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 "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #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 /* Nonzero if we should redraw the mode lines on the next redisplay.
438 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
439 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
440 (the number used is then only used to track down the cause for this
443 int update_mode_lines
;
445 /* Nonzero if window sizes or contents other than selected-window have changed
446 since last redisplay that finished.
447 If it has value REDISPLAY_SOME, then only redisplay the windows where
448 the `redisplay' bit has been set. Otherwise, redisplay all windows
449 (the number used is then only used to track down the cause for this
452 int windows_or_buffers_changed
;
454 /* True after display_mode_line if %l was used and it displayed a
457 static bool line_number_displayed
;
459 /* The name of the *Messages* buffer, a string. */
461 static Lisp_Object Vmessages_buffer_name
;
463 /* Current, index 0, and last displayed echo area message. Either
464 buffers from echo_buffers, or nil to indicate no message. */
466 Lisp_Object echo_area_buffer
[2];
468 /* The buffers referenced from echo_area_buffer. */
470 static Lisp_Object echo_buffer
[2];
472 /* A vector saved used in with_area_buffer to reduce consing. */
474 static Lisp_Object Vwith_echo_area_save_vector
;
476 /* True means display_echo_area should display the last echo area
477 message again. Set by redisplay_preserve_echo_area. */
479 static bool display_last_displayed_message_p
;
481 /* True if echo area is being used by print; false if being used by
484 static bool message_buf_print
;
486 /* Set to true in clear_message to make redisplay_internal aware
487 of an emptied echo area. */
489 static bool message_cleared_p
;
491 /* A scratch glyph row with contents used for generating truncation
492 glyphs. Also used in direct_output_for_insert. */
494 #define MAX_SCRATCH_GLYPHS 100
495 static struct glyph_row scratch_glyph_row
;
496 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
498 /* Ascent and height of the last line processed by move_it_to. */
500 static int last_height
;
502 /* True if there's a help-echo in the echo area. */
504 bool help_echo_showing_p
;
506 /* The maximum distance to look ahead for text properties. Values
507 that are too small let us call compute_char_face and similar
508 functions too often which is expensive. Values that are too large
509 let us call compute_char_face and alike too often because we
510 might not be interested in text properties that far away. */
512 #define TEXT_PROP_DISTANCE_LIMIT 100
514 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
515 iterator state and later restore it. This is needed because the
516 bidi iterator on bidi.c keeps a stacked cache of its states, which
517 is really a singleton. When we use scratch iterator objects to
518 move around the buffer, we can cause the bidi cache to be pushed or
519 popped, and therefore we need to restore the cache state when we
520 return to the original iterator. */
521 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
524 bidi_unshelve_cache (CACHE, true); \
526 CACHE = bidi_shelve_cache (); \
529 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
531 if (pITORIG != pITCOPY) \
532 *(pITORIG) = *(pITCOPY); \
533 bidi_unshelve_cache (CACHE, false); \
537 /* Functions to mark elements as needing redisplay. */
538 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
541 redisplay_other_windows (void)
543 if (!windows_or_buffers_changed
)
544 windows_or_buffers_changed
= REDISPLAY_SOME
;
548 wset_redisplay (struct window
*w
)
550 /* Beware: selected_window can be nil during early stages. */
551 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
552 redisplay_other_windows ();
557 fset_redisplay (struct frame
*f
)
559 redisplay_other_windows ();
564 bset_redisplay (struct buffer
*b
)
566 int count
= buffer_window_count (b
);
569 /* ... it's visible in other window than selected, */
570 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
571 redisplay_other_windows ();
572 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
573 so that if we later set windows_or_buffers_changed, this buffer will
575 b
->text
->redisplay
= true;
580 bset_update_mode_line (struct buffer
*b
)
582 if (!update_mode_lines
)
583 update_mode_lines
= REDISPLAY_SOME
;
584 b
->text
->redisplay
= true;
589 /* True means print traces of redisplay if compiled with
590 GLYPH_DEBUG defined. */
592 bool trace_redisplay_p
;
594 #endif /* GLYPH_DEBUG */
596 #ifdef DEBUG_TRACE_MOVE
597 /* True means trace with TRACE_MOVE to stderr. */
598 static bool trace_move
;
600 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
602 #define TRACE_MOVE(x) (void) 0
605 /* Buffer being redisplayed -- for redisplay_window_error. */
607 static struct buffer
*displayed_buffer
;
609 /* Value returned from text property handlers (see below). */
614 HANDLED_RECOMPUTE_PROPS
,
615 HANDLED_OVERLAY_STRING_CONSUMED
,
619 /* A description of text properties that redisplay is interested
624 /* The symbol index of the name of the property. */
627 /* A unique index for the property. */
630 /* A handler function called to set up iterator IT from the property
631 at IT's current position. Value is used to steer handle_stop. */
632 enum prop_handled (*handler
) (struct it
*it
);
635 static enum prop_handled
handle_face_prop (struct it
*);
636 static enum prop_handled
handle_invisible_prop (struct it
*);
637 static enum prop_handled
handle_display_prop (struct it
*);
638 static enum prop_handled
handle_composition_prop (struct it
*);
639 static enum prop_handled
handle_overlay_change (struct it
*);
640 static enum prop_handled
handle_fontified_prop (struct it
*);
642 /* Properties handled by iterators. */
644 static struct props it_props
[] =
646 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
647 /* Handle `face' before `display' because some sub-properties of
648 `display' need to know the face. */
649 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
650 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
651 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
652 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
656 /* Value is the position described by X. If X is a marker, value is
657 the marker_position of X. Otherwise, value is X. */
659 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
661 /* Enumeration returned by some move_it_.* functions internally. */
665 /* Not used. Undefined value. */
668 /* Move ended at the requested buffer position or ZV. */
669 MOVE_POS_MATCH_OR_ZV
,
671 /* Move ended at the requested X pixel position. */
674 /* Move within a line ended at the end of a line that must be
678 /* Move within a line ended at the end of a line that would
679 be displayed truncated. */
682 /* Move within a line ended at a line end. */
686 /* This counter is used to clear the face cache every once in a while
687 in redisplay_internal. It is incremented for each redisplay.
688 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
691 #define CLEAR_FACE_CACHE_COUNT 500
692 static int clear_face_cache_count
;
694 /* Similarly for the image cache. */
696 #ifdef HAVE_WINDOW_SYSTEM
697 #define CLEAR_IMAGE_CACHE_COUNT 101
698 static int clear_image_cache_count
;
700 /* Null glyph slice */
701 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
704 /* True while redisplay_internal is in progress. */
708 /* If a string, XTread_socket generates an event to display that string.
709 (The display is done in read_char.) */
711 Lisp_Object help_echo_string
;
712 Lisp_Object help_echo_window
;
713 Lisp_Object help_echo_object
;
714 ptrdiff_t help_echo_pos
;
716 /* Temporary variable for XTread_socket. */
718 Lisp_Object previous_help_echo_string
;
720 /* Platform-independent portion of hourglass implementation. */
722 #ifdef HAVE_WINDOW_SYSTEM
724 /* True means an hourglass cursor is currently shown. */
725 static bool hourglass_shown_p
;
727 /* If non-null, an asynchronous timer that, when it expires, displays
728 an hourglass cursor on all frames. */
729 static struct atimer
*hourglass_atimer
;
731 #endif /* HAVE_WINDOW_SYSTEM */
733 /* Default number of seconds to wait before displaying an hourglass
735 #define DEFAULT_HOURGLASS_DELAY 1
737 #ifdef HAVE_WINDOW_SYSTEM
739 /* Default pixel width of `thin-space' display method. */
740 #define THIN_SPACE_WIDTH 1
742 #endif /* HAVE_WINDOW_SYSTEM */
744 /* Function prototypes. */
746 static void setup_for_ellipsis (struct it
*, int);
747 static void set_iterator_to_next (struct it
*, bool);
748 static void mark_window_display_accurate_1 (struct window
*, bool);
749 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
750 static bool cursor_row_p (struct glyph_row
*);
751 static int redisplay_mode_lines (Lisp_Object
, bool);
753 static void handle_line_prefix (struct it
*);
755 static void handle_stop_backwards (struct it
*, ptrdiff_t);
756 static void unwind_with_echo_area_buffer (Lisp_Object
);
757 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
758 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
759 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
760 static void set_message (Lisp_Object
);
761 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
762 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
763 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
764 static void unwind_redisplay (void);
765 static void extend_face_to_end_of_line (struct it
*);
766 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
767 static void push_it (struct it
*, struct text_pos
*);
768 static void iterate_out_of_display_property (struct it
*);
769 static void pop_it (struct it
*);
770 static void redisplay_internal (void);
771 static bool echo_area_display (bool);
772 static void redisplay_windows (Lisp_Object
);
773 static void redisplay_window (Lisp_Object
, bool);
774 static Lisp_Object
redisplay_window_error (Lisp_Object
);
775 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
776 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
777 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
778 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
780 static bool update_menu_bar (struct frame
*, bool, bool);
781 static bool try_window_reusing_current_matrix (struct window
*);
782 static int try_window_id (struct window
*);
783 static bool display_line (struct it
*);
784 static int display_mode_lines (struct window
*);
785 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
786 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
788 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
790 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
791 static void display_menu_bar (struct window
*);
792 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
794 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
795 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
796 static void compute_line_metrics (struct it
*);
797 static void run_redisplay_end_trigger_hook (struct it
*);
798 static bool get_overlay_strings (struct it
*, ptrdiff_t);
799 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
800 static void next_overlay_string (struct it
*);
801 static void reseat (struct it
*, struct text_pos
, bool);
802 static void reseat_1 (struct it
*, struct text_pos
, bool);
803 static bool next_element_from_display_vector (struct it
*);
804 static bool next_element_from_string (struct it
*);
805 static bool next_element_from_c_string (struct it
*);
806 static bool next_element_from_buffer (struct it
*);
807 static bool next_element_from_composition (struct it
*);
808 static bool next_element_from_image (struct it
*);
809 static bool next_element_from_stretch (struct it
*);
810 static void load_overlay_strings (struct it
*, ptrdiff_t);
811 static bool get_next_display_element (struct it
*);
812 static enum move_it_result
813 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
814 enum move_operation_enum
);
815 static void get_visually_first_element (struct it
*);
816 static void compute_stop_pos (struct it
*);
817 static int face_before_or_after_it_pos (struct it
*, bool);
818 static ptrdiff_t next_overlay_change (ptrdiff_t);
819 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
820 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
821 static int handle_single_display_spec (struct it
*, Lisp_Object
,
822 Lisp_Object
, Lisp_Object
,
823 struct text_pos
*, ptrdiff_t, int, bool);
824 static int underlying_face_id (struct it
*);
826 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
827 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
829 #ifdef HAVE_WINDOW_SYSTEM
831 static void update_tool_bar (struct frame
*, bool);
832 static void x_draw_bottom_divider (struct window
*w
);
833 static void notice_overwritten_cursor (struct window
*,
836 static void append_stretch_glyph (struct it
*, Lisp_Object
,
840 #endif /* HAVE_WINDOW_SYSTEM */
842 static void produce_special_glyphs (struct it
*, enum display_element_type
);
843 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
844 static bool coords_in_mouse_face_p (struct window
*, int, int);
848 /***********************************************************************
849 Window display dimensions
850 ***********************************************************************/
852 /* Return the bottom boundary y-position for text lines in window W.
853 This is the first y position at which a line cannot start.
854 It is relative to the top of the window.
856 This is the height of W minus the height of a mode line, if any. */
859 window_text_bottom_y (struct window
*w
)
861 int height
= WINDOW_PIXEL_HEIGHT (w
);
863 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
865 if (WINDOW_WANTS_MODELINE_P (w
))
866 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
868 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
873 /* Return the pixel width of display area AREA of window W.
874 ANY_AREA means return the total width of W, not including
875 fringes to the left and right of the window. */
878 window_box_width (struct window
*w
, enum glyph_row_area area
)
880 int width
= w
->pixel_width
;
882 if (!w
->pseudo_window_p
)
884 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
885 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
887 if (area
== TEXT_AREA
)
888 width
-= (WINDOW_MARGINS_WIDTH (w
)
889 + WINDOW_FRINGES_WIDTH (w
));
890 else if (area
== LEFT_MARGIN_AREA
)
891 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
892 else if (area
== RIGHT_MARGIN_AREA
)
893 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
896 /* With wide margins, fringes, etc. we might end up with a negative
897 width, correct that here. */
898 return max (0, width
);
902 /* Return the pixel height of the display area of window W, not
903 including mode lines of W, if any. */
906 window_box_height (struct window
*w
)
908 struct frame
*f
= XFRAME (w
->frame
);
909 int height
= WINDOW_PIXEL_HEIGHT (w
);
911 eassert (height
>= 0);
913 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
914 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
916 /* Note: the code below that determines the mode-line/header-line
917 height is essentially the same as that contained in the macro
918 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
919 the appropriate glyph row has its `mode_line_p' flag set,
920 and if it doesn't, uses estimate_mode_line_height instead. */
922 if (WINDOW_WANTS_MODELINE_P (w
))
924 struct glyph_row
*ml_row
925 = (w
->current_matrix
&& w
->current_matrix
->rows
926 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
928 if (ml_row
&& ml_row
->mode_line_p
)
929 height
-= ml_row
->height
;
931 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
934 if (WINDOW_WANTS_HEADER_LINE_P (w
))
936 struct glyph_row
*hl_row
937 = (w
->current_matrix
&& w
->current_matrix
->rows
938 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
940 if (hl_row
&& hl_row
->mode_line_p
)
941 height
-= hl_row
->height
;
943 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
946 /* With a very small font and a mode-line that's taller than
947 default, we might end up with a negative height. */
948 return max (0, height
);
951 /* Return the window-relative coordinate of the left edge of display
952 area AREA of window W. ANY_AREA means return the left edge of the
953 whole window, to the right of the left fringe of W. */
956 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
960 if (w
->pseudo_window_p
)
963 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
965 if (area
== TEXT_AREA
)
966 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
967 + window_box_width (w
, LEFT_MARGIN_AREA
));
968 else if (area
== RIGHT_MARGIN_AREA
)
969 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
970 + window_box_width (w
, LEFT_MARGIN_AREA
)
971 + window_box_width (w
, TEXT_AREA
)
972 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
974 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
975 else if (area
== LEFT_MARGIN_AREA
976 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
977 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
979 /* Don't return more than the window's pixel width. */
980 return min (x
, w
->pixel_width
);
984 /* Return the window-relative coordinate of the right edge of display
985 area AREA of window W. ANY_AREA means return the right edge of the
986 whole window, to the left of the right fringe of W. */
989 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
991 /* Don't return more than the window's pixel width. */
992 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
996 /* Return the frame-relative coordinate of the left edge of display
997 area AREA of window W. ANY_AREA means return the left edge of the
998 whole window, to the right of the left fringe of W. */
1001 window_box_left (struct window
*w
, enum glyph_row_area area
)
1003 struct frame
*f
= XFRAME (w
->frame
);
1006 if (w
->pseudo_window_p
)
1007 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1009 x
= (WINDOW_LEFT_EDGE_X (w
)
1010 + window_box_left_offset (w
, area
));
1016 /* Return the frame-relative coordinate of the right edge of display
1017 area AREA of window W. ANY_AREA means return the right edge of the
1018 whole window, to the left of the right fringe of W. */
1021 window_box_right (struct window
*w
, enum glyph_row_area area
)
1023 return window_box_left (w
, area
) + window_box_width (w
, area
);
1026 /* Get the bounding box of the display area AREA of window W, without
1027 mode lines, in frame-relative coordinates. ANY_AREA means the
1028 whole window, not including the left and right fringes of
1029 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1030 coordinates of the upper-left corner of the box. Return in
1031 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1034 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1035 int *box_y
, int *box_width
, int *box_height
)
1038 *box_width
= window_box_width (w
, area
);
1040 *box_height
= window_box_height (w
);
1042 *box_x
= window_box_left (w
, area
);
1045 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1046 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1047 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1051 #ifdef HAVE_WINDOW_SYSTEM
1053 /* Get the bounding box of the display area AREA of window W, without
1054 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1055 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1056 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1057 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1061 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1062 int *bottom_right_x
, int *bottom_right_y
)
1064 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1065 bottom_right_x
, bottom_right_y
);
1066 *bottom_right_x
+= *top_left_x
;
1067 *bottom_right_y
+= *top_left_y
;
1070 #endif /* HAVE_WINDOW_SYSTEM */
1072 /***********************************************************************
1074 ***********************************************************************/
1076 /* Return the bottom y-position of the line the iterator IT is in.
1077 This can modify IT's settings. */
1080 line_bottom_y (struct it
*it
)
1082 int line_height
= it
->max_ascent
+ it
->max_descent
;
1083 int line_top_y
= it
->current_y
;
1085 if (line_height
== 0)
1088 line_height
= last_height
;
1089 else if (IT_CHARPOS (*it
) < ZV
)
1091 move_it_by_lines (it
, 1);
1092 line_height
= (it
->max_ascent
|| it
->max_descent
1093 ? it
->max_ascent
+ it
->max_descent
1098 struct glyph_row
*row
= it
->glyph_row
;
1100 /* Use the default character height. */
1101 it
->glyph_row
= NULL
;
1102 it
->what
= IT_CHARACTER
;
1105 PRODUCE_GLYPHS (it
);
1106 line_height
= it
->ascent
+ it
->descent
;
1107 it
->glyph_row
= row
;
1111 return line_top_y
+ line_height
;
1114 DEFUN ("line-pixel-height", Fline_pixel_height
,
1115 Sline_pixel_height
, 0, 0, 0,
1116 doc
: /* Return height in pixels of text line in the selected window.
1118 Value is the height in pixels of the line at point. */)
1123 struct window
*w
= XWINDOW (selected_window
);
1124 struct buffer
*old_buffer
= NULL
;
1127 if (XBUFFER (w
->contents
) != current_buffer
)
1129 old_buffer
= current_buffer
;
1130 set_buffer_internal_1 (XBUFFER (w
->contents
));
1132 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1133 start_display (&it
, w
, pt
);
1134 it
.vpos
= it
.current_y
= 0;
1136 result
= make_number (line_bottom_y (&it
));
1138 set_buffer_internal_1 (old_buffer
);
1143 /* Return the default pixel height of text lines in window W. The
1144 value is the canonical height of the W frame's default font, plus
1145 any extra space required by the line-spacing variable or frame
1148 Implementation note: this ignores any line-spacing text properties
1149 put on the newline characters. This is because those properties
1150 only affect the _screen_ line ending in the newline (i.e., in a
1151 continued line, only the last screen line will be affected), which
1152 means only a small number of lines in a buffer can ever use this
1153 feature. Since this function is used to compute the default pixel
1154 equivalent of text lines in a window, we can safely ignore those
1155 few lines. For the same reasons, we ignore the line-height
1158 default_line_pixel_height (struct window
*w
)
1160 struct frame
*f
= WINDOW_XFRAME (w
);
1161 int height
= FRAME_LINE_HEIGHT (f
);
1163 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1165 struct buffer
*b
= XBUFFER (w
->contents
);
1166 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1169 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1172 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1173 height
+= XFASTINT (val
);
1174 else if (FLOATP (val
))
1176 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1183 height
+= f
->extra_line_spacing
;
1189 /* Subroutine of pos_visible_p below. Extracts a display string, if
1190 any, from the display spec given as its argument. */
1192 string_from_display_spec (Lisp_Object spec
)
1196 while (CONSP (spec
))
1198 if (STRINGP (XCAR (spec
)))
1203 else if (VECTORP (spec
))
1207 for (i
= 0; i
< ASIZE (spec
); i
++)
1209 if (STRINGP (AREF (spec
, i
)))
1210 return AREF (spec
, i
);
1219 /* Limit insanely large values of W->hscroll on frame F to the largest
1220 value that will still prevent first_visible_x and last_visible_x of
1221 'struct it' from overflowing an int. */
1223 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1225 ptrdiff_t window_hscroll
= w
->hscroll
;
1226 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1227 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1229 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1230 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1232 return window_hscroll
;
1235 /* Return true if position CHARPOS is visible in window W.
1236 CHARPOS < 0 means return info about WINDOW_END position.
1237 If visible, set *X and *Y to pixel coordinates of top left corner.
1238 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1239 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1242 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1243 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1246 void *itdata
= bidi_shelve_cache ();
1247 struct text_pos top
;
1248 bool visible_p
= false;
1249 struct buffer
*old_buffer
= NULL
;
1252 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1255 if (XBUFFER (w
->contents
) != current_buffer
)
1257 old_buffer
= current_buffer
;
1258 set_buffer_internal_1 (XBUFFER (w
->contents
));
1261 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1262 /* Scrolling a minibuffer window via scroll bar when the echo area
1263 shows long text sometimes resets the minibuffer contents behind
1265 if (CHARPOS (top
) > ZV
)
1266 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1268 /* Compute exact mode line heights. */
1269 if (WINDOW_WANTS_MODELINE_P (w
))
1271 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1272 BVAR (current_buffer
, mode_line_format
));
1274 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1275 w
->header_line_height
1276 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1277 BVAR (current_buffer
, header_line_format
));
1279 start_display (&it
, w
, top
);
1280 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1281 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1284 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1285 && IT_CHARPOS (it
) >= charpos
)
1286 /* When scanning backwards under bidi iteration, move_it_to
1287 stops at or _before_ CHARPOS, because it stops at or to
1288 the _right_ of the character at CHARPOS. */
1289 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1290 && IT_CHARPOS (it
) <= charpos
)))
1292 /* We have reached CHARPOS, or passed it. How the call to
1293 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1294 or covered by a display property, move_it_to stops at the end
1295 of the invisible text, to the right of CHARPOS. (ii) If
1296 CHARPOS is in a display vector, move_it_to stops on its last
1298 int top_x
= it
.current_x
;
1299 int top_y
= it
.current_y
;
1300 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1303 void *save_it_data
= NULL
;
1305 /* Calling line_bottom_y may change it.method, it.position, etc. */
1306 SAVE_IT (save_it
, it
, save_it_data
);
1308 bottom_y
= line_bottom_y (&it
);
1309 if (top_y
< window_top_y
)
1310 visible_p
= bottom_y
> window_top_y
;
1311 else if (top_y
< it
.last_visible_y
)
1313 if (bottom_y
>= it
.last_visible_y
1314 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1315 && IT_CHARPOS (it
) < charpos
)
1317 /* When the last line of the window is scanned backwards
1318 under bidi iteration, we could be duped into thinking
1319 that we have passed CHARPOS, when in fact move_it_to
1320 simply stopped short of CHARPOS because it reached
1321 last_visible_y. To see if that's what happened, we call
1322 move_it_to again with a slightly larger vertical limit,
1323 and see if it actually moved vertically; if it did, we
1324 didn't really reach CHARPOS, which is beyond window end. */
1325 /* Why 10? because we don't know how many canonical lines
1326 will the height of the next line(s) be. So we guess. */
1327 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1329 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1330 MOVE_TO_POS
| MOVE_TO_Y
);
1331 if (it
.current_y
> top_y
)
1335 RESTORE_IT (&it
, &save_it
, save_it_data
);
1338 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1340 /* We stopped on the last glyph of a display vector.
1341 Try and recompute. Hack alert! */
1342 if (charpos
< 2 || top
.charpos
>= charpos
)
1343 top_x
= it
.glyph_row
->x
;
1346 struct it it2
, it2_prev
;
1347 /* The idea is to get to the previous buffer
1348 position, consume the character there, and use
1349 the pixel coordinates we get after that. But if
1350 the previous buffer position is also displayed
1351 from a display vector, we need to consume all of
1352 the glyphs from that display vector. */
1353 start_display (&it2
, w
, top
);
1354 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1355 /* If we didn't get to CHARPOS - 1, there's some
1356 replacing display property at that position, and
1357 we stopped after it. That is exactly the place
1358 whose coordinates we want. */
1359 if (IT_CHARPOS (it2
) != charpos
- 1)
1363 /* Iterate until we get out of the display
1364 vector that displays the character at
1367 get_next_display_element (&it2
);
1368 PRODUCE_GLYPHS (&it2
);
1370 set_iterator_to_next (&it2
, true);
1371 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1372 && IT_CHARPOS (it2
) < charpos
);
1374 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1375 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1376 top_x
= it
.glyph_row
->x
;
1379 top_x
= it2_prev
.current_x
;
1380 top_y
= it2_prev
.current_y
;
1384 else if (IT_CHARPOS (it
) != charpos
)
1386 Lisp_Object cpos
= make_number (charpos
);
1387 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1388 Lisp_Object string
= string_from_display_spec (spec
);
1389 struct text_pos tpos
;
1390 bool newline_in_string
1392 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1394 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1395 bool replacing_spec_p
1397 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1398 charpos
, FRAME_WINDOW_P (it
.f
)));
1399 /* The tricky code below is needed because there's a
1400 discrepancy between move_it_to and how we set cursor
1401 when PT is at the beginning of a portion of text
1402 covered by a display property or an overlay with a
1403 display property, or the display line ends in a
1404 newline from a display string. move_it_to will stop
1405 _after_ such display strings, whereas
1406 set_cursor_from_row conspires with cursor_row_p to
1407 place the cursor on the first glyph produced from the
1410 /* We have overshoot PT because it is covered by a
1411 display property that replaces the text it covers.
1412 If the string includes embedded newlines, we are also
1413 in the wrong display line. Backtrack to the correct
1414 line, where the display property begins. */
1415 if (replacing_spec_p
)
1417 Lisp_Object startpos
, endpos
;
1418 EMACS_INT start
, end
;
1421 /* Find the first and the last buffer positions
1422 covered by the display string. */
1424 Fnext_single_char_property_change (cpos
, Qdisplay
,
1427 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1429 start
= XFASTINT (startpos
);
1430 end
= XFASTINT (endpos
);
1431 /* Move to the last buffer position before the
1432 display property. */
1433 start_display (&it3
, w
, top
);
1434 if (start
> CHARPOS (top
))
1435 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1436 /* Move forward one more line if the position before
1437 the display string is a newline or if it is the
1438 rightmost character on a line that is
1439 continued or word-wrapped. */
1440 if (it3
.method
== GET_FROM_BUFFER
1442 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1443 move_it_by_lines (&it3
, 1);
1444 else if (move_it_in_display_line_to (&it3
, -1,
1448 == MOVE_LINE_CONTINUED
)
1450 move_it_by_lines (&it3
, 1);
1451 /* When we are under word-wrap, the #$@%!
1452 move_it_by_lines moves 2 lines, so we need to
1454 if (it3
.line_wrap
== WORD_WRAP
)
1455 move_it_by_lines (&it3
, -1);
1458 /* Record the vertical coordinate of the display
1459 line where we wound up. */
1460 top_y
= it3
.current_y
;
1463 /* When characters are reordered for display,
1464 the character displayed to the left of the
1465 display string could be _after_ the display
1466 property in the logical order. Use the
1467 smallest vertical position of these two. */
1468 start_display (&it3
, w
, top
);
1469 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1470 if (it3
.current_y
< top_y
)
1471 top_y
= it3
.current_y
;
1473 /* Move from the top of the window to the beginning
1474 of the display line where the display string
1476 start_display (&it3
, w
, top
);
1477 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1478 /* If it3_moved stays false after the 'while' loop
1479 below, that means we already were at a newline
1480 before the loop (e.g., the display string begins
1481 with a newline), so we don't need to (and cannot)
1482 inspect the glyphs of it3.glyph_row, because
1483 PRODUCE_GLYPHS will not produce anything for a
1484 newline, and thus it3.glyph_row stays at its
1485 stale content it got at top of the window. */
1486 bool it3_moved
= false;
1487 /* Finally, advance the iterator until we hit the
1488 first display element whose character position is
1489 CHARPOS, or until the first newline from the
1490 display string, which signals the end of the
1492 while (get_next_display_element (&it3
))
1494 PRODUCE_GLYPHS (&it3
);
1495 if (IT_CHARPOS (it3
) == charpos
1496 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1499 set_iterator_to_next (&it3
, false);
1501 top_x
= it3
.current_x
- it3
.pixel_width
;
1502 /* Normally, we would exit the above loop because we
1503 found the display element whose character
1504 position is CHARPOS. For the contingency that we
1505 didn't, and stopped at the first newline from the
1506 display string, move back over the glyphs
1507 produced from the string, until we find the
1508 rightmost glyph not from the string. */
1510 && newline_in_string
1511 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1513 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1514 + it3
.glyph_row
->used
[TEXT_AREA
];
1516 while (EQ ((g
- 1)->object
, string
))
1519 top_x
-= g
->pixel_width
;
1521 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1522 + it3
.glyph_row
->used
[TEXT_AREA
]);
1528 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1529 *rtop
= max (0, window_top_y
- top_y
);
1530 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1531 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1532 - max (top_y
, window_top_y
)));
1534 if (it
.bidi_it
.paragraph_dir
== R2L
)
1540 /* Either we were asked to provide info about WINDOW_END, or
1541 CHARPOS is in the partially visible glyph row at end of
1544 void *it2data
= NULL
;
1546 SAVE_IT (it2
, it
, it2data
);
1547 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1548 move_it_by_lines (&it
, 1);
1549 if (charpos
< IT_CHARPOS (it
)
1550 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1553 RESTORE_IT (&it2
, &it2
, it2data
);
1554 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1556 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1557 *rtop
= max (0, -it2
.current_y
);
1558 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1559 - it
.last_visible_y
));
1560 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1562 - max (it2
.current_y
,
1563 WINDOW_HEADER_LINE_HEIGHT (w
))));
1565 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1569 bidi_unshelve_cache (it2data
, true);
1571 bidi_unshelve_cache (itdata
, false);
1574 set_buffer_internal_1 (old_buffer
);
1580 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1581 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1582 /* For lines in an R2L paragraph, we need to mirror the X pixel
1583 coordinate wrt the text area. For the reasons, see the
1584 commentary in buffer_posn_from_coords and the explanation of
1585 the geometry used by the move_it_* functions at the end of
1586 the large commentary near the beginning of this file. */
1588 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1592 /* Debugging code. */
1594 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1595 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1597 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1604 /* Return the next character from STR. Return in *LEN the length of
1605 the character. This is like STRING_CHAR_AND_LENGTH but never
1606 returns an invalid character. If we find one, we return a `?', but
1607 with the length of the invalid character. */
1610 string_char_and_length (const unsigned char *str
, int *len
)
1614 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1615 if (!CHAR_VALID_P (c
))
1616 /* We may not change the length here because other places in Emacs
1617 don't use this function, i.e. they silently accept invalid
1626 /* Given a position POS containing a valid character and byte position
1627 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1629 static struct text_pos
1630 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1632 eassert (STRINGP (string
) && nchars
>= 0);
1634 if (STRING_MULTIBYTE (string
))
1636 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1641 string_char_and_length (p
, &len
);
1644 BYTEPOS (pos
) += len
;
1648 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1654 /* Value is the text position, i.e. character and byte position,
1655 for character position CHARPOS in STRING. */
1657 static struct text_pos
1658 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1660 struct text_pos pos
;
1661 eassert (STRINGP (string
));
1662 eassert (charpos
>= 0);
1663 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1668 /* Value is a text position, i.e. character and byte position, for
1669 character position CHARPOS in C string S. MULTIBYTE_P
1670 means recognize multibyte characters. */
1672 static struct text_pos
1673 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1675 struct text_pos pos
;
1677 eassert (s
!= NULL
);
1678 eassert (charpos
>= 0);
1684 SET_TEXT_POS (pos
, 0, 0);
1687 string_char_and_length ((const unsigned char *) s
, &len
);
1690 BYTEPOS (pos
) += len
;
1694 SET_TEXT_POS (pos
, charpos
, charpos
);
1700 /* Value is the number of characters in C string S. MULTIBYTE_P
1701 means recognize multibyte characters. */
1704 number_of_chars (const char *s
, bool multibyte_p
)
1710 ptrdiff_t rest
= strlen (s
);
1712 const unsigned char *p
= (const unsigned char *) s
;
1714 for (nchars
= 0; rest
> 0; ++nchars
)
1716 string_char_and_length (p
, &len
);
1717 rest
-= len
, p
+= len
;
1721 nchars
= strlen (s
);
1727 /* Compute byte position NEWPOS->bytepos corresponding to
1728 NEWPOS->charpos. POS is a known position in string STRING.
1729 NEWPOS->charpos must be >= POS.charpos. */
1732 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1734 eassert (STRINGP (string
));
1735 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1737 if (STRING_MULTIBYTE (string
))
1738 *newpos
= string_pos_nchars_ahead (pos
, string
,
1739 CHARPOS (*newpos
) - CHARPOS (pos
));
1741 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1745 Return an estimation of the pixel height of mode or header lines on
1746 frame F. FACE_ID specifies what line's height to estimate. */
1749 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1751 #ifdef HAVE_WINDOW_SYSTEM
1752 if (FRAME_WINDOW_P (f
))
1754 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1756 /* This function is called so early when Emacs starts that the face
1757 cache and mode line face are not yet initialized. */
1758 if (FRAME_FACE_CACHE (f
))
1760 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1764 height
= FONT_HEIGHT (face
->font
);
1765 if (face
->box_line_width
> 0)
1766 height
+= 2 * face
->box_line_width
;
1777 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1778 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1779 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1780 not force the value into range. */
1783 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1784 NativeRectangle
*bounds
, bool noclip
)
1787 #ifdef HAVE_WINDOW_SYSTEM
1788 if (FRAME_WINDOW_P (f
))
1790 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1791 even for negative values. */
1793 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1795 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1797 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1798 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1801 STORE_NATIVE_RECT (*bounds
,
1802 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1803 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1804 FRAME_COLUMN_WIDTH (f
) - 1,
1805 FRAME_LINE_HEIGHT (f
) - 1);
1807 /* PXW: Should we clip pixels before converting to columns/lines? */
1812 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1813 pix_x
= FRAME_TOTAL_COLS (f
);
1817 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1818 pix_y
= FRAME_TOTAL_LINES (f
);
1828 /* Find the glyph under window-relative coordinates X/Y in window W.
1829 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1830 strings. Return in *HPOS and *VPOS the row and column number of
1831 the glyph found. Return in *AREA the glyph area containing X.
1832 Value is a pointer to the glyph found or null if X/Y is not on
1833 text, or we can't tell because W's current matrix is not up to
1836 static struct glyph
*
1837 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1838 int *dx
, int *dy
, int *area
)
1840 struct glyph
*glyph
, *end
;
1841 struct glyph_row
*row
= NULL
;
1844 /* Find row containing Y. Give up if some row is not enabled. */
1845 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1847 row
= MATRIX_ROW (w
->current_matrix
, i
);
1848 if (!row
->enabled_p
)
1850 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1857 /* Give up if Y is not in the window. */
1858 if (i
== w
->current_matrix
->nrows
)
1861 /* Get the glyph area containing X. */
1862 if (w
->pseudo_window_p
)
1869 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1871 *area
= LEFT_MARGIN_AREA
;
1872 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1874 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1877 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1881 *area
= RIGHT_MARGIN_AREA
;
1882 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1886 /* Find glyph containing X. */
1887 glyph
= row
->glyphs
[*area
];
1888 end
= glyph
+ row
->used
[*area
];
1890 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1892 x
-= glyph
->pixel_width
;
1902 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1905 *hpos
= glyph
- row
->glyphs
[*area
];
1909 /* Convert frame-relative x/y to coordinates relative to window W.
1910 Takes pseudo-windows into account. */
1913 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1915 if (w
->pseudo_window_p
)
1917 /* A pseudo-window is always full-width, and starts at the
1918 left edge of the frame, plus a frame border. */
1919 struct frame
*f
= XFRAME (w
->frame
);
1920 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1921 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1925 *x
-= WINDOW_LEFT_EDGE_X (w
);
1926 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1930 #ifdef HAVE_WINDOW_SYSTEM
1933 Return in RECTS[] at most N clipping rectangles for glyph string S.
1934 Return the number of stored rectangles. */
1937 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1944 if (s
->row
->full_width_p
)
1946 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1947 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1948 if (s
->row
->mode_line_p
)
1949 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
1951 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
1953 /* Unless displaying a mode or menu bar line, which are always
1954 fully visible, clip to the visible part of the row. */
1955 if (s
->w
->pseudo_window_p
)
1956 r
.height
= s
->row
->visible_height
;
1958 r
.height
= s
->height
;
1962 /* This is a text line that may be partially visible. */
1963 r
.x
= window_box_left (s
->w
, s
->area
);
1964 r
.width
= window_box_width (s
->w
, s
->area
);
1965 r
.height
= s
->row
->visible_height
;
1969 if (r
.x
< s
->clip_head
->x
)
1971 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1972 r
.width
-= s
->clip_head
->x
- r
.x
;
1975 r
.x
= s
->clip_head
->x
;
1978 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1980 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1981 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1986 /* If S draws overlapping rows, it's sufficient to use the top and
1987 bottom of the window for clipping because this glyph string
1988 intentionally draws over other lines. */
1989 if (s
->for_overlaps
)
1991 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1992 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1994 /* Alas, the above simple strategy does not work for the
1995 environments with anti-aliased text: if the same text is
1996 drawn onto the same place multiple times, it gets thicker.
1997 If the overlap we are processing is for the erased cursor, we
1998 take the intersection with the rectangle of the cursor. */
1999 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2001 XRectangle rc
, r_save
= r
;
2003 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2004 rc
.y
= s
->w
->phys_cursor
.y
;
2005 rc
.width
= s
->w
->phys_cursor_width
;
2006 rc
.height
= s
->w
->phys_cursor_height
;
2008 x_intersect_rectangles (&r_save
, &rc
, &r
);
2013 /* Don't use S->y for clipping because it doesn't take partially
2014 visible lines into account. For example, it can be negative for
2015 partially visible lines at the top of a window. */
2016 if (!s
->row
->full_width_p
2017 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2018 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2020 r
.y
= max (0, s
->row
->y
);
2023 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2025 /* If drawing the cursor, don't let glyph draw outside its
2026 advertised boundaries. Cleartype does this under some circumstances. */
2027 if (s
->hl
== DRAW_CURSOR
)
2029 struct glyph
*glyph
= s
->first_glyph
;
2034 if (r
.width
>= s
->x
- r
.x
)
2035 r
.width
-= s
->x
- r
.x
;
2036 else /* R2L hscrolled row with cursor outside text area */
2040 r
.width
= min (r
.width
, glyph
->pixel_width
);
2042 /* If r.y is below window bottom, ensure that we still see a cursor. */
2043 height
= min (glyph
->ascent
+ glyph
->descent
,
2044 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2045 max_y
= window_text_bottom_y (s
->w
) - height
;
2046 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2047 if (s
->ybase
- glyph
->ascent
> max_y
)
2054 /* Don't draw cursor glyph taller than our actual glyph. */
2055 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2056 if (height
< r
.height
)
2058 max_y
= r
.y
+ r
.height
;
2059 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2060 r
.height
= min (max_y
- r
.y
, height
);
2067 XRectangle r_save
= r
;
2069 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2073 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2074 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2076 #ifdef CONVERT_FROM_XRECT
2077 CONVERT_FROM_XRECT (r
, *rects
);
2085 /* If we are processing overlapping and allowed to return
2086 multiple clipping rectangles, we exclude the row of the glyph
2087 string from the clipping rectangle. This is to avoid drawing
2088 the same text on the environment with anti-aliasing. */
2089 #ifdef CONVERT_FROM_XRECT
2092 XRectangle
*rs
= rects
;
2094 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2096 if (s
->for_overlaps
& OVERLAPS_PRED
)
2099 if (r
.y
+ r
.height
> row_y
)
2102 rs
[i
].height
= row_y
- r
.y
;
2108 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2111 if (r
.y
< row_y
+ s
->row
->visible_height
)
2113 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2115 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2116 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2125 #ifdef CONVERT_FROM_XRECT
2126 for (i
= 0; i
< n
; i
++)
2127 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2134 Return in *NR the clipping rectangle for glyph string S. */
2137 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2139 get_glyph_string_clip_rects (s
, nr
, 1);
2144 Return the position and height of the phys cursor in window W.
2145 Set w->phys_cursor_width to width of phys cursor.
2149 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2150 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2152 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2153 int x
, y
, wd
, h
, h0
, y0
;
2155 /* Compute the width of the rectangle to draw. If on a stretch
2156 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2157 rectangle as wide as the glyph, but use a canonical character
2159 wd
= glyph
->pixel_width
;
2161 x
= w
->phys_cursor
.x
;
2168 if (glyph
->type
== STRETCH_GLYPH
2169 && !x_stretch_cursor_p
)
2170 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2171 w
->phys_cursor_width
= wd
;
2173 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2175 /* If y is below window bottom, ensure that we still see a cursor. */
2176 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2178 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2179 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2181 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2184 h
= max (h
- (y0
- y
) + 1, h0
);
2189 y0
= window_text_bottom_y (w
) - h0
;
2197 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2198 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2203 * Remember which glyph the mouse is over.
2207 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2211 struct glyph_row
*r
, *gr
, *end_row
;
2212 enum window_part part
;
2213 enum glyph_row_area area
;
2214 int x
, y
, width
, height
;
2216 /* Try to determine frame pixel position and size of the glyph under
2217 frame pixel coordinates X/Y on frame F. */
2219 if (window_resize_pixelwise
)
2224 else if (!f
->glyphs_initialized_p
2225 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2228 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2229 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2233 w
= XWINDOW (window
);
2234 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2235 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2237 x
= window_relative_x_coord (w
, part
, gx
);
2238 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2240 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2241 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2243 if (w
->pseudo_window_p
)
2246 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2252 case ON_LEFT_MARGIN
:
2253 area
= LEFT_MARGIN_AREA
;
2256 case ON_RIGHT_MARGIN
:
2257 area
= RIGHT_MARGIN_AREA
;
2260 case ON_HEADER_LINE
:
2262 gr
= (part
== ON_HEADER_LINE
2263 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2264 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2267 goto text_glyph_row_found
;
2274 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2275 if (r
->y
+ r
->height
> y
)
2281 text_glyph_row_found
:
2284 struct glyph
*g
= gr
->glyphs
[area
];
2285 struct glyph
*end
= g
+ gr
->used
[area
];
2287 height
= gr
->height
;
2288 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2289 if (gx
+ g
->pixel_width
> x
)
2294 if (g
->type
== IMAGE_GLYPH
)
2296 /* Don't remember when mouse is over image, as
2297 image may have hot-spots. */
2298 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2301 width
= g
->pixel_width
;
2305 /* Use nominal char spacing at end of line. */
2307 gx
+= (x
/ width
) * width
;
2310 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2312 gx
+= window_box_left_offset (w
, area
);
2313 /* Don't expand over the modeline to make sure the vertical
2314 drag cursor is shown early enough. */
2315 height
= min (height
,
2316 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2321 /* Use nominal line height at end of window. */
2322 gx
= (x
/ width
) * width
;
2324 gy
+= (y
/ height
) * height
;
2325 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2326 /* See comment above. */
2327 height
= min (height
,
2328 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2332 case ON_LEFT_FRINGE
:
2333 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2334 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2335 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2336 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2339 case ON_RIGHT_FRINGE
:
2340 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2341 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2342 : window_box_right_offset (w
, TEXT_AREA
));
2343 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2344 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2345 && !WINDOW_RIGHTMOST_P (w
))
2346 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2347 /* Make sure the vertical border can get her own glyph to the
2348 right of the one we build here. */
2349 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2351 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2353 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2357 case ON_VERTICAL_BORDER
:
2358 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2361 case ON_VERTICAL_SCROLL_BAR
:
2362 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2364 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2365 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2366 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2368 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2372 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2373 if (r
->y
+ r
->height
> y
)
2380 height
= gr
->height
;
2383 /* Use nominal line height at end of window. */
2385 gy
+= (y
/ height
) * height
;
2389 case ON_RIGHT_DIVIDER
:
2390 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2391 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2393 /* The bottom divider prevails. */
2394 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2397 case ON_BOTTOM_DIVIDER
:
2399 width
= WINDOW_PIXEL_WIDTH (w
);
2400 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2401 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2407 /* If there is no glyph under the mouse, then we divide the screen
2408 into a grid of the smallest glyph in the frame, and use that
2411 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2412 round down even for negative values. */
2418 gx
= (gx
/ width
) * width
;
2419 gy
= (gy
/ height
) * height
;
2425 gx
+= WINDOW_LEFT_EDGE_X (w
);
2426 gy
+= WINDOW_TOP_EDGE_Y (w
);
2429 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2431 /* Visible feedback for debugging. */
2432 #if false && defined HAVE_X_WINDOWS
2433 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2434 f
->output_data
.x
->normal_gc
,
2435 gx
, gy
, width
, height
);
2440 #endif /* HAVE_WINDOW_SYSTEM */
2443 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2446 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2447 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2449 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2452 /***********************************************************************
2453 Lisp form evaluation
2454 ***********************************************************************/
2456 /* Error handler for safe_eval and safe_call. */
2459 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2461 add_to_log ("Error during redisplay: %S signaled %S",
2462 Flist (nargs
, args
), arg
);
2466 /* Call function FUNC with the rest of NARGS - 1 arguments
2467 following. Return the result, or nil if something went
2468 wrong. Prevent redisplay during the evaluation. */
2471 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2475 if (inhibit_eval_during_redisplay
)
2480 ptrdiff_t count
= SPECPDL_INDEX ();
2483 SAFE_ALLOCA_LISP (args
, nargs
);
2486 for (i
= 1; i
< nargs
; i
++)
2487 args
[i
] = va_arg (ap
, Lisp_Object
);
2489 specbind (Qinhibit_redisplay
, Qt
);
2491 specbind (Qinhibit_quit
, Qt
);
2492 /* Use Qt to ensure debugger does not run,
2493 so there is no possibility of wanting to redisplay. */
2494 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2497 val
= unbind_to (count
, val
);
2504 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2509 va_start (ap
, func
);
2510 retval
= safe__call (false, nargs
, func
, ap
);
2515 /* Call function FN with one argument ARG.
2516 Return the result, or nil if something went wrong. */
2519 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2521 return safe_call (2, fn
, arg
);
2525 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2531 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2537 safe_eval (Lisp_Object sexpr
)
2539 return safe__call1 (false, Qeval
, sexpr
);
2543 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2545 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2548 /* Call function FN with two arguments ARG1 and ARG2.
2549 Return the result, or nil if something went wrong. */
2552 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2554 return safe_call (3, fn
, arg1
, arg2
);
2559 /***********************************************************************
2561 ***********************************************************************/
2563 /* Define CHECK_IT to perform sanity checks on iterators.
2564 This is for debugging. It is too slow to do unconditionally. */
2567 CHECK_IT (struct it
*it
)
2570 if (it
->method
== GET_FROM_STRING
)
2572 eassert (STRINGP (it
->string
));
2573 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2577 eassert (IT_STRING_CHARPOS (*it
) < 0);
2578 if (it
->method
== GET_FROM_BUFFER
)
2580 /* Check that character and byte positions agree. */
2581 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2586 eassert (it
->current
.dpvec_index
>= 0);
2588 eassert (it
->current
.dpvec_index
< 0);
2593 /* Check that the window end of window W is what we expect it
2594 to be---the last row in the current matrix displaying text. */
2597 CHECK_WINDOW_END (struct window
*w
)
2599 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2600 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2602 struct glyph_row
*row
;
2603 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2605 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2606 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2611 /***********************************************************************
2612 Iterator initialization
2613 ***********************************************************************/
2615 /* Initialize IT for displaying current_buffer in window W, starting
2616 at character position CHARPOS. CHARPOS < 0 means that no buffer
2617 position is specified which is useful when the iterator is assigned
2618 a position later. BYTEPOS is the byte position corresponding to
2621 If ROW is not null, calls to produce_glyphs with IT as parameter
2622 will produce glyphs in that row.
2624 BASE_FACE_ID is the id of a base face to use. It must be one of
2625 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2626 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2627 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2629 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2630 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2631 will be initialized to use the corresponding mode line glyph row of
2632 the desired matrix of W. */
2635 init_iterator (struct it
*it
, struct window
*w
,
2636 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2637 struct glyph_row
*row
, enum face_id base_face_id
)
2639 enum face_id remapped_base_face_id
= base_face_id
;
2641 /* Some precondition checks. */
2642 eassert (w
!= NULL
&& it
!= NULL
);
2643 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2646 /* If face attributes have been changed since the last redisplay,
2647 free realized faces now because they depend on face definitions
2648 that might have changed. Don't free faces while there might be
2649 desired matrices pending which reference these faces. */
2650 if (face_change
&& !inhibit_free_realized_faces
)
2652 face_change
= false;
2653 free_all_realized_faces (Qnil
);
2656 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2657 if (! NILP (Vface_remapping_alist
))
2658 remapped_base_face_id
2659 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2661 /* Use one of the mode line rows of W's desired matrix if
2665 if (base_face_id
== MODE_LINE_FACE_ID
2666 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2667 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2668 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2669 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2672 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2673 Other parts of redisplay rely on that. */
2674 memclear (it
, sizeof *it
);
2675 it
->current
.overlay_string_index
= -1;
2676 it
->current
.dpvec_index
= -1;
2677 it
->base_face_id
= remapped_base_face_id
;
2678 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2679 it
->paragraph_embedding
= L2R
;
2682 /* The window in which we iterate over current_buffer: */
2683 XSETWINDOW (it
->window
, w
);
2685 it
->f
= XFRAME (w
->frame
);
2689 /* Extra space between lines (on window systems only). */
2690 if (base_face_id
== DEFAULT_FACE_ID
2691 && FRAME_WINDOW_P (it
->f
))
2693 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2694 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2695 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2696 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2697 * FRAME_LINE_HEIGHT (it
->f
));
2698 else if (it
->f
->extra_line_spacing
> 0)
2699 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2702 /* If realized faces have been removed, e.g. because of face
2703 attribute changes of named faces, recompute them. When running
2704 in batch mode, the face cache of the initial frame is null. If
2705 we happen to get called, make a dummy face cache. */
2706 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2707 init_frame_faces (it
->f
);
2708 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2709 recompute_basic_faces (it
->f
);
2711 it
->override_ascent
= -1;
2713 /* Are control characters displayed as `^C'? */
2714 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2716 /* -1 means everything between a CR and the following line end
2717 is invisible. >0 means lines indented more than this value are
2719 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2721 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2723 : (!NILP (BVAR (current_buffer
, selective_display
))
2725 it
->selective_display_ellipsis_p
2726 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2728 /* Display table to use. */
2729 it
->dp
= window_display_table (w
);
2731 /* Are multibyte characters enabled in current_buffer? */
2732 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2734 /* Get the position at which the redisplay_end_trigger hook should
2735 be run, if it is to be run at all. */
2736 if (MARKERP (w
->redisplay_end_trigger
)
2737 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2738 it
->redisplay_end_trigger_charpos
2739 = marker_position (w
->redisplay_end_trigger
);
2740 else if (INTEGERP (w
->redisplay_end_trigger
))
2741 it
->redisplay_end_trigger_charpos
2742 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2745 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2747 /* Are lines in the display truncated? */
2749 it
->line_wrap
= TRUNCATE
;
2750 if (base_face_id
== DEFAULT_FACE_ID
2752 && (WINDOW_FULL_WIDTH_P (it
->w
)
2753 || NILP (Vtruncate_partial_width_windows
)
2754 || (INTEGERP (Vtruncate_partial_width_windows
)
2755 /* PXW: Shall we do something about this? */
2756 && (XINT (Vtruncate_partial_width_windows
)
2757 <= WINDOW_TOTAL_COLS (it
->w
))))
2758 && NILP (BVAR (current_buffer
, truncate_lines
)))
2759 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2760 ? WINDOW_WRAP
: WORD_WRAP
;
2762 /* Get dimensions of truncation and continuation glyphs. These are
2763 displayed as fringe bitmaps under X, but we need them for such
2764 frames when the fringes are turned off. But leave the dimensions
2765 zero for tooltip frames, as these glyphs look ugly there and also
2766 sabotage calculations of tooltip dimensions in x-show-tip. */
2767 #ifdef HAVE_WINDOW_SYSTEM
2768 if (!(FRAME_WINDOW_P (it
->f
)
2769 && FRAMEP (tip_frame
)
2770 && it
->f
== XFRAME (tip_frame
)))
2773 if (it
->line_wrap
== TRUNCATE
)
2775 /* We will need the truncation glyph. */
2776 eassert (it
->glyph_row
== NULL
);
2777 produce_special_glyphs (it
, IT_TRUNCATION
);
2778 it
->truncation_pixel_width
= it
->pixel_width
;
2782 /* We will need the continuation glyph. */
2783 eassert (it
->glyph_row
== NULL
);
2784 produce_special_glyphs (it
, IT_CONTINUATION
);
2785 it
->continuation_pixel_width
= it
->pixel_width
;
2789 /* Reset these values to zero because the produce_special_glyphs
2790 above has changed them. */
2791 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2792 it
->phys_ascent
= it
->phys_descent
= 0;
2794 /* Set this after getting the dimensions of truncation and
2795 continuation glyphs, so that we don't produce glyphs when calling
2796 produce_special_glyphs, above. */
2797 it
->glyph_row
= row
;
2798 it
->area
= TEXT_AREA
;
2800 /* Get the dimensions of the display area. The display area
2801 consists of the visible window area plus a horizontally scrolled
2802 part to the left of the window. All x-values are relative to the
2803 start of this total display area. */
2804 if (base_face_id
!= DEFAULT_FACE_ID
)
2806 /* Mode lines, menu bar in terminal frames. */
2807 it
->first_visible_x
= 0;
2808 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2813 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2814 it
->last_visible_x
= (it
->first_visible_x
2815 + window_box_width (w
, TEXT_AREA
));
2817 /* If we truncate lines, leave room for the truncation glyph(s) at
2818 the right margin. Otherwise, leave room for the continuation
2819 glyph(s). Done only if the window has no right fringe. */
2820 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2822 if (it
->line_wrap
== TRUNCATE
)
2823 it
->last_visible_x
-= it
->truncation_pixel_width
;
2825 it
->last_visible_x
-= it
->continuation_pixel_width
;
2828 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2829 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2832 /* Leave room for a border glyph. */
2833 if (!FRAME_WINDOW_P (it
->f
)
2834 && !WINDOW_RIGHTMOST_P (it
->w
))
2835 it
->last_visible_x
-= 1;
2837 it
->last_visible_y
= window_text_bottom_y (w
);
2839 /* For mode lines and alike, arrange for the first glyph having a
2840 left box line if the face specifies a box. */
2841 if (base_face_id
!= DEFAULT_FACE_ID
)
2845 it
->face_id
= remapped_base_face_id
;
2847 /* If we have a boxed mode line, make the first character appear
2848 with a left box line. */
2849 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2850 if (face
&& face
->box
!= FACE_NO_BOX
)
2851 it
->start_of_box_run_p
= true;
2854 /* If a buffer position was specified, set the iterator there,
2855 getting overlays and face properties from that position. */
2856 if (charpos
>= BUF_BEG (current_buffer
))
2858 it
->stop_charpos
= charpos
;
2859 it
->end_charpos
= ZV
;
2860 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2861 IT_CHARPOS (*it
) = charpos
;
2862 IT_BYTEPOS (*it
) = bytepos
;
2864 /* We will rely on `reseat' to set this up properly, via
2865 handle_face_prop. */
2866 it
->face_id
= it
->base_face_id
;
2868 it
->start
= it
->current
;
2869 /* Do we need to reorder bidirectional text? Not if this is a
2870 unibyte buffer: by definition, none of the single-byte
2871 characters are strong R2L, so no reordering is needed. And
2872 bidi.c doesn't support unibyte buffers anyway. Also, don't
2873 reorder while we are loading loadup.el, since the tables of
2874 character properties needed for reordering are not yet
2878 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2881 /* If we are to reorder bidirectional text, init the bidi
2885 /* Since we don't know at this point whether there will be
2886 any R2L lines in the window, we reserve space for
2887 truncation/continuation glyphs even if only the left
2888 fringe is absent. */
2889 if (base_face_id
== DEFAULT_FACE_ID
2890 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2891 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2893 if (it
->line_wrap
== TRUNCATE
)
2894 it
->last_visible_x
-= it
->truncation_pixel_width
;
2896 it
->last_visible_x
-= it
->continuation_pixel_width
;
2898 /* Note the paragraph direction that this buffer wants to
2900 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2902 it
->paragraph_embedding
= L2R
;
2903 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2905 it
->paragraph_embedding
= R2L
;
2907 it
->paragraph_embedding
= NEUTRAL_DIR
;
2908 bidi_unshelve_cache (NULL
, false);
2909 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2913 /* Compute faces etc. */
2914 reseat (it
, it
->current
.pos
, true);
2921 /* Initialize IT for the display of window W with window start POS. */
2924 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2926 struct glyph_row
*row
;
2927 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2929 row
= w
->desired_matrix
->rows
+ first_vpos
;
2930 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2931 it
->first_vpos
= first_vpos
;
2933 /* Don't reseat to previous visible line start if current start
2934 position is in a string or image. */
2935 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2937 int first_y
= it
->current_y
;
2939 /* If window start is not at a line start, skip forward to POS to
2940 get the correct continuation lines width. */
2941 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2942 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2943 if (!start_at_line_beg_p
)
2947 reseat_at_previous_visible_line_start (it
);
2948 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2950 new_x
= it
->current_x
+ it
->pixel_width
;
2952 /* If lines are continued, this line may end in the middle
2953 of a multi-glyph character (e.g. a control character
2954 displayed as \003, or in the middle of an overlay
2955 string). In this case move_it_to above will not have
2956 taken us to the start of the continuation line but to the
2957 end of the continued line. */
2958 if (it
->current_x
> 0
2959 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2960 && (/* And glyph doesn't fit on the line. */
2961 new_x
> it
->last_visible_x
2962 /* Or it fits exactly and we're on a window
2964 || (new_x
== it
->last_visible_x
2965 && FRAME_WINDOW_P (it
->f
)
2966 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2967 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2968 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2970 if ((it
->current
.dpvec_index
>= 0
2971 || it
->current
.overlay_string_index
>= 0)
2972 /* If we are on a newline from a display vector or
2973 overlay string, then we are already at the end of
2974 a screen line; no need to go to the next line in
2975 that case, as this line is not really continued.
2976 (If we do go to the next line, C-e will not DTRT.) */
2979 set_iterator_to_next (it
, true);
2980 move_it_in_display_line_to (it
, -1, -1, 0);
2983 it
->continuation_lines_width
+= it
->current_x
;
2985 /* If the character at POS is displayed via a display
2986 vector, move_it_to above stops at the final glyph of
2987 IT->dpvec. To make the caller redisplay that character
2988 again (a.k.a. start at POS), we need to reset the
2989 dpvec_index to the beginning of IT->dpvec. */
2990 else if (it
->current
.dpvec_index
>= 0)
2991 it
->current
.dpvec_index
= 0;
2993 /* We're starting a new display line, not affected by the
2994 height of the continued line, so clear the appropriate
2995 fields in the iterator structure. */
2996 it
->max_ascent
= it
->max_descent
= 0;
2997 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2999 it
->current_y
= first_y
;
3001 it
->current_x
= it
->hpos
= 0;
3007 /* Return true if POS is a position in ellipses displayed for invisible
3008 text. W is the window we display, for text property lookup. */
3011 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3013 Lisp_Object prop
, window
;
3014 bool ellipses_p
= false;
3015 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3017 /* If POS specifies a position in a display vector, this might
3018 be for an ellipsis displayed for invisible text. We won't
3019 get the iterator set up for delivering that ellipsis unless
3020 we make sure that it gets aware of the invisible text. */
3021 if (pos
->dpvec_index
>= 0
3022 && pos
->overlay_string_index
< 0
3023 && CHARPOS (pos
->string_pos
) < 0
3025 && (XSETWINDOW (window
, w
),
3026 prop
= Fget_char_property (make_number (charpos
),
3027 Qinvisible
, window
),
3028 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3030 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3032 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3039 /* Initialize IT for stepping through current_buffer in window W,
3040 starting at position POS that includes overlay string and display
3041 vector/ control character translation position information. Value
3042 is false if there are overlay strings with newlines at POS. */
3045 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3047 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3049 bool overlay_strings_with_newlines
= false;
3051 /* If POS specifies a position in a display vector, this might
3052 be for an ellipsis displayed for invisible text. We won't
3053 get the iterator set up for delivering that ellipsis unless
3054 we make sure that it gets aware of the invisible text. */
3055 if (in_ellipses_for_invisible_text_p (pos
, w
))
3061 /* Keep in mind: the call to reseat in init_iterator skips invisible
3062 text, so we might end up at a position different from POS. This
3063 is only a problem when POS is a row start after a newline and an
3064 overlay starts there with an after-string, and the overlay has an
3065 invisible property. Since we don't skip invisible text in
3066 display_line and elsewhere immediately after consuming the
3067 newline before the row start, such a POS will not be in a string,
3068 but the call to init_iterator below will move us to the
3070 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3072 /* This only scans the current chunk -- it should scan all chunks.
3073 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3074 to 16 in 22.1 to make this a lesser problem. */
3075 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3077 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3078 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3080 while (s
< e
&& *s
!= '\n')
3085 overlay_strings_with_newlines
= true;
3090 /* If position is within an overlay string, set up IT to the right
3092 if (pos
->overlay_string_index
>= 0)
3096 /* If the first overlay string happens to have a `display'
3097 property for an image, the iterator will be set up for that
3098 image, and we have to undo that setup first before we can
3099 correct the overlay string index. */
3100 if (it
->method
== GET_FROM_IMAGE
)
3103 /* We already have the first chunk of overlay strings in
3104 IT->overlay_strings. Load more until the one for
3105 pos->overlay_string_index is in IT->overlay_strings. */
3106 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3108 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3109 it
->current
.overlay_string_index
= 0;
3112 load_overlay_strings (it
, 0);
3113 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3117 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3118 relative_index
= (it
->current
.overlay_string_index
3119 % OVERLAY_STRING_CHUNK_SIZE
);
3120 it
->string
= it
->overlay_strings
[relative_index
];
3121 eassert (STRINGP (it
->string
));
3122 it
->current
.string_pos
= pos
->string_pos
;
3123 it
->method
= GET_FROM_STRING
;
3124 it
->end_charpos
= SCHARS (it
->string
);
3125 /* Set up the bidi iterator for this overlay string. */
3128 it
->bidi_it
.string
.lstring
= it
->string
;
3129 it
->bidi_it
.string
.s
= NULL
;
3130 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3131 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3132 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3133 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3134 it
->bidi_it
.w
= it
->w
;
3135 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3136 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3138 /* Synchronize the state of the bidi iterator with
3139 pos->string_pos. For any string position other than
3140 zero, this will be done automagically when we resume
3141 iteration over the string and get_visually_first_element
3142 is called. But if string_pos is zero, and the string is
3143 to be reordered for display, we need to resync manually,
3144 since it could be that the iteration state recorded in
3145 pos ended at string_pos of 0 moving backwards in string. */
3146 if (CHARPOS (pos
->string_pos
) == 0)
3148 get_visually_first_element (it
);
3149 if (IT_STRING_CHARPOS (*it
) != 0)
3152 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3153 bidi_move_to_visually_next (&it
->bidi_it
);
3154 } while (it
->bidi_it
.charpos
!= 0);
3156 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3157 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3161 if (CHARPOS (pos
->string_pos
) >= 0)
3163 /* Recorded position is not in an overlay string, but in another
3164 string. This can only be a string from a `display' property.
3165 IT should already be filled with that string. */
3166 it
->current
.string_pos
= pos
->string_pos
;
3167 eassert (STRINGP (it
->string
));
3169 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3170 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3173 /* Restore position in display vector translations, control
3174 character translations or ellipses. */
3175 if (pos
->dpvec_index
>= 0)
3177 if (it
->dpvec
== NULL
)
3178 get_next_display_element (it
);
3179 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3180 it
->current
.dpvec_index
= pos
->dpvec_index
;
3184 return !overlay_strings_with_newlines
;
3188 /* Initialize IT for stepping through current_buffer in window W
3189 starting at ROW->start. */
3192 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3194 init_from_display_pos (it
, w
, &row
->start
);
3195 it
->start
= row
->start
;
3196 it
->continuation_lines_width
= row
->continuation_lines_width
;
3201 /* Initialize IT for stepping through current_buffer in window W
3202 starting in the line following ROW, i.e. starting at ROW->end.
3203 Value is false if there are overlay strings with newlines at ROW's
3207 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3209 bool success
= false;
3211 if (init_from_display_pos (it
, w
, &row
->end
))
3213 if (row
->continued_p
)
3214 it
->continuation_lines_width
3215 = row
->continuation_lines_width
+ row
->pixel_width
;
3226 /***********************************************************************
3228 ***********************************************************************/
3230 /* Called when IT reaches IT->stop_charpos. Handle text property and
3231 overlay changes. Set IT->stop_charpos to the next position where
3235 handle_stop (struct it
*it
)
3237 enum prop_handled handled
;
3238 bool handle_overlay_change_p
;
3242 it
->current
.dpvec_index
= -1;
3243 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3244 it
->ellipsis_p
= false;
3246 /* Use face of preceding text for ellipsis (if invisible) */
3247 if (it
->selective_display_ellipsis_p
)
3248 it
->saved_face_id
= it
->face_id
;
3250 /* Here's the description of the semantics of, and the logic behind,
3251 the various HANDLED_* statuses:
3253 HANDLED_NORMALLY means the handler did its job, and the loop
3254 should proceed to calling the next handler in order.
3256 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3257 change in the properties and overlays at current position, so the
3258 loop should be restarted, to re-invoke the handlers that were
3259 already called. This happens when fontification-functions were
3260 called by handle_fontified_prop, and actually fontified
3261 something. Another case where HANDLED_RECOMPUTE_PROPS is
3262 returned is when we discover overlay strings that need to be
3263 displayed right away. The loop below will continue for as long
3264 as the status is HANDLED_RECOMPUTE_PROPS.
3266 HANDLED_RETURN means return immediately to the caller, to
3267 continue iteration without calling any further handlers. This is
3268 used when we need to act on some property right away, for example
3269 when we need to display the ellipsis or a replacing display
3270 property, such as display string or image.
3272 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3273 consumed, and the handler switched to the next overlay string.
3274 This signals the loop below to refrain from looking for more
3275 overlays before all the overlay strings of the current overlay
3278 Some of the handlers called by the loop push the iterator state
3279 onto the stack (see 'push_it'), and arrange for the iteration to
3280 continue with another object, such as an image, a display string,
3281 or an overlay string. In most such cases, it->stop_charpos is
3282 set to the first character of the string, so that when the
3283 iteration resumes, this function will immediately be called
3284 again, to examine the properties at the beginning of the string.
3286 When a display or overlay string is exhausted, the iterator state
3287 is popped (see 'pop_it'), and iteration continues with the
3288 previous object. Again, in many such cases this function is
3289 called again to find the next position where properties might
3294 handled
= HANDLED_NORMALLY
;
3296 /* Call text property handlers. */
3297 for (p
= it_props
; p
->handler
; ++p
)
3299 handled
= p
->handler (it
);
3301 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3303 else if (handled
== HANDLED_RETURN
)
3305 /* We still want to show before and after strings from
3306 overlays even if the actual buffer text is replaced. */
3307 if (!handle_overlay_change_p
3309 /* Don't call get_overlay_strings_1 if we already
3310 have overlay strings loaded, because doing so
3311 will load them again and push the iterator state
3312 onto the stack one more time, which is not
3313 expected by the rest of the code that processes
3315 || (it
->current
.overlay_string_index
< 0
3316 && !get_overlay_strings_1 (it
, 0, false)))
3319 setup_for_ellipsis (it
, 0);
3320 /* When handling a display spec, we might load an
3321 empty string. In that case, discard it here. We
3322 used to discard it in handle_single_display_spec,
3323 but that causes get_overlay_strings_1, above, to
3324 ignore overlay strings that we must check. */
3325 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3329 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3333 it
->string_from_display_prop_p
= false;
3334 it
->from_disp_prop_p
= false;
3335 handle_overlay_change_p
= false;
3337 handled
= HANDLED_RECOMPUTE_PROPS
;
3340 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3341 handle_overlay_change_p
= false;
3344 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3346 /* Don't check for overlay strings below when set to deliver
3347 characters from a display vector. */
3348 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3349 handle_overlay_change_p
= false;
3351 /* Handle overlay changes.
3352 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3353 if it finds overlays. */
3354 if (handle_overlay_change_p
)
3355 handled
= handle_overlay_change (it
);
3360 setup_for_ellipsis (it
, 0);
3364 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3366 /* Determine where to stop next. */
3367 if (handled
== HANDLED_NORMALLY
)
3368 compute_stop_pos (it
);
3372 /* Compute IT->stop_charpos from text property and overlay change
3373 information for IT's current position. */
3376 compute_stop_pos (struct it
*it
)
3378 register INTERVAL iv
, next_iv
;
3379 Lisp_Object object
, limit
, position
;
3380 ptrdiff_t charpos
, bytepos
;
3382 if (STRINGP (it
->string
))
3384 /* Strings are usually short, so don't limit the search for
3386 it
->stop_charpos
= it
->end_charpos
;
3387 object
= it
->string
;
3389 charpos
= IT_STRING_CHARPOS (*it
);
3390 bytepos
= IT_STRING_BYTEPOS (*it
);
3396 /* If end_charpos is out of range for some reason, such as a
3397 misbehaving display function, rationalize it (Bug#5984). */
3398 if (it
->end_charpos
> ZV
)
3399 it
->end_charpos
= ZV
;
3400 it
->stop_charpos
= it
->end_charpos
;
3402 /* If next overlay change is in front of the current stop pos
3403 (which is IT->end_charpos), stop there. Note: value of
3404 next_overlay_change is point-max if no overlay change
3406 charpos
= IT_CHARPOS (*it
);
3407 bytepos
= IT_BYTEPOS (*it
);
3408 pos
= next_overlay_change (charpos
);
3409 if (pos
< it
->stop_charpos
)
3410 it
->stop_charpos
= pos
;
3412 /* Set up variables for computing the stop position from text
3413 property changes. */
3414 XSETBUFFER (object
, current_buffer
);
3415 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3418 /* Get the interval containing IT's position. Value is a null
3419 interval if there isn't such an interval. */
3420 position
= make_number (charpos
);
3421 iv
= validate_interval_range (object
, &position
, &position
, false);
3424 Lisp_Object values_here
[LAST_PROP_IDX
];
3427 /* Get properties here. */
3428 for (p
= it_props
; p
->handler
; ++p
)
3429 values_here
[p
->idx
] = textget (iv
->plist
,
3430 builtin_lisp_symbol (p
->name
));
3432 /* Look for an interval following iv that has different
3434 for (next_iv
= next_interval (iv
);
3437 || XFASTINT (limit
) > next_iv
->position
));
3438 next_iv
= next_interval (next_iv
))
3440 for (p
= it_props
; p
->handler
; ++p
)
3442 Lisp_Object new_value
= textget (next_iv
->plist
,
3443 builtin_lisp_symbol (p
->name
));
3444 if (!EQ (values_here
[p
->idx
], new_value
))
3454 if (INTEGERP (limit
)
3455 && next_iv
->position
>= XFASTINT (limit
))
3456 /* No text property change up to limit. */
3457 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3459 /* Text properties change in next_iv. */
3460 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3464 if (it
->cmp_it
.id
< 0)
3466 ptrdiff_t stoppos
= it
->end_charpos
;
3468 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3470 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3471 stoppos
, it
->string
);
3474 eassert (STRINGP (it
->string
)
3475 || (it
->stop_charpos
>= BEGV
3476 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3480 /* Return the position of the next overlay change after POS in
3481 current_buffer. Value is point-max if no overlay change
3482 follows. This is like `next-overlay-change' but doesn't use
3486 next_overlay_change (ptrdiff_t pos
)
3488 ptrdiff_t i
, noverlays
;
3490 Lisp_Object
*overlays
;
3493 /* Get all overlays at the given position. */
3494 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3496 /* If any of these overlays ends before endpos,
3497 use its ending point instead. */
3498 for (i
= 0; i
< noverlays
; ++i
)
3503 oend
= OVERLAY_END (overlays
[i
]);
3504 oendpos
= OVERLAY_POSITION (oend
);
3505 endpos
= min (endpos
, oendpos
);
3512 /* How many characters forward to search for a display property or
3513 display string. Searching too far forward makes the bidi display
3514 sluggish, especially in small windows. */
3515 #define MAX_DISP_SCAN 250
3517 /* Return the character position of a display string at or after
3518 position specified by POSITION. If no display string exists at or
3519 after POSITION, return ZV. A display string is either an overlay
3520 with `display' property whose value is a string, or a `display'
3521 text property whose value is a string. STRING is data about the
3522 string to iterate; if STRING->lstring is nil, we are iterating a
3523 buffer. FRAME_WINDOW_P is true when we are displaying a window
3524 on a GUI frame. DISP_PROP is set to zero if we searched
3525 MAX_DISP_SCAN characters forward without finding any display
3526 strings, non-zero otherwise. It is set to 2 if the display string
3527 uses any kind of `(space ...)' spec that will produce a stretch of
3528 white space in the text area. */
3530 compute_display_string_pos (struct text_pos
*position
,
3531 struct bidi_string_data
*string
,
3533 bool frame_window_p
, int *disp_prop
)
3535 /* OBJECT = nil means current buffer. */
3536 Lisp_Object object
, object1
;
3537 Lisp_Object pos
, spec
, limpos
;
3538 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3539 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3540 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3541 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3543 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3544 struct text_pos tpos
;
3547 if (string
&& STRINGP (string
->lstring
))
3548 object1
= object
= string
->lstring
;
3549 else if (w
&& !string_p
)
3551 XSETWINDOW (object
, w
);
3555 object1
= object
= Qnil
;
3560 /* We don't support display properties whose values are strings
3561 that have display string properties. */
3562 || string
->from_disp_str
3563 /* C strings cannot have display properties. */
3564 || (string
->s
&& !STRINGP (object
)))
3570 /* If the character at CHARPOS is where the display string begins,
3572 pos
= make_number (charpos
);
3573 if (STRINGP (object
))
3574 bufpos
= string
->bufpos
;
3578 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3580 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3583 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3591 /* Look forward for the first character with a `display' property
3592 that will replace the underlying text when displayed. */
3593 limpos
= make_number (lim
);
3595 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3596 CHARPOS (tpos
) = XFASTINT (pos
);
3597 if (CHARPOS (tpos
) >= lim
)
3602 if (STRINGP (object
))
3603 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3605 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3606 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3607 if (!STRINGP (object
))
3608 bufpos
= CHARPOS (tpos
);
3609 } while (NILP (spec
)
3610 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3611 bufpos
, frame_window_p
)));
3615 return CHARPOS (tpos
);
3618 /* Return the character position of the end of the display string that
3619 started at CHARPOS. If there's no display string at CHARPOS,
3620 return -1. A display string is either an overlay with `display'
3621 property whose value is a string or a `display' text property whose
3622 value is a string. */
3624 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3626 /* OBJECT = nil means current buffer. */
3627 Lisp_Object object
=
3628 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3629 Lisp_Object pos
= make_number (charpos
);
3631 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3633 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3636 /* It could happen that the display property or overlay was removed
3637 since we found it in compute_display_string_pos above. One way
3638 this can happen is if JIT font-lock was called (through
3639 handle_fontified_prop), and jit-lock-functions remove text
3640 properties or overlays from the portion of buffer that includes
3641 CHARPOS. Muse mode is known to do that, for example. In this
3642 case, we return -1 to the caller, to signal that no display
3643 string is actually present at CHARPOS. See bidi_fetch_char for
3644 how this is handled.
3646 An alternative would be to never look for display properties past
3647 it->stop_charpos. But neither compute_display_string_pos nor
3648 bidi_fetch_char that calls it know or care where the next
3650 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3653 /* Look forward for the first character where the `display' property
3655 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3657 return XFASTINT (pos
);
3662 /***********************************************************************
3664 ***********************************************************************/
3666 /* Handle changes in the `fontified' property of the current buffer by
3667 calling hook functions from Qfontification_functions to fontify
3670 static enum prop_handled
3671 handle_fontified_prop (struct it
*it
)
3673 Lisp_Object prop
, pos
;
3674 enum prop_handled handled
= HANDLED_NORMALLY
;
3676 if (!NILP (Vmemory_full
))
3679 /* Get the value of the `fontified' property at IT's current buffer
3680 position. (The `fontified' property doesn't have a special
3681 meaning in strings.) If the value is nil, call functions from
3682 Qfontification_functions. */
3683 if (!STRINGP (it
->string
)
3685 && !NILP (Vfontification_functions
)
3686 && !NILP (Vrun_hooks
)
3687 && (pos
= make_number (IT_CHARPOS (*it
)),
3688 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3689 /* Ignore the special cased nil value always present at EOB since
3690 no amount of fontifying will be able to change it. */
3691 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3693 ptrdiff_t count
= SPECPDL_INDEX ();
3695 struct buffer
*obuf
= current_buffer
;
3696 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3697 bool old_clip_changed
= current_buffer
->clip_changed
;
3699 val
= Vfontification_functions
;
3700 specbind (Qfontification_functions
, Qnil
);
3702 eassert (it
->end_charpos
== ZV
);
3704 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3705 safe_call1 (val
, pos
);
3708 Lisp_Object fns
, fn
;
3709 struct gcpro gcpro1
, gcpro2
;
3714 for (; CONSP (val
); val
= XCDR (val
))
3720 /* A value of t indicates this hook has a local
3721 binding; it means to run the global binding too.
3722 In a global value, t should not occur. If it
3723 does, we must ignore it to avoid an endless
3725 for (fns
= Fdefault_value (Qfontification_functions
);
3731 safe_call1 (fn
, pos
);
3735 safe_call1 (fn
, pos
);
3741 unbind_to (count
, Qnil
);
3743 /* Fontification functions routinely call `save-restriction'.
3744 Normally, this tags clip_changed, which can confuse redisplay
3745 (see discussion in Bug#6671). Since we don't perform any
3746 special handling of fontification changes in the case where
3747 `save-restriction' isn't called, there's no point doing so in
3748 this case either. So, if the buffer's restrictions are
3749 actually left unchanged, reset clip_changed. */
3750 if (obuf
== current_buffer
)
3752 if (begv
== BEGV
&& zv
== ZV
)
3753 current_buffer
->clip_changed
= old_clip_changed
;
3755 /* There isn't much we can reasonably do to protect against
3756 misbehaving fontification, but here's a fig leaf. */
3757 else if (BUFFER_LIVE_P (obuf
))
3758 set_buffer_internal_1 (obuf
);
3760 /* The fontification code may have added/removed text.
3761 It could do even a lot worse, but let's at least protect against
3762 the most obvious case where only the text past `pos' gets changed',
3763 as is/was done in grep.el where some escapes sequences are turned
3764 into face properties (bug#7876). */
3765 it
->end_charpos
= ZV
;
3767 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3768 something. This avoids an endless loop if they failed to
3769 fontify the text for which reason ever. */
3770 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3771 handled
= HANDLED_RECOMPUTE_PROPS
;
3779 /***********************************************************************
3781 ***********************************************************************/
3783 /* Set up iterator IT from face properties at its current position.
3784 Called from handle_stop. */
3786 static enum prop_handled
3787 handle_face_prop (struct it
*it
)
3790 ptrdiff_t next_stop
;
3792 if (!STRINGP (it
->string
))
3795 = face_at_buffer_position (it
->w
,
3799 + TEXT_PROP_DISTANCE_LIMIT
),
3800 false, it
->base_face_id
);
3802 /* Is this a start of a run of characters with box face?
3803 Caveat: this can be called for a freshly initialized
3804 iterator; face_id is -1 in this case. We know that the new
3805 face will not change until limit, i.e. if the new face has a
3806 box, all characters up to limit will have one. But, as
3807 usual, we don't know whether limit is really the end. */
3808 if (new_face_id
!= it
->face_id
)
3810 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3811 /* If it->face_id is -1, old_face below will be NULL, see
3812 the definition of FACE_FROM_ID. This will happen if this
3813 is the initial call that gets the face. */
3814 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3816 /* If the value of face_id of the iterator is -1, we have to
3817 look in front of IT's position and see whether there is a
3818 face there that's different from new_face_id. */
3819 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3821 int prev_face_id
= face_before_it_pos (it
);
3823 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3826 /* If the new face has a box, but the old face does not,
3827 this is the start of a run of characters with box face,
3828 i.e. this character has a shadow on the left side. */
3829 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3830 && (old_face
== NULL
|| !old_face
->box
));
3831 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3839 Lisp_Object from_overlay
3840 = (it
->current
.overlay_string_index
>= 0
3841 ? it
->string_overlays
[it
->current
.overlay_string_index
3842 % OVERLAY_STRING_CHUNK_SIZE
]
3845 /* See if we got to this string directly or indirectly from
3846 an overlay property. That includes the before-string or
3847 after-string of an overlay, strings in display properties
3848 provided by an overlay, their text properties, etc.
3850 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3851 if (! NILP (from_overlay
))
3852 for (i
= it
->sp
- 1; i
>= 0; i
--)
3854 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3856 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3857 % OVERLAY_STRING_CHUNK_SIZE
];
3858 else if (! NILP (it
->stack
[i
].from_overlay
))
3859 from_overlay
= it
->stack
[i
].from_overlay
;
3861 if (!NILP (from_overlay
))
3865 if (! NILP (from_overlay
))
3867 bufpos
= IT_CHARPOS (*it
);
3868 /* For a string from an overlay, the base face depends
3869 only on text properties and ignores overlays. */
3871 = face_for_overlay_string (it
->w
,
3875 + TEXT_PROP_DISTANCE_LIMIT
),
3883 /* For strings from a `display' property, use the face at
3884 IT's current buffer position as the base face to merge
3885 with, so that overlay strings appear in the same face as
3886 surrounding text, unless they specify their own faces.
3887 For strings from wrap-prefix and line-prefix properties,
3888 use the default face, possibly remapped via
3889 Vface_remapping_alist. */
3890 /* Note that the fact that we use the face at _buffer_
3891 position means that a 'display' property on an overlay
3892 string will not inherit the face of that overlay string,
3893 but will instead revert to the face of buffer text
3894 covered by the overlay. This is visible, e.g., when the
3895 overlay specifies a box face, but neither the buffer nor
3896 the display string do. This sounds like a design bug,
3897 but Emacs always did that since v21.1, so changing that
3898 might be a big deal. */
3899 base_face_id
= it
->string_from_prefix_prop_p
3900 ? (!NILP (Vface_remapping_alist
)
3901 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3903 : underlying_face_id (it
);
3906 new_face_id
= face_at_string_position (it
->w
,
3908 IT_STRING_CHARPOS (*it
),
3911 base_face_id
, false);
3913 /* Is this a start of a run of characters with box? Caveat:
3914 this can be called for a freshly allocated iterator; face_id
3915 is -1 is this case. We know that the new face will not
3916 change until the next check pos, i.e. if the new face has a
3917 box, all characters up to that position will have a
3918 box. But, as usual, we don't know whether that position
3919 is really the end. */
3920 if (new_face_id
!= it
->face_id
)
3922 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3923 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3925 /* If new face has a box but old face hasn't, this is the
3926 start of a run of characters with box, i.e. it has a
3927 shadow on the left side. */
3928 it
->start_of_box_run_p
3929 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3930 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3934 it
->face_id
= new_face_id
;
3935 return HANDLED_NORMALLY
;
3939 /* Return the ID of the face ``underlying'' IT's current position,
3940 which is in a string. If the iterator is associated with a
3941 buffer, return the face at IT's current buffer position.
3942 Otherwise, use the iterator's base_face_id. */
3945 underlying_face_id (struct it
*it
)
3947 int face_id
= it
->base_face_id
, i
;
3949 eassert (STRINGP (it
->string
));
3951 for (i
= it
->sp
- 1; i
>= 0; --i
)
3952 if (NILP (it
->stack
[i
].string
))
3953 face_id
= it
->stack
[i
].face_id
;
3959 /* Compute the face one character before or after the current position
3960 of IT, in the visual order. BEFORE_P means get the face
3961 in front (to the left in L2R paragraphs, to the right in R2L
3962 paragraphs) of IT's screen position. Value is the ID of the face. */
3965 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3968 ptrdiff_t next_check_charpos
;
3970 void *it_copy_data
= NULL
;
3972 eassert (it
->s
== NULL
);
3974 if (STRINGP (it
->string
))
3976 ptrdiff_t bufpos
, charpos
;
3979 /* No face change past the end of the string (for the case
3980 we are padding with spaces). No face change before the
3982 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3983 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3988 /* Set charpos to the position before or after IT's current
3989 position, in the logical order, which in the non-bidi
3990 case is the same as the visual order. */
3992 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3993 else if (it
->what
== IT_COMPOSITION
)
3994 /* For composition, we must check the character after the
3996 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3998 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4004 /* With bidi iteration, the character before the current
4005 in the visual order cannot be found by simple
4006 iteration, because "reverse" reordering is not
4007 supported. Instead, we need to use the move_it_*
4008 family of functions. */
4009 /* Ignore face changes before the first visible
4010 character on this display line. */
4011 if (it
->current_x
<= it
->first_visible_x
)
4013 SAVE_IT (it_copy
, *it
, it_copy_data
);
4014 /* Implementation note: Since move_it_in_display_line
4015 works in the iterator geometry, and thinks the first
4016 character is always the leftmost, even in R2L lines,
4017 we don't need to distinguish between the R2L and L2R
4019 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4020 it_copy
.current_x
- 1, MOVE_TO_X
);
4021 charpos
= IT_STRING_CHARPOS (it_copy
);
4022 RESTORE_IT (it
, it
, it_copy_data
);
4026 /* Set charpos to the string position of the character
4027 that comes after IT's current position in the visual
4029 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4033 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4035 charpos
= it_copy
.bidi_it
.charpos
;
4038 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4040 if (it
->current
.overlay_string_index
>= 0)
4041 bufpos
= IT_CHARPOS (*it
);
4045 base_face_id
= underlying_face_id (it
);
4047 /* Get the face for ASCII, or unibyte. */
4048 face_id
= face_at_string_position (it
->w
,
4052 &next_check_charpos
,
4053 base_face_id
, false);
4055 /* Correct the face for charsets different from ASCII. Do it
4056 for the multibyte case only. The face returned above is
4057 suitable for unibyte text if IT->string is unibyte. */
4058 if (STRING_MULTIBYTE (it
->string
))
4060 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4061 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4063 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4065 c
= string_char_and_length (p
, &len
);
4066 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4071 struct text_pos pos
;
4073 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4074 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4077 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4078 pos
= it
->current
.pos
;
4083 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4086 if (it
->what
== IT_COMPOSITION
)
4088 /* For composition, we must check the position after
4090 pos
.charpos
+= it
->cmp_it
.nchars
;
4091 pos
.bytepos
+= it
->len
;
4094 INC_TEXT_POS (pos
, it
->multibyte_p
);
4101 /* With bidi iteration, the character before the current
4102 in the visual order cannot be found by simple
4103 iteration, because "reverse" reordering is not
4104 supported. Instead, we need to use the move_it_*
4105 family of functions. */
4106 /* Ignore face changes before the first visible
4107 character on this display line. */
4108 if (it
->current_x
<= it
->first_visible_x
)
4110 SAVE_IT (it_copy
, *it
, it_copy_data
);
4111 /* Implementation note: Since move_it_in_display_line
4112 works in the iterator geometry, and thinks the first
4113 character is always the leftmost, even in R2L lines,
4114 we don't need to distinguish between the R2L and L2R
4116 move_it_in_display_line (&it_copy
, ZV
,
4117 it_copy
.current_x
- 1, MOVE_TO_X
);
4118 pos
= it_copy
.current
.pos
;
4119 RESTORE_IT (it
, it
, it_copy_data
);
4123 /* Set charpos to the buffer position of the character
4124 that comes after IT's current position in the visual
4126 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4130 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4133 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4136 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4138 /* Determine face for CHARSET_ASCII, or unibyte. */
4139 face_id
= face_at_buffer_position (it
->w
,
4141 &next_check_charpos
,
4144 /* Correct the face for charsets different from ASCII. Do it
4145 for the multibyte case only. The face returned above is
4146 suitable for unibyte text if current_buffer is unibyte. */
4147 if (it
->multibyte_p
)
4149 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4150 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4151 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4160 /***********************************************************************
4162 ***********************************************************************/
4164 /* Set up iterator IT from invisible properties at its current
4165 position. Called from handle_stop. */
4167 static enum prop_handled
4168 handle_invisible_prop (struct it
*it
)
4170 enum prop_handled handled
= HANDLED_NORMALLY
;
4174 if (STRINGP (it
->string
))
4176 Lisp_Object end_charpos
, limit
, charpos
;
4178 /* Get the value of the invisible text property at the
4179 current position. Value will be nil if there is no such
4181 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4182 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4183 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4185 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4187 /* Record whether we have to display an ellipsis for the
4189 bool display_ellipsis_p
= (invis
== 2);
4190 ptrdiff_t len
, endpos
;
4192 handled
= HANDLED_RECOMPUTE_PROPS
;
4194 /* Get the position at which the next visible text can be
4195 found in IT->string, if any. */
4196 endpos
= len
= SCHARS (it
->string
);
4197 XSETINT (limit
, len
);
4200 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4202 if (INTEGERP (end_charpos
))
4204 endpos
= XFASTINT (end_charpos
);
4205 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4206 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4208 display_ellipsis_p
= true;
4211 while (invis
!= 0 && endpos
< len
);
4213 if (display_ellipsis_p
)
4214 it
->ellipsis_p
= true;
4218 /* Text at END_CHARPOS is visible. Move IT there. */
4219 struct text_pos old
;
4222 old
= it
->current
.string_pos
;
4223 oldpos
= CHARPOS (old
);
4226 if (it
->bidi_it
.first_elt
4227 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4228 bidi_paragraph_init (it
->paragraph_embedding
,
4229 &it
->bidi_it
, true);
4230 /* Bidi-iterate out of the invisible text. */
4233 bidi_move_to_visually_next (&it
->bidi_it
);
4235 while (oldpos
<= it
->bidi_it
.charpos
4236 && it
->bidi_it
.charpos
< endpos
);
4238 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4239 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4240 if (IT_CHARPOS (*it
) >= endpos
)
4241 it
->prev_stop
= endpos
;
4245 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4246 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4251 /* The rest of the string is invisible. If this is an
4252 overlay string, proceed with the next overlay string
4253 or whatever comes and return a character from there. */
4254 if (it
->current
.overlay_string_index
>= 0
4255 && !display_ellipsis_p
)
4257 next_overlay_string (it
);
4258 /* Don't check for overlay strings when we just
4259 finished processing them. */
4260 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4264 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4265 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4272 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4273 Lisp_Object pos
, overlay
;
4275 /* First of all, is there invisible text at this position? */
4276 tem
= start_charpos
= IT_CHARPOS (*it
);
4277 pos
= make_number (tem
);
4278 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4280 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4282 /* If we are on invisible text, skip over it. */
4283 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4285 /* Record whether we have to display an ellipsis for the
4287 bool display_ellipsis_p
= invis
== 2;
4289 handled
= HANDLED_RECOMPUTE_PROPS
;
4291 /* Loop skipping over invisible text. The loop is left at
4292 ZV or with IT on the first char being visible again. */
4295 /* Try to skip some invisible text. Return value is the
4296 position reached which can be equal to where we start
4297 if there is nothing invisible there. This skips both
4298 over invisible text properties and overlays with
4299 invisible property. */
4300 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4302 /* If we skipped nothing at all we weren't at invisible
4303 text in the first place. If everything to the end of
4304 the buffer was skipped, end the loop. */
4305 if (newpos
== tem
|| newpos
>= ZV
)
4309 /* We skipped some characters but not necessarily
4310 all there are. Check if we ended up on visible
4311 text. Fget_char_property returns the property of
4312 the char before the given position, i.e. if we
4313 get invis = 0, this means that the char at
4314 newpos is visible. */
4315 pos
= make_number (newpos
);
4316 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4317 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4320 /* If we ended up on invisible text, proceed to
4321 skip starting with next_stop. */
4325 /* If there are adjacent invisible texts, don't lose the
4326 second one's ellipsis. */
4328 display_ellipsis_p
= true;
4332 /* The position newpos is now either ZV or on visible text. */
4335 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4337 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4339 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4341 /* If the invisible text ends on a newline or on a
4342 character after a newline, we can avoid the costly,
4343 character by character, bidi iteration to NEWPOS, and
4344 instead simply reseat the iterator there. That's
4345 because all bidi reordering information is tossed at
4346 the newline. This is a big win for modes that hide
4347 complete lines, like Outline, Org, etc. */
4348 if (on_newline
|| after_newline
)
4350 struct text_pos tpos
;
4351 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4353 SET_TEXT_POS (tpos
, newpos
, bpos
);
4354 reseat_1 (it
, tpos
, false);
4355 /* If we reseat on a newline/ZV, we need to prep the
4356 bidi iterator for advancing to the next character
4357 after the newline/EOB, keeping the current paragraph
4358 direction (so that PRODUCE_GLYPHS does TRT wrt
4359 prepending/appending glyphs to a glyph row). */
4362 it
->bidi_it
.first_elt
= false;
4363 it
->bidi_it
.paragraph_dir
= pdir
;
4364 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4365 it
->bidi_it
.nchars
= 1;
4366 it
->bidi_it
.ch_len
= 1;
4369 else /* Must use the slow method. */
4371 /* With bidi iteration, the region of invisible text
4372 could start and/or end in the middle of a
4373 non-base embedding level. Therefore, we need to
4374 skip invisible text using the bidi iterator,
4375 starting at IT's current position, until we find
4376 ourselves outside of the invisible text.
4377 Skipping invisible text _after_ bidi iteration
4378 avoids affecting the visual order of the
4379 displayed text when invisible properties are
4380 added or removed. */
4381 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4383 /* If we were `reseat'ed to a new paragraph,
4384 determine the paragraph base direction. We
4385 need to do it now because
4386 next_element_from_buffer may not have a
4387 chance to do it, if we are going to skip any
4388 text at the beginning, which resets the
4390 bidi_paragraph_init (it
->paragraph_embedding
,
4391 &it
->bidi_it
, true);
4395 bidi_move_to_visually_next (&it
->bidi_it
);
4397 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4398 && it
->bidi_it
.charpos
< newpos
);
4399 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4400 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4401 /* If we overstepped NEWPOS, record its position in
4402 the iterator, so that we skip invisible text if
4403 later the bidi iteration lands us in the
4404 invisible region again. */
4405 if (IT_CHARPOS (*it
) >= newpos
)
4406 it
->prev_stop
= newpos
;
4411 IT_CHARPOS (*it
) = newpos
;
4412 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4415 /* If there are before-strings at the start of invisible
4416 text, and the text is invisible because of a text
4417 property, arrange to show before-strings because 20.x did
4418 it that way. (If the text is invisible because of an
4419 overlay property instead of a text property, this is
4420 already handled in the overlay code.) */
4422 && get_overlay_strings (it
, it
->stop_charpos
))
4424 handled
= HANDLED_RECOMPUTE_PROPS
;
4427 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4428 /* The call to get_overlay_strings above recomputes
4429 it->stop_charpos, but it only considers changes
4430 in properties and overlays beyond iterator's
4431 current position. This causes us to miss changes
4432 that happen exactly where the invisible property
4433 ended. So we play it safe here and force the
4434 iterator to check for potential stop positions
4435 immediately after the invisible text. Note that
4436 if get_overlay_strings returns true, it
4437 normally also pushed the iterator stack, so we
4438 need to update the stop position in the slot
4439 below the current one. */
4440 it
->stack
[it
->sp
- 1].stop_charpos
4441 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4444 else if (display_ellipsis_p
)
4446 /* Make sure that the glyphs of the ellipsis will get
4447 correct `charpos' values. If we would not update
4448 it->position here, the glyphs would belong to the
4449 last visible character _before_ the invisible
4450 text, which confuses `set_cursor_from_row'.
4452 We use the last invisible position instead of the
4453 first because this way the cursor is always drawn on
4454 the first "." of the ellipsis, whenever PT is inside
4455 the invisible text. Otherwise the cursor would be
4456 placed _after_ the ellipsis when the point is after the
4457 first invisible character. */
4458 if (!STRINGP (it
->object
))
4460 it
->position
.charpos
= newpos
- 1;
4461 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4463 it
->ellipsis_p
= true;
4464 /* Let the ellipsis display before
4465 considering any properties of the following char.
4466 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4467 handled
= HANDLED_RETURN
;
4476 /* Make iterator IT return `...' next.
4477 Replaces LEN characters from buffer. */
4480 setup_for_ellipsis (struct it
*it
, int len
)
4482 /* Use the display table definition for `...'. Invalid glyphs
4483 will be handled by the method returning elements from dpvec. */
4484 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4486 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4487 it
->dpvec
= v
->contents
;
4488 it
->dpend
= v
->contents
+ v
->header
.size
;
4492 /* Default `...'. */
4493 it
->dpvec
= default_invis_vector
;
4494 it
->dpend
= default_invis_vector
+ 3;
4497 it
->dpvec_char_len
= len
;
4498 it
->current
.dpvec_index
= 0;
4499 it
->dpvec_face_id
= -1;
4501 /* Remember the current face id in case glyphs specify faces.
4502 IT's face is restored in set_iterator_to_next.
4503 saved_face_id was set to preceding char's face in handle_stop. */
4504 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4505 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4507 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4508 it
->ellipsis_p
= true;
4513 /***********************************************************************
4515 ***********************************************************************/
4517 /* Set up iterator IT from `display' property at its current position.
4518 Called from handle_stop.
4519 We return HANDLED_RETURN if some part of the display property
4520 overrides the display of the buffer text itself.
4521 Otherwise we return HANDLED_NORMALLY. */
4523 static enum prop_handled
4524 handle_display_prop (struct it
*it
)
4526 Lisp_Object propval
, object
, overlay
;
4527 struct text_pos
*position
;
4529 /* Nonzero if some property replaces the display of the text itself. */
4530 int display_replaced
= 0;
4532 if (STRINGP (it
->string
))
4534 object
= it
->string
;
4535 position
= &it
->current
.string_pos
;
4536 bufpos
= CHARPOS (it
->current
.pos
);
4540 XSETWINDOW (object
, it
->w
);
4541 position
= &it
->current
.pos
;
4542 bufpos
= CHARPOS (*position
);
4545 /* Reset those iterator values set from display property values. */
4546 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4547 it
->space_width
= Qnil
;
4548 it
->font_height
= Qnil
;
4551 /* We don't support recursive `display' properties, i.e. string
4552 values that have a string `display' property, that have a string
4553 `display' property etc. */
4554 if (!it
->string_from_display_prop_p
)
4555 it
->area
= TEXT_AREA
;
4557 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4558 Qdisplay
, object
, &overlay
);
4560 return HANDLED_NORMALLY
;
4561 /* Now OVERLAY is the overlay that gave us this property, or nil
4562 if it was a text property. */
4564 if (!STRINGP (it
->string
))
4565 object
= it
->w
->contents
;
4567 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4569 FRAME_WINDOW_P (it
->f
));
4570 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4573 /* Subroutine of handle_display_prop. Returns non-zero if the display
4574 specification in SPEC is a replacing specification, i.e. it would
4575 replace the text covered by `display' property with something else,
4576 such as an image or a display string. If SPEC includes any kind or
4577 `(space ...) specification, the value is 2; this is used by
4578 compute_display_string_pos, which see.
4580 See handle_single_display_spec for documentation of arguments.
4581 FRAME_WINDOW_P is true if the window being redisplayed is on a
4582 GUI frame; this argument is used only if IT is NULL, see below.
4584 IT can be NULL, if this is called by the bidi reordering code
4585 through compute_display_string_pos, which see. In that case, this
4586 function only examines SPEC, but does not otherwise "handle" it, in
4587 the sense that it doesn't set up members of IT from the display
4590 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4591 Lisp_Object overlay
, struct text_pos
*position
,
4592 ptrdiff_t bufpos
, bool frame_window_p
)
4597 /* Simple specifications. */
4598 && !EQ (XCAR (spec
), Qimage
)
4599 && !EQ (XCAR (spec
), Qspace
)
4600 && !EQ (XCAR (spec
), Qwhen
)
4601 && !EQ (XCAR (spec
), Qslice
)
4602 && !EQ (XCAR (spec
), Qspace_width
)
4603 && !EQ (XCAR (spec
), Qheight
)
4604 && !EQ (XCAR (spec
), Qraise
)
4605 /* Marginal area specifications. */
4606 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4607 && !EQ (XCAR (spec
), Qleft_fringe
)
4608 && !EQ (XCAR (spec
), Qright_fringe
)
4609 && !NILP (XCAR (spec
)))
4611 for (; CONSP (spec
); spec
= XCDR (spec
))
4613 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4614 overlay
, position
, bufpos
,
4615 replacing
, frame_window_p
);
4619 /* If some text in a string is replaced, `position' no
4620 longer points to the position of `object'. */
4621 if (!it
|| STRINGP (object
))
4626 else if (VECTORP (spec
))
4629 for (i
= 0; i
< ASIZE (spec
); ++i
)
4631 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4632 overlay
, position
, bufpos
,
4633 replacing
, frame_window_p
);
4637 /* If some text in a string is replaced, `position' no
4638 longer points to the position of `object'. */
4639 if (!it
|| STRINGP (object
))
4645 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4646 bufpos
, 0, frame_window_p
);
4650 /* Value is the position of the end of the `display' property starting
4651 at START_POS in OBJECT. */
4653 static struct text_pos
4654 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4657 struct text_pos end_pos
;
4659 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4660 Qdisplay
, object
, Qnil
);
4661 CHARPOS (end_pos
) = XFASTINT (end
);
4662 if (STRINGP (object
))
4663 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4665 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4671 /* Set up IT from a single `display' property specification SPEC. OBJECT
4672 is the object in which the `display' property was found. *POSITION
4673 is the position in OBJECT at which the `display' property was found.
4674 BUFPOS is the buffer position of OBJECT (different from POSITION if
4675 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4676 previously saw a display specification which already replaced text
4677 display with something else, for example an image; we ignore such
4678 properties after the first one has been processed.
4680 OVERLAY is the overlay this `display' property came from,
4681 or nil if it was a text property.
4683 If SPEC is a `space' or `image' specification, and in some other
4684 cases too, set *POSITION to the position where the `display'
4687 If IT is NULL, only examine the property specification in SPEC, but
4688 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4689 is intended to be displayed in a window on a GUI frame.
4691 Value is non-zero if something was found which replaces the display
4692 of buffer or string text. */
4695 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4696 Lisp_Object overlay
, struct text_pos
*position
,
4697 ptrdiff_t bufpos
, int display_replaced
,
4698 bool frame_window_p
)
4701 Lisp_Object location
, value
;
4702 struct text_pos start_pos
= *position
;
4704 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4705 If the result is non-nil, use VALUE instead of SPEC. */
4707 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4716 if (!NILP (form
) && !EQ (form
, Qt
))
4718 ptrdiff_t count
= SPECPDL_INDEX ();
4719 struct gcpro gcpro1
;
4721 /* Bind `object' to the object having the `display' property, a
4722 buffer or string. Bind `position' to the position in the
4723 object where the property was found, and `buffer-position'
4724 to the current position in the buffer. */
4727 XSETBUFFER (object
, current_buffer
);
4728 specbind (Qobject
, object
);
4729 specbind (Qposition
, make_number (CHARPOS (*position
)));
4730 specbind (Qbuffer_position
, make_number (bufpos
));
4732 form
= safe_eval (form
);
4734 unbind_to (count
, Qnil
);
4740 /* Handle `(height HEIGHT)' specifications. */
4742 && EQ (XCAR (spec
), Qheight
)
4743 && CONSP (XCDR (spec
)))
4747 if (!FRAME_WINDOW_P (it
->f
))
4750 it
->font_height
= XCAR (XCDR (spec
));
4751 if (!NILP (it
->font_height
))
4753 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4754 int new_height
= -1;
4756 if (CONSP (it
->font_height
)
4757 && (EQ (XCAR (it
->font_height
), Qplus
)
4758 || EQ (XCAR (it
->font_height
), Qminus
))
4759 && CONSP (XCDR (it
->font_height
))
4760 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4762 /* `(+ N)' or `(- N)' where N is an integer. */
4763 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4764 if (EQ (XCAR (it
->font_height
), Qplus
))
4766 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4768 else if (FUNCTIONP (it
->font_height
))
4770 /* Call function with current height as argument.
4771 Value is the new height. */
4773 height
= safe_call1 (it
->font_height
,
4774 face
->lface
[LFACE_HEIGHT_INDEX
]);
4775 if (NUMBERP (height
))
4776 new_height
= XFLOATINT (height
);
4778 else if (NUMBERP (it
->font_height
))
4780 /* Value is a multiple of the canonical char height. */
4783 f
= FACE_FROM_ID (it
->f
,
4784 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4785 new_height
= (XFLOATINT (it
->font_height
)
4786 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4790 /* Evaluate IT->font_height with `height' bound to the
4791 current specified height to get the new height. */
4792 ptrdiff_t count
= SPECPDL_INDEX ();
4794 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4795 value
= safe_eval (it
->font_height
);
4796 unbind_to (count
, Qnil
);
4798 if (NUMBERP (value
))
4799 new_height
= XFLOATINT (value
);
4803 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4810 /* Handle `(space-width WIDTH)'. */
4812 && EQ (XCAR (spec
), Qspace_width
)
4813 && CONSP (XCDR (spec
)))
4817 if (!FRAME_WINDOW_P (it
->f
))
4820 value
= XCAR (XCDR (spec
));
4821 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4822 it
->space_width
= value
;
4828 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4830 && EQ (XCAR (spec
), Qslice
))
4836 if (!FRAME_WINDOW_P (it
->f
))
4839 if (tem
= XCDR (spec
), CONSP (tem
))
4841 it
->slice
.x
= XCAR (tem
);
4842 if (tem
= XCDR (tem
), CONSP (tem
))
4844 it
->slice
.y
= XCAR (tem
);
4845 if (tem
= XCDR (tem
), CONSP (tem
))
4847 it
->slice
.width
= XCAR (tem
);
4848 if (tem
= XCDR (tem
), CONSP (tem
))
4849 it
->slice
.height
= XCAR (tem
);
4858 /* Handle `(raise FACTOR)'. */
4860 && EQ (XCAR (spec
), Qraise
)
4861 && CONSP (XCDR (spec
)))
4865 if (!FRAME_WINDOW_P (it
->f
))
4868 #ifdef HAVE_WINDOW_SYSTEM
4869 value
= XCAR (XCDR (spec
));
4870 if (NUMBERP (value
))
4872 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4873 it
->voffset
= - (XFLOATINT (value
)
4874 * (FONT_HEIGHT (face
->font
)));
4876 #endif /* HAVE_WINDOW_SYSTEM */
4882 /* Don't handle the other kinds of display specifications
4883 inside a string that we got from a `display' property. */
4884 if (it
&& it
->string_from_display_prop_p
)
4887 /* Characters having this form of property are not displayed, so
4888 we have to find the end of the property. */
4891 start_pos
= *position
;
4892 *position
= display_prop_end (it
, object
, start_pos
);
4896 /* Stop the scan at that end position--we assume that all
4897 text properties change there. */
4899 it
->stop_charpos
= position
->charpos
;
4901 /* Handle `(left-fringe BITMAP [FACE])'
4902 and `(right-fringe BITMAP [FACE])'. */
4904 && (EQ (XCAR (spec
), Qleft_fringe
)
4905 || EQ (XCAR (spec
), Qright_fringe
))
4906 && CONSP (XCDR (spec
)))
4912 if (!FRAME_WINDOW_P (it
->f
))
4913 /* If we return here, POSITION has been advanced
4914 across the text with this property. */
4916 /* Synchronize the bidi iterator with POSITION. This is
4917 needed because we are not going to push the iterator
4918 on behalf of this display property, so there will be
4919 no pop_it call to do this synchronization for us. */
4922 it
->position
= *position
;
4923 iterate_out_of_display_property (it
);
4924 *position
= it
->position
;
4929 else if (!frame_window_p
)
4932 #ifdef HAVE_WINDOW_SYSTEM
4933 value
= XCAR (XCDR (spec
));
4934 if (!SYMBOLP (value
)
4935 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4936 /* If we return here, POSITION has been advanced
4937 across the text with this property. */
4939 if (it
&& it
->bidi_p
)
4941 it
->position
= *position
;
4942 iterate_out_of_display_property (it
);
4943 *position
= it
->position
;
4950 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4952 if (CONSP (XCDR (XCDR (spec
))))
4954 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4955 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4956 FRINGE_FACE_ID
, false);
4961 /* Save current settings of IT so that we can restore them
4962 when we are finished with the glyph property value. */
4963 push_it (it
, position
);
4965 it
->area
= TEXT_AREA
;
4966 it
->what
= IT_IMAGE
;
4967 it
->image_id
= -1; /* no image */
4968 it
->position
= start_pos
;
4969 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
4970 it
->method
= GET_FROM_IMAGE
;
4971 it
->from_overlay
= Qnil
;
4972 it
->face_id
= face_id
;
4973 it
->from_disp_prop_p
= true;
4975 /* Say that we haven't consumed the characters with
4976 `display' property yet. The call to pop_it in
4977 set_iterator_to_next will clean this up. */
4978 *position
= start_pos
;
4980 if (EQ (XCAR (spec
), Qleft_fringe
))
4982 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4983 it
->left_user_fringe_face_id
= face_id
;
4987 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4988 it
->right_user_fringe_face_id
= face_id
;
4991 #endif /* HAVE_WINDOW_SYSTEM */
4995 /* Prepare to handle `((margin left-margin) ...)',
4996 `((margin right-margin) ...)' and `((margin nil) ...)'
4997 prefixes for display specifications. */
4998 location
= Qunbound
;
4999 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5003 value
= XCDR (spec
);
5005 value
= XCAR (value
);
5008 if (EQ (XCAR (tem
), Qmargin
)
5009 && (tem
= XCDR (tem
),
5010 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5012 || EQ (tem
, Qleft_margin
)
5013 || EQ (tem
, Qright_margin
))))
5017 if (EQ (location
, Qunbound
))
5023 /* After this point, VALUE is the property after any
5024 margin prefix has been stripped. It must be a string,
5025 an image specification, or `(space ...)'.
5027 LOCATION specifies where to display: `left-margin',
5028 `right-margin' or nil. */
5030 bool valid_p
= (STRINGP (value
)
5031 #ifdef HAVE_WINDOW_SYSTEM
5032 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5033 && valid_image_p (value
))
5034 #endif /* not HAVE_WINDOW_SYSTEM */
5035 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5037 if (valid_p
&& display_replaced
== 0)
5043 /* Callers need to know whether the display spec is any kind
5044 of `(space ...)' spec that is about to affect text-area
5046 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5051 /* Save current settings of IT so that we can restore them
5052 when we are finished with the glyph property value. */
5053 push_it (it
, position
);
5054 it
->from_overlay
= overlay
;
5055 it
->from_disp_prop_p
= true;
5057 if (NILP (location
))
5058 it
->area
= TEXT_AREA
;
5059 else if (EQ (location
, Qleft_margin
))
5060 it
->area
= LEFT_MARGIN_AREA
;
5062 it
->area
= RIGHT_MARGIN_AREA
;
5064 if (STRINGP (value
))
5067 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5068 it
->current
.overlay_string_index
= -1;
5069 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5070 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5071 it
->method
= GET_FROM_STRING
;
5072 it
->stop_charpos
= 0;
5074 it
->base_level_stop
= 0;
5075 it
->string_from_display_prop_p
= true;
5076 /* Say that we haven't consumed the characters with
5077 `display' property yet. The call to pop_it in
5078 set_iterator_to_next will clean this up. */
5079 if (BUFFERP (object
))
5080 *position
= start_pos
;
5082 /* Force paragraph direction to be that of the parent
5083 object. If the parent object's paragraph direction is
5084 not yet determined, default to L2R. */
5085 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5086 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5088 it
->paragraph_embedding
= L2R
;
5090 /* Set up the bidi iterator for this display string. */
5093 it
->bidi_it
.string
.lstring
= it
->string
;
5094 it
->bidi_it
.string
.s
= NULL
;
5095 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5096 it
->bidi_it
.string
.bufpos
= bufpos
;
5097 it
->bidi_it
.string
.from_disp_str
= true;
5098 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5099 it
->bidi_it
.w
= it
->w
;
5100 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5103 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5105 it
->method
= GET_FROM_STRETCH
;
5107 *position
= it
->position
= start_pos
;
5108 retval
= 1 + (it
->area
== TEXT_AREA
);
5110 #ifdef HAVE_WINDOW_SYSTEM
5113 it
->what
= IT_IMAGE
;
5114 it
->image_id
= lookup_image (it
->f
, value
);
5115 it
->position
= start_pos
;
5116 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5117 it
->method
= GET_FROM_IMAGE
;
5119 /* Say that we haven't consumed the characters with
5120 `display' property yet. The call to pop_it in
5121 set_iterator_to_next will clean this up. */
5122 *position
= start_pos
;
5124 #endif /* HAVE_WINDOW_SYSTEM */
5129 /* Invalid property or property not supported. Restore
5130 POSITION to what it was before. */
5131 *position
= start_pos
;
5135 /* Check if PROP is a display property value whose text should be
5136 treated as intangible. OVERLAY is the overlay from which PROP
5137 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5138 specify the buffer position covered by PROP. */
5141 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5142 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5144 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5145 struct text_pos position
;
5147 SET_TEXT_POS (position
, charpos
, bytepos
);
5148 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5149 &position
, charpos
, frame_window_p
)
5154 /* Return true if PROP is a display sub-property value containing STRING.
5156 Implementation note: this and the following function are really
5157 special cases of handle_display_spec and
5158 handle_single_display_spec, and should ideally use the same code.
5159 Until they do, these two pairs must be consistent and must be
5160 modified in sync. */
5163 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5165 if (EQ (string
, prop
))
5168 /* Skip over `when FORM'. */
5169 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5174 /* Actually, the condition following `when' should be eval'ed,
5175 like handle_single_display_spec does, and we should return
5176 false if it evaluates to nil. However, this function is
5177 called only when the buffer was already displayed and some
5178 glyph in the glyph matrix was found to come from a display
5179 string. Therefore, the condition was already evaluated, and
5180 the result was non-nil, otherwise the display string wouldn't
5181 have been displayed and we would have never been called for
5182 this property. Thus, we can skip the evaluation and assume
5183 its result is non-nil. */
5188 /* Skip over `margin LOCATION'. */
5189 if (EQ (XCAR (prop
), Qmargin
))
5200 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5204 /* Return true if STRING appears in the `display' property PROP. */
5207 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5210 && !EQ (XCAR (prop
), Qwhen
)
5211 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5213 /* A list of sub-properties. */
5214 while (CONSP (prop
))
5216 if (single_display_spec_string_p (XCAR (prop
), string
))
5221 else if (VECTORP (prop
))
5223 /* A vector of sub-properties. */
5225 for (i
= 0; i
< ASIZE (prop
); ++i
)
5226 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5230 return single_display_spec_string_p (prop
, string
);
5235 /* Look for STRING in overlays and text properties in the current
5236 buffer, between character positions FROM and TO (excluding TO).
5237 BACK_P means look back (in this case, TO is supposed to be
5239 Value is the first character position where STRING was found, or
5240 zero if it wasn't found before hitting TO.
5242 This function may only use code that doesn't eval because it is
5243 called asynchronously from note_mouse_highlight. */
5246 string_buffer_position_lim (Lisp_Object string
,
5247 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5249 Lisp_Object limit
, prop
, pos
;
5252 pos
= make_number (max (from
, BEGV
));
5254 if (!back_p
) /* looking forward */
5256 limit
= make_number (min (to
, ZV
));
5257 while (!found
&& !EQ (pos
, limit
))
5259 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5260 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5263 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5267 else /* looking back */
5269 limit
= make_number (max (to
, BEGV
));
5270 while (!found
&& !EQ (pos
, limit
))
5272 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5273 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5276 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5281 return found
? XINT (pos
) : 0;
5284 /* Determine which buffer position in current buffer STRING comes from.
5285 AROUND_CHARPOS is an approximate position where it could come from.
5286 Value is the buffer position or 0 if it couldn't be determined.
5288 This function is necessary because we don't record buffer positions
5289 in glyphs generated from strings (to keep struct glyph small).
5290 This function may only use code that doesn't eval because it is
5291 called asynchronously from note_mouse_highlight. */
5294 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5296 const int MAX_DISTANCE
= 1000;
5297 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5298 around_charpos
+ MAX_DISTANCE
,
5302 found
= string_buffer_position_lim (string
, around_charpos
,
5303 around_charpos
- MAX_DISTANCE
, true);
5309 /***********************************************************************
5310 `composition' property
5311 ***********************************************************************/
5313 /* Set up iterator IT from `composition' property at its current
5314 position. Called from handle_stop. */
5316 static enum prop_handled
5317 handle_composition_prop (struct it
*it
)
5319 Lisp_Object prop
, string
;
5320 ptrdiff_t pos
, pos_byte
, start
, end
;
5322 if (STRINGP (it
->string
))
5326 pos
= IT_STRING_CHARPOS (*it
);
5327 pos_byte
= IT_STRING_BYTEPOS (*it
);
5328 string
= it
->string
;
5329 s
= SDATA (string
) + pos_byte
;
5330 it
->c
= STRING_CHAR (s
);
5334 pos
= IT_CHARPOS (*it
);
5335 pos_byte
= IT_BYTEPOS (*it
);
5337 it
->c
= FETCH_CHAR (pos_byte
);
5340 /* If there's a valid composition and point is not inside of the
5341 composition (in the case that the composition is from the current
5342 buffer), draw a glyph composed from the composition components. */
5343 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5344 && composition_valid_p (start
, end
, prop
)
5345 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5348 /* As we can't handle this situation (perhaps font-lock added
5349 a new composition), we just return here hoping that next
5350 redisplay will detect this composition much earlier. */
5351 return HANDLED_NORMALLY
;
5354 if (STRINGP (it
->string
))
5355 pos_byte
= string_char_to_byte (it
->string
, start
);
5357 pos_byte
= CHAR_TO_BYTE (start
);
5359 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5362 if (it
->cmp_it
.id
>= 0)
5365 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5366 it
->cmp_it
.nglyphs
= -1;
5370 return HANDLED_NORMALLY
;
5375 /***********************************************************************
5377 ***********************************************************************/
5379 /* The following structure is used to record overlay strings for
5380 later sorting in load_overlay_strings. */
5382 struct overlay_entry
5384 Lisp_Object overlay
;
5387 bool after_string_p
;
5391 /* Set up iterator IT from overlay strings at its current position.
5392 Called from handle_stop. */
5394 static enum prop_handled
5395 handle_overlay_change (struct it
*it
)
5397 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5398 return HANDLED_RECOMPUTE_PROPS
;
5400 return HANDLED_NORMALLY
;
5404 /* Set up the next overlay string for delivery by IT, if there is an
5405 overlay string to deliver. Called by set_iterator_to_next when the
5406 end of the current overlay string is reached. If there are more
5407 overlay strings to display, IT->string and
5408 IT->current.overlay_string_index are set appropriately here.
5409 Otherwise IT->string is set to nil. */
5412 next_overlay_string (struct it
*it
)
5414 ++it
->current
.overlay_string_index
;
5415 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5417 /* No more overlay strings. Restore IT's settings to what
5418 they were before overlay strings were processed, and
5419 continue to deliver from current_buffer. */
5421 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5424 || (NILP (it
->string
)
5425 && it
->method
== GET_FROM_BUFFER
5426 && it
->stop_charpos
>= BEGV
5427 && it
->stop_charpos
<= it
->end_charpos
));
5428 it
->current
.overlay_string_index
= -1;
5429 it
->n_overlay_strings
= 0;
5430 it
->overlay_strings_charpos
= -1;
5431 /* If there's an empty display string on the stack, pop the
5432 stack, to resync the bidi iterator with IT's position. Such
5433 empty strings are pushed onto the stack in
5434 get_overlay_strings_1. */
5435 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5438 /* Since we've exhausted overlay strings at this buffer
5439 position, set the flag to ignore overlays until we move to
5440 another position. The flag is reset in
5441 next_element_from_buffer. */
5442 it
->ignore_overlay_strings_at_pos_p
= true;
5444 /* If we're at the end of the buffer, record that we have
5445 processed the overlay strings there already, so that
5446 next_element_from_buffer doesn't try it again. */
5447 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5448 it
->overlay_strings_at_end_processed_p
= true;
5452 /* There are more overlay strings to process. If
5453 IT->current.overlay_string_index has advanced to a position
5454 where we must load IT->overlay_strings with more strings, do
5455 it. We must load at the IT->overlay_strings_charpos where
5456 IT->n_overlay_strings was originally computed; when invisible
5457 text is present, this might not be IT_CHARPOS (Bug#7016). */
5458 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5460 if (it
->current
.overlay_string_index
&& i
== 0)
5461 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5463 /* Initialize IT to deliver display elements from the overlay
5465 it
->string
= it
->overlay_strings
[i
];
5466 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5467 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5468 it
->method
= GET_FROM_STRING
;
5469 it
->stop_charpos
= 0;
5470 it
->end_charpos
= SCHARS (it
->string
);
5471 if (it
->cmp_it
.stop_pos
>= 0)
5472 it
->cmp_it
.stop_pos
= 0;
5474 it
->base_level_stop
= 0;
5476 /* Set up the bidi iterator for this overlay string. */
5479 it
->bidi_it
.string
.lstring
= it
->string
;
5480 it
->bidi_it
.string
.s
= NULL
;
5481 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5482 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5483 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5484 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5485 it
->bidi_it
.w
= it
->w
;
5486 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5494 /* Compare two overlay_entry structures E1 and E2. Used as a
5495 comparison function for qsort in load_overlay_strings. Overlay
5496 strings for the same position are sorted so that
5498 1. All after-strings come in front of before-strings, except
5499 when they come from the same overlay.
5501 2. Within after-strings, strings are sorted so that overlay strings
5502 from overlays with higher priorities come first.
5504 2. Within before-strings, strings are sorted so that overlay
5505 strings from overlays with higher priorities come last.
5507 Value is analogous to strcmp. */
5511 compare_overlay_entries (const void *e1
, const void *e2
)
5513 struct overlay_entry
const *entry1
= e1
;
5514 struct overlay_entry
const *entry2
= e2
;
5517 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5519 /* Let after-strings appear in front of before-strings if
5520 they come from different overlays. */
5521 if (EQ (entry1
->overlay
, entry2
->overlay
))
5522 result
= entry1
->after_string_p
? 1 : -1;
5524 result
= entry1
->after_string_p
? -1 : 1;
5526 else if (entry1
->priority
!= entry2
->priority
)
5528 if (entry1
->after_string_p
)
5529 /* After-strings sorted in order of decreasing priority. */
5530 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5532 /* Before-strings sorted in order of increasing priority. */
5533 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5542 /* Load the vector IT->overlay_strings with overlay strings from IT's
5543 current buffer position, or from CHARPOS if that is > 0. Set
5544 IT->n_overlays to the total number of overlay strings found.
5546 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5547 a time. On entry into load_overlay_strings,
5548 IT->current.overlay_string_index gives the number of overlay
5549 strings that have already been loaded by previous calls to this
5552 IT->add_overlay_start contains an additional overlay start
5553 position to consider for taking overlay strings from, if non-zero.
5554 This position comes into play when the overlay has an `invisible'
5555 property, and both before and after-strings. When we've skipped to
5556 the end of the overlay, because of its `invisible' property, we
5557 nevertheless want its before-string to appear.
5558 IT->add_overlay_start will contain the overlay start position
5561 Overlay strings are sorted so that after-string strings come in
5562 front of before-string strings. Within before and after-strings,
5563 strings are sorted by overlay priority. See also function
5564 compare_overlay_entries. */
5567 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5569 Lisp_Object overlay
, window
, str
, invisible
;
5570 struct Lisp_Overlay
*ov
;
5571 ptrdiff_t start
, end
;
5572 ptrdiff_t n
= 0, i
, j
;
5574 struct overlay_entry entriesbuf
[20];
5575 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5576 struct overlay_entry
*entries
= entriesbuf
;
5580 charpos
= IT_CHARPOS (*it
);
5582 /* Append the overlay string STRING of overlay OVERLAY to vector
5583 `entries' which has size `size' and currently contains `n'
5584 elements. AFTER_P means STRING is an after-string of
5586 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5589 Lisp_Object priority; \
5593 struct overlay_entry *old = entries; \
5594 SAFE_NALLOCA (entries, 2, size); \
5595 memcpy (entries, old, size * sizeof *entries); \
5599 entries[n].string = (STRING); \
5600 entries[n].overlay = (OVERLAY); \
5601 priority = Foverlay_get ((OVERLAY), Qpriority); \
5602 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5603 entries[n].after_string_p = (AFTER_P); \
5608 /* Process overlay before the overlay center. */
5609 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5611 XSETMISC (overlay
, ov
);
5612 eassert (OVERLAYP (overlay
));
5613 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5614 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5619 /* Skip this overlay if it doesn't start or end at IT's current
5621 if (end
!= charpos
&& start
!= charpos
)
5624 /* Skip this overlay if it doesn't apply to IT->w. */
5625 window
= Foverlay_get (overlay
, Qwindow
);
5626 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5629 /* If the text ``under'' the overlay is invisible, both before-
5630 and after-strings from this overlay are visible; start and
5631 end position are indistinguishable. */
5632 invisible
= Foverlay_get (overlay
, Qinvisible
);
5633 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5635 /* If overlay has a non-empty before-string, record it. */
5636 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5637 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5639 RECORD_OVERLAY_STRING (overlay
, str
, false);
5641 /* If overlay has a non-empty after-string, record it. */
5642 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5643 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5645 RECORD_OVERLAY_STRING (overlay
, str
, true);
5648 /* Process overlays after the overlay center. */
5649 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5651 XSETMISC (overlay
, ov
);
5652 eassert (OVERLAYP (overlay
));
5653 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5654 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5656 if (start
> charpos
)
5659 /* Skip this overlay if it doesn't start or end at IT's current
5661 if (end
!= charpos
&& start
!= charpos
)
5664 /* Skip this overlay if it doesn't apply to IT->w. */
5665 window
= Foverlay_get (overlay
, Qwindow
);
5666 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5669 /* If the text ``under'' the overlay is invisible, it has a zero
5670 dimension, and both before- and after-strings apply. */
5671 invisible
= Foverlay_get (overlay
, Qinvisible
);
5672 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5674 /* If overlay has a non-empty before-string, record it. */
5675 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5676 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5678 RECORD_OVERLAY_STRING (overlay
, str
, false);
5680 /* If overlay has a non-empty after-string, record it. */
5681 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5682 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5684 RECORD_OVERLAY_STRING (overlay
, str
, true);
5687 #undef RECORD_OVERLAY_STRING
5691 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5693 /* Record number of overlay strings, and where we computed it. */
5694 it
->n_overlay_strings
= n
;
5695 it
->overlay_strings_charpos
= charpos
;
5697 /* IT->current.overlay_string_index is the number of overlay strings
5698 that have already been consumed by IT. Copy some of the
5699 remaining overlay strings to IT->overlay_strings. */
5701 j
= it
->current
.overlay_string_index
;
5702 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5704 it
->overlay_strings
[i
] = entries
[j
].string
;
5705 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5713 /* Get the first chunk of overlay strings at IT's current buffer
5714 position, or at CHARPOS if that is > 0. Value is true if at
5715 least one overlay string was found. */
5718 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5720 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5721 process. This fills IT->overlay_strings with strings, and sets
5722 IT->n_overlay_strings to the total number of strings to process.
5723 IT->pos.overlay_string_index has to be set temporarily to zero
5724 because load_overlay_strings needs this; it must be set to -1
5725 when no overlay strings are found because a zero value would
5726 indicate a position in the first overlay string. */
5727 it
->current
.overlay_string_index
= 0;
5728 load_overlay_strings (it
, charpos
);
5730 /* If we found overlay strings, set up IT to deliver display
5731 elements from the first one. Otherwise set up IT to deliver
5732 from current_buffer. */
5733 if (it
->n_overlay_strings
)
5735 /* Make sure we know settings in current_buffer, so that we can
5736 restore meaningful values when we're done with the overlay
5739 compute_stop_pos (it
);
5740 eassert (it
->face_id
>= 0);
5742 /* Save IT's settings. They are restored after all overlay
5743 strings have been processed. */
5744 eassert (!compute_stop_p
|| it
->sp
== 0);
5746 /* When called from handle_stop, there might be an empty display
5747 string loaded. In that case, don't bother saving it. But
5748 don't use this optimization with the bidi iterator, since we
5749 need the corresponding pop_it call to resync the bidi
5750 iterator's position with IT's position, after we are done
5751 with the overlay strings. (The corresponding call to pop_it
5752 in case of an empty display string is in
5753 next_overlay_string.) */
5755 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5758 /* Set up IT to deliver display elements from the first overlay
5760 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5761 it
->string
= it
->overlay_strings
[0];
5762 it
->from_overlay
= Qnil
;
5763 it
->stop_charpos
= 0;
5764 eassert (STRINGP (it
->string
));
5765 it
->end_charpos
= SCHARS (it
->string
);
5767 it
->base_level_stop
= 0;
5768 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5769 it
->method
= GET_FROM_STRING
;
5770 it
->from_disp_prop_p
= 0;
5772 /* Force paragraph direction to be that of the parent
5774 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5775 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5777 it
->paragraph_embedding
= L2R
;
5779 /* Set up the bidi iterator for this overlay string. */
5782 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5784 it
->bidi_it
.string
.lstring
= it
->string
;
5785 it
->bidi_it
.string
.s
= NULL
;
5786 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5787 it
->bidi_it
.string
.bufpos
= pos
;
5788 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5789 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5790 it
->bidi_it
.w
= it
->w
;
5791 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5796 it
->current
.overlay_string_index
= -1;
5801 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5804 it
->method
= GET_FROM_BUFFER
;
5806 get_overlay_strings_1 (it
, charpos
, true);
5810 /* Value is true if we found at least one overlay string. */
5811 return STRINGP (it
->string
);
5816 /***********************************************************************
5817 Saving and restoring state
5818 ***********************************************************************/
5820 /* Save current settings of IT on IT->stack. Called, for example,
5821 before setting up IT for an overlay string, to be able to restore
5822 IT's settings to what they were after the overlay string has been
5823 processed. If POSITION is non-NULL, it is the position to save on
5824 the stack instead of IT->position. */
5827 push_it (struct it
*it
, struct text_pos
*position
)
5829 struct iterator_stack_entry
*p
;
5831 eassert (it
->sp
< IT_STACK_SIZE
);
5832 p
= it
->stack
+ it
->sp
;
5834 p
->stop_charpos
= it
->stop_charpos
;
5835 p
->prev_stop
= it
->prev_stop
;
5836 p
->base_level_stop
= it
->base_level_stop
;
5837 p
->cmp_it
= it
->cmp_it
;
5838 eassert (it
->face_id
>= 0);
5839 p
->face_id
= it
->face_id
;
5840 p
->string
= it
->string
;
5841 p
->method
= it
->method
;
5842 p
->from_overlay
= it
->from_overlay
;
5845 case GET_FROM_IMAGE
:
5846 p
->u
.image
.object
= it
->object
;
5847 p
->u
.image
.image_id
= it
->image_id
;
5848 p
->u
.image
.slice
= it
->slice
;
5850 case GET_FROM_STRETCH
:
5851 p
->u
.stretch
.object
= it
->object
;
5854 p
->position
= position
? *position
: it
->position
;
5855 p
->current
= it
->current
;
5856 p
->end_charpos
= it
->end_charpos
;
5857 p
->string_nchars
= it
->string_nchars
;
5859 p
->multibyte_p
= it
->multibyte_p
;
5860 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5861 p
->space_width
= it
->space_width
;
5862 p
->font_height
= it
->font_height
;
5863 p
->voffset
= it
->voffset
;
5864 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5865 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5866 p
->display_ellipsis_p
= false;
5867 p
->line_wrap
= it
->line_wrap
;
5868 p
->bidi_p
= it
->bidi_p
;
5869 p
->paragraph_embedding
= it
->paragraph_embedding
;
5870 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5873 /* Save the state of the bidi iterator as well. */
5875 bidi_push_it (&it
->bidi_it
);
5879 iterate_out_of_display_property (struct it
*it
)
5881 bool buffer_p
= !STRINGP (it
->string
);
5882 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5883 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5885 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5887 /* Maybe initialize paragraph direction. If we are at the beginning
5888 of a new paragraph, next_element_from_buffer may not have a
5889 chance to do that. */
5890 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5891 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5892 /* prev_stop can be zero, so check against BEGV as well. */
5893 while (it
->bidi_it
.charpos
>= bob
5894 && it
->prev_stop
<= it
->bidi_it
.charpos
5895 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5896 && it
->bidi_it
.charpos
< eob
)
5897 bidi_move_to_visually_next (&it
->bidi_it
);
5898 /* Record the stop_pos we just crossed, for when we cross it
5900 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5901 it
->prev_stop
= CHARPOS (it
->position
);
5902 /* If we ended up not where pop_it put us, resync IT's
5903 positional members with the bidi iterator. */
5904 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5905 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5907 it
->current
.pos
= it
->position
;
5909 it
->current
.string_pos
= it
->position
;
5912 /* Restore IT's settings from IT->stack. Called, for example, when no
5913 more overlay strings must be processed, and we return to delivering
5914 display elements from a buffer, or when the end of a string from a
5915 `display' property is reached and we return to delivering display
5916 elements from an overlay string, or from a buffer. */
5919 pop_it (struct it
*it
)
5921 struct iterator_stack_entry
*p
;
5922 bool from_display_prop
= it
->from_disp_prop_p
;
5924 eassert (it
->sp
> 0);
5926 p
= it
->stack
+ it
->sp
;
5927 it
->stop_charpos
= p
->stop_charpos
;
5928 it
->prev_stop
= p
->prev_stop
;
5929 it
->base_level_stop
= p
->base_level_stop
;
5930 it
->cmp_it
= p
->cmp_it
;
5931 it
->face_id
= p
->face_id
;
5932 it
->current
= p
->current
;
5933 it
->position
= p
->position
;
5934 it
->string
= p
->string
;
5935 it
->from_overlay
= p
->from_overlay
;
5936 if (NILP (it
->string
))
5937 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5938 it
->method
= p
->method
;
5941 case GET_FROM_IMAGE
:
5942 it
->image_id
= p
->u
.image
.image_id
;
5943 it
->object
= p
->u
.image
.object
;
5944 it
->slice
= p
->u
.image
.slice
;
5946 case GET_FROM_STRETCH
:
5947 it
->object
= p
->u
.stretch
.object
;
5949 case GET_FROM_BUFFER
:
5950 it
->object
= it
->w
->contents
;
5952 case GET_FROM_STRING
:
5954 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5956 /* Restore the face_box_p flag, since it could have been
5957 overwritten by the face of the object that we just finished
5960 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
5961 it
->object
= it
->string
;
5964 case GET_FROM_DISPLAY_VECTOR
:
5966 it
->method
= GET_FROM_C_STRING
;
5967 else if (STRINGP (it
->string
))
5968 it
->method
= GET_FROM_STRING
;
5971 it
->method
= GET_FROM_BUFFER
;
5972 it
->object
= it
->w
->contents
;
5975 it
->end_charpos
= p
->end_charpos
;
5976 it
->string_nchars
= p
->string_nchars
;
5978 it
->multibyte_p
= p
->multibyte_p
;
5979 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5980 it
->space_width
= p
->space_width
;
5981 it
->font_height
= p
->font_height
;
5982 it
->voffset
= p
->voffset
;
5983 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5984 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5985 it
->line_wrap
= p
->line_wrap
;
5986 it
->bidi_p
= p
->bidi_p
;
5987 it
->paragraph_embedding
= p
->paragraph_embedding
;
5988 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5991 bidi_pop_it (&it
->bidi_it
);
5992 /* Bidi-iterate until we get out of the portion of text, if any,
5993 covered by a `display' text property or by an overlay with
5994 `display' property. (We cannot just jump there, because the
5995 internal coherency of the bidi iterator state can not be
5996 preserved across such jumps.) We also must determine the
5997 paragraph base direction if the overlay we just processed is
5998 at the beginning of a new paragraph. */
5999 if (from_display_prop
6000 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6001 iterate_out_of_display_property (it
);
6003 eassert ((BUFFERP (it
->object
)
6004 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6005 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6006 || (STRINGP (it
->object
)
6007 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6008 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6009 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6015 /***********************************************************************
6017 ***********************************************************************/
6019 /* Set IT's current position to the previous line start. */
6022 back_to_previous_line_start (struct it
*it
)
6024 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6027 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6031 /* Move IT to the next line start.
6033 Value is true if a newline was found. Set *SKIPPED_P to true if
6034 we skipped over part of the text (as opposed to moving the iterator
6035 continuously over the text). Otherwise, don't change the value
6038 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6039 iterator on the newline, if it was found.
6041 Newlines may come from buffer text, overlay strings, or strings
6042 displayed via the `display' property. That's the reason we can't
6043 simply use find_newline_no_quit.
6045 Note that this function may not skip over invisible text that is so
6046 because of text properties and immediately follows a newline. If
6047 it would, function reseat_at_next_visible_line_start, when called
6048 from set_iterator_to_next, would effectively make invisible
6049 characters following a newline part of the wrong glyph row, which
6050 leads to wrong cursor motion. */
6053 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6054 struct bidi_it
*bidi_it_prev
)
6056 ptrdiff_t old_selective
;
6057 bool newline_found_p
= false;
6059 const int MAX_NEWLINE_DISTANCE
= 500;
6061 /* If already on a newline, just consume it to avoid unintended
6062 skipping over invisible text below. */
6063 if (it
->what
== IT_CHARACTER
6065 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6067 if (it
->bidi_p
&& bidi_it_prev
)
6068 *bidi_it_prev
= it
->bidi_it
;
6069 set_iterator_to_next (it
, false);
6074 /* Don't handle selective display in the following. It's (a)
6075 unnecessary because it's done by the caller, and (b) leads to an
6076 infinite recursion because next_element_from_ellipsis indirectly
6077 calls this function. */
6078 old_selective
= it
->selective
;
6081 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6082 from buffer text. */
6084 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6085 n
+= !STRINGP (it
->string
))
6087 if (!get_next_display_element (it
))
6089 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6090 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6091 *bidi_it_prev
= it
->bidi_it
;
6092 set_iterator_to_next (it
, false);
6095 /* If we didn't find a newline near enough, see if we can use a
6097 if (!newline_found_p
)
6099 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6100 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6104 eassert (!STRINGP (it
->string
));
6106 /* If there isn't any `display' property in sight, and no
6107 overlays, we can just use the position of the newline in
6109 if (it
->stop_charpos
>= limit
6110 || ((pos
= Fnext_single_property_change (make_number (start
),
6112 make_number (limit
)),
6114 && next_overlay_change (start
) == ZV
))
6118 IT_CHARPOS (*it
) = limit
;
6119 IT_BYTEPOS (*it
) = bytepos
;
6123 struct bidi_it bprev
;
6125 /* Help bidi.c avoid expensive searches for display
6126 properties and overlays, by telling it that there are
6127 none up to `limit'. */
6128 if (it
->bidi_it
.disp_pos
< limit
)
6130 it
->bidi_it
.disp_pos
= limit
;
6131 it
->bidi_it
.disp_prop
= 0;
6134 bprev
= it
->bidi_it
;
6135 bidi_move_to_visually_next (&it
->bidi_it
);
6136 } while (it
->bidi_it
.charpos
!= limit
);
6137 IT_CHARPOS (*it
) = limit
;
6138 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6140 *bidi_it_prev
= bprev
;
6142 *skipped_p
= newline_found_p
= true;
6146 while (get_next_display_element (it
)
6147 && !newline_found_p
)
6149 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6150 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6151 *bidi_it_prev
= it
->bidi_it
;
6152 set_iterator_to_next (it
, false);
6157 it
->selective
= old_selective
;
6158 return newline_found_p
;
6162 /* Set IT's current position to the previous visible line start. Skip
6163 invisible text that is so either due to text properties or due to
6164 selective display. Caution: this does not change IT->current_x and
6168 back_to_previous_visible_line_start (struct it
*it
)
6170 while (IT_CHARPOS (*it
) > BEGV
)
6172 back_to_previous_line_start (it
);
6174 if (IT_CHARPOS (*it
) <= BEGV
)
6177 /* If selective > 0, then lines indented more than its value are
6179 if (it
->selective
> 0
6180 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6184 /* Check the newline before point for invisibility. */
6187 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6188 Qinvisible
, it
->window
);
6189 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6193 if (IT_CHARPOS (*it
) <= BEGV
)
6198 void *it2data
= NULL
;
6201 Lisp_Object val
, overlay
;
6203 SAVE_IT (it2
, *it
, it2data
);
6205 /* If newline is part of a composition, continue from start of composition */
6206 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6207 && beg
< IT_CHARPOS (*it
))
6210 /* If newline is replaced by a display property, find start of overlay
6211 or interval and continue search from that point. */
6212 pos
= --IT_CHARPOS (it2
);
6215 bidi_unshelve_cache (NULL
, false);
6216 it2
.string_from_display_prop_p
= false;
6217 it2
.from_disp_prop_p
= false;
6218 if (handle_display_prop (&it2
) == HANDLED_RETURN
6219 && !NILP (val
= get_char_property_and_overlay
6220 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6221 && (OVERLAYP (overlay
)
6222 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6223 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6225 RESTORE_IT (it
, it
, it2data
);
6229 /* Newline is not replaced by anything -- so we are done. */
6230 RESTORE_IT (it
, it
, it2data
);
6236 IT_CHARPOS (*it
) = beg
;
6237 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6241 it
->continuation_lines_width
= 0;
6243 eassert (IT_CHARPOS (*it
) >= BEGV
);
6244 eassert (IT_CHARPOS (*it
) == BEGV
6245 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6250 /* Reseat iterator IT at the previous visible line start. Skip
6251 invisible text that is so either due to text properties or due to
6252 selective display. At the end, update IT's overlay information,
6253 face information etc. */
6256 reseat_at_previous_visible_line_start (struct it
*it
)
6258 back_to_previous_visible_line_start (it
);
6259 reseat (it
, it
->current
.pos
, true);
6264 /* Reseat iterator IT on the next visible line start in the current
6265 buffer. ON_NEWLINE_P means position IT on the newline
6266 preceding the line start. Skip over invisible text that is so
6267 because of selective display. Compute faces, overlays etc at the
6268 new position. Note that this function does not skip over text that
6269 is invisible because of text properties. */
6272 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6274 bool skipped_p
= false;
6275 struct bidi_it bidi_it_prev
;
6276 bool newline_found_p
6277 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6279 /* Skip over lines that are invisible because they are indented
6280 more than the value of IT->selective. */
6281 if (it
->selective
> 0)
6282 while (IT_CHARPOS (*it
) < ZV
6283 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6286 eassert (IT_BYTEPOS (*it
) == BEGV
6287 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6289 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6292 /* Position on the newline if that's what's requested. */
6293 if (on_newline_p
&& newline_found_p
)
6295 if (STRINGP (it
->string
))
6297 if (IT_STRING_CHARPOS (*it
) > 0)
6301 --IT_STRING_CHARPOS (*it
);
6302 --IT_STRING_BYTEPOS (*it
);
6306 /* We need to restore the bidi iterator to the state
6307 it had on the newline, and resync the IT's
6308 position with that. */
6309 it
->bidi_it
= bidi_it_prev
;
6310 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6311 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6315 else if (IT_CHARPOS (*it
) > BEGV
)
6324 /* We need to restore the bidi iterator to the state it
6325 had on the newline and resync IT with that. */
6326 it
->bidi_it
= bidi_it_prev
;
6327 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6328 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6330 reseat (it
, it
->current
.pos
, false);
6334 reseat (it
, it
->current
.pos
, false);
6341 /***********************************************************************
6342 Changing an iterator's position
6343 ***********************************************************************/
6345 /* Change IT's current position to POS in current_buffer.
6346 If FORCE_P, always check for text properties at the new position.
6347 Otherwise, text properties are only looked up if POS >=
6348 IT->check_charpos of a property. */
6351 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6353 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6355 reseat_1 (it
, pos
, false);
6357 /* Determine where to check text properties. Avoid doing it
6358 where possible because text property lookup is very expensive. */
6360 || CHARPOS (pos
) > it
->stop_charpos
6361 || CHARPOS (pos
) < original_pos
)
6365 /* For bidi iteration, we need to prime prev_stop and
6366 base_level_stop with our best estimations. */
6367 /* Implementation note: Of course, POS is not necessarily a
6368 stop position, so assigning prev_pos to it is a lie; we
6369 should have called compute_stop_backwards. However, if
6370 the current buffer does not include any R2L characters,
6371 that call would be a waste of cycles, because the
6372 iterator will never move back, and thus never cross this
6373 "fake" stop position. So we delay that backward search
6374 until the time we really need it, in next_element_from_buffer. */
6375 if (CHARPOS (pos
) != it
->prev_stop
)
6376 it
->prev_stop
= CHARPOS (pos
);
6377 if (CHARPOS (pos
) < it
->base_level_stop
)
6378 it
->base_level_stop
= 0; /* meaning it's unknown */
6384 it
->prev_stop
= it
->base_level_stop
= 0;
6393 /* Change IT's buffer position to POS. SET_STOP_P means set
6394 IT->stop_pos to POS, also. */
6397 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6399 /* Don't call this function when scanning a C string. */
6400 eassert (it
->s
== NULL
);
6402 /* POS must be a reasonable value. */
6403 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6405 it
->current
.pos
= it
->position
= pos
;
6406 it
->end_charpos
= ZV
;
6408 it
->current
.dpvec_index
= -1;
6409 it
->current
.overlay_string_index
= -1;
6410 IT_STRING_CHARPOS (*it
) = -1;
6411 IT_STRING_BYTEPOS (*it
) = -1;
6413 it
->method
= GET_FROM_BUFFER
;
6414 it
->object
= it
->w
->contents
;
6415 it
->area
= TEXT_AREA
;
6416 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6418 it
->string_from_display_prop_p
= false;
6419 it
->string_from_prefix_prop_p
= false;
6421 it
->from_disp_prop_p
= false;
6422 it
->face_before_selective_p
= false;
6425 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6427 bidi_unshelve_cache (NULL
, false);
6428 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6429 it
->bidi_it
.string
.s
= NULL
;
6430 it
->bidi_it
.string
.lstring
= Qnil
;
6431 it
->bidi_it
.string
.bufpos
= 0;
6432 it
->bidi_it
.string
.from_disp_str
= false;
6433 it
->bidi_it
.string
.unibyte
= false;
6434 it
->bidi_it
.w
= it
->w
;
6439 it
->stop_charpos
= CHARPOS (pos
);
6440 it
->base_level_stop
= CHARPOS (pos
);
6442 /* This make the information stored in it->cmp_it invalidate. */
6447 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6448 If S is non-null, it is a C string to iterate over. Otherwise,
6449 STRING gives a Lisp string to iterate over.
6451 If PRECISION > 0, don't return more then PRECISION number of
6452 characters from the string.
6454 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6455 characters have been returned. FIELD_WIDTH < 0 means an infinite
6458 MULTIBYTE = 0 means disable processing of multibyte characters,
6459 MULTIBYTE > 0 means enable it,
6460 MULTIBYTE < 0 means use IT->multibyte_p.
6462 IT must be initialized via a prior call to init_iterator before
6463 calling this function. */
6466 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6467 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6470 /* No text property checks performed by default, but see below. */
6471 it
->stop_charpos
= -1;
6473 /* Set iterator position and end position. */
6474 memset (&it
->current
, 0, sizeof it
->current
);
6475 it
->current
.overlay_string_index
= -1;
6476 it
->current
.dpvec_index
= -1;
6477 eassert (charpos
>= 0);
6479 /* If STRING is specified, use its multibyteness, otherwise use the
6480 setting of MULTIBYTE, if specified. */
6482 it
->multibyte_p
= multibyte
> 0;
6484 /* Bidirectional reordering of strings is controlled by the default
6485 value of bidi-display-reordering. Don't try to reorder while
6486 loading loadup.el, as the necessary character property tables are
6487 not yet available. */
6490 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6494 eassert (STRINGP (string
));
6495 it
->string
= string
;
6497 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6498 it
->method
= GET_FROM_STRING
;
6499 it
->current
.string_pos
= string_pos (charpos
, string
);
6503 it
->bidi_it
.string
.lstring
= string
;
6504 it
->bidi_it
.string
.s
= NULL
;
6505 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6506 it
->bidi_it
.string
.bufpos
= 0;
6507 it
->bidi_it
.string
.from_disp_str
= false;
6508 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6509 it
->bidi_it
.w
= it
->w
;
6510 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6511 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6516 it
->s
= (const unsigned char *) s
;
6519 /* Note that we use IT->current.pos, not it->current.string_pos,
6520 for displaying C strings. */
6521 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6522 if (it
->multibyte_p
)
6524 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6525 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6529 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6530 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6535 it
->bidi_it
.string
.lstring
= Qnil
;
6536 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6537 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6538 it
->bidi_it
.string
.bufpos
= 0;
6539 it
->bidi_it
.string
.from_disp_str
= false;
6540 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6541 it
->bidi_it
.w
= it
->w
;
6542 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6545 it
->method
= GET_FROM_C_STRING
;
6548 /* PRECISION > 0 means don't return more than PRECISION characters
6550 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6552 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6554 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6557 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6558 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6559 FIELD_WIDTH < 0 means infinite field width. This is useful for
6560 padding with `-' at the end of a mode line. */
6561 if (field_width
< 0)
6562 field_width
= INFINITY
;
6563 /* Implementation note: We deliberately don't enlarge
6564 it->bidi_it.string.schars here to fit it->end_charpos, because
6565 the bidi iterator cannot produce characters out of thin air. */
6566 if (field_width
> it
->end_charpos
- charpos
)
6567 it
->end_charpos
= charpos
+ field_width
;
6569 /* Use the standard display table for displaying strings. */
6570 if (DISP_TABLE_P (Vstandard_display_table
))
6571 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6573 it
->stop_charpos
= charpos
;
6574 it
->prev_stop
= charpos
;
6575 it
->base_level_stop
= 0;
6578 it
->bidi_it
.first_elt
= true;
6579 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6580 it
->bidi_it
.disp_pos
= -1;
6582 if (s
== NULL
&& it
->multibyte_p
)
6584 ptrdiff_t endpos
= SCHARS (it
->string
);
6585 if (endpos
> it
->end_charpos
)
6586 endpos
= it
->end_charpos
;
6587 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6595 /***********************************************************************
6597 ***********************************************************************/
6599 /* Map enum it_method value to corresponding next_element_from_* function. */
6601 typedef bool (*next_element_function
) (struct it
*);
6603 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6605 next_element_from_buffer
,
6606 next_element_from_display_vector
,
6607 next_element_from_string
,
6608 next_element_from_c_string
,
6609 next_element_from_image
,
6610 next_element_from_stretch
6613 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6616 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6617 (possibly with the following characters). */
6619 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6620 ((IT)->cmp_it.id >= 0 \
6621 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6622 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6623 END_CHARPOS, (IT)->w, \
6624 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6628 /* Lookup the char-table Vglyphless_char_display for character C (-1
6629 if we want information for no-font case), and return the display
6630 method symbol. By side-effect, update it->what and
6631 it->glyphless_method. This function is called from
6632 get_next_display_element for each character element, and from
6633 x_produce_glyphs when no suitable font was found. */
6636 lookup_glyphless_char_display (int c
, struct it
*it
)
6638 Lisp_Object glyphless_method
= Qnil
;
6640 if (CHAR_TABLE_P (Vglyphless_char_display
)
6641 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6645 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6646 if (CONSP (glyphless_method
))
6647 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6648 ? XCAR (glyphless_method
)
6649 : XCDR (glyphless_method
);
6652 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6656 if (NILP (glyphless_method
))
6659 /* The default is to display the character by a proper font. */
6661 /* The default for the no-font case is to display an empty box. */
6662 glyphless_method
= Qempty_box
;
6664 if (EQ (glyphless_method
, Qzero_width
))
6667 return glyphless_method
;
6668 /* This method can't be used for the no-font case. */
6669 glyphless_method
= Qempty_box
;
6671 if (EQ (glyphless_method
, Qthin_space
))
6672 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6673 else if (EQ (glyphless_method
, Qempty_box
))
6674 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6675 else if (EQ (glyphless_method
, Qhex_code
))
6676 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6677 else if (STRINGP (glyphless_method
))
6678 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6681 /* Invalid value. We use the default method. */
6682 glyphless_method
= Qnil
;
6685 it
->what
= IT_GLYPHLESS
;
6686 return glyphless_method
;
6689 /* Merge escape glyph face and cache the result. */
6691 static struct frame
*last_escape_glyph_frame
= NULL
;
6692 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6693 static int last_escape_glyph_merged_face_id
= 0;
6696 merge_escape_glyph_face (struct it
*it
)
6700 if (it
->f
== last_escape_glyph_frame
6701 && it
->face_id
== last_escape_glyph_face_id
)
6702 face_id
= last_escape_glyph_merged_face_id
;
6705 /* Merge the `escape-glyph' face into the current face. */
6706 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6707 last_escape_glyph_frame
= it
->f
;
6708 last_escape_glyph_face_id
= it
->face_id
;
6709 last_escape_glyph_merged_face_id
= face_id
;
6714 /* Likewise for glyphless glyph face. */
6716 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6717 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6718 static int last_glyphless_glyph_merged_face_id
= 0;
6721 merge_glyphless_glyph_face (struct it
*it
)
6725 if (it
->f
== last_glyphless_glyph_frame
6726 && it
->face_id
== last_glyphless_glyph_face_id
)
6727 face_id
= last_glyphless_glyph_merged_face_id
;
6730 /* Merge the `glyphless-char' face into the current face. */
6731 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6732 last_glyphless_glyph_frame
= it
->f
;
6733 last_glyphless_glyph_face_id
= it
->face_id
;
6734 last_glyphless_glyph_merged_face_id
= face_id
;
6739 /* Load IT's display element fields with information about the next
6740 display element from the current position of IT. Value is false if
6741 end of buffer (or C string) is reached. */
6744 get_next_display_element (struct it
*it
)
6746 /* True means that we found a display element. False means that
6747 we hit the end of what we iterate over. Performance note: the
6748 function pointer `method' used here turns out to be faster than
6749 using a sequence of if-statements. */
6753 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6755 if (it
->what
== IT_CHARACTER
)
6757 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6758 and only if (a) the resolved directionality of that character
6760 /* FIXME: Do we need an exception for characters from display
6762 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6763 && !inhibit_bidi_mirroring
)
6764 it
->c
= bidi_mirror_char (it
->c
);
6765 /* Map via display table or translate control characters.
6766 IT->c, IT->len etc. have been set to the next character by
6767 the function call above. If we have a display table, and it
6768 contains an entry for IT->c, translate it. Don't do this if
6769 IT->c itself comes from a display table, otherwise we could
6770 end up in an infinite recursion. (An alternative could be to
6771 count the recursion depth of this function and signal an
6772 error when a certain maximum depth is reached.) Is it worth
6774 if (success_p
&& it
->dpvec
== NULL
)
6777 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6778 bool nonascii_space_p
= false;
6779 bool nonascii_hyphen_p
= false;
6780 int c
= it
->c
; /* This is the character to display. */
6782 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6784 eassert (SINGLE_BYTE_CHAR_P (c
));
6785 if (unibyte_display_via_language_environment
)
6787 c
= DECODE_CHAR (unibyte
, c
);
6789 c
= BYTE8_TO_CHAR (it
->c
);
6792 c
= BYTE8_TO_CHAR (it
->c
);
6796 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6799 struct Lisp_Vector
*v
= XVECTOR (dv
);
6801 /* Return the first character from the display table
6802 entry, if not empty. If empty, don't display the
6803 current character. */
6806 it
->dpvec_char_len
= it
->len
;
6807 it
->dpvec
= v
->contents
;
6808 it
->dpend
= v
->contents
+ v
->header
.size
;
6809 it
->current
.dpvec_index
= 0;
6810 it
->dpvec_face_id
= -1;
6811 it
->saved_face_id
= it
->face_id
;
6812 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6813 it
->ellipsis_p
= false;
6817 set_iterator_to_next (it
, false);
6822 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6824 if (it
->what
== IT_GLYPHLESS
)
6826 /* Don't display this character. */
6827 set_iterator_to_next (it
, false);
6831 /* If `nobreak-char-display' is non-nil, we display
6832 non-ASCII spaces and hyphens specially. */
6833 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6836 nonascii_space_p
= true;
6837 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6838 nonascii_hyphen_p
= true;
6841 /* Translate control characters into `\003' or `^C' form.
6842 Control characters coming from a display table entry are
6843 currently not translated because we use IT->dpvec to hold
6844 the translation. This could easily be changed but I
6845 don't believe that it is worth doing.
6847 The characters handled by `nobreak-char-display' must be
6850 Non-printable characters and raw-byte characters are also
6851 translated to octal form. */
6852 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6853 ? (it
->area
!= TEXT_AREA
6854 /* In mode line, treat \n, \t like other crl chars. */
6857 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6858 || (c
!= '\n' && c
!= '\t'))
6860 || nonascii_hyphen_p
6862 || ! CHAR_PRINTABLE_P (c
))))
6864 /* C is a control character, non-ASCII space/hyphen,
6865 raw-byte, or a non-printable character which must be
6866 displayed either as '\003' or as `^C' where the '\\'
6867 and '^' can be defined in the display table. Fill
6868 IT->ctl_chars with glyphs for what we have to
6869 display. Then, set IT->dpvec to these glyphs. */
6876 /* Handle control characters with ^. */
6878 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6882 g
= '^'; /* default glyph for Control */
6883 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6885 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6887 g
= GLYPH_CODE_CHAR (gc
);
6888 lface_id
= GLYPH_CODE_FACE (gc
);
6892 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6893 : merge_escape_glyph_face (it
));
6895 XSETINT (it
->ctl_chars
[0], g
);
6896 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6898 goto display_control
;
6901 /* Handle non-ascii space in the mode where it only gets
6904 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6906 /* Merge `nobreak-space' into the current face. */
6907 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6909 XSETINT (it
->ctl_chars
[0], ' ');
6911 goto display_control
;
6914 /* Handle sequences that start with the "escape glyph". */
6916 /* the default escape glyph is \. */
6917 escape_glyph
= '\\';
6920 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6922 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6923 lface_id
= GLYPH_CODE_FACE (gc
);
6927 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6928 : merge_escape_glyph_face (it
));
6930 /* Draw non-ASCII hyphen with just highlighting: */
6932 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6934 XSETINT (it
->ctl_chars
[0], '-');
6936 goto display_control
;
6939 /* Draw non-ASCII space/hyphen with escape glyph: */
6941 if (nonascii_space_p
|| nonascii_hyphen_p
)
6943 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6944 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6946 goto display_control
;
6953 if (CHAR_BYTE8_P (c
))
6954 /* Display \200 instead of \17777600. */
6955 c
= CHAR_TO_BYTE8 (c
);
6956 len
= sprintf (str
, "%03o", c
);
6958 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6959 for (i
= 0; i
< len
; i
++)
6960 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6965 /* Set up IT->dpvec and return first character from it. */
6966 it
->dpvec_char_len
= it
->len
;
6967 it
->dpvec
= it
->ctl_chars
;
6968 it
->dpend
= it
->dpvec
+ ctl_len
;
6969 it
->current
.dpvec_index
= 0;
6970 it
->dpvec_face_id
= face_id
;
6971 it
->saved_face_id
= it
->face_id
;
6972 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6973 it
->ellipsis_p
= false;
6976 it
->char_to_display
= c
;
6980 it
->char_to_display
= it
->c
;
6984 #ifdef HAVE_WINDOW_SYSTEM
6985 /* Adjust face id for a multibyte character. There are no multibyte
6986 character in unibyte text. */
6987 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6990 && FRAME_WINDOW_P (it
->f
))
6992 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6994 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6996 /* Automatic composition with glyph-string. */
6997 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6999 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7003 ptrdiff_t pos
= (it
->s
? -1
7004 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7005 : IT_CHARPOS (*it
));
7008 if (it
->what
== IT_CHARACTER
)
7009 c
= it
->char_to_display
;
7012 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7016 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7017 /* TAB in a composition means display glyphs with
7018 padding space on the left or right. */
7019 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7022 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7025 #endif /* HAVE_WINDOW_SYSTEM */
7028 /* Is this character the last one of a run of characters with
7029 box? If yes, set IT->end_of_box_run_p to true. */
7033 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7035 int face_id
= underlying_face_id (it
);
7036 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7040 if (face
->box
== FACE_NO_BOX
)
7042 /* If the box comes from face properties in a
7043 display string, check faces in that string. */
7044 int string_face_id
= face_after_it_pos (it
);
7045 it
->end_of_box_run_p
7046 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7049 /* Otherwise, the box comes from the underlying face.
7050 If this is the last string character displayed, check
7051 the next buffer location. */
7052 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7053 /* n_overlay_strings is unreliable unless
7054 overlay_string_index is non-negative. */
7055 && ((it
->current
.overlay_string_index
>= 0
7056 && (it
->current
.overlay_string_index
7057 == it
->n_overlay_strings
- 1))
7058 /* A string from display property. */
7059 || it
->from_disp_prop_p
))
7063 struct text_pos pos
= it
->current
.pos
;
7065 /* For a string from a display property, the next
7066 buffer position is stored in the 'position'
7067 member of the iteration stack slot below the
7068 current one, see handle_single_display_spec. By
7069 contrast, it->current.pos was is not yet updated
7070 to point to that buffer position; that will
7071 happen in pop_it, after we finish displaying the
7072 current string. Note that we already checked
7073 above that it->sp is positive, so subtracting one
7075 if (it
->from_disp_prop_p
)
7076 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7078 INC_TEXT_POS (pos
, it
->multibyte_p
);
7080 if (CHARPOS (pos
) >= ZV
)
7081 it
->end_of_box_run_p
= true;
7084 next_face_id
= face_at_buffer_position
7085 (it
->w
, CHARPOS (pos
), &ignore
,
7086 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7087 it
->end_of_box_run_p
7088 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7094 /* next_element_from_display_vector sets this flag according to
7095 faces of the display vector glyphs, see there. */
7096 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7098 int face_id
= face_after_it_pos (it
);
7099 it
->end_of_box_run_p
7100 = (face_id
!= it
->face_id
7101 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7104 /* If we reached the end of the object we've been iterating (e.g., a
7105 display string or an overlay string), and there's something on
7106 IT->stack, proceed with what's on the stack. It doesn't make
7107 sense to return false if there's unprocessed stuff on the stack,
7108 because otherwise that stuff will never be displayed. */
7109 if (!success_p
&& it
->sp
> 0)
7111 set_iterator_to_next (it
, false);
7112 success_p
= get_next_display_element (it
);
7115 /* Value is false if end of buffer or string reached. */
7120 /* Move IT to the next display element.
7122 RESEAT_P means if called on a newline in buffer text,
7123 skip to the next visible line start.
7125 Functions get_next_display_element and set_iterator_to_next are
7126 separate because I find this arrangement easier to handle than a
7127 get_next_display_element function that also increments IT's
7128 position. The way it is we can first look at an iterator's current
7129 display element, decide whether it fits on a line, and if it does,
7130 increment the iterator position. The other way around we probably
7131 would either need a flag indicating whether the iterator has to be
7132 incremented the next time, or we would have to implement a
7133 decrement position function which would not be easy to write. */
7136 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7138 /* Reset flags indicating start and end of a sequence of characters
7139 with box. Reset them at the start of this function because
7140 moving the iterator to a new position might set them. */
7141 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7145 case GET_FROM_BUFFER
:
7146 /* The current display element of IT is a character from
7147 current_buffer. Advance in the buffer, and maybe skip over
7148 invisible lines that are so because of selective display. */
7149 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7150 reseat_at_next_visible_line_start (it
, false);
7151 else if (it
->cmp_it
.id
>= 0)
7153 /* We are currently getting glyphs from a composition. */
7156 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7157 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7163 /* Update IT's char/byte positions to point to the first
7164 character of the next grapheme cluster, or to the
7165 character visually after the current composition. */
7166 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7167 bidi_move_to_visually_next (&it
->bidi_it
);
7168 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7169 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7172 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7173 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7175 /* Composition created while scanning forward. Proceed
7176 to the next grapheme cluster. */
7177 it
->cmp_it
.from
= it
->cmp_it
.to
;
7179 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7180 && it
->cmp_it
.from
> 0)
7182 /* Composition created while scanning backward. Proceed
7183 to the previous grapheme cluster. */
7184 it
->cmp_it
.to
= it
->cmp_it
.from
;
7188 /* No more grapheme clusters in this composition.
7189 Find the next stop position. */
7190 ptrdiff_t stop
= it
->end_charpos
;
7192 if (it
->bidi_it
.scan_dir
< 0)
7193 /* Now we are scanning backward and don't know
7196 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7197 IT_BYTEPOS (*it
), stop
, Qnil
);
7202 eassert (it
->len
!= 0);
7206 IT_BYTEPOS (*it
) += it
->len
;
7207 IT_CHARPOS (*it
) += 1;
7211 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7212 /* If this is a new paragraph, determine its base
7213 direction (a.k.a. its base embedding level). */
7214 if (it
->bidi_it
.new_paragraph
)
7215 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7217 bidi_move_to_visually_next (&it
->bidi_it
);
7218 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7219 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7220 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7222 /* As the scan direction was changed, we must
7223 re-compute the stop position for composition. */
7224 ptrdiff_t stop
= it
->end_charpos
;
7225 if (it
->bidi_it
.scan_dir
< 0)
7227 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7228 IT_BYTEPOS (*it
), stop
, Qnil
);
7231 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7235 case GET_FROM_C_STRING
:
7236 /* Current display element of IT is from a C string. */
7238 /* If the string position is beyond string's end, it means
7239 next_element_from_c_string is padding the string with
7240 blanks, in which case we bypass the bidi iterator,
7241 because it cannot deal with such virtual characters. */
7242 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7244 IT_BYTEPOS (*it
) += it
->len
;
7245 IT_CHARPOS (*it
) += 1;
7249 bidi_move_to_visually_next (&it
->bidi_it
);
7250 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7251 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7255 case GET_FROM_DISPLAY_VECTOR
:
7256 /* Current display element of IT is from a display table entry.
7257 Advance in the display table definition. Reset it to null if
7258 end reached, and continue with characters from buffers/
7260 ++it
->current
.dpvec_index
;
7262 /* Restore face of the iterator to what they were before the
7263 display vector entry (these entries may contain faces). */
7264 it
->face_id
= it
->saved_face_id
;
7266 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7268 bool recheck_faces
= it
->ellipsis_p
;
7271 it
->method
= GET_FROM_C_STRING
;
7272 else if (STRINGP (it
->string
))
7273 it
->method
= GET_FROM_STRING
;
7276 it
->method
= GET_FROM_BUFFER
;
7277 it
->object
= it
->w
->contents
;
7281 it
->current
.dpvec_index
= -1;
7283 /* Skip over characters which were displayed via IT->dpvec. */
7284 if (it
->dpvec_char_len
< 0)
7285 reseat_at_next_visible_line_start (it
, true);
7286 else if (it
->dpvec_char_len
> 0)
7288 it
->len
= it
->dpvec_char_len
;
7289 set_iterator_to_next (it
, reseat_p
);
7292 /* Maybe recheck faces after display vector. */
7295 if (it
->method
== GET_FROM_STRING
)
7296 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7298 it
->stop_charpos
= IT_CHARPOS (*it
);
7303 case GET_FROM_STRING
:
7304 /* Current display element is a character from a Lisp string. */
7305 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7306 /* Don't advance past string end. These conditions are true
7307 when set_iterator_to_next is called at the end of
7308 get_next_display_element, in which case the Lisp string is
7309 already exhausted, and all we want is pop the iterator
7311 if (it
->current
.overlay_string_index
>= 0)
7313 /* This is an overlay string, so there's no padding with
7314 spaces, and the number of characters in the string is
7315 where the string ends. */
7316 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7317 goto consider_string_end
;
7321 /* Not an overlay string. There could be padding, so test
7322 against it->end_charpos. */
7323 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7324 goto consider_string_end
;
7326 if (it
->cmp_it
.id
>= 0)
7328 /* We are delivering display elements from a composition.
7329 Update the string position past the grapheme cluster
7330 we've just processed. */
7333 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7334 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7340 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7341 bidi_move_to_visually_next (&it
->bidi_it
);
7342 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7343 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7346 /* Did we exhaust all the grapheme clusters of this
7348 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7349 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7351 /* Not all the grapheme clusters were processed yet;
7352 advance to the next cluster. */
7353 it
->cmp_it
.from
= it
->cmp_it
.to
;
7355 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7356 && it
->cmp_it
.from
> 0)
7358 /* Likewise: advance to the next cluster, but going in
7359 the reverse direction. */
7360 it
->cmp_it
.to
= it
->cmp_it
.from
;
7364 /* This composition was fully processed; find the next
7365 candidate place for checking for composed
7367 /* Always limit string searches to the string length;
7368 any padding spaces are not part of the string, and
7369 there cannot be any compositions in that padding. */
7370 ptrdiff_t stop
= SCHARS (it
->string
);
7372 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7374 else if (it
->end_charpos
< stop
)
7376 /* Cf. PRECISION in reseat_to_string: we might be
7377 limited in how many of the string characters we
7379 stop
= it
->end_charpos
;
7381 composition_compute_stop_pos (&it
->cmp_it
,
7382 IT_STRING_CHARPOS (*it
),
7383 IT_STRING_BYTEPOS (*it
), stop
,
7390 /* If the string position is beyond string's end, it
7391 means next_element_from_string is padding the string
7392 with blanks, in which case we bypass the bidi
7393 iterator, because it cannot deal with such virtual
7395 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7397 IT_STRING_BYTEPOS (*it
) += it
->len
;
7398 IT_STRING_CHARPOS (*it
) += 1;
7402 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7404 bidi_move_to_visually_next (&it
->bidi_it
);
7405 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7406 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7407 /* If the scan direction changes, we may need to update
7408 the place where to check for composed characters. */
7409 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7411 ptrdiff_t stop
= SCHARS (it
->string
);
7413 if (it
->bidi_it
.scan_dir
< 0)
7415 else if (it
->end_charpos
< stop
)
7416 stop
= it
->end_charpos
;
7418 composition_compute_stop_pos (&it
->cmp_it
,
7419 IT_STRING_CHARPOS (*it
),
7420 IT_STRING_BYTEPOS (*it
), stop
,
7426 consider_string_end
:
7428 if (it
->current
.overlay_string_index
>= 0)
7430 /* IT->string is an overlay string. Advance to the
7431 next, if there is one. */
7432 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7434 it
->ellipsis_p
= false;
7435 next_overlay_string (it
);
7437 setup_for_ellipsis (it
, 0);
7442 /* IT->string is not an overlay string. If we reached
7443 its end, and there is something on IT->stack, proceed
7444 with what is on the stack. This can be either another
7445 string, this time an overlay string, or a buffer. */
7446 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7450 if (it
->method
== GET_FROM_STRING
)
7451 goto consider_string_end
;
7456 case GET_FROM_IMAGE
:
7457 case GET_FROM_STRETCH
:
7458 /* The position etc with which we have to proceed are on
7459 the stack. The position may be at the end of a string,
7460 if the `display' property takes up the whole string. */
7461 eassert (it
->sp
> 0);
7463 if (it
->method
== GET_FROM_STRING
)
7464 goto consider_string_end
;
7468 /* There are no other methods defined, so this should be a bug. */
7472 eassert (it
->method
!= GET_FROM_STRING
7473 || (STRINGP (it
->string
)
7474 && IT_STRING_CHARPOS (*it
) >= 0));
7477 /* Load IT's display element fields with information about the next
7478 display element which comes from a display table entry or from the
7479 result of translating a control character to one of the forms `^C'
7482 IT->dpvec holds the glyphs to return as characters.
7483 IT->saved_face_id holds the face id before the display vector--it
7484 is restored into IT->face_id in set_iterator_to_next. */
7487 next_element_from_display_vector (struct it
*it
)
7490 int prev_face_id
= it
->face_id
;
7494 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7496 it
->face_id
= it
->saved_face_id
;
7498 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7499 That seemed totally bogus - so I changed it... */
7500 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7502 if (GLYPH_CODE_P (gc
))
7504 struct face
*this_face
, *prev_face
, *next_face
;
7506 it
->c
= GLYPH_CODE_CHAR (gc
);
7507 it
->len
= CHAR_BYTES (it
->c
);
7509 /* The entry may contain a face id to use. Such a face id is
7510 the id of a Lisp face, not a realized face. A face id of
7511 zero means no face is specified. */
7512 if (it
->dpvec_face_id
>= 0)
7513 it
->face_id
= it
->dpvec_face_id
;
7516 int lface_id
= GLYPH_CODE_FACE (gc
);
7518 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7522 /* Glyphs in the display vector could have the box face, so we
7523 need to set the related flags in the iterator, as
7525 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7526 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7528 /* Is this character the first character of a box-face run? */
7529 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7531 || prev_face
->box
== FACE_NO_BOX
));
7533 /* For the last character of the box-face run, we need to look
7534 either at the next glyph from the display vector, or at the
7535 face we saw before the display vector. */
7536 next_face_id
= it
->saved_face_id
;
7537 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7539 if (it
->dpvec_face_id
>= 0)
7540 next_face_id
= it
->dpvec_face_id
;
7544 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7547 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7551 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7552 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7554 || next_face
->box
== FACE_NO_BOX
));
7555 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7558 /* Display table entry is invalid. Return a space. */
7559 it
->c
= ' ', it
->len
= 1;
7561 /* Don't change position and object of the iterator here. They are
7562 still the values of the character that had this display table
7563 entry or was translated, and that's what we want. */
7564 it
->what
= IT_CHARACTER
;
7568 /* Get the first element of string/buffer in the visual order, after
7569 being reseated to a new position in a string or a buffer. */
7571 get_visually_first_element (struct it
*it
)
7573 bool string_p
= STRINGP (it
->string
) || it
->s
;
7574 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7575 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7577 if (STRINGP (it
->string
))
7579 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7580 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7584 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7585 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7588 if (it
->bidi_it
.charpos
== eob
)
7590 /* Nothing to do, but reset the FIRST_ELT flag, like
7591 bidi_paragraph_init does, because we are not going to
7593 it
->bidi_it
.first_elt
= false;
7595 else if (it
->bidi_it
.charpos
== bob
7597 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7598 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7600 /* If we are at the beginning of a line/string, we can produce
7601 the next element right away. */
7602 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7603 bidi_move_to_visually_next (&it
->bidi_it
);
7607 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7609 /* We need to prime the bidi iterator starting at the line's or
7610 string's beginning, before we will be able to produce the
7613 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7615 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7616 IT_BYTEPOS (*it
), -1,
7617 &it
->bidi_it
.bytepos
);
7618 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7621 /* Now return to buffer/string position where we were asked
7622 to get the next display element, and produce that. */
7623 bidi_move_to_visually_next (&it
->bidi_it
);
7625 while (it
->bidi_it
.bytepos
!= orig_bytepos
7626 && it
->bidi_it
.charpos
< eob
);
7629 /* Adjust IT's position information to where we ended up. */
7630 if (STRINGP (it
->string
))
7632 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7633 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7637 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7638 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7641 if (STRINGP (it
->string
) || !it
->s
)
7643 ptrdiff_t stop
, charpos
, bytepos
;
7645 if (STRINGP (it
->string
))
7648 stop
= SCHARS (it
->string
);
7649 if (stop
> it
->end_charpos
)
7650 stop
= it
->end_charpos
;
7651 charpos
= IT_STRING_CHARPOS (*it
);
7652 bytepos
= IT_STRING_BYTEPOS (*it
);
7656 stop
= it
->end_charpos
;
7657 charpos
= IT_CHARPOS (*it
);
7658 bytepos
= IT_BYTEPOS (*it
);
7660 if (it
->bidi_it
.scan_dir
< 0)
7662 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7667 /* Load IT with the next display element from Lisp string IT->string.
7668 IT->current.string_pos is the current position within the string.
7669 If IT->current.overlay_string_index >= 0, the Lisp string is an
7673 next_element_from_string (struct it
*it
)
7675 struct text_pos position
;
7677 eassert (STRINGP (it
->string
));
7678 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7679 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7680 position
= it
->current
.string_pos
;
7682 /* With bidi reordering, the character to display might not be the
7683 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7684 that we were reseat()ed to a new string, whose paragraph
7685 direction is not known. */
7686 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7688 get_visually_first_element (it
);
7689 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7692 /* Time to check for invisible text? */
7693 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7695 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7698 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7699 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7701 /* With bidi non-linear iteration, we could find
7702 ourselves far beyond the last computed stop_charpos,
7703 with several other stop positions in between that we
7704 missed. Scan them all now, in buffer's logical
7705 order, until we find and handle the last stop_charpos
7706 that precedes our current position. */
7707 handle_stop_backwards (it
, it
->stop_charpos
);
7708 return GET_NEXT_DISPLAY_ELEMENT (it
);
7714 /* Take note of the stop position we just moved
7715 across, for when we will move back across it. */
7716 it
->prev_stop
= it
->stop_charpos
;
7717 /* If we are at base paragraph embedding level, take
7718 note of the last stop position seen at this
7720 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7721 it
->base_level_stop
= it
->stop_charpos
;
7725 /* Since a handler may have changed IT->method, we must
7727 return GET_NEXT_DISPLAY_ELEMENT (it
);
7731 /* If we are before prev_stop, we may have overstepped
7732 on our way backwards a stop_pos, and if so, we need
7733 to handle that stop_pos. */
7734 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7735 /* We can sometimes back up for reasons that have nothing
7736 to do with bidi reordering. E.g., compositions. The
7737 code below is only needed when we are above the base
7738 embedding level, so test for that explicitly. */
7739 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7741 /* If we lost track of base_level_stop, we have no better
7742 place for handle_stop_backwards to start from than string
7743 beginning. This happens, e.g., when we were reseated to
7744 the previous screenful of text by vertical-motion. */
7745 if (it
->base_level_stop
<= 0
7746 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7747 it
->base_level_stop
= 0;
7748 handle_stop_backwards (it
, it
->base_level_stop
);
7749 return GET_NEXT_DISPLAY_ELEMENT (it
);
7753 if (it
->current
.overlay_string_index
>= 0)
7755 /* Get the next character from an overlay string. In overlay
7756 strings, there is no field width or padding with spaces to
7758 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7763 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7764 IT_STRING_BYTEPOS (*it
),
7765 it
->bidi_it
.scan_dir
< 0
7767 : SCHARS (it
->string
))
7768 && next_element_from_composition (it
))
7772 else if (STRING_MULTIBYTE (it
->string
))
7774 const unsigned char *s
= (SDATA (it
->string
)
7775 + IT_STRING_BYTEPOS (*it
));
7776 it
->c
= string_char_and_length (s
, &it
->len
);
7780 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7786 /* Get the next character from a Lisp string that is not an
7787 overlay string. Such strings come from the mode line, for
7788 example. We may have to pad with spaces, or truncate the
7789 string. See also next_element_from_c_string. */
7790 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7795 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7797 /* Pad with spaces. */
7798 it
->c
= ' ', it
->len
= 1;
7799 CHARPOS (position
) = BYTEPOS (position
) = -1;
7801 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7802 IT_STRING_BYTEPOS (*it
),
7803 it
->bidi_it
.scan_dir
< 0
7805 : it
->string_nchars
)
7806 && next_element_from_composition (it
))
7810 else if (STRING_MULTIBYTE (it
->string
))
7812 const unsigned char *s
= (SDATA (it
->string
)
7813 + IT_STRING_BYTEPOS (*it
));
7814 it
->c
= string_char_and_length (s
, &it
->len
);
7818 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7823 /* Record what we have and where it came from. */
7824 it
->what
= IT_CHARACTER
;
7825 it
->object
= it
->string
;
7826 it
->position
= position
;
7831 /* Load IT with next display element from C string IT->s.
7832 IT->string_nchars is the maximum number of characters to return
7833 from the string. IT->end_charpos may be greater than
7834 IT->string_nchars when this function is called, in which case we
7835 may have to return padding spaces. Value is false if end of string
7836 reached, including padding spaces. */
7839 next_element_from_c_string (struct it
*it
)
7841 bool success_p
= true;
7844 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7845 it
->what
= IT_CHARACTER
;
7846 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7847 it
->object
= make_number (0);
7849 /* With bidi reordering, the character to display might not be the
7850 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7851 we were reseated to a new string, whose paragraph direction is
7853 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7854 get_visually_first_element (it
);
7856 /* IT's position can be greater than IT->string_nchars in case a
7857 field width or precision has been specified when the iterator was
7859 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7861 /* End of the game. */
7865 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7867 /* Pad with spaces. */
7868 it
->c
= ' ', it
->len
= 1;
7869 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7871 else if (it
->multibyte_p
)
7872 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7874 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7880 /* Set up IT to return characters from an ellipsis, if appropriate.
7881 The definition of the ellipsis glyphs may come from a display table
7882 entry. This function fills IT with the first glyph from the
7883 ellipsis if an ellipsis is to be displayed. */
7886 next_element_from_ellipsis (struct it
*it
)
7888 if (it
->selective_display_ellipsis_p
)
7889 setup_for_ellipsis (it
, it
->len
);
7892 /* The face at the current position may be different from the
7893 face we find after the invisible text. Remember what it
7894 was in IT->saved_face_id, and signal that it's there by
7895 setting face_before_selective_p. */
7896 it
->saved_face_id
= it
->face_id
;
7897 it
->method
= GET_FROM_BUFFER
;
7898 it
->object
= it
->w
->contents
;
7899 reseat_at_next_visible_line_start (it
, true);
7900 it
->face_before_selective_p
= true;
7903 return GET_NEXT_DISPLAY_ELEMENT (it
);
7907 /* Deliver an image display element. The iterator IT is already
7908 filled with image information (done in handle_display_prop). Value
7913 next_element_from_image (struct it
*it
)
7915 it
->what
= IT_IMAGE
;
7920 /* Fill iterator IT with next display element from a stretch glyph
7921 property. IT->object is the value of the text property. Value is
7925 next_element_from_stretch (struct it
*it
)
7927 it
->what
= IT_STRETCH
;
7931 /* Scan backwards from IT's current position until we find a stop
7932 position, or until BEGV. This is called when we find ourself
7933 before both the last known prev_stop and base_level_stop while
7934 reordering bidirectional text. */
7937 compute_stop_pos_backwards (struct it
*it
)
7939 const int SCAN_BACK_LIMIT
= 1000;
7940 struct text_pos pos
;
7941 struct display_pos save_current
= it
->current
;
7942 struct text_pos save_position
= it
->position
;
7943 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7944 ptrdiff_t where_we_are
= charpos
;
7945 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7946 ptrdiff_t save_end_pos
= it
->end_charpos
;
7948 eassert (NILP (it
->string
) && !it
->s
);
7949 eassert (it
->bidi_p
);
7953 it
->end_charpos
= min (charpos
+ 1, ZV
);
7954 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7955 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
7956 reseat_1 (it
, pos
, false);
7957 compute_stop_pos (it
);
7958 /* We must advance forward, right? */
7959 if (it
->stop_charpos
<= charpos
)
7962 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7964 if (it
->stop_charpos
<= where_we_are
)
7965 it
->prev_stop
= it
->stop_charpos
;
7967 it
->prev_stop
= BEGV
;
7969 it
->current
= save_current
;
7970 it
->position
= save_position
;
7971 it
->stop_charpos
= save_stop_pos
;
7972 it
->end_charpos
= save_end_pos
;
7975 /* Scan forward from CHARPOS in the current buffer/string, until we
7976 find a stop position > current IT's position. Then handle the stop
7977 position before that. This is called when we bump into a stop
7978 position while reordering bidirectional text. CHARPOS should be
7979 the last previously processed stop_pos (or BEGV/0, if none were
7980 processed yet) whose position is less that IT's current
7984 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
7986 bool bufp
= !STRINGP (it
->string
);
7987 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7988 struct display_pos save_current
= it
->current
;
7989 struct text_pos save_position
= it
->position
;
7990 struct text_pos pos1
;
7991 ptrdiff_t next_stop
;
7993 /* Scan in strict logical order. */
7994 eassert (it
->bidi_p
);
7998 it
->prev_stop
= charpos
;
8001 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8002 reseat_1 (it
, pos1
, false);
8005 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8006 compute_stop_pos (it
);
8007 /* We must advance forward, right? */
8008 if (it
->stop_charpos
<= it
->prev_stop
)
8010 charpos
= it
->stop_charpos
;
8012 while (charpos
<= where_we_are
);
8015 it
->current
= save_current
;
8016 it
->position
= save_position
;
8017 next_stop
= it
->stop_charpos
;
8018 it
->stop_charpos
= it
->prev_stop
;
8020 it
->stop_charpos
= next_stop
;
8023 /* Load IT with the next display element from current_buffer. Value
8024 is false if end of buffer reached. IT->stop_charpos is the next
8025 position at which to stop and check for text properties or buffer
8029 next_element_from_buffer (struct it
*it
)
8031 bool success_p
= true;
8033 eassert (IT_CHARPOS (*it
) >= BEGV
);
8034 eassert (NILP (it
->string
) && !it
->s
);
8035 eassert (!it
->bidi_p
8036 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8037 && it
->bidi_it
.string
.s
== NULL
));
8039 /* With bidi reordering, the character to display might not be the
8040 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8041 we were reseat()ed to a new buffer position, which is potentially
8042 a different paragraph. */
8043 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8045 get_visually_first_element (it
);
8046 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8049 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8051 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8053 bool overlay_strings_follow_p
;
8055 /* End of the game, except when overlay strings follow that
8056 haven't been returned yet. */
8057 if (it
->overlay_strings_at_end_processed_p
)
8058 overlay_strings_follow_p
= false;
8061 it
->overlay_strings_at_end_processed_p
= true;
8062 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8065 if (overlay_strings_follow_p
)
8066 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8070 it
->position
= it
->current
.pos
;
8074 else if (!(!it
->bidi_p
8075 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8076 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8078 /* With bidi non-linear iteration, we could find ourselves
8079 far beyond the last computed stop_charpos, with several
8080 other stop positions in between that we missed. Scan
8081 them all now, in buffer's logical order, until we find
8082 and handle the last stop_charpos that precedes our
8083 current position. */
8084 handle_stop_backwards (it
, it
->stop_charpos
);
8085 it
->ignore_overlay_strings_at_pos_p
= false;
8086 return GET_NEXT_DISPLAY_ELEMENT (it
);
8092 /* Take note of the stop position we just moved across,
8093 for when we will move back across it. */
8094 it
->prev_stop
= it
->stop_charpos
;
8095 /* If we are at base paragraph embedding level, take
8096 note of the last stop position seen at this
8098 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8099 it
->base_level_stop
= it
->stop_charpos
;
8102 it
->ignore_overlay_strings_at_pos_p
= false;
8103 return GET_NEXT_DISPLAY_ELEMENT (it
);
8107 /* If we are before prev_stop, we may have overstepped on
8108 our way backwards a stop_pos, and if so, we need to
8109 handle that stop_pos. */
8110 && IT_CHARPOS (*it
) < it
->prev_stop
8111 /* We can sometimes back up for reasons that have nothing
8112 to do with bidi reordering. E.g., compositions. The
8113 code below is only needed when we are above the base
8114 embedding level, so test for that explicitly. */
8115 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8117 if (it
->base_level_stop
<= 0
8118 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8120 /* If we lost track of base_level_stop, we need to find
8121 prev_stop by looking backwards. This happens, e.g., when
8122 we were reseated to the previous screenful of text by
8124 it
->base_level_stop
= BEGV
;
8125 compute_stop_pos_backwards (it
);
8126 handle_stop_backwards (it
, it
->prev_stop
);
8129 handle_stop_backwards (it
, it
->base_level_stop
);
8130 it
->ignore_overlay_strings_at_pos_p
= false;
8131 return GET_NEXT_DISPLAY_ELEMENT (it
);
8135 /* No face changes, overlays etc. in sight, so just return a
8136 character from current_buffer. */
8140 /* We moved to the next buffer position, so any info about
8141 previously seen overlays is no longer valid. */
8142 it
->ignore_overlay_strings_at_pos_p
= false;
8144 /* Maybe run the redisplay end trigger hook. Performance note:
8145 This doesn't seem to cost measurable time. */
8146 if (it
->redisplay_end_trigger_charpos
8148 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8149 run_redisplay_end_trigger_hook (it
);
8151 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8152 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8154 && next_element_from_composition (it
))
8159 /* Get the next character, maybe multibyte. */
8160 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8161 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8162 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8164 it
->c
= *p
, it
->len
= 1;
8166 /* Record what we have and where it came from. */
8167 it
->what
= IT_CHARACTER
;
8168 it
->object
= it
->w
->contents
;
8169 it
->position
= it
->current
.pos
;
8171 /* Normally we return the character found above, except when we
8172 really want to return an ellipsis for selective display. */
8177 /* A value of selective > 0 means hide lines indented more
8178 than that number of columns. */
8179 if (it
->selective
> 0
8180 && IT_CHARPOS (*it
) + 1 < ZV
8181 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8182 IT_BYTEPOS (*it
) + 1,
8185 success_p
= next_element_from_ellipsis (it
);
8186 it
->dpvec_char_len
= -1;
8189 else if (it
->c
== '\r' && it
->selective
== -1)
8191 /* A value of selective == -1 means that everything from the
8192 CR to the end of the line is invisible, with maybe an
8193 ellipsis displayed for it. */
8194 success_p
= next_element_from_ellipsis (it
);
8195 it
->dpvec_char_len
= -1;
8200 /* Value is false if end of buffer reached. */
8201 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8206 /* Run the redisplay end trigger hook for IT. */
8209 run_redisplay_end_trigger_hook (struct it
*it
)
8211 /* IT->glyph_row should be non-null, i.e. we should be actually
8212 displaying something, or otherwise we should not run the hook. */
8213 eassert (it
->glyph_row
);
8215 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8216 it
->redisplay_end_trigger_charpos
= 0;
8218 /* Since we are *trying* to run these functions, don't try to run
8219 them again, even if they get an error. */
8220 wset_redisplay_end_trigger (it
->w
, Qnil
);
8221 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8222 make_number (charpos
));
8224 /* Notice if it changed the face of the character we are on. */
8225 handle_face_prop (it
);
8229 /* Deliver a composition display element. Unlike the other
8230 next_element_from_XXX, this function is not registered in the array
8231 get_next_element[]. It is called from next_element_from_buffer and
8232 next_element_from_string when necessary. */
8235 next_element_from_composition (struct it
*it
)
8237 it
->what
= IT_COMPOSITION
;
8238 it
->len
= it
->cmp_it
.nbytes
;
8239 if (STRINGP (it
->string
))
8243 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8244 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8247 it
->position
= it
->current
.string_pos
;
8248 it
->object
= it
->string
;
8249 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8250 IT_STRING_BYTEPOS (*it
), it
->string
);
8256 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8257 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8260 if (it
->bidi_it
.new_paragraph
)
8261 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8263 /* Resync the bidi iterator with IT's new position.
8264 FIXME: this doesn't support bidirectional text. */
8265 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8266 bidi_move_to_visually_next (&it
->bidi_it
);
8270 it
->position
= it
->current
.pos
;
8271 it
->object
= it
->w
->contents
;
8272 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8273 IT_BYTEPOS (*it
), Qnil
);
8280 /***********************************************************************
8281 Moving an iterator without producing glyphs
8282 ***********************************************************************/
8284 /* Check if iterator is at a position corresponding to a valid buffer
8285 position after some move_it_ call. */
8287 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8288 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8291 /* Move iterator IT to a specified buffer or X position within one
8292 line on the display without producing glyphs.
8294 OP should be a bit mask including some or all of these bits:
8295 MOVE_TO_X: Stop upon reaching x-position TO_X.
8296 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8297 Regardless of OP's value, stop upon reaching the end of the display line.
8299 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8300 This means, in particular, that TO_X includes window's horizontal
8303 The return value has several possible values that
8304 say what condition caused the scan to stop:
8306 MOVE_POS_MATCH_OR_ZV
8307 - when TO_POS or ZV was reached.
8310 -when TO_X was reached before TO_POS or ZV were reached.
8313 - when we reached the end of the display area and the line must
8317 - when we reached the end of the display area and the line is
8321 - when we stopped at a line end, i.e. a newline or a CR and selective
8324 static enum move_it_result
8325 move_it_in_display_line_to (struct it
*it
,
8326 ptrdiff_t to_charpos
, int to_x
,
8327 enum move_operation_enum op
)
8329 enum move_it_result result
= MOVE_UNDEFINED
;
8330 struct glyph_row
*saved_glyph_row
;
8331 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8332 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8333 void *ppos_data
= NULL
;
8334 bool may_wrap
= false;
8335 enum it_method prev_method
= it
->method
;
8336 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8337 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8339 /* Don't produce glyphs in produce_glyphs. */
8340 saved_glyph_row
= it
->glyph_row
;
8341 it
->glyph_row
= NULL
;
8343 /* Use wrap_it to save a copy of IT wherever a word wrap could
8344 occur. Use atpos_it to save a copy of IT at the desired buffer
8345 position, if found, so that we can scan ahead and check if the
8346 word later overshoots the window edge. Use atx_it similarly, for
8352 /* Use ppos_it under bidi reordering to save a copy of IT for the
8353 initial position. We restore that position in IT when we have
8354 scanned the entire display line without finding a match for
8355 TO_CHARPOS and all the character positions are greater than
8356 TO_CHARPOS. We then restart the scan from the initial position,
8357 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8358 the closest to TO_CHARPOS. */
8361 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8363 SAVE_IT (ppos_it
, *it
, ppos_data
);
8364 closest_pos
= IT_CHARPOS (*it
);
8370 #define BUFFER_POS_REACHED_P() \
8371 ((op & MOVE_TO_POS) != 0 \
8372 && BUFFERP (it->object) \
8373 && (IT_CHARPOS (*it) == to_charpos \
8375 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8376 && IT_CHARPOS (*it) > to_charpos) \
8377 || (it->what == IT_COMPOSITION \
8378 && ((IT_CHARPOS (*it) > to_charpos \
8379 && to_charpos >= it->cmp_it.charpos) \
8380 || (IT_CHARPOS (*it) < to_charpos \
8381 && to_charpos <= it->cmp_it.charpos)))) \
8382 && (it->method == GET_FROM_BUFFER \
8383 || (it->method == GET_FROM_DISPLAY_VECTOR \
8384 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8386 /* If there's a line-/wrap-prefix, handle it. */
8387 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8388 && it
->current_y
< it
->last_visible_y
)
8389 handle_line_prefix (it
);
8391 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8392 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8396 int x
, i
, ascent
= 0, descent
= 0;
8398 /* Utility macro to reset an iterator with x, ascent, and descent. */
8399 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8400 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8401 (IT)->max_descent = descent)
8403 /* Stop if we move beyond TO_CHARPOS (after an image or a
8404 display string or stretch glyph). */
8405 if ((op
& MOVE_TO_POS
) != 0
8406 && BUFFERP (it
->object
)
8407 && it
->method
== GET_FROM_BUFFER
8409 /* When the iterator is at base embedding level, we
8410 are guaranteed that characters are delivered for
8411 display in strictly increasing order of their
8412 buffer positions. */
8413 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8414 && IT_CHARPOS (*it
) > to_charpos
)
8416 && (prev_method
== GET_FROM_IMAGE
8417 || prev_method
== GET_FROM_STRETCH
8418 || prev_method
== GET_FROM_STRING
)
8419 /* Passed TO_CHARPOS from left to right. */
8420 && ((prev_pos
< to_charpos
8421 && IT_CHARPOS (*it
) > to_charpos
)
8422 /* Passed TO_CHARPOS from right to left. */
8423 || (prev_pos
> to_charpos
8424 && IT_CHARPOS (*it
) < to_charpos
)))))
8426 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8428 result
= MOVE_POS_MATCH_OR_ZV
;
8431 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8432 /* If wrap_it is valid, the current position might be in a
8433 word that is wrapped. So, save the iterator in
8434 atpos_it and continue to see if wrapping happens. */
8435 SAVE_IT (atpos_it
, *it
, atpos_data
);
8438 /* Stop when ZV reached.
8439 We used to stop here when TO_CHARPOS reached as well, but that is
8440 too soon if this glyph does not fit on this line. So we handle it
8441 explicitly below. */
8442 if (!get_next_display_element (it
))
8444 result
= MOVE_POS_MATCH_OR_ZV
;
8448 if (it
->line_wrap
== TRUNCATE
)
8450 if (BUFFER_POS_REACHED_P ())
8452 result
= MOVE_POS_MATCH_OR_ZV
;
8458 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8460 if (IT_DISPLAYING_WHITESPACE (it
))
8464 /* We have reached a glyph that follows one or more
8465 whitespace characters. If the position is
8466 already found, we are done. */
8467 if (atpos_it
.sp
>= 0)
8469 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8470 result
= MOVE_POS_MATCH_OR_ZV
;
8475 RESTORE_IT (it
, &atx_it
, atx_data
);
8476 result
= MOVE_X_REACHED
;
8479 /* Otherwise, we can wrap here. */
8480 SAVE_IT (wrap_it
, *it
, wrap_data
);
8486 /* Remember the line height for the current line, in case
8487 the next element doesn't fit on the line. */
8488 ascent
= it
->max_ascent
;
8489 descent
= it
->max_descent
;
8491 /* The call to produce_glyphs will get the metrics of the
8492 display element IT is loaded with. Record the x-position
8493 before this display element, in case it doesn't fit on the
8497 PRODUCE_GLYPHS (it
);
8499 if (it
->area
!= TEXT_AREA
)
8501 prev_method
= it
->method
;
8502 if (it
->method
== GET_FROM_BUFFER
)
8503 prev_pos
= IT_CHARPOS (*it
);
8504 set_iterator_to_next (it
, true);
8505 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8506 SET_TEXT_POS (this_line_min_pos
,
8507 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8509 && (op
& MOVE_TO_POS
)
8510 && IT_CHARPOS (*it
) > to_charpos
8511 && IT_CHARPOS (*it
) < closest_pos
)
8512 closest_pos
= IT_CHARPOS (*it
);
8516 /* The number of glyphs we get back in IT->nglyphs will normally
8517 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8518 character on a terminal frame, or (iii) a line end. For the
8519 second case, IT->nglyphs - 1 padding glyphs will be present.
8520 (On X frames, there is only one glyph produced for a
8521 composite character.)
8523 The behavior implemented below means, for continuation lines,
8524 that as many spaces of a TAB as fit on the current line are
8525 displayed there. For terminal frames, as many glyphs of a
8526 multi-glyph character are displayed in the current line, too.
8527 This is what the old redisplay code did, and we keep it that
8528 way. Under X, the whole shape of a complex character must
8529 fit on the line or it will be completely displayed in the
8532 Note that both for tabs and padding glyphs, all glyphs have
8536 /* More than one glyph or glyph doesn't fit on line. All
8537 glyphs have the same width. */
8538 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8540 int x_before_this_char
= x
;
8541 int hpos_before_this_char
= it
->hpos
;
8543 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8545 new_x
= x
+ single_glyph_width
;
8547 /* We want to leave anything reaching TO_X to the caller. */
8548 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8550 if (BUFFER_POS_REACHED_P ())
8552 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8553 goto buffer_pos_reached
;
8554 if (atpos_it
.sp
< 0)
8556 SAVE_IT (atpos_it
, *it
, atpos_data
);
8557 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8562 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8565 result
= MOVE_X_REACHED
;
8570 SAVE_IT (atx_it
, *it
, atx_data
);
8571 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8576 if (/* Lines are continued. */
8577 it
->line_wrap
!= TRUNCATE
8578 && (/* And glyph doesn't fit on the line. */
8579 new_x
> it
->last_visible_x
8580 /* Or it fits exactly and we're on a window
8582 || (new_x
== it
->last_visible_x
8583 && FRAME_WINDOW_P (it
->f
)
8584 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8585 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8586 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8588 if (/* IT->hpos == 0 means the very first glyph
8589 doesn't fit on the line, e.g. a wide image. */
8591 || (new_x
== it
->last_visible_x
8592 && FRAME_WINDOW_P (it
->f
)))
8595 it
->current_x
= new_x
;
8597 /* The character's last glyph just barely fits
8599 if (i
== it
->nglyphs
- 1)
8601 /* If this is the destination position,
8602 return a position *before* it in this row,
8603 now that we know it fits in this row. */
8604 if (BUFFER_POS_REACHED_P ())
8606 if (it
->line_wrap
!= WORD_WRAP
8609 it
->hpos
= hpos_before_this_char
;
8610 it
->current_x
= x_before_this_char
;
8611 result
= MOVE_POS_MATCH_OR_ZV
;
8614 if (it
->line_wrap
== WORD_WRAP
8617 SAVE_IT (atpos_it
, *it
, atpos_data
);
8618 atpos_it
.current_x
= x_before_this_char
;
8619 atpos_it
.hpos
= hpos_before_this_char
;
8623 prev_method
= it
->method
;
8624 if (it
->method
== GET_FROM_BUFFER
)
8625 prev_pos
= IT_CHARPOS (*it
);
8626 set_iterator_to_next (it
, true);
8627 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8628 SET_TEXT_POS (this_line_min_pos
,
8629 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8630 /* On graphical terminals, newlines may
8631 "overflow" into the fringe if
8632 overflow-newline-into-fringe is non-nil.
8633 On text terminals, and on graphical
8634 terminals with no right margin, newlines
8635 may overflow into the last glyph on the
8637 if (!FRAME_WINDOW_P (it
->f
)
8639 && it
->bidi_it
.paragraph_dir
== R2L
)
8640 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8641 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8642 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8644 if (!get_next_display_element (it
))
8646 result
= MOVE_POS_MATCH_OR_ZV
;
8649 if (BUFFER_POS_REACHED_P ())
8651 if (ITERATOR_AT_END_OF_LINE_P (it
))
8652 result
= MOVE_POS_MATCH_OR_ZV
;
8654 result
= MOVE_LINE_CONTINUED
;
8657 if (ITERATOR_AT_END_OF_LINE_P (it
)
8658 && (it
->line_wrap
!= WORD_WRAP
8660 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8662 result
= MOVE_NEWLINE_OR_CR
;
8669 IT_RESET_X_ASCENT_DESCENT (it
);
8671 if (wrap_it
.sp
>= 0)
8673 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8678 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8680 result
= MOVE_LINE_CONTINUED
;
8684 if (BUFFER_POS_REACHED_P ())
8686 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8687 goto buffer_pos_reached
;
8688 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8690 SAVE_IT (atpos_it
, *it
, atpos_data
);
8691 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8695 if (new_x
> it
->first_visible_x
)
8697 /* Glyph is visible. Increment number of glyphs that
8698 would be displayed. */
8703 if (result
!= MOVE_UNDEFINED
)
8706 else if (BUFFER_POS_REACHED_P ())
8709 IT_RESET_X_ASCENT_DESCENT (it
);
8710 result
= MOVE_POS_MATCH_OR_ZV
;
8713 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8715 /* Stop when TO_X specified and reached. This check is
8716 necessary here because of lines consisting of a line end,
8717 only. The line end will not produce any glyphs and we
8718 would never get MOVE_X_REACHED. */
8719 eassert (it
->nglyphs
== 0);
8720 result
= MOVE_X_REACHED
;
8724 /* Is this a line end? If yes, we're done. */
8725 if (ITERATOR_AT_END_OF_LINE_P (it
))
8727 /* If we are past TO_CHARPOS, but never saw any character
8728 positions smaller than TO_CHARPOS, return
8729 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8731 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8733 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8735 if (closest_pos
< ZV
)
8737 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8738 /* Don't recurse if closest_pos is equal to
8739 to_charpos, since we have just tried that. */
8740 if (closest_pos
!= to_charpos
)
8741 move_it_in_display_line_to (it
, closest_pos
, -1,
8743 result
= MOVE_POS_MATCH_OR_ZV
;
8746 goto buffer_pos_reached
;
8748 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8749 && IT_CHARPOS (*it
) > to_charpos
)
8750 goto buffer_pos_reached
;
8752 result
= MOVE_NEWLINE_OR_CR
;
8755 result
= MOVE_NEWLINE_OR_CR
;
8759 prev_method
= it
->method
;
8760 if (it
->method
== GET_FROM_BUFFER
)
8761 prev_pos
= IT_CHARPOS (*it
);
8762 /* The current display element has been consumed. Advance
8764 set_iterator_to_next (it
, true);
8765 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8766 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8767 if (IT_CHARPOS (*it
) < to_charpos
)
8768 saw_smaller_pos
= true;
8770 && (op
& MOVE_TO_POS
)
8771 && IT_CHARPOS (*it
) >= to_charpos
8772 && IT_CHARPOS (*it
) < closest_pos
)
8773 closest_pos
= IT_CHARPOS (*it
);
8775 /* Stop if lines are truncated and IT's current x-position is
8776 past the right edge of the window now. */
8777 if (it
->line_wrap
== TRUNCATE
8778 && it
->current_x
>= it
->last_visible_x
)
8780 if (!FRAME_WINDOW_P (it
->f
)
8781 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8782 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8783 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8784 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8786 bool at_eob_p
= false;
8788 if ((at_eob_p
= !get_next_display_element (it
))
8789 || BUFFER_POS_REACHED_P ()
8790 /* If we are past TO_CHARPOS, but never saw any
8791 character positions smaller than TO_CHARPOS,
8792 return MOVE_POS_MATCH_OR_ZV, like the
8793 unidirectional display did. */
8794 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8796 && IT_CHARPOS (*it
) > to_charpos
))
8799 && !BUFFER_POS_REACHED_P ()
8800 && !at_eob_p
&& closest_pos
< ZV
)
8802 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8803 if (closest_pos
!= to_charpos
)
8804 move_it_in_display_line_to (it
, closest_pos
, -1,
8807 result
= MOVE_POS_MATCH_OR_ZV
;
8810 if (ITERATOR_AT_END_OF_LINE_P (it
))
8812 result
= MOVE_NEWLINE_OR_CR
;
8816 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8818 && IT_CHARPOS (*it
) > to_charpos
)
8820 if (closest_pos
< ZV
)
8822 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8823 if (closest_pos
!= to_charpos
)
8824 move_it_in_display_line_to (it
, closest_pos
, -1,
8827 result
= MOVE_POS_MATCH_OR_ZV
;
8830 result
= MOVE_LINE_TRUNCATED
;
8833 #undef IT_RESET_X_ASCENT_DESCENT
8836 #undef BUFFER_POS_REACHED_P
8838 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8839 restore the saved iterator. */
8840 if (atpos_it
.sp
>= 0)
8841 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8842 else if (atx_it
.sp
>= 0)
8843 RESTORE_IT (it
, &atx_it
, atx_data
);
8848 bidi_unshelve_cache (atpos_data
, true);
8850 bidi_unshelve_cache (atx_data
, true);
8852 bidi_unshelve_cache (wrap_data
, true);
8854 bidi_unshelve_cache (ppos_data
, true);
8856 /* Restore the iterator settings altered at the beginning of this
8858 it
->glyph_row
= saved_glyph_row
;
8862 /* For external use. */
8864 move_it_in_display_line (struct it
*it
,
8865 ptrdiff_t to_charpos
, int to_x
,
8866 enum move_operation_enum op
)
8868 if (it
->line_wrap
== WORD_WRAP
8869 && (op
& MOVE_TO_X
))
8872 void *save_data
= NULL
;
8875 SAVE_IT (save_it
, *it
, save_data
);
8876 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8877 /* When word-wrap is on, TO_X may lie past the end
8878 of a wrapped line. Then it->current is the
8879 character on the next line, so backtrack to the
8880 space before the wrap point. */
8881 if (skip
== MOVE_LINE_CONTINUED
)
8883 int prev_x
= max (it
->current_x
- 1, 0);
8884 RESTORE_IT (it
, &save_it
, save_data
);
8885 move_it_in_display_line_to
8886 (it
, -1, prev_x
, MOVE_TO_X
);
8889 bidi_unshelve_cache (save_data
, true);
8892 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8896 /* Move IT forward until it satisfies one or more of the criteria in
8897 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8899 OP is a bit-mask that specifies where to stop, and in particular,
8900 which of those four position arguments makes a difference. See the
8901 description of enum move_operation_enum.
8903 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8904 screen line, this function will set IT to the next position that is
8905 displayed to the right of TO_CHARPOS on the screen.
8907 Return the maximum pixel length of any line scanned but never more
8908 than it.last_visible_x. */
8911 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8913 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8914 int line_height
, line_start_x
= 0, reached
= 0;
8915 int max_current_x
= 0;
8916 void *backup_data
= NULL
;
8920 if (op
& MOVE_TO_VPOS
)
8922 /* If no TO_CHARPOS and no TO_X specified, stop at the
8923 start of the line TO_VPOS. */
8924 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8926 if (it
->vpos
== to_vpos
)
8932 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8936 /* TO_VPOS >= 0 means stop at TO_X in the line at
8937 TO_VPOS, or at TO_POS, whichever comes first. */
8938 if (it
->vpos
== to_vpos
)
8944 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8946 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8951 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8953 /* We have reached TO_X but not in the line we want. */
8954 skip
= move_it_in_display_line_to (it
, to_charpos
,
8956 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8964 else if (op
& MOVE_TO_Y
)
8966 struct it it_backup
;
8968 if (it
->line_wrap
== WORD_WRAP
)
8969 SAVE_IT (it_backup
, *it
, backup_data
);
8971 /* TO_Y specified means stop at TO_X in the line containing
8972 TO_Y---or at TO_CHARPOS if this is reached first. The
8973 problem is that we can't really tell whether the line
8974 contains TO_Y before we have completely scanned it, and
8975 this may skip past TO_X. What we do is to first scan to
8978 If TO_X is not specified, use a TO_X of zero. The reason
8979 is to make the outcome of this function more predictable.
8980 If we didn't use TO_X == 0, we would stop at the end of
8981 the line which is probably not what a caller would expect
8983 skip
= move_it_in_display_line_to
8984 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8985 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8987 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8988 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8990 else if (skip
== MOVE_X_REACHED
)
8992 /* If TO_X was reached, we want to know whether TO_Y is
8993 in the line. We know this is the case if the already
8994 scanned glyphs make the line tall enough. Otherwise,
8995 we must check by scanning the rest of the line. */
8996 line_height
= it
->max_ascent
+ it
->max_descent
;
8997 if (to_y
>= it
->current_y
8998 && to_y
< it
->current_y
+ line_height
)
9003 SAVE_IT (it_backup
, *it
, backup_data
);
9004 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9005 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9007 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9008 line_height
= it
->max_ascent
+ it
->max_descent
;
9009 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9011 if (to_y
>= it
->current_y
9012 && to_y
< it
->current_y
+ line_height
)
9014 /* If TO_Y is in this line and TO_X was reached
9015 above, we scanned too far. We have to restore
9016 IT's settings to the ones before skipping. But
9017 keep the more accurate values of max_ascent and
9018 max_descent we've found while skipping the rest
9019 of the line, for the sake of callers, such as
9020 pos_visible_p, that need to know the line
9022 int max_ascent
= it
->max_ascent
;
9023 int max_descent
= it
->max_descent
;
9025 RESTORE_IT (it
, &it_backup
, backup_data
);
9026 it
->max_ascent
= max_ascent
;
9027 it
->max_descent
= max_descent
;
9033 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9039 /* Check whether TO_Y is in this line. */
9040 line_height
= it
->max_ascent
+ it
->max_descent
;
9041 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9043 if (to_y
>= it
->current_y
9044 && to_y
< it
->current_y
+ line_height
)
9046 if (to_y
> it
->current_y
)
9047 max_current_x
= max (it
->current_x
, max_current_x
);
9049 /* When word-wrap is on, TO_X may lie past the end
9050 of a wrapped line. Then it->current is the
9051 character on the next line, so backtrack to the
9052 space before the wrap point. */
9053 if (skip
== MOVE_LINE_CONTINUED
9054 && it
->line_wrap
== WORD_WRAP
)
9056 int prev_x
= max (it
->current_x
- 1, 0);
9057 RESTORE_IT (it
, &it_backup
, backup_data
);
9058 skip
= move_it_in_display_line_to
9059 (it
, -1, prev_x
, MOVE_TO_X
);
9068 max_current_x
= max (it
->current_x
, max_current_x
);
9072 else if (BUFFERP (it
->object
)
9073 && (it
->method
== GET_FROM_BUFFER
9074 || it
->method
== GET_FROM_STRETCH
)
9075 && IT_CHARPOS (*it
) >= to_charpos
9076 /* Under bidi iteration, a call to set_iterator_to_next
9077 can scan far beyond to_charpos if the initial
9078 portion of the next line needs to be reordered. In
9079 that case, give move_it_in_display_line_to another
9082 && it
->bidi_it
.scan_dir
== -1))
9083 skip
= MOVE_POS_MATCH_OR_ZV
;
9085 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9089 case MOVE_POS_MATCH_OR_ZV
:
9090 max_current_x
= max (it
->current_x
, max_current_x
);
9094 case MOVE_NEWLINE_OR_CR
:
9095 max_current_x
= max (it
->current_x
, max_current_x
);
9096 set_iterator_to_next (it
, true);
9097 it
->continuation_lines_width
= 0;
9100 case MOVE_LINE_TRUNCATED
:
9101 max_current_x
= it
->last_visible_x
;
9102 it
->continuation_lines_width
= 0;
9103 reseat_at_next_visible_line_start (it
, false);
9104 if ((op
& MOVE_TO_POS
) != 0
9105 && IT_CHARPOS (*it
) > to_charpos
)
9112 case MOVE_LINE_CONTINUED
:
9113 max_current_x
= it
->last_visible_x
;
9114 /* For continued lines ending in a tab, some of the glyphs
9115 associated with the tab are displayed on the current
9116 line. Since it->current_x does not include these glyphs,
9117 we use it->last_visible_x instead. */
9120 it
->continuation_lines_width
+= it
->last_visible_x
;
9121 /* When moving by vpos, ensure that the iterator really
9122 advances to the next line (bug#847, bug#969). Fixme:
9123 do we need to do this in other circumstances? */
9124 if (it
->current_x
!= it
->last_visible_x
9125 && (op
& MOVE_TO_VPOS
)
9126 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9128 line_start_x
= it
->current_x
+ it
->pixel_width
9129 - it
->last_visible_x
;
9130 if (FRAME_WINDOW_P (it
->f
))
9132 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9133 struct font
*face_font
= face
->font
;
9135 /* When display_line produces a continued line
9136 that ends in a TAB, it skips a tab stop that
9137 is closer than the font's space character
9138 width (see x_produce_glyphs where it produces
9139 the stretch glyph which represents a TAB).
9140 We need to reproduce the same logic here. */
9141 eassert (face_font
);
9144 if (line_start_x
< face_font
->space_width
)
9146 += it
->tab_width
* face_font
->space_width
;
9149 set_iterator_to_next (it
, false);
9153 it
->continuation_lines_width
+= it
->current_x
;
9160 /* Reset/increment for the next run. */
9161 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9162 it
->current_x
= line_start_x
;
9165 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9167 last_height
= it
->max_ascent
+ it
->max_descent
;
9168 it
->max_ascent
= it
->max_descent
= 0;
9173 /* On text terminals, we may stop at the end of a line in the middle
9174 of a multi-character glyph. If the glyph itself is continued,
9175 i.e. it is actually displayed on the next line, don't treat this
9176 stopping point as valid; move to the next line instead (unless
9177 that brings us offscreen). */
9178 if (!FRAME_WINDOW_P (it
->f
)
9180 && IT_CHARPOS (*it
) == to_charpos
9181 && it
->what
== IT_CHARACTER
9183 && it
->line_wrap
== WINDOW_WRAP
9184 && it
->current_x
== it
->last_visible_x
- 1
9187 && it
->w
->window_end_valid
9188 && it
->vpos
< it
->w
->window_end_vpos
)
9190 it
->continuation_lines_width
+= it
->current_x
;
9191 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9192 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9194 last_height
= it
->max_ascent
+ it
->max_descent
;
9198 bidi_unshelve_cache (backup_data
, true);
9200 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9202 return max_current_x
;
9206 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9208 If DY > 0, move IT backward at least that many pixels. DY = 0
9209 means move IT backward to the preceding line start or BEGV. This
9210 function may move over more than DY pixels if IT->current_y - DY
9211 ends up in the middle of a line; in this case IT->current_y will be
9212 set to the top of the line moved to. */
9215 move_it_vertically_backward (struct it
*it
, int dy
)
9219 void *it2data
= NULL
, *it3data
= NULL
;
9220 ptrdiff_t start_pos
;
9222 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9223 ptrdiff_t pos_limit
;
9228 start_pos
= IT_CHARPOS (*it
);
9230 /* Estimate how many newlines we must move back. */
9231 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9232 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9235 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9237 /* Set the iterator's position that many lines back. But don't go
9238 back more than NLINES full screen lines -- this wins a day with
9239 buffers which have very long lines. */
9240 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9241 back_to_previous_visible_line_start (it
);
9243 /* Reseat the iterator here. When moving backward, we don't want
9244 reseat to skip forward over invisible text, set up the iterator
9245 to deliver from overlay strings at the new position etc. So,
9246 use reseat_1 here. */
9247 reseat_1 (it
, it
->current
.pos
, true);
9249 /* We are now surely at a line start. */
9250 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9251 reordering is in effect. */
9252 it
->continuation_lines_width
= 0;
9254 /* Move forward and see what y-distance we moved. First move to the
9255 start of the next line so that we get its height. We need this
9256 height to be able to tell whether we reached the specified
9258 SAVE_IT (it2
, *it
, it2data
);
9259 it2
.max_ascent
= it2
.max_descent
= 0;
9262 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9263 MOVE_TO_POS
| MOVE_TO_VPOS
);
9265 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9266 /* If we are in a display string which starts at START_POS,
9267 and that display string includes a newline, and we are
9268 right after that newline (i.e. at the beginning of a
9269 display line), exit the loop, because otherwise we will
9270 infloop, since move_it_to will see that it is already at
9271 START_POS and will not move. */
9272 || (it2
.method
== GET_FROM_STRING
9273 && IT_CHARPOS (it2
) == start_pos
9274 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9275 eassert (IT_CHARPOS (*it
) >= BEGV
);
9276 SAVE_IT (it3
, it2
, it3data
);
9278 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9279 eassert (IT_CHARPOS (*it
) >= BEGV
);
9280 /* H is the actual vertical distance from the position in *IT
9281 and the starting position. */
9282 h
= it2
.current_y
- it
->current_y
;
9283 /* NLINES is the distance in number of lines. */
9284 nlines
= it2
.vpos
- it
->vpos
;
9286 /* Correct IT's y and vpos position
9287 so that they are relative to the starting point. */
9293 /* DY == 0 means move to the start of the screen line. The
9294 value of nlines is > 0 if continuation lines were involved,
9295 or if the original IT position was at start of a line. */
9296 RESTORE_IT (it
, it
, it2data
);
9298 move_it_by_lines (it
, nlines
);
9299 /* The above code moves us to some position NLINES down,
9300 usually to its first glyph (leftmost in an L2R line), but
9301 that's not necessarily the start of the line, under bidi
9302 reordering. We want to get to the character position
9303 that is immediately after the newline of the previous
9306 && !it
->continuation_lines_width
9307 && !STRINGP (it
->string
)
9308 && IT_CHARPOS (*it
) > BEGV
9309 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9311 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9314 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9315 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9317 bidi_unshelve_cache (it3data
, true);
9321 /* The y-position we try to reach, relative to *IT.
9322 Note that H has been subtracted in front of the if-statement. */
9323 int target_y
= it
->current_y
+ h
- dy
;
9324 int y0
= it3
.current_y
;
9328 RESTORE_IT (&it3
, &it3
, it3data
);
9329 y1
= line_bottom_y (&it3
);
9330 line_height
= y1
- y0
;
9331 RESTORE_IT (it
, it
, it2data
);
9332 /* If we did not reach target_y, try to move further backward if
9333 we can. If we moved too far backward, try to move forward. */
9334 if (target_y
< it
->current_y
9335 /* This is heuristic. In a window that's 3 lines high, with
9336 a line height of 13 pixels each, recentering with point
9337 on the bottom line will try to move -39/2 = 19 pixels
9338 backward. Try to avoid moving into the first line. */
9339 && (it
->current_y
- target_y
9340 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9341 && IT_CHARPOS (*it
) > BEGV
)
9343 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9344 target_y
- it
->current_y
));
9345 dy
= it
->current_y
- target_y
;
9346 goto move_further_back
;
9348 else if (target_y
>= it
->current_y
+ line_height
9349 && IT_CHARPOS (*it
) < ZV
)
9351 /* Should move forward by at least one line, maybe more.
9353 Note: Calling move_it_by_lines can be expensive on
9354 terminal frames, where compute_motion is used (via
9355 vmotion) to do the job, when there are very long lines
9356 and truncate-lines is nil. That's the reason for
9357 treating terminal frames specially here. */
9359 if (!FRAME_WINDOW_P (it
->f
))
9360 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9365 move_it_by_lines (it
, 1);
9367 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9374 /* Move IT by a specified amount of pixel lines DY. DY negative means
9375 move backwards. DY = 0 means move to start of screen line. At the
9376 end, IT will be on the start of a screen line. */
9379 move_it_vertically (struct it
*it
, int dy
)
9382 move_it_vertically_backward (it
, -dy
);
9385 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9386 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9387 MOVE_TO_POS
| MOVE_TO_Y
);
9388 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9390 /* If buffer ends in ZV without a newline, move to the start of
9391 the line to satisfy the post-condition. */
9392 if (IT_CHARPOS (*it
) == ZV
9394 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9395 move_it_by_lines (it
, 0);
9400 /* Move iterator IT past the end of the text line it is in. */
9403 move_it_past_eol (struct it
*it
)
9405 enum move_it_result rc
;
9407 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9408 if (rc
== MOVE_NEWLINE_OR_CR
)
9409 set_iterator_to_next (it
, false);
9413 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9414 negative means move up. DVPOS == 0 means move to the start of the
9417 Optimization idea: If we would know that IT->f doesn't use
9418 a face with proportional font, we could be faster for
9419 truncate-lines nil. */
9422 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9425 /* The commented-out optimization uses vmotion on terminals. This
9426 gives bad results, because elements like it->what, on which
9427 callers such as pos_visible_p rely, aren't updated. */
9428 /* struct position pos;
9429 if (!FRAME_WINDOW_P (it->f))
9431 struct text_pos textpos;
9433 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9434 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9435 reseat (it, textpos, true);
9436 it->vpos += pos.vpos;
9437 it->current_y += pos.vpos;
9443 /* DVPOS == 0 means move to the start of the screen line. */
9444 move_it_vertically_backward (it
, 0);
9445 /* Let next call to line_bottom_y calculate real line height. */
9450 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9451 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9453 /* Only move to the next buffer position if we ended up in a
9454 string from display property, not in an overlay string
9455 (before-string or after-string). That is because the
9456 latter don't conceal the underlying buffer position, so
9457 we can ask to move the iterator to the exact position we
9458 are interested in. Note that, even if we are already at
9459 IT_CHARPOS (*it), the call below is not a no-op, as it
9460 will detect that we are at the end of the string, pop the
9461 iterator, and compute it->current_x and it->hpos
9463 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9464 -1, -1, -1, MOVE_TO_POS
);
9470 void *it2data
= NULL
;
9471 ptrdiff_t start_charpos
, i
;
9473 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9474 bool hit_pos_limit
= false;
9475 ptrdiff_t pos_limit
;
9477 /* Start at the beginning of the screen line containing IT's
9478 position. This may actually move vertically backwards,
9479 in case of overlays, so adjust dvpos accordingly. */
9481 move_it_vertically_backward (it
, 0);
9484 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9485 screen lines, and reseat the iterator there. */
9486 start_charpos
= IT_CHARPOS (*it
);
9487 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9490 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9492 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9493 back_to_previous_visible_line_start (it
);
9494 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9495 hit_pos_limit
= true;
9496 reseat (it
, it
->current
.pos
, true);
9498 /* Move further back if we end up in a string or an image. */
9499 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9501 /* First try to move to start of display line. */
9503 move_it_vertically_backward (it
, 0);
9505 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9507 /* If start of line is still in string or image,
9508 move further back. */
9509 back_to_previous_visible_line_start (it
);
9510 reseat (it
, it
->current
.pos
, true);
9514 it
->current_x
= it
->hpos
= 0;
9516 /* Above call may have moved too far if continuation lines
9517 are involved. Scan forward and see if it did. */
9518 SAVE_IT (it2
, *it
, it2data
);
9519 it2
.vpos
= it2
.current_y
= 0;
9520 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9521 it
->vpos
-= it2
.vpos
;
9522 it
->current_y
-= it2
.current_y
;
9523 it
->current_x
= it
->hpos
= 0;
9525 /* If we moved too far back, move IT some lines forward. */
9526 if (it2
.vpos
> -dvpos
)
9528 int delta
= it2
.vpos
+ dvpos
;
9530 RESTORE_IT (&it2
, &it2
, it2data
);
9531 SAVE_IT (it2
, *it
, it2data
);
9532 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9533 /* Move back again if we got too far ahead. */
9534 if (IT_CHARPOS (*it
) >= start_charpos
)
9535 RESTORE_IT (it
, &it2
, it2data
);
9537 bidi_unshelve_cache (it2data
, true);
9539 else if (hit_pos_limit
&& pos_limit
> BEGV
9540 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9542 /* If we hit the limit, but still didn't make it far enough
9543 back, that means there's a display string with a newline
9544 covering a large chunk of text, and that caused
9545 back_to_previous_visible_line_start try to go too far.
9546 Punish those who commit such atrocities by going back
9547 until we've reached DVPOS, after lifting the limit, which
9548 could make it slow for very long lines. "If it hurts,
9551 RESTORE_IT (it
, it
, it2data
);
9552 for (i
= -dvpos
; i
> 0; --i
)
9554 back_to_previous_visible_line_start (it
);
9557 reseat_1 (it
, it
->current
.pos
, true);
9560 RESTORE_IT (it
, it
, it2data
);
9564 /* Return true if IT points into the middle of a display vector. */
9567 in_display_vector_p (struct it
*it
)
9569 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9570 && it
->current
.dpvec_index
> 0
9571 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9574 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9575 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9576 WINDOW must be a live window and defaults to the selected one. The
9577 return value is a cons of the maximum pixel-width of any text line and
9578 the maximum pixel-height of all text lines.
9580 The optional argument FROM, if non-nil, specifies the first text
9581 position and defaults to the minimum accessible position of the buffer.
9582 If FROM is t, use the minimum accessible position that is not a newline
9583 character. TO, if non-nil, specifies the last text position and
9584 defaults to the maximum accessible position of the buffer. If TO is t,
9585 use the maximum accessible position that is not a newline character.
9587 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9588 width that can be returned. X-LIMIT nil or omitted, means to use the
9589 pixel-width of WINDOW's body; use this if you do not intend to change
9590 the width of WINDOW. Use the maximum width WINDOW may assume if you
9591 intend to change WINDOW's width. In any case, text whose x-coordinate
9592 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9593 can take some time, it's always a good idea to make this argument as
9594 small as possible; in particular, if the buffer contains long lines that
9595 shall be truncated anyway.
9597 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9598 height that can be returned. Text lines whose y-coordinate is beyond
9599 Y-LIMIT are ignored. Since calculating the text height of a large
9600 buffer can take some time, it makes sense to specify this argument if
9601 the size of the buffer is unknown.
9603 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9604 include the height of the mode- or header-line of WINDOW in the return
9605 value. If it is either the symbol `mode-line' or `header-line', include
9606 only the height of that line, if present, in the return value. If t,
9607 include the height of both, if present, in the return value. */)
9608 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9609 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9611 struct window
*w
= decode_live_window (window
);
9612 Lisp_Object buffer
= w
->contents
;
9615 struct buffer
*old_b
= NULL
;
9616 ptrdiff_t start
, end
, pos
;
9617 struct text_pos startp
;
9618 void *itdata
= NULL
;
9619 int c
, max_y
= -1, x
= 0, y
= 0;
9621 CHECK_BUFFER (buffer
);
9622 b
= XBUFFER (buffer
);
9624 if (b
!= current_buffer
)
9626 old_b
= current_buffer
;
9627 set_buffer_internal (b
);
9632 else if (EQ (from
, Qt
))
9635 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9636 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9638 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9643 CHECK_NUMBER_COERCE_MARKER (from
);
9644 start
= min (max (XINT (from
), BEGV
), ZV
);
9649 else if (EQ (to
, Qt
))
9652 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9653 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9655 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9660 CHECK_NUMBER_COERCE_MARKER (to
);
9661 end
= max (start
, min (XINT (to
), ZV
));
9664 if (!NILP (y_limit
))
9666 CHECK_NUMBER (y_limit
);
9667 max_y
= min (XINT (y_limit
), INT_MAX
);
9670 itdata
= bidi_shelve_cache ();
9671 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9672 start_display (&it
, w
, startp
);
9675 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9678 CHECK_NUMBER (x_limit
);
9679 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9680 /* Actually, we never want move_it_to stop at to_x. But to make
9681 sure that move_it_in_display_line_to always moves far enough,
9682 we set it to INT_MAX and specify MOVE_TO_X. */
9683 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9684 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9687 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9689 if (!EQ (mode_and_header_line
, Qheader_line
)
9690 && !EQ (mode_and_header_line
, Qt
))
9691 /* Do not count the header-line which was counted automatically by
9693 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9695 if (EQ (mode_and_header_line
, Qmode_line
)
9696 || EQ (mode_and_header_line
, Qt
))
9697 /* Do count the mode-line which is not included automatically by
9699 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9701 bidi_unshelve_cache (itdata
, false);
9704 set_buffer_internal (old_b
);
9706 return Fcons (make_number (x
), make_number (y
));
9709 /***********************************************************************
9711 ***********************************************************************/
9714 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9718 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9720 Lisp_Object msg
, fmt
;
9723 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9727 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9729 fmt
= build_string (format
);
9730 msg
= CALLN (Fformat
, fmt
, arg1
, arg2
);
9732 len
= SBYTES (msg
) + 1;
9733 buffer
= SAFE_ALLOCA (len
);
9734 memcpy (buffer
, SDATA (msg
), len
);
9736 message_dolog (buffer
, len
- 1, true, false);
9743 /* Output a newline in the *Messages* buffer if "needs" one. */
9746 message_log_maybe_newline (void)
9748 if (message_log_need_newline
)
9749 message_dolog ("", 0, true, false);
9753 /* Add a string M of length NBYTES to the message log, optionally
9754 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9755 true, means interpret the contents of M as multibyte. This
9756 function calls low-level routines in order to bypass text property
9757 hooks, etc. which might not be safe to run.
9759 This may GC (insert may run before/after change hooks),
9760 so the buffer M must NOT point to a Lisp string. */
9763 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9765 const unsigned char *msg
= (const unsigned char *) m
;
9767 if (!NILP (Vmemory_full
))
9770 if (!NILP (Vmessage_log_max
))
9772 struct buffer
*oldbuf
;
9773 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9774 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9775 ptrdiff_t point_at_end
= 0;
9776 ptrdiff_t zv_at_end
= 0;
9777 Lisp_Object old_deactivate_mark
;
9778 struct gcpro gcpro1
;
9780 old_deactivate_mark
= Vdeactivate_mark
;
9781 oldbuf
= current_buffer
;
9783 /* Ensure the Messages buffer exists, and switch to it.
9784 If we created it, set the major-mode. */
9785 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9786 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9788 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9789 call0 (intern ("messages-buffer-mode"));
9791 bset_undo_list (current_buffer
, Qt
);
9792 bset_cache_long_scans (current_buffer
, Qnil
);
9794 oldpoint
= message_dolog_marker1
;
9795 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9796 oldbegv
= message_dolog_marker2
;
9797 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9798 oldzv
= message_dolog_marker3
;
9799 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9800 GCPRO1 (old_deactivate_mark
);
9808 BEGV_BYTE
= BEG_BYTE
;
9811 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9813 /* Insert the string--maybe converting multibyte to single byte
9814 or vice versa, so that all the text fits the buffer. */
9816 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9822 /* Convert a multibyte string to single-byte
9823 for the *Message* buffer. */
9824 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9826 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9827 work
[0] = CHAR_TO_BYTE8 (c
);
9828 insert_1_both (work
, 1, 1, true, false, false);
9831 else if (! multibyte
9832 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9836 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9837 /* Convert a single-byte string to multibyte
9838 for the *Message* buffer. */
9839 for (i
= 0; i
< nbytes
; i
++)
9842 MAKE_CHAR_MULTIBYTE (c
);
9843 char_bytes
= CHAR_STRING (c
, str
);
9844 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9848 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9849 true, false, false);
9853 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9856 insert_1_both ("\n", 1, 1, true, false, false);
9858 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
9860 this_bol_byte
= PT_BYTE
;
9862 /* See if this line duplicates the previous one.
9863 If so, combine duplicates. */
9866 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
9868 prev_bol_byte
= PT_BYTE
;
9870 dups
= message_log_check_duplicate (prev_bol_byte
,
9874 del_range_both (prev_bol
, prev_bol_byte
,
9875 this_bol
, this_bol_byte
, false);
9878 char dupstr
[sizeof " [ times]"
9879 + INT_STRLEN_BOUND (printmax_t
)];
9881 /* If you change this format, don't forget to also
9882 change message_log_check_duplicate. */
9883 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9884 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9885 insert_1_both (dupstr
, duplen
, duplen
,
9891 /* If we have more than the desired maximum number of lines
9892 in the *Messages* buffer now, delete the oldest ones.
9893 This is safe because we don't have undo in this buffer. */
9895 if (NATNUMP (Vmessage_log_max
))
9897 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9898 -XFASTINT (Vmessage_log_max
) - 1, false);
9899 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
9902 BEGV
= marker_position (oldbegv
);
9903 BEGV_BYTE
= marker_byte_position (oldbegv
);
9912 ZV
= marker_position (oldzv
);
9913 ZV_BYTE
= marker_byte_position (oldzv
);
9917 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9919 /* We can't do Fgoto_char (oldpoint) because it will run some
9921 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9922 marker_byte_position (oldpoint
));
9925 unchain_marker (XMARKER (oldpoint
));
9926 unchain_marker (XMARKER (oldbegv
));
9927 unchain_marker (XMARKER (oldzv
));
9929 /* We called insert_1_both above with its 5th argument (PREPARE)
9930 false, which prevents insert_1_both from calling
9931 prepare_to_modify_buffer, which in turns prevents us from
9932 incrementing windows_or_buffers_changed even if *Messages* is
9933 shown in some window. So we must manually set
9934 windows_or_buffers_changed here to make up for that. */
9935 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9936 bset_redisplay (current_buffer
);
9938 set_buffer_internal (oldbuf
);
9940 message_log_need_newline
= !nlflag
;
9941 Vdeactivate_mark
= old_deactivate_mark
;
9946 /* We are at the end of the buffer after just having inserted a newline.
9947 (Note: We depend on the fact we won't be crossing the gap.)
9948 Check to see if the most recent message looks a lot like the previous one.
9949 Return 0 if different, 1 if the new one should just replace it, or a
9950 value N > 1 if we should also append " [N times]". */
9953 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9956 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9957 bool seen_dots
= false;
9958 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9959 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9961 for (i
= 0; i
< len
; i
++)
9963 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
9971 if (*p1
++ == ' ' && *p1
++ == '[')
9974 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9975 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9982 /* Display an echo area message M with a specified length of NBYTES
9983 bytes. The string may include null characters. If M is not a
9984 string, clear out any existing message, and let the mini-buffer
9987 This function cancels echoing. */
9990 message3 (Lisp_Object m
)
9992 struct gcpro gcpro1
;
9995 clear_message (true, true);
9998 /* First flush out any partial line written with print. */
9999 message_log_maybe_newline ();
10002 ptrdiff_t nbytes
= SBYTES (m
);
10003 bool multibyte
= STRING_MULTIBYTE (m
);
10006 SAFE_ALLOCA_STRING (buffer
, m
);
10007 message_dolog (buffer
, nbytes
, true, multibyte
);
10010 message3_nolog (m
);
10016 /* The non-logging version of message3.
10017 This does not cancel echoing, because it is used for echoing.
10018 Perhaps we need to make a separate function for echoing
10019 and make this cancel echoing. */
10022 message3_nolog (Lisp_Object m
)
10024 struct frame
*sf
= SELECTED_FRAME ();
10026 if (FRAME_INITIAL_P (sf
))
10028 if (noninteractive_need_newline
)
10029 putc ('\n', stderr
);
10030 noninteractive_need_newline
= false;
10033 Lisp_Object s
= ENCODE_SYSTEM (m
);
10035 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10037 if (!cursor_in_echo_area
)
10038 fprintf (stderr
, "\n");
10041 /* Error messages get reported properly by cmd_error, so this must be just an
10042 informative message; if the frame hasn't really been initialized yet, just
10044 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10046 /* Get the frame containing the mini-buffer
10047 that the selected frame is using. */
10048 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10049 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10050 struct frame
*f
= XFRAME (frame
);
10052 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10053 Fmake_frame_visible (frame
);
10055 if (STRINGP (m
) && SCHARS (m
) > 0)
10058 if (minibuffer_auto_raise
)
10059 Fraise_frame (frame
);
10060 /* Assume we are not echoing.
10061 (If we are, echo_now will override this.) */
10062 echo_message_buffer
= Qnil
;
10065 clear_message (true, true);
10067 do_pending_window_change (false);
10068 echo_area_display (true);
10069 do_pending_window_change (false);
10070 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10071 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10076 /* Display a null-terminated echo area message M. If M is 0, clear
10077 out any existing message, and let the mini-buffer text show through.
10079 The buffer M must continue to exist until after the echo area gets
10080 cleared or some other message gets displayed there. Do not pass
10081 text that is stored in a Lisp string. Do not pass text in a buffer
10082 that was alloca'd. */
10085 message1 (const char *m
)
10087 message3 (m
? build_unibyte_string (m
) : Qnil
);
10091 /* The non-logging counterpart of message1. */
10094 message1_nolog (const char *m
)
10096 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10099 /* Display a message M which contains a single %s
10100 which gets replaced with STRING. */
10103 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10105 CHECK_STRING (string
);
10107 if (noninteractive
)
10111 /* ENCODE_SYSTEM below can GC and/or relocate the
10112 Lisp data, so make sure we don't use it here. */
10113 eassert (relocatable_string_data_p (m
) != 1);
10115 if (noninteractive_need_newline
)
10116 putc ('\n', stderr
);
10117 noninteractive_need_newline
= false;
10118 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10119 if (!cursor_in_echo_area
)
10120 fprintf (stderr
, "\n");
10124 else if (INTERACTIVE
)
10126 /* The frame whose minibuffer we're going to display the message on.
10127 It may be larger than the selected frame, so we need
10128 to use its buffer, not the selected frame's buffer. */
10129 Lisp_Object mini_window
;
10130 struct frame
*f
, *sf
= SELECTED_FRAME ();
10132 /* Get the frame containing the minibuffer
10133 that the selected frame is using. */
10134 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10135 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10137 /* Error messages get reported properly by cmd_error, so this must be
10138 just an informative message; if the frame hasn't really been
10139 initialized yet, just toss it. */
10140 if (f
->glyphs_initialized_p
)
10142 struct gcpro gcpro1
, gcpro2
;
10144 Lisp_Object fmt
= build_string (m
);
10145 Lisp_Object msg
= string
;
10148 msg
= CALLN (Fformat
, fmt
, msg
);
10153 message3_nolog (msg
);
10157 /* Print should start at the beginning of the message
10158 buffer next time. */
10159 message_buf_print
= false;
10165 /* Dump an informative message to the minibuf. If M is 0, clear out
10166 any existing message, and let the mini-buffer text show through. */
10168 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10169 vmessage (const char *m
, va_list ap
)
10171 if (noninteractive
)
10175 if (noninteractive_need_newline
)
10176 putc ('\n', stderr
);
10177 noninteractive_need_newline
= false;
10178 vfprintf (stderr
, m
, ap
);
10179 if (!cursor_in_echo_area
)
10180 fprintf (stderr
, "\n");
10184 else if (INTERACTIVE
)
10186 /* The frame whose mini-buffer we're going to display the message
10187 on. It may be larger than the selected frame, so we need to
10188 use its buffer, not the selected frame's buffer. */
10189 Lisp_Object mini_window
;
10190 struct frame
*f
, *sf
= SELECTED_FRAME ();
10192 /* Get the frame containing the mini-buffer
10193 that the selected frame is using. */
10194 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10195 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10197 /* Error messages get reported properly by cmd_error, so this must be
10198 just an informative message; if the frame hasn't really been
10199 initialized yet, just toss it. */
10200 if (f
->glyphs_initialized_p
)
10205 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10207 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10209 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10211 message3 (make_string (message_buf
, len
));
10217 /* Print should start at the beginning of the message
10218 buffer next time. */
10219 message_buf_print
= false;
10225 message (const char *m
, ...)
10235 /* The non-logging version of message. */
10238 message_nolog (const char *m
, ...)
10240 Lisp_Object old_log_max
;
10243 old_log_max
= Vmessage_log_max
;
10244 Vmessage_log_max
= Qnil
;
10246 Vmessage_log_max
= old_log_max
;
10252 /* Display the current message in the current mini-buffer. This is
10253 only called from error handlers in process.c, and is not time
10257 update_echo_area (void)
10259 if (!NILP (echo_area_buffer
[0]))
10261 Lisp_Object string
;
10262 string
= Fcurrent_message ();
10268 /* Make sure echo area buffers in `echo_buffers' are live.
10269 If they aren't, make new ones. */
10272 ensure_echo_area_buffers (void)
10276 for (i
= 0; i
< 2; ++i
)
10277 if (!BUFFERP (echo_buffer
[i
])
10278 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10281 Lisp_Object old_buffer
;
10284 old_buffer
= echo_buffer
[i
];
10285 echo_buffer
[i
] = Fget_buffer_create
10286 (make_formatted_string (name
, " *Echo Area %d*", i
));
10287 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10288 /* to force word wrap in echo area -
10289 it was decided to postpone this*/
10290 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10292 for (j
= 0; j
< 2; ++j
)
10293 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10294 echo_area_buffer
[j
] = echo_buffer
[i
];
10299 /* Call FN with args A1..A2 with either the current or last displayed
10300 echo_area_buffer as current buffer.
10302 WHICH zero means use the current message buffer
10303 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10304 from echo_buffer[] and clear it.
10306 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10307 suitable buffer from echo_buffer[] and clear it.
10309 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10310 that the current message becomes the last displayed one, make
10311 choose a suitable buffer for echo_area_buffer[0], and clear it.
10313 Value is what FN returns. */
10316 with_echo_area_buffer (struct window
*w
, int which
,
10317 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10318 ptrdiff_t a1
, Lisp_Object a2
)
10320 Lisp_Object buffer
;
10321 bool this_one
, the_other
, clear_buffer_p
, rc
;
10322 ptrdiff_t count
= SPECPDL_INDEX ();
10324 /* If buffers aren't live, make new ones. */
10325 ensure_echo_area_buffers ();
10327 clear_buffer_p
= false;
10330 this_one
= false, the_other
= true;
10331 else if (which
> 0)
10332 this_one
= true, the_other
= false;
10335 this_one
= false, the_other
= true;
10336 clear_buffer_p
= true;
10338 /* We need a fresh one in case the current echo buffer equals
10339 the one containing the last displayed echo area message. */
10340 if (!NILP (echo_area_buffer
[this_one
])
10341 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10342 echo_area_buffer
[this_one
] = Qnil
;
10345 /* Choose a suitable buffer from echo_buffer[] is we don't
10347 if (NILP (echo_area_buffer
[this_one
]))
10349 echo_area_buffer
[this_one
]
10350 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10351 ? echo_buffer
[the_other
]
10352 : echo_buffer
[this_one
]);
10353 clear_buffer_p
= true;
10356 buffer
= echo_area_buffer
[this_one
];
10358 /* Don't get confused by reusing the buffer used for echoing
10359 for a different purpose. */
10360 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10363 record_unwind_protect (unwind_with_echo_area_buffer
,
10364 with_echo_area_buffer_unwind_data (w
));
10366 /* Make the echo area buffer current. Note that for display
10367 purposes, it is not necessary that the displayed window's buffer
10368 == current_buffer, except for text property lookup. So, let's
10369 only set that buffer temporarily here without doing a full
10370 Fset_window_buffer. We must also change w->pointm, though,
10371 because otherwise an assertions in unshow_buffer fails, and Emacs
10373 set_buffer_internal_1 (XBUFFER (buffer
));
10376 wset_buffer (w
, buffer
);
10377 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10378 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10381 bset_undo_list (current_buffer
, Qt
);
10382 bset_read_only (current_buffer
, Qnil
);
10383 specbind (Qinhibit_read_only
, Qt
);
10384 specbind (Qinhibit_modification_hooks
, Qt
);
10386 if (clear_buffer_p
&& Z
> BEG
)
10387 del_range (BEG
, Z
);
10389 eassert (BEGV
>= BEG
);
10390 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10394 eassert (BEGV
>= BEG
);
10395 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10397 unbind_to (count
, Qnil
);
10402 /* Save state that should be preserved around the call to the function
10403 FN called in with_echo_area_buffer. */
10406 with_echo_area_buffer_unwind_data (struct window
*w
)
10409 Lisp_Object vector
, tmp
;
10411 /* Reduce consing by keeping one vector in
10412 Vwith_echo_area_save_vector. */
10413 vector
= Vwith_echo_area_save_vector
;
10414 Vwith_echo_area_save_vector
= Qnil
;
10417 vector
= Fmake_vector (make_number (11), Qnil
);
10419 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10420 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10421 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10425 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10426 ASET (vector
, i
, w
->contents
); ++i
;
10427 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10428 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10429 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10430 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10431 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10432 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10437 for (; i
< end
; ++i
)
10438 ASET (vector
, i
, Qnil
);
10441 eassert (i
== ASIZE (vector
));
10446 /* Restore global state from VECTOR which was created by
10447 with_echo_area_buffer_unwind_data. */
10450 unwind_with_echo_area_buffer (Lisp_Object vector
)
10452 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10453 Vdeactivate_mark
= AREF (vector
, 1);
10454 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10456 if (WINDOWP (AREF (vector
, 3)))
10459 Lisp_Object buffer
;
10461 w
= XWINDOW (AREF (vector
, 3));
10462 buffer
= AREF (vector
, 4);
10464 wset_buffer (w
, buffer
);
10465 set_marker_both (w
->pointm
, buffer
,
10466 XFASTINT (AREF (vector
, 5)),
10467 XFASTINT (AREF (vector
, 6)));
10468 set_marker_both (w
->old_pointm
, buffer
,
10469 XFASTINT (AREF (vector
, 7)),
10470 XFASTINT (AREF (vector
, 8)));
10471 set_marker_both (w
->start
, buffer
,
10472 XFASTINT (AREF (vector
, 9)),
10473 XFASTINT (AREF (vector
, 10)));
10476 Vwith_echo_area_save_vector
= vector
;
10480 /* Set up the echo area for use by print functions. MULTIBYTE_P
10481 means we will print multibyte. */
10484 setup_echo_area_for_printing (bool multibyte_p
)
10486 /* If we can't find an echo area any more, exit. */
10487 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10488 Fkill_emacs (Qnil
);
10490 ensure_echo_area_buffers ();
10492 if (!message_buf_print
)
10494 /* A message has been output since the last time we printed.
10495 Choose a fresh echo area buffer. */
10496 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10497 echo_area_buffer
[0] = echo_buffer
[1];
10499 echo_area_buffer
[0] = echo_buffer
[0];
10501 /* Switch to that buffer and clear it. */
10502 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10503 bset_truncate_lines (current_buffer
, Qnil
);
10507 ptrdiff_t count
= SPECPDL_INDEX ();
10508 specbind (Qinhibit_read_only
, Qt
);
10509 /* Note that undo recording is always disabled. */
10510 del_range (BEG
, Z
);
10511 unbind_to (count
, Qnil
);
10513 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10515 /* Set up the buffer for the multibyteness we need. */
10517 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10518 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10520 /* Raise the frame containing the echo area. */
10521 if (minibuffer_auto_raise
)
10523 struct frame
*sf
= SELECTED_FRAME ();
10524 Lisp_Object mini_window
;
10525 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10526 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10529 message_log_maybe_newline ();
10530 message_buf_print
= true;
10534 if (NILP (echo_area_buffer
[0]))
10536 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10537 echo_area_buffer
[0] = echo_buffer
[1];
10539 echo_area_buffer
[0] = echo_buffer
[0];
10542 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10544 /* Someone switched buffers between print requests. */
10545 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10546 bset_truncate_lines (current_buffer
, Qnil
);
10552 /* Display an echo area message in window W. Value is true if W's
10553 height is changed. If display_last_displayed_message_p,
10554 display the message that was last displayed, otherwise
10555 display the current message. */
10558 display_echo_area (struct window
*w
)
10560 bool no_message_p
, window_height_changed_p
;
10562 /* Temporarily disable garbage collections while displaying the echo
10563 area. This is done because a GC can print a message itself.
10564 That message would modify the echo area buffer's contents while a
10565 redisplay of the buffer is going on, and seriously confuse
10567 ptrdiff_t count
= inhibit_garbage_collection ();
10569 /* If there is no message, we must call display_echo_area_1
10570 nevertheless because it resizes the window. But we will have to
10571 reset the echo_area_buffer in question to nil at the end because
10572 with_echo_area_buffer will sets it to an empty buffer. */
10573 bool i
= display_last_displayed_message_p
;
10574 no_message_p
= NILP (echo_area_buffer
[i
]);
10576 window_height_changed_p
10577 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10578 display_echo_area_1
,
10579 (intptr_t) w
, Qnil
);
10582 echo_area_buffer
[i
] = Qnil
;
10584 unbind_to (count
, Qnil
);
10585 return window_height_changed_p
;
10589 /* Helper for display_echo_area. Display the current buffer which
10590 contains the current echo area message in window W, a mini-window,
10591 a pointer to which is passed in A1. A2..A4 are currently not used.
10592 Change the height of W so that all of the message is displayed.
10593 Value is true if height of W was changed. */
10596 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10599 struct window
*w
= (struct window
*) i1
;
10600 Lisp_Object window
;
10601 struct text_pos start
;
10603 /* Do this before displaying, so that we have a large enough glyph
10604 matrix for the display. If we can't get enough space for the
10605 whole text, display the last N lines. That works by setting w->start. */
10606 bool window_height_changed_p
= resize_mini_window (w
, false);
10608 /* Use the starting position chosen by resize_mini_window. */
10609 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10612 clear_glyph_matrix (w
->desired_matrix
);
10613 XSETWINDOW (window
, w
);
10614 try_window (window
, start
, 0);
10616 return window_height_changed_p
;
10620 /* Resize the echo area window to exactly the size needed for the
10621 currently displayed message, if there is one. If a mini-buffer
10622 is active, don't shrink it. */
10625 resize_echo_area_exactly (void)
10627 if (BUFFERP (echo_area_buffer
[0])
10628 && WINDOWP (echo_area_window
))
10630 struct window
*w
= XWINDOW (echo_area_window
);
10631 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10632 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10633 (intptr_t) w
, resize_exactly
);
10636 windows_or_buffers_changed
= 42;
10637 update_mode_lines
= 30;
10638 redisplay_internal ();
10644 /* Callback function for with_echo_area_buffer, when used from
10645 resize_echo_area_exactly. A1 contains a pointer to the window to
10646 resize, EXACTLY non-nil means resize the mini-window exactly to the
10647 size of the text displayed. A3 and A4 are not used. Value is what
10648 resize_mini_window returns. */
10651 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10654 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10658 /* Resize mini-window W to fit the size of its contents. EXACT_P
10659 means size the window exactly to the size needed. Otherwise, it's
10660 only enlarged until W's buffer is empty.
10662 Set W->start to the right place to begin display. If the whole
10663 contents fit, start at the beginning. Otherwise, start so as
10664 to make the end of the contents appear. This is particularly
10665 important for y-or-n-p, but seems desirable generally.
10667 Value is true if the window height has been changed. */
10670 resize_mini_window (struct window
*w
, bool exact_p
)
10672 struct frame
*f
= XFRAME (w
->frame
);
10673 bool window_height_changed_p
= false;
10675 eassert (MINI_WINDOW_P (w
));
10677 /* By default, start display at the beginning. */
10678 set_marker_both (w
->start
, w
->contents
,
10679 BUF_BEGV (XBUFFER (w
->contents
)),
10680 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10682 /* Don't resize windows while redisplaying a window; it would
10683 confuse redisplay functions when the size of the window they are
10684 displaying changes from under them. Such a resizing can happen,
10685 for instance, when which-func prints a long message while
10686 we are running fontification-functions. We're running these
10687 functions with safe_call which binds inhibit-redisplay to t. */
10688 if (!NILP (Vinhibit_redisplay
))
10691 /* Nil means don't try to resize. */
10692 if (NILP (Vresize_mini_windows
)
10693 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10696 if (!FRAME_MINIBUF_ONLY_P (f
))
10699 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10700 + WINDOW_PIXEL_HEIGHT (w
));
10701 int unit
= FRAME_LINE_HEIGHT (f
);
10702 int height
, max_height
;
10703 struct text_pos start
;
10704 struct buffer
*old_current_buffer
= NULL
;
10706 if (current_buffer
!= XBUFFER (w
->contents
))
10708 old_current_buffer
= current_buffer
;
10709 set_buffer_internal (XBUFFER (w
->contents
));
10712 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10714 /* Compute the max. number of lines specified by the user. */
10715 if (FLOATP (Vmax_mini_window_height
))
10716 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10717 else if (INTEGERP (Vmax_mini_window_height
))
10718 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10720 max_height
= total_height
/ 4;
10722 /* Correct that max. height if it's bogus. */
10723 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10725 /* Find out the height of the text in the window. */
10726 if (it
.line_wrap
== TRUNCATE
)
10731 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10732 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10733 height
= it
.current_y
+ last_height
;
10735 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10736 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10739 /* Compute a suitable window start. */
10740 if (height
> max_height
)
10742 height
= (max_height
/ unit
) * unit
;
10743 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10744 move_it_vertically_backward (&it
, height
- unit
);
10745 start
= it
.current
.pos
;
10748 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10749 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10751 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10753 /* Let it grow only, until we display an empty message, in which
10754 case the window shrinks again. */
10755 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10757 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10759 FRAME_WINDOWS_FROZEN (f
) = true;
10760 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10761 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10763 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10764 && (exact_p
|| BEGV
== ZV
))
10766 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10768 FRAME_WINDOWS_FROZEN (f
) = false;
10769 shrink_mini_window (w
, true);
10770 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10775 /* Always resize to exact size needed. */
10776 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10778 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10780 FRAME_WINDOWS_FROZEN (f
) = true;
10781 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10782 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10784 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10786 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10788 FRAME_WINDOWS_FROZEN (f
) = false;
10789 shrink_mini_window (w
, true);
10793 FRAME_WINDOWS_FROZEN (f
) = true;
10794 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10797 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10801 if (old_current_buffer
)
10802 set_buffer_internal (old_current_buffer
);
10805 return window_height_changed_p
;
10809 /* Value is the current message, a string, or nil if there is no
10810 current message. */
10813 current_message (void)
10817 if (!BUFFERP (echo_area_buffer
[0]))
10821 with_echo_area_buffer (0, 0, current_message_1
,
10822 (intptr_t) &msg
, Qnil
);
10824 echo_area_buffer
[0] = Qnil
;
10832 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10835 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10838 *msg
= make_buffer_string (BEG
, Z
, true);
10845 /* Push the current message on Vmessage_stack for later restoration
10846 by restore_message. Value is true if the current message isn't
10847 empty. This is a relatively infrequent operation, so it's not
10848 worth optimizing. */
10851 push_message (void)
10853 Lisp_Object msg
= current_message ();
10854 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10855 return STRINGP (msg
);
10859 /* Restore message display from the top of Vmessage_stack. */
10862 restore_message (void)
10864 eassert (CONSP (Vmessage_stack
));
10865 message3_nolog (XCAR (Vmessage_stack
));
10869 /* Handler for unwind-protect calling pop_message. */
10872 pop_message_unwind (void)
10874 /* Pop the top-most entry off Vmessage_stack. */
10875 eassert (CONSP (Vmessage_stack
));
10876 Vmessage_stack
= XCDR (Vmessage_stack
);
10880 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10881 exits. If the stack is not empty, we have a missing pop_message
10885 check_message_stack (void)
10887 if (!NILP (Vmessage_stack
))
10892 /* Truncate to NCHARS what will be displayed in the echo area the next
10893 time we display it---but don't redisplay it now. */
10896 truncate_echo_area (ptrdiff_t nchars
)
10899 echo_area_buffer
[0] = Qnil
;
10900 else if (!noninteractive
10902 && !NILP (echo_area_buffer
[0]))
10904 struct frame
*sf
= SELECTED_FRAME ();
10905 /* Error messages get reported properly by cmd_error, so this must be
10906 just an informative message; if the frame hasn't really been
10907 initialized yet, just toss it. */
10908 if (sf
->glyphs_initialized_p
)
10909 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10914 /* Helper function for truncate_echo_area. Truncate the current
10915 message to at most NCHARS characters. */
10918 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10920 if (BEG
+ nchars
< Z
)
10921 del_range (BEG
+ nchars
, Z
);
10923 echo_area_buffer
[0] = Qnil
;
10927 /* Set the current message to STRING. */
10930 set_message (Lisp_Object string
)
10932 eassert (STRINGP (string
));
10934 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10936 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10937 message_buf_print
= false;
10938 help_echo_showing_p
= false;
10940 if (STRINGP (Vdebug_on_message
)
10941 && STRINGP (string
)
10942 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10943 call_debugger (list2 (Qerror
, string
));
10947 /* Helper function for set_message. First argument is ignored and second
10948 argument has the same meaning as for set_message.
10949 This function is called with the echo area buffer being current. */
10952 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
10954 eassert (STRINGP (string
));
10956 /* Change multibyteness of the echo buffer appropriately. */
10957 if (message_enable_multibyte
10958 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10959 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10961 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10962 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10963 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10965 /* Insert new message at BEG. */
10966 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10968 /* This function takes care of single/multibyte conversion.
10969 We just have to ensure that the echo area buffer has the right
10970 setting of enable_multibyte_characters. */
10971 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
10977 /* Clear messages. CURRENT_P means clear the current message.
10978 LAST_DISPLAYED_P means clear the message last displayed. */
10981 clear_message (bool current_p
, bool last_displayed_p
)
10985 echo_area_buffer
[0] = Qnil
;
10986 message_cleared_p
= true;
10989 if (last_displayed_p
)
10990 echo_area_buffer
[1] = Qnil
;
10992 message_buf_print
= false;
10995 /* Clear garbaged frames.
10997 This function is used where the old redisplay called
10998 redraw_garbaged_frames which in turn called redraw_frame which in
10999 turn called clear_frame. The call to clear_frame was a source of
11000 flickering. I believe a clear_frame is not necessary. It should
11001 suffice in the new redisplay to invalidate all current matrices,
11002 and ensure a complete redisplay of all windows. */
11005 clear_garbaged_frames (void)
11007 if (frame_garbaged
)
11009 Lisp_Object tail
, frame
;
11011 FOR_EACH_FRAME (tail
, frame
)
11013 struct frame
*f
= XFRAME (frame
);
11015 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11020 clear_current_matrices (f
);
11021 fset_redisplay (f
);
11022 f
->garbaged
= false;
11023 f
->resized_p
= false;
11027 frame_garbaged
= false;
11032 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P,
11033 update selected_frame. Value is true if the mini-windows height
11034 has been changed. */
11037 echo_area_display (bool update_frame_p
)
11039 Lisp_Object mini_window
;
11042 bool window_height_changed_p
= false;
11043 struct frame
*sf
= SELECTED_FRAME ();
11045 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11046 w
= XWINDOW (mini_window
);
11047 f
= XFRAME (WINDOW_FRAME (w
));
11049 /* Don't display if frame is invisible or not yet initialized. */
11050 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11053 #ifdef HAVE_WINDOW_SYSTEM
11054 /* When Emacs starts, selected_frame may be the initial terminal
11055 frame. If we let this through, a message would be displayed on
11057 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11059 #endif /* HAVE_WINDOW_SYSTEM */
11061 /* Redraw garbaged frames. */
11062 clear_garbaged_frames ();
11064 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11066 echo_area_window
= mini_window
;
11067 window_height_changed_p
= display_echo_area (w
);
11068 w
->must_be_updated_p
= true;
11070 /* Update the display, unless called from redisplay_internal.
11071 Also don't update the screen during redisplay itself. The
11072 update will happen at the end of redisplay, and an update
11073 here could cause confusion. */
11074 if (update_frame_p
&& !redisplaying_p
)
11078 /* If the display update has been interrupted by pending
11079 input, update mode lines in the frame. Due to the
11080 pending input, it might have been that redisplay hasn't
11081 been called, so that mode lines above the echo area are
11082 garbaged. This looks odd, so we prevent it here. */
11083 if (!display_completed
)
11084 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11086 if (window_height_changed_p
11087 /* Don't do this if Emacs is shutting down. Redisplay
11088 needs to run hooks. */
11089 && !NILP (Vrun_hooks
))
11091 /* Must update other windows. Likewise as in other
11092 cases, don't let this update be interrupted by
11094 ptrdiff_t count
= SPECPDL_INDEX ();
11095 specbind (Qredisplay_dont_pause
, Qt
);
11096 windows_or_buffers_changed
= 44;
11097 redisplay_internal ();
11098 unbind_to (count
, Qnil
);
11100 else if (FRAME_WINDOW_P (f
) && n
== 0)
11102 /* Window configuration is the same as before.
11103 Can do with a display update of the echo area,
11104 unless we displayed some mode lines. */
11105 update_single_window (w
);
11109 update_frame (f
, true, true);
11111 /* If cursor is in the echo area, make sure that the next
11112 redisplay displays the minibuffer, so that the cursor will
11113 be replaced with what the minibuffer wants. */
11114 if (cursor_in_echo_area
)
11115 wset_redisplay (XWINDOW (mini_window
));
11118 else if (!EQ (mini_window
, selected_window
))
11119 wset_redisplay (XWINDOW (mini_window
));
11121 /* Last displayed message is now the current message. */
11122 echo_area_buffer
[1] = echo_area_buffer
[0];
11123 /* Inform read_char that we're not echoing. */
11124 echo_message_buffer
= Qnil
;
11126 /* Prevent redisplay optimization in redisplay_internal by resetting
11127 this_line_start_pos. This is done because the mini-buffer now
11128 displays the message instead of its buffer text. */
11129 if (EQ (mini_window
, selected_window
))
11130 CHARPOS (this_line_start_pos
) = 0;
11132 return window_height_changed_p
;
11135 /* True if W's buffer was changed but not saved. */
11138 window_buffer_changed (struct window
*w
)
11140 struct buffer
*b
= XBUFFER (w
->contents
);
11142 eassert (BUFFER_LIVE_P (b
));
11144 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11147 /* True if W has %c in its mode line and mode line should be updated. */
11150 mode_line_update_needed (struct window
*w
)
11152 return (w
->column_number_displayed
!= -1
11153 && !(PT
== w
->last_point
&& !window_outdated (w
))
11154 && (w
->column_number_displayed
!= current_column ()));
11157 /* True if window start of W is frozen and may not be changed during
11161 window_frozen_p (struct window
*w
)
11163 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11165 Lisp_Object window
;
11167 XSETWINDOW (window
, w
);
11168 if (MINI_WINDOW_P (w
))
11170 else if (EQ (window
, selected_window
))
11172 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11173 && EQ (window
, Vminibuf_scroll_window
))
11174 /* This special window can't be frozen too. */
11182 /***********************************************************************
11183 Mode Lines and Frame Titles
11184 ***********************************************************************/
11186 /* A buffer for constructing non-propertized mode-line strings and
11187 frame titles in it; allocated from the heap in init_xdisp and
11188 resized as needed in store_mode_line_noprop_char. */
11190 static char *mode_line_noprop_buf
;
11192 /* The buffer's end, and a current output position in it. */
11194 static char *mode_line_noprop_buf_end
;
11195 static char *mode_line_noprop_ptr
;
11197 #define MODE_LINE_NOPROP_LEN(start) \
11198 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11201 MODE_LINE_DISPLAY
= 0,
11205 } mode_line_target
;
11207 /* Alist that caches the results of :propertize.
11208 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11209 static Lisp_Object mode_line_proptrans_alist
;
11211 /* List of strings making up the mode-line. */
11212 static Lisp_Object mode_line_string_list
;
11214 /* Base face property when building propertized mode line string. */
11215 static Lisp_Object mode_line_string_face
;
11216 static Lisp_Object mode_line_string_face_prop
;
11219 /* Unwind data for mode line strings */
11221 static Lisp_Object Vmode_line_unwind_vector
;
11224 format_mode_line_unwind_data (struct frame
*target_frame
,
11225 struct buffer
*obuf
,
11227 bool save_proptrans
)
11229 Lisp_Object vector
, tmp
;
11231 /* Reduce consing by keeping one vector in
11232 Vwith_echo_area_save_vector. */
11233 vector
= Vmode_line_unwind_vector
;
11234 Vmode_line_unwind_vector
= Qnil
;
11237 vector
= Fmake_vector (make_number (10), Qnil
);
11239 ASET (vector
, 0, make_number (mode_line_target
));
11240 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11241 ASET (vector
, 2, mode_line_string_list
);
11242 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11243 ASET (vector
, 4, mode_line_string_face
);
11244 ASET (vector
, 5, mode_line_string_face_prop
);
11247 XSETBUFFER (tmp
, obuf
);
11250 ASET (vector
, 6, tmp
);
11251 ASET (vector
, 7, owin
);
11254 /* Similarly to `with-selected-window', if the operation selects
11255 a window on another frame, we must restore that frame's
11256 selected window, and (for a tty) the top-frame. */
11257 ASET (vector
, 8, target_frame
->selected_window
);
11258 if (FRAME_TERMCAP_P (target_frame
))
11259 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11266 unwind_format_mode_line (Lisp_Object vector
)
11268 Lisp_Object old_window
= AREF (vector
, 7);
11269 Lisp_Object target_frame_window
= AREF (vector
, 8);
11270 Lisp_Object old_top_frame
= AREF (vector
, 9);
11272 mode_line_target
= XINT (AREF (vector
, 0));
11273 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11274 mode_line_string_list
= AREF (vector
, 2);
11275 if (! EQ (AREF (vector
, 3), Qt
))
11276 mode_line_proptrans_alist
= AREF (vector
, 3);
11277 mode_line_string_face
= AREF (vector
, 4);
11278 mode_line_string_face_prop
= AREF (vector
, 5);
11280 /* Select window before buffer, since it may change the buffer. */
11281 if (!NILP (old_window
))
11283 /* If the operation that we are unwinding had selected a window
11284 on a different frame, reset its frame-selected-window. For a
11285 text terminal, reset its top-frame if necessary. */
11286 if (!NILP (target_frame_window
))
11289 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11291 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11292 Fselect_window (target_frame_window
, Qt
);
11294 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11295 Fselect_frame (old_top_frame
, Qt
);
11298 Fselect_window (old_window
, Qt
);
11301 if (!NILP (AREF (vector
, 6)))
11303 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11304 ASET (vector
, 6, Qnil
);
11307 Vmode_line_unwind_vector
= vector
;
11311 /* Store a single character C for the frame title in mode_line_noprop_buf.
11312 Re-allocate mode_line_noprop_buf if necessary. */
11315 store_mode_line_noprop_char (char c
)
11317 /* If output position has reached the end of the allocated buffer,
11318 increase the buffer's size. */
11319 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11321 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11322 ptrdiff_t size
= len
;
11323 mode_line_noprop_buf
=
11324 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11325 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11326 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11329 *mode_line_noprop_ptr
++ = c
;
11333 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11334 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11335 characters that yield more columns than PRECISION; PRECISION <= 0
11336 means copy the whole string. Pad with spaces until FIELD_WIDTH
11337 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11338 pad. Called from display_mode_element when it is used to build a
11342 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11344 const unsigned char *str
= (const unsigned char *) string
;
11346 ptrdiff_t dummy
, nbytes
;
11348 /* Copy at most PRECISION chars from STR. */
11349 nbytes
= strlen (string
);
11350 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11352 store_mode_line_noprop_char (*str
++);
11354 /* Fill up with spaces until FIELD_WIDTH reached. */
11355 while (field_width
> 0
11356 && n
< field_width
)
11358 store_mode_line_noprop_char (' ');
11365 /***********************************************************************
11367 ***********************************************************************/
11369 #ifdef HAVE_WINDOW_SYSTEM
11371 /* Set the title of FRAME, if it has changed. The title format is
11372 Vicon_title_format if FRAME is iconified, otherwise it is
11373 frame_title_format. */
11376 x_consider_frame_title (Lisp_Object frame
)
11378 struct frame
*f
= XFRAME (frame
);
11380 if (FRAME_WINDOW_P (f
)
11381 || FRAME_MINIBUF_ONLY_P (f
)
11382 || f
->explicit_name
)
11384 /* Do we have more than one visible frame on this X display? */
11385 Lisp_Object tail
, other_frame
, fmt
;
11386 ptrdiff_t title_start
;
11390 ptrdiff_t count
= SPECPDL_INDEX ();
11392 FOR_EACH_FRAME (tail
, other_frame
)
11394 struct frame
*tf
= XFRAME (other_frame
);
11397 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11398 && !FRAME_MINIBUF_ONLY_P (tf
)
11399 && !EQ (other_frame
, tip_frame
)
11400 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11404 /* Set global variable indicating that multiple frames exist. */
11405 multiple_frames
= CONSP (tail
);
11407 /* Switch to the buffer of selected window of the frame. Set up
11408 mode_line_target so that display_mode_element will output into
11409 mode_line_noprop_buf; then display the title. */
11410 record_unwind_protect (unwind_format_mode_line
,
11411 format_mode_line_unwind_data
11412 (f
, current_buffer
, selected_window
, false));
11414 Fselect_window (f
->selected_window
, Qt
);
11415 set_buffer_internal_1
11416 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11417 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11419 mode_line_target
= MODE_LINE_TITLE
;
11420 title_start
= MODE_LINE_NOPROP_LEN (0);
11421 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11422 NULL
, DEFAULT_FACE_ID
);
11423 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11424 len
= MODE_LINE_NOPROP_LEN (title_start
);
11425 title
= mode_line_noprop_buf
+ title_start
;
11426 unbind_to (count
, Qnil
);
11428 /* Set the title only if it's changed. This avoids consing in
11429 the common case where it hasn't. (If it turns out that we've
11430 already wasted too much time by walking through the list with
11431 display_mode_element, then we might need to optimize at a
11432 higher level than this.) */
11433 if (! STRINGP (f
->name
)
11434 || SBYTES (f
->name
) != len
11435 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11436 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11440 #endif /* not HAVE_WINDOW_SYSTEM */
11443 /***********************************************************************
11445 ***********************************************************************/
11447 /* True if we will not redisplay all visible windows. */
11448 #define REDISPLAY_SOME_P() \
11449 ((windows_or_buffers_changed == 0 \
11450 || windows_or_buffers_changed == REDISPLAY_SOME) \
11451 && (update_mode_lines == 0 \
11452 || update_mode_lines == REDISPLAY_SOME))
11454 /* Prepare for redisplay by updating menu-bar item lists when
11455 appropriate. This can call eval. */
11458 prepare_menu_bars (void)
11460 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11461 bool some_windows
= REDISPLAY_SOME_P ();
11462 struct gcpro gcpro1
, gcpro2
;
11463 Lisp_Object tooltip_frame
;
11465 #ifdef HAVE_WINDOW_SYSTEM
11466 tooltip_frame
= tip_frame
;
11468 tooltip_frame
= Qnil
;
11471 if (FUNCTIONP (Vpre_redisplay_function
))
11473 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11474 if (all_windows
&& some_windows
)
11476 Lisp_Object ws
= window_list ();
11477 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11479 Lisp_Object
this = XCAR (ws
);
11480 struct window
*w
= XWINDOW (this);
11482 || XFRAME (w
->frame
)->redisplay
11483 || XBUFFER (w
->contents
)->text
->redisplay
)
11485 windows
= Fcons (this, windows
);
11489 safe__call1 (true, Vpre_redisplay_function
, windows
);
11492 /* Update all frame titles based on their buffer names, etc. We do
11493 this before the menu bars so that the buffer-menu will show the
11494 up-to-date frame titles. */
11495 #ifdef HAVE_WINDOW_SYSTEM
11498 Lisp_Object tail
, frame
;
11500 FOR_EACH_FRAME (tail
, frame
)
11502 struct frame
*f
= XFRAME (frame
);
11503 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11507 && !XBUFFER (w
->contents
)->text
->redisplay
)
11510 if (!EQ (frame
, tooltip_frame
)
11511 && (FRAME_ICONIFIED_P (f
)
11512 || FRAME_VISIBLE_P (f
) == 1
11513 /* Exclude TTY frames that are obscured because they
11514 are not the top frame on their console. This is
11515 because x_consider_frame_title actually switches
11516 to the frame, which for TTY frames means it is
11517 marked as garbaged, and will be completely
11518 redrawn on the next redisplay cycle. This causes
11519 TTY frames to be completely redrawn, when there
11520 are more than one of them, even though nothing
11521 should be changed on display. */
11522 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11523 x_consider_frame_title (frame
);
11526 #endif /* HAVE_WINDOW_SYSTEM */
11528 /* Update the menu bar item lists, if appropriate. This has to be
11529 done before any actual redisplay or generation of display lines. */
11533 Lisp_Object tail
, frame
;
11534 ptrdiff_t count
= SPECPDL_INDEX ();
11535 /* True means that update_menu_bar has run its hooks
11536 so any further calls to update_menu_bar shouldn't do so again. */
11537 bool menu_bar_hooks_run
= false;
11539 record_unwind_save_match_data ();
11541 FOR_EACH_FRAME (tail
, frame
)
11543 struct frame
*f
= XFRAME (frame
);
11544 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11546 /* Ignore tooltip frame. */
11547 if (EQ (frame
, tooltip_frame
))
11553 && !XBUFFER (w
->contents
)->text
->redisplay
)
11556 /* If a window on this frame changed size, report that to
11557 the user and clear the size-change flag. */
11558 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11560 Lisp_Object functions
;
11562 /* Clear flag first in case we get an error below. */
11563 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11564 functions
= Vwindow_size_change_functions
;
11565 GCPRO2 (tail
, functions
);
11567 while (CONSP (functions
))
11569 if (!EQ (XCAR (functions
), Qt
))
11570 call1 (XCAR (functions
), frame
);
11571 functions
= XCDR (functions
);
11577 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11578 #ifdef HAVE_WINDOW_SYSTEM
11579 update_tool_bar (f
, false);
11584 unbind_to (count
, Qnil
);
11588 struct frame
*sf
= SELECTED_FRAME ();
11589 update_menu_bar (sf
, true, false);
11590 #ifdef HAVE_WINDOW_SYSTEM
11591 update_tool_bar (sf
, true);
11597 /* Update the menu bar item list for frame F. This has to be done
11598 before we start to fill in any display lines, because it can call
11601 If SAVE_MATCH_DATA, we must save and restore it here.
11603 If HOOKS_RUN, a previous call to update_menu_bar
11604 already ran the menu bar hooks for this redisplay, so there
11605 is no need to run them again. The return value is the
11606 updated value of this flag, to pass to the next call. */
11609 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11611 Lisp_Object window
;
11614 /* If called recursively during a menu update, do nothing. This can
11615 happen when, for instance, an activate-menubar-hook causes a
11617 if (inhibit_menubar_update
)
11620 window
= FRAME_SELECTED_WINDOW (f
);
11621 w
= XWINDOW (window
);
11623 if (FRAME_WINDOW_P (f
)
11625 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11626 || defined (HAVE_NS) || defined (USE_GTK)
11627 FRAME_EXTERNAL_MENU_BAR (f
)
11629 FRAME_MENU_BAR_LINES (f
) > 0
11631 : FRAME_MENU_BAR_LINES (f
) > 0)
11633 /* If the user has switched buffers or windows, we need to
11634 recompute to reflect the new bindings. But we'll
11635 recompute when update_mode_lines is set too; that means
11636 that people can use force-mode-line-update to request
11637 that the menu bar be recomputed. The adverse effect on
11638 the rest of the redisplay algorithm is about the same as
11639 windows_or_buffers_changed anyway. */
11640 if (windows_or_buffers_changed
11641 /* This used to test w->update_mode_line, but we believe
11642 there is no need to recompute the menu in that case. */
11643 || update_mode_lines
11644 || window_buffer_changed (w
))
11646 struct buffer
*prev
= current_buffer
;
11647 ptrdiff_t count
= SPECPDL_INDEX ();
11649 specbind (Qinhibit_menubar_update
, Qt
);
11651 set_buffer_internal_1 (XBUFFER (w
->contents
));
11652 if (save_match_data
)
11653 record_unwind_save_match_data ();
11654 if (NILP (Voverriding_local_map_menu_flag
))
11656 specbind (Qoverriding_terminal_local_map
, Qnil
);
11657 specbind (Qoverriding_local_map
, Qnil
);
11662 /* Run the Lucid hook. */
11663 safe_run_hooks (Qactivate_menubar_hook
);
11665 /* If it has changed current-menubar from previous value,
11666 really recompute the menu-bar from the value. */
11667 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11668 call0 (Qrecompute_lucid_menubar
);
11670 safe_run_hooks (Qmenu_bar_update_hook
);
11675 XSETFRAME (Vmenu_updating_frame
, f
);
11676 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11678 /* Redisplay the menu bar in case we changed it. */
11679 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11680 || defined (HAVE_NS) || defined (USE_GTK)
11681 if (FRAME_WINDOW_P (f
))
11683 #if defined (HAVE_NS)
11684 /* All frames on Mac OS share the same menubar. So only
11685 the selected frame should be allowed to set it. */
11686 if (f
== SELECTED_FRAME ())
11688 set_frame_menubar (f
, false, false);
11691 /* On a terminal screen, the menu bar is an ordinary screen
11692 line, and this makes it get updated. */
11693 w
->update_mode_line
= true;
11694 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11695 /* In the non-toolkit version, the menu bar is an ordinary screen
11696 line, and this makes it get updated. */
11697 w
->update_mode_line
= true;
11698 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11700 unbind_to (count
, Qnil
);
11701 set_buffer_internal_1 (prev
);
11708 /***********************************************************************
11710 ***********************************************************************/
11712 #ifdef HAVE_WINDOW_SYSTEM
11714 /* Select `frame' temporarily without running all the code in
11716 FIXME: Maybe do_switch_frame should be trimmed down similarly
11717 when `norecord' is set. */
11719 fast_set_selected_frame (Lisp_Object frame
)
11721 if (!EQ (selected_frame
, frame
))
11723 selected_frame
= frame
;
11724 selected_window
= XFRAME (frame
)->selected_window
;
11728 /* Update the tool-bar item list for frame F. This has to be done
11729 before we start to fill in any display lines. Called from
11730 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11731 and restore it here. */
11734 update_tool_bar (struct frame
*f
, bool save_match_data
)
11736 #if defined (USE_GTK) || defined (HAVE_NS)
11737 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11739 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11740 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11745 Lisp_Object window
;
11748 window
= FRAME_SELECTED_WINDOW (f
);
11749 w
= XWINDOW (window
);
11751 /* If the user has switched buffers or windows, we need to
11752 recompute to reflect the new bindings. But we'll
11753 recompute when update_mode_lines is set too; that means
11754 that people can use force-mode-line-update to request
11755 that the menu bar be recomputed. The adverse effect on
11756 the rest of the redisplay algorithm is about the same as
11757 windows_or_buffers_changed anyway. */
11758 if (windows_or_buffers_changed
11759 || w
->update_mode_line
11760 || update_mode_lines
11761 || window_buffer_changed (w
))
11763 struct buffer
*prev
= current_buffer
;
11764 ptrdiff_t count
= SPECPDL_INDEX ();
11765 Lisp_Object frame
, new_tool_bar
;
11766 int new_n_tool_bar
;
11767 struct gcpro gcpro1
;
11769 /* Set current_buffer to the buffer of the selected
11770 window of the frame, so that we get the right local
11772 set_buffer_internal_1 (XBUFFER (w
->contents
));
11774 /* Save match data, if we must. */
11775 if (save_match_data
)
11776 record_unwind_save_match_data ();
11778 /* Make sure that we don't accidentally use bogus keymaps. */
11779 if (NILP (Voverriding_local_map_menu_flag
))
11781 specbind (Qoverriding_terminal_local_map
, Qnil
);
11782 specbind (Qoverriding_local_map
, Qnil
);
11785 GCPRO1 (new_tool_bar
);
11787 /* We must temporarily set the selected frame to this frame
11788 before calling tool_bar_items, because the calculation of
11789 the tool-bar keymap uses the selected frame (see
11790 `tool-bar-make-keymap' in tool-bar.el). */
11791 eassert (EQ (selected_window
,
11792 /* Since we only explicitly preserve selected_frame,
11793 check that selected_window would be redundant. */
11794 XFRAME (selected_frame
)->selected_window
));
11795 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11796 XSETFRAME (frame
, f
);
11797 fast_set_selected_frame (frame
);
11799 /* Build desired tool-bar items from keymaps. */
11801 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11804 /* Redisplay the tool-bar if we changed it. */
11805 if (new_n_tool_bar
!= f
->n_tool_bar_items
11806 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11808 /* Redisplay that happens asynchronously due to an expose event
11809 may access f->tool_bar_items. Make sure we update both
11810 variables within BLOCK_INPUT so no such event interrupts. */
11812 fset_tool_bar_items (f
, new_tool_bar
);
11813 f
->n_tool_bar_items
= new_n_tool_bar
;
11814 w
->update_mode_line
= true;
11820 unbind_to (count
, Qnil
);
11821 set_buffer_internal_1 (prev
);
11826 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11828 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11829 F's desired tool-bar contents. F->tool_bar_items must have
11830 been set up previously by calling prepare_menu_bars. */
11833 build_desired_tool_bar_string (struct frame
*f
)
11835 int i
, size
, size_needed
;
11836 struct gcpro gcpro1
, gcpro2
;
11837 Lisp_Object image
, plist
;
11839 image
= plist
= Qnil
;
11840 GCPRO2 (image
, plist
);
11842 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11843 Otherwise, make a new string. */
11845 /* The size of the string we might be able to reuse. */
11846 size
= (STRINGP (f
->desired_tool_bar_string
)
11847 ? SCHARS (f
->desired_tool_bar_string
)
11850 /* We need one space in the string for each image. */
11851 size_needed
= f
->n_tool_bar_items
;
11853 /* Reuse f->desired_tool_bar_string, if possible. */
11854 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11855 fset_desired_tool_bar_string
11856 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11859 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11860 struct gcpro gcpro1
;
11862 Fremove_text_properties (make_number (0), make_number (size
),
11863 props
, f
->desired_tool_bar_string
);
11867 /* Put a `display' property on the string for the images to display,
11868 put a `menu_item' property on tool-bar items with a value that
11869 is the index of the item in F's tool-bar item vector. */
11870 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11872 #define PROP(IDX) \
11873 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11875 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11876 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11877 int hmargin
, vmargin
, relief
, idx
, end
;
11879 /* If image is a vector, choose the image according to the
11881 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11882 if (VECTORP (image
))
11886 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11887 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11890 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11891 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11893 eassert (ASIZE (image
) >= idx
);
11894 image
= AREF (image
, idx
);
11899 /* Ignore invalid image specifications. */
11900 if (!valid_image_p (image
))
11903 /* Display the tool-bar button pressed, or depressed. */
11904 plist
= Fcopy_sequence (XCDR (image
));
11906 /* Compute margin and relief to draw. */
11907 relief
= (tool_bar_button_relief
>= 0
11908 ? tool_bar_button_relief
11909 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11910 hmargin
= vmargin
= relief
;
11912 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11913 INT_MAX
- max (hmargin
, vmargin
)))
11915 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11916 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11918 else if (CONSP (Vtool_bar_button_margin
))
11920 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11921 INT_MAX
- hmargin
))
11922 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11924 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11925 INT_MAX
- vmargin
))
11926 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11929 if (auto_raise_tool_bar_buttons_p
)
11931 /* Add a `:relief' property to the image spec if the item is
11935 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11942 /* If image is selected, display it pressed, i.e. with a
11943 negative relief. If it's not selected, display it with a
11945 plist
= Fplist_put (plist
, QCrelief
,
11947 ? make_number (-relief
)
11948 : make_number (relief
)));
11953 /* Put a margin around the image. */
11954 if (hmargin
|| vmargin
)
11956 if (hmargin
== vmargin
)
11957 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11959 plist
= Fplist_put (plist
, QCmargin
,
11960 Fcons (make_number (hmargin
),
11961 make_number (vmargin
)));
11964 /* If button is not enabled, and we don't have special images
11965 for the disabled state, make the image appear disabled by
11966 applying an appropriate algorithm to it. */
11967 if (!enabled_p
&& idx
< 0)
11968 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11970 /* Put a `display' text property on the string for the image to
11971 display. Put a `menu-item' property on the string that gives
11972 the start of this item's properties in the tool-bar items
11974 image
= Fcons (Qimage
, plist
);
11975 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
11976 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11977 struct gcpro gcpro1
;
11980 /* Let the last image hide all remaining spaces in the tool bar
11981 string. The string can be longer than needed when we reuse a
11982 previous string. */
11983 if (i
+ 1 == f
->n_tool_bar_items
)
11984 end
= SCHARS (f
->desired_tool_bar_string
);
11987 Fadd_text_properties (make_number (i
), make_number (end
),
11988 props
, f
->desired_tool_bar_string
);
11997 /* Display one line of the tool-bar of frame IT->f.
11999 HEIGHT specifies the desired height of the tool-bar line.
12000 If the actual height of the glyph row is less than HEIGHT, the
12001 row's height is increased to HEIGHT, and the icons are centered
12002 vertically in the new height.
12004 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12005 count a final empty row in case the tool-bar width exactly matches
12010 display_tool_bar_line (struct it
*it
, int height
)
12012 struct glyph_row
*row
= it
->glyph_row
;
12013 int max_x
= it
->last_visible_x
;
12014 struct glyph
*last
;
12016 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12017 clear_glyph_row (row
);
12018 row
->enabled_p
= true;
12019 row
->y
= it
->current_y
;
12021 /* Note that this isn't made use of if the face hasn't a box,
12022 so there's no need to check the face here. */
12023 it
->start_of_box_run_p
= true;
12025 while (it
->current_x
< max_x
)
12027 int x
, n_glyphs_before
, i
, nglyphs
;
12028 struct it it_before
;
12030 /* Get the next display element. */
12031 if (!get_next_display_element (it
))
12033 /* Don't count empty row if we are counting needed tool-bar lines. */
12034 if (height
< 0 && !it
->hpos
)
12039 /* Produce glyphs. */
12040 n_glyphs_before
= row
->used
[TEXT_AREA
];
12043 PRODUCE_GLYPHS (it
);
12045 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12047 x
= it_before
.current_x
;
12048 while (i
< nglyphs
)
12050 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12052 if (x
+ glyph
->pixel_width
> max_x
)
12054 /* Glyph doesn't fit on line. Backtrack. */
12055 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12057 /* If this is the only glyph on this line, it will never fit on the
12058 tool-bar, so skip it. But ensure there is at least one glyph,
12059 so we don't accidentally disable the tool-bar. */
12060 if (n_glyphs_before
== 0
12061 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12067 x
+= glyph
->pixel_width
;
12071 /* Stop at line end. */
12072 if (ITERATOR_AT_END_OF_LINE_P (it
))
12075 set_iterator_to_next (it
, true);
12080 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12082 /* Use default face for the border below the tool bar.
12084 FIXME: When auto-resize-tool-bars is grow-only, there is
12085 no additional border below the possibly empty tool-bar lines.
12086 So to make the extra empty lines look "normal", we have to
12087 use the tool-bar face for the border too. */
12088 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12089 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12090 it
->face_id
= DEFAULT_FACE_ID
;
12092 extend_face_to_end_of_line (it
);
12093 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12094 last
->right_box_line_p
= true;
12095 if (last
== row
->glyphs
[TEXT_AREA
])
12096 last
->left_box_line_p
= true;
12098 /* Make line the desired height and center it vertically. */
12099 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12101 /* Don't add more than one line height. */
12102 height
%= FRAME_LINE_HEIGHT (it
->f
);
12103 it
->max_ascent
+= height
/ 2;
12104 it
->max_descent
+= (height
+ 1) / 2;
12107 compute_line_metrics (it
);
12109 /* If line is empty, make it occupy the rest of the tool-bar. */
12110 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12112 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12113 row
->visible_height
= row
->height
;
12114 row
->ascent
= row
->phys_ascent
= 0;
12115 row
->extra_line_spacing
= 0;
12118 row
->full_width_p
= true;
12119 row
->continued_p
= false;
12120 row
->truncated_on_left_p
= false;
12121 row
->truncated_on_right_p
= false;
12123 it
->current_x
= it
->hpos
= 0;
12124 it
->current_y
+= row
->height
;
12130 /* Value is the number of pixels needed to make all tool-bar items of
12131 frame F visible. The actual number of glyph rows needed is
12132 returned in *N_ROWS if non-NULL. */
12134 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12136 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12138 /* tool_bar_height is called from redisplay_tool_bar after building
12139 the desired matrix, so use (unused) mode-line row as temporary row to
12140 avoid destroying the first tool-bar row. */
12141 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12143 /* Initialize an iterator for iteration over
12144 F->desired_tool_bar_string in the tool-bar window of frame F. */
12145 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12146 temp_row
->reversed_p
= false;
12147 it
.first_visible_x
= 0;
12148 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12149 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12150 it
.paragraph_embedding
= L2R
;
12152 while (!ITERATOR_AT_END_P (&it
))
12154 clear_glyph_row (temp_row
);
12155 it
.glyph_row
= temp_row
;
12156 display_tool_bar_line (&it
, -1);
12158 clear_glyph_row (temp_row
);
12160 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12162 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12165 return it
.current_y
;
12167 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12170 #endif /* !USE_GTK && !HAVE_NS */
12172 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12174 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12175 If FRAME is nil or omitted, use the selected frame. Optional argument
12176 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12177 (Lisp_Object frame
, Lisp_Object pixelwise
)
12181 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12182 struct frame
*f
= decode_any_frame (frame
);
12184 if (WINDOWP (f
->tool_bar_window
)
12185 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12187 update_tool_bar (f
, true);
12188 if (f
->n_tool_bar_items
)
12190 build_desired_tool_bar_string (f
);
12191 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12196 return make_number (height
);
12200 /* Display the tool-bar of frame F. Value is true if tool-bar's
12201 height should be changed. */
12203 redisplay_tool_bar (struct frame
*f
)
12205 #if defined (USE_GTK) || defined (HAVE_NS)
12207 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12208 update_frame_tool_bar (f
);
12211 #else /* !USE_GTK && !HAVE_NS */
12215 struct glyph_row
*row
;
12217 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12218 do anything. This means you must start with tool-bar-lines
12219 non-zero to get the auto-sizing effect. Or in other words, you
12220 can turn off tool-bars by specifying tool-bar-lines zero. */
12221 if (!WINDOWP (f
->tool_bar_window
)
12222 || (w
= XWINDOW (f
->tool_bar_window
),
12223 WINDOW_TOTAL_LINES (w
) == 0))
12226 /* Set up an iterator for the tool-bar window. */
12227 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12228 it
.first_visible_x
= 0;
12229 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12230 row
= it
.glyph_row
;
12231 row
->reversed_p
= false;
12233 /* Build a string that represents the contents of the tool-bar. */
12234 build_desired_tool_bar_string (f
);
12235 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12236 /* FIXME: This should be controlled by a user option. But it
12237 doesn't make sense to have an R2L tool bar if the menu bar cannot
12238 be drawn also R2L, and making the menu bar R2L is tricky due
12239 toolkit-specific code that implements it. If an R2L tool bar is
12240 ever supported, display_tool_bar_line should also be augmented to
12241 call unproduce_glyphs like display_line and display_string
12243 it
.paragraph_embedding
= L2R
;
12245 if (f
->n_tool_bar_rows
== 0)
12247 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12249 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12251 x_change_tool_bar_height (f
, new_height
);
12252 frame_default_tool_bar_height
= new_height
;
12253 /* Always do that now. */
12254 clear_glyph_matrix (w
->desired_matrix
);
12255 f
->fonts_changed
= true;
12260 /* Display as many lines as needed to display all tool-bar items. */
12262 if (f
->n_tool_bar_rows
> 0)
12264 int border
, rows
, height
, extra
;
12266 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12267 border
= XINT (Vtool_bar_border
);
12268 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12269 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12270 else if (EQ (Vtool_bar_border
, Qborder_width
))
12271 border
= f
->border_width
;
12277 rows
= f
->n_tool_bar_rows
;
12278 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12279 extra
= it
.last_visible_y
- border
- height
* rows
;
12281 while (it
.current_y
< it
.last_visible_y
)
12284 if (extra
> 0 && rows
-- > 0)
12286 h
= (extra
+ rows
- 1) / rows
;
12289 display_tool_bar_line (&it
, height
+ h
);
12294 while (it
.current_y
< it
.last_visible_y
)
12295 display_tool_bar_line (&it
, 0);
12298 /* It doesn't make much sense to try scrolling in the tool-bar
12299 window, so don't do it. */
12300 w
->desired_matrix
->no_scrolling_p
= true;
12301 w
->must_be_updated_p
= true;
12303 if (!NILP (Vauto_resize_tool_bars
))
12305 bool change_height_p
= true;
12307 /* If we couldn't display everything, change the tool-bar's
12308 height if there is room for more. */
12309 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12310 change_height_p
= true;
12312 /* We subtract 1 because display_tool_bar_line advances the
12313 glyph_row pointer before returning to its caller. We want to
12314 examine the last glyph row produced by
12315 display_tool_bar_line. */
12316 row
= it
.glyph_row
- 1;
12318 /* If there are blank lines at the end, except for a partially
12319 visible blank line at the end that is smaller than
12320 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12321 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12322 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12323 change_height_p
= true;
12325 /* If row displays tool-bar items, but is partially visible,
12326 change the tool-bar's height. */
12327 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12328 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12329 change_height_p
= true;
12331 /* Resize windows as needed by changing the `tool-bar-lines'
12332 frame parameter. */
12333 if (change_height_p
)
12336 int new_height
= tool_bar_height (f
, &nrows
, true);
12338 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12339 && !f
->minimize_tool_bar_window_p
)
12340 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12341 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12342 f
->minimize_tool_bar_window_p
= false;
12344 if (change_height_p
)
12346 x_change_tool_bar_height (f
, new_height
);
12347 frame_default_tool_bar_height
= new_height
;
12348 clear_glyph_matrix (w
->desired_matrix
);
12349 f
->n_tool_bar_rows
= nrows
;
12350 f
->fonts_changed
= true;
12357 f
->minimize_tool_bar_window_p
= false;
12360 #endif /* USE_GTK || HAVE_NS */
12363 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12365 /* Get information about the tool-bar item which is displayed in GLYPH
12366 on frame F. Return in *PROP_IDX the index where tool-bar item
12367 properties start in F->tool_bar_items. Value is false if
12368 GLYPH doesn't display a tool-bar item. */
12371 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12376 /* This function can be called asynchronously, which means we must
12377 exclude any possibility that Fget_text_property signals an
12379 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12380 charpos
= max (0, charpos
);
12382 /* Get the text property `menu-item' at pos. The value of that
12383 property is the start index of this item's properties in
12384 F->tool_bar_items. */
12385 prop
= Fget_text_property (make_number (charpos
),
12386 Qmenu_item
, f
->current_tool_bar_string
);
12387 if (! INTEGERP (prop
))
12389 *prop_idx
= XINT (prop
);
12394 /* Get information about the tool-bar item at position X/Y on frame F.
12395 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12396 the current matrix of the tool-bar window of F, or NULL if not
12397 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12398 item in F->tool_bar_items. Value is
12400 -1 if X/Y is not on a tool-bar item
12401 0 if X/Y is on the same item that was highlighted before.
12405 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12406 int *hpos
, int *vpos
, int *prop_idx
)
12408 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12409 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12412 /* Find the glyph under X/Y. */
12413 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12414 if (*glyph
== NULL
)
12417 /* Get the start of this tool-bar item's properties in
12418 f->tool_bar_items. */
12419 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12422 /* Is mouse on the highlighted item? */
12423 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12424 && *vpos
>= hlinfo
->mouse_face_beg_row
12425 && *vpos
<= hlinfo
->mouse_face_end_row
12426 && (*vpos
> hlinfo
->mouse_face_beg_row
12427 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12428 && (*vpos
< hlinfo
->mouse_face_end_row
12429 || *hpos
< hlinfo
->mouse_face_end_col
12430 || hlinfo
->mouse_face_past_end
))
12438 Handle mouse button event on the tool-bar of frame F, at
12439 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12440 false for button release. MODIFIERS is event modifiers for button
12444 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12447 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12448 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12449 int hpos
, vpos
, prop_idx
;
12450 struct glyph
*glyph
;
12451 Lisp_Object enabled_p
;
12454 /* If not on the highlighted tool-bar item, and mouse-highlight is
12455 non-nil, return. This is so we generate the tool-bar button
12456 click only when the mouse button is released on the same item as
12457 where it was pressed. However, when mouse-highlight is disabled,
12458 generate the click when the button is released regardless of the
12459 highlight, since tool-bar items are not highlighted in that
12461 frame_to_window_pixel_xy (w
, &x
, &y
);
12462 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12464 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12467 /* When mouse-highlight is off, generate the click for the item
12468 where the button was pressed, disregarding where it was
12470 if (NILP (Vmouse_highlight
) && !down_p
)
12471 prop_idx
= f
->last_tool_bar_item
;
12473 /* If item is disabled, do nothing. */
12474 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12475 if (NILP (enabled_p
))
12480 /* Show item in pressed state. */
12481 if (!NILP (Vmouse_highlight
))
12482 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12483 f
->last_tool_bar_item
= prop_idx
;
12487 Lisp_Object key
, frame
;
12488 struct input_event event
;
12489 EVENT_INIT (event
);
12491 /* Show item in released state. */
12492 if (!NILP (Vmouse_highlight
))
12493 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12495 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12497 XSETFRAME (frame
, f
);
12498 event
.kind
= TOOL_BAR_EVENT
;
12499 event
.frame_or_window
= frame
;
12501 kbd_buffer_store_event (&event
);
12503 event
.kind
= TOOL_BAR_EVENT
;
12504 event
.frame_or_window
= frame
;
12506 event
.modifiers
= modifiers
;
12507 kbd_buffer_store_event (&event
);
12508 f
->last_tool_bar_item
= -1;
12513 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12514 tool-bar window-relative coordinates X/Y. Called from
12515 note_mouse_highlight. */
12518 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12520 Lisp_Object window
= f
->tool_bar_window
;
12521 struct window
*w
= XWINDOW (window
);
12522 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12523 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12525 struct glyph
*glyph
;
12526 struct glyph_row
*row
;
12528 Lisp_Object enabled_p
;
12530 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12534 /* Function note_mouse_highlight is called with negative X/Y
12535 values when mouse moves outside of the frame. */
12536 if (x
<= 0 || y
<= 0)
12538 clear_mouse_face (hlinfo
);
12542 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12545 /* Not on tool-bar item. */
12546 clear_mouse_face (hlinfo
);
12550 /* On same tool-bar item as before. */
12551 goto set_help_echo
;
12553 clear_mouse_face (hlinfo
);
12555 /* Mouse is down, but on different tool-bar item? */
12556 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12557 && f
== dpyinfo
->last_mouse_frame
);
12559 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12562 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12564 /* If tool-bar item is not enabled, don't highlight it. */
12565 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12566 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12568 /* Compute the x-position of the glyph. In front and past the
12569 image is a space. We include this in the highlighted area. */
12570 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12571 for (i
= x
= 0; i
< hpos
; ++i
)
12572 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12574 /* Record this as the current active region. */
12575 hlinfo
->mouse_face_beg_col
= hpos
;
12576 hlinfo
->mouse_face_beg_row
= vpos
;
12577 hlinfo
->mouse_face_beg_x
= x
;
12578 hlinfo
->mouse_face_past_end
= false;
12580 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12581 hlinfo
->mouse_face_end_row
= vpos
;
12582 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12583 hlinfo
->mouse_face_window
= window
;
12584 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12586 /* Display it as active. */
12587 show_mouse_face (hlinfo
, draw
);
12592 /* Set help_echo_string to a help string to display for this tool-bar item.
12593 XTread_socket does the rest. */
12594 help_echo_object
= help_echo_window
= Qnil
;
12595 help_echo_pos
= -1;
12596 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12597 if (NILP (help_echo_string
))
12598 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12601 #endif /* !USE_GTK && !HAVE_NS */
12603 #endif /* HAVE_WINDOW_SYSTEM */
12607 /************************************************************************
12608 Horizontal scrolling
12609 ************************************************************************/
12611 /* For all leaf windows in the window tree rooted at WINDOW, set their
12612 hscroll value so that PT is (i) visible in the window, and (ii) so
12613 that it is not within a certain margin at the window's left and
12614 right border. Value is true if any window's hscroll has been
12618 hscroll_window_tree (Lisp_Object window
)
12620 bool hscrolled_p
= false;
12621 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12622 int hscroll_step_abs
= 0;
12623 double hscroll_step_rel
= 0;
12625 if (hscroll_relative_p
)
12627 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12628 if (hscroll_step_rel
< 0)
12630 hscroll_relative_p
= false;
12631 hscroll_step_abs
= 0;
12634 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12636 hscroll_step_abs
= XINT (Vhscroll_step
);
12637 if (hscroll_step_abs
< 0)
12638 hscroll_step_abs
= 0;
12641 hscroll_step_abs
= 0;
12643 while (WINDOWP (window
))
12645 struct window
*w
= XWINDOW (window
);
12647 if (WINDOWP (w
->contents
))
12648 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12649 else if (w
->cursor
.vpos
>= 0)
12652 int text_area_width
;
12653 struct glyph_row
*cursor_row
;
12654 struct glyph_row
*bottom_row
;
12656 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12657 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12658 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12660 cursor_row
= bottom_row
- 1;
12662 if (!cursor_row
->enabled_p
)
12664 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12665 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12666 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12668 cursor_row
= bottom_row
- 1;
12670 bool row_r2l_p
= cursor_row
->reversed_p
;
12672 text_area_width
= window_box_width (w
, TEXT_AREA
);
12674 /* Scroll when cursor is inside this scroll margin. */
12675 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12677 /* If the position of this window's point has explicitly
12678 changed, no more suspend auto hscrolling. */
12679 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12680 w
->suspend_auto_hscroll
= false;
12682 /* Remember window point. */
12683 Fset_marker (w
->old_pointm
,
12684 ((w
== XWINDOW (selected_window
))
12685 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12686 : Fmarker_position (w
->pointm
)),
12689 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12690 && !w
->suspend_auto_hscroll
12691 /* In some pathological cases, like restoring a window
12692 configuration into a frame that is much smaller than
12693 the one from which the configuration was saved, we
12694 get glyph rows whose start and end have zero buffer
12695 positions, which we cannot handle below. Just skip
12697 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12698 /* For left-to-right rows, hscroll when cursor is either
12699 (i) inside the right hscroll margin, or (ii) if it is
12700 inside the left margin and the window is already
12703 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12704 || (cursor_row
->enabled_p
12705 && cursor_row
->truncated_on_right_p
12706 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12707 /* For right-to-left rows, the logic is similar,
12708 except that rules for scrolling to left and right
12709 are reversed. E.g., if cursor.x <= h_margin, we
12710 need to hscroll "to the right" unconditionally,
12711 and that will scroll the screen to the left so as
12712 to reveal the next portion of the row. */
12714 && ((cursor_row
->enabled_p
12715 /* FIXME: It is confusing to set the
12716 truncated_on_right_p flag when R2L rows
12717 are actually truncated on the left. */
12718 && cursor_row
->truncated_on_right_p
12719 && w
->cursor
.x
<= h_margin
)
12721 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12725 struct buffer
*saved_current_buffer
;
12729 /* Find point in a display of infinite width. */
12730 saved_current_buffer
= current_buffer
;
12731 current_buffer
= XBUFFER (w
->contents
);
12733 if (w
== XWINDOW (selected_window
))
12736 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12738 /* Move iterator to pt starting at cursor_row->start in
12739 a line with infinite width. */
12740 init_to_row_start (&it
, w
, cursor_row
);
12741 it
.last_visible_x
= INFINITY
;
12742 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12743 current_buffer
= saved_current_buffer
;
12745 /* Position cursor in window. */
12746 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12747 hscroll
= max (0, (it
.current_x
12748 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12749 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12750 : (text_area_width
/ 2))))
12751 / FRAME_COLUMN_WIDTH (it
.f
);
12752 else if ((!row_r2l_p
12753 && w
->cursor
.x
>= text_area_width
- h_margin
)
12754 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12756 if (hscroll_relative_p
)
12757 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12760 wanted_x
= text_area_width
12761 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12764 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12768 if (hscroll_relative_p
)
12769 wanted_x
= text_area_width
* hscroll_step_rel
12772 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12775 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12777 hscroll
= max (hscroll
, w
->min_hscroll
);
12779 /* Don't prevent redisplay optimizations if hscroll
12780 hasn't changed, as it will unnecessarily slow down
12782 if (w
->hscroll
!= hscroll
)
12784 struct buffer
*b
= XBUFFER (w
->contents
);
12785 b
->prevent_redisplay_optimizations_p
= true;
12786 w
->hscroll
= hscroll
;
12787 hscrolled_p
= true;
12795 /* Value is true if hscroll of any leaf window has been changed. */
12796 return hscrolled_p
;
12800 /* Set hscroll so that cursor is visible and not inside horizontal
12801 scroll margins for all windows in the tree rooted at WINDOW. See
12802 also hscroll_window_tree above. Value is true if any window's
12803 hscroll has been changed. If it has, desired matrices on the frame
12804 of WINDOW are cleared. */
12807 hscroll_windows (Lisp_Object window
)
12809 bool hscrolled_p
= hscroll_window_tree (window
);
12811 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12812 return hscrolled_p
;
12817 /************************************************************************
12819 ************************************************************************/
12821 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12822 This is sometimes handy to have in a debugger session. */
12826 /* First and last unchanged row for try_window_id. */
12828 static int debug_first_unchanged_at_end_vpos
;
12829 static int debug_last_unchanged_at_beg_vpos
;
12831 /* Delta vpos and y. */
12833 static int debug_dvpos
, debug_dy
;
12835 /* Delta in characters and bytes for try_window_id. */
12837 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12839 /* Values of window_end_pos and window_end_vpos at the end of
12842 static ptrdiff_t debug_end_vpos
;
12844 /* Append a string to W->desired_matrix->method. FMT is a printf
12845 format string. If trace_redisplay_p is true also printf the
12846 resulting string to stderr. */
12848 static void debug_method_add (struct window
*, char const *, ...)
12849 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12852 debug_method_add (struct window
*w
, char const *fmt
, ...)
12855 char *method
= w
->desired_matrix
->method
;
12856 int len
= strlen (method
);
12857 int size
= sizeof w
->desired_matrix
->method
;
12858 int remaining
= size
- len
- 1;
12861 if (len
&& remaining
)
12864 --remaining
, ++len
;
12867 va_start (ap
, fmt
);
12868 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12871 if (trace_redisplay_p
)
12872 fprintf (stderr
, "%p (%s): %s\n",
12874 ((BUFFERP (w
->contents
)
12875 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12876 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12881 #endif /* GLYPH_DEBUG */
12884 /* Value is true if all changes in window W, which displays
12885 current_buffer, are in the text between START and END. START is a
12886 buffer position, END is given as a distance from Z. Used in
12887 redisplay_internal for display optimization. */
12890 text_outside_line_unchanged_p (struct window
*w
,
12891 ptrdiff_t start
, ptrdiff_t end
)
12893 bool unchanged_p
= true;
12895 /* If text or overlays have changed, see where. */
12896 if (window_outdated (w
))
12898 /* Gap in the line? */
12899 if (GPT
< start
|| Z
- GPT
< end
)
12900 unchanged_p
= false;
12902 /* Changes start in front of the line, or end after it? */
12904 && (BEG_UNCHANGED
< start
- 1
12905 || END_UNCHANGED
< end
))
12906 unchanged_p
= false;
12908 /* If selective display, can't optimize if changes start at the
12909 beginning of the line. */
12911 && INTEGERP (BVAR (current_buffer
, selective_display
))
12912 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12913 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12914 unchanged_p
= false;
12916 /* If there are overlays at the start or end of the line, these
12917 may have overlay strings with newlines in them. A change at
12918 START, for instance, may actually concern the display of such
12919 overlay strings as well, and they are displayed on different
12920 lines. So, quickly rule out this case. (For the future, it
12921 might be desirable to implement something more telling than
12922 just BEG/END_UNCHANGED.) */
12925 if (BEG
+ BEG_UNCHANGED
== start
12926 && overlay_touches_p (start
))
12927 unchanged_p
= false;
12928 if (END_UNCHANGED
== end
12929 && overlay_touches_p (Z
- end
))
12930 unchanged_p
= false;
12933 /* Under bidi reordering, adding or deleting a character in the
12934 beginning of a paragraph, before the first strong directional
12935 character, can change the base direction of the paragraph (unless
12936 the buffer specifies a fixed paragraph direction), which will
12937 require to redisplay the whole paragraph. It might be worthwhile
12938 to find the paragraph limits and widen the range of redisplayed
12939 lines to that, but for now just give up this optimization. */
12940 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
12941 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
12942 unchanged_p
= false;
12945 return unchanged_p
;
12949 /* Do a frame update, taking possible shortcuts into account. This is
12950 the main external entry point for redisplay.
12952 If the last redisplay displayed an echo area message and that message
12953 is no longer requested, we clear the echo area or bring back the
12954 mini-buffer if that is in use. */
12959 redisplay_internal ();
12964 overlay_arrow_string_or_property (Lisp_Object var
)
12968 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12971 return Voverlay_arrow_string
;
12974 /* Return true if there are any overlay-arrows in current_buffer. */
12976 overlay_arrow_in_current_buffer_p (void)
12980 for (vlist
= Voverlay_arrow_variable_list
;
12982 vlist
= XCDR (vlist
))
12984 Lisp_Object var
= XCAR (vlist
);
12987 if (!SYMBOLP (var
))
12989 val
= find_symbol_value (var
);
12991 && current_buffer
== XMARKER (val
)->buffer
)
12998 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13002 overlay_arrows_changed_p (void)
13006 for (vlist
= Voverlay_arrow_variable_list
;
13008 vlist
= XCDR (vlist
))
13010 Lisp_Object var
= XCAR (vlist
);
13011 Lisp_Object val
, pstr
;
13013 if (!SYMBOLP (var
))
13015 val
= find_symbol_value (var
);
13016 if (!MARKERP (val
))
13018 if (! EQ (COERCE_MARKER (val
),
13019 Fget (var
, Qlast_arrow_position
))
13020 || ! (pstr
= overlay_arrow_string_or_property (var
),
13021 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13027 /* Mark overlay arrows to be updated on next redisplay. */
13030 update_overlay_arrows (int up_to_date
)
13034 for (vlist
= Voverlay_arrow_variable_list
;
13036 vlist
= XCDR (vlist
))
13038 Lisp_Object var
= XCAR (vlist
);
13040 if (!SYMBOLP (var
))
13043 if (up_to_date
> 0)
13045 Lisp_Object val
= find_symbol_value (var
);
13046 Fput (var
, Qlast_arrow_position
,
13047 COERCE_MARKER (val
));
13048 Fput (var
, Qlast_arrow_string
,
13049 overlay_arrow_string_or_property (var
));
13051 else if (up_to_date
< 0
13052 || !NILP (Fget (var
, Qlast_arrow_position
)))
13054 Fput (var
, Qlast_arrow_position
, Qt
);
13055 Fput (var
, Qlast_arrow_string
, Qt
);
13061 /* Return overlay arrow string to display at row.
13062 Return integer (bitmap number) for arrow bitmap in left fringe.
13063 Return nil if no overlay arrow. */
13066 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13070 for (vlist
= Voverlay_arrow_variable_list
;
13072 vlist
= XCDR (vlist
))
13074 Lisp_Object var
= XCAR (vlist
);
13077 if (!SYMBOLP (var
))
13080 val
= find_symbol_value (var
);
13083 && current_buffer
== XMARKER (val
)->buffer
13084 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13086 if (FRAME_WINDOW_P (it
->f
)
13087 /* FIXME: if ROW->reversed_p is set, this should test
13088 the right fringe, not the left one. */
13089 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13091 #ifdef HAVE_WINDOW_SYSTEM
13092 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13094 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13095 if (fringe_bitmap
!= 0)
13096 return make_number (fringe_bitmap
);
13099 return make_number (-1); /* Use default arrow bitmap. */
13101 return overlay_arrow_string_or_property (var
);
13108 /* Return true if point moved out of or into a composition. Otherwise
13109 return false. PREV_BUF and PREV_PT are the last point buffer and
13110 position. BUF and PT are the current point buffer and position. */
13113 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13114 struct buffer
*buf
, ptrdiff_t pt
)
13116 ptrdiff_t start
, end
;
13118 Lisp_Object buffer
;
13120 XSETBUFFER (buffer
, buf
);
13121 /* Check a composition at the last point if point moved within the
13123 if (prev_buf
== buf
)
13126 /* Point didn't move. */
13129 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13130 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13131 && composition_valid_p (start
, end
, prop
)
13132 && start
< prev_pt
&& end
> prev_pt
)
13133 /* The last point was within the composition. Return true iff
13134 point moved out of the composition. */
13135 return (pt
<= start
|| pt
>= end
);
13138 /* Check a composition at the current point. */
13139 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13140 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13141 && composition_valid_p (start
, end
, prop
)
13142 && start
< pt
&& end
> pt
);
13145 /* Reconsider the clip changes of buffer which is displayed in W. */
13148 reconsider_clip_changes (struct window
*w
)
13150 struct buffer
*b
= XBUFFER (w
->contents
);
13152 if (b
->clip_changed
13153 && w
->window_end_valid
13154 && w
->current_matrix
->buffer
== b
13155 && w
->current_matrix
->zv
== BUF_ZV (b
)
13156 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13157 b
->clip_changed
= false;
13159 /* If display wasn't paused, and W is not a tool bar window, see if
13160 point has been moved into or out of a composition. In that case,
13161 set b->clip_changed to force updating the screen. If
13162 b->clip_changed has already been set, skip this check. */
13163 if (!b
->clip_changed
&& w
->window_end_valid
)
13165 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13166 ? PT
: marker_position (w
->pointm
));
13168 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13169 && check_point_in_composition (w
->current_matrix
->buffer
,
13170 w
->last_point
, b
, pt
))
13171 b
->clip_changed
= true;
13176 propagate_buffer_redisplay (void)
13177 { /* Resetting b->text->redisplay is problematic!
13178 We can't just reset it in the case that some window that displays
13179 it has not been redisplayed; and such a window can stay
13180 unredisplayed for a long time if it's currently invisible.
13181 But we do want to reset it at the end of redisplay otherwise
13182 its displayed windows will keep being redisplayed over and over
13184 So we copy all b->text->redisplay flags up to their windows here,
13185 such that mark_window_display_accurate can safely reset
13186 b->text->redisplay. */
13187 Lisp_Object ws
= window_list ();
13188 for (; CONSP (ws
); ws
= XCDR (ws
))
13190 struct window
*thisw
= XWINDOW (XCAR (ws
));
13191 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13192 if (thisb
->text
->redisplay
)
13193 thisw
->redisplay
= true;
13197 #define STOP_POLLING \
13198 do { if (! polling_stopped_here) stop_polling (); \
13199 polling_stopped_here = true; } while (false)
13201 #define RESUME_POLLING \
13202 do { if (polling_stopped_here) start_polling (); \
13203 polling_stopped_here = false; } while (false)
13206 /* Perhaps in the future avoid recentering windows if it
13207 is not necessary; currently that causes some problems. */
13210 redisplay_internal (void)
13212 struct window
*w
= XWINDOW (selected_window
);
13216 bool must_finish
= false, match_p
;
13217 struct text_pos tlbufpos
, tlendpos
;
13218 int number_of_visible_frames
;
13221 bool polling_stopped_here
= false;
13222 Lisp_Object tail
, frame
;
13224 /* True means redisplay has to consider all windows on all
13225 frames. False, only selected_window is considered. */
13226 bool consider_all_windows_p
;
13228 /* True means redisplay has to redisplay the miniwindow. */
13229 bool update_miniwindow_p
= false;
13231 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13233 /* No redisplay if running in batch mode or frame is not yet fully
13234 initialized, or redisplay is explicitly turned off by setting
13235 Vinhibit_redisplay. */
13236 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13237 || !NILP (Vinhibit_redisplay
))
13240 /* Don't examine these until after testing Vinhibit_redisplay.
13241 When Emacs is shutting down, perhaps because its connection to
13242 X has dropped, we should not look at them at all. */
13243 fr
= XFRAME (w
->frame
);
13244 sf
= SELECTED_FRAME ();
13246 if (!fr
->glyphs_initialized_p
)
13249 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13250 if (popup_activated ())
13254 /* I don't think this happens but let's be paranoid. */
13255 if (redisplaying_p
)
13258 /* Record a function that clears redisplaying_p
13259 when we leave this function. */
13260 count
= SPECPDL_INDEX ();
13261 record_unwind_protect_void (unwind_redisplay
);
13262 redisplaying_p
= true;
13263 specbind (Qinhibit_free_realized_faces
, Qnil
);
13265 /* Record this function, so it appears on the profiler's backtraces. */
13266 record_in_backtrace (Qredisplay_internal
, 0, 0);
13268 FOR_EACH_FRAME (tail
, frame
)
13269 XFRAME (frame
)->already_hscrolled_p
= false;
13272 /* Remember the currently selected window. */
13276 last_escape_glyph_frame
= NULL
;
13277 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13278 last_glyphless_glyph_frame
= NULL
;
13279 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13281 /* If face_change, init_iterator will free all realized faces, which
13282 includes the faces referenced from current matrices. So, we
13283 can't reuse current matrices in this case. */
13285 windows_or_buffers_changed
= 47;
13287 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13288 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13290 /* Since frames on a single ASCII terminal share the same
13291 display area, displaying a different frame means redisplay
13292 the whole thing. */
13293 SET_FRAME_GARBAGED (sf
);
13295 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13297 FRAME_TTY (sf
)->previous_frame
= sf
;
13300 /* Set the visible flags for all frames. Do this before checking for
13301 resized or garbaged frames; they want to know if their frames are
13302 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13303 number_of_visible_frames
= 0;
13305 FOR_EACH_FRAME (tail
, frame
)
13307 struct frame
*f
= XFRAME (frame
);
13309 if (FRAME_VISIBLE_P (f
))
13311 ++number_of_visible_frames
;
13312 /* Adjust matrices for visible frames only. */
13313 if (f
->fonts_changed
)
13315 adjust_frame_glyphs (f
);
13316 f
->fonts_changed
= false;
13318 /* If cursor type has been changed on the frame
13319 other than selected, consider all frames. */
13320 if (f
!= sf
&& f
->cursor_type_changed
)
13321 update_mode_lines
= 31;
13323 clear_desired_matrices (f
);
13326 /* Notice any pending interrupt request to change frame size. */
13327 do_pending_window_change (true);
13329 /* do_pending_window_change could change the selected_window due to
13330 frame resizing which makes the selected window too small. */
13331 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13334 /* Clear frames marked as garbaged. */
13335 clear_garbaged_frames ();
13337 /* Build menubar and tool-bar items. */
13338 if (NILP (Vmemory_full
))
13339 prepare_menu_bars ();
13341 reconsider_clip_changes (w
);
13343 /* In most cases selected window displays current buffer. */
13344 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13347 /* Detect case that we need to write or remove a star in the mode line. */
13348 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13349 w
->update_mode_line
= true;
13351 if (mode_line_update_needed (w
))
13352 w
->update_mode_line
= true;
13354 /* If reconsider_clip_changes above decided that the narrowing
13355 in the current buffer changed, make sure all other windows
13356 showing that buffer will be redisplayed. */
13357 if (current_buffer
->clip_changed
)
13358 bset_update_mode_line (current_buffer
);
13361 /* Normally the message* functions will have already displayed and
13362 updated the echo area, but the frame may have been trashed, or
13363 the update may have been preempted, so display the echo area
13364 again here. Checking message_cleared_p captures the case that
13365 the echo area should be cleared. */
13366 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13367 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13368 || (message_cleared_p
13369 && minibuf_level
== 0
13370 /* If the mini-window is currently selected, this means the
13371 echo-area doesn't show through. */
13372 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13374 bool window_height_changed_p
= echo_area_display (false);
13376 if (message_cleared_p
)
13377 update_miniwindow_p
= true;
13379 must_finish
= true;
13381 /* If we don't display the current message, don't clear the
13382 message_cleared_p flag, because, if we did, we wouldn't clear
13383 the echo area in the next redisplay which doesn't preserve
13385 if (!display_last_displayed_message_p
)
13386 message_cleared_p
= false;
13388 if (window_height_changed_p
)
13390 windows_or_buffers_changed
= 50;
13392 /* If window configuration was changed, frames may have been
13393 marked garbaged. Clear them or we will experience
13394 surprises wrt scrolling. */
13395 clear_garbaged_frames ();
13398 else if (EQ (selected_window
, minibuf_window
)
13399 && (current_buffer
->clip_changed
|| window_outdated (w
))
13400 && resize_mini_window (w
, false))
13402 /* Resized active mini-window to fit the size of what it is
13403 showing if its contents might have changed. */
13404 must_finish
= true;
13406 /* If window configuration was changed, frames may have been
13407 marked garbaged. Clear them or we will experience
13408 surprises wrt scrolling. */
13409 clear_garbaged_frames ();
13412 if (windows_or_buffers_changed
&& !update_mode_lines
)
13413 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13414 only the windows's contents needs to be refreshed, or whether the
13415 mode-lines also need a refresh. */
13416 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13417 ? REDISPLAY_SOME
: 32);
13419 /* If specs for an arrow have changed, do thorough redisplay
13420 to ensure we remove any arrow that should no longer exist. */
13421 if (overlay_arrows_changed_p ())
13422 /* Apparently, this is the only case where we update other windows,
13423 without updating other mode-lines. */
13424 windows_or_buffers_changed
= 49;
13426 consider_all_windows_p
= (update_mode_lines
13427 || windows_or_buffers_changed
);
13429 #define AINC(a,i) \
13430 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13431 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13433 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13434 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13436 /* Optimize the case that only the line containing the cursor in the
13437 selected window has changed. Variables starting with this_ are
13438 set in display_line and record information about the line
13439 containing the cursor. */
13440 tlbufpos
= this_line_start_pos
;
13441 tlendpos
= this_line_end_pos
;
13442 if (!consider_all_windows_p
13443 && CHARPOS (tlbufpos
) > 0
13444 && !w
->update_mode_line
13445 && !current_buffer
->clip_changed
13446 && !current_buffer
->prevent_redisplay_optimizations_p
13447 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13448 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13449 && !XFRAME (w
->frame
)->cursor_type_changed
13450 /* Make sure recorded data applies to current buffer, etc. */
13451 && this_line_buffer
== current_buffer
13454 && !w
->optional_new_start
13455 /* Point must be on the line that we have info recorded about. */
13456 && PT
>= CHARPOS (tlbufpos
)
13457 && PT
<= Z
- CHARPOS (tlendpos
)
13458 /* All text outside that line, including its final newline,
13459 must be unchanged. */
13460 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13461 CHARPOS (tlendpos
)))
13463 if (CHARPOS (tlbufpos
) > BEGV
13464 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13465 && (CHARPOS (tlbufpos
) == ZV
13466 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13467 /* Former continuation line has disappeared by becoming empty. */
13469 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13471 /* We have to handle the case of continuation around a
13472 wide-column character (see the comment in indent.c around
13475 For instance, in the following case:
13477 -------- Insert --------
13478 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13479 J_I_ ==> J_I_ `^^' are cursors.
13483 As we have to redraw the line above, we cannot use this
13487 int line_height_before
= this_line_pixel_height
;
13489 /* Note that start_display will handle the case that the
13490 line starting at tlbufpos is a continuation line. */
13491 start_display (&it
, w
, tlbufpos
);
13493 /* Implementation note: It this still necessary? */
13494 if (it
.current_x
!= this_line_start_x
)
13497 TRACE ((stderr
, "trying display optimization 1\n"));
13498 w
->cursor
.vpos
= -1;
13499 overlay_arrow_seen
= false;
13500 it
.vpos
= this_line_vpos
;
13501 it
.current_y
= this_line_y
;
13502 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13503 display_line (&it
);
13505 /* If line contains point, is not continued,
13506 and ends at same distance from eob as before, we win. */
13507 if (w
->cursor
.vpos
>= 0
13508 /* Line is not continued, otherwise this_line_start_pos
13509 would have been set to 0 in display_line. */
13510 && CHARPOS (this_line_start_pos
)
13511 /* Line ends as before. */
13512 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13513 /* Line has same height as before. Otherwise other lines
13514 would have to be shifted up or down. */
13515 && this_line_pixel_height
== line_height_before
)
13517 /* If this is not the window's last line, we must adjust
13518 the charstarts of the lines below. */
13519 if (it
.current_y
< it
.last_visible_y
)
13521 struct glyph_row
*row
13522 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13523 ptrdiff_t delta
, delta_bytes
;
13525 /* We used to distinguish between two cases here,
13526 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13527 when the line ends in a newline or the end of the
13528 buffer's accessible portion. But both cases did
13529 the same, so they were collapsed. */
13531 - CHARPOS (tlendpos
)
13532 - MATRIX_ROW_START_CHARPOS (row
));
13533 delta_bytes
= (Z_BYTE
13534 - BYTEPOS (tlendpos
)
13535 - MATRIX_ROW_START_BYTEPOS (row
));
13537 increment_matrix_positions (w
->current_matrix
,
13538 this_line_vpos
+ 1,
13539 w
->current_matrix
->nrows
,
13540 delta
, delta_bytes
);
13543 /* If this row displays text now but previously didn't,
13544 or vice versa, w->window_end_vpos may have to be
13546 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13548 if (w
->window_end_vpos
< this_line_vpos
)
13549 w
->window_end_vpos
= this_line_vpos
;
13551 else if (w
->window_end_vpos
== this_line_vpos
13552 && this_line_vpos
> 0)
13553 w
->window_end_vpos
= this_line_vpos
- 1;
13554 w
->window_end_valid
= false;
13556 /* Update hint: No need to try to scroll in update_window. */
13557 w
->desired_matrix
->no_scrolling_p
= true;
13560 *w
->desired_matrix
->method
= 0;
13561 debug_method_add (w
, "optimization 1");
13563 #ifdef HAVE_WINDOW_SYSTEM
13564 update_window_fringes (w
, false);
13571 else if (/* Cursor position hasn't changed. */
13572 PT
== w
->last_point
13573 /* Make sure the cursor was last displayed
13574 in this window. Otherwise we have to reposition it. */
13576 /* PXW: Must be converted to pixels, probably. */
13577 && 0 <= w
->cursor
.vpos
13578 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13582 do_pending_window_change (true);
13583 /* If selected_window changed, redisplay again. */
13584 if (WINDOWP (selected_window
)
13585 && (w
= XWINDOW (selected_window
)) != sw
)
13588 /* We used to always goto end_of_redisplay here, but this
13589 isn't enough if we have a blinking cursor. */
13590 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13591 goto end_of_redisplay
;
13595 /* If highlighting the region, or if the cursor is in the echo area,
13596 then we can't just move the cursor. */
13597 else if (NILP (Vshow_trailing_whitespace
)
13598 && !cursor_in_echo_area
)
13601 struct glyph_row
*row
;
13603 /* Skip from tlbufpos to PT and see where it is. Note that
13604 PT may be in invisible text. If so, we will end at the
13605 next visible position. */
13606 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13607 NULL
, DEFAULT_FACE_ID
);
13608 it
.current_x
= this_line_start_x
;
13609 it
.current_y
= this_line_y
;
13610 it
.vpos
= this_line_vpos
;
13612 /* The call to move_it_to stops in front of PT, but
13613 moves over before-strings. */
13614 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13616 if (it
.vpos
== this_line_vpos
13617 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13620 eassert (this_line_vpos
== it
.vpos
);
13621 eassert (this_line_y
== it
.current_y
);
13622 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13624 *w
->desired_matrix
->method
= 0;
13625 debug_method_add (w
, "optimization 3");
13634 /* Text changed drastically or point moved off of line. */
13635 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13638 CHARPOS (this_line_start_pos
) = 0;
13639 ++clear_face_cache_count
;
13640 #ifdef HAVE_WINDOW_SYSTEM
13641 ++clear_image_cache_count
;
13644 /* Build desired matrices, and update the display. If
13645 consider_all_windows_p, do it for all windows on all frames.
13646 Otherwise do it for selected_window, only. */
13648 if (consider_all_windows_p
)
13650 FOR_EACH_FRAME (tail
, frame
)
13651 XFRAME (frame
)->updated_p
= false;
13653 propagate_buffer_redisplay ();
13655 FOR_EACH_FRAME (tail
, frame
)
13657 struct frame
*f
= XFRAME (frame
);
13659 /* We don't have to do anything for unselected terminal
13661 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13662 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13667 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13668 /* Redisplay internal tool bar if this is the first time so we
13669 can adjust the frame height right now, if necessary. */
13670 if (!f
->tool_bar_redisplayed_once
)
13672 if (redisplay_tool_bar (f
))
13673 adjust_frame_glyphs (f
);
13674 f
->tool_bar_redisplayed_once
= true;
13678 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13681 /* Only GC scrollbars when we redisplay the whole frame. */
13682 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13683 /* Mark all the scroll bars to be removed; we'll redeem
13684 the ones we want when we redisplay their windows. */
13685 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13686 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13688 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13689 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13690 /* Remember that the invisible frames need to be redisplayed next
13691 time they're visible. */
13692 else if (!REDISPLAY_SOME_P ())
13693 f
->redisplay
= true;
13695 /* The X error handler may have deleted that frame. */
13696 if (!FRAME_LIVE_P (f
))
13699 /* Any scroll bars which redisplay_windows should have
13700 nuked should now go away. */
13701 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13702 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13704 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13706 /* If fonts changed on visible frame, display again. */
13707 if (f
->fonts_changed
)
13709 adjust_frame_glyphs (f
);
13710 f
->fonts_changed
= false;
13714 /* See if we have to hscroll. */
13715 if (!f
->already_hscrolled_p
)
13717 f
->already_hscrolled_p
= true;
13718 if (hscroll_windows (f
->root_window
))
13722 /* Prevent various kinds of signals during display
13723 update. stdio is not robust about handling
13724 signals, which can cause an apparent I/O error. */
13725 if (interrupt_input
)
13726 unrequest_sigio ();
13729 pending
|= update_frame (f
, false, false);
13730 f
->cursor_type_changed
= false;
13731 f
->updated_p
= true;
13736 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13740 /* Do the mark_window_display_accurate after all windows have
13741 been redisplayed because this call resets flags in buffers
13742 which are needed for proper redisplay. */
13743 FOR_EACH_FRAME (tail
, frame
)
13745 struct frame
*f
= XFRAME (frame
);
13748 f
->redisplay
= false;
13749 mark_window_display_accurate (f
->root_window
, true);
13750 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13751 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13756 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13758 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13759 struct frame
*mini_frame
;
13761 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13762 /* Use list_of_error, not Qerror, so that
13763 we catch only errors and don't run the debugger. */
13764 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13766 redisplay_window_error
);
13767 if (update_miniwindow_p
)
13768 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13770 redisplay_window_error
);
13772 /* Compare desired and current matrices, perform output. */
13775 /* If fonts changed, display again. */
13776 if (sf
->fonts_changed
)
13779 /* Prevent various kinds of signals during display update.
13780 stdio is not robust about handling signals,
13781 which can cause an apparent I/O error. */
13782 if (interrupt_input
)
13783 unrequest_sigio ();
13786 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13788 if (hscroll_windows (selected_window
))
13791 XWINDOW (selected_window
)->must_be_updated_p
= true;
13792 pending
= update_frame (sf
, false, false);
13793 sf
->cursor_type_changed
= false;
13796 /* We may have called echo_area_display at the top of this
13797 function. If the echo area is on another frame, that may
13798 have put text on a frame other than the selected one, so the
13799 above call to update_frame would not have caught it. Catch
13801 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13802 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13804 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13806 XWINDOW (mini_window
)->must_be_updated_p
= true;
13807 pending
|= update_frame (mini_frame
, false, false);
13808 mini_frame
->cursor_type_changed
= false;
13809 if (!pending
&& hscroll_windows (mini_window
))
13814 /* If display was paused because of pending input, make sure we do a
13815 thorough update the next time. */
13818 /* Prevent the optimization at the beginning of
13819 redisplay_internal that tries a single-line update of the
13820 line containing the cursor in the selected window. */
13821 CHARPOS (this_line_start_pos
) = 0;
13823 /* Let the overlay arrow be updated the next time. */
13824 update_overlay_arrows (0);
13826 /* If we pause after scrolling, some rows in the current
13827 matrices of some windows are not valid. */
13828 if (!WINDOW_FULL_WIDTH_P (w
)
13829 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13830 update_mode_lines
= 36;
13834 if (!consider_all_windows_p
)
13836 /* This has already been done above if
13837 consider_all_windows_p is set. */
13838 if (XBUFFER (w
->contents
)->text
->redisplay
13839 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13840 /* This can happen if b->text->redisplay was set during
13842 propagate_buffer_redisplay ();
13843 mark_window_display_accurate_1 (w
, true);
13845 /* Say overlay arrows are up to date. */
13846 update_overlay_arrows (1);
13848 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13849 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13852 update_mode_lines
= 0;
13853 windows_or_buffers_changed
= 0;
13856 /* Start SIGIO interrupts coming again. Having them off during the
13857 code above makes it less likely one will discard output, but not
13858 impossible, since there might be stuff in the system buffer here.
13859 But it is much hairier to try to do anything about that. */
13860 if (interrupt_input
)
13864 /* If a frame has become visible which was not before, redisplay
13865 again, so that we display it. Expose events for such a frame
13866 (which it gets when becoming visible) don't call the parts of
13867 redisplay constructing glyphs, so simply exposing a frame won't
13868 display anything in this case. So, we have to display these
13869 frames here explicitly. */
13874 FOR_EACH_FRAME (tail
, frame
)
13876 if (XFRAME (frame
)->visible
)
13880 if (new_count
!= number_of_visible_frames
)
13881 windows_or_buffers_changed
= 52;
13884 /* Change frame size now if a change is pending. */
13885 do_pending_window_change (true);
13887 /* If we just did a pending size change, or have additional
13888 visible frames, or selected_window changed, redisplay again. */
13889 if ((windows_or_buffers_changed
&& !pending
)
13890 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13893 /* Clear the face and image caches.
13895 We used to do this only if consider_all_windows_p. But the cache
13896 needs to be cleared if a timer creates images in the current
13897 buffer (e.g. the test case in Bug#6230). */
13899 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13901 clear_face_cache (false);
13902 clear_face_cache_count
= 0;
13905 #ifdef HAVE_WINDOW_SYSTEM
13906 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13908 clear_image_caches (Qnil
);
13909 clear_image_cache_count
= 0;
13911 #endif /* HAVE_WINDOW_SYSTEM */
13915 ns_set_doc_edited ();
13917 if (interrupt_input
&& interrupts_deferred
)
13920 unbind_to (count
, Qnil
);
13925 /* Redisplay, but leave alone any recent echo area message unless
13926 another message has been requested in its place.
13928 This is useful in situations where you need to redisplay but no
13929 user action has occurred, making it inappropriate for the message
13930 area to be cleared. See tracking_off and
13931 wait_reading_process_output for examples of these situations.
13933 FROM_WHERE is an integer saying from where this function was
13934 called. This is useful for debugging. */
13937 redisplay_preserve_echo_area (int from_where
)
13939 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13941 if (!NILP (echo_area_buffer
[1]))
13943 /* We have a previously displayed message, but no current
13944 message. Redisplay the previous message. */
13945 display_last_displayed_message_p
= true;
13946 redisplay_internal ();
13947 display_last_displayed_message_p
= false;
13950 redisplay_internal ();
13952 flush_frame (SELECTED_FRAME ());
13956 /* Function registered with record_unwind_protect in redisplay_internal. */
13959 unwind_redisplay (void)
13961 redisplaying_p
= false;
13965 /* Mark the display of leaf window W as accurate or inaccurate.
13966 If ACCURATE_P, mark display of W as accurate.
13967 If !ACCURATE_P, arrange for W to be redisplayed the next
13968 time redisplay_internal is called. */
13971 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
13973 struct buffer
*b
= XBUFFER (w
->contents
);
13975 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
13976 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
13977 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
13981 b
->clip_changed
= false;
13982 b
->prevent_redisplay_optimizations_p
= false;
13983 eassert (buffer_window_count (b
) > 0);
13984 /* Resetting b->text->redisplay is problematic!
13985 In order to make it safer to do it here, redisplay_internal must
13986 have copied all b->text->redisplay to their respective windows. */
13987 b
->text
->redisplay
= false;
13989 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13990 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13991 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13992 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13994 w
->current_matrix
->buffer
= b
;
13995 w
->current_matrix
->begv
= BUF_BEGV (b
);
13996 w
->current_matrix
->zv
= BUF_ZV (b
);
13998 w
->last_cursor_vpos
= w
->cursor
.vpos
;
13999 w
->last_cursor_off_p
= w
->cursor_off_p
;
14001 if (w
== XWINDOW (selected_window
))
14002 w
->last_point
= BUF_PT (b
);
14004 w
->last_point
= marker_position (w
->pointm
);
14006 w
->window_end_valid
= true;
14007 w
->update_mode_line
= false;
14010 w
->redisplay
= !accurate_p
;
14014 /* Mark the display of windows in the window tree rooted at WINDOW as
14015 accurate or inaccurate. If ACCURATE_P, mark display of
14016 windows as accurate. If !ACCURATE_P, arrange for windows to
14017 be redisplayed the next time redisplay_internal is called. */
14020 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14024 for (; !NILP (window
); window
= w
->next
)
14026 w
= XWINDOW (window
);
14027 if (WINDOWP (w
->contents
))
14028 mark_window_display_accurate (w
->contents
, accurate_p
);
14030 mark_window_display_accurate_1 (w
, accurate_p
);
14034 update_overlay_arrows (1);
14036 /* Force a thorough redisplay the next time by setting
14037 last_arrow_position and last_arrow_string to t, which is
14038 unequal to any useful value of Voverlay_arrow_... */
14039 update_overlay_arrows (-1);
14043 /* Return value in display table DP (Lisp_Char_Table *) for character
14044 C. Since a display table doesn't have any parent, we don't have to
14045 follow parent. Do not call this function directly but use the
14046 macro DISP_CHAR_VECTOR. */
14049 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14053 if (ASCII_CHAR_P (c
))
14056 if (SUB_CHAR_TABLE_P (val
))
14057 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14063 XSETCHAR_TABLE (table
, dp
);
14064 val
= char_table_ref (table
, c
);
14073 /***********************************************************************
14075 ***********************************************************************/
14077 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14080 redisplay_windows (Lisp_Object window
)
14082 while (!NILP (window
))
14084 struct window
*w
= XWINDOW (window
);
14086 if (WINDOWP (w
->contents
))
14087 redisplay_windows (w
->contents
);
14088 else if (BUFFERP (w
->contents
))
14090 displayed_buffer
= XBUFFER (w
->contents
);
14091 /* Use list_of_error, not Qerror, so that
14092 we catch only errors and don't run the debugger. */
14093 internal_condition_case_1 (redisplay_window_0
, window
,
14095 redisplay_window_error
);
14103 redisplay_window_error (Lisp_Object ignore
)
14105 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14110 redisplay_window_0 (Lisp_Object window
)
14112 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14113 redisplay_window (window
, false);
14118 redisplay_window_1 (Lisp_Object window
)
14120 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14121 redisplay_window (window
, true);
14126 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14127 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14128 which positions recorded in ROW differ from current buffer
14131 Return true iff cursor is on this row. */
14134 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14135 struct glyph_matrix
*matrix
,
14136 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14139 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14140 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14141 struct glyph
*cursor
= NULL
;
14142 /* The last known character position in row. */
14143 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14145 ptrdiff_t pt_old
= PT
- delta
;
14146 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14147 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14148 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14149 /* A glyph beyond the edge of TEXT_AREA which we should never
14151 struct glyph
*glyphs_end
= end
;
14152 /* True means we've found a match for cursor position, but that
14153 glyph has the avoid_cursor_p flag set. */
14154 bool match_with_avoid_cursor
= false;
14155 /* True means we've seen at least one glyph that came from a
14157 bool string_seen
= false;
14158 /* Largest and smallest buffer positions seen so far during scan of
14160 ptrdiff_t bpos_max
= pos_before
;
14161 ptrdiff_t bpos_min
= pos_after
;
14162 /* Last buffer position covered by an overlay string with an integer
14163 `cursor' property. */
14164 ptrdiff_t bpos_covered
= 0;
14165 /* True means the display string on which to display the cursor
14166 comes from a text property, not from an overlay. */
14167 bool string_from_text_prop
= false;
14169 /* Don't even try doing anything if called for a mode-line or
14170 header-line row, since the rest of the code isn't prepared to
14171 deal with such calamities. */
14172 eassert (!row
->mode_line_p
);
14173 if (row
->mode_line_p
)
14176 /* Skip over glyphs not having an object at the start and the end of
14177 the row. These are special glyphs like truncation marks on
14178 terminal frames. */
14179 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14181 if (!row
->reversed_p
)
14184 && NILP (glyph
->object
)
14185 && glyph
->charpos
< 0)
14187 x
+= glyph
->pixel_width
;
14191 && NILP ((end
- 1)->object
)
14192 /* CHARPOS is zero for blanks and stretch glyphs
14193 inserted by extend_face_to_end_of_line. */
14194 && (end
- 1)->charpos
<= 0)
14196 glyph_before
= glyph
- 1;
14203 /* If the glyph row is reversed, we need to process it from back
14204 to front, so swap the edge pointers. */
14205 glyphs_end
= end
= glyph
- 1;
14206 glyph
+= row
->used
[TEXT_AREA
] - 1;
14208 while (glyph
> end
+ 1
14209 && NILP (glyph
->object
)
14210 && glyph
->charpos
< 0)
14213 x
-= glyph
->pixel_width
;
14215 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14217 /* By default, in reversed rows we put the cursor on the
14218 rightmost (first in the reading order) glyph. */
14219 for (g
= end
+ 1; g
< glyph
; g
++)
14220 x
+= g
->pixel_width
;
14222 && NILP ((end
+ 1)->object
)
14223 && (end
+ 1)->charpos
<= 0)
14225 glyph_before
= glyph
+ 1;
14229 else if (row
->reversed_p
)
14231 /* In R2L rows that don't display text, put the cursor on the
14232 rightmost glyph. Case in point: an empty last line that is
14233 part of an R2L paragraph. */
14235 /* Avoid placing the cursor on the last glyph of the row, where
14236 on terminal frames we hold the vertical border between
14237 adjacent windows. */
14238 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14239 && !WINDOW_RIGHTMOST_P (w
)
14240 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14242 x
= -1; /* will be computed below, at label compute_x */
14245 /* Step 1: Try to find the glyph whose character position
14246 corresponds to point. If that's not possible, find 2 glyphs
14247 whose character positions are the closest to point, one before
14248 point, the other after it. */
14249 if (!row
->reversed_p
)
14250 while (/* not marched to end of glyph row */
14252 /* glyph was not inserted by redisplay for internal purposes */
14253 && !NILP (glyph
->object
))
14255 if (BUFFERP (glyph
->object
))
14257 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14259 if (glyph
->charpos
> bpos_max
)
14260 bpos_max
= glyph
->charpos
;
14261 if (glyph
->charpos
< bpos_min
)
14262 bpos_min
= glyph
->charpos
;
14263 if (!glyph
->avoid_cursor_p
)
14265 /* If we hit point, we've found the glyph on which to
14266 display the cursor. */
14269 match_with_avoid_cursor
= false;
14272 /* See if we've found a better approximation to
14273 POS_BEFORE or to POS_AFTER. */
14274 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14276 pos_before
= glyph
->charpos
;
14277 glyph_before
= glyph
;
14279 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14281 pos_after
= glyph
->charpos
;
14282 glyph_after
= glyph
;
14285 else if (dpos
== 0)
14286 match_with_avoid_cursor
= true;
14288 else if (STRINGP (glyph
->object
))
14290 Lisp_Object chprop
;
14291 ptrdiff_t glyph_pos
= glyph
->charpos
;
14293 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14295 if (!NILP (chprop
))
14297 /* If the string came from a `display' text property,
14298 look up the buffer position of that property and
14299 use that position to update bpos_max, as if we
14300 actually saw such a position in one of the row's
14301 glyphs. This helps with supporting integer values
14302 of `cursor' property on the display string in
14303 situations where most or all of the row's buffer
14304 text is completely covered by display properties,
14305 so that no glyph with valid buffer positions is
14306 ever seen in the row. */
14307 ptrdiff_t prop_pos
=
14308 string_buffer_position_lim (glyph
->object
, pos_before
,
14311 if (prop_pos
>= pos_before
)
14312 bpos_max
= prop_pos
;
14314 if (INTEGERP (chprop
))
14316 bpos_covered
= bpos_max
+ XINT (chprop
);
14317 /* If the `cursor' property covers buffer positions up
14318 to and including point, we should display cursor on
14319 this glyph. Note that, if a `cursor' property on one
14320 of the string's characters has an integer value, we
14321 will break out of the loop below _before_ we get to
14322 the position match above. IOW, integer values of
14323 the `cursor' property override the "exact match for
14324 point" strategy of positioning the cursor. */
14325 /* Implementation note: bpos_max == pt_old when, e.g.,
14326 we are in an empty line, where bpos_max is set to
14327 MATRIX_ROW_START_CHARPOS, see above. */
14328 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14335 string_seen
= true;
14337 x
+= glyph
->pixel_width
;
14340 else if (glyph
> end
) /* row is reversed */
14341 while (!NILP (glyph
->object
))
14343 if (BUFFERP (glyph
->object
))
14345 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14347 if (glyph
->charpos
> bpos_max
)
14348 bpos_max
= glyph
->charpos
;
14349 if (glyph
->charpos
< bpos_min
)
14350 bpos_min
= glyph
->charpos
;
14351 if (!glyph
->avoid_cursor_p
)
14355 match_with_avoid_cursor
= false;
14358 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14360 pos_before
= glyph
->charpos
;
14361 glyph_before
= glyph
;
14363 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14365 pos_after
= glyph
->charpos
;
14366 glyph_after
= glyph
;
14369 else if (dpos
== 0)
14370 match_with_avoid_cursor
= true;
14372 else if (STRINGP (glyph
->object
))
14374 Lisp_Object chprop
;
14375 ptrdiff_t glyph_pos
= glyph
->charpos
;
14377 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14379 if (!NILP (chprop
))
14381 ptrdiff_t prop_pos
=
14382 string_buffer_position_lim (glyph
->object
, pos_before
,
14385 if (prop_pos
>= pos_before
)
14386 bpos_max
= prop_pos
;
14388 if (INTEGERP (chprop
))
14390 bpos_covered
= bpos_max
+ XINT (chprop
);
14391 /* If the `cursor' property covers buffer positions up
14392 to and including point, we should display cursor on
14394 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14400 string_seen
= true;
14403 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14405 x
--; /* can't use any pixel_width */
14408 x
-= glyph
->pixel_width
;
14411 /* Step 2: If we didn't find an exact match for point, we need to
14412 look for a proper place to put the cursor among glyphs between
14413 GLYPH_BEFORE and GLYPH_AFTER. */
14414 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14415 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14416 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14418 /* An empty line has a single glyph whose OBJECT is nil and
14419 whose CHARPOS is the position of a newline on that line.
14420 Note that on a TTY, there are more glyphs after that, which
14421 were produced by extend_face_to_end_of_line, but their
14422 CHARPOS is zero or negative. */
14423 bool empty_line_p
=
14424 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14425 && NILP (glyph
->object
) && glyph
->charpos
> 0
14426 /* On a TTY, continued and truncated rows also have a glyph at
14427 their end whose OBJECT is nil and whose CHARPOS is
14428 positive (the continuation and truncation glyphs), but such
14429 rows are obviously not "empty". */
14430 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14432 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14434 ptrdiff_t ellipsis_pos
;
14436 /* Scan back over the ellipsis glyphs. */
14437 if (!row
->reversed_p
)
14439 ellipsis_pos
= (glyph
- 1)->charpos
;
14440 while (glyph
> row
->glyphs
[TEXT_AREA
]
14441 && (glyph
- 1)->charpos
== ellipsis_pos
)
14442 glyph
--, x
-= glyph
->pixel_width
;
14443 /* That loop always goes one position too far, including
14444 the glyph before the ellipsis. So scan forward over
14446 x
+= glyph
->pixel_width
;
14449 else /* row is reversed */
14451 ellipsis_pos
= (glyph
+ 1)->charpos
;
14452 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14453 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14454 glyph
++, x
+= glyph
->pixel_width
;
14455 x
-= glyph
->pixel_width
;
14459 else if (match_with_avoid_cursor
)
14461 cursor
= glyph_after
;
14464 else if (string_seen
)
14466 int incr
= row
->reversed_p
? -1 : +1;
14468 /* Need to find the glyph that came out of a string which is
14469 present at point. That glyph is somewhere between
14470 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14471 positioned between POS_BEFORE and POS_AFTER in the
14473 struct glyph
*start
, *stop
;
14474 ptrdiff_t pos
= pos_before
;
14478 /* If the row ends in a newline from a display string,
14479 reordering could have moved the glyphs belonging to the
14480 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14481 in this case we extend the search to the last glyph in
14482 the row that was not inserted by redisplay. */
14483 if (row
->ends_in_newline_from_string_p
)
14486 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14489 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14490 correspond to POS_BEFORE and POS_AFTER, respectively. We
14491 need START and STOP in the order that corresponds to the
14492 row's direction as given by its reversed_p flag. If the
14493 directionality of characters between POS_BEFORE and
14494 POS_AFTER is the opposite of the row's base direction,
14495 these characters will have been reordered for display,
14496 and we need to reverse START and STOP. */
14497 if (!row
->reversed_p
)
14499 start
= min (glyph_before
, glyph_after
);
14500 stop
= max (glyph_before
, glyph_after
);
14504 start
= max (glyph_before
, glyph_after
);
14505 stop
= min (glyph_before
, glyph_after
);
14507 for (glyph
= start
+ incr
;
14508 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14511 /* Any glyphs that come from the buffer are here because
14512 of bidi reordering. Skip them, and only pay
14513 attention to glyphs that came from some string. */
14514 if (STRINGP (glyph
->object
))
14518 /* If the display property covers the newline, we
14519 need to search for it one position farther. */
14520 ptrdiff_t lim
= pos_after
14521 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14523 string_from_text_prop
= false;
14524 str
= glyph
->object
;
14525 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14526 if (tem
== 0 /* from overlay */
14529 /* If the string from which this glyph came is
14530 found in the buffer at point, or at position
14531 that is closer to point than pos_after, then
14532 we've found the glyph we've been looking for.
14533 If it comes from an overlay (tem == 0), and
14534 it has the `cursor' property on one of its
14535 glyphs, record that glyph as a candidate for
14536 displaying the cursor. (As in the
14537 unidirectional version, we will display the
14538 cursor on the last candidate we find.) */
14541 || (tem
- pt_old
> 0 && tem
< pos_after
))
14543 /* The glyphs from this string could have
14544 been reordered. Find the one with the
14545 smallest string position. Or there could
14546 be a character in the string with the
14547 `cursor' property, which means display
14548 cursor on that character's glyph. */
14549 ptrdiff_t strpos
= glyph
->charpos
;
14554 string_from_text_prop
= true;
14557 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14558 && EQ (glyph
->object
, str
);
14562 ptrdiff_t gpos
= glyph
->charpos
;
14564 cprop
= Fget_char_property (make_number (gpos
),
14572 if (tem
&& glyph
->charpos
< strpos
)
14574 strpos
= glyph
->charpos
;
14580 || (tem
- pt_old
> 0 && tem
< pos_after
))
14584 pos
= tem
+ 1; /* don't find previous instances */
14586 /* This string is not what we want; skip all of the
14587 glyphs that came from it. */
14588 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14589 && EQ (glyph
->object
, str
))
14596 /* If we reached the end of the line, and END was from a string,
14597 the cursor is not on this line. */
14599 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14600 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14601 && STRINGP (end
->object
)
14602 && row
->continued_p
)
14605 /* A truncated row may not include PT among its character positions.
14606 Setting the cursor inside the scroll margin will trigger
14607 recalculation of hscroll in hscroll_window_tree. But if a
14608 display string covers point, defer to the string-handling
14609 code below to figure this out. */
14610 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14612 cursor
= glyph_before
;
14615 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14616 /* Zero-width characters produce no glyphs. */
14618 && (row
->reversed_p
14619 ? glyph_after
> glyphs_end
14620 : glyph_after
< glyphs_end
)))
14622 cursor
= glyph_after
;
14628 if (cursor
!= NULL
)
14630 else if (glyph
== glyphs_end
14631 && pos_before
== pos_after
14632 && STRINGP ((row
->reversed_p
14633 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14634 : row
->glyphs
[TEXT_AREA
])->object
))
14636 /* If all the glyphs of this row came from strings, put the
14637 cursor on the first glyph of the row. This avoids having the
14638 cursor outside of the text area in this very rare and hard
14642 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14643 : row
->glyphs
[TEXT_AREA
];
14649 /* Need to compute x that corresponds to GLYPH. */
14650 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14652 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14654 x
+= g
->pixel_width
;
14658 /* ROW could be part of a continued line, which, under bidi
14659 reordering, might have other rows whose start and end charpos
14660 occlude point. Only set w->cursor if we found a better
14661 approximation to the cursor position than we have from previously
14662 examined candidate rows belonging to the same continued line. */
14663 if (/* We already have a candidate row. */
14664 w
->cursor
.vpos
>= 0
14665 /* That candidate is not the row we are processing. */
14666 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14667 /* Make sure cursor.vpos specifies a row whose start and end
14668 charpos occlude point, and it is valid candidate for being a
14669 cursor-row. This is because some callers of this function
14670 leave cursor.vpos at the row where the cursor was displayed
14671 during the last redisplay cycle. */
14672 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14673 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14674 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14677 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14679 /* Don't consider glyphs that are outside TEXT_AREA. */
14680 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14682 /* Keep the candidate whose buffer position is the closest to
14683 point or has the `cursor' property. */
14684 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14685 w
->cursor
.hpos
>= 0
14686 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14687 && ((BUFFERP (g1
->object
)
14688 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14689 || (BUFFERP (glyph
->object
)
14690 && eabs (g1
->charpos
- pt_old
)
14691 < eabs (glyph
->charpos
- pt_old
))))
14692 /* Previous candidate is a glyph from a string that has
14693 a non-nil `cursor' property. */
14694 || (STRINGP (g1
->object
)
14695 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14696 Qcursor
, g1
->object
))
14697 /* Previous candidate is from the same display
14698 string as this one, and the display string
14699 came from a text property. */
14700 || (EQ (g1
->object
, glyph
->object
)
14701 && string_from_text_prop
)
14702 /* this candidate is from newline and its
14703 position is not an exact match */
14704 || (NILP (glyph
->object
)
14705 && glyph
->charpos
!= pt_old
)))))
14707 /* If this candidate gives an exact match, use that. */
14708 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14709 /* If this candidate is a glyph created for the
14710 terminating newline of a line, and point is on that
14711 newline, it wins because it's an exact match. */
14712 || (!row
->continued_p
14713 && NILP (glyph
->object
)
14714 && glyph
->charpos
== 0
14715 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14716 /* Otherwise, keep the candidate that comes from a row
14717 spanning less buffer positions. This may win when one or
14718 both candidate positions are on glyphs that came from
14719 display strings, for which we cannot compare buffer
14721 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14722 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14723 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14726 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14728 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14729 w
->cursor
.y
= row
->y
+ dy
;
14731 if (w
== XWINDOW (selected_window
))
14733 if (!row
->continued_p
14734 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14737 this_line_buffer
= XBUFFER (w
->contents
);
14739 CHARPOS (this_line_start_pos
)
14740 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14741 BYTEPOS (this_line_start_pos
)
14742 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14744 CHARPOS (this_line_end_pos
)
14745 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14746 BYTEPOS (this_line_end_pos
)
14747 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14749 this_line_y
= w
->cursor
.y
;
14750 this_line_pixel_height
= row
->height
;
14751 this_line_vpos
= w
->cursor
.vpos
;
14752 this_line_start_x
= row
->x
;
14755 CHARPOS (this_line_start_pos
) = 0;
14762 /* Run window scroll functions, if any, for WINDOW with new window
14763 start STARTP. Sets the window start of WINDOW to that position.
14765 We assume that the window's buffer is really current. */
14767 static struct text_pos
14768 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14770 struct window
*w
= XWINDOW (window
);
14771 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14773 eassert (current_buffer
== XBUFFER (w
->contents
));
14775 if (!NILP (Vwindow_scroll_functions
))
14777 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14778 make_number (CHARPOS (startp
)));
14779 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14780 /* In case the hook functions switch buffers. */
14781 set_buffer_internal (XBUFFER (w
->contents
));
14788 /* Make sure the line containing the cursor is fully visible.
14789 A value of true means there is nothing to be done.
14790 (Either the line is fully visible, or it cannot be made so,
14791 or we cannot tell.)
14793 If FORCE_P, return false even if partial visible cursor row
14794 is higher than window.
14796 If CURRENT_MATRIX_P, use the information from the
14797 window's current glyph matrix; otherwise use the desired glyph
14800 A value of false means the caller should do scrolling
14801 as if point had gone off the screen. */
14804 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14805 bool current_matrix_p
)
14807 struct glyph_matrix
*matrix
;
14808 struct glyph_row
*row
;
14811 if (!make_cursor_line_fully_visible_p
)
14814 /* It's not always possible to find the cursor, e.g, when a window
14815 is full of overlay strings. Don't do anything in that case. */
14816 if (w
->cursor
.vpos
< 0)
14819 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14820 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14822 /* If the cursor row is not partially visible, there's nothing to do. */
14823 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14826 /* If the row the cursor is in is taller than the window's height,
14827 it's not clear what to do, so do nothing. */
14828 window_height
= window_box_height (w
);
14829 if (row
->height
>= window_height
)
14831 if (!force_p
|| MINI_WINDOW_P (w
)
14832 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14839 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14840 means only WINDOW is redisplayed in redisplay_internal.
14841 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14842 in redisplay_window to bring a partially visible line into view in
14843 the case that only the cursor has moved.
14845 LAST_LINE_MISFIT should be true if we're scrolling because the
14846 last screen line's vertical height extends past the end of the screen.
14850 1 if scrolling succeeded
14852 0 if scrolling didn't find point.
14854 -1 if new fonts have been loaded so that we must interrupt
14855 redisplay, adjust glyph matrices, and try again. */
14861 SCROLLING_NEED_LARGER_MATRICES
14864 /* If scroll-conservatively is more than this, never recenter.
14866 If you change this, don't forget to update the doc string of
14867 `scroll-conservatively' and the Emacs manual. */
14868 #define SCROLL_LIMIT 100
14871 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14872 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14873 bool temp_scroll_step
, bool last_line_misfit
)
14875 struct window
*w
= XWINDOW (window
);
14876 struct frame
*f
= XFRAME (w
->frame
);
14877 struct text_pos pos
, startp
;
14879 int this_scroll_margin
, scroll_max
, rc
, height
;
14880 int dy
= 0, amount_to_scroll
= 0;
14881 bool scroll_down_p
= false;
14882 int extra_scroll_margin_lines
= last_line_misfit
;
14883 Lisp_Object aggressive
;
14884 /* We will never try scrolling more than this number of lines. */
14885 int scroll_limit
= SCROLL_LIMIT
;
14886 int frame_line_height
= default_line_pixel_height (w
);
14887 int window_total_lines
14888 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14891 debug_method_add (w
, "try_scrolling");
14894 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14896 /* Compute scroll margin height in pixels. We scroll when point is
14897 within this distance from the top or bottom of the window. */
14898 if (scroll_margin
> 0)
14899 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14900 * frame_line_height
;
14902 this_scroll_margin
= 0;
14904 /* Force arg_scroll_conservatively to have a reasonable value, to
14905 avoid scrolling too far away with slow move_it_* functions. Note
14906 that the user can supply scroll-conservatively equal to
14907 `most-positive-fixnum', which can be larger than INT_MAX. */
14908 if (arg_scroll_conservatively
> scroll_limit
)
14910 arg_scroll_conservatively
= scroll_limit
+ 1;
14911 scroll_max
= scroll_limit
* frame_line_height
;
14913 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14914 /* Compute how much we should try to scroll maximally to bring
14915 point into view. */
14916 scroll_max
= (max (scroll_step
,
14917 max (arg_scroll_conservatively
, temp_scroll_step
))
14918 * frame_line_height
);
14919 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14920 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14921 /* We're trying to scroll because of aggressive scrolling but no
14922 scroll_step is set. Choose an arbitrary one. */
14923 scroll_max
= 10 * frame_line_height
;
14929 /* Decide whether to scroll down. */
14930 if (PT
> CHARPOS (startp
))
14932 int scroll_margin_y
;
14934 /* Compute the pixel ypos of the scroll margin, then move IT to
14935 either that ypos or PT, whichever comes first. */
14936 start_display (&it
, w
, startp
);
14937 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14938 - frame_line_height
* extra_scroll_margin_lines
;
14939 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14940 (MOVE_TO_POS
| MOVE_TO_Y
));
14942 if (PT
> CHARPOS (it
.current
.pos
))
14944 int y0
= line_bottom_y (&it
);
14945 /* Compute how many pixels below window bottom to stop searching
14946 for PT. This avoids costly search for PT that is far away if
14947 the user limited scrolling by a small number of lines, but
14948 always finds PT if scroll_conservatively is set to a large
14949 number, such as most-positive-fixnum. */
14950 int slack
= max (scroll_max
, 10 * frame_line_height
);
14951 int y_to_move
= it
.last_visible_y
+ slack
;
14953 /* Compute the distance from the scroll margin to PT or to
14954 the scroll limit, whichever comes first. This should
14955 include the height of the cursor line, to make that line
14957 move_it_to (&it
, PT
, -1, y_to_move
,
14958 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14959 dy
= line_bottom_y (&it
) - y0
;
14961 if (dy
> scroll_max
)
14962 return SCROLLING_FAILED
;
14965 scroll_down_p
= true;
14971 /* Point is in or below the bottom scroll margin, so move the
14972 window start down. If scrolling conservatively, move it just
14973 enough down to make point visible. If scroll_step is set,
14974 move it down by scroll_step. */
14975 if (arg_scroll_conservatively
)
14977 = min (max (dy
, frame_line_height
),
14978 frame_line_height
* arg_scroll_conservatively
);
14979 else if (scroll_step
|| temp_scroll_step
)
14980 amount_to_scroll
= scroll_max
;
14983 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14984 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14985 if (NUMBERP (aggressive
))
14987 double float_amount
= XFLOATINT (aggressive
) * height
;
14988 int aggressive_scroll
= float_amount
;
14989 if (aggressive_scroll
== 0 && float_amount
> 0)
14990 aggressive_scroll
= 1;
14991 /* Don't let point enter the scroll margin near top of
14992 the window. This could happen if the value of
14993 scroll_up_aggressively is too large and there are
14994 non-zero margins, because scroll_up_aggressively
14995 means put point that fraction of window height
14996 _from_the_bottom_margin_. */
14997 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
14998 aggressive_scroll
= height
- 2 * this_scroll_margin
;
14999 amount_to_scroll
= dy
+ aggressive_scroll
;
15003 if (amount_to_scroll
<= 0)
15004 return SCROLLING_FAILED
;
15006 start_display (&it
, w
, startp
);
15007 if (arg_scroll_conservatively
<= scroll_limit
)
15008 move_it_vertically (&it
, amount_to_scroll
);
15011 /* Extra precision for users who set scroll-conservatively
15012 to a large number: make sure the amount we scroll
15013 the window start is never less than amount_to_scroll,
15014 which was computed as distance from window bottom to
15015 point. This matters when lines at window top and lines
15016 below window bottom have different height. */
15018 void *it1data
= NULL
;
15019 /* We use a temporary it1 because line_bottom_y can modify
15020 its argument, if it moves one line down; see there. */
15023 SAVE_IT (it1
, it
, it1data
);
15024 start_y
= line_bottom_y (&it1
);
15026 RESTORE_IT (&it
, &it
, it1data
);
15027 move_it_by_lines (&it
, 1);
15028 SAVE_IT (it1
, it
, it1data
);
15029 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15032 /* If STARTP is unchanged, move it down another screen line. */
15033 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15034 move_it_by_lines (&it
, 1);
15035 startp
= it
.current
.pos
;
15039 struct text_pos scroll_margin_pos
= startp
;
15042 /* See if point is inside the scroll margin at the top of the
15044 if (this_scroll_margin
)
15048 start_display (&it
, w
, startp
);
15049 y_start
= it
.current_y
;
15050 move_it_vertically (&it
, this_scroll_margin
);
15051 scroll_margin_pos
= it
.current
.pos
;
15052 /* If we didn't move enough before hitting ZV, request
15053 additional amount of scroll, to move point out of the
15055 if (IT_CHARPOS (it
) == ZV
15056 && it
.current_y
- y_start
< this_scroll_margin
)
15057 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15060 if (PT
< CHARPOS (scroll_margin_pos
))
15062 /* Point is in the scroll margin at the top of the window or
15063 above what is displayed in the window. */
15066 /* Compute the vertical distance from PT to the scroll
15067 margin position. Move as far as scroll_max allows, or
15068 one screenful, or 10 screen lines, whichever is largest.
15069 Give up if distance is greater than scroll_max or if we
15070 didn't reach the scroll margin position. */
15071 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15072 start_display (&it
, w
, pos
);
15074 y_to_move
= max (it
.last_visible_y
,
15075 max (scroll_max
, 10 * frame_line_height
));
15076 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15078 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15079 dy
= it
.current_y
- y0
;
15080 if (dy
> scroll_max
15081 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15082 return SCROLLING_FAILED
;
15084 /* Additional scroll for when ZV was too close to point. */
15087 /* Compute new window start. */
15088 start_display (&it
, w
, startp
);
15090 if (arg_scroll_conservatively
)
15091 amount_to_scroll
= max (dy
, frame_line_height
15092 * max (scroll_step
, temp_scroll_step
));
15093 else if (scroll_step
|| temp_scroll_step
)
15094 amount_to_scroll
= scroll_max
;
15097 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15098 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15099 if (NUMBERP (aggressive
))
15101 double float_amount
= XFLOATINT (aggressive
) * height
;
15102 int aggressive_scroll
= float_amount
;
15103 if (aggressive_scroll
== 0 && float_amount
> 0)
15104 aggressive_scroll
= 1;
15105 /* Don't let point enter the scroll margin near
15106 bottom of the window, if the value of
15107 scroll_down_aggressively happens to be too
15109 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15110 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15111 amount_to_scroll
= dy
+ aggressive_scroll
;
15115 if (amount_to_scroll
<= 0)
15116 return SCROLLING_FAILED
;
15118 move_it_vertically_backward (&it
, amount_to_scroll
);
15119 startp
= it
.current
.pos
;
15123 /* Run window scroll functions. */
15124 startp
= run_window_scroll_functions (window
, startp
);
15126 /* Display the window. Give up if new fonts are loaded, or if point
15128 if (!try_window (window
, startp
, 0))
15129 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15130 else if (w
->cursor
.vpos
< 0)
15132 clear_glyph_matrix (w
->desired_matrix
);
15133 rc
= SCROLLING_FAILED
;
15137 /* Maybe forget recorded base line for line number display. */
15138 if (!just_this_one_p
15139 || current_buffer
->clip_changed
15140 || BEG_UNCHANGED
< CHARPOS (startp
))
15141 w
->base_line_number
= 0;
15143 /* If cursor ends up on a partially visible line,
15144 treat that as being off the bottom of the screen. */
15145 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15147 /* It's possible that the cursor is on the first line of the
15148 buffer, which is partially obscured due to a vscroll
15149 (Bug#7537). In that case, avoid looping forever. */
15150 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15152 clear_glyph_matrix (w
->desired_matrix
);
15153 ++extra_scroll_margin_lines
;
15156 rc
= SCROLLING_SUCCESS
;
15163 /* Compute a suitable window start for window W if display of W starts
15164 on a continuation line. Value is true if a new window start
15167 The new window start will be computed, based on W's width, starting
15168 from the start of the continued line. It is the start of the
15169 screen line with the minimum distance from the old start W->start. */
15172 compute_window_start_on_continuation_line (struct window
*w
)
15174 struct text_pos pos
, start_pos
;
15175 bool window_start_changed_p
= false;
15177 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15179 /* If window start is on a continuation line... Window start may be
15180 < BEGV in case there's invisible text at the start of the
15181 buffer (M-x rmail, for example). */
15182 if (CHARPOS (start_pos
) > BEGV
15183 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15186 struct glyph_row
*row
;
15188 /* Handle the case that the window start is out of range. */
15189 if (CHARPOS (start_pos
) < BEGV
)
15190 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15191 else if (CHARPOS (start_pos
) > ZV
)
15192 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15194 /* Find the start of the continued line. This should be fast
15195 because find_newline is fast (newline cache). */
15196 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15197 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15198 row
, DEFAULT_FACE_ID
);
15199 reseat_at_previous_visible_line_start (&it
);
15201 /* If the line start is "too far" away from the window start,
15202 say it takes too much time to compute a new window start. */
15203 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15204 /* PXW: Do we need upper bounds here? */
15205 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15207 int min_distance
, distance
;
15209 /* Move forward by display lines to find the new window
15210 start. If window width was enlarged, the new start can
15211 be expected to be > the old start. If window width was
15212 decreased, the new window start will be < the old start.
15213 So, we're looking for the display line start with the
15214 minimum distance from the old window start. */
15215 pos
= it
.current
.pos
;
15216 min_distance
= INFINITY
;
15217 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15218 distance
< min_distance
)
15220 min_distance
= distance
;
15221 pos
= it
.current
.pos
;
15222 if (it
.line_wrap
== WORD_WRAP
)
15224 /* Under WORD_WRAP, move_it_by_lines is likely to
15225 overshoot and stop not at the first, but the
15226 second character from the left margin. So in
15227 that case, we need a more tight control on the X
15228 coordinate of the iterator than move_it_by_lines
15229 promises in its contract. The method is to first
15230 go to the last (rightmost) visible character of a
15231 line, then move to the leftmost character on the
15232 next line in a separate call. */
15233 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15234 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15235 move_it_to (&it
, ZV
, 0,
15236 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15237 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15240 move_it_by_lines (&it
, 1);
15243 /* Set the window start there. */
15244 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15245 window_start_changed_p
= true;
15249 return window_start_changed_p
;
15253 /* Try cursor movement in case text has not changed in window WINDOW,
15254 with window start STARTP. Value is
15256 CURSOR_MOVEMENT_SUCCESS if successful
15258 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15260 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15261 display. *SCROLL_STEP is set to true, under certain circumstances, if
15262 we want to scroll as if scroll-step were set to 1. See the code.
15264 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15265 which case we have to abort this redisplay, and adjust matrices
15270 CURSOR_MOVEMENT_SUCCESS
,
15271 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15272 CURSOR_MOVEMENT_MUST_SCROLL
,
15273 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15277 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15280 struct window
*w
= XWINDOW (window
);
15281 struct frame
*f
= XFRAME (w
->frame
);
15282 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15285 if (inhibit_try_cursor_movement
)
15289 /* Previously, there was a check for Lisp integer in the
15290 if-statement below. Now, this field is converted to
15291 ptrdiff_t, thus zero means invalid position in a buffer. */
15292 eassert (w
->last_point
> 0);
15293 /* Likewise there was a check whether window_end_vpos is nil or larger
15294 than the window. Now window_end_vpos is int and so never nil, but
15295 let's leave eassert to check whether it fits in the window. */
15296 eassert (!w
->window_end_valid
15297 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15299 /* Handle case where text has not changed, only point, and it has
15300 not moved off the frame. */
15301 if (/* Point may be in this window. */
15302 PT
>= CHARPOS (startp
)
15303 /* Selective display hasn't changed. */
15304 && !current_buffer
->clip_changed
15305 /* Function force-mode-line-update is used to force a thorough
15306 redisplay. It sets either windows_or_buffers_changed or
15307 update_mode_lines. So don't take a shortcut here for these
15309 && !update_mode_lines
15310 && !windows_or_buffers_changed
15311 && !f
->cursor_type_changed
15312 && NILP (Vshow_trailing_whitespace
)
15313 /* This code is not used for mini-buffer for the sake of the case
15314 of redisplaying to replace an echo area message; since in
15315 that case the mini-buffer contents per se are usually
15316 unchanged. This code is of no real use in the mini-buffer
15317 since the handling of this_line_start_pos, etc., in redisplay
15318 handles the same cases. */
15319 && !EQ (window
, minibuf_window
)
15320 && (FRAME_WINDOW_P (f
)
15321 || !overlay_arrow_in_current_buffer_p ()))
15323 int this_scroll_margin
, top_scroll_margin
;
15324 struct glyph_row
*row
= NULL
;
15325 int frame_line_height
= default_line_pixel_height (w
);
15326 int window_total_lines
15327 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15330 debug_method_add (w
, "cursor movement");
15333 /* Scroll if point within this distance from the top or bottom
15334 of the window. This is a pixel value. */
15335 if (scroll_margin
> 0)
15337 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15338 this_scroll_margin
*= frame_line_height
;
15341 this_scroll_margin
= 0;
15343 top_scroll_margin
= this_scroll_margin
;
15344 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15345 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15347 /* Start with the row the cursor was displayed during the last
15348 not paused redisplay. Give up if that row is not valid. */
15349 if (w
->last_cursor_vpos
< 0
15350 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15351 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15354 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15355 if (row
->mode_line_p
)
15357 if (!row
->enabled_p
)
15358 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15361 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15363 bool scroll_p
= false, must_scroll
= false;
15364 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15366 if (PT
> w
->last_point
)
15368 /* Point has moved forward. */
15369 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15370 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15372 eassert (row
->enabled_p
);
15376 /* If the end position of a row equals the start
15377 position of the next row, and PT is at that position,
15378 we would rather display cursor in the next line. */
15379 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15380 && MATRIX_ROW_END_CHARPOS (row
) == PT
15381 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15382 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15383 && !cursor_row_p (row
))
15386 /* If within the scroll margin, scroll. Note that
15387 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15388 the next line would be drawn, and that
15389 this_scroll_margin can be zero. */
15390 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15391 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15392 /* Line is completely visible last line in window
15393 and PT is to be set in the next line. */
15394 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15395 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15396 && !row
->ends_at_zv_p
15397 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15400 else if (PT
< w
->last_point
)
15402 /* Cursor has to be moved backward. Note that PT >=
15403 CHARPOS (startp) because of the outer if-statement. */
15404 while (!row
->mode_line_p
15405 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15406 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15407 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15408 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15409 row
> w
->current_matrix
->rows
15410 && (row
-1)->ends_in_newline_from_string_p
))))
15411 && (row
->y
> top_scroll_margin
15412 || CHARPOS (startp
) == BEGV
))
15414 eassert (row
->enabled_p
);
15418 /* Consider the following case: Window starts at BEGV,
15419 there is invisible, intangible text at BEGV, so that
15420 display starts at some point START > BEGV. It can
15421 happen that we are called with PT somewhere between
15422 BEGV and START. Try to handle that case. */
15423 if (row
< w
->current_matrix
->rows
15424 || row
->mode_line_p
)
15426 row
= w
->current_matrix
->rows
;
15427 if (row
->mode_line_p
)
15431 /* Due to newlines in overlay strings, we may have to
15432 skip forward over overlay strings. */
15433 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15434 && MATRIX_ROW_END_CHARPOS (row
) == PT
15435 && !cursor_row_p (row
))
15438 /* If within the scroll margin, scroll. */
15439 if (row
->y
< top_scroll_margin
15440 && CHARPOS (startp
) != BEGV
)
15445 /* Cursor did not move. So don't scroll even if cursor line
15446 is partially visible, as it was so before. */
15447 rc
= CURSOR_MOVEMENT_SUCCESS
;
15450 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15451 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15453 /* if PT is not in the glyph row, give up. */
15454 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15455 must_scroll
= true;
15457 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15458 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15460 struct glyph_row
*row1
;
15462 /* If rows are bidi-reordered and point moved, back up
15463 until we find a row that does not belong to a
15464 continuation line. This is because we must consider
15465 all rows of a continued line as candidates for the
15466 new cursor positioning, since row start and end
15467 positions change non-linearly with vertical position
15469 /* FIXME: Revisit this when glyph ``spilling'' in
15470 continuation lines' rows is implemented for
15471 bidi-reordered rows. */
15472 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15473 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15476 /* If we hit the beginning of the displayed portion
15477 without finding the first row of a continued
15481 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15484 eassert (row
->enabled_p
);
15489 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15490 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15491 /* Make sure this isn't a header line by any chance, since
15492 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15493 && !row
->mode_line_p
15494 && make_cursor_line_fully_visible_p
)
15496 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15497 && !row
->ends_at_zv_p
15498 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15499 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15500 else if (row
->height
> window_box_height (w
))
15502 /* If we end up in a partially visible line, let's
15503 make it fully visible, except when it's taller
15504 than the window, in which case we can't do much
15506 *scroll_step
= true;
15507 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15511 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15512 if (!cursor_row_fully_visible_p (w
, false, true))
15513 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15515 rc
= CURSOR_MOVEMENT_SUCCESS
;
15519 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15520 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15521 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15523 /* With bidi-reordered rows, there could be more than
15524 one candidate row whose start and end positions
15525 occlude point. We need to let set_cursor_from_row
15526 find the best candidate. */
15527 /* FIXME: Revisit this when glyph ``spilling'' in
15528 continuation lines' rows is implemented for
15529 bidi-reordered rows. */
15534 bool at_zv_p
= false, exact_match_p
= false;
15536 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15537 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15538 && cursor_row_p (row
))
15539 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15541 /* As soon as we've found the exact match for point,
15542 or the first suitable row whose ends_at_zv_p flag
15543 is set, we are done. */
15546 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15547 w
->cursor
.vpos
)->ends_at_zv_p
;
15549 && w
->cursor
.hpos
>= 0
15550 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15553 struct glyph_row
*candidate
=
15554 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15556 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15557 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15560 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15561 || (NILP (g
->object
)
15562 && (g
->charpos
== PT
15563 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15565 if (at_zv_p
|| exact_match_p
)
15567 rc
= CURSOR_MOVEMENT_SUCCESS
;
15571 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15575 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15576 || row
->continued_p
)
15577 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15578 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15579 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15580 /* If we didn't find any candidate rows, or exited the
15581 loop before all the candidates were examined, signal
15582 to the caller that this method failed. */
15583 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15585 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15586 && !row
->continued_p
))
15587 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15589 rc
= CURSOR_MOVEMENT_SUCCESS
;
15595 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15597 rc
= CURSOR_MOVEMENT_SUCCESS
;
15602 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15603 && MATRIX_ROW_START_CHARPOS (row
) == PT
15604 && cursor_row_p (row
));
15614 set_vertical_scroll_bar (struct window
*w
)
15616 ptrdiff_t start
, end
, whole
;
15618 /* Calculate the start and end positions for the current window.
15619 At some point, it would be nice to choose between scrollbars
15620 which reflect the whole buffer size, with special markers
15621 indicating narrowing, and scrollbars which reflect only the
15624 Note that mini-buffers sometimes aren't displaying any text. */
15625 if (!MINI_WINDOW_P (w
)
15626 || (w
== XWINDOW (minibuf_window
)
15627 && NILP (echo_area_buffer
[0])))
15629 struct buffer
*buf
= XBUFFER (w
->contents
);
15630 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15631 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15632 /* I don't think this is guaranteed to be right. For the
15633 moment, we'll pretend it is. */
15634 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15638 if (whole
< (end
- start
))
15639 whole
= end
- start
;
15642 start
= end
= whole
= 0;
15644 /* Indicate what this scroll bar ought to be displaying now. */
15645 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15646 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15647 (w
, end
- start
, whole
, start
);
15652 set_horizontal_scroll_bar (struct window
*w
)
15654 int start
, end
, whole
, portion
;
15656 if (!MINI_WINDOW_P (w
)
15657 || (w
== XWINDOW (minibuf_window
)
15658 && NILP (echo_area_buffer
[0])))
15660 struct buffer
*b
= XBUFFER (w
->contents
);
15661 struct buffer
*old_buffer
= NULL
;
15663 struct text_pos startp
;
15665 if (b
!= current_buffer
)
15667 old_buffer
= current_buffer
;
15668 set_buffer_internal (b
);
15671 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15672 start_display (&it
, w
, startp
);
15673 it
.last_visible_x
= INT_MAX
;
15674 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15675 MOVE_TO_X
| MOVE_TO_Y
);
15676 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15677 window_box_height (w), -1,
15678 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15680 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15681 end
= start
+ window_box_width (w
, TEXT_AREA
);
15682 portion
= end
- start
;
15683 /* After enlarging a horizontally scrolled window such that it
15684 gets at least as wide as the text it contains, make sure that
15685 the thumb doesn't fill the entire scroll bar so we can still
15686 drag it back to see the entire text. */
15687 whole
= max (whole
, end
);
15693 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15694 if (EQ (pdir
, Qright_to_left
))
15696 start
= whole
- end
;
15697 end
= start
+ portion
;
15702 set_buffer_internal (old_buffer
);
15705 start
= end
= whole
= portion
= 0;
15707 w
->hscroll_whole
= whole
;
15709 /* Indicate what this scroll bar ought to be displaying now. */
15710 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15711 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15712 (w
, portion
, whole
, start
);
15716 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15717 selected_window is redisplayed.
15719 We can return without actually redisplaying the window if fonts has been
15720 changed on window's frame. In that case, redisplay_internal will retry.
15722 As one of the important parts of redisplaying a window, we need to
15723 decide whether the previous window-start position (stored in the
15724 window's w->start marker position) is still valid, and if it isn't,
15725 recompute it. Some details about that:
15727 . The previous window-start could be in a continuation line, in
15728 which case we need to recompute it when the window width
15729 changes. See compute_window_start_on_continuation_line and its
15732 . The text that changed since last redisplay could include the
15733 previous window-start position. In that case, we try to salvage
15734 what we can from the current glyph matrix by calling
15735 try_scrolling, which see.
15737 . Some Emacs command could force us to use a specific window-start
15738 position by setting the window's force_start flag, or gently
15739 propose doing that by setting the window's optional_new_start
15740 flag. In these cases, we try using the specified start point if
15741 that succeeds (i.e. the window desired matrix is successfully
15742 recomputed, and point location is within the window). In case
15743 of optional_new_start, we first check if the specified start
15744 position is feasible, i.e. if it will allow point to be
15745 displayed in the window. If using the specified start point
15746 fails, e.g., if new fonts are needed to be loaded, we abort the
15747 redisplay cycle and leave it up to the next cycle to figure out
15750 . Note that the window's force_start flag is sometimes set by
15751 redisplay itself, when it decides that the previous window start
15752 point is fine and should be kept. Search for "goto force_start"
15753 below to see the details. Like the values of window-start
15754 specified outside of redisplay, these internally-deduced values
15755 are tested for feasibility, and ignored if found to be
15758 . Note that the function try_window, used to completely redisplay
15759 a window, accepts the window's start point as its argument.
15760 This is used several times in the redisplay code to control
15761 where the window start will be, according to user options such
15762 as scroll-conservatively, and also to ensure the screen line
15763 showing point will be fully (as opposed to partially) visible on
15767 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15769 struct window
*w
= XWINDOW (window
);
15770 struct frame
*f
= XFRAME (w
->frame
);
15771 struct buffer
*buffer
= XBUFFER (w
->contents
);
15772 struct buffer
*old
= current_buffer
;
15773 struct text_pos lpoint
, opoint
, startp
;
15774 bool update_mode_line
;
15777 /* Record it now because it's overwritten. */
15778 bool current_matrix_up_to_date_p
= false;
15779 bool used_current_matrix_p
= false;
15780 /* This is less strict than current_matrix_up_to_date_p.
15781 It indicates that the buffer contents and narrowing are unchanged. */
15782 bool buffer_unchanged_p
= false;
15783 bool temp_scroll_step
= false;
15784 ptrdiff_t count
= SPECPDL_INDEX ();
15786 int centering_position
= -1;
15787 bool last_line_misfit
= false;
15788 ptrdiff_t beg_unchanged
, end_unchanged
;
15789 int frame_line_height
;
15791 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15795 *w
->desired_matrix
->method
= 0;
15798 if (!just_this_one_p
15799 && REDISPLAY_SOME_P ()
15801 && !w
->update_mode_line
15803 && !buffer
->text
->redisplay
15804 && BUF_PT (buffer
) == w
->last_point
)
15807 /* Make sure that both W's markers are valid. */
15808 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15809 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15811 /* We come here again if we need to run window-text-change-functions
15814 reconsider_clip_changes (w
);
15815 frame_line_height
= default_line_pixel_height (w
);
15817 /* Has the mode line to be updated? */
15818 update_mode_line
= (w
->update_mode_line
15819 || update_mode_lines
15820 || buffer
->clip_changed
15821 || buffer
->prevent_redisplay_optimizations_p
);
15823 if (!just_this_one_p
)
15824 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15825 cleverly elsewhere. */
15826 w
->must_be_updated_p
= true;
15828 if (MINI_WINDOW_P (w
))
15830 if (w
== XWINDOW (echo_area_window
)
15831 && !NILP (echo_area_buffer
[0]))
15833 if (update_mode_line
)
15834 /* We may have to update a tty frame's menu bar or a
15835 tool-bar. Example `M-x C-h C-h C-g'. */
15836 goto finish_menu_bars
;
15838 /* We've already displayed the echo area glyphs in this window. */
15839 goto finish_scroll_bars
;
15841 else if ((w
!= XWINDOW (minibuf_window
)
15842 || minibuf_level
== 0)
15843 /* When buffer is nonempty, redisplay window normally. */
15844 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15845 /* Quail displays non-mini buffers in minibuffer window.
15846 In that case, redisplay the window normally. */
15847 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15849 /* W is a mini-buffer window, but it's not active, so clear
15851 int yb
= window_text_bottom_y (w
);
15852 struct glyph_row
*row
;
15855 for (y
= 0, row
= w
->desired_matrix
->rows
;
15857 y
+= row
->height
, ++row
)
15858 blank_row (w
, row
, y
);
15859 goto finish_scroll_bars
;
15862 clear_glyph_matrix (w
->desired_matrix
);
15865 /* Otherwise set up data on this window; select its buffer and point
15867 /* Really select the buffer, for the sake of buffer-local
15869 set_buffer_internal_1 (XBUFFER (w
->contents
));
15871 current_matrix_up_to_date_p
15872 = (w
->window_end_valid
15873 && !current_buffer
->clip_changed
15874 && !current_buffer
->prevent_redisplay_optimizations_p
15875 && !window_outdated (w
));
15877 /* Run the window-text-change-functions
15878 if it is possible that the text on the screen has changed
15879 (either due to modification of the text, or any other reason). */
15880 if (!current_matrix_up_to_date_p
15881 && !NILP (Vwindow_text_change_functions
))
15883 safe_run_hooks (Qwindow_text_change_functions
);
15887 beg_unchanged
= BEG_UNCHANGED
;
15888 end_unchanged
= END_UNCHANGED
;
15890 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15892 specbind (Qinhibit_point_motion_hooks
, Qt
);
15895 = (w
->window_end_valid
15896 && !current_buffer
->clip_changed
15897 && !window_outdated (w
));
15899 /* When windows_or_buffers_changed is non-zero, we can't rely
15900 on the window end being valid, so set it to zero there. */
15901 if (windows_or_buffers_changed
)
15903 /* If window starts on a continuation line, maybe adjust the
15904 window start in case the window's width changed. */
15905 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15906 compute_window_start_on_continuation_line (w
);
15908 w
->window_end_valid
= false;
15909 /* If so, we also can't rely on current matrix
15910 and should not fool try_cursor_movement below. */
15911 current_matrix_up_to_date_p
= false;
15914 /* Some sanity checks. */
15915 CHECK_WINDOW_END (w
);
15916 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15918 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15921 if (mode_line_update_needed (w
))
15922 update_mode_line
= true;
15924 /* Point refers normally to the selected window. For any other
15925 window, set up appropriate value. */
15926 if (!EQ (window
, selected_window
))
15928 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15929 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15934 new_pt_byte
= BEGV_BYTE
;
15935 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15937 else if (new_pt
> (ZV
- 1))
15940 new_pt_byte
= ZV_BYTE
;
15941 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15944 /* We don't use SET_PT so that the point-motion hooks don't run. */
15945 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15948 /* If any of the character widths specified in the display table
15949 have changed, invalidate the width run cache. It's true that
15950 this may be a bit late to catch such changes, but the rest of
15951 redisplay goes (non-fatally) haywire when the display table is
15952 changed, so why should we worry about doing any better? */
15953 if (current_buffer
->width_run_cache
15954 || (current_buffer
->base_buffer
15955 && current_buffer
->base_buffer
->width_run_cache
))
15957 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15959 if (! disptab_matches_widthtab
15960 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15962 struct buffer
*buf
= current_buffer
;
15964 if (buf
->base_buffer
)
15965 buf
= buf
->base_buffer
;
15966 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
15967 recompute_width_table (current_buffer
, disptab
);
15971 /* If window-start is screwed up, choose a new one. */
15972 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15975 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15977 /* If someone specified a new starting point but did not insist,
15978 check whether it can be used. */
15979 if ((w
->optional_new_start
|| window_frozen_p (w
))
15980 && CHARPOS (startp
) >= BEGV
15981 && CHARPOS (startp
) <= ZV
)
15983 ptrdiff_t it_charpos
;
15985 w
->optional_new_start
= false;
15986 start_display (&it
, w
, startp
);
15987 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15988 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15989 /* Record IT's position now, since line_bottom_y might change
15991 it_charpos
= IT_CHARPOS (it
);
15992 /* Make sure we set the force_start flag only if the cursor row
15993 will be fully visible. Otherwise, the code under force_start
15994 label below will try to move point back into view, which is
15995 not what the code which sets optional_new_start wants. */
15996 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
15997 && !w
->force_start
)
15999 if (it_charpos
== PT
)
16000 w
->force_start
= true;
16001 /* IT may overshoot PT if text at PT is invisible. */
16002 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16003 w
->force_start
= true;
16005 if (w
->force_start
)
16007 if (window_frozen_p (w
))
16008 debug_method_add (w
, "set force_start from frozen window start");
16010 debug_method_add (w
, "set force_start from optional_new_start");
16018 /* Handle case where place to start displaying has been specified,
16019 unless the specified location is outside the accessible range. */
16020 if (w
->force_start
)
16022 /* We set this later on if we have to adjust point. */
16025 w
->force_start
= false;
16027 w
->window_end_valid
= false;
16029 /* Forget any recorded base line for line number display. */
16030 if (!buffer_unchanged_p
)
16031 w
->base_line_number
= 0;
16033 /* Redisplay the mode line. Select the buffer properly for that.
16034 Also, run the hook window-scroll-functions
16035 because we have scrolled. */
16036 /* Note, we do this after clearing force_start because
16037 if there's an error, it is better to forget about force_start
16038 than to get into an infinite loop calling the hook functions
16039 and having them get more errors. */
16040 if (!update_mode_line
16041 || ! NILP (Vwindow_scroll_functions
))
16043 update_mode_line
= true;
16044 w
->update_mode_line
= true;
16045 startp
= run_window_scroll_functions (window
, startp
);
16048 if (CHARPOS (startp
) < BEGV
)
16049 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16050 else if (CHARPOS (startp
) > ZV
)
16051 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16053 /* Redisplay, then check if cursor has been set during the
16054 redisplay. Give up if new fonts were loaded. */
16055 /* We used to issue a CHECK_MARGINS argument to try_window here,
16056 but this causes scrolling to fail when point begins inside
16057 the scroll margin (bug#148) -- cyd */
16058 if (!try_window (window
, startp
, 0))
16060 w
->force_start
= true;
16061 clear_glyph_matrix (w
->desired_matrix
);
16062 goto need_larger_matrices
;
16065 if (w
->cursor
.vpos
< 0)
16067 /* If point does not appear, try to move point so it does
16068 appear. The desired matrix has been built above, so we
16069 can use it here. */
16070 new_vpos
= window_box_height (w
) / 2;
16073 if (!cursor_row_fully_visible_p (w
, false, false))
16075 /* Point does appear, but on a line partly visible at end of window.
16076 Move it back to a fully-visible line. */
16077 new_vpos
= window_box_height (w
);
16078 /* But if window_box_height suggests a Y coordinate that is
16079 not less than we already have, that line will clearly not
16080 be fully visible, so give up and scroll the display.
16081 This can happen when the default face uses a font whose
16082 dimensions are different from the frame's default
16084 if (new_vpos
>= w
->cursor
.y
)
16086 w
->cursor
.vpos
= -1;
16087 clear_glyph_matrix (w
->desired_matrix
);
16088 goto try_to_scroll
;
16091 else if (w
->cursor
.vpos
>= 0)
16093 /* Some people insist on not letting point enter the scroll
16094 margin, even though this part handles windows that didn't
16096 int window_total_lines
16097 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16098 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16099 int pixel_margin
= margin
* frame_line_height
;
16100 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16102 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16103 below, which finds the row to move point to, advances by
16104 the Y coordinate of the _next_ row, see the definition of
16105 MATRIX_ROW_BOTTOM_Y. */
16106 if (w
->cursor
.vpos
< margin
+ header_line
)
16108 w
->cursor
.vpos
= -1;
16109 clear_glyph_matrix (w
->desired_matrix
);
16110 goto try_to_scroll
;
16114 int window_height
= window_box_height (w
);
16117 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16118 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16120 w
->cursor
.vpos
= -1;
16121 clear_glyph_matrix (w
->desired_matrix
);
16122 goto try_to_scroll
;
16127 /* If we need to move point for either of the above reasons,
16128 now actually do it. */
16131 struct glyph_row
*row
;
16133 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16134 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16137 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16138 MATRIX_ROW_START_BYTEPOS (row
));
16140 if (w
!= XWINDOW (selected_window
))
16141 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16142 else if (current_buffer
== old
)
16143 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16145 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16147 /* Re-run pre-redisplay-function so it can update the region
16148 according to the new position of point. */
16149 /* Other than the cursor, w's redisplay is done so we can set its
16150 redisplay to false. Also the buffer's redisplay can be set to
16151 false, since propagate_buffer_redisplay should have already
16152 propagated its info to `w' anyway. */
16153 w
->redisplay
= false;
16154 XBUFFER (w
->contents
)->text
->redisplay
= false;
16155 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16157 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16159 /* pre-redisplay-function made changes (e.g. move the region)
16160 that require another round of redisplay. */
16161 clear_glyph_matrix (w
->desired_matrix
);
16162 if (!try_window (window
, startp
, 0))
16163 goto need_larger_matrices
;
16166 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16168 clear_glyph_matrix (w
->desired_matrix
);
16169 goto try_to_scroll
;
16173 debug_method_add (w
, "forced window start");
16178 /* Handle case where text has not changed, only point, and it has
16179 not moved off the frame, and we are not retrying after hscroll.
16180 (current_matrix_up_to_date_p is true when retrying.) */
16181 if (current_matrix_up_to_date_p
16182 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16183 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16187 case CURSOR_MOVEMENT_SUCCESS
:
16188 used_current_matrix_p
= true;
16191 case CURSOR_MOVEMENT_MUST_SCROLL
:
16192 goto try_to_scroll
;
16198 /* If current starting point was originally the beginning of a line
16199 but no longer is, find a new starting point. */
16200 else if (w
->start_at_line_beg
16201 && !(CHARPOS (startp
) <= BEGV
16202 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16205 debug_method_add (w
, "recenter 1");
16210 /* Try scrolling with try_window_id. Value is > 0 if update has
16211 been done, it is -1 if we know that the same window start will
16212 not work. It is 0 if unsuccessful for some other reason. */
16213 else if ((tem
= try_window_id (w
)) != 0)
16216 debug_method_add (w
, "try_window_id %d", tem
);
16219 if (f
->fonts_changed
)
16220 goto need_larger_matrices
;
16224 /* Otherwise try_window_id has returned -1 which means that we
16225 don't want the alternative below this comment to execute. */
16227 else if (CHARPOS (startp
) >= BEGV
16228 && CHARPOS (startp
) <= ZV
16229 && PT
>= CHARPOS (startp
)
16230 && (CHARPOS (startp
) < ZV
16231 /* Avoid starting at end of buffer. */
16232 || CHARPOS (startp
) == BEGV
16233 || !window_outdated (w
)))
16235 int d1
, d2
, d5
, d6
;
16238 /* If first window line is a continuation line, and window start
16239 is inside the modified region, but the first change is before
16240 current window start, we must select a new window start.
16242 However, if this is the result of a down-mouse event (e.g. by
16243 extending the mouse-drag-overlay), we don't want to select a
16244 new window start, since that would change the position under
16245 the mouse, resulting in an unwanted mouse-movement rather
16246 than a simple mouse-click. */
16247 if (!w
->start_at_line_beg
16248 && NILP (do_mouse_tracking
)
16249 && CHARPOS (startp
) > BEGV
16250 && CHARPOS (startp
) > BEG
+ beg_unchanged
16251 && CHARPOS (startp
) <= Z
- end_unchanged
16252 /* Even if w->start_at_line_beg is nil, a new window may
16253 start at a line_beg, since that's how set_buffer_window
16254 sets it. So, we need to check the return value of
16255 compute_window_start_on_continuation_line. (See also
16257 && XMARKER (w
->start
)->buffer
== current_buffer
16258 && compute_window_start_on_continuation_line (w
)
16259 /* It doesn't make sense to force the window start like we
16260 do at label force_start if it is already known that point
16261 will not be fully visible in the resulting window, because
16262 doing so will move point from its correct position
16263 instead of scrolling the window to bring point into view.
16265 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16266 /* A very tall row could need more than the window height,
16267 in which case we accept that it is partially visible. */
16268 && (rtop
!= 0) == (rbot
!= 0))
16270 w
->force_start
= true;
16271 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16273 debug_method_add (w
, "recomputed window start in continuation line");
16279 debug_method_add (w
, "same window start");
16282 /* Try to redisplay starting at same place as before.
16283 If point has not moved off frame, accept the results. */
16284 if (!current_matrix_up_to_date_p
16285 /* Don't use try_window_reusing_current_matrix in this case
16286 because a window scroll function can have changed the
16288 || !NILP (Vwindow_scroll_functions
)
16289 || MINI_WINDOW_P (w
)
16290 || !(used_current_matrix_p
16291 = try_window_reusing_current_matrix (w
)))
16293 IF_DEBUG (debug_method_add (w
, "1"));
16294 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16295 /* -1 means we need to scroll.
16296 0 means we need new matrices, but fonts_changed
16297 is set in that case, so we will detect it below. */
16298 goto try_to_scroll
;
16301 if (f
->fonts_changed
)
16302 goto need_larger_matrices
;
16304 if (w
->cursor
.vpos
>= 0)
16306 if (!just_this_one_p
16307 || current_buffer
->clip_changed
16308 || BEG_UNCHANGED
< CHARPOS (startp
))
16309 /* Forget any recorded base line for line number display. */
16310 w
->base_line_number
= 0;
16312 if (!cursor_row_fully_visible_p (w
, true, false))
16314 clear_glyph_matrix (w
->desired_matrix
);
16315 last_line_misfit
= true;
16317 /* Drop through and scroll. */
16322 clear_glyph_matrix (w
->desired_matrix
);
16327 /* Redisplay the mode line. Select the buffer properly for that. */
16328 if (!update_mode_line
)
16330 update_mode_line
= true;
16331 w
->update_mode_line
= true;
16334 /* Try to scroll by specified few lines. */
16335 if ((scroll_conservatively
16336 || emacs_scroll_step
16337 || temp_scroll_step
16338 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16339 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16340 && CHARPOS (startp
) >= BEGV
16341 && CHARPOS (startp
) <= ZV
)
16343 /* The function returns -1 if new fonts were loaded, 1 if
16344 successful, 0 if not successful. */
16345 int ss
= try_scrolling (window
, just_this_one_p
,
16346 scroll_conservatively
,
16348 temp_scroll_step
, last_line_misfit
);
16351 case SCROLLING_SUCCESS
:
16354 case SCROLLING_NEED_LARGER_MATRICES
:
16355 goto need_larger_matrices
;
16357 case SCROLLING_FAILED
:
16365 /* Finally, just choose a place to start which positions point
16366 according to user preferences. */
16371 debug_method_add (w
, "recenter");
16374 /* Forget any previously recorded base line for line number display. */
16375 if (!buffer_unchanged_p
)
16376 w
->base_line_number
= 0;
16378 /* Determine the window start relative to point. */
16379 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16380 it
.current_y
= it
.last_visible_y
;
16381 if (centering_position
< 0)
16383 int window_total_lines
16384 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16386 = scroll_margin
> 0
16387 ? min (scroll_margin
, window_total_lines
/ 4)
16389 ptrdiff_t margin_pos
= CHARPOS (startp
);
16390 Lisp_Object aggressive
;
16393 /* If there is a scroll margin at the top of the window, find
16394 its character position. */
16396 /* Cannot call start_display if startp is not in the
16397 accessible region of the buffer. This can happen when we
16398 have just switched to a different buffer and/or changed
16399 its restriction. In that case, startp is initialized to
16400 the character position 1 (BEGV) because we did not yet
16401 have chance to display the buffer even once. */
16402 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16405 void *it1data
= NULL
;
16407 SAVE_IT (it1
, it
, it1data
);
16408 start_display (&it1
, w
, startp
);
16409 move_it_vertically (&it1
, margin
* frame_line_height
);
16410 margin_pos
= IT_CHARPOS (it1
);
16411 RESTORE_IT (&it
, &it
, it1data
);
16413 scrolling_up
= PT
> margin_pos
;
16416 ? BVAR (current_buffer
, scroll_up_aggressively
)
16417 : BVAR (current_buffer
, scroll_down_aggressively
);
16419 if (!MINI_WINDOW_P (w
)
16420 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16424 /* Setting scroll-conservatively overrides
16425 scroll-*-aggressively. */
16426 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16428 double float_amount
= XFLOATINT (aggressive
);
16430 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16431 if (pt_offset
== 0 && float_amount
> 0)
16433 if (pt_offset
&& margin
> 0)
16436 /* Compute how much to move the window start backward from
16437 point so that point will be displayed where the user
16441 centering_position
= it
.last_visible_y
;
16443 centering_position
-= pt_offset
;
16444 centering_position
-=
16445 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16446 + WINDOW_HEADER_LINE_HEIGHT (w
));
16447 /* Don't let point enter the scroll margin near top of
16449 if (centering_position
< margin
* frame_line_height
)
16450 centering_position
= margin
* frame_line_height
;
16453 centering_position
= margin
* frame_line_height
+ pt_offset
;
16456 /* Set the window start half the height of the window backward
16458 centering_position
= window_box_height (w
) / 2;
16460 move_it_vertically_backward (&it
, centering_position
);
16462 eassert (IT_CHARPOS (it
) >= BEGV
);
16464 /* The function move_it_vertically_backward may move over more
16465 than the specified y-distance. If it->w is small, e.g. a
16466 mini-buffer window, we may end up in front of the window's
16467 display area. Start displaying at the start of the line
16468 containing PT in this case. */
16469 if (it
.current_y
<= 0)
16471 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16472 move_it_vertically_backward (&it
, 0);
16476 it
.current_x
= it
.hpos
= 0;
16478 /* Set the window start position here explicitly, to avoid an
16479 infinite loop in case the functions in window-scroll-functions
16481 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16483 /* Run scroll hooks. */
16484 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16486 /* Redisplay the window. */
16487 if (!current_matrix_up_to_date_p
16488 || windows_or_buffers_changed
16489 || f
->cursor_type_changed
16490 /* Don't use try_window_reusing_current_matrix in this case
16491 because it can have changed the buffer. */
16492 || !NILP (Vwindow_scroll_functions
)
16493 || !just_this_one_p
16494 || MINI_WINDOW_P (w
)
16495 || !(used_current_matrix_p
16496 = try_window_reusing_current_matrix (w
)))
16497 try_window (window
, startp
, 0);
16499 /* If new fonts have been loaded (due to fontsets), give up. We
16500 have to start a new redisplay since we need to re-adjust glyph
16502 if (f
->fonts_changed
)
16503 goto need_larger_matrices
;
16505 /* If cursor did not appear assume that the middle of the window is
16506 in the first line of the window. Do it again with the next line.
16507 (Imagine a window of height 100, displaying two lines of height
16508 60. Moving back 50 from it->last_visible_y will end in the first
16510 if (w
->cursor
.vpos
< 0)
16512 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16514 clear_glyph_matrix (w
->desired_matrix
);
16515 move_it_by_lines (&it
, 1);
16516 try_window (window
, it
.current
.pos
, 0);
16518 else if (PT
< IT_CHARPOS (it
))
16520 clear_glyph_matrix (w
->desired_matrix
);
16521 move_it_by_lines (&it
, -1);
16522 try_window (window
, it
.current
.pos
, 0);
16526 /* Not much we can do about it. */
16530 /* Consider the following case: Window starts at BEGV, there is
16531 invisible, intangible text at BEGV, so that display starts at
16532 some point START > BEGV. It can happen that we are called with
16533 PT somewhere between BEGV and START. Try to handle that case,
16534 and similar ones. */
16535 if (w
->cursor
.vpos
< 0)
16537 /* First, try locating the proper glyph row for PT. */
16538 struct glyph_row
*row
=
16539 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16541 /* Sometimes point is at the beginning of invisible text that is
16542 before the 1st character displayed in the row. In that case,
16543 row_containing_pos fails to find the row, because no glyphs
16544 with appropriate buffer positions are present in the row.
16545 Therefore, we next try to find the row which shows the 1st
16546 position after the invisible text. */
16550 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16553 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16556 Lisp_Object invis_end
=
16557 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16560 if (NATNUMP (invis_end
))
16561 alt_pos
= XFASTINT (invis_end
);
16564 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16568 /* Finally, fall back on the first row of the window after the
16569 header line (if any). This is slightly better than not
16570 displaying the cursor at all. */
16573 row
= w
->current_matrix
->rows
;
16574 if (row
->mode_line_p
)
16577 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16580 if (!cursor_row_fully_visible_p (w
, false, false))
16582 /* If vscroll is enabled, disable it and try again. */
16586 clear_glyph_matrix (w
->desired_matrix
);
16590 /* Users who set scroll-conservatively to a large number want
16591 point just above/below the scroll margin. If we ended up
16592 with point's row partially visible, move the window start to
16593 make that row fully visible and out of the margin. */
16594 if (scroll_conservatively
> SCROLL_LIMIT
)
16596 int window_total_lines
16597 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16600 ? min (scroll_margin
, window_total_lines
/ 4)
16602 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16604 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16605 clear_glyph_matrix (w
->desired_matrix
);
16606 if (1 == try_window (window
, it
.current
.pos
,
16607 TRY_WINDOW_CHECK_MARGINS
))
16611 /* If centering point failed to make the whole line visible,
16612 put point at the top instead. That has to make the whole line
16613 visible, if it can be done. */
16614 if (centering_position
== 0)
16617 clear_glyph_matrix (w
->desired_matrix
);
16618 centering_position
= 0;
16624 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16625 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16626 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16628 /* Display the mode line, if we must. */
16629 if ((update_mode_line
16630 /* If window not full width, must redo its mode line
16631 if (a) the window to its side is being redone and
16632 (b) we do a frame-based redisplay. This is a consequence
16633 of how inverted lines are drawn in frame-based redisplay. */
16634 || (!just_this_one_p
16635 && !FRAME_WINDOW_P (f
)
16636 && !WINDOW_FULL_WIDTH_P (w
))
16637 /* Line number to display. */
16638 || w
->base_line_pos
> 0
16639 /* Column number is displayed and different from the one displayed. */
16640 || (w
->column_number_displayed
!= -1
16641 && (w
->column_number_displayed
!= current_column ())))
16642 /* This means that the window has a mode line. */
16643 && (WINDOW_WANTS_MODELINE_P (w
)
16644 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16647 display_mode_lines (w
);
16649 /* If mode line height has changed, arrange for a thorough
16650 immediate redisplay using the correct mode line height. */
16651 if (WINDOW_WANTS_MODELINE_P (w
)
16652 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16654 f
->fonts_changed
= true;
16655 w
->mode_line_height
= -1;
16656 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16657 = DESIRED_MODE_LINE_HEIGHT (w
);
16660 /* If header line height has changed, arrange for a thorough
16661 immediate redisplay using the correct header line height. */
16662 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16663 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16665 f
->fonts_changed
= true;
16666 w
->header_line_height
= -1;
16667 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16668 = DESIRED_HEADER_LINE_HEIGHT (w
);
16671 if (f
->fonts_changed
)
16672 goto need_larger_matrices
;
16675 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16677 w
->base_line_pos
= 0;
16678 w
->base_line_number
= 0;
16683 /* When we reach a frame's selected window, redo the frame's menu bar. */
16684 if (update_mode_line
16685 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16687 bool redisplay_menu_p
;
16689 if (FRAME_WINDOW_P (f
))
16691 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16692 || defined (HAVE_NS) || defined (USE_GTK)
16693 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16695 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16699 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16701 if (redisplay_menu_p
)
16702 display_menu_bar (w
);
16704 #ifdef HAVE_WINDOW_SYSTEM
16705 if (FRAME_WINDOW_P (f
))
16707 #if defined (USE_GTK) || defined (HAVE_NS)
16708 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16709 redisplay_tool_bar (f
);
16711 if (WINDOWP (f
->tool_bar_window
)
16712 && (FRAME_TOOL_BAR_LINES (f
) > 0
16713 || !NILP (Vauto_resize_tool_bars
))
16714 && redisplay_tool_bar (f
))
16715 ignore_mouse_drag_p
= true;
16721 #ifdef HAVE_WINDOW_SYSTEM
16722 if (FRAME_WINDOW_P (f
)
16723 && update_window_fringes (w
, (just_this_one_p
16724 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16725 || w
->pseudo_window_p
)))
16729 if (draw_window_fringes (w
, true))
16731 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16732 x_draw_right_divider (w
);
16734 x_draw_vertical_border (w
);
16740 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16741 x_draw_bottom_divider (w
);
16742 #endif /* HAVE_WINDOW_SYSTEM */
16744 /* We go to this label, with fonts_changed set, if it is
16745 necessary to try again using larger glyph matrices.
16746 We have to redeem the scroll bar even in this case,
16747 because the loop in redisplay_internal expects that. */
16748 need_larger_matrices
:
16750 finish_scroll_bars
:
16752 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16754 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16755 /* Set the thumb's position and size. */
16756 set_vertical_scroll_bar (w
);
16758 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16759 /* Set the thumb's position and size. */
16760 set_horizontal_scroll_bar (w
);
16762 /* Note that we actually used the scroll bar attached to this
16763 window, so it shouldn't be deleted at the end of redisplay. */
16764 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16765 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16768 /* Restore current_buffer and value of point in it. The window
16769 update may have changed the buffer, so first make sure `opoint'
16770 is still valid (Bug#6177). */
16771 if (CHARPOS (opoint
) < BEGV
)
16772 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16773 else if (CHARPOS (opoint
) > ZV
)
16774 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16776 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16778 set_buffer_internal_1 (old
);
16779 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16780 shorter. This can be caused by log truncation in *Messages*. */
16781 if (CHARPOS (lpoint
) <= ZV
)
16782 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16784 unbind_to (count
, Qnil
);
16788 /* Build the complete desired matrix of WINDOW with a window start
16789 buffer position POS.
16791 Value is 1 if successful. It is zero if fonts were loaded during
16792 redisplay which makes re-adjusting glyph matrices necessary, and -1
16793 if point would appear in the scroll margins.
16794 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16795 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16799 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16801 struct window
*w
= XWINDOW (window
);
16803 struct glyph_row
*last_text_row
= NULL
;
16804 struct frame
*f
= XFRAME (w
->frame
);
16805 int frame_line_height
= default_line_pixel_height (w
);
16807 /* Make POS the new window start. */
16808 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16810 /* Mark cursor position as unknown. No overlay arrow seen. */
16811 w
->cursor
.vpos
= -1;
16812 overlay_arrow_seen
= false;
16814 /* Initialize iterator and info to start at POS. */
16815 start_display (&it
, w
, pos
);
16816 it
.glyph_row
->reversed_p
= false;
16818 /* Display all lines of W. */
16819 while (it
.current_y
< it
.last_visible_y
)
16821 if (display_line (&it
))
16822 last_text_row
= it
.glyph_row
- 1;
16823 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16827 /* Don't let the cursor end in the scroll margins. */
16828 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16829 && !MINI_WINDOW_P (w
))
16831 int this_scroll_margin
;
16832 int window_total_lines
16833 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16835 if (scroll_margin
> 0)
16837 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16838 this_scroll_margin
*= frame_line_height
;
16841 this_scroll_margin
= 0;
16843 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16844 && w
->cursor
.y
< this_scroll_margin
16845 && CHARPOS (pos
) > BEGV
16846 && IT_CHARPOS (it
) < ZV
)
16847 /* rms: considering make_cursor_line_fully_visible_p here
16848 seems to give wrong results. We don't want to recenter
16849 when the last line is partly visible, we want to allow
16850 that case to be handled in the usual way. */
16851 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16853 w
->cursor
.vpos
= -1;
16854 clear_glyph_matrix (w
->desired_matrix
);
16859 /* If bottom moved off end of frame, change mode line percentage. */
16860 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16861 w
->update_mode_line
= true;
16863 /* Set window_end_pos to the offset of the last character displayed
16864 on the window from the end of current_buffer. Set
16865 window_end_vpos to its row number. */
16868 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16869 adjust_window_ends (w
, last_text_row
, false);
16871 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16872 w
->window_end_vpos
)));
16876 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16877 w
->window_end_pos
= Z
- ZV
;
16878 w
->window_end_vpos
= 0;
16881 /* But that is not valid info until redisplay finishes. */
16882 w
->window_end_valid
= false;
16888 /************************************************************************
16889 Window redisplay reusing current matrix when buffer has not changed
16890 ************************************************************************/
16892 /* Try redisplay of window W showing an unchanged buffer with a
16893 different window start than the last time it was displayed by
16894 reusing its current matrix. Value is true if successful.
16895 W->start is the new window start. */
16898 try_window_reusing_current_matrix (struct window
*w
)
16900 struct frame
*f
= XFRAME (w
->frame
);
16901 struct glyph_row
*bottom_row
;
16904 struct text_pos start
, new_start
;
16905 int nrows_scrolled
, i
;
16906 struct glyph_row
*last_text_row
;
16907 struct glyph_row
*last_reused_text_row
;
16908 struct glyph_row
*start_row
;
16909 int start_vpos
, min_y
, max_y
;
16912 if (inhibit_try_window_reusing
)
16916 if (/* This function doesn't handle terminal frames. */
16917 !FRAME_WINDOW_P (f
)
16918 /* Don't try to reuse the display if windows have been split
16920 || windows_or_buffers_changed
16921 || f
->cursor_type_changed
)
16924 /* Can't do this if showing trailing whitespace. */
16925 if (!NILP (Vshow_trailing_whitespace
))
16928 /* If top-line visibility has changed, give up. */
16929 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16930 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16933 /* Give up if old or new display is scrolled vertically. We could
16934 make this function handle this, but right now it doesn't. */
16935 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16936 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16939 /* The variable new_start now holds the new window start. The old
16940 start `start' can be determined from the current matrix. */
16941 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16942 start
= start_row
->minpos
;
16943 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16945 /* Clear the desired matrix for the display below. */
16946 clear_glyph_matrix (w
->desired_matrix
);
16948 if (CHARPOS (new_start
) <= CHARPOS (start
))
16950 /* Don't use this method if the display starts with an ellipsis
16951 displayed for invisible text. It's not easy to handle that case
16952 below, and it's certainly not worth the effort since this is
16953 not a frequent case. */
16954 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16957 IF_DEBUG (debug_method_add (w
, "twu1"));
16959 /* Display up to a row that can be reused. The variable
16960 last_text_row is set to the last row displayed that displays
16961 text. Note that it.vpos == 0 if or if not there is a
16962 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16963 start_display (&it
, w
, new_start
);
16964 w
->cursor
.vpos
= -1;
16965 last_text_row
= last_reused_text_row
= NULL
;
16967 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16969 /* If we have reached into the characters in the START row,
16970 that means the line boundaries have changed. So we
16971 can't start copying with the row START. Maybe it will
16972 work to start copying with the following row. */
16973 while (IT_CHARPOS (it
) > CHARPOS (start
))
16975 /* Advance to the next row as the "start". */
16977 start
= start_row
->minpos
;
16978 /* If there are no more rows to try, or just one, give up. */
16979 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16980 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16981 || CHARPOS (start
) == ZV
)
16983 clear_glyph_matrix (w
->desired_matrix
);
16987 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16989 /* If we have reached alignment, we can copy the rest of the
16991 if (IT_CHARPOS (it
) == CHARPOS (start
)
16992 /* Don't accept "alignment" inside a display vector,
16993 since start_row could have started in the middle of
16994 that same display vector (thus their character
16995 positions match), and we have no way of telling if
16996 that is the case. */
16997 && it
.current
.dpvec_index
< 0)
17000 it
.glyph_row
->reversed_p
= false;
17001 if (display_line (&it
))
17002 last_text_row
= it
.glyph_row
- 1;
17006 /* A value of current_y < last_visible_y means that we stopped
17007 at the previous window start, which in turn means that we
17008 have at least one reusable row. */
17009 if (it
.current_y
< it
.last_visible_y
)
17011 struct glyph_row
*row
;
17013 /* IT.vpos always starts from 0; it counts text lines. */
17014 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17016 /* Find PT if not already found in the lines displayed. */
17017 if (w
->cursor
.vpos
< 0)
17019 int dy
= it
.current_y
- start_row
->y
;
17021 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17022 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17024 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17025 dy
, nrows_scrolled
);
17028 clear_glyph_matrix (w
->desired_matrix
);
17033 /* Scroll the display. Do it before the current matrix is
17034 changed. The problem here is that update has not yet
17035 run, i.e. part of the current matrix is not up to date.
17036 scroll_run_hook will clear the cursor, and use the
17037 current matrix to get the height of the row the cursor is
17039 run
.current_y
= start_row
->y
;
17040 run
.desired_y
= it
.current_y
;
17041 run
.height
= it
.last_visible_y
- it
.current_y
;
17043 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17046 FRAME_RIF (f
)->update_window_begin_hook (w
);
17047 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17048 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17049 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17053 /* Shift current matrix down by nrows_scrolled lines. */
17054 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17055 rotate_matrix (w
->current_matrix
,
17057 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17060 /* Disable lines that must be updated. */
17061 for (i
= 0; i
< nrows_scrolled
; ++i
)
17062 (start_row
+ i
)->enabled_p
= false;
17064 /* Re-compute Y positions. */
17065 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17066 max_y
= it
.last_visible_y
;
17067 for (row
= start_row
+ nrows_scrolled
;
17071 row
->y
= it
.current_y
;
17072 row
->visible_height
= row
->height
;
17074 if (row
->y
< min_y
)
17075 row
->visible_height
-= min_y
- row
->y
;
17076 if (row
->y
+ row
->height
> max_y
)
17077 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17078 if (row
->fringe_bitmap_periodic_p
)
17079 row
->redraw_fringe_bitmaps_p
= true;
17081 it
.current_y
+= row
->height
;
17083 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17084 last_reused_text_row
= row
;
17085 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17089 /* Disable lines in the current matrix which are now
17090 below the window. */
17091 for (++row
; row
< bottom_row
; ++row
)
17092 row
->enabled_p
= row
->mode_line_p
= false;
17095 /* Update window_end_pos etc.; last_reused_text_row is the last
17096 reused row from the current matrix containing text, if any.
17097 The value of last_text_row is the last displayed line
17098 containing text. */
17099 if (last_reused_text_row
)
17100 adjust_window_ends (w
, last_reused_text_row
, true);
17101 else if (last_text_row
)
17102 adjust_window_ends (w
, last_text_row
, false);
17105 /* This window must be completely empty. */
17106 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17107 w
->window_end_pos
= Z
- ZV
;
17108 w
->window_end_vpos
= 0;
17110 w
->window_end_valid
= false;
17112 /* Update hint: don't try scrolling again in update_window. */
17113 w
->desired_matrix
->no_scrolling_p
= true;
17116 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17120 else if (CHARPOS (new_start
) > CHARPOS (start
))
17122 struct glyph_row
*pt_row
, *row
;
17123 struct glyph_row
*first_reusable_row
;
17124 struct glyph_row
*first_row_to_display
;
17126 int yb
= window_text_bottom_y (w
);
17128 /* Find the row starting at new_start, if there is one. Don't
17129 reuse a partially visible line at the end. */
17130 first_reusable_row
= start_row
;
17131 while (first_reusable_row
->enabled_p
17132 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17133 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17134 < CHARPOS (new_start
)))
17135 ++first_reusable_row
;
17137 /* Give up if there is no row to reuse. */
17138 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17139 || !first_reusable_row
->enabled_p
17140 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17141 != CHARPOS (new_start
)))
17144 /* We can reuse fully visible rows beginning with
17145 first_reusable_row to the end of the window. Set
17146 first_row_to_display to the first row that cannot be reused.
17147 Set pt_row to the row containing point, if there is any. */
17149 for (first_row_to_display
= first_reusable_row
;
17150 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17151 ++first_row_to_display
)
17153 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17154 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17155 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17156 && first_row_to_display
->ends_at_zv_p
17157 && pt_row
== NULL
)))
17158 pt_row
= first_row_to_display
;
17161 /* Start displaying at the start of first_row_to_display. */
17162 eassert (first_row_to_display
->y
< yb
);
17163 init_to_row_start (&it
, w
, first_row_to_display
);
17165 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17167 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17169 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17170 + WINDOW_HEADER_LINE_HEIGHT (w
));
17172 /* Display lines beginning with first_row_to_display in the
17173 desired matrix. Set last_text_row to the last row displayed
17174 that displays text. */
17175 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17176 if (pt_row
== NULL
)
17177 w
->cursor
.vpos
= -1;
17178 last_text_row
= NULL
;
17179 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17180 if (display_line (&it
))
17181 last_text_row
= it
.glyph_row
- 1;
17183 /* If point is in a reused row, adjust y and vpos of the cursor
17187 w
->cursor
.vpos
-= nrows_scrolled
;
17188 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17191 /* Give up if point isn't in a row displayed or reused. (This
17192 also handles the case where w->cursor.vpos < nrows_scrolled
17193 after the calls to display_line, which can happen with scroll
17194 margins. See bug#1295.) */
17195 if (w
->cursor
.vpos
< 0)
17197 clear_glyph_matrix (w
->desired_matrix
);
17201 /* Scroll the display. */
17202 run
.current_y
= first_reusable_row
->y
;
17203 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17204 run
.height
= it
.last_visible_y
- run
.current_y
;
17205 dy
= run
.current_y
- run
.desired_y
;
17210 FRAME_RIF (f
)->update_window_begin_hook (w
);
17211 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17212 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17213 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17217 /* Adjust Y positions of reused rows. */
17218 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17219 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17220 max_y
= it
.last_visible_y
;
17221 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17224 row
->visible_height
= row
->height
;
17225 if (row
->y
< min_y
)
17226 row
->visible_height
-= min_y
- row
->y
;
17227 if (row
->y
+ row
->height
> max_y
)
17228 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17229 if (row
->fringe_bitmap_periodic_p
)
17230 row
->redraw_fringe_bitmaps_p
= true;
17233 /* Scroll the current matrix. */
17234 eassert (nrows_scrolled
> 0);
17235 rotate_matrix (w
->current_matrix
,
17237 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17240 /* Disable rows not reused. */
17241 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17242 row
->enabled_p
= false;
17244 /* Point may have moved to a different line, so we cannot assume that
17245 the previous cursor position is valid; locate the correct row. */
17248 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17250 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17251 && !row
->ends_at_zv_p
;
17255 w
->cursor
.y
= row
->y
;
17257 if (row
< bottom_row
)
17259 /* Can't simply scan the row for point with
17260 bidi-reordered glyph rows. Let set_cursor_from_row
17261 figure out where to put the cursor, and if it fails,
17263 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17265 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17268 clear_glyph_matrix (w
->desired_matrix
);
17274 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17275 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17278 && (!BUFFERP (glyph
->object
)
17279 || glyph
->charpos
< PT
);
17283 w
->cursor
.x
+= glyph
->pixel_width
;
17289 /* Adjust window end. A null value of last_text_row means that
17290 the window end is in reused rows which in turn means that
17291 only its vpos can have changed. */
17293 adjust_window_ends (w
, last_text_row
, false);
17295 w
->window_end_vpos
-= nrows_scrolled
;
17297 w
->window_end_valid
= false;
17298 w
->desired_matrix
->no_scrolling_p
= true;
17301 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17311 /************************************************************************
17312 Window redisplay reusing current matrix when buffer has changed
17313 ************************************************************************/
17315 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17316 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17317 ptrdiff_t *, ptrdiff_t *);
17318 static struct glyph_row
*
17319 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17320 struct glyph_row
*);
17323 /* Return the last row in MATRIX displaying text. If row START is
17324 non-null, start searching with that row. IT gives the dimensions
17325 of the display. Value is null if matrix is empty; otherwise it is
17326 a pointer to the row found. */
17328 static struct glyph_row
*
17329 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17330 struct glyph_row
*start
)
17332 struct glyph_row
*row
, *row_found
;
17334 /* Set row_found to the last row in IT->w's current matrix
17335 displaying text. The loop looks funny but think of partially
17338 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17339 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17341 eassert (row
->enabled_p
);
17343 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17352 /* Return the last row in the current matrix of W that is not affected
17353 by changes at the start of current_buffer that occurred since W's
17354 current matrix was built. Value is null if no such row exists.
17356 BEG_UNCHANGED us the number of characters unchanged at the start of
17357 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17358 first changed character in current_buffer. Characters at positions <
17359 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17360 when the current matrix was built. */
17362 static struct glyph_row
*
17363 find_last_unchanged_at_beg_row (struct window
*w
)
17365 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17366 struct glyph_row
*row
;
17367 struct glyph_row
*row_found
= NULL
;
17368 int yb
= window_text_bottom_y (w
);
17370 /* Find the last row displaying unchanged text. */
17371 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17372 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17373 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17376 if (/* If row ends before first_changed_pos, it is unchanged,
17377 except in some case. */
17378 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17379 /* When row ends in ZV and we write at ZV it is not
17381 && !row
->ends_at_zv_p
17382 /* When first_changed_pos is the end of a continued line,
17383 row is not unchanged because it may be no longer
17385 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17386 && (row
->continued_p
17387 || row
->exact_window_width_line_p
))
17388 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17389 needs to be recomputed, so don't consider this row as
17390 unchanged. This happens when the last line was
17391 bidi-reordered and was killed immediately before this
17392 redisplay cycle. In that case, ROW->end stores the
17393 buffer position of the first visual-order character of
17394 the killed text, which is now beyond ZV. */
17395 && CHARPOS (row
->end
.pos
) <= ZV
)
17398 /* Stop if last visible row. */
17399 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17407 /* Find the first glyph row in the current matrix of W that is not
17408 affected by changes at the end of current_buffer since the
17409 time W's current matrix was built.
17411 Return in *DELTA the number of chars by which buffer positions in
17412 unchanged text at the end of current_buffer must be adjusted.
17414 Return in *DELTA_BYTES the corresponding number of bytes.
17416 Value is null if no such row exists, i.e. all rows are affected by
17419 static struct glyph_row
*
17420 find_first_unchanged_at_end_row (struct window
*w
,
17421 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17423 struct glyph_row
*row
;
17424 struct glyph_row
*row_found
= NULL
;
17426 *delta
= *delta_bytes
= 0;
17428 /* Display must not have been paused, otherwise the current matrix
17429 is not up to date. */
17430 eassert (w
->window_end_valid
);
17432 /* A value of window_end_pos >= END_UNCHANGED means that the window
17433 end is in the range of changed text. If so, there is no
17434 unchanged row at the end of W's current matrix. */
17435 if (w
->window_end_pos
>= END_UNCHANGED
)
17438 /* Set row to the last row in W's current matrix displaying text. */
17439 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17441 /* If matrix is entirely empty, no unchanged row exists. */
17442 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17444 /* The value of row is the last glyph row in the matrix having a
17445 meaningful buffer position in it. The end position of row
17446 corresponds to window_end_pos. This allows us to translate
17447 buffer positions in the current matrix to current buffer
17448 positions for characters not in changed text. */
17450 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17451 ptrdiff_t Z_BYTE_old
=
17452 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17453 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17454 struct glyph_row
*first_text_row
17455 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17457 *delta
= Z
- Z_old
;
17458 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17460 /* Set last_unchanged_pos to the buffer position of the last
17461 character in the buffer that has not been changed. Z is the
17462 index + 1 of the last character in current_buffer, i.e. by
17463 subtracting END_UNCHANGED we get the index of the last
17464 unchanged character, and we have to add BEG to get its buffer
17466 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17467 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17469 /* Search backward from ROW for a row displaying a line that
17470 starts at a minimum position >= last_unchanged_pos_old. */
17471 for (; row
> first_text_row
; --row
)
17473 /* This used to abort, but it can happen.
17474 It is ok to just stop the search instead here. KFS. */
17475 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17478 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17483 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17489 /* Make sure that glyph rows in the current matrix of window W
17490 reference the same glyph memory as corresponding rows in the
17491 frame's frame matrix. This function is called after scrolling W's
17492 current matrix on a terminal frame in try_window_id and
17493 try_window_reusing_current_matrix. */
17496 sync_frame_with_window_matrix_rows (struct window
*w
)
17498 struct frame
*f
= XFRAME (w
->frame
);
17499 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17501 /* Preconditions: W must be a leaf window and full-width. Its frame
17502 must have a frame matrix. */
17503 eassert (BUFFERP (w
->contents
));
17504 eassert (WINDOW_FULL_WIDTH_P (w
));
17505 eassert (!FRAME_WINDOW_P (f
));
17507 /* If W is a full-width window, glyph pointers in W's current matrix
17508 have, by definition, to be the same as glyph pointers in the
17509 corresponding frame matrix. Note that frame matrices have no
17510 marginal areas (see build_frame_matrix). */
17511 window_row
= w
->current_matrix
->rows
;
17512 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17513 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17514 while (window_row
< window_row_end
)
17516 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17517 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17519 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17520 frame_row
->glyphs
[TEXT_AREA
] = start
;
17521 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17522 frame_row
->glyphs
[LAST_AREA
] = end
;
17524 /* Disable frame rows whose corresponding window rows have
17525 been disabled in try_window_id. */
17526 if (!window_row
->enabled_p
)
17527 frame_row
->enabled_p
= false;
17529 ++window_row
, ++frame_row
;
17534 /* Find the glyph row in window W containing CHARPOS. Consider all
17535 rows between START and END (not inclusive). END null means search
17536 all rows to the end of the display area of W. Value is the row
17537 containing CHARPOS or null. */
17540 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17541 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17543 struct glyph_row
*row
= start
;
17544 struct glyph_row
*best_row
= NULL
;
17545 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17548 /* If we happen to start on a header-line, skip that. */
17549 if (row
->mode_line_p
)
17552 if ((end
&& row
>= end
) || !row
->enabled_p
)
17555 last_y
= window_text_bottom_y (w
) - dy
;
17559 /* Give up if we have gone too far. */
17560 if (end
&& row
>= end
)
17562 /* This formerly returned if they were equal.
17563 I think that both quantities are of a "last plus one" type;
17564 if so, when they are equal, the row is within the screen. -- rms. */
17565 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17568 /* If it is in this row, return this row. */
17569 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17570 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17571 /* The end position of a row equals the start
17572 position of the next row. If CHARPOS is there, we
17573 would rather consider it displayed in the next
17574 line, except when this line ends in ZV. */
17575 && !row_for_charpos_p (row
, charpos
)))
17576 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17580 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17581 || (!best_row
&& !row
->continued_p
))
17583 /* In bidi-reordered rows, there could be several rows whose
17584 edges surround CHARPOS, all of these rows belonging to
17585 the same continued line. We need to find the row which
17586 fits CHARPOS the best. */
17587 for (g
= row
->glyphs
[TEXT_AREA
];
17588 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17591 if (!STRINGP (g
->object
))
17593 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17595 mindif
= eabs (g
->charpos
- charpos
);
17597 /* Exact match always wins. */
17604 else if (best_row
&& !row
->continued_p
)
17611 /* Try to redisplay window W by reusing its existing display. W's
17612 current matrix must be up to date when this function is called,
17613 i.e., window_end_valid must be true.
17617 >= 1 if successful, i.e. display has been updated
17619 1 means the changes were in front of a newline that precedes
17620 the window start, and the whole current matrix was reused
17621 2 means the changes were after the last position displayed
17622 in the window, and the whole current matrix was reused
17623 3 means portions of the current matrix were reused, while
17624 some of the screen lines were redrawn
17625 -1 if redisplay with same window start is known not to succeed
17626 0 if otherwise unsuccessful
17628 The following steps are performed:
17630 1. Find the last row in the current matrix of W that is not
17631 affected by changes at the start of current_buffer. If no such row
17634 2. Find the first row in W's current matrix that is not affected by
17635 changes at the end of current_buffer. Maybe there is no such row.
17637 3. Display lines beginning with the row + 1 found in step 1 to the
17638 row found in step 2 or, if step 2 didn't find a row, to the end of
17641 4. If cursor is not known to appear on the window, give up.
17643 5. If display stopped at the row found in step 2, scroll the
17644 display and current matrix as needed.
17646 6. Maybe display some lines at the end of W, if we must. This can
17647 happen under various circumstances, like a partially visible line
17648 becoming fully visible, or because newly displayed lines are displayed
17649 in smaller font sizes.
17651 7. Update W's window end information. */
17654 try_window_id (struct window
*w
)
17656 struct frame
*f
= XFRAME (w
->frame
);
17657 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17658 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17659 struct glyph_row
*last_unchanged_at_beg_row
;
17660 struct glyph_row
*first_unchanged_at_end_row
;
17661 struct glyph_row
*row
;
17662 struct glyph_row
*bottom_row
;
17665 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17667 struct text_pos start_pos
;
17669 int first_unchanged_at_end_vpos
= 0;
17670 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17671 struct text_pos start
;
17672 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17675 if (inhibit_try_window_id
)
17679 /* This is handy for debugging. */
17681 #define GIVE_UP(X) \
17683 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17687 #define GIVE_UP(X) return 0
17690 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17692 /* Don't use this for mini-windows because these can show
17693 messages and mini-buffers, and we don't handle that here. */
17694 if (MINI_WINDOW_P (w
))
17697 /* This flag is used to prevent redisplay optimizations. */
17698 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17701 /* This function's optimizations cannot be used if overlays have
17702 changed in the buffer displayed by the window, so give up if they
17704 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17707 /* Verify that narrowing has not changed.
17708 Also verify that we were not told to prevent redisplay optimizations.
17709 It would be nice to further
17710 reduce the number of cases where this prevents try_window_id. */
17711 if (current_buffer
->clip_changed
17712 || current_buffer
->prevent_redisplay_optimizations_p
)
17715 /* Window must either use window-based redisplay or be full width. */
17716 if (!FRAME_WINDOW_P (f
)
17717 && (!FRAME_LINE_INS_DEL_OK (f
)
17718 || !WINDOW_FULL_WIDTH_P (w
)))
17721 /* Give up if point is known NOT to appear in W. */
17722 if (PT
< CHARPOS (start
))
17725 /* Another way to prevent redisplay optimizations. */
17726 if (w
->last_modified
== 0)
17729 /* Verify that window is not hscrolled. */
17730 if (w
->hscroll
!= 0)
17733 /* Verify that display wasn't paused. */
17734 if (!w
->window_end_valid
)
17737 /* Likewise if highlighting trailing whitespace. */
17738 if (!NILP (Vshow_trailing_whitespace
))
17741 /* Can't use this if overlay arrow position and/or string have
17743 if (overlay_arrows_changed_p ())
17746 /* When word-wrap is on, adding a space to the first word of a
17747 wrapped line can change the wrap position, altering the line
17748 above it. It might be worthwhile to handle this more
17749 intelligently, but for now just redisplay from scratch. */
17750 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17753 /* Under bidi reordering, adding or deleting a character in the
17754 beginning of a paragraph, before the first strong directional
17755 character, can change the base direction of the paragraph (unless
17756 the buffer specifies a fixed paragraph direction), which will
17757 require to redisplay the whole paragraph. It might be worthwhile
17758 to find the paragraph limits and widen the range of redisplayed
17759 lines to that, but for now just give up this optimization and
17760 redisplay from scratch. */
17761 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17762 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17765 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17766 only if buffer has really changed. The reason is that the gap is
17767 initially at Z for freshly visited files. The code below would
17768 set end_unchanged to 0 in that case. */
17769 if (MODIFF
> SAVE_MODIFF
17770 /* This seems to happen sometimes after saving a buffer. */
17771 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17773 if (GPT
- BEG
< BEG_UNCHANGED
)
17774 BEG_UNCHANGED
= GPT
- BEG
;
17775 if (Z
- GPT
< END_UNCHANGED
)
17776 END_UNCHANGED
= Z
- GPT
;
17779 /* The position of the first and last character that has been changed. */
17780 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17781 last_changed_charpos
= Z
- END_UNCHANGED
;
17783 /* If window starts after a line end, and the last change is in
17784 front of that newline, then changes don't affect the display.
17785 This case happens with stealth-fontification. Note that although
17786 the display is unchanged, glyph positions in the matrix have to
17787 be adjusted, of course. */
17788 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17789 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17790 && ((last_changed_charpos
< CHARPOS (start
)
17791 && CHARPOS (start
) == BEGV
)
17792 || (last_changed_charpos
< CHARPOS (start
) - 1
17793 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17795 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17796 struct glyph_row
*r0
;
17798 /* Compute how many chars/bytes have been added to or removed
17799 from the buffer. */
17800 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17801 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17802 Z_delta
= Z
- Z_old
;
17803 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17805 /* Give up if PT is not in the window. Note that it already has
17806 been checked at the start of try_window_id that PT is not in
17807 front of the window start. */
17808 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17811 /* If window start is unchanged, we can reuse the whole matrix
17812 as is, after adjusting glyph positions. No need to compute
17813 the window end again, since its offset from Z hasn't changed. */
17814 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17815 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17816 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17817 /* PT must not be in a partially visible line. */
17818 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17819 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17821 /* Adjust positions in the glyph matrix. */
17822 if (Z_delta
|| Z_delta_bytes
)
17824 struct glyph_row
*r1
17825 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17826 increment_matrix_positions (w
->current_matrix
,
17827 MATRIX_ROW_VPOS (r0
, current_matrix
),
17828 MATRIX_ROW_VPOS (r1
, current_matrix
),
17829 Z_delta
, Z_delta_bytes
);
17832 /* Set the cursor. */
17833 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17835 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17840 /* Handle the case that changes are all below what is displayed in
17841 the window, and that PT is in the window. This shortcut cannot
17842 be taken if ZV is visible in the window, and text has been added
17843 there that is visible in the window. */
17844 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17845 /* ZV is not visible in the window, or there are no
17846 changes at ZV, actually. */
17847 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17848 || first_changed_charpos
== last_changed_charpos
))
17850 struct glyph_row
*r0
;
17852 /* Give up if PT is not in the window. Note that it already has
17853 been checked at the start of try_window_id that PT is not in
17854 front of the window start. */
17855 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17858 /* If window start is unchanged, we can reuse the whole matrix
17859 as is, without changing glyph positions since no text has
17860 been added/removed in front of the window end. */
17861 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17862 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17863 /* PT must not be in a partially visible line. */
17864 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17865 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17867 /* We have to compute the window end anew since text
17868 could have been added/removed after it. */
17869 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17870 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17872 /* Set the cursor. */
17873 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17875 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17880 /* Give up if window start is in the changed area.
17882 The condition used to read
17884 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17886 but why that was tested escapes me at the moment. */
17887 if (CHARPOS (start
) >= first_changed_charpos
17888 && CHARPOS (start
) <= last_changed_charpos
)
17891 /* Check that window start agrees with the start of the first glyph
17892 row in its current matrix. Check this after we know the window
17893 start is not in changed text, otherwise positions would not be
17895 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17896 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17899 /* Give up if the window ends in strings. Overlay strings
17900 at the end are difficult to handle, so don't try. */
17901 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17902 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17905 /* Compute the position at which we have to start displaying new
17906 lines. Some of the lines at the top of the window might be
17907 reusable because they are not displaying changed text. Find the
17908 last row in W's current matrix not affected by changes at the
17909 start of current_buffer. Value is null if changes start in the
17910 first line of window. */
17911 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17912 if (last_unchanged_at_beg_row
)
17914 /* Avoid starting to display in the middle of a character, a TAB
17915 for instance. This is easier than to set up the iterator
17916 exactly, and it's not a frequent case, so the additional
17917 effort wouldn't really pay off. */
17918 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17919 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17920 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17921 --last_unchanged_at_beg_row
;
17923 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17926 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
17928 start_pos
= it
.current
.pos
;
17930 /* Start displaying new lines in the desired matrix at the same
17931 vpos we would use in the current matrix, i.e. below
17932 last_unchanged_at_beg_row. */
17933 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17935 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17936 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17938 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17942 /* There are no reusable lines at the start of the window.
17943 Start displaying in the first text line. */
17944 start_display (&it
, w
, start
);
17945 it
.vpos
= it
.first_vpos
;
17946 start_pos
= it
.current
.pos
;
17949 /* Find the first row that is not affected by changes at the end of
17950 the buffer. Value will be null if there is no unchanged row, in
17951 which case we must redisplay to the end of the window. delta
17952 will be set to the value by which buffer positions beginning with
17953 first_unchanged_at_end_row have to be adjusted due to text
17955 first_unchanged_at_end_row
17956 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17957 IF_DEBUG (debug_delta
= delta
);
17958 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17960 /* Set stop_pos to the buffer position up to which we will have to
17961 display new lines. If first_unchanged_at_end_row != NULL, this
17962 is the buffer position of the start of the line displayed in that
17963 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17964 that we don't stop at a buffer position. */
17966 if (first_unchanged_at_end_row
)
17968 eassert (last_unchanged_at_beg_row
== NULL
17969 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17971 /* If this is a continuation line, move forward to the next one
17972 that isn't. Changes in lines above affect this line.
17973 Caution: this may move first_unchanged_at_end_row to a row
17974 not displaying text. */
17975 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17976 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17977 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17978 < it
.last_visible_y
))
17979 ++first_unchanged_at_end_row
;
17981 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17982 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17983 >= it
.last_visible_y
))
17984 first_unchanged_at_end_row
= NULL
;
17987 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17989 first_unchanged_at_end_vpos
17990 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17991 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17994 else if (last_unchanged_at_beg_row
== NULL
)
18000 /* Either there is no unchanged row at the end, or the one we have
18001 now displays text. This is a necessary condition for the window
18002 end pos calculation at the end of this function. */
18003 eassert (first_unchanged_at_end_row
== NULL
18004 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18006 debug_last_unchanged_at_beg_vpos
18007 = (last_unchanged_at_beg_row
18008 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18010 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18012 #endif /* GLYPH_DEBUG */
18015 /* Display new lines. Set last_text_row to the last new line
18016 displayed which has text on it, i.e. might end up as being the
18017 line where the window_end_vpos is. */
18018 w
->cursor
.vpos
= -1;
18019 last_text_row
= NULL
;
18020 overlay_arrow_seen
= false;
18021 if (it
.current_y
< it
.last_visible_y
18022 && !f
->fonts_changed
18023 && (first_unchanged_at_end_row
== NULL
18024 || IT_CHARPOS (it
) < stop_pos
))
18025 it
.glyph_row
->reversed_p
= false;
18026 while (it
.current_y
< it
.last_visible_y
18027 && !f
->fonts_changed
18028 && (first_unchanged_at_end_row
== NULL
18029 || IT_CHARPOS (it
) < stop_pos
))
18031 if (display_line (&it
))
18032 last_text_row
= it
.glyph_row
- 1;
18035 if (f
->fonts_changed
)
18038 /* The redisplay iterations in display_line above could have
18039 triggered font-lock, which could have done something that
18040 invalidates IT->w window's end-point information, on which we
18041 rely below. E.g., one package, which will remain unnamed, used
18042 to install a font-lock-fontify-region-function that called
18043 bury-buffer, whose side effect is to switch the buffer displayed
18044 by IT->w, and that predictably resets IT->w's window_end_valid
18045 flag, which we already tested at the entry to this function.
18046 Amply punish such packages/modes by giving up on this
18047 optimization in those cases. */
18048 if (!w
->window_end_valid
)
18050 clear_glyph_matrix (w
->desired_matrix
);
18054 /* Compute differences in buffer positions, y-positions etc. for
18055 lines reused at the bottom of the window. Compute what we can
18057 if (first_unchanged_at_end_row
18058 /* No lines reused because we displayed everything up to the
18059 bottom of the window. */
18060 && it
.current_y
< it
.last_visible_y
)
18063 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18065 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18066 run
.current_y
= first_unchanged_at_end_row
->y
;
18067 run
.desired_y
= run
.current_y
+ dy
;
18068 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18072 delta
= delta_bytes
= dvpos
= dy
18073 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18074 first_unchanged_at_end_row
= NULL
;
18076 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18079 /* Find the cursor if not already found. We have to decide whether
18080 PT will appear on this window (it sometimes doesn't, but this is
18081 not a very frequent case.) This decision has to be made before
18082 the current matrix is altered. A value of cursor.vpos < 0 means
18083 that PT is either in one of the lines beginning at
18084 first_unchanged_at_end_row or below the window. Don't care for
18085 lines that might be displayed later at the window end; as
18086 mentioned, this is not a frequent case. */
18087 if (w
->cursor
.vpos
< 0)
18089 /* Cursor in unchanged rows at the top? */
18090 if (PT
< CHARPOS (start_pos
)
18091 && last_unchanged_at_beg_row
)
18093 row
= row_containing_pos (w
, PT
,
18094 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18095 last_unchanged_at_beg_row
+ 1, 0);
18097 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18100 /* Start from first_unchanged_at_end_row looking for PT. */
18101 else if (first_unchanged_at_end_row
)
18103 row
= row_containing_pos (w
, PT
- delta
,
18104 first_unchanged_at_end_row
, NULL
, 0);
18106 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18107 delta_bytes
, dy
, dvpos
);
18110 /* Give up if cursor was not found. */
18111 if (w
->cursor
.vpos
< 0)
18113 clear_glyph_matrix (w
->desired_matrix
);
18118 /* Don't let the cursor end in the scroll margins. */
18120 int this_scroll_margin
, cursor_height
;
18121 int frame_line_height
= default_line_pixel_height (w
);
18122 int window_total_lines
18123 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18125 this_scroll_margin
=
18126 max (0, min (scroll_margin
, window_total_lines
/ 4));
18127 this_scroll_margin
*= frame_line_height
;
18128 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18130 if ((w
->cursor
.y
< this_scroll_margin
18131 && CHARPOS (start
) > BEGV
)
18132 /* Old redisplay didn't take scroll margin into account at the bottom,
18133 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18134 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18135 ? cursor_height
+ this_scroll_margin
18136 : 1)) > it
.last_visible_y
)
18138 w
->cursor
.vpos
= -1;
18139 clear_glyph_matrix (w
->desired_matrix
);
18144 /* Scroll the display. Do it before changing the current matrix so
18145 that xterm.c doesn't get confused about where the cursor glyph is
18147 if (dy
&& run
.height
)
18151 if (FRAME_WINDOW_P (f
))
18153 FRAME_RIF (f
)->update_window_begin_hook (w
);
18154 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18155 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18156 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18160 /* Terminal frame. In this case, dvpos gives the number of
18161 lines to scroll by; dvpos < 0 means scroll up. */
18163 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18164 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18165 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18166 + WINDOW_WANTS_HEADER_LINE_P (w
)
18167 + window_internal_height (w
));
18169 #if defined (HAVE_GPM) || defined (MSDOS)
18170 x_clear_window_mouse_face (w
);
18172 /* Perform the operation on the screen. */
18175 /* Scroll last_unchanged_at_beg_row to the end of the
18176 window down dvpos lines. */
18177 set_terminal_window (f
, end
);
18179 /* On dumb terminals delete dvpos lines at the end
18180 before inserting dvpos empty lines. */
18181 if (!FRAME_SCROLL_REGION_OK (f
))
18182 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18184 /* Insert dvpos empty lines in front of
18185 last_unchanged_at_beg_row. */
18186 ins_del_lines (f
, from
, dvpos
);
18188 else if (dvpos
< 0)
18190 /* Scroll up last_unchanged_at_beg_vpos to the end of
18191 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18192 set_terminal_window (f
, end
);
18194 /* Delete dvpos lines in front of
18195 last_unchanged_at_beg_vpos. ins_del_lines will set
18196 the cursor to the given vpos and emit |dvpos| delete
18198 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18200 /* On a dumb terminal insert dvpos empty lines at the
18202 if (!FRAME_SCROLL_REGION_OK (f
))
18203 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18206 set_terminal_window (f
, 0);
18212 /* Shift reused rows of the current matrix to the right position.
18213 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18215 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18216 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18219 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18220 bottom_vpos
, dvpos
);
18221 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18224 else if (dvpos
> 0)
18226 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18227 bottom_vpos
, dvpos
);
18228 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18229 first_unchanged_at_end_vpos
+ dvpos
);
18232 /* For frame-based redisplay, make sure that current frame and window
18233 matrix are in sync with respect to glyph memory. */
18234 if (!FRAME_WINDOW_P (f
))
18235 sync_frame_with_window_matrix_rows (w
);
18237 /* Adjust buffer positions in reused rows. */
18238 if (delta
|| delta_bytes
)
18239 increment_matrix_positions (current_matrix
,
18240 first_unchanged_at_end_vpos
+ dvpos
,
18241 bottom_vpos
, delta
, delta_bytes
);
18243 /* Adjust Y positions. */
18245 shift_glyph_matrix (w
, current_matrix
,
18246 first_unchanged_at_end_vpos
+ dvpos
,
18249 if (first_unchanged_at_end_row
)
18251 first_unchanged_at_end_row
+= dvpos
;
18252 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18253 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18254 first_unchanged_at_end_row
= NULL
;
18257 /* If scrolling up, there may be some lines to display at the end of
18259 last_text_row_at_end
= NULL
;
18262 /* Scrolling up can leave for example a partially visible line
18263 at the end of the window to be redisplayed. */
18264 /* Set last_row to the glyph row in the current matrix where the
18265 window end line is found. It has been moved up or down in
18266 the matrix by dvpos. */
18267 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18268 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18270 /* If last_row is the window end line, it should display text. */
18271 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18273 /* If window end line was partially visible before, begin
18274 displaying at that line. Otherwise begin displaying with the
18275 line following it. */
18276 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18278 init_to_row_start (&it
, w
, last_row
);
18279 it
.vpos
= last_vpos
;
18280 it
.current_y
= last_row
->y
;
18284 init_to_row_end (&it
, w
, last_row
);
18285 it
.vpos
= 1 + last_vpos
;
18286 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18290 /* We may start in a continuation line. If so, we have to
18291 get the right continuation_lines_width and current_x. */
18292 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18293 it
.hpos
= it
.current_x
= 0;
18295 /* Display the rest of the lines at the window end. */
18296 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18297 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18299 /* Is it always sure that the display agrees with lines in
18300 the current matrix? I don't think so, so we mark rows
18301 displayed invalid in the current matrix by setting their
18302 enabled_p flag to false. */
18303 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18304 if (display_line (&it
))
18305 last_text_row_at_end
= it
.glyph_row
- 1;
18309 /* Update window_end_pos and window_end_vpos. */
18310 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18312 /* Window end line if one of the preserved rows from the current
18313 matrix. Set row to the last row displaying text in current
18314 matrix starting at first_unchanged_at_end_row, after
18316 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18317 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18318 first_unchanged_at_end_row
);
18319 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18320 adjust_window_ends (w
, row
, true);
18321 eassert (w
->window_end_bytepos
>= 0);
18322 IF_DEBUG (debug_method_add (w
, "A"));
18324 else if (last_text_row_at_end
)
18326 adjust_window_ends (w
, last_text_row_at_end
, false);
18327 eassert (w
->window_end_bytepos
>= 0);
18328 IF_DEBUG (debug_method_add (w
, "B"));
18330 else if (last_text_row
)
18332 /* We have displayed either to the end of the window or at the
18333 end of the window, i.e. the last row with text is to be found
18334 in the desired matrix. */
18335 adjust_window_ends (w
, last_text_row
, false);
18336 eassert (w
->window_end_bytepos
>= 0);
18338 else if (first_unchanged_at_end_row
== NULL
18339 && last_text_row
== NULL
18340 && last_text_row_at_end
== NULL
)
18342 /* Displayed to end of window, but no line containing text was
18343 displayed. Lines were deleted at the end of the window. */
18344 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18345 int vpos
= w
->window_end_vpos
;
18346 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18347 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18350 row
== NULL
&& vpos
>= first_vpos
;
18351 --vpos
, --current_row
, --desired_row
)
18353 if (desired_row
->enabled_p
)
18355 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18358 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18362 eassert (row
!= NULL
);
18363 w
->window_end_vpos
= vpos
+ 1;
18364 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18365 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18366 eassert (w
->window_end_bytepos
>= 0);
18367 IF_DEBUG (debug_method_add (w
, "C"));
18372 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18373 debug_end_vpos
= w
->window_end_vpos
));
18375 /* Record that display has not been completed. */
18376 w
->window_end_valid
= false;
18377 w
->desired_matrix
->no_scrolling_p
= true;
18385 /***********************************************************************
18386 More debugging support
18387 ***********************************************************************/
18391 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18392 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18393 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18396 /* Dump the contents of glyph matrix MATRIX on stderr.
18398 GLYPHS 0 means don't show glyph contents.
18399 GLYPHS 1 means show glyphs in short form
18400 GLYPHS > 1 means show glyphs in long form. */
18403 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18406 for (i
= 0; i
< matrix
->nrows
; ++i
)
18407 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18411 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18412 the glyph row and area where the glyph comes from. */
18415 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18417 if (glyph
->type
== CHAR_GLYPH
18418 || glyph
->type
== GLYPHLESS_GLYPH
)
18421 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18422 glyph
- row
->glyphs
[TEXT_AREA
],
18423 (glyph
->type
== CHAR_GLYPH
18427 (BUFFERP (glyph
->object
)
18429 : (STRINGP (glyph
->object
)
18431 : (NILP (glyph
->object
)
18434 glyph
->pixel_width
,
18436 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18440 glyph
->left_box_line_p
,
18441 glyph
->right_box_line_p
);
18443 else if (glyph
->type
== STRETCH_GLYPH
)
18446 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18447 glyph
- row
->glyphs
[TEXT_AREA
],
18450 (BUFFERP (glyph
->object
)
18452 : (STRINGP (glyph
->object
)
18454 : (NILP (glyph
->object
)
18457 glyph
->pixel_width
,
18461 glyph
->left_box_line_p
,
18462 glyph
->right_box_line_p
);
18464 else if (glyph
->type
== IMAGE_GLYPH
)
18467 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18468 glyph
- row
->glyphs
[TEXT_AREA
],
18471 (BUFFERP (glyph
->object
)
18473 : (STRINGP (glyph
->object
)
18475 : (NILP (glyph
->object
)
18478 glyph
->pixel_width
,
18482 glyph
->left_box_line_p
,
18483 glyph
->right_box_line_p
);
18485 else if (glyph
->type
== COMPOSITE_GLYPH
)
18488 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18489 glyph
- row
->glyphs
[TEXT_AREA
],
18492 (BUFFERP (glyph
->object
)
18494 : (STRINGP (glyph
->object
)
18496 : (NILP (glyph
->object
)
18499 glyph
->pixel_width
,
18501 if (glyph
->u
.cmp
.automatic
)
18504 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18505 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18507 glyph
->left_box_line_p
,
18508 glyph
->right_box_line_p
);
18513 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18514 GLYPHS 0 means don't show glyph contents.
18515 GLYPHS 1 means show glyphs in short form
18516 GLYPHS > 1 means show glyphs in long form. */
18519 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18523 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18524 fprintf (stderr
, "==============================================================================\n");
18526 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18527 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18529 MATRIX_ROW_START_CHARPOS (row
),
18530 MATRIX_ROW_END_CHARPOS (row
),
18531 row
->used
[TEXT_AREA
],
18532 row
->contains_overlapping_glyphs_p
,
18534 row
->truncated_on_left_p
,
18535 row
->truncated_on_right_p
,
18537 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18538 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18541 row
->ends_in_middle_of_char_p
,
18542 row
->starts_in_middle_of_char_p
,
18548 row
->visible_height
,
18551 /* The next 3 lines should align to "Start" in the header. */
18552 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18553 row
->end
.overlay_string_index
,
18554 row
->continuation_lines_width
);
18555 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18556 CHARPOS (row
->start
.string_pos
),
18557 CHARPOS (row
->end
.string_pos
));
18558 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18559 row
->end
.dpvec_index
);
18566 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18568 struct glyph
*glyph
= row
->glyphs
[area
];
18569 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18571 /* Glyph for a line end in text. */
18572 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18575 if (glyph
< glyph_end
)
18576 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18578 for (; glyph
< glyph_end
; ++glyph
)
18579 dump_glyph (row
, glyph
, area
);
18582 else if (glyphs
== 1)
18585 char s
[SHRT_MAX
+ 4];
18587 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18591 for (i
= 0; i
< row
->used
[area
]; ++i
)
18593 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18594 if (i
== row
->used
[area
] - 1
18595 && area
== TEXT_AREA
18596 && NILP (glyph
->object
)
18597 && glyph
->type
== CHAR_GLYPH
18598 && glyph
->u
.ch
== ' ')
18600 strcpy (&s
[i
], "[\\n]");
18603 else if (glyph
->type
== CHAR_GLYPH
18604 && glyph
->u
.ch
< 0x80
18605 && glyph
->u
.ch
>= ' ')
18606 s
[i
] = glyph
->u
.ch
;
18612 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18618 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18619 Sdump_glyph_matrix
, 0, 1, "p",
18620 doc
: /* Dump the current matrix of the selected window to stderr.
18621 Shows contents of glyph row structures. With non-nil
18622 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18623 glyphs in short form, otherwise show glyphs in long form.
18625 Interactively, no argument means show glyphs in short form;
18626 with numeric argument, its value is passed as the GLYPHS flag. */)
18627 (Lisp_Object glyphs
)
18629 struct window
*w
= XWINDOW (selected_window
);
18630 struct buffer
*buffer
= XBUFFER (w
->contents
);
18632 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18633 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18634 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18635 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18636 fprintf (stderr
, "=============================================\n");
18637 dump_glyph_matrix (w
->current_matrix
,
18638 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18643 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18644 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18645 Only text-mode frames have frame glyph matrices. */)
18648 struct frame
*f
= XFRAME (selected_frame
);
18650 if (f
->current_matrix
)
18651 dump_glyph_matrix (f
->current_matrix
, 1);
18653 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18658 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18659 doc
: /* Dump glyph row ROW to stderr.
18660 GLYPH 0 means don't dump glyphs.
18661 GLYPH 1 means dump glyphs in short form.
18662 GLYPH > 1 or omitted means dump glyphs in long form. */)
18663 (Lisp_Object row
, Lisp_Object glyphs
)
18665 struct glyph_matrix
*matrix
;
18668 CHECK_NUMBER (row
);
18669 matrix
= XWINDOW (selected_window
)->current_matrix
;
18671 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18672 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18674 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18679 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18680 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18681 GLYPH 0 means don't dump glyphs.
18682 GLYPH 1 means dump glyphs in short form.
18683 GLYPH > 1 or omitted means dump glyphs in long form.
18685 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18687 (Lisp_Object row
, Lisp_Object glyphs
)
18689 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18690 struct frame
*sf
= SELECTED_FRAME ();
18691 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18694 CHECK_NUMBER (row
);
18696 if (vpos
>= 0 && vpos
< m
->nrows
)
18697 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18698 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18704 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18705 doc
: /* Toggle tracing of redisplay.
18706 With ARG, turn tracing on if and only if ARG is positive. */)
18710 trace_redisplay_p
= !trace_redisplay_p
;
18713 arg
= Fprefix_numeric_value (arg
);
18714 trace_redisplay_p
= XINT (arg
) > 0;
18721 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18722 doc
: /* Like `format', but print result to stderr.
18723 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18724 (ptrdiff_t nargs
, Lisp_Object
*args
)
18726 Lisp_Object s
= Fformat (nargs
, args
);
18727 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18731 #endif /* GLYPH_DEBUG */
18735 /***********************************************************************
18736 Building Desired Matrix Rows
18737 ***********************************************************************/
18739 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18740 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18742 static struct glyph_row
*
18743 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18745 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18746 struct buffer
*buffer
= XBUFFER (w
->contents
);
18747 struct buffer
*old
= current_buffer
;
18748 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18749 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18750 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18751 const unsigned char *p
;
18754 int n_glyphs_before
;
18756 set_buffer_temp (buffer
);
18757 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18758 scratch_glyph_row
.reversed_p
= false;
18759 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18760 SET_TEXT_POS (it
.position
, 0, 0);
18762 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18764 while (p
< arrow_end
)
18766 Lisp_Object face
, ilisp
;
18768 /* Get the next character. */
18770 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18773 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18774 if (! ASCII_CHAR_P (it
.c
))
18775 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18779 /* Get its face. */
18780 ilisp
= make_number (p
- arrow_string
);
18781 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18782 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18784 /* Compute its width, get its glyphs. */
18785 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18786 SET_TEXT_POS (it
.position
, -1, -1);
18787 PRODUCE_GLYPHS (&it
);
18789 /* If this character doesn't fit any more in the line, we have
18790 to remove some glyphs. */
18791 if (it
.current_x
> it
.last_visible_x
)
18793 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18798 set_buffer_temp (old
);
18799 return it
.glyph_row
;
18803 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18804 glyphs to insert is determined by produce_special_glyphs. */
18807 insert_left_trunc_glyphs (struct it
*it
)
18809 struct it truncate_it
;
18810 struct glyph
*from
, *end
, *to
, *toend
;
18812 eassert (!FRAME_WINDOW_P (it
->f
)
18813 || (!it
->glyph_row
->reversed_p
18814 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18815 || (it
->glyph_row
->reversed_p
18816 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18818 /* Get the truncation glyphs. */
18820 truncate_it
.current_x
= 0;
18821 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18822 truncate_it
.glyph_row
= &scratch_glyph_row
;
18823 truncate_it
.area
= TEXT_AREA
;
18824 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18825 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18826 truncate_it
.object
= Qnil
;
18827 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18829 /* Overwrite glyphs from IT with truncation glyphs. */
18830 if (!it
->glyph_row
->reversed_p
)
18832 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18834 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18835 end
= from
+ tused
;
18836 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18837 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18838 if (FRAME_WINDOW_P (it
->f
))
18840 /* On GUI frames, when variable-size fonts are displayed,
18841 the truncation glyphs may need more pixels than the row's
18842 glyphs they overwrite. We overwrite more glyphs to free
18843 enough screen real estate, and enlarge the stretch glyph
18844 on the right (see display_line), if there is one, to
18845 preserve the screen position of the truncation glyphs on
18848 struct glyph
*g
= to
;
18851 /* The first glyph could be partially visible, in which case
18852 it->glyph_row->x will be negative. But we want the left
18853 truncation glyphs to be aligned at the left margin of the
18854 window, so we override the x coordinate at which the row
18856 it
->glyph_row
->x
= 0;
18857 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18859 w
+= g
->pixel_width
;
18862 if (g
- to
- tused
> 0)
18864 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18865 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18867 used
= it
->glyph_row
->used
[TEXT_AREA
];
18868 if (it
->glyph_row
->truncated_on_right_p
18869 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18870 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18873 int extra
= w
- it
->truncation_pixel_width
;
18875 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18882 /* There may be padding glyphs left over. Overwrite them too. */
18883 if (!FRAME_WINDOW_P (it
->f
))
18885 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18887 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18894 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18898 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18900 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18901 that back to front. */
18902 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18903 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18904 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18905 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18906 if (FRAME_WINDOW_P (it
->f
))
18909 struct glyph
*g
= to
;
18911 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18913 w
+= g
->pixel_width
;
18916 if (to
- g
- tused
> 0)
18918 if (it
->glyph_row
->truncated_on_right_p
18919 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18920 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18922 int extra
= w
- it
->truncation_pixel_width
;
18924 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18928 while (from
>= end
&& to
>= toend
)
18930 if (!FRAME_WINDOW_P (it
->f
))
18932 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18935 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18936 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18937 while (from
>= end
&& to
>= toend
)
18943 /* Need to free some room before prepending additional
18945 int move_by
= from
- end
+ 1;
18946 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18947 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18949 for ( ; g
>= g0
; g
--)
18951 while (from
>= end
)
18953 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18958 /* Compute the hash code for ROW. */
18960 row_hash (struct glyph_row
*row
)
18963 unsigned hashval
= 0;
18965 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18966 for (k
= 0; k
< row
->used
[area
]; ++k
)
18967 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18968 + row
->glyphs
[area
][k
].u
.val
18969 + row
->glyphs
[area
][k
].face_id
18970 + row
->glyphs
[area
][k
].padding_p
18971 + (row
->glyphs
[area
][k
].type
<< 2));
18976 /* Compute the pixel height and width of IT->glyph_row.
18978 Most of the time, ascent and height of a display line will be equal
18979 to the max_ascent and max_height values of the display iterator
18980 structure. This is not the case if
18982 1. We hit ZV without displaying anything. In this case, max_ascent
18983 and max_height will be zero.
18985 2. We have some glyphs that don't contribute to the line height.
18986 (The glyph row flag contributes_to_line_height_p is for future
18987 pixmap extensions).
18989 The first case is easily covered by using default values because in
18990 these cases, the line height does not really matter, except that it
18991 must not be zero. */
18994 compute_line_metrics (struct it
*it
)
18996 struct glyph_row
*row
= it
->glyph_row
;
18998 if (FRAME_WINDOW_P (it
->f
))
19000 int i
, min_y
, max_y
;
19002 /* The line may consist of one space only, that was added to
19003 place the cursor on it. If so, the row's height hasn't been
19005 if (row
->height
== 0)
19007 if (it
->max_ascent
+ it
->max_descent
== 0)
19008 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19009 row
->ascent
= it
->max_ascent
;
19010 row
->height
= it
->max_ascent
+ it
->max_descent
;
19011 row
->phys_ascent
= it
->max_phys_ascent
;
19012 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19013 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19016 /* Compute the width of this line. */
19017 row
->pixel_width
= row
->x
;
19018 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19019 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19021 eassert (row
->pixel_width
>= 0);
19022 eassert (row
->ascent
>= 0 && row
->height
> 0);
19024 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19025 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19027 /* If first line's physical ascent is larger than its logical
19028 ascent, use the physical ascent, and make the row taller.
19029 This makes accented characters fully visible. */
19030 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19031 && row
->phys_ascent
> row
->ascent
)
19033 row
->height
+= row
->phys_ascent
- row
->ascent
;
19034 row
->ascent
= row
->phys_ascent
;
19037 /* Compute how much of the line is visible. */
19038 row
->visible_height
= row
->height
;
19040 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19041 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19043 if (row
->y
< min_y
)
19044 row
->visible_height
-= min_y
- row
->y
;
19045 if (row
->y
+ row
->height
> max_y
)
19046 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19050 row
->pixel_width
= row
->used
[TEXT_AREA
];
19051 if (row
->continued_p
)
19052 row
->pixel_width
-= it
->continuation_pixel_width
;
19053 else if (row
->truncated_on_right_p
)
19054 row
->pixel_width
-= it
->truncation_pixel_width
;
19055 row
->ascent
= row
->phys_ascent
= 0;
19056 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19057 row
->extra_line_spacing
= 0;
19060 /* Compute a hash code for this row. */
19061 row
->hash
= row_hash (row
);
19063 it
->max_ascent
= it
->max_descent
= 0;
19064 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19068 /* Append one space to the glyph row of iterator IT if doing a
19069 window-based redisplay. The space has the same face as
19070 IT->face_id. Value is true if a space was added.
19072 This function is called to make sure that there is always one glyph
19073 at the end of a glyph row that the cursor can be set on under
19074 window-systems. (If there weren't such a glyph we would not know
19075 how wide and tall a box cursor should be displayed).
19077 At the same time this space let's a nicely handle clearing to the
19078 end of the line if the row ends in italic text. */
19081 append_space_for_newline (struct it
*it
, bool default_face_p
)
19083 if (FRAME_WINDOW_P (it
->f
))
19085 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19087 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19088 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19090 /* Save some values that must not be changed.
19091 Must save IT->c and IT->len because otherwise
19092 ITERATOR_AT_END_P wouldn't work anymore after
19093 append_space_for_newline has been called. */
19094 enum display_element_type saved_what
= it
->what
;
19095 int saved_c
= it
->c
, saved_len
= it
->len
;
19096 int saved_char_to_display
= it
->char_to_display
;
19097 int saved_x
= it
->current_x
;
19098 int saved_face_id
= it
->face_id
;
19099 bool saved_box_end
= it
->end_of_box_run_p
;
19100 struct text_pos saved_pos
;
19101 Lisp_Object saved_object
;
19104 saved_object
= it
->object
;
19105 saved_pos
= it
->position
;
19107 it
->what
= IT_CHARACTER
;
19108 memset (&it
->position
, 0, sizeof it
->position
);
19110 it
->c
= it
->char_to_display
= ' ';
19113 /* If the default face was remapped, be sure to use the
19114 remapped face for the appended newline. */
19115 if (default_face_p
)
19116 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19117 else if (it
->face_before_selective_p
)
19118 it
->face_id
= it
->saved_face_id
;
19119 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19120 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19121 /* In R2L rows, we will prepend a stretch glyph that will
19122 have the end_of_box_run_p flag set for it, so there's no
19123 need for the appended newline glyph to have that flag
19125 if (it
->glyph_row
->reversed_p
19126 /* But if the appended newline glyph goes all the way to
19127 the end of the row, there will be no stretch glyph,
19128 so leave the box flag set. */
19129 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19130 it
->end_of_box_run_p
= false;
19132 PRODUCE_GLYPHS (it
);
19134 it
->override_ascent
= -1;
19135 it
->constrain_row_ascent_descent_p
= false;
19136 it
->current_x
= saved_x
;
19137 it
->object
= saved_object
;
19138 it
->position
= saved_pos
;
19139 it
->what
= saved_what
;
19140 it
->face_id
= saved_face_id
;
19141 it
->len
= saved_len
;
19143 it
->char_to_display
= saved_char_to_display
;
19144 it
->end_of_box_run_p
= saved_box_end
;
19153 /* Extend the face of the last glyph in the text area of IT->glyph_row
19154 to the end of the display line. Called from display_line. If the
19155 glyph row is empty, add a space glyph to it so that we know the
19156 face to draw. Set the glyph row flag fill_line_p. If the glyph
19157 row is R2L, prepend a stretch glyph to cover the empty space to the
19158 left of the leftmost glyph. */
19161 extend_face_to_end_of_line (struct it
*it
)
19163 struct face
*face
, *default_face
;
19164 struct frame
*f
= it
->f
;
19166 /* If line is already filled, do nothing. Non window-system frames
19167 get a grace of one more ``pixel'' because their characters are
19168 1-``pixel'' wide, so they hit the equality too early. This grace
19169 is needed only for R2L rows that are not continued, to produce
19170 one extra blank where we could display the cursor. */
19171 if ((it
->current_x
>= it
->last_visible_x
19172 + (!FRAME_WINDOW_P (f
)
19173 && it
->glyph_row
->reversed_p
19174 && !it
->glyph_row
->continued_p
))
19175 /* If the window has display margins, we will need to extend
19176 their face even if the text area is filled. */
19177 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19178 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19181 /* The default face, possibly remapped. */
19182 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19184 /* Face extension extends the background and box of IT->face_id
19185 to the end of the line. If the background equals the background
19186 of the frame, we don't have to do anything. */
19187 if (it
->face_before_selective_p
)
19188 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19190 face
= FACE_FROM_ID (f
, it
->face_id
);
19192 if (FRAME_WINDOW_P (f
)
19193 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19194 && face
->box
== FACE_NO_BOX
19195 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19196 #ifdef HAVE_WINDOW_SYSTEM
19199 && !it
->glyph_row
->reversed_p
)
19202 /* Set the glyph row flag indicating that the face of the last glyph
19203 in the text area has to be drawn to the end of the text area. */
19204 it
->glyph_row
->fill_line_p
= true;
19206 /* If current character of IT is not ASCII, make sure we have the
19207 ASCII face. This will be automatically undone the next time
19208 get_next_display_element returns a multibyte character. Note
19209 that the character will always be single byte in unibyte
19211 if (!ASCII_CHAR_P (it
->c
))
19213 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19216 if (FRAME_WINDOW_P (f
))
19218 /* If the row is empty, add a space with the current face of IT,
19219 so that we know which face to draw. */
19220 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19222 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19223 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19224 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19226 /* Mode line and the header line don't have margins, and
19227 likewise the frame's tool-bar window, if there is any. */
19228 if (!(it
->glyph_row
->mode_line_p
19229 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19230 || (WINDOWP (f
->tool_bar_window
)
19231 && it
->w
== XWINDOW (f
->tool_bar_window
))
19235 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19236 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19238 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19239 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19241 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19243 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19244 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19246 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19247 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19249 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19252 #ifdef HAVE_WINDOW_SYSTEM
19253 if (it
->glyph_row
->reversed_p
)
19255 /* Prepend a stretch glyph to the row, such that the
19256 rightmost glyph will be drawn flushed all the way to the
19257 right margin of the window. The stretch glyph that will
19258 occupy the empty space, if any, to the left of the
19260 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19261 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19262 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19264 int row_width
, stretch_ascent
, stretch_width
;
19265 struct text_pos saved_pos
;
19267 bool saved_avoid_cursor
, saved_box_start
;
19269 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19270 row_width
+= g
->pixel_width
;
19272 /* FIXME: There are various minor display glitches in R2L
19273 rows when only one of the fringes is missing. The
19274 strange condition below produces the least bad effect. */
19275 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19276 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19277 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19278 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19280 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19281 stretch_width
-= row_width
;
19283 if (stretch_width
> 0)
19286 (((it
->ascent
+ it
->descent
)
19287 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19288 saved_pos
= it
->position
;
19289 memset (&it
->position
, 0, sizeof it
->position
);
19290 saved_avoid_cursor
= it
->avoid_cursor_p
;
19291 it
->avoid_cursor_p
= true;
19292 saved_face_id
= it
->face_id
;
19293 saved_box_start
= it
->start_of_box_run_p
;
19294 /* The last row's stretch glyph should get the default
19295 face, to avoid painting the rest of the window with
19296 the region face, if the region ends at ZV. */
19297 if (it
->glyph_row
->ends_at_zv_p
)
19298 it
->face_id
= default_face
->id
;
19300 it
->face_id
= face
->id
;
19301 it
->start_of_box_run_p
= false;
19302 append_stretch_glyph (it
, Qnil
, stretch_width
,
19303 it
->ascent
+ it
->descent
, stretch_ascent
);
19304 it
->position
= saved_pos
;
19305 it
->avoid_cursor_p
= saved_avoid_cursor
;
19306 it
->face_id
= saved_face_id
;
19307 it
->start_of_box_run_p
= saved_box_start
;
19309 /* If stretch_width comes out negative, it means that the
19310 last glyph is only partially visible. In R2L rows, we
19311 want the leftmost glyph to be partially visible, so we
19312 need to give the row the corresponding left offset. */
19313 if (stretch_width
< 0)
19314 it
->glyph_row
->x
= stretch_width
;
19316 #endif /* HAVE_WINDOW_SYSTEM */
19320 /* Save some values that must not be changed. */
19321 int saved_x
= it
->current_x
;
19322 struct text_pos saved_pos
;
19323 Lisp_Object saved_object
;
19324 enum display_element_type saved_what
= it
->what
;
19325 int saved_face_id
= it
->face_id
;
19327 saved_object
= it
->object
;
19328 saved_pos
= it
->position
;
19330 it
->what
= IT_CHARACTER
;
19331 memset (&it
->position
, 0, sizeof it
->position
);
19333 it
->c
= it
->char_to_display
= ' ';
19336 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19337 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19338 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19339 && !it
->glyph_row
->mode_line_p
19340 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19342 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19343 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19345 for (it
->current_x
= 0; g
< e
; g
++)
19346 it
->current_x
+= g
->pixel_width
;
19348 it
->area
= LEFT_MARGIN_AREA
;
19349 it
->face_id
= default_face
->id
;
19350 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19351 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19353 PRODUCE_GLYPHS (it
);
19354 /* term.c:produce_glyphs advances it->current_x only for
19356 it
->current_x
+= it
->pixel_width
;
19359 it
->current_x
= saved_x
;
19360 it
->area
= TEXT_AREA
;
19363 /* The last row's blank glyphs should get the default face, to
19364 avoid painting the rest of the window with the region face,
19365 if the region ends at ZV. */
19366 if (it
->glyph_row
->ends_at_zv_p
)
19367 it
->face_id
= default_face
->id
;
19369 it
->face_id
= face
->id
;
19370 PRODUCE_GLYPHS (it
);
19372 while (it
->current_x
<= it
->last_visible_x
)
19373 PRODUCE_GLYPHS (it
);
19375 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19376 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19377 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19378 && !it
->glyph_row
->mode_line_p
19379 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19381 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19382 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19384 for ( ; g
< e
; g
++)
19385 it
->current_x
+= g
->pixel_width
;
19387 it
->area
= RIGHT_MARGIN_AREA
;
19388 it
->face_id
= default_face
->id
;
19389 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19390 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19392 PRODUCE_GLYPHS (it
);
19393 it
->current_x
+= it
->pixel_width
;
19396 it
->area
= TEXT_AREA
;
19399 /* Don't count these blanks really. It would let us insert a left
19400 truncation glyph below and make us set the cursor on them, maybe. */
19401 it
->current_x
= saved_x
;
19402 it
->object
= saved_object
;
19403 it
->position
= saved_pos
;
19404 it
->what
= saved_what
;
19405 it
->face_id
= saved_face_id
;
19410 /* Value is true if text starting at CHARPOS in current_buffer is
19411 trailing whitespace. */
19414 trailing_whitespace_p (ptrdiff_t charpos
)
19416 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19419 while (bytepos
< ZV_BYTE
19420 && (c
= FETCH_CHAR (bytepos
),
19421 c
== ' ' || c
== '\t'))
19424 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19426 if (bytepos
!= PT_BYTE
)
19433 /* Highlight trailing whitespace, if any, in ROW. */
19436 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19438 int used
= row
->used
[TEXT_AREA
];
19442 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19443 struct glyph
*glyph
= start
+ used
- 1;
19445 if (row
->reversed_p
)
19447 /* Right-to-left rows need to be processed in the opposite
19448 direction, so swap the edge pointers. */
19450 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19453 /* Skip over glyphs inserted to display the cursor at the
19454 end of a line, for extending the face of the last glyph
19455 to the end of the line on terminals, and for truncation
19456 and continuation glyphs. */
19457 if (!row
->reversed_p
)
19459 while (glyph
>= start
19460 && glyph
->type
== CHAR_GLYPH
19461 && NILP (glyph
->object
))
19466 while (glyph
<= start
19467 && glyph
->type
== CHAR_GLYPH
19468 && NILP (glyph
->object
))
19472 /* If last glyph is a space or stretch, and it's trailing
19473 whitespace, set the face of all trailing whitespace glyphs in
19474 IT->glyph_row to `trailing-whitespace'. */
19475 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19476 && BUFFERP (glyph
->object
)
19477 && (glyph
->type
== STRETCH_GLYPH
19478 || (glyph
->type
== CHAR_GLYPH
19479 && glyph
->u
.ch
== ' '))
19480 && trailing_whitespace_p (glyph
->charpos
))
19482 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19486 if (!row
->reversed_p
)
19488 while (glyph
>= start
19489 && BUFFERP (glyph
->object
)
19490 && (glyph
->type
== STRETCH_GLYPH
19491 || (glyph
->type
== CHAR_GLYPH
19492 && glyph
->u
.ch
== ' ')))
19493 (glyph
--)->face_id
= face_id
;
19497 while (glyph
<= start
19498 && BUFFERP (glyph
->object
)
19499 && (glyph
->type
== STRETCH_GLYPH
19500 || (glyph
->type
== CHAR_GLYPH
19501 && glyph
->u
.ch
== ' ')))
19502 (glyph
++)->face_id
= face_id
;
19509 /* Value is true if glyph row ROW should be
19510 considered to hold the buffer position CHARPOS. */
19513 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19515 bool result
= true;
19517 if (charpos
== CHARPOS (row
->end
.pos
)
19518 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19520 /* Suppose the row ends on a string.
19521 Unless the row is continued, that means it ends on a newline
19522 in the string. If it's anything other than a display string
19523 (e.g., a before-string from an overlay), we don't want the
19524 cursor there. (This heuristic seems to give the optimal
19525 behavior for the various types of multi-line strings.)
19526 One exception: if the string has `cursor' property on one of
19527 its characters, we _do_ want the cursor there. */
19528 if (CHARPOS (row
->end
.string_pos
) >= 0)
19530 if (row
->continued_p
)
19534 /* Check for `display' property. */
19535 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19536 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19537 struct glyph
*glyph
;
19540 for (glyph
= end
; glyph
>= beg
; --glyph
)
19541 if (STRINGP (glyph
->object
))
19544 = Fget_char_property (make_number (charpos
),
19548 && display_prop_string_p (prop
, glyph
->object
));
19549 /* If there's a `cursor' property on one of the
19550 string's characters, this row is a cursor row,
19551 even though this is not a display string. */
19554 Lisp_Object s
= glyph
->object
;
19556 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19558 ptrdiff_t gpos
= glyph
->charpos
;
19560 if (!NILP (Fget_char_property (make_number (gpos
),
19572 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19574 /* If the row ends in middle of a real character,
19575 and the line is continued, we want the cursor here.
19576 That's because CHARPOS (ROW->end.pos) would equal
19577 PT if PT is before the character. */
19578 if (!row
->ends_in_ellipsis_p
)
19579 result
= row
->continued_p
;
19581 /* If the row ends in an ellipsis, then
19582 CHARPOS (ROW->end.pos) will equal point after the
19583 invisible text. We want that position to be displayed
19584 after the ellipsis. */
19587 /* If the row ends at ZV, display the cursor at the end of that
19588 row instead of at the start of the row below. */
19590 result
= row
->ends_at_zv_p
;
19596 /* Value is true if glyph row ROW should be
19597 used to hold the cursor. */
19600 cursor_row_p (struct glyph_row
*row
)
19602 return row_for_charpos_p (row
, PT
);
19607 /* Push the property PROP so that it will be rendered at the current
19608 position in IT. Return true if PROP was successfully pushed, false
19609 otherwise. Called from handle_line_prefix to handle the
19610 `line-prefix' and `wrap-prefix' properties. */
19613 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19615 struct text_pos pos
=
19616 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19618 eassert (it
->method
== GET_FROM_BUFFER
19619 || it
->method
== GET_FROM_DISPLAY_VECTOR
19620 || it
->method
== GET_FROM_STRING
);
19622 /* We need to save the current buffer/string position, so it will be
19623 restored by pop_it, because iterate_out_of_display_property
19624 depends on that being set correctly, but some situations leave
19625 it->position not yet set when this function is called. */
19626 push_it (it
, &pos
);
19628 if (STRINGP (prop
))
19630 if (SCHARS (prop
) == 0)
19637 it
->string_from_prefix_prop_p
= true;
19638 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19639 it
->current
.overlay_string_index
= -1;
19640 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19641 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19642 it
->method
= GET_FROM_STRING
;
19643 it
->stop_charpos
= 0;
19645 it
->base_level_stop
= 0;
19647 /* Force paragraph direction to be that of the parent
19649 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19650 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19652 it
->paragraph_embedding
= L2R
;
19654 /* Set up the bidi iterator for this display string. */
19657 it
->bidi_it
.string
.lstring
= it
->string
;
19658 it
->bidi_it
.string
.s
= NULL
;
19659 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19660 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19661 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19662 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19663 it
->bidi_it
.w
= it
->w
;
19664 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19667 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19669 it
->method
= GET_FROM_STRETCH
;
19672 #ifdef HAVE_WINDOW_SYSTEM
19673 else if (IMAGEP (prop
))
19675 it
->what
= IT_IMAGE
;
19676 it
->image_id
= lookup_image (it
->f
, prop
);
19677 it
->method
= GET_FROM_IMAGE
;
19679 #endif /* HAVE_WINDOW_SYSTEM */
19682 pop_it (it
); /* bogus display property, give up */
19689 /* Return the character-property PROP at the current position in IT. */
19692 get_it_property (struct it
*it
, Lisp_Object prop
)
19694 Lisp_Object position
, object
= it
->object
;
19696 if (STRINGP (object
))
19697 position
= make_number (IT_STRING_CHARPOS (*it
));
19698 else if (BUFFERP (object
))
19700 position
= make_number (IT_CHARPOS (*it
));
19701 object
= it
->window
;
19706 return Fget_char_property (position
, prop
, object
);
19709 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19712 handle_line_prefix (struct it
*it
)
19714 Lisp_Object prefix
;
19716 if (it
->continuation_lines_width
> 0)
19718 prefix
= get_it_property (it
, Qwrap_prefix
);
19720 prefix
= Vwrap_prefix
;
19724 prefix
= get_it_property (it
, Qline_prefix
);
19726 prefix
= Vline_prefix
;
19728 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19730 /* If the prefix is wider than the window, and we try to wrap
19731 it, it would acquire its own wrap prefix, and so on till the
19732 iterator stack overflows. So, don't wrap the prefix. */
19733 it
->line_wrap
= TRUNCATE
;
19734 it
->avoid_cursor_p
= true;
19740 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19741 only for R2L lines from display_line and display_string, when they
19742 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19743 the line/string needs to be continued on the next glyph row. */
19745 unproduce_glyphs (struct it
*it
, int n
)
19747 struct glyph
*glyph
, *end
;
19749 eassert (it
->glyph_row
);
19750 eassert (it
->glyph_row
->reversed_p
);
19751 eassert (it
->area
== TEXT_AREA
);
19752 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19754 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19755 n
= it
->glyph_row
->used
[TEXT_AREA
];
19756 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19757 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19758 for ( ; glyph
< end
; glyph
++)
19759 glyph
[-n
] = *glyph
;
19762 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19763 and ROW->maxpos. */
19765 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19766 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19767 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19769 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19770 lines' rows is implemented for bidi-reordered rows. */
19772 /* ROW->minpos is the value of min_pos, the minimal buffer position
19773 we have in ROW, or ROW->start.pos if that is smaller. */
19774 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19775 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19777 /* We didn't find buffer positions smaller than ROW->start, or
19778 didn't find _any_ valid buffer positions in any of the glyphs,
19779 so we must trust the iterator's computed positions. */
19780 row
->minpos
= row
->start
.pos
;
19783 max_pos
= CHARPOS (it
->current
.pos
);
19784 max_bpos
= BYTEPOS (it
->current
.pos
);
19787 /* Here are the various use-cases for ending the row, and the
19788 corresponding values for ROW->maxpos:
19790 Line ends in a newline from buffer eol_pos + 1
19791 Line is continued from buffer max_pos + 1
19792 Line is truncated on right it->current.pos
19793 Line ends in a newline from string max_pos + 1(*)
19794 (*) + 1 only when line ends in a forward scan
19795 Line is continued from string max_pos
19796 Line is continued from display vector max_pos
19797 Line is entirely from a string min_pos == max_pos
19798 Line is entirely from a display vector min_pos == max_pos
19799 Line that ends at ZV ZV
19801 If you discover other use-cases, please add them here as
19803 if (row
->ends_at_zv_p
)
19804 row
->maxpos
= it
->current
.pos
;
19805 else if (row
->used
[TEXT_AREA
])
19807 bool seen_this_string
= false;
19808 struct glyph_row
*r1
= row
- 1;
19810 /* Did we see the same display string on the previous row? */
19811 if (STRINGP (it
->object
)
19812 /* this is not the first row */
19813 && row
> it
->w
->desired_matrix
->rows
19814 /* previous row is not the header line */
19815 && !r1
->mode_line_p
19816 /* previous row also ends in a newline from a string */
19817 && r1
->ends_in_newline_from_string_p
)
19819 struct glyph
*start
, *end
;
19821 /* Search for the last glyph of the previous row that came
19822 from buffer or string. Depending on whether the row is
19823 L2R or R2L, we need to process it front to back or the
19824 other way round. */
19825 if (!r1
->reversed_p
)
19827 start
= r1
->glyphs
[TEXT_AREA
];
19828 end
= start
+ r1
->used
[TEXT_AREA
];
19829 /* Glyphs inserted by redisplay have nil as their object. */
19831 && NILP ((end
- 1)->object
)
19832 && (end
- 1)->charpos
<= 0)
19836 if (EQ ((end
- 1)->object
, it
->object
))
19837 seen_this_string
= true;
19840 /* If all the glyphs of the previous row were inserted
19841 by redisplay, it means the previous row was
19842 produced from a single newline, which is only
19843 possible if that newline came from the same string
19844 as the one which produced this ROW. */
19845 seen_this_string
= true;
19849 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19850 start
= end
+ r1
->used
[TEXT_AREA
];
19852 && NILP ((end
+ 1)->object
)
19853 && (end
+ 1)->charpos
<= 0)
19857 if (EQ ((end
+ 1)->object
, it
->object
))
19858 seen_this_string
= true;
19861 seen_this_string
= true;
19864 /* Take note of each display string that covers a newline only
19865 once, the first time we see it. This is for when a display
19866 string includes more than one newline in it. */
19867 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19869 /* If we were scanning the buffer forward when we displayed
19870 the string, we want to account for at least one buffer
19871 position that belongs to this row (position covered by
19872 the display string), so that cursor positioning will
19873 consider this row as a candidate when point is at the end
19874 of the visual line represented by this row. This is not
19875 required when scanning back, because max_pos will already
19876 have a much larger value. */
19877 if (CHARPOS (row
->end
.pos
) > max_pos
)
19878 INC_BOTH (max_pos
, max_bpos
);
19879 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19881 else if (CHARPOS (it
->eol_pos
) > 0)
19882 SET_TEXT_POS (row
->maxpos
,
19883 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19884 else if (row
->continued_p
)
19886 /* If max_pos is different from IT's current position, it
19887 means IT->method does not belong to the display element
19888 at max_pos. However, it also means that the display
19889 element at max_pos was displayed in its entirety on this
19890 line, which is equivalent to saying that the next line
19891 starts at the next buffer position. */
19892 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19893 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19896 INC_BOTH (max_pos
, max_bpos
);
19897 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19900 else if (row
->truncated_on_right_p
)
19901 /* display_line already called reseat_at_next_visible_line_start,
19902 which puts the iterator at the beginning of the next line, in
19903 the logical order. */
19904 row
->maxpos
= it
->current
.pos
;
19905 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19906 /* A line that is entirely from a string/image/stretch... */
19907 row
->maxpos
= row
->minpos
;
19912 row
->maxpos
= it
->current
.pos
;
19915 /* Construct the glyph row IT->glyph_row in the desired matrix of
19916 IT->w from text at the current position of IT. See dispextern.h
19917 for an overview of struct it. Value is true if
19918 IT->glyph_row displays text, as opposed to a line displaying ZV
19922 display_line (struct it
*it
)
19924 struct glyph_row
*row
= it
->glyph_row
;
19925 Lisp_Object overlay_arrow_string
;
19927 void *wrap_data
= NULL
;
19928 bool may_wrap
= false;
19929 int wrap_x
IF_LINT (= 0);
19930 int wrap_row_used
= -1;
19931 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19932 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19933 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19934 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19935 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19937 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19938 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19939 bool pending_handle_line_prefix
= false;
19941 /* We always start displaying at hpos zero even if hscrolled. */
19942 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19944 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19945 >= it
->w
->desired_matrix
->nrows
)
19947 it
->w
->nrows_scale_factor
++;
19948 it
->f
->fonts_changed
= true;
19952 /* Clear the result glyph row and enable it. */
19953 prepare_desired_row (it
->w
, row
, false);
19955 row
->y
= it
->current_y
;
19956 row
->start
= it
->start
;
19957 row
->continuation_lines_width
= it
->continuation_lines_width
;
19958 row
->displays_text_p
= true;
19959 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19960 it
->starts_in_middle_of_char_p
= false;
19962 /* Arrange the overlays nicely for our purposes. Usually, we call
19963 display_line on only one line at a time, in which case this
19964 can't really hurt too much, or we call it on lines which appear
19965 one after another in the buffer, in which case all calls to
19966 recenter_overlay_lists but the first will be pretty cheap. */
19967 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19969 /* Move over display elements that are not visible because we are
19970 hscrolled. This may stop at an x-position < IT->first_visible_x
19971 if the first glyph is partially visible or if we hit a line end. */
19972 if (it
->current_x
< it
->first_visible_x
)
19974 enum move_it_result move_result
;
19976 this_line_min_pos
= row
->start
.pos
;
19977 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19978 MOVE_TO_POS
| MOVE_TO_X
);
19979 /* If we are under a large hscroll, move_it_in_display_line_to
19980 could hit the end of the line without reaching
19981 it->first_visible_x. Pretend that we did reach it. This is
19982 especially important on a TTY, where we will call
19983 extend_face_to_end_of_line, which needs to know how many
19984 blank glyphs to produce. */
19985 if (it
->current_x
< it
->first_visible_x
19986 && (move_result
== MOVE_NEWLINE_OR_CR
19987 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19988 it
->current_x
= it
->first_visible_x
;
19990 /* Record the smallest positions seen while we moved over
19991 display elements that are not visible. This is needed by
19992 redisplay_internal for optimizing the case where the cursor
19993 stays inside the same line. The rest of this function only
19994 considers positions that are actually displayed, so
19995 RECORD_MAX_MIN_POS will not otherwise record positions that
19996 are hscrolled to the left of the left edge of the window. */
19997 min_pos
= CHARPOS (this_line_min_pos
);
19998 min_bpos
= BYTEPOS (this_line_min_pos
);
20000 else if (it
->area
== TEXT_AREA
)
20002 /* We only do this when not calling move_it_in_display_line_to
20003 above, because that function calls itself handle_line_prefix. */
20004 handle_line_prefix (it
);
20008 /* Line-prefix and wrap-prefix are always displayed in the text
20009 area. But if this is the first call to display_line after
20010 init_iterator, the iterator might have been set up to write
20011 into a marginal area, e.g. if the line begins with some
20012 display property that writes to the margins. So we need to
20013 wait with the call to handle_line_prefix until whatever
20014 writes to the margin has done its job. */
20015 pending_handle_line_prefix
= true;
20018 /* Get the initial row height. This is either the height of the
20019 text hscrolled, if there is any, or zero. */
20020 row
->ascent
= it
->max_ascent
;
20021 row
->height
= it
->max_ascent
+ it
->max_descent
;
20022 row
->phys_ascent
= it
->max_phys_ascent
;
20023 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20024 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20026 /* Utility macro to record max and min buffer positions seen until now. */
20027 #define RECORD_MAX_MIN_POS(IT) \
20030 bool composition_p \
20031 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20032 ptrdiff_t current_pos = \
20033 composition_p ? (IT)->cmp_it.charpos \
20034 : IT_CHARPOS (*(IT)); \
20035 ptrdiff_t current_bpos = \
20036 composition_p ? CHAR_TO_BYTE (current_pos) \
20037 : IT_BYTEPOS (*(IT)); \
20038 if (current_pos < min_pos) \
20040 min_pos = current_pos; \
20041 min_bpos = current_bpos; \
20043 if (IT_CHARPOS (*it) > max_pos) \
20045 max_pos = IT_CHARPOS (*it); \
20046 max_bpos = IT_BYTEPOS (*it); \
20051 /* Loop generating characters. The loop is left with IT on the next
20052 character to display. */
20055 int n_glyphs_before
, hpos_before
, x_before
;
20057 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20059 /* Retrieve the next thing to display. Value is false if end of
20061 if (!get_next_display_element (it
))
20063 /* Maybe add a space at the end of this line that is used to
20064 display the cursor there under X. Set the charpos of the
20065 first glyph of blank lines not corresponding to any text
20067 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20068 row
->exact_window_width_line_p
= true;
20069 else if ((append_space_for_newline (it
, true)
20070 && row
->used
[TEXT_AREA
] == 1)
20071 || row
->used
[TEXT_AREA
] == 0)
20073 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20074 row
->displays_text_p
= false;
20076 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20077 && (!MINI_WINDOW_P (it
->w
)
20078 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20079 row
->indicate_empty_line_p
= true;
20082 it
->continuation_lines_width
= 0;
20083 row
->ends_at_zv_p
= true;
20084 /* A row that displays right-to-left text must always have
20085 its last face extended all the way to the end of line,
20086 even if this row ends in ZV, because we still write to
20087 the screen left to right. We also need to extend the
20088 last face if the default face is remapped to some
20089 different face, otherwise the functions that clear
20090 portions of the screen will clear with the default face's
20091 background color. */
20092 if (row
->reversed_p
20093 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20094 extend_face_to_end_of_line (it
);
20098 /* Now, get the metrics of what we want to display. This also
20099 generates glyphs in `row' (which is IT->glyph_row). */
20100 n_glyphs_before
= row
->used
[TEXT_AREA
];
20103 /* Remember the line height so far in case the next element doesn't
20104 fit on the line. */
20105 if (it
->line_wrap
!= TRUNCATE
)
20107 ascent
= it
->max_ascent
;
20108 descent
= it
->max_descent
;
20109 phys_ascent
= it
->max_phys_ascent
;
20110 phys_descent
= it
->max_phys_descent
;
20112 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20114 if (IT_DISPLAYING_WHITESPACE (it
))
20118 SAVE_IT (wrap_it
, *it
, wrap_data
);
20120 wrap_row_used
= row
->used
[TEXT_AREA
];
20121 wrap_row_ascent
= row
->ascent
;
20122 wrap_row_height
= row
->height
;
20123 wrap_row_phys_ascent
= row
->phys_ascent
;
20124 wrap_row_phys_height
= row
->phys_height
;
20125 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20126 wrap_row_min_pos
= min_pos
;
20127 wrap_row_min_bpos
= min_bpos
;
20128 wrap_row_max_pos
= max_pos
;
20129 wrap_row_max_bpos
= max_bpos
;
20135 PRODUCE_GLYPHS (it
);
20137 /* If this display element was in marginal areas, continue with
20139 if (it
->area
!= TEXT_AREA
)
20141 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20142 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20143 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20144 row
->phys_height
= max (row
->phys_height
,
20145 it
->max_phys_ascent
+ it
->max_phys_descent
);
20146 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20147 it
->max_extra_line_spacing
);
20148 set_iterator_to_next (it
, true);
20149 /* If we didn't handle the line/wrap prefix above, and the
20150 call to set_iterator_to_next just switched to TEXT_AREA,
20151 process the prefix now. */
20152 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20154 pending_handle_line_prefix
= false;
20155 handle_line_prefix (it
);
20160 /* Does the display element fit on the line? If we truncate
20161 lines, we should draw past the right edge of the window. If
20162 we don't truncate, we want to stop so that we can display the
20163 continuation glyph before the right margin. If lines are
20164 continued, there are two possible strategies for characters
20165 resulting in more than 1 glyph (e.g. tabs): Display as many
20166 glyphs as possible in this line and leave the rest for the
20167 continuation line, or display the whole element in the next
20168 line. Original redisplay did the former, so we do it also. */
20169 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20170 hpos_before
= it
->hpos
;
20173 if (/* Not a newline. */
20175 /* Glyphs produced fit entirely in the line. */
20176 && it
->current_x
< it
->last_visible_x
)
20178 it
->hpos
+= nglyphs
;
20179 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20180 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20181 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20182 row
->phys_height
= max (row
->phys_height
,
20183 it
->max_phys_ascent
+ it
->max_phys_descent
);
20184 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20185 it
->max_extra_line_spacing
);
20186 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20187 /* In R2L rows, we arrange in extend_face_to_end_of_line
20188 to add a right offset to the line, by a suitable
20189 change to the stretch glyph that is the leftmost
20190 glyph of the line. */
20191 && !row
->reversed_p
)
20192 row
->x
= x
- it
->first_visible_x
;
20193 /* Record the maximum and minimum buffer positions seen so
20194 far in glyphs that will be displayed by this row. */
20196 RECORD_MAX_MIN_POS (it
);
20201 struct glyph
*glyph
;
20203 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20205 /* Identify the glyphs added by the last call to
20206 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20207 the previous glyphs. */
20208 if (!row
->reversed_p
)
20209 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20211 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20212 new_x
= x
+ glyph
->pixel_width
;
20214 if (/* Lines are continued. */
20215 it
->line_wrap
!= TRUNCATE
20216 && (/* Glyph doesn't fit on the line. */
20217 new_x
> it
->last_visible_x
20218 /* Or it fits exactly on a window system frame. */
20219 || (new_x
== it
->last_visible_x
20220 && FRAME_WINDOW_P (it
->f
)
20221 && (row
->reversed_p
20222 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20223 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20225 /* End of a continued line. */
20228 || (new_x
== it
->last_visible_x
20229 && FRAME_WINDOW_P (it
->f
)
20230 && (row
->reversed_p
20231 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20232 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20234 /* Current glyph is the only one on the line or
20235 fits exactly on the line. We must continue
20236 the line because we can't draw the cursor
20237 after the glyph. */
20238 row
->continued_p
= true;
20239 it
->current_x
= new_x
;
20240 it
->continuation_lines_width
+= new_x
;
20242 if (i
== nglyphs
- 1)
20244 /* If line-wrap is on, check if a previous
20245 wrap point was found. */
20246 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20247 && wrap_row_used
> 0
20248 /* Even if there is a previous wrap
20249 point, continue the line here as
20250 usual, if (i) the previous character
20251 was a space or tab AND (ii) the
20252 current character is not. */
20254 || IT_DISPLAYING_WHITESPACE (it
)))
20257 /* Record the maximum and minimum buffer
20258 positions seen so far in glyphs that will be
20259 displayed by this row. */
20261 RECORD_MAX_MIN_POS (it
);
20262 set_iterator_to_next (it
, true);
20263 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20265 if (!get_next_display_element (it
))
20267 row
->exact_window_width_line_p
= true;
20268 it
->continuation_lines_width
= 0;
20269 row
->continued_p
= false;
20270 row
->ends_at_zv_p
= true;
20272 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20274 row
->continued_p
= false;
20275 row
->exact_window_width_line_p
= true;
20277 /* If line-wrap is on, check if a
20278 previous wrap point was found. */
20279 else if (wrap_row_used
> 0
20280 /* Even if there is a previous wrap
20281 point, continue the line here as
20282 usual, if (i) the previous character
20283 was a space or tab AND (ii) the
20284 current character is not. */
20286 || IT_DISPLAYING_WHITESPACE (it
)))
20291 else if (it
->bidi_p
)
20292 RECORD_MAX_MIN_POS (it
);
20293 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20294 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20295 extend_face_to_end_of_line (it
);
20297 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20298 && !FRAME_WINDOW_P (it
->f
))
20300 /* A padding glyph that doesn't fit on this line.
20301 This means the whole character doesn't fit
20303 if (row
->reversed_p
)
20304 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20305 - n_glyphs_before
);
20306 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20308 /* Fill the rest of the row with continuation
20309 glyphs like in 20.x. */
20310 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20311 < row
->glyphs
[1 + TEXT_AREA
])
20312 produce_special_glyphs (it
, IT_CONTINUATION
);
20314 row
->continued_p
= true;
20315 it
->current_x
= x_before
;
20316 it
->continuation_lines_width
+= x_before
;
20318 /* Restore the height to what it was before the
20319 element not fitting on the line. */
20320 it
->max_ascent
= ascent
;
20321 it
->max_descent
= descent
;
20322 it
->max_phys_ascent
= phys_ascent
;
20323 it
->max_phys_descent
= phys_descent
;
20324 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20325 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20326 extend_face_to_end_of_line (it
);
20328 else if (wrap_row_used
> 0)
20331 if (row
->reversed_p
)
20332 unproduce_glyphs (it
,
20333 row
->used
[TEXT_AREA
] - wrap_row_used
);
20334 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20335 it
->continuation_lines_width
+= wrap_x
;
20336 row
->used
[TEXT_AREA
] = wrap_row_used
;
20337 row
->ascent
= wrap_row_ascent
;
20338 row
->height
= wrap_row_height
;
20339 row
->phys_ascent
= wrap_row_phys_ascent
;
20340 row
->phys_height
= wrap_row_phys_height
;
20341 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20342 min_pos
= wrap_row_min_pos
;
20343 min_bpos
= wrap_row_min_bpos
;
20344 max_pos
= wrap_row_max_pos
;
20345 max_bpos
= wrap_row_max_bpos
;
20346 row
->continued_p
= true;
20347 row
->ends_at_zv_p
= false;
20348 row
->exact_window_width_line_p
= false;
20349 it
->continuation_lines_width
+= x
;
20351 /* Make sure that a non-default face is extended
20352 up to the right margin of the window. */
20353 extend_face_to_end_of_line (it
);
20355 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20357 /* A TAB that extends past the right edge of the
20358 window. This produces a single glyph on
20359 window system frames. We leave the glyph in
20360 this row and let it fill the row, but don't
20361 consume the TAB. */
20362 if ((row
->reversed_p
20363 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20364 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20365 produce_special_glyphs (it
, IT_CONTINUATION
);
20366 it
->continuation_lines_width
+= it
->last_visible_x
;
20367 row
->ends_in_middle_of_char_p
= true;
20368 row
->continued_p
= true;
20369 glyph
->pixel_width
= it
->last_visible_x
- x
;
20370 it
->starts_in_middle_of_char_p
= true;
20371 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20372 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20373 extend_face_to_end_of_line (it
);
20377 /* Something other than a TAB that draws past
20378 the right edge of the window. Restore
20379 positions to values before the element. */
20380 if (row
->reversed_p
)
20381 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20382 - (n_glyphs_before
+ i
));
20383 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20385 /* Display continuation glyphs. */
20386 it
->current_x
= x_before
;
20387 it
->continuation_lines_width
+= x
;
20388 if (!FRAME_WINDOW_P (it
->f
)
20389 || (row
->reversed_p
20390 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20391 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20392 produce_special_glyphs (it
, IT_CONTINUATION
);
20393 row
->continued_p
= true;
20395 extend_face_to_end_of_line (it
);
20397 if (nglyphs
> 1 && i
> 0)
20399 row
->ends_in_middle_of_char_p
= true;
20400 it
->starts_in_middle_of_char_p
= true;
20403 /* Restore the height to what it was before the
20404 element not fitting on the line. */
20405 it
->max_ascent
= ascent
;
20406 it
->max_descent
= descent
;
20407 it
->max_phys_ascent
= phys_ascent
;
20408 it
->max_phys_descent
= phys_descent
;
20413 else if (new_x
> it
->first_visible_x
)
20415 /* Increment number of glyphs actually displayed. */
20418 /* Record the maximum and minimum buffer positions
20419 seen so far in glyphs that will be displayed by
20422 RECORD_MAX_MIN_POS (it
);
20424 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20425 /* Glyph is partially visible, i.e. row starts at
20426 negative X position. Don't do that in R2L
20427 rows, where we arrange to add a right offset to
20428 the line in extend_face_to_end_of_line, by a
20429 suitable change to the stretch glyph that is
20430 the leftmost glyph of the line. */
20431 row
->x
= x
- it
->first_visible_x
;
20432 /* When the last glyph of an R2L row only fits
20433 partially on the line, we need to set row->x to a
20434 negative offset, so that the leftmost glyph is
20435 the one that is partially visible. But if we are
20436 going to produce the truncation glyph, this will
20437 be taken care of in produce_special_glyphs. */
20438 if (row
->reversed_p
20439 && new_x
> it
->last_visible_x
20440 && !(it
->line_wrap
== TRUNCATE
20441 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20443 eassert (FRAME_WINDOW_P (it
->f
));
20444 row
->x
= it
->last_visible_x
- new_x
;
20449 /* Glyph is completely off the left margin of the
20450 window. This should not happen because of the
20451 move_it_in_display_line at the start of this
20452 function, unless the text display area of the
20453 window is empty. */
20454 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20457 /* Even if this display element produced no glyphs at all,
20458 we want to record its position. */
20459 if (it
->bidi_p
&& nglyphs
== 0)
20460 RECORD_MAX_MIN_POS (it
);
20462 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20463 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20464 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20465 row
->phys_height
= max (row
->phys_height
,
20466 it
->max_phys_ascent
+ it
->max_phys_descent
);
20467 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20468 it
->max_extra_line_spacing
);
20470 /* End of this display line if row is continued. */
20471 if (row
->continued_p
|| row
->ends_at_zv_p
)
20476 /* Is this a line end? If yes, we're also done, after making
20477 sure that a non-default face is extended up to the right
20478 margin of the window. */
20479 if (ITERATOR_AT_END_OF_LINE_P (it
))
20481 int used_before
= row
->used
[TEXT_AREA
];
20483 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20485 /* Add a space at the end of the line that is used to
20486 display the cursor there. */
20487 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20488 append_space_for_newline (it
, false);
20490 /* Extend the face to the end of the line. */
20491 extend_face_to_end_of_line (it
);
20493 /* Make sure we have the position. */
20494 if (used_before
== 0)
20495 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20497 /* Record the position of the newline, for use in
20499 it
->eol_pos
= it
->current
.pos
;
20501 /* Consume the line end. This skips over invisible lines. */
20502 set_iterator_to_next (it
, true);
20503 it
->continuation_lines_width
= 0;
20507 /* Proceed with next display element. Note that this skips
20508 over lines invisible because of selective display. */
20509 set_iterator_to_next (it
, true);
20511 /* If we truncate lines, we are done when the last displayed
20512 glyphs reach past the right margin of the window. */
20513 if (it
->line_wrap
== TRUNCATE
20514 && ((FRAME_WINDOW_P (it
->f
)
20515 /* Images are preprocessed in produce_image_glyph such
20516 that they are cropped at the right edge of the
20517 window, so an image glyph will always end exactly at
20518 last_visible_x, even if there's no right fringe. */
20519 && ((row
->reversed_p
20520 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20521 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20522 || it
->what
== IT_IMAGE
))
20523 ? (it
->current_x
>= it
->last_visible_x
)
20524 : (it
->current_x
> it
->last_visible_x
)))
20526 /* Maybe add truncation glyphs. */
20527 if (!FRAME_WINDOW_P (it
->f
)
20528 || (row
->reversed_p
20529 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20530 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20534 if (!row
->reversed_p
)
20536 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20537 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20542 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20543 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20545 /* Remove any padding glyphs at the front of ROW, to
20546 make room for the truncation glyphs we will be
20547 adding below. The loop below always inserts at
20548 least one truncation glyph, so also remove the
20549 last glyph added to ROW. */
20550 unproduce_glyphs (it
, i
+ 1);
20551 /* Adjust i for the loop below. */
20552 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20555 /* produce_special_glyphs overwrites the last glyph, so
20556 we don't want that if we want to keep that last
20557 glyph, which means it's an image. */
20558 if (it
->current_x
> it
->last_visible_x
)
20560 it
->current_x
= x_before
;
20561 if (!FRAME_WINDOW_P (it
->f
))
20563 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20565 row
->used
[TEXT_AREA
] = i
;
20566 produce_special_glyphs (it
, IT_TRUNCATION
);
20571 row
->used
[TEXT_AREA
] = i
;
20572 produce_special_glyphs (it
, IT_TRUNCATION
);
20574 it
->hpos
= hpos_before
;
20577 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20579 /* Don't truncate if we can overflow newline into fringe. */
20580 if (!get_next_display_element (it
))
20582 it
->continuation_lines_width
= 0;
20583 row
->ends_at_zv_p
= true;
20584 row
->exact_window_width_line_p
= true;
20587 if (ITERATOR_AT_END_OF_LINE_P (it
))
20589 row
->exact_window_width_line_p
= true;
20590 goto at_end_of_line
;
20592 it
->current_x
= x_before
;
20593 it
->hpos
= hpos_before
;
20596 row
->truncated_on_right_p
= true;
20597 it
->continuation_lines_width
= 0;
20598 reseat_at_next_visible_line_start (it
, false);
20599 /* We insist below that IT's position be at ZV because in
20600 bidi-reordered lines the character at visible line start
20601 might not be the character that follows the newline in
20602 the logical order. */
20603 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20604 row
->ends_at_zv_p
=
20605 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20607 row
->ends_at_zv_p
= false;
20613 bidi_unshelve_cache (wrap_data
, true);
20615 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20616 at the left window margin. */
20617 if (it
->first_visible_x
20618 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20620 if (!FRAME_WINDOW_P (it
->f
)
20621 || (((row
->reversed_p
20622 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20623 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20624 /* Don't let insert_left_trunc_glyphs overwrite the
20625 first glyph of the row if it is an image. */
20626 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20627 insert_left_trunc_glyphs (it
);
20628 row
->truncated_on_left_p
= true;
20631 /* Remember the position at which this line ends.
20633 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20634 cannot be before the call to find_row_edges below, since that is
20635 where these positions are determined. */
20636 row
->end
= it
->current
;
20639 row
->minpos
= row
->start
.pos
;
20640 row
->maxpos
= row
->end
.pos
;
20644 /* ROW->minpos and ROW->maxpos must be the smallest and
20645 `1 + the largest' buffer positions in ROW. But if ROW was
20646 bidi-reordered, these two positions can be anywhere in the
20647 row, so we must determine them now. */
20648 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20651 /* If the start of this line is the overlay arrow-position, then
20652 mark this glyph row as the one containing the overlay arrow.
20653 This is clearly a mess with variable size fonts. It would be
20654 better to let it be displayed like cursors under X. */
20655 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20656 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20657 !NILP (overlay_arrow_string
)))
20659 /* Overlay arrow in window redisplay is a fringe bitmap. */
20660 if (STRINGP (overlay_arrow_string
))
20662 struct glyph_row
*arrow_row
20663 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20664 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20665 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20666 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20667 struct glyph
*p2
, *end
;
20669 /* Copy the arrow glyphs. */
20670 while (glyph
< arrow_end
)
20673 /* Throw away padding glyphs. */
20675 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20676 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20682 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20687 eassert (INTEGERP (overlay_arrow_string
));
20688 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20690 overlay_arrow_seen
= true;
20693 /* Highlight trailing whitespace. */
20694 if (!NILP (Vshow_trailing_whitespace
))
20695 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20697 /* Compute pixel dimensions of this line. */
20698 compute_line_metrics (it
);
20700 /* Implementation note: No changes in the glyphs of ROW or in their
20701 faces can be done past this point, because compute_line_metrics
20702 computes ROW's hash value and stores it within the glyph_row
20705 /* Record whether this row ends inside an ellipsis. */
20706 row
->ends_in_ellipsis_p
20707 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20708 && it
->ellipsis_p
);
20710 /* Save fringe bitmaps in this row. */
20711 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20712 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20713 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20714 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20716 it
->left_user_fringe_bitmap
= 0;
20717 it
->left_user_fringe_face_id
= 0;
20718 it
->right_user_fringe_bitmap
= 0;
20719 it
->right_user_fringe_face_id
= 0;
20721 /* Maybe set the cursor. */
20722 cvpos
= it
->w
->cursor
.vpos
;
20724 /* In bidi-reordered rows, keep checking for proper cursor
20725 position even if one has been found already, because buffer
20726 positions in such rows change non-linearly with ROW->VPOS,
20727 when a line is continued. One exception: when we are at ZV,
20728 display cursor on the first suitable glyph row, since all
20729 the empty rows after that also have their position set to ZV. */
20730 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20731 lines' rows is implemented for bidi-reordered rows. */
20733 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20734 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20735 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20736 && cursor_row_p (row
))
20737 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20739 /* Prepare for the next line. This line starts horizontally at (X
20740 HPOS) = (0 0). Vertical positions are incremented. As a
20741 convenience for the caller, IT->glyph_row is set to the next
20743 it
->current_x
= it
->hpos
= 0;
20744 it
->current_y
+= row
->height
;
20745 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20748 /* The next row should by default use the same value of the
20749 reversed_p flag as this one. set_iterator_to_next decides when
20750 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20751 the flag accordingly. */
20752 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20753 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20754 it
->start
= row
->end
;
20755 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20757 #undef RECORD_MAX_MIN_POS
20760 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20761 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20762 doc
: /* Return paragraph direction at point in BUFFER.
20763 Value is either `left-to-right' or `right-to-left'.
20764 If BUFFER is omitted or nil, it defaults to the current buffer.
20766 Paragraph direction determines how the text in the paragraph is displayed.
20767 In left-to-right paragraphs, text begins at the left margin of the window
20768 and the reading direction is generally left to right. In right-to-left
20769 paragraphs, text begins at the right margin and is read from right to left.
20771 See also `bidi-paragraph-direction'. */)
20772 (Lisp_Object buffer
)
20774 struct buffer
*buf
= current_buffer
;
20775 struct buffer
*old
= buf
;
20777 if (! NILP (buffer
))
20779 CHECK_BUFFER (buffer
);
20780 buf
= XBUFFER (buffer
);
20783 if (NILP (BVAR (buf
, bidi_display_reordering
))
20784 || NILP (BVAR (buf
, enable_multibyte_characters
))
20785 /* When we are loading loadup.el, the character property tables
20786 needed for bidi iteration are not yet available. */
20787 || !NILP (Vpurify_flag
))
20788 return Qleft_to_right
;
20789 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20790 return BVAR (buf
, bidi_paragraph_direction
);
20793 /* Determine the direction from buffer text. We could try to
20794 use current_matrix if it is up to date, but this seems fast
20795 enough as it is. */
20796 struct bidi_it itb
;
20797 ptrdiff_t pos
= BUF_PT (buf
);
20798 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20800 void *itb_data
= bidi_shelve_cache ();
20802 set_buffer_temp (buf
);
20803 /* bidi_paragraph_init finds the base direction of the paragraph
20804 by searching forward from paragraph start. We need the base
20805 direction of the current or _previous_ paragraph, so we need
20806 to make sure we are within that paragraph. To that end, find
20807 the previous non-empty line. */
20808 if (pos
>= ZV
&& pos
> BEGV
)
20809 DEC_BOTH (pos
, bytepos
);
20810 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20811 if (fast_looking_at (trailing_white_space
,
20812 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20814 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20815 || c
== ' ' || c
== '\t' || c
== '\f')
20817 if (bytepos
<= BEGV_BYTE
)
20822 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20825 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20826 itb
.paragraph_dir
= NEUTRAL_DIR
;
20827 itb
.string
.s
= NULL
;
20828 itb
.string
.lstring
= Qnil
;
20829 itb
.string
.bufpos
= 0;
20830 itb
.string
.from_disp_str
= false;
20831 itb
.string
.unibyte
= false;
20832 /* We have no window to use here for ignoring window-specific
20833 overlays. Using NULL for window pointer will cause
20834 compute_display_string_pos to use the current buffer. */
20836 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
20837 bidi_unshelve_cache (itb_data
, false);
20838 set_buffer_temp (old
);
20839 switch (itb
.paragraph_dir
)
20842 return Qleft_to_right
;
20845 return Qright_to_left
;
20853 DEFUN ("bidi-find-overridden-directionality",
20854 Fbidi_find_overridden_directionality
,
20855 Sbidi_find_overridden_directionality
, 2, 3, 0,
20856 doc
: /* Return position between FROM and TO where directionality was overridden.
20858 This function returns the first character position in the specified
20859 region of OBJECT where there is a character whose `bidi-class' property
20860 is `L', but which was forced to display as `R' by a directional
20861 override, and likewise with characters whose `bidi-class' is `R'
20862 or `AL' that were forced to display as `L'.
20864 If no such character is found, the function returns nil.
20866 OBJECT is a Lisp string or buffer to search for overridden
20867 directionality, and defaults to the current buffer if nil or omitted.
20868 OBJECT can also be a window, in which case the function will search
20869 the buffer displayed in that window. Passing the window instead of
20870 a buffer is preferable when the buffer is displayed in some window,
20871 because this function will then be able to correctly account for
20872 window-specific overlays, which can affect the results.
20874 Strong directional characters `L', `R', and `AL' can have their
20875 intrinsic directionality overridden by directional override
20876 control characters RLO \(u+202e) and LRO \(u+202d). See the
20877 function `get-char-code-property' for a way to inquire about
20878 the `bidi-class' property of a character. */)
20879 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
20881 struct buffer
*buf
= current_buffer
;
20882 struct buffer
*old
= buf
;
20883 struct window
*w
= NULL
;
20884 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
20885 struct bidi_it itb
;
20886 ptrdiff_t from_pos
, to_pos
, from_bpos
;
20889 if (!NILP (object
))
20891 if (BUFFERP (object
))
20892 buf
= XBUFFER (object
);
20893 else if (WINDOWP (object
))
20895 w
= decode_live_window (object
);
20896 buf
= XBUFFER (w
->contents
);
20897 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
20900 CHECK_STRING (object
);
20903 if (STRINGP (object
))
20905 /* Characters in unibyte strings are always treated by bidi.c as
20907 if (!STRING_MULTIBYTE (object
)
20908 /* When we are loading loadup.el, the character property
20909 tables needed for bidi iteration are not yet
20911 || !NILP (Vpurify_flag
))
20914 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
20915 if (from_pos
>= SCHARS (object
))
20918 /* Set up the bidi iterator. */
20919 itb_data
= bidi_shelve_cache ();
20920 itb
.paragraph_dir
= NEUTRAL_DIR
;
20921 itb
.string
.lstring
= object
;
20922 itb
.string
.s
= NULL
;
20923 itb
.string
.schars
= SCHARS (object
);
20924 itb
.string
.bufpos
= 0;
20925 itb
.string
.from_disp_str
= false;
20926 itb
.string
.unibyte
= false;
20928 bidi_init_it (0, 0, frame_window_p
, &itb
);
20932 /* Nothing this fancy can happen in unibyte buffers, or in a
20933 buffer that disabled reordering, or if FROM is at EOB. */
20934 if (NILP (BVAR (buf
, bidi_display_reordering
))
20935 || NILP (BVAR (buf
, enable_multibyte_characters
))
20936 /* When we are loading loadup.el, the character property
20937 tables needed for bidi iteration are not yet
20939 || !NILP (Vpurify_flag
))
20942 set_buffer_temp (buf
);
20943 validate_region (&from
, &to
);
20944 from_pos
= XINT (from
);
20945 to_pos
= XINT (to
);
20946 if (from_pos
>= ZV
)
20949 /* Set up the bidi iterator. */
20950 itb_data
= bidi_shelve_cache ();
20951 from_bpos
= CHAR_TO_BYTE (from_pos
);
20952 if (from_pos
== BEGV
)
20954 itb
.charpos
= BEGV
;
20955 itb
.bytepos
= BEGV_BYTE
;
20957 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
20959 itb
.charpos
= from_pos
;
20960 itb
.bytepos
= from_bpos
;
20963 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
20965 itb
.paragraph_dir
= NEUTRAL_DIR
;
20966 itb
.string
.s
= NULL
;
20967 itb
.string
.lstring
= Qnil
;
20968 itb
.string
.bufpos
= 0;
20969 itb
.string
.from_disp_str
= false;
20970 itb
.string
.unibyte
= false;
20972 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
20977 /* For the purposes of this function, the actual base direction of
20978 the paragraph doesn't matter, so just set it to L2R. */
20979 bidi_paragraph_init (L2R
, &itb
, false);
20980 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
20982 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
20984 bidi_unshelve_cache (itb_data
, false);
20985 set_buffer_temp (old
);
20987 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
20990 DEFUN ("move-point-visually", Fmove_point_visually
,
20991 Smove_point_visually
, 1, 1, 0,
20992 doc
: /* Move point in the visual order in the specified DIRECTION.
20993 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20996 Value is the new character position of point. */)
20997 (Lisp_Object direction
)
20999 struct window
*w
= XWINDOW (selected_window
);
21000 struct buffer
*b
= XBUFFER (w
->contents
);
21001 struct glyph_row
*row
;
21003 Lisp_Object paragraph_dir
;
21005 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21006 (!(ROW)->continued_p \
21007 && NILP ((GLYPH)->object) \
21008 && (GLYPH)->type == CHAR_GLYPH \
21009 && (GLYPH)->u.ch == ' ' \
21010 && (GLYPH)->charpos >= 0 \
21011 && !(GLYPH)->avoid_cursor_p)
21013 CHECK_NUMBER (direction
);
21014 dir
= XINT (direction
);
21020 /* If current matrix is up-to-date, we can use the information
21021 recorded in the glyphs, at least as long as the goal is on the
21023 if (w
->window_end_valid
21024 && !windows_or_buffers_changed
21026 && !b
->clip_changed
21027 && !b
->prevent_redisplay_optimizations_p
21028 && !window_outdated (w
)
21029 /* We rely below on the cursor coordinates to be up to date, but
21030 we cannot trust them if some command moved point since the
21031 last complete redisplay. */
21032 && w
->last_point
== BUF_PT (b
)
21033 && w
->cursor
.vpos
>= 0
21034 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21035 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21037 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21038 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21039 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21041 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21043 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21045 SET_PT (g
->charpos
);
21046 w
->cursor
.vpos
= -1;
21047 return make_number (PT
);
21049 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21053 if (BUFFERP (gpt
->object
))
21056 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21057 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21059 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21061 else if (BUFFERP (g
->object
))
21062 new_pos
= g
->charpos
;
21066 w
->cursor
.vpos
= -1;
21067 return make_number (PT
);
21069 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21071 /* Glyphs inserted at the end of a non-empty line for
21072 positioning the cursor have zero charpos, so we must
21073 deduce the value of point by other means. */
21074 if (g
->charpos
> 0)
21075 SET_PT (g
->charpos
);
21076 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21078 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21079 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21082 w
->cursor
.vpos
= -1;
21083 return make_number (PT
);
21086 if (g
== e
|| NILP (g
->object
))
21088 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21089 goto simulate_display
;
21090 if (!row
->reversed_p
)
21094 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21095 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21096 goto simulate_display
;
21100 if (row
->reversed_p
&& !row
->continued_p
)
21102 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21103 w
->cursor
.vpos
= -1;
21104 return make_number (PT
);
21106 g
= row
->glyphs
[TEXT_AREA
];
21107 e
= g
+ row
->used
[TEXT_AREA
];
21108 for ( ; g
< e
; g
++)
21110 if (BUFFERP (g
->object
)
21111 /* Empty lines have only one glyph, which stands
21112 for the newline, and whose charpos is the
21113 buffer position of the newline. */
21114 || ROW_GLYPH_NEWLINE_P (row
, g
)
21115 /* When the buffer ends in a newline, the line at
21116 EOB also has one glyph, but its charpos is -1. */
21117 || (row
->ends_at_zv_p
21118 && !row
->reversed_p
21119 && NILP (g
->object
)
21120 && g
->type
== CHAR_GLYPH
21121 && g
->u
.ch
== ' '))
21123 if (g
->charpos
> 0)
21124 SET_PT (g
->charpos
);
21125 else if (!row
->reversed_p
21126 && row
->ends_at_zv_p
21131 w
->cursor
.vpos
= -1;
21132 return make_number (PT
);
21138 if (!row
->reversed_p
&& !row
->continued_p
)
21140 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21141 w
->cursor
.vpos
= -1;
21142 return make_number (PT
);
21144 e
= row
->glyphs
[TEXT_AREA
];
21145 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21146 for ( ; g
>= e
; g
--)
21148 if (BUFFERP (g
->object
)
21149 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21151 /* Empty R2L lines on GUI frames have the buffer
21152 position of the newline stored in the stretch
21154 || g
->type
== STRETCH_GLYPH
21155 || (row
->ends_at_zv_p
21157 && NILP (g
->object
)
21158 && g
->type
== CHAR_GLYPH
21159 && g
->u
.ch
== ' '))
21161 if (g
->charpos
> 0)
21162 SET_PT (g
->charpos
);
21163 else if (row
->reversed_p
21164 && row
->ends_at_zv_p
21169 w
->cursor
.vpos
= -1;
21170 return make_number (PT
);
21179 /* If we wind up here, we failed to move by using the glyphs, so we
21180 need to simulate display instead. */
21183 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21185 paragraph_dir
= Qleft_to_right
;
21186 if (EQ (paragraph_dir
, Qright_to_left
))
21188 if (PT
<= BEGV
&& dir
< 0)
21189 xsignal0 (Qbeginning_of_buffer
);
21190 else if (PT
>= ZV
&& dir
> 0)
21191 xsignal0 (Qend_of_buffer
);
21194 struct text_pos pt
;
21196 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21198 bool overshoot_expected
= false;
21199 bool target_is_eol_p
= false;
21201 /* Setup the arena. */
21202 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21203 start_display (&it
, w
, pt
);
21205 if (it
.cmp_it
.id
< 0
21206 && it
.method
== GET_FROM_STRING
21207 && it
.area
== TEXT_AREA
21208 && it
.string_from_display_prop_p
21209 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21210 overshoot_expected
= true;
21212 /* Find the X coordinate of point. We start from the beginning
21213 of this or previous line to make sure we are before point in
21214 the logical order (since the move_it_* functions can only
21217 reseat_at_previous_visible_line_start (&it
);
21218 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21219 if (IT_CHARPOS (it
) != PT
)
21221 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21222 -1, -1, -1, MOVE_TO_POS
);
21223 /* If we missed point because the character there is
21224 displayed out of a display vector that has more than one
21225 glyph, retry expecting overshoot. */
21226 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21227 && it
.current
.dpvec_index
> 0
21228 && !overshoot_expected
)
21230 overshoot_expected
= true;
21233 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21234 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21236 pt_x
= it
.current_x
;
21238 if (dir
> 0 || overshoot_expected
)
21240 struct glyph_row
*row
= it
.glyph_row
;
21242 /* When point is at beginning of line, we don't have
21243 information about the glyph there loaded into struct
21244 it. Calling get_next_display_element fixes that. */
21246 get_next_display_element (&it
);
21247 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21248 it
.glyph_row
= NULL
;
21249 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21250 it
.glyph_row
= row
;
21251 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21252 it, lest it will become out of sync with it's buffer
21254 it
.current_x
= pt_x
;
21257 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21258 pixel_width
= it
.pixel_width
;
21259 if (overshoot_expected
&& at_eol_p
)
21261 else if (pixel_width
<= 0)
21264 /* If there's a display string (or something similar) at point,
21265 we are actually at the glyph to the left of point, so we need
21266 to correct the X coordinate. */
21267 if (overshoot_expected
)
21270 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21272 pt_x
+= pixel_width
;
21275 /* Compute target X coordinate, either to the left or to the
21276 right of point. On TTY frames, all characters have the same
21277 pixel width of 1, so we can use that. On GUI frames we don't
21278 have an easy way of getting at the pixel width of the
21279 character to the left of point, so we use a different method
21280 of getting to that place. */
21282 target_x
= pt_x
+ pixel_width
;
21284 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21286 /* Target X coordinate could be one line above or below the line
21287 of point, in which case we need to adjust the target X
21288 coordinate. Also, if moving to the left, we need to begin at
21289 the left edge of the point's screen line. */
21294 start_display (&it
, w
, pt
);
21295 reseat_at_previous_visible_line_start (&it
);
21296 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21298 move_it_by_lines (&it
, pt_vpos
);
21302 move_it_by_lines (&it
, -1);
21303 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21304 target_is_eol_p
= true;
21305 /* Under word-wrap, we don't know the x coordinate of
21306 the last character displayed on the previous line,
21307 which immediately precedes the wrap point. To find
21308 out its x coordinate, we try moving to the right
21309 margin of the window, which will stop at the wrap
21310 point, and then reset target_x to point at the
21311 character that precedes the wrap point. This is not
21312 needed on GUI frames, because (see below) there we
21313 move from the left margin one grapheme cluster at a
21314 time, and stop when we hit the wrap point. */
21315 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21317 void *it_data
= NULL
;
21320 SAVE_IT (it2
, it
, it_data
);
21321 move_it_in_display_line_to (&it
, ZV
, target_x
,
21322 MOVE_TO_POS
| MOVE_TO_X
);
21323 /* If we arrived at target_x, that _is_ the last
21324 character on the previous line. */
21325 if (it
.current_x
!= target_x
)
21326 target_x
= it
.current_x
- 1;
21327 RESTORE_IT (&it
, &it2
, it_data
);
21334 || (target_x
>= it
.last_visible_x
21335 && it
.line_wrap
!= TRUNCATE
))
21338 move_it_by_lines (&it
, 0);
21339 move_it_by_lines (&it
, 1);
21344 /* Move to the target X coordinate. */
21345 #ifdef HAVE_WINDOW_SYSTEM
21346 /* On GUI frames, as we don't know the X coordinate of the
21347 character to the left of point, moving point to the left
21348 requires walking, one grapheme cluster at a time, until we
21349 find ourself at a place immediately to the left of the
21350 character at point. */
21351 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21353 struct text_pos new_pos
;
21354 enum move_it_result rc
= MOVE_X_REACHED
;
21356 if (it
.current_x
== 0)
21357 get_next_display_element (&it
);
21358 if (it
.what
== IT_COMPOSITION
)
21360 new_pos
.charpos
= it
.cmp_it
.charpos
;
21361 new_pos
.bytepos
= -1;
21364 new_pos
= it
.current
.pos
;
21366 while (it
.current_x
+ it
.pixel_width
<= target_x
21367 && (rc
== MOVE_X_REACHED
21368 /* Under word-wrap, move_it_in_display_line_to
21369 stops at correct coordinates, but sometimes
21370 returns MOVE_POS_MATCH_OR_ZV. */
21371 || (it
.line_wrap
== WORD_WRAP
21372 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21374 int new_x
= it
.current_x
+ it
.pixel_width
;
21376 /* For composed characters, we want the position of the
21377 first character in the grapheme cluster (usually, the
21378 composition's base character), whereas it.current
21379 might give us the position of the _last_ one, e.g. if
21380 the composition is rendered in reverse due to bidi
21382 if (it
.what
== IT_COMPOSITION
)
21384 new_pos
.charpos
= it
.cmp_it
.charpos
;
21385 new_pos
.bytepos
= -1;
21388 new_pos
= it
.current
.pos
;
21389 if (new_x
== it
.current_x
)
21391 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21392 MOVE_TO_POS
| MOVE_TO_X
);
21393 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21396 /* The previous position we saw in the loop is the one we
21398 if (new_pos
.bytepos
== -1)
21399 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21400 it
.current
.pos
= new_pos
;
21404 if (it
.current_x
!= target_x
)
21405 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21407 /* When lines are truncated, the above loop will stop at the
21408 window edge. But we want to get to the end of line, even if
21409 it is beyond the window edge; automatic hscroll will then
21410 scroll the window to show point as appropriate. */
21411 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21412 && get_next_display_element (&it
))
21414 struct text_pos new_pos
= it
.current
.pos
;
21416 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21418 set_iterator_to_next (&it
, false);
21419 if (it
.method
== GET_FROM_BUFFER
)
21420 new_pos
= it
.current
.pos
;
21421 if (!get_next_display_element (&it
))
21425 it
.current
.pos
= new_pos
;
21428 /* If we ended up in a display string that covers point, move to
21429 buffer position to the right in the visual order. */
21432 while (IT_CHARPOS (it
) == PT
)
21434 set_iterator_to_next (&it
, false);
21435 if (!get_next_display_element (&it
))
21440 /* Move point to that position. */
21441 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21444 return make_number (PT
);
21446 #undef ROW_GLYPH_NEWLINE_P
21449 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21450 Sbidi_resolved_levels
, 0, 1, 0,
21451 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21453 The resolved levels are produced by the Emacs bidi reordering engine
21454 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21455 read the Unicode Standard Annex 9 (UAX#9) for background information
21456 about these levels.
21458 VPOS is the zero-based number of the current window's screen line
21459 for which to produce the resolved levels. If VPOS is nil or omitted,
21460 it defaults to the screen line of point. If the window displays a
21461 header line, VPOS of zero will report on the header line, and first
21462 line of text in the window will have VPOS of 1.
21464 Value is an array of resolved levels, indexed by glyph number.
21465 Glyphs are numbered from zero starting from the beginning of the
21466 screen line, i.e. the left edge of the window for left-to-right lines
21467 and from the right edge for right-to-left lines. The resolved levels
21468 are produced only for the window's text area; text in display margins
21471 If the selected window's display is not up-to-date, or if the specified
21472 screen line does not display text, this function returns nil. It is
21473 highly recommended to bind this function to some simple key, like F8,
21474 in order to avoid these problems.
21476 This function exists mainly for testing the correctness of the
21477 Emacs UBA implementation, in particular with the test suite. */)
21480 struct window
*w
= XWINDOW (selected_window
);
21481 struct buffer
*b
= XBUFFER (w
->contents
);
21483 struct glyph_row
*row
;
21487 int d1
, d2
, d3
, d4
, d5
;
21489 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21493 CHECK_NUMBER_COERCE_MARKER (vpos
);
21494 nrow
= XINT (vpos
);
21497 /* We require up-to-date glyph matrix for this window. */
21498 if (w
->window_end_valid
21499 && !windows_or_buffers_changed
21501 && !b
->clip_changed
21502 && !b
->prevent_redisplay_optimizations_p
21503 && !window_outdated (w
)
21505 && nrow
< w
->current_matrix
->nrows
21506 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21507 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21509 struct glyph
*g
, *e
, *g1
;
21511 Lisp_Object levels
;
21513 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21515 g
= g1
= row
->glyphs
[TEXT_AREA
];
21516 e
= g
+ row
->used
[TEXT_AREA
];
21518 /* Skip over glyphs at the start of the row that was
21519 generated by redisplay for its own needs. */
21521 && NILP (g
->object
)
21526 /* Count the "interesting" glyphs in this row. */
21527 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21530 /* Create and fill the array. */
21531 levels
= make_uninit_vector (nglyphs
);
21532 for (i
= 0; g1
< g
; i
++, g1
++)
21533 ASET (levels
, i
, make_number (g1
->resolved_level
));
21535 else /* Right-to-left glyph row. */
21537 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21538 e
= row
->glyphs
[TEXT_AREA
] - 1;
21540 && NILP (g
->object
)
21544 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21546 levels
= make_uninit_vector (nglyphs
);
21547 for (i
= 0; g1
> g
; i
++, g1
--)
21548 ASET (levels
, i
, make_number (g1
->resolved_level
));
21558 /***********************************************************************
21560 ***********************************************************************/
21562 /* Redisplay the menu bar in the frame for window W.
21564 The menu bar of X frames that don't have X toolkit support is
21565 displayed in a special window W->frame->menu_bar_window.
21567 The menu bar of terminal frames is treated specially as far as
21568 glyph matrices are concerned. Menu bar lines are not part of
21569 windows, so the update is done directly on the frame matrix rows
21570 for the menu bar. */
21573 display_menu_bar (struct window
*w
)
21575 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21580 /* Don't do all this for graphical frames. */
21582 if (FRAME_W32_P (f
))
21585 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21591 if (FRAME_NS_P (f
))
21593 #endif /* HAVE_NS */
21595 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21596 eassert (!FRAME_WINDOW_P (f
));
21597 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21598 it
.first_visible_x
= 0;
21599 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21600 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21601 if (FRAME_WINDOW_P (f
))
21603 /* Menu bar lines are displayed in the desired matrix of the
21604 dummy window menu_bar_window. */
21605 struct window
*menu_w
;
21606 menu_w
= XWINDOW (f
->menu_bar_window
);
21607 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21609 it
.first_visible_x
= 0;
21610 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21613 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21615 /* This is a TTY frame, i.e. character hpos/vpos are used as
21617 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21619 it
.first_visible_x
= 0;
21620 it
.last_visible_x
= FRAME_COLS (f
);
21623 /* FIXME: This should be controlled by a user option. See the
21624 comments in redisplay_tool_bar and display_mode_line about
21626 it
.paragraph_embedding
= L2R
;
21628 /* Clear all rows of the menu bar. */
21629 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21631 struct glyph_row
*row
= it
.glyph_row
+ i
;
21632 clear_glyph_row (row
);
21633 row
->enabled_p
= true;
21634 row
->full_width_p
= true;
21635 row
->reversed_p
= false;
21638 /* Display all items of the menu bar. */
21639 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21640 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21642 Lisp_Object string
;
21644 /* Stop at nil string. */
21645 string
= AREF (items
, i
+ 1);
21649 /* Remember where item was displayed. */
21650 ASET (items
, i
+ 3, make_number (it
.hpos
));
21652 /* Display the item, pad with one space. */
21653 if (it
.current_x
< it
.last_visible_x
)
21654 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21655 SCHARS (string
) + 1, 0, 0, -1);
21658 /* Fill out the line with spaces. */
21659 if (it
.current_x
< it
.last_visible_x
)
21660 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21662 /* Compute the total height of the lines. */
21663 compute_line_metrics (&it
);
21666 /* Deep copy of a glyph row, including the glyphs. */
21668 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21670 struct glyph
*pointers
[1 + LAST_AREA
];
21671 int to_used
= to
->used
[TEXT_AREA
];
21673 /* Save glyph pointers of TO. */
21674 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21676 /* Do a structure assignment. */
21679 /* Restore original glyph pointers of TO. */
21680 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21682 /* Copy the glyphs. */
21683 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21684 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21686 /* If we filled only part of the TO row, fill the rest with
21687 space_glyph (which will display as empty space). */
21688 if (to_used
> from
->used
[TEXT_AREA
])
21689 fill_up_frame_row_with_spaces (to
, to_used
);
21692 /* Display one menu item on a TTY, by overwriting the glyphs in the
21693 frame F's desired glyph matrix with glyphs produced from the menu
21694 item text. Called from term.c to display TTY drop-down menus one
21697 ITEM_TEXT is the menu item text as a C string.
21699 FACE_ID is the face ID to be used for this menu item. FACE_ID
21700 could specify one of 3 faces: a face for an enabled item, a face
21701 for a disabled item, or a face for a selected item.
21703 X and Y are coordinates of the first glyph in the frame's desired
21704 matrix to be overwritten by the menu item. Since this is a TTY, Y
21705 is the zero-based number of the glyph row and X is the zero-based
21706 glyph number in the row, starting from left, where to start
21707 displaying the item.
21709 SUBMENU means this menu item drops down a submenu, which
21710 should be indicated by displaying a proper visual cue after the
21714 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21715 int x
, int y
, bool submenu
)
21718 struct frame
*f
= SELECTED_FRAME ();
21719 struct window
*w
= XWINDOW (f
->selected_window
);
21720 struct glyph_row
*row
;
21721 size_t item_len
= strlen (item_text
);
21723 eassert (FRAME_TERMCAP_P (f
));
21725 /* Don't write beyond the matrix's last row. This can happen for
21726 TTY screens that are not high enough to show the entire menu.
21727 (This is actually a bit of defensive programming, as
21728 tty_menu_display already limits the number of menu items to one
21729 less than the number of screen lines.) */
21730 if (y
>= f
->desired_matrix
->nrows
)
21733 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21734 it
.first_visible_x
= 0;
21735 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21736 row
= it
.glyph_row
;
21737 /* Start with the row contents from the current matrix. */
21738 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21739 bool saved_width
= row
->full_width_p
;
21740 row
->full_width_p
= true;
21741 bool saved_reversed
= row
->reversed_p
;
21742 row
->reversed_p
= false;
21743 row
->enabled_p
= true;
21745 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21747 eassert (x
< f
->desired_matrix
->matrix_w
);
21748 it
.current_x
= it
.hpos
= x
;
21749 it
.current_y
= it
.vpos
= y
;
21750 int saved_used
= row
->used
[TEXT_AREA
];
21751 bool saved_truncated
= row
->truncated_on_right_p
;
21752 row
->used
[TEXT_AREA
] = x
;
21753 it
.face_id
= face_id
;
21754 it
.line_wrap
= TRUNCATE
;
21756 /* FIXME: This should be controlled by a user option. See the
21757 comments in redisplay_tool_bar and display_mode_line about this.
21758 Also, if paragraph_embedding could ever be R2L, changes will be
21759 needed to avoid shifting to the right the row characters in
21760 term.c:append_glyph. */
21761 it
.paragraph_embedding
= L2R
;
21763 /* Pad with a space on the left. */
21764 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21766 /* Display the menu item, pad with spaces to WIDTH. */
21769 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21770 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21772 /* Indicate with " >" that there's a submenu. */
21773 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21774 FRAME_COLS (f
) - 1, -1);
21777 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21778 width
, 0, FRAME_COLS (f
) - 1, -1);
21780 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21781 row
->truncated_on_right_p
= saved_truncated
;
21782 row
->hash
= row_hash (row
);
21783 row
->full_width_p
= saved_width
;
21784 row
->reversed_p
= saved_reversed
;
21787 /***********************************************************************
21789 ***********************************************************************/
21791 /* Redisplay mode lines in the window tree whose root is WINDOW.
21792 If FORCE, redisplay mode lines unconditionally.
21793 Otherwise, redisplay only mode lines that are garbaged. Value is
21794 the number of windows whose mode lines were redisplayed. */
21797 redisplay_mode_lines (Lisp_Object window
, bool force
)
21801 while (!NILP (window
))
21803 struct window
*w
= XWINDOW (window
);
21805 if (WINDOWP (w
->contents
))
21806 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21808 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21809 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21811 struct text_pos lpoint
;
21812 struct buffer
*old
= current_buffer
;
21814 /* Set the window's buffer for the mode line display. */
21815 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21816 set_buffer_internal_1 (XBUFFER (w
->contents
));
21818 /* Point refers normally to the selected window. For any
21819 other window, set up appropriate value. */
21820 if (!EQ (window
, selected_window
))
21822 struct text_pos pt
;
21824 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21825 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21828 /* Display mode lines. */
21829 clear_glyph_matrix (w
->desired_matrix
);
21830 if (display_mode_lines (w
))
21833 /* Restore old settings. */
21834 set_buffer_internal_1 (old
);
21835 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21845 /* Display the mode and/or header line of window W. Value is the
21846 sum number of mode lines and header lines displayed. */
21849 display_mode_lines (struct window
*w
)
21851 Lisp_Object old_selected_window
= selected_window
;
21852 Lisp_Object old_selected_frame
= selected_frame
;
21853 Lisp_Object new_frame
= w
->frame
;
21854 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21857 selected_frame
= new_frame
;
21858 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21859 or window's point, then we'd need select_window_1 here as well. */
21860 XSETWINDOW (selected_window
, w
);
21861 XFRAME (new_frame
)->selected_window
= selected_window
;
21863 /* These will be set while the mode line specs are processed. */
21864 line_number_displayed
= false;
21865 w
->column_number_displayed
= -1;
21867 if (WINDOW_WANTS_MODELINE_P (w
))
21869 struct window
*sel_w
= XWINDOW (old_selected_window
);
21871 /* Select mode line face based on the real selected window. */
21872 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21873 BVAR (current_buffer
, mode_line_format
));
21877 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21879 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21880 BVAR (current_buffer
, header_line_format
));
21884 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21885 selected_frame
= old_selected_frame
;
21886 selected_window
= old_selected_window
;
21888 w
->must_be_updated_p
= true;
21893 /* Display mode or header line of window W. FACE_ID specifies which
21894 line to display; it is either MODE_LINE_FACE_ID or
21895 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21896 display. Value is the pixel height of the mode/header line
21900 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21904 ptrdiff_t count
= SPECPDL_INDEX ();
21906 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21907 /* Don't extend on a previously drawn mode-line.
21908 This may happen if called from pos_visible_p. */
21909 it
.glyph_row
->enabled_p
= false;
21910 prepare_desired_row (w
, it
.glyph_row
, true);
21912 it
.glyph_row
->mode_line_p
= true;
21914 /* FIXME: This should be controlled by a user option. But
21915 supporting such an option is not trivial, since the mode line is
21916 made up of many separate strings. */
21917 it
.paragraph_embedding
= L2R
;
21919 record_unwind_protect (unwind_format_mode_line
,
21920 format_mode_line_unwind_data (NULL
, NULL
,
21923 mode_line_target
= MODE_LINE_DISPLAY
;
21925 /* Temporarily make frame's keyboard the current kboard so that
21926 kboard-local variables in the mode_line_format will get the right
21928 push_kboard (FRAME_KBOARD (it
.f
));
21929 record_unwind_save_match_data ();
21930 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
21933 unbind_to (count
, Qnil
);
21935 /* Fill up with spaces. */
21936 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21938 compute_line_metrics (&it
);
21939 it
.glyph_row
->full_width_p
= true;
21940 it
.glyph_row
->continued_p
= false;
21941 it
.glyph_row
->truncated_on_left_p
= false;
21942 it
.glyph_row
->truncated_on_right_p
= false;
21944 /* Make a 3D mode-line have a shadow at its right end. */
21945 face
= FACE_FROM_ID (it
.f
, face_id
);
21946 extend_face_to_end_of_line (&it
);
21947 if (face
->box
!= FACE_NO_BOX
)
21949 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21950 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21951 last
->right_box_line_p
= true;
21954 return it
.glyph_row
->height
;
21957 /* Move element ELT in LIST to the front of LIST.
21958 Return the updated list. */
21961 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21963 register Lisp_Object tail
, prev
;
21964 register Lisp_Object tem
;
21968 while (CONSP (tail
))
21974 /* Splice out the link TAIL. */
21976 list
= XCDR (tail
);
21978 Fsetcdr (prev
, XCDR (tail
));
21980 /* Now make it the first. */
21981 Fsetcdr (tail
, list
);
21986 tail
= XCDR (tail
);
21990 /* Not found--return unchanged LIST. */
21994 /* Contribute ELT to the mode line for window IT->w. How it
21995 translates into text depends on its data type.
21997 IT describes the display environment in which we display, as usual.
21999 DEPTH is the depth in recursion. It is used to prevent
22000 infinite recursion here.
22002 FIELD_WIDTH is the number of characters the display of ELT should
22003 occupy in the mode line, and PRECISION is the maximum number of
22004 characters to display from ELT's representation. See
22005 display_string for details.
22007 Returns the hpos of the end of the text generated by ELT.
22009 PROPS is a property list to add to any string we encounter.
22011 If RISKY, remove (disregard) any properties in any string
22012 we encounter, and ignore :eval and :propertize.
22014 The global variable `mode_line_target' determines whether the
22015 output is passed to `store_mode_line_noprop',
22016 `store_mode_line_string', or `display_string'. */
22019 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22020 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22022 int n
= 0, field
, prec
;
22023 bool literal
= false;
22027 elt
= build_string ("*too-deep*");
22031 switch (XTYPE (elt
))
22035 /* A string: output it and check for %-constructs within it. */
22037 ptrdiff_t offset
= 0;
22039 if (SCHARS (elt
) > 0
22040 && (!NILP (props
) || risky
))
22042 Lisp_Object oprops
, aelt
;
22043 oprops
= Ftext_properties_at (make_number (0), elt
);
22045 /* If the starting string's properties are not what
22046 we want, translate the string. Also, if the string
22047 is risky, do that anyway. */
22049 if (NILP (Fequal (props
, oprops
)) || risky
)
22051 /* If the starting string has properties,
22052 merge the specified ones onto the existing ones. */
22053 if (! NILP (oprops
) && !risky
)
22057 oprops
= Fcopy_sequence (oprops
);
22059 while (CONSP (tem
))
22061 oprops
= Fplist_put (oprops
, XCAR (tem
),
22062 XCAR (XCDR (tem
)));
22063 tem
= XCDR (XCDR (tem
));
22068 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22069 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22071 /* AELT is what we want. Move it to the front
22072 without consing. */
22074 mode_line_proptrans_alist
22075 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22081 /* If AELT has the wrong props, it is useless.
22082 so get rid of it. */
22084 mode_line_proptrans_alist
22085 = Fdelq (aelt
, mode_line_proptrans_alist
);
22087 elt
= Fcopy_sequence (elt
);
22088 Fset_text_properties (make_number (0), Flength (elt
),
22090 /* Add this item to mode_line_proptrans_alist. */
22091 mode_line_proptrans_alist
22092 = Fcons (Fcons (elt
, props
),
22093 mode_line_proptrans_alist
);
22094 /* Truncate mode_line_proptrans_alist
22095 to at most 50 elements. */
22096 tem
= Fnthcdr (make_number (50),
22097 mode_line_proptrans_alist
);
22099 XSETCDR (tem
, Qnil
);
22108 prec
= precision
- n
;
22109 switch (mode_line_target
)
22111 case MODE_LINE_NOPROP
:
22112 case MODE_LINE_TITLE
:
22113 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22115 case MODE_LINE_STRING
:
22116 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22118 case MODE_LINE_DISPLAY
:
22119 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22120 0, prec
, 0, STRING_MULTIBYTE (elt
));
22127 /* Handle the non-literal case. */
22129 while ((precision
<= 0 || n
< precision
)
22130 && SREF (elt
, offset
) != 0
22131 && (mode_line_target
!= MODE_LINE_DISPLAY
22132 || it
->current_x
< it
->last_visible_x
))
22134 ptrdiff_t last_offset
= offset
;
22136 /* Advance to end of string or next format specifier. */
22137 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22140 if (offset
- 1 != last_offset
)
22142 ptrdiff_t nchars
, nbytes
;
22144 /* Output to end of string or up to '%'. Field width
22145 is length of string. Don't output more than
22146 PRECISION allows us. */
22149 prec
= c_string_width (SDATA (elt
) + last_offset
,
22150 offset
- last_offset
, precision
- n
,
22153 switch (mode_line_target
)
22155 case MODE_LINE_NOPROP
:
22156 case MODE_LINE_TITLE
:
22157 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22159 case MODE_LINE_STRING
:
22161 ptrdiff_t bytepos
= last_offset
;
22162 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22163 ptrdiff_t endpos
= (precision
<= 0
22164 ? string_byte_to_char (elt
, offset
)
22165 : charpos
+ nchars
);
22166 Lisp_Object mode_string
22167 = Fsubstring (elt
, make_number (charpos
),
22168 make_number (endpos
));
22169 n
+= store_mode_line_string (NULL
, mode_string
, false,
22173 case MODE_LINE_DISPLAY
:
22175 ptrdiff_t bytepos
= last_offset
;
22176 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22178 if (precision
<= 0)
22179 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22180 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22182 STRING_MULTIBYTE (elt
));
22187 else /* c == '%' */
22189 ptrdiff_t percent_position
= offset
;
22191 /* Get the specified minimum width. Zero means
22194 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22195 field
= field
* 10 + c
- '0';
22197 /* Don't pad beyond the total padding allowed. */
22198 if (field_width
- n
> 0 && field
> field_width
- n
)
22199 field
= field_width
- n
;
22201 /* Note that either PRECISION <= 0 or N < PRECISION. */
22202 prec
= precision
- n
;
22205 n
+= display_mode_element (it
, depth
, field
, prec
,
22206 Vglobal_mode_string
, props
,
22211 ptrdiff_t bytepos
, charpos
;
22213 Lisp_Object string
;
22215 bytepos
= percent_position
;
22216 charpos
= (STRING_MULTIBYTE (elt
)
22217 ? string_byte_to_char (elt
, bytepos
)
22219 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22220 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22222 switch (mode_line_target
)
22224 case MODE_LINE_NOPROP
:
22225 case MODE_LINE_TITLE
:
22226 n
+= store_mode_line_noprop (spec
, field
, prec
);
22228 case MODE_LINE_STRING
:
22230 Lisp_Object tem
= build_string (spec
);
22231 props
= Ftext_properties_at (make_number (charpos
), elt
);
22232 /* Should only keep face property in props */
22233 n
+= store_mode_line_string (NULL
, tem
, false,
22234 field
, prec
, props
);
22237 case MODE_LINE_DISPLAY
:
22239 int nglyphs_before
, nwritten
;
22241 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22242 nwritten
= display_string (spec
, string
, elt
,
22247 /* Assign to the glyphs written above the
22248 string where the `%x' came from, position
22252 struct glyph
*glyph
22253 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22257 for (i
= 0; i
< nwritten
; ++i
)
22259 glyph
[i
].object
= elt
;
22260 glyph
[i
].charpos
= charpos
;
22277 /* A symbol: process the value of the symbol recursively
22278 as if it appeared here directly. Avoid error if symbol void.
22279 Special case: if value of symbol is a string, output the string
22282 register Lisp_Object tem
;
22284 /* If the variable is not marked as risky to set
22285 then its contents are risky to use. */
22286 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22289 tem
= Fboundp (elt
);
22292 tem
= Fsymbol_value (elt
);
22293 /* If value is a string, output that string literally:
22294 don't check for % within it. */
22298 if (!EQ (tem
, elt
))
22300 /* Give up right away for nil or t. */
22310 register Lisp_Object car
, tem
;
22312 /* A cons cell: five distinct cases.
22313 If first element is :eval or :propertize, do something special.
22314 If first element is a string or a cons, process all the elements
22315 and effectively concatenate them.
22316 If first element is a negative number, truncate displaying cdr to
22317 at most that many characters. If positive, pad (with spaces)
22318 to at least that many characters.
22319 If first element is a symbol, process the cadr or caddr recursively
22320 according to whether the symbol's value is non-nil or nil. */
22322 if (EQ (car
, QCeval
))
22324 /* An element of the form (:eval FORM) means evaluate FORM
22325 and use the result as mode line elements. */
22330 if (CONSP (XCDR (elt
)))
22333 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22334 n
+= display_mode_element (it
, depth
, field_width
- n
,
22335 precision
- n
, spec
, props
,
22339 else if (EQ (car
, QCpropertize
))
22341 /* An element of the form (:propertize ELT PROPS...)
22342 means display ELT but applying properties PROPS. */
22347 if (CONSP (XCDR (elt
)))
22348 n
+= display_mode_element (it
, depth
, field_width
- n
,
22349 precision
- n
, XCAR (XCDR (elt
)),
22350 XCDR (XCDR (elt
)), risky
);
22352 else if (SYMBOLP (car
))
22354 tem
= Fboundp (car
);
22358 /* elt is now the cdr, and we know it is a cons cell.
22359 Use its car if CAR has a non-nil value. */
22362 tem
= Fsymbol_value (car
);
22369 /* Symbol's value is nil (or symbol is unbound)
22370 Get the cddr of the original list
22371 and if possible find the caddr and use that. */
22375 else if (!CONSP (elt
))
22380 else if (INTEGERP (car
))
22382 register int lim
= XINT (car
);
22386 /* Negative int means reduce maximum width. */
22387 if (precision
<= 0)
22390 precision
= min (precision
, -lim
);
22394 /* Padding specified. Don't let it be more than
22395 current maximum. */
22397 lim
= min (precision
, lim
);
22399 /* If that's more padding than already wanted, queue it.
22400 But don't reduce padding already specified even if
22401 that is beyond the current truncation point. */
22402 field_width
= max (lim
, field_width
);
22406 else if (STRINGP (car
) || CONSP (car
))
22408 Lisp_Object halftail
= elt
;
22412 && (precision
<= 0 || n
< precision
))
22414 n
+= display_mode_element (it
, depth
,
22415 /* Do padding only after the last
22416 element in the list. */
22417 (! CONSP (XCDR (elt
))
22420 precision
- n
, XCAR (elt
),
22424 if ((len
& 1) == 0)
22425 halftail
= XCDR (halftail
);
22426 /* Check for cycle. */
22427 if (EQ (halftail
, elt
))
22436 elt
= build_string ("*invalid*");
22440 /* Pad to FIELD_WIDTH. */
22441 if (field_width
> 0 && n
< field_width
)
22443 switch (mode_line_target
)
22445 case MODE_LINE_NOPROP
:
22446 case MODE_LINE_TITLE
:
22447 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22449 case MODE_LINE_STRING
:
22450 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22453 case MODE_LINE_DISPLAY
:
22454 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22463 /* Store a mode-line string element in mode_line_string_list.
22465 If STRING is non-null, display that C string. Otherwise, the Lisp
22466 string LISP_STRING is displayed.
22468 FIELD_WIDTH is the minimum number of output glyphs to produce.
22469 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22470 with spaces. FIELD_WIDTH <= 0 means don't pad.
22472 PRECISION is the maximum number of characters to output from
22473 STRING. PRECISION <= 0 means don't truncate the string.
22475 If COPY_STRING, make a copy of LISP_STRING before adding
22476 properties to the string.
22478 PROPS are the properties to add to the string.
22479 The mode_line_string_face face property is always added to the string.
22483 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22485 int field_width
, int precision
, Lisp_Object props
)
22490 if (string
!= NULL
)
22492 len
= strlen (string
);
22493 if (precision
> 0 && len
> precision
)
22495 lisp_string
= make_string (string
, len
);
22497 props
= mode_line_string_face_prop
;
22498 else if (!NILP (mode_line_string_face
))
22500 Lisp_Object face
= Fplist_get (props
, Qface
);
22501 props
= Fcopy_sequence (props
);
22503 face
= mode_line_string_face
;
22505 face
= list2 (face
, mode_line_string_face
);
22506 props
= Fplist_put (props
, Qface
, face
);
22508 Fadd_text_properties (make_number (0), make_number (len
),
22509 props
, lisp_string
);
22513 len
= XFASTINT (Flength (lisp_string
));
22514 if (precision
> 0 && len
> precision
)
22517 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22520 if (!NILP (mode_line_string_face
))
22524 props
= Ftext_properties_at (make_number (0), lisp_string
);
22525 face
= Fplist_get (props
, Qface
);
22527 face
= mode_line_string_face
;
22529 face
= list2 (face
, mode_line_string_face
);
22530 props
= list2 (Qface
, face
);
22532 lisp_string
= Fcopy_sequence (lisp_string
);
22535 Fadd_text_properties (make_number (0), make_number (len
),
22536 props
, lisp_string
);
22541 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22545 if (field_width
> len
)
22547 field_width
-= len
;
22548 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22550 Fadd_text_properties (make_number (0), make_number (field_width
),
22551 props
, lisp_string
);
22552 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22560 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22562 doc
: /* Format a string out of a mode line format specification.
22563 First arg FORMAT specifies the mode line format (see `mode-line-format'
22564 for details) to use.
22566 By default, the format is evaluated for the currently selected window.
22568 Optional second arg FACE specifies the face property to put on all
22569 characters for which no face is specified. The value nil means the
22570 default face. The value t means whatever face the window's mode line
22571 currently uses (either `mode-line' or `mode-line-inactive',
22572 depending on whether the window is the selected window or not).
22573 An integer value means the value string has no text
22576 Optional third and fourth args WINDOW and BUFFER specify the window
22577 and buffer to use as the context for the formatting (defaults
22578 are the selected window and the WINDOW's buffer). */)
22579 (Lisp_Object format
, Lisp_Object face
,
22580 Lisp_Object window
, Lisp_Object buffer
)
22585 struct buffer
*old_buffer
= NULL
;
22587 bool no_props
= INTEGERP (face
);
22588 ptrdiff_t count
= SPECPDL_INDEX ();
22590 int string_start
= 0;
22592 w
= decode_any_window (window
);
22593 XSETWINDOW (window
, w
);
22596 buffer
= w
->contents
;
22597 CHECK_BUFFER (buffer
);
22599 /* Make formatting the modeline a non-op when noninteractive, otherwise
22600 there will be problems later caused by a partially initialized frame. */
22601 if (NILP (format
) || noninteractive
)
22602 return empty_unibyte_string
;
22607 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22608 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22609 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22610 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22611 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22612 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22613 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22616 old_buffer
= current_buffer
;
22618 /* Save things including mode_line_proptrans_alist,
22619 and set that to nil so that we don't alter the outer value. */
22620 record_unwind_protect (unwind_format_mode_line
,
22621 format_mode_line_unwind_data
22622 (XFRAME (WINDOW_FRAME (w
)),
22623 old_buffer
, selected_window
, true));
22624 mode_line_proptrans_alist
= Qnil
;
22626 Fselect_window (window
, Qt
);
22627 set_buffer_internal_1 (XBUFFER (buffer
));
22629 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22633 mode_line_target
= MODE_LINE_NOPROP
;
22634 mode_line_string_face_prop
= Qnil
;
22635 mode_line_string_list
= Qnil
;
22636 string_start
= MODE_LINE_NOPROP_LEN (0);
22640 mode_line_target
= MODE_LINE_STRING
;
22641 mode_line_string_list
= Qnil
;
22642 mode_line_string_face
= face
;
22643 mode_line_string_face_prop
22644 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22647 push_kboard (FRAME_KBOARD (it
.f
));
22648 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22653 len
= MODE_LINE_NOPROP_LEN (string_start
);
22654 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22658 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22659 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22660 empty_unibyte_string
);
22663 unbind_to (count
, Qnil
);
22667 /* Write a null-terminated, right justified decimal representation of
22668 the positive integer D to BUF using a minimal field width WIDTH. */
22671 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22673 register char *p
= buf
;
22681 *p
++ = d
% 10 + '0';
22686 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22697 /* Write a null-terminated, right justified decimal and "human
22698 readable" representation of the nonnegative integer D to BUF using
22699 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22701 static const char power_letter
[] =
22715 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22717 /* We aim to represent the nonnegative integer D as
22718 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22719 ptrdiff_t quotient
= d
;
22721 /* -1 means: do not use TENTHS. */
22725 /* Length of QUOTIENT.TENTHS as a string. */
22731 if (quotient
>= 1000)
22733 /* Scale to the appropriate EXPONENT. */
22736 remainder
= quotient
% 1000;
22740 while (quotient
>= 1000);
22742 /* Round to nearest and decide whether to use TENTHS or not. */
22745 tenths
= remainder
/ 100;
22746 if (remainder
% 100 >= 50)
22753 if (quotient
== 10)
22761 if (remainder
>= 500)
22763 if (quotient
< 999)
22774 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22775 if (tenths
== -1 && quotient
<= 99)
22782 p
= psuffix
= buf
+ max (width
, length
);
22784 /* Print EXPONENT. */
22785 *psuffix
++ = power_letter
[exponent
];
22788 /* Print TENTHS. */
22791 *--p
= '0' + tenths
;
22795 /* Print QUOTIENT. */
22798 int digit
= quotient
% 10;
22799 *--p
= '0' + digit
;
22801 while ((quotient
/= 10) != 0);
22803 /* Print leading spaces. */
22808 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22809 If EOL_FLAG, set also a mnemonic character for end-of-line
22810 type of CODING_SYSTEM. Return updated pointer into BUF. */
22812 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22815 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
22818 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22819 const unsigned char *eol_str
;
22821 /* The EOL conversion we are using. */
22822 Lisp_Object eoltype
;
22824 val
= CODING_SYSTEM_SPEC (coding_system
);
22827 if (!VECTORP (val
)) /* Not yet decided. */
22829 *buf
++ = multibyte
? '-' : ' ';
22831 eoltype
= eol_mnemonic_undecided
;
22832 /* Don't mention EOL conversion if it isn't decided. */
22837 Lisp_Object eolvalue
;
22839 attrs
= AREF (val
, 0);
22840 eolvalue
= AREF (val
, 2);
22843 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22848 /* The EOL conversion that is normal on this system. */
22850 if (NILP (eolvalue
)) /* Not yet decided. */
22851 eoltype
= eol_mnemonic_undecided
;
22852 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22853 eoltype
= eol_mnemonic_undecided
;
22854 else /* eolvalue is Qunix, Qdos, or Qmac. */
22855 eoltype
= (EQ (eolvalue
, Qunix
)
22856 ? eol_mnemonic_unix
22857 : EQ (eolvalue
, Qdos
)
22858 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
22864 /* Mention the EOL conversion if it is not the usual one. */
22865 if (STRINGP (eoltype
))
22867 eol_str
= SDATA (eoltype
);
22868 eol_str_len
= SBYTES (eoltype
);
22870 else if (CHARACTERP (eoltype
))
22872 int c
= XFASTINT (eoltype
);
22873 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
22877 eol_str
= invalid_eol_type
;
22878 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22880 memcpy (buf
, eol_str
, eol_str_len
);
22881 buf
+= eol_str_len
;
22887 /* Return a string for the output of a mode line %-spec for window W,
22888 generated by character C. FIELD_WIDTH > 0 means pad the string
22889 returned with spaces to that value. Return a Lisp string in
22890 *STRING if the resulting string is taken from that Lisp string.
22892 Note we operate on the current buffer for most purposes. */
22894 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22896 static const char *
22897 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22898 Lisp_Object
*string
)
22901 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22902 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22903 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22904 produce strings from numerical values, so limit preposterously
22905 large values of FIELD_WIDTH to avoid overrunning the buffer's
22906 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22907 bytes plus the terminating null. */
22908 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22909 struct buffer
*b
= current_buffer
;
22917 if (!NILP (BVAR (b
, read_only
)))
22919 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22924 /* This differs from %* only for a modified read-only buffer. */
22925 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22927 if (!NILP (BVAR (b
, read_only
)))
22932 /* This differs from %* in ignoring read-only-ness. */
22933 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22945 if (command_loop_level
> 5)
22947 p
= decode_mode_spec_buf
;
22948 for (i
= 0; i
< command_loop_level
; i
++)
22951 return decode_mode_spec_buf
;
22959 if (command_loop_level
> 5)
22961 p
= decode_mode_spec_buf
;
22962 for (i
= 0; i
< command_loop_level
; i
++)
22965 return decode_mode_spec_buf
;
22972 /* Let lots_of_dashes be a string of infinite length. */
22973 if (mode_line_target
== MODE_LINE_NOPROP
22974 || mode_line_target
== MODE_LINE_STRING
)
22976 if (field_width
<= 0
22977 || field_width
> sizeof (lots_of_dashes
))
22979 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22980 decode_mode_spec_buf
[i
] = '-';
22981 decode_mode_spec_buf
[i
] = '\0';
22982 return decode_mode_spec_buf
;
22985 return lots_of_dashes
;
22989 obj
= BVAR (b
, name
);
22993 /* %c and %l are ignored in `frame-title-format'.
22994 (In redisplay_internal, the frame title is drawn _before_ the
22995 windows are updated, so the stuff which depends on actual
22996 window contents (such as %l) may fail to render properly, or
22997 even crash emacs.) */
22998 if (mode_line_target
== MODE_LINE_TITLE
)
23002 ptrdiff_t col
= current_column ();
23003 w
->column_number_displayed
= col
;
23004 pint2str (decode_mode_spec_buf
, width
, col
);
23005 return decode_mode_spec_buf
;
23009 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23011 if (NILP (Vmemory_full
))
23014 return "!MEM FULL! ";
23021 /* %F displays the frame name. */
23022 if (!NILP (f
->title
))
23023 return SSDATA (f
->title
);
23024 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23025 return SSDATA (f
->name
);
23029 obj
= BVAR (b
, filename
);
23034 ptrdiff_t size
= ZV
- BEGV
;
23035 pint2str (decode_mode_spec_buf
, width
, size
);
23036 return decode_mode_spec_buf
;
23041 ptrdiff_t size
= ZV
- BEGV
;
23042 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23043 return decode_mode_spec_buf
;
23048 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23049 ptrdiff_t topline
, nlines
, height
;
23052 /* %c and %l are ignored in `frame-title-format'. */
23053 if (mode_line_target
== MODE_LINE_TITLE
)
23056 startpos
= marker_position (w
->start
);
23057 startpos_byte
= marker_byte_position (w
->start
);
23058 height
= WINDOW_TOTAL_LINES (w
);
23060 /* If we decided that this buffer isn't suitable for line numbers,
23061 don't forget that too fast. */
23062 if (w
->base_line_pos
== -1)
23065 /* If the buffer is very big, don't waste time. */
23066 if (INTEGERP (Vline_number_display_limit
)
23067 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23069 w
->base_line_pos
= 0;
23070 w
->base_line_number
= 0;
23074 if (w
->base_line_number
> 0
23075 && w
->base_line_pos
> 0
23076 && w
->base_line_pos
<= startpos
)
23078 line
= w
->base_line_number
;
23079 linepos
= w
->base_line_pos
;
23080 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23085 linepos
= BUF_BEGV (b
);
23086 linepos_byte
= BUF_BEGV_BYTE (b
);
23089 /* Count lines from base line to window start position. */
23090 nlines
= display_count_lines (linepos_byte
,
23094 topline
= nlines
+ line
;
23096 /* Determine a new base line, if the old one is too close
23097 or too far away, or if we did not have one.
23098 "Too close" means it's plausible a scroll-down would
23099 go back past it. */
23100 if (startpos
== BUF_BEGV (b
))
23102 w
->base_line_number
= topline
;
23103 w
->base_line_pos
= BUF_BEGV (b
);
23105 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23106 || linepos
== BUF_BEGV (b
))
23108 ptrdiff_t limit
= BUF_BEGV (b
);
23109 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23110 ptrdiff_t position
;
23111 ptrdiff_t distance
=
23112 (height
* 2 + 30) * line_number_display_limit_width
;
23114 if (startpos
- distance
> limit
)
23116 limit
= startpos
- distance
;
23117 limit_byte
= CHAR_TO_BYTE (limit
);
23120 nlines
= display_count_lines (startpos_byte
,
23122 - (height
* 2 + 30),
23124 /* If we couldn't find the lines we wanted within
23125 line_number_display_limit_width chars per line,
23126 give up on line numbers for this window. */
23127 if (position
== limit_byte
&& limit
== startpos
- distance
)
23129 w
->base_line_pos
= -1;
23130 w
->base_line_number
= 0;
23134 w
->base_line_number
= topline
- nlines
;
23135 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23138 /* Now count lines from the start pos to point. */
23139 nlines
= display_count_lines (startpos_byte
,
23140 PT_BYTE
, PT
, &junk
);
23142 /* Record that we did display the line number. */
23143 line_number_displayed
= true;
23145 /* Make the string to show. */
23146 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23147 return decode_mode_spec_buf
;
23150 char *p
= decode_mode_spec_buf
;
23151 int pad
= width
- 2;
23157 return decode_mode_spec_buf
;
23163 obj
= BVAR (b
, mode_name
);
23167 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23173 ptrdiff_t pos
= marker_position (w
->start
);
23174 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23176 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23178 if (pos
<= BUF_BEGV (b
))
23183 else if (pos
<= BUF_BEGV (b
))
23187 if (total
> 1000000)
23188 /* Do it differently for a large value, to avoid overflow. */
23189 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23191 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23192 /* We can't normally display a 3-digit number,
23193 so get us a 2-digit number that is close. */
23196 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23197 return decode_mode_spec_buf
;
23201 /* Display percentage of size above the bottom of the screen. */
23204 ptrdiff_t toppos
= marker_position (w
->start
);
23205 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23206 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23208 if (botpos
>= BUF_ZV (b
))
23210 if (toppos
<= BUF_BEGV (b
))
23217 if (total
> 1000000)
23218 /* Do it differently for a large value, to avoid overflow. */
23219 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23221 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23222 /* We can't normally display a 3-digit number,
23223 so get us a 2-digit number that is close. */
23226 if (toppos
<= BUF_BEGV (b
))
23227 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23229 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23230 return decode_mode_spec_buf
;
23235 /* status of process */
23236 obj
= Fget_buffer_process (Fcurrent_buffer ());
23238 return "no process";
23240 obj
= Fsymbol_name (Fprocess_status (obj
));
23246 ptrdiff_t count
= inhibit_garbage_collection ();
23247 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23248 Lisp_Object val
= Qnil
;
23250 if (STRINGP (curdir
))
23251 val
= call1 (intern ("file-remote-p"), curdir
);
23253 unbind_to (count
, Qnil
);
23262 /* coding-system (not including end-of-line format) */
23264 /* coding-system (including end-of-line type) */
23266 bool eol_flag
= (c
== 'Z');
23267 char *p
= decode_mode_spec_buf
;
23269 if (! FRAME_WINDOW_P (f
))
23271 /* No need to mention EOL here--the terminal never needs
23272 to do EOL conversion. */
23273 p
= decode_mode_spec_coding (CODING_ID_NAME
23274 (FRAME_KEYBOARD_CODING (f
)->id
),
23276 p
= decode_mode_spec_coding (CODING_ID_NAME
23277 (FRAME_TERMINAL_CODING (f
)->id
),
23280 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23283 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23284 #ifdef subprocesses
23285 obj
= Fget_buffer_process (Fcurrent_buffer ());
23286 if (PROCESSP (obj
))
23288 p
= decode_mode_spec_coding
23289 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23290 p
= decode_mode_spec_coding
23291 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23293 #endif /* subprocesses */
23296 return decode_mode_spec_buf
;
23303 return SSDATA (obj
);
23310 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23311 means count lines back from START_BYTE. But don't go beyond
23312 LIMIT_BYTE. Return the number of lines thus found (always
23315 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23316 either the position COUNT lines after/before START_BYTE, if we
23317 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23321 display_count_lines (ptrdiff_t start_byte
,
23322 ptrdiff_t limit_byte
, ptrdiff_t count
,
23323 ptrdiff_t *byte_pos_ptr
)
23325 register unsigned char *cursor
;
23326 unsigned char *base
;
23328 register ptrdiff_t ceiling
;
23329 register unsigned char *ceiling_addr
;
23330 ptrdiff_t orig_count
= count
;
23332 /* If we are not in selective display mode,
23333 check only for newlines. */
23334 bool selective_display
23335 = (!NILP (BVAR (current_buffer
, selective_display
))
23336 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23340 while (start_byte
< limit_byte
)
23342 ceiling
= BUFFER_CEILING_OF (start_byte
);
23343 ceiling
= min (limit_byte
- 1, ceiling
);
23344 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23345 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23349 if (selective_display
)
23351 while (*cursor
!= '\n' && *cursor
!= 015
23352 && ++cursor
!= ceiling_addr
)
23354 if (cursor
== ceiling_addr
)
23359 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23368 start_byte
+= cursor
- base
;
23369 *byte_pos_ptr
= start_byte
;
23373 while (cursor
< ceiling_addr
);
23375 start_byte
+= ceiling_addr
- base
;
23380 while (start_byte
> limit_byte
)
23382 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23383 ceiling
= max (limit_byte
, ceiling
);
23384 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23385 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23388 if (selective_display
)
23390 while (--cursor
>= ceiling_addr
23391 && *cursor
!= '\n' && *cursor
!= 015)
23393 if (cursor
< ceiling_addr
)
23398 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23405 start_byte
+= cursor
- base
+ 1;
23406 *byte_pos_ptr
= start_byte
;
23407 /* When scanning backwards, we should
23408 not count the newline posterior to which we stop. */
23409 return - orig_count
- 1;
23412 start_byte
+= ceiling_addr
- base
;
23416 *byte_pos_ptr
= limit_byte
;
23419 return - orig_count
+ count
;
23420 return orig_count
- count
;
23426 /***********************************************************************
23428 ***********************************************************************/
23430 /* Display a NUL-terminated string, starting with index START.
23432 If STRING is non-null, display that C string. Otherwise, the Lisp
23433 string LISP_STRING is displayed. There's a case that STRING is
23434 non-null and LISP_STRING is not nil. It means STRING is a string
23435 data of LISP_STRING. In that case, we display LISP_STRING while
23436 ignoring its text properties.
23438 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23439 FACE_STRING. Display STRING or LISP_STRING with the face at
23440 FACE_STRING_POS in FACE_STRING:
23442 Display the string in the environment given by IT, but use the
23443 standard display table, temporarily.
23445 FIELD_WIDTH is the minimum number of output glyphs to produce.
23446 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23447 with spaces. If STRING has more characters, more than FIELD_WIDTH
23448 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23450 PRECISION is the maximum number of characters to output from
23451 STRING. PRECISION < 0 means don't truncate the string.
23453 This is roughly equivalent to printf format specifiers:
23455 FIELD_WIDTH PRECISION PRINTF
23456 ----------------------------------------
23462 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23463 display them, and < 0 means obey the current buffer's value of
23464 enable_multibyte_characters.
23466 Value is the number of columns displayed. */
23469 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23470 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23471 int field_width
, int precision
, int max_x
, int multibyte
)
23473 int hpos_at_start
= it
->hpos
;
23474 int saved_face_id
= it
->face_id
;
23475 struct glyph_row
*row
= it
->glyph_row
;
23476 ptrdiff_t it_charpos
;
23478 /* Initialize the iterator IT for iteration over STRING beginning
23479 with index START. */
23480 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23481 precision
, field_width
, multibyte
);
23482 if (string
&& STRINGP (lisp_string
))
23483 /* LISP_STRING is the one returned by decode_mode_spec. We should
23484 ignore its text properties. */
23485 it
->stop_charpos
= it
->end_charpos
;
23487 /* If displaying STRING, set up the face of the iterator from
23488 FACE_STRING, if that's given. */
23489 if (STRINGP (face_string
))
23495 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23496 0, &endptr
, it
->base_face_id
, false);
23497 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23498 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23501 /* Set max_x to the maximum allowed X position. Don't let it go
23502 beyond the right edge of the window. */
23504 max_x
= it
->last_visible_x
;
23506 max_x
= min (max_x
, it
->last_visible_x
);
23508 /* Skip over display elements that are not visible. because IT->w is
23510 if (it
->current_x
< it
->first_visible_x
)
23511 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23512 MOVE_TO_POS
| MOVE_TO_X
);
23514 row
->ascent
= it
->max_ascent
;
23515 row
->height
= it
->max_ascent
+ it
->max_descent
;
23516 row
->phys_ascent
= it
->max_phys_ascent
;
23517 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23518 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23520 if (STRINGP (it
->string
))
23521 it_charpos
= IT_STRING_CHARPOS (*it
);
23523 it_charpos
= IT_CHARPOS (*it
);
23525 /* This condition is for the case that we are called with current_x
23526 past last_visible_x. */
23527 while (it
->current_x
< max_x
)
23529 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23531 /* Get the next display element. */
23532 if (!get_next_display_element (it
))
23535 /* Produce glyphs. */
23536 x_before
= it
->current_x
;
23537 n_glyphs_before
= row
->used
[TEXT_AREA
];
23538 PRODUCE_GLYPHS (it
);
23540 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23543 while (i
< nglyphs
)
23545 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23547 if (it
->line_wrap
!= TRUNCATE
23548 && x
+ glyph
->pixel_width
> max_x
)
23550 /* End of continued line or max_x reached. */
23551 if (CHAR_GLYPH_PADDING_P (*glyph
))
23553 /* A wide character is unbreakable. */
23554 if (row
->reversed_p
)
23555 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23556 - n_glyphs_before
);
23557 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23558 it
->current_x
= x_before
;
23562 if (row
->reversed_p
)
23563 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23564 - (n_glyphs_before
+ i
));
23565 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23570 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23572 /* Glyph is at least partially visible. */
23574 if (x
< it
->first_visible_x
)
23575 row
->x
= x
- it
->first_visible_x
;
23579 /* Glyph is off the left margin of the display area.
23580 Should not happen. */
23584 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23585 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23586 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23587 row
->phys_height
= max (row
->phys_height
,
23588 it
->max_phys_ascent
+ it
->max_phys_descent
);
23589 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23590 it
->max_extra_line_spacing
);
23591 x
+= glyph
->pixel_width
;
23595 /* Stop if max_x reached. */
23599 /* Stop at line ends. */
23600 if (ITERATOR_AT_END_OF_LINE_P (it
))
23602 it
->continuation_lines_width
= 0;
23606 set_iterator_to_next (it
, true);
23607 if (STRINGP (it
->string
))
23608 it_charpos
= IT_STRING_CHARPOS (*it
);
23610 it_charpos
= IT_CHARPOS (*it
);
23612 /* Stop if truncating at the right edge. */
23613 if (it
->line_wrap
== TRUNCATE
23614 && it
->current_x
>= it
->last_visible_x
)
23616 /* Add truncation mark, but don't do it if the line is
23617 truncated at a padding space. */
23618 if (it_charpos
< it
->string_nchars
)
23620 if (!FRAME_WINDOW_P (it
->f
))
23624 if (it
->current_x
> it
->last_visible_x
)
23626 if (!row
->reversed_p
)
23628 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23629 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23634 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23635 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23637 unproduce_glyphs (it
, ii
+ 1);
23638 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23640 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23642 row
->used
[TEXT_AREA
] = ii
;
23643 produce_special_glyphs (it
, IT_TRUNCATION
);
23646 produce_special_glyphs (it
, IT_TRUNCATION
);
23648 row
->truncated_on_right_p
= true;
23654 /* Maybe insert a truncation at the left. */
23655 if (it
->first_visible_x
23658 if (!FRAME_WINDOW_P (it
->f
)
23659 || (row
->reversed_p
23660 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23661 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23662 insert_left_trunc_glyphs (it
);
23663 row
->truncated_on_left_p
= true;
23666 it
->face_id
= saved_face_id
;
23668 /* Value is number of columns displayed. */
23669 return it
->hpos
- hpos_at_start
;
23674 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23675 appears as an element of LIST or as the car of an element of LIST.
23676 If PROPVAL is a list, compare each element against LIST in that
23677 way, and return 1/2 if any element of PROPVAL is found in LIST.
23678 Otherwise return 0. This function cannot quit.
23679 The return value is 2 if the text is invisible but with an ellipsis
23680 and 1 if it's invisible and without an ellipsis. */
23683 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23685 Lisp_Object tail
, proptail
;
23687 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23689 register Lisp_Object tem
;
23691 if (EQ (propval
, tem
))
23693 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23694 return NILP (XCDR (tem
)) ? 1 : 2;
23697 if (CONSP (propval
))
23699 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23701 Lisp_Object propelt
;
23702 propelt
= XCAR (proptail
);
23703 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23705 register Lisp_Object tem
;
23707 if (EQ (propelt
, tem
))
23709 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23710 return NILP (XCDR (tem
)) ? 1 : 2;
23718 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23719 doc
: /* Non-nil if the property makes the text invisible.
23720 POS-OR-PROP can be a marker or number, in which case it is taken to be
23721 a position in the current buffer and the value of the `invisible' property
23722 is checked; or it can be some other value, which is then presumed to be the
23723 value of the `invisible' property of the text of interest.
23724 The non-nil value returned can be t for truly invisible text or something
23725 else if the text is replaced by an ellipsis. */)
23726 (Lisp_Object pos_or_prop
)
23729 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23730 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23732 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23733 return (invis
== 0 ? Qnil
23735 : make_number (invis
));
23738 /* Calculate a width or height in pixels from a specification using
23739 the following elements:
23742 NUM - a (fractional) multiple of the default font width/height
23743 (NUM) - specifies exactly NUM pixels
23744 UNIT - a fixed number of pixels, see below.
23745 ELEMENT - size of a display element in pixels, see below.
23746 (NUM . SPEC) - equals NUM * SPEC
23747 (+ SPEC SPEC ...) - add pixel values
23748 (- SPEC SPEC ...) - subtract pixel values
23749 (- SPEC) - negate pixel value
23752 INT or FLOAT - a number constant
23753 SYMBOL - use symbol's (buffer local) variable binding.
23756 in - pixels per inch *)
23757 mm - pixels per 1/1000 meter *)
23758 cm - pixels per 1/100 meter *)
23759 width - width of current font in pixels.
23760 height - height of current font in pixels.
23762 *) using the ratio(s) defined in display-pixels-per-inch.
23766 left-fringe - left fringe width in pixels
23767 right-fringe - right fringe width in pixels
23769 left-margin - left margin width in pixels
23770 right-margin - right margin width in pixels
23772 scroll-bar - scroll-bar area width in pixels
23776 Pixels corresponding to 5 inches:
23779 Total width of non-text areas on left side of window (if scroll-bar is on left):
23780 '(space :width (+ left-fringe left-margin scroll-bar))
23782 Align to first text column (in header line):
23783 '(space :align-to 0)
23785 Align to middle of text area minus half the width of variable `my-image'
23786 containing a loaded image:
23787 '(space :align-to (0.5 . (- text my-image)))
23789 Width of left margin minus width of 1 character in the default font:
23790 '(space :width (- left-margin 1))
23792 Width of left margin minus width of 2 characters in the current font:
23793 '(space :width (- left-margin (2 . width)))
23795 Center 1 character over left-margin (in header line):
23796 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23798 Different ways to express width of left fringe plus left margin minus one pixel:
23799 '(space :width (- (+ left-fringe left-margin) (1)))
23800 '(space :width (+ left-fringe left-margin (- (1))))
23801 '(space :width (+ left-fringe left-margin (-1)))
23806 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23807 struct font
*font
, bool width_p
, int *align_to
)
23811 # define OK_PIXELS(val) (*res = (val), true)
23812 # define OK_ALIGN_TO(val) (*align_to = (val), true)
23815 return OK_PIXELS (0);
23817 eassert (FRAME_LIVE_P (it
->f
));
23819 if (SYMBOLP (prop
))
23821 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23823 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23825 if (unit
[0] == 'i' && unit
[1] == 'n')
23827 else if (unit
[0] == 'm' && unit
[1] == 'm')
23829 else if (unit
[0] == 'c' && unit
[1] == 'm')
23835 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23836 : FRAME_RES_Y (it
->f
));
23839 return OK_PIXELS (ppi
/ pixels
);
23844 #ifdef HAVE_WINDOW_SYSTEM
23845 if (EQ (prop
, Qheight
))
23846 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23847 if (EQ (prop
, Qwidth
))
23848 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23850 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23851 return OK_PIXELS (1);
23854 if (EQ (prop
, Qtext
))
23855 return OK_PIXELS (width_p
23856 ? window_box_width (it
->w
, TEXT_AREA
)
23857 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23859 if (align_to
&& *align_to
< 0)
23862 if (EQ (prop
, Qleft
))
23863 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23864 if (EQ (prop
, Qright
))
23865 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23866 if (EQ (prop
, Qcenter
))
23867 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23868 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23869 if (EQ (prop
, Qleft_fringe
))
23870 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23871 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23872 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23873 if (EQ (prop
, Qright_fringe
))
23874 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23875 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23876 : window_box_right_offset (it
->w
, TEXT_AREA
));
23877 if (EQ (prop
, Qleft_margin
))
23878 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23879 if (EQ (prop
, Qright_margin
))
23880 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23881 if (EQ (prop
, Qscroll_bar
))
23882 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23884 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23885 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23886 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23891 if (EQ (prop
, Qleft_fringe
))
23892 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23893 if (EQ (prop
, Qright_fringe
))
23894 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23895 if (EQ (prop
, Qleft_margin
))
23896 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23897 if (EQ (prop
, Qright_margin
))
23898 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23899 if (EQ (prop
, Qscroll_bar
))
23900 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23903 prop
= buffer_local_value (prop
, it
->w
->contents
);
23904 if (EQ (prop
, Qunbound
))
23908 if (INTEGERP (prop
) || FLOATP (prop
))
23910 int base_unit
= (width_p
23911 ? FRAME_COLUMN_WIDTH (it
->f
)
23912 : FRAME_LINE_HEIGHT (it
->f
));
23913 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23918 Lisp_Object car
= XCAR (prop
);
23919 Lisp_Object cdr
= XCDR (prop
);
23923 #ifdef HAVE_WINDOW_SYSTEM
23924 if (FRAME_WINDOW_P (it
->f
)
23925 && valid_image_p (prop
))
23927 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23928 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23930 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23933 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23939 while (CONSP (cdr
))
23941 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23942 font
, width_p
, align_to
))
23945 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
23950 if (EQ (car
, Qminus
))
23952 return OK_PIXELS (pixels
);
23955 car
= buffer_local_value (car
, it
->w
->contents
);
23956 if (EQ (car
, Qunbound
))
23960 if (INTEGERP (car
) || FLOATP (car
))
23963 pixels
= XFLOATINT (car
);
23965 return OK_PIXELS (pixels
);
23966 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23967 font
, width_p
, align_to
))
23968 return OK_PIXELS (pixels
* fact
);
23979 /***********************************************************************
23981 ***********************************************************************/
23983 #ifdef HAVE_WINDOW_SYSTEM
23988 dump_glyph_string (struct glyph_string
*s
)
23990 fprintf (stderr
, "glyph string\n");
23991 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23992 s
->x
, s
->y
, s
->width
, s
->height
);
23993 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23994 fprintf (stderr
, " hl = %d\n", s
->hl
);
23995 fprintf (stderr
, " left overhang = %d, right = %d\n",
23996 s
->left_overhang
, s
->right_overhang
);
23997 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23998 fprintf (stderr
, " extends to end of line = %d\n",
23999 s
->extends_to_end_of_line_p
);
24000 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24001 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24004 #endif /* GLYPH_DEBUG */
24006 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24007 of XChar2b structures for S; it can't be allocated in
24008 init_glyph_string because it must be allocated via `alloca'. W
24009 is the window on which S is drawn. ROW and AREA are the glyph row
24010 and area within the row from which S is constructed. START is the
24011 index of the first glyph structure covered by S. HL is a
24012 face-override for drawing S. */
24015 #define OPTIONAL_HDC(hdc) HDC hdc,
24016 #define DECLARE_HDC(hdc) HDC hdc;
24017 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24018 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24021 #ifndef OPTIONAL_HDC
24022 #define OPTIONAL_HDC(hdc)
24023 #define DECLARE_HDC(hdc)
24024 #define ALLOCATE_HDC(hdc, f)
24025 #define RELEASE_HDC(hdc, f)
24029 init_glyph_string (struct glyph_string
*s
,
24031 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24032 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24034 memset (s
, 0, sizeof *s
);
24036 s
->f
= XFRAME (w
->frame
);
24040 s
->display
= FRAME_X_DISPLAY (s
->f
);
24041 s
->window
= FRAME_X_WINDOW (s
->f
);
24042 s
->char2b
= char2b
;
24046 s
->first_glyph
= row
->glyphs
[area
] + start
;
24047 s
->height
= row
->height
;
24048 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24049 s
->ybase
= s
->y
+ row
->ascent
;
24053 /* Append the list of glyph strings with head H and tail T to the list
24054 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24057 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24058 struct glyph_string
*h
, struct glyph_string
*t
)
24072 /* Prepend the list of glyph strings with head H and tail T to the
24073 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24077 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24078 struct glyph_string
*h
, struct glyph_string
*t
)
24092 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24093 Set *HEAD and *TAIL to the resulting list. */
24096 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24097 struct glyph_string
*s
)
24099 s
->next
= s
->prev
= NULL
;
24100 append_glyph_string_lists (head
, tail
, s
, s
);
24104 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24105 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24106 make sure that X resources for the face returned are allocated.
24107 Value is a pointer to a realized face that is ready for display if
24110 static struct face
*
24111 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24112 XChar2b
*char2b
, bool display_p
)
24114 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24119 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24121 if (code
== FONT_INVALID_CODE
)
24124 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24126 /* Make sure X resources of the face are allocated. */
24127 #ifdef HAVE_X_WINDOWS
24131 eassert (face
!= NULL
);
24132 prepare_face_for_display (f
, face
);
24139 /* Get face and two-byte form of character glyph GLYPH on frame F.
24140 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24141 a pointer to a realized face that is ready for display. */
24143 static struct face
*
24144 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24150 eassert (glyph
->type
== CHAR_GLYPH
);
24151 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24153 /* Make sure X resources of the face are allocated. */
24154 eassert (face
!= NULL
);
24155 prepare_face_for_display (f
, face
);
24159 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24160 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24162 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24164 if (code
== FONT_INVALID_CODE
)
24168 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24173 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24174 Return true iff FONT has a glyph for C. */
24177 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24181 if (CHAR_BYTE8_P (c
))
24182 code
= CHAR_TO_BYTE8 (c
);
24184 code
= font
->driver
->encode_char (font
, c
);
24186 if (code
== FONT_INVALID_CODE
)
24188 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24193 /* Fill glyph string S with composition components specified by S->cmp.
24195 BASE_FACE is the base face of the composition.
24196 S->cmp_from is the index of the first component for S.
24198 OVERLAPS non-zero means S should draw the foreground only, and use
24199 its physical height for clipping. See also draw_glyphs.
24201 Value is the index of a component not in S. */
24204 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24208 /* For all glyphs of this composition, starting at the offset
24209 S->cmp_from, until we reach the end of the definition or encounter a
24210 glyph that requires the different face, add it to S. */
24215 s
->for_overlaps
= overlaps
;
24218 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24220 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24222 /* TAB in a composition means display glyphs with padding space
24223 on the left or right. */
24226 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24229 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24230 s
->char2b
+ i
, true);
24236 s
->font
= s
->face
->font
;
24238 else if (s
->face
!= face
)
24246 if (s
->face
== NULL
)
24248 s
->face
= base_face
->ascii_face
;
24249 s
->font
= s
->face
->font
;
24252 /* All glyph strings for the same composition has the same width,
24253 i.e. the width set for the first component of the composition. */
24254 s
->width
= s
->first_glyph
->pixel_width
;
24256 /* If the specified font could not be loaded, use the frame's
24257 default font, but record the fact that we couldn't load it in
24258 the glyph string so that we can draw rectangles for the
24259 characters of the glyph string. */
24260 if (s
->font
== NULL
)
24262 s
->font_not_found_p
= true;
24263 s
->font
= FRAME_FONT (s
->f
);
24266 /* Adjust base line for subscript/superscript text. */
24267 s
->ybase
+= s
->first_glyph
->voffset
;
24273 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24274 int start
, int end
, int overlaps
)
24276 struct glyph
*glyph
, *last
;
24277 Lisp_Object lgstring
;
24280 s
->for_overlaps
= overlaps
;
24281 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24282 last
= s
->row
->glyphs
[s
->area
] + end
;
24283 s
->cmp_id
= glyph
->u
.cmp
.id
;
24284 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24285 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24286 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24287 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24288 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24290 while (glyph
< last
24291 && glyph
->u
.cmp
.automatic
24292 && glyph
->u
.cmp
.id
== s
->cmp_id
24293 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24294 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24296 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24298 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24299 unsigned code
= LGLYPH_CODE (lglyph
);
24301 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24303 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24304 return glyph
- s
->row
->glyphs
[s
->area
];
24308 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24309 See the comment of fill_glyph_string for arguments.
24310 Value is the index of the first glyph not in S. */
24314 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24315 int start
, int end
, int overlaps
)
24317 struct glyph
*glyph
, *last
;
24320 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24321 s
->for_overlaps
= overlaps
;
24322 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24323 last
= s
->row
->glyphs
[s
->area
] + end
;
24324 voffset
= glyph
->voffset
;
24325 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24326 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24328 s
->width
= glyph
->pixel_width
;
24330 while (glyph
< last
24331 && glyph
->type
== GLYPHLESS_GLYPH
24332 && glyph
->voffset
== voffset
24333 && glyph
->face_id
== face_id
)
24336 s
->width
+= glyph
->pixel_width
;
24339 s
->ybase
+= voffset
;
24340 return glyph
- s
->row
->glyphs
[s
->area
];
24344 /* Fill glyph string S from a sequence of character glyphs.
24346 FACE_ID is the face id of the string. START is the index of the
24347 first glyph to consider, END is the index of the last + 1.
24348 OVERLAPS non-zero means S should draw the foreground only, and use
24349 its physical height for clipping. See also draw_glyphs.
24351 Value is the index of the first glyph not in S. */
24354 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24355 int start
, int end
, int overlaps
)
24357 struct glyph
*glyph
, *last
;
24359 bool glyph_not_available_p
;
24361 eassert (s
->f
== XFRAME (s
->w
->frame
));
24362 eassert (s
->nchars
== 0);
24363 eassert (start
>= 0 && end
> start
);
24365 s
->for_overlaps
= overlaps
;
24366 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24367 last
= s
->row
->glyphs
[s
->area
] + end
;
24368 voffset
= glyph
->voffset
;
24369 s
->padding_p
= glyph
->padding_p
;
24370 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24372 while (glyph
< last
24373 && glyph
->type
== CHAR_GLYPH
24374 && glyph
->voffset
== voffset
24375 /* Same face id implies same font, nowadays. */
24376 && glyph
->face_id
== face_id
24377 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24379 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24380 s
->char2b
+ s
->nchars
);
24382 eassert (s
->nchars
<= end
- start
);
24383 s
->width
+= glyph
->pixel_width
;
24384 if (glyph
++->padding_p
!= s
->padding_p
)
24388 s
->font
= s
->face
->font
;
24390 /* If the specified font could not be loaded, use the frame's font,
24391 but record the fact that we couldn't load it in
24392 S->font_not_found_p so that we can draw rectangles for the
24393 characters of the glyph string. */
24394 if (s
->font
== NULL
|| glyph_not_available_p
)
24396 s
->font_not_found_p
= true;
24397 s
->font
= FRAME_FONT (s
->f
);
24400 /* Adjust base line for subscript/superscript text. */
24401 s
->ybase
+= voffset
;
24403 eassert (s
->face
&& s
->face
->gc
);
24404 return glyph
- s
->row
->glyphs
[s
->area
];
24408 /* Fill glyph string S from image glyph S->first_glyph. */
24411 fill_image_glyph_string (struct glyph_string
*s
)
24413 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24414 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24416 s
->slice
= s
->first_glyph
->slice
.img
;
24417 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24418 s
->font
= s
->face
->font
;
24419 s
->width
= s
->first_glyph
->pixel_width
;
24421 /* Adjust base line for subscript/superscript text. */
24422 s
->ybase
+= s
->first_glyph
->voffset
;
24426 /* Fill glyph string S from a sequence of stretch glyphs.
24428 START is the index of the first glyph to consider,
24429 END is the index of the last + 1.
24431 Value is the index of the first glyph not in S. */
24434 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24436 struct glyph
*glyph
, *last
;
24437 int voffset
, face_id
;
24439 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24441 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24442 last
= s
->row
->glyphs
[s
->area
] + end
;
24443 face_id
= glyph
->face_id
;
24444 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24445 s
->font
= s
->face
->font
;
24446 s
->width
= glyph
->pixel_width
;
24448 voffset
= glyph
->voffset
;
24452 && glyph
->type
== STRETCH_GLYPH
24453 && glyph
->voffset
== voffset
24454 && glyph
->face_id
== face_id
);
24456 s
->width
+= glyph
->pixel_width
;
24458 /* Adjust base line for subscript/superscript text. */
24459 s
->ybase
+= voffset
;
24461 /* The case that face->gc == 0 is handled when drawing the glyph
24462 string by calling prepare_face_for_display. */
24464 return glyph
- s
->row
->glyphs
[s
->area
];
24467 static struct font_metrics
*
24468 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24470 static struct font_metrics metrics
;
24475 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24476 if (code
== FONT_INVALID_CODE
)
24478 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24483 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24484 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24485 assumed to be zero. */
24488 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24490 *left
= *right
= 0;
24492 if (glyph
->type
== CHAR_GLYPH
)
24495 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24498 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24501 if (pcm
->rbearing
> pcm
->width
)
24502 *right
= pcm
->rbearing
- pcm
->width
;
24503 if (pcm
->lbearing
< 0)
24504 *left
= -pcm
->lbearing
;
24508 else if (glyph
->type
== COMPOSITE_GLYPH
)
24510 if (! glyph
->u
.cmp
.automatic
)
24512 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24514 if (cmp
->rbearing
> cmp
->pixel_width
)
24515 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24516 if (cmp
->lbearing
< 0)
24517 *left
= - cmp
->lbearing
;
24521 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24522 struct font_metrics metrics
;
24524 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24525 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24526 if (metrics
.rbearing
> metrics
.width
)
24527 *right
= metrics
.rbearing
- metrics
.width
;
24528 if (metrics
.lbearing
< 0)
24529 *left
= - metrics
.lbearing
;
24535 /* Return the index of the first glyph preceding glyph string S that
24536 is overwritten by S because of S's left overhang. Value is -1
24537 if no glyphs are overwritten. */
24540 left_overwritten (struct glyph_string
*s
)
24544 if (s
->left_overhang
)
24547 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24548 int first
= s
->first_glyph
- glyphs
;
24550 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24551 x
-= glyphs
[i
].pixel_width
;
24562 /* Return the index of the first glyph preceding glyph string S that
24563 is overwriting S because of its right overhang. Value is -1 if no
24564 glyph in front of S overwrites S. */
24567 left_overwriting (struct glyph_string
*s
)
24570 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24571 int first
= s
->first_glyph
- glyphs
;
24575 for (i
= first
- 1; i
>= 0; --i
)
24578 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24581 x
-= glyphs
[i
].pixel_width
;
24588 /* Return the index of the last glyph following glyph string S that is
24589 overwritten by S because of S's right overhang. Value is -1 if
24590 no such glyph is found. */
24593 right_overwritten (struct glyph_string
*s
)
24597 if (s
->right_overhang
)
24600 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24601 int first
= (s
->first_glyph
- glyphs
24602 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24603 int end
= s
->row
->used
[s
->area
];
24605 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24606 x
+= glyphs
[i
].pixel_width
;
24615 /* Return the index of the last glyph following glyph string S that
24616 overwrites S because of its left overhang. Value is negative
24617 if no such glyph is found. */
24620 right_overwriting (struct glyph_string
*s
)
24623 int end
= s
->row
->used
[s
->area
];
24624 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24625 int first
= (s
->first_glyph
- glyphs
24626 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24630 for (i
= first
; i
< end
; ++i
)
24633 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24636 x
+= glyphs
[i
].pixel_width
;
24643 /* Set background width of glyph string S. START is the index of the
24644 first glyph following S. LAST_X is the right-most x-position + 1
24645 in the drawing area. */
24648 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24650 /* If the face of this glyph string has to be drawn to the end of
24651 the drawing area, set S->extends_to_end_of_line_p. */
24653 if (start
== s
->row
->used
[s
->area
]
24654 && ((s
->row
->fill_line_p
24655 && (s
->hl
== DRAW_NORMAL_TEXT
24656 || s
->hl
== DRAW_IMAGE_RAISED
24657 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24658 || s
->hl
== DRAW_MOUSE_FACE
))
24659 s
->extends_to_end_of_line_p
= true;
24661 /* If S extends its face to the end of the line, set its
24662 background_width to the distance to the right edge of the drawing
24664 if (s
->extends_to_end_of_line_p
)
24665 s
->background_width
= last_x
- s
->x
+ 1;
24667 s
->background_width
= s
->width
;
24671 /* Compute overhangs and x-positions for glyph string S and its
24672 predecessors, or successors. X is the starting x-position for S.
24673 BACKWARD_P means process predecessors. */
24676 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24682 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24683 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24693 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24694 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24704 /* The following macros are only called from draw_glyphs below.
24705 They reference the following parameters of that function directly:
24706 `w', `row', `area', and `overlap_p'
24707 as well as the following local variables:
24708 `s', `f', and `hdc' (in W32) */
24711 /* On W32, silently add local `hdc' variable to argument list of
24712 init_glyph_string. */
24713 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24714 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24716 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24717 init_glyph_string (s, char2b, w, row, area, start, hl)
24720 /* Add a glyph string for a stretch glyph to the list of strings
24721 between HEAD and TAIL. START is the index of the stretch glyph in
24722 row area AREA of glyph row ROW. END is the index of the last glyph
24723 in that glyph row area. X is the current output position assigned
24724 to the new glyph string constructed. HL overrides that face of the
24725 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24726 is the right-most x-position of the drawing area. */
24728 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24729 and below -- keep them on one line. */
24730 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24733 s = alloca (sizeof *s); \
24734 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24735 START = fill_stretch_glyph_string (s, START, END); \
24736 append_glyph_string (&HEAD, &TAIL, s); \
24742 /* Add a glyph string for an image glyph to the list of strings
24743 between HEAD and TAIL. START is the index of the image glyph in
24744 row area AREA of glyph row ROW. END is the index of the last glyph
24745 in that glyph row area. X is the current output position assigned
24746 to the new glyph string constructed. HL overrides that face of the
24747 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24748 is the right-most x-position of the drawing area. */
24750 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24753 s = alloca (sizeof *s); \
24754 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24755 fill_image_glyph_string (s); \
24756 append_glyph_string (&HEAD, &TAIL, s); \
24763 /* Add a glyph string for a sequence of character glyphs to the list
24764 of strings between HEAD and TAIL. START is the index of the first
24765 glyph in row area AREA of glyph row ROW that is part of the new
24766 glyph string. END is the index of the last glyph in that glyph row
24767 area. X is the current output position assigned to the new glyph
24768 string constructed. HL overrides that face of the glyph; e.g. it
24769 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24770 right-most x-position of the drawing area. */
24772 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24778 face_id = (row)->glyphs[area][START].face_id; \
24780 s = alloca (sizeof *s); \
24781 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24782 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24783 append_glyph_string (&HEAD, &TAIL, s); \
24785 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24790 /* Add a glyph string for a composite sequence to the list of strings
24791 between HEAD and TAIL. START is the index of the first glyph in
24792 row area AREA of glyph row ROW that is part of the new glyph
24793 string. END is the index of the last glyph in that glyph row area.
24794 X is the current output position assigned to the new glyph string
24795 constructed. HL overrides that face of the glyph; e.g. it is
24796 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24797 x-position of the drawing area. */
24799 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24801 int face_id = (row)->glyphs[area][START].face_id; \
24802 struct face *base_face = FACE_FROM_ID (f, face_id); \
24803 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24804 struct composition *cmp = composition_table[cmp_id]; \
24806 struct glyph_string *first_s = NULL; \
24809 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
24811 /* Make glyph_strings for each glyph sequence that is drawable by \
24812 the same face, and append them to HEAD/TAIL. */ \
24813 for (n = 0; n < cmp->glyph_len;) \
24815 s = alloca (sizeof *s); \
24816 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24817 append_glyph_string (&(HEAD), &(TAIL), s); \
24823 n = fill_composite_glyph_string (s, base_face, overlaps); \
24831 /* Add a glyph string for a glyph-string sequence to the list of strings
24832 between HEAD and TAIL. */
24834 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24838 Lisp_Object gstring; \
24840 face_id = (row)->glyphs[area][START].face_id; \
24841 gstring = (composition_gstring_from_id \
24842 ((row)->glyphs[area][START].u.cmp.id)); \
24843 s = alloca (sizeof *s); \
24844 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
24845 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24846 append_glyph_string (&(HEAD), &(TAIL), s); \
24848 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24852 /* Add a glyph string for a sequence of glyphless character's glyphs
24853 to the list of strings between HEAD and TAIL. The meanings of
24854 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24856 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24861 face_id = (row)->glyphs[area][START].face_id; \
24863 s = alloca (sizeof *s); \
24864 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24865 append_glyph_string (&HEAD, &TAIL, s); \
24867 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24873 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24874 of AREA of glyph row ROW on window W between indices START and END.
24875 HL overrides the face for drawing glyph strings, e.g. it is
24876 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24877 x-positions of the drawing area.
24879 This is an ugly monster macro construct because we must use alloca
24880 to allocate glyph strings (because draw_glyphs can be called
24881 asynchronously). */
24883 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24886 HEAD = TAIL = NULL; \
24887 while (START < END) \
24889 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24890 switch (first_glyph->type) \
24893 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24897 case COMPOSITE_GLYPH: \
24898 if (first_glyph->u.cmp.automatic) \
24899 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24902 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24906 case STRETCH_GLYPH: \
24907 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24911 case IMAGE_GLYPH: \
24912 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24916 case GLYPHLESS_GLYPH: \
24917 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24927 set_glyph_string_background_width (s, START, LAST_X); \
24934 /* Draw glyphs between START and END in AREA of ROW on window W,
24935 starting at x-position X. X is relative to AREA in W. HL is a
24936 face-override with the following meaning:
24938 DRAW_NORMAL_TEXT draw normally
24939 DRAW_CURSOR draw in cursor face
24940 DRAW_MOUSE_FACE draw in mouse face.
24941 DRAW_INVERSE_VIDEO draw in mode line face
24942 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24943 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24945 If OVERLAPS is non-zero, draw only the foreground of characters and
24946 clip to the physical height of ROW. Non-zero value also defines
24947 the overlapping part to be drawn:
24949 OVERLAPS_PRED overlap with preceding rows
24950 OVERLAPS_SUCC overlap with succeeding rows
24951 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24952 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24954 Value is the x-position reached, relative to AREA of W. */
24957 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24958 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24959 enum draw_glyphs_face hl
, int overlaps
)
24961 struct glyph_string
*head
, *tail
;
24962 struct glyph_string
*s
;
24963 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24964 int i
, j
, x_reached
, last_x
, area_left
= 0;
24965 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24968 ALLOCATE_HDC (hdc
, f
);
24970 /* Let's rather be paranoid than getting a SEGV. */
24971 end
= min (end
, row
->used
[area
]);
24972 start
= clip_to_bounds (0, start
, end
);
24974 /* Translate X to frame coordinates. Set last_x to the right
24975 end of the drawing area. */
24976 if (row
->full_width_p
)
24978 /* X is relative to the left edge of W, without scroll bars
24980 area_left
= WINDOW_LEFT_EDGE_X (w
);
24981 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24982 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24986 area_left
= window_box_left (w
, area
);
24987 last_x
= area_left
+ window_box_width (w
, area
);
24991 /* Build a doubly-linked list of glyph_string structures between
24992 head and tail from what we have to draw. Note that the macro
24993 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24994 the reason we use a separate variable `i'. */
24997 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24999 x_reached
= tail
->x
+ tail
->background_width
;
25003 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25004 the row, redraw some glyphs in front or following the glyph
25005 strings built above. */
25006 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25008 struct glyph_string
*h
, *t
;
25009 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25010 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25011 bool check_mouse_face
= false;
25014 /* If mouse highlighting is on, we may need to draw adjacent
25015 glyphs using mouse-face highlighting. */
25016 if (area
== TEXT_AREA
&& row
->mouse_face_p
25017 && hlinfo
->mouse_face_beg_row
>= 0
25018 && hlinfo
->mouse_face_end_row
>= 0)
25020 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25022 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25023 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25025 check_mouse_face
= true;
25026 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25027 ? hlinfo
->mouse_face_beg_col
: 0;
25028 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25029 ? hlinfo
->mouse_face_end_col
25030 : row
->used
[TEXT_AREA
];
25034 /* Compute overhangs for all glyph strings. */
25035 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25036 for (s
= head
; s
; s
= s
->next
)
25037 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25039 /* Prepend glyph strings for glyphs in front of the first glyph
25040 string that are overwritten because of the first glyph
25041 string's left overhang. The background of all strings
25042 prepended must be drawn because the first glyph string
25044 i
= left_overwritten (head
);
25047 enum draw_glyphs_face overlap_hl
;
25049 /* If this row contains mouse highlighting, attempt to draw
25050 the overlapped glyphs with the correct highlight. This
25051 code fails if the overlap encompasses more than one glyph
25052 and mouse-highlight spans only some of these glyphs.
25053 However, making it work perfectly involves a lot more
25054 code, and I don't know if the pathological case occurs in
25055 practice, so we'll stick to this for now. --- cyd */
25056 if (check_mouse_face
25057 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25058 overlap_hl
= DRAW_MOUSE_FACE
;
25060 overlap_hl
= DRAW_NORMAL_TEXT
;
25062 if (hl
!= overlap_hl
)
25065 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25066 overlap_hl
, dummy_x
, last_x
);
25068 compute_overhangs_and_x (t
, head
->x
, true);
25069 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25070 if (clip_head
== NULL
)
25074 /* Prepend glyph strings for glyphs in front of the first glyph
25075 string that overwrite that glyph string because of their
25076 right overhang. For these strings, only the foreground must
25077 be drawn, because it draws over the glyph string at `head'.
25078 The background must not be drawn because this would overwrite
25079 right overhangs of preceding glyphs for which no glyph
25081 i
= left_overwriting (head
);
25084 enum draw_glyphs_face overlap_hl
;
25086 if (check_mouse_face
25087 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25088 overlap_hl
= DRAW_MOUSE_FACE
;
25090 overlap_hl
= DRAW_NORMAL_TEXT
;
25092 if (hl
== overlap_hl
|| clip_head
== NULL
)
25094 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25095 overlap_hl
, dummy_x
, last_x
);
25096 for (s
= h
; s
; s
= s
->next
)
25097 s
->background_filled_p
= true;
25098 compute_overhangs_and_x (t
, head
->x
, true);
25099 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25102 /* Append glyphs strings for glyphs following the last glyph
25103 string tail that are overwritten by tail. The background of
25104 these strings has to be drawn because tail's foreground draws
25106 i
= right_overwritten (tail
);
25109 enum draw_glyphs_face overlap_hl
;
25111 if (check_mouse_face
25112 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25113 overlap_hl
= DRAW_MOUSE_FACE
;
25115 overlap_hl
= DRAW_NORMAL_TEXT
;
25117 if (hl
!= overlap_hl
)
25119 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25120 overlap_hl
, x
, last_x
);
25121 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25122 we don't have `end = i;' here. */
25123 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25124 append_glyph_string_lists (&head
, &tail
, h
, t
);
25125 if (clip_tail
== NULL
)
25129 /* Append glyph strings for glyphs following the last glyph
25130 string tail that overwrite tail. The foreground of such
25131 glyphs has to be drawn because it writes into the background
25132 of tail. The background must not be drawn because it could
25133 paint over the foreground of following glyphs. */
25134 i
= right_overwriting (tail
);
25137 enum draw_glyphs_face overlap_hl
;
25138 if (check_mouse_face
25139 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25140 overlap_hl
= DRAW_MOUSE_FACE
;
25142 overlap_hl
= DRAW_NORMAL_TEXT
;
25144 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25146 i
++; /* We must include the Ith glyph. */
25147 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25148 overlap_hl
, x
, last_x
);
25149 for (s
= h
; s
; s
= s
->next
)
25150 s
->background_filled_p
= true;
25151 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25152 append_glyph_string_lists (&head
, &tail
, h
, t
);
25154 if (clip_head
|| clip_tail
)
25155 for (s
= head
; s
; s
= s
->next
)
25157 s
->clip_head
= clip_head
;
25158 s
->clip_tail
= clip_tail
;
25162 /* Draw all strings. */
25163 for (s
= head
; s
; s
= s
->next
)
25164 FRAME_RIF (f
)->draw_glyph_string (s
);
25167 /* When focus a sole frame and move horizontally, this clears on_p
25168 causing a failure to erase prev cursor position. */
25169 if (area
== TEXT_AREA
25170 && !row
->full_width_p
25171 /* When drawing overlapping rows, only the glyph strings'
25172 foreground is drawn, which doesn't erase a cursor
25176 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25177 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25178 : (tail
? tail
->x
+ tail
->background_width
: x
));
25182 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25183 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25187 /* Value is the x-position up to which drawn, relative to AREA of W.
25188 This doesn't include parts drawn because of overhangs. */
25189 if (row
->full_width_p
)
25190 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25192 x_reached
-= area_left
;
25194 RELEASE_HDC (hdc
, f
);
25200 /* Expand row matrix if too narrow. Don't expand if area
25203 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25205 if (!it->f->fonts_changed \
25206 && (it->glyph_row->glyphs[area] \
25207 < it->glyph_row->glyphs[area + 1])) \
25209 it->w->ncols_scale_factor++; \
25210 it->f->fonts_changed = true; \
25214 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25215 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25218 append_glyph (struct it
*it
)
25220 struct glyph
*glyph
;
25221 enum glyph_row_area area
= it
->area
;
25223 eassert (it
->glyph_row
);
25224 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25226 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25227 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25229 /* If the glyph row is reversed, we need to prepend the glyph
25230 rather than append it. */
25231 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25235 /* Make room for the additional glyph. */
25236 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25238 glyph
= it
->glyph_row
->glyphs
[area
];
25240 glyph
->charpos
= CHARPOS (it
->position
);
25241 glyph
->object
= it
->object
;
25242 if (it
->pixel_width
> 0)
25244 glyph
->pixel_width
= it
->pixel_width
;
25245 glyph
->padding_p
= false;
25249 /* Assure at least 1-pixel width. Otherwise, cursor can't
25250 be displayed correctly. */
25251 glyph
->pixel_width
= 1;
25252 glyph
->padding_p
= true;
25254 glyph
->ascent
= it
->ascent
;
25255 glyph
->descent
= it
->descent
;
25256 glyph
->voffset
= it
->voffset
;
25257 glyph
->type
= CHAR_GLYPH
;
25258 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25259 glyph
->multibyte_p
= it
->multibyte_p
;
25260 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25262 /* In R2L rows, the left and the right box edges need to be
25263 drawn in reverse direction. */
25264 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25265 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25269 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25270 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25272 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25273 || it
->phys_descent
> it
->descent
);
25274 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25275 glyph
->face_id
= it
->face_id
;
25276 glyph
->u
.ch
= it
->char_to_display
;
25277 glyph
->slice
.img
= null_glyph_slice
;
25278 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25281 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25282 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25283 glyph
->bidi_type
= it
->bidi_it
.type
;
25287 glyph
->resolved_level
= 0;
25288 glyph
->bidi_type
= UNKNOWN_BT
;
25290 ++it
->glyph_row
->used
[area
];
25293 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25296 /* Store one glyph for the composition IT->cmp_it.id in
25297 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25301 append_composite_glyph (struct it
*it
)
25303 struct glyph
*glyph
;
25304 enum glyph_row_area area
= it
->area
;
25306 eassert (it
->glyph_row
);
25308 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25309 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25311 /* If the glyph row is reversed, we need to prepend the glyph
25312 rather than append it. */
25313 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25317 /* Make room for the new glyph. */
25318 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25320 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25322 glyph
->charpos
= it
->cmp_it
.charpos
;
25323 glyph
->object
= it
->object
;
25324 glyph
->pixel_width
= it
->pixel_width
;
25325 glyph
->ascent
= it
->ascent
;
25326 glyph
->descent
= it
->descent
;
25327 glyph
->voffset
= it
->voffset
;
25328 glyph
->type
= COMPOSITE_GLYPH
;
25329 if (it
->cmp_it
.ch
< 0)
25331 glyph
->u
.cmp
.automatic
= false;
25332 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25333 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25337 glyph
->u
.cmp
.automatic
= true;
25338 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25339 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25340 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25342 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25343 glyph
->multibyte_p
= it
->multibyte_p
;
25344 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25346 /* In R2L rows, the left and the right box edges need to be
25347 drawn in reverse direction. */
25348 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25349 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25353 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25354 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25356 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25357 || it
->phys_descent
> it
->descent
);
25358 glyph
->padding_p
= false;
25359 glyph
->glyph_not_available_p
= false;
25360 glyph
->face_id
= it
->face_id
;
25361 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25364 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25365 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25366 glyph
->bidi_type
= it
->bidi_it
.type
;
25368 ++it
->glyph_row
->used
[area
];
25371 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25375 /* Change IT->ascent and IT->height according to the setting of
25379 take_vertical_position_into_account (struct it
*it
)
25383 if (it
->voffset
< 0)
25384 /* Increase the ascent so that we can display the text higher
25386 it
->ascent
-= it
->voffset
;
25388 /* Increase the descent so that we can display the text lower
25390 it
->descent
+= it
->voffset
;
25395 /* Produce glyphs/get display metrics for the image IT is loaded with.
25396 See the description of struct display_iterator in dispextern.h for
25397 an overview of struct display_iterator. */
25400 produce_image_glyph (struct it
*it
)
25404 int glyph_ascent
, crop
;
25405 struct glyph_slice slice
;
25407 eassert (it
->what
== IT_IMAGE
);
25409 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25411 /* Make sure X resources of the face is loaded. */
25412 prepare_face_for_display (it
->f
, face
);
25414 if (it
->image_id
< 0)
25416 /* Fringe bitmap. */
25417 it
->ascent
= it
->phys_ascent
= 0;
25418 it
->descent
= it
->phys_descent
= 0;
25419 it
->pixel_width
= 0;
25424 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25426 /* Make sure X resources of the image is loaded. */
25427 prepare_image_for_display (it
->f
, img
);
25429 slice
.x
= slice
.y
= 0;
25430 slice
.width
= img
->width
;
25431 slice
.height
= img
->height
;
25433 if (INTEGERP (it
->slice
.x
))
25434 slice
.x
= XINT (it
->slice
.x
);
25435 else if (FLOATP (it
->slice
.x
))
25436 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25438 if (INTEGERP (it
->slice
.y
))
25439 slice
.y
= XINT (it
->slice
.y
);
25440 else if (FLOATP (it
->slice
.y
))
25441 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25443 if (INTEGERP (it
->slice
.width
))
25444 slice
.width
= XINT (it
->slice
.width
);
25445 else if (FLOATP (it
->slice
.width
))
25446 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25448 if (INTEGERP (it
->slice
.height
))
25449 slice
.height
= XINT (it
->slice
.height
);
25450 else if (FLOATP (it
->slice
.height
))
25451 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25453 if (slice
.x
>= img
->width
)
25454 slice
.x
= img
->width
;
25455 if (slice
.y
>= img
->height
)
25456 slice
.y
= img
->height
;
25457 if (slice
.x
+ slice
.width
>= img
->width
)
25458 slice
.width
= img
->width
- slice
.x
;
25459 if (slice
.y
+ slice
.height
> img
->height
)
25460 slice
.height
= img
->height
- slice
.y
;
25462 if (slice
.width
== 0 || slice
.height
== 0)
25465 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25467 it
->descent
= slice
.height
- glyph_ascent
;
25469 it
->descent
+= img
->vmargin
;
25470 if (slice
.y
+ slice
.height
== img
->height
)
25471 it
->descent
+= img
->vmargin
;
25472 it
->phys_descent
= it
->descent
;
25474 it
->pixel_width
= slice
.width
;
25476 it
->pixel_width
+= img
->hmargin
;
25477 if (slice
.x
+ slice
.width
== img
->width
)
25478 it
->pixel_width
+= img
->hmargin
;
25480 /* It's quite possible for images to have an ascent greater than
25481 their height, so don't get confused in that case. */
25482 if (it
->descent
< 0)
25487 if (face
->box
!= FACE_NO_BOX
)
25489 if (face
->box_line_width
> 0)
25492 it
->ascent
+= face
->box_line_width
;
25493 if (slice
.y
+ slice
.height
== img
->height
)
25494 it
->descent
+= face
->box_line_width
;
25497 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25498 it
->pixel_width
+= eabs (face
->box_line_width
);
25499 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25500 it
->pixel_width
+= eabs (face
->box_line_width
);
25503 take_vertical_position_into_account (it
);
25505 /* Automatically crop wide image glyphs at right edge so we can
25506 draw the cursor on same display row. */
25507 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25508 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25510 it
->pixel_width
-= crop
;
25511 slice
.width
-= crop
;
25516 struct glyph
*glyph
;
25517 enum glyph_row_area area
= it
->area
;
25519 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25520 if (it
->glyph_row
->reversed_p
)
25524 /* Make room for the new glyph. */
25525 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25527 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25529 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25531 glyph
->charpos
= CHARPOS (it
->position
);
25532 glyph
->object
= it
->object
;
25533 glyph
->pixel_width
= it
->pixel_width
;
25534 glyph
->ascent
= glyph_ascent
;
25535 glyph
->descent
= it
->descent
;
25536 glyph
->voffset
= it
->voffset
;
25537 glyph
->type
= IMAGE_GLYPH
;
25538 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25539 glyph
->multibyte_p
= it
->multibyte_p
;
25540 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25542 /* In R2L rows, the left and the right box edges need to be
25543 drawn in reverse direction. */
25544 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25545 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25549 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25550 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25552 glyph
->overlaps_vertically_p
= false;
25553 glyph
->padding_p
= false;
25554 glyph
->glyph_not_available_p
= false;
25555 glyph
->face_id
= it
->face_id
;
25556 glyph
->u
.img_id
= img
->id
;
25557 glyph
->slice
.img
= slice
;
25558 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25561 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25562 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25563 glyph
->bidi_type
= it
->bidi_it
.type
;
25565 ++it
->glyph_row
->used
[area
];
25568 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25573 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25574 of the glyph, WIDTH and HEIGHT are the width and height of the
25575 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25578 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25579 int width
, int height
, int ascent
)
25581 struct glyph
*glyph
;
25582 enum glyph_row_area area
= it
->area
;
25584 eassert (ascent
>= 0 && ascent
<= height
);
25586 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25587 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25589 /* If the glyph row is reversed, we need to prepend the glyph
25590 rather than append it. */
25591 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25595 /* Make room for the additional glyph. */
25596 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25598 glyph
= it
->glyph_row
->glyphs
[area
];
25600 /* Decrease the width of the first glyph of the row that
25601 begins before first_visible_x (e.g., due to hscroll).
25602 This is so the overall width of the row becomes smaller
25603 by the scroll amount, and the stretch glyph appended by
25604 extend_face_to_end_of_line will be wider, to shift the
25605 row glyphs to the right. (In L2R rows, the corresponding
25606 left-shift effect is accomplished by setting row->x to a
25607 negative value, which won't work with R2L rows.)
25609 This must leave us with a positive value of WIDTH, since
25610 otherwise the call to move_it_in_display_line_to at the
25611 beginning of display_line would have got past the entire
25612 first glyph, and then it->current_x would have been
25613 greater or equal to it->first_visible_x. */
25614 if (it
->current_x
< it
->first_visible_x
)
25615 width
-= it
->first_visible_x
- it
->current_x
;
25616 eassert (width
> 0);
25618 glyph
->charpos
= CHARPOS (it
->position
);
25619 glyph
->object
= object
;
25620 glyph
->pixel_width
= width
;
25621 glyph
->ascent
= ascent
;
25622 glyph
->descent
= height
- ascent
;
25623 glyph
->voffset
= it
->voffset
;
25624 glyph
->type
= STRETCH_GLYPH
;
25625 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25626 glyph
->multibyte_p
= it
->multibyte_p
;
25627 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25629 /* In R2L rows, the left and the right box edges need to be
25630 drawn in reverse direction. */
25631 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25632 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25636 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25637 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25639 glyph
->overlaps_vertically_p
= false;
25640 glyph
->padding_p
= false;
25641 glyph
->glyph_not_available_p
= false;
25642 glyph
->face_id
= it
->face_id
;
25643 glyph
->u
.stretch
.ascent
= ascent
;
25644 glyph
->u
.stretch
.height
= height
;
25645 glyph
->slice
.img
= null_glyph_slice
;
25646 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25649 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25650 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25651 glyph
->bidi_type
= it
->bidi_it
.type
;
25655 glyph
->resolved_level
= 0;
25656 glyph
->bidi_type
= UNKNOWN_BT
;
25658 ++it
->glyph_row
->used
[area
];
25661 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25664 #endif /* HAVE_WINDOW_SYSTEM */
25666 /* Produce a stretch glyph for iterator IT. IT->object is the value
25667 of the glyph property displayed. The value must be a list
25668 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25671 1. `:width WIDTH' specifies that the space should be WIDTH *
25672 canonical char width wide. WIDTH may be an integer or floating
25675 2. `:relative-width FACTOR' specifies that the width of the stretch
25676 should be computed from the width of the first character having the
25677 `glyph' property, and should be FACTOR times that width.
25679 3. `:align-to HPOS' specifies that the space should be wide enough
25680 to reach HPOS, a value in canonical character units.
25682 Exactly one of the above pairs must be present.
25684 4. `:height HEIGHT' specifies that the height of the stretch produced
25685 should be HEIGHT, measured in canonical character units.
25687 5. `:relative-height FACTOR' specifies that the height of the
25688 stretch should be FACTOR times the height of the characters having
25689 the glyph property.
25691 Either none or exactly one of 4 or 5 must be present.
25693 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25694 of the stretch should be used for the ascent of the stretch.
25695 ASCENT must be in the range 0 <= ASCENT <= 100. */
25698 produce_stretch_glyph (struct it
*it
)
25700 /* (space :width WIDTH :height HEIGHT ...) */
25701 Lisp_Object prop
, plist
;
25702 int width
= 0, height
= 0, align_to
= -1;
25703 bool zero_width_ok_p
= false;
25705 struct font
*font
= NULL
;
25707 #ifdef HAVE_WINDOW_SYSTEM
25709 bool zero_height_ok_p
= false;
25711 if (FRAME_WINDOW_P (it
->f
))
25713 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25714 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25715 prepare_face_for_display (it
->f
, face
);
25719 /* List should start with `space'. */
25720 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25721 plist
= XCDR (it
->object
);
25723 /* Compute the width of the stretch. */
25724 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25725 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
25727 /* Absolute width `:width WIDTH' specified and valid. */
25728 zero_width_ok_p
= true;
25731 #ifdef HAVE_WINDOW_SYSTEM
25732 else if (FRAME_WINDOW_P (it
->f
)
25733 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25735 /* Relative width `:relative-width FACTOR' specified and valid.
25736 Compute the width of the characters having the `glyph'
25739 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25742 if (it
->multibyte_p
)
25743 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25746 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25747 if (! ASCII_CHAR_P (it2
.c
))
25748 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25751 it2
.glyph_row
= NULL
;
25752 it2
.what
= IT_CHARACTER
;
25753 x_produce_glyphs (&it2
);
25754 width
= NUMVAL (prop
) * it2
.pixel_width
;
25756 #endif /* HAVE_WINDOW_SYSTEM */
25757 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25758 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
25761 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25762 align_to
= (align_to
< 0
25764 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25765 else if (align_to
< 0)
25766 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25767 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25768 zero_width_ok_p
= true;
25771 /* Nothing specified -> width defaults to canonical char width. */
25772 width
= FRAME_COLUMN_WIDTH (it
->f
);
25774 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25777 #ifdef HAVE_WINDOW_SYSTEM
25778 /* Compute height. */
25779 if (FRAME_WINDOW_P (it
->f
))
25781 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25782 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
25785 zero_height_ok_p
= true;
25787 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25789 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25791 height
= FONT_HEIGHT (font
);
25793 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25796 /* Compute percentage of height used for ascent. If
25797 `:ascent ASCENT' is present and valid, use that. Otherwise,
25798 derive the ascent from the font in use. */
25799 if (prop
= Fplist_get (plist
, QCascent
),
25800 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25801 ascent
= height
* NUMVAL (prop
) / 100.0;
25802 else if (!NILP (prop
)
25803 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
25804 ascent
= min (max (0, (int)tem
), height
);
25806 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25809 #endif /* HAVE_WINDOW_SYSTEM */
25812 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25813 && it
->current_x
+ width
> it
->last_visible_x
)
25815 width
= it
->last_visible_x
- it
->current_x
;
25816 #ifdef HAVE_WINDOW_SYSTEM
25817 /* Subtract one more pixel from the stretch width, but only on
25818 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25819 width
-= FRAME_WINDOW_P (it
->f
);
25823 if (width
> 0 && height
> 0 && it
->glyph_row
)
25825 Lisp_Object o_object
= it
->object
;
25826 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25829 if (!STRINGP (object
))
25830 object
= it
->w
->contents
;
25831 #ifdef HAVE_WINDOW_SYSTEM
25832 if (FRAME_WINDOW_P (it
->f
))
25833 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25837 it
->object
= object
;
25838 it
->char_to_display
= ' ';
25839 it
->pixel_width
= it
->len
= 1;
25841 tty_append_glyph (it
);
25842 it
->object
= o_object
;
25846 it
->pixel_width
= width
;
25847 #ifdef HAVE_WINDOW_SYSTEM
25848 if (FRAME_WINDOW_P (it
->f
))
25850 it
->ascent
= it
->phys_ascent
= ascent
;
25851 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25852 it
->nglyphs
= width
> 0 && height
> 0;
25853 take_vertical_position_into_account (it
);
25857 it
->nglyphs
= width
;
25860 /* Get information about special display element WHAT in an
25861 environment described by IT. WHAT is one of IT_TRUNCATION or
25862 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25863 non-null glyph_row member. This function ensures that fields like
25864 face_id, c, len of IT are left untouched. */
25867 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25874 temp_it
.object
= Qnil
;
25875 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25877 if (what
== IT_CONTINUATION
)
25879 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25880 if (it
->bidi_it
.paragraph_dir
== R2L
)
25881 SET_GLYPH_FROM_CHAR (glyph
, '/');
25883 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25885 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25887 /* FIXME: Should we mirror GC for R2L lines? */
25888 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25889 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25892 else if (what
== IT_TRUNCATION
)
25894 /* Truncation glyph. */
25895 SET_GLYPH_FROM_CHAR (glyph
, '$');
25897 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25899 /* FIXME: Should we mirror GC for R2L lines? */
25900 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25901 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25907 #ifdef HAVE_WINDOW_SYSTEM
25908 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25909 is turned off, we precede the truncation/continuation glyphs by a
25910 stretch glyph whose width is computed such that these special
25911 glyphs are aligned at the window margin, even when very different
25912 fonts are used in different glyph rows. */
25913 if (FRAME_WINDOW_P (temp_it
.f
)
25914 /* init_iterator calls this with it->glyph_row == NULL, and it
25915 wants only the pixel width of the truncation/continuation
25917 && temp_it
.glyph_row
25918 /* insert_left_trunc_glyphs calls us at the beginning of the
25919 row, and it has its own calculation of the stretch glyph
25921 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25922 && (temp_it
.glyph_row
->reversed_p
25923 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25924 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25926 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25928 if (stretch_width
> 0)
25930 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25931 struct font
*font
=
25932 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25933 int stretch_ascent
=
25934 (((temp_it
.ascent
+ temp_it
.descent
)
25935 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25937 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
25938 temp_it
.ascent
+ temp_it
.descent
,
25945 temp_it
.what
= IT_CHARACTER
;
25946 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25947 temp_it
.face_id
= GLYPH_FACE (glyph
);
25948 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25950 PRODUCE_GLYPHS (&temp_it
);
25951 it
->pixel_width
= temp_it
.pixel_width
;
25952 it
->nglyphs
= temp_it
.nglyphs
;
25955 #ifdef HAVE_WINDOW_SYSTEM
25957 /* Calculate line-height and line-spacing properties.
25958 An integer value specifies explicit pixel value.
25959 A float value specifies relative value to current face height.
25960 A cons (float . face-name) specifies relative value to
25961 height of specified face font.
25963 Returns height in pixels, or nil. */
25966 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25967 int boff
, bool override
)
25969 Lisp_Object face_name
= Qnil
;
25970 int ascent
, descent
, height
;
25972 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25977 face_name
= XCAR (val
);
25979 if (!NUMBERP (val
))
25980 val
= make_number (1);
25981 if (NILP (face_name
))
25983 height
= it
->ascent
+ it
->descent
;
25988 if (NILP (face_name
))
25990 font
= FRAME_FONT (it
->f
);
25991 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25993 else if (EQ (face_name
, Qt
))
26002 face_id
= lookup_named_face (it
->f
, face_name
, false);
26004 return make_number (-1);
26006 face
= FACE_FROM_ID (it
->f
, face_id
);
26009 return make_number (-1);
26010 boff
= font
->baseline_offset
;
26011 if (font
->vertical_centering
)
26012 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26015 ascent
= FONT_BASE (font
) + boff
;
26016 descent
= FONT_DESCENT (font
) - boff
;
26020 it
->override_ascent
= ascent
;
26021 it
->override_descent
= descent
;
26022 it
->override_boff
= boff
;
26025 height
= ascent
+ descent
;
26029 height
= (int)(XFLOAT_DATA (val
) * height
);
26030 else if (INTEGERP (val
))
26031 height
*= XINT (val
);
26033 return make_number (height
);
26037 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26038 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26039 and only if this is for a character for which no font was found.
26041 If the display method (it->glyphless_method) is
26042 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26043 length of the acronym or the hexadecimal string, UPPER_XOFF and
26044 UPPER_YOFF are pixel offsets for the upper part of the string,
26045 LOWER_XOFF and LOWER_YOFF are for the lower part.
26047 For the other display methods, LEN through LOWER_YOFF are zero. */
26050 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26051 short upper_xoff
, short upper_yoff
,
26052 short lower_xoff
, short lower_yoff
)
26054 struct glyph
*glyph
;
26055 enum glyph_row_area area
= it
->area
;
26057 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26058 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26060 /* If the glyph row is reversed, we need to prepend the glyph
26061 rather than append it. */
26062 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26066 /* Make room for the additional glyph. */
26067 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26069 glyph
= it
->glyph_row
->glyphs
[area
];
26071 glyph
->charpos
= CHARPOS (it
->position
);
26072 glyph
->object
= it
->object
;
26073 glyph
->pixel_width
= it
->pixel_width
;
26074 glyph
->ascent
= it
->ascent
;
26075 glyph
->descent
= it
->descent
;
26076 glyph
->voffset
= it
->voffset
;
26077 glyph
->type
= GLYPHLESS_GLYPH
;
26078 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26079 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26080 glyph
->u
.glyphless
.len
= len
;
26081 glyph
->u
.glyphless
.ch
= it
->c
;
26082 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26083 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26084 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26085 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26086 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26087 glyph
->multibyte_p
= it
->multibyte_p
;
26088 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26090 /* In R2L rows, the left and the right box edges need to be
26091 drawn in reverse direction. */
26092 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26093 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26097 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26098 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26100 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26101 || it
->phys_descent
> it
->descent
);
26102 glyph
->padding_p
= false;
26103 glyph
->glyph_not_available_p
= false;
26104 glyph
->face_id
= face_id
;
26105 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26108 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26109 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26110 glyph
->bidi_type
= it
->bidi_it
.type
;
26112 ++it
->glyph_row
->used
[area
];
26115 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26119 /* Produce a glyph for a glyphless character for iterator IT.
26120 IT->glyphless_method specifies which method to use for displaying
26121 the character. See the description of enum
26122 glyphless_display_method in dispextern.h for the detail.
26124 FOR_NO_FONT is true if and only if this is for a character for
26125 which no font was found. ACRONYM, if non-nil, is an acronym string
26126 for the character. */
26129 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26134 int base_width
, base_height
, width
, height
;
26135 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26138 /* Get the metrics of the base font. We always refer to the current
26140 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26141 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26142 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26143 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26144 base_height
= it
->ascent
+ it
->descent
;
26145 base_width
= font
->average_width
;
26147 face_id
= merge_glyphless_glyph_face (it
);
26149 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26151 it
->pixel_width
= THIN_SPACE_WIDTH
;
26153 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26155 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26157 width
= CHAR_WIDTH (it
->c
);
26160 else if (width
> 4)
26162 it
->pixel_width
= base_width
* width
;
26164 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26170 unsigned int code
[6];
26172 int ascent
, descent
;
26173 struct font_metrics metrics_upper
, metrics_lower
;
26175 face
= FACE_FROM_ID (it
->f
, face_id
);
26176 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26177 prepare_face_for_display (it
->f
, face
);
26179 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26181 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26182 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26183 if (CONSP (acronym
))
26184 acronym
= XCAR (acronym
);
26185 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26189 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26190 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26193 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26194 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26195 upper_len
= (len
+ 1) / 2;
26196 font
->driver
->text_extents (font
, code
, upper_len
,
26198 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26203 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26204 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26205 upper_xoff
= upper_yoff
= 2; /* the typical case */
26206 if (base_width
>= width
)
26208 /* Align the upper to the left, the lower to the right. */
26209 it
->pixel_width
= base_width
;
26210 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26214 /* Center the shorter one. */
26215 it
->pixel_width
= width
;
26216 if (metrics_upper
.width
>= metrics_lower
.width
)
26217 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26220 /* FIXME: This code doesn't look right. It formerly was
26221 missing the "lower_xoff = 0;", which couldn't have
26222 been right since it left lower_xoff uninitialized. */
26224 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26228 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26229 top, bottom, and between upper and lower strings. */
26230 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26231 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26232 /* Center vertically.
26233 H:base_height, D:base_descent
26234 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26236 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26237 descent = D - H/2 + h/2;
26238 lower_yoff = descent - 2 - ld;
26239 upper_yoff = lower_yoff - la - 1 - ud; */
26240 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26241 descent
= it
->descent
- (base_height
- height
) / 2;
26242 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26243 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26244 - metrics_upper
.descent
);
26245 /* Don't make the height shorter than the base height. */
26246 if (height
> base_height
)
26248 it
->ascent
= ascent
;
26249 it
->descent
= descent
;
26253 it
->phys_ascent
= it
->ascent
;
26254 it
->phys_descent
= it
->descent
;
26256 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26257 upper_xoff
, upper_yoff
,
26258 lower_xoff
, lower_yoff
);
26260 take_vertical_position_into_account (it
);
26265 Produce glyphs/get display metrics for the display element IT is
26266 loaded with. See the description of struct it in dispextern.h
26267 for an overview of struct it. */
26270 x_produce_glyphs (struct it
*it
)
26272 int extra_line_spacing
= it
->extra_line_spacing
;
26274 it
->glyph_not_available_p
= false;
26276 if (it
->what
== IT_CHARACTER
)
26279 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26280 struct font
*font
= face
->font
;
26281 struct font_metrics
*pcm
= NULL
;
26282 int boff
; /* Baseline offset. */
26286 /* When no suitable font is found, display this character by
26287 the method specified in the first extra slot of
26288 Vglyphless_char_display. */
26289 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26291 eassert (it
->what
== IT_GLYPHLESS
);
26292 produce_glyphless_glyph (it
, true,
26293 STRINGP (acronym
) ? acronym
: Qnil
);
26297 boff
= font
->baseline_offset
;
26298 if (font
->vertical_centering
)
26299 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26301 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26305 if (it
->override_ascent
>= 0)
26307 it
->ascent
= it
->override_ascent
;
26308 it
->descent
= it
->override_descent
;
26309 boff
= it
->override_boff
;
26313 it
->ascent
= FONT_BASE (font
) + boff
;
26314 it
->descent
= FONT_DESCENT (font
) - boff
;
26317 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26319 pcm
= get_per_char_metric (font
, &char2b
);
26320 if (pcm
->width
== 0
26321 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26327 it
->phys_ascent
= pcm
->ascent
+ boff
;
26328 it
->phys_descent
= pcm
->descent
- boff
;
26329 it
->pixel_width
= pcm
->width
;
26333 it
->glyph_not_available_p
= true;
26334 it
->phys_ascent
= it
->ascent
;
26335 it
->phys_descent
= it
->descent
;
26336 it
->pixel_width
= font
->space_width
;
26339 if (it
->constrain_row_ascent_descent_p
)
26341 if (it
->descent
> it
->max_descent
)
26343 it
->ascent
+= it
->descent
- it
->max_descent
;
26344 it
->descent
= it
->max_descent
;
26346 if (it
->ascent
> it
->max_ascent
)
26348 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26349 it
->ascent
= it
->max_ascent
;
26351 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26352 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26353 extra_line_spacing
= 0;
26356 /* If this is a space inside a region of text with
26357 `space-width' property, change its width. */
26359 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26361 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26363 /* If face has a box, add the box thickness to the character
26364 height. If character has a box line to the left and/or
26365 right, add the box line width to the character's width. */
26366 if (face
->box
!= FACE_NO_BOX
)
26368 int thick
= face
->box_line_width
;
26372 it
->ascent
+= thick
;
26373 it
->descent
+= thick
;
26378 if (it
->start_of_box_run_p
)
26379 it
->pixel_width
+= thick
;
26380 if (it
->end_of_box_run_p
)
26381 it
->pixel_width
+= thick
;
26384 /* If face has an overline, add the height of the overline
26385 (1 pixel) and a 1 pixel margin to the character height. */
26386 if (face
->overline_p
)
26387 it
->ascent
+= overline_margin
;
26389 if (it
->constrain_row_ascent_descent_p
)
26391 if (it
->ascent
> it
->max_ascent
)
26392 it
->ascent
= it
->max_ascent
;
26393 if (it
->descent
> it
->max_descent
)
26394 it
->descent
= it
->max_descent
;
26397 take_vertical_position_into_account (it
);
26399 /* If we have to actually produce glyphs, do it. */
26404 /* Translate a space with a `space-width' property
26405 into a stretch glyph. */
26406 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26407 / FONT_HEIGHT (font
));
26408 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26409 it
->ascent
+ it
->descent
, ascent
);
26414 /* If characters with lbearing or rbearing are displayed
26415 in this line, record that fact in a flag of the
26416 glyph row. This is used to optimize X output code. */
26417 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26418 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26420 if (! stretched_p
&& it
->pixel_width
== 0)
26421 /* We assure that all visible glyphs have at least 1-pixel
26423 it
->pixel_width
= 1;
26425 else if (it
->char_to_display
== '\n')
26427 /* A newline has no width, but we need the height of the
26428 line. But if previous part of the line sets a height,
26429 don't increase that height. */
26431 Lisp_Object height
;
26432 Lisp_Object total_height
= Qnil
;
26434 it
->override_ascent
= -1;
26435 it
->pixel_width
= 0;
26438 height
= get_it_property (it
, Qline_height
);
26439 /* Split (line-height total-height) list. */
26441 && CONSP (XCDR (height
))
26442 && NILP (XCDR (XCDR (height
))))
26444 total_height
= XCAR (XCDR (height
));
26445 height
= XCAR (height
);
26447 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26449 if (it
->override_ascent
>= 0)
26451 it
->ascent
= it
->override_ascent
;
26452 it
->descent
= it
->override_descent
;
26453 boff
= it
->override_boff
;
26457 it
->ascent
= FONT_BASE (font
) + boff
;
26458 it
->descent
= FONT_DESCENT (font
) - boff
;
26461 if (EQ (height
, Qt
))
26463 if (it
->descent
> it
->max_descent
)
26465 it
->ascent
+= it
->descent
- it
->max_descent
;
26466 it
->descent
= it
->max_descent
;
26468 if (it
->ascent
> it
->max_ascent
)
26470 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26471 it
->ascent
= it
->max_ascent
;
26473 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26474 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26475 it
->constrain_row_ascent_descent_p
= true;
26476 extra_line_spacing
= 0;
26480 Lisp_Object spacing
;
26482 it
->phys_ascent
= it
->ascent
;
26483 it
->phys_descent
= it
->descent
;
26485 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26486 && face
->box
!= FACE_NO_BOX
26487 && face
->box_line_width
> 0)
26489 it
->ascent
+= face
->box_line_width
;
26490 it
->descent
+= face
->box_line_width
;
26493 && XINT (height
) > it
->ascent
+ it
->descent
)
26494 it
->ascent
= XINT (height
) - it
->descent
;
26496 if (!NILP (total_height
))
26497 spacing
= calc_line_height_property (it
, total_height
, font
,
26501 spacing
= get_it_property (it
, Qline_spacing
);
26502 spacing
= calc_line_height_property (it
, spacing
, font
,
26505 if (INTEGERP (spacing
))
26507 extra_line_spacing
= XINT (spacing
);
26508 if (!NILP (total_height
))
26509 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26513 else /* i.e. (it->char_to_display == '\t') */
26515 if (font
->space_width
> 0)
26517 int tab_width
= it
->tab_width
* font
->space_width
;
26518 int x
= it
->current_x
+ it
->continuation_lines_width
;
26519 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26521 /* If the distance from the current position to the next tab
26522 stop is less than a space character width, use the
26523 tab stop after that. */
26524 if (next_tab_x
- x
< font
->space_width
)
26525 next_tab_x
+= tab_width
;
26527 it
->pixel_width
= next_tab_x
- x
;
26529 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26530 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26534 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26535 it
->ascent
+ it
->descent
, it
->ascent
);
26540 it
->pixel_width
= 0;
26545 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26547 /* A static composition.
26549 Note: A composition is represented as one glyph in the
26550 glyph matrix. There are no padding glyphs.
26552 Important note: pixel_width, ascent, and descent are the
26553 values of what is drawn by draw_glyphs (i.e. the values of
26554 the overall glyphs composed). */
26555 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26556 int boff
; /* baseline offset */
26557 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26558 int glyph_len
= cmp
->glyph_len
;
26559 struct font
*font
= face
->font
;
26563 /* If we have not yet calculated pixel size data of glyphs of
26564 the composition for the current face font, calculate them
26565 now. Theoretically, we have to check all fonts for the
26566 glyphs, but that requires much time and memory space. So,
26567 here we check only the font of the first glyph. This may
26568 lead to incorrect display, but it's very rare, and C-l
26569 (recenter-top-bottom) can correct the display anyway. */
26570 if (! cmp
->font
|| cmp
->font
!= font
)
26572 /* Ascent and descent of the font of the first character
26573 of this composition (adjusted by baseline offset).
26574 Ascent and descent of overall glyphs should not be less
26575 than these, respectively. */
26576 int font_ascent
, font_descent
, font_height
;
26577 /* Bounding box of the overall glyphs. */
26578 int leftmost
, rightmost
, lowest
, highest
;
26579 int lbearing
, rbearing
;
26580 int i
, width
, ascent
, descent
;
26581 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26583 struct font_metrics
*pcm
;
26586 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26587 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26589 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26590 for (i
= 0; i
< glyph_len
; i
++)
26592 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26594 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26596 bool left_padded
= i
> 0;
26598 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26599 : IT_CHARPOS (*it
));
26600 /* If no suitable font is found, use the default font. */
26601 bool font_not_found_p
= font
== NULL
;
26602 if (font_not_found_p
)
26604 face
= face
->ascii_face
;
26607 boff
= font
->baseline_offset
;
26608 if (font
->vertical_centering
)
26609 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26610 font_ascent
= FONT_BASE (font
) + boff
;
26611 font_descent
= FONT_DESCENT (font
) - boff
;
26612 font_height
= FONT_HEIGHT (font
);
26617 if (! font_not_found_p
)
26619 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26621 pcm
= get_per_char_metric (font
, &char2b
);
26624 /* Initialize the bounding box. */
26627 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26628 ascent
= pcm
->ascent
;
26629 descent
= pcm
->descent
;
26630 lbearing
= pcm
->lbearing
;
26631 rbearing
= pcm
->rbearing
;
26635 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26636 ascent
= FONT_BASE (font
);
26637 descent
= FONT_DESCENT (font
);
26644 lowest
= - descent
+ boff
;
26645 highest
= ascent
+ boff
;
26647 if (! font_not_found_p
26648 && font
->default_ascent
26649 && CHAR_TABLE_P (Vuse_default_ascent
)
26650 && !NILP (Faref (Vuse_default_ascent
,
26651 make_number (it
->char_to_display
))))
26652 highest
= font
->default_ascent
+ boff
;
26654 /* Draw the first glyph at the normal position. It may be
26655 shifted to right later if some other glyphs are drawn
26657 cmp
->offsets
[i
* 2] = 0;
26658 cmp
->offsets
[i
* 2 + 1] = boff
;
26659 cmp
->lbearing
= lbearing
;
26660 cmp
->rbearing
= rbearing
;
26662 /* Set cmp->offsets for the remaining glyphs. */
26663 for (i
++; i
< glyph_len
; i
++)
26665 int left
, right
, btm
, top
;
26666 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26668 struct face
*this_face
;
26672 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26673 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26674 font
= this_face
->font
;
26680 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26682 pcm
= get_per_char_metric (font
, &char2b
);
26685 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26688 width
= pcm
->width
;
26689 ascent
= pcm
->ascent
;
26690 descent
= pcm
->descent
;
26691 lbearing
= pcm
->lbearing
;
26692 rbearing
= pcm
->rbearing
;
26693 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26695 /* Relative composition with or without
26696 alternate chars. */
26697 left
= (leftmost
+ rightmost
- width
) / 2;
26698 btm
= - descent
+ boff
;
26699 if (font
->relative_compose
26700 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26701 || NILP (Faref (Vignore_relative_composition
,
26702 make_number (ch
)))))
26705 if (- descent
>= font
->relative_compose
)
26706 /* One extra pixel between two glyphs. */
26708 else if (ascent
<= 0)
26709 /* One extra pixel between two glyphs. */
26710 btm
= lowest
- 1 - ascent
- descent
;
26715 /* A composition rule is specified by an integer
26716 value that encodes global and new reference
26717 points (GREF and NREF). GREF and NREF are
26718 specified by numbers as below:
26720 0---1---2 -- ascent
26724 9--10--11 -- center
26726 ---3---4---5--- baseline
26728 6---7---8 -- descent
26730 int rule
= COMPOSITION_RULE (cmp
, i
);
26731 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26733 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26734 grefx
= gref
% 3, nrefx
= nref
% 3;
26735 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26737 xoff
= font_height
* (xoff
- 128) / 256;
26739 yoff
= font_height
* (yoff
- 128) / 256;
26742 + grefx
* (rightmost
- leftmost
) / 2
26743 - nrefx
* width
/ 2
26746 btm
= ((grefy
== 0 ? highest
26748 : grefy
== 2 ? lowest
26749 : (highest
+ lowest
) / 2)
26750 - (nrefy
== 0 ? ascent
+ descent
26751 : nrefy
== 1 ? descent
- boff
26753 : (ascent
+ descent
) / 2)
26757 cmp
->offsets
[i
* 2] = left
;
26758 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26760 /* Update the bounding box of the overall glyphs. */
26763 right
= left
+ width
;
26764 if (left
< leftmost
)
26766 if (right
> rightmost
)
26769 top
= btm
+ descent
+ ascent
;
26775 if (cmp
->lbearing
> left
+ lbearing
)
26776 cmp
->lbearing
= left
+ lbearing
;
26777 if (cmp
->rbearing
< left
+ rbearing
)
26778 cmp
->rbearing
= left
+ rbearing
;
26782 /* If there are glyphs whose x-offsets are negative,
26783 shift all glyphs to the right and make all x-offsets
26787 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26788 cmp
->offsets
[i
* 2] -= leftmost
;
26789 rightmost
-= leftmost
;
26790 cmp
->lbearing
-= leftmost
;
26791 cmp
->rbearing
-= leftmost
;
26794 if (left_padded
&& cmp
->lbearing
< 0)
26796 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26797 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26798 rightmost
-= cmp
->lbearing
;
26799 cmp
->rbearing
-= cmp
->lbearing
;
26802 if (right_padded
&& rightmost
< cmp
->rbearing
)
26804 rightmost
= cmp
->rbearing
;
26807 cmp
->pixel_width
= rightmost
;
26808 cmp
->ascent
= highest
;
26809 cmp
->descent
= - lowest
;
26810 if (cmp
->ascent
< font_ascent
)
26811 cmp
->ascent
= font_ascent
;
26812 if (cmp
->descent
< font_descent
)
26813 cmp
->descent
= font_descent
;
26817 && (cmp
->lbearing
< 0
26818 || cmp
->rbearing
> cmp
->pixel_width
))
26819 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26821 it
->pixel_width
= cmp
->pixel_width
;
26822 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26823 it
->descent
= it
->phys_descent
= cmp
->descent
;
26824 if (face
->box
!= FACE_NO_BOX
)
26826 int thick
= face
->box_line_width
;
26830 it
->ascent
+= thick
;
26831 it
->descent
+= thick
;
26836 if (it
->start_of_box_run_p
)
26837 it
->pixel_width
+= thick
;
26838 if (it
->end_of_box_run_p
)
26839 it
->pixel_width
+= thick
;
26842 /* If face has an overline, add the height of the overline
26843 (1 pixel) and a 1 pixel margin to the character height. */
26844 if (face
->overline_p
)
26845 it
->ascent
+= overline_margin
;
26847 take_vertical_position_into_account (it
);
26848 if (it
->ascent
< 0)
26850 if (it
->descent
< 0)
26853 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26854 append_composite_glyph (it
);
26856 else if (it
->what
== IT_COMPOSITION
)
26858 /* A dynamic (automatic) composition. */
26859 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26860 Lisp_Object gstring
;
26861 struct font_metrics metrics
;
26865 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26867 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26870 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26871 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26872 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26873 it
->descent
= it
->phys_descent
= metrics
.descent
;
26874 if (face
->box
!= FACE_NO_BOX
)
26876 int thick
= face
->box_line_width
;
26880 it
->ascent
+= thick
;
26881 it
->descent
+= thick
;
26886 if (it
->start_of_box_run_p
)
26887 it
->pixel_width
+= thick
;
26888 if (it
->end_of_box_run_p
)
26889 it
->pixel_width
+= thick
;
26891 /* If face has an overline, add the height of the overline
26892 (1 pixel) and a 1 pixel margin to the character height. */
26893 if (face
->overline_p
)
26894 it
->ascent
+= overline_margin
;
26895 take_vertical_position_into_account (it
);
26896 if (it
->ascent
< 0)
26898 if (it
->descent
< 0)
26902 append_composite_glyph (it
);
26904 else if (it
->what
== IT_GLYPHLESS
)
26905 produce_glyphless_glyph (it
, false, Qnil
);
26906 else if (it
->what
== IT_IMAGE
)
26907 produce_image_glyph (it
);
26908 else if (it
->what
== IT_STRETCH
)
26909 produce_stretch_glyph (it
);
26912 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26913 because this isn't true for images with `:ascent 100'. */
26914 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26915 if (it
->area
== TEXT_AREA
)
26916 it
->current_x
+= it
->pixel_width
;
26918 if (extra_line_spacing
> 0)
26920 it
->descent
+= extra_line_spacing
;
26921 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26922 it
->max_extra_line_spacing
= extra_line_spacing
;
26925 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26926 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26927 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26928 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26932 Output LEN glyphs starting at START at the nominal cursor position.
26933 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26934 being updated, and UPDATED_AREA is the area of that row being updated. */
26937 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26938 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26940 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26942 eassert (updated_row
);
26943 /* When the window is hscrolled, cursor hpos can legitimately be out
26944 of bounds, but we draw the cursor at the corresponding window
26945 margin in that case. */
26946 if (!updated_row
->reversed_p
&& chpos
< 0)
26948 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26949 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26953 /* Write glyphs. */
26955 hpos
= start
- updated_row
->glyphs
[updated_area
];
26956 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26957 updated_row
, updated_area
,
26959 DRAW_NORMAL_TEXT
, 0);
26961 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26962 if (updated_area
== TEXT_AREA
26963 && w
->phys_cursor_on_p
26964 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26966 && chpos
< hpos
+ len
)
26967 w
->phys_cursor_on_p
= false;
26971 /* Advance the output cursor. */
26972 w
->output_cursor
.hpos
+= len
;
26973 w
->output_cursor
.x
= x
;
26978 Insert LEN glyphs from START at the nominal cursor position. */
26981 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26982 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26985 int line_height
, shift_by_width
, shifted_region_width
;
26986 struct glyph_row
*row
;
26987 struct glyph
*glyph
;
26988 int frame_x
, frame_y
;
26991 eassert (updated_row
);
26993 f
= XFRAME (WINDOW_FRAME (w
));
26995 /* Get the height of the line we are in. */
26997 line_height
= row
->height
;
26999 /* Get the width of the glyphs to insert. */
27000 shift_by_width
= 0;
27001 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27002 shift_by_width
+= glyph
->pixel_width
;
27004 /* Get the width of the region to shift right. */
27005 shifted_region_width
= (window_box_width (w
, updated_area
)
27006 - w
->output_cursor
.x
27010 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27011 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27013 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27014 line_height
, shift_by_width
);
27016 /* Write the glyphs. */
27017 hpos
= start
- row
->glyphs
[updated_area
];
27018 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27020 DRAW_NORMAL_TEXT
, 0);
27022 /* Advance the output cursor. */
27023 w
->output_cursor
.hpos
+= len
;
27024 w
->output_cursor
.x
+= shift_by_width
;
27030 Erase the current text line from the nominal cursor position
27031 (inclusive) to pixel column TO_X (exclusive). The idea is that
27032 everything from TO_X onward is already erased.
27034 TO_X is a pixel position relative to UPDATED_AREA of currently
27035 updated window W. TO_X == -1 means clear to the end of this area. */
27038 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27039 enum glyph_row_area updated_area
, int to_x
)
27042 int max_x
, min_y
, max_y
;
27043 int from_x
, from_y
, to_y
;
27045 eassert (updated_row
);
27046 f
= XFRAME (w
->frame
);
27048 if (updated_row
->full_width_p
)
27049 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27050 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27052 max_x
= window_box_width (w
, updated_area
);
27053 max_y
= window_text_bottom_y (w
);
27055 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27056 of window. For TO_X > 0, truncate to end of drawing area. */
27062 to_x
= min (to_x
, max_x
);
27064 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27066 /* Notice if the cursor will be cleared by this operation. */
27067 if (!updated_row
->full_width_p
)
27068 notice_overwritten_cursor (w
, updated_area
,
27069 w
->output_cursor
.x
, -1,
27071 MATRIX_ROW_BOTTOM_Y (updated_row
));
27073 from_x
= w
->output_cursor
.x
;
27075 /* Translate to frame coordinates. */
27076 if (updated_row
->full_width_p
)
27078 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27079 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27083 int area_left
= window_box_left (w
, updated_area
);
27084 from_x
+= area_left
;
27088 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27089 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27090 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27092 /* Prevent inadvertently clearing to end of the X window. */
27093 if (to_x
> from_x
&& to_y
> from_y
)
27096 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27097 to_x
- from_x
, to_y
- from_y
);
27102 #endif /* HAVE_WINDOW_SYSTEM */
27106 /***********************************************************************
27108 ***********************************************************************/
27110 /* Value is the internal representation of the specified cursor type
27111 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27112 of the bar cursor. */
27114 static enum text_cursor_kinds
27115 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27117 enum text_cursor_kinds type
;
27122 if (EQ (arg
, Qbox
))
27123 return FILLED_BOX_CURSOR
;
27125 if (EQ (arg
, Qhollow
))
27126 return HOLLOW_BOX_CURSOR
;
27128 if (EQ (arg
, Qbar
))
27135 && EQ (XCAR (arg
), Qbar
)
27136 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27138 *width
= XINT (XCDR (arg
));
27142 if (EQ (arg
, Qhbar
))
27145 return HBAR_CURSOR
;
27149 && EQ (XCAR (arg
), Qhbar
)
27150 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27152 *width
= XINT (XCDR (arg
));
27153 return HBAR_CURSOR
;
27156 /* Treat anything unknown as "hollow box cursor".
27157 It was bad to signal an error; people have trouble fixing
27158 .Xdefaults with Emacs, when it has something bad in it. */
27159 type
= HOLLOW_BOX_CURSOR
;
27164 /* Set the default cursor types for specified frame. */
27166 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27171 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27172 FRAME_CURSOR_WIDTH (f
) = width
;
27174 /* By default, set up the blink-off state depending on the on-state. */
27176 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27179 FRAME_BLINK_OFF_CURSOR (f
)
27180 = get_specified_cursor_type (XCDR (tem
), &width
);
27181 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27184 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27186 /* Make sure the cursor gets redrawn. */
27187 f
->cursor_type_changed
= true;
27191 #ifdef HAVE_WINDOW_SYSTEM
27193 /* Return the cursor we want to be displayed in window W. Return
27194 width of bar/hbar cursor through WIDTH arg. Return with
27195 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27196 (i.e. if the `system caret' should track this cursor).
27198 In a mini-buffer window, we want the cursor only to appear if we
27199 are reading input from this window. For the selected window, we
27200 want the cursor type given by the frame parameter or buffer local
27201 setting of cursor-type. If explicitly marked off, draw no cursor.
27202 In all other cases, we want a hollow box cursor. */
27204 static enum text_cursor_kinds
27205 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27206 bool *active_cursor
)
27208 struct frame
*f
= XFRAME (w
->frame
);
27209 struct buffer
*b
= XBUFFER (w
->contents
);
27210 int cursor_type
= DEFAULT_CURSOR
;
27211 Lisp_Object alt_cursor
;
27212 bool non_selected
= false;
27214 *active_cursor
= true;
27217 if (cursor_in_echo_area
27218 && FRAME_HAS_MINIBUF_P (f
)
27219 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27221 if (w
== XWINDOW (echo_area_window
))
27223 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27225 *width
= FRAME_CURSOR_WIDTH (f
);
27226 return FRAME_DESIRED_CURSOR (f
);
27229 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27232 *active_cursor
= false;
27233 non_selected
= true;
27236 /* Detect a nonselected window or nonselected frame. */
27237 else if (w
!= XWINDOW (f
->selected_window
)
27238 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27240 *active_cursor
= false;
27242 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27245 non_selected
= true;
27248 /* Never display a cursor in a window in which cursor-type is nil. */
27249 if (NILP (BVAR (b
, cursor_type
)))
27252 /* Get the normal cursor type for this window. */
27253 if (EQ (BVAR (b
, cursor_type
), Qt
))
27255 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27256 *width
= FRAME_CURSOR_WIDTH (f
);
27259 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27261 /* Use cursor-in-non-selected-windows instead
27262 for non-selected window or frame. */
27265 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27266 if (!EQ (Qt
, alt_cursor
))
27267 return get_specified_cursor_type (alt_cursor
, width
);
27268 /* t means modify the normal cursor type. */
27269 if (cursor_type
== FILLED_BOX_CURSOR
)
27270 cursor_type
= HOLLOW_BOX_CURSOR
;
27271 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27273 return cursor_type
;
27276 /* Use normal cursor if not blinked off. */
27277 if (!w
->cursor_off_p
)
27279 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27281 if (cursor_type
== FILLED_BOX_CURSOR
)
27283 /* Using a block cursor on large images can be very annoying.
27284 So use a hollow cursor for "large" images.
27285 If image is not transparent (no mask), also use hollow cursor. */
27286 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27287 if (img
!= NULL
&& IMAGEP (img
->spec
))
27289 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27290 where N = size of default frame font size.
27291 This should cover most of the "tiny" icons people may use. */
27293 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27294 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27295 cursor_type
= HOLLOW_BOX_CURSOR
;
27298 else if (cursor_type
!= NO_CURSOR
)
27300 /* Display current only supports BOX and HOLLOW cursors for images.
27301 So for now, unconditionally use a HOLLOW cursor when cursor is
27302 not a solid box cursor. */
27303 cursor_type
= HOLLOW_BOX_CURSOR
;
27306 return cursor_type
;
27309 /* Cursor is blinked off, so determine how to "toggle" it. */
27311 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27312 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27313 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27315 /* Then see if frame has specified a specific blink off cursor type. */
27316 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27318 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27319 return FRAME_BLINK_OFF_CURSOR (f
);
27323 /* Some people liked having a permanently visible blinking cursor,
27324 while others had very strong opinions against it. So it was
27325 decided to remove it. KFS 2003-09-03 */
27327 /* Finally perform built-in cursor blinking:
27328 filled box <-> hollow box
27329 wide [h]bar <-> narrow [h]bar
27330 narrow [h]bar <-> no cursor
27331 other type <-> no cursor */
27333 if (cursor_type
== FILLED_BOX_CURSOR
)
27334 return HOLLOW_BOX_CURSOR
;
27336 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27339 return cursor_type
;
27347 /* Notice when the text cursor of window W has been completely
27348 overwritten by a drawing operation that outputs glyphs in AREA
27349 starting at X0 and ending at X1 in the line starting at Y0 and
27350 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27351 the rest of the line after X0 has been written. Y coordinates
27352 are window-relative. */
27355 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27356 int x0
, int x1
, int y0
, int y1
)
27358 int cx0
, cx1
, cy0
, cy1
;
27359 struct glyph_row
*row
;
27361 if (!w
->phys_cursor_on_p
)
27363 if (area
!= TEXT_AREA
)
27366 if (w
->phys_cursor
.vpos
< 0
27367 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27368 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27369 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27372 if (row
->cursor_in_fringe_p
)
27374 row
->cursor_in_fringe_p
= false;
27375 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27376 w
->phys_cursor_on_p
= false;
27380 cx0
= w
->phys_cursor
.x
;
27381 cx1
= cx0
+ w
->phys_cursor_width
;
27382 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27385 /* The cursor image will be completely removed from the
27386 screen if the output area intersects the cursor area in
27387 y-direction. When we draw in [y0 y1[, and some part of
27388 the cursor is at y < y0, that part must have been drawn
27389 before. When scrolling, the cursor is erased before
27390 actually scrolling, so we don't come here. When not
27391 scrolling, the rows above the old cursor row must have
27392 changed, and in this case these rows must have written
27393 over the cursor image.
27395 Likewise if part of the cursor is below y1, with the
27396 exception of the cursor being in the first blank row at
27397 the buffer and window end because update_text_area
27398 doesn't draw that row. (Except when it does, but
27399 that's handled in update_text_area.) */
27401 cy0
= w
->phys_cursor
.y
;
27402 cy1
= cy0
+ w
->phys_cursor_height
;
27403 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27406 w
->phys_cursor_on_p
= false;
27409 #endif /* HAVE_WINDOW_SYSTEM */
27412 /************************************************************************
27414 ************************************************************************/
27416 #ifdef HAVE_WINDOW_SYSTEM
27419 Fix the display of area AREA of overlapping row ROW in window W
27420 with respect to the overlapping part OVERLAPS. */
27423 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27424 enum glyph_row_area area
, int overlaps
)
27431 for (i
= 0; i
< row
->used
[area
];)
27433 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27435 int start
= i
, start_x
= x
;
27439 x
+= row
->glyphs
[area
][i
].pixel_width
;
27442 while (i
< row
->used
[area
]
27443 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27445 draw_glyphs (w
, start_x
, row
, area
,
27447 DRAW_NORMAL_TEXT
, overlaps
);
27451 x
+= row
->glyphs
[area
][i
].pixel_width
;
27461 Draw the cursor glyph of window W in glyph row ROW. See the
27462 comment of draw_glyphs for the meaning of HL. */
27465 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27466 enum draw_glyphs_face hl
)
27468 /* If cursor hpos is out of bounds, don't draw garbage. This can
27469 happen in mini-buffer windows when switching between echo area
27470 glyphs and mini-buffer. */
27471 if ((row
->reversed_p
27472 ? (w
->phys_cursor
.hpos
>= 0)
27473 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27475 bool on_p
= w
->phys_cursor_on_p
;
27477 int hpos
= w
->phys_cursor
.hpos
;
27479 /* When the window is hscrolled, cursor hpos can legitimately be
27480 out of bounds, but we draw the cursor at the corresponding
27481 window margin in that case. */
27482 if (!row
->reversed_p
&& hpos
< 0)
27484 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27485 hpos
= row
->used
[TEXT_AREA
] - 1;
27487 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27489 w
->phys_cursor_on_p
= on_p
;
27491 if (hl
== DRAW_CURSOR
)
27492 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27493 /* When we erase the cursor, and ROW is overlapped by other
27494 rows, make sure that these overlapping parts of other rows
27496 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27498 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27500 if (row
> w
->current_matrix
->rows
27501 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27502 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27503 OVERLAPS_ERASED_CURSOR
);
27505 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27506 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27507 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27508 OVERLAPS_ERASED_CURSOR
);
27514 /* Erase the image of a cursor of window W from the screen. */
27517 erase_phys_cursor (struct window
*w
)
27519 struct frame
*f
= XFRAME (w
->frame
);
27520 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27521 int hpos
= w
->phys_cursor
.hpos
;
27522 int vpos
= w
->phys_cursor
.vpos
;
27523 bool mouse_face_here_p
= false;
27524 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27525 struct glyph_row
*cursor_row
;
27526 struct glyph
*cursor_glyph
;
27527 enum draw_glyphs_face hl
;
27529 /* No cursor displayed or row invalidated => nothing to do on the
27531 if (w
->phys_cursor_type
== NO_CURSOR
)
27532 goto mark_cursor_off
;
27534 /* VPOS >= active_glyphs->nrows means that window has been resized.
27535 Don't bother to erase the cursor. */
27536 if (vpos
>= active_glyphs
->nrows
)
27537 goto mark_cursor_off
;
27539 /* If row containing cursor is marked invalid, there is nothing we
27541 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27542 if (!cursor_row
->enabled_p
)
27543 goto mark_cursor_off
;
27545 /* If line spacing is > 0, old cursor may only be partially visible in
27546 window after split-window. So adjust visible height. */
27547 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27548 window_text_bottom_y (w
) - cursor_row
->y
);
27550 /* If row is completely invisible, don't attempt to delete a cursor which
27551 isn't there. This can happen if cursor is at top of a window, and
27552 we switch to a buffer with a header line in that window. */
27553 if (cursor_row
->visible_height
<= 0)
27554 goto mark_cursor_off
;
27556 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27557 if (cursor_row
->cursor_in_fringe_p
)
27559 cursor_row
->cursor_in_fringe_p
= false;
27560 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27561 goto mark_cursor_off
;
27564 /* This can happen when the new row is shorter than the old one.
27565 In this case, either draw_glyphs or clear_end_of_line
27566 should have cleared the cursor. Note that we wouldn't be
27567 able to erase the cursor in this case because we don't have a
27568 cursor glyph at hand. */
27569 if ((cursor_row
->reversed_p
27570 ? (w
->phys_cursor
.hpos
< 0)
27571 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27572 goto mark_cursor_off
;
27574 /* When the window is hscrolled, cursor hpos can legitimately be out
27575 of bounds, but we draw the cursor at the corresponding window
27576 margin in that case. */
27577 if (!cursor_row
->reversed_p
&& hpos
< 0)
27579 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27580 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27582 /* If the cursor is in the mouse face area, redisplay that when
27583 we clear the cursor. */
27584 if (! NILP (hlinfo
->mouse_face_window
)
27585 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27586 /* Don't redraw the cursor's spot in mouse face if it is at the
27587 end of a line (on a newline). The cursor appears there, but
27588 mouse highlighting does not. */
27589 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27590 mouse_face_here_p
= true;
27592 /* Maybe clear the display under the cursor. */
27593 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27596 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27599 cursor_glyph
= get_phys_cursor_glyph (w
);
27600 if (cursor_glyph
== NULL
)
27601 goto mark_cursor_off
;
27603 width
= cursor_glyph
->pixel_width
;
27604 x
= w
->phys_cursor
.x
;
27610 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27611 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27612 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27615 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27618 /* Erase the cursor by redrawing the character underneath it. */
27619 if (mouse_face_here_p
)
27620 hl
= DRAW_MOUSE_FACE
;
27622 hl
= DRAW_NORMAL_TEXT
;
27623 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27626 w
->phys_cursor_on_p
= false;
27627 w
->phys_cursor_type
= NO_CURSOR
;
27631 /* Display or clear cursor of window W. If !ON, clear the cursor.
27632 If ON, display the cursor; where to put the cursor is specified by
27633 HPOS, VPOS, X and Y. */
27636 display_and_set_cursor (struct window
*w
, bool on
,
27637 int hpos
, int vpos
, int x
, int y
)
27639 struct frame
*f
= XFRAME (w
->frame
);
27640 int new_cursor_type
;
27641 int new_cursor_width
;
27642 bool active_cursor
;
27643 struct glyph_row
*glyph_row
;
27644 struct glyph
*glyph
;
27646 /* This is pointless on invisible frames, and dangerous on garbaged
27647 windows and frames; in the latter case, the frame or window may
27648 be in the midst of changing its size, and x and y may be off the
27650 if (! FRAME_VISIBLE_P (f
)
27651 || FRAME_GARBAGED_P (f
)
27652 || vpos
>= w
->current_matrix
->nrows
27653 || hpos
>= w
->current_matrix
->matrix_w
)
27656 /* If cursor is off and we want it off, return quickly. */
27657 if (!on
&& !w
->phys_cursor_on_p
)
27660 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27661 /* If cursor row is not enabled, we don't really know where to
27662 display the cursor. */
27663 if (!glyph_row
->enabled_p
)
27665 w
->phys_cursor_on_p
= false;
27670 if (!glyph_row
->exact_window_width_line_p
27671 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27672 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27674 eassert (input_blocked_p ());
27676 /* Set new_cursor_type to the cursor we want to be displayed. */
27677 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27678 &new_cursor_width
, &active_cursor
);
27680 /* If cursor is currently being shown and we don't want it to be or
27681 it is in the wrong place, or the cursor type is not what we want,
27683 if (w
->phys_cursor_on_p
27685 || w
->phys_cursor
.x
!= x
27686 || w
->phys_cursor
.y
!= y
27687 /* HPOS can be negative in R2L rows whose
27688 exact_window_width_line_p flag is set (i.e. their newline
27689 would "overflow into the fringe"). */
27691 || new_cursor_type
!= w
->phys_cursor_type
27692 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27693 && new_cursor_width
!= w
->phys_cursor_width
)))
27694 erase_phys_cursor (w
);
27696 /* Don't check phys_cursor_on_p here because that flag is only set
27697 to false in some cases where we know that the cursor has been
27698 completely erased, to avoid the extra work of erasing the cursor
27699 twice. In other words, phys_cursor_on_p can be true and the cursor
27700 still not be visible, or it has only been partly erased. */
27703 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27704 w
->phys_cursor_height
= glyph_row
->height
;
27706 /* Set phys_cursor_.* before x_draw_.* is called because some
27707 of them may need the information. */
27708 w
->phys_cursor
.x
= x
;
27709 w
->phys_cursor
.y
= glyph_row
->y
;
27710 w
->phys_cursor
.hpos
= hpos
;
27711 w
->phys_cursor
.vpos
= vpos
;
27714 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27715 new_cursor_type
, new_cursor_width
,
27716 on
, active_cursor
);
27720 /* Switch the display of W's cursor on or off, according to the value
27724 update_window_cursor (struct window
*w
, bool on
)
27726 /* Don't update cursor in windows whose frame is in the process
27727 of being deleted. */
27728 if (w
->current_matrix
)
27730 int hpos
= w
->phys_cursor
.hpos
;
27731 int vpos
= w
->phys_cursor
.vpos
;
27732 struct glyph_row
*row
;
27734 if (vpos
>= w
->current_matrix
->nrows
27735 || hpos
>= w
->current_matrix
->matrix_w
)
27738 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27740 /* When the window is hscrolled, cursor hpos can legitimately be
27741 out of bounds, but we draw the cursor at the corresponding
27742 window margin in that case. */
27743 if (!row
->reversed_p
&& hpos
< 0)
27745 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27746 hpos
= row
->used
[TEXT_AREA
] - 1;
27749 display_and_set_cursor (w
, on
, hpos
, vpos
,
27750 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27756 /* Call update_window_cursor with parameter ON_P on all leaf windows
27757 in the window tree rooted at W. */
27760 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27764 if (WINDOWP (w
->contents
))
27765 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27767 update_window_cursor (w
, on_p
);
27769 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27775 Display the cursor on window W, or clear it, according to ON_P.
27776 Don't change the cursor's position. */
27779 x_update_cursor (struct frame
*f
, bool on_p
)
27781 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27786 Clear the cursor of window W to background color, and mark the
27787 cursor as not shown. This is used when the text where the cursor
27788 is about to be rewritten. */
27791 x_clear_cursor (struct window
*w
)
27793 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27794 update_window_cursor (w
, false);
27797 #endif /* HAVE_WINDOW_SYSTEM */
27799 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27802 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27803 int start_hpos
, int end_hpos
,
27804 enum draw_glyphs_face draw
)
27806 #ifdef HAVE_WINDOW_SYSTEM
27807 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27809 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27813 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27814 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27818 /* Display the active region described by mouse_face_* according to DRAW. */
27821 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27823 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27824 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27826 if (/* If window is in the process of being destroyed, don't bother
27828 w
->current_matrix
!= NULL
27829 /* Don't update mouse highlight if hidden. */
27830 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27831 /* Recognize when we are called to operate on rows that don't exist
27832 anymore. This can happen when a window is split. */
27833 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27835 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
27836 struct glyph_row
*row
, *first
, *last
;
27838 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27839 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27841 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27843 int start_hpos
, end_hpos
, start_x
;
27845 /* For all but the first row, the highlight starts at column 0. */
27848 /* R2L rows have BEG and END in reversed order, but the
27849 screen drawing geometry is always left to right. So
27850 we need to mirror the beginning and end of the
27851 highlighted area in R2L rows. */
27852 if (!row
->reversed_p
)
27854 start_hpos
= hlinfo
->mouse_face_beg_col
;
27855 start_x
= hlinfo
->mouse_face_beg_x
;
27857 else if (row
== last
)
27859 start_hpos
= hlinfo
->mouse_face_end_col
;
27860 start_x
= hlinfo
->mouse_face_end_x
;
27868 else if (row
->reversed_p
&& row
== last
)
27870 start_hpos
= hlinfo
->mouse_face_end_col
;
27871 start_x
= hlinfo
->mouse_face_end_x
;
27881 if (!row
->reversed_p
)
27882 end_hpos
= hlinfo
->mouse_face_end_col
;
27883 else if (row
== first
)
27884 end_hpos
= hlinfo
->mouse_face_beg_col
;
27887 end_hpos
= row
->used
[TEXT_AREA
];
27888 if (draw
== DRAW_NORMAL_TEXT
)
27889 row
->fill_line_p
= true; /* Clear to end of line. */
27892 else if (row
->reversed_p
&& row
== first
)
27893 end_hpos
= hlinfo
->mouse_face_beg_col
;
27896 end_hpos
= row
->used
[TEXT_AREA
];
27897 if (draw
== DRAW_NORMAL_TEXT
)
27898 row
->fill_line_p
= true; /* Clear to end of line. */
27901 if (end_hpos
> start_hpos
)
27903 draw_row_with_mouse_face (w
, start_x
, row
,
27904 start_hpos
, end_hpos
, draw
);
27907 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27911 #ifdef HAVE_WINDOW_SYSTEM
27912 /* When we've written over the cursor, arrange for it to
27913 be displayed again. */
27914 if (FRAME_WINDOW_P (f
)
27915 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27917 int hpos
= w
->phys_cursor
.hpos
;
27919 /* When the window is hscrolled, cursor hpos can legitimately be
27920 out of bounds, but we draw the cursor at the corresponding
27921 window margin in that case. */
27922 if (!row
->reversed_p
&& hpos
< 0)
27924 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27925 hpos
= row
->used
[TEXT_AREA
] - 1;
27928 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
27929 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27932 #endif /* HAVE_WINDOW_SYSTEM */
27935 #ifdef HAVE_WINDOW_SYSTEM
27936 /* Change the mouse cursor. */
27937 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
27939 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27940 if (draw
== DRAW_NORMAL_TEXT
27941 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27942 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27945 if (draw
== DRAW_MOUSE_FACE
)
27946 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27948 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27950 #endif /* HAVE_WINDOW_SYSTEM */
27954 Clear out the mouse-highlighted active region.
27955 Redraw it un-highlighted first. Value is true if mouse
27956 face was actually drawn unhighlighted. */
27959 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27962 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
27964 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27965 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27966 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27967 hlinfo
->mouse_face_window
= Qnil
;
27968 hlinfo
->mouse_face_overlay
= Qnil
;
27972 /* Return true if the coordinates HPOS and VPOS on windows W are
27973 within the mouse face on that window. */
27975 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27977 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27979 /* Quickly resolve the easy cases. */
27980 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27981 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27983 if (vpos
< hlinfo
->mouse_face_beg_row
27984 || vpos
> hlinfo
->mouse_face_end_row
)
27986 if (vpos
> hlinfo
->mouse_face_beg_row
27987 && vpos
< hlinfo
->mouse_face_end_row
)
27990 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27992 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27994 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27997 else if ((vpos
== hlinfo
->mouse_face_beg_row
27998 && hpos
>= hlinfo
->mouse_face_beg_col
)
27999 || (vpos
== hlinfo
->mouse_face_end_row
28000 && hpos
< hlinfo
->mouse_face_end_col
))
28005 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28007 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28010 else if ((vpos
== hlinfo
->mouse_face_beg_row
28011 && hpos
<= hlinfo
->mouse_face_beg_col
)
28012 || (vpos
== hlinfo
->mouse_face_end_row
28013 && hpos
> hlinfo
->mouse_face_end_col
))
28021 True if physical cursor of window W is within mouse face. */
28024 cursor_in_mouse_face_p (struct window
*w
)
28026 int hpos
= w
->phys_cursor
.hpos
;
28027 int vpos
= w
->phys_cursor
.vpos
;
28028 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28030 /* When the window is hscrolled, cursor hpos can legitimately be out
28031 of bounds, but we draw the cursor at the corresponding window
28032 margin in that case. */
28033 if (!row
->reversed_p
&& hpos
< 0)
28035 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28036 hpos
= row
->used
[TEXT_AREA
] - 1;
28038 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28043 /* Find the glyph rows START_ROW and END_ROW of window W that display
28044 characters between buffer positions START_CHARPOS and END_CHARPOS
28045 (excluding END_CHARPOS). DISP_STRING is a display string that
28046 covers these buffer positions. This is similar to
28047 row_containing_pos, but is more accurate when bidi reordering makes
28048 buffer positions change non-linearly with glyph rows. */
28050 rows_from_pos_range (struct window
*w
,
28051 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28052 Lisp_Object disp_string
,
28053 struct glyph_row
**start
, struct glyph_row
**end
)
28055 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28056 int last_y
= window_text_bottom_y (w
);
28057 struct glyph_row
*row
;
28062 while (!first
->enabled_p
28063 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28066 /* Find the START row. */
28068 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28071 /* A row can potentially be the START row if the range of the
28072 characters it displays intersects the range
28073 [START_CHARPOS..END_CHARPOS). */
28074 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28075 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28076 /* See the commentary in row_containing_pos, for the
28077 explanation of the complicated way to check whether
28078 some position is beyond the end of the characters
28079 displayed by a row. */
28080 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28081 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28082 && !row
->ends_at_zv_p
28083 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28084 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28085 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28086 && !row
->ends_at_zv_p
28087 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28089 /* Found a candidate row. Now make sure at least one of the
28090 glyphs it displays has a charpos from the range
28091 [START_CHARPOS..END_CHARPOS).
28093 This is not obvious because bidi reordering could make
28094 buffer positions of a row be 1,2,3,102,101,100, and if we
28095 want to highlight characters in [50..60), we don't want
28096 this row, even though [50..60) does intersect [1..103),
28097 the range of character positions given by the row's start
28098 and end positions. */
28099 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28100 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28104 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28105 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28106 /* A glyph that comes from DISP_STRING is by
28107 definition to be highlighted. */
28108 || EQ (g
->object
, disp_string
))
28117 /* Find the END row. */
28119 /* If the last row is partially visible, start looking for END
28120 from that row, instead of starting from FIRST. */
28121 && !(row
->enabled_p
28122 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28124 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28126 struct glyph_row
*next
= row
+ 1;
28127 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28129 if (!next
->enabled_p
28130 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28131 /* The first row >= START whose range of displayed characters
28132 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28133 is the row END + 1. */
28134 || (start_charpos
< next_start
28135 && end_charpos
< next_start
)
28136 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28137 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28138 && !next
->ends_at_zv_p
28139 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28140 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28141 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28142 && !next
->ends_at_zv_p
28143 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28150 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28151 but none of the characters it displays are in the range, it is
28153 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28154 struct glyph
*s
= g
;
28155 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28159 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28160 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28161 /* If the buffer position of the first glyph in
28162 the row is equal to END_CHARPOS, it means
28163 the last character to be highlighted is the
28164 newline of ROW, and we must consider NEXT as
28166 || (((!next
->reversed_p
&& g
== s
)
28167 || (next
->reversed_p
&& g
== e
- 1))
28168 && (g
->charpos
== end_charpos
28169 /* Special case for when NEXT is an
28170 empty line at ZV. */
28171 || (g
->charpos
== -1
28172 && !row
->ends_at_zv_p
28173 && next_start
== end_charpos
)))))
28174 /* A glyph that comes from DISP_STRING is by
28175 definition to be highlighted. */
28176 || EQ (g
->object
, disp_string
))
28185 /* The first row that ends at ZV must be the last to be
28187 else if (next
->ends_at_zv_p
)
28196 /* This function sets the mouse_face_* elements of HLINFO, assuming
28197 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28198 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28199 for the overlay or run of text properties specifying the mouse
28200 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28201 before-string and after-string that must also be highlighted.
28202 DISP_STRING, if non-nil, is a display string that may cover some
28203 or all of the highlighted text. */
28206 mouse_face_from_buffer_pos (Lisp_Object window
,
28207 Mouse_HLInfo
*hlinfo
,
28208 ptrdiff_t mouse_charpos
,
28209 ptrdiff_t start_charpos
,
28210 ptrdiff_t end_charpos
,
28211 Lisp_Object before_string
,
28212 Lisp_Object after_string
,
28213 Lisp_Object disp_string
)
28215 struct window
*w
= XWINDOW (window
);
28216 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28217 struct glyph_row
*r1
, *r2
;
28218 struct glyph
*glyph
, *end
;
28219 ptrdiff_t ignore
, pos
;
28222 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28223 eassert (NILP (before_string
) || STRINGP (before_string
));
28224 eassert (NILP (after_string
) || STRINGP (after_string
));
28226 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28227 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28229 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28230 /* If the before-string or display-string contains newlines,
28231 rows_from_pos_range skips to its last row. Move back. */
28232 if (!NILP (before_string
) || !NILP (disp_string
))
28234 struct glyph_row
*prev
;
28235 while ((prev
= r1
- 1, prev
>= first
)
28236 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28237 && prev
->used
[TEXT_AREA
] > 0)
28239 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28240 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28241 while (--glyph
>= beg
&& NILP (glyph
->object
));
28243 || !(EQ (glyph
->object
, before_string
)
28244 || EQ (glyph
->object
, disp_string
)))
28251 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28252 hlinfo
->mouse_face_past_end
= true;
28254 else if (!NILP (after_string
))
28256 /* If the after-string has newlines, advance to its last row. */
28257 struct glyph_row
*next
;
28258 struct glyph_row
*last
28259 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28261 for (next
= r2
+ 1;
28263 && next
->used
[TEXT_AREA
] > 0
28264 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28268 /* The rest of the display engine assumes that mouse_face_beg_row is
28269 either above mouse_face_end_row or identical to it. But with
28270 bidi-reordered continued lines, the row for START_CHARPOS could
28271 be below the row for END_CHARPOS. If so, swap the rows and store
28272 them in correct order. */
28275 struct glyph_row
*tem
= r2
;
28281 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28282 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28284 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28285 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28286 could be anywhere in the row and in any order. The strategy
28287 below is to find the leftmost and the rightmost glyph that
28288 belongs to either of these 3 strings, or whose position is
28289 between START_CHARPOS and END_CHARPOS, and highlight all the
28290 glyphs between those two. This may cover more than just the text
28291 between START_CHARPOS and END_CHARPOS if the range of characters
28292 strides the bidi level boundary, e.g. if the beginning is in R2L
28293 text while the end is in L2R text or vice versa. */
28294 if (!r1
->reversed_p
)
28296 /* This row is in a left to right paragraph. Scan it left to
28298 glyph
= r1
->glyphs
[TEXT_AREA
];
28299 end
= glyph
+ r1
->used
[TEXT_AREA
];
28302 /* Skip truncation glyphs at the start of the glyph row. */
28303 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28305 && NILP (glyph
->object
)
28306 && glyph
->charpos
< 0;
28308 x
+= glyph
->pixel_width
;
28310 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28311 or DISP_STRING, and the first glyph from buffer whose
28312 position is between START_CHARPOS and END_CHARPOS. */
28314 && !NILP (glyph
->object
)
28315 && !EQ (glyph
->object
, disp_string
)
28316 && !(BUFFERP (glyph
->object
)
28317 && (glyph
->charpos
>= start_charpos
28318 && glyph
->charpos
< end_charpos
));
28321 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28322 are present at buffer positions between START_CHARPOS and
28323 END_CHARPOS, or if they come from an overlay. */
28324 if (EQ (glyph
->object
, before_string
))
28326 pos
= string_buffer_position (before_string
,
28328 /* If pos == 0, it means before_string came from an
28329 overlay, not from a buffer position. */
28330 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28333 else if (EQ (glyph
->object
, after_string
))
28335 pos
= string_buffer_position (after_string
, end_charpos
);
28336 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28339 x
+= glyph
->pixel_width
;
28341 hlinfo
->mouse_face_beg_x
= x
;
28342 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28346 /* This row is in a right to left paragraph. Scan it right to
28350 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28351 glyph
= end
+ r1
->used
[TEXT_AREA
];
28353 /* Skip truncation glyphs at the start of the glyph row. */
28354 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28356 && NILP (glyph
->object
)
28357 && glyph
->charpos
< 0;
28361 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28362 or DISP_STRING, and the first glyph from buffer whose
28363 position is between START_CHARPOS and END_CHARPOS. */
28365 && !NILP (glyph
->object
)
28366 && !EQ (glyph
->object
, disp_string
)
28367 && !(BUFFERP (glyph
->object
)
28368 && (glyph
->charpos
>= start_charpos
28369 && glyph
->charpos
< end_charpos
));
28372 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28373 are present at buffer positions between START_CHARPOS and
28374 END_CHARPOS, or if they come from an overlay. */
28375 if (EQ (glyph
->object
, before_string
))
28377 pos
= string_buffer_position (before_string
, start_charpos
);
28378 /* If pos == 0, it means before_string came from an
28379 overlay, not from a buffer position. */
28380 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28383 else if (EQ (glyph
->object
, after_string
))
28385 pos
= string_buffer_position (after_string
, end_charpos
);
28386 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28391 glyph
++; /* first glyph to the right of the highlighted area */
28392 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28393 x
+= g
->pixel_width
;
28394 hlinfo
->mouse_face_beg_x
= x
;
28395 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28398 /* If the highlight ends in a different row, compute GLYPH and END
28399 for the end row. Otherwise, reuse the values computed above for
28400 the row where the highlight begins. */
28403 if (!r2
->reversed_p
)
28405 glyph
= r2
->glyphs
[TEXT_AREA
];
28406 end
= glyph
+ r2
->used
[TEXT_AREA
];
28411 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28412 glyph
= end
+ r2
->used
[TEXT_AREA
];
28416 if (!r2
->reversed_p
)
28418 /* Skip truncation and continuation glyphs near the end of the
28419 row, and also blanks and stretch glyphs inserted by
28420 extend_face_to_end_of_line. */
28422 && NILP ((end
- 1)->object
))
28424 /* Scan the rest of the glyph row from the end, looking for the
28425 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28426 DISP_STRING, or whose position is between START_CHARPOS
28430 && !NILP (end
->object
)
28431 && !EQ (end
->object
, disp_string
)
28432 && !(BUFFERP (end
->object
)
28433 && (end
->charpos
>= start_charpos
28434 && end
->charpos
< end_charpos
));
28437 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28438 are present at buffer positions between START_CHARPOS and
28439 END_CHARPOS, or if they come from an overlay. */
28440 if (EQ (end
->object
, before_string
))
28442 pos
= string_buffer_position (before_string
, start_charpos
);
28443 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28446 else if (EQ (end
->object
, after_string
))
28448 pos
= string_buffer_position (after_string
, end_charpos
);
28449 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28453 /* Find the X coordinate of the last glyph to be highlighted. */
28454 for (; glyph
<= end
; ++glyph
)
28455 x
+= glyph
->pixel_width
;
28457 hlinfo
->mouse_face_end_x
= x
;
28458 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28462 /* Skip truncation and continuation glyphs near the end of the
28463 row, and also blanks and stretch glyphs inserted by
28464 extend_face_to_end_of_line. */
28468 && NILP (end
->object
))
28470 x
+= end
->pixel_width
;
28473 /* Scan the rest of the glyph row from the end, looking for the
28474 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28475 DISP_STRING, or whose position is between START_CHARPOS
28479 && !NILP (end
->object
)
28480 && !EQ (end
->object
, disp_string
)
28481 && !(BUFFERP (end
->object
)
28482 && (end
->charpos
>= start_charpos
28483 && end
->charpos
< end_charpos
));
28486 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28487 are present at buffer positions between START_CHARPOS and
28488 END_CHARPOS, or if they come from an overlay. */
28489 if (EQ (end
->object
, before_string
))
28491 pos
= string_buffer_position (before_string
, start_charpos
);
28492 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28495 else if (EQ (end
->object
, after_string
))
28497 pos
= string_buffer_position (after_string
, end_charpos
);
28498 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28501 x
+= end
->pixel_width
;
28503 /* If we exited the above loop because we arrived at the last
28504 glyph of the row, and its buffer position is still not in
28505 range, it means the last character in range is the preceding
28506 newline. Bump the end column and x values to get past the
28509 && BUFFERP (end
->object
)
28510 && (end
->charpos
< start_charpos
28511 || end
->charpos
>= end_charpos
))
28513 x
+= end
->pixel_width
;
28516 hlinfo
->mouse_face_end_x
= x
;
28517 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28520 hlinfo
->mouse_face_window
= window
;
28521 hlinfo
->mouse_face_face_id
28522 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28524 !hlinfo
->mouse_face_hidden
, -1);
28525 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28528 /* The following function is not used anymore (replaced with
28529 mouse_face_from_string_pos), but I leave it here for the time
28530 being, in case someone would. */
28532 #if false /* not used */
28534 /* Find the position of the glyph for position POS in OBJECT in
28535 window W's current matrix, and return in *X, *Y the pixel
28536 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28538 RIGHT_P means return the position of the right edge of the glyph.
28539 !RIGHT_P means return the left edge position.
28541 If no glyph for POS exists in the matrix, return the position of
28542 the glyph with the next smaller position that is in the matrix, if
28543 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28544 exists in the matrix, return the position of the glyph with the
28545 next larger position in OBJECT.
28547 Value is true if a glyph was found. */
28550 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28551 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28553 int yb
= window_text_bottom_y (w
);
28554 struct glyph_row
*r
;
28555 struct glyph
*best_glyph
= NULL
;
28556 struct glyph_row
*best_row
= NULL
;
28559 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28560 r
->enabled_p
&& r
->y
< yb
;
28563 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28564 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28567 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28568 if (EQ (g
->object
, object
))
28570 if (g
->charpos
== pos
)
28577 else if (best_glyph
== NULL
28578 || ((eabs (g
->charpos
- pos
)
28579 < eabs (best_glyph
->charpos
- pos
))
28582 : g
->charpos
> pos
)))
28596 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28600 *x
+= best_glyph
->pixel_width
;
28605 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28608 return best_glyph
!= NULL
;
28610 #endif /* not used */
28612 /* Find the positions of the first and the last glyphs in window W's
28613 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28614 (assumed to be a string), and return in HLINFO's mouse_face_*
28615 members the pixel and column/row coordinates of those glyphs. */
28618 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28619 Lisp_Object object
,
28620 ptrdiff_t startpos
, ptrdiff_t endpos
)
28622 int yb
= window_text_bottom_y (w
);
28623 struct glyph_row
*r
;
28624 struct glyph
*g
, *e
;
28626 bool found
= false;
28628 /* Find the glyph row with at least one position in the range
28629 [STARTPOS..ENDPOS), and the first glyph in that row whose
28630 position belongs to that range. */
28631 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28632 r
->enabled_p
&& r
->y
< yb
;
28635 if (!r
->reversed_p
)
28637 g
= r
->glyphs
[TEXT_AREA
];
28638 e
= g
+ r
->used
[TEXT_AREA
];
28639 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28640 if (EQ (g
->object
, object
)
28641 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28643 hlinfo
->mouse_face_beg_row
28644 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28645 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28646 hlinfo
->mouse_face_beg_x
= gx
;
28655 e
= r
->glyphs
[TEXT_AREA
];
28656 g
= e
+ r
->used
[TEXT_AREA
];
28657 for ( ; g
> e
; --g
)
28658 if (EQ ((g
-1)->object
, object
)
28659 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28661 hlinfo
->mouse_face_beg_row
28662 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28663 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28664 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28665 gx
+= g1
->pixel_width
;
28666 hlinfo
->mouse_face_beg_x
= gx
;
28678 /* Starting with the next row, look for the first row which does NOT
28679 include any glyphs whose positions are in the range. */
28680 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28682 g
= r
->glyphs
[TEXT_AREA
];
28683 e
= g
+ r
->used
[TEXT_AREA
];
28685 for ( ; g
< e
; ++g
)
28686 if (EQ (g
->object
, object
)
28687 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28696 /* The highlighted region ends on the previous row. */
28699 /* Set the end row. */
28700 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28702 /* Compute and set the end column and the end column's horizontal
28703 pixel coordinate. */
28704 if (!r
->reversed_p
)
28706 g
= r
->glyphs
[TEXT_AREA
];
28707 e
= g
+ r
->used
[TEXT_AREA
];
28708 for ( ; e
> g
; --e
)
28709 if (EQ ((e
-1)->object
, object
)
28710 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28712 hlinfo
->mouse_face_end_col
= e
- g
;
28714 for (gx
= r
->x
; g
< e
; ++g
)
28715 gx
+= g
->pixel_width
;
28716 hlinfo
->mouse_face_end_x
= gx
;
28720 e
= r
->glyphs
[TEXT_AREA
];
28721 g
= e
+ r
->used
[TEXT_AREA
];
28722 for (gx
= r
->x
; e
< g
; ++e
)
28724 if (EQ (e
->object
, object
)
28725 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28727 gx
+= e
->pixel_width
;
28729 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28730 hlinfo
->mouse_face_end_x
= gx
;
28734 #ifdef HAVE_WINDOW_SYSTEM
28736 /* See if position X, Y is within a hot-spot of an image. */
28739 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28741 if (!CONSP (hot_spot
))
28744 if (EQ (XCAR (hot_spot
), Qrect
))
28746 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28747 Lisp_Object rect
= XCDR (hot_spot
);
28751 if (!CONSP (XCAR (rect
)))
28753 if (!CONSP (XCDR (rect
)))
28755 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28757 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28759 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28761 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28765 else if (EQ (XCAR (hot_spot
), Qcircle
))
28767 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28768 Lisp_Object circ
= XCDR (hot_spot
);
28769 Lisp_Object lr
, lx0
, ly0
;
28771 && CONSP (XCAR (circ
))
28772 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28773 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28774 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28776 double r
= XFLOATINT (lr
);
28777 double dx
= XINT (lx0
) - x
;
28778 double dy
= XINT (ly0
) - y
;
28779 return (dx
* dx
+ dy
* dy
<= r
* r
);
28782 else if (EQ (XCAR (hot_spot
), Qpoly
))
28784 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28785 if (VECTORP (XCDR (hot_spot
)))
28787 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28788 Lisp_Object
*poly
= v
->contents
;
28789 ptrdiff_t n
= v
->header
.size
;
28791 bool inside
= false;
28792 Lisp_Object lx
, ly
;
28795 /* Need an even number of coordinates, and at least 3 edges. */
28796 if (n
< 6 || n
& 1)
28799 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28800 If count is odd, we are inside polygon. Pixels on edges
28801 may or may not be included depending on actual geometry of the
28803 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28804 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28806 x0
= XINT (lx
), y0
= XINT (ly
);
28807 for (i
= 0; i
< n
; i
+= 2)
28809 int x1
= x0
, y1
= y0
;
28810 if ((lx
= poly
[i
], !INTEGERP (lx
))
28811 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28813 x0
= XINT (lx
), y0
= XINT (ly
);
28815 /* Does this segment cross the X line? */
28823 if (y
> y0
&& y
> y1
)
28825 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28835 find_hot_spot (Lisp_Object map
, int x
, int y
)
28837 while (CONSP (map
))
28839 if (CONSP (XCAR (map
))
28840 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28848 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28850 doc
: /* Lookup in image map MAP coordinates X and Y.
28851 An image map is an alist where each element has the format (AREA ID PLIST).
28852 An AREA is specified as either a rectangle, a circle, or a polygon:
28853 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28854 pixel coordinates of the upper left and bottom right corners.
28855 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28856 and the radius of the circle; r may be a float or integer.
28857 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28858 vector describes one corner in the polygon.
28859 Returns the alist element for the first matching AREA in MAP. */)
28860 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28868 return find_hot_spot (map
,
28869 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28870 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28874 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28876 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28878 /* Do not change cursor shape while dragging mouse. */
28879 if (!NILP (do_mouse_tracking
))
28882 if (!NILP (pointer
))
28884 if (EQ (pointer
, Qarrow
))
28885 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28886 else if (EQ (pointer
, Qhand
))
28887 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28888 else if (EQ (pointer
, Qtext
))
28889 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28890 else if (EQ (pointer
, intern ("hdrag")))
28891 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28892 else if (EQ (pointer
, intern ("nhdrag")))
28893 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28894 #ifdef HAVE_X_WINDOWS
28895 else if (EQ (pointer
, intern ("vdrag")))
28896 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28898 else if (EQ (pointer
, intern ("hourglass")))
28899 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28900 else if (EQ (pointer
, Qmodeline
))
28901 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28903 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28906 if (cursor
!= No_Cursor
)
28907 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28910 #endif /* HAVE_WINDOW_SYSTEM */
28912 /* Take proper action when mouse has moved to the mode or header line
28913 or marginal area AREA of window W, x-position X and y-position Y.
28914 X is relative to the start of the text display area of W, so the
28915 width of bitmap areas and scroll bars must be subtracted to get a
28916 position relative to the start of the mode line. */
28919 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28920 enum window_part area
)
28922 struct window
*w
= XWINDOW (window
);
28923 struct frame
*f
= XFRAME (w
->frame
);
28924 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28925 #ifdef HAVE_WINDOW_SYSTEM
28926 Display_Info
*dpyinfo
;
28928 Cursor cursor
= No_Cursor
;
28929 Lisp_Object pointer
= Qnil
;
28930 int dx
, dy
, width
, height
;
28932 Lisp_Object string
, object
= Qnil
;
28933 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28935 Lisp_Object mouse_face
;
28936 int original_x_pixel
= x
;
28937 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28938 struct glyph_row
*row
IF_LINT (= 0);
28940 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28945 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28946 returns them in row/column units! */
28947 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28948 &object
, &dx
, &dy
, &width
, &height
);
28950 row
= (area
== ON_MODE_LINE
28951 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28952 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28954 /* Find the glyph under the mouse pointer. */
28955 if (row
->mode_line_p
&& row
->enabled_p
)
28957 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28958 end
= glyph
+ row
->used
[TEXT_AREA
];
28960 for (x0
= original_x_pixel
;
28961 glyph
< end
&& x0
>= glyph
->pixel_width
;
28963 x0
-= glyph
->pixel_width
;
28971 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28972 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28973 returns them in row/column units! */
28974 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28975 &object
, &dx
, &dy
, &width
, &height
);
28980 #ifdef HAVE_WINDOW_SYSTEM
28981 if (IMAGEP (object
))
28983 Lisp_Object image_map
, hotspot
;
28984 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28986 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28988 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28992 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28993 If so, we could look for mouse-enter, mouse-leave
28994 properties in PLIST (and do something...). */
28995 hotspot
= XCDR (hotspot
);
28996 if (CONSP (hotspot
)
28997 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28999 pointer
= Fplist_get (plist
, Qpointer
);
29000 if (NILP (pointer
))
29002 help
= Fplist_get (plist
, Qhelp_echo
);
29005 help_echo_string
= help
;
29006 XSETWINDOW (help_echo_window
, w
);
29007 help_echo_object
= w
->contents
;
29008 help_echo_pos
= charpos
;
29012 if (NILP (pointer
))
29013 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29015 #endif /* HAVE_WINDOW_SYSTEM */
29017 if (STRINGP (string
))
29018 pos
= make_number (charpos
);
29020 /* Set the help text and mouse pointer. If the mouse is on a part
29021 of the mode line without any text (e.g. past the right edge of
29022 the mode line text), use the default help text and pointer. */
29023 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29025 /* Arrange to display the help by setting the global variables
29026 help_echo_string, help_echo_object, and help_echo_pos. */
29029 if (STRINGP (string
))
29030 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29034 help_echo_string
= help
;
29035 XSETWINDOW (help_echo_window
, w
);
29036 help_echo_object
= string
;
29037 help_echo_pos
= charpos
;
29039 else if (area
== ON_MODE_LINE
)
29041 Lisp_Object default_help
29042 = buffer_local_value (Qmode_line_default_help_echo
,
29045 if (STRINGP (default_help
))
29047 help_echo_string
= default_help
;
29048 XSETWINDOW (help_echo_window
, w
);
29049 help_echo_object
= Qnil
;
29050 help_echo_pos
= -1;
29055 #ifdef HAVE_WINDOW_SYSTEM
29056 /* Change the mouse pointer according to what is under it. */
29057 if (FRAME_WINDOW_P (f
))
29059 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29061 || NILP (Vresize_mini_windows
));
29063 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29064 if (STRINGP (string
))
29066 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29068 if (NILP (pointer
))
29069 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29071 /* Change the mouse pointer according to what is under X/Y. */
29073 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29076 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29077 if (!KEYMAPP (map
))
29078 map
= Fget_text_property (pos
, Qkeymap
, string
);
29079 if (!KEYMAPP (map
) && draggable
)
29080 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29083 else if (draggable
)
29084 /* Default mode-line pointer. */
29085 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29090 /* Change the mouse face according to what is under X/Y. */
29091 if (STRINGP (string
))
29093 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29094 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29095 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29100 struct glyph
* tmp_glyph
;
29104 int total_pixel_width
;
29105 ptrdiff_t begpos
, endpos
, ignore
;
29109 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29110 Qmouse_face
, string
, Qnil
);
29116 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29118 endpos
= SCHARS (string
);
29122 /* Calculate the glyph position GPOS of GLYPH in the
29123 displayed string, relative to the beginning of the
29124 highlighted part of the string.
29126 Note: GPOS is different from CHARPOS. CHARPOS is the
29127 position of GLYPH in the internal string object. A mode
29128 line string format has structures which are converted to
29129 a flattened string by the Emacs Lisp interpreter. The
29130 internal string is an element of those structures. The
29131 displayed string is the flattened string. */
29132 tmp_glyph
= row_start_glyph
;
29133 while (tmp_glyph
< glyph
29134 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29135 && begpos
<= tmp_glyph
->charpos
29136 && tmp_glyph
->charpos
< endpos
)))
29138 gpos
= glyph
- tmp_glyph
;
29140 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29141 the highlighted part of the displayed string to which
29142 GLYPH belongs. Note: GSEQ_LENGTH is different from
29143 SCHARS (STRING), because the latter returns the length of
29144 the internal string. */
29145 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29147 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29148 && begpos
<= tmp_glyph
->charpos
29149 && tmp_glyph
->charpos
< endpos
));
29152 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29154 /* Calculate the total pixel width of all the glyphs between
29155 the beginning of the highlighted area and GLYPH. */
29156 total_pixel_width
= 0;
29157 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29158 total_pixel_width
+= tmp_glyph
->pixel_width
;
29160 /* Pre calculation of re-rendering position. Note: X is in
29161 column units here, after the call to mode_line_string or
29162 marginal_area_string. */
29164 vpos
= (area
== ON_MODE_LINE
29165 ? (w
->current_matrix
)->nrows
- 1
29168 /* If GLYPH's position is included in the region that is
29169 already drawn in mouse face, we have nothing to do. */
29170 if ( EQ (window
, hlinfo
->mouse_face_window
)
29171 && (!row
->reversed_p
29172 ? (hlinfo
->mouse_face_beg_col
<= hpos
29173 && hpos
< hlinfo
->mouse_face_end_col
)
29174 /* In R2L rows we swap BEG and END, see below. */
29175 : (hlinfo
->mouse_face_end_col
<= hpos
29176 && hpos
< hlinfo
->mouse_face_beg_col
))
29177 && hlinfo
->mouse_face_beg_row
== vpos
)
29180 if (clear_mouse_face (hlinfo
))
29181 cursor
= No_Cursor
;
29183 if (!row
->reversed_p
)
29185 hlinfo
->mouse_face_beg_col
= hpos
;
29186 hlinfo
->mouse_face_beg_x
= original_x_pixel
29187 - (total_pixel_width
+ dx
);
29188 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29189 hlinfo
->mouse_face_end_x
= 0;
29193 /* In R2L rows, show_mouse_face expects BEG and END
29194 coordinates to be swapped. */
29195 hlinfo
->mouse_face_end_col
= hpos
;
29196 hlinfo
->mouse_face_end_x
= original_x_pixel
29197 - (total_pixel_width
+ dx
);
29198 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29199 hlinfo
->mouse_face_beg_x
= 0;
29202 hlinfo
->mouse_face_beg_row
= vpos
;
29203 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29204 hlinfo
->mouse_face_past_end
= false;
29205 hlinfo
->mouse_face_window
= window
;
29207 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29212 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29214 if (NILP (pointer
))
29217 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29218 clear_mouse_face (hlinfo
);
29220 #ifdef HAVE_WINDOW_SYSTEM
29221 if (FRAME_WINDOW_P (f
))
29222 define_frame_cursor1 (f
, cursor
, pointer
);
29228 Take proper action when the mouse has moved to position X, Y on
29229 frame F with regards to highlighting portions of display that have
29230 mouse-face properties. Also de-highlight portions of display where
29231 the mouse was before, set the mouse pointer shape as appropriate
29232 for the mouse coordinates, and activate help echo (tooltips).
29233 X and Y can be negative or out of range. */
29236 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29238 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29239 enum window_part part
= ON_NOTHING
;
29240 Lisp_Object window
;
29242 Cursor cursor
= No_Cursor
;
29243 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29246 /* When a menu is active, don't highlight because this looks odd. */
29247 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29248 if (popup_activated ())
29252 if (!f
->glyphs_initialized_p
29253 || f
->pointer_invisible
)
29256 hlinfo
->mouse_face_mouse_x
= x
;
29257 hlinfo
->mouse_face_mouse_y
= y
;
29258 hlinfo
->mouse_face_mouse_frame
= f
;
29260 if (hlinfo
->mouse_face_defer
)
29263 /* Which window is that in? */
29264 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29266 /* If displaying active text in another window, clear that. */
29267 if (! EQ (window
, hlinfo
->mouse_face_window
)
29268 /* Also clear if we move out of text area in same window. */
29269 || (!NILP (hlinfo
->mouse_face_window
)
29272 && part
!= ON_MODE_LINE
29273 && part
!= ON_HEADER_LINE
))
29274 clear_mouse_face (hlinfo
);
29276 /* Not on a window -> return. */
29277 if (!WINDOWP (window
))
29280 /* Reset help_echo_string. It will get recomputed below. */
29281 help_echo_string
= Qnil
;
29283 /* Convert to window-relative pixel coordinates. */
29284 w
= XWINDOW (window
);
29285 frame_to_window_pixel_xy (w
, &x
, &y
);
29287 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29288 /* Handle tool-bar window differently since it doesn't display a
29290 if (EQ (window
, f
->tool_bar_window
))
29292 note_tool_bar_highlight (f
, x
, y
);
29297 /* Mouse is on the mode, header line or margin? */
29298 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29299 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29301 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29303 #ifdef HAVE_WINDOW_SYSTEM
29304 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29306 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29307 /* Show non-text cursor (Bug#16647). */
29315 #ifdef HAVE_WINDOW_SYSTEM
29316 if (part
== ON_VERTICAL_BORDER
)
29318 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29319 help_echo_string
= build_string ("drag-mouse-1: resize");
29321 else if (part
== ON_RIGHT_DIVIDER
)
29323 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29324 help_echo_string
= build_string ("drag-mouse-1: resize");
29326 else if (part
== ON_BOTTOM_DIVIDER
)
29327 if (! WINDOW_BOTTOMMOST_P (w
)
29329 || NILP (Vresize_mini_windows
))
29331 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29332 help_echo_string
= build_string ("drag-mouse-1: resize");
29335 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29336 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29337 || part
== ON_VERTICAL_SCROLL_BAR
29338 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29339 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29341 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29344 /* Are we in a window whose display is up to date?
29345 And verify the buffer's text has not changed. */
29346 b
= XBUFFER (w
->contents
);
29347 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29349 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29351 struct glyph
*glyph
;
29352 Lisp_Object object
;
29353 Lisp_Object mouse_face
= Qnil
, position
;
29354 Lisp_Object
*overlay_vec
= NULL
;
29355 ptrdiff_t i
, noverlays
;
29356 struct buffer
*obuf
;
29357 ptrdiff_t obegv
, ozv
;
29360 /* Find the glyph under X/Y. */
29361 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29363 #ifdef HAVE_WINDOW_SYSTEM
29364 /* Look for :pointer property on image. */
29365 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29367 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29368 if (img
!= NULL
&& IMAGEP (img
->spec
))
29370 Lisp_Object image_map
, hotspot
;
29371 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29373 && (hotspot
= find_hot_spot (image_map
,
29374 glyph
->slice
.img
.x
+ dx
,
29375 glyph
->slice
.img
.y
+ dy
),
29377 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29381 /* Could check XCAR (hotspot) to see if we enter/leave
29383 If so, we could look for mouse-enter, mouse-leave
29384 properties in PLIST (and do something...). */
29385 hotspot
= XCDR (hotspot
);
29386 if (CONSP (hotspot
)
29387 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29389 pointer
= Fplist_get (plist
, Qpointer
);
29390 if (NILP (pointer
))
29392 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29393 if (!NILP (help_echo_string
))
29395 help_echo_window
= window
;
29396 help_echo_object
= glyph
->object
;
29397 help_echo_pos
= glyph
->charpos
;
29401 if (NILP (pointer
))
29402 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29405 #endif /* HAVE_WINDOW_SYSTEM */
29407 /* Clear mouse face if X/Y not over text. */
29409 || area
!= TEXT_AREA
29410 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29411 /* Glyph's OBJECT is nil for glyphs inserted by the
29412 display engine for its internal purposes, like truncation
29413 and continuation glyphs and blanks beyond the end of
29414 line's text on text terminals. If we are over such a
29415 glyph, we are not over any text. */
29416 || NILP (glyph
->object
)
29417 /* R2L rows have a stretch glyph at their front, which
29418 stands for no text, whereas L2R rows have no glyphs at
29419 all beyond the end of text. Treat such stretch glyphs
29420 like we do with NULL glyphs in L2R rows. */
29421 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29422 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29423 && glyph
->type
== STRETCH_GLYPH
29424 && glyph
->avoid_cursor_p
))
29426 if (clear_mouse_face (hlinfo
))
29427 cursor
= No_Cursor
;
29428 #ifdef HAVE_WINDOW_SYSTEM
29429 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29431 if (area
!= TEXT_AREA
)
29432 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29434 pointer
= Vvoid_text_area_pointer
;
29440 pos
= glyph
->charpos
;
29441 object
= glyph
->object
;
29442 if (!STRINGP (object
) && !BUFFERP (object
))
29445 /* If we get an out-of-range value, return now; avoid an error. */
29446 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29449 /* Make the window's buffer temporarily current for
29450 overlays_at and compute_char_face. */
29451 obuf
= current_buffer
;
29452 current_buffer
= b
;
29458 /* Is this char mouse-active or does it have help-echo? */
29459 position
= make_number (pos
);
29463 if (BUFFERP (object
))
29465 /* Put all the overlays we want in a vector in overlay_vec. */
29466 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29467 /* Sort overlays into increasing priority order. */
29468 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29473 if (NILP (Vmouse_highlight
))
29475 clear_mouse_face (hlinfo
);
29476 goto check_help_echo
;
29479 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29482 cursor
= No_Cursor
;
29484 /* Check mouse-face highlighting. */
29486 /* If there exists an overlay with mouse-face overlapping
29487 the one we are currently highlighting, we have to
29488 check if we enter the overlapping overlay, and then
29489 highlight only that. */
29490 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29491 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29493 /* Find the highest priority overlay with a mouse-face. */
29494 Lisp_Object overlay
= Qnil
;
29495 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29497 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29498 if (!NILP (mouse_face
))
29499 overlay
= overlay_vec
[i
];
29502 /* If we're highlighting the same overlay as before, there's
29503 no need to do that again. */
29504 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29505 goto check_help_echo
;
29506 hlinfo
->mouse_face_overlay
= overlay
;
29508 /* Clear the display of the old active region, if any. */
29509 if (clear_mouse_face (hlinfo
))
29510 cursor
= No_Cursor
;
29512 /* If no overlay applies, get a text property. */
29513 if (NILP (overlay
))
29514 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29516 /* Next, compute the bounds of the mouse highlighting and
29518 if (!NILP (mouse_face
) && STRINGP (object
))
29520 /* The mouse-highlighting comes from a display string
29521 with a mouse-face. */
29525 s
= Fprevious_single_property_change
29526 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29527 e
= Fnext_single_property_change
29528 (position
, Qmouse_face
, object
, Qnil
);
29530 s
= make_number (0);
29532 e
= make_number (SCHARS (object
));
29533 mouse_face_from_string_pos (w
, hlinfo
, object
,
29534 XINT (s
), XINT (e
));
29535 hlinfo
->mouse_face_past_end
= false;
29536 hlinfo
->mouse_face_window
= window
;
29537 hlinfo
->mouse_face_face_id
29538 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29539 glyph
->face_id
, true);
29540 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29541 cursor
= No_Cursor
;
29545 /* The mouse-highlighting, if any, comes from an overlay
29546 or text property in the buffer. */
29547 Lisp_Object buffer
IF_LINT (= Qnil
);
29548 Lisp_Object disp_string
IF_LINT (= Qnil
);
29550 if (STRINGP (object
))
29552 /* If we are on a display string with no mouse-face,
29553 check if the text under it has one. */
29554 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29555 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29556 pos
= string_buffer_position (object
, start
);
29559 mouse_face
= get_char_property_and_overlay
29560 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29561 buffer
= w
->contents
;
29562 disp_string
= object
;
29568 disp_string
= Qnil
;
29571 if (!NILP (mouse_face
))
29573 Lisp_Object before
, after
;
29574 Lisp_Object before_string
, after_string
;
29575 /* To correctly find the limits of mouse highlight
29576 in a bidi-reordered buffer, we must not use the
29577 optimization of limiting the search in
29578 previous-single-property-change and
29579 next-single-property-change, because
29580 rows_from_pos_range needs the real start and end
29581 positions to DTRT in this case. That's because
29582 the first row visible in a window does not
29583 necessarily display the character whose position
29584 is the smallest. */
29586 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29587 ? Fmarker_position (w
->start
)
29590 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29591 ? make_number (BUF_Z (XBUFFER (buffer
))
29592 - w
->window_end_pos
)
29595 if (NILP (overlay
))
29597 /* Handle the text property case. */
29598 before
= Fprevious_single_property_change
29599 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29600 after
= Fnext_single_property_change
29601 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29602 before_string
= after_string
= Qnil
;
29606 /* Handle the overlay case. */
29607 before
= Foverlay_start (overlay
);
29608 after
= Foverlay_end (overlay
);
29609 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29610 after_string
= Foverlay_get (overlay
, Qafter_string
);
29612 if (!STRINGP (before_string
)) before_string
= Qnil
;
29613 if (!STRINGP (after_string
)) after_string
= Qnil
;
29616 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29619 : XFASTINT (before
),
29621 ? BUF_Z (XBUFFER (buffer
))
29622 : XFASTINT (after
),
29623 before_string
, after_string
,
29625 cursor
= No_Cursor
;
29632 /* Look for a `help-echo' property. */
29633 if (NILP (help_echo_string
)) {
29634 Lisp_Object help
, overlay
;
29636 /* Check overlays first. */
29637 help
= overlay
= Qnil
;
29638 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29640 overlay
= overlay_vec
[i
];
29641 help
= Foverlay_get (overlay
, Qhelp_echo
);
29646 help_echo_string
= help
;
29647 help_echo_window
= window
;
29648 help_echo_object
= overlay
;
29649 help_echo_pos
= pos
;
29653 Lisp_Object obj
= glyph
->object
;
29654 ptrdiff_t charpos
= glyph
->charpos
;
29656 /* Try text properties. */
29659 && charpos
< SCHARS (obj
))
29661 help
= Fget_text_property (make_number (charpos
),
29665 /* If the string itself doesn't specify a help-echo,
29666 see if the buffer text ``under'' it does. */
29667 struct glyph_row
*r
29668 = MATRIX_ROW (w
->current_matrix
, vpos
);
29669 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29670 ptrdiff_t p
= string_buffer_position (obj
, start
);
29673 help
= Fget_char_property (make_number (p
),
29674 Qhelp_echo
, w
->contents
);
29683 else if (BUFFERP (obj
)
29686 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29691 help_echo_string
= help
;
29692 help_echo_window
= window
;
29693 help_echo_object
= obj
;
29694 help_echo_pos
= charpos
;
29699 #ifdef HAVE_WINDOW_SYSTEM
29700 /* Look for a `pointer' property. */
29701 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29703 /* Check overlays first. */
29704 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29705 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29707 if (NILP (pointer
))
29709 Lisp_Object obj
= glyph
->object
;
29710 ptrdiff_t charpos
= glyph
->charpos
;
29712 /* Try text properties. */
29715 && charpos
< SCHARS (obj
))
29717 pointer
= Fget_text_property (make_number (charpos
),
29719 if (NILP (pointer
))
29721 /* If the string itself doesn't specify a pointer,
29722 see if the buffer text ``under'' it does. */
29723 struct glyph_row
*r
29724 = MATRIX_ROW (w
->current_matrix
, vpos
);
29725 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29726 ptrdiff_t p
= string_buffer_position (obj
, start
);
29728 pointer
= Fget_char_property (make_number (p
),
29729 Qpointer
, w
->contents
);
29732 else if (BUFFERP (obj
)
29735 pointer
= Fget_text_property (make_number (charpos
),
29739 #endif /* HAVE_WINDOW_SYSTEM */
29743 current_buffer
= obuf
;
29749 #ifdef HAVE_WINDOW_SYSTEM
29750 if (FRAME_WINDOW_P (f
))
29751 define_frame_cursor1 (f
, cursor
, pointer
);
29753 /* This is here to prevent a compiler error, about "label at end of
29754 compound statement". */
29761 Clear any mouse-face on window W. This function is part of the
29762 redisplay interface, and is called from try_window_id and similar
29763 functions to ensure the mouse-highlight is off. */
29766 x_clear_window_mouse_face (struct window
*w
)
29768 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29769 Lisp_Object window
;
29772 XSETWINDOW (window
, w
);
29773 if (EQ (window
, hlinfo
->mouse_face_window
))
29774 clear_mouse_face (hlinfo
);
29780 Just discard the mouse face information for frame F, if any.
29781 This is used when the size of F is changed. */
29784 cancel_mouse_face (struct frame
*f
)
29786 Lisp_Object window
;
29787 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29789 window
= hlinfo
->mouse_face_window
;
29790 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29791 reset_mouse_highlight (hlinfo
);
29796 /***********************************************************************
29798 ***********************************************************************/
29800 #ifdef HAVE_WINDOW_SYSTEM
29802 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29803 which intersects rectangle R. R is in window-relative coordinates. */
29806 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29807 enum glyph_row_area area
)
29809 struct glyph
*first
= row
->glyphs
[area
];
29810 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29811 struct glyph
*last
;
29812 int first_x
, start_x
, x
;
29814 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29815 /* If row extends face to end of line write the whole line. */
29816 draw_glyphs (w
, 0, row
, area
,
29817 0, row
->used
[area
],
29818 DRAW_NORMAL_TEXT
, 0);
29821 /* Set START_X to the window-relative start position for drawing glyphs of
29822 AREA. The first glyph of the text area can be partially visible.
29823 The first glyphs of other areas cannot. */
29824 start_x
= window_box_left_offset (w
, area
);
29826 if (area
== TEXT_AREA
)
29829 /* Find the first glyph that must be redrawn. */
29831 && x
+ first
->pixel_width
< r
->x
)
29833 x
+= first
->pixel_width
;
29837 /* Find the last one. */
29841 && x
< r
->x
+ r
->width
)
29843 x
+= last
->pixel_width
;
29849 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29850 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29851 DRAW_NORMAL_TEXT
, 0);
29856 /* Redraw the parts of the glyph row ROW on window W intersecting
29857 rectangle R. R is in window-relative coordinates. Value is
29858 true if mouse-face was overwritten. */
29861 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29863 eassert (row
->enabled_p
);
29865 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29866 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29867 0, row
->used
[TEXT_AREA
],
29868 DRAW_NORMAL_TEXT
, 0);
29871 if (row
->used
[LEFT_MARGIN_AREA
])
29872 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29873 if (row
->used
[TEXT_AREA
])
29874 expose_area (w
, row
, r
, TEXT_AREA
);
29875 if (row
->used
[RIGHT_MARGIN_AREA
])
29876 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29877 draw_row_fringe_bitmaps (w
, row
);
29880 return row
->mouse_face_p
;
29884 /* Redraw those parts of glyphs rows during expose event handling that
29885 overlap other rows. Redrawing of an exposed line writes over parts
29886 of lines overlapping that exposed line; this function fixes that.
29888 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29889 row in W's current matrix that is exposed and overlaps other rows.
29890 LAST_OVERLAPPING_ROW is the last such row. */
29893 expose_overlaps (struct window
*w
,
29894 struct glyph_row
*first_overlapping_row
,
29895 struct glyph_row
*last_overlapping_row
,
29898 struct glyph_row
*row
;
29900 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29901 if (row
->overlapping_p
)
29903 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29906 if (row
->used
[LEFT_MARGIN_AREA
])
29907 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29909 if (row
->used
[TEXT_AREA
])
29910 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29912 if (row
->used
[RIGHT_MARGIN_AREA
])
29913 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29919 /* Return true if W's cursor intersects rectangle R. */
29922 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29924 XRectangle cr
, result
;
29925 struct glyph
*cursor_glyph
;
29926 struct glyph_row
*row
;
29928 if (w
->phys_cursor
.vpos
>= 0
29929 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29930 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29932 && row
->cursor_in_fringe_p
)
29934 /* Cursor is in the fringe. */
29935 cr
.x
= window_box_right_offset (w
,
29936 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29937 ? RIGHT_MARGIN_AREA
29940 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29941 cr
.height
= row
->height
;
29942 return x_intersect_rectangles (&cr
, r
, &result
);
29945 cursor_glyph
= get_phys_cursor_glyph (w
);
29948 /* r is relative to W's box, but w->phys_cursor.x is relative
29949 to left edge of W's TEXT area. Adjust it. */
29950 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29951 cr
.y
= w
->phys_cursor
.y
;
29952 cr
.width
= cursor_glyph
->pixel_width
;
29953 cr
.height
= w
->phys_cursor_height
;
29954 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29955 I assume the effect is the same -- and this is portable. */
29956 return x_intersect_rectangles (&cr
, r
, &result
);
29958 /* If we don't understand the format, pretend we're not in the hot-spot. */
29964 Draw a vertical window border to the right of window W if W doesn't
29965 have vertical scroll bars. */
29968 x_draw_vertical_border (struct window
*w
)
29970 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29972 /* We could do better, if we knew what type of scroll-bar the adjacent
29973 windows (on either side) have... But we don't :-(
29974 However, I think this works ok. ++KFS 2003-04-25 */
29976 /* Redraw borders between horizontally adjacent windows. Don't
29977 do it for frames with vertical scroll bars because either the
29978 right scroll bar of a window, or the left scroll bar of its
29979 neighbor will suffice as a border. */
29980 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29983 /* Note: It is necessary to redraw both the left and the right
29984 borders, for when only this single window W is being
29986 if (!WINDOW_RIGHTMOST_P (w
)
29987 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29989 int x0
, x1
, y0
, y1
;
29991 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29994 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29997 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30000 if (!WINDOW_LEFTMOST_P (w
)
30001 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30003 int x0
, x1
, y0
, y1
;
30005 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30008 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30011 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30016 /* Draw window dividers for window W. */
30019 x_draw_right_divider (struct window
*w
)
30021 struct frame
*f
= WINDOW_XFRAME (w
);
30023 if (w
->mini
|| w
->pseudo_window_p
)
30025 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30027 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30028 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30029 int y0
= WINDOW_TOP_EDGE_Y (w
);
30030 /* The bottom divider prevails. */
30031 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30033 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30038 x_draw_bottom_divider (struct window
*w
)
30040 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30042 if (w
->mini
|| w
->pseudo_window_p
)
30044 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30046 int x0
= WINDOW_LEFT_EDGE_X (w
);
30047 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30048 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30049 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30051 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30055 /* Redraw the part of window W intersection rectangle FR. Pixel
30056 coordinates in FR are frame-relative. Call this function with
30057 input blocked. Value is true if the exposure overwrites
30061 expose_window (struct window
*w
, XRectangle
*fr
)
30063 struct frame
*f
= XFRAME (w
->frame
);
30065 bool mouse_face_overwritten_p
= false;
30067 /* If window is not yet fully initialized, do nothing. This can
30068 happen when toolkit scroll bars are used and a window is split.
30069 Reconfiguring the scroll bar will generate an expose for a newly
30071 if (w
->current_matrix
== NULL
)
30074 /* When we're currently updating the window, display and current
30075 matrix usually don't agree. Arrange for a thorough display
30077 if (w
->must_be_updated_p
)
30079 SET_FRAME_GARBAGED (f
);
30083 /* Frame-relative pixel rectangle of W. */
30084 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30085 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30086 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30087 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30089 if (x_intersect_rectangles (fr
, &wr
, &r
))
30091 int yb
= window_text_bottom_y (w
);
30092 struct glyph_row
*row
;
30093 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30095 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30096 r
.x
, r
.y
, r
.width
, r
.height
));
30098 /* Convert to window coordinates. */
30099 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30100 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30102 /* Turn off the cursor. */
30103 bool cursor_cleared_p
= (!w
->pseudo_window_p
30104 && phys_cursor_in_rect_p (w
, &r
));
30105 if (cursor_cleared_p
)
30106 x_clear_cursor (w
);
30108 /* If the row containing the cursor extends face to end of line,
30109 then expose_area might overwrite the cursor outside the
30110 rectangle and thus notice_overwritten_cursor might clear
30111 w->phys_cursor_on_p. We remember the original value and
30112 check later if it is changed. */
30113 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30115 /* Update lines intersecting rectangle R. */
30116 first_overlapping_row
= last_overlapping_row
= NULL
;
30117 for (row
= w
->current_matrix
->rows
;
30122 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30124 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30125 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30126 || (r
.y
>= y0
&& r
.y
< y1
)
30127 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30129 /* A header line may be overlapping, but there is no need
30130 to fix overlapping areas for them. KFS 2005-02-12 */
30131 if (row
->overlapping_p
&& !row
->mode_line_p
)
30133 if (first_overlapping_row
== NULL
)
30134 first_overlapping_row
= row
;
30135 last_overlapping_row
= row
;
30139 if (expose_line (w
, row
, &r
))
30140 mouse_face_overwritten_p
= true;
30143 else if (row
->overlapping_p
)
30145 /* We must redraw a row overlapping the exposed area. */
30147 ? y0
+ row
->phys_height
> r
.y
30148 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30150 if (first_overlapping_row
== NULL
)
30151 first_overlapping_row
= row
;
30152 last_overlapping_row
= row
;
30160 /* Display the mode line if there is one. */
30161 if (WINDOW_WANTS_MODELINE_P (w
)
30162 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30164 && row
->y
< r
.y
+ r
.height
)
30166 if (expose_line (w
, row
, &r
))
30167 mouse_face_overwritten_p
= true;
30170 if (!w
->pseudo_window_p
)
30172 /* Fix the display of overlapping rows. */
30173 if (first_overlapping_row
)
30174 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30177 /* Draw border between windows. */
30178 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30179 x_draw_right_divider (w
);
30181 x_draw_vertical_border (w
);
30183 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30184 x_draw_bottom_divider (w
);
30186 /* Turn the cursor on again. */
30187 if (cursor_cleared_p
30188 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30189 update_window_cursor (w
, true);
30193 return mouse_face_overwritten_p
;
30198 /* Redraw (parts) of all windows in the window tree rooted at W that
30199 intersect R. R contains frame pixel coordinates. Value is
30200 true if the exposure overwrites mouse-face. */
30203 expose_window_tree (struct window
*w
, XRectangle
*r
)
30205 struct frame
*f
= XFRAME (w
->frame
);
30206 bool mouse_face_overwritten_p
= false;
30208 while (w
&& !FRAME_GARBAGED_P (f
))
30210 mouse_face_overwritten_p
30211 |= (WINDOWP (w
->contents
)
30212 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30213 : expose_window (w
, r
));
30215 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30218 return mouse_face_overwritten_p
;
30223 Redisplay an exposed area of frame F. X and Y are the upper-left
30224 corner of the exposed rectangle. W and H are width and height of
30225 the exposed area. All are pixel values. W or H zero means redraw
30226 the entire frame. */
30229 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30232 bool mouse_face_overwritten_p
= false;
30234 TRACE ((stderr
, "expose_frame "));
30236 /* No need to redraw if frame will be redrawn soon. */
30237 if (FRAME_GARBAGED_P (f
))
30239 TRACE ((stderr
, " garbaged\n"));
30243 /* If basic faces haven't been realized yet, there is no point in
30244 trying to redraw anything. This can happen when we get an expose
30245 event while Emacs is starting, e.g. by moving another window. */
30246 if (FRAME_FACE_CACHE (f
) == NULL
30247 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30249 TRACE ((stderr
, " no faces\n"));
30253 if (w
== 0 || h
== 0)
30256 r
.width
= FRAME_TEXT_WIDTH (f
);
30257 r
.height
= FRAME_TEXT_HEIGHT (f
);
30267 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30268 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30270 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30271 if (WINDOWP (f
->tool_bar_window
))
30272 mouse_face_overwritten_p
30273 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30276 #ifdef HAVE_X_WINDOWS
30278 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30279 if (WINDOWP (f
->menu_bar_window
))
30280 mouse_face_overwritten_p
30281 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30282 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30286 /* Some window managers support a focus-follows-mouse style with
30287 delayed raising of frames. Imagine a partially obscured frame,
30288 and moving the mouse into partially obscured mouse-face on that
30289 frame. The visible part of the mouse-face will be highlighted,
30290 then the WM raises the obscured frame. With at least one WM, KDE
30291 2.1, Emacs is not getting any event for the raising of the frame
30292 (even tried with SubstructureRedirectMask), only Expose events.
30293 These expose events will draw text normally, i.e. not
30294 highlighted. Which means we must redo the highlight here.
30295 Subsume it under ``we love X''. --gerd 2001-08-15 */
30296 /* Included in Windows version because Windows most likely does not
30297 do the right thing if any third party tool offers
30298 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30299 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30301 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30302 if (f
== hlinfo
->mouse_face_mouse_frame
)
30304 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30305 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30306 clear_mouse_face (hlinfo
);
30307 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30314 Determine the intersection of two rectangles R1 and R2. Return
30315 the intersection in *RESULT. Value is true if RESULT is not
30319 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30321 XRectangle
*left
, *right
;
30322 XRectangle
*upper
, *lower
;
30323 bool intersection_p
= false;
30325 /* Rearrange so that R1 is the left-most rectangle. */
30327 left
= r1
, right
= r2
;
30329 left
= r2
, right
= r1
;
30331 /* X0 of the intersection is right.x0, if this is inside R1,
30332 otherwise there is no intersection. */
30333 if (right
->x
<= left
->x
+ left
->width
)
30335 result
->x
= right
->x
;
30337 /* The right end of the intersection is the minimum of
30338 the right ends of left and right. */
30339 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30342 /* Same game for Y. */
30344 upper
= r1
, lower
= r2
;
30346 upper
= r2
, lower
= r1
;
30348 /* The upper end of the intersection is lower.y0, if this is inside
30349 of upper. Otherwise, there is no intersection. */
30350 if (lower
->y
<= upper
->y
+ upper
->height
)
30352 result
->y
= lower
->y
;
30354 /* The lower end of the intersection is the minimum of the lower
30355 ends of upper and lower. */
30356 result
->height
= (min (lower
->y
+ lower
->height
,
30357 upper
->y
+ upper
->height
)
30359 intersection_p
= true;
30363 return intersection_p
;
30366 #endif /* HAVE_WINDOW_SYSTEM */
30369 /***********************************************************************
30371 ***********************************************************************/
30374 syms_of_xdisp (void)
30376 Vwith_echo_area_save_vector
= Qnil
;
30377 staticpro (&Vwith_echo_area_save_vector
);
30379 Vmessage_stack
= Qnil
;
30380 staticpro (&Vmessage_stack
);
30382 /* Non-nil means don't actually do any redisplay. */
30383 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30385 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30387 message_dolog_marker1
= Fmake_marker ();
30388 staticpro (&message_dolog_marker1
);
30389 message_dolog_marker2
= Fmake_marker ();
30390 staticpro (&message_dolog_marker2
);
30391 message_dolog_marker3
= Fmake_marker ();
30392 staticpro (&message_dolog_marker3
);
30395 defsubr (&Sdump_frame_glyph_matrix
);
30396 defsubr (&Sdump_glyph_matrix
);
30397 defsubr (&Sdump_glyph_row
);
30398 defsubr (&Sdump_tool_bar_row
);
30399 defsubr (&Strace_redisplay
);
30400 defsubr (&Strace_to_stderr
);
30402 #ifdef HAVE_WINDOW_SYSTEM
30403 defsubr (&Stool_bar_height
);
30404 defsubr (&Slookup_image_map
);
30406 defsubr (&Sline_pixel_height
);
30407 defsubr (&Sformat_mode_line
);
30408 defsubr (&Sinvisible_p
);
30409 defsubr (&Scurrent_bidi_paragraph_direction
);
30410 defsubr (&Swindow_text_pixel_size
);
30411 defsubr (&Smove_point_visually
);
30412 defsubr (&Sbidi_find_overridden_directionality
);
30414 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30415 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30416 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30417 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30418 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30419 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30420 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30421 DEFSYM (Qeval
, "eval");
30422 DEFSYM (QCdata
, ":data");
30424 /* Names of text properties relevant for redisplay. */
30425 DEFSYM (Qdisplay
, "display");
30426 DEFSYM (Qspace_width
, "space-width");
30427 DEFSYM (Qraise
, "raise");
30428 DEFSYM (Qslice
, "slice");
30429 DEFSYM (Qspace
, "space");
30430 DEFSYM (Qmargin
, "margin");
30431 DEFSYM (Qpointer
, "pointer");
30432 DEFSYM (Qleft_margin
, "left-margin");
30433 DEFSYM (Qright_margin
, "right-margin");
30434 DEFSYM (Qcenter
, "center");
30435 DEFSYM (Qline_height
, "line-height");
30436 DEFSYM (QCalign_to
, ":align-to");
30437 DEFSYM (QCrelative_width
, ":relative-width");
30438 DEFSYM (QCrelative_height
, ":relative-height");
30439 DEFSYM (QCeval
, ":eval");
30440 DEFSYM (QCpropertize
, ":propertize");
30441 DEFSYM (QCfile
, ":file");
30442 DEFSYM (Qfontified
, "fontified");
30443 DEFSYM (Qfontification_functions
, "fontification-functions");
30445 /* Name of the face used to highlight trailing whitespace. */
30446 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30448 /* Name and number of the face used to highlight escape glyphs. */
30449 DEFSYM (Qescape_glyph
, "escape-glyph");
30451 /* Name and number of the face used to highlight non-breaking spaces. */
30452 DEFSYM (Qnobreak_space
, "nobreak-space");
30454 /* The symbol 'image' which is the car of the lists used to represent
30455 images in Lisp. Also a tool bar style. */
30456 DEFSYM (Qimage
, "image");
30458 /* Tool bar styles. */
30459 DEFSYM (Qtext
, "text");
30460 DEFSYM (Qboth
, "both");
30461 DEFSYM (Qboth_horiz
, "both-horiz");
30462 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30464 /* The image map types. */
30465 DEFSYM (QCmap
, ":map");
30466 DEFSYM (QCpointer
, ":pointer");
30467 DEFSYM (Qrect
, "rect");
30468 DEFSYM (Qcircle
, "circle");
30469 DEFSYM (Qpoly
, "poly");
30471 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
30472 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30473 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30475 DEFSYM (Qgrow_only
, "grow-only");
30476 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30477 DEFSYM (Qposition
, "position");
30478 DEFSYM (Qbuffer_position
, "buffer-position");
30479 DEFSYM (Qobject
, "object");
30481 /* Cursor shapes. */
30482 DEFSYM (Qbar
, "bar");
30483 DEFSYM (Qhbar
, "hbar");
30484 DEFSYM (Qbox
, "box");
30485 DEFSYM (Qhollow
, "hollow");
30487 /* Pointer shapes. */
30488 DEFSYM (Qhand
, "hand");
30489 DEFSYM (Qarrow
, "arrow");
30492 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30494 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30495 staticpro (&list_of_error
);
30497 /* Values of those variables at last redisplay are stored as
30498 properties on 'overlay-arrow-position' symbol. However, if
30499 Voverlay_arrow_position is a marker, last-arrow-position is its
30500 numerical position. */
30501 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30502 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30504 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30505 properties on a symbol in overlay-arrow-variable-list. */
30506 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30507 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30509 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30510 staticpro (&echo_buffer
[0]);
30511 staticpro (&echo_buffer
[1]);
30513 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30514 staticpro (&echo_area_buffer
[0]);
30515 staticpro (&echo_area_buffer
[1]);
30517 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30518 staticpro (&Vmessages_buffer_name
);
30520 mode_line_proptrans_alist
= Qnil
;
30521 staticpro (&mode_line_proptrans_alist
);
30522 mode_line_string_list
= Qnil
;
30523 staticpro (&mode_line_string_list
);
30524 mode_line_string_face
= Qnil
;
30525 staticpro (&mode_line_string_face
);
30526 mode_line_string_face_prop
= Qnil
;
30527 staticpro (&mode_line_string_face_prop
);
30528 Vmode_line_unwind_vector
= Qnil
;
30529 staticpro (&Vmode_line_unwind_vector
);
30531 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30533 help_echo_string
= Qnil
;
30534 staticpro (&help_echo_string
);
30535 help_echo_object
= Qnil
;
30536 staticpro (&help_echo_object
);
30537 help_echo_window
= Qnil
;
30538 staticpro (&help_echo_window
);
30539 previous_help_echo_string
= Qnil
;
30540 staticpro (&previous_help_echo_string
);
30541 help_echo_pos
= -1;
30543 DEFSYM (Qright_to_left
, "right-to-left");
30544 DEFSYM (Qleft_to_right
, "left-to-right");
30545 defsubr (&Sbidi_resolved_levels
);
30547 #ifdef HAVE_WINDOW_SYSTEM
30548 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30549 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30550 For example, if a block cursor is over a tab, it will be drawn as
30551 wide as that tab on the display. */);
30552 x_stretch_cursor_p
= 0;
30555 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30556 doc
: /* Non-nil means highlight trailing whitespace.
30557 The face used for trailing whitespace is `trailing-whitespace'. */);
30558 Vshow_trailing_whitespace
= Qnil
;
30560 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30561 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30562 If the value is t, Emacs highlights non-ASCII chars which have the
30563 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30564 or `escape-glyph' face respectively.
30566 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30567 U+2011 (non-breaking hyphen) are affected.
30569 Any other non-nil value means to display these characters as a escape
30570 glyph followed by an ordinary space or hyphen.
30572 A value of nil means no special handling of these characters. */);
30573 Vnobreak_char_display
= Qt
;
30575 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30576 doc
: /* The pointer shape to show in void text areas.
30577 A value of nil means to show the text pointer. Other options are
30578 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30580 Vvoid_text_area_pointer
= Qarrow
;
30582 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30583 doc
: /* Non-nil means don't actually do any redisplay.
30584 This is used for internal purposes. */);
30585 Vinhibit_redisplay
= Qnil
;
30587 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30588 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30589 Vglobal_mode_string
= Qnil
;
30591 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30592 doc
: /* Marker for where to display an arrow on top of the buffer text.
30593 This must be the beginning of a line in order to work.
30594 See also `overlay-arrow-string'. */);
30595 Voverlay_arrow_position
= Qnil
;
30597 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30598 doc
: /* String to display as an arrow in non-window frames.
30599 See also `overlay-arrow-position'. */);
30600 Voverlay_arrow_string
= build_pure_c_string ("=>");
30602 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30603 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30604 The symbols on this list are examined during redisplay to determine
30605 where to display overlay arrows. */);
30606 Voverlay_arrow_variable_list
30607 = list1 (intern_c_string ("overlay-arrow-position"));
30609 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30610 doc
: /* The number of lines to try scrolling a window by when point moves out.
30611 If that fails to bring point back on frame, point is centered instead.
30612 If this is zero, point is always centered after it moves off frame.
30613 If you want scrolling to always be a line at a time, you should set
30614 `scroll-conservatively' to a large value rather than set this to 1. */);
30616 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30617 doc
: /* Scroll up to this many lines, to bring point back on screen.
30618 If point moves off-screen, redisplay will scroll by up to
30619 `scroll-conservatively' lines in order to bring point just barely
30620 onto the screen again. If that cannot be done, then redisplay
30621 recenters point as usual.
30623 If the value is greater than 100, redisplay will never recenter point,
30624 but will always scroll just enough text to bring point into view, even
30625 if you move far away.
30627 A value of zero means always recenter point if it moves off screen. */);
30628 scroll_conservatively
= 0;
30630 DEFVAR_INT ("scroll-margin", scroll_margin
,
30631 doc
: /* Number of lines of margin at the top and bottom of a window.
30632 Recenter the window whenever point gets within this many lines
30633 of the top or bottom of the window. */);
30636 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30637 doc
: /* Pixels per inch value for non-window system displays.
30638 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30639 Vdisplay_pixels_per_inch
= make_float (72.0);
30642 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30645 DEFVAR_LISP ("truncate-partial-width-windows",
30646 Vtruncate_partial_width_windows
,
30647 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30648 For an integer value, truncate lines in each window narrower than the
30649 full frame width, provided the window width is less than that integer;
30650 otherwise, respect the value of `truncate-lines'.
30652 For any other non-nil value, truncate lines in all windows that do
30653 not span the full frame width.
30655 A value of nil means to respect the value of `truncate-lines'.
30657 If `word-wrap' is enabled, you might want to reduce this. */);
30658 Vtruncate_partial_width_windows
= make_number (50);
30660 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30661 doc
: /* Maximum buffer size for which line number should be displayed.
30662 If the buffer is bigger than this, the line number does not appear
30663 in the mode line. A value of nil means no limit. */);
30664 Vline_number_display_limit
= Qnil
;
30666 DEFVAR_INT ("line-number-display-limit-width",
30667 line_number_display_limit_width
,
30668 doc
: /* Maximum line width (in characters) for line number display.
30669 If the average length of the lines near point is bigger than this, then the
30670 line number may be omitted from the mode line. */);
30671 line_number_display_limit_width
= 200;
30673 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30674 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30675 highlight_nonselected_windows
= false;
30677 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30678 doc
: /* Non-nil if more than one frame is visible on this display.
30679 Minibuffer-only frames don't count, but iconified frames do.
30680 This variable is not guaranteed to be accurate except while processing
30681 `frame-title-format' and `icon-title-format'. */);
30683 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30684 doc
: /* Template for displaying the title bar of visible frames.
30685 \(Assuming the window manager supports this feature.)
30687 This variable has the same structure as `mode-line-format', except that
30688 the %c and %l constructs are ignored. It is used only on frames for
30689 which no explicit name has been set \(see `modify-frame-parameters'). */);
30691 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30692 doc
: /* Template for displaying the title bar of an iconified frame.
30693 \(Assuming the window manager supports this feature.)
30694 This variable has the same structure as `mode-line-format' (which see),
30695 and is used only on frames for which no explicit name has been set
30696 \(see `modify-frame-parameters'). */);
30698 = Vframe_title_format
30699 = listn (CONSTYPE_PURE
, 3,
30700 intern_c_string ("multiple-frames"),
30701 build_pure_c_string ("%b"),
30702 listn (CONSTYPE_PURE
, 4,
30703 empty_unibyte_string
,
30704 intern_c_string ("invocation-name"),
30705 build_pure_c_string ("@"),
30706 intern_c_string ("system-name")));
30708 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30709 doc
: /* Maximum number of lines to keep in the message log buffer.
30710 If nil, disable message logging. If t, log messages but don't truncate
30711 the buffer when it becomes large. */);
30712 Vmessage_log_max
= make_number (1000);
30714 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30715 doc
: /* Functions called before redisplay, if window sizes have changed.
30716 The value should be a list of functions that take one argument.
30717 Just before redisplay, for each frame, if any of its windows have changed
30718 size since the last redisplay, or have been split or deleted,
30719 all the functions in the list are called, with the frame as argument. */);
30720 Vwindow_size_change_functions
= Qnil
;
30722 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30723 doc
: /* List of functions to call before redisplaying a window with scrolling.
30724 Each function is called with two arguments, the window and its new
30725 display-start position.
30726 These functions are called whenever the `window-start' marker is modified,
30727 either to point into another buffer (e.g. via `set-window-buffer') or another
30728 place in the same buffer.
30729 Note that the value of `window-end' is not valid when these functions are
30732 Warning: Do not use this feature to alter the way the window
30733 is scrolled. It is not designed for that, and such use probably won't
30735 Vwindow_scroll_functions
= Qnil
;
30737 DEFVAR_LISP ("window-text-change-functions",
30738 Vwindow_text_change_functions
,
30739 doc
: /* Functions to call in redisplay when text in the window might change. */);
30740 Vwindow_text_change_functions
= Qnil
;
30742 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30743 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30744 Each function is called with two arguments, the window and the end trigger value.
30745 See `set-window-redisplay-end-trigger'. */);
30746 Vredisplay_end_trigger_functions
= Qnil
;
30748 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30749 doc
: /* Non-nil means autoselect window with mouse pointer.
30750 If nil, do not autoselect windows.
30751 A positive number means delay autoselection by that many seconds: a
30752 window is autoselected only after the mouse has remained in that
30753 window for the duration of the delay.
30754 A negative number has a similar effect, but causes windows to be
30755 autoselected only after the mouse has stopped moving. \(Because of
30756 the way Emacs compares mouse events, you will occasionally wait twice
30757 that time before the window gets selected.\)
30758 Any other value means to autoselect window instantaneously when the
30759 mouse pointer enters it.
30761 Autoselection selects the minibuffer only if it is active, and never
30762 unselects the minibuffer if it is active.
30764 When customizing this variable make sure that the actual value of
30765 `focus-follows-mouse' matches the behavior of your window manager. */);
30766 Vmouse_autoselect_window
= Qnil
;
30768 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30769 doc
: /* Non-nil means automatically resize tool-bars.
30770 This dynamically changes the tool-bar's height to the minimum height
30771 that is needed to make all tool-bar items visible.
30772 If value is `grow-only', the tool-bar's height is only increased
30773 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30774 Vauto_resize_tool_bars
= Qt
;
30776 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30777 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30778 auto_raise_tool_bar_buttons_p
= true;
30780 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30781 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30782 make_cursor_line_fully_visible_p
= true;
30784 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30785 doc
: /* Border below tool-bar in pixels.
30786 If an integer, use it as the height of the border.
30787 If it is one of `internal-border-width' or `border-width', use the
30788 value of the corresponding frame parameter.
30789 Otherwise, no border is added below the tool-bar. */);
30790 Vtool_bar_border
= Qinternal_border_width
;
30792 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30793 doc
: /* Margin around tool-bar buttons in pixels.
30794 If an integer, use that for both horizontal and vertical margins.
30795 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30796 HORZ specifying the horizontal margin, and VERT specifying the
30797 vertical margin. */);
30798 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30800 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30801 doc
: /* Relief thickness of tool-bar buttons. */);
30802 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30804 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30805 doc
: /* Tool bar style to use.
30807 image - show images only
30808 text - show text only
30809 both - show both, text below image
30810 both-horiz - show text to the right of the image
30811 text-image-horiz - show text to the left of the image
30812 any other - use system default or image if no system default.
30814 This variable only affects the GTK+ toolkit version of Emacs. */);
30815 Vtool_bar_style
= Qnil
;
30817 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30818 doc
: /* Maximum number of characters a label can have to be shown.
30819 The tool bar style must also show labels for this to have any effect, see
30820 `tool-bar-style'. */);
30821 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30823 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30824 doc
: /* List of functions to call to fontify regions of text.
30825 Each function is called with one argument POS. Functions must
30826 fontify a region starting at POS in the current buffer, and give
30827 fontified regions the property `fontified'. */);
30828 Vfontification_functions
= Qnil
;
30829 Fmake_variable_buffer_local (Qfontification_functions
);
30831 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30832 unibyte_display_via_language_environment
,
30833 doc
: /* Non-nil means display unibyte text according to language environment.
30834 Specifically, this means that raw bytes in the range 160-255 decimal
30835 are displayed by converting them to the equivalent multibyte characters
30836 according to the current language environment. As a result, they are
30837 displayed according to the current fontset.
30839 Note that this variable affects only how these bytes are displayed,
30840 but does not change the fact they are interpreted as raw bytes. */);
30841 unibyte_display_via_language_environment
= false;
30843 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30844 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30845 If a float, it specifies a fraction of the mini-window frame's height.
30846 If an integer, it specifies a number of lines. */);
30847 Vmax_mini_window_height
= make_float (0.25);
30849 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30850 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30851 A value of nil means don't automatically resize mini-windows.
30852 A value of t means resize them to fit the text displayed in them.
30853 A value of `grow-only', the default, means let mini-windows grow only;
30854 they return to their normal size when the minibuffer is closed, or the
30855 echo area becomes empty. */);
30856 Vresize_mini_windows
= Qgrow_only
;
30858 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30859 doc
: /* Alist specifying how to blink the cursor off.
30860 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30861 `cursor-type' frame-parameter or variable equals ON-STATE,
30862 comparing using `equal', Emacs uses OFF-STATE to specify
30863 how to blink it off. ON-STATE and OFF-STATE are values for
30864 the `cursor-type' frame parameter.
30866 If a frame's ON-STATE has no entry in this list,
30867 the frame's other specifications determine how to blink the cursor off. */);
30868 Vblink_cursor_alist
= Qnil
;
30870 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30871 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30872 If non-nil, windows are automatically scrolled horizontally to make
30873 point visible. */);
30874 automatic_hscrolling_p
= true;
30875 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30877 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30878 doc
: /* How many columns away from the window edge point is allowed to get
30879 before automatic hscrolling will horizontally scroll the window. */);
30880 hscroll_margin
= 5;
30882 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30883 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30884 When point is less than `hscroll-margin' columns from the window
30885 edge, automatic hscrolling will scroll the window by the amount of columns
30886 determined by this variable. If its value is a positive integer, scroll that
30887 many columns. If it's a positive floating-point number, it specifies the
30888 fraction of the window's width to scroll. If it's nil or zero, point will be
30889 centered horizontally after the scroll. Any other value, including negative
30890 numbers, are treated as if the value were zero.
30892 Automatic hscrolling always moves point outside the scroll margin, so if
30893 point was more than scroll step columns inside the margin, the window will
30894 scroll more than the value given by the scroll step.
30896 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30897 and `scroll-right' overrides this variable's effect. */);
30898 Vhscroll_step
= make_number (0);
30900 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30901 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30902 Bind this around calls to `message' to let it take effect. */);
30903 message_truncate_lines
= false;
30905 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30906 doc
: /* Normal hook run to update the menu bar definitions.
30907 Redisplay runs this hook before it redisplays the menu bar.
30908 This is used to update menus such as Buffers, whose contents depend on
30910 Vmenu_bar_update_hook
= Qnil
;
30912 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30913 doc
: /* Frame for which we are updating a menu.
30914 The enable predicate for a menu binding should check this variable. */);
30915 Vmenu_updating_frame
= Qnil
;
30917 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30918 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30919 inhibit_menubar_update
= false;
30921 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30922 doc
: /* Prefix prepended to all continuation lines at display time.
30923 The value may be a string, an image, or a stretch-glyph; it is
30924 interpreted in the same way as the value of a `display' text property.
30926 This variable is overridden by any `wrap-prefix' text or overlay
30929 To add a prefix to non-continuation lines, use `line-prefix'. */);
30930 Vwrap_prefix
= Qnil
;
30931 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30932 Fmake_variable_buffer_local (Qwrap_prefix
);
30934 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30935 doc
: /* Prefix prepended to all non-continuation lines at display time.
30936 The value may be a string, an image, or a stretch-glyph; it is
30937 interpreted in the same way as the value of a `display' text property.
30939 This variable is overridden by any `line-prefix' text or overlay
30942 To add a prefix to continuation lines, use `wrap-prefix'. */);
30943 Vline_prefix
= Qnil
;
30944 DEFSYM (Qline_prefix
, "line-prefix");
30945 Fmake_variable_buffer_local (Qline_prefix
);
30947 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30948 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30949 inhibit_eval_during_redisplay
= false;
30951 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30952 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30953 inhibit_free_realized_faces
= false;
30955 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
30956 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
30957 Intended for use during debugging and for testing bidi display;
30958 see biditest.el in the test suite. */);
30959 inhibit_bidi_mirroring
= false;
30962 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30963 doc
: /* Inhibit try_window_id display optimization. */);
30964 inhibit_try_window_id
= false;
30966 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30967 doc
: /* Inhibit try_window_reusing display optimization. */);
30968 inhibit_try_window_reusing
= false;
30970 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30971 doc
: /* Inhibit try_cursor_movement display optimization. */);
30972 inhibit_try_cursor_movement
= false;
30973 #endif /* GLYPH_DEBUG */
30975 DEFVAR_INT ("overline-margin", overline_margin
,
30976 doc
: /* Space between overline and text, in pixels.
30977 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30978 margin to the character height. */);
30979 overline_margin
= 2;
30981 DEFVAR_INT ("underline-minimum-offset",
30982 underline_minimum_offset
,
30983 doc
: /* Minimum distance between baseline and underline.
30984 This can improve legibility of underlined text at small font sizes,
30985 particularly when using variable `x-use-underline-position-properties'
30986 with fonts that specify an UNDERLINE_POSITION relatively close to the
30987 baseline. The default value is 1. */);
30988 underline_minimum_offset
= 1;
30990 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30991 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30992 This feature only works when on a window system that can change
30993 cursor shapes. */);
30994 display_hourglass_p
= true;
30996 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30997 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30998 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31000 #ifdef HAVE_WINDOW_SYSTEM
31001 hourglass_atimer
= NULL
;
31002 hourglass_shown_p
= false;
31003 #endif /* HAVE_WINDOW_SYSTEM */
31005 /* Name of the face used to display glyphless characters. */
31006 DEFSYM (Qglyphless_char
, "glyphless-char");
31008 /* Method symbols for Vglyphless_char_display. */
31009 DEFSYM (Qhex_code
, "hex-code");
31010 DEFSYM (Qempty_box
, "empty-box");
31011 DEFSYM (Qthin_space
, "thin-space");
31012 DEFSYM (Qzero_width
, "zero-width");
31014 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31015 doc
: /* Function run just before redisplay.
31016 It is called with one argument, which is the set of windows that are to
31017 be redisplayed. This set can be nil (meaning, only the selected window),
31018 or t (meaning all windows). */);
31019 Vpre_redisplay_function
= intern ("ignore");
31021 /* Symbol for the purpose of Vglyphless_char_display. */
31022 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31023 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31025 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31026 doc
: /* Char-table defining glyphless characters.
31027 Each element, if non-nil, should be one of the following:
31028 an ASCII acronym string: display this string in a box
31029 `hex-code': display the hexadecimal code of a character in a box
31030 `empty-box': display as an empty box
31031 `thin-space': display as 1-pixel width space
31032 `zero-width': don't display
31033 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31034 display method for graphical terminals and text terminals respectively.
31035 GRAPHICAL and TEXT should each have one of the values listed above.
31037 The char-table has one extra slot to control the display of a character for
31038 which no font is found. This slot only takes effect on graphical terminals.
31039 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31040 `thin-space'. The default is `empty-box'.
31042 If a character has a non-nil entry in an active display table, the
31043 display table takes effect; in this case, Emacs does not consult
31044 `glyphless-char-display' at all. */);
31045 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31046 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31049 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31050 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31051 Vdebug_on_message
= Qnil
;
31053 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31055 Vredisplay__all_windows_cause
31056 = Fmake_vector (make_number (100), make_number (0));
31058 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31060 Vredisplay__mode_lines_cause
31061 = Fmake_vector (make_number (100), make_number (0));
31065 /* Initialize this module when Emacs starts. */
31070 CHARPOS (this_line_start_pos
) = 0;
31072 if (!noninteractive
)
31074 struct window
*m
= XWINDOW (minibuf_window
);
31075 Lisp_Object frame
= m
->frame
;
31076 struct frame
*f
= XFRAME (frame
);
31077 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31078 struct window
*r
= XWINDOW (root
);
31081 echo_area_window
= minibuf_window
;
31083 r
->top_line
= FRAME_TOP_MARGIN (f
);
31084 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31085 r
->total_cols
= FRAME_COLS (f
);
31086 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31087 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31088 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31090 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31091 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31092 m
->total_cols
= FRAME_COLS (f
);
31093 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31094 m
->total_lines
= 1;
31095 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31097 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31098 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31099 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31101 /* The default ellipsis glyphs `...'. */
31102 for (i
= 0; i
< 3; ++i
)
31103 default_invis_vector
[i
] = make_number ('.');
31107 /* Allocate the buffer for frame titles.
31108 Also used for `format-mode-line'. */
31110 mode_line_noprop_buf
= xmalloc (size
);
31111 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31112 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31113 mode_line_target
= MODE_LINE_DISPLAY
;
31116 help_echo_showing_p
= false;
31119 #ifdef HAVE_WINDOW_SYSTEM
31121 /* Platform-independent portion of hourglass implementation. */
31123 /* Timer function of hourglass_atimer. */
31126 show_hourglass (struct atimer
*timer
)
31128 /* The timer implementation will cancel this timer automatically
31129 after this function has run. Set hourglass_atimer to null
31130 so that we know the timer doesn't have to be canceled. */
31131 hourglass_atimer
= NULL
;
31133 if (!hourglass_shown_p
)
31135 Lisp_Object tail
, frame
;
31139 FOR_EACH_FRAME (tail
, frame
)
31141 struct frame
*f
= XFRAME (frame
);
31143 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31144 && FRAME_RIF (f
)->show_hourglass
)
31145 FRAME_RIF (f
)->show_hourglass (f
);
31148 hourglass_shown_p
= true;
31153 /* Cancel a currently active hourglass timer, and start a new one. */
31156 start_hourglass (void)
31158 struct timespec delay
;
31160 cancel_hourglass ();
31162 if (INTEGERP (Vhourglass_delay
)
31163 && XINT (Vhourglass_delay
) > 0)
31164 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31165 TYPE_MAXIMUM (time_t)),
31167 else if (FLOATP (Vhourglass_delay
)
31168 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31169 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31171 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31173 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31174 show_hourglass
, NULL
);
31177 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31181 cancel_hourglass (void)
31183 if (hourglass_atimer
)
31185 cancel_atimer (hourglass_atimer
);
31186 hourglass_atimer
= NULL
;
31189 if (hourglass_shown_p
)
31191 Lisp_Object tail
, frame
;
31195 FOR_EACH_FRAME (tail
, frame
)
31197 struct frame
*f
= XFRAME (frame
);
31199 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31200 && FRAME_RIF (f
)->hide_hourglass
)
31201 FRAME_RIF (f
)->hide_hourglass (f
);
31203 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31204 else if (!FRAME_W32_P (f
))
31205 w32_arrow_cursor ();
31209 hourglass_shown_p
= false;
31214 #endif /* HAVE_WINDOW_SYSTEM */