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 void 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 (!inhibit_free_realized_faces
)
2668 face_change
= false;
2669 free_all_realized_faces (Qnil
);
2671 else if (XFRAME (w
->frame
)->face_change
)
2673 XFRAME (w
->frame
)->face_change
= 0;
2674 free_all_realized_faces (w
->frame
);
2678 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2679 if (! NILP (Vface_remapping_alist
))
2680 remapped_base_face_id
2681 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2683 /* Use one of the mode line rows of W's desired matrix if
2687 if (base_face_id
== MODE_LINE_FACE_ID
2688 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2689 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2690 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2691 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2694 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2695 Other parts of redisplay rely on that. */
2696 memclear (it
, sizeof *it
);
2697 it
->current
.overlay_string_index
= -1;
2698 it
->current
.dpvec_index
= -1;
2699 it
->base_face_id
= remapped_base_face_id
;
2700 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2701 it
->paragraph_embedding
= L2R
;
2704 /* The window in which we iterate over current_buffer: */
2705 XSETWINDOW (it
->window
, w
);
2707 it
->f
= XFRAME (w
->frame
);
2711 /* Extra space between lines (on window systems only). */
2712 if (base_face_id
== DEFAULT_FACE_ID
2713 && FRAME_WINDOW_P (it
->f
))
2715 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2716 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2717 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2718 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2719 * FRAME_LINE_HEIGHT (it
->f
));
2720 else if (it
->f
->extra_line_spacing
> 0)
2721 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2724 /* If realized faces have been removed, e.g. because of face
2725 attribute changes of named faces, recompute them. When running
2726 in batch mode, the face cache of the initial frame is null. If
2727 we happen to get called, make a dummy face cache. */
2728 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2729 init_frame_faces (it
->f
);
2730 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2731 recompute_basic_faces (it
->f
);
2733 it
->override_ascent
= -1;
2735 /* Are control characters displayed as `^C'? */
2736 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2738 /* -1 means everything between a CR and the following line end
2739 is invisible. >0 means lines indented more than this value are
2741 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2743 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2745 : (!NILP (BVAR (current_buffer
, selective_display
))
2747 it
->selective_display_ellipsis_p
2748 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2750 /* Display table to use. */
2751 it
->dp
= window_display_table (w
);
2753 /* Are multibyte characters enabled in current_buffer? */
2754 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2756 /* Get the position at which the redisplay_end_trigger hook should
2757 be run, if it is to be run at all. */
2758 if (MARKERP (w
->redisplay_end_trigger
)
2759 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2760 it
->redisplay_end_trigger_charpos
2761 = marker_position (w
->redisplay_end_trigger
);
2762 else if (INTEGERP (w
->redisplay_end_trigger
))
2763 it
->redisplay_end_trigger_charpos
2764 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2767 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2769 /* Are lines in the display truncated? */
2771 it
->line_wrap
= TRUNCATE
;
2772 if (base_face_id
== DEFAULT_FACE_ID
2774 && (WINDOW_FULL_WIDTH_P (it
->w
)
2775 || NILP (Vtruncate_partial_width_windows
)
2776 || (INTEGERP (Vtruncate_partial_width_windows
)
2777 /* PXW: Shall we do something about this? */
2778 && (XINT (Vtruncate_partial_width_windows
)
2779 <= WINDOW_TOTAL_COLS (it
->w
))))
2780 && NILP (BVAR (current_buffer
, truncate_lines
)))
2781 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2782 ? WINDOW_WRAP
: WORD_WRAP
;
2784 /* Get dimensions of truncation and continuation glyphs. These are
2785 displayed as fringe bitmaps under X, but we need them for such
2786 frames when the fringes are turned off. But leave the dimensions
2787 zero for tooltip frames, as these glyphs look ugly there and also
2788 sabotage calculations of tooltip dimensions in x-show-tip. */
2789 #ifdef HAVE_WINDOW_SYSTEM
2790 if (!(FRAME_WINDOW_P (it
->f
)
2791 && FRAMEP (tip_frame
)
2792 && it
->f
== XFRAME (tip_frame
)))
2795 if (it
->line_wrap
== TRUNCATE
)
2797 /* We will need the truncation glyph. */
2798 eassert (it
->glyph_row
== NULL
);
2799 produce_special_glyphs (it
, IT_TRUNCATION
);
2800 it
->truncation_pixel_width
= it
->pixel_width
;
2804 /* We will need the continuation glyph. */
2805 eassert (it
->glyph_row
== NULL
);
2806 produce_special_glyphs (it
, IT_CONTINUATION
);
2807 it
->continuation_pixel_width
= it
->pixel_width
;
2811 /* Reset these values to zero because the produce_special_glyphs
2812 above has changed them. */
2813 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2814 it
->phys_ascent
= it
->phys_descent
= 0;
2816 /* Set this after getting the dimensions of truncation and
2817 continuation glyphs, so that we don't produce glyphs when calling
2818 produce_special_glyphs, above. */
2819 it
->glyph_row
= row
;
2820 it
->area
= TEXT_AREA
;
2822 /* Get the dimensions of the display area. The display area
2823 consists of the visible window area plus a horizontally scrolled
2824 part to the left of the window. All x-values are relative to the
2825 start of this total display area. */
2826 if (base_face_id
!= DEFAULT_FACE_ID
)
2828 /* Mode lines, menu bar in terminal frames. */
2829 it
->first_visible_x
= 0;
2830 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2835 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2836 it
->last_visible_x
= (it
->first_visible_x
2837 + window_box_width (w
, TEXT_AREA
));
2839 /* If we truncate lines, leave room for the truncation glyph(s) at
2840 the right margin. Otherwise, leave room for the continuation
2841 glyph(s). Done only if the window has no right fringe. */
2842 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2844 if (it
->line_wrap
== TRUNCATE
)
2845 it
->last_visible_x
-= it
->truncation_pixel_width
;
2847 it
->last_visible_x
-= it
->continuation_pixel_width
;
2850 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2851 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2854 /* Leave room for a border glyph. */
2855 if (!FRAME_WINDOW_P (it
->f
)
2856 && !WINDOW_RIGHTMOST_P (it
->w
))
2857 it
->last_visible_x
-= 1;
2859 it
->last_visible_y
= window_text_bottom_y (w
);
2861 /* For mode lines and alike, arrange for the first glyph having a
2862 left box line if the face specifies a box. */
2863 if (base_face_id
!= DEFAULT_FACE_ID
)
2867 it
->face_id
= remapped_base_face_id
;
2869 /* If we have a boxed mode line, make the first character appear
2870 with a left box line. */
2871 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2872 if (face
&& face
->box
!= FACE_NO_BOX
)
2873 it
->start_of_box_run_p
= true;
2876 /* If a buffer position was specified, set the iterator there,
2877 getting overlays and face properties from that position. */
2878 if (charpos
>= BUF_BEG (current_buffer
))
2880 it
->stop_charpos
= charpos
;
2881 it
->end_charpos
= ZV
;
2882 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2883 IT_CHARPOS (*it
) = charpos
;
2884 IT_BYTEPOS (*it
) = bytepos
;
2886 /* We will rely on `reseat' to set this up properly, via
2887 handle_face_prop. */
2888 it
->face_id
= it
->base_face_id
;
2890 it
->start
= it
->current
;
2891 /* Do we need to reorder bidirectional text? Not if this is a
2892 unibyte buffer: by definition, none of the single-byte
2893 characters are strong R2L, so no reordering is needed. And
2894 bidi.c doesn't support unibyte buffers anyway. Also, don't
2895 reorder while we are loading loadup.el, since the tables of
2896 character properties needed for reordering are not yet
2900 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2903 /* If we are to reorder bidirectional text, init the bidi
2907 /* Since we don't know at this point whether there will be
2908 any R2L lines in the window, we reserve space for
2909 truncation/continuation glyphs even if only the left
2910 fringe is absent. */
2911 if (base_face_id
== DEFAULT_FACE_ID
2912 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2913 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2915 if (it
->line_wrap
== TRUNCATE
)
2916 it
->last_visible_x
-= it
->truncation_pixel_width
;
2918 it
->last_visible_x
-= it
->continuation_pixel_width
;
2920 /* Note the paragraph direction that this buffer wants to
2922 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2924 it
->paragraph_embedding
= L2R
;
2925 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2927 it
->paragraph_embedding
= R2L
;
2929 it
->paragraph_embedding
= NEUTRAL_DIR
;
2930 bidi_unshelve_cache (NULL
, false);
2931 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2935 /* Compute faces etc. */
2936 reseat (it
, it
->current
.pos
, true);
2943 /* Initialize IT for the display of window W with window start POS. */
2946 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2948 struct glyph_row
*row
;
2949 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2951 row
= w
->desired_matrix
->rows
+ first_vpos
;
2952 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2953 it
->first_vpos
= first_vpos
;
2955 /* Don't reseat to previous visible line start if current start
2956 position is in a string or image. */
2957 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2959 int first_y
= it
->current_y
;
2961 /* If window start is not at a line start, skip forward to POS to
2962 get the correct continuation lines width. */
2963 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2964 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2965 if (!start_at_line_beg_p
)
2969 reseat_at_previous_visible_line_start (it
);
2970 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2972 new_x
= it
->current_x
+ it
->pixel_width
;
2974 /* If lines are continued, this line may end in the middle
2975 of a multi-glyph character (e.g. a control character
2976 displayed as \003, or in the middle of an overlay
2977 string). In this case move_it_to above will not have
2978 taken us to the start of the continuation line but to the
2979 end of the continued line. */
2980 if (it
->current_x
> 0
2981 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2982 && (/* And glyph doesn't fit on the line. */
2983 new_x
> it
->last_visible_x
2984 /* Or it fits exactly and we're on a window
2986 || (new_x
== it
->last_visible_x
2987 && FRAME_WINDOW_P (it
->f
)
2988 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2989 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2990 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2992 if ((it
->current
.dpvec_index
>= 0
2993 || it
->current
.overlay_string_index
>= 0)
2994 /* If we are on a newline from a display vector or
2995 overlay string, then we are already at the end of
2996 a screen line; no need to go to the next line in
2997 that case, as this line is not really continued.
2998 (If we do go to the next line, C-e will not DTRT.) */
3001 set_iterator_to_next (it
, true);
3002 move_it_in_display_line_to (it
, -1, -1, 0);
3005 it
->continuation_lines_width
+= it
->current_x
;
3007 /* If the character at POS is displayed via a display
3008 vector, move_it_to above stops at the final glyph of
3009 IT->dpvec. To make the caller redisplay that character
3010 again (a.k.a. start at POS), we need to reset the
3011 dpvec_index to the beginning of IT->dpvec. */
3012 else if (it
->current
.dpvec_index
>= 0)
3013 it
->current
.dpvec_index
= 0;
3015 /* We're starting a new display line, not affected by the
3016 height of the continued line, so clear the appropriate
3017 fields in the iterator structure. */
3018 it
->max_ascent
= it
->max_descent
= 0;
3019 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3021 it
->current_y
= first_y
;
3023 it
->current_x
= it
->hpos
= 0;
3029 /* Return true if POS is a position in ellipses displayed for invisible
3030 text. W is the window we display, for text property lookup. */
3033 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3035 Lisp_Object prop
, window
;
3036 bool ellipses_p
= false;
3037 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3039 /* If POS specifies a position in a display vector, this might
3040 be for an ellipsis displayed for invisible text. We won't
3041 get the iterator set up for delivering that ellipsis unless
3042 we make sure that it gets aware of the invisible text. */
3043 if (pos
->dpvec_index
>= 0
3044 && pos
->overlay_string_index
< 0
3045 && CHARPOS (pos
->string_pos
) < 0
3047 && (XSETWINDOW (window
, w
),
3048 prop
= Fget_char_property (make_number (charpos
),
3049 Qinvisible
, window
),
3050 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3052 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3054 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3061 /* Initialize IT for stepping through current_buffer in window W,
3062 starting at position POS that includes overlay string and display
3063 vector/ control character translation position information. Value
3064 is false if there are overlay strings with newlines at POS. */
3067 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3069 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3071 bool overlay_strings_with_newlines
= false;
3073 /* If POS specifies a position in a display vector, this might
3074 be for an ellipsis displayed for invisible text. We won't
3075 get the iterator set up for delivering that ellipsis unless
3076 we make sure that it gets aware of the invisible text. */
3077 if (in_ellipses_for_invisible_text_p (pos
, w
))
3083 /* Keep in mind: the call to reseat in init_iterator skips invisible
3084 text, so we might end up at a position different from POS. This
3085 is only a problem when POS is a row start after a newline and an
3086 overlay starts there with an after-string, and the overlay has an
3087 invisible property. Since we don't skip invisible text in
3088 display_line and elsewhere immediately after consuming the
3089 newline before the row start, such a POS will not be in a string,
3090 but the call to init_iterator below will move us to the
3092 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3094 /* This only scans the current chunk -- it should scan all chunks.
3095 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3096 to 16 in 22.1 to make this a lesser problem. */
3097 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3099 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3100 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3102 while (s
< e
&& *s
!= '\n')
3107 overlay_strings_with_newlines
= true;
3112 /* If position is within an overlay string, set up IT to the right
3114 if (pos
->overlay_string_index
>= 0)
3118 /* If the first overlay string happens to have a `display'
3119 property for an image, the iterator will be set up for that
3120 image, and we have to undo that setup first before we can
3121 correct the overlay string index. */
3122 if (it
->method
== GET_FROM_IMAGE
)
3125 /* We already have the first chunk of overlay strings in
3126 IT->overlay_strings. Load more until the one for
3127 pos->overlay_string_index is in IT->overlay_strings. */
3128 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3130 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3131 it
->current
.overlay_string_index
= 0;
3134 load_overlay_strings (it
, 0);
3135 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3139 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3140 relative_index
= (it
->current
.overlay_string_index
3141 % OVERLAY_STRING_CHUNK_SIZE
);
3142 it
->string
= it
->overlay_strings
[relative_index
];
3143 eassert (STRINGP (it
->string
));
3144 it
->current
.string_pos
= pos
->string_pos
;
3145 it
->method
= GET_FROM_STRING
;
3146 it
->end_charpos
= SCHARS (it
->string
);
3147 /* Set up the bidi iterator for this overlay string. */
3150 it
->bidi_it
.string
.lstring
= it
->string
;
3151 it
->bidi_it
.string
.s
= NULL
;
3152 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3153 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3154 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3155 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3156 it
->bidi_it
.w
= it
->w
;
3157 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3158 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3160 /* Synchronize the state of the bidi iterator with
3161 pos->string_pos. For any string position other than
3162 zero, this will be done automagically when we resume
3163 iteration over the string and get_visually_first_element
3164 is called. But if string_pos is zero, and the string is
3165 to be reordered for display, we need to resync manually,
3166 since it could be that the iteration state recorded in
3167 pos ended at string_pos of 0 moving backwards in string. */
3168 if (CHARPOS (pos
->string_pos
) == 0)
3170 get_visually_first_element (it
);
3171 if (IT_STRING_CHARPOS (*it
) != 0)
3174 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3175 bidi_move_to_visually_next (&it
->bidi_it
);
3176 } while (it
->bidi_it
.charpos
!= 0);
3178 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3179 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3183 if (CHARPOS (pos
->string_pos
) >= 0)
3185 /* Recorded position is not in an overlay string, but in another
3186 string. This can only be a string from a `display' property.
3187 IT should already be filled with that string. */
3188 it
->current
.string_pos
= pos
->string_pos
;
3189 eassert (STRINGP (it
->string
));
3191 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3192 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3195 /* Restore position in display vector translations, control
3196 character translations or ellipses. */
3197 if (pos
->dpvec_index
>= 0)
3199 if (it
->dpvec
== NULL
)
3200 get_next_display_element (it
);
3201 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3202 it
->current
.dpvec_index
= pos
->dpvec_index
;
3206 return !overlay_strings_with_newlines
;
3210 /* Initialize IT for stepping through current_buffer in window W
3211 starting at ROW->start. */
3214 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3216 init_from_display_pos (it
, w
, &row
->start
);
3217 it
->start
= row
->start
;
3218 it
->continuation_lines_width
= row
->continuation_lines_width
;
3223 /* Initialize IT for stepping through current_buffer in window W
3224 starting in the line following ROW, i.e. starting at ROW->end.
3225 Value is false if there are overlay strings with newlines at ROW's
3229 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3231 bool success
= false;
3233 if (init_from_display_pos (it
, w
, &row
->end
))
3235 if (row
->continued_p
)
3236 it
->continuation_lines_width
3237 = row
->continuation_lines_width
+ row
->pixel_width
;
3248 /***********************************************************************
3250 ***********************************************************************/
3252 /* Called when IT reaches IT->stop_charpos. Handle text property and
3253 overlay changes. Set IT->stop_charpos to the next position where
3257 handle_stop (struct it
*it
)
3259 enum prop_handled handled
;
3260 bool handle_overlay_change_p
;
3264 it
->current
.dpvec_index
= -1;
3265 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3266 it
->ellipsis_p
= false;
3268 /* Use face of preceding text for ellipsis (if invisible) */
3269 if (it
->selective_display_ellipsis_p
)
3270 it
->saved_face_id
= it
->face_id
;
3272 /* Here's the description of the semantics of, and the logic behind,
3273 the various HANDLED_* statuses:
3275 HANDLED_NORMALLY means the handler did its job, and the loop
3276 should proceed to calling the next handler in order.
3278 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3279 change in the properties and overlays at current position, so the
3280 loop should be restarted, to re-invoke the handlers that were
3281 already called. This happens when fontification-functions were
3282 called by handle_fontified_prop, and actually fontified
3283 something. Another case where HANDLED_RECOMPUTE_PROPS is
3284 returned is when we discover overlay strings that need to be
3285 displayed right away. The loop below will continue for as long
3286 as the status is HANDLED_RECOMPUTE_PROPS.
3288 HANDLED_RETURN means return immediately to the caller, to
3289 continue iteration without calling any further handlers. This is
3290 used when we need to act on some property right away, for example
3291 when we need to display the ellipsis or a replacing display
3292 property, such as display string or image.
3294 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3295 consumed, and the handler switched to the next overlay string.
3296 This signals the loop below to refrain from looking for more
3297 overlays before all the overlay strings of the current overlay
3300 Some of the handlers called by the loop push the iterator state
3301 onto the stack (see 'push_it'), and arrange for the iteration to
3302 continue with another object, such as an image, a display string,
3303 or an overlay string. In most such cases, it->stop_charpos is
3304 set to the first character of the string, so that when the
3305 iteration resumes, this function will immediately be called
3306 again, to examine the properties at the beginning of the string.
3308 When a display or overlay string is exhausted, the iterator state
3309 is popped (see 'pop_it'), and iteration continues with the
3310 previous object. Again, in many such cases this function is
3311 called again to find the next position where properties might
3316 handled
= HANDLED_NORMALLY
;
3318 /* Call text property handlers. */
3319 for (p
= it_props
; p
->handler
; ++p
)
3321 handled
= p
->handler (it
);
3323 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3325 else if (handled
== HANDLED_RETURN
)
3327 /* We still want to show before and after strings from
3328 overlays even if the actual buffer text is replaced. */
3329 if (!handle_overlay_change_p
3331 /* Don't call get_overlay_strings_1 if we already
3332 have overlay strings loaded, because doing so
3333 will load them again and push the iterator state
3334 onto the stack one more time, which is not
3335 expected by the rest of the code that processes
3337 || (it
->current
.overlay_string_index
< 0
3338 && !get_overlay_strings_1 (it
, 0, false)))
3341 setup_for_ellipsis (it
, 0);
3342 /* When handling a display spec, we might load an
3343 empty string. In that case, discard it here. We
3344 used to discard it in handle_single_display_spec,
3345 but that causes get_overlay_strings_1, above, to
3346 ignore overlay strings that we must check. */
3347 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3351 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3355 it
->string_from_display_prop_p
= false;
3356 it
->from_disp_prop_p
= false;
3357 handle_overlay_change_p
= false;
3359 handled
= HANDLED_RECOMPUTE_PROPS
;
3362 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3363 handle_overlay_change_p
= false;
3366 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3368 /* Don't check for overlay strings below when set to deliver
3369 characters from a display vector. */
3370 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3371 handle_overlay_change_p
= false;
3373 /* Handle overlay changes.
3374 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3375 if it finds overlays. */
3376 if (handle_overlay_change_p
)
3377 handled
= handle_overlay_change (it
);
3382 setup_for_ellipsis (it
, 0);
3386 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3388 /* Determine where to stop next. */
3389 if (handled
== HANDLED_NORMALLY
)
3390 compute_stop_pos (it
);
3394 /* Compute IT->stop_charpos from text property and overlay change
3395 information for IT's current position. */
3398 compute_stop_pos (struct it
*it
)
3400 register INTERVAL iv
, next_iv
;
3401 Lisp_Object object
, limit
, position
;
3402 ptrdiff_t charpos
, bytepos
;
3404 if (STRINGP (it
->string
))
3406 /* Strings are usually short, so don't limit the search for
3408 it
->stop_charpos
= it
->end_charpos
;
3409 object
= it
->string
;
3411 charpos
= IT_STRING_CHARPOS (*it
);
3412 bytepos
= IT_STRING_BYTEPOS (*it
);
3418 /* If end_charpos is out of range for some reason, such as a
3419 misbehaving display function, rationalize it (Bug#5984). */
3420 if (it
->end_charpos
> ZV
)
3421 it
->end_charpos
= ZV
;
3422 it
->stop_charpos
= it
->end_charpos
;
3424 /* If next overlay change is in front of the current stop pos
3425 (which is IT->end_charpos), stop there. Note: value of
3426 next_overlay_change is point-max if no overlay change
3428 charpos
= IT_CHARPOS (*it
);
3429 bytepos
= IT_BYTEPOS (*it
);
3430 pos
= next_overlay_change (charpos
);
3431 if (pos
< it
->stop_charpos
)
3432 it
->stop_charpos
= pos
;
3434 /* Set up variables for computing the stop position from text
3435 property changes. */
3436 XSETBUFFER (object
, current_buffer
);
3437 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3440 /* Get the interval containing IT's position. Value is a null
3441 interval if there isn't such an interval. */
3442 position
= make_number (charpos
);
3443 iv
= validate_interval_range (object
, &position
, &position
, false);
3446 Lisp_Object values_here
[LAST_PROP_IDX
];
3449 /* Get properties here. */
3450 for (p
= it_props
; p
->handler
; ++p
)
3451 values_here
[p
->idx
] = textget (iv
->plist
,
3452 builtin_lisp_symbol (p
->name
));
3454 /* Look for an interval following iv that has different
3456 for (next_iv
= next_interval (iv
);
3459 || XFASTINT (limit
) > next_iv
->position
));
3460 next_iv
= next_interval (next_iv
))
3462 for (p
= it_props
; p
->handler
; ++p
)
3464 Lisp_Object new_value
= textget (next_iv
->plist
,
3465 builtin_lisp_symbol (p
->name
));
3466 if (!EQ (values_here
[p
->idx
], new_value
))
3476 if (INTEGERP (limit
)
3477 && next_iv
->position
>= XFASTINT (limit
))
3478 /* No text property change up to limit. */
3479 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3481 /* Text properties change in next_iv. */
3482 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3486 if (it
->cmp_it
.id
< 0)
3488 ptrdiff_t stoppos
= it
->end_charpos
;
3490 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3492 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3493 stoppos
, it
->string
);
3496 eassert (STRINGP (it
->string
)
3497 || (it
->stop_charpos
>= BEGV
3498 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3502 /* Return the position of the next overlay change after POS in
3503 current_buffer. Value is point-max if no overlay change
3504 follows. This is like `next-overlay-change' but doesn't use
3508 next_overlay_change (ptrdiff_t pos
)
3510 ptrdiff_t i
, noverlays
;
3512 Lisp_Object
*overlays
;
3515 /* Get all overlays at the given position. */
3516 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3518 /* If any of these overlays ends before endpos,
3519 use its ending point instead. */
3520 for (i
= 0; i
< noverlays
; ++i
)
3525 oend
= OVERLAY_END (overlays
[i
]);
3526 oendpos
= OVERLAY_POSITION (oend
);
3527 endpos
= min (endpos
, oendpos
);
3534 /* How many characters forward to search for a display property or
3535 display string. Searching too far forward makes the bidi display
3536 sluggish, especially in small windows. */
3537 #define MAX_DISP_SCAN 250
3539 /* Return the character position of a display string at or after
3540 position specified by POSITION. If no display string exists at or
3541 after POSITION, return ZV. A display string is either an overlay
3542 with `display' property whose value is a string, or a `display'
3543 text property whose value is a string. STRING is data about the
3544 string to iterate; if STRING->lstring is nil, we are iterating a
3545 buffer. FRAME_WINDOW_P is true when we are displaying a window
3546 on a GUI frame. DISP_PROP is set to zero if we searched
3547 MAX_DISP_SCAN characters forward without finding any display
3548 strings, non-zero otherwise. It is set to 2 if the display string
3549 uses any kind of `(space ...)' spec that will produce a stretch of
3550 white space in the text area. */
3552 compute_display_string_pos (struct text_pos
*position
,
3553 struct bidi_string_data
*string
,
3555 bool frame_window_p
, int *disp_prop
)
3557 /* OBJECT = nil means current buffer. */
3558 Lisp_Object object
, object1
;
3559 Lisp_Object pos
, spec
, limpos
;
3560 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3561 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3562 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3563 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3565 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3566 struct text_pos tpos
;
3569 if (string
&& STRINGP (string
->lstring
))
3570 object1
= object
= string
->lstring
;
3571 else if (w
&& !string_p
)
3573 XSETWINDOW (object
, w
);
3577 object1
= object
= Qnil
;
3582 /* We don't support display properties whose values are strings
3583 that have display string properties. */
3584 || string
->from_disp_str
3585 /* C strings cannot have display properties. */
3586 || (string
->s
&& !STRINGP (object
)))
3592 /* If the character at CHARPOS is where the display string begins,
3594 pos
= make_number (charpos
);
3595 if (STRINGP (object
))
3596 bufpos
= string
->bufpos
;
3600 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3602 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3605 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3613 /* Look forward for the first character with a `display' property
3614 that will replace the underlying text when displayed. */
3615 limpos
= make_number (lim
);
3617 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3618 CHARPOS (tpos
) = XFASTINT (pos
);
3619 if (CHARPOS (tpos
) >= lim
)
3624 if (STRINGP (object
))
3625 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3627 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3628 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3629 if (!STRINGP (object
))
3630 bufpos
= CHARPOS (tpos
);
3631 } while (NILP (spec
)
3632 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3633 bufpos
, frame_window_p
)));
3637 return CHARPOS (tpos
);
3640 /* Return the character position of the end of the display string that
3641 started at CHARPOS. If there's no display string at CHARPOS,
3642 return -1. A display string is either an overlay with `display'
3643 property whose value is a string or a `display' text property whose
3644 value is a string. */
3646 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3648 /* OBJECT = nil means current buffer. */
3649 Lisp_Object object
=
3650 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3651 Lisp_Object pos
= make_number (charpos
);
3653 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3655 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3658 /* It could happen that the display property or overlay was removed
3659 since we found it in compute_display_string_pos above. One way
3660 this can happen is if JIT font-lock was called (through
3661 handle_fontified_prop), and jit-lock-functions remove text
3662 properties or overlays from the portion of buffer that includes
3663 CHARPOS. Muse mode is known to do that, for example. In this
3664 case, we return -1 to the caller, to signal that no display
3665 string is actually present at CHARPOS. See bidi_fetch_char for
3666 how this is handled.
3668 An alternative would be to never look for display properties past
3669 it->stop_charpos. But neither compute_display_string_pos nor
3670 bidi_fetch_char that calls it know or care where the next
3672 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3675 /* Look forward for the first character where the `display' property
3677 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3679 return XFASTINT (pos
);
3684 /***********************************************************************
3686 ***********************************************************************/
3688 /* Handle changes in the `fontified' property of the current buffer by
3689 calling hook functions from Qfontification_functions to fontify
3692 static enum prop_handled
3693 handle_fontified_prop (struct it
*it
)
3695 Lisp_Object prop
, pos
;
3696 enum prop_handled handled
= HANDLED_NORMALLY
;
3698 if (!NILP (Vmemory_full
))
3701 /* Get the value of the `fontified' property at IT's current buffer
3702 position. (The `fontified' property doesn't have a special
3703 meaning in strings.) If the value is nil, call functions from
3704 Qfontification_functions. */
3705 if (!STRINGP (it
->string
)
3707 && !NILP (Vfontification_functions
)
3708 && !NILP (Vrun_hooks
)
3709 && (pos
= make_number (IT_CHARPOS (*it
)),
3710 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3711 /* Ignore the special cased nil value always present at EOB since
3712 no amount of fontifying will be able to change it. */
3713 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3715 ptrdiff_t count
= SPECPDL_INDEX ();
3717 struct buffer
*obuf
= current_buffer
;
3718 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3719 bool old_clip_changed
= current_buffer
->clip_changed
;
3721 val
= Vfontification_functions
;
3722 specbind (Qfontification_functions
, Qnil
);
3724 eassert (it
->end_charpos
== ZV
);
3726 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3727 safe_call1 (val
, pos
);
3730 Lisp_Object fns
, fn
;
3734 for (; CONSP (val
); val
= XCDR (val
))
3740 /* A value of t indicates this hook has a local
3741 binding; it means to run the global binding too.
3742 In a global value, t should not occur. If it
3743 does, we must ignore it to avoid an endless
3745 for (fns
= Fdefault_value (Qfontification_functions
);
3751 safe_call1 (fn
, pos
);
3755 safe_call1 (fn
, pos
);
3759 unbind_to (count
, Qnil
);
3761 /* Fontification functions routinely call `save-restriction'.
3762 Normally, this tags clip_changed, which can confuse redisplay
3763 (see discussion in Bug#6671). Since we don't perform any
3764 special handling of fontification changes in the case where
3765 `save-restriction' isn't called, there's no point doing so in
3766 this case either. So, if the buffer's restrictions are
3767 actually left unchanged, reset clip_changed. */
3768 if (obuf
== current_buffer
)
3770 if (begv
== BEGV
&& zv
== ZV
)
3771 current_buffer
->clip_changed
= old_clip_changed
;
3773 /* There isn't much we can reasonably do to protect against
3774 misbehaving fontification, but here's a fig leaf. */
3775 else if (BUFFER_LIVE_P (obuf
))
3776 set_buffer_internal_1 (obuf
);
3778 /* The fontification code may have added/removed text.
3779 It could do even a lot worse, but let's at least protect against
3780 the most obvious case where only the text past `pos' gets changed',
3781 as is/was done in grep.el where some escapes sequences are turned
3782 into face properties (bug#7876). */
3783 it
->end_charpos
= ZV
;
3785 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3786 something. This avoids an endless loop if they failed to
3787 fontify the text for which reason ever. */
3788 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3789 handled
= HANDLED_RECOMPUTE_PROPS
;
3797 /***********************************************************************
3799 ***********************************************************************/
3801 /* Set up iterator IT from face properties at its current position.
3802 Called from handle_stop. */
3804 static enum prop_handled
3805 handle_face_prop (struct it
*it
)
3808 ptrdiff_t next_stop
;
3810 if (!STRINGP (it
->string
))
3813 = face_at_buffer_position (it
->w
,
3817 + TEXT_PROP_DISTANCE_LIMIT
),
3818 false, it
->base_face_id
);
3820 /* Is this a start of a run of characters with box face?
3821 Caveat: this can be called for a freshly initialized
3822 iterator; face_id is -1 in this case. We know that the new
3823 face will not change until limit, i.e. if the new face has a
3824 box, all characters up to limit will have one. But, as
3825 usual, we don't know whether limit is really the end. */
3826 if (new_face_id
!= it
->face_id
)
3828 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3829 /* If it->face_id is -1, old_face below will be NULL, see
3830 the definition of FACE_FROM_ID. This will happen if this
3831 is the initial call that gets the face. */
3832 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3834 /* If the value of face_id of the iterator is -1, we have to
3835 look in front of IT's position and see whether there is a
3836 face there that's different from new_face_id. */
3837 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3839 int prev_face_id
= face_before_it_pos (it
);
3841 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3844 /* If the new face has a box, but the old face does not,
3845 this is the start of a run of characters with box face,
3846 i.e. this character has a shadow on the left side. */
3847 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3848 && (old_face
== NULL
|| !old_face
->box
));
3849 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3857 Lisp_Object from_overlay
3858 = (it
->current
.overlay_string_index
>= 0
3859 ? it
->string_overlays
[it
->current
.overlay_string_index
3860 % OVERLAY_STRING_CHUNK_SIZE
]
3863 /* See if we got to this string directly or indirectly from
3864 an overlay property. That includes the before-string or
3865 after-string of an overlay, strings in display properties
3866 provided by an overlay, their text properties, etc.
3868 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3869 if (! NILP (from_overlay
))
3870 for (i
= it
->sp
- 1; i
>= 0; i
--)
3872 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3874 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3875 % OVERLAY_STRING_CHUNK_SIZE
];
3876 else if (! NILP (it
->stack
[i
].from_overlay
))
3877 from_overlay
= it
->stack
[i
].from_overlay
;
3879 if (!NILP (from_overlay
))
3883 if (! NILP (from_overlay
))
3885 bufpos
= IT_CHARPOS (*it
);
3886 /* For a string from an overlay, the base face depends
3887 only on text properties and ignores overlays. */
3889 = face_for_overlay_string (it
->w
,
3893 + TEXT_PROP_DISTANCE_LIMIT
),
3901 /* For strings from a `display' property, use the face at
3902 IT's current buffer position as the base face to merge
3903 with, so that overlay strings appear in the same face as
3904 surrounding text, unless they specify their own faces.
3905 For strings from wrap-prefix and line-prefix properties,
3906 use the default face, possibly remapped via
3907 Vface_remapping_alist. */
3908 /* Note that the fact that we use the face at _buffer_
3909 position means that a 'display' property on an overlay
3910 string will not inherit the face of that overlay string,
3911 but will instead revert to the face of buffer text
3912 covered by the overlay. This is visible, e.g., when the
3913 overlay specifies a box face, but neither the buffer nor
3914 the display string do. This sounds like a design bug,
3915 but Emacs always did that since v21.1, so changing that
3916 might be a big deal. */
3917 base_face_id
= it
->string_from_prefix_prop_p
3918 ? (!NILP (Vface_remapping_alist
)
3919 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3921 : underlying_face_id (it
);
3924 new_face_id
= face_at_string_position (it
->w
,
3926 IT_STRING_CHARPOS (*it
),
3929 base_face_id
, false);
3931 /* Is this a start of a run of characters with box? Caveat:
3932 this can be called for a freshly allocated iterator; face_id
3933 is -1 is this case. We know that the new face will not
3934 change until the next check pos, i.e. if the new face has a
3935 box, all characters up to that position will have a
3936 box. But, as usual, we don't know whether that position
3937 is really the end. */
3938 if (new_face_id
!= it
->face_id
)
3940 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3941 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3943 /* If new face has a box but old face hasn't, this is the
3944 start of a run of characters with box, i.e. it has a
3945 shadow on the left side. */
3946 it
->start_of_box_run_p
3947 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3948 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3952 it
->face_id
= new_face_id
;
3953 return HANDLED_NORMALLY
;
3957 /* Return the ID of the face ``underlying'' IT's current position,
3958 which is in a string. If the iterator is associated with a
3959 buffer, return the face at IT's current buffer position.
3960 Otherwise, use the iterator's base_face_id. */
3963 underlying_face_id (struct it
*it
)
3965 int face_id
= it
->base_face_id
, i
;
3967 eassert (STRINGP (it
->string
));
3969 for (i
= it
->sp
- 1; i
>= 0; --i
)
3970 if (NILP (it
->stack
[i
].string
))
3971 face_id
= it
->stack
[i
].face_id
;
3977 /* Compute the face one character before or after the current position
3978 of IT, in the visual order. BEFORE_P means get the face
3979 in front (to the left in L2R paragraphs, to the right in R2L
3980 paragraphs) of IT's screen position. Value is the ID of the face. */
3983 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3986 ptrdiff_t next_check_charpos
;
3988 void *it_copy_data
= NULL
;
3990 eassert (it
->s
== NULL
);
3992 if (STRINGP (it
->string
))
3994 ptrdiff_t bufpos
, charpos
;
3997 /* No face change past the end of the string (for the case
3998 we are padding with spaces). No face change before the
4000 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4001 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4006 /* Set charpos to the position before or after IT's current
4007 position, in the logical order, which in the non-bidi
4008 case is the same as the visual order. */
4010 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4011 else if (it
->what
== IT_COMPOSITION
)
4012 /* For composition, we must check the character after the
4014 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4016 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4022 /* With bidi iteration, the character before the current
4023 in the visual order cannot be found by simple
4024 iteration, because "reverse" reordering is not
4025 supported. Instead, we need to start from the string
4026 beginning and go all the way to the current string
4027 position, remembering the previous position. */
4028 /* Ignore face changes before the first visible
4029 character on this display line. */
4030 if (it
->current_x
<= it
->first_visible_x
)
4032 SAVE_IT (it_copy
, *it
, it_copy_data
);
4033 IT_STRING_CHARPOS (it_copy
) = 0;
4034 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4038 charpos
= IT_STRING_CHARPOS (it_copy
);
4039 if (charpos
>= SCHARS (it
->string
))
4041 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4043 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4045 RESTORE_IT (it
, it
, it_copy_data
);
4049 /* Set charpos to the string position of the character
4050 that comes after IT's current position in the visual
4052 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4056 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4058 charpos
= it_copy
.bidi_it
.charpos
;
4061 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4063 if (it
->current
.overlay_string_index
>= 0)
4064 bufpos
= IT_CHARPOS (*it
);
4068 base_face_id
= underlying_face_id (it
);
4070 /* Get the face for ASCII, or unibyte. */
4071 face_id
= face_at_string_position (it
->w
,
4075 &next_check_charpos
,
4076 base_face_id
, false);
4078 /* Correct the face for charsets different from ASCII. Do it
4079 for the multibyte case only. The face returned above is
4080 suitable for unibyte text if IT->string is unibyte. */
4081 if (STRING_MULTIBYTE (it
->string
))
4083 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4084 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4086 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4088 c
= string_char_and_length (p
, &len
);
4089 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4094 struct text_pos pos
;
4096 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4097 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4100 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4101 pos
= it
->current
.pos
;
4106 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4109 if (it
->what
== IT_COMPOSITION
)
4111 /* For composition, we must check the position after
4113 pos
.charpos
+= it
->cmp_it
.nchars
;
4114 pos
.bytepos
+= it
->len
;
4117 INC_TEXT_POS (pos
, it
->multibyte_p
);
4126 /* With bidi iteration, the character before the current
4127 in the visual order cannot be found by simple
4128 iteration, because "reverse" reordering is not
4129 supported. Instead, we need to use the move_it_*
4130 family of functions, and move to the previous
4131 character starting from the beginning of the visual
4133 /* Ignore face changes before the first visible
4134 character on this display line. */
4135 if (it
->current_x
<= it
->first_visible_x
)
4137 SAVE_IT (it_copy
, *it
, it_copy_data
);
4138 /* Implementation note: Since move_it_in_display_line
4139 works in the iterator geometry, and thinks the first
4140 character is always the leftmost, even in R2L lines,
4141 we don't need to distinguish between the R2L and L2R
4143 current_x
= it_copy
.current_x
;
4144 move_it_vertically_backward (&it_copy
, 0);
4145 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4146 pos
= it_copy
.current
.pos
;
4147 RESTORE_IT (it
, it
, it_copy_data
);
4151 /* Set charpos to the buffer position of the character
4152 that comes after IT's current position in the visual
4154 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4158 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4161 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4164 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4166 /* Determine face for CHARSET_ASCII, or unibyte. */
4167 face_id
= face_at_buffer_position (it
->w
,
4169 &next_check_charpos
,
4172 /* Correct the face for charsets different from ASCII. Do it
4173 for the multibyte case only. The face returned above is
4174 suitable for unibyte text if current_buffer is unibyte. */
4175 if (it
->multibyte_p
)
4177 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4178 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4179 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4188 /***********************************************************************
4190 ***********************************************************************/
4192 /* Set up iterator IT from invisible properties at its current
4193 position. Called from handle_stop. */
4195 static enum prop_handled
4196 handle_invisible_prop (struct it
*it
)
4198 enum prop_handled handled
= HANDLED_NORMALLY
;
4202 if (STRINGP (it
->string
))
4204 Lisp_Object end_charpos
, limit
;
4206 /* Get the value of the invisible text property at the
4207 current position. Value will be nil if there is no such
4209 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4210 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4211 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4213 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4215 /* Record whether we have to display an ellipsis for the
4217 bool display_ellipsis_p
= (invis
== 2);
4218 ptrdiff_t len
, endpos
;
4220 handled
= HANDLED_RECOMPUTE_PROPS
;
4222 /* Get the position at which the next visible text can be
4223 found in IT->string, if any. */
4224 endpos
= len
= SCHARS (it
->string
);
4225 XSETINT (limit
, len
);
4229 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4231 /* Since LIMIT is always an integer, so should be the
4232 value returned by Fnext_single_property_change. */
4233 eassert (INTEGERP (end_charpos
));
4234 if (INTEGERP (end_charpos
))
4236 endpos
= XFASTINT (end_charpos
);
4237 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4238 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4240 display_ellipsis_p
= true;
4242 else /* Should never happen; but if it does, exit the loop. */
4245 while (invis
!= 0 && endpos
< len
);
4247 if (display_ellipsis_p
)
4248 it
->ellipsis_p
= true;
4252 /* Text at END_CHARPOS is visible. Move IT there. */
4253 struct text_pos old
;
4256 old
= it
->current
.string_pos
;
4257 oldpos
= CHARPOS (old
);
4260 if (it
->bidi_it
.first_elt
4261 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4262 bidi_paragraph_init (it
->paragraph_embedding
,
4263 &it
->bidi_it
, true);
4264 /* Bidi-iterate out of the invisible text. */
4267 bidi_move_to_visually_next (&it
->bidi_it
);
4269 while (oldpos
<= it
->bidi_it
.charpos
4270 && it
->bidi_it
.charpos
< endpos
);
4272 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4273 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4274 if (IT_CHARPOS (*it
) >= endpos
)
4275 it
->prev_stop
= endpos
;
4279 IT_STRING_CHARPOS (*it
) = endpos
;
4280 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4285 /* The rest of the string is invisible. If this is an
4286 overlay string, proceed with the next overlay string
4287 or whatever comes and return a character from there. */
4288 if (it
->current
.overlay_string_index
>= 0
4289 && !display_ellipsis_p
)
4291 next_overlay_string (it
);
4292 /* Don't check for overlay strings when we just
4293 finished processing them. */
4294 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4298 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4299 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4306 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4307 Lisp_Object pos
, overlay
;
4309 /* First of all, is there invisible text at this position? */
4310 tem
= start_charpos
= IT_CHARPOS (*it
);
4311 pos
= make_number (tem
);
4312 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4314 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4316 /* If we are on invisible text, skip over it. */
4317 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4319 /* Record whether we have to display an ellipsis for the
4321 bool display_ellipsis_p
= invis
== 2;
4323 handled
= HANDLED_RECOMPUTE_PROPS
;
4325 /* Loop skipping over invisible text. The loop is left at
4326 ZV or with IT on the first char being visible again. */
4329 /* Try to skip some invisible text. Return value is the
4330 position reached which can be equal to where we start
4331 if there is nothing invisible there. This skips both
4332 over invisible text properties and overlays with
4333 invisible property. */
4334 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4336 /* If we skipped nothing at all we weren't at invisible
4337 text in the first place. If everything to the end of
4338 the buffer was skipped, end the loop. */
4339 if (newpos
== tem
|| newpos
>= ZV
)
4343 /* We skipped some characters but not necessarily
4344 all there are. Check if we ended up on visible
4345 text. Fget_char_property returns the property of
4346 the char before the given position, i.e. if we
4347 get invis = 0, this means that the char at
4348 newpos is visible. */
4349 pos
= make_number (newpos
);
4350 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4351 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4354 /* If we ended up on invisible text, proceed to
4355 skip starting with next_stop. */
4359 /* If there are adjacent invisible texts, don't lose the
4360 second one's ellipsis. */
4362 display_ellipsis_p
= true;
4366 /* The position newpos is now either ZV or on visible text. */
4369 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4371 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4373 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4375 /* If the invisible text ends on a newline or on a
4376 character after a newline, we can avoid the costly,
4377 character by character, bidi iteration to NEWPOS, and
4378 instead simply reseat the iterator there. That's
4379 because all bidi reordering information is tossed at
4380 the newline. This is a big win for modes that hide
4381 complete lines, like Outline, Org, etc. */
4382 if (on_newline
|| after_newline
)
4384 struct text_pos tpos
;
4385 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4387 SET_TEXT_POS (tpos
, newpos
, bpos
);
4388 reseat_1 (it
, tpos
, false);
4389 /* If we reseat on a newline/ZV, we need to prep the
4390 bidi iterator for advancing to the next character
4391 after the newline/EOB, keeping the current paragraph
4392 direction (so that PRODUCE_GLYPHS does TRT wrt
4393 prepending/appending glyphs to a glyph row). */
4396 it
->bidi_it
.first_elt
= false;
4397 it
->bidi_it
.paragraph_dir
= pdir
;
4398 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4399 it
->bidi_it
.nchars
= 1;
4400 it
->bidi_it
.ch_len
= 1;
4403 else /* Must use the slow method. */
4405 /* With bidi iteration, the region of invisible text
4406 could start and/or end in the middle of a
4407 non-base embedding level. Therefore, we need to
4408 skip invisible text using the bidi iterator,
4409 starting at IT's current position, until we find
4410 ourselves outside of the invisible text.
4411 Skipping invisible text _after_ bidi iteration
4412 avoids affecting the visual order of the
4413 displayed text when invisible properties are
4414 added or removed. */
4415 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4417 /* If we were `reseat'ed to a new paragraph,
4418 determine the paragraph base direction. We
4419 need to do it now because
4420 next_element_from_buffer may not have a
4421 chance to do it, if we are going to skip any
4422 text at the beginning, which resets the
4424 bidi_paragraph_init (it
->paragraph_embedding
,
4425 &it
->bidi_it
, true);
4429 bidi_move_to_visually_next (&it
->bidi_it
);
4431 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4432 && it
->bidi_it
.charpos
< newpos
);
4433 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4434 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4435 /* If we overstepped NEWPOS, record its position in
4436 the iterator, so that we skip invisible text if
4437 later the bidi iteration lands us in the
4438 invisible region again. */
4439 if (IT_CHARPOS (*it
) >= newpos
)
4440 it
->prev_stop
= newpos
;
4445 IT_CHARPOS (*it
) = newpos
;
4446 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4449 if (display_ellipsis_p
)
4451 /* Make sure that the glyphs of the ellipsis will get
4452 correct `charpos' values. If we would not update
4453 it->position here, the glyphs would belong to the
4454 last visible character _before_ the invisible
4455 text, which confuses `set_cursor_from_row'.
4457 We use the last invisible position instead of the
4458 first because this way the cursor is always drawn on
4459 the first "." of the ellipsis, whenever PT is inside
4460 the invisible text. Otherwise the cursor would be
4461 placed _after_ the ellipsis when the point is after the
4462 first invisible character. */
4463 if (!STRINGP (it
->object
))
4465 it
->position
.charpos
= newpos
- 1;
4466 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4470 /* If there are before-strings at the start of invisible
4471 text, and the text is invisible because of a text
4472 property, arrange to show before-strings because 20.x did
4473 it that way. (If the text is invisible because of an
4474 overlay property instead of a text property, this is
4475 already handled in the overlay code.) */
4477 && get_overlay_strings (it
, it
->stop_charpos
))
4479 handled
= HANDLED_RECOMPUTE_PROPS
;
4482 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4483 /* The call to get_overlay_strings above recomputes
4484 it->stop_charpos, but it only considers changes
4485 in properties and overlays beyond iterator's
4486 current position. This causes us to miss changes
4487 that happen exactly where the invisible property
4488 ended. So we play it safe here and force the
4489 iterator to check for potential stop positions
4490 immediately after the invisible text. Note that
4491 if get_overlay_strings returns true, it
4492 normally also pushed the iterator stack, so we
4493 need to update the stop position in the slot
4494 below the current one. */
4495 it
->stack
[it
->sp
- 1].stop_charpos
4496 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4499 else if (display_ellipsis_p
)
4501 it
->ellipsis_p
= true;
4502 /* Let the ellipsis display before
4503 considering any properties of the following char.
4504 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4505 handled
= HANDLED_RETURN
;
4514 /* Make iterator IT return `...' next.
4515 Replaces LEN characters from buffer. */
4518 setup_for_ellipsis (struct it
*it
, int len
)
4520 /* Use the display table definition for `...'. Invalid glyphs
4521 will be handled by the method returning elements from dpvec. */
4522 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4524 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4525 it
->dpvec
= v
->contents
;
4526 it
->dpend
= v
->contents
+ v
->header
.size
;
4530 /* Default `...'. */
4531 it
->dpvec
= default_invis_vector
;
4532 it
->dpend
= default_invis_vector
+ 3;
4535 it
->dpvec_char_len
= len
;
4536 it
->current
.dpvec_index
= 0;
4537 it
->dpvec_face_id
= -1;
4539 /* Remember the current face id in case glyphs specify faces.
4540 IT's face is restored in set_iterator_to_next.
4541 saved_face_id was set to preceding char's face in handle_stop. */
4542 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4543 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4545 /* If the ellipsis represents buffer text, it means we advanced in
4546 the buffer, so we should no longer ignore overlay strings. */
4547 if (it
->method
== GET_FROM_BUFFER
)
4548 it
->ignore_overlay_strings_at_pos_p
= false;
4550 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4551 it
->ellipsis_p
= true;
4556 /***********************************************************************
4558 ***********************************************************************/
4560 /* Set up iterator IT from `display' property at its current position.
4561 Called from handle_stop.
4562 We return HANDLED_RETURN if some part of the display property
4563 overrides the display of the buffer text itself.
4564 Otherwise we return HANDLED_NORMALLY. */
4566 static enum prop_handled
4567 handle_display_prop (struct it
*it
)
4569 Lisp_Object propval
, object
, overlay
;
4570 struct text_pos
*position
;
4572 /* Nonzero if some property replaces the display of the text itself. */
4573 int display_replaced
= 0;
4575 if (STRINGP (it
->string
))
4577 object
= it
->string
;
4578 position
= &it
->current
.string_pos
;
4579 bufpos
= CHARPOS (it
->current
.pos
);
4583 XSETWINDOW (object
, it
->w
);
4584 position
= &it
->current
.pos
;
4585 bufpos
= CHARPOS (*position
);
4588 /* Reset those iterator values set from display property values. */
4589 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4590 it
->space_width
= Qnil
;
4591 it
->font_height
= Qnil
;
4594 /* We don't support recursive `display' properties, i.e. string
4595 values that have a string `display' property, that have a string
4596 `display' property etc. */
4597 if (!it
->string_from_display_prop_p
)
4598 it
->area
= TEXT_AREA
;
4600 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4601 Qdisplay
, object
, &overlay
);
4603 return HANDLED_NORMALLY
;
4604 /* Now OVERLAY is the overlay that gave us this property, or nil
4605 if it was a text property. */
4607 if (!STRINGP (it
->string
))
4608 object
= it
->w
->contents
;
4610 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4612 FRAME_WINDOW_P (it
->f
));
4613 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4616 /* Subroutine of handle_display_prop. Returns non-zero if the display
4617 specification in SPEC is a replacing specification, i.e. it would
4618 replace the text covered by `display' property with something else,
4619 such as an image or a display string. If SPEC includes any kind or
4620 `(space ...) specification, the value is 2; this is used by
4621 compute_display_string_pos, which see.
4623 See handle_single_display_spec for documentation of arguments.
4624 FRAME_WINDOW_P is true if the window being redisplayed is on a
4625 GUI frame; this argument is used only if IT is NULL, see below.
4627 IT can be NULL, if this is called by the bidi reordering code
4628 through compute_display_string_pos, which see. In that case, this
4629 function only examines SPEC, but does not otherwise "handle" it, in
4630 the sense that it doesn't set up members of IT from the display
4633 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4634 Lisp_Object overlay
, struct text_pos
*position
,
4635 ptrdiff_t bufpos
, bool frame_window_p
)
4640 /* Simple specifications. */
4641 && !EQ (XCAR (spec
), Qimage
)
4642 && !EQ (XCAR (spec
), Qspace
)
4643 && !EQ (XCAR (spec
), Qwhen
)
4644 && !EQ (XCAR (spec
), Qslice
)
4645 && !EQ (XCAR (spec
), Qspace_width
)
4646 && !EQ (XCAR (spec
), Qheight
)
4647 && !EQ (XCAR (spec
), Qraise
)
4648 /* Marginal area specifications. */
4649 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4650 && !EQ (XCAR (spec
), Qleft_fringe
)
4651 && !EQ (XCAR (spec
), Qright_fringe
)
4652 && !NILP (XCAR (spec
)))
4654 for (; CONSP (spec
); spec
= XCDR (spec
))
4656 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4657 overlay
, position
, bufpos
,
4658 replacing
, frame_window_p
);
4662 /* If some text in a string is replaced, `position' no
4663 longer points to the position of `object'. */
4664 if (!it
|| STRINGP (object
))
4669 else if (VECTORP (spec
))
4672 for (i
= 0; i
< ASIZE (spec
); ++i
)
4674 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4675 overlay
, position
, bufpos
,
4676 replacing
, frame_window_p
);
4680 /* If some text in a string is replaced, `position' no
4681 longer points to the position of `object'. */
4682 if (!it
|| STRINGP (object
))
4688 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4689 bufpos
, 0, frame_window_p
);
4693 /* Value is the position of the end of the `display' property starting
4694 at START_POS in OBJECT. */
4696 static struct text_pos
4697 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4700 struct text_pos end_pos
;
4702 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4703 Qdisplay
, object
, Qnil
);
4704 CHARPOS (end_pos
) = XFASTINT (end
);
4705 if (STRINGP (object
))
4706 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4708 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4714 /* Set up IT from a single `display' property specification SPEC. OBJECT
4715 is the object in which the `display' property was found. *POSITION
4716 is the position in OBJECT at which the `display' property was found.
4717 BUFPOS is the buffer position of OBJECT (different from POSITION if
4718 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4719 previously saw a display specification which already replaced text
4720 display with something else, for example an image; we ignore such
4721 properties after the first one has been processed.
4723 OVERLAY is the overlay this `display' property came from,
4724 or nil if it was a text property.
4726 If SPEC is a `space' or `image' specification, and in some other
4727 cases too, set *POSITION to the position where the `display'
4730 If IT is NULL, only examine the property specification in SPEC, but
4731 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4732 is intended to be displayed in a window on a GUI frame.
4734 Value is non-zero if something was found which replaces the display
4735 of buffer or string text. */
4738 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4739 Lisp_Object overlay
, struct text_pos
*position
,
4740 ptrdiff_t bufpos
, int display_replaced
,
4741 bool frame_window_p
)
4744 Lisp_Object location
, value
;
4745 struct text_pos start_pos
= *position
;
4747 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4748 If the result is non-nil, use VALUE instead of SPEC. */
4750 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4759 if (!NILP (form
) && !EQ (form
, Qt
))
4761 ptrdiff_t count
= SPECPDL_INDEX ();
4763 /* Bind `object' to the object having the `display' property, a
4764 buffer or string. Bind `position' to the position in the
4765 object where the property was found, and `buffer-position'
4766 to the current position in the buffer. */
4769 XSETBUFFER (object
, current_buffer
);
4770 specbind (Qobject
, object
);
4771 specbind (Qposition
, make_number (CHARPOS (*position
)));
4772 specbind (Qbuffer_position
, make_number (bufpos
));
4773 form
= safe_eval (form
);
4774 unbind_to (count
, Qnil
);
4780 /* Handle `(height HEIGHT)' specifications. */
4782 && EQ (XCAR (spec
), Qheight
)
4783 && CONSP (XCDR (spec
)))
4787 if (!FRAME_WINDOW_P (it
->f
))
4790 it
->font_height
= XCAR (XCDR (spec
));
4791 if (!NILP (it
->font_height
))
4793 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4794 int new_height
= -1;
4796 if (CONSP (it
->font_height
)
4797 && (EQ (XCAR (it
->font_height
), Qplus
)
4798 || EQ (XCAR (it
->font_height
), Qminus
))
4799 && CONSP (XCDR (it
->font_height
))
4800 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4802 /* `(+ N)' or `(- N)' where N is an integer. */
4803 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4804 if (EQ (XCAR (it
->font_height
), Qplus
))
4806 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4808 else if (FUNCTIONP (it
->font_height
))
4810 /* Call function with current height as argument.
4811 Value is the new height. */
4813 height
= safe_call1 (it
->font_height
,
4814 face
->lface
[LFACE_HEIGHT_INDEX
]);
4815 if (NUMBERP (height
))
4816 new_height
= XFLOATINT (height
);
4818 else if (NUMBERP (it
->font_height
))
4820 /* Value is a multiple of the canonical char height. */
4823 f
= FACE_FROM_ID (it
->f
,
4824 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4825 new_height
= (XFLOATINT (it
->font_height
)
4826 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4830 /* Evaluate IT->font_height with `height' bound to the
4831 current specified height to get the new height. */
4832 ptrdiff_t count
= SPECPDL_INDEX ();
4834 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4835 value
= safe_eval (it
->font_height
);
4836 unbind_to (count
, Qnil
);
4838 if (NUMBERP (value
))
4839 new_height
= XFLOATINT (value
);
4843 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4850 /* Handle `(space-width WIDTH)'. */
4852 && EQ (XCAR (spec
), Qspace_width
)
4853 && CONSP (XCDR (spec
)))
4857 if (!FRAME_WINDOW_P (it
->f
))
4860 value
= XCAR (XCDR (spec
));
4861 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4862 it
->space_width
= value
;
4868 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4870 && EQ (XCAR (spec
), Qslice
))
4876 if (!FRAME_WINDOW_P (it
->f
))
4879 if (tem
= XCDR (spec
), CONSP (tem
))
4881 it
->slice
.x
= XCAR (tem
);
4882 if (tem
= XCDR (tem
), CONSP (tem
))
4884 it
->slice
.y
= XCAR (tem
);
4885 if (tem
= XCDR (tem
), CONSP (tem
))
4887 it
->slice
.width
= XCAR (tem
);
4888 if (tem
= XCDR (tem
), CONSP (tem
))
4889 it
->slice
.height
= XCAR (tem
);
4898 /* Handle `(raise FACTOR)'. */
4900 && EQ (XCAR (spec
), Qraise
)
4901 && CONSP (XCDR (spec
)))
4905 if (!FRAME_WINDOW_P (it
->f
))
4908 #ifdef HAVE_WINDOW_SYSTEM
4909 value
= XCAR (XCDR (spec
));
4910 if (NUMBERP (value
))
4912 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4913 it
->voffset
= - (XFLOATINT (value
)
4914 * (normal_char_height (face
->font
, -1)));
4916 #endif /* HAVE_WINDOW_SYSTEM */
4922 /* Don't handle the other kinds of display specifications
4923 inside a string that we got from a `display' property. */
4924 if (it
&& it
->string_from_display_prop_p
)
4927 /* Characters having this form of property are not displayed, so
4928 we have to find the end of the property. */
4931 start_pos
= *position
;
4932 *position
= display_prop_end (it
, object
, start_pos
);
4933 /* If the display property comes from an overlay, don't consider
4934 any potential stop_charpos values before the end of that
4935 overlay. Since display_prop_end will happily find another
4936 'display' property coming from some other overlay or text
4937 property on buffer positions before this overlay's end, we
4938 need to ignore them, or else we risk displaying this
4939 overlay's display string/image twice. */
4940 if (!NILP (overlay
))
4942 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4944 if (ovendpos
> CHARPOS (*position
))
4945 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4950 /* Stop the scan at that end position--we assume that all
4951 text properties change there. */
4953 it
->stop_charpos
= position
->charpos
;
4955 /* Handle `(left-fringe BITMAP [FACE])'
4956 and `(right-fringe BITMAP [FACE])'. */
4958 && (EQ (XCAR (spec
), Qleft_fringe
)
4959 || EQ (XCAR (spec
), Qright_fringe
))
4960 && CONSP (XCDR (spec
)))
4966 if (!FRAME_WINDOW_P (it
->f
))
4967 /* If we return here, POSITION has been advanced
4968 across the text with this property. */
4970 /* Synchronize the bidi iterator with POSITION. This is
4971 needed because we are not going to push the iterator
4972 on behalf of this display property, so there will be
4973 no pop_it call to do this synchronization for us. */
4976 it
->position
= *position
;
4977 iterate_out_of_display_property (it
);
4978 *position
= it
->position
;
4983 else if (!frame_window_p
)
4986 #ifdef HAVE_WINDOW_SYSTEM
4987 value
= XCAR (XCDR (spec
));
4988 if (!SYMBOLP (value
)
4989 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4990 /* If we return here, POSITION has been advanced
4991 across the text with this property. */
4993 if (it
&& it
->bidi_p
)
4995 it
->position
= *position
;
4996 iterate_out_of_display_property (it
);
4997 *position
= it
->position
;
5004 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5006 if (CONSP (XCDR (XCDR (spec
))))
5008 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5009 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5010 FRINGE_FACE_ID
, false);
5015 /* Save current settings of IT so that we can restore them
5016 when we are finished with the glyph property value. */
5017 push_it (it
, position
);
5019 it
->area
= TEXT_AREA
;
5020 it
->what
= IT_IMAGE
;
5021 it
->image_id
= -1; /* no image */
5022 it
->position
= start_pos
;
5023 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5024 it
->method
= GET_FROM_IMAGE
;
5025 it
->from_overlay
= Qnil
;
5026 it
->face_id
= face_id
;
5027 it
->from_disp_prop_p
= true;
5029 /* Say that we haven't consumed the characters with
5030 `display' property yet. The call to pop_it in
5031 set_iterator_to_next will clean this up. */
5032 *position
= start_pos
;
5034 if (EQ (XCAR (spec
), Qleft_fringe
))
5036 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5037 it
->left_user_fringe_face_id
= face_id
;
5041 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5042 it
->right_user_fringe_face_id
= face_id
;
5045 #endif /* HAVE_WINDOW_SYSTEM */
5049 /* Prepare to handle `((margin left-margin) ...)',
5050 `((margin right-margin) ...)' and `((margin nil) ...)'
5051 prefixes for display specifications. */
5052 location
= Qunbound
;
5053 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5057 value
= XCDR (spec
);
5059 value
= XCAR (value
);
5062 if (EQ (XCAR (tem
), Qmargin
)
5063 && (tem
= XCDR (tem
),
5064 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5066 || EQ (tem
, Qleft_margin
)
5067 || EQ (tem
, Qright_margin
))))
5071 if (EQ (location
, Qunbound
))
5077 /* After this point, VALUE is the property after any
5078 margin prefix has been stripped. It must be a string,
5079 an image specification, or `(space ...)'.
5081 LOCATION specifies where to display: `left-margin',
5082 `right-margin' or nil. */
5084 bool valid_p
= (STRINGP (value
)
5085 #ifdef HAVE_WINDOW_SYSTEM
5086 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5087 && valid_image_p (value
))
5088 #endif /* not HAVE_WINDOW_SYSTEM */
5089 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5091 if (valid_p
&& display_replaced
== 0)
5097 /* Callers need to know whether the display spec is any kind
5098 of `(space ...)' spec that is about to affect text-area
5100 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5105 /* Save current settings of IT so that we can restore them
5106 when we are finished with the glyph property value. */
5107 push_it (it
, position
);
5108 it
->from_overlay
= overlay
;
5109 it
->from_disp_prop_p
= true;
5111 if (NILP (location
))
5112 it
->area
= TEXT_AREA
;
5113 else if (EQ (location
, Qleft_margin
))
5114 it
->area
= LEFT_MARGIN_AREA
;
5116 it
->area
= RIGHT_MARGIN_AREA
;
5118 if (STRINGP (value
))
5121 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5122 it
->current
.overlay_string_index
= -1;
5123 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5124 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5125 it
->method
= GET_FROM_STRING
;
5126 it
->stop_charpos
= 0;
5128 it
->base_level_stop
= 0;
5129 it
->string_from_display_prop_p
= true;
5130 /* Say that we haven't consumed the characters with
5131 `display' property yet. The call to pop_it in
5132 set_iterator_to_next will clean this up. */
5133 if (BUFFERP (object
))
5134 *position
= start_pos
;
5136 /* Force paragraph direction to be that of the parent
5137 object. If the parent object's paragraph direction is
5138 not yet determined, default to L2R. */
5139 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5140 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5142 it
->paragraph_embedding
= L2R
;
5144 /* Set up the bidi iterator for this display string. */
5147 it
->bidi_it
.string
.lstring
= it
->string
;
5148 it
->bidi_it
.string
.s
= NULL
;
5149 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5150 it
->bidi_it
.string
.bufpos
= bufpos
;
5151 it
->bidi_it
.string
.from_disp_str
= true;
5152 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5153 it
->bidi_it
.w
= it
->w
;
5154 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5157 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5159 it
->method
= GET_FROM_STRETCH
;
5161 *position
= it
->position
= start_pos
;
5162 retval
= 1 + (it
->area
== TEXT_AREA
);
5164 #ifdef HAVE_WINDOW_SYSTEM
5167 it
->what
= IT_IMAGE
;
5168 it
->image_id
= lookup_image (it
->f
, value
);
5169 it
->position
= start_pos
;
5170 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5171 it
->method
= GET_FROM_IMAGE
;
5173 /* Say that we haven't consumed the characters with
5174 `display' property yet. The call to pop_it in
5175 set_iterator_to_next will clean this up. */
5176 *position
= start_pos
;
5178 #endif /* HAVE_WINDOW_SYSTEM */
5183 /* Invalid property or property not supported. Restore
5184 POSITION to what it was before. */
5185 *position
= start_pos
;
5189 /* Check if PROP is a display property value whose text should be
5190 treated as intangible. OVERLAY is the overlay from which PROP
5191 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5192 specify the buffer position covered by PROP. */
5195 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5196 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5198 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5199 struct text_pos position
;
5201 SET_TEXT_POS (position
, charpos
, bytepos
);
5202 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5203 &position
, charpos
, frame_window_p
)
5208 /* Return true if PROP is a display sub-property value containing STRING.
5210 Implementation note: this and the following function are really
5211 special cases of handle_display_spec and
5212 handle_single_display_spec, and should ideally use the same code.
5213 Until they do, these two pairs must be consistent and must be
5214 modified in sync. */
5217 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5219 if (EQ (string
, prop
))
5222 /* Skip over `when FORM'. */
5223 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5228 /* Actually, the condition following `when' should be eval'ed,
5229 like handle_single_display_spec does, and we should return
5230 false if it evaluates to nil. However, this function is
5231 called only when the buffer was already displayed and some
5232 glyph in the glyph matrix was found to come from a display
5233 string. Therefore, the condition was already evaluated, and
5234 the result was non-nil, otherwise the display string wouldn't
5235 have been displayed and we would have never been called for
5236 this property. Thus, we can skip the evaluation and assume
5237 its result is non-nil. */
5242 /* Skip over `margin LOCATION'. */
5243 if (EQ (XCAR (prop
), Qmargin
))
5254 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5258 /* Return true if STRING appears in the `display' property PROP. */
5261 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5264 && !EQ (XCAR (prop
), Qwhen
)
5265 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5267 /* A list of sub-properties. */
5268 while (CONSP (prop
))
5270 if (single_display_spec_string_p (XCAR (prop
), string
))
5275 else if (VECTORP (prop
))
5277 /* A vector of sub-properties. */
5279 for (i
= 0; i
< ASIZE (prop
); ++i
)
5280 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5284 return single_display_spec_string_p (prop
, string
);
5289 /* Look for STRING in overlays and text properties in the current
5290 buffer, between character positions FROM and TO (excluding TO).
5291 BACK_P means look back (in this case, TO is supposed to be
5293 Value is the first character position where STRING was found, or
5294 zero if it wasn't found before hitting TO.
5296 This function may only use code that doesn't eval because it is
5297 called asynchronously from note_mouse_highlight. */
5300 string_buffer_position_lim (Lisp_Object string
,
5301 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5303 Lisp_Object limit
, prop
, pos
;
5306 pos
= make_number (max (from
, BEGV
));
5308 if (!back_p
) /* looking forward */
5310 limit
= make_number (min (to
, ZV
));
5311 while (!found
&& !EQ (pos
, limit
))
5313 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5314 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5317 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5321 else /* looking back */
5323 limit
= make_number (max (to
, BEGV
));
5324 while (!found
&& !EQ (pos
, limit
))
5326 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5327 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5330 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5335 return found
? XINT (pos
) : 0;
5338 /* Determine which buffer position in current buffer STRING comes from.
5339 AROUND_CHARPOS is an approximate position where it could come from.
5340 Value is the buffer position or 0 if it couldn't be determined.
5342 This function is necessary because we don't record buffer positions
5343 in glyphs generated from strings (to keep struct glyph small).
5344 This function may only use code that doesn't eval because it is
5345 called asynchronously from note_mouse_highlight. */
5348 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5350 const int MAX_DISTANCE
= 1000;
5351 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5352 around_charpos
+ MAX_DISTANCE
,
5356 found
= string_buffer_position_lim (string
, around_charpos
,
5357 around_charpos
- MAX_DISTANCE
, true);
5363 /***********************************************************************
5364 `composition' property
5365 ***********************************************************************/
5367 /* Set up iterator IT from `composition' property at its current
5368 position. Called from handle_stop. */
5370 static enum prop_handled
5371 handle_composition_prop (struct it
*it
)
5373 Lisp_Object prop
, string
;
5374 ptrdiff_t pos
, pos_byte
, start
, end
;
5376 if (STRINGP (it
->string
))
5380 pos
= IT_STRING_CHARPOS (*it
);
5381 pos_byte
= IT_STRING_BYTEPOS (*it
);
5382 string
= it
->string
;
5383 s
= SDATA (string
) + pos_byte
;
5384 it
->c
= STRING_CHAR (s
);
5388 pos
= IT_CHARPOS (*it
);
5389 pos_byte
= IT_BYTEPOS (*it
);
5391 it
->c
= FETCH_CHAR (pos_byte
);
5394 /* If there's a valid composition and point is not inside of the
5395 composition (in the case that the composition is from the current
5396 buffer), draw a glyph composed from the composition components. */
5397 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5398 && composition_valid_p (start
, end
, prop
)
5399 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5402 /* As we can't handle this situation (perhaps font-lock added
5403 a new composition), we just return here hoping that next
5404 redisplay will detect this composition much earlier. */
5405 return HANDLED_NORMALLY
;
5408 if (STRINGP (it
->string
))
5409 pos_byte
= string_char_to_byte (it
->string
, start
);
5411 pos_byte
= CHAR_TO_BYTE (start
);
5413 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5416 if (it
->cmp_it
.id
>= 0)
5419 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5420 it
->cmp_it
.nglyphs
= -1;
5424 return HANDLED_NORMALLY
;
5429 /***********************************************************************
5431 ***********************************************************************/
5433 /* The following structure is used to record overlay strings for
5434 later sorting in load_overlay_strings. */
5436 struct overlay_entry
5438 Lisp_Object overlay
;
5441 bool after_string_p
;
5445 /* Set up iterator IT from overlay strings at its current position.
5446 Called from handle_stop. */
5448 static enum prop_handled
5449 handle_overlay_change (struct it
*it
)
5451 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5452 return HANDLED_RECOMPUTE_PROPS
;
5454 return HANDLED_NORMALLY
;
5458 /* Set up the next overlay string for delivery by IT, if there is an
5459 overlay string to deliver. Called by set_iterator_to_next when the
5460 end of the current overlay string is reached. If there are more
5461 overlay strings to display, IT->string and
5462 IT->current.overlay_string_index are set appropriately here.
5463 Otherwise IT->string is set to nil. */
5466 next_overlay_string (struct it
*it
)
5468 ++it
->current
.overlay_string_index
;
5469 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5471 /* No more overlay strings. Restore IT's settings to what
5472 they were before overlay strings were processed, and
5473 continue to deliver from current_buffer. */
5475 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5478 || (NILP (it
->string
)
5479 && it
->method
== GET_FROM_BUFFER
5480 && it
->stop_charpos
>= BEGV
5481 && it
->stop_charpos
<= it
->end_charpos
));
5482 it
->current
.overlay_string_index
= -1;
5483 it
->n_overlay_strings
= 0;
5484 /* If there's an empty display string on the stack, pop the
5485 stack, to resync the bidi iterator with IT's position. Such
5486 empty strings are pushed onto the stack in
5487 get_overlay_strings_1. */
5488 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5491 /* Since we've exhausted overlay strings at this buffer
5492 position, set the flag to ignore overlays until we move to
5493 another position. The flag is reset in
5494 next_element_from_buffer. */
5495 it
->ignore_overlay_strings_at_pos_p
= true;
5497 /* If we're at the end of the buffer, record that we have
5498 processed the overlay strings there already, so that
5499 next_element_from_buffer doesn't try it again. */
5500 if (NILP (it
->string
)
5501 && IT_CHARPOS (*it
) >= it
->end_charpos
5502 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5503 it
->overlay_strings_at_end_processed_p
= true;
5504 /* Note: we reset overlay_strings_charpos only here, to make
5505 sure the just-processed overlays were indeed at EOB.
5506 Otherwise, overlays on text with invisible text property,
5507 which are processed with IT's position past the invisible
5508 text, might fool us into thinking the overlays at EOB were
5509 already processed (linum-mode can cause this, for
5511 it
->overlay_strings_charpos
= -1;
5515 /* There are more overlay strings to process. If
5516 IT->current.overlay_string_index has advanced to a position
5517 where we must load IT->overlay_strings with more strings, do
5518 it. We must load at the IT->overlay_strings_charpos where
5519 IT->n_overlay_strings was originally computed; when invisible
5520 text is present, this might not be IT_CHARPOS (Bug#7016). */
5521 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5523 if (it
->current
.overlay_string_index
&& i
== 0)
5524 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5526 /* Initialize IT to deliver display elements from the overlay
5528 it
->string
= it
->overlay_strings
[i
];
5529 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5530 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5531 it
->method
= GET_FROM_STRING
;
5532 it
->stop_charpos
= 0;
5533 it
->end_charpos
= SCHARS (it
->string
);
5534 if (it
->cmp_it
.stop_pos
>= 0)
5535 it
->cmp_it
.stop_pos
= 0;
5537 it
->base_level_stop
= 0;
5539 /* Set up the bidi iterator for this overlay string. */
5542 it
->bidi_it
.string
.lstring
= it
->string
;
5543 it
->bidi_it
.string
.s
= NULL
;
5544 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5545 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5546 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5547 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5548 it
->bidi_it
.w
= it
->w
;
5549 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5557 /* Compare two overlay_entry structures E1 and E2. Used as a
5558 comparison function for qsort in load_overlay_strings. Overlay
5559 strings for the same position are sorted so that
5561 1. All after-strings come in front of before-strings, except
5562 when they come from the same overlay.
5564 2. Within after-strings, strings are sorted so that overlay strings
5565 from overlays with higher priorities come first.
5567 2. Within before-strings, strings are sorted so that overlay
5568 strings from overlays with higher priorities come last.
5570 Value is analogous to strcmp. */
5574 compare_overlay_entries (const void *e1
, const void *e2
)
5576 struct overlay_entry
const *entry1
= e1
;
5577 struct overlay_entry
const *entry2
= e2
;
5580 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5582 /* Let after-strings appear in front of before-strings if
5583 they come from different overlays. */
5584 if (EQ (entry1
->overlay
, entry2
->overlay
))
5585 result
= entry1
->after_string_p
? 1 : -1;
5587 result
= entry1
->after_string_p
? -1 : 1;
5589 else if (entry1
->priority
!= entry2
->priority
)
5591 if (entry1
->after_string_p
)
5592 /* After-strings sorted in order of decreasing priority. */
5593 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5595 /* Before-strings sorted in order of increasing priority. */
5596 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5605 /* Load the vector IT->overlay_strings with overlay strings from IT's
5606 current buffer position, or from CHARPOS if that is > 0. Set
5607 IT->n_overlays to the total number of overlay strings found.
5609 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5610 a time. On entry into load_overlay_strings,
5611 IT->current.overlay_string_index gives the number of overlay
5612 strings that have already been loaded by previous calls to this
5615 IT->add_overlay_start contains an additional overlay start
5616 position to consider for taking overlay strings from, if non-zero.
5617 This position comes into play when the overlay has an `invisible'
5618 property, and both before and after-strings. When we've skipped to
5619 the end of the overlay, because of its `invisible' property, we
5620 nevertheless want its before-string to appear.
5621 IT->add_overlay_start will contain the overlay start position
5624 Overlay strings are sorted so that after-string strings come in
5625 front of before-string strings. Within before and after-strings,
5626 strings are sorted by overlay priority. See also function
5627 compare_overlay_entries. */
5630 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5632 Lisp_Object overlay
, window
, str
, invisible
;
5633 struct Lisp_Overlay
*ov
;
5634 ptrdiff_t start
, end
;
5635 ptrdiff_t n
= 0, i
, j
;
5637 struct overlay_entry entriesbuf
[20];
5638 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5639 struct overlay_entry
*entries
= entriesbuf
;
5643 charpos
= IT_CHARPOS (*it
);
5645 /* Append the overlay string STRING of overlay OVERLAY to vector
5646 `entries' which has size `size' and currently contains `n'
5647 elements. AFTER_P means STRING is an after-string of
5649 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5652 Lisp_Object priority; \
5656 struct overlay_entry *old = entries; \
5657 SAFE_NALLOCA (entries, 2, size); \
5658 memcpy (entries, old, size * sizeof *entries); \
5662 entries[n].string = (STRING); \
5663 entries[n].overlay = (OVERLAY); \
5664 priority = Foverlay_get ((OVERLAY), Qpriority); \
5665 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5666 entries[n].after_string_p = (AFTER_P); \
5671 /* Process overlay before the overlay center. */
5672 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5674 XSETMISC (overlay
, ov
);
5675 eassert (OVERLAYP (overlay
));
5676 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5677 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5682 /* Skip this overlay if it doesn't start or end at IT's current
5684 if (end
!= charpos
&& start
!= charpos
)
5687 /* Skip this overlay if it doesn't apply to IT->w. */
5688 window
= Foverlay_get (overlay
, Qwindow
);
5689 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5692 /* If the text ``under'' the overlay is invisible, both before-
5693 and after-strings from this overlay are visible; start and
5694 end position are indistinguishable. */
5695 invisible
= Foverlay_get (overlay
, Qinvisible
);
5696 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5698 /* If overlay has a non-empty before-string, record it. */
5699 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5700 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5702 RECORD_OVERLAY_STRING (overlay
, str
, false);
5704 /* If overlay has a non-empty after-string, record it. */
5705 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5706 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5708 RECORD_OVERLAY_STRING (overlay
, str
, true);
5711 /* Process overlays after the overlay center. */
5712 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5714 XSETMISC (overlay
, ov
);
5715 eassert (OVERLAYP (overlay
));
5716 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5717 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5719 if (start
> charpos
)
5722 /* Skip this overlay if it doesn't start or end at IT's current
5724 if (end
!= charpos
&& start
!= charpos
)
5727 /* Skip this overlay if it doesn't apply to IT->w. */
5728 window
= Foverlay_get (overlay
, Qwindow
);
5729 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5732 /* If the text ``under'' the overlay is invisible, it has a zero
5733 dimension, and both before- and after-strings apply. */
5734 invisible
= Foverlay_get (overlay
, Qinvisible
);
5735 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5737 /* If overlay has a non-empty before-string, record it. */
5738 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5739 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5741 RECORD_OVERLAY_STRING (overlay
, str
, false);
5743 /* If overlay has a non-empty after-string, record it. */
5744 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5745 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5747 RECORD_OVERLAY_STRING (overlay
, str
, true);
5750 #undef RECORD_OVERLAY_STRING
5754 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5756 /* Record number of overlay strings, and where we computed it. */
5757 it
->n_overlay_strings
= n
;
5758 it
->overlay_strings_charpos
= charpos
;
5760 /* IT->current.overlay_string_index is the number of overlay strings
5761 that have already been consumed by IT. Copy some of the
5762 remaining overlay strings to IT->overlay_strings. */
5764 j
= it
->current
.overlay_string_index
;
5765 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5767 it
->overlay_strings
[i
] = entries
[j
].string
;
5768 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5776 /* Get the first chunk of overlay strings at IT's current buffer
5777 position, or at CHARPOS if that is > 0. Value is true if at
5778 least one overlay string was found. */
5781 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5783 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5784 process. This fills IT->overlay_strings with strings, and sets
5785 IT->n_overlay_strings to the total number of strings to process.
5786 IT->pos.overlay_string_index has to be set temporarily to zero
5787 because load_overlay_strings needs this; it must be set to -1
5788 when no overlay strings are found because a zero value would
5789 indicate a position in the first overlay string. */
5790 it
->current
.overlay_string_index
= 0;
5791 load_overlay_strings (it
, charpos
);
5793 /* If we found overlay strings, set up IT to deliver display
5794 elements from the first one. Otherwise set up IT to deliver
5795 from current_buffer. */
5796 if (it
->n_overlay_strings
)
5798 /* Make sure we know settings in current_buffer, so that we can
5799 restore meaningful values when we're done with the overlay
5802 compute_stop_pos (it
);
5803 eassert (it
->face_id
>= 0);
5805 /* Save IT's settings. They are restored after all overlay
5806 strings have been processed. */
5807 eassert (!compute_stop_p
|| it
->sp
== 0);
5809 /* When called from handle_stop, there might be an empty display
5810 string loaded. In that case, don't bother saving it. But
5811 don't use this optimization with the bidi iterator, since we
5812 need the corresponding pop_it call to resync the bidi
5813 iterator's position with IT's position, after we are done
5814 with the overlay strings. (The corresponding call to pop_it
5815 in case of an empty display string is in
5816 next_overlay_string.) */
5818 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5821 /* Set up IT to deliver display elements from the first overlay
5823 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5824 it
->string
= it
->overlay_strings
[0];
5825 it
->from_overlay
= Qnil
;
5826 it
->stop_charpos
= 0;
5827 eassert (STRINGP (it
->string
));
5828 it
->end_charpos
= SCHARS (it
->string
);
5830 it
->base_level_stop
= 0;
5831 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5832 it
->method
= GET_FROM_STRING
;
5833 it
->from_disp_prop_p
= 0;
5835 /* Force paragraph direction to be that of the parent
5837 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5838 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5840 it
->paragraph_embedding
= L2R
;
5842 /* Set up the bidi iterator for this overlay string. */
5845 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5847 it
->bidi_it
.string
.lstring
= it
->string
;
5848 it
->bidi_it
.string
.s
= NULL
;
5849 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5850 it
->bidi_it
.string
.bufpos
= pos
;
5851 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5852 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5853 it
->bidi_it
.w
= it
->w
;
5854 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5859 it
->current
.overlay_string_index
= -1;
5864 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5867 it
->method
= GET_FROM_BUFFER
;
5869 get_overlay_strings_1 (it
, charpos
, true);
5873 /* Value is true if we found at least one overlay string. */
5874 return STRINGP (it
->string
);
5879 /***********************************************************************
5880 Saving and restoring state
5881 ***********************************************************************/
5883 /* Save current settings of IT on IT->stack. Called, for example,
5884 before setting up IT for an overlay string, to be able to restore
5885 IT's settings to what they were after the overlay string has been
5886 processed. If POSITION is non-NULL, it is the position to save on
5887 the stack instead of IT->position. */
5890 push_it (struct it
*it
, struct text_pos
*position
)
5892 struct iterator_stack_entry
*p
;
5894 eassert (it
->sp
< IT_STACK_SIZE
);
5895 p
= it
->stack
+ it
->sp
;
5897 p
->stop_charpos
= it
->stop_charpos
;
5898 p
->prev_stop
= it
->prev_stop
;
5899 p
->base_level_stop
= it
->base_level_stop
;
5900 p
->cmp_it
= it
->cmp_it
;
5901 eassert (it
->face_id
>= 0);
5902 p
->face_id
= it
->face_id
;
5903 p
->string
= it
->string
;
5904 p
->method
= it
->method
;
5905 p
->from_overlay
= it
->from_overlay
;
5908 case GET_FROM_IMAGE
:
5909 p
->u
.image
.object
= it
->object
;
5910 p
->u
.image
.image_id
= it
->image_id
;
5911 p
->u
.image
.slice
= it
->slice
;
5913 case GET_FROM_STRETCH
:
5914 p
->u
.stretch
.object
= it
->object
;
5916 case GET_FROM_BUFFER
:
5917 case GET_FROM_DISPLAY_VECTOR
:
5918 case GET_FROM_STRING
:
5919 case GET_FROM_C_STRING
:
5924 p
->position
= position
? *position
: it
->position
;
5925 p
->current
= it
->current
;
5926 p
->end_charpos
= it
->end_charpos
;
5927 p
->string_nchars
= it
->string_nchars
;
5929 p
->multibyte_p
= it
->multibyte_p
;
5930 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5931 p
->space_width
= it
->space_width
;
5932 p
->font_height
= it
->font_height
;
5933 p
->voffset
= it
->voffset
;
5934 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5935 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5936 p
->display_ellipsis_p
= false;
5937 p
->line_wrap
= it
->line_wrap
;
5938 p
->bidi_p
= it
->bidi_p
;
5939 p
->paragraph_embedding
= it
->paragraph_embedding
;
5940 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5943 /* Save the state of the bidi iterator as well. */
5945 bidi_push_it (&it
->bidi_it
);
5949 iterate_out_of_display_property (struct it
*it
)
5951 bool buffer_p
= !STRINGP (it
->string
);
5952 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5953 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5955 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5957 /* Maybe initialize paragraph direction. If we are at the beginning
5958 of a new paragraph, next_element_from_buffer may not have a
5959 chance to do that. */
5960 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5961 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5962 /* prev_stop can be zero, so check against BEGV as well. */
5963 while (it
->bidi_it
.charpos
>= bob
5964 && it
->prev_stop
<= it
->bidi_it
.charpos
5965 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5966 && it
->bidi_it
.charpos
< eob
)
5967 bidi_move_to_visually_next (&it
->bidi_it
);
5968 /* Record the stop_pos we just crossed, for when we cross it
5970 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5971 it
->prev_stop
= CHARPOS (it
->position
);
5972 /* If we ended up not where pop_it put us, resync IT's
5973 positional members with the bidi iterator. */
5974 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5975 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5977 it
->current
.pos
= it
->position
;
5979 it
->current
.string_pos
= it
->position
;
5982 /* Restore IT's settings from IT->stack. Called, for example, when no
5983 more overlay strings must be processed, and we return to delivering
5984 display elements from a buffer, or when the end of a string from a
5985 `display' property is reached and we return to delivering display
5986 elements from an overlay string, or from a buffer. */
5989 pop_it (struct it
*it
)
5991 struct iterator_stack_entry
*p
;
5992 bool from_display_prop
= it
->from_disp_prop_p
;
5993 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
5995 eassert (it
->sp
> 0);
5997 p
= it
->stack
+ it
->sp
;
5998 it
->stop_charpos
= p
->stop_charpos
;
5999 it
->prev_stop
= p
->prev_stop
;
6000 it
->base_level_stop
= p
->base_level_stop
;
6001 it
->cmp_it
= p
->cmp_it
;
6002 it
->face_id
= p
->face_id
;
6003 it
->current
= p
->current
;
6004 it
->position
= p
->position
;
6005 it
->string
= p
->string
;
6006 it
->from_overlay
= p
->from_overlay
;
6007 if (NILP (it
->string
))
6008 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6009 it
->method
= p
->method
;
6012 case GET_FROM_IMAGE
:
6013 it
->image_id
= p
->u
.image
.image_id
;
6014 it
->object
= p
->u
.image
.object
;
6015 it
->slice
= p
->u
.image
.slice
;
6017 case GET_FROM_STRETCH
:
6018 it
->object
= p
->u
.stretch
.object
;
6020 case GET_FROM_BUFFER
:
6021 it
->object
= it
->w
->contents
;
6023 case GET_FROM_STRING
:
6025 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6027 /* Restore the face_box_p flag, since it could have been
6028 overwritten by the face of the object that we just finished
6031 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6032 it
->object
= it
->string
;
6035 case GET_FROM_DISPLAY_VECTOR
:
6037 it
->method
= GET_FROM_C_STRING
;
6038 else if (STRINGP (it
->string
))
6039 it
->method
= GET_FROM_STRING
;
6042 it
->method
= GET_FROM_BUFFER
;
6043 it
->object
= it
->w
->contents
;
6046 case GET_FROM_C_STRING
:
6051 it
->end_charpos
= p
->end_charpos
;
6052 it
->string_nchars
= p
->string_nchars
;
6054 it
->multibyte_p
= p
->multibyte_p
;
6055 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6056 it
->space_width
= p
->space_width
;
6057 it
->font_height
= p
->font_height
;
6058 it
->voffset
= p
->voffset
;
6059 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6060 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6061 it
->line_wrap
= p
->line_wrap
;
6062 it
->bidi_p
= p
->bidi_p
;
6063 it
->paragraph_embedding
= p
->paragraph_embedding
;
6064 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6067 bidi_pop_it (&it
->bidi_it
);
6068 /* Bidi-iterate until we get out of the portion of text, if any,
6069 covered by a `display' text property or by an overlay with
6070 `display' property. (We cannot just jump there, because the
6071 internal coherency of the bidi iterator state can not be
6072 preserved across such jumps.) We also must determine the
6073 paragraph base direction if the overlay we just processed is
6074 at the beginning of a new paragraph. */
6075 if (from_display_prop
6076 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6077 iterate_out_of_display_property (it
);
6079 eassert ((BUFFERP (it
->object
)
6080 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6081 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6082 || (STRINGP (it
->object
)
6083 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6084 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6085 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6087 /* If we move the iterator over text covered by a display property
6088 to a new buffer position, any info about previously seen overlays
6089 is no longer valid. */
6090 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6091 it
->ignore_overlay_strings_at_pos_p
= false;
6096 /***********************************************************************
6098 ***********************************************************************/
6100 /* Set IT's current position to the previous line start. */
6103 back_to_previous_line_start (struct it
*it
)
6105 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6108 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6112 /* Move IT to the next line start.
6114 Value is true if a newline was found. Set *SKIPPED_P to true if
6115 we skipped over part of the text (as opposed to moving the iterator
6116 continuously over the text). Otherwise, don't change the value
6119 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6120 iterator on the newline, if it was found.
6122 Newlines may come from buffer text, overlay strings, or strings
6123 displayed via the `display' property. That's the reason we can't
6124 simply use find_newline_no_quit.
6126 Note that this function may not skip over invisible text that is so
6127 because of text properties and immediately follows a newline. If
6128 it would, function reseat_at_next_visible_line_start, when called
6129 from set_iterator_to_next, would effectively make invisible
6130 characters following a newline part of the wrong glyph row, which
6131 leads to wrong cursor motion. */
6134 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6135 struct bidi_it
*bidi_it_prev
)
6137 ptrdiff_t old_selective
;
6138 bool newline_found_p
= false;
6140 const int MAX_NEWLINE_DISTANCE
= 500;
6142 /* If already on a newline, just consume it to avoid unintended
6143 skipping over invisible text below. */
6144 if (it
->what
== IT_CHARACTER
6146 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6148 if (it
->bidi_p
&& bidi_it_prev
)
6149 *bidi_it_prev
= it
->bidi_it
;
6150 set_iterator_to_next (it
, false);
6155 /* Don't handle selective display in the following. It's (a)
6156 unnecessary because it's done by the caller, and (b) leads to an
6157 infinite recursion because next_element_from_ellipsis indirectly
6158 calls this function. */
6159 old_selective
= it
->selective
;
6162 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6163 from buffer text. */
6165 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6166 n
+= !STRINGP (it
->string
))
6168 if (!get_next_display_element (it
))
6170 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6171 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6172 *bidi_it_prev
= it
->bidi_it
;
6173 set_iterator_to_next (it
, false);
6176 /* If we didn't find a newline near enough, see if we can use a
6178 if (!newline_found_p
)
6180 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6181 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6185 eassert (!STRINGP (it
->string
));
6187 /* If there isn't any `display' property in sight, and no
6188 overlays, we can just use the position of the newline in
6190 if (it
->stop_charpos
>= limit
6191 || ((pos
= Fnext_single_property_change (make_number (start
),
6193 make_number (limit
)),
6195 && next_overlay_change (start
) == ZV
))
6199 IT_CHARPOS (*it
) = limit
;
6200 IT_BYTEPOS (*it
) = bytepos
;
6204 struct bidi_it bprev
;
6206 /* Help bidi.c avoid expensive searches for display
6207 properties and overlays, by telling it that there are
6208 none up to `limit'. */
6209 if (it
->bidi_it
.disp_pos
< limit
)
6211 it
->bidi_it
.disp_pos
= limit
;
6212 it
->bidi_it
.disp_prop
= 0;
6215 bprev
= it
->bidi_it
;
6216 bidi_move_to_visually_next (&it
->bidi_it
);
6217 } while (it
->bidi_it
.charpos
!= limit
);
6218 IT_CHARPOS (*it
) = limit
;
6219 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6221 *bidi_it_prev
= bprev
;
6223 *skipped_p
= newline_found_p
= true;
6227 while (get_next_display_element (it
)
6228 && !newline_found_p
)
6230 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6231 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6232 *bidi_it_prev
= it
->bidi_it
;
6233 set_iterator_to_next (it
, false);
6238 it
->selective
= old_selective
;
6239 return newline_found_p
;
6243 /* Set IT's current position to the previous visible line start. Skip
6244 invisible text that is so either due to text properties or due to
6245 selective display. Caution: this does not change IT->current_x and
6249 back_to_previous_visible_line_start (struct it
*it
)
6251 while (IT_CHARPOS (*it
) > BEGV
)
6253 back_to_previous_line_start (it
);
6255 if (IT_CHARPOS (*it
) <= BEGV
)
6258 /* If selective > 0, then lines indented more than its value are
6260 if (it
->selective
> 0
6261 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6265 /* Check the newline before point for invisibility. */
6268 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6269 Qinvisible
, it
->window
);
6270 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6274 if (IT_CHARPOS (*it
) <= BEGV
)
6279 void *it2data
= NULL
;
6282 Lisp_Object val
, overlay
;
6284 SAVE_IT (it2
, *it
, it2data
);
6286 /* If newline is part of a composition, continue from start of composition */
6287 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6288 && beg
< IT_CHARPOS (*it
))
6291 /* If newline is replaced by a display property, find start of overlay
6292 or interval and continue search from that point. */
6293 pos
= --IT_CHARPOS (it2
);
6296 bidi_unshelve_cache (NULL
, false);
6297 it2
.string_from_display_prop_p
= false;
6298 it2
.from_disp_prop_p
= false;
6299 if (handle_display_prop (&it2
) == HANDLED_RETURN
6300 && !NILP (val
= get_char_property_and_overlay
6301 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6302 && (OVERLAYP (overlay
)
6303 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6304 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6306 RESTORE_IT (it
, it
, it2data
);
6310 /* Newline is not replaced by anything -- so we are done. */
6311 RESTORE_IT (it
, it
, it2data
);
6317 IT_CHARPOS (*it
) = beg
;
6318 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6322 it
->continuation_lines_width
= 0;
6324 eassert (IT_CHARPOS (*it
) >= BEGV
);
6325 eassert (IT_CHARPOS (*it
) == BEGV
6326 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6331 /* Reseat iterator IT at the previous visible line start. Skip
6332 invisible text that is so either due to text properties or due to
6333 selective display. At the end, update IT's overlay information,
6334 face information etc. */
6337 reseat_at_previous_visible_line_start (struct it
*it
)
6339 back_to_previous_visible_line_start (it
);
6340 reseat (it
, it
->current
.pos
, true);
6345 /* Reseat iterator IT on the next visible line start in the current
6346 buffer. ON_NEWLINE_P means position IT on the newline
6347 preceding the line start. Skip over invisible text that is so
6348 because of selective display. Compute faces, overlays etc at the
6349 new position. Note that this function does not skip over text that
6350 is invisible because of text properties. */
6353 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6355 bool skipped_p
= false;
6356 struct bidi_it bidi_it_prev
;
6357 bool newline_found_p
6358 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6360 /* Skip over lines that are invisible because they are indented
6361 more than the value of IT->selective. */
6362 if (it
->selective
> 0)
6363 while (IT_CHARPOS (*it
) < ZV
6364 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6367 eassert (IT_BYTEPOS (*it
) == BEGV
6368 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6370 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6373 /* Position on the newline if that's what's requested. */
6374 if (on_newline_p
&& newline_found_p
)
6376 if (STRINGP (it
->string
))
6378 if (IT_STRING_CHARPOS (*it
) > 0)
6382 --IT_STRING_CHARPOS (*it
);
6383 --IT_STRING_BYTEPOS (*it
);
6387 /* We need to restore the bidi iterator to the state
6388 it had on the newline, and resync the IT's
6389 position with that. */
6390 it
->bidi_it
= bidi_it_prev
;
6391 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6392 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6396 else if (IT_CHARPOS (*it
) > BEGV
)
6405 /* We need to restore the bidi iterator to the state it
6406 had on the newline and resync IT with that. */
6407 it
->bidi_it
= bidi_it_prev
;
6408 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6409 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6411 reseat (it
, it
->current
.pos
, false);
6415 reseat (it
, it
->current
.pos
, false);
6422 /***********************************************************************
6423 Changing an iterator's position
6424 ***********************************************************************/
6426 /* Change IT's current position to POS in current_buffer.
6427 If FORCE_P, always check for text properties at the new position.
6428 Otherwise, text properties are only looked up if POS >=
6429 IT->check_charpos of a property. */
6432 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6434 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6436 reseat_1 (it
, pos
, false);
6438 /* Determine where to check text properties. Avoid doing it
6439 where possible because text property lookup is very expensive. */
6441 || CHARPOS (pos
) > it
->stop_charpos
6442 || CHARPOS (pos
) < original_pos
)
6446 /* For bidi iteration, we need to prime prev_stop and
6447 base_level_stop with our best estimations. */
6448 /* Implementation note: Of course, POS is not necessarily a
6449 stop position, so assigning prev_pos to it is a lie; we
6450 should have called compute_stop_backwards. However, if
6451 the current buffer does not include any R2L characters,
6452 that call would be a waste of cycles, because the
6453 iterator will never move back, and thus never cross this
6454 "fake" stop position. So we delay that backward search
6455 until the time we really need it, in next_element_from_buffer. */
6456 if (CHARPOS (pos
) != it
->prev_stop
)
6457 it
->prev_stop
= CHARPOS (pos
);
6458 if (CHARPOS (pos
) < it
->base_level_stop
)
6459 it
->base_level_stop
= 0; /* meaning it's unknown */
6465 it
->prev_stop
= it
->base_level_stop
= 0;
6474 /* Change IT's buffer position to POS. SET_STOP_P means set
6475 IT->stop_pos to POS, also. */
6478 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6480 /* Don't call this function when scanning a C string. */
6481 eassert (it
->s
== NULL
);
6483 /* POS must be a reasonable value. */
6484 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6486 it
->current
.pos
= it
->position
= pos
;
6487 it
->end_charpos
= ZV
;
6489 it
->current
.dpvec_index
= -1;
6490 it
->current
.overlay_string_index
= -1;
6491 IT_STRING_CHARPOS (*it
) = -1;
6492 IT_STRING_BYTEPOS (*it
) = -1;
6494 it
->method
= GET_FROM_BUFFER
;
6495 it
->object
= it
->w
->contents
;
6496 it
->area
= TEXT_AREA
;
6497 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6499 it
->string_from_display_prop_p
= false;
6500 it
->string_from_prefix_prop_p
= false;
6502 it
->from_disp_prop_p
= false;
6503 it
->face_before_selective_p
= false;
6506 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6508 bidi_unshelve_cache (NULL
, false);
6509 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6510 it
->bidi_it
.string
.s
= NULL
;
6511 it
->bidi_it
.string
.lstring
= Qnil
;
6512 it
->bidi_it
.string
.bufpos
= 0;
6513 it
->bidi_it
.string
.from_disp_str
= false;
6514 it
->bidi_it
.string
.unibyte
= false;
6515 it
->bidi_it
.w
= it
->w
;
6520 it
->stop_charpos
= CHARPOS (pos
);
6521 it
->base_level_stop
= CHARPOS (pos
);
6523 /* This make the information stored in it->cmp_it invalidate. */
6528 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6529 If S is non-null, it is a C string to iterate over. Otherwise,
6530 STRING gives a Lisp string to iterate over.
6532 If PRECISION > 0, don't return more then PRECISION number of
6533 characters from the string.
6535 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6536 characters have been returned. FIELD_WIDTH < 0 means an infinite
6539 MULTIBYTE = 0 means disable processing of multibyte characters,
6540 MULTIBYTE > 0 means enable it,
6541 MULTIBYTE < 0 means use IT->multibyte_p.
6543 IT must be initialized via a prior call to init_iterator before
6544 calling this function. */
6547 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6548 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6551 /* No text property checks performed by default, but see below. */
6552 it
->stop_charpos
= -1;
6554 /* Set iterator position and end position. */
6555 memset (&it
->current
, 0, sizeof it
->current
);
6556 it
->current
.overlay_string_index
= -1;
6557 it
->current
.dpvec_index
= -1;
6558 eassert (charpos
>= 0);
6560 /* If STRING is specified, use its multibyteness, otherwise use the
6561 setting of MULTIBYTE, if specified. */
6563 it
->multibyte_p
= multibyte
> 0;
6565 /* Bidirectional reordering of strings is controlled by the default
6566 value of bidi-display-reordering. Don't try to reorder while
6567 loading loadup.el, as the necessary character property tables are
6568 not yet available. */
6571 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6575 eassert (STRINGP (string
));
6576 it
->string
= string
;
6578 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6579 it
->method
= GET_FROM_STRING
;
6580 it
->current
.string_pos
= string_pos (charpos
, string
);
6584 it
->bidi_it
.string
.lstring
= string
;
6585 it
->bidi_it
.string
.s
= NULL
;
6586 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6587 it
->bidi_it
.string
.bufpos
= 0;
6588 it
->bidi_it
.string
.from_disp_str
= false;
6589 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6590 it
->bidi_it
.w
= it
->w
;
6591 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6592 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6597 it
->s
= (const unsigned char *) s
;
6600 /* Note that we use IT->current.pos, not it->current.string_pos,
6601 for displaying C strings. */
6602 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6603 if (it
->multibyte_p
)
6605 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6606 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6610 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6611 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6616 it
->bidi_it
.string
.lstring
= Qnil
;
6617 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6618 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6619 it
->bidi_it
.string
.bufpos
= 0;
6620 it
->bidi_it
.string
.from_disp_str
= false;
6621 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6622 it
->bidi_it
.w
= it
->w
;
6623 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6626 it
->method
= GET_FROM_C_STRING
;
6629 /* PRECISION > 0 means don't return more than PRECISION characters
6631 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6633 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6635 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6638 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6639 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6640 FIELD_WIDTH < 0 means infinite field width. This is useful for
6641 padding with `-' at the end of a mode line. */
6642 if (field_width
< 0)
6643 field_width
= INFINITY
;
6644 /* Implementation note: We deliberately don't enlarge
6645 it->bidi_it.string.schars here to fit it->end_charpos, because
6646 the bidi iterator cannot produce characters out of thin air. */
6647 if (field_width
> it
->end_charpos
- charpos
)
6648 it
->end_charpos
= charpos
+ field_width
;
6650 /* Use the standard display table for displaying strings. */
6651 if (DISP_TABLE_P (Vstandard_display_table
))
6652 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6654 it
->stop_charpos
= charpos
;
6655 it
->prev_stop
= charpos
;
6656 it
->base_level_stop
= 0;
6659 it
->bidi_it
.first_elt
= true;
6660 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6661 it
->bidi_it
.disp_pos
= -1;
6663 if (s
== NULL
&& it
->multibyte_p
)
6665 ptrdiff_t endpos
= SCHARS (it
->string
);
6666 if (endpos
> it
->end_charpos
)
6667 endpos
= it
->end_charpos
;
6668 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6676 /***********************************************************************
6678 ***********************************************************************/
6680 /* Map enum it_method value to corresponding next_element_from_* function. */
6682 typedef bool (*next_element_function
) (struct it
*);
6684 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6686 next_element_from_buffer
,
6687 next_element_from_display_vector
,
6688 next_element_from_string
,
6689 next_element_from_c_string
,
6690 next_element_from_image
,
6691 next_element_from_stretch
6694 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6697 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6698 (possibly with the following characters). */
6700 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6701 ((IT)->cmp_it.id >= 0 \
6702 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6703 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6704 END_CHARPOS, (IT)->w, \
6705 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6709 /* Lookup the char-table Vglyphless_char_display for character C (-1
6710 if we want information for no-font case), and return the display
6711 method symbol. By side-effect, update it->what and
6712 it->glyphless_method. This function is called from
6713 get_next_display_element for each character element, and from
6714 x_produce_glyphs when no suitable font was found. */
6717 lookup_glyphless_char_display (int c
, struct it
*it
)
6719 Lisp_Object glyphless_method
= Qnil
;
6721 if (CHAR_TABLE_P (Vglyphless_char_display
)
6722 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6726 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6727 if (CONSP (glyphless_method
))
6728 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6729 ? XCAR (glyphless_method
)
6730 : XCDR (glyphless_method
);
6733 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6737 if (NILP (glyphless_method
))
6740 /* The default is to display the character by a proper font. */
6742 /* The default for the no-font case is to display an empty box. */
6743 glyphless_method
= Qempty_box
;
6745 if (EQ (glyphless_method
, Qzero_width
))
6748 return glyphless_method
;
6749 /* This method can't be used for the no-font case. */
6750 glyphless_method
= Qempty_box
;
6752 if (EQ (glyphless_method
, Qthin_space
))
6753 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6754 else if (EQ (glyphless_method
, Qempty_box
))
6755 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6756 else if (EQ (glyphless_method
, Qhex_code
))
6757 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6758 else if (STRINGP (glyphless_method
))
6759 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6762 /* Invalid value. We use the default method. */
6763 glyphless_method
= Qnil
;
6766 it
->what
= IT_GLYPHLESS
;
6767 return glyphless_method
;
6770 /* Merge escape glyph face and cache the result. */
6772 static struct frame
*last_escape_glyph_frame
= NULL
;
6773 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6774 static int last_escape_glyph_merged_face_id
= 0;
6777 merge_escape_glyph_face (struct it
*it
)
6781 if (it
->f
== last_escape_glyph_frame
6782 && it
->face_id
== last_escape_glyph_face_id
)
6783 face_id
= last_escape_glyph_merged_face_id
;
6786 /* Merge the `escape-glyph' face into the current face. */
6787 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6788 last_escape_glyph_frame
= it
->f
;
6789 last_escape_glyph_face_id
= it
->face_id
;
6790 last_escape_glyph_merged_face_id
= face_id
;
6795 /* Likewise for glyphless glyph face. */
6797 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6798 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6799 static int last_glyphless_glyph_merged_face_id
= 0;
6802 merge_glyphless_glyph_face (struct it
*it
)
6806 if (it
->f
== last_glyphless_glyph_frame
6807 && it
->face_id
== last_glyphless_glyph_face_id
)
6808 face_id
= last_glyphless_glyph_merged_face_id
;
6811 /* Merge the `glyphless-char' face into the current face. */
6812 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6813 last_glyphless_glyph_frame
= it
->f
;
6814 last_glyphless_glyph_face_id
= it
->face_id
;
6815 last_glyphless_glyph_merged_face_id
= face_id
;
6820 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6821 be called before redisplaying windows, and when the frame's face
6824 forget_escape_and_glyphless_faces (void)
6826 last_escape_glyph_frame
= NULL
;
6827 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6828 last_glyphless_glyph_frame
= NULL
;
6829 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6832 /* Load IT's display element fields with information about the next
6833 display element from the current position of IT. Value is false if
6834 end of buffer (or C string) is reached. */
6837 get_next_display_element (struct it
*it
)
6839 /* True means that we found a display element. False means that
6840 we hit the end of what we iterate over. Performance note: the
6841 function pointer `method' used here turns out to be faster than
6842 using a sequence of if-statements. */
6846 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6848 if (it
->what
== IT_CHARACTER
)
6850 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6851 and only if (a) the resolved directionality of that character
6853 /* FIXME: Do we need an exception for characters from display
6855 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6856 && !inhibit_bidi_mirroring
)
6857 it
->c
= bidi_mirror_char (it
->c
);
6858 /* Map via display table or translate control characters.
6859 IT->c, IT->len etc. have been set to the next character by
6860 the function call above. If we have a display table, and it
6861 contains an entry for IT->c, translate it. Don't do this if
6862 IT->c itself comes from a display table, otherwise we could
6863 end up in an infinite recursion. (An alternative could be to
6864 count the recursion depth of this function and signal an
6865 error when a certain maximum depth is reached.) Is it worth
6867 if (success_p
&& it
->dpvec
== NULL
)
6870 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6871 bool nonascii_space_p
= false;
6872 bool nonascii_hyphen_p
= false;
6873 int c
= it
->c
; /* This is the character to display. */
6875 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6877 eassert (SINGLE_BYTE_CHAR_P (c
));
6878 if (unibyte_display_via_language_environment
)
6880 c
= DECODE_CHAR (unibyte
, c
);
6882 c
= BYTE8_TO_CHAR (it
->c
);
6885 c
= BYTE8_TO_CHAR (it
->c
);
6889 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6892 struct Lisp_Vector
*v
= XVECTOR (dv
);
6894 /* Return the first character from the display table
6895 entry, if not empty. If empty, don't display the
6896 current character. */
6899 it
->dpvec_char_len
= it
->len
;
6900 it
->dpvec
= v
->contents
;
6901 it
->dpend
= v
->contents
+ v
->header
.size
;
6902 it
->current
.dpvec_index
= 0;
6903 it
->dpvec_face_id
= -1;
6904 it
->saved_face_id
= it
->face_id
;
6905 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6906 it
->ellipsis_p
= false;
6910 set_iterator_to_next (it
, false);
6915 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6917 if (it
->what
== IT_GLYPHLESS
)
6919 /* Don't display this character. */
6920 set_iterator_to_next (it
, false);
6924 /* If `nobreak-char-display' is non-nil, we display
6925 non-ASCII spaces and hyphens specially. */
6926 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6928 if (c
== NO_BREAK_SPACE
)
6929 nonascii_space_p
= true;
6930 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6931 || c
== NON_BREAKING_HYPHEN
)
6932 nonascii_hyphen_p
= true;
6935 /* Translate control characters into `\003' or `^C' form.
6936 Control characters coming from a display table entry are
6937 currently not translated because we use IT->dpvec to hold
6938 the translation. This could easily be changed but I
6939 don't believe that it is worth doing.
6941 The characters handled by `nobreak-char-display' must be
6944 Non-printable characters and raw-byte characters are also
6945 translated to octal form. */
6946 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6947 ? (it
->area
!= TEXT_AREA
6948 /* In mode line, treat \n, \t like other crl chars. */
6951 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6952 || (c
!= '\n' && c
!= '\t'))
6954 || nonascii_hyphen_p
6956 || ! CHAR_PRINTABLE_P (c
))))
6958 /* C is a control character, non-ASCII space/hyphen,
6959 raw-byte, or a non-printable character which must be
6960 displayed either as '\003' or as `^C' where the '\\'
6961 and '^' can be defined in the display table. Fill
6962 IT->ctl_chars with glyphs for what we have to
6963 display. Then, set IT->dpvec to these glyphs. */
6970 /* Handle control characters with ^. */
6972 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6976 g
= '^'; /* default glyph for Control */
6977 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6979 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6981 g
= 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 XSETINT (it
->ctl_chars
[0], g
);
6990 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6992 goto display_control
;
6995 /* Handle non-ascii space in the mode where it only gets
6998 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7000 /* Merge `nobreak-space' into the current face. */
7001 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7003 XSETINT (it
->ctl_chars
[0], ' ');
7005 goto display_control
;
7008 /* Handle sequences that start with the "escape glyph". */
7010 /* the default escape glyph is \. */
7011 escape_glyph
= '\\';
7014 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7016 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7017 lface_id
= GLYPH_CODE_FACE (gc
);
7021 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7022 : merge_escape_glyph_face (it
));
7024 /* Draw non-ASCII hyphen with just highlighting: */
7026 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7028 XSETINT (it
->ctl_chars
[0], '-');
7030 goto display_control
;
7033 /* Draw non-ASCII space/hyphen with escape glyph: */
7035 if (nonascii_space_p
|| nonascii_hyphen_p
)
7037 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7038 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7040 goto display_control
;
7047 if (CHAR_BYTE8_P (c
))
7048 /* Display \200 instead of \17777600. */
7049 c
= CHAR_TO_BYTE8 (c
);
7050 len
= sprintf (str
, "%03o", c
+ 0u);
7052 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7053 for (i
= 0; i
< len
; i
++)
7054 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7059 /* Set up IT->dpvec and return first character from it. */
7060 it
->dpvec_char_len
= it
->len
;
7061 it
->dpvec
= it
->ctl_chars
;
7062 it
->dpend
= it
->dpvec
+ ctl_len
;
7063 it
->current
.dpvec_index
= 0;
7064 it
->dpvec_face_id
= face_id
;
7065 it
->saved_face_id
= it
->face_id
;
7066 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7067 it
->ellipsis_p
= false;
7070 it
->char_to_display
= c
;
7074 it
->char_to_display
= it
->c
;
7078 #ifdef HAVE_WINDOW_SYSTEM
7079 /* Adjust face id for a multibyte character. There are no multibyte
7080 character in unibyte text. */
7081 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7084 && FRAME_WINDOW_P (it
->f
))
7086 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7088 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7090 /* Automatic composition with glyph-string. */
7091 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7093 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7097 ptrdiff_t pos
= (it
->s
? -1
7098 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7099 : IT_CHARPOS (*it
));
7102 if (it
->what
== IT_CHARACTER
)
7103 c
= it
->char_to_display
;
7106 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7110 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7111 /* TAB in a composition means display glyphs with
7112 padding space on the left or right. */
7113 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7116 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7119 #endif /* HAVE_WINDOW_SYSTEM */
7122 /* Is this character the last one of a run of characters with
7123 box? If yes, set IT->end_of_box_run_p to true. */
7127 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7129 int face_id
= underlying_face_id (it
);
7130 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7134 if (face
->box
== FACE_NO_BOX
)
7136 /* If the box comes from face properties in a
7137 display string, check faces in that string. */
7138 int string_face_id
= face_after_it_pos (it
);
7139 it
->end_of_box_run_p
7140 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7143 /* Otherwise, the box comes from the underlying face.
7144 If this is the last string character displayed, check
7145 the next buffer location. */
7146 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7147 /* n_overlay_strings is unreliable unless
7148 overlay_string_index is non-negative. */
7149 && ((it
->current
.overlay_string_index
>= 0
7150 && (it
->current
.overlay_string_index
7151 == it
->n_overlay_strings
- 1))
7152 /* A string from display property. */
7153 || it
->from_disp_prop_p
))
7157 struct text_pos pos
= it
->current
.pos
;
7159 /* For a string from a display property, the next
7160 buffer position is stored in the 'position'
7161 member of the iteration stack slot below the
7162 current one, see handle_single_display_spec. By
7163 contrast, it->current.pos was is not yet updated
7164 to point to that buffer position; that will
7165 happen in pop_it, after we finish displaying the
7166 current string. Note that we already checked
7167 above that it->sp is positive, so subtracting one
7169 if (it
->from_disp_prop_p
)
7170 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7172 INC_TEXT_POS (pos
, it
->multibyte_p
);
7174 if (CHARPOS (pos
) >= ZV
)
7175 it
->end_of_box_run_p
= true;
7178 next_face_id
= face_at_buffer_position
7179 (it
->w
, CHARPOS (pos
), &ignore
,
7180 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7181 it
->end_of_box_run_p
7182 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7188 /* next_element_from_display_vector sets this flag according to
7189 faces of the display vector glyphs, see there. */
7190 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7192 int face_id
= face_after_it_pos (it
);
7193 it
->end_of_box_run_p
7194 = (face_id
!= it
->face_id
7195 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7198 /* If we reached the end of the object we've been iterating (e.g., a
7199 display string or an overlay string), and there's something on
7200 IT->stack, proceed with what's on the stack. It doesn't make
7201 sense to return false if there's unprocessed stuff on the stack,
7202 because otherwise that stuff will never be displayed. */
7203 if (!success_p
&& it
->sp
> 0)
7205 set_iterator_to_next (it
, false);
7206 success_p
= get_next_display_element (it
);
7209 /* Value is false if end of buffer or string reached. */
7214 /* Move IT to the next display element.
7216 RESEAT_P means if called on a newline in buffer text,
7217 skip to the next visible line start.
7219 Functions get_next_display_element and set_iterator_to_next are
7220 separate because I find this arrangement easier to handle than a
7221 get_next_display_element function that also increments IT's
7222 position. The way it is we can first look at an iterator's current
7223 display element, decide whether it fits on a line, and if it does,
7224 increment the iterator position. The other way around we probably
7225 would either need a flag indicating whether the iterator has to be
7226 incremented the next time, or we would have to implement a
7227 decrement position function which would not be easy to write. */
7230 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7232 /* Reset flags indicating start and end of a sequence of characters
7233 with box. Reset them at the start of this function because
7234 moving the iterator to a new position might set them. */
7235 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7239 case GET_FROM_BUFFER
:
7240 /* The current display element of IT is a character from
7241 current_buffer. Advance in the buffer, and maybe skip over
7242 invisible lines that are so because of selective display. */
7243 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7244 reseat_at_next_visible_line_start (it
, false);
7245 else if (it
->cmp_it
.id
>= 0)
7247 /* We are currently getting glyphs from a composition. */
7250 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7251 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7257 /* Update IT's char/byte positions to point to the first
7258 character of the next grapheme cluster, or to the
7259 character visually after the current composition. */
7260 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7261 bidi_move_to_visually_next (&it
->bidi_it
);
7262 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7263 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7266 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7267 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7269 /* Composition created while scanning forward. Proceed
7270 to the next grapheme cluster. */
7271 it
->cmp_it
.from
= it
->cmp_it
.to
;
7273 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7274 && it
->cmp_it
.from
> 0)
7276 /* Composition created while scanning backward. Proceed
7277 to the previous grapheme cluster. */
7278 it
->cmp_it
.to
= it
->cmp_it
.from
;
7282 /* No more grapheme clusters in this composition.
7283 Find the next stop position. */
7284 ptrdiff_t stop
= it
->end_charpos
;
7286 if (it
->bidi_it
.scan_dir
< 0)
7287 /* Now we are scanning backward and don't know
7290 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7291 IT_BYTEPOS (*it
), stop
, Qnil
);
7296 eassert (it
->len
!= 0);
7300 IT_BYTEPOS (*it
) += it
->len
;
7301 IT_CHARPOS (*it
) += 1;
7305 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7306 /* If this is a new paragraph, determine its base
7307 direction (a.k.a. its base embedding level). */
7308 if (it
->bidi_it
.new_paragraph
)
7309 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7311 bidi_move_to_visually_next (&it
->bidi_it
);
7312 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7313 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7314 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7316 /* As the scan direction was changed, we must
7317 re-compute the stop position for composition. */
7318 ptrdiff_t stop
= it
->end_charpos
;
7319 if (it
->bidi_it
.scan_dir
< 0)
7321 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7322 IT_BYTEPOS (*it
), stop
, Qnil
);
7325 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7329 case GET_FROM_C_STRING
:
7330 /* Current display element of IT is from a C string. */
7332 /* If the string position is beyond string's end, it means
7333 next_element_from_c_string is padding the string with
7334 blanks, in which case we bypass the bidi iterator,
7335 because it cannot deal with such virtual characters. */
7336 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7338 IT_BYTEPOS (*it
) += it
->len
;
7339 IT_CHARPOS (*it
) += 1;
7343 bidi_move_to_visually_next (&it
->bidi_it
);
7344 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7345 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7349 case GET_FROM_DISPLAY_VECTOR
:
7350 /* Current display element of IT is from a display table entry.
7351 Advance in the display table definition. Reset it to null if
7352 end reached, and continue with characters from buffers/
7354 ++it
->current
.dpvec_index
;
7356 /* Restore face of the iterator to what they were before the
7357 display vector entry (these entries may contain faces). */
7358 it
->face_id
= it
->saved_face_id
;
7360 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7362 bool recheck_faces
= it
->ellipsis_p
;
7365 it
->method
= GET_FROM_C_STRING
;
7366 else if (STRINGP (it
->string
))
7367 it
->method
= GET_FROM_STRING
;
7370 it
->method
= GET_FROM_BUFFER
;
7371 it
->object
= it
->w
->contents
;
7375 it
->current
.dpvec_index
= -1;
7377 /* Skip over characters which were displayed via IT->dpvec. */
7378 if (it
->dpvec_char_len
< 0)
7379 reseat_at_next_visible_line_start (it
, true);
7380 else if (it
->dpvec_char_len
> 0)
7382 it
->len
= it
->dpvec_char_len
;
7383 set_iterator_to_next (it
, reseat_p
);
7386 /* Maybe recheck faces after display vector. */
7389 if (it
->method
== GET_FROM_STRING
)
7390 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7392 it
->stop_charpos
= IT_CHARPOS (*it
);
7397 case GET_FROM_STRING
:
7398 /* Current display element is a character from a Lisp string. */
7399 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7400 /* Don't advance past string end. These conditions are true
7401 when set_iterator_to_next is called at the end of
7402 get_next_display_element, in which case the Lisp string is
7403 already exhausted, and all we want is pop the iterator
7405 if (it
->current
.overlay_string_index
>= 0)
7407 /* This is an overlay string, so there's no padding with
7408 spaces, and the number of characters in the string is
7409 where the string ends. */
7410 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7411 goto consider_string_end
;
7415 /* Not an overlay string. There could be padding, so test
7416 against it->end_charpos. */
7417 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7418 goto consider_string_end
;
7420 if (it
->cmp_it
.id
>= 0)
7422 /* We are delivering display elements from a composition.
7423 Update the string position past the grapheme cluster
7424 we've just processed. */
7427 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7428 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7434 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7435 bidi_move_to_visually_next (&it
->bidi_it
);
7436 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7437 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7440 /* Did we exhaust all the grapheme clusters of this
7442 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7443 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7445 /* Not all the grapheme clusters were processed yet;
7446 advance to the next cluster. */
7447 it
->cmp_it
.from
= it
->cmp_it
.to
;
7449 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7450 && it
->cmp_it
.from
> 0)
7452 /* Likewise: advance to the next cluster, but going in
7453 the reverse direction. */
7454 it
->cmp_it
.to
= it
->cmp_it
.from
;
7458 /* This composition was fully processed; find the next
7459 candidate place for checking for composed
7461 /* Always limit string searches to the string length;
7462 any padding spaces are not part of the string, and
7463 there cannot be any compositions in that padding. */
7464 ptrdiff_t stop
= SCHARS (it
->string
);
7466 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7468 else if (it
->end_charpos
< stop
)
7470 /* Cf. PRECISION in reseat_to_string: we might be
7471 limited in how many of the string characters we
7473 stop
= it
->end_charpos
;
7475 composition_compute_stop_pos (&it
->cmp_it
,
7476 IT_STRING_CHARPOS (*it
),
7477 IT_STRING_BYTEPOS (*it
), stop
,
7484 /* If the string position is beyond string's end, it
7485 means next_element_from_string is padding the string
7486 with blanks, in which case we bypass the bidi
7487 iterator, because it cannot deal with such virtual
7489 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7491 IT_STRING_BYTEPOS (*it
) += it
->len
;
7492 IT_STRING_CHARPOS (*it
) += 1;
7496 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7498 bidi_move_to_visually_next (&it
->bidi_it
);
7499 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7500 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7501 /* If the scan direction changes, we may need to update
7502 the place where to check for composed characters. */
7503 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7505 ptrdiff_t stop
= SCHARS (it
->string
);
7507 if (it
->bidi_it
.scan_dir
< 0)
7509 else if (it
->end_charpos
< stop
)
7510 stop
= it
->end_charpos
;
7512 composition_compute_stop_pos (&it
->cmp_it
,
7513 IT_STRING_CHARPOS (*it
),
7514 IT_STRING_BYTEPOS (*it
), stop
,
7520 consider_string_end
:
7522 if (it
->current
.overlay_string_index
>= 0)
7524 /* IT->string is an overlay string. Advance to the
7525 next, if there is one. */
7526 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7528 it
->ellipsis_p
= false;
7529 next_overlay_string (it
);
7531 setup_for_ellipsis (it
, 0);
7536 /* IT->string is not an overlay string. If we reached
7537 its end, and there is something on IT->stack, proceed
7538 with what is on the stack. This can be either another
7539 string, this time an overlay string, or a buffer. */
7540 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7544 if (it
->method
== GET_FROM_STRING
)
7545 goto consider_string_end
;
7550 case GET_FROM_IMAGE
:
7551 case GET_FROM_STRETCH
:
7552 /* The position etc with which we have to proceed are on
7553 the stack. The position may be at the end of a string,
7554 if the `display' property takes up the whole string. */
7555 eassert (it
->sp
> 0);
7557 if (it
->method
== GET_FROM_STRING
)
7558 goto consider_string_end
;
7562 /* There are no other methods defined, so this should be a bug. */
7566 eassert (it
->method
!= GET_FROM_STRING
7567 || (STRINGP (it
->string
)
7568 && IT_STRING_CHARPOS (*it
) >= 0));
7571 /* Load IT's display element fields with information about the next
7572 display element which comes from a display table entry or from the
7573 result of translating a control character to one of the forms `^C'
7576 IT->dpvec holds the glyphs to return as characters.
7577 IT->saved_face_id holds the face id before the display vector--it
7578 is restored into IT->face_id in set_iterator_to_next. */
7581 next_element_from_display_vector (struct it
*it
)
7584 int prev_face_id
= it
->face_id
;
7588 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7590 it
->face_id
= it
->saved_face_id
;
7592 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7593 That seemed totally bogus - so I changed it... */
7594 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7596 if (GLYPH_CODE_P (gc
))
7598 struct face
*this_face
, *prev_face
, *next_face
;
7600 it
->c
= GLYPH_CODE_CHAR (gc
);
7601 it
->len
= CHAR_BYTES (it
->c
);
7603 /* The entry may contain a face id to use. Such a face id is
7604 the id of a Lisp face, not a realized face. A face id of
7605 zero means no face is specified. */
7606 if (it
->dpvec_face_id
>= 0)
7607 it
->face_id
= it
->dpvec_face_id
;
7610 int lface_id
= GLYPH_CODE_FACE (gc
);
7612 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7616 /* Glyphs in the display vector could have the box face, so we
7617 need to set the related flags in the iterator, as
7619 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7620 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7622 /* Is this character the first character of a box-face run? */
7623 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7625 || prev_face
->box
== FACE_NO_BOX
));
7627 /* For the last character of the box-face run, we need to look
7628 either at the next glyph from the display vector, or at the
7629 face we saw before the display vector. */
7630 next_face_id
= it
->saved_face_id
;
7631 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7633 if (it
->dpvec_face_id
>= 0)
7634 next_face_id
= it
->dpvec_face_id
;
7638 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7641 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7645 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7646 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7648 || next_face
->box
== FACE_NO_BOX
));
7649 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7652 /* Display table entry is invalid. Return a space. */
7653 it
->c
= ' ', it
->len
= 1;
7655 /* Don't change position and object of the iterator here. They are
7656 still the values of the character that had this display table
7657 entry or was translated, and that's what we want. */
7658 it
->what
= IT_CHARACTER
;
7662 /* Get the first element of string/buffer in the visual order, after
7663 being reseated to a new position in a string or a buffer. */
7665 get_visually_first_element (struct it
*it
)
7667 bool string_p
= STRINGP (it
->string
) || it
->s
;
7668 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7669 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7671 if (STRINGP (it
->string
))
7673 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7674 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7678 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7679 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7682 if (it
->bidi_it
.charpos
== eob
)
7684 /* Nothing to do, but reset the FIRST_ELT flag, like
7685 bidi_paragraph_init does, because we are not going to
7687 it
->bidi_it
.first_elt
= false;
7689 else if (it
->bidi_it
.charpos
== bob
7691 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7692 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7694 /* If we are at the beginning of a line/string, we can produce
7695 the next element right away. */
7696 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7697 bidi_move_to_visually_next (&it
->bidi_it
);
7701 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7703 /* We need to prime the bidi iterator starting at the line's or
7704 string's beginning, before we will be able to produce the
7707 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7709 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7710 IT_BYTEPOS (*it
), -1,
7711 &it
->bidi_it
.bytepos
);
7712 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7715 /* Now return to buffer/string position where we were asked
7716 to get the next display element, and produce that. */
7717 bidi_move_to_visually_next (&it
->bidi_it
);
7719 while (it
->bidi_it
.bytepos
!= orig_bytepos
7720 && it
->bidi_it
.charpos
< eob
);
7723 /* Adjust IT's position information to where we ended up. */
7724 if (STRINGP (it
->string
))
7726 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7727 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7731 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7732 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7735 if (STRINGP (it
->string
) || !it
->s
)
7737 ptrdiff_t stop
, charpos
, bytepos
;
7739 if (STRINGP (it
->string
))
7742 stop
= SCHARS (it
->string
);
7743 if (stop
> it
->end_charpos
)
7744 stop
= it
->end_charpos
;
7745 charpos
= IT_STRING_CHARPOS (*it
);
7746 bytepos
= IT_STRING_BYTEPOS (*it
);
7750 stop
= it
->end_charpos
;
7751 charpos
= IT_CHARPOS (*it
);
7752 bytepos
= IT_BYTEPOS (*it
);
7754 if (it
->bidi_it
.scan_dir
< 0)
7756 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7761 /* Load IT with the next display element from Lisp string IT->string.
7762 IT->current.string_pos is the current position within the string.
7763 If IT->current.overlay_string_index >= 0, the Lisp string is an
7767 next_element_from_string (struct it
*it
)
7769 struct text_pos position
;
7771 eassert (STRINGP (it
->string
));
7772 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7773 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7774 position
= it
->current
.string_pos
;
7776 /* With bidi reordering, the character to display might not be the
7777 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7778 that we were reseat()ed to a new string, whose paragraph
7779 direction is not known. */
7780 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7782 get_visually_first_element (it
);
7783 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7786 /* Time to check for invisible text? */
7787 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7789 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7792 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7793 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7795 /* With bidi non-linear iteration, we could find
7796 ourselves far beyond the last computed stop_charpos,
7797 with several other stop positions in between that we
7798 missed. Scan them all now, in buffer's logical
7799 order, until we find and handle the last stop_charpos
7800 that precedes our current position. */
7801 handle_stop_backwards (it
, it
->stop_charpos
);
7802 return GET_NEXT_DISPLAY_ELEMENT (it
);
7808 /* Take note of the stop position we just moved
7809 across, for when we will move back across it. */
7810 it
->prev_stop
= it
->stop_charpos
;
7811 /* If we are at base paragraph embedding level, take
7812 note of the last stop position seen at this
7814 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7815 it
->base_level_stop
= it
->stop_charpos
;
7819 /* Since a handler may have changed IT->method, we must
7821 return GET_NEXT_DISPLAY_ELEMENT (it
);
7825 /* If we are before prev_stop, we may have overstepped
7826 on our way backwards a stop_pos, and if so, we need
7827 to handle that stop_pos. */
7828 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7829 /* We can sometimes back up for reasons that have nothing
7830 to do with bidi reordering. E.g., compositions. The
7831 code below is only needed when we are above the base
7832 embedding level, so test for that explicitly. */
7833 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7835 /* If we lost track of base_level_stop, we have no better
7836 place for handle_stop_backwards to start from than string
7837 beginning. This happens, e.g., when we were reseated to
7838 the previous screenful of text by vertical-motion. */
7839 if (it
->base_level_stop
<= 0
7840 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7841 it
->base_level_stop
= 0;
7842 handle_stop_backwards (it
, it
->base_level_stop
);
7843 return GET_NEXT_DISPLAY_ELEMENT (it
);
7847 if (it
->current
.overlay_string_index
>= 0)
7849 /* Get the next character from an overlay string. In overlay
7850 strings, there is no field width or padding with spaces to
7852 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7857 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7858 IT_STRING_BYTEPOS (*it
),
7859 it
->bidi_it
.scan_dir
< 0
7861 : SCHARS (it
->string
))
7862 && next_element_from_composition (it
))
7866 else if (STRING_MULTIBYTE (it
->string
))
7868 const unsigned char *s
= (SDATA (it
->string
)
7869 + IT_STRING_BYTEPOS (*it
));
7870 it
->c
= string_char_and_length (s
, &it
->len
);
7874 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7880 /* Get the next character from a Lisp string that is not an
7881 overlay string. Such strings come from the mode line, for
7882 example. We may have to pad with spaces, or truncate the
7883 string. See also next_element_from_c_string. */
7884 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7889 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7891 /* Pad with spaces. */
7892 it
->c
= ' ', it
->len
= 1;
7893 CHARPOS (position
) = BYTEPOS (position
) = -1;
7895 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7896 IT_STRING_BYTEPOS (*it
),
7897 it
->bidi_it
.scan_dir
< 0
7899 : it
->string_nchars
)
7900 && next_element_from_composition (it
))
7904 else if (STRING_MULTIBYTE (it
->string
))
7906 const unsigned char *s
= (SDATA (it
->string
)
7907 + IT_STRING_BYTEPOS (*it
));
7908 it
->c
= string_char_and_length (s
, &it
->len
);
7912 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7917 /* Record what we have and where it came from. */
7918 it
->what
= IT_CHARACTER
;
7919 it
->object
= it
->string
;
7920 it
->position
= position
;
7925 /* Load IT with next display element from C string IT->s.
7926 IT->string_nchars is the maximum number of characters to return
7927 from the string. IT->end_charpos may be greater than
7928 IT->string_nchars when this function is called, in which case we
7929 may have to return padding spaces. Value is false if end of string
7930 reached, including padding spaces. */
7933 next_element_from_c_string (struct it
*it
)
7935 bool success_p
= true;
7938 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7939 it
->what
= IT_CHARACTER
;
7940 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7941 it
->object
= make_number (0);
7943 /* With bidi reordering, the character to display might not be the
7944 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7945 we were reseated to a new string, whose paragraph direction is
7947 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7948 get_visually_first_element (it
);
7950 /* IT's position can be greater than IT->string_nchars in case a
7951 field width or precision has been specified when the iterator was
7953 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7955 /* End of the game. */
7959 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7961 /* Pad with spaces. */
7962 it
->c
= ' ', it
->len
= 1;
7963 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7965 else if (it
->multibyte_p
)
7966 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7968 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7974 /* Set up IT to return characters from an ellipsis, if appropriate.
7975 The definition of the ellipsis glyphs may come from a display table
7976 entry. This function fills IT with the first glyph from the
7977 ellipsis if an ellipsis is to be displayed. */
7980 next_element_from_ellipsis (struct it
*it
)
7982 if (it
->selective_display_ellipsis_p
)
7983 setup_for_ellipsis (it
, it
->len
);
7986 /* The face at the current position may be different from the
7987 face we find after the invisible text. Remember what it
7988 was in IT->saved_face_id, and signal that it's there by
7989 setting face_before_selective_p. */
7990 it
->saved_face_id
= it
->face_id
;
7991 it
->method
= GET_FROM_BUFFER
;
7992 it
->object
= it
->w
->contents
;
7993 reseat_at_next_visible_line_start (it
, true);
7994 it
->face_before_selective_p
= true;
7997 return GET_NEXT_DISPLAY_ELEMENT (it
);
8001 /* Deliver an image display element. The iterator IT is already
8002 filled with image information (done in handle_display_prop). Value
8007 next_element_from_image (struct it
*it
)
8009 it
->what
= IT_IMAGE
;
8014 /* Fill iterator IT with next display element from a stretch glyph
8015 property. IT->object is the value of the text property. Value is
8019 next_element_from_stretch (struct it
*it
)
8021 it
->what
= IT_STRETCH
;
8025 /* Scan backwards from IT's current position until we find a stop
8026 position, or until BEGV. This is called when we find ourself
8027 before both the last known prev_stop and base_level_stop while
8028 reordering bidirectional text. */
8031 compute_stop_pos_backwards (struct it
*it
)
8033 const int SCAN_BACK_LIMIT
= 1000;
8034 struct text_pos pos
;
8035 struct display_pos save_current
= it
->current
;
8036 struct text_pos save_position
= it
->position
;
8037 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8038 ptrdiff_t where_we_are
= charpos
;
8039 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8040 ptrdiff_t save_end_pos
= it
->end_charpos
;
8042 eassert (NILP (it
->string
) && !it
->s
);
8043 eassert (it
->bidi_p
);
8047 it
->end_charpos
= min (charpos
+ 1, ZV
);
8048 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8049 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8050 reseat_1 (it
, pos
, false);
8051 compute_stop_pos (it
);
8052 /* We must advance forward, right? */
8053 if (it
->stop_charpos
<= charpos
)
8056 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8058 if (it
->stop_charpos
<= where_we_are
)
8059 it
->prev_stop
= it
->stop_charpos
;
8061 it
->prev_stop
= BEGV
;
8063 it
->current
= save_current
;
8064 it
->position
= save_position
;
8065 it
->stop_charpos
= save_stop_pos
;
8066 it
->end_charpos
= save_end_pos
;
8069 /* Scan forward from CHARPOS in the current buffer/string, until we
8070 find a stop position > current IT's position. Then handle the stop
8071 position before that. This is called when we bump into a stop
8072 position while reordering bidirectional text. CHARPOS should be
8073 the last previously processed stop_pos (or BEGV/0, if none were
8074 processed yet) whose position is less that IT's current
8078 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8080 bool bufp
= !STRINGP (it
->string
);
8081 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8082 struct display_pos save_current
= it
->current
;
8083 struct text_pos save_position
= it
->position
;
8084 struct text_pos pos1
;
8085 ptrdiff_t next_stop
;
8087 /* Scan in strict logical order. */
8088 eassert (it
->bidi_p
);
8092 it
->prev_stop
= charpos
;
8095 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8096 reseat_1 (it
, pos1
, false);
8099 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8100 compute_stop_pos (it
);
8101 /* We must advance forward, right? */
8102 if (it
->stop_charpos
<= it
->prev_stop
)
8104 charpos
= it
->stop_charpos
;
8106 while (charpos
<= where_we_are
);
8109 it
->current
= save_current
;
8110 it
->position
= save_position
;
8111 next_stop
= it
->stop_charpos
;
8112 it
->stop_charpos
= it
->prev_stop
;
8114 it
->stop_charpos
= next_stop
;
8117 /* Load IT with the next display element from current_buffer. Value
8118 is false if end of buffer reached. IT->stop_charpos is the next
8119 position at which to stop and check for text properties or buffer
8123 next_element_from_buffer (struct it
*it
)
8125 bool success_p
= true;
8127 eassert (IT_CHARPOS (*it
) >= BEGV
);
8128 eassert (NILP (it
->string
) && !it
->s
);
8129 eassert (!it
->bidi_p
8130 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8131 && it
->bidi_it
.string
.s
== NULL
));
8133 /* With bidi reordering, the character to display might not be the
8134 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8135 we were reseat()ed to a new buffer position, which is potentially
8136 a different paragraph. */
8137 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8139 get_visually_first_element (it
);
8140 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8143 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8145 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8147 bool overlay_strings_follow_p
;
8149 /* End of the game, except when overlay strings follow that
8150 haven't been returned yet. */
8151 if (it
->overlay_strings_at_end_processed_p
)
8152 overlay_strings_follow_p
= false;
8155 it
->overlay_strings_at_end_processed_p
= true;
8156 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8159 if (overlay_strings_follow_p
)
8160 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8164 it
->position
= it
->current
.pos
;
8168 else if (!(!it
->bidi_p
8169 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8170 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8172 /* With bidi non-linear iteration, we could find ourselves
8173 far beyond the last computed stop_charpos, with several
8174 other stop positions in between that we missed. Scan
8175 them all now, in buffer's logical order, until we find
8176 and handle the last stop_charpos that precedes our
8177 current position. */
8178 handle_stop_backwards (it
, it
->stop_charpos
);
8179 it
->ignore_overlay_strings_at_pos_p
= false;
8180 return GET_NEXT_DISPLAY_ELEMENT (it
);
8186 /* Take note of the stop position we just moved across,
8187 for when we will move back across it. */
8188 it
->prev_stop
= it
->stop_charpos
;
8189 /* If we are at base paragraph embedding level, take
8190 note of the last stop position seen at this
8192 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8193 it
->base_level_stop
= it
->stop_charpos
;
8196 it
->ignore_overlay_strings_at_pos_p
= false;
8197 return GET_NEXT_DISPLAY_ELEMENT (it
);
8201 /* If we are before prev_stop, we may have overstepped on
8202 our way backwards a stop_pos, and if so, we need to
8203 handle that stop_pos. */
8204 && IT_CHARPOS (*it
) < it
->prev_stop
8205 /* We can sometimes back up for reasons that have nothing
8206 to do with bidi reordering. E.g., compositions. The
8207 code below is only needed when we are above the base
8208 embedding level, so test for that explicitly. */
8209 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8211 if (it
->base_level_stop
<= 0
8212 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8214 /* If we lost track of base_level_stop, we need to find
8215 prev_stop by looking backwards. This happens, e.g., when
8216 we were reseated to the previous screenful of text by
8218 it
->base_level_stop
= BEGV
;
8219 compute_stop_pos_backwards (it
);
8220 handle_stop_backwards (it
, it
->prev_stop
);
8223 handle_stop_backwards (it
, it
->base_level_stop
);
8224 it
->ignore_overlay_strings_at_pos_p
= false;
8225 return GET_NEXT_DISPLAY_ELEMENT (it
);
8229 /* No face changes, overlays etc. in sight, so just return a
8230 character from current_buffer. */
8234 /* We moved to the next buffer position, so any info about
8235 previously seen overlays is no longer valid. */
8236 it
->ignore_overlay_strings_at_pos_p
= false;
8238 /* Maybe run the redisplay end trigger hook. Performance note:
8239 This doesn't seem to cost measurable time. */
8240 if (it
->redisplay_end_trigger_charpos
8242 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8243 run_redisplay_end_trigger_hook (it
);
8245 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8246 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8248 && next_element_from_composition (it
))
8253 /* Get the next character, maybe multibyte. */
8254 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8255 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8256 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8258 it
->c
= *p
, it
->len
= 1;
8260 /* Record what we have and where it came from. */
8261 it
->what
= IT_CHARACTER
;
8262 it
->object
= it
->w
->contents
;
8263 it
->position
= it
->current
.pos
;
8265 /* Normally we return the character found above, except when we
8266 really want to return an ellipsis for selective display. */
8271 /* A value of selective > 0 means hide lines indented more
8272 than that number of columns. */
8273 if (it
->selective
> 0
8274 && IT_CHARPOS (*it
) + 1 < ZV
8275 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8276 IT_BYTEPOS (*it
) + 1,
8279 success_p
= next_element_from_ellipsis (it
);
8280 it
->dpvec_char_len
= -1;
8283 else if (it
->c
== '\r' && it
->selective
== -1)
8285 /* A value of selective == -1 means that everything from the
8286 CR to the end of the line is invisible, with maybe an
8287 ellipsis displayed for it. */
8288 success_p
= next_element_from_ellipsis (it
);
8289 it
->dpvec_char_len
= -1;
8294 /* Value is false if end of buffer reached. */
8295 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8300 /* Run the redisplay end trigger hook for IT. */
8303 run_redisplay_end_trigger_hook (struct it
*it
)
8305 /* IT->glyph_row should be non-null, i.e. we should be actually
8306 displaying something, or otherwise we should not run the hook. */
8307 eassert (it
->glyph_row
);
8309 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8310 it
->redisplay_end_trigger_charpos
= 0;
8312 /* Since we are *trying* to run these functions, don't try to run
8313 them again, even if they get an error. */
8314 wset_redisplay_end_trigger (it
->w
, Qnil
);
8315 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8316 make_number (charpos
));
8318 /* Notice if it changed the face of the character we are on. */
8319 handle_face_prop (it
);
8323 /* Deliver a composition display element. Unlike the other
8324 next_element_from_XXX, this function is not registered in the array
8325 get_next_element[]. It is called from next_element_from_buffer and
8326 next_element_from_string when necessary. */
8329 next_element_from_composition (struct it
*it
)
8331 it
->what
= IT_COMPOSITION
;
8332 it
->len
= it
->cmp_it
.nbytes
;
8333 if (STRINGP (it
->string
))
8337 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8338 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8341 it
->position
= it
->current
.string_pos
;
8342 it
->object
= it
->string
;
8343 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8344 IT_STRING_BYTEPOS (*it
), it
->string
);
8350 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8351 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8354 if (it
->bidi_it
.new_paragraph
)
8355 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8357 /* Resync the bidi iterator with IT's new position.
8358 FIXME: this doesn't support bidirectional text. */
8359 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8360 bidi_move_to_visually_next (&it
->bidi_it
);
8364 it
->position
= it
->current
.pos
;
8365 it
->object
= it
->w
->contents
;
8366 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8367 IT_BYTEPOS (*it
), Qnil
);
8374 /***********************************************************************
8375 Moving an iterator without producing glyphs
8376 ***********************************************************************/
8378 /* Check if iterator is at a position corresponding to a valid buffer
8379 position after some move_it_ call. */
8381 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8382 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8385 /* Move iterator IT to a specified buffer or X position within one
8386 line on the display without producing glyphs.
8388 OP should be a bit mask including some or all of these bits:
8389 MOVE_TO_X: Stop upon reaching x-position TO_X.
8390 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8391 Regardless of OP's value, stop upon reaching the end of the display line.
8393 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8394 This means, in particular, that TO_X includes window's horizontal
8397 The return value has several possible values that
8398 say what condition caused the scan to stop:
8400 MOVE_POS_MATCH_OR_ZV
8401 - when TO_POS or ZV was reached.
8404 -when TO_X was reached before TO_POS or ZV were reached.
8407 - when we reached the end of the display area and the line must
8411 - when we reached the end of the display area and the line is
8415 - when we stopped at a line end, i.e. a newline or a CR and selective
8418 static enum move_it_result
8419 move_it_in_display_line_to (struct it
*it
,
8420 ptrdiff_t to_charpos
, int to_x
,
8421 enum move_operation_enum op
)
8423 enum move_it_result result
= MOVE_UNDEFINED
;
8424 struct glyph_row
*saved_glyph_row
;
8425 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8426 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8427 void *ppos_data
= NULL
;
8428 bool may_wrap
= false;
8429 enum it_method prev_method
= it
->method
;
8430 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8431 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8433 /* Don't produce glyphs in produce_glyphs. */
8434 saved_glyph_row
= it
->glyph_row
;
8435 it
->glyph_row
= NULL
;
8437 /* Use wrap_it to save a copy of IT wherever a word wrap could
8438 occur. Use atpos_it to save a copy of IT at the desired buffer
8439 position, if found, so that we can scan ahead and check if the
8440 word later overshoots the window edge. Use atx_it similarly, for
8446 /* Use ppos_it under bidi reordering to save a copy of IT for the
8447 initial position. We restore that position in IT when we have
8448 scanned the entire display line without finding a match for
8449 TO_CHARPOS and all the character positions are greater than
8450 TO_CHARPOS. We then restart the scan from the initial position,
8451 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8452 the closest to TO_CHARPOS. */
8455 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8457 SAVE_IT (ppos_it
, *it
, ppos_data
);
8458 closest_pos
= IT_CHARPOS (*it
);
8464 #define BUFFER_POS_REACHED_P() \
8465 ((op & MOVE_TO_POS) != 0 \
8466 && BUFFERP (it->object) \
8467 && (IT_CHARPOS (*it) == to_charpos \
8469 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8470 && IT_CHARPOS (*it) > to_charpos) \
8471 || (it->what == IT_COMPOSITION \
8472 && ((IT_CHARPOS (*it) > to_charpos \
8473 && to_charpos >= it->cmp_it.charpos) \
8474 || (IT_CHARPOS (*it) < to_charpos \
8475 && to_charpos <= it->cmp_it.charpos)))) \
8476 && (it->method == GET_FROM_BUFFER \
8477 || (it->method == GET_FROM_DISPLAY_VECTOR \
8478 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8480 /* If there's a line-/wrap-prefix, handle it. */
8481 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8482 && it
->current_y
< it
->last_visible_y
)
8483 handle_line_prefix (it
);
8485 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8486 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8490 int x
, i
, ascent
= 0, descent
= 0;
8492 /* Utility macro to reset an iterator with x, ascent, and descent. */
8493 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8494 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8495 (IT)->max_descent = descent)
8497 /* Stop if we move beyond TO_CHARPOS (after an image or a
8498 display string or stretch glyph). */
8499 if ((op
& MOVE_TO_POS
) != 0
8500 && BUFFERP (it
->object
)
8501 && it
->method
== GET_FROM_BUFFER
8503 /* When the iterator is at base embedding level, we
8504 are guaranteed that characters are delivered for
8505 display in strictly increasing order of their
8506 buffer positions. */
8507 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8508 && IT_CHARPOS (*it
) > to_charpos
)
8510 && (prev_method
== GET_FROM_IMAGE
8511 || prev_method
== GET_FROM_STRETCH
8512 || prev_method
== GET_FROM_STRING
)
8513 /* Passed TO_CHARPOS from left to right. */
8514 && ((prev_pos
< to_charpos
8515 && IT_CHARPOS (*it
) > to_charpos
)
8516 /* Passed TO_CHARPOS from right to left. */
8517 || (prev_pos
> to_charpos
8518 && IT_CHARPOS (*it
) < to_charpos
)))))
8520 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8522 result
= MOVE_POS_MATCH_OR_ZV
;
8525 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8526 /* If wrap_it is valid, the current position might be in a
8527 word that is wrapped. So, save the iterator in
8528 atpos_it and continue to see if wrapping happens. */
8529 SAVE_IT (atpos_it
, *it
, atpos_data
);
8532 /* Stop when ZV reached.
8533 We used to stop here when TO_CHARPOS reached as well, but that is
8534 too soon if this glyph does not fit on this line. So we handle it
8535 explicitly below. */
8536 if (!get_next_display_element (it
))
8538 result
= MOVE_POS_MATCH_OR_ZV
;
8542 if (it
->line_wrap
== TRUNCATE
)
8544 if (BUFFER_POS_REACHED_P ())
8546 result
= MOVE_POS_MATCH_OR_ZV
;
8552 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8554 if (IT_DISPLAYING_WHITESPACE (it
))
8558 /* We have reached a glyph that follows one or more
8559 whitespace characters. If the position is
8560 already found, we are done. */
8561 if (atpos_it
.sp
>= 0)
8563 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8564 result
= MOVE_POS_MATCH_OR_ZV
;
8569 RESTORE_IT (it
, &atx_it
, atx_data
);
8570 result
= MOVE_X_REACHED
;
8573 /* Otherwise, we can wrap here. */
8574 SAVE_IT (wrap_it
, *it
, wrap_data
);
8580 /* Remember the line height for the current line, in case
8581 the next element doesn't fit on the line. */
8582 ascent
= it
->max_ascent
;
8583 descent
= it
->max_descent
;
8585 /* The call to produce_glyphs will get the metrics of the
8586 display element IT is loaded with. Record the x-position
8587 before this display element, in case it doesn't fit on the
8591 PRODUCE_GLYPHS (it
);
8593 if (it
->area
!= TEXT_AREA
)
8595 prev_method
= it
->method
;
8596 if (it
->method
== GET_FROM_BUFFER
)
8597 prev_pos
= IT_CHARPOS (*it
);
8598 set_iterator_to_next (it
, true);
8599 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8600 SET_TEXT_POS (this_line_min_pos
,
8601 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8603 && (op
& MOVE_TO_POS
)
8604 && IT_CHARPOS (*it
) > to_charpos
8605 && IT_CHARPOS (*it
) < closest_pos
)
8606 closest_pos
= IT_CHARPOS (*it
);
8610 /* The number of glyphs we get back in IT->nglyphs will normally
8611 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8612 character on a terminal frame, or (iii) a line end. For the
8613 second case, IT->nglyphs - 1 padding glyphs will be present.
8614 (On X frames, there is only one glyph produced for a
8615 composite character.)
8617 The behavior implemented below means, for continuation lines,
8618 that as many spaces of a TAB as fit on the current line are
8619 displayed there. For terminal frames, as many glyphs of a
8620 multi-glyph character are displayed in the current line, too.
8621 This is what the old redisplay code did, and we keep it that
8622 way. Under X, the whole shape of a complex character must
8623 fit on the line or it will be completely displayed in the
8626 Note that both for tabs and padding glyphs, all glyphs have
8630 /* More than one glyph or glyph doesn't fit on line. All
8631 glyphs have the same width. */
8632 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8634 int x_before_this_char
= x
;
8635 int hpos_before_this_char
= it
->hpos
;
8637 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8639 new_x
= x
+ single_glyph_width
;
8641 /* We want to leave anything reaching TO_X to the caller. */
8642 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8644 if (BUFFER_POS_REACHED_P ())
8646 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8647 goto buffer_pos_reached
;
8648 if (atpos_it
.sp
< 0)
8650 SAVE_IT (atpos_it
, *it
, atpos_data
);
8651 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8656 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8659 result
= MOVE_X_REACHED
;
8664 SAVE_IT (atx_it
, *it
, atx_data
);
8665 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8670 if (/* Lines are continued. */
8671 it
->line_wrap
!= TRUNCATE
8672 && (/* And glyph doesn't fit on the line. */
8673 new_x
> it
->last_visible_x
8674 /* Or it fits exactly and we're on a window
8676 || (new_x
== it
->last_visible_x
8677 && FRAME_WINDOW_P (it
->f
)
8678 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8679 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8680 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8682 if (/* IT->hpos == 0 means the very first glyph
8683 doesn't fit on the line, e.g. a wide image. */
8685 || (new_x
== it
->last_visible_x
8686 && FRAME_WINDOW_P (it
->f
)))
8689 it
->current_x
= new_x
;
8691 /* The character's last glyph just barely fits
8693 if (i
== it
->nglyphs
- 1)
8695 /* If this is the destination position,
8696 return a position *before* it in this row,
8697 now that we know it fits in this row. */
8698 if (BUFFER_POS_REACHED_P ())
8700 if (it
->line_wrap
!= WORD_WRAP
8702 /* If we've just found whitespace to
8703 wrap, effectively ignore the
8704 previous wrap point -- it is no
8705 longer relevant, but we won't
8706 have an opportunity to update it,
8707 since we've reached the edge of
8708 this screen line. */
8710 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8712 it
->hpos
= hpos_before_this_char
;
8713 it
->current_x
= x_before_this_char
;
8714 result
= MOVE_POS_MATCH_OR_ZV
;
8717 if (it
->line_wrap
== WORD_WRAP
8720 SAVE_IT (atpos_it
, *it
, atpos_data
);
8721 atpos_it
.current_x
= x_before_this_char
;
8722 atpos_it
.hpos
= hpos_before_this_char
;
8726 prev_method
= it
->method
;
8727 if (it
->method
== GET_FROM_BUFFER
)
8728 prev_pos
= IT_CHARPOS (*it
);
8729 set_iterator_to_next (it
, true);
8730 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8731 SET_TEXT_POS (this_line_min_pos
,
8732 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8733 /* On graphical terminals, newlines may
8734 "overflow" into the fringe if
8735 overflow-newline-into-fringe is non-nil.
8736 On text terminals, and on graphical
8737 terminals with no right margin, newlines
8738 may overflow into the last glyph on the
8740 if (!FRAME_WINDOW_P (it
->f
)
8742 && it
->bidi_it
.paragraph_dir
== R2L
)
8743 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8744 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8745 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8747 if (!get_next_display_element (it
))
8749 result
= MOVE_POS_MATCH_OR_ZV
;
8752 if (BUFFER_POS_REACHED_P ())
8754 if (ITERATOR_AT_END_OF_LINE_P (it
))
8755 result
= MOVE_POS_MATCH_OR_ZV
;
8757 result
= MOVE_LINE_CONTINUED
;
8760 if (ITERATOR_AT_END_OF_LINE_P (it
)
8761 && (it
->line_wrap
!= WORD_WRAP
8763 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8765 result
= MOVE_NEWLINE_OR_CR
;
8772 IT_RESET_X_ASCENT_DESCENT (it
);
8774 /* If the screen line ends with whitespace, and we
8775 are under word-wrap, don't use wrap_it: it is no
8776 longer relevant, but we won't have an opportunity
8777 to update it, since we are done with this screen
8779 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8781 /* If we've found TO_X, go back there, as we now
8782 know the last word fits on this screen line. */
8783 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8786 RESTORE_IT (it
, &atx_it
, atx_data
);
8789 result
= MOVE_X_REACHED
;
8793 else if (wrap_it
.sp
>= 0)
8795 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8800 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8802 result
= MOVE_LINE_CONTINUED
;
8806 if (BUFFER_POS_REACHED_P ())
8808 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8809 goto buffer_pos_reached
;
8810 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8812 SAVE_IT (atpos_it
, *it
, atpos_data
);
8813 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8817 if (new_x
> it
->first_visible_x
)
8819 /* Glyph is visible. Increment number of glyphs that
8820 would be displayed. */
8825 if (result
!= MOVE_UNDEFINED
)
8828 else if (BUFFER_POS_REACHED_P ())
8831 IT_RESET_X_ASCENT_DESCENT (it
);
8832 result
= MOVE_POS_MATCH_OR_ZV
;
8835 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8837 /* Stop when TO_X specified and reached. This check is
8838 necessary here because of lines consisting of a line end,
8839 only. The line end will not produce any glyphs and we
8840 would never get MOVE_X_REACHED. */
8841 eassert (it
->nglyphs
== 0);
8842 result
= MOVE_X_REACHED
;
8846 /* Is this a line end? If yes, we're done. */
8847 if (ITERATOR_AT_END_OF_LINE_P (it
))
8849 /* If we are past TO_CHARPOS, but never saw any character
8850 positions smaller than TO_CHARPOS, return
8851 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8853 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8855 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8857 if (closest_pos
< ZV
)
8859 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8860 /* Don't recurse if closest_pos is equal to
8861 to_charpos, since we have just tried that. */
8862 if (closest_pos
!= to_charpos
)
8863 move_it_in_display_line_to (it
, closest_pos
, -1,
8865 result
= MOVE_POS_MATCH_OR_ZV
;
8868 goto buffer_pos_reached
;
8870 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8871 && IT_CHARPOS (*it
) > to_charpos
)
8872 goto buffer_pos_reached
;
8874 result
= MOVE_NEWLINE_OR_CR
;
8877 result
= MOVE_NEWLINE_OR_CR
;
8881 prev_method
= it
->method
;
8882 if (it
->method
== GET_FROM_BUFFER
)
8883 prev_pos
= IT_CHARPOS (*it
);
8884 /* The current display element has been consumed. Advance
8886 set_iterator_to_next (it
, true);
8887 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8888 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8889 if (IT_CHARPOS (*it
) < to_charpos
)
8890 saw_smaller_pos
= true;
8892 && (op
& MOVE_TO_POS
)
8893 && IT_CHARPOS (*it
) >= to_charpos
8894 && IT_CHARPOS (*it
) < closest_pos
)
8895 closest_pos
= IT_CHARPOS (*it
);
8897 /* Stop if lines are truncated and IT's current x-position is
8898 past the right edge of the window now. */
8899 if (it
->line_wrap
== TRUNCATE
8900 && it
->current_x
>= it
->last_visible_x
)
8902 if (!FRAME_WINDOW_P (it
->f
)
8903 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8904 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8905 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8906 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8908 bool at_eob_p
= false;
8910 if ((at_eob_p
= !get_next_display_element (it
))
8911 || BUFFER_POS_REACHED_P ()
8912 /* If we are past TO_CHARPOS, but never saw any
8913 character positions smaller than TO_CHARPOS,
8914 return MOVE_POS_MATCH_OR_ZV, like the
8915 unidirectional display did. */
8916 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8918 && IT_CHARPOS (*it
) > to_charpos
))
8921 && !BUFFER_POS_REACHED_P ()
8922 && !at_eob_p
&& closest_pos
< ZV
)
8924 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8925 if (closest_pos
!= to_charpos
)
8926 move_it_in_display_line_to (it
, closest_pos
, -1,
8929 result
= MOVE_POS_MATCH_OR_ZV
;
8932 if (ITERATOR_AT_END_OF_LINE_P (it
))
8934 result
= MOVE_NEWLINE_OR_CR
;
8938 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8940 && IT_CHARPOS (*it
) > to_charpos
)
8942 if (closest_pos
< ZV
)
8944 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8945 if (closest_pos
!= to_charpos
)
8946 move_it_in_display_line_to (it
, closest_pos
, -1,
8949 result
= MOVE_POS_MATCH_OR_ZV
;
8952 result
= MOVE_LINE_TRUNCATED
;
8955 #undef IT_RESET_X_ASCENT_DESCENT
8958 #undef BUFFER_POS_REACHED_P
8960 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8961 restore the saved iterator. */
8962 if (atpos_it
.sp
>= 0)
8963 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8964 else if (atx_it
.sp
>= 0)
8965 RESTORE_IT (it
, &atx_it
, atx_data
);
8970 bidi_unshelve_cache (atpos_data
, true);
8972 bidi_unshelve_cache (atx_data
, true);
8974 bidi_unshelve_cache (wrap_data
, true);
8976 bidi_unshelve_cache (ppos_data
, true);
8978 /* Restore the iterator settings altered at the beginning of this
8980 it
->glyph_row
= saved_glyph_row
;
8984 /* For external use. */
8986 move_it_in_display_line (struct it
*it
,
8987 ptrdiff_t to_charpos
, int to_x
,
8988 enum move_operation_enum op
)
8990 if (it
->line_wrap
== WORD_WRAP
8991 && (op
& MOVE_TO_X
))
8994 void *save_data
= NULL
;
8997 SAVE_IT (save_it
, *it
, save_data
);
8998 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8999 /* When word-wrap is on, TO_X may lie past the end
9000 of a wrapped line. Then it->current is the
9001 character on the next line, so backtrack to the
9002 space before the wrap point. */
9003 if (skip
== MOVE_LINE_CONTINUED
)
9005 int prev_x
= max (it
->current_x
- 1, 0);
9006 RESTORE_IT (it
, &save_it
, save_data
);
9007 move_it_in_display_line_to
9008 (it
, -1, prev_x
, MOVE_TO_X
);
9011 bidi_unshelve_cache (save_data
, true);
9014 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9018 /* Move IT forward until it satisfies one or more of the criteria in
9019 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9021 OP is a bit-mask that specifies where to stop, and in particular,
9022 which of those four position arguments makes a difference. See the
9023 description of enum move_operation_enum.
9025 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9026 screen line, this function will set IT to the next position that is
9027 displayed to the right of TO_CHARPOS on the screen.
9029 Return the maximum pixel length of any line scanned but never more
9030 than it.last_visible_x. */
9033 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9035 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9036 int line_height
, line_start_x
= 0, reached
= 0;
9037 int max_current_x
= 0;
9038 void *backup_data
= NULL
;
9042 if (op
& MOVE_TO_VPOS
)
9044 /* If no TO_CHARPOS and no TO_X specified, stop at the
9045 start of the line TO_VPOS. */
9046 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9048 if (it
->vpos
== to_vpos
)
9054 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9058 /* TO_VPOS >= 0 means stop at TO_X in the line at
9059 TO_VPOS, or at TO_POS, whichever comes first. */
9060 if (it
->vpos
== to_vpos
)
9066 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9068 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9073 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9075 /* We have reached TO_X but not in the line we want. */
9076 skip
= move_it_in_display_line_to (it
, to_charpos
,
9078 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9086 else if (op
& MOVE_TO_Y
)
9088 struct it it_backup
;
9090 if (it
->line_wrap
== WORD_WRAP
)
9091 SAVE_IT (it_backup
, *it
, backup_data
);
9093 /* TO_Y specified means stop at TO_X in the line containing
9094 TO_Y---or at TO_CHARPOS if this is reached first. The
9095 problem is that we can't really tell whether the line
9096 contains TO_Y before we have completely scanned it, and
9097 this may skip past TO_X. What we do is to first scan to
9100 If TO_X is not specified, use a TO_X of zero. The reason
9101 is to make the outcome of this function more predictable.
9102 If we didn't use TO_X == 0, we would stop at the end of
9103 the line which is probably not what a caller would expect
9105 skip
= move_it_in_display_line_to
9106 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9107 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9109 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9110 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9112 else if (skip
== MOVE_X_REACHED
)
9114 /* If TO_X was reached, we want to know whether TO_Y is
9115 in the line. We know this is the case if the already
9116 scanned glyphs make the line tall enough. Otherwise,
9117 we must check by scanning the rest of the line. */
9118 line_height
= it
->max_ascent
+ it
->max_descent
;
9119 if (to_y
>= it
->current_y
9120 && to_y
< it
->current_y
+ line_height
)
9125 SAVE_IT (it_backup
, *it
, backup_data
);
9126 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9127 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9129 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9130 line_height
= it
->max_ascent
+ it
->max_descent
;
9131 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9133 if (to_y
>= it
->current_y
9134 && to_y
< it
->current_y
+ line_height
)
9136 /* If TO_Y is in this line and TO_X was reached
9137 above, we scanned too far. We have to restore
9138 IT's settings to the ones before skipping. But
9139 keep the more accurate values of max_ascent and
9140 max_descent we've found while skipping the rest
9141 of the line, for the sake of callers, such as
9142 pos_visible_p, that need to know the line
9144 int max_ascent
= it
->max_ascent
;
9145 int max_descent
= it
->max_descent
;
9147 RESTORE_IT (it
, &it_backup
, backup_data
);
9148 it
->max_ascent
= max_ascent
;
9149 it
->max_descent
= max_descent
;
9155 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9161 /* Check whether TO_Y is in this line. */
9162 line_height
= it
->max_ascent
+ it
->max_descent
;
9163 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9165 if (to_y
>= it
->current_y
9166 && to_y
< it
->current_y
+ line_height
)
9168 if (to_y
> it
->current_y
)
9169 max_current_x
= max (it
->current_x
, max_current_x
);
9171 /* When word-wrap is on, TO_X may lie past the end
9172 of a wrapped line. Then it->current is the
9173 character on the next line, so backtrack to the
9174 space before the wrap point. */
9175 if (skip
== MOVE_LINE_CONTINUED
9176 && it
->line_wrap
== WORD_WRAP
)
9178 int prev_x
= max (it
->current_x
- 1, 0);
9179 RESTORE_IT (it
, &it_backup
, backup_data
);
9180 skip
= move_it_in_display_line_to
9181 (it
, -1, prev_x
, MOVE_TO_X
);
9190 max_current_x
= max (it
->current_x
, max_current_x
);
9194 else if (BUFFERP (it
->object
)
9195 && (it
->method
== GET_FROM_BUFFER
9196 || it
->method
== GET_FROM_STRETCH
)
9197 && IT_CHARPOS (*it
) >= to_charpos
9198 /* Under bidi iteration, a call to set_iterator_to_next
9199 can scan far beyond to_charpos if the initial
9200 portion of the next line needs to be reordered. In
9201 that case, give move_it_in_display_line_to another
9204 && it
->bidi_it
.scan_dir
== -1))
9205 skip
= MOVE_POS_MATCH_OR_ZV
;
9207 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9211 case MOVE_POS_MATCH_OR_ZV
:
9212 max_current_x
= max (it
->current_x
, max_current_x
);
9216 case MOVE_NEWLINE_OR_CR
:
9217 max_current_x
= max (it
->current_x
, max_current_x
);
9218 set_iterator_to_next (it
, true);
9219 it
->continuation_lines_width
= 0;
9222 case MOVE_LINE_TRUNCATED
:
9223 max_current_x
= it
->last_visible_x
;
9224 it
->continuation_lines_width
= 0;
9225 reseat_at_next_visible_line_start (it
, false);
9226 if ((op
& MOVE_TO_POS
) != 0
9227 && IT_CHARPOS (*it
) > to_charpos
)
9234 case MOVE_LINE_CONTINUED
:
9235 max_current_x
= it
->last_visible_x
;
9236 /* For continued lines ending in a tab, some of the glyphs
9237 associated with the tab are displayed on the current
9238 line. Since it->current_x does not include these glyphs,
9239 we use it->last_visible_x instead. */
9242 it
->continuation_lines_width
+= it
->last_visible_x
;
9243 /* When moving by vpos, ensure that the iterator really
9244 advances to the next line (bug#847, bug#969). Fixme:
9245 do we need to do this in other circumstances? */
9246 if (it
->current_x
!= it
->last_visible_x
9247 && (op
& MOVE_TO_VPOS
)
9248 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9250 line_start_x
= it
->current_x
+ it
->pixel_width
9251 - it
->last_visible_x
;
9252 if (FRAME_WINDOW_P (it
->f
))
9254 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9255 struct font
*face_font
= face
->font
;
9257 /* When display_line produces a continued line
9258 that ends in a TAB, it skips a tab stop that
9259 is closer than the font's space character
9260 width (see x_produce_glyphs where it produces
9261 the stretch glyph which represents a TAB).
9262 We need to reproduce the same logic here. */
9263 eassert (face_font
);
9266 if (line_start_x
< face_font
->space_width
)
9268 += it
->tab_width
* face_font
->space_width
;
9271 set_iterator_to_next (it
, false);
9275 it
->continuation_lines_width
+= it
->current_x
;
9282 /* Reset/increment for the next run. */
9283 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9284 it
->current_x
= line_start_x
;
9287 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9289 last_height
= it
->max_ascent
+ it
->max_descent
;
9290 it
->max_ascent
= it
->max_descent
= 0;
9295 /* On text terminals, we may stop at the end of a line in the middle
9296 of a multi-character glyph. If the glyph itself is continued,
9297 i.e. it is actually displayed on the next line, don't treat this
9298 stopping point as valid; move to the next line instead (unless
9299 that brings us offscreen). */
9300 if (!FRAME_WINDOW_P (it
->f
)
9302 && IT_CHARPOS (*it
) == to_charpos
9303 && it
->what
== IT_CHARACTER
9305 && it
->line_wrap
== WINDOW_WRAP
9306 && it
->current_x
== it
->last_visible_x
- 1
9309 && it
->w
->window_end_valid
9310 && it
->vpos
< it
->w
->window_end_vpos
)
9312 it
->continuation_lines_width
+= it
->current_x
;
9313 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9314 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9316 last_height
= it
->max_ascent
+ it
->max_descent
;
9320 bidi_unshelve_cache (backup_data
, true);
9322 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9324 return max_current_x
;
9328 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9330 If DY > 0, move IT backward at least that many pixels. DY = 0
9331 means move IT backward to the preceding line start or BEGV. This
9332 function may move over more than DY pixels if IT->current_y - DY
9333 ends up in the middle of a line; in this case IT->current_y will be
9334 set to the top of the line moved to. */
9337 move_it_vertically_backward (struct it
*it
, int dy
)
9341 void *it2data
= NULL
, *it3data
= NULL
;
9342 ptrdiff_t start_pos
;
9344 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9345 ptrdiff_t pos_limit
;
9350 start_pos
= IT_CHARPOS (*it
);
9352 /* Estimate how many newlines we must move back. */
9353 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9354 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9357 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9359 /* Set the iterator's position that many lines back. But don't go
9360 back more than NLINES full screen lines -- this wins a day with
9361 buffers which have very long lines. */
9362 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9363 back_to_previous_visible_line_start (it
);
9365 /* Reseat the iterator here. When moving backward, we don't want
9366 reseat to skip forward over invisible text, set up the iterator
9367 to deliver from overlay strings at the new position etc. So,
9368 use reseat_1 here. */
9369 reseat_1 (it
, it
->current
.pos
, true);
9371 /* We are now surely at a line start. */
9372 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9373 reordering is in effect. */
9374 it
->continuation_lines_width
= 0;
9376 /* Move forward and see what y-distance we moved. First move to the
9377 start of the next line so that we get its height. We need this
9378 height to be able to tell whether we reached the specified
9380 SAVE_IT (it2
, *it
, it2data
);
9381 it2
.max_ascent
= it2
.max_descent
= 0;
9384 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9385 MOVE_TO_POS
| MOVE_TO_VPOS
);
9387 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9388 /* If we are in a display string which starts at START_POS,
9389 and that display string includes a newline, and we are
9390 right after that newline (i.e. at the beginning of a
9391 display line), exit the loop, because otherwise we will
9392 infloop, since move_it_to will see that it is already at
9393 START_POS and will not move. */
9394 || (it2
.method
== GET_FROM_STRING
9395 && IT_CHARPOS (it2
) == start_pos
9396 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9397 eassert (IT_CHARPOS (*it
) >= BEGV
);
9398 SAVE_IT (it3
, it2
, it3data
);
9400 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9401 eassert (IT_CHARPOS (*it
) >= BEGV
);
9402 /* H is the actual vertical distance from the position in *IT
9403 and the starting position. */
9404 h
= it2
.current_y
- it
->current_y
;
9405 /* NLINES is the distance in number of lines. */
9406 nlines
= it2
.vpos
- it
->vpos
;
9408 /* Correct IT's y and vpos position
9409 so that they are relative to the starting point. */
9415 /* DY == 0 means move to the start of the screen line. The
9416 value of nlines is > 0 if continuation lines were involved,
9417 or if the original IT position was at start of a line. */
9418 RESTORE_IT (it
, it
, it2data
);
9420 move_it_by_lines (it
, nlines
);
9421 /* The above code moves us to some position NLINES down,
9422 usually to its first glyph (leftmost in an L2R line), but
9423 that's not necessarily the start of the line, under bidi
9424 reordering. We want to get to the character position
9425 that is immediately after the newline of the previous
9428 && !it
->continuation_lines_width
9429 && !STRINGP (it
->string
)
9430 && IT_CHARPOS (*it
) > BEGV
9431 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9433 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9436 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9437 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9439 bidi_unshelve_cache (it3data
, true);
9443 /* The y-position we try to reach, relative to *IT.
9444 Note that H has been subtracted in front of the if-statement. */
9445 int target_y
= it
->current_y
+ h
- dy
;
9446 int y0
= it3
.current_y
;
9450 RESTORE_IT (&it3
, &it3
, it3data
);
9451 y1
= line_bottom_y (&it3
);
9452 line_height
= y1
- y0
;
9453 RESTORE_IT (it
, it
, it2data
);
9454 /* If we did not reach target_y, try to move further backward if
9455 we can. If we moved too far backward, try to move forward. */
9456 if (target_y
< it
->current_y
9457 /* This is heuristic. In a window that's 3 lines high, with
9458 a line height of 13 pixels each, recentering with point
9459 on the bottom line will try to move -39/2 = 19 pixels
9460 backward. Try to avoid moving into the first line. */
9461 && (it
->current_y
- target_y
9462 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9463 && IT_CHARPOS (*it
) > BEGV
)
9465 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9466 target_y
- it
->current_y
));
9467 dy
= it
->current_y
- target_y
;
9468 goto move_further_back
;
9470 else if (target_y
>= it
->current_y
+ line_height
9471 && IT_CHARPOS (*it
) < ZV
)
9473 /* Should move forward by at least one line, maybe more.
9475 Note: Calling move_it_by_lines can be expensive on
9476 terminal frames, where compute_motion is used (via
9477 vmotion) to do the job, when there are very long lines
9478 and truncate-lines is nil. That's the reason for
9479 treating terminal frames specially here. */
9481 if (!FRAME_WINDOW_P (it
->f
))
9482 move_it_vertically (it
, target_y
- it
->current_y
);
9487 move_it_by_lines (it
, 1);
9489 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9496 /* Move IT by a specified amount of pixel lines DY. DY negative means
9497 move backwards. DY = 0 means move to start of screen line. At the
9498 end, IT will be on the start of a screen line. */
9501 move_it_vertically (struct it
*it
, int dy
)
9504 move_it_vertically_backward (it
, -dy
);
9507 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9508 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9509 MOVE_TO_POS
| MOVE_TO_Y
);
9510 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9512 /* If buffer ends in ZV without a newline, move to the start of
9513 the line to satisfy the post-condition. */
9514 if (IT_CHARPOS (*it
) == ZV
9516 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9517 move_it_by_lines (it
, 0);
9522 /* Move iterator IT past the end of the text line it is in. */
9525 move_it_past_eol (struct it
*it
)
9527 enum move_it_result rc
;
9529 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9530 if (rc
== MOVE_NEWLINE_OR_CR
)
9531 set_iterator_to_next (it
, false);
9535 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9536 negative means move up. DVPOS == 0 means move to the start of the
9539 Optimization idea: If we would know that IT->f doesn't use
9540 a face with proportional font, we could be faster for
9541 truncate-lines nil. */
9544 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9547 /* The commented-out optimization uses vmotion on terminals. This
9548 gives bad results, because elements like it->what, on which
9549 callers such as pos_visible_p rely, aren't updated. */
9550 /* struct position pos;
9551 if (!FRAME_WINDOW_P (it->f))
9553 struct text_pos textpos;
9555 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9556 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9557 reseat (it, textpos, true);
9558 it->vpos += pos.vpos;
9559 it->current_y += pos.vpos;
9565 /* DVPOS == 0 means move to the start of the screen line. */
9566 move_it_vertically_backward (it
, 0);
9567 /* Let next call to line_bottom_y calculate real line height. */
9572 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9573 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9575 /* Only move to the next buffer position if we ended up in a
9576 string from display property, not in an overlay string
9577 (before-string or after-string). That is because the
9578 latter don't conceal the underlying buffer position, so
9579 we can ask to move the iterator to the exact position we
9580 are interested in. Note that, even if we are already at
9581 IT_CHARPOS (*it), the call below is not a no-op, as it
9582 will detect that we are at the end of the string, pop the
9583 iterator, and compute it->current_x and it->hpos
9585 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9586 -1, -1, -1, MOVE_TO_POS
);
9592 void *it2data
= NULL
;
9593 ptrdiff_t start_charpos
, i
;
9595 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9596 bool hit_pos_limit
= false;
9597 ptrdiff_t pos_limit
;
9599 /* Start at the beginning of the screen line containing IT's
9600 position. This may actually move vertically backwards,
9601 in case of overlays, so adjust dvpos accordingly. */
9603 move_it_vertically_backward (it
, 0);
9606 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9607 screen lines, and reseat the iterator there. */
9608 start_charpos
= IT_CHARPOS (*it
);
9609 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9612 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9614 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9615 back_to_previous_visible_line_start (it
);
9616 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9617 hit_pos_limit
= true;
9618 reseat (it
, it
->current
.pos
, true);
9620 /* Move further back if we end up in a string or an image. */
9621 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9623 /* First try to move to start of display line. */
9625 move_it_vertically_backward (it
, 0);
9627 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9629 /* If start of line is still in string or image,
9630 move further back. */
9631 back_to_previous_visible_line_start (it
);
9632 reseat (it
, it
->current
.pos
, true);
9636 it
->current_x
= it
->hpos
= 0;
9638 /* Above call may have moved too far if continuation lines
9639 are involved. Scan forward and see if it did. */
9640 SAVE_IT (it2
, *it
, it2data
);
9641 it2
.vpos
= it2
.current_y
= 0;
9642 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9643 it
->vpos
-= it2
.vpos
;
9644 it
->current_y
-= it2
.current_y
;
9645 it
->current_x
= it
->hpos
= 0;
9647 /* If we moved too far back, move IT some lines forward. */
9648 if (it2
.vpos
> -dvpos
)
9650 int delta
= it2
.vpos
+ dvpos
;
9652 RESTORE_IT (&it2
, &it2
, it2data
);
9653 SAVE_IT (it2
, *it
, it2data
);
9654 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9655 /* Move back again if we got too far ahead. */
9656 if (IT_CHARPOS (*it
) >= start_charpos
)
9657 RESTORE_IT (it
, &it2
, it2data
);
9659 bidi_unshelve_cache (it2data
, true);
9661 else if (hit_pos_limit
&& pos_limit
> BEGV
9662 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9664 /* If we hit the limit, but still didn't make it far enough
9665 back, that means there's a display string with a newline
9666 covering a large chunk of text, and that caused
9667 back_to_previous_visible_line_start try to go too far.
9668 Punish those who commit such atrocities by going back
9669 until we've reached DVPOS, after lifting the limit, which
9670 could make it slow for very long lines. "If it hurts,
9673 RESTORE_IT (it
, it
, it2data
);
9674 for (i
= -dvpos
; i
> 0; --i
)
9676 back_to_previous_visible_line_start (it
);
9679 reseat_1 (it
, it
->current
.pos
, true);
9682 RESTORE_IT (it
, it
, it2data
);
9686 /* Return true if IT points into the middle of a display vector. */
9689 in_display_vector_p (struct it
*it
)
9691 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9692 && it
->current
.dpvec_index
> 0
9693 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9696 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9697 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9698 WINDOW must be a live window and defaults to the selected one. The
9699 return value is a cons of the maximum pixel-width of any text line and
9700 the maximum pixel-height of all text lines.
9702 The optional argument FROM, if non-nil, specifies the first text
9703 position and defaults to the minimum accessible position of the buffer.
9704 If FROM is t, use the minimum accessible position that is not a newline
9705 character. TO, if non-nil, specifies the last text position and
9706 defaults to the maximum accessible position of the buffer. If TO is t,
9707 use the maximum accessible position that is not a newline character.
9709 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9710 width that can be returned. X-LIMIT nil or omitted, means to use the
9711 pixel-width of WINDOW's body; use this if you do not intend to change
9712 the width of WINDOW. Use the maximum width WINDOW may assume if you
9713 intend to change WINDOW's width. In any case, text whose x-coordinate
9714 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9715 can take some time, it's always a good idea to make this argument as
9716 small as possible; in particular, if the buffer contains long lines that
9717 shall be truncated anyway.
9719 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9720 height that can be returned. Text lines whose y-coordinate is beyond
9721 Y-LIMIT are ignored. Since calculating the text height of a large
9722 buffer can take some time, it makes sense to specify this argument if
9723 the size of the buffer is unknown.
9725 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9726 include the height of the mode- or header-line of WINDOW in the return
9727 value. If it is either the symbol `mode-line' or `header-line', include
9728 only the height of that line, if present, in the return value. If t,
9729 include the height of both, if present, in the return value. */)
9730 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9731 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9733 struct window
*w
= decode_live_window (window
);
9734 Lisp_Object buffer
= w
->contents
;
9737 struct buffer
*old_b
= NULL
;
9738 ptrdiff_t start
, end
, pos
;
9739 struct text_pos startp
;
9740 void *itdata
= NULL
;
9741 int c
, max_y
= -1, x
= 0, y
= 0;
9743 CHECK_BUFFER (buffer
);
9744 b
= XBUFFER (buffer
);
9746 if (b
!= current_buffer
)
9748 old_b
= current_buffer
;
9749 set_buffer_internal (b
);
9754 else if (EQ (from
, Qt
))
9757 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9758 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9760 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9765 CHECK_NUMBER_COERCE_MARKER (from
);
9766 start
= min (max (XINT (from
), BEGV
), ZV
);
9771 else if (EQ (to
, Qt
))
9774 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9775 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9777 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9782 CHECK_NUMBER_COERCE_MARKER (to
);
9783 end
= max (start
, min (XINT (to
), ZV
));
9786 if (!NILP (y_limit
))
9788 CHECK_NUMBER (y_limit
);
9789 max_y
= min (XINT (y_limit
), INT_MAX
);
9792 itdata
= bidi_shelve_cache ();
9793 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9794 start_display (&it
, w
, startp
);
9797 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9800 CHECK_NUMBER (x_limit
);
9801 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9802 /* Actually, we never want move_it_to stop at to_x. But to make
9803 sure that move_it_in_display_line_to always moves far enough,
9804 we set it to INT_MAX and specify MOVE_TO_X. */
9805 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9806 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9809 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9811 if (!EQ (mode_and_header_line
, Qheader_line
)
9812 && !EQ (mode_and_header_line
, Qt
))
9813 /* Do not count the header-line which was counted automatically by
9815 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9817 if (EQ (mode_and_header_line
, Qmode_line
)
9818 || EQ (mode_and_header_line
, Qt
))
9819 /* Do count the mode-line which is not included automatically by
9821 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9823 bidi_unshelve_cache (itdata
, false);
9826 set_buffer_internal (old_b
);
9828 return Fcons (make_number (x
), make_number (y
));
9831 /***********************************************************************
9833 ***********************************************************************/
9835 /* Return the number of arguments the format string FORMAT needs. */
9838 format_nargs (char const *format
)
9840 ptrdiff_t nargs
= 0;
9841 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9849 /* Add a message with format string FORMAT and formatted arguments
9853 add_to_log (const char *format
, ...)
9856 va_start (ap
, format
);
9857 vadd_to_log (format
, ap
);
9862 vadd_to_log (char const *format
, va_list ap
)
9864 ptrdiff_t form_nargs
= format_nargs (format
);
9865 ptrdiff_t nargs
= 1 + form_nargs
;
9866 Lisp_Object args
[10];
9867 eassert (nargs
<= ARRAYELTS (args
));
9868 AUTO_STRING (args0
, format
);
9870 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9871 args
[i
] = va_arg (ap
, Lisp_Object
);
9872 Lisp_Object msg
= Qnil
;
9873 msg
= Fformat_message (nargs
, args
);
9875 ptrdiff_t len
= SBYTES (msg
) + 1;
9877 char *buffer
= SAFE_ALLOCA (len
);
9878 memcpy (buffer
, SDATA (msg
), len
);
9880 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9885 /* Output a newline in the *Messages* buffer if "needs" one. */
9888 message_log_maybe_newline (void)
9890 if (message_log_need_newline
)
9891 message_dolog ("", 0, true, false);
9895 /* Add a string M of length NBYTES to the message log, optionally
9896 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9897 true, means interpret the contents of M as multibyte. This
9898 function calls low-level routines in order to bypass text property
9899 hooks, etc. which might not be safe to run.
9901 This may GC (insert may run before/after change hooks),
9902 so the buffer M must NOT point to a Lisp string. */
9905 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9907 const unsigned char *msg
= (const unsigned char *) m
;
9909 if (!NILP (Vmemory_full
))
9912 if (!NILP (Vmessage_log_max
))
9914 struct buffer
*oldbuf
;
9915 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9916 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9917 ptrdiff_t point_at_end
= 0;
9918 ptrdiff_t zv_at_end
= 0;
9919 Lisp_Object old_deactivate_mark
;
9921 old_deactivate_mark
= Vdeactivate_mark
;
9922 oldbuf
= current_buffer
;
9924 /* Ensure the Messages buffer exists, and switch to it.
9925 If we created it, set the major-mode. */
9926 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9927 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9929 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9930 call0 (intern ("messages-buffer-mode"));
9932 bset_undo_list (current_buffer
, Qt
);
9933 bset_cache_long_scans (current_buffer
, Qnil
);
9935 oldpoint
= message_dolog_marker1
;
9936 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9937 oldbegv
= message_dolog_marker2
;
9938 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9939 oldzv
= message_dolog_marker3
;
9940 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9948 BEGV_BYTE
= BEG_BYTE
;
9951 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9953 /* Insert the string--maybe converting multibyte to single byte
9954 or vice versa, so that all the text fits the buffer. */
9956 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9962 /* Convert a multibyte string to single-byte
9963 for the *Message* buffer. */
9964 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9966 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9967 work
[0] = CHAR_TO_BYTE8 (c
);
9968 insert_1_both (work
, 1, 1, true, false, false);
9971 else if (! multibyte
9972 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9976 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9977 /* Convert a single-byte string to multibyte
9978 for the *Message* buffer. */
9979 for (i
= 0; i
< nbytes
; i
++)
9982 MAKE_CHAR_MULTIBYTE (c
);
9983 char_bytes
= CHAR_STRING (c
, str
);
9984 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9988 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9989 true, false, false);
9993 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9996 insert_1_both ("\n", 1, 1, true, false, false);
9998 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10000 this_bol_byte
= PT_BYTE
;
10002 /* See if this line duplicates the previous one.
10003 If so, combine duplicates. */
10004 if (this_bol
> BEG
)
10006 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10008 prev_bol_byte
= PT_BYTE
;
10010 dups
= message_log_check_duplicate (prev_bol_byte
,
10014 del_range_both (prev_bol
, prev_bol_byte
,
10015 this_bol
, this_bol_byte
, false);
10018 char dupstr
[sizeof " [ times]"
10019 + INT_STRLEN_BOUND (printmax_t
)];
10021 /* If you change this format, don't forget to also
10022 change message_log_check_duplicate. */
10023 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10024 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10025 insert_1_both (dupstr
, duplen
, duplen
,
10026 true, false, true);
10031 /* If we have more than the desired maximum number of lines
10032 in the *Messages* buffer now, delete the oldest ones.
10033 This is safe because we don't have undo in this buffer. */
10035 if (NATNUMP (Vmessage_log_max
))
10037 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10038 -XFASTINT (Vmessage_log_max
) - 1, false);
10039 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10042 BEGV
= marker_position (oldbegv
);
10043 BEGV_BYTE
= marker_byte_position (oldbegv
);
10052 ZV
= marker_position (oldzv
);
10053 ZV_BYTE
= marker_byte_position (oldzv
);
10057 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10059 /* We can't do Fgoto_char (oldpoint) because it will run some
10061 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10062 marker_byte_position (oldpoint
));
10064 unchain_marker (XMARKER (oldpoint
));
10065 unchain_marker (XMARKER (oldbegv
));
10066 unchain_marker (XMARKER (oldzv
));
10068 /* We called insert_1_both above with its 5th argument (PREPARE)
10069 false, which prevents insert_1_both from calling
10070 prepare_to_modify_buffer, which in turns prevents us from
10071 incrementing windows_or_buffers_changed even if *Messages* is
10072 shown in some window. So we must manually set
10073 windows_or_buffers_changed here to make up for that. */
10074 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10075 bset_redisplay (current_buffer
);
10077 set_buffer_internal (oldbuf
);
10079 message_log_need_newline
= !nlflag
;
10080 Vdeactivate_mark
= old_deactivate_mark
;
10085 /* We are at the end of the buffer after just having inserted a newline.
10086 (Note: We depend on the fact we won't be crossing the gap.)
10087 Check to see if the most recent message looks a lot like the previous one.
10088 Return 0 if different, 1 if the new one should just replace it, or a
10089 value N > 1 if we should also append " [N times]". */
10092 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10095 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10096 bool seen_dots
= false;
10097 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10098 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10100 for (i
= 0; i
< len
; i
++)
10102 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10104 if (p1
[i
] != p2
[i
])
10110 if (*p1
++ == ' ' && *p1
++ == '[')
10113 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10114 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10121 /* Display an echo area message M with a specified length of NBYTES
10122 bytes. The string may include null characters. If M is not a
10123 string, clear out any existing message, and let the mini-buffer
10126 This function cancels echoing. */
10129 message3 (Lisp_Object m
)
10131 clear_message (true, true);
10134 /* First flush out any partial line written with print. */
10135 message_log_maybe_newline ();
10138 ptrdiff_t nbytes
= SBYTES (m
);
10139 bool multibyte
= STRING_MULTIBYTE (m
);
10142 SAFE_ALLOCA_STRING (buffer
, m
);
10143 message_dolog (buffer
, nbytes
, true, multibyte
);
10146 if (! inhibit_message
)
10147 message3_nolog (m
);
10150 /* Log the message M to stderr. Log an empty line if M is not a string. */
10153 message_to_stderr (Lisp_Object m
)
10155 if (noninteractive_need_newline
)
10157 noninteractive_need_newline
= false;
10158 fputc ('\n', stderr
);
10162 Lisp_Object s
= ENCODE_SYSTEM (m
);
10163 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10165 if (!cursor_in_echo_area
)
10166 fputc ('\n', stderr
);
10170 /* The non-logging version of message3.
10171 This does not cancel echoing, because it is used for echoing.
10172 Perhaps we need to make a separate function for echoing
10173 and make this cancel echoing. */
10176 message3_nolog (Lisp_Object m
)
10178 struct frame
*sf
= SELECTED_FRAME ();
10180 if (FRAME_INITIAL_P (sf
))
10181 message_to_stderr (m
);
10182 /* Error messages get reported properly by cmd_error, so this must be just an
10183 informative message; if the frame hasn't really been initialized yet, just
10185 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10187 /* Get the frame containing the mini-buffer
10188 that the selected frame is using. */
10189 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10190 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10191 struct frame
*f
= XFRAME (frame
);
10193 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10194 Fmake_frame_visible (frame
);
10196 if (STRINGP (m
) && SCHARS (m
) > 0)
10199 if (minibuffer_auto_raise
)
10200 Fraise_frame (frame
);
10201 /* Assume we are not echoing.
10202 (If we are, echo_now will override this.) */
10203 echo_message_buffer
= Qnil
;
10206 clear_message (true, true);
10208 do_pending_window_change (false);
10209 echo_area_display (true);
10210 do_pending_window_change (false);
10211 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10212 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10217 /* Display a null-terminated echo area message M. If M is 0, clear
10218 out any existing message, and let the mini-buffer text show through.
10220 The buffer M must continue to exist until after the echo area gets
10221 cleared or some other message gets displayed there. Do not pass
10222 text that is stored in a Lisp string. Do not pass text in a buffer
10223 that was alloca'd. */
10226 message1 (const char *m
)
10228 message3 (m
? build_unibyte_string (m
) : Qnil
);
10232 /* The non-logging counterpart of message1. */
10235 message1_nolog (const char *m
)
10237 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10240 /* Display a message M which contains a single %s
10241 which gets replaced with STRING. */
10244 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10246 CHECK_STRING (string
);
10249 if (noninteractive
)
10250 need_message
= !!m
;
10251 else if (!INTERACTIVE
)
10252 need_message
= false;
10255 /* The frame whose minibuffer we're going to display the message on.
10256 It may be larger than the selected frame, so we need
10257 to use its buffer, not the selected frame's buffer. */
10258 Lisp_Object mini_window
;
10259 struct frame
*f
, *sf
= SELECTED_FRAME ();
10261 /* Get the frame containing the minibuffer
10262 that the selected frame is using. */
10263 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10264 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10266 /* Error messages get reported properly by cmd_error, so this must be
10267 just an informative message; if the frame hasn't really been
10268 initialized yet, just toss it. */
10269 need_message
= f
->glyphs_initialized_p
;
10274 AUTO_STRING (fmt
, m
);
10275 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10277 if (noninteractive
)
10278 message_to_stderr (msg
);
10284 message3_nolog (msg
);
10286 /* Print should start at the beginning of the message
10287 buffer next time. */
10288 message_buf_print
= false;
10294 /* Dump an informative message to the minibuf. If M is 0, clear out
10295 any existing message, and let the mini-buffer text show through.
10297 The message must be safe ASCII and the format must not contain ` or
10298 '. If your message and format do not fit into this category,
10299 convert your arguments to Lisp objects and use Fmessage instead. */
10301 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10302 vmessage (const char *m
, va_list ap
)
10304 if (noninteractive
)
10308 if (noninteractive_need_newline
)
10309 putc ('\n', stderr
);
10310 noninteractive_need_newline
= false;
10311 vfprintf (stderr
, m
, ap
);
10312 if (!cursor_in_echo_area
)
10313 fprintf (stderr
, "\n");
10317 else if (INTERACTIVE
)
10319 /* The frame whose mini-buffer we're going to display the message
10320 on. It may be larger than the selected frame, so we need to
10321 use its buffer, not the selected frame's buffer. */
10322 Lisp_Object mini_window
;
10323 struct frame
*f
, *sf
= SELECTED_FRAME ();
10325 /* Get the frame containing the mini-buffer
10326 that the selected frame is using. */
10327 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10328 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10330 /* Error messages get reported properly by cmd_error, so this must be
10331 just an informative message; if the frame hasn't really been
10332 initialized yet, just toss it. */
10333 if (f
->glyphs_initialized_p
)
10338 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10340 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10342 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10344 message3 (make_string (message_buf
, len
));
10350 /* Print should start at the beginning of the message
10351 buffer next time. */
10352 message_buf_print
= false;
10358 message (const char *m
, ...)
10367 /* Display the current message in the current mini-buffer. This is
10368 only called from error handlers in process.c, and is not time
10372 update_echo_area (void)
10374 if (!NILP (echo_area_buffer
[0]))
10376 Lisp_Object string
;
10377 string
= Fcurrent_message ();
10383 /* Make sure echo area buffers in `echo_buffers' are live.
10384 If they aren't, make new ones. */
10387 ensure_echo_area_buffers (void)
10391 for (i
= 0; i
< 2; ++i
)
10392 if (!BUFFERP (echo_buffer
[i
])
10393 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10396 Lisp_Object old_buffer
;
10399 old_buffer
= echo_buffer
[i
];
10400 echo_buffer
[i
] = Fget_buffer_create
10401 (make_formatted_string (name
, " *Echo Area %d*", i
));
10402 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10403 /* to force word wrap in echo area -
10404 it was decided to postpone this*/
10405 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10407 for (j
= 0; j
< 2; ++j
)
10408 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10409 echo_area_buffer
[j
] = echo_buffer
[i
];
10414 /* Call FN with args A1..A2 with either the current or last displayed
10415 echo_area_buffer as current buffer.
10417 WHICH zero means use the current message buffer
10418 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10419 from echo_buffer[] and clear it.
10421 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10422 suitable buffer from echo_buffer[] and clear it.
10424 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10425 that the current message becomes the last displayed one, make
10426 choose a suitable buffer for echo_area_buffer[0], and clear it.
10428 Value is what FN returns. */
10431 with_echo_area_buffer (struct window
*w
, int which
,
10432 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10433 ptrdiff_t a1
, Lisp_Object a2
)
10435 Lisp_Object buffer
;
10436 bool this_one
, the_other
, clear_buffer_p
, rc
;
10437 ptrdiff_t count
= SPECPDL_INDEX ();
10439 /* If buffers aren't live, make new ones. */
10440 ensure_echo_area_buffers ();
10442 clear_buffer_p
= false;
10445 this_one
= false, the_other
= true;
10446 else if (which
> 0)
10447 this_one
= true, the_other
= false;
10450 this_one
= false, the_other
= true;
10451 clear_buffer_p
= true;
10453 /* We need a fresh one in case the current echo buffer equals
10454 the one containing the last displayed echo area message. */
10455 if (!NILP (echo_area_buffer
[this_one
])
10456 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10457 echo_area_buffer
[this_one
] = Qnil
;
10460 /* Choose a suitable buffer from echo_buffer[] is we don't
10462 if (NILP (echo_area_buffer
[this_one
]))
10464 echo_area_buffer
[this_one
]
10465 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10466 ? echo_buffer
[the_other
]
10467 : echo_buffer
[this_one
]);
10468 clear_buffer_p
= true;
10471 buffer
= echo_area_buffer
[this_one
];
10473 /* Don't get confused by reusing the buffer used for echoing
10474 for a different purpose. */
10475 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10478 record_unwind_protect (unwind_with_echo_area_buffer
,
10479 with_echo_area_buffer_unwind_data (w
));
10481 /* Make the echo area buffer current. Note that for display
10482 purposes, it is not necessary that the displayed window's buffer
10483 == current_buffer, except for text property lookup. So, let's
10484 only set that buffer temporarily here without doing a full
10485 Fset_window_buffer. We must also change w->pointm, though,
10486 because otherwise an assertions in unshow_buffer fails, and Emacs
10488 set_buffer_internal_1 (XBUFFER (buffer
));
10491 wset_buffer (w
, buffer
);
10492 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10493 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10496 bset_undo_list (current_buffer
, Qt
);
10497 bset_read_only (current_buffer
, Qnil
);
10498 specbind (Qinhibit_read_only
, Qt
);
10499 specbind (Qinhibit_modification_hooks
, Qt
);
10501 if (clear_buffer_p
&& Z
> BEG
)
10502 del_range (BEG
, Z
);
10504 eassert (BEGV
>= BEG
);
10505 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10509 eassert (BEGV
>= BEG
);
10510 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10512 unbind_to (count
, Qnil
);
10517 /* Save state that should be preserved around the call to the function
10518 FN called in with_echo_area_buffer. */
10521 with_echo_area_buffer_unwind_data (struct window
*w
)
10524 Lisp_Object vector
, tmp
;
10526 /* Reduce consing by keeping one vector in
10527 Vwith_echo_area_save_vector. */
10528 vector
= Vwith_echo_area_save_vector
;
10529 Vwith_echo_area_save_vector
= Qnil
;
10532 vector
= Fmake_vector (make_number (11), Qnil
);
10534 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10535 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10536 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10540 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10541 ASET (vector
, i
, w
->contents
); ++i
;
10542 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10543 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10544 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10545 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10546 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10547 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10552 for (; i
< end
; ++i
)
10553 ASET (vector
, i
, Qnil
);
10556 eassert (i
== ASIZE (vector
));
10561 /* Restore global state from VECTOR which was created by
10562 with_echo_area_buffer_unwind_data. */
10565 unwind_with_echo_area_buffer (Lisp_Object vector
)
10567 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10568 Vdeactivate_mark
= AREF (vector
, 1);
10569 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10571 if (WINDOWP (AREF (vector
, 3)))
10574 Lisp_Object buffer
;
10576 w
= XWINDOW (AREF (vector
, 3));
10577 buffer
= AREF (vector
, 4);
10579 wset_buffer (w
, buffer
);
10580 set_marker_both (w
->pointm
, buffer
,
10581 XFASTINT (AREF (vector
, 5)),
10582 XFASTINT (AREF (vector
, 6)));
10583 set_marker_both (w
->old_pointm
, buffer
,
10584 XFASTINT (AREF (vector
, 7)),
10585 XFASTINT (AREF (vector
, 8)));
10586 set_marker_both (w
->start
, buffer
,
10587 XFASTINT (AREF (vector
, 9)),
10588 XFASTINT (AREF (vector
, 10)));
10591 Vwith_echo_area_save_vector
= vector
;
10595 /* Set up the echo area for use by print functions. MULTIBYTE_P
10596 means we will print multibyte. */
10599 setup_echo_area_for_printing (bool multibyte_p
)
10601 /* If we can't find an echo area any more, exit. */
10602 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10603 Fkill_emacs (Qnil
);
10605 ensure_echo_area_buffers ();
10607 if (!message_buf_print
)
10609 /* A message has been output since the last time we printed.
10610 Choose a fresh echo area buffer. */
10611 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10612 echo_area_buffer
[0] = echo_buffer
[1];
10614 echo_area_buffer
[0] = echo_buffer
[0];
10616 /* Switch to that buffer and clear it. */
10617 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10618 bset_truncate_lines (current_buffer
, Qnil
);
10622 ptrdiff_t count
= SPECPDL_INDEX ();
10623 specbind (Qinhibit_read_only
, Qt
);
10624 /* Note that undo recording is always disabled. */
10625 del_range (BEG
, Z
);
10626 unbind_to (count
, Qnil
);
10628 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10630 /* Set up the buffer for the multibyteness we need. */
10632 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10633 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10635 /* Raise the frame containing the echo area. */
10636 if (minibuffer_auto_raise
)
10638 struct frame
*sf
= SELECTED_FRAME ();
10639 Lisp_Object mini_window
;
10640 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10641 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10644 message_log_maybe_newline ();
10645 message_buf_print
= true;
10649 if (NILP (echo_area_buffer
[0]))
10651 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10652 echo_area_buffer
[0] = echo_buffer
[1];
10654 echo_area_buffer
[0] = echo_buffer
[0];
10657 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10659 /* Someone switched buffers between print requests. */
10660 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10661 bset_truncate_lines (current_buffer
, Qnil
);
10667 /* Display an echo area message in window W. Value is true if W's
10668 height is changed. If display_last_displayed_message_p,
10669 display the message that was last displayed, otherwise
10670 display the current message. */
10673 display_echo_area (struct window
*w
)
10675 bool no_message_p
, window_height_changed_p
;
10677 /* Temporarily disable garbage collections while displaying the echo
10678 area. This is done because a GC can print a message itself.
10679 That message would modify the echo area buffer's contents while a
10680 redisplay of the buffer is going on, and seriously confuse
10682 ptrdiff_t count
= inhibit_garbage_collection ();
10684 /* If there is no message, we must call display_echo_area_1
10685 nevertheless because it resizes the window. But we will have to
10686 reset the echo_area_buffer in question to nil at the end because
10687 with_echo_area_buffer will sets it to an empty buffer. */
10688 bool i
= display_last_displayed_message_p
;
10689 no_message_p
= NILP (echo_area_buffer
[i
]);
10691 window_height_changed_p
10692 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10693 display_echo_area_1
,
10694 (intptr_t) w
, Qnil
);
10697 echo_area_buffer
[i
] = Qnil
;
10699 unbind_to (count
, Qnil
);
10700 return window_height_changed_p
;
10704 /* Helper for display_echo_area. Display the current buffer which
10705 contains the current echo area message in window W, a mini-window,
10706 a pointer to which is passed in A1. A2..A4 are currently not used.
10707 Change the height of W so that all of the message is displayed.
10708 Value is true if height of W was changed. */
10711 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10714 struct window
*w
= (struct window
*) i1
;
10715 Lisp_Object window
;
10716 struct text_pos start
;
10718 /* We are about to enter redisplay without going through
10719 redisplay_internal, so we need to forget these faces by hand
10721 forget_escape_and_glyphless_faces ();
10723 /* Do this before displaying, so that we have a large enough glyph
10724 matrix for the display. If we can't get enough space for the
10725 whole text, display the last N lines. That works by setting w->start. */
10726 bool window_height_changed_p
= resize_mini_window (w
, false);
10728 /* Use the starting position chosen by resize_mini_window. */
10729 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10732 clear_glyph_matrix (w
->desired_matrix
);
10733 XSETWINDOW (window
, w
);
10734 try_window (window
, start
, 0);
10736 return window_height_changed_p
;
10740 /* Resize the echo area window to exactly the size needed for the
10741 currently displayed message, if there is one. If a mini-buffer
10742 is active, don't shrink it. */
10745 resize_echo_area_exactly (void)
10747 if (BUFFERP (echo_area_buffer
[0])
10748 && WINDOWP (echo_area_window
))
10750 struct window
*w
= XWINDOW (echo_area_window
);
10751 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10752 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10753 (intptr_t) w
, resize_exactly
);
10756 windows_or_buffers_changed
= 42;
10757 update_mode_lines
= 30;
10758 redisplay_internal ();
10764 /* Callback function for with_echo_area_buffer, when used from
10765 resize_echo_area_exactly. A1 contains a pointer to the window to
10766 resize, EXACTLY non-nil means resize the mini-window exactly to the
10767 size of the text displayed. A3 and A4 are not used. Value is what
10768 resize_mini_window returns. */
10771 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10774 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10778 /* Resize mini-window W to fit the size of its contents. EXACT_P
10779 means size the window exactly to the size needed. Otherwise, it's
10780 only enlarged until W's buffer is empty.
10782 Set W->start to the right place to begin display. If the whole
10783 contents fit, start at the beginning. Otherwise, start so as
10784 to make the end of the contents appear. This is particularly
10785 important for y-or-n-p, but seems desirable generally.
10787 Value is true if the window height has been changed. */
10790 resize_mini_window (struct window
*w
, bool exact_p
)
10792 struct frame
*f
= XFRAME (w
->frame
);
10793 bool window_height_changed_p
= false;
10795 eassert (MINI_WINDOW_P (w
));
10797 /* By default, start display at the beginning. */
10798 set_marker_both (w
->start
, w
->contents
,
10799 BUF_BEGV (XBUFFER (w
->contents
)),
10800 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10802 /* Don't resize windows while redisplaying a window; it would
10803 confuse redisplay functions when the size of the window they are
10804 displaying changes from under them. Such a resizing can happen,
10805 for instance, when which-func prints a long message while
10806 we are running fontification-functions. We're running these
10807 functions with safe_call which binds inhibit-redisplay to t. */
10808 if (!NILP (Vinhibit_redisplay
))
10811 /* Nil means don't try to resize. */
10812 if (NILP (Vresize_mini_windows
)
10813 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10816 if (!FRAME_MINIBUF_ONLY_P (f
))
10819 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10820 + WINDOW_PIXEL_HEIGHT (w
));
10821 int unit
= FRAME_LINE_HEIGHT (f
);
10822 int height
, max_height
;
10823 struct text_pos start
;
10824 struct buffer
*old_current_buffer
= NULL
;
10826 if (current_buffer
!= XBUFFER (w
->contents
))
10828 old_current_buffer
= current_buffer
;
10829 set_buffer_internal (XBUFFER (w
->contents
));
10832 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10834 /* Compute the max. number of lines specified by the user. */
10835 if (FLOATP (Vmax_mini_window_height
))
10836 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10837 else if (INTEGERP (Vmax_mini_window_height
))
10838 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10840 max_height
= total_height
/ 4;
10842 /* Correct that max. height if it's bogus. */
10843 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10845 /* Find out the height of the text in the window. */
10846 if (it
.line_wrap
== TRUNCATE
)
10851 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10852 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10853 height
= it
.current_y
+ last_height
;
10855 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10856 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10859 /* Compute a suitable window start. */
10860 if (height
> max_height
)
10862 height
= (max_height
/ unit
) * unit
;
10863 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10864 move_it_vertically_backward (&it
, height
- unit
);
10865 start
= it
.current
.pos
;
10868 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10869 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10871 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10873 /* Let it grow only, until we display an empty message, in which
10874 case the window shrinks again. */
10875 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10877 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10879 FRAME_WINDOWS_FROZEN (f
) = true;
10880 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10881 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10883 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10884 && (exact_p
|| BEGV
== ZV
))
10886 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10888 FRAME_WINDOWS_FROZEN (f
) = false;
10889 shrink_mini_window (w
, true);
10890 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10895 /* Always resize to exact size needed. */
10896 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10898 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10900 FRAME_WINDOWS_FROZEN (f
) = true;
10901 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10902 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10904 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10906 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10908 FRAME_WINDOWS_FROZEN (f
) = false;
10909 shrink_mini_window (w
, true);
10913 FRAME_WINDOWS_FROZEN (f
) = true;
10914 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10917 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10921 if (old_current_buffer
)
10922 set_buffer_internal (old_current_buffer
);
10925 return window_height_changed_p
;
10929 /* Value is the current message, a string, or nil if there is no
10930 current message. */
10933 current_message (void)
10937 if (!BUFFERP (echo_area_buffer
[0]))
10941 with_echo_area_buffer (0, 0, current_message_1
,
10942 (intptr_t) &msg
, Qnil
);
10944 echo_area_buffer
[0] = Qnil
;
10952 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10955 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10958 *msg
= make_buffer_string (BEG
, Z
, true);
10965 /* Push the current message on Vmessage_stack for later restoration
10966 by restore_message. Value is true if the current message isn't
10967 empty. This is a relatively infrequent operation, so it's not
10968 worth optimizing. */
10971 push_message (void)
10973 Lisp_Object msg
= current_message ();
10974 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10975 return STRINGP (msg
);
10979 /* Restore message display from the top of Vmessage_stack. */
10982 restore_message (void)
10984 eassert (CONSP (Vmessage_stack
));
10985 message3_nolog (XCAR (Vmessage_stack
));
10989 /* Handler for unwind-protect calling pop_message. */
10992 pop_message_unwind (void)
10994 /* Pop the top-most entry off Vmessage_stack. */
10995 eassert (CONSP (Vmessage_stack
));
10996 Vmessage_stack
= XCDR (Vmessage_stack
);
11000 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11001 exits. If the stack is not empty, we have a missing pop_message
11005 check_message_stack (void)
11007 if (!NILP (Vmessage_stack
))
11012 /* Truncate to NCHARS what will be displayed in the echo area the next
11013 time we display it---but don't redisplay it now. */
11016 truncate_echo_area (ptrdiff_t nchars
)
11019 echo_area_buffer
[0] = Qnil
;
11020 else if (!noninteractive
11022 && !NILP (echo_area_buffer
[0]))
11024 struct frame
*sf
= SELECTED_FRAME ();
11025 /* Error messages get reported properly by cmd_error, so this must be
11026 just an informative message; if the frame hasn't really been
11027 initialized yet, just toss it. */
11028 if (sf
->glyphs_initialized_p
)
11029 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11034 /* Helper function for truncate_echo_area. Truncate the current
11035 message to at most NCHARS characters. */
11038 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11040 if (BEG
+ nchars
< Z
)
11041 del_range (BEG
+ nchars
, Z
);
11043 echo_area_buffer
[0] = Qnil
;
11047 /* Set the current message to STRING. */
11050 set_message (Lisp_Object string
)
11052 eassert (STRINGP (string
));
11054 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11056 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11057 message_buf_print
= false;
11058 help_echo_showing_p
= false;
11060 if (STRINGP (Vdebug_on_message
)
11061 && STRINGP (string
)
11062 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11063 call_debugger (list2 (Qerror
, string
));
11067 /* Helper function for set_message. First argument is ignored and second
11068 argument has the same meaning as for set_message.
11069 This function is called with the echo area buffer being current. */
11072 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11074 eassert (STRINGP (string
));
11076 /* Change multibyteness of the echo buffer appropriately. */
11077 if (message_enable_multibyte
11078 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11079 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11081 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11082 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11083 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11085 /* Insert new message at BEG. */
11086 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11088 /* This function takes care of single/multibyte conversion.
11089 We just have to ensure that the echo area buffer has the right
11090 setting of enable_multibyte_characters. */
11091 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11097 /* Clear messages. CURRENT_P means clear the current message.
11098 LAST_DISPLAYED_P means clear the message last displayed. */
11101 clear_message (bool current_p
, bool last_displayed_p
)
11105 echo_area_buffer
[0] = Qnil
;
11106 message_cleared_p
= true;
11109 if (last_displayed_p
)
11110 echo_area_buffer
[1] = Qnil
;
11112 message_buf_print
= false;
11115 /* Clear garbaged frames.
11117 This function is used where the old redisplay called
11118 redraw_garbaged_frames which in turn called redraw_frame which in
11119 turn called clear_frame. The call to clear_frame was a source of
11120 flickering. I believe a clear_frame is not necessary. It should
11121 suffice in the new redisplay to invalidate all current matrices,
11122 and ensure a complete redisplay of all windows. */
11125 clear_garbaged_frames (void)
11127 if (frame_garbaged
)
11129 Lisp_Object tail
, frame
;
11131 FOR_EACH_FRAME (tail
, frame
)
11133 struct frame
*f
= XFRAME (frame
);
11135 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11140 clear_current_matrices (f
);
11141 fset_redisplay (f
);
11142 f
->garbaged
= false;
11143 f
->resized_p
= false;
11147 frame_garbaged
= false;
11152 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11156 echo_area_display (bool update_frame_p
)
11158 Lisp_Object mini_window
;
11161 bool window_height_changed_p
= false;
11162 struct frame
*sf
= SELECTED_FRAME ();
11164 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11165 w
= XWINDOW (mini_window
);
11166 f
= XFRAME (WINDOW_FRAME (w
));
11168 /* Don't display if frame is invisible or not yet initialized. */
11169 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11172 #ifdef HAVE_WINDOW_SYSTEM
11173 /* When Emacs starts, selected_frame may be the initial terminal
11174 frame. If we let this through, a message would be displayed on
11176 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11178 #endif /* HAVE_WINDOW_SYSTEM */
11180 /* Redraw garbaged frames. */
11181 clear_garbaged_frames ();
11183 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11185 echo_area_window
= mini_window
;
11186 window_height_changed_p
= display_echo_area (w
);
11187 w
->must_be_updated_p
= true;
11189 /* Update the display, unless called from redisplay_internal.
11190 Also don't update the screen during redisplay itself. The
11191 update will happen at the end of redisplay, and an update
11192 here could cause confusion. */
11193 if (update_frame_p
&& !redisplaying_p
)
11197 /* If the display update has been interrupted by pending
11198 input, update mode lines in the frame. Due to the
11199 pending input, it might have been that redisplay hasn't
11200 been called, so that mode lines above the echo area are
11201 garbaged. This looks odd, so we prevent it here. */
11202 if (!display_completed
)
11203 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11205 if (window_height_changed_p
11206 /* Don't do this if Emacs is shutting down. Redisplay
11207 needs to run hooks. */
11208 && !NILP (Vrun_hooks
))
11210 /* Must update other windows. Likewise as in other
11211 cases, don't let this update be interrupted by
11213 ptrdiff_t count
= SPECPDL_INDEX ();
11214 specbind (Qredisplay_dont_pause
, Qt
);
11215 fset_redisplay (f
);
11216 redisplay_internal ();
11217 unbind_to (count
, Qnil
);
11219 else if (FRAME_WINDOW_P (f
) && n
== 0)
11221 /* Window configuration is the same as before.
11222 Can do with a display update of the echo area,
11223 unless we displayed some mode lines. */
11224 update_single_window (w
);
11228 update_frame (f
, true, true);
11230 /* If cursor is in the echo area, make sure that the next
11231 redisplay displays the minibuffer, so that the cursor will
11232 be replaced with what the minibuffer wants. */
11233 if (cursor_in_echo_area
)
11234 wset_redisplay (XWINDOW (mini_window
));
11237 else if (!EQ (mini_window
, selected_window
))
11238 wset_redisplay (XWINDOW (mini_window
));
11240 /* Last displayed message is now the current message. */
11241 echo_area_buffer
[1] = echo_area_buffer
[0];
11242 /* Inform read_char that we're not echoing. */
11243 echo_message_buffer
= Qnil
;
11245 /* Prevent redisplay optimization in redisplay_internal by resetting
11246 this_line_start_pos. This is done because the mini-buffer now
11247 displays the message instead of its buffer text. */
11248 if (EQ (mini_window
, selected_window
))
11249 CHARPOS (this_line_start_pos
) = 0;
11251 if (window_height_changed_p
)
11253 fset_redisplay (f
);
11255 /* If window configuration was changed, frames may have been
11256 marked garbaged. Clear them or we will experience
11257 surprises wrt scrolling.
11258 FIXME: How/why/when? */
11259 clear_garbaged_frames ();
11263 /* True if W's buffer was changed but not saved. */
11266 window_buffer_changed (struct window
*w
)
11268 struct buffer
*b
= XBUFFER (w
->contents
);
11270 eassert (BUFFER_LIVE_P (b
));
11272 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11275 /* True if W has %c in its mode line and mode line should be updated. */
11278 mode_line_update_needed (struct window
*w
)
11280 return (w
->column_number_displayed
!= -1
11281 && !(PT
== w
->last_point
&& !window_outdated (w
))
11282 && (w
->column_number_displayed
!= current_column ()));
11285 /* True if window start of W is frozen and may not be changed during
11289 window_frozen_p (struct window
*w
)
11291 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11293 Lisp_Object window
;
11295 XSETWINDOW (window
, w
);
11296 if (MINI_WINDOW_P (w
))
11298 else if (EQ (window
, selected_window
))
11300 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11301 && EQ (window
, Vminibuf_scroll_window
))
11302 /* This special window can't be frozen too. */
11310 /***********************************************************************
11311 Mode Lines and Frame Titles
11312 ***********************************************************************/
11314 /* A buffer for constructing non-propertized mode-line strings and
11315 frame titles in it; allocated from the heap in init_xdisp and
11316 resized as needed in store_mode_line_noprop_char. */
11318 static char *mode_line_noprop_buf
;
11320 /* The buffer's end, and a current output position in it. */
11322 static char *mode_line_noprop_buf_end
;
11323 static char *mode_line_noprop_ptr
;
11325 #define MODE_LINE_NOPROP_LEN(start) \
11326 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11329 MODE_LINE_DISPLAY
= 0,
11333 } mode_line_target
;
11335 /* Alist that caches the results of :propertize.
11336 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11337 static Lisp_Object mode_line_proptrans_alist
;
11339 /* List of strings making up the mode-line. */
11340 static Lisp_Object mode_line_string_list
;
11342 /* Base face property when building propertized mode line string. */
11343 static Lisp_Object mode_line_string_face
;
11344 static Lisp_Object mode_line_string_face_prop
;
11347 /* Unwind data for mode line strings */
11349 static Lisp_Object Vmode_line_unwind_vector
;
11352 format_mode_line_unwind_data (struct frame
*target_frame
,
11353 struct buffer
*obuf
,
11355 bool save_proptrans
)
11357 Lisp_Object vector
, tmp
;
11359 /* Reduce consing by keeping one vector in
11360 Vwith_echo_area_save_vector. */
11361 vector
= Vmode_line_unwind_vector
;
11362 Vmode_line_unwind_vector
= Qnil
;
11365 vector
= Fmake_vector (make_number (10), Qnil
);
11367 ASET (vector
, 0, make_number (mode_line_target
));
11368 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11369 ASET (vector
, 2, mode_line_string_list
);
11370 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11371 ASET (vector
, 4, mode_line_string_face
);
11372 ASET (vector
, 5, mode_line_string_face_prop
);
11375 XSETBUFFER (tmp
, obuf
);
11378 ASET (vector
, 6, tmp
);
11379 ASET (vector
, 7, owin
);
11382 /* Similarly to `with-selected-window', if the operation selects
11383 a window on another frame, we must restore that frame's
11384 selected window, and (for a tty) the top-frame. */
11385 ASET (vector
, 8, target_frame
->selected_window
);
11386 if (FRAME_TERMCAP_P (target_frame
))
11387 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11394 unwind_format_mode_line (Lisp_Object vector
)
11396 Lisp_Object old_window
= AREF (vector
, 7);
11397 Lisp_Object target_frame_window
= AREF (vector
, 8);
11398 Lisp_Object old_top_frame
= AREF (vector
, 9);
11400 mode_line_target
= XINT (AREF (vector
, 0));
11401 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11402 mode_line_string_list
= AREF (vector
, 2);
11403 if (! EQ (AREF (vector
, 3), Qt
))
11404 mode_line_proptrans_alist
= AREF (vector
, 3);
11405 mode_line_string_face
= AREF (vector
, 4);
11406 mode_line_string_face_prop
= AREF (vector
, 5);
11408 /* Select window before buffer, since it may change the buffer. */
11409 if (!NILP (old_window
))
11411 /* If the operation that we are unwinding had selected a window
11412 on a different frame, reset its frame-selected-window. For a
11413 text terminal, reset its top-frame if necessary. */
11414 if (!NILP (target_frame_window
))
11417 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11419 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11420 Fselect_window (target_frame_window
, Qt
);
11422 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11423 Fselect_frame (old_top_frame
, Qt
);
11426 Fselect_window (old_window
, Qt
);
11429 if (!NILP (AREF (vector
, 6)))
11431 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11432 ASET (vector
, 6, Qnil
);
11435 Vmode_line_unwind_vector
= vector
;
11439 /* Store a single character C for the frame title in mode_line_noprop_buf.
11440 Re-allocate mode_line_noprop_buf if necessary. */
11443 store_mode_line_noprop_char (char c
)
11445 /* If output position has reached the end of the allocated buffer,
11446 increase the buffer's size. */
11447 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11449 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11450 ptrdiff_t size
= len
;
11451 mode_line_noprop_buf
=
11452 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11453 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11454 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11457 *mode_line_noprop_ptr
++ = c
;
11461 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11462 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11463 characters that yield more columns than PRECISION; PRECISION <= 0
11464 means copy the whole string. Pad with spaces until FIELD_WIDTH
11465 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11466 pad. Called from display_mode_element when it is used to build a
11470 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11472 const unsigned char *str
= (const unsigned char *) string
;
11474 ptrdiff_t dummy
, nbytes
;
11476 /* Copy at most PRECISION chars from STR. */
11477 nbytes
= strlen (string
);
11478 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11480 store_mode_line_noprop_char (*str
++);
11482 /* Fill up with spaces until FIELD_WIDTH reached. */
11483 while (field_width
> 0
11484 && n
< field_width
)
11486 store_mode_line_noprop_char (' ');
11493 /***********************************************************************
11495 ***********************************************************************/
11497 #ifdef HAVE_WINDOW_SYSTEM
11499 /* Set the title of FRAME, if it has changed. The title format is
11500 Vicon_title_format if FRAME is iconified, otherwise it is
11501 frame_title_format. */
11504 x_consider_frame_title (Lisp_Object frame
)
11506 struct frame
*f
= XFRAME (frame
);
11508 if (FRAME_WINDOW_P (f
)
11509 || FRAME_MINIBUF_ONLY_P (f
)
11510 || f
->explicit_name
)
11512 /* Do we have more than one visible frame on this X display? */
11513 Lisp_Object tail
, other_frame
, fmt
;
11514 ptrdiff_t title_start
;
11518 ptrdiff_t count
= SPECPDL_INDEX ();
11520 FOR_EACH_FRAME (tail
, other_frame
)
11522 struct frame
*tf
= XFRAME (other_frame
);
11525 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11526 && !FRAME_MINIBUF_ONLY_P (tf
)
11527 && !EQ (other_frame
, tip_frame
)
11528 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11532 /* Set global variable indicating that multiple frames exist. */
11533 multiple_frames
= CONSP (tail
);
11535 /* Switch to the buffer of selected window of the frame. Set up
11536 mode_line_target so that display_mode_element will output into
11537 mode_line_noprop_buf; then display the title. */
11538 record_unwind_protect (unwind_format_mode_line
,
11539 format_mode_line_unwind_data
11540 (f
, current_buffer
, selected_window
, false));
11542 Fselect_window (f
->selected_window
, Qt
);
11543 set_buffer_internal_1
11544 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11545 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11547 mode_line_target
= MODE_LINE_TITLE
;
11548 title_start
= MODE_LINE_NOPROP_LEN (0);
11549 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11550 NULL
, DEFAULT_FACE_ID
);
11551 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11552 len
= MODE_LINE_NOPROP_LEN (title_start
);
11553 title
= mode_line_noprop_buf
+ title_start
;
11554 unbind_to (count
, Qnil
);
11556 /* Set the title only if it's changed. This avoids consing in
11557 the common case where it hasn't. (If it turns out that we've
11558 already wasted too much time by walking through the list with
11559 display_mode_element, then we might need to optimize at a
11560 higher level than this.) */
11561 if (! STRINGP (f
->name
)
11562 || SBYTES (f
->name
) != len
11563 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11564 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11568 #endif /* not HAVE_WINDOW_SYSTEM */
11571 /***********************************************************************
11573 ***********************************************************************/
11575 /* True if we will not redisplay all visible windows. */
11576 #define REDISPLAY_SOME_P() \
11577 ((windows_or_buffers_changed == 0 \
11578 || windows_or_buffers_changed == REDISPLAY_SOME) \
11579 && (update_mode_lines == 0 \
11580 || update_mode_lines == REDISPLAY_SOME))
11582 /* Prepare for redisplay by updating menu-bar item lists when
11583 appropriate. This can call eval. */
11586 prepare_menu_bars (void)
11588 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11589 bool some_windows
= REDISPLAY_SOME_P ();
11590 Lisp_Object tooltip_frame
;
11592 #ifdef HAVE_WINDOW_SYSTEM
11593 tooltip_frame
= tip_frame
;
11595 tooltip_frame
= Qnil
;
11598 if (FUNCTIONP (Vpre_redisplay_function
))
11600 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11601 if (all_windows
&& some_windows
)
11603 Lisp_Object ws
= window_list ();
11604 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11606 Lisp_Object
this = XCAR (ws
);
11607 struct window
*w
= XWINDOW (this);
11609 || XFRAME (w
->frame
)->redisplay
11610 || XBUFFER (w
->contents
)->text
->redisplay
)
11612 windows
= Fcons (this, windows
);
11616 safe__call1 (true, Vpre_redisplay_function
, windows
);
11619 /* Update all frame titles based on their buffer names, etc. We do
11620 this before the menu bars so that the buffer-menu will show the
11621 up-to-date frame titles. */
11622 #ifdef HAVE_WINDOW_SYSTEM
11625 Lisp_Object tail
, frame
;
11627 FOR_EACH_FRAME (tail
, frame
)
11629 struct frame
*f
= XFRAME (frame
);
11630 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11634 && !XBUFFER (w
->contents
)->text
->redisplay
)
11637 if (!EQ (frame
, tooltip_frame
)
11638 && (FRAME_ICONIFIED_P (f
)
11639 || FRAME_VISIBLE_P (f
) == 1
11640 /* Exclude TTY frames that are obscured because they
11641 are not the top frame on their console. This is
11642 because x_consider_frame_title actually switches
11643 to the frame, which for TTY frames means it is
11644 marked as garbaged, and will be completely
11645 redrawn on the next redisplay cycle. This causes
11646 TTY frames to be completely redrawn, when there
11647 are more than one of them, even though nothing
11648 should be changed on display. */
11649 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11650 x_consider_frame_title (frame
);
11653 #endif /* HAVE_WINDOW_SYSTEM */
11655 /* Update the menu bar item lists, if appropriate. This has to be
11656 done before any actual redisplay or generation of display lines. */
11660 Lisp_Object tail
, frame
;
11661 ptrdiff_t count
= SPECPDL_INDEX ();
11662 /* True means that update_menu_bar has run its hooks
11663 so any further calls to update_menu_bar shouldn't do so again. */
11664 bool menu_bar_hooks_run
= false;
11666 record_unwind_save_match_data ();
11668 FOR_EACH_FRAME (tail
, frame
)
11670 struct frame
*f
= XFRAME (frame
);
11671 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11673 /* Ignore tooltip frame. */
11674 if (EQ (frame
, tooltip_frame
))
11680 && !XBUFFER (w
->contents
)->text
->redisplay
)
11683 /* If a window on this frame changed size, report that to
11684 the user and clear the size-change flag. */
11685 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11687 Lisp_Object functions
;
11689 /* Clear flag first in case we get an error below. */
11690 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11691 functions
= Vwindow_size_change_functions
;
11693 while (CONSP (functions
))
11695 if (!EQ (XCAR (functions
), Qt
))
11696 call1 (XCAR (functions
), frame
);
11697 functions
= XCDR (functions
);
11701 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11702 #ifdef HAVE_WINDOW_SYSTEM
11703 update_tool_bar (f
, false);
11707 unbind_to (count
, Qnil
);
11711 struct frame
*sf
= SELECTED_FRAME ();
11712 update_menu_bar (sf
, true, false);
11713 #ifdef HAVE_WINDOW_SYSTEM
11714 update_tool_bar (sf
, true);
11720 /* Update the menu bar item list for frame F. This has to be done
11721 before we start to fill in any display lines, because it can call
11724 If SAVE_MATCH_DATA, we must save and restore it here.
11726 If HOOKS_RUN, a previous call to update_menu_bar
11727 already ran the menu bar hooks for this redisplay, so there
11728 is no need to run them again. The return value is the
11729 updated value of this flag, to pass to the next call. */
11732 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11734 Lisp_Object window
;
11737 /* If called recursively during a menu update, do nothing. This can
11738 happen when, for instance, an activate-menubar-hook causes a
11740 if (inhibit_menubar_update
)
11743 window
= FRAME_SELECTED_WINDOW (f
);
11744 w
= XWINDOW (window
);
11746 if (FRAME_WINDOW_P (f
)
11748 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11749 || defined (HAVE_NS) || defined (USE_GTK)
11750 FRAME_EXTERNAL_MENU_BAR (f
)
11752 FRAME_MENU_BAR_LINES (f
) > 0
11754 : FRAME_MENU_BAR_LINES (f
) > 0)
11756 /* If the user has switched buffers or windows, we need to
11757 recompute to reflect the new bindings. But we'll
11758 recompute when update_mode_lines is set too; that means
11759 that people can use force-mode-line-update to request
11760 that the menu bar be recomputed. The adverse effect on
11761 the rest of the redisplay algorithm is about the same as
11762 windows_or_buffers_changed anyway. */
11763 if (windows_or_buffers_changed
11764 /* This used to test w->update_mode_line, but we believe
11765 there is no need to recompute the menu in that case. */
11766 || update_mode_lines
11767 || window_buffer_changed (w
))
11769 struct buffer
*prev
= current_buffer
;
11770 ptrdiff_t count
= SPECPDL_INDEX ();
11772 specbind (Qinhibit_menubar_update
, Qt
);
11774 set_buffer_internal_1 (XBUFFER (w
->contents
));
11775 if (save_match_data
)
11776 record_unwind_save_match_data ();
11777 if (NILP (Voverriding_local_map_menu_flag
))
11779 specbind (Qoverriding_terminal_local_map
, Qnil
);
11780 specbind (Qoverriding_local_map
, Qnil
);
11785 /* Run the Lucid hook. */
11786 safe_run_hooks (Qactivate_menubar_hook
);
11788 /* If it has changed current-menubar from previous value,
11789 really recompute the menu-bar from the value. */
11790 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11791 call0 (Qrecompute_lucid_menubar
);
11793 safe_run_hooks (Qmenu_bar_update_hook
);
11798 XSETFRAME (Vmenu_updating_frame
, f
);
11799 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11801 /* Redisplay the menu bar in case we changed it. */
11802 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11803 || defined (HAVE_NS) || defined (USE_GTK)
11804 if (FRAME_WINDOW_P (f
))
11806 #if defined (HAVE_NS)
11807 /* All frames on Mac OS share the same menubar. So only
11808 the selected frame should be allowed to set it. */
11809 if (f
== SELECTED_FRAME ())
11811 set_frame_menubar (f
, false, false);
11814 /* On a terminal screen, the menu bar is an ordinary screen
11815 line, and this makes it get updated. */
11816 w
->update_mode_line
= true;
11817 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11818 /* In the non-toolkit version, the menu bar is an ordinary screen
11819 line, and this makes it get updated. */
11820 w
->update_mode_line
= true;
11821 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11823 unbind_to (count
, Qnil
);
11824 set_buffer_internal_1 (prev
);
11831 /***********************************************************************
11833 ***********************************************************************/
11835 #ifdef HAVE_WINDOW_SYSTEM
11837 /* Select `frame' temporarily without running all the code in
11839 FIXME: Maybe do_switch_frame should be trimmed down similarly
11840 when `norecord' is set. */
11842 fast_set_selected_frame (Lisp_Object frame
)
11844 if (!EQ (selected_frame
, frame
))
11846 selected_frame
= frame
;
11847 selected_window
= XFRAME (frame
)->selected_window
;
11851 /* Update the tool-bar item list for frame F. This has to be done
11852 before we start to fill in any display lines. Called from
11853 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11854 and restore it here. */
11857 update_tool_bar (struct frame
*f
, bool save_match_data
)
11859 #if defined (USE_GTK) || defined (HAVE_NS)
11860 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11862 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11863 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11868 Lisp_Object window
;
11871 window
= FRAME_SELECTED_WINDOW (f
);
11872 w
= XWINDOW (window
);
11874 /* If the user has switched buffers or windows, we need to
11875 recompute to reflect the new bindings. But we'll
11876 recompute when update_mode_lines is set too; that means
11877 that people can use force-mode-line-update to request
11878 that the menu bar be recomputed. The adverse effect on
11879 the rest of the redisplay algorithm is about the same as
11880 windows_or_buffers_changed anyway. */
11881 if (windows_or_buffers_changed
11882 || w
->update_mode_line
11883 || update_mode_lines
11884 || window_buffer_changed (w
))
11886 struct buffer
*prev
= current_buffer
;
11887 ptrdiff_t count
= SPECPDL_INDEX ();
11888 Lisp_Object frame
, new_tool_bar
;
11889 int new_n_tool_bar
;
11891 /* Set current_buffer to the buffer of the selected
11892 window of the frame, so that we get the right local
11894 set_buffer_internal_1 (XBUFFER (w
->contents
));
11896 /* Save match data, if we must. */
11897 if (save_match_data
)
11898 record_unwind_save_match_data ();
11900 /* Make sure that we don't accidentally use bogus keymaps. */
11901 if (NILP (Voverriding_local_map_menu_flag
))
11903 specbind (Qoverriding_terminal_local_map
, Qnil
);
11904 specbind (Qoverriding_local_map
, Qnil
);
11907 /* We must temporarily set the selected frame to this frame
11908 before calling tool_bar_items, because the calculation of
11909 the tool-bar keymap uses the selected frame (see
11910 `tool-bar-make-keymap' in tool-bar.el). */
11911 eassert (EQ (selected_window
,
11912 /* Since we only explicitly preserve selected_frame,
11913 check that selected_window would be redundant. */
11914 XFRAME (selected_frame
)->selected_window
));
11915 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11916 XSETFRAME (frame
, f
);
11917 fast_set_selected_frame (frame
);
11919 /* Build desired tool-bar items from keymaps. */
11921 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11924 /* Redisplay the tool-bar if we changed it. */
11925 if (new_n_tool_bar
!= f
->n_tool_bar_items
11926 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11928 /* Redisplay that happens asynchronously due to an expose event
11929 may access f->tool_bar_items. Make sure we update both
11930 variables within BLOCK_INPUT so no such event interrupts. */
11932 fset_tool_bar_items (f
, new_tool_bar
);
11933 f
->n_tool_bar_items
= new_n_tool_bar
;
11934 w
->update_mode_line
= true;
11938 unbind_to (count
, Qnil
);
11939 set_buffer_internal_1 (prev
);
11944 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11946 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11947 F's desired tool-bar contents. F->tool_bar_items must have
11948 been set up previously by calling prepare_menu_bars. */
11951 build_desired_tool_bar_string (struct frame
*f
)
11953 int i
, size
, size_needed
;
11954 Lisp_Object image
, plist
;
11956 image
= plist
= Qnil
;
11958 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11959 Otherwise, make a new string. */
11961 /* The size of the string we might be able to reuse. */
11962 size
= (STRINGP (f
->desired_tool_bar_string
)
11963 ? SCHARS (f
->desired_tool_bar_string
)
11966 /* We need one space in the string for each image. */
11967 size_needed
= f
->n_tool_bar_items
;
11969 /* Reuse f->desired_tool_bar_string, if possible. */
11970 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11971 fset_desired_tool_bar_string
11972 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11975 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11976 Fremove_text_properties (make_number (0), make_number (size
),
11977 props
, f
->desired_tool_bar_string
);
11980 /* Put a `display' property on the string for the images to display,
11981 put a `menu_item' property on tool-bar items with a value that
11982 is the index of the item in F's tool-bar item vector. */
11983 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11985 #define PROP(IDX) \
11986 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11988 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11989 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11990 int hmargin
, vmargin
, relief
, idx
, end
;
11992 /* If image is a vector, choose the image according to the
11994 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11995 if (VECTORP (image
))
11999 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12000 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12003 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12004 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12006 eassert (ASIZE (image
) >= idx
);
12007 image
= AREF (image
, idx
);
12012 /* Ignore invalid image specifications. */
12013 if (!valid_image_p (image
))
12016 /* Display the tool-bar button pressed, or depressed. */
12017 plist
= Fcopy_sequence (XCDR (image
));
12019 /* Compute margin and relief to draw. */
12020 relief
= (tool_bar_button_relief
>= 0
12021 ? tool_bar_button_relief
12022 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12023 hmargin
= vmargin
= relief
;
12025 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12026 INT_MAX
- max (hmargin
, vmargin
)))
12028 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12029 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12031 else if (CONSP (Vtool_bar_button_margin
))
12033 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12034 INT_MAX
- hmargin
))
12035 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12037 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12038 INT_MAX
- vmargin
))
12039 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12042 if (auto_raise_tool_bar_buttons_p
)
12044 /* Add a `:relief' property to the image spec if the item is
12048 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12055 /* If image is selected, display it pressed, i.e. with a
12056 negative relief. If it's not selected, display it with a
12058 plist
= Fplist_put (plist
, QCrelief
,
12060 ? make_number (-relief
)
12061 : make_number (relief
)));
12066 /* Put a margin around the image. */
12067 if (hmargin
|| vmargin
)
12069 if (hmargin
== vmargin
)
12070 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12072 plist
= Fplist_put (plist
, QCmargin
,
12073 Fcons (make_number (hmargin
),
12074 make_number (vmargin
)));
12077 /* If button is not enabled, and we don't have special images
12078 for the disabled state, make the image appear disabled by
12079 applying an appropriate algorithm to it. */
12080 if (!enabled_p
&& idx
< 0)
12081 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12083 /* Put a `display' text property on the string for the image to
12084 display. Put a `menu-item' property on the string that gives
12085 the start of this item's properties in the tool-bar items
12087 image
= Fcons (Qimage
, plist
);
12088 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12089 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12091 /* Let the last image hide all remaining spaces in the tool bar
12092 string. The string can be longer than needed when we reuse a
12093 previous string. */
12094 if (i
+ 1 == f
->n_tool_bar_items
)
12095 end
= SCHARS (f
->desired_tool_bar_string
);
12098 Fadd_text_properties (make_number (i
), make_number (end
),
12099 props
, f
->desired_tool_bar_string
);
12105 /* Display one line of the tool-bar of frame IT->f.
12107 HEIGHT specifies the desired height of the tool-bar line.
12108 If the actual height of the glyph row is less than HEIGHT, the
12109 row's height is increased to HEIGHT, and the icons are centered
12110 vertically in the new height.
12112 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12113 count a final empty row in case the tool-bar width exactly matches
12118 display_tool_bar_line (struct it
*it
, int height
)
12120 struct glyph_row
*row
= it
->glyph_row
;
12121 int max_x
= it
->last_visible_x
;
12122 struct glyph
*last
;
12124 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12125 clear_glyph_row (row
);
12126 row
->enabled_p
= true;
12127 row
->y
= it
->current_y
;
12129 /* Note that this isn't made use of if the face hasn't a box,
12130 so there's no need to check the face here. */
12131 it
->start_of_box_run_p
= true;
12133 while (it
->current_x
< max_x
)
12135 int x
, n_glyphs_before
, i
, nglyphs
;
12136 struct it it_before
;
12138 /* Get the next display element. */
12139 if (!get_next_display_element (it
))
12141 /* Don't count empty row if we are counting needed tool-bar lines. */
12142 if (height
< 0 && !it
->hpos
)
12147 /* Produce glyphs. */
12148 n_glyphs_before
= row
->used
[TEXT_AREA
];
12151 PRODUCE_GLYPHS (it
);
12153 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12155 x
= it_before
.current_x
;
12156 while (i
< nglyphs
)
12158 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12160 if (x
+ glyph
->pixel_width
> max_x
)
12162 /* Glyph doesn't fit on line. Backtrack. */
12163 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12165 /* If this is the only glyph on this line, it will never fit on the
12166 tool-bar, so skip it. But ensure there is at least one glyph,
12167 so we don't accidentally disable the tool-bar. */
12168 if (n_glyphs_before
== 0
12169 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12175 x
+= glyph
->pixel_width
;
12179 /* Stop at line end. */
12180 if (ITERATOR_AT_END_OF_LINE_P (it
))
12183 set_iterator_to_next (it
, true);
12188 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12190 /* Use default face for the border below the tool bar.
12192 FIXME: When auto-resize-tool-bars is grow-only, there is
12193 no additional border below the possibly empty tool-bar lines.
12194 So to make the extra empty lines look "normal", we have to
12195 use the tool-bar face for the border too. */
12196 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12197 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12198 it
->face_id
= DEFAULT_FACE_ID
;
12200 extend_face_to_end_of_line (it
);
12201 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12202 last
->right_box_line_p
= true;
12203 if (last
== row
->glyphs
[TEXT_AREA
])
12204 last
->left_box_line_p
= true;
12206 /* Make line the desired height and center it vertically. */
12207 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12209 /* Don't add more than one line height. */
12210 height
%= FRAME_LINE_HEIGHT (it
->f
);
12211 it
->max_ascent
+= height
/ 2;
12212 it
->max_descent
+= (height
+ 1) / 2;
12215 compute_line_metrics (it
);
12217 /* If line is empty, make it occupy the rest of the tool-bar. */
12218 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12220 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12221 row
->visible_height
= row
->height
;
12222 row
->ascent
= row
->phys_ascent
= 0;
12223 row
->extra_line_spacing
= 0;
12226 row
->full_width_p
= true;
12227 row
->continued_p
= false;
12228 row
->truncated_on_left_p
= false;
12229 row
->truncated_on_right_p
= false;
12231 it
->current_x
= it
->hpos
= 0;
12232 it
->current_y
+= row
->height
;
12238 /* Value is the number of pixels needed to make all tool-bar items of
12239 frame F visible. The actual number of glyph rows needed is
12240 returned in *N_ROWS if non-NULL. */
12242 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12244 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12246 /* tool_bar_height is called from redisplay_tool_bar after building
12247 the desired matrix, so use (unused) mode-line row as temporary row to
12248 avoid destroying the first tool-bar row. */
12249 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12251 /* Initialize an iterator for iteration over
12252 F->desired_tool_bar_string in the tool-bar window of frame F. */
12253 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12254 temp_row
->reversed_p
= false;
12255 it
.first_visible_x
= 0;
12256 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12257 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12258 it
.paragraph_embedding
= L2R
;
12260 while (!ITERATOR_AT_END_P (&it
))
12262 clear_glyph_row (temp_row
);
12263 it
.glyph_row
= temp_row
;
12264 display_tool_bar_line (&it
, -1);
12266 clear_glyph_row (temp_row
);
12268 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12270 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12273 return it
.current_y
;
12275 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12278 #endif /* !USE_GTK && !HAVE_NS */
12280 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12282 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12283 If FRAME is nil or omitted, use the selected frame. Optional argument
12284 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12285 (Lisp_Object frame
, Lisp_Object pixelwise
)
12289 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12290 struct frame
*f
= decode_any_frame (frame
);
12292 if (WINDOWP (f
->tool_bar_window
)
12293 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12295 update_tool_bar (f
, true);
12296 if (f
->n_tool_bar_items
)
12298 build_desired_tool_bar_string (f
);
12299 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12304 return make_number (height
);
12308 /* Display the tool-bar of frame F. Value is true if tool-bar's
12309 height should be changed. */
12311 redisplay_tool_bar (struct frame
*f
)
12313 #if defined (USE_GTK) || defined (HAVE_NS)
12315 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12316 update_frame_tool_bar (f
);
12319 #else /* !USE_GTK && !HAVE_NS */
12323 struct glyph_row
*row
;
12325 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12326 do anything. This means you must start with tool-bar-lines
12327 non-zero to get the auto-sizing effect. Or in other words, you
12328 can turn off tool-bars by specifying tool-bar-lines zero. */
12329 if (!WINDOWP (f
->tool_bar_window
)
12330 || (w
= XWINDOW (f
->tool_bar_window
),
12331 WINDOW_TOTAL_LINES (w
) == 0))
12334 /* Set up an iterator for the tool-bar window. */
12335 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12336 it
.first_visible_x
= 0;
12337 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12338 row
= it
.glyph_row
;
12339 row
->reversed_p
= false;
12341 /* Build a string that represents the contents of the tool-bar. */
12342 build_desired_tool_bar_string (f
);
12343 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12344 /* FIXME: This should be controlled by a user option. But it
12345 doesn't make sense to have an R2L tool bar if the menu bar cannot
12346 be drawn also R2L, and making the menu bar R2L is tricky due
12347 toolkit-specific code that implements it. If an R2L tool bar is
12348 ever supported, display_tool_bar_line should also be augmented to
12349 call unproduce_glyphs like display_line and display_string
12351 it
.paragraph_embedding
= L2R
;
12353 if (f
->n_tool_bar_rows
== 0)
12355 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12357 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12359 x_change_tool_bar_height (f
, new_height
);
12360 frame_default_tool_bar_height
= new_height
;
12361 /* Always do that now. */
12362 clear_glyph_matrix (w
->desired_matrix
);
12363 f
->fonts_changed
= true;
12368 /* Display as many lines as needed to display all tool-bar items. */
12370 if (f
->n_tool_bar_rows
> 0)
12372 int border
, rows
, height
, extra
;
12374 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12375 border
= XINT (Vtool_bar_border
);
12376 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12377 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12378 else if (EQ (Vtool_bar_border
, Qborder_width
))
12379 border
= f
->border_width
;
12385 rows
= f
->n_tool_bar_rows
;
12386 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12387 extra
= it
.last_visible_y
- border
- height
* rows
;
12389 while (it
.current_y
< it
.last_visible_y
)
12392 if (extra
> 0 && rows
-- > 0)
12394 h
= (extra
+ rows
- 1) / rows
;
12397 display_tool_bar_line (&it
, height
+ h
);
12402 while (it
.current_y
< it
.last_visible_y
)
12403 display_tool_bar_line (&it
, 0);
12406 /* It doesn't make much sense to try scrolling in the tool-bar
12407 window, so don't do it. */
12408 w
->desired_matrix
->no_scrolling_p
= true;
12409 w
->must_be_updated_p
= true;
12411 if (!NILP (Vauto_resize_tool_bars
))
12413 bool change_height_p
= true;
12415 /* If we couldn't display everything, change the tool-bar's
12416 height if there is room for more. */
12417 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12418 change_height_p
= true;
12420 /* We subtract 1 because display_tool_bar_line advances the
12421 glyph_row pointer before returning to its caller. We want to
12422 examine the last glyph row produced by
12423 display_tool_bar_line. */
12424 row
= it
.glyph_row
- 1;
12426 /* If there are blank lines at the end, except for a partially
12427 visible blank line at the end that is smaller than
12428 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12429 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12430 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12431 change_height_p
= true;
12433 /* If row displays tool-bar items, but is partially visible,
12434 change the tool-bar's height. */
12435 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12436 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12437 change_height_p
= true;
12439 /* Resize windows as needed by changing the `tool-bar-lines'
12440 frame parameter. */
12441 if (change_height_p
)
12444 int new_height
= tool_bar_height (f
, &nrows
, true);
12446 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12447 && !f
->minimize_tool_bar_window_p
)
12448 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12449 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12450 f
->minimize_tool_bar_window_p
= false;
12452 if (change_height_p
)
12454 x_change_tool_bar_height (f
, new_height
);
12455 frame_default_tool_bar_height
= new_height
;
12456 clear_glyph_matrix (w
->desired_matrix
);
12457 f
->n_tool_bar_rows
= nrows
;
12458 f
->fonts_changed
= true;
12465 f
->minimize_tool_bar_window_p
= false;
12468 #endif /* USE_GTK || HAVE_NS */
12471 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12473 /* Get information about the tool-bar item which is displayed in GLYPH
12474 on frame F. Return in *PROP_IDX the index where tool-bar item
12475 properties start in F->tool_bar_items. Value is false if
12476 GLYPH doesn't display a tool-bar item. */
12479 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12484 /* This function can be called asynchronously, which means we must
12485 exclude any possibility that Fget_text_property signals an
12487 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12488 charpos
= max (0, charpos
);
12490 /* Get the text property `menu-item' at pos. The value of that
12491 property is the start index of this item's properties in
12492 F->tool_bar_items. */
12493 prop
= Fget_text_property (make_number (charpos
),
12494 Qmenu_item
, f
->current_tool_bar_string
);
12495 if (! INTEGERP (prop
))
12497 *prop_idx
= XINT (prop
);
12502 /* Get information about the tool-bar item at position X/Y on frame F.
12503 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12504 the current matrix of the tool-bar window of F, or NULL if not
12505 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12506 item in F->tool_bar_items. Value is
12508 -1 if X/Y is not on a tool-bar item
12509 0 if X/Y is on the same item that was highlighted before.
12513 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12514 int *hpos
, int *vpos
, int *prop_idx
)
12516 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12517 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12520 /* Find the glyph under X/Y. */
12521 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12522 if (*glyph
== NULL
)
12525 /* Get the start of this tool-bar item's properties in
12526 f->tool_bar_items. */
12527 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12530 /* Is mouse on the highlighted item? */
12531 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12532 && *vpos
>= hlinfo
->mouse_face_beg_row
12533 && *vpos
<= hlinfo
->mouse_face_end_row
12534 && (*vpos
> hlinfo
->mouse_face_beg_row
12535 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12536 && (*vpos
< hlinfo
->mouse_face_end_row
12537 || *hpos
< hlinfo
->mouse_face_end_col
12538 || hlinfo
->mouse_face_past_end
))
12546 Handle mouse button event on the tool-bar of frame F, at
12547 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12548 false for button release. MODIFIERS is event modifiers for button
12552 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12555 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12556 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12557 int hpos
, vpos
, prop_idx
;
12558 struct glyph
*glyph
;
12559 Lisp_Object enabled_p
;
12562 /* If not on the highlighted tool-bar item, and mouse-highlight is
12563 non-nil, return. This is so we generate the tool-bar button
12564 click only when the mouse button is released on the same item as
12565 where it was pressed. However, when mouse-highlight is disabled,
12566 generate the click when the button is released regardless of the
12567 highlight, since tool-bar items are not highlighted in that
12569 frame_to_window_pixel_xy (w
, &x
, &y
);
12570 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12572 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12575 /* When mouse-highlight is off, generate the click for the item
12576 where the button was pressed, disregarding where it was
12578 if (NILP (Vmouse_highlight
) && !down_p
)
12579 prop_idx
= f
->last_tool_bar_item
;
12581 /* If item is disabled, do nothing. */
12582 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12583 if (NILP (enabled_p
))
12588 /* Show item in pressed state. */
12589 if (!NILP (Vmouse_highlight
))
12590 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12591 f
->last_tool_bar_item
= prop_idx
;
12595 Lisp_Object key
, frame
;
12596 struct input_event event
;
12597 EVENT_INIT (event
);
12599 /* Show item in released state. */
12600 if (!NILP (Vmouse_highlight
))
12601 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12603 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12605 XSETFRAME (frame
, f
);
12606 event
.kind
= TOOL_BAR_EVENT
;
12607 event
.frame_or_window
= frame
;
12609 kbd_buffer_store_event (&event
);
12611 event
.kind
= TOOL_BAR_EVENT
;
12612 event
.frame_or_window
= frame
;
12614 event
.modifiers
= modifiers
;
12615 kbd_buffer_store_event (&event
);
12616 f
->last_tool_bar_item
= -1;
12621 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12622 tool-bar window-relative coordinates X/Y. Called from
12623 note_mouse_highlight. */
12626 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12628 Lisp_Object window
= f
->tool_bar_window
;
12629 struct window
*w
= XWINDOW (window
);
12630 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12631 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12633 struct glyph
*glyph
;
12634 struct glyph_row
*row
;
12636 Lisp_Object enabled_p
;
12638 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12642 /* Function note_mouse_highlight is called with negative X/Y
12643 values when mouse moves outside of the frame. */
12644 if (x
<= 0 || y
<= 0)
12646 clear_mouse_face (hlinfo
);
12650 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12653 /* Not on tool-bar item. */
12654 clear_mouse_face (hlinfo
);
12658 /* On same tool-bar item as before. */
12659 goto set_help_echo
;
12661 clear_mouse_face (hlinfo
);
12663 /* Mouse is down, but on different tool-bar item? */
12664 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12665 && f
== dpyinfo
->last_mouse_frame
);
12667 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12670 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12672 /* If tool-bar item is not enabled, don't highlight it. */
12673 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12674 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12676 /* Compute the x-position of the glyph. In front and past the
12677 image is a space. We include this in the highlighted area. */
12678 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12679 for (i
= x
= 0; i
< hpos
; ++i
)
12680 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12682 /* Record this as the current active region. */
12683 hlinfo
->mouse_face_beg_col
= hpos
;
12684 hlinfo
->mouse_face_beg_row
= vpos
;
12685 hlinfo
->mouse_face_beg_x
= x
;
12686 hlinfo
->mouse_face_past_end
= false;
12688 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12689 hlinfo
->mouse_face_end_row
= vpos
;
12690 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12691 hlinfo
->mouse_face_window
= window
;
12692 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12694 /* Display it as active. */
12695 show_mouse_face (hlinfo
, draw
);
12700 /* Set help_echo_string to a help string to display for this tool-bar item.
12701 XTread_socket does the rest. */
12702 help_echo_object
= help_echo_window
= Qnil
;
12703 help_echo_pos
= -1;
12704 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12705 if (NILP (help_echo_string
))
12706 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12709 #endif /* !USE_GTK && !HAVE_NS */
12711 #endif /* HAVE_WINDOW_SYSTEM */
12715 /************************************************************************
12716 Horizontal scrolling
12717 ************************************************************************/
12719 /* For all leaf windows in the window tree rooted at WINDOW, set their
12720 hscroll value so that PT is (i) visible in the window, and (ii) so
12721 that it is not within a certain margin at the window's left and
12722 right border. Value is true if any window's hscroll has been
12726 hscroll_window_tree (Lisp_Object window
)
12728 bool hscrolled_p
= false;
12729 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12730 int hscroll_step_abs
= 0;
12731 double hscroll_step_rel
= 0;
12733 if (hscroll_relative_p
)
12735 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12736 if (hscroll_step_rel
< 0)
12738 hscroll_relative_p
= false;
12739 hscroll_step_abs
= 0;
12742 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12744 hscroll_step_abs
= XINT (Vhscroll_step
);
12745 if (hscroll_step_abs
< 0)
12746 hscroll_step_abs
= 0;
12749 hscroll_step_abs
= 0;
12751 while (WINDOWP (window
))
12753 struct window
*w
= XWINDOW (window
);
12755 if (WINDOWP (w
->contents
))
12756 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12757 else if (w
->cursor
.vpos
>= 0)
12760 int text_area_width
;
12761 struct glyph_row
*cursor_row
;
12762 struct glyph_row
*bottom_row
;
12764 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12765 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12766 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12768 cursor_row
= bottom_row
- 1;
12770 if (!cursor_row
->enabled_p
)
12772 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12773 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12774 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12776 cursor_row
= bottom_row
- 1;
12778 bool row_r2l_p
= cursor_row
->reversed_p
;
12780 text_area_width
= window_box_width (w
, TEXT_AREA
);
12782 /* Scroll when cursor is inside this scroll margin. */
12783 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12785 /* If the position of this window's point has explicitly
12786 changed, no more suspend auto hscrolling. */
12787 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12788 w
->suspend_auto_hscroll
= false;
12790 /* Remember window point. */
12791 Fset_marker (w
->old_pointm
,
12792 ((w
== XWINDOW (selected_window
))
12793 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12794 : Fmarker_position (w
->pointm
)),
12797 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12798 && !w
->suspend_auto_hscroll
12799 /* In some pathological cases, like restoring a window
12800 configuration into a frame that is much smaller than
12801 the one from which the configuration was saved, we
12802 get glyph rows whose start and end have zero buffer
12803 positions, which we cannot handle below. Just skip
12805 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12806 /* For left-to-right rows, hscroll when cursor is either
12807 (i) inside the right hscroll margin, or (ii) if it is
12808 inside the left margin and the window is already
12811 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12812 || (cursor_row
->enabled_p
12813 && cursor_row
->truncated_on_right_p
12814 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12815 /* For right-to-left rows, the logic is similar,
12816 except that rules for scrolling to left and right
12817 are reversed. E.g., if cursor.x <= h_margin, we
12818 need to hscroll "to the right" unconditionally,
12819 and that will scroll the screen to the left so as
12820 to reveal the next portion of the row. */
12822 && ((cursor_row
->enabled_p
12823 /* FIXME: It is confusing to set the
12824 truncated_on_right_p flag when R2L rows
12825 are actually truncated on the left. */
12826 && cursor_row
->truncated_on_right_p
12827 && w
->cursor
.x
<= h_margin
)
12829 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12833 struct buffer
*saved_current_buffer
;
12837 /* Find point in a display of infinite width. */
12838 saved_current_buffer
= current_buffer
;
12839 current_buffer
= XBUFFER (w
->contents
);
12841 if (w
== XWINDOW (selected_window
))
12844 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12846 /* Move iterator to pt starting at cursor_row->start in
12847 a line with infinite width. */
12848 init_to_row_start (&it
, w
, cursor_row
);
12849 it
.last_visible_x
= INFINITY
;
12850 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12851 current_buffer
= saved_current_buffer
;
12853 /* Position cursor in window. */
12854 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12855 hscroll
= max (0, (it
.current_x
12856 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12857 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12858 : (text_area_width
/ 2))))
12859 / FRAME_COLUMN_WIDTH (it
.f
);
12860 else if ((!row_r2l_p
12861 && w
->cursor
.x
>= text_area_width
- h_margin
)
12862 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12864 if (hscroll_relative_p
)
12865 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12868 wanted_x
= text_area_width
12869 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12872 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12876 if (hscroll_relative_p
)
12877 wanted_x
= text_area_width
* hscroll_step_rel
12880 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12883 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12885 hscroll
= max (hscroll
, w
->min_hscroll
);
12887 /* Don't prevent redisplay optimizations if hscroll
12888 hasn't changed, as it will unnecessarily slow down
12890 if (w
->hscroll
!= hscroll
)
12892 struct buffer
*b
= XBUFFER (w
->contents
);
12893 b
->prevent_redisplay_optimizations_p
= true;
12894 w
->hscroll
= hscroll
;
12895 hscrolled_p
= true;
12903 /* Value is true if hscroll of any leaf window has been changed. */
12904 return hscrolled_p
;
12908 /* Set hscroll so that cursor is visible and not inside horizontal
12909 scroll margins for all windows in the tree rooted at WINDOW. See
12910 also hscroll_window_tree above. Value is true if any window's
12911 hscroll has been changed. If it has, desired matrices on the frame
12912 of WINDOW are cleared. */
12915 hscroll_windows (Lisp_Object window
)
12917 bool hscrolled_p
= hscroll_window_tree (window
);
12919 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12920 return hscrolled_p
;
12925 /************************************************************************
12927 ************************************************************************/
12929 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12930 This is sometimes handy to have in a debugger session. */
12934 /* First and last unchanged row for try_window_id. */
12936 static int debug_first_unchanged_at_end_vpos
;
12937 static int debug_last_unchanged_at_beg_vpos
;
12939 /* Delta vpos and y. */
12941 static int debug_dvpos
, debug_dy
;
12943 /* Delta in characters and bytes for try_window_id. */
12945 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12947 /* Values of window_end_pos and window_end_vpos at the end of
12950 static ptrdiff_t debug_end_vpos
;
12952 /* Append a string to W->desired_matrix->method. FMT is a printf
12953 format string. If trace_redisplay_p is true also printf the
12954 resulting string to stderr. */
12956 static void debug_method_add (struct window
*, char const *, ...)
12957 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12960 debug_method_add (struct window
*w
, char const *fmt
, ...)
12963 char *method
= w
->desired_matrix
->method
;
12964 int len
= strlen (method
);
12965 int size
= sizeof w
->desired_matrix
->method
;
12966 int remaining
= size
- len
- 1;
12969 if (len
&& remaining
)
12972 --remaining
, ++len
;
12975 va_start (ap
, fmt
);
12976 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12979 if (trace_redisplay_p
)
12980 fprintf (stderr
, "%p (%s): %s\n",
12982 ((BUFFERP (w
->contents
)
12983 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12984 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12989 #endif /* GLYPH_DEBUG */
12992 /* Value is true if all changes in window W, which displays
12993 current_buffer, are in the text between START and END. START is a
12994 buffer position, END is given as a distance from Z. Used in
12995 redisplay_internal for display optimization. */
12998 text_outside_line_unchanged_p (struct window
*w
,
12999 ptrdiff_t start
, ptrdiff_t end
)
13001 bool unchanged_p
= true;
13003 /* If text or overlays have changed, see where. */
13004 if (window_outdated (w
))
13006 /* Gap in the line? */
13007 if (GPT
< start
|| Z
- GPT
< end
)
13008 unchanged_p
= false;
13010 /* Changes start in front of the line, or end after it? */
13012 && (BEG_UNCHANGED
< start
- 1
13013 || END_UNCHANGED
< end
))
13014 unchanged_p
= false;
13016 /* If selective display, can't optimize if changes start at the
13017 beginning of the line. */
13019 && INTEGERP (BVAR (current_buffer
, selective_display
))
13020 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13021 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13022 unchanged_p
= false;
13024 /* If there are overlays at the start or end of the line, these
13025 may have overlay strings with newlines in them. A change at
13026 START, for instance, may actually concern the display of such
13027 overlay strings as well, and they are displayed on different
13028 lines. So, quickly rule out this case. (For the future, it
13029 might be desirable to implement something more telling than
13030 just BEG/END_UNCHANGED.) */
13033 if (BEG
+ BEG_UNCHANGED
== start
13034 && overlay_touches_p (start
))
13035 unchanged_p
= false;
13036 if (END_UNCHANGED
== end
13037 && overlay_touches_p (Z
- end
))
13038 unchanged_p
= false;
13041 /* Under bidi reordering, adding or deleting a character in the
13042 beginning of a paragraph, before the first strong directional
13043 character, can change the base direction of the paragraph (unless
13044 the buffer specifies a fixed paragraph direction), which will
13045 require to redisplay the whole paragraph. It might be worthwhile
13046 to find the paragraph limits and widen the range of redisplayed
13047 lines to that, but for now just give up this optimization. */
13048 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13049 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13050 unchanged_p
= false;
13053 return unchanged_p
;
13057 /* Do a frame update, taking possible shortcuts into account. This is
13058 the main external entry point for redisplay.
13060 If the last redisplay displayed an echo area message and that message
13061 is no longer requested, we clear the echo area or bring back the
13062 mini-buffer if that is in use. */
13067 redisplay_internal ();
13072 overlay_arrow_string_or_property (Lisp_Object var
)
13076 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13079 return Voverlay_arrow_string
;
13082 /* Return true if there are any overlay-arrows in current_buffer. */
13084 overlay_arrow_in_current_buffer_p (void)
13088 for (vlist
= Voverlay_arrow_variable_list
;
13090 vlist
= XCDR (vlist
))
13092 Lisp_Object var
= XCAR (vlist
);
13095 if (!SYMBOLP (var
))
13097 val
= find_symbol_value (var
);
13099 && current_buffer
== XMARKER (val
)->buffer
)
13106 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13110 overlay_arrows_changed_p (void)
13114 for (vlist
= Voverlay_arrow_variable_list
;
13116 vlist
= XCDR (vlist
))
13118 Lisp_Object var
= XCAR (vlist
);
13119 Lisp_Object val
, pstr
;
13121 if (!SYMBOLP (var
))
13123 val
= find_symbol_value (var
);
13124 if (!MARKERP (val
))
13126 if (! EQ (COERCE_MARKER (val
),
13127 Fget (var
, Qlast_arrow_position
))
13128 || ! (pstr
= overlay_arrow_string_or_property (var
),
13129 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13135 /* Mark overlay arrows to be updated on next redisplay. */
13138 update_overlay_arrows (int up_to_date
)
13142 for (vlist
= Voverlay_arrow_variable_list
;
13144 vlist
= XCDR (vlist
))
13146 Lisp_Object var
= XCAR (vlist
);
13148 if (!SYMBOLP (var
))
13151 if (up_to_date
> 0)
13153 Lisp_Object val
= find_symbol_value (var
);
13154 Fput (var
, Qlast_arrow_position
,
13155 COERCE_MARKER (val
));
13156 Fput (var
, Qlast_arrow_string
,
13157 overlay_arrow_string_or_property (var
));
13159 else if (up_to_date
< 0
13160 || !NILP (Fget (var
, Qlast_arrow_position
)))
13162 Fput (var
, Qlast_arrow_position
, Qt
);
13163 Fput (var
, Qlast_arrow_string
, Qt
);
13169 /* Return overlay arrow string to display at row.
13170 Return integer (bitmap number) for arrow bitmap in left fringe.
13171 Return nil if no overlay arrow. */
13174 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13178 for (vlist
= Voverlay_arrow_variable_list
;
13180 vlist
= XCDR (vlist
))
13182 Lisp_Object var
= XCAR (vlist
);
13185 if (!SYMBOLP (var
))
13188 val
= find_symbol_value (var
);
13191 && current_buffer
== XMARKER (val
)->buffer
13192 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13194 if (FRAME_WINDOW_P (it
->f
)
13195 /* FIXME: if ROW->reversed_p is set, this should test
13196 the right fringe, not the left one. */
13197 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13199 #ifdef HAVE_WINDOW_SYSTEM
13200 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13202 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13203 if (fringe_bitmap
!= 0)
13204 return make_number (fringe_bitmap
);
13207 return make_number (-1); /* Use default arrow bitmap. */
13209 return overlay_arrow_string_or_property (var
);
13216 /* Return true if point moved out of or into a composition. Otherwise
13217 return false. PREV_BUF and PREV_PT are the last point buffer and
13218 position. BUF and PT are the current point buffer and position. */
13221 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13222 struct buffer
*buf
, ptrdiff_t pt
)
13224 ptrdiff_t start
, end
;
13226 Lisp_Object buffer
;
13228 XSETBUFFER (buffer
, buf
);
13229 /* Check a composition at the last point if point moved within the
13231 if (prev_buf
== buf
)
13234 /* Point didn't move. */
13237 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13238 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13239 && composition_valid_p (start
, end
, prop
)
13240 && start
< prev_pt
&& end
> prev_pt
)
13241 /* The last point was within the composition. Return true iff
13242 point moved out of the composition. */
13243 return (pt
<= start
|| pt
>= end
);
13246 /* Check a composition at the current point. */
13247 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13248 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13249 && composition_valid_p (start
, end
, prop
)
13250 && start
< pt
&& end
> pt
);
13253 /* Reconsider the clip changes of buffer which is displayed in W. */
13256 reconsider_clip_changes (struct window
*w
)
13258 struct buffer
*b
= XBUFFER (w
->contents
);
13260 if (b
->clip_changed
13261 && w
->window_end_valid
13262 && w
->current_matrix
->buffer
== b
13263 && w
->current_matrix
->zv
== BUF_ZV (b
)
13264 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13265 b
->clip_changed
= false;
13267 /* If display wasn't paused, and W is not a tool bar window, see if
13268 point has been moved into or out of a composition. In that case,
13269 set b->clip_changed to force updating the screen. If
13270 b->clip_changed has already been set, skip this check. */
13271 if (!b
->clip_changed
&& w
->window_end_valid
)
13273 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13274 ? PT
: marker_position (w
->pointm
));
13276 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13277 && check_point_in_composition (w
->current_matrix
->buffer
,
13278 w
->last_point
, b
, pt
))
13279 b
->clip_changed
= true;
13284 propagate_buffer_redisplay (void)
13285 { /* Resetting b->text->redisplay is problematic!
13286 We can't just reset it in the case that some window that displays
13287 it has not been redisplayed; and such a window can stay
13288 unredisplayed for a long time if it's currently invisible.
13289 But we do want to reset it at the end of redisplay otherwise
13290 its displayed windows will keep being redisplayed over and over
13292 So we copy all b->text->redisplay flags up to their windows here,
13293 such that mark_window_display_accurate can safely reset
13294 b->text->redisplay. */
13295 Lisp_Object ws
= window_list ();
13296 for (; CONSP (ws
); ws
= XCDR (ws
))
13298 struct window
*thisw
= XWINDOW (XCAR (ws
));
13299 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13300 if (thisb
->text
->redisplay
)
13301 thisw
->redisplay
= true;
13305 #define STOP_POLLING \
13306 do { if (! polling_stopped_here) stop_polling (); \
13307 polling_stopped_here = true; } while (false)
13309 #define RESUME_POLLING \
13310 do { if (polling_stopped_here) start_polling (); \
13311 polling_stopped_here = false; } while (false)
13314 /* Perhaps in the future avoid recentering windows if it
13315 is not necessary; currently that causes some problems. */
13318 redisplay_internal (void)
13320 struct window
*w
= XWINDOW (selected_window
);
13324 bool must_finish
= false, match_p
;
13325 struct text_pos tlbufpos
, tlendpos
;
13326 int number_of_visible_frames
;
13329 bool polling_stopped_here
= false;
13330 Lisp_Object tail
, frame
;
13332 /* True means redisplay has to consider all windows on all
13333 frames. False, only selected_window is considered. */
13334 bool consider_all_windows_p
;
13336 /* True means redisplay has to redisplay the miniwindow. */
13337 bool update_miniwindow_p
= false;
13339 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13341 /* No redisplay if running in batch mode or frame is not yet fully
13342 initialized, or redisplay is explicitly turned off by setting
13343 Vinhibit_redisplay. */
13344 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13345 || !NILP (Vinhibit_redisplay
))
13348 /* Don't examine these until after testing Vinhibit_redisplay.
13349 When Emacs is shutting down, perhaps because its connection to
13350 X has dropped, we should not look at them at all. */
13351 fr
= XFRAME (w
->frame
);
13352 sf
= SELECTED_FRAME ();
13354 if (!fr
->glyphs_initialized_p
)
13357 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13358 if (popup_activated ())
13362 /* I don't think this happens but let's be paranoid. */
13363 if (redisplaying_p
)
13366 /* Record a function that clears redisplaying_p
13367 when we leave this function. */
13368 count
= SPECPDL_INDEX ();
13369 record_unwind_protect_void (unwind_redisplay
);
13370 redisplaying_p
= true;
13371 specbind (Qinhibit_free_realized_faces
, Qnil
);
13373 /* Record this function, so it appears on the profiler's backtraces. */
13374 record_in_backtrace (Qredisplay_internal
, 0, 0);
13376 FOR_EACH_FRAME (tail
, frame
)
13377 XFRAME (frame
)->already_hscrolled_p
= false;
13380 /* Remember the currently selected window. */
13384 forget_escape_and_glyphless_faces ();
13386 inhibit_free_realized_faces
= false;
13388 /* If face_change, init_iterator will free all realized faces, which
13389 includes the faces referenced from current matrices. So, we
13390 can't reuse current matrices in this case. */
13392 windows_or_buffers_changed
= 47;
13394 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13395 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13397 /* Since frames on a single ASCII terminal share the same
13398 display area, displaying a different frame means redisplay
13399 the whole thing. */
13400 SET_FRAME_GARBAGED (sf
);
13402 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13404 FRAME_TTY (sf
)->previous_frame
= sf
;
13407 /* Set the visible flags for all frames. Do this before checking for
13408 resized or garbaged frames; they want to know if their frames are
13409 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13410 number_of_visible_frames
= 0;
13412 FOR_EACH_FRAME (tail
, frame
)
13414 struct frame
*f
= XFRAME (frame
);
13416 if (FRAME_VISIBLE_P (f
))
13418 ++number_of_visible_frames
;
13419 /* Adjust matrices for visible frames only. */
13420 if (f
->fonts_changed
)
13422 adjust_frame_glyphs (f
);
13423 /* Disable all redisplay optimizations for this frame.
13424 This is because adjust_frame_glyphs resets the
13425 enabled_p flag for all glyph rows of all windows, so
13426 many optimizations will fail anyway, and some might
13427 fail to test that flag and do bogus things as
13429 SET_FRAME_GARBAGED (f
);
13430 f
->fonts_changed
= false;
13432 /* If cursor type has been changed on the frame
13433 other than selected, consider all frames. */
13434 if (f
!= sf
&& f
->cursor_type_changed
)
13435 fset_redisplay (f
);
13437 clear_desired_matrices (f
);
13440 /* Notice any pending interrupt request to change frame size. */
13441 do_pending_window_change (true);
13443 /* do_pending_window_change could change the selected_window due to
13444 frame resizing which makes the selected window too small. */
13445 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13448 /* Clear frames marked as garbaged. */
13449 clear_garbaged_frames ();
13451 /* Build menubar and tool-bar items. */
13452 if (NILP (Vmemory_full
))
13453 prepare_menu_bars ();
13455 reconsider_clip_changes (w
);
13457 /* In most cases selected window displays current buffer. */
13458 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13461 /* Detect case that we need to write or remove a star in the mode line. */
13462 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13463 w
->update_mode_line
= true;
13465 if (mode_line_update_needed (w
))
13466 w
->update_mode_line
= true;
13468 /* If reconsider_clip_changes above decided that the narrowing
13469 in the current buffer changed, make sure all other windows
13470 showing that buffer will be redisplayed. */
13471 if (current_buffer
->clip_changed
)
13472 bset_update_mode_line (current_buffer
);
13475 /* Normally the message* functions will have already displayed and
13476 updated the echo area, but the frame may have been trashed, or
13477 the update may have been preempted, so display the echo area
13478 again here. Checking message_cleared_p captures the case that
13479 the echo area should be cleared. */
13480 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13481 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13482 || (message_cleared_p
13483 && minibuf_level
== 0
13484 /* If the mini-window is currently selected, this means the
13485 echo-area doesn't show through. */
13486 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13488 echo_area_display (false);
13490 if (message_cleared_p
)
13491 update_miniwindow_p
= true;
13493 must_finish
= true;
13495 /* If we don't display the current message, don't clear the
13496 message_cleared_p flag, because, if we did, we wouldn't clear
13497 the echo area in the next redisplay which doesn't preserve
13499 if (!display_last_displayed_message_p
)
13500 message_cleared_p
= false;
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) \
13535 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13536 if (INTEGERP (entry)) \
13537 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13540 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13541 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13543 /* Optimize the case that only the line containing the cursor in the
13544 selected window has changed. Variables starting with this_ are
13545 set in display_line and record information about the line
13546 containing the cursor. */
13547 tlbufpos
= this_line_start_pos
;
13548 tlendpos
= this_line_end_pos
;
13549 if (!consider_all_windows_p
13550 && CHARPOS (tlbufpos
) > 0
13551 && !w
->update_mode_line
13552 && !current_buffer
->clip_changed
13553 && !current_buffer
->prevent_redisplay_optimizations_p
13554 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13555 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13556 && !XFRAME (w
->frame
)->cursor_type_changed
13557 && !XFRAME (w
->frame
)->face_change
13558 /* Make sure recorded data applies to current buffer, etc. */
13559 && this_line_buffer
== current_buffer
13562 && !w
->optional_new_start
13563 /* Point must be on the line that we have info recorded about. */
13564 && PT
>= CHARPOS (tlbufpos
)
13565 && PT
<= Z
- CHARPOS (tlendpos
)
13566 /* All text outside that line, including its final newline,
13567 must be unchanged. */
13568 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13569 CHARPOS (tlendpos
)))
13571 if (CHARPOS (tlbufpos
) > BEGV
13572 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13573 && (CHARPOS (tlbufpos
) == ZV
13574 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13575 /* Former continuation line has disappeared by becoming empty. */
13577 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13579 /* We have to handle the case of continuation around a
13580 wide-column character (see the comment in indent.c around
13583 For instance, in the following case:
13585 -------- Insert --------
13586 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13587 J_I_ ==> J_I_ `^^' are cursors.
13591 As we have to redraw the line above, we cannot use this
13595 int line_height_before
= this_line_pixel_height
;
13597 /* Note that start_display will handle the case that the
13598 line starting at tlbufpos is a continuation line. */
13599 start_display (&it
, w
, tlbufpos
);
13601 /* Implementation note: It this still necessary? */
13602 if (it
.current_x
!= this_line_start_x
)
13605 TRACE ((stderr
, "trying display optimization 1\n"));
13606 w
->cursor
.vpos
= -1;
13607 overlay_arrow_seen
= false;
13608 it
.vpos
= this_line_vpos
;
13609 it
.current_y
= this_line_y
;
13610 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13611 display_line (&it
);
13613 /* If line contains point, is not continued,
13614 and ends at same distance from eob as before, we win. */
13615 if (w
->cursor
.vpos
>= 0
13616 /* Line is not continued, otherwise this_line_start_pos
13617 would have been set to 0 in display_line. */
13618 && CHARPOS (this_line_start_pos
)
13619 /* Line ends as before. */
13620 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13621 /* Line has same height as before. Otherwise other lines
13622 would have to be shifted up or down. */
13623 && this_line_pixel_height
== line_height_before
)
13625 /* If this is not the window's last line, we must adjust
13626 the charstarts of the lines below. */
13627 if (it
.current_y
< it
.last_visible_y
)
13629 struct glyph_row
*row
13630 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13631 ptrdiff_t delta
, delta_bytes
;
13633 /* We used to distinguish between two cases here,
13634 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13635 when the line ends in a newline or the end of the
13636 buffer's accessible portion. But both cases did
13637 the same, so they were collapsed. */
13639 - CHARPOS (tlendpos
)
13640 - MATRIX_ROW_START_CHARPOS (row
));
13641 delta_bytes
= (Z_BYTE
13642 - BYTEPOS (tlendpos
)
13643 - MATRIX_ROW_START_BYTEPOS (row
));
13645 increment_matrix_positions (w
->current_matrix
,
13646 this_line_vpos
+ 1,
13647 w
->current_matrix
->nrows
,
13648 delta
, delta_bytes
);
13651 /* If this row displays text now but previously didn't,
13652 or vice versa, w->window_end_vpos may have to be
13654 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13656 if (w
->window_end_vpos
< this_line_vpos
)
13657 w
->window_end_vpos
= this_line_vpos
;
13659 else if (w
->window_end_vpos
== this_line_vpos
13660 && this_line_vpos
> 0)
13661 w
->window_end_vpos
= this_line_vpos
- 1;
13662 w
->window_end_valid
= false;
13664 /* Update hint: No need to try to scroll in update_window. */
13665 w
->desired_matrix
->no_scrolling_p
= true;
13668 *w
->desired_matrix
->method
= 0;
13669 debug_method_add (w
, "optimization 1");
13671 #ifdef HAVE_WINDOW_SYSTEM
13672 update_window_fringes (w
, false);
13679 else if (/* Cursor position hasn't changed. */
13680 PT
== w
->last_point
13681 /* Make sure the cursor was last displayed
13682 in this window. Otherwise we have to reposition it. */
13684 /* PXW: Must be converted to pixels, probably. */
13685 && 0 <= w
->cursor
.vpos
13686 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13690 do_pending_window_change (true);
13691 /* If selected_window changed, redisplay again. */
13692 if (WINDOWP (selected_window
)
13693 && (w
= XWINDOW (selected_window
)) != sw
)
13696 /* We used to always goto end_of_redisplay here, but this
13697 isn't enough if we have a blinking cursor. */
13698 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13699 goto end_of_redisplay
;
13703 /* If highlighting the region, or if the cursor is in the echo area,
13704 then we can't just move the cursor. */
13705 else if (NILP (Vshow_trailing_whitespace
)
13706 && !cursor_in_echo_area
)
13709 struct glyph_row
*row
;
13711 /* Skip from tlbufpos to PT and see where it is. Note that
13712 PT may be in invisible text. If so, we will end at the
13713 next visible position. */
13714 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13715 NULL
, DEFAULT_FACE_ID
);
13716 it
.current_x
= this_line_start_x
;
13717 it
.current_y
= this_line_y
;
13718 it
.vpos
= this_line_vpos
;
13720 /* The call to move_it_to stops in front of PT, but
13721 moves over before-strings. */
13722 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13724 if (it
.vpos
== this_line_vpos
13725 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13728 eassert (this_line_vpos
== it
.vpos
);
13729 eassert (this_line_y
== it
.current_y
);
13730 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13732 *w
->desired_matrix
->method
= 0;
13733 debug_method_add (w
, "optimization 3");
13742 /* Text changed drastically or point moved off of line. */
13743 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13746 CHARPOS (this_line_start_pos
) = 0;
13747 ++clear_face_cache_count
;
13748 #ifdef HAVE_WINDOW_SYSTEM
13749 ++clear_image_cache_count
;
13752 /* Build desired matrices, and update the display. If
13753 consider_all_windows_p, do it for all windows on all frames.
13754 Otherwise do it for selected_window, only. */
13756 if (consider_all_windows_p
)
13758 FOR_EACH_FRAME (tail
, frame
)
13759 XFRAME (frame
)->updated_p
= false;
13761 propagate_buffer_redisplay ();
13763 FOR_EACH_FRAME (tail
, frame
)
13765 struct frame
*f
= XFRAME (frame
);
13767 /* We don't have to do anything for unselected terminal
13769 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13770 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13774 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13777 /* Only GC scrollbars when we redisplay the whole frame. */
13778 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13779 /* Mark all the scroll bars to be removed; we'll redeem
13780 the ones we want when we redisplay their windows. */
13781 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13782 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13784 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13785 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13786 /* Remember that the invisible frames need to be redisplayed next
13787 time they're visible. */
13788 else if (!REDISPLAY_SOME_P ())
13789 f
->redisplay
= true;
13791 /* The X error handler may have deleted that frame. */
13792 if (!FRAME_LIVE_P (f
))
13795 /* Any scroll bars which redisplay_windows should have
13796 nuked should now go away. */
13797 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13798 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13800 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13802 /* If fonts changed on visible frame, display again. */
13803 if (f
->fonts_changed
)
13805 adjust_frame_glyphs (f
);
13806 /* Disable all redisplay optimizations for this
13807 frame. For the reasons, see the comment near
13808 the previous call to adjust_frame_glyphs above. */
13809 SET_FRAME_GARBAGED (f
);
13810 f
->fonts_changed
= false;
13814 /* See if we have to hscroll. */
13815 if (!f
->already_hscrolled_p
)
13817 f
->already_hscrolled_p
= true;
13818 if (hscroll_windows (f
->root_window
))
13822 /* Prevent various kinds of signals during display
13823 update. stdio is not robust about handling
13824 signals, which can cause an apparent I/O error. */
13825 if (interrupt_input
)
13826 unrequest_sigio ();
13829 pending
|= update_frame (f
, false, false);
13830 f
->cursor_type_changed
= false;
13831 f
->updated_p
= true;
13836 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13840 /* Do the mark_window_display_accurate after all windows have
13841 been redisplayed because this call resets flags in buffers
13842 which are needed for proper redisplay. */
13843 FOR_EACH_FRAME (tail
, frame
)
13845 struct frame
*f
= XFRAME (frame
);
13848 f
->redisplay
= false;
13849 mark_window_display_accurate (f
->root_window
, true);
13850 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13851 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13856 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13858 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13859 struct frame
*mini_frame
;
13861 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13862 /* Use list_of_error, not Qerror, so that
13863 we catch only errors and don't run the debugger. */
13864 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13866 redisplay_window_error
);
13867 if (update_miniwindow_p
)
13868 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13870 redisplay_window_error
);
13872 /* Compare desired and current matrices, perform output. */
13875 /* If fonts changed, display again. */
13876 if (sf
->fonts_changed
)
13879 /* Prevent freeing of realized faces, since desired matrices are
13880 pending that reference the faces we computed and cached. */
13881 inhibit_free_realized_faces
= true;
13883 /* Prevent various kinds of signals during display update.
13884 stdio is not robust about handling signals,
13885 which can cause an apparent I/O error. */
13886 if (interrupt_input
)
13887 unrequest_sigio ();
13890 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13892 if (hscroll_windows (selected_window
))
13895 XWINDOW (selected_window
)->must_be_updated_p
= true;
13896 pending
= update_frame (sf
, false, false);
13897 sf
->cursor_type_changed
= false;
13900 /* We may have called echo_area_display at the top of this
13901 function. If the echo area is on another frame, that may
13902 have put text on a frame other than the selected one, so the
13903 above call to update_frame would not have caught it. Catch
13905 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13906 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13908 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13910 XWINDOW (mini_window
)->must_be_updated_p
= true;
13911 pending
|= update_frame (mini_frame
, false, false);
13912 mini_frame
->cursor_type_changed
= false;
13913 if (!pending
&& hscroll_windows (mini_window
))
13918 /* If display was paused because of pending input, make sure we do a
13919 thorough update the next time. */
13922 /* Prevent the optimization at the beginning of
13923 redisplay_internal that tries a single-line update of the
13924 line containing the cursor in the selected window. */
13925 CHARPOS (this_line_start_pos
) = 0;
13927 /* Let the overlay arrow be updated the next time. */
13928 update_overlay_arrows (0);
13930 /* If we pause after scrolling, some rows in the current
13931 matrices of some windows are not valid. */
13932 if (!WINDOW_FULL_WIDTH_P (w
)
13933 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13934 update_mode_lines
= 36;
13938 if (!consider_all_windows_p
)
13940 /* This has already been done above if
13941 consider_all_windows_p is set. */
13942 if (XBUFFER (w
->contents
)->text
->redisplay
13943 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13944 /* This can happen if b->text->redisplay was set during
13946 propagate_buffer_redisplay ();
13947 mark_window_display_accurate_1 (w
, true);
13949 /* Say overlay arrows are up to date. */
13950 update_overlay_arrows (1);
13952 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13953 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13956 update_mode_lines
= 0;
13957 windows_or_buffers_changed
= 0;
13960 /* Start SIGIO interrupts coming again. Having them off during the
13961 code above makes it less likely one will discard output, but not
13962 impossible, since there might be stuff in the system buffer here.
13963 But it is much hairier to try to do anything about that. */
13964 if (interrupt_input
)
13968 /* If a frame has become visible which was not before, redisplay
13969 again, so that we display it. Expose events for such a frame
13970 (which it gets when becoming visible) don't call the parts of
13971 redisplay constructing glyphs, so simply exposing a frame won't
13972 display anything in this case. So, we have to display these
13973 frames here explicitly. */
13978 FOR_EACH_FRAME (tail
, frame
)
13980 if (XFRAME (frame
)->visible
)
13984 if (new_count
!= number_of_visible_frames
)
13985 windows_or_buffers_changed
= 52;
13988 /* Change frame size now if a change is pending. */
13989 do_pending_window_change (true);
13991 /* If we just did a pending size change, or have additional
13992 visible frames, or selected_window changed, redisplay again. */
13993 if ((windows_or_buffers_changed
&& !pending
)
13994 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13997 /* Clear the face and image caches.
13999 We used to do this only if consider_all_windows_p. But the cache
14000 needs to be cleared if a timer creates images in the current
14001 buffer (e.g. the test case in Bug#6230). */
14003 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14005 clear_face_cache (false);
14006 clear_face_cache_count
= 0;
14009 #ifdef HAVE_WINDOW_SYSTEM
14010 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14012 clear_image_caches (Qnil
);
14013 clear_image_cache_count
= 0;
14015 #endif /* HAVE_WINDOW_SYSTEM */
14019 ns_set_doc_edited ();
14021 if (interrupt_input
&& interrupts_deferred
)
14024 unbind_to (count
, Qnil
);
14029 /* Redisplay, but leave alone any recent echo area message unless
14030 another message has been requested in its place.
14032 This is useful in situations where you need to redisplay but no
14033 user action has occurred, making it inappropriate for the message
14034 area to be cleared. See tracking_off and
14035 wait_reading_process_output for examples of these situations.
14037 FROM_WHERE is an integer saying from where this function was
14038 called. This is useful for debugging. */
14041 redisplay_preserve_echo_area (int from_where
)
14043 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14045 if (!NILP (echo_area_buffer
[1]))
14047 /* We have a previously displayed message, but no current
14048 message. Redisplay the previous message. */
14049 display_last_displayed_message_p
= true;
14050 redisplay_internal ();
14051 display_last_displayed_message_p
= false;
14054 redisplay_internal ();
14056 flush_frame (SELECTED_FRAME ());
14060 /* Function registered with record_unwind_protect in redisplay_internal. */
14063 unwind_redisplay (void)
14065 redisplaying_p
= false;
14069 /* Mark the display of leaf window W as accurate or inaccurate.
14070 If ACCURATE_P, mark display of W as accurate.
14071 If !ACCURATE_P, arrange for W to be redisplayed the next
14072 time redisplay_internal is called. */
14075 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14077 struct buffer
*b
= XBUFFER (w
->contents
);
14079 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14080 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14081 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14085 b
->clip_changed
= false;
14086 b
->prevent_redisplay_optimizations_p
= false;
14087 eassert (buffer_window_count (b
) > 0);
14088 /* Resetting b->text->redisplay is problematic!
14089 In order to make it safer to do it here, redisplay_internal must
14090 have copied all b->text->redisplay to their respective windows. */
14091 b
->text
->redisplay
= false;
14093 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14094 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14095 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14096 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14098 w
->current_matrix
->buffer
= b
;
14099 w
->current_matrix
->begv
= BUF_BEGV (b
);
14100 w
->current_matrix
->zv
= BUF_ZV (b
);
14102 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14103 w
->last_cursor_off_p
= w
->cursor_off_p
;
14105 if (w
== XWINDOW (selected_window
))
14106 w
->last_point
= BUF_PT (b
);
14108 w
->last_point
= marker_position (w
->pointm
);
14110 w
->window_end_valid
= true;
14111 w
->update_mode_line
= false;
14114 w
->redisplay
= !accurate_p
;
14118 /* Mark the display of windows in the window tree rooted at WINDOW as
14119 accurate or inaccurate. If ACCURATE_P, mark display of
14120 windows as accurate. If !ACCURATE_P, arrange for windows to
14121 be redisplayed the next time redisplay_internal is called. */
14124 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14128 for (; !NILP (window
); window
= w
->next
)
14130 w
= XWINDOW (window
);
14131 if (WINDOWP (w
->contents
))
14132 mark_window_display_accurate (w
->contents
, accurate_p
);
14134 mark_window_display_accurate_1 (w
, accurate_p
);
14138 update_overlay_arrows (1);
14140 /* Force a thorough redisplay the next time by setting
14141 last_arrow_position and last_arrow_string to t, which is
14142 unequal to any useful value of Voverlay_arrow_... */
14143 update_overlay_arrows (-1);
14147 /* Return value in display table DP (Lisp_Char_Table *) for character
14148 C. Since a display table doesn't have any parent, we don't have to
14149 follow parent. Do not call this function directly but use the
14150 macro DISP_CHAR_VECTOR. */
14153 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14157 if (ASCII_CHAR_P (c
))
14160 if (SUB_CHAR_TABLE_P (val
))
14161 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14167 XSETCHAR_TABLE (table
, dp
);
14168 val
= char_table_ref (table
, c
);
14177 /***********************************************************************
14179 ***********************************************************************/
14181 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14184 redisplay_windows (Lisp_Object window
)
14186 while (!NILP (window
))
14188 struct window
*w
= XWINDOW (window
);
14190 if (WINDOWP (w
->contents
))
14191 redisplay_windows (w
->contents
);
14192 else if (BUFFERP (w
->contents
))
14194 displayed_buffer
= XBUFFER (w
->contents
);
14195 /* Use list_of_error, not Qerror, so that
14196 we catch only errors and don't run the debugger. */
14197 internal_condition_case_1 (redisplay_window_0
, window
,
14199 redisplay_window_error
);
14207 redisplay_window_error (Lisp_Object ignore
)
14209 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14214 redisplay_window_0 (Lisp_Object window
)
14216 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14217 redisplay_window (window
, false);
14222 redisplay_window_1 (Lisp_Object window
)
14224 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14225 redisplay_window (window
, true);
14230 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14231 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14232 which positions recorded in ROW differ from current buffer
14235 Return true iff cursor is on this row. */
14238 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14239 struct glyph_matrix
*matrix
,
14240 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14243 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14244 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14245 struct glyph
*cursor
= NULL
;
14246 /* The last known character position in row. */
14247 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14249 ptrdiff_t pt_old
= PT
- delta
;
14250 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14251 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14252 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14253 /* A glyph beyond the edge of TEXT_AREA which we should never
14255 struct glyph
*glyphs_end
= end
;
14256 /* True means we've found a match for cursor position, but that
14257 glyph has the avoid_cursor_p flag set. */
14258 bool match_with_avoid_cursor
= false;
14259 /* True means we've seen at least one glyph that came from a
14261 bool string_seen
= false;
14262 /* Largest and smallest buffer positions seen so far during scan of
14264 ptrdiff_t bpos_max
= pos_before
;
14265 ptrdiff_t bpos_min
= pos_after
;
14266 /* Last buffer position covered by an overlay string with an integer
14267 `cursor' property. */
14268 ptrdiff_t bpos_covered
= 0;
14269 /* True means the display string on which to display the cursor
14270 comes from a text property, not from an overlay. */
14271 bool string_from_text_prop
= false;
14273 /* Don't even try doing anything if called for a mode-line or
14274 header-line row, since the rest of the code isn't prepared to
14275 deal with such calamities. */
14276 eassert (!row
->mode_line_p
);
14277 if (row
->mode_line_p
)
14280 /* Skip over glyphs not having an object at the start and the end of
14281 the row. These are special glyphs like truncation marks on
14282 terminal frames. */
14283 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14285 if (!row
->reversed_p
)
14288 && NILP (glyph
->object
)
14289 && glyph
->charpos
< 0)
14291 x
+= glyph
->pixel_width
;
14295 && NILP ((end
- 1)->object
)
14296 /* CHARPOS is zero for blanks and stretch glyphs
14297 inserted by extend_face_to_end_of_line. */
14298 && (end
- 1)->charpos
<= 0)
14300 glyph_before
= glyph
- 1;
14307 /* If the glyph row is reversed, we need to process it from back
14308 to front, so swap the edge pointers. */
14309 glyphs_end
= end
= glyph
- 1;
14310 glyph
+= row
->used
[TEXT_AREA
] - 1;
14312 while (glyph
> end
+ 1
14313 && NILP (glyph
->object
)
14314 && glyph
->charpos
< 0)
14317 x
-= glyph
->pixel_width
;
14319 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14321 /* By default, in reversed rows we put the cursor on the
14322 rightmost (first in the reading order) glyph. */
14323 for (g
= end
+ 1; g
< glyph
; g
++)
14324 x
+= g
->pixel_width
;
14326 && NILP ((end
+ 1)->object
)
14327 && (end
+ 1)->charpos
<= 0)
14329 glyph_before
= glyph
+ 1;
14333 else if (row
->reversed_p
)
14335 /* In R2L rows that don't display text, put the cursor on the
14336 rightmost glyph. Case in point: an empty last line that is
14337 part of an R2L paragraph. */
14339 /* Avoid placing the cursor on the last glyph of the row, where
14340 on terminal frames we hold the vertical border between
14341 adjacent windows. */
14342 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14343 && !WINDOW_RIGHTMOST_P (w
)
14344 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14346 x
= -1; /* will be computed below, at label compute_x */
14349 /* Step 1: Try to find the glyph whose character position
14350 corresponds to point. If that's not possible, find 2 glyphs
14351 whose character positions are the closest to point, one before
14352 point, the other after it. */
14353 if (!row
->reversed_p
)
14354 while (/* not marched to end of glyph row */
14356 /* glyph was not inserted by redisplay for internal purposes */
14357 && !NILP (glyph
->object
))
14359 if (BUFFERP (glyph
->object
))
14361 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14363 if (glyph
->charpos
> bpos_max
)
14364 bpos_max
= glyph
->charpos
;
14365 if (glyph
->charpos
< bpos_min
)
14366 bpos_min
= glyph
->charpos
;
14367 if (!glyph
->avoid_cursor_p
)
14369 /* If we hit point, we've found the glyph on which to
14370 display the cursor. */
14373 match_with_avoid_cursor
= false;
14376 /* See if we've found a better approximation to
14377 POS_BEFORE or to POS_AFTER. */
14378 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14380 pos_before
= glyph
->charpos
;
14381 glyph_before
= glyph
;
14383 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14385 pos_after
= glyph
->charpos
;
14386 glyph_after
= glyph
;
14389 else if (dpos
== 0)
14390 match_with_avoid_cursor
= true;
14392 else if (STRINGP (glyph
->object
))
14394 Lisp_Object chprop
;
14395 ptrdiff_t glyph_pos
= glyph
->charpos
;
14397 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14399 if (!NILP (chprop
))
14401 /* If the string came from a `display' text property,
14402 look up the buffer position of that property and
14403 use that position to update bpos_max, as if we
14404 actually saw such a position in one of the row's
14405 glyphs. This helps with supporting integer values
14406 of `cursor' property on the display string in
14407 situations where most or all of the row's buffer
14408 text is completely covered by display properties,
14409 so that no glyph with valid buffer positions is
14410 ever seen in the row. */
14411 ptrdiff_t prop_pos
=
14412 string_buffer_position_lim (glyph
->object
, pos_before
,
14415 if (prop_pos
>= pos_before
)
14416 bpos_max
= prop_pos
;
14418 if (INTEGERP (chprop
))
14420 bpos_covered
= bpos_max
+ XINT (chprop
);
14421 /* If the `cursor' property covers buffer positions up
14422 to and including point, we should display cursor on
14423 this glyph. Note that, if a `cursor' property on one
14424 of the string's characters has an integer value, we
14425 will break out of the loop below _before_ we get to
14426 the position match above. IOW, integer values of
14427 the `cursor' property override the "exact match for
14428 point" strategy of positioning the cursor. */
14429 /* Implementation note: bpos_max == pt_old when, e.g.,
14430 we are in an empty line, where bpos_max is set to
14431 MATRIX_ROW_START_CHARPOS, see above. */
14432 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14439 string_seen
= true;
14441 x
+= glyph
->pixel_width
;
14444 else if (glyph
> end
) /* row is reversed */
14445 while (!NILP (glyph
->object
))
14447 if (BUFFERP (glyph
->object
))
14449 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14451 if (glyph
->charpos
> bpos_max
)
14452 bpos_max
= glyph
->charpos
;
14453 if (glyph
->charpos
< bpos_min
)
14454 bpos_min
= glyph
->charpos
;
14455 if (!glyph
->avoid_cursor_p
)
14459 match_with_avoid_cursor
= false;
14462 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14464 pos_before
= glyph
->charpos
;
14465 glyph_before
= glyph
;
14467 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14469 pos_after
= glyph
->charpos
;
14470 glyph_after
= glyph
;
14473 else if (dpos
== 0)
14474 match_with_avoid_cursor
= true;
14476 else if (STRINGP (glyph
->object
))
14478 Lisp_Object chprop
;
14479 ptrdiff_t glyph_pos
= glyph
->charpos
;
14481 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14483 if (!NILP (chprop
))
14485 ptrdiff_t prop_pos
=
14486 string_buffer_position_lim (glyph
->object
, pos_before
,
14489 if (prop_pos
>= pos_before
)
14490 bpos_max
= prop_pos
;
14492 if (INTEGERP (chprop
))
14494 bpos_covered
= bpos_max
+ XINT (chprop
);
14495 /* If the `cursor' property covers buffer positions up
14496 to and including point, we should display cursor on
14498 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14504 string_seen
= true;
14507 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14509 x
--; /* can't use any pixel_width */
14512 x
-= glyph
->pixel_width
;
14515 /* Step 2: If we didn't find an exact match for point, we need to
14516 look for a proper place to put the cursor among glyphs between
14517 GLYPH_BEFORE and GLYPH_AFTER. */
14518 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14519 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14520 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14522 /* An empty line has a single glyph whose OBJECT is nil and
14523 whose CHARPOS is the position of a newline on that line.
14524 Note that on a TTY, there are more glyphs after that, which
14525 were produced by extend_face_to_end_of_line, but their
14526 CHARPOS is zero or negative. */
14527 bool empty_line_p
=
14528 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14529 && NILP (glyph
->object
) && glyph
->charpos
> 0
14530 /* On a TTY, continued and truncated rows also have a glyph at
14531 their end whose OBJECT is nil and whose CHARPOS is
14532 positive (the continuation and truncation glyphs), but such
14533 rows are obviously not "empty". */
14534 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14536 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14538 ptrdiff_t ellipsis_pos
;
14540 /* Scan back over the ellipsis glyphs. */
14541 if (!row
->reversed_p
)
14543 ellipsis_pos
= (glyph
- 1)->charpos
;
14544 while (glyph
> row
->glyphs
[TEXT_AREA
]
14545 && (glyph
- 1)->charpos
== ellipsis_pos
)
14546 glyph
--, x
-= glyph
->pixel_width
;
14547 /* That loop always goes one position too far, including
14548 the glyph before the ellipsis. So scan forward over
14550 x
+= glyph
->pixel_width
;
14553 else /* row is reversed */
14555 ellipsis_pos
= (glyph
+ 1)->charpos
;
14556 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14557 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14558 glyph
++, x
+= glyph
->pixel_width
;
14559 x
-= glyph
->pixel_width
;
14563 else if (match_with_avoid_cursor
)
14565 cursor
= glyph_after
;
14568 else if (string_seen
)
14570 int incr
= row
->reversed_p
? -1 : +1;
14572 /* Need to find the glyph that came out of a string which is
14573 present at point. That glyph is somewhere between
14574 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14575 positioned between POS_BEFORE and POS_AFTER in the
14577 struct glyph
*start
, *stop
;
14578 ptrdiff_t pos
= pos_before
;
14582 /* If the row ends in a newline from a display string,
14583 reordering could have moved the glyphs belonging to the
14584 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14585 in this case we extend the search to the last glyph in
14586 the row that was not inserted by redisplay. */
14587 if (row
->ends_in_newline_from_string_p
)
14590 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14593 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14594 correspond to POS_BEFORE and POS_AFTER, respectively. We
14595 need START and STOP in the order that corresponds to the
14596 row's direction as given by its reversed_p flag. If the
14597 directionality of characters between POS_BEFORE and
14598 POS_AFTER is the opposite of the row's base direction,
14599 these characters will have been reordered for display,
14600 and we need to reverse START and STOP. */
14601 if (!row
->reversed_p
)
14603 start
= min (glyph_before
, glyph_after
);
14604 stop
= max (glyph_before
, glyph_after
);
14608 start
= max (glyph_before
, glyph_after
);
14609 stop
= min (glyph_before
, glyph_after
);
14611 for (glyph
= start
+ incr
;
14612 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14615 /* Any glyphs that come from the buffer are here because
14616 of bidi reordering. Skip them, and only pay
14617 attention to glyphs that came from some string. */
14618 if (STRINGP (glyph
->object
))
14622 /* If the display property covers the newline, we
14623 need to search for it one position farther. */
14624 ptrdiff_t lim
= pos_after
14625 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14627 string_from_text_prop
= false;
14628 str
= glyph
->object
;
14629 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14630 if (tem
== 0 /* from overlay */
14633 /* If the string from which this glyph came is
14634 found in the buffer at point, or at position
14635 that is closer to point than pos_after, then
14636 we've found the glyph we've been looking for.
14637 If it comes from an overlay (tem == 0), and
14638 it has the `cursor' property on one of its
14639 glyphs, record that glyph as a candidate for
14640 displaying the cursor. (As in the
14641 unidirectional version, we will display the
14642 cursor on the last candidate we find.) */
14645 || (tem
- pt_old
> 0 && tem
< pos_after
))
14647 /* The glyphs from this string could have
14648 been reordered. Find the one with the
14649 smallest string position. Or there could
14650 be a character in the string with the
14651 `cursor' property, which means display
14652 cursor on that character's glyph. */
14653 ptrdiff_t strpos
= glyph
->charpos
;
14658 string_from_text_prop
= true;
14661 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14662 && EQ (glyph
->object
, str
);
14666 ptrdiff_t gpos
= glyph
->charpos
;
14668 cprop
= Fget_char_property (make_number (gpos
),
14676 if (tem
&& glyph
->charpos
< strpos
)
14678 strpos
= glyph
->charpos
;
14684 || (tem
- pt_old
> 0 && tem
< pos_after
))
14688 pos
= tem
+ 1; /* don't find previous instances */
14690 /* This string is not what we want; skip all of the
14691 glyphs that came from it. */
14692 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14693 && EQ (glyph
->object
, str
))
14700 /* If we reached the end of the line, and END was from a string,
14701 the cursor is not on this line. */
14703 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14704 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14705 && STRINGP (end
->object
)
14706 && row
->continued_p
)
14709 /* A truncated row may not include PT among its character positions.
14710 Setting the cursor inside the scroll margin will trigger
14711 recalculation of hscroll in hscroll_window_tree. But if a
14712 display string covers point, defer to the string-handling
14713 code below to figure this out. */
14714 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14716 cursor
= glyph_before
;
14719 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14720 /* Zero-width characters produce no glyphs. */
14722 && (row
->reversed_p
14723 ? glyph_after
> glyphs_end
14724 : glyph_after
< glyphs_end
)))
14726 cursor
= glyph_after
;
14732 if (cursor
!= NULL
)
14734 else if (glyph
== glyphs_end
14735 && pos_before
== pos_after
14736 && STRINGP ((row
->reversed_p
14737 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14738 : row
->glyphs
[TEXT_AREA
])->object
))
14740 /* If all the glyphs of this row came from strings, put the
14741 cursor on the first glyph of the row. This avoids having the
14742 cursor outside of the text area in this very rare and hard
14746 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14747 : row
->glyphs
[TEXT_AREA
];
14753 /* Need to compute x that corresponds to GLYPH. */
14754 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14756 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14758 x
+= g
->pixel_width
;
14762 /* ROW could be part of a continued line, which, under bidi
14763 reordering, might have other rows whose start and end charpos
14764 occlude point. Only set w->cursor if we found a better
14765 approximation to the cursor position than we have from previously
14766 examined candidate rows belonging to the same continued line. */
14767 if (/* We already have a candidate row. */
14768 w
->cursor
.vpos
>= 0
14769 /* That candidate is not the row we are processing. */
14770 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14771 /* Make sure cursor.vpos specifies a row whose start and end
14772 charpos occlude point, and it is valid candidate for being a
14773 cursor-row. This is because some callers of this function
14774 leave cursor.vpos at the row where the cursor was displayed
14775 during the last redisplay cycle. */
14776 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14777 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14778 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14781 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14783 /* Don't consider glyphs that are outside TEXT_AREA. */
14784 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14786 /* Keep the candidate whose buffer position is the closest to
14787 point or has the `cursor' property. */
14788 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14789 w
->cursor
.hpos
>= 0
14790 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14791 && ((BUFFERP (g1
->object
)
14792 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14793 || (BUFFERP (glyph
->object
)
14794 && eabs (g1
->charpos
- pt_old
)
14795 < eabs (glyph
->charpos
- pt_old
))))
14796 /* Previous candidate is a glyph from a string that has
14797 a non-nil `cursor' property. */
14798 || (STRINGP (g1
->object
)
14799 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14800 Qcursor
, g1
->object
))
14801 /* Previous candidate is from the same display
14802 string as this one, and the display string
14803 came from a text property. */
14804 || (EQ (g1
->object
, glyph
->object
)
14805 && string_from_text_prop
)
14806 /* this candidate is from newline and its
14807 position is not an exact match */
14808 || (NILP (glyph
->object
)
14809 && glyph
->charpos
!= pt_old
)))))
14811 /* If this candidate gives an exact match, use that. */
14812 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14813 /* If this candidate is a glyph created for the
14814 terminating newline of a line, and point is on that
14815 newline, it wins because it's an exact match. */
14816 || (!row
->continued_p
14817 && NILP (glyph
->object
)
14818 && glyph
->charpos
== 0
14819 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14820 /* Otherwise, keep the candidate that comes from a row
14821 spanning less buffer positions. This may win when one or
14822 both candidate positions are on glyphs that came from
14823 display strings, for which we cannot compare buffer
14825 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14826 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14827 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14830 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14832 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14833 w
->cursor
.y
= row
->y
+ dy
;
14835 if (w
== XWINDOW (selected_window
))
14837 if (!row
->continued_p
14838 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14841 this_line_buffer
= XBUFFER (w
->contents
);
14843 CHARPOS (this_line_start_pos
)
14844 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14845 BYTEPOS (this_line_start_pos
)
14846 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14848 CHARPOS (this_line_end_pos
)
14849 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14850 BYTEPOS (this_line_end_pos
)
14851 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14853 this_line_y
= w
->cursor
.y
;
14854 this_line_pixel_height
= row
->height
;
14855 this_line_vpos
= w
->cursor
.vpos
;
14856 this_line_start_x
= row
->x
;
14859 CHARPOS (this_line_start_pos
) = 0;
14866 /* Run window scroll functions, if any, for WINDOW with new window
14867 start STARTP. Sets the window start of WINDOW to that position.
14869 We assume that the window's buffer is really current. */
14871 static struct text_pos
14872 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14874 struct window
*w
= XWINDOW (window
);
14875 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14877 eassert (current_buffer
== XBUFFER (w
->contents
));
14879 if (!NILP (Vwindow_scroll_functions
))
14881 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14882 make_number (CHARPOS (startp
)));
14883 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14884 /* In case the hook functions switch buffers. */
14885 set_buffer_internal (XBUFFER (w
->contents
));
14892 /* Make sure the line containing the cursor is fully visible.
14893 A value of true means there is nothing to be done.
14894 (Either the line is fully visible, or it cannot be made so,
14895 or we cannot tell.)
14897 If FORCE_P, return false even if partial visible cursor row
14898 is higher than window.
14900 If CURRENT_MATRIX_P, use the information from the
14901 window's current glyph matrix; otherwise use the desired glyph
14904 A value of false means the caller should do scrolling
14905 as if point had gone off the screen. */
14908 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14909 bool current_matrix_p
)
14911 struct glyph_matrix
*matrix
;
14912 struct glyph_row
*row
;
14915 if (!make_cursor_line_fully_visible_p
)
14918 /* It's not always possible to find the cursor, e.g, when a window
14919 is full of overlay strings. Don't do anything in that case. */
14920 if (w
->cursor
.vpos
< 0)
14923 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14924 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14926 /* If the cursor row is not partially visible, there's nothing to do. */
14927 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14930 /* If the row the cursor is in is taller than the window's height,
14931 it's not clear what to do, so do nothing. */
14932 window_height
= window_box_height (w
);
14933 if (row
->height
>= window_height
)
14935 if (!force_p
|| MINI_WINDOW_P (w
)
14936 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14943 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14944 means only WINDOW is redisplayed in redisplay_internal.
14945 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14946 in redisplay_window to bring a partially visible line into view in
14947 the case that only the cursor has moved.
14949 LAST_LINE_MISFIT should be true if we're scrolling because the
14950 last screen line's vertical height extends past the end of the screen.
14954 1 if scrolling succeeded
14956 0 if scrolling didn't find point.
14958 -1 if new fonts have been loaded so that we must interrupt
14959 redisplay, adjust glyph matrices, and try again. */
14965 SCROLLING_NEED_LARGER_MATRICES
14968 /* If scroll-conservatively is more than this, never recenter.
14970 If you change this, don't forget to update the doc string of
14971 `scroll-conservatively' and the Emacs manual. */
14972 #define SCROLL_LIMIT 100
14975 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14976 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14977 bool temp_scroll_step
, bool last_line_misfit
)
14979 struct window
*w
= XWINDOW (window
);
14980 struct frame
*f
= XFRAME (w
->frame
);
14981 struct text_pos pos
, startp
;
14983 int this_scroll_margin
, scroll_max
, rc
, height
;
14984 int dy
= 0, amount_to_scroll
= 0;
14985 bool scroll_down_p
= false;
14986 int extra_scroll_margin_lines
= last_line_misfit
;
14987 Lisp_Object aggressive
;
14988 /* We will never try scrolling more than this number of lines. */
14989 int scroll_limit
= SCROLL_LIMIT
;
14990 int frame_line_height
= default_line_pixel_height (w
);
14991 int window_total_lines
14992 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14995 debug_method_add (w
, "try_scrolling");
14998 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15000 /* Compute scroll margin height in pixels. We scroll when point is
15001 within this distance from the top or bottom of the window. */
15002 if (scroll_margin
> 0)
15003 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15004 * frame_line_height
;
15006 this_scroll_margin
= 0;
15008 /* Force arg_scroll_conservatively to have a reasonable value, to
15009 avoid scrolling too far away with slow move_it_* functions. Note
15010 that the user can supply scroll-conservatively equal to
15011 `most-positive-fixnum', which can be larger than INT_MAX. */
15012 if (arg_scroll_conservatively
> scroll_limit
)
15014 arg_scroll_conservatively
= scroll_limit
+ 1;
15015 scroll_max
= scroll_limit
* frame_line_height
;
15017 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15018 /* Compute how much we should try to scroll maximally to bring
15019 point into view. */
15020 scroll_max
= (max (scroll_step
,
15021 max (arg_scroll_conservatively
, temp_scroll_step
))
15022 * frame_line_height
);
15023 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15024 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15025 /* We're trying to scroll because of aggressive scrolling but no
15026 scroll_step is set. Choose an arbitrary one. */
15027 scroll_max
= 10 * frame_line_height
;
15033 /* Decide whether to scroll down. */
15034 if (PT
> CHARPOS (startp
))
15036 int scroll_margin_y
;
15038 /* Compute the pixel ypos of the scroll margin, then move IT to
15039 either that ypos or PT, whichever comes first. */
15040 start_display (&it
, w
, startp
);
15041 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15042 - frame_line_height
* extra_scroll_margin_lines
;
15043 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15044 (MOVE_TO_POS
| MOVE_TO_Y
));
15046 if (PT
> CHARPOS (it
.current
.pos
))
15048 int y0
= line_bottom_y (&it
);
15049 /* Compute how many pixels below window bottom to stop searching
15050 for PT. This avoids costly search for PT that is far away if
15051 the user limited scrolling by a small number of lines, but
15052 always finds PT if scroll_conservatively is set to a large
15053 number, such as most-positive-fixnum. */
15054 int slack
= max (scroll_max
, 10 * frame_line_height
);
15055 int y_to_move
= it
.last_visible_y
+ slack
;
15057 /* Compute the distance from the scroll margin to PT or to
15058 the scroll limit, whichever comes first. This should
15059 include the height of the cursor line, to make that line
15061 move_it_to (&it
, PT
, -1, y_to_move
,
15062 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15063 dy
= line_bottom_y (&it
) - y0
;
15065 if (dy
> scroll_max
)
15066 return SCROLLING_FAILED
;
15069 scroll_down_p
= true;
15075 /* Point is in or below the bottom scroll margin, so move the
15076 window start down. If scrolling conservatively, move it just
15077 enough down to make point visible. If scroll_step is set,
15078 move it down by scroll_step. */
15079 if (arg_scroll_conservatively
)
15081 = min (max (dy
, frame_line_height
),
15082 frame_line_height
* arg_scroll_conservatively
);
15083 else if (scroll_step
|| temp_scroll_step
)
15084 amount_to_scroll
= scroll_max
;
15087 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15088 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15089 if (NUMBERP (aggressive
))
15091 double float_amount
= XFLOATINT (aggressive
) * height
;
15092 int aggressive_scroll
= float_amount
;
15093 if (aggressive_scroll
== 0 && float_amount
> 0)
15094 aggressive_scroll
= 1;
15095 /* Don't let point enter the scroll margin near top of
15096 the window. This could happen if the value of
15097 scroll_up_aggressively is too large and there are
15098 non-zero margins, because scroll_up_aggressively
15099 means put point that fraction of window height
15100 _from_the_bottom_margin_. */
15101 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15102 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15103 amount_to_scroll
= dy
+ aggressive_scroll
;
15107 if (amount_to_scroll
<= 0)
15108 return SCROLLING_FAILED
;
15110 start_display (&it
, w
, startp
);
15111 if (arg_scroll_conservatively
<= scroll_limit
)
15112 move_it_vertically (&it
, amount_to_scroll
);
15115 /* Extra precision for users who set scroll-conservatively
15116 to a large number: make sure the amount we scroll
15117 the window start is never less than amount_to_scroll,
15118 which was computed as distance from window bottom to
15119 point. This matters when lines at window top and lines
15120 below window bottom have different height. */
15122 void *it1data
= NULL
;
15123 /* We use a temporary it1 because line_bottom_y can modify
15124 its argument, if it moves one line down; see there. */
15127 SAVE_IT (it1
, it
, it1data
);
15128 start_y
= line_bottom_y (&it1
);
15130 RESTORE_IT (&it
, &it
, it1data
);
15131 move_it_by_lines (&it
, 1);
15132 SAVE_IT (it1
, it
, it1data
);
15133 } while (IT_CHARPOS (it
) < ZV
15134 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15135 bidi_unshelve_cache (it1data
, true);
15138 /* If STARTP is unchanged, move it down another screen line. */
15139 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15140 move_it_by_lines (&it
, 1);
15141 startp
= it
.current
.pos
;
15145 struct text_pos scroll_margin_pos
= startp
;
15148 /* See if point is inside the scroll margin at the top of the
15150 if (this_scroll_margin
)
15154 start_display (&it
, w
, startp
);
15155 y_start
= it
.current_y
;
15156 move_it_vertically (&it
, this_scroll_margin
);
15157 scroll_margin_pos
= it
.current
.pos
;
15158 /* If we didn't move enough before hitting ZV, request
15159 additional amount of scroll, to move point out of the
15161 if (IT_CHARPOS (it
) == ZV
15162 && it
.current_y
- y_start
< this_scroll_margin
)
15163 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15166 if (PT
< CHARPOS (scroll_margin_pos
))
15168 /* Point is in the scroll margin at the top of the window or
15169 above what is displayed in the window. */
15172 /* Compute the vertical distance from PT to the scroll
15173 margin position. Move as far as scroll_max allows, or
15174 one screenful, or 10 screen lines, whichever is largest.
15175 Give up if distance is greater than scroll_max or if we
15176 didn't reach the scroll margin position. */
15177 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15178 start_display (&it
, w
, pos
);
15180 y_to_move
= max (it
.last_visible_y
,
15181 max (scroll_max
, 10 * frame_line_height
));
15182 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15184 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15185 dy
= it
.current_y
- y0
;
15186 if (dy
> scroll_max
15187 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15188 return SCROLLING_FAILED
;
15190 /* Additional scroll for when ZV was too close to point. */
15193 /* Compute new window start. */
15194 start_display (&it
, w
, startp
);
15196 if (arg_scroll_conservatively
)
15197 amount_to_scroll
= max (dy
, frame_line_height
15198 * max (scroll_step
, temp_scroll_step
));
15199 else if (scroll_step
|| temp_scroll_step
)
15200 amount_to_scroll
= scroll_max
;
15203 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15204 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15205 if (NUMBERP (aggressive
))
15207 double float_amount
= XFLOATINT (aggressive
) * height
;
15208 int aggressive_scroll
= float_amount
;
15209 if (aggressive_scroll
== 0 && float_amount
> 0)
15210 aggressive_scroll
= 1;
15211 /* Don't let point enter the scroll margin near
15212 bottom of the window, if the value of
15213 scroll_down_aggressively happens to be too
15215 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15216 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15217 amount_to_scroll
= dy
+ aggressive_scroll
;
15221 if (amount_to_scroll
<= 0)
15222 return SCROLLING_FAILED
;
15224 move_it_vertically_backward (&it
, amount_to_scroll
);
15225 startp
= it
.current
.pos
;
15229 /* Run window scroll functions. */
15230 startp
= run_window_scroll_functions (window
, startp
);
15232 /* Display the window. Give up if new fonts are loaded, or if point
15234 if (!try_window (window
, startp
, 0))
15235 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15236 else if (w
->cursor
.vpos
< 0)
15238 clear_glyph_matrix (w
->desired_matrix
);
15239 rc
= SCROLLING_FAILED
;
15243 /* Maybe forget recorded base line for line number display. */
15244 if (!just_this_one_p
15245 || current_buffer
->clip_changed
15246 || BEG_UNCHANGED
< CHARPOS (startp
))
15247 w
->base_line_number
= 0;
15249 /* If cursor ends up on a partially visible line,
15250 treat that as being off the bottom of the screen. */
15251 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15253 /* It's possible that the cursor is on the first line of the
15254 buffer, which is partially obscured due to a vscroll
15255 (Bug#7537). In that case, avoid looping forever. */
15256 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15258 clear_glyph_matrix (w
->desired_matrix
);
15259 ++extra_scroll_margin_lines
;
15262 rc
= SCROLLING_SUCCESS
;
15269 /* Compute a suitable window start for window W if display of W starts
15270 on a continuation line. Value is true if a new window start
15273 The new window start will be computed, based on W's width, starting
15274 from the start of the continued line. It is the start of the
15275 screen line with the minimum distance from the old start W->start. */
15278 compute_window_start_on_continuation_line (struct window
*w
)
15280 struct text_pos pos
, start_pos
;
15281 bool window_start_changed_p
= false;
15283 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15285 /* If window start is on a continuation line... Window start may be
15286 < BEGV in case there's invisible text at the start of the
15287 buffer (M-x rmail, for example). */
15288 if (CHARPOS (start_pos
) > BEGV
15289 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15292 struct glyph_row
*row
;
15294 /* Handle the case that the window start is out of range. */
15295 if (CHARPOS (start_pos
) < BEGV
)
15296 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15297 else if (CHARPOS (start_pos
) > ZV
)
15298 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15300 /* Find the start of the continued line. This should be fast
15301 because find_newline is fast (newline cache). */
15302 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15303 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15304 row
, DEFAULT_FACE_ID
);
15305 reseat_at_previous_visible_line_start (&it
);
15307 /* If the line start is "too far" away from the window start,
15308 say it takes too much time to compute a new window start. */
15309 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15310 /* PXW: Do we need upper bounds here? */
15311 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15313 int min_distance
, distance
;
15315 /* Move forward by display lines to find the new window
15316 start. If window width was enlarged, the new start can
15317 be expected to be > the old start. If window width was
15318 decreased, the new window start will be < the old start.
15319 So, we're looking for the display line start with the
15320 minimum distance from the old window start. */
15321 pos
= it
.current
.pos
;
15322 min_distance
= INFINITY
;
15323 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15324 distance
< min_distance
)
15326 min_distance
= distance
;
15327 pos
= it
.current
.pos
;
15328 if (it
.line_wrap
== WORD_WRAP
)
15330 /* Under WORD_WRAP, move_it_by_lines is likely to
15331 overshoot and stop not at the first, but the
15332 second character from the left margin. So in
15333 that case, we need a more tight control on the X
15334 coordinate of the iterator than move_it_by_lines
15335 promises in its contract. The method is to first
15336 go to the last (rightmost) visible character of a
15337 line, then move to the leftmost character on the
15338 next line in a separate call. */
15339 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15340 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15341 move_it_to (&it
, ZV
, 0,
15342 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15343 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15346 move_it_by_lines (&it
, 1);
15349 /* Set the window start there. */
15350 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15351 window_start_changed_p
= true;
15355 return window_start_changed_p
;
15359 /* Try cursor movement in case text has not changed in window WINDOW,
15360 with window start STARTP. Value is
15362 CURSOR_MOVEMENT_SUCCESS if successful
15364 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15366 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15367 display. *SCROLL_STEP is set to true, under certain circumstances, if
15368 we want to scroll as if scroll-step were set to 1. See the code.
15370 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15371 which case we have to abort this redisplay, and adjust matrices
15376 CURSOR_MOVEMENT_SUCCESS
,
15377 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15378 CURSOR_MOVEMENT_MUST_SCROLL
,
15379 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15383 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15386 struct window
*w
= XWINDOW (window
);
15387 struct frame
*f
= XFRAME (w
->frame
);
15388 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15391 if (inhibit_try_cursor_movement
)
15395 /* Previously, there was a check for Lisp integer in the
15396 if-statement below. Now, this field is converted to
15397 ptrdiff_t, thus zero means invalid position in a buffer. */
15398 eassert (w
->last_point
> 0);
15399 /* Likewise there was a check whether window_end_vpos is nil or larger
15400 than the window. Now window_end_vpos is int and so never nil, but
15401 let's leave eassert to check whether it fits in the window. */
15402 eassert (!w
->window_end_valid
15403 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15405 /* Handle case where text has not changed, only point, and it has
15406 not moved off the frame. */
15407 if (/* Point may be in this window. */
15408 PT
>= CHARPOS (startp
)
15409 /* Selective display hasn't changed. */
15410 && !current_buffer
->clip_changed
15411 /* Function force-mode-line-update is used to force a thorough
15412 redisplay. It sets either windows_or_buffers_changed or
15413 update_mode_lines. So don't take a shortcut here for these
15415 && !update_mode_lines
15416 && !windows_or_buffers_changed
15417 && !f
->cursor_type_changed
15418 && NILP (Vshow_trailing_whitespace
)
15419 /* This code is not used for mini-buffer for the sake of the case
15420 of redisplaying to replace an echo area message; since in
15421 that case the mini-buffer contents per se are usually
15422 unchanged. This code is of no real use in the mini-buffer
15423 since the handling of this_line_start_pos, etc., in redisplay
15424 handles the same cases. */
15425 && !EQ (window
, minibuf_window
)
15426 && (FRAME_WINDOW_P (f
)
15427 || !overlay_arrow_in_current_buffer_p ()))
15429 int this_scroll_margin
, top_scroll_margin
;
15430 struct glyph_row
*row
= NULL
;
15431 int frame_line_height
= default_line_pixel_height (w
);
15432 int window_total_lines
15433 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15436 debug_method_add (w
, "cursor movement");
15439 /* Scroll if point within this distance from the top or bottom
15440 of the window. This is a pixel value. */
15441 if (scroll_margin
> 0)
15443 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15444 this_scroll_margin
*= frame_line_height
;
15447 this_scroll_margin
= 0;
15449 top_scroll_margin
= this_scroll_margin
;
15450 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15451 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15453 /* Start with the row the cursor was displayed during the last
15454 not paused redisplay. Give up if that row is not valid. */
15455 if (w
->last_cursor_vpos
< 0
15456 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15457 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15460 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15461 if (row
->mode_line_p
)
15463 if (!row
->enabled_p
)
15464 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15467 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15469 bool scroll_p
= false, must_scroll
= false;
15470 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15472 if (PT
> w
->last_point
)
15474 /* Point has moved forward. */
15475 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15476 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15478 eassert (row
->enabled_p
);
15482 /* If the end position of a row equals the start
15483 position of the next row, and PT is at that position,
15484 we would rather display cursor in the next line. */
15485 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15486 && MATRIX_ROW_END_CHARPOS (row
) == PT
15487 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15488 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15489 && !cursor_row_p (row
))
15492 /* If within the scroll margin, scroll. Note that
15493 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15494 the next line would be drawn, and that
15495 this_scroll_margin can be zero. */
15496 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15497 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15498 /* Line is completely visible last line in window
15499 and PT is to be set in the next line. */
15500 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15501 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15502 && !row
->ends_at_zv_p
15503 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15506 else if (PT
< w
->last_point
)
15508 /* Cursor has to be moved backward. Note that PT >=
15509 CHARPOS (startp) because of the outer if-statement. */
15510 while (!row
->mode_line_p
15511 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15512 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15513 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15514 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15515 row
> w
->current_matrix
->rows
15516 && (row
-1)->ends_in_newline_from_string_p
))))
15517 && (row
->y
> top_scroll_margin
15518 || CHARPOS (startp
) == BEGV
))
15520 eassert (row
->enabled_p
);
15524 /* Consider the following case: Window starts at BEGV,
15525 there is invisible, intangible text at BEGV, so that
15526 display starts at some point START > BEGV. It can
15527 happen that we are called with PT somewhere between
15528 BEGV and START. Try to handle that case. */
15529 if (row
< w
->current_matrix
->rows
15530 || row
->mode_line_p
)
15532 row
= w
->current_matrix
->rows
;
15533 if (row
->mode_line_p
)
15537 /* Due to newlines in overlay strings, we may have to
15538 skip forward over overlay strings. */
15539 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15540 && MATRIX_ROW_END_CHARPOS (row
) == PT
15541 && !cursor_row_p (row
))
15544 /* If within the scroll margin, scroll. */
15545 if (row
->y
< top_scroll_margin
15546 && CHARPOS (startp
) != BEGV
)
15551 /* Cursor did not move. So don't scroll even if cursor line
15552 is partially visible, as it was so before. */
15553 rc
= CURSOR_MOVEMENT_SUCCESS
;
15556 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15557 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15559 /* if PT is not in the glyph row, give up. */
15560 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15561 must_scroll
= true;
15563 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15564 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15566 struct glyph_row
*row1
;
15568 /* If rows are bidi-reordered and point moved, back up
15569 until we find a row that does not belong to a
15570 continuation line. This is because we must consider
15571 all rows of a continued line as candidates for the
15572 new cursor positioning, since row start and end
15573 positions change non-linearly with vertical position
15575 /* FIXME: Revisit this when glyph ``spilling'' in
15576 continuation lines' rows is implemented for
15577 bidi-reordered rows. */
15578 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15579 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15582 /* If we hit the beginning of the displayed portion
15583 without finding the first row of a continued
15587 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15590 eassert (row
->enabled_p
);
15595 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15596 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15597 /* Make sure this isn't a header line by any chance, since
15598 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15599 && !row
->mode_line_p
15600 && make_cursor_line_fully_visible_p
)
15602 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15603 && !row
->ends_at_zv_p
15604 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15605 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15606 else if (row
->height
> window_box_height (w
))
15608 /* If we end up in a partially visible line, let's
15609 make it fully visible, except when it's taller
15610 than the window, in which case we can't do much
15612 *scroll_step
= true;
15613 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15617 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15618 if (!cursor_row_fully_visible_p (w
, false, true))
15619 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15621 rc
= CURSOR_MOVEMENT_SUCCESS
;
15625 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15626 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15627 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15629 /* With bidi-reordered rows, there could be more than
15630 one candidate row whose start and end positions
15631 occlude point. We need to let set_cursor_from_row
15632 find the best candidate. */
15633 /* FIXME: Revisit this when glyph ``spilling'' in
15634 continuation lines' rows is implemented for
15635 bidi-reordered rows. */
15640 bool at_zv_p
= false, exact_match_p
= false;
15642 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15643 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15644 && cursor_row_p (row
))
15645 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15647 /* As soon as we've found the exact match for point,
15648 or the first suitable row whose ends_at_zv_p flag
15649 is set, we are done. */
15652 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15653 w
->cursor
.vpos
)->ends_at_zv_p
;
15655 && w
->cursor
.hpos
>= 0
15656 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15659 struct glyph_row
*candidate
=
15660 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15662 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15663 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15666 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15667 || (NILP (g
->object
)
15668 && (g
->charpos
== PT
15669 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15671 if (at_zv_p
|| exact_match_p
)
15673 rc
= CURSOR_MOVEMENT_SUCCESS
;
15677 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15681 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15682 || row
->continued_p
)
15683 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15684 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15685 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15686 /* If we didn't find any candidate rows, or exited the
15687 loop before all the candidates were examined, signal
15688 to the caller that this method failed. */
15689 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15691 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15692 && !row
->continued_p
))
15693 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15695 rc
= CURSOR_MOVEMENT_SUCCESS
;
15701 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15703 rc
= CURSOR_MOVEMENT_SUCCESS
;
15708 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15709 && MATRIX_ROW_START_CHARPOS (row
) == PT
15710 && cursor_row_p (row
));
15720 set_vertical_scroll_bar (struct window
*w
)
15722 ptrdiff_t start
, end
, whole
;
15724 /* Calculate the start and end positions for the current window.
15725 At some point, it would be nice to choose between scrollbars
15726 which reflect the whole buffer size, with special markers
15727 indicating narrowing, and scrollbars which reflect only the
15730 Note that mini-buffers sometimes aren't displaying any text. */
15731 if (!MINI_WINDOW_P (w
)
15732 || (w
== XWINDOW (minibuf_window
)
15733 && NILP (echo_area_buffer
[0])))
15735 struct buffer
*buf
= XBUFFER (w
->contents
);
15736 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15737 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15738 /* I don't think this is guaranteed to be right. For the
15739 moment, we'll pretend it is. */
15740 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15744 if (whole
< (end
- start
))
15745 whole
= end
- start
;
15748 start
= end
= whole
= 0;
15750 /* Indicate what this scroll bar ought to be displaying now. */
15751 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15752 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15753 (w
, end
- start
, whole
, start
);
15758 set_horizontal_scroll_bar (struct window
*w
)
15760 int start
, end
, whole
, portion
;
15762 if (!MINI_WINDOW_P (w
)
15763 || (w
== XWINDOW (minibuf_window
)
15764 && NILP (echo_area_buffer
[0])))
15766 struct buffer
*b
= XBUFFER (w
->contents
);
15767 struct buffer
*old_buffer
= NULL
;
15769 struct text_pos startp
;
15771 if (b
!= current_buffer
)
15773 old_buffer
= current_buffer
;
15774 set_buffer_internal (b
);
15777 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15778 start_display (&it
, w
, startp
);
15779 it
.last_visible_x
= INT_MAX
;
15780 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15781 MOVE_TO_X
| MOVE_TO_Y
);
15782 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15783 window_box_height (w), -1,
15784 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15786 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15787 end
= start
+ window_box_width (w
, TEXT_AREA
);
15788 portion
= end
- start
;
15789 /* After enlarging a horizontally scrolled window such that it
15790 gets at least as wide as the text it contains, make sure that
15791 the thumb doesn't fill the entire scroll bar so we can still
15792 drag it back to see the entire text. */
15793 whole
= max (whole
, end
);
15799 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15800 if (EQ (pdir
, Qright_to_left
))
15802 start
= whole
- end
;
15803 end
= start
+ portion
;
15808 set_buffer_internal (old_buffer
);
15811 start
= end
= whole
= portion
= 0;
15813 w
->hscroll_whole
= whole
;
15815 /* Indicate what this scroll bar ought to be displaying now. */
15816 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15817 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15818 (w
, portion
, whole
, start
);
15822 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15823 selected_window is redisplayed.
15825 We can return without actually redisplaying the window if fonts has been
15826 changed on window's frame. In that case, redisplay_internal will retry.
15828 As one of the important parts of redisplaying a window, we need to
15829 decide whether the previous window-start position (stored in the
15830 window's w->start marker position) is still valid, and if it isn't,
15831 recompute it. Some details about that:
15833 . The previous window-start could be in a continuation line, in
15834 which case we need to recompute it when the window width
15835 changes. See compute_window_start_on_continuation_line and its
15838 . The text that changed since last redisplay could include the
15839 previous window-start position. In that case, we try to salvage
15840 what we can from the current glyph matrix by calling
15841 try_scrolling, which see.
15843 . Some Emacs command could force us to use a specific window-start
15844 position by setting the window's force_start flag, or gently
15845 propose doing that by setting the window's optional_new_start
15846 flag. In these cases, we try using the specified start point if
15847 that succeeds (i.e. the window desired matrix is successfully
15848 recomputed, and point location is within the window). In case
15849 of optional_new_start, we first check if the specified start
15850 position is feasible, i.e. if it will allow point to be
15851 displayed in the window. If using the specified start point
15852 fails, e.g., if new fonts are needed to be loaded, we abort the
15853 redisplay cycle and leave it up to the next cycle to figure out
15856 . Note that the window's force_start flag is sometimes set by
15857 redisplay itself, when it decides that the previous window start
15858 point is fine and should be kept. Search for "goto force_start"
15859 below to see the details. Like the values of window-start
15860 specified outside of redisplay, these internally-deduced values
15861 are tested for feasibility, and ignored if found to be
15864 . Note that the function try_window, used to completely redisplay
15865 a window, accepts the window's start point as its argument.
15866 This is used several times in the redisplay code to control
15867 where the window start will be, according to user options such
15868 as scroll-conservatively, and also to ensure the screen line
15869 showing point will be fully (as opposed to partially) visible on
15873 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15875 struct window
*w
= XWINDOW (window
);
15876 struct frame
*f
= XFRAME (w
->frame
);
15877 struct buffer
*buffer
= XBUFFER (w
->contents
);
15878 struct buffer
*old
= current_buffer
;
15879 struct text_pos lpoint
, opoint
, startp
;
15880 bool update_mode_line
;
15883 /* Record it now because it's overwritten. */
15884 bool current_matrix_up_to_date_p
= false;
15885 bool used_current_matrix_p
= false;
15886 /* This is less strict than current_matrix_up_to_date_p.
15887 It indicates that the buffer contents and narrowing are unchanged. */
15888 bool buffer_unchanged_p
= false;
15889 bool temp_scroll_step
= false;
15890 ptrdiff_t count
= SPECPDL_INDEX ();
15892 int centering_position
= -1;
15893 bool last_line_misfit
= false;
15894 ptrdiff_t beg_unchanged
, end_unchanged
;
15895 int frame_line_height
;
15897 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15901 *w
->desired_matrix
->method
= 0;
15904 if (!just_this_one_p
15905 && REDISPLAY_SOME_P ()
15907 && !w
->update_mode_line
15910 && !buffer
->text
->redisplay
15911 && BUF_PT (buffer
) == w
->last_point
)
15914 /* Make sure that both W's markers are valid. */
15915 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15916 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15918 /* We come here again if we need to run window-text-change-functions
15921 reconsider_clip_changes (w
);
15922 frame_line_height
= default_line_pixel_height (w
);
15924 /* Has the mode line to be updated? */
15925 update_mode_line
= (w
->update_mode_line
15926 || update_mode_lines
15927 || buffer
->clip_changed
15928 || buffer
->prevent_redisplay_optimizations_p
);
15930 if (!just_this_one_p
)
15931 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15932 cleverly elsewhere. */
15933 w
->must_be_updated_p
= true;
15935 if (MINI_WINDOW_P (w
))
15937 if (w
== XWINDOW (echo_area_window
)
15938 && !NILP (echo_area_buffer
[0]))
15940 if (update_mode_line
)
15941 /* We may have to update a tty frame's menu bar or a
15942 tool-bar. Example `M-x C-h C-h C-g'. */
15943 goto finish_menu_bars
;
15945 /* We've already displayed the echo area glyphs in this window. */
15946 goto finish_scroll_bars
;
15948 else if ((w
!= XWINDOW (minibuf_window
)
15949 || minibuf_level
== 0)
15950 /* When buffer is nonempty, redisplay window normally. */
15951 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15952 /* Quail displays non-mini buffers in minibuffer window.
15953 In that case, redisplay the window normally. */
15954 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15956 /* W is a mini-buffer window, but it's not active, so clear
15958 int yb
= window_text_bottom_y (w
);
15959 struct glyph_row
*row
;
15962 for (y
= 0, row
= w
->desired_matrix
->rows
;
15964 y
+= row
->height
, ++row
)
15965 blank_row (w
, row
, y
);
15966 goto finish_scroll_bars
;
15969 clear_glyph_matrix (w
->desired_matrix
);
15972 /* Otherwise set up data on this window; select its buffer and point
15974 /* Really select the buffer, for the sake of buffer-local
15976 set_buffer_internal_1 (XBUFFER (w
->contents
));
15978 current_matrix_up_to_date_p
15979 = (w
->window_end_valid
15980 && !current_buffer
->clip_changed
15981 && !current_buffer
->prevent_redisplay_optimizations_p
15982 && !window_outdated (w
));
15984 /* Run the window-text-change-functions
15985 if it is possible that the text on the screen has changed
15986 (either due to modification of the text, or any other reason). */
15987 if (!current_matrix_up_to_date_p
15988 && !NILP (Vwindow_text_change_functions
))
15990 safe_run_hooks (Qwindow_text_change_functions
);
15994 beg_unchanged
= BEG_UNCHANGED
;
15995 end_unchanged
= END_UNCHANGED
;
15997 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15999 specbind (Qinhibit_point_motion_hooks
, Qt
);
16002 = (w
->window_end_valid
16003 && !current_buffer
->clip_changed
16004 && !window_outdated (w
));
16006 /* When windows_or_buffers_changed is non-zero, we can't rely
16007 on the window end being valid, so set it to zero there. */
16008 if (windows_or_buffers_changed
)
16010 /* If window starts on a continuation line, maybe adjust the
16011 window start in case the window's width changed. */
16012 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16013 compute_window_start_on_continuation_line (w
);
16015 w
->window_end_valid
= false;
16016 /* If so, we also can't rely on current matrix
16017 and should not fool try_cursor_movement below. */
16018 current_matrix_up_to_date_p
= false;
16021 /* Some sanity checks. */
16022 CHECK_WINDOW_END (w
);
16023 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16025 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16028 if (mode_line_update_needed (w
))
16029 update_mode_line
= true;
16031 /* Point refers normally to the selected window. For any other
16032 window, set up appropriate value. */
16033 if (!EQ (window
, selected_window
))
16035 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16036 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16041 new_pt_byte
= BEGV_BYTE
;
16042 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16044 else if (new_pt
> (ZV
- 1))
16047 new_pt_byte
= ZV_BYTE
;
16048 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16051 /* We don't use SET_PT so that the point-motion hooks don't run. */
16052 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16055 /* If any of the character widths specified in the display table
16056 have changed, invalidate the width run cache. It's true that
16057 this may be a bit late to catch such changes, but the rest of
16058 redisplay goes (non-fatally) haywire when the display table is
16059 changed, so why should we worry about doing any better? */
16060 if (current_buffer
->width_run_cache
16061 || (current_buffer
->base_buffer
16062 && current_buffer
->base_buffer
->width_run_cache
))
16064 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16066 if (! disptab_matches_widthtab
16067 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16069 struct buffer
*buf
= current_buffer
;
16071 if (buf
->base_buffer
)
16072 buf
= buf
->base_buffer
;
16073 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16074 recompute_width_table (current_buffer
, disptab
);
16078 /* If window-start is screwed up, choose a new one. */
16079 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16082 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16084 /* If someone specified a new starting point but did not insist,
16085 check whether it can be used. */
16086 if ((w
->optional_new_start
|| window_frozen_p (w
))
16087 && CHARPOS (startp
) >= BEGV
16088 && CHARPOS (startp
) <= ZV
)
16090 ptrdiff_t it_charpos
;
16092 w
->optional_new_start
= false;
16093 start_display (&it
, w
, startp
);
16094 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16095 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16096 /* Record IT's position now, since line_bottom_y might change
16098 it_charpos
= IT_CHARPOS (it
);
16099 /* Make sure we set the force_start flag only if the cursor row
16100 will be fully visible. Otherwise, the code under force_start
16101 label below will try to move point back into view, which is
16102 not what the code which sets optional_new_start wants. */
16103 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16104 && !w
->force_start
)
16106 if (it_charpos
== PT
)
16107 w
->force_start
= true;
16108 /* IT may overshoot PT if text at PT is invisible. */
16109 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16110 w
->force_start
= true;
16112 if (w
->force_start
)
16114 if (window_frozen_p (w
))
16115 debug_method_add (w
, "set force_start from frozen window start");
16117 debug_method_add (w
, "set force_start from optional_new_start");
16125 /* Handle case where place to start displaying has been specified,
16126 unless the specified location is outside the accessible range. */
16127 if (w
->force_start
)
16129 /* We set this later on if we have to adjust point. */
16132 w
->force_start
= false;
16134 w
->window_end_valid
= false;
16136 /* Forget any recorded base line for line number display. */
16137 if (!buffer_unchanged_p
)
16138 w
->base_line_number
= 0;
16140 /* Redisplay the mode line. Select the buffer properly for that.
16141 Also, run the hook window-scroll-functions
16142 because we have scrolled. */
16143 /* Note, we do this after clearing force_start because
16144 if there's an error, it is better to forget about force_start
16145 than to get into an infinite loop calling the hook functions
16146 and having them get more errors. */
16147 if (!update_mode_line
16148 || ! NILP (Vwindow_scroll_functions
))
16150 update_mode_line
= true;
16151 w
->update_mode_line
= true;
16152 startp
= run_window_scroll_functions (window
, startp
);
16155 if (CHARPOS (startp
) < BEGV
)
16156 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16157 else if (CHARPOS (startp
) > ZV
)
16158 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16160 /* Redisplay, then check if cursor has been set during the
16161 redisplay. Give up if new fonts were loaded. */
16162 /* We used to issue a CHECK_MARGINS argument to try_window here,
16163 but this causes scrolling to fail when point begins inside
16164 the scroll margin (bug#148) -- cyd */
16165 if (!try_window (window
, startp
, 0))
16167 w
->force_start
= true;
16168 clear_glyph_matrix (w
->desired_matrix
);
16169 goto need_larger_matrices
;
16172 if (w
->cursor
.vpos
< 0)
16174 /* If point does not appear, try to move point so it does
16175 appear. The desired matrix has been built above, so we
16176 can use it here. */
16177 new_vpos
= window_box_height (w
) / 2;
16180 if (!cursor_row_fully_visible_p (w
, false, false))
16182 /* Point does appear, but on a line partly visible at end of window.
16183 Move it back to a fully-visible line. */
16184 new_vpos
= window_box_height (w
);
16185 /* But if window_box_height suggests a Y coordinate that is
16186 not less than we already have, that line will clearly not
16187 be fully visible, so give up and scroll the display.
16188 This can happen when the default face uses a font whose
16189 dimensions are different from the frame's default
16191 if (new_vpos
>= w
->cursor
.y
)
16193 w
->cursor
.vpos
= -1;
16194 clear_glyph_matrix (w
->desired_matrix
);
16195 goto try_to_scroll
;
16198 else if (w
->cursor
.vpos
>= 0)
16200 /* Some people insist on not letting point enter the scroll
16201 margin, even though this part handles windows that didn't
16203 int window_total_lines
16204 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16205 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16206 int pixel_margin
= margin
* frame_line_height
;
16207 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16209 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16210 below, which finds the row to move point to, advances by
16211 the Y coordinate of the _next_ row, see the definition of
16212 MATRIX_ROW_BOTTOM_Y. */
16213 if (w
->cursor
.vpos
< margin
+ header_line
)
16215 w
->cursor
.vpos
= -1;
16216 clear_glyph_matrix (w
->desired_matrix
);
16217 goto try_to_scroll
;
16221 int window_height
= window_box_height (w
);
16224 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16225 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16227 w
->cursor
.vpos
= -1;
16228 clear_glyph_matrix (w
->desired_matrix
);
16229 goto try_to_scroll
;
16234 /* If we need to move point for either of the above reasons,
16235 now actually do it. */
16238 struct glyph_row
*row
;
16240 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16241 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16244 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16245 MATRIX_ROW_START_BYTEPOS (row
));
16247 if (w
!= XWINDOW (selected_window
))
16248 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16249 else if (current_buffer
== old
)
16250 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16252 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16254 /* Re-run pre-redisplay-function so it can update the region
16255 according to the new position of point. */
16256 /* Other than the cursor, w's redisplay is done so we can set its
16257 redisplay to false. Also the buffer's redisplay can be set to
16258 false, since propagate_buffer_redisplay should have already
16259 propagated its info to `w' anyway. */
16260 w
->redisplay
= false;
16261 XBUFFER (w
->contents
)->text
->redisplay
= false;
16262 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16264 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16266 /* pre-redisplay-function made changes (e.g. move the region)
16267 that require another round of redisplay. */
16268 clear_glyph_matrix (w
->desired_matrix
);
16269 if (!try_window (window
, startp
, 0))
16270 goto need_larger_matrices
;
16273 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16275 clear_glyph_matrix (w
->desired_matrix
);
16276 goto try_to_scroll
;
16280 debug_method_add (w
, "forced window start");
16285 /* Handle case where text has not changed, only point, and it has
16286 not moved off the frame, and we are not retrying after hscroll.
16287 (current_matrix_up_to_date_p is true when retrying.) */
16288 if (current_matrix_up_to_date_p
16289 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16290 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16294 case CURSOR_MOVEMENT_SUCCESS
:
16295 used_current_matrix_p
= true;
16298 case CURSOR_MOVEMENT_MUST_SCROLL
:
16299 goto try_to_scroll
;
16305 /* If current starting point was originally the beginning of a line
16306 but no longer is, find a new starting point. */
16307 else if (w
->start_at_line_beg
16308 && !(CHARPOS (startp
) <= BEGV
16309 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16312 debug_method_add (w
, "recenter 1");
16317 /* Try scrolling with try_window_id. Value is > 0 if update has
16318 been done, it is -1 if we know that the same window start will
16319 not work. It is 0 if unsuccessful for some other reason. */
16320 else if ((tem
= try_window_id (w
)) != 0)
16323 debug_method_add (w
, "try_window_id %d", tem
);
16326 if (f
->fonts_changed
)
16327 goto need_larger_matrices
;
16331 /* Otherwise try_window_id has returned -1 which means that we
16332 don't want the alternative below this comment to execute. */
16334 else if (CHARPOS (startp
) >= BEGV
16335 && CHARPOS (startp
) <= ZV
16336 && PT
>= CHARPOS (startp
)
16337 && (CHARPOS (startp
) < ZV
16338 /* Avoid starting at end of buffer. */
16339 || CHARPOS (startp
) == BEGV
16340 || !window_outdated (w
)))
16342 int d1
, d2
, d5
, d6
;
16345 /* If first window line is a continuation line, and window start
16346 is inside the modified region, but the first change is before
16347 current window start, we must select a new window start.
16349 However, if this is the result of a down-mouse event (e.g. by
16350 extending the mouse-drag-overlay), we don't want to select a
16351 new window start, since that would change the position under
16352 the mouse, resulting in an unwanted mouse-movement rather
16353 than a simple mouse-click. */
16354 if (!w
->start_at_line_beg
16355 && NILP (do_mouse_tracking
)
16356 && CHARPOS (startp
) > BEGV
16357 && CHARPOS (startp
) > BEG
+ beg_unchanged
16358 && CHARPOS (startp
) <= Z
- end_unchanged
16359 /* Even if w->start_at_line_beg is nil, a new window may
16360 start at a line_beg, since that's how set_buffer_window
16361 sets it. So, we need to check the return value of
16362 compute_window_start_on_continuation_line. (See also
16364 && XMARKER (w
->start
)->buffer
== current_buffer
16365 && compute_window_start_on_continuation_line (w
)
16366 /* It doesn't make sense to force the window start like we
16367 do at label force_start if it is already known that point
16368 will not be fully visible in the resulting window, because
16369 doing so will move point from its correct position
16370 instead of scrolling the window to bring point into view.
16372 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16373 /* A very tall row could need more than the window height,
16374 in which case we accept that it is partially visible. */
16375 && (rtop
!= 0) == (rbot
!= 0))
16377 w
->force_start
= true;
16378 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16380 debug_method_add (w
, "recomputed window start in continuation line");
16386 debug_method_add (w
, "same window start");
16389 /* Try to redisplay starting at same place as before.
16390 If point has not moved off frame, accept the results. */
16391 if (!current_matrix_up_to_date_p
16392 /* Don't use try_window_reusing_current_matrix in this case
16393 because a window scroll function can have changed the
16395 || !NILP (Vwindow_scroll_functions
)
16396 || MINI_WINDOW_P (w
)
16397 || !(used_current_matrix_p
16398 = try_window_reusing_current_matrix (w
)))
16400 IF_DEBUG (debug_method_add (w
, "1"));
16401 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16402 /* -1 means we need to scroll.
16403 0 means we need new matrices, but fonts_changed
16404 is set in that case, so we will detect it below. */
16405 goto try_to_scroll
;
16408 if (f
->fonts_changed
)
16409 goto need_larger_matrices
;
16411 if (w
->cursor
.vpos
>= 0)
16413 if (!just_this_one_p
16414 || current_buffer
->clip_changed
16415 || BEG_UNCHANGED
< CHARPOS (startp
))
16416 /* Forget any recorded base line for line number display. */
16417 w
->base_line_number
= 0;
16419 if (!cursor_row_fully_visible_p (w
, true, false))
16421 clear_glyph_matrix (w
->desired_matrix
);
16422 last_line_misfit
= true;
16424 /* Drop through and scroll. */
16429 clear_glyph_matrix (w
->desired_matrix
);
16434 /* Redisplay the mode line. Select the buffer properly for that. */
16435 if (!update_mode_line
)
16437 update_mode_line
= true;
16438 w
->update_mode_line
= true;
16441 /* Try to scroll by specified few lines. */
16442 if ((scroll_conservatively
16443 || emacs_scroll_step
16444 || temp_scroll_step
16445 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16446 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16447 && CHARPOS (startp
) >= BEGV
16448 && CHARPOS (startp
) <= ZV
)
16450 /* The function returns -1 if new fonts were loaded, 1 if
16451 successful, 0 if not successful. */
16452 int ss
= try_scrolling (window
, just_this_one_p
,
16453 scroll_conservatively
,
16455 temp_scroll_step
, last_line_misfit
);
16458 case SCROLLING_SUCCESS
:
16461 case SCROLLING_NEED_LARGER_MATRICES
:
16462 goto need_larger_matrices
;
16464 case SCROLLING_FAILED
:
16472 /* Finally, just choose a place to start which positions point
16473 according to user preferences. */
16478 debug_method_add (w
, "recenter");
16481 /* Forget any previously recorded base line for line number display. */
16482 if (!buffer_unchanged_p
)
16483 w
->base_line_number
= 0;
16485 /* Determine the window start relative to point. */
16486 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16487 it
.current_y
= it
.last_visible_y
;
16488 if (centering_position
< 0)
16490 int window_total_lines
16491 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16493 = scroll_margin
> 0
16494 ? min (scroll_margin
, window_total_lines
/ 4)
16496 ptrdiff_t margin_pos
= CHARPOS (startp
);
16497 Lisp_Object aggressive
;
16500 /* If there is a scroll margin at the top of the window, find
16501 its character position. */
16503 /* Cannot call start_display if startp is not in the
16504 accessible region of the buffer. This can happen when we
16505 have just switched to a different buffer and/or changed
16506 its restriction. In that case, startp is initialized to
16507 the character position 1 (BEGV) because we did not yet
16508 have chance to display the buffer even once. */
16509 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16512 void *it1data
= NULL
;
16514 SAVE_IT (it1
, it
, it1data
);
16515 start_display (&it1
, w
, startp
);
16516 move_it_vertically (&it1
, margin
* frame_line_height
);
16517 margin_pos
= IT_CHARPOS (it1
);
16518 RESTORE_IT (&it
, &it
, it1data
);
16520 scrolling_up
= PT
> margin_pos
;
16523 ? BVAR (current_buffer
, scroll_up_aggressively
)
16524 : BVAR (current_buffer
, scroll_down_aggressively
);
16526 if (!MINI_WINDOW_P (w
)
16527 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16531 /* Setting scroll-conservatively overrides
16532 scroll-*-aggressively. */
16533 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16535 double float_amount
= XFLOATINT (aggressive
);
16537 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16538 if (pt_offset
== 0 && float_amount
> 0)
16540 if (pt_offset
&& margin
> 0)
16543 /* Compute how much to move the window start backward from
16544 point so that point will be displayed where the user
16548 centering_position
= it
.last_visible_y
;
16550 centering_position
-= pt_offset
;
16551 centering_position
-=
16552 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16553 + WINDOW_HEADER_LINE_HEIGHT (w
));
16554 /* Don't let point enter the scroll margin near top of
16556 if (centering_position
< margin
* frame_line_height
)
16557 centering_position
= margin
* frame_line_height
;
16560 centering_position
= margin
* frame_line_height
+ pt_offset
;
16563 /* Set the window start half the height of the window backward
16565 centering_position
= window_box_height (w
) / 2;
16567 move_it_vertically_backward (&it
, centering_position
);
16569 eassert (IT_CHARPOS (it
) >= BEGV
);
16571 /* The function move_it_vertically_backward may move over more
16572 than the specified y-distance. If it->w is small, e.g. a
16573 mini-buffer window, we may end up in front of the window's
16574 display area. Start displaying at the start of the line
16575 containing PT in this case. */
16576 if (it
.current_y
<= 0)
16578 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16579 move_it_vertically_backward (&it
, 0);
16583 it
.current_x
= it
.hpos
= 0;
16585 /* Set the window start position here explicitly, to avoid an
16586 infinite loop in case the functions in window-scroll-functions
16588 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16590 /* Run scroll hooks. */
16591 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16593 /* Redisplay the window. */
16594 if (!current_matrix_up_to_date_p
16595 || windows_or_buffers_changed
16596 || f
->cursor_type_changed
16597 /* Don't use try_window_reusing_current_matrix in this case
16598 because it can have changed the buffer. */
16599 || !NILP (Vwindow_scroll_functions
)
16600 || !just_this_one_p
16601 || MINI_WINDOW_P (w
)
16602 || !(used_current_matrix_p
16603 = try_window_reusing_current_matrix (w
)))
16604 try_window (window
, startp
, 0);
16606 /* If new fonts have been loaded (due to fontsets), give up. We
16607 have to start a new redisplay since we need to re-adjust glyph
16609 if (f
->fonts_changed
)
16610 goto need_larger_matrices
;
16612 /* If cursor did not appear assume that the middle of the window is
16613 in the first line of the window. Do it again with the next line.
16614 (Imagine a window of height 100, displaying two lines of height
16615 60. Moving back 50 from it->last_visible_y will end in the first
16617 if (w
->cursor
.vpos
< 0)
16619 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16621 clear_glyph_matrix (w
->desired_matrix
);
16622 move_it_by_lines (&it
, 1);
16623 try_window (window
, it
.current
.pos
, 0);
16625 else if (PT
< IT_CHARPOS (it
))
16627 clear_glyph_matrix (w
->desired_matrix
);
16628 move_it_by_lines (&it
, -1);
16629 try_window (window
, it
.current
.pos
, 0);
16633 /* Not much we can do about it. */
16637 /* Consider the following case: Window starts at BEGV, there is
16638 invisible, intangible text at BEGV, so that display starts at
16639 some point START > BEGV. It can happen that we are called with
16640 PT somewhere between BEGV and START. Try to handle that case,
16641 and similar ones. */
16642 if (w
->cursor
.vpos
< 0)
16644 /* First, try locating the proper glyph row for PT. */
16645 struct glyph_row
*row
=
16646 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16648 /* Sometimes point is at the beginning of invisible text that is
16649 before the 1st character displayed in the row. In that case,
16650 row_containing_pos fails to find the row, because no glyphs
16651 with appropriate buffer positions are present in the row.
16652 Therefore, we next try to find the row which shows the 1st
16653 position after the invisible text. */
16657 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16660 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16663 Lisp_Object invis_end
=
16664 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16667 if (NATNUMP (invis_end
))
16668 alt_pos
= XFASTINT (invis_end
);
16671 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16675 /* Finally, fall back on the first row of the window after the
16676 header line (if any). This is slightly better than not
16677 displaying the cursor at all. */
16680 row
= w
->current_matrix
->rows
;
16681 if (row
->mode_line_p
)
16684 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16687 if (!cursor_row_fully_visible_p (w
, false, false))
16689 /* If vscroll is enabled, disable it and try again. */
16693 clear_glyph_matrix (w
->desired_matrix
);
16697 /* Users who set scroll-conservatively to a large number want
16698 point just above/below the scroll margin. If we ended up
16699 with point's row partially visible, move the window start to
16700 make that row fully visible and out of the margin. */
16701 if (scroll_conservatively
> SCROLL_LIMIT
)
16703 int window_total_lines
16704 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16707 ? min (scroll_margin
, window_total_lines
/ 4)
16709 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16711 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16712 clear_glyph_matrix (w
->desired_matrix
);
16713 if (1 == try_window (window
, it
.current
.pos
,
16714 TRY_WINDOW_CHECK_MARGINS
))
16718 /* If centering point failed to make the whole line visible,
16719 put point at the top instead. That has to make the whole line
16720 visible, if it can be done. */
16721 if (centering_position
== 0)
16724 clear_glyph_matrix (w
->desired_matrix
);
16725 centering_position
= 0;
16731 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16732 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16733 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16735 /* Display the mode line, if we must. */
16736 if ((update_mode_line
16737 /* If window not full width, must redo its mode line
16738 if (a) the window to its side is being redone and
16739 (b) we do a frame-based redisplay. This is a consequence
16740 of how inverted lines are drawn in frame-based redisplay. */
16741 || (!just_this_one_p
16742 && !FRAME_WINDOW_P (f
)
16743 && !WINDOW_FULL_WIDTH_P (w
))
16744 /* Line number to display. */
16745 || w
->base_line_pos
> 0
16746 /* Column number is displayed and different from the one displayed. */
16747 || (w
->column_number_displayed
!= -1
16748 && (w
->column_number_displayed
!= current_column ())))
16749 /* This means that the window has a mode line. */
16750 && (WINDOW_WANTS_MODELINE_P (w
)
16751 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16754 display_mode_lines (w
);
16756 /* If mode line height has changed, arrange for a thorough
16757 immediate redisplay using the correct mode line height. */
16758 if (WINDOW_WANTS_MODELINE_P (w
)
16759 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16761 f
->fonts_changed
= true;
16762 w
->mode_line_height
= -1;
16763 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16764 = DESIRED_MODE_LINE_HEIGHT (w
);
16767 /* If header line height has changed, arrange for a thorough
16768 immediate redisplay using the correct header line height. */
16769 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16770 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16772 f
->fonts_changed
= true;
16773 w
->header_line_height
= -1;
16774 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16775 = DESIRED_HEADER_LINE_HEIGHT (w
);
16778 if (f
->fonts_changed
)
16779 goto need_larger_matrices
;
16782 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16784 w
->base_line_pos
= 0;
16785 w
->base_line_number
= 0;
16790 /* When we reach a frame's selected window, redo the frame's menu bar. */
16791 if (update_mode_line
16792 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16794 bool redisplay_menu_p
;
16796 if (FRAME_WINDOW_P (f
))
16798 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16799 || defined (HAVE_NS) || defined (USE_GTK)
16800 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16802 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16806 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16808 if (redisplay_menu_p
)
16809 display_menu_bar (w
);
16811 #ifdef HAVE_WINDOW_SYSTEM
16812 if (FRAME_WINDOW_P (f
))
16814 #if defined (USE_GTK) || defined (HAVE_NS)
16815 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16816 redisplay_tool_bar (f
);
16818 if (WINDOWP (f
->tool_bar_window
)
16819 && (FRAME_TOOL_BAR_LINES (f
) > 0
16820 || !NILP (Vauto_resize_tool_bars
))
16821 && redisplay_tool_bar (f
))
16822 ignore_mouse_drag_p
= true;
16828 #ifdef HAVE_WINDOW_SYSTEM
16829 if (FRAME_WINDOW_P (f
)
16830 && update_window_fringes (w
, (just_this_one_p
16831 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16832 || w
->pseudo_window_p
)))
16836 if (draw_window_fringes (w
, true))
16838 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16839 x_draw_right_divider (w
);
16841 x_draw_vertical_border (w
);
16847 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16848 x_draw_bottom_divider (w
);
16849 #endif /* HAVE_WINDOW_SYSTEM */
16851 /* We go to this label, with fonts_changed set, if it is
16852 necessary to try again using larger glyph matrices.
16853 We have to redeem the scroll bar even in this case,
16854 because the loop in redisplay_internal expects that. */
16855 need_larger_matrices
:
16857 finish_scroll_bars
:
16859 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16861 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16862 /* Set the thumb's position and size. */
16863 set_vertical_scroll_bar (w
);
16865 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16866 /* Set the thumb's position and size. */
16867 set_horizontal_scroll_bar (w
);
16869 /* Note that we actually used the scroll bar attached to this
16870 window, so it shouldn't be deleted at the end of redisplay. */
16871 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16872 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16875 /* Restore current_buffer and value of point in it. The window
16876 update may have changed the buffer, so first make sure `opoint'
16877 is still valid (Bug#6177). */
16878 if (CHARPOS (opoint
) < BEGV
)
16879 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16880 else if (CHARPOS (opoint
) > ZV
)
16881 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16883 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16885 set_buffer_internal_1 (old
);
16886 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16887 shorter. This can be caused by log truncation in *Messages*. */
16888 if (CHARPOS (lpoint
) <= ZV
)
16889 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16891 unbind_to (count
, Qnil
);
16895 /* Build the complete desired matrix of WINDOW with a window start
16896 buffer position POS.
16898 Value is 1 if successful. It is zero if fonts were loaded during
16899 redisplay which makes re-adjusting glyph matrices necessary, and -1
16900 if point would appear in the scroll margins.
16901 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16902 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16906 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16908 struct window
*w
= XWINDOW (window
);
16910 struct glyph_row
*last_text_row
= NULL
;
16911 struct frame
*f
= XFRAME (w
->frame
);
16912 int frame_line_height
= default_line_pixel_height (w
);
16914 /* Make POS the new window start. */
16915 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16917 /* Mark cursor position as unknown. No overlay arrow seen. */
16918 w
->cursor
.vpos
= -1;
16919 overlay_arrow_seen
= false;
16921 /* Initialize iterator and info to start at POS. */
16922 start_display (&it
, w
, pos
);
16923 it
.glyph_row
->reversed_p
= false;
16925 /* Display all lines of W. */
16926 while (it
.current_y
< it
.last_visible_y
)
16928 if (display_line (&it
))
16929 last_text_row
= it
.glyph_row
- 1;
16930 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16934 /* Don't let the cursor end in the scroll margins. */
16935 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16936 && !MINI_WINDOW_P (w
))
16938 int this_scroll_margin
;
16939 int window_total_lines
16940 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16942 if (scroll_margin
> 0)
16944 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16945 this_scroll_margin
*= frame_line_height
;
16948 this_scroll_margin
= 0;
16950 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16951 && w
->cursor
.y
< this_scroll_margin
16952 && CHARPOS (pos
) > BEGV
16953 && IT_CHARPOS (it
) < ZV
)
16954 /* rms: considering make_cursor_line_fully_visible_p here
16955 seems to give wrong results. We don't want to recenter
16956 when the last line is partly visible, we want to allow
16957 that case to be handled in the usual way. */
16958 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16960 w
->cursor
.vpos
= -1;
16961 clear_glyph_matrix (w
->desired_matrix
);
16966 /* If bottom moved off end of frame, change mode line percentage. */
16967 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16968 w
->update_mode_line
= true;
16970 /* Set window_end_pos to the offset of the last character displayed
16971 on the window from the end of current_buffer. Set
16972 window_end_vpos to its row number. */
16975 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16976 adjust_window_ends (w
, last_text_row
, false);
16978 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16979 w
->window_end_vpos
)));
16983 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16984 w
->window_end_pos
= Z
- ZV
;
16985 w
->window_end_vpos
= 0;
16988 /* But that is not valid info until redisplay finishes. */
16989 w
->window_end_valid
= false;
16995 /************************************************************************
16996 Window redisplay reusing current matrix when buffer has not changed
16997 ************************************************************************/
16999 /* Try redisplay of window W showing an unchanged buffer with a
17000 different window start than the last time it was displayed by
17001 reusing its current matrix. Value is true if successful.
17002 W->start is the new window start. */
17005 try_window_reusing_current_matrix (struct window
*w
)
17007 struct frame
*f
= XFRAME (w
->frame
);
17008 struct glyph_row
*bottom_row
;
17011 struct text_pos start
, new_start
;
17012 int nrows_scrolled
, i
;
17013 struct glyph_row
*last_text_row
;
17014 struct glyph_row
*last_reused_text_row
;
17015 struct glyph_row
*start_row
;
17016 int start_vpos
, min_y
, max_y
;
17019 if (inhibit_try_window_reusing
)
17023 if (/* This function doesn't handle terminal frames. */
17024 !FRAME_WINDOW_P (f
)
17025 /* Don't try to reuse the display if windows have been split
17027 || windows_or_buffers_changed
17028 || f
->cursor_type_changed
)
17031 /* Can't do this if showing trailing whitespace. */
17032 if (!NILP (Vshow_trailing_whitespace
))
17035 /* If top-line visibility has changed, give up. */
17036 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17037 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17040 /* Give up if old or new display is scrolled vertically. We could
17041 make this function handle this, but right now it doesn't. */
17042 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17043 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17046 /* The variable new_start now holds the new window start. The old
17047 start `start' can be determined from the current matrix. */
17048 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17049 start
= start_row
->minpos
;
17050 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17052 /* Clear the desired matrix for the display below. */
17053 clear_glyph_matrix (w
->desired_matrix
);
17055 if (CHARPOS (new_start
) <= CHARPOS (start
))
17057 /* Don't use this method if the display starts with an ellipsis
17058 displayed for invisible text. It's not easy to handle that case
17059 below, and it's certainly not worth the effort since this is
17060 not a frequent case. */
17061 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17064 IF_DEBUG (debug_method_add (w
, "twu1"));
17066 /* Display up to a row that can be reused. The variable
17067 last_text_row is set to the last row displayed that displays
17068 text. Note that it.vpos == 0 if or if not there is a
17069 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17070 start_display (&it
, w
, new_start
);
17071 w
->cursor
.vpos
= -1;
17072 last_text_row
= last_reused_text_row
= NULL
;
17074 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17076 /* If we have reached into the characters in the START row,
17077 that means the line boundaries have changed. So we
17078 can't start copying with the row START. Maybe it will
17079 work to start copying with the following row. */
17080 while (IT_CHARPOS (it
) > CHARPOS (start
))
17082 /* Advance to the next row as the "start". */
17084 start
= start_row
->minpos
;
17085 /* If there are no more rows to try, or just one, give up. */
17086 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17087 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17088 || CHARPOS (start
) == ZV
)
17090 clear_glyph_matrix (w
->desired_matrix
);
17094 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17096 /* If we have reached alignment, we can copy the rest of the
17098 if (IT_CHARPOS (it
) == CHARPOS (start
)
17099 /* Don't accept "alignment" inside a display vector,
17100 since start_row could have started in the middle of
17101 that same display vector (thus their character
17102 positions match), and we have no way of telling if
17103 that is the case. */
17104 && it
.current
.dpvec_index
< 0)
17107 it
.glyph_row
->reversed_p
= false;
17108 if (display_line (&it
))
17109 last_text_row
= it
.glyph_row
- 1;
17113 /* A value of current_y < last_visible_y means that we stopped
17114 at the previous window start, which in turn means that we
17115 have at least one reusable row. */
17116 if (it
.current_y
< it
.last_visible_y
)
17118 struct glyph_row
*row
;
17120 /* IT.vpos always starts from 0; it counts text lines. */
17121 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17123 /* Find PT if not already found in the lines displayed. */
17124 if (w
->cursor
.vpos
< 0)
17126 int dy
= it
.current_y
- start_row
->y
;
17128 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17129 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17131 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17132 dy
, nrows_scrolled
);
17135 clear_glyph_matrix (w
->desired_matrix
);
17140 /* Scroll the display. Do it before the current matrix is
17141 changed. The problem here is that update has not yet
17142 run, i.e. part of the current matrix is not up to date.
17143 scroll_run_hook will clear the cursor, and use the
17144 current matrix to get the height of the row the cursor is
17146 run
.current_y
= start_row
->y
;
17147 run
.desired_y
= it
.current_y
;
17148 run
.height
= it
.last_visible_y
- it
.current_y
;
17150 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17153 FRAME_RIF (f
)->update_window_begin_hook (w
);
17154 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17155 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17156 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17160 /* Shift current matrix down by nrows_scrolled lines. */
17161 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17162 rotate_matrix (w
->current_matrix
,
17164 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17167 /* Disable lines that must be updated. */
17168 for (i
= 0; i
< nrows_scrolled
; ++i
)
17169 (start_row
+ i
)->enabled_p
= false;
17171 /* Re-compute Y positions. */
17172 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17173 max_y
= it
.last_visible_y
;
17174 for (row
= start_row
+ nrows_scrolled
;
17178 row
->y
= it
.current_y
;
17179 row
->visible_height
= row
->height
;
17181 if (row
->y
< min_y
)
17182 row
->visible_height
-= min_y
- row
->y
;
17183 if (row
->y
+ row
->height
> max_y
)
17184 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17185 if (row
->fringe_bitmap_periodic_p
)
17186 row
->redraw_fringe_bitmaps_p
= true;
17188 it
.current_y
+= row
->height
;
17190 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17191 last_reused_text_row
= row
;
17192 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17196 /* Disable lines in the current matrix which are now
17197 below the window. */
17198 for (++row
; row
< bottom_row
; ++row
)
17199 row
->enabled_p
= row
->mode_line_p
= false;
17202 /* Update window_end_pos etc.; last_reused_text_row is the last
17203 reused row from the current matrix containing text, if any.
17204 The value of last_text_row is the last displayed line
17205 containing text. */
17206 if (last_reused_text_row
)
17207 adjust_window_ends (w
, last_reused_text_row
, true);
17208 else if (last_text_row
)
17209 adjust_window_ends (w
, last_text_row
, false);
17212 /* This window must be completely empty. */
17213 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17214 w
->window_end_pos
= Z
- ZV
;
17215 w
->window_end_vpos
= 0;
17217 w
->window_end_valid
= false;
17219 /* Update hint: don't try scrolling again in update_window. */
17220 w
->desired_matrix
->no_scrolling_p
= true;
17223 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17227 else if (CHARPOS (new_start
) > CHARPOS (start
))
17229 struct glyph_row
*pt_row
, *row
;
17230 struct glyph_row
*first_reusable_row
;
17231 struct glyph_row
*first_row_to_display
;
17233 int yb
= window_text_bottom_y (w
);
17235 /* Find the row starting at new_start, if there is one. Don't
17236 reuse a partially visible line at the end. */
17237 first_reusable_row
= start_row
;
17238 while (first_reusable_row
->enabled_p
17239 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17240 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17241 < CHARPOS (new_start
)))
17242 ++first_reusable_row
;
17244 /* Give up if there is no row to reuse. */
17245 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17246 || !first_reusable_row
->enabled_p
17247 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17248 != CHARPOS (new_start
)))
17251 /* We can reuse fully visible rows beginning with
17252 first_reusable_row to the end of the window. Set
17253 first_row_to_display to the first row that cannot be reused.
17254 Set pt_row to the row containing point, if there is any. */
17256 for (first_row_to_display
= first_reusable_row
;
17257 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17258 ++first_row_to_display
)
17260 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17261 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17262 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17263 && first_row_to_display
->ends_at_zv_p
17264 && pt_row
== NULL
)))
17265 pt_row
= first_row_to_display
;
17268 /* Start displaying at the start of first_row_to_display. */
17269 eassert (first_row_to_display
->y
< yb
);
17270 init_to_row_start (&it
, w
, first_row_to_display
);
17272 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17274 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17276 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17277 + WINDOW_HEADER_LINE_HEIGHT (w
));
17279 /* Display lines beginning with first_row_to_display in the
17280 desired matrix. Set last_text_row to the last row displayed
17281 that displays text. */
17282 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17283 if (pt_row
== NULL
)
17284 w
->cursor
.vpos
= -1;
17285 last_text_row
= NULL
;
17286 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17287 if (display_line (&it
))
17288 last_text_row
= it
.glyph_row
- 1;
17290 /* If point is in a reused row, adjust y and vpos of the cursor
17294 w
->cursor
.vpos
-= nrows_scrolled
;
17295 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17298 /* Give up if point isn't in a row displayed or reused. (This
17299 also handles the case where w->cursor.vpos < nrows_scrolled
17300 after the calls to display_line, which can happen with scroll
17301 margins. See bug#1295.) */
17302 if (w
->cursor
.vpos
< 0)
17304 clear_glyph_matrix (w
->desired_matrix
);
17308 /* Scroll the display. */
17309 run
.current_y
= first_reusable_row
->y
;
17310 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17311 run
.height
= it
.last_visible_y
- run
.current_y
;
17312 dy
= run
.current_y
- run
.desired_y
;
17317 FRAME_RIF (f
)->update_window_begin_hook (w
);
17318 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17319 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17320 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17324 /* Adjust Y positions of reused rows. */
17325 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17326 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17327 max_y
= it
.last_visible_y
;
17328 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17331 row
->visible_height
= row
->height
;
17332 if (row
->y
< min_y
)
17333 row
->visible_height
-= min_y
- row
->y
;
17334 if (row
->y
+ row
->height
> max_y
)
17335 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17336 if (row
->fringe_bitmap_periodic_p
)
17337 row
->redraw_fringe_bitmaps_p
= true;
17340 /* Scroll the current matrix. */
17341 eassert (nrows_scrolled
> 0);
17342 rotate_matrix (w
->current_matrix
,
17344 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17347 /* Disable rows not reused. */
17348 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17349 row
->enabled_p
= false;
17351 /* Point may have moved to a different line, so we cannot assume that
17352 the previous cursor position is valid; locate the correct row. */
17355 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17357 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17358 && !row
->ends_at_zv_p
;
17362 w
->cursor
.y
= row
->y
;
17364 if (row
< bottom_row
)
17366 /* Can't simply scan the row for point with
17367 bidi-reordered glyph rows. Let set_cursor_from_row
17368 figure out where to put the cursor, and if it fails,
17370 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17372 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17375 clear_glyph_matrix (w
->desired_matrix
);
17381 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17382 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17385 && (!BUFFERP (glyph
->object
)
17386 || glyph
->charpos
< PT
);
17390 w
->cursor
.x
+= glyph
->pixel_width
;
17396 /* Adjust window end. A null value of last_text_row means that
17397 the window end is in reused rows which in turn means that
17398 only its vpos can have changed. */
17400 adjust_window_ends (w
, last_text_row
, false);
17402 w
->window_end_vpos
-= nrows_scrolled
;
17404 w
->window_end_valid
= false;
17405 w
->desired_matrix
->no_scrolling_p
= true;
17408 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17418 /************************************************************************
17419 Window redisplay reusing current matrix when buffer has changed
17420 ************************************************************************/
17422 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17423 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17424 ptrdiff_t *, ptrdiff_t *);
17425 static struct glyph_row
*
17426 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17427 struct glyph_row
*);
17430 /* Return the last row in MATRIX displaying text. If row START is
17431 non-null, start searching with that row. IT gives the dimensions
17432 of the display. Value is null if matrix is empty; otherwise it is
17433 a pointer to the row found. */
17435 static struct glyph_row
*
17436 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17437 struct glyph_row
*start
)
17439 struct glyph_row
*row
, *row_found
;
17441 /* Set row_found to the last row in IT->w's current matrix
17442 displaying text. The loop looks funny but think of partially
17445 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17446 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17448 eassert (row
->enabled_p
);
17450 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17459 /* Return the last row in the current matrix of W that is not affected
17460 by changes at the start of current_buffer that occurred since W's
17461 current matrix was built. Value is null if no such row exists.
17463 BEG_UNCHANGED us the number of characters unchanged at the start of
17464 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17465 first changed character in current_buffer. Characters at positions <
17466 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17467 when the current matrix was built. */
17469 static struct glyph_row
*
17470 find_last_unchanged_at_beg_row (struct window
*w
)
17472 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17473 struct glyph_row
*row
;
17474 struct glyph_row
*row_found
= NULL
;
17475 int yb
= window_text_bottom_y (w
);
17477 /* Find the last row displaying unchanged text. */
17478 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17479 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17480 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17483 if (/* If row ends before first_changed_pos, it is unchanged,
17484 except in some case. */
17485 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17486 /* When row ends in ZV and we write at ZV it is not
17488 && !row
->ends_at_zv_p
17489 /* When first_changed_pos is the end of a continued line,
17490 row is not unchanged because it may be no longer
17492 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17493 && (row
->continued_p
17494 || row
->exact_window_width_line_p
))
17495 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17496 needs to be recomputed, so don't consider this row as
17497 unchanged. This happens when the last line was
17498 bidi-reordered and was killed immediately before this
17499 redisplay cycle. In that case, ROW->end stores the
17500 buffer position of the first visual-order character of
17501 the killed text, which is now beyond ZV. */
17502 && CHARPOS (row
->end
.pos
) <= ZV
)
17505 /* Stop if last visible row. */
17506 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17514 /* Find the first glyph row in the current matrix of W that is not
17515 affected by changes at the end of current_buffer since the
17516 time W's current matrix was built.
17518 Return in *DELTA the number of chars by which buffer positions in
17519 unchanged text at the end of current_buffer must be adjusted.
17521 Return in *DELTA_BYTES the corresponding number of bytes.
17523 Value is null if no such row exists, i.e. all rows are affected by
17526 static struct glyph_row
*
17527 find_first_unchanged_at_end_row (struct window
*w
,
17528 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17530 struct glyph_row
*row
;
17531 struct glyph_row
*row_found
= NULL
;
17533 *delta
= *delta_bytes
= 0;
17535 /* Display must not have been paused, otherwise the current matrix
17536 is not up to date. */
17537 eassert (w
->window_end_valid
);
17539 /* A value of window_end_pos >= END_UNCHANGED means that the window
17540 end is in the range of changed text. If so, there is no
17541 unchanged row at the end of W's current matrix. */
17542 if (w
->window_end_pos
>= END_UNCHANGED
)
17545 /* Set row to the last row in W's current matrix displaying text. */
17546 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17548 /* If matrix is entirely empty, no unchanged row exists. */
17549 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17551 /* The value of row is the last glyph row in the matrix having a
17552 meaningful buffer position in it. The end position of row
17553 corresponds to window_end_pos. This allows us to translate
17554 buffer positions in the current matrix to current buffer
17555 positions for characters not in changed text. */
17557 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17558 ptrdiff_t Z_BYTE_old
=
17559 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17560 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17561 struct glyph_row
*first_text_row
17562 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17564 *delta
= Z
- Z_old
;
17565 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17567 /* Set last_unchanged_pos to the buffer position of the last
17568 character in the buffer that has not been changed. Z is the
17569 index + 1 of the last character in current_buffer, i.e. by
17570 subtracting END_UNCHANGED we get the index of the last
17571 unchanged character, and we have to add BEG to get its buffer
17573 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17574 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17576 /* Search backward from ROW for a row displaying a line that
17577 starts at a minimum position >= last_unchanged_pos_old. */
17578 for (; row
> first_text_row
; --row
)
17580 /* This used to abort, but it can happen.
17581 It is ok to just stop the search instead here. KFS. */
17582 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17585 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17590 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17596 /* Make sure that glyph rows in the current matrix of window W
17597 reference the same glyph memory as corresponding rows in the
17598 frame's frame matrix. This function is called after scrolling W's
17599 current matrix on a terminal frame in try_window_id and
17600 try_window_reusing_current_matrix. */
17603 sync_frame_with_window_matrix_rows (struct window
*w
)
17605 struct frame
*f
= XFRAME (w
->frame
);
17606 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17608 /* Preconditions: W must be a leaf window and full-width. Its frame
17609 must have a frame matrix. */
17610 eassert (BUFFERP (w
->contents
));
17611 eassert (WINDOW_FULL_WIDTH_P (w
));
17612 eassert (!FRAME_WINDOW_P (f
));
17614 /* If W is a full-width window, glyph pointers in W's current matrix
17615 have, by definition, to be the same as glyph pointers in the
17616 corresponding frame matrix. Note that frame matrices have no
17617 marginal areas (see build_frame_matrix). */
17618 window_row
= w
->current_matrix
->rows
;
17619 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17620 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17621 while (window_row
< window_row_end
)
17623 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17624 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17626 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17627 frame_row
->glyphs
[TEXT_AREA
] = start
;
17628 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17629 frame_row
->glyphs
[LAST_AREA
] = end
;
17631 /* Disable frame rows whose corresponding window rows have
17632 been disabled in try_window_id. */
17633 if (!window_row
->enabled_p
)
17634 frame_row
->enabled_p
= false;
17636 ++window_row
, ++frame_row
;
17641 /* Find the glyph row in window W containing CHARPOS. Consider all
17642 rows between START and END (not inclusive). END null means search
17643 all rows to the end of the display area of W. Value is the row
17644 containing CHARPOS or null. */
17647 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17648 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17650 struct glyph_row
*row
= start
;
17651 struct glyph_row
*best_row
= NULL
;
17652 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17655 /* If we happen to start on a header-line, skip that. */
17656 if (row
->mode_line_p
)
17659 if ((end
&& row
>= end
) || !row
->enabled_p
)
17662 last_y
= window_text_bottom_y (w
) - dy
;
17666 /* Give up if we have gone too far. */
17667 if (end
&& row
>= end
)
17669 /* This formerly returned if they were equal.
17670 I think that both quantities are of a "last plus one" type;
17671 if so, when they are equal, the row is within the screen. -- rms. */
17672 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17675 /* If it is in this row, return this row. */
17676 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17677 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17678 /* The end position of a row equals the start
17679 position of the next row. If CHARPOS is there, we
17680 would rather consider it displayed in the next
17681 line, except when this line ends in ZV. */
17682 && !row_for_charpos_p (row
, charpos
)))
17683 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17687 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17688 || (!best_row
&& !row
->continued_p
))
17690 /* In bidi-reordered rows, there could be several rows whose
17691 edges surround CHARPOS, all of these rows belonging to
17692 the same continued line. We need to find the row which
17693 fits CHARPOS the best. */
17694 for (g
= row
->glyphs
[TEXT_AREA
];
17695 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17698 if (!STRINGP (g
->object
))
17700 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17702 mindif
= eabs (g
->charpos
- charpos
);
17704 /* Exact match always wins. */
17711 else if (best_row
&& !row
->continued_p
)
17718 /* Try to redisplay window W by reusing its existing display. W's
17719 current matrix must be up to date when this function is called,
17720 i.e., window_end_valid must be true.
17724 >= 1 if successful, i.e. display has been updated
17726 1 means the changes were in front of a newline that precedes
17727 the window start, and the whole current matrix was reused
17728 2 means the changes were after the last position displayed
17729 in the window, and the whole current matrix was reused
17730 3 means portions of the current matrix were reused, while
17731 some of the screen lines were redrawn
17732 -1 if redisplay with same window start is known not to succeed
17733 0 if otherwise unsuccessful
17735 The following steps are performed:
17737 1. Find the last row in the current matrix of W that is not
17738 affected by changes at the start of current_buffer. If no such row
17741 2. Find the first row in W's current matrix that is not affected by
17742 changes at the end of current_buffer. Maybe there is no such row.
17744 3. Display lines beginning with the row + 1 found in step 1 to the
17745 row found in step 2 or, if step 2 didn't find a row, to the end of
17748 4. If cursor is not known to appear on the window, give up.
17750 5. If display stopped at the row found in step 2, scroll the
17751 display and current matrix as needed.
17753 6. Maybe display some lines at the end of W, if we must. This can
17754 happen under various circumstances, like a partially visible line
17755 becoming fully visible, or because newly displayed lines are displayed
17756 in smaller font sizes.
17758 7. Update W's window end information. */
17761 try_window_id (struct window
*w
)
17763 struct frame
*f
= XFRAME (w
->frame
);
17764 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17765 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17766 struct glyph_row
*last_unchanged_at_beg_row
;
17767 struct glyph_row
*first_unchanged_at_end_row
;
17768 struct glyph_row
*row
;
17769 struct glyph_row
*bottom_row
;
17772 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17774 struct text_pos start_pos
;
17776 int first_unchanged_at_end_vpos
= 0;
17777 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17778 struct text_pos start
;
17779 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17782 if (inhibit_try_window_id
)
17786 /* This is handy for debugging. */
17788 #define GIVE_UP(X) \
17790 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17794 #define GIVE_UP(X) return 0
17797 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17799 /* Don't use this for mini-windows because these can show
17800 messages and mini-buffers, and we don't handle that here. */
17801 if (MINI_WINDOW_P (w
))
17804 /* This flag is used to prevent redisplay optimizations. */
17805 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17808 /* This function's optimizations cannot be used if overlays have
17809 changed in the buffer displayed by the window, so give up if they
17811 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17814 /* Verify that narrowing has not changed.
17815 Also verify that we were not told to prevent redisplay optimizations.
17816 It would be nice to further
17817 reduce the number of cases where this prevents try_window_id. */
17818 if (current_buffer
->clip_changed
17819 || current_buffer
->prevent_redisplay_optimizations_p
)
17822 /* Window must either use window-based redisplay or be full width. */
17823 if (!FRAME_WINDOW_P (f
)
17824 && (!FRAME_LINE_INS_DEL_OK (f
)
17825 || !WINDOW_FULL_WIDTH_P (w
)))
17828 /* Give up if point is known NOT to appear in W. */
17829 if (PT
< CHARPOS (start
))
17832 /* Another way to prevent redisplay optimizations. */
17833 if (w
->last_modified
== 0)
17836 /* Verify that window is not hscrolled. */
17837 if (w
->hscroll
!= 0)
17840 /* Verify that display wasn't paused. */
17841 if (!w
->window_end_valid
)
17844 /* Likewise if highlighting trailing whitespace. */
17845 if (!NILP (Vshow_trailing_whitespace
))
17848 /* Can't use this if overlay arrow position and/or string have
17850 if (overlay_arrows_changed_p ())
17853 /* When word-wrap is on, adding a space to the first word of a
17854 wrapped line can change the wrap position, altering the line
17855 above it. It might be worthwhile to handle this more
17856 intelligently, but for now just redisplay from scratch. */
17857 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17860 /* Under bidi reordering, adding or deleting a character in the
17861 beginning of a paragraph, before the first strong directional
17862 character, can change the base direction of the paragraph (unless
17863 the buffer specifies a fixed paragraph direction), which will
17864 require to redisplay the whole paragraph. It might be worthwhile
17865 to find the paragraph limits and widen the range of redisplayed
17866 lines to that, but for now just give up this optimization and
17867 redisplay from scratch. */
17868 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17869 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17872 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17873 to that variable require thorough redisplay. */
17874 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17877 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17878 only if buffer has really changed. The reason is that the gap is
17879 initially at Z for freshly visited files. The code below would
17880 set end_unchanged to 0 in that case. */
17881 if (MODIFF
> SAVE_MODIFF
17882 /* This seems to happen sometimes after saving a buffer. */
17883 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17885 if (GPT
- BEG
< BEG_UNCHANGED
)
17886 BEG_UNCHANGED
= GPT
- BEG
;
17887 if (Z
- GPT
< END_UNCHANGED
)
17888 END_UNCHANGED
= Z
- GPT
;
17891 /* The position of the first and last character that has been changed. */
17892 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17893 last_changed_charpos
= Z
- END_UNCHANGED
;
17895 /* If window starts after a line end, and the last change is in
17896 front of that newline, then changes don't affect the display.
17897 This case happens with stealth-fontification. Note that although
17898 the display is unchanged, glyph positions in the matrix have to
17899 be adjusted, of course. */
17900 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17901 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17902 && ((last_changed_charpos
< CHARPOS (start
)
17903 && CHARPOS (start
) == BEGV
)
17904 || (last_changed_charpos
< CHARPOS (start
) - 1
17905 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17907 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17908 struct glyph_row
*r0
;
17910 /* Compute how many chars/bytes have been added to or removed
17911 from the buffer. */
17912 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17913 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17914 Z_delta
= Z
- Z_old
;
17915 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17917 /* Give up if PT is not in the window. Note that it already has
17918 been checked at the start of try_window_id that PT is not in
17919 front of the window start. */
17920 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17923 /* If window start is unchanged, we can reuse the whole matrix
17924 as is, after adjusting glyph positions. No need to compute
17925 the window end again, since its offset from Z hasn't changed. */
17926 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17927 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17928 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17929 /* PT must not be in a partially visible line. */
17930 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17931 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17933 /* Adjust positions in the glyph matrix. */
17934 if (Z_delta
|| Z_delta_bytes
)
17936 struct glyph_row
*r1
17937 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17938 increment_matrix_positions (w
->current_matrix
,
17939 MATRIX_ROW_VPOS (r0
, current_matrix
),
17940 MATRIX_ROW_VPOS (r1
, current_matrix
),
17941 Z_delta
, Z_delta_bytes
);
17944 /* Set the cursor. */
17945 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17947 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17952 /* Handle the case that changes are all below what is displayed in
17953 the window, and that PT is in the window. This shortcut cannot
17954 be taken if ZV is visible in the window, and text has been added
17955 there that is visible in the window. */
17956 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17957 /* ZV is not visible in the window, or there are no
17958 changes at ZV, actually. */
17959 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17960 || first_changed_charpos
== last_changed_charpos
))
17962 struct glyph_row
*r0
;
17964 /* Give up if PT is not in the window. Note that it already has
17965 been checked at the start of try_window_id that PT is not in
17966 front of the window start. */
17967 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17970 /* If window start is unchanged, we can reuse the whole matrix
17971 as is, without changing glyph positions since no text has
17972 been added/removed in front of the window end. */
17973 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17974 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17975 /* PT must not be in a partially visible line. */
17976 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17977 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17979 /* We have to compute the window end anew since text
17980 could have been added/removed after it. */
17981 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17982 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17984 /* Set the cursor. */
17985 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17987 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17992 /* Give up if window start is in the changed area.
17994 The condition used to read
17996 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17998 but why that was tested escapes me at the moment. */
17999 if (CHARPOS (start
) >= first_changed_charpos
18000 && CHARPOS (start
) <= last_changed_charpos
)
18003 /* Check that window start agrees with the start of the first glyph
18004 row in its current matrix. Check this after we know the window
18005 start is not in changed text, otherwise positions would not be
18007 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18008 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18011 /* Give up if the window ends in strings. Overlay strings
18012 at the end are difficult to handle, so don't try. */
18013 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18014 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18017 /* Compute the position at which we have to start displaying new
18018 lines. Some of the lines at the top of the window might be
18019 reusable because they are not displaying changed text. Find the
18020 last row in W's current matrix not affected by changes at the
18021 start of current_buffer. Value is null if changes start in the
18022 first line of window. */
18023 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18024 if (last_unchanged_at_beg_row
)
18026 /* Avoid starting to display in the middle of a character, a TAB
18027 for instance. This is easier than to set up the iterator
18028 exactly, and it's not a frequent case, so the additional
18029 effort wouldn't really pay off. */
18030 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18031 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18032 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18033 --last_unchanged_at_beg_row
;
18035 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18038 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18040 start_pos
= it
.current
.pos
;
18042 /* Start displaying new lines in the desired matrix at the same
18043 vpos we would use in the current matrix, i.e. below
18044 last_unchanged_at_beg_row. */
18045 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18047 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18048 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18050 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18054 /* There are no reusable lines at the start of the window.
18055 Start displaying in the first text line. */
18056 start_display (&it
, w
, start
);
18057 it
.vpos
= it
.first_vpos
;
18058 start_pos
= it
.current
.pos
;
18061 /* Find the first row that is not affected by changes at the end of
18062 the buffer. Value will be null if there is no unchanged row, in
18063 which case we must redisplay to the end of the window. delta
18064 will be set to the value by which buffer positions beginning with
18065 first_unchanged_at_end_row have to be adjusted due to text
18067 first_unchanged_at_end_row
18068 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18069 IF_DEBUG (debug_delta
= delta
);
18070 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18072 /* Set stop_pos to the buffer position up to which we will have to
18073 display new lines. If first_unchanged_at_end_row != NULL, this
18074 is the buffer position of the start of the line displayed in that
18075 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18076 that we don't stop at a buffer position. */
18078 if (first_unchanged_at_end_row
)
18080 eassert (last_unchanged_at_beg_row
== NULL
18081 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18083 /* If this is a continuation line, move forward to the next one
18084 that isn't. Changes in lines above affect this line.
18085 Caution: this may move first_unchanged_at_end_row to a row
18086 not displaying text. */
18087 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18088 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18089 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18090 < it
.last_visible_y
))
18091 ++first_unchanged_at_end_row
;
18093 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18094 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18095 >= it
.last_visible_y
))
18096 first_unchanged_at_end_row
= NULL
;
18099 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18101 first_unchanged_at_end_vpos
18102 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18103 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18106 else if (last_unchanged_at_beg_row
== NULL
)
18112 /* Either there is no unchanged row at the end, or the one we have
18113 now displays text. This is a necessary condition for the window
18114 end pos calculation at the end of this function. */
18115 eassert (first_unchanged_at_end_row
== NULL
18116 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18118 debug_last_unchanged_at_beg_vpos
18119 = (last_unchanged_at_beg_row
18120 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18122 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18124 #endif /* GLYPH_DEBUG */
18127 /* Display new lines. Set last_text_row to the last new line
18128 displayed which has text on it, i.e. might end up as being the
18129 line where the window_end_vpos is. */
18130 w
->cursor
.vpos
= -1;
18131 last_text_row
= NULL
;
18132 overlay_arrow_seen
= false;
18133 if (it
.current_y
< it
.last_visible_y
18134 && !f
->fonts_changed
18135 && (first_unchanged_at_end_row
== NULL
18136 || IT_CHARPOS (it
) < stop_pos
))
18137 it
.glyph_row
->reversed_p
= false;
18138 while (it
.current_y
< it
.last_visible_y
18139 && !f
->fonts_changed
18140 && (first_unchanged_at_end_row
== NULL
18141 || IT_CHARPOS (it
) < stop_pos
))
18143 if (display_line (&it
))
18144 last_text_row
= it
.glyph_row
- 1;
18147 if (f
->fonts_changed
)
18150 /* The redisplay iterations in display_line above could have
18151 triggered font-lock, which could have done something that
18152 invalidates IT->w window's end-point information, on which we
18153 rely below. E.g., one package, which will remain unnamed, used
18154 to install a font-lock-fontify-region-function that called
18155 bury-buffer, whose side effect is to switch the buffer displayed
18156 by IT->w, and that predictably resets IT->w's window_end_valid
18157 flag, which we already tested at the entry to this function.
18158 Amply punish such packages/modes by giving up on this
18159 optimization in those cases. */
18160 if (!w
->window_end_valid
)
18162 clear_glyph_matrix (w
->desired_matrix
);
18166 /* Compute differences in buffer positions, y-positions etc. for
18167 lines reused at the bottom of the window. Compute what we can
18169 if (first_unchanged_at_end_row
18170 /* No lines reused because we displayed everything up to the
18171 bottom of the window. */
18172 && it
.current_y
< it
.last_visible_y
)
18175 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18177 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18178 run
.current_y
= first_unchanged_at_end_row
->y
;
18179 run
.desired_y
= run
.current_y
+ dy
;
18180 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18184 delta
= delta_bytes
= dvpos
= dy
18185 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18186 first_unchanged_at_end_row
= NULL
;
18188 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18191 /* Find the cursor if not already found. We have to decide whether
18192 PT will appear on this window (it sometimes doesn't, but this is
18193 not a very frequent case.) This decision has to be made before
18194 the current matrix is altered. A value of cursor.vpos < 0 means
18195 that PT is either in one of the lines beginning at
18196 first_unchanged_at_end_row or below the window. Don't care for
18197 lines that might be displayed later at the window end; as
18198 mentioned, this is not a frequent case. */
18199 if (w
->cursor
.vpos
< 0)
18201 /* Cursor in unchanged rows at the top? */
18202 if (PT
< CHARPOS (start_pos
)
18203 && last_unchanged_at_beg_row
)
18205 row
= row_containing_pos (w
, PT
,
18206 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18207 last_unchanged_at_beg_row
+ 1, 0);
18209 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18212 /* Start from first_unchanged_at_end_row looking for PT. */
18213 else if (first_unchanged_at_end_row
)
18215 row
= row_containing_pos (w
, PT
- delta
,
18216 first_unchanged_at_end_row
, NULL
, 0);
18218 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18219 delta_bytes
, dy
, dvpos
);
18222 /* Give up if cursor was not found. */
18223 if (w
->cursor
.vpos
< 0)
18225 clear_glyph_matrix (w
->desired_matrix
);
18230 /* Don't let the cursor end in the scroll margins. */
18232 int this_scroll_margin
, cursor_height
;
18233 int frame_line_height
= default_line_pixel_height (w
);
18234 int window_total_lines
18235 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18237 this_scroll_margin
=
18238 max (0, min (scroll_margin
, window_total_lines
/ 4));
18239 this_scroll_margin
*= frame_line_height
;
18240 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18242 if ((w
->cursor
.y
< this_scroll_margin
18243 && CHARPOS (start
) > BEGV
)
18244 /* Old redisplay didn't take scroll margin into account at the bottom,
18245 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18246 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18247 ? cursor_height
+ this_scroll_margin
18248 : 1)) > it
.last_visible_y
)
18250 w
->cursor
.vpos
= -1;
18251 clear_glyph_matrix (w
->desired_matrix
);
18256 /* Scroll the display. Do it before changing the current matrix so
18257 that xterm.c doesn't get confused about where the cursor glyph is
18259 if (dy
&& run
.height
)
18263 if (FRAME_WINDOW_P (f
))
18265 FRAME_RIF (f
)->update_window_begin_hook (w
);
18266 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18267 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18268 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18272 /* Terminal frame. In this case, dvpos gives the number of
18273 lines to scroll by; dvpos < 0 means scroll up. */
18275 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18276 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18277 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18278 + WINDOW_WANTS_HEADER_LINE_P (w
)
18279 + window_internal_height (w
));
18281 #if defined (HAVE_GPM) || defined (MSDOS)
18282 x_clear_window_mouse_face (w
);
18284 /* Perform the operation on the screen. */
18287 /* Scroll last_unchanged_at_beg_row to the end of the
18288 window down dvpos lines. */
18289 set_terminal_window (f
, end
);
18291 /* On dumb terminals delete dvpos lines at the end
18292 before inserting dvpos empty lines. */
18293 if (!FRAME_SCROLL_REGION_OK (f
))
18294 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18296 /* Insert dvpos empty lines in front of
18297 last_unchanged_at_beg_row. */
18298 ins_del_lines (f
, from
, dvpos
);
18300 else if (dvpos
< 0)
18302 /* Scroll up last_unchanged_at_beg_vpos to the end of
18303 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18304 set_terminal_window (f
, end
);
18306 /* Delete dvpos lines in front of
18307 last_unchanged_at_beg_vpos. ins_del_lines will set
18308 the cursor to the given vpos and emit |dvpos| delete
18310 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18312 /* On a dumb terminal insert dvpos empty lines at the
18314 if (!FRAME_SCROLL_REGION_OK (f
))
18315 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18318 set_terminal_window (f
, 0);
18324 /* Shift reused rows of the current matrix to the right position.
18325 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18327 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18328 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18331 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18332 bottom_vpos
, dvpos
);
18333 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18336 else if (dvpos
> 0)
18338 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18339 bottom_vpos
, dvpos
);
18340 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18341 first_unchanged_at_end_vpos
+ dvpos
);
18344 /* For frame-based redisplay, make sure that current frame and window
18345 matrix are in sync with respect to glyph memory. */
18346 if (!FRAME_WINDOW_P (f
))
18347 sync_frame_with_window_matrix_rows (w
);
18349 /* Adjust buffer positions in reused rows. */
18350 if (delta
|| delta_bytes
)
18351 increment_matrix_positions (current_matrix
,
18352 first_unchanged_at_end_vpos
+ dvpos
,
18353 bottom_vpos
, delta
, delta_bytes
);
18355 /* Adjust Y positions. */
18357 shift_glyph_matrix (w
, current_matrix
,
18358 first_unchanged_at_end_vpos
+ dvpos
,
18361 if (first_unchanged_at_end_row
)
18363 first_unchanged_at_end_row
+= dvpos
;
18364 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18365 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18366 first_unchanged_at_end_row
= NULL
;
18369 /* If scrolling up, there may be some lines to display at the end of
18371 last_text_row_at_end
= NULL
;
18374 /* Scrolling up can leave for example a partially visible line
18375 at the end of the window to be redisplayed. */
18376 /* Set last_row to the glyph row in the current matrix where the
18377 window end line is found. It has been moved up or down in
18378 the matrix by dvpos. */
18379 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18380 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18382 /* If last_row is the window end line, it should display text. */
18383 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18385 /* If window end line was partially visible before, begin
18386 displaying at that line. Otherwise begin displaying with the
18387 line following it. */
18388 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18390 init_to_row_start (&it
, w
, last_row
);
18391 it
.vpos
= last_vpos
;
18392 it
.current_y
= last_row
->y
;
18396 init_to_row_end (&it
, w
, last_row
);
18397 it
.vpos
= 1 + last_vpos
;
18398 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18402 /* We may start in a continuation line. If so, we have to
18403 get the right continuation_lines_width and current_x. */
18404 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18405 it
.hpos
= it
.current_x
= 0;
18407 /* Display the rest of the lines at the window end. */
18408 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18409 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18411 /* Is it always sure that the display agrees with lines in
18412 the current matrix? I don't think so, so we mark rows
18413 displayed invalid in the current matrix by setting their
18414 enabled_p flag to false. */
18415 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18416 if (display_line (&it
))
18417 last_text_row_at_end
= it
.glyph_row
- 1;
18421 /* Update window_end_pos and window_end_vpos. */
18422 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18424 /* Window end line if one of the preserved rows from the current
18425 matrix. Set row to the last row displaying text in current
18426 matrix starting at first_unchanged_at_end_row, after
18428 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18429 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18430 first_unchanged_at_end_row
);
18431 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18432 adjust_window_ends (w
, row
, true);
18433 eassert (w
->window_end_bytepos
>= 0);
18434 IF_DEBUG (debug_method_add (w
, "A"));
18436 else if (last_text_row_at_end
)
18438 adjust_window_ends (w
, last_text_row_at_end
, false);
18439 eassert (w
->window_end_bytepos
>= 0);
18440 IF_DEBUG (debug_method_add (w
, "B"));
18442 else if (last_text_row
)
18444 /* We have displayed either to the end of the window or at the
18445 end of the window, i.e. the last row with text is to be found
18446 in the desired matrix. */
18447 adjust_window_ends (w
, last_text_row
, false);
18448 eassert (w
->window_end_bytepos
>= 0);
18450 else if (first_unchanged_at_end_row
== NULL
18451 && last_text_row
== NULL
18452 && last_text_row_at_end
== NULL
)
18454 /* Displayed to end of window, but no line containing text was
18455 displayed. Lines were deleted at the end of the window. */
18456 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18457 int vpos
= w
->window_end_vpos
;
18458 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18459 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18462 row
== NULL
&& vpos
>= first_vpos
;
18463 --vpos
, --current_row
, --desired_row
)
18465 if (desired_row
->enabled_p
)
18467 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18470 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18474 eassert (row
!= NULL
);
18475 w
->window_end_vpos
= vpos
+ 1;
18476 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18477 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18478 eassert (w
->window_end_bytepos
>= 0);
18479 IF_DEBUG (debug_method_add (w
, "C"));
18484 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18485 debug_end_vpos
= w
->window_end_vpos
));
18487 /* Record that display has not been completed. */
18488 w
->window_end_valid
= false;
18489 w
->desired_matrix
->no_scrolling_p
= true;
18497 /***********************************************************************
18498 More debugging support
18499 ***********************************************************************/
18503 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18504 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18505 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18508 /* Dump the contents of glyph matrix MATRIX on stderr.
18510 GLYPHS 0 means don't show glyph contents.
18511 GLYPHS 1 means show glyphs in short form
18512 GLYPHS > 1 means show glyphs in long form. */
18515 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18518 for (i
= 0; i
< matrix
->nrows
; ++i
)
18519 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18523 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18524 the glyph row and area where the glyph comes from. */
18527 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18529 if (glyph
->type
== CHAR_GLYPH
18530 || glyph
->type
== GLYPHLESS_GLYPH
)
18533 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18534 glyph
- row
->glyphs
[TEXT_AREA
],
18535 (glyph
->type
== CHAR_GLYPH
18539 (BUFFERP (glyph
->object
)
18541 : (STRINGP (glyph
->object
)
18543 : (NILP (glyph
->object
)
18546 glyph
->pixel_width
,
18548 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18552 glyph
->left_box_line_p
,
18553 glyph
->right_box_line_p
);
18555 else if (glyph
->type
== STRETCH_GLYPH
)
18558 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18559 glyph
- row
->glyphs
[TEXT_AREA
],
18562 (BUFFERP (glyph
->object
)
18564 : (STRINGP (glyph
->object
)
18566 : (NILP (glyph
->object
)
18569 glyph
->pixel_width
,
18573 glyph
->left_box_line_p
,
18574 glyph
->right_box_line_p
);
18576 else if (glyph
->type
== IMAGE_GLYPH
)
18579 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18580 glyph
- row
->glyphs
[TEXT_AREA
],
18583 (BUFFERP (glyph
->object
)
18585 : (STRINGP (glyph
->object
)
18587 : (NILP (glyph
->object
)
18590 glyph
->pixel_width
,
18594 glyph
->left_box_line_p
,
18595 glyph
->right_box_line_p
);
18597 else if (glyph
->type
== COMPOSITE_GLYPH
)
18600 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18601 glyph
- row
->glyphs
[TEXT_AREA
],
18604 (BUFFERP (glyph
->object
)
18606 : (STRINGP (glyph
->object
)
18608 : (NILP (glyph
->object
)
18611 glyph
->pixel_width
,
18613 if (glyph
->u
.cmp
.automatic
)
18616 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18617 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18619 glyph
->left_box_line_p
,
18620 glyph
->right_box_line_p
);
18625 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18626 GLYPHS 0 means don't show glyph contents.
18627 GLYPHS 1 means show glyphs in short form
18628 GLYPHS > 1 means show glyphs in long form. */
18631 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18635 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18636 fprintf (stderr
, "==============================================================================\n");
18638 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18639 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18641 MATRIX_ROW_START_CHARPOS (row
),
18642 MATRIX_ROW_END_CHARPOS (row
),
18643 row
->used
[TEXT_AREA
],
18644 row
->contains_overlapping_glyphs_p
,
18646 row
->truncated_on_left_p
,
18647 row
->truncated_on_right_p
,
18649 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18650 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18653 row
->ends_in_middle_of_char_p
,
18654 row
->starts_in_middle_of_char_p
,
18660 row
->visible_height
,
18663 /* The next 3 lines should align to "Start" in the header. */
18664 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18665 row
->end
.overlay_string_index
,
18666 row
->continuation_lines_width
);
18667 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18668 CHARPOS (row
->start
.string_pos
),
18669 CHARPOS (row
->end
.string_pos
));
18670 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18671 row
->end
.dpvec_index
);
18678 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18680 struct glyph
*glyph
= row
->glyphs
[area
];
18681 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18683 /* Glyph for a line end in text. */
18684 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18687 if (glyph
< glyph_end
)
18688 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18690 for (; glyph
< glyph_end
; ++glyph
)
18691 dump_glyph (row
, glyph
, area
);
18694 else if (glyphs
== 1)
18697 char s
[SHRT_MAX
+ 4];
18699 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18703 for (i
= 0; i
< row
->used
[area
]; ++i
)
18705 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18706 if (i
== row
->used
[area
] - 1
18707 && area
== TEXT_AREA
18708 && NILP (glyph
->object
)
18709 && glyph
->type
== CHAR_GLYPH
18710 && glyph
->u
.ch
== ' ')
18712 strcpy (&s
[i
], "[\\n]");
18715 else if (glyph
->type
== CHAR_GLYPH
18716 && glyph
->u
.ch
< 0x80
18717 && glyph
->u
.ch
>= ' ')
18718 s
[i
] = glyph
->u
.ch
;
18724 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18730 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18731 Sdump_glyph_matrix
, 0, 1, "p",
18732 doc
: /* Dump the current matrix of the selected window to stderr.
18733 Shows contents of glyph row structures. With non-nil
18734 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18735 glyphs in short form, otherwise show glyphs in long form.
18737 Interactively, no argument means show glyphs in short form;
18738 with numeric argument, its value is passed as the GLYPHS flag. */)
18739 (Lisp_Object glyphs
)
18741 struct window
*w
= XWINDOW (selected_window
);
18742 struct buffer
*buffer
= XBUFFER (w
->contents
);
18744 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18745 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18746 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18747 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18748 fprintf (stderr
, "=============================================\n");
18749 dump_glyph_matrix (w
->current_matrix
,
18750 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18755 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18756 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18757 Only text-mode frames have frame glyph matrices. */)
18760 struct frame
*f
= XFRAME (selected_frame
);
18762 if (f
->current_matrix
)
18763 dump_glyph_matrix (f
->current_matrix
, 1);
18765 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18770 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18771 doc
: /* Dump glyph row ROW to stderr.
18772 GLYPH 0 means don't dump glyphs.
18773 GLYPH 1 means dump glyphs in short form.
18774 GLYPH > 1 or omitted means dump glyphs in long form. */)
18775 (Lisp_Object row
, Lisp_Object glyphs
)
18777 struct glyph_matrix
*matrix
;
18780 CHECK_NUMBER (row
);
18781 matrix
= XWINDOW (selected_window
)->current_matrix
;
18783 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18784 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18786 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18791 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18792 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18793 GLYPH 0 means don't dump glyphs.
18794 GLYPH 1 means dump glyphs in short form.
18795 GLYPH > 1 or omitted means dump glyphs in long form.
18797 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18799 (Lisp_Object row
, Lisp_Object glyphs
)
18801 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18802 struct frame
*sf
= SELECTED_FRAME ();
18803 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18806 CHECK_NUMBER (row
);
18808 if (vpos
>= 0 && vpos
< m
->nrows
)
18809 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18810 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18816 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18817 doc
: /* Toggle tracing of redisplay.
18818 With ARG, turn tracing on if and only if ARG is positive. */)
18822 trace_redisplay_p
= !trace_redisplay_p
;
18825 arg
= Fprefix_numeric_value (arg
);
18826 trace_redisplay_p
= XINT (arg
) > 0;
18833 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18834 doc
: /* Like `format', but print result to stderr.
18835 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18836 (ptrdiff_t nargs
, Lisp_Object
*args
)
18838 Lisp_Object s
= Fformat (nargs
, args
);
18839 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18843 #endif /* GLYPH_DEBUG */
18847 /***********************************************************************
18848 Building Desired Matrix Rows
18849 ***********************************************************************/
18851 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18852 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18854 static struct glyph_row
*
18855 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18857 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18858 struct buffer
*buffer
= XBUFFER (w
->contents
);
18859 struct buffer
*old
= current_buffer
;
18860 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18861 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18862 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18863 const unsigned char *p
;
18866 int n_glyphs_before
;
18868 set_buffer_temp (buffer
);
18869 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18870 scratch_glyph_row
.reversed_p
= false;
18871 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18872 SET_TEXT_POS (it
.position
, 0, 0);
18874 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18876 while (p
< arrow_end
)
18878 Lisp_Object face
, ilisp
;
18880 /* Get the next character. */
18882 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18885 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18886 if (! ASCII_CHAR_P (it
.c
))
18887 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18891 /* Get its face. */
18892 ilisp
= make_number (p
- arrow_string
);
18893 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18894 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18896 /* Compute its width, get its glyphs. */
18897 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18898 SET_TEXT_POS (it
.position
, -1, -1);
18899 PRODUCE_GLYPHS (&it
);
18901 /* If this character doesn't fit any more in the line, we have
18902 to remove some glyphs. */
18903 if (it
.current_x
> it
.last_visible_x
)
18905 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18910 set_buffer_temp (old
);
18911 return it
.glyph_row
;
18915 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18916 glyphs to insert is determined by produce_special_glyphs. */
18919 insert_left_trunc_glyphs (struct it
*it
)
18921 struct it truncate_it
;
18922 struct glyph
*from
, *end
, *to
, *toend
;
18924 eassert (!FRAME_WINDOW_P (it
->f
)
18925 || (!it
->glyph_row
->reversed_p
18926 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18927 || (it
->glyph_row
->reversed_p
18928 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18930 /* Get the truncation glyphs. */
18932 truncate_it
.current_x
= 0;
18933 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18934 truncate_it
.glyph_row
= &scratch_glyph_row
;
18935 truncate_it
.area
= TEXT_AREA
;
18936 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18937 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18938 truncate_it
.object
= Qnil
;
18939 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18941 /* Overwrite glyphs from IT with truncation glyphs. */
18942 if (!it
->glyph_row
->reversed_p
)
18944 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18946 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18947 end
= from
+ tused
;
18948 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18949 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18950 if (FRAME_WINDOW_P (it
->f
))
18952 /* On GUI frames, when variable-size fonts are displayed,
18953 the truncation glyphs may need more pixels than the row's
18954 glyphs they overwrite. We overwrite more glyphs to free
18955 enough screen real estate, and enlarge the stretch glyph
18956 on the right (see display_line), if there is one, to
18957 preserve the screen position of the truncation glyphs on
18960 struct glyph
*g
= to
;
18963 /* The first glyph could be partially visible, in which case
18964 it->glyph_row->x will be negative. But we want the left
18965 truncation glyphs to be aligned at the left margin of the
18966 window, so we override the x coordinate at which the row
18968 it
->glyph_row
->x
= 0;
18969 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18971 w
+= g
->pixel_width
;
18974 if (g
- to
- tused
> 0)
18976 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18977 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18979 used
= it
->glyph_row
->used
[TEXT_AREA
];
18980 if (it
->glyph_row
->truncated_on_right_p
18981 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18982 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18985 int extra
= w
- it
->truncation_pixel_width
;
18987 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18994 /* There may be padding glyphs left over. Overwrite them too. */
18995 if (!FRAME_WINDOW_P (it
->f
))
18997 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18999 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19006 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19010 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19012 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19013 that back to front. */
19014 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19015 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19016 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19017 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19018 if (FRAME_WINDOW_P (it
->f
))
19021 struct glyph
*g
= to
;
19023 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19025 w
+= g
->pixel_width
;
19028 if (to
- g
- tused
> 0)
19030 if (it
->glyph_row
->truncated_on_right_p
19031 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19032 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19034 int extra
= w
- it
->truncation_pixel_width
;
19036 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19040 while (from
>= end
&& to
>= toend
)
19042 if (!FRAME_WINDOW_P (it
->f
))
19044 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19047 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19048 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19049 while (from
>= end
&& to
>= toend
)
19055 /* Need to free some room before prepending additional
19057 int move_by
= from
- end
+ 1;
19058 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19059 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19061 for ( ; g
>= g0
; g
--)
19063 while (from
>= end
)
19065 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19070 /* Compute the hash code for ROW. */
19072 row_hash (struct glyph_row
*row
)
19075 unsigned hashval
= 0;
19077 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19078 for (k
= 0; k
< row
->used
[area
]; ++k
)
19079 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19080 + row
->glyphs
[area
][k
].u
.val
19081 + row
->glyphs
[area
][k
].face_id
19082 + row
->glyphs
[area
][k
].padding_p
19083 + (row
->glyphs
[area
][k
].type
<< 2));
19088 /* Compute the pixel height and width of IT->glyph_row.
19090 Most of the time, ascent and height of a display line will be equal
19091 to the max_ascent and max_height values of the display iterator
19092 structure. This is not the case if
19094 1. We hit ZV without displaying anything. In this case, max_ascent
19095 and max_height will be zero.
19097 2. We have some glyphs that don't contribute to the line height.
19098 (The glyph row flag contributes_to_line_height_p is for future
19099 pixmap extensions).
19101 The first case is easily covered by using default values because in
19102 these cases, the line height does not really matter, except that it
19103 must not be zero. */
19106 compute_line_metrics (struct it
*it
)
19108 struct glyph_row
*row
= it
->glyph_row
;
19110 if (FRAME_WINDOW_P (it
->f
))
19112 int i
, min_y
, max_y
;
19114 /* The line may consist of one space only, that was added to
19115 place the cursor on it. If so, the row's height hasn't been
19117 if (row
->height
== 0)
19119 if (it
->max_ascent
+ it
->max_descent
== 0)
19120 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19121 row
->ascent
= it
->max_ascent
;
19122 row
->height
= it
->max_ascent
+ it
->max_descent
;
19123 row
->phys_ascent
= it
->max_phys_ascent
;
19124 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19125 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19128 /* Compute the width of this line. */
19129 row
->pixel_width
= row
->x
;
19130 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19131 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19133 eassert (row
->pixel_width
>= 0);
19134 eassert (row
->ascent
>= 0 && row
->height
> 0);
19136 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19137 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19139 /* If first line's physical ascent is larger than its logical
19140 ascent, use the physical ascent, and make the row taller.
19141 This makes accented characters fully visible. */
19142 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19143 && row
->phys_ascent
> row
->ascent
)
19145 row
->height
+= row
->phys_ascent
- row
->ascent
;
19146 row
->ascent
= row
->phys_ascent
;
19149 /* Compute how much of the line is visible. */
19150 row
->visible_height
= row
->height
;
19152 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19153 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19155 if (row
->y
< min_y
)
19156 row
->visible_height
-= min_y
- row
->y
;
19157 if (row
->y
+ row
->height
> max_y
)
19158 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19162 row
->pixel_width
= row
->used
[TEXT_AREA
];
19163 if (row
->continued_p
)
19164 row
->pixel_width
-= it
->continuation_pixel_width
;
19165 else if (row
->truncated_on_right_p
)
19166 row
->pixel_width
-= it
->truncation_pixel_width
;
19167 row
->ascent
= row
->phys_ascent
= 0;
19168 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19169 row
->extra_line_spacing
= 0;
19172 /* Compute a hash code for this row. */
19173 row
->hash
= row_hash (row
);
19175 it
->max_ascent
= it
->max_descent
= 0;
19176 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19180 /* Append one space to the glyph row of iterator IT if doing a
19181 window-based redisplay. The space has the same face as
19182 IT->face_id. Value is true if a space was added.
19184 This function is called to make sure that there is always one glyph
19185 at the end of a glyph row that the cursor can be set on under
19186 window-systems. (If there weren't such a glyph we would not know
19187 how wide and tall a box cursor should be displayed).
19189 At the same time this space let's a nicely handle clearing to the
19190 end of the line if the row ends in italic text. */
19193 append_space_for_newline (struct it
*it
, bool default_face_p
)
19195 if (FRAME_WINDOW_P (it
->f
))
19197 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19199 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19200 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19202 /* Save some values that must not be changed.
19203 Must save IT->c and IT->len because otherwise
19204 ITERATOR_AT_END_P wouldn't work anymore after
19205 append_space_for_newline has been called. */
19206 enum display_element_type saved_what
= it
->what
;
19207 int saved_c
= it
->c
, saved_len
= it
->len
;
19208 int saved_char_to_display
= it
->char_to_display
;
19209 int saved_x
= it
->current_x
;
19210 int saved_face_id
= it
->face_id
;
19211 bool saved_box_end
= it
->end_of_box_run_p
;
19212 struct text_pos saved_pos
;
19213 Lisp_Object saved_object
;
19217 saved_object
= it
->object
;
19218 saved_pos
= it
->position
;
19220 it
->what
= IT_CHARACTER
;
19221 memset (&it
->position
, 0, sizeof it
->position
);
19223 it
->c
= it
->char_to_display
= ' ';
19226 /* If the default face was remapped, be sure to use the
19227 remapped face for the appended newline. */
19228 if (default_face_p
)
19229 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19230 else if (it
->face_before_selective_p
)
19231 it
->face_id
= it
->saved_face_id
;
19232 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19233 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19234 /* In R2L rows, we will prepend a stretch glyph that will
19235 have the end_of_box_run_p flag set for it, so there's no
19236 need for the appended newline glyph to have that flag
19238 if (it
->glyph_row
->reversed_p
19239 /* But if the appended newline glyph goes all the way to
19240 the end of the row, there will be no stretch glyph,
19241 so leave the box flag set. */
19242 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19243 it
->end_of_box_run_p
= false;
19245 PRODUCE_GLYPHS (it
);
19247 #ifdef HAVE_WINDOW_SYSTEM
19248 /* Make sure this space glyph has the right ascent and
19249 descent values, or else cursor at end of line will look
19250 funny, and height of empty lines will be incorrect. */
19251 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19252 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19255 Lisp_Object height
, total_height
;
19256 int extra_line_spacing
= it
->extra_line_spacing
;
19257 int boff
= font
->baseline_offset
;
19259 if (font
->vertical_centering
)
19260 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19262 it
->object
= saved_object
; /* get_it_property needs this */
19263 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19264 /* Must do a subset of line height processing from
19265 x_produce_glyph for newline characters. */
19266 height
= get_it_property (it
, Qline_height
);
19268 && CONSP (XCDR (height
))
19269 && NILP (XCDR (XCDR (height
))))
19271 total_height
= XCAR (XCDR (height
));
19272 height
= XCAR (height
);
19275 total_height
= Qnil
;
19276 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19278 if (it
->override_ascent
>= 0)
19280 it
->ascent
= it
->override_ascent
;
19281 it
->descent
= it
->override_descent
;
19282 boff
= it
->override_boff
;
19284 if (EQ (height
, Qt
))
19285 extra_line_spacing
= 0;
19288 Lisp_Object spacing
;
19290 it
->phys_ascent
= it
->ascent
;
19291 it
->phys_descent
= it
->descent
;
19293 && XINT (height
) > it
->ascent
+ it
->descent
)
19294 it
->ascent
= XINT (height
) - it
->descent
;
19296 if (!NILP (total_height
))
19297 spacing
= calc_line_height_property (it
, total_height
, font
,
19301 spacing
= get_it_property (it
, Qline_spacing
);
19302 spacing
= calc_line_height_property (it
, spacing
, font
,
19305 if (INTEGERP (spacing
))
19307 extra_line_spacing
= XINT (spacing
);
19308 if (!NILP (total_height
))
19309 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19312 if (extra_line_spacing
> 0)
19314 it
->descent
+= extra_line_spacing
;
19315 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19316 it
->max_extra_line_spacing
= extra_line_spacing
;
19318 it
->max_ascent
= it
->ascent
;
19319 it
->max_descent
= it
->descent
;
19320 /* Make sure compute_line_metrics recomputes the row height. */
19321 it
->glyph_row
->height
= 0;
19324 g
->ascent
= it
->max_ascent
;
19325 g
->descent
= it
->max_descent
;
19328 it
->override_ascent
= -1;
19329 it
->constrain_row_ascent_descent_p
= false;
19330 it
->current_x
= saved_x
;
19331 it
->object
= saved_object
;
19332 it
->position
= saved_pos
;
19333 it
->what
= saved_what
;
19334 it
->face_id
= saved_face_id
;
19335 it
->len
= saved_len
;
19337 it
->char_to_display
= saved_char_to_display
;
19338 it
->end_of_box_run_p
= saved_box_end
;
19347 /* Extend the face of the last glyph in the text area of IT->glyph_row
19348 to the end of the display line. Called from display_line. If the
19349 glyph row is empty, add a space glyph to it so that we know the
19350 face to draw. Set the glyph row flag fill_line_p. If the glyph
19351 row is R2L, prepend a stretch glyph to cover the empty space to the
19352 left of the leftmost glyph. */
19355 extend_face_to_end_of_line (struct it
*it
)
19357 struct face
*face
, *default_face
;
19358 struct frame
*f
= it
->f
;
19360 /* If line is already filled, do nothing. Non window-system frames
19361 get a grace of one more ``pixel'' because their characters are
19362 1-``pixel'' wide, so they hit the equality too early. This grace
19363 is needed only for R2L rows that are not continued, to produce
19364 one extra blank where we could display the cursor. */
19365 if ((it
->current_x
>= it
->last_visible_x
19366 + (!FRAME_WINDOW_P (f
)
19367 && it
->glyph_row
->reversed_p
19368 && !it
->glyph_row
->continued_p
))
19369 /* If the window has display margins, we will need to extend
19370 their face even if the text area is filled. */
19371 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19372 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19375 /* The default face, possibly remapped. */
19376 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19378 /* Face extension extends the background and box of IT->face_id
19379 to the end of the line. If the background equals the background
19380 of the frame, we don't have to do anything. */
19381 if (it
->face_before_selective_p
)
19382 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19384 face
= FACE_FROM_ID (f
, it
->face_id
);
19386 if (FRAME_WINDOW_P (f
)
19387 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19388 && face
->box
== FACE_NO_BOX
19389 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19390 #ifdef HAVE_WINDOW_SYSTEM
19393 && !it
->glyph_row
->reversed_p
)
19396 /* Set the glyph row flag indicating that the face of the last glyph
19397 in the text area has to be drawn to the end of the text area. */
19398 it
->glyph_row
->fill_line_p
= true;
19400 /* If current character of IT is not ASCII, make sure we have the
19401 ASCII face. This will be automatically undone the next time
19402 get_next_display_element returns a multibyte character. Note
19403 that the character will always be single byte in unibyte
19405 if (!ASCII_CHAR_P (it
->c
))
19407 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19410 if (FRAME_WINDOW_P (f
))
19412 /* If the row is empty, add a space with the current face of IT,
19413 so that we know which face to draw. */
19414 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19416 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19417 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19418 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19420 /* Mode line and the header line don't have margins, and
19421 likewise the frame's tool-bar window, if there is any. */
19422 if (!(it
->glyph_row
->mode_line_p
19423 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19424 || (WINDOWP (f
->tool_bar_window
)
19425 && it
->w
== XWINDOW (f
->tool_bar_window
))
19429 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19430 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19432 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19433 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19435 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19437 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19438 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19440 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19441 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19443 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19446 #ifdef HAVE_WINDOW_SYSTEM
19447 if (it
->glyph_row
->reversed_p
)
19449 /* Prepend a stretch glyph to the row, such that the
19450 rightmost glyph will be drawn flushed all the way to the
19451 right margin of the window. The stretch glyph that will
19452 occupy the empty space, if any, to the left of the
19454 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19455 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19456 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19458 int row_width
, stretch_ascent
, stretch_width
;
19459 struct text_pos saved_pos
;
19461 bool saved_avoid_cursor
, saved_box_start
;
19463 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19464 row_width
+= g
->pixel_width
;
19466 /* FIXME: There are various minor display glitches in R2L
19467 rows when only one of the fringes is missing. The
19468 strange condition below produces the least bad effect. */
19469 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19470 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19471 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19472 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19474 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19475 stretch_width
-= row_width
;
19477 if (stretch_width
> 0)
19480 (((it
->ascent
+ it
->descent
)
19481 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19482 saved_pos
= it
->position
;
19483 memset (&it
->position
, 0, sizeof it
->position
);
19484 saved_avoid_cursor
= it
->avoid_cursor_p
;
19485 it
->avoid_cursor_p
= true;
19486 saved_face_id
= it
->face_id
;
19487 saved_box_start
= it
->start_of_box_run_p
;
19488 /* The last row's stretch glyph should get the default
19489 face, to avoid painting the rest of the window with
19490 the region face, if the region ends at ZV. */
19491 if (it
->glyph_row
->ends_at_zv_p
)
19492 it
->face_id
= default_face
->id
;
19494 it
->face_id
= face
->id
;
19495 it
->start_of_box_run_p
= false;
19496 append_stretch_glyph (it
, Qnil
, stretch_width
,
19497 it
->ascent
+ it
->descent
, stretch_ascent
);
19498 it
->position
= saved_pos
;
19499 it
->avoid_cursor_p
= saved_avoid_cursor
;
19500 it
->face_id
= saved_face_id
;
19501 it
->start_of_box_run_p
= saved_box_start
;
19503 /* If stretch_width comes out negative, it means that the
19504 last glyph is only partially visible. In R2L rows, we
19505 want the leftmost glyph to be partially visible, so we
19506 need to give the row the corresponding left offset. */
19507 if (stretch_width
< 0)
19508 it
->glyph_row
->x
= stretch_width
;
19510 #endif /* HAVE_WINDOW_SYSTEM */
19514 /* Save some values that must not be changed. */
19515 int saved_x
= it
->current_x
;
19516 struct text_pos saved_pos
;
19517 Lisp_Object saved_object
;
19518 enum display_element_type saved_what
= it
->what
;
19519 int saved_face_id
= it
->face_id
;
19521 saved_object
= it
->object
;
19522 saved_pos
= it
->position
;
19524 it
->what
= IT_CHARACTER
;
19525 memset (&it
->position
, 0, sizeof it
->position
);
19527 it
->c
= it
->char_to_display
= ' ';
19530 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19531 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19532 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19533 && !it
->glyph_row
->mode_line_p
19534 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19536 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19537 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19539 for (it
->current_x
= 0; g
< e
; g
++)
19540 it
->current_x
+= g
->pixel_width
;
19542 it
->area
= LEFT_MARGIN_AREA
;
19543 it
->face_id
= default_face
->id
;
19544 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19545 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19547 PRODUCE_GLYPHS (it
);
19548 /* term.c:produce_glyphs advances it->current_x only for
19550 it
->current_x
+= it
->pixel_width
;
19553 it
->current_x
= saved_x
;
19554 it
->area
= TEXT_AREA
;
19557 /* The last row's blank glyphs should get the default face, to
19558 avoid painting the rest of the window with the region face,
19559 if the region ends at ZV. */
19560 if (it
->glyph_row
->ends_at_zv_p
)
19561 it
->face_id
= default_face
->id
;
19563 it
->face_id
= face
->id
;
19564 PRODUCE_GLYPHS (it
);
19566 while (it
->current_x
<= it
->last_visible_x
)
19567 PRODUCE_GLYPHS (it
);
19569 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19570 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19571 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19572 && !it
->glyph_row
->mode_line_p
19573 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19575 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19576 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19578 for ( ; g
< e
; g
++)
19579 it
->current_x
+= g
->pixel_width
;
19581 it
->area
= RIGHT_MARGIN_AREA
;
19582 it
->face_id
= default_face
->id
;
19583 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19584 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19586 PRODUCE_GLYPHS (it
);
19587 it
->current_x
+= it
->pixel_width
;
19590 it
->area
= TEXT_AREA
;
19593 /* Don't count these blanks really. It would let us insert a left
19594 truncation glyph below and make us set the cursor on them, maybe. */
19595 it
->current_x
= saved_x
;
19596 it
->object
= saved_object
;
19597 it
->position
= saved_pos
;
19598 it
->what
= saved_what
;
19599 it
->face_id
= saved_face_id
;
19604 /* Value is true if text starting at CHARPOS in current_buffer is
19605 trailing whitespace. */
19608 trailing_whitespace_p (ptrdiff_t charpos
)
19610 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19613 while (bytepos
< ZV_BYTE
19614 && (c
= FETCH_CHAR (bytepos
),
19615 c
== ' ' || c
== '\t'))
19618 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19620 if (bytepos
!= PT_BYTE
)
19627 /* Highlight trailing whitespace, if any, in ROW. */
19630 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19632 int used
= row
->used
[TEXT_AREA
];
19636 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19637 struct glyph
*glyph
= start
+ used
- 1;
19639 if (row
->reversed_p
)
19641 /* Right-to-left rows need to be processed in the opposite
19642 direction, so swap the edge pointers. */
19644 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19647 /* Skip over glyphs inserted to display the cursor at the
19648 end of a line, for extending the face of the last glyph
19649 to the end of the line on terminals, and for truncation
19650 and continuation glyphs. */
19651 if (!row
->reversed_p
)
19653 while (glyph
>= start
19654 && glyph
->type
== CHAR_GLYPH
19655 && NILP (glyph
->object
))
19660 while (glyph
<= start
19661 && glyph
->type
== CHAR_GLYPH
19662 && NILP (glyph
->object
))
19666 /* If last glyph is a space or stretch, and it's trailing
19667 whitespace, set the face of all trailing whitespace glyphs in
19668 IT->glyph_row to `trailing-whitespace'. */
19669 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19670 && BUFFERP (glyph
->object
)
19671 && (glyph
->type
== STRETCH_GLYPH
19672 || (glyph
->type
== CHAR_GLYPH
19673 && glyph
->u
.ch
== ' '))
19674 && trailing_whitespace_p (glyph
->charpos
))
19676 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19680 if (!row
->reversed_p
)
19682 while (glyph
>= start
19683 && BUFFERP (glyph
->object
)
19684 && (glyph
->type
== STRETCH_GLYPH
19685 || (glyph
->type
== CHAR_GLYPH
19686 && glyph
->u
.ch
== ' ')))
19687 (glyph
--)->face_id
= face_id
;
19691 while (glyph
<= start
19692 && BUFFERP (glyph
->object
)
19693 && (glyph
->type
== STRETCH_GLYPH
19694 || (glyph
->type
== CHAR_GLYPH
19695 && glyph
->u
.ch
== ' ')))
19696 (glyph
++)->face_id
= face_id
;
19703 /* Value is true if glyph row ROW should be
19704 considered to hold the buffer position CHARPOS. */
19707 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19709 bool result
= true;
19711 if (charpos
== CHARPOS (row
->end
.pos
)
19712 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19714 /* Suppose the row ends on a string.
19715 Unless the row is continued, that means it ends on a newline
19716 in the string. If it's anything other than a display string
19717 (e.g., a before-string from an overlay), we don't want the
19718 cursor there. (This heuristic seems to give the optimal
19719 behavior for the various types of multi-line strings.)
19720 One exception: if the string has `cursor' property on one of
19721 its characters, we _do_ want the cursor there. */
19722 if (CHARPOS (row
->end
.string_pos
) >= 0)
19724 if (row
->continued_p
)
19728 /* Check for `display' property. */
19729 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19730 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19731 struct glyph
*glyph
;
19734 for (glyph
= end
; glyph
>= beg
; --glyph
)
19735 if (STRINGP (glyph
->object
))
19738 = Fget_char_property (make_number (charpos
),
19742 && display_prop_string_p (prop
, glyph
->object
));
19743 /* If there's a `cursor' property on one of the
19744 string's characters, this row is a cursor row,
19745 even though this is not a display string. */
19748 Lisp_Object s
= glyph
->object
;
19750 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19752 ptrdiff_t gpos
= glyph
->charpos
;
19754 if (!NILP (Fget_char_property (make_number (gpos
),
19766 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19768 /* If the row ends in middle of a real character,
19769 and the line is continued, we want the cursor here.
19770 That's because CHARPOS (ROW->end.pos) would equal
19771 PT if PT is before the character. */
19772 if (!row
->ends_in_ellipsis_p
)
19773 result
= row
->continued_p
;
19775 /* If the row ends in an ellipsis, then
19776 CHARPOS (ROW->end.pos) will equal point after the
19777 invisible text. We want that position to be displayed
19778 after the ellipsis. */
19781 /* If the row ends at ZV, display the cursor at the end of that
19782 row instead of at the start of the row below. */
19784 result
= row
->ends_at_zv_p
;
19790 /* Value is true if glyph row ROW should be
19791 used to hold the cursor. */
19794 cursor_row_p (struct glyph_row
*row
)
19796 return row_for_charpos_p (row
, PT
);
19801 /* Push the property PROP so that it will be rendered at the current
19802 position in IT. Return true if PROP was successfully pushed, false
19803 otherwise. Called from handle_line_prefix to handle the
19804 `line-prefix' and `wrap-prefix' properties. */
19807 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19809 struct text_pos pos
=
19810 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19812 eassert (it
->method
== GET_FROM_BUFFER
19813 || it
->method
== GET_FROM_DISPLAY_VECTOR
19814 || it
->method
== GET_FROM_STRING
);
19816 /* We need to save the current buffer/string position, so it will be
19817 restored by pop_it, because iterate_out_of_display_property
19818 depends on that being set correctly, but some situations leave
19819 it->position not yet set when this function is called. */
19820 push_it (it
, &pos
);
19822 if (STRINGP (prop
))
19824 if (SCHARS (prop
) == 0)
19831 it
->string_from_prefix_prop_p
= true;
19832 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19833 it
->current
.overlay_string_index
= -1;
19834 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19835 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19836 it
->method
= GET_FROM_STRING
;
19837 it
->stop_charpos
= 0;
19839 it
->base_level_stop
= 0;
19841 /* Force paragraph direction to be that of the parent
19843 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19844 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19846 it
->paragraph_embedding
= L2R
;
19848 /* Set up the bidi iterator for this display string. */
19851 it
->bidi_it
.string
.lstring
= it
->string
;
19852 it
->bidi_it
.string
.s
= NULL
;
19853 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19854 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19855 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19856 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19857 it
->bidi_it
.w
= it
->w
;
19858 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19861 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19863 it
->method
= GET_FROM_STRETCH
;
19866 #ifdef HAVE_WINDOW_SYSTEM
19867 else if (IMAGEP (prop
))
19869 it
->what
= IT_IMAGE
;
19870 it
->image_id
= lookup_image (it
->f
, prop
);
19871 it
->method
= GET_FROM_IMAGE
;
19873 #endif /* HAVE_WINDOW_SYSTEM */
19876 pop_it (it
); /* bogus display property, give up */
19883 /* Return the character-property PROP at the current position in IT. */
19886 get_it_property (struct it
*it
, Lisp_Object prop
)
19888 Lisp_Object position
, object
= it
->object
;
19890 if (STRINGP (object
))
19891 position
= make_number (IT_STRING_CHARPOS (*it
));
19892 else if (BUFFERP (object
))
19894 position
= make_number (IT_CHARPOS (*it
));
19895 object
= it
->window
;
19900 return Fget_char_property (position
, prop
, object
);
19903 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19906 handle_line_prefix (struct it
*it
)
19908 Lisp_Object prefix
;
19910 if (it
->continuation_lines_width
> 0)
19912 prefix
= get_it_property (it
, Qwrap_prefix
);
19914 prefix
= Vwrap_prefix
;
19918 prefix
= get_it_property (it
, Qline_prefix
);
19920 prefix
= Vline_prefix
;
19922 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19924 /* If the prefix is wider than the window, and we try to wrap
19925 it, it would acquire its own wrap prefix, and so on till the
19926 iterator stack overflows. So, don't wrap the prefix. */
19927 it
->line_wrap
= TRUNCATE
;
19928 it
->avoid_cursor_p
= true;
19934 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19935 only for R2L lines from display_line and display_string, when they
19936 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19937 the line/string needs to be continued on the next glyph row. */
19939 unproduce_glyphs (struct it
*it
, int n
)
19941 struct glyph
*glyph
, *end
;
19943 eassert (it
->glyph_row
);
19944 eassert (it
->glyph_row
->reversed_p
);
19945 eassert (it
->area
== TEXT_AREA
);
19946 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19948 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19949 n
= it
->glyph_row
->used
[TEXT_AREA
];
19950 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19951 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19952 for ( ; glyph
< end
; glyph
++)
19953 glyph
[-n
] = *glyph
;
19956 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19957 and ROW->maxpos. */
19959 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19960 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19961 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19963 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19964 lines' rows is implemented for bidi-reordered rows. */
19966 /* ROW->minpos is the value of min_pos, the minimal buffer position
19967 we have in ROW, or ROW->start.pos if that is smaller. */
19968 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19969 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19971 /* We didn't find buffer positions smaller than ROW->start, or
19972 didn't find _any_ valid buffer positions in any of the glyphs,
19973 so we must trust the iterator's computed positions. */
19974 row
->minpos
= row
->start
.pos
;
19977 max_pos
= CHARPOS (it
->current
.pos
);
19978 max_bpos
= BYTEPOS (it
->current
.pos
);
19981 /* Here are the various use-cases for ending the row, and the
19982 corresponding values for ROW->maxpos:
19984 Line ends in a newline from buffer eol_pos + 1
19985 Line is continued from buffer max_pos + 1
19986 Line is truncated on right it->current.pos
19987 Line ends in a newline from string max_pos + 1(*)
19988 (*) + 1 only when line ends in a forward scan
19989 Line is continued from string max_pos
19990 Line is continued from display vector max_pos
19991 Line is entirely from a string min_pos == max_pos
19992 Line is entirely from a display vector min_pos == max_pos
19993 Line that ends at ZV ZV
19995 If you discover other use-cases, please add them here as
19997 if (row
->ends_at_zv_p
)
19998 row
->maxpos
= it
->current
.pos
;
19999 else if (row
->used
[TEXT_AREA
])
20001 bool seen_this_string
= false;
20002 struct glyph_row
*r1
= row
- 1;
20004 /* Did we see the same display string on the previous row? */
20005 if (STRINGP (it
->object
)
20006 /* this is not the first row */
20007 && row
> it
->w
->desired_matrix
->rows
20008 /* previous row is not the header line */
20009 && !r1
->mode_line_p
20010 /* previous row also ends in a newline from a string */
20011 && r1
->ends_in_newline_from_string_p
)
20013 struct glyph
*start
, *end
;
20015 /* Search for the last glyph of the previous row that came
20016 from buffer or string. Depending on whether the row is
20017 L2R or R2L, we need to process it front to back or the
20018 other way round. */
20019 if (!r1
->reversed_p
)
20021 start
= r1
->glyphs
[TEXT_AREA
];
20022 end
= start
+ r1
->used
[TEXT_AREA
];
20023 /* Glyphs inserted by redisplay have nil as their object. */
20025 && NILP ((end
- 1)->object
)
20026 && (end
- 1)->charpos
<= 0)
20030 if (EQ ((end
- 1)->object
, it
->object
))
20031 seen_this_string
= true;
20034 /* If all the glyphs of the previous row were inserted
20035 by redisplay, it means the previous row was
20036 produced from a single newline, which is only
20037 possible if that newline came from the same string
20038 as the one which produced this ROW. */
20039 seen_this_string
= true;
20043 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20044 start
= end
+ r1
->used
[TEXT_AREA
];
20046 && NILP ((end
+ 1)->object
)
20047 && (end
+ 1)->charpos
<= 0)
20051 if (EQ ((end
+ 1)->object
, it
->object
))
20052 seen_this_string
= true;
20055 seen_this_string
= true;
20058 /* Take note of each display string that covers a newline only
20059 once, the first time we see it. This is for when a display
20060 string includes more than one newline in it. */
20061 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20063 /* If we were scanning the buffer forward when we displayed
20064 the string, we want to account for at least one buffer
20065 position that belongs to this row (position covered by
20066 the display string), so that cursor positioning will
20067 consider this row as a candidate when point is at the end
20068 of the visual line represented by this row. This is not
20069 required when scanning back, because max_pos will already
20070 have a much larger value. */
20071 if (CHARPOS (row
->end
.pos
) > max_pos
)
20072 INC_BOTH (max_pos
, max_bpos
);
20073 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20075 else if (CHARPOS (it
->eol_pos
) > 0)
20076 SET_TEXT_POS (row
->maxpos
,
20077 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20078 else if (row
->continued_p
)
20080 /* If max_pos is different from IT's current position, it
20081 means IT->method does not belong to the display element
20082 at max_pos. However, it also means that the display
20083 element at max_pos was displayed in its entirety on this
20084 line, which is equivalent to saying that the next line
20085 starts at the next buffer position. */
20086 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20087 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20090 INC_BOTH (max_pos
, max_bpos
);
20091 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20094 else if (row
->truncated_on_right_p
)
20095 /* display_line already called reseat_at_next_visible_line_start,
20096 which puts the iterator at the beginning of the next line, in
20097 the logical order. */
20098 row
->maxpos
= it
->current
.pos
;
20099 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20100 /* A line that is entirely from a string/image/stretch... */
20101 row
->maxpos
= row
->minpos
;
20106 row
->maxpos
= it
->current
.pos
;
20109 /* Construct the glyph row IT->glyph_row in the desired matrix of
20110 IT->w from text at the current position of IT. See dispextern.h
20111 for an overview of struct it. Value is true if
20112 IT->glyph_row displays text, as opposed to a line displaying ZV
20116 display_line (struct it
*it
)
20118 struct glyph_row
*row
= it
->glyph_row
;
20119 Lisp_Object overlay_arrow_string
;
20121 void *wrap_data
= NULL
;
20122 bool may_wrap
= false;
20123 int wrap_x
IF_LINT (= 0);
20124 int wrap_row_used
= -1;
20125 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20126 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20127 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20128 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20129 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20131 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20132 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20133 bool pending_handle_line_prefix
= false;
20135 /* We always start displaying at hpos zero even if hscrolled. */
20136 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20138 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20139 >= it
->w
->desired_matrix
->nrows
)
20141 it
->w
->nrows_scale_factor
++;
20142 it
->f
->fonts_changed
= true;
20146 /* Clear the result glyph row and enable it. */
20147 prepare_desired_row (it
->w
, row
, false);
20149 row
->y
= it
->current_y
;
20150 row
->start
= it
->start
;
20151 row
->continuation_lines_width
= it
->continuation_lines_width
;
20152 row
->displays_text_p
= true;
20153 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20154 it
->starts_in_middle_of_char_p
= false;
20156 /* Arrange the overlays nicely for our purposes. Usually, we call
20157 display_line on only one line at a time, in which case this
20158 can't really hurt too much, or we call it on lines which appear
20159 one after another in the buffer, in which case all calls to
20160 recenter_overlay_lists but the first will be pretty cheap. */
20161 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20163 /* Move over display elements that are not visible because we are
20164 hscrolled. This may stop at an x-position < IT->first_visible_x
20165 if the first glyph is partially visible or if we hit a line end. */
20166 if (it
->current_x
< it
->first_visible_x
)
20168 enum move_it_result move_result
;
20170 this_line_min_pos
= row
->start
.pos
;
20171 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20172 MOVE_TO_POS
| MOVE_TO_X
);
20173 /* If we are under a large hscroll, move_it_in_display_line_to
20174 could hit the end of the line without reaching
20175 it->first_visible_x. Pretend that we did reach it. This is
20176 especially important on a TTY, where we will call
20177 extend_face_to_end_of_line, which needs to know how many
20178 blank glyphs to produce. */
20179 if (it
->current_x
< it
->first_visible_x
20180 && (move_result
== MOVE_NEWLINE_OR_CR
20181 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20182 it
->current_x
= it
->first_visible_x
;
20184 /* Record the smallest positions seen while we moved over
20185 display elements that are not visible. This is needed by
20186 redisplay_internal for optimizing the case where the cursor
20187 stays inside the same line. The rest of this function only
20188 considers positions that are actually displayed, so
20189 RECORD_MAX_MIN_POS will not otherwise record positions that
20190 are hscrolled to the left of the left edge of the window. */
20191 min_pos
= CHARPOS (this_line_min_pos
);
20192 min_bpos
= BYTEPOS (this_line_min_pos
);
20194 else if (it
->area
== TEXT_AREA
)
20196 /* We only do this when not calling move_it_in_display_line_to
20197 above, because that function calls itself handle_line_prefix. */
20198 handle_line_prefix (it
);
20202 /* Line-prefix and wrap-prefix are always displayed in the text
20203 area. But if this is the first call to display_line after
20204 init_iterator, the iterator might have been set up to write
20205 into a marginal area, e.g. if the line begins with some
20206 display property that writes to the margins. So we need to
20207 wait with the call to handle_line_prefix until whatever
20208 writes to the margin has done its job. */
20209 pending_handle_line_prefix
= true;
20212 /* Get the initial row height. This is either the height of the
20213 text hscrolled, if there is any, or zero. */
20214 row
->ascent
= it
->max_ascent
;
20215 row
->height
= it
->max_ascent
+ it
->max_descent
;
20216 row
->phys_ascent
= it
->max_phys_ascent
;
20217 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20218 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20220 /* Utility macro to record max and min buffer positions seen until now. */
20221 #define RECORD_MAX_MIN_POS(IT) \
20224 bool composition_p \
20225 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20226 ptrdiff_t current_pos = \
20227 composition_p ? (IT)->cmp_it.charpos \
20228 : IT_CHARPOS (*(IT)); \
20229 ptrdiff_t current_bpos = \
20230 composition_p ? CHAR_TO_BYTE (current_pos) \
20231 : IT_BYTEPOS (*(IT)); \
20232 if (current_pos < min_pos) \
20234 min_pos = current_pos; \
20235 min_bpos = current_bpos; \
20237 if (IT_CHARPOS (*it) > max_pos) \
20239 max_pos = IT_CHARPOS (*it); \
20240 max_bpos = IT_BYTEPOS (*it); \
20245 /* Loop generating characters. The loop is left with IT on the next
20246 character to display. */
20249 int n_glyphs_before
, hpos_before
, x_before
;
20251 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20253 /* Retrieve the next thing to display. Value is false if end of
20255 if (!get_next_display_element (it
))
20257 /* Maybe add a space at the end of this line that is used to
20258 display the cursor there under X. Set the charpos of the
20259 first glyph of blank lines not corresponding to any text
20261 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20262 row
->exact_window_width_line_p
= true;
20263 else if ((append_space_for_newline (it
, true)
20264 && row
->used
[TEXT_AREA
] == 1)
20265 || row
->used
[TEXT_AREA
] == 0)
20267 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20268 row
->displays_text_p
= false;
20270 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20271 && (!MINI_WINDOW_P (it
->w
)
20272 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20273 row
->indicate_empty_line_p
= true;
20276 it
->continuation_lines_width
= 0;
20277 row
->ends_at_zv_p
= true;
20278 /* A row that displays right-to-left text must always have
20279 its last face extended all the way to the end of line,
20280 even if this row ends in ZV, because we still write to
20281 the screen left to right. We also need to extend the
20282 last face if the default face is remapped to some
20283 different face, otherwise the functions that clear
20284 portions of the screen will clear with the default face's
20285 background color. */
20286 if (row
->reversed_p
20287 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20288 extend_face_to_end_of_line (it
);
20292 /* Now, get the metrics of what we want to display. This also
20293 generates glyphs in `row' (which is IT->glyph_row). */
20294 n_glyphs_before
= row
->used
[TEXT_AREA
];
20297 /* Remember the line height so far in case the next element doesn't
20298 fit on the line. */
20299 if (it
->line_wrap
!= TRUNCATE
)
20301 ascent
= it
->max_ascent
;
20302 descent
= it
->max_descent
;
20303 phys_ascent
= it
->max_phys_ascent
;
20304 phys_descent
= it
->max_phys_descent
;
20306 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20308 if (IT_DISPLAYING_WHITESPACE (it
))
20312 SAVE_IT (wrap_it
, *it
, wrap_data
);
20314 wrap_row_used
= row
->used
[TEXT_AREA
];
20315 wrap_row_ascent
= row
->ascent
;
20316 wrap_row_height
= row
->height
;
20317 wrap_row_phys_ascent
= row
->phys_ascent
;
20318 wrap_row_phys_height
= row
->phys_height
;
20319 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20320 wrap_row_min_pos
= min_pos
;
20321 wrap_row_min_bpos
= min_bpos
;
20322 wrap_row_max_pos
= max_pos
;
20323 wrap_row_max_bpos
= max_bpos
;
20329 PRODUCE_GLYPHS (it
);
20331 /* If this display element was in marginal areas, continue with
20333 if (it
->area
!= TEXT_AREA
)
20335 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20336 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20337 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20338 row
->phys_height
= max (row
->phys_height
,
20339 it
->max_phys_ascent
+ it
->max_phys_descent
);
20340 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20341 it
->max_extra_line_spacing
);
20342 set_iterator_to_next (it
, true);
20343 /* If we didn't handle the line/wrap prefix above, and the
20344 call to set_iterator_to_next just switched to TEXT_AREA,
20345 process the prefix now. */
20346 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20348 pending_handle_line_prefix
= false;
20349 handle_line_prefix (it
);
20354 /* Does the display element fit on the line? If we truncate
20355 lines, we should draw past the right edge of the window. If
20356 we don't truncate, we want to stop so that we can display the
20357 continuation glyph before the right margin. If lines are
20358 continued, there are two possible strategies for characters
20359 resulting in more than 1 glyph (e.g. tabs): Display as many
20360 glyphs as possible in this line and leave the rest for the
20361 continuation line, or display the whole element in the next
20362 line. Original redisplay did the former, so we do it also. */
20363 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20364 hpos_before
= it
->hpos
;
20367 if (/* Not a newline. */
20369 /* Glyphs produced fit entirely in the line. */
20370 && it
->current_x
< it
->last_visible_x
)
20372 it
->hpos
+= nglyphs
;
20373 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20374 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20375 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20376 row
->phys_height
= max (row
->phys_height
,
20377 it
->max_phys_ascent
+ it
->max_phys_descent
);
20378 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20379 it
->max_extra_line_spacing
);
20380 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20381 /* In R2L rows, we arrange in extend_face_to_end_of_line
20382 to add a right offset to the line, by a suitable
20383 change to the stretch glyph that is the leftmost
20384 glyph of the line. */
20385 && !row
->reversed_p
)
20386 row
->x
= x
- it
->first_visible_x
;
20387 /* Record the maximum and minimum buffer positions seen so
20388 far in glyphs that will be displayed by this row. */
20390 RECORD_MAX_MIN_POS (it
);
20395 struct glyph
*glyph
;
20397 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20399 /* Identify the glyphs added by the last call to
20400 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20401 the previous glyphs. */
20402 if (!row
->reversed_p
)
20403 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20405 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20406 new_x
= x
+ glyph
->pixel_width
;
20408 if (/* Lines are continued. */
20409 it
->line_wrap
!= TRUNCATE
20410 && (/* Glyph doesn't fit on the line. */
20411 new_x
> it
->last_visible_x
20412 /* Or it fits exactly on a window system frame. */
20413 || (new_x
== it
->last_visible_x
20414 && FRAME_WINDOW_P (it
->f
)
20415 && (row
->reversed_p
20416 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20417 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20419 /* End of a continued line. */
20422 || (new_x
== it
->last_visible_x
20423 && FRAME_WINDOW_P (it
->f
)
20424 && (row
->reversed_p
20425 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20426 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20428 /* Current glyph is the only one on the line or
20429 fits exactly on the line. We must continue
20430 the line because we can't draw the cursor
20431 after the glyph. */
20432 row
->continued_p
= true;
20433 it
->current_x
= new_x
;
20434 it
->continuation_lines_width
+= new_x
;
20436 if (i
== nglyphs
- 1)
20438 /* If line-wrap is on, check if a previous
20439 wrap point was found. */
20440 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20441 && wrap_row_used
> 0
20442 /* Even if there is a previous wrap
20443 point, continue the line here as
20444 usual, if (i) the previous character
20445 was a space or tab AND (ii) the
20446 current character is not. */
20448 || IT_DISPLAYING_WHITESPACE (it
)))
20451 /* Record the maximum and minimum buffer
20452 positions seen so far in glyphs that will be
20453 displayed by this row. */
20455 RECORD_MAX_MIN_POS (it
);
20456 set_iterator_to_next (it
, true);
20457 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20459 if (!get_next_display_element (it
))
20461 row
->exact_window_width_line_p
= true;
20462 it
->continuation_lines_width
= 0;
20463 row
->continued_p
= false;
20464 row
->ends_at_zv_p
= true;
20466 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20468 row
->continued_p
= false;
20469 row
->exact_window_width_line_p
= true;
20471 /* If line-wrap is on, check if a
20472 previous wrap point was found. */
20473 else if (wrap_row_used
> 0
20474 /* Even if there is a previous wrap
20475 point, continue the line here as
20476 usual, if (i) the previous character
20477 was a space or tab AND (ii) the
20478 current character is not. */
20480 || IT_DISPLAYING_WHITESPACE (it
)))
20485 else if (it
->bidi_p
)
20486 RECORD_MAX_MIN_POS (it
);
20487 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20488 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20489 extend_face_to_end_of_line (it
);
20491 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20492 && !FRAME_WINDOW_P (it
->f
))
20494 /* A padding glyph that doesn't fit on this line.
20495 This means the whole character doesn't fit
20497 if (row
->reversed_p
)
20498 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20499 - n_glyphs_before
);
20500 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20502 /* Fill the rest of the row with continuation
20503 glyphs like in 20.x. */
20504 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20505 < row
->glyphs
[1 + TEXT_AREA
])
20506 produce_special_glyphs (it
, IT_CONTINUATION
);
20508 row
->continued_p
= true;
20509 it
->current_x
= x_before
;
20510 it
->continuation_lines_width
+= x_before
;
20512 /* Restore the height to what it was before the
20513 element not fitting on the line. */
20514 it
->max_ascent
= ascent
;
20515 it
->max_descent
= descent
;
20516 it
->max_phys_ascent
= phys_ascent
;
20517 it
->max_phys_descent
= phys_descent
;
20518 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20519 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20520 extend_face_to_end_of_line (it
);
20522 else if (wrap_row_used
> 0)
20525 if (row
->reversed_p
)
20526 unproduce_glyphs (it
,
20527 row
->used
[TEXT_AREA
] - wrap_row_used
);
20528 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20529 it
->continuation_lines_width
+= wrap_x
;
20530 row
->used
[TEXT_AREA
] = wrap_row_used
;
20531 row
->ascent
= wrap_row_ascent
;
20532 row
->height
= wrap_row_height
;
20533 row
->phys_ascent
= wrap_row_phys_ascent
;
20534 row
->phys_height
= wrap_row_phys_height
;
20535 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20536 min_pos
= wrap_row_min_pos
;
20537 min_bpos
= wrap_row_min_bpos
;
20538 max_pos
= wrap_row_max_pos
;
20539 max_bpos
= wrap_row_max_bpos
;
20540 row
->continued_p
= true;
20541 row
->ends_at_zv_p
= false;
20542 row
->exact_window_width_line_p
= false;
20543 it
->continuation_lines_width
+= x
;
20545 /* Make sure that a non-default face is extended
20546 up to the right margin of the window. */
20547 extend_face_to_end_of_line (it
);
20549 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20551 /* A TAB that extends past the right edge of the
20552 window. This produces a single glyph on
20553 window system frames. We leave the glyph in
20554 this row and let it fill the row, but don't
20555 consume the TAB. */
20556 if ((row
->reversed_p
20557 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20558 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20559 produce_special_glyphs (it
, IT_CONTINUATION
);
20560 it
->continuation_lines_width
+= it
->last_visible_x
;
20561 row
->ends_in_middle_of_char_p
= true;
20562 row
->continued_p
= true;
20563 glyph
->pixel_width
= it
->last_visible_x
- x
;
20564 it
->starts_in_middle_of_char_p
= true;
20565 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20566 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20567 extend_face_to_end_of_line (it
);
20571 /* Something other than a TAB that draws past
20572 the right edge of the window. Restore
20573 positions to values before the element. */
20574 if (row
->reversed_p
)
20575 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20576 - (n_glyphs_before
+ i
));
20577 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20579 /* Display continuation glyphs. */
20580 it
->current_x
= x_before
;
20581 it
->continuation_lines_width
+= x
;
20582 if (!FRAME_WINDOW_P (it
->f
)
20583 || (row
->reversed_p
20584 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20585 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20586 produce_special_glyphs (it
, IT_CONTINUATION
);
20587 row
->continued_p
= true;
20589 extend_face_to_end_of_line (it
);
20591 if (nglyphs
> 1 && i
> 0)
20593 row
->ends_in_middle_of_char_p
= true;
20594 it
->starts_in_middle_of_char_p
= true;
20597 /* Restore the height to what it was before the
20598 element not fitting on the line. */
20599 it
->max_ascent
= ascent
;
20600 it
->max_descent
= descent
;
20601 it
->max_phys_ascent
= phys_ascent
;
20602 it
->max_phys_descent
= phys_descent
;
20607 else if (new_x
> it
->first_visible_x
)
20609 /* Increment number of glyphs actually displayed. */
20612 /* Record the maximum and minimum buffer positions
20613 seen so far in glyphs that will be displayed by
20616 RECORD_MAX_MIN_POS (it
);
20618 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20619 /* Glyph is partially visible, i.e. row starts at
20620 negative X position. Don't do that in R2L
20621 rows, where we arrange to add a right offset to
20622 the line in extend_face_to_end_of_line, by a
20623 suitable change to the stretch glyph that is
20624 the leftmost glyph of the line. */
20625 row
->x
= x
- it
->first_visible_x
;
20626 /* When the last glyph of an R2L row only fits
20627 partially on the line, we need to set row->x to a
20628 negative offset, so that the leftmost glyph is
20629 the one that is partially visible. But if we are
20630 going to produce the truncation glyph, this will
20631 be taken care of in produce_special_glyphs. */
20632 if (row
->reversed_p
20633 && new_x
> it
->last_visible_x
20634 && !(it
->line_wrap
== TRUNCATE
20635 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20637 eassert (FRAME_WINDOW_P (it
->f
));
20638 row
->x
= it
->last_visible_x
- new_x
;
20643 /* Glyph is completely off the left margin of the
20644 window. This should not happen because of the
20645 move_it_in_display_line at the start of this
20646 function, unless the text display area of the
20647 window is empty. */
20648 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20651 /* Even if this display element produced no glyphs at all,
20652 we want to record its position. */
20653 if (it
->bidi_p
&& nglyphs
== 0)
20654 RECORD_MAX_MIN_POS (it
);
20656 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20657 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20658 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20659 row
->phys_height
= max (row
->phys_height
,
20660 it
->max_phys_ascent
+ it
->max_phys_descent
);
20661 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20662 it
->max_extra_line_spacing
);
20664 /* End of this display line if row is continued. */
20665 if (row
->continued_p
|| row
->ends_at_zv_p
)
20670 /* Is this a line end? If yes, we're also done, after making
20671 sure that a non-default face is extended up to the right
20672 margin of the window. */
20673 if (ITERATOR_AT_END_OF_LINE_P (it
))
20675 int used_before
= row
->used
[TEXT_AREA
];
20677 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20679 /* Add a space at the end of the line that is used to
20680 display the cursor there. */
20681 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20682 append_space_for_newline (it
, false);
20684 /* Extend the face to the end of the line. */
20685 extend_face_to_end_of_line (it
);
20687 /* Make sure we have the position. */
20688 if (used_before
== 0)
20689 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20691 /* Record the position of the newline, for use in
20693 it
->eol_pos
= it
->current
.pos
;
20695 /* Consume the line end. This skips over invisible lines. */
20696 set_iterator_to_next (it
, true);
20697 it
->continuation_lines_width
= 0;
20701 /* Proceed with next display element. Note that this skips
20702 over lines invisible because of selective display. */
20703 set_iterator_to_next (it
, true);
20705 /* If we truncate lines, we are done when the last displayed
20706 glyphs reach past the right margin of the window. */
20707 if (it
->line_wrap
== TRUNCATE
20708 && ((FRAME_WINDOW_P (it
->f
)
20709 /* Images are preprocessed in produce_image_glyph such
20710 that they are cropped at the right edge of the
20711 window, so an image glyph will always end exactly at
20712 last_visible_x, even if there's no right fringe. */
20713 && ((row
->reversed_p
20714 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20715 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20716 || it
->what
== IT_IMAGE
))
20717 ? (it
->current_x
>= it
->last_visible_x
)
20718 : (it
->current_x
> it
->last_visible_x
)))
20720 /* Maybe add truncation glyphs. */
20721 if (!FRAME_WINDOW_P (it
->f
)
20722 || (row
->reversed_p
20723 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20724 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20728 if (!row
->reversed_p
)
20730 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20731 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20736 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20737 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20739 /* Remove any padding glyphs at the front of ROW, to
20740 make room for the truncation glyphs we will be
20741 adding below. The loop below always inserts at
20742 least one truncation glyph, so also remove the
20743 last glyph added to ROW. */
20744 unproduce_glyphs (it
, i
+ 1);
20745 /* Adjust i for the loop below. */
20746 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20749 /* produce_special_glyphs overwrites the last glyph, so
20750 we don't want that if we want to keep that last
20751 glyph, which means it's an image. */
20752 if (it
->current_x
> it
->last_visible_x
)
20754 it
->current_x
= x_before
;
20755 if (!FRAME_WINDOW_P (it
->f
))
20757 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20759 row
->used
[TEXT_AREA
] = i
;
20760 produce_special_glyphs (it
, IT_TRUNCATION
);
20765 row
->used
[TEXT_AREA
] = i
;
20766 produce_special_glyphs (it
, IT_TRUNCATION
);
20768 it
->hpos
= hpos_before
;
20771 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20773 /* Don't truncate if we can overflow newline into fringe. */
20774 if (!get_next_display_element (it
))
20776 it
->continuation_lines_width
= 0;
20777 row
->ends_at_zv_p
= true;
20778 row
->exact_window_width_line_p
= true;
20781 if (ITERATOR_AT_END_OF_LINE_P (it
))
20783 row
->exact_window_width_line_p
= true;
20784 goto at_end_of_line
;
20786 it
->current_x
= x_before
;
20787 it
->hpos
= hpos_before
;
20790 row
->truncated_on_right_p
= true;
20791 it
->continuation_lines_width
= 0;
20792 reseat_at_next_visible_line_start (it
, false);
20793 /* We insist below that IT's position be at ZV because in
20794 bidi-reordered lines the character at visible line start
20795 might not be the character that follows the newline in
20796 the logical order. */
20797 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20798 row
->ends_at_zv_p
=
20799 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20801 row
->ends_at_zv_p
= false;
20807 bidi_unshelve_cache (wrap_data
, true);
20809 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20810 at the left window margin. */
20811 if (it
->first_visible_x
20812 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20814 if (!FRAME_WINDOW_P (it
->f
)
20815 || (((row
->reversed_p
20816 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20817 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20818 /* Don't let insert_left_trunc_glyphs overwrite the
20819 first glyph of the row if it is an image. */
20820 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20821 insert_left_trunc_glyphs (it
);
20822 row
->truncated_on_left_p
= true;
20825 /* Remember the position at which this line ends.
20827 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20828 cannot be before the call to find_row_edges below, since that is
20829 where these positions are determined. */
20830 row
->end
= it
->current
;
20833 row
->minpos
= row
->start
.pos
;
20834 row
->maxpos
= row
->end
.pos
;
20838 /* ROW->minpos and ROW->maxpos must be the smallest and
20839 `1 + the largest' buffer positions in ROW. But if ROW was
20840 bidi-reordered, these two positions can be anywhere in the
20841 row, so we must determine them now. */
20842 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20845 /* If the start of this line is the overlay arrow-position, then
20846 mark this glyph row as the one containing the overlay arrow.
20847 This is clearly a mess with variable size fonts. It would be
20848 better to let it be displayed like cursors under X. */
20849 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20850 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20851 !NILP (overlay_arrow_string
)))
20853 /* Overlay arrow in window redisplay is a fringe bitmap. */
20854 if (STRINGP (overlay_arrow_string
))
20856 struct glyph_row
*arrow_row
20857 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20858 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20859 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20860 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20861 struct glyph
*p2
, *end
;
20863 /* Copy the arrow glyphs. */
20864 while (glyph
< arrow_end
)
20867 /* Throw away padding glyphs. */
20869 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20870 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20876 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20881 eassert (INTEGERP (overlay_arrow_string
));
20882 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20884 overlay_arrow_seen
= true;
20887 /* Highlight trailing whitespace. */
20888 if (!NILP (Vshow_trailing_whitespace
))
20889 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20891 /* Compute pixel dimensions of this line. */
20892 compute_line_metrics (it
);
20894 /* Implementation note: No changes in the glyphs of ROW or in their
20895 faces can be done past this point, because compute_line_metrics
20896 computes ROW's hash value and stores it within the glyph_row
20899 /* Record whether this row ends inside an ellipsis. */
20900 row
->ends_in_ellipsis_p
20901 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20902 && it
->ellipsis_p
);
20904 /* Save fringe bitmaps in this row. */
20905 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20906 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20907 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20908 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20910 it
->left_user_fringe_bitmap
= 0;
20911 it
->left_user_fringe_face_id
= 0;
20912 it
->right_user_fringe_bitmap
= 0;
20913 it
->right_user_fringe_face_id
= 0;
20915 /* Maybe set the cursor. */
20916 cvpos
= it
->w
->cursor
.vpos
;
20918 /* In bidi-reordered rows, keep checking for proper cursor
20919 position even if one has been found already, because buffer
20920 positions in such rows change non-linearly with ROW->VPOS,
20921 when a line is continued. One exception: when we are at ZV,
20922 display cursor on the first suitable glyph row, since all
20923 the empty rows after that also have their position set to ZV. */
20924 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20925 lines' rows is implemented for bidi-reordered rows. */
20927 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20928 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20929 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20930 && cursor_row_p (row
))
20931 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20933 /* Prepare for the next line. This line starts horizontally at (X
20934 HPOS) = (0 0). Vertical positions are incremented. As a
20935 convenience for the caller, IT->glyph_row is set to the next
20937 it
->current_x
= it
->hpos
= 0;
20938 it
->current_y
+= row
->height
;
20939 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20942 /* The next row should by default use the same value of the
20943 reversed_p flag as this one. set_iterator_to_next decides when
20944 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20945 the flag accordingly. */
20946 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20947 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20948 it
->start
= row
->end
;
20949 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20951 #undef RECORD_MAX_MIN_POS
20954 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20955 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20956 doc
: /* Return paragraph direction at point in BUFFER.
20957 Value is either `left-to-right' or `right-to-left'.
20958 If BUFFER is omitted or nil, it defaults to the current buffer.
20960 Paragraph direction determines how the text in the paragraph is displayed.
20961 In left-to-right paragraphs, text begins at the left margin of the window
20962 and the reading direction is generally left to right. In right-to-left
20963 paragraphs, text begins at the right margin and is read from right to left.
20965 See also `bidi-paragraph-direction'. */)
20966 (Lisp_Object buffer
)
20968 struct buffer
*buf
= current_buffer
;
20969 struct buffer
*old
= buf
;
20971 if (! NILP (buffer
))
20973 CHECK_BUFFER (buffer
);
20974 buf
= XBUFFER (buffer
);
20977 if (NILP (BVAR (buf
, bidi_display_reordering
))
20978 || NILP (BVAR (buf
, enable_multibyte_characters
))
20979 /* When we are loading loadup.el, the character property tables
20980 needed for bidi iteration are not yet available. */
20981 || !NILP (Vpurify_flag
))
20982 return Qleft_to_right
;
20983 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20984 return BVAR (buf
, bidi_paragraph_direction
);
20987 /* Determine the direction from buffer text. We could try to
20988 use current_matrix if it is up to date, but this seems fast
20989 enough as it is. */
20990 struct bidi_it itb
;
20991 ptrdiff_t pos
= BUF_PT (buf
);
20992 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20994 void *itb_data
= bidi_shelve_cache ();
20996 set_buffer_temp (buf
);
20997 /* bidi_paragraph_init finds the base direction of the paragraph
20998 by searching forward from paragraph start. We need the base
20999 direction of the current or _previous_ paragraph, so we need
21000 to make sure we are within that paragraph. To that end, find
21001 the previous non-empty line. */
21002 if (pos
>= ZV
&& pos
> BEGV
)
21003 DEC_BOTH (pos
, bytepos
);
21004 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21005 if (fast_looking_at (trailing_white_space
,
21006 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21008 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21009 || c
== ' ' || c
== '\t' || c
== '\f')
21011 if (bytepos
<= BEGV_BYTE
)
21016 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21019 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21020 itb
.paragraph_dir
= NEUTRAL_DIR
;
21021 itb
.string
.s
= NULL
;
21022 itb
.string
.lstring
= Qnil
;
21023 itb
.string
.bufpos
= 0;
21024 itb
.string
.from_disp_str
= false;
21025 itb
.string
.unibyte
= false;
21026 /* We have no window to use here for ignoring window-specific
21027 overlays. Using NULL for window pointer will cause
21028 compute_display_string_pos to use the current buffer. */
21030 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21031 bidi_unshelve_cache (itb_data
, false);
21032 set_buffer_temp (old
);
21033 switch (itb
.paragraph_dir
)
21036 return Qleft_to_right
;
21039 return Qright_to_left
;
21047 DEFUN ("bidi-find-overridden-directionality",
21048 Fbidi_find_overridden_directionality
,
21049 Sbidi_find_overridden_directionality
, 2, 3, 0,
21050 doc
: /* Return position between FROM and TO where directionality was overridden.
21052 This function returns the first character position in the specified
21053 region of OBJECT where there is a character whose `bidi-class' property
21054 is `L', but which was forced to display as `R' by a directional
21055 override, and likewise with characters whose `bidi-class' is `R'
21056 or `AL' that were forced to display as `L'.
21058 If no such character is found, the function returns nil.
21060 OBJECT is a Lisp string or buffer to search for overridden
21061 directionality, and defaults to the current buffer if nil or omitted.
21062 OBJECT can also be a window, in which case the function will search
21063 the buffer displayed in that window. Passing the window instead of
21064 a buffer is preferable when the buffer is displayed in some window,
21065 because this function will then be able to correctly account for
21066 window-specific overlays, which can affect the results.
21068 Strong directional characters `L', `R', and `AL' can have their
21069 intrinsic directionality overridden by directional override
21070 control characters RLO (u+202e) and LRO (u+202d). See the
21071 function `get-char-code-property' for a way to inquire about
21072 the `bidi-class' property of a character. */)
21073 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21075 struct buffer
*buf
= current_buffer
;
21076 struct buffer
*old
= buf
;
21077 struct window
*w
= NULL
;
21078 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21079 struct bidi_it itb
;
21080 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21083 if (!NILP (object
))
21085 if (BUFFERP (object
))
21086 buf
= XBUFFER (object
);
21087 else if (WINDOWP (object
))
21089 w
= decode_live_window (object
);
21090 buf
= XBUFFER (w
->contents
);
21091 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21094 CHECK_STRING (object
);
21097 if (STRINGP (object
))
21099 /* Characters in unibyte strings are always treated by bidi.c as
21101 if (!STRING_MULTIBYTE (object
)
21102 /* When we are loading loadup.el, the character property
21103 tables needed for bidi iteration are not yet
21105 || !NILP (Vpurify_flag
))
21108 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21109 if (from_pos
>= SCHARS (object
))
21112 /* Set up the bidi iterator. */
21113 itb_data
= bidi_shelve_cache ();
21114 itb
.paragraph_dir
= NEUTRAL_DIR
;
21115 itb
.string
.lstring
= object
;
21116 itb
.string
.s
= NULL
;
21117 itb
.string
.schars
= SCHARS (object
);
21118 itb
.string
.bufpos
= 0;
21119 itb
.string
.from_disp_str
= false;
21120 itb
.string
.unibyte
= false;
21122 bidi_init_it (0, 0, frame_window_p
, &itb
);
21126 /* Nothing this fancy can happen in unibyte buffers, or in a
21127 buffer that disabled reordering, or if FROM is at EOB. */
21128 if (NILP (BVAR (buf
, bidi_display_reordering
))
21129 || NILP (BVAR (buf
, enable_multibyte_characters
))
21130 /* When we are loading loadup.el, the character property
21131 tables needed for bidi iteration are not yet
21133 || !NILP (Vpurify_flag
))
21136 set_buffer_temp (buf
);
21137 validate_region (&from
, &to
);
21138 from_pos
= XINT (from
);
21139 to_pos
= XINT (to
);
21140 if (from_pos
>= ZV
)
21143 /* Set up the bidi iterator. */
21144 itb_data
= bidi_shelve_cache ();
21145 from_bpos
= CHAR_TO_BYTE (from_pos
);
21146 if (from_pos
== BEGV
)
21148 itb
.charpos
= BEGV
;
21149 itb
.bytepos
= BEGV_BYTE
;
21151 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21153 itb
.charpos
= from_pos
;
21154 itb
.bytepos
= from_bpos
;
21157 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21159 itb
.paragraph_dir
= NEUTRAL_DIR
;
21160 itb
.string
.s
= NULL
;
21161 itb
.string
.lstring
= Qnil
;
21162 itb
.string
.bufpos
= 0;
21163 itb
.string
.from_disp_str
= false;
21164 itb
.string
.unibyte
= false;
21166 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21171 /* For the purposes of this function, the actual base direction of
21172 the paragraph doesn't matter, so just set it to L2R. */
21173 bidi_paragraph_init (L2R
, &itb
, false);
21174 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21176 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21178 bidi_unshelve_cache (itb_data
, false);
21179 set_buffer_temp (old
);
21181 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21184 DEFUN ("move-point-visually", Fmove_point_visually
,
21185 Smove_point_visually
, 1, 1, 0,
21186 doc
: /* Move point in the visual order in the specified DIRECTION.
21187 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21190 Value is the new character position of point. */)
21191 (Lisp_Object direction
)
21193 struct window
*w
= XWINDOW (selected_window
);
21194 struct buffer
*b
= XBUFFER (w
->contents
);
21195 struct glyph_row
*row
;
21197 Lisp_Object paragraph_dir
;
21199 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21200 (!(ROW)->continued_p \
21201 && NILP ((GLYPH)->object) \
21202 && (GLYPH)->type == CHAR_GLYPH \
21203 && (GLYPH)->u.ch == ' ' \
21204 && (GLYPH)->charpos >= 0 \
21205 && !(GLYPH)->avoid_cursor_p)
21207 CHECK_NUMBER (direction
);
21208 dir
= XINT (direction
);
21214 /* If current matrix is up-to-date, we can use the information
21215 recorded in the glyphs, at least as long as the goal is on the
21217 if (w
->window_end_valid
21218 && !windows_or_buffers_changed
21220 && !b
->clip_changed
21221 && !b
->prevent_redisplay_optimizations_p
21222 && !window_outdated (w
)
21223 /* We rely below on the cursor coordinates to be up to date, but
21224 we cannot trust them if some command moved point since the
21225 last complete redisplay. */
21226 && w
->last_point
== BUF_PT (b
)
21227 && w
->cursor
.vpos
>= 0
21228 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21229 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21231 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21232 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21233 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21235 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21237 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21239 SET_PT (g
->charpos
);
21240 w
->cursor
.vpos
= -1;
21241 return make_number (PT
);
21243 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21247 if (BUFFERP (gpt
->object
))
21250 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21251 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21253 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21255 else if (BUFFERP (g
->object
))
21256 new_pos
= g
->charpos
;
21260 w
->cursor
.vpos
= -1;
21261 return make_number (PT
);
21263 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21265 /* Glyphs inserted at the end of a non-empty line for
21266 positioning the cursor have zero charpos, so we must
21267 deduce the value of point by other means. */
21268 if (g
->charpos
> 0)
21269 SET_PT (g
->charpos
);
21270 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21272 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21273 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21276 w
->cursor
.vpos
= -1;
21277 return make_number (PT
);
21280 if (g
== e
|| NILP (g
->object
))
21282 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21283 goto simulate_display
;
21284 if (!row
->reversed_p
)
21288 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21289 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21290 goto simulate_display
;
21294 if (row
->reversed_p
&& !row
->continued_p
)
21296 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21297 w
->cursor
.vpos
= -1;
21298 return make_number (PT
);
21300 g
= row
->glyphs
[TEXT_AREA
];
21301 e
= g
+ row
->used
[TEXT_AREA
];
21302 for ( ; g
< e
; g
++)
21304 if (BUFFERP (g
->object
)
21305 /* Empty lines have only one glyph, which stands
21306 for the newline, and whose charpos is the
21307 buffer position of the newline. */
21308 || ROW_GLYPH_NEWLINE_P (row
, g
)
21309 /* When the buffer ends in a newline, the line at
21310 EOB also has one glyph, but its charpos is -1. */
21311 || (row
->ends_at_zv_p
21312 && !row
->reversed_p
21313 && NILP (g
->object
)
21314 && g
->type
== CHAR_GLYPH
21315 && g
->u
.ch
== ' '))
21317 if (g
->charpos
> 0)
21318 SET_PT (g
->charpos
);
21319 else if (!row
->reversed_p
21320 && row
->ends_at_zv_p
21325 w
->cursor
.vpos
= -1;
21326 return make_number (PT
);
21332 if (!row
->reversed_p
&& !row
->continued_p
)
21334 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21335 w
->cursor
.vpos
= -1;
21336 return make_number (PT
);
21338 e
= row
->glyphs
[TEXT_AREA
];
21339 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21340 for ( ; g
>= e
; g
--)
21342 if (BUFFERP (g
->object
)
21343 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21345 /* Empty R2L lines on GUI frames have the buffer
21346 position of the newline stored in the stretch
21348 || g
->type
== STRETCH_GLYPH
21349 || (row
->ends_at_zv_p
21351 && NILP (g
->object
)
21352 && g
->type
== CHAR_GLYPH
21353 && g
->u
.ch
== ' '))
21355 if (g
->charpos
> 0)
21356 SET_PT (g
->charpos
);
21357 else if (row
->reversed_p
21358 && row
->ends_at_zv_p
21363 w
->cursor
.vpos
= -1;
21364 return make_number (PT
);
21373 /* If we wind up here, we failed to move by using the glyphs, so we
21374 need to simulate display instead. */
21377 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21379 paragraph_dir
= Qleft_to_right
;
21380 if (EQ (paragraph_dir
, Qright_to_left
))
21382 if (PT
<= BEGV
&& dir
< 0)
21383 xsignal0 (Qbeginning_of_buffer
);
21384 else if (PT
>= ZV
&& dir
> 0)
21385 xsignal0 (Qend_of_buffer
);
21388 struct text_pos pt
;
21390 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21392 bool overshoot_expected
= false;
21393 bool target_is_eol_p
= false;
21395 /* Setup the arena. */
21396 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21397 start_display (&it
, w
, pt
);
21398 /* When lines are truncated, we could be called with point
21399 outside of the windows edges, in which case move_it_*
21400 functions either prematurely stop at window's edge or jump to
21401 the next screen line, whereas we rely below on our ability to
21402 reach point, in order to start from its X coordinate. So we
21403 need to disregard the window's horizontal extent in that case. */
21404 if (it
.line_wrap
== TRUNCATE
)
21405 it
.last_visible_x
= INFINITY
;
21407 if (it
.cmp_it
.id
< 0
21408 && it
.method
== GET_FROM_STRING
21409 && it
.area
== TEXT_AREA
21410 && it
.string_from_display_prop_p
21411 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21412 overshoot_expected
= true;
21414 /* Find the X coordinate of point. We start from the beginning
21415 of this or previous line to make sure we are before point in
21416 the logical order (since the move_it_* functions can only
21419 reseat_at_previous_visible_line_start (&it
);
21420 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21421 if (IT_CHARPOS (it
) != PT
)
21423 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21424 -1, -1, -1, MOVE_TO_POS
);
21425 /* If we missed point because the character there is
21426 displayed out of a display vector that has more than one
21427 glyph, retry expecting overshoot. */
21428 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21429 && it
.current
.dpvec_index
> 0
21430 && !overshoot_expected
)
21432 overshoot_expected
= true;
21435 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21436 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21438 pt_x
= it
.current_x
;
21440 if (dir
> 0 || overshoot_expected
)
21442 struct glyph_row
*row
= it
.glyph_row
;
21444 /* When point is at beginning of line, we don't have
21445 information about the glyph there loaded into struct
21446 it. Calling get_next_display_element fixes that. */
21448 get_next_display_element (&it
);
21449 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21450 it
.glyph_row
= NULL
;
21451 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21452 it
.glyph_row
= row
;
21453 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21454 it, lest it will become out of sync with it's buffer
21456 it
.current_x
= pt_x
;
21459 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21460 pixel_width
= it
.pixel_width
;
21461 if (overshoot_expected
&& at_eol_p
)
21463 else if (pixel_width
<= 0)
21466 /* If there's a display string (or something similar) at point,
21467 we are actually at the glyph to the left of point, so we need
21468 to correct the X coordinate. */
21469 if (overshoot_expected
)
21472 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21474 pt_x
+= pixel_width
;
21477 /* Compute target X coordinate, either to the left or to the
21478 right of point. On TTY frames, all characters have the same
21479 pixel width of 1, so we can use that. On GUI frames we don't
21480 have an easy way of getting at the pixel width of the
21481 character to the left of point, so we use a different method
21482 of getting to that place. */
21484 target_x
= pt_x
+ pixel_width
;
21486 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21488 /* Target X coordinate could be one line above or below the line
21489 of point, in which case we need to adjust the target X
21490 coordinate. Also, if moving to the left, we need to begin at
21491 the left edge of the point's screen line. */
21496 start_display (&it
, w
, pt
);
21497 if (it
.line_wrap
== TRUNCATE
)
21498 it
.last_visible_x
= INFINITY
;
21499 reseat_at_previous_visible_line_start (&it
);
21500 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21502 move_it_by_lines (&it
, pt_vpos
);
21506 move_it_by_lines (&it
, -1);
21507 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21508 target_is_eol_p
= true;
21509 /* Under word-wrap, we don't know the x coordinate of
21510 the last character displayed on the previous line,
21511 which immediately precedes the wrap point. To find
21512 out its x coordinate, we try moving to the right
21513 margin of the window, which will stop at the wrap
21514 point, and then reset target_x to point at the
21515 character that precedes the wrap point. This is not
21516 needed on GUI frames, because (see below) there we
21517 move from the left margin one grapheme cluster at a
21518 time, and stop when we hit the wrap point. */
21519 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21521 void *it_data
= NULL
;
21524 SAVE_IT (it2
, it
, it_data
);
21525 move_it_in_display_line_to (&it
, ZV
, target_x
,
21526 MOVE_TO_POS
| MOVE_TO_X
);
21527 /* If we arrived at target_x, that _is_ the last
21528 character on the previous line. */
21529 if (it
.current_x
!= target_x
)
21530 target_x
= it
.current_x
- 1;
21531 RESTORE_IT (&it
, &it2
, it_data
);
21538 || (target_x
>= it
.last_visible_x
21539 && it
.line_wrap
!= TRUNCATE
))
21542 move_it_by_lines (&it
, 0);
21543 move_it_by_lines (&it
, 1);
21548 /* Move to the target X coordinate. */
21549 #ifdef HAVE_WINDOW_SYSTEM
21550 /* On GUI frames, as we don't know the X coordinate of the
21551 character to the left of point, moving point to the left
21552 requires walking, one grapheme cluster at a time, until we
21553 find ourself at a place immediately to the left of the
21554 character at point. */
21555 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21557 struct text_pos new_pos
;
21558 enum move_it_result rc
= MOVE_X_REACHED
;
21560 if (it
.current_x
== 0)
21561 get_next_display_element (&it
);
21562 if (it
.what
== IT_COMPOSITION
)
21564 new_pos
.charpos
= it
.cmp_it
.charpos
;
21565 new_pos
.bytepos
= -1;
21568 new_pos
= it
.current
.pos
;
21570 while (it
.current_x
+ it
.pixel_width
<= target_x
21571 && (rc
== MOVE_X_REACHED
21572 /* Under word-wrap, move_it_in_display_line_to
21573 stops at correct coordinates, but sometimes
21574 returns MOVE_POS_MATCH_OR_ZV. */
21575 || (it
.line_wrap
== WORD_WRAP
21576 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21578 int new_x
= it
.current_x
+ it
.pixel_width
;
21580 /* For composed characters, we want the position of the
21581 first character in the grapheme cluster (usually, the
21582 composition's base character), whereas it.current
21583 might give us the position of the _last_ one, e.g. if
21584 the composition is rendered in reverse due to bidi
21586 if (it
.what
== IT_COMPOSITION
)
21588 new_pos
.charpos
= it
.cmp_it
.charpos
;
21589 new_pos
.bytepos
= -1;
21592 new_pos
= it
.current
.pos
;
21593 if (new_x
== it
.current_x
)
21595 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21596 MOVE_TO_POS
| MOVE_TO_X
);
21597 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21600 /* The previous position we saw in the loop is the one we
21602 if (new_pos
.bytepos
== -1)
21603 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21604 it
.current
.pos
= new_pos
;
21608 if (it
.current_x
!= target_x
)
21609 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21611 /* If we ended up in a display string that covers point, move to
21612 buffer position to the right in the visual order. */
21615 while (IT_CHARPOS (it
) == PT
)
21617 set_iterator_to_next (&it
, false);
21618 if (!get_next_display_element (&it
))
21623 /* Move point to that position. */
21624 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21627 return make_number (PT
);
21629 #undef ROW_GLYPH_NEWLINE_P
21632 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21633 Sbidi_resolved_levels
, 0, 1, 0,
21634 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21636 The resolved levels are produced by the Emacs bidi reordering engine
21637 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21638 read the Unicode Standard Annex 9 (UAX#9) for background information
21639 about these levels.
21641 VPOS is the zero-based number of the current window's screen line
21642 for which to produce the resolved levels. If VPOS is nil or omitted,
21643 it defaults to the screen line of point. If the window displays a
21644 header line, VPOS of zero will report on the header line, and first
21645 line of text in the window will have VPOS of 1.
21647 Value is an array of resolved levels, indexed by glyph number.
21648 Glyphs are numbered from zero starting from the beginning of the
21649 screen line, i.e. the left edge of the window for left-to-right lines
21650 and from the right edge for right-to-left lines. The resolved levels
21651 are produced only for the window's text area; text in display margins
21654 If the selected window's display is not up-to-date, or if the specified
21655 screen line does not display text, this function returns nil. It is
21656 highly recommended to bind this function to some simple key, like F8,
21657 in order to avoid these problems.
21659 This function exists mainly for testing the correctness of the
21660 Emacs UBA implementation, in particular with the test suite. */)
21663 struct window
*w
= XWINDOW (selected_window
);
21664 struct buffer
*b
= XBUFFER (w
->contents
);
21666 struct glyph_row
*row
;
21670 int d1
, d2
, d3
, d4
, d5
;
21672 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21676 CHECK_NUMBER_COERCE_MARKER (vpos
);
21677 nrow
= XINT (vpos
);
21680 /* We require up-to-date glyph matrix for this window. */
21681 if (w
->window_end_valid
21682 && !windows_or_buffers_changed
21684 && !b
->clip_changed
21685 && !b
->prevent_redisplay_optimizations_p
21686 && !window_outdated (w
)
21688 && nrow
< w
->current_matrix
->nrows
21689 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21690 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21692 struct glyph
*g
, *e
, *g1
;
21694 Lisp_Object levels
;
21696 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21698 g
= g1
= row
->glyphs
[TEXT_AREA
];
21699 e
= g
+ row
->used
[TEXT_AREA
];
21701 /* Skip over glyphs at the start of the row that was
21702 generated by redisplay for its own needs. */
21704 && NILP (g
->object
)
21709 /* Count the "interesting" glyphs in this row. */
21710 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21713 /* Create and fill the array. */
21714 levels
= make_uninit_vector (nglyphs
);
21715 for (i
= 0; g1
< g
; i
++, g1
++)
21716 ASET (levels
, i
, make_number (g1
->resolved_level
));
21718 else /* Right-to-left glyph row. */
21720 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21721 e
= row
->glyphs
[TEXT_AREA
] - 1;
21723 && NILP (g
->object
)
21727 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21729 levels
= make_uninit_vector (nglyphs
);
21730 for (i
= 0; g1
> g
; i
++, g1
--)
21731 ASET (levels
, i
, make_number (g1
->resolved_level
));
21741 /***********************************************************************
21743 ***********************************************************************/
21745 /* Redisplay the menu bar in the frame for window W.
21747 The menu bar of X frames that don't have X toolkit support is
21748 displayed in a special window W->frame->menu_bar_window.
21750 The menu bar of terminal frames is treated specially as far as
21751 glyph matrices are concerned. Menu bar lines are not part of
21752 windows, so the update is done directly on the frame matrix rows
21753 for the menu bar. */
21756 display_menu_bar (struct window
*w
)
21758 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21763 /* Don't do all this for graphical frames. */
21765 if (FRAME_W32_P (f
))
21768 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21774 if (FRAME_NS_P (f
))
21776 #endif /* HAVE_NS */
21778 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21779 eassert (!FRAME_WINDOW_P (f
));
21780 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21781 it
.first_visible_x
= 0;
21782 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21783 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21784 if (FRAME_WINDOW_P (f
))
21786 /* Menu bar lines are displayed in the desired matrix of the
21787 dummy window menu_bar_window. */
21788 struct window
*menu_w
;
21789 menu_w
= XWINDOW (f
->menu_bar_window
);
21790 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21792 it
.first_visible_x
= 0;
21793 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21796 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21798 /* This is a TTY frame, i.e. character hpos/vpos are used as
21800 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21802 it
.first_visible_x
= 0;
21803 it
.last_visible_x
= FRAME_COLS (f
);
21806 /* FIXME: This should be controlled by a user option. See the
21807 comments in redisplay_tool_bar and display_mode_line about
21809 it
.paragraph_embedding
= L2R
;
21811 /* Clear all rows of the menu bar. */
21812 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21814 struct glyph_row
*row
= it
.glyph_row
+ i
;
21815 clear_glyph_row (row
);
21816 row
->enabled_p
= true;
21817 row
->full_width_p
= true;
21818 row
->reversed_p
= false;
21821 /* Display all items of the menu bar. */
21822 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21823 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21825 Lisp_Object string
;
21827 /* Stop at nil string. */
21828 string
= AREF (items
, i
+ 1);
21832 /* Remember where item was displayed. */
21833 ASET (items
, i
+ 3, make_number (it
.hpos
));
21835 /* Display the item, pad with one space. */
21836 if (it
.current_x
< it
.last_visible_x
)
21837 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21838 SCHARS (string
) + 1, 0, 0, -1);
21841 /* Fill out the line with spaces. */
21842 if (it
.current_x
< it
.last_visible_x
)
21843 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21845 /* Compute the total height of the lines. */
21846 compute_line_metrics (&it
);
21849 /* Deep copy of a glyph row, including the glyphs. */
21851 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21853 struct glyph
*pointers
[1 + LAST_AREA
];
21854 int to_used
= to
->used
[TEXT_AREA
];
21856 /* Save glyph pointers of TO. */
21857 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21859 /* Do a structure assignment. */
21862 /* Restore original glyph pointers of TO. */
21863 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21865 /* Copy the glyphs. */
21866 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21867 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21869 /* If we filled only part of the TO row, fill the rest with
21870 space_glyph (which will display as empty space). */
21871 if (to_used
> from
->used
[TEXT_AREA
])
21872 fill_up_frame_row_with_spaces (to
, to_used
);
21875 /* Display one menu item on a TTY, by overwriting the glyphs in the
21876 frame F's desired glyph matrix with glyphs produced from the menu
21877 item text. Called from term.c to display TTY drop-down menus one
21880 ITEM_TEXT is the menu item text as a C string.
21882 FACE_ID is the face ID to be used for this menu item. FACE_ID
21883 could specify one of 3 faces: a face for an enabled item, a face
21884 for a disabled item, or a face for a selected item.
21886 X and Y are coordinates of the first glyph in the frame's desired
21887 matrix to be overwritten by the menu item. Since this is a TTY, Y
21888 is the zero-based number of the glyph row and X is the zero-based
21889 glyph number in the row, starting from left, where to start
21890 displaying the item.
21892 SUBMENU means this menu item drops down a submenu, which
21893 should be indicated by displaying a proper visual cue after the
21897 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21898 int x
, int y
, bool submenu
)
21901 struct frame
*f
= SELECTED_FRAME ();
21902 struct window
*w
= XWINDOW (f
->selected_window
);
21903 struct glyph_row
*row
;
21904 size_t item_len
= strlen (item_text
);
21906 eassert (FRAME_TERMCAP_P (f
));
21908 /* Don't write beyond the matrix's last row. This can happen for
21909 TTY screens that are not high enough to show the entire menu.
21910 (This is actually a bit of defensive programming, as
21911 tty_menu_display already limits the number of menu items to one
21912 less than the number of screen lines.) */
21913 if (y
>= f
->desired_matrix
->nrows
)
21916 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21917 it
.first_visible_x
= 0;
21918 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21919 row
= it
.glyph_row
;
21920 /* Start with the row contents from the current matrix. */
21921 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21922 bool saved_width
= row
->full_width_p
;
21923 row
->full_width_p
= true;
21924 bool saved_reversed
= row
->reversed_p
;
21925 row
->reversed_p
= false;
21926 row
->enabled_p
= true;
21928 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21930 eassert (x
< f
->desired_matrix
->matrix_w
);
21931 it
.current_x
= it
.hpos
= x
;
21932 it
.current_y
= it
.vpos
= y
;
21933 int saved_used
= row
->used
[TEXT_AREA
];
21934 bool saved_truncated
= row
->truncated_on_right_p
;
21935 row
->used
[TEXT_AREA
] = x
;
21936 it
.face_id
= face_id
;
21937 it
.line_wrap
= TRUNCATE
;
21939 /* FIXME: This should be controlled by a user option. See the
21940 comments in redisplay_tool_bar and display_mode_line about this.
21941 Also, if paragraph_embedding could ever be R2L, changes will be
21942 needed to avoid shifting to the right the row characters in
21943 term.c:append_glyph. */
21944 it
.paragraph_embedding
= L2R
;
21946 /* Pad with a space on the left. */
21947 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21949 /* Display the menu item, pad with spaces to WIDTH. */
21952 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21953 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21955 /* Indicate with " >" that there's a submenu. */
21956 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21957 FRAME_COLS (f
) - 1, -1);
21960 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21961 width
, 0, FRAME_COLS (f
) - 1, -1);
21963 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21964 row
->truncated_on_right_p
= saved_truncated
;
21965 row
->hash
= row_hash (row
);
21966 row
->full_width_p
= saved_width
;
21967 row
->reversed_p
= saved_reversed
;
21970 /***********************************************************************
21972 ***********************************************************************/
21974 /* Redisplay mode lines in the window tree whose root is WINDOW.
21975 If FORCE, redisplay mode lines unconditionally.
21976 Otherwise, redisplay only mode lines that are garbaged. Value is
21977 the number of windows whose mode lines were redisplayed. */
21980 redisplay_mode_lines (Lisp_Object window
, bool force
)
21984 while (!NILP (window
))
21986 struct window
*w
= XWINDOW (window
);
21988 if (WINDOWP (w
->contents
))
21989 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21991 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21992 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21994 struct text_pos lpoint
;
21995 struct buffer
*old
= current_buffer
;
21997 /* Set the window's buffer for the mode line display. */
21998 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21999 set_buffer_internal_1 (XBUFFER (w
->contents
));
22001 /* Point refers normally to the selected window. For any
22002 other window, set up appropriate value. */
22003 if (!EQ (window
, selected_window
))
22005 struct text_pos pt
;
22007 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22008 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22011 /* Display mode lines. */
22012 clear_glyph_matrix (w
->desired_matrix
);
22013 if (display_mode_lines (w
))
22016 /* Restore old settings. */
22017 set_buffer_internal_1 (old
);
22018 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22028 /* Display the mode and/or header line of window W. Value is the
22029 sum number of mode lines and header lines displayed. */
22032 display_mode_lines (struct window
*w
)
22034 Lisp_Object old_selected_window
= selected_window
;
22035 Lisp_Object old_selected_frame
= selected_frame
;
22036 Lisp_Object new_frame
= w
->frame
;
22037 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22040 selected_frame
= new_frame
;
22041 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22042 or window's point, then we'd need select_window_1 here as well. */
22043 XSETWINDOW (selected_window
, w
);
22044 XFRAME (new_frame
)->selected_window
= selected_window
;
22046 /* These will be set while the mode line specs are processed. */
22047 line_number_displayed
= false;
22048 w
->column_number_displayed
= -1;
22050 if (WINDOW_WANTS_MODELINE_P (w
))
22052 struct window
*sel_w
= XWINDOW (old_selected_window
);
22054 /* Select mode line face based on the real selected window. */
22055 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22056 BVAR (current_buffer
, mode_line_format
));
22060 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22062 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22063 BVAR (current_buffer
, header_line_format
));
22067 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22068 selected_frame
= old_selected_frame
;
22069 selected_window
= old_selected_window
;
22071 w
->must_be_updated_p
= true;
22076 /* Display mode or header line of window W. FACE_ID specifies which
22077 line to display; it is either MODE_LINE_FACE_ID or
22078 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22079 display. Value is the pixel height of the mode/header line
22083 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22087 ptrdiff_t count
= SPECPDL_INDEX ();
22089 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22090 /* Don't extend on a previously drawn mode-line.
22091 This may happen if called from pos_visible_p. */
22092 it
.glyph_row
->enabled_p
= false;
22093 prepare_desired_row (w
, it
.glyph_row
, true);
22095 it
.glyph_row
->mode_line_p
= true;
22097 /* FIXME: This should be controlled by a user option. But
22098 supporting such an option is not trivial, since the mode line is
22099 made up of many separate strings. */
22100 it
.paragraph_embedding
= L2R
;
22102 record_unwind_protect (unwind_format_mode_line
,
22103 format_mode_line_unwind_data (NULL
, NULL
,
22106 mode_line_target
= MODE_LINE_DISPLAY
;
22108 /* Temporarily make frame's keyboard the current kboard so that
22109 kboard-local variables in the mode_line_format will get the right
22111 push_kboard (FRAME_KBOARD (it
.f
));
22112 record_unwind_save_match_data ();
22113 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22116 unbind_to (count
, Qnil
);
22118 /* Fill up with spaces. */
22119 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22121 compute_line_metrics (&it
);
22122 it
.glyph_row
->full_width_p
= true;
22123 it
.glyph_row
->continued_p
= false;
22124 it
.glyph_row
->truncated_on_left_p
= false;
22125 it
.glyph_row
->truncated_on_right_p
= false;
22127 /* Make a 3D mode-line have a shadow at its right end. */
22128 face
= FACE_FROM_ID (it
.f
, face_id
);
22129 extend_face_to_end_of_line (&it
);
22130 if (face
->box
!= FACE_NO_BOX
)
22132 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22133 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22134 last
->right_box_line_p
= true;
22137 return it
.glyph_row
->height
;
22140 /* Move element ELT in LIST to the front of LIST.
22141 Return the updated list. */
22144 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22146 register Lisp_Object tail
, prev
;
22147 register Lisp_Object tem
;
22151 while (CONSP (tail
))
22157 /* Splice out the link TAIL. */
22159 list
= XCDR (tail
);
22161 Fsetcdr (prev
, XCDR (tail
));
22163 /* Now make it the first. */
22164 Fsetcdr (tail
, list
);
22169 tail
= XCDR (tail
);
22173 /* Not found--return unchanged LIST. */
22177 /* Contribute ELT to the mode line for window IT->w. How it
22178 translates into text depends on its data type.
22180 IT describes the display environment in which we display, as usual.
22182 DEPTH is the depth in recursion. It is used to prevent
22183 infinite recursion here.
22185 FIELD_WIDTH is the number of characters the display of ELT should
22186 occupy in the mode line, and PRECISION is the maximum number of
22187 characters to display from ELT's representation. See
22188 display_string for details.
22190 Returns the hpos of the end of the text generated by ELT.
22192 PROPS is a property list to add to any string we encounter.
22194 If RISKY, remove (disregard) any properties in any string
22195 we encounter, and ignore :eval and :propertize.
22197 The global variable `mode_line_target' determines whether the
22198 output is passed to `store_mode_line_noprop',
22199 `store_mode_line_string', or `display_string'. */
22202 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22203 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22205 int n
= 0, field
, prec
;
22206 bool literal
= false;
22210 elt
= build_string ("*too-deep*");
22214 switch (XTYPE (elt
))
22218 /* A string: output it and check for %-constructs within it. */
22220 ptrdiff_t offset
= 0;
22222 if (SCHARS (elt
) > 0
22223 && (!NILP (props
) || risky
))
22225 Lisp_Object oprops
, aelt
;
22226 oprops
= Ftext_properties_at (make_number (0), elt
);
22228 /* If the starting string's properties are not what
22229 we want, translate the string. Also, if the string
22230 is risky, do that anyway. */
22232 if (NILP (Fequal (props
, oprops
)) || risky
)
22234 /* If the starting string has properties,
22235 merge the specified ones onto the existing ones. */
22236 if (! NILP (oprops
) && !risky
)
22240 oprops
= Fcopy_sequence (oprops
);
22242 while (CONSP (tem
))
22244 oprops
= Fplist_put (oprops
, XCAR (tem
),
22245 XCAR (XCDR (tem
)));
22246 tem
= XCDR (XCDR (tem
));
22251 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22252 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22254 /* AELT is what we want. Move it to the front
22255 without consing. */
22257 mode_line_proptrans_alist
22258 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22264 /* If AELT has the wrong props, it is useless.
22265 so get rid of it. */
22267 mode_line_proptrans_alist
22268 = Fdelq (aelt
, mode_line_proptrans_alist
);
22270 elt
= Fcopy_sequence (elt
);
22271 Fset_text_properties (make_number (0), Flength (elt
),
22273 /* Add this item to mode_line_proptrans_alist. */
22274 mode_line_proptrans_alist
22275 = Fcons (Fcons (elt
, props
),
22276 mode_line_proptrans_alist
);
22277 /* Truncate mode_line_proptrans_alist
22278 to at most 50 elements. */
22279 tem
= Fnthcdr (make_number (50),
22280 mode_line_proptrans_alist
);
22282 XSETCDR (tem
, Qnil
);
22291 prec
= precision
- n
;
22292 switch (mode_line_target
)
22294 case MODE_LINE_NOPROP
:
22295 case MODE_LINE_TITLE
:
22296 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22298 case MODE_LINE_STRING
:
22299 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22301 case MODE_LINE_DISPLAY
:
22302 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22303 0, prec
, 0, STRING_MULTIBYTE (elt
));
22310 /* Handle the non-literal case. */
22312 while ((precision
<= 0 || n
< precision
)
22313 && SREF (elt
, offset
) != 0
22314 && (mode_line_target
!= MODE_LINE_DISPLAY
22315 || it
->current_x
< it
->last_visible_x
))
22317 ptrdiff_t last_offset
= offset
;
22319 /* Advance to end of string or next format specifier. */
22320 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22323 if (offset
- 1 != last_offset
)
22325 ptrdiff_t nchars
, nbytes
;
22327 /* Output to end of string or up to '%'. Field width
22328 is length of string. Don't output more than
22329 PRECISION allows us. */
22332 prec
= c_string_width (SDATA (elt
) + last_offset
,
22333 offset
- last_offset
, precision
- n
,
22336 switch (mode_line_target
)
22338 case MODE_LINE_NOPROP
:
22339 case MODE_LINE_TITLE
:
22340 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22342 case MODE_LINE_STRING
:
22344 ptrdiff_t bytepos
= last_offset
;
22345 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22346 ptrdiff_t endpos
= (precision
<= 0
22347 ? string_byte_to_char (elt
, offset
)
22348 : charpos
+ nchars
);
22349 Lisp_Object mode_string
22350 = Fsubstring (elt
, make_number (charpos
),
22351 make_number (endpos
));
22352 n
+= store_mode_line_string (NULL
, mode_string
, false,
22356 case MODE_LINE_DISPLAY
:
22358 ptrdiff_t bytepos
= last_offset
;
22359 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22361 if (precision
<= 0)
22362 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22363 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22365 STRING_MULTIBYTE (elt
));
22370 else /* c == '%' */
22372 ptrdiff_t percent_position
= offset
;
22374 /* Get the specified minimum width. Zero means
22377 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22378 field
= field
* 10 + c
- '0';
22380 /* Don't pad beyond the total padding allowed. */
22381 if (field_width
- n
> 0 && field
> field_width
- n
)
22382 field
= field_width
- n
;
22384 /* Note that either PRECISION <= 0 or N < PRECISION. */
22385 prec
= precision
- n
;
22388 n
+= display_mode_element (it
, depth
, field
, prec
,
22389 Vglobal_mode_string
, props
,
22394 ptrdiff_t bytepos
, charpos
;
22396 Lisp_Object string
;
22398 bytepos
= percent_position
;
22399 charpos
= (STRING_MULTIBYTE (elt
)
22400 ? string_byte_to_char (elt
, bytepos
)
22402 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22403 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22405 switch (mode_line_target
)
22407 case MODE_LINE_NOPROP
:
22408 case MODE_LINE_TITLE
:
22409 n
+= store_mode_line_noprop (spec
, field
, prec
);
22411 case MODE_LINE_STRING
:
22413 Lisp_Object tem
= build_string (spec
);
22414 props
= Ftext_properties_at (make_number (charpos
), elt
);
22415 /* Should only keep face property in props */
22416 n
+= store_mode_line_string (NULL
, tem
, false,
22417 field
, prec
, props
);
22420 case MODE_LINE_DISPLAY
:
22422 int nglyphs_before
, nwritten
;
22424 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22425 nwritten
= display_string (spec
, string
, elt
,
22430 /* Assign to the glyphs written above the
22431 string where the `%x' came from, position
22435 struct glyph
*glyph
22436 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22440 for (i
= 0; i
< nwritten
; ++i
)
22442 glyph
[i
].object
= elt
;
22443 glyph
[i
].charpos
= charpos
;
22460 /* A symbol: process the value of the symbol recursively
22461 as if it appeared here directly. Avoid error if symbol void.
22462 Special case: if value of symbol is a string, output the string
22465 register Lisp_Object tem
;
22467 /* If the variable is not marked as risky to set
22468 then its contents are risky to use. */
22469 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22472 tem
= Fboundp (elt
);
22475 tem
= Fsymbol_value (elt
);
22476 /* If value is a string, output that string literally:
22477 don't check for % within it. */
22481 if (!EQ (tem
, elt
))
22483 /* Give up right away for nil or t. */
22493 register Lisp_Object car
, tem
;
22495 /* A cons cell: five distinct cases.
22496 If first element is :eval or :propertize, do something special.
22497 If first element is a string or a cons, process all the elements
22498 and effectively concatenate them.
22499 If first element is a negative number, truncate displaying cdr to
22500 at most that many characters. If positive, pad (with spaces)
22501 to at least that many characters.
22502 If first element is a symbol, process the cadr or caddr recursively
22503 according to whether the symbol's value is non-nil or nil. */
22505 if (EQ (car
, QCeval
))
22507 /* An element of the form (:eval FORM) means evaluate FORM
22508 and use the result as mode line elements. */
22513 if (CONSP (XCDR (elt
)))
22516 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22517 n
+= display_mode_element (it
, depth
, field_width
- n
,
22518 precision
- n
, spec
, props
,
22522 else if (EQ (car
, QCpropertize
))
22524 /* An element of the form (:propertize ELT PROPS...)
22525 means display ELT but applying properties PROPS. */
22530 if (CONSP (XCDR (elt
)))
22531 n
+= display_mode_element (it
, depth
, field_width
- n
,
22532 precision
- n
, XCAR (XCDR (elt
)),
22533 XCDR (XCDR (elt
)), risky
);
22535 else if (SYMBOLP (car
))
22537 tem
= Fboundp (car
);
22541 /* elt is now the cdr, and we know it is a cons cell.
22542 Use its car if CAR has a non-nil value. */
22545 tem
= Fsymbol_value (car
);
22552 /* Symbol's value is nil (or symbol is unbound)
22553 Get the cddr of the original list
22554 and if possible find the caddr and use that. */
22558 else if (!CONSP (elt
))
22563 else if (INTEGERP (car
))
22565 register int lim
= XINT (car
);
22569 /* Negative int means reduce maximum width. */
22570 if (precision
<= 0)
22573 precision
= min (precision
, -lim
);
22577 /* Padding specified. Don't let it be more than
22578 current maximum. */
22580 lim
= min (precision
, lim
);
22582 /* If that's more padding than already wanted, queue it.
22583 But don't reduce padding already specified even if
22584 that is beyond the current truncation point. */
22585 field_width
= max (lim
, field_width
);
22589 else if (STRINGP (car
) || CONSP (car
))
22591 Lisp_Object halftail
= elt
;
22595 && (precision
<= 0 || n
< precision
))
22597 n
+= display_mode_element (it
, depth
,
22598 /* Do padding only after the last
22599 element in the list. */
22600 (! CONSP (XCDR (elt
))
22603 precision
- n
, XCAR (elt
),
22607 if ((len
& 1) == 0)
22608 halftail
= XCDR (halftail
);
22609 /* Check for cycle. */
22610 if (EQ (halftail
, elt
))
22619 elt
= build_string ("*invalid*");
22623 /* Pad to FIELD_WIDTH. */
22624 if (field_width
> 0 && n
< field_width
)
22626 switch (mode_line_target
)
22628 case MODE_LINE_NOPROP
:
22629 case MODE_LINE_TITLE
:
22630 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22632 case MODE_LINE_STRING
:
22633 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22636 case MODE_LINE_DISPLAY
:
22637 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22646 /* Store a mode-line string element in mode_line_string_list.
22648 If STRING is non-null, display that C string. Otherwise, the Lisp
22649 string LISP_STRING is displayed.
22651 FIELD_WIDTH is the minimum number of output glyphs to produce.
22652 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22653 with spaces. FIELD_WIDTH <= 0 means don't pad.
22655 PRECISION is the maximum number of characters to output from
22656 STRING. PRECISION <= 0 means don't truncate the string.
22658 If COPY_STRING, make a copy of LISP_STRING before adding
22659 properties to the string.
22661 PROPS are the properties to add to the string.
22662 The mode_line_string_face face property is always added to the string.
22666 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22668 int field_width
, int precision
, Lisp_Object props
)
22673 if (string
!= NULL
)
22675 len
= strlen (string
);
22676 if (precision
> 0 && len
> precision
)
22678 lisp_string
= make_string (string
, len
);
22680 props
= mode_line_string_face_prop
;
22681 else if (!NILP (mode_line_string_face
))
22683 Lisp_Object face
= Fplist_get (props
, Qface
);
22684 props
= Fcopy_sequence (props
);
22686 face
= mode_line_string_face
;
22688 face
= list2 (face
, mode_line_string_face
);
22689 props
= Fplist_put (props
, Qface
, face
);
22691 Fadd_text_properties (make_number (0), make_number (len
),
22692 props
, lisp_string
);
22696 len
= XFASTINT (Flength (lisp_string
));
22697 if (precision
> 0 && len
> precision
)
22700 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22703 if (!NILP (mode_line_string_face
))
22707 props
= Ftext_properties_at (make_number (0), lisp_string
);
22708 face
= Fplist_get (props
, Qface
);
22710 face
= mode_line_string_face
;
22712 face
= list2 (face
, mode_line_string_face
);
22713 props
= list2 (Qface
, face
);
22715 lisp_string
= Fcopy_sequence (lisp_string
);
22718 Fadd_text_properties (make_number (0), make_number (len
),
22719 props
, lisp_string
);
22724 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22728 if (field_width
> len
)
22730 field_width
-= len
;
22731 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22733 Fadd_text_properties (make_number (0), make_number (field_width
),
22734 props
, lisp_string
);
22735 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22743 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22745 doc
: /* Format a string out of a mode line format specification.
22746 First arg FORMAT specifies the mode line format (see `mode-line-format'
22747 for details) to use.
22749 By default, the format is evaluated for the currently selected window.
22751 Optional second arg FACE specifies the face property to put on all
22752 characters for which no face is specified. The value nil means the
22753 default face. The value t means whatever face the window's mode line
22754 currently uses (either `mode-line' or `mode-line-inactive',
22755 depending on whether the window is the selected window or not).
22756 An integer value means the value string has no text
22759 Optional third and fourth args WINDOW and BUFFER specify the window
22760 and buffer to use as the context for the formatting (defaults
22761 are the selected window and the WINDOW's buffer). */)
22762 (Lisp_Object format
, Lisp_Object face
,
22763 Lisp_Object window
, Lisp_Object buffer
)
22768 struct buffer
*old_buffer
= NULL
;
22770 bool no_props
= INTEGERP (face
);
22771 ptrdiff_t count
= SPECPDL_INDEX ();
22773 int string_start
= 0;
22775 w
= decode_any_window (window
);
22776 XSETWINDOW (window
, w
);
22779 buffer
= w
->contents
;
22780 CHECK_BUFFER (buffer
);
22782 /* Make formatting the modeline a non-op when noninteractive, otherwise
22783 there will be problems later caused by a partially initialized frame. */
22784 if (NILP (format
) || noninteractive
)
22785 return empty_unibyte_string
;
22790 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22791 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22792 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22793 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22794 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22795 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22796 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22799 old_buffer
= current_buffer
;
22801 /* Save things including mode_line_proptrans_alist,
22802 and set that to nil so that we don't alter the outer value. */
22803 record_unwind_protect (unwind_format_mode_line
,
22804 format_mode_line_unwind_data
22805 (XFRAME (WINDOW_FRAME (w
)),
22806 old_buffer
, selected_window
, true));
22807 mode_line_proptrans_alist
= Qnil
;
22809 Fselect_window (window
, Qt
);
22810 set_buffer_internal_1 (XBUFFER (buffer
));
22812 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22816 mode_line_target
= MODE_LINE_NOPROP
;
22817 mode_line_string_face_prop
= Qnil
;
22818 mode_line_string_list
= Qnil
;
22819 string_start
= MODE_LINE_NOPROP_LEN (0);
22823 mode_line_target
= MODE_LINE_STRING
;
22824 mode_line_string_list
= Qnil
;
22825 mode_line_string_face
= face
;
22826 mode_line_string_face_prop
22827 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22830 push_kboard (FRAME_KBOARD (it
.f
));
22831 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22836 len
= MODE_LINE_NOPROP_LEN (string_start
);
22837 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22841 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22842 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22843 empty_unibyte_string
);
22846 unbind_to (count
, Qnil
);
22850 /* Write a null-terminated, right justified decimal representation of
22851 the positive integer D to BUF using a minimal field width WIDTH. */
22854 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22856 register char *p
= buf
;
22864 *p
++ = d
% 10 + '0';
22869 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22880 /* Write a null-terminated, right justified decimal and "human
22881 readable" representation of the nonnegative integer D to BUF using
22882 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22884 static const char power_letter
[] =
22898 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22900 /* We aim to represent the nonnegative integer D as
22901 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22902 ptrdiff_t quotient
= d
;
22904 /* -1 means: do not use TENTHS. */
22908 /* Length of QUOTIENT.TENTHS as a string. */
22914 if (quotient
>= 1000)
22916 /* Scale to the appropriate EXPONENT. */
22919 remainder
= quotient
% 1000;
22923 while (quotient
>= 1000);
22925 /* Round to nearest and decide whether to use TENTHS or not. */
22928 tenths
= remainder
/ 100;
22929 if (remainder
% 100 >= 50)
22936 if (quotient
== 10)
22944 if (remainder
>= 500)
22946 if (quotient
< 999)
22957 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22958 if (tenths
== -1 && quotient
<= 99)
22965 p
= psuffix
= buf
+ max (width
, length
);
22967 /* Print EXPONENT. */
22968 *psuffix
++ = power_letter
[exponent
];
22971 /* Print TENTHS. */
22974 *--p
= '0' + tenths
;
22978 /* Print QUOTIENT. */
22981 int digit
= quotient
% 10;
22982 *--p
= '0' + digit
;
22984 while ((quotient
/= 10) != 0);
22986 /* Print leading spaces. */
22991 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22992 If EOL_FLAG, set also a mnemonic character for end-of-line
22993 type of CODING_SYSTEM. Return updated pointer into BUF. */
22995 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22998 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23001 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23002 const unsigned char *eol_str
;
23004 /* The EOL conversion we are using. */
23005 Lisp_Object eoltype
;
23007 val
= CODING_SYSTEM_SPEC (coding_system
);
23010 if (!VECTORP (val
)) /* Not yet decided. */
23012 *buf
++ = multibyte
? '-' : ' ';
23014 eoltype
= eol_mnemonic_undecided
;
23015 /* Don't mention EOL conversion if it isn't decided. */
23020 Lisp_Object eolvalue
;
23022 attrs
= AREF (val
, 0);
23023 eolvalue
= AREF (val
, 2);
23026 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23031 /* The EOL conversion that is normal on this system. */
23033 if (NILP (eolvalue
)) /* Not yet decided. */
23034 eoltype
= eol_mnemonic_undecided
;
23035 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23036 eoltype
= eol_mnemonic_undecided
;
23037 else /* eolvalue is Qunix, Qdos, or Qmac. */
23038 eoltype
= (EQ (eolvalue
, Qunix
)
23039 ? eol_mnemonic_unix
23040 : EQ (eolvalue
, Qdos
)
23041 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23047 /* Mention the EOL conversion if it is not the usual one. */
23048 if (STRINGP (eoltype
))
23050 eol_str
= SDATA (eoltype
);
23051 eol_str_len
= SBYTES (eoltype
);
23053 else if (CHARACTERP (eoltype
))
23055 int c
= XFASTINT (eoltype
);
23056 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23060 eol_str
= invalid_eol_type
;
23061 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23063 memcpy (buf
, eol_str
, eol_str_len
);
23064 buf
+= eol_str_len
;
23070 /* Return a string for the output of a mode line %-spec for window W,
23071 generated by character C. FIELD_WIDTH > 0 means pad the string
23072 returned with spaces to that value. Return a Lisp string in
23073 *STRING if the resulting string is taken from that Lisp string.
23075 Note we operate on the current buffer for most purposes. */
23077 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23079 static const char *
23080 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23081 Lisp_Object
*string
)
23084 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23085 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23086 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23087 produce strings from numerical values, so limit preposterously
23088 large values of FIELD_WIDTH to avoid overrunning the buffer's
23089 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23090 bytes plus the terminating null. */
23091 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23092 struct buffer
*b
= current_buffer
;
23100 if (!NILP (BVAR (b
, read_only
)))
23102 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23107 /* This differs from %* only for a modified read-only buffer. */
23108 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23110 if (!NILP (BVAR (b
, read_only
)))
23115 /* This differs from %* in ignoring read-only-ness. */
23116 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23128 if (command_loop_level
> 5)
23130 p
= decode_mode_spec_buf
;
23131 for (i
= 0; i
< command_loop_level
; i
++)
23134 return decode_mode_spec_buf
;
23142 if (command_loop_level
> 5)
23144 p
= decode_mode_spec_buf
;
23145 for (i
= 0; i
< command_loop_level
; i
++)
23148 return decode_mode_spec_buf
;
23155 /* Let lots_of_dashes be a string of infinite length. */
23156 if (mode_line_target
== MODE_LINE_NOPROP
23157 || mode_line_target
== MODE_LINE_STRING
)
23159 if (field_width
<= 0
23160 || field_width
> sizeof (lots_of_dashes
))
23162 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23163 decode_mode_spec_buf
[i
] = '-';
23164 decode_mode_spec_buf
[i
] = '\0';
23165 return decode_mode_spec_buf
;
23168 return lots_of_dashes
;
23172 obj
= BVAR (b
, name
);
23176 /* %c and %l are ignored in `frame-title-format'.
23177 (In redisplay_internal, the frame title is drawn _before_ the
23178 windows are updated, so the stuff which depends on actual
23179 window contents (such as %l) may fail to render properly, or
23180 even crash emacs.) */
23181 if (mode_line_target
== MODE_LINE_TITLE
)
23185 ptrdiff_t col
= current_column ();
23186 w
->column_number_displayed
= col
;
23187 pint2str (decode_mode_spec_buf
, width
, col
);
23188 return decode_mode_spec_buf
;
23192 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23194 if (NILP (Vmemory_full
))
23197 return "!MEM FULL! ";
23204 /* %F displays the frame name. */
23205 if (!NILP (f
->title
))
23206 return SSDATA (f
->title
);
23207 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23208 return SSDATA (f
->name
);
23212 obj
= BVAR (b
, filename
);
23217 ptrdiff_t size
= ZV
- BEGV
;
23218 pint2str (decode_mode_spec_buf
, width
, size
);
23219 return decode_mode_spec_buf
;
23224 ptrdiff_t size
= ZV
- BEGV
;
23225 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23226 return decode_mode_spec_buf
;
23231 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23232 ptrdiff_t topline
, nlines
, height
;
23235 /* %c and %l are ignored in `frame-title-format'. */
23236 if (mode_line_target
== MODE_LINE_TITLE
)
23239 startpos
= marker_position (w
->start
);
23240 startpos_byte
= marker_byte_position (w
->start
);
23241 height
= WINDOW_TOTAL_LINES (w
);
23243 /* If we decided that this buffer isn't suitable for line numbers,
23244 don't forget that too fast. */
23245 if (w
->base_line_pos
== -1)
23248 /* If the buffer is very big, don't waste time. */
23249 if (INTEGERP (Vline_number_display_limit
)
23250 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23252 w
->base_line_pos
= 0;
23253 w
->base_line_number
= 0;
23257 if (w
->base_line_number
> 0
23258 && w
->base_line_pos
> 0
23259 && w
->base_line_pos
<= startpos
)
23261 line
= w
->base_line_number
;
23262 linepos
= w
->base_line_pos
;
23263 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23268 linepos
= BUF_BEGV (b
);
23269 linepos_byte
= BUF_BEGV_BYTE (b
);
23272 /* Count lines from base line to window start position. */
23273 nlines
= display_count_lines (linepos_byte
,
23277 topline
= nlines
+ line
;
23279 /* Determine a new base line, if the old one is too close
23280 or too far away, or if we did not have one.
23281 "Too close" means it's plausible a scroll-down would
23282 go back past it. */
23283 if (startpos
== BUF_BEGV (b
))
23285 w
->base_line_number
= topline
;
23286 w
->base_line_pos
= BUF_BEGV (b
);
23288 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23289 || linepos
== BUF_BEGV (b
))
23291 ptrdiff_t limit
= BUF_BEGV (b
);
23292 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23293 ptrdiff_t position
;
23294 ptrdiff_t distance
=
23295 (height
* 2 + 30) * line_number_display_limit_width
;
23297 if (startpos
- distance
> limit
)
23299 limit
= startpos
- distance
;
23300 limit_byte
= CHAR_TO_BYTE (limit
);
23303 nlines
= display_count_lines (startpos_byte
,
23305 - (height
* 2 + 30),
23307 /* If we couldn't find the lines we wanted within
23308 line_number_display_limit_width chars per line,
23309 give up on line numbers for this window. */
23310 if (position
== limit_byte
&& limit
== startpos
- distance
)
23312 w
->base_line_pos
= -1;
23313 w
->base_line_number
= 0;
23317 w
->base_line_number
= topline
- nlines
;
23318 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23321 /* Now count lines from the start pos to point. */
23322 nlines
= display_count_lines (startpos_byte
,
23323 PT_BYTE
, PT
, &junk
);
23325 /* Record that we did display the line number. */
23326 line_number_displayed
= true;
23328 /* Make the string to show. */
23329 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23330 return decode_mode_spec_buf
;
23333 char *p
= decode_mode_spec_buf
;
23334 int pad
= width
- 2;
23340 return decode_mode_spec_buf
;
23346 obj
= BVAR (b
, mode_name
);
23350 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23356 ptrdiff_t pos
= marker_position (w
->start
);
23357 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23359 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23361 if (pos
<= BUF_BEGV (b
))
23366 else if (pos
<= BUF_BEGV (b
))
23370 if (total
> 1000000)
23371 /* Do it differently for a large value, to avoid overflow. */
23372 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23374 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23375 /* We can't normally display a 3-digit number,
23376 so get us a 2-digit number that is close. */
23379 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23380 return decode_mode_spec_buf
;
23384 /* Display percentage of size above the bottom of the screen. */
23387 ptrdiff_t toppos
= marker_position (w
->start
);
23388 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23389 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23391 if (botpos
>= BUF_ZV (b
))
23393 if (toppos
<= BUF_BEGV (b
))
23400 if (total
> 1000000)
23401 /* Do it differently for a large value, to avoid overflow. */
23402 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23404 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23405 /* We can't normally display a 3-digit number,
23406 so get us a 2-digit number that is close. */
23409 if (toppos
<= BUF_BEGV (b
))
23410 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23412 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23413 return decode_mode_spec_buf
;
23418 /* status of process */
23419 obj
= Fget_buffer_process (Fcurrent_buffer ());
23421 return "no process";
23423 obj
= Fsymbol_name (Fprocess_status (obj
));
23429 ptrdiff_t count
= inhibit_garbage_collection ();
23430 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23431 Lisp_Object val
= Qnil
;
23433 if (STRINGP (curdir
))
23434 val
= call1 (intern ("file-remote-p"), curdir
);
23436 unbind_to (count
, Qnil
);
23445 /* coding-system (not including end-of-line format) */
23447 /* coding-system (including end-of-line type) */
23449 bool eol_flag
= (c
== 'Z');
23450 char *p
= decode_mode_spec_buf
;
23452 if (! FRAME_WINDOW_P (f
))
23454 /* No need to mention EOL here--the terminal never needs
23455 to do EOL conversion. */
23456 p
= decode_mode_spec_coding (CODING_ID_NAME
23457 (FRAME_KEYBOARD_CODING (f
)->id
),
23459 p
= decode_mode_spec_coding (CODING_ID_NAME
23460 (FRAME_TERMINAL_CODING (f
)->id
),
23463 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23466 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23467 #ifdef subprocesses
23468 obj
= Fget_buffer_process (Fcurrent_buffer ());
23469 if (PROCESSP (obj
))
23471 p
= decode_mode_spec_coding
23472 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23473 p
= decode_mode_spec_coding
23474 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23476 #endif /* subprocesses */
23479 return decode_mode_spec_buf
;
23486 return SSDATA (obj
);
23493 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23494 means count lines back from START_BYTE. But don't go beyond
23495 LIMIT_BYTE. Return the number of lines thus found (always
23498 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23499 either the position COUNT lines after/before START_BYTE, if we
23500 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23504 display_count_lines (ptrdiff_t start_byte
,
23505 ptrdiff_t limit_byte
, ptrdiff_t count
,
23506 ptrdiff_t *byte_pos_ptr
)
23508 register unsigned char *cursor
;
23509 unsigned char *base
;
23511 register ptrdiff_t ceiling
;
23512 register unsigned char *ceiling_addr
;
23513 ptrdiff_t orig_count
= count
;
23515 /* If we are not in selective display mode,
23516 check only for newlines. */
23517 bool selective_display
23518 = (!NILP (BVAR (current_buffer
, selective_display
))
23519 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23523 while (start_byte
< limit_byte
)
23525 ceiling
= BUFFER_CEILING_OF (start_byte
);
23526 ceiling
= min (limit_byte
- 1, ceiling
);
23527 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23528 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23532 if (selective_display
)
23534 while (*cursor
!= '\n' && *cursor
!= 015
23535 && ++cursor
!= ceiling_addr
)
23537 if (cursor
== ceiling_addr
)
23542 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23551 start_byte
+= cursor
- base
;
23552 *byte_pos_ptr
= start_byte
;
23556 while (cursor
< ceiling_addr
);
23558 start_byte
+= ceiling_addr
- base
;
23563 while (start_byte
> limit_byte
)
23565 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23566 ceiling
= max (limit_byte
, ceiling
);
23567 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23568 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23571 if (selective_display
)
23573 while (--cursor
>= ceiling_addr
23574 && *cursor
!= '\n' && *cursor
!= 015)
23576 if (cursor
< ceiling_addr
)
23581 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23588 start_byte
+= cursor
- base
+ 1;
23589 *byte_pos_ptr
= start_byte
;
23590 /* When scanning backwards, we should
23591 not count the newline posterior to which we stop. */
23592 return - orig_count
- 1;
23595 start_byte
+= ceiling_addr
- base
;
23599 *byte_pos_ptr
= limit_byte
;
23602 return - orig_count
+ count
;
23603 return orig_count
- count
;
23609 /***********************************************************************
23611 ***********************************************************************/
23613 /* Display a NUL-terminated string, starting with index START.
23615 If STRING is non-null, display that C string. Otherwise, the Lisp
23616 string LISP_STRING is displayed. There's a case that STRING is
23617 non-null and LISP_STRING is not nil. It means STRING is a string
23618 data of LISP_STRING. In that case, we display LISP_STRING while
23619 ignoring its text properties.
23621 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23622 FACE_STRING. Display STRING or LISP_STRING with the face at
23623 FACE_STRING_POS in FACE_STRING:
23625 Display the string in the environment given by IT, but use the
23626 standard display table, temporarily.
23628 FIELD_WIDTH is the minimum number of output glyphs to produce.
23629 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23630 with spaces. If STRING has more characters, more than FIELD_WIDTH
23631 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23633 PRECISION is the maximum number of characters to output from
23634 STRING. PRECISION < 0 means don't truncate the string.
23636 This is roughly equivalent to printf format specifiers:
23638 FIELD_WIDTH PRECISION PRINTF
23639 ----------------------------------------
23645 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23646 display them, and < 0 means obey the current buffer's value of
23647 enable_multibyte_characters.
23649 Value is the number of columns displayed. */
23652 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23653 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23654 int field_width
, int precision
, int max_x
, int multibyte
)
23656 int hpos_at_start
= it
->hpos
;
23657 int saved_face_id
= it
->face_id
;
23658 struct glyph_row
*row
= it
->glyph_row
;
23659 ptrdiff_t it_charpos
;
23661 /* Initialize the iterator IT for iteration over STRING beginning
23662 with index START. */
23663 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23664 precision
, field_width
, multibyte
);
23665 if (string
&& STRINGP (lisp_string
))
23666 /* LISP_STRING is the one returned by decode_mode_spec. We should
23667 ignore its text properties. */
23668 it
->stop_charpos
= it
->end_charpos
;
23670 /* If displaying STRING, set up the face of the iterator from
23671 FACE_STRING, if that's given. */
23672 if (STRINGP (face_string
))
23678 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23679 0, &endptr
, it
->base_face_id
, false);
23680 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23681 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23684 /* Set max_x to the maximum allowed X position. Don't let it go
23685 beyond the right edge of the window. */
23687 max_x
= it
->last_visible_x
;
23689 max_x
= min (max_x
, it
->last_visible_x
);
23691 /* Skip over display elements that are not visible. because IT->w is
23693 if (it
->current_x
< it
->first_visible_x
)
23694 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23695 MOVE_TO_POS
| MOVE_TO_X
);
23697 row
->ascent
= it
->max_ascent
;
23698 row
->height
= it
->max_ascent
+ it
->max_descent
;
23699 row
->phys_ascent
= it
->max_phys_ascent
;
23700 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23701 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23703 if (STRINGP (it
->string
))
23704 it_charpos
= IT_STRING_CHARPOS (*it
);
23706 it_charpos
= IT_CHARPOS (*it
);
23708 /* This condition is for the case that we are called with current_x
23709 past last_visible_x. */
23710 while (it
->current_x
< max_x
)
23712 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23714 /* Get the next display element. */
23715 if (!get_next_display_element (it
))
23718 /* Produce glyphs. */
23719 x_before
= it
->current_x
;
23720 n_glyphs_before
= row
->used
[TEXT_AREA
];
23721 PRODUCE_GLYPHS (it
);
23723 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23726 while (i
< nglyphs
)
23728 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23730 if (it
->line_wrap
!= TRUNCATE
23731 && x
+ glyph
->pixel_width
> max_x
)
23733 /* End of continued line or max_x reached. */
23734 if (CHAR_GLYPH_PADDING_P (*glyph
))
23736 /* A wide character is unbreakable. */
23737 if (row
->reversed_p
)
23738 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23739 - n_glyphs_before
);
23740 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23741 it
->current_x
= x_before
;
23745 if (row
->reversed_p
)
23746 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23747 - (n_glyphs_before
+ i
));
23748 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23753 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23755 /* Glyph is at least partially visible. */
23757 if (x
< it
->first_visible_x
)
23758 row
->x
= x
- it
->first_visible_x
;
23762 /* Glyph is off the left margin of the display area.
23763 Should not happen. */
23767 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23768 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23769 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23770 row
->phys_height
= max (row
->phys_height
,
23771 it
->max_phys_ascent
+ it
->max_phys_descent
);
23772 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23773 it
->max_extra_line_spacing
);
23774 x
+= glyph
->pixel_width
;
23778 /* Stop if max_x reached. */
23782 /* Stop at line ends. */
23783 if (ITERATOR_AT_END_OF_LINE_P (it
))
23785 it
->continuation_lines_width
= 0;
23789 set_iterator_to_next (it
, true);
23790 if (STRINGP (it
->string
))
23791 it_charpos
= IT_STRING_CHARPOS (*it
);
23793 it_charpos
= IT_CHARPOS (*it
);
23795 /* Stop if truncating at the right edge. */
23796 if (it
->line_wrap
== TRUNCATE
23797 && it
->current_x
>= it
->last_visible_x
)
23799 /* Add truncation mark, but don't do it if the line is
23800 truncated at a padding space. */
23801 if (it_charpos
< it
->string_nchars
)
23803 if (!FRAME_WINDOW_P (it
->f
))
23807 if (it
->current_x
> it
->last_visible_x
)
23809 if (!row
->reversed_p
)
23811 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23812 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23817 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23818 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23820 unproduce_glyphs (it
, ii
+ 1);
23821 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23823 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23825 row
->used
[TEXT_AREA
] = ii
;
23826 produce_special_glyphs (it
, IT_TRUNCATION
);
23829 produce_special_glyphs (it
, IT_TRUNCATION
);
23831 row
->truncated_on_right_p
= true;
23837 /* Maybe insert a truncation at the left. */
23838 if (it
->first_visible_x
23841 if (!FRAME_WINDOW_P (it
->f
)
23842 || (row
->reversed_p
23843 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23844 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23845 insert_left_trunc_glyphs (it
);
23846 row
->truncated_on_left_p
= true;
23849 it
->face_id
= saved_face_id
;
23851 /* Value is number of columns displayed. */
23852 return it
->hpos
- hpos_at_start
;
23857 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23858 appears as an element of LIST or as the car of an element of LIST.
23859 If PROPVAL is a list, compare each element against LIST in that
23860 way, and return 1/2 if any element of PROPVAL is found in LIST.
23861 Otherwise return 0. This function cannot quit.
23862 The return value is 2 if the text is invisible but with an ellipsis
23863 and 1 if it's invisible and without an ellipsis. */
23866 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23868 Lisp_Object tail
, proptail
;
23870 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23872 register Lisp_Object tem
;
23874 if (EQ (propval
, tem
))
23876 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23877 return NILP (XCDR (tem
)) ? 1 : 2;
23880 if (CONSP (propval
))
23882 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23884 Lisp_Object propelt
;
23885 propelt
= XCAR (proptail
);
23886 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23888 register Lisp_Object tem
;
23890 if (EQ (propelt
, tem
))
23892 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23893 return NILP (XCDR (tem
)) ? 1 : 2;
23901 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23902 doc
: /* Non-nil if the property makes the text invisible.
23903 POS-OR-PROP can be a marker or number, in which case it is taken to be
23904 a position in the current buffer and the value of the `invisible' property
23905 is checked; or it can be some other value, which is then presumed to be the
23906 value of the `invisible' property of the text of interest.
23907 The non-nil value returned can be t for truly invisible text or something
23908 else if the text is replaced by an ellipsis. */)
23909 (Lisp_Object pos_or_prop
)
23912 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23913 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23915 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23916 return (invis
== 0 ? Qnil
23918 : make_number (invis
));
23921 /* Calculate a width or height in pixels from a specification using
23922 the following elements:
23925 NUM - a (fractional) multiple of the default font width/height
23926 (NUM) - specifies exactly NUM pixels
23927 UNIT - a fixed number of pixels, see below.
23928 ELEMENT - size of a display element in pixels, see below.
23929 (NUM . SPEC) - equals NUM * SPEC
23930 (+ SPEC SPEC ...) - add pixel values
23931 (- SPEC SPEC ...) - subtract pixel values
23932 (- SPEC) - negate pixel value
23935 INT or FLOAT - a number constant
23936 SYMBOL - use symbol's (buffer local) variable binding.
23939 in - pixels per inch *)
23940 mm - pixels per 1/1000 meter *)
23941 cm - pixels per 1/100 meter *)
23942 width - width of current font in pixels.
23943 height - height of current font in pixels.
23945 *) using the ratio(s) defined in display-pixels-per-inch.
23949 left-fringe - left fringe width in pixels
23950 right-fringe - right fringe width in pixels
23952 left-margin - left margin width in pixels
23953 right-margin - right margin width in pixels
23955 scroll-bar - scroll-bar area width in pixels
23959 Pixels corresponding to 5 inches:
23962 Total width of non-text areas on left side of window (if scroll-bar is on left):
23963 '(space :width (+ left-fringe left-margin scroll-bar))
23965 Align to first text column (in header line):
23966 '(space :align-to 0)
23968 Align to middle of text area minus half the width of variable `my-image'
23969 containing a loaded image:
23970 '(space :align-to (0.5 . (- text my-image)))
23972 Width of left margin minus width of 1 character in the default font:
23973 '(space :width (- left-margin 1))
23975 Width of left margin minus width of 2 characters in the current font:
23976 '(space :width (- left-margin (2 . width)))
23978 Center 1 character over left-margin (in header line):
23979 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23981 Different ways to express width of left fringe plus left margin minus one pixel:
23982 '(space :width (- (+ left-fringe left-margin) (1)))
23983 '(space :width (+ left-fringe left-margin (- (1))))
23984 '(space :width (+ left-fringe left-margin (-1)))
23989 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23990 struct font
*font
, bool width_p
, int *align_to
)
23994 # define OK_PIXELS(val) (*res = (val), true)
23995 # define OK_ALIGN_TO(val) (*align_to = (val), true)
23998 return OK_PIXELS (0);
24000 eassert (FRAME_LIVE_P (it
->f
));
24002 if (SYMBOLP (prop
))
24004 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24006 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24008 if (unit
[0] == 'i' && unit
[1] == 'n')
24010 else if (unit
[0] == 'm' && unit
[1] == 'm')
24012 else if (unit
[0] == 'c' && unit
[1] == 'm')
24018 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24019 : FRAME_RES_Y (it
->f
));
24022 return OK_PIXELS (ppi
/ pixels
);
24027 #ifdef HAVE_WINDOW_SYSTEM
24028 if (EQ (prop
, Qheight
))
24029 return OK_PIXELS (font
24030 ? normal_char_height (font
, -1)
24031 : FRAME_LINE_HEIGHT (it
->f
));
24032 if (EQ (prop
, Qwidth
))
24033 return OK_PIXELS (font
24034 ? FONT_WIDTH (font
)
24035 : FRAME_COLUMN_WIDTH (it
->f
));
24037 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24038 return OK_PIXELS (1);
24041 if (EQ (prop
, Qtext
))
24042 return OK_PIXELS (width_p
24043 ? window_box_width (it
->w
, TEXT_AREA
)
24044 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24046 if (align_to
&& *align_to
< 0)
24049 if (EQ (prop
, Qleft
))
24050 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24051 if (EQ (prop
, Qright
))
24052 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24053 if (EQ (prop
, Qcenter
))
24054 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24055 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24056 if (EQ (prop
, Qleft_fringe
))
24057 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24058 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24059 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24060 if (EQ (prop
, Qright_fringe
))
24061 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24062 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24063 : window_box_right_offset (it
->w
, TEXT_AREA
));
24064 if (EQ (prop
, Qleft_margin
))
24065 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24066 if (EQ (prop
, Qright_margin
))
24067 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24068 if (EQ (prop
, Qscroll_bar
))
24069 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24071 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24072 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24073 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24078 if (EQ (prop
, Qleft_fringe
))
24079 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24080 if (EQ (prop
, Qright_fringe
))
24081 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24082 if (EQ (prop
, Qleft_margin
))
24083 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24084 if (EQ (prop
, Qright_margin
))
24085 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24086 if (EQ (prop
, Qscroll_bar
))
24087 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24090 prop
= buffer_local_value (prop
, it
->w
->contents
);
24091 if (EQ (prop
, Qunbound
))
24095 if (NUMBERP (prop
))
24097 int base_unit
= (width_p
24098 ? FRAME_COLUMN_WIDTH (it
->f
)
24099 : FRAME_LINE_HEIGHT (it
->f
));
24100 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24105 Lisp_Object car
= XCAR (prop
);
24106 Lisp_Object cdr
= XCDR (prop
);
24110 #ifdef HAVE_WINDOW_SYSTEM
24111 if (FRAME_WINDOW_P (it
->f
)
24112 && valid_image_p (prop
))
24114 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24115 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24117 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24120 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24126 while (CONSP (cdr
))
24128 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24129 font
, width_p
, align_to
))
24132 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24137 if (EQ (car
, Qminus
))
24139 return OK_PIXELS (pixels
);
24142 car
= buffer_local_value (car
, it
->w
->contents
);
24143 if (EQ (car
, Qunbound
))
24150 pixels
= XFLOATINT (car
);
24152 return OK_PIXELS (pixels
);
24153 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24154 font
, width_p
, align_to
))
24155 return OK_PIXELS (pixels
* fact
);
24166 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24168 #ifdef HAVE_WINDOW_SYSTEM
24169 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24177 /***********************************************************************
24179 ***********************************************************************/
24181 #ifdef HAVE_WINDOW_SYSTEM
24186 dump_glyph_string (struct glyph_string
*s
)
24188 fprintf (stderr
, "glyph string\n");
24189 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24190 s
->x
, s
->y
, s
->width
, s
->height
);
24191 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24192 fprintf (stderr
, " hl = %d\n", s
->hl
);
24193 fprintf (stderr
, " left overhang = %d, right = %d\n",
24194 s
->left_overhang
, s
->right_overhang
);
24195 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24196 fprintf (stderr
, " extends to end of line = %d\n",
24197 s
->extends_to_end_of_line_p
);
24198 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24199 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24202 #endif /* GLYPH_DEBUG */
24204 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24205 of XChar2b structures for S; it can't be allocated in
24206 init_glyph_string because it must be allocated via `alloca'. W
24207 is the window on which S is drawn. ROW and AREA are the glyph row
24208 and area within the row from which S is constructed. START is the
24209 index of the first glyph structure covered by S. HL is a
24210 face-override for drawing S. */
24213 #define OPTIONAL_HDC(hdc) HDC hdc,
24214 #define DECLARE_HDC(hdc) HDC hdc;
24215 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24216 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24219 #ifndef OPTIONAL_HDC
24220 #define OPTIONAL_HDC(hdc)
24221 #define DECLARE_HDC(hdc)
24222 #define ALLOCATE_HDC(hdc, f)
24223 #define RELEASE_HDC(hdc, f)
24227 init_glyph_string (struct glyph_string
*s
,
24229 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24230 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24232 memset (s
, 0, sizeof *s
);
24234 s
->f
= XFRAME (w
->frame
);
24238 s
->display
= FRAME_X_DISPLAY (s
->f
);
24239 s
->window
= FRAME_X_WINDOW (s
->f
);
24240 s
->char2b
= char2b
;
24244 s
->first_glyph
= row
->glyphs
[area
] + start
;
24245 s
->height
= row
->height
;
24246 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24247 s
->ybase
= s
->y
+ row
->ascent
;
24251 /* Append the list of glyph strings with head H and tail T to the list
24252 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24255 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24256 struct glyph_string
*h
, struct glyph_string
*t
)
24270 /* Prepend the list of glyph strings with head H and tail T to the
24271 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24275 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24276 struct glyph_string
*h
, struct glyph_string
*t
)
24290 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24291 Set *HEAD and *TAIL to the resulting list. */
24294 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24295 struct glyph_string
*s
)
24297 s
->next
= s
->prev
= NULL
;
24298 append_glyph_string_lists (head
, tail
, s
, s
);
24302 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24303 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24304 make sure that X resources for the face returned are allocated.
24305 Value is a pointer to a realized face that is ready for display if
24308 static struct face
*
24309 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24310 XChar2b
*char2b
, bool display_p
)
24312 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24317 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24319 if (code
== FONT_INVALID_CODE
)
24322 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24324 /* Make sure X resources of the face are allocated. */
24325 #ifdef HAVE_X_WINDOWS
24329 eassert (face
!= NULL
);
24330 prepare_face_for_display (f
, face
);
24337 /* Get face and two-byte form of character glyph GLYPH on frame F.
24338 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24339 a pointer to a realized face that is ready for display. */
24341 static struct face
*
24342 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24348 eassert (glyph
->type
== CHAR_GLYPH
);
24349 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24351 /* Make sure X resources of the face are allocated. */
24352 eassert (face
!= NULL
);
24353 prepare_face_for_display (f
, face
);
24357 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24358 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24360 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24362 if (code
== FONT_INVALID_CODE
)
24366 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24371 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24372 Return true iff FONT has a glyph for C. */
24375 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24379 if (CHAR_BYTE8_P (c
))
24380 code
= CHAR_TO_BYTE8 (c
);
24382 code
= font
->driver
->encode_char (font
, c
);
24384 if (code
== FONT_INVALID_CODE
)
24386 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24391 /* Fill glyph string S with composition components specified by S->cmp.
24393 BASE_FACE is the base face of the composition.
24394 S->cmp_from is the index of the first component for S.
24396 OVERLAPS non-zero means S should draw the foreground only, and use
24397 its physical height for clipping. See also draw_glyphs.
24399 Value is the index of a component not in S. */
24402 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24406 /* For all glyphs of this composition, starting at the offset
24407 S->cmp_from, until we reach the end of the definition or encounter a
24408 glyph that requires the different face, add it to S. */
24413 s
->for_overlaps
= overlaps
;
24416 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24418 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24420 /* TAB in a composition means display glyphs with padding space
24421 on the left or right. */
24424 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24427 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24428 s
->char2b
+ i
, true);
24434 s
->font
= s
->face
->font
;
24436 else if (s
->face
!= face
)
24444 if (s
->face
== NULL
)
24446 s
->face
= base_face
->ascii_face
;
24447 s
->font
= s
->face
->font
;
24450 /* All glyph strings for the same composition has the same width,
24451 i.e. the width set for the first component of the composition. */
24452 s
->width
= s
->first_glyph
->pixel_width
;
24454 /* If the specified font could not be loaded, use the frame's
24455 default font, but record the fact that we couldn't load it in
24456 the glyph string so that we can draw rectangles for the
24457 characters of the glyph string. */
24458 if (s
->font
== NULL
)
24460 s
->font_not_found_p
= true;
24461 s
->font
= FRAME_FONT (s
->f
);
24464 /* Adjust base line for subscript/superscript text. */
24465 s
->ybase
+= s
->first_glyph
->voffset
;
24471 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24472 int start
, int end
, int overlaps
)
24474 struct glyph
*glyph
, *last
;
24475 Lisp_Object lgstring
;
24478 s
->for_overlaps
= overlaps
;
24479 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24480 last
= s
->row
->glyphs
[s
->area
] + end
;
24481 s
->cmp_id
= glyph
->u
.cmp
.id
;
24482 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24483 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24484 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24485 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24486 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24488 while (glyph
< last
24489 && glyph
->u
.cmp
.automatic
24490 && glyph
->u
.cmp
.id
== s
->cmp_id
24491 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24492 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24494 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24496 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24497 unsigned code
= LGLYPH_CODE (lglyph
);
24499 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24501 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24502 return glyph
- s
->row
->glyphs
[s
->area
];
24506 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24507 See the comment of fill_glyph_string for arguments.
24508 Value is the index of the first glyph not in S. */
24512 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24513 int start
, int end
, int overlaps
)
24515 struct glyph
*glyph
, *last
;
24518 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24519 s
->for_overlaps
= overlaps
;
24520 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24521 last
= s
->row
->glyphs
[s
->area
] + end
;
24522 voffset
= glyph
->voffset
;
24523 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24524 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24526 s
->width
= glyph
->pixel_width
;
24528 while (glyph
< last
24529 && glyph
->type
== GLYPHLESS_GLYPH
24530 && glyph
->voffset
== voffset
24531 && glyph
->face_id
== face_id
)
24534 s
->width
+= glyph
->pixel_width
;
24537 s
->ybase
+= voffset
;
24538 return glyph
- s
->row
->glyphs
[s
->area
];
24542 /* Fill glyph string S from a sequence of character glyphs.
24544 FACE_ID is the face id of the string. START is the index of the
24545 first glyph to consider, END is the index of the last + 1.
24546 OVERLAPS non-zero means S should draw the foreground only, and use
24547 its physical height for clipping. See also draw_glyphs.
24549 Value is the index of the first glyph not in S. */
24552 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24553 int start
, int end
, int overlaps
)
24555 struct glyph
*glyph
, *last
;
24557 bool glyph_not_available_p
;
24559 eassert (s
->f
== XFRAME (s
->w
->frame
));
24560 eassert (s
->nchars
== 0);
24561 eassert (start
>= 0 && end
> start
);
24563 s
->for_overlaps
= overlaps
;
24564 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24565 last
= s
->row
->glyphs
[s
->area
] + end
;
24566 voffset
= glyph
->voffset
;
24567 s
->padding_p
= glyph
->padding_p
;
24568 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24570 while (glyph
< last
24571 && glyph
->type
== CHAR_GLYPH
24572 && glyph
->voffset
== voffset
24573 /* Same face id implies same font, nowadays. */
24574 && glyph
->face_id
== face_id
24575 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24577 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24578 s
->char2b
+ s
->nchars
);
24580 eassert (s
->nchars
<= end
- start
);
24581 s
->width
+= glyph
->pixel_width
;
24582 if (glyph
++->padding_p
!= s
->padding_p
)
24586 s
->font
= s
->face
->font
;
24588 /* If the specified font could not be loaded, use the frame's font,
24589 but record the fact that we couldn't load it in
24590 S->font_not_found_p so that we can draw rectangles for the
24591 characters of the glyph string. */
24592 if (s
->font
== NULL
|| glyph_not_available_p
)
24594 s
->font_not_found_p
= true;
24595 s
->font
= FRAME_FONT (s
->f
);
24598 /* Adjust base line for subscript/superscript text. */
24599 s
->ybase
+= voffset
;
24601 eassert (s
->face
&& s
->face
->gc
);
24602 return glyph
- s
->row
->glyphs
[s
->area
];
24606 /* Fill glyph string S from image glyph S->first_glyph. */
24609 fill_image_glyph_string (struct glyph_string
*s
)
24611 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24612 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24614 s
->slice
= s
->first_glyph
->slice
.img
;
24615 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24616 s
->font
= s
->face
->font
;
24617 s
->width
= s
->first_glyph
->pixel_width
;
24619 /* Adjust base line for subscript/superscript text. */
24620 s
->ybase
+= s
->first_glyph
->voffset
;
24624 /* Fill glyph string S from a sequence of stretch glyphs.
24626 START is the index of the first glyph to consider,
24627 END is the index of the last + 1.
24629 Value is the index of the first glyph not in S. */
24632 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24634 struct glyph
*glyph
, *last
;
24635 int voffset
, face_id
;
24637 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24639 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24640 last
= s
->row
->glyphs
[s
->area
] + end
;
24641 face_id
= glyph
->face_id
;
24642 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24643 s
->font
= s
->face
->font
;
24644 s
->width
= glyph
->pixel_width
;
24646 voffset
= glyph
->voffset
;
24650 && glyph
->type
== STRETCH_GLYPH
24651 && glyph
->voffset
== voffset
24652 && glyph
->face_id
== face_id
);
24654 s
->width
+= glyph
->pixel_width
;
24656 /* Adjust base line for subscript/superscript text. */
24657 s
->ybase
+= voffset
;
24659 /* The case that face->gc == 0 is handled when drawing the glyph
24660 string by calling prepare_face_for_display. */
24662 return glyph
- s
->row
->glyphs
[s
->area
];
24665 static struct font_metrics
*
24666 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24668 static struct font_metrics metrics
;
24673 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24674 if (code
== FONT_INVALID_CODE
)
24676 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24680 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24681 for FONT. Values are taken from font-global ones, except for fonts
24682 that claim preposterously large values, but whose glyphs actually
24683 have reasonable dimensions. C is the character to use for metrics
24684 if the font-global values are too large; if C is negative, the
24685 function selects a default character. */
24687 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24689 *ascent
= FONT_BASE (font
);
24690 *descent
= FONT_DESCENT (font
);
24692 if (FONT_TOO_HIGH (font
))
24696 /* Get metrics of C, defaulting to a reasonably sized ASCII
24698 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24700 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24702 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24704 /* We add 1 pixel to character dimensions as heuristics
24705 that produces nicer display, e.g. when the face has
24706 the box attribute. */
24707 *ascent
= pcm
->ascent
+ 1;
24708 *descent
= pcm
->descent
+ 1;
24714 /* A subroutine that computes a reasonable "normal character height"
24715 for fonts that claim preposterously large vertical dimensions, but
24716 whose glyphs are actually reasonably sized. C is the character
24717 whose metrics to use for those fonts, or -1 for default
24720 normal_char_height (struct font
*font
, int c
)
24722 int ascent
, descent
;
24724 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24726 return ascent
+ descent
;
24730 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24731 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24732 assumed to be zero. */
24735 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24737 *left
= *right
= 0;
24739 if (glyph
->type
== CHAR_GLYPH
)
24742 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24745 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24748 if (pcm
->rbearing
> pcm
->width
)
24749 *right
= pcm
->rbearing
- pcm
->width
;
24750 if (pcm
->lbearing
< 0)
24751 *left
= -pcm
->lbearing
;
24755 else if (glyph
->type
== COMPOSITE_GLYPH
)
24757 if (! glyph
->u
.cmp
.automatic
)
24759 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24761 if (cmp
->rbearing
> cmp
->pixel_width
)
24762 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24763 if (cmp
->lbearing
< 0)
24764 *left
= - cmp
->lbearing
;
24768 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24769 struct font_metrics metrics
;
24771 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24772 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24773 if (metrics
.rbearing
> metrics
.width
)
24774 *right
= metrics
.rbearing
- metrics
.width
;
24775 if (metrics
.lbearing
< 0)
24776 *left
= - metrics
.lbearing
;
24782 /* Return the index of the first glyph preceding glyph string S that
24783 is overwritten by S because of S's left overhang. Value is -1
24784 if no glyphs are overwritten. */
24787 left_overwritten (struct glyph_string
*s
)
24791 if (s
->left_overhang
)
24794 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24795 int first
= s
->first_glyph
- glyphs
;
24797 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24798 x
-= glyphs
[i
].pixel_width
;
24809 /* Return the index of the first glyph preceding glyph string S that
24810 is overwriting S because of its right overhang. Value is -1 if no
24811 glyph in front of S overwrites S. */
24814 left_overwriting (struct glyph_string
*s
)
24817 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24818 int first
= s
->first_glyph
- glyphs
;
24822 for (i
= first
- 1; i
>= 0; --i
)
24825 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24828 x
-= glyphs
[i
].pixel_width
;
24835 /* Return the index of the last glyph following glyph string S that is
24836 overwritten by S because of S's right overhang. Value is -1 if
24837 no such glyph is found. */
24840 right_overwritten (struct glyph_string
*s
)
24844 if (s
->right_overhang
)
24847 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24848 int first
= (s
->first_glyph
- glyphs
24849 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24850 int end
= s
->row
->used
[s
->area
];
24852 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24853 x
+= glyphs
[i
].pixel_width
;
24862 /* Return the index of the last glyph following glyph string S that
24863 overwrites S because of its left overhang. Value is negative
24864 if no such glyph is found. */
24867 right_overwriting (struct glyph_string
*s
)
24870 int end
= s
->row
->used
[s
->area
];
24871 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24872 int first
= (s
->first_glyph
- glyphs
24873 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24877 for (i
= first
; i
< end
; ++i
)
24880 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24883 x
+= glyphs
[i
].pixel_width
;
24890 /* Set background width of glyph string S. START is the index of the
24891 first glyph following S. LAST_X is the right-most x-position + 1
24892 in the drawing area. */
24895 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24897 /* If the face of this glyph string has to be drawn to the end of
24898 the drawing area, set S->extends_to_end_of_line_p. */
24900 if (start
== s
->row
->used
[s
->area
]
24901 && ((s
->row
->fill_line_p
24902 && (s
->hl
== DRAW_NORMAL_TEXT
24903 || s
->hl
== DRAW_IMAGE_RAISED
24904 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24905 || s
->hl
== DRAW_MOUSE_FACE
))
24906 s
->extends_to_end_of_line_p
= true;
24908 /* If S extends its face to the end of the line, set its
24909 background_width to the distance to the right edge of the drawing
24911 if (s
->extends_to_end_of_line_p
)
24912 s
->background_width
= last_x
- s
->x
+ 1;
24914 s
->background_width
= s
->width
;
24918 /* Compute overhangs and x-positions for glyph string S and its
24919 predecessors, or successors. X is the starting x-position for S.
24920 BACKWARD_P means process predecessors. */
24923 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24929 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24930 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24940 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24941 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24951 /* The following macros are only called from draw_glyphs below.
24952 They reference the following parameters of that function directly:
24953 `w', `row', `area', and `overlap_p'
24954 as well as the following local variables:
24955 `s', `f', and `hdc' (in W32) */
24958 /* On W32, silently add local `hdc' variable to argument list of
24959 init_glyph_string. */
24960 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24961 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24963 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24964 init_glyph_string (s, char2b, w, row, area, start, hl)
24967 /* Add a glyph string for a stretch glyph to the list of strings
24968 between HEAD and TAIL. START is the index of the stretch glyph in
24969 row area AREA of glyph row ROW. END is the index of the last glyph
24970 in that glyph row area. X is the current output position assigned
24971 to the new glyph string constructed. HL overrides that face of the
24972 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24973 is the right-most x-position of the drawing area. */
24975 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24976 and below -- keep them on one line. */
24977 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24980 s = alloca (sizeof *s); \
24981 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24982 START = fill_stretch_glyph_string (s, START, END); \
24983 append_glyph_string (&HEAD, &TAIL, s); \
24989 /* Add a glyph string for an image glyph to the list of strings
24990 between HEAD and TAIL. START is the index of the image glyph in
24991 row area AREA of glyph row ROW. END is the index of the last glyph
24992 in that glyph row area. X is the current output position assigned
24993 to the new glyph string constructed. HL overrides that face of the
24994 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24995 is the right-most x-position of the drawing area. */
24997 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25000 s = alloca (sizeof *s); \
25001 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25002 fill_image_glyph_string (s); \
25003 append_glyph_string (&HEAD, &TAIL, s); \
25010 /* Add a glyph string for a sequence of character glyphs to the list
25011 of strings between HEAD and TAIL. START is the index of the first
25012 glyph in row area AREA of glyph row ROW that is part of the new
25013 glyph string. END is the index of the last glyph in that glyph row
25014 area. X is the current output position assigned to the new glyph
25015 string constructed. HL overrides that face of the glyph; e.g. it
25016 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25017 right-most x-position of the drawing area. */
25019 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25025 face_id = (row)->glyphs[area][START].face_id; \
25027 s = alloca (sizeof *s); \
25028 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25029 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25030 append_glyph_string (&HEAD, &TAIL, s); \
25032 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25037 /* Add a glyph string for a composite sequence to the list of strings
25038 between HEAD and TAIL. START is the index of the first glyph in
25039 row area AREA of glyph row ROW that is part of the new glyph
25040 string. END is the index of the last glyph in that glyph row area.
25041 X is the current output position assigned to the new glyph string
25042 constructed. HL overrides that face of the glyph; e.g. it is
25043 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25044 x-position of the drawing area. */
25046 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25048 int face_id = (row)->glyphs[area][START].face_id; \
25049 struct face *base_face = FACE_FROM_ID (f, face_id); \
25050 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25051 struct composition *cmp = composition_table[cmp_id]; \
25053 struct glyph_string *first_s = NULL; \
25056 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25058 /* Make glyph_strings for each glyph sequence that is drawable by \
25059 the same face, and append them to HEAD/TAIL. */ \
25060 for (n = 0; n < cmp->glyph_len;) \
25062 s = alloca (sizeof *s); \
25063 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25064 append_glyph_string (&(HEAD), &(TAIL), s); \
25070 n = fill_composite_glyph_string (s, base_face, overlaps); \
25078 /* Add a glyph string for a glyph-string sequence to the list of strings
25079 between HEAD and TAIL. */
25081 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25085 Lisp_Object gstring; \
25087 face_id = (row)->glyphs[area][START].face_id; \
25088 gstring = (composition_gstring_from_id \
25089 ((row)->glyphs[area][START].u.cmp.id)); \
25090 s = alloca (sizeof *s); \
25091 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25092 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25093 append_glyph_string (&(HEAD), &(TAIL), s); \
25095 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25099 /* Add a glyph string for a sequence of glyphless character's glyphs
25100 to the list of strings between HEAD and TAIL. The meanings of
25101 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25103 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25108 face_id = (row)->glyphs[area][START].face_id; \
25110 s = alloca (sizeof *s); \
25111 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25112 append_glyph_string (&HEAD, &TAIL, s); \
25114 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25120 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25121 of AREA of glyph row ROW on window W between indices START and END.
25122 HL overrides the face for drawing glyph strings, e.g. it is
25123 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25124 x-positions of the drawing area.
25126 This is an ugly monster macro construct because we must use alloca
25127 to allocate glyph strings (because draw_glyphs can be called
25128 asynchronously). */
25130 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25133 HEAD = TAIL = NULL; \
25134 while (START < END) \
25136 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25137 switch (first_glyph->type) \
25140 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25144 case COMPOSITE_GLYPH: \
25145 if (first_glyph->u.cmp.automatic) \
25146 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25149 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25153 case STRETCH_GLYPH: \
25154 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25158 case IMAGE_GLYPH: \
25159 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25163 case GLYPHLESS_GLYPH: \
25164 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25174 set_glyph_string_background_width (s, START, LAST_X); \
25181 /* Draw glyphs between START and END in AREA of ROW on window W,
25182 starting at x-position X. X is relative to AREA in W. HL is a
25183 face-override with the following meaning:
25185 DRAW_NORMAL_TEXT draw normally
25186 DRAW_CURSOR draw in cursor face
25187 DRAW_MOUSE_FACE draw in mouse face.
25188 DRAW_INVERSE_VIDEO draw in mode line face
25189 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25190 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25192 If OVERLAPS is non-zero, draw only the foreground of characters and
25193 clip to the physical height of ROW. Non-zero value also defines
25194 the overlapping part to be drawn:
25196 OVERLAPS_PRED overlap with preceding rows
25197 OVERLAPS_SUCC overlap with succeeding rows
25198 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25199 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25201 Value is the x-position reached, relative to AREA of W. */
25204 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25205 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25206 enum draw_glyphs_face hl
, int overlaps
)
25208 struct glyph_string
*head
, *tail
;
25209 struct glyph_string
*s
;
25210 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25211 int i
, j
, x_reached
, last_x
, area_left
= 0;
25212 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25215 ALLOCATE_HDC (hdc
, f
);
25217 /* Let's rather be paranoid than getting a SEGV. */
25218 end
= min (end
, row
->used
[area
]);
25219 start
= clip_to_bounds (0, start
, end
);
25221 /* Translate X to frame coordinates. Set last_x to the right
25222 end of the drawing area. */
25223 if (row
->full_width_p
)
25225 /* X is relative to the left edge of W, without scroll bars
25227 area_left
= WINDOW_LEFT_EDGE_X (w
);
25228 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25229 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25233 area_left
= window_box_left (w
, area
);
25234 last_x
= area_left
+ window_box_width (w
, area
);
25238 /* Build a doubly-linked list of glyph_string structures between
25239 head and tail from what we have to draw. Note that the macro
25240 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25241 the reason we use a separate variable `i'. */
25244 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25246 x_reached
= tail
->x
+ tail
->background_width
;
25250 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25251 the row, redraw some glyphs in front or following the glyph
25252 strings built above. */
25253 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25255 struct glyph_string
*h
, *t
;
25256 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25257 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25258 bool check_mouse_face
= false;
25261 /* If mouse highlighting is on, we may need to draw adjacent
25262 glyphs using mouse-face highlighting. */
25263 if (area
== TEXT_AREA
&& row
->mouse_face_p
25264 && hlinfo
->mouse_face_beg_row
>= 0
25265 && hlinfo
->mouse_face_end_row
>= 0)
25267 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25269 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25270 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25272 check_mouse_face
= true;
25273 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25274 ? hlinfo
->mouse_face_beg_col
: 0;
25275 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25276 ? hlinfo
->mouse_face_end_col
25277 : row
->used
[TEXT_AREA
];
25281 /* Compute overhangs for all glyph strings. */
25282 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25283 for (s
= head
; s
; s
= s
->next
)
25284 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25286 /* Prepend glyph strings for glyphs in front of the first glyph
25287 string that are overwritten because of the first glyph
25288 string's left overhang. The background of all strings
25289 prepended must be drawn because the first glyph string
25291 i
= left_overwritten (head
);
25294 enum draw_glyphs_face overlap_hl
;
25296 /* If this row contains mouse highlighting, attempt to draw
25297 the overlapped glyphs with the correct highlight. This
25298 code fails if the overlap encompasses more than one glyph
25299 and mouse-highlight spans only some of these glyphs.
25300 However, making it work perfectly involves a lot more
25301 code, and I don't know if the pathological case occurs in
25302 practice, so we'll stick to this for now. --- cyd */
25303 if (check_mouse_face
25304 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25305 overlap_hl
= DRAW_MOUSE_FACE
;
25307 overlap_hl
= DRAW_NORMAL_TEXT
;
25309 if (hl
!= overlap_hl
)
25312 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25313 overlap_hl
, dummy_x
, last_x
);
25315 compute_overhangs_and_x (t
, head
->x
, true);
25316 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25317 if (clip_head
== NULL
)
25321 /* Prepend glyph strings for glyphs in front of the first glyph
25322 string that overwrite that glyph string because of their
25323 right overhang. For these strings, only the foreground must
25324 be drawn, because it draws over the glyph string at `head'.
25325 The background must not be drawn because this would overwrite
25326 right overhangs of preceding glyphs for which no glyph
25328 i
= left_overwriting (head
);
25331 enum draw_glyphs_face overlap_hl
;
25333 if (check_mouse_face
25334 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25335 overlap_hl
= DRAW_MOUSE_FACE
;
25337 overlap_hl
= DRAW_NORMAL_TEXT
;
25339 if (hl
== overlap_hl
|| clip_head
== NULL
)
25341 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25342 overlap_hl
, dummy_x
, last_x
);
25343 for (s
= h
; s
; s
= s
->next
)
25344 s
->background_filled_p
= true;
25345 compute_overhangs_and_x (t
, head
->x
, true);
25346 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25349 /* Append glyphs strings for glyphs following the last glyph
25350 string tail that are overwritten by tail. The background of
25351 these strings has to be drawn because tail's foreground draws
25353 i
= right_overwritten (tail
);
25356 enum draw_glyphs_face overlap_hl
;
25358 if (check_mouse_face
25359 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25360 overlap_hl
= DRAW_MOUSE_FACE
;
25362 overlap_hl
= DRAW_NORMAL_TEXT
;
25364 if (hl
!= overlap_hl
)
25366 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25367 overlap_hl
, x
, last_x
);
25368 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25369 we don't have `end = i;' here. */
25370 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25371 append_glyph_string_lists (&head
, &tail
, h
, t
);
25372 if (clip_tail
== NULL
)
25376 /* Append glyph strings for glyphs following the last glyph
25377 string tail that overwrite tail. The foreground of such
25378 glyphs has to be drawn because it writes into the background
25379 of tail. The background must not be drawn because it could
25380 paint over the foreground of following glyphs. */
25381 i
= right_overwriting (tail
);
25384 enum draw_glyphs_face overlap_hl
;
25385 if (check_mouse_face
25386 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25387 overlap_hl
= DRAW_MOUSE_FACE
;
25389 overlap_hl
= DRAW_NORMAL_TEXT
;
25391 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25393 i
++; /* We must include the Ith glyph. */
25394 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25395 overlap_hl
, x
, last_x
);
25396 for (s
= h
; s
; s
= s
->next
)
25397 s
->background_filled_p
= true;
25398 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25399 append_glyph_string_lists (&head
, &tail
, h
, t
);
25401 if (clip_head
|| clip_tail
)
25402 for (s
= head
; s
; s
= s
->next
)
25404 s
->clip_head
= clip_head
;
25405 s
->clip_tail
= clip_tail
;
25409 /* Draw all strings. */
25410 for (s
= head
; s
; s
= s
->next
)
25411 FRAME_RIF (f
)->draw_glyph_string (s
);
25414 /* When focus a sole frame and move horizontally, this clears on_p
25415 causing a failure to erase prev cursor position. */
25416 if (area
== TEXT_AREA
25417 && !row
->full_width_p
25418 /* When drawing overlapping rows, only the glyph strings'
25419 foreground is drawn, which doesn't erase a cursor
25423 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25424 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25425 : (tail
? tail
->x
+ tail
->background_width
: x
));
25429 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25430 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25434 /* Value is the x-position up to which drawn, relative to AREA of W.
25435 This doesn't include parts drawn because of overhangs. */
25436 if (row
->full_width_p
)
25437 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25439 x_reached
-= area_left
;
25441 RELEASE_HDC (hdc
, f
);
25447 /* Expand row matrix if too narrow. Don't expand if area
25450 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25452 if (!it->f->fonts_changed \
25453 && (it->glyph_row->glyphs[area] \
25454 < it->glyph_row->glyphs[area + 1])) \
25456 it->w->ncols_scale_factor++; \
25457 it->f->fonts_changed = true; \
25461 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25462 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25465 append_glyph (struct it
*it
)
25467 struct glyph
*glyph
;
25468 enum glyph_row_area area
= it
->area
;
25470 eassert (it
->glyph_row
);
25471 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25473 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25474 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25476 /* If the glyph row is reversed, we need to prepend the glyph
25477 rather than append it. */
25478 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25482 /* Make room for the additional glyph. */
25483 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25485 glyph
= it
->glyph_row
->glyphs
[area
];
25487 glyph
->charpos
= CHARPOS (it
->position
);
25488 glyph
->object
= it
->object
;
25489 if (it
->pixel_width
> 0)
25491 glyph
->pixel_width
= it
->pixel_width
;
25492 glyph
->padding_p
= false;
25496 /* Assure at least 1-pixel width. Otherwise, cursor can't
25497 be displayed correctly. */
25498 glyph
->pixel_width
= 1;
25499 glyph
->padding_p
= true;
25501 glyph
->ascent
= it
->ascent
;
25502 glyph
->descent
= it
->descent
;
25503 glyph
->voffset
= it
->voffset
;
25504 glyph
->type
= CHAR_GLYPH
;
25505 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25506 glyph
->multibyte_p
= it
->multibyte_p
;
25507 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25509 /* In R2L rows, the left and the right box edges need to be
25510 drawn in reverse direction. */
25511 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25512 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25516 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25517 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25519 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25520 || it
->phys_descent
> it
->descent
);
25521 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25522 glyph
->face_id
= it
->face_id
;
25523 glyph
->u
.ch
= it
->char_to_display
;
25524 glyph
->slice
.img
= null_glyph_slice
;
25525 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25528 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25529 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25530 glyph
->bidi_type
= it
->bidi_it
.type
;
25534 glyph
->resolved_level
= 0;
25535 glyph
->bidi_type
= UNKNOWN_BT
;
25537 ++it
->glyph_row
->used
[area
];
25540 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25543 /* Store one glyph for the composition IT->cmp_it.id in
25544 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25548 append_composite_glyph (struct it
*it
)
25550 struct glyph
*glyph
;
25551 enum glyph_row_area area
= it
->area
;
25553 eassert (it
->glyph_row
);
25555 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25556 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25558 /* If the glyph row is reversed, we need to prepend the glyph
25559 rather than append it. */
25560 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25564 /* Make room for the new glyph. */
25565 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25567 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25569 glyph
->charpos
= it
->cmp_it
.charpos
;
25570 glyph
->object
= it
->object
;
25571 glyph
->pixel_width
= it
->pixel_width
;
25572 glyph
->ascent
= it
->ascent
;
25573 glyph
->descent
= it
->descent
;
25574 glyph
->voffset
= it
->voffset
;
25575 glyph
->type
= COMPOSITE_GLYPH
;
25576 if (it
->cmp_it
.ch
< 0)
25578 glyph
->u
.cmp
.automatic
= false;
25579 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25580 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25584 glyph
->u
.cmp
.automatic
= true;
25585 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25586 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25587 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25589 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25590 glyph
->multibyte_p
= it
->multibyte_p
;
25591 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25593 /* In R2L rows, the left and the right box edges need to be
25594 drawn in reverse direction. */
25595 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25596 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25600 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25601 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25603 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25604 || it
->phys_descent
> it
->descent
);
25605 glyph
->padding_p
= false;
25606 glyph
->glyph_not_available_p
= false;
25607 glyph
->face_id
= it
->face_id
;
25608 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25611 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25612 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25613 glyph
->bidi_type
= it
->bidi_it
.type
;
25615 ++it
->glyph_row
->used
[area
];
25618 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25622 /* Change IT->ascent and IT->height according to the setting of
25626 take_vertical_position_into_account (struct it
*it
)
25630 if (it
->voffset
< 0)
25631 /* Increase the ascent so that we can display the text higher
25633 it
->ascent
-= it
->voffset
;
25635 /* Increase the descent so that we can display the text lower
25637 it
->descent
+= it
->voffset
;
25642 /* Produce glyphs/get display metrics for the image IT is loaded with.
25643 See the description of struct display_iterator in dispextern.h for
25644 an overview of struct display_iterator. */
25647 produce_image_glyph (struct it
*it
)
25651 int glyph_ascent
, crop
;
25652 struct glyph_slice slice
;
25654 eassert (it
->what
== IT_IMAGE
);
25656 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25658 /* Make sure X resources of the face is loaded. */
25659 prepare_face_for_display (it
->f
, face
);
25661 if (it
->image_id
< 0)
25663 /* Fringe bitmap. */
25664 it
->ascent
= it
->phys_ascent
= 0;
25665 it
->descent
= it
->phys_descent
= 0;
25666 it
->pixel_width
= 0;
25671 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25673 /* Make sure X resources of the image is loaded. */
25674 prepare_image_for_display (it
->f
, img
);
25676 slice
.x
= slice
.y
= 0;
25677 slice
.width
= img
->width
;
25678 slice
.height
= img
->height
;
25680 if (INTEGERP (it
->slice
.x
))
25681 slice
.x
= XINT (it
->slice
.x
);
25682 else if (FLOATP (it
->slice
.x
))
25683 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25685 if (INTEGERP (it
->slice
.y
))
25686 slice
.y
= XINT (it
->slice
.y
);
25687 else if (FLOATP (it
->slice
.y
))
25688 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25690 if (INTEGERP (it
->slice
.width
))
25691 slice
.width
= XINT (it
->slice
.width
);
25692 else if (FLOATP (it
->slice
.width
))
25693 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25695 if (INTEGERP (it
->slice
.height
))
25696 slice
.height
= XINT (it
->slice
.height
);
25697 else if (FLOATP (it
->slice
.height
))
25698 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25700 if (slice
.x
>= img
->width
)
25701 slice
.x
= img
->width
;
25702 if (slice
.y
>= img
->height
)
25703 slice
.y
= img
->height
;
25704 if (slice
.x
+ slice
.width
>= img
->width
)
25705 slice
.width
= img
->width
- slice
.x
;
25706 if (slice
.y
+ slice
.height
> img
->height
)
25707 slice
.height
= img
->height
- slice
.y
;
25709 if (slice
.width
== 0 || slice
.height
== 0)
25712 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25714 it
->descent
= slice
.height
- glyph_ascent
;
25716 it
->descent
+= img
->vmargin
;
25717 if (slice
.y
+ slice
.height
== img
->height
)
25718 it
->descent
+= img
->vmargin
;
25719 it
->phys_descent
= it
->descent
;
25721 it
->pixel_width
= slice
.width
;
25723 it
->pixel_width
+= img
->hmargin
;
25724 if (slice
.x
+ slice
.width
== img
->width
)
25725 it
->pixel_width
+= img
->hmargin
;
25727 /* It's quite possible for images to have an ascent greater than
25728 their height, so don't get confused in that case. */
25729 if (it
->descent
< 0)
25734 if (face
->box
!= FACE_NO_BOX
)
25736 if (face
->box_line_width
> 0)
25739 it
->ascent
+= face
->box_line_width
;
25740 if (slice
.y
+ slice
.height
== img
->height
)
25741 it
->descent
+= face
->box_line_width
;
25744 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25745 it
->pixel_width
+= eabs (face
->box_line_width
);
25746 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25747 it
->pixel_width
+= eabs (face
->box_line_width
);
25750 take_vertical_position_into_account (it
);
25752 /* Automatically crop wide image glyphs at right edge so we can
25753 draw the cursor on same display row. */
25754 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25755 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25757 it
->pixel_width
-= crop
;
25758 slice
.width
-= crop
;
25763 struct glyph
*glyph
;
25764 enum glyph_row_area area
= it
->area
;
25766 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25767 if (it
->glyph_row
->reversed_p
)
25771 /* Make room for the new glyph. */
25772 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25774 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25776 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25778 glyph
->charpos
= CHARPOS (it
->position
);
25779 glyph
->object
= it
->object
;
25780 glyph
->pixel_width
= it
->pixel_width
;
25781 glyph
->ascent
= glyph_ascent
;
25782 glyph
->descent
= it
->descent
;
25783 glyph
->voffset
= it
->voffset
;
25784 glyph
->type
= IMAGE_GLYPH
;
25785 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25786 glyph
->multibyte_p
= it
->multibyte_p
;
25787 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25789 /* In R2L rows, the left and the right box edges need to be
25790 drawn in reverse direction. */
25791 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25792 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25796 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25797 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25799 glyph
->overlaps_vertically_p
= false;
25800 glyph
->padding_p
= false;
25801 glyph
->glyph_not_available_p
= false;
25802 glyph
->face_id
= it
->face_id
;
25803 glyph
->u
.img_id
= img
->id
;
25804 glyph
->slice
.img
= slice
;
25805 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25808 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25809 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25810 glyph
->bidi_type
= it
->bidi_it
.type
;
25812 ++it
->glyph_row
->used
[area
];
25815 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25820 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25821 of the glyph, WIDTH and HEIGHT are the width and height of the
25822 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25825 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25826 int width
, int height
, int ascent
)
25828 struct glyph
*glyph
;
25829 enum glyph_row_area area
= it
->area
;
25831 eassert (ascent
>= 0 && ascent
<= height
);
25833 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25834 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25836 /* If the glyph row is reversed, we need to prepend the glyph
25837 rather than append it. */
25838 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25842 /* Make room for the additional glyph. */
25843 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25845 glyph
= it
->glyph_row
->glyphs
[area
];
25847 /* Decrease the width of the first glyph of the row that
25848 begins before first_visible_x (e.g., due to hscroll).
25849 This is so the overall width of the row becomes smaller
25850 by the scroll amount, and the stretch glyph appended by
25851 extend_face_to_end_of_line will be wider, to shift the
25852 row glyphs to the right. (In L2R rows, the corresponding
25853 left-shift effect is accomplished by setting row->x to a
25854 negative value, which won't work with R2L rows.)
25856 This must leave us with a positive value of WIDTH, since
25857 otherwise the call to move_it_in_display_line_to at the
25858 beginning of display_line would have got past the entire
25859 first glyph, and then it->current_x would have been
25860 greater or equal to it->first_visible_x. */
25861 if (it
->current_x
< it
->first_visible_x
)
25862 width
-= it
->first_visible_x
- it
->current_x
;
25863 eassert (width
> 0);
25865 glyph
->charpos
= CHARPOS (it
->position
);
25866 glyph
->object
= object
;
25867 glyph
->pixel_width
= width
;
25868 glyph
->ascent
= ascent
;
25869 glyph
->descent
= height
- ascent
;
25870 glyph
->voffset
= it
->voffset
;
25871 glyph
->type
= STRETCH_GLYPH
;
25872 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25873 glyph
->multibyte_p
= it
->multibyte_p
;
25874 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25876 /* In R2L rows, the left and the right box edges need to be
25877 drawn in reverse direction. */
25878 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25879 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25883 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25884 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25886 glyph
->overlaps_vertically_p
= false;
25887 glyph
->padding_p
= false;
25888 glyph
->glyph_not_available_p
= false;
25889 glyph
->face_id
= it
->face_id
;
25890 glyph
->u
.stretch
.ascent
= ascent
;
25891 glyph
->u
.stretch
.height
= height
;
25892 glyph
->slice
.img
= null_glyph_slice
;
25893 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25896 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25897 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25898 glyph
->bidi_type
= it
->bidi_it
.type
;
25902 glyph
->resolved_level
= 0;
25903 glyph
->bidi_type
= UNKNOWN_BT
;
25905 ++it
->glyph_row
->used
[area
];
25908 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25911 #endif /* HAVE_WINDOW_SYSTEM */
25913 /* Produce a stretch glyph for iterator IT. IT->object is the value
25914 of the glyph property displayed. The value must be a list
25915 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25918 1. `:width WIDTH' specifies that the space should be WIDTH *
25919 canonical char width wide. WIDTH may be an integer or floating
25922 2. `:relative-width FACTOR' specifies that the width of the stretch
25923 should be computed from the width of the first character having the
25924 `glyph' property, and should be FACTOR times that width.
25926 3. `:align-to HPOS' specifies that the space should be wide enough
25927 to reach HPOS, a value in canonical character units.
25929 Exactly one of the above pairs must be present.
25931 4. `:height HEIGHT' specifies that the height of the stretch produced
25932 should be HEIGHT, measured in canonical character units.
25934 5. `:relative-height FACTOR' specifies that the height of the
25935 stretch should be FACTOR times the height of the characters having
25936 the glyph property.
25938 Either none or exactly one of 4 or 5 must be present.
25940 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25941 of the stretch should be used for the ascent of the stretch.
25942 ASCENT must be in the range 0 <= ASCENT <= 100. */
25945 produce_stretch_glyph (struct it
*it
)
25947 /* (space :width WIDTH :height HEIGHT ...) */
25948 Lisp_Object prop
, plist
;
25949 int width
= 0, height
= 0, align_to
= -1;
25950 bool zero_width_ok_p
= false;
25952 struct font
*font
= NULL
;
25954 #ifdef HAVE_WINDOW_SYSTEM
25956 bool zero_height_ok_p
= false;
25958 if (FRAME_WINDOW_P (it
->f
))
25960 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25961 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25962 prepare_face_for_display (it
->f
, face
);
25966 /* List should start with `space'. */
25967 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25968 plist
= XCDR (it
->object
);
25970 /* Compute the width of the stretch. */
25971 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25972 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
25974 /* Absolute width `:width WIDTH' specified and valid. */
25975 zero_width_ok_p
= true;
25978 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
25980 /* Relative width `:relative-width FACTOR' specified and valid.
25981 Compute the width of the characters having the `glyph'
25984 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25987 if (it
->multibyte_p
)
25988 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25991 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25992 if (! ASCII_CHAR_P (it2
.c
))
25993 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25996 it2
.glyph_row
= NULL
;
25997 it2
.what
= IT_CHARACTER
;
25998 PRODUCE_GLYPHS (&it2
);
25999 width
= NUMVAL (prop
) * it2
.pixel_width
;
26001 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26002 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26005 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26006 align_to
= (align_to
< 0
26008 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26009 else if (align_to
< 0)
26010 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26011 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26012 zero_width_ok_p
= true;
26015 /* Nothing specified -> width defaults to canonical char width. */
26016 width
= FRAME_COLUMN_WIDTH (it
->f
);
26018 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26021 #ifdef HAVE_WINDOW_SYSTEM
26022 /* Compute height. */
26023 if (FRAME_WINDOW_P (it
->f
))
26025 int default_height
= normal_char_height (font
, ' ');
26027 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26028 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26031 zero_height_ok_p
= true;
26033 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26035 height
= default_height
* NUMVAL (prop
);
26037 height
= default_height
;
26039 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26042 /* Compute percentage of height used for ascent. If
26043 `:ascent ASCENT' is present and valid, use that. Otherwise,
26044 derive the ascent from the font in use. */
26045 if (prop
= Fplist_get (plist
, QCascent
),
26046 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26047 ascent
= height
* NUMVAL (prop
) / 100.0;
26048 else if (!NILP (prop
)
26049 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26050 ascent
= min (max (0, (int)tem
), height
);
26052 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26055 #endif /* HAVE_WINDOW_SYSTEM */
26058 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26059 && it
->current_x
+ width
> it
->last_visible_x
)
26061 width
= it
->last_visible_x
- it
->current_x
;
26062 #ifdef HAVE_WINDOW_SYSTEM
26063 /* Subtract one more pixel from the stretch width, but only on
26064 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26065 width
-= FRAME_WINDOW_P (it
->f
);
26069 if (width
> 0 && height
> 0 && it
->glyph_row
)
26071 Lisp_Object o_object
= it
->object
;
26072 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26075 if (!STRINGP (object
))
26076 object
= it
->w
->contents
;
26077 #ifdef HAVE_WINDOW_SYSTEM
26078 if (FRAME_WINDOW_P (it
->f
))
26079 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26083 it
->object
= object
;
26084 it
->char_to_display
= ' ';
26085 it
->pixel_width
= it
->len
= 1;
26087 tty_append_glyph (it
);
26088 it
->object
= o_object
;
26092 it
->pixel_width
= width
;
26093 #ifdef HAVE_WINDOW_SYSTEM
26094 if (FRAME_WINDOW_P (it
->f
))
26096 it
->ascent
= it
->phys_ascent
= ascent
;
26097 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26098 it
->nglyphs
= width
> 0 && height
> 0;
26099 take_vertical_position_into_account (it
);
26103 it
->nglyphs
= width
;
26106 /* Get information about special display element WHAT in an
26107 environment described by IT. WHAT is one of IT_TRUNCATION or
26108 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26109 non-null glyph_row member. This function ensures that fields like
26110 face_id, c, len of IT are left untouched. */
26113 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26120 temp_it
.object
= Qnil
;
26121 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26123 if (what
== IT_CONTINUATION
)
26125 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26126 if (it
->bidi_it
.paragraph_dir
== R2L
)
26127 SET_GLYPH_FROM_CHAR (glyph
, '/');
26129 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26131 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26133 /* FIXME: Should we mirror GC for R2L lines? */
26134 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26135 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26138 else if (what
== IT_TRUNCATION
)
26140 /* Truncation glyph. */
26141 SET_GLYPH_FROM_CHAR (glyph
, '$');
26143 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26145 /* FIXME: Should we mirror GC for R2L lines? */
26146 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26147 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26153 #ifdef HAVE_WINDOW_SYSTEM
26154 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26155 is turned off, we precede the truncation/continuation glyphs by a
26156 stretch glyph whose width is computed such that these special
26157 glyphs are aligned at the window margin, even when very different
26158 fonts are used in different glyph rows. */
26159 if (FRAME_WINDOW_P (temp_it
.f
)
26160 /* init_iterator calls this with it->glyph_row == NULL, and it
26161 wants only the pixel width of the truncation/continuation
26163 && temp_it
.glyph_row
26164 /* insert_left_trunc_glyphs calls us at the beginning of the
26165 row, and it has its own calculation of the stretch glyph
26167 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26168 && (temp_it
.glyph_row
->reversed_p
26169 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26170 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26172 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26174 if (stretch_width
> 0)
26176 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26177 struct font
*font
=
26178 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26179 int stretch_ascent
=
26180 (((temp_it
.ascent
+ temp_it
.descent
)
26181 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26183 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26184 temp_it
.ascent
+ temp_it
.descent
,
26191 temp_it
.what
= IT_CHARACTER
;
26192 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26193 temp_it
.face_id
= GLYPH_FACE (glyph
);
26194 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26196 PRODUCE_GLYPHS (&temp_it
);
26197 it
->pixel_width
= temp_it
.pixel_width
;
26198 it
->nglyphs
= temp_it
.nglyphs
;
26201 #ifdef HAVE_WINDOW_SYSTEM
26203 /* Calculate line-height and line-spacing properties.
26204 An integer value specifies explicit pixel value.
26205 A float value specifies relative value to current face height.
26206 A cons (float . face-name) specifies relative value to
26207 height of specified face font.
26209 Returns height in pixels, or nil. */
26212 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26213 int boff
, bool override
)
26215 Lisp_Object face_name
= Qnil
;
26216 int ascent
, descent
, height
;
26218 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26223 face_name
= XCAR (val
);
26225 if (!NUMBERP (val
))
26226 val
= make_number (1);
26227 if (NILP (face_name
))
26229 height
= it
->ascent
+ it
->descent
;
26234 if (NILP (face_name
))
26236 font
= FRAME_FONT (it
->f
);
26237 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26239 else if (EQ (face_name
, Qt
))
26248 face_id
= lookup_named_face (it
->f
, face_name
, false);
26250 return make_number (-1);
26252 face
= FACE_FROM_ID (it
->f
, face_id
);
26255 return make_number (-1);
26256 boff
= font
->baseline_offset
;
26257 if (font
->vertical_centering
)
26258 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26261 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26265 it
->override_ascent
= ascent
;
26266 it
->override_descent
= descent
;
26267 it
->override_boff
= boff
;
26270 height
= ascent
+ descent
;
26274 height
= (int)(XFLOAT_DATA (val
) * height
);
26275 else if (INTEGERP (val
))
26276 height
*= XINT (val
);
26278 return make_number (height
);
26282 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26283 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26284 and only if this is for a character for which no font was found.
26286 If the display method (it->glyphless_method) is
26287 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26288 length of the acronym or the hexadecimal string, UPPER_XOFF and
26289 UPPER_YOFF are pixel offsets for the upper part of the string,
26290 LOWER_XOFF and LOWER_YOFF are for the lower part.
26292 For the other display methods, LEN through LOWER_YOFF are zero. */
26295 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26296 short upper_xoff
, short upper_yoff
,
26297 short lower_xoff
, short lower_yoff
)
26299 struct glyph
*glyph
;
26300 enum glyph_row_area area
= it
->area
;
26302 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26303 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26305 /* If the glyph row is reversed, we need to prepend the glyph
26306 rather than append it. */
26307 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26311 /* Make room for the additional glyph. */
26312 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26314 glyph
= it
->glyph_row
->glyphs
[area
];
26316 glyph
->charpos
= CHARPOS (it
->position
);
26317 glyph
->object
= it
->object
;
26318 glyph
->pixel_width
= it
->pixel_width
;
26319 glyph
->ascent
= it
->ascent
;
26320 glyph
->descent
= it
->descent
;
26321 glyph
->voffset
= it
->voffset
;
26322 glyph
->type
= GLYPHLESS_GLYPH
;
26323 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26324 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26325 glyph
->u
.glyphless
.len
= len
;
26326 glyph
->u
.glyphless
.ch
= it
->c
;
26327 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26328 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26329 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26330 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26331 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26332 glyph
->multibyte_p
= it
->multibyte_p
;
26333 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26335 /* In R2L rows, the left and the right box edges need to be
26336 drawn in reverse direction. */
26337 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26338 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26342 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26343 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26345 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26346 || it
->phys_descent
> it
->descent
);
26347 glyph
->padding_p
= false;
26348 glyph
->glyph_not_available_p
= false;
26349 glyph
->face_id
= face_id
;
26350 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26353 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26354 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26355 glyph
->bidi_type
= it
->bidi_it
.type
;
26357 ++it
->glyph_row
->used
[area
];
26360 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26364 /* Produce a glyph for a glyphless character for iterator IT.
26365 IT->glyphless_method specifies which method to use for displaying
26366 the character. See the description of enum
26367 glyphless_display_method in dispextern.h for the detail.
26369 FOR_NO_FONT is true if and only if this is for a character for
26370 which no font was found. ACRONYM, if non-nil, is an acronym string
26371 for the character. */
26374 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26379 int base_width
, base_height
, width
, height
;
26380 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26383 /* Get the metrics of the base font. We always refer to the current
26385 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26386 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26387 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26388 it
->ascent
+= font
->baseline_offset
;
26389 it
->descent
-= font
->baseline_offset
;
26390 base_height
= it
->ascent
+ it
->descent
;
26391 base_width
= font
->average_width
;
26393 face_id
= merge_glyphless_glyph_face (it
);
26395 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26397 it
->pixel_width
= THIN_SPACE_WIDTH
;
26399 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26401 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26403 width
= CHAR_WIDTH (it
->c
);
26406 else if (width
> 4)
26408 it
->pixel_width
= base_width
* width
;
26410 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26416 unsigned int code
[6];
26418 int ascent
, descent
;
26419 struct font_metrics metrics_upper
, metrics_lower
;
26421 face
= FACE_FROM_ID (it
->f
, face_id
);
26422 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26423 prepare_face_for_display (it
->f
, face
);
26425 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26427 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26428 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26429 if (CONSP (acronym
))
26430 acronym
= XCAR (acronym
);
26431 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26435 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26436 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26439 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26440 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26441 upper_len
= (len
+ 1) / 2;
26442 font
->driver
->text_extents (font
, code
, upper_len
,
26444 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26449 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26450 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26451 upper_xoff
= upper_yoff
= 2; /* the typical case */
26452 if (base_width
>= width
)
26454 /* Align the upper to the left, the lower to the right. */
26455 it
->pixel_width
= base_width
;
26456 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26460 /* Center the shorter one. */
26461 it
->pixel_width
= width
;
26462 if (metrics_upper
.width
>= metrics_lower
.width
)
26463 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26466 /* FIXME: This code doesn't look right. It formerly was
26467 missing the "lower_xoff = 0;", which couldn't have
26468 been right since it left lower_xoff uninitialized. */
26470 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26474 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26475 top, bottom, and between upper and lower strings. */
26476 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26477 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26478 /* Center vertically.
26479 H:base_height, D:base_descent
26480 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26482 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26483 descent = D - H/2 + h/2;
26484 lower_yoff = descent - 2 - ld;
26485 upper_yoff = lower_yoff - la - 1 - ud; */
26486 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26487 descent
= it
->descent
- (base_height
- height
) / 2;
26488 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26489 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26490 - metrics_upper
.descent
);
26491 /* Don't make the height shorter than the base height. */
26492 if (height
> base_height
)
26494 it
->ascent
= ascent
;
26495 it
->descent
= descent
;
26499 it
->phys_ascent
= it
->ascent
;
26500 it
->phys_descent
= it
->descent
;
26502 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26503 upper_xoff
, upper_yoff
,
26504 lower_xoff
, lower_yoff
);
26506 take_vertical_position_into_account (it
);
26511 Produce glyphs/get display metrics for the display element IT is
26512 loaded with. See the description of struct it in dispextern.h
26513 for an overview of struct it. */
26516 x_produce_glyphs (struct it
*it
)
26518 int extra_line_spacing
= it
->extra_line_spacing
;
26520 it
->glyph_not_available_p
= false;
26522 if (it
->what
== IT_CHARACTER
)
26525 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26526 struct font
*font
= face
->font
;
26527 struct font_metrics
*pcm
= NULL
;
26528 int boff
; /* Baseline offset. */
26532 /* When no suitable font is found, display this character by
26533 the method specified in the first extra slot of
26534 Vglyphless_char_display. */
26535 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26537 eassert (it
->what
== IT_GLYPHLESS
);
26538 produce_glyphless_glyph (it
, true,
26539 STRINGP (acronym
) ? acronym
: Qnil
);
26543 boff
= font
->baseline_offset
;
26544 if (font
->vertical_centering
)
26545 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26547 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26551 if (it
->override_ascent
>= 0)
26553 it
->ascent
= it
->override_ascent
;
26554 it
->descent
= it
->override_descent
;
26555 boff
= it
->override_boff
;
26559 it
->ascent
= FONT_BASE (font
) + boff
;
26560 it
->descent
= FONT_DESCENT (font
) - boff
;
26563 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26565 pcm
= get_per_char_metric (font
, &char2b
);
26566 if (pcm
->width
== 0
26567 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26573 it
->phys_ascent
= pcm
->ascent
+ boff
;
26574 it
->phys_descent
= pcm
->descent
- boff
;
26575 it
->pixel_width
= pcm
->width
;
26576 /* Don't use font-global values for ascent and descent
26577 if they result in an exceedingly large line height. */
26578 if (it
->override_ascent
< 0)
26580 if (FONT_TOO_HIGH (font
))
26582 it
->ascent
= it
->phys_ascent
;
26583 it
->descent
= it
->phys_descent
;
26584 /* These limitations are enforced by an
26585 assertion near the end of this function. */
26586 if (it
->ascent
< 0)
26588 if (it
->descent
< 0)
26595 it
->glyph_not_available_p
= true;
26596 it
->phys_ascent
= it
->ascent
;
26597 it
->phys_descent
= it
->descent
;
26598 it
->pixel_width
= font
->space_width
;
26601 if (it
->constrain_row_ascent_descent_p
)
26603 if (it
->descent
> it
->max_descent
)
26605 it
->ascent
+= it
->descent
- it
->max_descent
;
26606 it
->descent
= it
->max_descent
;
26608 if (it
->ascent
> it
->max_ascent
)
26610 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26611 it
->ascent
= it
->max_ascent
;
26613 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26614 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26615 extra_line_spacing
= 0;
26618 /* If this is a space inside a region of text with
26619 `space-width' property, change its width. */
26621 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26623 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26625 /* If face has a box, add the box thickness to the character
26626 height. If character has a box line to the left and/or
26627 right, add the box line width to the character's width. */
26628 if (face
->box
!= FACE_NO_BOX
)
26630 int thick
= face
->box_line_width
;
26634 it
->ascent
+= thick
;
26635 it
->descent
+= thick
;
26640 if (it
->start_of_box_run_p
)
26641 it
->pixel_width
+= thick
;
26642 if (it
->end_of_box_run_p
)
26643 it
->pixel_width
+= thick
;
26646 /* If face has an overline, add the height of the overline
26647 (1 pixel) and a 1 pixel margin to the character height. */
26648 if (face
->overline_p
)
26649 it
->ascent
+= overline_margin
;
26651 if (it
->constrain_row_ascent_descent_p
)
26653 if (it
->ascent
> it
->max_ascent
)
26654 it
->ascent
= it
->max_ascent
;
26655 if (it
->descent
> it
->max_descent
)
26656 it
->descent
= it
->max_descent
;
26659 take_vertical_position_into_account (it
);
26661 /* If we have to actually produce glyphs, do it. */
26666 /* Translate a space with a `space-width' property
26667 into a stretch glyph. */
26668 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26669 / FONT_HEIGHT (font
));
26670 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26671 it
->ascent
+ it
->descent
, ascent
);
26676 /* If characters with lbearing or rbearing are displayed
26677 in this line, record that fact in a flag of the
26678 glyph row. This is used to optimize X output code. */
26679 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26680 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26682 if (! stretched_p
&& it
->pixel_width
== 0)
26683 /* We assure that all visible glyphs have at least 1-pixel
26685 it
->pixel_width
= 1;
26687 else if (it
->char_to_display
== '\n')
26689 /* A newline has no width, but we need the height of the
26690 line. But if previous part of the line sets a height,
26691 don't increase that height. */
26693 Lisp_Object height
;
26694 Lisp_Object total_height
= Qnil
;
26696 it
->override_ascent
= -1;
26697 it
->pixel_width
= 0;
26700 height
= get_it_property (it
, Qline_height
);
26701 /* Split (line-height total-height) list. */
26703 && CONSP (XCDR (height
))
26704 && NILP (XCDR (XCDR (height
))))
26706 total_height
= XCAR (XCDR (height
));
26707 height
= XCAR (height
);
26709 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26711 if (it
->override_ascent
>= 0)
26713 it
->ascent
= it
->override_ascent
;
26714 it
->descent
= it
->override_descent
;
26715 boff
= it
->override_boff
;
26719 if (FONT_TOO_HIGH (font
))
26721 it
->ascent
= font
->pixel_size
+ boff
- 1;
26722 it
->descent
= -boff
+ 1;
26723 if (it
->descent
< 0)
26728 it
->ascent
= FONT_BASE (font
) + boff
;
26729 it
->descent
= FONT_DESCENT (font
) - boff
;
26733 if (EQ (height
, Qt
))
26735 if (it
->descent
> it
->max_descent
)
26737 it
->ascent
+= it
->descent
- it
->max_descent
;
26738 it
->descent
= it
->max_descent
;
26740 if (it
->ascent
> it
->max_ascent
)
26742 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26743 it
->ascent
= it
->max_ascent
;
26745 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26746 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26747 it
->constrain_row_ascent_descent_p
= true;
26748 extra_line_spacing
= 0;
26752 Lisp_Object spacing
;
26754 it
->phys_ascent
= it
->ascent
;
26755 it
->phys_descent
= it
->descent
;
26757 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26758 && face
->box
!= FACE_NO_BOX
26759 && face
->box_line_width
> 0)
26761 it
->ascent
+= face
->box_line_width
;
26762 it
->descent
+= face
->box_line_width
;
26765 && XINT (height
) > it
->ascent
+ it
->descent
)
26766 it
->ascent
= XINT (height
) - it
->descent
;
26768 if (!NILP (total_height
))
26769 spacing
= calc_line_height_property (it
, total_height
, font
,
26773 spacing
= get_it_property (it
, Qline_spacing
);
26774 spacing
= calc_line_height_property (it
, spacing
, font
,
26777 if (INTEGERP (spacing
))
26779 extra_line_spacing
= XINT (spacing
);
26780 if (!NILP (total_height
))
26781 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26785 else /* i.e. (it->char_to_display == '\t') */
26787 if (font
->space_width
> 0)
26789 int tab_width
= it
->tab_width
* font
->space_width
;
26790 int x
= it
->current_x
+ it
->continuation_lines_width
;
26791 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26793 /* If the distance from the current position to the next tab
26794 stop is less than a space character width, use the
26795 tab stop after that. */
26796 if (next_tab_x
- x
< font
->space_width
)
26797 next_tab_x
+= tab_width
;
26799 it
->pixel_width
= next_tab_x
- x
;
26801 if (FONT_TOO_HIGH (font
))
26803 if (get_char_glyph_code (' ', font
, &char2b
))
26805 pcm
= get_per_char_metric (font
, &char2b
);
26806 if (pcm
->width
== 0
26807 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26813 it
->ascent
= pcm
->ascent
+ boff
;
26814 it
->descent
= pcm
->descent
- boff
;
26818 it
->ascent
= font
->pixel_size
+ boff
- 1;
26819 it
->descent
= -boff
+ 1;
26821 if (it
->ascent
< 0)
26823 if (it
->descent
< 0)
26828 it
->ascent
= FONT_BASE (font
) + boff
;
26829 it
->descent
= FONT_DESCENT (font
) - boff
;
26831 it
->phys_ascent
= it
->ascent
;
26832 it
->phys_descent
= it
->descent
;
26836 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26837 it
->ascent
+ it
->descent
, it
->ascent
);
26842 it
->pixel_width
= 0;
26847 if (FONT_TOO_HIGH (font
))
26849 int font_ascent
, font_descent
;
26851 /* For very large fonts, where we ignore the declared font
26852 dimensions, and go by per-character metrics instead,
26853 don't let the row ascent and descent values (and the row
26854 height computed from them) be smaller than the "normal"
26855 character metrics. This avoids unpleasant effects
26856 whereby lines on display would change their height
26857 depending on which characters are shown. */
26858 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26859 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26860 it
->max_descent
= max (it
->max_descent
, font_descent
);
26863 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26865 /* A static composition.
26867 Note: A composition is represented as one glyph in the
26868 glyph matrix. There are no padding glyphs.
26870 Important note: pixel_width, ascent, and descent are the
26871 values of what is drawn by draw_glyphs (i.e. the values of
26872 the overall glyphs composed). */
26873 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26874 int boff
; /* baseline offset */
26875 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26876 int glyph_len
= cmp
->glyph_len
;
26877 struct font
*font
= face
->font
;
26881 /* If we have not yet calculated pixel size data of glyphs of
26882 the composition for the current face font, calculate them
26883 now. Theoretically, we have to check all fonts for the
26884 glyphs, but that requires much time and memory space. So,
26885 here we check only the font of the first glyph. This may
26886 lead to incorrect display, but it's very rare, and C-l
26887 (recenter-top-bottom) can correct the display anyway. */
26888 if (! cmp
->font
|| cmp
->font
!= font
)
26890 /* Ascent and descent of the font of the first character
26891 of this composition (adjusted by baseline offset).
26892 Ascent and descent of overall glyphs should not be less
26893 than these, respectively. */
26894 int font_ascent
, font_descent
, font_height
;
26895 /* Bounding box of the overall glyphs. */
26896 int leftmost
, rightmost
, lowest
, highest
;
26897 int lbearing
, rbearing
;
26898 int i
, width
, ascent
, descent
;
26899 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26901 struct font_metrics
*pcm
;
26904 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26905 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26907 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26908 for (i
= 0; i
< glyph_len
; i
++)
26910 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26912 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26914 bool left_padded
= i
> 0;
26916 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26917 : IT_CHARPOS (*it
));
26918 /* If no suitable font is found, use the default font. */
26919 bool font_not_found_p
= font
== NULL
;
26920 if (font_not_found_p
)
26922 face
= face
->ascii_face
;
26925 boff
= font
->baseline_offset
;
26926 if (font
->vertical_centering
)
26927 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26928 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26929 font_ascent
+= boff
;
26930 font_descent
-= boff
;
26931 font_height
= font_ascent
+ font_descent
;
26936 if (! font_not_found_p
)
26938 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26940 pcm
= get_per_char_metric (font
, &char2b
);
26943 /* Initialize the bounding box. */
26946 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26947 ascent
= pcm
->ascent
;
26948 descent
= pcm
->descent
;
26949 lbearing
= pcm
->lbearing
;
26950 rbearing
= pcm
->rbearing
;
26954 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26955 ascent
= FONT_BASE (font
);
26956 descent
= FONT_DESCENT (font
);
26963 lowest
= - descent
+ boff
;
26964 highest
= ascent
+ boff
;
26966 if (! font_not_found_p
26967 && font
->default_ascent
26968 && CHAR_TABLE_P (Vuse_default_ascent
)
26969 && !NILP (Faref (Vuse_default_ascent
,
26970 make_number (it
->char_to_display
))))
26971 highest
= font
->default_ascent
+ boff
;
26973 /* Draw the first glyph at the normal position. It may be
26974 shifted to right later if some other glyphs are drawn
26976 cmp
->offsets
[i
* 2] = 0;
26977 cmp
->offsets
[i
* 2 + 1] = boff
;
26978 cmp
->lbearing
= lbearing
;
26979 cmp
->rbearing
= rbearing
;
26981 /* Set cmp->offsets for the remaining glyphs. */
26982 for (i
++; i
< glyph_len
; i
++)
26984 int left
, right
, btm
, top
;
26985 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26987 struct face
*this_face
;
26991 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26992 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26993 font
= this_face
->font
;
26999 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27001 pcm
= get_per_char_metric (font
, &char2b
);
27004 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27007 width
= pcm
->width
;
27008 ascent
= pcm
->ascent
;
27009 descent
= pcm
->descent
;
27010 lbearing
= pcm
->lbearing
;
27011 rbearing
= pcm
->rbearing
;
27012 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27014 /* Relative composition with or without
27015 alternate chars. */
27016 left
= (leftmost
+ rightmost
- width
) / 2;
27017 btm
= - descent
+ boff
;
27018 if (font
->relative_compose
27019 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27020 || NILP (Faref (Vignore_relative_composition
,
27021 make_number (ch
)))))
27024 if (- descent
>= font
->relative_compose
)
27025 /* One extra pixel between two glyphs. */
27027 else if (ascent
<= 0)
27028 /* One extra pixel between two glyphs. */
27029 btm
= lowest
- 1 - ascent
- descent
;
27034 /* A composition rule is specified by an integer
27035 value that encodes global and new reference
27036 points (GREF and NREF). GREF and NREF are
27037 specified by numbers as below:
27039 0---1---2 -- ascent
27043 9--10--11 -- center
27045 ---3---4---5--- baseline
27047 6---7---8 -- descent
27049 int rule
= COMPOSITION_RULE (cmp
, i
);
27050 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27052 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27053 grefx
= gref
% 3, nrefx
= nref
% 3;
27054 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27056 xoff
= font_height
* (xoff
- 128) / 256;
27058 yoff
= font_height
* (yoff
- 128) / 256;
27061 + grefx
* (rightmost
- leftmost
) / 2
27062 - nrefx
* width
/ 2
27065 btm
= ((grefy
== 0 ? highest
27067 : grefy
== 2 ? lowest
27068 : (highest
+ lowest
) / 2)
27069 - (nrefy
== 0 ? ascent
+ descent
27070 : nrefy
== 1 ? descent
- boff
27072 : (ascent
+ descent
) / 2)
27076 cmp
->offsets
[i
* 2] = left
;
27077 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27079 /* Update the bounding box of the overall glyphs. */
27082 right
= left
+ width
;
27083 if (left
< leftmost
)
27085 if (right
> rightmost
)
27088 top
= btm
+ descent
+ ascent
;
27094 if (cmp
->lbearing
> left
+ lbearing
)
27095 cmp
->lbearing
= left
+ lbearing
;
27096 if (cmp
->rbearing
< left
+ rbearing
)
27097 cmp
->rbearing
= left
+ rbearing
;
27101 /* If there are glyphs whose x-offsets are negative,
27102 shift all glyphs to the right and make all x-offsets
27106 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27107 cmp
->offsets
[i
* 2] -= leftmost
;
27108 rightmost
-= leftmost
;
27109 cmp
->lbearing
-= leftmost
;
27110 cmp
->rbearing
-= leftmost
;
27113 if (left_padded
&& cmp
->lbearing
< 0)
27115 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27116 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27117 rightmost
-= cmp
->lbearing
;
27118 cmp
->rbearing
-= cmp
->lbearing
;
27121 if (right_padded
&& rightmost
< cmp
->rbearing
)
27123 rightmost
= cmp
->rbearing
;
27126 cmp
->pixel_width
= rightmost
;
27127 cmp
->ascent
= highest
;
27128 cmp
->descent
= - lowest
;
27129 if (cmp
->ascent
< font_ascent
)
27130 cmp
->ascent
= font_ascent
;
27131 if (cmp
->descent
< font_descent
)
27132 cmp
->descent
= font_descent
;
27136 && (cmp
->lbearing
< 0
27137 || cmp
->rbearing
> cmp
->pixel_width
))
27138 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27140 it
->pixel_width
= cmp
->pixel_width
;
27141 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27142 it
->descent
= it
->phys_descent
= cmp
->descent
;
27143 if (face
->box
!= FACE_NO_BOX
)
27145 int thick
= face
->box_line_width
;
27149 it
->ascent
+= thick
;
27150 it
->descent
+= thick
;
27155 if (it
->start_of_box_run_p
)
27156 it
->pixel_width
+= thick
;
27157 if (it
->end_of_box_run_p
)
27158 it
->pixel_width
+= thick
;
27161 /* If face has an overline, add the height of the overline
27162 (1 pixel) and a 1 pixel margin to the character height. */
27163 if (face
->overline_p
)
27164 it
->ascent
+= overline_margin
;
27166 take_vertical_position_into_account (it
);
27167 if (it
->ascent
< 0)
27169 if (it
->descent
< 0)
27172 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27173 append_composite_glyph (it
);
27175 else if (it
->what
== IT_COMPOSITION
)
27177 /* A dynamic (automatic) composition. */
27178 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27179 Lisp_Object gstring
;
27180 struct font_metrics metrics
;
27184 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27186 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27189 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27190 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27191 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27192 it
->descent
= it
->phys_descent
= metrics
.descent
;
27193 if (face
->box
!= FACE_NO_BOX
)
27195 int thick
= face
->box_line_width
;
27199 it
->ascent
+= thick
;
27200 it
->descent
+= thick
;
27205 if (it
->start_of_box_run_p
)
27206 it
->pixel_width
+= thick
;
27207 if (it
->end_of_box_run_p
)
27208 it
->pixel_width
+= thick
;
27210 /* If face has an overline, add the height of the overline
27211 (1 pixel) and a 1 pixel margin to the character height. */
27212 if (face
->overline_p
)
27213 it
->ascent
+= overline_margin
;
27214 take_vertical_position_into_account (it
);
27215 if (it
->ascent
< 0)
27217 if (it
->descent
< 0)
27221 append_composite_glyph (it
);
27223 else if (it
->what
== IT_GLYPHLESS
)
27224 produce_glyphless_glyph (it
, false, Qnil
);
27225 else if (it
->what
== IT_IMAGE
)
27226 produce_image_glyph (it
);
27227 else if (it
->what
== IT_STRETCH
)
27228 produce_stretch_glyph (it
);
27231 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27232 because this isn't true for images with `:ascent 100'. */
27233 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27234 if (it
->area
== TEXT_AREA
)
27235 it
->current_x
+= it
->pixel_width
;
27237 if (extra_line_spacing
> 0)
27239 it
->descent
+= extra_line_spacing
;
27240 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27241 it
->max_extra_line_spacing
= extra_line_spacing
;
27244 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27245 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27246 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27247 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27251 Output LEN glyphs starting at START at the nominal cursor position.
27252 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27253 being updated, and UPDATED_AREA is the area of that row being updated. */
27256 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27257 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27259 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27261 eassert (updated_row
);
27262 /* When the window is hscrolled, cursor hpos can legitimately be out
27263 of bounds, but we draw the cursor at the corresponding window
27264 margin in that case. */
27265 if (!updated_row
->reversed_p
&& chpos
< 0)
27267 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27268 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27272 /* Write glyphs. */
27274 hpos
= start
- updated_row
->glyphs
[updated_area
];
27275 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27276 updated_row
, updated_area
,
27278 DRAW_NORMAL_TEXT
, 0);
27280 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27281 if (updated_area
== TEXT_AREA
27282 && w
->phys_cursor_on_p
27283 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27285 && chpos
< hpos
+ len
)
27286 w
->phys_cursor_on_p
= false;
27290 /* Advance the output cursor. */
27291 w
->output_cursor
.hpos
+= len
;
27292 w
->output_cursor
.x
= x
;
27297 Insert LEN glyphs from START at the nominal cursor position. */
27300 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27301 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27304 int line_height
, shift_by_width
, shifted_region_width
;
27305 struct glyph_row
*row
;
27306 struct glyph
*glyph
;
27307 int frame_x
, frame_y
;
27310 eassert (updated_row
);
27312 f
= XFRAME (WINDOW_FRAME (w
));
27314 /* Get the height of the line we are in. */
27316 line_height
= row
->height
;
27318 /* Get the width of the glyphs to insert. */
27319 shift_by_width
= 0;
27320 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27321 shift_by_width
+= glyph
->pixel_width
;
27323 /* Get the width of the region to shift right. */
27324 shifted_region_width
= (window_box_width (w
, updated_area
)
27325 - w
->output_cursor
.x
27329 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27330 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27332 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27333 line_height
, shift_by_width
);
27335 /* Write the glyphs. */
27336 hpos
= start
- row
->glyphs
[updated_area
];
27337 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27339 DRAW_NORMAL_TEXT
, 0);
27341 /* Advance the output cursor. */
27342 w
->output_cursor
.hpos
+= len
;
27343 w
->output_cursor
.x
+= shift_by_width
;
27349 Erase the current text line from the nominal cursor position
27350 (inclusive) to pixel column TO_X (exclusive). The idea is that
27351 everything from TO_X onward is already erased.
27353 TO_X is a pixel position relative to UPDATED_AREA of currently
27354 updated window W. TO_X == -1 means clear to the end of this area. */
27357 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27358 enum glyph_row_area updated_area
, int to_x
)
27361 int max_x
, min_y
, max_y
;
27362 int from_x
, from_y
, to_y
;
27364 eassert (updated_row
);
27365 f
= XFRAME (w
->frame
);
27367 if (updated_row
->full_width_p
)
27368 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27369 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27371 max_x
= window_box_width (w
, updated_area
);
27372 max_y
= window_text_bottom_y (w
);
27374 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27375 of window. For TO_X > 0, truncate to end of drawing area. */
27381 to_x
= min (to_x
, max_x
);
27383 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27385 /* Notice if the cursor will be cleared by this operation. */
27386 if (!updated_row
->full_width_p
)
27387 notice_overwritten_cursor (w
, updated_area
,
27388 w
->output_cursor
.x
, -1,
27390 MATRIX_ROW_BOTTOM_Y (updated_row
));
27392 from_x
= w
->output_cursor
.x
;
27394 /* Translate to frame coordinates. */
27395 if (updated_row
->full_width_p
)
27397 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27398 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27402 int area_left
= window_box_left (w
, updated_area
);
27403 from_x
+= area_left
;
27407 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27408 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27409 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27411 /* Prevent inadvertently clearing to end of the X window. */
27412 if (to_x
> from_x
&& to_y
> from_y
)
27415 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27416 to_x
- from_x
, to_y
- from_y
);
27421 #endif /* HAVE_WINDOW_SYSTEM */
27425 /***********************************************************************
27427 ***********************************************************************/
27429 /* Value is the internal representation of the specified cursor type
27430 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27431 of the bar cursor. */
27433 static enum text_cursor_kinds
27434 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27436 enum text_cursor_kinds type
;
27441 if (EQ (arg
, Qbox
))
27442 return FILLED_BOX_CURSOR
;
27444 if (EQ (arg
, Qhollow
))
27445 return HOLLOW_BOX_CURSOR
;
27447 if (EQ (arg
, Qbar
))
27454 && EQ (XCAR (arg
), Qbar
)
27455 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27457 *width
= XINT (XCDR (arg
));
27461 if (EQ (arg
, Qhbar
))
27464 return HBAR_CURSOR
;
27468 && EQ (XCAR (arg
), Qhbar
)
27469 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27471 *width
= XINT (XCDR (arg
));
27472 return HBAR_CURSOR
;
27475 /* Treat anything unknown as "hollow box cursor".
27476 It was bad to signal an error; people have trouble fixing
27477 .Xdefaults with Emacs, when it has something bad in it. */
27478 type
= HOLLOW_BOX_CURSOR
;
27483 /* Set the default cursor types for specified frame. */
27485 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27490 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27491 FRAME_CURSOR_WIDTH (f
) = width
;
27493 /* By default, set up the blink-off state depending on the on-state. */
27495 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27498 FRAME_BLINK_OFF_CURSOR (f
)
27499 = get_specified_cursor_type (XCDR (tem
), &width
);
27500 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27503 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27505 /* Make sure the cursor gets redrawn. */
27506 f
->cursor_type_changed
= true;
27510 #ifdef HAVE_WINDOW_SYSTEM
27512 /* Return the cursor we want to be displayed in window W. Return
27513 width of bar/hbar cursor through WIDTH arg. Return with
27514 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27515 (i.e. if the `system caret' should track this cursor).
27517 In a mini-buffer window, we want the cursor only to appear if we
27518 are reading input from this window. For the selected window, we
27519 want the cursor type given by the frame parameter or buffer local
27520 setting of cursor-type. If explicitly marked off, draw no cursor.
27521 In all other cases, we want a hollow box cursor. */
27523 static enum text_cursor_kinds
27524 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27525 bool *active_cursor
)
27527 struct frame
*f
= XFRAME (w
->frame
);
27528 struct buffer
*b
= XBUFFER (w
->contents
);
27529 int cursor_type
= DEFAULT_CURSOR
;
27530 Lisp_Object alt_cursor
;
27531 bool non_selected
= false;
27533 *active_cursor
= true;
27536 if (cursor_in_echo_area
27537 && FRAME_HAS_MINIBUF_P (f
)
27538 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27540 if (w
== XWINDOW (echo_area_window
))
27542 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27544 *width
= FRAME_CURSOR_WIDTH (f
);
27545 return FRAME_DESIRED_CURSOR (f
);
27548 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27551 *active_cursor
= false;
27552 non_selected
= true;
27555 /* Detect a nonselected window or nonselected frame. */
27556 else if (w
!= XWINDOW (f
->selected_window
)
27557 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27559 *active_cursor
= false;
27561 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27564 non_selected
= true;
27567 /* Never display a cursor in a window in which cursor-type is nil. */
27568 if (NILP (BVAR (b
, cursor_type
)))
27571 /* Get the normal cursor type for this window. */
27572 if (EQ (BVAR (b
, cursor_type
), Qt
))
27574 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27575 *width
= FRAME_CURSOR_WIDTH (f
);
27578 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27580 /* Use cursor-in-non-selected-windows instead
27581 for non-selected window or frame. */
27584 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27585 if (!EQ (Qt
, alt_cursor
))
27586 return get_specified_cursor_type (alt_cursor
, width
);
27587 /* t means modify the normal cursor type. */
27588 if (cursor_type
== FILLED_BOX_CURSOR
)
27589 cursor_type
= HOLLOW_BOX_CURSOR
;
27590 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27592 return cursor_type
;
27595 /* Use normal cursor if not blinked off. */
27596 if (!w
->cursor_off_p
)
27598 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27600 if (cursor_type
== FILLED_BOX_CURSOR
)
27602 /* Using a block cursor on large images can be very annoying.
27603 So use a hollow cursor for "large" images.
27604 If image is not transparent (no mask), also use hollow cursor. */
27605 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27606 if (img
!= NULL
&& IMAGEP (img
->spec
))
27608 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27609 where N = size of default frame font size.
27610 This should cover most of the "tiny" icons people may use. */
27612 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27613 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27614 cursor_type
= HOLLOW_BOX_CURSOR
;
27617 else if (cursor_type
!= NO_CURSOR
)
27619 /* Display current only supports BOX and HOLLOW cursors for images.
27620 So for now, unconditionally use a HOLLOW cursor when cursor is
27621 not a solid box cursor. */
27622 cursor_type
= HOLLOW_BOX_CURSOR
;
27625 return cursor_type
;
27628 /* Cursor is blinked off, so determine how to "toggle" it. */
27630 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27631 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27632 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27634 /* Then see if frame has specified a specific blink off cursor type. */
27635 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27637 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27638 return FRAME_BLINK_OFF_CURSOR (f
);
27642 /* Some people liked having a permanently visible blinking cursor,
27643 while others had very strong opinions against it. So it was
27644 decided to remove it. KFS 2003-09-03 */
27646 /* Finally perform built-in cursor blinking:
27647 filled box <-> hollow box
27648 wide [h]bar <-> narrow [h]bar
27649 narrow [h]bar <-> no cursor
27650 other type <-> no cursor */
27652 if (cursor_type
== FILLED_BOX_CURSOR
)
27653 return HOLLOW_BOX_CURSOR
;
27655 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27658 return cursor_type
;
27666 /* Notice when the text cursor of window W has been completely
27667 overwritten by a drawing operation that outputs glyphs in AREA
27668 starting at X0 and ending at X1 in the line starting at Y0 and
27669 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27670 the rest of the line after X0 has been written. Y coordinates
27671 are window-relative. */
27674 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27675 int x0
, int x1
, int y0
, int y1
)
27677 int cx0
, cx1
, cy0
, cy1
;
27678 struct glyph_row
*row
;
27680 if (!w
->phys_cursor_on_p
)
27682 if (area
!= TEXT_AREA
)
27685 if (w
->phys_cursor
.vpos
< 0
27686 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27687 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27688 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27691 if (row
->cursor_in_fringe_p
)
27693 row
->cursor_in_fringe_p
= false;
27694 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27695 w
->phys_cursor_on_p
= false;
27699 cx0
= w
->phys_cursor
.x
;
27700 cx1
= cx0
+ w
->phys_cursor_width
;
27701 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27704 /* The cursor image will be completely removed from the
27705 screen if the output area intersects the cursor area in
27706 y-direction. When we draw in [y0 y1[, and some part of
27707 the cursor is at y < y0, that part must have been drawn
27708 before. When scrolling, the cursor is erased before
27709 actually scrolling, so we don't come here. When not
27710 scrolling, the rows above the old cursor row must have
27711 changed, and in this case these rows must have written
27712 over the cursor image.
27714 Likewise if part of the cursor is below y1, with the
27715 exception of the cursor being in the first blank row at
27716 the buffer and window end because update_text_area
27717 doesn't draw that row. (Except when it does, but
27718 that's handled in update_text_area.) */
27720 cy0
= w
->phys_cursor
.y
;
27721 cy1
= cy0
+ w
->phys_cursor_height
;
27722 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27725 w
->phys_cursor_on_p
= false;
27728 #endif /* HAVE_WINDOW_SYSTEM */
27731 /************************************************************************
27733 ************************************************************************/
27735 #ifdef HAVE_WINDOW_SYSTEM
27738 Fix the display of area AREA of overlapping row ROW in window W
27739 with respect to the overlapping part OVERLAPS. */
27742 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27743 enum glyph_row_area area
, int overlaps
)
27750 for (i
= 0; i
< row
->used
[area
];)
27752 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27754 int start
= i
, start_x
= x
;
27758 x
+= row
->glyphs
[area
][i
].pixel_width
;
27761 while (i
< row
->used
[area
]
27762 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27764 draw_glyphs (w
, start_x
, row
, area
,
27766 DRAW_NORMAL_TEXT
, overlaps
);
27770 x
+= row
->glyphs
[area
][i
].pixel_width
;
27780 Draw the cursor glyph of window W in glyph row ROW. See the
27781 comment of draw_glyphs for the meaning of HL. */
27784 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27785 enum draw_glyphs_face hl
)
27787 /* If cursor hpos is out of bounds, don't draw garbage. This can
27788 happen in mini-buffer windows when switching between echo area
27789 glyphs and mini-buffer. */
27790 if ((row
->reversed_p
27791 ? (w
->phys_cursor
.hpos
>= 0)
27792 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27794 bool on_p
= w
->phys_cursor_on_p
;
27796 int hpos
= w
->phys_cursor
.hpos
;
27798 /* When the window is hscrolled, cursor hpos can legitimately be
27799 out of bounds, but we draw the cursor at the corresponding
27800 window margin in that case. */
27801 if (!row
->reversed_p
&& hpos
< 0)
27803 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27804 hpos
= row
->used
[TEXT_AREA
] - 1;
27806 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27808 w
->phys_cursor_on_p
= on_p
;
27810 if (hl
== DRAW_CURSOR
)
27811 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27812 /* When we erase the cursor, and ROW is overlapped by other
27813 rows, make sure that these overlapping parts of other rows
27815 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27817 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27819 if (row
> w
->current_matrix
->rows
27820 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27821 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27822 OVERLAPS_ERASED_CURSOR
);
27824 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27825 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27826 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27827 OVERLAPS_ERASED_CURSOR
);
27833 /* Erase the image of a cursor of window W from the screen. */
27836 erase_phys_cursor (struct window
*w
)
27838 struct frame
*f
= XFRAME (w
->frame
);
27839 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27840 int hpos
= w
->phys_cursor
.hpos
;
27841 int vpos
= w
->phys_cursor
.vpos
;
27842 bool mouse_face_here_p
= false;
27843 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27844 struct glyph_row
*cursor_row
;
27845 struct glyph
*cursor_glyph
;
27846 enum draw_glyphs_face hl
;
27848 /* No cursor displayed or row invalidated => nothing to do on the
27850 if (w
->phys_cursor_type
== NO_CURSOR
)
27851 goto mark_cursor_off
;
27853 /* VPOS >= active_glyphs->nrows means that window has been resized.
27854 Don't bother to erase the cursor. */
27855 if (vpos
>= active_glyphs
->nrows
)
27856 goto mark_cursor_off
;
27858 /* If row containing cursor is marked invalid, there is nothing we
27860 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27861 if (!cursor_row
->enabled_p
)
27862 goto mark_cursor_off
;
27864 /* If line spacing is > 0, old cursor may only be partially visible in
27865 window after split-window. So adjust visible height. */
27866 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27867 window_text_bottom_y (w
) - cursor_row
->y
);
27869 /* If row is completely invisible, don't attempt to delete a cursor which
27870 isn't there. This can happen if cursor is at top of a window, and
27871 we switch to a buffer with a header line in that window. */
27872 if (cursor_row
->visible_height
<= 0)
27873 goto mark_cursor_off
;
27875 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27876 if (cursor_row
->cursor_in_fringe_p
)
27878 cursor_row
->cursor_in_fringe_p
= false;
27879 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27880 goto mark_cursor_off
;
27883 /* This can happen when the new row is shorter than the old one.
27884 In this case, either draw_glyphs or clear_end_of_line
27885 should have cleared the cursor. Note that we wouldn't be
27886 able to erase the cursor in this case because we don't have a
27887 cursor glyph at hand. */
27888 if ((cursor_row
->reversed_p
27889 ? (w
->phys_cursor
.hpos
< 0)
27890 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27891 goto mark_cursor_off
;
27893 /* When the window is hscrolled, cursor hpos can legitimately be out
27894 of bounds, but we draw the cursor at the corresponding window
27895 margin in that case. */
27896 if (!cursor_row
->reversed_p
&& hpos
< 0)
27898 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27899 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27901 /* If the cursor is in the mouse face area, redisplay that when
27902 we clear the cursor. */
27903 if (! NILP (hlinfo
->mouse_face_window
)
27904 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27905 /* Don't redraw the cursor's spot in mouse face if it is at the
27906 end of a line (on a newline). The cursor appears there, but
27907 mouse highlighting does not. */
27908 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27909 mouse_face_here_p
= true;
27911 /* Maybe clear the display under the cursor. */
27912 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27915 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27918 cursor_glyph
= get_phys_cursor_glyph (w
);
27919 if (cursor_glyph
== NULL
)
27920 goto mark_cursor_off
;
27922 width
= cursor_glyph
->pixel_width
;
27923 x
= w
->phys_cursor
.x
;
27929 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27930 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27931 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27934 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27937 /* Erase the cursor by redrawing the character underneath it. */
27938 if (mouse_face_here_p
)
27939 hl
= DRAW_MOUSE_FACE
;
27941 hl
= DRAW_NORMAL_TEXT
;
27942 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27945 w
->phys_cursor_on_p
= false;
27946 w
->phys_cursor_type
= NO_CURSOR
;
27950 /* Display or clear cursor of window W. If !ON, clear the cursor.
27951 If ON, display the cursor; where to put the cursor is specified by
27952 HPOS, VPOS, X and Y. */
27955 display_and_set_cursor (struct window
*w
, bool on
,
27956 int hpos
, int vpos
, int x
, int y
)
27958 struct frame
*f
= XFRAME (w
->frame
);
27959 int new_cursor_type
;
27960 int new_cursor_width
;
27961 bool active_cursor
;
27962 struct glyph_row
*glyph_row
;
27963 struct glyph
*glyph
;
27965 /* This is pointless on invisible frames, and dangerous on garbaged
27966 windows and frames; in the latter case, the frame or window may
27967 be in the midst of changing its size, and x and y may be off the
27969 if (! FRAME_VISIBLE_P (f
)
27970 || FRAME_GARBAGED_P (f
)
27971 || vpos
>= w
->current_matrix
->nrows
27972 || hpos
>= w
->current_matrix
->matrix_w
)
27975 /* If cursor is off and we want it off, return quickly. */
27976 if (!on
&& !w
->phys_cursor_on_p
)
27979 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27980 /* If cursor row is not enabled, we don't really know where to
27981 display the cursor. */
27982 if (!glyph_row
->enabled_p
)
27984 w
->phys_cursor_on_p
= false;
27989 if (!glyph_row
->exact_window_width_line_p
27990 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27991 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27993 eassert (input_blocked_p ());
27995 /* Set new_cursor_type to the cursor we want to be displayed. */
27996 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27997 &new_cursor_width
, &active_cursor
);
27999 /* If cursor is currently being shown and we don't want it to be or
28000 it is in the wrong place, or the cursor type is not what we want,
28002 if (w
->phys_cursor_on_p
28004 || w
->phys_cursor
.x
!= x
28005 || w
->phys_cursor
.y
!= y
28006 /* HPOS can be negative in R2L rows whose
28007 exact_window_width_line_p flag is set (i.e. their newline
28008 would "overflow into the fringe"). */
28010 || new_cursor_type
!= w
->phys_cursor_type
28011 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28012 && new_cursor_width
!= w
->phys_cursor_width
)))
28013 erase_phys_cursor (w
);
28015 /* Don't check phys_cursor_on_p here because that flag is only set
28016 to false in some cases where we know that the cursor has been
28017 completely erased, to avoid the extra work of erasing the cursor
28018 twice. In other words, phys_cursor_on_p can be true and the cursor
28019 still not be visible, or it has only been partly erased. */
28022 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28023 w
->phys_cursor_height
= glyph_row
->height
;
28025 /* Set phys_cursor_.* before x_draw_.* is called because some
28026 of them may need the information. */
28027 w
->phys_cursor
.x
= x
;
28028 w
->phys_cursor
.y
= glyph_row
->y
;
28029 w
->phys_cursor
.hpos
= hpos
;
28030 w
->phys_cursor
.vpos
= vpos
;
28033 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28034 new_cursor_type
, new_cursor_width
,
28035 on
, active_cursor
);
28039 /* Switch the display of W's cursor on or off, according to the value
28043 update_window_cursor (struct window
*w
, bool on
)
28045 /* Don't update cursor in windows whose frame is in the process
28046 of being deleted. */
28047 if (w
->current_matrix
)
28049 int hpos
= w
->phys_cursor
.hpos
;
28050 int vpos
= w
->phys_cursor
.vpos
;
28051 struct glyph_row
*row
;
28053 if (vpos
>= w
->current_matrix
->nrows
28054 || hpos
>= w
->current_matrix
->matrix_w
)
28057 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28059 /* When the window is hscrolled, cursor hpos can legitimately be
28060 out of bounds, but we draw the cursor at the corresponding
28061 window margin in that case. */
28062 if (!row
->reversed_p
&& hpos
< 0)
28064 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28065 hpos
= row
->used
[TEXT_AREA
] - 1;
28068 display_and_set_cursor (w
, on
, hpos
, vpos
,
28069 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28075 /* Call update_window_cursor with parameter ON_P on all leaf windows
28076 in the window tree rooted at W. */
28079 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28083 if (WINDOWP (w
->contents
))
28084 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28086 update_window_cursor (w
, on_p
);
28088 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28094 Display the cursor on window W, or clear it, according to ON_P.
28095 Don't change the cursor's position. */
28098 x_update_cursor (struct frame
*f
, bool on_p
)
28100 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28105 Clear the cursor of window W to background color, and mark the
28106 cursor as not shown. This is used when the text where the cursor
28107 is about to be rewritten. */
28110 x_clear_cursor (struct window
*w
)
28112 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28113 update_window_cursor (w
, false);
28116 #endif /* HAVE_WINDOW_SYSTEM */
28118 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28121 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28122 int start_hpos
, int end_hpos
,
28123 enum draw_glyphs_face draw
)
28125 #ifdef HAVE_WINDOW_SYSTEM
28126 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28128 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28132 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28133 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28137 /* Display the active region described by mouse_face_* according to DRAW. */
28140 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28142 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28143 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28145 if (/* If window is in the process of being destroyed, don't bother
28147 w
->current_matrix
!= NULL
28148 /* Don't update mouse highlight if hidden. */
28149 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28150 /* Recognize when we are called to operate on rows that don't exist
28151 anymore. This can happen when a window is split. */
28152 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28154 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28155 struct glyph_row
*row
, *first
, *last
;
28157 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28158 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28160 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28162 int start_hpos
, end_hpos
, start_x
;
28164 /* For all but the first row, the highlight starts at column 0. */
28167 /* R2L rows have BEG and END in reversed order, but the
28168 screen drawing geometry is always left to right. So
28169 we need to mirror the beginning and end of the
28170 highlighted area in R2L rows. */
28171 if (!row
->reversed_p
)
28173 start_hpos
= hlinfo
->mouse_face_beg_col
;
28174 start_x
= hlinfo
->mouse_face_beg_x
;
28176 else if (row
== last
)
28178 start_hpos
= hlinfo
->mouse_face_end_col
;
28179 start_x
= hlinfo
->mouse_face_end_x
;
28187 else if (row
->reversed_p
&& row
== last
)
28189 start_hpos
= hlinfo
->mouse_face_end_col
;
28190 start_x
= hlinfo
->mouse_face_end_x
;
28200 if (!row
->reversed_p
)
28201 end_hpos
= hlinfo
->mouse_face_end_col
;
28202 else if (row
== first
)
28203 end_hpos
= hlinfo
->mouse_face_beg_col
;
28206 end_hpos
= row
->used
[TEXT_AREA
];
28207 if (draw
== DRAW_NORMAL_TEXT
)
28208 row
->fill_line_p
= true; /* Clear to end of line. */
28211 else if (row
->reversed_p
&& row
== first
)
28212 end_hpos
= hlinfo
->mouse_face_beg_col
;
28215 end_hpos
= row
->used
[TEXT_AREA
];
28216 if (draw
== DRAW_NORMAL_TEXT
)
28217 row
->fill_line_p
= true; /* Clear to end of line. */
28220 if (end_hpos
> start_hpos
)
28222 draw_row_with_mouse_face (w
, start_x
, row
,
28223 start_hpos
, end_hpos
, draw
);
28226 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28230 #ifdef HAVE_WINDOW_SYSTEM
28231 /* When we've written over the cursor, arrange for it to
28232 be displayed again. */
28233 if (FRAME_WINDOW_P (f
)
28234 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28236 int hpos
= w
->phys_cursor
.hpos
;
28238 /* When the window is hscrolled, cursor hpos can legitimately be
28239 out of bounds, but we draw the cursor at the corresponding
28240 window margin in that case. */
28241 if (!row
->reversed_p
&& hpos
< 0)
28243 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28244 hpos
= row
->used
[TEXT_AREA
] - 1;
28247 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28248 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28251 #endif /* HAVE_WINDOW_SYSTEM */
28254 #ifdef HAVE_WINDOW_SYSTEM
28255 /* Change the mouse cursor. */
28256 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28258 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28259 if (draw
== DRAW_NORMAL_TEXT
28260 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28261 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28264 if (draw
== DRAW_MOUSE_FACE
)
28265 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28267 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28269 #endif /* HAVE_WINDOW_SYSTEM */
28273 Clear out the mouse-highlighted active region.
28274 Redraw it un-highlighted first. Value is true if mouse
28275 face was actually drawn unhighlighted. */
28278 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28281 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28283 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28284 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28285 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28286 hlinfo
->mouse_face_window
= Qnil
;
28287 hlinfo
->mouse_face_overlay
= Qnil
;
28291 /* Return true if the coordinates HPOS and VPOS on windows W are
28292 within the mouse face on that window. */
28294 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28296 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28298 /* Quickly resolve the easy cases. */
28299 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28300 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28302 if (vpos
< hlinfo
->mouse_face_beg_row
28303 || vpos
> hlinfo
->mouse_face_end_row
)
28305 if (vpos
> hlinfo
->mouse_face_beg_row
28306 && vpos
< hlinfo
->mouse_face_end_row
)
28309 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28311 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28313 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28316 else if ((vpos
== hlinfo
->mouse_face_beg_row
28317 && hpos
>= hlinfo
->mouse_face_beg_col
)
28318 || (vpos
== hlinfo
->mouse_face_end_row
28319 && hpos
< hlinfo
->mouse_face_end_col
))
28324 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28326 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28329 else if ((vpos
== hlinfo
->mouse_face_beg_row
28330 && hpos
<= hlinfo
->mouse_face_beg_col
)
28331 || (vpos
== hlinfo
->mouse_face_end_row
28332 && hpos
> hlinfo
->mouse_face_end_col
))
28340 True if physical cursor of window W is within mouse face. */
28343 cursor_in_mouse_face_p (struct window
*w
)
28345 int hpos
= w
->phys_cursor
.hpos
;
28346 int vpos
= w
->phys_cursor
.vpos
;
28347 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28349 /* When the window is hscrolled, cursor hpos can legitimately be out
28350 of bounds, but we draw the cursor at the corresponding window
28351 margin in that case. */
28352 if (!row
->reversed_p
&& hpos
< 0)
28354 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28355 hpos
= row
->used
[TEXT_AREA
] - 1;
28357 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28362 /* Find the glyph rows START_ROW and END_ROW of window W that display
28363 characters between buffer positions START_CHARPOS and END_CHARPOS
28364 (excluding END_CHARPOS). DISP_STRING is a display string that
28365 covers these buffer positions. This is similar to
28366 row_containing_pos, but is more accurate when bidi reordering makes
28367 buffer positions change non-linearly with glyph rows. */
28369 rows_from_pos_range (struct window
*w
,
28370 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28371 Lisp_Object disp_string
,
28372 struct glyph_row
**start
, struct glyph_row
**end
)
28374 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28375 int last_y
= window_text_bottom_y (w
);
28376 struct glyph_row
*row
;
28381 while (!first
->enabled_p
28382 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28385 /* Find the START row. */
28387 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28390 /* A row can potentially be the START row if the range of the
28391 characters it displays intersects the range
28392 [START_CHARPOS..END_CHARPOS). */
28393 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28394 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28395 /* See the commentary in row_containing_pos, for the
28396 explanation of the complicated way to check whether
28397 some position is beyond the end of the characters
28398 displayed by a row. */
28399 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28400 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28401 && !row
->ends_at_zv_p
28402 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28403 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28404 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28405 && !row
->ends_at_zv_p
28406 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28408 /* Found a candidate row. Now make sure at least one of the
28409 glyphs it displays has a charpos from the range
28410 [START_CHARPOS..END_CHARPOS).
28412 This is not obvious because bidi reordering could make
28413 buffer positions of a row be 1,2,3,102,101,100, and if we
28414 want to highlight characters in [50..60), we don't want
28415 this row, even though [50..60) does intersect [1..103),
28416 the range of character positions given by the row's start
28417 and end positions. */
28418 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28419 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28423 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28424 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28425 /* A glyph that comes from DISP_STRING is by
28426 definition to be highlighted. */
28427 || EQ (g
->object
, disp_string
))
28436 /* Find the END row. */
28438 /* If the last row is partially visible, start looking for END
28439 from that row, instead of starting from FIRST. */
28440 && !(row
->enabled_p
28441 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28443 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28445 struct glyph_row
*next
= row
+ 1;
28446 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28448 if (!next
->enabled_p
28449 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28450 /* The first row >= START whose range of displayed characters
28451 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28452 is the row END + 1. */
28453 || (start_charpos
< next_start
28454 && end_charpos
< next_start
)
28455 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28456 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28457 && !next
->ends_at_zv_p
28458 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28459 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28460 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28461 && !next
->ends_at_zv_p
28462 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28469 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28470 but none of the characters it displays are in the range, it is
28472 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28473 struct glyph
*s
= g
;
28474 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28478 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28479 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28480 /* If the buffer position of the first glyph in
28481 the row is equal to END_CHARPOS, it means
28482 the last character to be highlighted is the
28483 newline of ROW, and we must consider NEXT as
28485 || (((!next
->reversed_p
&& g
== s
)
28486 || (next
->reversed_p
&& g
== e
- 1))
28487 && (g
->charpos
== end_charpos
28488 /* Special case for when NEXT is an
28489 empty line at ZV. */
28490 || (g
->charpos
== -1
28491 && !row
->ends_at_zv_p
28492 && next_start
== end_charpos
)))))
28493 /* A glyph that comes from DISP_STRING is by
28494 definition to be highlighted. */
28495 || EQ (g
->object
, disp_string
))
28504 /* The first row that ends at ZV must be the last to be
28506 else if (next
->ends_at_zv_p
)
28515 /* This function sets the mouse_face_* elements of HLINFO, assuming
28516 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28517 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28518 for the overlay or run of text properties specifying the mouse
28519 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28520 before-string and after-string that must also be highlighted.
28521 DISP_STRING, if non-nil, is a display string that may cover some
28522 or all of the highlighted text. */
28525 mouse_face_from_buffer_pos (Lisp_Object window
,
28526 Mouse_HLInfo
*hlinfo
,
28527 ptrdiff_t mouse_charpos
,
28528 ptrdiff_t start_charpos
,
28529 ptrdiff_t end_charpos
,
28530 Lisp_Object before_string
,
28531 Lisp_Object after_string
,
28532 Lisp_Object disp_string
)
28534 struct window
*w
= XWINDOW (window
);
28535 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28536 struct glyph_row
*r1
, *r2
;
28537 struct glyph
*glyph
, *end
;
28538 ptrdiff_t ignore
, pos
;
28541 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28542 eassert (NILP (before_string
) || STRINGP (before_string
));
28543 eassert (NILP (after_string
) || STRINGP (after_string
));
28545 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28546 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28548 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28549 /* If the before-string or display-string contains newlines,
28550 rows_from_pos_range skips to its last row. Move back. */
28551 if (!NILP (before_string
) || !NILP (disp_string
))
28553 struct glyph_row
*prev
;
28554 while ((prev
= r1
- 1, prev
>= first
)
28555 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28556 && prev
->used
[TEXT_AREA
] > 0)
28558 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28559 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28560 while (--glyph
>= beg
&& NILP (glyph
->object
));
28562 || !(EQ (glyph
->object
, before_string
)
28563 || EQ (glyph
->object
, disp_string
)))
28570 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28571 hlinfo
->mouse_face_past_end
= true;
28573 else if (!NILP (after_string
))
28575 /* If the after-string has newlines, advance to its last row. */
28576 struct glyph_row
*next
;
28577 struct glyph_row
*last
28578 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28580 for (next
= r2
+ 1;
28582 && next
->used
[TEXT_AREA
] > 0
28583 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28587 /* The rest of the display engine assumes that mouse_face_beg_row is
28588 either above mouse_face_end_row or identical to it. But with
28589 bidi-reordered continued lines, the row for START_CHARPOS could
28590 be below the row for END_CHARPOS. If so, swap the rows and store
28591 them in correct order. */
28594 struct glyph_row
*tem
= r2
;
28600 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28601 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28603 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28604 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28605 could be anywhere in the row and in any order. The strategy
28606 below is to find the leftmost and the rightmost glyph that
28607 belongs to either of these 3 strings, or whose position is
28608 between START_CHARPOS and END_CHARPOS, and highlight all the
28609 glyphs between those two. This may cover more than just the text
28610 between START_CHARPOS and END_CHARPOS if the range of characters
28611 strides the bidi level boundary, e.g. if the beginning is in R2L
28612 text while the end is in L2R text or vice versa. */
28613 if (!r1
->reversed_p
)
28615 /* This row is in a left to right paragraph. Scan it left to
28617 glyph
= r1
->glyphs
[TEXT_AREA
];
28618 end
= glyph
+ r1
->used
[TEXT_AREA
];
28621 /* Skip truncation glyphs at the start of the glyph row. */
28622 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28624 && NILP (glyph
->object
)
28625 && glyph
->charpos
< 0;
28627 x
+= glyph
->pixel_width
;
28629 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28630 or DISP_STRING, and the first glyph from buffer whose
28631 position is between START_CHARPOS and END_CHARPOS. */
28633 && !NILP (glyph
->object
)
28634 && !EQ (glyph
->object
, disp_string
)
28635 && !(BUFFERP (glyph
->object
)
28636 && (glyph
->charpos
>= start_charpos
28637 && glyph
->charpos
< end_charpos
));
28640 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28641 are present at buffer positions between START_CHARPOS and
28642 END_CHARPOS, or if they come from an overlay. */
28643 if (EQ (glyph
->object
, before_string
))
28645 pos
= string_buffer_position (before_string
,
28647 /* If pos == 0, it means before_string came from an
28648 overlay, not from a buffer position. */
28649 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28652 else if (EQ (glyph
->object
, after_string
))
28654 pos
= string_buffer_position (after_string
, end_charpos
);
28655 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28658 x
+= glyph
->pixel_width
;
28660 hlinfo
->mouse_face_beg_x
= x
;
28661 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28665 /* This row is in a right to left paragraph. Scan it right to
28669 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28670 glyph
= end
+ r1
->used
[TEXT_AREA
];
28672 /* Skip truncation glyphs at the start of the glyph row. */
28673 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28675 && NILP (glyph
->object
)
28676 && glyph
->charpos
< 0;
28680 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28681 or DISP_STRING, and the first glyph from buffer whose
28682 position is between START_CHARPOS and END_CHARPOS. */
28684 && !NILP (glyph
->object
)
28685 && !EQ (glyph
->object
, disp_string
)
28686 && !(BUFFERP (glyph
->object
)
28687 && (glyph
->charpos
>= start_charpos
28688 && glyph
->charpos
< end_charpos
));
28691 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28692 are present at buffer positions between START_CHARPOS and
28693 END_CHARPOS, or if they come from an overlay. */
28694 if (EQ (glyph
->object
, before_string
))
28696 pos
= string_buffer_position (before_string
, start_charpos
);
28697 /* If pos == 0, it means before_string came from an
28698 overlay, not from a buffer position. */
28699 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28702 else if (EQ (glyph
->object
, after_string
))
28704 pos
= string_buffer_position (after_string
, end_charpos
);
28705 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28710 glyph
++; /* first glyph to the right of the highlighted area */
28711 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28712 x
+= g
->pixel_width
;
28713 hlinfo
->mouse_face_beg_x
= x
;
28714 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28717 /* If the highlight ends in a different row, compute GLYPH and END
28718 for the end row. Otherwise, reuse the values computed above for
28719 the row where the highlight begins. */
28722 if (!r2
->reversed_p
)
28724 glyph
= r2
->glyphs
[TEXT_AREA
];
28725 end
= glyph
+ r2
->used
[TEXT_AREA
];
28730 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28731 glyph
= end
+ r2
->used
[TEXT_AREA
];
28735 if (!r2
->reversed_p
)
28737 /* Skip truncation and continuation glyphs near the end of the
28738 row, and also blanks and stretch glyphs inserted by
28739 extend_face_to_end_of_line. */
28741 && NILP ((end
- 1)->object
))
28743 /* Scan the rest of the glyph row from the end, looking for the
28744 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28745 DISP_STRING, or whose position is between START_CHARPOS
28749 && !NILP (end
->object
)
28750 && !EQ (end
->object
, disp_string
)
28751 && !(BUFFERP (end
->object
)
28752 && (end
->charpos
>= start_charpos
28753 && end
->charpos
< end_charpos
));
28756 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28757 are present at buffer positions between START_CHARPOS and
28758 END_CHARPOS, or if they come from an overlay. */
28759 if (EQ (end
->object
, before_string
))
28761 pos
= string_buffer_position (before_string
, start_charpos
);
28762 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28765 else if (EQ (end
->object
, after_string
))
28767 pos
= string_buffer_position (after_string
, end_charpos
);
28768 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28772 /* Find the X coordinate of the last glyph to be highlighted. */
28773 for (; glyph
<= end
; ++glyph
)
28774 x
+= glyph
->pixel_width
;
28776 hlinfo
->mouse_face_end_x
= x
;
28777 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28781 /* Skip truncation and continuation glyphs near the end of the
28782 row, and also blanks and stretch glyphs inserted by
28783 extend_face_to_end_of_line. */
28787 && NILP (end
->object
))
28789 x
+= end
->pixel_width
;
28792 /* Scan the rest of the glyph row from the end, looking for the
28793 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28794 DISP_STRING, or whose position is between START_CHARPOS
28798 && !NILP (end
->object
)
28799 && !EQ (end
->object
, disp_string
)
28800 && !(BUFFERP (end
->object
)
28801 && (end
->charpos
>= start_charpos
28802 && end
->charpos
< end_charpos
));
28805 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28806 are present at buffer positions between START_CHARPOS and
28807 END_CHARPOS, or if they come from an overlay. */
28808 if (EQ (end
->object
, before_string
))
28810 pos
= string_buffer_position (before_string
, start_charpos
);
28811 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28814 else if (EQ (end
->object
, after_string
))
28816 pos
= string_buffer_position (after_string
, end_charpos
);
28817 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28820 x
+= end
->pixel_width
;
28822 /* If we exited the above loop because we arrived at the last
28823 glyph of the row, and its buffer position is still not in
28824 range, it means the last character in range is the preceding
28825 newline. Bump the end column and x values to get past the
28828 && BUFFERP (end
->object
)
28829 && (end
->charpos
< start_charpos
28830 || end
->charpos
>= end_charpos
))
28832 x
+= end
->pixel_width
;
28835 hlinfo
->mouse_face_end_x
= x
;
28836 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28839 hlinfo
->mouse_face_window
= window
;
28840 hlinfo
->mouse_face_face_id
28841 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28843 !hlinfo
->mouse_face_hidden
, -1);
28844 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28847 /* The following function is not used anymore (replaced with
28848 mouse_face_from_string_pos), but I leave it here for the time
28849 being, in case someone would. */
28851 #if false /* not used */
28853 /* Find the position of the glyph for position POS in OBJECT in
28854 window W's current matrix, and return in *X, *Y the pixel
28855 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28857 RIGHT_P means return the position of the right edge of the glyph.
28858 !RIGHT_P means return the left edge position.
28860 If no glyph for POS exists in the matrix, return the position of
28861 the glyph with the next smaller position that is in the matrix, if
28862 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28863 exists in the matrix, return the position of the glyph with the
28864 next larger position in OBJECT.
28866 Value is true if a glyph was found. */
28869 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28870 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28872 int yb
= window_text_bottom_y (w
);
28873 struct glyph_row
*r
;
28874 struct glyph
*best_glyph
= NULL
;
28875 struct glyph_row
*best_row
= NULL
;
28878 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28879 r
->enabled_p
&& r
->y
< yb
;
28882 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28883 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28886 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28887 if (EQ (g
->object
, object
))
28889 if (g
->charpos
== pos
)
28896 else if (best_glyph
== NULL
28897 || ((eabs (g
->charpos
- pos
)
28898 < eabs (best_glyph
->charpos
- pos
))
28901 : g
->charpos
> pos
)))
28915 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28919 *x
+= best_glyph
->pixel_width
;
28924 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28927 return best_glyph
!= NULL
;
28929 #endif /* not used */
28931 /* Find the positions of the first and the last glyphs in window W's
28932 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28933 (assumed to be a string), and return in HLINFO's mouse_face_*
28934 members the pixel and column/row coordinates of those glyphs. */
28937 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28938 Lisp_Object object
,
28939 ptrdiff_t startpos
, ptrdiff_t endpos
)
28941 int yb
= window_text_bottom_y (w
);
28942 struct glyph_row
*r
;
28943 struct glyph
*g
, *e
;
28945 bool found
= false;
28947 /* Find the glyph row with at least one position in the range
28948 [STARTPOS..ENDPOS), and the first glyph in that row whose
28949 position belongs to that range. */
28950 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28951 r
->enabled_p
&& r
->y
< yb
;
28954 if (!r
->reversed_p
)
28956 g
= r
->glyphs
[TEXT_AREA
];
28957 e
= g
+ r
->used
[TEXT_AREA
];
28958 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28959 if (EQ (g
->object
, object
)
28960 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28962 hlinfo
->mouse_face_beg_row
28963 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28964 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28965 hlinfo
->mouse_face_beg_x
= gx
;
28974 e
= r
->glyphs
[TEXT_AREA
];
28975 g
= e
+ r
->used
[TEXT_AREA
];
28976 for ( ; g
> e
; --g
)
28977 if (EQ ((g
-1)->object
, object
)
28978 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28980 hlinfo
->mouse_face_beg_row
28981 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28982 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28983 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28984 gx
+= g1
->pixel_width
;
28985 hlinfo
->mouse_face_beg_x
= gx
;
28997 /* Starting with the next row, look for the first row which does NOT
28998 include any glyphs whose positions are in the range. */
28999 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29001 g
= r
->glyphs
[TEXT_AREA
];
29002 e
= g
+ r
->used
[TEXT_AREA
];
29004 for ( ; g
< e
; ++g
)
29005 if (EQ (g
->object
, object
)
29006 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29015 /* The highlighted region ends on the previous row. */
29018 /* Set the end row. */
29019 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29021 /* Compute and set the end column and the end column's horizontal
29022 pixel coordinate. */
29023 if (!r
->reversed_p
)
29025 g
= r
->glyphs
[TEXT_AREA
];
29026 e
= g
+ r
->used
[TEXT_AREA
];
29027 for ( ; e
> g
; --e
)
29028 if (EQ ((e
-1)->object
, object
)
29029 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29031 hlinfo
->mouse_face_end_col
= e
- g
;
29033 for (gx
= r
->x
; g
< e
; ++g
)
29034 gx
+= g
->pixel_width
;
29035 hlinfo
->mouse_face_end_x
= gx
;
29039 e
= r
->glyphs
[TEXT_AREA
];
29040 g
= e
+ r
->used
[TEXT_AREA
];
29041 for (gx
= r
->x
; e
< g
; ++e
)
29043 if (EQ (e
->object
, object
)
29044 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29046 gx
+= e
->pixel_width
;
29048 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29049 hlinfo
->mouse_face_end_x
= gx
;
29053 #ifdef HAVE_WINDOW_SYSTEM
29055 /* See if position X, Y is within a hot-spot of an image. */
29058 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29060 if (!CONSP (hot_spot
))
29063 if (EQ (XCAR (hot_spot
), Qrect
))
29065 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29066 Lisp_Object rect
= XCDR (hot_spot
);
29070 if (!CONSP (XCAR (rect
)))
29072 if (!CONSP (XCDR (rect
)))
29074 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29076 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29078 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29080 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29084 else if (EQ (XCAR (hot_spot
), Qcircle
))
29086 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29087 Lisp_Object circ
= XCDR (hot_spot
);
29088 Lisp_Object lr
, lx0
, ly0
;
29090 && CONSP (XCAR (circ
))
29091 && (lr
= XCDR (circ
), NUMBERP (lr
))
29092 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29093 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29095 double r
= XFLOATINT (lr
);
29096 double dx
= XINT (lx0
) - x
;
29097 double dy
= XINT (ly0
) - y
;
29098 return (dx
* dx
+ dy
* dy
<= r
* r
);
29101 else if (EQ (XCAR (hot_spot
), Qpoly
))
29103 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29104 if (VECTORP (XCDR (hot_spot
)))
29106 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29107 Lisp_Object
*poly
= v
->contents
;
29108 ptrdiff_t n
= v
->header
.size
;
29110 bool inside
= false;
29111 Lisp_Object lx
, ly
;
29114 /* Need an even number of coordinates, and at least 3 edges. */
29115 if (n
< 6 || n
& 1)
29118 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29119 If count is odd, we are inside polygon. Pixels on edges
29120 may or may not be included depending on actual geometry of the
29122 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29123 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29125 x0
= XINT (lx
), y0
= XINT (ly
);
29126 for (i
= 0; i
< n
; i
+= 2)
29128 int x1
= x0
, y1
= y0
;
29129 if ((lx
= poly
[i
], !INTEGERP (lx
))
29130 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29132 x0
= XINT (lx
), y0
= XINT (ly
);
29134 /* Does this segment cross the X line? */
29142 if (y
> y0
&& y
> y1
)
29144 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29154 find_hot_spot (Lisp_Object map
, int x
, int y
)
29156 while (CONSP (map
))
29158 if (CONSP (XCAR (map
))
29159 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29167 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29169 doc
: /* Lookup in image map MAP coordinates X and Y.
29170 An image map is an alist where each element has the format (AREA ID PLIST).
29171 An AREA is specified as either a rectangle, a circle, or a polygon:
29172 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29173 pixel coordinates of the upper left and bottom right corners.
29174 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29175 and the radius of the circle; r may be a float or integer.
29176 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29177 vector describes one corner in the polygon.
29178 Returns the alist element for the first matching AREA in MAP. */)
29179 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29187 return find_hot_spot (map
,
29188 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29189 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29193 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29195 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29197 /* Do not change cursor shape while dragging mouse. */
29198 if (EQ (do_mouse_tracking
, Qdragging
))
29201 if (!NILP (pointer
))
29203 if (EQ (pointer
, Qarrow
))
29204 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29205 else if (EQ (pointer
, Qhand
))
29206 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29207 else if (EQ (pointer
, Qtext
))
29208 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29209 else if (EQ (pointer
, intern ("hdrag")))
29210 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29211 else if (EQ (pointer
, intern ("nhdrag")))
29212 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29213 #ifdef HAVE_X_WINDOWS
29214 else if (EQ (pointer
, intern ("vdrag")))
29215 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29217 else if (EQ (pointer
, intern ("hourglass")))
29218 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29219 else if (EQ (pointer
, Qmodeline
))
29220 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29222 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29225 if (cursor
!= No_Cursor
)
29226 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29229 #endif /* HAVE_WINDOW_SYSTEM */
29231 /* Take proper action when mouse has moved to the mode or header line
29232 or marginal area AREA of window W, x-position X and y-position Y.
29233 X is relative to the start of the text display area of W, so the
29234 width of bitmap areas and scroll bars must be subtracted to get a
29235 position relative to the start of the mode line. */
29238 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29239 enum window_part area
)
29241 struct window
*w
= XWINDOW (window
);
29242 struct frame
*f
= XFRAME (w
->frame
);
29243 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29244 #ifdef HAVE_WINDOW_SYSTEM
29245 Display_Info
*dpyinfo
;
29247 Cursor cursor
= No_Cursor
;
29248 Lisp_Object pointer
= Qnil
;
29249 int dx
, dy
, width
, height
;
29251 Lisp_Object string
, object
= Qnil
;
29252 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29254 Lisp_Object mouse_face
;
29255 int original_x_pixel
= x
;
29256 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29257 struct glyph_row
*row
IF_LINT (= 0);
29259 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29264 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29265 returns them in row/column units! */
29266 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29267 &object
, &dx
, &dy
, &width
, &height
);
29269 row
= (area
== ON_MODE_LINE
29270 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29271 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29273 /* Find the glyph under the mouse pointer. */
29274 if (row
->mode_line_p
&& row
->enabled_p
)
29276 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29277 end
= glyph
+ row
->used
[TEXT_AREA
];
29279 for (x0
= original_x_pixel
;
29280 glyph
< end
&& x0
>= glyph
->pixel_width
;
29282 x0
-= glyph
->pixel_width
;
29290 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29291 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29292 returns them in row/column units! */
29293 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29294 &object
, &dx
, &dy
, &width
, &height
);
29299 #ifdef HAVE_WINDOW_SYSTEM
29300 if (IMAGEP (object
))
29302 Lisp_Object image_map
, hotspot
;
29303 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29305 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29307 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29311 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29312 If so, we could look for mouse-enter, mouse-leave
29313 properties in PLIST (and do something...). */
29314 hotspot
= XCDR (hotspot
);
29315 if (CONSP (hotspot
)
29316 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29318 pointer
= Fplist_get (plist
, Qpointer
);
29319 if (NILP (pointer
))
29321 help
= Fplist_get (plist
, Qhelp_echo
);
29324 help_echo_string
= help
;
29325 XSETWINDOW (help_echo_window
, w
);
29326 help_echo_object
= w
->contents
;
29327 help_echo_pos
= charpos
;
29331 if (NILP (pointer
))
29332 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29334 #endif /* HAVE_WINDOW_SYSTEM */
29336 if (STRINGP (string
))
29337 pos
= make_number (charpos
);
29339 /* Set the help text and mouse pointer. If the mouse is on a part
29340 of the mode line without any text (e.g. past the right edge of
29341 the mode line text), use the default help text and pointer. */
29342 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29344 /* Arrange to display the help by setting the global variables
29345 help_echo_string, help_echo_object, and help_echo_pos. */
29348 if (STRINGP (string
))
29349 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29353 help_echo_string
= help
;
29354 XSETWINDOW (help_echo_window
, w
);
29355 help_echo_object
= string
;
29356 help_echo_pos
= charpos
;
29358 else if (area
== ON_MODE_LINE
)
29360 Lisp_Object default_help
29361 = buffer_local_value (Qmode_line_default_help_echo
,
29364 if (STRINGP (default_help
))
29366 help_echo_string
= default_help
;
29367 XSETWINDOW (help_echo_window
, w
);
29368 help_echo_object
= Qnil
;
29369 help_echo_pos
= -1;
29374 #ifdef HAVE_WINDOW_SYSTEM
29375 /* Change the mouse pointer according to what is under it. */
29376 if (FRAME_WINDOW_P (f
))
29378 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29380 || NILP (Vresize_mini_windows
));
29382 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29383 if (STRINGP (string
))
29385 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29387 if (NILP (pointer
))
29388 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29390 /* Change the mouse pointer according to what is under X/Y. */
29392 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29395 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29396 if (!KEYMAPP (map
))
29397 map
= Fget_text_property (pos
, Qkeymap
, string
);
29398 if (!KEYMAPP (map
) && draggable
)
29399 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29402 else if (draggable
)
29403 /* Default mode-line pointer. */
29404 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29409 /* Change the mouse face according to what is under X/Y. */
29410 bool mouse_face_shown
= false;
29411 if (STRINGP (string
))
29413 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29414 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29415 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29420 struct glyph
* tmp_glyph
;
29424 int total_pixel_width
;
29425 ptrdiff_t begpos
, endpos
, ignore
;
29429 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29430 Qmouse_face
, string
, Qnil
);
29436 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29438 endpos
= SCHARS (string
);
29442 /* Calculate the glyph position GPOS of GLYPH in the
29443 displayed string, relative to the beginning of the
29444 highlighted part of the string.
29446 Note: GPOS is different from CHARPOS. CHARPOS is the
29447 position of GLYPH in the internal string object. A mode
29448 line string format has structures which are converted to
29449 a flattened string by the Emacs Lisp interpreter. The
29450 internal string is an element of those structures. The
29451 displayed string is the flattened string. */
29452 tmp_glyph
= row_start_glyph
;
29453 while (tmp_glyph
< glyph
29454 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29455 && begpos
<= tmp_glyph
->charpos
29456 && tmp_glyph
->charpos
< endpos
)))
29458 gpos
= glyph
- tmp_glyph
;
29460 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29461 the highlighted part of the displayed string to which
29462 GLYPH belongs. Note: GSEQ_LENGTH is different from
29463 SCHARS (STRING), because the latter returns the length of
29464 the internal string. */
29465 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29467 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29468 && begpos
<= tmp_glyph
->charpos
29469 && tmp_glyph
->charpos
< endpos
));
29472 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29474 /* Calculate the total pixel width of all the glyphs between
29475 the beginning of the highlighted area and GLYPH. */
29476 total_pixel_width
= 0;
29477 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29478 total_pixel_width
+= tmp_glyph
->pixel_width
;
29480 /* Pre calculation of re-rendering position. Note: X is in
29481 column units here, after the call to mode_line_string or
29482 marginal_area_string. */
29484 vpos
= (area
== ON_MODE_LINE
29485 ? (w
->current_matrix
)->nrows
- 1
29488 /* If GLYPH's position is included in the region that is
29489 already drawn in mouse face, we have nothing to do. */
29490 if ( EQ (window
, hlinfo
->mouse_face_window
)
29491 && (!row
->reversed_p
29492 ? (hlinfo
->mouse_face_beg_col
<= hpos
29493 && hpos
< hlinfo
->mouse_face_end_col
)
29494 /* In R2L rows we swap BEG and END, see below. */
29495 : (hlinfo
->mouse_face_end_col
<= hpos
29496 && hpos
< hlinfo
->mouse_face_beg_col
))
29497 && hlinfo
->mouse_face_beg_row
== vpos
)
29500 if (clear_mouse_face (hlinfo
))
29501 cursor
= No_Cursor
;
29503 if (!row
->reversed_p
)
29505 hlinfo
->mouse_face_beg_col
= hpos
;
29506 hlinfo
->mouse_face_beg_x
= original_x_pixel
29507 - (total_pixel_width
+ dx
);
29508 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29509 hlinfo
->mouse_face_end_x
= 0;
29513 /* In R2L rows, show_mouse_face expects BEG and END
29514 coordinates to be swapped. */
29515 hlinfo
->mouse_face_end_col
= hpos
;
29516 hlinfo
->mouse_face_end_x
= original_x_pixel
29517 - (total_pixel_width
+ dx
);
29518 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29519 hlinfo
->mouse_face_beg_x
= 0;
29522 hlinfo
->mouse_face_beg_row
= vpos
;
29523 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29524 hlinfo
->mouse_face_past_end
= false;
29525 hlinfo
->mouse_face_window
= window
;
29527 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29532 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29533 mouse_face_shown
= true;
29535 if (NILP (pointer
))
29540 /* If mouse-face doesn't need to be shown, clear any existing
29542 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29543 clear_mouse_face (hlinfo
);
29545 #ifdef HAVE_WINDOW_SYSTEM
29546 if (FRAME_WINDOW_P (f
))
29547 define_frame_cursor1 (f
, cursor
, pointer
);
29553 Take proper action when the mouse has moved to position X, Y on
29554 frame F with regards to highlighting portions of display that have
29555 mouse-face properties. Also de-highlight portions of display where
29556 the mouse was before, set the mouse pointer shape as appropriate
29557 for the mouse coordinates, and activate help echo (tooltips).
29558 X and Y can be negative or out of range. */
29561 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29563 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29564 enum window_part part
= ON_NOTHING
;
29565 Lisp_Object window
;
29567 Cursor cursor
= No_Cursor
;
29568 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29571 /* When a menu is active, don't highlight because this looks odd. */
29572 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29573 if (popup_activated ())
29577 if (!f
->glyphs_initialized_p
29578 || f
->pointer_invisible
)
29581 hlinfo
->mouse_face_mouse_x
= x
;
29582 hlinfo
->mouse_face_mouse_y
= y
;
29583 hlinfo
->mouse_face_mouse_frame
= f
;
29585 if (hlinfo
->mouse_face_defer
)
29588 /* Which window is that in? */
29589 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29591 /* If displaying active text in another window, clear that. */
29592 if (! EQ (window
, hlinfo
->mouse_face_window
)
29593 /* Also clear if we move out of text area in same window. */
29594 || (!NILP (hlinfo
->mouse_face_window
)
29597 && part
!= ON_MODE_LINE
29598 && part
!= ON_HEADER_LINE
))
29599 clear_mouse_face (hlinfo
);
29601 /* Not on a window -> return. */
29602 if (!WINDOWP (window
))
29605 /* Reset help_echo_string. It will get recomputed below. */
29606 help_echo_string
= Qnil
;
29608 /* Convert to window-relative pixel coordinates. */
29609 w
= XWINDOW (window
);
29610 frame_to_window_pixel_xy (w
, &x
, &y
);
29612 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29613 /* Handle tool-bar window differently since it doesn't display a
29615 if (EQ (window
, f
->tool_bar_window
))
29617 note_tool_bar_highlight (f
, x
, y
);
29622 /* Mouse is on the mode, header line or margin? */
29623 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29624 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29626 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29628 #ifdef HAVE_WINDOW_SYSTEM
29629 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29631 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29632 /* Show non-text cursor (Bug#16647). */
29640 #ifdef HAVE_WINDOW_SYSTEM
29641 if (part
== ON_VERTICAL_BORDER
)
29643 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29644 help_echo_string
= build_string ("drag-mouse-1: resize");
29646 else if (part
== ON_RIGHT_DIVIDER
)
29648 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29649 help_echo_string
= build_string ("drag-mouse-1: resize");
29651 else if (part
== ON_BOTTOM_DIVIDER
)
29652 if (! WINDOW_BOTTOMMOST_P (w
)
29654 || NILP (Vresize_mini_windows
))
29656 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29657 help_echo_string
= build_string ("drag-mouse-1: resize");
29660 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29661 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29662 || part
== ON_VERTICAL_SCROLL_BAR
29663 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29664 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29666 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29669 /* Are we in a window whose display is up to date?
29670 And verify the buffer's text has not changed. */
29671 b
= XBUFFER (w
->contents
);
29672 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29674 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29676 struct glyph
*glyph
;
29677 Lisp_Object object
;
29678 Lisp_Object mouse_face
= Qnil
, position
;
29679 Lisp_Object
*overlay_vec
= NULL
;
29680 ptrdiff_t i
, noverlays
;
29681 struct buffer
*obuf
;
29682 ptrdiff_t obegv
, ozv
;
29685 /* Find the glyph under X/Y. */
29686 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29688 #ifdef HAVE_WINDOW_SYSTEM
29689 /* Look for :pointer property on image. */
29690 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29692 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29693 if (img
!= NULL
&& IMAGEP (img
->spec
))
29695 Lisp_Object image_map
, hotspot
;
29696 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29698 && (hotspot
= find_hot_spot (image_map
,
29699 glyph
->slice
.img
.x
+ dx
,
29700 glyph
->slice
.img
.y
+ dy
),
29702 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29706 /* Could check XCAR (hotspot) to see if we enter/leave
29708 If so, we could look for mouse-enter, mouse-leave
29709 properties in PLIST (and do something...). */
29710 hotspot
= XCDR (hotspot
);
29711 if (CONSP (hotspot
)
29712 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29714 pointer
= Fplist_get (plist
, Qpointer
);
29715 if (NILP (pointer
))
29717 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29718 if (!NILP (help_echo_string
))
29720 help_echo_window
= window
;
29721 help_echo_object
= glyph
->object
;
29722 help_echo_pos
= glyph
->charpos
;
29726 if (NILP (pointer
))
29727 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29730 #endif /* HAVE_WINDOW_SYSTEM */
29732 /* Clear mouse face if X/Y not over text. */
29734 || area
!= TEXT_AREA
29735 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29736 /* Glyph's OBJECT is nil for glyphs inserted by the
29737 display engine for its internal purposes, like truncation
29738 and continuation glyphs and blanks beyond the end of
29739 line's text on text terminals. If we are over such a
29740 glyph, we are not over any text. */
29741 || NILP (glyph
->object
)
29742 /* R2L rows have a stretch glyph at their front, which
29743 stands for no text, whereas L2R rows have no glyphs at
29744 all beyond the end of text. Treat such stretch glyphs
29745 like we do with NULL glyphs in L2R rows. */
29746 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29747 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29748 && glyph
->type
== STRETCH_GLYPH
29749 && glyph
->avoid_cursor_p
))
29751 if (clear_mouse_face (hlinfo
))
29752 cursor
= No_Cursor
;
29753 #ifdef HAVE_WINDOW_SYSTEM
29754 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29756 if (area
!= TEXT_AREA
)
29757 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29759 pointer
= Vvoid_text_area_pointer
;
29765 pos
= glyph
->charpos
;
29766 object
= glyph
->object
;
29767 if (!STRINGP (object
) && !BUFFERP (object
))
29770 /* If we get an out-of-range value, return now; avoid an error. */
29771 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29774 /* Make the window's buffer temporarily current for
29775 overlays_at and compute_char_face. */
29776 obuf
= current_buffer
;
29777 current_buffer
= b
;
29783 /* Is this char mouse-active or does it have help-echo? */
29784 position
= make_number (pos
);
29788 if (BUFFERP (object
))
29790 /* Put all the overlays we want in a vector in overlay_vec. */
29791 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29792 /* Sort overlays into increasing priority order. */
29793 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29798 if (NILP (Vmouse_highlight
))
29800 clear_mouse_face (hlinfo
);
29801 goto check_help_echo
;
29804 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29807 cursor
= No_Cursor
;
29809 /* Check mouse-face highlighting. */
29811 /* If there exists an overlay with mouse-face overlapping
29812 the one we are currently highlighting, we have to
29813 check if we enter the overlapping overlay, and then
29814 highlight only that. */
29815 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29816 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29818 /* Find the highest priority overlay with a mouse-face. */
29819 Lisp_Object overlay
= Qnil
;
29820 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29822 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29823 if (!NILP (mouse_face
))
29824 overlay
= overlay_vec
[i
];
29827 /* If we're highlighting the same overlay as before, there's
29828 no need to do that again. */
29829 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29830 goto check_help_echo
;
29831 hlinfo
->mouse_face_overlay
= overlay
;
29833 /* Clear the display of the old active region, if any. */
29834 if (clear_mouse_face (hlinfo
))
29835 cursor
= No_Cursor
;
29837 /* If no overlay applies, get a text property. */
29838 if (NILP (overlay
))
29839 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29841 /* Next, compute the bounds of the mouse highlighting and
29843 if (!NILP (mouse_face
) && STRINGP (object
))
29845 /* The mouse-highlighting comes from a display string
29846 with a mouse-face. */
29850 s
= Fprevious_single_property_change
29851 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29852 e
= Fnext_single_property_change
29853 (position
, Qmouse_face
, object
, Qnil
);
29855 s
= make_number (0);
29857 e
= make_number (SCHARS (object
));
29858 mouse_face_from_string_pos (w
, hlinfo
, object
,
29859 XINT (s
), XINT (e
));
29860 hlinfo
->mouse_face_past_end
= false;
29861 hlinfo
->mouse_face_window
= window
;
29862 hlinfo
->mouse_face_face_id
29863 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29864 glyph
->face_id
, true);
29865 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29866 cursor
= No_Cursor
;
29870 /* The mouse-highlighting, if any, comes from an overlay
29871 or text property in the buffer. */
29872 Lisp_Object buffer
IF_LINT (= Qnil
);
29873 Lisp_Object disp_string
IF_LINT (= Qnil
);
29875 if (STRINGP (object
))
29877 /* If we are on a display string with no mouse-face,
29878 check if the text under it has one. */
29879 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29880 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29881 pos
= string_buffer_position (object
, start
);
29884 mouse_face
= get_char_property_and_overlay
29885 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29886 buffer
= w
->contents
;
29887 disp_string
= object
;
29893 disp_string
= Qnil
;
29896 if (!NILP (mouse_face
))
29898 Lisp_Object before
, after
;
29899 Lisp_Object before_string
, after_string
;
29900 /* To correctly find the limits of mouse highlight
29901 in a bidi-reordered buffer, we must not use the
29902 optimization of limiting the search in
29903 previous-single-property-change and
29904 next-single-property-change, because
29905 rows_from_pos_range needs the real start and end
29906 positions to DTRT in this case. That's because
29907 the first row visible in a window does not
29908 necessarily display the character whose position
29909 is the smallest. */
29911 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29912 ? Fmarker_position (w
->start
)
29915 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29916 ? make_number (BUF_Z (XBUFFER (buffer
))
29917 - w
->window_end_pos
)
29920 if (NILP (overlay
))
29922 /* Handle the text property case. */
29923 before
= Fprevious_single_property_change
29924 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29925 after
= Fnext_single_property_change
29926 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29927 before_string
= after_string
= Qnil
;
29931 /* Handle the overlay case. */
29932 before
= Foverlay_start (overlay
);
29933 after
= Foverlay_end (overlay
);
29934 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29935 after_string
= Foverlay_get (overlay
, Qafter_string
);
29937 if (!STRINGP (before_string
)) before_string
= Qnil
;
29938 if (!STRINGP (after_string
)) after_string
= Qnil
;
29941 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29944 : XFASTINT (before
),
29946 ? BUF_Z (XBUFFER (buffer
))
29947 : XFASTINT (after
),
29948 before_string
, after_string
,
29950 cursor
= No_Cursor
;
29957 /* Look for a `help-echo' property. */
29958 if (NILP (help_echo_string
)) {
29959 Lisp_Object help
, overlay
;
29961 /* Check overlays first. */
29962 help
= overlay
= Qnil
;
29963 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29965 overlay
= overlay_vec
[i
];
29966 help
= Foverlay_get (overlay
, Qhelp_echo
);
29971 help_echo_string
= help
;
29972 help_echo_window
= window
;
29973 help_echo_object
= overlay
;
29974 help_echo_pos
= pos
;
29978 Lisp_Object obj
= glyph
->object
;
29979 ptrdiff_t charpos
= glyph
->charpos
;
29981 /* Try text properties. */
29984 && charpos
< SCHARS (obj
))
29986 help
= Fget_text_property (make_number (charpos
),
29990 /* If the string itself doesn't specify a help-echo,
29991 see if the buffer text ``under'' it does. */
29992 struct glyph_row
*r
29993 = MATRIX_ROW (w
->current_matrix
, vpos
);
29994 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29995 ptrdiff_t p
= string_buffer_position (obj
, start
);
29998 help
= Fget_char_property (make_number (p
),
29999 Qhelp_echo
, w
->contents
);
30008 else if (BUFFERP (obj
)
30011 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30016 help_echo_string
= help
;
30017 help_echo_window
= window
;
30018 help_echo_object
= obj
;
30019 help_echo_pos
= charpos
;
30024 #ifdef HAVE_WINDOW_SYSTEM
30025 /* Look for a `pointer' property. */
30026 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30028 /* Check overlays first. */
30029 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30030 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30032 if (NILP (pointer
))
30034 Lisp_Object obj
= glyph
->object
;
30035 ptrdiff_t charpos
= glyph
->charpos
;
30037 /* Try text properties. */
30040 && charpos
< SCHARS (obj
))
30042 pointer
= Fget_text_property (make_number (charpos
),
30044 if (NILP (pointer
))
30046 /* If the string itself doesn't specify a pointer,
30047 see if the buffer text ``under'' it does. */
30048 struct glyph_row
*r
30049 = MATRIX_ROW (w
->current_matrix
, vpos
);
30050 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30051 ptrdiff_t p
= string_buffer_position (obj
, start
);
30053 pointer
= Fget_char_property (make_number (p
),
30054 Qpointer
, w
->contents
);
30057 else if (BUFFERP (obj
)
30060 pointer
= Fget_text_property (make_number (charpos
),
30064 #endif /* HAVE_WINDOW_SYSTEM */
30068 current_buffer
= obuf
;
30074 #ifdef HAVE_WINDOW_SYSTEM
30075 if (FRAME_WINDOW_P (f
))
30076 define_frame_cursor1 (f
, cursor
, pointer
);
30078 /* This is here to prevent a compiler error, about "label at end of
30079 compound statement". */
30086 Clear any mouse-face on window W. This function is part of the
30087 redisplay interface, and is called from try_window_id and similar
30088 functions to ensure the mouse-highlight is off. */
30091 x_clear_window_mouse_face (struct window
*w
)
30093 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30094 Lisp_Object window
;
30097 XSETWINDOW (window
, w
);
30098 if (EQ (window
, hlinfo
->mouse_face_window
))
30099 clear_mouse_face (hlinfo
);
30105 Just discard the mouse face information for frame F, if any.
30106 This is used when the size of F is changed. */
30109 cancel_mouse_face (struct frame
*f
)
30111 Lisp_Object window
;
30112 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30114 window
= hlinfo
->mouse_face_window
;
30115 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30116 reset_mouse_highlight (hlinfo
);
30121 /***********************************************************************
30123 ***********************************************************************/
30125 #ifdef HAVE_WINDOW_SYSTEM
30127 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30128 which intersects rectangle R. R is in window-relative coordinates. */
30131 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30132 enum glyph_row_area area
)
30134 struct glyph
*first
= row
->glyphs
[area
];
30135 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30136 struct glyph
*last
;
30137 int first_x
, start_x
, x
;
30139 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30140 /* If row extends face to end of line write the whole line. */
30141 draw_glyphs (w
, 0, row
, area
,
30142 0, row
->used
[area
],
30143 DRAW_NORMAL_TEXT
, 0);
30146 /* Set START_X to the window-relative start position for drawing glyphs of
30147 AREA. The first glyph of the text area can be partially visible.
30148 The first glyphs of other areas cannot. */
30149 start_x
= window_box_left_offset (w
, area
);
30151 if (area
== TEXT_AREA
)
30154 /* Find the first glyph that must be redrawn. */
30156 && x
+ first
->pixel_width
< r
->x
)
30158 x
+= first
->pixel_width
;
30162 /* Find the last one. */
30165 /* Use a signed int intermediate value to avoid catastrophic
30166 failures due to comparison between signed and unsigned, when
30167 x is negative (can happen for wide images that are hscrolled). */
30168 int r_end
= r
->x
+ r
->width
;
30169 while (last
< end
&& x
< r_end
)
30171 x
+= last
->pixel_width
;
30177 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30178 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30179 DRAW_NORMAL_TEXT
, 0);
30184 /* Redraw the parts of the glyph row ROW on window W intersecting
30185 rectangle R. R is in window-relative coordinates. Value is
30186 true if mouse-face was overwritten. */
30189 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30191 eassert (row
->enabled_p
);
30193 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30194 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30195 0, row
->used
[TEXT_AREA
],
30196 DRAW_NORMAL_TEXT
, 0);
30199 if (row
->used
[LEFT_MARGIN_AREA
])
30200 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30201 if (row
->used
[TEXT_AREA
])
30202 expose_area (w
, row
, r
, TEXT_AREA
);
30203 if (row
->used
[RIGHT_MARGIN_AREA
])
30204 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30205 draw_row_fringe_bitmaps (w
, row
);
30208 return row
->mouse_face_p
;
30212 /* Redraw those parts of glyphs rows during expose event handling that
30213 overlap other rows. Redrawing of an exposed line writes over parts
30214 of lines overlapping that exposed line; this function fixes that.
30216 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30217 row in W's current matrix that is exposed and overlaps other rows.
30218 LAST_OVERLAPPING_ROW is the last such row. */
30221 expose_overlaps (struct window
*w
,
30222 struct glyph_row
*first_overlapping_row
,
30223 struct glyph_row
*last_overlapping_row
,
30226 struct glyph_row
*row
;
30228 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30229 if (row
->overlapping_p
)
30231 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30234 if (row
->used
[LEFT_MARGIN_AREA
])
30235 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30237 if (row
->used
[TEXT_AREA
])
30238 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30240 if (row
->used
[RIGHT_MARGIN_AREA
])
30241 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30247 /* Return true if W's cursor intersects rectangle R. */
30250 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30252 XRectangle cr
, result
;
30253 struct glyph
*cursor_glyph
;
30254 struct glyph_row
*row
;
30256 if (w
->phys_cursor
.vpos
>= 0
30257 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30258 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30260 && row
->cursor_in_fringe_p
)
30262 /* Cursor is in the fringe. */
30263 cr
.x
= window_box_right_offset (w
,
30264 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30265 ? RIGHT_MARGIN_AREA
30268 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30269 cr
.height
= row
->height
;
30270 return x_intersect_rectangles (&cr
, r
, &result
);
30273 cursor_glyph
= get_phys_cursor_glyph (w
);
30276 /* r is relative to W's box, but w->phys_cursor.x is relative
30277 to left edge of W's TEXT area. Adjust it. */
30278 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30279 cr
.y
= w
->phys_cursor
.y
;
30280 cr
.width
= cursor_glyph
->pixel_width
;
30281 cr
.height
= w
->phys_cursor_height
;
30282 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30283 I assume the effect is the same -- and this is portable. */
30284 return x_intersect_rectangles (&cr
, r
, &result
);
30286 /* If we don't understand the format, pretend we're not in the hot-spot. */
30292 Draw a vertical window border to the right of window W if W doesn't
30293 have vertical scroll bars. */
30296 x_draw_vertical_border (struct window
*w
)
30298 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30300 /* We could do better, if we knew what type of scroll-bar the adjacent
30301 windows (on either side) have... But we don't :-(
30302 However, I think this works ok. ++KFS 2003-04-25 */
30304 /* Redraw borders between horizontally adjacent windows. Don't
30305 do it for frames with vertical scroll bars because either the
30306 right scroll bar of a window, or the left scroll bar of its
30307 neighbor will suffice as a border. */
30308 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30311 /* Note: It is necessary to redraw both the left and the right
30312 borders, for when only this single window W is being
30314 if (!WINDOW_RIGHTMOST_P (w
)
30315 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30317 int x0
, x1
, y0
, y1
;
30319 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30322 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30325 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30328 if (!WINDOW_LEFTMOST_P (w
)
30329 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30331 int x0
, x1
, y0
, y1
;
30333 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30336 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30339 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30344 /* Draw window dividers for window W. */
30347 x_draw_right_divider (struct window
*w
)
30349 struct frame
*f
= WINDOW_XFRAME (w
);
30351 if (w
->mini
|| w
->pseudo_window_p
)
30353 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30355 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30356 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30357 int y0
= WINDOW_TOP_EDGE_Y (w
);
30358 /* The bottom divider prevails. */
30359 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30361 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30366 x_draw_bottom_divider (struct window
*w
)
30368 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30370 if (w
->mini
|| w
->pseudo_window_p
)
30372 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30374 int x0
= WINDOW_LEFT_EDGE_X (w
);
30375 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30376 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30377 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30379 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30383 /* Redraw the part of window W intersection rectangle FR. Pixel
30384 coordinates in FR are frame-relative. Call this function with
30385 input blocked. Value is true if the exposure overwrites
30389 expose_window (struct window
*w
, XRectangle
*fr
)
30391 struct frame
*f
= XFRAME (w
->frame
);
30393 bool mouse_face_overwritten_p
= false;
30395 /* If window is not yet fully initialized, do nothing. This can
30396 happen when toolkit scroll bars are used and a window is split.
30397 Reconfiguring the scroll bar will generate an expose for a newly
30399 if (w
->current_matrix
== NULL
)
30402 /* When we're currently updating the window, display and current
30403 matrix usually don't agree. Arrange for a thorough display
30405 if (w
->must_be_updated_p
)
30407 SET_FRAME_GARBAGED (f
);
30411 /* Frame-relative pixel rectangle of W. */
30412 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30413 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30414 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30415 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30417 if (x_intersect_rectangles (fr
, &wr
, &r
))
30419 int yb
= window_text_bottom_y (w
);
30420 struct glyph_row
*row
;
30421 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30423 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30424 r
.x
, r
.y
, r
.width
, r
.height
));
30426 /* Convert to window coordinates. */
30427 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30428 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30430 /* Turn off the cursor. */
30431 bool cursor_cleared_p
= (!w
->pseudo_window_p
30432 && phys_cursor_in_rect_p (w
, &r
));
30433 if (cursor_cleared_p
)
30434 x_clear_cursor (w
);
30436 /* If the row containing the cursor extends face to end of line,
30437 then expose_area might overwrite the cursor outside the
30438 rectangle and thus notice_overwritten_cursor might clear
30439 w->phys_cursor_on_p. We remember the original value and
30440 check later if it is changed. */
30441 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30443 /* Use a signed int intermediate value to avoid catastrophic
30444 failures due to comparison between signed and unsigned, when
30445 y0 or y1 is negative (can happen for tall images). */
30446 int r_bottom
= r
.y
+ r
.height
;
30448 /* Update lines intersecting rectangle R. */
30449 first_overlapping_row
= last_overlapping_row
= NULL
;
30450 for (row
= w
->current_matrix
->rows
;
30455 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30457 if ((y0
>= r
.y
&& y0
< r_bottom
)
30458 || (y1
> r
.y
&& y1
< r_bottom
)
30459 || (r
.y
>= y0
&& r
.y
< y1
)
30460 || (r_bottom
> y0
&& r_bottom
< y1
))
30462 /* A header line may be overlapping, but there is no need
30463 to fix overlapping areas for them. KFS 2005-02-12 */
30464 if (row
->overlapping_p
&& !row
->mode_line_p
)
30466 if (first_overlapping_row
== NULL
)
30467 first_overlapping_row
= row
;
30468 last_overlapping_row
= row
;
30472 if (expose_line (w
, row
, &r
))
30473 mouse_face_overwritten_p
= true;
30476 else if (row
->overlapping_p
)
30478 /* We must redraw a row overlapping the exposed area. */
30480 ? y0
+ row
->phys_height
> r
.y
30481 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30483 if (first_overlapping_row
== NULL
)
30484 first_overlapping_row
= row
;
30485 last_overlapping_row
= row
;
30493 /* Display the mode line if there is one. */
30494 if (WINDOW_WANTS_MODELINE_P (w
)
30495 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30497 && row
->y
< r_bottom
)
30499 if (expose_line (w
, row
, &r
))
30500 mouse_face_overwritten_p
= true;
30503 if (!w
->pseudo_window_p
)
30505 /* Fix the display of overlapping rows. */
30506 if (first_overlapping_row
)
30507 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30510 /* Draw border between windows. */
30511 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30512 x_draw_right_divider (w
);
30514 x_draw_vertical_border (w
);
30516 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30517 x_draw_bottom_divider (w
);
30519 /* Turn the cursor on again. */
30520 if (cursor_cleared_p
30521 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30522 update_window_cursor (w
, true);
30526 return mouse_face_overwritten_p
;
30531 /* Redraw (parts) of all windows in the window tree rooted at W that
30532 intersect R. R contains frame pixel coordinates. Value is
30533 true if the exposure overwrites mouse-face. */
30536 expose_window_tree (struct window
*w
, XRectangle
*r
)
30538 struct frame
*f
= XFRAME (w
->frame
);
30539 bool mouse_face_overwritten_p
= false;
30541 while (w
&& !FRAME_GARBAGED_P (f
))
30543 mouse_face_overwritten_p
30544 |= (WINDOWP (w
->contents
)
30545 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30546 : expose_window (w
, r
));
30548 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30551 return mouse_face_overwritten_p
;
30556 Redisplay an exposed area of frame F. X and Y are the upper-left
30557 corner of the exposed rectangle. W and H are width and height of
30558 the exposed area. All are pixel values. W or H zero means redraw
30559 the entire frame. */
30562 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30565 bool mouse_face_overwritten_p
= false;
30567 TRACE ((stderr
, "expose_frame "));
30569 /* No need to redraw if frame will be redrawn soon. */
30570 if (FRAME_GARBAGED_P (f
))
30572 TRACE ((stderr
, " garbaged\n"));
30576 /* If basic faces haven't been realized yet, there is no point in
30577 trying to redraw anything. This can happen when we get an expose
30578 event while Emacs is starting, e.g. by moving another window. */
30579 if (FRAME_FACE_CACHE (f
) == NULL
30580 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30582 TRACE ((stderr
, " no faces\n"));
30586 if (w
== 0 || h
== 0)
30589 r
.width
= FRAME_TEXT_WIDTH (f
);
30590 r
.height
= FRAME_TEXT_HEIGHT (f
);
30600 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30601 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30603 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30604 if (WINDOWP (f
->tool_bar_window
))
30605 mouse_face_overwritten_p
30606 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30609 #ifdef HAVE_X_WINDOWS
30611 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30612 if (WINDOWP (f
->menu_bar_window
))
30613 mouse_face_overwritten_p
30614 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30615 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30619 /* Some window managers support a focus-follows-mouse style with
30620 delayed raising of frames. Imagine a partially obscured frame,
30621 and moving the mouse into partially obscured mouse-face on that
30622 frame. The visible part of the mouse-face will be highlighted,
30623 then the WM raises the obscured frame. With at least one WM, KDE
30624 2.1, Emacs is not getting any event for the raising of the frame
30625 (even tried with SubstructureRedirectMask), only Expose events.
30626 These expose events will draw text normally, i.e. not
30627 highlighted. Which means we must redo the highlight here.
30628 Subsume it under ``we love X''. --gerd 2001-08-15 */
30629 /* Included in Windows version because Windows most likely does not
30630 do the right thing if any third party tool offers
30631 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30632 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30634 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30635 if (f
== hlinfo
->mouse_face_mouse_frame
)
30637 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30638 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30639 clear_mouse_face (hlinfo
);
30640 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30647 Determine the intersection of two rectangles R1 and R2. Return
30648 the intersection in *RESULT. Value is true if RESULT is not
30652 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30654 XRectangle
*left
, *right
;
30655 XRectangle
*upper
, *lower
;
30656 bool intersection_p
= false;
30658 /* Rearrange so that R1 is the left-most rectangle. */
30660 left
= r1
, right
= r2
;
30662 left
= r2
, right
= r1
;
30664 /* X0 of the intersection is right.x0, if this is inside R1,
30665 otherwise there is no intersection. */
30666 if (right
->x
<= left
->x
+ left
->width
)
30668 result
->x
= right
->x
;
30670 /* The right end of the intersection is the minimum of
30671 the right ends of left and right. */
30672 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30675 /* Same game for Y. */
30677 upper
= r1
, lower
= r2
;
30679 upper
= r2
, lower
= r1
;
30681 /* The upper end of the intersection is lower.y0, if this is inside
30682 of upper. Otherwise, there is no intersection. */
30683 if (lower
->y
<= upper
->y
+ upper
->height
)
30685 result
->y
= lower
->y
;
30687 /* The lower end of the intersection is the minimum of the lower
30688 ends of upper and lower. */
30689 result
->height
= (min (lower
->y
+ lower
->height
,
30690 upper
->y
+ upper
->height
)
30692 intersection_p
= true;
30696 return intersection_p
;
30699 #endif /* HAVE_WINDOW_SYSTEM */
30702 /***********************************************************************
30704 ***********************************************************************/
30707 syms_of_xdisp (void)
30709 Vwith_echo_area_save_vector
= Qnil
;
30710 staticpro (&Vwith_echo_area_save_vector
);
30712 Vmessage_stack
= Qnil
;
30713 staticpro (&Vmessage_stack
);
30715 /* Non-nil means don't actually do any redisplay. */
30716 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30718 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30720 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30721 doc
: /* Non-nil means calls to `message' are not displayed.
30722 They are still logged to the *Messages* buffer. */);
30723 inhibit_message
= 0;
30725 message_dolog_marker1
= Fmake_marker ();
30726 staticpro (&message_dolog_marker1
);
30727 message_dolog_marker2
= Fmake_marker ();
30728 staticpro (&message_dolog_marker2
);
30729 message_dolog_marker3
= Fmake_marker ();
30730 staticpro (&message_dolog_marker3
);
30733 defsubr (&Sdump_frame_glyph_matrix
);
30734 defsubr (&Sdump_glyph_matrix
);
30735 defsubr (&Sdump_glyph_row
);
30736 defsubr (&Sdump_tool_bar_row
);
30737 defsubr (&Strace_redisplay
);
30738 defsubr (&Strace_to_stderr
);
30740 #ifdef HAVE_WINDOW_SYSTEM
30741 defsubr (&Stool_bar_height
);
30742 defsubr (&Slookup_image_map
);
30744 defsubr (&Sline_pixel_height
);
30745 defsubr (&Sformat_mode_line
);
30746 defsubr (&Sinvisible_p
);
30747 defsubr (&Scurrent_bidi_paragraph_direction
);
30748 defsubr (&Swindow_text_pixel_size
);
30749 defsubr (&Smove_point_visually
);
30750 defsubr (&Sbidi_find_overridden_directionality
);
30752 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30753 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30754 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30755 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30756 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30757 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30758 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30759 DEFSYM (Qeval
, "eval");
30760 DEFSYM (QCdata
, ":data");
30762 /* Names of text properties relevant for redisplay. */
30763 DEFSYM (Qdisplay
, "display");
30764 DEFSYM (Qspace_width
, "space-width");
30765 DEFSYM (Qraise
, "raise");
30766 DEFSYM (Qslice
, "slice");
30767 DEFSYM (Qspace
, "space");
30768 DEFSYM (Qmargin
, "margin");
30769 DEFSYM (Qpointer
, "pointer");
30770 DEFSYM (Qleft_margin
, "left-margin");
30771 DEFSYM (Qright_margin
, "right-margin");
30772 DEFSYM (Qcenter
, "center");
30773 DEFSYM (Qline_height
, "line-height");
30774 DEFSYM (QCalign_to
, ":align-to");
30775 DEFSYM (QCrelative_width
, ":relative-width");
30776 DEFSYM (QCrelative_height
, ":relative-height");
30777 DEFSYM (QCeval
, ":eval");
30778 DEFSYM (QCpropertize
, ":propertize");
30779 DEFSYM (QCfile
, ":file");
30780 DEFSYM (Qfontified
, "fontified");
30781 DEFSYM (Qfontification_functions
, "fontification-functions");
30783 /* Name of the face used to highlight trailing whitespace. */
30784 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30786 /* Name and number of the face used to highlight escape glyphs. */
30787 DEFSYM (Qescape_glyph
, "escape-glyph");
30789 /* Name and number of the face used to highlight non-breaking spaces. */
30790 DEFSYM (Qnobreak_space
, "nobreak-space");
30792 /* The symbol 'image' which is the car of the lists used to represent
30793 images in Lisp. Also a tool bar style. */
30794 DEFSYM (Qimage
, "image");
30796 /* Tool bar styles. */
30797 DEFSYM (Qtext
, "text");
30798 DEFSYM (Qboth
, "both");
30799 DEFSYM (Qboth_horiz
, "both-horiz");
30800 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30802 /* The image map types. */
30803 DEFSYM (QCmap
, ":map");
30804 DEFSYM (QCpointer
, ":pointer");
30805 DEFSYM (Qrect
, "rect");
30806 DEFSYM (Qcircle
, "circle");
30807 DEFSYM (Qpoly
, "poly");
30809 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30811 DEFSYM (Qgrow_only
, "grow-only");
30812 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30813 DEFSYM (Qposition
, "position");
30814 DEFSYM (Qbuffer_position
, "buffer-position");
30815 DEFSYM (Qobject
, "object");
30817 /* Cursor shapes. */
30818 DEFSYM (Qbar
, "bar");
30819 DEFSYM (Qhbar
, "hbar");
30820 DEFSYM (Qbox
, "box");
30821 DEFSYM (Qhollow
, "hollow");
30823 /* Pointer shapes. */
30824 DEFSYM (Qhand
, "hand");
30825 DEFSYM (Qarrow
, "arrow");
30828 DEFSYM (Qdragging
, "dragging");
30830 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30832 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30833 staticpro (&list_of_error
);
30835 /* Values of those variables at last redisplay are stored as
30836 properties on 'overlay-arrow-position' symbol. However, if
30837 Voverlay_arrow_position is a marker, last-arrow-position is its
30838 numerical position. */
30839 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30840 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30842 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30843 properties on a symbol in overlay-arrow-variable-list. */
30844 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30845 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30847 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30848 staticpro (&echo_buffer
[0]);
30849 staticpro (&echo_buffer
[1]);
30851 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30852 staticpro (&echo_area_buffer
[0]);
30853 staticpro (&echo_area_buffer
[1]);
30855 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30856 staticpro (&Vmessages_buffer_name
);
30858 mode_line_proptrans_alist
= Qnil
;
30859 staticpro (&mode_line_proptrans_alist
);
30860 mode_line_string_list
= Qnil
;
30861 staticpro (&mode_line_string_list
);
30862 mode_line_string_face
= Qnil
;
30863 staticpro (&mode_line_string_face
);
30864 mode_line_string_face_prop
= Qnil
;
30865 staticpro (&mode_line_string_face_prop
);
30866 Vmode_line_unwind_vector
= Qnil
;
30867 staticpro (&Vmode_line_unwind_vector
);
30869 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30871 help_echo_string
= Qnil
;
30872 staticpro (&help_echo_string
);
30873 help_echo_object
= Qnil
;
30874 staticpro (&help_echo_object
);
30875 help_echo_window
= Qnil
;
30876 staticpro (&help_echo_window
);
30877 previous_help_echo_string
= Qnil
;
30878 staticpro (&previous_help_echo_string
);
30879 help_echo_pos
= -1;
30881 DEFSYM (Qright_to_left
, "right-to-left");
30882 DEFSYM (Qleft_to_right
, "left-to-right");
30883 defsubr (&Sbidi_resolved_levels
);
30885 #ifdef HAVE_WINDOW_SYSTEM
30886 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30887 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30888 For example, if a block cursor is over a tab, it will be drawn as
30889 wide as that tab on the display. */);
30890 x_stretch_cursor_p
= 0;
30893 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30894 doc
: /* Non-nil means highlight trailing whitespace.
30895 The face used for trailing whitespace is `trailing-whitespace'. */);
30896 Vshow_trailing_whitespace
= Qnil
;
30898 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30899 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30900 If the value is t, Emacs highlights non-ASCII chars which have the
30901 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30902 or `escape-glyph' face respectively.
30904 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30905 U+2011 (non-breaking hyphen) are affected.
30907 Any other non-nil value means to display these characters as a escape
30908 glyph followed by an ordinary space or hyphen.
30910 A value of nil means no special handling of these characters. */);
30911 Vnobreak_char_display
= Qt
;
30913 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30914 doc
: /* The pointer shape to show in void text areas.
30915 A value of nil means to show the text pointer. Other options are
30916 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30918 Vvoid_text_area_pointer
= Qarrow
;
30920 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30921 doc
: /* Non-nil means don't actually do any redisplay.
30922 This is used for internal purposes. */);
30923 Vinhibit_redisplay
= Qnil
;
30925 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30926 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30927 Vglobal_mode_string
= Qnil
;
30929 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30930 doc
: /* Marker for where to display an arrow on top of the buffer text.
30931 This must be the beginning of a line in order to work.
30932 See also `overlay-arrow-string'. */);
30933 Voverlay_arrow_position
= Qnil
;
30935 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30936 doc
: /* String to display as an arrow in non-window frames.
30937 See also `overlay-arrow-position'. */);
30938 Voverlay_arrow_string
= build_pure_c_string ("=>");
30940 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30941 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30942 The symbols on this list are examined during redisplay to determine
30943 where to display overlay arrows. */);
30944 Voverlay_arrow_variable_list
30945 = list1 (intern_c_string ("overlay-arrow-position"));
30947 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30948 doc
: /* The number of lines to try scrolling a window by when point moves out.
30949 If that fails to bring point back on frame, point is centered instead.
30950 If this is zero, point is always centered after it moves off frame.
30951 If you want scrolling to always be a line at a time, you should set
30952 `scroll-conservatively' to a large value rather than set this to 1. */);
30954 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30955 doc
: /* Scroll up to this many lines, to bring point back on screen.
30956 If point moves off-screen, redisplay will scroll by up to
30957 `scroll-conservatively' lines in order to bring point just barely
30958 onto the screen again. If that cannot be done, then redisplay
30959 recenters point as usual.
30961 If the value is greater than 100, redisplay will never recenter point,
30962 but will always scroll just enough text to bring point into view, even
30963 if you move far away.
30965 A value of zero means always recenter point if it moves off screen. */);
30966 scroll_conservatively
= 0;
30968 DEFVAR_INT ("scroll-margin", scroll_margin
,
30969 doc
: /* Number of lines of margin at the top and bottom of a window.
30970 Recenter the window whenever point gets within this many lines
30971 of the top or bottom of the window. */);
30974 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30975 doc
: /* Pixels per inch value for non-window system displays.
30976 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30977 Vdisplay_pixels_per_inch
= make_float (72.0);
30980 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30983 DEFVAR_LISP ("truncate-partial-width-windows",
30984 Vtruncate_partial_width_windows
,
30985 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30986 For an integer value, truncate lines in each window narrower than the
30987 full frame width, provided the window width is less than that integer;
30988 otherwise, respect the value of `truncate-lines'.
30990 For any other non-nil value, truncate lines in all windows that do
30991 not span the full frame width.
30993 A value of nil means to respect the value of `truncate-lines'.
30995 If `word-wrap' is enabled, you might want to reduce this. */);
30996 Vtruncate_partial_width_windows
= make_number (50);
30998 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30999 doc
: /* Maximum buffer size for which line number should be displayed.
31000 If the buffer is bigger than this, the line number does not appear
31001 in the mode line. A value of nil means no limit. */);
31002 Vline_number_display_limit
= Qnil
;
31004 DEFVAR_INT ("line-number-display-limit-width",
31005 line_number_display_limit_width
,
31006 doc
: /* Maximum line width (in characters) for line number display.
31007 If the average length of the lines near point is bigger than this, then the
31008 line number may be omitted from the mode line. */);
31009 line_number_display_limit_width
= 200;
31011 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31012 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31013 highlight_nonselected_windows
= false;
31015 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31016 doc
: /* Non-nil if more than one frame is visible on this display.
31017 Minibuffer-only frames don't count, but iconified frames do.
31018 This variable is not guaranteed to be accurate except while processing
31019 `frame-title-format' and `icon-title-format'. */);
31021 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31022 doc
: /* Template for displaying the title bar of visible frames.
31023 (Assuming the window manager supports this feature.)
31025 This variable has the same structure as `mode-line-format', except that
31026 the %c and %l constructs are ignored. It is used only on frames for
31027 which no explicit name has been set (see `modify-frame-parameters'). */);
31029 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31030 doc
: /* Template for displaying the title bar of an iconified frame.
31031 (Assuming the window manager supports this feature.)
31032 This variable has the same structure as `mode-line-format' (which see),
31033 and is used only on frames for which no explicit name has been set
31034 (see `modify-frame-parameters'). */);
31036 = Vframe_title_format
31037 = listn (CONSTYPE_PURE
, 3,
31038 intern_c_string ("multiple-frames"),
31039 build_pure_c_string ("%b"),
31040 listn (CONSTYPE_PURE
, 4,
31041 empty_unibyte_string
,
31042 intern_c_string ("invocation-name"),
31043 build_pure_c_string ("@"),
31044 intern_c_string ("system-name")));
31046 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31047 doc
: /* Maximum number of lines to keep in the message log buffer.
31048 If nil, disable message logging. If t, log messages but don't truncate
31049 the buffer when it becomes large. */);
31050 Vmessage_log_max
= make_number (1000);
31052 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31053 doc
: /* Functions called before redisplay, if window sizes have changed.
31054 The value should be a list of functions that take one argument.
31055 Just before redisplay, for each frame, if any of its windows have changed
31056 size since the last redisplay, or have been split or deleted,
31057 all the functions in the list are called, with the frame as argument. */);
31058 Vwindow_size_change_functions
= Qnil
;
31060 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31061 doc
: /* List of functions to call before redisplaying a window with scrolling.
31062 Each function is called with two arguments, the window and its new
31063 display-start position.
31064 These functions are called whenever the `window-start' marker is modified,
31065 either to point into another buffer (e.g. via `set-window-buffer') or another
31066 place in the same buffer.
31067 Note that the value of `window-end' is not valid when these functions are
31070 Warning: Do not use this feature to alter the way the window
31071 is scrolled. It is not designed for that, and such use probably won't
31073 Vwindow_scroll_functions
= Qnil
;
31075 DEFVAR_LISP ("window-text-change-functions",
31076 Vwindow_text_change_functions
,
31077 doc
: /* Functions to call in redisplay when text in the window might change. */);
31078 Vwindow_text_change_functions
= Qnil
;
31080 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31081 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31082 Each function is called with two arguments, the window and the end trigger value.
31083 See `set-window-redisplay-end-trigger'. */);
31084 Vredisplay_end_trigger_functions
= Qnil
;
31086 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31087 doc
: /* Non-nil means autoselect window with mouse pointer.
31088 If nil, do not autoselect windows.
31089 A positive number means delay autoselection by that many seconds: a
31090 window is autoselected only after the mouse has remained in that
31091 window for the duration of the delay.
31092 A negative number has a similar effect, but causes windows to be
31093 autoselected only after the mouse has stopped moving. (Because of
31094 the way Emacs compares mouse events, you will occasionally wait twice
31095 that time before the window gets selected.)
31096 Any other value means to autoselect window instantaneously when the
31097 mouse pointer enters it.
31099 Autoselection selects the minibuffer only if it is active, and never
31100 unselects the minibuffer if it is active.
31102 When customizing this variable make sure that the actual value of
31103 `focus-follows-mouse' matches the behavior of your window manager. */);
31104 Vmouse_autoselect_window
= Qnil
;
31106 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31107 doc
: /* Non-nil means automatically resize tool-bars.
31108 This dynamically changes the tool-bar's height to the minimum height
31109 that is needed to make all tool-bar items visible.
31110 If value is `grow-only', the tool-bar's height is only increased
31111 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31112 Vauto_resize_tool_bars
= Qt
;
31114 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31115 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31116 auto_raise_tool_bar_buttons_p
= true;
31118 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31119 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31120 make_cursor_line_fully_visible_p
= true;
31122 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31123 doc
: /* Border below tool-bar in pixels.
31124 If an integer, use it as the height of the border.
31125 If it is one of `internal-border-width' or `border-width', use the
31126 value of the corresponding frame parameter.
31127 Otherwise, no border is added below the tool-bar. */);
31128 Vtool_bar_border
= Qinternal_border_width
;
31130 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31131 doc
: /* Margin around tool-bar buttons in pixels.
31132 If an integer, use that for both horizontal and vertical margins.
31133 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31134 HORZ specifying the horizontal margin, and VERT specifying the
31135 vertical margin. */);
31136 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31138 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31139 doc
: /* Relief thickness of tool-bar buttons. */);
31140 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31142 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31143 doc
: /* Tool bar style to use.
31145 image - show images only
31146 text - show text only
31147 both - show both, text below image
31148 both-horiz - show text to the right of the image
31149 text-image-horiz - show text to the left of the image
31150 any other - use system default or image if no system default.
31152 This variable only affects the GTK+ toolkit version of Emacs. */);
31153 Vtool_bar_style
= Qnil
;
31155 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31156 doc
: /* Maximum number of characters a label can have to be shown.
31157 The tool bar style must also show labels for this to have any effect, see
31158 `tool-bar-style'. */);
31159 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31161 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31162 doc
: /* List of functions to call to fontify regions of text.
31163 Each function is called with one argument POS. Functions must
31164 fontify a region starting at POS in the current buffer, and give
31165 fontified regions the property `fontified'. */);
31166 Vfontification_functions
= Qnil
;
31167 Fmake_variable_buffer_local (Qfontification_functions
);
31169 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31170 unibyte_display_via_language_environment
,
31171 doc
: /* Non-nil means display unibyte text according to language environment.
31172 Specifically, this means that raw bytes in the range 160-255 decimal
31173 are displayed by converting them to the equivalent multibyte characters
31174 according to the current language environment. As a result, they are
31175 displayed according to the current fontset.
31177 Note that this variable affects only how these bytes are displayed,
31178 but does not change the fact they are interpreted as raw bytes. */);
31179 unibyte_display_via_language_environment
= false;
31181 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31182 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31183 If a float, it specifies a fraction of the mini-window frame's height.
31184 If an integer, it specifies a number of lines. */);
31185 Vmax_mini_window_height
= make_float (0.25);
31187 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31188 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31189 A value of nil means don't automatically resize mini-windows.
31190 A value of t means resize them to fit the text displayed in them.
31191 A value of `grow-only', the default, means let mini-windows grow only;
31192 they return to their normal size when the minibuffer is closed, or the
31193 echo area becomes empty. */);
31194 Vresize_mini_windows
= Qgrow_only
;
31196 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31197 doc
: /* Alist specifying how to blink the cursor off.
31198 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31199 `cursor-type' frame-parameter or variable equals ON-STATE,
31200 comparing using `equal', Emacs uses OFF-STATE to specify
31201 how to blink it off. ON-STATE and OFF-STATE are values for
31202 the `cursor-type' frame parameter.
31204 If a frame's ON-STATE has no entry in this list,
31205 the frame's other specifications determine how to blink the cursor off. */);
31206 Vblink_cursor_alist
= Qnil
;
31208 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31209 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31210 If non-nil, windows are automatically scrolled horizontally to make
31211 point visible. */);
31212 automatic_hscrolling_p
= true;
31213 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31215 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31216 doc
: /* How many columns away from the window edge point is allowed to get
31217 before automatic hscrolling will horizontally scroll the window. */);
31218 hscroll_margin
= 5;
31220 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31221 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31222 When point is less than `hscroll-margin' columns from the window
31223 edge, automatic hscrolling will scroll the window by the amount of columns
31224 determined by this variable. If its value is a positive integer, scroll that
31225 many columns. If it's a positive floating-point number, it specifies the
31226 fraction of the window's width to scroll. If it's nil or zero, point will be
31227 centered horizontally after the scroll. Any other value, including negative
31228 numbers, are treated as if the value were zero.
31230 Automatic hscrolling always moves point outside the scroll margin, so if
31231 point was more than scroll step columns inside the margin, the window will
31232 scroll more than the value given by the scroll step.
31234 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31235 and `scroll-right' overrides this variable's effect. */);
31236 Vhscroll_step
= make_number (0);
31238 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31239 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31240 Bind this around calls to `message' to let it take effect. */);
31241 message_truncate_lines
= false;
31243 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31244 doc
: /* Normal hook run to update the menu bar definitions.
31245 Redisplay runs this hook before it redisplays the menu bar.
31246 This is used to update menus such as Buffers, whose contents depend on
31248 Vmenu_bar_update_hook
= Qnil
;
31250 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31251 doc
: /* Frame for which we are updating a menu.
31252 The enable predicate for a menu binding should check this variable. */);
31253 Vmenu_updating_frame
= Qnil
;
31255 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31256 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31257 inhibit_menubar_update
= false;
31259 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31260 doc
: /* Prefix prepended to all continuation lines at display time.
31261 The value may be a string, an image, or a stretch-glyph; it is
31262 interpreted in the same way as the value of a `display' text property.
31264 This variable is overridden by any `wrap-prefix' text or overlay
31267 To add a prefix to non-continuation lines, use `line-prefix'. */);
31268 Vwrap_prefix
= Qnil
;
31269 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31270 Fmake_variable_buffer_local (Qwrap_prefix
);
31272 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31273 doc
: /* Prefix prepended to all non-continuation lines at display time.
31274 The value may be a string, an image, or a stretch-glyph; it is
31275 interpreted in the same way as the value of a `display' text property.
31277 This variable is overridden by any `line-prefix' text or overlay
31280 To add a prefix to continuation lines, use `wrap-prefix'. */);
31281 Vline_prefix
= Qnil
;
31282 DEFSYM (Qline_prefix
, "line-prefix");
31283 Fmake_variable_buffer_local (Qline_prefix
);
31285 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31286 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31287 inhibit_eval_during_redisplay
= false;
31289 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31290 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31291 inhibit_free_realized_faces
= false;
31293 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31294 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31295 Intended for use during debugging and for testing bidi display;
31296 see biditest.el in the test suite. */);
31297 inhibit_bidi_mirroring
= false;
31300 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31301 doc
: /* Inhibit try_window_id display optimization. */);
31302 inhibit_try_window_id
= false;
31304 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31305 doc
: /* Inhibit try_window_reusing display optimization. */);
31306 inhibit_try_window_reusing
= false;
31308 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31309 doc
: /* Inhibit try_cursor_movement display optimization. */);
31310 inhibit_try_cursor_movement
= false;
31311 #endif /* GLYPH_DEBUG */
31313 DEFVAR_INT ("overline-margin", overline_margin
,
31314 doc
: /* Space between overline and text, in pixels.
31315 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31316 margin to the character height. */);
31317 overline_margin
= 2;
31319 DEFVAR_INT ("underline-minimum-offset",
31320 underline_minimum_offset
,
31321 doc
: /* Minimum distance between baseline and underline.
31322 This can improve legibility of underlined text at small font sizes,
31323 particularly when using variable `x-use-underline-position-properties'
31324 with fonts that specify an UNDERLINE_POSITION relatively close to the
31325 baseline. The default value is 1. */);
31326 underline_minimum_offset
= 1;
31328 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31329 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31330 This feature only works when on a window system that can change
31331 cursor shapes. */);
31332 display_hourglass_p
= true;
31334 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31335 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31336 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31338 #ifdef HAVE_WINDOW_SYSTEM
31339 hourglass_atimer
= NULL
;
31340 hourglass_shown_p
= false;
31341 #endif /* HAVE_WINDOW_SYSTEM */
31343 /* Name of the face used to display glyphless characters. */
31344 DEFSYM (Qglyphless_char
, "glyphless-char");
31346 /* Method symbols for Vglyphless_char_display. */
31347 DEFSYM (Qhex_code
, "hex-code");
31348 DEFSYM (Qempty_box
, "empty-box");
31349 DEFSYM (Qthin_space
, "thin-space");
31350 DEFSYM (Qzero_width
, "zero-width");
31352 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31353 doc
: /* Function run just before redisplay.
31354 It is called with one argument, which is the set of windows that are to
31355 be redisplayed. This set can be nil (meaning, only the selected window),
31356 or t (meaning all windows). */);
31357 Vpre_redisplay_function
= intern ("ignore");
31359 /* Symbol for the purpose of Vglyphless_char_display. */
31360 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31361 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31363 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31364 doc
: /* Char-table defining glyphless characters.
31365 Each element, if non-nil, should be one of the following:
31366 an ASCII acronym string: display this string in a box
31367 `hex-code': display the hexadecimal code of a character in a box
31368 `empty-box': display as an empty box
31369 `thin-space': display as 1-pixel width space
31370 `zero-width': don't display
31371 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31372 display method for graphical terminals and text terminals respectively.
31373 GRAPHICAL and TEXT should each have one of the values listed above.
31375 The char-table has one extra slot to control the display of a character for
31376 which no font is found. This slot only takes effect on graphical terminals.
31377 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31378 `thin-space'. The default is `empty-box'.
31380 If a character has a non-nil entry in an active display table, the
31381 display table takes effect; in this case, Emacs does not consult
31382 `glyphless-char-display' at all. */);
31383 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31384 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31387 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31388 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31389 Vdebug_on_message
= Qnil
;
31391 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31393 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31395 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31397 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31401 /* Initialize this module when Emacs starts. */
31406 CHARPOS (this_line_start_pos
) = 0;
31408 if (!noninteractive
)
31410 struct window
*m
= XWINDOW (minibuf_window
);
31411 Lisp_Object frame
= m
->frame
;
31412 struct frame
*f
= XFRAME (frame
);
31413 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31414 struct window
*r
= XWINDOW (root
);
31417 echo_area_window
= minibuf_window
;
31419 r
->top_line
= FRAME_TOP_MARGIN (f
);
31420 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31421 r
->total_cols
= FRAME_COLS (f
);
31422 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31423 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31424 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31426 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31427 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31428 m
->total_cols
= FRAME_COLS (f
);
31429 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31430 m
->total_lines
= 1;
31431 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31433 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31434 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31435 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31437 /* The default ellipsis glyphs `...'. */
31438 for (i
= 0; i
< 3; ++i
)
31439 default_invis_vector
[i
] = make_number ('.');
31443 /* Allocate the buffer for frame titles.
31444 Also used for `format-mode-line'. */
31446 mode_line_noprop_buf
= xmalloc (size
);
31447 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31448 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31449 mode_line_target
= MODE_LINE_DISPLAY
;
31452 help_echo_showing_p
= false;
31455 #ifdef HAVE_WINDOW_SYSTEM
31457 /* Platform-independent portion of hourglass implementation. */
31459 /* Timer function of hourglass_atimer. */
31462 show_hourglass (struct atimer
*timer
)
31464 /* The timer implementation will cancel this timer automatically
31465 after this function has run. Set hourglass_atimer to null
31466 so that we know the timer doesn't have to be canceled. */
31467 hourglass_atimer
= NULL
;
31469 if (!hourglass_shown_p
)
31471 Lisp_Object tail
, frame
;
31475 FOR_EACH_FRAME (tail
, frame
)
31477 struct frame
*f
= XFRAME (frame
);
31479 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31480 && FRAME_RIF (f
)->show_hourglass
)
31481 FRAME_RIF (f
)->show_hourglass (f
);
31484 hourglass_shown_p
= true;
31489 /* Cancel a currently active hourglass timer, and start a new one. */
31492 start_hourglass (void)
31494 struct timespec delay
;
31496 cancel_hourglass ();
31498 if (INTEGERP (Vhourglass_delay
)
31499 && XINT (Vhourglass_delay
) > 0)
31500 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31501 TYPE_MAXIMUM (time_t)),
31503 else if (FLOATP (Vhourglass_delay
)
31504 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31505 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31507 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31509 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31510 show_hourglass
, NULL
);
31513 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31517 cancel_hourglass (void)
31519 if (hourglass_atimer
)
31521 cancel_atimer (hourglass_atimer
);
31522 hourglass_atimer
= NULL
;
31525 if (hourglass_shown_p
)
31527 Lisp_Object tail
, frame
;
31531 FOR_EACH_FRAME (tail
, frame
)
31533 struct frame
*f
= XFRAME (frame
);
31535 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31536 && FRAME_RIF (f
)->hide_hourglass
)
31537 FRAME_RIF (f
)->hide_hourglass (f
);
31539 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31540 else if (!FRAME_W32_P (f
))
31541 w32_arrow_cursor ();
31545 hourglass_shown_p
= false;
31550 #endif /* HAVE_WINDOW_SYSTEM */