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 int normal_char_height (struct font
*, int);
837 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
839 static void append_stretch_glyph (struct it
*, Lisp_Object
,
842 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
843 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
844 struct font
*, int, bool);
846 #endif /* HAVE_WINDOW_SYSTEM */
848 static void produce_special_glyphs (struct it
*, enum display_element_type
);
849 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
850 static bool coords_in_mouse_face_p (struct window
*, int, int);
854 /***********************************************************************
855 Window display dimensions
856 ***********************************************************************/
858 /* Return the bottom boundary y-position for text lines in window W.
859 This is the first y position at which a line cannot start.
860 It is relative to the top of the window.
862 This is the height of W minus the height of a mode line, if any. */
865 window_text_bottom_y (struct window
*w
)
867 int height
= WINDOW_PIXEL_HEIGHT (w
);
869 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
871 if (WINDOW_WANTS_MODELINE_P (w
))
872 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
874 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
879 /* Return the pixel width of display area AREA of window W.
880 ANY_AREA means return the total width of W, not including
881 fringes to the left and right of the window. */
884 window_box_width (struct window
*w
, enum glyph_row_area area
)
886 int width
= w
->pixel_width
;
888 if (!w
->pseudo_window_p
)
890 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
891 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
893 if (area
== TEXT_AREA
)
894 width
-= (WINDOW_MARGINS_WIDTH (w
)
895 + WINDOW_FRINGES_WIDTH (w
));
896 else if (area
== LEFT_MARGIN_AREA
)
897 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
898 else if (area
== RIGHT_MARGIN_AREA
)
899 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
902 /* With wide margins, fringes, etc. we might end up with a negative
903 width, correct that here. */
904 return max (0, width
);
908 /* Return the pixel height of the display area of window W, not
909 including mode lines of W, if any. */
912 window_box_height (struct window
*w
)
914 struct frame
*f
= XFRAME (w
->frame
);
915 int height
= WINDOW_PIXEL_HEIGHT (w
);
917 eassert (height
>= 0);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
920 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
922 /* Note: the code below that determines the mode-line/header-line
923 height is essentially the same as that contained in the macro
924 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
925 the appropriate glyph row has its `mode_line_p' flag set,
926 and if it doesn't, uses estimate_mode_line_height instead. */
928 if (WINDOW_WANTS_MODELINE_P (w
))
930 struct glyph_row
*ml_row
931 = (w
->current_matrix
&& w
->current_matrix
->rows
932 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
934 if (ml_row
&& ml_row
->mode_line_p
)
935 height
-= ml_row
->height
;
937 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
940 if (WINDOW_WANTS_HEADER_LINE_P (w
))
942 struct glyph_row
*hl_row
943 = (w
->current_matrix
&& w
->current_matrix
->rows
944 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
946 if (hl_row
&& hl_row
->mode_line_p
)
947 height
-= hl_row
->height
;
949 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
952 /* With a very small font and a mode-line that's taller than
953 default, we might end up with a negative height. */
954 return max (0, height
);
957 /* Return the window-relative coordinate of the left edge of display
958 area AREA of window W. ANY_AREA means return the left edge of the
959 whole window, to the right of the left fringe of W. */
962 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
966 if (w
->pseudo_window_p
)
969 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
971 if (area
== TEXT_AREA
)
972 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
973 + window_box_width (w
, LEFT_MARGIN_AREA
));
974 else if (area
== RIGHT_MARGIN_AREA
)
975 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
976 + window_box_width (w
, LEFT_MARGIN_AREA
)
977 + window_box_width (w
, TEXT_AREA
)
978 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
980 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
981 else if (area
== LEFT_MARGIN_AREA
982 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
983 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
985 /* Don't return more than the window's pixel width. */
986 return min (x
, w
->pixel_width
);
990 /* Return the window-relative coordinate of the right edge of display
991 area AREA of window W. ANY_AREA means return the right edge of the
992 whole window, to the left of the right fringe of W. */
995 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
997 /* Don't return more than the window's pixel width. */
998 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1002 /* Return the frame-relative coordinate of the left edge of display
1003 area AREA of window W. ANY_AREA means return the left edge of the
1004 whole window, to the right of the left fringe of W. */
1007 window_box_left (struct window
*w
, enum glyph_row_area area
)
1009 struct frame
*f
= XFRAME (w
->frame
);
1012 if (w
->pseudo_window_p
)
1013 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1015 x
= (WINDOW_LEFT_EDGE_X (w
)
1016 + window_box_left_offset (w
, area
));
1022 /* Return the frame-relative coordinate of the right edge of display
1023 area AREA of window W. ANY_AREA means return the right edge of the
1024 whole window, to the left of the right fringe of W. */
1027 window_box_right (struct window
*w
, enum glyph_row_area area
)
1029 return window_box_left (w
, area
) + window_box_width (w
, area
);
1032 /* Get the bounding box of the display area AREA of window W, without
1033 mode lines, in frame-relative coordinates. ANY_AREA means the
1034 whole window, not including the left and right fringes of
1035 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1036 coordinates of the upper-left corner of the box. Return in
1037 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1040 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1041 int *box_y
, int *box_width
, int *box_height
)
1044 *box_width
= window_box_width (w
, area
);
1046 *box_height
= window_box_height (w
);
1048 *box_x
= window_box_left (w
, area
);
1051 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1052 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1053 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1057 #ifdef HAVE_WINDOW_SYSTEM
1059 /* Get the bounding box of the display area AREA of window W, without
1060 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1061 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1062 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1063 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1067 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1068 int *bottom_right_x
, int *bottom_right_y
)
1070 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1071 bottom_right_x
, bottom_right_y
);
1072 *bottom_right_x
+= *top_left_x
;
1073 *bottom_right_y
+= *top_left_y
;
1076 #endif /* HAVE_WINDOW_SYSTEM */
1078 /***********************************************************************
1080 ***********************************************************************/
1082 /* Return the bottom y-position of the line the iterator IT is in.
1083 This can modify IT's settings. */
1086 line_bottom_y (struct it
*it
)
1088 int line_height
= it
->max_ascent
+ it
->max_descent
;
1089 int line_top_y
= it
->current_y
;
1091 if (line_height
== 0)
1094 line_height
= last_height
;
1095 else if (IT_CHARPOS (*it
) < ZV
)
1097 move_it_by_lines (it
, 1);
1098 line_height
= (it
->max_ascent
|| it
->max_descent
1099 ? it
->max_ascent
+ it
->max_descent
1104 struct glyph_row
*row
= it
->glyph_row
;
1106 /* Use the default character height. */
1107 it
->glyph_row
= NULL
;
1108 it
->what
= IT_CHARACTER
;
1111 PRODUCE_GLYPHS (it
);
1112 line_height
= it
->ascent
+ it
->descent
;
1113 it
->glyph_row
= row
;
1117 return line_top_y
+ line_height
;
1120 DEFUN ("line-pixel-height", Fline_pixel_height
,
1121 Sline_pixel_height
, 0, 0, 0,
1122 doc
: /* Return height in pixels of text line in the selected window.
1124 Value is the height in pixels of the line at point. */)
1129 struct window
*w
= XWINDOW (selected_window
);
1130 struct buffer
*old_buffer
= NULL
;
1133 if (XBUFFER (w
->contents
) != current_buffer
)
1135 old_buffer
= current_buffer
;
1136 set_buffer_internal_1 (XBUFFER (w
->contents
));
1138 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1139 start_display (&it
, w
, pt
);
1140 it
.vpos
= it
.current_y
= 0;
1142 result
= make_number (line_bottom_y (&it
));
1144 set_buffer_internal_1 (old_buffer
);
1149 /* Return the default pixel height of text lines in window W. The
1150 value is the canonical height of the W frame's default font, plus
1151 any extra space required by the line-spacing variable or frame
1154 Implementation note: this ignores any line-spacing text properties
1155 put on the newline characters. This is because those properties
1156 only affect the _screen_ line ending in the newline (i.e., in a
1157 continued line, only the last screen line will be affected), which
1158 means only a small number of lines in a buffer can ever use this
1159 feature. Since this function is used to compute the default pixel
1160 equivalent of text lines in a window, we can safely ignore those
1161 few lines. For the same reasons, we ignore the line-height
1164 default_line_pixel_height (struct window
*w
)
1166 struct frame
*f
= WINDOW_XFRAME (w
);
1167 int height
= FRAME_LINE_HEIGHT (f
);
1169 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1171 struct buffer
*b
= XBUFFER (w
->contents
);
1172 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1175 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1178 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1179 height
+= XFASTINT (val
);
1180 else if (FLOATP (val
))
1182 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1189 height
+= f
->extra_line_spacing
;
1195 /* Subroutine of pos_visible_p below. Extracts a display string, if
1196 any, from the display spec given as its argument. */
1198 string_from_display_spec (Lisp_Object spec
)
1202 while (CONSP (spec
))
1204 if (STRINGP (XCAR (spec
)))
1209 else if (VECTORP (spec
))
1213 for (i
= 0; i
< ASIZE (spec
); i
++)
1215 if (STRINGP (AREF (spec
, i
)))
1216 return AREF (spec
, i
);
1225 /* Limit insanely large values of W->hscroll on frame F to the largest
1226 value that will still prevent first_visible_x and last_visible_x of
1227 'struct it' from overflowing an int. */
1229 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1231 ptrdiff_t window_hscroll
= w
->hscroll
;
1232 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1233 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1235 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1236 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1238 return window_hscroll
;
1241 /* Return true if position CHARPOS is visible in window W.
1242 CHARPOS < 0 means return info about WINDOW_END position.
1243 If visible, set *X and *Y to pixel coordinates of top left corner.
1244 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1245 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1248 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1249 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1252 void *itdata
= bidi_shelve_cache ();
1253 struct text_pos top
;
1254 bool visible_p
= false;
1255 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->contents
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->contents
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1268 /* Scrolling a minibuffer window via scroll bar when the echo area
1269 shows long text sometimes resets the minibuffer contents behind
1271 if (CHARPOS (top
) > ZV
)
1272 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1274 /* Compute exact mode line heights. */
1275 if (WINDOW_WANTS_MODELINE_P (w
))
1277 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1278 BVAR (current_buffer
, mode_line_format
));
1280 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1281 w
->header_line_height
1282 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1283 BVAR (current_buffer
, header_line_format
));
1285 start_display (&it
, w
, top
);
1286 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1287 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1290 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1291 && IT_CHARPOS (it
) >= charpos
)
1292 /* When scanning backwards under bidi iteration, move_it_to
1293 stops at or _before_ CHARPOS, because it stops at or to
1294 the _right_ of the character at CHARPOS. */
1295 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1296 && IT_CHARPOS (it
) <= charpos
)))
1298 /* We have reached CHARPOS, or passed it. How the call to
1299 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1300 or covered by a display property, move_it_to stops at the end
1301 of the invisible text, to the right of CHARPOS. (ii) If
1302 CHARPOS is in a display vector, move_it_to stops on its last
1304 int top_x
= it
.current_x
;
1305 int top_y
= it
.current_y
;
1306 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1309 void *save_it_data
= NULL
;
1311 /* Calling line_bottom_y may change it.method, it.position, etc. */
1312 SAVE_IT (save_it
, it
, save_it_data
);
1314 bottom_y
= line_bottom_y (&it
);
1315 if (top_y
< window_top_y
)
1316 visible_p
= bottom_y
> window_top_y
;
1317 else if (top_y
< it
.last_visible_y
)
1319 if (bottom_y
>= it
.last_visible_y
1320 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1321 && IT_CHARPOS (it
) < charpos
)
1323 /* When the last line of the window is scanned backwards
1324 under bidi iteration, we could be duped into thinking
1325 that we have passed CHARPOS, when in fact move_it_to
1326 simply stopped short of CHARPOS because it reached
1327 last_visible_y. To see if that's what happened, we call
1328 move_it_to again with a slightly larger vertical limit,
1329 and see if it actually moved vertically; if it did, we
1330 didn't really reach CHARPOS, which is beyond window end. */
1331 /* Why 10? because we don't know how many canonical lines
1332 will the height of the next line(s) be. So we guess. */
1333 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1335 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1336 MOVE_TO_POS
| MOVE_TO_Y
);
1337 if (it
.current_y
> top_y
)
1341 RESTORE_IT (&it
, &save_it
, save_it_data
);
1344 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1346 /* We stopped on the last glyph of a display vector.
1347 Try and recompute. Hack alert! */
1348 if (charpos
< 2 || top
.charpos
>= charpos
)
1349 top_x
= it
.glyph_row
->x
;
1352 struct it it2
, it2_prev
;
1353 /* The idea is to get to the previous buffer
1354 position, consume the character there, and use
1355 the pixel coordinates we get after that. But if
1356 the previous buffer position is also displayed
1357 from a display vector, we need to consume all of
1358 the glyphs from that display vector. */
1359 start_display (&it2
, w
, top
);
1360 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1361 /* If we didn't get to CHARPOS - 1, there's some
1362 replacing display property at that position, and
1363 we stopped after it. That is exactly the place
1364 whose coordinates we want. */
1365 if (IT_CHARPOS (it2
) != charpos
- 1)
1369 /* Iterate until we get out of the display
1370 vector that displays the character at
1373 get_next_display_element (&it2
);
1374 PRODUCE_GLYPHS (&it2
);
1376 set_iterator_to_next (&it2
, true);
1377 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1378 && IT_CHARPOS (it2
) < charpos
);
1380 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1381 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1382 top_x
= it
.glyph_row
->x
;
1385 top_x
= it2_prev
.current_x
;
1386 top_y
= it2_prev
.current_y
;
1390 else if (IT_CHARPOS (it
) != charpos
)
1392 Lisp_Object cpos
= make_number (charpos
);
1393 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1394 Lisp_Object string
= string_from_display_spec (spec
);
1395 struct text_pos tpos
;
1396 bool newline_in_string
1398 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1400 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1401 bool replacing_spec_p
1403 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1404 charpos
, FRAME_WINDOW_P (it
.f
)));
1405 /* The tricky code below is needed because there's a
1406 discrepancy between move_it_to and how we set cursor
1407 when PT is at the beginning of a portion of text
1408 covered by a display property or an overlay with a
1409 display property, or the display line ends in a
1410 newline from a display string. move_it_to will stop
1411 _after_ such display strings, whereas
1412 set_cursor_from_row conspires with cursor_row_p to
1413 place the cursor on the first glyph produced from the
1416 /* We have overshoot PT because it is covered by a
1417 display property that replaces the text it covers.
1418 If the string includes embedded newlines, we are also
1419 in the wrong display line. Backtrack to the correct
1420 line, where the display property begins. */
1421 if (replacing_spec_p
)
1423 Lisp_Object startpos
, endpos
;
1424 EMACS_INT start
, end
;
1427 /* Find the first and the last buffer positions
1428 covered by the display string. */
1430 Fnext_single_char_property_change (cpos
, Qdisplay
,
1433 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1435 start
= XFASTINT (startpos
);
1436 end
= XFASTINT (endpos
);
1437 /* Move to the last buffer position before the
1438 display property. */
1439 start_display (&it3
, w
, top
);
1440 if (start
> CHARPOS (top
))
1441 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1442 /* Move forward one more line if the position before
1443 the display string is a newline or if it is the
1444 rightmost character on a line that is
1445 continued or word-wrapped. */
1446 if (it3
.method
== GET_FROM_BUFFER
1448 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1449 move_it_by_lines (&it3
, 1);
1450 else if (move_it_in_display_line_to (&it3
, -1,
1454 == MOVE_LINE_CONTINUED
)
1456 move_it_by_lines (&it3
, 1);
1457 /* When we are under word-wrap, the #$@%!
1458 move_it_by_lines moves 2 lines, so we need to
1460 if (it3
.line_wrap
== WORD_WRAP
)
1461 move_it_by_lines (&it3
, -1);
1464 /* Record the vertical coordinate of the display
1465 line where we wound up. */
1466 top_y
= it3
.current_y
;
1469 /* When characters are reordered for display,
1470 the character displayed to the left of the
1471 display string could be _after_ the display
1472 property in the logical order. Use the
1473 smallest vertical position of these two. */
1474 start_display (&it3
, w
, top
);
1475 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1476 if (it3
.current_y
< top_y
)
1477 top_y
= it3
.current_y
;
1479 /* Move from the top of the window to the beginning
1480 of the display line where the display string
1482 start_display (&it3
, w
, top
);
1483 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1484 /* If it3_moved stays false after the 'while' loop
1485 below, that means we already were at a newline
1486 before the loop (e.g., the display string begins
1487 with a newline), so we don't need to (and cannot)
1488 inspect the glyphs of it3.glyph_row, because
1489 PRODUCE_GLYPHS will not produce anything for a
1490 newline, and thus it3.glyph_row stays at its
1491 stale content it got at top of the window. */
1492 bool it3_moved
= false;
1493 /* Finally, advance the iterator until we hit the
1494 first display element whose character position is
1495 CHARPOS, or until the first newline from the
1496 display string, which signals the end of the
1498 while (get_next_display_element (&it3
))
1500 PRODUCE_GLYPHS (&it3
);
1501 if (IT_CHARPOS (it3
) == charpos
1502 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1505 set_iterator_to_next (&it3
, false);
1507 top_x
= it3
.current_x
- it3
.pixel_width
;
1508 /* Normally, we would exit the above loop because we
1509 found the display element whose character
1510 position is CHARPOS. For the contingency that we
1511 didn't, and stopped at the first newline from the
1512 display string, move back over the glyphs
1513 produced from the string, until we find the
1514 rightmost glyph not from the string. */
1516 && newline_in_string
1517 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1519 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1520 + it3
.glyph_row
->used
[TEXT_AREA
];
1522 while (EQ ((g
- 1)->object
, string
))
1525 top_x
-= g
->pixel_width
;
1527 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1528 + it3
.glyph_row
->used
[TEXT_AREA
]);
1534 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1535 *rtop
= max (0, window_top_y
- top_y
);
1536 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1537 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1538 - max (top_y
, window_top_y
)));
1540 if (it
.bidi_it
.paragraph_dir
== R2L
)
1546 /* Either we were asked to provide info about WINDOW_END, or
1547 CHARPOS is in the partially visible glyph row at end of
1550 void *it2data
= NULL
;
1552 SAVE_IT (it2
, it
, it2data
);
1553 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1554 move_it_by_lines (&it
, 1);
1555 if (charpos
< IT_CHARPOS (it
)
1556 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1559 RESTORE_IT (&it2
, &it2
, it2data
);
1560 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1562 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1563 *rtop
= max (0, -it2
.current_y
);
1564 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1565 - it
.last_visible_y
));
1566 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1568 - max (it2
.current_y
,
1569 WINDOW_HEADER_LINE_HEIGHT (w
))));
1571 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1575 bidi_unshelve_cache (it2data
, true);
1577 bidi_unshelve_cache (itdata
, false);
1580 set_buffer_internal_1 (old_buffer
);
1586 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1587 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1588 /* For lines in an R2L paragraph, we need to mirror the X pixel
1589 coordinate wrt the text area. For the reasons, see the
1590 commentary in buffer_posn_from_coords and the explanation of
1591 the geometry used by the move_it_* functions at the end of
1592 the large commentary near the beginning of this file. */
1594 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1598 /* Debugging code. */
1600 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1601 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1603 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1610 /* Return the next character from STR. Return in *LEN the length of
1611 the character. This is like STRING_CHAR_AND_LENGTH but never
1612 returns an invalid character. If we find one, we return a `?', but
1613 with the length of the invalid character. */
1616 string_char_and_length (const unsigned char *str
, int *len
)
1620 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1621 if (!CHAR_VALID_P (c
))
1622 /* We may not change the length here because other places in Emacs
1623 don't use this function, i.e. they silently accept invalid
1632 /* Given a position POS containing a valid character and byte position
1633 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1635 static struct text_pos
1636 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1638 eassert (STRINGP (string
) && nchars
>= 0);
1640 if (STRING_MULTIBYTE (string
))
1642 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1647 string_char_and_length (p
, &len
);
1650 BYTEPOS (pos
) += len
;
1654 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1660 /* Value is the text position, i.e. character and byte position,
1661 for character position CHARPOS in STRING. */
1663 static struct text_pos
1664 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1666 struct text_pos pos
;
1667 eassert (STRINGP (string
));
1668 eassert (charpos
>= 0);
1669 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1674 /* Value is a text position, i.e. character and byte position, for
1675 character position CHARPOS in C string S. MULTIBYTE_P
1676 means recognize multibyte characters. */
1678 static struct text_pos
1679 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1681 struct text_pos pos
;
1683 eassert (s
!= NULL
);
1684 eassert (charpos
>= 0);
1690 SET_TEXT_POS (pos
, 0, 0);
1693 string_char_and_length ((const unsigned char *) s
, &len
);
1696 BYTEPOS (pos
) += len
;
1700 SET_TEXT_POS (pos
, charpos
, charpos
);
1706 /* Value is the number of characters in C string S. MULTIBYTE_P
1707 means recognize multibyte characters. */
1710 number_of_chars (const char *s
, bool multibyte_p
)
1716 ptrdiff_t rest
= strlen (s
);
1718 const unsigned char *p
= (const unsigned char *) s
;
1720 for (nchars
= 0; rest
> 0; ++nchars
)
1722 string_char_and_length (p
, &len
);
1723 rest
-= len
, p
+= len
;
1727 nchars
= strlen (s
);
1733 /* Compute byte position NEWPOS->bytepos corresponding to
1734 NEWPOS->charpos. POS is a known position in string STRING.
1735 NEWPOS->charpos must be >= POS.charpos. */
1738 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1740 eassert (STRINGP (string
));
1741 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1743 if (STRING_MULTIBYTE (string
))
1744 *newpos
= string_pos_nchars_ahead (pos
, string
,
1745 CHARPOS (*newpos
) - CHARPOS (pos
));
1747 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1751 Return an estimation of the pixel height of mode or header lines on
1752 frame F. FACE_ID specifies what line's height to estimate. */
1755 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1757 #ifdef HAVE_WINDOW_SYSTEM
1758 if (FRAME_WINDOW_P (f
))
1760 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1762 /* This function is called so early when Emacs starts that the face
1763 cache and mode line face are not yet initialized. */
1764 if (FRAME_FACE_CACHE (f
))
1766 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1770 height
= normal_char_height (face
->font
, -1);
1771 if (face
->box_line_width
> 0)
1772 height
+= 2 * face
->box_line_width
;
1783 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1784 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1785 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1786 not force the value into range. */
1789 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1790 NativeRectangle
*bounds
, bool noclip
)
1793 #ifdef HAVE_WINDOW_SYSTEM
1794 if (FRAME_WINDOW_P (f
))
1796 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1797 even for negative values. */
1799 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1801 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1803 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1804 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1807 STORE_NATIVE_RECT (*bounds
,
1808 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1809 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1810 FRAME_COLUMN_WIDTH (f
) - 1,
1811 FRAME_LINE_HEIGHT (f
) - 1);
1813 /* PXW: Should we clip pixels before converting to columns/lines? */
1818 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1819 pix_x
= FRAME_TOTAL_COLS (f
);
1823 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1824 pix_y
= FRAME_TOTAL_LINES (f
);
1834 /* Find the glyph under window-relative coordinates X/Y in window W.
1835 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1836 strings. Return in *HPOS and *VPOS the row and column number of
1837 the glyph found. Return in *AREA the glyph area containing X.
1838 Value is a pointer to the glyph found or null if X/Y is not on
1839 text, or we can't tell because W's current matrix is not up to
1842 static struct glyph
*
1843 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1844 int *dx
, int *dy
, int *area
)
1846 struct glyph
*glyph
, *end
;
1847 struct glyph_row
*row
= NULL
;
1850 /* Find row containing Y. Give up if some row is not enabled. */
1851 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1853 row
= MATRIX_ROW (w
->current_matrix
, i
);
1854 if (!row
->enabled_p
)
1856 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1863 /* Give up if Y is not in the window. */
1864 if (i
== w
->current_matrix
->nrows
)
1867 /* Get the glyph area containing X. */
1868 if (w
->pseudo_window_p
)
1875 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1877 *area
= LEFT_MARGIN_AREA
;
1878 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1880 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1883 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1887 *area
= RIGHT_MARGIN_AREA
;
1888 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1892 /* Find glyph containing X. */
1893 glyph
= row
->glyphs
[*area
];
1894 end
= glyph
+ row
->used
[*area
];
1896 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1898 x
-= glyph
->pixel_width
;
1908 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1911 *hpos
= glyph
- row
->glyphs
[*area
];
1915 /* Convert frame-relative x/y to coordinates relative to window W.
1916 Takes pseudo-windows into account. */
1919 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1921 if (w
->pseudo_window_p
)
1923 /* A pseudo-window is always full-width, and starts at the
1924 left edge of the frame, plus a frame border. */
1925 struct frame
*f
= XFRAME (w
->frame
);
1926 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1927 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1931 *x
-= WINDOW_LEFT_EDGE_X (w
);
1932 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1936 #ifdef HAVE_WINDOW_SYSTEM
1939 Return in RECTS[] at most N clipping rectangles for glyph string S.
1940 Return the number of stored rectangles. */
1943 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1950 if (s
->row
->full_width_p
)
1952 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1953 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1954 if (s
->row
->mode_line_p
)
1955 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
1957 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
1959 /* Unless displaying a mode or menu bar line, which are always
1960 fully visible, clip to the visible part of the row. */
1961 if (s
->w
->pseudo_window_p
)
1962 r
.height
= s
->row
->visible_height
;
1964 r
.height
= s
->height
;
1968 /* This is a text line that may be partially visible. */
1969 r
.x
= window_box_left (s
->w
, s
->area
);
1970 r
.width
= window_box_width (s
->w
, s
->area
);
1971 r
.height
= s
->row
->visible_height
;
1975 if (r
.x
< s
->clip_head
->x
)
1977 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1978 r
.width
-= s
->clip_head
->x
- r
.x
;
1981 r
.x
= s
->clip_head
->x
;
1984 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1986 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1987 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1992 /* If S draws overlapping rows, it's sufficient to use the top and
1993 bottom of the window for clipping because this glyph string
1994 intentionally draws over other lines. */
1995 if (s
->for_overlaps
)
1997 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1998 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2000 /* Alas, the above simple strategy does not work for the
2001 environments with anti-aliased text: if the same text is
2002 drawn onto the same place multiple times, it gets thicker.
2003 If the overlap we are processing is for the erased cursor, we
2004 take the intersection with the rectangle of the cursor. */
2005 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2007 XRectangle rc
, r_save
= r
;
2009 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2010 rc
.y
= s
->w
->phys_cursor
.y
;
2011 rc
.width
= s
->w
->phys_cursor_width
;
2012 rc
.height
= s
->w
->phys_cursor_height
;
2014 x_intersect_rectangles (&r_save
, &rc
, &r
);
2019 /* Don't use S->y for clipping because it doesn't take partially
2020 visible lines into account. For example, it can be negative for
2021 partially visible lines at the top of a window. */
2022 if (!s
->row
->full_width_p
2023 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2024 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2026 r
.y
= max (0, s
->row
->y
);
2029 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2031 /* If drawing the cursor, don't let glyph draw outside its
2032 advertised boundaries. Cleartype does this under some circumstances. */
2033 if (s
->hl
== DRAW_CURSOR
)
2035 struct glyph
*glyph
= s
->first_glyph
;
2040 if (r
.width
>= s
->x
- r
.x
)
2041 r
.width
-= s
->x
- r
.x
;
2042 else /* R2L hscrolled row with cursor outside text area */
2046 r
.width
= min (r
.width
, glyph
->pixel_width
);
2048 /* If r.y is below window bottom, ensure that we still see a cursor. */
2049 height
= min (glyph
->ascent
+ glyph
->descent
,
2050 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2051 max_y
= window_text_bottom_y (s
->w
) - height
;
2052 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2053 if (s
->ybase
- glyph
->ascent
> max_y
)
2060 /* Don't draw cursor glyph taller than our actual glyph. */
2061 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2062 if (height
< r
.height
)
2064 max_y
= r
.y
+ r
.height
;
2065 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2066 r
.height
= min (max_y
- r
.y
, height
);
2073 XRectangle r_save
= r
;
2075 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2079 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2080 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2082 #ifdef CONVERT_FROM_XRECT
2083 CONVERT_FROM_XRECT (r
, *rects
);
2091 /* If we are processing overlapping and allowed to return
2092 multiple clipping rectangles, we exclude the row of the glyph
2093 string from the clipping rectangle. This is to avoid drawing
2094 the same text on the environment with anti-aliasing. */
2095 #ifdef CONVERT_FROM_XRECT
2098 XRectangle
*rs
= rects
;
2100 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2102 if (s
->for_overlaps
& OVERLAPS_PRED
)
2105 if (r
.y
+ r
.height
> row_y
)
2108 rs
[i
].height
= row_y
- r
.y
;
2114 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2117 if (r
.y
< row_y
+ s
->row
->visible_height
)
2119 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2121 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2122 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i
= 0; i
< n
; i
++)
2133 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2140 Return in *NR the clipping rectangle for glyph string S. */
2143 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2145 get_glyph_string_clip_rects (s
, nr
, 1);
2150 Return the position and height of the phys cursor in window W.
2151 Set w->phys_cursor_width to width of phys cursor.
2155 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2156 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2158 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2159 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2161 /* Compute the width of the rectangle to draw. If on a stretch
2162 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2163 rectangle as wide as the glyph, but use a canonical character
2165 wd
= glyph
->pixel_width
;
2167 x
= w
->phys_cursor
.x
;
2174 if (glyph
->type
== STRETCH_GLYPH
2175 && !x_stretch_cursor_p
)
2176 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2177 w
->phys_cursor_width
= wd
;
2179 /* Don't let the hollow cursor glyph descend below the glyph row's
2180 ascent value, lest the hollow cursor looks funny. */
2181 y
= w
->phys_cursor
.y
;
2182 ascent
= row
->ascent
;
2183 if (row
->ascent
< glyph
->ascent
)
2185 y
=- glyph
->ascent
- row
->ascent
;
2186 ascent
= glyph
->ascent
;
2189 /* If y is below window bottom, ensure that we still see a cursor. */
2190 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2192 h
= max (h0
, ascent
+ glyph
->descent
);
2193 h0
= min (h0
, ascent
+ glyph
->descent
);
2195 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2198 h
= max (h
- (y0
- y
) + 1, h0
);
2203 y0
= window_text_bottom_y (w
) - h0
;
2211 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2212 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2217 * Remember which glyph the mouse is over.
2221 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2225 struct glyph_row
*r
, *gr
, *end_row
;
2226 enum window_part part
;
2227 enum glyph_row_area area
;
2228 int x
, y
, width
, height
;
2230 /* Try to determine frame pixel position and size of the glyph under
2231 frame pixel coordinates X/Y on frame F. */
2233 if (window_resize_pixelwise
)
2238 else if (!f
->glyphs_initialized_p
2239 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2242 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2243 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2247 w
= XWINDOW (window
);
2248 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2249 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2251 x
= window_relative_x_coord (w
, part
, gx
);
2252 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2254 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2255 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2257 if (w
->pseudo_window_p
)
2260 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2266 case ON_LEFT_MARGIN
:
2267 area
= LEFT_MARGIN_AREA
;
2270 case ON_RIGHT_MARGIN
:
2271 area
= RIGHT_MARGIN_AREA
;
2274 case ON_HEADER_LINE
:
2276 gr
= (part
== ON_HEADER_LINE
2277 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2278 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2281 goto text_glyph_row_found
;
2288 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2289 if (r
->y
+ r
->height
> y
)
2295 text_glyph_row_found
:
2298 struct glyph
*g
= gr
->glyphs
[area
];
2299 struct glyph
*end
= g
+ gr
->used
[area
];
2301 height
= gr
->height
;
2302 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2303 if (gx
+ g
->pixel_width
> x
)
2308 if (g
->type
== IMAGE_GLYPH
)
2310 /* Don't remember when mouse is over image, as
2311 image may have hot-spots. */
2312 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2315 width
= g
->pixel_width
;
2319 /* Use nominal char spacing at end of line. */
2321 gx
+= (x
/ width
) * width
;
2324 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2326 gx
+= window_box_left_offset (w
, area
);
2327 /* Don't expand over the modeline to make sure the vertical
2328 drag cursor is shown early enough. */
2329 height
= min (height
,
2330 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2335 /* Use nominal line height at end of window. */
2336 gx
= (x
/ width
) * width
;
2338 gy
+= (y
/ height
) * height
;
2339 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2340 /* See comment above. */
2341 height
= min (height
,
2342 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2346 case ON_LEFT_FRINGE
:
2347 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2348 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2349 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2350 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2353 case ON_RIGHT_FRINGE
:
2354 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2355 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2356 : window_box_right_offset (w
, TEXT_AREA
));
2357 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2358 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2359 && !WINDOW_RIGHTMOST_P (w
))
2360 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2361 /* Make sure the vertical border can get her own glyph to the
2362 right of the one we build here. */
2363 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2365 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2367 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2371 case ON_VERTICAL_BORDER
:
2372 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2375 case ON_VERTICAL_SCROLL_BAR
:
2376 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2378 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2379 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2380 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2382 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2386 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2387 if (r
->y
+ r
->height
> y
)
2394 height
= gr
->height
;
2397 /* Use nominal line height at end of window. */
2399 gy
+= (y
/ height
) * height
;
2403 case ON_RIGHT_DIVIDER
:
2404 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2405 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2407 /* The bottom divider prevails. */
2408 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2411 case ON_BOTTOM_DIVIDER
:
2413 width
= WINDOW_PIXEL_WIDTH (w
);
2414 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2415 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2421 /* If there is no glyph under the mouse, then we divide the screen
2422 into a grid of the smallest glyph in the frame, and use that
2425 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2426 round down even for negative values. */
2432 gx
= (gx
/ width
) * width
;
2433 gy
= (gy
/ height
) * height
;
2439 gx
+= WINDOW_LEFT_EDGE_X (w
);
2440 gy
+= WINDOW_TOP_EDGE_Y (w
);
2443 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2445 /* Visible feedback for debugging. */
2446 #if false && defined HAVE_X_WINDOWS
2447 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2448 f
->output_data
.x
->normal_gc
,
2449 gx
, gy
, width
, height
);
2454 #endif /* HAVE_WINDOW_SYSTEM */
2457 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2460 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2461 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2463 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2466 /***********************************************************************
2467 Lisp form evaluation
2468 ***********************************************************************/
2470 /* Error handler for safe_eval and safe_call. */
2473 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2475 add_to_log ("Error during redisplay: %S signaled %S",
2476 Flist (nargs
, args
), arg
);
2480 /* Call function FUNC with the rest of NARGS - 1 arguments
2481 following. Return the result, or nil if something went
2482 wrong. Prevent redisplay during the evaluation. */
2485 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2489 if (inhibit_eval_during_redisplay
)
2494 ptrdiff_t count
= SPECPDL_INDEX ();
2497 SAFE_ALLOCA_LISP (args
, nargs
);
2500 for (i
= 1; i
< nargs
; i
++)
2501 args
[i
] = va_arg (ap
, Lisp_Object
);
2503 specbind (Qinhibit_redisplay
, Qt
);
2505 specbind (Qinhibit_quit
, Qt
);
2506 /* Use Qt to ensure debugger does not run,
2507 so there is no possibility of wanting to redisplay. */
2508 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2511 val
= unbind_to (count
, val
);
2518 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2523 va_start (ap
, func
);
2524 retval
= safe__call (false, nargs
, func
, ap
);
2529 /* Call function FN with one argument ARG.
2530 Return the result, or nil if something went wrong. */
2533 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2535 return safe_call (2, fn
, arg
);
2539 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2545 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2551 safe_eval (Lisp_Object sexpr
)
2553 return safe__call1 (false, Qeval
, sexpr
);
2557 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2559 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2562 /* Call function FN with two arguments ARG1 and ARG2.
2563 Return the result, or nil if something went wrong. */
2566 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2568 return safe_call (3, fn
, arg1
, arg2
);
2573 /***********************************************************************
2575 ***********************************************************************/
2577 /* Define CHECK_IT to perform sanity checks on iterators.
2578 This is for debugging. It is too slow to do unconditionally. */
2581 CHECK_IT (struct it
*it
)
2584 if (it
->method
== GET_FROM_STRING
)
2586 eassert (STRINGP (it
->string
));
2587 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2591 eassert (IT_STRING_CHARPOS (*it
) < 0);
2592 if (it
->method
== GET_FROM_BUFFER
)
2594 /* Check that character and byte positions agree. */
2595 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2600 eassert (it
->current
.dpvec_index
>= 0);
2602 eassert (it
->current
.dpvec_index
< 0);
2607 /* Check that the window end of window W is what we expect it
2608 to be---the last row in the current matrix displaying text. */
2611 CHECK_WINDOW_END (struct window
*w
)
2613 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2614 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2616 struct glyph_row
*row
;
2617 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2619 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2620 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2625 /***********************************************************************
2626 Iterator initialization
2627 ***********************************************************************/
2629 /* Initialize IT for displaying current_buffer in window W, starting
2630 at character position CHARPOS. CHARPOS < 0 means that no buffer
2631 position is specified which is useful when the iterator is assigned
2632 a position later. BYTEPOS is the byte position corresponding to
2635 If ROW is not null, calls to produce_glyphs with IT as parameter
2636 will produce glyphs in that row.
2638 BASE_FACE_ID is the id of a base face to use. It must be one of
2639 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2640 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2641 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2643 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2644 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2645 will be initialized to use the corresponding mode line glyph row of
2646 the desired matrix of W. */
2649 init_iterator (struct it
*it
, struct window
*w
,
2650 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2651 struct glyph_row
*row
, enum face_id base_face_id
)
2653 enum face_id remapped_base_face_id
= base_face_id
;
2655 /* Some precondition checks. */
2656 eassert (w
!= NULL
&& it
!= NULL
);
2657 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2660 /* If face attributes have been changed since the last redisplay,
2661 free realized faces now because they depend on face definitions
2662 that might have changed. Don't free faces while there might be
2663 desired matrices pending which reference these faces. */
2664 if (face_change
&& !inhibit_free_realized_faces
)
2666 face_change
= false;
2667 free_all_realized_faces (Qnil
);
2670 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2671 if (! NILP (Vface_remapping_alist
))
2672 remapped_base_face_id
2673 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2675 /* Use one of the mode line rows of W's desired matrix if
2679 if (base_face_id
== MODE_LINE_FACE_ID
2680 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2681 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2682 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2683 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2686 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2687 Other parts of redisplay rely on that. */
2688 memclear (it
, sizeof *it
);
2689 it
->current
.overlay_string_index
= -1;
2690 it
->current
.dpvec_index
= -1;
2691 it
->base_face_id
= remapped_base_face_id
;
2692 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2693 it
->paragraph_embedding
= L2R
;
2696 /* The window in which we iterate over current_buffer: */
2697 XSETWINDOW (it
->window
, w
);
2699 it
->f
= XFRAME (w
->frame
);
2703 /* Extra space between lines (on window systems only). */
2704 if (base_face_id
== DEFAULT_FACE_ID
2705 && FRAME_WINDOW_P (it
->f
))
2707 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2708 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2709 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2710 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2711 * FRAME_LINE_HEIGHT (it
->f
));
2712 else if (it
->f
->extra_line_spacing
> 0)
2713 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2716 /* If realized faces have been removed, e.g. because of face
2717 attribute changes of named faces, recompute them. When running
2718 in batch mode, the face cache of the initial frame is null. If
2719 we happen to get called, make a dummy face cache. */
2720 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2721 init_frame_faces (it
->f
);
2722 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2723 recompute_basic_faces (it
->f
);
2725 it
->override_ascent
= -1;
2727 /* Are control characters displayed as `^C'? */
2728 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2730 /* -1 means everything between a CR and the following line end
2731 is invisible. >0 means lines indented more than this value are
2733 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2735 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2737 : (!NILP (BVAR (current_buffer
, selective_display
))
2739 it
->selective_display_ellipsis_p
2740 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2742 /* Display table to use. */
2743 it
->dp
= window_display_table (w
);
2745 /* Are multibyte characters enabled in current_buffer? */
2746 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2748 /* Get the position at which the redisplay_end_trigger hook should
2749 be run, if it is to be run at all. */
2750 if (MARKERP (w
->redisplay_end_trigger
)
2751 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2752 it
->redisplay_end_trigger_charpos
2753 = marker_position (w
->redisplay_end_trigger
);
2754 else if (INTEGERP (w
->redisplay_end_trigger
))
2755 it
->redisplay_end_trigger_charpos
2756 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2759 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2761 /* Are lines in the display truncated? */
2763 it
->line_wrap
= TRUNCATE
;
2764 if (base_face_id
== DEFAULT_FACE_ID
2766 && (WINDOW_FULL_WIDTH_P (it
->w
)
2767 || NILP (Vtruncate_partial_width_windows
)
2768 || (INTEGERP (Vtruncate_partial_width_windows
)
2769 /* PXW: Shall we do something about this? */
2770 && (XINT (Vtruncate_partial_width_windows
)
2771 <= WINDOW_TOTAL_COLS (it
->w
))))
2772 && NILP (BVAR (current_buffer
, truncate_lines
)))
2773 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2774 ? WINDOW_WRAP
: WORD_WRAP
;
2776 /* Get dimensions of truncation and continuation glyphs. These are
2777 displayed as fringe bitmaps under X, but we need them for such
2778 frames when the fringes are turned off. But leave the dimensions
2779 zero for tooltip frames, as these glyphs look ugly there and also
2780 sabotage calculations of tooltip dimensions in x-show-tip. */
2781 #ifdef HAVE_WINDOW_SYSTEM
2782 if (!(FRAME_WINDOW_P (it
->f
)
2783 && FRAMEP (tip_frame
)
2784 && it
->f
== XFRAME (tip_frame
)))
2787 if (it
->line_wrap
== TRUNCATE
)
2789 /* We will need the truncation glyph. */
2790 eassert (it
->glyph_row
== NULL
);
2791 produce_special_glyphs (it
, IT_TRUNCATION
);
2792 it
->truncation_pixel_width
= it
->pixel_width
;
2796 /* We will need the continuation glyph. */
2797 eassert (it
->glyph_row
== NULL
);
2798 produce_special_glyphs (it
, IT_CONTINUATION
);
2799 it
->continuation_pixel_width
= it
->pixel_width
;
2803 /* Reset these values to zero because the produce_special_glyphs
2804 above has changed them. */
2805 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2806 it
->phys_ascent
= it
->phys_descent
= 0;
2808 /* Set this after getting the dimensions of truncation and
2809 continuation glyphs, so that we don't produce glyphs when calling
2810 produce_special_glyphs, above. */
2811 it
->glyph_row
= row
;
2812 it
->area
= TEXT_AREA
;
2814 /* Get the dimensions of the display area. The display area
2815 consists of the visible window area plus a horizontally scrolled
2816 part to the left of the window. All x-values are relative to the
2817 start of this total display area. */
2818 if (base_face_id
!= DEFAULT_FACE_ID
)
2820 /* Mode lines, menu bar in terminal frames. */
2821 it
->first_visible_x
= 0;
2822 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2827 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2828 it
->last_visible_x
= (it
->first_visible_x
2829 + window_box_width (w
, TEXT_AREA
));
2831 /* If we truncate lines, leave room for the truncation glyph(s) at
2832 the right margin. Otherwise, leave room for the continuation
2833 glyph(s). Done only if the window has no right fringe. */
2834 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2836 if (it
->line_wrap
== TRUNCATE
)
2837 it
->last_visible_x
-= it
->truncation_pixel_width
;
2839 it
->last_visible_x
-= it
->continuation_pixel_width
;
2842 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2843 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2846 /* Leave room for a border glyph. */
2847 if (!FRAME_WINDOW_P (it
->f
)
2848 && !WINDOW_RIGHTMOST_P (it
->w
))
2849 it
->last_visible_x
-= 1;
2851 it
->last_visible_y
= window_text_bottom_y (w
);
2853 /* For mode lines and alike, arrange for the first glyph having a
2854 left box line if the face specifies a box. */
2855 if (base_face_id
!= DEFAULT_FACE_ID
)
2859 it
->face_id
= remapped_base_face_id
;
2861 /* If we have a boxed mode line, make the first character appear
2862 with a left box line. */
2863 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2864 if (face
&& face
->box
!= FACE_NO_BOX
)
2865 it
->start_of_box_run_p
= true;
2868 /* If a buffer position was specified, set the iterator there,
2869 getting overlays and face properties from that position. */
2870 if (charpos
>= BUF_BEG (current_buffer
))
2872 it
->stop_charpos
= charpos
;
2873 it
->end_charpos
= ZV
;
2874 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2875 IT_CHARPOS (*it
) = charpos
;
2876 IT_BYTEPOS (*it
) = bytepos
;
2878 /* We will rely on `reseat' to set this up properly, via
2879 handle_face_prop. */
2880 it
->face_id
= it
->base_face_id
;
2882 it
->start
= it
->current
;
2883 /* Do we need to reorder bidirectional text? Not if this is a
2884 unibyte buffer: by definition, none of the single-byte
2885 characters are strong R2L, so no reordering is needed. And
2886 bidi.c doesn't support unibyte buffers anyway. Also, don't
2887 reorder while we are loading loadup.el, since the tables of
2888 character properties needed for reordering are not yet
2892 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2895 /* If we are to reorder bidirectional text, init the bidi
2899 /* Since we don't know at this point whether there will be
2900 any R2L lines in the window, we reserve space for
2901 truncation/continuation glyphs even if only the left
2902 fringe is absent. */
2903 if (base_face_id
== DEFAULT_FACE_ID
2904 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2905 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2907 if (it
->line_wrap
== TRUNCATE
)
2908 it
->last_visible_x
-= it
->truncation_pixel_width
;
2910 it
->last_visible_x
-= it
->continuation_pixel_width
;
2912 /* Note the paragraph direction that this buffer wants to
2914 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2916 it
->paragraph_embedding
= L2R
;
2917 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2919 it
->paragraph_embedding
= R2L
;
2921 it
->paragraph_embedding
= NEUTRAL_DIR
;
2922 bidi_unshelve_cache (NULL
, false);
2923 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2927 /* Compute faces etc. */
2928 reseat (it
, it
->current
.pos
, true);
2935 /* Initialize IT for the display of window W with window start POS. */
2938 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2940 struct glyph_row
*row
;
2941 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2943 row
= w
->desired_matrix
->rows
+ first_vpos
;
2944 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2945 it
->first_vpos
= first_vpos
;
2947 /* Don't reseat to previous visible line start if current start
2948 position is in a string or image. */
2949 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2951 int first_y
= it
->current_y
;
2953 /* If window start is not at a line start, skip forward to POS to
2954 get the correct continuation lines width. */
2955 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2956 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2957 if (!start_at_line_beg_p
)
2961 reseat_at_previous_visible_line_start (it
);
2962 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2964 new_x
= it
->current_x
+ it
->pixel_width
;
2966 /* If lines are continued, this line may end in the middle
2967 of a multi-glyph character (e.g. a control character
2968 displayed as \003, or in the middle of an overlay
2969 string). In this case move_it_to above will not have
2970 taken us to the start of the continuation line but to the
2971 end of the continued line. */
2972 if (it
->current_x
> 0
2973 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2974 && (/* And glyph doesn't fit on the line. */
2975 new_x
> it
->last_visible_x
2976 /* Or it fits exactly and we're on a window
2978 || (new_x
== it
->last_visible_x
2979 && FRAME_WINDOW_P (it
->f
)
2980 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2981 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2982 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2984 if ((it
->current
.dpvec_index
>= 0
2985 || it
->current
.overlay_string_index
>= 0)
2986 /* If we are on a newline from a display vector or
2987 overlay string, then we are already at the end of
2988 a screen line; no need to go to the next line in
2989 that case, as this line is not really continued.
2990 (If we do go to the next line, C-e will not DTRT.) */
2993 set_iterator_to_next (it
, true);
2994 move_it_in_display_line_to (it
, -1, -1, 0);
2997 it
->continuation_lines_width
+= it
->current_x
;
2999 /* If the character at POS is displayed via a display
3000 vector, move_it_to above stops at the final glyph of
3001 IT->dpvec. To make the caller redisplay that character
3002 again (a.k.a. start at POS), we need to reset the
3003 dpvec_index to the beginning of IT->dpvec. */
3004 else if (it
->current
.dpvec_index
>= 0)
3005 it
->current
.dpvec_index
= 0;
3007 /* We're starting a new display line, not affected by the
3008 height of the continued line, so clear the appropriate
3009 fields in the iterator structure. */
3010 it
->max_ascent
= it
->max_descent
= 0;
3011 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3013 it
->current_y
= first_y
;
3015 it
->current_x
= it
->hpos
= 0;
3021 /* Return true if POS is a position in ellipses displayed for invisible
3022 text. W is the window we display, for text property lookup. */
3025 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3027 Lisp_Object prop
, window
;
3028 bool ellipses_p
= false;
3029 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3031 /* If POS specifies a position in a display vector, this might
3032 be for an ellipsis displayed for invisible text. We won't
3033 get the iterator set up for delivering that ellipsis unless
3034 we make sure that it gets aware of the invisible text. */
3035 if (pos
->dpvec_index
>= 0
3036 && pos
->overlay_string_index
< 0
3037 && CHARPOS (pos
->string_pos
) < 0
3039 && (XSETWINDOW (window
, w
),
3040 prop
= Fget_char_property (make_number (charpos
),
3041 Qinvisible
, window
),
3042 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3044 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3046 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3053 /* Initialize IT for stepping through current_buffer in window W,
3054 starting at position POS that includes overlay string and display
3055 vector/ control character translation position information. Value
3056 is false if there are overlay strings with newlines at POS. */
3059 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3061 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3063 bool overlay_strings_with_newlines
= false;
3065 /* If POS specifies a position in a display vector, this might
3066 be for an ellipsis displayed for invisible text. We won't
3067 get the iterator set up for delivering that ellipsis unless
3068 we make sure that it gets aware of the invisible text. */
3069 if (in_ellipses_for_invisible_text_p (pos
, w
))
3075 /* Keep in mind: the call to reseat in init_iterator skips invisible
3076 text, so we might end up at a position different from POS. This
3077 is only a problem when POS is a row start after a newline and an
3078 overlay starts there with an after-string, and the overlay has an
3079 invisible property. Since we don't skip invisible text in
3080 display_line and elsewhere immediately after consuming the
3081 newline before the row start, such a POS will not be in a string,
3082 but the call to init_iterator below will move us to the
3084 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3086 /* This only scans the current chunk -- it should scan all chunks.
3087 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3088 to 16 in 22.1 to make this a lesser problem. */
3089 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3091 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3092 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3094 while (s
< e
&& *s
!= '\n')
3099 overlay_strings_with_newlines
= true;
3104 /* If position is within an overlay string, set up IT to the right
3106 if (pos
->overlay_string_index
>= 0)
3110 /* If the first overlay string happens to have a `display'
3111 property for an image, the iterator will be set up for that
3112 image, and we have to undo that setup first before we can
3113 correct the overlay string index. */
3114 if (it
->method
== GET_FROM_IMAGE
)
3117 /* We already have the first chunk of overlay strings in
3118 IT->overlay_strings. Load more until the one for
3119 pos->overlay_string_index is in IT->overlay_strings. */
3120 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3122 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3123 it
->current
.overlay_string_index
= 0;
3126 load_overlay_strings (it
, 0);
3127 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3131 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3132 relative_index
= (it
->current
.overlay_string_index
3133 % OVERLAY_STRING_CHUNK_SIZE
);
3134 it
->string
= it
->overlay_strings
[relative_index
];
3135 eassert (STRINGP (it
->string
));
3136 it
->current
.string_pos
= pos
->string_pos
;
3137 it
->method
= GET_FROM_STRING
;
3138 it
->end_charpos
= SCHARS (it
->string
);
3139 /* Set up the bidi iterator for this overlay string. */
3142 it
->bidi_it
.string
.lstring
= it
->string
;
3143 it
->bidi_it
.string
.s
= NULL
;
3144 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3145 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3146 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3147 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3148 it
->bidi_it
.w
= it
->w
;
3149 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3150 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3152 /* Synchronize the state of the bidi iterator with
3153 pos->string_pos. For any string position other than
3154 zero, this will be done automagically when we resume
3155 iteration over the string and get_visually_first_element
3156 is called. But if string_pos is zero, and the string is
3157 to be reordered for display, we need to resync manually,
3158 since it could be that the iteration state recorded in
3159 pos ended at string_pos of 0 moving backwards in string. */
3160 if (CHARPOS (pos
->string_pos
) == 0)
3162 get_visually_first_element (it
);
3163 if (IT_STRING_CHARPOS (*it
) != 0)
3166 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3167 bidi_move_to_visually_next (&it
->bidi_it
);
3168 } while (it
->bidi_it
.charpos
!= 0);
3170 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3171 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3175 if (CHARPOS (pos
->string_pos
) >= 0)
3177 /* Recorded position is not in an overlay string, but in another
3178 string. This can only be a string from a `display' property.
3179 IT should already be filled with that string. */
3180 it
->current
.string_pos
= pos
->string_pos
;
3181 eassert (STRINGP (it
->string
));
3183 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3184 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3187 /* Restore position in display vector translations, control
3188 character translations or ellipses. */
3189 if (pos
->dpvec_index
>= 0)
3191 if (it
->dpvec
== NULL
)
3192 get_next_display_element (it
);
3193 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3194 it
->current
.dpvec_index
= pos
->dpvec_index
;
3198 return !overlay_strings_with_newlines
;
3202 /* Initialize IT for stepping through current_buffer in window W
3203 starting at ROW->start. */
3206 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3208 init_from_display_pos (it
, w
, &row
->start
);
3209 it
->start
= row
->start
;
3210 it
->continuation_lines_width
= row
->continuation_lines_width
;
3215 /* Initialize IT for stepping through current_buffer in window W
3216 starting in the line following ROW, i.e. starting at ROW->end.
3217 Value is false if there are overlay strings with newlines at ROW's
3221 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3223 bool success
= false;
3225 if (init_from_display_pos (it
, w
, &row
->end
))
3227 if (row
->continued_p
)
3228 it
->continuation_lines_width
3229 = row
->continuation_lines_width
+ row
->pixel_width
;
3240 /***********************************************************************
3242 ***********************************************************************/
3244 /* Called when IT reaches IT->stop_charpos. Handle text property and
3245 overlay changes. Set IT->stop_charpos to the next position where
3249 handle_stop (struct it
*it
)
3251 enum prop_handled handled
;
3252 bool handle_overlay_change_p
;
3256 it
->current
.dpvec_index
= -1;
3257 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3258 it
->ellipsis_p
= false;
3260 /* Use face of preceding text for ellipsis (if invisible) */
3261 if (it
->selective_display_ellipsis_p
)
3262 it
->saved_face_id
= it
->face_id
;
3264 /* Here's the description of the semantics of, and the logic behind,
3265 the various HANDLED_* statuses:
3267 HANDLED_NORMALLY means the handler did its job, and the loop
3268 should proceed to calling the next handler in order.
3270 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3271 change in the properties and overlays at current position, so the
3272 loop should be restarted, to re-invoke the handlers that were
3273 already called. This happens when fontification-functions were
3274 called by handle_fontified_prop, and actually fontified
3275 something. Another case where HANDLED_RECOMPUTE_PROPS is
3276 returned is when we discover overlay strings that need to be
3277 displayed right away. The loop below will continue for as long
3278 as the status is HANDLED_RECOMPUTE_PROPS.
3280 HANDLED_RETURN means return immediately to the caller, to
3281 continue iteration without calling any further handlers. This is
3282 used when we need to act on some property right away, for example
3283 when we need to display the ellipsis or a replacing display
3284 property, such as display string or image.
3286 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3287 consumed, and the handler switched to the next overlay string.
3288 This signals the loop below to refrain from looking for more
3289 overlays before all the overlay strings of the current overlay
3292 Some of the handlers called by the loop push the iterator state
3293 onto the stack (see 'push_it'), and arrange for the iteration to
3294 continue with another object, such as an image, a display string,
3295 or an overlay string. In most such cases, it->stop_charpos is
3296 set to the first character of the string, so that when the
3297 iteration resumes, this function will immediately be called
3298 again, to examine the properties at the beginning of the string.
3300 When a display or overlay string is exhausted, the iterator state
3301 is popped (see 'pop_it'), and iteration continues with the
3302 previous object. Again, in many such cases this function is
3303 called again to find the next position where properties might
3308 handled
= HANDLED_NORMALLY
;
3310 /* Call text property handlers. */
3311 for (p
= it_props
; p
->handler
; ++p
)
3313 handled
= p
->handler (it
);
3315 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3317 else if (handled
== HANDLED_RETURN
)
3319 /* We still want to show before and after strings from
3320 overlays even if the actual buffer text is replaced. */
3321 if (!handle_overlay_change_p
3323 /* Don't call get_overlay_strings_1 if we already
3324 have overlay strings loaded, because doing so
3325 will load them again and push the iterator state
3326 onto the stack one more time, which is not
3327 expected by the rest of the code that processes
3329 || (it
->current
.overlay_string_index
< 0
3330 && !get_overlay_strings_1 (it
, 0, false)))
3333 setup_for_ellipsis (it
, 0);
3334 /* When handling a display spec, we might load an
3335 empty string. In that case, discard it here. We
3336 used to discard it in handle_single_display_spec,
3337 but that causes get_overlay_strings_1, above, to
3338 ignore overlay strings that we must check. */
3339 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3343 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3347 it
->string_from_display_prop_p
= false;
3348 it
->from_disp_prop_p
= false;
3349 handle_overlay_change_p
= false;
3351 handled
= HANDLED_RECOMPUTE_PROPS
;
3354 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3355 handle_overlay_change_p
= false;
3358 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3360 /* Don't check for overlay strings below when set to deliver
3361 characters from a display vector. */
3362 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3363 handle_overlay_change_p
= false;
3365 /* Handle overlay changes.
3366 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3367 if it finds overlays. */
3368 if (handle_overlay_change_p
)
3369 handled
= handle_overlay_change (it
);
3374 setup_for_ellipsis (it
, 0);
3378 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3380 /* Determine where to stop next. */
3381 if (handled
== HANDLED_NORMALLY
)
3382 compute_stop_pos (it
);
3386 /* Compute IT->stop_charpos from text property and overlay change
3387 information for IT's current position. */
3390 compute_stop_pos (struct it
*it
)
3392 register INTERVAL iv
, next_iv
;
3393 Lisp_Object object
, limit
, position
;
3394 ptrdiff_t charpos
, bytepos
;
3396 if (STRINGP (it
->string
))
3398 /* Strings are usually short, so don't limit the search for
3400 it
->stop_charpos
= it
->end_charpos
;
3401 object
= it
->string
;
3403 charpos
= IT_STRING_CHARPOS (*it
);
3404 bytepos
= IT_STRING_BYTEPOS (*it
);
3410 /* If end_charpos is out of range for some reason, such as a
3411 misbehaving display function, rationalize it (Bug#5984). */
3412 if (it
->end_charpos
> ZV
)
3413 it
->end_charpos
= ZV
;
3414 it
->stop_charpos
= it
->end_charpos
;
3416 /* If next overlay change is in front of the current stop pos
3417 (which is IT->end_charpos), stop there. Note: value of
3418 next_overlay_change is point-max if no overlay change
3420 charpos
= IT_CHARPOS (*it
);
3421 bytepos
= IT_BYTEPOS (*it
);
3422 pos
= next_overlay_change (charpos
);
3423 if (pos
< it
->stop_charpos
)
3424 it
->stop_charpos
= pos
;
3426 /* Set up variables for computing the stop position from text
3427 property changes. */
3428 XSETBUFFER (object
, current_buffer
);
3429 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3432 /* Get the interval containing IT's position. Value is a null
3433 interval if there isn't such an interval. */
3434 position
= make_number (charpos
);
3435 iv
= validate_interval_range (object
, &position
, &position
, false);
3438 Lisp_Object values_here
[LAST_PROP_IDX
];
3441 /* Get properties here. */
3442 for (p
= it_props
; p
->handler
; ++p
)
3443 values_here
[p
->idx
] = textget (iv
->plist
,
3444 builtin_lisp_symbol (p
->name
));
3446 /* Look for an interval following iv that has different
3448 for (next_iv
= next_interval (iv
);
3451 || XFASTINT (limit
) > next_iv
->position
));
3452 next_iv
= next_interval (next_iv
))
3454 for (p
= it_props
; p
->handler
; ++p
)
3456 Lisp_Object new_value
= textget (next_iv
->plist
,
3457 builtin_lisp_symbol (p
->name
));
3458 if (!EQ (values_here
[p
->idx
], new_value
))
3468 if (INTEGERP (limit
)
3469 && next_iv
->position
>= XFASTINT (limit
))
3470 /* No text property change up to limit. */
3471 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3473 /* Text properties change in next_iv. */
3474 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3478 if (it
->cmp_it
.id
< 0)
3480 ptrdiff_t stoppos
= it
->end_charpos
;
3482 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3484 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3485 stoppos
, it
->string
);
3488 eassert (STRINGP (it
->string
)
3489 || (it
->stop_charpos
>= BEGV
3490 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3494 /* Return the position of the next overlay change after POS in
3495 current_buffer. Value is point-max if no overlay change
3496 follows. This is like `next-overlay-change' but doesn't use
3500 next_overlay_change (ptrdiff_t pos
)
3502 ptrdiff_t i
, noverlays
;
3504 Lisp_Object
*overlays
;
3507 /* Get all overlays at the given position. */
3508 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3510 /* If any of these overlays ends before endpos,
3511 use its ending point instead. */
3512 for (i
= 0; i
< noverlays
; ++i
)
3517 oend
= OVERLAY_END (overlays
[i
]);
3518 oendpos
= OVERLAY_POSITION (oend
);
3519 endpos
= min (endpos
, oendpos
);
3526 /* How many characters forward to search for a display property or
3527 display string. Searching too far forward makes the bidi display
3528 sluggish, especially in small windows. */
3529 #define MAX_DISP_SCAN 250
3531 /* Return the character position of a display string at or after
3532 position specified by POSITION. If no display string exists at or
3533 after POSITION, return ZV. A display string is either an overlay
3534 with `display' property whose value is a string, or a `display'
3535 text property whose value is a string. STRING is data about the
3536 string to iterate; if STRING->lstring is nil, we are iterating a
3537 buffer. FRAME_WINDOW_P is true when we are displaying a window
3538 on a GUI frame. DISP_PROP is set to zero if we searched
3539 MAX_DISP_SCAN characters forward without finding any display
3540 strings, non-zero otherwise. It is set to 2 if the display string
3541 uses any kind of `(space ...)' spec that will produce a stretch of
3542 white space in the text area. */
3544 compute_display_string_pos (struct text_pos
*position
,
3545 struct bidi_string_data
*string
,
3547 bool frame_window_p
, int *disp_prop
)
3549 /* OBJECT = nil means current buffer. */
3550 Lisp_Object object
, object1
;
3551 Lisp_Object pos
, spec
, limpos
;
3552 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3553 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3554 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3555 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3557 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3558 struct text_pos tpos
;
3561 if (string
&& STRINGP (string
->lstring
))
3562 object1
= object
= string
->lstring
;
3563 else if (w
&& !string_p
)
3565 XSETWINDOW (object
, w
);
3569 object1
= object
= Qnil
;
3574 /* We don't support display properties whose values are strings
3575 that have display string properties. */
3576 || string
->from_disp_str
3577 /* C strings cannot have display properties. */
3578 || (string
->s
&& !STRINGP (object
)))
3584 /* If the character at CHARPOS is where the display string begins,
3586 pos
= make_number (charpos
);
3587 if (STRINGP (object
))
3588 bufpos
= string
->bufpos
;
3592 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3594 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3597 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3605 /* Look forward for the first character with a `display' property
3606 that will replace the underlying text when displayed. */
3607 limpos
= make_number (lim
);
3609 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3610 CHARPOS (tpos
) = XFASTINT (pos
);
3611 if (CHARPOS (tpos
) >= lim
)
3616 if (STRINGP (object
))
3617 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3619 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3620 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3621 if (!STRINGP (object
))
3622 bufpos
= CHARPOS (tpos
);
3623 } while (NILP (spec
)
3624 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3625 bufpos
, frame_window_p
)));
3629 return CHARPOS (tpos
);
3632 /* Return the character position of the end of the display string that
3633 started at CHARPOS. If there's no display string at CHARPOS,
3634 return -1. A display string is either an overlay with `display'
3635 property whose value is a string or a `display' text property whose
3636 value is a string. */
3638 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3640 /* OBJECT = nil means current buffer. */
3641 Lisp_Object object
=
3642 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3643 Lisp_Object pos
= make_number (charpos
);
3645 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3647 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3650 /* It could happen that the display property or overlay was removed
3651 since we found it in compute_display_string_pos above. One way
3652 this can happen is if JIT font-lock was called (through
3653 handle_fontified_prop), and jit-lock-functions remove text
3654 properties or overlays from the portion of buffer that includes
3655 CHARPOS. Muse mode is known to do that, for example. In this
3656 case, we return -1 to the caller, to signal that no display
3657 string is actually present at CHARPOS. See bidi_fetch_char for
3658 how this is handled.
3660 An alternative would be to never look for display properties past
3661 it->stop_charpos. But neither compute_display_string_pos nor
3662 bidi_fetch_char that calls it know or care where the next
3664 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3667 /* Look forward for the first character where the `display' property
3669 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3671 return XFASTINT (pos
);
3676 /***********************************************************************
3678 ***********************************************************************/
3680 /* Handle changes in the `fontified' property of the current buffer by
3681 calling hook functions from Qfontification_functions to fontify
3684 static enum prop_handled
3685 handle_fontified_prop (struct it
*it
)
3687 Lisp_Object prop
, pos
;
3688 enum prop_handled handled
= HANDLED_NORMALLY
;
3690 if (!NILP (Vmemory_full
))
3693 /* Get the value of the `fontified' property at IT's current buffer
3694 position. (The `fontified' property doesn't have a special
3695 meaning in strings.) If the value is nil, call functions from
3696 Qfontification_functions. */
3697 if (!STRINGP (it
->string
)
3699 && !NILP (Vfontification_functions
)
3700 && !NILP (Vrun_hooks
)
3701 && (pos
= make_number (IT_CHARPOS (*it
)),
3702 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3703 /* Ignore the special cased nil value always present at EOB since
3704 no amount of fontifying will be able to change it. */
3705 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3707 ptrdiff_t count
= SPECPDL_INDEX ();
3709 struct buffer
*obuf
= current_buffer
;
3710 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3711 bool old_clip_changed
= current_buffer
->clip_changed
;
3713 val
= Vfontification_functions
;
3714 specbind (Qfontification_functions
, Qnil
);
3716 eassert (it
->end_charpos
== ZV
);
3718 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3719 safe_call1 (val
, pos
);
3722 Lisp_Object fns
, fn
;
3723 struct gcpro gcpro1
, gcpro2
;
3728 for (; CONSP (val
); val
= XCDR (val
))
3734 /* A value of t indicates this hook has a local
3735 binding; it means to run the global binding too.
3736 In a global value, t should not occur. If it
3737 does, we must ignore it to avoid an endless
3739 for (fns
= Fdefault_value (Qfontification_functions
);
3745 safe_call1 (fn
, pos
);
3749 safe_call1 (fn
, pos
);
3755 unbind_to (count
, Qnil
);
3757 /* Fontification functions routinely call `save-restriction'.
3758 Normally, this tags clip_changed, which can confuse redisplay
3759 (see discussion in Bug#6671). Since we don't perform any
3760 special handling of fontification changes in the case where
3761 `save-restriction' isn't called, there's no point doing so in
3762 this case either. So, if the buffer's restrictions are
3763 actually left unchanged, reset clip_changed. */
3764 if (obuf
== current_buffer
)
3766 if (begv
== BEGV
&& zv
== ZV
)
3767 current_buffer
->clip_changed
= old_clip_changed
;
3769 /* There isn't much we can reasonably do to protect against
3770 misbehaving fontification, but here's a fig leaf. */
3771 else if (BUFFER_LIVE_P (obuf
))
3772 set_buffer_internal_1 (obuf
);
3774 /* The fontification code may have added/removed text.
3775 It could do even a lot worse, but let's at least protect against
3776 the most obvious case where only the text past `pos' gets changed',
3777 as is/was done in grep.el where some escapes sequences are turned
3778 into face properties (bug#7876). */
3779 it
->end_charpos
= ZV
;
3781 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3782 something. This avoids an endless loop if they failed to
3783 fontify the text for which reason ever. */
3784 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3785 handled
= HANDLED_RECOMPUTE_PROPS
;
3793 /***********************************************************************
3795 ***********************************************************************/
3797 /* Set up iterator IT from face properties at its current position.
3798 Called from handle_stop. */
3800 static enum prop_handled
3801 handle_face_prop (struct it
*it
)
3804 ptrdiff_t next_stop
;
3806 if (!STRINGP (it
->string
))
3809 = face_at_buffer_position (it
->w
,
3813 + TEXT_PROP_DISTANCE_LIMIT
),
3814 false, it
->base_face_id
);
3816 /* Is this a start of a run of characters with box face?
3817 Caveat: this can be called for a freshly initialized
3818 iterator; face_id is -1 in this case. We know that the new
3819 face will not change until limit, i.e. if the new face has a
3820 box, all characters up to limit will have one. But, as
3821 usual, we don't know whether limit is really the end. */
3822 if (new_face_id
!= it
->face_id
)
3824 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3825 /* If it->face_id is -1, old_face below will be NULL, see
3826 the definition of FACE_FROM_ID. This will happen if this
3827 is the initial call that gets the face. */
3828 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3830 /* If the value of face_id of the iterator is -1, we have to
3831 look in front of IT's position and see whether there is a
3832 face there that's different from new_face_id. */
3833 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3835 int prev_face_id
= face_before_it_pos (it
);
3837 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3840 /* If the new face has a box, but the old face does not,
3841 this is the start of a run of characters with box face,
3842 i.e. this character has a shadow on the left side. */
3843 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3844 && (old_face
== NULL
|| !old_face
->box
));
3845 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3853 Lisp_Object from_overlay
3854 = (it
->current
.overlay_string_index
>= 0
3855 ? it
->string_overlays
[it
->current
.overlay_string_index
3856 % OVERLAY_STRING_CHUNK_SIZE
]
3859 /* See if we got to this string directly or indirectly from
3860 an overlay property. That includes the before-string or
3861 after-string of an overlay, strings in display properties
3862 provided by an overlay, their text properties, etc.
3864 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3865 if (! NILP (from_overlay
))
3866 for (i
= it
->sp
- 1; i
>= 0; i
--)
3868 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3870 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3871 % OVERLAY_STRING_CHUNK_SIZE
];
3872 else if (! NILP (it
->stack
[i
].from_overlay
))
3873 from_overlay
= it
->stack
[i
].from_overlay
;
3875 if (!NILP (from_overlay
))
3879 if (! NILP (from_overlay
))
3881 bufpos
= IT_CHARPOS (*it
);
3882 /* For a string from an overlay, the base face depends
3883 only on text properties and ignores overlays. */
3885 = face_for_overlay_string (it
->w
,
3889 + TEXT_PROP_DISTANCE_LIMIT
),
3897 /* For strings from a `display' property, use the face at
3898 IT's current buffer position as the base face to merge
3899 with, so that overlay strings appear in the same face as
3900 surrounding text, unless they specify their own faces.
3901 For strings from wrap-prefix and line-prefix properties,
3902 use the default face, possibly remapped via
3903 Vface_remapping_alist. */
3904 /* Note that the fact that we use the face at _buffer_
3905 position means that a 'display' property on an overlay
3906 string will not inherit the face of that overlay string,
3907 but will instead revert to the face of buffer text
3908 covered by the overlay. This is visible, e.g., when the
3909 overlay specifies a box face, but neither the buffer nor
3910 the display string do. This sounds like a design bug,
3911 but Emacs always did that since v21.1, so changing that
3912 might be a big deal. */
3913 base_face_id
= it
->string_from_prefix_prop_p
3914 ? (!NILP (Vface_remapping_alist
)
3915 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3917 : underlying_face_id (it
);
3920 new_face_id
= face_at_string_position (it
->w
,
3922 IT_STRING_CHARPOS (*it
),
3925 base_face_id
, false);
3927 /* Is this a start of a run of characters with box? Caveat:
3928 this can be called for a freshly allocated iterator; face_id
3929 is -1 is this case. We know that the new face will not
3930 change until the next check pos, i.e. if the new face has a
3931 box, all characters up to that position will have a
3932 box. But, as usual, we don't know whether that position
3933 is really the end. */
3934 if (new_face_id
!= it
->face_id
)
3936 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3937 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3939 /* If new face has a box but old face hasn't, this is the
3940 start of a run of characters with box, i.e. it has a
3941 shadow on the left side. */
3942 it
->start_of_box_run_p
3943 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3944 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3948 it
->face_id
= new_face_id
;
3949 return HANDLED_NORMALLY
;
3953 /* Return the ID of the face ``underlying'' IT's current position,
3954 which is in a string. If the iterator is associated with a
3955 buffer, return the face at IT's current buffer position.
3956 Otherwise, use the iterator's base_face_id. */
3959 underlying_face_id (struct it
*it
)
3961 int face_id
= it
->base_face_id
, i
;
3963 eassert (STRINGP (it
->string
));
3965 for (i
= it
->sp
- 1; i
>= 0; --i
)
3966 if (NILP (it
->stack
[i
].string
))
3967 face_id
= it
->stack
[i
].face_id
;
3973 /* Compute the face one character before or after the current position
3974 of IT, in the visual order. BEFORE_P means get the face
3975 in front (to the left in L2R paragraphs, to the right in R2L
3976 paragraphs) of IT's screen position. Value is the ID of the face. */
3979 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3982 ptrdiff_t next_check_charpos
;
3984 void *it_copy_data
= NULL
;
3986 eassert (it
->s
== NULL
);
3988 if (STRINGP (it
->string
))
3990 ptrdiff_t bufpos
, charpos
;
3993 /* No face change past the end of the string (for the case
3994 we are padding with spaces). No face change before the
3996 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3997 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4002 /* Set charpos to the position before or after IT's current
4003 position, in the logical order, which in the non-bidi
4004 case is the same as the visual order. */
4006 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4007 else if (it
->what
== IT_COMPOSITION
)
4008 /* For composition, we must check the character after the
4010 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4012 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4018 /* With bidi iteration, the character before the current
4019 in the visual order cannot be found by simple
4020 iteration, because "reverse" reordering is not
4021 supported. Instead, we need to use the move_it_*
4022 family of functions. */
4023 /* Ignore face changes before the first visible
4024 character on this display line. */
4025 if (it
->current_x
<= it
->first_visible_x
)
4027 SAVE_IT (it_copy
, *it
, it_copy_data
);
4028 /* Implementation note: Since move_it_in_display_line
4029 works in the iterator geometry, and thinks the first
4030 character is always the leftmost, even in R2L lines,
4031 we don't need to distinguish between the R2L and L2R
4033 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4034 it_copy
.current_x
- 1, MOVE_TO_X
);
4035 charpos
= IT_STRING_CHARPOS (it_copy
);
4036 RESTORE_IT (it
, it
, it_copy_data
);
4040 /* Set charpos to the string position of the character
4041 that comes after IT's current position in the visual
4043 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4047 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4049 charpos
= it_copy
.bidi_it
.charpos
;
4052 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4054 if (it
->current
.overlay_string_index
>= 0)
4055 bufpos
= IT_CHARPOS (*it
);
4059 base_face_id
= underlying_face_id (it
);
4061 /* Get the face for ASCII, or unibyte. */
4062 face_id
= face_at_string_position (it
->w
,
4066 &next_check_charpos
,
4067 base_face_id
, false);
4069 /* Correct the face for charsets different from ASCII. Do it
4070 for the multibyte case only. The face returned above is
4071 suitable for unibyte text if IT->string is unibyte. */
4072 if (STRING_MULTIBYTE (it
->string
))
4074 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4075 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4077 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4079 c
= string_char_and_length (p
, &len
);
4080 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4085 struct text_pos pos
;
4087 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4088 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4091 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4092 pos
= it
->current
.pos
;
4097 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4100 if (it
->what
== IT_COMPOSITION
)
4102 /* For composition, we must check the position after
4104 pos
.charpos
+= it
->cmp_it
.nchars
;
4105 pos
.bytepos
+= it
->len
;
4108 INC_TEXT_POS (pos
, it
->multibyte_p
);
4115 /* With bidi iteration, the character before the current
4116 in the visual order cannot be found by simple
4117 iteration, because "reverse" reordering is not
4118 supported. Instead, we need to use the move_it_*
4119 family of functions. */
4120 /* Ignore face changes before the first visible
4121 character on this display line. */
4122 if (it
->current_x
<= it
->first_visible_x
)
4124 SAVE_IT (it_copy
, *it
, it_copy_data
);
4125 /* Implementation note: Since move_it_in_display_line
4126 works in the iterator geometry, and thinks the first
4127 character is always the leftmost, even in R2L lines,
4128 we don't need to distinguish between the R2L and L2R
4130 move_it_in_display_line (&it_copy
, ZV
,
4131 it_copy
.current_x
- 1, MOVE_TO_X
);
4132 pos
= it_copy
.current
.pos
;
4133 RESTORE_IT (it
, it
, it_copy_data
);
4137 /* Set charpos to the buffer position of the character
4138 that comes after IT's current position in the visual
4140 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4144 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4147 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4150 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4152 /* Determine face for CHARSET_ASCII, or unibyte. */
4153 face_id
= face_at_buffer_position (it
->w
,
4155 &next_check_charpos
,
4158 /* Correct the face for charsets different from ASCII. Do it
4159 for the multibyte case only. The face returned above is
4160 suitable for unibyte text if current_buffer is unibyte. */
4161 if (it
->multibyte_p
)
4163 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4164 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4165 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4174 /***********************************************************************
4176 ***********************************************************************/
4178 /* Set up iterator IT from invisible properties at its current
4179 position. Called from handle_stop. */
4181 static enum prop_handled
4182 handle_invisible_prop (struct it
*it
)
4184 enum prop_handled handled
= HANDLED_NORMALLY
;
4188 if (STRINGP (it
->string
))
4190 Lisp_Object end_charpos
, limit
;
4192 /* Get the value of the invisible text property at the
4193 current position. Value will be nil if there is no such
4195 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4196 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4197 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4199 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4201 /* Record whether we have to display an ellipsis for the
4203 bool display_ellipsis_p
= (invis
== 2);
4204 ptrdiff_t len
, endpos
;
4206 handled
= HANDLED_RECOMPUTE_PROPS
;
4208 /* Get the position at which the next visible text can be
4209 found in IT->string, if any. */
4210 endpos
= len
= SCHARS (it
->string
);
4211 XSETINT (limit
, len
);
4215 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4217 /* Since LIMIT is always an integer, so should be the
4218 value returned by Fnext_single_property_change. */
4219 eassert (INTEGERP (end_charpos
));
4220 if (INTEGERP (end_charpos
))
4222 endpos
= XFASTINT (end_charpos
);
4223 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4224 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4226 display_ellipsis_p
= true;
4228 else /* Should never happen; but if it does, exit the loop. */
4231 while (invis
!= 0 && endpos
< len
);
4233 if (display_ellipsis_p
)
4234 it
->ellipsis_p
= true;
4238 /* Text at END_CHARPOS is visible. Move IT there. */
4239 struct text_pos old
;
4242 old
= it
->current
.string_pos
;
4243 oldpos
= CHARPOS (old
);
4246 if (it
->bidi_it
.first_elt
4247 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4248 bidi_paragraph_init (it
->paragraph_embedding
,
4249 &it
->bidi_it
, true);
4250 /* Bidi-iterate out of the invisible text. */
4253 bidi_move_to_visually_next (&it
->bidi_it
);
4255 while (oldpos
<= it
->bidi_it
.charpos
4256 && it
->bidi_it
.charpos
< endpos
);
4258 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4259 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4260 if (IT_CHARPOS (*it
) >= endpos
)
4261 it
->prev_stop
= endpos
;
4265 IT_STRING_CHARPOS (*it
) = endpos
;
4266 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4271 /* The rest of the string is invisible. If this is an
4272 overlay string, proceed with the next overlay string
4273 or whatever comes and return a character from there. */
4274 if (it
->current
.overlay_string_index
>= 0
4275 && !display_ellipsis_p
)
4277 next_overlay_string (it
);
4278 /* Don't check for overlay strings when we just
4279 finished processing them. */
4280 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4284 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4285 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4292 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4293 Lisp_Object pos
, overlay
;
4295 /* First of all, is there invisible text at this position? */
4296 tem
= start_charpos
= IT_CHARPOS (*it
);
4297 pos
= make_number (tem
);
4298 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4300 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4302 /* If we are on invisible text, skip over it. */
4303 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4305 /* Record whether we have to display an ellipsis for the
4307 bool display_ellipsis_p
= invis
== 2;
4309 handled
= HANDLED_RECOMPUTE_PROPS
;
4311 /* Loop skipping over invisible text. The loop is left at
4312 ZV or with IT on the first char being visible again. */
4315 /* Try to skip some invisible text. Return value is the
4316 position reached which can be equal to where we start
4317 if there is nothing invisible there. This skips both
4318 over invisible text properties and overlays with
4319 invisible property. */
4320 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4322 /* If we skipped nothing at all we weren't at invisible
4323 text in the first place. If everything to the end of
4324 the buffer was skipped, end the loop. */
4325 if (newpos
== tem
|| newpos
>= ZV
)
4329 /* We skipped some characters but not necessarily
4330 all there are. Check if we ended up on visible
4331 text. Fget_char_property returns the property of
4332 the char before the given position, i.e. if we
4333 get invis = 0, this means that the char at
4334 newpos is visible. */
4335 pos
= make_number (newpos
);
4336 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4337 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4340 /* If we ended up on invisible text, proceed to
4341 skip starting with next_stop. */
4345 /* If there are adjacent invisible texts, don't lose the
4346 second one's ellipsis. */
4348 display_ellipsis_p
= true;
4352 /* The position newpos is now either ZV or on visible text. */
4355 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4357 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4359 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4361 /* If the invisible text ends on a newline or on a
4362 character after a newline, we can avoid the costly,
4363 character by character, bidi iteration to NEWPOS, and
4364 instead simply reseat the iterator there. That's
4365 because all bidi reordering information is tossed at
4366 the newline. This is a big win for modes that hide
4367 complete lines, like Outline, Org, etc. */
4368 if (on_newline
|| after_newline
)
4370 struct text_pos tpos
;
4371 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4373 SET_TEXT_POS (tpos
, newpos
, bpos
);
4374 reseat_1 (it
, tpos
, false);
4375 /* If we reseat on a newline/ZV, we need to prep the
4376 bidi iterator for advancing to the next character
4377 after the newline/EOB, keeping the current paragraph
4378 direction (so that PRODUCE_GLYPHS does TRT wrt
4379 prepending/appending glyphs to a glyph row). */
4382 it
->bidi_it
.first_elt
= false;
4383 it
->bidi_it
.paragraph_dir
= pdir
;
4384 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4385 it
->bidi_it
.nchars
= 1;
4386 it
->bidi_it
.ch_len
= 1;
4389 else /* Must use the slow method. */
4391 /* With bidi iteration, the region of invisible text
4392 could start and/or end in the middle of a
4393 non-base embedding level. Therefore, we need to
4394 skip invisible text using the bidi iterator,
4395 starting at IT's current position, until we find
4396 ourselves outside of the invisible text.
4397 Skipping invisible text _after_ bidi iteration
4398 avoids affecting the visual order of the
4399 displayed text when invisible properties are
4400 added or removed. */
4401 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4403 /* If we were `reseat'ed to a new paragraph,
4404 determine the paragraph base direction. We
4405 need to do it now because
4406 next_element_from_buffer may not have a
4407 chance to do it, if we are going to skip any
4408 text at the beginning, which resets the
4410 bidi_paragraph_init (it
->paragraph_embedding
,
4411 &it
->bidi_it
, true);
4415 bidi_move_to_visually_next (&it
->bidi_it
);
4417 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4418 && it
->bidi_it
.charpos
< newpos
);
4419 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4420 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4421 /* If we overstepped NEWPOS, record its position in
4422 the iterator, so that we skip invisible text if
4423 later the bidi iteration lands us in the
4424 invisible region again. */
4425 if (IT_CHARPOS (*it
) >= newpos
)
4426 it
->prev_stop
= newpos
;
4431 IT_CHARPOS (*it
) = newpos
;
4432 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4435 if (display_ellipsis_p
)
4437 /* Make sure that the glyphs of the ellipsis will get
4438 correct `charpos' values. If we would not update
4439 it->position here, the glyphs would belong to the
4440 last visible character _before_ the invisible
4441 text, which confuses `set_cursor_from_row'.
4443 We use the last invisible position instead of the
4444 first because this way the cursor is always drawn on
4445 the first "." of the ellipsis, whenever PT is inside
4446 the invisible text. Otherwise the cursor would be
4447 placed _after_ the ellipsis when the point is after the
4448 first invisible character. */
4449 if (!STRINGP (it
->object
))
4451 it
->position
.charpos
= newpos
- 1;
4452 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4456 /* If there are before-strings at the start of invisible
4457 text, and the text is invisible because of a text
4458 property, arrange to show before-strings because 20.x did
4459 it that way. (If the text is invisible because of an
4460 overlay property instead of a text property, this is
4461 already handled in the overlay code.) */
4463 && get_overlay_strings (it
, it
->stop_charpos
))
4465 handled
= HANDLED_RECOMPUTE_PROPS
;
4468 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4469 /* The call to get_overlay_strings above recomputes
4470 it->stop_charpos, but it only considers changes
4471 in properties and overlays beyond iterator's
4472 current position. This causes us to miss changes
4473 that happen exactly where the invisible property
4474 ended. So we play it safe here and force the
4475 iterator to check for potential stop positions
4476 immediately after the invisible text. Note that
4477 if get_overlay_strings returns true, it
4478 normally also pushed the iterator stack, so we
4479 need to update the stop position in the slot
4480 below the current one. */
4481 it
->stack
[it
->sp
- 1].stop_charpos
4482 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4485 else if (display_ellipsis_p
)
4487 it
->ellipsis_p
= true;
4488 /* Let the ellipsis display before
4489 considering any properties of the following char.
4490 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4491 handled
= HANDLED_RETURN
;
4500 /* Make iterator IT return `...' next.
4501 Replaces LEN characters from buffer. */
4504 setup_for_ellipsis (struct it
*it
, int len
)
4506 /* Use the display table definition for `...'. Invalid glyphs
4507 will be handled by the method returning elements from dpvec. */
4508 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4510 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4511 it
->dpvec
= v
->contents
;
4512 it
->dpend
= v
->contents
+ v
->header
.size
;
4516 /* Default `...'. */
4517 it
->dpvec
= default_invis_vector
;
4518 it
->dpend
= default_invis_vector
+ 3;
4521 it
->dpvec_char_len
= len
;
4522 it
->current
.dpvec_index
= 0;
4523 it
->dpvec_face_id
= -1;
4525 /* Remember the current face id in case glyphs specify faces.
4526 IT's face is restored in set_iterator_to_next.
4527 saved_face_id was set to preceding char's face in handle_stop. */
4528 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4529 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4531 /* If the ellipsis represents buffer text, it means we advanced in
4532 the buffer, so we should no longer ignore overlay strings. */
4533 if (it
->method
== GET_FROM_BUFFER
)
4534 it
->ignore_overlay_strings_at_pos_p
= false;
4536 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4537 it
->ellipsis_p
= true;
4542 /***********************************************************************
4544 ***********************************************************************/
4546 /* Set up iterator IT from `display' property at its current position.
4547 Called from handle_stop.
4548 We return HANDLED_RETURN if some part of the display property
4549 overrides the display of the buffer text itself.
4550 Otherwise we return HANDLED_NORMALLY. */
4552 static enum prop_handled
4553 handle_display_prop (struct it
*it
)
4555 Lisp_Object propval
, object
, overlay
;
4556 struct text_pos
*position
;
4558 /* Nonzero if some property replaces the display of the text itself. */
4559 int display_replaced
= 0;
4561 if (STRINGP (it
->string
))
4563 object
= it
->string
;
4564 position
= &it
->current
.string_pos
;
4565 bufpos
= CHARPOS (it
->current
.pos
);
4569 XSETWINDOW (object
, it
->w
);
4570 position
= &it
->current
.pos
;
4571 bufpos
= CHARPOS (*position
);
4574 /* Reset those iterator values set from display property values. */
4575 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4576 it
->space_width
= Qnil
;
4577 it
->font_height
= Qnil
;
4580 /* We don't support recursive `display' properties, i.e. string
4581 values that have a string `display' property, that have a string
4582 `display' property etc. */
4583 if (!it
->string_from_display_prop_p
)
4584 it
->area
= TEXT_AREA
;
4586 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4587 Qdisplay
, object
, &overlay
);
4589 return HANDLED_NORMALLY
;
4590 /* Now OVERLAY is the overlay that gave us this property, or nil
4591 if it was a text property. */
4593 if (!STRINGP (it
->string
))
4594 object
= it
->w
->contents
;
4596 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4598 FRAME_WINDOW_P (it
->f
));
4599 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4602 /* Subroutine of handle_display_prop. Returns non-zero if the display
4603 specification in SPEC is a replacing specification, i.e. it would
4604 replace the text covered by `display' property with something else,
4605 such as an image or a display string. If SPEC includes any kind or
4606 `(space ...) specification, the value is 2; this is used by
4607 compute_display_string_pos, which see.
4609 See handle_single_display_spec for documentation of arguments.
4610 FRAME_WINDOW_P is true if the window being redisplayed is on a
4611 GUI frame; this argument is used only if IT is NULL, see below.
4613 IT can be NULL, if this is called by the bidi reordering code
4614 through compute_display_string_pos, which see. In that case, this
4615 function only examines SPEC, but does not otherwise "handle" it, in
4616 the sense that it doesn't set up members of IT from the display
4619 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4620 Lisp_Object overlay
, struct text_pos
*position
,
4621 ptrdiff_t bufpos
, bool frame_window_p
)
4626 /* Simple specifications. */
4627 && !EQ (XCAR (spec
), Qimage
)
4628 && !EQ (XCAR (spec
), Qspace
)
4629 && !EQ (XCAR (spec
), Qwhen
)
4630 && !EQ (XCAR (spec
), Qslice
)
4631 && !EQ (XCAR (spec
), Qspace_width
)
4632 && !EQ (XCAR (spec
), Qheight
)
4633 && !EQ (XCAR (spec
), Qraise
)
4634 /* Marginal area specifications. */
4635 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4636 && !EQ (XCAR (spec
), Qleft_fringe
)
4637 && !EQ (XCAR (spec
), Qright_fringe
)
4638 && !NILP (XCAR (spec
)))
4640 for (; CONSP (spec
); spec
= XCDR (spec
))
4642 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4643 overlay
, position
, bufpos
,
4644 replacing
, frame_window_p
);
4648 /* If some text in a string is replaced, `position' no
4649 longer points to the position of `object'. */
4650 if (!it
|| STRINGP (object
))
4655 else if (VECTORP (spec
))
4658 for (i
= 0; i
< ASIZE (spec
); ++i
)
4660 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4661 overlay
, position
, bufpos
,
4662 replacing
, frame_window_p
);
4666 /* If some text in a string is replaced, `position' no
4667 longer points to the position of `object'. */
4668 if (!it
|| STRINGP (object
))
4674 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4675 bufpos
, 0, frame_window_p
);
4679 /* Value is the position of the end of the `display' property starting
4680 at START_POS in OBJECT. */
4682 static struct text_pos
4683 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4686 struct text_pos end_pos
;
4688 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4689 Qdisplay
, object
, Qnil
);
4690 CHARPOS (end_pos
) = XFASTINT (end
);
4691 if (STRINGP (object
))
4692 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4694 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4700 /* Set up IT from a single `display' property specification SPEC. OBJECT
4701 is the object in which the `display' property was found. *POSITION
4702 is the position in OBJECT at which the `display' property was found.
4703 BUFPOS is the buffer position of OBJECT (different from POSITION if
4704 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4705 previously saw a display specification which already replaced text
4706 display with something else, for example an image; we ignore such
4707 properties after the first one has been processed.
4709 OVERLAY is the overlay this `display' property came from,
4710 or nil if it was a text property.
4712 If SPEC is a `space' or `image' specification, and in some other
4713 cases too, set *POSITION to the position where the `display'
4716 If IT is NULL, only examine the property specification in SPEC, but
4717 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4718 is intended to be displayed in a window on a GUI frame.
4720 Value is non-zero if something was found which replaces the display
4721 of buffer or string text. */
4724 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4725 Lisp_Object overlay
, struct text_pos
*position
,
4726 ptrdiff_t bufpos
, int display_replaced
,
4727 bool frame_window_p
)
4730 Lisp_Object location
, value
;
4731 struct text_pos start_pos
= *position
;
4733 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4734 If the result is non-nil, use VALUE instead of SPEC. */
4736 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4745 if (!NILP (form
) && !EQ (form
, Qt
))
4747 ptrdiff_t count
= SPECPDL_INDEX ();
4748 struct gcpro gcpro1
;
4750 /* Bind `object' to the object having the `display' property, a
4751 buffer or string. Bind `position' to the position in the
4752 object where the property was found, and `buffer-position'
4753 to the current position in the buffer. */
4756 XSETBUFFER (object
, current_buffer
);
4757 specbind (Qobject
, object
);
4758 specbind (Qposition
, make_number (CHARPOS (*position
)));
4759 specbind (Qbuffer_position
, make_number (bufpos
));
4761 form
= safe_eval (form
);
4763 unbind_to (count
, Qnil
);
4769 /* Handle `(height HEIGHT)' specifications. */
4771 && EQ (XCAR (spec
), Qheight
)
4772 && CONSP (XCDR (spec
)))
4776 if (!FRAME_WINDOW_P (it
->f
))
4779 it
->font_height
= XCAR (XCDR (spec
));
4780 if (!NILP (it
->font_height
))
4782 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4783 int new_height
= -1;
4785 if (CONSP (it
->font_height
)
4786 && (EQ (XCAR (it
->font_height
), Qplus
)
4787 || EQ (XCAR (it
->font_height
), Qminus
))
4788 && CONSP (XCDR (it
->font_height
))
4789 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4791 /* `(+ N)' or `(- N)' where N is an integer. */
4792 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4793 if (EQ (XCAR (it
->font_height
), Qplus
))
4795 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4797 else if (FUNCTIONP (it
->font_height
))
4799 /* Call function with current height as argument.
4800 Value is the new height. */
4802 height
= safe_call1 (it
->font_height
,
4803 face
->lface
[LFACE_HEIGHT_INDEX
]);
4804 if (NUMBERP (height
))
4805 new_height
= XFLOATINT (height
);
4807 else if (NUMBERP (it
->font_height
))
4809 /* Value is a multiple of the canonical char height. */
4812 f
= FACE_FROM_ID (it
->f
,
4813 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4814 new_height
= (XFLOATINT (it
->font_height
)
4815 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4819 /* Evaluate IT->font_height with `height' bound to the
4820 current specified height to get the new height. */
4821 ptrdiff_t count
= SPECPDL_INDEX ();
4823 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4824 value
= safe_eval (it
->font_height
);
4825 unbind_to (count
, Qnil
);
4827 if (NUMBERP (value
))
4828 new_height
= XFLOATINT (value
);
4832 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4839 /* Handle `(space-width WIDTH)'. */
4841 && EQ (XCAR (spec
), Qspace_width
)
4842 && CONSP (XCDR (spec
)))
4846 if (!FRAME_WINDOW_P (it
->f
))
4849 value
= XCAR (XCDR (spec
));
4850 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4851 it
->space_width
= value
;
4857 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4859 && EQ (XCAR (spec
), Qslice
))
4865 if (!FRAME_WINDOW_P (it
->f
))
4868 if (tem
= XCDR (spec
), CONSP (tem
))
4870 it
->slice
.x
= XCAR (tem
);
4871 if (tem
= XCDR (tem
), CONSP (tem
))
4873 it
->slice
.y
= XCAR (tem
);
4874 if (tem
= XCDR (tem
), CONSP (tem
))
4876 it
->slice
.width
= XCAR (tem
);
4877 if (tem
= XCDR (tem
), CONSP (tem
))
4878 it
->slice
.height
= XCAR (tem
);
4887 /* Handle `(raise FACTOR)'. */
4889 && EQ (XCAR (spec
), Qraise
)
4890 && CONSP (XCDR (spec
)))
4894 if (!FRAME_WINDOW_P (it
->f
))
4897 #ifdef HAVE_WINDOW_SYSTEM
4898 value
= XCAR (XCDR (spec
));
4899 if (NUMBERP (value
))
4901 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4902 it
->voffset
= - (XFLOATINT (value
)
4903 * (normal_char_height (face
->font
, -1)));
4905 #endif /* HAVE_WINDOW_SYSTEM */
4911 /* Don't handle the other kinds of display specifications
4912 inside a string that we got from a `display' property. */
4913 if (it
&& it
->string_from_display_prop_p
)
4916 /* Characters having this form of property are not displayed, so
4917 we have to find the end of the property. */
4920 start_pos
= *position
;
4921 *position
= display_prop_end (it
, object
, start_pos
);
4922 /* If the display property comes from an overlay, don't consider
4923 any potential stop_charpos values before the end of that
4924 overlay. Since display_prop_end will happily find another
4925 'display' property coming from some other overlay or text
4926 property on buffer positions before this overlay's end, we
4927 need to ignore them, or else we risk displaying this
4928 overlay's display string/image twice. */
4929 if (!NILP (overlay
))
4931 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4933 if (ovendpos
> CHARPOS (*position
))
4934 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4939 /* Stop the scan at that end position--we assume that all
4940 text properties change there. */
4942 it
->stop_charpos
= position
->charpos
;
4944 /* Handle `(left-fringe BITMAP [FACE])'
4945 and `(right-fringe BITMAP [FACE])'. */
4947 && (EQ (XCAR (spec
), Qleft_fringe
)
4948 || EQ (XCAR (spec
), Qright_fringe
))
4949 && CONSP (XCDR (spec
)))
4955 if (!FRAME_WINDOW_P (it
->f
))
4956 /* If we return here, POSITION has been advanced
4957 across the text with this property. */
4959 /* Synchronize the bidi iterator with POSITION. This is
4960 needed because we are not going to push the iterator
4961 on behalf of this display property, so there will be
4962 no pop_it call to do this synchronization for us. */
4965 it
->position
= *position
;
4966 iterate_out_of_display_property (it
);
4967 *position
= it
->position
;
4972 else if (!frame_window_p
)
4975 #ifdef HAVE_WINDOW_SYSTEM
4976 value
= XCAR (XCDR (spec
));
4977 if (!SYMBOLP (value
)
4978 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4979 /* If we return here, POSITION has been advanced
4980 across the text with this property. */
4982 if (it
&& it
->bidi_p
)
4984 it
->position
= *position
;
4985 iterate_out_of_display_property (it
);
4986 *position
= it
->position
;
4993 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4995 if (CONSP (XCDR (XCDR (spec
))))
4997 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4998 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4999 FRINGE_FACE_ID
, false);
5004 /* Save current settings of IT so that we can restore them
5005 when we are finished with the glyph property value. */
5006 push_it (it
, position
);
5008 it
->area
= TEXT_AREA
;
5009 it
->what
= IT_IMAGE
;
5010 it
->image_id
= -1; /* no image */
5011 it
->position
= start_pos
;
5012 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5013 it
->method
= GET_FROM_IMAGE
;
5014 it
->from_overlay
= Qnil
;
5015 it
->face_id
= face_id
;
5016 it
->from_disp_prop_p
= true;
5018 /* Say that we haven't consumed the characters with
5019 `display' property yet. The call to pop_it in
5020 set_iterator_to_next will clean this up. */
5021 *position
= start_pos
;
5023 if (EQ (XCAR (spec
), Qleft_fringe
))
5025 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5026 it
->left_user_fringe_face_id
= face_id
;
5030 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5031 it
->right_user_fringe_face_id
= face_id
;
5034 #endif /* HAVE_WINDOW_SYSTEM */
5038 /* Prepare to handle `((margin left-margin) ...)',
5039 `((margin right-margin) ...)' and `((margin nil) ...)'
5040 prefixes for display specifications. */
5041 location
= Qunbound
;
5042 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5046 value
= XCDR (spec
);
5048 value
= XCAR (value
);
5051 if (EQ (XCAR (tem
), Qmargin
)
5052 && (tem
= XCDR (tem
),
5053 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5055 || EQ (tem
, Qleft_margin
)
5056 || EQ (tem
, Qright_margin
))))
5060 if (EQ (location
, Qunbound
))
5066 /* After this point, VALUE is the property after any
5067 margin prefix has been stripped. It must be a string,
5068 an image specification, or `(space ...)'.
5070 LOCATION specifies where to display: `left-margin',
5071 `right-margin' or nil. */
5073 bool valid_p
= (STRINGP (value
)
5074 #ifdef HAVE_WINDOW_SYSTEM
5075 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5076 && valid_image_p (value
))
5077 #endif /* not HAVE_WINDOW_SYSTEM */
5078 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5080 if (valid_p
&& display_replaced
== 0)
5086 /* Callers need to know whether the display spec is any kind
5087 of `(space ...)' spec that is about to affect text-area
5089 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5094 /* Save current settings of IT so that we can restore them
5095 when we are finished with the glyph property value. */
5096 push_it (it
, position
);
5097 it
->from_overlay
= overlay
;
5098 it
->from_disp_prop_p
= true;
5100 if (NILP (location
))
5101 it
->area
= TEXT_AREA
;
5102 else if (EQ (location
, Qleft_margin
))
5103 it
->area
= LEFT_MARGIN_AREA
;
5105 it
->area
= RIGHT_MARGIN_AREA
;
5107 if (STRINGP (value
))
5110 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5111 it
->current
.overlay_string_index
= -1;
5112 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5113 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5114 it
->method
= GET_FROM_STRING
;
5115 it
->stop_charpos
= 0;
5117 it
->base_level_stop
= 0;
5118 it
->string_from_display_prop_p
= true;
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 if (BUFFERP (object
))
5123 *position
= start_pos
;
5125 /* Force paragraph direction to be that of the parent
5126 object. If the parent object's paragraph direction is
5127 not yet determined, default to L2R. */
5128 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5129 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5131 it
->paragraph_embedding
= L2R
;
5133 /* Set up the bidi iterator for this display string. */
5136 it
->bidi_it
.string
.lstring
= it
->string
;
5137 it
->bidi_it
.string
.s
= NULL
;
5138 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5139 it
->bidi_it
.string
.bufpos
= bufpos
;
5140 it
->bidi_it
.string
.from_disp_str
= true;
5141 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5142 it
->bidi_it
.w
= it
->w
;
5143 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5146 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5148 it
->method
= GET_FROM_STRETCH
;
5150 *position
= it
->position
= start_pos
;
5151 retval
= 1 + (it
->area
== TEXT_AREA
);
5153 #ifdef HAVE_WINDOW_SYSTEM
5156 it
->what
= IT_IMAGE
;
5157 it
->image_id
= lookup_image (it
->f
, value
);
5158 it
->position
= start_pos
;
5159 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5160 it
->method
= GET_FROM_IMAGE
;
5162 /* Say that we haven't consumed the characters with
5163 `display' property yet. The call to pop_it in
5164 set_iterator_to_next will clean this up. */
5165 *position
= start_pos
;
5167 #endif /* HAVE_WINDOW_SYSTEM */
5172 /* Invalid property or property not supported. Restore
5173 POSITION to what it was before. */
5174 *position
= start_pos
;
5178 /* Check if PROP is a display property value whose text should be
5179 treated as intangible. OVERLAY is the overlay from which PROP
5180 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5181 specify the buffer position covered by PROP. */
5184 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5185 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5187 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5188 struct text_pos position
;
5190 SET_TEXT_POS (position
, charpos
, bytepos
);
5191 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5192 &position
, charpos
, frame_window_p
)
5197 /* Return true if PROP is a display sub-property value containing STRING.
5199 Implementation note: this and the following function are really
5200 special cases of handle_display_spec and
5201 handle_single_display_spec, and should ideally use the same code.
5202 Until they do, these two pairs must be consistent and must be
5203 modified in sync. */
5206 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5208 if (EQ (string
, prop
))
5211 /* Skip over `when FORM'. */
5212 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5217 /* Actually, the condition following `when' should be eval'ed,
5218 like handle_single_display_spec does, and we should return
5219 false if it evaluates to nil. However, this function is
5220 called only when the buffer was already displayed and some
5221 glyph in the glyph matrix was found to come from a display
5222 string. Therefore, the condition was already evaluated, and
5223 the result was non-nil, otherwise the display string wouldn't
5224 have been displayed and we would have never been called for
5225 this property. Thus, we can skip the evaluation and assume
5226 its result is non-nil. */
5231 /* Skip over `margin LOCATION'. */
5232 if (EQ (XCAR (prop
), Qmargin
))
5243 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5247 /* Return true if STRING appears in the `display' property PROP. */
5250 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5253 && !EQ (XCAR (prop
), Qwhen
)
5254 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5256 /* A list of sub-properties. */
5257 while (CONSP (prop
))
5259 if (single_display_spec_string_p (XCAR (prop
), string
))
5264 else if (VECTORP (prop
))
5266 /* A vector of sub-properties. */
5268 for (i
= 0; i
< ASIZE (prop
); ++i
)
5269 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5273 return single_display_spec_string_p (prop
, string
);
5278 /* Look for STRING in overlays and text properties in the current
5279 buffer, between character positions FROM and TO (excluding TO).
5280 BACK_P means look back (in this case, TO is supposed to be
5282 Value is the first character position where STRING was found, or
5283 zero if it wasn't found before hitting TO.
5285 This function may only use code that doesn't eval because it is
5286 called asynchronously from note_mouse_highlight. */
5289 string_buffer_position_lim (Lisp_Object string
,
5290 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5292 Lisp_Object limit
, prop
, pos
;
5295 pos
= make_number (max (from
, BEGV
));
5297 if (!back_p
) /* looking forward */
5299 limit
= make_number (min (to
, ZV
));
5300 while (!found
&& !EQ (pos
, limit
))
5302 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5303 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5306 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5310 else /* looking back */
5312 limit
= make_number (max (to
, BEGV
));
5313 while (!found
&& !EQ (pos
, limit
))
5315 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5316 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5319 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5324 return found
? XINT (pos
) : 0;
5327 /* Determine which buffer position in current buffer STRING comes from.
5328 AROUND_CHARPOS is an approximate position where it could come from.
5329 Value is the buffer position or 0 if it couldn't be determined.
5331 This function is necessary because we don't record buffer positions
5332 in glyphs generated from strings (to keep struct glyph small).
5333 This function may only use code that doesn't eval because it is
5334 called asynchronously from note_mouse_highlight. */
5337 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5339 const int MAX_DISTANCE
= 1000;
5340 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5341 around_charpos
+ MAX_DISTANCE
,
5345 found
= string_buffer_position_lim (string
, around_charpos
,
5346 around_charpos
- MAX_DISTANCE
, true);
5352 /***********************************************************************
5353 `composition' property
5354 ***********************************************************************/
5356 /* Set up iterator IT from `composition' property at its current
5357 position. Called from handle_stop. */
5359 static enum prop_handled
5360 handle_composition_prop (struct it
*it
)
5362 Lisp_Object prop
, string
;
5363 ptrdiff_t pos
, pos_byte
, start
, end
;
5365 if (STRINGP (it
->string
))
5369 pos
= IT_STRING_CHARPOS (*it
);
5370 pos_byte
= IT_STRING_BYTEPOS (*it
);
5371 string
= it
->string
;
5372 s
= SDATA (string
) + pos_byte
;
5373 it
->c
= STRING_CHAR (s
);
5377 pos
= IT_CHARPOS (*it
);
5378 pos_byte
= IT_BYTEPOS (*it
);
5380 it
->c
= FETCH_CHAR (pos_byte
);
5383 /* If there's a valid composition and point is not inside of the
5384 composition (in the case that the composition is from the current
5385 buffer), draw a glyph composed from the composition components. */
5386 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5387 && composition_valid_p (start
, end
, prop
)
5388 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5391 /* As we can't handle this situation (perhaps font-lock added
5392 a new composition), we just return here hoping that next
5393 redisplay will detect this composition much earlier. */
5394 return HANDLED_NORMALLY
;
5397 if (STRINGP (it
->string
))
5398 pos_byte
= string_char_to_byte (it
->string
, start
);
5400 pos_byte
= CHAR_TO_BYTE (start
);
5402 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5405 if (it
->cmp_it
.id
>= 0)
5408 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5409 it
->cmp_it
.nglyphs
= -1;
5413 return HANDLED_NORMALLY
;
5418 /***********************************************************************
5420 ***********************************************************************/
5422 /* The following structure is used to record overlay strings for
5423 later sorting in load_overlay_strings. */
5425 struct overlay_entry
5427 Lisp_Object overlay
;
5430 bool after_string_p
;
5434 /* Set up iterator IT from overlay strings at its current position.
5435 Called from handle_stop. */
5437 static enum prop_handled
5438 handle_overlay_change (struct it
*it
)
5440 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5441 return HANDLED_RECOMPUTE_PROPS
;
5443 return HANDLED_NORMALLY
;
5447 /* Set up the next overlay string for delivery by IT, if there is an
5448 overlay string to deliver. Called by set_iterator_to_next when the
5449 end of the current overlay string is reached. If there are more
5450 overlay strings to display, IT->string and
5451 IT->current.overlay_string_index are set appropriately here.
5452 Otherwise IT->string is set to nil. */
5455 next_overlay_string (struct it
*it
)
5457 ++it
->current
.overlay_string_index
;
5458 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5460 /* No more overlay strings. Restore IT's settings to what
5461 they were before overlay strings were processed, and
5462 continue to deliver from current_buffer. */
5464 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5467 || (NILP (it
->string
)
5468 && it
->method
== GET_FROM_BUFFER
5469 && it
->stop_charpos
>= BEGV
5470 && it
->stop_charpos
<= it
->end_charpos
));
5471 it
->current
.overlay_string_index
= -1;
5472 it
->n_overlay_strings
= 0;
5473 /* If there's an empty display string on the stack, pop the
5474 stack, to resync the bidi iterator with IT's position. Such
5475 empty strings are pushed onto the stack in
5476 get_overlay_strings_1. */
5477 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5480 /* Since we've exhausted overlay strings at this buffer
5481 position, set the flag to ignore overlays until we move to
5482 another position. The flag is reset in
5483 next_element_from_buffer. */
5484 it
->ignore_overlay_strings_at_pos_p
= true;
5486 /* If we're at the end of the buffer, record that we have
5487 processed the overlay strings there already, so that
5488 next_element_from_buffer doesn't try it again. */
5489 if (NILP (it
->string
)
5490 && IT_CHARPOS (*it
) >= it
->end_charpos
5491 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5492 it
->overlay_strings_at_end_processed_p
= true;
5493 /* Note: we reset overlay_strings_charpos only here, to make
5494 sure the just-processed overlays were indeed at EOB.
5495 Otherwise, overlays on text with invisible text property,
5496 which are processed with IT's position past the invisible
5497 text, might fool us into thinking the overlays at EOB were
5498 already processed (linum-mode can cause this, for
5500 it
->overlay_strings_charpos
= -1;
5504 /* There are more overlay strings to process. If
5505 IT->current.overlay_string_index has advanced to a position
5506 where we must load IT->overlay_strings with more strings, do
5507 it. We must load at the IT->overlay_strings_charpos where
5508 IT->n_overlay_strings was originally computed; when invisible
5509 text is present, this might not be IT_CHARPOS (Bug#7016). */
5510 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5512 if (it
->current
.overlay_string_index
&& i
== 0)
5513 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5515 /* Initialize IT to deliver display elements from the overlay
5517 it
->string
= it
->overlay_strings
[i
];
5518 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5519 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5520 it
->method
= GET_FROM_STRING
;
5521 it
->stop_charpos
= 0;
5522 it
->end_charpos
= SCHARS (it
->string
);
5523 if (it
->cmp_it
.stop_pos
>= 0)
5524 it
->cmp_it
.stop_pos
= 0;
5526 it
->base_level_stop
= 0;
5528 /* Set up the bidi iterator for this overlay string. */
5531 it
->bidi_it
.string
.lstring
= it
->string
;
5532 it
->bidi_it
.string
.s
= NULL
;
5533 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5534 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5535 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5536 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5537 it
->bidi_it
.w
= it
->w
;
5538 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5546 /* Compare two overlay_entry structures E1 and E2. Used as a
5547 comparison function for qsort in load_overlay_strings. Overlay
5548 strings for the same position are sorted so that
5550 1. All after-strings come in front of before-strings, except
5551 when they come from the same overlay.
5553 2. Within after-strings, strings are sorted so that overlay strings
5554 from overlays with higher priorities come first.
5556 2. Within before-strings, strings are sorted so that overlay
5557 strings from overlays with higher priorities come last.
5559 Value is analogous to strcmp. */
5563 compare_overlay_entries (const void *e1
, const void *e2
)
5565 struct overlay_entry
const *entry1
= e1
;
5566 struct overlay_entry
const *entry2
= e2
;
5569 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5571 /* Let after-strings appear in front of before-strings if
5572 they come from different overlays. */
5573 if (EQ (entry1
->overlay
, entry2
->overlay
))
5574 result
= entry1
->after_string_p
? 1 : -1;
5576 result
= entry1
->after_string_p
? -1 : 1;
5578 else if (entry1
->priority
!= entry2
->priority
)
5580 if (entry1
->after_string_p
)
5581 /* After-strings sorted in order of decreasing priority. */
5582 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5584 /* Before-strings sorted in order of increasing priority. */
5585 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5594 /* Load the vector IT->overlay_strings with overlay strings from IT's
5595 current buffer position, or from CHARPOS if that is > 0. Set
5596 IT->n_overlays to the total number of overlay strings found.
5598 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5599 a time. On entry into load_overlay_strings,
5600 IT->current.overlay_string_index gives the number of overlay
5601 strings that have already been loaded by previous calls to this
5604 IT->add_overlay_start contains an additional overlay start
5605 position to consider for taking overlay strings from, if non-zero.
5606 This position comes into play when the overlay has an `invisible'
5607 property, and both before and after-strings. When we've skipped to
5608 the end of the overlay, because of its `invisible' property, we
5609 nevertheless want its before-string to appear.
5610 IT->add_overlay_start will contain the overlay start position
5613 Overlay strings are sorted so that after-string strings come in
5614 front of before-string strings. Within before and after-strings,
5615 strings are sorted by overlay priority. See also function
5616 compare_overlay_entries. */
5619 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5621 Lisp_Object overlay
, window
, str
, invisible
;
5622 struct Lisp_Overlay
*ov
;
5623 ptrdiff_t start
, end
;
5624 ptrdiff_t n
= 0, i
, j
;
5626 struct overlay_entry entriesbuf
[20];
5627 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5628 struct overlay_entry
*entries
= entriesbuf
;
5632 charpos
= IT_CHARPOS (*it
);
5634 /* Append the overlay string STRING of overlay OVERLAY to vector
5635 `entries' which has size `size' and currently contains `n'
5636 elements. AFTER_P means STRING is an after-string of
5638 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5641 Lisp_Object priority; \
5645 struct overlay_entry *old = entries; \
5646 SAFE_NALLOCA (entries, 2, size); \
5647 memcpy (entries, old, size * sizeof *entries); \
5651 entries[n].string = (STRING); \
5652 entries[n].overlay = (OVERLAY); \
5653 priority = Foverlay_get ((OVERLAY), Qpriority); \
5654 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5655 entries[n].after_string_p = (AFTER_P); \
5660 /* Process overlay before the overlay center. */
5661 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5663 XSETMISC (overlay
, ov
);
5664 eassert (OVERLAYP (overlay
));
5665 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5666 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5671 /* Skip this overlay if it doesn't start or end at IT's current
5673 if (end
!= charpos
&& start
!= charpos
)
5676 /* Skip this overlay if it doesn't apply to IT->w. */
5677 window
= Foverlay_get (overlay
, Qwindow
);
5678 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5681 /* If the text ``under'' the overlay is invisible, both before-
5682 and after-strings from this overlay are visible; start and
5683 end position are indistinguishable. */
5684 invisible
= Foverlay_get (overlay
, Qinvisible
);
5685 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5687 /* If overlay has a non-empty before-string, record it. */
5688 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5689 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5691 RECORD_OVERLAY_STRING (overlay
, str
, false);
5693 /* If overlay has a non-empty after-string, record it. */
5694 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5695 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5697 RECORD_OVERLAY_STRING (overlay
, str
, true);
5700 /* Process overlays after the overlay center. */
5701 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5703 XSETMISC (overlay
, ov
);
5704 eassert (OVERLAYP (overlay
));
5705 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5706 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5708 if (start
> charpos
)
5711 /* Skip this overlay if it doesn't start or end at IT's current
5713 if (end
!= charpos
&& start
!= charpos
)
5716 /* Skip this overlay if it doesn't apply to IT->w. */
5717 window
= Foverlay_get (overlay
, Qwindow
);
5718 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5721 /* If the text ``under'' the overlay is invisible, it has a zero
5722 dimension, and both before- and after-strings apply. */
5723 invisible
= Foverlay_get (overlay
, Qinvisible
);
5724 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5726 /* If overlay has a non-empty before-string, record it. */
5727 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5728 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5730 RECORD_OVERLAY_STRING (overlay
, str
, false);
5732 /* If overlay has a non-empty after-string, record it. */
5733 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5734 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5736 RECORD_OVERLAY_STRING (overlay
, str
, true);
5739 #undef RECORD_OVERLAY_STRING
5743 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5745 /* Record number of overlay strings, and where we computed it. */
5746 it
->n_overlay_strings
= n
;
5747 it
->overlay_strings_charpos
= charpos
;
5749 /* IT->current.overlay_string_index is the number of overlay strings
5750 that have already been consumed by IT. Copy some of the
5751 remaining overlay strings to IT->overlay_strings. */
5753 j
= it
->current
.overlay_string_index
;
5754 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5756 it
->overlay_strings
[i
] = entries
[j
].string
;
5757 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5765 /* Get the first chunk of overlay strings at IT's current buffer
5766 position, or at CHARPOS if that is > 0. Value is true if at
5767 least one overlay string was found. */
5770 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5772 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5773 process. This fills IT->overlay_strings with strings, and sets
5774 IT->n_overlay_strings to the total number of strings to process.
5775 IT->pos.overlay_string_index has to be set temporarily to zero
5776 because load_overlay_strings needs this; it must be set to -1
5777 when no overlay strings are found because a zero value would
5778 indicate a position in the first overlay string. */
5779 it
->current
.overlay_string_index
= 0;
5780 load_overlay_strings (it
, charpos
);
5782 /* If we found overlay strings, set up IT to deliver display
5783 elements from the first one. Otherwise set up IT to deliver
5784 from current_buffer. */
5785 if (it
->n_overlay_strings
)
5787 /* Make sure we know settings in current_buffer, so that we can
5788 restore meaningful values when we're done with the overlay
5791 compute_stop_pos (it
);
5792 eassert (it
->face_id
>= 0);
5794 /* Save IT's settings. They are restored after all overlay
5795 strings have been processed. */
5796 eassert (!compute_stop_p
|| it
->sp
== 0);
5798 /* When called from handle_stop, there might be an empty display
5799 string loaded. In that case, don't bother saving it. But
5800 don't use this optimization with the bidi iterator, since we
5801 need the corresponding pop_it call to resync the bidi
5802 iterator's position with IT's position, after we are done
5803 with the overlay strings. (The corresponding call to pop_it
5804 in case of an empty display string is in
5805 next_overlay_string.) */
5807 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5810 /* Set up IT to deliver display elements from the first overlay
5812 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5813 it
->string
= it
->overlay_strings
[0];
5814 it
->from_overlay
= Qnil
;
5815 it
->stop_charpos
= 0;
5816 eassert (STRINGP (it
->string
));
5817 it
->end_charpos
= SCHARS (it
->string
);
5819 it
->base_level_stop
= 0;
5820 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5821 it
->method
= GET_FROM_STRING
;
5822 it
->from_disp_prop_p
= 0;
5824 /* Force paragraph direction to be that of the parent
5826 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5827 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5829 it
->paragraph_embedding
= L2R
;
5831 /* Set up the bidi iterator for this overlay string. */
5834 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5836 it
->bidi_it
.string
.lstring
= it
->string
;
5837 it
->bidi_it
.string
.s
= NULL
;
5838 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5839 it
->bidi_it
.string
.bufpos
= pos
;
5840 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5841 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5842 it
->bidi_it
.w
= it
->w
;
5843 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5848 it
->current
.overlay_string_index
= -1;
5853 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5856 it
->method
= GET_FROM_BUFFER
;
5858 get_overlay_strings_1 (it
, charpos
, true);
5862 /* Value is true if we found at least one overlay string. */
5863 return STRINGP (it
->string
);
5868 /***********************************************************************
5869 Saving and restoring state
5870 ***********************************************************************/
5872 /* Save current settings of IT on IT->stack. Called, for example,
5873 before setting up IT for an overlay string, to be able to restore
5874 IT's settings to what they were after the overlay string has been
5875 processed. If POSITION is non-NULL, it is the position to save on
5876 the stack instead of IT->position. */
5879 push_it (struct it
*it
, struct text_pos
*position
)
5881 struct iterator_stack_entry
*p
;
5883 eassert (it
->sp
< IT_STACK_SIZE
);
5884 p
= it
->stack
+ it
->sp
;
5886 p
->stop_charpos
= it
->stop_charpos
;
5887 p
->prev_stop
= it
->prev_stop
;
5888 p
->base_level_stop
= it
->base_level_stop
;
5889 p
->cmp_it
= it
->cmp_it
;
5890 eassert (it
->face_id
>= 0);
5891 p
->face_id
= it
->face_id
;
5892 p
->string
= it
->string
;
5893 p
->method
= it
->method
;
5894 p
->from_overlay
= it
->from_overlay
;
5897 case GET_FROM_IMAGE
:
5898 p
->u
.image
.object
= it
->object
;
5899 p
->u
.image
.image_id
= it
->image_id
;
5900 p
->u
.image
.slice
= it
->slice
;
5902 case GET_FROM_STRETCH
:
5903 p
->u
.stretch
.object
= it
->object
;
5906 p
->position
= position
? *position
: it
->position
;
5907 p
->current
= it
->current
;
5908 p
->end_charpos
= it
->end_charpos
;
5909 p
->string_nchars
= it
->string_nchars
;
5911 p
->multibyte_p
= it
->multibyte_p
;
5912 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5913 p
->space_width
= it
->space_width
;
5914 p
->font_height
= it
->font_height
;
5915 p
->voffset
= it
->voffset
;
5916 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5917 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5918 p
->display_ellipsis_p
= false;
5919 p
->line_wrap
= it
->line_wrap
;
5920 p
->bidi_p
= it
->bidi_p
;
5921 p
->paragraph_embedding
= it
->paragraph_embedding
;
5922 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5925 /* Save the state of the bidi iterator as well. */
5927 bidi_push_it (&it
->bidi_it
);
5931 iterate_out_of_display_property (struct it
*it
)
5933 bool buffer_p
= !STRINGP (it
->string
);
5934 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5935 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5937 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5939 /* Maybe initialize paragraph direction. If we are at the beginning
5940 of a new paragraph, next_element_from_buffer may not have a
5941 chance to do that. */
5942 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5943 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5944 /* prev_stop can be zero, so check against BEGV as well. */
5945 while (it
->bidi_it
.charpos
>= bob
5946 && it
->prev_stop
<= it
->bidi_it
.charpos
5947 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5948 && it
->bidi_it
.charpos
< eob
)
5949 bidi_move_to_visually_next (&it
->bidi_it
);
5950 /* Record the stop_pos we just crossed, for when we cross it
5952 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5953 it
->prev_stop
= CHARPOS (it
->position
);
5954 /* If we ended up not where pop_it put us, resync IT's
5955 positional members with the bidi iterator. */
5956 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5957 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5959 it
->current
.pos
= it
->position
;
5961 it
->current
.string_pos
= it
->position
;
5964 /* Restore IT's settings from IT->stack. Called, for example, when no
5965 more overlay strings must be processed, and we return to delivering
5966 display elements from a buffer, or when the end of a string from a
5967 `display' property is reached and we return to delivering display
5968 elements from an overlay string, or from a buffer. */
5971 pop_it (struct it
*it
)
5973 struct iterator_stack_entry
*p
;
5974 bool from_display_prop
= it
->from_disp_prop_p
;
5975 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
5977 eassert (it
->sp
> 0);
5979 p
= it
->stack
+ it
->sp
;
5980 it
->stop_charpos
= p
->stop_charpos
;
5981 it
->prev_stop
= p
->prev_stop
;
5982 it
->base_level_stop
= p
->base_level_stop
;
5983 it
->cmp_it
= p
->cmp_it
;
5984 it
->face_id
= p
->face_id
;
5985 it
->current
= p
->current
;
5986 it
->position
= p
->position
;
5987 it
->string
= p
->string
;
5988 it
->from_overlay
= p
->from_overlay
;
5989 if (NILP (it
->string
))
5990 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5991 it
->method
= p
->method
;
5994 case GET_FROM_IMAGE
:
5995 it
->image_id
= p
->u
.image
.image_id
;
5996 it
->object
= p
->u
.image
.object
;
5997 it
->slice
= p
->u
.image
.slice
;
5999 case GET_FROM_STRETCH
:
6000 it
->object
= p
->u
.stretch
.object
;
6002 case GET_FROM_BUFFER
:
6003 it
->object
= it
->w
->contents
;
6005 case GET_FROM_STRING
:
6007 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6009 /* Restore the face_box_p flag, since it could have been
6010 overwritten by the face of the object that we just finished
6013 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6014 it
->object
= it
->string
;
6017 case GET_FROM_DISPLAY_VECTOR
:
6019 it
->method
= GET_FROM_C_STRING
;
6020 else if (STRINGP (it
->string
))
6021 it
->method
= GET_FROM_STRING
;
6024 it
->method
= GET_FROM_BUFFER
;
6025 it
->object
= it
->w
->contents
;
6028 it
->end_charpos
= p
->end_charpos
;
6029 it
->string_nchars
= p
->string_nchars
;
6031 it
->multibyte_p
= p
->multibyte_p
;
6032 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6033 it
->space_width
= p
->space_width
;
6034 it
->font_height
= p
->font_height
;
6035 it
->voffset
= p
->voffset
;
6036 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6037 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6038 it
->line_wrap
= p
->line_wrap
;
6039 it
->bidi_p
= p
->bidi_p
;
6040 it
->paragraph_embedding
= p
->paragraph_embedding
;
6041 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6044 bidi_pop_it (&it
->bidi_it
);
6045 /* Bidi-iterate until we get out of the portion of text, if any,
6046 covered by a `display' text property or by an overlay with
6047 `display' property. (We cannot just jump there, because the
6048 internal coherency of the bidi iterator state can not be
6049 preserved across such jumps.) We also must determine the
6050 paragraph base direction if the overlay we just processed is
6051 at the beginning of a new paragraph. */
6052 if (from_display_prop
6053 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6054 iterate_out_of_display_property (it
);
6056 eassert ((BUFFERP (it
->object
)
6057 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6058 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6059 || (STRINGP (it
->object
)
6060 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6061 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6062 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6064 /* If we move the iterator over text covered by a display property
6065 to a new buffer position, any info about previously seen overlays
6066 is no longer valid. */
6067 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6068 it
->ignore_overlay_strings_at_pos_p
= false;
6073 /***********************************************************************
6075 ***********************************************************************/
6077 /* Set IT's current position to the previous line start. */
6080 back_to_previous_line_start (struct it
*it
)
6082 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6085 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6089 /* Move IT to the next line start.
6091 Value is true if a newline was found. Set *SKIPPED_P to true if
6092 we skipped over part of the text (as opposed to moving the iterator
6093 continuously over the text). Otherwise, don't change the value
6096 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6097 iterator on the newline, if it was found.
6099 Newlines may come from buffer text, overlay strings, or strings
6100 displayed via the `display' property. That's the reason we can't
6101 simply use find_newline_no_quit.
6103 Note that this function may not skip over invisible text that is so
6104 because of text properties and immediately follows a newline. If
6105 it would, function reseat_at_next_visible_line_start, when called
6106 from set_iterator_to_next, would effectively make invisible
6107 characters following a newline part of the wrong glyph row, which
6108 leads to wrong cursor motion. */
6111 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6112 struct bidi_it
*bidi_it_prev
)
6114 ptrdiff_t old_selective
;
6115 bool newline_found_p
= false;
6117 const int MAX_NEWLINE_DISTANCE
= 500;
6119 /* If already on a newline, just consume it to avoid unintended
6120 skipping over invisible text below. */
6121 if (it
->what
== IT_CHARACTER
6123 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6125 if (it
->bidi_p
&& bidi_it_prev
)
6126 *bidi_it_prev
= it
->bidi_it
;
6127 set_iterator_to_next (it
, false);
6132 /* Don't handle selective display in the following. It's (a)
6133 unnecessary because it's done by the caller, and (b) leads to an
6134 infinite recursion because next_element_from_ellipsis indirectly
6135 calls this function. */
6136 old_selective
= it
->selective
;
6139 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6140 from buffer text. */
6142 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6143 n
+= !STRINGP (it
->string
))
6145 if (!get_next_display_element (it
))
6147 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6148 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6149 *bidi_it_prev
= it
->bidi_it
;
6150 set_iterator_to_next (it
, false);
6153 /* If we didn't find a newline near enough, see if we can use a
6155 if (!newline_found_p
)
6157 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6158 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6162 eassert (!STRINGP (it
->string
));
6164 /* If there isn't any `display' property in sight, and no
6165 overlays, we can just use the position of the newline in
6167 if (it
->stop_charpos
>= limit
6168 || ((pos
= Fnext_single_property_change (make_number (start
),
6170 make_number (limit
)),
6172 && next_overlay_change (start
) == ZV
))
6176 IT_CHARPOS (*it
) = limit
;
6177 IT_BYTEPOS (*it
) = bytepos
;
6181 struct bidi_it bprev
;
6183 /* Help bidi.c avoid expensive searches for display
6184 properties and overlays, by telling it that there are
6185 none up to `limit'. */
6186 if (it
->bidi_it
.disp_pos
< limit
)
6188 it
->bidi_it
.disp_pos
= limit
;
6189 it
->bidi_it
.disp_prop
= 0;
6192 bprev
= it
->bidi_it
;
6193 bidi_move_to_visually_next (&it
->bidi_it
);
6194 } while (it
->bidi_it
.charpos
!= limit
);
6195 IT_CHARPOS (*it
) = limit
;
6196 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6198 *bidi_it_prev
= bprev
;
6200 *skipped_p
= newline_found_p
= true;
6204 while (get_next_display_element (it
)
6205 && !newline_found_p
)
6207 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6208 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6209 *bidi_it_prev
= it
->bidi_it
;
6210 set_iterator_to_next (it
, false);
6215 it
->selective
= old_selective
;
6216 return newline_found_p
;
6220 /* Set IT's current position to the previous visible line start. Skip
6221 invisible text that is so either due to text properties or due to
6222 selective display. Caution: this does not change IT->current_x and
6226 back_to_previous_visible_line_start (struct it
*it
)
6228 while (IT_CHARPOS (*it
) > BEGV
)
6230 back_to_previous_line_start (it
);
6232 if (IT_CHARPOS (*it
) <= BEGV
)
6235 /* If selective > 0, then lines indented more than its value are
6237 if (it
->selective
> 0
6238 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6242 /* Check the newline before point for invisibility. */
6245 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6246 Qinvisible
, it
->window
);
6247 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6251 if (IT_CHARPOS (*it
) <= BEGV
)
6256 void *it2data
= NULL
;
6259 Lisp_Object val
, overlay
;
6261 SAVE_IT (it2
, *it
, it2data
);
6263 /* If newline is part of a composition, continue from start of composition */
6264 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6265 && beg
< IT_CHARPOS (*it
))
6268 /* If newline is replaced by a display property, find start of overlay
6269 or interval and continue search from that point. */
6270 pos
= --IT_CHARPOS (it2
);
6273 bidi_unshelve_cache (NULL
, false);
6274 it2
.string_from_display_prop_p
= false;
6275 it2
.from_disp_prop_p
= false;
6276 if (handle_display_prop (&it2
) == HANDLED_RETURN
6277 && !NILP (val
= get_char_property_and_overlay
6278 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6279 && (OVERLAYP (overlay
)
6280 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6281 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6283 RESTORE_IT (it
, it
, it2data
);
6287 /* Newline is not replaced by anything -- so we are done. */
6288 RESTORE_IT (it
, it
, it2data
);
6294 IT_CHARPOS (*it
) = beg
;
6295 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6299 it
->continuation_lines_width
= 0;
6301 eassert (IT_CHARPOS (*it
) >= BEGV
);
6302 eassert (IT_CHARPOS (*it
) == BEGV
6303 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6308 /* Reseat iterator IT at the previous visible line start. Skip
6309 invisible text that is so either due to text properties or due to
6310 selective display. At the end, update IT's overlay information,
6311 face information etc. */
6314 reseat_at_previous_visible_line_start (struct it
*it
)
6316 back_to_previous_visible_line_start (it
);
6317 reseat (it
, it
->current
.pos
, true);
6322 /* Reseat iterator IT on the next visible line start in the current
6323 buffer. ON_NEWLINE_P means position IT on the newline
6324 preceding the line start. Skip over invisible text that is so
6325 because of selective display. Compute faces, overlays etc at the
6326 new position. Note that this function does not skip over text that
6327 is invisible because of text properties. */
6330 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6332 bool skipped_p
= false;
6333 struct bidi_it bidi_it_prev
;
6334 bool newline_found_p
6335 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6337 /* Skip over lines that are invisible because they are indented
6338 more than the value of IT->selective. */
6339 if (it
->selective
> 0)
6340 while (IT_CHARPOS (*it
) < ZV
6341 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6344 eassert (IT_BYTEPOS (*it
) == BEGV
6345 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6347 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6350 /* Position on the newline if that's what's requested. */
6351 if (on_newline_p
&& newline_found_p
)
6353 if (STRINGP (it
->string
))
6355 if (IT_STRING_CHARPOS (*it
) > 0)
6359 --IT_STRING_CHARPOS (*it
);
6360 --IT_STRING_BYTEPOS (*it
);
6364 /* We need to restore the bidi iterator to the state
6365 it had on the newline, and resync the IT's
6366 position with that. */
6367 it
->bidi_it
= bidi_it_prev
;
6368 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6369 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6373 else if (IT_CHARPOS (*it
) > BEGV
)
6382 /* We need to restore the bidi iterator to the state it
6383 had on the newline and resync IT with that. */
6384 it
->bidi_it
= bidi_it_prev
;
6385 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6386 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6388 reseat (it
, it
->current
.pos
, false);
6392 reseat (it
, it
->current
.pos
, false);
6399 /***********************************************************************
6400 Changing an iterator's position
6401 ***********************************************************************/
6403 /* Change IT's current position to POS in current_buffer.
6404 If FORCE_P, always check for text properties at the new position.
6405 Otherwise, text properties are only looked up if POS >=
6406 IT->check_charpos of a property. */
6409 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6411 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6413 reseat_1 (it
, pos
, false);
6415 /* Determine where to check text properties. Avoid doing it
6416 where possible because text property lookup is very expensive. */
6418 || CHARPOS (pos
) > it
->stop_charpos
6419 || CHARPOS (pos
) < original_pos
)
6423 /* For bidi iteration, we need to prime prev_stop and
6424 base_level_stop with our best estimations. */
6425 /* Implementation note: Of course, POS is not necessarily a
6426 stop position, so assigning prev_pos to it is a lie; we
6427 should have called compute_stop_backwards. However, if
6428 the current buffer does not include any R2L characters,
6429 that call would be a waste of cycles, because the
6430 iterator will never move back, and thus never cross this
6431 "fake" stop position. So we delay that backward search
6432 until the time we really need it, in next_element_from_buffer. */
6433 if (CHARPOS (pos
) != it
->prev_stop
)
6434 it
->prev_stop
= CHARPOS (pos
);
6435 if (CHARPOS (pos
) < it
->base_level_stop
)
6436 it
->base_level_stop
= 0; /* meaning it's unknown */
6442 it
->prev_stop
= it
->base_level_stop
= 0;
6451 /* Change IT's buffer position to POS. SET_STOP_P means set
6452 IT->stop_pos to POS, also. */
6455 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6457 /* Don't call this function when scanning a C string. */
6458 eassert (it
->s
== NULL
);
6460 /* POS must be a reasonable value. */
6461 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6463 it
->current
.pos
= it
->position
= pos
;
6464 it
->end_charpos
= ZV
;
6466 it
->current
.dpvec_index
= -1;
6467 it
->current
.overlay_string_index
= -1;
6468 IT_STRING_CHARPOS (*it
) = -1;
6469 IT_STRING_BYTEPOS (*it
) = -1;
6471 it
->method
= GET_FROM_BUFFER
;
6472 it
->object
= it
->w
->contents
;
6473 it
->area
= TEXT_AREA
;
6474 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6476 it
->string_from_display_prop_p
= false;
6477 it
->string_from_prefix_prop_p
= false;
6479 it
->from_disp_prop_p
= false;
6480 it
->face_before_selective_p
= false;
6483 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6485 bidi_unshelve_cache (NULL
, false);
6486 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6487 it
->bidi_it
.string
.s
= NULL
;
6488 it
->bidi_it
.string
.lstring
= Qnil
;
6489 it
->bidi_it
.string
.bufpos
= 0;
6490 it
->bidi_it
.string
.from_disp_str
= false;
6491 it
->bidi_it
.string
.unibyte
= false;
6492 it
->bidi_it
.w
= it
->w
;
6497 it
->stop_charpos
= CHARPOS (pos
);
6498 it
->base_level_stop
= CHARPOS (pos
);
6500 /* This make the information stored in it->cmp_it invalidate. */
6505 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6506 If S is non-null, it is a C string to iterate over. Otherwise,
6507 STRING gives a Lisp string to iterate over.
6509 If PRECISION > 0, don't return more then PRECISION number of
6510 characters from the string.
6512 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6513 characters have been returned. FIELD_WIDTH < 0 means an infinite
6516 MULTIBYTE = 0 means disable processing of multibyte characters,
6517 MULTIBYTE > 0 means enable it,
6518 MULTIBYTE < 0 means use IT->multibyte_p.
6520 IT must be initialized via a prior call to init_iterator before
6521 calling this function. */
6524 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6525 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6528 /* No text property checks performed by default, but see below. */
6529 it
->stop_charpos
= -1;
6531 /* Set iterator position and end position. */
6532 memset (&it
->current
, 0, sizeof it
->current
);
6533 it
->current
.overlay_string_index
= -1;
6534 it
->current
.dpvec_index
= -1;
6535 eassert (charpos
>= 0);
6537 /* If STRING is specified, use its multibyteness, otherwise use the
6538 setting of MULTIBYTE, if specified. */
6540 it
->multibyte_p
= multibyte
> 0;
6542 /* Bidirectional reordering of strings is controlled by the default
6543 value of bidi-display-reordering. Don't try to reorder while
6544 loading loadup.el, as the necessary character property tables are
6545 not yet available. */
6548 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6552 eassert (STRINGP (string
));
6553 it
->string
= string
;
6555 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6556 it
->method
= GET_FROM_STRING
;
6557 it
->current
.string_pos
= string_pos (charpos
, string
);
6561 it
->bidi_it
.string
.lstring
= string
;
6562 it
->bidi_it
.string
.s
= NULL
;
6563 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6564 it
->bidi_it
.string
.bufpos
= 0;
6565 it
->bidi_it
.string
.from_disp_str
= false;
6566 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6567 it
->bidi_it
.w
= it
->w
;
6568 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6569 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6574 it
->s
= (const unsigned char *) s
;
6577 /* Note that we use IT->current.pos, not it->current.string_pos,
6578 for displaying C strings. */
6579 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6580 if (it
->multibyte_p
)
6582 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6583 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6587 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6588 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6593 it
->bidi_it
.string
.lstring
= Qnil
;
6594 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6595 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6596 it
->bidi_it
.string
.bufpos
= 0;
6597 it
->bidi_it
.string
.from_disp_str
= false;
6598 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6599 it
->bidi_it
.w
= it
->w
;
6600 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6603 it
->method
= GET_FROM_C_STRING
;
6606 /* PRECISION > 0 means don't return more than PRECISION characters
6608 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6610 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6612 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6615 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6616 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6617 FIELD_WIDTH < 0 means infinite field width. This is useful for
6618 padding with `-' at the end of a mode line. */
6619 if (field_width
< 0)
6620 field_width
= INFINITY
;
6621 /* Implementation note: We deliberately don't enlarge
6622 it->bidi_it.string.schars here to fit it->end_charpos, because
6623 the bidi iterator cannot produce characters out of thin air. */
6624 if (field_width
> it
->end_charpos
- charpos
)
6625 it
->end_charpos
= charpos
+ field_width
;
6627 /* Use the standard display table for displaying strings. */
6628 if (DISP_TABLE_P (Vstandard_display_table
))
6629 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6631 it
->stop_charpos
= charpos
;
6632 it
->prev_stop
= charpos
;
6633 it
->base_level_stop
= 0;
6636 it
->bidi_it
.first_elt
= true;
6637 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6638 it
->bidi_it
.disp_pos
= -1;
6640 if (s
== NULL
&& it
->multibyte_p
)
6642 ptrdiff_t endpos
= SCHARS (it
->string
);
6643 if (endpos
> it
->end_charpos
)
6644 endpos
= it
->end_charpos
;
6645 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6653 /***********************************************************************
6655 ***********************************************************************/
6657 /* Map enum it_method value to corresponding next_element_from_* function. */
6659 typedef bool (*next_element_function
) (struct it
*);
6661 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6663 next_element_from_buffer
,
6664 next_element_from_display_vector
,
6665 next_element_from_string
,
6666 next_element_from_c_string
,
6667 next_element_from_image
,
6668 next_element_from_stretch
6671 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6674 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6675 (possibly with the following characters). */
6677 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6678 ((IT)->cmp_it.id >= 0 \
6679 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6680 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6681 END_CHARPOS, (IT)->w, \
6682 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6686 /* Lookup the char-table Vglyphless_char_display for character C (-1
6687 if we want information for no-font case), and return the display
6688 method symbol. By side-effect, update it->what and
6689 it->glyphless_method. This function is called from
6690 get_next_display_element for each character element, and from
6691 x_produce_glyphs when no suitable font was found. */
6694 lookup_glyphless_char_display (int c
, struct it
*it
)
6696 Lisp_Object glyphless_method
= Qnil
;
6698 if (CHAR_TABLE_P (Vglyphless_char_display
)
6699 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6703 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6704 if (CONSP (glyphless_method
))
6705 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6706 ? XCAR (glyphless_method
)
6707 : XCDR (glyphless_method
);
6710 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6714 if (NILP (glyphless_method
))
6717 /* The default is to display the character by a proper font. */
6719 /* The default for the no-font case is to display an empty box. */
6720 glyphless_method
= Qempty_box
;
6722 if (EQ (glyphless_method
, Qzero_width
))
6725 return glyphless_method
;
6726 /* This method can't be used for the no-font case. */
6727 glyphless_method
= Qempty_box
;
6729 if (EQ (glyphless_method
, Qthin_space
))
6730 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6731 else if (EQ (glyphless_method
, Qempty_box
))
6732 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6733 else if (EQ (glyphless_method
, Qhex_code
))
6734 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6735 else if (STRINGP (glyphless_method
))
6736 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6739 /* Invalid value. We use the default method. */
6740 glyphless_method
= Qnil
;
6743 it
->what
= IT_GLYPHLESS
;
6744 return glyphless_method
;
6747 /* Merge escape glyph face and cache the result. */
6749 static struct frame
*last_escape_glyph_frame
= NULL
;
6750 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6751 static int last_escape_glyph_merged_face_id
= 0;
6754 merge_escape_glyph_face (struct it
*it
)
6758 if (it
->f
== last_escape_glyph_frame
6759 && it
->face_id
== last_escape_glyph_face_id
)
6760 face_id
= last_escape_glyph_merged_face_id
;
6763 /* Merge the `escape-glyph' face into the current face. */
6764 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6765 last_escape_glyph_frame
= it
->f
;
6766 last_escape_glyph_face_id
= it
->face_id
;
6767 last_escape_glyph_merged_face_id
= face_id
;
6772 /* Likewise for glyphless glyph face. */
6774 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6775 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6776 static int last_glyphless_glyph_merged_face_id
= 0;
6779 merge_glyphless_glyph_face (struct it
*it
)
6783 if (it
->f
== last_glyphless_glyph_frame
6784 && it
->face_id
== last_glyphless_glyph_face_id
)
6785 face_id
= last_glyphless_glyph_merged_face_id
;
6788 /* Merge the `glyphless-char' face into the current face. */
6789 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6790 last_glyphless_glyph_frame
= it
->f
;
6791 last_glyphless_glyph_face_id
= it
->face_id
;
6792 last_glyphless_glyph_merged_face_id
= face_id
;
6797 /* Load IT's display element fields with information about the next
6798 display element from the current position of IT. Value is false if
6799 end of buffer (or C string) is reached. */
6802 get_next_display_element (struct it
*it
)
6804 /* True means that we found a display element. False means that
6805 we hit the end of what we iterate over. Performance note: the
6806 function pointer `method' used here turns out to be faster than
6807 using a sequence of if-statements. */
6811 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6813 if (it
->what
== IT_CHARACTER
)
6815 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6816 and only if (a) the resolved directionality of that character
6818 /* FIXME: Do we need an exception for characters from display
6820 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6821 && !inhibit_bidi_mirroring
)
6822 it
->c
= bidi_mirror_char (it
->c
);
6823 /* Map via display table or translate control characters.
6824 IT->c, IT->len etc. have been set to the next character by
6825 the function call above. If we have a display table, and it
6826 contains an entry for IT->c, translate it. Don't do this if
6827 IT->c itself comes from a display table, otherwise we could
6828 end up in an infinite recursion. (An alternative could be to
6829 count the recursion depth of this function and signal an
6830 error when a certain maximum depth is reached.) Is it worth
6832 if (success_p
&& it
->dpvec
== NULL
)
6835 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6836 bool nonascii_space_p
= false;
6837 bool nonascii_hyphen_p
= false;
6838 int c
= it
->c
; /* This is the character to display. */
6840 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6842 eassert (SINGLE_BYTE_CHAR_P (c
));
6843 if (unibyte_display_via_language_environment
)
6845 c
= DECODE_CHAR (unibyte
, c
);
6847 c
= BYTE8_TO_CHAR (it
->c
);
6850 c
= BYTE8_TO_CHAR (it
->c
);
6854 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6857 struct Lisp_Vector
*v
= XVECTOR (dv
);
6859 /* Return the first character from the display table
6860 entry, if not empty. If empty, don't display the
6861 current character. */
6864 it
->dpvec_char_len
= it
->len
;
6865 it
->dpvec
= v
->contents
;
6866 it
->dpend
= v
->contents
+ v
->header
.size
;
6867 it
->current
.dpvec_index
= 0;
6868 it
->dpvec_face_id
= -1;
6869 it
->saved_face_id
= it
->face_id
;
6870 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6871 it
->ellipsis_p
= false;
6875 set_iterator_to_next (it
, false);
6880 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6882 if (it
->what
== IT_GLYPHLESS
)
6884 /* Don't display this character. */
6885 set_iterator_to_next (it
, false);
6889 /* If `nobreak-char-display' is non-nil, we display
6890 non-ASCII spaces and hyphens specially. */
6891 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6893 if (c
== NO_BREAK_SPACE
)
6894 nonascii_space_p
= true;
6895 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6896 || c
== NON_BREAKING_HYPHEN
)
6897 nonascii_hyphen_p
= true;
6900 /* Translate control characters into `\003' or `^C' form.
6901 Control characters coming from a display table entry are
6902 currently not translated because we use IT->dpvec to hold
6903 the translation. This could easily be changed but I
6904 don't believe that it is worth doing.
6906 The characters handled by `nobreak-char-display' must be
6909 Non-printable characters and raw-byte characters are also
6910 translated to octal form. */
6911 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6912 ? (it
->area
!= TEXT_AREA
6913 /* In mode line, treat \n, \t like other crl chars. */
6916 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6917 || (c
!= '\n' && c
!= '\t'))
6919 || nonascii_hyphen_p
6921 || ! CHAR_PRINTABLE_P (c
))))
6923 /* C is a control character, non-ASCII space/hyphen,
6924 raw-byte, or a non-printable character which must be
6925 displayed either as '\003' or as `^C' where the '\\'
6926 and '^' can be defined in the display table. Fill
6927 IT->ctl_chars with glyphs for what we have to
6928 display. Then, set IT->dpvec to these glyphs. */
6935 /* Handle control characters with ^. */
6937 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6941 g
= '^'; /* default glyph for Control */
6942 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6944 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6946 g
= GLYPH_CODE_CHAR (gc
);
6947 lface_id
= GLYPH_CODE_FACE (gc
);
6951 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6952 : merge_escape_glyph_face (it
));
6954 XSETINT (it
->ctl_chars
[0], g
);
6955 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6957 goto display_control
;
6960 /* Handle non-ascii space in the mode where it only gets
6963 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6965 /* Merge `nobreak-space' into the current face. */
6966 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6968 XSETINT (it
->ctl_chars
[0], ' ');
6970 goto display_control
;
6973 /* Handle sequences that start with the "escape glyph". */
6975 /* the default escape glyph is \. */
6976 escape_glyph
= '\\';
6979 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6981 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6982 lface_id
= GLYPH_CODE_FACE (gc
);
6986 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6987 : merge_escape_glyph_face (it
));
6989 /* Draw non-ASCII hyphen with just highlighting: */
6991 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6993 XSETINT (it
->ctl_chars
[0], '-');
6995 goto display_control
;
6998 /* Draw non-ASCII space/hyphen with escape glyph: */
7000 if (nonascii_space_p
|| nonascii_hyphen_p
)
7002 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7003 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7005 goto display_control
;
7012 if (CHAR_BYTE8_P (c
))
7013 /* Display \200 instead of \17777600. */
7014 c
= CHAR_TO_BYTE8 (c
);
7015 len
= sprintf (str
, "%03o", c
+ 0u);
7017 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7018 for (i
= 0; i
< len
; i
++)
7019 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7024 /* Set up IT->dpvec and return first character from it. */
7025 it
->dpvec_char_len
= it
->len
;
7026 it
->dpvec
= it
->ctl_chars
;
7027 it
->dpend
= it
->dpvec
+ ctl_len
;
7028 it
->current
.dpvec_index
= 0;
7029 it
->dpvec_face_id
= face_id
;
7030 it
->saved_face_id
= it
->face_id
;
7031 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7032 it
->ellipsis_p
= false;
7035 it
->char_to_display
= c
;
7039 it
->char_to_display
= it
->c
;
7043 #ifdef HAVE_WINDOW_SYSTEM
7044 /* Adjust face id for a multibyte character. There are no multibyte
7045 character in unibyte text. */
7046 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7049 && FRAME_WINDOW_P (it
->f
))
7051 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7053 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7055 /* Automatic composition with glyph-string. */
7056 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7058 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7062 ptrdiff_t pos
= (it
->s
? -1
7063 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7064 : IT_CHARPOS (*it
));
7067 if (it
->what
== IT_CHARACTER
)
7068 c
= it
->char_to_display
;
7071 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7075 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7076 /* TAB in a composition means display glyphs with
7077 padding space on the left or right. */
7078 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7081 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7084 #endif /* HAVE_WINDOW_SYSTEM */
7087 /* Is this character the last one of a run of characters with
7088 box? If yes, set IT->end_of_box_run_p to true. */
7092 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7094 int face_id
= underlying_face_id (it
);
7095 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7099 if (face
->box
== FACE_NO_BOX
)
7101 /* If the box comes from face properties in a
7102 display string, check faces in that string. */
7103 int string_face_id
= face_after_it_pos (it
);
7104 it
->end_of_box_run_p
7105 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7108 /* Otherwise, the box comes from the underlying face.
7109 If this is the last string character displayed, check
7110 the next buffer location. */
7111 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7112 /* n_overlay_strings is unreliable unless
7113 overlay_string_index is non-negative. */
7114 && ((it
->current
.overlay_string_index
>= 0
7115 && (it
->current
.overlay_string_index
7116 == it
->n_overlay_strings
- 1))
7117 /* A string from display property. */
7118 || it
->from_disp_prop_p
))
7122 struct text_pos pos
= it
->current
.pos
;
7124 /* For a string from a display property, the next
7125 buffer position is stored in the 'position'
7126 member of the iteration stack slot below the
7127 current one, see handle_single_display_spec. By
7128 contrast, it->current.pos was is not yet updated
7129 to point to that buffer position; that will
7130 happen in pop_it, after we finish displaying the
7131 current string. Note that we already checked
7132 above that it->sp is positive, so subtracting one
7134 if (it
->from_disp_prop_p
)
7135 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7137 INC_TEXT_POS (pos
, it
->multibyte_p
);
7139 if (CHARPOS (pos
) >= ZV
)
7140 it
->end_of_box_run_p
= true;
7143 next_face_id
= face_at_buffer_position
7144 (it
->w
, CHARPOS (pos
), &ignore
,
7145 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7146 it
->end_of_box_run_p
7147 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7153 /* next_element_from_display_vector sets this flag according to
7154 faces of the display vector glyphs, see there. */
7155 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7157 int face_id
= face_after_it_pos (it
);
7158 it
->end_of_box_run_p
7159 = (face_id
!= it
->face_id
7160 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7163 /* If we reached the end of the object we've been iterating (e.g., a
7164 display string or an overlay string), and there's something on
7165 IT->stack, proceed with what's on the stack. It doesn't make
7166 sense to return false if there's unprocessed stuff on the stack,
7167 because otherwise that stuff will never be displayed. */
7168 if (!success_p
&& it
->sp
> 0)
7170 set_iterator_to_next (it
, false);
7171 success_p
= get_next_display_element (it
);
7174 /* Value is false if end of buffer or string reached. */
7179 /* Move IT to the next display element.
7181 RESEAT_P means if called on a newline in buffer text,
7182 skip to the next visible line start.
7184 Functions get_next_display_element and set_iterator_to_next are
7185 separate because I find this arrangement easier to handle than a
7186 get_next_display_element function that also increments IT's
7187 position. The way it is we can first look at an iterator's current
7188 display element, decide whether it fits on a line, and if it does,
7189 increment the iterator position. The other way around we probably
7190 would either need a flag indicating whether the iterator has to be
7191 incremented the next time, or we would have to implement a
7192 decrement position function which would not be easy to write. */
7195 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7197 /* Reset flags indicating start and end of a sequence of characters
7198 with box. Reset them at the start of this function because
7199 moving the iterator to a new position might set them. */
7200 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7204 case GET_FROM_BUFFER
:
7205 /* The current display element of IT is a character from
7206 current_buffer. Advance in the buffer, and maybe skip over
7207 invisible lines that are so because of selective display. */
7208 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7209 reseat_at_next_visible_line_start (it
, false);
7210 else if (it
->cmp_it
.id
>= 0)
7212 /* We are currently getting glyphs from a composition. */
7215 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7216 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7222 /* Update IT's char/byte positions to point to the first
7223 character of the next grapheme cluster, or to the
7224 character visually after the current composition. */
7225 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7226 bidi_move_to_visually_next (&it
->bidi_it
);
7227 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7228 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7231 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7232 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7234 /* Composition created while scanning forward. Proceed
7235 to the next grapheme cluster. */
7236 it
->cmp_it
.from
= it
->cmp_it
.to
;
7238 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7239 && it
->cmp_it
.from
> 0)
7241 /* Composition created while scanning backward. Proceed
7242 to the previous grapheme cluster. */
7243 it
->cmp_it
.to
= it
->cmp_it
.from
;
7247 /* No more grapheme clusters in this composition.
7248 Find the next stop position. */
7249 ptrdiff_t stop
= it
->end_charpos
;
7251 if (it
->bidi_it
.scan_dir
< 0)
7252 /* Now we are scanning backward and don't know
7255 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7256 IT_BYTEPOS (*it
), stop
, Qnil
);
7261 eassert (it
->len
!= 0);
7265 IT_BYTEPOS (*it
) += it
->len
;
7266 IT_CHARPOS (*it
) += 1;
7270 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7271 /* If this is a new paragraph, determine its base
7272 direction (a.k.a. its base embedding level). */
7273 if (it
->bidi_it
.new_paragraph
)
7274 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7276 bidi_move_to_visually_next (&it
->bidi_it
);
7277 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7278 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7279 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7281 /* As the scan direction was changed, we must
7282 re-compute the stop position for composition. */
7283 ptrdiff_t stop
= it
->end_charpos
;
7284 if (it
->bidi_it
.scan_dir
< 0)
7286 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7287 IT_BYTEPOS (*it
), stop
, Qnil
);
7290 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7294 case GET_FROM_C_STRING
:
7295 /* Current display element of IT is from a C string. */
7297 /* If the string position is beyond string's end, it means
7298 next_element_from_c_string is padding the string with
7299 blanks, in which case we bypass the bidi iterator,
7300 because it cannot deal with such virtual characters. */
7301 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7303 IT_BYTEPOS (*it
) += it
->len
;
7304 IT_CHARPOS (*it
) += 1;
7308 bidi_move_to_visually_next (&it
->bidi_it
);
7309 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7310 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7314 case GET_FROM_DISPLAY_VECTOR
:
7315 /* Current display element of IT is from a display table entry.
7316 Advance in the display table definition. Reset it to null if
7317 end reached, and continue with characters from buffers/
7319 ++it
->current
.dpvec_index
;
7321 /* Restore face of the iterator to what they were before the
7322 display vector entry (these entries may contain faces). */
7323 it
->face_id
= it
->saved_face_id
;
7325 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7327 bool recheck_faces
= it
->ellipsis_p
;
7330 it
->method
= GET_FROM_C_STRING
;
7331 else if (STRINGP (it
->string
))
7332 it
->method
= GET_FROM_STRING
;
7335 it
->method
= GET_FROM_BUFFER
;
7336 it
->object
= it
->w
->contents
;
7340 it
->current
.dpvec_index
= -1;
7342 /* Skip over characters which were displayed via IT->dpvec. */
7343 if (it
->dpvec_char_len
< 0)
7344 reseat_at_next_visible_line_start (it
, true);
7345 else if (it
->dpvec_char_len
> 0)
7347 it
->len
= it
->dpvec_char_len
;
7348 set_iterator_to_next (it
, reseat_p
);
7351 /* Maybe recheck faces after display vector. */
7354 if (it
->method
== GET_FROM_STRING
)
7355 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7357 it
->stop_charpos
= IT_CHARPOS (*it
);
7362 case GET_FROM_STRING
:
7363 /* Current display element is a character from a Lisp string. */
7364 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7365 /* Don't advance past string end. These conditions are true
7366 when set_iterator_to_next is called at the end of
7367 get_next_display_element, in which case the Lisp string is
7368 already exhausted, and all we want is pop the iterator
7370 if (it
->current
.overlay_string_index
>= 0)
7372 /* This is an overlay string, so there's no padding with
7373 spaces, and the number of characters in the string is
7374 where the string ends. */
7375 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7376 goto consider_string_end
;
7380 /* Not an overlay string. There could be padding, so test
7381 against it->end_charpos. */
7382 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7383 goto consider_string_end
;
7385 if (it
->cmp_it
.id
>= 0)
7387 /* We are delivering display elements from a composition.
7388 Update the string position past the grapheme cluster
7389 we've just processed. */
7392 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7393 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7399 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7400 bidi_move_to_visually_next (&it
->bidi_it
);
7401 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7402 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7405 /* Did we exhaust all the grapheme clusters of this
7407 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7408 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7410 /* Not all the grapheme clusters were processed yet;
7411 advance to the next cluster. */
7412 it
->cmp_it
.from
= it
->cmp_it
.to
;
7414 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7415 && it
->cmp_it
.from
> 0)
7417 /* Likewise: advance to the next cluster, but going in
7418 the reverse direction. */
7419 it
->cmp_it
.to
= it
->cmp_it
.from
;
7423 /* This composition was fully processed; find the next
7424 candidate place for checking for composed
7426 /* Always limit string searches to the string length;
7427 any padding spaces are not part of the string, and
7428 there cannot be any compositions in that padding. */
7429 ptrdiff_t stop
= SCHARS (it
->string
);
7431 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7433 else if (it
->end_charpos
< stop
)
7435 /* Cf. PRECISION in reseat_to_string: we might be
7436 limited in how many of the string characters we
7438 stop
= it
->end_charpos
;
7440 composition_compute_stop_pos (&it
->cmp_it
,
7441 IT_STRING_CHARPOS (*it
),
7442 IT_STRING_BYTEPOS (*it
), stop
,
7449 /* If the string position is beyond string's end, it
7450 means next_element_from_string is padding the string
7451 with blanks, in which case we bypass the bidi
7452 iterator, because it cannot deal with such virtual
7454 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7456 IT_STRING_BYTEPOS (*it
) += it
->len
;
7457 IT_STRING_CHARPOS (*it
) += 1;
7461 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7463 bidi_move_to_visually_next (&it
->bidi_it
);
7464 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7465 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7466 /* If the scan direction changes, we may need to update
7467 the place where to check for composed characters. */
7468 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7470 ptrdiff_t stop
= SCHARS (it
->string
);
7472 if (it
->bidi_it
.scan_dir
< 0)
7474 else if (it
->end_charpos
< stop
)
7475 stop
= it
->end_charpos
;
7477 composition_compute_stop_pos (&it
->cmp_it
,
7478 IT_STRING_CHARPOS (*it
),
7479 IT_STRING_BYTEPOS (*it
), stop
,
7485 consider_string_end
:
7487 if (it
->current
.overlay_string_index
>= 0)
7489 /* IT->string is an overlay string. Advance to the
7490 next, if there is one. */
7491 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7493 it
->ellipsis_p
= false;
7494 next_overlay_string (it
);
7496 setup_for_ellipsis (it
, 0);
7501 /* IT->string is not an overlay string. If we reached
7502 its end, and there is something on IT->stack, proceed
7503 with what is on the stack. This can be either another
7504 string, this time an overlay string, or a buffer. */
7505 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7509 if (it
->method
== GET_FROM_STRING
)
7510 goto consider_string_end
;
7515 case GET_FROM_IMAGE
:
7516 case GET_FROM_STRETCH
:
7517 /* The position etc with which we have to proceed are on
7518 the stack. The position may be at the end of a string,
7519 if the `display' property takes up the whole string. */
7520 eassert (it
->sp
> 0);
7522 if (it
->method
== GET_FROM_STRING
)
7523 goto consider_string_end
;
7527 /* There are no other methods defined, so this should be a bug. */
7531 eassert (it
->method
!= GET_FROM_STRING
7532 || (STRINGP (it
->string
)
7533 && IT_STRING_CHARPOS (*it
) >= 0));
7536 /* Load IT's display element fields with information about the next
7537 display element which comes from a display table entry or from the
7538 result of translating a control character to one of the forms `^C'
7541 IT->dpvec holds the glyphs to return as characters.
7542 IT->saved_face_id holds the face id before the display vector--it
7543 is restored into IT->face_id in set_iterator_to_next. */
7546 next_element_from_display_vector (struct it
*it
)
7549 int prev_face_id
= it
->face_id
;
7553 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7555 it
->face_id
= it
->saved_face_id
;
7557 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7558 That seemed totally bogus - so I changed it... */
7559 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7561 if (GLYPH_CODE_P (gc
))
7563 struct face
*this_face
, *prev_face
, *next_face
;
7565 it
->c
= GLYPH_CODE_CHAR (gc
);
7566 it
->len
= CHAR_BYTES (it
->c
);
7568 /* The entry may contain a face id to use. Such a face id is
7569 the id of a Lisp face, not a realized face. A face id of
7570 zero means no face is specified. */
7571 if (it
->dpvec_face_id
>= 0)
7572 it
->face_id
= it
->dpvec_face_id
;
7575 int lface_id
= GLYPH_CODE_FACE (gc
);
7577 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7581 /* Glyphs in the display vector could have the box face, so we
7582 need to set the related flags in the iterator, as
7584 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7585 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7587 /* Is this character the first character of a box-face run? */
7588 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7590 || prev_face
->box
== FACE_NO_BOX
));
7592 /* For the last character of the box-face run, we need to look
7593 either at the next glyph from the display vector, or at the
7594 face we saw before the display vector. */
7595 next_face_id
= it
->saved_face_id
;
7596 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7598 if (it
->dpvec_face_id
>= 0)
7599 next_face_id
= it
->dpvec_face_id
;
7603 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7606 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7610 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7611 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7613 || next_face
->box
== FACE_NO_BOX
));
7614 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7617 /* Display table entry is invalid. Return a space. */
7618 it
->c
= ' ', it
->len
= 1;
7620 /* Don't change position and object of the iterator here. They are
7621 still the values of the character that had this display table
7622 entry or was translated, and that's what we want. */
7623 it
->what
= IT_CHARACTER
;
7627 /* Get the first element of string/buffer in the visual order, after
7628 being reseated to a new position in a string or a buffer. */
7630 get_visually_first_element (struct it
*it
)
7632 bool string_p
= STRINGP (it
->string
) || it
->s
;
7633 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7634 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7636 if (STRINGP (it
->string
))
7638 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7639 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7643 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7644 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7647 if (it
->bidi_it
.charpos
== eob
)
7649 /* Nothing to do, but reset the FIRST_ELT flag, like
7650 bidi_paragraph_init does, because we are not going to
7652 it
->bidi_it
.first_elt
= false;
7654 else if (it
->bidi_it
.charpos
== bob
7656 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7657 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7659 /* If we are at the beginning of a line/string, we can produce
7660 the next element right away. */
7661 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7662 bidi_move_to_visually_next (&it
->bidi_it
);
7666 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7668 /* We need to prime the bidi iterator starting at the line's or
7669 string's beginning, before we will be able to produce the
7672 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7674 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7675 IT_BYTEPOS (*it
), -1,
7676 &it
->bidi_it
.bytepos
);
7677 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7680 /* Now return to buffer/string position where we were asked
7681 to get the next display element, and produce that. */
7682 bidi_move_to_visually_next (&it
->bidi_it
);
7684 while (it
->bidi_it
.bytepos
!= orig_bytepos
7685 && it
->bidi_it
.charpos
< eob
);
7688 /* Adjust IT's position information to where we ended up. */
7689 if (STRINGP (it
->string
))
7691 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7692 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7696 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7697 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7700 if (STRINGP (it
->string
) || !it
->s
)
7702 ptrdiff_t stop
, charpos
, bytepos
;
7704 if (STRINGP (it
->string
))
7707 stop
= SCHARS (it
->string
);
7708 if (stop
> it
->end_charpos
)
7709 stop
= it
->end_charpos
;
7710 charpos
= IT_STRING_CHARPOS (*it
);
7711 bytepos
= IT_STRING_BYTEPOS (*it
);
7715 stop
= it
->end_charpos
;
7716 charpos
= IT_CHARPOS (*it
);
7717 bytepos
= IT_BYTEPOS (*it
);
7719 if (it
->bidi_it
.scan_dir
< 0)
7721 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7726 /* Load IT with the next display element from Lisp string IT->string.
7727 IT->current.string_pos is the current position within the string.
7728 If IT->current.overlay_string_index >= 0, the Lisp string is an
7732 next_element_from_string (struct it
*it
)
7734 struct text_pos position
;
7736 eassert (STRINGP (it
->string
));
7737 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7738 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7739 position
= it
->current
.string_pos
;
7741 /* With bidi reordering, the character to display might not be the
7742 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7743 that we were reseat()ed to a new string, whose paragraph
7744 direction is not known. */
7745 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7747 get_visually_first_element (it
);
7748 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7751 /* Time to check for invisible text? */
7752 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7754 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7757 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7758 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7760 /* With bidi non-linear iteration, we could find
7761 ourselves far beyond the last computed stop_charpos,
7762 with several other stop positions in between that we
7763 missed. Scan them all now, in buffer's logical
7764 order, until we find and handle the last stop_charpos
7765 that precedes our current position. */
7766 handle_stop_backwards (it
, it
->stop_charpos
);
7767 return GET_NEXT_DISPLAY_ELEMENT (it
);
7773 /* Take note of the stop position we just moved
7774 across, for when we will move back across it. */
7775 it
->prev_stop
= it
->stop_charpos
;
7776 /* If we are at base paragraph embedding level, take
7777 note of the last stop position seen at this
7779 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7780 it
->base_level_stop
= it
->stop_charpos
;
7784 /* Since a handler may have changed IT->method, we must
7786 return GET_NEXT_DISPLAY_ELEMENT (it
);
7790 /* If we are before prev_stop, we may have overstepped
7791 on our way backwards a stop_pos, and if so, we need
7792 to handle that stop_pos. */
7793 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7794 /* We can sometimes back up for reasons that have nothing
7795 to do with bidi reordering. E.g., compositions. The
7796 code below is only needed when we are above the base
7797 embedding level, so test for that explicitly. */
7798 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7800 /* If we lost track of base_level_stop, we have no better
7801 place for handle_stop_backwards to start from than string
7802 beginning. This happens, e.g., when we were reseated to
7803 the previous screenful of text by vertical-motion. */
7804 if (it
->base_level_stop
<= 0
7805 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7806 it
->base_level_stop
= 0;
7807 handle_stop_backwards (it
, it
->base_level_stop
);
7808 return GET_NEXT_DISPLAY_ELEMENT (it
);
7812 if (it
->current
.overlay_string_index
>= 0)
7814 /* Get the next character from an overlay string. In overlay
7815 strings, there is no field width or padding with spaces to
7817 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7822 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7823 IT_STRING_BYTEPOS (*it
),
7824 it
->bidi_it
.scan_dir
< 0
7826 : SCHARS (it
->string
))
7827 && next_element_from_composition (it
))
7831 else if (STRING_MULTIBYTE (it
->string
))
7833 const unsigned char *s
= (SDATA (it
->string
)
7834 + IT_STRING_BYTEPOS (*it
));
7835 it
->c
= string_char_and_length (s
, &it
->len
);
7839 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7845 /* Get the next character from a Lisp string that is not an
7846 overlay string. Such strings come from the mode line, for
7847 example. We may have to pad with spaces, or truncate the
7848 string. See also next_element_from_c_string. */
7849 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7854 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7856 /* Pad with spaces. */
7857 it
->c
= ' ', it
->len
= 1;
7858 CHARPOS (position
) = BYTEPOS (position
) = -1;
7860 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7861 IT_STRING_BYTEPOS (*it
),
7862 it
->bidi_it
.scan_dir
< 0
7864 : it
->string_nchars
)
7865 && next_element_from_composition (it
))
7869 else if (STRING_MULTIBYTE (it
->string
))
7871 const unsigned char *s
= (SDATA (it
->string
)
7872 + IT_STRING_BYTEPOS (*it
));
7873 it
->c
= string_char_and_length (s
, &it
->len
);
7877 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7882 /* Record what we have and where it came from. */
7883 it
->what
= IT_CHARACTER
;
7884 it
->object
= it
->string
;
7885 it
->position
= position
;
7890 /* Load IT with next display element from C string IT->s.
7891 IT->string_nchars is the maximum number of characters to return
7892 from the string. IT->end_charpos may be greater than
7893 IT->string_nchars when this function is called, in which case we
7894 may have to return padding spaces. Value is false if end of string
7895 reached, including padding spaces. */
7898 next_element_from_c_string (struct it
*it
)
7900 bool success_p
= true;
7903 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7904 it
->what
= IT_CHARACTER
;
7905 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7906 it
->object
= make_number (0);
7908 /* With bidi reordering, the character to display might not be the
7909 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7910 we were reseated to a new string, whose paragraph direction is
7912 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7913 get_visually_first_element (it
);
7915 /* IT's position can be greater than IT->string_nchars in case a
7916 field width or precision has been specified when the iterator was
7918 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7920 /* End of the game. */
7924 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7926 /* Pad with spaces. */
7927 it
->c
= ' ', it
->len
= 1;
7928 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7930 else if (it
->multibyte_p
)
7931 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7933 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7939 /* Set up IT to return characters from an ellipsis, if appropriate.
7940 The definition of the ellipsis glyphs may come from a display table
7941 entry. This function fills IT with the first glyph from the
7942 ellipsis if an ellipsis is to be displayed. */
7945 next_element_from_ellipsis (struct it
*it
)
7947 if (it
->selective_display_ellipsis_p
)
7948 setup_for_ellipsis (it
, it
->len
);
7951 /* The face at the current position may be different from the
7952 face we find after the invisible text. Remember what it
7953 was in IT->saved_face_id, and signal that it's there by
7954 setting face_before_selective_p. */
7955 it
->saved_face_id
= it
->face_id
;
7956 it
->method
= GET_FROM_BUFFER
;
7957 it
->object
= it
->w
->contents
;
7958 reseat_at_next_visible_line_start (it
, true);
7959 it
->face_before_selective_p
= true;
7962 return GET_NEXT_DISPLAY_ELEMENT (it
);
7966 /* Deliver an image display element. The iterator IT is already
7967 filled with image information (done in handle_display_prop). Value
7972 next_element_from_image (struct it
*it
)
7974 it
->what
= IT_IMAGE
;
7979 /* Fill iterator IT with next display element from a stretch glyph
7980 property. IT->object is the value of the text property. Value is
7984 next_element_from_stretch (struct it
*it
)
7986 it
->what
= IT_STRETCH
;
7990 /* Scan backwards from IT's current position until we find a stop
7991 position, or until BEGV. This is called when we find ourself
7992 before both the last known prev_stop and base_level_stop while
7993 reordering bidirectional text. */
7996 compute_stop_pos_backwards (struct it
*it
)
7998 const int SCAN_BACK_LIMIT
= 1000;
7999 struct text_pos pos
;
8000 struct display_pos save_current
= it
->current
;
8001 struct text_pos save_position
= it
->position
;
8002 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8003 ptrdiff_t where_we_are
= charpos
;
8004 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8005 ptrdiff_t save_end_pos
= it
->end_charpos
;
8007 eassert (NILP (it
->string
) && !it
->s
);
8008 eassert (it
->bidi_p
);
8012 it
->end_charpos
= min (charpos
+ 1, ZV
);
8013 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8014 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8015 reseat_1 (it
, pos
, false);
8016 compute_stop_pos (it
);
8017 /* We must advance forward, right? */
8018 if (it
->stop_charpos
<= charpos
)
8021 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8023 if (it
->stop_charpos
<= where_we_are
)
8024 it
->prev_stop
= it
->stop_charpos
;
8026 it
->prev_stop
= BEGV
;
8028 it
->current
= save_current
;
8029 it
->position
= save_position
;
8030 it
->stop_charpos
= save_stop_pos
;
8031 it
->end_charpos
= save_end_pos
;
8034 /* Scan forward from CHARPOS in the current buffer/string, until we
8035 find a stop position > current IT's position. Then handle the stop
8036 position before that. This is called when we bump into a stop
8037 position while reordering bidirectional text. CHARPOS should be
8038 the last previously processed stop_pos (or BEGV/0, if none were
8039 processed yet) whose position is less that IT's current
8043 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8045 bool bufp
= !STRINGP (it
->string
);
8046 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8047 struct display_pos save_current
= it
->current
;
8048 struct text_pos save_position
= it
->position
;
8049 struct text_pos pos1
;
8050 ptrdiff_t next_stop
;
8052 /* Scan in strict logical order. */
8053 eassert (it
->bidi_p
);
8057 it
->prev_stop
= charpos
;
8060 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8061 reseat_1 (it
, pos1
, false);
8064 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8065 compute_stop_pos (it
);
8066 /* We must advance forward, right? */
8067 if (it
->stop_charpos
<= it
->prev_stop
)
8069 charpos
= it
->stop_charpos
;
8071 while (charpos
<= where_we_are
);
8074 it
->current
= save_current
;
8075 it
->position
= save_position
;
8076 next_stop
= it
->stop_charpos
;
8077 it
->stop_charpos
= it
->prev_stop
;
8079 it
->stop_charpos
= next_stop
;
8082 /* Load IT with the next display element from current_buffer. Value
8083 is false if end of buffer reached. IT->stop_charpos is the next
8084 position at which to stop and check for text properties or buffer
8088 next_element_from_buffer (struct it
*it
)
8090 bool success_p
= true;
8092 eassert (IT_CHARPOS (*it
) >= BEGV
);
8093 eassert (NILP (it
->string
) && !it
->s
);
8094 eassert (!it
->bidi_p
8095 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8096 && it
->bidi_it
.string
.s
== NULL
));
8098 /* With bidi reordering, the character to display might not be the
8099 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8100 we were reseat()ed to a new buffer position, which is potentially
8101 a different paragraph. */
8102 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8104 get_visually_first_element (it
);
8105 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8108 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8110 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8112 bool overlay_strings_follow_p
;
8114 /* End of the game, except when overlay strings follow that
8115 haven't been returned yet. */
8116 if (it
->overlay_strings_at_end_processed_p
)
8117 overlay_strings_follow_p
= false;
8120 it
->overlay_strings_at_end_processed_p
= true;
8121 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8124 if (overlay_strings_follow_p
)
8125 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8129 it
->position
= it
->current
.pos
;
8133 else if (!(!it
->bidi_p
8134 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8135 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8137 /* With bidi non-linear iteration, we could find ourselves
8138 far beyond the last computed stop_charpos, with several
8139 other stop positions in between that we missed. Scan
8140 them all now, in buffer's logical order, until we find
8141 and handle the last stop_charpos that precedes our
8142 current position. */
8143 handle_stop_backwards (it
, it
->stop_charpos
);
8144 it
->ignore_overlay_strings_at_pos_p
= false;
8145 return GET_NEXT_DISPLAY_ELEMENT (it
);
8151 /* Take note of the stop position we just moved across,
8152 for when we will move back across it. */
8153 it
->prev_stop
= it
->stop_charpos
;
8154 /* If we are at base paragraph embedding level, take
8155 note of the last stop position seen at this
8157 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8158 it
->base_level_stop
= it
->stop_charpos
;
8161 it
->ignore_overlay_strings_at_pos_p
= false;
8162 return GET_NEXT_DISPLAY_ELEMENT (it
);
8166 /* If we are before prev_stop, we may have overstepped on
8167 our way backwards a stop_pos, and if so, we need to
8168 handle that stop_pos. */
8169 && IT_CHARPOS (*it
) < it
->prev_stop
8170 /* We can sometimes back up for reasons that have nothing
8171 to do with bidi reordering. E.g., compositions. The
8172 code below is only needed when we are above the base
8173 embedding level, so test for that explicitly. */
8174 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8176 if (it
->base_level_stop
<= 0
8177 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8179 /* If we lost track of base_level_stop, we need to find
8180 prev_stop by looking backwards. This happens, e.g., when
8181 we were reseated to the previous screenful of text by
8183 it
->base_level_stop
= BEGV
;
8184 compute_stop_pos_backwards (it
);
8185 handle_stop_backwards (it
, it
->prev_stop
);
8188 handle_stop_backwards (it
, it
->base_level_stop
);
8189 it
->ignore_overlay_strings_at_pos_p
= false;
8190 return GET_NEXT_DISPLAY_ELEMENT (it
);
8194 /* No face changes, overlays etc. in sight, so just return a
8195 character from current_buffer. */
8199 /* We moved to the next buffer position, so any info about
8200 previously seen overlays is no longer valid. */
8201 it
->ignore_overlay_strings_at_pos_p
= false;
8203 /* Maybe run the redisplay end trigger hook. Performance note:
8204 This doesn't seem to cost measurable time. */
8205 if (it
->redisplay_end_trigger_charpos
8207 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8208 run_redisplay_end_trigger_hook (it
);
8210 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8211 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8213 && next_element_from_composition (it
))
8218 /* Get the next character, maybe multibyte. */
8219 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8220 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8221 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8223 it
->c
= *p
, it
->len
= 1;
8225 /* Record what we have and where it came from. */
8226 it
->what
= IT_CHARACTER
;
8227 it
->object
= it
->w
->contents
;
8228 it
->position
= it
->current
.pos
;
8230 /* Normally we return the character found above, except when we
8231 really want to return an ellipsis for selective display. */
8236 /* A value of selective > 0 means hide lines indented more
8237 than that number of columns. */
8238 if (it
->selective
> 0
8239 && IT_CHARPOS (*it
) + 1 < ZV
8240 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8241 IT_BYTEPOS (*it
) + 1,
8244 success_p
= next_element_from_ellipsis (it
);
8245 it
->dpvec_char_len
= -1;
8248 else if (it
->c
== '\r' && it
->selective
== -1)
8250 /* A value of selective == -1 means that everything from the
8251 CR to the end of the line is invisible, with maybe an
8252 ellipsis displayed for it. */
8253 success_p
= next_element_from_ellipsis (it
);
8254 it
->dpvec_char_len
= -1;
8259 /* Value is false if end of buffer reached. */
8260 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8265 /* Run the redisplay end trigger hook for IT. */
8268 run_redisplay_end_trigger_hook (struct it
*it
)
8270 /* IT->glyph_row should be non-null, i.e. we should be actually
8271 displaying something, or otherwise we should not run the hook. */
8272 eassert (it
->glyph_row
);
8274 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8275 it
->redisplay_end_trigger_charpos
= 0;
8277 /* Since we are *trying* to run these functions, don't try to run
8278 them again, even if they get an error. */
8279 wset_redisplay_end_trigger (it
->w
, Qnil
);
8280 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8281 make_number (charpos
));
8283 /* Notice if it changed the face of the character we are on. */
8284 handle_face_prop (it
);
8288 /* Deliver a composition display element. Unlike the other
8289 next_element_from_XXX, this function is not registered in the array
8290 get_next_element[]. It is called from next_element_from_buffer and
8291 next_element_from_string when necessary. */
8294 next_element_from_composition (struct it
*it
)
8296 it
->what
= IT_COMPOSITION
;
8297 it
->len
= it
->cmp_it
.nbytes
;
8298 if (STRINGP (it
->string
))
8302 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8303 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8306 it
->position
= it
->current
.string_pos
;
8307 it
->object
= it
->string
;
8308 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8309 IT_STRING_BYTEPOS (*it
), it
->string
);
8315 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8316 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8319 if (it
->bidi_it
.new_paragraph
)
8320 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8322 /* Resync the bidi iterator with IT's new position.
8323 FIXME: this doesn't support bidirectional text. */
8324 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8325 bidi_move_to_visually_next (&it
->bidi_it
);
8329 it
->position
= it
->current
.pos
;
8330 it
->object
= it
->w
->contents
;
8331 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8332 IT_BYTEPOS (*it
), Qnil
);
8339 /***********************************************************************
8340 Moving an iterator without producing glyphs
8341 ***********************************************************************/
8343 /* Check if iterator is at a position corresponding to a valid buffer
8344 position after some move_it_ call. */
8346 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8347 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8350 /* Move iterator IT to a specified buffer or X position within one
8351 line on the display without producing glyphs.
8353 OP should be a bit mask including some or all of these bits:
8354 MOVE_TO_X: Stop upon reaching x-position TO_X.
8355 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8356 Regardless of OP's value, stop upon reaching the end of the display line.
8358 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8359 This means, in particular, that TO_X includes window's horizontal
8362 The return value has several possible values that
8363 say what condition caused the scan to stop:
8365 MOVE_POS_MATCH_OR_ZV
8366 - when TO_POS or ZV was reached.
8369 -when TO_X was reached before TO_POS or ZV were reached.
8372 - when we reached the end of the display area and the line must
8376 - when we reached the end of the display area and the line is
8380 - when we stopped at a line end, i.e. a newline or a CR and selective
8383 static enum move_it_result
8384 move_it_in_display_line_to (struct it
*it
,
8385 ptrdiff_t to_charpos
, int to_x
,
8386 enum move_operation_enum op
)
8388 enum move_it_result result
= MOVE_UNDEFINED
;
8389 struct glyph_row
*saved_glyph_row
;
8390 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8391 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8392 void *ppos_data
= NULL
;
8393 bool may_wrap
= false;
8394 enum it_method prev_method
= it
->method
;
8395 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8396 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8398 /* Don't produce glyphs in produce_glyphs. */
8399 saved_glyph_row
= it
->glyph_row
;
8400 it
->glyph_row
= NULL
;
8402 /* Use wrap_it to save a copy of IT wherever a word wrap could
8403 occur. Use atpos_it to save a copy of IT at the desired buffer
8404 position, if found, so that we can scan ahead and check if the
8405 word later overshoots the window edge. Use atx_it similarly, for
8411 /* Use ppos_it under bidi reordering to save a copy of IT for the
8412 initial position. We restore that position in IT when we have
8413 scanned the entire display line without finding a match for
8414 TO_CHARPOS and all the character positions are greater than
8415 TO_CHARPOS. We then restart the scan from the initial position,
8416 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8417 the closest to TO_CHARPOS. */
8420 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8422 SAVE_IT (ppos_it
, *it
, ppos_data
);
8423 closest_pos
= IT_CHARPOS (*it
);
8429 #define BUFFER_POS_REACHED_P() \
8430 ((op & MOVE_TO_POS) != 0 \
8431 && BUFFERP (it->object) \
8432 && (IT_CHARPOS (*it) == to_charpos \
8434 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8435 && IT_CHARPOS (*it) > to_charpos) \
8436 || (it->what == IT_COMPOSITION \
8437 && ((IT_CHARPOS (*it) > to_charpos \
8438 && to_charpos >= it->cmp_it.charpos) \
8439 || (IT_CHARPOS (*it) < to_charpos \
8440 && to_charpos <= it->cmp_it.charpos)))) \
8441 && (it->method == GET_FROM_BUFFER \
8442 || (it->method == GET_FROM_DISPLAY_VECTOR \
8443 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8445 /* If there's a line-/wrap-prefix, handle it. */
8446 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8447 && it
->current_y
< it
->last_visible_y
)
8448 handle_line_prefix (it
);
8450 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8451 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8455 int x
, i
, ascent
= 0, descent
= 0;
8457 /* Utility macro to reset an iterator with x, ascent, and descent. */
8458 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8459 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8460 (IT)->max_descent = descent)
8462 /* Stop if we move beyond TO_CHARPOS (after an image or a
8463 display string or stretch glyph). */
8464 if ((op
& MOVE_TO_POS
) != 0
8465 && BUFFERP (it
->object
)
8466 && it
->method
== GET_FROM_BUFFER
8468 /* When the iterator is at base embedding level, we
8469 are guaranteed that characters are delivered for
8470 display in strictly increasing order of their
8471 buffer positions. */
8472 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8473 && IT_CHARPOS (*it
) > to_charpos
)
8475 && (prev_method
== GET_FROM_IMAGE
8476 || prev_method
== GET_FROM_STRETCH
8477 || prev_method
== GET_FROM_STRING
)
8478 /* Passed TO_CHARPOS from left to right. */
8479 && ((prev_pos
< to_charpos
8480 && IT_CHARPOS (*it
) > to_charpos
)
8481 /* Passed TO_CHARPOS from right to left. */
8482 || (prev_pos
> to_charpos
8483 && IT_CHARPOS (*it
) < to_charpos
)))))
8485 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8487 result
= MOVE_POS_MATCH_OR_ZV
;
8490 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8491 /* If wrap_it is valid, the current position might be in a
8492 word that is wrapped. So, save the iterator in
8493 atpos_it and continue to see if wrapping happens. */
8494 SAVE_IT (atpos_it
, *it
, atpos_data
);
8497 /* Stop when ZV reached.
8498 We used to stop here when TO_CHARPOS reached as well, but that is
8499 too soon if this glyph does not fit on this line. So we handle it
8500 explicitly below. */
8501 if (!get_next_display_element (it
))
8503 result
= MOVE_POS_MATCH_OR_ZV
;
8507 if (it
->line_wrap
== TRUNCATE
)
8509 if (BUFFER_POS_REACHED_P ())
8511 result
= MOVE_POS_MATCH_OR_ZV
;
8517 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8519 if (IT_DISPLAYING_WHITESPACE (it
))
8523 /* We have reached a glyph that follows one or more
8524 whitespace characters. If the position is
8525 already found, we are done. */
8526 if (atpos_it
.sp
>= 0)
8528 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8529 result
= MOVE_POS_MATCH_OR_ZV
;
8534 RESTORE_IT (it
, &atx_it
, atx_data
);
8535 result
= MOVE_X_REACHED
;
8538 /* Otherwise, we can wrap here. */
8539 SAVE_IT (wrap_it
, *it
, wrap_data
);
8545 /* Remember the line height for the current line, in case
8546 the next element doesn't fit on the line. */
8547 ascent
= it
->max_ascent
;
8548 descent
= it
->max_descent
;
8550 /* The call to produce_glyphs will get the metrics of the
8551 display element IT is loaded with. Record the x-position
8552 before this display element, in case it doesn't fit on the
8556 PRODUCE_GLYPHS (it
);
8558 if (it
->area
!= TEXT_AREA
)
8560 prev_method
= it
->method
;
8561 if (it
->method
== GET_FROM_BUFFER
)
8562 prev_pos
= IT_CHARPOS (*it
);
8563 set_iterator_to_next (it
, true);
8564 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8565 SET_TEXT_POS (this_line_min_pos
,
8566 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8568 && (op
& MOVE_TO_POS
)
8569 && IT_CHARPOS (*it
) > to_charpos
8570 && IT_CHARPOS (*it
) < closest_pos
)
8571 closest_pos
= IT_CHARPOS (*it
);
8575 /* The number of glyphs we get back in IT->nglyphs will normally
8576 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8577 character on a terminal frame, or (iii) a line end. For the
8578 second case, IT->nglyphs - 1 padding glyphs will be present.
8579 (On X frames, there is only one glyph produced for a
8580 composite character.)
8582 The behavior implemented below means, for continuation lines,
8583 that as many spaces of a TAB as fit on the current line are
8584 displayed there. For terminal frames, as many glyphs of a
8585 multi-glyph character are displayed in the current line, too.
8586 This is what the old redisplay code did, and we keep it that
8587 way. Under X, the whole shape of a complex character must
8588 fit on the line or it will be completely displayed in the
8591 Note that both for tabs and padding glyphs, all glyphs have
8595 /* More than one glyph or glyph doesn't fit on line. All
8596 glyphs have the same width. */
8597 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8599 int x_before_this_char
= x
;
8600 int hpos_before_this_char
= it
->hpos
;
8602 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8604 new_x
= x
+ single_glyph_width
;
8606 /* We want to leave anything reaching TO_X to the caller. */
8607 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8609 if (BUFFER_POS_REACHED_P ())
8611 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8612 goto buffer_pos_reached
;
8613 if (atpos_it
.sp
< 0)
8615 SAVE_IT (atpos_it
, *it
, atpos_data
);
8616 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8621 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8624 result
= MOVE_X_REACHED
;
8629 SAVE_IT (atx_it
, *it
, atx_data
);
8630 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8635 if (/* Lines are continued. */
8636 it
->line_wrap
!= TRUNCATE
8637 && (/* And glyph doesn't fit on the line. */
8638 new_x
> it
->last_visible_x
8639 /* Or it fits exactly and we're on a window
8641 || (new_x
== it
->last_visible_x
8642 && FRAME_WINDOW_P (it
->f
)
8643 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8644 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8645 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8647 if (/* IT->hpos == 0 means the very first glyph
8648 doesn't fit on the line, e.g. a wide image. */
8650 || (new_x
== it
->last_visible_x
8651 && FRAME_WINDOW_P (it
->f
)))
8654 it
->current_x
= new_x
;
8656 /* The character's last glyph just barely fits
8658 if (i
== it
->nglyphs
- 1)
8660 /* If this is the destination position,
8661 return a position *before* it in this row,
8662 now that we know it fits in this row. */
8663 if (BUFFER_POS_REACHED_P ())
8665 if (it
->line_wrap
!= WORD_WRAP
8667 /* If we've just found whitespace to
8668 wrap, effectively ignore the
8669 previous wrap point -- it is no
8670 longer relevant, but we won't
8671 have an opportunity to update it,
8672 since we've reached the edge of
8673 this screen line. */
8675 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8677 it
->hpos
= hpos_before_this_char
;
8678 it
->current_x
= x_before_this_char
;
8679 result
= MOVE_POS_MATCH_OR_ZV
;
8682 if (it
->line_wrap
== WORD_WRAP
8685 SAVE_IT (atpos_it
, *it
, atpos_data
);
8686 atpos_it
.current_x
= x_before_this_char
;
8687 atpos_it
.hpos
= hpos_before_this_char
;
8691 prev_method
= it
->method
;
8692 if (it
->method
== GET_FROM_BUFFER
)
8693 prev_pos
= IT_CHARPOS (*it
);
8694 set_iterator_to_next (it
, true);
8695 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8696 SET_TEXT_POS (this_line_min_pos
,
8697 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8698 /* On graphical terminals, newlines may
8699 "overflow" into the fringe if
8700 overflow-newline-into-fringe is non-nil.
8701 On text terminals, and on graphical
8702 terminals with no right margin, newlines
8703 may overflow into the last glyph on the
8705 if (!FRAME_WINDOW_P (it
->f
)
8707 && it
->bidi_it
.paragraph_dir
== R2L
)
8708 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8709 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8710 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8712 if (!get_next_display_element (it
))
8714 result
= MOVE_POS_MATCH_OR_ZV
;
8717 if (BUFFER_POS_REACHED_P ())
8719 if (ITERATOR_AT_END_OF_LINE_P (it
))
8720 result
= MOVE_POS_MATCH_OR_ZV
;
8722 result
= MOVE_LINE_CONTINUED
;
8725 if (ITERATOR_AT_END_OF_LINE_P (it
)
8726 && (it
->line_wrap
!= WORD_WRAP
8728 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8730 result
= MOVE_NEWLINE_OR_CR
;
8737 IT_RESET_X_ASCENT_DESCENT (it
);
8739 /* If the screen line ends with whitespace, and we
8740 are under word-wrap, don't use wrap_it: it is no
8741 longer relevant, but we won't have an opportunity
8742 to update it, since we are done with this screen
8744 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8746 /* If we've found TO_X, go back there, as we now
8747 know the last word fits on this screen line. */
8748 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8751 RESTORE_IT (it
, &atx_it
, atx_data
);
8754 result
= MOVE_X_REACHED
;
8758 else if (wrap_it
.sp
>= 0)
8760 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8765 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8767 result
= MOVE_LINE_CONTINUED
;
8771 if (BUFFER_POS_REACHED_P ())
8773 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8774 goto buffer_pos_reached
;
8775 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8777 SAVE_IT (atpos_it
, *it
, atpos_data
);
8778 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8782 if (new_x
> it
->first_visible_x
)
8784 /* Glyph is visible. Increment number of glyphs that
8785 would be displayed. */
8790 if (result
!= MOVE_UNDEFINED
)
8793 else if (BUFFER_POS_REACHED_P ())
8796 IT_RESET_X_ASCENT_DESCENT (it
);
8797 result
= MOVE_POS_MATCH_OR_ZV
;
8800 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8802 /* Stop when TO_X specified and reached. This check is
8803 necessary here because of lines consisting of a line end,
8804 only. The line end will not produce any glyphs and we
8805 would never get MOVE_X_REACHED. */
8806 eassert (it
->nglyphs
== 0);
8807 result
= MOVE_X_REACHED
;
8811 /* Is this a line end? If yes, we're done. */
8812 if (ITERATOR_AT_END_OF_LINE_P (it
))
8814 /* If we are past TO_CHARPOS, but never saw any character
8815 positions smaller than TO_CHARPOS, return
8816 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8818 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8820 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8822 if (closest_pos
< ZV
)
8824 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8825 /* Don't recurse if closest_pos is equal to
8826 to_charpos, since we have just tried that. */
8827 if (closest_pos
!= to_charpos
)
8828 move_it_in_display_line_to (it
, closest_pos
, -1,
8830 result
= MOVE_POS_MATCH_OR_ZV
;
8833 goto buffer_pos_reached
;
8835 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8836 && IT_CHARPOS (*it
) > to_charpos
)
8837 goto buffer_pos_reached
;
8839 result
= MOVE_NEWLINE_OR_CR
;
8842 result
= MOVE_NEWLINE_OR_CR
;
8846 prev_method
= it
->method
;
8847 if (it
->method
== GET_FROM_BUFFER
)
8848 prev_pos
= IT_CHARPOS (*it
);
8849 /* The current display element has been consumed. Advance
8851 set_iterator_to_next (it
, true);
8852 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8853 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8854 if (IT_CHARPOS (*it
) < to_charpos
)
8855 saw_smaller_pos
= true;
8857 && (op
& MOVE_TO_POS
)
8858 && IT_CHARPOS (*it
) >= to_charpos
8859 && IT_CHARPOS (*it
) < closest_pos
)
8860 closest_pos
= IT_CHARPOS (*it
);
8862 /* Stop if lines are truncated and IT's current x-position is
8863 past the right edge of the window now. */
8864 if (it
->line_wrap
== TRUNCATE
8865 && it
->current_x
>= it
->last_visible_x
)
8867 if (!FRAME_WINDOW_P (it
->f
)
8868 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8869 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8870 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8871 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8873 bool at_eob_p
= false;
8875 if ((at_eob_p
= !get_next_display_element (it
))
8876 || BUFFER_POS_REACHED_P ()
8877 /* If we are past TO_CHARPOS, but never saw any
8878 character positions smaller than TO_CHARPOS,
8879 return MOVE_POS_MATCH_OR_ZV, like the
8880 unidirectional display did. */
8881 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8883 && IT_CHARPOS (*it
) > to_charpos
))
8886 && !BUFFER_POS_REACHED_P ()
8887 && !at_eob_p
&& closest_pos
< ZV
)
8889 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8890 if (closest_pos
!= to_charpos
)
8891 move_it_in_display_line_to (it
, closest_pos
, -1,
8894 result
= MOVE_POS_MATCH_OR_ZV
;
8897 if (ITERATOR_AT_END_OF_LINE_P (it
))
8899 result
= MOVE_NEWLINE_OR_CR
;
8903 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8905 && IT_CHARPOS (*it
) > to_charpos
)
8907 if (closest_pos
< ZV
)
8909 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8910 if (closest_pos
!= to_charpos
)
8911 move_it_in_display_line_to (it
, closest_pos
, -1,
8914 result
= MOVE_POS_MATCH_OR_ZV
;
8917 result
= MOVE_LINE_TRUNCATED
;
8920 #undef IT_RESET_X_ASCENT_DESCENT
8923 #undef BUFFER_POS_REACHED_P
8925 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8926 restore the saved iterator. */
8927 if (atpos_it
.sp
>= 0)
8928 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8929 else if (atx_it
.sp
>= 0)
8930 RESTORE_IT (it
, &atx_it
, atx_data
);
8935 bidi_unshelve_cache (atpos_data
, true);
8937 bidi_unshelve_cache (atx_data
, true);
8939 bidi_unshelve_cache (wrap_data
, true);
8941 bidi_unshelve_cache (ppos_data
, true);
8943 /* Restore the iterator settings altered at the beginning of this
8945 it
->glyph_row
= saved_glyph_row
;
8949 /* For external use. */
8951 move_it_in_display_line (struct it
*it
,
8952 ptrdiff_t to_charpos
, int to_x
,
8953 enum move_operation_enum op
)
8955 if (it
->line_wrap
== WORD_WRAP
8956 && (op
& MOVE_TO_X
))
8959 void *save_data
= NULL
;
8962 SAVE_IT (save_it
, *it
, save_data
);
8963 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8964 /* When word-wrap is on, TO_X may lie past the end
8965 of a wrapped line. Then it->current is the
8966 character on the next line, so backtrack to the
8967 space before the wrap point. */
8968 if (skip
== MOVE_LINE_CONTINUED
)
8970 int prev_x
= max (it
->current_x
- 1, 0);
8971 RESTORE_IT (it
, &save_it
, save_data
);
8972 move_it_in_display_line_to
8973 (it
, -1, prev_x
, MOVE_TO_X
);
8976 bidi_unshelve_cache (save_data
, true);
8979 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8983 /* Move IT forward until it satisfies one or more of the criteria in
8984 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8986 OP is a bit-mask that specifies where to stop, and in particular,
8987 which of those four position arguments makes a difference. See the
8988 description of enum move_operation_enum.
8990 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8991 screen line, this function will set IT to the next position that is
8992 displayed to the right of TO_CHARPOS on the screen.
8994 Return the maximum pixel length of any line scanned but never more
8995 than it.last_visible_x. */
8998 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9000 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9001 int line_height
, line_start_x
= 0, reached
= 0;
9002 int max_current_x
= 0;
9003 void *backup_data
= NULL
;
9007 if (op
& MOVE_TO_VPOS
)
9009 /* If no TO_CHARPOS and no TO_X specified, stop at the
9010 start of the line TO_VPOS. */
9011 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9013 if (it
->vpos
== to_vpos
)
9019 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9023 /* TO_VPOS >= 0 means stop at TO_X in the line at
9024 TO_VPOS, or at TO_POS, whichever comes first. */
9025 if (it
->vpos
== to_vpos
)
9031 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9033 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9038 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9040 /* We have reached TO_X but not in the line we want. */
9041 skip
= move_it_in_display_line_to (it
, to_charpos
,
9043 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9051 else if (op
& MOVE_TO_Y
)
9053 struct it it_backup
;
9055 if (it
->line_wrap
== WORD_WRAP
)
9056 SAVE_IT (it_backup
, *it
, backup_data
);
9058 /* TO_Y specified means stop at TO_X in the line containing
9059 TO_Y---or at TO_CHARPOS if this is reached first. The
9060 problem is that we can't really tell whether the line
9061 contains TO_Y before we have completely scanned it, and
9062 this may skip past TO_X. What we do is to first scan to
9065 If TO_X is not specified, use a TO_X of zero. The reason
9066 is to make the outcome of this function more predictable.
9067 If we didn't use TO_X == 0, we would stop at the end of
9068 the line which is probably not what a caller would expect
9070 skip
= move_it_in_display_line_to
9071 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9072 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9074 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9075 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9077 else if (skip
== MOVE_X_REACHED
)
9079 /* If TO_X was reached, we want to know whether TO_Y is
9080 in the line. We know this is the case if the already
9081 scanned glyphs make the line tall enough. Otherwise,
9082 we must check by scanning the rest of the line. */
9083 line_height
= it
->max_ascent
+ it
->max_descent
;
9084 if (to_y
>= it
->current_y
9085 && to_y
< it
->current_y
+ line_height
)
9090 SAVE_IT (it_backup
, *it
, backup_data
);
9091 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9092 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9094 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9095 line_height
= it
->max_ascent
+ it
->max_descent
;
9096 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9098 if (to_y
>= it
->current_y
9099 && to_y
< it
->current_y
+ line_height
)
9101 /* If TO_Y is in this line and TO_X was reached
9102 above, we scanned too far. We have to restore
9103 IT's settings to the ones before skipping. But
9104 keep the more accurate values of max_ascent and
9105 max_descent we've found while skipping the rest
9106 of the line, for the sake of callers, such as
9107 pos_visible_p, that need to know the line
9109 int max_ascent
= it
->max_ascent
;
9110 int max_descent
= it
->max_descent
;
9112 RESTORE_IT (it
, &it_backup
, backup_data
);
9113 it
->max_ascent
= max_ascent
;
9114 it
->max_descent
= max_descent
;
9120 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9126 /* Check whether TO_Y is in this line. */
9127 line_height
= it
->max_ascent
+ it
->max_descent
;
9128 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9130 if (to_y
>= it
->current_y
9131 && to_y
< it
->current_y
+ line_height
)
9133 if (to_y
> it
->current_y
)
9134 max_current_x
= max (it
->current_x
, max_current_x
);
9136 /* When word-wrap is on, TO_X may lie past the end
9137 of a wrapped line. Then it->current is the
9138 character on the next line, so backtrack to the
9139 space before the wrap point. */
9140 if (skip
== MOVE_LINE_CONTINUED
9141 && it
->line_wrap
== WORD_WRAP
)
9143 int prev_x
= max (it
->current_x
- 1, 0);
9144 RESTORE_IT (it
, &it_backup
, backup_data
);
9145 skip
= move_it_in_display_line_to
9146 (it
, -1, prev_x
, MOVE_TO_X
);
9155 max_current_x
= max (it
->current_x
, max_current_x
);
9159 else if (BUFFERP (it
->object
)
9160 && (it
->method
== GET_FROM_BUFFER
9161 || it
->method
== GET_FROM_STRETCH
)
9162 && IT_CHARPOS (*it
) >= to_charpos
9163 /* Under bidi iteration, a call to set_iterator_to_next
9164 can scan far beyond to_charpos if the initial
9165 portion of the next line needs to be reordered. In
9166 that case, give move_it_in_display_line_to another
9169 && it
->bidi_it
.scan_dir
== -1))
9170 skip
= MOVE_POS_MATCH_OR_ZV
;
9172 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9176 case MOVE_POS_MATCH_OR_ZV
:
9177 max_current_x
= max (it
->current_x
, max_current_x
);
9181 case MOVE_NEWLINE_OR_CR
:
9182 max_current_x
= max (it
->current_x
, max_current_x
);
9183 set_iterator_to_next (it
, true);
9184 it
->continuation_lines_width
= 0;
9187 case MOVE_LINE_TRUNCATED
:
9188 max_current_x
= it
->last_visible_x
;
9189 it
->continuation_lines_width
= 0;
9190 reseat_at_next_visible_line_start (it
, false);
9191 if ((op
& MOVE_TO_POS
) != 0
9192 && IT_CHARPOS (*it
) > to_charpos
)
9199 case MOVE_LINE_CONTINUED
:
9200 max_current_x
= it
->last_visible_x
;
9201 /* For continued lines ending in a tab, some of the glyphs
9202 associated with the tab are displayed on the current
9203 line. Since it->current_x does not include these glyphs,
9204 we use it->last_visible_x instead. */
9207 it
->continuation_lines_width
+= it
->last_visible_x
;
9208 /* When moving by vpos, ensure that the iterator really
9209 advances to the next line (bug#847, bug#969). Fixme:
9210 do we need to do this in other circumstances? */
9211 if (it
->current_x
!= it
->last_visible_x
9212 && (op
& MOVE_TO_VPOS
)
9213 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9215 line_start_x
= it
->current_x
+ it
->pixel_width
9216 - it
->last_visible_x
;
9217 if (FRAME_WINDOW_P (it
->f
))
9219 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9220 struct font
*face_font
= face
->font
;
9222 /* When display_line produces a continued line
9223 that ends in a TAB, it skips a tab stop that
9224 is closer than the font's space character
9225 width (see x_produce_glyphs where it produces
9226 the stretch glyph which represents a TAB).
9227 We need to reproduce the same logic here. */
9228 eassert (face_font
);
9231 if (line_start_x
< face_font
->space_width
)
9233 += it
->tab_width
* face_font
->space_width
;
9236 set_iterator_to_next (it
, false);
9240 it
->continuation_lines_width
+= it
->current_x
;
9247 /* Reset/increment for the next run. */
9248 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9249 it
->current_x
= line_start_x
;
9252 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9254 last_height
= it
->max_ascent
+ it
->max_descent
;
9255 it
->max_ascent
= it
->max_descent
= 0;
9260 /* On text terminals, we may stop at the end of a line in the middle
9261 of a multi-character glyph. If the glyph itself is continued,
9262 i.e. it is actually displayed on the next line, don't treat this
9263 stopping point as valid; move to the next line instead (unless
9264 that brings us offscreen). */
9265 if (!FRAME_WINDOW_P (it
->f
)
9267 && IT_CHARPOS (*it
) == to_charpos
9268 && it
->what
== IT_CHARACTER
9270 && it
->line_wrap
== WINDOW_WRAP
9271 && it
->current_x
== it
->last_visible_x
- 1
9274 && it
->w
->window_end_valid
9275 && it
->vpos
< it
->w
->window_end_vpos
)
9277 it
->continuation_lines_width
+= it
->current_x
;
9278 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9279 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9281 last_height
= it
->max_ascent
+ it
->max_descent
;
9285 bidi_unshelve_cache (backup_data
, true);
9287 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9289 return max_current_x
;
9293 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9295 If DY > 0, move IT backward at least that many pixels. DY = 0
9296 means move IT backward to the preceding line start or BEGV. This
9297 function may move over more than DY pixels if IT->current_y - DY
9298 ends up in the middle of a line; in this case IT->current_y will be
9299 set to the top of the line moved to. */
9302 move_it_vertically_backward (struct it
*it
, int dy
)
9306 void *it2data
= NULL
, *it3data
= NULL
;
9307 ptrdiff_t start_pos
;
9309 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9310 ptrdiff_t pos_limit
;
9315 start_pos
= IT_CHARPOS (*it
);
9317 /* Estimate how many newlines we must move back. */
9318 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9319 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9322 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9324 /* Set the iterator's position that many lines back. But don't go
9325 back more than NLINES full screen lines -- this wins a day with
9326 buffers which have very long lines. */
9327 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9328 back_to_previous_visible_line_start (it
);
9330 /* Reseat the iterator here. When moving backward, we don't want
9331 reseat to skip forward over invisible text, set up the iterator
9332 to deliver from overlay strings at the new position etc. So,
9333 use reseat_1 here. */
9334 reseat_1 (it
, it
->current
.pos
, true);
9336 /* We are now surely at a line start. */
9337 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9338 reordering is in effect. */
9339 it
->continuation_lines_width
= 0;
9341 /* Move forward and see what y-distance we moved. First move to the
9342 start of the next line so that we get its height. We need this
9343 height to be able to tell whether we reached the specified
9345 SAVE_IT (it2
, *it
, it2data
);
9346 it2
.max_ascent
= it2
.max_descent
= 0;
9349 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9350 MOVE_TO_POS
| MOVE_TO_VPOS
);
9352 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9353 /* If we are in a display string which starts at START_POS,
9354 and that display string includes a newline, and we are
9355 right after that newline (i.e. at the beginning of a
9356 display line), exit the loop, because otherwise we will
9357 infloop, since move_it_to will see that it is already at
9358 START_POS and will not move. */
9359 || (it2
.method
== GET_FROM_STRING
9360 && IT_CHARPOS (it2
) == start_pos
9361 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9362 eassert (IT_CHARPOS (*it
) >= BEGV
);
9363 SAVE_IT (it3
, it2
, it3data
);
9365 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9366 eassert (IT_CHARPOS (*it
) >= BEGV
);
9367 /* H is the actual vertical distance from the position in *IT
9368 and the starting position. */
9369 h
= it2
.current_y
- it
->current_y
;
9370 /* NLINES is the distance in number of lines. */
9371 nlines
= it2
.vpos
- it
->vpos
;
9373 /* Correct IT's y and vpos position
9374 so that they are relative to the starting point. */
9380 /* DY == 0 means move to the start of the screen line. The
9381 value of nlines is > 0 if continuation lines were involved,
9382 or if the original IT position was at start of a line. */
9383 RESTORE_IT (it
, it
, it2data
);
9385 move_it_by_lines (it
, nlines
);
9386 /* The above code moves us to some position NLINES down,
9387 usually to its first glyph (leftmost in an L2R line), but
9388 that's not necessarily the start of the line, under bidi
9389 reordering. We want to get to the character position
9390 that is immediately after the newline of the previous
9393 && !it
->continuation_lines_width
9394 && !STRINGP (it
->string
)
9395 && IT_CHARPOS (*it
) > BEGV
9396 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9398 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9401 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9402 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9404 bidi_unshelve_cache (it3data
, true);
9408 /* The y-position we try to reach, relative to *IT.
9409 Note that H has been subtracted in front of the if-statement. */
9410 int target_y
= it
->current_y
+ h
- dy
;
9411 int y0
= it3
.current_y
;
9415 RESTORE_IT (&it3
, &it3
, it3data
);
9416 y1
= line_bottom_y (&it3
);
9417 line_height
= y1
- y0
;
9418 RESTORE_IT (it
, it
, it2data
);
9419 /* If we did not reach target_y, try to move further backward if
9420 we can. If we moved too far backward, try to move forward. */
9421 if (target_y
< it
->current_y
9422 /* This is heuristic. In a window that's 3 lines high, with
9423 a line height of 13 pixels each, recentering with point
9424 on the bottom line will try to move -39/2 = 19 pixels
9425 backward. Try to avoid moving into the first line. */
9426 && (it
->current_y
- target_y
9427 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9428 && IT_CHARPOS (*it
) > BEGV
)
9430 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9431 target_y
- it
->current_y
));
9432 dy
= it
->current_y
- target_y
;
9433 goto move_further_back
;
9435 else if (target_y
>= it
->current_y
+ line_height
9436 && IT_CHARPOS (*it
) < ZV
)
9438 /* Should move forward by at least one line, maybe more.
9440 Note: Calling move_it_by_lines can be expensive on
9441 terminal frames, where compute_motion is used (via
9442 vmotion) to do the job, when there are very long lines
9443 and truncate-lines is nil. That's the reason for
9444 treating terminal frames specially here. */
9446 if (!FRAME_WINDOW_P (it
->f
))
9447 move_it_vertically (it
, target_y
- it
->current_y
);
9452 move_it_by_lines (it
, 1);
9454 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9461 /* Move IT by a specified amount of pixel lines DY. DY negative means
9462 move backwards. DY = 0 means move to start of screen line. At the
9463 end, IT will be on the start of a screen line. */
9466 move_it_vertically (struct it
*it
, int dy
)
9469 move_it_vertically_backward (it
, -dy
);
9472 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9473 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9474 MOVE_TO_POS
| MOVE_TO_Y
);
9475 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9477 /* If buffer ends in ZV without a newline, move to the start of
9478 the line to satisfy the post-condition. */
9479 if (IT_CHARPOS (*it
) == ZV
9481 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9482 move_it_by_lines (it
, 0);
9487 /* Move iterator IT past the end of the text line it is in. */
9490 move_it_past_eol (struct it
*it
)
9492 enum move_it_result rc
;
9494 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9495 if (rc
== MOVE_NEWLINE_OR_CR
)
9496 set_iterator_to_next (it
, false);
9500 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9501 negative means move up. DVPOS == 0 means move to the start of the
9504 Optimization idea: If we would know that IT->f doesn't use
9505 a face with proportional font, we could be faster for
9506 truncate-lines nil. */
9509 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9512 /* The commented-out optimization uses vmotion on terminals. This
9513 gives bad results, because elements like it->what, on which
9514 callers such as pos_visible_p rely, aren't updated. */
9515 /* struct position pos;
9516 if (!FRAME_WINDOW_P (it->f))
9518 struct text_pos textpos;
9520 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9521 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9522 reseat (it, textpos, true);
9523 it->vpos += pos.vpos;
9524 it->current_y += pos.vpos;
9530 /* DVPOS == 0 means move to the start of the screen line. */
9531 move_it_vertically_backward (it
, 0);
9532 /* Let next call to line_bottom_y calculate real line height. */
9537 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9538 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9540 /* Only move to the next buffer position if we ended up in a
9541 string from display property, not in an overlay string
9542 (before-string or after-string). That is because the
9543 latter don't conceal the underlying buffer position, so
9544 we can ask to move the iterator to the exact position we
9545 are interested in. Note that, even if we are already at
9546 IT_CHARPOS (*it), the call below is not a no-op, as it
9547 will detect that we are at the end of the string, pop the
9548 iterator, and compute it->current_x and it->hpos
9550 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9551 -1, -1, -1, MOVE_TO_POS
);
9557 void *it2data
= NULL
;
9558 ptrdiff_t start_charpos
, i
;
9560 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9561 bool hit_pos_limit
= false;
9562 ptrdiff_t pos_limit
;
9564 /* Start at the beginning of the screen line containing IT's
9565 position. This may actually move vertically backwards,
9566 in case of overlays, so adjust dvpos accordingly. */
9568 move_it_vertically_backward (it
, 0);
9571 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9572 screen lines, and reseat the iterator there. */
9573 start_charpos
= IT_CHARPOS (*it
);
9574 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9577 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9579 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9580 back_to_previous_visible_line_start (it
);
9581 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9582 hit_pos_limit
= true;
9583 reseat (it
, it
->current
.pos
, true);
9585 /* Move further back if we end up in a string or an image. */
9586 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9588 /* First try to move to start of display line. */
9590 move_it_vertically_backward (it
, 0);
9592 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9594 /* If start of line is still in string or image,
9595 move further back. */
9596 back_to_previous_visible_line_start (it
);
9597 reseat (it
, it
->current
.pos
, true);
9601 it
->current_x
= it
->hpos
= 0;
9603 /* Above call may have moved too far if continuation lines
9604 are involved. Scan forward and see if it did. */
9605 SAVE_IT (it2
, *it
, it2data
);
9606 it2
.vpos
= it2
.current_y
= 0;
9607 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9608 it
->vpos
-= it2
.vpos
;
9609 it
->current_y
-= it2
.current_y
;
9610 it
->current_x
= it
->hpos
= 0;
9612 /* If we moved too far back, move IT some lines forward. */
9613 if (it2
.vpos
> -dvpos
)
9615 int delta
= it2
.vpos
+ dvpos
;
9617 RESTORE_IT (&it2
, &it2
, it2data
);
9618 SAVE_IT (it2
, *it
, it2data
);
9619 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9620 /* Move back again if we got too far ahead. */
9621 if (IT_CHARPOS (*it
) >= start_charpos
)
9622 RESTORE_IT (it
, &it2
, it2data
);
9624 bidi_unshelve_cache (it2data
, true);
9626 else if (hit_pos_limit
&& pos_limit
> BEGV
9627 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9629 /* If we hit the limit, but still didn't make it far enough
9630 back, that means there's a display string with a newline
9631 covering a large chunk of text, and that caused
9632 back_to_previous_visible_line_start try to go too far.
9633 Punish those who commit such atrocities by going back
9634 until we've reached DVPOS, after lifting the limit, which
9635 could make it slow for very long lines. "If it hurts,
9638 RESTORE_IT (it
, it
, it2data
);
9639 for (i
= -dvpos
; i
> 0; --i
)
9641 back_to_previous_visible_line_start (it
);
9644 reseat_1 (it
, it
->current
.pos
, true);
9647 RESTORE_IT (it
, it
, it2data
);
9651 /* Return true if IT points into the middle of a display vector. */
9654 in_display_vector_p (struct it
*it
)
9656 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9657 && it
->current
.dpvec_index
> 0
9658 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9661 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9662 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9663 WINDOW must be a live window and defaults to the selected one. The
9664 return value is a cons of the maximum pixel-width of any text line and
9665 the maximum pixel-height of all text lines.
9667 The optional argument FROM, if non-nil, specifies the first text
9668 position and defaults to the minimum accessible position of the buffer.
9669 If FROM is t, use the minimum accessible position that is not a newline
9670 character. TO, if non-nil, specifies the last text position and
9671 defaults to the maximum accessible position of the buffer. If TO is t,
9672 use the maximum accessible position that is not a newline character.
9674 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9675 width that can be returned. X-LIMIT nil or omitted, means to use the
9676 pixel-width of WINDOW's body; use this if you do not intend to change
9677 the width of WINDOW. Use the maximum width WINDOW may assume if you
9678 intend to change WINDOW's width. In any case, text whose x-coordinate
9679 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9680 can take some time, it's always a good idea to make this argument as
9681 small as possible; in particular, if the buffer contains long lines that
9682 shall be truncated anyway.
9684 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9685 height that can be returned. Text lines whose y-coordinate is beyond
9686 Y-LIMIT are ignored. Since calculating the text height of a large
9687 buffer can take some time, it makes sense to specify this argument if
9688 the size of the buffer is unknown.
9690 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9691 include the height of the mode- or header-line of WINDOW in the return
9692 value. If it is either the symbol `mode-line' or `header-line', include
9693 only the height of that line, if present, in the return value. If t,
9694 include the height of both, if present, in the return value. */)
9695 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9696 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9698 struct window
*w
= decode_live_window (window
);
9699 Lisp_Object buffer
= w
->contents
;
9702 struct buffer
*old_b
= NULL
;
9703 ptrdiff_t start
, end
, pos
;
9704 struct text_pos startp
;
9705 void *itdata
= NULL
;
9706 int c
, max_y
= -1, x
= 0, y
= 0;
9708 CHECK_BUFFER (buffer
);
9709 b
= XBUFFER (buffer
);
9711 if (b
!= current_buffer
)
9713 old_b
= current_buffer
;
9714 set_buffer_internal (b
);
9719 else if (EQ (from
, Qt
))
9722 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9723 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9725 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9730 CHECK_NUMBER_COERCE_MARKER (from
);
9731 start
= min (max (XINT (from
), BEGV
), ZV
);
9736 else if (EQ (to
, Qt
))
9739 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9740 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9742 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9747 CHECK_NUMBER_COERCE_MARKER (to
);
9748 end
= max (start
, min (XINT (to
), ZV
));
9751 if (!NILP (y_limit
))
9753 CHECK_NUMBER (y_limit
);
9754 max_y
= min (XINT (y_limit
), INT_MAX
);
9757 itdata
= bidi_shelve_cache ();
9758 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9759 start_display (&it
, w
, startp
);
9762 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9765 CHECK_NUMBER (x_limit
);
9766 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9767 /* Actually, we never want move_it_to stop at to_x. But to make
9768 sure that move_it_in_display_line_to always moves far enough,
9769 we set it to INT_MAX and specify MOVE_TO_X. */
9770 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9771 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9774 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9776 if (!EQ (mode_and_header_line
, Qheader_line
)
9777 && !EQ (mode_and_header_line
, Qt
))
9778 /* Do not count the header-line which was counted automatically by
9780 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9782 if (EQ (mode_and_header_line
, Qmode_line
)
9783 || EQ (mode_and_header_line
, Qt
))
9784 /* Do count the mode-line which is not included automatically by
9786 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9788 bidi_unshelve_cache (itdata
, false);
9791 set_buffer_internal (old_b
);
9793 return Fcons (make_number (x
), make_number (y
));
9796 /***********************************************************************
9798 ***********************************************************************/
9800 /* Return the number of arguments the format string FORMAT needs. */
9803 format_nargs (char const *format
)
9805 ptrdiff_t nargs
= 0;
9806 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9814 /* Add a message with format string FORMAT and formatted arguments
9818 add_to_log (const char *format
, ...)
9821 va_start (ap
, format
);
9822 vadd_to_log (format
, ap
);
9827 vadd_to_log (char const *format
, va_list ap
)
9829 ptrdiff_t form_nargs
= format_nargs (format
);
9830 ptrdiff_t nargs
= 1 + form_nargs
;
9831 Lisp_Object args
[10];
9832 eassert (nargs
<= ARRAYELTS (args
));
9833 AUTO_STRING (args0
, format
);
9835 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9836 args
[i
] = va_arg (ap
, Lisp_Object
);
9837 Lisp_Object msg
= Qnil
;
9838 struct gcpro gcpro1
, gcpro2
;
9839 GCPRO2 (args
[1], msg
);
9840 gcpro1
.nvars
= form_nargs
;
9841 msg
= Fformat_message (nargs
, args
);
9843 ptrdiff_t len
= SBYTES (msg
) + 1;
9845 char *buffer
= SAFE_ALLOCA (len
);
9846 memcpy (buffer
, SDATA (msg
), len
);
9848 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9855 /* Output a newline in the *Messages* buffer if "needs" one. */
9858 message_log_maybe_newline (void)
9860 if (message_log_need_newline
)
9861 message_dolog ("", 0, true, false);
9865 /* Add a string M of length NBYTES to the message log, optionally
9866 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9867 true, means interpret the contents of M as multibyte. This
9868 function calls low-level routines in order to bypass text property
9869 hooks, etc. which might not be safe to run.
9871 This may GC (insert may run before/after change hooks),
9872 so the buffer M must NOT point to a Lisp string. */
9875 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9877 const unsigned char *msg
= (const unsigned char *) m
;
9879 if (!NILP (Vmemory_full
))
9882 if (!NILP (Vmessage_log_max
))
9884 struct buffer
*oldbuf
;
9885 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9886 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9887 ptrdiff_t point_at_end
= 0;
9888 ptrdiff_t zv_at_end
= 0;
9889 Lisp_Object old_deactivate_mark
;
9890 struct gcpro gcpro1
;
9892 old_deactivate_mark
= Vdeactivate_mark
;
9893 oldbuf
= current_buffer
;
9895 /* Ensure the Messages buffer exists, and switch to it.
9896 If we created it, set the major-mode. */
9897 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9898 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9900 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9901 call0 (intern ("messages-buffer-mode"));
9903 bset_undo_list (current_buffer
, Qt
);
9904 bset_cache_long_scans (current_buffer
, Qnil
);
9906 oldpoint
= message_dolog_marker1
;
9907 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9908 oldbegv
= message_dolog_marker2
;
9909 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9910 oldzv
= message_dolog_marker3
;
9911 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9912 GCPRO1 (old_deactivate_mark
);
9920 BEGV_BYTE
= BEG_BYTE
;
9923 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9925 /* Insert the string--maybe converting multibyte to single byte
9926 or vice versa, so that all the text fits the buffer. */
9928 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9934 /* Convert a multibyte string to single-byte
9935 for the *Message* buffer. */
9936 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9938 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9939 work
[0] = CHAR_TO_BYTE8 (c
);
9940 insert_1_both (work
, 1, 1, true, false, false);
9943 else if (! multibyte
9944 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9948 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9949 /* Convert a single-byte string to multibyte
9950 for the *Message* buffer. */
9951 for (i
= 0; i
< nbytes
; i
++)
9954 MAKE_CHAR_MULTIBYTE (c
);
9955 char_bytes
= CHAR_STRING (c
, str
);
9956 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9960 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9961 true, false, false);
9965 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9968 insert_1_both ("\n", 1, 1, true, false, false);
9970 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
9972 this_bol_byte
= PT_BYTE
;
9974 /* See if this line duplicates the previous one.
9975 If so, combine duplicates. */
9978 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
9980 prev_bol_byte
= PT_BYTE
;
9982 dups
= message_log_check_duplicate (prev_bol_byte
,
9986 del_range_both (prev_bol
, prev_bol_byte
,
9987 this_bol
, this_bol_byte
, false);
9990 char dupstr
[sizeof " [ times]"
9991 + INT_STRLEN_BOUND (printmax_t
)];
9993 /* If you change this format, don't forget to also
9994 change message_log_check_duplicate. */
9995 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9996 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9997 insert_1_both (dupstr
, duplen
, duplen
,
10003 /* If we have more than the desired maximum number of lines
10004 in the *Messages* buffer now, delete the oldest ones.
10005 This is safe because we don't have undo in this buffer. */
10007 if (NATNUMP (Vmessage_log_max
))
10009 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10010 -XFASTINT (Vmessage_log_max
) - 1, false);
10011 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10014 BEGV
= marker_position (oldbegv
);
10015 BEGV_BYTE
= marker_byte_position (oldbegv
);
10024 ZV
= marker_position (oldzv
);
10025 ZV_BYTE
= marker_byte_position (oldzv
);
10029 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10031 /* We can't do Fgoto_char (oldpoint) because it will run some
10033 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10034 marker_byte_position (oldpoint
));
10037 unchain_marker (XMARKER (oldpoint
));
10038 unchain_marker (XMARKER (oldbegv
));
10039 unchain_marker (XMARKER (oldzv
));
10041 /* We called insert_1_both above with its 5th argument (PREPARE)
10042 false, which prevents insert_1_both from calling
10043 prepare_to_modify_buffer, which in turns prevents us from
10044 incrementing windows_or_buffers_changed even if *Messages* is
10045 shown in some window. So we must manually set
10046 windows_or_buffers_changed here to make up for that. */
10047 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10048 bset_redisplay (current_buffer
);
10050 set_buffer_internal (oldbuf
);
10052 message_log_need_newline
= !nlflag
;
10053 Vdeactivate_mark
= old_deactivate_mark
;
10058 /* We are at the end of the buffer after just having inserted a newline.
10059 (Note: We depend on the fact we won't be crossing the gap.)
10060 Check to see if the most recent message looks a lot like the previous one.
10061 Return 0 if different, 1 if the new one should just replace it, or a
10062 value N > 1 if we should also append " [N times]". */
10065 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10068 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10069 bool seen_dots
= false;
10070 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10071 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10073 for (i
= 0; i
< len
; i
++)
10075 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10077 if (p1
[i
] != p2
[i
])
10083 if (*p1
++ == ' ' && *p1
++ == '[')
10086 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10087 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10094 /* Display an echo area message M with a specified length of NBYTES
10095 bytes. The string may include null characters. If M is not a
10096 string, clear out any existing message, and let the mini-buffer
10099 This function cancels echoing. */
10102 message3 (Lisp_Object m
)
10104 struct gcpro gcpro1
;
10107 clear_message (true, true);
10110 /* First flush out any partial line written with print. */
10111 message_log_maybe_newline ();
10114 ptrdiff_t nbytes
= SBYTES (m
);
10115 bool multibyte
= STRING_MULTIBYTE (m
);
10118 SAFE_ALLOCA_STRING (buffer
, m
);
10119 message_dolog (buffer
, nbytes
, true, multibyte
);
10122 if (! inhibit_message
)
10123 message3_nolog (m
);
10127 /* Log the message M to stderr. Log an empty line if M is not a string. */
10130 message_to_stderr (Lisp_Object m
)
10132 if (noninteractive_need_newline
)
10134 noninteractive_need_newline
= false;
10135 fputc ('\n', stderr
);
10139 Lisp_Object s
= ENCODE_SYSTEM (m
);
10140 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10142 if (!cursor_in_echo_area
)
10143 fputc ('\n', stderr
);
10147 /* The non-logging version of message3.
10148 This does not cancel echoing, because it is used for echoing.
10149 Perhaps we need to make a separate function for echoing
10150 and make this cancel echoing. */
10153 message3_nolog (Lisp_Object m
)
10155 struct frame
*sf
= SELECTED_FRAME ();
10157 if (FRAME_INITIAL_P (sf
))
10158 message_to_stderr (m
);
10159 /* Error messages get reported properly by cmd_error, so this must be just an
10160 informative message; if the frame hasn't really been initialized yet, just
10162 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10164 /* Get the frame containing the mini-buffer
10165 that the selected frame is using. */
10166 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10167 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10168 struct frame
*f
= XFRAME (frame
);
10170 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10171 Fmake_frame_visible (frame
);
10173 if (STRINGP (m
) && SCHARS (m
) > 0)
10176 if (minibuffer_auto_raise
)
10177 Fraise_frame (frame
);
10178 /* Assume we are not echoing.
10179 (If we are, echo_now will override this.) */
10180 echo_message_buffer
= Qnil
;
10183 clear_message (true, true);
10185 do_pending_window_change (false);
10186 echo_area_display (true);
10187 do_pending_window_change (false);
10188 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10189 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10194 /* Display a null-terminated echo area message M. If M is 0, clear
10195 out any existing message, and let the mini-buffer text show through.
10197 The buffer M must continue to exist until after the echo area gets
10198 cleared or some other message gets displayed there. Do not pass
10199 text that is stored in a Lisp string. Do not pass text in a buffer
10200 that was alloca'd. */
10203 message1 (const char *m
)
10205 message3 (m
? build_unibyte_string (m
) : Qnil
);
10209 /* The non-logging counterpart of message1. */
10212 message1_nolog (const char *m
)
10214 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10217 /* Display a message M which contains a single %s
10218 which gets replaced with STRING. */
10221 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10223 CHECK_STRING (string
);
10226 if (noninteractive
)
10227 need_message
= !!m
;
10228 else if (!INTERACTIVE
)
10229 need_message
= false;
10232 /* The frame whose minibuffer we're going to display the message on.
10233 It may be larger than the selected frame, so we need
10234 to use its buffer, not the selected frame's buffer. */
10235 Lisp_Object mini_window
;
10236 struct frame
*f
, *sf
= SELECTED_FRAME ();
10238 /* Get the frame containing the minibuffer
10239 that the selected frame is using. */
10240 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10241 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10243 /* Error messages get reported properly by cmd_error, so this must be
10244 just an informative message; if the frame hasn't really been
10245 initialized yet, just toss it. */
10246 need_message
= f
->glyphs_initialized_p
;
10251 AUTO_STRING (fmt
, m
);
10252 struct gcpro gcpro1
;
10253 Lisp_Object msg
= string
;
10255 msg
= CALLN (Fformat_message
, fmt
, msg
);
10257 if (noninteractive
)
10258 message_to_stderr (msg
);
10264 message3_nolog (msg
);
10266 /* Print should start at the beginning of the message
10267 buffer next time. */
10268 message_buf_print
= false;
10276 /* Dump an informative message to the minibuf. If M is 0, clear out
10277 any existing message, and let the mini-buffer text show through.
10279 The message must be safe ASCII and the format must not contain ` or
10280 '. If your message and format do not fit into this category,
10281 convert your arguments to Lisp objects and use Fmessage instead. */
10283 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10284 vmessage (const char *m
, va_list ap
)
10286 if (noninteractive
)
10290 if (noninteractive_need_newline
)
10291 putc ('\n', stderr
);
10292 noninteractive_need_newline
= false;
10293 vfprintf (stderr
, m
, ap
);
10294 if (!cursor_in_echo_area
)
10295 fprintf (stderr
, "\n");
10299 else if (INTERACTIVE
)
10301 /* The frame whose mini-buffer we're going to display the message
10302 on. It may be larger than the selected frame, so we need to
10303 use its buffer, not the selected frame's buffer. */
10304 Lisp_Object mini_window
;
10305 struct frame
*f
, *sf
= SELECTED_FRAME ();
10307 /* Get the frame containing the mini-buffer
10308 that the selected frame is using. */
10309 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10310 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10312 /* Error messages get reported properly by cmd_error, so this must be
10313 just an informative message; if the frame hasn't really been
10314 initialized yet, just toss it. */
10315 if (f
->glyphs_initialized_p
)
10320 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10322 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10324 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10326 message3 (make_string (message_buf
, len
));
10332 /* Print should start at the beginning of the message
10333 buffer next time. */
10334 message_buf_print
= false;
10340 message (const char *m
, ...)
10349 /* Display the current message in the current mini-buffer. This is
10350 only called from error handlers in process.c, and is not time
10354 update_echo_area (void)
10356 if (!NILP (echo_area_buffer
[0]))
10358 Lisp_Object string
;
10359 string
= Fcurrent_message ();
10365 /* Make sure echo area buffers in `echo_buffers' are live.
10366 If they aren't, make new ones. */
10369 ensure_echo_area_buffers (void)
10373 for (i
= 0; i
< 2; ++i
)
10374 if (!BUFFERP (echo_buffer
[i
])
10375 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10378 Lisp_Object old_buffer
;
10381 old_buffer
= echo_buffer
[i
];
10382 echo_buffer
[i
] = Fget_buffer_create
10383 (make_formatted_string (name
, " *Echo Area %d*", i
));
10384 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10385 /* to force word wrap in echo area -
10386 it was decided to postpone this*/
10387 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10389 for (j
= 0; j
< 2; ++j
)
10390 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10391 echo_area_buffer
[j
] = echo_buffer
[i
];
10396 /* Call FN with args A1..A2 with either the current or last displayed
10397 echo_area_buffer as current buffer.
10399 WHICH zero means use the current message buffer
10400 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10401 from echo_buffer[] and clear it.
10403 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10404 suitable buffer from echo_buffer[] and clear it.
10406 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10407 that the current message becomes the last displayed one, make
10408 choose a suitable buffer for echo_area_buffer[0], and clear it.
10410 Value is what FN returns. */
10413 with_echo_area_buffer (struct window
*w
, int which
,
10414 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10415 ptrdiff_t a1
, Lisp_Object a2
)
10417 Lisp_Object buffer
;
10418 bool this_one
, the_other
, clear_buffer_p
, rc
;
10419 ptrdiff_t count
= SPECPDL_INDEX ();
10421 /* If buffers aren't live, make new ones. */
10422 ensure_echo_area_buffers ();
10424 clear_buffer_p
= false;
10427 this_one
= false, the_other
= true;
10428 else if (which
> 0)
10429 this_one
= true, the_other
= false;
10432 this_one
= false, the_other
= true;
10433 clear_buffer_p
= true;
10435 /* We need a fresh one in case the current echo buffer equals
10436 the one containing the last displayed echo area message. */
10437 if (!NILP (echo_area_buffer
[this_one
])
10438 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10439 echo_area_buffer
[this_one
] = Qnil
;
10442 /* Choose a suitable buffer from echo_buffer[] is we don't
10444 if (NILP (echo_area_buffer
[this_one
]))
10446 echo_area_buffer
[this_one
]
10447 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10448 ? echo_buffer
[the_other
]
10449 : echo_buffer
[this_one
]);
10450 clear_buffer_p
= true;
10453 buffer
= echo_area_buffer
[this_one
];
10455 /* Don't get confused by reusing the buffer used for echoing
10456 for a different purpose. */
10457 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10460 record_unwind_protect (unwind_with_echo_area_buffer
,
10461 with_echo_area_buffer_unwind_data (w
));
10463 /* Make the echo area buffer current. Note that for display
10464 purposes, it is not necessary that the displayed window's buffer
10465 == current_buffer, except for text property lookup. So, let's
10466 only set that buffer temporarily here without doing a full
10467 Fset_window_buffer. We must also change w->pointm, though,
10468 because otherwise an assertions in unshow_buffer fails, and Emacs
10470 set_buffer_internal_1 (XBUFFER (buffer
));
10473 wset_buffer (w
, buffer
);
10474 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10475 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10478 bset_undo_list (current_buffer
, Qt
);
10479 bset_read_only (current_buffer
, Qnil
);
10480 specbind (Qinhibit_read_only
, Qt
);
10481 specbind (Qinhibit_modification_hooks
, Qt
);
10483 if (clear_buffer_p
&& Z
> BEG
)
10484 del_range (BEG
, Z
);
10486 eassert (BEGV
>= BEG
);
10487 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10491 eassert (BEGV
>= BEG
);
10492 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10494 unbind_to (count
, Qnil
);
10499 /* Save state that should be preserved around the call to the function
10500 FN called in with_echo_area_buffer. */
10503 with_echo_area_buffer_unwind_data (struct window
*w
)
10506 Lisp_Object vector
, tmp
;
10508 /* Reduce consing by keeping one vector in
10509 Vwith_echo_area_save_vector. */
10510 vector
= Vwith_echo_area_save_vector
;
10511 Vwith_echo_area_save_vector
= Qnil
;
10514 vector
= Fmake_vector (make_number (11), Qnil
);
10516 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10517 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10518 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10522 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10523 ASET (vector
, i
, w
->contents
); ++i
;
10524 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10525 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10526 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10527 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10528 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10529 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10534 for (; i
< end
; ++i
)
10535 ASET (vector
, i
, Qnil
);
10538 eassert (i
== ASIZE (vector
));
10543 /* Restore global state from VECTOR which was created by
10544 with_echo_area_buffer_unwind_data. */
10547 unwind_with_echo_area_buffer (Lisp_Object vector
)
10549 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10550 Vdeactivate_mark
= AREF (vector
, 1);
10551 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10553 if (WINDOWP (AREF (vector
, 3)))
10556 Lisp_Object buffer
;
10558 w
= XWINDOW (AREF (vector
, 3));
10559 buffer
= AREF (vector
, 4);
10561 wset_buffer (w
, buffer
);
10562 set_marker_both (w
->pointm
, buffer
,
10563 XFASTINT (AREF (vector
, 5)),
10564 XFASTINT (AREF (vector
, 6)));
10565 set_marker_both (w
->old_pointm
, buffer
,
10566 XFASTINT (AREF (vector
, 7)),
10567 XFASTINT (AREF (vector
, 8)));
10568 set_marker_both (w
->start
, buffer
,
10569 XFASTINT (AREF (vector
, 9)),
10570 XFASTINT (AREF (vector
, 10)));
10573 Vwith_echo_area_save_vector
= vector
;
10577 /* Set up the echo area for use by print functions. MULTIBYTE_P
10578 means we will print multibyte. */
10581 setup_echo_area_for_printing (bool multibyte_p
)
10583 /* If we can't find an echo area any more, exit. */
10584 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10585 Fkill_emacs (Qnil
);
10587 ensure_echo_area_buffers ();
10589 if (!message_buf_print
)
10591 /* A message has been output since the last time we printed.
10592 Choose a fresh echo area buffer. */
10593 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10594 echo_area_buffer
[0] = echo_buffer
[1];
10596 echo_area_buffer
[0] = echo_buffer
[0];
10598 /* Switch to that buffer and clear it. */
10599 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10600 bset_truncate_lines (current_buffer
, Qnil
);
10604 ptrdiff_t count
= SPECPDL_INDEX ();
10605 specbind (Qinhibit_read_only
, Qt
);
10606 /* Note that undo recording is always disabled. */
10607 del_range (BEG
, Z
);
10608 unbind_to (count
, Qnil
);
10610 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10612 /* Set up the buffer for the multibyteness we need. */
10614 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10615 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10617 /* Raise the frame containing the echo area. */
10618 if (minibuffer_auto_raise
)
10620 struct frame
*sf
= SELECTED_FRAME ();
10621 Lisp_Object mini_window
;
10622 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10623 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10626 message_log_maybe_newline ();
10627 message_buf_print
= true;
10631 if (NILP (echo_area_buffer
[0]))
10633 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10634 echo_area_buffer
[0] = echo_buffer
[1];
10636 echo_area_buffer
[0] = echo_buffer
[0];
10639 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10641 /* Someone switched buffers between print requests. */
10642 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10643 bset_truncate_lines (current_buffer
, Qnil
);
10649 /* Display an echo area message in window W. Value is true if W's
10650 height is changed. If display_last_displayed_message_p,
10651 display the message that was last displayed, otherwise
10652 display the current message. */
10655 display_echo_area (struct window
*w
)
10657 bool no_message_p
, window_height_changed_p
;
10659 /* Temporarily disable garbage collections while displaying the echo
10660 area. This is done because a GC can print a message itself.
10661 That message would modify the echo area buffer's contents while a
10662 redisplay of the buffer is going on, and seriously confuse
10664 ptrdiff_t count
= inhibit_garbage_collection ();
10666 /* If there is no message, we must call display_echo_area_1
10667 nevertheless because it resizes the window. But we will have to
10668 reset the echo_area_buffer in question to nil at the end because
10669 with_echo_area_buffer will sets it to an empty buffer. */
10670 bool i
= display_last_displayed_message_p
;
10671 no_message_p
= NILP (echo_area_buffer
[i
]);
10673 window_height_changed_p
10674 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10675 display_echo_area_1
,
10676 (intptr_t) w
, Qnil
);
10679 echo_area_buffer
[i
] = Qnil
;
10681 unbind_to (count
, Qnil
);
10682 return window_height_changed_p
;
10686 /* Helper for display_echo_area. Display the current buffer which
10687 contains the current echo area message in window W, a mini-window,
10688 a pointer to which is passed in A1. A2..A4 are currently not used.
10689 Change the height of W so that all of the message is displayed.
10690 Value is true if height of W was changed. */
10693 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10696 struct window
*w
= (struct window
*) i1
;
10697 Lisp_Object window
;
10698 struct text_pos start
;
10700 /* Do this before displaying, so that we have a large enough glyph
10701 matrix for the display. If we can't get enough space for the
10702 whole text, display the last N lines. That works by setting w->start. */
10703 bool window_height_changed_p
= resize_mini_window (w
, false);
10705 /* Use the starting position chosen by resize_mini_window. */
10706 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10709 clear_glyph_matrix (w
->desired_matrix
);
10710 XSETWINDOW (window
, w
);
10711 try_window (window
, start
, 0);
10713 return window_height_changed_p
;
10717 /* Resize the echo area window to exactly the size needed for the
10718 currently displayed message, if there is one. If a mini-buffer
10719 is active, don't shrink it. */
10722 resize_echo_area_exactly (void)
10724 if (BUFFERP (echo_area_buffer
[0])
10725 && WINDOWP (echo_area_window
))
10727 struct window
*w
= XWINDOW (echo_area_window
);
10728 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10729 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10730 (intptr_t) w
, resize_exactly
);
10733 windows_or_buffers_changed
= 42;
10734 update_mode_lines
= 30;
10735 redisplay_internal ();
10741 /* Callback function for with_echo_area_buffer, when used from
10742 resize_echo_area_exactly. A1 contains a pointer to the window to
10743 resize, EXACTLY non-nil means resize the mini-window exactly to the
10744 size of the text displayed. A3 and A4 are not used. Value is what
10745 resize_mini_window returns. */
10748 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10751 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10755 /* Resize mini-window W to fit the size of its contents. EXACT_P
10756 means size the window exactly to the size needed. Otherwise, it's
10757 only enlarged until W's buffer is empty.
10759 Set W->start to the right place to begin display. If the whole
10760 contents fit, start at the beginning. Otherwise, start so as
10761 to make the end of the contents appear. This is particularly
10762 important for y-or-n-p, but seems desirable generally.
10764 Value is true if the window height has been changed. */
10767 resize_mini_window (struct window
*w
, bool exact_p
)
10769 struct frame
*f
= XFRAME (w
->frame
);
10770 bool window_height_changed_p
= false;
10772 eassert (MINI_WINDOW_P (w
));
10774 /* By default, start display at the beginning. */
10775 set_marker_both (w
->start
, w
->contents
,
10776 BUF_BEGV (XBUFFER (w
->contents
)),
10777 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10779 /* Don't resize windows while redisplaying a window; it would
10780 confuse redisplay functions when the size of the window they are
10781 displaying changes from under them. Such a resizing can happen,
10782 for instance, when which-func prints a long message while
10783 we are running fontification-functions. We're running these
10784 functions with safe_call which binds inhibit-redisplay to t. */
10785 if (!NILP (Vinhibit_redisplay
))
10788 /* Nil means don't try to resize. */
10789 if (NILP (Vresize_mini_windows
)
10790 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10793 if (!FRAME_MINIBUF_ONLY_P (f
))
10796 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10797 + WINDOW_PIXEL_HEIGHT (w
));
10798 int unit
= FRAME_LINE_HEIGHT (f
);
10799 int height
, max_height
;
10800 struct text_pos start
;
10801 struct buffer
*old_current_buffer
= NULL
;
10803 if (current_buffer
!= XBUFFER (w
->contents
))
10805 old_current_buffer
= current_buffer
;
10806 set_buffer_internal (XBUFFER (w
->contents
));
10809 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10811 /* Compute the max. number of lines specified by the user. */
10812 if (FLOATP (Vmax_mini_window_height
))
10813 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10814 else if (INTEGERP (Vmax_mini_window_height
))
10815 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10817 max_height
= total_height
/ 4;
10819 /* Correct that max. height if it's bogus. */
10820 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10822 /* Find out the height of the text in the window. */
10823 if (it
.line_wrap
== TRUNCATE
)
10828 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10829 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10830 height
= it
.current_y
+ last_height
;
10832 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10833 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10836 /* Compute a suitable window start. */
10837 if (height
> max_height
)
10839 height
= (max_height
/ unit
) * unit
;
10840 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10841 move_it_vertically_backward (&it
, height
- unit
);
10842 start
= it
.current
.pos
;
10845 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10846 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10848 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10850 /* Let it grow only, until we display an empty message, in which
10851 case the window shrinks again. */
10852 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10854 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10856 FRAME_WINDOWS_FROZEN (f
) = true;
10857 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10858 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10860 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10861 && (exact_p
|| BEGV
== ZV
))
10863 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10865 FRAME_WINDOWS_FROZEN (f
) = false;
10866 shrink_mini_window (w
, true);
10867 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10872 /* Always resize to exact size needed. */
10873 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10875 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10877 FRAME_WINDOWS_FROZEN (f
) = true;
10878 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10879 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10881 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10883 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10885 FRAME_WINDOWS_FROZEN (f
) = false;
10886 shrink_mini_window (w
, true);
10890 FRAME_WINDOWS_FROZEN (f
) = true;
10891 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10894 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10898 if (old_current_buffer
)
10899 set_buffer_internal (old_current_buffer
);
10902 return window_height_changed_p
;
10906 /* Value is the current message, a string, or nil if there is no
10907 current message. */
10910 current_message (void)
10914 if (!BUFFERP (echo_area_buffer
[0]))
10918 with_echo_area_buffer (0, 0, current_message_1
,
10919 (intptr_t) &msg
, Qnil
);
10921 echo_area_buffer
[0] = Qnil
;
10929 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10932 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10935 *msg
= make_buffer_string (BEG
, Z
, true);
10942 /* Push the current message on Vmessage_stack for later restoration
10943 by restore_message. Value is true if the current message isn't
10944 empty. This is a relatively infrequent operation, so it's not
10945 worth optimizing. */
10948 push_message (void)
10950 Lisp_Object msg
= current_message ();
10951 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10952 return STRINGP (msg
);
10956 /* Restore message display from the top of Vmessage_stack. */
10959 restore_message (void)
10961 eassert (CONSP (Vmessage_stack
));
10962 message3_nolog (XCAR (Vmessage_stack
));
10966 /* Handler for unwind-protect calling pop_message. */
10969 pop_message_unwind (void)
10971 /* Pop the top-most entry off Vmessage_stack. */
10972 eassert (CONSP (Vmessage_stack
));
10973 Vmessage_stack
= XCDR (Vmessage_stack
);
10977 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10978 exits. If the stack is not empty, we have a missing pop_message
10982 check_message_stack (void)
10984 if (!NILP (Vmessage_stack
))
10989 /* Truncate to NCHARS what will be displayed in the echo area the next
10990 time we display it---but don't redisplay it now. */
10993 truncate_echo_area (ptrdiff_t nchars
)
10996 echo_area_buffer
[0] = Qnil
;
10997 else if (!noninteractive
10999 && !NILP (echo_area_buffer
[0]))
11001 struct frame
*sf
= SELECTED_FRAME ();
11002 /* Error messages get reported properly by cmd_error, so this must be
11003 just an informative message; if the frame hasn't really been
11004 initialized yet, just toss it. */
11005 if (sf
->glyphs_initialized_p
)
11006 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11011 /* Helper function for truncate_echo_area. Truncate the current
11012 message to at most NCHARS characters. */
11015 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11017 if (BEG
+ nchars
< Z
)
11018 del_range (BEG
+ nchars
, Z
);
11020 echo_area_buffer
[0] = Qnil
;
11024 /* Set the current message to STRING. */
11027 set_message (Lisp_Object string
)
11029 eassert (STRINGP (string
));
11031 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11033 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11034 message_buf_print
= false;
11035 help_echo_showing_p
= false;
11037 if (STRINGP (Vdebug_on_message
)
11038 && STRINGP (string
)
11039 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11040 call_debugger (list2 (Qerror
, string
));
11044 /* Helper function for set_message. First argument is ignored and second
11045 argument has the same meaning as for set_message.
11046 This function is called with the echo area buffer being current. */
11049 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11051 eassert (STRINGP (string
));
11053 /* Change multibyteness of the echo buffer appropriately. */
11054 if (message_enable_multibyte
11055 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11056 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11058 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11059 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11060 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11062 /* Insert new message at BEG. */
11063 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11065 /* This function takes care of single/multibyte conversion.
11066 We just have to ensure that the echo area buffer has the right
11067 setting of enable_multibyte_characters. */
11068 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11074 /* Clear messages. CURRENT_P means clear the current message.
11075 LAST_DISPLAYED_P means clear the message last displayed. */
11078 clear_message (bool current_p
, bool last_displayed_p
)
11082 echo_area_buffer
[0] = Qnil
;
11083 message_cleared_p
= true;
11086 if (last_displayed_p
)
11087 echo_area_buffer
[1] = Qnil
;
11089 message_buf_print
= false;
11092 /* Clear garbaged frames.
11094 This function is used where the old redisplay called
11095 redraw_garbaged_frames which in turn called redraw_frame which in
11096 turn called clear_frame. The call to clear_frame was a source of
11097 flickering. I believe a clear_frame is not necessary. It should
11098 suffice in the new redisplay to invalidate all current matrices,
11099 and ensure a complete redisplay of all windows. */
11102 clear_garbaged_frames (void)
11104 if (frame_garbaged
)
11106 Lisp_Object tail
, frame
;
11108 FOR_EACH_FRAME (tail
, frame
)
11110 struct frame
*f
= XFRAME (frame
);
11112 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11117 clear_current_matrices (f
);
11118 fset_redisplay (f
);
11119 f
->garbaged
= false;
11120 f
->resized_p
= false;
11124 frame_garbaged
= false;
11129 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P,
11130 update selected_frame. Value is true if the mini-windows height
11131 has been changed. */
11134 echo_area_display (bool update_frame_p
)
11136 Lisp_Object mini_window
;
11139 bool window_height_changed_p
= false;
11140 struct frame
*sf
= SELECTED_FRAME ();
11142 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11143 w
= XWINDOW (mini_window
);
11144 f
= XFRAME (WINDOW_FRAME (w
));
11146 /* Don't display if frame is invisible or not yet initialized. */
11147 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11150 #ifdef HAVE_WINDOW_SYSTEM
11151 /* When Emacs starts, selected_frame may be the initial terminal
11152 frame. If we let this through, a message would be displayed on
11154 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11156 #endif /* HAVE_WINDOW_SYSTEM */
11158 /* Redraw garbaged frames. */
11159 clear_garbaged_frames ();
11161 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11163 echo_area_window
= mini_window
;
11164 window_height_changed_p
= display_echo_area (w
);
11165 w
->must_be_updated_p
= true;
11167 /* Update the display, unless called from redisplay_internal.
11168 Also don't update the screen during redisplay itself. The
11169 update will happen at the end of redisplay, and an update
11170 here could cause confusion. */
11171 if (update_frame_p
&& !redisplaying_p
)
11175 /* If the display update has been interrupted by pending
11176 input, update mode lines in the frame. Due to the
11177 pending input, it might have been that redisplay hasn't
11178 been called, so that mode lines above the echo area are
11179 garbaged. This looks odd, so we prevent it here. */
11180 if (!display_completed
)
11181 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11183 if (window_height_changed_p
11184 /* Don't do this if Emacs is shutting down. Redisplay
11185 needs to run hooks. */
11186 && !NILP (Vrun_hooks
))
11188 /* Must update other windows. Likewise as in other
11189 cases, don't let this update be interrupted by
11191 ptrdiff_t count
= SPECPDL_INDEX ();
11192 specbind (Qredisplay_dont_pause
, Qt
);
11193 windows_or_buffers_changed
= 44;
11194 redisplay_internal ();
11195 unbind_to (count
, Qnil
);
11197 else if (FRAME_WINDOW_P (f
) && n
== 0)
11199 /* Window configuration is the same as before.
11200 Can do with a display update of the echo area,
11201 unless we displayed some mode lines. */
11202 update_single_window (w
);
11206 update_frame (f
, true, true);
11208 /* If cursor is in the echo area, make sure that the next
11209 redisplay displays the minibuffer, so that the cursor will
11210 be replaced with what the minibuffer wants. */
11211 if (cursor_in_echo_area
)
11212 wset_redisplay (XWINDOW (mini_window
));
11215 else if (!EQ (mini_window
, selected_window
))
11216 wset_redisplay (XWINDOW (mini_window
));
11218 /* Last displayed message is now the current message. */
11219 echo_area_buffer
[1] = echo_area_buffer
[0];
11220 /* Inform read_char that we're not echoing. */
11221 echo_message_buffer
= Qnil
;
11223 /* Prevent redisplay optimization in redisplay_internal by resetting
11224 this_line_start_pos. This is done because the mini-buffer now
11225 displays the message instead of its buffer text. */
11226 if (EQ (mini_window
, selected_window
))
11227 CHARPOS (this_line_start_pos
) = 0;
11229 return window_height_changed_p
;
11232 /* True if W's buffer was changed but not saved. */
11235 window_buffer_changed (struct window
*w
)
11237 struct buffer
*b
= XBUFFER (w
->contents
);
11239 eassert (BUFFER_LIVE_P (b
));
11241 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11244 /* True if W has %c in its mode line and mode line should be updated. */
11247 mode_line_update_needed (struct window
*w
)
11249 return (w
->column_number_displayed
!= -1
11250 && !(PT
== w
->last_point
&& !window_outdated (w
))
11251 && (w
->column_number_displayed
!= current_column ()));
11254 /* True if window start of W is frozen and may not be changed during
11258 window_frozen_p (struct window
*w
)
11260 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11262 Lisp_Object window
;
11264 XSETWINDOW (window
, w
);
11265 if (MINI_WINDOW_P (w
))
11267 else if (EQ (window
, selected_window
))
11269 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11270 && EQ (window
, Vminibuf_scroll_window
))
11271 /* This special window can't be frozen too. */
11279 /***********************************************************************
11280 Mode Lines and Frame Titles
11281 ***********************************************************************/
11283 /* A buffer for constructing non-propertized mode-line strings and
11284 frame titles in it; allocated from the heap in init_xdisp and
11285 resized as needed in store_mode_line_noprop_char. */
11287 static char *mode_line_noprop_buf
;
11289 /* The buffer's end, and a current output position in it. */
11291 static char *mode_line_noprop_buf_end
;
11292 static char *mode_line_noprop_ptr
;
11294 #define MODE_LINE_NOPROP_LEN(start) \
11295 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11298 MODE_LINE_DISPLAY
= 0,
11302 } mode_line_target
;
11304 /* Alist that caches the results of :propertize.
11305 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11306 static Lisp_Object mode_line_proptrans_alist
;
11308 /* List of strings making up the mode-line. */
11309 static Lisp_Object mode_line_string_list
;
11311 /* Base face property when building propertized mode line string. */
11312 static Lisp_Object mode_line_string_face
;
11313 static Lisp_Object mode_line_string_face_prop
;
11316 /* Unwind data for mode line strings */
11318 static Lisp_Object Vmode_line_unwind_vector
;
11321 format_mode_line_unwind_data (struct frame
*target_frame
,
11322 struct buffer
*obuf
,
11324 bool save_proptrans
)
11326 Lisp_Object vector
, tmp
;
11328 /* Reduce consing by keeping one vector in
11329 Vwith_echo_area_save_vector. */
11330 vector
= Vmode_line_unwind_vector
;
11331 Vmode_line_unwind_vector
= Qnil
;
11334 vector
= Fmake_vector (make_number (10), Qnil
);
11336 ASET (vector
, 0, make_number (mode_line_target
));
11337 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11338 ASET (vector
, 2, mode_line_string_list
);
11339 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11340 ASET (vector
, 4, mode_line_string_face
);
11341 ASET (vector
, 5, mode_line_string_face_prop
);
11344 XSETBUFFER (tmp
, obuf
);
11347 ASET (vector
, 6, tmp
);
11348 ASET (vector
, 7, owin
);
11351 /* Similarly to `with-selected-window', if the operation selects
11352 a window on another frame, we must restore that frame's
11353 selected window, and (for a tty) the top-frame. */
11354 ASET (vector
, 8, target_frame
->selected_window
);
11355 if (FRAME_TERMCAP_P (target_frame
))
11356 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11363 unwind_format_mode_line (Lisp_Object vector
)
11365 Lisp_Object old_window
= AREF (vector
, 7);
11366 Lisp_Object target_frame_window
= AREF (vector
, 8);
11367 Lisp_Object old_top_frame
= AREF (vector
, 9);
11369 mode_line_target
= XINT (AREF (vector
, 0));
11370 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11371 mode_line_string_list
= AREF (vector
, 2);
11372 if (! EQ (AREF (vector
, 3), Qt
))
11373 mode_line_proptrans_alist
= AREF (vector
, 3);
11374 mode_line_string_face
= AREF (vector
, 4);
11375 mode_line_string_face_prop
= AREF (vector
, 5);
11377 /* Select window before buffer, since it may change the buffer. */
11378 if (!NILP (old_window
))
11380 /* If the operation that we are unwinding had selected a window
11381 on a different frame, reset its frame-selected-window. For a
11382 text terminal, reset its top-frame if necessary. */
11383 if (!NILP (target_frame_window
))
11386 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11388 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11389 Fselect_window (target_frame_window
, Qt
);
11391 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11392 Fselect_frame (old_top_frame
, Qt
);
11395 Fselect_window (old_window
, Qt
);
11398 if (!NILP (AREF (vector
, 6)))
11400 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11401 ASET (vector
, 6, Qnil
);
11404 Vmode_line_unwind_vector
= vector
;
11408 /* Store a single character C for the frame title in mode_line_noprop_buf.
11409 Re-allocate mode_line_noprop_buf if necessary. */
11412 store_mode_line_noprop_char (char c
)
11414 /* If output position has reached the end of the allocated buffer,
11415 increase the buffer's size. */
11416 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11418 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11419 ptrdiff_t size
= len
;
11420 mode_line_noprop_buf
=
11421 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11422 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11423 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11426 *mode_line_noprop_ptr
++ = c
;
11430 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11431 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11432 characters that yield more columns than PRECISION; PRECISION <= 0
11433 means copy the whole string. Pad with spaces until FIELD_WIDTH
11434 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11435 pad. Called from display_mode_element when it is used to build a
11439 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11441 const unsigned char *str
= (const unsigned char *) string
;
11443 ptrdiff_t dummy
, nbytes
;
11445 /* Copy at most PRECISION chars from STR. */
11446 nbytes
= strlen (string
);
11447 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11449 store_mode_line_noprop_char (*str
++);
11451 /* Fill up with spaces until FIELD_WIDTH reached. */
11452 while (field_width
> 0
11453 && n
< field_width
)
11455 store_mode_line_noprop_char (' ');
11462 /***********************************************************************
11464 ***********************************************************************/
11466 #ifdef HAVE_WINDOW_SYSTEM
11468 /* Set the title of FRAME, if it has changed. The title format is
11469 Vicon_title_format if FRAME is iconified, otherwise it is
11470 frame_title_format. */
11473 x_consider_frame_title (Lisp_Object frame
)
11475 struct frame
*f
= XFRAME (frame
);
11477 if (FRAME_WINDOW_P (f
)
11478 || FRAME_MINIBUF_ONLY_P (f
)
11479 || f
->explicit_name
)
11481 /* Do we have more than one visible frame on this X display? */
11482 Lisp_Object tail
, other_frame
, fmt
;
11483 ptrdiff_t title_start
;
11487 ptrdiff_t count
= SPECPDL_INDEX ();
11489 FOR_EACH_FRAME (tail
, other_frame
)
11491 struct frame
*tf
= XFRAME (other_frame
);
11494 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11495 && !FRAME_MINIBUF_ONLY_P (tf
)
11496 && !EQ (other_frame
, tip_frame
)
11497 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11501 /* Set global variable indicating that multiple frames exist. */
11502 multiple_frames
= CONSP (tail
);
11504 /* Switch to the buffer of selected window of the frame. Set up
11505 mode_line_target so that display_mode_element will output into
11506 mode_line_noprop_buf; then display the title. */
11507 record_unwind_protect (unwind_format_mode_line
,
11508 format_mode_line_unwind_data
11509 (f
, current_buffer
, selected_window
, false));
11511 Fselect_window (f
->selected_window
, Qt
);
11512 set_buffer_internal_1
11513 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11514 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11516 mode_line_target
= MODE_LINE_TITLE
;
11517 title_start
= MODE_LINE_NOPROP_LEN (0);
11518 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11519 NULL
, DEFAULT_FACE_ID
);
11520 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11521 len
= MODE_LINE_NOPROP_LEN (title_start
);
11522 title
= mode_line_noprop_buf
+ title_start
;
11523 unbind_to (count
, Qnil
);
11525 /* Set the title only if it's changed. This avoids consing in
11526 the common case where it hasn't. (If it turns out that we've
11527 already wasted too much time by walking through the list with
11528 display_mode_element, then we might need to optimize at a
11529 higher level than this.) */
11530 if (! STRINGP (f
->name
)
11531 || SBYTES (f
->name
) != len
11532 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11533 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11537 #endif /* not HAVE_WINDOW_SYSTEM */
11540 /***********************************************************************
11542 ***********************************************************************/
11544 /* True if we will not redisplay all visible windows. */
11545 #define REDISPLAY_SOME_P() \
11546 ((windows_or_buffers_changed == 0 \
11547 || windows_or_buffers_changed == REDISPLAY_SOME) \
11548 && (update_mode_lines == 0 \
11549 || update_mode_lines == REDISPLAY_SOME))
11551 /* Prepare for redisplay by updating menu-bar item lists when
11552 appropriate. This can call eval. */
11555 prepare_menu_bars (void)
11557 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11558 bool some_windows
= REDISPLAY_SOME_P ();
11559 struct gcpro gcpro1
, gcpro2
;
11560 Lisp_Object tooltip_frame
;
11562 #ifdef HAVE_WINDOW_SYSTEM
11563 tooltip_frame
= tip_frame
;
11565 tooltip_frame
= Qnil
;
11568 if (FUNCTIONP (Vpre_redisplay_function
))
11570 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11571 if (all_windows
&& some_windows
)
11573 Lisp_Object ws
= window_list ();
11574 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11576 Lisp_Object
this = XCAR (ws
);
11577 struct window
*w
= XWINDOW (this);
11579 || XFRAME (w
->frame
)->redisplay
11580 || XBUFFER (w
->contents
)->text
->redisplay
)
11582 windows
= Fcons (this, windows
);
11586 safe__call1 (true, Vpre_redisplay_function
, windows
);
11589 /* Update all frame titles based on their buffer names, etc. We do
11590 this before the menu bars so that the buffer-menu will show the
11591 up-to-date frame titles. */
11592 #ifdef HAVE_WINDOW_SYSTEM
11595 Lisp_Object tail
, frame
;
11597 FOR_EACH_FRAME (tail
, frame
)
11599 struct frame
*f
= XFRAME (frame
);
11600 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11604 && !XBUFFER (w
->contents
)->text
->redisplay
)
11607 if (!EQ (frame
, tooltip_frame
)
11608 && (FRAME_ICONIFIED_P (f
)
11609 || FRAME_VISIBLE_P (f
) == 1
11610 /* Exclude TTY frames that are obscured because they
11611 are not the top frame on their console. This is
11612 because x_consider_frame_title actually switches
11613 to the frame, which for TTY frames means it is
11614 marked as garbaged, and will be completely
11615 redrawn on the next redisplay cycle. This causes
11616 TTY frames to be completely redrawn, when there
11617 are more than one of them, even though nothing
11618 should be changed on display. */
11619 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11620 x_consider_frame_title (frame
);
11623 #endif /* HAVE_WINDOW_SYSTEM */
11625 /* Update the menu bar item lists, if appropriate. This has to be
11626 done before any actual redisplay or generation of display lines. */
11630 Lisp_Object tail
, frame
;
11631 ptrdiff_t count
= SPECPDL_INDEX ();
11632 /* True means that update_menu_bar has run its hooks
11633 so any further calls to update_menu_bar shouldn't do so again. */
11634 bool menu_bar_hooks_run
= false;
11636 record_unwind_save_match_data ();
11638 FOR_EACH_FRAME (tail
, frame
)
11640 struct frame
*f
= XFRAME (frame
);
11641 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11643 /* Ignore tooltip frame. */
11644 if (EQ (frame
, tooltip_frame
))
11650 && !XBUFFER (w
->contents
)->text
->redisplay
)
11653 /* If a window on this frame changed size, report that to
11654 the user and clear the size-change flag. */
11655 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11657 Lisp_Object functions
;
11659 /* Clear flag first in case we get an error below. */
11660 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11661 functions
= Vwindow_size_change_functions
;
11662 GCPRO2 (tail
, functions
);
11664 while (CONSP (functions
))
11666 if (!EQ (XCAR (functions
), Qt
))
11667 call1 (XCAR (functions
), frame
);
11668 functions
= XCDR (functions
);
11674 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11675 #ifdef HAVE_WINDOW_SYSTEM
11676 update_tool_bar (f
, false);
11681 unbind_to (count
, Qnil
);
11685 struct frame
*sf
= SELECTED_FRAME ();
11686 update_menu_bar (sf
, true, false);
11687 #ifdef HAVE_WINDOW_SYSTEM
11688 update_tool_bar (sf
, true);
11694 /* Update the menu bar item list for frame F. This has to be done
11695 before we start to fill in any display lines, because it can call
11698 If SAVE_MATCH_DATA, we must save and restore it here.
11700 If HOOKS_RUN, a previous call to update_menu_bar
11701 already ran the menu bar hooks for this redisplay, so there
11702 is no need to run them again. The return value is the
11703 updated value of this flag, to pass to the next call. */
11706 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11708 Lisp_Object window
;
11711 /* If called recursively during a menu update, do nothing. This can
11712 happen when, for instance, an activate-menubar-hook causes a
11714 if (inhibit_menubar_update
)
11717 window
= FRAME_SELECTED_WINDOW (f
);
11718 w
= XWINDOW (window
);
11720 if (FRAME_WINDOW_P (f
)
11722 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11723 || defined (HAVE_NS) || defined (USE_GTK)
11724 FRAME_EXTERNAL_MENU_BAR (f
)
11726 FRAME_MENU_BAR_LINES (f
) > 0
11728 : FRAME_MENU_BAR_LINES (f
) > 0)
11730 /* If the user has switched buffers or windows, we need to
11731 recompute to reflect the new bindings. But we'll
11732 recompute when update_mode_lines is set too; that means
11733 that people can use force-mode-line-update to request
11734 that the menu bar be recomputed. The adverse effect on
11735 the rest of the redisplay algorithm is about the same as
11736 windows_or_buffers_changed anyway. */
11737 if (windows_or_buffers_changed
11738 /* This used to test w->update_mode_line, but we believe
11739 there is no need to recompute the menu in that case. */
11740 || update_mode_lines
11741 || window_buffer_changed (w
))
11743 struct buffer
*prev
= current_buffer
;
11744 ptrdiff_t count
= SPECPDL_INDEX ();
11746 specbind (Qinhibit_menubar_update
, Qt
);
11748 set_buffer_internal_1 (XBUFFER (w
->contents
));
11749 if (save_match_data
)
11750 record_unwind_save_match_data ();
11751 if (NILP (Voverriding_local_map_menu_flag
))
11753 specbind (Qoverriding_terminal_local_map
, Qnil
);
11754 specbind (Qoverriding_local_map
, Qnil
);
11759 /* Run the Lucid hook. */
11760 safe_run_hooks (Qactivate_menubar_hook
);
11762 /* If it has changed current-menubar from previous value,
11763 really recompute the menu-bar from the value. */
11764 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11765 call0 (Qrecompute_lucid_menubar
);
11767 safe_run_hooks (Qmenu_bar_update_hook
);
11772 XSETFRAME (Vmenu_updating_frame
, f
);
11773 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11775 /* Redisplay the menu bar in case we changed it. */
11776 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11777 || defined (HAVE_NS) || defined (USE_GTK)
11778 if (FRAME_WINDOW_P (f
))
11780 #if defined (HAVE_NS)
11781 /* All frames on Mac OS share the same menubar. So only
11782 the selected frame should be allowed to set it. */
11783 if (f
== SELECTED_FRAME ())
11785 set_frame_menubar (f
, false, false);
11788 /* On a terminal screen, the menu bar is an ordinary screen
11789 line, and this makes it get updated. */
11790 w
->update_mode_line
= true;
11791 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11792 /* In the non-toolkit version, the menu bar is an ordinary screen
11793 line, and this makes it get updated. */
11794 w
->update_mode_line
= true;
11795 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11797 unbind_to (count
, Qnil
);
11798 set_buffer_internal_1 (prev
);
11805 /***********************************************************************
11807 ***********************************************************************/
11809 #ifdef HAVE_WINDOW_SYSTEM
11811 /* Select `frame' temporarily without running all the code in
11813 FIXME: Maybe do_switch_frame should be trimmed down similarly
11814 when `norecord' is set. */
11816 fast_set_selected_frame (Lisp_Object frame
)
11818 if (!EQ (selected_frame
, frame
))
11820 selected_frame
= frame
;
11821 selected_window
= XFRAME (frame
)->selected_window
;
11825 /* Update the tool-bar item list for frame F. This has to be done
11826 before we start to fill in any display lines. Called from
11827 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11828 and restore it here. */
11831 update_tool_bar (struct frame
*f
, bool save_match_data
)
11833 #if defined (USE_GTK) || defined (HAVE_NS)
11834 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11836 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11837 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11842 Lisp_Object window
;
11845 window
= FRAME_SELECTED_WINDOW (f
);
11846 w
= XWINDOW (window
);
11848 /* If the user has switched buffers or windows, we need to
11849 recompute to reflect the new bindings. But we'll
11850 recompute when update_mode_lines is set too; that means
11851 that people can use force-mode-line-update to request
11852 that the menu bar be recomputed. The adverse effect on
11853 the rest of the redisplay algorithm is about the same as
11854 windows_or_buffers_changed anyway. */
11855 if (windows_or_buffers_changed
11856 || w
->update_mode_line
11857 || update_mode_lines
11858 || window_buffer_changed (w
))
11860 struct buffer
*prev
= current_buffer
;
11861 ptrdiff_t count
= SPECPDL_INDEX ();
11862 Lisp_Object frame
, new_tool_bar
;
11863 int new_n_tool_bar
;
11864 struct gcpro gcpro1
;
11866 /* Set current_buffer to the buffer of the selected
11867 window of the frame, so that we get the right local
11869 set_buffer_internal_1 (XBUFFER (w
->contents
));
11871 /* Save match data, if we must. */
11872 if (save_match_data
)
11873 record_unwind_save_match_data ();
11875 /* Make sure that we don't accidentally use bogus keymaps. */
11876 if (NILP (Voverriding_local_map_menu_flag
))
11878 specbind (Qoverriding_terminal_local_map
, Qnil
);
11879 specbind (Qoverriding_local_map
, Qnil
);
11882 GCPRO1 (new_tool_bar
);
11884 /* We must temporarily set the selected frame to this frame
11885 before calling tool_bar_items, because the calculation of
11886 the tool-bar keymap uses the selected frame (see
11887 `tool-bar-make-keymap' in tool-bar.el). */
11888 eassert (EQ (selected_window
,
11889 /* Since we only explicitly preserve selected_frame,
11890 check that selected_window would be redundant. */
11891 XFRAME (selected_frame
)->selected_window
));
11892 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11893 XSETFRAME (frame
, f
);
11894 fast_set_selected_frame (frame
);
11896 /* Build desired tool-bar items from keymaps. */
11898 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11901 /* Redisplay the tool-bar if we changed it. */
11902 if (new_n_tool_bar
!= f
->n_tool_bar_items
11903 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11905 /* Redisplay that happens asynchronously due to an expose event
11906 may access f->tool_bar_items. Make sure we update both
11907 variables within BLOCK_INPUT so no such event interrupts. */
11909 fset_tool_bar_items (f
, new_tool_bar
);
11910 f
->n_tool_bar_items
= new_n_tool_bar
;
11911 w
->update_mode_line
= true;
11917 unbind_to (count
, Qnil
);
11918 set_buffer_internal_1 (prev
);
11923 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11925 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11926 F's desired tool-bar contents. F->tool_bar_items must have
11927 been set up previously by calling prepare_menu_bars. */
11930 build_desired_tool_bar_string (struct frame
*f
)
11932 int i
, size
, size_needed
;
11933 struct gcpro gcpro1
, gcpro2
;
11934 Lisp_Object image
, plist
;
11936 image
= plist
= Qnil
;
11937 GCPRO2 (image
, plist
);
11939 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11940 Otherwise, make a new string. */
11942 /* The size of the string we might be able to reuse. */
11943 size
= (STRINGP (f
->desired_tool_bar_string
)
11944 ? SCHARS (f
->desired_tool_bar_string
)
11947 /* We need one space in the string for each image. */
11948 size_needed
= f
->n_tool_bar_items
;
11950 /* Reuse f->desired_tool_bar_string, if possible. */
11951 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11952 fset_desired_tool_bar_string
11953 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11956 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11957 struct gcpro gcpro1
;
11959 Fremove_text_properties (make_number (0), make_number (size
),
11960 props
, f
->desired_tool_bar_string
);
11964 /* Put a `display' property on the string for the images to display,
11965 put a `menu_item' property on tool-bar items with a value that
11966 is the index of the item in F's tool-bar item vector. */
11967 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11969 #define PROP(IDX) \
11970 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11972 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11973 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11974 int hmargin
, vmargin
, relief
, idx
, end
;
11976 /* If image is a vector, choose the image according to the
11978 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11979 if (VECTORP (image
))
11983 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11984 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11987 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11988 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11990 eassert (ASIZE (image
) >= idx
);
11991 image
= AREF (image
, idx
);
11996 /* Ignore invalid image specifications. */
11997 if (!valid_image_p (image
))
12000 /* Display the tool-bar button pressed, or depressed. */
12001 plist
= Fcopy_sequence (XCDR (image
));
12003 /* Compute margin and relief to draw. */
12004 relief
= (tool_bar_button_relief
>= 0
12005 ? tool_bar_button_relief
12006 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12007 hmargin
= vmargin
= relief
;
12009 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12010 INT_MAX
- max (hmargin
, vmargin
)))
12012 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12013 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12015 else if (CONSP (Vtool_bar_button_margin
))
12017 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12018 INT_MAX
- hmargin
))
12019 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12021 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12022 INT_MAX
- vmargin
))
12023 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12026 if (auto_raise_tool_bar_buttons_p
)
12028 /* Add a `:relief' property to the image spec if the item is
12032 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12039 /* If image is selected, display it pressed, i.e. with a
12040 negative relief. If it's not selected, display it with a
12042 plist
= Fplist_put (plist
, QCrelief
,
12044 ? make_number (-relief
)
12045 : make_number (relief
)));
12050 /* Put a margin around the image. */
12051 if (hmargin
|| vmargin
)
12053 if (hmargin
== vmargin
)
12054 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12056 plist
= Fplist_put (plist
, QCmargin
,
12057 Fcons (make_number (hmargin
),
12058 make_number (vmargin
)));
12061 /* If button is not enabled, and we don't have special images
12062 for the disabled state, make the image appear disabled by
12063 applying an appropriate algorithm to it. */
12064 if (!enabled_p
&& idx
< 0)
12065 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12067 /* Put a `display' text property on the string for the image to
12068 display. Put a `menu-item' property on the string that gives
12069 the start of this item's properties in the tool-bar items
12071 image
= Fcons (Qimage
, plist
);
12072 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12073 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12074 struct gcpro gcpro1
;
12077 /* Let the last image hide all remaining spaces in the tool bar
12078 string. The string can be longer than needed when we reuse a
12079 previous string. */
12080 if (i
+ 1 == f
->n_tool_bar_items
)
12081 end
= SCHARS (f
->desired_tool_bar_string
);
12084 Fadd_text_properties (make_number (i
), make_number (end
),
12085 props
, f
->desired_tool_bar_string
);
12094 /* Display one line of the tool-bar of frame IT->f.
12096 HEIGHT specifies the desired height of the tool-bar line.
12097 If the actual height of the glyph row is less than HEIGHT, the
12098 row's height is increased to HEIGHT, and the icons are centered
12099 vertically in the new height.
12101 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12102 count a final empty row in case the tool-bar width exactly matches
12107 display_tool_bar_line (struct it
*it
, int height
)
12109 struct glyph_row
*row
= it
->glyph_row
;
12110 int max_x
= it
->last_visible_x
;
12111 struct glyph
*last
;
12113 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12114 clear_glyph_row (row
);
12115 row
->enabled_p
= true;
12116 row
->y
= it
->current_y
;
12118 /* Note that this isn't made use of if the face hasn't a box,
12119 so there's no need to check the face here. */
12120 it
->start_of_box_run_p
= true;
12122 while (it
->current_x
< max_x
)
12124 int x
, n_glyphs_before
, i
, nglyphs
;
12125 struct it it_before
;
12127 /* Get the next display element. */
12128 if (!get_next_display_element (it
))
12130 /* Don't count empty row if we are counting needed tool-bar lines. */
12131 if (height
< 0 && !it
->hpos
)
12136 /* Produce glyphs. */
12137 n_glyphs_before
= row
->used
[TEXT_AREA
];
12140 PRODUCE_GLYPHS (it
);
12142 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12144 x
= it_before
.current_x
;
12145 while (i
< nglyphs
)
12147 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12149 if (x
+ glyph
->pixel_width
> max_x
)
12151 /* Glyph doesn't fit on line. Backtrack. */
12152 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12154 /* If this is the only glyph on this line, it will never fit on the
12155 tool-bar, so skip it. But ensure there is at least one glyph,
12156 so we don't accidentally disable the tool-bar. */
12157 if (n_glyphs_before
== 0
12158 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12164 x
+= glyph
->pixel_width
;
12168 /* Stop at line end. */
12169 if (ITERATOR_AT_END_OF_LINE_P (it
))
12172 set_iterator_to_next (it
, true);
12177 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12179 /* Use default face for the border below the tool bar.
12181 FIXME: When auto-resize-tool-bars is grow-only, there is
12182 no additional border below the possibly empty tool-bar lines.
12183 So to make the extra empty lines look "normal", we have to
12184 use the tool-bar face for the border too. */
12185 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12186 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12187 it
->face_id
= DEFAULT_FACE_ID
;
12189 extend_face_to_end_of_line (it
);
12190 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12191 last
->right_box_line_p
= true;
12192 if (last
== row
->glyphs
[TEXT_AREA
])
12193 last
->left_box_line_p
= true;
12195 /* Make line the desired height and center it vertically. */
12196 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12198 /* Don't add more than one line height. */
12199 height
%= FRAME_LINE_HEIGHT (it
->f
);
12200 it
->max_ascent
+= height
/ 2;
12201 it
->max_descent
+= (height
+ 1) / 2;
12204 compute_line_metrics (it
);
12206 /* If line is empty, make it occupy the rest of the tool-bar. */
12207 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12209 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12210 row
->visible_height
= row
->height
;
12211 row
->ascent
= row
->phys_ascent
= 0;
12212 row
->extra_line_spacing
= 0;
12215 row
->full_width_p
= true;
12216 row
->continued_p
= false;
12217 row
->truncated_on_left_p
= false;
12218 row
->truncated_on_right_p
= false;
12220 it
->current_x
= it
->hpos
= 0;
12221 it
->current_y
+= row
->height
;
12227 /* Value is the number of pixels needed to make all tool-bar items of
12228 frame F visible. The actual number of glyph rows needed is
12229 returned in *N_ROWS if non-NULL. */
12231 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12233 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12235 /* tool_bar_height is called from redisplay_tool_bar after building
12236 the desired matrix, so use (unused) mode-line row as temporary row to
12237 avoid destroying the first tool-bar row. */
12238 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12240 /* Initialize an iterator for iteration over
12241 F->desired_tool_bar_string in the tool-bar window of frame F. */
12242 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12243 temp_row
->reversed_p
= false;
12244 it
.first_visible_x
= 0;
12245 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12246 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12247 it
.paragraph_embedding
= L2R
;
12249 while (!ITERATOR_AT_END_P (&it
))
12251 clear_glyph_row (temp_row
);
12252 it
.glyph_row
= temp_row
;
12253 display_tool_bar_line (&it
, -1);
12255 clear_glyph_row (temp_row
);
12257 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12259 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12262 return it
.current_y
;
12264 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12267 #endif /* !USE_GTK && !HAVE_NS */
12269 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12271 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12272 If FRAME is nil or omitted, use the selected frame. Optional argument
12273 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12274 (Lisp_Object frame
, Lisp_Object pixelwise
)
12278 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12279 struct frame
*f
= decode_any_frame (frame
);
12281 if (WINDOWP (f
->tool_bar_window
)
12282 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12284 update_tool_bar (f
, true);
12285 if (f
->n_tool_bar_items
)
12287 build_desired_tool_bar_string (f
);
12288 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12293 return make_number (height
);
12297 /* Display the tool-bar of frame F. Value is true if tool-bar's
12298 height should be changed. */
12300 redisplay_tool_bar (struct frame
*f
)
12302 #if defined (USE_GTK) || defined (HAVE_NS)
12304 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12305 update_frame_tool_bar (f
);
12308 #else /* !USE_GTK && !HAVE_NS */
12312 struct glyph_row
*row
;
12314 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12315 do anything. This means you must start with tool-bar-lines
12316 non-zero to get the auto-sizing effect. Or in other words, you
12317 can turn off tool-bars by specifying tool-bar-lines zero. */
12318 if (!WINDOWP (f
->tool_bar_window
)
12319 || (w
= XWINDOW (f
->tool_bar_window
),
12320 WINDOW_TOTAL_LINES (w
) == 0))
12323 /* Set up an iterator for the tool-bar window. */
12324 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12325 it
.first_visible_x
= 0;
12326 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12327 row
= it
.glyph_row
;
12328 row
->reversed_p
= false;
12330 /* Build a string that represents the contents of the tool-bar. */
12331 build_desired_tool_bar_string (f
);
12332 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12333 /* FIXME: This should be controlled by a user option. But it
12334 doesn't make sense to have an R2L tool bar if the menu bar cannot
12335 be drawn also R2L, and making the menu bar R2L is tricky due
12336 toolkit-specific code that implements it. If an R2L tool bar is
12337 ever supported, display_tool_bar_line should also be augmented to
12338 call unproduce_glyphs like display_line and display_string
12340 it
.paragraph_embedding
= L2R
;
12342 if (f
->n_tool_bar_rows
== 0)
12344 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12346 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12348 x_change_tool_bar_height (f
, new_height
);
12349 frame_default_tool_bar_height
= new_height
;
12350 /* Always do that now. */
12351 clear_glyph_matrix (w
->desired_matrix
);
12352 f
->fonts_changed
= true;
12357 /* Display as many lines as needed to display all tool-bar items. */
12359 if (f
->n_tool_bar_rows
> 0)
12361 int border
, rows
, height
, extra
;
12363 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12364 border
= XINT (Vtool_bar_border
);
12365 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12366 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12367 else if (EQ (Vtool_bar_border
, Qborder_width
))
12368 border
= f
->border_width
;
12374 rows
= f
->n_tool_bar_rows
;
12375 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12376 extra
= it
.last_visible_y
- border
- height
* rows
;
12378 while (it
.current_y
< it
.last_visible_y
)
12381 if (extra
> 0 && rows
-- > 0)
12383 h
= (extra
+ rows
- 1) / rows
;
12386 display_tool_bar_line (&it
, height
+ h
);
12391 while (it
.current_y
< it
.last_visible_y
)
12392 display_tool_bar_line (&it
, 0);
12395 /* It doesn't make much sense to try scrolling in the tool-bar
12396 window, so don't do it. */
12397 w
->desired_matrix
->no_scrolling_p
= true;
12398 w
->must_be_updated_p
= true;
12400 if (!NILP (Vauto_resize_tool_bars
))
12402 bool change_height_p
= true;
12404 /* If we couldn't display everything, change the tool-bar's
12405 height if there is room for more. */
12406 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12407 change_height_p
= true;
12409 /* We subtract 1 because display_tool_bar_line advances the
12410 glyph_row pointer before returning to its caller. We want to
12411 examine the last glyph row produced by
12412 display_tool_bar_line. */
12413 row
= it
.glyph_row
- 1;
12415 /* If there are blank lines at the end, except for a partially
12416 visible blank line at the end that is smaller than
12417 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12418 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12419 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12420 change_height_p
= true;
12422 /* If row displays tool-bar items, but is partially visible,
12423 change the tool-bar's height. */
12424 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12425 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12426 change_height_p
= true;
12428 /* Resize windows as needed by changing the `tool-bar-lines'
12429 frame parameter. */
12430 if (change_height_p
)
12433 int new_height
= tool_bar_height (f
, &nrows
, true);
12435 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12436 && !f
->minimize_tool_bar_window_p
)
12437 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12438 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12439 f
->minimize_tool_bar_window_p
= false;
12441 if (change_height_p
)
12443 x_change_tool_bar_height (f
, new_height
);
12444 frame_default_tool_bar_height
= new_height
;
12445 clear_glyph_matrix (w
->desired_matrix
);
12446 f
->n_tool_bar_rows
= nrows
;
12447 f
->fonts_changed
= true;
12454 f
->minimize_tool_bar_window_p
= false;
12457 #endif /* USE_GTK || HAVE_NS */
12460 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12462 /* Get information about the tool-bar item which is displayed in GLYPH
12463 on frame F. Return in *PROP_IDX the index where tool-bar item
12464 properties start in F->tool_bar_items. Value is false if
12465 GLYPH doesn't display a tool-bar item. */
12468 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12473 /* This function can be called asynchronously, which means we must
12474 exclude any possibility that Fget_text_property signals an
12476 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12477 charpos
= max (0, charpos
);
12479 /* Get the text property `menu-item' at pos. The value of that
12480 property is the start index of this item's properties in
12481 F->tool_bar_items. */
12482 prop
= Fget_text_property (make_number (charpos
),
12483 Qmenu_item
, f
->current_tool_bar_string
);
12484 if (! INTEGERP (prop
))
12486 *prop_idx
= XINT (prop
);
12491 /* Get information about the tool-bar item at position X/Y on frame F.
12492 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12493 the current matrix of the tool-bar window of F, or NULL if not
12494 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12495 item in F->tool_bar_items. Value is
12497 -1 if X/Y is not on a tool-bar item
12498 0 if X/Y is on the same item that was highlighted before.
12502 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12503 int *hpos
, int *vpos
, int *prop_idx
)
12505 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12506 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12509 /* Find the glyph under X/Y. */
12510 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12511 if (*glyph
== NULL
)
12514 /* Get the start of this tool-bar item's properties in
12515 f->tool_bar_items. */
12516 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12519 /* Is mouse on the highlighted item? */
12520 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12521 && *vpos
>= hlinfo
->mouse_face_beg_row
12522 && *vpos
<= hlinfo
->mouse_face_end_row
12523 && (*vpos
> hlinfo
->mouse_face_beg_row
12524 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12525 && (*vpos
< hlinfo
->mouse_face_end_row
12526 || *hpos
< hlinfo
->mouse_face_end_col
12527 || hlinfo
->mouse_face_past_end
))
12535 Handle mouse button event on the tool-bar of frame F, at
12536 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12537 false for button release. MODIFIERS is event modifiers for button
12541 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12544 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12545 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12546 int hpos
, vpos
, prop_idx
;
12547 struct glyph
*glyph
;
12548 Lisp_Object enabled_p
;
12551 /* If not on the highlighted tool-bar item, and mouse-highlight is
12552 non-nil, return. This is so we generate the tool-bar button
12553 click only when the mouse button is released on the same item as
12554 where it was pressed. However, when mouse-highlight is disabled,
12555 generate the click when the button is released regardless of the
12556 highlight, since tool-bar items are not highlighted in that
12558 frame_to_window_pixel_xy (w
, &x
, &y
);
12559 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12561 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12564 /* When mouse-highlight is off, generate the click for the item
12565 where the button was pressed, disregarding where it was
12567 if (NILP (Vmouse_highlight
) && !down_p
)
12568 prop_idx
= f
->last_tool_bar_item
;
12570 /* If item is disabled, do nothing. */
12571 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12572 if (NILP (enabled_p
))
12577 /* Show item in pressed state. */
12578 if (!NILP (Vmouse_highlight
))
12579 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12580 f
->last_tool_bar_item
= prop_idx
;
12584 Lisp_Object key
, frame
;
12585 struct input_event event
;
12586 EVENT_INIT (event
);
12588 /* Show item in released state. */
12589 if (!NILP (Vmouse_highlight
))
12590 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12592 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12594 XSETFRAME (frame
, f
);
12595 event
.kind
= TOOL_BAR_EVENT
;
12596 event
.frame_or_window
= frame
;
12598 kbd_buffer_store_event (&event
);
12600 event
.kind
= TOOL_BAR_EVENT
;
12601 event
.frame_or_window
= frame
;
12603 event
.modifiers
= modifiers
;
12604 kbd_buffer_store_event (&event
);
12605 f
->last_tool_bar_item
= -1;
12610 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12611 tool-bar window-relative coordinates X/Y. Called from
12612 note_mouse_highlight. */
12615 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12617 Lisp_Object window
= f
->tool_bar_window
;
12618 struct window
*w
= XWINDOW (window
);
12619 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12620 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12622 struct glyph
*glyph
;
12623 struct glyph_row
*row
;
12625 Lisp_Object enabled_p
;
12627 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12631 /* Function note_mouse_highlight is called with negative X/Y
12632 values when mouse moves outside of the frame. */
12633 if (x
<= 0 || y
<= 0)
12635 clear_mouse_face (hlinfo
);
12639 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12642 /* Not on tool-bar item. */
12643 clear_mouse_face (hlinfo
);
12647 /* On same tool-bar item as before. */
12648 goto set_help_echo
;
12650 clear_mouse_face (hlinfo
);
12652 /* Mouse is down, but on different tool-bar item? */
12653 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12654 && f
== dpyinfo
->last_mouse_frame
);
12656 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12659 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12661 /* If tool-bar item is not enabled, don't highlight it. */
12662 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12663 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12665 /* Compute the x-position of the glyph. In front and past the
12666 image is a space. We include this in the highlighted area. */
12667 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12668 for (i
= x
= 0; i
< hpos
; ++i
)
12669 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12671 /* Record this as the current active region. */
12672 hlinfo
->mouse_face_beg_col
= hpos
;
12673 hlinfo
->mouse_face_beg_row
= vpos
;
12674 hlinfo
->mouse_face_beg_x
= x
;
12675 hlinfo
->mouse_face_past_end
= false;
12677 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12678 hlinfo
->mouse_face_end_row
= vpos
;
12679 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12680 hlinfo
->mouse_face_window
= window
;
12681 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12683 /* Display it as active. */
12684 show_mouse_face (hlinfo
, draw
);
12689 /* Set help_echo_string to a help string to display for this tool-bar item.
12690 XTread_socket does the rest. */
12691 help_echo_object
= help_echo_window
= Qnil
;
12692 help_echo_pos
= -1;
12693 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12694 if (NILP (help_echo_string
))
12695 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12698 #endif /* !USE_GTK && !HAVE_NS */
12700 #endif /* HAVE_WINDOW_SYSTEM */
12704 /************************************************************************
12705 Horizontal scrolling
12706 ************************************************************************/
12708 /* For all leaf windows in the window tree rooted at WINDOW, set their
12709 hscroll value so that PT is (i) visible in the window, and (ii) so
12710 that it is not within a certain margin at the window's left and
12711 right border. Value is true if any window's hscroll has been
12715 hscroll_window_tree (Lisp_Object window
)
12717 bool hscrolled_p
= false;
12718 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12719 int hscroll_step_abs
= 0;
12720 double hscroll_step_rel
= 0;
12722 if (hscroll_relative_p
)
12724 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12725 if (hscroll_step_rel
< 0)
12727 hscroll_relative_p
= false;
12728 hscroll_step_abs
= 0;
12731 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12733 hscroll_step_abs
= XINT (Vhscroll_step
);
12734 if (hscroll_step_abs
< 0)
12735 hscroll_step_abs
= 0;
12738 hscroll_step_abs
= 0;
12740 while (WINDOWP (window
))
12742 struct window
*w
= XWINDOW (window
);
12744 if (WINDOWP (w
->contents
))
12745 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12746 else if (w
->cursor
.vpos
>= 0)
12749 int text_area_width
;
12750 struct glyph_row
*cursor_row
;
12751 struct glyph_row
*bottom_row
;
12753 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12754 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12755 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12757 cursor_row
= bottom_row
- 1;
12759 if (!cursor_row
->enabled_p
)
12761 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12762 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12763 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12765 cursor_row
= bottom_row
- 1;
12767 bool row_r2l_p
= cursor_row
->reversed_p
;
12769 text_area_width
= window_box_width (w
, TEXT_AREA
);
12771 /* Scroll when cursor is inside this scroll margin. */
12772 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12774 /* If the position of this window's point has explicitly
12775 changed, no more suspend auto hscrolling. */
12776 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12777 w
->suspend_auto_hscroll
= false;
12779 /* Remember window point. */
12780 Fset_marker (w
->old_pointm
,
12781 ((w
== XWINDOW (selected_window
))
12782 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12783 : Fmarker_position (w
->pointm
)),
12786 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12787 && !w
->suspend_auto_hscroll
12788 /* In some pathological cases, like restoring a window
12789 configuration into a frame that is much smaller than
12790 the one from which the configuration was saved, we
12791 get glyph rows whose start and end have zero buffer
12792 positions, which we cannot handle below. Just skip
12794 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12795 /* For left-to-right rows, hscroll when cursor is either
12796 (i) inside the right hscroll margin, or (ii) if it is
12797 inside the left margin and the window is already
12800 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12801 || (cursor_row
->enabled_p
12802 && cursor_row
->truncated_on_right_p
12803 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12804 /* For right-to-left rows, the logic is similar,
12805 except that rules for scrolling to left and right
12806 are reversed. E.g., if cursor.x <= h_margin, we
12807 need to hscroll "to the right" unconditionally,
12808 and that will scroll the screen to the left so as
12809 to reveal the next portion of the row. */
12811 && ((cursor_row
->enabled_p
12812 /* FIXME: It is confusing to set the
12813 truncated_on_right_p flag when R2L rows
12814 are actually truncated on the left. */
12815 && cursor_row
->truncated_on_right_p
12816 && w
->cursor
.x
<= h_margin
)
12818 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12822 struct buffer
*saved_current_buffer
;
12826 /* Find point in a display of infinite width. */
12827 saved_current_buffer
= current_buffer
;
12828 current_buffer
= XBUFFER (w
->contents
);
12830 if (w
== XWINDOW (selected_window
))
12833 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12835 /* Move iterator to pt starting at cursor_row->start in
12836 a line with infinite width. */
12837 init_to_row_start (&it
, w
, cursor_row
);
12838 it
.last_visible_x
= INFINITY
;
12839 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12840 current_buffer
= saved_current_buffer
;
12842 /* Position cursor in window. */
12843 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12844 hscroll
= max (0, (it
.current_x
12845 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12846 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12847 : (text_area_width
/ 2))))
12848 / FRAME_COLUMN_WIDTH (it
.f
);
12849 else if ((!row_r2l_p
12850 && w
->cursor
.x
>= text_area_width
- h_margin
)
12851 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12853 if (hscroll_relative_p
)
12854 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12857 wanted_x
= text_area_width
12858 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12861 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12865 if (hscroll_relative_p
)
12866 wanted_x
= text_area_width
* hscroll_step_rel
12869 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12872 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12874 hscroll
= max (hscroll
, w
->min_hscroll
);
12876 /* Don't prevent redisplay optimizations if hscroll
12877 hasn't changed, as it will unnecessarily slow down
12879 if (w
->hscroll
!= hscroll
)
12881 struct buffer
*b
= XBUFFER (w
->contents
);
12882 b
->prevent_redisplay_optimizations_p
= true;
12883 w
->hscroll
= hscroll
;
12884 hscrolled_p
= true;
12892 /* Value is true if hscroll of any leaf window has been changed. */
12893 return hscrolled_p
;
12897 /* Set hscroll so that cursor is visible and not inside horizontal
12898 scroll margins for all windows in the tree rooted at WINDOW. See
12899 also hscroll_window_tree above. Value is true if any window's
12900 hscroll has been changed. If it has, desired matrices on the frame
12901 of WINDOW are cleared. */
12904 hscroll_windows (Lisp_Object window
)
12906 bool hscrolled_p
= hscroll_window_tree (window
);
12908 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12909 return hscrolled_p
;
12914 /************************************************************************
12916 ************************************************************************/
12918 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12919 This is sometimes handy to have in a debugger session. */
12923 /* First and last unchanged row for try_window_id. */
12925 static int debug_first_unchanged_at_end_vpos
;
12926 static int debug_last_unchanged_at_beg_vpos
;
12928 /* Delta vpos and y. */
12930 static int debug_dvpos
, debug_dy
;
12932 /* Delta in characters and bytes for try_window_id. */
12934 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12936 /* Values of window_end_pos and window_end_vpos at the end of
12939 static ptrdiff_t debug_end_vpos
;
12941 /* Append a string to W->desired_matrix->method. FMT is a printf
12942 format string. If trace_redisplay_p is true also printf the
12943 resulting string to stderr. */
12945 static void debug_method_add (struct window
*, char const *, ...)
12946 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12949 debug_method_add (struct window
*w
, char const *fmt
, ...)
12952 char *method
= w
->desired_matrix
->method
;
12953 int len
= strlen (method
);
12954 int size
= sizeof w
->desired_matrix
->method
;
12955 int remaining
= size
- len
- 1;
12958 if (len
&& remaining
)
12961 --remaining
, ++len
;
12964 va_start (ap
, fmt
);
12965 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12968 if (trace_redisplay_p
)
12969 fprintf (stderr
, "%p (%s): %s\n",
12971 ((BUFFERP (w
->contents
)
12972 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12973 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12978 #endif /* GLYPH_DEBUG */
12981 /* Value is true if all changes in window W, which displays
12982 current_buffer, are in the text between START and END. START is a
12983 buffer position, END is given as a distance from Z. Used in
12984 redisplay_internal for display optimization. */
12987 text_outside_line_unchanged_p (struct window
*w
,
12988 ptrdiff_t start
, ptrdiff_t end
)
12990 bool unchanged_p
= true;
12992 /* If text or overlays have changed, see where. */
12993 if (window_outdated (w
))
12995 /* Gap in the line? */
12996 if (GPT
< start
|| Z
- GPT
< end
)
12997 unchanged_p
= false;
12999 /* Changes start in front of the line, or end after it? */
13001 && (BEG_UNCHANGED
< start
- 1
13002 || END_UNCHANGED
< end
))
13003 unchanged_p
= false;
13005 /* If selective display, can't optimize if changes start at the
13006 beginning of the line. */
13008 && INTEGERP (BVAR (current_buffer
, selective_display
))
13009 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13010 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13011 unchanged_p
= false;
13013 /* If there are overlays at the start or end of the line, these
13014 may have overlay strings with newlines in them. A change at
13015 START, for instance, may actually concern the display of such
13016 overlay strings as well, and they are displayed on different
13017 lines. So, quickly rule out this case. (For the future, it
13018 might be desirable to implement something more telling than
13019 just BEG/END_UNCHANGED.) */
13022 if (BEG
+ BEG_UNCHANGED
== start
13023 && overlay_touches_p (start
))
13024 unchanged_p
= false;
13025 if (END_UNCHANGED
== end
13026 && overlay_touches_p (Z
- end
))
13027 unchanged_p
= false;
13030 /* Under bidi reordering, adding or deleting a character in the
13031 beginning of a paragraph, before the first strong directional
13032 character, can change the base direction of the paragraph (unless
13033 the buffer specifies a fixed paragraph direction), which will
13034 require to redisplay the whole paragraph. It might be worthwhile
13035 to find the paragraph limits and widen the range of redisplayed
13036 lines to that, but for now just give up this optimization. */
13037 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13038 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13039 unchanged_p
= false;
13042 return unchanged_p
;
13046 /* Do a frame update, taking possible shortcuts into account. This is
13047 the main external entry point for redisplay.
13049 If the last redisplay displayed an echo area message and that message
13050 is no longer requested, we clear the echo area or bring back the
13051 mini-buffer if that is in use. */
13056 redisplay_internal ();
13061 overlay_arrow_string_or_property (Lisp_Object var
)
13065 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13068 return Voverlay_arrow_string
;
13071 /* Return true if there are any overlay-arrows in current_buffer. */
13073 overlay_arrow_in_current_buffer_p (void)
13077 for (vlist
= Voverlay_arrow_variable_list
;
13079 vlist
= XCDR (vlist
))
13081 Lisp_Object var
= XCAR (vlist
);
13084 if (!SYMBOLP (var
))
13086 val
= find_symbol_value (var
);
13088 && current_buffer
== XMARKER (val
)->buffer
)
13095 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13099 overlay_arrows_changed_p (void)
13103 for (vlist
= Voverlay_arrow_variable_list
;
13105 vlist
= XCDR (vlist
))
13107 Lisp_Object var
= XCAR (vlist
);
13108 Lisp_Object val
, pstr
;
13110 if (!SYMBOLP (var
))
13112 val
= find_symbol_value (var
);
13113 if (!MARKERP (val
))
13115 if (! EQ (COERCE_MARKER (val
),
13116 Fget (var
, Qlast_arrow_position
))
13117 || ! (pstr
= overlay_arrow_string_or_property (var
),
13118 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13124 /* Mark overlay arrows to be updated on next redisplay. */
13127 update_overlay_arrows (int up_to_date
)
13131 for (vlist
= Voverlay_arrow_variable_list
;
13133 vlist
= XCDR (vlist
))
13135 Lisp_Object var
= XCAR (vlist
);
13137 if (!SYMBOLP (var
))
13140 if (up_to_date
> 0)
13142 Lisp_Object val
= find_symbol_value (var
);
13143 Fput (var
, Qlast_arrow_position
,
13144 COERCE_MARKER (val
));
13145 Fput (var
, Qlast_arrow_string
,
13146 overlay_arrow_string_or_property (var
));
13148 else if (up_to_date
< 0
13149 || !NILP (Fget (var
, Qlast_arrow_position
)))
13151 Fput (var
, Qlast_arrow_position
, Qt
);
13152 Fput (var
, Qlast_arrow_string
, Qt
);
13158 /* Return overlay arrow string to display at row.
13159 Return integer (bitmap number) for arrow bitmap in left fringe.
13160 Return nil if no overlay arrow. */
13163 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13167 for (vlist
= Voverlay_arrow_variable_list
;
13169 vlist
= XCDR (vlist
))
13171 Lisp_Object var
= XCAR (vlist
);
13174 if (!SYMBOLP (var
))
13177 val
= find_symbol_value (var
);
13180 && current_buffer
== XMARKER (val
)->buffer
13181 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13183 if (FRAME_WINDOW_P (it
->f
)
13184 /* FIXME: if ROW->reversed_p is set, this should test
13185 the right fringe, not the left one. */
13186 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13188 #ifdef HAVE_WINDOW_SYSTEM
13189 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13191 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13192 if (fringe_bitmap
!= 0)
13193 return make_number (fringe_bitmap
);
13196 return make_number (-1); /* Use default arrow bitmap. */
13198 return overlay_arrow_string_or_property (var
);
13205 /* Return true if point moved out of or into a composition. Otherwise
13206 return false. PREV_BUF and PREV_PT are the last point buffer and
13207 position. BUF and PT are the current point buffer and position. */
13210 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13211 struct buffer
*buf
, ptrdiff_t pt
)
13213 ptrdiff_t start
, end
;
13215 Lisp_Object buffer
;
13217 XSETBUFFER (buffer
, buf
);
13218 /* Check a composition at the last point if point moved within the
13220 if (prev_buf
== buf
)
13223 /* Point didn't move. */
13226 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13227 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13228 && composition_valid_p (start
, end
, prop
)
13229 && start
< prev_pt
&& end
> prev_pt
)
13230 /* The last point was within the composition. Return true iff
13231 point moved out of the composition. */
13232 return (pt
<= start
|| pt
>= end
);
13235 /* Check a composition at the current point. */
13236 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13237 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13238 && composition_valid_p (start
, end
, prop
)
13239 && start
< pt
&& end
> pt
);
13242 /* Reconsider the clip changes of buffer which is displayed in W. */
13245 reconsider_clip_changes (struct window
*w
)
13247 struct buffer
*b
= XBUFFER (w
->contents
);
13249 if (b
->clip_changed
13250 && w
->window_end_valid
13251 && w
->current_matrix
->buffer
== b
13252 && w
->current_matrix
->zv
== BUF_ZV (b
)
13253 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13254 b
->clip_changed
= false;
13256 /* If display wasn't paused, and W is not a tool bar window, see if
13257 point has been moved into or out of a composition. In that case,
13258 set b->clip_changed to force updating the screen. If
13259 b->clip_changed has already been set, skip this check. */
13260 if (!b
->clip_changed
&& w
->window_end_valid
)
13262 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13263 ? PT
: marker_position (w
->pointm
));
13265 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13266 && check_point_in_composition (w
->current_matrix
->buffer
,
13267 w
->last_point
, b
, pt
))
13268 b
->clip_changed
= true;
13273 propagate_buffer_redisplay (void)
13274 { /* Resetting b->text->redisplay is problematic!
13275 We can't just reset it in the case that some window that displays
13276 it has not been redisplayed; and such a window can stay
13277 unredisplayed for a long time if it's currently invisible.
13278 But we do want to reset it at the end of redisplay otherwise
13279 its displayed windows will keep being redisplayed over and over
13281 So we copy all b->text->redisplay flags up to their windows here,
13282 such that mark_window_display_accurate can safely reset
13283 b->text->redisplay. */
13284 Lisp_Object ws
= window_list ();
13285 for (; CONSP (ws
); ws
= XCDR (ws
))
13287 struct window
*thisw
= XWINDOW (XCAR (ws
));
13288 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13289 if (thisb
->text
->redisplay
)
13290 thisw
->redisplay
= true;
13294 #define STOP_POLLING \
13295 do { if (! polling_stopped_here) stop_polling (); \
13296 polling_stopped_here = true; } while (false)
13298 #define RESUME_POLLING \
13299 do { if (polling_stopped_here) start_polling (); \
13300 polling_stopped_here = false; } while (false)
13303 /* Perhaps in the future avoid recentering windows if it
13304 is not necessary; currently that causes some problems. */
13307 redisplay_internal (void)
13309 struct window
*w
= XWINDOW (selected_window
);
13313 bool must_finish
= false, match_p
;
13314 struct text_pos tlbufpos
, tlendpos
;
13315 int number_of_visible_frames
;
13318 bool polling_stopped_here
= false;
13319 Lisp_Object tail
, frame
;
13321 /* True means redisplay has to consider all windows on all
13322 frames. False, only selected_window is considered. */
13323 bool consider_all_windows_p
;
13325 /* True means redisplay has to redisplay the miniwindow. */
13326 bool update_miniwindow_p
= false;
13328 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13330 /* No redisplay if running in batch mode or frame is not yet fully
13331 initialized, or redisplay is explicitly turned off by setting
13332 Vinhibit_redisplay. */
13333 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13334 || !NILP (Vinhibit_redisplay
))
13337 /* Don't examine these until after testing Vinhibit_redisplay.
13338 When Emacs is shutting down, perhaps because its connection to
13339 X has dropped, we should not look at them at all. */
13340 fr
= XFRAME (w
->frame
);
13341 sf
= SELECTED_FRAME ();
13343 if (!fr
->glyphs_initialized_p
)
13346 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13347 if (popup_activated ())
13351 /* I don't think this happens but let's be paranoid. */
13352 if (redisplaying_p
)
13355 /* Record a function that clears redisplaying_p
13356 when we leave this function. */
13357 count
= SPECPDL_INDEX ();
13358 record_unwind_protect_void (unwind_redisplay
);
13359 redisplaying_p
= true;
13360 specbind (Qinhibit_free_realized_faces
, Qnil
);
13362 /* Record this function, so it appears on the profiler's backtraces. */
13363 record_in_backtrace (Qredisplay_internal
, 0, 0);
13365 FOR_EACH_FRAME (tail
, frame
)
13366 XFRAME (frame
)->already_hscrolled_p
= false;
13369 /* Remember the currently selected window. */
13373 last_escape_glyph_frame
= NULL
;
13374 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13375 last_glyphless_glyph_frame
= NULL
;
13376 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13378 /* If face_change, init_iterator will free all realized faces, which
13379 includes the faces referenced from current matrices. So, we
13380 can't reuse current matrices in this case. */
13382 windows_or_buffers_changed
= 47;
13384 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13385 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13387 /* Since frames on a single ASCII terminal share the same
13388 display area, displaying a different frame means redisplay
13389 the whole thing. */
13390 SET_FRAME_GARBAGED (sf
);
13392 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13394 FRAME_TTY (sf
)->previous_frame
= sf
;
13397 /* Set the visible flags for all frames. Do this before checking for
13398 resized or garbaged frames; they want to know if their frames are
13399 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13400 number_of_visible_frames
= 0;
13402 FOR_EACH_FRAME (tail
, frame
)
13404 struct frame
*f
= XFRAME (frame
);
13406 if (FRAME_VISIBLE_P (f
))
13408 ++number_of_visible_frames
;
13409 /* Adjust matrices for visible frames only. */
13410 if (f
->fonts_changed
)
13412 adjust_frame_glyphs (f
);
13413 /* Disable all redisplay optimizations for this frame.
13414 This is because adjust_frame_glyphs resets the
13415 enabled_p flag for all glyph rows of all windows, so
13416 many optimizations will fail anyway, and some might
13417 fail to test that flag and do bogus things as
13419 SET_FRAME_GARBAGED (f
);
13420 f
->fonts_changed
= false;
13422 /* If cursor type has been changed on the frame
13423 other than selected, consider all frames. */
13424 if (f
!= sf
&& f
->cursor_type_changed
)
13425 update_mode_lines
= 31;
13427 clear_desired_matrices (f
);
13430 /* Notice any pending interrupt request to change frame size. */
13431 do_pending_window_change (true);
13433 /* do_pending_window_change could change the selected_window due to
13434 frame resizing which makes the selected window too small. */
13435 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13438 /* Clear frames marked as garbaged. */
13439 clear_garbaged_frames ();
13441 /* Build menubar and tool-bar items. */
13442 if (NILP (Vmemory_full
))
13443 prepare_menu_bars ();
13445 reconsider_clip_changes (w
);
13447 /* In most cases selected window displays current buffer. */
13448 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13451 /* Detect case that we need to write or remove a star in the mode line. */
13452 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13453 w
->update_mode_line
= true;
13455 if (mode_line_update_needed (w
))
13456 w
->update_mode_line
= true;
13458 /* If reconsider_clip_changes above decided that the narrowing
13459 in the current buffer changed, make sure all other windows
13460 showing that buffer will be redisplayed. */
13461 if (current_buffer
->clip_changed
)
13462 bset_update_mode_line (current_buffer
);
13465 /* Normally the message* functions will have already displayed and
13466 updated the echo area, but the frame may have been trashed, or
13467 the update may have been preempted, so display the echo area
13468 again here. Checking message_cleared_p captures the case that
13469 the echo area should be cleared. */
13470 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13471 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13472 || (message_cleared_p
13473 && minibuf_level
== 0
13474 /* If the mini-window is currently selected, this means the
13475 echo-area doesn't show through. */
13476 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13478 bool window_height_changed_p
= echo_area_display (false);
13480 if (message_cleared_p
)
13481 update_miniwindow_p
= true;
13483 must_finish
= true;
13485 /* If we don't display the current message, don't clear the
13486 message_cleared_p flag, because, if we did, we wouldn't clear
13487 the echo area in the next redisplay which doesn't preserve
13489 if (!display_last_displayed_message_p
)
13490 message_cleared_p
= false;
13492 if (window_height_changed_p
)
13494 windows_or_buffers_changed
= 50;
13496 /* If window configuration was changed, frames may have been
13497 marked garbaged. Clear them or we will experience
13498 surprises wrt scrolling. */
13499 clear_garbaged_frames ();
13502 else if (EQ (selected_window
, minibuf_window
)
13503 && (current_buffer
->clip_changed
|| window_outdated (w
))
13504 && resize_mini_window (w
, false))
13506 /* Resized active mini-window to fit the size of what it is
13507 showing if its contents might have changed. */
13508 must_finish
= true;
13510 /* If window configuration was changed, frames may have been
13511 marked garbaged. Clear them or we will experience
13512 surprises wrt scrolling. */
13513 clear_garbaged_frames ();
13516 if (windows_or_buffers_changed
&& !update_mode_lines
)
13517 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13518 only the windows's contents needs to be refreshed, or whether the
13519 mode-lines also need a refresh. */
13520 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13521 ? REDISPLAY_SOME
: 32);
13523 /* If specs for an arrow have changed, do thorough redisplay
13524 to ensure we remove any arrow that should no longer exist. */
13525 if (overlay_arrows_changed_p ())
13526 /* Apparently, this is the only case where we update other windows,
13527 without updating other mode-lines. */
13528 windows_or_buffers_changed
= 49;
13530 consider_all_windows_p
= (update_mode_lines
13531 || windows_or_buffers_changed
);
13533 #define AINC(a,i) \
13534 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13535 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13537 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13538 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13540 /* Optimize the case that only the line containing the cursor in the
13541 selected window has changed. Variables starting with this_ are
13542 set in display_line and record information about the line
13543 containing the cursor. */
13544 tlbufpos
= this_line_start_pos
;
13545 tlendpos
= this_line_end_pos
;
13546 if (!consider_all_windows_p
13547 && CHARPOS (tlbufpos
) > 0
13548 && !w
->update_mode_line
13549 && !current_buffer
->clip_changed
13550 && !current_buffer
->prevent_redisplay_optimizations_p
13551 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13552 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13553 && !XFRAME (w
->frame
)->cursor_type_changed
13554 /* Make sure recorded data applies to current buffer, etc. */
13555 && this_line_buffer
== current_buffer
13558 && !w
->optional_new_start
13559 /* Point must be on the line that we have info recorded about. */
13560 && PT
>= CHARPOS (tlbufpos
)
13561 && PT
<= Z
- CHARPOS (tlendpos
)
13562 /* All text outside that line, including its final newline,
13563 must be unchanged. */
13564 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13565 CHARPOS (tlendpos
)))
13567 if (CHARPOS (tlbufpos
) > BEGV
13568 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13569 && (CHARPOS (tlbufpos
) == ZV
13570 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13571 /* Former continuation line has disappeared by becoming empty. */
13573 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13575 /* We have to handle the case of continuation around a
13576 wide-column character (see the comment in indent.c around
13579 For instance, in the following case:
13581 -------- Insert --------
13582 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13583 J_I_ ==> J_I_ `^^' are cursors.
13587 As we have to redraw the line above, we cannot use this
13591 int line_height_before
= this_line_pixel_height
;
13593 /* Note that start_display will handle the case that the
13594 line starting at tlbufpos is a continuation line. */
13595 start_display (&it
, w
, tlbufpos
);
13597 /* Implementation note: It this still necessary? */
13598 if (it
.current_x
!= this_line_start_x
)
13601 TRACE ((stderr
, "trying display optimization 1\n"));
13602 w
->cursor
.vpos
= -1;
13603 overlay_arrow_seen
= false;
13604 it
.vpos
= this_line_vpos
;
13605 it
.current_y
= this_line_y
;
13606 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13607 display_line (&it
);
13609 /* If line contains point, is not continued,
13610 and ends at same distance from eob as before, we win. */
13611 if (w
->cursor
.vpos
>= 0
13612 /* Line is not continued, otherwise this_line_start_pos
13613 would have been set to 0 in display_line. */
13614 && CHARPOS (this_line_start_pos
)
13615 /* Line ends as before. */
13616 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13617 /* Line has same height as before. Otherwise other lines
13618 would have to be shifted up or down. */
13619 && this_line_pixel_height
== line_height_before
)
13621 /* If this is not the window's last line, we must adjust
13622 the charstarts of the lines below. */
13623 if (it
.current_y
< it
.last_visible_y
)
13625 struct glyph_row
*row
13626 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13627 ptrdiff_t delta
, delta_bytes
;
13629 /* We used to distinguish between two cases here,
13630 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13631 when the line ends in a newline or the end of the
13632 buffer's accessible portion. But both cases did
13633 the same, so they were collapsed. */
13635 - CHARPOS (tlendpos
)
13636 - MATRIX_ROW_START_CHARPOS (row
));
13637 delta_bytes
= (Z_BYTE
13638 - BYTEPOS (tlendpos
)
13639 - MATRIX_ROW_START_BYTEPOS (row
));
13641 increment_matrix_positions (w
->current_matrix
,
13642 this_line_vpos
+ 1,
13643 w
->current_matrix
->nrows
,
13644 delta
, delta_bytes
);
13647 /* If this row displays text now but previously didn't,
13648 or vice versa, w->window_end_vpos may have to be
13650 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13652 if (w
->window_end_vpos
< this_line_vpos
)
13653 w
->window_end_vpos
= this_line_vpos
;
13655 else if (w
->window_end_vpos
== this_line_vpos
13656 && this_line_vpos
> 0)
13657 w
->window_end_vpos
= this_line_vpos
- 1;
13658 w
->window_end_valid
= false;
13660 /* Update hint: No need to try to scroll in update_window. */
13661 w
->desired_matrix
->no_scrolling_p
= true;
13664 *w
->desired_matrix
->method
= 0;
13665 debug_method_add (w
, "optimization 1");
13667 #ifdef HAVE_WINDOW_SYSTEM
13668 update_window_fringes (w
, false);
13675 else if (/* Cursor position hasn't changed. */
13676 PT
== w
->last_point
13677 /* Make sure the cursor was last displayed
13678 in this window. Otherwise we have to reposition it. */
13680 /* PXW: Must be converted to pixels, probably. */
13681 && 0 <= w
->cursor
.vpos
13682 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13686 do_pending_window_change (true);
13687 /* If selected_window changed, redisplay again. */
13688 if (WINDOWP (selected_window
)
13689 && (w
= XWINDOW (selected_window
)) != sw
)
13692 /* We used to always goto end_of_redisplay here, but this
13693 isn't enough if we have a blinking cursor. */
13694 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13695 goto end_of_redisplay
;
13699 /* If highlighting the region, or if the cursor is in the echo area,
13700 then we can't just move the cursor. */
13701 else if (NILP (Vshow_trailing_whitespace
)
13702 && !cursor_in_echo_area
)
13705 struct glyph_row
*row
;
13707 /* Skip from tlbufpos to PT and see where it is. Note that
13708 PT may be in invisible text. If so, we will end at the
13709 next visible position. */
13710 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13711 NULL
, DEFAULT_FACE_ID
);
13712 it
.current_x
= this_line_start_x
;
13713 it
.current_y
= this_line_y
;
13714 it
.vpos
= this_line_vpos
;
13716 /* The call to move_it_to stops in front of PT, but
13717 moves over before-strings. */
13718 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13720 if (it
.vpos
== this_line_vpos
13721 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13724 eassert (this_line_vpos
== it
.vpos
);
13725 eassert (this_line_y
== it
.current_y
);
13726 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13728 *w
->desired_matrix
->method
= 0;
13729 debug_method_add (w
, "optimization 3");
13738 /* Text changed drastically or point moved off of line. */
13739 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13742 CHARPOS (this_line_start_pos
) = 0;
13743 ++clear_face_cache_count
;
13744 #ifdef HAVE_WINDOW_SYSTEM
13745 ++clear_image_cache_count
;
13748 /* Build desired matrices, and update the display. If
13749 consider_all_windows_p, do it for all windows on all frames.
13750 Otherwise do it for selected_window, only. */
13752 if (consider_all_windows_p
)
13754 FOR_EACH_FRAME (tail
, frame
)
13755 XFRAME (frame
)->updated_p
= false;
13757 propagate_buffer_redisplay ();
13759 FOR_EACH_FRAME (tail
, frame
)
13761 struct frame
*f
= XFRAME (frame
);
13763 /* We don't have to do anything for unselected terminal
13765 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13766 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13771 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13772 /* Redisplay internal tool bar if this is the first time so we
13773 can adjust the frame height right now, if necessary. */
13774 if (!f
->tool_bar_redisplayed_once
)
13776 if (redisplay_tool_bar (f
))
13777 adjust_frame_glyphs (f
);
13778 f
->tool_bar_redisplayed_once
= true;
13782 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13785 /* Only GC scrollbars when we redisplay the whole frame. */
13786 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13787 /* Mark all the scroll bars to be removed; we'll redeem
13788 the ones we want when we redisplay their windows. */
13789 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13790 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13792 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13793 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13794 /* Remember that the invisible frames need to be redisplayed next
13795 time they're visible. */
13796 else if (!REDISPLAY_SOME_P ())
13797 f
->redisplay
= true;
13799 /* The X error handler may have deleted that frame. */
13800 if (!FRAME_LIVE_P (f
))
13803 /* Any scroll bars which redisplay_windows should have
13804 nuked should now go away. */
13805 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13806 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13808 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13810 /* If fonts changed on visible frame, display again. */
13811 if (f
->fonts_changed
)
13813 adjust_frame_glyphs (f
);
13814 /* Disable all redisplay optimizations for this
13815 frame. For the reasons, see the comment near
13816 the previous call to adjust_frame_glyphs above. */
13817 SET_FRAME_GARBAGED (f
);
13818 f
->fonts_changed
= false;
13822 /* See if we have to hscroll. */
13823 if (!f
->already_hscrolled_p
)
13825 f
->already_hscrolled_p
= true;
13826 if (hscroll_windows (f
->root_window
))
13830 /* Prevent various kinds of signals during display
13831 update. stdio is not robust about handling
13832 signals, which can cause an apparent I/O error. */
13833 if (interrupt_input
)
13834 unrequest_sigio ();
13837 pending
|= update_frame (f
, false, false);
13838 f
->cursor_type_changed
= false;
13839 f
->updated_p
= true;
13844 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13848 /* Do the mark_window_display_accurate after all windows have
13849 been redisplayed because this call resets flags in buffers
13850 which are needed for proper redisplay. */
13851 FOR_EACH_FRAME (tail
, frame
)
13853 struct frame
*f
= XFRAME (frame
);
13856 f
->redisplay
= false;
13857 mark_window_display_accurate (f
->root_window
, true);
13858 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13859 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13864 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13866 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13867 struct frame
*mini_frame
;
13869 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13870 /* Use list_of_error, not Qerror, so that
13871 we catch only errors and don't run the debugger. */
13872 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13874 redisplay_window_error
);
13875 if (update_miniwindow_p
)
13876 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13878 redisplay_window_error
);
13880 /* Compare desired and current matrices, perform output. */
13883 /* If fonts changed, display again. */
13884 if (sf
->fonts_changed
)
13887 /* Prevent various kinds of signals during display update.
13888 stdio is not robust about handling signals,
13889 which can cause an apparent I/O error. */
13890 if (interrupt_input
)
13891 unrequest_sigio ();
13894 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13896 if (hscroll_windows (selected_window
))
13899 XWINDOW (selected_window
)->must_be_updated_p
= true;
13900 pending
= update_frame (sf
, false, false);
13901 sf
->cursor_type_changed
= false;
13904 /* We may have called echo_area_display at the top of this
13905 function. If the echo area is on another frame, that may
13906 have put text on a frame other than the selected one, so the
13907 above call to update_frame would not have caught it. Catch
13909 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13910 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13912 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13914 XWINDOW (mini_window
)->must_be_updated_p
= true;
13915 pending
|= update_frame (mini_frame
, false, false);
13916 mini_frame
->cursor_type_changed
= false;
13917 if (!pending
&& hscroll_windows (mini_window
))
13922 /* If display was paused because of pending input, make sure we do a
13923 thorough update the next time. */
13926 /* Prevent the optimization at the beginning of
13927 redisplay_internal that tries a single-line update of the
13928 line containing the cursor in the selected window. */
13929 CHARPOS (this_line_start_pos
) = 0;
13931 /* Let the overlay arrow be updated the next time. */
13932 update_overlay_arrows (0);
13934 /* If we pause after scrolling, some rows in the current
13935 matrices of some windows are not valid. */
13936 if (!WINDOW_FULL_WIDTH_P (w
)
13937 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13938 update_mode_lines
= 36;
13942 if (!consider_all_windows_p
)
13944 /* This has already been done above if
13945 consider_all_windows_p is set. */
13946 if (XBUFFER (w
->contents
)->text
->redisplay
13947 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13948 /* This can happen if b->text->redisplay was set during
13950 propagate_buffer_redisplay ();
13951 mark_window_display_accurate_1 (w
, true);
13953 /* Say overlay arrows are up to date. */
13954 update_overlay_arrows (1);
13956 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13957 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13960 update_mode_lines
= 0;
13961 windows_or_buffers_changed
= 0;
13964 /* Start SIGIO interrupts coming again. Having them off during the
13965 code above makes it less likely one will discard output, but not
13966 impossible, since there might be stuff in the system buffer here.
13967 But it is much hairier to try to do anything about that. */
13968 if (interrupt_input
)
13972 /* If a frame has become visible which was not before, redisplay
13973 again, so that we display it. Expose events for such a frame
13974 (which it gets when becoming visible) don't call the parts of
13975 redisplay constructing glyphs, so simply exposing a frame won't
13976 display anything in this case. So, we have to display these
13977 frames here explicitly. */
13982 FOR_EACH_FRAME (tail
, frame
)
13984 if (XFRAME (frame
)->visible
)
13988 if (new_count
!= number_of_visible_frames
)
13989 windows_or_buffers_changed
= 52;
13992 /* Change frame size now if a change is pending. */
13993 do_pending_window_change (true);
13995 /* If we just did a pending size change, or have additional
13996 visible frames, or selected_window changed, redisplay again. */
13997 if ((windows_or_buffers_changed
&& !pending
)
13998 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14001 /* Clear the face and image caches.
14003 We used to do this only if consider_all_windows_p. But the cache
14004 needs to be cleared if a timer creates images in the current
14005 buffer (e.g. the test case in Bug#6230). */
14007 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14009 clear_face_cache (false);
14010 clear_face_cache_count
= 0;
14013 #ifdef HAVE_WINDOW_SYSTEM
14014 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14016 clear_image_caches (Qnil
);
14017 clear_image_cache_count
= 0;
14019 #endif /* HAVE_WINDOW_SYSTEM */
14023 ns_set_doc_edited ();
14025 if (interrupt_input
&& interrupts_deferred
)
14028 unbind_to (count
, Qnil
);
14033 /* Redisplay, but leave alone any recent echo area message unless
14034 another message has been requested in its place.
14036 This is useful in situations where you need to redisplay but no
14037 user action has occurred, making it inappropriate for the message
14038 area to be cleared. See tracking_off and
14039 wait_reading_process_output for examples of these situations.
14041 FROM_WHERE is an integer saying from where this function was
14042 called. This is useful for debugging. */
14045 redisplay_preserve_echo_area (int from_where
)
14047 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14049 if (!NILP (echo_area_buffer
[1]))
14051 /* We have a previously displayed message, but no current
14052 message. Redisplay the previous message. */
14053 display_last_displayed_message_p
= true;
14054 redisplay_internal ();
14055 display_last_displayed_message_p
= false;
14058 redisplay_internal ();
14060 flush_frame (SELECTED_FRAME ());
14064 /* Function registered with record_unwind_protect in redisplay_internal. */
14067 unwind_redisplay (void)
14069 redisplaying_p
= false;
14073 /* Mark the display of leaf window W as accurate or inaccurate.
14074 If ACCURATE_P, mark display of W as accurate.
14075 If !ACCURATE_P, arrange for W to be redisplayed the next
14076 time redisplay_internal is called. */
14079 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14081 struct buffer
*b
= XBUFFER (w
->contents
);
14083 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14084 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14085 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14089 b
->clip_changed
= false;
14090 b
->prevent_redisplay_optimizations_p
= false;
14091 eassert (buffer_window_count (b
) > 0);
14092 /* Resetting b->text->redisplay is problematic!
14093 In order to make it safer to do it here, redisplay_internal must
14094 have copied all b->text->redisplay to their respective windows. */
14095 b
->text
->redisplay
= false;
14097 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14098 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14099 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14100 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14102 w
->current_matrix
->buffer
= b
;
14103 w
->current_matrix
->begv
= BUF_BEGV (b
);
14104 w
->current_matrix
->zv
= BUF_ZV (b
);
14106 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14107 w
->last_cursor_off_p
= w
->cursor_off_p
;
14109 if (w
== XWINDOW (selected_window
))
14110 w
->last_point
= BUF_PT (b
);
14112 w
->last_point
= marker_position (w
->pointm
);
14114 w
->window_end_valid
= true;
14115 w
->update_mode_line
= false;
14118 w
->redisplay
= !accurate_p
;
14122 /* Mark the display of windows in the window tree rooted at WINDOW as
14123 accurate or inaccurate. If ACCURATE_P, mark display of
14124 windows as accurate. If !ACCURATE_P, arrange for windows to
14125 be redisplayed the next time redisplay_internal is called. */
14128 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14132 for (; !NILP (window
); window
= w
->next
)
14134 w
= XWINDOW (window
);
14135 if (WINDOWP (w
->contents
))
14136 mark_window_display_accurate (w
->contents
, accurate_p
);
14138 mark_window_display_accurate_1 (w
, accurate_p
);
14142 update_overlay_arrows (1);
14144 /* Force a thorough redisplay the next time by setting
14145 last_arrow_position and last_arrow_string to t, which is
14146 unequal to any useful value of Voverlay_arrow_... */
14147 update_overlay_arrows (-1);
14151 /* Return value in display table DP (Lisp_Char_Table *) for character
14152 C. Since a display table doesn't have any parent, we don't have to
14153 follow parent. Do not call this function directly but use the
14154 macro DISP_CHAR_VECTOR. */
14157 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14161 if (ASCII_CHAR_P (c
))
14164 if (SUB_CHAR_TABLE_P (val
))
14165 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14171 XSETCHAR_TABLE (table
, dp
);
14172 val
= char_table_ref (table
, c
);
14181 /***********************************************************************
14183 ***********************************************************************/
14185 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14188 redisplay_windows (Lisp_Object window
)
14190 while (!NILP (window
))
14192 struct window
*w
= XWINDOW (window
);
14194 if (WINDOWP (w
->contents
))
14195 redisplay_windows (w
->contents
);
14196 else if (BUFFERP (w
->contents
))
14198 displayed_buffer
= XBUFFER (w
->contents
);
14199 /* Use list_of_error, not Qerror, so that
14200 we catch only errors and don't run the debugger. */
14201 internal_condition_case_1 (redisplay_window_0
, window
,
14203 redisplay_window_error
);
14211 redisplay_window_error (Lisp_Object ignore
)
14213 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14218 redisplay_window_0 (Lisp_Object window
)
14220 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14221 redisplay_window (window
, false);
14226 redisplay_window_1 (Lisp_Object window
)
14228 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14229 redisplay_window (window
, true);
14234 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14235 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14236 which positions recorded in ROW differ from current buffer
14239 Return true iff cursor is on this row. */
14242 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14243 struct glyph_matrix
*matrix
,
14244 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14247 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14248 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14249 struct glyph
*cursor
= NULL
;
14250 /* The last known character position in row. */
14251 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14253 ptrdiff_t pt_old
= PT
- delta
;
14254 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14255 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14256 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14257 /* A glyph beyond the edge of TEXT_AREA which we should never
14259 struct glyph
*glyphs_end
= end
;
14260 /* True means we've found a match for cursor position, but that
14261 glyph has the avoid_cursor_p flag set. */
14262 bool match_with_avoid_cursor
= false;
14263 /* True means we've seen at least one glyph that came from a
14265 bool string_seen
= false;
14266 /* Largest and smallest buffer positions seen so far during scan of
14268 ptrdiff_t bpos_max
= pos_before
;
14269 ptrdiff_t bpos_min
= pos_after
;
14270 /* Last buffer position covered by an overlay string with an integer
14271 `cursor' property. */
14272 ptrdiff_t bpos_covered
= 0;
14273 /* True means the display string on which to display the cursor
14274 comes from a text property, not from an overlay. */
14275 bool string_from_text_prop
= false;
14277 /* Don't even try doing anything if called for a mode-line or
14278 header-line row, since the rest of the code isn't prepared to
14279 deal with such calamities. */
14280 eassert (!row
->mode_line_p
);
14281 if (row
->mode_line_p
)
14284 /* Skip over glyphs not having an object at the start and the end of
14285 the row. These are special glyphs like truncation marks on
14286 terminal frames. */
14287 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14289 if (!row
->reversed_p
)
14292 && NILP (glyph
->object
)
14293 && glyph
->charpos
< 0)
14295 x
+= glyph
->pixel_width
;
14299 && NILP ((end
- 1)->object
)
14300 /* CHARPOS is zero for blanks and stretch glyphs
14301 inserted by extend_face_to_end_of_line. */
14302 && (end
- 1)->charpos
<= 0)
14304 glyph_before
= glyph
- 1;
14311 /* If the glyph row is reversed, we need to process it from back
14312 to front, so swap the edge pointers. */
14313 glyphs_end
= end
= glyph
- 1;
14314 glyph
+= row
->used
[TEXT_AREA
] - 1;
14316 while (glyph
> end
+ 1
14317 && NILP (glyph
->object
)
14318 && glyph
->charpos
< 0)
14321 x
-= glyph
->pixel_width
;
14323 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14325 /* By default, in reversed rows we put the cursor on the
14326 rightmost (first in the reading order) glyph. */
14327 for (g
= end
+ 1; g
< glyph
; g
++)
14328 x
+= g
->pixel_width
;
14330 && NILP ((end
+ 1)->object
)
14331 && (end
+ 1)->charpos
<= 0)
14333 glyph_before
= glyph
+ 1;
14337 else if (row
->reversed_p
)
14339 /* In R2L rows that don't display text, put the cursor on the
14340 rightmost glyph. Case in point: an empty last line that is
14341 part of an R2L paragraph. */
14343 /* Avoid placing the cursor on the last glyph of the row, where
14344 on terminal frames we hold the vertical border between
14345 adjacent windows. */
14346 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14347 && !WINDOW_RIGHTMOST_P (w
)
14348 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14350 x
= -1; /* will be computed below, at label compute_x */
14353 /* Step 1: Try to find the glyph whose character position
14354 corresponds to point. If that's not possible, find 2 glyphs
14355 whose character positions are the closest to point, one before
14356 point, the other after it. */
14357 if (!row
->reversed_p
)
14358 while (/* not marched to end of glyph row */
14360 /* glyph was not inserted by redisplay for internal purposes */
14361 && !NILP (glyph
->object
))
14363 if (BUFFERP (glyph
->object
))
14365 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14367 if (glyph
->charpos
> bpos_max
)
14368 bpos_max
= glyph
->charpos
;
14369 if (glyph
->charpos
< bpos_min
)
14370 bpos_min
= glyph
->charpos
;
14371 if (!glyph
->avoid_cursor_p
)
14373 /* If we hit point, we've found the glyph on which to
14374 display the cursor. */
14377 match_with_avoid_cursor
= false;
14380 /* See if we've found a better approximation to
14381 POS_BEFORE or to POS_AFTER. */
14382 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14384 pos_before
= glyph
->charpos
;
14385 glyph_before
= glyph
;
14387 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14389 pos_after
= glyph
->charpos
;
14390 glyph_after
= glyph
;
14393 else if (dpos
== 0)
14394 match_with_avoid_cursor
= true;
14396 else if (STRINGP (glyph
->object
))
14398 Lisp_Object chprop
;
14399 ptrdiff_t glyph_pos
= glyph
->charpos
;
14401 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14403 if (!NILP (chprop
))
14405 /* If the string came from a `display' text property,
14406 look up the buffer position of that property and
14407 use that position to update bpos_max, as if we
14408 actually saw such a position in one of the row's
14409 glyphs. This helps with supporting integer values
14410 of `cursor' property on the display string in
14411 situations where most or all of the row's buffer
14412 text is completely covered by display properties,
14413 so that no glyph with valid buffer positions is
14414 ever seen in the row. */
14415 ptrdiff_t prop_pos
=
14416 string_buffer_position_lim (glyph
->object
, pos_before
,
14419 if (prop_pos
>= pos_before
)
14420 bpos_max
= prop_pos
;
14422 if (INTEGERP (chprop
))
14424 bpos_covered
= bpos_max
+ XINT (chprop
);
14425 /* If the `cursor' property covers buffer positions up
14426 to and including point, we should display cursor on
14427 this glyph. Note that, if a `cursor' property on one
14428 of the string's characters has an integer value, we
14429 will break out of the loop below _before_ we get to
14430 the position match above. IOW, integer values of
14431 the `cursor' property override the "exact match for
14432 point" strategy of positioning the cursor. */
14433 /* Implementation note: bpos_max == pt_old when, e.g.,
14434 we are in an empty line, where bpos_max is set to
14435 MATRIX_ROW_START_CHARPOS, see above. */
14436 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14443 string_seen
= true;
14445 x
+= glyph
->pixel_width
;
14448 else if (glyph
> end
) /* row is reversed */
14449 while (!NILP (glyph
->object
))
14451 if (BUFFERP (glyph
->object
))
14453 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14455 if (glyph
->charpos
> bpos_max
)
14456 bpos_max
= glyph
->charpos
;
14457 if (glyph
->charpos
< bpos_min
)
14458 bpos_min
= glyph
->charpos
;
14459 if (!glyph
->avoid_cursor_p
)
14463 match_with_avoid_cursor
= false;
14466 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14468 pos_before
= glyph
->charpos
;
14469 glyph_before
= glyph
;
14471 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14473 pos_after
= glyph
->charpos
;
14474 glyph_after
= glyph
;
14477 else if (dpos
== 0)
14478 match_with_avoid_cursor
= true;
14480 else if (STRINGP (glyph
->object
))
14482 Lisp_Object chprop
;
14483 ptrdiff_t glyph_pos
= glyph
->charpos
;
14485 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14487 if (!NILP (chprop
))
14489 ptrdiff_t prop_pos
=
14490 string_buffer_position_lim (glyph
->object
, pos_before
,
14493 if (prop_pos
>= pos_before
)
14494 bpos_max
= prop_pos
;
14496 if (INTEGERP (chprop
))
14498 bpos_covered
= bpos_max
+ XINT (chprop
);
14499 /* If the `cursor' property covers buffer positions up
14500 to and including point, we should display cursor on
14502 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14508 string_seen
= true;
14511 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14513 x
--; /* can't use any pixel_width */
14516 x
-= glyph
->pixel_width
;
14519 /* Step 2: If we didn't find an exact match for point, we need to
14520 look for a proper place to put the cursor among glyphs between
14521 GLYPH_BEFORE and GLYPH_AFTER. */
14522 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14523 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14524 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14526 /* An empty line has a single glyph whose OBJECT is nil and
14527 whose CHARPOS is the position of a newline on that line.
14528 Note that on a TTY, there are more glyphs after that, which
14529 were produced by extend_face_to_end_of_line, but their
14530 CHARPOS is zero or negative. */
14531 bool empty_line_p
=
14532 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14533 && NILP (glyph
->object
) && glyph
->charpos
> 0
14534 /* On a TTY, continued and truncated rows also have a glyph at
14535 their end whose OBJECT is nil and whose CHARPOS is
14536 positive (the continuation and truncation glyphs), but such
14537 rows are obviously not "empty". */
14538 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14540 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14542 ptrdiff_t ellipsis_pos
;
14544 /* Scan back over the ellipsis glyphs. */
14545 if (!row
->reversed_p
)
14547 ellipsis_pos
= (glyph
- 1)->charpos
;
14548 while (glyph
> row
->glyphs
[TEXT_AREA
]
14549 && (glyph
- 1)->charpos
== ellipsis_pos
)
14550 glyph
--, x
-= glyph
->pixel_width
;
14551 /* That loop always goes one position too far, including
14552 the glyph before the ellipsis. So scan forward over
14554 x
+= glyph
->pixel_width
;
14557 else /* row is reversed */
14559 ellipsis_pos
= (glyph
+ 1)->charpos
;
14560 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14561 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14562 glyph
++, x
+= glyph
->pixel_width
;
14563 x
-= glyph
->pixel_width
;
14567 else if (match_with_avoid_cursor
)
14569 cursor
= glyph_after
;
14572 else if (string_seen
)
14574 int incr
= row
->reversed_p
? -1 : +1;
14576 /* Need to find the glyph that came out of a string which is
14577 present at point. That glyph is somewhere between
14578 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14579 positioned between POS_BEFORE and POS_AFTER in the
14581 struct glyph
*start
, *stop
;
14582 ptrdiff_t pos
= pos_before
;
14586 /* If the row ends in a newline from a display string,
14587 reordering could have moved the glyphs belonging to the
14588 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14589 in this case we extend the search to the last glyph in
14590 the row that was not inserted by redisplay. */
14591 if (row
->ends_in_newline_from_string_p
)
14594 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14597 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14598 correspond to POS_BEFORE and POS_AFTER, respectively. We
14599 need START and STOP in the order that corresponds to the
14600 row's direction as given by its reversed_p flag. If the
14601 directionality of characters between POS_BEFORE and
14602 POS_AFTER is the opposite of the row's base direction,
14603 these characters will have been reordered for display,
14604 and we need to reverse START and STOP. */
14605 if (!row
->reversed_p
)
14607 start
= min (glyph_before
, glyph_after
);
14608 stop
= max (glyph_before
, glyph_after
);
14612 start
= max (glyph_before
, glyph_after
);
14613 stop
= min (glyph_before
, glyph_after
);
14615 for (glyph
= start
+ incr
;
14616 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14619 /* Any glyphs that come from the buffer are here because
14620 of bidi reordering. Skip them, and only pay
14621 attention to glyphs that came from some string. */
14622 if (STRINGP (glyph
->object
))
14626 /* If the display property covers the newline, we
14627 need to search for it one position farther. */
14628 ptrdiff_t lim
= pos_after
14629 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14631 string_from_text_prop
= false;
14632 str
= glyph
->object
;
14633 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14634 if (tem
== 0 /* from overlay */
14637 /* If the string from which this glyph came is
14638 found in the buffer at point, or at position
14639 that is closer to point than pos_after, then
14640 we've found the glyph we've been looking for.
14641 If it comes from an overlay (tem == 0), and
14642 it has the `cursor' property on one of its
14643 glyphs, record that glyph as a candidate for
14644 displaying the cursor. (As in the
14645 unidirectional version, we will display the
14646 cursor on the last candidate we find.) */
14649 || (tem
- pt_old
> 0 && tem
< pos_after
))
14651 /* The glyphs from this string could have
14652 been reordered. Find the one with the
14653 smallest string position. Or there could
14654 be a character in the string with the
14655 `cursor' property, which means display
14656 cursor on that character's glyph. */
14657 ptrdiff_t strpos
= glyph
->charpos
;
14662 string_from_text_prop
= true;
14665 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14666 && EQ (glyph
->object
, str
);
14670 ptrdiff_t gpos
= glyph
->charpos
;
14672 cprop
= Fget_char_property (make_number (gpos
),
14680 if (tem
&& glyph
->charpos
< strpos
)
14682 strpos
= glyph
->charpos
;
14688 || (tem
- pt_old
> 0 && tem
< pos_after
))
14692 pos
= tem
+ 1; /* don't find previous instances */
14694 /* This string is not what we want; skip all of the
14695 glyphs that came from it. */
14696 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14697 && EQ (glyph
->object
, str
))
14704 /* If we reached the end of the line, and END was from a string,
14705 the cursor is not on this line. */
14707 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14708 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14709 && STRINGP (end
->object
)
14710 && row
->continued_p
)
14713 /* A truncated row may not include PT among its character positions.
14714 Setting the cursor inside the scroll margin will trigger
14715 recalculation of hscroll in hscroll_window_tree. But if a
14716 display string covers point, defer to the string-handling
14717 code below to figure this out. */
14718 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14720 cursor
= glyph_before
;
14723 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14724 /* Zero-width characters produce no glyphs. */
14726 && (row
->reversed_p
14727 ? glyph_after
> glyphs_end
14728 : glyph_after
< glyphs_end
)))
14730 cursor
= glyph_after
;
14736 if (cursor
!= NULL
)
14738 else if (glyph
== glyphs_end
14739 && pos_before
== pos_after
14740 && STRINGP ((row
->reversed_p
14741 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14742 : row
->glyphs
[TEXT_AREA
])->object
))
14744 /* If all the glyphs of this row came from strings, put the
14745 cursor on the first glyph of the row. This avoids having the
14746 cursor outside of the text area in this very rare and hard
14750 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14751 : row
->glyphs
[TEXT_AREA
];
14757 /* Need to compute x that corresponds to GLYPH. */
14758 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14760 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14762 x
+= g
->pixel_width
;
14766 /* ROW could be part of a continued line, which, under bidi
14767 reordering, might have other rows whose start and end charpos
14768 occlude point. Only set w->cursor if we found a better
14769 approximation to the cursor position than we have from previously
14770 examined candidate rows belonging to the same continued line. */
14771 if (/* We already have a candidate row. */
14772 w
->cursor
.vpos
>= 0
14773 /* That candidate is not the row we are processing. */
14774 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14775 /* Make sure cursor.vpos specifies a row whose start and end
14776 charpos occlude point, and it is valid candidate for being a
14777 cursor-row. This is because some callers of this function
14778 leave cursor.vpos at the row where the cursor was displayed
14779 during the last redisplay cycle. */
14780 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14781 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14782 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14785 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14787 /* Don't consider glyphs that are outside TEXT_AREA. */
14788 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14790 /* Keep the candidate whose buffer position is the closest to
14791 point or has the `cursor' property. */
14792 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14793 w
->cursor
.hpos
>= 0
14794 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14795 && ((BUFFERP (g1
->object
)
14796 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14797 || (BUFFERP (glyph
->object
)
14798 && eabs (g1
->charpos
- pt_old
)
14799 < eabs (glyph
->charpos
- pt_old
))))
14800 /* Previous candidate is a glyph from a string that has
14801 a non-nil `cursor' property. */
14802 || (STRINGP (g1
->object
)
14803 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14804 Qcursor
, g1
->object
))
14805 /* Previous candidate is from the same display
14806 string as this one, and the display string
14807 came from a text property. */
14808 || (EQ (g1
->object
, glyph
->object
)
14809 && string_from_text_prop
)
14810 /* this candidate is from newline and its
14811 position is not an exact match */
14812 || (NILP (glyph
->object
)
14813 && glyph
->charpos
!= pt_old
)))))
14815 /* If this candidate gives an exact match, use that. */
14816 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14817 /* If this candidate is a glyph created for the
14818 terminating newline of a line, and point is on that
14819 newline, it wins because it's an exact match. */
14820 || (!row
->continued_p
14821 && NILP (glyph
->object
)
14822 && glyph
->charpos
== 0
14823 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14824 /* Otherwise, keep the candidate that comes from a row
14825 spanning less buffer positions. This may win when one or
14826 both candidate positions are on glyphs that came from
14827 display strings, for which we cannot compare buffer
14829 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14830 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14831 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14834 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14836 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14837 w
->cursor
.y
= row
->y
+ dy
;
14839 if (w
== XWINDOW (selected_window
))
14841 if (!row
->continued_p
14842 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14845 this_line_buffer
= XBUFFER (w
->contents
);
14847 CHARPOS (this_line_start_pos
)
14848 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14849 BYTEPOS (this_line_start_pos
)
14850 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14852 CHARPOS (this_line_end_pos
)
14853 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14854 BYTEPOS (this_line_end_pos
)
14855 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14857 this_line_y
= w
->cursor
.y
;
14858 this_line_pixel_height
= row
->height
;
14859 this_line_vpos
= w
->cursor
.vpos
;
14860 this_line_start_x
= row
->x
;
14863 CHARPOS (this_line_start_pos
) = 0;
14870 /* Run window scroll functions, if any, for WINDOW with new window
14871 start STARTP. Sets the window start of WINDOW to that position.
14873 We assume that the window's buffer is really current. */
14875 static struct text_pos
14876 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14878 struct window
*w
= XWINDOW (window
);
14879 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14881 eassert (current_buffer
== XBUFFER (w
->contents
));
14883 if (!NILP (Vwindow_scroll_functions
))
14885 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14886 make_number (CHARPOS (startp
)));
14887 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14888 /* In case the hook functions switch buffers. */
14889 set_buffer_internal (XBUFFER (w
->contents
));
14896 /* Make sure the line containing the cursor is fully visible.
14897 A value of true means there is nothing to be done.
14898 (Either the line is fully visible, or it cannot be made so,
14899 or we cannot tell.)
14901 If FORCE_P, return false even if partial visible cursor row
14902 is higher than window.
14904 If CURRENT_MATRIX_P, use the information from the
14905 window's current glyph matrix; otherwise use the desired glyph
14908 A value of false means the caller should do scrolling
14909 as if point had gone off the screen. */
14912 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14913 bool current_matrix_p
)
14915 struct glyph_matrix
*matrix
;
14916 struct glyph_row
*row
;
14919 if (!make_cursor_line_fully_visible_p
)
14922 /* It's not always possible to find the cursor, e.g, when a window
14923 is full of overlay strings. Don't do anything in that case. */
14924 if (w
->cursor
.vpos
< 0)
14927 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14928 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14930 /* If the cursor row is not partially visible, there's nothing to do. */
14931 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14934 /* If the row the cursor is in is taller than the window's height,
14935 it's not clear what to do, so do nothing. */
14936 window_height
= window_box_height (w
);
14937 if (row
->height
>= window_height
)
14939 if (!force_p
|| MINI_WINDOW_P (w
)
14940 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14947 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14948 means only WINDOW is redisplayed in redisplay_internal.
14949 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14950 in redisplay_window to bring a partially visible line into view in
14951 the case that only the cursor has moved.
14953 LAST_LINE_MISFIT should be true if we're scrolling because the
14954 last screen line's vertical height extends past the end of the screen.
14958 1 if scrolling succeeded
14960 0 if scrolling didn't find point.
14962 -1 if new fonts have been loaded so that we must interrupt
14963 redisplay, adjust glyph matrices, and try again. */
14969 SCROLLING_NEED_LARGER_MATRICES
14972 /* If scroll-conservatively is more than this, never recenter.
14974 If you change this, don't forget to update the doc string of
14975 `scroll-conservatively' and the Emacs manual. */
14976 #define SCROLL_LIMIT 100
14979 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14980 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14981 bool temp_scroll_step
, bool last_line_misfit
)
14983 struct window
*w
= XWINDOW (window
);
14984 struct frame
*f
= XFRAME (w
->frame
);
14985 struct text_pos pos
, startp
;
14987 int this_scroll_margin
, scroll_max
, rc
, height
;
14988 int dy
= 0, amount_to_scroll
= 0;
14989 bool scroll_down_p
= false;
14990 int extra_scroll_margin_lines
= last_line_misfit
;
14991 Lisp_Object aggressive
;
14992 /* We will never try scrolling more than this number of lines. */
14993 int scroll_limit
= SCROLL_LIMIT
;
14994 int frame_line_height
= default_line_pixel_height (w
);
14995 int window_total_lines
14996 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14999 debug_method_add (w
, "try_scrolling");
15002 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15004 /* Compute scroll margin height in pixels. We scroll when point is
15005 within this distance from the top or bottom of the window. */
15006 if (scroll_margin
> 0)
15007 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15008 * frame_line_height
;
15010 this_scroll_margin
= 0;
15012 /* Force arg_scroll_conservatively to have a reasonable value, to
15013 avoid scrolling too far away with slow move_it_* functions. Note
15014 that the user can supply scroll-conservatively equal to
15015 `most-positive-fixnum', which can be larger than INT_MAX. */
15016 if (arg_scroll_conservatively
> scroll_limit
)
15018 arg_scroll_conservatively
= scroll_limit
+ 1;
15019 scroll_max
= scroll_limit
* frame_line_height
;
15021 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15022 /* Compute how much we should try to scroll maximally to bring
15023 point into view. */
15024 scroll_max
= (max (scroll_step
,
15025 max (arg_scroll_conservatively
, temp_scroll_step
))
15026 * frame_line_height
);
15027 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15028 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15029 /* We're trying to scroll because of aggressive scrolling but no
15030 scroll_step is set. Choose an arbitrary one. */
15031 scroll_max
= 10 * frame_line_height
;
15037 /* Decide whether to scroll down. */
15038 if (PT
> CHARPOS (startp
))
15040 int scroll_margin_y
;
15042 /* Compute the pixel ypos of the scroll margin, then move IT to
15043 either that ypos or PT, whichever comes first. */
15044 start_display (&it
, w
, startp
);
15045 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15046 - frame_line_height
* extra_scroll_margin_lines
;
15047 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15048 (MOVE_TO_POS
| MOVE_TO_Y
));
15050 if (PT
> CHARPOS (it
.current
.pos
))
15052 int y0
= line_bottom_y (&it
);
15053 /* Compute how many pixels below window bottom to stop searching
15054 for PT. This avoids costly search for PT that is far away if
15055 the user limited scrolling by a small number of lines, but
15056 always finds PT if scroll_conservatively is set to a large
15057 number, such as most-positive-fixnum. */
15058 int slack
= max (scroll_max
, 10 * frame_line_height
);
15059 int y_to_move
= it
.last_visible_y
+ slack
;
15061 /* Compute the distance from the scroll margin to PT or to
15062 the scroll limit, whichever comes first. This should
15063 include the height of the cursor line, to make that line
15065 move_it_to (&it
, PT
, -1, y_to_move
,
15066 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15067 dy
= line_bottom_y (&it
) - y0
;
15069 if (dy
> scroll_max
)
15070 return SCROLLING_FAILED
;
15073 scroll_down_p
= true;
15079 /* Point is in or below the bottom scroll margin, so move the
15080 window start down. If scrolling conservatively, move it just
15081 enough down to make point visible. If scroll_step is set,
15082 move it down by scroll_step. */
15083 if (arg_scroll_conservatively
)
15085 = min (max (dy
, frame_line_height
),
15086 frame_line_height
* arg_scroll_conservatively
);
15087 else if (scroll_step
|| temp_scroll_step
)
15088 amount_to_scroll
= scroll_max
;
15091 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15092 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15093 if (NUMBERP (aggressive
))
15095 double float_amount
= XFLOATINT (aggressive
) * height
;
15096 int aggressive_scroll
= float_amount
;
15097 if (aggressive_scroll
== 0 && float_amount
> 0)
15098 aggressive_scroll
= 1;
15099 /* Don't let point enter the scroll margin near top of
15100 the window. This could happen if the value of
15101 scroll_up_aggressively is too large and there are
15102 non-zero margins, because scroll_up_aggressively
15103 means put point that fraction of window height
15104 _from_the_bottom_margin_. */
15105 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15106 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15107 amount_to_scroll
= dy
+ aggressive_scroll
;
15111 if (amount_to_scroll
<= 0)
15112 return SCROLLING_FAILED
;
15114 start_display (&it
, w
, startp
);
15115 if (arg_scroll_conservatively
<= scroll_limit
)
15116 move_it_vertically (&it
, amount_to_scroll
);
15119 /* Extra precision for users who set scroll-conservatively
15120 to a large number: make sure the amount we scroll
15121 the window start is never less than amount_to_scroll,
15122 which was computed as distance from window bottom to
15123 point. This matters when lines at window top and lines
15124 below window bottom have different height. */
15126 void *it1data
= NULL
;
15127 /* We use a temporary it1 because line_bottom_y can modify
15128 its argument, if it moves one line down; see there. */
15131 SAVE_IT (it1
, it
, it1data
);
15132 start_y
= line_bottom_y (&it1
);
15134 RESTORE_IT (&it
, &it
, it1data
);
15135 move_it_by_lines (&it
, 1);
15136 SAVE_IT (it1
, it
, it1data
);
15137 } while (IT_CHARPOS (it
) < ZV
15138 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15139 bidi_unshelve_cache (it1data
, true);
15142 /* If STARTP is unchanged, move it down another screen line. */
15143 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15144 move_it_by_lines (&it
, 1);
15145 startp
= it
.current
.pos
;
15149 struct text_pos scroll_margin_pos
= startp
;
15152 /* See if point is inside the scroll margin at the top of the
15154 if (this_scroll_margin
)
15158 start_display (&it
, w
, startp
);
15159 y_start
= it
.current_y
;
15160 move_it_vertically (&it
, this_scroll_margin
);
15161 scroll_margin_pos
= it
.current
.pos
;
15162 /* If we didn't move enough before hitting ZV, request
15163 additional amount of scroll, to move point out of the
15165 if (IT_CHARPOS (it
) == ZV
15166 && it
.current_y
- y_start
< this_scroll_margin
)
15167 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15170 if (PT
< CHARPOS (scroll_margin_pos
))
15172 /* Point is in the scroll margin at the top of the window or
15173 above what is displayed in the window. */
15176 /* Compute the vertical distance from PT to the scroll
15177 margin position. Move as far as scroll_max allows, or
15178 one screenful, or 10 screen lines, whichever is largest.
15179 Give up if distance is greater than scroll_max or if we
15180 didn't reach the scroll margin position. */
15181 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15182 start_display (&it
, w
, pos
);
15184 y_to_move
= max (it
.last_visible_y
,
15185 max (scroll_max
, 10 * frame_line_height
));
15186 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15188 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15189 dy
= it
.current_y
- y0
;
15190 if (dy
> scroll_max
15191 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15192 return SCROLLING_FAILED
;
15194 /* Additional scroll for when ZV was too close to point. */
15197 /* Compute new window start. */
15198 start_display (&it
, w
, startp
);
15200 if (arg_scroll_conservatively
)
15201 amount_to_scroll
= max (dy
, frame_line_height
15202 * max (scroll_step
, temp_scroll_step
));
15203 else if (scroll_step
|| temp_scroll_step
)
15204 amount_to_scroll
= scroll_max
;
15207 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15208 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15209 if (NUMBERP (aggressive
))
15211 double float_amount
= XFLOATINT (aggressive
) * height
;
15212 int aggressive_scroll
= float_amount
;
15213 if (aggressive_scroll
== 0 && float_amount
> 0)
15214 aggressive_scroll
= 1;
15215 /* Don't let point enter the scroll margin near
15216 bottom of the window, if the value of
15217 scroll_down_aggressively happens to be too
15219 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15220 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15221 amount_to_scroll
= dy
+ aggressive_scroll
;
15225 if (amount_to_scroll
<= 0)
15226 return SCROLLING_FAILED
;
15228 move_it_vertically_backward (&it
, amount_to_scroll
);
15229 startp
= it
.current
.pos
;
15233 /* Run window scroll functions. */
15234 startp
= run_window_scroll_functions (window
, startp
);
15236 /* Display the window. Give up if new fonts are loaded, or if point
15238 if (!try_window (window
, startp
, 0))
15239 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15240 else if (w
->cursor
.vpos
< 0)
15242 clear_glyph_matrix (w
->desired_matrix
);
15243 rc
= SCROLLING_FAILED
;
15247 /* Maybe forget recorded base line for line number display. */
15248 if (!just_this_one_p
15249 || current_buffer
->clip_changed
15250 || BEG_UNCHANGED
< CHARPOS (startp
))
15251 w
->base_line_number
= 0;
15253 /* If cursor ends up on a partially visible line,
15254 treat that as being off the bottom of the screen. */
15255 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15257 /* It's possible that the cursor is on the first line of the
15258 buffer, which is partially obscured due to a vscroll
15259 (Bug#7537). In that case, avoid looping forever. */
15260 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15262 clear_glyph_matrix (w
->desired_matrix
);
15263 ++extra_scroll_margin_lines
;
15266 rc
= SCROLLING_SUCCESS
;
15273 /* Compute a suitable window start for window W if display of W starts
15274 on a continuation line. Value is true if a new window start
15277 The new window start will be computed, based on W's width, starting
15278 from the start of the continued line. It is the start of the
15279 screen line with the minimum distance from the old start W->start. */
15282 compute_window_start_on_continuation_line (struct window
*w
)
15284 struct text_pos pos
, start_pos
;
15285 bool window_start_changed_p
= false;
15287 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15289 /* If window start is on a continuation line... Window start may be
15290 < BEGV in case there's invisible text at the start of the
15291 buffer (M-x rmail, for example). */
15292 if (CHARPOS (start_pos
) > BEGV
15293 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15296 struct glyph_row
*row
;
15298 /* Handle the case that the window start is out of range. */
15299 if (CHARPOS (start_pos
) < BEGV
)
15300 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15301 else if (CHARPOS (start_pos
) > ZV
)
15302 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15304 /* Find the start of the continued line. This should be fast
15305 because find_newline is fast (newline cache). */
15306 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15307 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15308 row
, DEFAULT_FACE_ID
);
15309 reseat_at_previous_visible_line_start (&it
);
15311 /* If the line start is "too far" away from the window start,
15312 say it takes too much time to compute a new window start. */
15313 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15314 /* PXW: Do we need upper bounds here? */
15315 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15317 int min_distance
, distance
;
15319 /* Move forward by display lines to find the new window
15320 start. If window width was enlarged, the new start can
15321 be expected to be > the old start. If window width was
15322 decreased, the new window start will be < the old start.
15323 So, we're looking for the display line start with the
15324 minimum distance from the old window start. */
15325 pos
= it
.current
.pos
;
15326 min_distance
= INFINITY
;
15327 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15328 distance
< min_distance
)
15330 min_distance
= distance
;
15331 pos
= it
.current
.pos
;
15332 if (it
.line_wrap
== WORD_WRAP
)
15334 /* Under WORD_WRAP, move_it_by_lines is likely to
15335 overshoot and stop not at the first, but the
15336 second character from the left margin. So in
15337 that case, we need a more tight control on the X
15338 coordinate of the iterator than move_it_by_lines
15339 promises in its contract. The method is to first
15340 go to the last (rightmost) visible character of a
15341 line, then move to the leftmost character on the
15342 next line in a separate call. */
15343 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15344 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15345 move_it_to (&it
, ZV
, 0,
15346 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15347 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15350 move_it_by_lines (&it
, 1);
15353 /* Set the window start there. */
15354 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15355 window_start_changed_p
= true;
15359 return window_start_changed_p
;
15363 /* Try cursor movement in case text has not changed in window WINDOW,
15364 with window start STARTP. Value is
15366 CURSOR_MOVEMENT_SUCCESS if successful
15368 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15370 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15371 display. *SCROLL_STEP is set to true, under certain circumstances, if
15372 we want to scroll as if scroll-step were set to 1. See the code.
15374 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15375 which case we have to abort this redisplay, and adjust matrices
15380 CURSOR_MOVEMENT_SUCCESS
,
15381 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15382 CURSOR_MOVEMENT_MUST_SCROLL
,
15383 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15387 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15390 struct window
*w
= XWINDOW (window
);
15391 struct frame
*f
= XFRAME (w
->frame
);
15392 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15395 if (inhibit_try_cursor_movement
)
15399 /* Previously, there was a check for Lisp integer in the
15400 if-statement below. Now, this field is converted to
15401 ptrdiff_t, thus zero means invalid position in a buffer. */
15402 eassert (w
->last_point
> 0);
15403 /* Likewise there was a check whether window_end_vpos is nil or larger
15404 than the window. Now window_end_vpos is int and so never nil, but
15405 let's leave eassert to check whether it fits in the window. */
15406 eassert (!w
->window_end_valid
15407 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15409 /* Handle case where text has not changed, only point, and it has
15410 not moved off the frame. */
15411 if (/* Point may be in this window. */
15412 PT
>= CHARPOS (startp
)
15413 /* Selective display hasn't changed. */
15414 && !current_buffer
->clip_changed
15415 /* Function force-mode-line-update is used to force a thorough
15416 redisplay. It sets either windows_or_buffers_changed or
15417 update_mode_lines. So don't take a shortcut here for these
15419 && !update_mode_lines
15420 && !windows_or_buffers_changed
15421 && !f
->cursor_type_changed
15422 && NILP (Vshow_trailing_whitespace
)
15423 /* This code is not used for mini-buffer for the sake of the case
15424 of redisplaying to replace an echo area message; since in
15425 that case the mini-buffer contents per se are usually
15426 unchanged. This code is of no real use in the mini-buffer
15427 since the handling of this_line_start_pos, etc., in redisplay
15428 handles the same cases. */
15429 && !EQ (window
, minibuf_window
)
15430 && (FRAME_WINDOW_P (f
)
15431 || !overlay_arrow_in_current_buffer_p ()))
15433 int this_scroll_margin
, top_scroll_margin
;
15434 struct glyph_row
*row
= NULL
;
15435 int frame_line_height
= default_line_pixel_height (w
);
15436 int window_total_lines
15437 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15440 debug_method_add (w
, "cursor movement");
15443 /* Scroll if point within this distance from the top or bottom
15444 of the window. This is a pixel value. */
15445 if (scroll_margin
> 0)
15447 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15448 this_scroll_margin
*= frame_line_height
;
15451 this_scroll_margin
= 0;
15453 top_scroll_margin
= this_scroll_margin
;
15454 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15455 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15457 /* Start with the row the cursor was displayed during the last
15458 not paused redisplay. Give up if that row is not valid. */
15459 if (w
->last_cursor_vpos
< 0
15460 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15461 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15464 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15465 if (row
->mode_line_p
)
15467 if (!row
->enabled_p
)
15468 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15471 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15473 bool scroll_p
= false, must_scroll
= false;
15474 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15476 if (PT
> w
->last_point
)
15478 /* Point has moved forward. */
15479 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15480 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15482 eassert (row
->enabled_p
);
15486 /* If the end position of a row equals the start
15487 position of the next row, and PT is at that position,
15488 we would rather display cursor in the next line. */
15489 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15490 && MATRIX_ROW_END_CHARPOS (row
) == PT
15491 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15492 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15493 && !cursor_row_p (row
))
15496 /* If within the scroll margin, scroll. Note that
15497 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15498 the next line would be drawn, and that
15499 this_scroll_margin can be zero. */
15500 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15501 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15502 /* Line is completely visible last line in window
15503 and PT is to be set in the next line. */
15504 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15505 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15506 && !row
->ends_at_zv_p
15507 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15510 else if (PT
< w
->last_point
)
15512 /* Cursor has to be moved backward. Note that PT >=
15513 CHARPOS (startp) because of the outer if-statement. */
15514 while (!row
->mode_line_p
15515 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15516 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15517 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15518 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15519 row
> w
->current_matrix
->rows
15520 && (row
-1)->ends_in_newline_from_string_p
))))
15521 && (row
->y
> top_scroll_margin
15522 || CHARPOS (startp
) == BEGV
))
15524 eassert (row
->enabled_p
);
15528 /* Consider the following case: Window starts at BEGV,
15529 there is invisible, intangible text at BEGV, so that
15530 display starts at some point START > BEGV. It can
15531 happen that we are called with PT somewhere between
15532 BEGV and START. Try to handle that case. */
15533 if (row
< w
->current_matrix
->rows
15534 || row
->mode_line_p
)
15536 row
= w
->current_matrix
->rows
;
15537 if (row
->mode_line_p
)
15541 /* Due to newlines in overlay strings, we may have to
15542 skip forward over overlay strings. */
15543 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15544 && MATRIX_ROW_END_CHARPOS (row
) == PT
15545 && !cursor_row_p (row
))
15548 /* If within the scroll margin, scroll. */
15549 if (row
->y
< top_scroll_margin
15550 && CHARPOS (startp
) != BEGV
)
15555 /* Cursor did not move. So don't scroll even if cursor line
15556 is partially visible, as it was so before. */
15557 rc
= CURSOR_MOVEMENT_SUCCESS
;
15560 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15561 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15563 /* if PT is not in the glyph row, give up. */
15564 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15565 must_scroll
= true;
15567 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15568 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15570 struct glyph_row
*row1
;
15572 /* If rows are bidi-reordered and point moved, back up
15573 until we find a row that does not belong to a
15574 continuation line. This is because we must consider
15575 all rows of a continued line as candidates for the
15576 new cursor positioning, since row start and end
15577 positions change non-linearly with vertical position
15579 /* FIXME: Revisit this when glyph ``spilling'' in
15580 continuation lines' rows is implemented for
15581 bidi-reordered rows. */
15582 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15583 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15586 /* If we hit the beginning of the displayed portion
15587 without finding the first row of a continued
15591 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15594 eassert (row
->enabled_p
);
15599 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15600 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15601 /* Make sure this isn't a header line by any chance, since
15602 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15603 && !row
->mode_line_p
15604 && make_cursor_line_fully_visible_p
)
15606 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15607 && !row
->ends_at_zv_p
15608 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15609 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15610 else if (row
->height
> window_box_height (w
))
15612 /* If we end up in a partially visible line, let's
15613 make it fully visible, except when it's taller
15614 than the window, in which case we can't do much
15616 *scroll_step
= true;
15617 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15621 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15622 if (!cursor_row_fully_visible_p (w
, false, true))
15623 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15625 rc
= CURSOR_MOVEMENT_SUCCESS
;
15629 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15630 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15631 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15633 /* With bidi-reordered rows, there could be more than
15634 one candidate row whose start and end positions
15635 occlude point. We need to let set_cursor_from_row
15636 find the best candidate. */
15637 /* FIXME: Revisit this when glyph ``spilling'' in
15638 continuation lines' rows is implemented for
15639 bidi-reordered rows. */
15644 bool at_zv_p
= false, exact_match_p
= false;
15646 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15647 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15648 && cursor_row_p (row
))
15649 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15651 /* As soon as we've found the exact match for point,
15652 or the first suitable row whose ends_at_zv_p flag
15653 is set, we are done. */
15656 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15657 w
->cursor
.vpos
)->ends_at_zv_p
;
15659 && w
->cursor
.hpos
>= 0
15660 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15663 struct glyph_row
*candidate
=
15664 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15666 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15667 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15670 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15671 || (NILP (g
->object
)
15672 && (g
->charpos
== PT
15673 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15675 if (at_zv_p
|| exact_match_p
)
15677 rc
= CURSOR_MOVEMENT_SUCCESS
;
15681 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15685 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15686 || row
->continued_p
)
15687 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15688 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15689 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15690 /* If we didn't find any candidate rows, or exited the
15691 loop before all the candidates were examined, signal
15692 to the caller that this method failed. */
15693 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15695 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15696 && !row
->continued_p
))
15697 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15699 rc
= CURSOR_MOVEMENT_SUCCESS
;
15705 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15707 rc
= CURSOR_MOVEMENT_SUCCESS
;
15712 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15713 && MATRIX_ROW_START_CHARPOS (row
) == PT
15714 && cursor_row_p (row
));
15724 set_vertical_scroll_bar (struct window
*w
)
15726 ptrdiff_t start
, end
, whole
;
15728 /* Calculate the start and end positions for the current window.
15729 At some point, it would be nice to choose between scrollbars
15730 which reflect the whole buffer size, with special markers
15731 indicating narrowing, and scrollbars which reflect only the
15734 Note that mini-buffers sometimes aren't displaying any text. */
15735 if (!MINI_WINDOW_P (w
)
15736 || (w
== XWINDOW (minibuf_window
)
15737 && NILP (echo_area_buffer
[0])))
15739 struct buffer
*buf
= XBUFFER (w
->contents
);
15740 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15741 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15742 /* I don't think this is guaranteed to be right. For the
15743 moment, we'll pretend it is. */
15744 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15748 if (whole
< (end
- start
))
15749 whole
= end
- start
;
15752 start
= end
= whole
= 0;
15754 /* Indicate what this scroll bar ought to be displaying now. */
15755 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15756 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15757 (w
, end
- start
, whole
, start
);
15762 set_horizontal_scroll_bar (struct window
*w
)
15764 int start
, end
, whole
, portion
;
15766 if (!MINI_WINDOW_P (w
)
15767 || (w
== XWINDOW (minibuf_window
)
15768 && NILP (echo_area_buffer
[0])))
15770 struct buffer
*b
= XBUFFER (w
->contents
);
15771 struct buffer
*old_buffer
= NULL
;
15773 struct text_pos startp
;
15775 if (b
!= current_buffer
)
15777 old_buffer
= current_buffer
;
15778 set_buffer_internal (b
);
15781 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15782 start_display (&it
, w
, startp
);
15783 it
.last_visible_x
= INT_MAX
;
15784 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15785 MOVE_TO_X
| MOVE_TO_Y
);
15786 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15787 window_box_height (w), -1,
15788 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15790 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15791 end
= start
+ window_box_width (w
, TEXT_AREA
);
15792 portion
= end
- start
;
15793 /* After enlarging a horizontally scrolled window such that it
15794 gets at least as wide as the text it contains, make sure that
15795 the thumb doesn't fill the entire scroll bar so we can still
15796 drag it back to see the entire text. */
15797 whole
= max (whole
, end
);
15803 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15804 if (EQ (pdir
, Qright_to_left
))
15806 start
= whole
- end
;
15807 end
= start
+ portion
;
15812 set_buffer_internal (old_buffer
);
15815 start
= end
= whole
= portion
= 0;
15817 w
->hscroll_whole
= whole
;
15819 /* Indicate what this scroll bar ought to be displaying now. */
15820 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15821 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15822 (w
, portion
, whole
, start
);
15826 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15827 selected_window is redisplayed.
15829 We can return without actually redisplaying the window if fonts has been
15830 changed on window's frame. In that case, redisplay_internal will retry.
15832 As one of the important parts of redisplaying a window, we need to
15833 decide whether the previous window-start position (stored in the
15834 window's w->start marker position) is still valid, and if it isn't,
15835 recompute it. Some details about that:
15837 . The previous window-start could be in a continuation line, in
15838 which case we need to recompute it when the window width
15839 changes. See compute_window_start_on_continuation_line and its
15842 . The text that changed since last redisplay could include the
15843 previous window-start position. In that case, we try to salvage
15844 what we can from the current glyph matrix by calling
15845 try_scrolling, which see.
15847 . Some Emacs command could force us to use a specific window-start
15848 position by setting the window's force_start flag, or gently
15849 propose doing that by setting the window's optional_new_start
15850 flag. In these cases, we try using the specified start point if
15851 that succeeds (i.e. the window desired matrix is successfully
15852 recomputed, and point location is within the window). In case
15853 of optional_new_start, we first check if the specified start
15854 position is feasible, i.e. if it will allow point to be
15855 displayed in the window. If using the specified start point
15856 fails, e.g., if new fonts are needed to be loaded, we abort the
15857 redisplay cycle and leave it up to the next cycle to figure out
15860 . Note that the window's force_start flag is sometimes set by
15861 redisplay itself, when it decides that the previous window start
15862 point is fine and should be kept. Search for "goto force_start"
15863 below to see the details. Like the values of window-start
15864 specified outside of redisplay, these internally-deduced values
15865 are tested for feasibility, and ignored if found to be
15868 . Note that the function try_window, used to completely redisplay
15869 a window, accepts the window's start point as its argument.
15870 This is used several times in the redisplay code to control
15871 where the window start will be, according to user options such
15872 as scroll-conservatively, and also to ensure the screen line
15873 showing point will be fully (as opposed to partially) visible on
15877 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15879 struct window
*w
= XWINDOW (window
);
15880 struct frame
*f
= XFRAME (w
->frame
);
15881 struct buffer
*buffer
= XBUFFER (w
->contents
);
15882 struct buffer
*old
= current_buffer
;
15883 struct text_pos lpoint
, opoint
, startp
;
15884 bool update_mode_line
;
15887 /* Record it now because it's overwritten. */
15888 bool current_matrix_up_to_date_p
= false;
15889 bool used_current_matrix_p
= false;
15890 /* This is less strict than current_matrix_up_to_date_p.
15891 It indicates that the buffer contents and narrowing are unchanged. */
15892 bool buffer_unchanged_p
= false;
15893 bool temp_scroll_step
= false;
15894 ptrdiff_t count
= SPECPDL_INDEX ();
15896 int centering_position
= -1;
15897 bool last_line_misfit
= false;
15898 ptrdiff_t beg_unchanged
, end_unchanged
;
15899 int frame_line_height
;
15901 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15905 *w
->desired_matrix
->method
= 0;
15908 if (!just_this_one_p
15909 && REDISPLAY_SOME_P ()
15911 && !w
->update_mode_line
15913 && !buffer
->text
->redisplay
15914 && BUF_PT (buffer
) == w
->last_point
)
15917 /* Make sure that both W's markers are valid. */
15918 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15919 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15921 /* We come here again if we need to run window-text-change-functions
15924 reconsider_clip_changes (w
);
15925 frame_line_height
= default_line_pixel_height (w
);
15927 /* Has the mode line to be updated? */
15928 update_mode_line
= (w
->update_mode_line
15929 || update_mode_lines
15930 || buffer
->clip_changed
15931 || buffer
->prevent_redisplay_optimizations_p
);
15933 if (!just_this_one_p
)
15934 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15935 cleverly elsewhere. */
15936 w
->must_be_updated_p
= true;
15938 if (MINI_WINDOW_P (w
))
15940 if (w
== XWINDOW (echo_area_window
)
15941 && !NILP (echo_area_buffer
[0]))
15943 if (update_mode_line
)
15944 /* We may have to update a tty frame's menu bar or a
15945 tool-bar. Example `M-x C-h C-h C-g'. */
15946 goto finish_menu_bars
;
15948 /* We've already displayed the echo area glyphs in this window. */
15949 goto finish_scroll_bars
;
15951 else if ((w
!= XWINDOW (minibuf_window
)
15952 || minibuf_level
== 0)
15953 /* When buffer is nonempty, redisplay window normally. */
15954 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15955 /* Quail displays non-mini buffers in minibuffer window.
15956 In that case, redisplay the window normally. */
15957 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15959 /* W is a mini-buffer window, but it's not active, so clear
15961 int yb
= window_text_bottom_y (w
);
15962 struct glyph_row
*row
;
15965 for (y
= 0, row
= w
->desired_matrix
->rows
;
15967 y
+= row
->height
, ++row
)
15968 blank_row (w
, row
, y
);
15969 goto finish_scroll_bars
;
15972 clear_glyph_matrix (w
->desired_matrix
);
15975 /* Otherwise set up data on this window; select its buffer and point
15977 /* Really select the buffer, for the sake of buffer-local
15979 set_buffer_internal_1 (XBUFFER (w
->contents
));
15981 current_matrix_up_to_date_p
15982 = (w
->window_end_valid
15983 && !current_buffer
->clip_changed
15984 && !current_buffer
->prevent_redisplay_optimizations_p
15985 && !window_outdated (w
));
15987 /* Run the window-text-change-functions
15988 if it is possible that the text on the screen has changed
15989 (either due to modification of the text, or any other reason). */
15990 if (!current_matrix_up_to_date_p
15991 && !NILP (Vwindow_text_change_functions
))
15993 safe_run_hooks (Qwindow_text_change_functions
);
15997 beg_unchanged
= BEG_UNCHANGED
;
15998 end_unchanged
= END_UNCHANGED
;
16000 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16002 specbind (Qinhibit_point_motion_hooks
, Qt
);
16005 = (w
->window_end_valid
16006 && !current_buffer
->clip_changed
16007 && !window_outdated (w
));
16009 /* When windows_or_buffers_changed is non-zero, we can't rely
16010 on the window end being valid, so set it to zero there. */
16011 if (windows_or_buffers_changed
)
16013 /* If window starts on a continuation line, maybe adjust the
16014 window start in case the window's width changed. */
16015 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16016 compute_window_start_on_continuation_line (w
);
16018 w
->window_end_valid
= false;
16019 /* If so, we also can't rely on current matrix
16020 and should not fool try_cursor_movement below. */
16021 current_matrix_up_to_date_p
= false;
16024 /* Some sanity checks. */
16025 CHECK_WINDOW_END (w
);
16026 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16028 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16031 if (mode_line_update_needed (w
))
16032 update_mode_line
= true;
16034 /* Point refers normally to the selected window. For any other
16035 window, set up appropriate value. */
16036 if (!EQ (window
, selected_window
))
16038 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16039 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16044 new_pt_byte
= BEGV_BYTE
;
16045 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16047 else if (new_pt
> (ZV
- 1))
16050 new_pt_byte
= ZV_BYTE
;
16051 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16054 /* We don't use SET_PT so that the point-motion hooks don't run. */
16055 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16058 /* If any of the character widths specified in the display table
16059 have changed, invalidate the width run cache. It's true that
16060 this may be a bit late to catch such changes, but the rest of
16061 redisplay goes (non-fatally) haywire when the display table is
16062 changed, so why should we worry about doing any better? */
16063 if (current_buffer
->width_run_cache
16064 || (current_buffer
->base_buffer
16065 && current_buffer
->base_buffer
->width_run_cache
))
16067 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16069 if (! disptab_matches_widthtab
16070 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16072 struct buffer
*buf
= current_buffer
;
16074 if (buf
->base_buffer
)
16075 buf
= buf
->base_buffer
;
16076 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16077 recompute_width_table (current_buffer
, disptab
);
16081 /* If window-start is screwed up, choose a new one. */
16082 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16085 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16087 /* If someone specified a new starting point but did not insist,
16088 check whether it can be used. */
16089 if ((w
->optional_new_start
|| window_frozen_p (w
))
16090 && CHARPOS (startp
) >= BEGV
16091 && CHARPOS (startp
) <= ZV
)
16093 ptrdiff_t it_charpos
;
16095 w
->optional_new_start
= false;
16096 start_display (&it
, w
, startp
);
16097 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16098 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16099 /* Record IT's position now, since line_bottom_y might change
16101 it_charpos
= IT_CHARPOS (it
);
16102 /* Make sure we set the force_start flag only if the cursor row
16103 will be fully visible. Otherwise, the code under force_start
16104 label below will try to move point back into view, which is
16105 not what the code which sets optional_new_start wants. */
16106 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16107 && !w
->force_start
)
16109 if (it_charpos
== PT
)
16110 w
->force_start
= true;
16111 /* IT may overshoot PT if text at PT is invisible. */
16112 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16113 w
->force_start
= true;
16115 if (w
->force_start
)
16117 if (window_frozen_p (w
))
16118 debug_method_add (w
, "set force_start from frozen window start");
16120 debug_method_add (w
, "set force_start from optional_new_start");
16128 /* Handle case where place to start displaying has been specified,
16129 unless the specified location is outside the accessible range. */
16130 if (w
->force_start
)
16132 /* We set this later on if we have to adjust point. */
16135 w
->force_start
= false;
16137 w
->window_end_valid
= false;
16139 /* Forget any recorded base line for line number display. */
16140 if (!buffer_unchanged_p
)
16141 w
->base_line_number
= 0;
16143 /* Redisplay the mode line. Select the buffer properly for that.
16144 Also, run the hook window-scroll-functions
16145 because we have scrolled. */
16146 /* Note, we do this after clearing force_start because
16147 if there's an error, it is better to forget about force_start
16148 than to get into an infinite loop calling the hook functions
16149 and having them get more errors. */
16150 if (!update_mode_line
16151 || ! NILP (Vwindow_scroll_functions
))
16153 update_mode_line
= true;
16154 w
->update_mode_line
= true;
16155 startp
= run_window_scroll_functions (window
, startp
);
16158 if (CHARPOS (startp
) < BEGV
)
16159 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16160 else if (CHARPOS (startp
) > ZV
)
16161 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16163 /* Redisplay, then check if cursor has been set during the
16164 redisplay. Give up if new fonts were loaded. */
16165 /* We used to issue a CHECK_MARGINS argument to try_window here,
16166 but this causes scrolling to fail when point begins inside
16167 the scroll margin (bug#148) -- cyd */
16168 if (!try_window (window
, startp
, 0))
16170 w
->force_start
= true;
16171 clear_glyph_matrix (w
->desired_matrix
);
16172 goto need_larger_matrices
;
16175 if (w
->cursor
.vpos
< 0)
16177 /* If point does not appear, try to move point so it does
16178 appear. The desired matrix has been built above, so we
16179 can use it here. */
16180 new_vpos
= window_box_height (w
) / 2;
16183 if (!cursor_row_fully_visible_p (w
, false, false))
16185 /* Point does appear, but on a line partly visible at end of window.
16186 Move it back to a fully-visible line. */
16187 new_vpos
= window_box_height (w
);
16188 /* But if window_box_height suggests a Y coordinate that is
16189 not less than we already have, that line will clearly not
16190 be fully visible, so give up and scroll the display.
16191 This can happen when the default face uses a font whose
16192 dimensions are different from the frame's default
16194 if (new_vpos
>= w
->cursor
.y
)
16196 w
->cursor
.vpos
= -1;
16197 clear_glyph_matrix (w
->desired_matrix
);
16198 goto try_to_scroll
;
16201 else if (w
->cursor
.vpos
>= 0)
16203 /* Some people insist on not letting point enter the scroll
16204 margin, even though this part handles windows that didn't
16206 int window_total_lines
16207 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16208 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16209 int pixel_margin
= margin
* frame_line_height
;
16210 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16212 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16213 below, which finds the row to move point to, advances by
16214 the Y coordinate of the _next_ row, see the definition of
16215 MATRIX_ROW_BOTTOM_Y. */
16216 if (w
->cursor
.vpos
< margin
+ header_line
)
16218 w
->cursor
.vpos
= -1;
16219 clear_glyph_matrix (w
->desired_matrix
);
16220 goto try_to_scroll
;
16224 int window_height
= window_box_height (w
);
16227 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16228 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16230 w
->cursor
.vpos
= -1;
16231 clear_glyph_matrix (w
->desired_matrix
);
16232 goto try_to_scroll
;
16237 /* If we need to move point for either of the above reasons,
16238 now actually do it. */
16241 struct glyph_row
*row
;
16243 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16244 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16247 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16248 MATRIX_ROW_START_BYTEPOS (row
));
16250 if (w
!= XWINDOW (selected_window
))
16251 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16252 else if (current_buffer
== old
)
16253 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16255 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16257 /* Re-run pre-redisplay-function so it can update the region
16258 according to the new position of point. */
16259 /* Other than the cursor, w's redisplay is done so we can set its
16260 redisplay to false. Also the buffer's redisplay can be set to
16261 false, since propagate_buffer_redisplay should have already
16262 propagated its info to `w' anyway. */
16263 w
->redisplay
= false;
16264 XBUFFER (w
->contents
)->text
->redisplay
= false;
16265 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16267 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16269 /* pre-redisplay-function made changes (e.g. move the region)
16270 that require another round of redisplay. */
16271 clear_glyph_matrix (w
->desired_matrix
);
16272 if (!try_window (window
, startp
, 0))
16273 goto need_larger_matrices
;
16276 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16278 clear_glyph_matrix (w
->desired_matrix
);
16279 goto try_to_scroll
;
16283 debug_method_add (w
, "forced window start");
16288 /* Handle case where text has not changed, only point, and it has
16289 not moved off the frame, and we are not retrying after hscroll.
16290 (current_matrix_up_to_date_p is true when retrying.) */
16291 if (current_matrix_up_to_date_p
16292 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16293 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16297 case CURSOR_MOVEMENT_SUCCESS
:
16298 used_current_matrix_p
= true;
16301 case CURSOR_MOVEMENT_MUST_SCROLL
:
16302 goto try_to_scroll
;
16308 /* If current starting point was originally the beginning of a line
16309 but no longer is, find a new starting point. */
16310 else if (w
->start_at_line_beg
16311 && !(CHARPOS (startp
) <= BEGV
16312 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16315 debug_method_add (w
, "recenter 1");
16320 /* Try scrolling with try_window_id. Value is > 0 if update has
16321 been done, it is -1 if we know that the same window start will
16322 not work. It is 0 if unsuccessful for some other reason. */
16323 else if ((tem
= try_window_id (w
)) != 0)
16326 debug_method_add (w
, "try_window_id %d", tem
);
16329 if (f
->fonts_changed
)
16330 goto need_larger_matrices
;
16334 /* Otherwise try_window_id has returned -1 which means that we
16335 don't want the alternative below this comment to execute. */
16337 else if (CHARPOS (startp
) >= BEGV
16338 && CHARPOS (startp
) <= ZV
16339 && PT
>= CHARPOS (startp
)
16340 && (CHARPOS (startp
) < ZV
16341 /* Avoid starting at end of buffer. */
16342 || CHARPOS (startp
) == BEGV
16343 || !window_outdated (w
)))
16345 int d1
, d2
, d5
, d6
;
16348 /* If first window line is a continuation line, and window start
16349 is inside the modified region, but the first change is before
16350 current window start, we must select a new window start.
16352 However, if this is the result of a down-mouse event (e.g. by
16353 extending the mouse-drag-overlay), we don't want to select a
16354 new window start, since that would change the position under
16355 the mouse, resulting in an unwanted mouse-movement rather
16356 than a simple mouse-click. */
16357 if (!w
->start_at_line_beg
16358 && NILP (do_mouse_tracking
)
16359 && CHARPOS (startp
) > BEGV
16360 && CHARPOS (startp
) > BEG
+ beg_unchanged
16361 && CHARPOS (startp
) <= Z
- end_unchanged
16362 /* Even if w->start_at_line_beg is nil, a new window may
16363 start at a line_beg, since that's how set_buffer_window
16364 sets it. So, we need to check the return value of
16365 compute_window_start_on_continuation_line. (See also
16367 && XMARKER (w
->start
)->buffer
== current_buffer
16368 && compute_window_start_on_continuation_line (w
)
16369 /* It doesn't make sense to force the window start like we
16370 do at label force_start if it is already known that point
16371 will not be fully visible in the resulting window, because
16372 doing so will move point from its correct position
16373 instead of scrolling the window to bring point into view.
16375 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16376 /* A very tall row could need more than the window height,
16377 in which case we accept that it is partially visible. */
16378 && (rtop
!= 0) == (rbot
!= 0))
16380 w
->force_start
= true;
16381 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16383 debug_method_add (w
, "recomputed window start in continuation line");
16389 debug_method_add (w
, "same window start");
16392 /* Try to redisplay starting at same place as before.
16393 If point has not moved off frame, accept the results. */
16394 if (!current_matrix_up_to_date_p
16395 /* Don't use try_window_reusing_current_matrix in this case
16396 because a window scroll function can have changed the
16398 || !NILP (Vwindow_scroll_functions
)
16399 || MINI_WINDOW_P (w
)
16400 || !(used_current_matrix_p
16401 = try_window_reusing_current_matrix (w
)))
16403 IF_DEBUG (debug_method_add (w
, "1"));
16404 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16405 /* -1 means we need to scroll.
16406 0 means we need new matrices, but fonts_changed
16407 is set in that case, so we will detect it below. */
16408 goto try_to_scroll
;
16411 if (f
->fonts_changed
)
16412 goto need_larger_matrices
;
16414 if (w
->cursor
.vpos
>= 0)
16416 if (!just_this_one_p
16417 || current_buffer
->clip_changed
16418 || BEG_UNCHANGED
< CHARPOS (startp
))
16419 /* Forget any recorded base line for line number display. */
16420 w
->base_line_number
= 0;
16422 if (!cursor_row_fully_visible_p (w
, true, false))
16424 clear_glyph_matrix (w
->desired_matrix
);
16425 last_line_misfit
= true;
16427 /* Drop through and scroll. */
16432 clear_glyph_matrix (w
->desired_matrix
);
16437 /* Redisplay the mode line. Select the buffer properly for that. */
16438 if (!update_mode_line
)
16440 update_mode_line
= true;
16441 w
->update_mode_line
= true;
16444 /* Try to scroll by specified few lines. */
16445 if ((scroll_conservatively
16446 || emacs_scroll_step
16447 || temp_scroll_step
16448 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16449 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16450 && CHARPOS (startp
) >= BEGV
16451 && CHARPOS (startp
) <= ZV
)
16453 /* The function returns -1 if new fonts were loaded, 1 if
16454 successful, 0 if not successful. */
16455 int ss
= try_scrolling (window
, just_this_one_p
,
16456 scroll_conservatively
,
16458 temp_scroll_step
, last_line_misfit
);
16461 case SCROLLING_SUCCESS
:
16464 case SCROLLING_NEED_LARGER_MATRICES
:
16465 goto need_larger_matrices
;
16467 case SCROLLING_FAILED
:
16475 /* Finally, just choose a place to start which positions point
16476 according to user preferences. */
16481 debug_method_add (w
, "recenter");
16484 /* Forget any previously recorded base line for line number display. */
16485 if (!buffer_unchanged_p
)
16486 w
->base_line_number
= 0;
16488 /* Determine the window start relative to point. */
16489 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16490 it
.current_y
= it
.last_visible_y
;
16491 if (centering_position
< 0)
16493 int window_total_lines
16494 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16496 = scroll_margin
> 0
16497 ? min (scroll_margin
, window_total_lines
/ 4)
16499 ptrdiff_t margin_pos
= CHARPOS (startp
);
16500 Lisp_Object aggressive
;
16503 /* If there is a scroll margin at the top of the window, find
16504 its character position. */
16506 /* Cannot call start_display if startp is not in the
16507 accessible region of the buffer. This can happen when we
16508 have just switched to a different buffer and/or changed
16509 its restriction. In that case, startp is initialized to
16510 the character position 1 (BEGV) because we did not yet
16511 have chance to display the buffer even once. */
16512 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16515 void *it1data
= NULL
;
16517 SAVE_IT (it1
, it
, it1data
);
16518 start_display (&it1
, w
, startp
);
16519 move_it_vertically (&it1
, margin
* frame_line_height
);
16520 margin_pos
= IT_CHARPOS (it1
);
16521 RESTORE_IT (&it
, &it
, it1data
);
16523 scrolling_up
= PT
> margin_pos
;
16526 ? BVAR (current_buffer
, scroll_up_aggressively
)
16527 : BVAR (current_buffer
, scroll_down_aggressively
);
16529 if (!MINI_WINDOW_P (w
)
16530 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16534 /* Setting scroll-conservatively overrides
16535 scroll-*-aggressively. */
16536 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16538 double float_amount
= XFLOATINT (aggressive
);
16540 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16541 if (pt_offset
== 0 && float_amount
> 0)
16543 if (pt_offset
&& margin
> 0)
16546 /* Compute how much to move the window start backward from
16547 point so that point will be displayed where the user
16551 centering_position
= it
.last_visible_y
;
16553 centering_position
-= pt_offset
;
16554 centering_position
-=
16555 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16556 + WINDOW_HEADER_LINE_HEIGHT (w
));
16557 /* Don't let point enter the scroll margin near top of
16559 if (centering_position
< margin
* frame_line_height
)
16560 centering_position
= margin
* frame_line_height
;
16563 centering_position
= margin
* frame_line_height
+ pt_offset
;
16566 /* Set the window start half the height of the window backward
16568 centering_position
= window_box_height (w
) / 2;
16570 move_it_vertically_backward (&it
, centering_position
);
16572 eassert (IT_CHARPOS (it
) >= BEGV
);
16574 /* The function move_it_vertically_backward may move over more
16575 than the specified y-distance. If it->w is small, e.g. a
16576 mini-buffer window, we may end up in front of the window's
16577 display area. Start displaying at the start of the line
16578 containing PT in this case. */
16579 if (it
.current_y
<= 0)
16581 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16582 move_it_vertically_backward (&it
, 0);
16586 it
.current_x
= it
.hpos
= 0;
16588 /* Set the window start position here explicitly, to avoid an
16589 infinite loop in case the functions in window-scroll-functions
16591 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16593 /* Run scroll hooks. */
16594 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16596 /* Redisplay the window. */
16597 if (!current_matrix_up_to_date_p
16598 || windows_or_buffers_changed
16599 || f
->cursor_type_changed
16600 /* Don't use try_window_reusing_current_matrix in this case
16601 because it can have changed the buffer. */
16602 || !NILP (Vwindow_scroll_functions
)
16603 || !just_this_one_p
16604 || MINI_WINDOW_P (w
)
16605 || !(used_current_matrix_p
16606 = try_window_reusing_current_matrix (w
)))
16607 try_window (window
, startp
, 0);
16609 /* If new fonts have been loaded (due to fontsets), give up. We
16610 have to start a new redisplay since we need to re-adjust glyph
16612 if (f
->fonts_changed
)
16613 goto need_larger_matrices
;
16615 /* If cursor did not appear assume that the middle of the window is
16616 in the first line of the window. Do it again with the next line.
16617 (Imagine a window of height 100, displaying two lines of height
16618 60. Moving back 50 from it->last_visible_y will end in the first
16620 if (w
->cursor
.vpos
< 0)
16622 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16624 clear_glyph_matrix (w
->desired_matrix
);
16625 move_it_by_lines (&it
, 1);
16626 try_window (window
, it
.current
.pos
, 0);
16628 else if (PT
< IT_CHARPOS (it
))
16630 clear_glyph_matrix (w
->desired_matrix
);
16631 move_it_by_lines (&it
, -1);
16632 try_window (window
, it
.current
.pos
, 0);
16636 /* Not much we can do about it. */
16640 /* Consider the following case: Window starts at BEGV, there is
16641 invisible, intangible text at BEGV, so that display starts at
16642 some point START > BEGV. It can happen that we are called with
16643 PT somewhere between BEGV and START. Try to handle that case,
16644 and similar ones. */
16645 if (w
->cursor
.vpos
< 0)
16647 /* First, try locating the proper glyph row for PT. */
16648 struct glyph_row
*row
=
16649 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16651 /* Sometimes point is at the beginning of invisible text that is
16652 before the 1st character displayed in the row. In that case,
16653 row_containing_pos fails to find the row, because no glyphs
16654 with appropriate buffer positions are present in the row.
16655 Therefore, we next try to find the row which shows the 1st
16656 position after the invisible text. */
16660 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16663 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16666 Lisp_Object invis_end
=
16667 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16670 if (NATNUMP (invis_end
))
16671 alt_pos
= XFASTINT (invis_end
);
16674 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16678 /* Finally, fall back on the first row of the window after the
16679 header line (if any). This is slightly better than not
16680 displaying the cursor at all. */
16683 row
= w
->current_matrix
->rows
;
16684 if (row
->mode_line_p
)
16687 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16690 if (!cursor_row_fully_visible_p (w
, false, false))
16692 /* If vscroll is enabled, disable it and try again. */
16696 clear_glyph_matrix (w
->desired_matrix
);
16700 /* Users who set scroll-conservatively to a large number want
16701 point just above/below the scroll margin. If we ended up
16702 with point's row partially visible, move the window start to
16703 make that row fully visible and out of the margin. */
16704 if (scroll_conservatively
> SCROLL_LIMIT
)
16706 int window_total_lines
16707 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16710 ? min (scroll_margin
, window_total_lines
/ 4)
16712 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16714 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16715 clear_glyph_matrix (w
->desired_matrix
);
16716 if (1 == try_window (window
, it
.current
.pos
,
16717 TRY_WINDOW_CHECK_MARGINS
))
16721 /* If centering point failed to make the whole line visible,
16722 put point at the top instead. That has to make the whole line
16723 visible, if it can be done. */
16724 if (centering_position
== 0)
16727 clear_glyph_matrix (w
->desired_matrix
);
16728 centering_position
= 0;
16734 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16735 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16736 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16738 /* Display the mode line, if we must. */
16739 if ((update_mode_line
16740 /* If window not full width, must redo its mode line
16741 if (a) the window to its side is being redone and
16742 (b) we do a frame-based redisplay. This is a consequence
16743 of how inverted lines are drawn in frame-based redisplay. */
16744 || (!just_this_one_p
16745 && !FRAME_WINDOW_P (f
)
16746 && !WINDOW_FULL_WIDTH_P (w
))
16747 /* Line number to display. */
16748 || w
->base_line_pos
> 0
16749 /* Column number is displayed and different from the one displayed. */
16750 || (w
->column_number_displayed
!= -1
16751 && (w
->column_number_displayed
!= current_column ())))
16752 /* This means that the window has a mode line. */
16753 && (WINDOW_WANTS_MODELINE_P (w
)
16754 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16757 display_mode_lines (w
);
16759 /* If mode line height has changed, arrange for a thorough
16760 immediate redisplay using the correct mode line height. */
16761 if (WINDOW_WANTS_MODELINE_P (w
)
16762 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16764 f
->fonts_changed
= true;
16765 w
->mode_line_height
= -1;
16766 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16767 = DESIRED_MODE_LINE_HEIGHT (w
);
16770 /* If header line height has changed, arrange for a thorough
16771 immediate redisplay using the correct header line height. */
16772 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16773 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16775 f
->fonts_changed
= true;
16776 w
->header_line_height
= -1;
16777 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16778 = DESIRED_HEADER_LINE_HEIGHT (w
);
16781 if (f
->fonts_changed
)
16782 goto need_larger_matrices
;
16785 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16787 w
->base_line_pos
= 0;
16788 w
->base_line_number
= 0;
16793 /* When we reach a frame's selected window, redo the frame's menu bar. */
16794 if (update_mode_line
16795 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16797 bool redisplay_menu_p
;
16799 if (FRAME_WINDOW_P (f
))
16801 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16802 || defined (HAVE_NS) || defined (USE_GTK)
16803 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16805 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16809 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16811 if (redisplay_menu_p
)
16812 display_menu_bar (w
);
16814 #ifdef HAVE_WINDOW_SYSTEM
16815 if (FRAME_WINDOW_P (f
))
16817 #if defined (USE_GTK) || defined (HAVE_NS)
16818 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16819 redisplay_tool_bar (f
);
16821 if (WINDOWP (f
->tool_bar_window
)
16822 && (FRAME_TOOL_BAR_LINES (f
) > 0
16823 || !NILP (Vauto_resize_tool_bars
))
16824 && redisplay_tool_bar (f
))
16825 ignore_mouse_drag_p
= true;
16831 #ifdef HAVE_WINDOW_SYSTEM
16832 if (FRAME_WINDOW_P (f
)
16833 && update_window_fringes (w
, (just_this_one_p
16834 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16835 || w
->pseudo_window_p
)))
16839 if (draw_window_fringes (w
, true))
16841 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16842 x_draw_right_divider (w
);
16844 x_draw_vertical_border (w
);
16850 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16851 x_draw_bottom_divider (w
);
16852 #endif /* HAVE_WINDOW_SYSTEM */
16854 /* We go to this label, with fonts_changed set, if it is
16855 necessary to try again using larger glyph matrices.
16856 We have to redeem the scroll bar even in this case,
16857 because the loop in redisplay_internal expects that. */
16858 need_larger_matrices
:
16860 finish_scroll_bars
:
16862 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16864 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16865 /* Set the thumb's position and size. */
16866 set_vertical_scroll_bar (w
);
16868 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16869 /* Set the thumb's position and size. */
16870 set_horizontal_scroll_bar (w
);
16872 /* Note that we actually used the scroll bar attached to this
16873 window, so it shouldn't be deleted at the end of redisplay. */
16874 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16875 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16878 /* Restore current_buffer and value of point in it. The window
16879 update may have changed the buffer, so first make sure `opoint'
16880 is still valid (Bug#6177). */
16881 if (CHARPOS (opoint
) < BEGV
)
16882 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16883 else if (CHARPOS (opoint
) > ZV
)
16884 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16886 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16888 set_buffer_internal_1 (old
);
16889 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16890 shorter. This can be caused by log truncation in *Messages*. */
16891 if (CHARPOS (lpoint
) <= ZV
)
16892 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16894 unbind_to (count
, Qnil
);
16898 /* Build the complete desired matrix of WINDOW with a window start
16899 buffer position POS.
16901 Value is 1 if successful. It is zero if fonts were loaded during
16902 redisplay which makes re-adjusting glyph matrices necessary, and -1
16903 if point would appear in the scroll margins.
16904 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16905 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16909 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16911 struct window
*w
= XWINDOW (window
);
16913 struct glyph_row
*last_text_row
= NULL
;
16914 struct frame
*f
= XFRAME (w
->frame
);
16915 int frame_line_height
= default_line_pixel_height (w
);
16917 /* Make POS the new window start. */
16918 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16920 /* Mark cursor position as unknown. No overlay arrow seen. */
16921 w
->cursor
.vpos
= -1;
16922 overlay_arrow_seen
= false;
16924 /* Initialize iterator and info to start at POS. */
16925 start_display (&it
, w
, pos
);
16926 it
.glyph_row
->reversed_p
= false;
16928 /* Display all lines of W. */
16929 while (it
.current_y
< it
.last_visible_y
)
16931 if (display_line (&it
))
16932 last_text_row
= it
.glyph_row
- 1;
16933 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16937 /* Don't let the cursor end in the scroll margins. */
16938 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16939 && !MINI_WINDOW_P (w
))
16941 int this_scroll_margin
;
16942 int window_total_lines
16943 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16945 if (scroll_margin
> 0)
16947 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16948 this_scroll_margin
*= frame_line_height
;
16951 this_scroll_margin
= 0;
16953 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16954 && w
->cursor
.y
< this_scroll_margin
16955 && CHARPOS (pos
) > BEGV
16956 && IT_CHARPOS (it
) < ZV
)
16957 /* rms: considering make_cursor_line_fully_visible_p here
16958 seems to give wrong results. We don't want to recenter
16959 when the last line is partly visible, we want to allow
16960 that case to be handled in the usual way. */
16961 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16963 w
->cursor
.vpos
= -1;
16964 clear_glyph_matrix (w
->desired_matrix
);
16969 /* If bottom moved off end of frame, change mode line percentage. */
16970 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16971 w
->update_mode_line
= true;
16973 /* Set window_end_pos to the offset of the last character displayed
16974 on the window from the end of current_buffer. Set
16975 window_end_vpos to its row number. */
16978 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16979 adjust_window_ends (w
, last_text_row
, false);
16981 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16982 w
->window_end_vpos
)));
16986 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16987 w
->window_end_pos
= Z
- ZV
;
16988 w
->window_end_vpos
= 0;
16991 /* But that is not valid info until redisplay finishes. */
16992 w
->window_end_valid
= false;
16998 /************************************************************************
16999 Window redisplay reusing current matrix when buffer has not changed
17000 ************************************************************************/
17002 /* Try redisplay of window W showing an unchanged buffer with a
17003 different window start than the last time it was displayed by
17004 reusing its current matrix. Value is true if successful.
17005 W->start is the new window start. */
17008 try_window_reusing_current_matrix (struct window
*w
)
17010 struct frame
*f
= XFRAME (w
->frame
);
17011 struct glyph_row
*bottom_row
;
17014 struct text_pos start
, new_start
;
17015 int nrows_scrolled
, i
;
17016 struct glyph_row
*last_text_row
;
17017 struct glyph_row
*last_reused_text_row
;
17018 struct glyph_row
*start_row
;
17019 int start_vpos
, min_y
, max_y
;
17022 if (inhibit_try_window_reusing
)
17026 if (/* This function doesn't handle terminal frames. */
17027 !FRAME_WINDOW_P (f
)
17028 /* Don't try to reuse the display if windows have been split
17030 || windows_or_buffers_changed
17031 || f
->cursor_type_changed
)
17034 /* Can't do this if showing trailing whitespace. */
17035 if (!NILP (Vshow_trailing_whitespace
))
17038 /* If top-line visibility has changed, give up. */
17039 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17040 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17043 /* Give up if old or new display is scrolled vertically. We could
17044 make this function handle this, but right now it doesn't. */
17045 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17046 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17049 /* The variable new_start now holds the new window start. The old
17050 start `start' can be determined from the current matrix. */
17051 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17052 start
= start_row
->minpos
;
17053 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17055 /* Clear the desired matrix for the display below. */
17056 clear_glyph_matrix (w
->desired_matrix
);
17058 if (CHARPOS (new_start
) <= CHARPOS (start
))
17060 /* Don't use this method if the display starts with an ellipsis
17061 displayed for invisible text. It's not easy to handle that case
17062 below, and it's certainly not worth the effort since this is
17063 not a frequent case. */
17064 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17067 IF_DEBUG (debug_method_add (w
, "twu1"));
17069 /* Display up to a row that can be reused. The variable
17070 last_text_row is set to the last row displayed that displays
17071 text. Note that it.vpos == 0 if or if not there is a
17072 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17073 start_display (&it
, w
, new_start
);
17074 w
->cursor
.vpos
= -1;
17075 last_text_row
= last_reused_text_row
= NULL
;
17077 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17079 /* If we have reached into the characters in the START row,
17080 that means the line boundaries have changed. So we
17081 can't start copying with the row START. Maybe it will
17082 work to start copying with the following row. */
17083 while (IT_CHARPOS (it
) > CHARPOS (start
))
17085 /* Advance to the next row as the "start". */
17087 start
= start_row
->minpos
;
17088 /* If there are no more rows to try, or just one, give up. */
17089 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17090 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17091 || CHARPOS (start
) == ZV
)
17093 clear_glyph_matrix (w
->desired_matrix
);
17097 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17099 /* If we have reached alignment, we can copy the rest of the
17101 if (IT_CHARPOS (it
) == CHARPOS (start
)
17102 /* Don't accept "alignment" inside a display vector,
17103 since start_row could have started in the middle of
17104 that same display vector (thus their character
17105 positions match), and we have no way of telling if
17106 that is the case. */
17107 && it
.current
.dpvec_index
< 0)
17110 it
.glyph_row
->reversed_p
= false;
17111 if (display_line (&it
))
17112 last_text_row
= it
.glyph_row
- 1;
17116 /* A value of current_y < last_visible_y means that we stopped
17117 at the previous window start, which in turn means that we
17118 have at least one reusable row. */
17119 if (it
.current_y
< it
.last_visible_y
)
17121 struct glyph_row
*row
;
17123 /* IT.vpos always starts from 0; it counts text lines. */
17124 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17126 /* Find PT if not already found in the lines displayed. */
17127 if (w
->cursor
.vpos
< 0)
17129 int dy
= it
.current_y
- start_row
->y
;
17131 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17132 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17134 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17135 dy
, nrows_scrolled
);
17138 clear_glyph_matrix (w
->desired_matrix
);
17143 /* Scroll the display. Do it before the current matrix is
17144 changed. The problem here is that update has not yet
17145 run, i.e. part of the current matrix is not up to date.
17146 scroll_run_hook will clear the cursor, and use the
17147 current matrix to get the height of the row the cursor is
17149 run
.current_y
= start_row
->y
;
17150 run
.desired_y
= it
.current_y
;
17151 run
.height
= it
.last_visible_y
- it
.current_y
;
17153 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17156 FRAME_RIF (f
)->update_window_begin_hook (w
);
17157 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17158 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17159 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17163 /* Shift current matrix down by nrows_scrolled lines. */
17164 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17165 rotate_matrix (w
->current_matrix
,
17167 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17170 /* Disable lines that must be updated. */
17171 for (i
= 0; i
< nrows_scrolled
; ++i
)
17172 (start_row
+ i
)->enabled_p
= false;
17174 /* Re-compute Y positions. */
17175 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17176 max_y
= it
.last_visible_y
;
17177 for (row
= start_row
+ nrows_scrolled
;
17181 row
->y
= it
.current_y
;
17182 row
->visible_height
= row
->height
;
17184 if (row
->y
< min_y
)
17185 row
->visible_height
-= min_y
- row
->y
;
17186 if (row
->y
+ row
->height
> max_y
)
17187 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17188 if (row
->fringe_bitmap_periodic_p
)
17189 row
->redraw_fringe_bitmaps_p
= true;
17191 it
.current_y
+= row
->height
;
17193 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17194 last_reused_text_row
= row
;
17195 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17199 /* Disable lines in the current matrix which are now
17200 below the window. */
17201 for (++row
; row
< bottom_row
; ++row
)
17202 row
->enabled_p
= row
->mode_line_p
= false;
17205 /* Update window_end_pos etc.; last_reused_text_row is the last
17206 reused row from the current matrix containing text, if any.
17207 The value of last_text_row is the last displayed line
17208 containing text. */
17209 if (last_reused_text_row
)
17210 adjust_window_ends (w
, last_reused_text_row
, true);
17211 else if (last_text_row
)
17212 adjust_window_ends (w
, last_text_row
, false);
17215 /* This window must be completely empty. */
17216 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17217 w
->window_end_pos
= Z
- ZV
;
17218 w
->window_end_vpos
= 0;
17220 w
->window_end_valid
= false;
17222 /* Update hint: don't try scrolling again in update_window. */
17223 w
->desired_matrix
->no_scrolling_p
= true;
17226 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17230 else if (CHARPOS (new_start
) > CHARPOS (start
))
17232 struct glyph_row
*pt_row
, *row
;
17233 struct glyph_row
*first_reusable_row
;
17234 struct glyph_row
*first_row_to_display
;
17236 int yb
= window_text_bottom_y (w
);
17238 /* Find the row starting at new_start, if there is one. Don't
17239 reuse a partially visible line at the end. */
17240 first_reusable_row
= start_row
;
17241 while (first_reusable_row
->enabled_p
17242 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17243 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17244 < CHARPOS (new_start
)))
17245 ++first_reusable_row
;
17247 /* Give up if there is no row to reuse. */
17248 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17249 || !first_reusable_row
->enabled_p
17250 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17251 != CHARPOS (new_start
)))
17254 /* We can reuse fully visible rows beginning with
17255 first_reusable_row to the end of the window. Set
17256 first_row_to_display to the first row that cannot be reused.
17257 Set pt_row to the row containing point, if there is any. */
17259 for (first_row_to_display
= first_reusable_row
;
17260 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17261 ++first_row_to_display
)
17263 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17264 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17265 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17266 && first_row_to_display
->ends_at_zv_p
17267 && pt_row
== NULL
)))
17268 pt_row
= first_row_to_display
;
17271 /* Start displaying at the start of first_row_to_display. */
17272 eassert (first_row_to_display
->y
< yb
);
17273 init_to_row_start (&it
, w
, first_row_to_display
);
17275 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17277 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17279 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17280 + WINDOW_HEADER_LINE_HEIGHT (w
));
17282 /* Display lines beginning with first_row_to_display in the
17283 desired matrix. Set last_text_row to the last row displayed
17284 that displays text. */
17285 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17286 if (pt_row
== NULL
)
17287 w
->cursor
.vpos
= -1;
17288 last_text_row
= NULL
;
17289 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17290 if (display_line (&it
))
17291 last_text_row
= it
.glyph_row
- 1;
17293 /* If point is in a reused row, adjust y and vpos of the cursor
17297 w
->cursor
.vpos
-= nrows_scrolled
;
17298 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17301 /* Give up if point isn't in a row displayed or reused. (This
17302 also handles the case where w->cursor.vpos < nrows_scrolled
17303 after the calls to display_line, which can happen with scroll
17304 margins. See bug#1295.) */
17305 if (w
->cursor
.vpos
< 0)
17307 clear_glyph_matrix (w
->desired_matrix
);
17311 /* Scroll the display. */
17312 run
.current_y
= first_reusable_row
->y
;
17313 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17314 run
.height
= it
.last_visible_y
- run
.current_y
;
17315 dy
= run
.current_y
- run
.desired_y
;
17320 FRAME_RIF (f
)->update_window_begin_hook (w
);
17321 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17322 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17323 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17327 /* Adjust Y positions of reused rows. */
17328 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17329 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17330 max_y
= it
.last_visible_y
;
17331 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17334 row
->visible_height
= row
->height
;
17335 if (row
->y
< min_y
)
17336 row
->visible_height
-= min_y
- row
->y
;
17337 if (row
->y
+ row
->height
> max_y
)
17338 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17339 if (row
->fringe_bitmap_periodic_p
)
17340 row
->redraw_fringe_bitmaps_p
= true;
17343 /* Scroll the current matrix. */
17344 eassert (nrows_scrolled
> 0);
17345 rotate_matrix (w
->current_matrix
,
17347 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17350 /* Disable rows not reused. */
17351 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17352 row
->enabled_p
= false;
17354 /* Point may have moved to a different line, so we cannot assume that
17355 the previous cursor position is valid; locate the correct row. */
17358 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17360 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17361 && !row
->ends_at_zv_p
;
17365 w
->cursor
.y
= row
->y
;
17367 if (row
< bottom_row
)
17369 /* Can't simply scan the row for point with
17370 bidi-reordered glyph rows. Let set_cursor_from_row
17371 figure out where to put the cursor, and if it fails,
17373 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17375 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17378 clear_glyph_matrix (w
->desired_matrix
);
17384 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17385 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17388 && (!BUFFERP (glyph
->object
)
17389 || glyph
->charpos
< PT
);
17393 w
->cursor
.x
+= glyph
->pixel_width
;
17399 /* Adjust window end. A null value of last_text_row means that
17400 the window end is in reused rows which in turn means that
17401 only its vpos can have changed. */
17403 adjust_window_ends (w
, last_text_row
, false);
17405 w
->window_end_vpos
-= nrows_scrolled
;
17407 w
->window_end_valid
= false;
17408 w
->desired_matrix
->no_scrolling_p
= true;
17411 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17421 /************************************************************************
17422 Window redisplay reusing current matrix when buffer has changed
17423 ************************************************************************/
17425 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17426 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17427 ptrdiff_t *, ptrdiff_t *);
17428 static struct glyph_row
*
17429 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17430 struct glyph_row
*);
17433 /* Return the last row in MATRIX displaying text. If row START is
17434 non-null, start searching with that row. IT gives the dimensions
17435 of the display. Value is null if matrix is empty; otherwise it is
17436 a pointer to the row found. */
17438 static struct glyph_row
*
17439 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17440 struct glyph_row
*start
)
17442 struct glyph_row
*row
, *row_found
;
17444 /* Set row_found to the last row in IT->w's current matrix
17445 displaying text. The loop looks funny but think of partially
17448 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17449 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17451 eassert (row
->enabled_p
);
17453 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17462 /* Return the last row in the current matrix of W that is not affected
17463 by changes at the start of current_buffer that occurred since W's
17464 current matrix was built. Value is null if no such row exists.
17466 BEG_UNCHANGED us the number of characters unchanged at the start of
17467 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17468 first changed character in current_buffer. Characters at positions <
17469 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17470 when the current matrix was built. */
17472 static struct glyph_row
*
17473 find_last_unchanged_at_beg_row (struct window
*w
)
17475 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17476 struct glyph_row
*row
;
17477 struct glyph_row
*row_found
= NULL
;
17478 int yb
= window_text_bottom_y (w
);
17480 /* Find the last row displaying unchanged text. */
17481 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17482 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17483 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17486 if (/* If row ends before first_changed_pos, it is unchanged,
17487 except in some case. */
17488 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17489 /* When row ends in ZV and we write at ZV it is not
17491 && !row
->ends_at_zv_p
17492 /* When first_changed_pos is the end of a continued line,
17493 row is not unchanged because it may be no longer
17495 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17496 && (row
->continued_p
17497 || row
->exact_window_width_line_p
))
17498 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17499 needs to be recomputed, so don't consider this row as
17500 unchanged. This happens when the last line was
17501 bidi-reordered and was killed immediately before this
17502 redisplay cycle. In that case, ROW->end stores the
17503 buffer position of the first visual-order character of
17504 the killed text, which is now beyond ZV. */
17505 && CHARPOS (row
->end
.pos
) <= ZV
)
17508 /* Stop if last visible row. */
17509 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17517 /* Find the first glyph row in the current matrix of W that is not
17518 affected by changes at the end of current_buffer since the
17519 time W's current matrix was built.
17521 Return in *DELTA the number of chars by which buffer positions in
17522 unchanged text at the end of current_buffer must be adjusted.
17524 Return in *DELTA_BYTES the corresponding number of bytes.
17526 Value is null if no such row exists, i.e. all rows are affected by
17529 static struct glyph_row
*
17530 find_first_unchanged_at_end_row (struct window
*w
,
17531 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17533 struct glyph_row
*row
;
17534 struct glyph_row
*row_found
= NULL
;
17536 *delta
= *delta_bytes
= 0;
17538 /* Display must not have been paused, otherwise the current matrix
17539 is not up to date. */
17540 eassert (w
->window_end_valid
);
17542 /* A value of window_end_pos >= END_UNCHANGED means that the window
17543 end is in the range of changed text. If so, there is no
17544 unchanged row at the end of W's current matrix. */
17545 if (w
->window_end_pos
>= END_UNCHANGED
)
17548 /* Set row to the last row in W's current matrix displaying text. */
17549 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17551 /* If matrix is entirely empty, no unchanged row exists. */
17552 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17554 /* The value of row is the last glyph row in the matrix having a
17555 meaningful buffer position in it. The end position of row
17556 corresponds to window_end_pos. This allows us to translate
17557 buffer positions in the current matrix to current buffer
17558 positions for characters not in changed text. */
17560 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17561 ptrdiff_t Z_BYTE_old
=
17562 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17563 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17564 struct glyph_row
*first_text_row
17565 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17567 *delta
= Z
- Z_old
;
17568 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17570 /* Set last_unchanged_pos to the buffer position of the last
17571 character in the buffer that has not been changed. Z is the
17572 index + 1 of the last character in current_buffer, i.e. by
17573 subtracting END_UNCHANGED we get the index of the last
17574 unchanged character, and we have to add BEG to get its buffer
17576 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17577 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17579 /* Search backward from ROW for a row displaying a line that
17580 starts at a minimum position >= last_unchanged_pos_old. */
17581 for (; row
> first_text_row
; --row
)
17583 /* This used to abort, but it can happen.
17584 It is ok to just stop the search instead here. KFS. */
17585 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17588 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17593 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17599 /* Make sure that glyph rows in the current matrix of window W
17600 reference the same glyph memory as corresponding rows in the
17601 frame's frame matrix. This function is called after scrolling W's
17602 current matrix on a terminal frame in try_window_id and
17603 try_window_reusing_current_matrix. */
17606 sync_frame_with_window_matrix_rows (struct window
*w
)
17608 struct frame
*f
= XFRAME (w
->frame
);
17609 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17611 /* Preconditions: W must be a leaf window and full-width. Its frame
17612 must have a frame matrix. */
17613 eassert (BUFFERP (w
->contents
));
17614 eassert (WINDOW_FULL_WIDTH_P (w
));
17615 eassert (!FRAME_WINDOW_P (f
));
17617 /* If W is a full-width window, glyph pointers in W's current matrix
17618 have, by definition, to be the same as glyph pointers in the
17619 corresponding frame matrix. Note that frame matrices have no
17620 marginal areas (see build_frame_matrix). */
17621 window_row
= w
->current_matrix
->rows
;
17622 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17623 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17624 while (window_row
< window_row_end
)
17626 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17627 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17629 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17630 frame_row
->glyphs
[TEXT_AREA
] = start
;
17631 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17632 frame_row
->glyphs
[LAST_AREA
] = end
;
17634 /* Disable frame rows whose corresponding window rows have
17635 been disabled in try_window_id. */
17636 if (!window_row
->enabled_p
)
17637 frame_row
->enabled_p
= false;
17639 ++window_row
, ++frame_row
;
17644 /* Find the glyph row in window W containing CHARPOS. Consider all
17645 rows between START and END (not inclusive). END null means search
17646 all rows to the end of the display area of W. Value is the row
17647 containing CHARPOS or null. */
17650 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17651 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17653 struct glyph_row
*row
= start
;
17654 struct glyph_row
*best_row
= NULL
;
17655 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17658 /* If we happen to start on a header-line, skip that. */
17659 if (row
->mode_line_p
)
17662 if ((end
&& row
>= end
) || !row
->enabled_p
)
17665 last_y
= window_text_bottom_y (w
) - dy
;
17669 /* Give up if we have gone too far. */
17670 if (end
&& row
>= end
)
17672 /* This formerly returned if they were equal.
17673 I think that both quantities are of a "last plus one" type;
17674 if so, when they are equal, the row is within the screen. -- rms. */
17675 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17678 /* If it is in this row, return this row. */
17679 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17680 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17681 /* The end position of a row equals the start
17682 position of the next row. If CHARPOS is there, we
17683 would rather consider it displayed in the next
17684 line, except when this line ends in ZV. */
17685 && !row_for_charpos_p (row
, charpos
)))
17686 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17690 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17691 || (!best_row
&& !row
->continued_p
))
17693 /* In bidi-reordered rows, there could be several rows whose
17694 edges surround CHARPOS, all of these rows belonging to
17695 the same continued line. We need to find the row which
17696 fits CHARPOS the best. */
17697 for (g
= row
->glyphs
[TEXT_AREA
];
17698 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17701 if (!STRINGP (g
->object
))
17703 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17705 mindif
= eabs (g
->charpos
- charpos
);
17707 /* Exact match always wins. */
17714 else if (best_row
&& !row
->continued_p
)
17721 /* Try to redisplay window W by reusing its existing display. W's
17722 current matrix must be up to date when this function is called,
17723 i.e., window_end_valid must be true.
17727 >= 1 if successful, i.e. display has been updated
17729 1 means the changes were in front of a newline that precedes
17730 the window start, and the whole current matrix was reused
17731 2 means the changes were after the last position displayed
17732 in the window, and the whole current matrix was reused
17733 3 means portions of the current matrix were reused, while
17734 some of the screen lines were redrawn
17735 -1 if redisplay with same window start is known not to succeed
17736 0 if otherwise unsuccessful
17738 The following steps are performed:
17740 1. Find the last row in the current matrix of W that is not
17741 affected by changes at the start of current_buffer. If no such row
17744 2. Find the first row in W's current matrix that is not affected by
17745 changes at the end of current_buffer. Maybe there is no such row.
17747 3. Display lines beginning with the row + 1 found in step 1 to the
17748 row found in step 2 or, if step 2 didn't find a row, to the end of
17751 4. If cursor is not known to appear on the window, give up.
17753 5. If display stopped at the row found in step 2, scroll the
17754 display and current matrix as needed.
17756 6. Maybe display some lines at the end of W, if we must. This can
17757 happen under various circumstances, like a partially visible line
17758 becoming fully visible, or because newly displayed lines are displayed
17759 in smaller font sizes.
17761 7. Update W's window end information. */
17764 try_window_id (struct window
*w
)
17766 struct frame
*f
= XFRAME (w
->frame
);
17767 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17768 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17769 struct glyph_row
*last_unchanged_at_beg_row
;
17770 struct glyph_row
*first_unchanged_at_end_row
;
17771 struct glyph_row
*row
;
17772 struct glyph_row
*bottom_row
;
17775 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17777 struct text_pos start_pos
;
17779 int first_unchanged_at_end_vpos
= 0;
17780 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17781 struct text_pos start
;
17782 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17785 if (inhibit_try_window_id
)
17789 /* This is handy for debugging. */
17791 #define GIVE_UP(X) \
17793 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17797 #define GIVE_UP(X) return 0
17800 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17802 /* Don't use this for mini-windows because these can show
17803 messages and mini-buffers, and we don't handle that here. */
17804 if (MINI_WINDOW_P (w
))
17807 /* This flag is used to prevent redisplay optimizations. */
17808 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17811 /* This function's optimizations cannot be used if overlays have
17812 changed in the buffer displayed by the window, so give up if they
17814 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17817 /* Verify that narrowing has not changed.
17818 Also verify that we were not told to prevent redisplay optimizations.
17819 It would be nice to further
17820 reduce the number of cases where this prevents try_window_id. */
17821 if (current_buffer
->clip_changed
17822 || current_buffer
->prevent_redisplay_optimizations_p
)
17825 /* Window must either use window-based redisplay or be full width. */
17826 if (!FRAME_WINDOW_P (f
)
17827 && (!FRAME_LINE_INS_DEL_OK (f
)
17828 || !WINDOW_FULL_WIDTH_P (w
)))
17831 /* Give up if point is known NOT to appear in W. */
17832 if (PT
< CHARPOS (start
))
17835 /* Another way to prevent redisplay optimizations. */
17836 if (w
->last_modified
== 0)
17839 /* Verify that window is not hscrolled. */
17840 if (w
->hscroll
!= 0)
17843 /* Verify that display wasn't paused. */
17844 if (!w
->window_end_valid
)
17847 /* Likewise if highlighting trailing whitespace. */
17848 if (!NILP (Vshow_trailing_whitespace
))
17851 /* Can't use this if overlay arrow position and/or string have
17853 if (overlay_arrows_changed_p ())
17856 /* When word-wrap is on, adding a space to the first word of a
17857 wrapped line can change the wrap position, altering the line
17858 above it. It might be worthwhile to handle this more
17859 intelligently, but for now just redisplay from scratch. */
17860 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17863 /* Under bidi reordering, adding or deleting a character in the
17864 beginning of a paragraph, before the first strong directional
17865 character, can change the base direction of the paragraph (unless
17866 the buffer specifies a fixed paragraph direction), which will
17867 require to redisplay the whole paragraph. It might be worthwhile
17868 to find the paragraph limits and widen the range of redisplayed
17869 lines to that, but for now just give up this optimization and
17870 redisplay from scratch. */
17871 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17872 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17875 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17876 to that variable require thorough redisplay. */
17877 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17880 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17881 only if buffer has really changed. The reason is that the gap is
17882 initially at Z for freshly visited files. The code below would
17883 set end_unchanged to 0 in that case. */
17884 if (MODIFF
> SAVE_MODIFF
17885 /* This seems to happen sometimes after saving a buffer. */
17886 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17888 if (GPT
- BEG
< BEG_UNCHANGED
)
17889 BEG_UNCHANGED
= GPT
- BEG
;
17890 if (Z
- GPT
< END_UNCHANGED
)
17891 END_UNCHANGED
= Z
- GPT
;
17894 /* The position of the first and last character that has been changed. */
17895 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17896 last_changed_charpos
= Z
- END_UNCHANGED
;
17898 /* If window starts after a line end, and the last change is in
17899 front of that newline, then changes don't affect the display.
17900 This case happens with stealth-fontification. Note that although
17901 the display is unchanged, glyph positions in the matrix have to
17902 be adjusted, of course. */
17903 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17904 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17905 && ((last_changed_charpos
< CHARPOS (start
)
17906 && CHARPOS (start
) == BEGV
)
17907 || (last_changed_charpos
< CHARPOS (start
) - 1
17908 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17910 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17911 struct glyph_row
*r0
;
17913 /* Compute how many chars/bytes have been added to or removed
17914 from the buffer. */
17915 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17916 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17917 Z_delta
= Z
- Z_old
;
17918 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17920 /* Give up if PT is not in the window. Note that it already has
17921 been checked at the start of try_window_id that PT is not in
17922 front of the window start. */
17923 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17926 /* If window start is unchanged, we can reuse the whole matrix
17927 as is, after adjusting glyph positions. No need to compute
17928 the window end again, since its offset from Z hasn't changed. */
17929 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17930 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17931 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17932 /* PT must not be in a partially visible line. */
17933 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17934 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17936 /* Adjust positions in the glyph matrix. */
17937 if (Z_delta
|| Z_delta_bytes
)
17939 struct glyph_row
*r1
17940 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17941 increment_matrix_positions (w
->current_matrix
,
17942 MATRIX_ROW_VPOS (r0
, current_matrix
),
17943 MATRIX_ROW_VPOS (r1
, current_matrix
),
17944 Z_delta
, Z_delta_bytes
);
17947 /* Set the cursor. */
17948 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17950 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17955 /* Handle the case that changes are all below what is displayed in
17956 the window, and that PT is in the window. This shortcut cannot
17957 be taken if ZV is visible in the window, and text has been added
17958 there that is visible in the window. */
17959 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17960 /* ZV is not visible in the window, or there are no
17961 changes at ZV, actually. */
17962 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17963 || first_changed_charpos
== last_changed_charpos
))
17965 struct glyph_row
*r0
;
17967 /* Give up if PT is not in the window. Note that it already has
17968 been checked at the start of try_window_id that PT is not in
17969 front of the window start. */
17970 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17973 /* If window start is unchanged, we can reuse the whole matrix
17974 as is, without changing glyph positions since no text has
17975 been added/removed in front of the window end. */
17976 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17977 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17978 /* PT must not be in a partially visible line. */
17979 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17980 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17982 /* We have to compute the window end anew since text
17983 could have been added/removed after it. */
17984 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17985 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17987 /* Set the cursor. */
17988 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17990 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17995 /* Give up if window start is in the changed area.
17997 The condition used to read
17999 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18001 but why that was tested escapes me at the moment. */
18002 if (CHARPOS (start
) >= first_changed_charpos
18003 && CHARPOS (start
) <= last_changed_charpos
)
18006 /* Check that window start agrees with the start of the first glyph
18007 row in its current matrix. Check this after we know the window
18008 start is not in changed text, otherwise positions would not be
18010 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18011 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18014 /* Give up if the window ends in strings. Overlay strings
18015 at the end are difficult to handle, so don't try. */
18016 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18017 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18020 /* Compute the position at which we have to start displaying new
18021 lines. Some of the lines at the top of the window might be
18022 reusable because they are not displaying changed text. Find the
18023 last row in W's current matrix not affected by changes at the
18024 start of current_buffer. Value is null if changes start in the
18025 first line of window. */
18026 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18027 if (last_unchanged_at_beg_row
)
18029 /* Avoid starting to display in the middle of a character, a TAB
18030 for instance. This is easier than to set up the iterator
18031 exactly, and it's not a frequent case, so the additional
18032 effort wouldn't really pay off. */
18033 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18034 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18035 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18036 --last_unchanged_at_beg_row
;
18038 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18041 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18043 start_pos
= it
.current
.pos
;
18045 /* Start displaying new lines in the desired matrix at the same
18046 vpos we would use in the current matrix, i.e. below
18047 last_unchanged_at_beg_row. */
18048 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18050 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18051 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18053 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18057 /* There are no reusable lines at the start of the window.
18058 Start displaying in the first text line. */
18059 start_display (&it
, w
, start
);
18060 it
.vpos
= it
.first_vpos
;
18061 start_pos
= it
.current
.pos
;
18064 /* Find the first row that is not affected by changes at the end of
18065 the buffer. Value will be null if there is no unchanged row, in
18066 which case we must redisplay to the end of the window. delta
18067 will be set to the value by which buffer positions beginning with
18068 first_unchanged_at_end_row have to be adjusted due to text
18070 first_unchanged_at_end_row
18071 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18072 IF_DEBUG (debug_delta
= delta
);
18073 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18075 /* Set stop_pos to the buffer position up to which we will have to
18076 display new lines. If first_unchanged_at_end_row != NULL, this
18077 is the buffer position of the start of the line displayed in that
18078 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18079 that we don't stop at a buffer position. */
18081 if (first_unchanged_at_end_row
)
18083 eassert (last_unchanged_at_beg_row
== NULL
18084 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18086 /* If this is a continuation line, move forward to the next one
18087 that isn't. Changes in lines above affect this line.
18088 Caution: this may move first_unchanged_at_end_row to a row
18089 not displaying text. */
18090 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18091 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18092 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18093 < it
.last_visible_y
))
18094 ++first_unchanged_at_end_row
;
18096 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18097 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18098 >= it
.last_visible_y
))
18099 first_unchanged_at_end_row
= NULL
;
18102 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18104 first_unchanged_at_end_vpos
18105 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18106 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18109 else if (last_unchanged_at_beg_row
== NULL
)
18115 /* Either there is no unchanged row at the end, or the one we have
18116 now displays text. This is a necessary condition for the window
18117 end pos calculation at the end of this function. */
18118 eassert (first_unchanged_at_end_row
== NULL
18119 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18121 debug_last_unchanged_at_beg_vpos
18122 = (last_unchanged_at_beg_row
18123 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18125 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18127 #endif /* GLYPH_DEBUG */
18130 /* Display new lines. Set last_text_row to the last new line
18131 displayed which has text on it, i.e. might end up as being the
18132 line where the window_end_vpos is. */
18133 w
->cursor
.vpos
= -1;
18134 last_text_row
= NULL
;
18135 overlay_arrow_seen
= false;
18136 if (it
.current_y
< it
.last_visible_y
18137 && !f
->fonts_changed
18138 && (first_unchanged_at_end_row
== NULL
18139 || IT_CHARPOS (it
) < stop_pos
))
18140 it
.glyph_row
->reversed_p
= false;
18141 while (it
.current_y
< it
.last_visible_y
18142 && !f
->fonts_changed
18143 && (first_unchanged_at_end_row
== NULL
18144 || IT_CHARPOS (it
) < stop_pos
))
18146 if (display_line (&it
))
18147 last_text_row
= it
.glyph_row
- 1;
18150 if (f
->fonts_changed
)
18153 /* The redisplay iterations in display_line above could have
18154 triggered font-lock, which could have done something that
18155 invalidates IT->w window's end-point information, on which we
18156 rely below. E.g., one package, which will remain unnamed, used
18157 to install a font-lock-fontify-region-function that called
18158 bury-buffer, whose side effect is to switch the buffer displayed
18159 by IT->w, and that predictably resets IT->w's window_end_valid
18160 flag, which we already tested at the entry to this function.
18161 Amply punish such packages/modes by giving up on this
18162 optimization in those cases. */
18163 if (!w
->window_end_valid
)
18165 clear_glyph_matrix (w
->desired_matrix
);
18169 /* Compute differences in buffer positions, y-positions etc. for
18170 lines reused at the bottom of the window. Compute what we can
18172 if (first_unchanged_at_end_row
18173 /* No lines reused because we displayed everything up to the
18174 bottom of the window. */
18175 && it
.current_y
< it
.last_visible_y
)
18178 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18180 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18181 run
.current_y
= first_unchanged_at_end_row
->y
;
18182 run
.desired_y
= run
.current_y
+ dy
;
18183 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18187 delta
= delta_bytes
= dvpos
= dy
18188 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18189 first_unchanged_at_end_row
= NULL
;
18191 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18194 /* Find the cursor if not already found. We have to decide whether
18195 PT will appear on this window (it sometimes doesn't, but this is
18196 not a very frequent case.) This decision has to be made before
18197 the current matrix is altered. A value of cursor.vpos < 0 means
18198 that PT is either in one of the lines beginning at
18199 first_unchanged_at_end_row or below the window. Don't care for
18200 lines that might be displayed later at the window end; as
18201 mentioned, this is not a frequent case. */
18202 if (w
->cursor
.vpos
< 0)
18204 /* Cursor in unchanged rows at the top? */
18205 if (PT
< CHARPOS (start_pos
)
18206 && last_unchanged_at_beg_row
)
18208 row
= row_containing_pos (w
, PT
,
18209 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18210 last_unchanged_at_beg_row
+ 1, 0);
18212 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18215 /* Start from first_unchanged_at_end_row looking for PT. */
18216 else if (first_unchanged_at_end_row
)
18218 row
= row_containing_pos (w
, PT
- delta
,
18219 first_unchanged_at_end_row
, NULL
, 0);
18221 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18222 delta_bytes
, dy
, dvpos
);
18225 /* Give up if cursor was not found. */
18226 if (w
->cursor
.vpos
< 0)
18228 clear_glyph_matrix (w
->desired_matrix
);
18233 /* Don't let the cursor end in the scroll margins. */
18235 int this_scroll_margin
, cursor_height
;
18236 int frame_line_height
= default_line_pixel_height (w
);
18237 int window_total_lines
18238 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18240 this_scroll_margin
=
18241 max (0, min (scroll_margin
, window_total_lines
/ 4));
18242 this_scroll_margin
*= frame_line_height
;
18243 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18245 if ((w
->cursor
.y
< this_scroll_margin
18246 && CHARPOS (start
) > BEGV
)
18247 /* Old redisplay didn't take scroll margin into account at the bottom,
18248 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18249 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18250 ? cursor_height
+ this_scroll_margin
18251 : 1)) > it
.last_visible_y
)
18253 w
->cursor
.vpos
= -1;
18254 clear_glyph_matrix (w
->desired_matrix
);
18259 /* Scroll the display. Do it before changing the current matrix so
18260 that xterm.c doesn't get confused about where the cursor glyph is
18262 if (dy
&& run
.height
)
18266 if (FRAME_WINDOW_P (f
))
18268 FRAME_RIF (f
)->update_window_begin_hook (w
);
18269 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18270 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18271 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18275 /* Terminal frame. In this case, dvpos gives the number of
18276 lines to scroll by; dvpos < 0 means scroll up. */
18278 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18279 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18280 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18281 + WINDOW_WANTS_HEADER_LINE_P (w
)
18282 + window_internal_height (w
));
18284 #if defined (HAVE_GPM) || defined (MSDOS)
18285 x_clear_window_mouse_face (w
);
18287 /* Perform the operation on the screen. */
18290 /* Scroll last_unchanged_at_beg_row to the end of the
18291 window down dvpos lines. */
18292 set_terminal_window (f
, end
);
18294 /* On dumb terminals delete dvpos lines at the end
18295 before inserting dvpos empty lines. */
18296 if (!FRAME_SCROLL_REGION_OK (f
))
18297 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18299 /* Insert dvpos empty lines in front of
18300 last_unchanged_at_beg_row. */
18301 ins_del_lines (f
, from
, dvpos
);
18303 else if (dvpos
< 0)
18305 /* Scroll up last_unchanged_at_beg_vpos to the end of
18306 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18307 set_terminal_window (f
, end
);
18309 /* Delete dvpos lines in front of
18310 last_unchanged_at_beg_vpos. ins_del_lines will set
18311 the cursor to the given vpos and emit |dvpos| delete
18313 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18315 /* On a dumb terminal insert dvpos empty lines at the
18317 if (!FRAME_SCROLL_REGION_OK (f
))
18318 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18321 set_terminal_window (f
, 0);
18327 /* Shift reused rows of the current matrix to the right position.
18328 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18330 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18331 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18334 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18335 bottom_vpos
, dvpos
);
18336 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18339 else if (dvpos
> 0)
18341 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18342 bottom_vpos
, dvpos
);
18343 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18344 first_unchanged_at_end_vpos
+ dvpos
);
18347 /* For frame-based redisplay, make sure that current frame and window
18348 matrix are in sync with respect to glyph memory. */
18349 if (!FRAME_WINDOW_P (f
))
18350 sync_frame_with_window_matrix_rows (w
);
18352 /* Adjust buffer positions in reused rows. */
18353 if (delta
|| delta_bytes
)
18354 increment_matrix_positions (current_matrix
,
18355 first_unchanged_at_end_vpos
+ dvpos
,
18356 bottom_vpos
, delta
, delta_bytes
);
18358 /* Adjust Y positions. */
18360 shift_glyph_matrix (w
, current_matrix
,
18361 first_unchanged_at_end_vpos
+ dvpos
,
18364 if (first_unchanged_at_end_row
)
18366 first_unchanged_at_end_row
+= dvpos
;
18367 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18368 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18369 first_unchanged_at_end_row
= NULL
;
18372 /* If scrolling up, there may be some lines to display at the end of
18374 last_text_row_at_end
= NULL
;
18377 /* Scrolling up can leave for example a partially visible line
18378 at the end of the window to be redisplayed. */
18379 /* Set last_row to the glyph row in the current matrix where the
18380 window end line is found. It has been moved up or down in
18381 the matrix by dvpos. */
18382 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18383 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18385 /* If last_row is the window end line, it should display text. */
18386 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18388 /* If window end line was partially visible before, begin
18389 displaying at that line. Otherwise begin displaying with the
18390 line following it. */
18391 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18393 init_to_row_start (&it
, w
, last_row
);
18394 it
.vpos
= last_vpos
;
18395 it
.current_y
= last_row
->y
;
18399 init_to_row_end (&it
, w
, last_row
);
18400 it
.vpos
= 1 + last_vpos
;
18401 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18405 /* We may start in a continuation line. If so, we have to
18406 get the right continuation_lines_width and current_x. */
18407 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18408 it
.hpos
= it
.current_x
= 0;
18410 /* Display the rest of the lines at the window end. */
18411 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18412 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18414 /* Is it always sure that the display agrees with lines in
18415 the current matrix? I don't think so, so we mark rows
18416 displayed invalid in the current matrix by setting their
18417 enabled_p flag to false. */
18418 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18419 if (display_line (&it
))
18420 last_text_row_at_end
= it
.glyph_row
- 1;
18424 /* Update window_end_pos and window_end_vpos. */
18425 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18427 /* Window end line if one of the preserved rows from the current
18428 matrix. Set row to the last row displaying text in current
18429 matrix starting at first_unchanged_at_end_row, after
18431 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18432 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18433 first_unchanged_at_end_row
);
18434 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18435 adjust_window_ends (w
, row
, true);
18436 eassert (w
->window_end_bytepos
>= 0);
18437 IF_DEBUG (debug_method_add (w
, "A"));
18439 else if (last_text_row_at_end
)
18441 adjust_window_ends (w
, last_text_row_at_end
, false);
18442 eassert (w
->window_end_bytepos
>= 0);
18443 IF_DEBUG (debug_method_add (w
, "B"));
18445 else if (last_text_row
)
18447 /* We have displayed either to the end of the window or at the
18448 end of the window, i.e. the last row with text is to be found
18449 in the desired matrix. */
18450 adjust_window_ends (w
, last_text_row
, false);
18451 eassert (w
->window_end_bytepos
>= 0);
18453 else if (first_unchanged_at_end_row
== NULL
18454 && last_text_row
== NULL
18455 && last_text_row_at_end
== NULL
)
18457 /* Displayed to end of window, but no line containing text was
18458 displayed. Lines were deleted at the end of the window. */
18459 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18460 int vpos
= w
->window_end_vpos
;
18461 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18462 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18465 row
== NULL
&& vpos
>= first_vpos
;
18466 --vpos
, --current_row
, --desired_row
)
18468 if (desired_row
->enabled_p
)
18470 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18473 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18477 eassert (row
!= NULL
);
18478 w
->window_end_vpos
= vpos
+ 1;
18479 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18480 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18481 eassert (w
->window_end_bytepos
>= 0);
18482 IF_DEBUG (debug_method_add (w
, "C"));
18487 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18488 debug_end_vpos
= w
->window_end_vpos
));
18490 /* Record that display has not been completed. */
18491 w
->window_end_valid
= false;
18492 w
->desired_matrix
->no_scrolling_p
= true;
18500 /***********************************************************************
18501 More debugging support
18502 ***********************************************************************/
18506 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18507 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18508 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18511 /* Dump the contents of glyph matrix MATRIX on stderr.
18513 GLYPHS 0 means don't show glyph contents.
18514 GLYPHS 1 means show glyphs in short form
18515 GLYPHS > 1 means show glyphs in long form. */
18518 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18521 for (i
= 0; i
< matrix
->nrows
; ++i
)
18522 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18526 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18527 the glyph row and area where the glyph comes from. */
18530 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18532 if (glyph
->type
== CHAR_GLYPH
18533 || glyph
->type
== GLYPHLESS_GLYPH
)
18536 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18537 glyph
- row
->glyphs
[TEXT_AREA
],
18538 (glyph
->type
== CHAR_GLYPH
18542 (BUFFERP (glyph
->object
)
18544 : (STRINGP (glyph
->object
)
18546 : (NILP (glyph
->object
)
18549 glyph
->pixel_width
,
18551 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18555 glyph
->left_box_line_p
,
18556 glyph
->right_box_line_p
);
18558 else if (glyph
->type
== STRETCH_GLYPH
)
18561 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18562 glyph
- row
->glyphs
[TEXT_AREA
],
18565 (BUFFERP (glyph
->object
)
18567 : (STRINGP (glyph
->object
)
18569 : (NILP (glyph
->object
)
18572 glyph
->pixel_width
,
18576 glyph
->left_box_line_p
,
18577 glyph
->right_box_line_p
);
18579 else if (glyph
->type
== IMAGE_GLYPH
)
18582 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18583 glyph
- row
->glyphs
[TEXT_AREA
],
18586 (BUFFERP (glyph
->object
)
18588 : (STRINGP (glyph
->object
)
18590 : (NILP (glyph
->object
)
18593 glyph
->pixel_width
,
18597 glyph
->left_box_line_p
,
18598 glyph
->right_box_line_p
);
18600 else if (glyph
->type
== COMPOSITE_GLYPH
)
18603 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18604 glyph
- row
->glyphs
[TEXT_AREA
],
18607 (BUFFERP (glyph
->object
)
18609 : (STRINGP (glyph
->object
)
18611 : (NILP (glyph
->object
)
18614 glyph
->pixel_width
,
18616 if (glyph
->u
.cmp
.automatic
)
18619 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18620 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18622 glyph
->left_box_line_p
,
18623 glyph
->right_box_line_p
);
18628 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18629 GLYPHS 0 means don't show glyph contents.
18630 GLYPHS 1 means show glyphs in short form
18631 GLYPHS > 1 means show glyphs in long form. */
18634 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18638 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18639 fprintf (stderr
, "==============================================================================\n");
18641 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18642 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18644 MATRIX_ROW_START_CHARPOS (row
),
18645 MATRIX_ROW_END_CHARPOS (row
),
18646 row
->used
[TEXT_AREA
],
18647 row
->contains_overlapping_glyphs_p
,
18649 row
->truncated_on_left_p
,
18650 row
->truncated_on_right_p
,
18652 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18653 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18656 row
->ends_in_middle_of_char_p
,
18657 row
->starts_in_middle_of_char_p
,
18663 row
->visible_height
,
18666 /* The next 3 lines should align to "Start" in the header. */
18667 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18668 row
->end
.overlay_string_index
,
18669 row
->continuation_lines_width
);
18670 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18671 CHARPOS (row
->start
.string_pos
),
18672 CHARPOS (row
->end
.string_pos
));
18673 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18674 row
->end
.dpvec_index
);
18681 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18683 struct glyph
*glyph
= row
->glyphs
[area
];
18684 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18686 /* Glyph for a line end in text. */
18687 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18690 if (glyph
< glyph_end
)
18691 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18693 for (; glyph
< glyph_end
; ++glyph
)
18694 dump_glyph (row
, glyph
, area
);
18697 else if (glyphs
== 1)
18700 char s
[SHRT_MAX
+ 4];
18702 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18706 for (i
= 0; i
< row
->used
[area
]; ++i
)
18708 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18709 if (i
== row
->used
[area
] - 1
18710 && area
== TEXT_AREA
18711 && NILP (glyph
->object
)
18712 && glyph
->type
== CHAR_GLYPH
18713 && glyph
->u
.ch
== ' ')
18715 strcpy (&s
[i
], "[\\n]");
18718 else if (glyph
->type
== CHAR_GLYPH
18719 && glyph
->u
.ch
< 0x80
18720 && glyph
->u
.ch
>= ' ')
18721 s
[i
] = glyph
->u
.ch
;
18727 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18733 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18734 Sdump_glyph_matrix
, 0, 1, "p",
18735 doc
: /* Dump the current matrix of the selected window to stderr.
18736 Shows contents of glyph row structures. With non-nil
18737 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18738 glyphs in short form, otherwise show glyphs in long form.
18740 Interactively, no argument means show glyphs in short form;
18741 with numeric argument, its value is passed as the GLYPHS flag. */)
18742 (Lisp_Object glyphs
)
18744 struct window
*w
= XWINDOW (selected_window
);
18745 struct buffer
*buffer
= XBUFFER (w
->contents
);
18747 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18748 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18749 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18750 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18751 fprintf (stderr
, "=============================================\n");
18752 dump_glyph_matrix (w
->current_matrix
,
18753 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18758 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18759 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18760 Only text-mode frames have frame glyph matrices. */)
18763 struct frame
*f
= XFRAME (selected_frame
);
18765 if (f
->current_matrix
)
18766 dump_glyph_matrix (f
->current_matrix
, 1);
18768 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18773 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18774 doc
: /* Dump glyph row ROW to stderr.
18775 GLYPH 0 means don't dump glyphs.
18776 GLYPH 1 means dump glyphs in short form.
18777 GLYPH > 1 or omitted means dump glyphs in long form. */)
18778 (Lisp_Object row
, Lisp_Object glyphs
)
18780 struct glyph_matrix
*matrix
;
18783 CHECK_NUMBER (row
);
18784 matrix
= XWINDOW (selected_window
)->current_matrix
;
18786 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18787 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18789 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18794 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18795 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18796 GLYPH 0 means don't dump glyphs.
18797 GLYPH 1 means dump glyphs in short form.
18798 GLYPH > 1 or omitted means dump glyphs in long form.
18800 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18802 (Lisp_Object row
, Lisp_Object glyphs
)
18804 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18805 struct frame
*sf
= SELECTED_FRAME ();
18806 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18809 CHECK_NUMBER (row
);
18811 if (vpos
>= 0 && vpos
< m
->nrows
)
18812 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18813 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18819 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18820 doc
: /* Toggle tracing of redisplay.
18821 With ARG, turn tracing on if and only if ARG is positive. */)
18825 trace_redisplay_p
= !trace_redisplay_p
;
18828 arg
= Fprefix_numeric_value (arg
);
18829 trace_redisplay_p
= XINT (arg
) > 0;
18836 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18837 doc
: /* Like `format', but print result to stderr.
18838 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18839 (ptrdiff_t nargs
, Lisp_Object
*args
)
18841 Lisp_Object s
= Fformat (nargs
, args
);
18842 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18846 #endif /* GLYPH_DEBUG */
18850 /***********************************************************************
18851 Building Desired Matrix Rows
18852 ***********************************************************************/
18854 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18855 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18857 static struct glyph_row
*
18858 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18860 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18861 struct buffer
*buffer
= XBUFFER (w
->contents
);
18862 struct buffer
*old
= current_buffer
;
18863 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18864 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18865 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18866 const unsigned char *p
;
18869 int n_glyphs_before
;
18871 set_buffer_temp (buffer
);
18872 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18873 scratch_glyph_row
.reversed_p
= false;
18874 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18875 SET_TEXT_POS (it
.position
, 0, 0);
18877 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18879 while (p
< arrow_end
)
18881 Lisp_Object face
, ilisp
;
18883 /* Get the next character. */
18885 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18888 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18889 if (! ASCII_CHAR_P (it
.c
))
18890 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18894 /* Get its face. */
18895 ilisp
= make_number (p
- arrow_string
);
18896 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18897 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18899 /* Compute its width, get its glyphs. */
18900 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18901 SET_TEXT_POS (it
.position
, -1, -1);
18902 PRODUCE_GLYPHS (&it
);
18904 /* If this character doesn't fit any more in the line, we have
18905 to remove some glyphs. */
18906 if (it
.current_x
> it
.last_visible_x
)
18908 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18913 set_buffer_temp (old
);
18914 return it
.glyph_row
;
18918 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18919 glyphs to insert is determined by produce_special_glyphs. */
18922 insert_left_trunc_glyphs (struct it
*it
)
18924 struct it truncate_it
;
18925 struct glyph
*from
, *end
, *to
, *toend
;
18927 eassert (!FRAME_WINDOW_P (it
->f
)
18928 || (!it
->glyph_row
->reversed_p
18929 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18930 || (it
->glyph_row
->reversed_p
18931 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18933 /* Get the truncation glyphs. */
18935 truncate_it
.current_x
= 0;
18936 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18937 truncate_it
.glyph_row
= &scratch_glyph_row
;
18938 truncate_it
.area
= TEXT_AREA
;
18939 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18940 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18941 truncate_it
.object
= Qnil
;
18942 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18944 /* Overwrite glyphs from IT with truncation glyphs. */
18945 if (!it
->glyph_row
->reversed_p
)
18947 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18949 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18950 end
= from
+ tused
;
18951 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18952 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18953 if (FRAME_WINDOW_P (it
->f
))
18955 /* On GUI frames, when variable-size fonts are displayed,
18956 the truncation glyphs may need more pixels than the row's
18957 glyphs they overwrite. We overwrite more glyphs to free
18958 enough screen real estate, and enlarge the stretch glyph
18959 on the right (see display_line), if there is one, to
18960 preserve the screen position of the truncation glyphs on
18963 struct glyph
*g
= to
;
18966 /* The first glyph could be partially visible, in which case
18967 it->glyph_row->x will be negative. But we want the left
18968 truncation glyphs to be aligned at the left margin of the
18969 window, so we override the x coordinate at which the row
18971 it
->glyph_row
->x
= 0;
18972 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18974 w
+= g
->pixel_width
;
18977 if (g
- to
- tused
> 0)
18979 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18980 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18982 used
= it
->glyph_row
->used
[TEXT_AREA
];
18983 if (it
->glyph_row
->truncated_on_right_p
18984 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18985 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18988 int extra
= w
- it
->truncation_pixel_width
;
18990 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18997 /* There may be padding glyphs left over. Overwrite them too. */
18998 if (!FRAME_WINDOW_P (it
->f
))
19000 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19002 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19009 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19013 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19015 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19016 that back to front. */
19017 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19018 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19019 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19020 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19021 if (FRAME_WINDOW_P (it
->f
))
19024 struct glyph
*g
= to
;
19026 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19028 w
+= g
->pixel_width
;
19031 if (to
- g
- tused
> 0)
19033 if (it
->glyph_row
->truncated_on_right_p
19034 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19035 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19037 int extra
= w
- it
->truncation_pixel_width
;
19039 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19043 while (from
>= end
&& to
>= toend
)
19045 if (!FRAME_WINDOW_P (it
->f
))
19047 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19050 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19051 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19052 while (from
>= end
&& to
>= toend
)
19058 /* Need to free some room before prepending additional
19060 int move_by
= from
- end
+ 1;
19061 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19062 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19064 for ( ; g
>= g0
; g
--)
19066 while (from
>= end
)
19068 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19073 /* Compute the hash code for ROW. */
19075 row_hash (struct glyph_row
*row
)
19078 unsigned hashval
= 0;
19080 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19081 for (k
= 0; k
< row
->used
[area
]; ++k
)
19082 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19083 + row
->glyphs
[area
][k
].u
.val
19084 + row
->glyphs
[area
][k
].face_id
19085 + row
->glyphs
[area
][k
].padding_p
19086 + (row
->glyphs
[area
][k
].type
<< 2));
19091 /* Compute the pixel height and width of IT->glyph_row.
19093 Most of the time, ascent and height of a display line will be equal
19094 to the max_ascent and max_height values of the display iterator
19095 structure. This is not the case if
19097 1. We hit ZV without displaying anything. In this case, max_ascent
19098 and max_height will be zero.
19100 2. We have some glyphs that don't contribute to the line height.
19101 (The glyph row flag contributes_to_line_height_p is for future
19102 pixmap extensions).
19104 The first case is easily covered by using default values because in
19105 these cases, the line height does not really matter, except that it
19106 must not be zero. */
19109 compute_line_metrics (struct it
*it
)
19111 struct glyph_row
*row
= it
->glyph_row
;
19113 if (FRAME_WINDOW_P (it
->f
))
19115 int i
, min_y
, max_y
;
19117 /* The line may consist of one space only, that was added to
19118 place the cursor on it. If so, the row's height hasn't been
19120 if (row
->height
== 0)
19122 if (it
->max_ascent
+ it
->max_descent
== 0)
19123 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19124 row
->ascent
= it
->max_ascent
;
19125 row
->height
= it
->max_ascent
+ it
->max_descent
;
19126 row
->phys_ascent
= it
->max_phys_ascent
;
19127 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19128 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19131 /* Compute the width of this line. */
19132 row
->pixel_width
= row
->x
;
19133 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19134 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19136 eassert (row
->pixel_width
>= 0);
19137 eassert (row
->ascent
>= 0 && row
->height
> 0);
19139 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19140 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19142 /* If first line's physical ascent is larger than its logical
19143 ascent, use the physical ascent, and make the row taller.
19144 This makes accented characters fully visible. */
19145 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19146 && row
->phys_ascent
> row
->ascent
)
19148 row
->height
+= row
->phys_ascent
- row
->ascent
;
19149 row
->ascent
= row
->phys_ascent
;
19152 /* Compute how much of the line is visible. */
19153 row
->visible_height
= row
->height
;
19155 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19156 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19158 if (row
->y
< min_y
)
19159 row
->visible_height
-= min_y
- row
->y
;
19160 if (row
->y
+ row
->height
> max_y
)
19161 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19165 row
->pixel_width
= row
->used
[TEXT_AREA
];
19166 if (row
->continued_p
)
19167 row
->pixel_width
-= it
->continuation_pixel_width
;
19168 else if (row
->truncated_on_right_p
)
19169 row
->pixel_width
-= it
->truncation_pixel_width
;
19170 row
->ascent
= row
->phys_ascent
= 0;
19171 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19172 row
->extra_line_spacing
= 0;
19175 /* Compute a hash code for this row. */
19176 row
->hash
= row_hash (row
);
19178 it
->max_ascent
= it
->max_descent
= 0;
19179 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19183 /* Append one space to the glyph row of iterator IT if doing a
19184 window-based redisplay. The space has the same face as
19185 IT->face_id. Value is true if a space was added.
19187 This function is called to make sure that there is always one glyph
19188 at the end of a glyph row that the cursor can be set on under
19189 window-systems. (If there weren't such a glyph we would not know
19190 how wide and tall a box cursor should be displayed).
19192 At the same time this space let's a nicely handle clearing to the
19193 end of the line if the row ends in italic text. */
19196 append_space_for_newline (struct it
*it
, bool default_face_p
)
19198 if (FRAME_WINDOW_P (it
->f
))
19200 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19202 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19203 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19205 /* Save some values that must not be changed.
19206 Must save IT->c and IT->len because otherwise
19207 ITERATOR_AT_END_P wouldn't work anymore after
19208 append_space_for_newline has been called. */
19209 enum display_element_type saved_what
= it
->what
;
19210 int saved_c
= it
->c
, saved_len
= it
->len
;
19211 int saved_char_to_display
= it
->char_to_display
;
19212 int saved_x
= it
->current_x
;
19213 int saved_face_id
= it
->face_id
;
19214 bool saved_box_end
= it
->end_of_box_run_p
;
19215 struct text_pos saved_pos
;
19216 Lisp_Object saved_object
;
19220 saved_object
= it
->object
;
19221 saved_pos
= it
->position
;
19223 it
->what
= IT_CHARACTER
;
19224 memset (&it
->position
, 0, sizeof it
->position
);
19226 it
->c
= it
->char_to_display
= ' ';
19229 /* If the default face was remapped, be sure to use the
19230 remapped face for the appended newline. */
19231 if (default_face_p
)
19232 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19233 else if (it
->face_before_selective_p
)
19234 it
->face_id
= it
->saved_face_id
;
19235 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19236 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19237 /* In R2L rows, we will prepend a stretch glyph that will
19238 have the end_of_box_run_p flag set for it, so there's no
19239 need for the appended newline glyph to have that flag
19241 if (it
->glyph_row
->reversed_p
19242 /* But if the appended newline glyph goes all the way to
19243 the end of the row, there will be no stretch glyph,
19244 so leave the box flag set. */
19245 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19246 it
->end_of_box_run_p
= false;
19248 PRODUCE_GLYPHS (it
);
19250 #ifdef HAVE_WINDOW_SYSTEM
19251 /* Make sure this space glyph has the right ascent and
19252 descent values, or else cursor at end of line will look
19253 funny, and height of empty lines will be incorrect. */
19254 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19255 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19258 Lisp_Object height
, total_height
;
19259 int extra_line_spacing
= it
->extra_line_spacing
;
19260 int boff
= font
->baseline_offset
;
19262 if (font
->vertical_centering
)
19263 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19265 it
->object
= saved_object
; /* get_it_property needs this */
19266 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19267 /* Must do a subset of line height processing from
19268 x_produce_glyph for newline characters. */
19269 height
= get_it_property (it
, Qline_height
);
19271 && CONSP (XCDR (height
))
19272 && NILP (XCDR (XCDR (height
))))
19274 total_height
= XCAR (XCDR (height
));
19275 height
= XCAR (height
);
19278 total_height
= Qnil
;
19279 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19281 if (it
->override_ascent
>= 0)
19283 it
->ascent
= it
->override_ascent
;
19284 it
->descent
= it
->override_descent
;
19285 boff
= it
->override_boff
;
19287 if (EQ (height
, Qt
))
19288 extra_line_spacing
= 0;
19291 Lisp_Object spacing
;
19293 it
->phys_ascent
= it
->ascent
;
19294 it
->phys_descent
= it
->descent
;
19296 && XINT (height
) > it
->ascent
+ it
->descent
)
19297 it
->ascent
= XINT (height
) - it
->descent
;
19299 if (!NILP (total_height
))
19300 spacing
= calc_line_height_property (it
, total_height
, font
,
19304 spacing
= get_it_property (it
, Qline_spacing
);
19305 spacing
= calc_line_height_property (it
, spacing
, font
,
19308 if (INTEGERP (spacing
))
19310 extra_line_spacing
= XINT (spacing
);
19311 if (!NILP (total_height
))
19312 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19315 if (extra_line_spacing
> 0)
19317 it
->descent
+= extra_line_spacing
;
19318 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19319 it
->max_extra_line_spacing
= extra_line_spacing
;
19321 it
->max_ascent
= it
->ascent
;
19322 it
->max_descent
= it
->descent
;
19323 /* Make sure compute_line_metrics recomputes the row height. */
19324 it
->glyph_row
->height
= 0;
19327 g
->ascent
= it
->max_ascent
;
19328 g
->descent
= it
->max_descent
;
19331 it
->override_ascent
= -1;
19332 it
->constrain_row_ascent_descent_p
= false;
19333 it
->current_x
= saved_x
;
19334 it
->object
= saved_object
;
19335 it
->position
= saved_pos
;
19336 it
->what
= saved_what
;
19337 it
->face_id
= saved_face_id
;
19338 it
->len
= saved_len
;
19340 it
->char_to_display
= saved_char_to_display
;
19341 it
->end_of_box_run_p
= saved_box_end
;
19350 /* Extend the face of the last glyph in the text area of IT->glyph_row
19351 to the end of the display line. Called from display_line. If the
19352 glyph row is empty, add a space glyph to it so that we know the
19353 face to draw. Set the glyph row flag fill_line_p. If the glyph
19354 row is R2L, prepend a stretch glyph to cover the empty space to the
19355 left of the leftmost glyph. */
19358 extend_face_to_end_of_line (struct it
*it
)
19360 struct face
*face
, *default_face
;
19361 struct frame
*f
= it
->f
;
19363 /* If line is already filled, do nothing. Non window-system frames
19364 get a grace of one more ``pixel'' because their characters are
19365 1-``pixel'' wide, so they hit the equality too early. This grace
19366 is needed only for R2L rows that are not continued, to produce
19367 one extra blank where we could display the cursor. */
19368 if ((it
->current_x
>= it
->last_visible_x
19369 + (!FRAME_WINDOW_P (f
)
19370 && it
->glyph_row
->reversed_p
19371 && !it
->glyph_row
->continued_p
))
19372 /* If the window has display margins, we will need to extend
19373 their face even if the text area is filled. */
19374 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19375 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19378 /* The default face, possibly remapped. */
19379 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19381 /* Face extension extends the background and box of IT->face_id
19382 to the end of the line. If the background equals the background
19383 of the frame, we don't have to do anything. */
19384 if (it
->face_before_selective_p
)
19385 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19387 face
= FACE_FROM_ID (f
, it
->face_id
);
19389 if (FRAME_WINDOW_P (f
)
19390 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19391 && face
->box
== FACE_NO_BOX
19392 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19393 #ifdef HAVE_WINDOW_SYSTEM
19396 && !it
->glyph_row
->reversed_p
)
19399 /* Set the glyph row flag indicating that the face of the last glyph
19400 in the text area has to be drawn to the end of the text area. */
19401 it
->glyph_row
->fill_line_p
= true;
19403 /* If current character of IT is not ASCII, make sure we have the
19404 ASCII face. This will be automatically undone the next time
19405 get_next_display_element returns a multibyte character. Note
19406 that the character will always be single byte in unibyte
19408 if (!ASCII_CHAR_P (it
->c
))
19410 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19413 if (FRAME_WINDOW_P (f
))
19415 /* If the row is empty, add a space with the current face of IT,
19416 so that we know which face to draw. */
19417 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19419 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19420 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19421 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19423 /* Mode line and the header line don't have margins, and
19424 likewise the frame's tool-bar window, if there is any. */
19425 if (!(it
->glyph_row
->mode_line_p
19426 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19427 || (WINDOWP (f
->tool_bar_window
)
19428 && it
->w
== XWINDOW (f
->tool_bar_window
))
19432 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19433 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19435 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19436 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19438 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19440 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19441 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19443 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19444 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19446 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19449 #ifdef HAVE_WINDOW_SYSTEM
19450 if (it
->glyph_row
->reversed_p
)
19452 /* Prepend a stretch glyph to the row, such that the
19453 rightmost glyph will be drawn flushed all the way to the
19454 right margin of the window. The stretch glyph that will
19455 occupy the empty space, if any, to the left of the
19457 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19458 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19459 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19461 int row_width
, stretch_ascent
, stretch_width
;
19462 struct text_pos saved_pos
;
19464 bool saved_avoid_cursor
, saved_box_start
;
19466 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19467 row_width
+= g
->pixel_width
;
19469 /* FIXME: There are various minor display glitches in R2L
19470 rows when only one of the fringes is missing. The
19471 strange condition below produces the least bad effect. */
19472 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19473 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19474 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19475 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19477 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19478 stretch_width
-= row_width
;
19480 if (stretch_width
> 0)
19483 (((it
->ascent
+ it
->descent
)
19484 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19485 saved_pos
= it
->position
;
19486 memset (&it
->position
, 0, sizeof it
->position
);
19487 saved_avoid_cursor
= it
->avoid_cursor_p
;
19488 it
->avoid_cursor_p
= true;
19489 saved_face_id
= it
->face_id
;
19490 saved_box_start
= it
->start_of_box_run_p
;
19491 /* The last row's stretch glyph should get the default
19492 face, to avoid painting the rest of the window with
19493 the region face, if the region ends at ZV. */
19494 if (it
->glyph_row
->ends_at_zv_p
)
19495 it
->face_id
= default_face
->id
;
19497 it
->face_id
= face
->id
;
19498 it
->start_of_box_run_p
= false;
19499 append_stretch_glyph (it
, Qnil
, stretch_width
,
19500 it
->ascent
+ it
->descent
, stretch_ascent
);
19501 it
->position
= saved_pos
;
19502 it
->avoid_cursor_p
= saved_avoid_cursor
;
19503 it
->face_id
= saved_face_id
;
19504 it
->start_of_box_run_p
= saved_box_start
;
19506 /* If stretch_width comes out negative, it means that the
19507 last glyph is only partially visible. In R2L rows, we
19508 want the leftmost glyph to be partially visible, so we
19509 need to give the row the corresponding left offset. */
19510 if (stretch_width
< 0)
19511 it
->glyph_row
->x
= stretch_width
;
19513 #endif /* HAVE_WINDOW_SYSTEM */
19517 /* Save some values that must not be changed. */
19518 int saved_x
= it
->current_x
;
19519 struct text_pos saved_pos
;
19520 Lisp_Object saved_object
;
19521 enum display_element_type saved_what
= it
->what
;
19522 int saved_face_id
= it
->face_id
;
19524 saved_object
= it
->object
;
19525 saved_pos
= it
->position
;
19527 it
->what
= IT_CHARACTER
;
19528 memset (&it
->position
, 0, sizeof it
->position
);
19530 it
->c
= it
->char_to_display
= ' ';
19533 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19534 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19535 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19536 && !it
->glyph_row
->mode_line_p
19537 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19539 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19540 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19542 for (it
->current_x
= 0; g
< e
; g
++)
19543 it
->current_x
+= g
->pixel_width
;
19545 it
->area
= LEFT_MARGIN_AREA
;
19546 it
->face_id
= default_face
->id
;
19547 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19548 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19550 PRODUCE_GLYPHS (it
);
19551 /* term.c:produce_glyphs advances it->current_x only for
19553 it
->current_x
+= it
->pixel_width
;
19556 it
->current_x
= saved_x
;
19557 it
->area
= TEXT_AREA
;
19560 /* The last row's blank glyphs should get the default face, to
19561 avoid painting the rest of the window with the region face,
19562 if the region ends at ZV. */
19563 if (it
->glyph_row
->ends_at_zv_p
)
19564 it
->face_id
= default_face
->id
;
19566 it
->face_id
= face
->id
;
19567 PRODUCE_GLYPHS (it
);
19569 while (it
->current_x
<= it
->last_visible_x
)
19570 PRODUCE_GLYPHS (it
);
19572 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19573 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19574 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19575 && !it
->glyph_row
->mode_line_p
19576 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19578 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19579 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19581 for ( ; g
< e
; g
++)
19582 it
->current_x
+= g
->pixel_width
;
19584 it
->area
= RIGHT_MARGIN_AREA
;
19585 it
->face_id
= default_face
->id
;
19586 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19587 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19589 PRODUCE_GLYPHS (it
);
19590 it
->current_x
+= it
->pixel_width
;
19593 it
->area
= TEXT_AREA
;
19596 /* Don't count these blanks really. It would let us insert a left
19597 truncation glyph below and make us set the cursor on them, maybe. */
19598 it
->current_x
= saved_x
;
19599 it
->object
= saved_object
;
19600 it
->position
= saved_pos
;
19601 it
->what
= saved_what
;
19602 it
->face_id
= saved_face_id
;
19607 /* Value is true if text starting at CHARPOS in current_buffer is
19608 trailing whitespace. */
19611 trailing_whitespace_p (ptrdiff_t charpos
)
19613 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19616 while (bytepos
< ZV_BYTE
19617 && (c
= FETCH_CHAR (bytepos
),
19618 c
== ' ' || c
== '\t'))
19621 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19623 if (bytepos
!= PT_BYTE
)
19630 /* Highlight trailing whitespace, if any, in ROW. */
19633 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19635 int used
= row
->used
[TEXT_AREA
];
19639 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19640 struct glyph
*glyph
= start
+ used
- 1;
19642 if (row
->reversed_p
)
19644 /* Right-to-left rows need to be processed in the opposite
19645 direction, so swap the edge pointers. */
19647 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19650 /* Skip over glyphs inserted to display the cursor at the
19651 end of a line, for extending the face of the last glyph
19652 to the end of the line on terminals, and for truncation
19653 and continuation glyphs. */
19654 if (!row
->reversed_p
)
19656 while (glyph
>= start
19657 && glyph
->type
== CHAR_GLYPH
19658 && NILP (glyph
->object
))
19663 while (glyph
<= start
19664 && glyph
->type
== CHAR_GLYPH
19665 && NILP (glyph
->object
))
19669 /* If last glyph is a space or stretch, and it's trailing
19670 whitespace, set the face of all trailing whitespace glyphs in
19671 IT->glyph_row to `trailing-whitespace'. */
19672 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19673 && BUFFERP (glyph
->object
)
19674 && (glyph
->type
== STRETCH_GLYPH
19675 || (glyph
->type
== CHAR_GLYPH
19676 && glyph
->u
.ch
== ' '))
19677 && trailing_whitespace_p (glyph
->charpos
))
19679 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19683 if (!row
->reversed_p
)
19685 while (glyph
>= start
19686 && BUFFERP (glyph
->object
)
19687 && (glyph
->type
== STRETCH_GLYPH
19688 || (glyph
->type
== CHAR_GLYPH
19689 && glyph
->u
.ch
== ' ')))
19690 (glyph
--)->face_id
= face_id
;
19694 while (glyph
<= start
19695 && BUFFERP (glyph
->object
)
19696 && (glyph
->type
== STRETCH_GLYPH
19697 || (glyph
->type
== CHAR_GLYPH
19698 && glyph
->u
.ch
== ' ')))
19699 (glyph
++)->face_id
= face_id
;
19706 /* Value is true if glyph row ROW should be
19707 considered to hold the buffer position CHARPOS. */
19710 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19712 bool result
= true;
19714 if (charpos
== CHARPOS (row
->end
.pos
)
19715 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19717 /* Suppose the row ends on a string.
19718 Unless the row is continued, that means it ends on a newline
19719 in the string. If it's anything other than a display string
19720 (e.g., a before-string from an overlay), we don't want the
19721 cursor there. (This heuristic seems to give the optimal
19722 behavior for the various types of multi-line strings.)
19723 One exception: if the string has `cursor' property on one of
19724 its characters, we _do_ want the cursor there. */
19725 if (CHARPOS (row
->end
.string_pos
) >= 0)
19727 if (row
->continued_p
)
19731 /* Check for `display' property. */
19732 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19733 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19734 struct glyph
*glyph
;
19737 for (glyph
= end
; glyph
>= beg
; --glyph
)
19738 if (STRINGP (glyph
->object
))
19741 = Fget_char_property (make_number (charpos
),
19745 && display_prop_string_p (prop
, glyph
->object
));
19746 /* If there's a `cursor' property on one of the
19747 string's characters, this row is a cursor row,
19748 even though this is not a display string. */
19751 Lisp_Object s
= glyph
->object
;
19753 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19755 ptrdiff_t gpos
= glyph
->charpos
;
19757 if (!NILP (Fget_char_property (make_number (gpos
),
19769 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19771 /* If the row ends in middle of a real character,
19772 and the line is continued, we want the cursor here.
19773 That's because CHARPOS (ROW->end.pos) would equal
19774 PT if PT is before the character. */
19775 if (!row
->ends_in_ellipsis_p
)
19776 result
= row
->continued_p
;
19778 /* If the row ends in an ellipsis, then
19779 CHARPOS (ROW->end.pos) will equal point after the
19780 invisible text. We want that position to be displayed
19781 after the ellipsis. */
19784 /* If the row ends at ZV, display the cursor at the end of that
19785 row instead of at the start of the row below. */
19787 result
= row
->ends_at_zv_p
;
19793 /* Value is true if glyph row ROW should be
19794 used to hold the cursor. */
19797 cursor_row_p (struct glyph_row
*row
)
19799 return row_for_charpos_p (row
, PT
);
19804 /* Push the property PROP so that it will be rendered at the current
19805 position in IT. Return true if PROP was successfully pushed, false
19806 otherwise. Called from handle_line_prefix to handle the
19807 `line-prefix' and `wrap-prefix' properties. */
19810 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19812 struct text_pos pos
=
19813 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19815 eassert (it
->method
== GET_FROM_BUFFER
19816 || it
->method
== GET_FROM_DISPLAY_VECTOR
19817 || it
->method
== GET_FROM_STRING
);
19819 /* We need to save the current buffer/string position, so it will be
19820 restored by pop_it, because iterate_out_of_display_property
19821 depends on that being set correctly, but some situations leave
19822 it->position not yet set when this function is called. */
19823 push_it (it
, &pos
);
19825 if (STRINGP (prop
))
19827 if (SCHARS (prop
) == 0)
19834 it
->string_from_prefix_prop_p
= true;
19835 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19836 it
->current
.overlay_string_index
= -1;
19837 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19838 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19839 it
->method
= GET_FROM_STRING
;
19840 it
->stop_charpos
= 0;
19842 it
->base_level_stop
= 0;
19844 /* Force paragraph direction to be that of the parent
19846 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19847 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19849 it
->paragraph_embedding
= L2R
;
19851 /* Set up the bidi iterator for this display string. */
19854 it
->bidi_it
.string
.lstring
= it
->string
;
19855 it
->bidi_it
.string
.s
= NULL
;
19856 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19857 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19858 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19859 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19860 it
->bidi_it
.w
= it
->w
;
19861 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19864 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19866 it
->method
= GET_FROM_STRETCH
;
19869 #ifdef HAVE_WINDOW_SYSTEM
19870 else if (IMAGEP (prop
))
19872 it
->what
= IT_IMAGE
;
19873 it
->image_id
= lookup_image (it
->f
, prop
);
19874 it
->method
= GET_FROM_IMAGE
;
19876 #endif /* HAVE_WINDOW_SYSTEM */
19879 pop_it (it
); /* bogus display property, give up */
19886 /* Return the character-property PROP at the current position in IT. */
19889 get_it_property (struct it
*it
, Lisp_Object prop
)
19891 Lisp_Object position
, object
= it
->object
;
19893 if (STRINGP (object
))
19894 position
= make_number (IT_STRING_CHARPOS (*it
));
19895 else if (BUFFERP (object
))
19897 position
= make_number (IT_CHARPOS (*it
));
19898 object
= it
->window
;
19903 return Fget_char_property (position
, prop
, object
);
19906 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19909 handle_line_prefix (struct it
*it
)
19911 Lisp_Object prefix
;
19913 if (it
->continuation_lines_width
> 0)
19915 prefix
= get_it_property (it
, Qwrap_prefix
);
19917 prefix
= Vwrap_prefix
;
19921 prefix
= get_it_property (it
, Qline_prefix
);
19923 prefix
= Vline_prefix
;
19925 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19927 /* If the prefix is wider than the window, and we try to wrap
19928 it, it would acquire its own wrap prefix, and so on till the
19929 iterator stack overflows. So, don't wrap the prefix. */
19930 it
->line_wrap
= TRUNCATE
;
19931 it
->avoid_cursor_p
= true;
19937 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19938 only for R2L lines from display_line and display_string, when they
19939 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19940 the line/string needs to be continued on the next glyph row. */
19942 unproduce_glyphs (struct it
*it
, int n
)
19944 struct glyph
*glyph
, *end
;
19946 eassert (it
->glyph_row
);
19947 eassert (it
->glyph_row
->reversed_p
);
19948 eassert (it
->area
== TEXT_AREA
);
19949 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19951 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19952 n
= it
->glyph_row
->used
[TEXT_AREA
];
19953 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19954 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19955 for ( ; glyph
< end
; glyph
++)
19956 glyph
[-n
] = *glyph
;
19959 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19960 and ROW->maxpos. */
19962 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19963 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19964 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19966 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19967 lines' rows is implemented for bidi-reordered rows. */
19969 /* ROW->minpos is the value of min_pos, the minimal buffer position
19970 we have in ROW, or ROW->start.pos if that is smaller. */
19971 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19972 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19974 /* We didn't find buffer positions smaller than ROW->start, or
19975 didn't find _any_ valid buffer positions in any of the glyphs,
19976 so we must trust the iterator's computed positions. */
19977 row
->minpos
= row
->start
.pos
;
19980 max_pos
= CHARPOS (it
->current
.pos
);
19981 max_bpos
= BYTEPOS (it
->current
.pos
);
19984 /* Here are the various use-cases for ending the row, and the
19985 corresponding values for ROW->maxpos:
19987 Line ends in a newline from buffer eol_pos + 1
19988 Line is continued from buffer max_pos + 1
19989 Line is truncated on right it->current.pos
19990 Line ends in a newline from string max_pos + 1(*)
19991 (*) + 1 only when line ends in a forward scan
19992 Line is continued from string max_pos
19993 Line is continued from display vector max_pos
19994 Line is entirely from a string min_pos == max_pos
19995 Line is entirely from a display vector min_pos == max_pos
19996 Line that ends at ZV ZV
19998 If you discover other use-cases, please add them here as
20000 if (row
->ends_at_zv_p
)
20001 row
->maxpos
= it
->current
.pos
;
20002 else if (row
->used
[TEXT_AREA
])
20004 bool seen_this_string
= false;
20005 struct glyph_row
*r1
= row
- 1;
20007 /* Did we see the same display string on the previous row? */
20008 if (STRINGP (it
->object
)
20009 /* this is not the first row */
20010 && row
> it
->w
->desired_matrix
->rows
20011 /* previous row is not the header line */
20012 && !r1
->mode_line_p
20013 /* previous row also ends in a newline from a string */
20014 && r1
->ends_in_newline_from_string_p
)
20016 struct glyph
*start
, *end
;
20018 /* Search for the last glyph of the previous row that came
20019 from buffer or string. Depending on whether the row is
20020 L2R or R2L, we need to process it front to back or the
20021 other way round. */
20022 if (!r1
->reversed_p
)
20024 start
= r1
->glyphs
[TEXT_AREA
];
20025 end
= start
+ r1
->used
[TEXT_AREA
];
20026 /* Glyphs inserted by redisplay have nil as their object. */
20028 && NILP ((end
- 1)->object
)
20029 && (end
- 1)->charpos
<= 0)
20033 if (EQ ((end
- 1)->object
, it
->object
))
20034 seen_this_string
= true;
20037 /* If all the glyphs of the previous row were inserted
20038 by redisplay, it means the previous row was
20039 produced from a single newline, which is only
20040 possible if that newline came from the same string
20041 as the one which produced this ROW. */
20042 seen_this_string
= true;
20046 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20047 start
= end
+ r1
->used
[TEXT_AREA
];
20049 && NILP ((end
+ 1)->object
)
20050 && (end
+ 1)->charpos
<= 0)
20054 if (EQ ((end
+ 1)->object
, it
->object
))
20055 seen_this_string
= true;
20058 seen_this_string
= true;
20061 /* Take note of each display string that covers a newline only
20062 once, the first time we see it. This is for when a display
20063 string includes more than one newline in it. */
20064 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20066 /* If we were scanning the buffer forward when we displayed
20067 the string, we want to account for at least one buffer
20068 position that belongs to this row (position covered by
20069 the display string), so that cursor positioning will
20070 consider this row as a candidate when point is at the end
20071 of the visual line represented by this row. This is not
20072 required when scanning back, because max_pos will already
20073 have a much larger value. */
20074 if (CHARPOS (row
->end
.pos
) > max_pos
)
20075 INC_BOTH (max_pos
, max_bpos
);
20076 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20078 else if (CHARPOS (it
->eol_pos
) > 0)
20079 SET_TEXT_POS (row
->maxpos
,
20080 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20081 else if (row
->continued_p
)
20083 /* If max_pos is different from IT's current position, it
20084 means IT->method does not belong to the display element
20085 at max_pos. However, it also means that the display
20086 element at max_pos was displayed in its entirety on this
20087 line, which is equivalent to saying that the next line
20088 starts at the next buffer position. */
20089 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20090 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20093 INC_BOTH (max_pos
, max_bpos
);
20094 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20097 else if (row
->truncated_on_right_p
)
20098 /* display_line already called reseat_at_next_visible_line_start,
20099 which puts the iterator at the beginning of the next line, in
20100 the logical order. */
20101 row
->maxpos
= it
->current
.pos
;
20102 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20103 /* A line that is entirely from a string/image/stretch... */
20104 row
->maxpos
= row
->minpos
;
20109 row
->maxpos
= it
->current
.pos
;
20112 /* Construct the glyph row IT->glyph_row in the desired matrix of
20113 IT->w from text at the current position of IT. See dispextern.h
20114 for an overview of struct it. Value is true if
20115 IT->glyph_row displays text, as opposed to a line displaying ZV
20119 display_line (struct it
*it
)
20121 struct glyph_row
*row
= it
->glyph_row
;
20122 Lisp_Object overlay_arrow_string
;
20124 void *wrap_data
= NULL
;
20125 bool may_wrap
= false;
20126 int wrap_x
IF_LINT (= 0);
20127 int wrap_row_used
= -1;
20128 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20129 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20130 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20131 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20132 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20134 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20135 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20136 bool pending_handle_line_prefix
= false;
20138 /* We always start displaying at hpos zero even if hscrolled. */
20139 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20141 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20142 >= it
->w
->desired_matrix
->nrows
)
20144 it
->w
->nrows_scale_factor
++;
20145 it
->f
->fonts_changed
= true;
20149 /* Clear the result glyph row and enable it. */
20150 prepare_desired_row (it
->w
, row
, false);
20152 row
->y
= it
->current_y
;
20153 row
->start
= it
->start
;
20154 row
->continuation_lines_width
= it
->continuation_lines_width
;
20155 row
->displays_text_p
= true;
20156 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20157 it
->starts_in_middle_of_char_p
= false;
20159 /* Arrange the overlays nicely for our purposes. Usually, we call
20160 display_line on only one line at a time, in which case this
20161 can't really hurt too much, or we call it on lines which appear
20162 one after another in the buffer, in which case all calls to
20163 recenter_overlay_lists but the first will be pretty cheap. */
20164 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20166 /* Move over display elements that are not visible because we are
20167 hscrolled. This may stop at an x-position < IT->first_visible_x
20168 if the first glyph is partially visible or if we hit a line end. */
20169 if (it
->current_x
< it
->first_visible_x
)
20171 enum move_it_result move_result
;
20173 this_line_min_pos
= row
->start
.pos
;
20174 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20175 MOVE_TO_POS
| MOVE_TO_X
);
20176 /* If we are under a large hscroll, move_it_in_display_line_to
20177 could hit the end of the line without reaching
20178 it->first_visible_x. Pretend that we did reach it. This is
20179 especially important on a TTY, where we will call
20180 extend_face_to_end_of_line, which needs to know how many
20181 blank glyphs to produce. */
20182 if (it
->current_x
< it
->first_visible_x
20183 && (move_result
== MOVE_NEWLINE_OR_CR
20184 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20185 it
->current_x
= it
->first_visible_x
;
20187 /* Record the smallest positions seen while we moved over
20188 display elements that are not visible. This is needed by
20189 redisplay_internal for optimizing the case where the cursor
20190 stays inside the same line. The rest of this function only
20191 considers positions that are actually displayed, so
20192 RECORD_MAX_MIN_POS will not otherwise record positions that
20193 are hscrolled to the left of the left edge of the window. */
20194 min_pos
= CHARPOS (this_line_min_pos
);
20195 min_bpos
= BYTEPOS (this_line_min_pos
);
20197 else if (it
->area
== TEXT_AREA
)
20199 /* We only do this when not calling move_it_in_display_line_to
20200 above, because that function calls itself handle_line_prefix. */
20201 handle_line_prefix (it
);
20205 /* Line-prefix and wrap-prefix are always displayed in the text
20206 area. But if this is the first call to display_line after
20207 init_iterator, the iterator might have been set up to write
20208 into a marginal area, e.g. if the line begins with some
20209 display property that writes to the margins. So we need to
20210 wait with the call to handle_line_prefix until whatever
20211 writes to the margin has done its job. */
20212 pending_handle_line_prefix
= true;
20215 /* Get the initial row height. This is either the height of the
20216 text hscrolled, if there is any, or zero. */
20217 row
->ascent
= it
->max_ascent
;
20218 row
->height
= it
->max_ascent
+ it
->max_descent
;
20219 row
->phys_ascent
= it
->max_phys_ascent
;
20220 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20221 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20223 /* Utility macro to record max and min buffer positions seen until now. */
20224 #define RECORD_MAX_MIN_POS(IT) \
20227 bool composition_p \
20228 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20229 ptrdiff_t current_pos = \
20230 composition_p ? (IT)->cmp_it.charpos \
20231 : IT_CHARPOS (*(IT)); \
20232 ptrdiff_t current_bpos = \
20233 composition_p ? CHAR_TO_BYTE (current_pos) \
20234 : IT_BYTEPOS (*(IT)); \
20235 if (current_pos < min_pos) \
20237 min_pos = current_pos; \
20238 min_bpos = current_bpos; \
20240 if (IT_CHARPOS (*it) > max_pos) \
20242 max_pos = IT_CHARPOS (*it); \
20243 max_bpos = IT_BYTEPOS (*it); \
20248 /* Loop generating characters. The loop is left with IT on the next
20249 character to display. */
20252 int n_glyphs_before
, hpos_before
, x_before
;
20254 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20256 /* Retrieve the next thing to display. Value is false if end of
20258 if (!get_next_display_element (it
))
20260 /* Maybe add a space at the end of this line that is used to
20261 display the cursor there under X. Set the charpos of the
20262 first glyph of blank lines not corresponding to any text
20264 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20265 row
->exact_window_width_line_p
= true;
20266 else if ((append_space_for_newline (it
, true)
20267 && row
->used
[TEXT_AREA
] == 1)
20268 || row
->used
[TEXT_AREA
] == 0)
20270 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20271 row
->displays_text_p
= false;
20273 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20274 && (!MINI_WINDOW_P (it
->w
)
20275 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20276 row
->indicate_empty_line_p
= true;
20279 it
->continuation_lines_width
= 0;
20280 row
->ends_at_zv_p
= true;
20281 /* A row that displays right-to-left text must always have
20282 its last face extended all the way to the end of line,
20283 even if this row ends in ZV, because we still write to
20284 the screen left to right. We also need to extend the
20285 last face if the default face is remapped to some
20286 different face, otherwise the functions that clear
20287 portions of the screen will clear with the default face's
20288 background color. */
20289 if (row
->reversed_p
20290 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20291 extend_face_to_end_of_line (it
);
20295 /* Now, get the metrics of what we want to display. This also
20296 generates glyphs in `row' (which is IT->glyph_row). */
20297 n_glyphs_before
= row
->used
[TEXT_AREA
];
20300 /* Remember the line height so far in case the next element doesn't
20301 fit on the line. */
20302 if (it
->line_wrap
!= TRUNCATE
)
20304 ascent
= it
->max_ascent
;
20305 descent
= it
->max_descent
;
20306 phys_ascent
= it
->max_phys_ascent
;
20307 phys_descent
= it
->max_phys_descent
;
20309 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20311 if (IT_DISPLAYING_WHITESPACE (it
))
20315 SAVE_IT (wrap_it
, *it
, wrap_data
);
20317 wrap_row_used
= row
->used
[TEXT_AREA
];
20318 wrap_row_ascent
= row
->ascent
;
20319 wrap_row_height
= row
->height
;
20320 wrap_row_phys_ascent
= row
->phys_ascent
;
20321 wrap_row_phys_height
= row
->phys_height
;
20322 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20323 wrap_row_min_pos
= min_pos
;
20324 wrap_row_min_bpos
= min_bpos
;
20325 wrap_row_max_pos
= max_pos
;
20326 wrap_row_max_bpos
= max_bpos
;
20332 PRODUCE_GLYPHS (it
);
20334 /* If this display element was in marginal areas, continue with
20336 if (it
->area
!= TEXT_AREA
)
20338 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20339 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20340 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20341 row
->phys_height
= max (row
->phys_height
,
20342 it
->max_phys_ascent
+ it
->max_phys_descent
);
20343 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20344 it
->max_extra_line_spacing
);
20345 set_iterator_to_next (it
, true);
20346 /* If we didn't handle the line/wrap prefix above, and the
20347 call to set_iterator_to_next just switched to TEXT_AREA,
20348 process the prefix now. */
20349 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20351 pending_handle_line_prefix
= false;
20352 handle_line_prefix (it
);
20357 /* Does the display element fit on the line? If we truncate
20358 lines, we should draw past the right edge of the window. If
20359 we don't truncate, we want to stop so that we can display the
20360 continuation glyph before the right margin. If lines are
20361 continued, there are two possible strategies for characters
20362 resulting in more than 1 glyph (e.g. tabs): Display as many
20363 glyphs as possible in this line and leave the rest for the
20364 continuation line, or display the whole element in the next
20365 line. Original redisplay did the former, so we do it also. */
20366 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20367 hpos_before
= it
->hpos
;
20370 if (/* Not a newline. */
20372 /* Glyphs produced fit entirely in the line. */
20373 && it
->current_x
< it
->last_visible_x
)
20375 it
->hpos
+= nglyphs
;
20376 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20377 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20378 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20379 row
->phys_height
= max (row
->phys_height
,
20380 it
->max_phys_ascent
+ it
->max_phys_descent
);
20381 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20382 it
->max_extra_line_spacing
);
20383 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20384 /* In R2L rows, we arrange in extend_face_to_end_of_line
20385 to add a right offset to the line, by a suitable
20386 change to the stretch glyph that is the leftmost
20387 glyph of the line. */
20388 && !row
->reversed_p
)
20389 row
->x
= x
- it
->first_visible_x
;
20390 /* Record the maximum and minimum buffer positions seen so
20391 far in glyphs that will be displayed by this row. */
20393 RECORD_MAX_MIN_POS (it
);
20398 struct glyph
*glyph
;
20400 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20402 /* Identify the glyphs added by the last call to
20403 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20404 the previous glyphs. */
20405 if (!row
->reversed_p
)
20406 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20408 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20409 new_x
= x
+ glyph
->pixel_width
;
20411 if (/* Lines are continued. */
20412 it
->line_wrap
!= TRUNCATE
20413 && (/* Glyph doesn't fit on the line. */
20414 new_x
> it
->last_visible_x
20415 /* Or it fits exactly on a window system frame. */
20416 || (new_x
== it
->last_visible_x
20417 && FRAME_WINDOW_P (it
->f
)
20418 && (row
->reversed_p
20419 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20420 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20422 /* End of a continued line. */
20425 || (new_x
== it
->last_visible_x
20426 && FRAME_WINDOW_P (it
->f
)
20427 && (row
->reversed_p
20428 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20429 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20431 /* Current glyph is the only one on the line or
20432 fits exactly on the line. We must continue
20433 the line because we can't draw the cursor
20434 after the glyph. */
20435 row
->continued_p
= true;
20436 it
->current_x
= new_x
;
20437 it
->continuation_lines_width
+= new_x
;
20439 if (i
== nglyphs
- 1)
20441 /* If line-wrap is on, check if a previous
20442 wrap point was found. */
20443 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20444 && wrap_row_used
> 0
20445 /* Even if there is a previous wrap
20446 point, continue the line here as
20447 usual, if (i) the previous character
20448 was a space or tab AND (ii) the
20449 current character is not. */
20451 || IT_DISPLAYING_WHITESPACE (it
)))
20454 /* Record the maximum and minimum buffer
20455 positions seen so far in glyphs that will be
20456 displayed by this row. */
20458 RECORD_MAX_MIN_POS (it
);
20459 set_iterator_to_next (it
, true);
20460 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20462 if (!get_next_display_element (it
))
20464 row
->exact_window_width_line_p
= true;
20465 it
->continuation_lines_width
= 0;
20466 row
->continued_p
= false;
20467 row
->ends_at_zv_p
= true;
20469 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20471 row
->continued_p
= false;
20472 row
->exact_window_width_line_p
= true;
20474 /* If line-wrap is on, check if a
20475 previous wrap point was found. */
20476 else if (wrap_row_used
> 0
20477 /* Even if there is a previous wrap
20478 point, continue the line here as
20479 usual, if (i) the previous character
20480 was a space or tab AND (ii) the
20481 current character is not. */
20483 || IT_DISPLAYING_WHITESPACE (it
)))
20488 else if (it
->bidi_p
)
20489 RECORD_MAX_MIN_POS (it
);
20490 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20491 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20492 extend_face_to_end_of_line (it
);
20494 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20495 && !FRAME_WINDOW_P (it
->f
))
20497 /* A padding glyph that doesn't fit on this line.
20498 This means the whole character doesn't fit
20500 if (row
->reversed_p
)
20501 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20502 - n_glyphs_before
);
20503 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20505 /* Fill the rest of the row with continuation
20506 glyphs like in 20.x. */
20507 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20508 < row
->glyphs
[1 + TEXT_AREA
])
20509 produce_special_glyphs (it
, IT_CONTINUATION
);
20511 row
->continued_p
= true;
20512 it
->current_x
= x_before
;
20513 it
->continuation_lines_width
+= x_before
;
20515 /* Restore the height to what it was before the
20516 element not fitting on the line. */
20517 it
->max_ascent
= ascent
;
20518 it
->max_descent
= descent
;
20519 it
->max_phys_ascent
= phys_ascent
;
20520 it
->max_phys_descent
= phys_descent
;
20521 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20522 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20523 extend_face_to_end_of_line (it
);
20525 else if (wrap_row_used
> 0)
20528 if (row
->reversed_p
)
20529 unproduce_glyphs (it
,
20530 row
->used
[TEXT_AREA
] - wrap_row_used
);
20531 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20532 it
->continuation_lines_width
+= wrap_x
;
20533 row
->used
[TEXT_AREA
] = wrap_row_used
;
20534 row
->ascent
= wrap_row_ascent
;
20535 row
->height
= wrap_row_height
;
20536 row
->phys_ascent
= wrap_row_phys_ascent
;
20537 row
->phys_height
= wrap_row_phys_height
;
20538 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20539 min_pos
= wrap_row_min_pos
;
20540 min_bpos
= wrap_row_min_bpos
;
20541 max_pos
= wrap_row_max_pos
;
20542 max_bpos
= wrap_row_max_bpos
;
20543 row
->continued_p
= true;
20544 row
->ends_at_zv_p
= false;
20545 row
->exact_window_width_line_p
= false;
20546 it
->continuation_lines_width
+= x
;
20548 /* Make sure that a non-default face is extended
20549 up to the right margin of the window. */
20550 extend_face_to_end_of_line (it
);
20552 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20554 /* A TAB that extends past the right edge of the
20555 window. This produces a single glyph on
20556 window system frames. We leave the glyph in
20557 this row and let it fill the row, but don't
20558 consume the TAB. */
20559 if ((row
->reversed_p
20560 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20561 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20562 produce_special_glyphs (it
, IT_CONTINUATION
);
20563 it
->continuation_lines_width
+= it
->last_visible_x
;
20564 row
->ends_in_middle_of_char_p
= true;
20565 row
->continued_p
= true;
20566 glyph
->pixel_width
= it
->last_visible_x
- x
;
20567 it
->starts_in_middle_of_char_p
= true;
20568 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20569 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20570 extend_face_to_end_of_line (it
);
20574 /* Something other than a TAB that draws past
20575 the right edge of the window. Restore
20576 positions to values before the element. */
20577 if (row
->reversed_p
)
20578 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20579 - (n_glyphs_before
+ i
));
20580 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20582 /* Display continuation glyphs. */
20583 it
->current_x
= x_before
;
20584 it
->continuation_lines_width
+= x
;
20585 if (!FRAME_WINDOW_P (it
->f
)
20586 || (row
->reversed_p
20587 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20588 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20589 produce_special_glyphs (it
, IT_CONTINUATION
);
20590 row
->continued_p
= true;
20592 extend_face_to_end_of_line (it
);
20594 if (nglyphs
> 1 && i
> 0)
20596 row
->ends_in_middle_of_char_p
= true;
20597 it
->starts_in_middle_of_char_p
= true;
20600 /* Restore the height to what it was before the
20601 element not fitting on the line. */
20602 it
->max_ascent
= ascent
;
20603 it
->max_descent
= descent
;
20604 it
->max_phys_ascent
= phys_ascent
;
20605 it
->max_phys_descent
= phys_descent
;
20610 else if (new_x
> it
->first_visible_x
)
20612 /* Increment number of glyphs actually displayed. */
20615 /* Record the maximum and minimum buffer positions
20616 seen so far in glyphs that will be displayed by
20619 RECORD_MAX_MIN_POS (it
);
20621 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20622 /* Glyph is partially visible, i.e. row starts at
20623 negative X position. Don't do that in R2L
20624 rows, where we arrange to add a right offset to
20625 the line in extend_face_to_end_of_line, by a
20626 suitable change to the stretch glyph that is
20627 the leftmost glyph of the line. */
20628 row
->x
= x
- it
->first_visible_x
;
20629 /* When the last glyph of an R2L row only fits
20630 partially on the line, we need to set row->x to a
20631 negative offset, so that the leftmost glyph is
20632 the one that is partially visible. But if we are
20633 going to produce the truncation glyph, this will
20634 be taken care of in produce_special_glyphs. */
20635 if (row
->reversed_p
20636 && new_x
> it
->last_visible_x
20637 && !(it
->line_wrap
== TRUNCATE
20638 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20640 eassert (FRAME_WINDOW_P (it
->f
));
20641 row
->x
= it
->last_visible_x
- new_x
;
20646 /* Glyph is completely off the left margin of the
20647 window. This should not happen because of the
20648 move_it_in_display_line at the start of this
20649 function, unless the text display area of the
20650 window is empty. */
20651 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20654 /* Even if this display element produced no glyphs at all,
20655 we want to record its position. */
20656 if (it
->bidi_p
&& nglyphs
== 0)
20657 RECORD_MAX_MIN_POS (it
);
20659 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20660 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20661 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20662 row
->phys_height
= max (row
->phys_height
,
20663 it
->max_phys_ascent
+ it
->max_phys_descent
);
20664 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20665 it
->max_extra_line_spacing
);
20667 /* End of this display line if row is continued. */
20668 if (row
->continued_p
|| row
->ends_at_zv_p
)
20673 /* Is this a line end? If yes, we're also done, after making
20674 sure that a non-default face is extended up to the right
20675 margin of the window. */
20676 if (ITERATOR_AT_END_OF_LINE_P (it
))
20678 int used_before
= row
->used
[TEXT_AREA
];
20680 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20682 /* Add a space at the end of the line that is used to
20683 display the cursor there. */
20684 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20685 append_space_for_newline (it
, false);
20687 /* Extend the face to the end of the line. */
20688 extend_face_to_end_of_line (it
);
20690 /* Make sure we have the position. */
20691 if (used_before
== 0)
20692 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20694 /* Record the position of the newline, for use in
20696 it
->eol_pos
= it
->current
.pos
;
20698 /* Consume the line end. This skips over invisible lines. */
20699 set_iterator_to_next (it
, true);
20700 it
->continuation_lines_width
= 0;
20704 /* Proceed with next display element. Note that this skips
20705 over lines invisible because of selective display. */
20706 set_iterator_to_next (it
, true);
20708 /* If we truncate lines, we are done when the last displayed
20709 glyphs reach past the right margin of the window. */
20710 if (it
->line_wrap
== TRUNCATE
20711 && ((FRAME_WINDOW_P (it
->f
)
20712 /* Images are preprocessed in produce_image_glyph such
20713 that they are cropped at the right edge of the
20714 window, so an image glyph will always end exactly at
20715 last_visible_x, even if there's no right fringe. */
20716 && ((row
->reversed_p
20717 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20718 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20719 || it
->what
== IT_IMAGE
))
20720 ? (it
->current_x
>= it
->last_visible_x
)
20721 : (it
->current_x
> it
->last_visible_x
)))
20723 /* Maybe add truncation glyphs. */
20724 if (!FRAME_WINDOW_P (it
->f
)
20725 || (row
->reversed_p
20726 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20727 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20731 if (!row
->reversed_p
)
20733 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20734 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20739 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20740 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20742 /* Remove any padding glyphs at the front of ROW, to
20743 make room for the truncation glyphs we will be
20744 adding below. The loop below always inserts at
20745 least one truncation glyph, so also remove the
20746 last glyph added to ROW. */
20747 unproduce_glyphs (it
, i
+ 1);
20748 /* Adjust i for the loop below. */
20749 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20752 /* produce_special_glyphs overwrites the last glyph, so
20753 we don't want that if we want to keep that last
20754 glyph, which means it's an image. */
20755 if (it
->current_x
> it
->last_visible_x
)
20757 it
->current_x
= x_before
;
20758 if (!FRAME_WINDOW_P (it
->f
))
20760 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20762 row
->used
[TEXT_AREA
] = i
;
20763 produce_special_glyphs (it
, IT_TRUNCATION
);
20768 row
->used
[TEXT_AREA
] = i
;
20769 produce_special_glyphs (it
, IT_TRUNCATION
);
20771 it
->hpos
= hpos_before
;
20774 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20776 /* Don't truncate if we can overflow newline into fringe. */
20777 if (!get_next_display_element (it
))
20779 it
->continuation_lines_width
= 0;
20780 row
->ends_at_zv_p
= true;
20781 row
->exact_window_width_line_p
= true;
20784 if (ITERATOR_AT_END_OF_LINE_P (it
))
20786 row
->exact_window_width_line_p
= true;
20787 goto at_end_of_line
;
20789 it
->current_x
= x_before
;
20790 it
->hpos
= hpos_before
;
20793 row
->truncated_on_right_p
= true;
20794 it
->continuation_lines_width
= 0;
20795 reseat_at_next_visible_line_start (it
, false);
20796 /* We insist below that IT's position be at ZV because in
20797 bidi-reordered lines the character at visible line start
20798 might not be the character that follows the newline in
20799 the logical order. */
20800 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20801 row
->ends_at_zv_p
=
20802 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20804 row
->ends_at_zv_p
= false;
20810 bidi_unshelve_cache (wrap_data
, true);
20812 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20813 at the left window margin. */
20814 if (it
->first_visible_x
20815 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20817 if (!FRAME_WINDOW_P (it
->f
)
20818 || (((row
->reversed_p
20819 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20820 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20821 /* Don't let insert_left_trunc_glyphs overwrite the
20822 first glyph of the row if it is an image. */
20823 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20824 insert_left_trunc_glyphs (it
);
20825 row
->truncated_on_left_p
= true;
20828 /* Remember the position at which this line ends.
20830 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20831 cannot be before the call to find_row_edges below, since that is
20832 where these positions are determined. */
20833 row
->end
= it
->current
;
20836 row
->minpos
= row
->start
.pos
;
20837 row
->maxpos
= row
->end
.pos
;
20841 /* ROW->minpos and ROW->maxpos must be the smallest and
20842 `1 + the largest' buffer positions in ROW. But if ROW was
20843 bidi-reordered, these two positions can be anywhere in the
20844 row, so we must determine them now. */
20845 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20848 /* If the start of this line is the overlay arrow-position, then
20849 mark this glyph row as the one containing the overlay arrow.
20850 This is clearly a mess with variable size fonts. It would be
20851 better to let it be displayed like cursors under X. */
20852 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20853 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20854 !NILP (overlay_arrow_string
)))
20856 /* Overlay arrow in window redisplay is a fringe bitmap. */
20857 if (STRINGP (overlay_arrow_string
))
20859 struct glyph_row
*arrow_row
20860 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20861 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20862 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20863 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20864 struct glyph
*p2
, *end
;
20866 /* Copy the arrow glyphs. */
20867 while (glyph
< arrow_end
)
20870 /* Throw away padding glyphs. */
20872 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20873 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20879 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20884 eassert (INTEGERP (overlay_arrow_string
));
20885 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20887 overlay_arrow_seen
= true;
20890 /* Highlight trailing whitespace. */
20891 if (!NILP (Vshow_trailing_whitespace
))
20892 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20894 /* Compute pixel dimensions of this line. */
20895 compute_line_metrics (it
);
20897 /* Implementation note: No changes in the glyphs of ROW or in their
20898 faces can be done past this point, because compute_line_metrics
20899 computes ROW's hash value and stores it within the glyph_row
20902 /* Record whether this row ends inside an ellipsis. */
20903 row
->ends_in_ellipsis_p
20904 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20905 && it
->ellipsis_p
);
20907 /* Save fringe bitmaps in this row. */
20908 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20909 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20910 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20911 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20913 it
->left_user_fringe_bitmap
= 0;
20914 it
->left_user_fringe_face_id
= 0;
20915 it
->right_user_fringe_bitmap
= 0;
20916 it
->right_user_fringe_face_id
= 0;
20918 /* Maybe set the cursor. */
20919 cvpos
= it
->w
->cursor
.vpos
;
20921 /* In bidi-reordered rows, keep checking for proper cursor
20922 position even if one has been found already, because buffer
20923 positions in such rows change non-linearly with ROW->VPOS,
20924 when a line is continued. One exception: when we are at ZV,
20925 display cursor on the first suitable glyph row, since all
20926 the empty rows after that also have their position set to ZV. */
20927 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20928 lines' rows is implemented for bidi-reordered rows. */
20930 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20931 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20932 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20933 && cursor_row_p (row
))
20934 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20936 /* Prepare for the next line. This line starts horizontally at (X
20937 HPOS) = (0 0). Vertical positions are incremented. As a
20938 convenience for the caller, IT->glyph_row is set to the next
20940 it
->current_x
= it
->hpos
= 0;
20941 it
->current_y
+= row
->height
;
20942 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20945 /* The next row should by default use the same value of the
20946 reversed_p flag as this one. set_iterator_to_next decides when
20947 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20948 the flag accordingly. */
20949 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20950 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20951 it
->start
= row
->end
;
20952 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20954 #undef RECORD_MAX_MIN_POS
20957 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20958 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20959 doc
: /* Return paragraph direction at point in BUFFER.
20960 Value is either `left-to-right' or `right-to-left'.
20961 If BUFFER is omitted or nil, it defaults to the current buffer.
20963 Paragraph direction determines how the text in the paragraph is displayed.
20964 In left-to-right paragraphs, text begins at the left margin of the window
20965 and the reading direction is generally left to right. In right-to-left
20966 paragraphs, text begins at the right margin and is read from right to left.
20968 See also `bidi-paragraph-direction'. */)
20969 (Lisp_Object buffer
)
20971 struct buffer
*buf
= current_buffer
;
20972 struct buffer
*old
= buf
;
20974 if (! NILP (buffer
))
20976 CHECK_BUFFER (buffer
);
20977 buf
= XBUFFER (buffer
);
20980 if (NILP (BVAR (buf
, bidi_display_reordering
))
20981 || NILP (BVAR (buf
, enable_multibyte_characters
))
20982 /* When we are loading loadup.el, the character property tables
20983 needed for bidi iteration are not yet available. */
20984 || !NILP (Vpurify_flag
))
20985 return Qleft_to_right
;
20986 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20987 return BVAR (buf
, bidi_paragraph_direction
);
20990 /* Determine the direction from buffer text. We could try to
20991 use current_matrix if it is up to date, but this seems fast
20992 enough as it is. */
20993 struct bidi_it itb
;
20994 ptrdiff_t pos
= BUF_PT (buf
);
20995 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20997 void *itb_data
= bidi_shelve_cache ();
20999 set_buffer_temp (buf
);
21000 /* bidi_paragraph_init finds the base direction of the paragraph
21001 by searching forward from paragraph start. We need the base
21002 direction of the current or _previous_ paragraph, so we need
21003 to make sure we are within that paragraph. To that end, find
21004 the previous non-empty line. */
21005 if (pos
>= ZV
&& pos
> BEGV
)
21006 DEC_BOTH (pos
, bytepos
);
21007 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21008 if (fast_looking_at (trailing_white_space
,
21009 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21011 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21012 || c
== ' ' || c
== '\t' || c
== '\f')
21014 if (bytepos
<= BEGV_BYTE
)
21019 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21022 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21023 itb
.paragraph_dir
= NEUTRAL_DIR
;
21024 itb
.string
.s
= NULL
;
21025 itb
.string
.lstring
= Qnil
;
21026 itb
.string
.bufpos
= 0;
21027 itb
.string
.from_disp_str
= false;
21028 itb
.string
.unibyte
= false;
21029 /* We have no window to use here for ignoring window-specific
21030 overlays. Using NULL for window pointer will cause
21031 compute_display_string_pos to use the current buffer. */
21033 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21034 bidi_unshelve_cache (itb_data
, false);
21035 set_buffer_temp (old
);
21036 switch (itb
.paragraph_dir
)
21039 return Qleft_to_right
;
21042 return Qright_to_left
;
21050 DEFUN ("bidi-find-overridden-directionality",
21051 Fbidi_find_overridden_directionality
,
21052 Sbidi_find_overridden_directionality
, 2, 3, 0,
21053 doc
: /* Return position between FROM and TO where directionality was overridden.
21055 This function returns the first character position in the specified
21056 region of OBJECT where there is a character whose `bidi-class' property
21057 is `L', but which was forced to display as `R' by a directional
21058 override, and likewise with characters whose `bidi-class' is `R'
21059 or `AL' that were forced to display as `L'.
21061 If no such character is found, the function returns nil.
21063 OBJECT is a Lisp string or buffer to search for overridden
21064 directionality, and defaults to the current buffer if nil or omitted.
21065 OBJECT can also be a window, in which case the function will search
21066 the buffer displayed in that window. Passing the window instead of
21067 a buffer is preferable when the buffer is displayed in some window,
21068 because this function will then be able to correctly account for
21069 window-specific overlays, which can affect the results.
21071 Strong directional characters `L', `R', and `AL' can have their
21072 intrinsic directionality overridden by directional override
21073 control characters RLO \(u+202e) and LRO \(u+202d). See the
21074 function `get-char-code-property' for a way to inquire about
21075 the `bidi-class' property of a character. */)
21076 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21078 struct buffer
*buf
= current_buffer
;
21079 struct buffer
*old
= buf
;
21080 struct window
*w
= NULL
;
21081 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21082 struct bidi_it itb
;
21083 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21086 if (!NILP (object
))
21088 if (BUFFERP (object
))
21089 buf
= XBUFFER (object
);
21090 else if (WINDOWP (object
))
21092 w
= decode_live_window (object
);
21093 buf
= XBUFFER (w
->contents
);
21094 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21097 CHECK_STRING (object
);
21100 if (STRINGP (object
))
21102 /* Characters in unibyte strings are always treated by bidi.c as
21104 if (!STRING_MULTIBYTE (object
)
21105 /* When we are loading loadup.el, the character property
21106 tables needed for bidi iteration are not yet
21108 || !NILP (Vpurify_flag
))
21111 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21112 if (from_pos
>= SCHARS (object
))
21115 /* Set up the bidi iterator. */
21116 itb_data
= bidi_shelve_cache ();
21117 itb
.paragraph_dir
= NEUTRAL_DIR
;
21118 itb
.string
.lstring
= object
;
21119 itb
.string
.s
= NULL
;
21120 itb
.string
.schars
= SCHARS (object
);
21121 itb
.string
.bufpos
= 0;
21122 itb
.string
.from_disp_str
= false;
21123 itb
.string
.unibyte
= false;
21125 bidi_init_it (0, 0, frame_window_p
, &itb
);
21129 /* Nothing this fancy can happen in unibyte buffers, or in a
21130 buffer that disabled reordering, or if FROM is at EOB. */
21131 if (NILP (BVAR (buf
, bidi_display_reordering
))
21132 || NILP (BVAR (buf
, enable_multibyte_characters
))
21133 /* When we are loading loadup.el, the character property
21134 tables needed for bidi iteration are not yet
21136 || !NILP (Vpurify_flag
))
21139 set_buffer_temp (buf
);
21140 validate_region (&from
, &to
);
21141 from_pos
= XINT (from
);
21142 to_pos
= XINT (to
);
21143 if (from_pos
>= ZV
)
21146 /* Set up the bidi iterator. */
21147 itb_data
= bidi_shelve_cache ();
21148 from_bpos
= CHAR_TO_BYTE (from_pos
);
21149 if (from_pos
== BEGV
)
21151 itb
.charpos
= BEGV
;
21152 itb
.bytepos
= BEGV_BYTE
;
21154 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21156 itb
.charpos
= from_pos
;
21157 itb
.bytepos
= from_bpos
;
21160 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21162 itb
.paragraph_dir
= NEUTRAL_DIR
;
21163 itb
.string
.s
= NULL
;
21164 itb
.string
.lstring
= Qnil
;
21165 itb
.string
.bufpos
= 0;
21166 itb
.string
.from_disp_str
= false;
21167 itb
.string
.unibyte
= false;
21169 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21174 /* For the purposes of this function, the actual base direction of
21175 the paragraph doesn't matter, so just set it to L2R. */
21176 bidi_paragraph_init (L2R
, &itb
, false);
21177 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21179 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21181 bidi_unshelve_cache (itb_data
, false);
21182 set_buffer_temp (old
);
21184 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21187 DEFUN ("move-point-visually", Fmove_point_visually
,
21188 Smove_point_visually
, 1, 1, 0,
21189 doc
: /* Move point in the visual order in the specified DIRECTION.
21190 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21193 Value is the new character position of point. */)
21194 (Lisp_Object direction
)
21196 struct window
*w
= XWINDOW (selected_window
);
21197 struct buffer
*b
= XBUFFER (w
->contents
);
21198 struct glyph_row
*row
;
21200 Lisp_Object paragraph_dir
;
21202 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21203 (!(ROW)->continued_p \
21204 && NILP ((GLYPH)->object) \
21205 && (GLYPH)->type == CHAR_GLYPH \
21206 && (GLYPH)->u.ch == ' ' \
21207 && (GLYPH)->charpos >= 0 \
21208 && !(GLYPH)->avoid_cursor_p)
21210 CHECK_NUMBER (direction
);
21211 dir
= XINT (direction
);
21217 /* If current matrix is up-to-date, we can use the information
21218 recorded in the glyphs, at least as long as the goal is on the
21220 if (w
->window_end_valid
21221 && !windows_or_buffers_changed
21223 && !b
->clip_changed
21224 && !b
->prevent_redisplay_optimizations_p
21225 && !window_outdated (w
)
21226 /* We rely below on the cursor coordinates to be up to date, but
21227 we cannot trust them if some command moved point since the
21228 last complete redisplay. */
21229 && w
->last_point
== BUF_PT (b
)
21230 && w
->cursor
.vpos
>= 0
21231 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21232 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21234 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21235 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21236 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21238 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21240 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21242 SET_PT (g
->charpos
);
21243 w
->cursor
.vpos
= -1;
21244 return make_number (PT
);
21246 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21250 if (BUFFERP (gpt
->object
))
21253 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21254 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21256 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21258 else if (BUFFERP (g
->object
))
21259 new_pos
= g
->charpos
;
21263 w
->cursor
.vpos
= -1;
21264 return make_number (PT
);
21266 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21268 /* Glyphs inserted at the end of a non-empty line for
21269 positioning the cursor have zero charpos, so we must
21270 deduce the value of point by other means. */
21271 if (g
->charpos
> 0)
21272 SET_PT (g
->charpos
);
21273 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21275 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21276 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21279 w
->cursor
.vpos
= -1;
21280 return make_number (PT
);
21283 if (g
== e
|| NILP (g
->object
))
21285 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21286 goto simulate_display
;
21287 if (!row
->reversed_p
)
21291 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21292 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21293 goto simulate_display
;
21297 if (row
->reversed_p
&& !row
->continued_p
)
21299 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21300 w
->cursor
.vpos
= -1;
21301 return make_number (PT
);
21303 g
= row
->glyphs
[TEXT_AREA
];
21304 e
= g
+ row
->used
[TEXT_AREA
];
21305 for ( ; g
< e
; g
++)
21307 if (BUFFERP (g
->object
)
21308 /* Empty lines have only one glyph, which stands
21309 for the newline, and whose charpos is the
21310 buffer position of the newline. */
21311 || ROW_GLYPH_NEWLINE_P (row
, g
)
21312 /* When the buffer ends in a newline, the line at
21313 EOB also has one glyph, but its charpos is -1. */
21314 || (row
->ends_at_zv_p
21315 && !row
->reversed_p
21316 && NILP (g
->object
)
21317 && g
->type
== CHAR_GLYPH
21318 && g
->u
.ch
== ' '))
21320 if (g
->charpos
> 0)
21321 SET_PT (g
->charpos
);
21322 else if (!row
->reversed_p
21323 && row
->ends_at_zv_p
21328 w
->cursor
.vpos
= -1;
21329 return make_number (PT
);
21335 if (!row
->reversed_p
&& !row
->continued_p
)
21337 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21338 w
->cursor
.vpos
= -1;
21339 return make_number (PT
);
21341 e
= row
->glyphs
[TEXT_AREA
];
21342 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21343 for ( ; g
>= e
; g
--)
21345 if (BUFFERP (g
->object
)
21346 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21348 /* Empty R2L lines on GUI frames have the buffer
21349 position of the newline stored in the stretch
21351 || g
->type
== STRETCH_GLYPH
21352 || (row
->ends_at_zv_p
21354 && NILP (g
->object
)
21355 && g
->type
== CHAR_GLYPH
21356 && g
->u
.ch
== ' '))
21358 if (g
->charpos
> 0)
21359 SET_PT (g
->charpos
);
21360 else if (row
->reversed_p
21361 && row
->ends_at_zv_p
21366 w
->cursor
.vpos
= -1;
21367 return make_number (PT
);
21376 /* If we wind up here, we failed to move by using the glyphs, so we
21377 need to simulate display instead. */
21380 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21382 paragraph_dir
= Qleft_to_right
;
21383 if (EQ (paragraph_dir
, Qright_to_left
))
21385 if (PT
<= BEGV
&& dir
< 0)
21386 xsignal0 (Qbeginning_of_buffer
);
21387 else if (PT
>= ZV
&& dir
> 0)
21388 xsignal0 (Qend_of_buffer
);
21391 struct text_pos pt
;
21393 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21395 bool overshoot_expected
= false;
21396 bool target_is_eol_p
= false;
21398 /* Setup the arena. */
21399 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21400 start_display (&it
, w
, pt
);
21401 /* When lines are truncated, we could be called with point
21402 outside of the windows edges, in which case move_it_*
21403 functions either prematurely stop at window's edge or jump to
21404 the next screen line, whereas we rely below on our ability to
21405 reach point, in order to start from its X coordinate. So we
21406 need to disregard the window's horizontal extent in that case. */
21407 if (it
.line_wrap
== TRUNCATE
)
21408 it
.last_visible_x
= INFINITY
;
21410 if (it
.cmp_it
.id
< 0
21411 && it
.method
== GET_FROM_STRING
21412 && it
.area
== TEXT_AREA
21413 && it
.string_from_display_prop_p
21414 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21415 overshoot_expected
= true;
21417 /* Find the X coordinate of point. We start from the beginning
21418 of this or previous line to make sure we are before point in
21419 the logical order (since the move_it_* functions can only
21422 reseat_at_previous_visible_line_start (&it
);
21423 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21424 if (IT_CHARPOS (it
) != PT
)
21426 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21427 -1, -1, -1, MOVE_TO_POS
);
21428 /* If we missed point because the character there is
21429 displayed out of a display vector that has more than one
21430 glyph, retry expecting overshoot. */
21431 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21432 && it
.current
.dpvec_index
> 0
21433 && !overshoot_expected
)
21435 overshoot_expected
= true;
21438 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21439 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21441 pt_x
= it
.current_x
;
21443 if (dir
> 0 || overshoot_expected
)
21445 struct glyph_row
*row
= it
.glyph_row
;
21447 /* When point is at beginning of line, we don't have
21448 information about the glyph there loaded into struct
21449 it. Calling get_next_display_element fixes that. */
21451 get_next_display_element (&it
);
21452 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21453 it
.glyph_row
= NULL
;
21454 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21455 it
.glyph_row
= row
;
21456 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21457 it, lest it will become out of sync with it's buffer
21459 it
.current_x
= pt_x
;
21462 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21463 pixel_width
= it
.pixel_width
;
21464 if (overshoot_expected
&& at_eol_p
)
21466 else if (pixel_width
<= 0)
21469 /* If there's a display string (or something similar) at point,
21470 we are actually at the glyph to the left of point, so we need
21471 to correct the X coordinate. */
21472 if (overshoot_expected
)
21475 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21477 pt_x
+= pixel_width
;
21480 /* Compute target X coordinate, either to the left or to the
21481 right of point. On TTY frames, all characters have the same
21482 pixel width of 1, so we can use that. On GUI frames we don't
21483 have an easy way of getting at the pixel width of the
21484 character to the left of point, so we use a different method
21485 of getting to that place. */
21487 target_x
= pt_x
+ pixel_width
;
21489 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21491 /* Target X coordinate could be one line above or below the line
21492 of point, in which case we need to adjust the target X
21493 coordinate. Also, if moving to the left, we need to begin at
21494 the left edge of the point's screen line. */
21499 start_display (&it
, w
, pt
);
21500 if (it
.line_wrap
== TRUNCATE
)
21501 it
.last_visible_x
= INFINITY
;
21502 reseat_at_previous_visible_line_start (&it
);
21503 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21505 move_it_by_lines (&it
, pt_vpos
);
21509 move_it_by_lines (&it
, -1);
21510 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21511 target_is_eol_p
= true;
21512 /* Under word-wrap, we don't know the x coordinate of
21513 the last character displayed on the previous line,
21514 which immediately precedes the wrap point. To find
21515 out its x coordinate, we try moving to the right
21516 margin of the window, which will stop at the wrap
21517 point, and then reset target_x to point at the
21518 character that precedes the wrap point. This is not
21519 needed on GUI frames, because (see below) there we
21520 move from the left margin one grapheme cluster at a
21521 time, and stop when we hit the wrap point. */
21522 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21524 void *it_data
= NULL
;
21527 SAVE_IT (it2
, it
, it_data
);
21528 move_it_in_display_line_to (&it
, ZV
, target_x
,
21529 MOVE_TO_POS
| MOVE_TO_X
);
21530 /* If we arrived at target_x, that _is_ the last
21531 character on the previous line. */
21532 if (it
.current_x
!= target_x
)
21533 target_x
= it
.current_x
- 1;
21534 RESTORE_IT (&it
, &it2
, it_data
);
21541 || (target_x
>= it
.last_visible_x
21542 && it
.line_wrap
!= TRUNCATE
))
21545 move_it_by_lines (&it
, 0);
21546 move_it_by_lines (&it
, 1);
21551 /* Move to the target X coordinate. */
21552 #ifdef HAVE_WINDOW_SYSTEM
21553 /* On GUI frames, as we don't know the X coordinate of the
21554 character to the left of point, moving point to the left
21555 requires walking, one grapheme cluster at a time, until we
21556 find ourself at a place immediately to the left of the
21557 character at point. */
21558 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21560 struct text_pos new_pos
;
21561 enum move_it_result rc
= MOVE_X_REACHED
;
21563 if (it
.current_x
== 0)
21564 get_next_display_element (&it
);
21565 if (it
.what
== IT_COMPOSITION
)
21567 new_pos
.charpos
= it
.cmp_it
.charpos
;
21568 new_pos
.bytepos
= -1;
21571 new_pos
= it
.current
.pos
;
21573 while (it
.current_x
+ it
.pixel_width
<= target_x
21574 && (rc
== MOVE_X_REACHED
21575 /* Under word-wrap, move_it_in_display_line_to
21576 stops at correct coordinates, but sometimes
21577 returns MOVE_POS_MATCH_OR_ZV. */
21578 || (it
.line_wrap
== WORD_WRAP
21579 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21581 int new_x
= it
.current_x
+ it
.pixel_width
;
21583 /* For composed characters, we want the position of the
21584 first character in the grapheme cluster (usually, the
21585 composition's base character), whereas it.current
21586 might give us the position of the _last_ one, e.g. if
21587 the composition is rendered in reverse due to bidi
21589 if (it
.what
== IT_COMPOSITION
)
21591 new_pos
.charpos
= it
.cmp_it
.charpos
;
21592 new_pos
.bytepos
= -1;
21595 new_pos
= it
.current
.pos
;
21596 if (new_x
== it
.current_x
)
21598 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21599 MOVE_TO_POS
| MOVE_TO_X
);
21600 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21603 /* The previous position we saw in the loop is the one we
21605 if (new_pos
.bytepos
== -1)
21606 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21607 it
.current
.pos
= new_pos
;
21611 if (it
.current_x
!= target_x
)
21612 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21614 /* If we ended up in a display string that covers point, move to
21615 buffer position to the right in the visual order. */
21618 while (IT_CHARPOS (it
) == PT
)
21620 set_iterator_to_next (&it
, false);
21621 if (!get_next_display_element (&it
))
21626 /* Move point to that position. */
21627 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21630 return make_number (PT
);
21632 #undef ROW_GLYPH_NEWLINE_P
21635 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21636 Sbidi_resolved_levels
, 0, 1, 0,
21637 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21639 The resolved levels are produced by the Emacs bidi reordering engine
21640 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21641 read the Unicode Standard Annex 9 (UAX#9) for background information
21642 about these levels.
21644 VPOS is the zero-based number of the current window's screen line
21645 for which to produce the resolved levels. If VPOS is nil or omitted,
21646 it defaults to the screen line of point. If the window displays a
21647 header line, VPOS of zero will report on the header line, and first
21648 line of text in the window will have VPOS of 1.
21650 Value is an array of resolved levels, indexed by glyph number.
21651 Glyphs are numbered from zero starting from the beginning of the
21652 screen line, i.e. the left edge of the window for left-to-right lines
21653 and from the right edge for right-to-left lines. The resolved levels
21654 are produced only for the window's text area; text in display margins
21657 If the selected window's display is not up-to-date, or if the specified
21658 screen line does not display text, this function returns nil. It is
21659 highly recommended to bind this function to some simple key, like F8,
21660 in order to avoid these problems.
21662 This function exists mainly for testing the correctness of the
21663 Emacs UBA implementation, in particular with the test suite. */)
21666 struct window
*w
= XWINDOW (selected_window
);
21667 struct buffer
*b
= XBUFFER (w
->contents
);
21669 struct glyph_row
*row
;
21673 int d1
, d2
, d3
, d4
, d5
;
21675 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21679 CHECK_NUMBER_COERCE_MARKER (vpos
);
21680 nrow
= XINT (vpos
);
21683 /* We require up-to-date glyph matrix for this window. */
21684 if (w
->window_end_valid
21685 && !windows_or_buffers_changed
21687 && !b
->clip_changed
21688 && !b
->prevent_redisplay_optimizations_p
21689 && !window_outdated (w
)
21691 && nrow
< w
->current_matrix
->nrows
21692 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21693 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21695 struct glyph
*g
, *e
, *g1
;
21697 Lisp_Object levels
;
21699 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21701 g
= g1
= row
->glyphs
[TEXT_AREA
];
21702 e
= g
+ row
->used
[TEXT_AREA
];
21704 /* Skip over glyphs at the start of the row that was
21705 generated by redisplay for its own needs. */
21707 && NILP (g
->object
)
21712 /* Count the "interesting" glyphs in this row. */
21713 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21716 /* Create and fill the array. */
21717 levels
= make_uninit_vector (nglyphs
);
21718 for (i
= 0; g1
< g
; i
++, g1
++)
21719 ASET (levels
, i
, make_number (g1
->resolved_level
));
21721 else /* Right-to-left glyph row. */
21723 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21724 e
= row
->glyphs
[TEXT_AREA
] - 1;
21726 && NILP (g
->object
)
21730 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21732 levels
= make_uninit_vector (nglyphs
);
21733 for (i
= 0; g1
> g
; i
++, g1
--)
21734 ASET (levels
, i
, make_number (g1
->resolved_level
));
21744 /***********************************************************************
21746 ***********************************************************************/
21748 /* Redisplay the menu bar in the frame for window W.
21750 The menu bar of X frames that don't have X toolkit support is
21751 displayed in a special window W->frame->menu_bar_window.
21753 The menu bar of terminal frames is treated specially as far as
21754 glyph matrices are concerned. Menu bar lines are not part of
21755 windows, so the update is done directly on the frame matrix rows
21756 for the menu bar. */
21759 display_menu_bar (struct window
*w
)
21761 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21766 /* Don't do all this for graphical frames. */
21768 if (FRAME_W32_P (f
))
21771 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21777 if (FRAME_NS_P (f
))
21779 #endif /* HAVE_NS */
21781 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21782 eassert (!FRAME_WINDOW_P (f
));
21783 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21784 it
.first_visible_x
= 0;
21785 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21786 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21787 if (FRAME_WINDOW_P (f
))
21789 /* Menu bar lines are displayed in the desired matrix of the
21790 dummy window menu_bar_window. */
21791 struct window
*menu_w
;
21792 menu_w
= XWINDOW (f
->menu_bar_window
);
21793 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21795 it
.first_visible_x
= 0;
21796 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21799 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21801 /* This is a TTY frame, i.e. character hpos/vpos are used as
21803 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21805 it
.first_visible_x
= 0;
21806 it
.last_visible_x
= FRAME_COLS (f
);
21809 /* FIXME: This should be controlled by a user option. See the
21810 comments in redisplay_tool_bar and display_mode_line about
21812 it
.paragraph_embedding
= L2R
;
21814 /* Clear all rows of the menu bar. */
21815 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21817 struct glyph_row
*row
= it
.glyph_row
+ i
;
21818 clear_glyph_row (row
);
21819 row
->enabled_p
= true;
21820 row
->full_width_p
= true;
21821 row
->reversed_p
= false;
21824 /* Display all items of the menu bar. */
21825 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21826 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21828 Lisp_Object string
;
21830 /* Stop at nil string. */
21831 string
= AREF (items
, i
+ 1);
21835 /* Remember where item was displayed. */
21836 ASET (items
, i
+ 3, make_number (it
.hpos
));
21838 /* Display the item, pad with one space. */
21839 if (it
.current_x
< it
.last_visible_x
)
21840 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21841 SCHARS (string
) + 1, 0, 0, -1);
21844 /* Fill out the line with spaces. */
21845 if (it
.current_x
< it
.last_visible_x
)
21846 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21848 /* Compute the total height of the lines. */
21849 compute_line_metrics (&it
);
21852 /* Deep copy of a glyph row, including the glyphs. */
21854 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21856 struct glyph
*pointers
[1 + LAST_AREA
];
21857 int to_used
= to
->used
[TEXT_AREA
];
21859 /* Save glyph pointers of TO. */
21860 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21862 /* Do a structure assignment. */
21865 /* Restore original glyph pointers of TO. */
21866 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21868 /* Copy the glyphs. */
21869 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21870 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21872 /* If we filled only part of the TO row, fill the rest with
21873 space_glyph (which will display as empty space). */
21874 if (to_used
> from
->used
[TEXT_AREA
])
21875 fill_up_frame_row_with_spaces (to
, to_used
);
21878 /* Display one menu item on a TTY, by overwriting the glyphs in the
21879 frame F's desired glyph matrix with glyphs produced from the menu
21880 item text. Called from term.c to display TTY drop-down menus one
21883 ITEM_TEXT is the menu item text as a C string.
21885 FACE_ID is the face ID to be used for this menu item. FACE_ID
21886 could specify one of 3 faces: a face for an enabled item, a face
21887 for a disabled item, or a face for a selected item.
21889 X and Y are coordinates of the first glyph in the frame's desired
21890 matrix to be overwritten by the menu item. Since this is a TTY, Y
21891 is the zero-based number of the glyph row and X is the zero-based
21892 glyph number in the row, starting from left, where to start
21893 displaying the item.
21895 SUBMENU means this menu item drops down a submenu, which
21896 should be indicated by displaying a proper visual cue after the
21900 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21901 int x
, int y
, bool submenu
)
21904 struct frame
*f
= SELECTED_FRAME ();
21905 struct window
*w
= XWINDOW (f
->selected_window
);
21906 struct glyph_row
*row
;
21907 size_t item_len
= strlen (item_text
);
21909 eassert (FRAME_TERMCAP_P (f
));
21911 /* Don't write beyond the matrix's last row. This can happen for
21912 TTY screens that are not high enough to show the entire menu.
21913 (This is actually a bit of defensive programming, as
21914 tty_menu_display already limits the number of menu items to one
21915 less than the number of screen lines.) */
21916 if (y
>= f
->desired_matrix
->nrows
)
21919 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21920 it
.first_visible_x
= 0;
21921 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21922 row
= it
.glyph_row
;
21923 /* Start with the row contents from the current matrix. */
21924 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21925 bool saved_width
= row
->full_width_p
;
21926 row
->full_width_p
= true;
21927 bool saved_reversed
= row
->reversed_p
;
21928 row
->reversed_p
= false;
21929 row
->enabled_p
= true;
21931 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21933 eassert (x
< f
->desired_matrix
->matrix_w
);
21934 it
.current_x
= it
.hpos
= x
;
21935 it
.current_y
= it
.vpos
= y
;
21936 int saved_used
= row
->used
[TEXT_AREA
];
21937 bool saved_truncated
= row
->truncated_on_right_p
;
21938 row
->used
[TEXT_AREA
] = x
;
21939 it
.face_id
= face_id
;
21940 it
.line_wrap
= TRUNCATE
;
21942 /* FIXME: This should be controlled by a user option. See the
21943 comments in redisplay_tool_bar and display_mode_line about this.
21944 Also, if paragraph_embedding could ever be R2L, changes will be
21945 needed to avoid shifting to the right the row characters in
21946 term.c:append_glyph. */
21947 it
.paragraph_embedding
= L2R
;
21949 /* Pad with a space on the left. */
21950 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21952 /* Display the menu item, pad with spaces to WIDTH. */
21955 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21956 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21958 /* Indicate with " >" that there's a submenu. */
21959 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21960 FRAME_COLS (f
) - 1, -1);
21963 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21964 width
, 0, FRAME_COLS (f
) - 1, -1);
21966 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21967 row
->truncated_on_right_p
= saved_truncated
;
21968 row
->hash
= row_hash (row
);
21969 row
->full_width_p
= saved_width
;
21970 row
->reversed_p
= saved_reversed
;
21973 /***********************************************************************
21975 ***********************************************************************/
21977 /* Redisplay mode lines in the window tree whose root is WINDOW.
21978 If FORCE, redisplay mode lines unconditionally.
21979 Otherwise, redisplay only mode lines that are garbaged. Value is
21980 the number of windows whose mode lines were redisplayed. */
21983 redisplay_mode_lines (Lisp_Object window
, bool force
)
21987 while (!NILP (window
))
21989 struct window
*w
= XWINDOW (window
);
21991 if (WINDOWP (w
->contents
))
21992 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21994 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21995 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21997 struct text_pos lpoint
;
21998 struct buffer
*old
= current_buffer
;
22000 /* Set the window's buffer for the mode line display. */
22001 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22002 set_buffer_internal_1 (XBUFFER (w
->contents
));
22004 /* Point refers normally to the selected window. For any
22005 other window, set up appropriate value. */
22006 if (!EQ (window
, selected_window
))
22008 struct text_pos pt
;
22010 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22011 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22014 /* Display mode lines. */
22015 clear_glyph_matrix (w
->desired_matrix
);
22016 if (display_mode_lines (w
))
22019 /* Restore old settings. */
22020 set_buffer_internal_1 (old
);
22021 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22031 /* Display the mode and/or header line of window W. Value is the
22032 sum number of mode lines and header lines displayed. */
22035 display_mode_lines (struct window
*w
)
22037 Lisp_Object old_selected_window
= selected_window
;
22038 Lisp_Object old_selected_frame
= selected_frame
;
22039 Lisp_Object new_frame
= w
->frame
;
22040 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22043 selected_frame
= new_frame
;
22044 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22045 or window's point, then we'd need select_window_1 here as well. */
22046 XSETWINDOW (selected_window
, w
);
22047 XFRAME (new_frame
)->selected_window
= selected_window
;
22049 /* These will be set while the mode line specs are processed. */
22050 line_number_displayed
= false;
22051 w
->column_number_displayed
= -1;
22053 if (WINDOW_WANTS_MODELINE_P (w
))
22055 struct window
*sel_w
= XWINDOW (old_selected_window
);
22057 /* Select mode line face based on the real selected window. */
22058 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22059 BVAR (current_buffer
, mode_line_format
));
22063 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22065 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22066 BVAR (current_buffer
, header_line_format
));
22070 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22071 selected_frame
= old_selected_frame
;
22072 selected_window
= old_selected_window
;
22074 w
->must_be_updated_p
= true;
22079 /* Display mode or header line of window W. FACE_ID specifies which
22080 line to display; it is either MODE_LINE_FACE_ID or
22081 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22082 display. Value is the pixel height of the mode/header line
22086 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22090 ptrdiff_t count
= SPECPDL_INDEX ();
22092 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22093 /* Don't extend on a previously drawn mode-line.
22094 This may happen if called from pos_visible_p. */
22095 it
.glyph_row
->enabled_p
= false;
22096 prepare_desired_row (w
, it
.glyph_row
, true);
22098 it
.glyph_row
->mode_line_p
= true;
22100 /* FIXME: This should be controlled by a user option. But
22101 supporting such an option is not trivial, since the mode line is
22102 made up of many separate strings. */
22103 it
.paragraph_embedding
= L2R
;
22105 record_unwind_protect (unwind_format_mode_line
,
22106 format_mode_line_unwind_data (NULL
, NULL
,
22109 mode_line_target
= MODE_LINE_DISPLAY
;
22111 /* Temporarily make frame's keyboard the current kboard so that
22112 kboard-local variables in the mode_line_format will get the right
22114 push_kboard (FRAME_KBOARD (it
.f
));
22115 record_unwind_save_match_data ();
22116 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22119 unbind_to (count
, Qnil
);
22121 /* Fill up with spaces. */
22122 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22124 compute_line_metrics (&it
);
22125 it
.glyph_row
->full_width_p
= true;
22126 it
.glyph_row
->continued_p
= false;
22127 it
.glyph_row
->truncated_on_left_p
= false;
22128 it
.glyph_row
->truncated_on_right_p
= false;
22130 /* Make a 3D mode-line have a shadow at its right end. */
22131 face
= FACE_FROM_ID (it
.f
, face_id
);
22132 extend_face_to_end_of_line (&it
);
22133 if (face
->box
!= FACE_NO_BOX
)
22135 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22136 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22137 last
->right_box_line_p
= true;
22140 return it
.glyph_row
->height
;
22143 /* Move element ELT in LIST to the front of LIST.
22144 Return the updated list. */
22147 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22149 register Lisp_Object tail
, prev
;
22150 register Lisp_Object tem
;
22154 while (CONSP (tail
))
22160 /* Splice out the link TAIL. */
22162 list
= XCDR (tail
);
22164 Fsetcdr (prev
, XCDR (tail
));
22166 /* Now make it the first. */
22167 Fsetcdr (tail
, list
);
22172 tail
= XCDR (tail
);
22176 /* Not found--return unchanged LIST. */
22180 /* Contribute ELT to the mode line for window IT->w. How it
22181 translates into text depends on its data type.
22183 IT describes the display environment in which we display, as usual.
22185 DEPTH is the depth in recursion. It is used to prevent
22186 infinite recursion here.
22188 FIELD_WIDTH is the number of characters the display of ELT should
22189 occupy in the mode line, and PRECISION is the maximum number of
22190 characters to display from ELT's representation. See
22191 display_string for details.
22193 Returns the hpos of the end of the text generated by ELT.
22195 PROPS is a property list to add to any string we encounter.
22197 If RISKY, remove (disregard) any properties in any string
22198 we encounter, and ignore :eval and :propertize.
22200 The global variable `mode_line_target' determines whether the
22201 output is passed to `store_mode_line_noprop',
22202 `store_mode_line_string', or `display_string'. */
22205 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22206 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22208 int n
= 0, field
, prec
;
22209 bool literal
= false;
22213 elt
= build_string ("*too-deep*");
22217 switch (XTYPE (elt
))
22221 /* A string: output it and check for %-constructs within it. */
22223 ptrdiff_t offset
= 0;
22225 if (SCHARS (elt
) > 0
22226 && (!NILP (props
) || risky
))
22228 Lisp_Object oprops
, aelt
;
22229 oprops
= Ftext_properties_at (make_number (0), elt
);
22231 /* If the starting string's properties are not what
22232 we want, translate the string. Also, if the string
22233 is risky, do that anyway. */
22235 if (NILP (Fequal (props
, oprops
)) || risky
)
22237 /* If the starting string has properties,
22238 merge the specified ones onto the existing ones. */
22239 if (! NILP (oprops
) && !risky
)
22243 oprops
= Fcopy_sequence (oprops
);
22245 while (CONSP (tem
))
22247 oprops
= Fplist_put (oprops
, XCAR (tem
),
22248 XCAR (XCDR (tem
)));
22249 tem
= XCDR (XCDR (tem
));
22254 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22255 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22257 /* AELT is what we want. Move it to the front
22258 without consing. */
22260 mode_line_proptrans_alist
22261 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22267 /* If AELT has the wrong props, it is useless.
22268 so get rid of it. */
22270 mode_line_proptrans_alist
22271 = Fdelq (aelt
, mode_line_proptrans_alist
);
22273 elt
= Fcopy_sequence (elt
);
22274 Fset_text_properties (make_number (0), Flength (elt
),
22276 /* Add this item to mode_line_proptrans_alist. */
22277 mode_line_proptrans_alist
22278 = Fcons (Fcons (elt
, props
),
22279 mode_line_proptrans_alist
);
22280 /* Truncate mode_line_proptrans_alist
22281 to at most 50 elements. */
22282 tem
= Fnthcdr (make_number (50),
22283 mode_line_proptrans_alist
);
22285 XSETCDR (tem
, Qnil
);
22294 prec
= precision
- n
;
22295 switch (mode_line_target
)
22297 case MODE_LINE_NOPROP
:
22298 case MODE_LINE_TITLE
:
22299 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22301 case MODE_LINE_STRING
:
22302 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22304 case MODE_LINE_DISPLAY
:
22305 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22306 0, prec
, 0, STRING_MULTIBYTE (elt
));
22313 /* Handle the non-literal case. */
22315 while ((precision
<= 0 || n
< precision
)
22316 && SREF (elt
, offset
) != 0
22317 && (mode_line_target
!= MODE_LINE_DISPLAY
22318 || it
->current_x
< it
->last_visible_x
))
22320 ptrdiff_t last_offset
= offset
;
22322 /* Advance to end of string or next format specifier. */
22323 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22326 if (offset
- 1 != last_offset
)
22328 ptrdiff_t nchars
, nbytes
;
22330 /* Output to end of string or up to '%'. Field width
22331 is length of string. Don't output more than
22332 PRECISION allows us. */
22335 prec
= c_string_width (SDATA (elt
) + last_offset
,
22336 offset
- last_offset
, precision
- n
,
22339 switch (mode_line_target
)
22341 case MODE_LINE_NOPROP
:
22342 case MODE_LINE_TITLE
:
22343 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22345 case MODE_LINE_STRING
:
22347 ptrdiff_t bytepos
= last_offset
;
22348 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22349 ptrdiff_t endpos
= (precision
<= 0
22350 ? string_byte_to_char (elt
, offset
)
22351 : charpos
+ nchars
);
22352 Lisp_Object mode_string
22353 = Fsubstring (elt
, make_number (charpos
),
22354 make_number (endpos
));
22355 n
+= store_mode_line_string (NULL
, mode_string
, false,
22359 case MODE_LINE_DISPLAY
:
22361 ptrdiff_t bytepos
= last_offset
;
22362 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22364 if (precision
<= 0)
22365 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22366 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22368 STRING_MULTIBYTE (elt
));
22373 else /* c == '%' */
22375 ptrdiff_t percent_position
= offset
;
22377 /* Get the specified minimum width. Zero means
22380 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22381 field
= field
* 10 + c
- '0';
22383 /* Don't pad beyond the total padding allowed. */
22384 if (field_width
- n
> 0 && field
> field_width
- n
)
22385 field
= field_width
- n
;
22387 /* Note that either PRECISION <= 0 or N < PRECISION. */
22388 prec
= precision
- n
;
22391 n
+= display_mode_element (it
, depth
, field
, prec
,
22392 Vglobal_mode_string
, props
,
22397 ptrdiff_t bytepos
, charpos
;
22399 Lisp_Object string
;
22401 bytepos
= percent_position
;
22402 charpos
= (STRING_MULTIBYTE (elt
)
22403 ? string_byte_to_char (elt
, bytepos
)
22405 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22406 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22408 switch (mode_line_target
)
22410 case MODE_LINE_NOPROP
:
22411 case MODE_LINE_TITLE
:
22412 n
+= store_mode_line_noprop (spec
, field
, prec
);
22414 case MODE_LINE_STRING
:
22416 Lisp_Object tem
= build_string (spec
);
22417 props
= Ftext_properties_at (make_number (charpos
), elt
);
22418 /* Should only keep face property in props */
22419 n
+= store_mode_line_string (NULL
, tem
, false,
22420 field
, prec
, props
);
22423 case MODE_LINE_DISPLAY
:
22425 int nglyphs_before
, nwritten
;
22427 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22428 nwritten
= display_string (spec
, string
, elt
,
22433 /* Assign to the glyphs written above the
22434 string where the `%x' came from, position
22438 struct glyph
*glyph
22439 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22443 for (i
= 0; i
< nwritten
; ++i
)
22445 glyph
[i
].object
= elt
;
22446 glyph
[i
].charpos
= charpos
;
22463 /* A symbol: process the value of the symbol recursively
22464 as if it appeared here directly. Avoid error if symbol void.
22465 Special case: if value of symbol is a string, output the string
22468 register Lisp_Object tem
;
22470 /* If the variable is not marked as risky to set
22471 then its contents are risky to use. */
22472 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22475 tem
= Fboundp (elt
);
22478 tem
= Fsymbol_value (elt
);
22479 /* If value is a string, output that string literally:
22480 don't check for % within it. */
22484 if (!EQ (tem
, elt
))
22486 /* Give up right away for nil or t. */
22496 register Lisp_Object car
, tem
;
22498 /* A cons cell: five distinct cases.
22499 If first element is :eval or :propertize, do something special.
22500 If first element is a string or a cons, process all the elements
22501 and effectively concatenate them.
22502 If first element is a negative number, truncate displaying cdr to
22503 at most that many characters. If positive, pad (with spaces)
22504 to at least that many characters.
22505 If first element is a symbol, process the cadr or caddr recursively
22506 according to whether the symbol's value is non-nil or nil. */
22508 if (EQ (car
, QCeval
))
22510 /* An element of the form (:eval FORM) means evaluate FORM
22511 and use the result as mode line elements. */
22516 if (CONSP (XCDR (elt
)))
22519 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22520 n
+= display_mode_element (it
, depth
, field_width
- n
,
22521 precision
- n
, spec
, props
,
22525 else if (EQ (car
, QCpropertize
))
22527 /* An element of the form (:propertize ELT PROPS...)
22528 means display ELT but applying properties PROPS. */
22533 if (CONSP (XCDR (elt
)))
22534 n
+= display_mode_element (it
, depth
, field_width
- n
,
22535 precision
- n
, XCAR (XCDR (elt
)),
22536 XCDR (XCDR (elt
)), risky
);
22538 else if (SYMBOLP (car
))
22540 tem
= Fboundp (car
);
22544 /* elt is now the cdr, and we know it is a cons cell.
22545 Use its car if CAR has a non-nil value. */
22548 tem
= Fsymbol_value (car
);
22555 /* Symbol's value is nil (or symbol is unbound)
22556 Get the cddr of the original list
22557 and if possible find the caddr and use that. */
22561 else if (!CONSP (elt
))
22566 else if (INTEGERP (car
))
22568 register int lim
= XINT (car
);
22572 /* Negative int means reduce maximum width. */
22573 if (precision
<= 0)
22576 precision
= min (precision
, -lim
);
22580 /* Padding specified. Don't let it be more than
22581 current maximum. */
22583 lim
= min (precision
, lim
);
22585 /* If that's more padding than already wanted, queue it.
22586 But don't reduce padding already specified even if
22587 that is beyond the current truncation point. */
22588 field_width
= max (lim
, field_width
);
22592 else if (STRINGP (car
) || CONSP (car
))
22594 Lisp_Object halftail
= elt
;
22598 && (precision
<= 0 || n
< precision
))
22600 n
+= display_mode_element (it
, depth
,
22601 /* Do padding only after the last
22602 element in the list. */
22603 (! CONSP (XCDR (elt
))
22606 precision
- n
, XCAR (elt
),
22610 if ((len
& 1) == 0)
22611 halftail
= XCDR (halftail
);
22612 /* Check for cycle. */
22613 if (EQ (halftail
, elt
))
22622 elt
= build_string ("*invalid*");
22626 /* Pad to FIELD_WIDTH. */
22627 if (field_width
> 0 && n
< field_width
)
22629 switch (mode_line_target
)
22631 case MODE_LINE_NOPROP
:
22632 case MODE_LINE_TITLE
:
22633 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22635 case MODE_LINE_STRING
:
22636 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22639 case MODE_LINE_DISPLAY
:
22640 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22649 /* Store a mode-line string element in mode_line_string_list.
22651 If STRING is non-null, display that C string. Otherwise, the Lisp
22652 string LISP_STRING is displayed.
22654 FIELD_WIDTH is the minimum number of output glyphs to produce.
22655 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22656 with spaces. FIELD_WIDTH <= 0 means don't pad.
22658 PRECISION is the maximum number of characters to output from
22659 STRING. PRECISION <= 0 means don't truncate the string.
22661 If COPY_STRING, make a copy of LISP_STRING before adding
22662 properties to the string.
22664 PROPS are the properties to add to the string.
22665 The mode_line_string_face face property is always added to the string.
22669 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22671 int field_width
, int precision
, Lisp_Object props
)
22676 if (string
!= NULL
)
22678 len
= strlen (string
);
22679 if (precision
> 0 && len
> precision
)
22681 lisp_string
= make_string (string
, len
);
22683 props
= mode_line_string_face_prop
;
22684 else if (!NILP (mode_line_string_face
))
22686 Lisp_Object face
= Fplist_get (props
, Qface
);
22687 props
= Fcopy_sequence (props
);
22689 face
= mode_line_string_face
;
22691 face
= list2 (face
, mode_line_string_face
);
22692 props
= Fplist_put (props
, Qface
, face
);
22694 Fadd_text_properties (make_number (0), make_number (len
),
22695 props
, lisp_string
);
22699 len
= XFASTINT (Flength (lisp_string
));
22700 if (precision
> 0 && len
> precision
)
22703 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22706 if (!NILP (mode_line_string_face
))
22710 props
= Ftext_properties_at (make_number (0), lisp_string
);
22711 face
= Fplist_get (props
, Qface
);
22713 face
= mode_line_string_face
;
22715 face
= list2 (face
, mode_line_string_face
);
22716 props
= list2 (Qface
, face
);
22718 lisp_string
= Fcopy_sequence (lisp_string
);
22721 Fadd_text_properties (make_number (0), make_number (len
),
22722 props
, lisp_string
);
22727 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22731 if (field_width
> len
)
22733 field_width
-= len
;
22734 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22736 Fadd_text_properties (make_number (0), make_number (field_width
),
22737 props
, lisp_string
);
22738 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22746 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22748 doc
: /* Format a string out of a mode line format specification.
22749 First arg FORMAT specifies the mode line format (see `mode-line-format'
22750 for details) to use.
22752 By default, the format is evaluated for the currently selected window.
22754 Optional second arg FACE specifies the face property to put on all
22755 characters for which no face is specified. The value nil means the
22756 default face. The value t means whatever face the window's mode line
22757 currently uses (either `mode-line' or `mode-line-inactive',
22758 depending on whether the window is the selected window or not).
22759 An integer value means the value string has no text
22762 Optional third and fourth args WINDOW and BUFFER specify the window
22763 and buffer to use as the context for the formatting (defaults
22764 are the selected window and the WINDOW's buffer). */)
22765 (Lisp_Object format
, Lisp_Object face
,
22766 Lisp_Object window
, Lisp_Object buffer
)
22771 struct buffer
*old_buffer
= NULL
;
22773 bool no_props
= INTEGERP (face
);
22774 ptrdiff_t count
= SPECPDL_INDEX ();
22776 int string_start
= 0;
22778 w
= decode_any_window (window
);
22779 XSETWINDOW (window
, w
);
22782 buffer
= w
->contents
;
22783 CHECK_BUFFER (buffer
);
22785 /* Make formatting the modeline a non-op when noninteractive, otherwise
22786 there will be problems later caused by a partially initialized frame. */
22787 if (NILP (format
) || noninteractive
)
22788 return empty_unibyte_string
;
22793 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22794 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22795 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22796 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22797 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22798 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22799 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22802 old_buffer
= current_buffer
;
22804 /* Save things including mode_line_proptrans_alist,
22805 and set that to nil so that we don't alter the outer value. */
22806 record_unwind_protect (unwind_format_mode_line
,
22807 format_mode_line_unwind_data
22808 (XFRAME (WINDOW_FRAME (w
)),
22809 old_buffer
, selected_window
, true));
22810 mode_line_proptrans_alist
= Qnil
;
22812 Fselect_window (window
, Qt
);
22813 set_buffer_internal_1 (XBUFFER (buffer
));
22815 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22819 mode_line_target
= MODE_LINE_NOPROP
;
22820 mode_line_string_face_prop
= Qnil
;
22821 mode_line_string_list
= Qnil
;
22822 string_start
= MODE_LINE_NOPROP_LEN (0);
22826 mode_line_target
= MODE_LINE_STRING
;
22827 mode_line_string_list
= Qnil
;
22828 mode_line_string_face
= face
;
22829 mode_line_string_face_prop
22830 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22833 push_kboard (FRAME_KBOARD (it
.f
));
22834 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22839 len
= MODE_LINE_NOPROP_LEN (string_start
);
22840 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22844 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22845 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22846 empty_unibyte_string
);
22849 unbind_to (count
, Qnil
);
22853 /* Write a null-terminated, right justified decimal representation of
22854 the positive integer D to BUF using a minimal field width WIDTH. */
22857 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22859 register char *p
= buf
;
22867 *p
++ = d
% 10 + '0';
22872 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22883 /* Write a null-terminated, right justified decimal and "human
22884 readable" representation of the nonnegative integer D to BUF using
22885 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22887 static const char power_letter
[] =
22901 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22903 /* We aim to represent the nonnegative integer D as
22904 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22905 ptrdiff_t quotient
= d
;
22907 /* -1 means: do not use TENTHS. */
22911 /* Length of QUOTIENT.TENTHS as a string. */
22917 if (quotient
>= 1000)
22919 /* Scale to the appropriate EXPONENT. */
22922 remainder
= quotient
% 1000;
22926 while (quotient
>= 1000);
22928 /* Round to nearest and decide whether to use TENTHS or not. */
22931 tenths
= remainder
/ 100;
22932 if (remainder
% 100 >= 50)
22939 if (quotient
== 10)
22947 if (remainder
>= 500)
22949 if (quotient
< 999)
22960 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22961 if (tenths
== -1 && quotient
<= 99)
22968 p
= psuffix
= buf
+ max (width
, length
);
22970 /* Print EXPONENT. */
22971 *psuffix
++ = power_letter
[exponent
];
22974 /* Print TENTHS. */
22977 *--p
= '0' + tenths
;
22981 /* Print QUOTIENT. */
22984 int digit
= quotient
% 10;
22985 *--p
= '0' + digit
;
22987 while ((quotient
/= 10) != 0);
22989 /* Print leading spaces. */
22994 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22995 If EOL_FLAG, set also a mnemonic character for end-of-line
22996 type of CODING_SYSTEM. Return updated pointer into BUF. */
22998 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23001 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23004 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23005 const unsigned char *eol_str
;
23007 /* The EOL conversion we are using. */
23008 Lisp_Object eoltype
;
23010 val
= CODING_SYSTEM_SPEC (coding_system
);
23013 if (!VECTORP (val
)) /* Not yet decided. */
23015 *buf
++ = multibyte
? '-' : ' ';
23017 eoltype
= eol_mnemonic_undecided
;
23018 /* Don't mention EOL conversion if it isn't decided. */
23023 Lisp_Object eolvalue
;
23025 attrs
= AREF (val
, 0);
23026 eolvalue
= AREF (val
, 2);
23029 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23034 /* The EOL conversion that is normal on this system. */
23036 if (NILP (eolvalue
)) /* Not yet decided. */
23037 eoltype
= eol_mnemonic_undecided
;
23038 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23039 eoltype
= eol_mnemonic_undecided
;
23040 else /* eolvalue is Qunix, Qdos, or Qmac. */
23041 eoltype
= (EQ (eolvalue
, Qunix
)
23042 ? eol_mnemonic_unix
23043 : EQ (eolvalue
, Qdos
)
23044 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23050 /* Mention the EOL conversion if it is not the usual one. */
23051 if (STRINGP (eoltype
))
23053 eol_str
= SDATA (eoltype
);
23054 eol_str_len
= SBYTES (eoltype
);
23056 else if (CHARACTERP (eoltype
))
23058 int c
= XFASTINT (eoltype
);
23059 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23063 eol_str
= invalid_eol_type
;
23064 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23066 memcpy (buf
, eol_str
, eol_str_len
);
23067 buf
+= eol_str_len
;
23073 /* Return a string for the output of a mode line %-spec for window W,
23074 generated by character C. FIELD_WIDTH > 0 means pad the string
23075 returned with spaces to that value. Return a Lisp string in
23076 *STRING if the resulting string is taken from that Lisp string.
23078 Note we operate on the current buffer for most purposes. */
23080 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23082 static const char *
23083 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23084 Lisp_Object
*string
)
23087 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23088 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23089 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23090 produce strings from numerical values, so limit preposterously
23091 large values of FIELD_WIDTH to avoid overrunning the buffer's
23092 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23093 bytes plus the terminating null. */
23094 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23095 struct buffer
*b
= current_buffer
;
23103 if (!NILP (BVAR (b
, read_only
)))
23105 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23110 /* This differs from %* only for a modified read-only buffer. */
23111 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23113 if (!NILP (BVAR (b
, read_only
)))
23118 /* This differs from %* in ignoring read-only-ness. */
23119 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23131 if (command_loop_level
> 5)
23133 p
= decode_mode_spec_buf
;
23134 for (i
= 0; i
< command_loop_level
; i
++)
23137 return decode_mode_spec_buf
;
23145 if (command_loop_level
> 5)
23147 p
= decode_mode_spec_buf
;
23148 for (i
= 0; i
< command_loop_level
; i
++)
23151 return decode_mode_spec_buf
;
23158 /* Let lots_of_dashes be a string of infinite length. */
23159 if (mode_line_target
== MODE_LINE_NOPROP
23160 || mode_line_target
== MODE_LINE_STRING
)
23162 if (field_width
<= 0
23163 || field_width
> sizeof (lots_of_dashes
))
23165 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23166 decode_mode_spec_buf
[i
] = '-';
23167 decode_mode_spec_buf
[i
] = '\0';
23168 return decode_mode_spec_buf
;
23171 return lots_of_dashes
;
23175 obj
= BVAR (b
, name
);
23179 /* %c and %l are ignored in `frame-title-format'.
23180 (In redisplay_internal, the frame title is drawn _before_ the
23181 windows are updated, so the stuff which depends on actual
23182 window contents (such as %l) may fail to render properly, or
23183 even crash emacs.) */
23184 if (mode_line_target
== MODE_LINE_TITLE
)
23188 ptrdiff_t col
= current_column ();
23189 w
->column_number_displayed
= col
;
23190 pint2str (decode_mode_spec_buf
, width
, col
);
23191 return decode_mode_spec_buf
;
23195 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23197 if (NILP (Vmemory_full
))
23200 return "!MEM FULL! ";
23207 /* %F displays the frame name. */
23208 if (!NILP (f
->title
))
23209 return SSDATA (f
->title
);
23210 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23211 return SSDATA (f
->name
);
23215 obj
= BVAR (b
, filename
);
23220 ptrdiff_t size
= ZV
- BEGV
;
23221 pint2str (decode_mode_spec_buf
, width
, size
);
23222 return decode_mode_spec_buf
;
23227 ptrdiff_t size
= ZV
- BEGV
;
23228 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23229 return decode_mode_spec_buf
;
23234 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23235 ptrdiff_t topline
, nlines
, height
;
23238 /* %c and %l are ignored in `frame-title-format'. */
23239 if (mode_line_target
== MODE_LINE_TITLE
)
23242 startpos
= marker_position (w
->start
);
23243 startpos_byte
= marker_byte_position (w
->start
);
23244 height
= WINDOW_TOTAL_LINES (w
);
23246 /* If we decided that this buffer isn't suitable for line numbers,
23247 don't forget that too fast. */
23248 if (w
->base_line_pos
== -1)
23251 /* If the buffer is very big, don't waste time. */
23252 if (INTEGERP (Vline_number_display_limit
)
23253 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23255 w
->base_line_pos
= 0;
23256 w
->base_line_number
= 0;
23260 if (w
->base_line_number
> 0
23261 && w
->base_line_pos
> 0
23262 && w
->base_line_pos
<= startpos
)
23264 line
= w
->base_line_number
;
23265 linepos
= w
->base_line_pos
;
23266 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23271 linepos
= BUF_BEGV (b
);
23272 linepos_byte
= BUF_BEGV_BYTE (b
);
23275 /* Count lines from base line to window start position. */
23276 nlines
= display_count_lines (linepos_byte
,
23280 topline
= nlines
+ line
;
23282 /* Determine a new base line, if the old one is too close
23283 or too far away, or if we did not have one.
23284 "Too close" means it's plausible a scroll-down would
23285 go back past it. */
23286 if (startpos
== BUF_BEGV (b
))
23288 w
->base_line_number
= topline
;
23289 w
->base_line_pos
= BUF_BEGV (b
);
23291 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23292 || linepos
== BUF_BEGV (b
))
23294 ptrdiff_t limit
= BUF_BEGV (b
);
23295 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23296 ptrdiff_t position
;
23297 ptrdiff_t distance
=
23298 (height
* 2 + 30) * line_number_display_limit_width
;
23300 if (startpos
- distance
> limit
)
23302 limit
= startpos
- distance
;
23303 limit_byte
= CHAR_TO_BYTE (limit
);
23306 nlines
= display_count_lines (startpos_byte
,
23308 - (height
* 2 + 30),
23310 /* If we couldn't find the lines we wanted within
23311 line_number_display_limit_width chars per line,
23312 give up on line numbers for this window. */
23313 if (position
== limit_byte
&& limit
== startpos
- distance
)
23315 w
->base_line_pos
= -1;
23316 w
->base_line_number
= 0;
23320 w
->base_line_number
= topline
- nlines
;
23321 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23324 /* Now count lines from the start pos to point. */
23325 nlines
= display_count_lines (startpos_byte
,
23326 PT_BYTE
, PT
, &junk
);
23328 /* Record that we did display the line number. */
23329 line_number_displayed
= true;
23331 /* Make the string to show. */
23332 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23333 return decode_mode_spec_buf
;
23336 char *p
= decode_mode_spec_buf
;
23337 int pad
= width
- 2;
23343 return decode_mode_spec_buf
;
23349 obj
= BVAR (b
, mode_name
);
23353 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23359 ptrdiff_t pos
= marker_position (w
->start
);
23360 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23362 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23364 if (pos
<= BUF_BEGV (b
))
23369 else if (pos
<= BUF_BEGV (b
))
23373 if (total
> 1000000)
23374 /* Do it differently for a large value, to avoid overflow. */
23375 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23377 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23378 /* We can't normally display a 3-digit number,
23379 so get us a 2-digit number that is close. */
23382 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23383 return decode_mode_spec_buf
;
23387 /* Display percentage of size above the bottom of the screen. */
23390 ptrdiff_t toppos
= marker_position (w
->start
);
23391 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23392 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23394 if (botpos
>= BUF_ZV (b
))
23396 if (toppos
<= BUF_BEGV (b
))
23403 if (total
> 1000000)
23404 /* Do it differently for a large value, to avoid overflow. */
23405 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23407 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23408 /* We can't normally display a 3-digit number,
23409 so get us a 2-digit number that is close. */
23412 if (toppos
<= BUF_BEGV (b
))
23413 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23415 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23416 return decode_mode_spec_buf
;
23421 /* status of process */
23422 obj
= Fget_buffer_process (Fcurrent_buffer ());
23424 return "no process";
23426 obj
= Fsymbol_name (Fprocess_status (obj
));
23432 ptrdiff_t count
= inhibit_garbage_collection ();
23433 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23434 Lisp_Object val
= Qnil
;
23436 if (STRINGP (curdir
))
23437 val
= call1 (intern ("file-remote-p"), curdir
);
23439 unbind_to (count
, Qnil
);
23448 /* coding-system (not including end-of-line format) */
23450 /* coding-system (including end-of-line type) */
23452 bool eol_flag
= (c
== 'Z');
23453 char *p
= decode_mode_spec_buf
;
23455 if (! FRAME_WINDOW_P (f
))
23457 /* No need to mention EOL here--the terminal never needs
23458 to do EOL conversion. */
23459 p
= decode_mode_spec_coding (CODING_ID_NAME
23460 (FRAME_KEYBOARD_CODING (f
)->id
),
23462 p
= decode_mode_spec_coding (CODING_ID_NAME
23463 (FRAME_TERMINAL_CODING (f
)->id
),
23466 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23469 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23470 #ifdef subprocesses
23471 obj
= Fget_buffer_process (Fcurrent_buffer ());
23472 if (PROCESSP (obj
))
23474 p
= decode_mode_spec_coding
23475 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23476 p
= decode_mode_spec_coding
23477 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23479 #endif /* subprocesses */
23482 return decode_mode_spec_buf
;
23489 return SSDATA (obj
);
23496 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23497 means count lines back from START_BYTE. But don't go beyond
23498 LIMIT_BYTE. Return the number of lines thus found (always
23501 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23502 either the position COUNT lines after/before START_BYTE, if we
23503 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23507 display_count_lines (ptrdiff_t start_byte
,
23508 ptrdiff_t limit_byte
, ptrdiff_t count
,
23509 ptrdiff_t *byte_pos_ptr
)
23511 register unsigned char *cursor
;
23512 unsigned char *base
;
23514 register ptrdiff_t ceiling
;
23515 register unsigned char *ceiling_addr
;
23516 ptrdiff_t orig_count
= count
;
23518 /* If we are not in selective display mode,
23519 check only for newlines. */
23520 bool selective_display
23521 = (!NILP (BVAR (current_buffer
, selective_display
))
23522 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23526 while (start_byte
< limit_byte
)
23528 ceiling
= BUFFER_CEILING_OF (start_byte
);
23529 ceiling
= min (limit_byte
- 1, ceiling
);
23530 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23531 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23535 if (selective_display
)
23537 while (*cursor
!= '\n' && *cursor
!= 015
23538 && ++cursor
!= ceiling_addr
)
23540 if (cursor
== ceiling_addr
)
23545 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23554 start_byte
+= cursor
- base
;
23555 *byte_pos_ptr
= start_byte
;
23559 while (cursor
< ceiling_addr
);
23561 start_byte
+= ceiling_addr
- base
;
23566 while (start_byte
> limit_byte
)
23568 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23569 ceiling
= max (limit_byte
, ceiling
);
23570 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23571 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23574 if (selective_display
)
23576 while (--cursor
>= ceiling_addr
23577 && *cursor
!= '\n' && *cursor
!= 015)
23579 if (cursor
< ceiling_addr
)
23584 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23591 start_byte
+= cursor
- base
+ 1;
23592 *byte_pos_ptr
= start_byte
;
23593 /* When scanning backwards, we should
23594 not count the newline posterior to which we stop. */
23595 return - orig_count
- 1;
23598 start_byte
+= ceiling_addr
- base
;
23602 *byte_pos_ptr
= limit_byte
;
23605 return - orig_count
+ count
;
23606 return orig_count
- count
;
23612 /***********************************************************************
23614 ***********************************************************************/
23616 /* Display a NUL-terminated string, starting with index START.
23618 If STRING is non-null, display that C string. Otherwise, the Lisp
23619 string LISP_STRING is displayed. There's a case that STRING is
23620 non-null and LISP_STRING is not nil. It means STRING is a string
23621 data of LISP_STRING. In that case, we display LISP_STRING while
23622 ignoring its text properties.
23624 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23625 FACE_STRING. Display STRING or LISP_STRING with the face at
23626 FACE_STRING_POS in FACE_STRING:
23628 Display the string in the environment given by IT, but use the
23629 standard display table, temporarily.
23631 FIELD_WIDTH is the minimum number of output glyphs to produce.
23632 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23633 with spaces. If STRING has more characters, more than FIELD_WIDTH
23634 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23636 PRECISION is the maximum number of characters to output from
23637 STRING. PRECISION < 0 means don't truncate the string.
23639 This is roughly equivalent to printf format specifiers:
23641 FIELD_WIDTH PRECISION PRINTF
23642 ----------------------------------------
23648 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23649 display them, and < 0 means obey the current buffer's value of
23650 enable_multibyte_characters.
23652 Value is the number of columns displayed. */
23655 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23656 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23657 int field_width
, int precision
, int max_x
, int multibyte
)
23659 int hpos_at_start
= it
->hpos
;
23660 int saved_face_id
= it
->face_id
;
23661 struct glyph_row
*row
= it
->glyph_row
;
23662 ptrdiff_t it_charpos
;
23664 /* Initialize the iterator IT for iteration over STRING beginning
23665 with index START. */
23666 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23667 precision
, field_width
, multibyte
);
23668 if (string
&& STRINGP (lisp_string
))
23669 /* LISP_STRING is the one returned by decode_mode_spec. We should
23670 ignore its text properties. */
23671 it
->stop_charpos
= it
->end_charpos
;
23673 /* If displaying STRING, set up the face of the iterator from
23674 FACE_STRING, if that's given. */
23675 if (STRINGP (face_string
))
23681 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23682 0, &endptr
, it
->base_face_id
, false);
23683 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23684 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23687 /* Set max_x to the maximum allowed X position. Don't let it go
23688 beyond the right edge of the window. */
23690 max_x
= it
->last_visible_x
;
23692 max_x
= min (max_x
, it
->last_visible_x
);
23694 /* Skip over display elements that are not visible. because IT->w is
23696 if (it
->current_x
< it
->first_visible_x
)
23697 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23698 MOVE_TO_POS
| MOVE_TO_X
);
23700 row
->ascent
= it
->max_ascent
;
23701 row
->height
= it
->max_ascent
+ it
->max_descent
;
23702 row
->phys_ascent
= it
->max_phys_ascent
;
23703 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23704 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23706 if (STRINGP (it
->string
))
23707 it_charpos
= IT_STRING_CHARPOS (*it
);
23709 it_charpos
= IT_CHARPOS (*it
);
23711 /* This condition is for the case that we are called with current_x
23712 past last_visible_x. */
23713 while (it
->current_x
< max_x
)
23715 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23717 /* Get the next display element. */
23718 if (!get_next_display_element (it
))
23721 /* Produce glyphs. */
23722 x_before
= it
->current_x
;
23723 n_glyphs_before
= row
->used
[TEXT_AREA
];
23724 PRODUCE_GLYPHS (it
);
23726 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23729 while (i
< nglyphs
)
23731 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23733 if (it
->line_wrap
!= TRUNCATE
23734 && x
+ glyph
->pixel_width
> max_x
)
23736 /* End of continued line or max_x reached. */
23737 if (CHAR_GLYPH_PADDING_P (*glyph
))
23739 /* A wide character is unbreakable. */
23740 if (row
->reversed_p
)
23741 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23742 - n_glyphs_before
);
23743 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23744 it
->current_x
= x_before
;
23748 if (row
->reversed_p
)
23749 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23750 - (n_glyphs_before
+ i
));
23751 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23756 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23758 /* Glyph is at least partially visible. */
23760 if (x
< it
->first_visible_x
)
23761 row
->x
= x
- it
->first_visible_x
;
23765 /* Glyph is off the left margin of the display area.
23766 Should not happen. */
23770 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23771 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23772 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23773 row
->phys_height
= max (row
->phys_height
,
23774 it
->max_phys_ascent
+ it
->max_phys_descent
);
23775 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23776 it
->max_extra_line_spacing
);
23777 x
+= glyph
->pixel_width
;
23781 /* Stop if max_x reached. */
23785 /* Stop at line ends. */
23786 if (ITERATOR_AT_END_OF_LINE_P (it
))
23788 it
->continuation_lines_width
= 0;
23792 set_iterator_to_next (it
, true);
23793 if (STRINGP (it
->string
))
23794 it_charpos
= IT_STRING_CHARPOS (*it
);
23796 it_charpos
= IT_CHARPOS (*it
);
23798 /* Stop if truncating at the right edge. */
23799 if (it
->line_wrap
== TRUNCATE
23800 && it
->current_x
>= it
->last_visible_x
)
23802 /* Add truncation mark, but don't do it if the line is
23803 truncated at a padding space. */
23804 if (it_charpos
< it
->string_nchars
)
23806 if (!FRAME_WINDOW_P (it
->f
))
23810 if (it
->current_x
> it
->last_visible_x
)
23812 if (!row
->reversed_p
)
23814 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23815 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23820 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23821 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23823 unproduce_glyphs (it
, ii
+ 1);
23824 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23826 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23828 row
->used
[TEXT_AREA
] = ii
;
23829 produce_special_glyphs (it
, IT_TRUNCATION
);
23832 produce_special_glyphs (it
, IT_TRUNCATION
);
23834 row
->truncated_on_right_p
= true;
23840 /* Maybe insert a truncation at the left. */
23841 if (it
->first_visible_x
23844 if (!FRAME_WINDOW_P (it
->f
)
23845 || (row
->reversed_p
23846 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23847 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23848 insert_left_trunc_glyphs (it
);
23849 row
->truncated_on_left_p
= true;
23852 it
->face_id
= saved_face_id
;
23854 /* Value is number of columns displayed. */
23855 return it
->hpos
- hpos_at_start
;
23860 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23861 appears as an element of LIST or as the car of an element of LIST.
23862 If PROPVAL is a list, compare each element against LIST in that
23863 way, and return 1/2 if any element of PROPVAL is found in LIST.
23864 Otherwise return 0. This function cannot quit.
23865 The return value is 2 if the text is invisible but with an ellipsis
23866 and 1 if it's invisible and without an ellipsis. */
23869 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23871 Lisp_Object tail
, proptail
;
23873 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23875 register Lisp_Object tem
;
23877 if (EQ (propval
, tem
))
23879 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23880 return NILP (XCDR (tem
)) ? 1 : 2;
23883 if (CONSP (propval
))
23885 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23887 Lisp_Object propelt
;
23888 propelt
= XCAR (proptail
);
23889 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23891 register Lisp_Object tem
;
23893 if (EQ (propelt
, tem
))
23895 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23896 return NILP (XCDR (tem
)) ? 1 : 2;
23904 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23905 doc
: /* Non-nil if the property makes the text invisible.
23906 POS-OR-PROP can be a marker or number, in which case it is taken to be
23907 a position in the current buffer and the value of the `invisible' property
23908 is checked; or it can be some other value, which is then presumed to be the
23909 value of the `invisible' property of the text of interest.
23910 The non-nil value returned can be t for truly invisible text or something
23911 else if the text is replaced by an ellipsis. */)
23912 (Lisp_Object pos_or_prop
)
23915 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23916 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23918 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23919 return (invis
== 0 ? Qnil
23921 : make_number (invis
));
23924 /* Calculate a width or height in pixels from a specification using
23925 the following elements:
23928 NUM - a (fractional) multiple of the default font width/height
23929 (NUM) - specifies exactly NUM pixels
23930 UNIT - a fixed number of pixels, see below.
23931 ELEMENT - size of a display element in pixels, see below.
23932 (NUM . SPEC) - equals NUM * SPEC
23933 (+ SPEC SPEC ...) - add pixel values
23934 (- SPEC SPEC ...) - subtract pixel values
23935 (- SPEC) - negate pixel value
23938 INT or FLOAT - a number constant
23939 SYMBOL - use symbol's (buffer local) variable binding.
23942 in - pixels per inch *)
23943 mm - pixels per 1/1000 meter *)
23944 cm - pixels per 1/100 meter *)
23945 width - width of current font in pixels.
23946 height - height of current font in pixels.
23948 *) using the ratio(s) defined in display-pixels-per-inch.
23952 left-fringe - left fringe width in pixels
23953 right-fringe - right fringe width in pixels
23955 left-margin - left margin width in pixels
23956 right-margin - right margin width in pixels
23958 scroll-bar - scroll-bar area width in pixels
23962 Pixels corresponding to 5 inches:
23965 Total width of non-text areas on left side of window (if scroll-bar is on left):
23966 '(space :width (+ left-fringe left-margin scroll-bar))
23968 Align to first text column (in header line):
23969 '(space :align-to 0)
23971 Align to middle of text area minus half the width of variable `my-image'
23972 containing a loaded image:
23973 '(space :align-to (0.5 . (- text my-image)))
23975 Width of left margin minus width of 1 character in the default font:
23976 '(space :width (- left-margin 1))
23978 Width of left margin minus width of 2 characters in the current font:
23979 '(space :width (- left-margin (2 . width)))
23981 Center 1 character over left-margin (in header line):
23982 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23984 Different ways to express width of left fringe plus left margin minus one pixel:
23985 '(space :width (- (+ left-fringe left-margin) (1)))
23986 '(space :width (+ left-fringe left-margin (- (1))))
23987 '(space :width (+ left-fringe left-margin (-1)))
23992 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23993 struct font
*font
, bool width_p
, int *align_to
)
23997 # define OK_PIXELS(val) (*res = (val), true)
23998 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24001 return OK_PIXELS (0);
24003 eassert (FRAME_LIVE_P (it
->f
));
24005 if (SYMBOLP (prop
))
24007 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24009 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24011 if (unit
[0] == 'i' && unit
[1] == 'n')
24013 else if (unit
[0] == 'm' && unit
[1] == 'm')
24015 else if (unit
[0] == 'c' && unit
[1] == 'm')
24021 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24022 : FRAME_RES_Y (it
->f
));
24025 return OK_PIXELS (ppi
/ pixels
);
24030 #ifdef HAVE_WINDOW_SYSTEM
24031 if (EQ (prop
, Qheight
))
24032 return OK_PIXELS (font
24033 ? normal_char_height (font
, -1)
24034 : FRAME_LINE_HEIGHT (it
->f
));
24035 if (EQ (prop
, Qwidth
))
24036 return OK_PIXELS (font
24037 ? FONT_WIDTH (font
)
24038 : FRAME_COLUMN_WIDTH (it
->f
));
24040 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24041 return OK_PIXELS (1);
24044 if (EQ (prop
, Qtext
))
24045 return OK_PIXELS (width_p
24046 ? window_box_width (it
->w
, TEXT_AREA
)
24047 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24049 if (align_to
&& *align_to
< 0)
24052 if (EQ (prop
, Qleft
))
24053 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24054 if (EQ (prop
, Qright
))
24055 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24056 if (EQ (prop
, Qcenter
))
24057 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24058 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24059 if (EQ (prop
, Qleft_fringe
))
24060 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24061 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24062 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24063 if (EQ (prop
, Qright_fringe
))
24064 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24065 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24066 : window_box_right_offset (it
->w
, TEXT_AREA
));
24067 if (EQ (prop
, Qleft_margin
))
24068 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24069 if (EQ (prop
, Qright_margin
))
24070 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24071 if (EQ (prop
, Qscroll_bar
))
24072 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24074 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24075 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24076 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24081 if (EQ (prop
, Qleft_fringe
))
24082 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24083 if (EQ (prop
, Qright_fringe
))
24084 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24085 if (EQ (prop
, Qleft_margin
))
24086 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24087 if (EQ (prop
, Qright_margin
))
24088 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24089 if (EQ (prop
, Qscroll_bar
))
24090 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24093 prop
= buffer_local_value (prop
, it
->w
->contents
);
24094 if (EQ (prop
, Qunbound
))
24098 if (INTEGERP (prop
) || FLOATP (prop
))
24100 int base_unit
= (width_p
24101 ? FRAME_COLUMN_WIDTH (it
->f
)
24102 : FRAME_LINE_HEIGHT (it
->f
));
24103 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24108 Lisp_Object car
= XCAR (prop
);
24109 Lisp_Object cdr
= XCDR (prop
);
24113 #ifdef HAVE_WINDOW_SYSTEM
24114 if (FRAME_WINDOW_P (it
->f
)
24115 && valid_image_p (prop
))
24117 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24118 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24120 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24123 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24129 while (CONSP (cdr
))
24131 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24132 font
, width_p
, align_to
))
24135 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24140 if (EQ (car
, Qminus
))
24142 return OK_PIXELS (pixels
);
24145 car
= buffer_local_value (car
, it
->w
->contents
);
24146 if (EQ (car
, Qunbound
))
24150 if (INTEGERP (car
) || FLOATP (car
))
24153 pixels
= XFLOATINT (car
);
24155 return OK_PIXELS (pixels
);
24156 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24157 font
, width_p
, align_to
))
24158 return OK_PIXELS (pixels
* fact
);
24169 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24171 #ifdef HAVE_WINDOW_SYSTEM
24172 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24180 /***********************************************************************
24182 ***********************************************************************/
24184 #ifdef HAVE_WINDOW_SYSTEM
24189 dump_glyph_string (struct glyph_string
*s
)
24191 fprintf (stderr
, "glyph string\n");
24192 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24193 s
->x
, s
->y
, s
->width
, s
->height
);
24194 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24195 fprintf (stderr
, " hl = %d\n", s
->hl
);
24196 fprintf (stderr
, " left overhang = %d, right = %d\n",
24197 s
->left_overhang
, s
->right_overhang
);
24198 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24199 fprintf (stderr
, " extends to end of line = %d\n",
24200 s
->extends_to_end_of_line_p
);
24201 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24202 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24205 #endif /* GLYPH_DEBUG */
24207 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24208 of XChar2b structures for S; it can't be allocated in
24209 init_glyph_string because it must be allocated via `alloca'. W
24210 is the window on which S is drawn. ROW and AREA are the glyph row
24211 and area within the row from which S is constructed. START is the
24212 index of the first glyph structure covered by S. HL is a
24213 face-override for drawing S. */
24216 #define OPTIONAL_HDC(hdc) HDC hdc,
24217 #define DECLARE_HDC(hdc) HDC hdc;
24218 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24219 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24222 #ifndef OPTIONAL_HDC
24223 #define OPTIONAL_HDC(hdc)
24224 #define DECLARE_HDC(hdc)
24225 #define ALLOCATE_HDC(hdc, f)
24226 #define RELEASE_HDC(hdc, f)
24230 init_glyph_string (struct glyph_string
*s
,
24232 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24233 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24235 memset (s
, 0, sizeof *s
);
24237 s
->f
= XFRAME (w
->frame
);
24241 s
->display
= FRAME_X_DISPLAY (s
->f
);
24242 s
->window
= FRAME_X_WINDOW (s
->f
);
24243 s
->char2b
= char2b
;
24247 s
->first_glyph
= row
->glyphs
[area
] + start
;
24248 s
->height
= row
->height
;
24249 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24250 s
->ybase
= s
->y
+ row
->ascent
;
24254 /* Append the list of glyph strings with head H and tail T to the list
24255 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24258 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24259 struct glyph_string
*h
, struct glyph_string
*t
)
24273 /* Prepend the list of glyph strings with head H and tail T to the
24274 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24278 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24279 struct glyph_string
*h
, struct glyph_string
*t
)
24293 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24294 Set *HEAD and *TAIL to the resulting list. */
24297 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24298 struct glyph_string
*s
)
24300 s
->next
= s
->prev
= NULL
;
24301 append_glyph_string_lists (head
, tail
, s
, s
);
24305 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24306 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24307 make sure that X resources for the face returned are allocated.
24308 Value is a pointer to a realized face that is ready for display if
24311 static struct face
*
24312 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24313 XChar2b
*char2b
, bool display_p
)
24315 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24320 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24322 if (code
== FONT_INVALID_CODE
)
24325 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24327 /* Make sure X resources of the face are allocated. */
24328 #ifdef HAVE_X_WINDOWS
24332 eassert (face
!= NULL
);
24333 prepare_face_for_display (f
, face
);
24340 /* Get face and two-byte form of character glyph GLYPH on frame F.
24341 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24342 a pointer to a realized face that is ready for display. */
24344 static struct face
*
24345 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24351 eassert (glyph
->type
== CHAR_GLYPH
);
24352 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24354 /* Make sure X resources of the face are allocated. */
24355 eassert (face
!= NULL
);
24356 prepare_face_for_display (f
, face
);
24360 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24361 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24363 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24365 if (code
== FONT_INVALID_CODE
)
24369 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24374 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24375 Return true iff FONT has a glyph for C. */
24378 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24382 if (CHAR_BYTE8_P (c
))
24383 code
= CHAR_TO_BYTE8 (c
);
24385 code
= font
->driver
->encode_char (font
, c
);
24387 if (code
== FONT_INVALID_CODE
)
24389 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24394 /* Fill glyph string S with composition components specified by S->cmp.
24396 BASE_FACE is the base face of the composition.
24397 S->cmp_from is the index of the first component for S.
24399 OVERLAPS non-zero means S should draw the foreground only, and use
24400 its physical height for clipping. See also draw_glyphs.
24402 Value is the index of a component not in S. */
24405 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24409 /* For all glyphs of this composition, starting at the offset
24410 S->cmp_from, until we reach the end of the definition or encounter a
24411 glyph that requires the different face, add it to S. */
24416 s
->for_overlaps
= overlaps
;
24419 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24421 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24423 /* TAB in a composition means display glyphs with padding space
24424 on the left or right. */
24427 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24430 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24431 s
->char2b
+ i
, true);
24437 s
->font
= s
->face
->font
;
24439 else if (s
->face
!= face
)
24447 if (s
->face
== NULL
)
24449 s
->face
= base_face
->ascii_face
;
24450 s
->font
= s
->face
->font
;
24453 /* All glyph strings for the same composition has the same width,
24454 i.e. the width set for the first component of the composition. */
24455 s
->width
= s
->first_glyph
->pixel_width
;
24457 /* If the specified font could not be loaded, use the frame's
24458 default font, but record the fact that we couldn't load it in
24459 the glyph string so that we can draw rectangles for the
24460 characters of the glyph string. */
24461 if (s
->font
== NULL
)
24463 s
->font_not_found_p
= true;
24464 s
->font
= FRAME_FONT (s
->f
);
24467 /* Adjust base line for subscript/superscript text. */
24468 s
->ybase
+= s
->first_glyph
->voffset
;
24474 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24475 int start
, int end
, int overlaps
)
24477 struct glyph
*glyph
, *last
;
24478 Lisp_Object lgstring
;
24481 s
->for_overlaps
= overlaps
;
24482 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24483 last
= s
->row
->glyphs
[s
->area
] + end
;
24484 s
->cmp_id
= glyph
->u
.cmp
.id
;
24485 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24486 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24487 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24488 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24489 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24491 while (glyph
< last
24492 && glyph
->u
.cmp
.automatic
24493 && glyph
->u
.cmp
.id
== s
->cmp_id
24494 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24495 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24497 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24499 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24500 unsigned code
= LGLYPH_CODE (lglyph
);
24502 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24504 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24505 return glyph
- s
->row
->glyphs
[s
->area
];
24509 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24510 See the comment of fill_glyph_string for arguments.
24511 Value is the index of the first glyph not in S. */
24515 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24516 int start
, int end
, int overlaps
)
24518 struct glyph
*glyph
, *last
;
24521 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24522 s
->for_overlaps
= overlaps
;
24523 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24524 last
= s
->row
->glyphs
[s
->area
] + end
;
24525 voffset
= glyph
->voffset
;
24526 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24527 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24529 s
->width
= glyph
->pixel_width
;
24531 while (glyph
< last
24532 && glyph
->type
== GLYPHLESS_GLYPH
24533 && glyph
->voffset
== voffset
24534 && glyph
->face_id
== face_id
)
24537 s
->width
+= glyph
->pixel_width
;
24540 s
->ybase
+= voffset
;
24541 return glyph
- s
->row
->glyphs
[s
->area
];
24545 /* Fill glyph string S from a sequence of character glyphs.
24547 FACE_ID is the face id of the string. START is the index of the
24548 first glyph to consider, END is the index of the last + 1.
24549 OVERLAPS non-zero means S should draw the foreground only, and use
24550 its physical height for clipping. See also draw_glyphs.
24552 Value is the index of the first glyph not in S. */
24555 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24556 int start
, int end
, int overlaps
)
24558 struct glyph
*glyph
, *last
;
24560 bool glyph_not_available_p
;
24562 eassert (s
->f
== XFRAME (s
->w
->frame
));
24563 eassert (s
->nchars
== 0);
24564 eassert (start
>= 0 && end
> start
);
24566 s
->for_overlaps
= overlaps
;
24567 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24568 last
= s
->row
->glyphs
[s
->area
] + end
;
24569 voffset
= glyph
->voffset
;
24570 s
->padding_p
= glyph
->padding_p
;
24571 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24573 while (glyph
< last
24574 && glyph
->type
== CHAR_GLYPH
24575 && glyph
->voffset
== voffset
24576 /* Same face id implies same font, nowadays. */
24577 && glyph
->face_id
== face_id
24578 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24580 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24581 s
->char2b
+ s
->nchars
);
24583 eassert (s
->nchars
<= end
- start
);
24584 s
->width
+= glyph
->pixel_width
;
24585 if (glyph
++->padding_p
!= s
->padding_p
)
24589 s
->font
= s
->face
->font
;
24591 /* If the specified font could not be loaded, use the frame's font,
24592 but record the fact that we couldn't load it in
24593 S->font_not_found_p so that we can draw rectangles for the
24594 characters of the glyph string. */
24595 if (s
->font
== NULL
|| glyph_not_available_p
)
24597 s
->font_not_found_p
= true;
24598 s
->font
= FRAME_FONT (s
->f
);
24601 /* Adjust base line for subscript/superscript text. */
24602 s
->ybase
+= voffset
;
24604 eassert (s
->face
&& s
->face
->gc
);
24605 return glyph
- s
->row
->glyphs
[s
->area
];
24609 /* Fill glyph string S from image glyph S->first_glyph. */
24612 fill_image_glyph_string (struct glyph_string
*s
)
24614 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24615 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24617 s
->slice
= s
->first_glyph
->slice
.img
;
24618 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24619 s
->font
= s
->face
->font
;
24620 s
->width
= s
->first_glyph
->pixel_width
;
24622 /* Adjust base line for subscript/superscript text. */
24623 s
->ybase
+= s
->first_glyph
->voffset
;
24627 /* Fill glyph string S from a sequence of stretch glyphs.
24629 START is the index of the first glyph to consider,
24630 END is the index of the last + 1.
24632 Value is the index of the first glyph not in S. */
24635 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24637 struct glyph
*glyph
, *last
;
24638 int voffset
, face_id
;
24640 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24642 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24643 last
= s
->row
->glyphs
[s
->area
] + end
;
24644 face_id
= glyph
->face_id
;
24645 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24646 s
->font
= s
->face
->font
;
24647 s
->width
= glyph
->pixel_width
;
24649 voffset
= glyph
->voffset
;
24653 && glyph
->type
== STRETCH_GLYPH
24654 && glyph
->voffset
== voffset
24655 && glyph
->face_id
== face_id
);
24657 s
->width
+= glyph
->pixel_width
;
24659 /* Adjust base line for subscript/superscript text. */
24660 s
->ybase
+= voffset
;
24662 /* The case that face->gc == 0 is handled when drawing the glyph
24663 string by calling prepare_face_for_display. */
24665 return glyph
- s
->row
->glyphs
[s
->area
];
24668 static struct font_metrics
*
24669 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24671 static struct font_metrics metrics
;
24676 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24677 if (code
== FONT_INVALID_CODE
)
24679 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24683 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24684 for FONT. Values are taken from font-global ones, except for fonts
24685 that claim preposterously large values, but whose glyphs actually
24686 have reasonable dimensions. C is the character to use for metrics
24687 if the font-global values are too large; if C is negative, the
24688 function selects a default character. */
24690 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24692 *ascent
= FONT_BASE (font
);
24693 *descent
= FONT_DESCENT (font
);
24695 if (FONT_TOO_HIGH (font
))
24699 /* Get metrics of C, defaulting to a reasonably sized ASCII
24701 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24703 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24705 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24707 /* We add 1 pixel to character dimensions as heuristics
24708 that produces nicer display, e.g. when the face has
24709 the box attribute. */
24710 *ascent
= pcm
->ascent
+ 1;
24711 *descent
= pcm
->descent
+ 1;
24717 /* A subroutine that computes a reasonable "normal character height"
24718 for fonts that claim preposterously large vertical dimensions, but
24719 whose glyphs are actually reasonably sized. C is the character
24720 whose metrics to use for those fonts, or -1 for default
24723 normal_char_height (struct font
*font
, int c
)
24725 int ascent
, descent
;
24727 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24729 return ascent
+ descent
;
24733 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24734 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24735 assumed to be zero. */
24738 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24740 *left
= *right
= 0;
24742 if (glyph
->type
== CHAR_GLYPH
)
24745 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24748 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24751 if (pcm
->rbearing
> pcm
->width
)
24752 *right
= pcm
->rbearing
- pcm
->width
;
24753 if (pcm
->lbearing
< 0)
24754 *left
= -pcm
->lbearing
;
24758 else if (glyph
->type
== COMPOSITE_GLYPH
)
24760 if (! glyph
->u
.cmp
.automatic
)
24762 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24764 if (cmp
->rbearing
> cmp
->pixel_width
)
24765 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24766 if (cmp
->lbearing
< 0)
24767 *left
= - cmp
->lbearing
;
24771 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24772 struct font_metrics metrics
;
24774 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24775 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24776 if (metrics
.rbearing
> metrics
.width
)
24777 *right
= metrics
.rbearing
- metrics
.width
;
24778 if (metrics
.lbearing
< 0)
24779 *left
= - metrics
.lbearing
;
24785 /* Return the index of the first glyph preceding glyph string S that
24786 is overwritten by S because of S's left overhang. Value is -1
24787 if no glyphs are overwritten. */
24790 left_overwritten (struct glyph_string
*s
)
24794 if (s
->left_overhang
)
24797 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24798 int first
= s
->first_glyph
- glyphs
;
24800 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24801 x
-= glyphs
[i
].pixel_width
;
24812 /* Return the index of the first glyph preceding glyph string S that
24813 is overwriting S because of its right overhang. Value is -1 if no
24814 glyph in front of S overwrites S. */
24817 left_overwriting (struct glyph_string
*s
)
24820 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24821 int first
= s
->first_glyph
- glyphs
;
24825 for (i
= first
- 1; i
>= 0; --i
)
24828 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24831 x
-= glyphs
[i
].pixel_width
;
24838 /* Return the index of the last glyph following glyph string S that is
24839 overwritten by S because of S's right overhang. Value is -1 if
24840 no such glyph is found. */
24843 right_overwritten (struct glyph_string
*s
)
24847 if (s
->right_overhang
)
24850 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24851 int first
= (s
->first_glyph
- glyphs
24852 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24853 int end
= s
->row
->used
[s
->area
];
24855 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24856 x
+= glyphs
[i
].pixel_width
;
24865 /* Return the index of the last glyph following glyph string S that
24866 overwrites S because of its left overhang. Value is negative
24867 if no such glyph is found. */
24870 right_overwriting (struct glyph_string
*s
)
24873 int end
= s
->row
->used
[s
->area
];
24874 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24875 int first
= (s
->first_glyph
- glyphs
24876 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24880 for (i
= first
; i
< end
; ++i
)
24883 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24886 x
+= glyphs
[i
].pixel_width
;
24893 /* Set background width of glyph string S. START is the index of the
24894 first glyph following S. LAST_X is the right-most x-position + 1
24895 in the drawing area. */
24898 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24900 /* If the face of this glyph string has to be drawn to the end of
24901 the drawing area, set S->extends_to_end_of_line_p. */
24903 if (start
== s
->row
->used
[s
->area
]
24904 && ((s
->row
->fill_line_p
24905 && (s
->hl
== DRAW_NORMAL_TEXT
24906 || s
->hl
== DRAW_IMAGE_RAISED
24907 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24908 || s
->hl
== DRAW_MOUSE_FACE
))
24909 s
->extends_to_end_of_line_p
= true;
24911 /* If S extends its face to the end of the line, set its
24912 background_width to the distance to the right edge of the drawing
24914 if (s
->extends_to_end_of_line_p
)
24915 s
->background_width
= last_x
- s
->x
+ 1;
24917 s
->background_width
= s
->width
;
24921 /* Compute overhangs and x-positions for glyph string S and its
24922 predecessors, or successors. X is the starting x-position for S.
24923 BACKWARD_P means process predecessors. */
24926 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24932 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24933 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24943 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24944 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24954 /* The following macros are only called from draw_glyphs below.
24955 They reference the following parameters of that function directly:
24956 `w', `row', `area', and `overlap_p'
24957 as well as the following local variables:
24958 `s', `f', and `hdc' (in W32) */
24961 /* On W32, silently add local `hdc' variable to argument list of
24962 init_glyph_string. */
24963 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24964 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24966 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24967 init_glyph_string (s, char2b, w, row, area, start, hl)
24970 /* Add a glyph string for a stretch glyph to the list of strings
24971 between HEAD and TAIL. START is the index of the stretch glyph in
24972 row area AREA of glyph row ROW. END is the index of the last glyph
24973 in that glyph row area. X is the current output position assigned
24974 to the new glyph string constructed. HL overrides that face of the
24975 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24976 is the right-most x-position of the drawing area. */
24978 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24979 and below -- keep them on one line. */
24980 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24983 s = alloca (sizeof *s); \
24984 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24985 START = fill_stretch_glyph_string (s, START, END); \
24986 append_glyph_string (&HEAD, &TAIL, s); \
24992 /* Add a glyph string for an image glyph to the list of strings
24993 between HEAD and TAIL. START is the index of the image glyph in
24994 row area AREA of glyph row ROW. END is the index of the last glyph
24995 in that glyph row area. X is the current output position assigned
24996 to the new glyph string constructed. HL overrides that face of the
24997 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24998 is the right-most x-position of the drawing area. */
25000 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25003 s = alloca (sizeof *s); \
25004 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25005 fill_image_glyph_string (s); \
25006 append_glyph_string (&HEAD, &TAIL, s); \
25013 /* Add a glyph string for a sequence of character glyphs to the list
25014 of strings between HEAD and TAIL. START is the index of the first
25015 glyph in row area AREA of glyph row ROW that is part of the new
25016 glyph string. END is the index of the last glyph in that glyph row
25017 area. X is the current output position assigned to the new glyph
25018 string constructed. HL overrides that face of the glyph; e.g. it
25019 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25020 right-most x-position of the drawing area. */
25022 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25028 face_id = (row)->glyphs[area][START].face_id; \
25030 s = alloca (sizeof *s); \
25031 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25032 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25033 append_glyph_string (&HEAD, &TAIL, s); \
25035 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25040 /* Add a glyph string for a composite sequence to the list of strings
25041 between HEAD and TAIL. START is the index of the first glyph in
25042 row area AREA of glyph row ROW that is part of the new glyph
25043 string. END is the index of the last glyph in that glyph row area.
25044 X is the current output position assigned to the new glyph string
25045 constructed. HL overrides that face of the glyph; e.g. it is
25046 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25047 x-position of the drawing area. */
25049 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25051 int face_id = (row)->glyphs[area][START].face_id; \
25052 struct face *base_face = FACE_FROM_ID (f, face_id); \
25053 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25054 struct composition *cmp = composition_table[cmp_id]; \
25056 struct glyph_string *first_s = NULL; \
25059 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25061 /* Make glyph_strings for each glyph sequence that is drawable by \
25062 the same face, and append them to HEAD/TAIL. */ \
25063 for (n = 0; n < cmp->glyph_len;) \
25065 s = alloca (sizeof *s); \
25066 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25067 append_glyph_string (&(HEAD), &(TAIL), s); \
25073 n = fill_composite_glyph_string (s, base_face, overlaps); \
25081 /* Add a glyph string for a glyph-string sequence to the list of strings
25082 between HEAD and TAIL. */
25084 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25088 Lisp_Object gstring; \
25090 face_id = (row)->glyphs[area][START].face_id; \
25091 gstring = (composition_gstring_from_id \
25092 ((row)->glyphs[area][START].u.cmp.id)); \
25093 s = alloca (sizeof *s); \
25094 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25095 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25096 append_glyph_string (&(HEAD), &(TAIL), s); \
25098 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25102 /* Add a glyph string for a sequence of glyphless character's glyphs
25103 to the list of strings between HEAD and TAIL. The meanings of
25104 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25106 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25111 face_id = (row)->glyphs[area][START].face_id; \
25113 s = alloca (sizeof *s); \
25114 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25115 append_glyph_string (&HEAD, &TAIL, s); \
25117 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25123 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25124 of AREA of glyph row ROW on window W between indices START and END.
25125 HL overrides the face for drawing glyph strings, e.g. it is
25126 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25127 x-positions of the drawing area.
25129 This is an ugly monster macro construct because we must use alloca
25130 to allocate glyph strings (because draw_glyphs can be called
25131 asynchronously). */
25133 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25136 HEAD = TAIL = NULL; \
25137 while (START < END) \
25139 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25140 switch (first_glyph->type) \
25143 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25147 case COMPOSITE_GLYPH: \
25148 if (first_glyph->u.cmp.automatic) \
25149 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25152 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25156 case STRETCH_GLYPH: \
25157 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25161 case IMAGE_GLYPH: \
25162 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25166 case GLYPHLESS_GLYPH: \
25167 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25177 set_glyph_string_background_width (s, START, LAST_X); \
25184 /* Draw glyphs between START and END in AREA of ROW on window W,
25185 starting at x-position X. X is relative to AREA in W. HL is a
25186 face-override with the following meaning:
25188 DRAW_NORMAL_TEXT draw normally
25189 DRAW_CURSOR draw in cursor face
25190 DRAW_MOUSE_FACE draw in mouse face.
25191 DRAW_INVERSE_VIDEO draw in mode line face
25192 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25193 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25195 If OVERLAPS is non-zero, draw only the foreground of characters and
25196 clip to the physical height of ROW. Non-zero value also defines
25197 the overlapping part to be drawn:
25199 OVERLAPS_PRED overlap with preceding rows
25200 OVERLAPS_SUCC overlap with succeeding rows
25201 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25202 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25204 Value is the x-position reached, relative to AREA of W. */
25207 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25208 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25209 enum draw_glyphs_face hl
, int overlaps
)
25211 struct glyph_string
*head
, *tail
;
25212 struct glyph_string
*s
;
25213 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25214 int i
, j
, x_reached
, last_x
, area_left
= 0;
25215 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25218 ALLOCATE_HDC (hdc
, f
);
25220 /* Let's rather be paranoid than getting a SEGV. */
25221 end
= min (end
, row
->used
[area
]);
25222 start
= clip_to_bounds (0, start
, end
);
25224 /* Translate X to frame coordinates. Set last_x to the right
25225 end of the drawing area. */
25226 if (row
->full_width_p
)
25228 /* X is relative to the left edge of W, without scroll bars
25230 area_left
= WINDOW_LEFT_EDGE_X (w
);
25231 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25232 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25236 area_left
= window_box_left (w
, area
);
25237 last_x
= area_left
+ window_box_width (w
, area
);
25241 /* Build a doubly-linked list of glyph_string structures between
25242 head and tail from what we have to draw. Note that the macro
25243 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25244 the reason we use a separate variable `i'. */
25247 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25249 x_reached
= tail
->x
+ tail
->background_width
;
25253 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25254 the row, redraw some glyphs in front or following the glyph
25255 strings built above. */
25256 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25258 struct glyph_string
*h
, *t
;
25259 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25260 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25261 bool check_mouse_face
= false;
25264 /* If mouse highlighting is on, we may need to draw adjacent
25265 glyphs using mouse-face highlighting. */
25266 if (area
== TEXT_AREA
&& row
->mouse_face_p
25267 && hlinfo
->mouse_face_beg_row
>= 0
25268 && hlinfo
->mouse_face_end_row
>= 0)
25270 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25272 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25273 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25275 check_mouse_face
= true;
25276 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25277 ? hlinfo
->mouse_face_beg_col
: 0;
25278 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25279 ? hlinfo
->mouse_face_end_col
25280 : row
->used
[TEXT_AREA
];
25284 /* Compute overhangs for all glyph strings. */
25285 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25286 for (s
= head
; s
; s
= s
->next
)
25287 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25289 /* Prepend glyph strings for glyphs in front of the first glyph
25290 string that are overwritten because of the first glyph
25291 string's left overhang. The background of all strings
25292 prepended must be drawn because the first glyph string
25294 i
= left_overwritten (head
);
25297 enum draw_glyphs_face overlap_hl
;
25299 /* If this row contains mouse highlighting, attempt to draw
25300 the overlapped glyphs with the correct highlight. This
25301 code fails if the overlap encompasses more than one glyph
25302 and mouse-highlight spans only some of these glyphs.
25303 However, making it work perfectly involves a lot more
25304 code, and I don't know if the pathological case occurs in
25305 practice, so we'll stick to this for now. --- cyd */
25306 if (check_mouse_face
25307 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25308 overlap_hl
= DRAW_MOUSE_FACE
;
25310 overlap_hl
= DRAW_NORMAL_TEXT
;
25312 if (hl
!= overlap_hl
)
25315 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25316 overlap_hl
, dummy_x
, last_x
);
25318 compute_overhangs_and_x (t
, head
->x
, true);
25319 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25320 if (clip_head
== NULL
)
25324 /* Prepend glyph strings for glyphs in front of the first glyph
25325 string that overwrite that glyph string because of their
25326 right overhang. For these strings, only the foreground must
25327 be drawn, because it draws over the glyph string at `head'.
25328 The background must not be drawn because this would overwrite
25329 right overhangs of preceding glyphs for which no glyph
25331 i
= left_overwriting (head
);
25334 enum draw_glyphs_face overlap_hl
;
25336 if (check_mouse_face
25337 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25338 overlap_hl
= DRAW_MOUSE_FACE
;
25340 overlap_hl
= DRAW_NORMAL_TEXT
;
25342 if (hl
== overlap_hl
|| clip_head
== NULL
)
25344 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25345 overlap_hl
, dummy_x
, last_x
);
25346 for (s
= h
; s
; s
= s
->next
)
25347 s
->background_filled_p
= true;
25348 compute_overhangs_and_x (t
, head
->x
, true);
25349 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25352 /* Append glyphs strings for glyphs following the last glyph
25353 string tail that are overwritten by tail. The background of
25354 these strings has to be drawn because tail's foreground draws
25356 i
= right_overwritten (tail
);
25359 enum draw_glyphs_face overlap_hl
;
25361 if (check_mouse_face
25362 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25363 overlap_hl
= DRAW_MOUSE_FACE
;
25365 overlap_hl
= DRAW_NORMAL_TEXT
;
25367 if (hl
!= overlap_hl
)
25369 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25370 overlap_hl
, x
, last_x
);
25371 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25372 we don't have `end = i;' here. */
25373 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25374 append_glyph_string_lists (&head
, &tail
, h
, t
);
25375 if (clip_tail
== NULL
)
25379 /* Append glyph strings for glyphs following the last glyph
25380 string tail that overwrite tail. The foreground of such
25381 glyphs has to be drawn because it writes into the background
25382 of tail. The background must not be drawn because it could
25383 paint over the foreground of following glyphs. */
25384 i
= right_overwriting (tail
);
25387 enum draw_glyphs_face overlap_hl
;
25388 if (check_mouse_face
25389 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25390 overlap_hl
= DRAW_MOUSE_FACE
;
25392 overlap_hl
= DRAW_NORMAL_TEXT
;
25394 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25396 i
++; /* We must include the Ith glyph. */
25397 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25398 overlap_hl
, x
, last_x
);
25399 for (s
= h
; s
; s
= s
->next
)
25400 s
->background_filled_p
= true;
25401 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25402 append_glyph_string_lists (&head
, &tail
, h
, t
);
25404 if (clip_head
|| clip_tail
)
25405 for (s
= head
; s
; s
= s
->next
)
25407 s
->clip_head
= clip_head
;
25408 s
->clip_tail
= clip_tail
;
25412 /* Draw all strings. */
25413 for (s
= head
; s
; s
= s
->next
)
25414 FRAME_RIF (f
)->draw_glyph_string (s
);
25417 /* When focus a sole frame and move horizontally, this clears on_p
25418 causing a failure to erase prev cursor position. */
25419 if (area
== TEXT_AREA
25420 && !row
->full_width_p
25421 /* When drawing overlapping rows, only the glyph strings'
25422 foreground is drawn, which doesn't erase a cursor
25426 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25427 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25428 : (tail
? tail
->x
+ tail
->background_width
: x
));
25432 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25433 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25437 /* Value is the x-position up to which drawn, relative to AREA of W.
25438 This doesn't include parts drawn because of overhangs. */
25439 if (row
->full_width_p
)
25440 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25442 x_reached
-= area_left
;
25444 RELEASE_HDC (hdc
, f
);
25450 /* Expand row matrix if too narrow. Don't expand if area
25453 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25455 if (!it->f->fonts_changed \
25456 && (it->glyph_row->glyphs[area] \
25457 < it->glyph_row->glyphs[area + 1])) \
25459 it->w->ncols_scale_factor++; \
25460 it->f->fonts_changed = true; \
25464 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25465 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25468 append_glyph (struct it
*it
)
25470 struct glyph
*glyph
;
25471 enum glyph_row_area area
= it
->area
;
25473 eassert (it
->glyph_row
);
25474 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25476 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25477 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25479 /* If the glyph row is reversed, we need to prepend the glyph
25480 rather than append it. */
25481 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25485 /* Make room for the additional glyph. */
25486 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25488 glyph
= it
->glyph_row
->glyphs
[area
];
25490 glyph
->charpos
= CHARPOS (it
->position
);
25491 glyph
->object
= it
->object
;
25492 if (it
->pixel_width
> 0)
25494 glyph
->pixel_width
= it
->pixel_width
;
25495 glyph
->padding_p
= false;
25499 /* Assure at least 1-pixel width. Otherwise, cursor can't
25500 be displayed correctly. */
25501 glyph
->pixel_width
= 1;
25502 glyph
->padding_p
= true;
25504 glyph
->ascent
= it
->ascent
;
25505 glyph
->descent
= it
->descent
;
25506 glyph
->voffset
= it
->voffset
;
25507 glyph
->type
= CHAR_GLYPH
;
25508 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25509 glyph
->multibyte_p
= it
->multibyte_p
;
25510 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25512 /* In R2L rows, the left and the right box edges need to be
25513 drawn in reverse direction. */
25514 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25515 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25519 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25520 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25522 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25523 || it
->phys_descent
> it
->descent
);
25524 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25525 glyph
->face_id
= it
->face_id
;
25526 glyph
->u
.ch
= it
->char_to_display
;
25527 glyph
->slice
.img
= null_glyph_slice
;
25528 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25531 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25532 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25533 glyph
->bidi_type
= it
->bidi_it
.type
;
25537 glyph
->resolved_level
= 0;
25538 glyph
->bidi_type
= UNKNOWN_BT
;
25540 ++it
->glyph_row
->used
[area
];
25543 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25546 /* Store one glyph for the composition IT->cmp_it.id in
25547 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25551 append_composite_glyph (struct it
*it
)
25553 struct glyph
*glyph
;
25554 enum glyph_row_area area
= it
->area
;
25556 eassert (it
->glyph_row
);
25558 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25559 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25561 /* If the glyph row is reversed, we need to prepend the glyph
25562 rather than append it. */
25563 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25567 /* Make room for the new glyph. */
25568 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25570 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25572 glyph
->charpos
= it
->cmp_it
.charpos
;
25573 glyph
->object
= it
->object
;
25574 glyph
->pixel_width
= it
->pixel_width
;
25575 glyph
->ascent
= it
->ascent
;
25576 glyph
->descent
= it
->descent
;
25577 glyph
->voffset
= it
->voffset
;
25578 glyph
->type
= COMPOSITE_GLYPH
;
25579 if (it
->cmp_it
.ch
< 0)
25581 glyph
->u
.cmp
.automatic
= false;
25582 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25583 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25587 glyph
->u
.cmp
.automatic
= true;
25588 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25589 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25590 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25592 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25593 glyph
->multibyte_p
= it
->multibyte_p
;
25594 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25596 /* In R2L rows, the left and the right box edges need to be
25597 drawn in reverse direction. */
25598 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25599 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25603 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25604 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25606 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25607 || it
->phys_descent
> it
->descent
);
25608 glyph
->padding_p
= false;
25609 glyph
->glyph_not_available_p
= false;
25610 glyph
->face_id
= it
->face_id
;
25611 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25614 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25615 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25616 glyph
->bidi_type
= it
->bidi_it
.type
;
25618 ++it
->glyph_row
->used
[area
];
25621 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25625 /* Change IT->ascent and IT->height according to the setting of
25629 take_vertical_position_into_account (struct it
*it
)
25633 if (it
->voffset
< 0)
25634 /* Increase the ascent so that we can display the text higher
25636 it
->ascent
-= it
->voffset
;
25638 /* Increase the descent so that we can display the text lower
25640 it
->descent
+= it
->voffset
;
25645 /* Produce glyphs/get display metrics for the image IT is loaded with.
25646 See the description of struct display_iterator in dispextern.h for
25647 an overview of struct display_iterator. */
25650 produce_image_glyph (struct it
*it
)
25654 int glyph_ascent
, crop
;
25655 struct glyph_slice slice
;
25657 eassert (it
->what
== IT_IMAGE
);
25659 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25661 /* Make sure X resources of the face is loaded. */
25662 prepare_face_for_display (it
->f
, face
);
25664 if (it
->image_id
< 0)
25666 /* Fringe bitmap. */
25667 it
->ascent
= it
->phys_ascent
= 0;
25668 it
->descent
= it
->phys_descent
= 0;
25669 it
->pixel_width
= 0;
25674 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25676 /* Make sure X resources of the image is loaded. */
25677 prepare_image_for_display (it
->f
, img
);
25679 slice
.x
= slice
.y
= 0;
25680 slice
.width
= img
->width
;
25681 slice
.height
= img
->height
;
25683 if (INTEGERP (it
->slice
.x
))
25684 slice
.x
= XINT (it
->slice
.x
);
25685 else if (FLOATP (it
->slice
.x
))
25686 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25688 if (INTEGERP (it
->slice
.y
))
25689 slice
.y
= XINT (it
->slice
.y
);
25690 else if (FLOATP (it
->slice
.y
))
25691 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25693 if (INTEGERP (it
->slice
.width
))
25694 slice
.width
= XINT (it
->slice
.width
);
25695 else if (FLOATP (it
->slice
.width
))
25696 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25698 if (INTEGERP (it
->slice
.height
))
25699 slice
.height
= XINT (it
->slice
.height
);
25700 else if (FLOATP (it
->slice
.height
))
25701 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25703 if (slice
.x
>= img
->width
)
25704 slice
.x
= img
->width
;
25705 if (slice
.y
>= img
->height
)
25706 slice
.y
= img
->height
;
25707 if (slice
.x
+ slice
.width
>= img
->width
)
25708 slice
.width
= img
->width
- slice
.x
;
25709 if (slice
.y
+ slice
.height
> img
->height
)
25710 slice
.height
= img
->height
- slice
.y
;
25712 if (slice
.width
== 0 || slice
.height
== 0)
25715 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25717 it
->descent
= slice
.height
- glyph_ascent
;
25719 it
->descent
+= img
->vmargin
;
25720 if (slice
.y
+ slice
.height
== img
->height
)
25721 it
->descent
+= img
->vmargin
;
25722 it
->phys_descent
= it
->descent
;
25724 it
->pixel_width
= slice
.width
;
25726 it
->pixel_width
+= img
->hmargin
;
25727 if (slice
.x
+ slice
.width
== img
->width
)
25728 it
->pixel_width
+= img
->hmargin
;
25730 /* It's quite possible for images to have an ascent greater than
25731 their height, so don't get confused in that case. */
25732 if (it
->descent
< 0)
25737 if (face
->box
!= FACE_NO_BOX
)
25739 if (face
->box_line_width
> 0)
25742 it
->ascent
+= face
->box_line_width
;
25743 if (slice
.y
+ slice
.height
== img
->height
)
25744 it
->descent
+= face
->box_line_width
;
25747 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25748 it
->pixel_width
+= eabs (face
->box_line_width
);
25749 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25750 it
->pixel_width
+= eabs (face
->box_line_width
);
25753 take_vertical_position_into_account (it
);
25755 /* Automatically crop wide image glyphs at right edge so we can
25756 draw the cursor on same display row. */
25757 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25758 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25760 it
->pixel_width
-= crop
;
25761 slice
.width
-= crop
;
25766 struct glyph
*glyph
;
25767 enum glyph_row_area area
= it
->area
;
25769 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25770 if (it
->glyph_row
->reversed_p
)
25774 /* Make room for the new glyph. */
25775 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25777 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25779 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25781 glyph
->charpos
= CHARPOS (it
->position
);
25782 glyph
->object
= it
->object
;
25783 glyph
->pixel_width
= it
->pixel_width
;
25784 glyph
->ascent
= glyph_ascent
;
25785 glyph
->descent
= it
->descent
;
25786 glyph
->voffset
= it
->voffset
;
25787 glyph
->type
= IMAGE_GLYPH
;
25788 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25789 glyph
->multibyte_p
= it
->multibyte_p
;
25790 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25792 /* In R2L rows, the left and the right box edges need to be
25793 drawn in reverse direction. */
25794 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25795 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25799 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25800 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25802 glyph
->overlaps_vertically_p
= false;
25803 glyph
->padding_p
= false;
25804 glyph
->glyph_not_available_p
= false;
25805 glyph
->face_id
= it
->face_id
;
25806 glyph
->u
.img_id
= img
->id
;
25807 glyph
->slice
.img
= slice
;
25808 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25811 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25812 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25813 glyph
->bidi_type
= it
->bidi_it
.type
;
25815 ++it
->glyph_row
->used
[area
];
25818 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25823 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25824 of the glyph, WIDTH and HEIGHT are the width and height of the
25825 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25828 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25829 int width
, int height
, int ascent
)
25831 struct glyph
*glyph
;
25832 enum glyph_row_area area
= it
->area
;
25834 eassert (ascent
>= 0 && ascent
<= height
);
25836 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25837 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25839 /* If the glyph row is reversed, we need to prepend the glyph
25840 rather than append it. */
25841 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25845 /* Make room for the additional glyph. */
25846 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25848 glyph
= it
->glyph_row
->glyphs
[area
];
25850 /* Decrease the width of the first glyph of the row that
25851 begins before first_visible_x (e.g., due to hscroll).
25852 This is so the overall width of the row becomes smaller
25853 by the scroll amount, and the stretch glyph appended by
25854 extend_face_to_end_of_line will be wider, to shift the
25855 row glyphs to the right. (In L2R rows, the corresponding
25856 left-shift effect is accomplished by setting row->x to a
25857 negative value, which won't work with R2L rows.)
25859 This must leave us with a positive value of WIDTH, since
25860 otherwise the call to move_it_in_display_line_to at the
25861 beginning of display_line would have got past the entire
25862 first glyph, and then it->current_x would have been
25863 greater or equal to it->first_visible_x. */
25864 if (it
->current_x
< it
->first_visible_x
)
25865 width
-= it
->first_visible_x
- it
->current_x
;
25866 eassert (width
> 0);
25868 glyph
->charpos
= CHARPOS (it
->position
);
25869 glyph
->object
= object
;
25870 glyph
->pixel_width
= width
;
25871 glyph
->ascent
= ascent
;
25872 glyph
->descent
= height
- ascent
;
25873 glyph
->voffset
= it
->voffset
;
25874 glyph
->type
= STRETCH_GLYPH
;
25875 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25876 glyph
->multibyte_p
= it
->multibyte_p
;
25877 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25879 /* In R2L rows, the left and the right box edges need to be
25880 drawn in reverse direction. */
25881 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25882 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25886 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25887 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25889 glyph
->overlaps_vertically_p
= false;
25890 glyph
->padding_p
= false;
25891 glyph
->glyph_not_available_p
= false;
25892 glyph
->face_id
= it
->face_id
;
25893 glyph
->u
.stretch
.ascent
= ascent
;
25894 glyph
->u
.stretch
.height
= height
;
25895 glyph
->slice
.img
= null_glyph_slice
;
25896 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25899 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25900 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25901 glyph
->bidi_type
= it
->bidi_it
.type
;
25905 glyph
->resolved_level
= 0;
25906 glyph
->bidi_type
= UNKNOWN_BT
;
25908 ++it
->glyph_row
->used
[area
];
25911 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25914 #endif /* HAVE_WINDOW_SYSTEM */
25916 /* Produce a stretch glyph for iterator IT. IT->object is the value
25917 of the glyph property displayed. The value must be a list
25918 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25921 1. `:width WIDTH' specifies that the space should be WIDTH *
25922 canonical char width wide. WIDTH may be an integer or floating
25925 2. `:relative-width FACTOR' specifies that the width of the stretch
25926 should be computed from the width of the first character having the
25927 `glyph' property, and should be FACTOR times that width.
25929 3. `:align-to HPOS' specifies that the space should be wide enough
25930 to reach HPOS, a value in canonical character units.
25932 Exactly one of the above pairs must be present.
25934 4. `:height HEIGHT' specifies that the height of the stretch produced
25935 should be HEIGHT, measured in canonical character units.
25937 5. `:relative-height FACTOR' specifies that the height of the
25938 stretch should be FACTOR times the height of the characters having
25939 the glyph property.
25941 Either none or exactly one of 4 or 5 must be present.
25943 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25944 of the stretch should be used for the ascent of the stretch.
25945 ASCENT must be in the range 0 <= ASCENT <= 100. */
25948 produce_stretch_glyph (struct it
*it
)
25950 /* (space :width WIDTH :height HEIGHT ...) */
25951 Lisp_Object prop
, plist
;
25952 int width
= 0, height
= 0, align_to
= -1;
25953 bool zero_width_ok_p
= false;
25955 struct font
*font
= NULL
;
25957 #ifdef HAVE_WINDOW_SYSTEM
25959 bool zero_height_ok_p
= false;
25961 if (FRAME_WINDOW_P (it
->f
))
25963 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25964 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25965 prepare_face_for_display (it
->f
, face
);
25969 /* List should start with `space'. */
25970 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25971 plist
= XCDR (it
->object
);
25973 /* Compute the width of the stretch. */
25974 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25975 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
25977 /* Absolute width `:width WIDTH' specified and valid. */
25978 zero_width_ok_p
= true;
25981 #ifdef HAVE_WINDOW_SYSTEM
25982 else if (FRAME_WINDOW_P (it
->f
)
25983 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25985 /* Relative width `:relative-width FACTOR' specified and valid.
25986 Compute the width of the characters having the `glyph'
25989 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25992 if (it
->multibyte_p
)
25993 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25996 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25997 if (! ASCII_CHAR_P (it2
.c
))
25998 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26001 it2
.glyph_row
= NULL
;
26002 it2
.what
= IT_CHARACTER
;
26003 x_produce_glyphs (&it2
);
26004 width
= NUMVAL (prop
) * it2
.pixel_width
;
26006 #endif /* HAVE_WINDOW_SYSTEM */
26007 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26008 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26011 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26012 align_to
= (align_to
< 0
26014 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26015 else if (align_to
< 0)
26016 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26017 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26018 zero_width_ok_p
= true;
26021 /* Nothing specified -> width defaults to canonical char width. */
26022 width
= FRAME_COLUMN_WIDTH (it
->f
);
26024 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26027 #ifdef HAVE_WINDOW_SYSTEM
26028 /* Compute height. */
26029 if (FRAME_WINDOW_P (it
->f
))
26031 int default_height
= normal_char_height (font
, ' ');
26033 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26034 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26037 zero_height_ok_p
= true;
26039 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26041 height
= default_height
* NUMVAL (prop
);
26043 height
= default_height
;
26045 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26048 /* Compute percentage of height used for ascent. If
26049 `:ascent ASCENT' is present and valid, use that. Otherwise,
26050 derive the ascent from the font in use. */
26051 if (prop
= Fplist_get (plist
, QCascent
),
26052 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26053 ascent
= height
* NUMVAL (prop
) / 100.0;
26054 else if (!NILP (prop
)
26055 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26056 ascent
= min (max (0, (int)tem
), height
);
26058 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26061 #endif /* HAVE_WINDOW_SYSTEM */
26064 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26065 && it
->current_x
+ width
> it
->last_visible_x
)
26067 width
= it
->last_visible_x
- it
->current_x
;
26068 #ifdef HAVE_WINDOW_SYSTEM
26069 /* Subtract one more pixel from the stretch width, but only on
26070 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26071 width
-= FRAME_WINDOW_P (it
->f
);
26075 if (width
> 0 && height
> 0 && it
->glyph_row
)
26077 Lisp_Object o_object
= it
->object
;
26078 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26081 if (!STRINGP (object
))
26082 object
= it
->w
->contents
;
26083 #ifdef HAVE_WINDOW_SYSTEM
26084 if (FRAME_WINDOW_P (it
->f
))
26085 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26089 it
->object
= object
;
26090 it
->char_to_display
= ' ';
26091 it
->pixel_width
= it
->len
= 1;
26093 tty_append_glyph (it
);
26094 it
->object
= o_object
;
26098 it
->pixel_width
= width
;
26099 #ifdef HAVE_WINDOW_SYSTEM
26100 if (FRAME_WINDOW_P (it
->f
))
26102 it
->ascent
= it
->phys_ascent
= ascent
;
26103 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26104 it
->nglyphs
= width
> 0 && height
> 0;
26105 take_vertical_position_into_account (it
);
26109 it
->nglyphs
= width
;
26112 /* Get information about special display element WHAT in an
26113 environment described by IT. WHAT is one of IT_TRUNCATION or
26114 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26115 non-null glyph_row member. This function ensures that fields like
26116 face_id, c, len of IT are left untouched. */
26119 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26126 temp_it
.object
= Qnil
;
26127 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26129 if (what
== IT_CONTINUATION
)
26131 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26132 if (it
->bidi_it
.paragraph_dir
== R2L
)
26133 SET_GLYPH_FROM_CHAR (glyph
, '/');
26135 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26137 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26139 /* FIXME: Should we mirror GC for R2L lines? */
26140 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26141 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26144 else if (what
== IT_TRUNCATION
)
26146 /* Truncation glyph. */
26147 SET_GLYPH_FROM_CHAR (glyph
, '$');
26149 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26151 /* FIXME: Should we mirror GC for R2L lines? */
26152 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26153 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26159 #ifdef HAVE_WINDOW_SYSTEM
26160 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26161 is turned off, we precede the truncation/continuation glyphs by a
26162 stretch glyph whose width is computed such that these special
26163 glyphs are aligned at the window margin, even when very different
26164 fonts are used in different glyph rows. */
26165 if (FRAME_WINDOW_P (temp_it
.f
)
26166 /* init_iterator calls this with it->glyph_row == NULL, and it
26167 wants only the pixel width of the truncation/continuation
26169 && temp_it
.glyph_row
26170 /* insert_left_trunc_glyphs calls us at the beginning of the
26171 row, and it has its own calculation of the stretch glyph
26173 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26174 && (temp_it
.glyph_row
->reversed_p
26175 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26176 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26178 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26180 if (stretch_width
> 0)
26182 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26183 struct font
*font
=
26184 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26185 int stretch_ascent
=
26186 (((temp_it
.ascent
+ temp_it
.descent
)
26187 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26189 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26190 temp_it
.ascent
+ temp_it
.descent
,
26197 temp_it
.what
= IT_CHARACTER
;
26198 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26199 temp_it
.face_id
= GLYPH_FACE (glyph
);
26200 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26202 PRODUCE_GLYPHS (&temp_it
);
26203 it
->pixel_width
= temp_it
.pixel_width
;
26204 it
->nglyphs
= temp_it
.nglyphs
;
26207 #ifdef HAVE_WINDOW_SYSTEM
26209 /* Calculate line-height and line-spacing properties.
26210 An integer value specifies explicit pixel value.
26211 A float value specifies relative value to current face height.
26212 A cons (float . face-name) specifies relative value to
26213 height of specified face font.
26215 Returns height in pixels, or nil. */
26218 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26219 int boff
, bool override
)
26221 Lisp_Object face_name
= Qnil
;
26222 int ascent
, descent
, height
;
26224 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26229 face_name
= XCAR (val
);
26231 if (!NUMBERP (val
))
26232 val
= make_number (1);
26233 if (NILP (face_name
))
26235 height
= it
->ascent
+ it
->descent
;
26240 if (NILP (face_name
))
26242 font
= FRAME_FONT (it
->f
);
26243 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26245 else if (EQ (face_name
, Qt
))
26254 face_id
= lookup_named_face (it
->f
, face_name
, false);
26256 return make_number (-1);
26258 face
= FACE_FROM_ID (it
->f
, face_id
);
26261 return make_number (-1);
26262 boff
= font
->baseline_offset
;
26263 if (font
->vertical_centering
)
26264 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26267 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26271 it
->override_ascent
= ascent
;
26272 it
->override_descent
= descent
;
26273 it
->override_boff
= boff
;
26276 height
= ascent
+ descent
;
26280 height
= (int)(XFLOAT_DATA (val
) * height
);
26281 else if (INTEGERP (val
))
26282 height
*= XINT (val
);
26284 return make_number (height
);
26288 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26289 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26290 and only if this is for a character for which no font was found.
26292 If the display method (it->glyphless_method) is
26293 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26294 length of the acronym or the hexadecimal string, UPPER_XOFF and
26295 UPPER_YOFF are pixel offsets for the upper part of the string,
26296 LOWER_XOFF and LOWER_YOFF are for the lower part.
26298 For the other display methods, LEN through LOWER_YOFF are zero. */
26301 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26302 short upper_xoff
, short upper_yoff
,
26303 short lower_xoff
, short lower_yoff
)
26305 struct glyph
*glyph
;
26306 enum glyph_row_area area
= it
->area
;
26308 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26309 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26311 /* If the glyph row is reversed, we need to prepend the glyph
26312 rather than append it. */
26313 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26317 /* Make room for the additional glyph. */
26318 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26320 glyph
= it
->glyph_row
->glyphs
[area
];
26322 glyph
->charpos
= CHARPOS (it
->position
);
26323 glyph
->object
= it
->object
;
26324 glyph
->pixel_width
= it
->pixel_width
;
26325 glyph
->ascent
= it
->ascent
;
26326 glyph
->descent
= it
->descent
;
26327 glyph
->voffset
= it
->voffset
;
26328 glyph
->type
= GLYPHLESS_GLYPH
;
26329 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26330 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26331 glyph
->u
.glyphless
.len
= len
;
26332 glyph
->u
.glyphless
.ch
= it
->c
;
26333 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26334 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26335 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26336 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26337 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26338 glyph
->multibyte_p
= it
->multibyte_p
;
26339 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26341 /* In R2L rows, the left and the right box edges need to be
26342 drawn in reverse direction. */
26343 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26344 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26348 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26349 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26351 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26352 || it
->phys_descent
> it
->descent
);
26353 glyph
->padding_p
= false;
26354 glyph
->glyph_not_available_p
= false;
26355 glyph
->face_id
= face_id
;
26356 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26359 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26360 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26361 glyph
->bidi_type
= it
->bidi_it
.type
;
26363 ++it
->glyph_row
->used
[area
];
26366 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26370 /* Produce a glyph for a glyphless character for iterator IT.
26371 IT->glyphless_method specifies which method to use for displaying
26372 the character. See the description of enum
26373 glyphless_display_method in dispextern.h for the detail.
26375 FOR_NO_FONT is true if and only if this is for a character for
26376 which no font was found. ACRONYM, if non-nil, is an acronym string
26377 for the character. */
26380 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26385 int base_width
, base_height
, width
, height
;
26386 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26389 /* Get the metrics of the base font. We always refer to the current
26391 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26392 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26393 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26394 it
->ascent
+= font
->baseline_offset
;
26395 it
->descent
-= font
->baseline_offset
;
26396 base_height
= it
->ascent
+ it
->descent
;
26397 base_width
= font
->average_width
;
26399 face_id
= merge_glyphless_glyph_face (it
);
26401 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26403 it
->pixel_width
= THIN_SPACE_WIDTH
;
26405 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26407 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26409 width
= CHAR_WIDTH (it
->c
);
26412 else if (width
> 4)
26414 it
->pixel_width
= base_width
* width
;
26416 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26422 unsigned int code
[6];
26424 int ascent
, descent
;
26425 struct font_metrics metrics_upper
, metrics_lower
;
26427 face
= FACE_FROM_ID (it
->f
, face_id
);
26428 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26429 prepare_face_for_display (it
->f
, face
);
26431 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26433 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26434 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26435 if (CONSP (acronym
))
26436 acronym
= XCAR (acronym
);
26437 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26441 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26442 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26445 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26446 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26447 upper_len
= (len
+ 1) / 2;
26448 font
->driver
->text_extents (font
, code
, upper_len
,
26450 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26455 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26456 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26457 upper_xoff
= upper_yoff
= 2; /* the typical case */
26458 if (base_width
>= width
)
26460 /* Align the upper to the left, the lower to the right. */
26461 it
->pixel_width
= base_width
;
26462 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26466 /* Center the shorter one. */
26467 it
->pixel_width
= width
;
26468 if (metrics_upper
.width
>= metrics_lower
.width
)
26469 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26472 /* FIXME: This code doesn't look right. It formerly was
26473 missing the "lower_xoff = 0;", which couldn't have
26474 been right since it left lower_xoff uninitialized. */
26476 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26480 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26481 top, bottom, and between upper and lower strings. */
26482 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26483 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26484 /* Center vertically.
26485 H:base_height, D:base_descent
26486 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26488 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26489 descent = D - H/2 + h/2;
26490 lower_yoff = descent - 2 - ld;
26491 upper_yoff = lower_yoff - la - 1 - ud; */
26492 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26493 descent
= it
->descent
- (base_height
- height
) / 2;
26494 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26495 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26496 - metrics_upper
.descent
);
26497 /* Don't make the height shorter than the base height. */
26498 if (height
> base_height
)
26500 it
->ascent
= ascent
;
26501 it
->descent
= descent
;
26505 it
->phys_ascent
= it
->ascent
;
26506 it
->phys_descent
= it
->descent
;
26508 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26509 upper_xoff
, upper_yoff
,
26510 lower_xoff
, lower_yoff
);
26512 take_vertical_position_into_account (it
);
26517 Produce glyphs/get display metrics for the display element IT is
26518 loaded with. See the description of struct it in dispextern.h
26519 for an overview of struct it. */
26522 x_produce_glyphs (struct it
*it
)
26524 int extra_line_spacing
= it
->extra_line_spacing
;
26526 it
->glyph_not_available_p
= false;
26528 if (it
->what
== IT_CHARACTER
)
26531 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26532 struct font
*font
= face
->font
;
26533 struct font_metrics
*pcm
= NULL
;
26534 int boff
; /* Baseline offset. */
26538 /* When no suitable font is found, display this character by
26539 the method specified in the first extra slot of
26540 Vglyphless_char_display. */
26541 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26543 eassert (it
->what
== IT_GLYPHLESS
);
26544 produce_glyphless_glyph (it
, true,
26545 STRINGP (acronym
) ? acronym
: Qnil
);
26549 boff
= font
->baseline_offset
;
26550 if (font
->vertical_centering
)
26551 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26553 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26557 if (it
->override_ascent
>= 0)
26559 it
->ascent
= it
->override_ascent
;
26560 it
->descent
= it
->override_descent
;
26561 boff
= it
->override_boff
;
26565 it
->ascent
= FONT_BASE (font
) + boff
;
26566 it
->descent
= FONT_DESCENT (font
) - boff
;
26569 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26571 pcm
= get_per_char_metric (font
, &char2b
);
26572 if (pcm
->width
== 0
26573 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26579 it
->phys_ascent
= pcm
->ascent
+ boff
;
26580 it
->phys_descent
= pcm
->descent
- boff
;
26581 it
->pixel_width
= pcm
->width
;
26582 /* Don't use font-global values for ascent and descent
26583 if they result in an exceedingly large line height. */
26584 if (it
->override_ascent
< 0)
26586 if (FONT_TOO_HIGH (font
))
26588 it
->ascent
= it
->phys_ascent
;
26589 it
->descent
= it
->phys_descent
;
26590 /* These limitations are enforced by an
26591 assertion near the end of this function. */
26592 if (it
->ascent
< 0)
26594 if (it
->descent
< 0)
26601 it
->glyph_not_available_p
= true;
26602 it
->phys_ascent
= it
->ascent
;
26603 it
->phys_descent
= it
->descent
;
26604 it
->pixel_width
= font
->space_width
;
26607 if (it
->constrain_row_ascent_descent_p
)
26609 if (it
->descent
> it
->max_descent
)
26611 it
->ascent
+= it
->descent
- it
->max_descent
;
26612 it
->descent
= it
->max_descent
;
26614 if (it
->ascent
> it
->max_ascent
)
26616 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26617 it
->ascent
= it
->max_ascent
;
26619 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26620 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26621 extra_line_spacing
= 0;
26624 /* If this is a space inside a region of text with
26625 `space-width' property, change its width. */
26627 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26629 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26631 /* If face has a box, add the box thickness to the character
26632 height. If character has a box line to the left and/or
26633 right, add the box line width to the character's width. */
26634 if (face
->box
!= FACE_NO_BOX
)
26636 int thick
= face
->box_line_width
;
26640 it
->ascent
+= thick
;
26641 it
->descent
+= thick
;
26646 if (it
->start_of_box_run_p
)
26647 it
->pixel_width
+= thick
;
26648 if (it
->end_of_box_run_p
)
26649 it
->pixel_width
+= thick
;
26652 /* If face has an overline, add the height of the overline
26653 (1 pixel) and a 1 pixel margin to the character height. */
26654 if (face
->overline_p
)
26655 it
->ascent
+= overline_margin
;
26657 if (it
->constrain_row_ascent_descent_p
)
26659 if (it
->ascent
> it
->max_ascent
)
26660 it
->ascent
= it
->max_ascent
;
26661 if (it
->descent
> it
->max_descent
)
26662 it
->descent
= it
->max_descent
;
26665 take_vertical_position_into_account (it
);
26667 /* If we have to actually produce glyphs, do it. */
26672 /* Translate a space with a `space-width' property
26673 into a stretch glyph. */
26674 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26675 / FONT_HEIGHT (font
));
26676 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26677 it
->ascent
+ it
->descent
, ascent
);
26682 /* If characters with lbearing or rbearing are displayed
26683 in this line, record that fact in a flag of the
26684 glyph row. This is used to optimize X output code. */
26685 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26686 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26688 if (! stretched_p
&& it
->pixel_width
== 0)
26689 /* We assure that all visible glyphs have at least 1-pixel
26691 it
->pixel_width
= 1;
26693 else if (it
->char_to_display
== '\n')
26695 /* A newline has no width, but we need the height of the
26696 line. But if previous part of the line sets a height,
26697 don't increase that height. */
26699 Lisp_Object height
;
26700 Lisp_Object total_height
= Qnil
;
26702 it
->override_ascent
= -1;
26703 it
->pixel_width
= 0;
26706 height
= get_it_property (it
, Qline_height
);
26707 /* Split (line-height total-height) list. */
26709 && CONSP (XCDR (height
))
26710 && NILP (XCDR (XCDR (height
))))
26712 total_height
= XCAR (XCDR (height
));
26713 height
= XCAR (height
);
26715 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26717 if (it
->override_ascent
>= 0)
26719 it
->ascent
= it
->override_ascent
;
26720 it
->descent
= it
->override_descent
;
26721 boff
= it
->override_boff
;
26725 if (FONT_TOO_HIGH (font
))
26727 it
->ascent
= font
->pixel_size
+ boff
- 1;
26728 it
->descent
= -boff
+ 1;
26729 if (it
->descent
< 0)
26734 it
->ascent
= FONT_BASE (font
) + boff
;
26735 it
->descent
= FONT_DESCENT (font
) - boff
;
26739 if (EQ (height
, Qt
))
26741 if (it
->descent
> it
->max_descent
)
26743 it
->ascent
+= it
->descent
- it
->max_descent
;
26744 it
->descent
= it
->max_descent
;
26746 if (it
->ascent
> it
->max_ascent
)
26748 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26749 it
->ascent
= it
->max_ascent
;
26751 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26752 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26753 it
->constrain_row_ascent_descent_p
= true;
26754 extra_line_spacing
= 0;
26758 Lisp_Object spacing
;
26760 it
->phys_ascent
= it
->ascent
;
26761 it
->phys_descent
= it
->descent
;
26763 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26764 && face
->box
!= FACE_NO_BOX
26765 && face
->box_line_width
> 0)
26767 it
->ascent
+= face
->box_line_width
;
26768 it
->descent
+= face
->box_line_width
;
26771 && XINT (height
) > it
->ascent
+ it
->descent
)
26772 it
->ascent
= XINT (height
) - it
->descent
;
26774 if (!NILP (total_height
))
26775 spacing
= calc_line_height_property (it
, total_height
, font
,
26779 spacing
= get_it_property (it
, Qline_spacing
);
26780 spacing
= calc_line_height_property (it
, spacing
, font
,
26783 if (INTEGERP (spacing
))
26785 extra_line_spacing
= XINT (spacing
);
26786 if (!NILP (total_height
))
26787 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26791 else /* i.e. (it->char_to_display == '\t') */
26793 if (font
->space_width
> 0)
26795 int tab_width
= it
->tab_width
* font
->space_width
;
26796 int x
= it
->current_x
+ it
->continuation_lines_width
;
26797 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26799 /* If the distance from the current position to the next tab
26800 stop is less than a space character width, use the
26801 tab stop after that. */
26802 if (next_tab_x
- x
< font
->space_width
)
26803 next_tab_x
+= tab_width
;
26805 it
->pixel_width
= next_tab_x
- x
;
26807 if (FONT_TOO_HIGH (font
))
26809 if (get_char_glyph_code (' ', font
, &char2b
))
26811 pcm
= get_per_char_metric (font
, &char2b
);
26812 if (pcm
->width
== 0
26813 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26819 it
->ascent
= pcm
->ascent
+ boff
;
26820 it
->descent
= pcm
->descent
- boff
;
26824 it
->ascent
= font
->pixel_size
+ boff
- 1;
26825 it
->descent
= -boff
+ 1;
26827 if (it
->ascent
< 0)
26829 if (it
->descent
< 0)
26834 it
->ascent
= FONT_BASE (font
) + boff
;
26835 it
->descent
= FONT_DESCENT (font
) - boff
;
26837 it
->phys_ascent
= it
->ascent
;
26838 it
->phys_descent
= it
->descent
;
26842 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26843 it
->ascent
+ it
->descent
, it
->ascent
);
26848 it
->pixel_width
= 0;
26853 if (FONT_TOO_HIGH (font
))
26855 int font_ascent
, font_descent
;
26857 /* For very large fonts, where we ignore the declared font
26858 dimensions, and go by per-character metrics instead,
26859 don't let the row ascent and descent values (and the row
26860 height computed from them) be smaller than the "normal"
26861 character metrics. This avoids unpleasant effects
26862 whereby lines on display would change their height
26863 depending on which characters are shown. */
26864 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26865 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26866 it
->max_descent
= max (it
->max_descent
, font_descent
);
26869 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26871 /* A static composition.
26873 Note: A composition is represented as one glyph in the
26874 glyph matrix. There are no padding glyphs.
26876 Important note: pixel_width, ascent, and descent are the
26877 values of what is drawn by draw_glyphs (i.e. the values of
26878 the overall glyphs composed). */
26879 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26880 int boff
; /* baseline offset */
26881 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26882 int glyph_len
= cmp
->glyph_len
;
26883 struct font
*font
= face
->font
;
26887 /* If we have not yet calculated pixel size data of glyphs of
26888 the composition for the current face font, calculate them
26889 now. Theoretically, we have to check all fonts for the
26890 glyphs, but that requires much time and memory space. So,
26891 here we check only the font of the first glyph. This may
26892 lead to incorrect display, but it's very rare, and C-l
26893 (recenter-top-bottom) can correct the display anyway. */
26894 if (! cmp
->font
|| cmp
->font
!= font
)
26896 /* Ascent and descent of the font of the first character
26897 of this composition (adjusted by baseline offset).
26898 Ascent and descent of overall glyphs should not be less
26899 than these, respectively. */
26900 int font_ascent
, font_descent
, font_height
;
26901 /* Bounding box of the overall glyphs. */
26902 int leftmost
, rightmost
, lowest
, highest
;
26903 int lbearing
, rbearing
;
26904 int i
, width
, ascent
, descent
;
26905 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26907 struct font_metrics
*pcm
;
26910 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26911 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26913 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26914 for (i
= 0; i
< glyph_len
; i
++)
26916 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26918 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26920 bool left_padded
= i
> 0;
26922 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26923 : IT_CHARPOS (*it
));
26924 /* If no suitable font is found, use the default font. */
26925 bool font_not_found_p
= font
== NULL
;
26926 if (font_not_found_p
)
26928 face
= face
->ascii_face
;
26931 boff
= font
->baseline_offset
;
26932 if (font
->vertical_centering
)
26933 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26934 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26935 font_ascent
+= boff
;
26936 font_descent
-= boff
;
26937 font_height
= font_ascent
+ font_descent
;
26942 if (! font_not_found_p
)
26944 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26946 pcm
= get_per_char_metric (font
, &char2b
);
26949 /* Initialize the bounding box. */
26952 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26953 ascent
= pcm
->ascent
;
26954 descent
= pcm
->descent
;
26955 lbearing
= pcm
->lbearing
;
26956 rbearing
= pcm
->rbearing
;
26960 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26961 ascent
= FONT_BASE (font
);
26962 descent
= FONT_DESCENT (font
);
26969 lowest
= - descent
+ boff
;
26970 highest
= ascent
+ boff
;
26972 if (! font_not_found_p
26973 && font
->default_ascent
26974 && CHAR_TABLE_P (Vuse_default_ascent
)
26975 && !NILP (Faref (Vuse_default_ascent
,
26976 make_number (it
->char_to_display
))))
26977 highest
= font
->default_ascent
+ boff
;
26979 /* Draw the first glyph at the normal position. It may be
26980 shifted to right later if some other glyphs are drawn
26982 cmp
->offsets
[i
* 2] = 0;
26983 cmp
->offsets
[i
* 2 + 1] = boff
;
26984 cmp
->lbearing
= lbearing
;
26985 cmp
->rbearing
= rbearing
;
26987 /* Set cmp->offsets for the remaining glyphs. */
26988 for (i
++; i
< glyph_len
; i
++)
26990 int left
, right
, btm
, top
;
26991 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26993 struct face
*this_face
;
26997 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26998 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26999 font
= this_face
->font
;
27005 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27007 pcm
= get_per_char_metric (font
, &char2b
);
27010 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27013 width
= pcm
->width
;
27014 ascent
= pcm
->ascent
;
27015 descent
= pcm
->descent
;
27016 lbearing
= pcm
->lbearing
;
27017 rbearing
= pcm
->rbearing
;
27018 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27020 /* Relative composition with or without
27021 alternate chars. */
27022 left
= (leftmost
+ rightmost
- width
) / 2;
27023 btm
= - descent
+ boff
;
27024 if (font
->relative_compose
27025 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27026 || NILP (Faref (Vignore_relative_composition
,
27027 make_number (ch
)))))
27030 if (- descent
>= font
->relative_compose
)
27031 /* One extra pixel between two glyphs. */
27033 else if (ascent
<= 0)
27034 /* One extra pixel between two glyphs. */
27035 btm
= lowest
- 1 - ascent
- descent
;
27040 /* A composition rule is specified by an integer
27041 value that encodes global and new reference
27042 points (GREF and NREF). GREF and NREF are
27043 specified by numbers as below:
27045 0---1---2 -- ascent
27049 9--10--11 -- center
27051 ---3---4---5--- baseline
27053 6---7---8 -- descent
27055 int rule
= COMPOSITION_RULE (cmp
, i
);
27056 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27058 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27059 grefx
= gref
% 3, nrefx
= nref
% 3;
27060 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27062 xoff
= font_height
* (xoff
- 128) / 256;
27064 yoff
= font_height
* (yoff
- 128) / 256;
27067 + grefx
* (rightmost
- leftmost
) / 2
27068 - nrefx
* width
/ 2
27071 btm
= ((grefy
== 0 ? highest
27073 : grefy
== 2 ? lowest
27074 : (highest
+ lowest
) / 2)
27075 - (nrefy
== 0 ? ascent
+ descent
27076 : nrefy
== 1 ? descent
- boff
27078 : (ascent
+ descent
) / 2)
27082 cmp
->offsets
[i
* 2] = left
;
27083 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27085 /* Update the bounding box of the overall glyphs. */
27088 right
= left
+ width
;
27089 if (left
< leftmost
)
27091 if (right
> rightmost
)
27094 top
= btm
+ descent
+ ascent
;
27100 if (cmp
->lbearing
> left
+ lbearing
)
27101 cmp
->lbearing
= left
+ lbearing
;
27102 if (cmp
->rbearing
< left
+ rbearing
)
27103 cmp
->rbearing
= left
+ rbearing
;
27107 /* If there are glyphs whose x-offsets are negative,
27108 shift all glyphs to the right and make all x-offsets
27112 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27113 cmp
->offsets
[i
* 2] -= leftmost
;
27114 rightmost
-= leftmost
;
27115 cmp
->lbearing
-= leftmost
;
27116 cmp
->rbearing
-= leftmost
;
27119 if (left_padded
&& cmp
->lbearing
< 0)
27121 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27122 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27123 rightmost
-= cmp
->lbearing
;
27124 cmp
->rbearing
-= cmp
->lbearing
;
27127 if (right_padded
&& rightmost
< cmp
->rbearing
)
27129 rightmost
= cmp
->rbearing
;
27132 cmp
->pixel_width
= rightmost
;
27133 cmp
->ascent
= highest
;
27134 cmp
->descent
= - lowest
;
27135 if (cmp
->ascent
< font_ascent
)
27136 cmp
->ascent
= font_ascent
;
27137 if (cmp
->descent
< font_descent
)
27138 cmp
->descent
= font_descent
;
27142 && (cmp
->lbearing
< 0
27143 || cmp
->rbearing
> cmp
->pixel_width
))
27144 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27146 it
->pixel_width
= cmp
->pixel_width
;
27147 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27148 it
->descent
= it
->phys_descent
= cmp
->descent
;
27149 if (face
->box
!= FACE_NO_BOX
)
27151 int thick
= face
->box_line_width
;
27155 it
->ascent
+= thick
;
27156 it
->descent
+= thick
;
27161 if (it
->start_of_box_run_p
)
27162 it
->pixel_width
+= thick
;
27163 if (it
->end_of_box_run_p
)
27164 it
->pixel_width
+= thick
;
27167 /* If face has an overline, add the height of the overline
27168 (1 pixel) and a 1 pixel margin to the character height. */
27169 if (face
->overline_p
)
27170 it
->ascent
+= overline_margin
;
27172 take_vertical_position_into_account (it
);
27173 if (it
->ascent
< 0)
27175 if (it
->descent
< 0)
27178 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27179 append_composite_glyph (it
);
27181 else if (it
->what
== IT_COMPOSITION
)
27183 /* A dynamic (automatic) composition. */
27184 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27185 Lisp_Object gstring
;
27186 struct font_metrics metrics
;
27190 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27192 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27195 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27196 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27197 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27198 it
->descent
= it
->phys_descent
= metrics
.descent
;
27199 if (face
->box
!= FACE_NO_BOX
)
27201 int thick
= face
->box_line_width
;
27205 it
->ascent
+= thick
;
27206 it
->descent
+= thick
;
27211 if (it
->start_of_box_run_p
)
27212 it
->pixel_width
+= thick
;
27213 if (it
->end_of_box_run_p
)
27214 it
->pixel_width
+= thick
;
27216 /* If face has an overline, add the height of the overline
27217 (1 pixel) and a 1 pixel margin to the character height. */
27218 if (face
->overline_p
)
27219 it
->ascent
+= overline_margin
;
27220 take_vertical_position_into_account (it
);
27221 if (it
->ascent
< 0)
27223 if (it
->descent
< 0)
27227 append_composite_glyph (it
);
27229 else if (it
->what
== IT_GLYPHLESS
)
27230 produce_glyphless_glyph (it
, false, Qnil
);
27231 else if (it
->what
== IT_IMAGE
)
27232 produce_image_glyph (it
);
27233 else if (it
->what
== IT_STRETCH
)
27234 produce_stretch_glyph (it
);
27237 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27238 because this isn't true for images with `:ascent 100'. */
27239 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27240 if (it
->area
== TEXT_AREA
)
27241 it
->current_x
+= it
->pixel_width
;
27243 if (extra_line_spacing
> 0)
27245 it
->descent
+= extra_line_spacing
;
27246 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27247 it
->max_extra_line_spacing
= extra_line_spacing
;
27250 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27251 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27252 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27253 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27257 Output LEN glyphs starting at START at the nominal cursor position.
27258 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27259 being updated, and UPDATED_AREA is the area of that row being updated. */
27262 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27263 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27265 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27267 eassert (updated_row
);
27268 /* When the window is hscrolled, cursor hpos can legitimately be out
27269 of bounds, but we draw the cursor at the corresponding window
27270 margin in that case. */
27271 if (!updated_row
->reversed_p
&& chpos
< 0)
27273 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27274 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27278 /* Write glyphs. */
27280 hpos
= start
- updated_row
->glyphs
[updated_area
];
27281 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27282 updated_row
, updated_area
,
27284 DRAW_NORMAL_TEXT
, 0);
27286 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27287 if (updated_area
== TEXT_AREA
27288 && w
->phys_cursor_on_p
27289 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27291 && chpos
< hpos
+ len
)
27292 w
->phys_cursor_on_p
= false;
27296 /* Advance the output cursor. */
27297 w
->output_cursor
.hpos
+= len
;
27298 w
->output_cursor
.x
= x
;
27303 Insert LEN glyphs from START at the nominal cursor position. */
27306 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27307 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27310 int line_height
, shift_by_width
, shifted_region_width
;
27311 struct glyph_row
*row
;
27312 struct glyph
*glyph
;
27313 int frame_x
, frame_y
;
27316 eassert (updated_row
);
27318 f
= XFRAME (WINDOW_FRAME (w
));
27320 /* Get the height of the line we are in. */
27322 line_height
= row
->height
;
27324 /* Get the width of the glyphs to insert. */
27325 shift_by_width
= 0;
27326 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27327 shift_by_width
+= glyph
->pixel_width
;
27329 /* Get the width of the region to shift right. */
27330 shifted_region_width
= (window_box_width (w
, updated_area
)
27331 - w
->output_cursor
.x
27335 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27336 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27338 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27339 line_height
, shift_by_width
);
27341 /* Write the glyphs. */
27342 hpos
= start
- row
->glyphs
[updated_area
];
27343 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27345 DRAW_NORMAL_TEXT
, 0);
27347 /* Advance the output cursor. */
27348 w
->output_cursor
.hpos
+= len
;
27349 w
->output_cursor
.x
+= shift_by_width
;
27355 Erase the current text line from the nominal cursor position
27356 (inclusive) to pixel column TO_X (exclusive). The idea is that
27357 everything from TO_X onward is already erased.
27359 TO_X is a pixel position relative to UPDATED_AREA of currently
27360 updated window W. TO_X == -1 means clear to the end of this area. */
27363 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27364 enum glyph_row_area updated_area
, int to_x
)
27367 int max_x
, min_y
, max_y
;
27368 int from_x
, from_y
, to_y
;
27370 eassert (updated_row
);
27371 f
= XFRAME (w
->frame
);
27373 if (updated_row
->full_width_p
)
27374 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27375 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27377 max_x
= window_box_width (w
, updated_area
);
27378 max_y
= window_text_bottom_y (w
);
27380 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27381 of window. For TO_X > 0, truncate to end of drawing area. */
27387 to_x
= min (to_x
, max_x
);
27389 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27391 /* Notice if the cursor will be cleared by this operation. */
27392 if (!updated_row
->full_width_p
)
27393 notice_overwritten_cursor (w
, updated_area
,
27394 w
->output_cursor
.x
, -1,
27396 MATRIX_ROW_BOTTOM_Y (updated_row
));
27398 from_x
= w
->output_cursor
.x
;
27400 /* Translate to frame coordinates. */
27401 if (updated_row
->full_width_p
)
27403 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27404 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27408 int area_left
= window_box_left (w
, updated_area
);
27409 from_x
+= area_left
;
27413 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27414 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27415 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27417 /* Prevent inadvertently clearing to end of the X window. */
27418 if (to_x
> from_x
&& to_y
> from_y
)
27421 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27422 to_x
- from_x
, to_y
- from_y
);
27427 #endif /* HAVE_WINDOW_SYSTEM */
27431 /***********************************************************************
27433 ***********************************************************************/
27435 /* Value is the internal representation of the specified cursor type
27436 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27437 of the bar cursor. */
27439 static enum text_cursor_kinds
27440 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27442 enum text_cursor_kinds type
;
27447 if (EQ (arg
, Qbox
))
27448 return FILLED_BOX_CURSOR
;
27450 if (EQ (arg
, Qhollow
))
27451 return HOLLOW_BOX_CURSOR
;
27453 if (EQ (arg
, Qbar
))
27460 && EQ (XCAR (arg
), Qbar
)
27461 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27463 *width
= XINT (XCDR (arg
));
27467 if (EQ (arg
, Qhbar
))
27470 return HBAR_CURSOR
;
27474 && EQ (XCAR (arg
), Qhbar
)
27475 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27477 *width
= XINT (XCDR (arg
));
27478 return HBAR_CURSOR
;
27481 /* Treat anything unknown as "hollow box cursor".
27482 It was bad to signal an error; people have trouble fixing
27483 .Xdefaults with Emacs, when it has something bad in it. */
27484 type
= HOLLOW_BOX_CURSOR
;
27489 /* Set the default cursor types for specified frame. */
27491 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27496 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27497 FRAME_CURSOR_WIDTH (f
) = width
;
27499 /* By default, set up the blink-off state depending on the on-state. */
27501 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27504 FRAME_BLINK_OFF_CURSOR (f
)
27505 = get_specified_cursor_type (XCDR (tem
), &width
);
27506 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27509 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27511 /* Make sure the cursor gets redrawn. */
27512 f
->cursor_type_changed
= true;
27516 #ifdef HAVE_WINDOW_SYSTEM
27518 /* Return the cursor we want to be displayed in window W. Return
27519 width of bar/hbar cursor through WIDTH arg. Return with
27520 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27521 (i.e. if the `system caret' should track this cursor).
27523 In a mini-buffer window, we want the cursor only to appear if we
27524 are reading input from this window. For the selected window, we
27525 want the cursor type given by the frame parameter or buffer local
27526 setting of cursor-type. If explicitly marked off, draw no cursor.
27527 In all other cases, we want a hollow box cursor. */
27529 static enum text_cursor_kinds
27530 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27531 bool *active_cursor
)
27533 struct frame
*f
= XFRAME (w
->frame
);
27534 struct buffer
*b
= XBUFFER (w
->contents
);
27535 int cursor_type
= DEFAULT_CURSOR
;
27536 Lisp_Object alt_cursor
;
27537 bool non_selected
= false;
27539 *active_cursor
= true;
27542 if (cursor_in_echo_area
27543 && FRAME_HAS_MINIBUF_P (f
)
27544 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27546 if (w
== XWINDOW (echo_area_window
))
27548 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27550 *width
= FRAME_CURSOR_WIDTH (f
);
27551 return FRAME_DESIRED_CURSOR (f
);
27554 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27557 *active_cursor
= false;
27558 non_selected
= true;
27561 /* Detect a nonselected window or nonselected frame. */
27562 else if (w
!= XWINDOW (f
->selected_window
)
27563 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27565 *active_cursor
= false;
27567 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27570 non_selected
= true;
27573 /* Never display a cursor in a window in which cursor-type is nil. */
27574 if (NILP (BVAR (b
, cursor_type
)))
27577 /* Get the normal cursor type for this window. */
27578 if (EQ (BVAR (b
, cursor_type
), Qt
))
27580 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27581 *width
= FRAME_CURSOR_WIDTH (f
);
27584 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27586 /* Use cursor-in-non-selected-windows instead
27587 for non-selected window or frame. */
27590 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27591 if (!EQ (Qt
, alt_cursor
))
27592 return get_specified_cursor_type (alt_cursor
, width
);
27593 /* t means modify the normal cursor type. */
27594 if (cursor_type
== FILLED_BOX_CURSOR
)
27595 cursor_type
= HOLLOW_BOX_CURSOR
;
27596 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27598 return cursor_type
;
27601 /* Use normal cursor if not blinked off. */
27602 if (!w
->cursor_off_p
)
27604 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27606 if (cursor_type
== FILLED_BOX_CURSOR
)
27608 /* Using a block cursor on large images can be very annoying.
27609 So use a hollow cursor for "large" images.
27610 If image is not transparent (no mask), also use hollow cursor. */
27611 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27612 if (img
!= NULL
&& IMAGEP (img
->spec
))
27614 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27615 where N = size of default frame font size.
27616 This should cover most of the "tiny" icons people may use. */
27618 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27619 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27620 cursor_type
= HOLLOW_BOX_CURSOR
;
27623 else if (cursor_type
!= NO_CURSOR
)
27625 /* Display current only supports BOX and HOLLOW cursors for images.
27626 So for now, unconditionally use a HOLLOW cursor when cursor is
27627 not a solid box cursor. */
27628 cursor_type
= HOLLOW_BOX_CURSOR
;
27631 return cursor_type
;
27634 /* Cursor is blinked off, so determine how to "toggle" it. */
27636 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27637 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27638 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27640 /* Then see if frame has specified a specific blink off cursor type. */
27641 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27643 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27644 return FRAME_BLINK_OFF_CURSOR (f
);
27648 /* Some people liked having a permanently visible blinking cursor,
27649 while others had very strong opinions against it. So it was
27650 decided to remove it. KFS 2003-09-03 */
27652 /* Finally perform built-in cursor blinking:
27653 filled box <-> hollow box
27654 wide [h]bar <-> narrow [h]bar
27655 narrow [h]bar <-> no cursor
27656 other type <-> no cursor */
27658 if (cursor_type
== FILLED_BOX_CURSOR
)
27659 return HOLLOW_BOX_CURSOR
;
27661 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27664 return cursor_type
;
27672 /* Notice when the text cursor of window W has been completely
27673 overwritten by a drawing operation that outputs glyphs in AREA
27674 starting at X0 and ending at X1 in the line starting at Y0 and
27675 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27676 the rest of the line after X0 has been written. Y coordinates
27677 are window-relative. */
27680 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27681 int x0
, int x1
, int y0
, int y1
)
27683 int cx0
, cx1
, cy0
, cy1
;
27684 struct glyph_row
*row
;
27686 if (!w
->phys_cursor_on_p
)
27688 if (area
!= TEXT_AREA
)
27691 if (w
->phys_cursor
.vpos
< 0
27692 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27693 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27694 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27697 if (row
->cursor_in_fringe_p
)
27699 row
->cursor_in_fringe_p
= false;
27700 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27701 w
->phys_cursor_on_p
= false;
27705 cx0
= w
->phys_cursor
.x
;
27706 cx1
= cx0
+ w
->phys_cursor_width
;
27707 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27710 /* The cursor image will be completely removed from the
27711 screen if the output area intersects the cursor area in
27712 y-direction. When we draw in [y0 y1[, and some part of
27713 the cursor is at y < y0, that part must have been drawn
27714 before. When scrolling, the cursor is erased before
27715 actually scrolling, so we don't come here. When not
27716 scrolling, the rows above the old cursor row must have
27717 changed, and in this case these rows must have written
27718 over the cursor image.
27720 Likewise if part of the cursor is below y1, with the
27721 exception of the cursor being in the first blank row at
27722 the buffer and window end because update_text_area
27723 doesn't draw that row. (Except when it does, but
27724 that's handled in update_text_area.) */
27726 cy0
= w
->phys_cursor
.y
;
27727 cy1
= cy0
+ w
->phys_cursor_height
;
27728 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27731 w
->phys_cursor_on_p
= false;
27734 #endif /* HAVE_WINDOW_SYSTEM */
27737 /************************************************************************
27739 ************************************************************************/
27741 #ifdef HAVE_WINDOW_SYSTEM
27744 Fix the display of area AREA of overlapping row ROW in window W
27745 with respect to the overlapping part OVERLAPS. */
27748 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27749 enum glyph_row_area area
, int overlaps
)
27756 for (i
= 0; i
< row
->used
[area
];)
27758 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27760 int start
= i
, start_x
= x
;
27764 x
+= row
->glyphs
[area
][i
].pixel_width
;
27767 while (i
< row
->used
[area
]
27768 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27770 draw_glyphs (w
, start_x
, row
, area
,
27772 DRAW_NORMAL_TEXT
, overlaps
);
27776 x
+= row
->glyphs
[area
][i
].pixel_width
;
27786 Draw the cursor glyph of window W in glyph row ROW. See the
27787 comment of draw_glyphs for the meaning of HL. */
27790 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27791 enum draw_glyphs_face hl
)
27793 /* If cursor hpos is out of bounds, don't draw garbage. This can
27794 happen in mini-buffer windows when switching between echo area
27795 glyphs and mini-buffer. */
27796 if ((row
->reversed_p
27797 ? (w
->phys_cursor
.hpos
>= 0)
27798 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27800 bool on_p
= w
->phys_cursor_on_p
;
27802 int hpos
= w
->phys_cursor
.hpos
;
27804 /* When the window is hscrolled, cursor hpos can legitimately be
27805 out of bounds, but we draw the cursor at the corresponding
27806 window margin in that case. */
27807 if (!row
->reversed_p
&& hpos
< 0)
27809 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27810 hpos
= row
->used
[TEXT_AREA
] - 1;
27812 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27814 w
->phys_cursor_on_p
= on_p
;
27816 if (hl
== DRAW_CURSOR
)
27817 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27818 /* When we erase the cursor, and ROW is overlapped by other
27819 rows, make sure that these overlapping parts of other rows
27821 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27823 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27825 if (row
> w
->current_matrix
->rows
27826 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27827 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27828 OVERLAPS_ERASED_CURSOR
);
27830 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27831 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27832 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27833 OVERLAPS_ERASED_CURSOR
);
27839 /* Erase the image of a cursor of window W from the screen. */
27842 erase_phys_cursor (struct window
*w
)
27844 struct frame
*f
= XFRAME (w
->frame
);
27845 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27846 int hpos
= w
->phys_cursor
.hpos
;
27847 int vpos
= w
->phys_cursor
.vpos
;
27848 bool mouse_face_here_p
= false;
27849 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27850 struct glyph_row
*cursor_row
;
27851 struct glyph
*cursor_glyph
;
27852 enum draw_glyphs_face hl
;
27854 /* No cursor displayed or row invalidated => nothing to do on the
27856 if (w
->phys_cursor_type
== NO_CURSOR
)
27857 goto mark_cursor_off
;
27859 /* VPOS >= active_glyphs->nrows means that window has been resized.
27860 Don't bother to erase the cursor. */
27861 if (vpos
>= active_glyphs
->nrows
)
27862 goto mark_cursor_off
;
27864 /* If row containing cursor is marked invalid, there is nothing we
27866 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27867 if (!cursor_row
->enabled_p
)
27868 goto mark_cursor_off
;
27870 /* If line spacing is > 0, old cursor may only be partially visible in
27871 window after split-window. So adjust visible height. */
27872 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27873 window_text_bottom_y (w
) - cursor_row
->y
);
27875 /* If row is completely invisible, don't attempt to delete a cursor which
27876 isn't there. This can happen if cursor is at top of a window, and
27877 we switch to a buffer with a header line in that window. */
27878 if (cursor_row
->visible_height
<= 0)
27879 goto mark_cursor_off
;
27881 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27882 if (cursor_row
->cursor_in_fringe_p
)
27884 cursor_row
->cursor_in_fringe_p
= false;
27885 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27886 goto mark_cursor_off
;
27889 /* This can happen when the new row is shorter than the old one.
27890 In this case, either draw_glyphs or clear_end_of_line
27891 should have cleared the cursor. Note that we wouldn't be
27892 able to erase the cursor in this case because we don't have a
27893 cursor glyph at hand. */
27894 if ((cursor_row
->reversed_p
27895 ? (w
->phys_cursor
.hpos
< 0)
27896 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27897 goto mark_cursor_off
;
27899 /* When the window is hscrolled, cursor hpos can legitimately be out
27900 of bounds, but we draw the cursor at the corresponding window
27901 margin in that case. */
27902 if (!cursor_row
->reversed_p
&& hpos
< 0)
27904 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27905 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27907 /* If the cursor is in the mouse face area, redisplay that when
27908 we clear the cursor. */
27909 if (! NILP (hlinfo
->mouse_face_window
)
27910 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27911 /* Don't redraw the cursor's spot in mouse face if it is at the
27912 end of a line (on a newline). The cursor appears there, but
27913 mouse highlighting does not. */
27914 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27915 mouse_face_here_p
= true;
27917 /* Maybe clear the display under the cursor. */
27918 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27921 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27924 cursor_glyph
= get_phys_cursor_glyph (w
);
27925 if (cursor_glyph
== NULL
)
27926 goto mark_cursor_off
;
27928 width
= cursor_glyph
->pixel_width
;
27929 x
= w
->phys_cursor
.x
;
27935 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27936 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27937 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27940 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27943 /* Erase the cursor by redrawing the character underneath it. */
27944 if (mouse_face_here_p
)
27945 hl
= DRAW_MOUSE_FACE
;
27947 hl
= DRAW_NORMAL_TEXT
;
27948 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27951 w
->phys_cursor_on_p
= false;
27952 w
->phys_cursor_type
= NO_CURSOR
;
27956 /* Display or clear cursor of window W. If !ON, clear the cursor.
27957 If ON, display the cursor; where to put the cursor is specified by
27958 HPOS, VPOS, X and Y. */
27961 display_and_set_cursor (struct window
*w
, bool on
,
27962 int hpos
, int vpos
, int x
, int y
)
27964 struct frame
*f
= XFRAME (w
->frame
);
27965 int new_cursor_type
;
27966 int new_cursor_width
;
27967 bool active_cursor
;
27968 struct glyph_row
*glyph_row
;
27969 struct glyph
*glyph
;
27971 /* This is pointless on invisible frames, and dangerous on garbaged
27972 windows and frames; in the latter case, the frame or window may
27973 be in the midst of changing its size, and x and y may be off the
27975 if (! FRAME_VISIBLE_P (f
)
27976 || FRAME_GARBAGED_P (f
)
27977 || vpos
>= w
->current_matrix
->nrows
27978 || hpos
>= w
->current_matrix
->matrix_w
)
27981 /* If cursor is off and we want it off, return quickly. */
27982 if (!on
&& !w
->phys_cursor_on_p
)
27985 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27986 /* If cursor row is not enabled, we don't really know where to
27987 display the cursor. */
27988 if (!glyph_row
->enabled_p
)
27990 w
->phys_cursor_on_p
= false;
27995 if (!glyph_row
->exact_window_width_line_p
27996 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27997 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27999 eassert (input_blocked_p ());
28001 /* Set new_cursor_type to the cursor we want to be displayed. */
28002 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28003 &new_cursor_width
, &active_cursor
);
28005 /* If cursor is currently being shown and we don't want it to be or
28006 it is in the wrong place, or the cursor type is not what we want,
28008 if (w
->phys_cursor_on_p
28010 || w
->phys_cursor
.x
!= x
28011 || w
->phys_cursor
.y
!= y
28012 /* HPOS can be negative in R2L rows whose
28013 exact_window_width_line_p flag is set (i.e. their newline
28014 would "overflow into the fringe"). */
28016 || new_cursor_type
!= w
->phys_cursor_type
28017 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28018 && new_cursor_width
!= w
->phys_cursor_width
)))
28019 erase_phys_cursor (w
);
28021 /* Don't check phys_cursor_on_p here because that flag is only set
28022 to false in some cases where we know that the cursor has been
28023 completely erased, to avoid the extra work of erasing the cursor
28024 twice. In other words, phys_cursor_on_p can be true and the cursor
28025 still not be visible, or it has only been partly erased. */
28028 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28029 w
->phys_cursor_height
= glyph_row
->height
;
28031 /* Set phys_cursor_.* before x_draw_.* is called because some
28032 of them may need the information. */
28033 w
->phys_cursor
.x
= x
;
28034 w
->phys_cursor
.y
= glyph_row
->y
;
28035 w
->phys_cursor
.hpos
= hpos
;
28036 w
->phys_cursor
.vpos
= vpos
;
28039 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28040 new_cursor_type
, new_cursor_width
,
28041 on
, active_cursor
);
28045 /* Switch the display of W's cursor on or off, according to the value
28049 update_window_cursor (struct window
*w
, bool on
)
28051 /* Don't update cursor in windows whose frame is in the process
28052 of being deleted. */
28053 if (w
->current_matrix
)
28055 int hpos
= w
->phys_cursor
.hpos
;
28056 int vpos
= w
->phys_cursor
.vpos
;
28057 struct glyph_row
*row
;
28059 if (vpos
>= w
->current_matrix
->nrows
28060 || hpos
>= w
->current_matrix
->matrix_w
)
28063 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28065 /* When the window is hscrolled, cursor hpos can legitimately be
28066 out of bounds, but we draw the cursor at the corresponding
28067 window margin in that case. */
28068 if (!row
->reversed_p
&& hpos
< 0)
28070 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28071 hpos
= row
->used
[TEXT_AREA
] - 1;
28074 display_and_set_cursor (w
, on
, hpos
, vpos
,
28075 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28081 /* Call update_window_cursor with parameter ON_P on all leaf windows
28082 in the window tree rooted at W. */
28085 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28089 if (WINDOWP (w
->contents
))
28090 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28092 update_window_cursor (w
, on_p
);
28094 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28100 Display the cursor on window W, or clear it, according to ON_P.
28101 Don't change the cursor's position. */
28104 x_update_cursor (struct frame
*f
, bool on_p
)
28106 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28111 Clear the cursor of window W to background color, and mark the
28112 cursor as not shown. This is used when the text where the cursor
28113 is about to be rewritten. */
28116 x_clear_cursor (struct window
*w
)
28118 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28119 update_window_cursor (w
, false);
28122 #endif /* HAVE_WINDOW_SYSTEM */
28124 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28127 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28128 int start_hpos
, int end_hpos
,
28129 enum draw_glyphs_face draw
)
28131 #ifdef HAVE_WINDOW_SYSTEM
28132 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28134 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28138 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28139 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28143 /* Display the active region described by mouse_face_* according to DRAW. */
28146 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28148 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28149 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28151 if (/* If window is in the process of being destroyed, don't bother
28153 w
->current_matrix
!= NULL
28154 /* Don't update mouse highlight if hidden. */
28155 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28156 /* Recognize when we are called to operate on rows that don't exist
28157 anymore. This can happen when a window is split. */
28158 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28160 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28161 struct glyph_row
*row
, *first
, *last
;
28163 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28164 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28166 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28168 int start_hpos
, end_hpos
, start_x
;
28170 /* For all but the first row, the highlight starts at column 0. */
28173 /* R2L rows have BEG and END in reversed order, but the
28174 screen drawing geometry is always left to right. So
28175 we need to mirror the beginning and end of the
28176 highlighted area in R2L rows. */
28177 if (!row
->reversed_p
)
28179 start_hpos
= hlinfo
->mouse_face_beg_col
;
28180 start_x
= hlinfo
->mouse_face_beg_x
;
28182 else if (row
== last
)
28184 start_hpos
= hlinfo
->mouse_face_end_col
;
28185 start_x
= hlinfo
->mouse_face_end_x
;
28193 else if (row
->reversed_p
&& row
== last
)
28195 start_hpos
= hlinfo
->mouse_face_end_col
;
28196 start_x
= hlinfo
->mouse_face_end_x
;
28206 if (!row
->reversed_p
)
28207 end_hpos
= hlinfo
->mouse_face_end_col
;
28208 else if (row
== first
)
28209 end_hpos
= hlinfo
->mouse_face_beg_col
;
28212 end_hpos
= row
->used
[TEXT_AREA
];
28213 if (draw
== DRAW_NORMAL_TEXT
)
28214 row
->fill_line_p
= true; /* Clear to end of line. */
28217 else if (row
->reversed_p
&& row
== first
)
28218 end_hpos
= hlinfo
->mouse_face_beg_col
;
28221 end_hpos
= row
->used
[TEXT_AREA
];
28222 if (draw
== DRAW_NORMAL_TEXT
)
28223 row
->fill_line_p
= true; /* Clear to end of line. */
28226 if (end_hpos
> start_hpos
)
28228 draw_row_with_mouse_face (w
, start_x
, row
,
28229 start_hpos
, end_hpos
, draw
);
28232 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28236 #ifdef HAVE_WINDOW_SYSTEM
28237 /* When we've written over the cursor, arrange for it to
28238 be displayed again. */
28239 if (FRAME_WINDOW_P (f
)
28240 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28242 int hpos
= w
->phys_cursor
.hpos
;
28244 /* When the window is hscrolled, cursor hpos can legitimately be
28245 out of bounds, but we draw the cursor at the corresponding
28246 window margin in that case. */
28247 if (!row
->reversed_p
&& hpos
< 0)
28249 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28250 hpos
= row
->used
[TEXT_AREA
] - 1;
28253 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28254 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28257 #endif /* HAVE_WINDOW_SYSTEM */
28260 #ifdef HAVE_WINDOW_SYSTEM
28261 /* Change the mouse cursor. */
28262 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28264 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28265 if (draw
== DRAW_NORMAL_TEXT
28266 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28267 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28270 if (draw
== DRAW_MOUSE_FACE
)
28271 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28273 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28275 #endif /* HAVE_WINDOW_SYSTEM */
28279 Clear out the mouse-highlighted active region.
28280 Redraw it un-highlighted first. Value is true if mouse
28281 face was actually drawn unhighlighted. */
28284 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28287 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28289 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28290 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28291 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28292 hlinfo
->mouse_face_window
= Qnil
;
28293 hlinfo
->mouse_face_overlay
= Qnil
;
28297 /* Return true if the coordinates HPOS and VPOS on windows W are
28298 within the mouse face on that window. */
28300 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28302 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28304 /* Quickly resolve the easy cases. */
28305 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28306 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28308 if (vpos
< hlinfo
->mouse_face_beg_row
28309 || vpos
> hlinfo
->mouse_face_end_row
)
28311 if (vpos
> hlinfo
->mouse_face_beg_row
28312 && vpos
< hlinfo
->mouse_face_end_row
)
28315 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28317 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28319 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28322 else if ((vpos
== hlinfo
->mouse_face_beg_row
28323 && hpos
>= hlinfo
->mouse_face_beg_col
)
28324 || (vpos
== hlinfo
->mouse_face_end_row
28325 && hpos
< hlinfo
->mouse_face_end_col
))
28330 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28332 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28335 else if ((vpos
== hlinfo
->mouse_face_beg_row
28336 && hpos
<= hlinfo
->mouse_face_beg_col
)
28337 || (vpos
== hlinfo
->mouse_face_end_row
28338 && hpos
> hlinfo
->mouse_face_end_col
))
28346 True if physical cursor of window W is within mouse face. */
28349 cursor_in_mouse_face_p (struct window
*w
)
28351 int hpos
= w
->phys_cursor
.hpos
;
28352 int vpos
= w
->phys_cursor
.vpos
;
28353 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28355 /* When the window is hscrolled, cursor hpos can legitimately be out
28356 of bounds, but we draw the cursor at the corresponding window
28357 margin in that case. */
28358 if (!row
->reversed_p
&& hpos
< 0)
28360 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28361 hpos
= row
->used
[TEXT_AREA
] - 1;
28363 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28368 /* Find the glyph rows START_ROW and END_ROW of window W that display
28369 characters between buffer positions START_CHARPOS and END_CHARPOS
28370 (excluding END_CHARPOS). DISP_STRING is a display string that
28371 covers these buffer positions. This is similar to
28372 row_containing_pos, but is more accurate when bidi reordering makes
28373 buffer positions change non-linearly with glyph rows. */
28375 rows_from_pos_range (struct window
*w
,
28376 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28377 Lisp_Object disp_string
,
28378 struct glyph_row
**start
, struct glyph_row
**end
)
28380 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28381 int last_y
= window_text_bottom_y (w
);
28382 struct glyph_row
*row
;
28387 while (!first
->enabled_p
28388 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28391 /* Find the START row. */
28393 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28396 /* A row can potentially be the START row if the range of the
28397 characters it displays intersects the range
28398 [START_CHARPOS..END_CHARPOS). */
28399 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28400 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28401 /* See the commentary in row_containing_pos, for the
28402 explanation of the complicated way to check whether
28403 some position is beyond the end of the characters
28404 displayed by a row. */
28405 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28406 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28407 && !row
->ends_at_zv_p
28408 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28409 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28410 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28411 && !row
->ends_at_zv_p
28412 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28414 /* Found a candidate row. Now make sure at least one of the
28415 glyphs it displays has a charpos from the range
28416 [START_CHARPOS..END_CHARPOS).
28418 This is not obvious because bidi reordering could make
28419 buffer positions of a row be 1,2,3,102,101,100, and if we
28420 want to highlight characters in [50..60), we don't want
28421 this row, even though [50..60) does intersect [1..103),
28422 the range of character positions given by the row's start
28423 and end positions. */
28424 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28425 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28429 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28430 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28431 /* A glyph that comes from DISP_STRING is by
28432 definition to be highlighted. */
28433 || EQ (g
->object
, disp_string
))
28442 /* Find the END row. */
28444 /* If the last row is partially visible, start looking for END
28445 from that row, instead of starting from FIRST. */
28446 && !(row
->enabled_p
28447 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28449 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28451 struct glyph_row
*next
= row
+ 1;
28452 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28454 if (!next
->enabled_p
28455 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28456 /* The first row >= START whose range of displayed characters
28457 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28458 is the row END + 1. */
28459 || (start_charpos
< next_start
28460 && end_charpos
< next_start
)
28461 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28462 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28463 && !next
->ends_at_zv_p
28464 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28465 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28466 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28467 && !next
->ends_at_zv_p
28468 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28475 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28476 but none of the characters it displays are in the range, it is
28478 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28479 struct glyph
*s
= g
;
28480 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28484 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28485 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28486 /* If the buffer position of the first glyph in
28487 the row is equal to END_CHARPOS, it means
28488 the last character to be highlighted is the
28489 newline of ROW, and we must consider NEXT as
28491 || (((!next
->reversed_p
&& g
== s
)
28492 || (next
->reversed_p
&& g
== e
- 1))
28493 && (g
->charpos
== end_charpos
28494 /* Special case for when NEXT is an
28495 empty line at ZV. */
28496 || (g
->charpos
== -1
28497 && !row
->ends_at_zv_p
28498 && next_start
== end_charpos
)))))
28499 /* A glyph that comes from DISP_STRING is by
28500 definition to be highlighted. */
28501 || EQ (g
->object
, disp_string
))
28510 /* The first row that ends at ZV must be the last to be
28512 else if (next
->ends_at_zv_p
)
28521 /* This function sets the mouse_face_* elements of HLINFO, assuming
28522 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28523 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28524 for the overlay or run of text properties specifying the mouse
28525 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28526 before-string and after-string that must also be highlighted.
28527 DISP_STRING, if non-nil, is a display string that may cover some
28528 or all of the highlighted text. */
28531 mouse_face_from_buffer_pos (Lisp_Object window
,
28532 Mouse_HLInfo
*hlinfo
,
28533 ptrdiff_t mouse_charpos
,
28534 ptrdiff_t start_charpos
,
28535 ptrdiff_t end_charpos
,
28536 Lisp_Object before_string
,
28537 Lisp_Object after_string
,
28538 Lisp_Object disp_string
)
28540 struct window
*w
= XWINDOW (window
);
28541 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28542 struct glyph_row
*r1
, *r2
;
28543 struct glyph
*glyph
, *end
;
28544 ptrdiff_t ignore
, pos
;
28547 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28548 eassert (NILP (before_string
) || STRINGP (before_string
));
28549 eassert (NILP (after_string
) || STRINGP (after_string
));
28551 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28552 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28554 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28555 /* If the before-string or display-string contains newlines,
28556 rows_from_pos_range skips to its last row. Move back. */
28557 if (!NILP (before_string
) || !NILP (disp_string
))
28559 struct glyph_row
*prev
;
28560 while ((prev
= r1
- 1, prev
>= first
)
28561 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28562 && prev
->used
[TEXT_AREA
] > 0)
28564 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28565 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28566 while (--glyph
>= beg
&& NILP (glyph
->object
));
28568 || !(EQ (glyph
->object
, before_string
)
28569 || EQ (glyph
->object
, disp_string
)))
28576 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28577 hlinfo
->mouse_face_past_end
= true;
28579 else if (!NILP (after_string
))
28581 /* If the after-string has newlines, advance to its last row. */
28582 struct glyph_row
*next
;
28583 struct glyph_row
*last
28584 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28586 for (next
= r2
+ 1;
28588 && next
->used
[TEXT_AREA
] > 0
28589 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28593 /* The rest of the display engine assumes that mouse_face_beg_row is
28594 either above mouse_face_end_row or identical to it. But with
28595 bidi-reordered continued lines, the row for START_CHARPOS could
28596 be below the row for END_CHARPOS. If so, swap the rows and store
28597 them in correct order. */
28600 struct glyph_row
*tem
= r2
;
28606 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28607 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28609 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28610 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28611 could be anywhere in the row and in any order. The strategy
28612 below is to find the leftmost and the rightmost glyph that
28613 belongs to either of these 3 strings, or whose position is
28614 between START_CHARPOS and END_CHARPOS, and highlight all the
28615 glyphs between those two. This may cover more than just the text
28616 between START_CHARPOS and END_CHARPOS if the range of characters
28617 strides the bidi level boundary, e.g. if the beginning is in R2L
28618 text while the end is in L2R text or vice versa. */
28619 if (!r1
->reversed_p
)
28621 /* This row is in a left to right paragraph. Scan it left to
28623 glyph
= r1
->glyphs
[TEXT_AREA
];
28624 end
= glyph
+ r1
->used
[TEXT_AREA
];
28627 /* Skip truncation glyphs at the start of the glyph row. */
28628 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28630 && NILP (glyph
->object
)
28631 && glyph
->charpos
< 0;
28633 x
+= glyph
->pixel_width
;
28635 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28636 or DISP_STRING, and the first glyph from buffer whose
28637 position is between START_CHARPOS and END_CHARPOS. */
28639 && !NILP (glyph
->object
)
28640 && !EQ (glyph
->object
, disp_string
)
28641 && !(BUFFERP (glyph
->object
)
28642 && (glyph
->charpos
>= start_charpos
28643 && glyph
->charpos
< end_charpos
));
28646 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28647 are present at buffer positions between START_CHARPOS and
28648 END_CHARPOS, or if they come from an overlay. */
28649 if (EQ (glyph
->object
, before_string
))
28651 pos
= string_buffer_position (before_string
,
28653 /* If pos == 0, it means before_string came from an
28654 overlay, not from a buffer position. */
28655 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28658 else if (EQ (glyph
->object
, after_string
))
28660 pos
= string_buffer_position (after_string
, end_charpos
);
28661 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28664 x
+= glyph
->pixel_width
;
28666 hlinfo
->mouse_face_beg_x
= x
;
28667 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28671 /* This row is in a right to left paragraph. Scan it right to
28675 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28676 glyph
= end
+ r1
->used
[TEXT_AREA
];
28678 /* Skip truncation glyphs at the start of the glyph row. */
28679 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28681 && NILP (glyph
->object
)
28682 && glyph
->charpos
< 0;
28686 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28687 or DISP_STRING, and the first glyph from buffer whose
28688 position is between START_CHARPOS and END_CHARPOS. */
28690 && !NILP (glyph
->object
)
28691 && !EQ (glyph
->object
, disp_string
)
28692 && !(BUFFERP (glyph
->object
)
28693 && (glyph
->charpos
>= start_charpos
28694 && glyph
->charpos
< end_charpos
));
28697 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28698 are present at buffer positions between START_CHARPOS and
28699 END_CHARPOS, or if they come from an overlay. */
28700 if (EQ (glyph
->object
, before_string
))
28702 pos
= string_buffer_position (before_string
, start_charpos
);
28703 /* If pos == 0, it means before_string came from an
28704 overlay, not from a buffer position. */
28705 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28708 else if (EQ (glyph
->object
, after_string
))
28710 pos
= string_buffer_position (after_string
, end_charpos
);
28711 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28716 glyph
++; /* first glyph to the right of the highlighted area */
28717 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28718 x
+= g
->pixel_width
;
28719 hlinfo
->mouse_face_beg_x
= x
;
28720 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28723 /* If the highlight ends in a different row, compute GLYPH and END
28724 for the end row. Otherwise, reuse the values computed above for
28725 the row where the highlight begins. */
28728 if (!r2
->reversed_p
)
28730 glyph
= r2
->glyphs
[TEXT_AREA
];
28731 end
= glyph
+ r2
->used
[TEXT_AREA
];
28736 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28737 glyph
= end
+ r2
->used
[TEXT_AREA
];
28741 if (!r2
->reversed_p
)
28743 /* Skip truncation and continuation glyphs near the end of the
28744 row, and also blanks and stretch glyphs inserted by
28745 extend_face_to_end_of_line. */
28747 && NILP ((end
- 1)->object
))
28749 /* Scan the rest of the glyph row from the end, looking for the
28750 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28751 DISP_STRING, or whose position is between START_CHARPOS
28755 && !NILP (end
->object
)
28756 && !EQ (end
->object
, disp_string
)
28757 && !(BUFFERP (end
->object
)
28758 && (end
->charpos
>= start_charpos
28759 && end
->charpos
< end_charpos
));
28762 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28763 are present at buffer positions between START_CHARPOS and
28764 END_CHARPOS, or if they come from an overlay. */
28765 if (EQ (end
->object
, before_string
))
28767 pos
= string_buffer_position (before_string
, start_charpos
);
28768 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28771 else if (EQ (end
->object
, after_string
))
28773 pos
= string_buffer_position (after_string
, end_charpos
);
28774 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28778 /* Find the X coordinate of the last glyph to be highlighted. */
28779 for (; glyph
<= end
; ++glyph
)
28780 x
+= glyph
->pixel_width
;
28782 hlinfo
->mouse_face_end_x
= x
;
28783 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28787 /* Skip truncation and continuation glyphs near the end of the
28788 row, and also blanks and stretch glyphs inserted by
28789 extend_face_to_end_of_line. */
28793 && NILP (end
->object
))
28795 x
+= end
->pixel_width
;
28798 /* Scan the rest of the glyph row from the end, looking for the
28799 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28800 DISP_STRING, or whose position is between START_CHARPOS
28804 && !NILP (end
->object
)
28805 && !EQ (end
->object
, disp_string
)
28806 && !(BUFFERP (end
->object
)
28807 && (end
->charpos
>= start_charpos
28808 && end
->charpos
< end_charpos
));
28811 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28812 are present at buffer positions between START_CHARPOS and
28813 END_CHARPOS, or if they come from an overlay. */
28814 if (EQ (end
->object
, before_string
))
28816 pos
= string_buffer_position (before_string
, start_charpos
);
28817 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28820 else if (EQ (end
->object
, after_string
))
28822 pos
= string_buffer_position (after_string
, end_charpos
);
28823 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28826 x
+= end
->pixel_width
;
28828 /* If we exited the above loop because we arrived at the last
28829 glyph of the row, and its buffer position is still not in
28830 range, it means the last character in range is the preceding
28831 newline. Bump the end column and x values to get past the
28834 && BUFFERP (end
->object
)
28835 && (end
->charpos
< start_charpos
28836 || end
->charpos
>= end_charpos
))
28838 x
+= end
->pixel_width
;
28841 hlinfo
->mouse_face_end_x
= x
;
28842 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28845 hlinfo
->mouse_face_window
= window
;
28846 hlinfo
->mouse_face_face_id
28847 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28849 !hlinfo
->mouse_face_hidden
, -1);
28850 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28853 /* The following function is not used anymore (replaced with
28854 mouse_face_from_string_pos), but I leave it here for the time
28855 being, in case someone would. */
28857 #if false /* not used */
28859 /* Find the position of the glyph for position POS in OBJECT in
28860 window W's current matrix, and return in *X, *Y the pixel
28861 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28863 RIGHT_P means return the position of the right edge of the glyph.
28864 !RIGHT_P means return the left edge position.
28866 If no glyph for POS exists in the matrix, return the position of
28867 the glyph with the next smaller position that is in the matrix, if
28868 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28869 exists in the matrix, return the position of the glyph with the
28870 next larger position in OBJECT.
28872 Value is true if a glyph was found. */
28875 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28876 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28878 int yb
= window_text_bottom_y (w
);
28879 struct glyph_row
*r
;
28880 struct glyph
*best_glyph
= NULL
;
28881 struct glyph_row
*best_row
= NULL
;
28884 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28885 r
->enabled_p
&& r
->y
< yb
;
28888 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28889 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28892 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28893 if (EQ (g
->object
, object
))
28895 if (g
->charpos
== pos
)
28902 else if (best_glyph
== NULL
28903 || ((eabs (g
->charpos
- pos
)
28904 < eabs (best_glyph
->charpos
- pos
))
28907 : g
->charpos
> pos
)))
28921 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28925 *x
+= best_glyph
->pixel_width
;
28930 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28933 return best_glyph
!= NULL
;
28935 #endif /* not used */
28937 /* Find the positions of the first and the last glyphs in window W's
28938 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28939 (assumed to be a string), and return in HLINFO's mouse_face_*
28940 members the pixel and column/row coordinates of those glyphs. */
28943 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28944 Lisp_Object object
,
28945 ptrdiff_t startpos
, ptrdiff_t endpos
)
28947 int yb
= window_text_bottom_y (w
);
28948 struct glyph_row
*r
;
28949 struct glyph
*g
, *e
;
28951 bool found
= false;
28953 /* Find the glyph row with at least one position in the range
28954 [STARTPOS..ENDPOS), and the first glyph in that row whose
28955 position belongs to that range. */
28956 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28957 r
->enabled_p
&& r
->y
< yb
;
28960 if (!r
->reversed_p
)
28962 g
= r
->glyphs
[TEXT_AREA
];
28963 e
= g
+ r
->used
[TEXT_AREA
];
28964 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28965 if (EQ (g
->object
, object
)
28966 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28968 hlinfo
->mouse_face_beg_row
28969 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28970 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28971 hlinfo
->mouse_face_beg_x
= gx
;
28980 e
= r
->glyphs
[TEXT_AREA
];
28981 g
= e
+ r
->used
[TEXT_AREA
];
28982 for ( ; g
> e
; --g
)
28983 if (EQ ((g
-1)->object
, object
)
28984 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28986 hlinfo
->mouse_face_beg_row
28987 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28988 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28989 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28990 gx
+= g1
->pixel_width
;
28991 hlinfo
->mouse_face_beg_x
= gx
;
29003 /* Starting with the next row, look for the first row which does NOT
29004 include any glyphs whose positions are in the range. */
29005 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29007 g
= r
->glyphs
[TEXT_AREA
];
29008 e
= g
+ r
->used
[TEXT_AREA
];
29010 for ( ; g
< e
; ++g
)
29011 if (EQ (g
->object
, object
)
29012 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29021 /* The highlighted region ends on the previous row. */
29024 /* Set the end row. */
29025 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29027 /* Compute and set the end column and the end column's horizontal
29028 pixel coordinate. */
29029 if (!r
->reversed_p
)
29031 g
= r
->glyphs
[TEXT_AREA
];
29032 e
= g
+ r
->used
[TEXT_AREA
];
29033 for ( ; e
> g
; --e
)
29034 if (EQ ((e
-1)->object
, object
)
29035 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29037 hlinfo
->mouse_face_end_col
= e
- g
;
29039 for (gx
= r
->x
; g
< e
; ++g
)
29040 gx
+= g
->pixel_width
;
29041 hlinfo
->mouse_face_end_x
= gx
;
29045 e
= r
->glyphs
[TEXT_AREA
];
29046 g
= e
+ r
->used
[TEXT_AREA
];
29047 for (gx
= r
->x
; e
< g
; ++e
)
29049 if (EQ (e
->object
, object
)
29050 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29052 gx
+= e
->pixel_width
;
29054 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29055 hlinfo
->mouse_face_end_x
= gx
;
29059 #ifdef HAVE_WINDOW_SYSTEM
29061 /* See if position X, Y is within a hot-spot of an image. */
29064 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29066 if (!CONSP (hot_spot
))
29069 if (EQ (XCAR (hot_spot
), Qrect
))
29071 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29072 Lisp_Object rect
= XCDR (hot_spot
);
29076 if (!CONSP (XCAR (rect
)))
29078 if (!CONSP (XCDR (rect
)))
29080 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29082 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29084 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29086 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29090 else if (EQ (XCAR (hot_spot
), Qcircle
))
29092 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29093 Lisp_Object circ
= XCDR (hot_spot
);
29094 Lisp_Object lr
, lx0
, ly0
;
29096 && CONSP (XCAR (circ
))
29097 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
29098 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29099 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29101 double r
= XFLOATINT (lr
);
29102 double dx
= XINT (lx0
) - x
;
29103 double dy
= XINT (ly0
) - y
;
29104 return (dx
* dx
+ dy
* dy
<= r
* r
);
29107 else if (EQ (XCAR (hot_spot
), Qpoly
))
29109 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29110 if (VECTORP (XCDR (hot_spot
)))
29112 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29113 Lisp_Object
*poly
= v
->contents
;
29114 ptrdiff_t n
= v
->header
.size
;
29116 bool inside
= false;
29117 Lisp_Object lx
, ly
;
29120 /* Need an even number of coordinates, and at least 3 edges. */
29121 if (n
< 6 || n
& 1)
29124 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29125 If count is odd, we are inside polygon. Pixels on edges
29126 may or may not be included depending on actual geometry of the
29128 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29129 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29131 x0
= XINT (lx
), y0
= XINT (ly
);
29132 for (i
= 0; i
< n
; i
+= 2)
29134 int x1
= x0
, y1
= y0
;
29135 if ((lx
= poly
[i
], !INTEGERP (lx
))
29136 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29138 x0
= XINT (lx
), y0
= XINT (ly
);
29140 /* Does this segment cross the X line? */
29148 if (y
> y0
&& y
> y1
)
29150 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29160 find_hot_spot (Lisp_Object map
, int x
, int y
)
29162 while (CONSP (map
))
29164 if (CONSP (XCAR (map
))
29165 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29173 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29175 doc
: /* Lookup in image map MAP coordinates X and Y.
29176 An image map is an alist where each element has the format (AREA ID PLIST).
29177 An AREA is specified as either a rectangle, a circle, or a polygon:
29178 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29179 pixel coordinates of the upper left and bottom right corners.
29180 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29181 and the radius of the circle; r may be a float or integer.
29182 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29183 vector describes one corner in the polygon.
29184 Returns the alist element for the first matching AREA in MAP. */)
29185 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29193 return find_hot_spot (map
,
29194 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29195 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29199 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29201 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29203 /* Do not change cursor shape while dragging mouse. */
29204 if (EQ (do_mouse_tracking
, Qdragging
))
29207 if (!NILP (pointer
))
29209 if (EQ (pointer
, Qarrow
))
29210 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29211 else if (EQ (pointer
, Qhand
))
29212 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29213 else if (EQ (pointer
, Qtext
))
29214 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29215 else if (EQ (pointer
, intern ("hdrag")))
29216 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29217 else if (EQ (pointer
, intern ("nhdrag")))
29218 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29219 #ifdef HAVE_X_WINDOWS
29220 else if (EQ (pointer
, intern ("vdrag")))
29221 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29223 else if (EQ (pointer
, intern ("hourglass")))
29224 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29225 else if (EQ (pointer
, Qmodeline
))
29226 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29228 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29231 if (cursor
!= No_Cursor
)
29232 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29235 #endif /* HAVE_WINDOW_SYSTEM */
29237 /* Take proper action when mouse has moved to the mode or header line
29238 or marginal area AREA of window W, x-position X and y-position Y.
29239 X is relative to the start of the text display area of W, so the
29240 width of bitmap areas and scroll bars must be subtracted to get a
29241 position relative to the start of the mode line. */
29244 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29245 enum window_part area
)
29247 struct window
*w
= XWINDOW (window
);
29248 struct frame
*f
= XFRAME (w
->frame
);
29249 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29250 #ifdef HAVE_WINDOW_SYSTEM
29251 Display_Info
*dpyinfo
;
29253 Cursor cursor
= No_Cursor
;
29254 Lisp_Object pointer
= Qnil
;
29255 int dx
, dy
, width
, height
;
29257 Lisp_Object string
, object
= Qnil
;
29258 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29260 Lisp_Object mouse_face
;
29261 int original_x_pixel
= x
;
29262 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29263 struct glyph_row
*row
IF_LINT (= 0);
29265 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29270 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29271 returns them in row/column units! */
29272 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29273 &object
, &dx
, &dy
, &width
, &height
);
29275 row
= (area
== ON_MODE_LINE
29276 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29277 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29279 /* Find the glyph under the mouse pointer. */
29280 if (row
->mode_line_p
&& row
->enabled_p
)
29282 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29283 end
= glyph
+ row
->used
[TEXT_AREA
];
29285 for (x0
= original_x_pixel
;
29286 glyph
< end
&& x0
>= glyph
->pixel_width
;
29288 x0
-= glyph
->pixel_width
;
29296 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29297 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29298 returns them in row/column units! */
29299 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29300 &object
, &dx
, &dy
, &width
, &height
);
29305 #ifdef HAVE_WINDOW_SYSTEM
29306 if (IMAGEP (object
))
29308 Lisp_Object image_map
, hotspot
;
29309 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29311 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29313 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29317 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29318 If so, we could look for mouse-enter, mouse-leave
29319 properties in PLIST (and do something...). */
29320 hotspot
= XCDR (hotspot
);
29321 if (CONSP (hotspot
)
29322 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29324 pointer
= Fplist_get (plist
, Qpointer
);
29325 if (NILP (pointer
))
29327 help
= Fplist_get (plist
, Qhelp_echo
);
29330 help_echo_string
= help
;
29331 XSETWINDOW (help_echo_window
, w
);
29332 help_echo_object
= w
->contents
;
29333 help_echo_pos
= charpos
;
29337 if (NILP (pointer
))
29338 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29340 #endif /* HAVE_WINDOW_SYSTEM */
29342 if (STRINGP (string
))
29343 pos
= make_number (charpos
);
29345 /* Set the help text and mouse pointer. If the mouse is on a part
29346 of the mode line without any text (e.g. past the right edge of
29347 the mode line text), use the default help text and pointer. */
29348 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29350 /* Arrange to display the help by setting the global variables
29351 help_echo_string, help_echo_object, and help_echo_pos. */
29354 if (STRINGP (string
))
29355 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29359 help_echo_string
= help
;
29360 XSETWINDOW (help_echo_window
, w
);
29361 help_echo_object
= string
;
29362 help_echo_pos
= charpos
;
29364 else if (area
== ON_MODE_LINE
)
29366 Lisp_Object default_help
29367 = buffer_local_value (Qmode_line_default_help_echo
,
29370 if (STRINGP (default_help
))
29372 help_echo_string
= default_help
;
29373 XSETWINDOW (help_echo_window
, w
);
29374 help_echo_object
= Qnil
;
29375 help_echo_pos
= -1;
29380 #ifdef HAVE_WINDOW_SYSTEM
29381 /* Change the mouse pointer according to what is under it. */
29382 if (FRAME_WINDOW_P (f
))
29384 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29386 || NILP (Vresize_mini_windows
));
29388 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29389 if (STRINGP (string
))
29391 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29393 if (NILP (pointer
))
29394 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29396 /* Change the mouse pointer according to what is under X/Y. */
29398 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29401 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29402 if (!KEYMAPP (map
))
29403 map
= Fget_text_property (pos
, Qkeymap
, string
);
29404 if (!KEYMAPP (map
) && draggable
)
29405 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29408 else if (draggable
)
29409 /* Default mode-line pointer. */
29410 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29415 /* Change the mouse face according to what is under X/Y. */
29416 bool mouse_face_shown
= false;
29417 if (STRINGP (string
))
29419 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29420 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29421 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29426 struct glyph
* tmp_glyph
;
29430 int total_pixel_width
;
29431 ptrdiff_t begpos
, endpos
, ignore
;
29435 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29436 Qmouse_face
, string
, Qnil
);
29442 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29444 endpos
= SCHARS (string
);
29448 /* Calculate the glyph position GPOS of GLYPH in the
29449 displayed string, relative to the beginning of the
29450 highlighted part of the string.
29452 Note: GPOS is different from CHARPOS. CHARPOS is the
29453 position of GLYPH in the internal string object. A mode
29454 line string format has structures which are converted to
29455 a flattened string by the Emacs Lisp interpreter. The
29456 internal string is an element of those structures. The
29457 displayed string is the flattened string. */
29458 tmp_glyph
= row_start_glyph
;
29459 while (tmp_glyph
< glyph
29460 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29461 && begpos
<= tmp_glyph
->charpos
29462 && tmp_glyph
->charpos
< endpos
)))
29464 gpos
= glyph
- tmp_glyph
;
29466 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29467 the highlighted part of the displayed string to which
29468 GLYPH belongs. Note: GSEQ_LENGTH is different from
29469 SCHARS (STRING), because the latter returns the length of
29470 the internal string. */
29471 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29473 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29474 && begpos
<= tmp_glyph
->charpos
29475 && tmp_glyph
->charpos
< endpos
));
29478 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29480 /* Calculate the total pixel width of all the glyphs between
29481 the beginning of the highlighted area and GLYPH. */
29482 total_pixel_width
= 0;
29483 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29484 total_pixel_width
+= tmp_glyph
->pixel_width
;
29486 /* Pre calculation of re-rendering position. Note: X is in
29487 column units here, after the call to mode_line_string or
29488 marginal_area_string. */
29490 vpos
= (area
== ON_MODE_LINE
29491 ? (w
->current_matrix
)->nrows
- 1
29494 /* If GLYPH's position is included in the region that is
29495 already drawn in mouse face, we have nothing to do. */
29496 if ( EQ (window
, hlinfo
->mouse_face_window
)
29497 && (!row
->reversed_p
29498 ? (hlinfo
->mouse_face_beg_col
<= hpos
29499 && hpos
< hlinfo
->mouse_face_end_col
)
29500 /* In R2L rows we swap BEG and END, see below. */
29501 : (hlinfo
->mouse_face_end_col
<= hpos
29502 && hpos
< hlinfo
->mouse_face_beg_col
))
29503 && hlinfo
->mouse_face_beg_row
== vpos
)
29506 if (clear_mouse_face (hlinfo
))
29507 cursor
= No_Cursor
;
29509 if (!row
->reversed_p
)
29511 hlinfo
->mouse_face_beg_col
= hpos
;
29512 hlinfo
->mouse_face_beg_x
= original_x_pixel
29513 - (total_pixel_width
+ dx
);
29514 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29515 hlinfo
->mouse_face_end_x
= 0;
29519 /* In R2L rows, show_mouse_face expects BEG and END
29520 coordinates to be swapped. */
29521 hlinfo
->mouse_face_end_col
= hpos
;
29522 hlinfo
->mouse_face_end_x
= original_x_pixel
29523 - (total_pixel_width
+ dx
);
29524 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29525 hlinfo
->mouse_face_beg_x
= 0;
29528 hlinfo
->mouse_face_beg_row
= vpos
;
29529 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29530 hlinfo
->mouse_face_past_end
= false;
29531 hlinfo
->mouse_face_window
= window
;
29533 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29538 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29539 mouse_face_shown
= true;
29541 if (NILP (pointer
))
29546 /* If mouse-face doesn't need to be shown, clear any existing
29548 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29549 clear_mouse_face (hlinfo
);
29551 #ifdef HAVE_WINDOW_SYSTEM
29552 if (FRAME_WINDOW_P (f
))
29553 define_frame_cursor1 (f
, cursor
, pointer
);
29559 Take proper action when the mouse has moved to position X, Y on
29560 frame F with regards to highlighting portions of display that have
29561 mouse-face properties. Also de-highlight portions of display where
29562 the mouse was before, set the mouse pointer shape as appropriate
29563 for the mouse coordinates, and activate help echo (tooltips).
29564 X and Y can be negative or out of range. */
29567 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29569 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29570 enum window_part part
= ON_NOTHING
;
29571 Lisp_Object window
;
29573 Cursor cursor
= No_Cursor
;
29574 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29577 /* When a menu is active, don't highlight because this looks odd. */
29578 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29579 if (popup_activated ())
29583 if (!f
->glyphs_initialized_p
29584 || f
->pointer_invisible
)
29587 hlinfo
->mouse_face_mouse_x
= x
;
29588 hlinfo
->mouse_face_mouse_y
= y
;
29589 hlinfo
->mouse_face_mouse_frame
= f
;
29591 if (hlinfo
->mouse_face_defer
)
29594 /* Which window is that in? */
29595 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29597 /* If displaying active text in another window, clear that. */
29598 if (! EQ (window
, hlinfo
->mouse_face_window
)
29599 /* Also clear if we move out of text area in same window. */
29600 || (!NILP (hlinfo
->mouse_face_window
)
29603 && part
!= ON_MODE_LINE
29604 && part
!= ON_HEADER_LINE
))
29605 clear_mouse_face (hlinfo
);
29607 /* Not on a window -> return. */
29608 if (!WINDOWP (window
))
29611 /* Reset help_echo_string. It will get recomputed below. */
29612 help_echo_string
= Qnil
;
29614 /* Convert to window-relative pixel coordinates. */
29615 w
= XWINDOW (window
);
29616 frame_to_window_pixel_xy (w
, &x
, &y
);
29618 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29619 /* Handle tool-bar window differently since it doesn't display a
29621 if (EQ (window
, f
->tool_bar_window
))
29623 note_tool_bar_highlight (f
, x
, y
);
29628 /* Mouse is on the mode, header line or margin? */
29629 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29630 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29632 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29634 #ifdef HAVE_WINDOW_SYSTEM
29635 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29637 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29638 /* Show non-text cursor (Bug#16647). */
29646 #ifdef HAVE_WINDOW_SYSTEM
29647 if (part
== ON_VERTICAL_BORDER
)
29649 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29650 help_echo_string
= build_string ("drag-mouse-1: resize");
29652 else if (part
== ON_RIGHT_DIVIDER
)
29654 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29655 help_echo_string
= build_string ("drag-mouse-1: resize");
29657 else if (part
== ON_BOTTOM_DIVIDER
)
29658 if (! WINDOW_BOTTOMMOST_P (w
)
29660 || NILP (Vresize_mini_windows
))
29662 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29663 help_echo_string
= build_string ("drag-mouse-1: resize");
29666 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29667 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29668 || part
== ON_VERTICAL_SCROLL_BAR
29669 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29670 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29672 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29675 /* Are we in a window whose display is up to date?
29676 And verify the buffer's text has not changed. */
29677 b
= XBUFFER (w
->contents
);
29678 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29680 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29682 struct glyph
*glyph
;
29683 Lisp_Object object
;
29684 Lisp_Object mouse_face
= Qnil
, position
;
29685 Lisp_Object
*overlay_vec
= NULL
;
29686 ptrdiff_t i
, noverlays
;
29687 struct buffer
*obuf
;
29688 ptrdiff_t obegv
, ozv
;
29691 /* Find the glyph under X/Y. */
29692 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29694 #ifdef HAVE_WINDOW_SYSTEM
29695 /* Look for :pointer property on image. */
29696 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29698 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29699 if (img
!= NULL
&& IMAGEP (img
->spec
))
29701 Lisp_Object image_map
, hotspot
;
29702 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29704 && (hotspot
= find_hot_spot (image_map
,
29705 glyph
->slice
.img
.x
+ dx
,
29706 glyph
->slice
.img
.y
+ dy
),
29708 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29712 /* Could check XCAR (hotspot) to see if we enter/leave
29714 If so, we could look for mouse-enter, mouse-leave
29715 properties in PLIST (and do something...). */
29716 hotspot
= XCDR (hotspot
);
29717 if (CONSP (hotspot
)
29718 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29720 pointer
= Fplist_get (plist
, Qpointer
);
29721 if (NILP (pointer
))
29723 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29724 if (!NILP (help_echo_string
))
29726 help_echo_window
= window
;
29727 help_echo_object
= glyph
->object
;
29728 help_echo_pos
= glyph
->charpos
;
29732 if (NILP (pointer
))
29733 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29736 #endif /* HAVE_WINDOW_SYSTEM */
29738 /* Clear mouse face if X/Y not over text. */
29740 || area
!= TEXT_AREA
29741 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29742 /* Glyph's OBJECT is nil for glyphs inserted by the
29743 display engine for its internal purposes, like truncation
29744 and continuation glyphs and blanks beyond the end of
29745 line's text on text terminals. If we are over such a
29746 glyph, we are not over any text. */
29747 || NILP (glyph
->object
)
29748 /* R2L rows have a stretch glyph at their front, which
29749 stands for no text, whereas L2R rows have no glyphs at
29750 all beyond the end of text. Treat such stretch glyphs
29751 like we do with NULL glyphs in L2R rows. */
29752 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29753 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29754 && glyph
->type
== STRETCH_GLYPH
29755 && glyph
->avoid_cursor_p
))
29757 if (clear_mouse_face (hlinfo
))
29758 cursor
= No_Cursor
;
29759 #ifdef HAVE_WINDOW_SYSTEM
29760 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29762 if (area
!= TEXT_AREA
)
29763 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29765 pointer
= Vvoid_text_area_pointer
;
29771 pos
= glyph
->charpos
;
29772 object
= glyph
->object
;
29773 if (!STRINGP (object
) && !BUFFERP (object
))
29776 /* If we get an out-of-range value, return now; avoid an error. */
29777 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29780 /* Make the window's buffer temporarily current for
29781 overlays_at and compute_char_face. */
29782 obuf
= current_buffer
;
29783 current_buffer
= b
;
29789 /* Is this char mouse-active or does it have help-echo? */
29790 position
= make_number (pos
);
29794 if (BUFFERP (object
))
29796 /* Put all the overlays we want in a vector in overlay_vec. */
29797 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29798 /* Sort overlays into increasing priority order. */
29799 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29804 if (NILP (Vmouse_highlight
))
29806 clear_mouse_face (hlinfo
);
29807 goto check_help_echo
;
29810 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29813 cursor
= No_Cursor
;
29815 /* Check mouse-face highlighting. */
29817 /* If there exists an overlay with mouse-face overlapping
29818 the one we are currently highlighting, we have to
29819 check if we enter the overlapping overlay, and then
29820 highlight only that. */
29821 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29822 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29824 /* Find the highest priority overlay with a mouse-face. */
29825 Lisp_Object overlay
= Qnil
;
29826 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29828 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29829 if (!NILP (mouse_face
))
29830 overlay
= overlay_vec
[i
];
29833 /* If we're highlighting the same overlay as before, there's
29834 no need to do that again. */
29835 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29836 goto check_help_echo
;
29837 hlinfo
->mouse_face_overlay
= overlay
;
29839 /* Clear the display of the old active region, if any. */
29840 if (clear_mouse_face (hlinfo
))
29841 cursor
= No_Cursor
;
29843 /* If no overlay applies, get a text property. */
29844 if (NILP (overlay
))
29845 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29847 /* Next, compute the bounds of the mouse highlighting and
29849 if (!NILP (mouse_face
) && STRINGP (object
))
29851 /* The mouse-highlighting comes from a display string
29852 with a mouse-face. */
29856 s
= Fprevious_single_property_change
29857 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29858 e
= Fnext_single_property_change
29859 (position
, Qmouse_face
, object
, Qnil
);
29861 s
= make_number (0);
29863 e
= make_number (SCHARS (object
));
29864 mouse_face_from_string_pos (w
, hlinfo
, object
,
29865 XINT (s
), XINT (e
));
29866 hlinfo
->mouse_face_past_end
= false;
29867 hlinfo
->mouse_face_window
= window
;
29868 hlinfo
->mouse_face_face_id
29869 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29870 glyph
->face_id
, true);
29871 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29872 cursor
= No_Cursor
;
29876 /* The mouse-highlighting, if any, comes from an overlay
29877 or text property in the buffer. */
29878 Lisp_Object buffer
IF_LINT (= Qnil
);
29879 Lisp_Object disp_string
IF_LINT (= Qnil
);
29881 if (STRINGP (object
))
29883 /* If we are on a display string with no mouse-face,
29884 check if the text under it has one. */
29885 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29886 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29887 pos
= string_buffer_position (object
, start
);
29890 mouse_face
= get_char_property_and_overlay
29891 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29892 buffer
= w
->contents
;
29893 disp_string
= object
;
29899 disp_string
= Qnil
;
29902 if (!NILP (mouse_face
))
29904 Lisp_Object before
, after
;
29905 Lisp_Object before_string
, after_string
;
29906 /* To correctly find the limits of mouse highlight
29907 in a bidi-reordered buffer, we must not use the
29908 optimization of limiting the search in
29909 previous-single-property-change and
29910 next-single-property-change, because
29911 rows_from_pos_range needs the real start and end
29912 positions to DTRT in this case. That's because
29913 the first row visible in a window does not
29914 necessarily display the character whose position
29915 is the smallest. */
29917 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29918 ? Fmarker_position (w
->start
)
29921 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29922 ? make_number (BUF_Z (XBUFFER (buffer
))
29923 - w
->window_end_pos
)
29926 if (NILP (overlay
))
29928 /* Handle the text property case. */
29929 before
= Fprevious_single_property_change
29930 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29931 after
= Fnext_single_property_change
29932 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29933 before_string
= after_string
= Qnil
;
29937 /* Handle the overlay case. */
29938 before
= Foverlay_start (overlay
);
29939 after
= Foverlay_end (overlay
);
29940 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29941 after_string
= Foverlay_get (overlay
, Qafter_string
);
29943 if (!STRINGP (before_string
)) before_string
= Qnil
;
29944 if (!STRINGP (after_string
)) after_string
= Qnil
;
29947 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29950 : XFASTINT (before
),
29952 ? BUF_Z (XBUFFER (buffer
))
29953 : XFASTINT (after
),
29954 before_string
, after_string
,
29956 cursor
= No_Cursor
;
29963 /* Look for a `help-echo' property. */
29964 if (NILP (help_echo_string
)) {
29965 Lisp_Object help
, overlay
;
29967 /* Check overlays first. */
29968 help
= overlay
= Qnil
;
29969 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29971 overlay
= overlay_vec
[i
];
29972 help
= Foverlay_get (overlay
, Qhelp_echo
);
29977 help_echo_string
= help
;
29978 help_echo_window
= window
;
29979 help_echo_object
= overlay
;
29980 help_echo_pos
= pos
;
29984 Lisp_Object obj
= glyph
->object
;
29985 ptrdiff_t charpos
= glyph
->charpos
;
29987 /* Try text properties. */
29990 && charpos
< SCHARS (obj
))
29992 help
= Fget_text_property (make_number (charpos
),
29996 /* If the string itself doesn't specify a help-echo,
29997 see if the buffer text ``under'' it does. */
29998 struct glyph_row
*r
29999 = MATRIX_ROW (w
->current_matrix
, vpos
);
30000 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30001 ptrdiff_t p
= string_buffer_position (obj
, start
);
30004 help
= Fget_char_property (make_number (p
),
30005 Qhelp_echo
, w
->contents
);
30014 else if (BUFFERP (obj
)
30017 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30022 help_echo_string
= help
;
30023 help_echo_window
= window
;
30024 help_echo_object
= obj
;
30025 help_echo_pos
= charpos
;
30030 #ifdef HAVE_WINDOW_SYSTEM
30031 /* Look for a `pointer' property. */
30032 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30034 /* Check overlays first. */
30035 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30036 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30038 if (NILP (pointer
))
30040 Lisp_Object obj
= glyph
->object
;
30041 ptrdiff_t charpos
= glyph
->charpos
;
30043 /* Try text properties. */
30046 && charpos
< SCHARS (obj
))
30048 pointer
= Fget_text_property (make_number (charpos
),
30050 if (NILP (pointer
))
30052 /* If the string itself doesn't specify a pointer,
30053 see if the buffer text ``under'' it does. */
30054 struct glyph_row
*r
30055 = MATRIX_ROW (w
->current_matrix
, vpos
);
30056 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30057 ptrdiff_t p
= string_buffer_position (obj
, start
);
30059 pointer
= Fget_char_property (make_number (p
),
30060 Qpointer
, w
->contents
);
30063 else if (BUFFERP (obj
)
30066 pointer
= Fget_text_property (make_number (charpos
),
30070 #endif /* HAVE_WINDOW_SYSTEM */
30074 current_buffer
= obuf
;
30080 #ifdef HAVE_WINDOW_SYSTEM
30081 if (FRAME_WINDOW_P (f
))
30082 define_frame_cursor1 (f
, cursor
, pointer
);
30084 /* This is here to prevent a compiler error, about "label at end of
30085 compound statement". */
30092 Clear any mouse-face on window W. This function is part of the
30093 redisplay interface, and is called from try_window_id and similar
30094 functions to ensure the mouse-highlight is off. */
30097 x_clear_window_mouse_face (struct window
*w
)
30099 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30100 Lisp_Object window
;
30103 XSETWINDOW (window
, w
);
30104 if (EQ (window
, hlinfo
->mouse_face_window
))
30105 clear_mouse_face (hlinfo
);
30111 Just discard the mouse face information for frame F, if any.
30112 This is used when the size of F is changed. */
30115 cancel_mouse_face (struct frame
*f
)
30117 Lisp_Object window
;
30118 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30120 window
= hlinfo
->mouse_face_window
;
30121 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30122 reset_mouse_highlight (hlinfo
);
30127 /***********************************************************************
30129 ***********************************************************************/
30131 #ifdef HAVE_WINDOW_SYSTEM
30133 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30134 which intersects rectangle R. R is in window-relative coordinates. */
30137 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30138 enum glyph_row_area area
)
30140 struct glyph
*first
= row
->glyphs
[area
];
30141 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30142 struct glyph
*last
;
30143 int first_x
, start_x
, x
;
30145 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30146 /* If row extends face to end of line write the whole line. */
30147 draw_glyphs (w
, 0, row
, area
,
30148 0, row
->used
[area
],
30149 DRAW_NORMAL_TEXT
, 0);
30152 /* Set START_X to the window-relative start position for drawing glyphs of
30153 AREA. The first glyph of the text area can be partially visible.
30154 The first glyphs of other areas cannot. */
30155 start_x
= window_box_left_offset (w
, area
);
30157 if (area
== TEXT_AREA
)
30160 /* Find the first glyph that must be redrawn. */
30162 && x
+ first
->pixel_width
< r
->x
)
30164 x
+= first
->pixel_width
;
30168 /* Find the last one. */
30171 /* Use a signed int intermediate value to avoid catastrophic
30172 failures due to comparison between signed and unsigned, when
30173 x is negative (can happen for wide images that are hscrolled). */
30174 int r_end
= r
->x
+ r
->width
;
30175 while (last
< end
&& x
< r_end
)
30177 x
+= last
->pixel_width
;
30183 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30184 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30185 DRAW_NORMAL_TEXT
, 0);
30190 /* Redraw the parts of the glyph row ROW on window W intersecting
30191 rectangle R. R is in window-relative coordinates. Value is
30192 true if mouse-face was overwritten. */
30195 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30197 eassert (row
->enabled_p
);
30199 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30200 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30201 0, row
->used
[TEXT_AREA
],
30202 DRAW_NORMAL_TEXT
, 0);
30205 if (row
->used
[LEFT_MARGIN_AREA
])
30206 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30207 if (row
->used
[TEXT_AREA
])
30208 expose_area (w
, row
, r
, TEXT_AREA
);
30209 if (row
->used
[RIGHT_MARGIN_AREA
])
30210 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30211 draw_row_fringe_bitmaps (w
, row
);
30214 return row
->mouse_face_p
;
30218 /* Redraw those parts of glyphs rows during expose event handling that
30219 overlap other rows. Redrawing of an exposed line writes over parts
30220 of lines overlapping that exposed line; this function fixes that.
30222 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30223 row in W's current matrix that is exposed and overlaps other rows.
30224 LAST_OVERLAPPING_ROW is the last such row. */
30227 expose_overlaps (struct window
*w
,
30228 struct glyph_row
*first_overlapping_row
,
30229 struct glyph_row
*last_overlapping_row
,
30232 struct glyph_row
*row
;
30234 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30235 if (row
->overlapping_p
)
30237 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30240 if (row
->used
[LEFT_MARGIN_AREA
])
30241 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30243 if (row
->used
[TEXT_AREA
])
30244 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30246 if (row
->used
[RIGHT_MARGIN_AREA
])
30247 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30253 /* Return true if W's cursor intersects rectangle R. */
30256 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30258 XRectangle cr
, result
;
30259 struct glyph
*cursor_glyph
;
30260 struct glyph_row
*row
;
30262 if (w
->phys_cursor
.vpos
>= 0
30263 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30264 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30266 && row
->cursor_in_fringe_p
)
30268 /* Cursor is in the fringe. */
30269 cr
.x
= window_box_right_offset (w
,
30270 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30271 ? RIGHT_MARGIN_AREA
30274 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30275 cr
.height
= row
->height
;
30276 return x_intersect_rectangles (&cr
, r
, &result
);
30279 cursor_glyph
= get_phys_cursor_glyph (w
);
30282 /* r is relative to W's box, but w->phys_cursor.x is relative
30283 to left edge of W's TEXT area. Adjust it. */
30284 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30285 cr
.y
= w
->phys_cursor
.y
;
30286 cr
.width
= cursor_glyph
->pixel_width
;
30287 cr
.height
= w
->phys_cursor_height
;
30288 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30289 I assume the effect is the same -- and this is portable. */
30290 return x_intersect_rectangles (&cr
, r
, &result
);
30292 /* If we don't understand the format, pretend we're not in the hot-spot. */
30298 Draw a vertical window border to the right of window W if W doesn't
30299 have vertical scroll bars. */
30302 x_draw_vertical_border (struct window
*w
)
30304 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30306 /* We could do better, if we knew what type of scroll-bar the adjacent
30307 windows (on either side) have... But we don't :-(
30308 However, I think this works ok. ++KFS 2003-04-25 */
30310 /* Redraw borders between horizontally adjacent windows. Don't
30311 do it for frames with vertical scroll bars because either the
30312 right scroll bar of a window, or the left scroll bar of its
30313 neighbor will suffice as a border. */
30314 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30317 /* Note: It is necessary to redraw both the left and the right
30318 borders, for when only this single window W is being
30320 if (!WINDOW_RIGHTMOST_P (w
)
30321 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30323 int x0
, x1
, y0
, y1
;
30325 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30328 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30331 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30334 if (!WINDOW_LEFTMOST_P (w
)
30335 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30337 int x0
, x1
, y0
, y1
;
30339 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30342 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30345 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30350 /* Draw window dividers for window W. */
30353 x_draw_right_divider (struct window
*w
)
30355 struct frame
*f
= WINDOW_XFRAME (w
);
30357 if (w
->mini
|| w
->pseudo_window_p
)
30359 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30361 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30362 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30363 int y0
= WINDOW_TOP_EDGE_Y (w
);
30364 /* The bottom divider prevails. */
30365 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30367 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30372 x_draw_bottom_divider (struct window
*w
)
30374 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30376 if (w
->mini
|| w
->pseudo_window_p
)
30378 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30380 int x0
= WINDOW_LEFT_EDGE_X (w
);
30381 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30382 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30383 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30385 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30389 /* Redraw the part of window W intersection rectangle FR. Pixel
30390 coordinates in FR are frame-relative. Call this function with
30391 input blocked. Value is true if the exposure overwrites
30395 expose_window (struct window
*w
, XRectangle
*fr
)
30397 struct frame
*f
= XFRAME (w
->frame
);
30399 bool mouse_face_overwritten_p
= false;
30401 /* If window is not yet fully initialized, do nothing. This can
30402 happen when toolkit scroll bars are used and a window is split.
30403 Reconfiguring the scroll bar will generate an expose for a newly
30405 if (w
->current_matrix
== NULL
)
30408 /* When we're currently updating the window, display and current
30409 matrix usually don't agree. Arrange for a thorough display
30411 if (w
->must_be_updated_p
)
30413 SET_FRAME_GARBAGED (f
);
30417 /* Frame-relative pixel rectangle of W. */
30418 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30419 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30420 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30421 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30423 if (x_intersect_rectangles (fr
, &wr
, &r
))
30425 int yb
= window_text_bottom_y (w
);
30426 struct glyph_row
*row
;
30427 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30429 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30430 r
.x
, r
.y
, r
.width
, r
.height
));
30432 /* Convert to window coordinates. */
30433 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30434 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30436 /* Turn off the cursor. */
30437 bool cursor_cleared_p
= (!w
->pseudo_window_p
30438 && phys_cursor_in_rect_p (w
, &r
));
30439 if (cursor_cleared_p
)
30440 x_clear_cursor (w
);
30442 /* If the row containing the cursor extends face to end of line,
30443 then expose_area might overwrite the cursor outside the
30444 rectangle and thus notice_overwritten_cursor might clear
30445 w->phys_cursor_on_p. We remember the original value and
30446 check later if it is changed. */
30447 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30449 /* Use a signed int intermediate value to avoid catastrophic
30450 failures due to comparison between signed and unsigned, when
30451 y0 or y1 is negative (can happen for tall images). */
30452 int r_bottom
= r
.y
+ r
.height
;
30454 /* Update lines intersecting rectangle R. */
30455 first_overlapping_row
= last_overlapping_row
= NULL
;
30456 for (row
= w
->current_matrix
->rows
;
30461 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30463 if ((y0
>= r
.y
&& y0
< r_bottom
)
30464 || (y1
> r
.y
&& y1
< r_bottom
)
30465 || (r
.y
>= y0
&& r
.y
< y1
)
30466 || (r_bottom
> y0
&& r_bottom
< y1
))
30468 /* A header line may be overlapping, but there is no need
30469 to fix overlapping areas for them. KFS 2005-02-12 */
30470 if (row
->overlapping_p
&& !row
->mode_line_p
)
30472 if (first_overlapping_row
== NULL
)
30473 first_overlapping_row
= row
;
30474 last_overlapping_row
= row
;
30478 if (expose_line (w
, row
, &r
))
30479 mouse_face_overwritten_p
= true;
30482 else if (row
->overlapping_p
)
30484 /* We must redraw a row overlapping the exposed area. */
30486 ? y0
+ row
->phys_height
> r
.y
30487 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30489 if (first_overlapping_row
== NULL
)
30490 first_overlapping_row
= row
;
30491 last_overlapping_row
= row
;
30499 /* Display the mode line if there is one. */
30500 if (WINDOW_WANTS_MODELINE_P (w
)
30501 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30503 && row
->y
< r_bottom
)
30505 if (expose_line (w
, row
, &r
))
30506 mouse_face_overwritten_p
= true;
30509 if (!w
->pseudo_window_p
)
30511 /* Fix the display of overlapping rows. */
30512 if (first_overlapping_row
)
30513 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30516 /* Draw border between windows. */
30517 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30518 x_draw_right_divider (w
);
30520 x_draw_vertical_border (w
);
30522 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30523 x_draw_bottom_divider (w
);
30525 /* Turn the cursor on again. */
30526 if (cursor_cleared_p
30527 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30528 update_window_cursor (w
, true);
30532 return mouse_face_overwritten_p
;
30537 /* Redraw (parts) of all windows in the window tree rooted at W that
30538 intersect R. R contains frame pixel coordinates. Value is
30539 true if the exposure overwrites mouse-face. */
30542 expose_window_tree (struct window
*w
, XRectangle
*r
)
30544 struct frame
*f
= XFRAME (w
->frame
);
30545 bool mouse_face_overwritten_p
= false;
30547 while (w
&& !FRAME_GARBAGED_P (f
))
30549 mouse_face_overwritten_p
30550 |= (WINDOWP (w
->contents
)
30551 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30552 : expose_window (w
, r
));
30554 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30557 return mouse_face_overwritten_p
;
30562 Redisplay an exposed area of frame F. X and Y are the upper-left
30563 corner of the exposed rectangle. W and H are width and height of
30564 the exposed area. All are pixel values. W or H zero means redraw
30565 the entire frame. */
30568 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30571 bool mouse_face_overwritten_p
= false;
30573 TRACE ((stderr
, "expose_frame "));
30575 /* No need to redraw if frame will be redrawn soon. */
30576 if (FRAME_GARBAGED_P (f
))
30578 TRACE ((stderr
, " garbaged\n"));
30582 /* If basic faces haven't been realized yet, there is no point in
30583 trying to redraw anything. This can happen when we get an expose
30584 event while Emacs is starting, e.g. by moving another window. */
30585 if (FRAME_FACE_CACHE (f
) == NULL
30586 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30588 TRACE ((stderr
, " no faces\n"));
30592 if (w
== 0 || h
== 0)
30595 r
.width
= FRAME_TEXT_WIDTH (f
);
30596 r
.height
= FRAME_TEXT_HEIGHT (f
);
30606 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30607 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30609 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30610 if (WINDOWP (f
->tool_bar_window
))
30611 mouse_face_overwritten_p
30612 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30615 #ifdef HAVE_X_WINDOWS
30617 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30618 if (WINDOWP (f
->menu_bar_window
))
30619 mouse_face_overwritten_p
30620 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30621 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30625 /* Some window managers support a focus-follows-mouse style with
30626 delayed raising of frames. Imagine a partially obscured frame,
30627 and moving the mouse into partially obscured mouse-face on that
30628 frame. The visible part of the mouse-face will be highlighted,
30629 then the WM raises the obscured frame. With at least one WM, KDE
30630 2.1, Emacs is not getting any event for the raising of the frame
30631 (even tried with SubstructureRedirectMask), only Expose events.
30632 These expose events will draw text normally, i.e. not
30633 highlighted. Which means we must redo the highlight here.
30634 Subsume it under ``we love X''. --gerd 2001-08-15 */
30635 /* Included in Windows version because Windows most likely does not
30636 do the right thing if any third party tool offers
30637 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30638 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30640 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30641 if (f
== hlinfo
->mouse_face_mouse_frame
)
30643 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30644 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30645 clear_mouse_face (hlinfo
);
30646 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30653 Determine the intersection of two rectangles R1 and R2. Return
30654 the intersection in *RESULT. Value is true if RESULT is not
30658 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30660 XRectangle
*left
, *right
;
30661 XRectangle
*upper
, *lower
;
30662 bool intersection_p
= false;
30664 /* Rearrange so that R1 is the left-most rectangle. */
30666 left
= r1
, right
= r2
;
30668 left
= r2
, right
= r1
;
30670 /* X0 of the intersection is right.x0, if this is inside R1,
30671 otherwise there is no intersection. */
30672 if (right
->x
<= left
->x
+ left
->width
)
30674 result
->x
= right
->x
;
30676 /* The right end of the intersection is the minimum of
30677 the right ends of left and right. */
30678 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30681 /* Same game for Y. */
30683 upper
= r1
, lower
= r2
;
30685 upper
= r2
, lower
= r1
;
30687 /* The upper end of the intersection is lower.y0, if this is inside
30688 of upper. Otherwise, there is no intersection. */
30689 if (lower
->y
<= upper
->y
+ upper
->height
)
30691 result
->y
= lower
->y
;
30693 /* The lower end of the intersection is the minimum of the lower
30694 ends of upper and lower. */
30695 result
->height
= (min (lower
->y
+ lower
->height
,
30696 upper
->y
+ upper
->height
)
30698 intersection_p
= true;
30702 return intersection_p
;
30705 #endif /* HAVE_WINDOW_SYSTEM */
30708 /***********************************************************************
30710 ***********************************************************************/
30713 syms_of_xdisp (void)
30715 Vwith_echo_area_save_vector
= Qnil
;
30716 staticpro (&Vwith_echo_area_save_vector
);
30718 Vmessage_stack
= Qnil
;
30719 staticpro (&Vmessage_stack
);
30721 /* Non-nil means don't actually do any redisplay. */
30722 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30724 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30726 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30727 doc
: /* Non-nil means calls to `message' are not displayed.
30728 They are still logged to the *Messages* buffer. */);
30729 inhibit_message
= 0;
30731 message_dolog_marker1
= Fmake_marker ();
30732 staticpro (&message_dolog_marker1
);
30733 message_dolog_marker2
= Fmake_marker ();
30734 staticpro (&message_dolog_marker2
);
30735 message_dolog_marker3
= Fmake_marker ();
30736 staticpro (&message_dolog_marker3
);
30739 defsubr (&Sdump_frame_glyph_matrix
);
30740 defsubr (&Sdump_glyph_matrix
);
30741 defsubr (&Sdump_glyph_row
);
30742 defsubr (&Sdump_tool_bar_row
);
30743 defsubr (&Strace_redisplay
);
30744 defsubr (&Strace_to_stderr
);
30746 #ifdef HAVE_WINDOW_SYSTEM
30747 defsubr (&Stool_bar_height
);
30748 defsubr (&Slookup_image_map
);
30750 defsubr (&Sline_pixel_height
);
30751 defsubr (&Sformat_mode_line
);
30752 defsubr (&Sinvisible_p
);
30753 defsubr (&Scurrent_bidi_paragraph_direction
);
30754 defsubr (&Swindow_text_pixel_size
);
30755 defsubr (&Smove_point_visually
);
30756 defsubr (&Sbidi_find_overridden_directionality
);
30758 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30759 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30760 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30761 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30762 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30763 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30764 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30765 DEFSYM (Qeval
, "eval");
30766 DEFSYM (QCdata
, ":data");
30768 /* Names of text properties relevant for redisplay. */
30769 DEFSYM (Qdisplay
, "display");
30770 DEFSYM (Qspace_width
, "space-width");
30771 DEFSYM (Qraise
, "raise");
30772 DEFSYM (Qslice
, "slice");
30773 DEFSYM (Qspace
, "space");
30774 DEFSYM (Qmargin
, "margin");
30775 DEFSYM (Qpointer
, "pointer");
30776 DEFSYM (Qleft_margin
, "left-margin");
30777 DEFSYM (Qright_margin
, "right-margin");
30778 DEFSYM (Qcenter
, "center");
30779 DEFSYM (Qline_height
, "line-height");
30780 DEFSYM (QCalign_to
, ":align-to");
30781 DEFSYM (QCrelative_width
, ":relative-width");
30782 DEFSYM (QCrelative_height
, ":relative-height");
30783 DEFSYM (QCeval
, ":eval");
30784 DEFSYM (QCpropertize
, ":propertize");
30785 DEFSYM (QCfile
, ":file");
30786 DEFSYM (Qfontified
, "fontified");
30787 DEFSYM (Qfontification_functions
, "fontification-functions");
30789 /* Name of the face used to highlight trailing whitespace. */
30790 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30792 /* Name and number of the face used to highlight escape glyphs. */
30793 DEFSYM (Qescape_glyph
, "escape-glyph");
30795 /* Name and number of the face used to highlight non-breaking spaces. */
30796 DEFSYM (Qnobreak_space
, "nobreak-space");
30798 /* The symbol 'image' which is the car of the lists used to represent
30799 images in Lisp. Also a tool bar style. */
30800 DEFSYM (Qimage
, "image");
30802 /* Tool bar styles. */
30803 DEFSYM (Qtext
, "text");
30804 DEFSYM (Qboth
, "both");
30805 DEFSYM (Qboth_horiz
, "both-horiz");
30806 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30808 /* The image map types. */
30809 DEFSYM (QCmap
, ":map");
30810 DEFSYM (QCpointer
, ":pointer");
30811 DEFSYM (Qrect
, "rect");
30812 DEFSYM (Qcircle
, "circle");
30813 DEFSYM (Qpoly
, "poly");
30815 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30817 DEFSYM (Qgrow_only
, "grow-only");
30818 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30819 DEFSYM (Qposition
, "position");
30820 DEFSYM (Qbuffer_position
, "buffer-position");
30821 DEFSYM (Qobject
, "object");
30823 /* Cursor shapes. */
30824 DEFSYM (Qbar
, "bar");
30825 DEFSYM (Qhbar
, "hbar");
30826 DEFSYM (Qbox
, "box");
30827 DEFSYM (Qhollow
, "hollow");
30829 /* Pointer shapes. */
30830 DEFSYM (Qhand
, "hand");
30831 DEFSYM (Qarrow
, "arrow");
30834 DEFSYM (Qdragging
, "dragging");
30836 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30838 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30839 staticpro (&list_of_error
);
30841 /* Values of those variables at last redisplay are stored as
30842 properties on 'overlay-arrow-position' symbol. However, if
30843 Voverlay_arrow_position is a marker, last-arrow-position is its
30844 numerical position. */
30845 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30846 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30848 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30849 properties on a symbol in overlay-arrow-variable-list. */
30850 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30851 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30853 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30854 staticpro (&echo_buffer
[0]);
30855 staticpro (&echo_buffer
[1]);
30857 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30858 staticpro (&echo_area_buffer
[0]);
30859 staticpro (&echo_area_buffer
[1]);
30861 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30862 staticpro (&Vmessages_buffer_name
);
30864 mode_line_proptrans_alist
= Qnil
;
30865 staticpro (&mode_line_proptrans_alist
);
30866 mode_line_string_list
= Qnil
;
30867 staticpro (&mode_line_string_list
);
30868 mode_line_string_face
= Qnil
;
30869 staticpro (&mode_line_string_face
);
30870 mode_line_string_face_prop
= Qnil
;
30871 staticpro (&mode_line_string_face_prop
);
30872 Vmode_line_unwind_vector
= Qnil
;
30873 staticpro (&Vmode_line_unwind_vector
);
30875 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30877 help_echo_string
= Qnil
;
30878 staticpro (&help_echo_string
);
30879 help_echo_object
= Qnil
;
30880 staticpro (&help_echo_object
);
30881 help_echo_window
= Qnil
;
30882 staticpro (&help_echo_window
);
30883 previous_help_echo_string
= Qnil
;
30884 staticpro (&previous_help_echo_string
);
30885 help_echo_pos
= -1;
30887 DEFSYM (Qright_to_left
, "right-to-left");
30888 DEFSYM (Qleft_to_right
, "left-to-right");
30889 defsubr (&Sbidi_resolved_levels
);
30891 #ifdef HAVE_WINDOW_SYSTEM
30892 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30893 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30894 For example, if a block cursor is over a tab, it will be drawn as
30895 wide as that tab on the display. */);
30896 x_stretch_cursor_p
= 0;
30899 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30900 doc
: /* Non-nil means highlight trailing whitespace.
30901 The face used for trailing whitespace is `trailing-whitespace'. */);
30902 Vshow_trailing_whitespace
= Qnil
;
30904 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30905 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30906 If the value is t, Emacs highlights non-ASCII chars which have the
30907 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30908 or `escape-glyph' face respectively.
30910 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30911 U+2011 (non-breaking hyphen) are affected.
30913 Any other non-nil value means to display these characters as a escape
30914 glyph followed by an ordinary space or hyphen.
30916 A value of nil means no special handling of these characters. */);
30917 Vnobreak_char_display
= Qt
;
30919 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30920 doc
: /* The pointer shape to show in void text areas.
30921 A value of nil means to show the text pointer. Other options are
30922 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30924 Vvoid_text_area_pointer
= Qarrow
;
30926 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30927 doc
: /* Non-nil means don't actually do any redisplay.
30928 This is used for internal purposes. */);
30929 Vinhibit_redisplay
= Qnil
;
30931 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30932 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30933 Vglobal_mode_string
= Qnil
;
30935 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30936 doc
: /* Marker for where to display an arrow on top of the buffer text.
30937 This must be the beginning of a line in order to work.
30938 See also `overlay-arrow-string'. */);
30939 Voverlay_arrow_position
= Qnil
;
30941 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30942 doc
: /* String to display as an arrow in non-window frames.
30943 See also `overlay-arrow-position'. */);
30944 Voverlay_arrow_string
= build_pure_c_string ("=>");
30946 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30947 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30948 The symbols on this list are examined during redisplay to determine
30949 where to display overlay arrows. */);
30950 Voverlay_arrow_variable_list
30951 = list1 (intern_c_string ("overlay-arrow-position"));
30953 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30954 doc
: /* The number of lines to try scrolling a window by when point moves out.
30955 If that fails to bring point back on frame, point is centered instead.
30956 If this is zero, point is always centered after it moves off frame.
30957 If you want scrolling to always be a line at a time, you should set
30958 `scroll-conservatively' to a large value rather than set this to 1. */);
30960 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30961 doc
: /* Scroll up to this many lines, to bring point back on screen.
30962 If point moves off-screen, redisplay will scroll by up to
30963 `scroll-conservatively' lines in order to bring point just barely
30964 onto the screen again. If that cannot be done, then redisplay
30965 recenters point as usual.
30967 If the value is greater than 100, redisplay will never recenter point,
30968 but will always scroll just enough text to bring point into view, even
30969 if you move far away.
30971 A value of zero means always recenter point if it moves off screen. */);
30972 scroll_conservatively
= 0;
30974 DEFVAR_INT ("scroll-margin", scroll_margin
,
30975 doc
: /* Number of lines of margin at the top and bottom of a window.
30976 Recenter the window whenever point gets within this many lines
30977 of the top or bottom of the window. */);
30980 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30981 doc
: /* Pixels per inch value for non-window system displays.
30982 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30983 Vdisplay_pixels_per_inch
= make_float (72.0);
30986 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30989 DEFVAR_LISP ("truncate-partial-width-windows",
30990 Vtruncate_partial_width_windows
,
30991 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30992 For an integer value, truncate lines in each window narrower than the
30993 full frame width, provided the window width is less than that integer;
30994 otherwise, respect the value of `truncate-lines'.
30996 For any other non-nil value, truncate lines in all windows that do
30997 not span the full frame width.
30999 A value of nil means to respect the value of `truncate-lines'.
31001 If `word-wrap' is enabled, you might want to reduce this. */);
31002 Vtruncate_partial_width_windows
= make_number (50);
31004 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31005 doc
: /* Maximum buffer size for which line number should be displayed.
31006 If the buffer is bigger than this, the line number does not appear
31007 in the mode line. A value of nil means no limit. */);
31008 Vline_number_display_limit
= Qnil
;
31010 DEFVAR_INT ("line-number-display-limit-width",
31011 line_number_display_limit_width
,
31012 doc
: /* Maximum line width (in characters) for line number display.
31013 If the average length of the lines near point is bigger than this, then the
31014 line number may be omitted from the mode line. */);
31015 line_number_display_limit_width
= 200;
31017 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31018 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31019 highlight_nonselected_windows
= false;
31021 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31022 doc
: /* Non-nil if more than one frame is visible on this display.
31023 Minibuffer-only frames don't count, but iconified frames do.
31024 This variable is not guaranteed to be accurate except while processing
31025 `frame-title-format' and `icon-title-format'. */);
31027 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31028 doc
: /* Template for displaying the title bar of visible frames.
31029 \(Assuming the window manager supports this feature.)
31031 This variable has the same structure as `mode-line-format', except that
31032 the %c and %l constructs are ignored. It is used only on frames for
31033 which no explicit name has been set \(see `modify-frame-parameters'). */);
31035 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31036 doc
: /* Template for displaying the title bar of an iconified frame.
31037 \(Assuming the window manager supports this feature.)
31038 This variable has the same structure as `mode-line-format' (which see),
31039 and is used only on frames for which no explicit name has been set
31040 \(see `modify-frame-parameters'). */);
31042 = Vframe_title_format
31043 = listn (CONSTYPE_PURE
, 3,
31044 intern_c_string ("multiple-frames"),
31045 build_pure_c_string ("%b"),
31046 listn (CONSTYPE_PURE
, 4,
31047 empty_unibyte_string
,
31048 intern_c_string ("invocation-name"),
31049 build_pure_c_string ("@"),
31050 intern_c_string ("system-name")));
31052 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31053 doc
: /* Maximum number of lines to keep in the message log buffer.
31054 If nil, disable message logging. If t, log messages but don't truncate
31055 the buffer when it becomes large. */);
31056 Vmessage_log_max
= make_number (1000);
31058 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31059 doc
: /* Functions called before redisplay, if window sizes have changed.
31060 The value should be a list of functions that take one argument.
31061 Just before redisplay, for each frame, if any of its windows have changed
31062 size since the last redisplay, or have been split or deleted,
31063 all the functions in the list are called, with the frame as argument. */);
31064 Vwindow_size_change_functions
= Qnil
;
31066 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31067 doc
: /* List of functions to call before redisplaying a window with scrolling.
31068 Each function is called with two arguments, the window and its new
31069 display-start position.
31070 These functions are called whenever the `window-start' marker is modified,
31071 either to point into another buffer (e.g. via `set-window-buffer') or another
31072 place in the same buffer.
31073 Note that the value of `window-end' is not valid when these functions are
31076 Warning: Do not use this feature to alter the way the window
31077 is scrolled. It is not designed for that, and such use probably won't
31079 Vwindow_scroll_functions
= Qnil
;
31081 DEFVAR_LISP ("window-text-change-functions",
31082 Vwindow_text_change_functions
,
31083 doc
: /* Functions to call in redisplay when text in the window might change. */);
31084 Vwindow_text_change_functions
= Qnil
;
31086 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31087 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31088 Each function is called with two arguments, the window and the end trigger value.
31089 See `set-window-redisplay-end-trigger'. */);
31090 Vredisplay_end_trigger_functions
= Qnil
;
31092 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31093 doc
: /* Non-nil means autoselect window with mouse pointer.
31094 If nil, do not autoselect windows.
31095 A positive number means delay autoselection by that many seconds: a
31096 window is autoselected only after the mouse has remained in that
31097 window for the duration of the delay.
31098 A negative number has a similar effect, but causes windows to be
31099 autoselected only after the mouse has stopped moving. \(Because of
31100 the way Emacs compares mouse events, you will occasionally wait twice
31101 that time before the window gets selected.\)
31102 Any other value means to autoselect window instantaneously when the
31103 mouse pointer enters it.
31105 Autoselection selects the minibuffer only if it is active, and never
31106 unselects the minibuffer if it is active.
31108 When customizing this variable make sure that the actual value of
31109 `focus-follows-mouse' matches the behavior of your window manager. */);
31110 Vmouse_autoselect_window
= Qnil
;
31112 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31113 doc
: /* Non-nil means automatically resize tool-bars.
31114 This dynamically changes the tool-bar's height to the minimum height
31115 that is needed to make all tool-bar items visible.
31116 If value is `grow-only', the tool-bar's height is only increased
31117 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31118 Vauto_resize_tool_bars
= Qt
;
31120 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31121 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31122 auto_raise_tool_bar_buttons_p
= true;
31124 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31125 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31126 make_cursor_line_fully_visible_p
= true;
31128 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31129 doc
: /* Border below tool-bar in pixels.
31130 If an integer, use it as the height of the border.
31131 If it is one of `internal-border-width' or `border-width', use the
31132 value of the corresponding frame parameter.
31133 Otherwise, no border is added below the tool-bar. */);
31134 Vtool_bar_border
= Qinternal_border_width
;
31136 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31137 doc
: /* Margin around tool-bar buttons in pixels.
31138 If an integer, use that for both horizontal and vertical margins.
31139 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31140 HORZ specifying the horizontal margin, and VERT specifying the
31141 vertical margin. */);
31142 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31144 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31145 doc
: /* Relief thickness of tool-bar buttons. */);
31146 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31148 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31149 doc
: /* Tool bar style to use.
31151 image - show images only
31152 text - show text only
31153 both - show both, text below image
31154 both-horiz - show text to the right of the image
31155 text-image-horiz - show text to the left of the image
31156 any other - use system default or image if no system default.
31158 This variable only affects the GTK+ toolkit version of Emacs. */);
31159 Vtool_bar_style
= Qnil
;
31161 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31162 doc
: /* Maximum number of characters a label can have to be shown.
31163 The tool bar style must also show labels for this to have any effect, see
31164 `tool-bar-style'. */);
31165 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31167 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31168 doc
: /* List of functions to call to fontify regions of text.
31169 Each function is called with one argument POS. Functions must
31170 fontify a region starting at POS in the current buffer, and give
31171 fontified regions the property `fontified'. */);
31172 Vfontification_functions
= Qnil
;
31173 Fmake_variable_buffer_local (Qfontification_functions
);
31175 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31176 unibyte_display_via_language_environment
,
31177 doc
: /* Non-nil means display unibyte text according to language environment.
31178 Specifically, this means that raw bytes in the range 160-255 decimal
31179 are displayed by converting them to the equivalent multibyte characters
31180 according to the current language environment. As a result, they are
31181 displayed according to the current fontset.
31183 Note that this variable affects only how these bytes are displayed,
31184 but does not change the fact they are interpreted as raw bytes. */);
31185 unibyte_display_via_language_environment
= false;
31187 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31188 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31189 If a float, it specifies a fraction of the mini-window frame's height.
31190 If an integer, it specifies a number of lines. */);
31191 Vmax_mini_window_height
= make_float (0.25);
31193 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31194 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31195 A value of nil means don't automatically resize mini-windows.
31196 A value of t means resize them to fit the text displayed in them.
31197 A value of `grow-only', the default, means let mini-windows grow only;
31198 they return to their normal size when the minibuffer is closed, or the
31199 echo area becomes empty. */);
31200 Vresize_mini_windows
= Qgrow_only
;
31202 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31203 doc
: /* Alist specifying how to blink the cursor off.
31204 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31205 `cursor-type' frame-parameter or variable equals ON-STATE,
31206 comparing using `equal', Emacs uses OFF-STATE to specify
31207 how to blink it off. ON-STATE and OFF-STATE are values for
31208 the `cursor-type' frame parameter.
31210 If a frame's ON-STATE has no entry in this list,
31211 the frame's other specifications determine how to blink the cursor off. */);
31212 Vblink_cursor_alist
= Qnil
;
31214 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31215 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31216 If non-nil, windows are automatically scrolled horizontally to make
31217 point visible. */);
31218 automatic_hscrolling_p
= true;
31219 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31221 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31222 doc
: /* How many columns away from the window edge point is allowed to get
31223 before automatic hscrolling will horizontally scroll the window. */);
31224 hscroll_margin
= 5;
31226 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31227 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31228 When point is less than `hscroll-margin' columns from the window
31229 edge, automatic hscrolling will scroll the window by the amount of columns
31230 determined by this variable. If its value is a positive integer, scroll that
31231 many columns. If it's a positive floating-point number, it specifies the
31232 fraction of the window's width to scroll. If it's nil or zero, point will be
31233 centered horizontally after the scroll. Any other value, including negative
31234 numbers, are treated as if the value were zero.
31236 Automatic hscrolling always moves point outside the scroll margin, so if
31237 point was more than scroll step columns inside the margin, the window will
31238 scroll more than the value given by the scroll step.
31240 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31241 and `scroll-right' overrides this variable's effect. */);
31242 Vhscroll_step
= make_number (0);
31244 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31245 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31246 Bind this around calls to `message' to let it take effect. */);
31247 message_truncate_lines
= false;
31249 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31250 doc
: /* Normal hook run to update the menu bar definitions.
31251 Redisplay runs this hook before it redisplays the menu bar.
31252 This is used to update menus such as Buffers, whose contents depend on
31254 Vmenu_bar_update_hook
= Qnil
;
31256 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31257 doc
: /* Frame for which we are updating a menu.
31258 The enable predicate for a menu binding should check this variable. */);
31259 Vmenu_updating_frame
= Qnil
;
31261 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31262 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31263 inhibit_menubar_update
= false;
31265 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31266 doc
: /* Prefix prepended to all continuation lines at display time.
31267 The value may be a string, an image, or a stretch-glyph; it is
31268 interpreted in the same way as the value of a `display' text property.
31270 This variable is overridden by any `wrap-prefix' text or overlay
31273 To add a prefix to non-continuation lines, use `line-prefix'. */);
31274 Vwrap_prefix
= Qnil
;
31275 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31276 Fmake_variable_buffer_local (Qwrap_prefix
);
31278 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31279 doc
: /* Prefix prepended to all non-continuation lines at display time.
31280 The value may be a string, an image, or a stretch-glyph; it is
31281 interpreted in the same way as the value of a `display' text property.
31283 This variable is overridden by any `line-prefix' text or overlay
31286 To add a prefix to continuation lines, use `wrap-prefix'. */);
31287 Vline_prefix
= Qnil
;
31288 DEFSYM (Qline_prefix
, "line-prefix");
31289 Fmake_variable_buffer_local (Qline_prefix
);
31291 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31292 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31293 inhibit_eval_during_redisplay
= false;
31295 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31296 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31297 inhibit_free_realized_faces
= false;
31299 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31300 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31301 Intended for use during debugging and for testing bidi display;
31302 see biditest.el in the test suite. */);
31303 inhibit_bidi_mirroring
= false;
31306 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31307 doc
: /* Inhibit try_window_id display optimization. */);
31308 inhibit_try_window_id
= false;
31310 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31311 doc
: /* Inhibit try_window_reusing display optimization. */);
31312 inhibit_try_window_reusing
= false;
31314 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31315 doc
: /* Inhibit try_cursor_movement display optimization. */);
31316 inhibit_try_cursor_movement
= false;
31317 #endif /* GLYPH_DEBUG */
31319 DEFVAR_INT ("overline-margin", overline_margin
,
31320 doc
: /* Space between overline and text, in pixels.
31321 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31322 margin to the character height. */);
31323 overline_margin
= 2;
31325 DEFVAR_INT ("underline-minimum-offset",
31326 underline_minimum_offset
,
31327 doc
: /* Minimum distance between baseline and underline.
31328 This can improve legibility of underlined text at small font sizes,
31329 particularly when using variable `x-use-underline-position-properties'
31330 with fonts that specify an UNDERLINE_POSITION relatively close to the
31331 baseline. The default value is 1. */);
31332 underline_minimum_offset
= 1;
31334 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31335 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31336 This feature only works when on a window system that can change
31337 cursor shapes. */);
31338 display_hourglass_p
= true;
31340 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31341 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31342 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31344 #ifdef HAVE_WINDOW_SYSTEM
31345 hourglass_atimer
= NULL
;
31346 hourglass_shown_p
= false;
31347 #endif /* HAVE_WINDOW_SYSTEM */
31349 /* Name of the face used to display glyphless characters. */
31350 DEFSYM (Qglyphless_char
, "glyphless-char");
31352 /* Method symbols for Vglyphless_char_display. */
31353 DEFSYM (Qhex_code
, "hex-code");
31354 DEFSYM (Qempty_box
, "empty-box");
31355 DEFSYM (Qthin_space
, "thin-space");
31356 DEFSYM (Qzero_width
, "zero-width");
31358 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31359 doc
: /* Function run just before redisplay.
31360 It is called with one argument, which is the set of windows that are to
31361 be redisplayed. This set can be nil (meaning, only the selected window),
31362 or t (meaning all windows). */);
31363 Vpre_redisplay_function
= intern ("ignore");
31365 /* Symbol for the purpose of Vglyphless_char_display. */
31366 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31367 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31369 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31370 doc
: /* Char-table defining glyphless characters.
31371 Each element, if non-nil, should be one of the following:
31372 an ASCII acronym string: display this string in a box
31373 `hex-code': display the hexadecimal code of a character in a box
31374 `empty-box': display as an empty box
31375 `thin-space': display as 1-pixel width space
31376 `zero-width': don't display
31377 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31378 display method for graphical terminals and text terminals respectively.
31379 GRAPHICAL and TEXT should each have one of the values listed above.
31381 The char-table has one extra slot to control the display of a character for
31382 which no font is found. This slot only takes effect on graphical terminals.
31383 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31384 `thin-space'. The default is `empty-box'.
31386 If a character has a non-nil entry in an active display table, the
31387 display table takes effect; in this case, Emacs does not consult
31388 `glyphless-char-display' at all. */);
31389 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31390 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31393 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31394 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31395 Vdebug_on_message
= Qnil
;
31397 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31399 Vredisplay__all_windows_cause
31400 = Fmake_vector (make_number (100), make_number (0));
31402 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31404 Vredisplay__mode_lines_cause
31405 = Fmake_vector (make_number (100), make_number (0));
31409 /* Initialize this module when Emacs starts. */
31414 CHARPOS (this_line_start_pos
) = 0;
31416 if (!noninteractive
)
31418 struct window
*m
= XWINDOW (minibuf_window
);
31419 Lisp_Object frame
= m
->frame
;
31420 struct frame
*f
= XFRAME (frame
);
31421 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31422 struct window
*r
= XWINDOW (root
);
31425 echo_area_window
= minibuf_window
;
31427 r
->top_line
= FRAME_TOP_MARGIN (f
);
31428 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31429 r
->total_cols
= FRAME_COLS (f
);
31430 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31431 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31432 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31434 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31435 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31436 m
->total_cols
= FRAME_COLS (f
);
31437 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31438 m
->total_lines
= 1;
31439 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31441 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31442 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31443 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31445 /* The default ellipsis glyphs `...'. */
31446 for (i
= 0; i
< 3; ++i
)
31447 default_invis_vector
[i
] = make_number ('.');
31451 /* Allocate the buffer for frame titles.
31452 Also used for `format-mode-line'. */
31454 mode_line_noprop_buf
= xmalloc (size
);
31455 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31456 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31457 mode_line_target
= MODE_LINE_DISPLAY
;
31460 help_echo_showing_p
= false;
31463 #ifdef HAVE_WINDOW_SYSTEM
31465 /* Platform-independent portion of hourglass implementation. */
31467 /* Timer function of hourglass_atimer. */
31470 show_hourglass (struct atimer
*timer
)
31472 /* The timer implementation will cancel this timer automatically
31473 after this function has run. Set hourglass_atimer to null
31474 so that we know the timer doesn't have to be canceled. */
31475 hourglass_atimer
= NULL
;
31477 if (!hourglass_shown_p
)
31479 Lisp_Object tail
, frame
;
31483 FOR_EACH_FRAME (tail
, frame
)
31485 struct frame
*f
= XFRAME (frame
);
31487 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31488 && FRAME_RIF (f
)->show_hourglass
)
31489 FRAME_RIF (f
)->show_hourglass (f
);
31492 hourglass_shown_p
= true;
31497 /* Cancel a currently active hourglass timer, and start a new one. */
31500 start_hourglass (void)
31502 struct timespec delay
;
31504 cancel_hourglass ();
31506 if (INTEGERP (Vhourglass_delay
)
31507 && XINT (Vhourglass_delay
) > 0)
31508 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31509 TYPE_MAXIMUM (time_t)),
31511 else if (FLOATP (Vhourglass_delay
)
31512 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31513 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31515 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31517 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31518 show_hourglass
, NULL
);
31521 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31525 cancel_hourglass (void)
31527 if (hourglass_atimer
)
31529 cancel_atimer (hourglass_atimer
);
31530 hourglass_atimer
= NULL
;
31533 if (hourglass_shown_p
)
31535 Lisp_Object tail
, frame
;
31539 FOR_EACH_FRAME (tail
, frame
)
31541 struct frame
*f
= XFRAME (frame
);
31543 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31544 && FRAME_RIF (f
)->hide_hourglass
)
31545 FRAME_RIF (f
)->hide_hourglass (f
);
31547 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31548 else if (!FRAME_W32_P (f
))
31549 w32_arrow_cursor ();
31553 hourglass_shown_p
= false;
31558 #endif /* HAVE_WINDOW_SYSTEM */