1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "composite.h"
296 #include "keyboard.h"
300 #include "termchar.h"
301 #include "dispextern.h"
302 #include "character.h"
306 #include "commands.h"
309 #include "termhooks.h"
310 #include "termopts.h"
311 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 /* Holds the list (error). */
328 static Lisp_Object list_of_error
;
330 #ifdef HAVE_WINDOW_SYSTEM
332 /* Test if overflow newline into fringe. Called with iterator IT
333 at or past right window margin, and with IT->current_x set. */
335 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
336 (!NILP (Voverflow_newline_into_fringe) \
337 && FRAME_WINDOW_P ((IT)->f) \
338 && ((IT)->bidi_it.paragraph_dir == R2L \
339 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
340 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
341 && (IT)->current_x == (IT)->last_visible_x)
343 #else /* !HAVE_WINDOW_SYSTEM */
344 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
345 #endif /* HAVE_WINDOW_SYSTEM */
347 /* Test if the display element loaded in IT, or the underlying buffer
348 or string character, is a space or a TAB character. This is used
349 to determine where word wrapping can occur. */
351 #define IT_DISPLAYING_WHITESPACE(it) \
352 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
353 || ((STRINGP (it->string) \
354 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
355 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
357 && (it->s[IT_BYTEPOS (*it)] == ' ' \
358 || it->s[IT_BYTEPOS (*it)] == '\t')) \
359 || (IT_BYTEPOS (*it) < ZV_BYTE \
360 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
361 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
363 /* True means print newline to stdout before next mini-buffer message. */
365 bool noninteractive_need_newline
;
367 /* True means print newline to message log before next message. */
369 static bool message_log_need_newline
;
371 /* Three markers that message_dolog uses.
372 It could allocate them itself, but that causes trouble
373 in handling memory-full errors. */
374 static Lisp_Object message_dolog_marker1
;
375 static Lisp_Object message_dolog_marker2
;
376 static Lisp_Object message_dolog_marker3
;
378 /* The buffer position of the first character appearing entirely or
379 partially on the line of the selected window which contains the
380 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
381 redisplay optimization in redisplay_internal. */
383 static struct text_pos this_line_start_pos
;
385 /* Number of characters past the end of the line above, including the
386 terminating newline. */
388 static struct text_pos this_line_end_pos
;
390 /* The vertical positions and the height of this line. */
392 static int this_line_vpos
;
393 static int this_line_y
;
394 static int this_line_pixel_height
;
396 /* X position at which this display line starts. Usually zero;
397 negative if first character is partially visible. */
399 static int this_line_start_x
;
401 /* The smallest character position seen by move_it_* functions as they
402 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
403 hscrolled lines, see display_line. */
405 static struct text_pos this_line_min_pos
;
407 /* Buffer that this_line_.* variables are referring to. */
409 static struct buffer
*this_line_buffer
;
411 /* True if an overlay arrow has been displayed in this window. */
413 static bool overlay_arrow_seen
;
415 /* Vector containing glyphs for an ellipsis `...'. */
417 static Lisp_Object default_invis_vector
[3];
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 static Lisp_Object Vmessage_stack
;
432 /* True means multibyte characters were enabled when the echo area
433 message was specified. */
435 static bool message_enable_multibyte
;
437 /* At each redisplay cycle, we should refresh everything there is to refresh.
438 To do that efficiently, we use many optimizations that try to make sure we
439 don't waste too much time updating things that haven't changed.
440 The coarsest such optimization is that, in the most common cases, we only
441 look at the selected-window.
443 To know whether other windows should be considered for redisplay, we use the
444 variable windows_or_buffers_changed: as long as it is 0, it means that we
445 have not noticed anything that should require updating anything else than
446 the selected-window. If it is set to REDISPLAY_SOME, it means that since
447 last redisplay, some changes have been made which could impact other
448 windows. To know which ones need redisplay, every buffer, window, and frame
449 has a `redisplay' bit, which (if true) means that this object needs to be
450 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
451 looking for those `redisplay' bits (actually, there might be some such bits
452 set, but then only on objects which aren't displayed anyway).
454 OTOH if it's non-zero we wil have to loop through all windows and then check
455 the `redisplay' bit of the corresponding window, frame, and buffer, in order
456 to decide whether that window needs attention or not. Note that we can't
457 just look at the frame's redisplay bit to decide that the whole frame can be
458 skipped, since even if the frame's redisplay bit is unset, some of its
459 windows's redisplay bits may be set.
461 Mostly for historical reasons, windows_or_buffers_changed can also take
462 other non-zero values. In that case, the precise value doesn't matter (it
463 encodes the cause of the setting but is only used for debugging purposes),
464 and what it means is that we shouldn't pay attention to any `redisplay' bits
465 and we should simply try and redisplay every window out there. */
467 int windows_or_buffers_changed
;
469 /* Nonzero if we should redraw the mode lines on the next redisplay.
470 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
471 then only redisplay the mode lines in those buffers/windows/frames where the
472 `redisplay' bit has been set.
473 For any other value, redisplay all mode lines (the number used is then only
474 used to track down the cause for this full-redisplay).
476 Since the frame title uses the same %-constructs as the mode line
477 (except %c and %l), if this variable is non-zero, we also consider
478 redisplaying the title of each frame, see x_consider_frame_title.
480 The `redisplay' bits are the same as those used for
481 windows_or_buffers_changed, and setting windows_or_buffers_changed also
482 causes recomputation of the mode lines of all those windows. IOW this
483 variable only has an effect if windows_or_buffers_changed is zero, in which
484 case we should only need to redisplay the mode-line of those objects with
485 a `redisplay' bit set but not the window's text content (tho we may still
486 need to refresh the text content of the selected-window). */
488 int update_mode_lines
;
490 /* True after display_mode_line if %l was used and it displayed a
493 static bool line_number_displayed
;
495 /* The name of the *Messages* buffer, a string. */
497 static Lisp_Object Vmessages_buffer_name
;
499 /* Current, index 0, and last displayed echo area message. Either
500 buffers from echo_buffers, or nil to indicate no message. */
502 Lisp_Object echo_area_buffer
[2];
504 /* The buffers referenced from echo_area_buffer. */
506 static Lisp_Object echo_buffer
[2];
508 /* A vector saved used in with_area_buffer to reduce consing. */
510 static Lisp_Object Vwith_echo_area_save_vector
;
512 /* True means display_echo_area should display the last echo area
513 message again. Set by redisplay_preserve_echo_area. */
515 static bool display_last_displayed_message_p
;
517 /* True if echo area is being used by print; false if being used by
520 static bool message_buf_print
;
522 /* Set to true in clear_message to make redisplay_internal aware
523 of an emptied echo area. */
525 static bool message_cleared_p
;
527 /* A scratch glyph row with contents used for generating truncation
528 glyphs. Also used in direct_output_for_insert. */
530 #define MAX_SCRATCH_GLYPHS 100
531 static struct glyph_row scratch_glyph_row
;
532 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
534 /* Ascent and height of the last line processed by move_it_to. */
536 static int last_height
;
538 /* True if there's a help-echo in the echo area. */
540 bool help_echo_showing_p
;
542 /* The maximum distance to look ahead for text properties. Values
543 that are too small let us call compute_char_face and similar
544 functions too often which is expensive. Values that are too large
545 let us call compute_char_face and alike too often because we
546 might not be interested in text properties that far away. */
548 #define TEXT_PROP_DISTANCE_LIMIT 100
550 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
551 iterator state and later restore it. This is needed because the
552 bidi iterator on bidi.c keeps a stacked cache of its states, which
553 is really a singleton. When we use scratch iterator objects to
554 move around the buffer, we can cause the bidi cache to be pushed or
555 popped, and therefore we need to restore the cache state when we
556 return to the original iterator. */
557 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
560 bidi_unshelve_cache (CACHE, true); \
562 CACHE = bidi_shelve_cache (); \
565 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
567 if (pITORIG != pITCOPY) \
568 *(pITORIG) = *(pITCOPY); \
569 bidi_unshelve_cache (CACHE, false); \
573 /* Functions to mark elements as needing redisplay. */
574 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
577 redisplay_other_windows (void)
579 if (!windows_or_buffers_changed
)
580 windows_or_buffers_changed
= REDISPLAY_SOME
;
584 wset_redisplay (struct window
*w
)
586 /* Beware: selected_window can be nil during early stages. */
587 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
588 redisplay_other_windows ();
593 fset_redisplay (struct frame
*f
)
595 redisplay_other_windows ();
600 bset_redisplay (struct buffer
*b
)
602 int count
= buffer_window_count (b
);
605 /* ... it's visible in other window than selected, */
606 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
607 redisplay_other_windows ();
608 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
609 so that if we later set windows_or_buffers_changed, this buffer will
611 b
->text
->redisplay
= true;
616 bset_update_mode_line (struct buffer
*b
)
618 if (!update_mode_lines
)
619 update_mode_lines
= REDISPLAY_SOME
;
620 b
->text
->redisplay
= true;
624 maybe_set_redisplay (Lisp_Object symbol
)
626 if (!NILP (Fassoc_string (symbol
, Vredisplay__variables
, Qnil
)))
628 bset_update_mode_line (current_buffer
);
629 current_buffer
->prevent_redisplay_optimizations_p
= true;
635 /* True means print traces of redisplay if compiled with
636 GLYPH_DEBUG defined. */
638 bool trace_redisplay_p
;
640 #endif /* GLYPH_DEBUG */
642 #ifdef DEBUG_TRACE_MOVE
643 /* True means trace with TRACE_MOVE to stderr. */
644 static bool trace_move
;
646 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
648 #define TRACE_MOVE(x) (void) 0
651 /* Buffer being redisplayed -- for redisplay_window_error. */
653 static struct buffer
*displayed_buffer
;
655 /* Value returned from text property handlers (see below). */
660 HANDLED_RECOMPUTE_PROPS
,
661 HANDLED_OVERLAY_STRING_CONSUMED
,
665 /* A description of text properties that redisplay is interested
670 /* The symbol index of the name of the property. */
673 /* A unique index for the property. */
676 /* A handler function called to set up iterator IT from the property
677 at IT's current position. Value is used to steer handle_stop. */
678 enum prop_handled (*handler
) (struct it
*it
);
681 static enum prop_handled
handle_face_prop (struct it
*);
682 static enum prop_handled
handle_invisible_prop (struct it
*);
683 static enum prop_handled
handle_display_prop (struct it
*);
684 static enum prop_handled
handle_composition_prop (struct it
*);
685 static enum prop_handled
handle_overlay_change (struct it
*);
686 static enum prop_handled
handle_fontified_prop (struct it
*);
688 /* Properties handled by iterators. */
690 static struct props it_props
[] =
692 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
693 /* Handle `face' before `display' because some sub-properties of
694 `display' need to know the face. */
695 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
696 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
697 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
698 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
702 /* Value is the position described by X. If X is a marker, value is
703 the marker_position of X. Otherwise, value is X. */
705 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
707 /* Enumeration returned by some move_it_.* functions internally. */
711 /* Not used. Undefined value. */
714 /* Move ended at the requested buffer position or ZV. */
715 MOVE_POS_MATCH_OR_ZV
,
717 /* Move ended at the requested X pixel position. */
720 /* Move within a line ended at the end of a line that must be
724 /* Move within a line ended at the end of a line that would
725 be displayed truncated. */
728 /* Move within a line ended at a line end. */
732 /* This counter is used to clear the face cache every once in a while
733 in redisplay_internal. It is incremented for each redisplay.
734 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
737 #define CLEAR_FACE_CACHE_COUNT 500
738 static int clear_face_cache_count
;
740 /* Similarly for the image cache. */
742 #ifdef HAVE_WINDOW_SYSTEM
743 #define CLEAR_IMAGE_CACHE_COUNT 101
744 static int clear_image_cache_count
;
746 /* Null glyph slice */
747 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
750 /* True while redisplay_internal is in progress. */
754 /* If a string, XTread_socket generates an event to display that string.
755 (The display is done in read_char.) */
757 Lisp_Object help_echo_string
;
758 Lisp_Object help_echo_window
;
759 Lisp_Object help_echo_object
;
760 ptrdiff_t help_echo_pos
;
762 /* Temporary variable for XTread_socket. */
764 Lisp_Object previous_help_echo_string
;
766 /* Platform-independent portion of hourglass implementation. */
768 #ifdef HAVE_WINDOW_SYSTEM
770 /* True means an hourglass cursor is currently shown. */
771 static bool hourglass_shown_p
;
773 /* If non-null, an asynchronous timer that, when it expires, displays
774 an hourglass cursor on all frames. */
775 static struct atimer
*hourglass_atimer
;
777 #endif /* HAVE_WINDOW_SYSTEM */
779 /* Default number of seconds to wait before displaying an hourglass
781 #define DEFAULT_HOURGLASS_DELAY 1
783 #ifdef HAVE_WINDOW_SYSTEM
785 /* Default pixel width of `thin-space' display method. */
786 #define THIN_SPACE_WIDTH 1
788 #endif /* HAVE_WINDOW_SYSTEM */
790 /* Function prototypes. */
792 static void setup_for_ellipsis (struct it
*, int);
793 static void set_iterator_to_next (struct it
*, bool);
794 static void mark_window_display_accurate_1 (struct window
*, bool);
795 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
796 static bool cursor_row_p (struct glyph_row
*);
797 static int redisplay_mode_lines (Lisp_Object
, bool);
799 static void handle_line_prefix (struct it
*);
801 static void handle_stop_backwards (struct it
*, ptrdiff_t);
802 static void unwind_with_echo_area_buffer (Lisp_Object
);
803 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
804 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
805 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
806 static void set_message (Lisp_Object
);
807 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
808 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
809 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
810 static void unwind_redisplay (void);
811 static void extend_face_to_end_of_line (struct it
*);
812 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
813 static void push_it (struct it
*, struct text_pos
*);
814 static void iterate_out_of_display_property (struct it
*);
815 static void pop_it (struct it
*);
816 static void redisplay_internal (void);
817 static void echo_area_display (bool);
818 static void redisplay_windows (Lisp_Object
);
819 static void redisplay_window (Lisp_Object
, bool);
820 static Lisp_Object
redisplay_window_error (Lisp_Object
);
821 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
822 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
823 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
824 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
826 static bool update_menu_bar (struct frame
*, bool, bool);
827 static bool try_window_reusing_current_matrix (struct window
*);
828 static int try_window_id (struct window
*);
829 static bool display_line (struct it
*);
830 static int display_mode_lines (struct window
*);
831 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
832 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
834 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
836 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
837 static void display_menu_bar (struct window
*);
838 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
840 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
841 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
842 static void compute_line_metrics (struct it
*);
843 static void run_redisplay_end_trigger_hook (struct it
*);
844 static bool get_overlay_strings (struct it
*, ptrdiff_t);
845 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
846 static void next_overlay_string (struct it
*);
847 static void reseat (struct it
*, struct text_pos
, bool);
848 static void reseat_1 (struct it
*, struct text_pos
, bool);
849 static bool next_element_from_display_vector (struct it
*);
850 static bool next_element_from_string (struct it
*);
851 static bool next_element_from_c_string (struct it
*);
852 static bool next_element_from_buffer (struct it
*);
853 static bool next_element_from_composition (struct it
*);
854 static bool next_element_from_image (struct it
*);
855 static bool next_element_from_stretch (struct it
*);
856 static void load_overlay_strings (struct it
*, ptrdiff_t);
857 static bool get_next_display_element (struct it
*);
858 static enum move_it_result
859 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
860 enum move_operation_enum
);
861 static void get_visually_first_element (struct it
*);
862 static void compute_stop_pos (struct it
*);
863 static int face_before_or_after_it_pos (struct it
*, bool);
864 static ptrdiff_t next_overlay_change (ptrdiff_t);
865 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
866 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
867 static int handle_single_display_spec (struct it
*, Lisp_Object
,
868 Lisp_Object
, Lisp_Object
,
869 struct text_pos
*, ptrdiff_t, int, bool);
870 static int underlying_face_id (struct it
*);
872 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
873 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
875 #ifdef HAVE_WINDOW_SYSTEM
877 static void update_tool_bar (struct frame
*, bool);
878 static void x_draw_bottom_divider (struct window
*w
);
879 static void notice_overwritten_cursor (struct window
*,
882 static int normal_char_height (struct font
*, int);
883 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
885 static void append_stretch_glyph (struct it
*, Lisp_Object
,
888 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
889 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
890 struct font
*, int, bool);
892 #endif /* HAVE_WINDOW_SYSTEM */
894 static void produce_special_glyphs (struct it
*, enum display_element_type
);
895 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
896 static bool coords_in_mouse_face_p (struct window
*, int, int);
900 /***********************************************************************
901 Window display dimensions
902 ***********************************************************************/
904 /* Return the bottom boundary y-position for text lines in window W.
905 This is the first y position at which a line cannot start.
906 It is relative to the top of the window.
908 This is the height of W minus the height of a mode line, if any. */
911 window_text_bottom_y (struct window
*w
)
913 int height
= WINDOW_PIXEL_HEIGHT (w
);
915 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
917 if (WINDOW_WANTS_MODELINE_P (w
))
918 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
920 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
925 /* Return the pixel width of display area AREA of window W.
926 ANY_AREA means return the total width of W, not including
927 fringes to the left and right of the window. */
930 window_box_width (struct window
*w
, enum glyph_row_area area
)
932 int width
= w
->pixel_width
;
934 if (!w
->pseudo_window_p
)
936 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
937 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
939 if (area
== TEXT_AREA
)
940 width
-= (WINDOW_MARGINS_WIDTH (w
)
941 + WINDOW_FRINGES_WIDTH (w
));
942 else if (area
== LEFT_MARGIN_AREA
)
943 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
944 else if (area
== RIGHT_MARGIN_AREA
)
945 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
948 /* With wide margins, fringes, etc. we might end up with a negative
949 width, correct that here. */
950 return max (0, width
);
954 /* Return the pixel height of the display area of window W, not
955 including mode lines of W, if any. */
958 window_box_height (struct window
*w
)
960 struct frame
*f
= XFRAME (w
->frame
);
961 int height
= WINDOW_PIXEL_HEIGHT (w
);
963 eassert (height
>= 0);
965 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
966 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
968 /* Note: the code below that determines the mode-line/header-line
969 height is essentially the same as that contained in the macro
970 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
971 the appropriate glyph row has its `mode_line_p' flag set,
972 and if it doesn't, uses estimate_mode_line_height instead. */
974 if (WINDOW_WANTS_MODELINE_P (w
))
976 struct glyph_row
*ml_row
977 = (w
->current_matrix
&& w
->current_matrix
->rows
978 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
980 if (ml_row
&& ml_row
->mode_line_p
)
981 height
-= ml_row
->height
;
983 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
986 if (WINDOW_WANTS_HEADER_LINE_P (w
))
988 struct glyph_row
*hl_row
989 = (w
->current_matrix
&& w
->current_matrix
->rows
990 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
992 if (hl_row
&& hl_row
->mode_line_p
)
993 height
-= hl_row
->height
;
995 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
998 /* With a very small font and a mode-line that's taller than
999 default, we might end up with a negative height. */
1000 return max (0, height
);
1003 /* Return the window-relative coordinate of the left edge of display
1004 area AREA of window W. ANY_AREA means return the left edge of the
1005 whole window, to the right of the left fringe of W. */
1008 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1012 if (w
->pseudo_window_p
)
1015 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1017 if (area
== TEXT_AREA
)
1018 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1019 + window_box_width (w
, LEFT_MARGIN_AREA
));
1020 else if (area
== RIGHT_MARGIN_AREA
)
1021 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1022 + window_box_width (w
, LEFT_MARGIN_AREA
)
1023 + window_box_width (w
, TEXT_AREA
)
1024 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1026 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1027 else if (area
== LEFT_MARGIN_AREA
1028 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1029 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1031 /* Don't return more than the window's pixel width. */
1032 return min (x
, w
->pixel_width
);
1036 /* Return the window-relative coordinate of the right edge of display
1037 area AREA of window W. ANY_AREA means return the right edge of the
1038 whole window, to the left of the right fringe of W. */
1041 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1043 /* Don't return more than the window's pixel width. */
1044 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1048 /* Return the frame-relative coordinate of the left edge of display
1049 area AREA of window W. ANY_AREA means return the left edge of the
1050 whole window, to the right of the left fringe of W. */
1053 window_box_left (struct window
*w
, enum glyph_row_area area
)
1055 struct frame
*f
= XFRAME (w
->frame
);
1058 if (w
->pseudo_window_p
)
1059 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1061 x
= (WINDOW_LEFT_EDGE_X (w
)
1062 + window_box_left_offset (w
, area
));
1068 /* Return the frame-relative coordinate of the right edge of display
1069 area AREA of window W. ANY_AREA means return the right edge of the
1070 whole window, to the left of the right fringe of W. */
1073 window_box_right (struct window
*w
, enum glyph_row_area area
)
1075 return window_box_left (w
, area
) + window_box_width (w
, area
);
1078 /* Get the bounding box of the display area AREA of window W, without
1079 mode lines, in frame-relative coordinates. ANY_AREA means the
1080 whole window, not including the left and right fringes of
1081 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1082 coordinates of the upper-left corner of the box. Return in
1083 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1086 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1087 int *box_y
, int *box_width
, int *box_height
)
1090 *box_width
= window_box_width (w
, area
);
1092 *box_height
= window_box_height (w
);
1094 *box_x
= window_box_left (w
, area
);
1097 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1098 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1099 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1103 #ifdef HAVE_WINDOW_SYSTEM
1105 /* Get the bounding box of the display area AREA of window W, without
1106 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1107 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1108 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1109 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1113 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1114 int *bottom_right_x
, int *bottom_right_y
)
1116 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1117 bottom_right_x
, bottom_right_y
);
1118 *bottom_right_x
+= *top_left_x
;
1119 *bottom_right_y
+= *top_left_y
;
1122 #endif /* HAVE_WINDOW_SYSTEM */
1124 /***********************************************************************
1126 ***********************************************************************/
1128 /* Return the bottom y-position of the line the iterator IT is in.
1129 This can modify IT's settings. */
1132 line_bottom_y (struct it
*it
)
1134 int line_height
= it
->max_ascent
+ it
->max_descent
;
1135 int line_top_y
= it
->current_y
;
1137 if (line_height
== 0)
1140 line_height
= last_height
;
1141 else if (IT_CHARPOS (*it
) < ZV
)
1143 move_it_by_lines (it
, 1);
1144 line_height
= (it
->max_ascent
|| it
->max_descent
1145 ? it
->max_ascent
+ it
->max_descent
1150 struct glyph_row
*row
= it
->glyph_row
;
1152 /* Use the default character height. */
1153 it
->glyph_row
= NULL
;
1154 it
->what
= IT_CHARACTER
;
1157 PRODUCE_GLYPHS (it
);
1158 line_height
= it
->ascent
+ it
->descent
;
1159 it
->glyph_row
= row
;
1163 return line_top_y
+ line_height
;
1166 DEFUN ("line-pixel-height", Fline_pixel_height
,
1167 Sline_pixel_height
, 0, 0, 0,
1168 doc
: /* Return height in pixels of text line in the selected window.
1170 Value is the height in pixels of the line at point. */)
1175 struct window
*w
= XWINDOW (selected_window
);
1176 struct buffer
*old_buffer
= NULL
;
1179 if (XBUFFER (w
->contents
) != current_buffer
)
1181 old_buffer
= current_buffer
;
1182 set_buffer_internal_1 (XBUFFER (w
->contents
));
1184 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1185 start_display (&it
, w
, pt
);
1186 it
.vpos
= it
.current_y
= 0;
1188 result
= make_number (line_bottom_y (&it
));
1190 set_buffer_internal_1 (old_buffer
);
1195 /* Return the default pixel height of text lines in window W. The
1196 value is the canonical height of the W frame's default font, plus
1197 any extra space required by the line-spacing variable or frame
1200 Implementation note: this ignores any line-spacing text properties
1201 put on the newline characters. This is because those properties
1202 only affect the _screen_ line ending in the newline (i.e., in a
1203 continued line, only the last screen line will be affected), which
1204 means only a small number of lines in a buffer can ever use this
1205 feature. Since this function is used to compute the default pixel
1206 equivalent of text lines in a window, we can safely ignore those
1207 few lines. For the same reasons, we ignore the line-height
1210 default_line_pixel_height (struct window
*w
)
1212 struct frame
*f
= WINDOW_XFRAME (w
);
1213 int height
= FRAME_LINE_HEIGHT (f
);
1215 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1217 struct buffer
*b
= XBUFFER (w
->contents
);
1218 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1221 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1224 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1225 height
+= XFASTINT (val
);
1226 else if (FLOATP (val
))
1228 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1235 height
+= f
->extra_line_spacing
;
1241 /* Subroutine of pos_visible_p below. Extracts a display string, if
1242 any, from the display spec given as its argument. */
1244 string_from_display_spec (Lisp_Object spec
)
1248 while (CONSP (spec
))
1250 if (STRINGP (XCAR (spec
)))
1255 else if (VECTORP (spec
))
1259 for (i
= 0; i
< ASIZE (spec
); i
++)
1261 if (STRINGP (AREF (spec
, i
)))
1262 return AREF (spec
, i
);
1271 /* Limit insanely large values of W->hscroll on frame F to the largest
1272 value that will still prevent first_visible_x and last_visible_x of
1273 'struct it' from overflowing an int. */
1275 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1277 ptrdiff_t window_hscroll
= w
->hscroll
;
1278 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1279 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1281 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1282 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1284 return window_hscroll
;
1287 /* Return true if position CHARPOS is visible in window W.
1288 CHARPOS < 0 means return info about WINDOW_END position.
1289 If visible, set *X and *Y to pixel coordinates of top left corner.
1290 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1291 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1294 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1295 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1298 void *itdata
= bidi_shelve_cache ();
1299 struct text_pos top
;
1300 bool visible_p
= false;
1301 struct buffer
*old_buffer
= NULL
;
1304 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1307 if (XBUFFER (w
->contents
) != current_buffer
)
1309 old_buffer
= current_buffer
;
1310 set_buffer_internal_1 (XBUFFER (w
->contents
));
1313 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1314 /* Scrolling a minibuffer window via scroll bar when the echo area
1315 shows long text sometimes resets the minibuffer contents behind
1317 if (CHARPOS (top
) > ZV
)
1318 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1320 /* Compute exact mode line heights. */
1321 if (WINDOW_WANTS_MODELINE_P (w
))
1323 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1324 BVAR (current_buffer
, mode_line_format
));
1326 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1327 w
->header_line_height
1328 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1329 BVAR (current_buffer
, header_line_format
));
1331 start_display (&it
, w
, top
);
1332 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1333 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1336 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1337 && IT_CHARPOS (it
) >= charpos
)
1338 /* When scanning backwards under bidi iteration, move_it_to
1339 stops at or _before_ CHARPOS, because it stops at or to
1340 the _right_ of the character at CHARPOS. */
1341 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1342 && IT_CHARPOS (it
) <= charpos
)))
1344 /* We have reached CHARPOS, or passed it. How the call to
1345 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1346 or covered by a display property, move_it_to stops at the end
1347 of the invisible text, to the right of CHARPOS. (ii) If
1348 CHARPOS is in a display vector, move_it_to stops on its last
1350 int top_x
= it
.current_x
;
1351 int top_y
= it
.current_y
;
1352 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1355 void *save_it_data
= NULL
;
1357 /* Calling line_bottom_y may change it.method, it.position, etc. */
1358 SAVE_IT (save_it
, it
, save_it_data
);
1360 bottom_y
= line_bottom_y (&it
);
1361 if (top_y
< window_top_y
)
1362 visible_p
= bottom_y
> window_top_y
;
1363 else if (top_y
< it
.last_visible_y
)
1365 if (bottom_y
>= it
.last_visible_y
1366 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1367 && IT_CHARPOS (it
) < charpos
)
1369 /* When the last line of the window is scanned backwards
1370 under bidi iteration, we could be duped into thinking
1371 that we have passed CHARPOS, when in fact move_it_to
1372 simply stopped short of CHARPOS because it reached
1373 last_visible_y. To see if that's what happened, we call
1374 move_it_to again with a slightly larger vertical limit,
1375 and see if it actually moved vertically; if it did, we
1376 didn't really reach CHARPOS, which is beyond window end. */
1377 /* Why 10? because we don't know how many canonical lines
1378 will the height of the next line(s) be. So we guess. */
1379 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1381 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1382 MOVE_TO_POS
| MOVE_TO_Y
);
1383 if (it
.current_y
> top_y
)
1387 RESTORE_IT (&it
, &save_it
, save_it_data
);
1390 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1392 /* We stopped on the last glyph of a display vector.
1393 Try and recompute. Hack alert! */
1394 if (charpos
< 2 || top
.charpos
>= charpos
)
1395 top_x
= it
.glyph_row
->x
;
1398 struct it it2
, it2_prev
;
1399 /* The idea is to get to the previous buffer
1400 position, consume the character there, and use
1401 the pixel coordinates we get after that. But if
1402 the previous buffer position is also displayed
1403 from a display vector, we need to consume all of
1404 the glyphs from that display vector. */
1405 start_display (&it2
, w
, top
);
1406 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1407 /* If we didn't get to CHARPOS - 1, there's some
1408 replacing display property at that position, and
1409 we stopped after it. That is exactly the place
1410 whose coordinates we want. */
1411 if (IT_CHARPOS (it2
) != charpos
- 1)
1415 /* Iterate until we get out of the display
1416 vector that displays the character at
1419 get_next_display_element (&it2
);
1420 PRODUCE_GLYPHS (&it2
);
1422 set_iterator_to_next (&it2
, true);
1423 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1424 && IT_CHARPOS (it2
) < charpos
);
1426 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1427 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1428 top_x
= it
.glyph_row
->x
;
1431 top_x
= it2_prev
.current_x
;
1432 top_y
= it2_prev
.current_y
;
1436 else if (IT_CHARPOS (it
) != charpos
)
1438 Lisp_Object cpos
= make_number (charpos
);
1439 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1440 Lisp_Object string
= string_from_display_spec (spec
);
1441 struct text_pos tpos
;
1442 bool newline_in_string
1444 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1446 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1447 bool replacing_spec_p
1449 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1450 charpos
, FRAME_WINDOW_P (it
.f
)));
1451 /* The tricky code below is needed because there's a
1452 discrepancy between move_it_to and how we set cursor
1453 when PT is at the beginning of a portion of text
1454 covered by a display property or an overlay with a
1455 display property, or the display line ends in a
1456 newline from a display string. move_it_to will stop
1457 _after_ such display strings, whereas
1458 set_cursor_from_row conspires with cursor_row_p to
1459 place the cursor on the first glyph produced from the
1462 /* We have overshoot PT because it is covered by a
1463 display property that replaces the text it covers.
1464 If the string includes embedded newlines, we are also
1465 in the wrong display line. Backtrack to the correct
1466 line, where the display property begins. */
1467 if (replacing_spec_p
)
1469 Lisp_Object startpos
, endpos
;
1470 EMACS_INT start
, end
;
1473 /* Find the first and the last buffer positions
1474 covered by the display string. */
1476 Fnext_single_char_property_change (cpos
, Qdisplay
,
1479 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1481 start
= XFASTINT (startpos
);
1482 end
= XFASTINT (endpos
);
1483 /* Move to the last buffer position before the
1484 display property. */
1485 start_display (&it3
, w
, top
);
1486 if (start
> CHARPOS (top
))
1487 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1488 /* Move forward one more line if the position before
1489 the display string is a newline or if it is the
1490 rightmost character on a line that is
1491 continued or word-wrapped. */
1492 if (it3
.method
== GET_FROM_BUFFER
1494 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1495 move_it_by_lines (&it3
, 1);
1496 else if (move_it_in_display_line_to (&it3
, -1,
1500 == MOVE_LINE_CONTINUED
)
1502 move_it_by_lines (&it3
, 1);
1503 /* When we are under word-wrap, the #$@%!
1504 move_it_by_lines moves 2 lines, so we need to
1506 if (it3
.line_wrap
== WORD_WRAP
)
1507 move_it_by_lines (&it3
, -1);
1510 /* Record the vertical coordinate of the display
1511 line where we wound up. */
1512 top_y
= it3
.current_y
;
1515 /* When characters are reordered for display,
1516 the character displayed to the left of the
1517 display string could be _after_ the display
1518 property in the logical order. Use the
1519 smallest vertical position of these two. */
1520 start_display (&it3
, w
, top
);
1521 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1522 if (it3
.current_y
< top_y
)
1523 top_y
= it3
.current_y
;
1525 /* Move from the top of the window to the beginning
1526 of the display line where the display string
1528 start_display (&it3
, w
, top
);
1529 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1530 /* If it3_moved stays false after the 'while' loop
1531 below, that means we already were at a newline
1532 before the loop (e.g., the display string begins
1533 with a newline), so we don't need to (and cannot)
1534 inspect the glyphs of it3.glyph_row, because
1535 PRODUCE_GLYPHS will not produce anything for a
1536 newline, and thus it3.glyph_row stays at its
1537 stale content it got at top of the window. */
1538 bool it3_moved
= false;
1539 /* Finally, advance the iterator until we hit the
1540 first display element whose character position is
1541 CHARPOS, or until the first newline from the
1542 display string, which signals the end of the
1544 while (get_next_display_element (&it3
))
1546 PRODUCE_GLYPHS (&it3
);
1547 if (IT_CHARPOS (it3
) == charpos
1548 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1551 set_iterator_to_next (&it3
, false);
1553 top_x
= it3
.current_x
- it3
.pixel_width
;
1554 /* Normally, we would exit the above loop because we
1555 found the display element whose character
1556 position is CHARPOS. For the contingency that we
1557 didn't, and stopped at the first newline from the
1558 display string, move back over the glyphs
1559 produced from the string, until we find the
1560 rightmost glyph not from the string. */
1562 && newline_in_string
1563 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1565 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1566 + it3
.glyph_row
->used
[TEXT_AREA
];
1568 while (EQ ((g
- 1)->object
, string
))
1571 top_x
-= g
->pixel_width
;
1573 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1574 + it3
.glyph_row
->used
[TEXT_AREA
]);
1580 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1581 *rtop
= max (0, window_top_y
- top_y
);
1582 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1583 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1584 - max (top_y
, window_top_y
)));
1586 if (it
.bidi_it
.paragraph_dir
== R2L
)
1592 /* Either we were asked to provide info about WINDOW_END, or
1593 CHARPOS is in the partially visible glyph row at end of
1596 void *it2data
= NULL
;
1598 SAVE_IT (it2
, it
, it2data
);
1599 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1600 move_it_by_lines (&it
, 1);
1601 if (charpos
< IT_CHARPOS (it
)
1602 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1605 RESTORE_IT (&it2
, &it2
, it2data
);
1606 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1608 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1609 *rtop
= max (0, -it2
.current_y
);
1610 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1611 - it
.last_visible_y
));
1612 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1614 - max (it2
.current_y
,
1615 WINDOW_HEADER_LINE_HEIGHT (w
))));
1617 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1621 bidi_unshelve_cache (it2data
, true);
1623 bidi_unshelve_cache (itdata
, false);
1626 set_buffer_internal_1 (old_buffer
);
1632 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1633 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1634 /* For lines in an R2L paragraph, we need to mirror the X pixel
1635 coordinate wrt the text area. For the reasons, see the
1636 commentary in buffer_posn_from_coords and the explanation of
1637 the geometry used by the move_it_* functions at the end of
1638 the large commentary near the beginning of this file. */
1640 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1644 /* Debugging code. */
1646 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1647 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1649 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1656 /* Return the next character from STR. Return in *LEN the length of
1657 the character. This is like STRING_CHAR_AND_LENGTH but never
1658 returns an invalid character. If we find one, we return a `?', but
1659 with the length of the invalid character. */
1662 string_char_and_length (const unsigned char *str
, int *len
)
1666 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1667 if (!CHAR_VALID_P (c
))
1668 /* We may not change the length here because other places in Emacs
1669 don't use this function, i.e. they silently accept invalid
1678 /* Given a position POS containing a valid character and byte position
1679 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1681 static struct text_pos
1682 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1684 eassert (STRINGP (string
) && nchars
>= 0);
1686 if (STRING_MULTIBYTE (string
))
1688 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1693 string_char_and_length (p
, &len
);
1696 BYTEPOS (pos
) += len
;
1700 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1706 /* Value is the text position, i.e. character and byte position,
1707 for character position CHARPOS in STRING. */
1709 static struct text_pos
1710 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1712 struct text_pos pos
;
1713 eassert (STRINGP (string
));
1714 eassert (charpos
>= 0);
1715 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1720 /* Value is a text position, i.e. character and byte position, for
1721 character position CHARPOS in C string S. MULTIBYTE_P
1722 means recognize multibyte characters. */
1724 static struct text_pos
1725 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1727 struct text_pos pos
;
1729 eassert (s
!= NULL
);
1730 eassert (charpos
>= 0);
1736 SET_TEXT_POS (pos
, 0, 0);
1739 string_char_and_length ((const unsigned char *) s
, &len
);
1742 BYTEPOS (pos
) += len
;
1746 SET_TEXT_POS (pos
, charpos
, charpos
);
1752 /* Value is the number of characters in C string S. MULTIBYTE_P
1753 means recognize multibyte characters. */
1756 number_of_chars (const char *s
, bool multibyte_p
)
1762 ptrdiff_t rest
= strlen (s
);
1764 const unsigned char *p
= (const unsigned char *) s
;
1766 for (nchars
= 0; rest
> 0; ++nchars
)
1768 string_char_and_length (p
, &len
);
1769 rest
-= len
, p
+= len
;
1773 nchars
= strlen (s
);
1779 /* Compute byte position NEWPOS->bytepos corresponding to
1780 NEWPOS->charpos. POS is a known position in string STRING.
1781 NEWPOS->charpos must be >= POS.charpos. */
1784 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1786 eassert (STRINGP (string
));
1787 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1789 if (STRING_MULTIBYTE (string
))
1790 *newpos
= string_pos_nchars_ahead (pos
, string
,
1791 CHARPOS (*newpos
) - CHARPOS (pos
));
1793 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1797 Return an estimation of the pixel height of mode or header lines on
1798 frame F. FACE_ID specifies what line's height to estimate. */
1801 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1803 #ifdef HAVE_WINDOW_SYSTEM
1804 if (FRAME_WINDOW_P (f
))
1806 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1808 /* This function is called so early when Emacs starts that the face
1809 cache and mode line face are not yet initialized. */
1810 if (FRAME_FACE_CACHE (f
))
1812 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1816 height
= normal_char_height (face
->font
, -1);
1817 if (face
->box_line_width
> 0)
1818 height
+= 2 * face
->box_line_width
;
1829 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1830 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1831 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1832 not force the value into range. */
1835 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1836 NativeRectangle
*bounds
, bool noclip
)
1839 #ifdef HAVE_WINDOW_SYSTEM
1840 if (FRAME_WINDOW_P (f
))
1842 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1843 even for negative values. */
1845 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1847 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1849 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1850 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1853 STORE_NATIVE_RECT (*bounds
,
1854 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1855 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1856 FRAME_COLUMN_WIDTH (f
) - 1,
1857 FRAME_LINE_HEIGHT (f
) - 1);
1859 /* PXW: Should we clip pixels before converting to columns/lines? */
1864 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1865 pix_x
= FRAME_TOTAL_COLS (f
);
1869 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1870 pix_y
= FRAME_TOTAL_LINES (f
);
1880 /* Find the glyph under window-relative coordinates X/Y in window W.
1881 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1882 strings. Return in *HPOS and *VPOS the row and column number of
1883 the glyph found. Return in *AREA the glyph area containing X.
1884 Value is a pointer to the glyph found or null if X/Y is not on
1885 text, or we can't tell because W's current matrix is not up to
1888 static struct glyph
*
1889 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1890 int *dx
, int *dy
, int *area
)
1892 struct glyph
*glyph
, *end
;
1893 struct glyph_row
*row
= NULL
;
1896 /* Find row containing Y. Give up if some row is not enabled. */
1897 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1899 row
= MATRIX_ROW (w
->current_matrix
, i
);
1900 if (!row
->enabled_p
)
1902 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1909 /* Give up if Y is not in the window. */
1910 if (i
== w
->current_matrix
->nrows
)
1913 /* Get the glyph area containing X. */
1914 if (w
->pseudo_window_p
)
1921 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1923 *area
= LEFT_MARGIN_AREA
;
1924 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1926 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1929 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1933 *area
= RIGHT_MARGIN_AREA
;
1934 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1938 /* Find glyph containing X. */
1939 glyph
= row
->glyphs
[*area
];
1940 end
= glyph
+ row
->used
[*area
];
1942 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1944 x
-= glyph
->pixel_width
;
1954 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1957 *hpos
= glyph
- row
->glyphs
[*area
];
1961 /* Convert frame-relative x/y to coordinates relative to window W.
1962 Takes pseudo-windows into account. */
1965 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1967 if (w
->pseudo_window_p
)
1969 /* A pseudo-window is always full-width, and starts at the
1970 left edge of the frame, plus a frame border. */
1971 struct frame
*f
= XFRAME (w
->frame
);
1972 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1973 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1977 *x
-= WINDOW_LEFT_EDGE_X (w
);
1978 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1982 #ifdef HAVE_WINDOW_SYSTEM
1985 Return in RECTS[] at most N clipping rectangles for glyph string S.
1986 Return the number of stored rectangles. */
1989 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1996 if (s
->row
->full_width_p
)
1998 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1999 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2000 if (s
->row
->mode_line_p
)
2001 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2003 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2005 /* Unless displaying a mode or menu bar line, which are always
2006 fully visible, clip to the visible part of the row. */
2007 if (s
->w
->pseudo_window_p
)
2008 r
.height
= s
->row
->visible_height
;
2010 r
.height
= s
->height
;
2014 /* This is a text line that may be partially visible. */
2015 r
.x
= window_box_left (s
->w
, s
->area
);
2016 r
.width
= window_box_width (s
->w
, s
->area
);
2017 r
.height
= s
->row
->visible_height
;
2021 if (r
.x
< s
->clip_head
->x
)
2023 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2024 r
.width
-= s
->clip_head
->x
- r
.x
;
2027 r
.x
= s
->clip_head
->x
;
2030 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2032 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2033 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2038 /* If S draws overlapping rows, it's sufficient to use the top and
2039 bottom of the window for clipping because this glyph string
2040 intentionally draws over other lines. */
2041 if (s
->for_overlaps
)
2043 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2044 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2046 /* Alas, the above simple strategy does not work for the
2047 environments with anti-aliased text: if the same text is
2048 drawn onto the same place multiple times, it gets thicker.
2049 If the overlap we are processing is for the erased cursor, we
2050 take the intersection with the rectangle of the cursor. */
2051 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2053 XRectangle rc
, r_save
= r
;
2055 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2056 rc
.y
= s
->w
->phys_cursor
.y
;
2057 rc
.width
= s
->w
->phys_cursor_width
;
2058 rc
.height
= s
->w
->phys_cursor_height
;
2060 x_intersect_rectangles (&r_save
, &rc
, &r
);
2065 /* Don't use S->y for clipping because it doesn't take partially
2066 visible lines into account. For example, it can be negative for
2067 partially visible lines at the top of a window. */
2068 if (!s
->row
->full_width_p
2069 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2070 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2072 r
.y
= max (0, s
->row
->y
);
2075 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2077 /* If drawing the cursor, don't let glyph draw outside its
2078 advertised boundaries. Cleartype does this under some circumstances. */
2079 if (s
->hl
== DRAW_CURSOR
)
2081 struct glyph
*glyph
= s
->first_glyph
;
2086 if (r
.width
>= s
->x
- r
.x
)
2087 r
.width
-= s
->x
- r
.x
;
2088 else /* R2L hscrolled row with cursor outside text area */
2092 r
.width
= min (r
.width
, glyph
->pixel_width
);
2094 /* If r.y is below window bottom, ensure that we still see a cursor. */
2095 height
= min (glyph
->ascent
+ glyph
->descent
,
2096 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2097 max_y
= window_text_bottom_y (s
->w
) - height
;
2098 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2099 if (s
->ybase
- glyph
->ascent
> max_y
)
2106 /* Don't draw cursor glyph taller than our actual glyph. */
2107 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2108 if (height
< r
.height
)
2110 max_y
= r
.y
+ r
.height
;
2111 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2112 r
.height
= min (max_y
- r
.y
, height
);
2119 XRectangle r_save
= r
;
2121 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2125 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2126 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2128 #ifdef CONVERT_FROM_XRECT
2129 CONVERT_FROM_XRECT (r
, *rects
);
2137 /* If we are processing overlapping and allowed to return
2138 multiple clipping rectangles, we exclude the row of the glyph
2139 string from the clipping rectangle. This is to avoid drawing
2140 the same text on the environment with anti-aliasing. */
2141 #ifdef CONVERT_FROM_XRECT
2144 XRectangle
*rs
= rects
;
2146 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2148 if (s
->for_overlaps
& OVERLAPS_PRED
)
2151 if (r
.y
+ r
.height
> row_y
)
2154 rs
[i
].height
= row_y
- r
.y
;
2160 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2163 if (r
.y
< row_y
+ s
->row
->visible_height
)
2165 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2167 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2168 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2177 #ifdef CONVERT_FROM_XRECT
2178 for (i
= 0; i
< n
; i
++)
2179 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2186 Return in *NR the clipping rectangle for glyph string S. */
2189 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2191 get_glyph_string_clip_rects (s
, nr
, 1);
2196 Return the position and height of the phys cursor in window W.
2197 Set w->phys_cursor_width to width of phys cursor.
2201 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2202 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2204 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2205 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2207 /* Compute the width of the rectangle to draw. If on a stretch
2208 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2209 rectangle as wide as the glyph, but use a canonical character
2211 wd
= glyph
->pixel_width
;
2213 x
= w
->phys_cursor
.x
;
2220 if (glyph
->type
== STRETCH_GLYPH
2221 && !x_stretch_cursor_p
)
2222 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2223 w
->phys_cursor_width
= wd
;
2225 /* Don't let the hollow cursor glyph descend below the glyph row's
2226 ascent value, lest the hollow cursor looks funny. */
2227 y
= w
->phys_cursor
.y
;
2228 ascent
= row
->ascent
;
2229 if (row
->ascent
< glyph
->ascent
)
2231 y
=- glyph
->ascent
- row
->ascent
;
2232 ascent
= glyph
->ascent
;
2235 /* If y is below window bottom, ensure that we still see a cursor. */
2236 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2238 h
= max (h0
, ascent
+ glyph
->descent
);
2239 h0
= min (h0
, ascent
+ glyph
->descent
);
2241 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2244 h
= max (h
- (y0
- y
) + 1, h0
);
2249 y0
= window_text_bottom_y (w
) - h0
;
2257 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2258 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2263 * Remember which glyph the mouse is over.
2267 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2271 struct glyph_row
*r
, *gr
, *end_row
;
2272 enum window_part part
;
2273 enum glyph_row_area area
;
2274 int x
, y
, width
, height
;
2276 /* Try to determine frame pixel position and size of the glyph under
2277 frame pixel coordinates X/Y on frame F. */
2279 if (window_resize_pixelwise
)
2284 else if (!f
->glyphs_initialized_p
2285 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2288 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2289 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2293 w
= XWINDOW (window
);
2294 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2295 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2297 x
= window_relative_x_coord (w
, part
, gx
);
2298 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2300 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2301 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2303 if (w
->pseudo_window_p
)
2306 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2312 case ON_LEFT_MARGIN
:
2313 area
= LEFT_MARGIN_AREA
;
2316 case ON_RIGHT_MARGIN
:
2317 area
= RIGHT_MARGIN_AREA
;
2320 case ON_HEADER_LINE
:
2322 gr
= (part
== ON_HEADER_LINE
2323 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2324 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2327 goto text_glyph_row_found
;
2334 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2335 if (r
->y
+ r
->height
> y
)
2341 text_glyph_row_found
:
2344 struct glyph
*g
= gr
->glyphs
[area
];
2345 struct glyph
*end
= g
+ gr
->used
[area
];
2347 height
= gr
->height
;
2348 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2349 if (gx
+ g
->pixel_width
> x
)
2354 if (g
->type
== IMAGE_GLYPH
)
2356 /* Don't remember when mouse is over image, as
2357 image may have hot-spots. */
2358 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2361 width
= g
->pixel_width
;
2365 /* Use nominal char spacing at end of line. */
2367 gx
+= (x
/ width
) * width
;
2370 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2372 gx
+= window_box_left_offset (w
, area
);
2373 /* Don't expand over the modeline to make sure the vertical
2374 drag cursor is shown early enough. */
2375 height
= min (height
,
2376 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2381 /* Use nominal line height at end of window. */
2382 gx
= (x
/ width
) * width
;
2384 gy
+= (y
/ height
) * height
;
2385 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2386 /* See comment above. */
2387 height
= min (height
,
2388 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2392 case ON_LEFT_FRINGE
:
2393 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2394 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2395 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2396 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2399 case ON_RIGHT_FRINGE
:
2400 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2401 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2402 : window_box_right_offset (w
, TEXT_AREA
));
2403 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2404 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2405 && !WINDOW_RIGHTMOST_P (w
))
2406 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2407 /* Make sure the vertical border can get her own glyph to the
2408 right of the one we build here. */
2409 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2411 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2413 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2417 case ON_VERTICAL_BORDER
:
2418 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2421 case ON_VERTICAL_SCROLL_BAR
:
2422 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2424 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2425 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2426 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2428 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2432 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2433 if (r
->y
+ r
->height
> y
)
2440 height
= gr
->height
;
2443 /* Use nominal line height at end of window. */
2445 gy
+= (y
/ height
) * height
;
2449 case ON_RIGHT_DIVIDER
:
2450 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2451 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2453 /* The bottom divider prevails. */
2454 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2457 case ON_BOTTOM_DIVIDER
:
2459 width
= WINDOW_PIXEL_WIDTH (w
);
2460 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2461 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2467 /* If there is no glyph under the mouse, then we divide the screen
2468 into a grid of the smallest glyph in the frame, and use that
2471 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2472 round down even for negative values. */
2478 gx
= (gx
/ width
) * width
;
2479 gy
= (gy
/ height
) * height
;
2485 gx
+= WINDOW_LEFT_EDGE_X (w
);
2486 gy
+= WINDOW_TOP_EDGE_Y (w
);
2489 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2491 /* Visible feedback for debugging. */
2492 #if false && defined HAVE_X_WINDOWS
2493 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2494 f
->output_data
.x
->normal_gc
,
2495 gx
, gy
, width
, height
);
2500 #endif /* HAVE_WINDOW_SYSTEM */
2503 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2506 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2507 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2509 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2512 /***********************************************************************
2513 Lisp form evaluation
2514 ***********************************************************************/
2516 /* Error handler for safe_eval and safe_call. */
2519 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2521 add_to_log ("Error during redisplay: %S signaled %S",
2522 Flist (nargs
, args
), arg
);
2526 /* Call function FUNC with the rest of NARGS - 1 arguments
2527 following. Return the result, or nil if something went
2528 wrong. Prevent redisplay during the evaluation. */
2531 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2535 if (inhibit_eval_during_redisplay
)
2540 ptrdiff_t count
= SPECPDL_INDEX ();
2543 SAFE_ALLOCA_LISP (args
, nargs
);
2546 for (i
= 1; i
< nargs
; i
++)
2547 args
[i
] = va_arg (ap
, Lisp_Object
);
2549 specbind (Qinhibit_redisplay
, Qt
);
2551 specbind (Qinhibit_quit
, Qt
);
2552 /* Use Qt to ensure debugger does not run,
2553 so there is no possibility of wanting to redisplay. */
2554 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2557 val
= unbind_to (count
, val
);
2564 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2569 va_start (ap
, func
);
2570 retval
= safe__call (false, nargs
, func
, ap
);
2575 /* Call function FN with one argument ARG.
2576 Return the result, or nil if something went wrong. */
2579 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2581 return safe_call (2, fn
, arg
);
2585 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2591 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2597 safe_eval (Lisp_Object sexpr
)
2599 return safe__call1 (false, Qeval
, sexpr
);
2603 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2605 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2608 /* Call function FN with two arguments ARG1 and ARG2.
2609 Return the result, or nil if something went wrong. */
2612 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2614 return safe_call (3, fn
, arg1
, arg2
);
2619 /***********************************************************************
2621 ***********************************************************************/
2623 /* Define CHECK_IT to perform sanity checks on iterators.
2624 This is for debugging. It is too slow to do unconditionally. */
2627 CHECK_IT (struct it
*it
)
2630 if (it
->method
== GET_FROM_STRING
)
2632 eassert (STRINGP (it
->string
));
2633 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2637 eassert (IT_STRING_CHARPOS (*it
) < 0);
2638 if (it
->method
== GET_FROM_BUFFER
)
2640 /* Check that character and byte positions agree. */
2641 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2646 eassert (it
->current
.dpvec_index
>= 0);
2648 eassert (it
->current
.dpvec_index
< 0);
2653 /* Check that the window end of window W is what we expect it
2654 to be---the last row in the current matrix displaying text. */
2657 CHECK_WINDOW_END (struct window
*w
)
2659 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2660 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2662 struct glyph_row
*row
;
2663 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2665 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2666 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2671 /***********************************************************************
2672 Iterator initialization
2673 ***********************************************************************/
2675 /* Initialize IT for displaying current_buffer in window W, starting
2676 at character position CHARPOS. CHARPOS < 0 means that no buffer
2677 position is specified which is useful when the iterator is assigned
2678 a position later. BYTEPOS is the byte position corresponding to
2681 If ROW is not null, calls to produce_glyphs with IT as parameter
2682 will produce glyphs in that row.
2684 BASE_FACE_ID is the id of a base face to use. It must be one of
2685 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2686 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2687 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2689 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2690 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2691 will be initialized to use the corresponding mode line glyph row of
2692 the desired matrix of W. */
2695 init_iterator (struct it
*it
, struct window
*w
,
2696 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2697 struct glyph_row
*row
, enum face_id base_face_id
)
2699 enum face_id remapped_base_face_id
= base_face_id
;
2701 /* Some precondition checks. */
2702 eassert (w
!= NULL
&& it
!= NULL
);
2703 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2706 /* If face attributes have been changed since the last redisplay,
2707 free realized faces now because they depend on face definitions
2708 that might have changed. Don't free faces while there might be
2709 desired matrices pending which reference these faces. */
2710 if (!inhibit_free_realized_faces
)
2714 face_change
= false;
2715 free_all_realized_faces (Qnil
);
2717 else if (XFRAME (w
->frame
)->face_change
)
2719 XFRAME (w
->frame
)->face_change
= 0;
2720 free_all_realized_faces (w
->frame
);
2724 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2725 if (! NILP (Vface_remapping_alist
))
2726 remapped_base_face_id
2727 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2729 /* Use one of the mode line rows of W's desired matrix if
2733 if (base_face_id
== MODE_LINE_FACE_ID
2734 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2735 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2736 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2737 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2740 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2741 Other parts of redisplay rely on that. */
2742 memclear (it
, sizeof *it
);
2743 it
->current
.overlay_string_index
= -1;
2744 it
->current
.dpvec_index
= -1;
2745 it
->base_face_id
= remapped_base_face_id
;
2746 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2747 it
->paragraph_embedding
= L2R
;
2750 /* The window in which we iterate over current_buffer: */
2751 XSETWINDOW (it
->window
, w
);
2753 it
->f
= XFRAME (w
->frame
);
2757 /* Extra space between lines (on window systems only). */
2758 if (base_face_id
== DEFAULT_FACE_ID
2759 && FRAME_WINDOW_P (it
->f
))
2761 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2762 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2763 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2764 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2765 * FRAME_LINE_HEIGHT (it
->f
));
2766 else if (it
->f
->extra_line_spacing
> 0)
2767 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2770 /* If realized faces have been removed, e.g. because of face
2771 attribute changes of named faces, recompute them. When running
2772 in batch mode, the face cache of the initial frame is null. If
2773 we happen to get called, make a dummy face cache. */
2774 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2775 init_frame_faces (it
->f
);
2776 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2777 recompute_basic_faces (it
->f
);
2779 it
->override_ascent
= -1;
2781 /* Are control characters displayed as `^C'? */
2782 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2784 /* -1 means everything between a CR and the following line end
2785 is invisible. >0 means lines indented more than this value are
2787 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2789 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2791 : (!NILP (BVAR (current_buffer
, selective_display
))
2793 it
->selective_display_ellipsis_p
2794 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2796 /* Display table to use. */
2797 it
->dp
= window_display_table (w
);
2799 /* Are multibyte characters enabled in current_buffer? */
2800 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2802 /* Get the position at which the redisplay_end_trigger hook should
2803 be run, if it is to be run at all. */
2804 if (MARKERP (w
->redisplay_end_trigger
)
2805 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2806 it
->redisplay_end_trigger_charpos
2807 = marker_position (w
->redisplay_end_trigger
);
2808 else if (INTEGERP (w
->redisplay_end_trigger
))
2809 it
->redisplay_end_trigger_charpos
2810 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2813 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2815 /* Are lines in the display truncated? */
2817 it
->line_wrap
= TRUNCATE
;
2818 if (base_face_id
== DEFAULT_FACE_ID
2820 && (WINDOW_FULL_WIDTH_P (it
->w
)
2821 || NILP (Vtruncate_partial_width_windows
)
2822 || (INTEGERP (Vtruncate_partial_width_windows
)
2823 /* PXW: Shall we do something about this? */
2824 && (XINT (Vtruncate_partial_width_windows
)
2825 <= WINDOW_TOTAL_COLS (it
->w
))))
2826 && NILP (BVAR (current_buffer
, truncate_lines
)))
2827 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2828 ? WINDOW_WRAP
: WORD_WRAP
;
2830 /* Get dimensions of truncation and continuation glyphs. These are
2831 displayed as fringe bitmaps under X, but we need them for such
2832 frames when the fringes are turned off. But leave the dimensions
2833 zero for tooltip frames, as these glyphs look ugly there and also
2834 sabotage calculations of tooltip dimensions in x-show-tip. */
2835 #ifdef HAVE_WINDOW_SYSTEM
2836 if (!(FRAME_WINDOW_P (it
->f
)
2837 && FRAMEP (tip_frame
)
2838 && it
->f
== XFRAME (tip_frame
)))
2841 if (it
->line_wrap
== TRUNCATE
)
2843 /* We will need the truncation glyph. */
2844 eassert (it
->glyph_row
== NULL
);
2845 produce_special_glyphs (it
, IT_TRUNCATION
);
2846 it
->truncation_pixel_width
= it
->pixel_width
;
2850 /* We will need the continuation glyph. */
2851 eassert (it
->glyph_row
== NULL
);
2852 produce_special_glyphs (it
, IT_CONTINUATION
);
2853 it
->continuation_pixel_width
= it
->pixel_width
;
2857 /* Reset these values to zero because the produce_special_glyphs
2858 above has changed them. */
2859 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2860 it
->phys_ascent
= it
->phys_descent
= 0;
2862 /* Set this after getting the dimensions of truncation and
2863 continuation glyphs, so that we don't produce glyphs when calling
2864 produce_special_glyphs, above. */
2865 it
->glyph_row
= row
;
2866 it
->area
= TEXT_AREA
;
2868 /* Get the dimensions of the display area. The display area
2869 consists of the visible window area plus a horizontally scrolled
2870 part to the left of the window. All x-values are relative to the
2871 start of this total display area. */
2872 if (base_face_id
!= DEFAULT_FACE_ID
)
2874 /* Mode lines, menu bar in terminal frames. */
2875 it
->first_visible_x
= 0;
2876 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2881 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2882 it
->last_visible_x
= (it
->first_visible_x
2883 + window_box_width (w
, TEXT_AREA
));
2885 /* If we truncate lines, leave room for the truncation glyph(s) at
2886 the right margin. Otherwise, leave room for the continuation
2887 glyph(s). Done only if the window has no right fringe. */
2888 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2890 if (it
->line_wrap
== TRUNCATE
)
2891 it
->last_visible_x
-= it
->truncation_pixel_width
;
2893 it
->last_visible_x
-= it
->continuation_pixel_width
;
2896 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2897 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2900 /* Leave room for a border glyph. */
2901 if (!FRAME_WINDOW_P (it
->f
)
2902 && !WINDOW_RIGHTMOST_P (it
->w
))
2903 it
->last_visible_x
-= 1;
2905 it
->last_visible_y
= window_text_bottom_y (w
);
2907 /* For mode lines and alike, arrange for the first glyph having a
2908 left box line if the face specifies a box. */
2909 if (base_face_id
!= DEFAULT_FACE_ID
)
2913 it
->face_id
= remapped_base_face_id
;
2915 /* If we have a boxed mode line, make the first character appear
2916 with a left box line. */
2917 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2918 if (face
&& face
->box
!= FACE_NO_BOX
)
2919 it
->start_of_box_run_p
= true;
2922 /* If a buffer position was specified, set the iterator there,
2923 getting overlays and face properties from that position. */
2924 if (charpos
>= BUF_BEG (current_buffer
))
2926 it
->stop_charpos
= charpos
;
2927 it
->end_charpos
= ZV
;
2928 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2929 IT_CHARPOS (*it
) = charpos
;
2930 IT_BYTEPOS (*it
) = bytepos
;
2932 /* We will rely on `reseat' to set this up properly, via
2933 handle_face_prop. */
2934 it
->face_id
= it
->base_face_id
;
2936 it
->start
= it
->current
;
2937 /* Do we need to reorder bidirectional text? Not if this is a
2938 unibyte buffer: by definition, none of the single-byte
2939 characters are strong R2L, so no reordering is needed. And
2940 bidi.c doesn't support unibyte buffers anyway. Also, don't
2941 reorder while we are loading loadup.el, since the tables of
2942 character properties needed for reordering are not yet
2946 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2949 /* If we are to reorder bidirectional text, init the bidi
2953 /* Since we don't know at this point whether there will be
2954 any R2L lines in the window, we reserve space for
2955 truncation/continuation glyphs even if only the left
2956 fringe is absent. */
2957 if (base_face_id
== DEFAULT_FACE_ID
2958 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2959 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2961 if (it
->line_wrap
== TRUNCATE
)
2962 it
->last_visible_x
-= it
->truncation_pixel_width
;
2964 it
->last_visible_x
-= it
->continuation_pixel_width
;
2966 /* Note the paragraph direction that this buffer wants to
2968 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2970 it
->paragraph_embedding
= L2R
;
2971 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2973 it
->paragraph_embedding
= R2L
;
2975 it
->paragraph_embedding
= NEUTRAL_DIR
;
2976 bidi_unshelve_cache (NULL
, false);
2977 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2981 /* Compute faces etc. */
2982 reseat (it
, it
->current
.pos
, true);
2989 /* Initialize IT for the display of window W with window start POS. */
2992 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2994 struct glyph_row
*row
;
2995 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2997 row
= w
->desired_matrix
->rows
+ first_vpos
;
2998 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2999 it
->first_vpos
= first_vpos
;
3001 /* Don't reseat to previous visible line start if current start
3002 position is in a string or image. */
3003 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3005 int first_y
= it
->current_y
;
3007 /* If window start is not at a line start, skip forward to POS to
3008 get the correct continuation lines width. */
3009 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3010 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3011 if (!start_at_line_beg_p
)
3015 reseat_at_previous_visible_line_start (it
);
3016 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3018 new_x
= it
->current_x
+ it
->pixel_width
;
3020 /* If lines are continued, this line may end in the middle
3021 of a multi-glyph character (e.g. a control character
3022 displayed as \003, or in the middle of an overlay
3023 string). In this case move_it_to above will not have
3024 taken us to the start of the continuation line but to the
3025 end of the continued line. */
3026 if (it
->current_x
> 0
3027 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3028 && (/* And glyph doesn't fit on the line. */
3029 new_x
> it
->last_visible_x
3030 /* Or it fits exactly and we're on a window
3032 || (new_x
== it
->last_visible_x
3033 && FRAME_WINDOW_P (it
->f
)
3034 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3035 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3036 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3038 if ((it
->current
.dpvec_index
>= 0
3039 || it
->current
.overlay_string_index
>= 0)
3040 /* If we are on a newline from a display vector or
3041 overlay string, then we are already at the end of
3042 a screen line; no need to go to the next line in
3043 that case, as this line is not really continued.
3044 (If we do go to the next line, C-e will not DTRT.) */
3047 set_iterator_to_next (it
, true);
3048 move_it_in_display_line_to (it
, -1, -1, 0);
3051 it
->continuation_lines_width
+= it
->current_x
;
3053 /* If the character at POS is displayed via a display
3054 vector, move_it_to above stops at the final glyph of
3055 IT->dpvec. To make the caller redisplay that character
3056 again (a.k.a. start at POS), we need to reset the
3057 dpvec_index to the beginning of IT->dpvec. */
3058 else if (it
->current
.dpvec_index
>= 0)
3059 it
->current
.dpvec_index
= 0;
3061 /* We're starting a new display line, not affected by the
3062 height of the continued line, so clear the appropriate
3063 fields in the iterator structure. */
3064 it
->max_ascent
= it
->max_descent
= 0;
3065 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3067 it
->current_y
= first_y
;
3069 it
->current_x
= it
->hpos
= 0;
3075 /* Return true if POS is a position in ellipses displayed for invisible
3076 text. W is the window we display, for text property lookup. */
3079 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3081 Lisp_Object prop
, window
;
3082 bool ellipses_p
= false;
3083 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3085 /* If POS specifies a position in a display vector, this might
3086 be for an ellipsis displayed for invisible text. We won't
3087 get the iterator set up for delivering that ellipsis unless
3088 we make sure that it gets aware of the invisible text. */
3089 if (pos
->dpvec_index
>= 0
3090 && pos
->overlay_string_index
< 0
3091 && CHARPOS (pos
->string_pos
) < 0
3093 && (XSETWINDOW (window
, w
),
3094 prop
= Fget_char_property (make_number (charpos
),
3095 Qinvisible
, window
),
3096 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3098 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3100 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3107 /* Initialize IT for stepping through current_buffer in window W,
3108 starting at position POS that includes overlay string and display
3109 vector/ control character translation position information. Value
3110 is false if there are overlay strings with newlines at POS. */
3113 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3115 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3117 bool overlay_strings_with_newlines
= false;
3119 /* If POS specifies a position in a display vector, this might
3120 be for an ellipsis displayed for invisible text. We won't
3121 get the iterator set up for delivering that ellipsis unless
3122 we make sure that it gets aware of the invisible text. */
3123 if (in_ellipses_for_invisible_text_p (pos
, w
))
3129 /* Keep in mind: the call to reseat in init_iterator skips invisible
3130 text, so we might end up at a position different from POS. This
3131 is only a problem when POS is a row start after a newline and an
3132 overlay starts there with an after-string, and the overlay has an
3133 invisible property. Since we don't skip invisible text in
3134 display_line and elsewhere immediately after consuming the
3135 newline before the row start, such a POS will not be in a string,
3136 but the call to init_iterator below will move us to the
3138 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3140 /* This only scans the current chunk -- it should scan all chunks.
3141 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3142 to 16 in 22.1 to make this a lesser problem. */
3143 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3145 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3146 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3148 while (s
< e
&& *s
!= '\n')
3153 overlay_strings_with_newlines
= true;
3158 /* If position is within an overlay string, set up IT to the right
3160 if (pos
->overlay_string_index
>= 0)
3164 /* If the first overlay string happens to have a `display'
3165 property for an image, the iterator will be set up for that
3166 image, and we have to undo that setup first before we can
3167 correct the overlay string index. */
3168 if (it
->method
== GET_FROM_IMAGE
)
3171 /* We already have the first chunk of overlay strings in
3172 IT->overlay_strings. Load more until the one for
3173 pos->overlay_string_index is in IT->overlay_strings. */
3174 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3176 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3177 it
->current
.overlay_string_index
= 0;
3180 load_overlay_strings (it
, 0);
3181 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3185 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3186 relative_index
= (it
->current
.overlay_string_index
3187 % OVERLAY_STRING_CHUNK_SIZE
);
3188 it
->string
= it
->overlay_strings
[relative_index
];
3189 eassert (STRINGP (it
->string
));
3190 it
->current
.string_pos
= pos
->string_pos
;
3191 it
->method
= GET_FROM_STRING
;
3192 it
->end_charpos
= SCHARS (it
->string
);
3193 /* Set up the bidi iterator for this overlay string. */
3196 it
->bidi_it
.string
.lstring
= it
->string
;
3197 it
->bidi_it
.string
.s
= NULL
;
3198 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3199 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3200 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3201 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3202 it
->bidi_it
.w
= it
->w
;
3203 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3204 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3206 /* Synchronize the state of the bidi iterator with
3207 pos->string_pos. For any string position other than
3208 zero, this will be done automagically when we resume
3209 iteration over the string and get_visually_first_element
3210 is called. But if string_pos is zero, and the string is
3211 to be reordered for display, we need to resync manually,
3212 since it could be that the iteration state recorded in
3213 pos ended at string_pos of 0 moving backwards in string. */
3214 if (CHARPOS (pos
->string_pos
) == 0)
3216 get_visually_first_element (it
);
3217 if (IT_STRING_CHARPOS (*it
) != 0)
3220 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3221 bidi_move_to_visually_next (&it
->bidi_it
);
3222 } while (it
->bidi_it
.charpos
!= 0);
3224 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3225 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3229 if (CHARPOS (pos
->string_pos
) >= 0)
3231 /* Recorded position is not in an overlay string, but in another
3232 string. This can only be a string from a `display' property.
3233 IT should already be filled with that string. */
3234 it
->current
.string_pos
= pos
->string_pos
;
3235 eassert (STRINGP (it
->string
));
3237 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3238 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3241 /* Restore position in display vector translations, control
3242 character translations or ellipses. */
3243 if (pos
->dpvec_index
>= 0)
3245 if (it
->dpvec
== NULL
)
3246 get_next_display_element (it
);
3247 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3248 it
->current
.dpvec_index
= pos
->dpvec_index
;
3252 return !overlay_strings_with_newlines
;
3256 /* Initialize IT for stepping through current_buffer in window W
3257 starting at ROW->start. */
3260 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3262 init_from_display_pos (it
, w
, &row
->start
);
3263 it
->start
= row
->start
;
3264 it
->continuation_lines_width
= row
->continuation_lines_width
;
3269 /* Initialize IT for stepping through current_buffer in window W
3270 starting in the line following ROW, i.e. starting at ROW->end.
3271 Value is false if there are overlay strings with newlines at ROW's
3275 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3277 bool success
= false;
3279 if (init_from_display_pos (it
, w
, &row
->end
))
3281 if (row
->continued_p
)
3282 it
->continuation_lines_width
3283 = row
->continuation_lines_width
+ row
->pixel_width
;
3294 /***********************************************************************
3296 ***********************************************************************/
3298 /* Called when IT reaches IT->stop_charpos. Handle text property and
3299 overlay changes. Set IT->stop_charpos to the next position where
3303 handle_stop (struct it
*it
)
3305 enum prop_handled handled
;
3306 bool handle_overlay_change_p
;
3310 it
->current
.dpvec_index
= -1;
3311 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3312 it
->ellipsis_p
= false;
3314 /* Use face of preceding text for ellipsis (if invisible) */
3315 if (it
->selective_display_ellipsis_p
)
3316 it
->saved_face_id
= it
->face_id
;
3318 /* Here's the description of the semantics of, and the logic behind,
3319 the various HANDLED_* statuses:
3321 HANDLED_NORMALLY means the handler did its job, and the loop
3322 should proceed to calling the next handler in order.
3324 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3325 change in the properties and overlays at current position, so the
3326 loop should be restarted, to re-invoke the handlers that were
3327 already called. This happens when fontification-functions were
3328 called by handle_fontified_prop, and actually fontified
3329 something. Another case where HANDLED_RECOMPUTE_PROPS is
3330 returned is when we discover overlay strings that need to be
3331 displayed right away. The loop below will continue for as long
3332 as the status is HANDLED_RECOMPUTE_PROPS.
3334 HANDLED_RETURN means return immediately to the caller, to
3335 continue iteration without calling any further handlers. This is
3336 used when we need to act on some property right away, for example
3337 when we need to display the ellipsis or a replacing display
3338 property, such as display string or image.
3340 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3341 consumed, and the handler switched to the next overlay string.
3342 This signals the loop below to refrain from looking for more
3343 overlays before all the overlay strings of the current overlay
3346 Some of the handlers called by the loop push the iterator state
3347 onto the stack (see 'push_it'), and arrange for the iteration to
3348 continue with another object, such as an image, a display string,
3349 or an overlay string. In most such cases, it->stop_charpos is
3350 set to the first character of the string, so that when the
3351 iteration resumes, this function will immediately be called
3352 again, to examine the properties at the beginning of the string.
3354 When a display or overlay string is exhausted, the iterator state
3355 is popped (see 'pop_it'), and iteration continues with the
3356 previous object. Again, in many such cases this function is
3357 called again to find the next position where properties might
3362 handled
= HANDLED_NORMALLY
;
3364 /* Call text property handlers. */
3365 for (p
= it_props
; p
->handler
; ++p
)
3367 handled
= p
->handler (it
);
3369 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3371 else if (handled
== HANDLED_RETURN
)
3373 /* We still want to show before and after strings from
3374 overlays even if the actual buffer text is replaced. */
3375 if (!handle_overlay_change_p
3377 /* Don't call get_overlay_strings_1 if we already
3378 have overlay strings loaded, because doing so
3379 will load them again and push the iterator state
3380 onto the stack one more time, which is not
3381 expected by the rest of the code that processes
3383 || (it
->current
.overlay_string_index
< 0
3384 && !get_overlay_strings_1 (it
, 0, false)))
3387 setup_for_ellipsis (it
, 0);
3388 /* When handling a display spec, we might load an
3389 empty string. In that case, discard it here. We
3390 used to discard it in handle_single_display_spec,
3391 but that causes get_overlay_strings_1, above, to
3392 ignore overlay strings that we must check. */
3393 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3397 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 it
->string_from_display_prop_p
= false;
3402 it
->from_disp_prop_p
= false;
3403 handle_overlay_change_p
= false;
3405 handled
= HANDLED_RECOMPUTE_PROPS
;
3408 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3409 handle_overlay_change_p
= false;
3412 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3414 /* Don't check for overlay strings below when set to deliver
3415 characters from a display vector. */
3416 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3417 handle_overlay_change_p
= false;
3419 /* Handle overlay changes.
3420 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3421 if it finds overlays. */
3422 if (handle_overlay_change_p
)
3423 handled
= handle_overlay_change (it
);
3428 setup_for_ellipsis (it
, 0);
3432 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3434 /* Determine where to stop next. */
3435 if (handled
== HANDLED_NORMALLY
)
3436 compute_stop_pos (it
);
3440 /* Compute IT->stop_charpos from text property and overlay change
3441 information for IT's current position. */
3444 compute_stop_pos (struct it
*it
)
3446 register INTERVAL iv
, next_iv
;
3447 Lisp_Object object
, limit
, position
;
3448 ptrdiff_t charpos
, bytepos
;
3450 if (STRINGP (it
->string
))
3452 /* Strings are usually short, so don't limit the search for
3454 it
->stop_charpos
= it
->end_charpos
;
3455 object
= it
->string
;
3457 charpos
= IT_STRING_CHARPOS (*it
);
3458 bytepos
= IT_STRING_BYTEPOS (*it
);
3464 /* If end_charpos is out of range for some reason, such as a
3465 misbehaving display function, rationalize it (Bug#5984). */
3466 if (it
->end_charpos
> ZV
)
3467 it
->end_charpos
= ZV
;
3468 it
->stop_charpos
= it
->end_charpos
;
3470 /* If next overlay change is in front of the current stop pos
3471 (which is IT->end_charpos), stop there. Note: value of
3472 next_overlay_change is point-max if no overlay change
3474 charpos
= IT_CHARPOS (*it
);
3475 bytepos
= IT_BYTEPOS (*it
);
3476 pos
= next_overlay_change (charpos
);
3477 if (pos
< it
->stop_charpos
)
3478 it
->stop_charpos
= pos
;
3480 /* Set up variables for computing the stop position from text
3481 property changes. */
3482 XSETBUFFER (object
, current_buffer
);
3483 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3486 /* Get the interval containing IT's position. Value is a null
3487 interval if there isn't such an interval. */
3488 position
= make_number (charpos
);
3489 iv
= validate_interval_range (object
, &position
, &position
, false);
3492 Lisp_Object values_here
[LAST_PROP_IDX
];
3495 /* Get properties here. */
3496 for (p
= it_props
; p
->handler
; ++p
)
3497 values_here
[p
->idx
] = textget (iv
->plist
,
3498 builtin_lisp_symbol (p
->name
));
3500 /* Look for an interval following iv that has different
3502 for (next_iv
= next_interval (iv
);
3505 || XFASTINT (limit
) > next_iv
->position
));
3506 next_iv
= next_interval (next_iv
))
3508 for (p
= it_props
; p
->handler
; ++p
)
3510 Lisp_Object new_value
= textget (next_iv
->plist
,
3511 builtin_lisp_symbol (p
->name
));
3512 if (!EQ (values_here
[p
->idx
], new_value
))
3522 if (INTEGERP (limit
)
3523 && next_iv
->position
>= XFASTINT (limit
))
3524 /* No text property change up to limit. */
3525 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3527 /* Text properties change in next_iv. */
3528 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3532 if (it
->cmp_it
.id
< 0)
3534 ptrdiff_t stoppos
= it
->end_charpos
;
3536 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3538 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3539 stoppos
, it
->string
);
3542 eassert (STRINGP (it
->string
)
3543 || (it
->stop_charpos
>= BEGV
3544 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3548 /* Return the position of the next overlay change after POS in
3549 current_buffer. Value is point-max if no overlay change
3550 follows. This is like `next-overlay-change' but doesn't use
3554 next_overlay_change (ptrdiff_t pos
)
3556 ptrdiff_t i
, noverlays
;
3558 Lisp_Object
*overlays
;
3561 /* Get all overlays at the given position. */
3562 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3564 /* If any of these overlays ends before endpos,
3565 use its ending point instead. */
3566 for (i
= 0; i
< noverlays
; ++i
)
3571 oend
= OVERLAY_END (overlays
[i
]);
3572 oendpos
= OVERLAY_POSITION (oend
);
3573 endpos
= min (endpos
, oendpos
);
3580 /* How many characters forward to search for a display property or
3581 display string. Searching too far forward makes the bidi display
3582 sluggish, especially in small windows. */
3583 #define MAX_DISP_SCAN 250
3585 /* Return the character position of a display string at or after
3586 position specified by POSITION. If no display string exists at or
3587 after POSITION, return ZV. A display string is either an overlay
3588 with `display' property whose value is a string, or a `display'
3589 text property whose value is a string. STRING is data about the
3590 string to iterate; if STRING->lstring is nil, we are iterating a
3591 buffer. FRAME_WINDOW_P is true when we are displaying a window
3592 on a GUI frame. DISP_PROP is set to zero if we searched
3593 MAX_DISP_SCAN characters forward without finding any display
3594 strings, non-zero otherwise. It is set to 2 if the display string
3595 uses any kind of `(space ...)' spec that will produce a stretch of
3596 white space in the text area. */
3598 compute_display_string_pos (struct text_pos
*position
,
3599 struct bidi_string_data
*string
,
3601 bool frame_window_p
, int *disp_prop
)
3603 /* OBJECT = nil means current buffer. */
3604 Lisp_Object object
, object1
;
3605 Lisp_Object pos
, spec
, limpos
;
3606 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3607 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3608 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3609 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3611 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3612 struct text_pos tpos
;
3615 if (string
&& STRINGP (string
->lstring
))
3616 object1
= object
= string
->lstring
;
3617 else if (w
&& !string_p
)
3619 XSETWINDOW (object
, w
);
3623 object1
= object
= Qnil
;
3628 /* We don't support display properties whose values are strings
3629 that have display string properties. */
3630 || string
->from_disp_str
3631 /* C strings cannot have display properties. */
3632 || (string
->s
&& !STRINGP (object
)))
3638 /* If the character at CHARPOS is where the display string begins,
3640 pos
= make_number (charpos
);
3641 if (STRINGP (object
))
3642 bufpos
= string
->bufpos
;
3646 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3648 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3651 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3659 /* Look forward for the first character with a `display' property
3660 that will replace the underlying text when displayed. */
3661 limpos
= make_number (lim
);
3663 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3664 CHARPOS (tpos
) = XFASTINT (pos
);
3665 if (CHARPOS (tpos
) >= lim
)
3670 if (STRINGP (object
))
3671 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3673 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3674 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3675 if (!STRINGP (object
))
3676 bufpos
= CHARPOS (tpos
);
3677 } while (NILP (spec
)
3678 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3679 bufpos
, frame_window_p
)));
3683 return CHARPOS (tpos
);
3686 /* Return the character position of the end of the display string that
3687 started at CHARPOS. If there's no display string at CHARPOS,
3688 return -1. A display string is either an overlay with `display'
3689 property whose value is a string or a `display' text property whose
3690 value is a string. */
3692 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3694 /* OBJECT = nil means current buffer. */
3695 Lisp_Object object
=
3696 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3697 Lisp_Object pos
= make_number (charpos
);
3699 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3701 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3704 /* It could happen that the display property or overlay was removed
3705 since we found it in compute_display_string_pos above. One way
3706 this can happen is if JIT font-lock was called (through
3707 handle_fontified_prop), and jit-lock-functions remove text
3708 properties or overlays from the portion of buffer that includes
3709 CHARPOS. Muse mode is known to do that, for example. In this
3710 case, we return -1 to the caller, to signal that no display
3711 string is actually present at CHARPOS. See bidi_fetch_char for
3712 how this is handled.
3714 An alternative would be to never look for display properties past
3715 it->stop_charpos. But neither compute_display_string_pos nor
3716 bidi_fetch_char that calls it know or care where the next
3718 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3721 /* Look forward for the first character where the `display' property
3723 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3725 return XFASTINT (pos
);
3730 /***********************************************************************
3732 ***********************************************************************/
3734 /* Handle changes in the `fontified' property of the current buffer by
3735 calling hook functions from Qfontification_functions to fontify
3738 static enum prop_handled
3739 handle_fontified_prop (struct it
*it
)
3741 Lisp_Object prop
, pos
;
3742 enum prop_handled handled
= HANDLED_NORMALLY
;
3744 if (!NILP (Vmemory_full
))
3747 /* Get the value of the `fontified' property at IT's current buffer
3748 position. (The `fontified' property doesn't have a special
3749 meaning in strings.) If the value is nil, call functions from
3750 Qfontification_functions. */
3751 if (!STRINGP (it
->string
)
3753 && !NILP (Vfontification_functions
)
3754 && !NILP (Vrun_hooks
)
3755 && (pos
= make_number (IT_CHARPOS (*it
)),
3756 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3757 /* Ignore the special cased nil value always present at EOB since
3758 no amount of fontifying will be able to change it. */
3759 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3761 ptrdiff_t count
= SPECPDL_INDEX ();
3763 struct buffer
*obuf
= current_buffer
;
3764 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3765 bool old_clip_changed
= current_buffer
->clip_changed
;
3767 val
= Vfontification_functions
;
3768 specbind (Qfontification_functions
, Qnil
);
3770 eassert (it
->end_charpos
== ZV
);
3772 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3773 safe_call1 (val
, pos
);
3776 Lisp_Object fns
, fn
;
3780 for (; CONSP (val
); val
= XCDR (val
))
3786 /* A value of t indicates this hook has a local
3787 binding; it means to run the global binding too.
3788 In a global value, t should not occur. If it
3789 does, we must ignore it to avoid an endless
3791 for (fns
= Fdefault_value (Qfontification_functions
);
3797 safe_call1 (fn
, pos
);
3801 safe_call1 (fn
, pos
);
3805 unbind_to (count
, Qnil
);
3807 /* Fontification functions routinely call `save-restriction'.
3808 Normally, this tags clip_changed, which can confuse redisplay
3809 (see discussion in Bug#6671). Since we don't perform any
3810 special handling of fontification changes in the case where
3811 `save-restriction' isn't called, there's no point doing so in
3812 this case either. So, if the buffer's restrictions are
3813 actually left unchanged, reset clip_changed. */
3814 if (obuf
== current_buffer
)
3816 if (begv
== BEGV
&& zv
== ZV
)
3817 current_buffer
->clip_changed
= old_clip_changed
;
3819 /* There isn't much we can reasonably do to protect against
3820 misbehaving fontification, but here's a fig leaf. */
3821 else if (BUFFER_LIVE_P (obuf
))
3822 set_buffer_internal_1 (obuf
);
3824 /* The fontification code may have added/removed text.
3825 It could do even a lot worse, but let's at least protect against
3826 the most obvious case where only the text past `pos' gets changed',
3827 as is/was done in grep.el where some escapes sequences are turned
3828 into face properties (bug#7876). */
3829 it
->end_charpos
= ZV
;
3831 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3832 something. This avoids an endless loop if they failed to
3833 fontify the text for which reason ever. */
3834 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3835 handled
= HANDLED_RECOMPUTE_PROPS
;
3843 /***********************************************************************
3845 ***********************************************************************/
3847 /* Set up iterator IT from face properties at its current position.
3848 Called from handle_stop. */
3850 static enum prop_handled
3851 handle_face_prop (struct it
*it
)
3854 ptrdiff_t next_stop
;
3856 if (!STRINGP (it
->string
))
3859 = face_at_buffer_position (it
->w
,
3863 + TEXT_PROP_DISTANCE_LIMIT
),
3864 false, it
->base_face_id
);
3866 /* Is this a start of a run of characters with box face?
3867 Caveat: this can be called for a freshly initialized
3868 iterator; face_id is -1 in this case. We know that the new
3869 face will not change until limit, i.e. if the new face has a
3870 box, all characters up to limit will have one. But, as
3871 usual, we don't know whether limit is really the end. */
3872 if (new_face_id
!= it
->face_id
)
3874 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3875 /* If it->face_id is -1, old_face below will be NULL, see
3876 the definition of FACE_FROM_ID. This will happen if this
3877 is the initial call that gets the face. */
3878 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3880 /* If the value of face_id of the iterator is -1, we have to
3881 look in front of IT's position and see whether there is a
3882 face there that's different from new_face_id. */
3883 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3885 int prev_face_id
= face_before_it_pos (it
);
3887 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3890 /* If the new face has a box, but the old face does not,
3891 this is the start of a run of characters with box face,
3892 i.e. this character has a shadow on the left side. */
3893 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3894 && (old_face
== NULL
|| !old_face
->box
));
3895 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3903 Lisp_Object from_overlay
3904 = (it
->current
.overlay_string_index
>= 0
3905 ? it
->string_overlays
[it
->current
.overlay_string_index
3906 % OVERLAY_STRING_CHUNK_SIZE
]
3909 /* See if we got to this string directly or indirectly from
3910 an overlay property. That includes the before-string or
3911 after-string of an overlay, strings in display properties
3912 provided by an overlay, their text properties, etc.
3914 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3915 if (! NILP (from_overlay
))
3916 for (i
= it
->sp
- 1; i
>= 0; i
--)
3918 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3920 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3921 % OVERLAY_STRING_CHUNK_SIZE
];
3922 else if (! NILP (it
->stack
[i
].from_overlay
))
3923 from_overlay
= it
->stack
[i
].from_overlay
;
3925 if (!NILP (from_overlay
))
3929 if (! NILP (from_overlay
))
3931 bufpos
= IT_CHARPOS (*it
);
3932 /* For a string from an overlay, the base face depends
3933 only on text properties and ignores overlays. */
3935 = face_for_overlay_string (it
->w
,
3939 + TEXT_PROP_DISTANCE_LIMIT
),
3947 /* For strings from a `display' property, use the face at
3948 IT's current buffer position as the base face to merge
3949 with, so that overlay strings appear in the same face as
3950 surrounding text, unless they specify their own faces.
3951 For strings from wrap-prefix and line-prefix properties,
3952 use the default face, possibly remapped via
3953 Vface_remapping_alist. */
3954 /* Note that the fact that we use the face at _buffer_
3955 position means that a 'display' property on an overlay
3956 string will not inherit the face of that overlay string,
3957 but will instead revert to the face of buffer text
3958 covered by the overlay. This is visible, e.g., when the
3959 overlay specifies a box face, but neither the buffer nor
3960 the display string do. This sounds like a design bug,
3961 but Emacs always did that since v21.1, so changing that
3962 might be a big deal. */
3963 base_face_id
= it
->string_from_prefix_prop_p
3964 ? (!NILP (Vface_remapping_alist
)
3965 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3967 : underlying_face_id (it
);
3970 new_face_id
= face_at_string_position (it
->w
,
3972 IT_STRING_CHARPOS (*it
),
3975 base_face_id
, false);
3977 /* Is this a start of a run of characters with box? Caveat:
3978 this can be called for a freshly allocated iterator; face_id
3979 is -1 is this case. We know that the new face will not
3980 change until the next check pos, i.e. if the new face has a
3981 box, all characters up to that position will have a
3982 box. But, as usual, we don't know whether that position
3983 is really the end. */
3984 if (new_face_id
!= it
->face_id
)
3986 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3987 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3989 /* If new face has a box but old face hasn't, this is the
3990 start of a run of characters with box, i.e. it has a
3991 shadow on the left side. */
3992 it
->start_of_box_run_p
3993 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3994 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3998 it
->face_id
= new_face_id
;
3999 return HANDLED_NORMALLY
;
4003 /* Return the ID of the face ``underlying'' IT's current position,
4004 which is in a string. If the iterator is associated with a
4005 buffer, return the face at IT's current buffer position.
4006 Otherwise, use the iterator's base_face_id. */
4009 underlying_face_id (struct it
*it
)
4011 int face_id
= it
->base_face_id
, i
;
4013 eassert (STRINGP (it
->string
));
4015 for (i
= it
->sp
- 1; i
>= 0; --i
)
4016 if (NILP (it
->stack
[i
].string
))
4017 face_id
= it
->stack
[i
].face_id
;
4023 /* Compute the face one character before or after the current position
4024 of IT, in the visual order. BEFORE_P means get the face
4025 in front (to the left in L2R paragraphs, to the right in R2L
4026 paragraphs) of IT's screen position. Value is the ID of the face. */
4029 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4032 ptrdiff_t next_check_charpos
;
4034 void *it_copy_data
= NULL
;
4036 eassert (it
->s
== NULL
);
4038 if (STRINGP (it
->string
))
4040 ptrdiff_t bufpos
, charpos
;
4043 /* No face change past the end of the string (for the case
4044 we are padding with spaces). No face change before the
4046 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4047 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4052 /* Set charpos to the position before or after IT's current
4053 position, in the logical order, which in the non-bidi
4054 case is the same as the visual order. */
4056 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4057 else if (it
->what
== IT_COMPOSITION
)
4058 /* For composition, we must check the character after the
4060 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4062 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4068 /* With bidi iteration, the character before the current
4069 in the visual order cannot be found by simple
4070 iteration, because "reverse" reordering is not
4071 supported. Instead, we need to start from the string
4072 beginning and go all the way to the current string
4073 position, remembering the previous position. */
4074 /* Ignore face changes before the first visible
4075 character on this display line. */
4076 if (it
->current_x
<= it
->first_visible_x
)
4078 SAVE_IT (it_copy
, *it
, it_copy_data
);
4079 IT_STRING_CHARPOS (it_copy
) = 0;
4080 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4084 charpos
= IT_STRING_CHARPOS (it_copy
);
4085 if (charpos
>= SCHARS (it
->string
))
4087 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4089 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4091 RESTORE_IT (it
, it
, it_copy_data
);
4095 /* Set charpos to the string position of the character
4096 that comes after IT's current position in the visual
4098 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4102 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4104 charpos
= it_copy
.bidi_it
.charpos
;
4107 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4109 if (it
->current
.overlay_string_index
>= 0)
4110 bufpos
= IT_CHARPOS (*it
);
4114 base_face_id
= underlying_face_id (it
);
4116 /* Get the face for ASCII, or unibyte. */
4117 face_id
= face_at_string_position (it
->w
,
4121 &next_check_charpos
,
4122 base_face_id
, false);
4124 /* Correct the face for charsets different from ASCII. Do it
4125 for the multibyte case only. The face returned above is
4126 suitable for unibyte text if IT->string is unibyte. */
4127 if (STRING_MULTIBYTE (it
->string
))
4129 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4130 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4132 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4134 c
= string_char_and_length (p
, &len
);
4135 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4140 struct text_pos pos
;
4142 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4143 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4146 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4147 pos
= it
->current
.pos
;
4152 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4155 if (it
->what
== IT_COMPOSITION
)
4157 /* For composition, we must check the position after
4159 pos
.charpos
+= it
->cmp_it
.nchars
;
4160 pos
.bytepos
+= it
->len
;
4163 INC_TEXT_POS (pos
, it
->multibyte_p
);
4172 /* With bidi iteration, the character before the current
4173 in the visual order cannot be found by simple
4174 iteration, because "reverse" reordering is not
4175 supported. Instead, we need to use the move_it_*
4176 family of functions, and move to the previous
4177 character starting from the beginning of the visual
4179 /* Ignore face changes before the first visible
4180 character on this display line. */
4181 if (it
->current_x
<= it
->first_visible_x
)
4183 SAVE_IT (it_copy
, *it
, it_copy_data
);
4184 /* Implementation note: Since move_it_in_display_line
4185 works in the iterator geometry, and thinks the first
4186 character is always the leftmost, even in R2L lines,
4187 we don't need to distinguish between the R2L and L2R
4189 current_x
= it_copy
.current_x
;
4190 move_it_vertically_backward (&it_copy
, 0);
4191 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4192 pos
= it_copy
.current
.pos
;
4193 RESTORE_IT (it
, it
, it_copy_data
);
4197 /* Set charpos to the buffer position of the character
4198 that comes after IT's current position in the visual
4200 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4204 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4207 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4210 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4212 /* Determine face for CHARSET_ASCII, or unibyte. */
4213 face_id
= face_at_buffer_position (it
->w
,
4215 &next_check_charpos
,
4218 /* Correct the face for charsets different from ASCII. Do it
4219 for the multibyte case only. The face returned above is
4220 suitable for unibyte text if current_buffer is unibyte. */
4221 if (it
->multibyte_p
)
4223 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4224 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4225 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4234 /***********************************************************************
4236 ***********************************************************************/
4238 /* Set up iterator IT from invisible properties at its current
4239 position. Called from handle_stop. */
4241 static enum prop_handled
4242 handle_invisible_prop (struct it
*it
)
4244 enum prop_handled handled
= HANDLED_NORMALLY
;
4248 if (STRINGP (it
->string
))
4250 Lisp_Object end_charpos
, limit
;
4252 /* Get the value of the invisible text property at the
4253 current position. Value will be nil if there is no such
4255 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4256 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4257 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4259 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4261 /* Record whether we have to display an ellipsis for the
4263 bool display_ellipsis_p
= (invis
== 2);
4264 ptrdiff_t len
, endpos
;
4266 handled
= HANDLED_RECOMPUTE_PROPS
;
4268 /* Get the position at which the next visible text can be
4269 found in IT->string, if any. */
4270 endpos
= len
= SCHARS (it
->string
);
4271 XSETINT (limit
, len
);
4275 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4277 /* Since LIMIT is always an integer, so should be the
4278 value returned by Fnext_single_property_change. */
4279 eassert (INTEGERP (end_charpos
));
4280 if (INTEGERP (end_charpos
))
4282 endpos
= XFASTINT (end_charpos
);
4283 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4284 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4286 display_ellipsis_p
= true;
4288 else /* Should never happen; but if it does, exit the loop. */
4291 while (invis
!= 0 && endpos
< len
);
4293 if (display_ellipsis_p
)
4294 it
->ellipsis_p
= true;
4298 /* Text at END_CHARPOS is visible. Move IT there. */
4299 struct text_pos old
;
4302 old
= it
->current
.string_pos
;
4303 oldpos
= CHARPOS (old
);
4306 if (it
->bidi_it
.first_elt
4307 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4308 bidi_paragraph_init (it
->paragraph_embedding
,
4309 &it
->bidi_it
, true);
4310 /* Bidi-iterate out of the invisible text. */
4313 bidi_move_to_visually_next (&it
->bidi_it
);
4315 while (oldpos
<= it
->bidi_it
.charpos
4316 && it
->bidi_it
.charpos
< endpos
);
4318 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4319 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4320 if (IT_CHARPOS (*it
) >= endpos
)
4321 it
->prev_stop
= endpos
;
4325 IT_STRING_CHARPOS (*it
) = endpos
;
4326 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4331 /* The rest of the string is invisible. If this is an
4332 overlay string, proceed with the next overlay string
4333 or whatever comes and return a character from there. */
4334 if (it
->current
.overlay_string_index
>= 0
4335 && !display_ellipsis_p
)
4337 next_overlay_string (it
);
4338 /* Don't check for overlay strings when we just
4339 finished processing them. */
4340 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4344 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4345 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4352 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4353 Lisp_Object pos
, overlay
;
4355 /* First of all, is there invisible text at this position? */
4356 tem
= start_charpos
= IT_CHARPOS (*it
);
4357 pos
= make_number (tem
);
4358 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4360 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4362 /* If we are on invisible text, skip over it. */
4363 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4365 /* Record whether we have to display an ellipsis for the
4367 bool display_ellipsis_p
= invis
== 2;
4369 handled
= HANDLED_RECOMPUTE_PROPS
;
4371 /* Loop skipping over invisible text. The loop is left at
4372 ZV or with IT on the first char being visible again. */
4375 /* Try to skip some invisible text. Return value is the
4376 position reached which can be equal to where we start
4377 if there is nothing invisible there. This skips both
4378 over invisible text properties and overlays with
4379 invisible property. */
4380 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4382 /* If we skipped nothing at all we weren't at invisible
4383 text in the first place. If everything to the end of
4384 the buffer was skipped, end the loop. */
4385 if (newpos
== tem
|| newpos
>= ZV
)
4389 /* We skipped some characters but not necessarily
4390 all there are. Check if we ended up on visible
4391 text. Fget_char_property returns the property of
4392 the char before the given position, i.e. if we
4393 get invis = 0, this means that the char at
4394 newpos is visible. */
4395 pos
= make_number (newpos
);
4396 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4397 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4400 /* If we ended up on invisible text, proceed to
4401 skip starting with next_stop. */
4405 /* If there are adjacent invisible texts, don't lose the
4406 second one's ellipsis. */
4408 display_ellipsis_p
= true;
4412 /* The position newpos is now either ZV or on visible text. */
4415 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4417 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4419 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4421 /* If the invisible text ends on a newline or on a
4422 character after a newline, we can avoid the costly,
4423 character by character, bidi iteration to NEWPOS, and
4424 instead simply reseat the iterator there. That's
4425 because all bidi reordering information is tossed at
4426 the newline. This is a big win for modes that hide
4427 complete lines, like Outline, Org, etc. */
4428 if (on_newline
|| after_newline
)
4430 struct text_pos tpos
;
4431 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4433 SET_TEXT_POS (tpos
, newpos
, bpos
);
4434 reseat_1 (it
, tpos
, false);
4435 /* If we reseat on a newline/ZV, we need to prep the
4436 bidi iterator for advancing to the next character
4437 after the newline/EOB, keeping the current paragraph
4438 direction (so that PRODUCE_GLYPHS does TRT wrt
4439 prepending/appending glyphs to a glyph row). */
4442 it
->bidi_it
.first_elt
= false;
4443 it
->bidi_it
.paragraph_dir
= pdir
;
4444 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4445 it
->bidi_it
.nchars
= 1;
4446 it
->bidi_it
.ch_len
= 1;
4449 else /* Must use the slow method. */
4451 /* With bidi iteration, the region of invisible text
4452 could start and/or end in the middle of a
4453 non-base embedding level. Therefore, we need to
4454 skip invisible text using the bidi iterator,
4455 starting at IT's current position, until we find
4456 ourselves outside of the invisible text.
4457 Skipping invisible text _after_ bidi iteration
4458 avoids affecting the visual order of the
4459 displayed text when invisible properties are
4460 added or removed. */
4461 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4463 /* If we were `reseat'ed to a new paragraph,
4464 determine the paragraph base direction. We
4465 need to do it now because
4466 next_element_from_buffer may not have a
4467 chance to do it, if we are going to skip any
4468 text at the beginning, which resets the
4470 bidi_paragraph_init (it
->paragraph_embedding
,
4471 &it
->bidi_it
, true);
4475 bidi_move_to_visually_next (&it
->bidi_it
);
4477 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4478 && it
->bidi_it
.charpos
< newpos
);
4479 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4480 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4481 /* If we overstepped NEWPOS, record its position in
4482 the iterator, so that we skip invisible text if
4483 later the bidi iteration lands us in the
4484 invisible region again. */
4485 if (IT_CHARPOS (*it
) >= newpos
)
4486 it
->prev_stop
= newpos
;
4491 IT_CHARPOS (*it
) = newpos
;
4492 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4495 if (display_ellipsis_p
)
4497 /* Make sure that the glyphs of the ellipsis will get
4498 correct `charpos' values. If we would not update
4499 it->position here, the glyphs would belong to the
4500 last visible character _before_ the invisible
4501 text, which confuses `set_cursor_from_row'.
4503 We use the last invisible position instead of the
4504 first because this way the cursor is always drawn on
4505 the first "." of the ellipsis, whenever PT is inside
4506 the invisible text. Otherwise the cursor would be
4507 placed _after_ the ellipsis when the point is after the
4508 first invisible character. */
4509 if (!STRINGP (it
->object
))
4511 it
->position
.charpos
= newpos
- 1;
4512 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4516 /* If there are before-strings at the start of invisible
4517 text, and the text is invisible because of a text
4518 property, arrange to show before-strings because 20.x did
4519 it that way. (If the text is invisible because of an
4520 overlay property instead of a text property, this is
4521 already handled in the overlay code.) */
4523 && get_overlay_strings (it
, it
->stop_charpos
))
4525 handled
= HANDLED_RECOMPUTE_PROPS
;
4528 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4529 /* The call to get_overlay_strings above recomputes
4530 it->stop_charpos, but it only considers changes
4531 in properties and overlays beyond iterator's
4532 current position. This causes us to miss changes
4533 that happen exactly where the invisible property
4534 ended. So we play it safe here and force the
4535 iterator to check for potential stop positions
4536 immediately after the invisible text. Note that
4537 if get_overlay_strings returns true, it
4538 normally also pushed the iterator stack, so we
4539 need to update the stop position in the slot
4540 below the current one. */
4541 it
->stack
[it
->sp
- 1].stop_charpos
4542 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4545 else if (display_ellipsis_p
)
4547 it
->ellipsis_p
= true;
4548 /* Let the ellipsis display before
4549 considering any properties of the following char.
4550 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4551 handled
= HANDLED_RETURN
;
4560 /* Make iterator IT return `...' next.
4561 Replaces LEN characters from buffer. */
4564 setup_for_ellipsis (struct it
*it
, int len
)
4566 /* Use the display table definition for `...'. Invalid glyphs
4567 will be handled by the method returning elements from dpvec. */
4568 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4570 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4571 it
->dpvec
= v
->contents
;
4572 it
->dpend
= v
->contents
+ v
->header
.size
;
4576 /* Default `...'. */
4577 it
->dpvec
= default_invis_vector
;
4578 it
->dpend
= default_invis_vector
+ 3;
4581 it
->dpvec_char_len
= len
;
4582 it
->current
.dpvec_index
= 0;
4583 it
->dpvec_face_id
= -1;
4585 /* Remember the current face id in case glyphs specify faces.
4586 IT's face is restored in set_iterator_to_next.
4587 saved_face_id was set to preceding char's face in handle_stop. */
4588 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4589 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4591 /* If the ellipsis represents buffer text, it means we advanced in
4592 the buffer, so we should no longer ignore overlay strings. */
4593 if (it
->method
== GET_FROM_BUFFER
)
4594 it
->ignore_overlay_strings_at_pos_p
= false;
4596 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4597 it
->ellipsis_p
= true;
4602 /***********************************************************************
4604 ***********************************************************************/
4606 /* Set up iterator IT from `display' property at its current position.
4607 Called from handle_stop.
4608 We return HANDLED_RETURN if some part of the display property
4609 overrides the display of the buffer text itself.
4610 Otherwise we return HANDLED_NORMALLY. */
4612 static enum prop_handled
4613 handle_display_prop (struct it
*it
)
4615 Lisp_Object propval
, object
, overlay
;
4616 struct text_pos
*position
;
4618 /* Nonzero if some property replaces the display of the text itself. */
4619 int display_replaced
= 0;
4621 if (STRINGP (it
->string
))
4623 object
= it
->string
;
4624 position
= &it
->current
.string_pos
;
4625 bufpos
= CHARPOS (it
->current
.pos
);
4629 XSETWINDOW (object
, it
->w
);
4630 position
= &it
->current
.pos
;
4631 bufpos
= CHARPOS (*position
);
4634 /* Reset those iterator values set from display property values. */
4635 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4636 it
->space_width
= Qnil
;
4637 it
->font_height
= Qnil
;
4640 /* We don't support recursive `display' properties, i.e. string
4641 values that have a string `display' property, that have a string
4642 `display' property etc. */
4643 if (!it
->string_from_display_prop_p
)
4644 it
->area
= TEXT_AREA
;
4646 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4647 Qdisplay
, object
, &overlay
);
4649 return HANDLED_NORMALLY
;
4650 /* Now OVERLAY is the overlay that gave us this property, or nil
4651 if it was a text property. */
4653 if (!STRINGP (it
->string
))
4654 object
= it
->w
->contents
;
4656 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4658 FRAME_WINDOW_P (it
->f
));
4659 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4662 /* Subroutine of handle_display_prop. Returns non-zero if the display
4663 specification in SPEC is a replacing specification, i.e. it would
4664 replace the text covered by `display' property with something else,
4665 such as an image or a display string. If SPEC includes any kind or
4666 `(space ...) specification, the value is 2; this is used by
4667 compute_display_string_pos, which see.
4669 See handle_single_display_spec for documentation of arguments.
4670 FRAME_WINDOW_P is true if the window being redisplayed is on a
4671 GUI frame; this argument is used only if IT is NULL, see below.
4673 IT can be NULL, if this is called by the bidi reordering code
4674 through compute_display_string_pos, which see. In that case, this
4675 function only examines SPEC, but does not otherwise "handle" it, in
4676 the sense that it doesn't set up members of IT from the display
4679 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4680 Lisp_Object overlay
, struct text_pos
*position
,
4681 ptrdiff_t bufpos
, bool frame_window_p
)
4686 /* Simple specifications. */
4687 && !EQ (XCAR (spec
), Qimage
)
4688 && !EQ (XCAR (spec
), Qspace
)
4689 && !EQ (XCAR (spec
), Qwhen
)
4690 && !EQ (XCAR (spec
), Qslice
)
4691 && !EQ (XCAR (spec
), Qspace_width
)
4692 && !EQ (XCAR (spec
), Qheight
)
4693 && !EQ (XCAR (spec
), Qraise
)
4694 /* Marginal area specifications. */
4695 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4696 && !EQ (XCAR (spec
), Qleft_fringe
)
4697 && !EQ (XCAR (spec
), Qright_fringe
)
4698 && !NILP (XCAR (spec
)))
4700 for (; CONSP (spec
); spec
= XCDR (spec
))
4702 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4703 overlay
, position
, bufpos
,
4704 replacing
, frame_window_p
);
4708 /* If some text in a string is replaced, `position' no
4709 longer points to the position of `object'. */
4710 if (!it
|| STRINGP (object
))
4715 else if (VECTORP (spec
))
4718 for (i
= 0; i
< ASIZE (spec
); ++i
)
4720 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4721 overlay
, position
, bufpos
,
4722 replacing
, frame_window_p
);
4726 /* If some text in a string is replaced, `position' no
4727 longer points to the position of `object'. */
4728 if (!it
|| STRINGP (object
))
4734 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4735 bufpos
, 0, frame_window_p
);
4739 /* Value is the position of the end of the `display' property starting
4740 at START_POS in OBJECT. */
4742 static struct text_pos
4743 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4746 struct text_pos end_pos
;
4748 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4749 Qdisplay
, object
, Qnil
);
4750 CHARPOS (end_pos
) = XFASTINT (end
);
4751 if (STRINGP (object
))
4752 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4754 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4760 /* Set up IT from a single `display' property specification SPEC. OBJECT
4761 is the object in which the `display' property was found. *POSITION
4762 is the position in OBJECT at which the `display' property was found.
4763 BUFPOS is the buffer position of OBJECT (different from POSITION if
4764 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4765 previously saw a display specification which already replaced text
4766 display with something else, for example an image; we ignore such
4767 properties after the first one has been processed.
4769 OVERLAY is the overlay this `display' property came from,
4770 or nil if it was a text property.
4772 If SPEC is a `space' or `image' specification, and in some other
4773 cases too, set *POSITION to the position where the `display'
4776 If IT is NULL, only examine the property specification in SPEC, but
4777 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4778 is intended to be displayed in a window on a GUI frame.
4780 Value is non-zero if something was found which replaces the display
4781 of buffer or string text. */
4784 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4785 Lisp_Object overlay
, struct text_pos
*position
,
4786 ptrdiff_t bufpos
, int display_replaced
,
4787 bool frame_window_p
)
4790 Lisp_Object location
, value
;
4791 struct text_pos start_pos
= *position
;
4793 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4794 If the result is non-nil, use VALUE instead of SPEC. */
4796 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4805 if (!NILP (form
) && !EQ (form
, Qt
))
4807 ptrdiff_t count
= SPECPDL_INDEX ();
4809 /* Bind `object' to the object having the `display' property, a
4810 buffer or string. Bind `position' to the position in the
4811 object where the property was found, and `buffer-position'
4812 to the current position in the buffer. */
4815 XSETBUFFER (object
, current_buffer
);
4816 specbind (Qobject
, object
);
4817 specbind (Qposition
, make_number (CHARPOS (*position
)));
4818 specbind (Qbuffer_position
, make_number (bufpos
));
4819 form
= safe_eval (form
);
4820 unbind_to (count
, Qnil
);
4826 /* Handle `(height HEIGHT)' specifications. */
4828 && EQ (XCAR (spec
), Qheight
)
4829 && CONSP (XCDR (spec
)))
4833 if (!FRAME_WINDOW_P (it
->f
))
4836 it
->font_height
= XCAR (XCDR (spec
));
4837 if (!NILP (it
->font_height
))
4839 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4840 int new_height
= -1;
4842 if (CONSP (it
->font_height
)
4843 && (EQ (XCAR (it
->font_height
), Qplus
)
4844 || EQ (XCAR (it
->font_height
), Qminus
))
4845 && CONSP (XCDR (it
->font_height
))
4846 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4848 /* `(+ N)' or `(- N)' where N is an integer. */
4849 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4850 if (EQ (XCAR (it
->font_height
), Qplus
))
4852 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4854 else if (FUNCTIONP (it
->font_height
))
4856 /* Call function with current height as argument.
4857 Value is the new height. */
4859 height
= safe_call1 (it
->font_height
,
4860 face
->lface
[LFACE_HEIGHT_INDEX
]);
4861 if (NUMBERP (height
))
4862 new_height
= XFLOATINT (height
);
4864 else if (NUMBERP (it
->font_height
))
4866 /* Value is a multiple of the canonical char height. */
4869 f
= FACE_FROM_ID (it
->f
,
4870 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4871 new_height
= (XFLOATINT (it
->font_height
)
4872 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4876 /* Evaluate IT->font_height with `height' bound to the
4877 current specified height to get the new height. */
4878 ptrdiff_t count
= SPECPDL_INDEX ();
4880 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4881 value
= safe_eval (it
->font_height
);
4882 unbind_to (count
, Qnil
);
4884 if (NUMBERP (value
))
4885 new_height
= XFLOATINT (value
);
4889 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4896 /* Handle `(space-width WIDTH)'. */
4898 && EQ (XCAR (spec
), Qspace_width
)
4899 && CONSP (XCDR (spec
)))
4903 if (!FRAME_WINDOW_P (it
->f
))
4906 value
= XCAR (XCDR (spec
));
4907 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4908 it
->space_width
= value
;
4914 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4916 && EQ (XCAR (spec
), Qslice
))
4922 if (!FRAME_WINDOW_P (it
->f
))
4925 if (tem
= XCDR (spec
), CONSP (tem
))
4927 it
->slice
.x
= XCAR (tem
);
4928 if (tem
= XCDR (tem
), CONSP (tem
))
4930 it
->slice
.y
= XCAR (tem
);
4931 if (tem
= XCDR (tem
), CONSP (tem
))
4933 it
->slice
.width
= XCAR (tem
);
4934 if (tem
= XCDR (tem
), CONSP (tem
))
4935 it
->slice
.height
= XCAR (tem
);
4944 /* Handle `(raise FACTOR)'. */
4946 && EQ (XCAR (spec
), Qraise
)
4947 && CONSP (XCDR (spec
)))
4951 if (!FRAME_WINDOW_P (it
->f
))
4954 #ifdef HAVE_WINDOW_SYSTEM
4955 value
= XCAR (XCDR (spec
));
4956 if (NUMBERP (value
))
4958 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4959 it
->voffset
= - (XFLOATINT (value
)
4960 * (normal_char_height (face
->font
, -1)));
4962 #endif /* HAVE_WINDOW_SYSTEM */
4968 /* Don't handle the other kinds of display specifications
4969 inside a string that we got from a `display' property. */
4970 if (it
&& it
->string_from_display_prop_p
)
4973 /* Characters having this form of property are not displayed, so
4974 we have to find the end of the property. */
4977 start_pos
= *position
;
4978 *position
= display_prop_end (it
, object
, start_pos
);
4979 /* If the display property comes from an overlay, don't consider
4980 any potential stop_charpos values before the end of that
4981 overlay. Since display_prop_end will happily find another
4982 'display' property coming from some other overlay or text
4983 property on buffer positions before this overlay's end, we
4984 need to ignore them, or else we risk displaying this
4985 overlay's display string/image twice. */
4986 if (!NILP (overlay
))
4988 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4990 if (ovendpos
> CHARPOS (*position
))
4991 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4996 /* Stop the scan at that end position--we assume that all
4997 text properties change there. */
4999 it
->stop_charpos
= position
->charpos
;
5001 /* Handle `(left-fringe BITMAP [FACE])'
5002 and `(right-fringe BITMAP [FACE])'. */
5004 && (EQ (XCAR (spec
), Qleft_fringe
)
5005 || EQ (XCAR (spec
), Qright_fringe
))
5006 && CONSP (XCDR (spec
)))
5012 if (!FRAME_WINDOW_P (it
->f
))
5013 /* If we return here, POSITION has been advanced
5014 across the text with this property. */
5016 /* Synchronize the bidi iterator with POSITION. This is
5017 needed because we are not going to push the iterator
5018 on behalf of this display property, so there will be
5019 no pop_it call to do this synchronization for us. */
5022 it
->position
= *position
;
5023 iterate_out_of_display_property (it
);
5024 *position
= it
->position
;
5029 else if (!frame_window_p
)
5032 #ifdef HAVE_WINDOW_SYSTEM
5033 value
= XCAR (XCDR (spec
));
5034 if (!SYMBOLP (value
)
5035 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5036 /* If we return here, POSITION has been advanced
5037 across the text with this property. */
5039 if (it
&& it
->bidi_p
)
5041 it
->position
= *position
;
5042 iterate_out_of_display_property (it
);
5043 *position
= it
->position
;
5050 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5052 if (CONSP (XCDR (XCDR (spec
))))
5054 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5055 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5056 FRINGE_FACE_ID
, false);
5061 /* Save current settings of IT so that we can restore them
5062 when we are finished with the glyph property value. */
5063 push_it (it
, position
);
5065 it
->area
= TEXT_AREA
;
5066 it
->what
= IT_IMAGE
;
5067 it
->image_id
= -1; /* no image */
5068 it
->position
= start_pos
;
5069 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5070 it
->method
= GET_FROM_IMAGE
;
5071 it
->from_overlay
= Qnil
;
5072 it
->face_id
= face_id
;
5073 it
->from_disp_prop_p
= true;
5075 /* Say that we haven't consumed the characters with
5076 `display' property yet. The call to pop_it in
5077 set_iterator_to_next will clean this up. */
5078 *position
= start_pos
;
5080 if (EQ (XCAR (spec
), Qleft_fringe
))
5082 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5083 it
->left_user_fringe_face_id
= face_id
;
5087 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5088 it
->right_user_fringe_face_id
= face_id
;
5091 #endif /* HAVE_WINDOW_SYSTEM */
5095 /* Prepare to handle `((margin left-margin) ...)',
5096 `((margin right-margin) ...)' and `((margin nil) ...)'
5097 prefixes for display specifications. */
5098 location
= Qunbound
;
5099 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5103 value
= XCDR (spec
);
5105 value
= XCAR (value
);
5108 if (EQ (XCAR (tem
), Qmargin
)
5109 && (tem
= XCDR (tem
),
5110 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5112 || EQ (tem
, Qleft_margin
)
5113 || EQ (tem
, Qright_margin
))))
5117 if (EQ (location
, Qunbound
))
5123 /* After this point, VALUE is the property after any
5124 margin prefix has been stripped. It must be a string,
5125 an image specification, or `(space ...)'.
5127 LOCATION specifies where to display: `left-margin',
5128 `right-margin' or nil. */
5130 bool valid_p
= (STRINGP (value
)
5131 #ifdef HAVE_WINDOW_SYSTEM
5132 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5133 && valid_image_p (value
))
5134 #endif /* not HAVE_WINDOW_SYSTEM */
5135 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5137 if (valid_p
&& display_replaced
== 0)
5143 /* Callers need to know whether the display spec is any kind
5144 of `(space ...)' spec that is about to affect text-area
5146 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5151 /* Save current settings of IT so that we can restore them
5152 when we are finished with the glyph property value. */
5153 push_it (it
, position
);
5154 it
->from_overlay
= overlay
;
5155 it
->from_disp_prop_p
= true;
5157 if (NILP (location
))
5158 it
->area
= TEXT_AREA
;
5159 else if (EQ (location
, Qleft_margin
))
5160 it
->area
= LEFT_MARGIN_AREA
;
5162 it
->area
= RIGHT_MARGIN_AREA
;
5164 if (STRINGP (value
))
5167 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5168 it
->current
.overlay_string_index
= -1;
5169 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5170 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5171 it
->method
= GET_FROM_STRING
;
5172 it
->stop_charpos
= 0;
5174 it
->base_level_stop
= 0;
5175 it
->string_from_display_prop_p
= true;
5176 /* Say that we haven't consumed the characters with
5177 `display' property yet. The call to pop_it in
5178 set_iterator_to_next will clean this up. */
5179 if (BUFFERP (object
))
5180 *position
= start_pos
;
5182 /* Force paragraph direction to be that of the parent
5183 object. If the parent object's paragraph direction is
5184 not yet determined, default to L2R. */
5185 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5186 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5188 it
->paragraph_embedding
= L2R
;
5190 /* Set up the bidi iterator for this display string. */
5193 it
->bidi_it
.string
.lstring
= it
->string
;
5194 it
->bidi_it
.string
.s
= NULL
;
5195 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5196 it
->bidi_it
.string
.bufpos
= bufpos
;
5197 it
->bidi_it
.string
.from_disp_str
= true;
5198 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5199 it
->bidi_it
.w
= it
->w
;
5200 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5203 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5205 it
->method
= GET_FROM_STRETCH
;
5207 *position
= it
->position
= start_pos
;
5208 retval
= 1 + (it
->area
== TEXT_AREA
);
5210 #ifdef HAVE_WINDOW_SYSTEM
5213 it
->what
= IT_IMAGE
;
5214 it
->image_id
= lookup_image (it
->f
, value
);
5215 it
->position
= start_pos
;
5216 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5217 it
->method
= GET_FROM_IMAGE
;
5219 /* Say that we haven't consumed the characters with
5220 `display' property yet. The call to pop_it in
5221 set_iterator_to_next will clean this up. */
5222 *position
= start_pos
;
5224 #endif /* HAVE_WINDOW_SYSTEM */
5229 /* Invalid property or property not supported. Restore
5230 POSITION to what it was before. */
5231 *position
= start_pos
;
5235 /* Check if PROP is a display property value whose text should be
5236 treated as intangible. OVERLAY is the overlay from which PROP
5237 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5238 specify the buffer position covered by PROP. */
5241 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5242 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5244 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5245 struct text_pos position
;
5247 SET_TEXT_POS (position
, charpos
, bytepos
);
5248 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5249 &position
, charpos
, frame_window_p
)
5254 /* Return true if PROP is a display sub-property value containing STRING.
5256 Implementation note: this and the following function are really
5257 special cases of handle_display_spec and
5258 handle_single_display_spec, and should ideally use the same code.
5259 Until they do, these two pairs must be consistent and must be
5260 modified in sync. */
5263 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5265 if (EQ (string
, prop
))
5268 /* Skip over `when FORM'. */
5269 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5274 /* Actually, the condition following `when' should be eval'ed,
5275 like handle_single_display_spec does, and we should return
5276 false if it evaluates to nil. However, this function is
5277 called only when the buffer was already displayed and some
5278 glyph in the glyph matrix was found to come from a display
5279 string. Therefore, the condition was already evaluated, and
5280 the result was non-nil, otherwise the display string wouldn't
5281 have been displayed and we would have never been called for
5282 this property. Thus, we can skip the evaluation and assume
5283 its result is non-nil. */
5288 /* Skip over `margin LOCATION'. */
5289 if (EQ (XCAR (prop
), Qmargin
))
5300 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5304 /* Return true if STRING appears in the `display' property PROP. */
5307 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5310 && !EQ (XCAR (prop
), Qwhen
)
5311 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5313 /* A list of sub-properties. */
5314 while (CONSP (prop
))
5316 if (single_display_spec_string_p (XCAR (prop
), string
))
5321 else if (VECTORP (prop
))
5323 /* A vector of sub-properties. */
5325 for (i
= 0; i
< ASIZE (prop
); ++i
)
5326 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5330 return single_display_spec_string_p (prop
, string
);
5335 /* Look for STRING in overlays and text properties in the current
5336 buffer, between character positions FROM and TO (excluding TO).
5337 BACK_P means look back (in this case, TO is supposed to be
5339 Value is the first character position where STRING was found, or
5340 zero if it wasn't found before hitting TO.
5342 This function may only use code that doesn't eval because it is
5343 called asynchronously from note_mouse_highlight. */
5346 string_buffer_position_lim (Lisp_Object string
,
5347 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5349 Lisp_Object limit
, prop
, pos
;
5352 pos
= make_number (max (from
, BEGV
));
5354 if (!back_p
) /* looking forward */
5356 limit
= make_number (min (to
, ZV
));
5357 while (!found
&& !EQ (pos
, limit
))
5359 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5360 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5363 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5367 else /* looking back */
5369 limit
= make_number (max (to
, BEGV
));
5370 while (!found
&& !EQ (pos
, limit
))
5372 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5373 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5376 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5381 return found
? XINT (pos
) : 0;
5384 /* Determine which buffer position in current buffer STRING comes from.
5385 AROUND_CHARPOS is an approximate position where it could come from.
5386 Value is the buffer position or 0 if it couldn't be determined.
5388 This function is necessary because we don't record buffer positions
5389 in glyphs generated from strings (to keep struct glyph small).
5390 This function may only use code that doesn't eval because it is
5391 called asynchronously from note_mouse_highlight. */
5394 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5396 const int MAX_DISTANCE
= 1000;
5397 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5398 around_charpos
+ MAX_DISTANCE
,
5402 found
= string_buffer_position_lim (string
, around_charpos
,
5403 around_charpos
- MAX_DISTANCE
, true);
5409 /***********************************************************************
5410 `composition' property
5411 ***********************************************************************/
5413 /* Set up iterator IT from `composition' property at its current
5414 position. Called from handle_stop. */
5416 static enum prop_handled
5417 handle_composition_prop (struct it
*it
)
5419 Lisp_Object prop
, string
;
5420 ptrdiff_t pos
, pos_byte
, start
, end
;
5422 if (STRINGP (it
->string
))
5426 pos
= IT_STRING_CHARPOS (*it
);
5427 pos_byte
= IT_STRING_BYTEPOS (*it
);
5428 string
= it
->string
;
5429 s
= SDATA (string
) + pos_byte
;
5430 it
->c
= STRING_CHAR (s
);
5434 pos
= IT_CHARPOS (*it
);
5435 pos_byte
= IT_BYTEPOS (*it
);
5437 it
->c
= FETCH_CHAR (pos_byte
);
5440 /* If there's a valid composition and point is not inside of the
5441 composition (in the case that the composition is from the current
5442 buffer), draw a glyph composed from the composition components. */
5443 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5444 && composition_valid_p (start
, end
, prop
)
5445 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5448 /* As we can't handle this situation (perhaps font-lock added
5449 a new composition), we just return here hoping that next
5450 redisplay will detect this composition much earlier. */
5451 return HANDLED_NORMALLY
;
5454 if (STRINGP (it
->string
))
5455 pos_byte
= string_char_to_byte (it
->string
, start
);
5457 pos_byte
= CHAR_TO_BYTE (start
);
5459 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5462 if (it
->cmp_it
.id
>= 0)
5465 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5466 it
->cmp_it
.nglyphs
= -1;
5470 return HANDLED_NORMALLY
;
5475 /***********************************************************************
5477 ***********************************************************************/
5479 /* The following structure is used to record overlay strings for
5480 later sorting in load_overlay_strings. */
5482 struct overlay_entry
5484 Lisp_Object overlay
;
5487 bool after_string_p
;
5491 /* Set up iterator IT from overlay strings at its current position.
5492 Called from handle_stop. */
5494 static enum prop_handled
5495 handle_overlay_change (struct it
*it
)
5497 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5498 return HANDLED_RECOMPUTE_PROPS
;
5500 return HANDLED_NORMALLY
;
5504 /* Set up the next overlay string for delivery by IT, if there is an
5505 overlay string to deliver. Called by set_iterator_to_next when the
5506 end of the current overlay string is reached. If there are more
5507 overlay strings to display, IT->string and
5508 IT->current.overlay_string_index are set appropriately here.
5509 Otherwise IT->string is set to nil. */
5512 next_overlay_string (struct it
*it
)
5514 ++it
->current
.overlay_string_index
;
5515 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5517 /* No more overlay strings. Restore IT's settings to what
5518 they were before overlay strings were processed, and
5519 continue to deliver from current_buffer. */
5521 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5524 || (NILP (it
->string
)
5525 && it
->method
== GET_FROM_BUFFER
5526 && it
->stop_charpos
>= BEGV
5527 && it
->stop_charpos
<= it
->end_charpos
));
5528 it
->current
.overlay_string_index
= -1;
5529 it
->n_overlay_strings
= 0;
5530 /* If there's an empty display string on the stack, pop the
5531 stack, to resync the bidi iterator with IT's position. Such
5532 empty strings are pushed onto the stack in
5533 get_overlay_strings_1. */
5534 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5537 /* Since we've exhausted overlay strings at this buffer
5538 position, set the flag to ignore overlays until we move to
5539 another position. The flag is reset in
5540 next_element_from_buffer. */
5541 it
->ignore_overlay_strings_at_pos_p
= true;
5543 /* If we're at the end of the buffer, record that we have
5544 processed the overlay strings there already, so that
5545 next_element_from_buffer doesn't try it again. */
5546 if (NILP (it
->string
)
5547 && IT_CHARPOS (*it
) >= it
->end_charpos
5548 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5549 it
->overlay_strings_at_end_processed_p
= true;
5550 /* Note: we reset overlay_strings_charpos only here, to make
5551 sure the just-processed overlays were indeed at EOB.
5552 Otherwise, overlays on text with invisible text property,
5553 which are processed with IT's position past the invisible
5554 text, might fool us into thinking the overlays at EOB were
5555 already processed (linum-mode can cause this, for
5557 it
->overlay_strings_charpos
= -1;
5561 /* There are more overlay strings to process. If
5562 IT->current.overlay_string_index has advanced to a position
5563 where we must load IT->overlay_strings with more strings, do
5564 it. We must load at the IT->overlay_strings_charpos where
5565 IT->n_overlay_strings was originally computed; when invisible
5566 text is present, this might not be IT_CHARPOS (Bug#7016). */
5567 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5569 if (it
->current
.overlay_string_index
&& i
== 0)
5570 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5572 /* Initialize IT to deliver display elements from the overlay
5574 it
->string
= it
->overlay_strings
[i
];
5575 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5576 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5577 it
->method
= GET_FROM_STRING
;
5578 it
->stop_charpos
= 0;
5579 it
->end_charpos
= SCHARS (it
->string
);
5580 if (it
->cmp_it
.stop_pos
>= 0)
5581 it
->cmp_it
.stop_pos
= 0;
5583 it
->base_level_stop
= 0;
5585 /* Set up the bidi iterator for this overlay string. */
5588 it
->bidi_it
.string
.lstring
= it
->string
;
5589 it
->bidi_it
.string
.s
= NULL
;
5590 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5591 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5592 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5593 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5594 it
->bidi_it
.w
= it
->w
;
5595 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5603 /* Compare two overlay_entry structures E1 and E2. Used as a
5604 comparison function for qsort in load_overlay_strings. Overlay
5605 strings for the same position are sorted so that
5607 1. All after-strings come in front of before-strings, except
5608 when they come from the same overlay.
5610 2. Within after-strings, strings are sorted so that overlay strings
5611 from overlays with higher priorities come first.
5613 2. Within before-strings, strings are sorted so that overlay
5614 strings from overlays with higher priorities come last.
5616 Value is analogous to strcmp. */
5620 compare_overlay_entries (const void *e1
, const void *e2
)
5622 struct overlay_entry
const *entry1
= e1
;
5623 struct overlay_entry
const *entry2
= e2
;
5626 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5628 /* Let after-strings appear in front of before-strings if
5629 they come from different overlays. */
5630 if (EQ (entry1
->overlay
, entry2
->overlay
))
5631 result
= entry1
->after_string_p
? 1 : -1;
5633 result
= entry1
->after_string_p
? -1 : 1;
5635 else if (entry1
->priority
!= entry2
->priority
)
5637 if (entry1
->after_string_p
)
5638 /* After-strings sorted in order of decreasing priority. */
5639 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5641 /* Before-strings sorted in order of increasing priority. */
5642 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5651 /* Load the vector IT->overlay_strings with overlay strings from IT's
5652 current buffer position, or from CHARPOS if that is > 0. Set
5653 IT->n_overlays to the total number of overlay strings found.
5655 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5656 a time. On entry into load_overlay_strings,
5657 IT->current.overlay_string_index gives the number of overlay
5658 strings that have already been loaded by previous calls to this
5661 IT->add_overlay_start contains an additional overlay start
5662 position to consider for taking overlay strings from, if non-zero.
5663 This position comes into play when the overlay has an `invisible'
5664 property, and both before and after-strings. When we've skipped to
5665 the end of the overlay, because of its `invisible' property, we
5666 nevertheless want its before-string to appear.
5667 IT->add_overlay_start will contain the overlay start position
5670 Overlay strings are sorted so that after-string strings come in
5671 front of before-string strings. Within before and after-strings,
5672 strings are sorted by overlay priority. See also function
5673 compare_overlay_entries. */
5676 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5678 Lisp_Object overlay
, window
, str
, invisible
;
5679 struct Lisp_Overlay
*ov
;
5680 ptrdiff_t start
, end
;
5681 ptrdiff_t n
= 0, i
, j
;
5683 struct overlay_entry entriesbuf
[20];
5684 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5685 struct overlay_entry
*entries
= entriesbuf
;
5689 charpos
= IT_CHARPOS (*it
);
5691 /* Append the overlay string STRING of overlay OVERLAY to vector
5692 `entries' which has size `size' and currently contains `n'
5693 elements. AFTER_P means STRING is an after-string of
5695 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5698 Lisp_Object priority; \
5702 struct overlay_entry *old = entries; \
5703 SAFE_NALLOCA (entries, 2, size); \
5704 memcpy (entries, old, size * sizeof *entries); \
5708 entries[n].string = (STRING); \
5709 entries[n].overlay = (OVERLAY); \
5710 priority = Foverlay_get ((OVERLAY), Qpriority); \
5711 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5712 entries[n].after_string_p = (AFTER_P); \
5717 /* Process overlay before the overlay center. */
5718 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5720 XSETMISC (overlay
, ov
);
5721 eassert (OVERLAYP (overlay
));
5722 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5723 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5728 /* Skip this overlay if it doesn't start or end at IT's current
5730 if (end
!= charpos
&& start
!= charpos
)
5733 /* Skip this overlay if it doesn't apply to IT->w. */
5734 window
= Foverlay_get (overlay
, Qwindow
);
5735 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5738 /* If the text ``under'' the overlay is invisible, both before-
5739 and after-strings from this overlay are visible; start and
5740 end position are indistinguishable. */
5741 invisible
= Foverlay_get (overlay
, Qinvisible
);
5742 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5744 /* If overlay has a non-empty before-string, record it. */
5745 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5746 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5748 RECORD_OVERLAY_STRING (overlay
, str
, false);
5750 /* If overlay has a non-empty after-string, record it. */
5751 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5752 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5754 RECORD_OVERLAY_STRING (overlay
, str
, true);
5757 /* Process overlays after the overlay center. */
5758 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5760 XSETMISC (overlay
, ov
);
5761 eassert (OVERLAYP (overlay
));
5762 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5763 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5765 if (start
> charpos
)
5768 /* Skip this overlay if it doesn't start or end at IT's current
5770 if (end
!= charpos
&& start
!= charpos
)
5773 /* Skip this overlay if it doesn't apply to IT->w. */
5774 window
= Foverlay_get (overlay
, Qwindow
);
5775 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5778 /* If the text ``under'' the overlay is invisible, it has a zero
5779 dimension, and both before- and after-strings apply. */
5780 invisible
= Foverlay_get (overlay
, Qinvisible
);
5781 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5783 /* If overlay has a non-empty before-string, record it. */
5784 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5785 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5787 RECORD_OVERLAY_STRING (overlay
, str
, false);
5789 /* If overlay has a non-empty after-string, record it. */
5790 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5791 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5793 RECORD_OVERLAY_STRING (overlay
, str
, true);
5796 #undef RECORD_OVERLAY_STRING
5800 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5802 /* Record number of overlay strings, and where we computed it. */
5803 it
->n_overlay_strings
= n
;
5804 it
->overlay_strings_charpos
= charpos
;
5806 /* IT->current.overlay_string_index is the number of overlay strings
5807 that have already been consumed by IT. Copy some of the
5808 remaining overlay strings to IT->overlay_strings. */
5810 j
= it
->current
.overlay_string_index
;
5811 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5813 it
->overlay_strings
[i
] = entries
[j
].string
;
5814 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5822 /* Get the first chunk of overlay strings at IT's current buffer
5823 position, or at CHARPOS if that is > 0. Value is true if at
5824 least one overlay string was found. */
5827 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5829 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5830 process. This fills IT->overlay_strings with strings, and sets
5831 IT->n_overlay_strings to the total number of strings to process.
5832 IT->pos.overlay_string_index has to be set temporarily to zero
5833 because load_overlay_strings needs this; it must be set to -1
5834 when no overlay strings are found because a zero value would
5835 indicate a position in the first overlay string. */
5836 it
->current
.overlay_string_index
= 0;
5837 load_overlay_strings (it
, charpos
);
5839 /* If we found overlay strings, set up IT to deliver display
5840 elements from the first one. Otherwise set up IT to deliver
5841 from current_buffer. */
5842 if (it
->n_overlay_strings
)
5844 /* Make sure we know settings in current_buffer, so that we can
5845 restore meaningful values when we're done with the overlay
5848 compute_stop_pos (it
);
5849 eassert (it
->face_id
>= 0);
5851 /* Save IT's settings. They are restored after all overlay
5852 strings have been processed. */
5853 eassert (!compute_stop_p
|| it
->sp
== 0);
5855 /* When called from handle_stop, there might be an empty display
5856 string loaded. In that case, don't bother saving it. But
5857 don't use this optimization with the bidi iterator, since we
5858 need the corresponding pop_it call to resync the bidi
5859 iterator's position with IT's position, after we are done
5860 with the overlay strings. (The corresponding call to pop_it
5861 in case of an empty display string is in
5862 next_overlay_string.) */
5864 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5867 /* Set up IT to deliver display elements from the first overlay
5869 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5870 it
->string
= it
->overlay_strings
[0];
5871 it
->from_overlay
= Qnil
;
5872 it
->stop_charpos
= 0;
5873 eassert (STRINGP (it
->string
));
5874 it
->end_charpos
= SCHARS (it
->string
);
5876 it
->base_level_stop
= 0;
5877 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5878 it
->method
= GET_FROM_STRING
;
5879 it
->from_disp_prop_p
= 0;
5881 /* Force paragraph direction to be that of the parent
5883 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5884 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5886 it
->paragraph_embedding
= L2R
;
5888 /* Set up the bidi iterator for this overlay string. */
5891 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5893 it
->bidi_it
.string
.lstring
= it
->string
;
5894 it
->bidi_it
.string
.s
= NULL
;
5895 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5896 it
->bidi_it
.string
.bufpos
= pos
;
5897 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5898 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5899 it
->bidi_it
.w
= it
->w
;
5900 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5905 it
->current
.overlay_string_index
= -1;
5910 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5913 it
->method
= GET_FROM_BUFFER
;
5915 get_overlay_strings_1 (it
, charpos
, true);
5919 /* Value is true if we found at least one overlay string. */
5920 return STRINGP (it
->string
);
5925 /***********************************************************************
5926 Saving and restoring state
5927 ***********************************************************************/
5929 /* Save current settings of IT on IT->stack. Called, for example,
5930 before setting up IT for an overlay string, to be able to restore
5931 IT's settings to what they were after the overlay string has been
5932 processed. If POSITION is non-NULL, it is the position to save on
5933 the stack instead of IT->position. */
5936 push_it (struct it
*it
, struct text_pos
*position
)
5938 struct iterator_stack_entry
*p
;
5940 eassert (it
->sp
< IT_STACK_SIZE
);
5941 p
= it
->stack
+ it
->sp
;
5943 p
->stop_charpos
= it
->stop_charpos
;
5944 p
->prev_stop
= it
->prev_stop
;
5945 p
->base_level_stop
= it
->base_level_stop
;
5946 p
->cmp_it
= it
->cmp_it
;
5947 eassert (it
->face_id
>= 0);
5948 p
->face_id
= it
->face_id
;
5949 p
->string
= it
->string
;
5950 p
->method
= it
->method
;
5951 p
->from_overlay
= it
->from_overlay
;
5954 case GET_FROM_IMAGE
:
5955 p
->u
.image
.object
= it
->object
;
5956 p
->u
.image
.image_id
= it
->image_id
;
5957 p
->u
.image
.slice
= it
->slice
;
5959 case GET_FROM_STRETCH
:
5960 p
->u
.stretch
.object
= it
->object
;
5962 case GET_FROM_BUFFER
:
5963 case GET_FROM_DISPLAY_VECTOR
:
5964 case GET_FROM_STRING
:
5965 case GET_FROM_C_STRING
:
5970 p
->position
= position
? *position
: it
->position
;
5971 p
->current
= it
->current
;
5972 p
->end_charpos
= it
->end_charpos
;
5973 p
->string_nchars
= it
->string_nchars
;
5975 p
->multibyte_p
= it
->multibyte_p
;
5976 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5977 p
->space_width
= it
->space_width
;
5978 p
->font_height
= it
->font_height
;
5979 p
->voffset
= it
->voffset
;
5980 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5981 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5982 p
->display_ellipsis_p
= false;
5983 p
->line_wrap
= it
->line_wrap
;
5984 p
->bidi_p
= it
->bidi_p
;
5985 p
->paragraph_embedding
= it
->paragraph_embedding
;
5986 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5989 /* Save the state of the bidi iterator as well. */
5991 bidi_push_it (&it
->bidi_it
);
5995 iterate_out_of_display_property (struct it
*it
)
5997 bool buffer_p
= !STRINGP (it
->string
);
5998 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5999 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6001 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6003 /* Maybe initialize paragraph direction. If we are at the beginning
6004 of a new paragraph, next_element_from_buffer may not have a
6005 chance to do that. */
6006 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6007 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6008 /* prev_stop can be zero, so check against BEGV as well. */
6009 while (it
->bidi_it
.charpos
>= bob
6010 && it
->prev_stop
<= it
->bidi_it
.charpos
6011 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6012 && it
->bidi_it
.charpos
< eob
)
6013 bidi_move_to_visually_next (&it
->bidi_it
);
6014 /* Record the stop_pos we just crossed, for when we cross it
6016 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6017 it
->prev_stop
= CHARPOS (it
->position
);
6018 /* If we ended up not where pop_it put us, resync IT's
6019 positional members with the bidi iterator. */
6020 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6021 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6023 it
->current
.pos
= it
->position
;
6025 it
->current
.string_pos
= it
->position
;
6028 /* Restore IT's settings from IT->stack. Called, for example, when no
6029 more overlay strings must be processed, and we return to delivering
6030 display elements from a buffer, or when the end of a string from a
6031 `display' property is reached and we return to delivering display
6032 elements from an overlay string, or from a buffer. */
6035 pop_it (struct it
*it
)
6037 struct iterator_stack_entry
*p
;
6038 bool from_display_prop
= it
->from_disp_prop_p
;
6039 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6041 eassert (it
->sp
> 0);
6043 p
= it
->stack
+ it
->sp
;
6044 it
->stop_charpos
= p
->stop_charpos
;
6045 it
->prev_stop
= p
->prev_stop
;
6046 it
->base_level_stop
= p
->base_level_stop
;
6047 it
->cmp_it
= p
->cmp_it
;
6048 it
->face_id
= p
->face_id
;
6049 it
->current
= p
->current
;
6050 it
->position
= p
->position
;
6051 it
->string
= p
->string
;
6052 it
->from_overlay
= p
->from_overlay
;
6053 if (NILP (it
->string
))
6054 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6055 it
->method
= p
->method
;
6058 case GET_FROM_IMAGE
:
6059 it
->image_id
= p
->u
.image
.image_id
;
6060 it
->object
= p
->u
.image
.object
;
6061 it
->slice
= p
->u
.image
.slice
;
6063 case GET_FROM_STRETCH
:
6064 it
->object
= p
->u
.stretch
.object
;
6066 case GET_FROM_BUFFER
:
6067 it
->object
= it
->w
->contents
;
6069 case GET_FROM_STRING
:
6071 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6073 /* Restore the face_box_p flag, since it could have been
6074 overwritten by the face of the object that we just finished
6077 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6078 it
->object
= it
->string
;
6081 case GET_FROM_DISPLAY_VECTOR
:
6083 it
->method
= GET_FROM_C_STRING
;
6084 else if (STRINGP (it
->string
))
6085 it
->method
= GET_FROM_STRING
;
6088 it
->method
= GET_FROM_BUFFER
;
6089 it
->object
= it
->w
->contents
;
6092 case GET_FROM_C_STRING
:
6097 it
->end_charpos
= p
->end_charpos
;
6098 it
->string_nchars
= p
->string_nchars
;
6100 it
->multibyte_p
= p
->multibyte_p
;
6101 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6102 it
->space_width
= p
->space_width
;
6103 it
->font_height
= p
->font_height
;
6104 it
->voffset
= p
->voffset
;
6105 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6106 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6107 it
->line_wrap
= p
->line_wrap
;
6108 it
->bidi_p
= p
->bidi_p
;
6109 it
->paragraph_embedding
= p
->paragraph_embedding
;
6110 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6113 bidi_pop_it (&it
->bidi_it
);
6114 /* Bidi-iterate until we get out of the portion of text, if any,
6115 covered by a `display' text property or by an overlay with
6116 `display' property. (We cannot just jump there, because the
6117 internal coherency of the bidi iterator state can not be
6118 preserved across such jumps.) We also must determine the
6119 paragraph base direction if the overlay we just processed is
6120 at the beginning of a new paragraph. */
6121 if (from_display_prop
6122 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6123 iterate_out_of_display_property (it
);
6125 eassert ((BUFFERP (it
->object
)
6126 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6127 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6128 || (STRINGP (it
->object
)
6129 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6130 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6131 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6133 /* If we move the iterator over text covered by a display property
6134 to a new buffer position, any info about previously seen overlays
6135 is no longer valid. */
6136 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6137 it
->ignore_overlay_strings_at_pos_p
= false;
6142 /***********************************************************************
6144 ***********************************************************************/
6146 /* Set IT's current position to the previous line start. */
6149 back_to_previous_line_start (struct it
*it
)
6151 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6154 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6158 /* Move IT to the next line start.
6160 Value is true if a newline was found. Set *SKIPPED_P to true if
6161 we skipped over part of the text (as opposed to moving the iterator
6162 continuously over the text). Otherwise, don't change the value
6165 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6166 iterator on the newline, if it was found.
6168 Newlines may come from buffer text, overlay strings, or strings
6169 displayed via the `display' property. That's the reason we can't
6170 simply use find_newline_no_quit.
6172 Note that this function may not skip over invisible text that is so
6173 because of text properties and immediately follows a newline. If
6174 it would, function reseat_at_next_visible_line_start, when called
6175 from set_iterator_to_next, would effectively make invisible
6176 characters following a newline part of the wrong glyph row, which
6177 leads to wrong cursor motion. */
6180 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6181 struct bidi_it
*bidi_it_prev
)
6183 ptrdiff_t old_selective
;
6184 bool newline_found_p
= false;
6186 const int MAX_NEWLINE_DISTANCE
= 500;
6188 /* If already on a newline, just consume it to avoid unintended
6189 skipping over invisible text below. */
6190 if (it
->what
== IT_CHARACTER
6192 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6194 if (it
->bidi_p
&& bidi_it_prev
)
6195 *bidi_it_prev
= it
->bidi_it
;
6196 set_iterator_to_next (it
, false);
6201 /* Don't handle selective display in the following. It's (a)
6202 unnecessary because it's done by the caller, and (b) leads to an
6203 infinite recursion because next_element_from_ellipsis indirectly
6204 calls this function. */
6205 old_selective
= it
->selective
;
6208 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6209 from buffer text. */
6211 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6212 n
+= !STRINGP (it
->string
))
6214 if (!get_next_display_element (it
))
6216 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6217 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6218 *bidi_it_prev
= it
->bidi_it
;
6219 set_iterator_to_next (it
, false);
6222 /* If we didn't find a newline near enough, see if we can use a
6224 if (!newline_found_p
)
6226 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6227 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6231 eassert (!STRINGP (it
->string
));
6233 /* If there isn't any `display' property in sight, and no
6234 overlays, we can just use the position of the newline in
6236 if (it
->stop_charpos
>= limit
6237 || ((pos
= Fnext_single_property_change (make_number (start
),
6239 make_number (limit
)),
6241 && next_overlay_change (start
) == ZV
))
6245 IT_CHARPOS (*it
) = limit
;
6246 IT_BYTEPOS (*it
) = bytepos
;
6250 struct bidi_it bprev
;
6252 /* Help bidi.c avoid expensive searches for display
6253 properties and overlays, by telling it that there are
6254 none up to `limit'. */
6255 if (it
->bidi_it
.disp_pos
< limit
)
6257 it
->bidi_it
.disp_pos
= limit
;
6258 it
->bidi_it
.disp_prop
= 0;
6261 bprev
= it
->bidi_it
;
6262 bidi_move_to_visually_next (&it
->bidi_it
);
6263 } while (it
->bidi_it
.charpos
!= limit
);
6264 IT_CHARPOS (*it
) = limit
;
6265 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6267 *bidi_it_prev
= bprev
;
6269 *skipped_p
= newline_found_p
= true;
6273 while (get_next_display_element (it
)
6274 && !newline_found_p
)
6276 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6277 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6278 *bidi_it_prev
= it
->bidi_it
;
6279 set_iterator_to_next (it
, false);
6284 it
->selective
= old_selective
;
6285 return newline_found_p
;
6289 /* Set IT's current position to the previous visible line start. Skip
6290 invisible text that is so either due to text properties or due to
6291 selective display. Caution: this does not change IT->current_x and
6295 back_to_previous_visible_line_start (struct it
*it
)
6297 while (IT_CHARPOS (*it
) > BEGV
)
6299 back_to_previous_line_start (it
);
6301 if (IT_CHARPOS (*it
) <= BEGV
)
6304 /* If selective > 0, then lines indented more than its value are
6306 if (it
->selective
> 0
6307 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6311 /* Check the newline before point for invisibility. */
6314 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6315 Qinvisible
, it
->window
);
6316 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6320 if (IT_CHARPOS (*it
) <= BEGV
)
6325 void *it2data
= NULL
;
6328 Lisp_Object val
, overlay
;
6330 SAVE_IT (it2
, *it
, it2data
);
6332 /* If newline is part of a composition, continue from start of composition */
6333 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6334 && beg
< IT_CHARPOS (*it
))
6337 /* If newline is replaced by a display property, find start of overlay
6338 or interval and continue search from that point. */
6339 pos
= --IT_CHARPOS (it2
);
6342 bidi_unshelve_cache (NULL
, false);
6343 it2
.string_from_display_prop_p
= false;
6344 it2
.from_disp_prop_p
= false;
6345 if (handle_display_prop (&it2
) == HANDLED_RETURN
6346 && !NILP (val
= get_char_property_and_overlay
6347 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6348 && (OVERLAYP (overlay
)
6349 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6350 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6352 RESTORE_IT (it
, it
, it2data
);
6356 /* Newline is not replaced by anything -- so we are done. */
6357 RESTORE_IT (it
, it
, it2data
);
6363 IT_CHARPOS (*it
) = beg
;
6364 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6368 it
->continuation_lines_width
= 0;
6370 eassert (IT_CHARPOS (*it
) >= BEGV
);
6371 eassert (IT_CHARPOS (*it
) == BEGV
6372 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6377 /* Reseat iterator IT at the previous visible line start. Skip
6378 invisible text that is so either due to text properties or due to
6379 selective display. At the end, update IT's overlay information,
6380 face information etc. */
6383 reseat_at_previous_visible_line_start (struct it
*it
)
6385 back_to_previous_visible_line_start (it
);
6386 reseat (it
, it
->current
.pos
, true);
6391 /* Reseat iterator IT on the next visible line start in the current
6392 buffer. ON_NEWLINE_P means position IT on the newline
6393 preceding the line start. Skip over invisible text that is so
6394 because of selective display. Compute faces, overlays etc at the
6395 new position. Note that this function does not skip over text that
6396 is invisible because of text properties. */
6399 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6401 bool skipped_p
= false;
6402 struct bidi_it bidi_it_prev
;
6403 bool newline_found_p
6404 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6406 /* Skip over lines that are invisible because they are indented
6407 more than the value of IT->selective. */
6408 if (it
->selective
> 0)
6409 while (IT_CHARPOS (*it
) < ZV
6410 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6413 eassert (IT_BYTEPOS (*it
) == BEGV
6414 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6416 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6419 /* Position on the newline if that's what's requested. */
6420 if (on_newline_p
&& newline_found_p
)
6422 if (STRINGP (it
->string
))
6424 if (IT_STRING_CHARPOS (*it
) > 0)
6428 --IT_STRING_CHARPOS (*it
);
6429 --IT_STRING_BYTEPOS (*it
);
6433 /* We need to restore the bidi iterator to the state
6434 it had on the newline, and resync the IT's
6435 position with that. */
6436 it
->bidi_it
= bidi_it_prev
;
6437 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6438 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6442 else if (IT_CHARPOS (*it
) > BEGV
)
6451 /* We need to restore the bidi iterator to the state it
6452 had on the newline and resync IT with that. */
6453 it
->bidi_it
= bidi_it_prev
;
6454 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6455 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6457 reseat (it
, it
->current
.pos
, false);
6461 reseat (it
, it
->current
.pos
, false);
6468 /***********************************************************************
6469 Changing an iterator's position
6470 ***********************************************************************/
6472 /* Change IT's current position to POS in current_buffer.
6473 If FORCE_P, always check for text properties at the new position.
6474 Otherwise, text properties are only looked up if POS >=
6475 IT->check_charpos of a property. */
6478 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6480 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6482 reseat_1 (it
, pos
, false);
6484 /* Determine where to check text properties. Avoid doing it
6485 where possible because text property lookup is very expensive. */
6487 || CHARPOS (pos
) > it
->stop_charpos
6488 || CHARPOS (pos
) < original_pos
)
6492 /* For bidi iteration, we need to prime prev_stop and
6493 base_level_stop with our best estimations. */
6494 /* Implementation note: Of course, POS is not necessarily a
6495 stop position, so assigning prev_pos to it is a lie; we
6496 should have called compute_stop_backwards. However, if
6497 the current buffer does not include any R2L characters,
6498 that call would be a waste of cycles, because the
6499 iterator will never move back, and thus never cross this
6500 "fake" stop position. So we delay that backward search
6501 until the time we really need it, in next_element_from_buffer. */
6502 if (CHARPOS (pos
) != it
->prev_stop
)
6503 it
->prev_stop
= CHARPOS (pos
);
6504 if (CHARPOS (pos
) < it
->base_level_stop
)
6505 it
->base_level_stop
= 0; /* meaning it's unknown */
6511 it
->prev_stop
= it
->base_level_stop
= 0;
6520 /* Change IT's buffer position to POS. SET_STOP_P means set
6521 IT->stop_pos to POS, also. */
6524 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6526 /* Don't call this function when scanning a C string. */
6527 eassert (it
->s
== NULL
);
6529 /* POS must be a reasonable value. */
6530 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6532 it
->current
.pos
= it
->position
= pos
;
6533 it
->end_charpos
= ZV
;
6535 it
->current
.dpvec_index
= -1;
6536 it
->current
.overlay_string_index
= -1;
6537 IT_STRING_CHARPOS (*it
) = -1;
6538 IT_STRING_BYTEPOS (*it
) = -1;
6540 it
->method
= GET_FROM_BUFFER
;
6541 it
->object
= it
->w
->contents
;
6542 it
->area
= TEXT_AREA
;
6543 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6545 it
->string_from_display_prop_p
= false;
6546 it
->string_from_prefix_prop_p
= false;
6548 it
->from_disp_prop_p
= false;
6549 it
->face_before_selective_p
= false;
6552 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6554 bidi_unshelve_cache (NULL
, false);
6555 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6556 it
->bidi_it
.string
.s
= NULL
;
6557 it
->bidi_it
.string
.lstring
= Qnil
;
6558 it
->bidi_it
.string
.bufpos
= 0;
6559 it
->bidi_it
.string
.from_disp_str
= false;
6560 it
->bidi_it
.string
.unibyte
= false;
6561 it
->bidi_it
.w
= it
->w
;
6566 it
->stop_charpos
= CHARPOS (pos
);
6567 it
->base_level_stop
= CHARPOS (pos
);
6569 /* This make the information stored in it->cmp_it invalidate. */
6574 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6575 If S is non-null, it is a C string to iterate over. Otherwise,
6576 STRING gives a Lisp string to iterate over.
6578 If PRECISION > 0, don't return more then PRECISION number of
6579 characters from the string.
6581 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6582 characters have been returned. FIELD_WIDTH < 0 means an infinite
6585 MULTIBYTE = 0 means disable processing of multibyte characters,
6586 MULTIBYTE > 0 means enable it,
6587 MULTIBYTE < 0 means use IT->multibyte_p.
6589 IT must be initialized via a prior call to init_iterator before
6590 calling this function. */
6593 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6594 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6597 /* No text property checks performed by default, but see below. */
6598 it
->stop_charpos
= -1;
6600 /* Set iterator position and end position. */
6601 memset (&it
->current
, 0, sizeof it
->current
);
6602 it
->current
.overlay_string_index
= -1;
6603 it
->current
.dpvec_index
= -1;
6604 eassert (charpos
>= 0);
6606 /* If STRING is specified, use its multibyteness, otherwise use the
6607 setting of MULTIBYTE, if specified. */
6609 it
->multibyte_p
= multibyte
> 0;
6611 /* Bidirectional reordering of strings is controlled by the default
6612 value of bidi-display-reordering. Don't try to reorder while
6613 loading loadup.el, as the necessary character property tables are
6614 not yet available. */
6617 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6621 eassert (STRINGP (string
));
6622 it
->string
= string
;
6624 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6625 it
->method
= GET_FROM_STRING
;
6626 it
->current
.string_pos
= string_pos (charpos
, string
);
6630 it
->bidi_it
.string
.lstring
= string
;
6631 it
->bidi_it
.string
.s
= NULL
;
6632 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6633 it
->bidi_it
.string
.bufpos
= 0;
6634 it
->bidi_it
.string
.from_disp_str
= false;
6635 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6636 it
->bidi_it
.w
= it
->w
;
6637 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6638 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6643 it
->s
= (const unsigned char *) s
;
6646 /* Note that we use IT->current.pos, not it->current.string_pos,
6647 for displaying C strings. */
6648 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6649 if (it
->multibyte_p
)
6651 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6652 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6656 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6657 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6662 it
->bidi_it
.string
.lstring
= Qnil
;
6663 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6664 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6665 it
->bidi_it
.string
.bufpos
= 0;
6666 it
->bidi_it
.string
.from_disp_str
= false;
6667 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6668 it
->bidi_it
.w
= it
->w
;
6669 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6672 it
->method
= GET_FROM_C_STRING
;
6675 /* PRECISION > 0 means don't return more than PRECISION characters
6677 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6679 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6681 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6684 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6685 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6686 FIELD_WIDTH < 0 means infinite field width. This is useful for
6687 padding with `-' at the end of a mode line. */
6688 if (field_width
< 0)
6689 field_width
= INFINITY
;
6690 /* Implementation note: We deliberately don't enlarge
6691 it->bidi_it.string.schars here to fit it->end_charpos, because
6692 the bidi iterator cannot produce characters out of thin air. */
6693 if (field_width
> it
->end_charpos
- charpos
)
6694 it
->end_charpos
= charpos
+ field_width
;
6696 /* Use the standard display table for displaying strings. */
6697 if (DISP_TABLE_P (Vstandard_display_table
))
6698 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6700 it
->stop_charpos
= charpos
;
6701 it
->prev_stop
= charpos
;
6702 it
->base_level_stop
= 0;
6705 it
->bidi_it
.first_elt
= true;
6706 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6707 it
->bidi_it
.disp_pos
= -1;
6709 if (s
== NULL
&& it
->multibyte_p
)
6711 ptrdiff_t endpos
= SCHARS (it
->string
);
6712 if (endpos
> it
->end_charpos
)
6713 endpos
= it
->end_charpos
;
6714 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6722 /***********************************************************************
6724 ***********************************************************************/
6726 /* Map enum it_method value to corresponding next_element_from_* function. */
6728 typedef bool (*next_element_function
) (struct it
*);
6730 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6732 next_element_from_buffer
,
6733 next_element_from_display_vector
,
6734 next_element_from_string
,
6735 next_element_from_c_string
,
6736 next_element_from_image
,
6737 next_element_from_stretch
6740 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6743 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6744 (possibly with the following characters). */
6746 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6747 ((IT)->cmp_it.id >= 0 \
6748 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6749 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6750 END_CHARPOS, (IT)->w, \
6751 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6755 /* Lookup the char-table Vglyphless_char_display for character C (-1
6756 if we want information for no-font case), and return the display
6757 method symbol. By side-effect, update it->what and
6758 it->glyphless_method. This function is called from
6759 get_next_display_element for each character element, and from
6760 x_produce_glyphs when no suitable font was found. */
6763 lookup_glyphless_char_display (int c
, struct it
*it
)
6765 Lisp_Object glyphless_method
= Qnil
;
6767 if (CHAR_TABLE_P (Vglyphless_char_display
)
6768 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6772 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6773 if (CONSP (glyphless_method
))
6774 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6775 ? XCAR (glyphless_method
)
6776 : XCDR (glyphless_method
);
6779 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6783 if (NILP (glyphless_method
))
6786 /* The default is to display the character by a proper font. */
6788 /* The default for the no-font case is to display an empty box. */
6789 glyphless_method
= Qempty_box
;
6791 if (EQ (glyphless_method
, Qzero_width
))
6794 return glyphless_method
;
6795 /* This method can't be used for the no-font case. */
6796 glyphless_method
= Qempty_box
;
6798 if (EQ (glyphless_method
, Qthin_space
))
6799 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6800 else if (EQ (glyphless_method
, Qempty_box
))
6801 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6802 else if (EQ (glyphless_method
, Qhex_code
))
6803 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6804 else if (STRINGP (glyphless_method
))
6805 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6808 /* Invalid value. We use the default method. */
6809 glyphless_method
= Qnil
;
6812 it
->what
= IT_GLYPHLESS
;
6813 return glyphless_method
;
6816 /* Merge escape glyph face and cache the result. */
6818 static struct frame
*last_escape_glyph_frame
= NULL
;
6819 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6820 static int last_escape_glyph_merged_face_id
= 0;
6823 merge_escape_glyph_face (struct it
*it
)
6827 if (it
->f
== last_escape_glyph_frame
6828 && it
->face_id
== last_escape_glyph_face_id
)
6829 face_id
= last_escape_glyph_merged_face_id
;
6832 /* Merge the `escape-glyph' face into the current face. */
6833 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6834 last_escape_glyph_frame
= it
->f
;
6835 last_escape_glyph_face_id
= it
->face_id
;
6836 last_escape_glyph_merged_face_id
= face_id
;
6841 /* Likewise for glyphless glyph face. */
6843 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6844 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6845 static int last_glyphless_glyph_merged_face_id
= 0;
6848 merge_glyphless_glyph_face (struct it
*it
)
6852 if (it
->f
== last_glyphless_glyph_frame
6853 && it
->face_id
== last_glyphless_glyph_face_id
)
6854 face_id
= last_glyphless_glyph_merged_face_id
;
6857 /* Merge the `glyphless-char' face into the current face. */
6858 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6859 last_glyphless_glyph_frame
= it
->f
;
6860 last_glyphless_glyph_face_id
= it
->face_id
;
6861 last_glyphless_glyph_merged_face_id
= face_id
;
6866 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6867 be called before redisplaying windows, and when the frame's face
6870 forget_escape_and_glyphless_faces (void)
6872 last_escape_glyph_frame
= NULL
;
6873 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6874 last_glyphless_glyph_frame
= NULL
;
6875 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6878 /* Load IT's display element fields with information about the next
6879 display element from the current position of IT. Value is false if
6880 end of buffer (or C string) is reached. */
6883 get_next_display_element (struct it
*it
)
6885 /* True means that we found a display element. False means that
6886 we hit the end of what we iterate over. Performance note: the
6887 function pointer `method' used here turns out to be faster than
6888 using a sequence of if-statements. */
6892 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6894 if (it
->what
== IT_CHARACTER
)
6896 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6897 and only if (a) the resolved directionality of that character
6899 /* FIXME: Do we need an exception for characters from display
6901 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6902 && !inhibit_bidi_mirroring
)
6903 it
->c
= bidi_mirror_char (it
->c
);
6904 /* Map via display table or translate control characters.
6905 IT->c, IT->len etc. have been set to the next character by
6906 the function call above. If we have a display table, and it
6907 contains an entry for IT->c, translate it. Don't do this if
6908 IT->c itself comes from a display table, otherwise we could
6909 end up in an infinite recursion. (An alternative could be to
6910 count the recursion depth of this function and signal an
6911 error when a certain maximum depth is reached.) Is it worth
6913 if (success_p
&& it
->dpvec
== NULL
)
6916 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6917 bool nonascii_space_p
= false;
6918 bool nonascii_hyphen_p
= false;
6919 int c
= it
->c
; /* This is the character to display. */
6921 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6923 eassert (SINGLE_BYTE_CHAR_P (c
));
6924 if (unibyte_display_via_language_environment
)
6926 c
= DECODE_CHAR (unibyte
, c
);
6928 c
= BYTE8_TO_CHAR (it
->c
);
6931 c
= BYTE8_TO_CHAR (it
->c
);
6935 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6938 struct Lisp_Vector
*v
= XVECTOR (dv
);
6940 /* Return the first character from the display table
6941 entry, if not empty. If empty, don't display the
6942 current character. */
6945 it
->dpvec_char_len
= it
->len
;
6946 it
->dpvec
= v
->contents
;
6947 it
->dpend
= v
->contents
+ v
->header
.size
;
6948 it
->current
.dpvec_index
= 0;
6949 it
->dpvec_face_id
= -1;
6950 it
->saved_face_id
= it
->face_id
;
6951 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6952 it
->ellipsis_p
= false;
6956 set_iterator_to_next (it
, false);
6961 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6963 if (it
->what
== IT_GLYPHLESS
)
6965 /* Don't display this character. */
6966 set_iterator_to_next (it
, false);
6970 /* If `nobreak-char-display' is non-nil, we display
6971 non-ASCII spaces and hyphens specially. */
6972 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6974 if (c
== NO_BREAK_SPACE
)
6975 nonascii_space_p
= true;
6976 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6977 || c
== NON_BREAKING_HYPHEN
)
6978 nonascii_hyphen_p
= true;
6981 /* Translate control characters into `\003' or `^C' form.
6982 Control characters coming from a display table entry are
6983 currently not translated because we use IT->dpvec to hold
6984 the translation. This could easily be changed but I
6985 don't believe that it is worth doing.
6987 The characters handled by `nobreak-char-display' must be
6990 Non-printable characters and raw-byte characters are also
6991 translated to octal form. */
6992 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6993 ? (it
->area
!= TEXT_AREA
6994 /* In mode line, treat \n, \t like other crl chars. */
6997 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6998 || (c
!= '\n' && c
!= '\t'))
7000 || nonascii_hyphen_p
7002 || ! CHAR_PRINTABLE_P (c
))))
7004 /* C is a control character, non-ASCII space/hyphen,
7005 raw-byte, or a non-printable character which must be
7006 displayed either as '\003' or as `^C' where the '\\'
7007 and '^' can be defined in the display table. Fill
7008 IT->ctl_chars with glyphs for what we have to
7009 display. Then, set IT->dpvec to these glyphs. */
7016 /* Handle control characters with ^. */
7018 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7022 g
= '^'; /* default glyph for Control */
7023 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7025 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7027 g
= GLYPH_CODE_CHAR (gc
);
7028 lface_id
= GLYPH_CODE_FACE (gc
);
7032 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7033 : merge_escape_glyph_face (it
));
7035 XSETINT (it
->ctl_chars
[0], g
);
7036 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7038 goto display_control
;
7041 /* Handle non-ascii space in the mode where it only gets
7044 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7046 /* Merge `nobreak-space' into the current face. */
7047 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7049 XSETINT (it
->ctl_chars
[0], ' ');
7051 goto display_control
;
7054 /* Handle sequences that start with the "escape glyph". */
7056 /* the default escape glyph is \. */
7057 escape_glyph
= '\\';
7060 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7062 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7063 lface_id
= GLYPH_CODE_FACE (gc
);
7067 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7068 : merge_escape_glyph_face (it
));
7070 /* Draw non-ASCII hyphen with just highlighting: */
7072 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7074 XSETINT (it
->ctl_chars
[0], '-');
7076 goto display_control
;
7079 /* Draw non-ASCII space/hyphen with escape glyph: */
7081 if (nonascii_space_p
|| nonascii_hyphen_p
)
7083 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7084 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7086 goto display_control
;
7093 if (CHAR_BYTE8_P (c
))
7094 /* Display \200 instead of \17777600. */
7095 c
= CHAR_TO_BYTE8 (c
);
7096 len
= sprintf (str
, "%03o", c
+ 0u);
7098 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7099 for (i
= 0; i
< len
; i
++)
7100 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7105 /* Set up IT->dpvec and return first character from it. */
7106 it
->dpvec_char_len
= it
->len
;
7107 it
->dpvec
= it
->ctl_chars
;
7108 it
->dpend
= it
->dpvec
+ ctl_len
;
7109 it
->current
.dpvec_index
= 0;
7110 it
->dpvec_face_id
= face_id
;
7111 it
->saved_face_id
= it
->face_id
;
7112 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7113 it
->ellipsis_p
= false;
7116 it
->char_to_display
= c
;
7120 it
->char_to_display
= it
->c
;
7124 #ifdef HAVE_WINDOW_SYSTEM
7125 /* Adjust face id for a multibyte character. There are no multibyte
7126 character in unibyte text. */
7127 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7130 && FRAME_WINDOW_P (it
->f
))
7132 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7134 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7136 /* Automatic composition with glyph-string. */
7137 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7139 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7143 ptrdiff_t pos
= (it
->s
? -1
7144 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7145 : IT_CHARPOS (*it
));
7148 if (it
->what
== IT_CHARACTER
)
7149 c
= it
->char_to_display
;
7152 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7156 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7157 /* TAB in a composition means display glyphs with
7158 padding space on the left or right. */
7159 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7162 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7165 #endif /* HAVE_WINDOW_SYSTEM */
7168 /* Is this character the last one of a run of characters with
7169 box? If yes, set IT->end_of_box_run_p to true. */
7173 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7175 int face_id
= underlying_face_id (it
);
7176 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7180 if (face
->box
== FACE_NO_BOX
)
7182 /* If the box comes from face properties in a
7183 display string, check faces in that string. */
7184 int string_face_id
= face_after_it_pos (it
);
7185 it
->end_of_box_run_p
7186 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7189 /* Otherwise, the box comes from the underlying face.
7190 If this is the last string character displayed, check
7191 the next buffer location. */
7192 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7193 /* n_overlay_strings is unreliable unless
7194 overlay_string_index is non-negative. */
7195 && ((it
->current
.overlay_string_index
>= 0
7196 && (it
->current
.overlay_string_index
7197 == it
->n_overlay_strings
- 1))
7198 /* A string from display property. */
7199 || it
->from_disp_prop_p
))
7203 struct text_pos pos
= it
->current
.pos
;
7205 /* For a string from a display property, the next
7206 buffer position is stored in the 'position'
7207 member of the iteration stack slot below the
7208 current one, see handle_single_display_spec. By
7209 contrast, it->current.pos was is not yet updated
7210 to point to that buffer position; that will
7211 happen in pop_it, after we finish displaying the
7212 current string. Note that we already checked
7213 above that it->sp is positive, so subtracting one
7215 if (it
->from_disp_prop_p
)
7216 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7218 INC_TEXT_POS (pos
, it
->multibyte_p
);
7220 if (CHARPOS (pos
) >= ZV
)
7221 it
->end_of_box_run_p
= true;
7224 next_face_id
= face_at_buffer_position
7225 (it
->w
, CHARPOS (pos
), &ignore
,
7226 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7227 it
->end_of_box_run_p
7228 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7234 /* next_element_from_display_vector sets this flag according to
7235 faces of the display vector glyphs, see there. */
7236 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7238 int face_id
= face_after_it_pos (it
);
7239 it
->end_of_box_run_p
7240 = (face_id
!= it
->face_id
7241 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7244 /* If we reached the end of the object we've been iterating (e.g., a
7245 display string or an overlay string), and there's something on
7246 IT->stack, proceed with what's on the stack. It doesn't make
7247 sense to return false if there's unprocessed stuff on the stack,
7248 because otherwise that stuff will never be displayed. */
7249 if (!success_p
&& it
->sp
> 0)
7251 set_iterator_to_next (it
, false);
7252 success_p
= get_next_display_element (it
);
7255 /* Value is false if end of buffer or string reached. */
7260 /* Move IT to the next display element.
7262 RESEAT_P means if called on a newline in buffer text,
7263 skip to the next visible line start.
7265 Functions get_next_display_element and set_iterator_to_next are
7266 separate because I find this arrangement easier to handle than a
7267 get_next_display_element function that also increments IT's
7268 position. The way it is we can first look at an iterator's current
7269 display element, decide whether it fits on a line, and if it does,
7270 increment the iterator position. The other way around we probably
7271 would either need a flag indicating whether the iterator has to be
7272 incremented the next time, or we would have to implement a
7273 decrement position function which would not be easy to write. */
7276 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7278 /* Reset flags indicating start and end of a sequence of characters
7279 with box. Reset them at the start of this function because
7280 moving the iterator to a new position might set them. */
7281 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7285 case GET_FROM_BUFFER
:
7286 /* The current display element of IT is a character from
7287 current_buffer. Advance in the buffer, and maybe skip over
7288 invisible lines that are so because of selective display. */
7289 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7290 reseat_at_next_visible_line_start (it
, false);
7291 else if (it
->cmp_it
.id
>= 0)
7293 /* We are currently getting glyphs from a composition. */
7296 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7297 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7303 /* Update IT's char/byte positions to point to the first
7304 character of the next grapheme cluster, or to the
7305 character visually after the current composition. */
7306 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7307 bidi_move_to_visually_next (&it
->bidi_it
);
7308 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7309 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7312 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7313 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7315 /* Composition created while scanning forward. Proceed
7316 to the next grapheme cluster. */
7317 it
->cmp_it
.from
= it
->cmp_it
.to
;
7319 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7320 && it
->cmp_it
.from
> 0)
7322 /* Composition created while scanning backward. Proceed
7323 to the previous grapheme cluster. */
7324 it
->cmp_it
.to
= it
->cmp_it
.from
;
7328 /* No more grapheme clusters in this composition.
7329 Find the next stop position. */
7330 ptrdiff_t stop
= it
->end_charpos
;
7332 if (it
->bidi_it
.scan_dir
< 0)
7333 /* Now we are scanning backward and don't know
7336 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7337 IT_BYTEPOS (*it
), stop
, Qnil
);
7342 eassert (it
->len
!= 0);
7346 IT_BYTEPOS (*it
) += it
->len
;
7347 IT_CHARPOS (*it
) += 1;
7351 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7352 /* If this is a new paragraph, determine its base
7353 direction (a.k.a. its base embedding level). */
7354 if (it
->bidi_it
.new_paragraph
)
7355 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7357 bidi_move_to_visually_next (&it
->bidi_it
);
7358 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7359 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7360 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7362 /* As the scan direction was changed, we must
7363 re-compute the stop position for composition. */
7364 ptrdiff_t stop
= it
->end_charpos
;
7365 if (it
->bidi_it
.scan_dir
< 0)
7367 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7368 IT_BYTEPOS (*it
), stop
, Qnil
);
7371 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7375 case GET_FROM_C_STRING
:
7376 /* Current display element of IT is from a C string. */
7378 /* If the string position is beyond string's end, it means
7379 next_element_from_c_string is padding the string with
7380 blanks, in which case we bypass the bidi iterator,
7381 because it cannot deal with such virtual characters. */
7382 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7384 IT_BYTEPOS (*it
) += it
->len
;
7385 IT_CHARPOS (*it
) += 1;
7389 bidi_move_to_visually_next (&it
->bidi_it
);
7390 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7391 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7395 case GET_FROM_DISPLAY_VECTOR
:
7396 /* Current display element of IT is from a display table entry.
7397 Advance in the display table definition. Reset it to null if
7398 end reached, and continue with characters from buffers/
7400 ++it
->current
.dpvec_index
;
7402 /* Restore face of the iterator to what they were before the
7403 display vector entry (these entries may contain faces). */
7404 it
->face_id
= it
->saved_face_id
;
7406 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7408 bool recheck_faces
= it
->ellipsis_p
;
7411 it
->method
= GET_FROM_C_STRING
;
7412 else if (STRINGP (it
->string
))
7413 it
->method
= GET_FROM_STRING
;
7416 it
->method
= GET_FROM_BUFFER
;
7417 it
->object
= it
->w
->contents
;
7421 it
->current
.dpvec_index
= -1;
7423 /* Skip over characters which were displayed via IT->dpvec. */
7424 if (it
->dpvec_char_len
< 0)
7425 reseat_at_next_visible_line_start (it
, true);
7426 else if (it
->dpvec_char_len
> 0)
7428 it
->len
= it
->dpvec_char_len
;
7429 set_iterator_to_next (it
, reseat_p
);
7432 /* Maybe recheck faces after display vector. */
7435 if (it
->method
== GET_FROM_STRING
)
7436 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7438 it
->stop_charpos
= IT_CHARPOS (*it
);
7443 case GET_FROM_STRING
:
7444 /* Current display element is a character from a Lisp string. */
7445 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7446 /* Don't advance past string end. These conditions are true
7447 when set_iterator_to_next is called at the end of
7448 get_next_display_element, in which case the Lisp string is
7449 already exhausted, and all we want is pop the iterator
7451 if (it
->current
.overlay_string_index
>= 0)
7453 /* This is an overlay string, so there's no padding with
7454 spaces, and the number of characters in the string is
7455 where the string ends. */
7456 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7457 goto consider_string_end
;
7461 /* Not an overlay string. There could be padding, so test
7462 against it->end_charpos. */
7463 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7464 goto consider_string_end
;
7466 if (it
->cmp_it
.id
>= 0)
7468 /* We are delivering display elements from a composition.
7469 Update the string position past the grapheme cluster
7470 we've just processed. */
7473 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7474 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7480 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7481 bidi_move_to_visually_next (&it
->bidi_it
);
7482 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7483 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7486 /* Did we exhaust all the grapheme clusters of this
7488 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7489 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7491 /* Not all the grapheme clusters were processed yet;
7492 advance to the next cluster. */
7493 it
->cmp_it
.from
= it
->cmp_it
.to
;
7495 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7496 && it
->cmp_it
.from
> 0)
7498 /* Likewise: advance to the next cluster, but going in
7499 the reverse direction. */
7500 it
->cmp_it
.to
= it
->cmp_it
.from
;
7504 /* This composition was fully processed; find the next
7505 candidate place for checking for composed
7507 /* Always limit string searches to the string length;
7508 any padding spaces are not part of the string, and
7509 there cannot be any compositions in that padding. */
7510 ptrdiff_t stop
= SCHARS (it
->string
);
7512 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7514 else if (it
->end_charpos
< stop
)
7516 /* Cf. PRECISION in reseat_to_string: we might be
7517 limited in how many of the string characters we
7519 stop
= it
->end_charpos
;
7521 composition_compute_stop_pos (&it
->cmp_it
,
7522 IT_STRING_CHARPOS (*it
),
7523 IT_STRING_BYTEPOS (*it
), stop
,
7530 /* If the string position is beyond string's end, it
7531 means next_element_from_string is padding the string
7532 with blanks, in which case we bypass the bidi
7533 iterator, because it cannot deal with such virtual
7535 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7537 IT_STRING_BYTEPOS (*it
) += it
->len
;
7538 IT_STRING_CHARPOS (*it
) += 1;
7542 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7544 bidi_move_to_visually_next (&it
->bidi_it
);
7545 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7546 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7547 /* If the scan direction changes, we may need to update
7548 the place where to check for composed characters. */
7549 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7551 ptrdiff_t stop
= SCHARS (it
->string
);
7553 if (it
->bidi_it
.scan_dir
< 0)
7555 else if (it
->end_charpos
< stop
)
7556 stop
= it
->end_charpos
;
7558 composition_compute_stop_pos (&it
->cmp_it
,
7559 IT_STRING_CHARPOS (*it
),
7560 IT_STRING_BYTEPOS (*it
), stop
,
7566 consider_string_end
:
7568 if (it
->current
.overlay_string_index
>= 0)
7570 /* IT->string is an overlay string. Advance to the
7571 next, if there is one. */
7572 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7574 it
->ellipsis_p
= false;
7575 next_overlay_string (it
);
7577 setup_for_ellipsis (it
, 0);
7582 /* IT->string is not an overlay string. If we reached
7583 its end, and there is something on IT->stack, proceed
7584 with what is on the stack. This can be either another
7585 string, this time an overlay string, or a buffer. */
7586 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7590 if (it
->method
== GET_FROM_STRING
)
7591 goto consider_string_end
;
7596 case GET_FROM_IMAGE
:
7597 case GET_FROM_STRETCH
:
7598 /* The position etc with which we have to proceed are on
7599 the stack. The position may be at the end of a string,
7600 if the `display' property takes up the whole string. */
7601 eassert (it
->sp
> 0);
7603 if (it
->method
== GET_FROM_STRING
)
7604 goto consider_string_end
;
7608 /* There are no other methods defined, so this should be a bug. */
7612 eassert (it
->method
!= GET_FROM_STRING
7613 || (STRINGP (it
->string
)
7614 && IT_STRING_CHARPOS (*it
) >= 0));
7617 /* Load IT's display element fields with information about the next
7618 display element which comes from a display table entry or from the
7619 result of translating a control character to one of the forms `^C'
7622 IT->dpvec holds the glyphs to return as characters.
7623 IT->saved_face_id holds the face id before the display vector--it
7624 is restored into IT->face_id in set_iterator_to_next. */
7627 next_element_from_display_vector (struct it
*it
)
7630 int prev_face_id
= it
->face_id
;
7634 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7636 it
->face_id
= it
->saved_face_id
;
7638 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7639 That seemed totally bogus - so I changed it... */
7640 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7642 if (GLYPH_CODE_P (gc
))
7644 struct face
*this_face
, *prev_face
, *next_face
;
7646 it
->c
= GLYPH_CODE_CHAR (gc
);
7647 it
->len
= CHAR_BYTES (it
->c
);
7649 /* The entry may contain a face id to use. Such a face id is
7650 the id of a Lisp face, not a realized face. A face id of
7651 zero means no face is specified. */
7652 if (it
->dpvec_face_id
>= 0)
7653 it
->face_id
= it
->dpvec_face_id
;
7656 int lface_id
= GLYPH_CODE_FACE (gc
);
7658 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7662 /* Glyphs in the display vector could have the box face, so we
7663 need to set the related flags in the iterator, as
7665 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7666 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7668 /* Is this character the first character of a box-face run? */
7669 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7671 || prev_face
->box
== FACE_NO_BOX
));
7673 /* For the last character of the box-face run, we need to look
7674 either at the next glyph from the display vector, or at the
7675 face we saw before the display vector. */
7676 next_face_id
= it
->saved_face_id
;
7677 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7679 if (it
->dpvec_face_id
>= 0)
7680 next_face_id
= it
->dpvec_face_id
;
7684 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7687 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7691 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7692 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7694 || next_face
->box
== FACE_NO_BOX
));
7695 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7698 /* Display table entry is invalid. Return a space. */
7699 it
->c
= ' ', it
->len
= 1;
7701 /* Don't change position and object of the iterator here. They are
7702 still the values of the character that had this display table
7703 entry or was translated, and that's what we want. */
7704 it
->what
= IT_CHARACTER
;
7708 /* Get the first element of string/buffer in the visual order, after
7709 being reseated to a new position in a string or a buffer. */
7711 get_visually_first_element (struct it
*it
)
7713 bool string_p
= STRINGP (it
->string
) || it
->s
;
7714 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7715 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7717 if (STRINGP (it
->string
))
7719 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7720 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7724 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7725 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7728 if (it
->bidi_it
.charpos
== eob
)
7730 /* Nothing to do, but reset the FIRST_ELT flag, like
7731 bidi_paragraph_init does, because we are not going to
7733 it
->bidi_it
.first_elt
= false;
7735 else if (it
->bidi_it
.charpos
== bob
7737 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7738 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7740 /* If we are at the beginning of a line/string, we can produce
7741 the next element right away. */
7742 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7743 bidi_move_to_visually_next (&it
->bidi_it
);
7747 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7749 /* We need to prime the bidi iterator starting at the line's or
7750 string's beginning, before we will be able to produce the
7753 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7755 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7756 IT_BYTEPOS (*it
), -1,
7757 &it
->bidi_it
.bytepos
);
7758 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7761 /* Now return to buffer/string position where we were asked
7762 to get the next display element, and produce that. */
7763 bidi_move_to_visually_next (&it
->bidi_it
);
7765 while (it
->bidi_it
.bytepos
!= orig_bytepos
7766 && it
->bidi_it
.charpos
< eob
);
7769 /* Adjust IT's position information to where we ended up. */
7770 if (STRINGP (it
->string
))
7772 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7773 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7777 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7778 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7781 if (STRINGP (it
->string
) || !it
->s
)
7783 ptrdiff_t stop
, charpos
, bytepos
;
7785 if (STRINGP (it
->string
))
7788 stop
= SCHARS (it
->string
);
7789 if (stop
> it
->end_charpos
)
7790 stop
= it
->end_charpos
;
7791 charpos
= IT_STRING_CHARPOS (*it
);
7792 bytepos
= IT_STRING_BYTEPOS (*it
);
7796 stop
= it
->end_charpos
;
7797 charpos
= IT_CHARPOS (*it
);
7798 bytepos
= IT_BYTEPOS (*it
);
7800 if (it
->bidi_it
.scan_dir
< 0)
7802 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7807 /* Load IT with the next display element from Lisp string IT->string.
7808 IT->current.string_pos is the current position within the string.
7809 If IT->current.overlay_string_index >= 0, the Lisp string is an
7813 next_element_from_string (struct it
*it
)
7815 struct text_pos position
;
7817 eassert (STRINGP (it
->string
));
7818 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7819 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7820 position
= it
->current
.string_pos
;
7822 /* With bidi reordering, the character to display might not be the
7823 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7824 that we were reseat()ed to a new string, whose paragraph
7825 direction is not known. */
7826 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7828 get_visually_first_element (it
);
7829 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7832 /* Time to check for invisible text? */
7833 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7835 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7838 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7839 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7841 /* With bidi non-linear iteration, we could find
7842 ourselves far beyond the last computed stop_charpos,
7843 with several other stop positions in between that we
7844 missed. Scan them all now, in buffer's logical
7845 order, until we find and handle the last stop_charpos
7846 that precedes our current position. */
7847 handle_stop_backwards (it
, it
->stop_charpos
);
7848 return GET_NEXT_DISPLAY_ELEMENT (it
);
7854 /* Take note of the stop position we just moved
7855 across, for when we will move back across it. */
7856 it
->prev_stop
= it
->stop_charpos
;
7857 /* If we are at base paragraph embedding level, take
7858 note of the last stop position seen at this
7860 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7861 it
->base_level_stop
= it
->stop_charpos
;
7865 /* Since a handler may have changed IT->method, we must
7867 return GET_NEXT_DISPLAY_ELEMENT (it
);
7871 /* If we are before prev_stop, we may have overstepped
7872 on our way backwards a stop_pos, and if so, we need
7873 to handle that stop_pos. */
7874 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7875 /* We can sometimes back up for reasons that have nothing
7876 to do with bidi reordering. E.g., compositions. The
7877 code below is only needed when we are above the base
7878 embedding level, so test for that explicitly. */
7879 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7881 /* If we lost track of base_level_stop, we have no better
7882 place for handle_stop_backwards to start from than string
7883 beginning. This happens, e.g., when we were reseated to
7884 the previous screenful of text by vertical-motion. */
7885 if (it
->base_level_stop
<= 0
7886 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7887 it
->base_level_stop
= 0;
7888 handle_stop_backwards (it
, it
->base_level_stop
);
7889 return GET_NEXT_DISPLAY_ELEMENT (it
);
7893 if (it
->current
.overlay_string_index
>= 0)
7895 /* Get the next character from an overlay string. In overlay
7896 strings, there is no field width or padding with spaces to
7898 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7903 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7904 IT_STRING_BYTEPOS (*it
),
7905 it
->bidi_it
.scan_dir
< 0
7907 : SCHARS (it
->string
))
7908 && next_element_from_composition (it
))
7912 else if (STRING_MULTIBYTE (it
->string
))
7914 const unsigned char *s
= (SDATA (it
->string
)
7915 + IT_STRING_BYTEPOS (*it
));
7916 it
->c
= string_char_and_length (s
, &it
->len
);
7920 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7926 /* Get the next character from a Lisp string that is not an
7927 overlay string. Such strings come from the mode line, for
7928 example. We may have to pad with spaces, or truncate the
7929 string. See also next_element_from_c_string. */
7930 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7935 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7937 /* Pad with spaces. */
7938 it
->c
= ' ', it
->len
= 1;
7939 CHARPOS (position
) = BYTEPOS (position
) = -1;
7941 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7942 IT_STRING_BYTEPOS (*it
),
7943 it
->bidi_it
.scan_dir
< 0
7945 : it
->string_nchars
)
7946 && next_element_from_composition (it
))
7950 else if (STRING_MULTIBYTE (it
->string
))
7952 const unsigned char *s
= (SDATA (it
->string
)
7953 + IT_STRING_BYTEPOS (*it
));
7954 it
->c
= string_char_and_length (s
, &it
->len
);
7958 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7963 /* Record what we have and where it came from. */
7964 it
->what
= IT_CHARACTER
;
7965 it
->object
= it
->string
;
7966 it
->position
= position
;
7971 /* Load IT with next display element from C string IT->s.
7972 IT->string_nchars is the maximum number of characters to return
7973 from the string. IT->end_charpos may be greater than
7974 IT->string_nchars when this function is called, in which case we
7975 may have to return padding spaces. Value is false if end of string
7976 reached, including padding spaces. */
7979 next_element_from_c_string (struct it
*it
)
7981 bool success_p
= true;
7984 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7985 it
->what
= IT_CHARACTER
;
7986 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7987 it
->object
= make_number (0);
7989 /* With bidi reordering, the character to display might not be the
7990 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7991 we were reseated to a new string, whose paragraph direction is
7993 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7994 get_visually_first_element (it
);
7996 /* IT's position can be greater than IT->string_nchars in case a
7997 field width or precision has been specified when the iterator was
7999 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8001 /* End of the game. */
8005 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8007 /* Pad with spaces. */
8008 it
->c
= ' ', it
->len
= 1;
8009 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8011 else if (it
->multibyte_p
)
8012 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8014 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8020 /* Set up IT to return characters from an ellipsis, if appropriate.
8021 The definition of the ellipsis glyphs may come from a display table
8022 entry. This function fills IT with the first glyph from the
8023 ellipsis if an ellipsis is to be displayed. */
8026 next_element_from_ellipsis (struct it
*it
)
8028 if (it
->selective_display_ellipsis_p
)
8029 setup_for_ellipsis (it
, it
->len
);
8032 /* The face at the current position may be different from the
8033 face we find after the invisible text. Remember what it
8034 was in IT->saved_face_id, and signal that it's there by
8035 setting face_before_selective_p. */
8036 it
->saved_face_id
= it
->face_id
;
8037 it
->method
= GET_FROM_BUFFER
;
8038 it
->object
= it
->w
->contents
;
8039 reseat_at_next_visible_line_start (it
, true);
8040 it
->face_before_selective_p
= true;
8043 return GET_NEXT_DISPLAY_ELEMENT (it
);
8047 /* Deliver an image display element. The iterator IT is already
8048 filled with image information (done in handle_display_prop). Value
8053 next_element_from_image (struct it
*it
)
8055 it
->what
= IT_IMAGE
;
8060 /* Fill iterator IT with next display element from a stretch glyph
8061 property. IT->object is the value of the text property. Value is
8065 next_element_from_stretch (struct it
*it
)
8067 it
->what
= IT_STRETCH
;
8071 /* Scan backwards from IT's current position until we find a stop
8072 position, or until BEGV. This is called when we find ourself
8073 before both the last known prev_stop and base_level_stop while
8074 reordering bidirectional text. */
8077 compute_stop_pos_backwards (struct it
*it
)
8079 const int SCAN_BACK_LIMIT
= 1000;
8080 struct text_pos pos
;
8081 struct display_pos save_current
= it
->current
;
8082 struct text_pos save_position
= it
->position
;
8083 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8084 ptrdiff_t where_we_are
= charpos
;
8085 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8086 ptrdiff_t save_end_pos
= it
->end_charpos
;
8088 eassert (NILP (it
->string
) && !it
->s
);
8089 eassert (it
->bidi_p
);
8093 it
->end_charpos
= min (charpos
+ 1, ZV
);
8094 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8095 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8096 reseat_1 (it
, pos
, false);
8097 compute_stop_pos (it
);
8098 /* We must advance forward, right? */
8099 if (it
->stop_charpos
<= charpos
)
8102 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8104 if (it
->stop_charpos
<= where_we_are
)
8105 it
->prev_stop
= it
->stop_charpos
;
8107 it
->prev_stop
= BEGV
;
8109 it
->current
= save_current
;
8110 it
->position
= save_position
;
8111 it
->stop_charpos
= save_stop_pos
;
8112 it
->end_charpos
= save_end_pos
;
8115 /* Scan forward from CHARPOS in the current buffer/string, until we
8116 find a stop position > current IT's position. Then handle the stop
8117 position before that. This is called when we bump into a stop
8118 position while reordering bidirectional text. CHARPOS should be
8119 the last previously processed stop_pos (or BEGV/0, if none were
8120 processed yet) whose position is less that IT's current
8124 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8126 bool bufp
= !STRINGP (it
->string
);
8127 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8128 struct display_pos save_current
= it
->current
;
8129 struct text_pos save_position
= it
->position
;
8130 struct text_pos pos1
;
8131 ptrdiff_t next_stop
;
8133 /* Scan in strict logical order. */
8134 eassert (it
->bidi_p
);
8138 it
->prev_stop
= charpos
;
8141 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8142 reseat_1 (it
, pos1
, false);
8145 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8146 compute_stop_pos (it
);
8147 /* We must advance forward, right? */
8148 if (it
->stop_charpos
<= it
->prev_stop
)
8150 charpos
= it
->stop_charpos
;
8152 while (charpos
<= where_we_are
);
8155 it
->current
= save_current
;
8156 it
->position
= save_position
;
8157 next_stop
= it
->stop_charpos
;
8158 it
->stop_charpos
= it
->prev_stop
;
8160 it
->stop_charpos
= next_stop
;
8163 /* Load IT with the next display element from current_buffer. Value
8164 is false if end of buffer reached. IT->stop_charpos is the next
8165 position at which to stop and check for text properties or buffer
8169 next_element_from_buffer (struct it
*it
)
8171 bool success_p
= true;
8173 eassert (IT_CHARPOS (*it
) >= BEGV
);
8174 eassert (NILP (it
->string
) && !it
->s
);
8175 eassert (!it
->bidi_p
8176 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8177 && it
->bidi_it
.string
.s
== NULL
));
8179 /* With bidi reordering, the character to display might not be the
8180 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8181 we were reseat()ed to a new buffer position, which is potentially
8182 a different paragraph. */
8183 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8185 get_visually_first_element (it
);
8186 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8189 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8191 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8193 bool overlay_strings_follow_p
;
8195 /* End of the game, except when overlay strings follow that
8196 haven't been returned yet. */
8197 if (it
->overlay_strings_at_end_processed_p
)
8198 overlay_strings_follow_p
= false;
8201 it
->overlay_strings_at_end_processed_p
= true;
8202 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8205 if (overlay_strings_follow_p
)
8206 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8210 it
->position
= it
->current
.pos
;
8214 else if (!(!it
->bidi_p
8215 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8216 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8218 /* With bidi non-linear iteration, we could find ourselves
8219 far beyond the last computed stop_charpos, with several
8220 other stop positions in between that we missed. Scan
8221 them all now, in buffer's logical order, until we find
8222 and handle the last stop_charpos that precedes our
8223 current position. */
8224 handle_stop_backwards (it
, it
->stop_charpos
);
8225 it
->ignore_overlay_strings_at_pos_p
= false;
8226 return GET_NEXT_DISPLAY_ELEMENT (it
);
8232 /* Take note of the stop position we just moved across,
8233 for when we will move back across it. */
8234 it
->prev_stop
= it
->stop_charpos
;
8235 /* If we are at base paragraph embedding level, take
8236 note of the last stop position seen at this
8238 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8239 it
->base_level_stop
= it
->stop_charpos
;
8242 it
->ignore_overlay_strings_at_pos_p
= false;
8243 return GET_NEXT_DISPLAY_ELEMENT (it
);
8247 /* If we are before prev_stop, we may have overstepped on
8248 our way backwards a stop_pos, and if so, we need to
8249 handle that stop_pos. */
8250 && IT_CHARPOS (*it
) < it
->prev_stop
8251 /* We can sometimes back up for reasons that have nothing
8252 to do with bidi reordering. E.g., compositions. The
8253 code below is only needed when we are above the base
8254 embedding level, so test for that explicitly. */
8255 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8257 if (it
->base_level_stop
<= 0
8258 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8260 /* If we lost track of base_level_stop, we need to find
8261 prev_stop by looking backwards. This happens, e.g., when
8262 we were reseated to the previous screenful of text by
8264 it
->base_level_stop
= BEGV
;
8265 compute_stop_pos_backwards (it
);
8266 handle_stop_backwards (it
, it
->prev_stop
);
8269 handle_stop_backwards (it
, it
->base_level_stop
);
8270 it
->ignore_overlay_strings_at_pos_p
= false;
8271 return GET_NEXT_DISPLAY_ELEMENT (it
);
8275 /* No face changes, overlays etc. in sight, so just return a
8276 character from current_buffer. */
8280 /* We moved to the next buffer position, so any info about
8281 previously seen overlays is no longer valid. */
8282 it
->ignore_overlay_strings_at_pos_p
= false;
8284 /* Maybe run the redisplay end trigger hook. Performance note:
8285 This doesn't seem to cost measurable time. */
8286 if (it
->redisplay_end_trigger_charpos
8288 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8289 run_redisplay_end_trigger_hook (it
);
8291 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8292 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8294 && next_element_from_composition (it
))
8299 /* Get the next character, maybe multibyte. */
8300 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8301 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8302 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8304 it
->c
= *p
, it
->len
= 1;
8306 /* Record what we have and where it came from. */
8307 it
->what
= IT_CHARACTER
;
8308 it
->object
= it
->w
->contents
;
8309 it
->position
= it
->current
.pos
;
8311 /* Normally we return the character found above, except when we
8312 really want to return an ellipsis for selective display. */
8317 /* A value of selective > 0 means hide lines indented more
8318 than that number of columns. */
8319 if (it
->selective
> 0
8320 && IT_CHARPOS (*it
) + 1 < ZV
8321 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8322 IT_BYTEPOS (*it
) + 1,
8325 success_p
= next_element_from_ellipsis (it
);
8326 it
->dpvec_char_len
= -1;
8329 else if (it
->c
== '\r' && it
->selective
== -1)
8331 /* A value of selective == -1 means that everything from the
8332 CR to the end of the line is invisible, with maybe an
8333 ellipsis displayed for it. */
8334 success_p
= next_element_from_ellipsis (it
);
8335 it
->dpvec_char_len
= -1;
8340 /* Value is false if end of buffer reached. */
8341 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8346 /* Run the redisplay end trigger hook for IT. */
8349 run_redisplay_end_trigger_hook (struct it
*it
)
8351 /* IT->glyph_row should be non-null, i.e. we should be actually
8352 displaying something, or otherwise we should not run the hook. */
8353 eassert (it
->glyph_row
);
8355 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8356 it
->redisplay_end_trigger_charpos
= 0;
8358 /* Since we are *trying* to run these functions, don't try to run
8359 them again, even if they get an error. */
8360 wset_redisplay_end_trigger (it
->w
, Qnil
);
8361 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8362 make_number (charpos
));
8364 /* Notice if it changed the face of the character we are on. */
8365 handle_face_prop (it
);
8369 /* Deliver a composition display element. Unlike the other
8370 next_element_from_XXX, this function is not registered in the array
8371 get_next_element[]. It is called from next_element_from_buffer and
8372 next_element_from_string when necessary. */
8375 next_element_from_composition (struct it
*it
)
8377 it
->what
= IT_COMPOSITION
;
8378 it
->len
= it
->cmp_it
.nbytes
;
8379 if (STRINGP (it
->string
))
8383 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8384 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8387 it
->position
= it
->current
.string_pos
;
8388 it
->object
= it
->string
;
8389 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8390 IT_STRING_BYTEPOS (*it
), it
->string
);
8396 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8397 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8400 if (it
->bidi_it
.new_paragraph
)
8401 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8403 /* Resync the bidi iterator with IT's new position.
8404 FIXME: this doesn't support bidirectional text. */
8405 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8406 bidi_move_to_visually_next (&it
->bidi_it
);
8410 it
->position
= it
->current
.pos
;
8411 it
->object
= it
->w
->contents
;
8412 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8413 IT_BYTEPOS (*it
), Qnil
);
8420 /***********************************************************************
8421 Moving an iterator without producing glyphs
8422 ***********************************************************************/
8424 /* Check if iterator is at a position corresponding to a valid buffer
8425 position after some move_it_ call. */
8427 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8428 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8431 /* Move iterator IT to a specified buffer or X position within one
8432 line on the display without producing glyphs.
8434 OP should be a bit mask including some or all of these bits:
8435 MOVE_TO_X: Stop upon reaching x-position TO_X.
8436 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8437 Regardless of OP's value, stop upon reaching the end of the display line.
8439 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8440 This means, in particular, that TO_X includes window's horizontal
8443 The return value has several possible values that
8444 say what condition caused the scan to stop:
8446 MOVE_POS_MATCH_OR_ZV
8447 - when TO_POS or ZV was reached.
8450 -when TO_X was reached before TO_POS or ZV were reached.
8453 - when we reached the end of the display area and the line must
8457 - when we reached the end of the display area and the line is
8461 - when we stopped at a line end, i.e. a newline or a CR and selective
8464 static enum move_it_result
8465 move_it_in_display_line_to (struct it
*it
,
8466 ptrdiff_t to_charpos
, int to_x
,
8467 enum move_operation_enum op
)
8469 enum move_it_result result
= MOVE_UNDEFINED
;
8470 struct glyph_row
*saved_glyph_row
;
8471 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8472 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8473 void *ppos_data
= NULL
;
8474 bool may_wrap
= false;
8475 enum it_method prev_method
= it
->method
;
8476 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8477 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8479 /* Don't produce glyphs in produce_glyphs. */
8480 saved_glyph_row
= it
->glyph_row
;
8481 it
->glyph_row
= NULL
;
8483 /* Use wrap_it to save a copy of IT wherever a word wrap could
8484 occur. Use atpos_it to save a copy of IT at the desired buffer
8485 position, if found, so that we can scan ahead and check if the
8486 word later overshoots the window edge. Use atx_it similarly, for
8492 /* Use ppos_it under bidi reordering to save a copy of IT for the
8493 initial position. We restore that position in IT when we have
8494 scanned the entire display line without finding a match for
8495 TO_CHARPOS and all the character positions are greater than
8496 TO_CHARPOS. We then restart the scan from the initial position,
8497 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8498 the closest to TO_CHARPOS. */
8501 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8503 SAVE_IT (ppos_it
, *it
, ppos_data
);
8504 closest_pos
= IT_CHARPOS (*it
);
8510 #define BUFFER_POS_REACHED_P() \
8511 ((op & MOVE_TO_POS) != 0 \
8512 && BUFFERP (it->object) \
8513 && (IT_CHARPOS (*it) == to_charpos \
8515 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8516 && IT_CHARPOS (*it) > to_charpos) \
8517 || (it->what == IT_COMPOSITION \
8518 && ((IT_CHARPOS (*it) > to_charpos \
8519 && to_charpos >= it->cmp_it.charpos) \
8520 || (IT_CHARPOS (*it) < to_charpos \
8521 && to_charpos <= it->cmp_it.charpos)))) \
8522 && (it->method == GET_FROM_BUFFER \
8523 || (it->method == GET_FROM_DISPLAY_VECTOR \
8524 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8526 /* If there's a line-/wrap-prefix, handle it. */
8527 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8528 && it
->current_y
< it
->last_visible_y
)
8529 handle_line_prefix (it
);
8531 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8532 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8536 int x
, i
, ascent
= 0, descent
= 0;
8538 /* Utility macro to reset an iterator with x, ascent, and descent. */
8539 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8540 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8541 (IT)->max_descent = descent)
8543 /* Stop if we move beyond TO_CHARPOS (after an image or a
8544 display string or stretch glyph). */
8545 if ((op
& MOVE_TO_POS
) != 0
8546 && BUFFERP (it
->object
)
8547 && it
->method
== GET_FROM_BUFFER
8549 /* When the iterator is at base embedding level, we
8550 are guaranteed that characters are delivered for
8551 display in strictly increasing order of their
8552 buffer positions. */
8553 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8554 && IT_CHARPOS (*it
) > to_charpos
)
8556 && (prev_method
== GET_FROM_IMAGE
8557 || prev_method
== GET_FROM_STRETCH
8558 || prev_method
== GET_FROM_STRING
)
8559 /* Passed TO_CHARPOS from left to right. */
8560 && ((prev_pos
< to_charpos
8561 && IT_CHARPOS (*it
) > to_charpos
)
8562 /* Passed TO_CHARPOS from right to left. */
8563 || (prev_pos
> to_charpos
8564 && IT_CHARPOS (*it
) < to_charpos
)))))
8566 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8568 result
= MOVE_POS_MATCH_OR_ZV
;
8571 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8572 /* If wrap_it is valid, the current position might be in a
8573 word that is wrapped. So, save the iterator in
8574 atpos_it and continue to see if wrapping happens. */
8575 SAVE_IT (atpos_it
, *it
, atpos_data
);
8578 /* Stop when ZV reached.
8579 We used to stop here when TO_CHARPOS reached as well, but that is
8580 too soon if this glyph does not fit on this line. So we handle it
8581 explicitly below. */
8582 if (!get_next_display_element (it
))
8584 result
= MOVE_POS_MATCH_OR_ZV
;
8588 if (it
->line_wrap
== TRUNCATE
)
8590 if (BUFFER_POS_REACHED_P ())
8592 result
= MOVE_POS_MATCH_OR_ZV
;
8598 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8600 if (IT_DISPLAYING_WHITESPACE (it
))
8604 /* We have reached a glyph that follows one or more
8605 whitespace characters. If the position is
8606 already found, we are done. */
8607 if (atpos_it
.sp
>= 0)
8609 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8610 result
= MOVE_POS_MATCH_OR_ZV
;
8615 RESTORE_IT (it
, &atx_it
, atx_data
);
8616 result
= MOVE_X_REACHED
;
8619 /* Otherwise, we can wrap here. */
8620 SAVE_IT (wrap_it
, *it
, wrap_data
);
8626 /* Remember the line height for the current line, in case
8627 the next element doesn't fit on the line. */
8628 ascent
= it
->max_ascent
;
8629 descent
= it
->max_descent
;
8631 /* The call to produce_glyphs will get the metrics of the
8632 display element IT is loaded with. Record the x-position
8633 before this display element, in case it doesn't fit on the
8637 PRODUCE_GLYPHS (it
);
8639 if (it
->area
!= TEXT_AREA
)
8641 prev_method
= it
->method
;
8642 if (it
->method
== GET_FROM_BUFFER
)
8643 prev_pos
= IT_CHARPOS (*it
);
8644 set_iterator_to_next (it
, true);
8645 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8646 SET_TEXT_POS (this_line_min_pos
,
8647 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8649 && (op
& MOVE_TO_POS
)
8650 && IT_CHARPOS (*it
) > to_charpos
8651 && IT_CHARPOS (*it
) < closest_pos
)
8652 closest_pos
= IT_CHARPOS (*it
);
8656 /* The number of glyphs we get back in IT->nglyphs will normally
8657 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8658 character on a terminal frame, or (iii) a line end. For the
8659 second case, IT->nglyphs - 1 padding glyphs will be present.
8660 (On X frames, there is only one glyph produced for a
8661 composite character.)
8663 The behavior implemented below means, for continuation lines,
8664 that as many spaces of a TAB as fit on the current line are
8665 displayed there. For terminal frames, as many glyphs of a
8666 multi-glyph character are displayed in the current line, too.
8667 This is what the old redisplay code did, and we keep it that
8668 way. Under X, the whole shape of a complex character must
8669 fit on the line or it will be completely displayed in the
8672 Note that both for tabs and padding glyphs, all glyphs have
8676 /* More than one glyph or glyph doesn't fit on line. All
8677 glyphs have the same width. */
8678 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8680 int x_before_this_char
= x
;
8681 int hpos_before_this_char
= it
->hpos
;
8683 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8685 new_x
= x
+ single_glyph_width
;
8687 /* We want to leave anything reaching TO_X to the caller. */
8688 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8690 if (BUFFER_POS_REACHED_P ())
8692 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8693 goto buffer_pos_reached
;
8694 if (atpos_it
.sp
< 0)
8696 SAVE_IT (atpos_it
, *it
, atpos_data
);
8697 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8702 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8705 result
= MOVE_X_REACHED
;
8710 SAVE_IT (atx_it
, *it
, atx_data
);
8711 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8716 if (/* Lines are continued. */
8717 it
->line_wrap
!= TRUNCATE
8718 && (/* And glyph doesn't fit on the line. */
8719 new_x
> it
->last_visible_x
8720 /* Or it fits exactly and we're on a window
8722 || (new_x
== it
->last_visible_x
8723 && FRAME_WINDOW_P (it
->f
)
8724 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8725 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8726 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8728 if (/* IT->hpos == 0 means the very first glyph
8729 doesn't fit on the line, e.g. a wide image. */
8731 || (new_x
== it
->last_visible_x
8732 && FRAME_WINDOW_P (it
->f
)))
8735 it
->current_x
= new_x
;
8737 /* The character's last glyph just barely fits
8739 if (i
== it
->nglyphs
- 1)
8741 /* If this is the destination position,
8742 return a position *before* it in this row,
8743 now that we know it fits in this row. */
8744 if (BUFFER_POS_REACHED_P ())
8746 if (it
->line_wrap
!= WORD_WRAP
8748 /* If we've just found whitespace to
8749 wrap, effectively ignore the
8750 previous wrap point -- it is no
8751 longer relevant, but we won't
8752 have an opportunity to update it,
8753 since we've reached the edge of
8754 this screen line. */
8756 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8758 it
->hpos
= hpos_before_this_char
;
8759 it
->current_x
= x_before_this_char
;
8760 result
= MOVE_POS_MATCH_OR_ZV
;
8763 if (it
->line_wrap
== WORD_WRAP
8766 SAVE_IT (atpos_it
, *it
, atpos_data
);
8767 atpos_it
.current_x
= x_before_this_char
;
8768 atpos_it
.hpos
= hpos_before_this_char
;
8772 prev_method
= it
->method
;
8773 if (it
->method
== GET_FROM_BUFFER
)
8774 prev_pos
= IT_CHARPOS (*it
);
8775 set_iterator_to_next (it
, true);
8776 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8777 SET_TEXT_POS (this_line_min_pos
,
8778 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8779 /* On graphical terminals, newlines may
8780 "overflow" into the fringe if
8781 overflow-newline-into-fringe is non-nil.
8782 On text terminals, and on graphical
8783 terminals with no right margin, newlines
8784 may overflow into the last glyph on the
8786 if (!FRAME_WINDOW_P (it
->f
)
8788 && it
->bidi_it
.paragraph_dir
== R2L
)
8789 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8790 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8791 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8793 if (!get_next_display_element (it
))
8795 result
= MOVE_POS_MATCH_OR_ZV
;
8798 if (BUFFER_POS_REACHED_P ())
8800 if (ITERATOR_AT_END_OF_LINE_P (it
))
8801 result
= MOVE_POS_MATCH_OR_ZV
;
8803 result
= MOVE_LINE_CONTINUED
;
8806 if (ITERATOR_AT_END_OF_LINE_P (it
)
8807 && (it
->line_wrap
!= WORD_WRAP
8809 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8811 result
= MOVE_NEWLINE_OR_CR
;
8818 IT_RESET_X_ASCENT_DESCENT (it
);
8820 /* If the screen line ends with whitespace, and we
8821 are under word-wrap, don't use wrap_it: it is no
8822 longer relevant, but we won't have an opportunity
8823 to update it, since we are done with this screen
8825 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8827 /* If we've found TO_X, go back there, as we now
8828 know the last word fits on this screen line. */
8829 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8832 RESTORE_IT (it
, &atx_it
, atx_data
);
8835 result
= MOVE_X_REACHED
;
8839 else if (wrap_it
.sp
>= 0)
8841 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8846 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8848 result
= MOVE_LINE_CONTINUED
;
8852 if (BUFFER_POS_REACHED_P ())
8854 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8855 goto buffer_pos_reached
;
8856 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8858 SAVE_IT (atpos_it
, *it
, atpos_data
);
8859 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8863 if (new_x
> it
->first_visible_x
)
8865 /* Glyph is visible. Increment number of glyphs that
8866 would be displayed. */
8871 if (result
!= MOVE_UNDEFINED
)
8874 else if (BUFFER_POS_REACHED_P ())
8877 IT_RESET_X_ASCENT_DESCENT (it
);
8878 result
= MOVE_POS_MATCH_OR_ZV
;
8881 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8883 /* Stop when TO_X specified and reached. This check is
8884 necessary here because of lines consisting of a line end,
8885 only. The line end will not produce any glyphs and we
8886 would never get MOVE_X_REACHED. */
8887 eassert (it
->nglyphs
== 0);
8888 result
= MOVE_X_REACHED
;
8892 /* Is this a line end? If yes, we're done. */
8893 if (ITERATOR_AT_END_OF_LINE_P (it
))
8895 /* If we are past TO_CHARPOS, but never saw any character
8896 positions smaller than TO_CHARPOS, return
8897 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8899 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8901 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8903 if (closest_pos
< ZV
)
8905 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8906 /* Don't recurse if closest_pos is equal to
8907 to_charpos, since we have just tried that. */
8908 if (closest_pos
!= to_charpos
)
8909 move_it_in_display_line_to (it
, closest_pos
, -1,
8911 result
= MOVE_POS_MATCH_OR_ZV
;
8914 goto buffer_pos_reached
;
8916 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8917 && IT_CHARPOS (*it
) > to_charpos
)
8918 goto buffer_pos_reached
;
8920 result
= MOVE_NEWLINE_OR_CR
;
8923 result
= MOVE_NEWLINE_OR_CR
;
8927 prev_method
= it
->method
;
8928 if (it
->method
== GET_FROM_BUFFER
)
8929 prev_pos
= IT_CHARPOS (*it
);
8930 /* The current display element has been consumed. Advance
8932 set_iterator_to_next (it
, true);
8933 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8934 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8935 if (IT_CHARPOS (*it
) < to_charpos
)
8936 saw_smaller_pos
= true;
8938 && (op
& MOVE_TO_POS
)
8939 && IT_CHARPOS (*it
) >= to_charpos
8940 && IT_CHARPOS (*it
) < closest_pos
)
8941 closest_pos
= IT_CHARPOS (*it
);
8943 /* Stop if lines are truncated and IT's current x-position is
8944 past the right edge of the window now. */
8945 if (it
->line_wrap
== TRUNCATE
8946 && it
->current_x
>= it
->last_visible_x
)
8948 if (!FRAME_WINDOW_P (it
->f
)
8949 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8950 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8951 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8952 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8954 bool at_eob_p
= false;
8956 if ((at_eob_p
= !get_next_display_element (it
))
8957 || BUFFER_POS_REACHED_P ()
8958 /* If we are past TO_CHARPOS, but never saw any
8959 character positions smaller than TO_CHARPOS,
8960 return MOVE_POS_MATCH_OR_ZV, like the
8961 unidirectional display did. */
8962 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8964 && IT_CHARPOS (*it
) > to_charpos
))
8967 && !BUFFER_POS_REACHED_P ()
8968 && !at_eob_p
&& closest_pos
< ZV
)
8970 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8971 if (closest_pos
!= to_charpos
)
8972 move_it_in_display_line_to (it
, closest_pos
, -1,
8975 result
= MOVE_POS_MATCH_OR_ZV
;
8978 if (ITERATOR_AT_END_OF_LINE_P (it
))
8980 result
= MOVE_NEWLINE_OR_CR
;
8984 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8986 && IT_CHARPOS (*it
) > to_charpos
)
8988 if (closest_pos
< ZV
)
8990 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8991 if (closest_pos
!= to_charpos
)
8992 move_it_in_display_line_to (it
, closest_pos
, -1,
8995 result
= MOVE_POS_MATCH_OR_ZV
;
8998 result
= MOVE_LINE_TRUNCATED
;
9001 #undef IT_RESET_X_ASCENT_DESCENT
9004 #undef BUFFER_POS_REACHED_P
9006 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9007 restore the saved iterator. */
9008 if (atpos_it
.sp
>= 0)
9009 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9010 else if (atx_it
.sp
>= 0)
9011 RESTORE_IT (it
, &atx_it
, atx_data
);
9016 bidi_unshelve_cache (atpos_data
, true);
9018 bidi_unshelve_cache (atx_data
, true);
9020 bidi_unshelve_cache (wrap_data
, true);
9022 bidi_unshelve_cache (ppos_data
, true);
9024 /* Restore the iterator settings altered at the beginning of this
9026 it
->glyph_row
= saved_glyph_row
;
9030 /* For external use. */
9032 move_it_in_display_line (struct it
*it
,
9033 ptrdiff_t to_charpos
, int to_x
,
9034 enum move_operation_enum op
)
9036 if (it
->line_wrap
== WORD_WRAP
9037 && (op
& MOVE_TO_X
))
9040 void *save_data
= NULL
;
9043 SAVE_IT (save_it
, *it
, save_data
);
9044 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9045 /* When word-wrap is on, TO_X may lie past the end
9046 of a wrapped line. Then it->current is the
9047 character on the next line, so backtrack to the
9048 space before the wrap point. */
9049 if (skip
== MOVE_LINE_CONTINUED
)
9051 int prev_x
= max (it
->current_x
- 1, 0);
9052 RESTORE_IT (it
, &save_it
, save_data
);
9053 move_it_in_display_line_to
9054 (it
, -1, prev_x
, MOVE_TO_X
);
9057 bidi_unshelve_cache (save_data
, true);
9060 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9064 /* Move IT forward until it satisfies one or more of the criteria in
9065 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9067 OP is a bit-mask that specifies where to stop, and in particular,
9068 which of those four position arguments makes a difference. See the
9069 description of enum move_operation_enum.
9071 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9072 screen line, this function will set IT to the next position that is
9073 displayed to the right of TO_CHARPOS on the screen.
9075 Return the maximum pixel length of any line scanned but never more
9076 than it.last_visible_x. */
9079 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9081 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9082 int line_height
, line_start_x
= 0, reached
= 0;
9083 int max_current_x
= 0;
9084 void *backup_data
= NULL
;
9088 if (op
& MOVE_TO_VPOS
)
9090 /* If no TO_CHARPOS and no TO_X specified, stop at the
9091 start of the line TO_VPOS. */
9092 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9094 if (it
->vpos
== to_vpos
)
9100 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9104 /* TO_VPOS >= 0 means stop at TO_X in the line at
9105 TO_VPOS, or at TO_POS, whichever comes first. */
9106 if (it
->vpos
== to_vpos
)
9112 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9114 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9119 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9121 /* We have reached TO_X but not in the line we want. */
9122 skip
= move_it_in_display_line_to (it
, to_charpos
,
9124 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9132 else if (op
& MOVE_TO_Y
)
9134 struct it it_backup
;
9136 if (it
->line_wrap
== WORD_WRAP
)
9137 SAVE_IT (it_backup
, *it
, backup_data
);
9139 /* TO_Y specified means stop at TO_X in the line containing
9140 TO_Y---or at TO_CHARPOS if this is reached first. The
9141 problem is that we can't really tell whether the line
9142 contains TO_Y before we have completely scanned it, and
9143 this may skip past TO_X. What we do is to first scan to
9146 If TO_X is not specified, use a TO_X of zero. The reason
9147 is to make the outcome of this function more predictable.
9148 If we didn't use TO_X == 0, we would stop at the end of
9149 the line which is probably not what a caller would expect
9151 skip
= move_it_in_display_line_to
9152 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9153 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9155 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9156 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9158 else if (skip
== MOVE_X_REACHED
)
9160 /* If TO_X was reached, we want to know whether TO_Y is
9161 in the line. We know this is the case if the already
9162 scanned glyphs make the line tall enough. Otherwise,
9163 we must check by scanning the rest of the line. */
9164 line_height
= it
->max_ascent
+ it
->max_descent
;
9165 if (to_y
>= it
->current_y
9166 && to_y
< it
->current_y
+ line_height
)
9171 SAVE_IT (it_backup
, *it
, backup_data
);
9172 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9173 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9175 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9176 line_height
= it
->max_ascent
+ it
->max_descent
;
9177 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9179 if (to_y
>= it
->current_y
9180 && to_y
< it
->current_y
+ line_height
)
9182 /* If TO_Y is in this line and TO_X was reached
9183 above, we scanned too far. We have to restore
9184 IT's settings to the ones before skipping. But
9185 keep the more accurate values of max_ascent and
9186 max_descent we've found while skipping the rest
9187 of the line, for the sake of callers, such as
9188 pos_visible_p, that need to know the line
9190 int max_ascent
= it
->max_ascent
;
9191 int max_descent
= it
->max_descent
;
9193 RESTORE_IT (it
, &it_backup
, backup_data
);
9194 it
->max_ascent
= max_ascent
;
9195 it
->max_descent
= max_descent
;
9201 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9207 /* Check whether TO_Y is in this line. */
9208 line_height
= it
->max_ascent
+ it
->max_descent
;
9209 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9211 if (to_y
>= it
->current_y
9212 && to_y
< it
->current_y
+ line_height
)
9214 if (to_y
> it
->current_y
)
9215 max_current_x
= max (it
->current_x
, max_current_x
);
9217 /* When word-wrap is on, TO_X may lie past the end
9218 of a wrapped line. Then it->current is the
9219 character on the next line, so backtrack to the
9220 space before the wrap point. */
9221 if (skip
== MOVE_LINE_CONTINUED
9222 && it
->line_wrap
== WORD_WRAP
)
9224 int prev_x
= max (it
->current_x
- 1, 0);
9225 RESTORE_IT (it
, &it_backup
, backup_data
);
9226 skip
= move_it_in_display_line_to
9227 (it
, -1, prev_x
, MOVE_TO_X
);
9236 max_current_x
= max (it
->current_x
, max_current_x
);
9240 else if (BUFFERP (it
->object
)
9241 && (it
->method
== GET_FROM_BUFFER
9242 || it
->method
== GET_FROM_STRETCH
)
9243 && IT_CHARPOS (*it
) >= to_charpos
9244 /* Under bidi iteration, a call to set_iterator_to_next
9245 can scan far beyond to_charpos if the initial
9246 portion of the next line needs to be reordered. In
9247 that case, give move_it_in_display_line_to another
9250 && it
->bidi_it
.scan_dir
== -1))
9251 skip
= MOVE_POS_MATCH_OR_ZV
;
9253 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9257 case MOVE_POS_MATCH_OR_ZV
:
9258 max_current_x
= max (it
->current_x
, max_current_x
);
9262 case MOVE_NEWLINE_OR_CR
:
9263 max_current_x
= max (it
->current_x
, max_current_x
);
9264 set_iterator_to_next (it
, true);
9265 it
->continuation_lines_width
= 0;
9268 case MOVE_LINE_TRUNCATED
:
9269 max_current_x
= it
->last_visible_x
;
9270 it
->continuation_lines_width
= 0;
9271 reseat_at_next_visible_line_start (it
, false);
9272 if ((op
& MOVE_TO_POS
) != 0
9273 && IT_CHARPOS (*it
) > to_charpos
)
9280 case MOVE_LINE_CONTINUED
:
9281 max_current_x
= it
->last_visible_x
;
9282 /* For continued lines ending in a tab, some of the glyphs
9283 associated with the tab are displayed on the current
9284 line. Since it->current_x does not include these glyphs,
9285 we use it->last_visible_x instead. */
9288 it
->continuation_lines_width
+= it
->last_visible_x
;
9289 /* When moving by vpos, ensure that the iterator really
9290 advances to the next line (bug#847, bug#969). Fixme:
9291 do we need to do this in other circumstances? */
9292 if (it
->current_x
!= it
->last_visible_x
9293 && (op
& MOVE_TO_VPOS
)
9294 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9296 line_start_x
= it
->current_x
+ it
->pixel_width
9297 - it
->last_visible_x
;
9298 if (FRAME_WINDOW_P (it
->f
))
9300 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9301 struct font
*face_font
= face
->font
;
9303 /* When display_line produces a continued line
9304 that ends in a TAB, it skips a tab stop that
9305 is closer than the font's space character
9306 width (see x_produce_glyphs where it produces
9307 the stretch glyph which represents a TAB).
9308 We need to reproduce the same logic here. */
9309 eassert (face_font
);
9312 if (line_start_x
< face_font
->space_width
)
9314 += it
->tab_width
* face_font
->space_width
;
9317 set_iterator_to_next (it
, false);
9321 it
->continuation_lines_width
+= it
->current_x
;
9328 /* Reset/increment for the next run. */
9329 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9330 it
->current_x
= line_start_x
;
9333 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9335 last_height
= it
->max_ascent
+ it
->max_descent
;
9336 it
->max_ascent
= it
->max_descent
= 0;
9341 /* On text terminals, we may stop at the end of a line in the middle
9342 of a multi-character glyph. If the glyph itself is continued,
9343 i.e. it is actually displayed on the next line, don't treat this
9344 stopping point as valid; move to the next line instead (unless
9345 that brings us offscreen). */
9346 if (!FRAME_WINDOW_P (it
->f
)
9348 && IT_CHARPOS (*it
) == to_charpos
9349 && it
->what
== IT_CHARACTER
9351 && it
->line_wrap
== WINDOW_WRAP
9352 && it
->current_x
== it
->last_visible_x
- 1
9355 && it
->w
->window_end_valid
9356 && it
->vpos
< it
->w
->window_end_vpos
)
9358 it
->continuation_lines_width
+= it
->current_x
;
9359 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9360 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9362 last_height
= it
->max_ascent
+ it
->max_descent
;
9366 bidi_unshelve_cache (backup_data
, true);
9368 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9370 return max_current_x
;
9374 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9376 If DY > 0, move IT backward at least that many pixels. DY = 0
9377 means move IT backward to the preceding line start or BEGV. This
9378 function may move over more than DY pixels if IT->current_y - DY
9379 ends up in the middle of a line; in this case IT->current_y will be
9380 set to the top of the line moved to. */
9383 move_it_vertically_backward (struct it
*it
, int dy
)
9387 void *it2data
= NULL
, *it3data
= NULL
;
9388 ptrdiff_t start_pos
;
9390 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9391 ptrdiff_t pos_limit
;
9396 start_pos
= IT_CHARPOS (*it
);
9398 /* Estimate how many newlines we must move back. */
9399 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9400 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9403 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9405 /* Set the iterator's position that many lines back. But don't go
9406 back more than NLINES full screen lines -- this wins a day with
9407 buffers which have very long lines. */
9408 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9409 back_to_previous_visible_line_start (it
);
9411 /* Reseat the iterator here. When moving backward, we don't want
9412 reseat to skip forward over invisible text, set up the iterator
9413 to deliver from overlay strings at the new position etc. So,
9414 use reseat_1 here. */
9415 reseat_1 (it
, it
->current
.pos
, true);
9417 /* We are now surely at a line start. */
9418 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9419 reordering is in effect. */
9420 it
->continuation_lines_width
= 0;
9422 /* Move forward and see what y-distance we moved. First move to the
9423 start of the next line so that we get its height. We need this
9424 height to be able to tell whether we reached the specified
9426 SAVE_IT (it2
, *it
, it2data
);
9427 it2
.max_ascent
= it2
.max_descent
= 0;
9430 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9431 MOVE_TO_POS
| MOVE_TO_VPOS
);
9433 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9434 /* If we are in a display string which starts at START_POS,
9435 and that display string includes a newline, and we are
9436 right after that newline (i.e. at the beginning of a
9437 display line), exit the loop, because otherwise we will
9438 infloop, since move_it_to will see that it is already at
9439 START_POS and will not move. */
9440 || (it2
.method
== GET_FROM_STRING
9441 && IT_CHARPOS (it2
) == start_pos
9442 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9443 eassert (IT_CHARPOS (*it
) >= BEGV
);
9444 SAVE_IT (it3
, it2
, it3data
);
9446 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9447 eassert (IT_CHARPOS (*it
) >= BEGV
);
9448 /* H is the actual vertical distance from the position in *IT
9449 and the starting position. */
9450 h
= it2
.current_y
- it
->current_y
;
9451 /* NLINES is the distance in number of lines. */
9452 nlines
= it2
.vpos
- it
->vpos
;
9454 /* Correct IT's y and vpos position
9455 so that they are relative to the starting point. */
9461 /* DY == 0 means move to the start of the screen line. The
9462 value of nlines is > 0 if continuation lines were involved,
9463 or if the original IT position was at start of a line. */
9464 RESTORE_IT (it
, it
, it2data
);
9466 move_it_by_lines (it
, nlines
);
9467 /* The above code moves us to some position NLINES down,
9468 usually to its first glyph (leftmost in an L2R line), but
9469 that's not necessarily the start of the line, under bidi
9470 reordering. We want to get to the character position
9471 that is immediately after the newline of the previous
9474 && !it
->continuation_lines_width
9475 && !STRINGP (it
->string
)
9476 && IT_CHARPOS (*it
) > BEGV
9477 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9479 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9482 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9483 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9485 bidi_unshelve_cache (it3data
, true);
9489 /* The y-position we try to reach, relative to *IT.
9490 Note that H has been subtracted in front of the if-statement. */
9491 int target_y
= it
->current_y
+ h
- dy
;
9492 int y0
= it3
.current_y
;
9496 RESTORE_IT (&it3
, &it3
, it3data
);
9497 y1
= line_bottom_y (&it3
);
9498 line_height
= y1
- y0
;
9499 RESTORE_IT (it
, it
, it2data
);
9500 /* If we did not reach target_y, try to move further backward if
9501 we can. If we moved too far backward, try to move forward. */
9502 if (target_y
< it
->current_y
9503 /* This is heuristic. In a window that's 3 lines high, with
9504 a line height of 13 pixels each, recentering with point
9505 on the bottom line will try to move -39/2 = 19 pixels
9506 backward. Try to avoid moving into the first line. */
9507 && (it
->current_y
- target_y
9508 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9509 && IT_CHARPOS (*it
) > BEGV
)
9511 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9512 target_y
- it
->current_y
));
9513 dy
= it
->current_y
- target_y
;
9514 goto move_further_back
;
9516 else if (target_y
>= it
->current_y
+ line_height
9517 && IT_CHARPOS (*it
) < ZV
)
9519 /* Should move forward by at least one line, maybe more.
9521 Note: Calling move_it_by_lines can be expensive on
9522 terminal frames, where compute_motion is used (via
9523 vmotion) to do the job, when there are very long lines
9524 and truncate-lines is nil. That's the reason for
9525 treating terminal frames specially here. */
9527 if (!FRAME_WINDOW_P (it
->f
))
9528 move_it_vertically (it
, target_y
- it
->current_y
);
9533 move_it_by_lines (it
, 1);
9535 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9542 /* Move IT by a specified amount of pixel lines DY. DY negative means
9543 move backwards. DY = 0 means move to start of screen line. At the
9544 end, IT will be on the start of a screen line. */
9547 move_it_vertically (struct it
*it
, int dy
)
9550 move_it_vertically_backward (it
, -dy
);
9553 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9554 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9555 MOVE_TO_POS
| MOVE_TO_Y
);
9556 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9558 /* If buffer ends in ZV without a newline, move to the start of
9559 the line to satisfy the post-condition. */
9560 if (IT_CHARPOS (*it
) == ZV
9562 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9563 move_it_by_lines (it
, 0);
9568 /* Move iterator IT past the end of the text line it is in. */
9571 move_it_past_eol (struct it
*it
)
9573 enum move_it_result rc
;
9575 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9576 if (rc
== MOVE_NEWLINE_OR_CR
)
9577 set_iterator_to_next (it
, false);
9581 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9582 negative means move up. DVPOS == 0 means move to the start of the
9585 Optimization idea: If we would know that IT->f doesn't use
9586 a face with proportional font, we could be faster for
9587 truncate-lines nil. */
9590 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9593 /* The commented-out optimization uses vmotion on terminals. This
9594 gives bad results, because elements like it->what, on which
9595 callers such as pos_visible_p rely, aren't updated. */
9596 /* struct position pos;
9597 if (!FRAME_WINDOW_P (it->f))
9599 struct text_pos textpos;
9601 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9602 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9603 reseat (it, textpos, true);
9604 it->vpos += pos.vpos;
9605 it->current_y += pos.vpos;
9611 /* DVPOS == 0 means move to the start of the screen line. */
9612 move_it_vertically_backward (it
, 0);
9613 /* Let next call to line_bottom_y calculate real line height. */
9618 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9619 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9621 /* Only move to the next buffer position if we ended up in a
9622 string from display property, not in an overlay string
9623 (before-string or after-string). That is because the
9624 latter don't conceal the underlying buffer position, so
9625 we can ask to move the iterator to the exact position we
9626 are interested in. Note that, even if we are already at
9627 IT_CHARPOS (*it), the call below is not a no-op, as it
9628 will detect that we are at the end of the string, pop the
9629 iterator, and compute it->current_x and it->hpos
9631 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9632 -1, -1, -1, MOVE_TO_POS
);
9638 void *it2data
= NULL
;
9639 ptrdiff_t start_charpos
, i
;
9641 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9642 bool hit_pos_limit
= false;
9643 ptrdiff_t pos_limit
;
9645 /* Start at the beginning of the screen line containing IT's
9646 position. This may actually move vertically backwards,
9647 in case of overlays, so adjust dvpos accordingly. */
9649 move_it_vertically_backward (it
, 0);
9652 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9653 screen lines, and reseat the iterator there. */
9654 start_charpos
= IT_CHARPOS (*it
);
9655 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9658 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9660 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9661 back_to_previous_visible_line_start (it
);
9662 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9663 hit_pos_limit
= true;
9664 reseat (it
, it
->current
.pos
, true);
9666 /* Move further back if we end up in a string or an image. */
9667 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9669 /* First try to move to start of display line. */
9671 move_it_vertically_backward (it
, 0);
9673 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9675 /* If start of line is still in string or image,
9676 move further back. */
9677 back_to_previous_visible_line_start (it
);
9678 reseat (it
, it
->current
.pos
, true);
9682 it
->current_x
= it
->hpos
= 0;
9684 /* Above call may have moved too far if continuation lines
9685 are involved. Scan forward and see if it did. */
9686 SAVE_IT (it2
, *it
, it2data
);
9687 it2
.vpos
= it2
.current_y
= 0;
9688 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9689 it
->vpos
-= it2
.vpos
;
9690 it
->current_y
-= it2
.current_y
;
9691 it
->current_x
= it
->hpos
= 0;
9693 /* If we moved too far back, move IT some lines forward. */
9694 if (it2
.vpos
> -dvpos
)
9696 int delta
= it2
.vpos
+ dvpos
;
9698 RESTORE_IT (&it2
, &it2
, it2data
);
9699 SAVE_IT (it2
, *it
, it2data
);
9700 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9701 /* Move back again if we got too far ahead. */
9702 if (IT_CHARPOS (*it
) >= start_charpos
)
9703 RESTORE_IT (it
, &it2
, it2data
);
9705 bidi_unshelve_cache (it2data
, true);
9707 else if (hit_pos_limit
&& pos_limit
> BEGV
9708 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9710 /* If we hit the limit, but still didn't make it far enough
9711 back, that means there's a display string with a newline
9712 covering a large chunk of text, and that caused
9713 back_to_previous_visible_line_start try to go too far.
9714 Punish those who commit such atrocities by going back
9715 until we've reached DVPOS, after lifting the limit, which
9716 could make it slow for very long lines. "If it hurts,
9719 RESTORE_IT (it
, it
, it2data
);
9720 for (i
= -dvpos
; i
> 0; --i
)
9722 back_to_previous_visible_line_start (it
);
9725 reseat_1 (it
, it
->current
.pos
, true);
9728 RESTORE_IT (it
, it
, it2data
);
9732 /* Return true if IT points into the middle of a display vector. */
9735 in_display_vector_p (struct it
*it
)
9737 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9738 && it
->current
.dpvec_index
> 0
9739 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9742 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9743 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9744 WINDOW must be a live window and defaults to the selected one. The
9745 return value is a cons of the maximum pixel-width of any text line and
9746 the maximum pixel-height of all text lines.
9748 The optional argument FROM, if non-nil, specifies the first text
9749 position and defaults to the minimum accessible position of the buffer.
9750 If FROM is t, use the minimum accessible position that is not a newline
9751 character. TO, if non-nil, specifies the last text position and
9752 defaults to the maximum accessible position of the buffer. If TO is t,
9753 use the maximum accessible position that is not a newline character.
9755 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9756 width that can be returned. X-LIMIT nil or omitted, means to use the
9757 pixel-width of WINDOW's body; use this if you do not intend to change
9758 the width of WINDOW. Use the maximum width WINDOW may assume if you
9759 intend to change WINDOW's width. In any case, text whose x-coordinate
9760 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9761 can take some time, it's always a good idea to make this argument as
9762 small as possible; in particular, if the buffer contains long lines that
9763 shall be truncated anyway.
9765 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9766 height that can be returned. Text lines whose y-coordinate is beyond
9767 Y-LIMIT are ignored. Since calculating the text height of a large
9768 buffer can take some time, it makes sense to specify this argument if
9769 the size of the buffer is unknown.
9771 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9772 include the height of the mode- or header-line of WINDOW in the return
9773 value. If it is either the symbol `mode-line' or `header-line', include
9774 only the height of that line, if present, in the return value. If t,
9775 include the height of both, if present, in the return value. */)
9776 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9777 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9779 struct window
*w
= decode_live_window (window
);
9780 Lisp_Object buffer
= w
->contents
;
9783 struct buffer
*old_b
= NULL
;
9784 ptrdiff_t start
, end
, pos
;
9785 struct text_pos startp
;
9786 void *itdata
= NULL
;
9787 int c
, max_y
= -1, x
= 0, y
= 0;
9789 CHECK_BUFFER (buffer
);
9790 b
= XBUFFER (buffer
);
9792 if (b
!= current_buffer
)
9794 old_b
= current_buffer
;
9795 set_buffer_internal (b
);
9800 else if (EQ (from
, Qt
))
9803 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9804 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9806 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9811 CHECK_NUMBER_COERCE_MARKER (from
);
9812 start
= min (max (XINT (from
), BEGV
), ZV
);
9817 else if (EQ (to
, Qt
))
9820 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9821 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9823 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9828 CHECK_NUMBER_COERCE_MARKER (to
);
9829 end
= max (start
, min (XINT (to
), ZV
));
9832 if (!NILP (y_limit
))
9834 CHECK_NUMBER (y_limit
);
9835 max_y
= min (XINT (y_limit
), INT_MAX
);
9838 itdata
= bidi_shelve_cache ();
9839 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9840 start_display (&it
, w
, startp
);
9843 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9846 CHECK_NUMBER (x_limit
);
9847 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9848 /* Actually, we never want move_it_to stop at to_x. But to make
9849 sure that move_it_in_display_line_to always moves far enough,
9850 we set it to INT_MAX and specify MOVE_TO_X. */
9851 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9852 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9855 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9857 if (!EQ (mode_and_header_line
, Qheader_line
)
9858 && !EQ (mode_and_header_line
, Qt
))
9859 /* Do not count the header-line which was counted automatically by
9861 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9863 if (EQ (mode_and_header_line
, Qmode_line
)
9864 || EQ (mode_and_header_line
, Qt
))
9865 /* Do count the mode-line which is not included automatically by
9867 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9869 bidi_unshelve_cache (itdata
, false);
9872 set_buffer_internal (old_b
);
9874 return Fcons (make_number (x
), make_number (y
));
9877 /***********************************************************************
9879 ***********************************************************************/
9881 /* Return the number of arguments the format string FORMAT needs. */
9884 format_nargs (char const *format
)
9886 ptrdiff_t nargs
= 0;
9887 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9895 /* Add a message with format string FORMAT and formatted arguments
9899 add_to_log (const char *format
, ...)
9902 va_start (ap
, format
);
9903 vadd_to_log (format
, ap
);
9908 vadd_to_log (char const *format
, va_list ap
)
9910 ptrdiff_t form_nargs
= format_nargs (format
);
9911 ptrdiff_t nargs
= 1 + form_nargs
;
9912 Lisp_Object args
[10];
9913 eassert (nargs
<= ARRAYELTS (args
));
9914 AUTO_STRING (args0
, format
);
9916 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9917 args
[i
] = va_arg (ap
, Lisp_Object
);
9918 Lisp_Object msg
= Qnil
;
9919 msg
= Fformat_message (nargs
, args
);
9921 ptrdiff_t len
= SBYTES (msg
) + 1;
9923 char *buffer
= SAFE_ALLOCA (len
);
9924 memcpy (buffer
, SDATA (msg
), len
);
9926 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9931 /* Output a newline in the *Messages* buffer if "needs" one. */
9934 message_log_maybe_newline (void)
9936 if (message_log_need_newline
)
9937 message_dolog ("", 0, true, false);
9941 /* Add a string M of length NBYTES to the message log, optionally
9942 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9943 true, means interpret the contents of M as multibyte. This
9944 function calls low-level routines in order to bypass text property
9945 hooks, etc. which might not be safe to run.
9947 This may GC (insert may run before/after change hooks),
9948 so the buffer M must NOT point to a Lisp string. */
9951 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9953 const unsigned char *msg
= (const unsigned char *) m
;
9955 if (!NILP (Vmemory_full
))
9958 if (!NILP (Vmessage_log_max
))
9960 struct buffer
*oldbuf
;
9961 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9962 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9963 ptrdiff_t point_at_end
= 0;
9964 ptrdiff_t zv_at_end
= 0;
9965 Lisp_Object old_deactivate_mark
;
9967 old_deactivate_mark
= Vdeactivate_mark
;
9968 oldbuf
= current_buffer
;
9970 /* Ensure the Messages buffer exists, and switch to it.
9971 If we created it, set the major-mode. */
9972 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9973 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9975 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9976 call0 (intern ("messages-buffer-mode"));
9978 bset_undo_list (current_buffer
, Qt
);
9979 bset_cache_long_scans (current_buffer
, Qnil
);
9981 oldpoint
= message_dolog_marker1
;
9982 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9983 oldbegv
= message_dolog_marker2
;
9984 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9985 oldzv
= message_dolog_marker3
;
9986 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9994 BEGV_BYTE
= BEG_BYTE
;
9997 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9999 /* Insert the string--maybe converting multibyte to single byte
10000 or vice versa, so that all the text fits the buffer. */
10002 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10008 /* Convert a multibyte string to single-byte
10009 for the *Message* buffer. */
10010 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10012 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10013 work
[0] = CHAR_TO_BYTE8 (c
);
10014 insert_1_both (work
, 1, 1, true, false, false);
10017 else if (! multibyte
10018 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10022 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10023 /* Convert a single-byte string to multibyte
10024 for the *Message* buffer. */
10025 for (i
= 0; i
< nbytes
; i
++)
10028 MAKE_CHAR_MULTIBYTE (c
);
10029 char_bytes
= CHAR_STRING (c
, str
);
10030 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10034 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10035 true, false, false);
10039 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10042 insert_1_both ("\n", 1, 1, true, false, false);
10044 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10046 this_bol_byte
= PT_BYTE
;
10048 /* See if this line duplicates the previous one.
10049 If so, combine duplicates. */
10050 if (this_bol
> BEG
)
10052 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10054 prev_bol_byte
= PT_BYTE
;
10056 dups
= message_log_check_duplicate (prev_bol_byte
,
10060 del_range_both (prev_bol
, prev_bol_byte
,
10061 this_bol
, this_bol_byte
, false);
10064 char dupstr
[sizeof " [ times]"
10065 + INT_STRLEN_BOUND (printmax_t
)];
10067 /* If you change this format, don't forget to also
10068 change message_log_check_duplicate. */
10069 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10070 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10071 insert_1_both (dupstr
, duplen
, duplen
,
10072 true, false, true);
10077 /* If we have more than the desired maximum number of lines
10078 in the *Messages* buffer now, delete the oldest ones.
10079 This is safe because we don't have undo in this buffer. */
10081 if (NATNUMP (Vmessage_log_max
))
10083 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10084 -XFASTINT (Vmessage_log_max
) - 1, false);
10085 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10088 BEGV
= marker_position (oldbegv
);
10089 BEGV_BYTE
= marker_byte_position (oldbegv
);
10098 ZV
= marker_position (oldzv
);
10099 ZV_BYTE
= marker_byte_position (oldzv
);
10103 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10105 /* We can't do Fgoto_char (oldpoint) because it will run some
10107 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10108 marker_byte_position (oldpoint
));
10110 unchain_marker (XMARKER (oldpoint
));
10111 unchain_marker (XMARKER (oldbegv
));
10112 unchain_marker (XMARKER (oldzv
));
10114 /* We called insert_1_both above with its 5th argument (PREPARE)
10115 false, which prevents insert_1_both from calling
10116 prepare_to_modify_buffer, which in turns prevents us from
10117 incrementing windows_or_buffers_changed even if *Messages* is
10118 shown in some window. So we must manually set
10119 windows_or_buffers_changed here to make up for that. */
10120 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10121 bset_redisplay (current_buffer
);
10123 set_buffer_internal (oldbuf
);
10125 message_log_need_newline
= !nlflag
;
10126 Vdeactivate_mark
= old_deactivate_mark
;
10131 /* We are at the end of the buffer after just having inserted a newline.
10132 (Note: We depend on the fact we won't be crossing the gap.)
10133 Check to see if the most recent message looks a lot like the previous one.
10134 Return 0 if different, 1 if the new one should just replace it, or a
10135 value N > 1 if we should also append " [N times]". */
10138 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10141 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10142 bool seen_dots
= false;
10143 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10144 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10146 for (i
= 0; i
< len
; i
++)
10148 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10150 if (p1
[i
] != p2
[i
])
10156 if (*p1
++ == ' ' && *p1
++ == '[')
10159 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10160 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10167 /* Display an echo area message M with a specified length of NBYTES
10168 bytes. The string may include null characters. If M is not a
10169 string, clear out any existing message, and let the mini-buffer
10172 This function cancels echoing. */
10175 message3 (Lisp_Object m
)
10177 clear_message (true, true);
10180 /* First flush out any partial line written with print. */
10181 message_log_maybe_newline ();
10184 ptrdiff_t nbytes
= SBYTES (m
);
10185 bool multibyte
= STRING_MULTIBYTE (m
);
10188 SAFE_ALLOCA_STRING (buffer
, m
);
10189 message_dolog (buffer
, nbytes
, true, multibyte
);
10192 if (! inhibit_message
)
10193 message3_nolog (m
);
10196 /* Log the message M to stderr. Log an empty line if M is not a string. */
10199 message_to_stderr (Lisp_Object m
)
10201 if (noninteractive_need_newline
)
10203 noninteractive_need_newline
= false;
10204 fputc ('\n', stderr
);
10208 Lisp_Object s
= ENCODE_SYSTEM (m
);
10209 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10211 if (!cursor_in_echo_area
)
10212 fputc ('\n', stderr
);
10216 /* The non-logging version of message3.
10217 This does not cancel echoing, because it is used for echoing.
10218 Perhaps we need to make a separate function for echoing
10219 and make this cancel echoing. */
10222 message3_nolog (Lisp_Object m
)
10224 struct frame
*sf
= SELECTED_FRAME ();
10226 if (FRAME_INITIAL_P (sf
))
10227 message_to_stderr (m
);
10228 /* Error messages get reported properly by cmd_error, so this must be just an
10229 informative message; if the frame hasn't really been initialized yet, just
10231 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10233 /* Get the frame containing the mini-buffer
10234 that the selected frame is using. */
10235 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10236 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10237 struct frame
*f
= XFRAME (frame
);
10239 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10240 Fmake_frame_visible (frame
);
10242 if (STRINGP (m
) && SCHARS (m
) > 0)
10245 if (minibuffer_auto_raise
)
10246 Fraise_frame (frame
);
10247 /* Assume we are not echoing.
10248 (If we are, echo_now will override this.) */
10249 echo_message_buffer
= Qnil
;
10252 clear_message (true, true);
10254 do_pending_window_change (false);
10255 echo_area_display (true);
10256 do_pending_window_change (false);
10257 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10258 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10263 /* Display a null-terminated echo area message M. If M is 0, clear
10264 out any existing message, and let the mini-buffer text show through.
10266 The buffer M must continue to exist until after the echo area gets
10267 cleared or some other message gets displayed there. Do not pass
10268 text that is stored in a Lisp string. Do not pass text in a buffer
10269 that was alloca'd. */
10272 message1 (const char *m
)
10274 message3 (m
? build_unibyte_string (m
) : Qnil
);
10278 /* The non-logging counterpart of message1. */
10281 message1_nolog (const char *m
)
10283 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10286 /* Display a message M which contains a single %s
10287 which gets replaced with STRING. */
10290 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10292 CHECK_STRING (string
);
10295 if (noninteractive
)
10296 need_message
= !!m
;
10297 else if (!INTERACTIVE
)
10298 need_message
= false;
10301 /* The frame whose minibuffer we're going to display the message on.
10302 It may be larger than the selected frame, so we need
10303 to use its buffer, not the selected frame's buffer. */
10304 Lisp_Object mini_window
;
10305 struct frame
*f
, *sf
= SELECTED_FRAME ();
10307 /* Get the frame containing the minibuffer
10308 that the selected frame is using. */
10309 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10310 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10312 /* Error messages get reported properly by cmd_error, so this must be
10313 just an informative message; if the frame hasn't really been
10314 initialized yet, just toss it. */
10315 need_message
= f
->glyphs_initialized_p
;
10320 AUTO_STRING (fmt
, m
);
10321 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10323 if (noninteractive
)
10324 message_to_stderr (msg
);
10330 message3_nolog (msg
);
10332 /* Print should start at the beginning of the message
10333 buffer next time. */
10334 message_buf_print
= false;
10340 /* Dump an informative message to the minibuf. If M is 0, clear out
10341 any existing message, and let the mini-buffer text show through.
10343 The message must be safe ASCII and the format must not contain ` or
10344 '. If your message and format do not fit into this category,
10345 convert your arguments to Lisp objects and use Fmessage instead. */
10347 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10348 vmessage (const char *m
, va_list ap
)
10350 if (noninteractive
)
10354 if (noninteractive_need_newline
)
10355 putc ('\n', stderr
);
10356 noninteractive_need_newline
= false;
10357 vfprintf (stderr
, m
, ap
);
10358 if (!cursor_in_echo_area
)
10359 fprintf (stderr
, "\n");
10363 else if (INTERACTIVE
)
10365 /* The frame whose mini-buffer we're going to display the message
10366 on. It may be larger than the selected frame, so we need to
10367 use its buffer, not the selected frame's buffer. */
10368 Lisp_Object mini_window
;
10369 struct frame
*f
, *sf
= SELECTED_FRAME ();
10371 /* Get the frame containing the mini-buffer
10372 that the selected frame is using. */
10373 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10374 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10376 /* Error messages get reported properly by cmd_error, so this must be
10377 just an informative message; if the frame hasn't really been
10378 initialized yet, just toss it. */
10379 if (f
->glyphs_initialized_p
)
10384 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10386 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10388 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10390 message3 (make_string (message_buf
, len
));
10396 /* Print should start at the beginning of the message
10397 buffer next time. */
10398 message_buf_print
= false;
10404 message (const char *m
, ...)
10413 /* Display the current message in the current mini-buffer. This is
10414 only called from error handlers in process.c, and is not time
10418 update_echo_area (void)
10420 if (!NILP (echo_area_buffer
[0]))
10422 Lisp_Object string
;
10423 string
= Fcurrent_message ();
10429 /* Make sure echo area buffers in `echo_buffers' are live.
10430 If they aren't, make new ones. */
10433 ensure_echo_area_buffers (void)
10437 for (i
= 0; i
< 2; ++i
)
10438 if (!BUFFERP (echo_buffer
[i
])
10439 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10442 Lisp_Object old_buffer
;
10445 old_buffer
= echo_buffer
[i
];
10446 echo_buffer
[i
] = Fget_buffer_create
10447 (make_formatted_string (name
, " *Echo Area %d*", i
));
10448 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10449 /* to force word wrap in echo area -
10450 it was decided to postpone this*/
10451 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10453 for (j
= 0; j
< 2; ++j
)
10454 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10455 echo_area_buffer
[j
] = echo_buffer
[i
];
10460 /* Call FN with args A1..A2 with either the current or last displayed
10461 echo_area_buffer as current buffer.
10463 WHICH zero means use the current message buffer
10464 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10465 from echo_buffer[] and clear it.
10467 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10468 suitable buffer from echo_buffer[] and clear it.
10470 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10471 that the current message becomes the last displayed one, make
10472 choose a suitable buffer for echo_area_buffer[0], and clear it.
10474 Value is what FN returns. */
10477 with_echo_area_buffer (struct window
*w
, int which
,
10478 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10479 ptrdiff_t a1
, Lisp_Object a2
)
10481 Lisp_Object buffer
;
10482 bool this_one
, the_other
, clear_buffer_p
, rc
;
10483 ptrdiff_t count
= SPECPDL_INDEX ();
10485 /* If buffers aren't live, make new ones. */
10486 ensure_echo_area_buffers ();
10488 clear_buffer_p
= false;
10491 this_one
= false, the_other
= true;
10492 else if (which
> 0)
10493 this_one
= true, the_other
= false;
10496 this_one
= false, the_other
= true;
10497 clear_buffer_p
= true;
10499 /* We need a fresh one in case the current echo buffer equals
10500 the one containing the last displayed echo area message. */
10501 if (!NILP (echo_area_buffer
[this_one
])
10502 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10503 echo_area_buffer
[this_one
] = Qnil
;
10506 /* Choose a suitable buffer from echo_buffer[] is we don't
10508 if (NILP (echo_area_buffer
[this_one
]))
10510 echo_area_buffer
[this_one
]
10511 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10512 ? echo_buffer
[the_other
]
10513 : echo_buffer
[this_one
]);
10514 clear_buffer_p
= true;
10517 buffer
= echo_area_buffer
[this_one
];
10519 /* Don't get confused by reusing the buffer used for echoing
10520 for a different purpose. */
10521 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10524 record_unwind_protect (unwind_with_echo_area_buffer
,
10525 with_echo_area_buffer_unwind_data (w
));
10527 /* Make the echo area buffer current. Note that for display
10528 purposes, it is not necessary that the displayed window's buffer
10529 == current_buffer, except for text property lookup. So, let's
10530 only set that buffer temporarily here without doing a full
10531 Fset_window_buffer. We must also change w->pointm, though,
10532 because otherwise an assertions in unshow_buffer fails, and Emacs
10534 set_buffer_internal_1 (XBUFFER (buffer
));
10537 wset_buffer (w
, buffer
);
10538 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10539 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10542 bset_undo_list (current_buffer
, Qt
);
10543 bset_read_only (current_buffer
, Qnil
);
10544 specbind (Qinhibit_read_only
, Qt
);
10545 specbind (Qinhibit_modification_hooks
, Qt
);
10547 if (clear_buffer_p
&& Z
> BEG
)
10548 del_range (BEG
, Z
);
10550 eassert (BEGV
>= BEG
);
10551 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10555 eassert (BEGV
>= BEG
);
10556 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10558 unbind_to (count
, Qnil
);
10563 /* Save state that should be preserved around the call to the function
10564 FN called in with_echo_area_buffer. */
10567 with_echo_area_buffer_unwind_data (struct window
*w
)
10570 Lisp_Object vector
, tmp
;
10572 /* Reduce consing by keeping one vector in
10573 Vwith_echo_area_save_vector. */
10574 vector
= Vwith_echo_area_save_vector
;
10575 Vwith_echo_area_save_vector
= Qnil
;
10578 vector
= Fmake_vector (make_number (11), Qnil
);
10580 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10581 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10582 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10586 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10587 ASET (vector
, i
, w
->contents
); ++i
;
10588 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10589 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10590 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10591 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10592 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10593 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10598 for (; i
< end
; ++i
)
10599 ASET (vector
, i
, Qnil
);
10602 eassert (i
== ASIZE (vector
));
10607 /* Restore global state from VECTOR which was created by
10608 with_echo_area_buffer_unwind_data. */
10611 unwind_with_echo_area_buffer (Lisp_Object vector
)
10613 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10614 Vdeactivate_mark
= AREF (vector
, 1);
10615 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10617 if (WINDOWP (AREF (vector
, 3)))
10620 Lisp_Object buffer
;
10622 w
= XWINDOW (AREF (vector
, 3));
10623 buffer
= AREF (vector
, 4);
10625 wset_buffer (w
, buffer
);
10626 set_marker_both (w
->pointm
, buffer
,
10627 XFASTINT (AREF (vector
, 5)),
10628 XFASTINT (AREF (vector
, 6)));
10629 set_marker_both (w
->old_pointm
, buffer
,
10630 XFASTINT (AREF (vector
, 7)),
10631 XFASTINT (AREF (vector
, 8)));
10632 set_marker_both (w
->start
, buffer
,
10633 XFASTINT (AREF (vector
, 9)),
10634 XFASTINT (AREF (vector
, 10)));
10637 Vwith_echo_area_save_vector
= vector
;
10641 /* Set up the echo area for use by print functions. MULTIBYTE_P
10642 means we will print multibyte. */
10645 setup_echo_area_for_printing (bool multibyte_p
)
10647 /* If we can't find an echo area any more, exit. */
10648 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10649 Fkill_emacs (Qnil
);
10651 ensure_echo_area_buffers ();
10653 if (!message_buf_print
)
10655 /* A message has been output since the last time we printed.
10656 Choose a fresh echo area buffer. */
10657 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10658 echo_area_buffer
[0] = echo_buffer
[1];
10660 echo_area_buffer
[0] = echo_buffer
[0];
10662 /* Switch to that buffer and clear it. */
10663 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10664 bset_truncate_lines (current_buffer
, Qnil
);
10668 ptrdiff_t count
= SPECPDL_INDEX ();
10669 specbind (Qinhibit_read_only
, Qt
);
10670 /* Note that undo recording is always disabled. */
10671 del_range (BEG
, Z
);
10672 unbind_to (count
, Qnil
);
10674 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10676 /* Set up the buffer for the multibyteness we need. */
10678 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10679 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10681 /* Raise the frame containing the echo area. */
10682 if (minibuffer_auto_raise
)
10684 struct frame
*sf
= SELECTED_FRAME ();
10685 Lisp_Object mini_window
;
10686 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10687 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10690 message_log_maybe_newline ();
10691 message_buf_print
= true;
10695 if (NILP (echo_area_buffer
[0]))
10697 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10698 echo_area_buffer
[0] = echo_buffer
[1];
10700 echo_area_buffer
[0] = echo_buffer
[0];
10703 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10705 /* Someone switched buffers between print requests. */
10706 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10707 bset_truncate_lines (current_buffer
, Qnil
);
10713 /* Display an echo area message in window W. Value is true if W's
10714 height is changed. If display_last_displayed_message_p,
10715 display the message that was last displayed, otherwise
10716 display the current message. */
10719 display_echo_area (struct window
*w
)
10721 bool no_message_p
, window_height_changed_p
;
10723 /* Temporarily disable garbage collections while displaying the echo
10724 area. This is done because a GC can print a message itself.
10725 That message would modify the echo area buffer's contents while a
10726 redisplay of the buffer is going on, and seriously confuse
10728 ptrdiff_t count
= inhibit_garbage_collection ();
10730 /* If there is no message, we must call display_echo_area_1
10731 nevertheless because it resizes the window. But we will have to
10732 reset the echo_area_buffer in question to nil at the end because
10733 with_echo_area_buffer will sets it to an empty buffer. */
10734 bool i
= display_last_displayed_message_p
;
10735 no_message_p
= NILP (echo_area_buffer
[i
]);
10737 window_height_changed_p
10738 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10739 display_echo_area_1
,
10740 (intptr_t) w
, Qnil
);
10743 echo_area_buffer
[i
] = Qnil
;
10745 unbind_to (count
, Qnil
);
10746 return window_height_changed_p
;
10750 /* Helper for display_echo_area. Display the current buffer which
10751 contains the current echo area message in window W, a mini-window,
10752 a pointer to which is passed in A1. A2..A4 are currently not used.
10753 Change the height of W so that all of the message is displayed.
10754 Value is true if height of W was changed. */
10757 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10760 struct window
*w
= (struct window
*) i1
;
10761 Lisp_Object window
;
10762 struct text_pos start
;
10764 /* We are about to enter redisplay without going through
10765 redisplay_internal, so we need to forget these faces by hand
10767 forget_escape_and_glyphless_faces ();
10769 /* Do this before displaying, so that we have a large enough glyph
10770 matrix for the display. If we can't get enough space for the
10771 whole text, display the last N lines. That works by setting w->start. */
10772 bool window_height_changed_p
= resize_mini_window (w
, false);
10774 /* Use the starting position chosen by resize_mini_window. */
10775 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10778 clear_glyph_matrix (w
->desired_matrix
);
10779 XSETWINDOW (window
, w
);
10780 try_window (window
, start
, 0);
10782 return window_height_changed_p
;
10786 /* Resize the echo area window to exactly the size needed for the
10787 currently displayed message, if there is one. If a mini-buffer
10788 is active, don't shrink it. */
10791 resize_echo_area_exactly (void)
10793 if (BUFFERP (echo_area_buffer
[0])
10794 && WINDOWP (echo_area_window
))
10796 struct window
*w
= XWINDOW (echo_area_window
);
10797 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10798 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10799 (intptr_t) w
, resize_exactly
);
10802 windows_or_buffers_changed
= 42;
10803 update_mode_lines
= 30;
10804 redisplay_internal ();
10810 /* Callback function for with_echo_area_buffer, when used from
10811 resize_echo_area_exactly. A1 contains a pointer to the window to
10812 resize, EXACTLY non-nil means resize the mini-window exactly to the
10813 size of the text displayed. A3 and A4 are not used. Value is what
10814 resize_mini_window returns. */
10817 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10820 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10824 /* Resize mini-window W to fit the size of its contents. EXACT_P
10825 means size the window exactly to the size needed. Otherwise, it's
10826 only enlarged until W's buffer is empty.
10828 Set W->start to the right place to begin display. If the whole
10829 contents fit, start at the beginning. Otherwise, start so as
10830 to make the end of the contents appear. This is particularly
10831 important for y-or-n-p, but seems desirable generally.
10833 Value is true if the window height has been changed. */
10836 resize_mini_window (struct window
*w
, bool exact_p
)
10838 struct frame
*f
= XFRAME (w
->frame
);
10839 bool window_height_changed_p
= false;
10841 eassert (MINI_WINDOW_P (w
));
10843 /* By default, start display at the beginning. */
10844 set_marker_both (w
->start
, w
->contents
,
10845 BUF_BEGV (XBUFFER (w
->contents
)),
10846 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10848 /* Don't resize windows while redisplaying a window; it would
10849 confuse redisplay functions when the size of the window they are
10850 displaying changes from under them. Such a resizing can happen,
10851 for instance, when which-func prints a long message while
10852 we are running fontification-functions. We're running these
10853 functions with safe_call which binds inhibit-redisplay to t. */
10854 if (!NILP (Vinhibit_redisplay
))
10857 /* Nil means don't try to resize. */
10858 if (NILP (Vresize_mini_windows
)
10859 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10862 if (!FRAME_MINIBUF_ONLY_P (f
))
10865 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10866 + WINDOW_PIXEL_HEIGHT (w
));
10867 int unit
= FRAME_LINE_HEIGHT (f
);
10868 int height
, max_height
;
10869 struct text_pos start
;
10870 struct buffer
*old_current_buffer
= NULL
;
10872 if (current_buffer
!= XBUFFER (w
->contents
))
10874 old_current_buffer
= current_buffer
;
10875 set_buffer_internal (XBUFFER (w
->contents
));
10878 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10880 /* Compute the max. number of lines specified by the user. */
10881 if (FLOATP (Vmax_mini_window_height
))
10882 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10883 else if (INTEGERP (Vmax_mini_window_height
))
10884 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10886 max_height
= total_height
/ 4;
10888 /* Correct that max. height if it's bogus. */
10889 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10891 /* Find out the height of the text in the window. */
10892 if (it
.line_wrap
== TRUNCATE
)
10897 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10898 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10899 height
= it
.current_y
+ last_height
;
10901 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10902 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10905 /* Compute a suitable window start. */
10906 if (height
> max_height
)
10908 height
= (max_height
/ unit
) * unit
;
10909 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10910 move_it_vertically_backward (&it
, height
- unit
);
10911 start
= it
.current
.pos
;
10914 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10915 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10917 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10919 /* Let it grow only, until we display an empty message, in which
10920 case the window shrinks again. */
10921 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10923 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10925 FRAME_WINDOWS_FROZEN (f
) = true;
10926 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10927 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10929 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10930 && (exact_p
|| BEGV
== ZV
))
10932 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10934 FRAME_WINDOWS_FROZEN (f
) = false;
10935 shrink_mini_window (w
, true);
10936 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10941 /* Always resize to exact size needed. */
10942 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10944 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10946 FRAME_WINDOWS_FROZEN (f
) = true;
10947 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10948 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10950 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10952 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10954 FRAME_WINDOWS_FROZEN (f
) = false;
10955 shrink_mini_window (w
, true);
10959 FRAME_WINDOWS_FROZEN (f
) = true;
10960 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10963 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10967 if (old_current_buffer
)
10968 set_buffer_internal (old_current_buffer
);
10971 return window_height_changed_p
;
10975 /* Value is the current message, a string, or nil if there is no
10976 current message. */
10979 current_message (void)
10983 if (!BUFFERP (echo_area_buffer
[0]))
10987 with_echo_area_buffer (0, 0, current_message_1
,
10988 (intptr_t) &msg
, Qnil
);
10990 echo_area_buffer
[0] = Qnil
;
10998 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11001 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11004 *msg
= make_buffer_string (BEG
, Z
, true);
11011 /* Push the current message on Vmessage_stack for later restoration
11012 by restore_message. Value is true if the current message isn't
11013 empty. This is a relatively infrequent operation, so it's not
11014 worth optimizing. */
11017 push_message (void)
11019 Lisp_Object msg
= current_message ();
11020 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11021 return STRINGP (msg
);
11025 /* Restore message display from the top of Vmessage_stack. */
11028 restore_message (void)
11030 eassert (CONSP (Vmessage_stack
));
11031 message3_nolog (XCAR (Vmessage_stack
));
11035 /* Handler for unwind-protect calling pop_message. */
11038 pop_message_unwind (void)
11040 /* Pop the top-most entry off Vmessage_stack. */
11041 eassert (CONSP (Vmessage_stack
));
11042 Vmessage_stack
= XCDR (Vmessage_stack
);
11046 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11047 exits. If the stack is not empty, we have a missing pop_message
11051 check_message_stack (void)
11053 if (!NILP (Vmessage_stack
))
11058 /* Truncate to NCHARS what will be displayed in the echo area the next
11059 time we display it---but don't redisplay it now. */
11062 truncate_echo_area (ptrdiff_t nchars
)
11065 echo_area_buffer
[0] = Qnil
;
11066 else if (!noninteractive
11068 && !NILP (echo_area_buffer
[0]))
11070 struct frame
*sf
= SELECTED_FRAME ();
11071 /* Error messages get reported properly by cmd_error, so this must be
11072 just an informative message; if the frame hasn't really been
11073 initialized yet, just toss it. */
11074 if (sf
->glyphs_initialized_p
)
11075 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11080 /* Helper function for truncate_echo_area. Truncate the current
11081 message to at most NCHARS characters. */
11084 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11086 if (BEG
+ nchars
< Z
)
11087 del_range (BEG
+ nchars
, Z
);
11089 echo_area_buffer
[0] = Qnil
;
11093 /* Set the current message to STRING. */
11096 set_message (Lisp_Object string
)
11098 eassert (STRINGP (string
));
11100 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11102 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11103 message_buf_print
= false;
11104 help_echo_showing_p
= false;
11106 if (STRINGP (Vdebug_on_message
)
11107 && STRINGP (string
)
11108 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11109 call_debugger (list2 (Qerror
, string
));
11113 /* Helper function for set_message. First argument is ignored and second
11114 argument has the same meaning as for set_message.
11115 This function is called with the echo area buffer being current. */
11118 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11120 eassert (STRINGP (string
));
11122 /* Change multibyteness of the echo buffer appropriately. */
11123 if (message_enable_multibyte
11124 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11125 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11127 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11128 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11129 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11131 /* Insert new message at BEG. */
11132 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11134 /* This function takes care of single/multibyte conversion.
11135 We just have to ensure that the echo area buffer has the right
11136 setting of enable_multibyte_characters. */
11137 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11143 /* Clear messages. CURRENT_P means clear the current message.
11144 LAST_DISPLAYED_P means clear the message last displayed. */
11147 clear_message (bool current_p
, bool last_displayed_p
)
11151 echo_area_buffer
[0] = Qnil
;
11152 message_cleared_p
= true;
11155 if (last_displayed_p
)
11156 echo_area_buffer
[1] = Qnil
;
11158 message_buf_print
= false;
11161 /* Clear garbaged frames.
11163 This function is used where the old redisplay called
11164 redraw_garbaged_frames which in turn called redraw_frame which in
11165 turn called clear_frame. The call to clear_frame was a source of
11166 flickering. I believe a clear_frame is not necessary. It should
11167 suffice in the new redisplay to invalidate all current matrices,
11168 and ensure a complete redisplay of all windows. */
11171 clear_garbaged_frames (void)
11173 if (frame_garbaged
)
11175 Lisp_Object tail
, frame
;
11177 FOR_EACH_FRAME (tail
, frame
)
11179 struct frame
*f
= XFRAME (frame
);
11181 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11186 clear_current_matrices (f
);
11187 fset_redisplay (f
);
11188 f
->garbaged
= false;
11189 f
->resized_p
= false;
11193 frame_garbaged
= false;
11198 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11202 echo_area_display (bool update_frame_p
)
11204 Lisp_Object mini_window
;
11207 bool window_height_changed_p
= false;
11208 struct frame
*sf
= SELECTED_FRAME ();
11210 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11211 w
= XWINDOW (mini_window
);
11212 f
= XFRAME (WINDOW_FRAME (w
));
11214 /* Don't display if frame is invisible or not yet initialized. */
11215 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11218 #ifdef HAVE_WINDOW_SYSTEM
11219 /* When Emacs starts, selected_frame may be the initial terminal
11220 frame. If we let this through, a message would be displayed on
11222 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11224 #endif /* HAVE_WINDOW_SYSTEM */
11226 /* Redraw garbaged frames. */
11227 clear_garbaged_frames ();
11229 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11231 echo_area_window
= mini_window
;
11232 window_height_changed_p
= display_echo_area (w
);
11233 w
->must_be_updated_p
= true;
11235 /* Update the display, unless called from redisplay_internal.
11236 Also don't update the screen during redisplay itself. The
11237 update will happen at the end of redisplay, and an update
11238 here could cause confusion. */
11239 if (update_frame_p
&& !redisplaying_p
)
11243 /* If the display update has been interrupted by pending
11244 input, update mode lines in the frame. Due to the
11245 pending input, it might have been that redisplay hasn't
11246 been called, so that mode lines above the echo area are
11247 garbaged. This looks odd, so we prevent it here. */
11248 if (!display_completed
)
11249 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11251 if (window_height_changed_p
11252 /* Don't do this if Emacs is shutting down. Redisplay
11253 needs to run hooks. */
11254 && !NILP (Vrun_hooks
))
11256 /* Must update other windows. Likewise as in other
11257 cases, don't let this update be interrupted by
11259 ptrdiff_t count
= SPECPDL_INDEX ();
11260 specbind (Qredisplay_dont_pause
, Qt
);
11261 fset_redisplay (f
);
11262 redisplay_internal ();
11263 unbind_to (count
, Qnil
);
11265 else if (FRAME_WINDOW_P (f
) && n
== 0)
11267 /* Window configuration is the same as before.
11268 Can do with a display update of the echo area,
11269 unless we displayed some mode lines. */
11270 update_single_window (w
);
11274 update_frame (f
, true, true);
11276 /* If cursor is in the echo area, make sure that the next
11277 redisplay displays the minibuffer, so that the cursor will
11278 be replaced with what the minibuffer wants. */
11279 if (cursor_in_echo_area
)
11280 wset_redisplay (XWINDOW (mini_window
));
11283 else if (!EQ (mini_window
, selected_window
))
11284 wset_redisplay (XWINDOW (mini_window
));
11286 /* Last displayed message is now the current message. */
11287 echo_area_buffer
[1] = echo_area_buffer
[0];
11288 /* Inform read_char that we're not echoing. */
11289 echo_message_buffer
= Qnil
;
11291 /* Prevent redisplay optimization in redisplay_internal by resetting
11292 this_line_start_pos. This is done because the mini-buffer now
11293 displays the message instead of its buffer text. */
11294 if (EQ (mini_window
, selected_window
))
11295 CHARPOS (this_line_start_pos
) = 0;
11297 if (window_height_changed_p
)
11299 fset_redisplay (f
);
11301 /* If window configuration was changed, frames may have been
11302 marked garbaged. Clear them or we will experience
11303 surprises wrt scrolling.
11304 FIXME: How/why/when? */
11305 clear_garbaged_frames ();
11309 /* True if W's buffer was changed but not saved. */
11312 window_buffer_changed (struct window
*w
)
11314 struct buffer
*b
= XBUFFER (w
->contents
);
11316 eassert (BUFFER_LIVE_P (b
));
11318 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11321 /* True if W has %c in its mode line and mode line should be updated. */
11324 mode_line_update_needed (struct window
*w
)
11326 return (w
->column_number_displayed
!= -1
11327 && !(PT
== w
->last_point
&& !window_outdated (w
))
11328 && (w
->column_number_displayed
!= current_column ()));
11331 /* True if window start of W is frozen and may not be changed during
11335 window_frozen_p (struct window
*w
)
11337 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11339 Lisp_Object window
;
11341 XSETWINDOW (window
, w
);
11342 if (MINI_WINDOW_P (w
))
11344 else if (EQ (window
, selected_window
))
11346 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11347 && EQ (window
, Vminibuf_scroll_window
))
11348 /* This special window can't be frozen too. */
11356 /***********************************************************************
11357 Mode Lines and Frame Titles
11358 ***********************************************************************/
11360 /* A buffer for constructing non-propertized mode-line strings and
11361 frame titles in it; allocated from the heap in init_xdisp and
11362 resized as needed in store_mode_line_noprop_char. */
11364 static char *mode_line_noprop_buf
;
11366 /* The buffer's end, and a current output position in it. */
11368 static char *mode_line_noprop_buf_end
;
11369 static char *mode_line_noprop_ptr
;
11371 #define MODE_LINE_NOPROP_LEN(start) \
11372 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11375 MODE_LINE_DISPLAY
= 0,
11379 } mode_line_target
;
11381 /* Alist that caches the results of :propertize.
11382 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11383 static Lisp_Object mode_line_proptrans_alist
;
11385 /* List of strings making up the mode-line. */
11386 static Lisp_Object mode_line_string_list
;
11388 /* Base face property when building propertized mode line string. */
11389 static Lisp_Object mode_line_string_face
;
11390 static Lisp_Object mode_line_string_face_prop
;
11393 /* Unwind data for mode line strings */
11395 static Lisp_Object Vmode_line_unwind_vector
;
11398 format_mode_line_unwind_data (struct frame
*target_frame
,
11399 struct buffer
*obuf
,
11401 bool save_proptrans
)
11403 Lisp_Object vector
, tmp
;
11405 /* Reduce consing by keeping one vector in
11406 Vwith_echo_area_save_vector. */
11407 vector
= Vmode_line_unwind_vector
;
11408 Vmode_line_unwind_vector
= Qnil
;
11411 vector
= Fmake_vector (make_number (10), Qnil
);
11413 ASET (vector
, 0, make_number (mode_line_target
));
11414 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11415 ASET (vector
, 2, mode_line_string_list
);
11416 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11417 ASET (vector
, 4, mode_line_string_face
);
11418 ASET (vector
, 5, mode_line_string_face_prop
);
11421 XSETBUFFER (tmp
, obuf
);
11424 ASET (vector
, 6, tmp
);
11425 ASET (vector
, 7, owin
);
11428 /* Similarly to `with-selected-window', if the operation selects
11429 a window on another frame, we must restore that frame's
11430 selected window, and (for a tty) the top-frame. */
11431 ASET (vector
, 8, target_frame
->selected_window
);
11432 if (FRAME_TERMCAP_P (target_frame
))
11433 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11440 unwind_format_mode_line (Lisp_Object vector
)
11442 Lisp_Object old_window
= AREF (vector
, 7);
11443 Lisp_Object target_frame_window
= AREF (vector
, 8);
11444 Lisp_Object old_top_frame
= AREF (vector
, 9);
11446 mode_line_target
= XINT (AREF (vector
, 0));
11447 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11448 mode_line_string_list
= AREF (vector
, 2);
11449 if (! EQ (AREF (vector
, 3), Qt
))
11450 mode_line_proptrans_alist
= AREF (vector
, 3);
11451 mode_line_string_face
= AREF (vector
, 4);
11452 mode_line_string_face_prop
= AREF (vector
, 5);
11454 /* Select window before buffer, since it may change the buffer. */
11455 if (!NILP (old_window
))
11457 /* If the operation that we are unwinding had selected a window
11458 on a different frame, reset its frame-selected-window. For a
11459 text terminal, reset its top-frame if necessary. */
11460 if (!NILP (target_frame_window
))
11463 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11465 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11466 Fselect_window (target_frame_window
, Qt
);
11468 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11469 Fselect_frame (old_top_frame
, Qt
);
11472 Fselect_window (old_window
, Qt
);
11475 if (!NILP (AREF (vector
, 6)))
11477 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11478 ASET (vector
, 6, Qnil
);
11481 Vmode_line_unwind_vector
= vector
;
11485 /* Store a single character C for the frame title in mode_line_noprop_buf.
11486 Re-allocate mode_line_noprop_buf if necessary. */
11489 store_mode_line_noprop_char (char c
)
11491 /* If output position has reached the end of the allocated buffer,
11492 increase the buffer's size. */
11493 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11495 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11496 ptrdiff_t size
= len
;
11497 mode_line_noprop_buf
=
11498 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11499 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11500 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11503 *mode_line_noprop_ptr
++ = c
;
11507 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11508 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11509 characters that yield more columns than PRECISION; PRECISION <= 0
11510 means copy the whole string. Pad with spaces until FIELD_WIDTH
11511 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11512 pad. Called from display_mode_element when it is used to build a
11516 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11518 const unsigned char *str
= (const unsigned char *) string
;
11520 ptrdiff_t dummy
, nbytes
;
11522 /* Copy at most PRECISION chars from STR. */
11523 nbytes
= strlen (string
);
11524 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11526 store_mode_line_noprop_char (*str
++);
11528 /* Fill up with spaces until FIELD_WIDTH reached. */
11529 while (field_width
> 0
11530 && n
< field_width
)
11532 store_mode_line_noprop_char (' ');
11539 /***********************************************************************
11541 ***********************************************************************/
11543 #ifdef HAVE_WINDOW_SYSTEM
11545 /* Set the title of FRAME, if it has changed. The title format is
11546 Vicon_title_format if FRAME is iconified, otherwise it is
11547 frame_title_format. */
11550 x_consider_frame_title (Lisp_Object frame
)
11552 struct frame
*f
= XFRAME (frame
);
11554 if (FRAME_WINDOW_P (f
)
11555 || FRAME_MINIBUF_ONLY_P (f
)
11556 || f
->explicit_name
)
11558 /* Do we have more than one visible frame on this X display? */
11559 Lisp_Object tail
, other_frame
, fmt
;
11560 ptrdiff_t title_start
;
11564 ptrdiff_t count
= SPECPDL_INDEX ();
11566 FOR_EACH_FRAME (tail
, other_frame
)
11568 struct frame
*tf
= XFRAME (other_frame
);
11571 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11572 && !FRAME_MINIBUF_ONLY_P (tf
)
11573 && !EQ (other_frame
, tip_frame
)
11574 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11578 /* Set global variable indicating that multiple frames exist. */
11579 multiple_frames
= CONSP (tail
);
11581 /* Switch to the buffer of selected window of the frame. Set up
11582 mode_line_target so that display_mode_element will output into
11583 mode_line_noprop_buf; then display the title. */
11584 record_unwind_protect (unwind_format_mode_line
,
11585 format_mode_line_unwind_data
11586 (f
, current_buffer
, selected_window
, false));
11588 Fselect_window (f
->selected_window
, Qt
);
11589 set_buffer_internal_1
11590 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11591 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11593 mode_line_target
= MODE_LINE_TITLE
;
11594 title_start
= MODE_LINE_NOPROP_LEN (0);
11595 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11596 NULL
, DEFAULT_FACE_ID
);
11597 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11598 len
= MODE_LINE_NOPROP_LEN (title_start
);
11599 title
= mode_line_noprop_buf
+ title_start
;
11600 unbind_to (count
, Qnil
);
11602 /* Set the title only if it's changed. This avoids consing in
11603 the common case where it hasn't. (If it turns out that we've
11604 already wasted too much time by walking through the list with
11605 display_mode_element, then we might need to optimize at a
11606 higher level than this.) */
11607 if (! STRINGP (f
->name
)
11608 || SBYTES (f
->name
) != len
11609 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11610 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11614 #endif /* not HAVE_WINDOW_SYSTEM */
11617 /***********************************************************************
11619 ***********************************************************************/
11621 /* True if we will not redisplay all visible windows. */
11622 #define REDISPLAY_SOME_P() \
11623 ((windows_or_buffers_changed == 0 \
11624 || windows_or_buffers_changed == REDISPLAY_SOME) \
11625 && (update_mode_lines == 0 \
11626 || update_mode_lines == REDISPLAY_SOME))
11628 /* Prepare for redisplay by updating menu-bar item lists when
11629 appropriate. This can call eval. */
11632 prepare_menu_bars (void)
11634 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11635 bool some_windows
= REDISPLAY_SOME_P ();
11636 Lisp_Object tooltip_frame
;
11638 #ifdef HAVE_WINDOW_SYSTEM
11639 tooltip_frame
= tip_frame
;
11641 tooltip_frame
= Qnil
;
11644 if (FUNCTIONP (Vpre_redisplay_function
))
11646 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11647 if (all_windows
&& some_windows
)
11649 Lisp_Object ws
= window_list ();
11650 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11652 Lisp_Object
this = XCAR (ws
);
11653 struct window
*w
= XWINDOW (this);
11655 || XFRAME (w
->frame
)->redisplay
11656 || XBUFFER (w
->contents
)->text
->redisplay
)
11658 windows
= Fcons (this, windows
);
11662 safe__call1 (true, Vpre_redisplay_function
, windows
);
11665 /* Update all frame titles based on their buffer names, etc. We do
11666 this before the menu bars so that the buffer-menu will show the
11667 up-to-date frame titles. */
11668 #ifdef HAVE_WINDOW_SYSTEM
11671 Lisp_Object tail
, frame
;
11673 FOR_EACH_FRAME (tail
, frame
)
11675 struct frame
*f
= XFRAME (frame
);
11676 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11680 && !XBUFFER (w
->contents
)->text
->redisplay
)
11683 if (!EQ (frame
, tooltip_frame
)
11684 && (FRAME_ICONIFIED_P (f
)
11685 || FRAME_VISIBLE_P (f
) == 1
11686 /* Exclude TTY frames that are obscured because they
11687 are not the top frame on their console. This is
11688 because x_consider_frame_title actually switches
11689 to the frame, which for TTY frames means it is
11690 marked as garbaged, and will be completely
11691 redrawn on the next redisplay cycle. This causes
11692 TTY frames to be completely redrawn, when there
11693 are more than one of them, even though nothing
11694 should be changed on display. */
11695 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11696 x_consider_frame_title (frame
);
11699 #endif /* HAVE_WINDOW_SYSTEM */
11701 /* Update the menu bar item lists, if appropriate. This has to be
11702 done before any actual redisplay or generation of display lines. */
11706 Lisp_Object tail
, frame
;
11707 ptrdiff_t count
= SPECPDL_INDEX ();
11708 /* True means that update_menu_bar has run its hooks
11709 so any further calls to update_menu_bar shouldn't do so again. */
11710 bool menu_bar_hooks_run
= false;
11712 record_unwind_save_match_data ();
11714 FOR_EACH_FRAME (tail
, frame
)
11716 struct frame
*f
= XFRAME (frame
);
11717 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11719 /* Ignore tooltip frame. */
11720 if (EQ (frame
, tooltip_frame
))
11726 && !XBUFFER (w
->contents
)->text
->redisplay
)
11729 /* If a window on this frame changed size, report that to
11730 the user and clear the size-change flag. */
11731 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11733 Lisp_Object functions
;
11735 /* Clear flag first in case we get an error below. */
11736 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11737 functions
= Vwindow_size_change_functions
;
11739 while (CONSP (functions
))
11741 if (!EQ (XCAR (functions
), Qt
))
11742 call1 (XCAR (functions
), frame
);
11743 functions
= XCDR (functions
);
11747 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11748 #ifdef HAVE_WINDOW_SYSTEM
11749 update_tool_bar (f
, false);
11753 unbind_to (count
, Qnil
);
11757 struct frame
*sf
= SELECTED_FRAME ();
11758 update_menu_bar (sf
, true, false);
11759 #ifdef HAVE_WINDOW_SYSTEM
11760 update_tool_bar (sf
, true);
11766 /* Update the menu bar item list for frame F. This has to be done
11767 before we start to fill in any display lines, because it can call
11770 If SAVE_MATCH_DATA, we must save and restore it here.
11772 If HOOKS_RUN, a previous call to update_menu_bar
11773 already ran the menu bar hooks for this redisplay, so there
11774 is no need to run them again. The return value is the
11775 updated value of this flag, to pass to the next call. */
11778 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11780 Lisp_Object window
;
11783 /* If called recursively during a menu update, do nothing. This can
11784 happen when, for instance, an activate-menubar-hook causes a
11786 if (inhibit_menubar_update
)
11789 window
= FRAME_SELECTED_WINDOW (f
);
11790 w
= XWINDOW (window
);
11792 if (FRAME_WINDOW_P (f
)
11794 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11795 || defined (HAVE_NS) || defined (USE_GTK)
11796 FRAME_EXTERNAL_MENU_BAR (f
)
11798 FRAME_MENU_BAR_LINES (f
) > 0
11800 : FRAME_MENU_BAR_LINES (f
) > 0)
11802 /* If the user has switched buffers or windows, we need to
11803 recompute to reflect the new bindings. But we'll
11804 recompute when update_mode_lines is set too; that means
11805 that people can use force-mode-line-update to request
11806 that the menu bar be recomputed. The adverse effect on
11807 the rest of the redisplay algorithm is about the same as
11808 windows_or_buffers_changed anyway. */
11809 if (windows_or_buffers_changed
11810 /* This used to test w->update_mode_line, but we believe
11811 there is no need to recompute the menu in that case. */
11812 || update_mode_lines
11813 || window_buffer_changed (w
))
11815 struct buffer
*prev
= current_buffer
;
11816 ptrdiff_t count
= SPECPDL_INDEX ();
11818 specbind (Qinhibit_menubar_update
, Qt
);
11820 set_buffer_internal_1 (XBUFFER (w
->contents
));
11821 if (save_match_data
)
11822 record_unwind_save_match_data ();
11823 if (NILP (Voverriding_local_map_menu_flag
))
11825 specbind (Qoverriding_terminal_local_map
, Qnil
);
11826 specbind (Qoverriding_local_map
, Qnil
);
11831 /* Run the Lucid hook. */
11832 safe_run_hooks (Qactivate_menubar_hook
);
11834 /* If it has changed current-menubar from previous value,
11835 really recompute the menu-bar from the value. */
11836 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11837 call0 (Qrecompute_lucid_menubar
);
11839 safe_run_hooks (Qmenu_bar_update_hook
);
11844 XSETFRAME (Vmenu_updating_frame
, f
);
11845 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11847 /* Redisplay the menu bar in case we changed it. */
11848 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11849 || defined (HAVE_NS) || defined (USE_GTK)
11850 if (FRAME_WINDOW_P (f
))
11852 #if defined (HAVE_NS)
11853 /* All frames on Mac OS share the same menubar. So only
11854 the selected frame should be allowed to set it. */
11855 if (f
== SELECTED_FRAME ())
11857 set_frame_menubar (f
, false, false);
11860 /* On a terminal screen, the menu bar is an ordinary screen
11861 line, and this makes it get updated. */
11862 w
->update_mode_line
= true;
11863 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11864 /* In the non-toolkit version, the menu bar is an ordinary screen
11865 line, and this makes it get updated. */
11866 w
->update_mode_line
= true;
11867 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11869 unbind_to (count
, Qnil
);
11870 set_buffer_internal_1 (prev
);
11877 /***********************************************************************
11879 ***********************************************************************/
11881 #ifdef HAVE_WINDOW_SYSTEM
11883 /* Select `frame' temporarily without running all the code in
11885 FIXME: Maybe do_switch_frame should be trimmed down similarly
11886 when `norecord' is set. */
11888 fast_set_selected_frame (Lisp_Object frame
)
11890 if (!EQ (selected_frame
, frame
))
11892 selected_frame
= frame
;
11893 selected_window
= XFRAME (frame
)->selected_window
;
11897 /* Update the tool-bar item list for frame F. This has to be done
11898 before we start to fill in any display lines. Called from
11899 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11900 and restore it here. */
11903 update_tool_bar (struct frame
*f
, bool save_match_data
)
11905 #if defined (USE_GTK) || defined (HAVE_NS)
11906 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11908 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11909 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11914 Lisp_Object window
;
11917 window
= FRAME_SELECTED_WINDOW (f
);
11918 w
= XWINDOW (window
);
11920 /* If the user has switched buffers or windows, we need to
11921 recompute to reflect the new bindings. But we'll
11922 recompute when update_mode_lines is set too; that means
11923 that people can use force-mode-line-update to request
11924 that the menu bar be recomputed. The adverse effect on
11925 the rest of the redisplay algorithm is about the same as
11926 windows_or_buffers_changed anyway. */
11927 if (windows_or_buffers_changed
11928 || w
->update_mode_line
11929 || update_mode_lines
11930 || window_buffer_changed (w
))
11932 struct buffer
*prev
= current_buffer
;
11933 ptrdiff_t count
= SPECPDL_INDEX ();
11934 Lisp_Object frame
, new_tool_bar
;
11935 int new_n_tool_bar
;
11937 /* Set current_buffer to the buffer of the selected
11938 window of the frame, so that we get the right local
11940 set_buffer_internal_1 (XBUFFER (w
->contents
));
11942 /* Save match data, if we must. */
11943 if (save_match_data
)
11944 record_unwind_save_match_data ();
11946 /* Make sure that we don't accidentally use bogus keymaps. */
11947 if (NILP (Voverriding_local_map_menu_flag
))
11949 specbind (Qoverriding_terminal_local_map
, Qnil
);
11950 specbind (Qoverriding_local_map
, Qnil
);
11953 /* We must temporarily set the selected frame to this frame
11954 before calling tool_bar_items, because the calculation of
11955 the tool-bar keymap uses the selected frame (see
11956 `tool-bar-make-keymap' in tool-bar.el). */
11957 eassert (EQ (selected_window
,
11958 /* Since we only explicitly preserve selected_frame,
11959 check that selected_window would be redundant. */
11960 XFRAME (selected_frame
)->selected_window
));
11961 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11962 XSETFRAME (frame
, f
);
11963 fast_set_selected_frame (frame
);
11965 /* Build desired tool-bar items from keymaps. */
11967 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11970 /* Redisplay the tool-bar if we changed it. */
11971 if (new_n_tool_bar
!= f
->n_tool_bar_items
11972 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11974 /* Redisplay that happens asynchronously due to an expose event
11975 may access f->tool_bar_items. Make sure we update both
11976 variables within BLOCK_INPUT so no such event interrupts. */
11978 fset_tool_bar_items (f
, new_tool_bar
);
11979 f
->n_tool_bar_items
= new_n_tool_bar
;
11980 w
->update_mode_line
= true;
11984 unbind_to (count
, Qnil
);
11985 set_buffer_internal_1 (prev
);
11990 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11992 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11993 F's desired tool-bar contents. F->tool_bar_items must have
11994 been set up previously by calling prepare_menu_bars. */
11997 build_desired_tool_bar_string (struct frame
*f
)
11999 int i
, size
, size_needed
;
12000 Lisp_Object image
, plist
;
12002 image
= plist
= Qnil
;
12004 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12005 Otherwise, make a new string. */
12007 /* The size of the string we might be able to reuse. */
12008 size
= (STRINGP (f
->desired_tool_bar_string
)
12009 ? SCHARS (f
->desired_tool_bar_string
)
12012 /* We need one space in the string for each image. */
12013 size_needed
= f
->n_tool_bar_items
;
12015 /* Reuse f->desired_tool_bar_string, if possible. */
12016 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12017 fset_desired_tool_bar_string
12018 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12021 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12022 Fremove_text_properties (make_number (0), make_number (size
),
12023 props
, f
->desired_tool_bar_string
);
12026 /* Put a `display' property on the string for the images to display,
12027 put a `menu_item' property on tool-bar items with a value that
12028 is the index of the item in F's tool-bar item vector. */
12029 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12031 #define PROP(IDX) \
12032 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12034 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12035 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12036 int hmargin
, vmargin
, relief
, idx
, end
;
12038 /* If image is a vector, choose the image according to the
12040 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12041 if (VECTORP (image
))
12045 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12046 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12049 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12050 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12052 eassert (ASIZE (image
) >= idx
);
12053 image
= AREF (image
, idx
);
12058 /* Ignore invalid image specifications. */
12059 if (!valid_image_p (image
))
12062 /* Display the tool-bar button pressed, or depressed. */
12063 plist
= Fcopy_sequence (XCDR (image
));
12065 /* Compute margin and relief to draw. */
12066 relief
= (tool_bar_button_relief
>= 0
12067 ? tool_bar_button_relief
12068 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12069 hmargin
= vmargin
= relief
;
12071 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12072 INT_MAX
- max (hmargin
, vmargin
)))
12074 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12075 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12077 else if (CONSP (Vtool_bar_button_margin
))
12079 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12080 INT_MAX
- hmargin
))
12081 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12083 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12084 INT_MAX
- vmargin
))
12085 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12088 if (auto_raise_tool_bar_buttons_p
)
12090 /* Add a `:relief' property to the image spec if the item is
12094 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12101 /* If image is selected, display it pressed, i.e. with a
12102 negative relief. If it's not selected, display it with a
12104 plist
= Fplist_put (plist
, QCrelief
,
12106 ? make_number (-relief
)
12107 : make_number (relief
)));
12112 /* Put a margin around the image. */
12113 if (hmargin
|| vmargin
)
12115 if (hmargin
== vmargin
)
12116 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12118 plist
= Fplist_put (plist
, QCmargin
,
12119 Fcons (make_number (hmargin
),
12120 make_number (vmargin
)));
12123 /* If button is not enabled, and we don't have special images
12124 for the disabled state, make the image appear disabled by
12125 applying an appropriate algorithm to it. */
12126 if (!enabled_p
&& idx
< 0)
12127 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12129 /* Put a `display' text property on the string for the image to
12130 display. Put a `menu-item' property on the string that gives
12131 the start of this item's properties in the tool-bar items
12133 image
= Fcons (Qimage
, plist
);
12134 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12135 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12137 /* Let the last image hide all remaining spaces in the tool bar
12138 string. The string can be longer than needed when we reuse a
12139 previous string. */
12140 if (i
+ 1 == f
->n_tool_bar_items
)
12141 end
= SCHARS (f
->desired_tool_bar_string
);
12144 Fadd_text_properties (make_number (i
), make_number (end
),
12145 props
, f
->desired_tool_bar_string
);
12151 /* Display one line of the tool-bar of frame IT->f.
12153 HEIGHT specifies the desired height of the tool-bar line.
12154 If the actual height of the glyph row is less than HEIGHT, the
12155 row's height is increased to HEIGHT, and the icons are centered
12156 vertically in the new height.
12158 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12159 count a final empty row in case the tool-bar width exactly matches
12164 display_tool_bar_line (struct it
*it
, int height
)
12166 struct glyph_row
*row
= it
->glyph_row
;
12167 int max_x
= it
->last_visible_x
;
12168 struct glyph
*last
;
12170 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12171 clear_glyph_row (row
);
12172 row
->enabled_p
= true;
12173 row
->y
= it
->current_y
;
12175 /* Note that this isn't made use of if the face hasn't a box,
12176 so there's no need to check the face here. */
12177 it
->start_of_box_run_p
= true;
12179 while (it
->current_x
< max_x
)
12181 int x
, n_glyphs_before
, i
, nglyphs
;
12182 struct it it_before
;
12184 /* Get the next display element. */
12185 if (!get_next_display_element (it
))
12187 /* Don't count empty row if we are counting needed tool-bar lines. */
12188 if (height
< 0 && !it
->hpos
)
12193 /* Produce glyphs. */
12194 n_glyphs_before
= row
->used
[TEXT_AREA
];
12197 PRODUCE_GLYPHS (it
);
12199 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12201 x
= it_before
.current_x
;
12202 while (i
< nglyphs
)
12204 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12206 if (x
+ glyph
->pixel_width
> max_x
)
12208 /* Glyph doesn't fit on line. Backtrack. */
12209 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12211 /* If this is the only glyph on this line, it will never fit on the
12212 tool-bar, so skip it. But ensure there is at least one glyph,
12213 so we don't accidentally disable the tool-bar. */
12214 if (n_glyphs_before
== 0
12215 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12221 x
+= glyph
->pixel_width
;
12225 /* Stop at line end. */
12226 if (ITERATOR_AT_END_OF_LINE_P (it
))
12229 set_iterator_to_next (it
, true);
12234 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12236 /* Use default face for the border below the tool bar.
12238 FIXME: When auto-resize-tool-bars is grow-only, there is
12239 no additional border below the possibly empty tool-bar lines.
12240 So to make the extra empty lines look "normal", we have to
12241 use the tool-bar face for the border too. */
12242 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12243 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12244 it
->face_id
= DEFAULT_FACE_ID
;
12246 extend_face_to_end_of_line (it
);
12247 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12248 last
->right_box_line_p
= true;
12249 if (last
== row
->glyphs
[TEXT_AREA
])
12250 last
->left_box_line_p
= true;
12252 /* Make line the desired height and center it vertically. */
12253 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12255 /* Don't add more than one line height. */
12256 height
%= FRAME_LINE_HEIGHT (it
->f
);
12257 it
->max_ascent
+= height
/ 2;
12258 it
->max_descent
+= (height
+ 1) / 2;
12261 compute_line_metrics (it
);
12263 /* If line is empty, make it occupy the rest of the tool-bar. */
12264 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12266 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12267 row
->visible_height
= row
->height
;
12268 row
->ascent
= row
->phys_ascent
= 0;
12269 row
->extra_line_spacing
= 0;
12272 row
->full_width_p
= true;
12273 row
->continued_p
= false;
12274 row
->truncated_on_left_p
= false;
12275 row
->truncated_on_right_p
= false;
12277 it
->current_x
= it
->hpos
= 0;
12278 it
->current_y
+= row
->height
;
12284 /* Value is the number of pixels needed to make all tool-bar items of
12285 frame F visible. The actual number of glyph rows needed is
12286 returned in *N_ROWS if non-NULL. */
12288 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12290 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12292 /* tool_bar_height is called from redisplay_tool_bar after building
12293 the desired matrix, so use (unused) mode-line row as temporary row to
12294 avoid destroying the first tool-bar row. */
12295 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12297 /* Initialize an iterator for iteration over
12298 F->desired_tool_bar_string in the tool-bar window of frame F. */
12299 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12300 temp_row
->reversed_p
= false;
12301 it
.first_visible_x
= 0;
12302 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12303 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12304 it
.paragraph_embedding
= L2R
;
12306 while (!ITERATOR_AT_END_P (&it
))
12308 clear_glyph_row (temp_row
);
12309 it
.glyph_row
= temp_row
;
12310 display_tool_bar_line (&it
, -1);
12312 clear_glyph_row (temp_row
);
12314 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12316 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12319 return it
.current_y
;
12321 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12324 #endif /* !USE_GTK && !HAVE_NS */
12326 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12328 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12329 If FRAME is nil or omitted, use the selected frame. Optional argument
12330 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12331 (Lisp_Object frame
, Lisp_Object pixelwise
)
12335 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12336 struct frame
*f
= decode_any_frame (frame
);
12338 if (WINDOWP (f
->tool_bar_window
)
12339 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12341 update_tool_bar (f
, true);
12342 if (f
->n_tool_bar_items
)
12344 build_desired_tool_bar_string (f
);
12345 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12350 return make_number (height
);
12354 /* Display the tool-bar of frame F. Value is true if tool-bar's
12355 height should be changed. */
12357 redisplay_tool_bar (struct frame
*f
)
12359 f
->tool_bar_redisplayed
= true;
12360 #if defined (USE_GTK) || defined (HAVE_NS)
12362 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12363 update_frame_tool_bar (f
);
12366 #else /* !USE_GTK && !HAVE_NS */
12370 struct glyph_row
*row
;
12372 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12373 do anything. This means you must start with tool-bar-lines
12374 non-zero to get the auto-sizing effect. Or in other words, you
12375 can turn off tool-bars by specifying tool-bar-lines zero. */
12376 if (!WINDOWP (f
->tool_bar_window
)
12377 || (w
= XWINDOW (f
->tool_bar_window
),
12378 WINDOW_TOTAL_LINES (w
) == 0))
12381 /* Set up an iterator for the tool-bar window. */
12382 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12383 it
.first_visible_x
= 0;
12384 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12385 row
= it
.glyph_row
;
12386 row
->reversed_p
= false;
12388 /* Build a string that represents the contents of the tool-bar. */
12389 build_desired_tool_bar_string (f
);
12390 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12391 /* FIXME: This should be controlled by a user option. But it
12392 doesn't make sense to have an R2L tool bar if the menu bar cannot
12393 be drawn also R2L, and making the menu bar R2L is tricky due
12394 toolkit-specific code that implements it. If an R2L tool bar is
12395 ever supported, display_tool_bar_line should also be augmented to
12396 call unproduce_glyphs like display_line and display_string
12398 it
.paragraph_embedding
= L2R
;
12400 if (f
->n_tool_bar_rows
== 0)
12402 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12404 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12406 x_change_tool_bar_height (f
, new_height
);
12407 frame_default_tool_bar_height
= new_height
;
12408 /* Always do that now. */
12409 clear_glyph_matrix (w
->desired_matrix
);
12410 f
->fonts_changed
= true;
12415 /* Display as many lines as needed to display all tool-bar items. */
12417 if (f
->n_tool_bar_rows
> 0)
12419 int border
, rows
, height
, extra
;
12421 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12422 border
= XINT (Vtool_bar_border
);
12423 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12424 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12425 else if (EQ (Vtool_bar_border
, Qborder_width
))
12426 border
= f
->border_width
;
12432 rows
= f
->n_tool_bar_rows
;
12433 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12434 extra
= it
.last_visible_y
- border
- height
* rows
;
12436 while (it
.current_y
< it
.last_visible_y
)
12439 if (extra
> 0 && rows
-- > 0)
12441 h
= (extra
+ rows
- 1) / rows
;
12444 display_tool_bar_line (&it
, height
+ h
);
12449 while (it
.current_y
< it
.last_visible_y
)
12450 display_tool_bar_line (&it
, 0);
12453 /* It doesn't make much sense to try scrolling in the tool-bar
12454 window, so don't do it. */
12455 w
->desired_matrix
->no_scrolling_p
= true;
12456 w
->must_be_updated_p
= true;
12458 if (!NILP (Vauto_resize_tool_bars
))
12460 bool change_height_p
= true;
12462 /* If we couldn't display everything, change the tool-bar's
12463 height if there is room for more. */
12464 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12465 change_height_p
= true;
12467 /* We subtract 1 because display_tool_bar_line advances the
12468 glyph_row pointer before returning to its caller. We want to
12469 examine the last glyph row produced by
12470 display_tool_bar_line. */
12471 row
= it
.glyph_row
- 1;
12473 /* If there are blank lines at the end, except for a partially
12474 visible blank line at the end that is smaller than
12475 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12476 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12477 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12478 change_height_p
= true;
12480 /* If row displays tool-bar items, but is partially visible,
12481 change the tool-bar's height. */
12482 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12483 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12484 change_height_p
= true;
12486 /* Resize windows as needed by changing the `tool-bar-lines'
12487 frame parameter. */
12488 if (change_height_p
)
12491 int new_height
= tool_bar_height (f
, &nrows
, true);
12493 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12494 && !f
->minimize_tool_bar_window_p
)
12495 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12496 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12497 f
->minimize_tool_bar_window_p
= false;
12499 if (change_height_p
)
12501 x_change_tool_bar_height (f
, new_height
);
12502 frame_default_tool_bar_height
= new_height
;
12503 clear_glyph_matrix (w
->desired_matrix
);
12504 f
->n_tool_bar_rows
= nrows
;
12505 f
->fonts_changed
= true;
12512 f
->minimize_tool_bar_window_p
= false;
12515 #endif /* USE_GTK || HAVE_NS */
12518 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12520 /* Get information about the tool-bar item which is displayed in GLYPH
12521 on frame F. Return in *PROP_IDX the index where tool-bar item
12522 properties start in F->tool_bar_items. Value is false if
12523 GLYPH doesn't display a tool-bar item. */
12526 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12531 /* This function can be called asynchronously, which means we must
12532 exclude any possibility that Fget_text_property signals an
12534 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12535 charpos
= max (0, charpos
);
12537 /* Get the text property `menu-item' at pos. The value of that
12538 property is the start index of this item's properties in
12539 F->tool_bar_items. */
12540 prop
= Fget_text_property (make_number (charpos
),
12541 Qmenu_item
, f
->current_tool_bar_string
);
12542 if (! INTEGERP (prop
))
12544 *prop_idx
= XINT (prop
);
12549 /* Get information about the tool-bar item at position X/Y on frame F.
12550 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12551 the current matrix of the tool-bar window of F, or NULL if not
12552 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12553 item in F->tool_bar_items. Value is
12555 -1 if X/Y is not on a tool-bar item
12556 0 if X/Y is on the same item that was highlighted before.
12560 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12561 int *hpos
, int *vpos
, int *prop_idx
)
12563 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12564 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12567 /* Find the glyph under X/Y. */
12568 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12569 if (*glyph
== NULL
)
12572 /* Get the start of this tool-bar item's properties in
12573 f->tool_bar_items. */
12574 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12577 /* Is mouse on the highlighted item? */
12578 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12579 && *vpos
>= hlinfo
->mouse_face_beg_row
12580 && *vpos
<= hlinfo
->mouse_face_end_row
12581 && (*vpos
> hlinfo
->mouse_face_beg_row
12582 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12583 && (*vpos
< hlinfo
->mouse_face_end_row
12584 || *hpos
< hlinfo
->mouse_face_end_col
12585 || hlinfo
->mouse_face_past_end
))
12593 Handle mouse button event on the tool-bar of frame F, at
12594 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12595 false for button release. MODIFIERS is event modifiers for button
12599 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12602 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12603 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12604 int hpos
, vpos
, prop_idx
;
12605 struct glyph
*glyph
;
12606 Lisp_Object enabled_p
;
12609 /* If not on the highlighted tool-bar item, and mouse-highlight is
12610 non-nil, return. This is so we generate the tool-bar button
12611 click only when the mouse button is released on the same item as
12612 where it was pressed. However, when mouse-highlight is disabled,
12613 generate the click when the button is released regardless of the
12614 highlight, since tool-bar items are not highlighted in that
12616 frame_to_window_pixel_xy (w
, &x
, &y
);
12617 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12619 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12622 /* When mouse-highlight is off, generate the click for the item
12623 where the button was pressed, disregarding where it was
12625 if (NILP (Vmouse_highlight
) && !down_p
)
12626 prop_idx
= f
->last_tool_bar_item
;
12628 /* If item is disabled, do nothing. */
12629 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12630 if (NILP (enabled_p
))
12635 /* Show item in pressed state. */
12636 if (!NILP (Vmouse_highlight
))
12637 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12638 f
->last_tool_bar_item
= prop_idx
;
12642 Lisp_Object key
, frame
;
12643 struct input_event event
;
12644 EVENT_INIT (event
);
12646 /* Show item in released state. */
12647 if (!NILP (Vmouse_highlight
))
12648 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12650 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12652 XSETFRAME (frame
, f
);
12653 event
.kind
= TOOL_BAR_EVENT
;
12654 event
.frame_or_window
= frame
;
12656 kbd_buffer_store_event (&event
);
12658 event
.kind
= TOOL_BAR_EVENT
;
12659 event
.frame_or_window
= frame
;
12661 event
.modifiers
= modifiers
;
12662 kbd_buffer_store_event (&event
);
12663 f
->last_tool_bar_item
= -1;
12668 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12669 tool-bar window-relative coordinates X/Y. Called from
12670 note_mouse_highlight. */
12673 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12675 Lisp_Object window
= f
->tool_bar_window
;
12676 struct window
*w
= XWINDOW (window
);
12677 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12678 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12680 struct glyph
*glyph
;
12681 struct glyph_row
*row
;
12683 Lisp_Object enabled_p
;
12685 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12689 /* Function note_mouse_highlight is called with negative X/Y
12690 values when mouse moves outside of the frame. */
12691 if (x
<= 0 || y
<= 0)
12693 clear_mouse_face (hlinfo
);
12697 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12700 /* Not on tool-bar item. */
12701 clear_mouse_face (hlinfo
);
12705 /* On same tool-bar item as before. */
12706 goto set_help_echo
;
12708 clear_mouse_face (hlinfo
);
12710 /* Mouse is down, but on different tool-bar item? */
12711 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12712 && f
== dpyinfo
->last_mouse_frame
);
12714 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12717 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12719 /* If tool-bar item is not enabled, don't highlight it. */
12720 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12721 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12723 /* Compute the x-position of the glyph. In front and past the
12724 image is a space. We include this in the highlighted area. */
12725 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12726 for (i
= x
= 0; i
< hpos
; ++i
)
12727 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12729 /* Record this as the current active region. */
12730 hlinfo
->mouse_face_beg_col
= hpos
;
12731 hlinfo
->mouse_face_beg_row
= vpos
;
12732 hlinfo
->mouse_face_beg_x
= x
;
12733 hlinfo
->mouse_face_past_end
= false;
12735 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12736 hlinfo
->mouse_face_end_row
= vpos
;
12737 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12738 hlinfo
->mouse_face_window
= window
;
12739 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12741 /* Display it as active. */
12742 show_mouse_face (hlinfo
, draw
);
12747 /* Set help_echo_string to a help string to display for this tool-bar item.
12748 XTread_socket does the rest. */
12749 help_echo_object
= help_echo_window
= Qnil
;
12750 help_echo_pos
= -1;
12751 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12752 if (NILP (help_echo_string
))
12753 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12756 #endif /* !USE_GTK && !HAVE_NS */
12758 #endif /* HAVE_WINDOW_SYSTEM */
12762 /************************************************************************
12763 Horizontal scrolling
12764 ************************************************************************/
12766 /* For all leaf windows in the window tree rooted at WINDOW, set their
12767 hscroll value so that PT is (i) visible in the window, and (ii) so
12768 that it is not within a certain margin at the window's left and
12769 right border. Value is true if any window's hscroll has been
12773 hscroll_window_tree (Lisp_Object window
)
12775 bool hscrolled_p
= false;
12776 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12777 int hscroll_step_abs
= 0;
12778 double hscroll_step_rel
= 0;
12780 if (hscroll_relative_p
)
12782 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12783 if (hscroll_step_rel
< 0)
12785 hscroll_relative_p
= false;
12786 hscroll_step_abs
= 0;
12789 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12791 hscroll_step_abs
= XINT (Vhscroll_step
);
12792 if (hscroll_step_abs
< 0)
12793 hscroll_step_abs
= 0;
12796 hscroll_step_abs
= 0;
12798 while (WINDOWP (window
))
12800 struct window
*w
= XWINDOW (window
);
12802 if (WINDOWP (w
->contents
))
12803 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12804 else if (w
->cursor
.vpos
>= 0)
12807 int text_area_width
;
12808 struct glyph_row
*cursor_row
;
12809 struct glyph_row
*bottom_row
;
12811 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12812 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12813 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12815 cursor_row
= bottom_row
- 1;
12817 if (!cursor_row
->enabled_p
)
12819 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12820 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12821 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12823 cursor_row
= bottom_row
- 1;
12825 bool row_r2l_p
= cursor_row
->reversed_p
;
12827 text_area_width
= window_box_width (w
, TEXT_AREA
);
12829 /* Scroll when cursor is inside this scroll margin. */
12830 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12832 /* If the position of this window's point has explicitly
12833 changed, no more suspend auto hscrolling. */
12834 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12835 w
->suspend_auto_hscroll
= false;
12837 /* Remember window point. */
12838 Fset_marker (w
->old_pointm
,
12839 ((w
== XWINDOW (selected_window
))
12840 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12841 : Fmarker_position (w
->pointm
)),
12844 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12845 && !w
->suspend_auto_hscroll
12846 /* In some pathological cases, like restoring a window
12847 configuration into a frame that is much smaller than
12848 the one from which the configuration was saved, we
12849 get glyph rows whose start and end have zero buffer
12850 positions, which we cannot handle below. Just skip
12852 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12853 /* For left-to-right rows, hscroll when cursor is either
12854 (i) inside the right hscroll margin, or (ii) if it is
12855 inside the left margin and the window is already
12858 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12859 || (cursor_row
->enabled_p
12860 && cursor_row
->truncated_on_right_p
12861 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12862 /* For right-to-left rows, the logic is similar,
12863 except that rules for scrolling to left and right
12864 are reversed. E.g., if cursor.x <= h_margin, we
12865 need to hscroll "to the right" unconditionally,
12866 and that will scroll the screen to the left so as
12867 to reveal the next portion of the row. */
12869 && ((cursor_row
->enabled_p
12870 /* FIXME: It is confusing to set the
12871 truncated_on_right_p flag when R2L rows
12872 are actually truncated on the left. */
12873 && cursor_row
->truncated_on_right_p
12874 && w
->cursor
.x
<= h_margin
)
12876 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12880 struct buffer
*saved_current_buffer
;
12884 /* Find point in a display of infinite width. */
12885 saved_current_buffer
= current_buffer
;
12886 current_buffer
= XBUFFER (w
->contents
);
12888 if (w
== XWINDOW (selected_window
))
12891 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12893 /* Move iterator to pt starting at cursor_row->start in
12894 a line with infinite width. */
12895 init_to_row_start (&it
, w
, cursor_row
);
12896 it
.last_visible_x
= INFINITY
;
12897 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12898 current_buffer
= saved_current_buffer
;
12900 /* Position cursor in window. */
12901 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12902 hscroll
= max (0, (it
.current_x
12903 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12904 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12905 : (text_area_width
/ 2))))
12906 / FRAME_COLUMN_WIDTH (it
.f
);
12907 else if ((!row_r2l_p
12908 && w
->cursor
.x
>= text_area_width
- h_margin
)
12909 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12911 if (hscroll_relative_p
)
12912 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12915 wanted_x
= text_area_width
12916 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12919 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12923 if (hscroll_relative_p
)
12924 wanted_x
= text_area_width
* hscroll_step_rel
12927 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12930 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12932 hscroll
= max (hscroll
, w
->min_hscroll
);
12934 /* Don't prevent redisplay optimizations if hscroll
12935 hasn't changed, as it will unnecessarily slow down
12937 if (w
->hscroll
!= hscroll
)
12939 struct buffer
*b
= XBUFFER (w
->contents
);
12940 b
->prevent_redisplay_optimizations_p
= true;
12941 w
->hscroll
= hscroll
;
12942 hscrolled_p
= true;
12950 /* Value is true if hscroll of any leaf window has been changed. */
12951 return hscrolled_p
;
12955 /* Set hscroll so that cursor is visible and not inside horizontal
12956 scroll margins for all windows in the tree rooted at WINDOW. See
12957 also hscroll_window_tree above. Value is true if any window's
12958 hscroll has been changed. If it has, desired matrices on the frame
12959 of WINDOW are cleared. */
12962 hscroll_windows (Lisp_Object window
)
12964 bool hscrolled_p
= hscroll_window_tree (window
);
12966 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12967 return hscrolled_p
;
12972 /************************************************************************
12974 ************************************************************************/
12976 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12977 This is sometimes handy to have in a debugger session. */
12981 /* First and last unchanged row for try_window_id. */
12983 static int debug_first_unchanged_at_end_vpos
;
12984 static int debug_last_unchanged_at_beg_vpos
;
12986 /* Delta vpos and y. */
12988 static int debug_dvpos
, debug_dy
;
12990 /* Delta in characters and bytes for try_window_id. */
12992 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12994 /* Values of window_end_pos and window_end_vpos at the end of
12997 static ptrdiff_t debug_end_vpos
;
12999 /* Append a string to W->desired_matrix->method. FMT is a printf
13000 format string. If trace_redisplay_p is true also printf the
13001 resulting string to stderr. */
13003 static void debug_method_add (struct window
*, char const *, ...)
13004 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13007 debug_method_add (struct window
*w
, char const *fmt
, ...)
13010 char *method
= w
->desired_matrix
->method
;
13011 int len
= strlen (method
);
13012 int size
= sizeof w
->desired_matrix
->method
;
13013 int remaining
= size
- len
- 1;
13016 if (len
&& remaining
)
13019 --remaining
, ++len
;
13022 va_start (ap
, fmt
);
13023 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13026 if (trace_redisplay_p
)
13027 fprintf (stderr
, "%p (%s): %s\n",
13029 ((BUFFERP (w
->contents
)
13030 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13031 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13036 #endif /* GLYPH_DEBUG */
13039 /* Value is true if all changes in window W, which displays
13040 current_buffer, are in the text between START and END. START is a
13041 buffer position, END is given as a distance from Z. Used in
13042 redisplay_internal for display optimization. */
13045 text_outside_line_unchanged_p (struct window
*w
,
13046 ptrdiff_t start
, ptrdiff_t end
)
13048 bool unchanged_p
= true;
13050 /* If text or overlays have changed, see where. */
13051 if (window_outdated (w
))
13053 /* Gap in the line? */
13054 if (GPT
< start
|| Z
- GPT
< end
)
13055 unchanged_p
= false;
13057 /* Changes start in front of the line, or end after it? */
13059 && (BEG_UNCHANGED
< start
- 1
13060 || END_UNCHANGED
< end
))
13061 unchanged_p
= false;
13063 /* If selective display, can't optimize if changes start at the
13064 beginning of the line. */
13066 && INTEGERP (BVAR (current_buffer
, selective_display
))
13067 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13068 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13069 unchanged_p
= false;
13071 /* If there are overlays at the start or end of the line, these
13072 may have overlay strings with newlines in them. A change at
13073 START, for instance, may actually concern the display of such
13074 overlay strings as well, and they are displayed on different
13075 lines. So, quickly rule out this case. (For the future, it
13076 might be desirable to implement something more telling than
13077 just BEG/END_UNCHANGED.) */
13080 if (BEG
+ BEG_UNCHANGED
== start
13081 && overlay_touches_p (start
))
13082 unchanged_p
= false;
13083 if (END_UNCHANGED
== end
13084 && overlay_touches_p (Z
- end
))
13085 unchanged_p
= false;
13088 /* Under bidi reordering, adding or deleting a character in the
13089 beginning of a paragraph, before the first strong directional
13090 character, can change the base direction of the paragraph (unless
13091 the buffer specifies a fixed paragraph direction), which will
13092 require to redisplay the whole paragraph. It might be worthwhile
13093 to find the paragraph limits and widen the range of redisplayed
13094 lines to that, but for now just give up this optimization. */
13095 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13096 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13097 unchanged_p
= false;
13100 return unchanged_p
;
13104 /* Do a frame update, taking possible shortcuts into account. This is
13105 the main external entry point for redisplay.
13107 If the last redisplay displayed an echo area message and that message
13108 is no longer requested, we clear the echo area or bring back the
13109 mini-buffer if that is in use. */
13114 redisplay_internal ();
13119 overlay_arrow_string_or_property (Lisp_Object var
)
13123 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13126 return Voverlay_arrow_string
;
13129 /* Return true if there are any overlay-arrows in current_buffer. */
13131 overlay_arrow_in_current_buffer_p (void)
13135 for (vlist
= Voverlay_arrow_variable_list
;
13137 vlist
= XCDR (vlist
))
13139 Lisp_Object var
= XCAR (vlist
);
13142 if (!SYMBOLP (var
))
13144 val
= find_symbol_value (var
);
13146 && current_buffer
== XMARKER (val
)->buffer
)
13153 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13157 overlay_arrows_changed_p (void)
13161 for (vlist
= Voverlay_arrow_variable_list
;
13163 vlist
= XCDR (vlist
))
13165 Lisp_Object var
= XCAR (vlist
);
13166 Lisp_Object val
, pstr
;
13168 if (!SYMBOLP (var
))
13170 val
= find_symbol_value (var
);
13171 if (!MARKERP (val
))
13173 if (! EQ (COERCE_MARKER (val
),
13174 Fget (var
, Qlast_arrow_position
))
13175 || ! (pstr
= overlay_arrow_string_or_property (var
),
13176 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13182 /* Mark overlay arrows to be updated on next redisplay. */
13185 update_overlay_arrows (int up_to_date
)
13189 for (vlist
= Voverlay_arrow_variable_list
;
13191 vlist
= XCDR (vlist
))
13193 Lisp_Object var
= XCAR (vlist
);
13195 if (!SYMBOLP (var
))
13198 if (up_to_date
> 0)
13200 Lisp_Object val
= find_symbol_value (var
);
13201 Fput (var
, Qlast_arrow_position
,
13202 COERCE_MARKER (val
));
13203 Fput (var
, Qlast_arrow_string
,
13204 overlay_arrow_string_or_property (var
));
13206 else if (up_to_date
< 0
13207 || !NILP (Fget (var
, Qlast_arrow_position
)))
13209 Fput (var
, Qlast_arrow_position
, Qt
);
13210 Fput (var
, Qlast_arrow_string
, Qt
);
13216 /* Return overlay arrow string to display at row.
13217 Return integer (bitmap number) for arrow bitmap in left fringe.
13218 Return nil if no overlay arrow. */
13221 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13225 for (vlist
= Voverlay_arrow_variable_list
;
13227 vlist
= XCDR (vlist
))
13229 Lisp_Object var
= XCAR (vlist
);
13232 if (!SYMBOLP (var
))
13235 val
= find_symbol_value (var
);
13238 && current_buffer
== XMARKER (val
)->buffer
13239 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13241 if (FRAME_WINDOW_P (it
->f
)
13242 /* FIXME: if ROW->reversed_p is set, this should test
13243 the right fringe, not the left one. */
13244 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13246 #ifdef HAVE_WINDOW_SYSTEM
13247 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13249 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13250 if (fringe_bitmap
!= 0)
13251 return make_number (fringe_bitmap
);
13254 return make_number (-1); /* Use default arrow bitmap. */
13256 return overlay_arrow_string_or_property (var
);
13263 /* Return true if point moved out of or into a composition. Otherwise
13264 return false. PREV_BUF and PREV_PT are the last point buffer and
13265 position. BUF and PT are the current point buffer and position. */
13268 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13269 struct buffer
*buf
, ptrdiff_t pt
)
13271 ptrdiff_t start
, end
;
13273 Lisp_Object buffer
;
13275 XSETBUFFER (buffer
, buf
);
13276 /* Check a composition at the last point if point moved within the
13278 if (prev_buf
== buf
)
13281 /* Point didn't move. */
13284 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13285 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13286 && composition_valid_p (start
, end
, prop
)
13287 && start
< prev_pt
&& end
> prev_pt
)
13288 /* The last point was within the composition. Return true iff
13289 point moved out of the composition. */
13290 return (pt
<= start
|| pt
>= end
);
13293 /* Check a composition at the current point. */
13294 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13295 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13296 && composition_valid_p (start
, end
, prop
)
13297 && start
< pt
&& end
> pt
);
13300 /* Reconsider the clip changes of buffer which is displayed in W. */
13303 reconsider_clip_changes (struct window
*w
)
13305 struct buffer
*b
= XBUFFER (w
->contents
);
13307 if (b
->clip_changed
13308 && w
->window_end_valid
13309 && w
->current_matrix
->buffer
== b
13310 && w
->current_matrix
->zv
== BUF_ZV (b
)
13311 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13312 b
->clip_changed
= false;
13314 /* If display wasn't paused, and W is not a tool bar window, see if
13315 point has been moved into or out of a composition. In that case,
13316 set b->clip_changed to force updating the screen. If
13317 b->clip_changed has already been set, skip this check. */
13318 if (!b
->clip_changed
&& w
->window_end_valid
)
13320 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13321 ? PT
: marker_position (w
->pointm
));
13323 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13324 && check_point_in_composition (w
->current_matrix
->buffer
,
13325 w
->last_point
, b
, pt
))
13326 b
->clip_changed
= true;
13331 propagate_buffer_redisplay (void)
13332 { /* Resetting b->text->redisplay is problematic!
13333 We can't just reset it in the case that some window that displays
13334 it has not been redisplayed; and such a window can stay
13335 unredisplayed for a long time if it's currently invisible.
13336 But we do want to reset it at the end of redisplay otherwise
13337 its displayed windows will keep being redisplayed over and over
13339 So we copy all b->text->redisplay flags up to their windows here,
13340 such that mark_window_display_accurate can safely reset
13341 b->text->redisplay. */
13342 Lisp_Object ws
= window_list ();
13343 for (; CONSP (ws
); ws
= XCDR (ws
))
13345 struct window
*thisw
= XWINDOW (XCAR (ws
));
13346 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13347 if (thisb
->text
->redisplay
)
13348 thisw
->redisplay
= true;
13352 #define STOP_POLLING \
13353 do { if (! polling_stopped_here) stop_polling (); \
13354 polling_stopped_here = true; } while (false)
13356 #define RESUME_POLLING \
13357 do { if (polling_stopped_here) start_polling (); \
13358 polling_stopped_here = false; } while (false)
13361 /* Perhaps in the future avoid recentering windows if it
13362 is not necessary; currently that causes some problems. */
13365 redisplay_internal (void)
13367 struct window
*w
= XWINDOW (selected_window
);
13371 bool must_finish
= false, match_p
;
13372 struct text_pos tlbufpos
, tlendpos
;
13373 int number_of_visible_frames
;
13376 bool polling_stopped_here
= false;
13377 Lisp_Object tail
, frame
;
13379 /* True means redisplay has to consider all windows on all
13380 frames. False, only selected_window is considered. */
13381 bool consider_all_windows_p
;
13383 /* True means redisplay has to redisplay the miniwindow. */
13384 bool update_miniwindow_p
= false;
13386 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13388 /* No redisplay if running in batch mode or frame is not yet fully
13389 initialized, or redisplay is explicitly turned off by setting
13390 Vinhibit_redisplay. */
13391 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13392 || !NILP (Vinhibit_redisplay
))
13395 /* Don't examine these until after testing Vinhibit_redisplay.
13396 When Emacs is shutting down, perhaps because its connection to
13397 X has dropped, we should not look at them at all. */
13398 fr
= XFRAME (w
->frame
);
13399 sf
= SELECTED_FRAME ();
13401 if (!fr
->glyphs_initialized_p
)
13404 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13405 if (popup_activated ())
13409 /* I don't think this happens but let's be paranoid. */
13410 if (redisplaying_p
)
13413 /* Record a function that clears redisplaying_p
13414 when we leave this function. */
13415 count
= SPECPDL_INDEX ();
13416 record_unwind_protect_void (unwind_redisplay
);
13417 redisplaying_p
= true;
13418 specbind (Qinhibit_free_realized_faces
, Qnil
);
13420 /* Record this function, so it appears on the profiler's backtraces. */
13421 record_in_backtrace (Qredisplay_internal
, 0, 0);
13423 FOR_EACH_FRAME (tail
, frame
)
13424 XFRAME (frame
)->already_hscrolled_p
= false;
13427 /* Remember the currently selected window. */
13431 forget_escape_and_glyphless_faces ();
13433 inhibit_free_realized_faces
= false;
13435 /* If face_change, init_iterator will free all realized faces, which
13436 includes the faces referenced from current matrices. So, we
13437 can't reuse current matrices in this case. */
13439 windows_or_buffers_changed
= 47;
13441 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13442 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13444 /* Since frames on a single ASCII terminal share the same
13445 display area, displaying a different frame means redisplay
13446 the whole thing. */
13447 SET_FRAME_GARBAGED (sf
);
13449 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13451 FRAME_TTY (sf
)->previous_frame
= sf
;
13454 /* Set the visible flags for all frames. Do this before checking for
13455 resized or garbaged frames; they want to know if their frames are
13456 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13457 number_of_visible_frames
= 0;
13459 FOR_EACH_FRAME (tail
, frame
)
13461 struct frame
*f
= XFRAME (frame
);
13463 if (FRAME_VISIBLE_P (f
))
13465 ++number_of_visible_frames
;
13466 /* Adjust matrices for visible frames only. */
13467 if (f
->fonts_changed
)
13469 adjust_frame_glyphs (f
);
13470 /* Disable all redisplay optimizations for this frame.
13471 This is because adjust_frame_glyphs resets the
13472 enabled_p flag for all glyph rows of all windows, so
13473 many optimizations will fail anyway, and some might
13474 fail to test that flag and do bogus things as
13476 SET_FRAME_GARBAGED (f
);
13477 f
->fonts_changed
= false;
13479 /* If cursor type has been changed on the frame
13480 other than selected, consider all frames. */
13481 if (f
!= sf
&& f
->cursor_type_changed
)
13482 fset_redisplay (f
);
13484 clear_desired_matrices (f
);
13487 /* Notice any pending interrupt request to change frame size. */
13488 do_pending_window_change (true);
13490 /* do_pending_window_change could change the selected_window due to
13491 frame resizing which makes the selected window too small. */
13492 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13495 /* Clear frames marked as garbaged. */
13496 clear_garbaged_frames ();
13498 /* Build menubar and tool-bar items. */
13499 if (NILP (Vmemory_full
))
13500 prepare_menu_bars ();
13502 reconsider_clip_changes (w
);
13504 /* In most cases selected window displays current buffer. */
13505 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13508 /* Detect case that we need to write or remove a star in the mode line. */
13509 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13510 w
->update_mode_line
= true;
13512 if (mode_line_update_needed (w
))
13513 w
->update_mode_line
= true;
13515 /* If reconsider_clip_changes above decided that the narrowing
13516 in the current buffer changed, make sure all other windows
13517 showing that buffer will be redisplayed. */
13518 if (current_buffer
->clip_changed
)
13519 bset_update_mode_line (current_buffer
);
13522 /* Normally the message* functions will have already displayed and
13523 updated the echo area, but the frame may have been trashed, or
13524 the update may have been preempted, so display the echo area
13525 again here. Checking message_cleared_p captures the case that
13526 the echo area should be cleared. */
13527 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13528 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13529 || (message_cleared_p
13530 && minibuf_level
== 0
13531 /* If the mini-window is currently selected, this means the
13532 echo-area doesn't show through. */
13533 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13535 echo_area_display (false);
13537 if (message_cleared_p
)
13538 update_miniwindow_p
= true;
13540 must_finish
= true;
13542 /* If we don't display the current message, don't clear the
13543 message_cleared_p flag, because, if we did, we wouldn't clear
13544 the echo area in the next redisplay which doesn't preserve
13546 if (!display_last_displayed_message_p
)
13547 message_cleared_p
= false;
13549 else if (EQ (selected_window
, minibuf_window
)
13550 && (current_buffer
->clip_changed
|| window_outdated (w
))
13551 && resize_mini_window (w
, false))
13553 /* Resized active mini-window to fit the size of what it is
13554 showing if its contents might have changed. */
13555 must_finish
= true;
13557 /* If window configuration was changed, frames may have been
13558 marked garbaged. Clear them or we will experience
13559 surprises wrt scrolling. */
13560 clear_garbaged_frames ();
13563 if (windows_or_buffers_changed
&& !update_mode_lines
)
13564 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13565 only the windows's contents needs to be refreshed, or whether the
13566 mode-lines also need a refresh. */
13567 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13568 ? REDISPLAY_SOME
: 32);
13570 /* If specs for an arrow have changed, do thorough redisplay
13571 to ensure we remove any arrow that should no longer exist. */
13572 if (overlay_arrows_changed_p ())
13573 /* Apparently, this is the only case where we update other windows,
13574 without updating other mode-lines. */
13575 windows_or_buffers_changed
= 49;
13577 consider_all_windows_p
= (update_mode_lines
13578 || windows_or_buffers_changed
);
13580 #define AINC(a,i) \
13582 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13583 if (INTEGERP (entry)) \
13584 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13587 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13588 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13590 /* Optimize the case that only the line containing the cursor in the
13591 selected window has changed. Variables starting with this_ are
13592 set in display_line and record information about the line
13593 containing the cursor. */
13594 tlbufpos
= this_line_start_pos
;
13595 tlendpos
= this_line_end_pos
;
13596 if (!consider_all_windows_p
13597 && CHARPOS (tlbufpos
) > 0
13598 && !w
->update_mode_line
13599 && !current_buffer
->clip_changed
13600 && !current_buffer
->prevent_redisplay_optimizations_p
13601 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13602 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13603 && !XFRAME (w
->frame
)->cursor_type_changed
13604 && !XFRAME (w
->frame
)->face_change
13605 /* Make sure recorded data applies to current buffer, etc. */
13606 && this_line_buffer
== current_buffer
13609 && !w
->optional_new_start
13610 /* Point must be on the line that we have info recorded about. */
13611 && PT
>= CHARPOS (tlbufpos
)
13612 && PT
<= Z
- CHARPOS (tlendpos
)
13613 /* All text outside that line, including its final newline,
13614 must be unchanged. */
13615 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13616 CHARPOS (tlendpos
)))
13618 if (CHARPOS (tlbufpos
) > BEGV
13619 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13620 && (CHARPOS (tlbufpos
) == ZV
13621 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13622 /* Former continuation line has disappeared by becoming empty. */
13624 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13626 /* We have to handle the case of continuation around a
13627 wide-column character (see the comment in indent.c around
13630 For instance, in the following case:
13632 -------- Insert --------
13633 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13634 J_I_ ==> J_I_ `^^' are cursors.
13638 As we have to redraw the line above, we cannot use this
13642 int line_height_before
= this_line_pixel_height
;
13644 /* Note that start_display will handle the case that the
13645 line starting at tlbufpos is a continuation line. */
13646 start_display (&it
, w
, tlbufpos
);
13648 /* Implementation note: It this still necessary? */
13649 if (it
.current_x
!= this_line_start_x
)
13652 TRACE ((stderr
, "trying display optimization 1\n"));
13653 w
->cursor
.vpos
= -1;
13654 overlay_arrow_seen
= false;
13655 it
.vpos
= this_line_vpos
;
13656 it
.current_y
= this_line_y
;
13657 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13658 display_line (&it
);
13660 /* If line contains point, is not continued,
13661 and ends at same distance from eob as before, we win. */
13662 if (w
->cursor
.vpos
>= 0
13663 /* Line is not continued, otherwise this_line_start_pos
13664 would have been set to 0 in display_line. */
13665 && CHARPOS (this_line_start_pos
)
13666 /* Line ends as before. */
13667 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13668 /* Line has same height as before. Otherwise other lines
13669 would have to be shifted up or down. */
13670 && this_line_pixel_height
== line_height_before
)
13672 /* If this is not the window's last line, we must adjust
13673 the charstarts of the lines below. */
13674 if (it
.current_y
< it
.last_visible_y
)
13676 struct glyph_row
*row
13677 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13678 ptrdiff_t delta
, delta_bytes
;
13680 /* We used to distinguish between two cases here,
13681 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13682 when the line ends in a newline or the end of the
13683 buffer's accessible portion. But both cases did
13684 the same, so they were collapsed. */
13686 - CHARPOS (tlendpos
)
13687 - MATRIX_ROW_START_CHARPOS (row
));
13688 delta_bytes
= (Z_BYTE
13689 - BYTEPOS (tlendpos
)
13690 - MATRIX_ROW_START_BYTEPOS (row
));
13692 increment_matrix_positions (w
->current_matrix
,
13693 this_line_vpos
+ 1,
13694 w
->current_matrix
->nrows
,
13695 delta
, delta_bytes
);
13698 /* If this row displays text now but previously didn't,
13699 or vice versa, w->window_end_vpos may have to be
13701 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13703 if (w
->window_end_vpos
< this_line_vpos
)
13704 w
->window_end_vpos
= this_line_vpos
;
13706 else if (w
->window_end_vpos
== this_line_vpos
13707 && this_line_vpos
> 0)
13708 w
->window_end_vpos
= this_line_vpos
- 1;
13709 w
->window_end_valid
= false;
13711 /* Update hint: No need to try to scroll in update_window. */
13712 w
->desired_matrix
->no_scrolling_p
= true;
13715 *w
->desired_matrix
->method
= 0;
13716 debug_method_add (w
, "optimization 1");
13718 #ifdef HAVE_WINDOW_SYSTEM
13719 update_window_fringes (w
, false);
13726 else if (/* Cursor position hasn't changed. */
13727 PT
== w
->last_point
13728 /* Make sure the cursor was last displayed
13729 in this window. Otherwise we have to reposition it. */
13731 /* PXW: Must be converted to pixels, probably. */
13732 && 0 <= w
->cursor
.vpos
13733 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13737 do_pending_window_change (true);
13738 /* If selected_window changed, redisplay again. */
13739 if (WINDOWP (selected_window
)
13740 && (w
= XWINDOW (selected_window
)) != sw
)
13743 /* We used to always goto end_of_redisplay here, but this
13744 isn't enough if we have a blinking cursor. */
13745 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13746 goto end_of_redisplay
;
13750 /* If highlighting the region, or if the cursor is in the echo area,
13751 then we can't just move the cursor. */
13752 else if (NILP (Vshow_trailing_whitespace
)
13753 && !cursor_in_echo_area
)
13756 struct glyph_row
*row
;
13758 /* Skip from tlbufpos to PT and see where it is. Note that
13759 PT may be in invisible text. If so, we will end at the
13760 next visible position. */
13761 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13762 NULL
, DEFAULT_FACE_ID
);
13763 it
.current_x
= this_line_start_x
;
13764 it
.current_y
= this_line_y
;
13765 it
.vpos
= this_line_vpos
;
13767 /* The call to move_it_to stops in front of PT, but
13768 moves over before-strings. */
13769 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13771 if (it
.vpos
== this_line_vpos
13772 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13775 eassert (this_line_vpos
== it
.vpos
);
13776 eassert (this_line_y
== it
.current_y
);
13777 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13779 *w
->desired_matrix
->method
= 0;
13780 debug_method_add (w
, "optimization 3");
13789 /* Text changed drastically or point moved off of line. */
13790 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13793 CHARPOS (this_line_start_pos
) = 0;
13794 ++clear_face_cache_count
;
13795 #ifdef HAVE_WINDOW_SYSTEM
13796 ++clear_image_cache_count
;
13799 /* Build desired matrices, and update the display. If
13800 consider_all_windows_p, do it for all windows on all frames that
13801 require redisplay, as specified by their 'redisplay' flag.
13802 Otherwise do it for selected_window, only. */
13804 if (consider_all_windows_p
)
13806 FOR_EACH_FRAME (tail
, frame
)
13807 XFRAME (frame
)->updated_p
= false;
13809 propagate_buffer_redisplay ();
13811 FOR_EACH_FRAME (tail
, frame
)
13813 struct frame
*f
= XFRAME (frame
);
13815 /* We don't have to do anything for unselected terminal
13817 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13818 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13822 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13825 /* Only GC scrollbars when we redisplay the whole frame. */
13826 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13827 bool f_redisplay_flag
= f
->redisplay
;
13828 /* Mark all the scroll bars to be removed; we'll redeem
13829 the ones we want when we redisplay their windows. */
13830 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13831 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13833 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13834 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13835 /* Remember that the invisible frames need to be redisplayed next
13836 time they're visible. */
13837 else if (!REDISPLAY_SOME_P ())
13838 f
->redisplay
= true;
13840 /* The X error handler may have deleted that frame. */
13841 if (!FRAME_LIVE_P (f
))
13844 /* Any scroll bars which redisplay_windows should have
13845 nuked should now go away. */
13846 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13847 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13849 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13851 /* If fonts changed on visible frame, display again. */
13852 if (f
->fonts_changed
)
13854 adjust_frame_glyphs (f
);
13855 /* Disable all redisplay optimizations for this
13856 frame. For the reasons, see the comment near
13857 the previous call to adjust_frame_glyphs above. */
13858 SET_FRAME_GARBAGED (f
);
13859 f
->fonts_changed
= false;
13863 /* See if we have to hscroll. */
13864 if (!f
->already_hscrolled_p
)
13866 f
->already_hscrolled_p
= true;
13867 if (hscroll_windows (f
->root_window
))
13871 /* If the frame's redisplay flag was not set before
13872 we went about redisplaying its windows, but it is
13873 set now, that means we employed some redisplay
13874 optimizations inside redisplay_windows, and
13875 bypassed producing some screen lines. But if
13876 f->redisplay is now set, it might mean the old
13877 faces are no longer valid (e.g., if redisplaying
13878 some window called some Lisp which defined a new
13879 face or redefined an existing face), so trying to
13880 use them in update_frame will segfault.
13881 Therefore, we must redisplay this frame. */
13882 if (!f_redisplay_flag
&& f
->redisplay
)
13885 /* Prevent various kinds of signals during display
13886 update. stdio is not robust about handling
13887 signals, which can cause an apparent I/O error. */
13888 if (interrupt_input
)
13889 unrequest_sigio ();
13892 pending
|= update_frame (f
, false, false);
13893 f
->cursor_type_changed
= false;
13894 f
->updated_p
= true;
13899 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13903 /* Do the mark_window_display_accurate after all windows have
13904 been redisplayed because this call resets flags in buffers
13905 which are needed for proper redisplay. */
13906 FOR_EACH_FRAME (tail
, frame
)
13908 struct frame
*f
= XFRAME (frame
);
13911 f
->redisplay
= false;
13912 mark_window_display_accurate (f
->root_window
, true);
13913 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13914 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13919 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13921 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13922 struct frame
*mini_frame
;
13924 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13925 /* Use list_of_error, not Qerror, so that
13926 we catch only errors and don't run the debugger. */
13927 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13929 redisplay_window_error
);
13930 if (update_miniwindow_p
)
13931 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13933 redisplay_window_error
);
13935 /* Compare desired and current matrices, perform output. */
13938 /* If fonts changed, display again. Likewise if redisplay_window_1
13939 above caused some change (e.g., a change in faces) that requires
13940 considering the entire frame again. */
13941 if (sf
->fonts_changed
|| sf
->redisplay
)
13945 /* Set this to force a more thorough redisplay.
13946 Otherwise, we might immediately loop back to the
13947 above "else-if" clause (since all the conditions that
13948 led here might still be true), and we will then
13949 infloop, because the selected-frame's redisplay flag
13950 is not (and cannot be) reset. */
13951 windows_or_buffers_changed
= 50;
13956 /* Prevent freeing of realized faces, since desired matrices are
13957 pending that reference the faces we computed and cached. */
13958 inhibit_free_realized_faces
= true;
13960 /* Prevent various kinds of signals during display update.
13961 stdio is not robust about handling signals,
13962 which can cause an apparent I/O error. */
13963 if (interrupt_input
)
13964 unrequest_sigio ();
13967 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13969 if (hscroll_windows (selected_window
))
13972 XWINDOW (selected_window
)->must_be_updated_p
= true;
13973 pending
= update_frame (sf
, false, false);
13974 sf
->cursor_type_changed
= false;
13977 /* We may have called echo_area_display at the top of this
13978 function. If the echo area is on another frame, that may
13979 have put text on a frame other than the selected one, so the
13980 above call to update_frame would not have caught it. Catch
13982 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13983 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13985 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13987 XWINDOW (mini_window
)->must_be_updated_p
= true;
13988 pending
|= update_frame (mini_frame
, false, false);
13989 mini_frame
->cursor_type_changed
= false;
13990 if (!pending
&& hscroll_windows (mini_window
))
13995 /* If display was paused because of pending input, make sure we do a
13996 thorough update the next time. */
13999 /* Prevent the optimization at the beginning of
14000 redisplay_internal that tries a single-line update of the
14001 line containing the cursor in the selected window. */
14002 CHARPOS (this_line_start_pos
) = 0;
14004 /* Let the overlay arrow be updated the next time. */
14005 update_overlay_arrows (0);
14007 /* If we pause after scrolling, some rows in the current
14008 matrices of some windows are not valid. */
14009 if (!WINDOW_FULL_WIDTH_P (w
)
14010 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14011 update_mode_lines
= 36;
14015 if (!consider_all_windows_p
)
14017 /* This has already been done above if
14018 consider_all_windows_p is set. */
14019 if (XBUFFER (w
->contents
)->text
->redisplay
14020 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14021 /* This can happen if b->text->redisplay was set during
14023 propagate_buffer_redisplay ();
14024 mark_window_display_accurate_1 (w
, true);
14026 /* Say overlay arrows are up to date. */
14027 update_overlay_arrows (1);
14029 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14030 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14033 update_mode_lines
= 0;
14034 windows_or_buffers_changed
= 0;
14037 /* Start SIGIO interrupts coming again. Having them off during the
14038 code above makes it less likely one will discard output, but not
14039 impossible, since there might be stuff in the system buffer here.
14040 But it is much hairier to try to do anything about that. */
14041 if (interrupt_input
)
14045 /* If a frame has become visible which was not before, redisplay
14046 again, so that we display it. Expose events for such a frame
14047 (which it gets when becoming visible) don't call the parts of
14048 redisplay constructing glyphs, so simply exposing a frame won't
14049 display anything in this case. So, we have to display these
14050 frames here explicitly. */
14055 FOR_EACH_FRAME (tail
, frame
)
14057 if (XFRAME (frame
)->visible
)
14061 if (new_count
!= number_of_visible_frames
)
14062 windows_or_buffers_changed
= 52;
14065 /* Change frame size now if a change is pending. */
14066 do_pending_window_change (true);
14068 /* If we just did a pending size change, or have additional
14069 visible frames, or selected_window changed, redisplay again. */
14070 if ((windows_or_buffers_changed
&& !pending
)
14071 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14074 /* Clear the face and image caches.
14076 We used to do this only if consider_all_windows_p. But the cache
14077 needs to be cleared if a timer creates images in the current
14078 buffer (e.g. the test case in Bug#6230). */
14080 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14082 clear_face_cache (false);
14083 clear_face_cache_count
= 0;
14086 #ifdef HAVE_WINDOW_SYSTEM
14087 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14089 clear_image_caches (Qnil
);
14090 clear_image_cache_count
= 0;
14092 #endif /* HAVE_WINDOW_SYSTEM */
14096 ns_set_doc_edited ();
14098 if (interrupt_input
&& interrupts_deferred
)
14101 unbind_to (count
, Qnil
);
14106 /* Redisplay, but leave alone any recent echo area message unless
14107 another message has been requested in its place.
14109 This is useful in situations where you need to redisplay but no
14110 user action has occurred, making it inappropriate for the message
14111 area to be cleared. See tracking_off and
14112 wait_reading_process_output for examples of these situations.
14114 FROM_WHERE is an integer saying from where this function was
14115 called. This is useful for debugging. */
14118 redisplay_preserve_echo_area (int from_where
)
14120 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14122 if (!NILP (echo_area_buffer
[1]))
14124 /* We have a previously displayed message, but no current
14125 message. Redisplay the previous message. */
14126 display_last_displayed_message_p
= true;
14127 redisplay_internal ();
14128 display_last_displayed_message_p
= false;
14131 redisplay_internal ();
14133 flush_frame (SELECTED_FRAME ());
14137 /* Function registered with record_unwind_protect in redisplay_internal. */
14140 unwind_redisplay (void)
14142 redisplaying_p
= false;
14146 /* Mark the display of leaf window W as accurate or inaccurate.
14147 If ACCURATE_P, mark display of W as accurate.
14148 If !ACCURATE_P, arrange for W to be redisplayed the next
14149 time redisplay_internal is called. */
14152 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14154 struct buffer
*b
= XBUFFER (w
->contents
);
14156 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14157 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14158 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14162 b
->clip_changed
= false;
14163 b
->prevent_redisplay_optimizations_p
= false;
14164 eassert (buffer_window_count (b
) > 0);
14165 /* Resetting b->text->redisplay is problematic!
14166 In order to make it safer to do it here, redisplay_internal must
14167 have copied all b->text->redisplay to their respective windows. */
14168 b
->text
->redisplay
= false;
14170 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14171 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14172 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14173 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14175 w
->current_matrix
->buffer
= b
;
14176 w
->current_matrix
->begv
= BUF_BEGV (b
);
14177 w
->current_matrix
->zv
= BUF_ZV (b
);
14179 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14180 w
->last_cursor_off_p
= w
->cursor_off_p
;
14182 if (w
== XWINDOW (selected_window
))
14183 w
->last_point
= BUF_PT (b
);
14185 w
->last_point
= marker_position (w
->pointm
);
14187 w
->window_end_valid
= true;
14188 w
->update_mode_line
= false;
14191 w
->redisplay
= !accurate_p
;
14195 /* Mark the display of windows in the window tree rooted at WINDOW as
14196 accurate or inaccurate. If ACCURATE_P, mark display of
14197 windows as accurate. If !ACCURATE_P, arrange for windows to
14198 be redisplayed the next time redisplay_internal is called. */
14201 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14205 for (; !NILP (window
); window
= w
->next
)
14207 w
= XWINDOW (window
);
14208 if (WINDOWP (w
->contents
))
14209 mark_window_display_accurate (w
->contents
, accurate_p
);
14211 mark_window_display_accurate_1 (w
, accurate_p
);
14215 update_overlay_arrows (1);
14217 /* Force a thorough redisplay the next time by setting
14218 last_arrow_position and last_arrow_string to t, which is
14219 unequal to any useful value of Voverlay_arrow_... */
14220 update_overlay_arrows (-1);
14224 /* Return value in display table DP (Lisp_Char_Table *) for character
14225 C. Since a display table doesn't have any parent, we don't have to
14226 follow parent. Do not call this function directly but use the
14227 macro DISP_CHAR_VECTOR. */
14230 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14234 if (ASCII_CHAR_P (c
))
14237 if (SUB_CHAR_TABLE_P (val
))
14238 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14244 XSETCHAR_TABLE (table
, dp
);
14245 val
= char_table_ref (table
, c
);
14254 /***********************************************************************
14256 ***********************************************************************/
14258 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14261 redisplay_windows (Lisp_Object window
)
14263 while (!NILP (window
))
14265 struct window
*w
= XWINDOW (window
);
14267 if (WINDOWP (w
->contents
))
14268 redisplay_windows (w
->contents
);
14269 else if (BUFFERP (w
->contents
))
14271 displayed_buffer
= XBUFFER (w
->contents
);
14272 /* Use list_of_error, not Qerror, so that
14273 we catch only errors and don't run the debugger. */
14274 internal_condition_case_1 (redisplay_window_0
, window
,
14276 redisplay_window_error
);
14284 redisplay_window_error (Lisp_Object ignore
)
14286 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14291 redisplay_window_0 (Lisp_Object window
)
14293 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14294 redisplay_window (window
, false);
14299 redisplay_window_1 (Lisp_Object window
)
14301 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14302 redisplay_window (window
, true);
14307 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14308 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14309 which positions recorded in ROW differ from current buffer
14312 Return true iff cursor is on this row. */
14315 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14316 struct glyph_matrix
*matrix
,
14317 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14320 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14321 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14322 struct glyph
*cursor
= NULL
;
14323 /* The last known character position in row. */
14324 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14326 ptrdiff_t pt_old
= PT
- delta
;
14327 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14328 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14329 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14330 /* A glyph beyond the edge of TEXT_AREA which we should never
14332 struct glyph
*glyphs_end
= end
;
14333 /* True means we've found a match for cursor position, but that
14334 glyph has the avoid_cursor_p flag set. */
14335 bool match_with_avoid_cursor
= false;
14336 /* True means we've seen at least one glyph that came from a
14338 bool string_seen
= false;
14339 /* Largest and smallest buffer positions seen so far during scan of
14341 ptrdiff_t bpos_max
= pos_before
;
14342 ptrdiff_t bpos_min
= pos_after
;
14343 /* Last buffer position covered by an overlay string with an integer
14344 `cursor' property. */
14345 ptrdiff_t bpos_covered
= 0;
14346 /* True means the display string on which to display the cursor
14347 comes from a text property, not from an overlay. */
14348 bool string_from_text_prop
= false;
14350 /* Don't even try doing anything if called for a mode-line or
14351 header-line row, since the rest of the code isn't prepared to
14352 deal with such calamities. */
14353 eassert (!row
->mode_line_p
);
14354 if (row
->mode_line_p
)
14357 /* Skip over glyphs not having an object at the start and the end of
14358 the row. These are special glyphs like truncation marks on
14359 terminal frames. */
14360 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14362 if (!row
->reversed_p
)
14365 && NILP (glyph
->object
)
14366 && glyph
->charpos
< 0)
14368 x
+= glyph
->pixel_width
;
14372 && NILP ((end
- 1)->object
)
14373 /* CHARPOS is zero for blanks and stretch glyphs
14374 inserted by extend_face_to_end_of_line. */
14375 && (end
- 1)->charpos
<= 0)
14377 glyph_before
= glyph
- 1;
14384 /* If the glyph row is reversed, we need to process it from back
14385 to front, so swap the edge pointers. */
14386 glyphs_end
= end
= glyph
- 1;
14387 glyph
+= row
->used
[TEXT_AREA
] - 1;
14389 while (glyph
> end
+ 1
14390 && NILP (glyph
->object
)
14391 && glyph
->charpos
< 0)
14394 x
-= glyph
->pixel_width
;
14396 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14398 /* By default, in reversed rows we put the cursor on the
14399 rightmost (first in the reading order) glyph. */
14400 for (g
= end
+ 1; g
< glyph
; g
++)
14401 x
+= g
->pixel_width
;
14403 && NILP ((end
+ 1)->object
)
14404 && (end
+ 1)->charpos
<= 0)
14406 glyph_before
= glyph
+ 1;
14410 else if (row
->reversed_p
)
14412 /* In R2L rows that don't display text, put the cursor on the
14413 rightmost glyph. Case in point: an empty last line that is
14414 part of an R2L paragraph. */
14416 /* Avoid placing the cursor on the last glyph of the row, where
14417 on terminal frames we hold the vertical border between
14418 adjacent windows. */
14419 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14420 && !WINDOW_RIGHTMOST_P (w
)
14421 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14423 x
= -1; /* will be computed below, at label compute_x */
14426 /* Step 1: Try to find the glyph whose character position
14427 corresponds to point. If that's not possible, find 2 glyphs
14428 whose character positions are the closest to point, one before
14429 point, the other after it. */
14430 if (!row
->reversed_p
)
14431 while (/* not marched to end of glyph row */
14433 /* glyph was not inserted by redisplay for internal purposes */
14434 && !NILP (glyph
->object
))
14436 if (BUFFERP (glyph
->object
))
14438 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14440 if (glyph
->charpos
> bpos_max
)
14441 bpos_max
= glyph
->charpos
;
14442 if (glyph
->charpos
< bpos_min
)
14443 bpos_min
= glyph
->charpos
;
14444 if (!glyph
->avoid_cursor_p
)
14446 /* If we hit point, we've found the glyph on which to
14447 display the cursor. */
14450 match_with_avoid_cursor
= false;
14453 /* See if we've found a better approximation to
14454 POS_BEFORE or to POS_AFTER. */
14455 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14457 pos_before
= glyph
->charpos
;
14458 glyph_before
= glyph
;
14460 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14462 pos_after
= glyph
->charpos
;
14463 glyph_after
= glyph
;
14466 else if (dpos
== 0)
14467 match_with_avoid_cursor
= true;
14469 else if (STRINGP (glyph
->object
))
14471 Lisp_Object chprop
;
14472 ptrdiff_t glyph_pos
= glyph
->charpos
;
14474 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14476 if (!NILP (chprop
))
14478 /* If the string came from a `display' text property,
14479 look up the buffer position of that property and
14480 use that position to update bpos_max, as if we
14481 actually saw such a position in one of the row's
14482 glyphs. This helps with supporting integer values
14483 of `cursor' property on the display string in
14484 situations where most or all of the row's buffer
14485 text is completely covered by display properties,
14486 so that no glyph with valid buffer positions is
14487 ever seen in the row. */
14488 ptrdiff_t prop_pos
=
14489 string_buffer_position_lim (glyph
->object
, pos_before
,
14492 if (prop_pos
>= pos_before
)
14493 bpos_max
= prop_pos
;
14495 if (INTEGERP (chprop
))
14497 bpos_covered
= bpos_max
+ XINT (chprop
);
14498 /* If the `cursor' property covers buffer positions up
14499 to and including point, we should display cursor on
14500 this glyph. Note that, if a `cursor' property on one
14501 of the string's characters has an integer value, we
14502 will break out of the loop below _before_ we get to
14503 the position match above. IOW, integer values of
14504 the `cursor' property override the "exact match for
14505 point" strategy of positioning the cursor. */
14506 /* Implementation note: bpos_max == pt_old when, e.g.,
14507 we are in an empty line, where bpos_max is set to
14508 MATRIX_ROW_START_CHARPOS, see above. */
14509 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14516 string_seen
= true;
14518 x
+= glyph
->pixel_width
;
14521 else if (glyph
> end
) /* row is reversed */
14522 while (!NILP (glyph
->object
))
14524 if (BUFFERP (glyph
->object
))
14526 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14528 if (glyph
->charpos
> bpos_max
)
14529 bpos_max
= glyph
->charpos
;
14530 if (glyph
->charpos
< bpos_min
)
14531 bpos_min
= glyph
->charpos
;
14532 if (!glyph
->avoid_cursor_p
)
14536 match_with_avoid_cursor
= false;
14539 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14541 pos_before
= glyph
->charpos
;
14542 glyph_before
= glyph
;
14544 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14546 pos_after
= glyph
->charpos
;
14547 glyph_after
= glyph
;
14550 else if (dpos
== 0)
14551 match_with_avoid_cursor
= true;
14553 else if (STRINGP (glyph
->object
))
14555 Lisp_Object chprop
;
14556 ptrdiff_t glyph_pos
= glyph
->charpos
;
14558 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14560 if (!NILP (chprop
))
14562 ptrdiff_t prop_pos
=
14563 string_buffer_position_lim (glyph
->object
, pos_before
,
14566 if (prop_pos
>= pos_before
)
14567 bpos_max
= prop_pos
;
14569 if (INTEGERP (chprop
))
14571 bpos_covered
= bpos_max
+ XINT (chprop
);
14572 /* If the `cursor' property covers buffer positions up
14573 to and including point, we should display cursor on
14575 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14581 string_seen
= true;
14584 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14586 x
--; /* can't use any pixel_width */
14589 x
-= glyph
->pixel_width
;
14592 /* Step 2: If we didn't find an exact match for point, we need to
14593 look for a proper place to put the cursor among glyphs between
14594 GLYPH_BEFORE and GLYPH_AFTER. */
14595 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14596 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14597 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14599 /* An empty line has a single glyph whose OBJECT is nil and
14600 whose CHARPOS is the position of a newline on that line.
14601 Note that on a TTY, there are more glyphs after that, which
14602 were produced by extend_face_to_end_of_line, but their
14603 CHARPOS is zero or negative. */
14604 bool empty_line_p
=
14605 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14606 && NILP (glyph
->object
) && glyph
->charpos
> 0
14607 /* On a TTY, continued and truncated rows also have a glyph at
14608 their end whose OBJECT is nil and whose CHARPOS is
14609 positive (the continuation and truncation glyphs), but such
14610 rows are obviously not "empty". */
14611 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14613 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14615 ptrdiff_t ellipsis_pos
;
14617 /* Scan back over the ellipsis glyphs. */
14618 if (!row
->reversed_p
)
14620 ellipsis_pos
= (glyph
- 1)->charpos
;
14621 while (glyph
> row
->glyphs
[TEXT_AREA
]
14622 && (glyph
- 1)->charpos
== ellipsis_pos
)
14623 glyph
--, x
-= glyph
->pixel_width
;
14624 /* That loop always goes one position too far, including
14625 the glyph before the ellipsis. So scan forward over
14627 x
+= glyph
->pixel_width
;
14630 else /* row is reversed */
14632 ellipsis_pos
= (glyph
+ 1)->charpos
;
14633 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14634 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14635 glyph
++, x
+= glyph
->pixel_width
;
14636 x
-= glyph
->pixel_width
;
14640 else if (match_with_avoid_cursor
)
14642 cursor
= glyph_after
;
14645 else if (string_seen
)
14647 int incr
= row
->reversed_p
? -1 : +1;
14649 /* Need to find the glyph that came out of a string which is
14650 present at point. That glyph is somewhere between
14651 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14652 positioned between POS_BEFORE and POS_AFTER in the
14654 struct glyph
*start
, *stop
;
14655 ptrdiff_t pos
= pos_before
;
14659 /* If the row ends in a newline from a display string,
14660 reordering could have moved the glyphs belonging to the
14661 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14662 in this case we extend the search to the last glyph in
14663 the row that was not inserted by redisplay. */
14664 if (row
->ends_in_newline_from_string_p
)
14667 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14670 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14671 correspond to POS_BEFORE and POS_AFTER, respectively. We
14672 need START and STOP in the order that corresponds to the
14673 row's direction as given by its reversed_p flag. If the
14674 directionality of characters between POS_BEFORE and
14675 POS_AFTER is the opposite of the row's base direction,
14676 these characters will have been reordered for display,
14677 and we need to reverse START and STOP. */
14678 if (!row
->reversed_p
)
14680 start
= min (glyph_before
, glyph_after
);
14681 stop
= max (glyph_before
, glyph_after
);
14685 start
= max (glyph_before
, glyph_after
);
14686 stop
= min (glyph_before
, glyph_after
);
14688 for (glyph
= start
+ incr
;
14689 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14692 /* Any glyphs that come from the buffer are here because
14693 of bidi reordering. Skip them, and only pay
14694 attention to glyphs that came from some string. */
14695 if (STRINGP (glyph
->object
))
14699 /* If the display property covers the newline, we
14700 need to search for it one position farther. */
14701 ptrdiff_t lim
= pos_after
14702 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14704 string_from_text_prop
= false;
14705 str
= glyph
->object
;
14706 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14707 if (tem
== 0 /* from overlay */
14710 /* If the string from which this glyph came is
14711 found in the buffer at point, or at position
14712 that is closer to point than pos_after, then
14713 we've found the glyph we've been looking for.
14714 If it comes from an overlay (tem == 0), and
14715 it has the `cursor' property on one of its
14716 glyphs, record that glyph as a candidate for
14717 displaying the cursor. (As in the
14718 unidirectional version, we will display the
14719 cursor on the last candidate we find.) */
14722 || (tem
- pt_old
> 0 && tem
< pos_after
))
14724 /* The glyphs from this string could have
14725 been reordered. Find the one with the
14726 smallest string position. Or there could
14727 be a character in the string with the
14728 `cursor' property, which means display
14729 cursor on that character's glyph. */
14730 ptrdiff_t strpos
= glyph
->charpos
;
14735 string_from_text_prop
= true;
14738 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14739 && EQ (glyph
->object
, str
);
14743 ptrdiff_t gpos
= glyph
->charpos
;
14745 cprop
= Fget_char_property (make_number (gpos
),
14753 if (tem
&& glyph
->charpos
< strpos
)
14755 strpos
= glyph
->charpos
;
14761 || (tem
- pt_old
> 0 && tem
< pos_after
))
14765 pos
= tem
+ 1; /* don't find previous instances */
14767 /* This string is not what we want; skip all of the
14768 glyphs that came from it. */
14769 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14770 && EQ (glyph
->object
, str
))
14777 /* If we reached the end of the line, and END was from a string,
14778 the cursor is not on this line. */
14780 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14781 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14782 && STRINGP (end
->object
)
14783 && row
->continued_p
)
14786 /* A truncated row may not include PT among its character positions.
14787 Setting the cursor inside the scroll margin will trigger
14788 recalculation of hscroll in hscroll_window_tree. But if a
14789 display string covers point, defer to the string-handling
14790 code below to figure this out. */
14791 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14793 cursor
= glyph_before
;
14796 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14797 /* Zero-width characters produce no glyphs. */
14799 && (row
->reversed_p
14800 ? glyph_after
> glyphs_end
14801 : glyph_after
< glyphs_end
)))
14803 cursor
= glyph_after
;
14809 if (cursor
!= NULL
)
14811 else if (glyph
== glyphs_end
14812 && pos_before
== pos_after
14813 && STRINGP ((row
->reversed_p
14814 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14815 : row
->glyphs
[TEXT_AREA
])->object
))
14817 /* If all the glyphs of this row came from strings, put the
14818 cursor on the first glyph of the row. This avoids having the
14819 cursor outside of the text area in this very rare and hard
14823 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14824 : row
->glyphs
[TEXT_AREA
];
14830 /* Need to compute x that corresponds to GLYPH. */
14831 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14833 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14835 x
+= g
->pixel_width
;
14839 /* ROW could be part of a continued line, which, under bidi
14840 reordering, might have other rows whose start and end charpos
14841 occlude point. Only set w->cursor if we found a better
14842 approximation to the cursor position than we have from previously
14843 examined candidate rows belonging to the same continued line. */
14844 if (/* We already have a candidate row. */
14845 w
->cursor
.vpos
>= 0
14846 /* That candidate is not the row we are processing. */
14847 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14848 /* Make sure cursor.vpos specifies a row whose start and end
14849 charpos occlude point, and it is valid candidate for being a
14850 cursor-row. This is because some callers of this function
14851 leave cursor.vpos at the row where the cursor was displayed
14852 during the last redisplay cycle. */
14853 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14854 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14855 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14858 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14860 /* Don't consider glyphs that are outside TEXT_AREA. */
14861 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14863 /* Keep the candidate whose buffer position is the closest to
14864 point or has the `cursor' property. */
14865 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14866 w
->cursor
.hpos
>= 0
14867 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14868 && ((BUFFERP (g1
->object
)
14869 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14870 || (BUFFERP (glyph
->object
)
14871 && eabs (g1
->charpos
- pt_old
)
14872 < eabs (glyph
->charpos
- pt_old
))))
14873 /* Previous candidate is a glyph from a string that has
14874 a non-nil `cursor' property. */
14875 || (STRINGP (g1
->object
)
14876 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14877 Qcursor
, g1
->object
))
14878 /* Previous candidate is from the same display
14879 string as this one, and the display string
14880 came from a text property. */
14881 || (EQ (g1
->object
, glyph
->object
)
14882 && string_from_text_prop
)
14883 /* this candidate is from newline and its
14884 position is not an exact match */
14885 || (NILP (glyph
->object
)
14886 && glyph
->charpos
!= pt_old
)))))
14888 /* If this candidate gives an exact match, use that. */
14889 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14890 /* If this candidate is a glyph created for the
14891 terminating newline of a line, and point is on that
14892 newline, it wins because it's an exact match. */
14893 || (!row
->continued_p
14894 && NILP (glyph
->object
)
14895 && glyph
->charpos
== 0
14896 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14897 /* Otherwise, keep the candidate that comes from a row
14898 spanning less buffer positions. This may win when one or
14899 both candidate positions are on glyphs that came from
14900 display strings, for which we cannot compare buffer
14902 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14903 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14904 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14907 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14909 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14910 w
->cursor
.y
= row
->y
+ dy
;
14912 if (w
== XWINDOW (selected_window
))
14914 if (!row
->continued_p
14915 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14918 this_line_buffer
= XBUFFER (w
->contents
);
14920 CHARPOS (this_line_start_pos
)
14921 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14922 BYTEPOS (this_line_start_pos
)
14923 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14925 CHARPOS (this_line_end_pos
)
14926 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14927 BYTEPOS (this_line_end_pos
)
14928 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14930 this_line_y
= w
->cursor
.y
;
14931 this_line_pixel_height
= row
->height
;
14932 this_line_vpos
= w
->cursor
.vpos
;
14933 this_line_start_x
= row
->x
;
14936 CHARPOS (this_line_start_pos
) = 0;
14943 /* Run window scroll functions, if any, for WINDOW with new window
14944 start STARTP. Sets the window start of WINDOW to that position.
14946 We assume that the window's buffer is really current. */
14948 static struct text_pos
14949 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14951 struct window
*w
= XWINDOW (window
);
14952 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14954 eassert (current_buffer
== XBUFFER (w
->contents
));
14956 if (!NILP (Vwindow_scroll_functions
))
14958 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14959 make_number (CHARPOS (startp
)));
14960 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14961 /* In case the hook functions switch buffers. */
14962 set_buffer_internal (XBUFFER (w
->contents
));
14969 /* Make sure the line containing the cursor is fully visible.
14970 A value of true means there is nothing to be done.
14971 (Either the line is fully visible, or it cannot be made so,
14972 or we cannot tell.)
14974 If FORCE_P, return false even if partial visible cursor row
14975 is higher than window.
14977 If CURRENT_MATRIX_P, use the information from the
14978 window's current glyph matrix; otherwise use the desired glyph
14981 A value of false means the caller should do scrolling
14982 as if point had gone off the screen. */
14985 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14986 bool current_matrix_p
)
14988 struct glyph_matrix
*matrix
;
14989 struct glyph_row
*row
;
14992 if (!make_cursor_line_fully_visible_p
)
14995 /* It's not always possible to find the cursor, e.g, when a window
14996 is full of overlay strings. Don't do anything in that case. */
14997 if (w
->cursor
.vpos
< 0)
15000 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15001 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15003 /* If the cursor row is not partially visible, there's nothing to do. */
15004 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15007 /* If the row the cursor is in is taller than the window's height,
15008 it's not clear what to do, so do nothing. */
15009 window_height
= window_box_height (w
);
15010 if (row
->height
>= window_height
)
15012 if (!force_p
|| MINI_WINDOW_P (w
)
15013 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15020 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15021 means only WINDOW is redisplayed in redisplay_internal.
15022 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15023 in redisplay_window to bring a partially visible line into view in
15024 the case that only the cursor has moved.
15026 LAST_LINE_MISFIT should be true if we're scrolling because the
15027 last screen line's vertical height extends past the end of the screen.
15031 1 if scrolling succeeded
15033 0 if scrolling didn't find point.
15035 -1 if new fonts have been loaded so that we must interrupt
15036 redisplay, adjust glyph matrices, and try again. */
15042 SCROLLING_NEED_LARGER_MATRICES
15045 /* If scroll-conservatively is more than this, never recenter.
15047 If you change this, don't forget to update the doc string of
15048 `scroll-conservatively' and the Emacs manual. */
15049 #define SCROLL_LIMIT 100
15052 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15053 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15054 bool temp_scroll_step
, bool last_line_misfit
)
15056 struct window
*w
= XWINDOW (window
);
15057 struct frame
*f
= XFRAME (w
->frame
);
15058 struct text_pos pos
, startp
;
15060 int this_scroll_margin
, scroll_max
, rc
, height
;
15061 int dy
= 0, amount_to_scroll
= 0;
15062 bool scroll_down_p
= false;
15063 int extra_scroll_margin_lines
= last_line_misfit
;
15064 Lisp_Object aggressive
;
15065 /* We will never try scrolling more than this number of lines. */
15066 int scroll_limit
= SCROLL_LIMIT
;
15067 int frame_line_height
= default_line_pixel_height (w
);
15068 int window_total_lines
15069 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15072 debug_method_add (w
, "try_scrolling");
15075 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15077 /* Compute scroll margin height in pixels. We scroll when point is
15078 within this distance from the top or bottom of the window. */
15079 if (scroll_margin
> 0)
15080 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15081 * frame_line_height
;
15083 this_scroll_margin
= 0;
15085 /* Force arg_scroll_conservatively to have a reasonable value, to
15086 avoid scrolling too far away with slow move_it_* functions. Note
15087 that the user can supply scroll-conservatively equal to
15088 `most-positive-fixnum', which can be larger than INT_MAX. */
15089 if (arg_scroll_conservatively
> scroll_limit
)
15091 arg_scroll_conservatively
= scroll_limit
+ 1;
15092 scroll_max
= scroll_limit
* frame_line_height
;
15094 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15095 /* Compute how much we should try to scroll maximally to bring
15096 point into view. */
15097 scroll_max
= (max (scroll_step
,
15098 max (arg_scroll_conservatively
, temp_scroll_step
))
15099 * frame_line_height
);
15100 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15101 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15102 /* We're trying to scroll because of aggressive scrolling but no
15103 scroll_step is set. Choose an arbitrary one. */
15104 scroll_max
= 10 * frame_line_height
;
15110 /* Decide whether to scroll down. */
15111 if (PT
> CHARPOS (startp
))
15113 int scroll_margin_y
;
15115 /* Compute the pixel ypos of the scroll margin, then move IT to
15116 either that ypos or PT, whichever comes first. */
15117 start_display (&it
, w
, startp
);
15118 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15119 - frame_line_height
* extra_scroll_margin_lines
;
15120 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15121 (MOVE_TO_POS
| MOVE_TO_Y
));
15123 if (PT
> CHARPOS (it
.current
.pos
))
15125 int y0
= line_bottom_y (&it
);
15126 /* Compute how many pixels below window bottom to stop searching
15127 for PT. This avoids costly search for PT that is far away if
15128 the user limited scrolling by a small number of lines, but
15129 always finds PT if scroll_conservatively is set to a large
15130 number, such as most-positive-fixnum. */
15131 int slack
= max (scroll_max
, 10 * frame_line_height
);
15132 int y_to_move
= it
.last_visible_y
+ slack
;
15134 /* Compute the distance from the scroll margin to PT or to
15135 the scroll limit, whichever comes first. This should
15136 include the height of the cursor line, to make that line
15138 move_it_to (&it
, PT
, -1, y_to_move
,
15139 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15140 dy
= line_bottom_y (&it
) - y0
;
15142 if (dy
> scroll_max
)
15143 return SCROLLING_FAILED
;
15146 scroll_down_p
= true;
15152 /* Point is in or below the bottom scroll margin, so move the
15153 window start down. If scrolling conservatively, move it just
15154 enough down to make point visible. If scroll_step is set,
15155 move it down by scroll_step. */
15156 if (arg_scroll_conservatively
)
15158 = min (max (dy
, frame_line_height
),
15159 frame_line_height
* arg_scroll_conservatively
);
15160 else if (scroll_step
|| temp_scroll_step
)
15161 amount_to_scroll
= scroll_max
;
15164 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15165 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15166 if (NUMBERP (aggressive
))
15168 double float_amount
= XFLOATINT (aggressive
) * height
;
15169 int aggressive_scroll
= float_amount
;
15170 if (aggressive_scroll
== 0 && float_amount
> 0)
15171 aggressive_scroll
= 1;
15172 /* Don't let point enter the scroll margin near top of
15173 the window. This could happen if the value of
15174 scroll_up_aggressively is too large and there are
15175 non-zero margins, because scroll_up_aggressively
15176 means put point that fraction of window height
15177 _from_the_bottom_margin_. */
15178 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15179 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15180 amount_to_scroll
= dy
+ aggressive_scroll
;
15184 if (amount_to_scroll
<= 0)
15185 return SCROLLING_FAILED
;
15187 start_display (&it
, w
, startp
);
15188 if (arg_scroll_conservatively
<= scroll_limit
)
15189 move_it_vertically (&it
, amount_to_scroll
);
15192 /* Extra precision for users who set scroll-conservatively
15193 to a large number: make sure the amount we scroll
15194 the window start is never less than amount_to_scroll,
15195 which was computed as distance from window bottom to
15196 point. This matters when lines at window top and lines
15197 below window bottom have different height. */
15199 void *it1data
= NULL
;
15200 /* We use a temporary it1 because line_bottom_y can modify
15201 its argument, if it moves one line down; see there. */
15204 SAVE_IT (it1
, it
, it1data
);
15205 start_y
= line_bottom_y (&it1
);
15207 RESTORE_IT (&it
, &it
, it1data
);
15208 move_it_by_lines (&it
, 1);
15209 SAVE_IT (it1
, it
, it1data
);
15210 } while (IT_CHARPOS (it
) < ZV
15211 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15212 bidi_unshelve_cache (it1data
, true);
15215 /* If STARTP is unchanged, move it down another screen line. */
15216 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15217 move_it_by_lines (&it
, 1);
15218 startp
= it
.current
.pos
;
15222 struct text_pos scroll_margin_pos
= startp
;
15225 /* See if point is inside the scroll margin at the top of the
15227 if (this_scroll_margin
)
15231 start_display (&it
, w
, startp
);
15232 y_start
= it
.current_y
;
15233 move_it_vertically (&it
, this_scroll_margin
);
15234 scroll_margin_pos
= it
.current
.pos
;
15235 /* If we didn't move enough before hitting ZV, request
15236 additional amount of scroll, to move point out of the
15238 if (IT_CHARPOS (it
) == ZV
15239 && it
.current_y
- y_start
< this_scroll_margin
)
15240 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15243 if (PT
< CHARPOS (scroll_margin_pos
))
15245 /* Point is in the scroll margin at the top of the window or
15246 above what is displayed in the window. */
15249 /* Compute the vertical distance from PT to the scroll
15250 margin position. Move as far as scroll_max allows, or
15251 one screenful, or 10 screen lines, whichever is largest.
15252 Give up if distance is greater than scroll_max or if we
15253 didn't reach the scroll margin position. */
15254 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15255 start_display (&it
, w
, pos
);
15257 y_to_move
= max (it
.last_visible_y
,
15258 max (scroll_max
, 10 * frame_line_height
));
15259 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15261 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15262 dy
= it
.current_y
- y0
;
15263 if (dy
> scroll_max
15264 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15265 return SCROLLING_FAILED
;
15267 /* Additional scroll for when ZV was too close to point. */
15270 /* Compute new window start. */
15271 start_display (&it
, w
, startp
);
15273 if (arg_scroll_conservatively
)
15274 amount_to_scroll
= max (dy
, frame_line_height
15275 * max (scroll_step
, temp_scroll_step
));
15276 else if (scroll_step
|| temp_scroll_step
)
15277 amount_to_scroll
= scroll_max
;
15280 aggressive
= BVAR (current_buffer
, scroll_down_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
15289 bottom of the window, if the value of
15290 scroll_down_aggressively happens to be too
15292 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15293 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15294 amount_to_scroll
= dy
+ aggressive_scroll
;
15298 if (amount_to_scroll
<= 0)
15299 return SCROLLING_FAILED
;
15301 move_it_vertically_backward (&it
, amount_to_scroll
);
15302 startp
= it
.current
.pos
;
15306 /* Run window scroll functions. */
15307 startp
= run_window_scroll_functions (window
, startp
);
15309 /* Display the window. Give up if new fonts are loaded, or if point
15311 if (!try_window (window
, startp
, 0))
15312 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15313 else if (w
->cursor
.vpos
< 0)
15315 clear_glyph_matrix (w
->desired_matrix
);
15316 rc
= SCROLLING_FAILED
;
15320 /* Maybe forget recorded base line for line number display. */
15321 if (!just_this_one_p
15322 || current_buffer
->clip_changed
15323 || BEG_UNCHANGED
< CHARPOS (startp
))
15324 w
->base_line_number
= 0;
15326 /* If cursor ends up on a partially visible line,
15327 treat that as being off the bottom of the screen. */
15328 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15330 /* It's possible that the cursor is on the first line of the
15331 buffer, which is partially obscured due to a vscroll
15332 (Bug#7537). In that case, avoid looping forever. */
15333 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15335 clear_glyph_matrix (w
->desired_matrix
);
15336 ++extra_scroll_margin_lines
;
15339 rc
= SCROLLING_SUCCESS
;
15346 /* Compute a suitable window start for window W if display of W starts
15347 on a continuation line. Value is true if a new window start
15350 The new window start will be computed, based on W's width, starting
15351 from the start of the continued line. It is the start of the
15352 screen line with the minimum distance from the old start W->start. */
15355 compute_window_start_on_continuation_line (struct window
*w
)
15357 struct text_pos pos
, start_pos
;
15358 bool window_start_changed_p
= false;
15360 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15362 /* If window start is on a continuation line... Window start may be
15363 < BEGV in case there's invisible text at the start of the
15364 buffer (M-x rmail, for example). */
15365 if (CHARPOS (start_pos
) > BEGV
15366 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15369 struct glyph_row
*row
;
15371 /* Handle the case that the window start is out of range. */
15372 if (CHARPOS (start_pos
) < BEGV
)
15373 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15374 else if (CHARPOS (start_pos
) > ZV
)
15375 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15377 /* Find the start of the continued line. This should be fast
15378 because find_newline is fast (newline cache). */
15379 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15380 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15381 row
, DEFAULT_FACE_ID
);
15382 reseat_at_previous_visible_line_start (&it
);
15384 /* If the line start is "too far" away from the window start,
15385 say it takes too much time to compute a new window start. */
15386 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15387 /* PXW: Do we need upper bounds here? */
15388 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15390 int min_distance
, distance
;
15392 /* Move forward by display lines to find the new window
15393 start. If window width was enlarged, the new start can
15394 be expected to be > the old start. If window width was
15395 decreased, the new window start will be < the old start.
15396 So, we're looking for the display line start with the
15397 minimum distance from the old window start. */
15398 pos
= it
.current
.pos
;
15399 min_distance
= INFINITY
;
15400 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15401 distance
< min_distance
)
15403 min_distance
= distance
;
15404 pos
= it
.current
.pos
;
15405 if (it
.line_wrap
== WORD_WRAP
)
15407 /* Under WORD_WRAP, move_it_by_lines is likely to
15408 overshoot and stop not at the first, but the
15409 second character from the left margin. So in
15410 that case, we need a more tight control on the X
15411 coordinate of the iterator than move_it_by_lines
15412 promises in its contract. The method is to first
15413 go to the last (rightmost) visible character of a
15414 line, then move to the leftmost character on the
15415 next line in a separate call. */
15416 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15417 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15418 move_it_to (&it
, ZV
, 0,
15419 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15420 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15423 move_it_by_lines (&it
, 1);
15426 /* Set the window start there. */
15427 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15428 window_start_changed_p
= true;
15432 return window_start_changed_p
;
15436 /* Try cursor movement in case text has not changed in window WINDOW,
15437 with window start STARTP. Value is
15439 CURSOR_MOVEMENT_SUCCESS if successful
15441 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15443 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15444 display. *SCROLL_STEP is set to true, under certain circumstances, if
15445 we want to scroll as if scroll-step were set to 1. See the code.
15447 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15448 which case we have to abort this redisplay, and adjust matrices
15453 CURSOR_MOVEMENT_SUCCESS
,
15454 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15455 CURSOR_MOVEMENT_MUST_SCROLL
,
15456 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15460 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15463 struct window
*w
= XWINDOW (window
);
15464 struct frame
*f
= XFRAME (w
->frame
);
15465 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15468 if (inhibit_try_cursor_movement
)
15472 /* Previously, there was a check for Lisp integer in the
15473 if-statement below. Now, this field is converted to
15474 ptrdiff_t, thus zero means invalid position in a buffer. */
15475 eassert (w
->last_point
> 0);
15476 /* Likewise there was a check whether window_end_vpos is nil or larger
15477 than the window. Now window_end_vpos is int and so never nil, but
15478 let's leave eassert to check whether it fits in the window. */
15479 eassert (!w
->window_end_valid
15480 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15482 /* Handle case where text has not changed, only point, and it has
15483 not moved off the frame. */
15484 if (/* Point may be in this window. */
15485 PT
>= CHARPOS (startp
)
15486 /* Selective display hasn't changed. */
15487 && !current_buffer
->clip_changed
15488 /* Function force-mode-line-update is used to force a thorough
15489 redisplay. It sets either windows_or_buffers_changed or
15490 update_mode_lines. So don't take a shortcut here for these
15492 && !update_mode_lines
15493 && !windows_or_buffers_changed
15494 && !f
->cursor_type_changed
15495 && NILP (Vshow_trailing_whitespace
)
15496 /* This code is not used for mini-buffer for the sake of the case
15497 of redisplaying to replace an echo area message; since in
15498 that case the mini-buffer contents per se are usually
15499 unchanged. This code is of no real use in the mini-buffer
15500 since the handling of this_line_start_pos, etc., in redisplay
15501 handles the same cases. */
15502 && !EQ (window
, minibuf_window
)
15503 && (FRAME_WINDOW_P (f
)
15504 || !overlay_arrow_in_current_buffer_p ()))
15506 int this_scroll_margin
, top_scroll_margin
;
15507 struct glyph_row
*row
= NULL
;
15508 int frame_line_height
= default_line_pixel_height (w
);
15509 int window_total_lines
15510 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15513 debug_method_add (w
, "cursor movement");
15516 /* Scroll if point within this distance from the top or bottom
15517 of the window. This is a pixel value. */
15518 if (scroll_margin
> 0)
15520 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15521 this_scroll_margin
*= frame_line_height
;
15524 this_scroll_margin
= 0;
15526 top_scroll_margin
= this_scroll_margin
;
15527 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15528 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15530 /* Start with the row the cursor was displayed during the last
15531 not paused redisplay. Give up if that row is not valid. */
15532 if (w
->last_cursor_vpos
< 0
15533 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15534 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15537 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15538 if (row
->mode_line_p
)
15540 if (!row
->enabled_p
)
15541 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15544 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15546 bool scroll_p
= false, must_scroll
= false;
15547 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15549 if (PT
> w
->last_point
)
15551 /* Point has moved forward. */
15552 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15553 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15555 eassert (row
->enabled_p
);
15559 /* If the end position of a row equals the start
15560 position of the next row, and PT is at that position,
15561 we would rather display cursor in the next line. */
15562 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15563 && MATRIX_ROW_END_CHARPOS (row
) == PT
15564 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15565 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15566 && !cursor_row_p (row
))
15569 /* If within the scroll margin, scroll. Note that
15570 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15571 the next line would be drawn, and that
15572 this_scroll_margin can be zero. */
15573 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15574 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15575 /* Line is completely visible last line in window
15576 and PT is to be set in the next line. */
15577 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15578 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15579 && !row
->ends_at_zv_p
15580 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15583 else if (PT
< w
->last_point
)
15585 /* Cursor has to be moved backward. Note that PT >=
15586 CHARPOS (startp) because of the outer if-statement. */
15587 while (!row
->mode_line_p
15588 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15589 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15590 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15591 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15592 row
> w
->current_matrix
->rows
15593 && (row
-1)->ends_in_newline_from_string_p
))))
15594 && (row
->y
> top_scroll_margin
15595 || CHARPOS (startp
) == BEGV
))
15597 eassert (row
->enabled_p
);
15601 /* Consider the following case: Window starts at BEGV,
15602 there is invisible, intangible text at BEGV, so that
15603 display starts at some point START > BEGV. It can
15604 happen that we are called with PT somewhere between
15605 BEGV and START. Try to handle that case. */
15606 if (row
< w
->current_matrix
->rows
15607 || row
->mode_line_p
)
15609 row
= w
->current_matrix
->rows
;
15610 if (row
->mode_line_p
)
15614 /* Due to newlines in overlay strings, we may have to
15615 skip forward over overlay strings. */
15616 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15617 && MATRIX_ROW_END_CHARPOS (row
) == PT
15618 && !cursor_row_p (row
))
15621 /* If within the scroll margin, scroll. */
15622 if (row
->y
< top_scroll_margin
15623 && CHARPOS (startp
) != BEGV
)
15628 /* Cursor did not move. So don't scroll even if cursor line
15629 is partially visible, as it was so before. */
15630 rc
= CURSOR_MOVEMENT_SUCCESS
;
15633 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15634 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15636 /* if PT is not in the glyph row, give up. */
15637 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15638 must_scroll
= true;
15640 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15641 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15643 struct glyph_row
*row1
;
15645 /* If rows are bidi-reordered and point moved, back up
15646 until we find a row that does not belong to a
15647 continuation line. This is because we must consider
15648 all rows of a continued line as candidates for the
15649 new cursor positioning, since row start and end
15650 positions change non-linearly with vertical position
15652 /* FIXME: Revisit this when glyph ``spilling'' in
15653 continuation lines' rows is implemented for
15654 bidi-reordered rows. */
15655 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15656 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15659 /* If we hit the beginning of the displayed portion
15660 without finding the first row of a continued
15664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15667 eassert (row
->enabled_p
);
15672 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15673 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15674 /* Make sure this isn't a header line by any chance, since
15675 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15676 && !row
->mode_line_p
15677 && make_cursor_line_fully_visible_p
)
15679 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15680 && !row
->ends_at_zv_p
15681 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15682 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15683 else if (row
->height
> window_box_height (w
))
15685 /* If we end up in a partially visible line, let's
15686 make it fully visible, except when it's taller
15687 than the window, in which case we can't do much
15689 *scroll_step
= true;
15690 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15694 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15695 if (!cursor_row_fully_visible_p (w
, false, true))
15696 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15698 rc
= CURSOR_MOVEMENT_SUCCESS
;
15702 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15703 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15704 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15706 /* With bidi-reordered rows, there could be more than
15707 one candidate row whose start and end positions
15708 occlude point. We need to let set_cursor_from_row
15709 find the best candidate. */
15710 /* FIXME: Revisit this when glyph ``spilling'' in
15711 continuation lines' rows is implemented for
15712 bidi-reordered rows. */
15717 bool at_zv_p
= false, exact_match_p
= false;
15719 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15720 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15721 && cursor_row_p (row
))
15722 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15724 /* As soon as we've found the exact match for point,
15725 or the first suitable row whose ends_at_zv_p flag
15726 is set, we are done. */
15729 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15730 w
->cursor
.vpos
)->ends_at_zv_p
;
15732 && w
->cursor
.hpos
>= 0
15733 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15736 struct glyph_row
*candidate
=
15737 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15739 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15740 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15743 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15744 || (NILP (g
->object
)
15745 && (g
->charpos
== PT
15746 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15748 if (at_zv_p
|| exact_match_p
)
15750 rc
= CURSOR_MOVEMENT_SUCCESS
;
15754 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15758 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15759 || row
->continued_p
)
15760 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15761 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15762 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15763 /* If we didn't find any candidate rows, or exited the
15764 loop before all the candidates were examined, signal
15765 to the caller that this method failed. */
15766 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15768 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15769 && !row
->continued_p
))
15770 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15772 rc
= CURSOR_MOVEMENT_SUCCESS
;
15778 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15780 rc
= CURSOR_MOVEMENT_SUCCESS
;
15785 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15786 && MATRIX_ROW_START_CHARPOS (row
) == PT
15787 && cursor_row_p (row
));
15797 set_vertical_scroll_bar (struct window
*w
)
15799 ptrdiff_t start
, end
, whole
;
15801 /* Calculate the start and end positions for the current window.
15802 At some point, it would be nice to choose between scrollbars
15803 which reflect the whole buffer size, with special markers
15804 indicating narrowing, and scrollbars which reflect only the
15807 Note that mini-buffers sometimes aren't displaying any text. */
15808 if (!MINI_WINDOW_P (w
)
15809 || (w
== XWINDOW (minibuf_window
)
15810 && NILP (echo_area_buffer
[0])))
15812 struct buffer
*buf
= XBUFFER (w
->contents
);
15813 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15814 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15815 /* I don't think this is guaranteed to be right. For the
15816 moment, we'll pretend it is. */
15817 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15821 if (whole
< (end
- start
))
15822 whole
= end
- start
;
15825 start
= end
= whole
= 0;
15827 /* Indicate what this scroll bar ought to be displaying now. */
15828 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15829 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15830 (w
, end
- start
, whole
, start
);
15835 set_horizontal_scroll_bar (struct window
*w
)
15837 int start
, end
, whole
, portion
;
15839 if (!MINI_WINDOW_P (w
)
15840 || (w
== XWINDOW (minibuf_window
)
15841 && NILP (echo_area_buffer
[0])))
15843 struct buffer
*b
= XBUFFER (w
->contents
);
15844 struct buffer
*old_buffer
= NULL
;
15846 struct text_pos startp
;
15848 if (b
!= current_buffer
)
15850 old_buffer
= current_buffer
;
15851 set_buffer_internal (b
);
15854 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15855 start_display (&it
, w
, startp
);
15856 it
.last_visible_x
= INT_MAX
;
15857 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15858 MOVE_TO_X
| MOVE_TO_Y
);
15859 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15860 window_box_height (w), -1,
15861 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15863 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15864 end
= start
+ window_box_width (w
, TEXT_AREA
);
15865 portion
= end
- start
;
15866 /* After enlarging a horizontally scrolled window such that it
15867 gets at least as wide as the text it contains, make sure that
15868 the thumb doesn't fill the entire scroll bar so we can still
15869 drag it back to see the entire text. */
15870 whole
= max (whole
, end
);
15876 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15877 if (EQ (pdir
, Qright_to_left
))
15879 start
= whole
- end
;
15880 end
= start
+ portion
;
15885 set_buffer_internal (old_buffer
);
15888 start
= end
= whole
= portion
= 0;
15890 w
->hscroll_whole
= whole
;
15892 /* Indicate what this scroll bar ought to be displaying now. */
15893 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15894 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15895 (w
, portion
, whole
, start
);
15899 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15900 selected_window is redisplayed.
15902 We can return without actually redisplaying the window if fonts has been
15903 changed on window's frame. In that case, redisplay_internal will retry.
15905 As one of the important parts of redisplaying a window, we need to
15906 decide whether the previous window-start position (stored in the
15907 window's w->start marker position) is still valid, and if it isn't,
15908 recompute it. Some details about that:
15910 . The previous window-start could be in a continuation line, in
15911 which case we need to recompute it when the window width
15912 changes. See compute_window_start_on_continuation_line and its
15915 . The text that changed since last redisplay could include the
15916 previous window-start position. In that case, we try to salvage
15917 what we can from the current glyph matrix by calling
15918 try_scrolling, which see.
15920 . Some Emacs command could force us to use a specific window-start
15921 position by setting the window's force_start flag, or gently
15922 propose doing that by setting the window's optional_new_start
15923 flag. In these cases, we try using the specified start point if
15924 that succeeds (i.e. the window desired matrix is successfully
15925 recomputed, and point location is within the window). In case
15926 of optional_new_start, we first check if the specified start
15927 position is feasible, i.e. if it will allow point to be
15928 displayed in the window. If using the specified start point
15929 fails, e.g., if new fonts are needed to be loaded, we abort the
15930 redisplay cycle and leave it up to the next cycle to figure out
15933 . Note that the window's force_start flag is sometimes set by
15934 redisplay itself, when it decides that the previous window start
15935 point is fine and should be kept. Search for "goto force_start"
15936 below to see the details. Like the values of window-start
15937 specified outside of redisplay, these internally-deduced values
15938 are tested for feasibility, and ignored if found to be
15941 . Note that the function try_window, used to completely redisplay
15942 a window, accepts the window's start point as its argument.
15943 This is used several times in the redisplay code to control
15944 where the window start will be, according to user options such
15945 as scroll-conservatively, and also to ensure the screen line
15946 showing point will be fully (as opposed to partially) visible on
15950 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15952 struct window
*w
= XWINDOW (window
);
15953 struct frame
*f
= XFRAME (w
->frame
);
15954 struct buffer
*buffer
= XBUFFER (w
->contents
);
15955 struct buffer
*old
= current_buffer
;
15956 struct text_pos lpoint
, opoint
, startp
;
15957 bool update_mode_line
;
15960 /* Record it now because it's overwritten. */
15961 bool current_matrix_up_to_date_p
= false;
15962 bool used_current_matrix_p
= false;
15963 /* This is less strict than current_matrix_up_to_date_p.
15964 It indicates that the buffer contents and narrowing are unchanged. */
15965 bool buffer_unchanged_p
= false;
15966 bool temp_scroll_step
= false;
15967 ptrdiff_t count
= SPECPDL_INDEX ();
15969 int centering_position
= -1;
15970 bool last_line_misfit
= false;
15971 ptrdiff_t beg_unchanged
, end_unchanged
;
15972 int frame_line_height
;
15974 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15978 *w
->desired_matrix
->method
= 0;
15981 if (!just_this_one_p
15982 && REDISPLAY_SOME_P ()
15984 && !w
->update_mode_line
15987 && !buffer
->text
->redisplay
15988 && BUF_PT (buffer
) == w
->last_point
)
15991 /* Make sure that both W's markers are valid. */
15992 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15993 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15995 /* We come here again if we need to run window-text-change-functions
15998 reconsider_clip_changes (w
);
15999 frame_line_height
= default_line_pixel_height (w
);
16001 /* Has the mode line to be updated? */
16002 update_mode_line
= (w
->update_mode_line
16003 || update_mode_lines
16004 || buffer
->clip_changed
16005 || buffer
->prevent_redisplay_optimizations_p
);
16007 if (!just_this_one_p
)
16008 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16009 cleverly elsewhere. */
16010 w
->must_be_updated_p
= true;
16012 if (MINI_WINDOW_P (w
))
16014 if (w
== XWINDOW (echo_area_window
)
16015 && !NILP (echo_area_buffer
[0]))
16017 if (update_mode_line
)
16018 /* We may have to update a tty frame's menu bar or a
16019 tool-bar. Example `M-x C-h C-h C-g'. */
16020 goto finish_menu_bars
;
16022 /* We've already displayed the echo area glyphs in this window. */
16023 goto finish_scroll_bars
;
16025 else if ((w
!= XWINDOW (minibuf_window
)
16026 || minibuf_level
== 0)
16027 /* When buffer is nonempty, redisplay window normally. */
16028 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16029 /* Quail displays non-mini buffers in minibuffer window.
16030 In that case, redisplay the window normally. */
16031 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16033 /* W is a mini-buffer window, but it's not active, so clear
16035 int yb
= window_text_bottom_y (w
);
16036 struct glyph_row
*row
;
16039 for (y
= 0, row
= w
->desired_matrix
->rows
;
16041 y
+= row
->height
, ++row
)
16042 blank_row (w
, row
, y
);
16043 goto finish_scroll_bars
;
16046 clear_glyph_matrix (w
->desired_matrix
);
16049 /* Otherwise set up data on this window; select its buffer and point
16051 /* Really select the buffer, for the sake of buffer-local
16053 set_buffer_internal_1 (XBUFFER (w
->contents
));
16055 current_matrix_up_to_date_p
16056 = (w
->window_end_valid
16057 && !current_buffer
->clip_changed
16058 && !current_buffer
->prevent_redisplay_optimizations_p
16059 && !window_outdated (w
));
16061 /* Run the window-text-change-functions
16062 if it is possible that the text on the screen has changed
16063 (either due to modification of the text, or any other reason). */
16064 if (!current_matrix_up_to_date_p
16065 && !NILP (Vwindow_text_change_functions
))
16067 safe_run_hooks (Qwindow_text_change_functions
);
16071 beg_unchanged
= BEG_UNCHANGED
;
16072 end_unchanged
= END_UNCHANGED
;
16074 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16076 specbind (Qinhibit_point_motion_hooks
, Qt
);
16079 = (w
->window_end_valid
16080 && !current_buffer
->clip_changed
16081 && !window_outdated (w
));
16083 /* When windows_or_buffers_changed is non-zero, we can't rely
16084 on the window end being valid, so set it to zero there. */
16085 if (windows_or_buffers_changed
)
16087 /* If window starts on a continuation line, maybe adjust the
16088 window start in case the window's width changed. */
16089 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16090 compute_window_start_on_continuation_line (w
);
16092 w
->window_end_valid
= false;
16093 /* If so, we also can't rely on current matrix
16094 and should not fool try_cursor_movement below. */
16095 current_matrix_up_to_date_p
= false;
16098 /* Some sanity checks. */
16099 CHECK_WINDOW_END (w
);
16100 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16102 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16105 if (mode_line_update_needed (w
))
16106 update_mode_line
= true;
16108 /* Point refers normally to the selected window. For any other
16109 window, set up appropriate value. */
16110 if (!EQ (window
, selected_window
))
16112 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16113 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16118 new_pt_byte
= BEGV_BYTE
;
16119 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16121 else if (new_pt
> (ZV
- 1))
16124 new_pt_byte
= ZV_BYTE
;
16125 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16128 /* We don't use SET_PT so that the point-motion hooks don't run. */
16129 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16132 /* If any of the character widths specified in the display table
16133 have changed, invalidate the width run cache. It's true that
16134 this may be a bit late to catch such changes, but the rest of
16135 redisplay goes (non-fatally) haywire when the display table is
16136 changed, so why should we worry about doing any better? */
16137 if (current_buffer
->width_run_cache
16138 || (current_buffer
->base_buffer
16139 && current_buffer
->base_buffer
->width_run_cache
))
16141 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16143 if (! disptab_matches_widthtab
16144 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16146 struct buffer
*buf
= current_buffer
;
16148 if (buf
->base_buffer
)
16149 buf
= buf
->base_buffer
;
16150 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16151 recompute_width_table (current_buffer
, disptab
);
16155 /* If window-start is screwed up, choose a new one. */
16156 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16159 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16161 /* If someone specified a new starting point but did not insist,
16162 check whether it can be used. */
16163 if ((w
->optional_new_start
|| window_frozen_p (w
))
16164 && CHARPOS (startp
) >= BEGV
16165 && CHARPOS (startp
) <= ZV
)
16167 ptrdiff_t it_charpos
;
16169 w
->optional_new_start
= false;
16170 start_display (&it
, w
, startp
);
16171 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16172 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16173 /* Record IT's position now, since line_bottom_y might change
16175 it_charpos
= IT_CHARPOS (it
);
16176 /* Make sure we set the force_start flag only if the cursor row
16177 will be fully visible. Otherwise, the code under force_start
16178 label below will try to move point back into view, which is
16179 not what the code which sets optional_new_start wants. */
16180 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16181 && !w
->force_start
)
16183 if (it_charpos
== PT
)
16184 w
->force_start
= true;
16185 /* IT may overshoot PT if text at PT is invisible. */
16186 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16187 w
->force_start
= true;
16189 if (w
->force_start
)
16191 if (window_frozen_p (w
))
16192 debug_method_add (w
, "set force_start from frozen window start");
16194 debug_method_add (w
, "set force_start from optional_new_start");
16202 /* Handle case where place to start displaying has been specified,
16203 unless the specified location is outside the accessible range. */
16204 if (w
->force_start
)
16206 /* We set this later on if we have to adjust point. */
16209 w
->force_start
= false;
16211 w
->window_end_valid
= false;
16213 /* Forget any recorded base line for line number display. */
16214 if (!buffer_unchanged_p
)
16215 w
->base_line_number
= 0;
16217 /* Redisplay the mode line. Select the buffer properly for that.
16218 Also, run the hook window-scroll-functions
16219 because we have scrolled. */
16220 /* Note, we do this after clearing force_start because
16221 if there's an error, it is better to forget about force_start
16222 than to get into an infinite loop calling the hook functions
16223 and having them get more errors. */
16224 if (!update_mode_line
16225 || ! NILP (Vwindow_scroll_functions
))
16227 update_mode_line
= true;
16228 w
->update_mode_line
= true;
16229 startp
= run_window_scroll_functions (window
, startp
);
16232 if (CHARPOS (startp
) < BEGV
)
16233 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16234 else if (CHARPOS (startp
) > ZV
)
16235 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16237 /* Redisplay, then check if cursor has been set during the
16238 redisplay. Give up if new fonts were loaded. */
16239 /* We used to issue a CHECK_MARGINS argument to try_window here,
16240 but this causes scrolling to fail when point begins inside
16241 the scroll margin (bug#148) -- cyd */
16242 if (!try_window (window
, startp
, 0))
16244 w
->force_start
= true;
16245 clear_glyph_matrix (w
->desired_matrix
);
16246 goto need_larger_matrices
;
16249 if (w
->cursor
.vpos
< 0)
16251 /* If point does not appear, try to move point so it does
16252 appear. The desired matrix has been built above, so we
16253 can use it here. */
16254 new_vpos
= window_box_height (w
) / 2;
16257 if (!cursor_row_fully_visible_p (w
, false, false))
16259 /* Point does appear, but on a line partly visible at end of window.
16260 Move it back to a fully-visible line. */
16261 new_vpos
= window_box_height (w
);
16262 /* But if window_box_height suggests a Y coordinate that is
16263 not less than we already have, that line will clearly not
16264 be fully visible, so give up and scroll the display.
16265 This can happen when the default face uses a font whose
16266 dimensions are different from the frame's default
16268 if (new_vpos
>= w
->cursor
.y
)
16270 w
->cursor
.vpos
= -1;
16271 clear_glyph_matrix (w
->desired_matrix
);
16272 goto try_to_scroll
;
16275 else if (w
->cursor
.vpos
>= 0)
16277 /* Some people insist on not letting point enter the scroll
16278 margin, even though this part handles windows that didn't
16280 int window_total_lines
16281 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16282 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16283 int pixel_margin
= margin
* frame_line_height
;
16284 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16286 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16287 below, which finds the row to move point to, advances by
16288 the Y coordinate of the _next_ row, see the definition of
16289 MATRIX_ROW_BOTTOM_Y. */
16290 if (w
->cursor
.vpos
< margin
+ header_line
)
16292 w
->cursor
.vpos
= -1;
16293 clear_glyph_matrix (w
->desired_matrix
);
16294 goto try_to_scroll
;
16298 int window_height
= window_box_height (w
);
16301 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16302 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16304 w
->cursor
.vpos
= -1;
16305 clear_glyph_matrix (w
->desired_matrix
);
16306 goto try_to_scroll
;
16311 /* If we need to move point for either of the above reasons,
16312 now actually do it. */
16315 struct glyph_row
*row
;
16317 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16318 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16321 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16322 MATRIX_ROW_START_BYTEPOS (row
));
16324 if (w
!= XWINDOW (selected_window
))
16325 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16326 else if (current_buffer
== old
)
16327 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16329 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16331 /* Re-run pre-redisplay-function so it can update the region
16332 according to the new position of point. */
16333 /* Other than the cursor, w's redisplay is done so we can set its
16334 redisplay to false. Also the buffer's redisplay can be set to
16335 false, since propagate_buffer_redisplay should have already
16336 propagated its info to `w' anyway. */
16337 w
->redisplay
= false;
16338 XBUFFER (w
->contents
)->text
->redisplay
= false;
16339 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16341 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16343 /* pre-redisplay-function made changes (e.g. move the region)
16344 that require another round of redisplay. */
16345 clear_glyph_matrix (w
->desired_matrix
);
16346 if (!try_window (window
, startp
, 0))
16347 goto need_larger_matrices
;
16350 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16352 clear_glyph_matrix (w
->desired_matrix
);
16353 goto try_to_scroll
;
16357 debug_method_add (w
, "forced window start");
16362 /* Handle case where text has not changed, only point, and it has
16363 not moved off the frame, and we are not retrying after hscroll.
16364 (current_matrix_up_to_date_p is true when retrying.) */
16365 if (current_matrix_up_to_date_p
16366 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16367 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16371 case CURSOR_MOVEMENT_SUCCESS
:
16372 used_current_matrix_p
= true;
16375 case CURSOR_MOVEMENT_MUST_SCROLL
:
16376 goto try_to_scroll
;
16382 /* If current starting point was originally the beginning of a line
16383 but no longer is, find a new starting point. */
16384 else if (w
->start_at_line_beg
16385 && !(CHARPOS (startp
) <= BEGV
16386 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16389 debug_method_add (w
, "recenter 1");
16394 /* Try scrolling with try_window_id. Value is > 0 if update has
16395 been done, it is -1 if we know that the same window start will
16396 not work. It is 0 if unsuccessful for some other reason. */
16397 else if ((tem
= try_window_id (w
)) != 0)
16400 debug_method_add (w
, "try_window_id %d", tem
);
16403 if (f
->fonts_changed
)
16404 goto need_larger_matrices
;
16408 /* Otherwise try_window_id has returned -1 which means that we
16409 don't want the alternative below this comment to execute. */
16411 else if (CHARPOS (startp
) >= BEGV
16412 && CHARPOS (startp
) <= ZV
16413 && PT
>= CHARPOS (startp
)
16414 && (CHARPOS (startp
) < ZV
16415 /* Avoid starting at end of buffer. */
16416 || CHARPOS (startp
) == BEGV
16417 || !window_outdated (w
)))
16419 int d1
, d2
, d5
, d6
;
16422 /* If first window line is a continuation line, and window start
16423 is inside the modified region, but the first change is before
16424 current window start, we must select a new window start.
16426 However, if this is the result of a down-mouse event (e.g. by
16427 extending the mouse-drag-overlay), we don't want to select a
16428 new window start, since that would change the position under
16429 the mouse, resulting in an unwanted mouse-movement rather
16430 than a simple mouse-click. */
16431 if (!w
->start_at_line_beg
16432 && NILP (do_mouse_tracking
)
16433 && CHARPOS (startp
) > BEGV
16434 && CHARPOS (startp
) > BEG
+ beg_unchanged
16435 && CHARPOS (startp
) <= Z
- end_unchanged
16436 /* Even if w->start_at_line_beg is nil, a new window may
16437 start at a line_beg, since that's how set_buffer_window
16438 sets it. So, we need to check the return value of
16439 compute_window_start_on_continuation_line. (See also
16441 && XMARKER (w
->start
)->buffer
== current_buffer
16442 && compute_window_start_on_continuation_line (w
)
16443 /* It doesn't make sense to force the window start like we
16444 do at label force_start if it is already known that point
16445 will not be fully visible in the resulting window, because
16446 doing so will move point from its correct position
16447 instead of scrolling the window to bring point into view.
16449 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16450 /* A very tall row could need more than the window height,
16451 in which case we accept that it is partially visible. */
16452 && (rtop
!= 0) == (rbot
!= 0))
16454 w
->force_start
= true;
16455 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16457 debug_method_add (w
, "recomputed window start in continuation line");
16463 debug_method_add (w
, "same window start");
16466 /* Try to redisplay starting at same place as before.
16467 If point has not moved off frame, accept the results. */
16468 if (!current_matrix_up_to_date_p
16469 /* Don't use try_window_reusing_current_matrix in this case
16470 because a window scroll function can have changed the
16472 || !NILP (Vwindow_scroll_functions
)
16473 || MINI_WINDOW_P (w
)
16474 || !(used_current_matrix_p
16475 = try_window_reusing_current_matrix (w
)))
16477 IF_DEBUG (debug_method_add (w
, "1"));
16478 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16479 /* -1 means we need to scroll.
16480 0 means we need new matrices, but fonts_changed
16481 is set in that case, so we will detect it below. */
16482 goto try_to_scroll
;
16485 if (f
->fonts_changed
)
16486 goto need_larger_matrices
;
16488 if (w
->cursor
.vpos
>= 0)
16490 if (!just_this_one_p
16491 || current_buffer
->clip_changed
16492 || BEG_UNCHANGED
< CHARPOS (startp
))
16493 /* Forget any recorded base line for line number display. */
16494 w
->base_line_number
= 0;
16496 if (!cursor_row_fully_visible_p (w
, true, false))
16498 clear_glyph_matrix (w
->desired_matrix
);
16499 last_line_misfit
= true;
16501 /* Drop through and scroll. */
16506 clear_glyph_matrix (w
->desired_matrix
);
16511 /* Redisplay the mode line. Select the buffer properly for that. */
16512 if (!update_mode_line
)
16514 update_mode_line
= true;
16515 w
->update_mode_line
= true;
16518 /* Try to scroll by specified few lines. */
16519 if ((scroll_conservatively
16520 || emacs_scroll_step
16521 || temp_scroll_step
16522 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16523 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16524 && CHARPOS (startp
) >= BEGV
16525 && CHARPOS (startp
) <= ZV
)
16527 /* The function returns -1 if new fonts were loaded, 1 if
16528 successful, 0 if not successful. */
16529 int ss
= try_scrolling (window
, just_this_one_p
,
16530 scroll_conservatively
,
16532 temp_scroll_step
, last_line_misfit
);
16535 case SCROLLING_SUCCESS
:
16538 case SCROLLING_NEED_LARGER_MATRICES
:
16539 goto need_larger_matrices
;
16541 case SCROLLING_FAILED
:
16549 /* Finally, just choose a place to start which positions point
16550 according to user preferences. */
16555 debug_method_add (w
, "recenter");
16558 /* Forget any previously recorded base line for line number display. */
16559 if (!buffer_unchanged_p
)
16560 w
->base_line_number
= 0;
16562 /* Determine the window start relative to point. */
16563 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16564 it
.current_y
= it
.last_visible_y
;
16565 if (centering_position
< 0)
16567 int window_total_lines
16568 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16570 = scroll_margin
> 0
16571 ? min (scroll_margin
, window_total_lines
/ 4)
16573 ptrdiff_t margin_pos
= CHARPOS (startp
);
16574 Lisp_Object aggressive
;
16577 /* If there is a scroll margin at the top of the window, find
16578 its character position. */
16580 /* Cannot call start_display if startp is not in the
16581 accessible region of the buffer. This can happen when we
16582 have just switched to a different buffer and/or changed
16583 its restriction. In that case, startp is initialized to
16584 the character position 1 (BEGV) because we did not yet
16585 have chance to display the buffer even once. */
16586 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16589 void *it1data
= NULL
;
16591 SAVE_IT (it1
, it
, it1data
);
16592 start_display (&it1
, w
, startp
);
16593 move_it_vertically (&it1
, margin
* frame_line_height
);
16594 margin_pos
= IT_CHARPOS (it1
);
16595 RESTORE_IT (&it
, &it
, it1data
);
16597 scrolling_up
= PT
> margin_pos
;
16600 ? BVAR (current_buffer
, scroll_up_aggressively
)
16601 : BVAR (current_buffer
, scroll_down_aggressively
);
16603 if (!MINI_WINDOW_P (w
)
16604 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16608 /* Setting scroll-conservatively overrides
16609 scroll-*-aggressively. */
16610 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16612 double float_amount
= XFLOATINT (aggressive
);
16614 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16615 if (pt_offset
== 0 && float_amount
> 0)
16617 if (pt_offset
&& margin
> 0)
16620 /* Compute how much to move the window start backward from
16621 point so that point will be displayed where the user
16625 centering_position
= it
.last_visible_y
;
16627 centering_position
-= pt_offset
;
16628 centering_position
-=
16629 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16630 + WINDOW_HEADER_LINE_HEIGHT (w
));
16631 /* Don't let point enter the scroll margin near top of
16633 if (centering_position
< margin
* frame_line_height
)
16634 centering_position
= margin
* frame_line_height
;
16637 centering_position
= margin
* frame_line_height
+ pt_offset
;
16640 /* Set the window start half the height of the window backward
16642 centering_position
= window_box_height (w
) / 2;
16644 move_it_vertically_backward (&it
, centering_position
);
16646 eassert (IT_CHARPOS (it
) >= BEGV
);
16648 /* The function move_it_vertically_backward may move over more
16649 than the specified y-distance. If it->w is small, e.g. a
16650 mini-buffer window, we may end up in front of the window's
16651 display area. Start displaying at the start of the line
16652 containing PT in this case. */
16653 if (it
.current_y
<= 0)
16655 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16656 move_it_vertically_backward (&it
, 0);
16660 it
.current_x
= it
.hpos
= 0;
16662 /* Set the window start position here explicitly, to avoid an
16663 infinite loop in case the functions in window-scroll-functions
16665 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16667 /* Run scroll hooks. */
16668 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16670 /* Redisplay the window. */
16671 if (!current_matrix_up_to_date_p
16672 || windows_or_buffers_changed
16673 || f
->cursor_type_changed
16674 /* Don't use try_window_reusing_current_matrix in this case
16675 because it can have changed the buffer. */
16676 || !NILP (Vwindow_scroll_functions
)
16677 || !just_this_one_p
16678 || MINI_WINDOW_P (w
)
16679 || !(used_current_matrix_p
16680 = try_window_reusing_current_matrix (w
)))
16681 try_window (window
, startp
, 0);
16683 /* If new fonts have been loaded (due to fontsets), give up. We
16684 have to start a new redisplay since we need to re-adjust glyph
16686 if (f
->fonts_changed
)
16687 goto need_larger_matrices
;
16689 /* If cursor did not appear assume that the middle of the window is
16690 in the first line of the window. Do it again with the next line.
16691 (Imagine a window of height 100, displaying two lines of height
16692 60. Moving back 50 from it->last_visible_y will end in the first
16694 if (w
->cursor
.vpos
< 0)
16696 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16698 clear_glyph_matrix (w
->desired_matrix
);
16699 move_it_by_lines (&it
, 1);
16700 try_window (window
, it
.current
.pos
, 0);
16702 else if (PT
< IT_CHARPOS (it
))
16704 clear_glyph_matrix (w
->desired_matrix
);
16705 move_it_by_lines (&it
, -1);
16706 try_window (window
, it
.current
.pos
, 0);
16710 /* Not much we can do about it. */
16714 /* Consider the following case: Window starts at BEGV, there is
16715 invisible, intangible text at BEGV, so that display starts at
16716 some point START > BEGV. It can happen that we are called with
16717 PT somewhere between BEGV and START. Try to handle that case,
16718 and similar ones. */
16719 if (w
->cursor
.vpos
< 0)
16721 /* First, try locating the proper glyph row for PT. */
16722 struct glyph_row
*row
=
16723 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16725 /* Sometimes point is at the beginning of invisible text that is
16726 before the 1st character displayed in the row. In that case,
16727 row_containing_pos fails to find the row, because no glyphs
16728 with appropriate buffer positions are present in the row.
16729 Therefore, we next try to find the row which shows the 1st
16730 position after the invisible text. */
16734 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16737 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16740 Lisp_Object invis_end
=
16741 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16744 if (NATNUMP (invis_end
))
16745 alt_pos
= XFASTINT (invis_end
);
16748 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16752 /* Finally, fall back on the first row of the window after the
16753 header line (if any). This is slightly better than not
16754 displaying the cursor at all. */
16757 row
= w
->current_matrix
->rows
;
16758 if (row
->mode_line_p
)
16761 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16764 if (!cursor_row_fully_visible_p (w
, false, false))
16766 /* If vscroll is enabled, disable it and try again. */
16770 clear_glyph_matrix (w
->desired_matrix
);
16774 /* Users who set scroll-conservatively to a large number want
16775 point just above/below the scroll margin. If we ended up
16776 with point's row partially visible, move the window start to
16777 make that row fully visible and out of the margin. */
16778 if (scroll_conservatively
> SCROLL_LIMIT
)
16780 int window_total_lines
16781 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16784 ? min (scroll_margin
, window_total_lines
/ 4)
16786 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16788 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16789 clear_glyph_matrix (w
->desired_matrix
);
16790 if (1 == try_window (window
, it
.current
.pos
,
16791 TRY_WINDOW_CHECK_MARGINS
))
16795 /* If centering point failed to make the whole line visible,
16796 put point at the top instead. That has to make the whole line
16797 visible, if it can be done. */
16798 if (centering_position
== 0)
16801 clear_glyph_matrix (w
->desired_matrix
);
16802 centering_position
= 0;
16808 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16809 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16810 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16812 /* Display the mode line, if we must. */
16813 if ((update_mode_line
16814 /* If window not full width, must redo its mode line
16815 if (a) the window to its side is being redone and
16816 (b) we do a frame-based redisplay. This is a consequence
16817 of how inverted lines are drawn in frame-based redisplay. */
16818 || (!just_this_one_p
16819 && !FRAME_WINDOW_P (f
)
16820 && !WINDOW_FULL_WIDTH_P (w
))
16821 /* Line number to display. */
16822 || w
->base_line_pos
> 0
16823 /* Column number is displayed and different from the one displayed. */
16824 || (w
->column_number_displayed
!= -1
16825 && (w
->column_number_displayed
!= current_column ())))
16826 /* This means that the window has a mode line. */
16827 && (WINDOW_WANTS_MODELINE_P (w
)
16828 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16831 display_mode_lines (w
);
16833 /* If mode line height has changed, arrange for a thorough
16834 immediate redisplay using the correct mode line height. */
16835 if (WINDOW_WANTS_MODELINE_P (w
)
16836 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16838 f
->fonts_changed
= true;
16839 w
->mode_line_height
= -1;
16840 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16841 = DESIRED_MODE_LINE_HEIGHT (w
);
16844 /* If header line height has changed, arrange for a thorough
16845 immediate redisplay using the correct header line height. */
16846 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16847 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16849 f
->fonts_changed
= true;
16850 w
->header_line_height
= -1;
16851 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16852 = DESIRED_HEADER_LINE_HEIGHT (w
);
16855 if (f
->fonts_changed
)
16856 goto need_larger_matrices
;
16859 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16861 w
->base_line_pos
= 0;
16862 w
->base_line_number
= 0;
16867 /* When we reach a frame's selected window, redo the frame's menu
16868 bar and the frame's title. */
16869 if (update_mode_line
16870 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16872 bool redisplay_menu_p
;
16874 if (FRAME_WINDOW_P (f
))
16876 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16877 || defined (HAVE_NS) || defined (USE_GTK)
16878 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16880 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16884 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16886 if (redisplay_menu_p
)
16887 display_menu_bar (w
);
16889 #ifdef HAVE_WINDOW_SYSTEM
16890 if (FRAME_WINDOW_P (f
))
16892 #if defined (USE_GTK) || defined (HAVE_NS)
16893 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16894 redisplay_tool_bar (f
);
16896 if (WINDOWP (f
->tool_bar_window
)
16897 && (FRAME_TOOL_BAR_LINES (f
) > 0
16898 || !NILP (Vauto_resize_tool_bars
))
16899 && redisplay_tool_bar (f
))
16900 ignore_mouse_drag_p
= true;
16903 x_consider_frame_title (w
->frame
);
16907 #ifdef HAVE_WINDOW_SYSTEM
16908 if (FRAME_WINDOW_P (f
)
16909 && update_window_fringes (w
, (just_this_one_p
16910 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16911 || w
->pseudo_window_p
)))
16915 if (draw_window_fringes (w
, true))
16917 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16918 x_draw_right_divider (w
);
16920 x_draw_vertical_border (w
);
16926 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16927 x_draw_bottom_divider (w
);
16928 #endif /* HAVE_WINDOW_SYSTEM */
16930 /* We go to this label, with fonts_changed set, if it is
16931 necessary to try again using larger glyph matrices.
16932 We have to redeem the scroll bar even in this case,
16933 because the loop in redisplay_internal expects that. */
16934 need_larger_matrices
:
16936 finish_scroll_bars
:
16938 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16940 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16941 /* Set the thumb's position and size. */
16942 set_vertical_scroll_bar (w
);
16944 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16945 /* Set the thumb's position and size. */
16946 set_horizontal_scroll_bar (w
);
16948 /* Note that we actually used the scroll bar attached to this
16949 window, so it shouldn't be deleted at the end of redisplay. */
16950 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16951 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16954 /* Restore current_buffer and value of point in it. The window
16955 update may have changed the buffer, so first make sure `opoint'
16956 is still valid (Bug#6177). */
16957 if (CHARPOS (opoint
) < BEGV
)
16958 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16959 else if (CHARPOS (opoint
) > ZV
)
16960 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16962 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16964 set_buffer_internal_1 (old
);
16965 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16966 shorter. This can be caused by log truncation in *Messages*. */
16967 if (CHARPOS (lpoint
) <= ZV
)
16968 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16970 unbind_to (count
, Qnil
);
16974 /* Build the complete desired matrix of WINDOW with a window start
16975 buffer position POS.
16977 Value is 1 if successful. It is zero if fonts were loaded during
16978 redisplay which makes re-adjusting glyph matrices necessary, and -1
16979 if point would appear in the scroll margins.
16980 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16981 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16985 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16987 struct window
*w
= XWINDOW (window
);
16989 struct glyph_row
*last_text_row
= NULL
;
16990 struct frame
*f
= XFRAME (w
->frame
);
16991 int frame_line_height
= default_line_pixel_height (w
);
16993 /* Make POS the new window start. */
16994 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16996 /* Mark cursor position as unknown. No overlay arrow seen. */
16997 w
->cursor
.vpos
= -1;
16998 overlay_arrow_seen
= false;
17000 /* Initialize iterator and info to start at POS. */
17001 start_display (&it
, w
, pos
);
17002 it
.glyph_row
->reversed_p
= false;
17004 /* Display all lines of W. */
17005 while (it
.current_y
< it
.last_visible_y
)
17007 if (display_line (&it
))
17008 last_text_row
= it
.glyph_row
- 1;
17009 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17013 /* Don't let the cursor end in the scroll margins. */
17014 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17015 && !MINI_WINDOW_P (w
))
17017 int this_scroll_margin
;
17018 int window_total_lines
17019 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17021 if (scroll_margin
> 0)
17023 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17024 this_scroll_margin
*= frame_line_height
;
17027 this_scroll_margin
= 0;
17029 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17030 && w
->cursor
.y
< this_scroll_margin
17031 && CHARPOS (pos
) > BEGV
17032 && IT_CHARPOS (it
) < ZV
)
17033 /* rms: considering make_cursor_line_fully_visible_p here
17034 seems to give wrong results. We don't want to recenter
17035 when the last line is partly visible, we want to allow
17036 that case to be handled in the usual way. */
17037 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17039 w
->cursor
.vpos
= -1;
17040 clear_glyph_matrix (w
->desired_matrix
);
17045 /* If bottom moved off end of frame, change mode line percentage. */
17046 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17047 w
->update_mode_line
= true;
17049 /* Set window_end_pos to the offset of the last character displayed
17050 on the window from the end of current_buffer. Set
17051 window_end_vpos to its row number. */
17054 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17055 adjust_window_ends (w
, last_text_row
, false);
17057 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17058 w
->window_end_vpos
)));
17062 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17063 w
->window_end_pos
= Z
- ZV
;
17064 w
->window_end_vpos
= 0;
17067 /* But that is not valid info until redisplay finishes. */
17068 w
->window_end_valid
= false;
17074 /************************************************************************
17075 Window redisplay reusing current matrix when buffer has not changed
17076 ************************************************************************/
17078 /* Try redisplay of window W showing an unchanged buffer with a
17079 different window start than the last time it was displayed by
17080 reusing its current matrix. Value is true if successful.
17081 W->start is the new window start. */
17084 try_window_reusing_current_matrix (struct window
*w
)
17086 struct frame
*f
= XFRAME (w
->frame
);
17087 struct glyph_row
*bottom_row
;
17090 struct text_pos start
, new_start
;
17091 int nrows_scrolled
, i
;
17092 struct glyph_row
*last_text_row
;
17093 struct glyph_row
*last_reused_text_row
;
17094 struct glyph_row
*start_row
;
17095 int start_vpos
, min_y
, max_y
;
17098 if (inhibit_try_window_reusing
)
17102 if (/* This function doesn't handle terminal frames. */
17103 !FRAME_WINDOW_P (f
)
17104 /* Don't try to reuse the display if windows have been split
17106 || windows_or_buffers_changed
17107 || f
->cursor_type_changed
)
17110 /* Can't do this if showing trailing whitespace. */
17111 if (!NILP (Vshow_trailing_whitespace
))
17114 /* If top-line visibility has changed, give up. */
17115 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17116 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17119 /* Give up if old or new display is scrolled vertically. We could
17120 make this function handle this, but right now it doesn't. */
17121 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17122 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17125 /* The variable new_start now holds the new window start. The old
17126 start `start' can be determined from the current matrix. */
17127 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17128 start
= start_row
->minpos
;
17129 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17131 /* Clear the desired matrix for the display below. */
17132 clear_glyph_matrix (w
->desired_matrix
);
17134 if (CHARPOS (new_start
) <= CHARPOS (start
))
17136 /* Don't use this method if the display starts with an ellipsis
17137 displayed for invisible text. It's not easy to handle that case
17138 below, and it's certainly not worth the effort since this is
17139 not a frequent case. */
17140 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17143 IF_DEBUG (debug_method_add (w
, "twu1"));
17145 /* Display up to a row that can be reused. The variable
17146 last_text_row is set to the last row displayed that displays
17147 text. Note that it.vpos == 0 if or if not there is a
17148 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17149 start_display (&it
, w
, new_start
);
17150 w
->cursor
.vpos
= -1;
17151 last_text_row
= last_reused_text_row
= NULL
;
17153 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17155 /* If we have reached into the characters in the START row,
17156 that means the line boundaries have changed. So we
17157 can't start copying with the row START. Maybe it will
17158 work to start copying with the following row. */
17159 while (IT_CHARPOS (it
) > CHARPOS (start
))
17161 /* Advance to the next row as the "start". */
17163 start
= start_row
->minpos
;
17164 /* If there are no more rows to try, or just one, give up. */
17165 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17166 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17167 || CHARPOS (start
) == ZV
)
17169 clear_glyph_matrix (w
->desired_matrix
);
17173 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17175 /* If we have reached alignment, we can copy the rest of the
17177 if (IT_CHARPOS (it
) == CHARPOS (start
)
17178 /* Don't accept "alignment" inside a display vector,
17179 since start_row could have started in the middle of
17180 that same display vector (thus their character
17181 positions match), and we have no way of telling if
17182 that is the case. */
17183 && it
.current
.dpvec_index
< 0)
17186 it
.glyph_row
->reversed_p
= false;
17187 if (display_line (&it
))
17188 last_text_row
= it
.glyph_row
- 1;
17192 /* A value of current_y < last_visible_y means that we stopped
17193 at the previous window start, which in turn means that we
17194 have at least one reusable row. */
17195 if (it
.current_y
< it
.last_visible_y
)
17197 struct glyph_row
*row
;
17199 /* IT.vpos always starts from 0; it counts text lines. */
17200 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17202 /* Find PT if not already found in the lines displayed. */
17203 if (w
->cursor
.vpos
< 0)
17205 int dy
= it
.current_y
- start_row
->y
;
17207 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17208 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17210 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17211 dy
, nrows_scrolled
);
17214 clear_glyph_matrix (w
->desired_matrix
);
17219 /* Scroll the display. Do it before the current matrix is
17220 changed. The problem here is that update has not yet
17221 run, i.e. part of the current matrix is not up to date.
17222 scroll_run_hook will clear the cursor, and use the
17223 current matrix to get the height of the row the cursor is
17225 run
.current_y
= start_row
->y
;
17226 run
.desired_y
= it
.current_y
;
17227 run
.height
= it
.last_visible_y
- it
.current_y
;
17229 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17232 FRAME_RIF (f
)->update_window_begin_hook (w
);
17233 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17234 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17235 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17239 /* Shift current matrix down by nrows_scrolled lines. */
17240 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17241 rotate_matrix (w
->current_matrix
,
17243 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17246 /* Disable lines that must be updated. */
17247 for (i
= 0; i
< nrows_scrolled
; ++i
)
17248 (start_row
+ i
)->enabled_p
= false;
17250 /* Re-compute Y positions. */
17251 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17252 max_y
= it
.last_visible_y
;
17253 for (row
= start_row
+ nrows_scrolled
;
17257 row
->y
= it
.current_y
;
17258 row
->visible_height
= row
->height
;
17260 if (row
->y
< min_y
)
17261 row
->visible_height
-= min_y
- row
->y
;
17262 if (row
->y
+ row
->height
> max_y
)
17263 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17264 if (row
->fringe_bitmap_periodic_p
)
17265 row
->redraw_fringe_bitmaps_p
= true;
17267 it
.current_y
+= row
->height
;
17269 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17270 last_reused_text_row
= row
;
17271 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17275 /* Disable lines in the current matrix which are now
17276 below the window. */
17277 for (++row
; row
< bottom_row
; ++row
)
17278 row
->enabled_p
= row
->mode_line_p
= false;
17281 /* Update window_end_pos etc.; last_reused_text_row is the last
17282 reused row from the current matrix containing text, if any.
17283 The value of last_text_row is the last displayed line
17284 containing text. */
17285 if (last_reused_text_row
)
17286 adjust_window_ends (w
, last_reused_text_row
, true);
17287 else if (last_text_row
)
17288 adjust_window_ends (w
, last_text_row
, false);
17291 /* This window must be completely empty. */
17292 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17293 w
->window_end_pos
= Z
- ZV
;
17294 w
->window_end_vpos
= 0;
17296 w
->window_end_valid
= false;
17298 /* Update hint: don't try scrolling again in update_window. */
17299 w
->desired_matrix
->no_scrolling_p
= true;
17302 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17306 else if (CHARPOS (new_start
) > CHARPOS (start
))
17308 struct glyph_row
*pt_row
, *row
;
17309 struct glyph_row
*first_reusable_row
;
17310 struct glyph_row
*first_row_to_display
;
17312 int yb
= window_text_bottom_y (w
);
17314 /* Find the row starting at new_start, if there is one. Don't
17315 reuse a partially visible line at the end. */
17316 first_reusable_row
= start_row
;
17317 while (first_reusable_row
->enabled_p
17318 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17319 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17320 < CHARPOS (new_start
)))
17321 ++first_reusable_row
;
17323 /* Give up if there is no row to reuse. */
17324 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17325 || !first_reusable_row
->enabled_p
17326 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17327 != CHARPOS (new_start
)))
17330 /* We can reuse fully visible rows beginning with
17331 first_reusable_row to the end of the window. Set
17332 first_row_to_display to the first row that cannot be reused.
17333 Set pt_row to the row containing point, if there is any. */
17335 for (first_row_to_display
= first_reusable_row
;
17336 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17337 ++first_row_to_display
)
17339 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17340 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17341 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17342 && first_row_to_display
->ends_at_zv_p
17343 && pt_row
== NULL
)))
17344 pt_row
= first_row_to_display
;
17347 /* Start displaying at the start of first_row_to_display. */
17348 eassert (first_row_to_display
->y
< yb
);
17349 init_to_row_start (&it
, w
, first_row_to_display
);
17351 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17353 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17355 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17356 + WINDOW_HEADER_LINE_HEIGHT (w
));
17358 /* Display lines beginning with first_row_to_display in the
17359 desired matrix. Set last_text_row to the last row displayed
17360 that displays text. */
17361 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17362 if (pt_row
== NULL
)
17363 w
->cursor
.vpos
= -1;
17364 last_text_row
= NULL
;
17365 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17366 if (display_line (&it
))
17367 last_text_row
= it
.glyph_row
- 1;
17369 /* If point is in a reused row, adjust y and vpos of the cursor
17373 w
->cursor
.vpos
-= nrows_scrolled
;
17374 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17377 /* Give up if point isn't in a row displayed or reused. (This
17378 also handles the case where w->cursor.vpos < nrows_scrolled
17379 after the calls to display_line, which can happen with scroll
17380 margins. See bug#1295.) */
17381 if (w
->cursor
.vpos
< 0)
17383 clear_glyph_matrix (w
->desired_matrix
);
17387 /* Scroll the display. */
17388 run
.current_y
= first_reusable_row
->y
;
17389 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17390 run
.height
= it
.last_visible_y
- run
.current_y
;
17391 dy
= run
.current_y
- run
.desired_y
;
17396 FRAME_RIF (f
)->update_window_begin_hook (w
);
17397 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17398 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17399 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17403 /* Adjust Y positions of reused rows. */
17404 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17405 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17406 max_y
= it
.last_visible_y
;
17407 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17410 row
->visible_height
= row
->height
;
17411 if (row
->y
< min_y
)
17412 row
->visible_height
-= min_y
- row
->y
;
17413 if (row
->y
+ row
->height
> max_y
)
17414 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17415 if (row
->fringe_bitmap_periodic_p
)
17416 row
->redraw_fringe_bitmaps_p
= true;
17419 /* Scroll the current matrix. */
17420 eassert (nrows_scrolled
> 0);
17421 rotate_matrix (w
->current_matrix
,
17423 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17426 /* Disable rows not reused. */
17427 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17428 row
->enabled_p
= false;
17430 /* Point may have moved to a different line, so we cannot assume that
17431 the previous cursor position is valid; locate the correct row. */
17434 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17436 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17437 && !row
->ends_at_zv_p
;
17441 w
->cursor
.y
= row
->y
;
17443 if (row
< bottom_row
)
17445 /* Can't simply scan the row for point with
17446 bidi-reordered glyph rows. Let set_cursor_from_row
17447 figure out where to put the cursor, and if it fails,
17449 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17451 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17454 clear_glyph_matrix (w
->desired_matrix
);
17460 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17461 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17464 && (!BUFFERP (glyph
->object
)
17465 || glyph
->charpos
< PT
);
17469 w
->cursor
.x
+= glyph
->pixel_width
;
17475 /* Adjust window end. A null value of last_text_row means that
17476 the window end is in reused rows which in turn means that
17477 only its vpos can have changed. */
17479 adjust_window_ends (w
, last_text_row
, false);
17481 w
->window_end_vpos
-= nrows_scrolled
;
17483 w
->window_end_valid
= false;
17484 w
->desired_matrix
->no_scrolling_p
= true;
17487 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17497 /************************************************************************
17498 Window redisplay reusing current matrix when buffer has changed
17499 ************************************************************************/
17501 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17502 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17503 ptrdiff_t *, ptrdiff_t *);
17504 static struct glyph_row
*
17505 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17506 struct glyph_row
*);
17509 /* Return the last row in MATRIX displaying text. If row START is
17510 non-null, start searching with that row. IT gives the dimensions
17511 of the display. Value is null if matrix is empty; otherwise it is
17512 a pointer to the row found. */
17514 static struct glyph_row
*
17515 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17516 struct glyph_row
*start
)
17518 struct glyph_row
*row
, *row_found
;
17520 /* Set row_found to the last row in IT->w's current matrix
17521 displaying text. The loop looks funny but think of partially
17524 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17525 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17527 eassert (row
->enabled_p
);
17529 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17538 /* Return the last row in the current matrix of W that is not affected
17539 by changes at the start of current_buffer that occurred since W's
17540 current matrix was built. Value is null if no such row exists.
17542 BEG_UNCHANGED us the number of characters unchanged at the start of
17543 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17544 first changed character in current_buffer. Characters at positions <
17545 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17546 when the current matrix was built. */
17548 static struct glyph_row
*
17549 find_last_unchanged_at_beg_row (struct window
*w
)
17551 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17552 struct glyph_row
*row
;
17553 struct glyph_row
*row_found
= NULL
;
17554 int yb
= window_text_bottom_y (w
);
17556 /* Find the last row displaying unchanged text. */
17557 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17558 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17559 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17562 if (/* If row ends before first_changed_pos, it is unchanged,
17563 except in some case. */
17564 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17565 /* When row ends in ZV and we write at ZV it is not
17567 && !row
->ends_at_zv_p
17568 /* When first_changed_pos is the end of a continued line,
17569 row is not unchanged because it may be no longer
17571 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17572 && (row
->continued_p
17573 || row
->exact_window_width_line_p
))
17574 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17575 needs to be recomputed, so don't consider this row as
17576 unchanged. This happens when the last line was
17577 bidi-reordered and was killed immediately before this
17578 redisplay cycle. In that case, ROW->end stores the
17579 buffer position of the first visual-order character of
17580 the killed text, which is now beyond ZV. */
17581 && CHARPOS (row
->end
.pos
) <= ZV
)
17584 /* Stop if last visible row. */
17585 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17593 /* Find the first glyph row in the current matrix of W that is not
17594 affected by changes at the end of current_buffer since the
17595 time W's current matrix was built.
17597 Return in *DELTA the number of chars by which buffer positions in
17598 unchanged text at the end of current_buffer must be adjusted.
17600 Return in *DELTA_BYTES the corresponding number of bytes.
17602 Value is null if no such row exists, i.e. all rows are affected by
17605 static struct glyph_row
*
17606 find_first_unchanged_at_end_row (struct window
*w
,
17607 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17609 struct glyph_row
*row
;
17610 struct glyph_row
*row_found
= NULL
;
17612 *delta
= *delta_bytes
= 0;
17614 /* Display must not have been paused, otherwise the current matrix
17615 is not up to date. */
17616 eassert (w
->window_end_valid
);
17618 /* A value of window_end_pos >= END_UNCHANGED means that the window
17619 end is in the range of changed text. If so, there is no
17620 unchanged row at the end of W's current matrix. */
17621 if (w
->window_end_pos
>= END_UNCHANGED
)
17624 /* Set row to the last row in W's current matrix displaying text. */
17625 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17627 /* If matrix is entirely empty, no unchanged row exists. */
17628 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17630 /* The value of row is the last glyph row in the matrix having a
17631 meaningful buffer position in it. The end position of row
17632 corresponds to window_end_pos. This allows us to translate
17633 buffer positions in the current matrix to current buffer
17634 positions for characters not in changed text. */
17636 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17637 ptrdiff_t Z_BYTE_old
=
17638 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17639 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17640 struct glyph_row
*first_text_row
17641 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17643 *delta
= Z
- Z_old
;
17644 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17646 /* Set last_unchanged_pos to the buffer position of the last
17647 character in the buffer that has not been changed. Z is the
17648 index + 1 of the last character in current_buffer, i.e. by
17649 subtracting END_UNCHANGED we get the index of the last
17650 unchanged character, and we have to add BEG to get its buffer
17652 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17653 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17655 /* Search backward from ROW for a row displaying a line that
17656 starts at a minimum position >= last_unchanged_pos_old. */
17657 for (; row
> first_text_row
; --row
)
17659 /* This used to abort, but it can happen.
17660 It is ok to just stop the search instead here. KFS. */
17661 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17664 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17669 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17675 /* Make sure that glyph rows in the current matrix of window W
17676 reference the same glyph memory as corresponding rows in the
17677 frame's frame matrix. This function is called after scrolling W's
17678 current matrix on a terminal frame in try_window_id and
17679 try_window_reusing_current_matrix. */
17682 sync_frame_with_window_matrix_rows (struct window
*w
)
17684 struct frame
*f
= XFRAME (w
->frame
);
17685 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17687 /* Preconditions: W must be a leaf window and full-width. Its frame
17688 must have a frame matrix. */
17689 eassert (BUFFERP (w
->contents
));
17690 eassert (WINDOW_FULL_WIDTH_P (w
));
17691 eassert (!FRAME_WINDOW_P (f
));
17693 /* If W is a full-width window, glyph pointers in W's current matrix
17694 have, by definition, to be the same as glyph pointers in the
17695 corresponding frame matrix. Note that frame matrices have no
17696 marginal areas (see build_frame_matrix). */
17697 window_row
= w
->current_matrix
->rows
;
17698 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17699 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17700 while (window_row
< window_row_end
)
17702 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17703 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17705 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17706 frame_row
->glyphs
[TEXT_AREA
] = start
;
17707 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17708 frame_row
->glyphs
[LAST_AREA
] = end
;
17710 /* Disable frame rows whose corresponding window rows have
17711 been disabled in try_window_id. */
17712 if (!window_row
->enabled_p
)
17713 frame_row
->enabled_p
= false;
17715 ++window_row
, ++frame_row
;
17720 /* Find the glyph row in window W containing CHARPOS. Consider all
17721 rows between START and END (not inclusive). END null means search
17722 all rows to the end of the display area of W. Value is the row
17723 containing CHARPOS or null. */
17726 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17727 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17729 struct glyph_row
*row
= start
;
17730 struct glyph_row
*best_row
= NULL
;
17731 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17734 /* If we happen to start on a header-line, skip that. */
17735 if (row
->mode_line_p
)
17738 if ((end
&& row
>= end
) || !row
->enabled_p
)
17741 last_y
= window_text_bottom_y (w
) - dy
;
17745 /* Give up if we have gone too far. */
17746 if (end
&& row
>= end
)
17748 /* This formerly returned if they were equal.
17749 I think that both quantities are of a "last plus one" type;
17750 if so, when they are equal, the row is within the screen. -- rms. */
17751 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17754 /* If it is in this row, return this row. */
17755 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17756 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17757 /* The end position of a row equals the start
17758 position of the next row. If CHARPOS is there, we
17759 would rather consider it displayed in the next
17760 line, except when this line ends in ZV. */
17761 && !row_for_charpos_p (row
, charpos
)))
17762 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17766 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17767 || (!best_row
&& !row
->continued_p
))
17769 /* In bidi-reordered rows, there could be several rows whose
17770 edges surround CHARPOS, all of these rows belonging to
17771 the same continued line. We need to find the row which
17772 fits CHARPOS the best. */
17773 for (g
= row
->glyphs
[TEXT_AREA
];
17774 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17777 if (!STRINGP (g
->object
))
17779 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17781 mindif
= eabs (g
->charpos
- charpos
);
17783 /* Exact match always wins. */
17790 else if (best_row
&& !row
->continued_p
)
17797 /* Try to redisplay window W by reusing its existing display. W's
17798 current matrix must be up to date when this function is called,
17799 i.e., window_end_valid must be true.
17803 >= 1 if successful, i.e. display has been updated
17805 1 means the changes were in front of a newline that precedes
17806 the window start, and the whole current matrix was reused
17807 2 means the changes were after the last position displayed
17808 in the window, and the whole current matrix was reused
17809 3 means portions of the current matrix were reused, while
17810 some of the screen lines were redrawn
17811 -1 if redisplay with same window start is known not to succeed
17812 0 if otherwise unsuccessful
17814 The following steps are performed:
17816 1. Find the last row in the current matrix of W that is not
17817 affected by changes at the start of current_buffer. If no such row
17820 2. Find the first row in W's current matrix that is not affected by
17821 changes at the end of current_buffer. Maybe there is no such row.
17823 3. Display lines beginning with the row + 1 found in step 1 to the
17824 row found in step 2 or, if step 2 didn't find a row, to the end of
17827 4. If cursor is not known to appear on the window, give up.
17829 5. If display stopped at the row found in step 2, scroll the
17830 display and current matrix as needed.
17832 6. Maybe display some lines at the end of W, if we must. This can
17833 happen under various circumstances, like a partially visible line
17834 becoming fully visible, or because newly displayed lines are displayed
17835 in smaller font sizes.
17837 7. Update W's window end information. */
17840 try_window_id (struct window
*w
)
17842 struct frame
*f
= XFRAME (w
->frame
);
17843 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17844 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17845 struct glyph_row
*last_unchanged_at_beg_row
;
17846 struct glyph_row
*first_unchanged_at_end_row
;
17847 struct glyph_row
*row
;
17848 struct glyph_row
*bottom_row
;
17851 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17853 struct text_pos start_pos
;
17855 int first_unchanged_at_end_vpos
= 0;
17856 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17857 struct text_pos start
;
17858 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17861 if (inhibit_try_window_id
)
17865 /* This is handy for debugging. */
17867 #define GIVE_UP(X) \
17869 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17873 #define GIVE_UP(X) return 0
17876 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17878 /* Don't use this for mini-windows because these can show
17879 messages and mini-buffers, and we don't handle that here. */
17880 if (MINI_WINDOW_P (w
))
17883 /* This flag is used to prevent redisplay optimizations. */
17884 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17887 /* This function's optimizations cannot be used if overlays have
17888 changed in the buffer displayed by the window, so give up if they
17890 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17893 /* Verify that narrowing has not changed.
17894 Also verify that we were not told to prevent redisplay optimizations.
17895 It would be nice to further
17896 reduce the number of cases where this prevents try_window_id. */
17897 if (current_buffer
->clip_changed
17898 || current_buffer
->prevent_redisplay_optimizations_p
)
17901 /* Window must either use window-based redisplay or be full width. */
17902 if (!FRAME_WINDOW_P (f
)
17903 && (!FRAME_LINE_INS_DEL_OK (f
)
17904 || !WINDOW_FULL_WIDTH_P (w
)))
17907 /* Give up if point is known NOT to appear in W. */
17908 if (PT
< CHARPOS (start
))
17911 /* Another way to prevent redisplay optimizations. */
17912 if (w
->last_modified
== 0)
17915 /* Verify that window is not hscrolled. */
17916 if (w
->hscroll
!= 0)
17919 /* Verify that display wasn't paused. */
17920 if (!w
->window_end_valid
)
17923 /* Likewise if highlighting trailing whitespace. */
17924 if (!NILP (Vshow_trailing_whitespace
))
17927 /* Can't use this if overlay arrow position and/or string have
17929 if (overlay_arrows_changed_p ())
17932 /* When word-wrap is on, adding a space to the first word of a
17933 wrapped line can change the wrap position, altering the line
17934 above it. It might be worthwhile to handle this more
17935 intelligently, but for now just redisplay from scratch. */
17936 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17939 /* Under bidi reordering, adding or deleting a character in the
17940 beginning of a paragraph, before the first strong directional
17941 character, can change the base direction of the paragraph (unless
17942 the buffer specifies a fixed paragraph direction), which will
17943 require to redisplay the whole paragraph. It might be worthwhile
17944 to find the paragraph limits and widen the range of redisplayed
17945 lines to that, but for now just give up this optimization and
17946 redisplay from scratch. */
17947 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17948 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17951 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17952 to that variable require thorough redisplay. */
17953 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17956 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17957 only if buffer has really changed. The reason is that the gap is
17958 initially at Z for freshly visited files. The code below would
17959 set end_unchanged to 0 in that case. */
17960 if (MODIFF
> SAVE_MODIFF
17961 /* This seems to happen sometimes after saving a buffer. */
17962 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17964 if (GPT
- BEG
< BEG_UNCHANGED
)
17965 BEG_UNCHANGED
= GPT
- BEG
;
17966 if (Z
- GPT
< END_UNCHANGED
)
17967 END_UNCHANGED
= Z
- GPT
;
17970 /* The position of the first and last character that has been changed. */
17971 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17972 last_changed_charpos
= Z
- END_UNCHANGED
;
17974 /* If window starts after a line end, and the last change is in
17975 front of that newline, then changes don't affect the display.
17976 This case happens with stealth-fontification. Note that although
17977 the display is unchanged, glyph positions in the matrix have to
17978 be adjusted, of course. */
17979 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17980 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17981 && ((last_changed_charpos
< CHARPOS (start
)
17982 && CHARPOS (start
) == BEGV
)
17983 || (last_changed_charpos
< CHARPOS (start
) - 1
17984 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17986 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17987 struct glyph_row
*r0
;
17989 /* Compute how many chars/bytes have been added to or removed
17990 from the buffer. */
17991 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17992 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17993 Z_delta
= Z
- Z_old
;
17994 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17996 /* Give up if PT is not in the window. Note that it already has
17997 been checked at the start of try_window_id that PT is not in
17998 front of the window start. */
17999 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18002 /* If window start is unchanged, we can reuse the whole matrix
18003 as is, after adjusting glyph positions. No need to compute
18004 the window end again, since its offset from Z hasn't changed. */
18005 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18006 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18007 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18008 /* PT must not be in a partially visible line. */
18009 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18010 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18012 /* Adjust positions in the glyph matrix. */
18013 if (Z_delta
|| Z_delta_bytes
)
18015 struct glyph_row
*r1
18016 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18017 increment_matrix_positions (w
->current_matrix
,
18018 MATRIX_ROW_VPOS (r0
, current_matrix
),
18019 MATRIX_ROW_VPOS (r1
, current_matrix
),
18020 Z_delta
, Z_delta_bytes
);
18023 /* Set the cursor. */
18024 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18026 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18031 /* Handle the case that changes are all below what is displayed in
18032 the window, and that PT is in the window. This shortcut cannot
18033 be taken if ZV is visible in the window, and text has been added
18034 there that is visible in the window. */
18035 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18036 /* ZV is not visible in the window, or there are no
18037 changes at ZV, actually. */
18038 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18039 || first_changed_charpos
== last_changed_charpos
))
18041 struct glyph_row
*r0
;
18043 /* Give up if PT is not in the window. Note that it already has
18044 been checked at the start of try_window_id that PT is not in
18045 front of the window start. */
18046 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18049 /* If window start is unchanged, we can reuse the whole matrix
18050 as is, without changing glyph positions since no text has
18051 been added/removed in front of the window end. */
18052 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18053 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18054 /* PT must not be in a partially visible line. */
18055 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18056 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18058 /* We have to compute the window end anew since text
18059 could have been added/removed after it. */
18060 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18061 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18063 /* Set the cursor. */
18064 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18066 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18071 /* Give up if window start is in the changed area.
18073 The condition used to read
18075 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18077 but why that was tested escapes me at the moment. */
18078 if (CHARPOS (start
) >= first_changed_charpos
18079 && CHARPOS (start
) <= last_changed_charpos
)
18082 /* Check that window start agrees with the start of the first glyph
18083 row in its current matrix. Check this after we know the window
18084 start is not in changed text, otherwise positions would not be
18086 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18087 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18090 /* Give up if the window ends in strings. Overlay strings
18091 at the end are difficult to handle, so don't try. */
18092 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18093 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18096 /* Compute the position at which we have to start displaying new
18097 lines. Some of the lines at the top of the window might be
18098 reusable because they are not displaying changed text. Find the
18099 last row in W's current matrix not affected by changes at the
18100 start of current_buffer. Value is null if changes start in the
18101 first line of window. */
18102 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18103 if (last_unchanged_at_beg_row
)
18105 /* Avoid starting to display in the middle of a character, a TAB
18106 for instance. This is easier than to set up the iterator
18107 exactly, and it's not a frequent case, so the additional
18108 effort wouldn't really pay off. */
18109 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18110 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18111 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18112 --last_unchanged_at_beg_row
;
18114 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18117 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18119 start_pos
= it
.current
.pos
;
18121 /* Start displaying new lines in the desired matrix at the same
18122 vpos we would use in the current matrix, i.e. below
18123 last_unchanged_at_beg_row. */
18124 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18126 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18127 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18129 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18133 /* There are no reusable lines at the start of the window.
18134 Start displaying in the first text line. */
18135 start_display (&it
, w
, start
);
18136 it
.vpos
= it
.first_vpos
;
18137 start_pos
= it
.current
.pos
;
18140 /* Find the first row that is not affected by changes at the end of
18141 the buffer. Value will be null if there is no unchanged row, in
18142 which case we must redisplay to the end of the window. delta
18143 will be set to the value by which buffer positions beginning with
18144 first_unchanged_at_end_row have to be adjusted due to text
18146 first_unchanged_at_end_row
18147 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18148 IF_DEBUG (debug_delta
= delta
);
18149 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18151 /* Set stop_pos to the buffer position up to which we will have to
18152 display new lines. If first_unchanged_at_end_row != NULL, this
18153 is the buffer position of the start of the line displayed in that
18154 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18155 that we don't stop at a buffer position. */
18157 if (first_unchanged_at_end_row
)
18159 eassert (last_unchanged_at_beg_row
== NULL
18160 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18162 /* If this is a continuation line, move forward to the next one
18163 that isn't. Changes in lines above affect this line.
18164 Caution: this may move first_unchanged_at_end_row to a row
18165 not displaying text. */
18166 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18167 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18168 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18169 < it
.last_visible_y
))
18170 ++first_unchanged_at_end_row
;
18172 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18173 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18174 >= it
.last_visible_y
))
18175 first_unchanged_at_end_row
= NULL
;
18178 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18180 first_unchanged_at_end_vpos
18181 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18182 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18185 else if (last_unchanged_at_beg_row
== NULL
)
18191 /* Either there is no unchanged row at the end, or the one we have
18192 now displays text. This is a necessary condition for the window
18193 end pos calculation at the end of this function. */
18194 eassert (first_unchanged_at_end_row
== NULL
18195 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18197 debug_last_unchanged_at_beg_vpos
18198 = (last_unchanged_at_beg_row
18199 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18201 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18203 #endif /* GLYPH_DEBUG */
18206 /* Display new lines. Set last_text_row to the last new line
18207 displayed which has text on it, i.e. might end up as being the
18208 line where the window_end_vpos is. */
18209 w
->cursor
.vpos
= -1;
18210 last_text_row
= NULL
;
18211 overlay_arrow_seen
= false;
18212 if (it
.current_y
< it
.last_visible_y
18213 && !f
->fonts_changed
18214 && (first_unchanged_at_end_row
== NULL
18215 || IT_CHARPOS (it
) < stop_pos
))
18216 it
.glyph_row
->reversed_p
= false;
18217 while (it
.current_y
< it
.last_visible_y
18218 && !f
->fonts_changed
18219 && (first_unchanged_at_end_row
== NULL
18220 || IT_CHARPOS (it
) < stop_pos
))
18222 if (display_line (&it
))
18223 last_text_row
= it
.glyph_row
- 1;
18226 if (f
->fonts_changed
)
18229 /* The redisplay iterations in display_line above could have
18230 triggered font-lock, which could have done something that
18231 invalidates IT->w window's end-point information, on which we
18232 rely below. E.g., one package, which will remain unnamed, used
18233 to install a font-lock-fontify-region-function that called
18234 bury-buffer, whose side effect is to switch the buffer displayed
18235 by IT->w, and that predictably resets IT->w's window_end_valid
18236 flag, which we already tested at the entry to this function.
18237 Amply punish such packages/modes by giving up on this
18238 optimization in those cases. */
18239 if (!w
->window_end_valid
)
18241 clear_glyph_matrix (w
->desired_matrix
);
18245 /* Compute differences in buffer positions, y-positions etc. for
18246 lines reused at the bottom of the window. Compute what we can
18248 if (first_unchanged_at_end_row
18249 /* No lines reused because we displayed everything up to the
18250 bottom of the window. */
18251 && it
.current_y
< it
.last_visible_y
)
18254 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18256 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18257 run
.current_y
= first_unchanged_at_end_row
->y
;
18258 run
.desired_y
= run
.current_y
+ dy
;
18259 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18263 delta
= delta_bytes
= dvpos
= dy
18264 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18265 first_unchanged_at_end_row
= NULL
;
18267 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18270 /* Find the cursor if not already found. We have to decide whether
18271 PT will appear on this window (it sometimes doesn't, but this is
18272 not a very frequent case.) This decision has to be made before
18273 the current matrix is altered. A value of cursor.vpos < 0 means
18274 that PT is either in one of the lines beginning at
18275 first_unchanged_at_end_row or below the window. Don't care for
18276 lines that might be displayed later at the window end; as
18277 mentioned, this is not a frequent case. */
18278 if (w
->cursor
.vpos
< 0)
18280 /* Cursor in unchanged rows at the top? */
18281 if (PT
< CHARPOS (start_pos
)
18282 && last_unchanged_at_beg_row
)
18284 row
= row_containing_pos (w
, PT
,
18285 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18286 last_unchanged_at_beg_row
+ 1, 0);
18288 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18291 /* Start from first_unchanged_at_end_row looking for PT. */
18292 else if (first_unchanged_at_end_row
)
18294 row
= row_containing_pos (w
, PT
- delta
,
18295 first_unchanged_at_end_row
, NULL
, 0);
18297 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18298 delta_bytes
, dy
, dvpos
);
18301 /* Give up if cursor was not found. */
18302 if (w
->cursor
.vpos
< 0)
18304 clear_glyph_matrix (w
->desired_matrix
);
18309 /* Don't let the cursor end in the scroll margins. */
18311 int this_scroll_margin
, cursor_height
;
18312 int frame_line_height
= default_line_pixel_height (w
);
18313 int window_total_lines
18314 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18316 this_scroll_margin
=
18317 max (0, min (scroll_margin
, window_total_lines
/ 4));
18318 this_scroll_margin
*= frame_line_height
;
18319 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18321 if ((w
->cursor
.y
< this_scroll_margin
18322 && CHARPOS (start
) > BEGV
)
18323 /* Old redisplay didn't take scroll margin into account at the bottom,
18324 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18325 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18326 ? cursor_height
+ this_scroll_margin
18327 : 1)) > it
.last_visible_y
)
18329 w
->cursor
.vpos
= -1;
18330 clear_glyph_matrix (w
->desired_matrix
);
18335 /* Scroll the display. Do it before changing the current matrix so
18336 that xterm.c doesn't get confused about where the cursor glyph is
18338 if (dy
&& run
.height
)
18342 if (FRAME_WINDOW_P (f
))
18344 FRAME_RIF (f
)->update_window_begin_hook (w
);
18345 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18346 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18347 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18351 /* Terminal frame. In this case, dvpos gives the number of
18352 lines to scroll by; dvpos < 0 means scroll up. */
18354 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18355 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18356 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18357 + WINDOW_WANTS_HEADER_LINE_P (w
)
18358 + window_internal_height (w
));
18360 #if defined (HAVE_GPM) || defined (MSDOS)
18361 x_clear_window_mouse_face (w
);
18363 /* Perform the operation on the screen. */
18366 /* Scroll last_unchanged_at_beg_row to the end of the
18367 window down dvpos lines. */
18368 set_terminal_window (f
, end
);
18370 /* On dumb terminals delete dvpos lines at the end
18371 before inserting dvpos empty lines. */
18372 if (!FRAME_SCROLL_REGION_OK (f
))
18373 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18375 /* Insert dvpos empty lines in front of
18376 last_unchanged_at_beg_row. */
18377 ins_del_lines (f
, from
, dvpos
);
18379 else if (dvpos
< 0)
18381 /* Scroll up last_unchanged_at_beg_vpos to the end of
18382 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18383 set_terminal_window (f
, end
);
18385 /* Delete dvpos lines in front of
18386 last_unchanged_at_beg_vpos. ins_del_lines will set
18387 the cursor to the given vpos and emit |dvpos| delete
18389 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18391 /* On a dumb terminal insert dvpos empty lines at the
18393 if (!FRAME_SCROLL_REGION_OK (f
))
18394 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18397 set_terminal_window (f
, 0);
18403 /* Shift reused rows of the current matrix to the right position.
18404 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18406 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18407 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18410 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18411 bottom_vpos
, dvpos
);
18412 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18415 else if (dvpos
> 0)
18417 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18418 bottom_vpos
, dvpos
);
18419 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18420 first_unchanged_at_end_vpos
+ dvpos
);
18423 /* For frame-based redisplay, make sure that current frame and window
18424 matrix are in sync with respect to glyph memory. */
18425 if (!FRAME_WINDOW_P (f
))
18426 sync_frame_with_window_matrix_rows (w
);
18428 /* Adjust buffer positions in reused rows. */
18429 if (delta
|| delta_bytes
)
18430 increment_matrix_positions (current_matrix
,
18431 first_unchanged_at_end_vpos
+ dvpos
,
18432 bottom_vpos
, delta
, delta_bytes
);
18434 /* Adjust Y positions. */
18436 shift_glyph_matrix (w
, current_matrix
,
18437 first_unchanged_at_end_vpos
+ dvpos
,
18440 if (first_unchanged_at_end_row
)
18442 first_unchanged_at_end_row
+= dvpos
;
18443 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18444 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18445 first_unchanged_at_end_row
= NULL
;
18448 /* If scrolling up, there may be some lines to display at the end of
18450 last_text_row_at_end
= NULL
;
18453 /* Scrolling up can leave for example a partially visible line
18454 at the end of the window to be redisplayed. */
18455 /* Set last_row to the glyph row in the current matrix where the
18456 window end line is found. It has been moved up or down in
18457 the matrix by dvpos. */
18458 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18459 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18461 /* If last_row is the window end line, it should display text. */
18462 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18464 /* If window end line was partially visible before, begin
18465 displaying at that line. Otherwise begin displaying with the
18466 line following it. */
18467 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18469 init_to_row_start (&it
, w
, last_row
);
18470 it
.vpos
= last_vpos
;
18471 it
.current_y
= last_row
->y
;
18475 init_to_row_end (&it
, w
, last_row
);
18476 it
.vpos
= 1 + last_vpos
;
18477 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18481 /* We may start in a continuation line. If so, we have to
18482 get the right continuation_lines_width and current_x. */
18483 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18484 it
.hpos
= it
.current_x
= 0;
18486 /* Display the rest of the lines at the window end. */
18487 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18488 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18490 /* Is it always sure that the display agrees with lines in
18491 the current matrix? I don't think so, so we mark rows
18492 displayed invalid in the current matrix by setting their
18493 enabled_p flag to false. */
18494 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18495 if (display_line (&it
))
18496 last_text_row_at_end
= it
.glyph_row
- 1;
18500 /* Update window_end_pos and window_end_vpos. */
18501 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18503 /* Window end line if one of the preserved rows from the current
18504 matrix. Set row to the last row displaying text in current
18505 matrix starting at first_unchanged_at_end_row, after
18507 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18508 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18509 first_unchanged_at_end_row
);
18510 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18511 adjust_window_ends (w
, row
, true);
18512 eassert (w
->window_end_bytepos
>= 0);
18513 IF_DEBUG (debug_method_add (w
, "A"));
18515 else if (last_text_row_at_end
)
18517 adjust_window_ends (w
, last_text_row_at_end
, false);
18518 eassert (w
->window_end_bytepos
>= 0);
18519 IF_DEBUG (debug_method_add (w
, "B"));
18521 else if (last_text_row
)
18523 /* We have displayed either to the end of the window or at the
18524 end of the window, i.e. the last row with text is to be found
18525 in the desired matrix. */
18526 adjust_window_ends (w
, last_text_row
, false);
18527 eassert (w
->window_end_bytepos
>= 0);
18529 else if (first_unchanged_at_end_row
== NULL
18530 && last_text_row
== NULL
18531 && last_text_row_at_end
== NULL
)
18533 /* Displayed to end of window, but no line containing text was
18534 displayed. Lines were deleted at the end of the window. */
18535 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18536 int vpos
= w
->window_end_vpos
;
18537 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18538 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18541 row
== NULL
&& vpos
>= first_vpos
;
18542 --vpos
, --current_row
, --desired_row
)
18544 if (desired_row
->enabled_p
)
18546 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18549 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18553 eassert (row
!= NULL
);
18554 w
->window_end_vpos
= vpos
+ 1;
18555 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18556 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18557 eassert (w
->window_end_bytepos
>= 0);
18558 IF_DEBUG (debug_method_add (w
, "C"));
18563 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18564 debug_end_vpos
= w
->window_end_vpos
));
18566 /* Record that display has not been completed. */
18567 w
->window_end_valid
= false;
18568 w
->desired_matrix
->no_scrolling_p
= true;
18576 /***********************************************************************
18577 More debugging support
18578 ***********************************************************************/
18582 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18583 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18584 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18587 /* Dump the contents of glyph matrix MATRIX on stderr.
18589 GLYPHS 0 means don't show glyph contents.
18590 GLYPHS 1 means show glyphs in short form
18591 GLYPHS > 1 means show glyphs in long form. */
18594 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18597 for (i
= 0; i
< matrix
->nrows
; ++i
)
18598 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18602 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18603 the glyph row and area where the glyph comes from. */
18606 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18608 if (glyph
->type
== CHAR_GLYPH
18609 || glyph
->type
== GLYPHLESS_GLYPH
)
18612 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18613 glyph
- row
->glyphs
[TEXT_AREA
],
18614 (glyph
->type
== CHAR_GLYPH
18618 (BUFFERP (glyph
->object
)
18620 : (STRINGP (glyph
->object
)
18622 : (NILP (glyph
->object
)
18625 glyph
->pixel_width
,
18627 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18631 glyph
->left_box_line_p
,
18632 glyph
->right_box_line_p
);
18634 else if (glyph
->type
== STRETCH_GLYPH
)
18637 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18638 glyph
- row
->glyphs
[TEXT_AREA
],
18641 (BUFFERP (glyph
->object
)
18643 : (STRINGP (glyph
->object
)
18645 : (NILP (glyph
->object
)
18648 glyph
->pixel_width
,
18652 glyph
->left_box_line_p
,
18653 glyph
->right_box_line_p
);
18655 else if (glyph
->type
== IMAGE_GLYPH
)
18658 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18659 glyph
- row
->glyphs
[TEXT_AREA
],
18662 (BUFFERP (glyph
->object
)
18664 : (STRINGP (glyph
->object
)
18666 : (NILP (glyph
->object
)
18669 glyph
->pixel_width
,
18673 glyph
->left_box_line_p
,
18674 glyph
->right_box_line_p
);
18676 else if (glyph
->type
== COMPOSITE_GLYPH
)
18679 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18680 glyph
- row
->glyphs
[TEXT_AREA
],
18683 (BUFFERP (glyph
->object
)
18685 : (STRINGP (glyph
->object
)
18687 : (NILP (glyph
->object
)
18690 glyph
->pixel_width
,
18692 if (glyph
->u
.cmp
.automatic
)
18695 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18696 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18698 glyph
->left_box_line_p
,
18699 glyph
->right_box_line_p
);
18704 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18705 GLYPHS 0 means don't show glyph contents.
18706 GLYPHS 1 means show glyphs in short form
18707 GLYPHS > 1 means show glyphs in long form. */
18710 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18714 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18715 fprintf (stderr
, "==============================================================================\n");
18717 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18718 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18720 MATRIX_ROW_START_CHARPOS (row
),
18721 MATRIX_ROW_END_CHARPOS (row
),
18722 row
->used
[TEXT_AREA
],
18723 row
->contains_overlapping_glyphs_p
,
18725 row
->truncated_on_left_p
,
18726 row
->truncated_on_right_p
,
18728 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18729 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18732 row
->ends_in_middle_of_char_p
,
18733 row
->starts_in_middle_of_char_p
,
18739 row
->visible_height
,
18742 /* The next 3 lines should align to "Start" in the header. */
18743 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18744 row
->end
.overlay_string_index
,
18745 row
->continuation_lines_width
);
18746 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18747 CHARPOS (row
->start
.string_pos
),
18748 CHARPOS (row
->end
.string_pos
));
18749 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18750 row
->end
.dpvec_index
);
18757 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18759 struct glyph
*glyph
= row
->glyphs
[area
];
18760 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18762 /* Glyph for a line end in text. */
18763 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18766 if (glyph
< glyph_end
)
18767 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18769 for (; glyph
< glyph_end
; ++glyph
)
18770 dump_glyph (row
, glyph
, area
);
18773 else if (glyphs
== 1)
18776 char s
[SHRT_MAX
+ 4];
18778 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18782 for (i
= 0; i
< row
->used
[area
]; ++i
)
18784 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18785 if (i
== row
->used
[area
] - 1
18786 && area
== TEXT_AREA
18787 && NILP (glyph
->object
)
18788 && glyph
->type
== CHAR_GLYPH
18789 && glyph
->u
.ch
== ' ')
18791 strcpy (&s
[i
], "[\\n]");
18794 else if (glyph
->type
== CHAR_GLYPH
18795 && glyph
->u
.ch
< 0x80
18796 && glyph
->u
.ch
>= ' ')
18797 s
[i
] = glyph
->u
.ch
;
18803 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18809 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18810 Sdump_glyph_matrix
, 0, 1, "p",
18811 doc
: /* Dump the current matrix of the selected window to stderr.
18812 Shows contents of glyph row structures. With non-nil
18813 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18814 glyphs in short form, otherwise show glyphs in long form.
18816 Interactively, no argument means show glyphs in short form;
18817 with numeric argument, its value is passed as the GLYPHS flag. */)
18818 (Lisp_Object glyphs
)
18820 struct window
*w
= XWINDOW (selected_window
);
18821 struct buffer
*buffer
= XBUFFER (w
->contents
);
18823 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18824 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18825 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18826 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18827 fprintf (stderr
, "=============================================\n");
18828 dump_glyph_matrix (w
->current_matrix
,
18829 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18834 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18835 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18836 Only text-mode frames have frame glyph matrices. */)
18839 struct frame
*f
= XFRAME (selected_frame
);
18841 if (f
->current_matrix
)
18842 dump_glyph_matrix (f
->current_matrix
, 1);
18844 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18849 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18850 doc
: /* Dump glyph row ROW to stderr.
18851 GLYPH 0 means don't dump glyphs.
18852 GLYPH 1 means dump glyphs in short form.
18853 GLYPH > 1 or omitted means dump glyphs in long form. */)
18854 (Lisp_Object row
, Lisp_Object glyphs
)
18856 struct glyph_matrix
*matrix
;
18859 CHECK_NUMBER (row
);
18860 matrix
= XWINDOW (selected_window
)->current_matrix
;
18862 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18863 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18865 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18870 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18871 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18872 GLYPH 0 means don't dump glyphs.
18873 GLYPH 1 means dump glyphs in short form.
18874 GLYPH > 1 or omitted means dump glyphs in long form.
18876 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18878 (Lisp_Object row
, Lisp_Object glyphs
)
18880 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18881 struct frame
*sf
= SELECTED_FRAME ();
18882 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18885 CHECK_NUMBER (row
);
18887 if (vpos
>= 0 && vpos
< m
->nrows
)
18888 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18889 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18895 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18896 doc
: /* Toggle tracing of redisplay.
18897 With ARG, turn tracing on if and only if ARG is positive. */)
18901 trace_redisplay_p
= !trace_redisplay_p
;
18904 arg
= Fprefix_numeric_value (arg
);
18905 trace_redisplay_p
= XINT (arg
) > 0;
18912 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18913 doc
: /* Like `format', but print result to stderr.
18914 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18915 (ptrdiff_t nargs
, Lisp_Object
*args
)
18917 Lisp_Object s
= Fformat (nargs
, args
);
18918 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18922 #endif /* GLYPH_DEBUG */
18926 /***********************************************************************
18927 Building Desired Matrix Rows
18928 ***********************************************************************/
18930 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18931 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18933 static struct glyph_row
*
18934 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18936 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18937 struct buffer
*buffer
= XBUFFER (w
->contents
);
18938 struct buffer
*old
= current_buffer
;
18939 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18940 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18941 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18942 const unsigned char *p
;
18945 int n_glyphs_before
;
18947 set_buffer_temp (buffer
);
18948 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18949 scratch_glyph_row
.reversed_p
= false;
18950 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18951 SET_TEXT_POS (it
.position
, 0, 0);
18953 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18955 while (p
< arrow_end
)
18957 Lisp_Object face
, ilisp
;
18959 /* Get the next character. */
18961 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18964 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18965 if (! ASCII_CHAR_P (it
.c
))
18966 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18970 /* Get its face. */
18971 ilisp
= make_number (p
- arrow_string
);
18972 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18973 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18975 /* Compute its width, get its glyphs. */
18976 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18977 SET_TEXT_POS (it
.position
, -1, -1);
18978 PRODUCE_GLYPHS (&it
);
18980 /* If this character doesn't fit any more in the line, we have
18981 to remove some glyphs. */
18982 if (it
.current_x
> it
.last_visible_x
)
18984 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18989 set_buffer_temp (old
);
18990 return it
.glyph_row
;
18994 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18995 glyphs to insert is determined by produce_special_glyphs. */
18998 insert_left_trunc_glyphs (struct it
*it
)
19000 struct it truncate_it
;
19001 struct glyph
*from
, *end
, *to
, *toend
;
19003 eassert (!FRAME_WINDOW_P (it
->f
)
19004 || (!it
->glyph_row
->reversed_p
19005 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19006 || (it
->glyph_row
->reversed_p
19007 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19009 /* Get the truncation glyphs. */
19011 truncate_it
.current_x
= 0;
19012 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19013 truncate_it
.glyph_row
= &scratch_glyph_row
;
19014 truncate_it
.area
= TEXT_AREA
;
19015 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19016 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19017 truncate_it
.object
= Qnil
;
19018 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19020 /* Overwrite glyphs from IT with truncation glyphs. */
19021 if (!it
->glyph_row
->reversed_p
)
19023 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19025 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19026 end
= from
+ tused
;
19027 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19028 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19029 if (FRAME_WINDOW_P (it
->f
))
19031 /* On GUI frames, when variable-size fonts are displayed,
19032 the truncation glyphs may need more pixels than the row's
19033 glyphs they overwrite. We overwrite more glyphs to free
19034 enough screen real estate, and enlarge the stretch glyph
19035 on the right (see display_line), if there is one, to
19036 preserve the screen position of the truncation glyphs on
19039 struct glyph
*g
= to
;
19042 /* The first glyph could be partially visible, in which case
19043 it->glyph_row->x will be negative. But we want the left
19044 truncation glyphs to be aligned at the left margin of the
19045 window, so we override the x coordinate at which the row
19047 it
->glyph_row
->x
= 0;
19048 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19050 w
+= g
->pixel_width
;
19053 if (g
- to
- tused
> 0)
19055 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19056 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19058 used
= it
->glyph_row
->used
[TEXT_AREA
];
19059 if (it
->glyph_row
->truncated_on_right_p
19060 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19061 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19064 int extra
= w
- it
->truncation_pixel_width
;
19066 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19073 /* There may be padding glyphs left over. Overwrite them too. */
19074 if (!FRAME_WINDOW_P (it
->f
))
19076 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19078 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19085 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19089 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19091 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19092 that back to front. */
19093 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19094 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19095 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19096 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19097 if (FRAME_WINDOW_P (it
->f
))
19100 struct glyph
*g
= to
;
19102 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19104 w
+= g
->pixel_width
;
19107 if (to
- g
- tused
> 0)
19109 if (it
->glyph_row
->truncated_on_right_p
19110 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19111 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19113 int extra
= w
- it
->truncation_pixel_width
;
19115 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19119 while (from
>= end
&& to
>= toend
)
19121 if (!FRAME_WINDOW_P (it
->f
))
19123 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19126 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19127 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19128 while (from
>= end
&& to
>= toend
)
19134 /* Need to free some room before prepending additional
19136 int move_by
= from
- end
+ 1;
19137 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19138 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19140 for ( ; g
>= g0
; g
--)
19142 while (from
>= end
)
19144 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19149 /* Compute the hash code for ROW. */
19151 row_hash (struct glyph_row
*row
)
19154 unsigned hashval
= 0;
19156 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19157 for (k
= 0; k
< row
->used
[area
]; ++k
)
19158 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19159 + row
->glyphs
[area
][k
].u
.val
19160 + row
->glyphs
[area
][k
].face_id
19161 + row
->glyphs
[area
][k
].padding_p
19162 + (row
->glyphs
[area
][k
].type
<< 2));
19167 /* Compute the pixel height and width of IT->glyph_row.
19169 Most of the time, ascent and height of a display line will be equal
19170 to the max_ascent and max_height values of the display iterator
19171 structure. This is not the case if
19173 1. We hit ZV without displaying anything. In this case, max_ascent
19174 and max_height will be zero.
19176 2. We have some glyphs that don't contribute to the line height.
19177 (The glyph row flag contributes_to_line_height_p is for future
19178 pixmap extensions).
19180 The first case is easily covered by using default values because in
19181 these cases, the line height does not really matter, except that it
19182 must not be zero. */
19185 compute_line_metrics (struct it
*it
)
19187 struct glyph_row
*row
= it
->glyph_row
;
19189 if (FRAME_WINDOW_P (it
->f
))
19191 int i
, min_y
, max_y
;
19193 /* The line may consist of one space only, that was added to
19194 place the cursor on it. If so, the row's height hasn't been
19196 if (row
->height
== 0)
19198 if (it
->max_ascent
+ it
->max_descent
== 0)
19199 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19200 row
->ascent
= it
->max_ascent
;
19201 row
->height
= it
->max_ascent
+ it
->max_descent
;
19202 row
->phys_ascent
= it
->max_phys_ascent
;
19203 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19204 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19207 /* Compute the width of this line. */
19208 row
->pixel_width
= row
->x
;
19209 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19210 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19212 eassert (row
->pixel_width
>= 0);
19213 eassert (row
->ascent
>= 0 && row
->height
> 0);
19215 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19216 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19218 /* If first line's physical ascent is larger than its logical
19219 ascent, use the physical ascent, and make the row taller.
19220 This makes accented characters fully visible. */
19221 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19222 && row
->phys_ascent
> row
->ascent
)
19224 row
->height
+= row
->phys_ascent
- row
->ascent
;
19225 row
->ascent
= row
->phys_ascent
;
19228 /* Compute how much of the line is visible. */
19229 row
->visible_height
= row
->height
;
19231 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19232 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19234 if (row
->y
< min_y
)
19235 row
->visible_height
-= min_y
- row
->y
;
19236 if (row
->y
+ row
->height
> max_y
)
19237 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19241 row
->pixel_width
= row
->used
[TEXT_AREA
];
19242 if (row
->continued_p
)
19243 row
->pixel_width
-= it
->continuation_pixel_width
;
19244 else if (row
->truncated_on_right_p
)
19245 row
->pixel_width
-= it
->truncation_pixel_width
;
19246 row
->ascent
= row
->phys_ascent
= 0;
19247 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19248 row
->extra_line_spacing
= 0;
19251 /* Compute a hash code for this row. */
19252 row
->hash
= row_hash (row
);
19254 it
->max_ascent
= it
->max_descent
= 0;
19255 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19259 /* Append one space to the glyph row of iterator IT if doing a
19260 window-based redisplay. The space has the same face as
19261 IT->face_id. Value is true if a space was added.
19263 This function is called to make sure that there is always one glyph
19264 at the end of a glyph row that the cursor can be set on under
19265 window-systems. (If there weren't such a glyph we would not know
19266 how wide and tall a box cursor should be displayed).
19268 At the same time this space let's a nicely handle clearing to the
19269 end of the line if the row ends in italic text. */
19272 append_space_for_newline (struct it
*it
, bool default_face_p
)
19274 if (FRAME_WINDOW_P (it
->f
))
19276 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19278 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19279 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19281 /* Save some values that must not be changed.
19282 Must save IT->c and IT->len because otherwise
19283 ITERATOR_AT_END_P wouldn't work anymore after
19284 append_space_for_newline has been called. */
19285 enum display_element_type saved_what
= it
->what
;
19286 int saved_c
= it
->c
, saved_len
= it
->len
;
19287 int saved_char_to_display
= it
->char_to_display
;
19288 int saved_x
= it
->current_x
;
19289 int saved_face_id
= it
->face_id
;
19290 bool saved_box_end
= it
->end_of_box_run_p
;
19291 struct text_pos saved_pos
;
19292 Lisp_Object saved_object
;
19296 saved_object
= it
->object
;
19297 saved_pos
= it
->position
;
19299 it
->what
= IT_CHARACTER
;
19300 memset (&it
->position
, 0, sizeof it
->position
);
19302 it
->c
= it
->char_to_display
= ' ';
19305 /* If the default face was remapped, be sure to use the
19306 remapped face for the appended newline. */
19307 if (default_face_p
)
19308 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19309 else if (it
->face_before_selective_p
)
19310 it
->face_id
= it
->saved_face_id
;
19311 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19312 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19313 /* In R2L rows, we will prepend a stretch glyph that will
19314 have the end_of_box_run_p flag set for it, so there's no
19315 need for the appended newline glyph to have that flag
19317 if (it
->glyph_row
->reversed_p
19318 /* But if the appended newline glyph goes all the way to
19319 the end of the row, there will be no stretch glyph,
19320 so leave the box flag set. */
19321 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19322 it
->end_of_box_run_p
= false;
19324 PRODUCE_GLYPHS (it
);
19326 #ifdef HAVE_WINDOW_SYSTEM
19327 /* Make sure this space glyph has the right ascent and
19328 descent values, or else cursor at end of line will look
19329 funny, and height of empty lines will be incorrect. */
19330 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19331 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19334 Lisp_Object height
, total_height
;
19335 int extra_line_spacing
= it
->extra_line_spacing
;
19336 int boff
= font
->baseline_offset
;
19338 if (font
->vertical_centering
)
19339 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19341 it
->object
= saved_object
; /* get_it_property needs this */
19342 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19343 /* Must do a subset of line height processing from
19344 x_produce_glyph for newline characters. */
19345 height
= get_it_property (it
, Qline_height
);
19347 && CONSP (XCDR (height
))
19348 && NILP (XCDR (XCDR (height
))))
19350 total_height
= XCAR (XCDR (height
));
19351 height
= XCAR (height
);
19354 total_height
= Qnil
;
19355 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19357 if (it
->override_ascent
>= 0)
19359 it
->ascent
= it
->override_ascent
;
19360 it
->descent
= it
->override_descent
;
19361 boff
= it
->override_boff
;
19363 if (EQ (height
, Qt
))
19364 extra_line_spacing
= 0;
19367 Lisp_Object spacing
;
19369 it
->phys_ascent
= it
->ascent
;
19370 it
->phys_descent
= it
->descent
;
19372 && XINT (height
) > it
->ascent
+ it
->descent
)
19373 it
->ascent
= XINT (height
) - it
->descent
;
19375 if (!NILP (total_height
))
19376 spacing
= calc_line_height_property (it
, total_height
, font
,
19380 spacing
= get_it_property (it
, Qline_spacing
);
19381 spacing
= calc_line_height_property (it
, spacing
, font
,
19384 if (INTEGERP (spacing
))
19386 extra_line_spacing
= XINT (spacing
);
19387 if (!NILP (total_height
))
19388 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19391 if (extra_line_spacing
> 0)
19393 it
->descent
+= extra_line_spacing
;
19394 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19395 it
->max_extra_line_spacing
= extra_line_spacing
;
19397 it
->max_ascent
= it
->ascent
;
19398 it
->max_descent
= it
->descent
;
19399 /* Make sure compute_line_metrics recomputes the row height. */
19400 it
->glyph_row
->height
= 0;
19403 g
->ascent
= it
->max_ascent
;
19404 g
->descent
= it
->max_descent
;
19407 it
->override_ascent
= -1;
19408 it
->constrain_row_ascent_descent_p
= false;
19409 it
->current_x
= saved_x
;
19410 it
->object
= saved_object
;
19411 it
->position
= saved_pos
;
19412 it
->what
= saved_what
;
19413 it
->face_id
= saved_face_id
;
19414 it
->len
= saved_len
;
19416 it
->char_to_display
= saved_char_to_display
;
19417 it
->end_of_box_run_p
= saved_box_end
;
19426 /* Extend the face of the last glyph in the text area of IT->glyph_row
19427 to the end of the display line. Called from display_line. If the
19428 glyph row is empty, add a space glyph to it so that we know the
19429 face to draw. Set the glyph row flag fill_line_p. If the glyph
19430 row is R2L, prepend a stretch glyph to cover the empty space to the
19431 left of the leftmost glyph. */
19434 extend_face_to_end_of_line (struct it
*it
)
19436 struct face
*face
, *default_face
;
19437 struct frame
*f
= it
->f
;
19439 /* If line is already filled, do nothing. Non window-system frames
19440 get a grace of one more ``pixel'' because their characters are
19441 1-``pixel'' wide, so they hit the equality too early. This grace
19442 is needed only for R2L rows that are not continued, to produce
19443 one extra blank where we could display the cursor. */
19444 if ((it
->current_x
>= it
->last_visible_x
19445 + (!FRAME_WINDOW_P (f
)
19446 && it
->glyph_row
->reversed_p
19447 && !it
->glyph_row
->continued_p
))
19448 /* If the window has display margins, we will need to extend
19449 their face even if the text area is filled. */
19450 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19451 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19454 /* The default face, possibly remapped. */
19455 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19457 /* Face extension extends the background and box of IT->face_id
19458 to the end of the line. If the background equals the background
19459 of the frame, we don't have to do anything. */
19460 if (it
->face_before_selective_p
)
19461 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19463 face
= FACE_FROM_ID (f
, it
->face_id
);
19465 if (FRAME_WINDOW_P (f
)
19466 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19467 && face
->box
== FACE_NO_BOX
19468 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19469 #ifdef HAVE_WINDOW_SYSTEM
19472 && !it
->glyph_row
->reversed_p
)
19475 /* Set the glyph row flag indicating that the face of the last glyph
19476 in the text area has to be drawn to the end of the text area. */
19477 it
->glyph_row
->fill_line_p
= true;
19479 /* If current character of IT is not ASCII, make sure we have the
19480 ASCII face. This will be automatically undone the next time
19481 get_next_display_element returns a multibyte character. Note
19482 that the character will always be single byte in unibyte
19484 if (!ASCII_CHAR_P (it
->c
))
19486 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19489 if (FRAME_WINDOW_P (f
))
19491 /* If the row is empty, add a space with the current face of IT,
19492 so that we know which face to draw. */
19493 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19495 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19496 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19497 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19499 /* Mode line and the header line don't have margins, and
19500 likewise the frame's tool-bar window, if there is any. */
19501 if (!(it
->glyph_row
->mode_line_p
19502 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19503 || (WINDOWP (f
->tool_bar_window
)
19504 && it
->w
== XWINDOW (f
->tool_bar_window
))
19508 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19509 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19511 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19512 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19514 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19516 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19517 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19519 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19520 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19522 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19525 #ifdef HAVE_WINDOW_SYSTEM
19526 if (it
->glyph_row
->reversed_p
)
19528 /* Prepend a stretch glyph to the row, such that the
19529 rightmost glyph will be drawn flushed all the way to the
19530 right margin of the window. The stretch glyph that will
19531 occupy the empty space, if any, to the left of the
19533 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19534 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19535 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19537 int row_width
, stretch_ascent
, stretch_width
;
19538 struct text_pos saved_pos
;
19540 bool saved_avoid_cursor
, saved_box_start
;
19542 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19543 row_width
+= g
->pixel_width
;
19545 /* FIXME: There are various minor display glitches in R2L
19546 rows when only one of the fringes is missing. The
19547 strange condition below produces the least bad effect. */
19548 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19549 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19550 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19551 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19553 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19554 stretch_width
-= row_width
;
19556 if (stretch_width
> 0)
19559 (((it
->ascent
+ it
->descent
)
19560 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19561 saved_pos
= it
->position
;
19562 memset (&it
->position
, 0, sizeof it
->position
);
19563 saved_avoid_cursor
= it
->avoid_cursor_p
;
19564 it
->avoid_cursor_p
= true;
19565 saved_face_id
= it
->face_id
;
19566 saved_box_start
= it
->start_of_box_run_p
;
19567 /* The last row's stretch glyph should get the default
19568 face, to avoid painting the rest of the window with
19569 the region face, if the region ends at ZV. */
19570 if (it
->glyph_row
->ends_at_zv_p
)
19571 it
->face_id
= default_face
->id
;
19573 it
->face_id
= face
->id
;
19574 it
->start_of_box_run_p
= false;
19575 append_stretch_glyph (it
, Qnil
, stretch_width
,
19576 it
->ascent
+ it
->descent
, stretch_ascent
);
19577 it
->position
= saved_pos
;
19578 it
->avoid_cursor_p
= saved_avoid_cursor
;
19579 it
->face_id
= saved_face_id
;
19580 it
->start_of_box_run_p
= saved_box_start
;
19582 /* If stretch_width comes out negative, it means that the
19583 last glyph is only partially visible. In R2L rows, we
19584 want the leftmost glyph to be partially visible, so we
19585 need to give the row the corresponding left offset. */
19586 if (stretch_width
< 0)
19587 it
->glyph_row
->x
= stretch_width
;
19589 #endif /* HAVE_WINDOW_SYSTEM */
19593 /* Save some values that must not be changed. */
19594 int saved_x
= it
->current_x
;
19595 struct text_pos saved_pos
;
19596 Lisp_Object saved_object
;
19597 enum display_element_type saved_what
= it
->what
;
19598 int saved_face_id
= it
->face_id
;
19600 saved_object
= it
->object
;
19601 saved_pos
= it
->position
;
19603 it
->what
= IT_CHARACTER
;
19604 memset (&it
->position
, 0, sizeof it
->position
);
19606 it
->c
= it
->char_to_display
= ' ';
19609 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19610 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19611 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19612 && !it
->glyph_row
->mode_line_p
19613 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19615 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19616 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19618 for (it
->current_x
= 0; g
< e
; g
++)
19619 it
->current_x
+= g
->pixel_width
;
19621 it
->area
= LEFT_MARGIN_AREA
;
19622 it
->face_id
= default_face
->id
;
19623 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19624 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19626 PRODUCE_GLYPHS (it
);
19627 /* term.c:produce_glyphs advances it->current_x only for
19629 it
->current_x
+= it
->pixel_width
;
19632 it
->current_x
= saved_x
;
19633 it
->area
= TEXT_AREA
;
19636 /* The last row's blank glyphs should get the default face, to
19637 avoid painting the rest of the window with the region face,
19638 if the region ends at ZV. */
19639 if (it
->glyph_row
->ends_at_zv_p
)
19640 it
->face_id
= default_face
->id
;
19642 it
->face_id
= face
->id
;
19643 PRODUCE_GLYPHS (it
);
19645 while (it
->current_x
<= it
->last_visible_x
)
19646 PRODUCE_GLYPHS (it
);
19648 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19649 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19650 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19651 && !it
->glyph_row
->mode_line_p
19652 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19654 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19655 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19657 for ( ; g
< e
; g
++)
19658 it
->current_x
+= g
->pixel_width
;
19660 it
->area
= RIGHT_MARGIN_AREA
;
19661 it
->face_id
= default_face
->id
;
19662 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19663 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19665 PRODUCE_GLYPHS (it
);
19666 it
->current_x
+= it
->pixel_width
;
19669 it
->area
= TEXT_AREA
;
19672 /* Don't count these blanks really. It would let us insert a left
19673 truncation glyph below and make us set the cursor on them, maybe. */
19674 it
->current_x
= saved_x
;
19675 it
->object
= saved_object
;
19676 it
->position
= saved_pos
;
19677 it
->what
= saved_what
;
19678 it
->face_id
= saved_face_id
;
19683 /* Value is true if text starting at CHARPOS in current_buffer is
19684 trailing whitespace. */
19687 trailing_whitespace_p (ptrdiff_t charpos
)
19689 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19692 while (bytepos
< ZV_BYTE
19693 && (c
= FETCH_CHAR (bytepos
),
19694 c
== ' ' || c
== '\t'))
19697 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19699 if (bytepos
!= PT_BYTE
)
19706 /* Highlight trailing whitespace, if any, in ROW. */
19709 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19711 int used
= row
->used
[TEXT_AREA
];
19715 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19716 struct glyph
*glyph
= start
+ used
- 1;
19718 if (row
->reversed_p
)
19720 /* Right-to-left rows need to be processed in the opposite
19721 direction, so swap the edge pointers. */
19723 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19726 /* Skip over glyphs inserted to display the cursor at the
19727 end of a line, for extending the face of the last glyph
19728 to the end of the line on terminals, and for truncation
19729 and continuation glyphs. */
19730 if (!row
->reversed_p
)
19732 while (glyph
>= start
19733 && glyph
->type
== CHAR_GLYPH
19734 && NILP (glyph
->object
))
19739 while (glyph
<= start
19740 && glyph
->type
== CHAR_GLYPH
19741 && NILP (glyph
->object
))
19745 /* If last glyph is a space or stretch, and it's trailing
19746 whitespace, set the face of all trailing whitespace glyphs in
19747 IT->glyph_row to `trailing-whitespace'. */
19748 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19749 && BUFFERP (glyph
->object
)
19750 && (glyph
->type
== STRETCH_GLYPH
19751 || (glyph
->type
== CHAR_GLYPH
19752 && glyph
->u
.ch
== ' '))
19753 && trailing_whitespace_p (glyph
->charpos
))
19755 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19759 if (!row
->reversed_p
)
19761 while (glyph
>= start
19762 && BUFFERP (glyph
->object
)
19763 && (glyph
->type
== STRETCH_GLYPH
19764 || (glyph
->type
== CHAR_GLYPH
19765 && glyph
->u
.ch
== ' ')))
19766 (glyph
--)->face_id
= face_id
;
19770 while (glyph
<= start
19771 && BUFFERP (glyph
->object
)
19772 && (glyph
->type
== STRETCH_GLYPH
19773 || (glyph
->type
== CHAR_GLYPH
19774 && glyph
->u
.ch
== ' ')))
19775 (glyph
++)->face_id
= face_id
;
19782 /* Value is true if glyph row ROW should be
19783 considered to hold the buffer position CHARPOS. */
19786 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19788 bool result
= true;
19790 if (charpos
== CHARPOS (row
->end
.pos
)
19791 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19793 /* Suppose the row ends on a string.
19794 Unless the row is continued, that means it ends on a newline
19795 in the string. If it's anything other than a display string
19796 (e.g., a before-string from an overlay), we don't want the
19797 cursor there. (This heuristic seems to give the optimal
19798 behavior for the various types of multi-line strings.)
19799 One exception: if the string has `cursor' property on one of
19800 its characters, we _do_ want the cursor there. */
19801 if (CHARPOS (row
->end
.string_pos
) >= 0)
19803 if (row
->continued_p
)
19807 /* Check for `display' property. */
19808 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19809 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19810 struct glyph
*glyph
;
19813 for (glyph
= end
; glyph
>= beg
; --glyph
)
19814 if (STRINGP (glyph
->object
))
19817 = Fget_char_property (make_number (charpos
),
19821 && display_prop_string_p (prop
, glyph
->object
));
19822 /* If there's a `cursor' property on one of the
19823 string's characters, this row is a cursor row,
19824 even though this is not a display string. */
19827 Lisp_Object s
= glyph
->object
;
19829 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19831 ptrdiff_t gpos
= glyph
->charpos
;
19833 if (!NILP (Fget_char_property (make_number (gpos
),
19845 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19847 /* If the row ends in middle of a real character,
19848 and the line is continued, we want the cursor here.
19849 That's because CHARPOS (ROW->end.pos) would equal
19850 PT if PT is before the character. */
19851 if (!row
->ends_in_ellipsis_p
)
19852 result
= row
->continued_p
;
19854 /* If the row ends in an ellipsis, then
19855 CHARPOS (ROW->end.pos) will equal point after the
19856 invisible text. We want that position to be displayed
19857 after the ellipsis. */
19860 /* If the row ends at ZV, display the cursor at the end of that
19861 row instead of at the start of the row below. */
19863 result
= row
->ends_at_zv_p
;
19869 /* Value is true if glyph row ROW should be
19870 used to hold the cursor. */
19873 cursor_row_p (struct glyph_row
*row
)
19875 return row_for_charpos_p (row
, PT
);
19880 /* Push the property PROP so that it will be rendered at the current
19881 position in IT. Return true if PROP was successfully pushed, false
19882 otherwise. Called from handle_line_prefix to handle the
19883 `line-prefix' and `wrap-prefix' properties. */
19886 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19888 struct text_pos pos
=
19889 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19891 eassert (it
->method
== GET_FROM_BUFFER
19892 || it
->method
== GET_FROM_DISPLAY_VECTOR
19893 || it
->method
== GET_FROM_STRING
19894 || it
->method
== GET_FROM_IMAGE
);
19896 /* We need to save the current buffer/string position, so it will be
19897 restored by pop_it, because iterate_out_of_display_property
19898 depends on that being set correctly, but some situations leave
19899 it->position not yet set when this function is called. */
19900 push_it (it
, &pos
);
19902 if (STRINGP (prop
))
19904 if (SCHARS (prop
) == 0)
19911 it
->string_from_prefix_prop_p
= true;
19912 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19913 it
->current
.overlay_string_index
= -1;
19914 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19915 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19916 it
->method
= GET_FROM_STRING
;
19917 it
->stop_charpos
= 0;
19919 it
->base_level_stop
= 0;
19921 /* Force paragraph direction to be that of the parent
19923 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19924 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19926 it
->paragraph_embedding
= L2R
;
19928 /* Set up the bidi iterator for this display string. */
19931 it
->bidi_it
.string
.lstring
= it
->string
;
19932 it
->bidi_it
.string
.s
= NULL
;
19933 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19934 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19935 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19936 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19937 it
->bidi_it
.w
= it
->w
;
19938 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19941 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19943 it
->method
= GET_FROM_STRETCH
;
19946 #ifdef HAVE_WINDOW_SYSTEM
19947 else if (IMAGEP (prop
))
19949 it
->what
= IT_IMAGE
;
19950 it
->image_id
= lookup_image (it
->f
, prop
);
19951 it
->method
= GET_FROM_IMAGE
;
19953 #endif /* HAVE_WINDOW_SYSTEM */
19956 pop_it (it
); /* bogus display property, give up */
19963 /* Return the character-property PROP at the current position in IT. */
19966 get_it_property (struct it
*it
, Lisp_Object prop
)
19968 Lisp_Object position
, object
= it
->object
;
19970 if (STRINGP (object
))
19971 position
= make_number (IT_STRING_CHARPOS (*it
));
19972 else if (BUFFERP (object
))
19974 position
= make_number (IT_CHARPOS (*it
));
19975 object
= it
->window
;
19980 return Fget_char_property (position
, prop
, object
);
19983 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19986 handle_line_prefix (struct it
*it
)
19988 Lisp_Object prefix
;
19990 if (it
->continuation_lines_width
> 0)
19992 prefix
= get_it_property (it
, Qwrap_prefix
);
19994 prefix
= Vwrap_prefix
;
19998 prefix
= get_it_property (it
, Qline_prefix
);
20000 prefix
= Vline_prefix
;
20002 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20004 /* If the prefix is wider than the window, and we try to wrap
20005 it, it would acquire its own wrap prefix, and so on till the
20006 iterator stack overflows. So, don't wrap the prefix. */
20007 it
->line_wrap
= TRUNCATE
;
20008 it
->avoid_cursor_p
= true;
20014 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20015 only for R2L lines from display_line and display_string, when they
20016 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20017 the line/string needs to be continued on the next glyph row. */
20019 unproduce_glyphs (struct it
*it
, int n
)
20021 struct glyph
*glyph
, *end
;
20023 eassert (it
->glyph_row
);
20024 eassert (it
->glyph_row
->reversed_p
);
20025 eassert (it
->area
== TEXT_AREA
);
20026 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20028 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20029 n
= it
->glyph_row
->used
[TEXT_AREA
];
20030 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20031 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20032 for ( ; glyph
< end
; glyph
++)
20033 glyph
[-n
] = *glyph
;
20036 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20037 and ROW->maxpos. */
20039 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20040 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20041 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20043 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20044 lines' rows is implemented for bidi-reordered rows. */
20046 /* ROW->minpos is the value of min_pos, the minimal buffer position
20047 we have in ROW, or ROW->start.pos if that is smaller. */
20048 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20049 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20051 /* We didn't find buffer positions smaller than ROW->start, or
20052 didn't find _any_ valid buffer positions in any of the glyphs,
20053 so we must trust the iterator's computed positions. */
20054 row
->minpos
= row
->start
.pos
;
20057 max_pos
= CHARPOS (it
->current
.pos
);
20058 max_bpos
= BYTEPOS (it
->current
.pos
);
20061 /* Here are the various use-cases for ending the row, and the
20062 corresponding values for ROW->maxpos:
20064 Line ends in a newline from buffer eol_pos + 1
20065 Line is continued from buffer max_pos + 1
20066 Line is truncated on right it->current.pos
20067 Line ends in a newline from string max_pos + 1(*)
20068 (*) + 1 only when line ends in a forward scan
20069 Line is continued from string max_pos
20070 Line is continued from display vector max_pos
20071 Line is entirely from a string min_pos == max_pos
20072 Line is entirely from a display vector min_pos == max_pos
20073 Line that ends at ZV ZV
20075 If you discover other use-cases, please add them here as
20077 if (row
->ends_at_zv_p
)
20078 row
->maxpos
= it
->current
.pos
;
20079 else if (row
->used
[TEXT_AREA
])
20081 bool seen_this_string
= false;
20082 struct glyph_row
*r1
= row
- 1;
20084 /* Did we see the same display string on the previous row? */
20085 if (STRINGP (it
->object
)
20086 /* this is not the first row */
20087 && row
> it
->w
->desired_matrix
->rows
20088 /* previous row is not the header line */
20089 && !r1
->mode_line_p
20090 /* previous row also ends in a newline from a string */
20091 && r1
->ends_in_newline_from_string_p
)
20093 struct glyph
*start
, *end
;
20095 /* Search for the last glyph of the previous row that came
20096 from buffer or string. Depending on whether the row is
20097 L2R or R2L, we need to process it front to back or the
20098 other way round. */
20099 if (!r1
->reversed_p
)
20101 start
= r1
->glyphs
[TEXT_AREA
];
20102 end
= start
+ r1
->used
[TEXT_AREA
];
20103 /* Glyphs inserted by redisplay have nil as their object. */
20105 && NILP ((end
- 1)->object
)
20106 && (end
- 1)->charpos
<= 0)
20110 if (EQ ((end
- 1)->object
, it
->object
))
20111 seen_this_string
= true;
20114 /* If all the glyphs of the previous row were inserted
20115 by redisplay, it means the previous row was
20116 produced from a single newline, which is only
20117 possible if that newline came from the same string
20118 as the one which produced this ROW. */
20119 seen_this_string
= true;
20123 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20124 start
= end
+ r1
->used
[TEXT_AREA
];
20126 && NILP ((end
+ 1)->object
)
20127 && (end
+ 1)->charpos
<= 0)
20131 if (EQ ((end
+ 1)->object
, it
->object
))
20132 seen_this_string
= true;
20135 seen_this_string
= true;
20138 /* Take note of each display string that covers a newline only
20139 once, the first time we see it. This is for when a display
20140 string includes more than one newline in it. */
20141 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20143 /* If we were scanning the buffer forward when we displayed
20144 the string, we want to account for at least one buffer
20145 position that belongs to this row (position covered by
20146 the display string), so that cursor positioning will
20147 consider this row as a candidate when point is at the end
20148 of the visual line represented by this row. This is not
20149 required when scanning back, because max_pos will already
20150 have a much larger value. */
20151 if (CHARPOS (row
->end
.pos
) > max_pos
)
20152 INC_BOTH (max_pos
, max_bpos
);
20153 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20155 else if (CHARPOS (it
->eol_pos
) > 0)
20156 SET_TEXT_POS (row
->maxpos
,
20157 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20158 else if (row
->continued_p
)
20160 /* If max_pos is different from IT's current position, it
20161 means IT->method does not belong to the display element
20162 at max_pos. However, it also means that the display
20163 element at max_pos was displayed in its entirety on this
20164 line, which is equivalent to saying that the next line
20165 starts at the next buffer position. */
20166 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20167 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20170 INC_BOTH (max_pos
, max_bpos
);
20171 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20174 else if (row
->truncated_on_right_p
)
20175 /* display_line already called reseat_at_next_visible_line_start,
20176 which puts the iterator at the beginning of the next line, in
20177 the logical order. */
20178 row
->maxpos
= it
->current
.pos
;
20179 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20180 /* A line that is entirely from a string/image/stretch... */
20181 row
->maxpos
= row
->minpos
;
20186 row
->maxpos
= it
->current
.pos
;
20189 /* Construct the glyph row IT->glyph_row in the desired matrix of
20190 IT->w from text at the current position of IT. See dispextern.h
20191 for an overview of struct it. Value is true if
20192 IT->glyph_row displays text, as opposed to a line displaying ZV
20196 display_line (struct it
*it
)
20198 struct glyph_row
*row
= it
->glyph_row
;
20199 Lisp_Object overlay_arrow_string
;
20201 void *wrap_data
= NULL
;
20202 bool may_wrap
= false;
20203 int wrap_x
IF_LINT (= 0);
20204 int wrap_row_used
= -1;
20205 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20206 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20207 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20208 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20209 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20211 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20212 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20213 bool pending_handle_line_prefix
= false;
20215 /* We always start displaying at hpos zero even if hscrolled. */
20216 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20218 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20219 >= it
->w
->desired_matrix
->nrows
)
20221 it
->w
->nrows_scale_factor
++;
20222 it
->f
->fonts_changed
= true;
20226 /* Clear the result glyph row and enable it. */
20227 prepare_desired_row (it
->w
, row
, false);
20229 row
->y
= it
->current_y
;
20230 row
->start
= it
->start
;
20231 row
->continuation_lines_width
= it
->continuation_lines_width
;
20232 row
->displays_text_p
= true;
20233 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20234 it
->starts_in_middle_of_char_p
= false;
20236 /* Arrange the overlays nicely for our purposes. Usually, we call
20237 display_line on only one line at a time, in which case this
20238 can't really hurt too much, or we call it on lines which appear
20239 one after another in the buffer, in which case all calls to
20240 recenter_overlay_lists but the first will be pretty cheap. */
20241 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20243 /* Move over display elements that are not visible because we are
20244 hscrolled. This may stop at an x-position < IT->first_visible_x
20245 if the first glyph is partially visible or if we hit a line end. */
20246 if (it
->current_x
< it
->first_visible_x
)
20248 enum move_it_result move_result
;
20250 this_line_min_pos
= row
->start
.pos
;
20251 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20252 MOVE_TO_POS
| MOVE_TO_X
);
20253 /* If we are under a large hscroll, move_it_in_display_line_to
20254 could hit the end of the line without reaching
20255 it->first_visible_x. Pretend that we did reach it. This is
20256 especially important on a TTY, where we will call
20257 extend_face_to_end_of_line, which needs to know how many
20258 blank glyphs to produce. */
20259 if (it
->current_x
< it
->first_visible_x
20260 && (move_result
== MOVE_NEWLINE_OR_CR
20261 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20262 it
->current_x
= it
->first_visible_x
;
20264 /* Record the smallest positions seen while we moved over
20265 display elements that are not visible. This is needed by
20266 redisplay_internal for optimizing the case where the cursor
20267 stays inside the same line. The rest of this function only
20268 considers positions that are actually displayed, so
20269 RECORD_MAX_MIN_POS will not otherwise record positions that
20270 are hscrolled to the left of the left edge of the window. */
20271 min_pos
= CHARPOS (this_line_min_pos
);
20272 min_bpos
= BYTEPOS (this_line_min_pos
);
20274 else if (it
->area
== TEXT_AREA
)
20276 /* We only do this when not calling move_it_in_display_line_to
20277 above, because that function calls itself handle_line_prefix. */
20278 handle_line_prefix (it
);
20282 /* Line-prefix and wrap-prefix are always displayed in the text
20283 area. But if this is the first call to display_line after
20284 init_iterator, the iterator might have been set up to write
20285 into a marginal area, e.g. if the line begins with some
20286 display property that writes to the margins. So we need to
20287 wait with the call to handle_line_prefix until whatever
20288 writes to the margin has done its job. */
20289 pending_handle_line_prefix
= true;
20292 /* Get the initial row height. This is either the height of the
20293 text hscrolled, if there is any, or zero. */
20294 row
->ascent
= it
->max_ascent
;
20295 row
->height
= it
->max_ascent
+ it
->max_descent
;
20296 row
->phys_ascent
= it
->max_phys_ascent
;
20297 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20298 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20300 /* Utility macro to record max and min buffer positions seen until now. */
20301 #define RECORD_MAX_MIN_POS(IT) \
20304 bool composition_p \
20305 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20306 ptrdiff_t current_pos = \
20307 composition_p ? (IT)->cmp_it.charpos \
20308 : IT_CHARPOS (*(IT)); \
20309 ptrdiff_t current_bpos = \
20310 composition_p ? CHAR_TO_BYTE (current_pos) \
20311 : IT_BYTEPOS (*(IT)); \
20312 if (current_pos < min_pos) \
20314 min_pos = current_pos; \
20315 min_bpos = current_bpos; \
20317 if (IT_CHARPOS (*it) > max_pos) \
20319 max_pos = IT_CHARPOS (*it); \
20320 max_bpos = IT_BYTEPOS (*it); \
20325 /* Loop generating characters. The loop is left with IT on the next
20326 character to display. */
20329 int n_glyphs_before
, hpos_before
, x_before
;
20331 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20333 /* Retrieve the next thing to display. Value is false if end of
20335 if (!get_next_display_element (it
))
20337 /* Maybe add a space at the end of this line that is used to
20338 display the cursor there under X. Set the charpos of the
20339 first glyph of blank lines not corresponding to any text
20341 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20342 row
->exact_window_width_line_p
= true;
20343 else if ((append_space_for_newline (it
, true)
20344 && row
->used
[TEXT_AREA
] == 1)
20345 || row
->used
[TEXT_AREA
] == 0)
20347 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20348 row
->displays_text_p
= false;
20350 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20351 && (!MINI_WINDOW_P (it
->w
)
20352 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20353 row
->indicate_empty_line_p
= true;
20356 it
->continuation_lines_width
= 0;
20357 row
->ends_at_zv_p
= true;
20358 /* A row that displays right-to-left text must always have
20359 its last face extended all the way to the end of line,
20360 even if this row ends in ZV, because we still write to
20361 the screen left to right. We also need to extend the
20362 last face if the default face is remapped to some
20363 different face, otherwise the functions that clear
20364 portions of the screen will clear with the default face's
20365 background color. */
20366 if (row
->reversed_p
20367 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20368 extend_face_to_end_of_line (it
);
20372 /* Now, get the metrics of what we want to display. This also
20373 generates glyphs in `row' (which is IT->glyph_row). */
20374 n_glyphs_before
= row
->used
[TEXT_AREA
];
20377 /* Remember the line height so far in case the next element doesn't
20378 fit on the line. */
20379 if (it
->line_wrap
!= TRUNCATE
)
20381 ascent
= it
->max_ascent
;
20382 descent
= it
->max_descent
;
20383 phys_ascent
= it
->max_phys_ascent
;
20384 phys_descent
= it
->max_phys_descent
;
20386 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20388 if (IT_DISPLAYING_WHITESPACE (it
))
20392 SAVE_IT (wrap_it
, *it
, wrap_data
);
20394 wrap_row_used
= row
->used
[TEXT_AREA
];
20395 wrap_row_ascent
= row
->ascent
;
20396 wrap_row_height
= row
->height
;
20397 wrap_row_phys_ascent
= row
->phys_ascent
;
20398 wrap_row_phys_height
= row
->phys_height
;
20399 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20400 wrap_row_min_pos
= min_pos
;
20401 wrap_row_min_bpos
= min_bpos
;
20402 wrap_row_max_pos
= max_pos
;
20403 wrap_row_max_bpos
= max_bpos
;
20409 PRODUCE_GLYPHS (it
);
20411 /* If this display element was in marginal areas, continue with
20413 if (it
->area
!= TEXT_AREA
)
20415 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20416 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20417 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20418 row
->phys_height
= max (row
->phys_height
,
20419 it
->max_phys_ascent
+ it
->max_phys_descent
);
20420 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20421 it
->max_extra_line_spacing
);
20422 set_iterator_to_next (it
, true);
20423 /* If we didn't handle the line/wrap prefix above, and the
20424 call to set_iterator_to_next just switched to TEXT_AREA,
20425 process the prefix now. */
20426 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20428 pending_handle_line_prefix
= false;
20429 handle_line_prefix (it
);
20434 /* Does the display element fit on the line? If we truncate
20435 lines, we should draw past the right edge of the window. If
20436 we don't truncate, we want to stop so that we can display the
20437 continuation glyph before the right margin. If lines are
20438 continued, there are two possible strategies for characters
20439 resulting in more than 1 glyph (e.g. tabs): Display as many
20440 glyphs as possible in this line and leave the rest for the
20441 continuation line, or display the whole element in the next
20442 line. Original redisplay did the former, so we do it also. */
20443 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20444 hpos_before
= it
->hpos
;
20447 if (/* Not a newline. */
20449 /* Glyphs produced fit entirely in the line. */
20450 && it
->current_x
< it
->last_visible_x
)
20452 it
->hpos
+= nglyphs
;
20453 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20454 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20455 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20456 row
->phys_height
= max (row
->phys_height
,
20457 it
->max_phys_ascent
+ it
->max_phys_descent
);
20458 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20459 it
->max_extra_line_spacing
);
20460 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20461 /* In R2L rows, we arrange in extend_face_to_end_of_line
20462 to add a right offset to the line, by a suitable
20463 change to the stretch glyph that is the leftmost
20464 glyph of the line. */
20465 && !row
->reversed_p
)
20466 row
->x
= x
- it
->first_visible_x
;
20467 /* Record the maximum and minimum buffer positions seen so
20468 far in glyphs that will be displayed by this row. */
20470 RECORD_MAX_MIN_POS (it
);
20475 struct glyph
*glyph
;
20477 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20479 /* Identify the glyphs added by the last call to
20480 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20481 the previous glyphs. */
20482 if (!row
->reversed_p
)
20483 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20485 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20486 new_x
= x
+ glyph
->pixel_width
;
20488 if (/* Lines are continued. */
20489 it
->line_wrap
!= TRUNCATE
20490 && (/* Glyph doesn't fit on the line. */
20491 new_x
> it
->last_visible_x
20492 /* Or it fits exactly on a window system frame. */
20493 || (new_x
== it
->last_visible_x
20494 && FRAME_WINDOW_P (it
->f
)
20495 && (row
->reversed_p
20496 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20497 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20499 /* End of a continued line. */
20502 || (new_x
== it
->last_visible_x
20503 && FRAME_WINDOW_P (it
->f
)
20504 && (row
->reversed_p
20505 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20506 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20508 /* Current glyph is the only one on the line or
20509 fits exactly on the line. We must continue
20510 the line because we can't draw the cursor
20511 after the glyph. */
20512 row
->continued_p
= true;
20513 it
->current_x
= new_x
;
20514 it
->continuation_lines_width
+= new_x
;
20516 if (i
== nglyphs
- 1)
20518 /* If line-wrap is on, check if a previous
20519 wrap point was found. */
20520 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20521 && wrap_row_used
> 0
20522 /* Even if there is a previous wrap
20523 point, continue the line here as
20524 usual, if (i) the previous character
20525 was a space or tab AND (ii) the
20526 current character is not. */
20528 || IT_DISPLAYING_WHITESPACE (it
)))
20531 /* Record the maximum and minimum buffer
20532 positions seen so far in glyphs that will be
20533 displayed by this row. */
20535 RECORD_MAX_MIN_POS (it
);
20536 set_iterator_to_next (it
, true);
20537 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20539 if (!get_next_display_element (it
))
20541 row
->exact_window_width_line_p
= true;
20542 it
->continuation_lines_width
= 0;
20543 row
->continued_p
= false;
20544 row
->ends_at_zv_p
= true;
20546 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20548 row
->continued_p
= false;
20549 row
->exact_window_width_line_p
= true;
20551 /* If line-wrap is on, check if a
20552 previous wrap point was found. */
20553 else if (wrap_row_used
> 0
20554 /* Even if there is a previous wrap
20555 point, continue the line here as
20556 usual, if (i) the previous character
20557 was a space or tab AND (ii) the
20558 current character is not. */
20560 || IT_DISPLAYING_WHITESPACE (it
)))
20565 else if (it
->bidi_p
)
20566 RECORD_MAX_MIN_POS (it
);
20567 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20568 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20569 extend_face_to_end_of_line (it
);
20571 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20572 && !FRAME_WINDOW_P (it
->f
))
20574 /* A padding glyph that doesn't fit on this line.
20575 This means the whole character doesn't fit
20577 if (row
->reversed_p
)
20578 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20579 - n_glyphs_before
);
20580 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20582 /* Fill the rest of the row with continuation
20583 glyphs like in 20.x. */
20584 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20585 < row
->glyphs
[1 + TEXT_AREA
])
20586 produce_special_glyphs (it
, IT_CONTINUATION
);
20588 row
->continued_p
= true;
20589 it
->current_x
= x_before
;
20590 it
->continuation_lines_width
+= x_before
;
20592 /* Restore the height to what it was before the
20593 element not fitting on the line. */
20594 it
->max_ascent
= ascent
;
20595 it
->max_descent
= descent
;
20596 it
->max_phys_ascent
= phys_ascent
;
20597 it
->max_phys_descent
= phys_descent
;
20598 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20599 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20600 extend_face_to_end_of_line (it
);
20602 else if (wrap_row_used
> 0)
20605 if (row
->reversed_p
)
20606 unproduce_glyphs (it
,
20607 row
->used
[TEXT_AREA
] - wrap_row_used
);
20608 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20609 it
->continuation_lines_width
+= wrap_x
;
20610 row
->used
[TEXT_AREA
] = wrap_row_used
;
20611 row
->ascent
= wrap_row_ascent
;
20612 row
->height
= wrap_row_height
;
20613 row
->phys_ascent
= wrap_row_phys_ascent
;
20614 row
->phys_height
= wrap_row_phys_height
;
20615 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20616 min_pos
= wrap_row_min_pos
;
20617 min_bpos
= wrap_row_min_bpos
;
20618 max_pos
= wrap_row_max_pos
;
20619 max_bpos
= wrap_row_max_bpos
;
20620 row
->continued_p
= true;
20621 row
->ends_at_zv_p
= false;
20622 row
->exact_window_width_line_p
= false;
20623 it
->continuation_lines_width
+= x
;
20625 /* Make sure that a non-default face is extended
20626 up to the right margin of the window. */
20627 extend_face_to_end_of_line (it
);
20629 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20631 /* A TAB that extends past the right edge of the
20632 window. This produces a single glyph on
20633 window system frames. We leave the glyph in
20634 this row and let it fill the row, but don't
20635 consume the TAB. */
20636 if ((row
->reversed_p
20637 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20638 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20639 produce_special_glyphs (it
, IT_CONTINUATION
);
20640 it
->continuation_lines_width
+= it
->last_visible_x
;
20641 row
->ends_in_middle_of_char_p
= true;
20642 row
->continued_p
= true;
20643 glyph
->pixel_width
= it
->last_visible_x
- x
;
20644 it
->starts_in_middle_of_char_p
= true;
20645 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20646 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20647 extend_face_to_end_of_line (it
);
20651 /* Something other than a TAB that draws past
20652 the right edge of the window. Restore
20653 positions to values before the element. */
20654 if (row
->reversed_p
)
20655 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20656 - (n_glyphs_before
+ i
));
20657 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20659 /* Display continuation glyphs. */
20660 it
->current_x
= x_before
;
20661 it
->continuation_lines_width
+= x
;
20662 if (!FRAME_WINDOW_P (it
->f
)
20663 || (row
->reversed_p
20664 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20665 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20666 produce_special_glyphs (it
, IT_CONTINUATION
);
20667 row
->continued_p
= true;
20669 extend_face_to_end_of_line (it
);
20671 if (nglyphs
> 1 && i
> 0)
20673 row
->ends_in_middle_of_char_p
= true;
20674 it
->starts_in_middle_of_char_p
= true;
20677 /* Restore the height to what it was before the
20678 element not fitting on the line. */
20679 it
->max_ascent
= ascent
;
20680 it
->max_descent
= descent
;
20681 it
->max_phys_ascent
= phys_ascent
;
20682 it
->max_phys_descent
= phys_descent
;
20687 else if (new_x
> it
->first_visible_x
)
20689 /* Increment number of glyphs actually displayed. */
20692 /* Record the maximum and minimum buffer positions
20693 seen so far in glyphs that will be displayed by
20696 RECORD_MAX_MIN_POS (it
);
20698 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20699 /* Glyph is partially visible, i.e. row starts at
20700 negative X position. Don't do that in R2L
20701 rows, where we arrange to add a right offset to
20702 the line in extend_face_to_end_of_line, by a
20703 suitable change to the stretch glyph that is
20704 the leftmost glyph of the line. */
20705 row
->x
= x
- it
->first_visible_x
;
20706 /* When the last glyph of an R2L row only fits
20707 partially on the line, we need to set row->x to a
20708 negative offset, so that the leftmost glyph is
20709 the one that is partially visible. But if we are
20710 going to produce the truncation glyph, this will
20711 be taken care of in produce_special_glyphs. */
20712 if (row
->reversed_p
20713 && new_x
> it
->last_visible_x
20714 && !(it
->line_wrap
== TRUNCATE
20715 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20717 eassert (FRAME_WINDOW_P (it
->f
));
20718 row
->x
= it
->last_visible_x
- new_x
;
20723 /* Glyph is completely off the left margin of the
20724 window. This should not happen because of the
20725 move_it_in_display_line at the start of this
20726 function, unless the text display area of the
20727 window is empty. */
20728 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20731 /* Even if this display element produced no glyphs at all,
20732 we want to record its position. */
20733 if (it
->bidi_p
&& nglyphs
== 0)
20734 RECORD_MAX_MIN_POS (it
);
20736 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20737 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20738 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20739 row
->phys_height
= max (row
->phys_height
,
20740 it
->max_phys_ascent
+ it
->max_phys_descent
);
20741 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20742 it
->max_extra_line_spacing
);
20744 /* End of this display line if row is continued. */
20745 if (row
->continued_p
|| row
->ends_at_zv_p
)
20750 /* Is this a line end? If yes, we're also done, after making
20751 sure that a non-default face is extended up to the right
20752 margin of the window. */
20753 if (ITERATOR_AT_END_OF_LINE_P (it
))
20755 int used_before
= row
->used
[TEXT_AREA
];
20757 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20759 /* Add a space at the end of the line that is used to
20760 display the cursor there. */
20761 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20762 append_space_for_newline (it
, false);
20764 /* Extend the face to the end of the line. */
20765 extend_face_to_end_of_line (it
);
20767 /* Make sure we have the position. */
20768 if (used_before
== 0)
20769 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20771 /* Record the position of the newline, for use in
20773 it
->eol_pos
= it
->current
.pos
;
20775 /* Consume the line end. This skips over invisible lines. */
20776 set_iterator_to_next (it
, true);
20777 it
->continuation_lines_width
= 0;
20781 /* Proceed with next display element. Note that this skips
20782 over lines invisible because of selective display. */
20783 set_iterator_to_next (it
, true);
20785 /* If we truncate lines, we are done when the last displayed
20786 glyphs reach past the right margin of the window. */
20787 if (it
->line_wrap
== TRUNCATE
20788 && ((FRAME_WINDOW_P (it
->f
)
20789 /* Images are preprocessed in produce_image_glyph such
20790 that they are cropped at the right edge of the
20791 window, so an image glyph will always end exactly at
20792 last_visible_x, even if there's no right fringe. */
20793 && ((row
->reversed_p
20794 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20795 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20796 || it
->what
== IT_IMAGE
))
20797 ? (it
->current_x
>= it
->last_visible_x
)
20798 : (it
->current_x
> it
->last_visible_x
)))
20800 /* Maybe add truncation glyphs. */
20801 if (!FRAME_WINDOW_P (it
->f
)
20802 || (row
->reversed_p
20803 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20804 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20808 if (!row
->reversed_p
)
20810 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20811 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20816 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20817 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20819 /* Remove any padding glyphs at the front of ROW, to
20820 make room for the truncation glyphs we will be
20821 adding below. The loop below always inserts at
20822 least one truncation glyph, so also remove the
20823 last glyph added to ROW. */
20824 unproduce_glyphs (it
, i
+ 1);
20825 /* Adjust i for the loop below. */
20826 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20829 /* produce_special_glyphs overwrites the last glyph, so
20830 we don't want that if we want to keep that last
20831 glyph, which means it's an image. */
20832 if (it
->current_x
> it
->last_visible_x
)
20834 it
->current_x
= x_before
;
20835 if (!FRAME_WINDOW_P (it
->f
))
20837 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20839 row
->used
[TEXT_AREA
] = i
;
20840 produce_special_glyphs (it
, IT_TRUNCATION
);
20845 row
->used
[TEXT_AREA
] = i
;
20846 produce_special_glyphs (it
, IT_TRUNCATION
);
20848 it
->hpos
= hpos_before
;
20851 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20853 /* Don't truncate if we can overflow newline into fringe. */
20854 if (!get_next_display_element (it
))
20856 it
->continuation_lines_width
= 0;
20857 row
->ends_at_zv_p
= true;
20858 row
->exact_window_width_line_p
= true;
20861 if (ITERATOR_AT_END_OF_LINE_P (it
))
20863 row
->exact_window_width_line_p
= true;
20864 goto at_end_of_line
;
20866 it
->current_x
= x_before
;
20867 it
->hpos
= hpos_before
;
20870 row
->truncated_on_right_p
= true;
20871 it
->continuation_lines_width
= 0;
20872 reseat_at_next_visible_line_start (it
, false);
20873 /* We insist below that IT's position be at ZV because in
20874 bidi-reordered lines the character at visible line start
20875 might not be the character that follows the newline in
20876 the logical order. */
20877 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20878 row
->ends_at_zv_p
=
20879 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20881 row
->ends_at_zv_p
= false;
20887 bidi_unshelve_cache (wrap_data
, true);
20889 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20890 at the left window margin. */
20891 if (it
->first_visible_x
20892 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20894 if (!FRAME_WINDOW_P (it
->f
)
20895 || (((row
->reversed_p
20896 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20897 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20898 /* Don't let insert_left_trunc_glyphs overwrite the
20899 first glyph of the row if it is an image. */
20900 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20901 insert_left_trunc_glyphs (it
);
20902 row
->truncated_on_left_p
= true;
20905 /* Remember the position at which this line ends.
20907 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20908 cannot be before the call to find_row_edges below, since that is
20909 where these positions are determined. */
20910 row
->end
= it
->current
;
20913 row
->minpos
= row
->start
.pos
;
20914 row
->maxpos
= row
->end
.pos
;
20918 /* ROW->minpos and ROW->maxpos must be the smallest and
20919 `1 + the largest' buffer positions in ROW. But if ROW was
20920 bidi-reordered, these two positions can be anywhere in the
20921 row, so we must determine them now. */
20922 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20925 /* If the start of this line is the overlay arrow-position, then
20926 mark this glyph row as the one containing the overlay arrow.
20927 This is clearly a mess with variable size fonts. It would be
20928 better to let it be displayed like cursors under X. */
20929 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20930 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20931 !NILP (overlay_arrow_string
)))
20933 /* Overlay arrow in window redisplay is a fringe bitmap. */
20934 if (STRINGP (overlay_arrow_string
))
20936 struct glyph_row
*arrow_row
20937 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20938 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20939 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20940 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20941 struct glyph
*p2
, *end
;
20943 /* Copy the arrow glyphs. */
20944 while (glyph
< arrow_end
)
20947 /* Throw away padding glyphs. */
20949 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20950 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20956 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20961 eassert (INTEGERP (overlay_arrow_string
));
20962 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20964 overlay_arrow_seen
= true;
20967 /* Highlight trailing whitespace. */
20968 if (!NILP (Vshow_trailing_whitespace
))
20969 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20971 /* Compute pixel dimensions of this line. */
20972 compute_line_metrics (it
);
20974 /* Implementation note: No changes in the glyphs of ROW or in their
20975 faces can be done past this point, because compute_line_metrics
20976 computes ROW's hash value and stores it within the glyph_row
20979 /* Record whether this row ends inside an ellipsis. */
20980 row
->ends_in_ellipsis_p
20981 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20982 && it
->ellipsis_p
);
20984 /* Save fringe bitmaps in this row. */
20985 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20986 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20987 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20988 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20990 it
->left_user_fringe_bitmap
= 0;
20991 it
->left_user_fringe_face_id
= 0;
20992 it
->right_user_fringe_bitmap
= 0;
20993 it
->right_user_fringe_face_id
= 0;
20995 /* Maybe set the cursor. */
20996 cvpos
= it
->w
->cursor
.vpos
;
20998 /* In bidi-reordered rows, keep checking for proper cursor
20999 position even if one has been found already, because buffer
21000 positions in such rows change non-linearly with ROW->VPOS,
21001 when a line is continued. One exception: when we are at ZV,
21002 display cursor on the first suitable glyph row, since all
21003 the empty rows after that also have their position set to ZV. */
21004 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21005 lines' rows is implemented for bidi-reordered rows. */
21007 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21008 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21009 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21010 && cursor_row_p (row
))
21011 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21013 /* Prepare for the next line. This line starts horizontally at (X
21014 HPOS) = (0 0). Vertical positions are incremented. As a
21015 convenience for the caller, IT->glyph_row is set to the next
21017 it
->current_x
= it
->hpos
= 0;
21018 it
->current_y
+= row
->height
;
21019 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21022 /* The next row should by default use the same value of the
21023 reversed_p flag as this one. set_iterator_to_next decides when
21024 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21025 the flag accordingly. */
21026 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21027 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21028 it
->start
= row
->end
;
21029 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21031 #undef RECORD_MAX_MIN_POS
21034 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21035 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21036 doc
: /* Return paragraph direction at point in BUFFER.
21037 Value is either `left-to-right' or `right-to-left'.
21038 If BUFFER is omitted or nil, it defaults to the current buffer.
21040 Paragraph direction determines how the text in the paragraph is displayed.
21041 In left-to-right paragraphs, text begins at the left margin of the window
21042 and the reading direction is generally left to right. In right-to-left
21043 paragraphs, text begins at the right margin and is read from right to left.
21045 See also `bidi-paragraph-direction'. */)
21046 (Lisp_Object buffer
)
21048 struct buffer
*buf
= current_buffer
;
21049 struct buffer
*old
= buf
;
21051 if (! NILP (buffer
))
21053 CHECK_BUFFER (buffer
);
21054 buf
= XBUFFER (buffer
);
21057 if (NILP (BVAR (buf
, bidi_display_reordering
))
21058 || NILP (BVAR (buf
, enable_multibyte_characters
))
21059 /* When we are loading loadup.el, the character property tables
21060 needed for bidi iteration are not yet available. */
21061 || !NILP (Vpurify_flag
))
21062 return Qleft_to_right
;
21063 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21064 return BVAR (buf
, bidi_paragraph_direction
);
21067 /* Determine the direction from buffer text. We could try to
21068 use current_matrix if it is up to date, but this seems fast
21069 enough as it is. */
21070 struct bidi_it itb
;
21071 ptrdiff_t pos
= BUF_PT (buf
);
21072 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21074 void *itb_data
= bidi_shelve_cache ();
21076 set_buffer_temp (buf
);
21077 /* bidi_paragraph_init finds the base direction of the paragraph
21078 by searching forward from paragraph start. We need the base
21079 direction of the current or _previous_ paragraph, so we need
21080 to make sure we are within that paragraph. To that end, find
21081 the previous non-empty line. */
21082 if (pos
>= ZV
&& pos
> BEGV
)
21083 DEC_BOTH (pos
, bytepos
);
21084 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21085 if (fast_looking_at (trailing_white_space
,
21086 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21088 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21089 || c
== ' ' || c
== '\t' || c
== '\f')
21091 if (bytepos
<= BEGV_BYTE
)
21096 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21099 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21100 itb
.paragraph_dir
= NEUTRAL_DIR
;
21101 itb
.string
.s
= NULL
;
21102 itb
.string
.lstring
= Qnil
;
21103 itb
.string
.bufpos
= 0;
21104 itb
.string
.from_disp_str
= false;
21105 itb
.string
.unibyte
= false;
21106 /* We have no window to use here for ignoring window-specific
21107 overlays. Using NULL for window pointer will cause
21108 compute_display_string_pos to use the current buffer. */
21110 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21111 bidi_unshelve_cache (itb_data
, false);
21112 set_buffer_temp (old
);
21113 switch (itb
.paragraph_dir
)
21116 return Qleft_to_right
;
21119 return Qright_to_left
;
21127 DEFUN ("bidi-find-overridden-directionality",
21128 Fbidi_find_overridden_directionality
,
21129 Sbidi_find_overridden_directionality
, 2, 3, 0,
21130 doc
: /* Return position between FROM and TO where directionality was overridden.
21132 This function returns the first character position in the specified
21133 region of OBJECT where there is a character whose `bidi-class' property
21134 is `L', but which was forced to display as `R' by a directional
21135 override, and likewise with characters whose `bidi-class' is `R'
21136 or `AL' that were forced to display as `L'.
21138 If no such character is found, the function returns nil.
21140 OBJECT is a Lisp string or buffer to search for overridden
21141 directionality, and defaults to the current buffer if nil or omitted.
21142 OBJECT can also be a window, in which case the function will search
21143 the buffer displayed in that window. Passing the window instead of
21144 a buffer is preferable when the buffer is displayed in some window,
21145 because this function will then be able to correctly account for
21146 window-specific overlays, which can affect the results.
21148 Strong directional characters `L', `R', and `AL' can have their
21149 intrinsic directionality overridden by directional override
21150 control characters RLO (u+202e) and LRO (u+202d). See the
21151 function `get-char-code-property' for a way to inquire about
21152 the `bidi-class' property of a character. */)
21153 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21155 struct buffer
*buf
= current_buffer
;
21156 struct buffer
*old
= buf
;
21157 struct window
*w
= NULL
;
21158 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21159 struct bidi_it itb
;
21160 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21163 if (!NILP (object
))
21165 if (BUFFERP (object
))
21166 buf
= XBUFFER (object
);
21167 else if (WINDOWP (object
))
21169 w
= decode_live_window (object
);
21170 buf
= XBUFFER (w
->contents
);
21171 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21174 CHECK_STRING (object
);
21177 if (STRINGP (object
))
21179 /* Characters in unibyte strings are always treated by bidi.c as
21181 if (!STRING_MULTIBYTE (object
)
21182 /* When we are loading loadup.el, the character property
21183 tables needed for bidi iteration are not yet
21185 || !NILP (Vpurify_flag
))
21188 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21189 if (from_pos
>= SCHARS (object
))
21192 /* Set up the bidi iterator. */
21193 itb_data
= bidi_shelve_cache ();
21194 itb
.paragraph_dir
= NEUTRAL_DIR
;
21195 itb
.string
.lstring
= object
;
21196 itb
.string
.s
= NULL
;
21197 itb
.string
.schars
= SCHARS (object
);
21198 itb
.string
.bufpos
= 0;
21199 itb
.string
.from_disp_str
= false;
21200 itb
.string
.unibyte
= false;
21202 bidi_init_it (0, 0, frame_window_p
, &itb
);
21206 /* Nothing this fancy can happen in unibyte buffers, or in a
21207 buffer that disabled reordering, or if FROM is at EOB. */
21208 if (NILP (BVAR (buf
, bidi_display_reordering
))
21209 || NILP (BVAR (buf
, enable_multibyte_characters
))
21210 /* When we are loading loadup.el, the character property
21211 tables needed for bidi iteration are not yet
21213 || !NILP (Vpurify_flag
))
21216 set_buffer_temp (buf
);
21217 validate_region (&from
, &to
);
21218 from_pos
= XINT (from
);
21219 to_pos
= XINT (to
);
21220 if (from_pos
>= ZV
)
21223 /* Set up the bidi iterator. */
21224 itb_data
= bidi_shelve_cache ();
21225 from_bpos
= CHAR_TO_BYTE (from_pos
);
21226 if (from_pos
== BEGV
)
21228 itb
.charpos
= BEGV
;
21229 itb
.bytepos
= BEGV_BYTE
;
21231 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21233 itb
.charpos
= from_pos
;
21234 itb
.bytepos
= from_bpos
;
21237 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21239 itb
.paragraph_dir
= NEUTRAL_DIR
;
21240 itb
.string
.s
= NULL
;
21241 itb
.string
.lstring
= Qnil
;
21242 itb
.string
.bufpos
= 0;
21243 itb
.string
.from_disp_str
= false;
21244 itb
.string
.unibyte
= false;
21246 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21251 /* For the purposes of this function, the actual base direction of
21252 the paragraph doesn't matter, so just set it to L2R. */
21253 bidi_paragraph_init (L2R
, &itb
, false);
21254 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21256 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21258 bidi_unshelve_cache (itb_data
, false);
21259 set_buffer_temp (old
);
21261 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21264 DEFUN ("move-point-visually", Fmove_point_visually
,
21265 Smove_point_visually
, 1, 1, 0,
21266 doc
: /* Move point in the visual order in the specified DIRECTION.
21267 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21270 Value is the new character position of point. */)
21271 (Lisp_Object direction
)
21273 struct window
*w
= XWINDOW (selected_window
);
21274 struct buffer
*b
= XBUFFER (w
->contents
);
21275 struct glyph_row
*row
;
21277 Lisp_Object paragraph_dir
;
21279 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21280 (!(ROW)->continued_p \
21281 && NILP ((GLYPH)->object) \
21282 && (GLYPH)->type == CHAR_GLYPH \
21283 && (GLYPH)->u.ch == ' ' \
21284 && (GLYPH)->charpos >= 0 \
21285 && !(GLYPH)->avoid_cursor_p)
21287 CHECK_NUMBER (direction
);
21288 dir
= XINT (direction
);
21294 /* If current matrix is up-to-date, we can use the information
21295 recorded in the glyphs, at least as long as the goal is on the
21297 if (w
->window_end_valid
21298 && !windows_or_buffers_changed
21300 && !b
->clip_changed
21301 && !b
->prevent_redisplay_optimizations_p
21302 && !window_outdated (w
)
21303 /* We rely below on the cursor coordinates to be up to date, but
21304 we cannot trust them if some command moved point since the
21305 last complete redisplay. */
21306 && w
->last_point
== BUF_PT (b
)
21307 && w
->cursor
.vpos
>= 0
21308 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21309 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21311 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21312 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21313 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21315 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21317 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21319 SET_PT (g
->charpos
);
21320 w
->cursor
.vpos
= -1;
21321 return make_number (PT
);
21323 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21327 if (BUFFERP (gpt
->object
))
21330 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21331 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21333 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21335 else if (BUFFERP (g
->object
))
21336 new_pos
= g
->charpos
;
21340 w
->cursor
.vpos
= -1;
21341 return make_number (PT
);
21343 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21345 /* Glyphs inserted at the end of a non-empty line for
21346 positioning the cursor have zero charpos, so we must
21347 deduce the value of point by other means. */
21348 if (g
->charpos
> 0)
21349 SET_PT (g
->charpos
);
21350 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21352 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21353 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21356 w
->cursor
.vpos
= -1;
21357 return make_number (PT
);
21360 if (g
== e
|| NILP (g
->object
))
21362 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21363 goto simulate_display
;
21364 if (!row
->reversed_p
)
21368 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21369 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21370 goto simulate_display
;
21374 if (row
->reversed_p
&& !row
->continued_p
)
21376 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21377 w
->cursor
.vpos
= -1;
21378 return make_number (PT
);
21380 g
= row
->glyphs
[TEXT_AREA
];
21381 e
= g
+ row
->used
[TEXT_AREA
];
21382 for ( ; g
< e
; g
++)
21384 if (BUFFERP (g
->object
)
21385 /* Empty lines have only one glyph, which stands
21386 for the newline, and whose charpos is the
21387 buffer position of the newline. */
21388 || ROW_GLYPH_NEWLINE_P (row
, g
)
21389 /* When the buffer ends in a newline, the line at
21390 EOB also has one glyph, but its charpos is -1. */
21391 || (row
->ends_at_zv_p
21392 && !row
->reversed_p
21393 && NILP (g
->object
)
21394 && g
->type
== CHAR_GLYPH
21395 && g
->u
.ch
== ' '))
21397 if (g
->charpos
> 0)
21398 SET_PT (g
->charpos
);
21399 else if (!row
->reversed_p
21400 && row
->ends_at_zv_p
21405 w
->cursor
.vpos
= -1;
21406 return make_number (PT
);
21412 if (!row
->reversed_p
&& !row
->continued_p
)
21414 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21415 w
->cursor
.vpos
= -1;
21416 return make_number (PT
);
21418 e
= row
->glyphs
[TEXT_AREA
];
21419 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21420 for ( ; g
>= e
; g
--)
21422 if (BUFFERP (g
->object
)
21423 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21425 /* Empty R2L lines on GUI frames have the buffer
21426 position of the newline stored in the stretch
21428 || g
->type
== STRETCH_GLYPH
21429 || (row
->ends_at_zv_p
21431 && NILP (g
->object
)
21432 && g
->type
== CHAR_GLYPH
21433 && g
->u
.ch
== ' '))
21435 if (g
->charpos
> 0)
21436 SET_PT (g
->charpos
);
21437 else if (row
->reversed_p
21438 && row
->ends_at_zv_p
21443 w
->cursor
.vpos
= -1;
21444 return make_number (PT
);
21453 /* If we wind up here, we failed to move by using the glyphs, so we
21454 need to simulate display instead. */
21457 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21459 paragraph_dir
= Qleft_to_right
;
21460 if (EQ (paragraph_dir
, Qright_to_left
))
21462 if (PT
<= BEGV
&& dir
< 0)
21463 xsignal0 (Qbeginning_of_buffer
);
21464 else if (PT
>= ZV
&& dir
> 0)
21465 xsignal0 (Qend_of_buffer
);
21468 struct text_pos pt
;
21470 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21472 bool overshoot_expected
= false;
21473 bool target_is_eol_p
= false;
21475 /* Setup the arena. */
21476 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21477 start_display (&it
, w
, pt
);
21478 /* When lines are truncated, we could be called with point
21479 outside of the windows edges, in which case move_it_*
21480 functions either prematurely stop at window's edge or jump to
21481 the next screen line, whereas we rely below on our ability to
21482 reach point, in order to start from its X coordinate. So we
21483 need to disregard the window's horizontal extent in that case. */
21484 if (it
.line_wrap
== TRUNCATE
)
21485 it
.last_visible_x
= INFINITY
;
21487 if (it
.cmp_it
.id
< 0
21488 && it
.method
== GET_FROM_STRING
21489 && it
.area
== TEXT_AREA
21490 && it
.string_from_display_prop_p
21491 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21492 overshoot_expected
= true;
21494 /* Find the X coordinate of point. We start from the beginning
21495 of this or previous line to make sure we are before point in
21496 the logical order (since the move_it_* functions can only
21499 reseat_at_previous_visible_line_start (&it
);
21500 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21501 if (IT_CHARPOS (it
) != PT
)
21503 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21504 -1, -1, -1, MOVE_TO_POS
);
21505 /* If we missed point because the character there is
21506 displayed out of a display vector that has more than one
21507 glyph, retry expecting overshoot. */
21508 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21509 && it
.current
.dpvec_index
> 0
21510 && !overshoot_expected
)
21512 overshoot_expected
= true;
21515 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21516 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21518 pt_x
= it
.current_x
;
21520 if (dir
> 0 || overshoot_expected
)
21522 struct glyph_row
*row
= it
.glyph_row
;
21524 /* When point is at beginning of line, we don't have
21525 information about the glyph there loaded into struct
21526 it. Calling get_next_display_element fixes that. */
21528 get_next_display_element (&it
);
21529 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21530 it
.glyph_row
= NULL
;
21531 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21532 it
.glyph_row
= row
;
21533 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21534 it, lest it will become out of sync with it's buffer
21536 it
.current_x
= pt_x
;
21539 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21540 pixel_width
= it
.pixel_width
;
21541 if (overshoot_expected
&& at_eol_p
)
21543 else if (pixel_width
<= 0)
21546 /* If there's a display string (or something similar) at point,
21547 we are actually at the glyph to the left of point, so we need
21548 to correct the X coordinate. */
21549 if (overshoot_expected
)
21552 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21554 pt_x
+= pixel_width
;
21557 /* Compute target X coordinate, either to the left or to the
21558 right of point. On TTY frames, all characters have the same
21559 pixel width of 1, so we can use that. On GUI frames we don't
21560 have an easy way of getting at the pixel width of the
21561 character to the left of point, so we use a different method
21562 of getting to that place. */
21564 target_x
= pt_x
+ pixel_width
;
21566 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21568 /* Target X coordinate could be one line above or below the line
21569 of point, in which case we need to adjust the target X
21570 coordinate. Also, if moving to the left, we need to begin at
21571 the left edge of the point's screen line. */
21576 start_display (&it
, w
, pt
);
21577 if (it
.line_wrap
== TRUNCATE
)
21578 it
.last_visible_x
= INFINITY
;
21579 reseat_at_previous_visible_line_start (&it
);
21580 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21582 move_it_by_lines (&it
, pt_vpos
);
21586 move_it_by_lines (&it
, -1);
21587 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21588 target_is_eol_p
= true;
21589 /* Under word-wrap, we don't know the x coordinate of
21590 the last character displayed on the previous line,
21591 which immediately precedes the wrap point. To find
21592 out its x coordinate, we try moving to the right
21593 margin of the window, which will stop at the wrap
21594 point, and then reset target_x to point at the
21595 character that precedes the wrap point. This is not
21596 needed on GUI frames, because (see below) there we
21597 move from the left margin one grapheme cluster at a
21598 time, and stop when we hit the wrap point. */
21599 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21601 void *it_data
= NULL
;
21604 SAVE_IT (it2
, it
, it_data
);
21605 move_it_in_display_line_to (&it
, ZV
, target_x
,
21606 MOVE_TO_POS
| MOVE_TO_X
);
21607 /* If we arrived at target_x, that _is_ the last
21608 character on the previous line. */
21609 if (it
.current_x
!= target_x
)
21610 target_x
= it
.current_x
- 1;
21611 RESTORE_IT (&it
, &it2
, it_data
);
21618 || (target_x
>= it
.last_visible_x
21619 && it
.line_wrap
!= TRUNCATE
))
21622 move_it_by_lines (&it
, 0);
21623 move_it_by_lines (&it
, 1);
21628 /* Move to the target X coordinate. */
21629 #ifdef HAVE_WINDOW_SYSTEM
21630 /* On GUI frames, as we don't know the X coordinate of the
21631 character to the left of point, moving point to the left
21632 requires walking, one grapheme cluster at a time, until we
21633 find ourself at a place immediately to the left of the
21634 character at point. */
21635 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21637 struct text_pos new_pos
;
21638 enum move_it_result rc
= MOVE_X_REACHED
;
21640 if (it
.current_x
== 0)
21641 get_next_display_element (&it
);
21642 if (it
.what
== IT_COMPOSITION
)
21644 new_pos
.charpos
= it
.cmp_it
.charpos
;
21645 new_pos
.bytepos
= -1;
21648 new_pos
= it
.current
.pos
;
21650 while (it
.current_x
+ it
.pixel_width
<= target_x
21651 && (rc
== MOVE_X_REACHED
21652 /* Under word-wrap, move_it_in_display_line_to
21653 stops at correct coordinates, but sometimes
21654 returns MOVE_POS_MATCH_OR_ZV. */
21655 || (it
.line_wrap
== WORD_WRAP
21656 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21658 int new_x
= it
.current_x
+ it
.pixel_width
;
21660 /* For composed characters, we want the position of the
21661 first character in the grapheme cluster (usually, the
21662 composition's base character), whereas it.current
21663 might give us the position of the _last_ one, e.g. if
21664 the composition is rendered in reverse due to bidi
21666 if (it
.what
== IT_COMPOSITION
)
21668 new_pos
.charpos
= it
.cmp_it
.charpos
;
21669 new_pos
.bytepos
= -1;
21672 new_pos
= it
.current
.pos
;
21673 if (new_x
== it
.current_x
)
21675 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21676 MOVE_TO_POS
| MOVE_TO_X
);
21677 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21680 /* The previous position we saw in the loop is the one we
21682 if (new_pos
.bytepos
== -1)
21683 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21684 it
.current
.pos
= new_pos
;
21688 if (it
.current_x
!= target_x
)
21689 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21691 /* If we ended up in a display string that covers point, move to
21692 buffer position to the right in the visual order. */
21695 while (IT_CHARPOS (it
) == PT
)
21697 set_iterator_to_next (&it
, false);
21698 if (!get_next_display_element (&it
))
21703 /* Move point to that position. */
21704 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21707 return make_number (PT
);
21709 #undef ROW_GLYPH_NEWLINE_P
21712 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21713 Sbidi_resolved_levels
, 0, 1, 0,
21714 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21716 The resolved levels are produced by the Emacs bidi reordering engine
21717 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21718 read the Unicode Standard Annex 9 (UAX#9) for background information
21719 about these levels.
21721 VPOS is the zero-based number of the current window's screen line
21722 for which to produce the resolved levels. If VPOS is nil or omitted,
21723 it defaults to the screen line of point. If the window displays a
21724 header line, VPOS of zero will report on the header line, and first
21725 line of text in the window will have VPOS of 1.
21727 Value is an array of resolved levels, indexed by glyph number.
21728 Glyphs are numbered from zero starting from the beginning of the
21729 screen line, i.e. the left edge of the window for left-to-right lines
21730 and from the right edge for right-to-left lines. The resolved levels
21731 are produced only for the window's text area; text in display margins
21734 If the selected window's display is not up-to-date, or if the specified
21735 screen line does not display text, this function returns nil. It is
21736 highly recommended to bind this function to some simple key, like F8,
21737 in order to avoid these problems.
21739 This function exists mainly for testing the correctness of the
21740 Emacs UBA implementation, in particular with the test suite. */)
21743 struct window
*w
= XWINDOW (selected_window
);
21744 struct buffer
*b
= XBUFFER (w
->contents
);
21746 struct glyph_row
*row
;
21750 int d1
, d2
, d3
, d4
, d5
;
21752 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21756 CHECK_NUMBER_COERCE_MARKER (vpos
);
21757 nrow
= XINT (vpos
);
21760 /* We require up-to-date glyph matrix for this window. */
21761 if (w
->window_end_valid
21762 && !windows_or_buffers_changed
21764 && !b
->clip_changed
21765 && !b
->prevent_redisplay_optimizations_p
21766 && !window_outdated (w
)
21768 && nrow
< w
->current_matrix
->nrows
21769 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21770 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21772 struct glyph
*g
, *e
, *g1
;
21774 Lisp_Object levels
;
21776 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21778 g
= g1
= row
->glyphs
[TEXT_AREA
];
21779 e
= g
+ row
->used
[TEXT_AREA
];
21781 /* Skip over glyphs at the start of the row that was
21782 generated by redisplay for its own needs. */
21784 && NILP (g
->object
)
21789 /* Count the "interesting" glyphs in this row. */
21790 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21793 /* Create and fill the array. */
21794 levels
= make_uninit_vector (nglyphs
);
21795 for (i
= 0; g1
< g
; i
++, g1
++)
21796 ASET (levels
, i
, make_number (g1
->resolved_level
));
21798 else /* Right-to-left glyph row. */
21800 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21801 e
= row
->glyphs
[TEXT_AREA
] - 1;
21803 && NILP (g
->object
)
21807 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21809 levels
= make_uninit_vector (nglyphs
);
21810 for (i
= 0; g1
> g
; i
++, g1
--)
21811 ASET (levels
, i
, make_number (g1
->resolved_level
));
21821 /***********************************************************************
21823 ***********************************************************************/
21825 /* Redisplay the menu bar in the frame for window W.
21827 The menu bar of X frames that don't have X toolkit support is
21828 displayed in a special window W->frame->menu_bar_window.
21830 The menu bar of terminal frames is treated specially as far as
21831 glyph matrices are concerned. Menu bar lines are not part of
21832 windows, so the update is done directly on the frame matrix rows
21833 for the menu bar. */
21836 display_menu_bar (struct window
*w
)
21838 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21843 /* Don't do all this for graphical frames. */
21845 if (FRAME_W32_P (f
))
21848 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21854 if (FRAME_NS_P (f
))
21856 #endif /* HAVE_NS */
21858 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21859 eassert (!FRAME_WINDOW_P (f
));
21860 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21861 it
.first_visible_x
= 0;
21862 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21863 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21864 if (FRAME_WINDOW_P (f
))
21866 /* Menu bar lines are displayed in the desired matrix of the
21867 dummy window menu_bar_window. */
21868 struct window
*menu_w
;
21869 menu_w
= XWINDOW (f
->menu_bar_window
);
21870 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21872 it
.first_visible_x
= 0;
21873 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21876 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21878 /* This is a TTY frame, i.e. character hpos/vpos are used as
21880 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21882 it
.first_visible_x
= 0;
21883 it
.last_visible_x
= FRAME_COLS (f
);
21886 /* FIXME: This should be controlled by a user option. See the
21887 comments in redisplay_tool_bar and display_mode_line about
21889 it
.paragraph_embedding
= L2R
;
21891 /* Clear all rows of the menu bar. */
21892 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21894 struct glyph_row
*row
= it
.glyph_row
+ i
;
21895 clear_glyph_row (row
);
21896 row
->enabled_p
= true;
21897 row
->full_width_p
= true;
21898 row
->reversed_p
= false;
21901 /* Display all items of the menu bar. */
21902 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21903 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21905 Lisp_Object string
;
21907 /* Stop at nil string. */
21908 string
= AREF (items
, i
+ 1);
21912 /* Remember where item was displayed. */
21913 ASET (items
, i
+ 3, make_number (it
.hpos
));
21915 /* Display the item, pad with one space. */
21916 if (it
.current_x
< it
.last_visible_x
)
21917 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21918 SCHARS (string
) + 1, 0, 0, -1);
21921 /* Fill out the line with spaces. */
21922 if (it
.current_x
< it
.last_visible_x
)
21923 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21925 /* Compute the total height of the lines. */
21926 compute_line_metrics (&it
);
21929 /* Deep copy of a glyph row, including the glyphs. */
21931 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21933 struct glyph
*pointers
[1 + LAST_AREA
];
21934 int to_used
= to
->used
[TEXT_AREA
];
21936 /* Save glyph pointers of TO. */
21937 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21939 /* Do a structure assignment. */
21942 /* Restore original glyph pointers of TO. */
21943 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21945 /* Copy the glyphs. */
21946 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21947 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21949 /* If we filled only part of the TO row, fill the rest with
21950 space_glyph (which will display as empty space). */
21951 if (to_used
> from
->used
[TEXT_AREA
])
21952 fill_up_frame_row_with_spaces (to
, to_used
);
21955 /* Display one menu item on a TTY, by overwriting the glyphs in the
21956 frame F's desired glyph matrix with glyphs produced from the menu
21957 item text. Called from term.c to display TTY drop-down menus one
21960 ITEM_TEXT is the menu item text as a C string.
21962 FACE_ID is the face ID to be used for this menu item. FACE_ID
21963 could specify one of 3 faces: a face for an enabled item, a face
21964 for a disabled item, or a face for a selected item.
21966 X and Y are coordinates of the first glyph in the frame's desired
21967 matrix to be overwritten by the menu item. Since this is a TTY, Y
21968 is the zero-based number of the glyph row and X is the zero-based
21969 glyph number in the row, starting from left, where to start
21970 displaying the item.
21972 SUBMENU means this menu item drops down a submenu, which
21973 should be indicated by displaying a proper visual cue after the
21977 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21978 int x
, int y
, bool submenu
)
21981 struct frame
*f
= SELECTED_FRAME ();
21982 struct window
*w
= XWINDOW (f
->selected_window
);
21983 struct glyph_row
*row
;
21984 size_t item_len
= strlen (item_text
);
21986 eassert (FRAME_TERMCAP_P (f
));
21988 /* Don't write beyond the matrix's last row. This can happen for
21989 TTY screens that are not high enough to show the entire menu.
21990 (This is actually a bit of defensive programming, as
21991 tty_menu_display already limits the number of menu items to one
21992 less than the number of screen lines.) */
21993 if (y
>= f
->desired_matrix
->nrows
)
21996 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21997 it
.first_visible_x
= 0;
21998 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21999 row
= it
.glyph_row
;
22000 /* Start with the row contents from the current matrix. */
22001 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22002 bool saved_width
= row
->full_width_p
;
22003 row
->full_width_p
= true;
22004 bool saved_reversed
= row
->reversed_p
;
22005 row
->reversed_p
= false;
22006 row
->enabled_p
= true;
22008 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22010 eassert (x
< f
->desired_matrix
->matrix_w
);
22011 it
.current_x
= it
.hpos
= x
;
22012 it
.current_y
= it
.vpos
= y
;
22013 int saved_used
= row
->used
[TEXT_AREA
];
22014 bool saved_truncated
= row
->truncated_on_right_p
;
22015 row
->used
[TEXT_AREA
] = x
;
22016 it
.face_id
= face_id
;
22017 it
.line_wrap
= TRUNCATE
;
22019 /* FIXME: This should be controlled by a user option. See the
22020 comments in redisplay_tool_bar and display_mode_line about this.
22021 Also, if paragraph_embedding could ever be R2L, changes will be
22022 needed to avoid shifting to the right the row characters in
22023 term.c:append_glyph. */
22024 it
.paragraph_embedding
= L2R
;
22026 /* Pad with a space on the left. */
22027 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22029 /* Display the menu item, pad with spaces to WIDTH. */
22032 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22033 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22035 /* Indicate with " >" that there's a submenu. */
22036 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22037 FRAME_COLS (f
) - 1, -1);
22040 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22041 width
, 0, FRAME_COLS (f
) - 1, -1);
22043 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22044 row
->truncated_on_right_p
= saved_truncated
;
22045 row
->hash
= row_hash (row
);
22046 row
->full_width_p
= saved_width
;
22047 row
->reversed_p
= saved_reversed
;
22050 /***********************************************************************
22052 ***********************************************************************/
22054 /* Redisplay mode lines in the window tree whose root is WINDOW.
22055 If FORCE, redisplay mode lines unconditionally.
22056 Otherwise, redisplay only mode lines that are garbaged. Value is
22057 the number of windows whose mode lines were redisplayed. */
22060 redisplay_mode_lines (Lisp_Object window
, bool force
)
22064 while (!NILP (window
))
22066 struct window
*w
= XWINDOW (window
);
22068 if (WINDOWP (w
->contents
))
22069 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22071 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22072 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22074 struct text_pos lpoint
;
22075 struct buffer
*old
= current_buffer
;
22077 /* Set the window's buffer for the mode line display. */
22078 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22079 set_buffer_internal_1 (XBUFFER (w
->contents
));
22081 /* Point refers normally to the selected window. For any
22082 other window, set up appropriate value. */
22083 if (!EQ (window
, selected_window
))
22085 struct text_pos pt
;
22087 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22088 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22091 /* Display mode lines. */
22092 clear_glyph_matrix (w
->desired_matrix
);
22093 if (display_mode_lines (w
))
22096 /* Restore old settings. */
22097 set_buffer_internal_1 (old
);
22098 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22108 /* Display the mode and/or header line of window W. Value is the
22109 sum number of mode lines and header lines displayed. */
22112 display_mode_lines (struct window
*w
)
22114 Lisp_Object old_selected_window
= selected_window
;
22115 Lisp_Object old_selected_frame
= selected_frame
;
22116 Lisp_Object new_frame
= w
->frame
;
22117 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22120 selected_frame
= new_frame
;
22121 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22122 or window's point, then we'd need select_window_1 here as well. */
22123 XSETWINDOW (selected_window
, w
);
22124 XFRAME (new_frame
)->selected_window
= selected_window
;
22126 /* These will be set while the mode line specs are processed. */
22127 line_number_displayed
= false;
22128 w
->column_number_displayed
= -1;
22130 if (WINDOW_WANTS_MODELINE_P (w
))
22132 struct window
*sel_w
= XWINDOW (old_selected_window
);
22134 /* Select mode line face based on the real selected window. */
22135 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22136 BVAR (current_buffer
, mode_line_format
));
22140 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22142 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22143 BVAR (current_buffer
, header_line_format
));
22147 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22148 selected_frame
= old_selected_frame
;
22149 selected_window
= old_selected_window
;
22151 w
->must_be_updated_p
= true;
22156 /* Display mode or header line of window W. FACE_ID specifies which
22157 line to display; it is either MODE_LINE_FACE_ID or
22158 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22159 display. Value is the pixel height of the mode/header line
22163 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22167 ptrdiff_t count
= SPECPDL_INDEX ();
22169 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22170 /* Don't extend on a previously drawn mode-line.
22171 This may happen if called from pos_visible_p. */
22172 it
.glyph_row
->enabled_p
= false;
22173 prepare_desired_row (w
, it
.glyph_row
, true);
22175 it
.glyph_row
->mode_line_p
= true;
22177 /* FIXME: This should be controlled by a user option. But
22178 supporting such an option is not trivial, since the mode line is
22179 made up of many separate strings. */
22180 it
.paragraph_embedding
= L2R
;
22182 record_unwind_protect (unwind_format_mode_line
,
22183 format_mode_line_unwind_data (NULL
, NULL
,
22186 mode_line_target
= MODE_LINE_DISPLAY
;
22188 /* Temporarily make frame's keyboard the current kboard so that
22189 kboard-local variables in the mode_line_format will get the right
22191 push_kboard (FRAME_KBOARD (it
.f
));
22192 record_unwind_save_match_data ();
22193 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22196 unbind_to (count
, Qnil
);
22198 /* Fill up with spaces. */
22199 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22201 compute_line_metrics (&it
);
22202 it
.glyph_row
->full_width_p
= true;
22203 it
.glyph_row
->continued_p
= false;
22204 it
.glyph_row
->truncated_on_left_p
= false;
22205 it
.glyph_row
->truncated_on_right_p
= false;
22207 /* Make a 3D mode-line have a shadow at its right end. */
22208 face
= FACE_FROM_ID (it
.f
, face_id
);
22209 extend_face_to_end_of_line (&it
);
22210 if (face
->box
!= FACE_NO_BOX
)
22212 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22213 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22214 last
->right_box_line_p
= true;
22217 return it
.glyph_row
->height
;
22220 /* Move element ELT in LIST to the front of LIST.
22221 Return the updated list. */
22224 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22226 register Lisp_Object tail
, prev
;
22227 register Lisp_Object tem
;
22231 while (CONSP (tail
))
22237 /* Splice out the link TAIL. */
22239 list
= XCDR (tail
);
22241 Fsetcdr (prev
, XCDR (tail
));
22243 /* Now make it the first. */
22244 Fsetcdr (tail
, list
);
22249 tail
= XCDR (tail
);
22253 /* Not found--return unchanged LIST. */
22257 /* Contribute ELT to the mode line for window IT->w. How it
22258 translates into text depends on its data type.
22260 IT describes the display environment in which we display, as usual.
22262 DEPTH is the depth in recursion. It is used to prevent
22263 infinite recursion here.
22265 FIELD_WIDTH is the number of characters the display of ELT should
22266 occupy in the mode line, and PRECISION is the maximum number of
22267 characters to display from ELT's representation. See
22268 display_string for details.
22270 Returns the hpos of the end of the text generated by ELT.
22272 PROPS is a property list to add to any string we encounter.
22274 If RISKY, remove (disregard) any properties in any string
22275 we encounter, and ignore :eval and :propertize.
22277 The global variable `mode_line_target' determines whether the
22278 output is passed to `store_mode_line_noprop',
22279 `store_mode_line_string', or `display_string'. */
22282 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22283 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22285 int n
= 0, field
, prec
;
22286 bool literal
= false;
22290 elt
= build_string ("*too-deep*");
22294 switch (XTYPE (elt
))
22298 /* A string: output it and check for %-constructs within it. */
22300 ptrdiff_t offset
= 0;
22302 if (SCHARS (elt
) > 0
22303 && (!NILP (props
) || risky
))
22305 Lisp_Object oprops
, aelt
;
22306 oprops
= Ftext_properties_at (make_number (0), elt
);
22308 /* If the starting string's properties are not what
22309 we want, translate the string. Also, if the string
22310 is risky, do that anyway. */
22312 if (NILP (Fequal (props
, oprops
)) || risky
)
22314 /* If the starting string has properties,
22315 merge the specified ones onto the existing ones. */
22316 if (! NILP (oprops
) && !risky
)
22320 oprops
= Fcopy_sequence (oprops
);
22322 while (CONSP (tem
))
22324 oprops
= Fplist_put (oprops
, XCAR (tem
),
22325 XCAR (XCDR (tem
)));
22326 tem
= XCDR (XCDR (tem
));
22331 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22332 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22334 /* AELT is what we want. Move it to the front
22335 without consing. */
22337 mode_line_proptrans_alist
22338 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22344 /* If AELT has the wrong props, it is useless.
22345 so get rid of it. */
22347 mode_line_proptrans_alist
22348 = Fdelq (aelt
, mode_line_proptrans_alist
);
22350 elt
= Fcopy_sequence (elt
);
22351 Fset_text_properties (make_number (0), Flength (elt
),
22353 /* Add this item to mode_line_proptrans_alist. */
22354 mode_line_proptrans_alist
22355 = Fcons (Fcons (elt
, props
),
22356 mode_line_proptrans_alist
);
22357 /* Truncate mode_line_proptrans_alist
22358 to at most 50 elements. */
22359 tem
= Fnthcdr (make_number (50),
22360 mode_line_proptrans_alist
);
22362 XSETCDR (tem
, Qnil
);
22371 prec
= precision
- n
;
22372 switch (mode_line_target
)
22374 case MODE_LINE_NOPROP
:
22375 case MODE_LINE_TITLE
:
22376 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22378 case MODE_LINE_STRING
:
22379 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22381 case MODE_LINE_DISPLAY
:
22382 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22383 0, prec
, 0, STRING_MULTIBYTE (elt
));
22390 /* Handle the non-literal case. */
22392 while ((precision
<= 0 || n
< precision
)
22393 && SREF (elt
, offset
) != 0
22394 && (mode_line_target
!= MODE_LINE_DISPLAY
22395 || it
->current_x
< it
->last_visible_x
))
22397 ptrdiff_t last_offset
= offset
;
22399 /* Advance to end of string or next format specifier. */
22400 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22403 if (offset
- 1 != last_offset
)
22405 ptrdiff_t nchars
, nbytes
;
22407 /* Output to end of string or up to '%'. Field width
22408 is length of string. Don't output more than
22409 PRECISION allows us. */
22412 prec
= c_string_width (SDATA (elt
) + last_offset
,
22413 offset
- last_offset
, precision
- n
,
22416 switch (mode_line_target
)
22418 case MODE_LINE_NOPROP
:
22419 case MODE_LINE_TITLE
:
22420 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22422 case MODE_LINE_STRING
:
22424 ptrdiff_t bytepos
= last_offset
;
22425 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22426 ptrdiff_t endpos
= (precision
<= 0
22427 ? string_byte_to_char (elt
, offset
)
22428 : charpos
+ nchars
);
22429 Lisp_Object mode_string
22430 = Fsubstring (elt
, make_number (charpos
),
22431 make_number (endpos
));
22432 n
+= store_mode_line_string (NULL
, mode_string
, false,
22436 case MODE_LINE_DISPLAY
:
22438 ptrdiff_t bytepos
= last_offset
;
22439 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22441 if (precision
<= 0)
22442 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22443 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22445 STRING_MULTIBYTE (elt
));
22450 else /* c == '%' */
22452 ptrdiff_t percent_position
= offset
;
22454 /* Get the specified minimum width. Zero means
22457 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22458 field
= field
* 10 + c
- '0';
22460 /* Don't pad beyond the total padding allowed. */
22461 if (field_width
- n
> 0 && field
> field_width
- n
)
22462 field
= field_width
- n
;
22464 /* Note that either PRECISION <= 0 or N < PRECISION. */
22465 prec
= precision
- n
;
22468 n
+= display_mode_element (it
, depth
, field
, prec
,
22469 Vglobal_mode_string
, props
,
22474 ptrdiff_t bytepos
, charpos
;
22476 Lisp_Object string
;
22478 bytepos
= percent_position
;
22479 charpos
= (STRING_MULTIBYTE (elt
)
22480 ? string_byte_to_char (elt
, bytepos
)
22482 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22483 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22485 switch (mode_line_target
)
22487 case MODE_LINE_NOPROP
:
22488 case MODE_LINE_TITLE
:
22489 n
+= store_mode_line_noprop (spec
, field
, prec
);
22491 case MODE_LINE_STRING
:
22493 Lisp_Object tem
= build_string (spec
);
22494 props
= Ftext_properties_at (make_number (charpos
), elt
);
22495 /* Should only keep face property in props */
22496 n
+= store_mode_line_string (NULL
, tem
, false,
22497 field
, prec
, props
);
22500 case MODE_LINE_DISPLAY
:
22502 int nglyphs_before
, nwritten
;
22504 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22505 nwritten
= display_string (spec
, string
, elt
,
22510 /* Assign to the glyphs written above the
22511 string where the `%x' came from, position
22515 struct glyph
*glyph
22516 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22520 for (i
= 0; i
< nwritten
; ++i
)
22522 glyph
[i
].object
= elt
;
22523 glyph
[i
].charpos
= charpos
;
22540 /* A symbol: process the value of the symbol recursively
22541 as if it appeared here directly. Avoid error if symbol void.
22542 Special case: if value of symbol is a string, output the string
22545 register Lisp_Object tem
;
22547 /* If the variable is not marked as risky to set
22548 then its contents are risky to use. */
22549 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22552 tem
= Fboundp (elt
);
22555 tem
= Fsymbol_value (elt
);
22556 /* If value is a string, output that string literally:
22557 don't check for % within it. */
22561 if (!EQ (tem
, elt
))
22563 /* Give up right away for nil or t. */
22573 register Lisp_Object car
, tem
;
22575 /* A cons cell: five distinct cases.
22576 If first element is :eval or :propertize, do something special.
22577 If first element is a string or a cons, process all the elements
22578 and effectively concatenate them.
22579 If first element is a negative number, truncate displaying cdr to
22580 at most that many characters. If positive, pad (with spaces)
22581 to at least that many characters.
22582 If first element is a symbol, process the cadr or caddr recursively
22583 according to whether the symbol's value is non-nil or nil. */
22585 if (EQ (car
, QCeval
))
22587 /* An element of the form (:eval FORM) means evaluate FORM
22588 and use the result as mode line elements. */
22593 if (CONSP (XCDR (elt
)))
22596 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22597 n
+= display_mode_element (it
, depth
, field_width
- n
,
22598 precision
- n
, spec
, props
,
22602 else if (EQ (car
, QCpropertize
))
22604 /* An element of the form (:propertize ELT PROPS...)
22605 means display ELT but applying properties PROPS. */
22610 if (CONSP (XCDR (elt
)))
22611 n
+= display_mode_element (it
, depth
, field_width
- n
,
22612 precision
- n
, XCAR (XCDR (elt
)),
22613 XCDR (XCDR (elt
)), risky
);
22615 else if (SYMBOLP (car
))
22617 tem
= Fboundp (car
);
22621 /* elt is now the cdr, and we know it is a cons cell.
22622 Use its car if CAR has a non-nil value. */
22625 tem
= Fsymbol_value (car
);
22632 /* Symbol's value is nil (or symbol is unbound)
22633 Get the cddr of the original list
22634 and if possible find the caddr and use that. */
22638 else if (!CONSP (elt
))
22643 else if (INTEGERP (car
))
22645 register int lim
= XINT (car
);
22649 /* Negative int means reduce maximum width. */
22650 if (precision
<= 0)
22653 precision
= min (precision
, -lim
);
22657 /* Padding specified. Don't let it be more than
22658 current maximum. */
22660 lim
= min (precision
, lim
);
22662 /* If that's more padding than already wanted, queue it.
22663 But don't reduce padding already specified even if
22664 that is beyond the current truncation point. */
22665 field_width
= max (lim
, field_width
);
22669 else if (STRINGP (car
) || CONSP (car
))
22671 Lisp_Object halftail
= elt
;
22675 && (precision
<= 0 || n
< precision
))
22677 n
+= display_mode_element (it
, depth
,
22678 /* Do padding only after the last
22679 element in the list. */
22680 (! CONSP (XCDR (elt
))
22683 precision
- n
, XCAR (elt
),
22687 if ((len
& 1) == 0)
22688 halftail
= XCDR (halftail
);
22689 /* Check for cycle. */
22690 if (EQ (halftail
, elt
))
22699 elt
= build_string ("*invalid*");
22703 /* Pad to FIELD_WIDTH. */
22704 if (field_width
> 0 && n
< field_width
)
22706 switch (mode_line_target
)
22708 case MODE_LINE_NOPROP
:
22709 case MODE_LINE_TITLE
:
22710 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22712 case MODE_LINE_STRING
:
22713 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22716 case MODE_LINE_DISPLAY
:
22717 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22726 /* Store a mode-line string element in mode_line_string_list.
22728 If STRING is non-null, display that C string. Otherwise, the Lisp
22729 string LISP_STRING is displayed.
22731 FIELD_WIDTH is the minimum number of output glyphs to produce.
22732 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22733 with spaces. FIELD_WIDTH <= 0 means don't pad.
22735 PRECISION is the maximum number of characters to output from
22736 STRING. PRECISION <= 0 means don't truncate the string.
22738 If COPY_STRING, make a copy of LISP_STRING before adding
22739 properties to the string.
22741 PROPS are the properties to add to the string.
22742 The mode_line_string_face face property is always added to the string.
22746 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22748 int field_width
, int precision
, Lisp_Object props
)
22753 if (string
!= NULL
)
22755 len
= strlen (string
);
22756 if (precision
> 0 && len
> precision
)
22758 lisp_string
= make_string (string
, len
);
22760 props
= mode_line_string_face_prop
;
22761 else if (!NILP (mode_line_string_face
))
22763 Lisp_Object face
= Fplist_get (props
, Qface
);
22764 props
= Fcopy_sequence (props
);
22766 face
= mode_line_string_face
;
22768 face
= list2 (face
, mode_line_string_face
);
22769 props
= Fplist_put (props
, Qface
, face
);
22771 Fadd_text_properties (make_number (0), make_number (len
),
22772 props
, lisp_string
);
22776 len
= XFASTINT (Flength (lisp_string
));
22777 if (precision
> 0 && len
> precision
)
22780 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22783 if (!NILP (mode_line_string_face
))
22787 props
= Ftext_properties_at (make_number (0), lisp_string
);
22788 face
= Fplist_get (props
, Qface
);
22790 face
= mode_line_string_face
;
22792 face
= list2 (face
, mode_line_string_face
);
22793 props
= list2 (Qface
, face
);
22795 lisp_string
= Fcopy_sequence (lisp_string
);
22798 Fadd_text_properties (make_number (0), make_number (len
),
22799 props
, lisp_string
);
22804 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22808 if (field_width
> len
)
22810 field_width
-= len
;
22811 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22813 Fadd_text_properties (make_number (0), make_number (field_width
),
22814 props
, lisp_string
);
22815 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22823 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22825 doc
: /* Format a string out of a mode line format specification.
22826 First arg FORMAT specifies the mode line format (see `mode-line-format'
22827 for details) to use.
22829 By default, the format is evaluated for the currently selected window.
22831 Optional second arg FACE specifies the face property to put on all
22832 characters for which no face is specified. The value nil means the
22833 default face. The value t means whatever face the window's mode line
22834 currently uses (either `mode-line' or `mode-line-inactive',
22835 depending on whether the window is the selected window or not).
22836 An integer value means the value string has no text
22839 Optional third and fourth args WINDOW and BUFFER specify the window
22840 and buffer to use as the context for the formatting (defaults
22841 are the selected window and the WINDOW's buffer). */)
22842 (Lisp_Object format
, Lisp_Object face
,
22843 Lisp_Object window
, Lisp_Object buffer
)
22848 struct buffer
*old_buffer
= NULL
;
22850 bool no_props
= INTEGERP (face
);
22851 ptrdiff_t count
= SPECPDL_INDEX ();
22853 int string_start
= 0;
22855 w
= decode_any_window (window
);
22856 XSETWINDOW (window
, w
);
22859 buffer
= w
->contents
;
22860 CHECK_BUFFER (buffer
);
22862 /* Make formatting the modeline a non-op when noninteractive, otherwise
22863 there will be problems later caused by a partially initialized frame. */
22864 if (NILP (format
) || noninteractive
)
22865 return empty_unibyte_string
;
22870 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22871 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22872 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22873 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22874 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22875 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22876 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22879 old_buffer
= current_buffer
;
22881 /* Save things including mode_line_proptrans_alist,
22882 and set that to nil so that we don't alter the outer value. */
22883 record_unwind_protect (unwind_format_mode_line
,
22884 format_mode_line_unwind_data
22885 (XFRAME (WINDOW_FRAME (w
)),
22886 old_buffer
, selected_window
, true));
22887 mode_line_proptrans_alist
= Qnil
;
22889 Fselect_window (window
, Qt
);
22890 set_buffer_internal_1 (XBUFFER (buffer
));
22892 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22896 mode_line_target
= MODE_LINE_NOPROP
;
22897 mode_line_string_face_prop
= Qnil
;
22898 mode_line_string_list
= Qnil
;
22899 string_start
= MODE_LINE_NOPROP_LEN (0);
22903 mode_line_target
= MODE_LINE_STRING
;
22904 mode_line_string_list
= Qnil
;
22905 mode_line_string_face
= face
;
22906 mode_line_string_face_prop
22907 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22910 push_kboard (FRAME_KBOARD (it
.f
));
22911 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22916 len
= MODE_LINE_NOPROP_LEN (string_start
);
22917 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22921 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22922 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22923 empty_unibyte_string
);
22926 unbind_to (count
, Qnil
);
22930 /* Write a null-terminated, right justified decimal representation of
22931 the positive integer D to BUF using a minimal field width WIDTH. */
22934 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22936 register char *p
= buf
;
22944 *p
++ = d
% 10 + '0';
22949 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22960 /* Write a null-terminated, right justified decimal and "human
22961 readable" representation of the nonnegative integer D to BUF using
22962 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22964 static const char power_letter
[] =
22978 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22980 /* We aim to represent the nonnegative integer D as
22981 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22982 ptrdiff_t quotient
= d
;
22984 /* -1 means: do not use TENTHS. */
22988 /* Length of QUOTIENT.TENTHS as a string. */
22994 if (quotient
>= 1000)
22996 /* Scale to the appropriate EXPONENT. */
22999 remainder
= quotient
% 1000;
23003 while (quotient
>= 1000);
23005 /* Round to nearest and decide whether to use TENTHS or not. */
23008 tenths
= remainder
/ 100;
23009 if (remainder
% 100 >= 50)
23016 if (quotient
== 10)
23024 if (remainder
>= 500)
23026 if (quotient
< 999)
23037 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23038 if (tenths
== -1 && quotient
<= 99)
23045 p
= psuffix
= buf
+ max (width
, length
);
23047 /* Print EXPONENT. */
23048 *psuffix
++ = power_letter
[exponent
];
23051 /* Print TENTHS. */
23054 *--p
= '0' + tenths
;
23058 /* Print QUOTIENT. */
23061 int digit
= quotient
% 10;
23062 *--p
= '0' + digit
;
23064 while ((quotient
/= 10) != 0);
23066 /* Print leading spaces. */
23071 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23072 If EOL_FLAG, set also a mnemonic character for end-of-line
23073 type of CODING_SYSTEM. Return updated pointer into BUF. */
23075 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23078 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23081 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23082 const unsigned char *eol_str
;
23084 /* The EOL conversion we are using. */
23085 Lisp_Object eoltype
;
23087 val
= CODING_SYSTEM_SPEC (coding_system
);
23090 if (!VECTORP (val
)) /* Not yet decided. */
23092 *buf
++ = multibyte
? '-' : ' ';
23094 eoltype
= eol_mnemonic_undecided
;
23095 /* Don't mention EOL conversion if it isn't decided. */
23100 Lisp_Object eolvalue
;
23102 attrs
= AREF (val
, 0);
23103 eolvalue
= AREF (val
, 2);
23106 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23111 /* The EOL conversion that is normal on this system. */
23113 if (NILP (eolvalue
)) /* Not yet decided. */
23114 eoltype
= eol_mnemonic_undecided
;
23115 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23116 eoltype
= eol_mnemonic_undecided
;
23117 else /* eolvalue is Qunix, Qdos, or Qmac. */
23118 eoltype
= (EQ (eolvalue
, Qunix
)
23119 ? eol_mnemonic_unix
23120 : EQ (eolvalue
, Qdos
)
23121 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23127 /* Mention the EOL conversion if it is not the usual one. */
23128 if (STRINGP (eoltype
))
23130 eol_str
= SDATA (eoltype
);
23131 eol_str_len
= SBYTES (eoltype
);
23133 else if (CHARACTERP (eoltype
))
23135 int c
= XFASTINT (eoltype
);
23136 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23140 eol_str
= invalid_eol_type
;
23141 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23143 memcpy (buf
, eol_str
, eol_str_len
);
23144 buf
+= eol_str_len
;
23150 /* Return a string for the output of a mode line %-spec for window W,
23151 generated by character C. FIELD_WIDTH > 0 means pad the string
23152 returned with spaces to that value. Return a Lisp string in
23153 *STRING if the resulting string is taken from that Lisp string.
23155 Note we operate on the current buffer for most purposes. */
23157 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23159 static const char *
23160 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23161 Lisp_Object
*string
)
23164 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23165 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23166 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23167 produce strings from numerical values, so limit preposterously
23168 large values of FIELD_WIDTH to avoid overrunning the buffer's
23169 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23170 bytes plus the terminating null. */
23171 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23172 struct buffer
*b
= current_buffer
;
23180 if (!NILP (BVAR (b
, read_only
)))
23182 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23187 /* This differs from %* only for a modified read-only buffer. */
23188 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23190 if (!NILP (BVAR (b
, read_only
)))
23195 /* This differs from %* in ignoring read-only-ness. */
23196 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23208 if (command_loop_level
> 5)
23210 p
= decode_mode_spec_buf
;
23211 for (i
= 0; i
< command_loop_level
; i
++)
23214 return decode_mode_spec_buf
;
23222 if (command_loop_level
> 5)
23224 p
= decode_mode_spec_buf
;
23225 for (i
= 0; i
< command_loop_level
; i
++)
23228 return decode_mode_spec_buf
;
23235 /* Let lots_of_dashes be a string of infinite length. */
23236 if (mode_line_target
== MODE_LINE_NOPROP
23237 || mode_line_target
== MODE_LINE_STRING
)
23239 if (field_width
<= 0
23240 || field_width
> sizeof (lots_of_dashes
))
23242 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23243 decode_mode_spec_buf
[i
] = '-';
23244 decode_mode_spec_buf
[i
] = '\0';
23245 return decode_mode_spec_buf
;
23248 return lots_of_dashes
;
23252 obj
= BVAR (b
, name
);
23256 /* %c and %l are ignored in `frame-title-format'.
23257 (In redisplay_internal, the frame title is drawn _before_ the
23258 windows are updated, so the stuff which depends on actual
23259 window contents (such as %l) may fail to render properly, or
23260 even crash emacs.) */
23261 if (mode_line_target
== MODE_LINE_TITLE
)
23265 ptrdiff_t col
= current_column ();
23266 w
->column_number_displayed
= col
;
23267 pint2str (decode_mode_spec_buf
, width
, col
);
23268 return decode_mode_spec_buf
;
23272 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23274 if (NILP (Vmemory_full
))
23277 return "!MEM FULL! ";
23284 /* %F displays the frame name. */
23285 if (!NILP (f
->title
))
23286 return SSDATA (f
->title
);
23287 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23288 return SSDATA (f
->name
);
23292 obj
= BVAR (b
, filename
);
23297 ptrdiff_t size
= ZV
- BEGV
;
23298 pint2str (decode_mode_spec_buf
, width
, size
);
23299 return decode_mode_spec_buf
;
23304 ptrdiff_t size
= ZV
- BEGV
;
23305 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23306 return decode_mode_spec_buf
;
23311 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23312 ptrdiff_t topline
, nlines
, height
;
23315 /* %c and %l are ignored in `frame-title-format'. */
23316 if (mode_line_target
== MODE_LINE_TITLE
)
23319 startpos
= marker_position (w
->start
);
23320 startpos_byte
= marker_byte_position (w
->start
);
23321 height
= WINDOW_TOTAL_LINES (w
);
23323 /* If we decided that this buffer isn't suitable for line numbers,
23324 don't forget that too fast. */
23325 if (w
->base_line_pos
== -1)
23328 /* If the buffer is very big, don't waste time. */
23329 if (INTEGERP (Vline_number_display_limit
)
23330 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23332 w
->base_line_pos
= 0;
23333 w
->base_line_number
= 0;
23337 if (w
->base_line_number
> 0
23338 && w
->base_line_pos
> 0
23339 && w
->base_line_pos
<= startpos
)
23341 line
= w
->base_line_number
;
23342 linepos
= w
->base_line_pos
;
23343 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23348 linepos
= BUF_BEGV (b
);
23349 linepos_byte
= BUF_BEGV_BYTE (b
);
23352 /* Count lines from base line to window start position. */
23353 nlines
= display_count_lines (linepos_byte
,
23357 topline
= nlines
+ line
;
23359 /* Determine a new base line, if the old one is too close
23360 or too far away, or if we did not have one.
23361 "Too close" means it's plausible a scroll-down would
23362 go back past it. */
23363 if (startpos
== BUF_BEGV (b
))
23365 w
->base_line_number
= topline
;
23366 w
->base_line_pos
= BUF_BEGV (b
);
23368 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23369 || linepos
== BUF_BEGV (b
))
23371 ptrdiff_t limit
= BUF_BEGV (b
);
23372 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23373 ptrdiff_t position
;
23374 ptrdiff_t distance
=
23375 (height
* 2 + 30) * line_number_display_limit_width
;
23377 if (startpos
- distance
> limit
)
23379 limit
= startpos
- distance
;
23380 limit_byte
= CHAR_TO_BYTE (limit
);
23383 nlines
= display_count_lines (startpos_byte
,
23385 - (height
* 2 + 30),
23387 /* If we couldn't find the lines we wanted within
23388 line_number_display_limit_width chars per line,
23389 give up on line numbers for this window. */
23390 if (position
== limit_byte
&& limit
== startpos
- distance
)
23392 w
->base_line_pos
= -1;
23393 w
->base_line_number
= 0;
23397 w
->base_line_number
= topline
- nlines
;
23398 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23401 /* Now count lines from the start pos to point. */
23402 nlines
= display_count_lines (startpos_byte
,
23403 PT_BYTE
, PT
, &junk
);
23405 /* Record that we did display the line number. */
23406 line_number_displayed
= true;
23408 /* Make the string to show. */
23409 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23410 return decode_mode_spec_buf
;
23413 char *p
= decode_mode_spec_buf
;
23414 int pad
= width
- 2;
23420 return decode_mode_spec_buf
;
23426 obj
= BVAR (b
, mode_name
);
23430 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23436 ptrdiff_t pos
= marker_position (w
->start
);
23437 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23439 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23441 if (pos
<= BUF_BEGV (b
))
23446 else if (pos
<= BUF_BEGV (b
))
23450 if (total
> 1000000)
23451 /* Do it differently for a large value, to avoid overflow. */
23452 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23454 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23455 /* We can't normally display a 3-digit number,
23456 so get us a 2-digit number that is close. */
23459 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23460 return decode_mode_spec_buf
;
23464 /* Display percentage of size above the bottom of the screen. */
23467 ptrdiff_t toppos
= marker_position (w
->start
);
23468 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23469 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23471 if (botpos
>= BUF_ZV (b
))
23473 if (toppos
<= BUF_BEGV (b
))
23480 if (total
> 1000000)
23481 /* Do it differently for a large value, to avoid overflow. */
23482 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23484 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23485 /* We can't normally display a 3-digit number,
23486 so get us a 2-digit number that is close. */
23489 if (toppos
<= BUF_BEGV (b
))
23490 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23492 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23493 return decode_mode_spec_buf
;
23498 /* status of process */
23499 obj
= Fget_buffer_process (Fcurrent_buffer ());
23501 return "no process";
23503 obj
= Fsymbol_name (Fprocess_status (obj
));
23509 ptrdiff_t count
= inhibit_garbage_collection ();
23510 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23511 Lisp_Object val
= Qnil
;
23513 if (STRINGP (curdir
))
23514 val
= call1 (intern ("file-remote-p"), curdir
);
23516 unbind_to (count
, Qnil
);
23525 /* coding-system (not including end-of-line format) */
23527 /* coding-system (including end-of-line type) */
23529 bool eol_flag
= (c
== 'Z');
23530 char *p
= decode_mode_spec_buf
;
23532 if (! FRAME_WINDOW_P (f
))
23534 /* No need to mention EOL here--the terminal never needs
23535 to do EOL conversion. */
23536 p
= decode_mode_spec_coding (CODING_ID_NAME
23537 (FRAME_KEYBOARD_CODING (f
)->id
),
23539 p
= decode_mode_spec_coding (CODING_ID_NAME
23540 (FRAME_TERMINAL_CODING (f
)->id
),
23543 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23546 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23547 #ifdef subprocesses
23548 obj
= Fget_buffer_process (Fcurrent_buffer ());
23549 if (PROCESSP (obj
))
23551 p
= decode_mode_spec_coding
23552 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23553 p
= decode_mode_spec_coding
23554 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23556 #endif /* subprocesses */
23559 return decode_mode_spec_buf
;
23566 return SSDATA (obj
);
23573 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23574 means count lines back from START_BYTE. But don't go beyond
23575 LIMIT_BYTE. Return the number of lines thus found (always
23578 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23579 either the position COUNT lines after/before START_BYTE, if we
23580 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23584 display_count_lines (ptrdiff_t start_byte
,
23585 ptrdiff_t limit_byte
, ptrdiff_t count
,
23586 ptrdiff_t *byte_pos_ptr
)
23588 register unsigned char *cursor
;
23589 unsigned char *base
;
23591 register ptrdiff_t ceiling
;
23592 register unsigned char *ceiling_addr
;
23593 ptrdiff_t orig_count
= count
;
23595 /* If we are not in selective display mode,
23596 check only for newlines. */
23597 bool selective_display
23598 = (!NILP (BVAR (current_buffer
, selective_display
))
23599 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23603 while (start_byte
< limit_byte
)
23605 ceiling
= BUFFER_CEILING_OF (start_byte
);
23606 ceiling
= min (limit_byte
- 1, ceiling
);
23607 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23608 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23612 if (selective_display
)
23614 while (*cursor
!= '\n' && *cursor
!= 015
23615 && ++cursor
!= ceiling_addr
)
23617 if (cursor
== ceiling_addr
)
23622 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23631 start_byte
+= cursor
- base
;
23632 *byte_pos_ptr
= start_byte
;
23636 while (cursor
< ceiling_addr
);
23638 start_byte
+= ceiling_addr
- base
;
23643 while (start_byte
> limit_byte
)
23645 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23646 ceiling
= max (limit_byte
, ceiling
);
23647 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23648 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23651 if (selective_display
)
23653 while (--cursor
>= ceiling_addr
23654 && *cursor
!= '\n' && *cursor
!= 015)
23656 if (cursor
< ceiling_addr
)
23661 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23668 start_byte
+= cursor
- base
+ 1;
23669 *byte_pos_ptr
= start_byte
;
23670 /* When scanning backwards, we should
23671 not count the newline posterior to which we stop. */
23672 return - orig_count
- 1;
23675 start_byte
+= ceiling_addr
- base
;
23679 *byte_pos_ptr
= limit_byte
;
23682 return - orig_count
+ count
;
23683 return orig_count
- count
;
23689 /***********************************************************************
23691 ***********************************************************************/
23693 /* Display a NUL-terminated string, starting with index START.
23695 If STRING is non-null, display that C string. Otherwise, the Lisp
23696 string LISP_STRING is displayed. There's a case that STRING is
23697 non-null and LISP_STRING is not nil. It means STRING is a string
23698 data of LISP_STRING. In that case, we display LISP_STRING while
23699 ignoring its text properties.
23701 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23702 FACE_STRING. Display STRING or LISP_STRING with the face at
23703 FACE_STRING_POS in FACE_STRING:
23705 Display the string in the environment given by IT, but use the
23706 standard display table, temporarily.
23708 FIELD_WIDTH is the minimum number of output glyphs to produce.
23709 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23710 with spaces. If STRING has more characters, more than FIELD_WIDTH
23711 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23713 PRECISION is the maximum number of characters to output from
23714 STRING. PRECISION < 0 means don't truncate the string.
23716 This is roughly equivalent to printf format specifiers:
23718 FIELD_WIDTH PRECISION PRINTF
23719 ----------------------------------------
23725 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23726 display them, and < 0 means obey the current buffer's value of
23727 enable_multibyte_characters.
23729 Value is the number of columns displayed. */
23732 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23733 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23734 int field_width
, int precision
, int max_x
, int multibyte
)
23736 int hpos_at_start
= it
->hpos
;
23737 int saved_face_id
= it
->face_id
;
23738 struct glyph_row
*row
= it
->glyph_row
;
23739 ptrdiff_t it_charpos
;
23741 /* Initialize the iterator IT for iteration over STRING beginning
23742 with index START. */
23743 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23744 precision
, field_width
, multibyte
);
23745 if (string
&& STRINGP (lisp_string
))
23746 /* LISP_STRING is the one returned by decode_mode_spec. We should
23747 ignore its text properties. */
23748 it
->stop_charpos
= it
->end_charpos
;
23750 /* If displaying STRING, set up the face of the iterator from
23751 FACE_STRING, if that's given. */
23752 if (STRINGP (face_string
))
23758 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23759 0, &endptr
, it
->base_face_id
, false);
23760 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23761 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23764 /* Set max_x to the maximum allowed X position. Don't let it go
23765 beyond the right edge of the window. */
23767 max_x
= it
->last_visible_x
;
23769 max_x
= min (max_x
, it
->last_visible_x
);
23771 /* Skip over display elements that are not visible. because IT->w is
23773 if (it
->current_x
< it
->first_visible_x
)
23774 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23775 MOVE_TO_POS
| MOVE_TO_X
);
23777 row
->ascent
= it
->max_ascent
;
23778 row
->height
= it
->max_ascent
+ it
->max_descent
;
23779 row
->phys_ascent
= it
->max_phys_ascent
;
23780 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23781 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23783 if (STRINGP (it
->string
))
23784 it_charpos
= IT_STRING_CHARPOS (*it
);
23786 it_charpos
= IT_CHARPOS (*it
);
23788 /* This condition is for the case that we are called with current_x
23789 past last_visible_x. */
23790 while (it
->current_x
< max_x
)
23792 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23794 /* Get the next display element. */
23795 if (!get_next_display_element (it
))
23798 /* Produce glyphs. */
23799 x_before
= it
->current_x
;
23800 n_glyphs_before
= row
->used
[TEXT_AREA
];
23801 PRODUCE_GLYPHS (it
);
23803 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23806 while (i
< nglyphs
)
23808 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23810 if (it
->line_wrap
!= TRUNCATE
23811 && x
+ glyph
->pixel_width
> max_x
)
23813 /* End of continued line or max_x reached. */
23814 if (CHAR_GLYPH_PADDING_P (*glyph
))
23816 /* A wide character is unbreakable. */
23817 if (row
->reversed_p
)
23818 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23819 - n_glyphs_before
);
23820 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23821 it
->current_x
= x_before
;
23825 if (row
->reversed_p
)
23826 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23827 - (n_glyphs_before
+ i
));
23828 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23833 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23835 /* Glyph is at least partially visible. */
23837 if (x
< it
->first_visible_x
)
23838 row
->x
= x
- it
->first_visible_x
;
23842 /* Glyph is off the left margin of the display area.
23843 Should not happen. */
23847 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23848 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23849 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23850 row
->phys_height
= max (row
->phys_height
,
23851 it
->max_phys_ascent
+ it
->max_phys_descent
);
23852 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23853 it
->max_extra_line_spacing
);
23854 x
+= glyph
->pixel_width
;
23858 /* Stop if max_x reached. */
23862 /* Stop at line ends. */
23863 if (ITERATOR_AT_END_OF_LINE_P (it
))
23865 it
->continuation_lines_width
= 0;
23869 set_iterator_to_next (it
, true);
23870 if (STRINGP (it
->string
))
23871 it_charpos
= IT_STRING_CHARPOS (*it
);
23873 it_charpos
= IT_CHARPOS (*it
);
23875 /* Stop if truncating at the right edge. */
23876 if (it
->line_wrap
== TRUNCATE
23877 && it
->current_x
>= it
->last_visible_x
)
23879 /* Add truncation mark, but don't do it if the line is
23880 truncated at a padding space. */
23881 if (it_charpos
< it
->string_nchars
)
23883 if (!FRAME_WINDOW_P (it
->f
))
23887 if (it
->current_x
> it
->last_visible_x
)
23889 if (!row
->reversed_p
)
23891 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23892 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23897 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23898 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23900 unproduce_glyphs (it
, ii
+ 1);
23901 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23903 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23905 row
->used
[TEXT_AREA
] = ii
;
23906 produce_special_glyphs (it
, IT_TRUNCATION
);
23909 produce_special_glyphs (it
, IT_TRUNCATION
);
23911 row
->truncated_on_right_p
= true;
23917 /* Maybe insert a truncation at the left. */
23918 if (it
->first_visible_x
23921 if (!FRAME_WINDOW_P (it
->f
)
23922 || (row
->reversed_p
23923 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23924 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23925 insert_left_trunc_glyphs (it
);
23926 row
->truncated_on_left_p
= true;
23929 it
->face_id
= saved_face_id
;
23931 /* Value is number of columns displayed. */
23932 return it
->hpos
- hpos_at_start
;
23937 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23938 appears as an element of LIST or as the car of an element of LIST.
23939 If PROPVAL is a list, compare each element against LIST in that
23940 way, and return 1/2 if any element of PROPVAL is found in LIST.
23941 Otherwise return 0. This function cannot quit.
23942 The return value is 2 if the text is invisible but with an ellipsis
23943 and 1 if it's invisible and without an ellipsis. */
23946 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23948 Lisp_Object tail
, proptail
;
23950 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23952 register Lisp_Object tem
;
23954 if (EQ (propval
, tem
))
23956 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23957 return NILP (XCDR (tem
)) ? 1 : 2;
23960 if (CONSP (propval
))
23962 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23964 Lisp_Object propelt
;
23965 propelt
= XCAR (proptail
);
23966 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23968 register Lisp_Object tem
;
23970 if (EQ (propelt
, tem
))
23972 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23973 return NILP (XCDR (tem
)) ? 1 : 2;
23981 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23982 doc
: /* Non-nil if the property makes the text invisible.
23983 POS-OR-PROP can be a marker or number, in which case it is taken to be
23984 a position in the current buffer and the value of the `invisible' property
23985 is checked; or it can be some other value, which is then presumed to be the
23986 value of the `invisible' property of the text of interest.
23987 The non-nil value returned can be t for truly invisible text or something
23988 else if the text is replaced by an ellipsis. */)
23989 (Lisp_Object pos_or_prop
)
23992 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23993 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23995 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23996 return (invis
== 0 ? Qnil
23998 : make_number (invis
));
24001 /* Calculate a width or height in pixels from a specification using
24002 the following elements:
24005 NUM - a (fractional) multiple of the default font width/height
24006 (NUM) - specifies exactly NUM pixels
24007 UNIT - a fixed number of pixels, see below.
24008 ELEMENT - size of a display element in pixels, see below.
24009 (NUM . SPEC) - equals NUM * SPEC
24010 (+ SPEC SPEC ...) - add pixel values
24011 (- SPEC SPEC ...) - subtract pixel values
24012 (- SPEC) - negate pixel value
24015 INT or FLOAT - a number constant
24016 SYMBOL - use symbol's (buffer local) variable binding.
24019 in - pixels per inch *)
24020 mm - pixels per 1/1000 meter *)
24021 cm - pixels per 1/100 meter *)
24022 width - width of current font in pixels.
24023 height - height of current font in pixels.
24025 *) using the ratio(s) defined in display-pixels-per-inch.
24029 left-fringe - left fringe width in pixels
24030 right-fringe - right fringe width in pixels
24032 left-margin - left margin width in pixels
24033 right-margin - right margin width in pixels
24035 scroll-bar - scroll-bar area width in pixels
24039 Pixels corresponding to 5 inches:
24042 Total width of non-text areas on left side of window (if scroll-bar is on left):
24043 '(space :width (+ left-fringe left-margin scroll-bar))
24045 Align to first text column (in header line):
24046 '(space :align-to 0)
24048 Align to middle of text area minus half the width of variable `my-image'
24049 containing a loaded image:
24050 '(space :align-to (0.5 . (- text my-image)))
24052 Width of left margin minus width of 1 character in the default font:
24053 '(space :width (- left-margin 1))
24055 Width of left margin minus width of 2 characters in the current font:
24056 '(space :width (- left-margin (2 . width)))
24058 Center 1 character over left-margin (in header line):
24059 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24061 Different ways to express width of left fringe plus left margin minus one pixel:
24062 '(space :width (- (+ left-fringe left-margin) (1)))
24063 '(space :width (+ left-fringe left-margin (- (1))))
24064 '(space :width (+ left-fringe left-margin (-1)))
24069 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24070 struct font
*font
, bool width_p
, int *align_to
)
24074 # define OK_PIXELS(val) (*res = (val), true)
24075 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24078 return OK_PIXELS (0);
24080 eassert (FRAME_LIVE_P (it
->f
));
24082 if (SYMBOLP (prop
))
24084 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24086 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24088 if (unit
[0] == 'i' && unit
[1] == 'n')
24090 else if (unit
[0] == 'm' && unit
[1] == 'm')
24092 else if (unit
[0] == 'c' && unit
[1] == 'm')
24098 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24099 : FRAME_RES_Y (it
->f
));
24102 return OK_PIXELS (ppi
/ pixels
);
24107 #ifdef HAVE_WINDOW_SYSTEM
24108 if (EQ (prop
, Qheight
))
24109 return OK_PIXELS (font
24110 ? normal_char_height (font
, -1)
24111 : FRAME_LINE_HEIGHT (it
->f
));
24112 if (EQ (prop
, Qwidth
))
24113 return OK_PIXELS (font
24114 ? FONT_WIDTH (font
)
24115 : FRAME_COLUMN_WIDTH (it
->f
));
24117 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24118 return OK_PIXELS (1);
24121 if (EQ (prop
, Qtext
))
24122 return OK_PIXELS (width_p
24123 ? window_box_width (it
->w
, TEXT_AREA
)
24124 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24126 if (align_to
&& *align_to
< 0)
24129 if (EQ (prop
, Qleft
))
24130 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24131 if (EQ (prop
, Qright
))
24132 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24133 if (EQ (prop
, Qcenter
))
24134 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24135 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24136 if (EQ (prop
, Qleft_fringe
))
24137 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24138 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24139 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24140 if (EQ (prop
, Qright_fringe
))
24141 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24142 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24143 : window_box_right_offset (it
->w
, TEXT_AREA
));
24144 if (EQ (prop
, Qleft_margin
))
24145 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24146 if (EQ (prop
, Qright_margin
))
24147 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24148 if (EQ (prop
, Qscroll_bar
))
24149 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24151 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24152 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24153 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24158 if (EQ (prop
, Qleft_fringe
))
24159 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24160 if (EQ (prop
, Qright_fringe
))
24161 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24162 if (EQ (prop
, Qleft_margin
))
24163 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24164 if (EQ (prop
, Qright_margin
))
24165 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24166 if (EQ (prop
, Qscroll_bar
))
24167 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24170 prop
= buffer_local_value (prop
, it
->w
->contents
);
24171 if (EQ (prop
, Qunbound
))
24175 if (NUMBERP (prop
))
24177 int base_unit
= (width_p
24178 ? FRAME_COLUMN_WIDTH (it
->f
)
24179 : FRAME_LINE_HEIGHT (it
->f
));
24180 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24185 Lisp_Object car
= XCAR (prop
);
24186 Lisp_Object cdr
= XCDR (prop
);
24190 #ifdef HAVE_WINDOW_SYSTEM
24191 if (FRAME_WINDOW_P (it
->f
)
24192 && valid_image_p (prop
))
24194 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24195 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24197 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24200 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24206 while (CONSP (cdr
))
24208 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24209 font
, width_p
, align_to
))
24212 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24217 if (EQ (car
, Qminus
))
24219 return OK_PIXELS (pixels
);
24222 car
= buffer_local_value (car
, it
->w
->contents
);
24223 if (EQ (car
, Qunbound
))
24230 pixels
= XFLOATINT (car
);
24232 return OK_PIXELS (pixels
);
24233 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24234 font
, width_p
, align_to
))
24235 return OK_PIXELS (pixels
* fact
);
24246 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24248 #ifdef HAVE_WINDOW_SYSTEM
24249 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24257 /***********************************************************************
24259 ***********************************************************************/
24261 #ifdef HAVE_WINDOW_SYSTEM
24266 dump_glyph_string (struct glyph_string
*s
)
24268 fprintf (stderr
, "glyph string\n");
24269 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24270 s
->x
, s
->y
, s
->width
, s
->height
);
24271 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24272 fprintf (stderr
, " hl = %d\n", s
->hl
);
24273 fprintf (stderr
, " left overhang = %d, right = %d\n",
24274 s
->left_overhang
, s
->right_overhang
);
24275 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24276 fprintf (stderr
, " extends to end of line = %d\n",
24277 s
->extends_to_end_of_line_p
);
24278 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24279 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24282 #endif /* GLYPH_DEBUG */
24284 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24285 of XChar2b structures for S; it can't be allocated in
24286 init_glyph_string because it must be allocated via `alloca'. W
24287 is the window on which S is drawn. ROW and AREA are the glyph row
24288 and area within the row from which S is constructed. START is the
24289 index of the first glyph structure covered by S. HL is a
24290 face-override for drawing S. */
24293 #define OPTIONAL_HDC(hdc) HDC hdc,
24294 #define DECLARE_HDC(hdc) HDC hdc;
24295 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24296 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24299 #ifndef OPTIONAL_HDC
24300 #define OPTIONAL_HDC(hdc)
24301 #define DECLARE_HDC(hdc)
24302 #define ALLOCATE_HDC(hdc, f)
24303 #define RELEASE_HDC(hdc, f)
24307 init_glyph_string (struct glyph_string
*s
,
24309 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24310 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24312 memset (s
, 0, sizeof *s
);
24314 s
->f
= XFRAME (w
->frame
);
24318 s
->display
= FRAME_X_DISPLAY (s
->f
);
24319 s
->window
= FRAME_X_WINDOW (s
->f
);
24320 s
->char2b
= char2b
;
24324 s
->first_glyph
= row
->glyphs
[area
] + start
;
24325 s
->height
= row
->height
;
24326 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24327 s
->ybase
= s
->y
+ row
->ascent
;
24331 /* Append the list of glyph strings with head H and tail T to the list
24332 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24335 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24336 struct glyph_string
*h
, struct glyph_string
*t
)
24350 /* Prepend the list of glyph strings with head H and tail T to the
24351 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24355 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24356 struct glyph_string
*h
, struct glyph_string
*t
)
24370 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24371 Set *HEAD and *TAIL to the resulting list. */
24374 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24375 struct glyph_string
*s
)
24377 s
->next
= s
->prev
= NULL
;
24378 append_glyph_string_lists (head
, tail
, s
, s
);
24382 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24383 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24384 make sure that X resources for the face returned are allocated.
24385 Value is a pointer to a realized face that is ready for display if
24388 static struct face
*
24389 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24390 XChar2b
*char2b
, bool display_p
)
24392 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24397 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24399 if (code
== FONT_INVALID_CODE
)
24402 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24404 /* Make sure X resources of the face are allocated. */
24405 #ifdef HAVE_X_WINDOWS
24409 eassert (face
!= NULL
);
24410 prepare_face_for_display (f
, face
);
24417 /* Get face and two-byte form of character glyph GLYPH on frame F.
24418 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24419 a pointer to a realized face that is ready for display. */
24421 static struct face
*
24422 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24428 eassert (glyph
->type
== CHAR_GLYPH
);
24429 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24431 /* Make sure X resources of the face are allocated. */
24432 eassert (face
!= NULL
);
24433 prepare_face_for_display (f
, face
);
24437 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24438 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24440 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24442 if (code
== FONT_INVALID_CODE
)
24446 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24451 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24452 Return true iff FONT has a glyph for C. */
24455 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24459 if (CHAR_BYTE8_P (c
))
24460 code
= CHAR_TO_BYTE8 (c
);
24462 code
= font
->driver
->encode_char (font
, c
);
24464 if (code
== FONT_INVALID_CODE
)
24466 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24471 /* Fill glyph string S with composition components specified by S->cmp.
24473 BASE_FACE is the base face of the composition.
24474 S->cmp_from is the index of the first component for S.
24476 OVERLAPS non-zero means S should draw the foreground only, and use
24477 its physical height for clipping. See also draw_glyphs.
24479 Value is the index of a component not in S. */
24482 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24486 /* For all glyphs of this composition, starting at the offset
24487 S->cmp_from, until we reach the end of the definition or encounter a
24488 glyph that requires the different face, add it to S. */
24493 s
->for_overlaps
= overlaps
;
24496 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24498 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24500 /* TAB in a composition means display glyphs with padding space
24501 on the left or right. */
24504 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24507 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24508 s
->char2b
+ i
, true);
24514 s
->font
= s
->face
->font
;
24516 else if (s
->face
!= face
)
24524 if (s
->face
== NULL
)
24526 s
->face
= base_face
->ascii_face
;
24527 s
->font
= s
->face
->font
;
24530 /* All glyph strings for the same composition has the same width,
24531 i.e. the width set for the first component of the composition. */
24532 s
->width
= s
->first_glyph
->pixel_width
;
24534 /* If the specified font could not be loaded, use the frame's
24535 default font, but record the fact that we couldn't load it in
24536 the glyph string so that we can draw rectangles for the
24537 characters of the glyph string. */
24538 if (s
->font
== NULL
)
24540 s
->font_not_found_p
= true;
24541 s
->font
= FRAME_FONT (s
->f
);
24544 /* Adjust base line for subscript/superscript text. */
24545 s
->ybase
+= s
->first_glyph
->voffset
;
24551 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24552 int start
, int end
, int overlaps
)
24554 struct glyph
*glyph
, *last
;
24555 Lisp_Object lgstring
;
24558 s
->for_overlaps
= overlaps
;
24559 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24560 last
= s
->row
->glyphs
[s
->area
] + end
;
24561 s
->cmp_id
= glyph
->u
.cmp
.id
;
24562 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24563 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24564 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24565 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24566 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24568 while (glyph
< last
24569 && glyph
->u
.cmp
.automatic
24570 && glyph
->u
.cmp
.id
== s
->cmp_id
24571 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24572 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24574 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24576 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24577 unsigned code
= LGLYPH_CODE (lglyph
);
24579 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24581 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24582 return glyph
- s
->row
->glyphs
[s
->area
];
24586 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24587 See the comment of fill_glyph_string for arguments.
24588 Value is the index of the first glyph not in S. */
24592 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24593 int start
, int end
, int overlaps
)
24595 struct glyph
*glyph
, *last
;
24598 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24599 s
->for_overlaps
= overlaps
;
24600 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24601 last
= s
->row
->glyphs
[s
->area
] + end
;
24602 voffset
= glyph
->voffset
;
24603 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24604 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24606 s
->width
= glyph
->pixel_width
;
24608 while (glyph
< last
24609 && glyph
->type
== GLYPHLESS_GLYPH
24610 && glyph
->voffset
== voffset
24611 && glyph
->face_id
== face_id
)
24614 s
->width
+= glyph
->pixel_width
;
24617 s
->ybase
+= voffset
;
24618 return glyph
- s
->row
->glyphs
[s
->area
];
24622 /* Fill glyph string S from a sequence of character glyphs.
24624 FACE_ID is the face id of the string. START is the index of the
24625 first glyph to consider, END is the index of the last + 1.
24626 OVERLAPS non-zero means S should draw the foreground only, and use
24627 its physical height for clipping. See also draw_glyphs.
24629 Value is the index of the first glyph not in S. */
24632 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24633 int start
, int end
, int overlaps
)
24635 struct glyph
*glyph
, *last
;
24637 bool glyph_not_available_p
;
24639 eassert (s
->f
== XFRAME (s
->w
->frame
));
24640 eassert (s
->nchars
== 0);
24641 eassert (start
>= 0 && end
> start
);
24643 s
->for_overlaps
= overlaps
;
24644 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24645 last
= s
->row
->glyphs
[s
->area
] + end
;
24646 voffset
= glyph
->voffset
;
24647 s
->padding_p
= glyph
->padding_p
;
24648 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24650 while (glyph
< last
24651 && glyph
->type
== CHAR_GLYPH
24652 && glyph
->voffset
== voffset
24653 /* Same face id implies same font, nowadays. */
24654 && glyph
->face_id
== face_id
24655 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24657 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24658 s
->char2b
+ s
->nchars
);
24660 eassert (s
->nchars
<= end
- start
);
24661 s
->width
+= glyph
->pixel_width
;
24662 if (glyph
++->padding_p
!= s
->padding_p
)
24666 s
->font
= s
->face
->font
;
24668 /* If the specified font could not be loaded, use the frame's font,
24669 but record the fact that we couldn't load it in
24670 S->font_not_found_p so that we can draw rectangles for the
24671 characters of the glyph string. */
24672 if (s
->font
== NULL
|| glyph_not_available_p
)
24674 s
->font_not_found_p
= true;
24675 s
->font
= FRAME_FONT (s
->f
);
24678 /* Adjust base line for subscript/superscript text. */
24679 s
->ybase
+= voffset
;
24681 eassert (s
->face
&& s
->face
->gc
);
24682 return glyph
- s
->row
->glyphs
[s
->area
];
24686 /* Fill glyph string S from image glyph S->first_glyph. */
24689 fill_image_glyph_string (struct glyph_string
*s
)
24691 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24692 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24694 s
->slice
= s
->first_glyph
->slice
.img
;
24695 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24696 s
->font
= s
->face
->font
;
24697 s
->width
= s
->first_glyph
->pixel_width
;
24699 /* Adjust base line for subscript/superscript text. */
24700 s
->ybase
+= s
->first_glyph
->voffset
;
24704 /* Fill glyph string S from a sequence of stretch glyphs.
24706 START is the index of the first glyph to consider,
24707 END is the index of the last + 1.
24709 Value is the index of the first glyph not in S. */
24712 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24714 struct glyph
*glyph
, *last
;
24715 int voffset
, face_id
;
24717 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24719 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24720 last
= s
->row
->glyphs
[s
->area
] + end
;
24721 face_id
= glyph
->face_id
;
24722 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24723 s
->font
= s
->face
->font
;
24724 s
->width
= glyph
->pixel_width
;
24726 voffset
= glyph
->voffset
;
24730 && glyph
->type
== STRETCH_GLYPH
24731 && glyph
->voffset
== voffset
24732 && glyph
->face_id
== face_id
);
24734 s
->width
+= glyph
->pixel_width
;
24736 /* Adjust base line for subscript/superscript text. */
24737 s
->ybase
+= voffset
;
24739 /* The case that face->gc == 0 is handled when drawing the glyph
24740 string by calling prepare_face_for_display. */
24742 return glyph
- s
->row
->glyphs
[s
->area
];
24745 static struct font_metrics
*
24746 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24748 static struct font_metrics metrics
;
24753 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24754 if (code
== FONT_INVALID_CODE
)
24756 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24760 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24761 for FONT. Values are taken from font-global ones, except for fonts
24762 that claim preposterously large values, but whose glyphs actually
24763 have reasonable dimensions. C is the character to use for metrics
24764 if the font-global values are too large; if C is negative, the
24765 function selects a default character. */
24767 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24769 *ascent
= FONT_BASE (font
);
24770 *descent
= FONT_DESCENT (font
);
24772 if (FONT_TOO_HIGH (font
))
24776 /* Get metrics of C, defaulting to a reasonably sized ASCII
24778 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24780 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24782 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24784 /* We add 1 pixel to character dimensions as heuristics
24785 that produces nicer display, e.g. when the face has
24786 the box attribute. */
24787 *ascent
= pcm
->ascent
+ 1;
24788 *descent
= pcm
->descent
+ 1;
24794 /* A subroutine that computes a reasonable "normal character height"
24795 for fonts that claim preposterously large vertical dimensions, but
24796 whose glyphs are actually reasonably sized. C is the character
24797 whose metrics to use for those fonts, or -1 for default
24800 normal_char_height (struct font
*font
, int c
)
24802 int ascent
, descent
;
24804 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24806 return ascent
+ descent
;
24810 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24811 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24812 assumed to be zero. */
24815 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24817 *left
= *right
= 0;
24819 if (glyph
->type
== CHAR_GLYPH
)
24822 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24825 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24828 if (pcm
->rbearing
> pcm
->width
)
24829 *right
= pcm
->rbearing
- pcm
->width
;
24830 if (pcm
->lbearing
< 0)
24831 *left
= -pcm
->lbearing
;
24835 else if (glyph
->type
== COMPOSITE_GLYPH
)
24837 if (! glyph
->u
.cmp
.automatic
)
24839 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24841 if (cmp
->rbearing
> cmp
->pixel_width
)
24842 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24843 if (cmp
->lbearing
< 0)
24844 *left
= - cmp
->lbearing
;
24848 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24849 struct font_metrics metrics
;
24851 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24852 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24853 if (metrics
.rbearing
> metrics
.width
)
24854 *right
= metrics
.rbearing
- metrics
.width
;
24855 if (metrics
.lbearing
< 0)
24856 *left
= - metrics
.lbearing
;
24862 /* Return the index of the first glyph preceding glyph string S that
24863 is overwritten by S because of S's left overhang. Value is -1
24864 if no glyphs are overwritten. */
24867 left_overwritten (struct glyph_string
*s
)
24871 if (s
->left_overhang
)
24874 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24875 int first
= s
->first_glyph
- glyphs
;
24877 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24878 x
-= glyphs
[i
].pixel_width
;
24889 /* Return the index of the first glyph preceding glyph string S that
24890 is overwriting S because of its right overhang. Value is -1 if no
24891 glyph in front of S overwrites S. */
24894 left_overwriting (struct glyph_string
*s
)
24897 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24898 int first
= s
->first_glyph
- glyphs
;
24902 for (i
= first
- 1; i
>= 0; --i
)
24905 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24908 x
-= glyphs
[i
].pixel_width
;
24915 /* Return the index of the last glyph following glyph string S that is
24916 overwritten by S because of S's right overhang. Value is -1 if
24917 no such glyph is found. */
24920 right_overwritten (struct glyph_string
*s
)
24924 if (s
->right_overhang
)
24927 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24928 int first
= (s
->first_glyph
- glyphs
24929 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24930 int end
= s
->row
->used
[s
->area
];
24932 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24933 x
+= glyphs
[i
].pixel_width
;
24942 /* Return the index of the last glyph following glyph string S that
24943 overwrites S because of its left overhang. Value is negative
24944 if no such glyph is found. */
24947 right_overwriting (struct glyph_string
*s
)
24950 int end
= s
->row
->used
[s
->area
];
24951 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24952 int first
= (s
->first_glyph
- glyphs
24953 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24957 for (i
= first
; i
< end
; ++i
)
24960 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24963 x
+= glyphs
[i
].pixel_width
;
24970 /* Set background width of glyph string S. START is the index of the
24971 first glyph following S. LAST_X is the right-most x-position + 1
24972 in the drawing area. */
24975 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24977 /* If the face of this glyph string has to be drawn to the end of
24978 the drawing area, set S->extends_to_end_of_line_p. */
24980 if (start
== s
->row
->used
[s
->area
]
24981 && ((s
->row
->fill_line_p
24982 && (s
->hl
== DRAW_NORMAL_TEXT
24983 || s
->hl
== DRAW_IMAGE_RAISED
24984 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24985 || s
->hl
== DRAW_MOUSE_FACE
))
24986 s
->extends_to_end_of_line_p
= true;
24988 /* If S extends its face to the end of the line, set its
24989 background_width to the distance to the right edge of the drawing
24991 if (s
->extends_to_end_of_line_p
)
24992 s
->background_width
= last_x
- s
->x
+ 1;
24994 s
->background_width
= s
->width
;
24998 /* Compute overhangs and x-positions for glyph string S and its
24999 predecessors, or successors. X is the starting x-position for S.
25000 BACKWARD_P means process predecessors. */
25003 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25009 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25010 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25020 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25021 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25031 /* The following macros are only called from draw_glyphs below.
25032 They reference the following parameters of that function directly:
25033 `w', `row', `area', and `overlap_p'
25034 as well as the following local variables:
25035 `s', `f', and `hdc' (in W32) */
25038 /* On W32, silently add local `hdc' variable to argument list of
25039 init_glyph_string. */
25040 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25041 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25043 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25044 init_glyph_string (s, char2b, w, row, area, start, hl)
25047 /* Add a glyph string for a stretch glyph to the list of strings
25048 between HEAD and TAIL. START is the index of the stretch glyph in
25049 row area AREA of glyph row ROW. END is the index of the last glyph
25050 in that glyph row area. X is the current output position assigned
25051 to the new glyph string constructed. HL overrides that face of the
25052 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25053 is the right-most x-position of the drawing area. */
25055 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25056 and below -- keep them on one line. */
25057 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25060 s = alloca (sizeof *s); \
25061 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25062 START = fill_stretch_glyph_string (s, START, END); \
25063 append_glyph_string (&HEAD, &TAIL, s); \
25069 /* Add a glyph string for an image glyph to the list of strings
25070 between HEAD and TAIL. START is the index of the image glyph in
25071 row area AREA of glyph row ROW. END is the index of the last glyph
25072 in that glyph row area. X is the current output position assigned
25073 to the new glyph string constructed. HL overrides that face of the
25074 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25075 is the right-most x-position of the drawing area. */
25077 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25080 s = alloca (sizeof *s); \
25081 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25082 fill_image_glyph_string (s); \
25083 append_glyph_string (&HEAD, &TAIL, s); \
25090 /* Add a glyph string for a sequence of character glyphs to the list
25091 of strings between HEAD and TAIL. START is the index of the first
25092 glyph in row area AREA of glyph row ROW that is part of the new
25093 glyph string. END is the index of the last glyph in that glyph row
25094 area. X is the current output position assigned to the new glyph
25095 string constructed. HL overrides that face of the glyph; e.g. it
25096 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25097 right-most x-position of the drawing area. */
25099 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25105 face_id = (row)->glyphs[area][START].face_id; \
25107 s = alloca (sizeof *s); \
25108 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25109 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25110 append_glyph_string (&HEAD, &TAIL, s); \
25112 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25117 /* Add a glyph string for a composite sequence to the list of strings
25118 between HEAD and TAIL. START is the index of the first glyph in
25119 row area AREA of glyph row ROW that is part of the new glyph
25120 string. END is the index of the last glyph in that glyph row area.
25121 X is the current output position assigned to the new glyph string
25122 constructed. HL overrides that face of the glyph; e.g. it is
25123 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25124 x-position of the drawing area. */
25126 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25128 int face_id = (row)->glyphs[area][START].face_id; \
25129 struct face *base_face = FACE_FROM_ID (f, face_id); \
25130 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25131 struct composition *cmp = composition_table[cmp_id]; \
25133 struct glyph_string *first_s = NULL; \
25136 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25138 /* Make glyph_strings for each glyph sequence that is drawable by \
25139 the same face, and append them to HEAD/TAIL. */ \
25140 for (n = 0; n < cmp->glyph_len;) \
25142 s = alloca (sizeof *s); \
25143 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25144 append_glyph_string (&(HEAD), &(TAIL), s); \
25150 n = fill_composite_glyph_string (s, base_face, overlaps); \
25158 /* Add a glyph string for a glyph-string sequence to the list of strings
25159 between HEAD and TAIL. */
25161 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25165 Lisp_Object gstring; \
25167 face_id = (row)->glyphs[area][START].face_id; \
25168 gstring = (composition_gstring_from_id \
25169 ((row)->glyphs[area][START].u.cmp.id)); \
25170 s = alloca (sizeof *s); \
25171 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25172 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25173 append_glyph_string (&(HEAD), &(TAIL), s); \
25175 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25179 /* Add a glyph string for a sequence of glyphless character's glyphs
25180 to the list of strings between HEAD and TAIL. The meanings of
25181 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25183 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25188 face_id = (row)->glyphs[area][START].face_id; \
25190 s = alloca (sizeof *s); \
25191 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25192 append_glyph_string (&HEAD, &TAIL, s); \
25194 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25200 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25201 of AREA of glyph row ROW on window W between indices START and END.
25202 HL overrides the face for drawing glyph strings, e.g. it is
25203 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25204 x-positions of the drawing area.
25206 This is an ugly monster macro construct because we must use alloca
25207 to allocate glyph strings (because draw_glyphs can be called
25208 asynchronously). */
25210 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25213 HEAD = TAIL = NULL; \
25214 while (START < END) \
25216 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25217 switch (first_glyph->type) \
25220 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25224 case COMPOSITE_GLYPH: \
25225 if (first_glyph->u.cmp.automatic) \
25226 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25229 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25233 case STRETCH_GLYPH: \
25234 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25238 case IMAGE_GLYPH: \
25239 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25243 case GLYPHLESS_GLYPH: \
25244 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25254 set_glyph_string_background_width (s, START, LAST_X); \
25261 /* Draw glyphs between START and END in AREA of ROW on window W,
25262 starting at x-position X. X is relative to AREA in W. HL is a
25263 face-override with the following meaning:
25265 DRAW_NORMAL_TEXT draw normally
25266 DRAW_CURSOR draw in cursor face
25267 DRAW_MOUSE_FACE draw in mouse face.
25268 DRAW_INVERSE_VIDEO draw in mode line face
25269 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25270 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25272 If OVERLAPS is non-zero, draw only the foreground of characters and
25273 clip to the physical height of ROW. Non-zero value also defines
25274 the overlapping part to be drawn:
25276 OVERLAPS_PRED overlap with preceding rows
25277 OVERLAPS_SUCC overlap with succeeding rows
25278 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25279 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25281 Value is the x-position reached, relative to AREA of W. */
25284 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25285 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25286 enum draw_glyphs_face hl
, int overlaps
)
25288 struct glyph_string
*head
, *tail
;
25289 struct glyph_string
*s
;
25290 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25291 int i
, j
, x_reached
, last_x
, area_left
= 0;
25292 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25295 ALLOCATE_HDC (hdc
, f
);
25297 /* Let's rather be paranoid than getting a SEGV. */
25298 end
= min (end
, row
->used
[area
]);
25299 start
= clip_to_bounds (0, start
, end
);
25301 /* Translate X to frame coordinates. Set last_x to the right
25302 end of the drawing area. */
25303 if (row
->full_width_p
)
25305 /* X is relative to the left edge of W, without scroll bars
25307 area_left
= WINDOW_LEFT_EDGE_X (w
);
25308 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25309 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25313 area_left
= window_box_left (w
, area
);
25314 last_x
= area_left
+ window_box_width (w
, area
);
25318 /* Build a doubly-linked list of glyph_string structures between
25319 head and tail from what we have to draw. Note that the macro
25320 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25321 the reason we use a separate variable `i'. */
25324 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25326 x_reached
= tail
->x
+ tail
->background_width
;
25330 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25331 the row, redraw some glyphs in front or following the glyph
25332 strings built above. */
25333 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25335 struct glyph_string
*h
, *t
;
25336 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25337 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25338 bool check_mouse_face
= false;
25341 /* If mouse highlighting is on, we may need to draw adjacent
25342 glyphs using mouse-face highlighting. */
25343 if (area
== TEXT_AREA
&& row
->mouse_face_p
25344 && hlinfo
->mouse_face_beg_row
>= 0
25345 && hlinfo
->mouse_face_end_row
>= 0)
25347 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25349 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25350 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25352 check_mouse_face
= true;
25353 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25354 ? hlinfo
->mouse_face_beg_col
: 0;
25355 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25356 ? hlinfo
->mouse_face_end_col
25357 : row
->used
[TEXT_AREA
];
25361 /* Compute overhangs for all glyph strings. */
25362 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25363 for (s
= head
; s
; s
= s
->next
)
25364 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25366 /* Prepend glyph strings for glyphs in front of the first glyph
25367 string that are overwritten because of the first glyph
25368 string's left overhang. The background of all strings
25369 prepended must be drawn because the first glyph string
25371 i
= left_overwritten (head
);
25374 enum draw_glyphs_face overlap_hl
;
25376 /* If this row contains mouse highlighting, attempt to draw
25377 the overlapped glyphs with the correct highlight. This
25378 code fails if the overlap encompasses more than one glyph
25379 and mouse-highlight spans only some of these glyphs.
25380 However, making it work perfectly involves a lot more
25381 code, and I don't know if the pathological case occurs in
25382 practice, so we'll stick to this for now. --- cyd */
25383 if (check_mouse_face
25384 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25385 overlap_hl
= DRAW_MOUSE_FACE
;
25387 overlap_hl
= DRAW_NORMAL_TEXT
;
25389 if (hl
!= overlap_hl
)
25392 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25393 overlap_hl
, dummy_x
, last_x
);
25395 compute_overhangs_and_x (t
, head
->x
, true);
25396 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25397 if (clip_head
== NULL
)
25401 /* Prepend glyph strings for glyphs in front of the first glyph
25402 string that overwrite that glyph string because of their
25403 right overhang. For these strings, only the foreground must
25404 be drawn, because it draws over the glyph string at `head'.
25405 The background must not be drawn because this would overwrite
25406 right overhangs of preceding glyphs for which no glyph
25408 i
= left_overwriting (head
);
25411 enum draw_glyphs_face overlap_hl
;
25413 if (check_mouse_face
25414 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25415 overlap_hl
= DRAW_MOUSE_FACE
;
25417 overlap_hl
= DRAW_NORMAL_TEXT
;
25419 if (hl
== overlap_hl
|| clip_head
== NULL
)
25421 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25422 overlap_hl
, dummy_x
, last_x
);
25423 for (s
= h
; s
; s
= s
->next
)
25424 s
->background_filled_p
= true;
25425 compute_overhangs_and_x (t
, head
->x
, true);
25426 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25429 /* Append glyphs strings for glyphs following the last glyph
25430 string tail that are overwritten by tail. The background of
25431 these strings has to be drawn because tail's foreground draws
25433 i
= right_overwritten (tail
);
25436 enum draw_glyphs_face overlap_hl
;
25438 if (check_mouse_face
25439 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25440 overlap_hl
= DRAW_MOUSE_FACE
;
25442 overlap_hl
= DRAW_NORMAL_TEXT
;
25444 if (hl
!= overlap_hl
)
25446 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25447 overlap_hl
, x
, last_x
);
25448 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25449 we don't have `end = i;' here. */
25450 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25451 append_glyph_string_lists (&head
, &tail
, h
, t
);
25452 if (clip_tail
== NULL
)
25456 /* Append glyph strings for glyphs following the last glyph
25457 string tail that overwrite tail. The foreground of such
25458 glyphs has to be drawn because it writes into the background
25459 of tail. The background must not be drawn because it could
25460 paint over the foreground of following glyphs. */
25461 i
= right_overwriting (tail
);
25464 enum draw_glyphs_face overlap_hl
;
25465 if (check_mouse_face
25466 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25467 overlap_hl
= DRAW_MOUSE_FACE
;
25469 overlap_hl
= DRAW_NORMAL_TEXT
;
25471 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25473 i
++; /* We must include the Ith glyph. */
25474 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25475 overlap_hl
, x
, last_x
);
25476 for (s
= h
; s
; s
= s
->next
)
25477 s
->background_filled_p
= true;
25478 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25479 append_glyph_string_lists (&head
, &tail
, h
, t
);
25481 if (clip_head
|| clip_tail
)
25482 for (s
= head
; s
; s
= s
->next
)
25484 s
->clip_head
= clip_head
;
25485 s
->clip_tail
= clip_tail
;
25489 /* Draw all strings. */
25490 for (s
= head
; s
; s
= s
->next
)
25491 FRAME_RIF (f
)->draw_glyph_string (s
);
25494 /* When focus a sole frame and move horizontally, this clears on_p
25495 causing a failure to erase prev cursor position. */
25496 if (area
== TEXT_AREA
25497 && !row
->full_width_p
25498 /* When drawing overlapping rows, only the glyph strings'
25499 foreground is drawn, which doesn't erase a cursor
25503 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25504 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25505 : (tail
? tail
->x
+ tail
->background_width
: x
));
25509 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25510 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25514 /* Value is the x-position up to which drawn, relative to AREA of W.
25515 This doesn't include parts drawn because of overhangs. */
25516 if (row
->full_width_p
)
25517 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25519 x_reached
-= area_left
;
25521 RELEASE_HDC (hdc
, f
);
25527 /* Expand row matrix if too narrow. Don't expand if area
25530 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25532 if (!it->f->fonts_changed \
25533 && (it->glyph_row->glyphs[area] \
25534 < it->glyph_row->glyphs[area + 1])) \
25536 it->w->ncols_scale_factor++; \
25537 it->f->fonts_changed = true; \
25541 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25542 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25545 append_glyph (struct it
*it
)
25547 struct glyph
*glyph
;
25548 enum glyph_row_area area
= it
->area
;
25550 eassert (it
->glyph_row
);
25551 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25553 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25554 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25556 /* If the glyph row is reversed, we need to prepend the glyph
25557 rather than append it. */
25558 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25562 /* Make room for the additional glyph. */
25563 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25565 glyph
= it
->glyph_row
->glyphs
[area
];
25567 glyph
->charpos
= CHARPOS (it
->position
);
25568 glyph
->object
= it
->object
;
25569 if (it
->pixel_width
> 0)
25571 glyph
->pixel_width
= it
->pixel_width
;
25572 glyph
->padding_p
= false;
25576 /* Assure at least 1-pixel width. Otherwise, cursor can't
25577 be displayed correctly. */
25578 glyph
->pixel_width
= 1;
25579 glyph
->padding_p
= true;
25581 glyph
->ascent
= it
->ascent
;
25582 glyph
->descent
= it
->descent
;
25583 glyph
->voffset
= it
->voffset
;
25584 glyph
->type
= CHAR_GLYPH
;
25585 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25586 glyph
->multibyte_p
= it
->multibyte_p
;
25587 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25589 /* In R2L rows, the left and the right box edges need to be
25590 drawn in reverse direction. */
25591 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25592 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25596 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25597 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25599 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25600 || it
->phys_descent
> it
->descent
);
25601 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25602 glyph
->face_id
= it
->face_id
;
25603 glyph
->u
.ch
= it
->char_to_display
;
25604 glyph
->slice
.img
= null_glyph_slice
;
25605 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25608 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25609 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25610 glyph
->bidi_type
= it
->bidi_it
.type
;
25614 glyph
->resolved_level
= 0;
25615 glyph
->bidi_type
= UNKNOWN_BT
;
25617 ++it
->glyph_row
->used
[area
];
25620 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25623 /* Store one glyph for the composition IT->cmp_it.id in
25624 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25628 append_composite_glyph (struct it
*it
)
25630 struct glyph
*glyph
;
25631 enum glyph_row_area area
= it
->area
;
25633 eassert (it
->glyph_row
);
25635 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25636 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25638 /* If the glyph row is reversed, we need to prepend the glyph
25639 rather than append it. */
25640 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25644 /* Make room for the new glyph. */
25645 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25647 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25649 glyph
->charpos
= it
->cmp_it
.charpos
;
25650 glyph
->object
= it
->object
;
25651 glyph
->pixel_width
= it
->pixel_width
;
25652 glyph
->ascent
= it
->ascent
;
25653 glyph
->descent
= it
->descent
;
25654 glyph
->voffset
= it
->voffset
;
25655 glyph
->type
= COMPOSITE_GLYPH
;
25656 if (it
->cmp_it
.ch
< 0)
25658 glyph
->u
.cmp
.automatic
= false;
25659 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25660 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25664 glyph
->u
.cmp
.automatic
= true;
25665 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25666 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25667 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25669 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25670 glyph
->multibyte_p
= it
->multibyte_p
;
25671 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25673 /* In R2L rows, the left and the right box edges need to be
25674 drawn in reverse direction. */
25675 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25676 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25680 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25681 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25683 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25684 || it
->phys_descent
> it
->descent
);
25685 glyph
->padding_p
= false;
25686 glyph
->glyph_not_available_p
= false;
25687 glyph
->face_id
= it
->face_id
;
25688 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25691 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25692 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25693 glyph
->bidi_type
= it
->bidi_it
.type
;
25695 ++it
->glyph_row
->used
[area
];
25698 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25702 /* Change IT->ascent and IT->height according to the setting of
25706 take_vertical_position_into_account (struct it
*it
)
25710 if (it
->voffset
< 0)
25711 /* Increase the ascent so that we can display the text higher
25713 it
->ascent
-= it
->voffset
;
25715 /* Increase the descent so that we can display the text lower
25717 it
->descent
+= it
->voffset
;
25722 /* Produce glyphs/get display metrics for the image IT is loaded with.
25723 See the description of struct display_iterator in dispextern.h for
25724 an overview of struct display_iterator. */
25727 produce_image_glyph (struct it
*it
)
25731 int glyph_ascent
, crop
;
25732 struct glyph_slice slice
;
25734 eassert (it
->what
== IT_IMAGE
);
25736 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25738 /* Make sure X resources of the face is loaded. */
25739 prepare_face_for_display (it
->f
, face
);
25741 if (it
->image_id
< 0)
25743 /* Fringe bitmap. */
25744 it
->ascent
= it
->phys_ascent
= 0;
25745 it
->descent
= it
->phys_descent
= 0;
25746 it
->pixel_width
= 0;
25751 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25753 /* Make sure X resources of the image is loaded. */
25754 prepare_image_for_display (it
->f
, img
);
25756 slice
.x
= slice
.y
= 0;
25757 slice
.width
= img
->width
;
25758 slice
.height
= img
->height
;
25760 if (INTEGERP (it
->slice
.x
))
25761 slice
.x
= XINT (it
->slice
.x
);
25762 else if (FLOATP (it
->slice
.x
))
25763 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25765 if (INTEGERP (it
->slice
.y
))
25766 slice
.y
= XINT (it
->slice
.y
);
25767 else if (FLOATP (it
->slice
.y
))
25768 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25770 if (INTEGERP (it
->slice
.width
))
25771 slice
.width
= XINT (it
->slice
.width
);
25772 else if (FLOATP (it
->slice
.width
))
25773 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25775 if (INTEGERP (it
->slice
.height
))
25776 slice
.height
= XINT (it
->slice
.height
);
25777 else if (FLOATP (it
->slice
.height
))
25778 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25780 if (slice
.x
>= img
->width
)
25781 slice
.x
= img
->width
;
25782 if (slice
.y
>= img
->height
)
25783 slice
.y
= img
->height
;
25784 if (slice
.x
+ slice
.width
>= img
->width
)
25785 slice
.width
= img
->width
- slice
.x
;
25786 if (slice
.y
+ slice
.height
> img
->height
)
25787 slice
.height
= img
->height
- slice
.y
;
25789 if (slice
.width
== 0 || slice
.height
== 0)
25792 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25794 it
->descent
= slice
.height
- glyph_ascent
;
25796 it
->descent
+= img
->vmargin
;
25797 if (slice
.y
+ slice
.height
== img
->height
)
25798 it
->descent
+= img
->vmargin
;
25799 it
->phys_descent
= it
->descent
;
25801 it
->pixel_width
= slice
.width
;
25803 it
->pixel_width
+= img
->hmargin
;
25804 if (slice
.x
+ slice
.width
== img
->width
)
25805 it
->pixel_width
+= img
->hmargin
;
25807 /* It's quite possible for images to have an ascent greater than
25808 their height, so don't get confused in that case. */
25809 if (it
->descent
< 0)
25814 if (face
->box
!= FACE_NO_BOX
)
25816 if (face
->box_line_width
> 0)
25819 it
->ascent
+= face
->box_line_width
;
25820 if (slice
.y
+ slice
.height
== img
->height
)
25821 it
->descent
+= face
->box_line_width
;
25824 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25825 it
->pixel_width
+= eabs (face
->box_line_width
);
25826 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25827 it
->pixel_width
+= eabs (face
->box_line_width
);
25830 take_vertical_position_into_account (it
);
25832 /* Automatically crop wide image glyphs at right edge so we can
25833 draw the cursor on same display row. */
25834 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25835 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25837 it
->pixel_width
-= crop
;
25838 slice
.width
-= crop
;
25843 struct glyph
*glyph
;
25844 enum glyph_row_area area
= it
->area
;
25846 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25847 if (it
->glyph_row
->reversed_p
)
25851 /* Make room for the new glyph. */
25852 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25854 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25856 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25858 glyph
->charpos
= CHARPOS (it
->position
);
25859 glyph
->object
= it
->object
;
25860 glyph
->pixel_width
= it
->pixel_width
;
25861 glyph
->ascent
= glyph_ascent
;
25862 glyph
->descent
= it
->descent
;
25863 glyph
->voffset
= it
->voffset
;
25864 glyph
->type
= IMAGE_GLYPH
;
25865 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25866 glyph
->multibyte_p
= it
->multibyte_p
;
25867 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25869 /* In R2L rows, the left and the right box edges need to be
25870 drawn in reverse direction. */
25871 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25872 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25876 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25877 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25879 glyph
->overlaps_vertically_p
= false;
25880 glyph
->padding_p
= false;
25881 glyph
->glyph_not_available_p
= false;
25882 glyph
->face_id
= it
->face_id
;
25883 glyph
->u
.img_id
= img
->id
;
25884 glyph
->slice
.img
= slice
;
25885 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25888 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25889 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25890 glyph
->bidi_type
= it
->bidi_it
.type
;
25892 ++it
->glyph_row
->used
[area
];
25895 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25900 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25901 of the glyph, WIDTH and HEIGHT are the width and height of the
25902 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25905 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25906 int width
, int height
, int ascent
)
25908 struct glyph
*glyph
;
25909 enum glyph_row_area area
= it
->area
;
25911 eassert (ascent
>= 0 && ascent
<= height
);
25913 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25914 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25916 /* If the glyph row is reversed, we need to prepend the glyph
25917 rather than append it. */
25918 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25922 /* Make room for the additional glyph. */
25923 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25925 glyph
= it
->glyph_row
->glyphs
[area
];
25927 /* Decrease the width of the first glyph of the row that
25928 begins before first_visible_x (e.g., due to hscroll).
25929 This is so the overall width of the row becomes smaller
25930 by the scroll amount, and the stretch glyph appended by
25931 extend_face_to_end_of_line will be wider, to shift the
25932 row glyphs to the right. (In L2R rows, the corresponding
25933 left-shift effect is accomplished by setting row->x to a
25934 negative value, which won't work with R2L rows.)
25936 This must leave us with a positive value of WIDTH, since
25937 otherwise the call to move_it_in_display_line_to at the
25938 beginning of display_line would have got past the entire
25939 first glyph, and then it->current_x would have been
25940 greater or equal to it->first_visible_x. */
25941 if (it
->current_x
< it
->first_visible_x
)
25942 width
-= it
->first_visible_x
- it
->current_x
;
25943 eassert (width
> 0);
25945 glyph
->charpos
= CHARPOS (it
->position
);
25946 glyph
->object
= object
;
25947 glyph
->pixel_width
= width
;
25948 glyph
->ascent
= ascent
;
25949 glyph
->descent
= height
- ascent
;
25950 glyph
->voffset
= it
->voffset
;
25951 glyph
->type
= STRETCH_GLYPH
;
25952 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25953 glyph
->multibyte_p
= it
->multibyte_p
;
25954 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25956 /* In R2L rows, the left and the right box edges need to be
25957 drawn in reverse direction. */
25958 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25959 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25963 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25964 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25966 glyph
->overlaps_vertically_p
= false;
25967 glyph
->padding_p
= false;
25968 glyph
->glyph_not_available_p
= false;
25969 glyph
->face_id
= it
->face_id
;
25970 glyph
->u
.stretch
.ascent
= ascent
;
25971 glyph
->u
.stretch
.height
= height
;
25972 glyph
->slice
.img
= null_glyph_slice
;
25973 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25976 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25977 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25978 glyph
->bidi_type
= it
->bidi_it
.type
;
25982 glyph
->resolved_level
= 0;
25983 glyph
->bidi_type
= UNKNOWN_BT
;
25985 ++it
->glyph_row
->used
[area
];
25988 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25991 #endif /* HAVE_WINDOW_SYSTEM */
25993 /* Produce a stretch glyph for iterator IT. IT->object is the value
25994 of the glyph property displayed. The value must be a list
25995 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25998 1. `:width WIDTH' specifies that the space should be WIDTH *
25999 canonical char width wide. WIDTH may be an integer or floating
26002 2. `:relative-width FACTOR' specifies that the width of the stretch
26003 should be computed from the width of the first character having the
26004 `glyph' property, and should be FACTOR times that width.
26006 3. `:align-to HPOS' specifies that the space should be wide enough
26007 to reach HPOS, a value in canonical character units.
26009 Exactly one of the above pairs must be present.
26011 4. `:height HEIGHT' specifies that the height of the stretch produced
26012 should be HEIGHT, measured in canonical character units.
26014 5. `:relative-height FACTOR' specifies that the height of the
26015 stretch should be FACTOR times the height of the characters having
26016 the glyph property.
26018 Either none or exactly one of 4 or 5 must be present.
26020 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26021 of the stretch should be used for the ascent of the stretch.
26022 ASCENT must be in the range 0 <= ASCENT <= 100. */
26025 produce_stretch_glyph (struct it
*it
)
26027 /* (space :width WIDTH :height HEIGHT ...) */
26028 Lisp_Object prop
, plist
;
26029 int width
= 0, height
= 0, align_to
= -1;
26030 bool zero_width_ok_p
= false;
26032 struct font
*font
= NULL
;
26034 #ifdef HAVE_WINDOW_SYSTEM
26036 bool zero_height_ok_p
= false;
26038 if (FRAME_WINDOW_P (it
->f
))
26040 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26041 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26042 prepare_face_for_display (it
->f
, face
);
26046 /* List should start with `space'. */
26047 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26048 plist
= XCDR (it
->object
);
26050 /* Compute the width of the stretch. */
26051 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26052 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26054 /* Absolute width `:width WIDTH' specified and valid. */
26055 zero_width_ok_p
= true;
26058 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26060 /* Relative width `:relative-width FACTOR' specified and valid.
26061 Compute the width of the characters having the `glyph'
26064 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26067 if (it
->multibyte_p
)
26068 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26071 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26072 if (! ASCII_CHAR_P (it2
.c
))
26073 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26076 it2
.glyph_row
= NULL
;
26077 it2
.what
= IT_CHARACTER
;
26078 PRODUCE_GLYPHS (&it2
);
26079 width
= NUMVAL (prop
) * it2
.pixel_width
;
26081 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26082 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26085 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26086 align_to
= (align_to
< 0
26088 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26089 else if (align_to
< 0)
26090 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26091 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26092 zero_width_ok_p
= true;
26095 /* Nothing specified -> width defaults to canonical char width. */
26096 width
= FRAME_COLUMN_WIDTH (it
->f
);
26098 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26101 #ifdef HAVE_WINDOW_SYSTEM
26102 /* Compute height. */
26103 if (FRAME_WINDOW_P (it
->f
))
26105 int default_height
= normal_char_height (font
, ' ');
26107 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26108 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26111 zero_height_ok_p
= true;
26113 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26115 height
= default_height
* NUMVAL (prop
);
26117 height
= default_height
;
26119 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26122 /* Compute percentage of height used for ascent. If
26123 `:ascent ASCENT' is present and valid, use that. Otherwise,
26124 derive the ascent from the font in use. */
26125 if (prop
= Fplist_get (plist
, QCascent
),
26126 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26127 ascent
= height
* NUMVAL (prop
) / 100.0;
26128 else if (!NILP (prop
)
26129 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26130 ascent
= min (max (0, (int)tem
), height
);
26132 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26135 #endif /* HAVE_WINDOW_SYSTEM */
26138 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26139 && it
->current_x
+ width
> it
->last_visible_x
)
26141 width
= it
->last_visible_x
- it
->current_x
;
26142 #ifdef HAVE_WINDOW_SYSTEM
26143 /* Subtract one more pixel from the stretch width, but only on
26144 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26145 width
-= FRAME_WINDOW_P (it
->f
);
26149 if (width
> 0 && height
> 0 && it
->glyph_row
)
26151 Lisp_Object o_object
= it
->object
;
26152 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26155 if (!STRINGP (object
))
26156 object
= it
->w
->contents
;
26157 #ifdef HAVE_WINDOW_SYSTEM
26158 if (FRAME_WINDOW_P (it
->f
))
26159 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26163 it
->object
= object
;
26164 it
->char_to_display
= ' ';
26165 it
->pixel_width
= it
->len
= 1;
26167 tty_append_glyph (it
);
26168 it
->object
= o_object
;
26172 it
->pixel_width
= width
;
26173 #ifdef HAVE_WINDOW_SYSTEM
26174 if (FRAME_WINDOW_P (it
->f
))
26176 it
->ascent
= it
->phys_ascent
= ascent
;
26177 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26178 it
->nglyphs
= width
> 0 && height
> 0;
26179 take_vertical_position_into_account (it
);
26183 it
->nglyphs
= width
;
26186 /* Get information about special display element WHAT in an
26187 environment described by IT. WHAT is one of IT_TRUNCATION or
26188 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26189 non-null glyph_row member. This function ensures that fields like
26190 face_id, c, len of IT are left untouched. */
26193 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26200 temp_it
.object
= Qnil
;
26201 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26203 if (what
== IT_CONTINUATION
)
26205 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26206 if (it
->bidi_it
.paragraph_dir
== R2L
)
26207 SET_GLYPH_FROM_CHAR (glyph
, '/');
26209 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26211 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26213 /* FIXME: Should we mirror GC for R2L lines? */
26214 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26215 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26218 else if (what
== IT_TRUNCATION
)
26220 /* Truncation glyph. */
26221 SET_GLYPH_FROM_CHAR (glyph
, '$');
26223 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26225 /* FIXME: Should we mirror GC for R2L lines? */
26226 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26227 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26233 #ifdef HAVE_WINDOW_SYSTEM
26234 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26235 is turned off, we precede the truncation/continuation glyphs by a
26236 stretch glyph whose width is computed such that these special
26237 glyphs are aligned at the window margin, even when very different
26238 fonts are used in different glyph rows. */
26239 if (FRAME_WINDOW_P (temp_it
.f
)
26240 /* init_iterator calls this with it->glyph_row == NULL, and it
26241 wants only the pixel width of the truncation/continuation
26243 && temp_it
.glyph_row
26244 /* insert_left_trunc_glyphs calls us at the beginning of the
26245 row, and it has its own calculation of the stretch glyph
26247 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26248 && (temp_it
.glyph_row
->reversed_p
26249 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26250 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26252 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26254 if (stretch_width
> 0)
26256 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26257 struct font
*font
=
26258 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26259 int stretch_ascent
=
26260 (((temp_it
.ascent
+ temp_it
.descent
)
26261 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26263 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26264 temp_it
.ascent
+ temp_it
.descent
,
26271 temp_it
.what
= IT_CHARACTER
;
26272 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26273 temp_it
.face_id
= GLYPH_FACE (glyph
);
26274 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26276 PRODUCE_GLYPHS (&temp_it
);
26277 it
->pixel_width
= temp_it
.pixel_width
;
26278 it
->nglyphs
= temp_it
.nglyphs
;
26281 #ifdef HAVE_WINDOW_SYSTEM
26283 /* Calculate line-height and line-spacing properties.
26284 An integer value specifies explicit pixel value.
26285 A float value specifies relative value to current face height.
26286 A cons (float . face-name) specifies relative value to
26287 height of specified face font.
26289 Returns height in pixels, or nil. */
26292 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26293 int boff
, bool override
)
26295 Lisp_Object face_name
= Qnil
;
26296 int ascent
, descent
, height
;
26298 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26303 face_name
= XCAR (val
);
26305 if (!NUMBERP (val
))
26306 val
= make_number (1);
26307 if (NILP (face_name
))
26309 height
= it
->ascent
+ it
->descent
;
26314 if (NILP (face_name
))
26316 font
= FRAME_FONT (it
->f
);
26317 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26319 else if (EQ (face_name
, Qt
))
26328 face_id
= lookup_named_face (it
->f
, face_name
, false);
26330 return make_number (-1);
26332 face
= FACE_FROM_ID (it
->f
, face_id
);
26335 return make_number (-1);
26336 boff
= font
->baseline_offset
;
26337 if (font
->vertical_centering
)
26338 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26341 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26345 it
->override_ascent
= ascent
;
26346 it
->override_descent
= descent
;
26347 it
->override_boff
= boff
;
26350 height
= ascent
+ descent
;
26354 height
= (int)(XFLOAT_DATA (val
) * height
);
26355 else if (INTEGERP (val
))
26356 height
*= XINT (val
);
26358 return make_number (height
);
26362 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26363 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26364 and only if this is for a character for which no font was found.
26366 If the display method (it->glyphless_method) is
26367 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26368 length of the acronym or the hexadecimal string, UPPER_XOFF and
26369 UPPER_YOFF are pixel offsets for the upper part of the string,
26370 LOWER_XOFF and LOWER_YOFF are for the lower part.
26372 For the other display methods, LEN through LOWER_YOFF are zero. */
26375 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26376 short upper_xoff
, short upper_yoff
,
26377 short lower_xoff
, short lower_yoff
)
26379 struct glyph
*glyph
;
26380 enum glyph_row_area area
= it
->area
;
26382 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26383 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26385 /* If the glyph row is reversed, we need to prepend the glyph
26386 rather than append it. */
26387 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26391 /* Make room for the additional glyph. */
26392 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26394 glyph
= it
->glyph_row
->glyphs
[area
];
26396 glyph
->charpos
= CHARPOS (it
->position
);
26397 glyph
->object
= it
->object
;
26398 glyph
->pixel_width
= it
->pixel_width
;
26399 glyph
->ascent
= it
->ascent
;
26400 glyph
->descent
= it
->descent
;
26401 glyph
->voffset
= it
->voffset
;
26402 glyph
->type
= GLYPHLESS_GLYPH
;
26403 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26404 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26405 glyph
->u
.glyphless
.len
= len
;
26406 glyph
->u
.glyphless
.ch
= it
->c
;
26407 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26408 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26409 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26410 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26411 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26412 glyph
->multibyte_p
= it
->multibyte_p
;
26413 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26415 /* In R2L rows, the left and the right box edges need to be
26416 drawn in reverse direction. */
26417 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26418 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26422 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26423 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26425 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26426 || it
->phys_descent
> it
->descent
);
26427 glyph
->padding_p
= false;
26428 glyph
->glyph_not_available_p
= false;
26429 glyph
->face_id
= face_id
;
26430 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26433 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26434 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26435 glyph
->bidi_type
= it
->bidi_it
.type
;
26437 ++it
->glyph_row
->used
[area
];
26440 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26444 /* Produce a glyph for a glyphless character for iterator IT.
26445 IT->glyphless_method specifies which method to use for displaying
26446 the character. See the description of enum
26447 glyphless_display_method in dispextern.h for the detail.
26449 FOR_NO_FONT is true if and only if this is for a character for
26450 which no font was found. ACRONYM, if non-nil, is an acronym string
26451 for the character. */
26454 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26459 int base_width
, base_height
, width
, height
;
26460 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26463 /* Get the metrics of the base font. We always refer to the current
26465 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26466 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26467 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26468 it
->ascent
+= font
->baseline_offset
;
26469 it
->descent
-= font
->baseline_offset
;
26470 base_height
= it
->ascent
+ it
->descent
;
26471 base_width
= font
->average_width
;
26473 face_id
= merge_glyphless_glyph_face (it
);
26475 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26477 it
->pixel_width
= THIN_SPACE_WIDTH
;
26479 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26481 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26483 width
= CHAR_WIDTH (it
->c
);
26486 else if (width
> 4)
26488 it
->pixel_width
= base_width
* width
;
26490 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26496 unsigned int code
[6];
26498 int ascent
, descent
;
26499 struct font_metrics metrics_upper
, metrics_lower
;
26501 face
= FACE_FROM_ID (it
->f
, face_id
);
26502 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26503 prepare_face_for_display (it
->f
, face
);
26505 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26507 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26508 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26509 if (CONSP (acronym
))
26510 acronym
= XCAR (acronym
);
26511 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26515 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26516 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26519 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26520 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26521 upper_len
= (len
+ 1) / 2;
26522 font
->driver
->text_extents (font
, code
, upper_len
,
26524 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26529 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26530 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26531 upper_xoff
= upper_yoff
= 2; /* the typical case */
26532 if (base_width
>= width
)
26534 /* Align the upper to the left, the lower to the right. */
26535 it
->pixel_width
= base_width
;
26536 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26540 /* Center the shorter one. */
26541 it
->pixel_width
= width
;
26542 if (metrics_upper
.width
>= metrics_lower
.width
)
26543 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26546 /* FIXME: This code doesn't look right. It formerly was
26547 missing the "lower_xoff = 0;", which couldn't have
26548 been right since it left lower_xoff uninitialized. */
26550 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26554 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26555 top, bottom, and between upper and lower strings. */
26556 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26557 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26558 /* Center vertically.
26559 H:base_height, D:base_descent
26560 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26562 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26563 descent = D - H/2 + h/2;
26564 lower_yoff = descent - 2 - ld;
26565 upper_yoff = lower_yoff - la - 1 - ud; */
26566 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26567 descent
= it
->descent
- (base_height
- height
) / 2;
26568 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26569 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26570 - metrics_upper
.descent
);
26571 /* Don't make the height shorter than the base height. */
26572 if (height
> base_height
)
26574 it
->ascent
= ascent
;
26575 it
->descent
= descent
;
26579 it
->phys_ascent
= it
->ascent
;
26580 it
->phys_descent
= it
->descent
;
26582 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26583 upper_xoff
, upper_yoff
,
26584 lower_xoff
, lower_yoff
);
26586 take_vertical_position_into_account (it
);
26591 Produce glyphs/get display metrics for the display element IT is
26592 loaded with. See the description of struct it in dispextern.h
26593 for an overview of struct it. */
26596 x_produce_glyphs (struct it
*it
)
26598 int extra_line_spacing
= it
->extra_line_spacing
;
26600 it
->glyph_not_available_p
= false;
26602 if (it
->what
== IT_CHARACTER
)
26605 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26606 struct font
*font
= face
->font
;
26607 struct font_metrics
*pcm
= NULL
;
26608 int boff
; /* Baseline offset. */
26612 /* When no suitable font is found, display this character by
26613 the method specified in the first extra slot of
26614 Vglyphless_char_display. */
26615 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26617 eassert (it
->what
== IT_GLYPHLESS
);
26618 produce_glyphless_glyph (it
, true,
26619 STRINGP (acronym
) ? acronym
: Qnil
);
26623 boff
= font
->baseline_offset
;
26624 if (font
->vertical_centering
)
26625 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26627 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26631 if (it
->override_ascent
>= 0)
26633 it
->ascent
= it
->override_ascent
;
26634 it
->descent
= it
->override_descent
;
26635 boff
= it
->override_boff
;
26639 it
->ascent
= FONT_BASE (font
) + boff
;
26640 it
->descent
= FONT_DESCENT (font
) - boff
;
26643 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26645 pcm
= get_per_char_metric (font
, &char2b
);
26646 if (pcm
->width
== 0
26647 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26653 it
->phys_ascent
= pcm
->ascent
+ boff
;
26654 it
->phys_descent
= pcm
->descent
- boff
;
26655 it
->pixel_width
= pcm
->width
;
26656 /* Don't use font-global values for ascent and descent
26657 if they result in an exceedingly large line height. */
26658 if (it
->override_ascent
< 0)
26660 if (FONT_TOO_HIGH (font
))
26662 it
->ascent
= it
->phys_ascent
;
26663 it
->descent
= it
->phys_descent
;
26664 /* These limitations are enforced by an
26665 assertion near the end of this function. */
26666 if (it
->ascent
< 0)
26668 if (it
->descent
< 0)
26675 it
->glyph_not_available_p
= true;
26676 it
->phys_ascent
= it
->ascent
;
26677 it
->phys_descent
= it
->descent
;
26678 it
->pixel_width
= font
->space_width
;
26681 if (it
->constrain_row_ascent_descent_p
)
26683 if (it
->descent
> it
->max_descent
)
26685 it
->ascent
+= it
->descent
- it
->max_descent
;
26686 it
->descent
= it
->max_descent
;
26688 if (it
->ascent
> it
->max_ascent
)
26690 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26691 it
->ascent
= it
->max_ascent
;
26693 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26694 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26695 extra_line_spacing
= 0;
26698 /* If this is a space inside a region of text with
26699 `space-width' property, change its width. */
26701 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26703 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26705 /* If face has a box, add the box thickness to the character
26706 height. If character has a box line to the left and/or
26707 right, add the box line width to the character's width. */
26708 if (face
->box
!= FACE_NO_BOX
)
26710 int thick
= face
->box_line_width
;
26714 it
->ascent
+= thick
;
26715 it
->descent
+= thick
;
26720 if (it
->start_of_box_run_p
)
26721 it
->pixel_width
+= thick
;
26722 if (it
->end_of_box_run_p
)
26723 it
->pixel_width
+= thick
;
26726 /* If face has an overline, add the height of the overline
26727 (1 pixel) and a 1 pixel margin to the character height. */
26728 if (face
->overline_p
)
26729 it
->ascent
+= overline_margin
;
26731 if (it
->constrain_row_ascent_descent_p
)
26733 if (it
->ascent
> it
->max_ascent
)
26734 it
->ascent
= it
->max_ascent
;
26735 if (it
->descent
> it
->max_descent
)
26736 it
->descent
= it
->max_descent
;
26739 take_vertical_position_into_account (it
);
26741 /* If we have to actually produce glyphs, do it. */
26746 /* Translate a space with a `space-width' property
26747 into a stretch glyph. */
26748 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26749 / FONT_HEIGHT (font
));
26750 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26751 it
->ascent
+ it
->descent
, ascent
);
26756 /* If characters with lbearing or rbearing are displayed
26757 in this line, record that fact in a flag of the
26758 glyph row. This is used to optimize X output code. */
26759 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26760 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26762 if (! stretched_p
&& it
->pixel_width
== 0)
26763 /* We assure that all visible glyphs have at least 1-pixel
26765 it
->pixel_width
= 1;
26767 else if (it
->char_to_display
== '\n')
26769 /* A newline has no width, but we need the height of the
26770 line. But if previous part of the line sets a height,
26771 don't increase that height. */
26773 Lisp_Object height
;
26774 Lisp_Object total_height
= Qnil
;
26776 it
->override_ascent
= -1;
26777 it
->pixel_width
= 0;
26780 height
= get_it_property (it
, Qline_height
);
26781 /* Split (line-height total-height) list. */
26783 && CONSP (XCDR (height
))
26784 && NILP (XCDR (XCDR (height
))))
26786 total_height
= XCAR (XCDR (height
));
26787 height
= XCAR (height
);
26789 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26791 if (it
->override_ascent
>= 0)
26793 it
->ascent
= it
->override_ascent
;
26794 it
->descent
= it
->override_descent
;
26795 boff
= it
->override_boff
;
26799 if (FONT_TOO_HIGH (font
))
26801 it
->ascent
= font
->pixel_size
+ boff
- 1;
26802 it
->descent
= -boff
+ 1;
26803 if (it
->descent
< 0)
26808 it
->ascent
= FONT_BASE (font
) + boff
;
26809 it
->descent
= FONT_DESCENT (font
) - boff
;
26813 if (EQ (height
, Qt
))
26815 if (it
->descent
> it
->max_descent
)
26817 it
->ascent
+= it
->descent
- it
->max_descent
;
26818 it
->descent
= it
->max_descent
;
26820 if (it
->ascent
> it
->max_ascent
)
26822 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26823 it
->ascent
= it
->max_ascent
;
26825 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26826 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26827 it
->constrain_row_ascent_descent_p
= true;
26828 extra_line_spacing
= 0;
26832 Lisp_Object spacing
;
26834 it
->phys_ascent
= it
->ascent
;
26835 it
->phys_descent
= it
->descent
;
26837 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26838 && face
->box
!= FACE_NO_BOX
26839 && face
->box_line_width
> 0)
26841 it
->ascent
+= face
->box_line_width
;
26842 it
->descent
+= face
->box_line_width
;
26845 && XINT (height
) > it
->ascent
+ it
->descent
)
26846 it
->ascent
= XINT (height
) - it
->descent
;
26848 if (!NILP (total_height
))
26849 spacing
= calc_line_height_property (it
, total_height
, font
,
26853 spacing
= get_it_property (it
, Qline_spacing
);
26854 spacing
= calc_line_height_property (it
, spacing
, font
,
26857 if (INTEGERP (spacing
))
26859 extra_line_spacing
= XINT (spacing
);
26860 if (!NILP (total_height
))
26861 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26865 else /* i.e. (it->char_to_display == '\t') */
26867 if (font
->space_width
> 0)
26869 int tab_width
= it
->tab_width
* font
->space_width
;
26870 int x
= it
->current_x
+ it
->continuation_lines_width
;
26871 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26873 /* If the distance from the current position to the next tab
26874 stop is less than a space character width, use the
26875 tab stop after that. */
26876 if (next_tab_x
- x
< font
->space_width
)
26877 next_tab_x
+= tab_width
;
26879 it
->pixel_width
= next_tab_x
- x
;
26881 if (FONT_TOO_HIGH (font
))
26883 if (get_char_glyph_code (' ', font
, &char2b
))
26885 pcm
= get_per_char_metric (font
, &char2b
);
26886 if (pcm
->width
== 0
26887 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26893 it
->ascent
= pcm
->ascent
+ boff
;
26894 it
->descent
= pcm
->descent
- boff
;
26898 it
->ascent
= font
->pixel_size
+ boff
- 1;
26899 it
->descent
= -boff
+ 1;
26901 if (it
->ascent
< 0)
26903 if (it
->descent
< 0)
26908 it
->ascent
= FONT_BASE (font
) + boff
;
26909 it
->descent
= FONT_DESCENT (font
) - boff
;
26911 it
->phys_ascent
= it
->ascent
;
26912 it
->phys_descent
= it
->descent
;
26916 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26917 it
->ascent
+ it
->descent
, it
->ascent
);
26922 it
->pixel_width
= 0;
26927 if (FONT_TOO_HIGH (font
))
26929 int font_ascent
, font_descent
;
26931 /* For very large fonts, where we ignore the declared font
26932 dimensions, and go by per-character metrics instead,
26933 don't let the row ascent and descent values (and the row
26934 height computed from them) be smaller than the "normal"
26935 character metrics. This avoids unpleasant effects
26936 whereby lines on display would change their height
26937 depending on which characters are shown. */
26938 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26939 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26940 it
->max_descent
= max (it
->max_descent
, font_descent
);
26943 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26945 /* A static composition.
26947 Note: A composition is represented as one glyph in the
26948 glyph matrix. There are no padding glyphs.
26950 Important note: pixel_width, ascent, and descent are the
26951 values of what is drawn by draw_glyphs (i.e. the values of
26952 the overall glyphs composed). */
26953 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26954 int boff
; /* baseline offset */
26955 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26956 int glyph_len
= cmp
->glyph_len
;
26957 struct font
*font
= face
->font
;
26961 /* If we have not yet calculated pixel size data of glyphs of
26962 the composition for the current face font, calculate them
26963 now. Theoretically, we have to check all fonts for the
26964 glyphs, but that requires much time and memory space. So,
26965 here we check only the font of the first glyph. This may
26966 lead to incorrect display, but it's very rare, and C-l
26967 (recenter-top-bottom) can correct the display anyway. */
26968 if (! cmp
->font
|| cmp
->font
!= font
)
26970 /* Ascent and descent of the font of the first character
26971 of this composition (adjusted by baseline offset).
26972 Ascent and descent of overall glyphs should not be less
26973 than these, respectively. */
26974 int font_ascent
, font_descent
, font_height
;
26975 /* Bounding box of the overall glyphs. */
26976 int leftmost
, rightmost
, lowest
, highest
;
26977 int lbearing
, rbearing
;
26978 int i
, width
, ascent
, descent
;
26979 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26981 struct font_metrics
*pcm
;
26984 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26985 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26987 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26988 for (i
= 0; i
< glyph_len
; i
++)
26990 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26992 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26994 bool left_padded
= i
> 0;
26996 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26997 : IT_CHARPOS (*it
));
26998 /* If no suitable font is found, use the default font. */
26999 bool font_not_found_p
= font
== NULL
;
27000 if (font_not_found_p
)
27002 face
= face
->ascii_face
;
27005 boff
= font
->baseline_offset
;
27006 if (font
->vertical_centering
)
27007 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27008 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27009 font_ascent
+= boff
;
27010 font_descent
-= boff
;
27011 font_height
= font_ascent
+ font_descent
;
27016 if (! font_not_found_p
)
27018 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27020 pcm
= get_per_char_metric (font
, &char2b
);
27023 /* Initialize the bounding box. */
27026 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27027 ascent
= pcm
->ascent
;
27028 descent
= pcm
->descent
;
27029 lbearing
= pcm
->lbearing
;
27030 rbearing
= pcm
->rbearing
;
27034 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27035 ascent
= FONT_BASE (font
);
27036 descent
= FONT_DESCENT (font
);
27043 lowest
= - descent
+ boff
;
27044 highest
= ascent
+ boff
;
27046 if (! font_not_found_p
27047 && font
->default_ascent
27048 && CHAR_TABLE_P (Vuse_default_ascent
)
27049 && !NILP (Faref (Vuse_default_ascent
,
27050 make_number (it
->char_to_display
))))
27051 highest
= font
->default_ascent
+ boff
;
27053 /* Draw the first glyph at the normal position. It may be
27054 shifted to right later if some other glyphs are drawn
27056 cmp
->offsets
[i
* 2] = 0;
27057 cmp
->offsets
[i
* 2 + 1] = boff
;
27058 cmp
->lbearing
= lbearing
;
27059 cmp
->rbearing
= rbearing
;
27061 /* Set cmp->offsets for the remaining glyphs. */
27062 for (i
++; i
< glyph_len
; i
++)
27064 int left
, right
, btm
, top
;
27065 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27067 struct face
*this_face
;
27071 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27072 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27073 font
= this_face
->font
;
27079 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27081 pcm
= get_per_char_metric (font
, &char2b
);
27084 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27087 width
= pcm
->width
;
27088 ascent
= pcm
->ascent
;
27089 descent
= pcm
->descent
;
27090 lbearing
= pcm
->lbearing
;
27091 rbearing
= pcm
->rbearing
;
27092 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27094 /* Relative composition with or without
27095 alternate chars. */
27096 left
= (leftmost
+ rightmost
- width
) / 2;
27097 btm
= - descent
+ boff
;
27098 if (font
->relative_compose
27099 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27100 || NILP (Faref (Vignore_relative_composition
,
27101 make_number (ch
)))))
27104 if (- descent
>= font
->relative_compose
)
27105 /* One extra pixel between two glyphs. */
27107 else if (ascent
<= 0)
27108 /* One extra pixel between two glyphs. */
27109 btm
= lowest
- 1 - ascent
- descent
;
27114 /* A composition rule is specified by an integer
27115 value that encodes global and new reference
27116 points (GREF and NREF). GREF and NREF are
27117 specified by numbers as below:
27119 0---1---2 -- ascent
27123 9--10--11 -- center
27125 ---3---4---5--- baseline
27127 6---7---8 -- descent
27129 int rule
= COMPOSITION_RULE (cmp
, i
);
27130 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27132 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27133 grefx
= gref
% 3, nrefx
= nref
% 3;
27134 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27136 xoff
= font_height
* (xoff
- 128) / 256;
27138 yoff
= font_height
* (yoff
- 128) / 256;
27141 + grefx
* (rightmost
- leftmost
) / 2
27142 - nrefx
* width
/ 2
27145 btm
= ((grefy
== 0 ? highest
27147 : grefy
== 2 ? lowest
27148 : (highest
+ lowest
) / 2)
27149 - (nrefy
== 0 ? ascent
+ descent
27150 : nrefy
== 1 ? descent
- boff
27152 : (ascent
+ descent
) / 2)
27156 cmp
->offsets
[i
* 2] = left
;
27157 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27159 /* Update the bounding box of the overall glyphs. */
27162 right
= left
+ width
;
27163 if (left
< leftmost
)
27165 if (right
> rightmost
)
27168 top
= btm
+ descent
+ ascent
;
27174 if (cmp
->lbearing
> left
+ lbearing
)
27175 cmp
->lbearing
= left
+ lbearing
;
27176 if (cmp
->rbearing
< left
+ rbearing
)
27177 cmp
->rbearing
= left
+ rbearing
;
27181 /* If there are glyphs whose x-offsets are negative,
27182 shift all glyphs to the right and make all x-offsets
27186 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27187 cmp
->offsets
[i
* 2] -= leftmost
;
27188 rightmost
-= leftmost
;
27189 cmp
->lbearing
-= leftmost
;
27190 cmp
->rbearing
-= leftmost
;
27193 if (left_padded
&& cmp
->lbearing
< 0)
27195 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27196 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27197 rightmost
-= cmp
->lbearing
;
27198 cmp
->rbearing
-= cmp
->lbearing
;
27201 if (right_padded
&& rightmost
< cmp
->rbearing
)
27203 rightmost
= cmp
->rbearing
;
27206 cmp
->pixel_width
= rightmost
;
27207 cmp
->ascent
= highest
;
27208 cmp
->descent
= - lowest
;
27209 if (cmp
->ascent
< font_ascent
)
27210 cmp
->ascent
= font_ascent
;
27211 if (cmp
->descent
< font_descent
)
27212 cmp
->descent
= font_descent
;
27216 && (cmp
->lbearing
< 0
27217 || cmp
->rbearing
> cmp
->pixel_width
))
27218 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27220 it
->pixel_width
= cmp
->pixel_width
;
27221 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27222 it
->descent
= it
->phys_descent
= cmp
->descent
;
27223 if (face
->box
!= FACE_NO_BOX
)
27225 int thick
= face
->box_line_width
;
27229 it
->ascent
+= thick
;
27230 it
->descent
+= thick
;
27235 if (it
->start_of_box_run_p
)
27236 it
->pixel_width
+= thick
;
27237 if (it
->end_of_box_run_p
)
27238 it
->pixel_width
+= thick
;
27241 /* If face has an overline, add the height of the overline
27242 (1 pixel) and a 1 pixel margin to the character height. */
27243 if (face
->overline_p
)
27244 it
->ascent
+= overline_margin
;
27246 take_vertical_position_into_account (it
);
27247 if (it
->ascent
< 0)
27249 if (it
->descent
< 0)
27252 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27253 append_composite_glyph (it
);
27255 else if (it
->what
== IT_COMPOSITION
)
27257 /* A dynamic (automatic) composition. */
27258 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27259 Lisp_Object gstring
;
27260 struct font_metrics metrics
;
27264 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27266 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27269 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27270 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27271 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27272 it
->descent
= it
->phys_descent
= metrics
.descent
;
27273 if (face
->box
!= FACE_NO_BOX
)
27275 int thick
= face
->box_line_width
;
27279 it
->ascent
+= thick
;
27280 it
->descent
+= thick
;
27285 if (it
->start_of_box_run_p
)
27286 it
->pixel_width
+= thick
;
27287 if (it
->end_of_box_run_p
)
27288 it
->pixel_width
+= thick
;
27290 /* If face has an overline, add the height of the overline
27291 (1 pixel) and a 1 pixel margin to the character height. */
27292 if (face
->overline_p
)
27293 it
->ascent
+= overline_margin
;
27294 take_vertical_position_into_account (it
);
27295 if (it
->ascent
< 0)
27297 if (it
->descent
< 0)
27301 append_composite_glyph (it
);
27303 else if (it
->what
== IT_GLYPHLESS
)
27304 produce_glyphless_glyph (it
, false, Qnil
);
27305 else if (it
->what
== IT_IMAGE
)
27306 produce_image_glyph (it
);
27307 else if (it
->what
== IT_STRETCH
)
27308 produce_stretch_glyph (it
);
27311 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27312 because this isn't true for images with `:ascent 100'. */
27313 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27314 if (it
->area
== TEXT_AREA
)
27315 it
->current_x
+= it
->pixel_width
;
27317 if (extra_line_spacing
> 0)
27319 it
->descent
+= extra_line_spacing
;
27320 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27321 it
->max_extra_line_spacing
= extra_line_spacing
;
27324 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27325 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27326 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27327 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27331 Output LEN glyphs starting at START at the nominal cursor position.
27332 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27333 being updated, and UPDATED_AREA is the area of that row being updated. */
27336 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27337 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27339 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27341 eassert (updated_row
);
27342 /* When the window is hscrolled, cursor hpos can legitimately be out
27343 of bounds, but we draw the cursor at the corresponding window
27344 margin in that case. */
27345 if (!updated_row
->reversed_p
&& chpos
< 0)
27347 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27348 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27352 /* Write glyphs. */
27354 hpos
= start
- updated_row
->glyphs
[updated_area
];
27355 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27356 updated_row
, updated_area
,
27358 DRAW_NORMAL_TEXT
, 0);
27360 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27361 if (updated_area
== TEXT_AREA
27362 && w
->phys_cursor_on_p
27363 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27365 && chpos
< hpos
+ len
)
27366 w
->phys_cursor_on_p
= false;
27370 /* Advance the output cursor. */
27371 w
->output_cursor
.hpos
+= len
;
27372 w
->output_cursor
.x
= x
;
27377 Insert LEN glyphs from START at the nominal cursor position. */
27380 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27381 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27384 int line_height
, shift_by_width
, shifted_region_width
;
27385 struct glyph_row
*row
;
27386 struct glyph
*glyph
;
27387 int frame_x
, frame_y
;
27390 eassert (updated_row
);
27392 f
= XFRAME (WINDOW_FRAME (w
));
27394 /* Get the height of the line we are in. */
27396 line_height
= row
->height
;
27398 /* Get the width of the glyphs to insert. */
27399 shift_by_width
= 0;
27400 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27401 shift_by_width
+= glyph
->pixel_width
;
27403 /* Get the width of the region to shift right. */
27404 shifted_region_width
= (window_box_width (w
, updated_area
)
27405 - w
->output_cursor
.x
27409 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27410 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27412 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27413 line_height
, shift_by_width
);
27415 /* Write the glyphs. */
27416 hpos
= start
- row
->glyphs
[updated_area
];
27417 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27419 DRAW_NORMAL_TEXT
, 0);
27421 /* Advance the output cursor. */
27422 w
->output_cursor
.hpos
+= len
;
27423 w
->output_cursor
.x
+= shift_by_width
;
27429 Erase the current text line from the nominal cursor position
27430 (inclusive) to pixel column TO_X (exclusive). The idea is that
27431 everything from TO_X onward is already erased.
27433 TO_X is a pixel position relative to UPDATED_AREA of currently
27434 updated window W. TO_X == -1 means clear to the end of this area. */
27437 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27438 enum glyph_row_area updated_area
, int to_x
)
27441 int max_x
, min_y
, max_y
;
27442 int from_x
, from_y
, to_y
;
27444 eassert (updated_row
);
27445 f
= XFRAME (w
->frame
);
27447 if (updated_row
->full_width_p
)
27448 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27449 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27451 max_x
= window_box_width (w
, updated_area
);
27452 max_y
= window_text_bottom_y (w
);
27454 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27455 of window. For TO_X > 0, truncate to end of drawing area. */
27461 to_x
= min (to_x
, max_x
);
27463 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27465 /* Notice if the cursor will be cleared by this operation. */
27466 if (!updated_row
->full_width_p
)
27467 notice_overwritten_cursor (w
, updated_area
,
27468 w
->output_cursor
.x
, -1,
27470 MATRIX_ROW_BOTTOM_Y (updated_row
));
27472 from_x
= w
->output_cursor
.x
;
27474 /* Translate to frame coordinates. */
27475 if (updated_row
->full_width_p
)
27477 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27478 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27482 int area_left
= window_box_left (w
, updated_area
);
27483 from_x
+= area_left
;
27487 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27488 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27489 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27491 /* Prevent inadvertently clearing to end of the X window. */
27492 if (to_x
> from_x
&& to_y
> from_y
)
27495 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27496 to_x
- from_x
, to_y
- from_y
);
27501 #endif /* HAVE_WINDOW_SYSTEM */
27505 /***********************************************************************
27507 ***********************************************************************/
27509 /* Value is the internal representation of the specified cursor type
27510 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27511 of the bar cursor. */
27513 static enum text_cursor_kinds
27514 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27516 enum text_cursor_kinds type
;
27521 if (EQ (arg
, Qbox
))
27522 return FILLED_BOX_CURSOR
;
27524 if (EQ (arg
, Qhollow
))
27525 return HOLLOW_BOX_CURSOR
;
27527 if (EQ (arg
, Qbar
))
27534 && EQ (XCAR (arg
), Qbar
)
27535 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27537 *width
= XINT (XCDR (arg
));
27541 if (EQ (arg
, Qhbar
))
27544 return HBAR_CURSOR
;
27548 && EQ (XCAR (arg
), Qhbar
)
27549 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27551 *width
= XINT (XCDR (arg
));
27552 return HBAR_CURSOR
;
27555 /* Treat anything unknown as "hollow box cursor".
27556 It was bad to signal an error; people have trouble fixing
27557 .Xdefaults with Emacs, when it has something bad in it. */
27558 type
= HOLLOW_BOX_CURSOR
;
27563 /* Set the default cursor types for specified frame. */
27565 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27570 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27571 FRAME_CURSOR_WIDTH (f
) = width
;
27573 /* By default, set up the blink-off state depending on the on-state. */
27575 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27578 FRAME_BLINK_OFF_CURSOR (f
)
27579 = get_specified_cursor_type (XCDR (tem
), &width
);
27580 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27583 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27585 /* Make sure the cursor gets redrawn. */
27586 f
->cursor_type_changed
= true;
27590 #ifdef HAVE_WINDOW_SYSTEM
27592 /* Return the cursor we want to be displayed in window W. Return
27593 width of bar/hbar cursor through WIDTH arg. Return with
27594 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27595 (i.e. if the `system caret' should track this cursor).
27597 In a mini-buffer window, we want the cursor only to appear if we
27598 are reading input from this window. For the selected window, we
27599 want the cursor type given by the frame parameter or buffer local
27600 setting of cursor-type. If explicitly marked off, draw no cursor.
27601 In all other cases, we want a hollow box cursor. */
27603 static enum text_cursor_kinds
27604 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27605 bool *active_cursor
)
27607 struct frame
*f
= XFRAME (w
->frame
);
27608 struct buffer
*b
= XBUFFER (w
->contents
);
27609 int cursor_type
= DEFAULT_CURSOR
;
27610 Lisp_Object alt_cursor
;
27611 bool non_selected
= false;
27613 *active_cursor
= true;
27616 if (cursor_in_echo_area
27617 && FRAME_HAS_MINIBUF_P (f
)
27618 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27620 if (w
== XWINDOW (echo_area_window
))
27622 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27624 *width
= FRAME_CURSOR_WIDTH (f
);
27625 return FRAME_DESIRED_CURSOR (f
);
27628 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27631 *active_cursor
= false;
27632 non_selected
= true;
27635 /* Detect a nonselected window or nonselected frame. */
27636 else if (w
!= XWINDOW (f
->selected_window
)
27637 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27639 *active_cursor
= false;
27641 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27644 non_selected
= true;
27647 /* Never display a cursor in a window in which cursor-type is nil. */
27648 if (NILP (BVAR (b
, cursor_type
)))
27651 /* Get the normal cursor type for this window. */
27652 if (EQ (BVAR (b
, cursor_type
), Qt
))
27654 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27655 *width
= FRAME_CURSOR_WIDTH (f
);
27658 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27660 /* Use cursor-in-non-selected-windows instead
27661 for non-selected window or frame. */
27664 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27665 if (!EQ (Qt
, alt_cursor
))
27666 return get_specified_cursor_type (alt_cursor
, width
);
27667 /* t means modify the normal cursor type. */
27668 if (cursor_type
== FILLED_BOX_CURSOR
)
27669 cursor_type
= HOLLOW_BOX_CURSOR
;
27670 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27672 return cursor_type
;
27675 /* Use normal cursor if not blinked off. */
27676 if (!w
->cursor_off_p
)
27678 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27680 if (cursor_type
== FILLED_BOX_CURSOR
)
27682 /* Using a block cursor on large images can be very annoying.
27683 So use a hollow cursor for "large" images.
27684 If image is not transparent (no mask), also use hollow cursor. */
27685 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27686 if (img
!= NULL
&& IMAGEP (img
->spec
))
27688 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27689 where N = size of default frame font size.
27690 This should cover most of the "tiny" icons people may use. */
27692 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27693 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27694 cursor_type
= HOLLOW_BOX_CURSOR
;
27697 else if (cursor_type
!= NO_CURSOR
)
27699 /* Display current only supports BOX and HOLLOW cursors for images.
27700 So for now, unconditionally use a HOLLOW cursor when cursor is
27701 not a solid box cursor. */
27702 cursor_type
= HOLLOW_BOX_CURSOR
;
27705 return cursor_type
;
27708 /* Cursor is blinked off, so determine how to "toggle" it. */
27710 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27711 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27712 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27714 /* Then see if frame has specified a specific blink off cursor type. */
27715 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27717 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27718 return FRAME_BLINK_OFF_CURSOR (f
);
27722 /* Some people liked having a permanently visible blinking cursor,
27723 while others had very strong opinions against it. So it was
27724 decided to remove it. KFS 2003-09-03 */
27726 /* Finally perform built-in cursor blinking:
27727 filled box <-> hollow box
27728 wide [h]bar <-> narrow [h]bar
27729 narrow [h]bar <-> no cursor
27730 other type <-> no cursor */
27732 if (cursor_type
== FILLED_BOX_CURSOR
)
27733 return HOLLOW_BOX_CURSOR
;
27735 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27738 return cursor_type
;
27746 /* Notice when the text cursor of window W has been completely
27747 overwritten by a drawing operation that outputs glyphs in AREA
27748 starting at X0 and ending at X1 in the line starting at Y0 and
27749 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27750 the rest of the line after X0 has been written. Y coordinates
27751 are window-relative. */
27754 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27755 int x0
, int x1
, int y0
, int y1
)
27757 int cx0
, cx1
, cy0
, cy1
;
27758 struct glyph_row
*row
;
27760 if (!w
->phys_cursor_on_p
)
27762 if (area
!= TEXT_AREA
)
27765 if (w
->phys_cursor
.vpos
< 0
27766 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27767 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27768 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27771 if (row
->cursor_in_fringe_p
)
27773 row
->cursor_in_fringe_p
= false;
27774 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27775 w
->phys_cursor_on_p
= false;
27779 cx0
= w
->phys_cursor
.x
;
27780 cx1
= cx0
+ w
->phys_cursor_width
;
27781 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27784 /* The cursor image will be completely removed from the
27785 screen if the output area intersects the cursor area in
27786 y-direction. When we draw in [y0 y1[, and some part of
27787 the cursor is at y < y0, that part must have been drawn
27788 before. When scrolling, the cursor is erased before
27789 actually scrolling, so we don't come here. When not
27790 scrolling, the rows above the old cursor row must have
27791 changed, and in this case these rows must have written
27792 over the cursor image.
27794 Likewise if part of the cursor is below y1, with the
27795 exception of the cursor being in the first blank row at
27796 the buffer and window end because update_text_area
27797 doesn't draw that row. (Except when it does, but
27798 that's handled in update_text_area.) */
27800 cy0
= w
->phys_cursor
.y
;
27801 cy1
= cy0
+ w
->phys_cursor_height
;
27802 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27805 w
->phys_cursor_on_p
= false;
27808 #endif /* HAVE_WINDOW_SYSTEM */
27811 /************************************************************************
27813 ************************************************************************/
27815 #ifdef HAVE_WINDOW_SYSTEM
27818 Fix the display of area AREA of overlapping row ROW in window W
27819 with respect to the overlapping part OVERLAPS. */
27822 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27823 enum glyph_row_area area
, int overlaps
)
27830 for (i
= 0; i
< row
->used
[area
];)
27832 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27834 int start
= i
, start_x
= x
;
27838 x
+= row
->glyphs
[area
][i
].pixel_width
;
27841 while (i
< row
->used
[area
]
27842 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27844 draw_glyphs (w
, start_x
, row
, area
,
27846 DRAW_NORMAL_TEXT
, overlaps
);
27850 x
+= row
->glyphs
[area
][i
].pixel_width
;
27860 Draw the cursor glyph of window W in glyph row ROW. See the
27861 comment of draw_glyphs for the meaning of HL. */
27864 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27865 enum draw_glyphs_face hl
)
27867 /* If cursor hpos is out of bounds, don't draw garbage. This can
27868 happen in mini-buffer windows when switching between echo area
27869 glyphs and mini-buffer. */
27870 if ((row
->reversed_p
27871 ? (w
->phys_cursor
.hpos
>= 0)
27872 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27874 bool on_p
= w
->phys_cursor_on_p
;
27876 int hpos
= w
->phys_cursor
.hpos
;
27878 /* When the window is hscrolled, cursor hpos can legitimately be
27879 out of bounds, but we draw the cursor at the corresponding
27880 window margin in that case. */
27881 if (!row
->reversed_p
&& hpos
< 0)
27883 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27884 hpos
= row
->used
[TEXT_AREA
] - 1;
27886 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27888 w
->phys_cursor_on_p
= on_p
;
27890 if (hl
== DRAW_CURSOR
)
27891 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27892 /* When we erase the cursor, and ROW is overlapped by other
27893 rows, make sure that these overlapping parts of other rows
27895 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27897 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27899 if (row
> w
->current_matrix
->rows
27900 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27901 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27902 OVERLAPS_ERASED_CURSOR
);
27904 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27905 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27906 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27907 OVERLAPS_ERASED_CURSOR
);
27913 /* Erase the image of a cursor of window W from the screen. */
27916 erase_phys_cursor (struct window
*w
)
27918 struct frame
*f
= XFRAME (w
->frame
);
27919 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27920 int hpos
= w
->phys_cursor
.hpos
;
27921 int vpos
= w
->phys_cursor
.vpos
;
27922 bool mouse_face_here_p
= false;
27923 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27924 struct glyph_row
*cursor_row
;
27925 struct glyph
*cursor_glyph
;
27926 enum draw_glyphs_face hl
;
27928 /* No cursor displayed or row invalidated => nothing to do on the
27930 if (w
->phys_cursor_type
== NO_CURSOR
)
27931 goto mark_cursor_off
;
27933 /* VPOS >= active_glyphs->nrows means that window has been resized.
27934 Don't bother to erase the cursor. */
27935 if (vpos
>= active_glyphs
->nrows
)
27936 goto mark_cursor_off
;
27938 /* If row containing cursor is marked invalid, there is nothing we
27940 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27941 if (!cursor_row
->enabled_p
)
27942 goto mark_cursor_off
;
27944 /* If line spacing is > 0, old cursor may only be partially visible in
27945 window after split-window. So adjust visible height. */
27946 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27947 window_text_bottom_y (w
) - cursor_row
->y
);
27949 /* If row is completely invisible, don't attempt to delete a cursor which
27950 isn't there. This can happen if cursor is at top of a window, and
27951 we switch to a buffer with a header line in that window. */
27952 if (cursor_row
->visible_height
<= 0)
27953 goto mark_cursor_off
;
27955 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27956 if (cursor_row
->cursor_in_fringe_p
)
27958 cursor_row
->cursor_in_fringe_p
= false;
27959 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27960 goto mark_cursor_off
;
27963 /* This can happen when the new row is shorter than the old one.
27964 In this case, either draw_glyphs or clear_end_of_line
27965 should have cleared the cursor. Note that we wouldn't be
27966 able to erase the cursor in this case because we don't have a
27967 cursor glyph at hand. */
27968 if ((cursor_row
->reversed_p
27969 ? (w
->phys_cursor
.hpos
< 0)
27970 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27971 goto mark_cursor_off
;
27973 /* When the window is hscrolled, cursor hpos can legitimately be out
27974 of bounds, but we draw the cursor at the corresponding window
27975 margin in that case. */
27976 if (!cursor_row
->reversed_p
&& hpos
< 0)
27978 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27979 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27981 /* If the cursor is in the mouse face area, redisplay that when
27982 we clear the cursor. */
27983 if (! NILP (hlinfo
->mouse_face_window
)
27984 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27985 /* Don't redraw the cursor's spot in mouse face if it is at the
27986 end of a line (on a newline). The cursor appears there, but
27987 mouse highlighting does not. */
27988 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27989 mouse_face_here_p
= true;
27991 /* Maybe clear the display under the cursor. */
27992 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27995 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27998 cursor_glyph
= get_phys_cursor_glyph (w
);
27999 if (cursor_glyph
== NULL
)
28000 goto mark_cursor_off
;
28002 width
= cursor_glyph
->pixel_width
;
28003 x
= w
->phys_cursor
.x
;
28009 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28010 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28011 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28014 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28017 /* Erase the cursor by redrawing the character underneath it. */
28018 if (mouse_face_here_p
)
28019 hl
= DRAW_MOUSE_FACE
;
28021 hl
= DRAW_NORMAL_TEXT
;
28022 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28025 w
->phys_cursor_on_p
= false;
28026 w
->phys_cursor_type
= NO_CURSOR
;
28030 /* Display or clear cursor of window W. If !ON, clear the cursor.
28031 If ON, display the cursor; where to put the cursor is specified by
28032 HPOS, VPOS, X and Y. */
28035 display_and_set_cursor (struct window
*w
, bool on
,
28036 int hpos
, int vpos
, int x
, int y
)
28038 struct frame
*f
= XFRAME (w
->frame
);
28039 int new_cursor_type
;
28040 int new_cursor_width
;
28041 bool active_cursor
;
28042 struct glyph_row
*glyph_row
;
28043 struct glyph
*glyph
;
28045 /* This is pointless on invisible frames, and dangerous on garbaged
28046 windows and frames; in the latter case, the frame or window may
28047 be in the midst of changing its size, and x and y may be off the
28049 if (! FRAME_VISIBLE_P (f
)
28050 || FRAME_GARBAGED_P (f
)
28051 || vpos
>= w
->current_matrix
->nrows
28052 || hpos
>= w
->current_matrix
->matrix_w
)
28055 /* If cursor is off and we want it off, return quickly. */
28056 if (!on
&& !w
->phys_cursor_on_p
)
28059 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28060 /* If cursor row is not enabled, we don't really know where to
28061 display the cursor. */
28062 if (!glyph_row
->enabled_p
)
28064 w
->phys_cursor_on_p
= false;
28069 if (!glyph_row
->exact_window_width_line_p
28070 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28071 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28073 eassert (input_blocked_p ());
28075 /* Set new_cursor_type to the cursor we want to be displayed. */
28076 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28077 &new_cursor_width
, &active_cursor
);
28079 /* If cursor is currently being shown and we don't want it to be or
28080 it is in the wrong place, or the cursor type is not what we want,
28082 if (w
->phys_cursor_on_p
28084 || w
->phys_cursor
.x
!= x
28085 || w
->phys_cursor
.y
!= y
28086 /* HPOS can be negative in R2L rows whose
28087 exact_window_width_line_p flag is set (i.e. their newline
28088 would "overflow into the fringe"). */
28090 || new_cursor_type
!= w
->phys_cursor_type
28091 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28092 && new_cursor_width
!= w
->phys_cursor_width
)))
28093 erase_phys_cursor (w
);
28095 /* Don't check phys_cursor_on_p here because that flag is only set
28096 to false in some cases where we know that the cursor has been
28097 completely erased, to avoid the extra work of erasing the cursor
28098 twice. In other words, phys_cursor_on_p can be true and the cursor
28099 still not be visible, or it has only been partly erased. */
28102 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28103 w
->phys_cursor_height
= glyph_row
->height
;
28105 /* Set phys_cursor_.* before x_draw_.* is called because some
28106 of them may need the information. */
28107 w
->phys_cursor
.x
= x
;
28108 w
->phys_cursor
.y
= glyph_row
->y
;
28109 w
->phys_cursor
.hpos
= hpos
;
28110 w
->phys_cursor
.vpos
= vpos
;
28113 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28114 new_cursor_type
, new_cursor_width
,
28115 on
, active_cursor
);
28119 /* Switch the display of W's cursor on or off, according to the value
28123 update_window_cursor (struct window
*w
, bool on
)
28125 /* Don't update cursor in windows whose frame is in the process
28126 of being deleted. */
28127 if (w
->current_matrix
)
28129 int hpos
= w
->phys_cursor
.hpos
;
28130 int vpos
= w
->phys_cursor
.vpos
;
28131 struct glyph_row
*row
;
28133 if (vpos
>= w
->current_matrix
->nrows
28134 || hpos
>= w
->current_matrix
->matrix_w
)
28137 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28139 /* When the window is hscrolled, cursor hpos can legitimately be
28140 out of bounds, but we draw the cursor at the corresponding
28141 window margin in that case. */
28142 if (!row
->reversed_p
&& hpos
< 0)
28144 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28145 hpos
= row
->used
[TEXT_AREA
] - 1;
28148 display_and_set_cursor (w
, on
, hpos
, vpos
,
28149 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28155 /* Call update_window_cursor with parameter ON_P on all leaf windows
28156 in the window tree rooted at W. */
28159 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28163 if (WINDOWP (w
->contents
))
28164 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28166 update_window_cursor (w
, on_p
);
28168 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28174 Display the cursor on window W, or clear it, according to ON_P.
28175 Don't change the cursor's position. */
28178 x_update_cursor (struct frame
*f
, bool on_p
)
28180 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28185 Clear the cursor of window W to background color, and mark the
28186 cursor as not shown. This is used when the text where the cursor
28187 is about to be rewritten. */
28190 x_clear_cursor (struct window
*w
)
28192 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28193 update_window_cursor (w
, false);
28196 #endif /* HAVE_WINDOW_SYSTEM */
28198 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28201 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28202 int start_hpos
, int end_hpos
,
28203 enum draw_glyphs_face draw
)
28205 #ifdef HAVE_WINDOW_SYSTEM
28206 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28208 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28212 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28213 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28217 /* Display the active region described by mouse_face_* according to DRAW. */
28220 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28222 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28223 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28225 if (/* If window is in the process of being destroyed, don't bother
28227 w
->current_matrix
!= NULL
28228 /* Don't update mouse highlight if hidden. */
28229 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28230 /* Recognize when we are called to operate on rows that don't exist
28231 anymore. This can happen when a window is split. */
28232 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28234 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28235 struct glyph_row
*row
, *first
, *last
;
28237 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28238 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28240 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28242 int start_hpos
, end_hpos
, start_x
;
28244 /* For all but the first row, the highlight starts at column 0. */
28247 /* R2L rows have BEG and END in reversed order, but the
28248 screen drawing geometry is always left to right. So
28249 we need to mirror the beginning and end of the
28250 highlighted area in R2L rows. */
28251 if (!row
->reversed_p
)
28253 start_hpos
= hlinfo
->mouse_face_beg_col
;
28254 start_x
= hlinfo
->mouse_face_beg_x
;
28256 else if (row
== last
)
28258 start_hpos
= hlinfo
->mouse_face_end_col
;
28259 start_x
= hlinfo
->mouse_face_end_x
;
28267 else if (row
->reversed_p
&& row
== last
)
28269 start_hpos
= hlinfo
->mouse_face_end_col
;
28270 start_x
= hlinfo
->mouse_face_end_x
;
28280 if (!row
->reversed_p
)
28281 end_hpos
= hlinfo
->mouse_face_end_col
;
28282 else if (row
== first
)
28283 end_hpos
= hlinfo
->mouse_face_beg_col
;
28286 end_hpos
= row
->used
[TEXT_AREA
];
28287 if (draw
== DRAW_NORMAL_TEXT
)
28288 row
->fill_line_p
= true; /* Clear to end of line. */
28291 else if (row
->reversed_p
&& row
== first
)
28292 end_hpos
= hlinfo
->mouse_face_beg_col
;
28295 end_hpos
= row
->used
[TEXT_AREA
];
28296 if (draw
== DRAW_NORMAL_TEXT
)
28297 row
->fill_line_p
= true; /* Clear to end of line. */
28300 if (end_hpos
> start_hpos
)
28302 draw_row_with_mouse_face (w
, start_x
, row
,
28303 start_hpos
, end_hpos
, draw
);
28306 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28310 #ifdef HAVE_WINDOW_SYSTEM
28311 /* When we've written over the cursor, arrange for it to
28312 be displayed again. */
28313 if (FRAME_WINDOW_P (f
)
28314 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28316 int hpos
= w
->phys_cursor
.hpos
;
28318 /* When the window is hscrolled, cursor hpos can legitimately be
28319 out of bounds, but we draw the cursor at the corresponding
28320 window margin in that case. */
28321 if (!row
->reversed_p
&& hpos
< 0)
28323 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28324 hpos
= row
->used
[TEXT_AREA
] - 1;
28327 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28328 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28331 #endif /* HAVE_WINDOW_SYSTEM */
28334 #ifdef HAVE_WINDOW_SYSTEM
28335 /* Change the mouse cursor. */
28336 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28338 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28339 if (draw
== DRAW_NORMAL_TEXT
28340 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28341 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28344 if (draw
== DRAW_MOUSE_FACE
)
28345 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28347 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28349 #endif /* HAVE_WINDOW_SYSTEM */
28353 Clear out the mouse-highlighted active region.
28354 Redraw it un-highlighted first. Value is true if mouse
28355 face was actually drawn unhighlighted. */
28358 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28361 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28363 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28364 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28365 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28366 hlinfo
->mouse_face_window
= Qnil
;
28367 hlinfo
->mouse_face_overlay
= Qnil
;
28371 /* Return true if the coordinates HPOS and VPOS on windows W are
28372 within the mouse face on that window. */
28374 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28376 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28378 /* Quickly resolve the easy cases. */
28379 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28380 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28382 if (vpos
< hlinfo
->mouse_face_beg_row
28383 || vpos
> hlinfo
->mouse_face_end_row
)
28385 if (vpos
> hlinfo
->mouse_face_beg_row
28386 && vpos
< hlinfo
->mouse_face_end_row
)
28389 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28391 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28393 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28396 else if ((vpos
== hlinfo
->mouse_face_beg_row
28397 && hpos
>= hlinfo
->mouse_face_beg_col
)
28398 || (vpos
== hlinfo
->mouse_face_end_row
28399 && hpos
< hlinfo
->mouse_face_end_col
))
28404 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28406 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28409 else if ((vpos
== hlinfo
->mouse_face_beg_row
28410 && hpos
<= hlinfo
->mouse_face_beg_col
)
28411 || (vpos
== hlinfo
->mouse_face_end_row
28412 && hpos
> hlinfo
->mouse_face_end_col
))
28420 True if physical cursor of window W is within mouse face. */
28423 cursor_in_mouse_face_p (struct window
*w
)
28425 int hpos
= w
->phys_cursor
.hpos
;
28426 int vpos
= w
->phys_cursor
.vpos
;
28427 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28429 /* When the window is hscrolled, cursor hpos can legitimately be out
28430 of bounds, but we draw the cursor at the corresponding window
28431 margin in that case. */
28432 if (!row
->reversed_p
&& hpos
< 0)
28434 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28435 hpos
= row
->used
[TEXT_AREA
] - 1;
28437 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28442 /* Find the glyph rows START_ROW and END_ROW of window W that display
28443 characters between buffer positions START_CHARPOS and END_CHARPOS
28444 (excluding END_CHARPOS). DISP_STRING is a display string that
28445 covers these buffer positions. This is similar to
28446 row_containing_pos, but is more accurate when bidi reordering makes
28447 buffer positions change non-linearly with glyph rows. */
28449 rows_from_pos_range (struct window
*w
,
28450 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28451 Lisp_Object disp_string
,
28452 struct glyph_row
**start
, struct glyph_row
**end
)
28454 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28455 int last_y
= window_text_bottom_y (w
);
28456 struct glyph_row
*row
;
28461 while (!first
->enabled_p
28462 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28465 /* Find the START row. */
28467 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28470 /* A row can potentially be the START row if the range of the
28471 characters it displays intersects the range
28472 [START_CHARPOS..END_CHARPOS). */
28473 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28474 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28475 /* See the commentary in row_containing_pos, for the
28476 explanation of the complicated way to check whether
28477 some position is beyond the end of the characters
28478 displayed by a row. */
28479 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28480 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28481 && !row
->ends_at_zv_p
28482 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28483 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28484 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28485 && !row
->ends_at_zv_p
28486 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28488 /* Found a candidate row. Now make sure at least one of the
28489 glyphs it displays has a charpos from the range
28490 [START_CHARPOS..END_CHARPOS).
28492 This is not obvious because bidi reordering could make
28493 buffer positions of a row be 1,2,3,102,101,100, and if we
28494 want to highlight characters in [50..60), we don't want
28495 this row, even though [50..60) does intersect [1..103),
28496 the range of character positions given by the row's start
28497 and end positions. */
28498 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28499 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28503 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28504 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28505 /* A glyph that comes from DISP_STRING is by
28506 definition to be highlighted. */
28507 || EQ (g
->object
, disp_string
))
28516 /* Find the END row. */
28518 /* If the last row is partially visible, start looking for END
28519 from that row, instead of starting from FIRST. */
28520 && !(row
->enabled_p
28521 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28523 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28525 struct glyph_row
*next
= row
+ 1;
28526 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28528 if (!next
->enabled_p
28529 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28530 /* The first row >= START whose range of displayed characters
28531 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28532 is the row END + 1. */
28533 || (start_charpos
< next_start
28534 && end_charpos
< next_start
)
28535 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28536 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28537 && !next
->ends_at_zv_p
28538 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28539 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28540 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28541 && !next
->ends_at_zv_p
28542 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28549 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28550 but none of the characters it displays are in the range, it is
28552 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28553 struct glyph
*s
= g
;
28554 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28558 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28559 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28560 /* If the buffer position of the first glyph in
28561 the row is equal to END_CHARPOS, it means
28562 the last character to be highlighted is the
28563 newline of ROW, and we must consider NEXT as
28565 || (((!next
->reversed_p
&& g
== s
)
28566 || (next
->reversed_p
&& g
== e
- 1))
28567 && (g
->charpos
== end_charpos
28568 /* Special case for when NEXT is an
28569 empty line at ZV. */
28570 || (g
->charpos
== -1
28571 && !row
->ends_at_zv_p
28572 && next_start
== end_charpos
)))))
28573 /* A glyph that comes from DISP_STRING is by
28574 definition to be highlighted. */
28575 || EQ (g
->object
, disp_string
))
28584 /* The first row that ends at ZV must be the last to be
28586 else if (next
->ends_at_zv_p
)
28595 /* This function sets the mouse_face_* elements of HLINFO, assuming
28596 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28597 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28598 for the overlay or run of text properties specifying the mouse
28599 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28600 before-string and after-string that must also be highlighted.
28601 DISP_STRING, if non-nil, is a display string that may cover some
28602 or all of the highlighted text. */
28605 mouse_face_from_buffer_pos (Lisp_Object window
,
28606 Mouse_HLInfo
*hlinfo
,
28607 ptrdiff_t mouse_charpos
,
28608 ptrdiff_t start_charpos
,
28609 ptrdiff_t end_charpos
,
28610 Lisp_Object before_string
,
28611 Lisp_Object after_string
,
28612 Lisp_Object disp_string
)
28614 struct window
*w
= XWINDOW (window
);
28615 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28616 struct glyph_row
*r1
, *r2
;
28617 struct glyph
*glyph
, *end
;
28618 ptrdiff_t ignore
, pos
;
28621 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28622 eassert (NILP (before_string
) || STRINGP (before_string
));
28623 eassert (NILP (after_string
) || STRINGP (after_string
));
28625 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28626 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28628 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28629 /* If the before-string or display-string contains newlines,
28630 rows_from_pos_range skips to its last row. Move back. */
28631 if (!NILP (before_string
) || !NILP (disp_string
))
28633 struct glyph_row
*prev
;
28634 while ((prev
= r1
- 1, prev
>= first
)
28635 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28636 && prev
->used
[TEXT_AREA
] > 0)
28638 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28639 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28640 while (--glyph
>= beg
&& NILP (glyph
->object
));
28642 || !(EQ (glyph
->object
, before_string
)
28643 || EQ (glyph
->object
, disp_string
)))
28650 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28651 hlinfo
->mouse_face_past_end
= true;
28653 else if (!NILP (after_string
))
28655 /* If the after-string has newlines, advance to its last row. */
28656 struct glyph_row
*next
;
28657 struct glyph_row
*last
28658 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28660 for (next
= r2
+ 1;
28662 && next
->used
[TEXT_AREA
] > 0
28663 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28667 /* The rest of the display engine assumes that mouse_face_beg_row is
28668 either above mouse_face_end_row or identical to it. But with
28669 bidi-reordered continued lines, the row for START_CHARPOS could
28670 be below the row for END_CHARPOS. If so, swap the rows and store
28671 them in correct order. */
28674 struct glyph_row
*tem
= r2
;
28680 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28681 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28683 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28684 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28685 could be anywhere in the row and in any order. The strategy
28686 below is to find the leftmost and the rightmost glyph that
28687 belongs to either of these 3 strings, or whose position is
28688 between START_CHARPOS and END_CHARPOS, and highlight all the
28689 glyphs between those two. This may cover more than just the text
28690 between START_CHARPOS and END_CHARPOS if the range of characters
28691 strides the bidi level boundary, e.g. if the beginning is in R2L
28692 text while the end is in L2R text or vice versa. */
28693 if (!r1
->reversed_p
)
28695 /* This row is in a left to right paragraph. Scan it left to
28697 glyph
= r1
->glyphs
[TEXT_AREA
];
28698 end
= glyph
+ r1
->used
[TEXT_AREA
];
28701 /* Skip truncation glyphs at the start of the glyph row. */
28702 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28704 && NILP (glyph
->object
)
28705 && glyph
->charpos
< 0;
28707 x
+= glyph
->pixel_width
;
28709 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28710 or DISP_STRING, and the first glyph from buffer whose
28711 position is between START_CHARPOS and END_CHARPOS. */
28713 && !NILP (glyph
->object
)
28714 && !EQ (glyph
->object
, disp_string
)
28715 && !(BUFFERP (glyph
->object
)
28716 && (glyph
->charpos
>= start_charpos
28717 && glyph
->charpos
< end_charpos
));
28720 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28721 are present at buffer positions between START_CHARPOS and
28722 END_CHARPOS, or if they come from an overlay. */
28723 if (EQ (glyph
->object
, before_string
))
28725 pos
= string_buffer_position (before_string
,
28727 /* If pos == 0, it means before_string came from an
28728 overlay, not from a buffer position. */
28729 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28732 else if (EQ (glyph
->object
, after_string
))
28734 pos
= string_buffer_position (after_string
, end_charpos
);
28735 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28738 x
+= glyph
->pixel_width
;
28740 hlinfo
->mouse_face_beg_x
= x
;
28741 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28745 /* This row is in a right to left paragraph. Scan it right to
28749 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28750 glyph
= end
+ r1
->used
[TEXT_AREA
];
28752 /* Skip truncation glyphs at the start of the glyph row. */
28753 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28755 && NILP (glyph
->object
)
28756 && glyph
->charpos
< 0;
28760 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28761 or DISP_STRING, and the first glyph from buffer whose
28762 position is between START_CHARPOS and END_CHARPOS. */
28764 && !NILP (glyph
->object
)
28765 && !EQ (glyph
->object
, disp_string
)
28766 && !(BUFFERP (glyph
->object
)
28767 && (glyph
->charpos
>= start_charpos
28768 && glyph
->charpos
< end_charpos
));
28771 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28772 are present at buffer positions between START_CHARPOS and
28773 END_CHARPOS, or if they come from an overlay. */
28774 if (EQ (glyph
->object
, before_string
))
28776 pos
= string_buffer_position (before_string
, start_charpos
);
28777 /* If pos == 0, it means before_string came from an
28778 overlay, not from a buffer position. */
28779 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28782 else if (EQ (glyph
->object
, after_string
))
28784 pos
= string_buffer_position (after_string
, end_charpos
);
28785 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28790 glyph
++; /* first glyph to the right of the highlighted area */
28791 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28792 x
+= g
->pixel_width
;
28793 hlinfo
->mouse_face_beg_x
= x
;
28794 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28797 /* If the highlight ends in a different row, compute GLYPH and END
28798 for the end row. Otherwise, reuse the values computed above for
28799 the row where the highlight begins. */
28802 if (!r2
->reversed_p
)
28804 glyph
= r2
->glyphs
[TEXT_AREA
];
28805 end
= glyph
+ r2
->used
[TEXT_AREA
];
28810 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28811 glyph
= end
+ r2
->used
[TEXT_AREA
];
28815 if (!r2
->reversed_p
)
28817 /* Skip truncation and continuation glyphs near the end of the
28818 row, and also blanks and stretch glyphs inserted by
28819 extend_face_to_end_of_line. */
28821 && NILP ((end
- 1)->object
))
28823 /* Scan the rest of the glyph row from the end, looking for the
28824 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28825 DISP_STRING, or whose position is between START_CHARPOS
28829 && !NILP (end
->object
)
28830 && !EQ (end
->object
, disp_string
)
28831 && !(BUFFERP (end
->object
)
28832 && (end
->charpos
>= start_charpos
28833 && end
->charpos
< end_charpos
));
28836 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28837 are present at buffer positions between START_CHARPOS and
28838 END_CHARPOS, or if they come from an overlay. */
28839 if (EQ (end
->object
, before_string
))
28841 pos
= string_buffer_position (before_string
, start_charpos
);
28842 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28845 else if (EQ (end
->object
, after_string
))
28847 pos
= string_buffer_position (after_string
, end_charpos
);
28848 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28852 /* Find the X coordinate of the last glyph to be highlighted. */
28853 for (; glyph
<= end
; ++glyph
)
28854 x
+= glyph
->pixel_width
;
28856 hlinfo
->mouse_face_end_x
= x
;
28857 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28861 /* Skip truncation and continuation glyphs near the end of the
28862 row, and also blanks and stretch glyphs inserted by
28863 extend_face_to_end_of_line. */
28867 && NILP (end
->object
))
28869 x
+= end
->pixel_width
;
28872 /* Scan the rest of the glyph row from the end, looking for the
28873 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28874 DISP_STRING, or whose position is between START_CHARPOS
28878 && !NILP (end
->object
)
28879 && !EQ (end
->object
, disp_string
)
28880 && !(BUFFERP (end
->object
)
28881 && (end
->charpos
>= start_charpos
28882 && end
->charpos
< end_charpos
));
28885 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28886 are present at buffer positions between START_CHARPOS and
28887 END_CHARPOS, or if they come from an overlay. */
28888 if (EQ (end
->object
, before_string
))
28890 pos
= string_buffer_position (before_string
, start_charpos
);
28891 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28894 else if (EQ (end
->object
, after_string
))
28896 pos
= string_buffer_position (after_string
, end_charpos
);
28897 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28900 x
+= end
->pixel_width
;
28902 /* If we exited the above loop because we arrived at the last
28903 glyph of the row, and its buffer position is still not in
28904 range, it means the last character in range is the preceding
28905 newline. Bump the end column and x values to get past the
28908 && BUFFERP (end
->object
)
28909 && (end
->charpos
< start_charpos
28910 || end
->charpos
>= end_charpos
))
28912 x
+= end
->pixel_width
;
28915 hlinfo
->mouse_face_end_x
= x
;
28916 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28919 hlinfo
->mouse_face_window
= window
;
28920 hlinfo
->mouse_face_face_id
28921 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28923 !hlinfo
->mouse_face_hidden
, -1);
28924 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28927 /* The following function is not used anymore (replaced with
28928 mouse_face_from_string_pos), but I leave it here for the time
28929 being, in case someone would. */
28931 #if false /* not used */
28933 /* Find the position of the glyph for position POS in OBJECT in
28934 window W's current matrix, and return in *X, *Y the pixel
28935 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28937 RIGHT_P means return the position of the right edge of the glyph.
28938 !RIGHT_P means return the left edge position.
28940 If no glyph for POS exists in the matrix, return the position of
28941 the glyph with the next smaller position that is in the matrix, if
28942 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28943 exists in the matrix, return the position of the glyph with the
28944 next larger position in OBJECT.
28946 Value is true if a glyph was found. */
28949 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28950 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28952 int yb
= window_text_bottom_y (w
);
28953 struct glyph_row
*r
;
28954 struct glyph
*best_glyph
= NULL
;
28955 struct glyph_row
*best_row
= NULL
;
28958 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28959 r
->enabled_p
&& r
->y
< yb
;
28962 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28963 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28966 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28967 if (EQ (g
->object
, object
))
28969 if (g
->charpos
== pos
)
28976 else if (best_glyph
== NULL
28977 || ((eabs (g
->charpos
- pos
)
28978 < eabs (best_glyph
->charpos
- pos
))
28981 : g
->charpos
> pos
)))
28995 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28999 *x
+= best_glyph
->pixel_width
;
29004 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29007 return best_glyph
!= NULL
;
29009 #endif /* not used */
29011 /* Find the positions of the first and the last glyphs in window W's
29012 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29013 (assumed to be a string), and return in HLINFO's mouse_face_*
29014 members the pixel and column/row coordinates of those glyphs. */
29017 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29018 Lisp_Object object
,
29019 ptrdiff_t startpos
, ptrdiff_t endpos
)
29021 int yb
= window_text_bottom_y (w
);
29022 struct glyph_row
*r
;
29023 struct glyph
*g
, *e
;
29025 bool found
= false;
29027 /* Find the glyph row with at least one position in the range
29028 [STARTPOS..ENDPOS), and the first glyph in that row whose
29029 position belongs to that range. */
29030 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29031 r
->enabled_p
&& r
->y
< yb
;
29034 if (!r
->reversed_p
)
29036 g
= r
->glyphs
[TEXT_AREA
];
29037 e
= g
+ r
->used
[TEXT_AREA
];
29038 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29039 if (EQ (g
->object
, object
)
29040 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29042 hlinfo
->mouse_face_beg_row
29043 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29044 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29045 hlinfo
->mouse_face_beg_x
= gx
;
29054 e
= r
->glyphs
[TEXT_AREA
];
29055 g
= e
+ r
->used
[TEXT_AREA
];
29056 for ( ; g
> e
; --g
)
29057 if (EQ ((g
-1)->object
, object
)
29058 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29060 hlinfo
->mouse_face_beg_row
29061 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29062 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29063 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29064 gx
+= g1
->pixel_width
;
29065 hlinfo
->mouse_face_beg_x
= gx
;
29077 /* Starting with the next row, look for the first row which does NOT
29078 include any glyphs whose positions are in the range. */
29079 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29081 g
= r
->glyphs
[TEXT_AREA
];
29082 e
= g
+ r
->used
[TEXT_AREA
];
29084 for ( ; g
< e
; ++g
)
29085 if (EQ (g
->object
, object
)
29086 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29095 /* The highlighted region ends on the previous row. */
29098 /* Set the end row. */
29099 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29101 /* Compute and set the end column and the end column's horizontal
29102 pixel coordinate. */
29103 if (!r
->reversed_p
)
29105 g
= r
->glyphs
[TEXT_AREA
];
29106 e
= g
+ r
->used
[TEXT_AREA
];
29107 for ( ; e
> g
; --e
)
29108 if (EQ ((e
-1)->object
, object
)
29109 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29111 hlinfo
->mouse_face_end_col
= e
- g
;
29113 for (gx
= r
->x
; g
< e
; ++g
)
29114 gx
+= g
->pixel_width
;
29115 hlinfo
->mouse_face_end_x
= gx
;
29119 e
= r
->glyphs
[TEXT_AREA
];
29120 g
= e
+ r
->used
[TEXT_AREA
];
29121 for (gx
= r
->x
; e
< g
; ++e
)
29123 if (EQ (e
->object
, object
)
29124 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29126 gx
+= e
->pixel_width
;
29128 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29129 hlinfo
->mouse_face_end_x
= gx
;
29133 #ifdef HAVE_WINDOW_SYSTEM
29135 /* See if position X, Y is within a hot-spot of an image. */
29138 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29140 if (!CONSP (hot_spot
))
29143 if (EQ (XCAR (hot_spot
), Qrect
))
29145 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29146 Lisp_Object rect
= XCDR (hot_spot
);
29150 if (!CONSP (XCAR (rect
)))
29152 if (!CONSP (XCDR (rect
)))
29154 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29156 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29158 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29160 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29164 else if (EQ (XCAR (hot_spot
), Qcircle
))
29166 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29167 Lisp_Object circ
= XCDR (hot_spot
);
29168 Lisp_Object lr
, lx0
, ly0
;
29170 && CONSP (XCAR (circ
))
29171 && (lr
= XCDR (circ
), NUMBERP (lr
))
29172 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29173 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29175 double r
= XFLOATINT (lr
);
29176 double dx
= XINT (lx0
) - x
;
29177 double dy
= XINT (ly0
) - y
;
29178 return (dx
* dx
+ dy
* dy
<= r
* r
);
29181 else if (EQ (XCAR (hot_spot
), Qpoly
))
29183 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29184 if (VECTORP (XCDR (hot_spot
)))
29186 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29187 Lisp_Object
*poly
= v
->contents
;
29188 ptrdiff_t n
= v
->header
.size
;
29190 bool inside
= false;
29191 Lisp_Object lx
, ly
;
29194 /* Need an even number of coordinates, and at least 3 edges. */
29195 if (n
< 6 || n
& 1)
29198 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29199 If count is odd, we are inside polygon. Pixels on edges
29200 may or may not be included depending on actual geometry of the
29202 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29203 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29205 x0
= XINT (lx
), y0
= XINT (ly
);
29206 for (i
= 0; i
< n
; i
+= 2)
29208 int x1
= x0
, y1
= y0
;
29209 if ((lx
= poly
[i
], !INTEGERP (lx
))
29210 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29212 x0
= XINT (lx
), y0
= XINT (ly
);
29214 /* Does this segment cross the X line? */
29222 if (y
> y0
&& y
> y1
)
29224 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29234 find_hot_spot (Lisp_Object map
, int x
, int y
)
29236 while (CONSP (map
))
29238 if (CONSP (XCAR (map
))
29239 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29247 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29249 doc
: /* Lookup in image map MAP coordinates X and Y.
29250 An image map is an alist where each element has the format (AREA ID PLIST).
29251 An AREA is specified as either a rectangle, a circle, or a polygon:
29252 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29253 pixel coordinates of the upper left and bottom right corners.
29254 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29255 and the radius of the circle; r may be a float or integer.
29256 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29257 vector describes one corner in the polygon.
29258 Returns the alist element for the first matching AREA in MAP. */)
29259 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29267 return find_hot_spot (map
,
29268 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29269 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29273 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29275 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29277 /* Do not change cursor shape while dragging mouse. */
29278 if (EQ (do_mouse_tracking
, Qdragging
))
29281 if (!NILP (pointer
))
29283 if (EQ (pointer
, Qarrow
))
29284 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29285 else if (EQ (pointer
, Qhand
))
29286 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29287 else if (EQ (pointer
, Qtext
))
29288 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29289 else if (EQ (pointer
, intern ("hdrag")))
29290 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29291 else if (EQ (pointer
, intern ("nhdrag")))
29292 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29293 #ifdef HAVE_X_WINDOWS
29294 else if (EQ (pointer
, intern ("vdrag")))
29295 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29297 else if (EQ (pointer
, intern ("hourglass")))
29298 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29299 else if (EQ (pointer
, Qmodeline
))
29300 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29302 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29305 if (cursor
!= No_Cursor
)
29306 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29309 #endif /* HAVE_WINDOW_SYSTEM */
29311 /* Take proper action when mouse has moved to the mode or header line
29312 or marginal area AREA of window W, x-position X and y-position Y.
29313 X is relative to the start of the text display area of W, so the
29314 width of bitmap areas and scroll bars must be subtracted to get a
29315 position relative to the start of the mode line. */
29318 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29319 enum window_part area
)
29321 struct window
*w
= XWINDOW (window
);
29322 struct frame
*f
= XFRAME (w
->frame
);
29323 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29324 #ifdef HAVE_WINDOW_SYSTEM
29325 Display_Info
*dpyinfo
;
29327 Cursor cursor
= No_Cursor
;
29328 Lisp_Object pointer
= Qnil
;
29329 int dx
, dy
, width
, height
;
29331 Lisp_Object string
, object
= Qnil
;
29332 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29334 Lisp_Object mouse_face
;
29335 int original_x_pixel
= x
;
29336 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29337 struct glyph_row
*row
IF_LINT (= 0);
29339 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29344 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29345 returns them in row/column units! */
29346 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29347 &object
, &dx
, &dy
, &width
, &height
);
29349 row
= (area
== ON_MODE_LINE
29350 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29351 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29353 /* Find the glyph under the mouse pointer. */
29354 if (row
->mode_line_p
&& row
->enabled_p
)
29356 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29357 end
= glyph
+ row
->used
[TEXT_AREA
];
29359 for (x0
= original_x_pixel
;
29360 glyph
< end
&& x0
>= glyph
->pixel_width
;
29362 x0
-= glyph
->pixel_width
;
29370 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29371 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29372 returns them in row/column units! */
29373 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29374 &object
, &dx
, &dy
, &width
, &height
);
29379 #ifdef HAVE_WINDOW_SYSTEM
29380 if (IMAGEP (object
))
29382 Lisp_Object image_map
, hotspot
;
29383 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29385 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29387 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29391 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29392 If so, we could look for mouse-enter, mouse-leave
29393 properties in PLIST (and do something...). */
29394 hotspot
= XCDR (hotspot
);
29395 if (CONSP (hotspot
)
29396 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29398 pointer
= Fplist_get (plist
, Qpointer
);
29399 if (NILP (pointer
))
29401 help
= Fplist_get (plist
, Qhelp_echo
);
29404 help_echo_string
= help
;
29405 XSETWINDOW (help_echo_window
, w
);
29406 help_echo_object
= w
->contents
;
29407 help_echo_pos
= charpos
;
29411 if (NILP (pointer
))
29412 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29414 #endif /* HAVE_WINDOW_SYSTEM */
29416 if (STRINGP (string
))
29417 pos
= make_number (charpos
);
29419 /* Set the help text and mouse pointer. If the mouse is on a part
29420 of the mode line without any text (e.g. past the right edge of
29421 the mode line text), use the default help text and pointer. */
29422 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29424 /* Arrange to display the help by setting the global variables
29425 help_echo_string, help_echo_object, and help_echo_pos. */
29428 if (STRINGP (string
))
29429 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29433 help_echo_string
= help
;
29434 XSETWINDOW (help_echo_window
, w
);
29435 help_echo_object
= string
;
29436 help_echo_pos
= charpos
;
29438 else if (area
== ON_MODE_LINE
)
29440 Lisp_Object default_help
29441 = buffer_local_value (Qmode_line_default_help_echo
,
29444 if (STRINGP (default_help
))
29446 help_echo_string
= default_help
;
29447 XSETWINDOW (help_echo_window
, w
);
29448 help_echo_object
= Qnil
;
29449 help_echo_pos
= -1;
29454 #ifdef HAVE_WINDOW_SYSTEM
29455 /* Change the mouse pointer according to what is under it. */
29456 if (FRAME_WINDOW_P (f
))
29458 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29460 || NILP (Vresize_mini_windows
));
29462 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29463 if (STRINGP (string
))
29465 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29467 if (NILP (pointer
))
29468 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29470 /* Change the mouse pointer according to what is under X/Y. */
29472 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29475 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29476 if (!KEYMAPP (map
))
29477 map
= Fget_text_property (pos
, Qkeymap
, string
);
29478 if (!KEYMAPP (map
) && draggable
)
29479 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29482 else if (draggable
)
29483 /* Default mode-line pointer. */
29484 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29489 /* Change the mouse face according to what is under X/Y. */
29490 bool mouse_face_shown
= false;
29491 if (STRINGP (string
))
29493 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29494 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29495 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29500 struct glyph
* tmp_glyph
;
29504 int total_pixel_width
;
29505 ptrdiff_t begpos
, endpos
, ignore
;
29509 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29510 Qmouse_face
, string
, Qnil
);
29516 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29518 endpos
= SCHARS (string
);
29522 /* Calculate the glyph position GPOS of GLYPH in the
29523 displayed string, relative to the beginning of the
29524 highlighted part of the string.
29526 Note: GPOS is different from CHARPOS. CHARPOS is the
29527 position of GLYPH in the internal string object. A mode
29528 line string format has structures which are converted to
29529 a flattened string by the Emacs Lisp interpreter. The
29530 internal string is an element of those structures. The
29531 displayed string is the flattened string. */
29532 tmp_glyph
= row_start_glyph
;
29533 while (tmp_glyph
< glyph
29534 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29535 && begpos
<= tmp_glyph
->charpos
29536 && tmp_glyph
->charpos
< endpos
)))
29538 gpos
= glyph
- tmp_glyph
;
29540 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29541 the highlighted part of the displayed string to which
29542 GLYPH belongs. Note: GSEQ_LENGTH is different from
29543 SCHARS (STRING), because the latter returns the length of
29544 the internal string. */
29545 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29547 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29548 && begpos
<= tmp_glyph
->charpos
29549 && tmp_glyph
->charpos
< endpos
));
29552 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29554 /* Calculate the total pixel width of all the glyphs between
29555 the beginning of the highlighted area and GLYPH. */
29556 total_pixel_width
= 0;
29557 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29558 total_pixel_width
+= tmp_glyph
->pixel_width
;
29560 /* Pre calculation of re-rendering position. Note: X is in
29561 column units here, after the call to mode_line_string or
29562 marginal_area_string. */
29564 vpos
= (area
== ON_MODE_LINE
29565 ? (w
->current_matrix
)->nrows
- 1
29568 /* If GLYPH's position is included in the region that is
29569 already drawn in mouse face, we have nothing to do. */
29570 if ( EQ (window
, hlinfo
->mouse_face_window
)
29571 && (!row
->reversed_p
29572 ? (hlinfo
->mouse_face_beg_col
<= hpos
29573 && hpos
< hlinfo
->mouse_face_end_col
)
29574 /* In R2L rows we swap BEG and END, see below. */
29575 : (hlinfo
->mouse_face_end_col
<= hpos
29576 && hpos
< hlinfo
->mouse_face_beg_col
))
29577 && hlinfo
->mouse_face_beg_row
== vpos
)
29580 if (clear_mouse_face (hlinfo
))
29581 cursor
= No_Cursor
;
29583 if (!row
->reversed_p
)
29585 hlinfo
->mouse_face_beg_col
= hpos
;
29586 hlinfo
->mouse_face_beg_x
= original_x_pixel
29587 - (total_pixel_width
+ dx
);
29588 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29589 hlinfo
->mouse_face_end_x
= 0;
29593 /* In R2L rows, show_mouse_face expects BEG and END
29594 coordinates to be swapped. */
29595 hlinfo
->mouse_face_end_col
= hpos
;
29596 hlinfo
->mouse_face_end_x
= original_x_pixel
29597 - (total_pixel_width
+ dx
);
29598 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29599 hlinfo
->mouse_face_beg_x
= 0;
29602 hlinfo
->mouse_face_beg_row
= vpos
;
29603 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29604 hlinfo
->mouse_face_past_end
= false;
29605 hlinfo
->mouse_face_window
= window
;
29607 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29612 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29613 mouse_face_shown
= true;
29615 if (NILP (pointer
))
29620 /* If mouse-face doesn't need to be shown, clear any existing
29622 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29623 clear_mouse_face (hlinfo
);
29625 #ifdef HAVE_WINDOW_SYSTEM
29626 if (FRAME_WINDOW_P (f
))
29627 define_frame_cursor1 (f
, cursor
, pointer
);
29633 Take proper action when the mouse has moved to position X, Y on
29634 frame F with regards to highlighting portions of display that have
29635 mouse-face properties. Also de-highlight portions of display where
29636 the mouse was before, set the mouse pointer shape as appropriate
29637 for the mouse coordinates, and activate help echo (tooltips).
29638 X and Y can be negative or out of range. */
29641 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29643 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29644 enum window_part part
= ON_NOTHING
;
29645 Lisp_Object window
;
29647 Cursor cursor
= No_Cursor
;
29648 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29651 /* When a menu is active, don't highlight because this looks odd. */
29652 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29653 if (popup_activated ())
29657 if (!f
->glyphs_initialized_p
29658 || f
->pointer_invisible
)
29661 hlinfo
->mouse_face_mouse_x
= x
;
29662 hlinfo
->mouse_face_mouse_y
= y
;
29663 hlinfo
->mouse_face_mouse_frame
= f
;
29665 if (hlinfo
->mouse_face_defer
)
29668 /* Which window is that in? */
29669 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29671 /* If displaying active text in another window, clear that. */
29672 if (! EQ (window
, hlinfo
->mouse_face_window
)
29673 /* Also clear if we move out of text area in same window. */
29674 || (!NILP (hlinfo
->mouse_face_window
)
29677 && part
!= ON_MODE_LINE
29678 && part
!= ON_HEADER_LINE
))
29679 clear_mouse_face (hlinfo
);
29681 /* Not on a window -> return. */
29682 if (!WINDOWP (window
))
29685 /* Reset help_echo_string. It will get recomputed below. */
29686 help_echo_string
= Qnil
;
29688 /* Convert to window-relative pixel coordinates. */
29689 w
= XWINDOW (window
);
29690 frame_to_window_pixel_xy (w
, &x
, &y
);
29692 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29693 /* Handle tool-bar window differently since it doesn't display a
29695 if (EQ (window
, f
->tool_bar_window
))
29697 note_tool_bar_highlight (f
, x
, y
);
29702 /* Mouse is on the mode, header line or margin? */
29703 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29704 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29706 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29708 #ifdef HAVE_WINDOW_SYSTEM
29709 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29711 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29712 /* Show non-text cursor (Bug#16647). */
29720 #ifdef HAVE_WINDOW_SYSTEM
29721 if (part
== ON_VERTICAL_BORDER
)
29723 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29724 help_echo_string
= build_string ("drag-mouse-1: resize");
29726 else if (part
== ON_RIGHT_DIVIDER
)
29728 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29729 help_echo_string
= build_string ("drag-mouse-1: resize");
29731 else if (part
== ON_BOTTOM_DIVIDER
)
29732 if (! WINDOW_BOTTOMMOST_P (w
)
29734 || NILP (Vresize_mini_windows
))
29736 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29737 help_echo_string
= build_string ("drag-mouse-1: resize");
29740 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29741 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29742 || part
== ON_VERTICAL_SCROLL_BAR
29743 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29744 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29746 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29749 /* Are we in a window whose display is up to date?
29750 And verify the buffer's text has not changed. */
29751 b
= XBUFFER (w
->contents
);
29752 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29754 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29756 struct glyph
*glyph
;
29757 Lisp_Object object
;
29758 Lisp_Object mouse_face
= Qnil
, position
;
29759 Lisp_Object
*overlay_vec
= NULL
;
29760 ptrdiff_t i
, noverlays
;
29761 struct buffer
*obuf
;
29762 ptrdiff_t obegv
, ozv
;
29765 /* Find the glyph under X/Y. */
29766 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29768 #ifdef HAVE_WINDOW_SYSTEM
29769 /* Look for :pointer property on image. */
29770 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29772 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29773 if (img
!= NULL
&& IMAGEP (img
->spec
))
29775 Lisp_Object image_map
, hotspot
;
29776 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29778 && (hotspot
= find_hot_spot (image_map
,
29779 glyph
->slice
.img
.x
+ dx
,
29780 glyph
->slice
.img
.y
+ dy
),
29782 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29786 /* Could check XCAR (hotspot) to see if we enter/leave
29788 If so, we could look for mouse-enter, mouse-leave
29789 properties in PLIST (and do something...). */
29790 hotspot
= XCDR (hotspot
);
29791 if (CONSP (hotspot
)
29792 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29794 pointer
= Fplist_get (plist
, Qpointer
);
29795 if (NILP (pointer
))
29797 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29798 if (!NILP (help_echo_string
))
29800 help_echo_window
= window
;
29801 help_echo_object
= glyph
->object
;
29802 help_echo_pos
= glyph
->charpos
;
29806 if (NILP (pointer
))
29807 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29810 #endif /* HAVE_WINDOW_SYSTEM */
29812 /* Clear mouse face if X/Y not over text. */
29814 || area
!= TEXT_AREA
29815 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29816 /* Glyph's OBJECT is nil for glyphs inserted by the
29817 display engine for its internal purposes, like truncation
29818 and continuation glyphs and blanks beyond the end of
29819 line's text on text terminals. If we are over such a
29820 glyph, we are not over any text. */
29821 || NILP (glyph
->object
)
29822 /* R2L rows have a stretch glyph at their front, which
29823 stands for no text, whereas L2R rows have no glyphs at
29824 all beyond the end of text. Treat such stretch glyphs
29825 like we do with NULL glyphs in L2R rows. */
29826 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29827 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29828 && glyph
->type
== STRETCH_GLYPH
29829 && glyph
->avoid_cursor_p
))
29831 if (clear_mouse_face (hlinfo
))
29832 cursor
= No_Cursor
;
29833 #ifdef HAVE_WINDOW_SYSTEM
29834 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29836 if (area
!= TEXT_AREA
)
29837 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29839 pointer
= Vvoid_text_area_pointer
;
29845 pos
= glyph
->charpos
;
29846 object
= glyph
->object
;
29847 if (!STRINGP (object
) && !BUFFERP (object
))
29850 /* If we get an out-of-range value, return now; avoid an error. */
29851 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29854 /* Make the window's buffer temporarily current for
29855 overlays_at and compute_char_face. */
29856 obuf
= current_buffer
;
29857 current_buffer
= b
;
29863 /* Is this char mouse-active or does it have help-echo? */
29864 position
= make_number (pos
);
29868 if (BUFFERP (object
))
29870 /* Put all the overlays we want in a vector in overlay_vec. */
29871 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29872 /* Sort overlays into increasing priority order. */
29873 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29878 if (NILP (Vmouse_highlight
))
29880 clear_mouse_face (hlinfo
);
29881 goto check_help_echo
;
29884 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29887 cursor
= No_Cursor
;
29889 /* Check mouse-face highlighting. */
29891 /* If there exists an overlay with mouse-face overlapping
29892 the one we are currently highlighting, we have to
29893 check if we enter the overlapping overlay, and then
29894 highlight only that. */
29895 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29896 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29898 /* Find the highest priority overlay with a mouse-face. */
29899 Lisp_Object overlay
= Qnil
;
29900 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29902 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29903 if (!NILP (mouse_face
))
29904 overlay
= overlay_vec
[i
];
29907 /* If we're highlighting the same overlay as before, there's
29908 no need to do that again. */
29909 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29910 goto check_help_echo
;
29911 hlinfo
->mouse_face_overlay
= overlay
;
29913 /* Clear the display of the old active region, if any. */
29914 if (clear_mouse_face (hlinfo
))
29915 cursor
= No_Cursor
;
29917 /* If no overlay applies, get a text property. */
29918 if (NILP (overlay
))
29919 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29921 /* Next, compute the bounds of the mouse highlighting and
29923 if (!NILP (mouse_face
) && STRINGP (object
))
29925 /* The mouse-highlighting comes from a display string
29926 with a mouse-face. */
29930 s
= Fprevious_single_property_change
29931 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29932 e
= Fnext_single_property_change
29933 (position
, Qmouse_face
, object
, Qnil
);
29935 s
= make_number (0);
29937 e
= make_number (SCHARS (object
));
29938 mouse_face_from_string_pos (w
, hlinfo
, object
,
29939 XINT (s
), XINT (e
));
29940 hlinfo
->mouse_face_past_end
= false;
29941 hlinfo
->mouse_face_window
= window
;
29942 hlinfo
->mouse_face_face_id
29943 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29944 glyph
->face_id
, true);
29945 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29946 cursor
= No_Cursor
;
29950 /* The mouse-highlighting, if any, comes from an overlay
29951 or text property in the buffer. */
29952 Lisp_Object buffer
IF_LINT (= Qnil
);
29953 Lisp_Object disp_string
IF_LINT (= Qnil
);
29955 if (STRINGP (object
))
29957 /* If we are on a display string with no mouse-face,
29958 check if the text under it has one. */
29959 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29960 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29961 pos
= string_buffer_position (object
, start
);
29964 mouse_face
= get_char_property_and_overlay
29965 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29966 buffer
= w
->contents
;
29967 disp_string
= object
;
29973 disp_string
= Qnil
;
29976 if (!NILP (mouse_face
))
29978 Lisp_Object before
, after
;
29979 Lisp_Object before_string
, after_string
;
29980 /* To correctly find the limits of mouse highlight
29981 in a bidi-reordered buffer, we must not use the
29982 optimization of limiting the search in
29983 previous-single-property-change and
29984 next-single-property-change, because
29985 rows_from_pos_range needs the real start and end
29986 positions to DTRT in this case. That's because
29987 the first row visible in a window does not
29988 necessarily display the character whose position
29989 is the smallest. */
29991 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29992 ? Fmarker_position (w
->start
)
29995 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29996 ? make_number (BUF_Z (XBUFFER (buffer
))
29997 - w
->window_end_pos
)
30000 if (NILP (overlay
))
30002 /* Handle the text property case. */
30003 before
= Fprevious_single_property_change
30004 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30005 after
= Fnext_single_property_change
30006 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30007 before_string
= after_string
= Qnil
;
30011 /* Handle the overlay case. */
30012 before
= Foverlay_start (overlay
);
30013 after
= Foverlay_end (overlay
);
30014 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30015 after_string
= Foverlay_get (overlay
, Qafter_string
);
30017 if (!STRINGP (before_string
)) before_string
= Qnil
;
30018 if (!STRINGP (after_string
)) after_string
= Qnil
;
30021 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30024 : XFASTINT (before
),
30026 ? BUF_Z (XBUFFER (buffer
))
30027 : XFASTINT (after
),
30028 before_string
, after_string
,
30030 cursor
= No_Cursor
;
30037 /* Look for a `help-echo' property. */
30038 if (NILP (help_echo_string
)) {
30039 Lisp_Object help
, overlay
;
30041 /* Check overlays first. */
30042 help
= overlay
= Qnil
;
30043 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30045 overlay
= overlay_vec
[i
];
30046 help
= Foverlay_get (overlay
, Qhelp_echo
);
30051 help_echo_string
= help
;
30052 help_echo_window
= window
;
30053 help_echo_object
= overlay
;
30054 help_echo_pos
= pos
;
30058 Lisp_Object obj
= glyph
->object
;
30059 ptrdiff_t charpos
= glyph
->charpos
;
30061 /* Try text properties. */
30064 && charpos
< SCHARS (obj
))
30066 help
= Fget_text_property (make_number (charpos
),
30070 /* If the string itself doesn't specify a help-echo,
30071 see if the buffer text ``under'' it does. */
30072 struct glyph_row
*r
30073 = MATRIX_ROW (w
->current_matrix
, vpos
);
30074 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30075 ptrdiff_t p
= string_buffer_position (obj
, start
);
30078 help
= Fget_char_property (make_number (p
),
30079 Qhelp_echo
, w
->contents
);
30088 else if (BUFFERP (obj
)
30091 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30096 help_echo_string
= help
;
30097 help_echo_window
= window
;
30098 help_echo_object
= obj
;
30099 help_echo_pos
= charpos
;
30104 #ifdef HAVE_WINDOW_SYSTEM
30105 /* Look for a `pointer' property. */
30106 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30108 /* Check overlays first. */
30109 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30110 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30112 if (NILP (pointer
))
30114 Lisp_Object obj
= glyph
->object
;
30115 ptrdiff_t charpos
= glyph
->charpos
;
30117 /* Try text properties. */
30120 && charpos
< SCHARS (obj
))
30122 pointer
= Fget_text_property (make_number (charpos
),
30124 if (NILP (pointer
))
30126 /* If the string itself doesn't specify a pointer,
30127 see if the buffer text ``under'' it does. */
30128 struct glyph_row
*r
30129 = MATRIX_ROW (w
->current_matrix
, vpos
);
30130 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30131 ptrdiff_t p
= string_buffer_position (obj
, start
);
30133 pointer
= Fget_char_property (make_number (p
),
30134 Qpointer
, w
->contents
);
30137 else if (BUFFERP (obj
)
30140 pointer
= Fget_text_property (make_number (charpos
),
30144 #endif /* HAVE_WINDOW_SYSTEM */
30148 current_buffer
= obuf
;
30154 #ifdef HAVE_WINDOW_SYSTEM
30155 if (FRAME_WINDOW_P (f
))
30156 define_frame_cursor1 (f
, cursor
, pointer
);
30158 /* This is here to prevent a compiler error, about "label at end of
30159 compound statement". */
30166 Clear any mouse-face on window W. This function is part of the
30167 redisplay interface, and is called from try_window_id and similar
30168 functions to ensure the mouse-highlight is off. */
30171 x_clear_window_mouse_face (struct window
*w
)
30173 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30174 Lisp_Object window
;
30177 XSETWINDOW (window
, w
);
30178 if (EQ (window
, hlinfo
->mouse_face_window
))
30179 clear_mouse_face (hlinfo
);
30185 Just discard the mouse face information for frame F, if any.
30186 This is used when the size of F is changed. */
30189 cancel_mouse_face (struct frame
*f
)
30191 Lisp_Object window
;
30192 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30194 window
= hlinfo
->mouse_face_window
;
30195 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30196 reset_mouse_highlight (hlinfo
);
30201 /***********************************************************************
30203 ***********************************************************************/
30205 #ifdef HAVE_WINDOW_SYSTEM
30207 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30208 which intersects rectangle R. R is in window-relative coordinates. */
30211 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30212 enum glyph_row_area area
)
30214 struct glyph
*first
= row
->glyphs
[area
];
30215 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30216 struct glyph
*last
;
30217 int first_x
, start_x
, x
;
30219 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30220 /* If row extends face to end of line write the whole line. */
30221 draw_glyphs (w
, 0, row
, area
,
30222 0, row
->used
[area
],
30223 DRAW_NORMAL_TEXT
, 0);
30226 /* Set START_X to the window-relative start position for drawing glyphs of
30227 AREA. The first glyph of the text area can be partially visible.
30228 The first glyphs of other areas cannot. */
30229 start_x
= window_box_left_offset (w
, area
);
30231 if (area
== TEXT_AREA
)
30234 /* Find the first glyph that must be redrawn. */
30236 && x
+ first
->pixel_width
< r
->x
)
30238 x
+= first
->pixel_width
;
30242 /* Find the last one. */
30245 /* Use a signed int intermediate value to avoid catastrophic
30246 failures due to comparison between signed and unsigned, when
30247 x is negative (can happen for wide images that are hscrolled). */
30248 int r_end
= r
->x
+ r
->width
;
30249 while (last
< end
&& x
< r_end
)
30251 x
+= last
->pixel_width
;
30257 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30258 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30259 DRAW_NORMAL_TEXT
, 0);
30264 /* Redraw the parts of the glyph row ROW on window W intersecting
30265 rectangle R. R is in window-relative coordinates. Value is
30266 true if mouse-face was overwritten. */
30269 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30271 eassert (row
->enabled_p
);
30273 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30274 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30275 0, row
->used
[TEXT_AREA
],
30276 DRAW_NORMAL_TEXT
, 0);
30279 if (row
->used
[LEFT_MARGIN_AREA
])
30280 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30281 if (row
->used
[TEXT_AREA
])
30282 expose_area (w
, row
, r
, TEXT_AREA
);
30283 if (row
->used
[RIGHT_MARGIN_AREA
])
30284 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30285 draw_row_fringe_bitmaps (w
, row
);
30288 return row
->mouse_face_p
;
30292 /* Redraw those parts of glyphs rows during expose event handling that
30293 overlap other rows. Redrawing of an exposed line writes over parts
30294 of lines overlapping that exposed line; this function fixes that.
30296 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30297 row in W's current matrix that is exposed and overlaps other rows.
30298 LAST_OVERLAPPING_ROW is the last such row. */
30301 expose_overlaps (struct window
*w
,
30302 struct glyph_row
*first_overlapping_row
,
30303 struct glyph_row
*last_overlapping_row
,
30306 struct glyph_row
*row
;
30308 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30309 if (row
->overlapping_p
)
30311 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30314 if (row
->used
[LEFT_MARGIN_AREA
])
30315 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30317 if (row
->used
[TEXT_AREA
])
30318 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30320 if (row
->used
[RIGHT_MARGIN_AREA
])
30321 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30327 /* Return true if W's cursor intersects rectangle R. */
30330 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30332 XRectangle cr
, result
;
30333 struct glyph
*cursor_glyph
;
30334 struct glyph_row
*row
;
30336 if (w
->phys_cursor
.vpos
>= 0
30337 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30338 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30340 && row
->cursor_in_fringe_p
)
30342 /* Cursor is in the fringe. */
30343 cr
.x
= window_box_right_offset (w
,
30344 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30345 ? RIGHT_MARGIN_AREA
30348 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30349 cr
.height
= row
->height
;
30350 return x_intersect_rectangles (&cr
, r
, &result
);
30353 cursor_glyph
= get_phys_cursor_glyph (w
);
30356 /* r is relative to W's box, but w->phys_cursor.x is relative
30357 to left edge of W's TEXT area. Adjust it. */
30358 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30359 cr
.y
= w
->phys_cursor
.y
;
30360 cr
.width
= cursor_glyph
->pixel_width
;
30361 cr
.height
= w
->phys_cursor_height
;
30362 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30363 I assume the effect is the same -- and this is portable. */
30364 return x_intersect_rectangles (&cr
, r
, &result
);
30366 /* If we don't understand the format, pretend we're not in the hot-spot. */
30372 Draw a vertical window border to the right of window W if W doesn't
30373 have vertical scroll bars. */
30376 x_draw_vertical_border (struct window
*w
)
30378 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30380 /* We could do better, if we knew what type of scroll-bar the adjacent
30381 windows (on either side) have... But we don't :-(
30382 However, I think this works ok. ++KFS 2003-04-25 */
30384 /* Redraw borders between horizontally adjacent windows. Don't
30385 do it for frames with vertical scroll bars because either the
30386 right scroll bar of a window, or the left scroll bar of its
30387 neighbor will suffice as a border. */
30388 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30391 /* Note: It is necessary to redraw both the left and the right
30392 borders, for when only this single window W is being
30394 if (!WINDOW_RIGHTMOST_P (w
)
30395 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30397 int x0
, x1
, y0
, y1
;
30399 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30402 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30405 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30408 if (!WINDOW_LEFTMOST_P (w
)
30409 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30411 int x0
, x1
, y0
, y1
;
30413 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30416 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30419 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30424 /* Draw window dividers for window W. */
30427 x_draw_right_divider (struct window
*w
)
30429 struct frame
*f
= WINDOW_XFRAME (w
);
30431 if (w
->mini
|| w
->pseudo_window_p
)
30433 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30435 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30436 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30437 int y0
= WINDOW_TOP_EDGE_Y (w
);
30438 /* The bottom divider prevails. */
30439 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30441 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30446 x_draw_bottom_divider (struct window
*w
)
30448 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30450 if (w
->mini
|| w
->pseudo_window_p
)
30452 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30454 int x0
= WINDOW_LEFT_EDGE_X (w
);
30455 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30456 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30457 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30459 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30463 /* Redraw the part of window W intersection rectangle FR. Pixel
30464 coordinates in FR are frame-relative. Call this function with
30465 input blocked. Value is true if the exposure overwrites
30469 expose_window (struct window
*w
, XRectangle
*fr
)
30471 struct frame
*f
= XFRAME (w
->frame
);
30473 bool mouse_face_overwritten_p
= false;
30475 /* If window is not yet fully initialized, do nothing. This can
30476 happen when toolkit scroll bars are used and a window is split.
30477 Reconfiguring the scroll bar will generate an expose for a newly
30479 if (w
->current_matrix
== NULL
)
30482 /* When we're currently updating the window, display and current
30483 matrix usually don't agree. Arrange for a thorough display
30485 if (w
->must_be_updated_p
)
30487 SET_FRAME_GARBAGED (f
);
30491 /* Frame-relative pixel rectangle of W. */
30492 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30493 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30494 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30495 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30497 if (x_intersect_rectangles (fr
, &wr
, &r
))
30499 int yb
= window_text_bottom_y (w
);
30500 struct glyph_row
*row
;
30501 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30503 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30504 r
.x
, r
.y
, r
.width
, r
.height
));
30506 /* Convert to window coordinates. */
30507 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30508 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30510 /* Turn off the cursor. */
30511 bool cursor_cleared_p
= (!w
->pseudo_window_p
30512 && phys_cursor_in_rect_p (w
, &r
));
30513 if (cursor_cleared_p
)
30514 x_clear_cursor (w
);
30516 /* If the row containing the cursor extends face to end of line,
30517 then expose_area might overwrite the cursor outside the
30518 rectangle and thus notice_overwritten_cursor might clear
30519 w->phys_cursor_on_p. We remember the original value and
30520 check later if it is changed. */
30521 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30523 /* Use a signed int intermediate value to avoid catastrophic
30524 failures due to comparison between signed and unsigned, when
30525 y0 or y1 is negative (can happen for tall images). */
30526 int r_bottom
= r
.y
+ r
.height
;
30528 /* Update lines intersecting rectangle R. */
30529 first_overlapping_row
= last_overlapping_row
= NULL
;
30530 for (row
= w
->current_matrix
->rows
;
30535 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30537 if ((y0
>= r
.y
&& y0
< r_bottom
)
30538 || (y1
> r
.y
&& y1
< r_bottom
)
30539 || (r
.y
>= y0
&& r
.y
< y1
)
30540 || (r_bottom
> y0
&& r_bottom
< y1
))
30542 /* A header line may be overlapping, but there is no need
30543 to fix overlapping areas for them. KFS 2005-02-12 */
30544 if (row
->overlapping_p
&& !row
->mode_line_p
)
30546 if (first_overlapping_row
== NULL
)
30547 first_overlapping_row
= row
;
30548 last_overlapping_row
= row
;
30552 if (expose_line (w
, row
, &r
))
30553 mouse_face_overwritten_p
= true;
30556 else if (row
->overlapping_p
)
30558 /* We must redraw a row overlapping the exposed area. */
30560 ? y0
+ row
->phys_height
> r
.y
30561 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30563 if (first_overlapping_row
== NULL
)
30564 first_overlapping_row
= row
;
30565 last_overlapping_row
= row
;
30573 /* Display the mode line if there is one. */
30574 if (WINDOW_WANTS_MODELINE_P (w
)
30575 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30577 && row
->y
< r_bottom
)
30579 if (expose_line (w
, row
, &r
))
30580 mouse_face_overwritten_p
= true;
30583 if (!w
->pseudo_window_p
)
30585 /* Fix the display of overlapping rows. */
30586 if (first_overlapping_row
)
30587 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30590 /* Draw border between windows. */
30591 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30592 x_draw_right_divider (w
);
30594 x_draw_vertical_border (w
);
30596 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30597 x_draw_bottom_divider (w
);
30599 /* Turn the cursor on again. */
30600 if (cursor_cleared_p
30601 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30602 update_window_cursor (w
, true);
30606 return mouse_face_overwritten_p
;
30611 /* Redraw (parts) of all windows in the window tree rooted at W that
30612 intersect R. R contains frame pixel coordinates. Value is
30613 true if the exposure overwrites mouse-face. */
30616 expose_window_tree (struct window
*w
, XRectangle
*r
)
30618 struct frame
*f
= XFRAME (w
->frame
);
30619 bool mouse_face_overwritten_p
= false;
30621 while (w
&& !FRAME_GARBAGED_P (f
))
30623 mouse_face_overwritten_p
30624 |= (WINDOWP (w
->contents
)
30625 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30626 : expose_window (w
, r
));
30628 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30631 return mouse_face_overwritten_p
;
30636 Redisplay an exposed area of frame F. X and Y are the upper-left
30637 corner of the exposed rectangle. W and H are width and height of
30638 the exposed area. All are pixel values. W or H zero means redraw
30639 the entire frame. */
30642 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30645 bool mouse_face_overwritten_p
= false;
30647 TRACE ((stderr
, "expose_frame "));
30649 /* No need to redraw if frame will be redrawn soon. */
30650 if (FRAME_GARBAGED_P (f
))
30652 TRACE ((stderr
, " garbaged\n"));
30656 /* If basic faces haven't been realized yet, there is no point in
30657 trying to redraw anything. This can happen when we get an expose
30658 event while Emacs is starting, e.g. by moving another window. */
30659 if (FRAME_FACE_CACHE (f
) == NULL
30660 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30662 TRACE ((stderr
, " no faces\n"));
30666 if (w
== 0 || h
== 0)
30669 r
.width
= FRAME_TEXT_WIDTH (f
);
30670 r
.height
= FRAME_TEXT_HEIGHT (f
);
30680 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30681 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30683 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30684 if (WINDOWP (f
->tool_bar_window
))
30685 mouse_face_overwritten_p
30686 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30689 #ifdef HAVE_X_WINDOWS
30691 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30692 if (WINDOWP (f
->menu_bar_window
))
30693 mouse_face_overwritten_p
30694 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30695 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30699 /* Some window managers support a focus-follows-mouse style with
30700 delayed raising of frames. Imagine a partially obscured frame,
30701 and moving the mouse into partially obscured mouse-face on that
30702 frame. The visible part of the mouse-face will be highlighted,
30703 then the WM raises the obscured frame. With at least one WM, KDE
30704 2.1, Emacs is not getting any event for the raising of the frame
30705 (even tried with SubstructureRedirectMask), only Expose events.
30706 These expose events will draw text normally, i.e. not
30707 highlighted. Which means we must redo the highlight here.
30708 Subsume it under ``we love X''. --gerd 2001-08-15 */
30709 /* Included in Windows version because Windows most likely does not
30710 do the right thing if any third party tool offers
30711 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30712 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30714 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30715 if (f
== hlinfo
->mouse_face_mouse_frame
)
30717 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30718 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30719 clear_mouse_face (hlinfo
);
30720 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30727 Determine the intersection of two rectangles R1 and R2. Return
30728 the intersection in *RESULT. Value is true if RESULT is not
30732 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30734 XRectangle
*left
, *right
;
30735 XRectangle
*upper
, *lower
;
30736 bool intersection_p
= false;
30738 /* Rearrange so that R1 is the left-most rectangle. */
30740 left
= r1
, right
= r2
;
30742 left
= r2
, right
= r1
;
30744 /* X0 of the intersection is right.x0, if this is inside R1,
30745 otherwise there is no intersection. */
30746 if (right
->x
<= left
->x
+ left
->width
)
30748 result
->x
= right
->x
;
30750 /* The right end of the intersection is the minimum of
30751 the right ends of left and right. */
30752 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30755 /* Same game for Y. */
30757 upper
= r1
, lower
= r2
;
30759 upper
= r2
, lower
= r1
;
30761 /* The upper end of the intersection is lower.y0, if this is inside
30762 of upper. Otherwise, there is no intersection. */
30763 if (lower
->y
<= upper
->y
+ upper
->height
)
30765 result
->y
= lower
->y
;
30767 /* The lower end of the intersection is the minimum of the lower
30768 ends of upper and lower. */
30769 result
->height
= (min (lower
->y
+ lower
->height
,
30770 upper
->y
+ upper
->height
)
30772 intersection_p
= true;
30776 return intersection_p
;
30779 #endif /* HAVE_WINDOW_SYSTEM */
30782 /***********************************************************************
30784 ***********************************************************************/
30787 syms_of_xdisp (void)
30789 Vwith_echo_area_save_vector
= Qnil
;
30790 staticpro (&Vwith_echo_area_save_vector
);
30792 Vmessage_stack
= Qnil
;
30793 staticpro (&Vmessage_stack
);
30795 /* Non-nil means don't actually do any redisplay. */
30796 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30798 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30800 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30801 doc
: /* Non-nil means calls to `message' are not displayed.
30802 They are still logged to the *Messages* buffer. */);
30803 inhibit_message
= 0;
30805 message_dolog_marker1
= Fmake_marker ();
30806 staticpro (&message_dolog_marker1
);
30807 message_dolog_marker2
= Fmake_marker ();
30808 staticpro (&message_dolog_marker2
);
30809 message_dolog_marker3
= Fmake_marker ();
30810 staticpro (&message_dolog_marker3
);
30813 defsubr (&Sdump_frame_glyph_matrix
);
30814 defsubr (&Sdump_glyph_matrix
);
30815 defsubr (&Sdump_glyph_row
);
30816 defsubr (&Sdump_tool_bar_row
);
30817 defsubr (&Strace_redisplay
);
30818 defsubr (&Strace_to_stderr
);
30820 #ifdef HAVE_WINDOW_SYSTEM
30821 defsubr (&Stool_bar_height
);
30822 defsubr (&Slookup_image_map
);
30824 defsubr (&Sline_pixel_height
);
30825 defsubr (&Sformat_mode_line
);
30826 defsubr (&Sinvisible_p
);
30827 defsubr (&Scurrent_bidi_paragraph_direction
);
30828 defsubr (&Swindow_text_pixel_size
);
30829 defsubr (&Smove_point_visually
);
30830 defsubr (&Sbidi_find_overridden_directionality
);
30832 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30833 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30834 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30835 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30836 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30837 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30838 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30839 DEFSYM (Qeval
, "eval");
30840 DEFSYM (QCdata
, ":data");
30842 /* Names of text properties relevant for redisplay. */
30843 DEFSYM (Qdisplay
, "display");
30844 DEFSYM (Qspace_width
, "space-width");
30845 DEFSYM (Qraise
, "raise");
30846 DEFSYM (Qslice
, "slice");
30847 DEFSYM (Qspace
, "space");
30848 DEFSYM (Qmargin
, "margin");
30849 DEFSYM (Qpointer
, "pointer");
30850 DEFSYM (Qleft_margin
, "left-margin");
30851 DEFSYM (Qright_margin
, "right-margin");
30852 DEFSYM (Qcenter
, "center");
30853 DEFSYM (Qline_height
, "line-height");
30854 DEFSYM (QCalign_to
, ":align-to");
30855 DEFSYM (QCrelative_width
, ":relative-width");
30856 DEFSYM (QCrelative_height
, ":relative-height");
30857 DEFSYM (QCeval
, ":eval");
30858 DEFSYM (QCpropertize
, ":propertize");
30859 DEFSYM (QCfile
, ":file");
30860 DEFSYM (Qfontified
, "fontified");
30861 DEFSYM (Qfontification_functions
, "fontification-functions");
30863 /* Name of the face used to highlight trailing whitespace. */
30864 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30866 /* Name and number of the face used to highlight escape glyphs. */
30867 DEFSYM (Qescape_glyph
, "escape-glyph");
30869 /* Name and number of the face used to highlight non-breaking spaces. */
30870 DEFSYM (Qnobreak_space
, "nobreak-space");
30872 /* The symbol 'image' which is the car of the lists used to represent
30873 images in Lisp. Also a tool bar style. */
30874 DEFSYM (Qimage
, "image");
30876 /* Tool bar styles. */
30877 DEFSYM (Qtext
, "text");
30878 DEFSYM (Qboth
, "both");
30879 DEFSYM (Qboth_horiz
, "both-horiz");
30880 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30882 /* The image map types. */
30883 DEFSYM (QCmap
, ":map");
30884 DEFSYM (QCpointer
, ":pointer");
30885 DEFSYM (Qrect
, "rect");
30886 DEFSYM (Qcircle
, "circle");
30887 DEFSYM (Qpoly
, "poly");
30889 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30891 DEFSYM (Qgrow_only
, "grow-only");
30892 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30893 DEFSYM (Qposition
, "position");
30894 DEFSYM (Qbuffer_position
, "buffer-position");
30895 DEFSYM (Qobject
, "object");
30897 /* Cursor shapes. */
30898 DEFSYM (Qbar
, "bar");
30899 DEFSYM (Qhbar
, "hbar");
30900 DEFSYM (Qbox
, "box");
30901 DEFSYM (Qhollow
, "hollow");
30903 /* Pointer shapes. */
30904 DEFSYM (Qhand
, "hand");
30905 DEFSYM (Qarrow
, "arrow");
30908 DEFSYM (Qdragging
, "dragging");
30910 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30912 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30913 staticpro (&list_of_error
);
30915 /* Values of those variables at last redisplay are stored as
30916 properties on 'overlay-arrow-position' symbol. However, if
30917 Voverlay_arrow_position is a marker, last-arrow-position is its
30918 numerical position. */
30919 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30920 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30922 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30923 properties on a symbol in overlay-arrow-variable-list. */
30924 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30925 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30927 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30928 staticpro (&echo_buffer
[0]);
30929 staticpro (&echo_buffer
[1]);
30931 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30932 staticpro (&echo_area_buffer
[0]);
30933 staticpro (&echo_area_buffer
[1]);
30935 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30936 staticpro (&Vmessages_buffer_name
);
30938 mode_line_proptrans_alist
= Qnil
;
30939 staticpro (&mode_line_proptrans_alist
);
30940 mode_line_string_list
= Qnil
;
30941 staticpro (&mode_line_string_list
);
30942 mode_line_string_face
= Qnil
;
30943 staticpro (&mode_line_string_face
);
30944 mode_line_string_face_prop
= Qnil
;
30945 staticpro (&mode_line_string_face_prop
);
30946 Vmode_line_unwind_vector
= Qnil
;
30947 staticpro (&Vmode_line_unwind_vector
);
30949 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30951 help_echo_string
= Qnil
;
30952 staticpro (&help_echo_string
);
30953 help_echo_object
= Qnil
;
30954 staticpro (&help_echo_object
);
30955 help_echo_window
= Qnil
;
30956 staticpro (&help_echo_window
);
30957 previous_help_echo_string
= Qnil
;
30958 staticpro (&previous_help_echo_string
);
30959 help_echo_pos
= -1;
30961 DEFSYM (Qright_to_left
, "right-to-left");
30962 DEFSYM (Qleft_to_right
, "left-to-right");
30963 defsubr (&Sbidi_resolved_levels
);
30965 #ifdef HAVE_WINDOW_SYSTEM
30966 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30967 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30968 For example, if a block cursor is over a tab, it will be drawn as
30969 wide as that tab on the display. */);
30970 x_stretch_cursor_p
= 0;
30973 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30974 doc
: /* Non-nil means highlight trailing whitespace.
30975 The face used for trailing whitespace is `trailing-whitespace'. */);
30976 Vshow_trailing_whitespace
= Qnil
;
30978 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30979 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30980 If the value is t, Emacs highlights non-ASCII chars which have the
30981 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30982 or `escape-glyph' face respectively.
30984 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30985 U+2011 (non-breaking hyphen) are affected.
30987 Any other non-nil value means to display these characters as a escape
30988 glyph followed by an ordinary space or hyphen.
30990 A value of nil means no special handling of these characters. */);
30991 Vnobreak_char_display
= Qt
;
30993 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30994 doc
: /* The pointer shape to show in void text areas.
30995 A value of nil means to show the text pointer. Other options are
30996 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30998 Vvoid_text_area_pointer
= Qarrow
;
31000 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31001 doc
: /* Non-nil means don't actually do any redisplay.
31002 This is used for internal purposes. */);
31003 Vinhibit_redisplay
= Qnil
;
31005 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31006 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31007 Vglobal_mode_string
= Qnil
;
31009 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31010 doc
: /* Marker for where to display an arrow on top of the buffer text.
31011 This must be the beginning of a line in order to work.
31012 See also `overlay-arrow-string'. */);
31013 Voverlay_arrow_position
= Qnil
;
31015 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31016 doc
: /* String to display as an arrow in non-window frames.
31017 See also `overlay-arrow-position'. */);
31018 Voverlay_arrow_string
= build_pure_c_string ("=>");
31020 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31021 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31022 The symbols on this list are examined during redisplay to determine
31023 where to display overlay arrows. */);
31024 Voverlay_arrow_variable_list
31025 = list1 (intern_c_string ("overlay-arrow-position"));
31027 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31028 doc
: /* The number of lines to try scrolling a window by when point moves out.
31029 If that fails to bring point back on frame, point is centered instead.
31030 If this is zero, point is always centered after it moves off frame.
31031 If you want scrolling to always be a line at a time, you should set
31032 `scroll-conservatively' to a large value rather than set this to 1. */);
31034 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31035 doc
: /* Scroll up to this many lines, to bring point back on screen.
31036 If point moves off-screen, redisplay will scroll by up to
31037 `scroll-conservatively' lines in order to bring point just barely
31038 onto the screen again. If that cannot be done, then redisplay
31039 recenters point as usual.
31041 If the value is greater than 100, redisplay will never recenter point,
31042 but will always scroll just enough text to bring point into view, even
31043 if you move far away.
31045 A value of zero means always recenter point if it moves off screen. */);
31046 scroll_conservatively
= 0;
31048 DEFVAR_INT ("scroll-margin", scroll_margin
,
31049 doc
: /* Number of lines of margin at the top and bottom of a window.
31050 Recenter the window whenever point gets within this many lines
31051 of the top or bottom of the window. */);
31054 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31055 doc
: /* Pixels per inch value for non-window system displays.
31056 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31057 Vdisplay_pixels_per_inch
= make_float (72.0);
31060 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31063 DEFVAR_LISP ("truncate-partial-width-windows",
31064 Vtruncate_partial_width_windows
,
31065 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31066 For an integer value, truncate lines in each window narrower than the
31067 full frame width, provided the window width is less than that integer;
31068 otherwise, respect the value of `truncate-lines'.
31070 For any other non-nil value, truncate lines in all windows that do
31071 not span the full frame width.
31073 A value of nil means to respect the value of `truncate-lines'.
31075 If `word-wrap' is enabled, you might want to reduce this. */);
31076 Vtruncate_partial_width_windows
= make_number (50);
31078 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31079 doc
: /* Maximum buffer size for which line number should be displayed.
31080 If the buffer is bigger than this, the line number does not appear
31081 in the mode line. A value of nil means no limit. */);
31082 Vline_number_display_limit
= Qnil
;
31084 DEFVAR_INT ("line-number-display-limit-width",
31085 line_number_display_limit_width
,
31086 doc
: /* Maximum line width (in characters) for line number display.
31087 If the average length of the lines near point is bigger than this, then the
31088 line number may be omitted from the mode line. */);
31089 line_number_display_limit_width
= 200;
31091 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31092 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31093 highlight_nonselected_windows
= false;
31095 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31096 doc
: /* Non-nil if more than one frame is visible on this display.
31097 Minibuffer-only frames don't count, but iconified frames do.
31098 This variable is not guaranteed to be accurate except while processing
31099 `frame-title-format' and `icon-title-format'. */);
31101 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31102 doc
: /* Template for displaying the title bar of visible frames.
31103 (Assuming the window manager supports this feature.)
31105 This variable has the same structure as `mode-line-format', except that
31106 the %c and %l constructs are ignored. It is used only on frames for
31107 which no explicit name has been set (see `modify-frame-parameters'). */);
31109 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31110 doc
: /* Template for displaying the title bar of an iconified frame.
31111 (Assuming the window manager supports this feature.)
31112 This variable has the same structure as `mode-line-format' (which see),
31113 and is used only on frames for which no explicit name has been set
31114 (see `modify-frame-parameters'). */);
31116 = Vframe_title_format
31117 = listn (CONSTYPE_PURE
, 3,
31118 intern_c_string ("multiple-frames"),
31119 build_pure_c_string ("%b"),
31120 listn (CONSTYPE_PURE
, 4,
31121 empty_unibyte_string
,
31122 intern_c_string ("invocation-name"),
31123 build_pure_c_string ("@"),
31124 intern_c_string ("system-name")));
31126 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31127 doc
: /* Maximum number of lines to keep in the message log buffer.
31128 If nil, disable message logging. If t, log messages but don't truncate
31129 the buffer when it becomes large. */);
31130 Vmessage_log_max
= make_number (1000);
31132 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31133 doc
: /* Functions called before redisplay, if window sizes have changed.
31134 The value should be a list of functions that take one argument.
31135 Just before redisplay, for each frame, if any of its windows have changed
31136 size since the last redisplay, or have been split or deleted,
31137 all the functions in the list are called, with the frame as argument. */);
31138 Vwindow_size_change_functions
= Qnil
;
31140 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31141 doc
: /* List of functions to call before redisplaying a window with scrolling.
31142 Each function is called with two arguments, the window and its new
31143 display-start position.
31144 These functions are called whenever the `window-start' marker is modified,
31145 either to point into another buffer (e.g. via `set-window-buffer') or another
31146 place in the same buffer.
31147 Note that the value of `window-end' is not valid when these functions are
31150 Warning: Do not use this feature to alter the way the window
31151 is scrolled. It is not designed for that, and such use probably won't
31153 Vwindow_scroll_functions
= Qnil
;
31155 DEFVAR_LISP ("window-text-change-functions",
31156 Vwindow_text_change_functions
,
31157 doc
: /* Functions to call in redisplay when text in the window might change. */);
31158 Vwindow_text_change_functions
= Qnil
;
31160 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31161 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31162 Each function is called with two arguments, the window and the end trigger value.
31163 See `set-window-redisplay-end-trigger'. */);
31164 Vredisplay_end_trigger_functions
= Qnil
;
31166 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31167 doc
: /* Non-nil means autoselect window with mouse pointer.
31168 If nil, do not autoselect windows.
31169 A positive number means delay autoselection by that many seconds: a
31170 window is autoselected only after the mouse has remained in that
31171 window for the duration of the delay.
31172 A negative number has a similar effect, but causes windows to be
31173 autoselected only after the mouse has stopped moving. (Because of
31174 the way Emacs compares mouse events, you will occasionally wait twice
31175 that time before the window gets selected.)
31176 Any other value means to autoselect window instantaneously when the
31177 mouse pointer enters it.
31179 Autoselection selects the minibuffer only if it is active, and never
31180 unselects the minibuffer if it is active.
31182 When customizing this variable make sure that the actual value of
31183 `focus-follows-mouse' matches the behavior of your window manager. */);
31184 Vmouse_autoselect_window
= Qnil
;
31186 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31187 doc
: /* Non-nil means automatically resize tool-bars.
31188 This dynamically changes the tool-bar's height to the minimum height
31189 that is needed to make all tool-bar items visible.
31190 If value is `grow-only', the tool-bar's height is only increased
31191 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31192 Vauto_resize_tool_bars
= Qt
;
31194 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31195 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31196 auto_raise_tool_bar_buttons_p
= true;
31198 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31199 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31200 make_cursor_line_fully_visible_p
= true;
31202 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31203 doc
: /* Border below tool-bar in pixels.
31204 If an integer, use it as the height of the border.
31205 If it is one of `internal-border-width' or `border-width', use the
31206 value of the corresponding frame parameter.
31207 Otherwise, no border is added below the tool-bar. */);
31208 Vtool_bar_border
= Qinternal_border_width
;
31210 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31211 doc
: /* Margin around tool-bar buttons in pixels.
31212 If an integer, use that for both horizontal and vertical margins.
31213 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31214 HORZ specifying the horizontal margin, and VERT specifying the
31215 vertical margin. */);
31216 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31218 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31219 doc
: /* Relief thickness of tool-bar buttons. */);
31220 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31222 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31223 doc
: /* Tool bar style to use.
31225 image - show images only
31226 text - show text only
31227 both - show both, text below image
31228 both-horiz - show text to the right of the image
31229 text-image-horiz - show text to the left of the image
31230 any other - use system default or image if no system default.
31232 This variable only affects the GTK+ toolkit version of Emacs. */);
31233 Vtool_bar_style
= Qnil
;
31235 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31236 doc
: /* Maximum number of characters a label can have to be shown.
31237 The tool bar style must also show labels for this to have any effect, see
31238 `tool-bar-style'. */);
31239 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31241 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31242 doc
: /* List of functions to call to fontify regions of text.
31243 Each function is called with one argument POS. Functions must
31244 fontify a region starting at POS in the current buffer, and give
31245 fontified regions the property `fontified'. */);
31246 Vfontification_functions
= Qnil
;
31247 Fmake_variable_buffer_local (Qfontification_functions
);
31249 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31250 unibyte_display_via_language_environment
,
31251 doc
: /* Non-nil means display unibyte text according to language environment.
31252 Specifically, this means that raw bytes in the range 160-255 decimal
31253 are displayed by converting them to the equivalent multibyte characters
31254 according to the current language environment. As a result, they are
31255 displayed according to the current fontset.
31257 Note that this variable affects only how these bytes are displayed,
31258 but does not change the fact they are interpreted as raw bytes. */);
31259 unibyte_display_via_language_environment
= false;
31261 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31262 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31263 If a float, it specifies a fraction of the mini-window frame's height.
31264 If an integer, it specifies a number of lines. */);
31265 Vmax_mini_window_height
= make_float (0.25);
31267 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31268 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31269 A value of nil means don't automatically resize mini-windows.
31270 A value of t means resize them to fit the text displayed in them.
31271 A value of `grow-only', the default, means let mini-windows grow only;
31272 they return to their normal size when the minibuffer is closed, or the
31273 echo area becomes empty. */);
31274 Vresize_mini_windows
= Qgrow_only
;
31276 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31277 doc
: /* Alist specifying how to blink the cursor off.
31278 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31279 `cursor-type' frame-parameter or variable equals ON-STATE,
31280 comparing using `equal', Emacs uses OFF-STATE to specify
31281 how to blink it off. ON-STATE and OFF-STATE are values for
31282 the `cursor-type' frame parameter.
31284 If a frame's ON-STATE has no entry in this list,
31285 the frame's other specifications determine how to blink the cursor off. */);
31286 Vblink_cursor_alist
= Qnil
;
31288 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31289 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31290 If non-nil, windows are automatically scrolled horizontally to make
31291 point visible. */);
31292 automatic_hscrolling_p
= true;
31293 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31295 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31296 doc
: /* How many columns away from the window edge point is allowed to get
31297 before automatic hscrolling will horizontally scroll the window. */);
31298 hscroll_margin
= 5;
31300 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31301 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31302 When point is less than `hscroll-margin' columns from the window
31303 edge, automatic hscrolling will scroll the window by the amount of columns
31304 determined by this variable. If its value is a positive integer, scroll that
31305 many columns. If it's a positive floating-point number, it specifies the
31306 fraction of the window's width to scroll. If it's nil or zero, point will be
31307 centered horizontally after the scroll. Any other value, including negative
31308 numbers, are treated as if the value were zero.
31310 Automatic hscrolling always moves point outside the scroll margin, so if
31311 point was more than scroll step columns inside the margin, the window will
31312 scroll more than the value given by the scroll step.
31314 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31315 and `scroll-right' overrides this variable's effect. */);
31316 Vhscroll_step
= make_number (0);
31318 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31319 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31320 Bind this around calls to `message' to let it take effect. */);
31321 message_truncate_lines
= false;
31323 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31324 doc
: /* Normal hook run to update the menu bar definitions.
31325 Redisplay runs this hook before it redisplays the menu bar.
31326 This is used to update menus such as Buffers, whose contents depend on
31328 Vmenu_bar_update_hook
= Qnil
;
31330 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31331 doc
: /* Frame for which we are updating a menu.
31332 The enable predicate for a menu binding should check this variable. */);
31333 Vmenu_updating_frame
= Qnil
;
31335 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31336 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31337 inhibit_menubar_update
= false;
31339 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31340 doc
: /* Prefix prepended to all continuation lines at display time.
31341 The value may be a string, an image, or a stretch-glyph; it is
31342 interpreted in the same way as the value of a `display' text property.
31344 This variable is overridden by any `wrap-prefix' text or overlay
31347 To add a prefix to non-continuation lines, use `line-prefix'. */);
31348 Vwrap_prefix
= Qnil
;
31349 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31350 Fmake_variable_buffer_local (Qwrap_prefix
);
31352 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31353 doc
: /* Prefix prepended to all non-continuation lines at display time.
31354 The value may be a string, an image, or a stretch-glyph; it is
31355 interpreted in the same way as the value of a `display' text property.
31357 This variable is overridden by any `line-prefix' text or overlay
31360 To add a prefix to continuation lines, use `wrap-prefix'. */);
31361 Vline_prefix
= Qnil
;
31362 DEFSYM (Qline_prefix
, "line-prefix");
31363 Fmake_variable_buffer_local (Qline_prefix
);
31365 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31366 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31367 inhibit_eval_during_redisplay
= false;
31369 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31370 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31371 inhibit_free_realized_faces
= false;
31373 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31374 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31375 Intended for use during debugging and for testing bidi display;
31376 see biditest.el in the test suite. */);
31377 inhibit_bidi_mirroring
= false;
31380 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31381 doc
: /* Inhibit try_window_id display optimization. */);
31382 inhibit_try_window_id
= false;
31384 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31385 doc
: /* Inhibit try_window_reusing display optimization. */);
31386 inhibit_try_window_reusing
= false;
31388 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31389 doc
: /* Inhibit try_cursor_movement display optimization. */);
31390 inhibit_try_cursor_movement
= false;
31391 #endif /* GLYPH_DEBUG */
31393 DEFVAR_INT ("overline-margin", overline_margin
,
31394 doc
: /* Space between overline and text, in pixels.
31395 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31396 margin to the character height. */);
31397 overline_margin
= 2;
31399 DEFVAR_INT ("underline-minimum-offset",
31400 underline_minimum_offset
,
31401 doc
: /* Minimum distance between baseline and underline.
31402 This can improve legibility of underlined text at small font sizes,
31403 particularly when using variable `x-use-underline-position-properties'
31404 with fonts that specify an UNDERLINE_POSITION relatively close to the
31405 baseline. The default value is 1. */);
31406 underline_minimum_offset
= 1;
31408 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31409 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31410 This feature only works when on a window system that can change
31411 cursor shapes. */);
31412 display_hourglass_p
= true;
31414 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31415 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31416 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31418 #ifdef HAVE_WINDOW_SYSTEM
31419 hourglass_atimer
= NULL
;
31420 hourglass_shown_p
= false;
31421 #endif /* HAVE_WINDOW_SYSTEM */
31423 /* Name of the face used to display glyphless characters. */
31424 DEFSYM (Qglyphless_char
, "glyphless-char");
31426 /* Method symbols for Vglyphless_char_display. */
31427 DEFSYM (Qhex_code
, "hex-code");
31428 DEFSYM (Qempty_box
, "empty-box");
31429 DEFSYM (Qthin_space
, "thin-space");
31430 DEFSYM (Qzero_width
, "zero-width");
31432 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31433 doc
: /* Function run just before redisplay.
31434 It is called with one argument, which is the set of windows that are to
31435 be redisplayed. This set can be nil (meaning, only the selected window),
31436 or t (meaning all windows). */);
31437 Vpre_redisplay_function
= intern ("ignore");
31439 /* Symbol for the purpose of Vglyphless_char_display. */
31440 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31441 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31443 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31444 doc
: /* Char-table defining glyphless characters.
31445 Each element, if non-nil, should be one of the following:
31446 an ASCII acronym string: display this string in a box
31447 `hex-code': display the hexadecimal code of a character in a box
31448 `empty-box': display as an empty box
31449 `thin-space': display as 1-pixel width space
31450 `zero-width': don't display
31451 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31452 display method for graphical terminals and text terminals respectively.
31453 GRAPHICAL and TEXT should each have one of the values listed above.
31455 The char-table has one extra slot to control the display of a character for
31456 which no font is found. This slot only takes effect on graphical terminals.
31457 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31458 `thin-space'. The default is `empty-box'.
31460 If a character has a non-nil entry in an active display table, the
31461 display table takes effect; in this case, Emacs does not consult
31462 `glyphless-char-display' at all. */);
31463 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31464 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31467 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31468 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31469 Vdebug_on_message
= Qnil
;
31471 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31473 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31475 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31477 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31479 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31480 doc
: /* A list of variables changes to which trigger a thorough redisplay. */);
31481 Vredisplay__variables
= Qnil
;
31485 /* Initialize this module when Emacs starts. */
31490 CHARPOS (this_line_start_pos
) = 0;
31492 if (!noninteractive
)
31494 struct window
*m
= XWINDOW (minibuf_window
);
31495 Lisp_Object frame
= m
->frame
;
31496 struct frame
*f
= XFRAME (frame
);
31497 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31498 struct window
*r
= XWINDOW (root
);
31501 echo_area_window
= minibuf_window
;
31503 r
->top_line
= FRAME_TOP_MARGIN (f
);
31504 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31505 r
->total_cols
= FRAME_COLS (f
);
31506 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31507 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31508 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31510 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31511 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31512 m
->total_cols
= FRAME_COLS (f
);
31513 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31514 m
->total_lines
= 1;
31515 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31517 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31518 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31519 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31521 /* The default ellipsis glyphs `...'. */
31522 for (i
= 0; i
< 3; ++i
)
31523 default_invis_vector
[i
] = make_number ('.');
31527 /* Allocate the buffer for frame titles.
31528 Also used for `format-mode-line'. */
31530 mode_line_noprop_buf
= xmalloc (size
);
31531 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31532 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31533 mode_line_target
= MODE_LINE_DISPLAY
;
31536 help_echo_showing_p
= false;
31539 #ifdef HAVE_WINDOW_SYSTEM
31541 /* Platform-independent portion of hourglass implementation. */
31543 /* Timer function of hourglass_atimer. */
31546 show_hourglass (struct atimer
*timer
)
31548 /* The timer implementation will cancel this timer automatically
31549 after this function has run. Set hourglass_atimer to null
31550 so that we know the timer doesn't have to be canceled. */
31551 hourglass_atimer
= NULL
;
31553 if (!hourglass_shown_p
)
31555 Lisp_Object tail
, frame
;
31559 FOR_EACH_FRAME (tail
, frame
)
31561 struct frame
*f
= XFRAME (frame
);
31563 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31564 && FRAME_RIF (f
)->show_hourglass
)
31565 FRAME_RIF (f
)->show_hourglass (f
);
31568 hourglass_shown_p
= true;
31573 /* Cancel a currently active hourglass timer, and start a new one. */
31576 start_hourglass (void)
31578 struct timespec delay
;
31580 cancel_hourglass ();
31582 if (INTEGERP (Vhourglass_delay
)
31583 && XINT (Vhourglass_delay
) > 0)
31584 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31585 TYPE_MAXIMUM (time_t)),
31587 else if (FLOATP (Vhourglass_delay
)
31588 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31589 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31591 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31593 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31594 show_hourglass
, NULL
);
31597 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31601 cancel_hourglass (void)
31603 if (hourglass_atimer
)
31605 cancel_atimer (hourglass_atimer
);
31606 hourglass_atimer
= NULL
;
31609 if (hourglass_shown_p
)
31611 Lisp_Object tail
, frame
;
31615 FOR_EACH_FRAME (tail
, frame
)
31617 struct frame
*f
= XFRAME (frame
);
31619 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31620 && FRAME_RIF (f
)->hide_hourglass
)
31621 FRAME_RIF (f
)->hide_hourglass (f
);
31623 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31624 else if (!FRAME_W32_P (f
))
31625 w32_arrow_cursor ();
31629 hourglass_shown_p
= false;
31634 #endif /* HAVE_WINDOW_SYSTEM */