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 (face_change
&& !inhibit_free_realized_faces
)
2666 face_change
= false;
2667 free_all_realized_faces (Qnil
);
2670 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2671 if (! NILP (Vface_remapping_alist
))
2672 remapped_base_face_id
2673 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2675 /* Use one of the mode line rows of W's desired matrix if
2679 if (base_face_id
== MODE_LINE_FACE_ID
2680 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2681 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2682 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2683 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2686 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2687 Other parts of redisplay rely on that. */
2688 memclear (it
, sizeof *it
);
2689 it
->current
.overlay_string_index
= -1;
2690 it
->current
.dpvec_index
= -1;
2691 it
->base_face_id
= remapped_base_face_id
;
2692 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2693 it
->paragraph_embedding
= L2R
;
2696 /* The window in which we iterate over current_buffer: */
2697 XSETWINDOW (it
->window
, w
);
2699 it
->f
= XFRAME (w
->frame
);
2703 /* Extra space between lines (on window systems only). */
2704 if (base_face_id
== DEFAULT_FACE_ID
2705 && FRAME_WINDOW_P (it
->f
))
2707 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2708 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2709 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2710 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2711 * FRAME_LINE_HEIGHT (it
->f
));
2712 else if (it
->f
->extra_line_spacing
> 0)
2713 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2716 /* If realized faces have been removed, e.g. because of face
2717 attribute changes of named faces, recompute them. When running
2718 in batch mode, the face cache of the initial frame is null. If
2719 we happen to get called, make a dummy face cache. */
2720 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2721 init_frame_faces (it
->f
);
2722 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2723 recompute_basic_faces (it
->f
);
2725 it
->override_ascent
= -1;
2727 /* Are control characters displayed as `^C'? */
2728 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2730 /* -1 means everything between a CR and the following line end
2731 is invisible. >0 means lines indented more than this value are
2733 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2735 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2737 : (!NILP (BVAR (current_buffer
, selective_display
))
2739 it
->selective_display_ellipsis_p
2740 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2742 /* Display table to use. */
2743 it
->dp
= window_display_table (w
);
2745 /* Are multibyte characters enabled in current_buffer? */
2746 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2748 /* Get the position at which the redisplay_end_trigger hook should
2749 be run, if it is to be run at all. */
2750 if (MARKERP (w
->redisplay_end_trigger
)
2751 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2752 it
->redisplay_end_trigger_charpos
2753 = marker_position (w
->redisplay_end_trigger
);
2754 else if (INTEGERP (w
->redisplay_end_trigger
))
2755 it
->redisplay_end_trigger_charpos
2756 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2759 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2761 /* Are lines in the display truncated? */
2763 it
->line_wrap
= TRUNCATE
;
2764 if (base_face_id
== DEFAULT_FACE_ID
2766 && (WINDOW_FULL_WIDTH_P (it
->w
)
2767 || NILP (Vtruncate_partial_width_windows
)
2768 || (INTEGERP (Vtruncate_partial_width_windows
)
2769 /* PXW: Shall we do something about this? */
2770 && (XINT (Vtruncate_partial_width_windows
)
2771 <= WINDOW_TOTAL_COLS (it
->w
))))
2772 && NILP (BVAR (current_buffer
, truncate_lines
)))
2773 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2774 ? WINDOW_WRAP
: WORD_WRAP
;
2776 /* Get dimensions of truncation and continuation glyphs. These are
2777 displayed as fringe bitmaps under X, but we need them for such
2778 frames when the fringes are turned off. But leave the dimensions
2779 zero for tooltip frames, as these glyphs look ugly there and also
2780 sabotage calculations of tooltip dimensions in x-show-tip. */
2781 #ifdef HAVE_WINDOW_SYSTEM
2782 if (!(FRAME_WINDOW_P (it
->f
)
2783 && FRAMEP (tip_frame
)
2784 && it
->f
== XFRAME (tip_frame
)))
2787 if (it
->line_wrap
== TRUNCATE
)
2789 /* We will need the truncation glyph. */
2790 eassert (it
->glyph_row
== NULL
);
2791 produce_special_glyphs (it
, IT_TRUNCATION
);
2792 it
->truncation_pixel_width
= it
->pixel_width
;
2796 /* We will need the continuation glyph. */
2797 eassert (it
->glyph_row
== NULL
);
2798 produce_special_glyphs (it
, IT_CONTINUATION
);
2799 it
->continuation_pixel_width
= it
->pixel_width
;
2803 /* Reset these values to zero because the produce_special_glyphs
2804 above has changed them. */
2805 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2806 it
->phys_ascent
= it
->phys_descent
= 0;
2808 /* Set this after getting the dimensions of truncation and
2809 continuation glyphs, so that we don't produce glyphs when calling
2810 produce_special_glyphs, above. */
2811 it
->glyph_row
= row
;
2812 it
->area
= TEXT_AREA
;
2814 /* Get the dimensions of the display area. The display area
2815 consists of the visible window area plus a horizontally scrolled
2816 part to the left of the window. All x-values are relative to the
2817 start of this total display area. */
2818 if (base_face_id
!= DEFAULT_FACE_ID
)
2820 /* Mode lines, menu bar in terminal frames. */
2821 it
->first_visible_x
= 0;
2822 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2827 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2828 it
->last_visible_x
= (it
->first_visible_x
2829 + window_box_width (w
, TEXT_AREA
));
2831 /* If we truncate lines, leave room for the truncation glyph(s) at
2832 the right margin. Otherwise, leave room for the continuation
2833 glyph(s). Done only if the window has no right fringe. */
2834 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2836 if (it
->line_wrap
== TRUNCATE
)
2837 it
->last_visible_x
-= it
->truncation_pixel_width
;
2839 it
->last_visible_x
-= it
->continuation_pixel_width
;
2842 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2843 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2846 /* Leave room for a border glyph. */
2847 if (!FRAME_WINDOW_P (it
->f
)
2848 && !WINDOW_RIGHTMOST_P (it
->w
))
2849 it
->last_visible_x
-= 1;
2851 it
->last_visible_y
= window_text_bottom_y (w
);
2853 /* For mode lines and alike, arrange for the first glyph having a
2854 left box line if the face specifies a box. */
2855 if (base_face_id
!= DEFAULT_FACE_ID
)
2859 it
->face_id
= remapped_base_face_id
;
2861 /* If we have a boxed mode line, make the first character appear
2862 with a left box line. */
2863 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2864 if (face
&& face
->box
!= FACE_NO_BOX
)
2865 it
->start_of_box_run_p
= true;
2868 /* If a buffer position was specified, set the iterator there,
2869 getting overlays and face properties from that position. */
2870 if (charpos
>= BUF_BEG (current_buffer
))
2872 it
->stop_charpos
= charpos
;
2873 it
->end_charpos
= ZV
;
2874 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2875 IT_CHARPOS (*it
) = charpos
;
2876 IT_BYTEPOS (*it
) = bytepos
;
2878 /* We will rely on `reseat' to set this up properly, via
2879 handle_face_prop. */
2880 it
->face_id
= it
->base_face_id
;
2882 it
->start
= it
->current
;
2883 /* Do we need to reorder bidirectional text? Not if this is a
2884 unibyte buffer: by definition, none of the single-byte
2885 characters are strong R2L, so no reordering is needed. And
2886 bidi.c doesn't support unibyte buffers anyway. Also, don't
2887 reorder while we are loading loadup.el, since the tables of
2888 character properties needed for reordering are not yet
2892 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2895 /* If we are to reorder bidirectional text, init the bidi
2899 /* Since we don't know at this point whether there will be
2900 any R2L lines in the window, we reserve space for
2901 truncation/continuation glyphs even if only the left
2902 fringe is absent. */
2903 if (base_face_id
== DEFAULT_FACE_ID
2904 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2905 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2907 if (it
->line_wrap
== TRUNCATE
)
2908 it
->last_visible_x
-= it
->truncation_pixel_width
;
2910 it
->last_visible_x
-= it
->continuation_pixel_width
;
2912 /* Note the paragraph direction that this buffer wants to
2914 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2916 it
->paragraph_embedding
= L2R
;
2917 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2919 it
->paragraph_embedding
= R2L
;
2921 it
->paragraph_embedding
= NEUTRAL_DIR
;
2922 bidi_unshelve_cache (NULL
, false);
2923 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2927 /* Compute faces etc. */
2928 reseat (it
, it
->current
.pos
, true);
2935 /* Initialize IT for the display of window W with window start POS. */
2938 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2940 struct glyph_row
*row
;
2941 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2943 row
= w
->desired_matrix
->rows
+ first_vpos
;
2944 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2945 it
->first_vpos
= first_vpos
;
2947 /* Don't reseat to previous visible line start if current start
2948 position is in a string or image. */
2949 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2951 int first_y
= it
->current_y
;
2953 /* If window start is not at a line start, skip forward to POS to
2954 get the correct continuation lines width. */
2955 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2956 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2957 if (!start_at_line_beg_p
)
2961 reseat_at_previous_visible_line_start (it
);
2962 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2964 new_x
= it
->current_x
+ it
->pixel_width
;
2966 /* If lines are continued, this line may end in the middle
2967 of a multi-glyph character (e.g. a control character
2968 displayed as \003, or in the middle of an overlay
2969 string). In this case move_it_to above will not have
2970 taken us to the start of the continuation line but to the
2971 end of the continued line. */
2972 if (it
->current_x
> 0
2973 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2974 && (/* And glyph doesn't fit on the line. */
2975 new_x
> it
->last_visible_x
2976 /* Or it fits exactly and we're on a window
2978 || (new_x
== it
->last_visible_x
2979 && FRAME_WINDOW_P (it
->f
)
2980 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2981 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2982 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2984 if ((it
->current
.dpvec_index
>= 0
2985 || it
->current
.overlay_string_index
>= 0)
2986 /* If we are on a newline from a display vector or
2987 overlay string, then we are already at the end of
2988 a screen line; no need to go to the next line in
2989 that case, as this line is not really continued.
2990 (If we do go to the next line, C-e will not DTRT.) */
2993 set_iterator_to_next (it
, true);
2994 move_it_in_display_line_to (it
, -1, -1, 0);
2997 it
->continuation_lines_width
+= it
->current_x
;
2999 /* If the character at POS is displayed via a display
3000 vector, move_it_to above stops at the final glyph of
3001 IT->dpvec. To make the caller redisplay that character
3002 again (a.k.a. start at POS), we need to reset the
3003 dpvec_index to the beginning of IT->dpvec. */
3004 else if (it
->current
.dpvec_index
>= 0)
3005 it
->current
.dpvec_index
= 0;
3007 /* We're starting a new display line, not affected by the
3008 height of the continued line, so clear the appropriate
3009 fields in the iterator structure. */
3010 it
->max_ascent
= it
->max_descent
= 0;
3011 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3013 it
->current_y
= first_y
;
3015 it
->current_x
= it
->hpos
= 0;
3021 /* Return true if POS is a position in ellipses displayed for invisible
3022 text. W is the window we display, for text property lookup. */
3025 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3027 Lisp_Object prop
, window
;
3028 bool ellipses_p
= false;
3029 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3031 /* If POS specifies a position in a display vector, this might
3032 be for an ellipsis displayed for invisible text. We won't
3033 get the iterator set up for delivering that ellipsis unless
3034 we make sure that it gets aware of the invisible text. */
3035 if (pos
->dpvec_index
>= 0
3036 && pos
->overlay_string_index
< 0
3037 && CHARPOS (pos
->string_pos
) < 0
3039 && (XSETWINDOW (window
, w
),
3040 prop
= Fget_char_property (make_number (charpos
),
3041 Qinvisible
, window
),
3042 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3044 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3046 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3053 /* Initialize IT for stepping through current_buffer in window W,
3054 starting at position POS that includes overlay string and display
3055 vector/ control character translation position information. Value
3056 is false if there are overlay strings with newlines at POS. */
3059 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3061 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3063 bool overlay_strings_with_newlines
= false;
3065 /* If POS specifies a position in a display vector, this might
3066 be for an ellipsis displayed for invisible text. We won't
3067 get the iterator set up for delivering that ellipsis unless
3068 we make sure that it gets aware of the invisible text. */
3069 if (in_ellipses_for_invisible_text_p (pos
, w
))
3075 /* Keep in mind: the call to reseat in init_iterator skips invisible
3076 text, so we might end up at a position different from POS. This
3077 is only a problem when POS is a row start after a newline and an
3078 overlay starts there with an after-string, and the overlay has an
3079 invisible property. Since we don't skip invisible text in
3080 display_line and elsewhere immediately after consuming the
3081 newline before the row start, such a POS will not be in a string,
3082 but the call to init_iterator below will move us to the
3084 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3086 /* This only scans the current chunk -- it should scan all chunks.
3087 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3088 to 16 in 22.1 to make this a lesser problem. */
3089 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3091 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3092 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3094 while (s
< e
&& *s
!= '\n')
3099 overlay_strings_with_newlines
= true;
3104 /* If position is within an overlay string, set up IT to the right
3106 if (pos
->overlay_string_index
>= 0)
3110 /* If the first overlay string happens to have a `display'
3111 property for an image, the iterator will be set up for that
3112 image, and we have to undo that setup first before we can
3113 correct the overlay string index. */
3114 if (it
->method
== GET_FROM_IMAGE
)
3117 /* We already have the first chunk of overlay strings in
3118 IT->overlay_strings. Load more until the one for
3119 pos->overlay_string_index is in IT->overlay_strings. */
3120 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3122 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3123 it
->current
.overlay_string_index
= 0;
3126 load_overlay_strings (it
, 0);
3127 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3131 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3132 relative_index
= (it
->current
.overlay_string_index
3133 % OVERLAY_STRING_CHUNK_SIZE
);
3134 it
->string
= it
->overlay_strings
[relative_index
];
3135 eassert (STRINGP (it
->string
));
3136 it
->current
.string_pos
= pos
->string_pos
;
3137 it
->method
= GET_FROM_STRING
;
3138 it
->end_charpos
= SCHARS (it
->string
);
3139 /* Set up the bidi iterator for this overlay string. */
3142 it
->bidi_it
.string
.lstring
= it
->string
;
3143 it
->bidi_it
.string
.s
= NULL
;
3144 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3145 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3146 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3147 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3148 it
->bidi_it
.w
= it
->w
;
3149 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3150 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3152 /* Synchronize the state of the bidi iterator with
3153 pos->string_pos. For any string position other than
3154 zero, this will be done automagically when we resume
3155 iteration over the string and get_visually_first_element
3156 is called. But if string_pos is zero, and the string is
3157 to be reordered for display, we need to resync manually,
3158 since it could be that the iteration state recorded in
3159 pos ended at string_pos of 0 moving backwards in string. */
3160 if (CHARPOS (pos
->string_pos
) == 0)
3162 get_visually_first_element (it
);
3163 if (IT_STRING_CHARPOS (*it
) != 0)
3166 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3167 bidi_move_to_visually_next (&it
->bidi_it
);
3168 } while (it
->bidi_it
.charpos
!= 0);
3170 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3171 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3175 if (CHARPOS (pos
->string_pos
) >= 0)
3177 /* Recorded position is not in an overlay string, but in another
3178 string. This can only be a string from a `display' property.
3179 IT should already be filled with that string. */
3180 it
->current
.string_pos
= pos
->string_pos
;
3181 eassert (STRINGP (it
->string
));
3183 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3184 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3187 /* Restore position in display vector translations, control
3188 character translations or ellipses. */
3189 if (pos
->dpvec_index
>= 0)
3191 if (it
->dpvec
== NULL
)
3192 get_next_display_element (it
);
3193 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3194 it
->current
.dpvec_index
= pos
->dpvec_index
;
3198 return !overlay_strings_with_newlines
;
3202 /* Initialize IT for stepping through current_buffer in window W
3203 starting at ROW->start. */
3206 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3208 init_from_display_pos (it
, w
, &row
->start
);
3209 it
->start
= row
->start
;
3210 it
->continuation_lines_width
= row
->continuation_lines_width
;
3215 /* Initialize IT for stepping through current_buffer in window W
3216 starting in the line following ROW, i.e. starting at ROW->end.
3217 Value is false if there are overlay strings with newlines at ROW's
3221 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3223 bool success
= false;
3225 if (init_from_display_pos (it
, w
, &row
->end
))
3227 if (row
->continued_p
)
3228 it
->continuation_lines_width
3229 = row
->continuation_lines_width
+ row
->pixel_width
;
3240 /***********************************************************************
3242 ***********************************************************************/
3244 /* Called when IT reaches IT->stop_charpos. Handle text property and
3245 overlay changes. Set IT->stop_charpos to the next position where
3249 handle_stop (struct it
*it
)
3251 enum prop_handled handled
;
3252 bool handle_overlay_change_p
;
3256 it
->current
.dpvec_index
= -1;
3257 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3258 it
->ellipsis_p
= false;
3260 /* Use face of preceding text for ellipsis (if invisible) */
3261 if (it
->selective_display_ellipsis_p
)
3262 it
->saved_face_id
= it
->face_id
;
3264 /* Here's the description of the semantics of, and the logic behind,
3265 the various HANDLED_* statuses:
3267 HANDLED_NORMALLY means the handler did its job, and the loop
3268 should proceed to calling the next handler in order.
3270 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3271 change in the properties and overlays at current position, so the
3272 loop should be restarted, to re-invoke the handlers that were
3273 already called. This happens when fontification-functions were
3274 called by handle_fontified_prop, and actually fontified
3275 something. Another case where HANDLED_RECOMPUTE_PROPS is
3276 returned is when we discover overlay strings that need to be
3277 displayed right away. The loop below will continue for as long
3278 as the status is HANDLED_RECOMPUTE_PROPS.
3280 HANDLED_RETURN means return immediately to the caller, to
3281 continue iteration without calling any further handlers. This is
3282 used when we need to act on some property right away, for example
3283 when we need to display the ellipsis or a replacing display
3284 property, such as display string or image.
3286 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3287 consumed, and the handler switched to the next overlay string.
3288 This signals the loop below to refrain from looking for more
3289 overlays before all the overlay strings of the current overlay
3292 Some of the handlers called by the loop push the iterator state
3293 onto the stack (see 'push_it'), and arrange for the iteration to
3294 continue with another object, such as an image, a display string,
3295 or an overlay string. In most such cases, it->stop_charpos is
3296 set to the first character of the string, so that when the
3297 iteration resumes, this function will immediately be called
3298 again, to examine the properties at the beginning of the string.
3300 When a display or overlay string is exhausted, the iterator state
3301 is popped (see 'pop_it'), and iteration continues with the
3302 previous object. Again, in many such cases this function is
3303 called again to find the next position where properties might
3308 handled
= HANDLED_NORMALLY
;
3310 /* Call text property handlers. */
3311 for (p
= it_props
; p
->handler
; ++p
)
3313 handled
= p
->handler (it
);
3315 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3317 else if (handled
== HANDLED_RETURN
)
3319 /* We still want to show before and after strings from
3320 overlays even if the actual buffer text is replaced. */
3321 if (!handle_overlay_change_p
3323 /* Don't call get_overlay_strings_1 if we already
3324 have overlay strings loaded, because doing so
3325 will load them again and push the iterator state
3326 onto the stack one more time, which is not
3327 expected by the rest of the code that processes
3329 || (it
->current
.overlay_string_index
< 0
3330 && !get_overlay_strings_1 (it
, 0, false)))
3333 setup_for_ellipsis (it
, 0);
3334 /* When handling a display spec, we might load an
3335 empty string. In that case, discard it here. We
3336 used to discard it in handle_single_display_spec,
3337 but that causes get_overlay_strings_1, above, to
3338 ignore overlay strings that we must check. */
3339 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3343 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3347 it
->string_from_display_prop_p
= false;
3348 it
->from_disp_prop_p
= false;
3349 handle_overlay_change_p
= false;
3351 handled
= HANDLED_RECOMPUTE_PROPS
;
3354 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3355 handle_overlay_change_p
= false;
3358 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3360 /* Don't check for overlay strings below when set to deliver
3361 characters from a display vector. */
3362 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3363 handle_overlay_change_p
= false;
3365 /* Handle overlay changes.
3366 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3367 if it finds overlays. */
3368 if (handle_overlay_change_p
)
3369 handled
= handle_overlay_change (it
);
3374 setup_for_ellipsis (it
, 0);
3378 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3380 /* Determine where to stop next. */
3381 if (handled
== HANDLED_NORMALLY
)
3382 compute_stop_pos (it
);
3386 /* Compute IT->stop_charpos from text property and overlay change
3387 information for IT's current position. */
3390 compute_stop_pos (struct it
*it
)
3392 register INTERVAL iv
, next_iv
;
3393 Lisp_Object object
, limit
, position
;
3394 ptrdiff_t charpos
, bytepos
;
3396 if (STRINGP (it
->string
))
3398 /* Strings are usually short, so don't limit the search for
3400 it
->stop_charpos
= it
->end_charpos
;
3401 object
= it
->string
;
3403 charpos
= IT_STRING_CHARPOS (*it
);
3404 bytepos
= IT_STRING_BYTEPOS (*it
);
3410 /* If end_charpos is out of range for some reason, such as a
3411 misbehaving display function, rationalize it (Bug#5984). */
3412 if (it
->end_charpos
> ZV
)
3413 it
->end_charpos
= ZV
;
3414 it
->stop_charpos
= it
->end_charpos
;
3416 /* If next overlay change is in front of the current stop pos
3417 (which is IT->end_charpos), stop there. Note: value of
3418 next_overlay_change is point-max if no overlay change
3420 charpos
= IT_CHARPOS (*it
);
3421 bytepos
= IT_BYTEPOS (*it
);
3422 pos
= next_overlay_change (charpos
);
3423 if (pos
< it
->stop_charpos
)
3424 it
->stop_charpos
= pos
;
3426 /* Set up variables for computing the stop position from text
3427 property changes. */
3428 XSETBUFFER (object
, current_buffer
);
3429 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3432 /* Get the interval containing IT's position. Value is a null
3433 interval if there isn't such an interval. */
3434 position
= make_number (charpos
);
3435 iv
= validate_interval_range (object
, &position
, &position
, false);
3438 Lisp_Object values_here
[LAST_PROP_IDX
];
3441 /* Get properties here. */
3442 for (p
= it_props
; p
->handler
; ++p
)
3443 values_here
[p
->idx
] = textget (iv
->plist
,
3444 builtin_lisp_symbol (p
->name
));
3446 /* Look for an interval following iv that has different
3448 for (next_iv
= next_interval (iv
);
3451 || XFASTINT (limit
) > next_iv
->position
));
3452 next_iv
= next_interval (next_iv
))
3454 for (p
= it_props
; p
->handler
; ++p
)
3456 Lisp_Object new_value
= textget (next_iv
->plist
,
3457 builtin_lisp_symbol (p
->name
));
3458 if (!EQ (values_here
[p
->idx
], new_value
))
3468 if (INTEGERP (limit
)
3469 && next_iv
->position
>= XFASTINT (limit
))
3470 /* No text property change up to limit. */
3471 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3473 /* Text properties change in next_iv. */
3474 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3478 if (it
->cmp_it
.id
< 0)
3480 ptrdiff_t stoppos
= it
->end_charpos
;
3482 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3484 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3485 stoppos
, it
->string
);
3488 eassert (STRINGP (it
->string
)
3489 || (it
->stop_charpos
>= BEGV
3490 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3494 /* Return the position of the next overlay change after POS in
3495 current_buffer. Value is point-max if no overlay change
3496 follows. This is like `next-overlay-change' but doesn't use
3500 next_overlay_change (ptrdiff_t pos
)
3502 ptrdiff_t i
, noverlays
;
3504 Lisp_Object
*overlays
;
3507 /* Get all overlays at the given position. */
3508 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3510 /* If any of these overlays ends before endpos,
3511 use its ending point instead. */
3512 for (i
= 0; i
< noverlays
; ++i
)
3517 oend
= OVERLAY_END (overlays
[i
]);
3518 oendpos
= OVERLAY_POSITION (oend
);
3519 endpos
= min (endpos
, oendpos
);
3526 /* How many characters forward to search for a display property or
3527 display string. Searching too far forward makes the bidi display
3528 sluggish, especially in small windows. */
3529 #define MAX_DISP_SCAN 250
3531 /* Return the character position of a display string at or after
3532 position specified by POSITION. If no display string exists at or
3533 after POSITION, return ZV. A display string is either an overlay
3534 with `display' property whose value is a string, or a `display'
3535 text property whose value is a string. STRING is data about the
3536 string to iterate; if STRING->lstring is nil, we are iterating a
3537 buffer. FRAME_WINDOW_P is true when we are displaying a window
3538 on a GUI frame. DISP_PROP is set to zero if we searched
3539 MAX_DISP_SCAN characters forward without finding any display
3540 strings, non-zero otherwise. It is set to 2 if the display string
3541 uses any kind of `(space ...)' spec that will produce a stretch of
3542 white space in the text area. */
3544 compute_display_string_pos (struct text_pos
*position
,
3545 struct bidi_string_data
*string
,
3547 bool frame_window_p
, int *disp_prop
)
3549 /* OBJECT = nil means current buffer. */
3550 Lisp_Object object
, object1
;
3551 Lisp_Object pos
, spec
, limpos
;
3552 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3553 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3554 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3555 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3557 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3558 struct text_pos tpos
;
3561 if (string
&& STRINGP (string
->lstring
))
3562 object1
= object
= string
->lstring
;
3563 else if (w
&& !string_p
)
3565 XSETWINDOW (object
, w
);
3569 object1
= object
= Qnil
;
3574 /* We don't support display properties whose values are strings
3575 that have display string properties. */
3576 || string
->from_disp_str
3577 /* C strings cannot have display properties. */
3578 || (string
->s
&& !STRINGP (object
)))
3584 /* If the character at CHARPOS is where the display string begins,
3586 pos
= make_number (charpos
);
3587 if (STRINGP (object
))
3588 bufpos
= string
->bufpos
;
3592 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3594 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3597 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3605 /* Look forward for the first character with a `display' property
3606 that will replace the underlying text when displayed. */
3607 limpos
= make_number (lim
);
3609 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3610 CHARPOS (tpos
) = XFASTINT (pos
);
3611 if (CHARPOS (tpos
) >= lim
)
3616 if (STRINGP (object
))
3617 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3619 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3620 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3621 if (!STRINGP (object
))
3622 bufpos
= CHARPOS (tpos
);
3623 } while (NILP (spec
)
3624 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3625 bufpos
, frame_window_p
)));
3629 return CHARPOS (tpos
);
3632 /* Return the character position of the end of the display string that
3633 started at CHARPOS. If there's no display string at CHARPOS,
3634 return -1. A display string is either an overlay with `display'
3635 property whose value is a string or a `display' text property whose
3636 value is a string. */
3638 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3640 /* OBJECT = nil means current buffer. */
3641 Lisp_Object object
=
3642 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3643 Lisp_Object pos
= make_number (charpos
);
3645 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3647 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3650 /* It could happen that the display property or overlay was removed
3651 since we found it in compute_display_string_pos above. One way
3652 this can happen is if JIT font-lock was called (through
3653 handle_fontified_prop), and jit-lock-functions remove text
3654 properties or overlays from the portion of buffer that includes
3655 CHARPOS. Muse mode is known to do that, for example. In this
3656 case, we return -1 to the caller, to signal that no display
3657 string is actually present at CHARPOS. See bidi_fetch_char for
3658 how this is handled.
3660 An alternative would be to never look for display properties past
3661 it->stop_charpos. But neither compute_display_string_pos nor
3662 bidi_fetch_char that calls it know or care where the next
3664 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3667 /* Look forward for the first character where the `display' property
3669 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3671 return XFASTINT (pos
);
3676 /***********************************************************************
3678 ***********************************************************************/
3680 /* Handle changes in the `fontified' property of the current buffer by
3681 calling hook functions from Qfontification_functions to fontify
3684 static enum prop_handled
3685 handle_fontified_prop (struct it
*it
)
3687 Lisp_Object prop
, pos
;
3688 enum prop_handled handled
= HANDLED_NORMALLY
;
3690 if (!NILP (Vmemory_full
))
3693 /* Get the value of the `fontified' property at IT's current buffer
3694 position. (The `fontified' property doesn't have a special
3695 meaning in strings.) If the value is nil, call functions from
3696 Qfontification_functions. */
3697 if (!STRINGP (it
->string
)
3699 && !NILP (Vfontification_functions
)
3700 && !NILP (Vrun_hooks
)
3701 && (pos
= make_number (IT_CHARPOS (*it
)),
3702 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3703 /* Ignore the special cased nil value always present at EOB since
3704 no amount of fontifying will be able to change it. */
3705 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3707 ptrdiff_t count
= SPECPDL_INDEX ();
3709 struct buffer
*obuf
= current_buffer
;
3710 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3711 bool old_clip_changed
= current_buffer
->clip_changed
;
3713 val
= Vfontification_functions
;
3714 specbind (Qfontification_functions
, Qnil
);
3716 eassert (it
->end_charpos
== ZV
);
3718 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3719 safe_call1 (val
, pos
);
3722 Lisp_Object fns
, fn
;
3726 for (; CONSP (val
); val
= XCDR (val
))
3732 /* A value of t indicates this hook has a local
3733 binding; it means to run the global binding too.
3734 In a global value, t should not occur. If it
3735 does, we must ignore it to avoid an endless
3737 for (fns
= Fdefault_value (Qfontification_functions
);
3743 safe_call1 (fn
, pos
);
3747 safe_call1 (fn
, pos
);
3751 unbind_to (count
, Qnil
);
3753 /* Fontification functions routinely call `save-restriction'.
3754 Normally, this tags clip_changed, which can confuse redisplay
3755 (see discussion in Bug#6671). Since we don't perform any
3756 special handling of fontification changes in the case where
3757 `save-restriction' isn't called, there's no point doing so in
3758 this case either. So, if the buffer's restrictions are
3759 actually left unchanged, reset clip_changed. */
3760 if (obuf
== current_buffer
)
3762 if (begv
== BEGV
&& zv
== ZV
)
3763 current_buffer
->clip_changed
= old_clip_changed
;
3765 /* There isn't much we can reasonably do to protect against
3766 misbehaving fontification, but here's a fig leaf. */
3767 else if (BUFFER_LIVE_P (obuf
))
3768 set_buffer_internal_1 (obuf
);
3770 /* The fontification code may have added/removed text.
3771 It could do even a lot worse, but let's at least protect against
3772 the most obvious case where only the text past `pos' gets changed',
3773 as is/was done in grep.el where some escapes sequences are turned
3774 into face properties (bug#7876). */
3775 it
->end_charpos
= ZV
;
3777 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3778 something. This avoids an endless loop if they failed to
3779 fontify the text for which reason ever. */
3780 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3781 handled
= HANDLED_RECOMPUTE_PROPS
;
3789 /***********************************************************************
3791 ***********************************************************************/
3793 /* Set up iterator IT from face properties at its current position.
3794 Called from handle_stop. */
3796 static enum prop_handled
3797 handle_face_prop (struct it
*it
)
3800 ptrdiff_t next_stop
;
3802 if (!STRINGP (it
->string
))
3805 = face_at_buffer_position (it
->w
,
3809 + TEXT_PROP_DISTANCE_LIMIT
),
3810 false, it
->base_face_id
);
3812 /* Is this a start of a run of characters with box face?
3813 Caveat: this can be called for a freshly initialized
3814 iterator; face_id is -1 in this case. We know that the new
3815 face will not change until limit, i.e. if the new face has a
3816 box, all characters up to limit will have one. But, as
3817 usual, we don't know whether limit is really the end. */
3818 if (new_face_id
!= it
->face_id
)
3820 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3821 /* If it->face_id is -1, old_face below will be NULL, see
3822 the definition of FACE_FROM_ID. This will happen if this
3823 is the initial call that gets the face. */
3824 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3826 /* If the value of face_id of the iterator is -1, we have to
3827 look in front of IT's position and see whether there is a
3828 face there that's different from new_face_id. */
3829 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3831 int prev_face_id
= face_before_it_pos (it
);
3833 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3836 /* If the new face has a box, but the old face does not,
3837 this is the start of a run of characters with box face,
3838 i.e. this character has a shadow on the left side. */
3839 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3840 && (old_face
== NULL
|| !old_face
->box
));
3841 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3849 Lisp_Object from_overlay
3850 = (it
->current
.overlay_string_index
>= 0
3851 ? it
->string_overlays
[it
->current
.overlay_string_index
3852 % OVERLAY_STRING_CHUNK_SIZE
]
3855 /* See if we got to this string directly or indirectly from
3856 an overlay property. That includes the before-string or
3857 after-string of an overlay, strings in display properties
3858 provided by an overlay, their text properties, etc.
3860 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3861 if (! NILP (from_overlay
))
3862 for (i
= it
->sp
- 1; i
>= 0; i
--)
3864 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3866 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3867 % OVERLAY_STRING_CHUNK_SIZE
];
3868 else if (! NILP (it
->stack
[i
].from_overlay
))
3869 from_overlay
= it
->stack
[i
].from_overlay
;
3871 if (!NILP (from_overlay
))
3875 if (! NILP (from_overlay
))
3877 bufpos
= IT_CHARPOS (*it
);
3878 /* For a string from an overlay, the base face depends
3879 only on text properties and ignores overlays. */
3881 = face_for_overlay_string (it
->w
,
3885 + TEXT_PROP_DISTANCE_LIMIT
),
3893 /* For strings from a `display' property, use the face at
3894 IT's current buffer position as the base face to merge
3895 with, so that overlay strings appear in the same face as
3896 surrounding text, unless they specify their own faces.
3897 For strings from wrap-prefix and line-prefix properties,
3898 use the default face, possibly remapped via
3899 Vface_remapping_alist. */
3900 /* Note that the fact that we use the face at _buffer_
3901 position means that a 'display' property on an overlay
3902 string will not inherit the face of that overlay string,
3903 but will instead revert to the face of buffer text
3904 covered by the overlay. This is visible, e.g., when the
3905 overlay specifies a box face, but neither the buffer nor
3906 the display string do. This sounds like a design bug,
3907 but Emacs always did that since v21.1, so changing that
3908 might be a big deal. */
3909 base_face_id
= it
->string_from_prefix_prop_p
3910 ? (!NILP (Vface_remapping_alist
)
3911 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3913 : underlying_face_id (it
);
3916 new_face_id
= face_at_string_position (it
->w
,
3918 IT_STRING_CHARPOS (*it
),
3921 base_face_id
, false);
3923 /* Is this a start of a run of characters with box? Caveat:
3924 this can be called for a freshly allocated iterator; face_id
3925 is -1 is this case. We know that the new face will not
3926 change until the next check pos, i.e. if the new face has a
3927 box, all characters up to that position will have a
3928 box. But, as usual, we don't know whether that position
3929 is really the end. */
3930 if (new_face_id
!= it
->face_id
)
3932 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3933 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3935 /* If new face has a box but old face hasn't, this is the
3936 start of a run of characters with box, i.e. it has a
3937 shadow on the left side. */
3938 it
->start_of_box_run_p
3939 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3940 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3944 it
->face_id
= new_face_id
;
3945 return HANDLED_NORMALLY
;
3949 /* Return the ID of the face ``underlying'' IT's current position,
3950 which is in a string. If the iterator is associated with a
3951 buffer, return the face at IT's current buffer position.
3952 Otherwise, use the iterator's base_face_id. */
3955 underlying_face_id (struct it
*it
)
3957 int face_id
= it
->base_face_id
, i
;
3959 eassert (STRINGP (it
->string
));
3961 for (i
= it
->sp
- 1; i
>= 0; --i
)
3962 if (NILP (it
->stack
[i
].string
))
3963 face_id
= it
->stack
[i
].face_id
;
3969 /* Compute the face one character before or after the current position
3970 of IT, in the visual order. BEFORE_P means get the face
3971 in front (to the left in L2R paragraphs, to the right in R2L
3972 paragraphs) of IT's screen position. Value is the ID of the face. */
3975 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3978 ptrdiff_t next_check_charpos
;
3980 void *it_copy_data
= NULL
;
3982 eassert (it
->s
== NULL
);
3984 if (STRINGP (it
->string
))
3986 ptrdiff_t bufpos
, charpos
;
3989 /* No face change past the end of the string (for the case
3990 we are padding with spaces). No face change before the
3992 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3993 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3998 /* Set charpos to the position before or after IT's current
3999 position, in the logical order, which in the non-bidi
4000 case is the same as the visual order. */
4002 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4003 else if (it
->what
== IT_COMPOSITION
)
4004 /* For composition, we must check the character after the
4006 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4008 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4014 /* With bidi iteration, the character before the current
4015 in the visual order cannot be found by simple
4016 iteration, because "reverse" reordering is not
4017 supported. Instead, we need to use the move_it_*
4018 family of functions. */
4019 /* Ignore face changes before the first visible
4020 character on this display line. */
4021 if (it
->current_x
<= it
->first_visible_x
)
4023 SAVE_IT (it_copy
, *it
, it_copy_data
);
4024 /* Implementation note: Since move_it_in_display_line
4025 works in the iterator geometry, and thinks the first
4026 character is always the leftmost, even in R2L lines,
4027 we don't need to distinguish between the R2L and L2R
4029 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4030 it_copy
.current_x
- 1, MOVE_TO_X
);
4031 charpos
= IT_STRING_CHARPOS (it_copy
);
4032 RESTORE_IT (it
, it
, it_copy_data
);
4036 /* Set charpos to the string position of the character
4037 that comes after IT's current position in the visual
4039 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4043 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4045 charpos
= it_copy
.bidi_it
.charpos
;
4048 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4050 if (it
->current
.overlay_string_index
>= 0)
4051 bufpos
= IT_CHARPOS (*it
);
4055 base_face_id
= underlying_face_id (it
);
4057 /* Get the face for ASCII, or unibyte. */
4058 face_id
= face_at_string_position (it
->w
,
4062 &next_check_charpos
,
4063 base_face_id
, false);
4065 /* Correct the face for charsets different from ASCII. Do it
4066 for the multibyte case only. The face returned above is
4067 suitable for unibyte text if IT->string is unibyte. */
4068 if (STRING_MULTIBYTE (it
->string
))
4070 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4071 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4073 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4075 c
= string_char_and_length (p
, &len
);
4076 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4081 struct text_pos pos
;
4083 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4084 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4087 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4088 pos
= it
->current
.pos
;
4093 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4096 if (it
->what
== IT_COMPOSITION
)
4098 /* For composition, we must check the position after
4100 pos
.charpos
+= it
->cmp_it
.nchars
;
4101 pos
.bytepos
+= it
->len
;
4104 INC_TEXT_POS (pos
, it
->multibyte_p
);
4111 /* With bidi iteration, the character before the current
4112 in the visual order cannot be found by simple
4113 iteration, because "reverse" reordering is not
4114 supported. Instead, we need to use the move_it_*
4115 family of functions. */
4116 /* Ignore face changes before the first visible
4117 character on this display line. */
4118 if (it
->current_x
<= it
->first_visible_x
)
4120 SAVE_IT (it_copy
, *it
, it_copy_data
);
4121 /* Implementation note: Since move_it_in_display_line
4122 works in the iterator geometry, and thinks the first
4123 character is always the leftmost, even in R2L lines,
4124 we don't need to distinguish between the R2L and L2R
4126 move_it_in_display_line (&it_copy
, ZV
,
4127 it_copy
.current_x
- 1, MOVE_TO_X
);
4128 pos
= it_copy
.current
.pos
;
4129 RESTORE_IT (it
, it
, it_copy_data
);
4133 /* Set charpos to the buffer position of the character
4134 that comes after IT's current position in the visual
4136 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4140 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4143 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4146 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4148 /* Determine face for CHARSET_ASCII, or unibyte. */
4149 face_id
= face_at_buffer_position (it
->w
,
4151 &next_check_charpos
,
4154 /* Correct the face for charsets different from ASCII. Do it
4155 for the multibyte case only. The face returned above is
4156 suitable for unibyte text if current_buffer is unibyte. */
4157 if (it
->multibyte_p
)
4159 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4160 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4161 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4170 /***********************************************************************
4172 ***********************************************************************/
4174 /* Set up iterator IT from invisible properties at its current
4175 position. Called from handle_stop. */
4177 static enum prop_handled
4178 handle_invisible_prop (struct it
*it
)
4180 enum prop_handled handled
= HANDLED_NORMALLY
;
4184 if (STRINGP (it
->string
))
4186 Lisp_Object end_charpos
, limit
;
4188 /* Get the value of the invisible text property at the
4189 current position. Value will be nil if there is no such
4191 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4192 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4193 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4195 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4197 /* Record whether we have to display an ellipsis for the
4199 bool display_ellipsis_p
= (invis
== 2);
4200 ptrdiff_t len
, endpos
;
4202 handled
= HANDLED_RECOMPUTE_PROPS
;
4204 /* Get the position at which the next visible text can be
4205 found in IT->string, if any. */
4206 endpos
= len
= SCHARS (it
->string
);
4207 XSETINT (limit
, len
);
4211 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4213 /* Since LIMIT is always an integer, so should be the
4214 value returned by Fnext_single_property_change. */
4215 eassert (INTEGERP (end_charpos
));
4216 if (INTEGERP (end_charpos
))
4218 endpos
= XFASTINT (end_charpos
);
4219 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4220 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4222 display_ellipsis_p
= true;
4224 else /* Should never happen; but if it does, exit the loop. */
4227 while (invis
!= 0 && endpos
< len
);
4229 if (display_ellipsis_p
)
4230 it
->ellipsis_p
= true;
4234 /* Text at END_CHARPOS is visible. Move IT there. */
4235 struct text_pos old
;
4238 old
= it
->current
.string_pos
;
4239 oldpos
= CHARPOS (old
);
4242 if (it
->bidi_it
.first_elt
4243 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4244 bidi_paragraph_init (it
->paragraph_embedding
,
4245 &it
->bidi_it
, true);
4246 /* Bidi-iterate out of the invisible text. */
4249 bidi_move_to_visually_next (&it
->bidi_it
);
4251 while (oldpos
<= it
->bidi_it
.charpos
4252 && it
->bidi_it
.charpos
< endpos
);
4254 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4255 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4256 if (IT_CHARPOS (*it
) >= endpos
)
4257 it
->prev_stop
= endpos
;
4261 IT_STRING_CHARPOS (*it
) = endpos
;
4262 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4267 /* The rest of the string is invisible. If this is an
4268 overlay string, proceed with the next overlay string
4269 or whatever comes and return a character from there. */
4270 if (it
->current
.overlay_string_index
>= 0
4271 && !display_ellipsis_p
)
4273 next_overlay_string (it
);
4274 /* Don't check for overlay strings when we just
4275 finished processing them. */
4276 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4280 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4281 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4288 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4289 Lisp_Object pos
, overlay
;
4291 /* First of all, is there invisible text at this position? */
4292 tem
= start_charpos
= IT_CHARPOS (*it
);
4293 pos
= make_number (tem
);
4294 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4296 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4298 /* If we are on invisible text, skip over it. */
4299 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4301 /* Record whether we have to display an ellipsis for the
4303 bool display_ellipsis_p
= invis
== 2;
4305 handled
= HANDLED_RECOMPUTE_PROPS
;
4307 /* Loop skipping over invisible text. The loop is left at
4308 ZV or with IT on the first char being visible again. */
4311 /* Try to skip some invisible text. Return value is the
4312 position reached which can be equal to where we start
4313 if there is nothing invisible there. This skips both
4314 over invisible text properties and overlays with
4315 invisible property. */
4316 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4318 /* If we skipped nothing at all we weren't at invisible
4319 text in the first place. If everything to the end of
4320 the buffer was skipped, end the loop. */
4321 if (newpos
== tem
|| newpos
>= ZV
)
4325 /* We skipped some characters but not necessarily
4326 all there are. Check if we ended up on visible
4327 text. Fget_char_property returns the property of
4328 the char before the given position, i.e. if we
4329 get invis = 0, this means that the char at
4330 newpos is visible. */
4331 pos
= make_number (newpos
);
4332 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4333 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4336 /* If we ended up on invisible text, proceed to
4337 skip starting with next_stop. */
4341 /* If there are adjacent invisible texts, don't lose the
4342 second one's ellipsis. */
4344 display_ellipsis_p
= true;
4348 /* The position newpos is now either ZV or on visible text. */
4351 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4353 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4355 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4357 /* If the invisible text ends on a newline or on a
4358 character after a newline, we can avoid the costly,
4359 character by character, bidi iteration to NEWPOS, and
4360 instead simply reseat the iterator there. That's
4361 because all bidi reordering information is tossed at
4362 the newline. This is a big win for modes that hide
4363 complete lines, like Outline, Org, etc. */
4364 if (on_newline
|| after_newline
)
4366 struct text_pos tpos
;
4367 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4369 SET_TEXT_POS (tpos
, newpos
, bpos
);
4370 reseat_1 (it
, tpos
, false);
4371 /* If we reseat on a newline/ZV, we need to prep the
4372 bidi iterator for advancing to the next character
4373 after the newline/EOB, keeping the current paragraph
4374 direction (so that PRODUCE_GLYPHS does TRT wrt
4375 prepending/appending glyphs to a glyph row). */
4378 it
->bidi_it
.first_elt
= false;
4379 it
->bidi_it
.paragraph_dir
= pdir
;
4380 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4381 it
->bidi_it
.nchars
= 1;
4382 it
->bidi_it
.ch_len
= 1;
4385 else /* Must use the slow method. */
4387 /* With bidi iteration, the region of invisible text
4388 could start and/or end in the middle of a
4389 non-base embedding level. Therefore, we need to
4390 skip invisible text using the bidi iterator,
4391 starting at IT's current position, until we find
4392 ourselves outside of the invisible text.
4393 Skipping invisible text _after_ bidi iteration
4394 avoids affecting the visual order of the
4395 displayed text when invisible properties are
4396 added or removed. */
4397 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4399 /* If we were `reseat'ed to a new paragraph,
4400 determine the paragraph base direction. We
4401 need to do it now because
4402 next_element_from_buffer may not have a
4403 chance to do it, if we are going to skip any
4404 text at the beginning, which resets the
4406 bidi_paragraph_init (it
->paragraph_embedding
,
4407 &it
->bidi_it
, true);
4411 bidi_move_to_visually_next (&it
->bidi_it
);
4413 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4414 && it
->bidi_it
.charpos
< newpos
);
4415 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4416 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4417 /* If we overstepped NEWPOS, record its position in
4418 the iterator, so that we skip invisible text if
4419 later the bidi iteration lands us in the
4420 invisible region again. */
4421 if (IT_CHARPOS (*it
) >= newpos
)
4422 it
->prev_stop
= newpos
;
4427 IT_CHARPOS (*it
) = newpos
;
4428 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4431 if (display_ellipsis_p
)
4433 /* Make sure that the glyphs of the ellipsis will get
4434 correct `charpos' values. If we would not update
4435 it->position here, the glyphs would belong to the
4436 last visible character _before_ the invisible
4437 text, which confuses `set_cursor_from_row'.
4439 We use the last invisible position instead of the
4440 first because this way the cursor is always drawn on
4441 the first "." of the ellipsis, whenever PT is inside
4442 the invisible text. Otherwise the cursor would be
4443 placed _after_ the ellipsis when the point is after the
4444 first invisible character. */
4445 if (!STRINGP (it
->object
))
4447 it
->position
.charpos
= newpos
- 1;
4448 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4452 /* If there are before-strings at the start of invisible
4453 text, and the text is invisible because of a text
4454 property, arrange to show before-strings because 20.x did
4455 it that way. (If the text is invisible because of an
4456 overlay property instead of a text property, this is
4457 already handled in the overlay code.) */
4459 && get_overlay_strings (it
, it
->stop_charpos
))
4461 handled
= HANDLED_RECOMPUTE_PROPS
;
4464 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4465 /* The call to get_overlay_strings above recomputes
4466 it->stop_charpos, but it only considers changes
4467 in properties and overlays beyond iterator's
4468 current position. This causes us to miss changes
4469 that happen exactly where the invisible property
4470 ended. So we play it safe here and force the
4471 iterator to check for potential stop positions
4472 immediately after the invisible text. Note that
4473 if get_overlay_strings returns true, it
4474 normally also pushed the iterator stack, so we
4475 need to update the stop position in the slot
4476 below the current one. */
4477 it
->stack
[it
->sp
- 1].stop_charpos
4478 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4481 else if (display_ellipsis_p
)
4483 it
->ellipsis_p
= true;
4484 /* Let the ellipsis display before
4485 considering any properties of the following char.
4486 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4487 handled
= HANDLED_RETURN
;
4496 /* Make iterator IT return `...' next.
4497 Replaces LEN characters from buffer. */
4500 setup_for_ellipsis (struct it
*it
, int len
)
4502 /* Use the display table definition for `...'. Invalid glyphs
4503 will be handled by the method returning elements from dpvec. */
4504 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4506 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4507 it
->dpvec
= v
->contents
;
4508 it
->dpend
= v
->contents
+ v
->header
.size
;
4512 /* Default `...'. */
4513 it
->dpvec
= default_invis_vector
;
4514 it
->dpend
= default_invis_vector
+ 3;
4517 it
->dpvec_char_len
= len
;
4518 it
->current
.dpvec_index
= 0;
4519 it
->dpvec_face_id
= -1;
4521 /* Remember the current face id in case glyphs specify faces.
4522 IT's face is restored in set_iterator_to_next.
4523 saved_face_id was set to preceding char's face in handle_stop. */
4524 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4525 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4527 /* If the ellipsis represents buffer text, it means we advanced in
4528 the buffer, so we should no longer ignore overlay strings. */
4529 if (it
->method
== GET_FROM_BUFFER
)
4530 it
->ignore_overlay_strings_at_pos_p
= false;
4532 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4533 it
->ellipsis_p
= true;
4538 /***********************************************************************
4540 ***********************************************************************/
4542 /* Set up iterator IT from `display' property at its current position.
4543 Called from handle_stop.
4544 We return HANDLED_RETURN if some part of the display property
4545 overrides the display of the buffer text itself.
4546 Otherwise we return HANDLED_NORMALLY. */
4548 static enum prop_handled
4549 handle_display_prop (struct it
*it
)
4551 Lisp_Object propval
, object
, overlay
;
4552 struct text_pos
*position
;
4554 /* Nonzero if some property replaces the display of the text itself. */
4555 int display_replaced
= 0;
4557 if (STRINGP (it
->string
))
4559 object
= it
->string
;
4560 position
= &it
->current
.string_pos
;
4561 bufpos
= CHARPOS (it
->current
.pos
);
4565 XSETWINDOW (object
, it
->w
);
4566 position
= &it
->current
.pos
;
4567 bufpos
= CHARPOS (*position
);
4570 /* Reset those iterator values set from display property values. */
4571 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4572 it
->space_width
= Qnil
;
4573 it
->font_height
= Qnil
;
4576 /* We don't support recursive `display' properties, i.e. string
4577 values that have a string `display' property, that have a string
4578 `display' property etc. */
4579 if (!it
->string_from_display_prop_p
)
4580 it
->area
= TEXT_AREA
;
4582 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4583 Qdisplay
, object
, &overlay
);
4585 return HANDLED_NORMALLY
;
4586 /* Now OVERLAY is the overlay that gave us this property, or nil
4587 if it was a text property. */
4589 if (!STRINGP (it
->string
))
4590 object
= it
->w
->contents
;
4592 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4594 FRAME_WINDOW_P (it
->f
));
4595 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4598 /* Subroutine of handle_display_prop. Returns non-zero if the display
4599 specification in SPEC is a replacing specification, i.e. it would
4600 replace the text covered by `display' property with something else,
4601 such as an image or a display string. If SPEC includes any kind or
4602 `(space ...) specification, the value is 2; this is used by
4603 compute_display_string_pos, which see.
4605 See handle_single_display_spec for documentation of arguments.
4606 FRAME_WINDOW_P is true if the window being redisplayed is on a
4607 GUI frame; this argument is used only if IT is NULL, see below.
4609 IT can be NULL, if this is called by the bidi reordering code
4610 through compute_display_string_pos, which see. In that case, this
4611 function only examines SPEC, but does not otherwise "handle" it, in
4612 the sense that it doesn't set up members of IT from the display
4615 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4616 Lisp_Object overlay
, struct text_pos
*position
,
4617 ptrdiff_t bufpos
, bool frame_window_p
)
4622 /* Simple specifications. */
4623 && !EQ (XCAR (spec
), Qimage
)
4624 && !EQ (XCAR (spec
), Qspace
)
4625 && !EQ (XCAR (spec
), Qwhen
)
4626 && !EQ (XCAR (spec
), Qslice
)
4627 && !EQ (XCAR (spec
), Qspace_width
)
4628 && !EQ (XCAR (spec
), Qheight
)
4629 && !EQ (XCAR (spec
), Qraise
)
4630 /* Marginal area specifications. */
4631 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4632 && !EQ (XCAR (spec
), Qleft_fringe
)
4633 && !EQ (XCAR (spec
), Qright_fringe
)
4634 && !NILP (XCAR (spec
)))
4636 for (; CONSP (spec
); spec
= XCDR (spec
))
4638 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4639 overlay
, position
, bufpos
,
4640 replacing
, frame_window_p
);
4644 /* If some text in a string is replaced, `position' no
4645 longer points to the position of `object'. */
4646 if (!it
|| STRINGP (object
))
4651 else if (VECTORP (spec
))
4654 for (i
= 0; i
< ASIZE (spec
); ++i
)
4656 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), 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
))
4670 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4671 bufpos
, 0, frame_window_p
);
4675 /* Value is the position of the end of the `display' property starting
4676 at START_POS in OBJECT. */
4678 static struct text_pos
4679 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4682 struct text_pos end_pos
;
4684 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4685 Qdisplay
, object
, Qnil
);
4686 CHARPOS (end_pos
) = XFASTINT (end
);
4687 if (STRINGP (object
))
4688 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4690 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4696 /* Set up IT from a single `display' property specification SPEC. OBJECT
4697 is the object in which the `display' property was found. *POSITION
4698 is the position in OBJECT at which the `display' property was found.
4699 BUFPOS is the buffer position of OBJECT (different from POSITION if
4700 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4701 previously saw a display specification which already replaced text
4702 display with something else, for example an image; we ignore such
4703 properties after the first one has been processed.
4705 OVERLAY is the overlay this `display' property came from,
4706 or nil if it was a text property.
4708 If SPEC is a `space' or `image' specification, and in some other
4709 cases too, set *POSITION to the position where the `display'
4712 If IT is NULL, only examine the property specification in SPEC, but
4713 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4714 is intended to be displayed in a window on a GUI frame.
4716 Value is non-zero if something was found which replaces the display
4717 of buffer or string text. */
4720 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4721 Lisp_Object overlay
, struct text_pos
*position
,
4722 ptrdiff_t bufpos
, int display_replaced
,
4723 bool frame_window_p
)
4726 Lisp_Object location
, value
;
4727 struct text_pos start_pos
= *position
;
4729 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4730 If the result is non-nil, use VALUE instead of SPEC. */
4732 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4741 if (!NILP (form
) && !EQ (form
, Qt
))
4743 ptrdiff_t count
= SPECPDL_INDEX ();
4745 /* Bind `object' to the object having the `display' property, a
4746 buffer or string. Bind `position' to the position in the
4747 object where the property was found, and `buffer-position'
4748 to the current position in the buffer. */
4751 XSETBUFFER (object
, current_buffer
);
4752 specbind (Qobject
, object
);
4753 specbind (Qposition
, make_number (CHARPOS (*position
)));
4754 specbind (Qbuffer_position
, make_number (bufpos
));
4755 form
= safe_eval (form
);
4756 unbind_to (count
, Qnil
);
4762 /* Handle `(height HEIGHT)' specifications. */
4764 && EQ (XCAR (spec
), Qheight
)
4765 && CONSP (XCDR (spec
)))
4769 if (!FRAME_WINDOW_P (it
->f
))
4772 it
->font_height
= XCAR (XCDR (spec
));
4773 if (!NILP (it
->font_height
))
4775 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4776 int new_height
= -1;
4778 if (CONSP (it
->font_height
)
4779 && (EQ (XCAR (it
->font_height
), Qplus
)
4780 || EQ (XCAR (it
->font_height
), Qminus
))
4781 && CONSP (XCDR (it
->font_height
))
4782 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4784 /* `(+ N)' or `(- N)' where N is an integer. */
4785 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4786 if (EQ (XCAR (it
->font_height
), Qplus
))
4788 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4790 else if (FUNCTIONP (it
->font_height
))
4792 /* Call function with current height as argument.
4793 Value is the new height. */
4795 height
= safe_call1 (it
->font_height
,
4796 face
->lface
[LFACE_HEIGHT_INDEX
]);
4797 if (NUMBERP (height
))
4798 new_height
= XFLOATINT (height
);
4800 else if (NUMBERP (it
->font_height
))
4802 /* Value is a multiple of the canonical char height. */
4805 f
= FACE_FROM_ID (it
->f
,
4806 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4807 new_height
= (XFLOATINT (it
->font_height
)
4808 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4812 /* Evaluate IT->font_height with `height' bound to the
4813 current specified height to get the new height. */
4814 ptrdiff_t count
= SPECPDL_INDEX ();
4816 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4817 value
= safe_eval (it
->font_height
);
4818 unbind_to (count
, Qnil
);
4820 if (NUMBERP (value
))
4821 new_height
= XFLOATINT (value
);
4825 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4832 /* Handle `(space-width WIDTH)'. */
4834 && EQ (XCAR (spec
), Qspace_width
)
4835 && CONSP (XCDR (spec
)))
4839 if (!FRAME_WINDOW_P (it
->f
))
4842 value
= XCAR (XCDR (spec
));
4843 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4844 it
->space_width
= value
;
4850 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4852 && EQ (XCAR (spec
), Qslice
))
4858 if (!FRAME_WINDOW_P (it
->f
))
4861 if (tem
= XCDR (spec
), CONSP (tem
))
4863 it
->slice
.x
= XCAR (tem
);
4864 if (tem
= XCDR (tem
), CONSP (tem
))
4866 it
->slice
.y
= XCAR (tem
);
4867 if (tem
= XCDR (tem
), CONSP (tem
))
4869 it
->slice
.width
= XCAR (tem
);
4870 if (tem
= XCDR (tem
), CONSP (tem
))
4871 it
->slice
.height
= XCAR (tem
);
4880 /* Handle `(raise FACTOR)'. */
4882 && EQ (XCAR (spec
), Qraise
)
4883 && CONSP (XCDR (spec
)))
4887 if (!FRAME_WINDOW_P (it
->f
))
4890 #ifdef HAVE_WINDOW_SYSTEM
4891 value
= XCAR (XCDR (spec
));
4892 if (NUMBERP (value
))
4894 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4895 it
->voffset
= - (XFLOATINT (value
)
4896 * (normal_char_height (face
->font
, -1)));
4898 #endif /* HAVE_WINDOW_SYSTEM */
4904 /* Don't handle the other kinds of display specifications
4905 inside a string that we got from a `display' property. */
4906 if (it
&& it
->string_from_display_prop_p
)
4909 /* Characters having this form of property are not displayed, so
4910 we have to find the end of the property. */
4913 start_pos
= *position
;
4914 *position
= display_prop_end (it
, object
, start_pos
);
4915 /* If the display property comes from an overlay, don't consider
4916 any potential stop_charpos values before the end of that
4917 overlay. Since display_prop_end will happily find another
4918 'display' property coming from some other overlay or text
4919 property on buffer positions before this overlay's end, we
4920 need to ignore them, or else we risk displaying this
4921 overlay's display string/image twice. */
4922 if (!NILP (overlay
))
4924 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4926 if (ovendpos
> CHARPOS (*position
))
4927 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4932 /* Stop the scan at that end position--we assume that all
4933 text properties change there. */
4935 it
->stop_charpos
= position
->charpos
;
4937 /* Handle `(left-fringe BITMAP [FACE])'
4938 and `(right-fringe BITMAP [FACE])'. */
4940 && (EQ (XCAR (spec
), Qleft_fringe
)
4941 || EQ (XCAR (spec
), Qright_fringe
))
4942 && CONSP (XCDR (spec
)))
4948 if (!FRAME_WINDOW_P (it
->f
))
4949 /* If we return here, POSITION has been advanced
4950 across the text with this property. */
4952 /* Synchronize the bidi iterator with POSITION. This is
4953 needed because we are not going to push the iterator
4954 on behalf of this display property, so there will be
4955 no pop_it call to do this synchronization for us. */
4958 it
->position
= *position
;
4959 iterate_out_of_display_property (it
);
4960 *position
= it
->position
;
4965 else if (!frame_window_p
)
4968 #ifdef HAVE_WINDOW_SYSTEM
4969 value
= XCAR (XCDR (spec
));
4970 if (!SYMBOLP (value
)
4971 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4972 /* If we return here, POSITION has been advanced
4973 across the text with this property. */
4975 if (it
&& it
->bidi_p
)
4977 it
->position
= *position
;
4978 iterate_out_of_display_property (it
);
4979 *position
= it
->position
;
4986 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4988 if (CONSP (XCDR (XCDR (spec
))))
4990 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4991 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4992 FRINGE_FACE_ID
, false);
4997 /* Save current settings of IT so that we can restore them
4998 when we are finished with the glyph property value. */
4999 push_it (it
, position
);
5001 it
->area
= TEXT_AREA
;
5002 it
->what
= IT_IMAGE
;
5003 it
->image_id
= -1; /* no image */
5004 it
->position
= start_pos
;
5005 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5006 it
->method
= GET_FROM_IMAGE
;
5007 it
->from_overlay
= Qnil
;
5008 it
->face_id
= face_id
;
5009 it
->from_disp_prop_p
= true;
5011 /* Say that we haven't consumed the characters with
5012 `display' property yet. The call to pop_it in
5013 set_iterator_to_next will clean this up. */
5014 *position
= start_pos
;
5016 if (EQ (XCAR (spec
), Qleft_fringe
))
5018 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5019 it
->left_user_fringe_face_id
= face_id
;
5023 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5024 it
->right_user_fringe_face_id
= face_id
;
5027 #endif /* HAVE_WINDOW_SYSTEM */
5031 /* Prepare to handle `((margin left-margin) ...)',
5032 `((margin right-margin) ...)' and `((margin nil) ...)'
5033 prefixes for display specifications. */
5034 location
= Qunbound
;
5035 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5039 value
= XCDR (spec
);
5041 value
= XCAR (value
);
5044 if (EQ (XCAR (tem
), Qmargin
)
5045 && (tem
= XCDR (tem
),
5046 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5048 || EQ (tem
, Qleft_margin
)
5049 || EQ (tem
, Qright_margin
))))
5053 if (EQ (location
, Qunbound
))
5059 /* After this point, VALUE is the property after any
5060 margin prefix has been stripped. It must be a string,
5061 an image specification, or `(space ...)'.
5063 LOCATION specifies where to display: `left-margin',
5064 `right-margin' or nil. */
5066 bool valid_p
= (STRINGP (value
)
5067 #ifdef HAVE_WINDOW_SYSTEM
5068 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5069 && valid_image_p (value
))
5070 #endif /* not HAVE_WINDOW_SYSTEM */
5071 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5073 if (valid_p
&& display_replaced
== 0)
5079 /* Callers need to know whether the display spec is any kind
5080 of `(space ...)' spec that is about to affect text-area
5082 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5087 /* Save current settings of IT so that we can restore them
5088 when we are finished with the glyph property value. */
5089 push_it (it
, position
);
5090 it
->from_overlay
= overlay
;
5091 it
->from_disp_prop_p
= true;
5093 if (NILP (location
))
5094 it
->area
= TEXT_AREA
;
5095 else if (EQ (location
, Qleft_margin
))
5096 it
->area
= LEFT_MARGIN_AREA
;
5098 it
->area
= RIGHT_MARGIN_AREA
;
5100 if (STRINGP (value
))
5103 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5104 it
->current
.overlay_string_index
= -1;
5105 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5106 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5107 it
->method
= GET_FROM_STRING
;
5108 it
->stop_charpos
= 0;
5110 it
->base_level_stop
= 0;
5111 it
->string_from_display_prop_p
= true;
5112 /* Say that we haven't consumed the characters with
5113 `display' property yet. The call to pop_it in
5114 set_iterator_to_next will clean this up. */
5115 if (BUFFERP (object
))
5116 *position
= start_pos
;
5118 /* Force paragraph direction to be that of the parent
5119 object. If the parent object's paragraph direction is
5120 not yet determined, default to L2R. */
5121 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5122 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5124 it
->paragraph_embedding
= L2R
;
5126 /* Set up the bidi iterator for this display string. */
5129 it
->bidi_it
.string
.lstring
= it
->string
;
5130 it
->bidi_it
.string
.s
= NULL
;
5131 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5132 it
->bidi_it
.string
.bufpos
= bufpos
;
5133 it
->bidi_it
.string
.from_disp_str
= true;
5134 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5135 it
->bidi_it
.w
= it
->w
;
5136 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5139 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5141 it
->method
= GET_FROM_STRETCH
;
5143 *position
= it
->position
= start_pos
;
5144 retval
= 1 + (it
->area
== TEXT_AREA
);
5146 #ifdef HAVE_WINDOW_SYSTEM
5149 it
->what
= IT_IMAGE
;
5150 it
->image_id
= lookup_image (it
->f
, value
);
5151 it
->position
= start_pos
;
5152 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5153 it
->method
= GET_FROM_IMAGE
;
5155 /* Say that we haven't consumed the characters with
5156 `display' property yet. The call to pop_it in
5157 set_iterator_to_next will clean this up. */
5158 *position
= start_pos
;
5160 #endif /* HAVE_WINDOW_SYSTEM */
5165 /* Invalid property or property not supported. Restore
5166 POSITION to what it was before. */
5167 *position
= start_pos
;
5171 /* Check if PROP is a display property value whose text should be
5172 treated as intangible. OVERLAY is the overlay from which PROP
5173 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5174 specify the buffer position covered by PROP. */
5177 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5178 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5180 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5181 struct text_pos position
;
5183 SET_TEXT_POS (position
, charpos
, bytepos
);
5184 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5185 &position
, charpos
, frame_window_p
)
5190 /* Return true if PROP is a display sub-property value containing STRING.
5192 Implementation note: this and the following function are really
5193 special cases of handle_display_spec and
5194 handle_single_display_spec, and should ideally use the same code.
5195 Until they do, these two pairs must be consistent and must be
5196 modified in sync. */
5199 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5201 if (EQ (string
, prop
))
5204 /* Skip over `when FORM'. */
5205 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5210 /* Actually, the condition following `when' should be eval'ed,
5211 like handle_single_display_spec does, and we should return
5212 false if it evaluates to nil. However, this function is
5213 called only when the buffer was already displayed and some
5214 glyph in the glyph matrix was found to come from a display
5215 string. Therefore, the condition was already evaluated, and
5216 the result was non-nil, otherwise the display string wouldn't
5217 have been displayed and we would have never been called for
5218 this property. Thus, we can skip the evaluation and assume
5219 its result is non-nil. */
5224 /* Skip over `margin LOCATION'. */
5225 if (EQ (XCAR (prop
), Qmargin
))
5236 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5240 /* Return true if STRING appears in the `display' property PROP. */
5243 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5246 && !EQ (XCAR (prop
), Qwhen
)
5247 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5249 /* A list of sub-properties. */
5250 while (CONSP (prop
))
5252 if (single_display_spec_string_p (XCAR (prop
), string
))
5257 else if (VECTORP (prop
))
5259 /* A vector of sub-properties. */
5261 for (i
= 0; i
< ASIZE (prop
); ++i
)
5262 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5266 return single_display_spec_string_p (prop
, string
);
5271 /* Look for STRING in overlays and text properties in the current
5272 buffer, between character positions FROM and TO (excluding TO).
5273 BACK_P means look back (in this case, TO is supposed to be
5275 Value is the first character position where STRING was found, or
5276 zero if it wasn't found before hitting TO.
5278 This function may only use code that doesn't eval because it is
5279 called asynchronously from note_mouse_highlight. */
5282 string_buffer_position_lim (Lisp_Object string
,
5283 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5285 Lisp_Object limit
, prop
, pos
;
5288 pos
= make_number (max (from
, BEGV
));
5290 if (!back_p
) /* looking forward */
5292 limit
= make_number (min (to
, ZV
));
5293 while (!found
&& !EQ (pos
, limit
))
5295 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5296 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5299 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5303 else /* looking back */
5305 limit
= make_number (max (to
, BEGV
));
5306 while (!found
&& !EQ (pos
, limit
))
5308 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5309 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5312 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5317 return found
? XINT (pos
) : 0;
5320 /* Determine which buffer position in current buffer STRING comes from.
5321 AROUND_CHARPOS is an approximate position where it could come from.
5322 Value is the buffer position or 0 if it couldn't be determined.
5324 This function is necessary because we don't record buffer positions
5325 in glyphs generated from strings (to keep struct glyph small).
5326 This function may only use code that doesn't eval because it is
5327 called asynchronously from note_mouse_highlight. */
5330 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5332 const int MAX_DISTANCE
= 1000;
5333 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5334 around_charpos
+ MAX_DISTANCE
,
5338 found
= string_buffer_position_lim (string
, around_charpos
,
5339 around_charpos
- MAX_DISTANCE
, true);
5345 /***********************************************************************
5346 `composition' property
5347 ***********************************************************************/
5349 /* Set up iterator IT from `composition' property at its current
5350 position. Called from handle_stop. */
5352 static enum prop_handled
5353 handle_composition_prop (struct it
*it
)
5355 Lisp_Object prop
, string
;
5356 ptrdiff_t pos
, pos_byte
, start
, end
;
5358 if (STRINGP (it
->string
))
5362 pos
= IT_STRING_CHARPOS (*it
);
5363 pos_byte
= IT_STRING_BYTEPOS (*it
);
5364 string
= it
->string
;
5365 s
= SDATA (string
) + pos_byte
;
5366 it
->c
= STRING_CHAR (s
);
5370 pos
= IT_CHARPOS (*it
);
5371 pos_byte
= IT_BYTEPOS (*it
);
5373 it
->c
= FETCH_CHAR (pos_byte
);
5376 /* If there's a valid composition and point is not inside of the
5377 composition (in the case that the composition is from the current
5378 buffer), draw a glyph composed from the composition components. */
5379 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5380 && composition_valid_p (start
, end
, prop
)
5381 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5384 /* As we can't handle this situation (perhaps font-lock added
5385 a new composition), we just return here hoping that next
5386 redisplay will detect this composition much earlier. */
5387 return HANDLED_NORMALLY
;
5390 if (STRINGP (it
->string
))
5391 pos_byte
= string_char_to_byte (it
->string
, start
);
5393 pos_byte
= CHAR_TO_BYTE (start
);
5395 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5398 if (it
->cmp_it
.id
>= 0)
5401 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5402 it
->cmp_it
.nglyphs
= -1;
5406 return HANDLED_NORMALLY
;
5411 /***********************************************************************
5413 ***********************************************************************/
5415 /* The following structure is used to record overlay strings for
5416 later sorting in load_overlay_strings. */
5418 struct overlay_entry
5420 Lisp_Object overlay
;
5423 bool after_string_p
;
5427 /* Set up iterator IT from overlay strings at its current position.
5428 Called from handle_stop. */
5430 static enum prop_handled
5431 handle_overlay_change (struct it
*it
)
5433 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5434 return HANDLED_RECOMPUTE_PROPS
;
5436 return HANDLED_NORMALLY
;
5440 /* Set up the next overlay string for delivery by IT, if there is an
5441 overlay string to deliver. Called by set_iterator_to_next when the
5442 end of the current overlay string is reached. If there are more
5443 overlay strings to display, IT->string and
5444 IT->current.overlay_string_index are set appropriately here.
5445 Otherwise IT->string is set to nil. */
5448 next_overlay_string (struct it
*it
)
5450 ++it
->current
.overlay_string_index
;
5451 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5453 /* No more overlay strings. Restore IT's settings to what
5454 they were before overlay strings were processed, and
5455 continue to deliver from current_buffer. */
5457 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5460 || (NILP (it
->string
)
5461 && it
->method
== GET_FROM_BUFFER
5462 && it
->stop_charpos
>= BEGV
5463 && it
->stop_charpos
<= it
->end_charpos
));
5464 it
->current
.overlay_string_index
= -1;
5465 it
->n_overlay_strings
= 0;
5466 /* If there's an empty display string on the stack, pop the
5467 stack, to resync the bidi iterator with IT's position. Such
5468 empty strings are pushed onto the stack in
5469 get_overlay_strings_1. */
5470 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5473 /* Since we've exhausted overlay strings at this buffer
5474 position, set the flag to ignore overlays until we move to
5475 another position. The flag is reset in
5476 next_element_from_buffer. */
5477 it
->ignore_overlay_strings_at_pos_p
= true;
5479 /* If we're at the end of the buffer, record that we have
5480 processed the overlay strings there already, so that
5481 next_element_from_buffer doesn't try it again. */
5482 if (NILP (it
->string
)
5483 && IT_CHARPOS (*it
) >= it
->end_charpos
5484 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5485 it
->overlay_strings_at_end_processed_p
= true;
5486 /* Note: we reset overlay_strings_charpos only here, to make
5487 sure the just-processed overlays were indeed at EOB.
5488 Otherwise, overlays on text with invisible text property,
5489 which are processed with IT's position past the invisible
5490 text, might fool us into thinking the overlays at EOB were
5491 already processed (linum-mode can cause this, for
5493 it
->overlay_strings_charpos
= -1;
5497 /* There are more overlay strings to process. If
5498 IT->current.overlay_string_index has advanced to a position
5499 where we must load IT->overlay_strings with more strings, do
5500 it. We must load at the IT->overlay_strings_charpos where
5501 IT->n_overlay_strings was originally computed; when invisible
5502 text is present, this might not be IT_CHARPOS (Bug#7016). */
5503 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5505 if (it
->current
.overlay_string_index
&& i
== 0)
5506 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5508 /* Initialize IT to deliver display elements from the overlay
5510 it
->string
= it
->overlay_strings
[i
];
5511 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5512 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5513 it
->method
= GET_FROM_STRING
;
5514 it
->stop_charpos
= 0;
5515 it
->end_charpos
= SCHARS (it
->string
);
5516 if (it
->cmp_it
.stop_pos
>= 0)
5517 it
->cmp_it
.stop_pos
= 0;
5519 it
->base_level_stop
= 0;
5521 /* Set up the bidi iterator for this overlay string. */
5524 it
->bidi_it
.string
.lstring
= it
->string
;
5525 it
->bidi_it
.string
.s
= NULL
;
5526 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5527 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5528 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5529 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5530 it
->bidi_it
.w
= it
->w
;
5531 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5539 /* Compare two overlay_entry structures E1 and E2. Used as a
5540 comparison function for qsort in load_overlay_strings. Overlay
5541 strings for the same position are sorted so that
5543 1. All after-strings come in front of before-strings, except
5544 when they come from the same overlay.
5546 2. Within after-strings, strings are sorted so that overlay strings
5547 from overlays with higher priorities come first.
5549 2. Within before-strings, strings are sorted so that overlay
5550 strings from overlays with higher priorities come last.
5552 Value is analogous to strcmp. */
5556 compare_overlay_entries (const void *e1
, const void *e2
)
5558 struct overlay_entry
const *entry1
= e1
;
5559 struct overlay_entry
const *entry2
= e2
;
5562 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5564 /* Let after-strings appear in front of before-strings if
5565 they come from different overlays. */
5566 if (EQ (entry1
->overlay
, entry2
->overlay
))
5567 result
= entry1
->after_string_p
? 1 : -1;
5569 result
= entry1
->after_string_p
? -1 : 1;
5571 else if (entry1
->priority
!= entry2
->priority
)
5573 if (entry1
->after_string_p
)
5574 /* After-strings sorted in order of decreasing priority. */
5575 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5577 /* Before-strings sorted in order of increasing priority. */
5578 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5587 /* Load the vector IT->overlay_strings with overlay strings from IT's
5588 current buffer position, or from CHARPOS if that is > 0. Set
5589 IT->n_overlays to the total number of overlay strings found.
5591 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5592 a time. On entry into load_overlay_strings,
5593 IT->current.overlay_string_index gives the number of overlay
5594 strings that have already been loaded by previous calls to this
5597 IT->add_overlay_start contains an additional overlay start
5598 position to consider for taking overlay strings from, if non-zero.
5599 This position comes into play when the overlay has an `invisible'
5600 property, and both before and after-strings. When we've skipped to
5601 the end of the overlay, because of its `invisible' property, we
5602 nevertheless want its before-string to appear.
5603 IT->add_overlay_start will contain the overlay start position
5606 Overlay strings are sorted so that after-string strings come in
5607 front of before-string strings. Within before and after-strings,
5608 strings are sorted by overlay priority. See also function
5609 compare_overlay_entries. */
5612 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5614 Lisp_Object overlay
, window
, str
, invisible
;
5615 struct Lisp_Overlay
*ov
;
5616 ptrdiff_t start
, end
;
5617 ptrdiff_t n
= 0, i
, j
;
5619 struct overlay_entry entriesbuf
[20];
5620 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5621 struct overlay_entry
*entries
= entriesbuf
;
5625 charpos
= IT_CHARPOS (*it
);
5627 /* Append the overlay string STRING of overlay OVERLAY to vector
5628 `entries' which has size `size' and currently contains `n'
5629 elements. AFTER_P means STRING is an after-string of
5631 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5634 Lisp_Object priority; \
5638 struct overlay_entry *old = entries; \
5639 SAFE_NALLOCA (entries, 2, size); \
5640 memcpy (entries, old, size * sizeof *entries); \
5644 entries[n].string = (STRING); \
5645 entries[n].overlay = (OVERLAY); \
5646 priority = Foverlay_get ((OVERLAY), Qpriority); \
5647 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5648 entries[n].after_string_p = (AFTER_P); \
5653 /* Process overlay before the overlay center. */
5654 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5656 XSETMISC (overlay
, ov
);
5657 eassert (OVERLAYP (overlay
));
5658 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5659 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5664 /* Skip this overlay if it doesn't start or end at IT's current
5666 if (end
!= charpos
&& start
!= charpos
)
5669 /* Skip this overlay if it doesn't apply to IT->w. */
5670 window
= Foverlay_get (overlay
, Qwindow
);
5671 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5674 /* If the text ``under'' the overlay is invisible, both before-
5675 and after-strings from this overlay are visible; start and
5676 end position are indistinguishable. */
5677 invisible
= Foverlay_get (overlay
, Qinvisible
);
5678 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5680 /* If overlay has a non-empty before-string, record it. */
5681 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5682 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5684 RECORD_OVERLAY_STRING (overlay
, str
, false);
5686 /* If overlay has a non-empty after-string, record it. */
5687 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5688 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5690 RECORD_OVERLAY_STRING (overlay
, str
, true);
5693 /* Process overlays after the overlay center. */
5694 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5696 XSETMISC (overlay
, ov
);
5697 eassert (OVERLAYP (overlay
));
5698 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5699 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5701 if (start
> charpos
)
5704 /* Skip this overlay if it doesn't start or end at IT's current
5706 if (end
!= charpos
&& start
!= charpos
)
5709 /* Skip this overlay if it doesn't apply to IT->w. */
5710 window
= Foverlay_get (overlay
, Qwindow
);
5711 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5714 /* If the text ``under'' the overlay is invisible, it has a zero
5715 dimension, and both before- and after-strings apply. */
5716 invisible
= Foverlay_get (overlay
, Qinvisible
);
5717 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5719 /* If overlay has a non-empty before-string, record it. */
5720 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5721 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5723 RECORD_OVERLAY_STRING (overlay
, str
, false);
5725 /* If overlay has a non-empty after-string, record it. */
5726 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5727 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5729 RECORD_OVERLAY_STRING (overlay
, str
, true);
5732 #undef RECORD_OVERLAY_STRING
5736 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5738 /* Record number of overlay strings, and where we computed it. */
5739 it
->n_overlay_strings
= n
;
5740 it
->overlay_strings_charpos
= charpos
;
5742 /* IT->current.overlay_string_index is the number of overlay strings
5743 that have already been consumed by IT. Copy some of the
5744 remaining overlay strings to IT->overlay_strings. */
5746 j
= it
->current
.overlay_string_index
;
5747 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5749 it
->overlay_strings
[i
] = entries
[j
].string
;
5750 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5758 /* Get the first chunk of overlay strings at IT's current buffer
5759 position, or at CHARPOS if that is > 0. Value is true if at
5760 least one overlay string was found. */
5763 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5765 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5766 process. This fills IT->overlay_strings with strings, and sets
5767 IT->n_overlay_strings to the total number of strings to process.
5768 IT->pos.overlay_string_index has to be set temporarily to zero
5769 because load_overlay_strings needs this; it must be set to -1
5770 when no overlay strings are found because a zero value would
5771 indicate a position in the first overlay string. */
5772 it
->current
.overlay_string_index
= 0;
5773 load_overlay_strings (it
, charpos
);
5775 /* If we found overlay strings, set up IT to deliver display
5776 elements from the first one. Otherwise set up IT to deliver
5777 from current_buffer. */
5778 if (it
->n_overlay_strings
)
5780 /* Make sure we know settings in current_buffer, so that we can
5781 restore meaningful values when we're done with the overlay
5784 compute_stop_pos (it
);
5785 eassert (it
->face_id
>= 0);
5787 /* Save IT's settings. They are restored after all overlay
5788 strings have been processed. */
5789 eassert (!compute_stop_p
|| it
->sp
== 0);
5791 /* When called from handle_stop, there might be an empty display
5792 string loaded. In that case, don't bother saving it. But
5793 don't use this optimization with the bidi iterator, since we
5794 need the corresponding pop_it call to resync the bidi
5795 iterator's position with IT's position, after we are done
5796 with the overlay strings. (The corresponding call to pop_it
5797 in case of an empty display string is in
5798 next_overlay_string.) */
5800 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5803 /* Set up IT to deliver display elements from the first overlay
5805 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5806 it
->string
= it
->overlay_strings
[0];
5807 it
->from_overlay
= Qnil
;
5808 it
->stop_charpos
= 0;
5809 eassert (STRINGP (it
->string
));
5810 it
->end_charpos
= SCHARS (it
->string
);
5812 it
->base_level_stop
= 0;
5813 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5814 it
->method
= GET_FROM_STRING
;
5815 it
->from_disp_prop_p
= 0;
5817 /* Force paragraph direction to be that of the parent
5819 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5820 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5822 it
->paragraph_embedding
= L2R
;
5824 /* Set up the bidi iterator for this overlay string. */
5827 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5829 it
->bidi_it
.string
.lstring
= it
->string
;
5830 it
->bidi_it
.string
.s
= NULL
;
5831 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5832 it
->bidi_it
.string
.bufpos
= pos
;
5833 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5834 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5835 it
->bidi_it
.w
= it
->w
;
5836 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5841 it
->current
.overlay_string_index
= -1;
5846 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5849 it
->method
= GET_FROM_BUFFER
;
5851 get_overlay_strings_1 (it
, charpos
, true);
5855 /* Value is true if we found at least one overlay string. */
5856 return STRINGP (it
->string
);
5861 /***********************************************************************
5862 Saving and restoring state
5863 ***********************************************************************/
5865 /* Save current settings of IT on IT->stack. Called, for example,
5866 before setting up IT for an overlay string, to be able to restore
5867 IT's settings to what they were after the overlay string has been
5868 processed. If POSITION is non-NULL, it is the position to save on
5869 the stack instead of IT->position. */
5872 push_it (struct it
*it
, struct text_pos
*position
)
5874 struct iterator_stack_entry
*p
;
5876 eassert (it
->sp
< IT_STACK_SIZE
);
5877 p
= it
->stack
+ it
->sp
;
5879 p
->stop_charpos
= it
->stop_charpos
;
5880 p
->prev_stop
= it
->prev_stop
;
5881 p
->base_level_stop
= it
->base_level_stop
;
5882 p
->cmp_it
= it
->cmp_it
;
5883 eassert (it
->face_id
>= 0);
5884 p
->face_id
= it
->face_id
;
5885 p
->string
= it
->string
;
5886 p
->method
= it
->method
;
5887 p
->from_overlay
= it
->from_overlay
;
5890 case GET_FROM_IMAGE
:
5891 p
->u
.image
.object
= it
->object
;
5892 p
->u
.image
.image_id
= it
->image_id
;
5893 p
->u
.image
.slice
= it
->slice
;
5895 case GET_FROM_STRETCH
:
5896 p
->u
.stretch
.object
= it
->object
;
5899 p
->position
= position
? *position
: it
->position
;
5900 p
->current
= it
->current
;
5901 p
->end_charpos
= it
->end_charpos
;
5902 p
->string_nchars
= it
->string_nchars
;
5904 p
->multibyte_p
= it
->multibyte_p
;
5905 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5906 p
->space_width
= it
->space_width
;
5907 p
->font_height
= it
->font_height
;
5908 p
->voffset
= it
->voffset
;
5909 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5910 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5911 p
->display_ellipsis_p
= false;
5912 p
->line_wrap
= it
->line_wrap
;
5913 p
->bidi_p
= it
->bidi_p
;
5914 p
->paragraph_embedding
= it
->paragraph_embedding
;
5915 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5918 /* Save the state of the bidi iterator as well. */
5920 bidi_push_it (&it
->bidi_it
);
5924 iterate_out_of_display_property (struct it
*it
)
5926 bool buffer_p
= !STRINGP (it
->string
);
5927 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5928 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5930 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5932 /* Maybe initialize paragraph direction. If we are at the beginning
5933 of a new paragraph, next_element_from_buffer may not have a
5934 chance to do that. */
5935 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5936 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5937 /* prev_stop can be zero, so check against BEGV as well. */
5938 while (it
->bidi_it
.charpos
>= bob
5939 && it
->prev_stop
<= it
->bidi_it
.charpos
5940 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5941 && it
->bidi_it
.charpos
< eob
)
5942 bidi_move_to_visually_next (&it
->bidi_it
);
5943 /* Record the stop_pos we just crossed, for when we cross it
5945 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5946 it
->prev_stop
= CHARPOS (it
->position
);
5947 /* If we ended up not where pop_it put us, resync IT's
5948 positional members with the bidi iterator. */
5949 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5950 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5952 it
->current
.pos
= it
->position
;
5954 it
->current
.string_pos
= it
->position
;
5957 /* Restore IT's settings from IT->stack. Called, for example, when no
5958 more overlay strings must be processed, and we return to delivering
5959 display elements from a buffer, or when the end of a string from a
5960 `display' property is reached and we return to delivering display
5961 elements from an overlay string, or from a buffer. */
5964 pop_it (struct it
*it
)
5966 struct iterator_stack_entry
*p
;
5967 bool from_display_prop
= it
->from_disp_prop_p
;
5968 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
5970 eassert (it
->sp
> 0);
5972 p
= it
->stack
+ it
->sp
;
5973 it
->stop_charpos
= p
->stop_charpos
;
5974 it
->prev_stop
= p
->prev_stop
;
5975 it
->base_level_stop
= p
->base_level_stop
;
5976 it
->cmp_it
= p
->cmp_it
;
5977 it
->face_id
= p
->face_id
;
5978 it
->current
= p
->current
;
5979 it
->position
= p
->position
;
5980 it
->string
= p
->string
;
5981 it
->from_overlay
= p
->from_overlay
;
5982 if (NILP (it
->string
))
5983 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5984 it
->method
= p
->method
;
5987 case GET_FROM_IMAGE
:
5988 it
->image_id
= p
->u
.image
.image_id
;
5989 it
->object
= p
->u
.image
.object
;
5990 it
->slice
= p
->u
.image
.slice
;
5992 case GET_FROM_STRETCH
:
5993 it
->object
= p
->u
.stretch
.object
;
5995 case GET_FROM_BUFFER
:
5996 it
->object
= it
->w
->contents
;
5998 case GET_FROM_STRING
:
6000 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6002 /* Restore the face_box_p flag, since it could have been
6003 overwritten by the face of the object that we just finished
6006 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6007 it
->object
= it
->string
;
6010 case GET_FROM_DISPLAY_VECTOR
:
6012 it
->method
= GET_FROM_C_STRING
;
6013 else if (STRINGP (it
->string
))
6014 it
->method
= GET_FROM_STRING
;
6017 it
->method
= GET_FROM_BUFFER
;
6018 it
->object
= it
->w
->contents
;
6021 it
->end_charpos
= p
->end_charpos
;
6022 it
->string_nchars
= p
->string_nchars
;
6024 it
->multibyte_p
= p
->multibyte_p
;
6025 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6026 it
->space_width
= p
->space_width
;
6027 it
->font_height
= p
->font_height
;
6028 it
->voffset
= p
->voffset
;
6029 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6030 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6031 it
->line_wrap
= p
->line_wrap
;
6032 it
->bidi_p
= p
->bidi_p
;
6033 it
->paragraph_embedding
= p
->paragraph_embedding
;
6034 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6037 bidi_pop_it (&it
->bidi_it
);
6038 /* Bidi-iterate until we get out of the portion of text, if any,
6039 covered by a `display' text property or by an overlay with
6040 `display' property. (We cannot just jump there, because the
6041 internal coherency of the bidi iterator state can not be
6042 preserved across such jumps.) We also must determine the
6043 paragraph base direction if the overlay we just processed is
6044 at the beginning of a new paragraph. */
6045 if (from_display_prop
6046 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6047 iterate_out_of_display_property (it
);
6049 eassert ((BUFFERP (it
->object
)
6050 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6051 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6052 || (STRINGP (it
->object
)
6053 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6054 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6055 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6057 /* If we move the iterator over text covered by a display property
6058 to a new buffer position, any info about previously seen overlays
6059 is no longer valid. */
6060 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6061 it
->ignore_overlay_strings_at_pos_p
= false;
6066 /***********************************************************************
6068 ***********************************************************************/
6070 /* Set IT's current position to the previous line start. */
6073 back_to_previous_line_start (struct it
*it
)
6075 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6078 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6082 /* Move IT to the next line start.
6084 Value is true if a newline was found. Set *SKIPPED_P to true if
6085 we skipped over part of the text (as opposed to moving the iterator
6086 continuously over the text). Otherwise, don't change the value
6089 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6090 iterator on the newline, if it was found.
6092 Newlines may come from buffer text, overlay strings, or strings
6093 displayed via the `display' property. That's the reason we can't
6094 simply use find_newline_no_quit.
6096 Note that this function may not skip over invisible text that is so
6097 because of text properties and immediately follows a newline. If
6098 it would, function reseat_at_next_visible_line_start, when called
6099 from set_iterator_to_next, would effectively make invisible
6100 characters following a newline part of the wrong glyph row, which
6101 leads to wrong cursor motion. */
6104 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6105 struct bidi_it
*bidi_it_prev
)
6107 ptrdiff_t old_selective
;
6108 bool newline_found_p
= false;
6110 const int MAX_NEWLINE_DISTANCE
= 500;
6112 /* If already on a newline, just consume it to avoid unintended
6113 skipping over invisible text below. */
6114 if (it
->what
== IT_CHARACTER
6116 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6118 if (it
->bidi_p
&& bidi_it_prev
)
6119 *bidi_it_prev
= it
->bidi_it
;
6120 set_iterator_to_next (it
, false);
6125 /* Don't handle selective display in the following. It's (a)
6126 unnecessary because it's done by the caller, and (b) leads to an
6127 infinite recursion because next_element_from_ellipsis indirectly
6128 calls this function. */
6129 old_selective
= it
->selective
;
6132 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6133 from buffer text. */
6135 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6136 n
+= !STRINGP (it
->string
))
6138 if (!get_next_display_element (it
))
6140 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6141 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6142 *bidi_it_prev
= it
->bidi_it
;
6143 set_iterator_to_next (it
, false);
6146 /* If we didn't find a newline near enough, see if we can use a
6148 if (!newline_found_p
)
6150 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6151 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6155 eassert (!STRINGP (it
->string
));
6157 /* If there isn't any `display' property in sight, and no
6158 overlays, we can just use the position of the newline in
6160 if (it
->stop_charpos
>= limit
6161 || ((pos
= Fnext_single_property_change (make_number (start
),
6163 make_number (limit
)),
6165 && next_overlay_change (start
) == ZV
))
6169 IT_CHARPOS (*it
) = limit
;
6170 IT_BYTEPOS (*it
) = bytepos
;
6174 struct bidi_it bprev
;
6176 /* Help bidi.c avoid expensive searches for display
6177 properties and overlays, by telling it that there are
6178 none up to `limit'. */
6179 if (it
->bidi_it
.disp_pos
< limit
)
6181 it
->bidi_it
.disp_pos
= limit
;
6182 it
->bidi_it
.disp_prop
= 0;
6185 bprev
= it
->bidi_it
;
6186 bidi_move_to_visually_next (&it
->bidi_it
);
6187 } while (it
->bidi_it
.charpos
!= limit
);
6188 IT_CHARPOS (*it
) = limit
;
6189 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6191 *bidi_it_prev
= bprev
;
6193 *skipped_p
= newline_found_p
= true;
6197 while (get_next_display_element (it
)
6198 && !newline_found_p
)
6200 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6201 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6202 *bidi_it_prev
= it
->bidi_it
;
6203 set_iterator_to_next (it
, false);
6208 it
->selective
= old_selective
;
6209 return newline_found_p
;
6213 /* Set IT's current position to the previous visible line start. Skip
6214 invisible text that is so either due to text properties or due to
6215 selective display. Caution: this does not change IT->current_x and
6219 back_to_previous_visible_line_start (struct it
*it
)
6221 while (IT_CHARPOS (*it
) > BEGV
)
6223 back_to_previous_line_start (it
);
6225 if (IT_CHARPOS (*it
) <= BEGV
)
6228 /* If selective > 0, then lines indented more than its value are
6230 if (it
->selective
> 0
6231 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6235 /* Check the newline before point for invisibility. */
6238 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6239 Qinvisible
, it
->window
);
6240 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6244 if (IT_CHARPOS (*it
) <= BEGV
)
6249 void *it2data
= NULL
;
6252 Lisp_Object val
, overlay
;
6254 SAVE_IT (it2
, *it
, it2data
);
6256 /* If newline is part of a composition, continue from start of composition */
6257 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6258 && beg
< IT_CHARPOS (*it
))
6261 /* If newline is replaced by a display property, find start of overlay
6262 or interval and continue search from that point. */
6263 pos
= --IT_CHARPOS (it2
);
6266 bidi_unshelve_cache (NULL
, false);
6267 it2
.string_from_display_prop_p
= false;
6268 it2
.from_disp_prop_p
= false;
6269 if (handle_display_prop (&it2
) == HANDLED_RETURN
6270 && !NILP (val
= get_char_property_and_overlay
6271 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6272 && (OVERLAYP (overlay
)
6273 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6274 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6276 RESTORE_IT (it
, it
, it2data
);
6280 /* Newline is not replaced by anything -- so we are done. */
6281 RESTORE_IT (it
, it
, it2data
);
6287 IT_CHARPOS (*it
) = beg
;
6288 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6292 it
->continuation_lines_width
= 0;
6294 eassert (IT_CHARPOS (*it
) >= BEGV
);
6295 eassert (IT_CHARPOS (*it
) == BEGV
6296 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6301 /* Reseat iterator IT at the previous visible line start. Skip
6302 invisible text that is so either due to text properties or due to
6303 selective display. At the end, update IT's overlay information,
6304 face information etc. */
6307 reseat_at_previous_visible_line_start (struct it
*it
)
6309 back_to_previous_visible_line_start (it
);
6310 reseat (it
, it
->current
.pos
, true);
6315 /* Reseat iterator IT on the next visible line start in the current
6316 buffer. ON_NEWLINE_P means position IT on the newline
6317 preceding the line start. Skip over invisible text that is so
6318 because of selective display. Compute faces, overlays etc at the
6319 new position. Note that this function does not skip over text that
6320 is invisible because of text properties. */
6323 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6325 bool skipped_p
= false;
6326 struct bidi_it bidi_it_prev
;
6327 bool newline_found_p
6328 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6330 /* Skip over lines that are invisible because they are indented
6331 more than the value of IT->selective. */
6332 if (it
->selective
> 0)
6333 while (IT_CHARPOS (*it
) < ZV
6334 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6337 eassert (IT_BYTEPOS (*it
) == BEGV
6338 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6340 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6343 /* Position on the newline if that's what's requested. */
6344 if (on_newline_p
&& newline_found_p
)
6346 if (STRINGP (it
->string
))
6348 if (IT_STRING_CHARPOS (*it
) > 0)
6352 --IT_STRING_CHARPOS (*it
);
6353 --IT_STRING_BYTEPOS (*it
);
6357 /* We need to restore the bidi iterator to the state
6358 it had on the newline, and resync the IT's
6359 position with that. */
6360 it
->bidi_it
= bidi_it_prev
;
6361 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6362 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6366 else if (IT_CHARPOS (*it
) > BEGV
)
6375 /* We need to restore the bidi iterator to the state it
6376 had on the newline and resync IT with that. */
6377 it
->bidi_it
= bidi_it_prev
;
6378 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6379 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6381 reseat (it
, it
->current
.pos
, false);
6385 reseat (it
, it
->current
.pos
, false);
6392 /***********************************************************************
6393 Changing an iterator's position
6394 ***********************************************************************/
6396 /* Change IT's current position to POS in current_buffer.
6397 If FORCE_P, always check for text properties at the new position.
6398 Otherwise, text properties are only looked up if POS >=
6399 IT->check_charpos of a property. */
6402 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6404 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6406 reseat_1 (it
, pos
, false);
6408 /* Determine where to check text properties. Avoid doing it
6409 where possible because text property lookup is very expensive. */
6411 || CHARPOS (pos
) > it
->stop_charpos
6412 || CHARPOS (pos
) < original_pos
)
6416 /* For bidi iteration, we need to prime prev_stop and
6417 base_level_stop with our best estimations. */
6418 /* Implementation note: Of course, POS is not necessarily a
6419 stop position, so assigning prev_pos to it is a lie; we
6420 should have called compute_stop_backwards. However, if
6421 the current buffer does not include any R2L characters,
6422 that call would be a waste of cycles, because the
6423 iterator will never move back, and thus never cross this
6424 "fake" stop position. So we delay that backward search
6425 until the time we really need it, in next_element_from_buffer. */
6426 if (CHARPOS (pos
) != it
->prev_stop
)
6427 it
->prev_stop
= CHARPOS (pos
);
6428 if (CHARPOS (pos
) < it
->base_level_stop
)
6429 it
->base_level_stop
= 0; /* meaning it's unknown */
6435 it
->prev_stop
= it
->base_level_stop
= 0;
6444 /* Change IT's buffer position to POS. SET_STOP_P means set
6445 IT->stop_pos to POS, also. */
6448 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6450 /* Don't call this function when scanning a C string. */
6451 eassert (it
->s
== NULL
);
6453 /* POS must be a reasonable value. */
6454 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6456 it
->current
.pos
= it
->position
= pos
;
6457 it
->end_charpos
= ZV
;
6459 it
->current
.dpvec_index
= -1;
6460 it
->current
.overlay_string_index
= -1;
6461 IT_STRING_CHARPOS (*it
) = -1;
6462 IT_STRING_BYTEPOS (*it
) = -1;
6464 it
->method
= GET_FROM_BUFFER
;
6465 it
->object
= it
->w
->contents
;
6466 it
->area
= TEXT_AREA
;
6467 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6469 it
->string_from_display_prop_p
= false;
6470 it
->string_from_prefix_prop_p
= false;
6472 it
->from_disp_prop_p
= false;
6473 it
->face_before_selective_p
= false;
6476 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6478 bidi_unshelve_cache (NULL
, false);
6479 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6480 it
->bidi_it
.string
.s
= NULL
;
6481 it
->bidi_it
.string
.lstring
= Qnil
;
6482 it
->bidi_it
.string
.bufpos
= 0;
6483 it
->bidi_it
.string
.from_disp_str
= false;
6484 it
->bidi_it
.string
.unibyte
= false;
6485 it
->bidi_it
.w
= it
->w
;
6490 it
->stop_charpos
= CHARPOS (pos
);
6491 it
->base_level_stop
= CHARPOS (pos
);
6493 /* This make the information stored in it->cmp_it invalidate. */
6498 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6499 If S is non-null, it is a C string to iterate over. Otherwise,
6500 STRING gives a Lisp string to iterate over.
6502 If PRECISION > 0, don't return more then PRECISION number of
6503 characters from the string.
6505 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6506 characters have been returned. FIELD_WIDTH < 0 means an infinite
6509 MULTIBYTE = 0 means disable processing of multibyte characters,
6510 MULTIBYTE > 0 means enable it,
6511 MULTIBYTE < 0 means use IT->multibyte_p.
6513 IT must be initialized via a prior call to init_iterator before
6514 calling this function. */
6517 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6518 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6521 /* No text property checks performed by default, but see below. */
6522 it
->stop_charpos
= -1;
6524 /* Set iterator position and end position. */
6525 memset (&it
->current
, 0, sizeof it
->current
);
6526 it
->current
.overlay_string_index
= -1;
6527 it
->current
.dpvec_index
= -1;
6528 eassert (charpos
>= 0);
6530 /* If STRING is specified, use its multibyteness, otherwise use the
6531 setting of MULTIBYTE, if specified. */
6533 it
->multibyte_p
= multibyte
> 0;
6535 /* Bidirectional reordering of strings is controlled by the default
6536 value of bidi-display-reordering. Don't try to reorder while
6537 loading loadup.el, as the necessary character property tables are
6538 not yet available. */
6541 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6545 eassert (STRINGP (string
));
6546 it
->string
= string
;
6548 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6549 it
->method
= GET_FROM_STRING
;
6550 it
->current
.string_pos
= string_pos (charpos
, string
);
6554 it
->bidi_it
.string
.lstring
= string
;
6555 it
->bidi_it
.string
.s
= NULL
;
6556 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6557 it
->bidi_it
.string
.bufpos
= 0;
6558 it
->bidi_it
.string
.from_disp_str
= false;
6559 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6560 it
->bidi_it
.w
= it
->w
;
6561 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6562 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6567 it
->s
= (const unsigned char *) s
;
6570 /* Note that we use IT->current.pos, not it->current.string_pos,
6571 for displaying C strings. */
6572 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6573 if (it
->multibyte_p
)
6575 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6576 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6580 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6581 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6586 it
->bidi_it
.string
.lstring
= Qnil
;
6587 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6588 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6589 it
->bidi_it
.string
.bufpos
= 0;
6590 it
->bidi_it
.string
.from_disp_str
= false;
6591 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6592 it
->bidi_it
.w
= it
->w
;
6593 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6596 it
->method
= GET_FROM_C_STRING
;
6599 /* PRECISION > 0 means don't return more than PRECISION characters
6601 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6603 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6605 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6608 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6609 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6610 FIELD_WIDTH < 0 means infinite field width. This is useful for
6611 padding with `-' at the end of a mode line. */
6612 if (field_width
< 0)
6613 field_width
= INFINITY
;
6614 /* Implementation note: We deliberately don't enlarge
6615 it->bidi_it.string.schars here to fit it->end_charpos, because
6616 the bidi iterator cannot produce characters out of thin air. */
6617 if (field_width
> it
->end_charpos
- charpos
)
6618 it
->end_charpos
= charpos
+ field_width
;
6620 /* Use the standard display table for displaying strings. */
6621 if (DISP_TABLE_P (Vstandard_display_table
))
6622 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6624 it
->stop_charpos
= charpos
;
6625 it
->prev_stop
= charpos
;
6626 it
->base_level_stop
= 0;
6629 it
->bidi_it
.first_elt
= true;
6630 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6631 it
->bidi_it
.disp_pos
= -1;
6633 if (s
== NULL
&& it
->multibyte_p
)
6635 ptrdiff_t endpos
= SCHARS (it
->string
);
6636 if (endpos
> it
->end_charpos
)
6637 endpos
= it
->end_charpos
;
6638 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6646 /***********************************************************************
6648 ***********************************************************************/
6650 /* Map enum it_method value to corresponding next_element_from_* function. */
6652 typedef bool (*next_element_function
) (struct it
*);
6654 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6656 next_element_from_buffer
,
6657 next_element_from_display_vector
,
6658 next_element_from_string
,
6659 next_element_from_c_string
,
6660 next_element_from_image
,
6661 next_element_from_stretch
6664 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6667 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6668 (possibly with the following characters). */
6670 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6671 ((IT)->cmp_it.id >= 0 \
6672 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6673 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6674 END_CHARPOS, (IT)->w, \
6675 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6679 /* Lookup the char-table Vglyphless_char_display for character C (-1
6680 if we want information for no-font case), and return the display
6681 method symbol. By side-effect, update it->what and
6682 it->glyphless_method. This function is called from
6683 get_next_display_element for each character element, and from
6684 x_produce_glyphs when no suitable font was found. */
6687 lookup_glyphless_char_display (int c
, struct it
*it
)
6689 Lisp_Object glyphless_method
= Qnil
;
6691 if (CHAR_TABLE_P (Vglyphless_char_display
)
6692 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6696 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6697 if (CONSP (glyphless_method
))
6698 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6699 ? XCAR (glyphless_method
)
6700 : XCDR (glyphless_method
);
6703 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6707 if (NILP (glyphless_method
))
6710 /* The default is to display the character by a proper font. */
6712 /* The default for the no-font case is to display an empty box. */
6713 glyphless_method
= Qempty_box
;
6715 if (EQ (glyphless_method
, Qzero_width
))
6718 return glyphless_method
;
6719 /* This method can't be used for the no-font case. */
6720 glyphless_method
= Qempty_box
;
6722 if (EQ (glyphless_method
, Qthin_space
))
6723 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6724 else if (EQ (glyphless_method
, Qempty_box
))
6725 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6726 else if (EQ (glyphless_method
, Qhex_code
))
6727 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6728 else if (STRINGP (glyphless_method
))
6729 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6732 /* Invalid value. We use the default method. */
6733 glyphless_method
= Qnil
;
6736 it
->what
= IT_GLYPHLESS
;
6737 return glyphless_method
;
6740 /* Merge escape glyph face and cache the result. */
6742 static struct frame
*last_escape_glyph_frame
= NULL
;
6743 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6744 static int last_escape_glyph_merged_face_id
= 0;
6747 merge_escape_glyph_face (struct it
*it
)
6751 if (it
->f
== last_escape_glyph_frame
6752 && it
->face_id
== last_escape_glyph_face_id
)
6753 face_id
= last_escape_glyph_merged_face_id
;
6756 /* Merge the `escape-glyph' face into the current face. */
6757 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6758 last_escape_glyph_frame
= it
->f
;
6759 last_escape_glyph_face_id
= it
->face_id
;
6760 last_escape_glyph_merged_face_id
= face_id
;
6765 /* Likewise for glyphless glyph face. */
6767 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6768 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6769 static int last_glyphless_glyph_merged_face_id
= 0;
6772 merge_glyphless_glyph_face (struct it
*it
)
6776 if (it
->f
== last_glyphless_glyph_frame
6777 && it
->face_id
== last_glyphless_glyph_face_id
)
6778 face_id
= last_glyphless_glyph_merged_face_id
;
6781 /* Merge the `glyphless-char' face into the current face. */
6782 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6783 last_glyphless_glyph_frame
= it
->f
;
6784 last_glyphless_glyph_face_id
= it
->face_id
;
6785 last_glyphless_glyph_merged_face_id
= face_id
;
6790 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6791 be called before redisplaying windows, and when the frame's face
6794 forget_escape_and_glyphless_faces (void)
6796 last_escape_glyph_frame
= NULL
;
6797 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6798 last_glyphless_glyph_frame
= NULL
;
6799 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6802 /* Load IT's display element fields with information about the next
6803 display element from the current position of IT. Value is false if
6804 end of buffer (or C string) is reached. */
6807 get_next_display_element (struct it
*it
)
6809 /* True means that we found a display element. False means that
6810 we hit the end of what we iterate over. Performance note: the
6811 function pointer `method' used here turns out to be faster than
6812 using a sequence of if-statements. */
6816 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6818 if (it
->what
== IT_CHARACTER
)
6820 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6821 and only if (a) the resolved directionality of that character
6823 /* FIXME: Do we need an exception for characters from display
6825 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6826 && !inhibit_bidi_mirroring
)
6827 it
->c
= bidi_mirror_char (it
->c
);
6828 /* Map via display table or translate control characters.
6829 IT->c, IT->len etc. have been set to the next character by
6830 the function call above. If we have a display table, and it
6831 contains an entry for IT->c, translate it. Don't do this if
6832 IT->c itself comes from a display table, otherwise we could
6833 end up in an infinite recursion. (An alternative could be to
6834 count the recursion depth of this function and signal an
6835 error when a certain maximum depth is reached.) Is it worth
6837 if (success_p
&& it
->dpvec
== NULL
)
6840 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6841 bool nonascii_space_p
= false;
6842 bool nonascii_hyphen_p
= false;
6843 int c
= it
->c
; /* This is the character to display. */
6845 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6847 eassert (SINGLE_BYTE_CHAR_P (c
));
6848 if (unibyte_display_via_language_environment
)
6850 c
= DECODE_CHAR (unibyte
, c
);
6852 c
= BYTE8_TO_CHAR (it
->c
);
6855 c
= BYTE8_TO_CHAR (it
->c
);
6859 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6862 struct Lisp_Vector
*v
= XVECTOR (dv
);
6864 /* Return the first character from the display table
6865 entry, if not empty. If empty, don't display the
6866 current character. */
6869 it
->dpvec_char_len
= it
->len
;
6870 it
->dpvec
= v
->contents
;
6871 it
->dpend
= v
->contents
+ v
->header
.size
;
6872 it
->current
.dpvec_index
= 0;
6873 it
->dpvec_face_id
= -1;
6874 it
->saved_face_id
= it
->face_id
;
6875 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6876 it
->ellipsis_p
= false;
6880 set_iterator_to_next (it
, false);
6885 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6887 if (it
->what
== IT_GLYPHLESS
)
6889 /* Don't display this character. */
6890 set_iterator_to_next (it
, false);
6894 /* If `nobreak-char-display' is non-nil, we display
6895 non-ASCII spaces and hyphens specially. */
6896 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6898 if (c
== NO_BREAK_SPACE
)
6899 nonascii_space_p
= true;
6900 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6901 || c
== NON_BREAKING_HYPHEN
)
6902 nonascii_hyphen_p
= true;
6905 /* Translate control characters into `\003' or `^C' form.
6906 Control characters coming from a display table entry are
6907 currently not translated because we use IT->dpvec to hold
6908 the translation. This could easily be changed but I
6909 don't believe that it is worth doing.
6911 The characters handled by `nobreak-char-display' must be
6914 Non-printable characters and raw-byte characters are also
6915 translated to octal form. */
6916 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6917 ? (it
->area
!= TEXT_AREA
6918 /* In mode line, treat \n, \t like other crl chars. */
6921 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6922 || (c
!= '\n' && c
!= '\t'))
6924 || nonascii_hyphen_p
6926 || ! CHAR_PRINTABLE_P (c
))))
6928 /* C is a control character, non-ASCII space/hyphen,
6929 raw-byte, or a non-printable character which must be
6930 displayed either as '\003' or as `^C' where the '\\'
6931 and '^' can be defined in the display table. Fill
6932 IT->ctl_chars with glyphs for what we have to
6933 display. Then, set IT->dpvec to these glyphs. */
6940 /* Handle control characters with ^. */
6942 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6946 g
= '^'; /* default glyph for Control */
6947 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6949 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6951 g
= GLYPH_CODE_CHAR (gc
);
6952 lface_id
= GLYPH_CODE_FACE (gc
);
6956 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6957 : merge_escape_glyph_face (it
));
6959 XSETINT (it
->ctl_chars
[0], g
);
6960 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6962 goto display_control
;
6965 /* Handle non-ascii space in the mode where it only gets
6968 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6970 /* Merge `nobreak-space' into the current face. */
6971 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6973 XSETINT (it
->ctl_chars
[0], ' ');
6975 goto display_control
;
6978 /* Handle sequences that start with the "escape glyph". */
6980 /* the default escape glyph is \. */
6981 escape_glyph
= '\\';
6984 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6986 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6987 lface_id
= GLYPH_CODE_FACE (gc
);
6991 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6992 : merge_escape_glyph_face (it
));
6994 /* Draw non-ASCII hyphen with just highlighting: */
6996 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6998 XSETINT (it
->ctl_chars
[0], '-');
7000 goto display_control
;
7003 /* Draw non-ASCII space/hyphen with escape glyph: */
7005 if (nonascii_space_p
|| nonascii_hyphen_p
)
7007 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7008 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7010 goto display_control
;
7017 if (CHAR_BYTE8_P (c
))
7018 /* Display \200 instead of \17777600. */
7019 c
= CHAR_TO_BYTE8 (c
);
7020 len
= sprintf (str
, "%03o", c
+ 0u);
7022 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7023 for (i
= 0; i
< len
; i
++)
7024 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7029 /* Set up IT->dpvec and return first character from it. */
7030 it
->dpvec_char_len
= it
->len
;
7031 it
->dpvec
= it
->ctl_chars
;
7032 it
->dpend
= it
->dpvec
+ ctl_len
;
7033 it
->current
.dpvec_index
= 0;
7034 it
->dpvec_face_id
= face_id
;
7035 it
->saved_face_id
= it
->face_id
;
7036 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7037 it
->ellipsis_p
= false;
7040 it
->char_to_display
= c
;
7044 it
->char_to_display
= it
->c
;
7048 #ifdef HAVE_WINDOW_SYSTEM
7049 /* Adjust face id for a multibyte character. There are no multibyte
7050 character in unibyte text. */
7051 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7054 && FRAME_WINDOW_P (it
->f
))
7056 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7058 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7060 /* Automatic composition with glyph-string. */
7061 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7063 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7067 ptrdiff_t pos
= (it
->s
? -1
7068 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7069 : IT_CHARPOS (*it
));
7072 if (it
->what
== IT_CHARACTER
)
7073 c
= it
->char_to_display
;
7076 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7080 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7081 /* TAB in a composition means display glyphs with
7082 padding space on the left or right. */
7083 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7086 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7089 #endif /* HAVE_WINDOW_SYSTEM */
7092 /* Is this character the last one of a run of characters with
7093 box? If yes, set IT->end_of_box_run_p to true. */
7097 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7099 int face_id
= underlying_face_id (it
);
7100 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7104 if (face
->box
== FACE_NO_BOX
)
7106 /* If the box comes from face properties in a
7107 display string, check faces in that string. */
7108 int string_face_id
= face_after_it_pos (it
);
7109 it
->end_of_box_run_p
7110 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7113 /* Otherwise, the box comes from the underlying face.
7114 If this is the last string character displayed, check
7115 the next buffer location. */
7116 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7117 /* n_overlay_strings is unreliable unless
7118 overlay_string_index is non-negative. */
7119 && ((it
->current
.overlay_string_index
>= 0
7120 && (it
->current
.overlay_string_index
7121 == it
->n_overlay_strings
- 1))
7122 /* A string from display property. */
7123 || it
->from_disp_prop_p
))
7127 struct text_pos pos
= it
->current
.pos
;
7129 /* For a string from a display property, the next
7130 buffer position is stored in the 'position'
7131 member of the iteration stack slot below the
7132 current one, see handle_single_display_spec. By
7133 contrast, it->current.pos was is not yet updated
7134 to point to that buffer position; that will
7135 happen in pop_it, after we finish displaying the
7136 current string. Note that we already checked
7137 above that it->sp is positive, so subtracting one
7139 if (it
->from_disp_prop_p
)
7140 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7142 INC_TEXT_POS (pos
, it
->multibyte_p
);
7144 if (CHARPOS (pos
) >= ZV
)
7145 it
->end_of_box_run_p
= true;
7148 next_face_id
= face_at_buffer_position
7149 (it
->w
, CHARPOS (pos
), &ignore
,
7150 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7151 it
->end_of_box_run_p
7152 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7158 /* next_element_from_display_vector sets this flag according to
7159 faces of the display vector glyphs, see there. */
7160 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7162 int face_id
= face_after_it_pos (it
);
7163 it
->end_of_box_run_p
7164 = (face_id
!= it
->face_id
7165 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7168 /* If we reached the end of the object we've been iterating (e.g., a
7169 display string or an overlay string), and there's something on
7170 IT->stack, proceed with what's on the stack. It doesn't make
7171 sense to return false if there's unprocessed stuff on the stack,
7172 because otherwise that stuff will never be displayed. */
7173 if (!success_p
&& it
->sp
> 0)
7175 set_iterator_to_next (it
, false);
7176 success_p
= get_next_display_element (it
);
7179 /* Value is false if end of buffer or string reached. */
7184 /* Move IT to the next display element.
7186 RESEAT_P means if called on a newline in buffer text,
7187 skip to the next visible line start.
7189 Functions get_next_display_element and set_iterator_to_next are
7190 separate because I find this arrangement easier to handle than a
7191 get_next_display_element function that also increments IT's
7192 position. The way it is we can first look at an iterator's current
7193 display element, decide whether it fits on a line, and if it does,
7194 increment the iterator position. The other way around we probably
7195 would either need a flag indicating whether the iterator has to be
7196 incremented the next time, or we would have to implement a
7197 decrement position function which would not be easy to write. */
7200 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7202 /* Reset flags indicating start and end of a sequence of characters
7203 with box. Reset them at the start of this function because
7204 moving the iterator to a new position might set them. */
7205 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7209 case GET_FROM_BUFFER
:
7210 /* The current display element of IT is a character from
7211 current_buffer. Advance in the buffer, and maybe skip over
7212 invisible lines that are so because of selective display. */
7213 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7214 reseat_at_next_visible_line_start (it
, false);
7215 else if (it
->cmp_it
.id
>= 0)
7217 /* We are currently getting glyphs from a composition. */
7220 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7221 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7227 /* Update IT's char/byte positions to point to the first
7228 character of the next grapheme cluster, or to the
7229 character visually after the current composition. */
7230 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7231 bidi_move_to_visually_next (&it
->bidi_it
);
7232 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7233 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7236 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7237 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7239 /* Composition created while scanning forward. Proceed
7240 to the next grapheme cluster. */
7241 it
->cmp_it
.from
= it
->cmp_it
.to
;
7243 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7244 && it
->cmp_it
.from
> 0)
7246 /* Composition created while scanning backward. Proceed
7247 to the previous grapheme cluster. */
7248 it
->cmp_it
.to
= it
->cmp_it
.from
;
7252 /* No more grapheme clusters in this composition.
7253 Find the next stop position. */
7254 ptrdiff_t stop
= it
->end_charpos
;
7256 if (it
->bidi_it
.scan_dir
< 0)
7257 /* Now we are scanning backward and don't know
7260 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7261 IT_BYTEPOS (*it
), stop
, Qnil
);
7266 eassert (it
->len
!= 0);
7270 IT_BYTEPOS (*it
) += it
->len
;
7271 IT_CHARPOS (*it
) += 1;
7275 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7276 /* If this is a new paragraph, determine its base
7277 direction (a.k.a. its base embedding level). */
7278 if (it
->bidi_it
.new_paragraph
)
7279 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7281 bidi_move_to_visually_next (&it
->bidi_it
);
7282 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7283 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7284 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7286 /* As the scan direction was changed, we must
7287 re-compute the stop position for composition. */
7288 ptrdiff_t stop
= it
->end_charpos
;
7289 if (it
->bidi_it
.scan_dir
< 0)
7291 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7292 IT_BYTEPOS (*it
), stop
, Qnil
);
7295 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7299 case GET_FROM_C_STRING
:
7300 /* Current display element of IT is from a C string. */
7302 /* If the string position is beyond string's end, it means
7303 next_element_from_c_string is padding the string with
7304 blanks, in which case we bypass the bidi iterator,
7305 because it cannot deal with such virtual characters. */
7306 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7308 IT_BYTEPOS (*it
) += it
->len
;
7309 IT_CHARPOS (*it
) += 1;
7313 bidi_move_to_visually_next (&it
->bidi_it
);
7314 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7315 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7319 case GET_FROM_DISPLAY_VECTOR
:
7320 /* Current display element of IT is from a display table entry.
7321 Advance in the display table definition. Reset it to null if
7322 end reached, and continue with characters from buffers/
7324 ++it
->current
.dpvec_index
;
7326 /* Restore face of the iterator to what they were before the
7327 display vector entry (these entries may contain faces). */
7328 it
->face_id
= it
->saved_face_id
;
7330 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7332 bool recheck_faces
= it
->ellipsis_p
;
7335 it
->method
= GET_FROM_C_STRING
;
7336 else if (STRINGP (it
->string
))
7337 it
->method
= GET_FROM_STRING
;
7340 it
->method
= GET_FROM_BUFFER
;
7341 it
->object
= it
->w
->contents
;
7345 it
->current
.dpvec_index
= -1;
7347 /* Skip over characters which were displayed via IT->dpvec. */
7348 if (it
->dpvec_char_len
< 0)
7349 reseat_at_next_visible_line_start (it
, true);
7350 else if (it
->dpvec_char_len
> 0)
7352 it
->len
= it
->dpvec_char_len
;
7353 set_iterator_to_next (it
, reseat_p
);
7356 /* Maybe recheck faces after display vector. */
7359 if (it
->method
== GET_FROM_STRING
)
7360 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7362 it
->stop_charpos
= IT_CHARPOS (*it
);
7367 case GET_FROM_STRING
:
7368 /* Current display element is a character from a Lisp string. */
7369 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7370 /* Don't advance past string end. These conditions are true
7371 when set_iterator_to_next is called at the end of
7372 get_next_display_element, in which case the Lisp string is
7373 already exhausted, and all we want is pop the iterator
7375 if (it
->current
.overlay_string_index
>= 0)
7377 /* This is an overlay string, so there's no padding with
7378 spaces, and the number of characters in the string is
7379 where the string ends. */
7380 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7381 goto consider_string_end
;
7385 /* Not an overlay string. There could be padding, so test
7386 against it->end_charpos. */
7387 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7388 goto consider_string_end
;
7390 if (it
->cmp_it
.id
>= 0)
7392 /* We are delivering display elements from a composition.
7393 Update the string position past the grapheme cluster
7394 we've just processed. */
7397 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7398 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7404 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7405 bidi_move_to_visually_next (&it
->bidi_it
);
7406 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7407 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7410 /* Did we exhaust all the grapheme clusters of this
7412 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7413 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7415 /* Not all the grapheme clusters were processed yet;
7416 advance to the next cluster. */
7417 it
->cmp_it
.from
= it
->cmp_it
.to
;
7419 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7420 && it
->cmp_it
.from
> 0)
7422 /* Likewise: advance to the next cluster, but going in
7423 the reverse direction. */
7424 it
->cmp_it
.to
= it
->cmp_it
.from
;
7428 /* This composition was fully processed; find the next
7429 candidate place for checking for composed
7431 /* Always limit string searches to the string length;
7432 any padding spaces are not part of the string, and
7433 there cannot be any compositions in that padding. */
7434 ptrdiff_t stop
= SCHARS (it
->string
);
7436 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7438 else if (it
->end_charpos
< stop
)
7440 /* Cf. PRECISION in reseat_to_string: we might be
7441 limited in how many of the string characters we
7443 stop
= it
->end_charpos
;
7445 composition_compute_stop_pos (&it
->cmp_it
,
7446 IT_STRING_CHARPOS (*it
),
7447 IT_STRING_BYTEPOS (*it
), stop
,
7454 /* If the string position is beyond string's end, it
7455 means next_element_from_string is padding the string
7456 with blanks, in which case we bypass the bidi
7457 iterator, because it cannot deal with such virtual
7459 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7461 IT_STRING_BYTEPOS (*it
) += it
->len
;
7462 IT_STRING_CHARPOS (*it
) += 1;
7466 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7468 bidi_move_to_visually_next (&it
->bidi_it
);
7469 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7470 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7471 /* If the scan direction changes, we may need to update
7472 the place where to check for composed characters. */
7473 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7475 ptrdiff_t stop
= SCHARS (it
->string
);
7477 if (it
->bidi_it
.scan_dir
< 0)
7479 else if (it
->end_charpos
< stop
)
7480 stop
= it
->end_charpos
;
7482 composition_compute_stop_pos (&it
->cmp_it
,
7483 IT_STRING_CHARPOS (*it
),
7484 IT_STRING_BYTEPOS (*it
), stop
,
7490 consider_string_end
:
7492 if (it
->current
.overlay_string_index
>= 0)
7494 /* IT->string is an overlay string. Advance to the
7495 next, if there is one. */
7496 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7498 it
->ellipsis_p
= false;
7499 next_overlay_string (it
);
7501 setup_for_ellipsis (it
, 0);
7506 /* IT->string is not an overlay string. If we reached
7507 its end, and there is something on IT->stack, proceed
7508 with what is on the stack. This can be either another
7509 string, this time an overlay string, or a buffer. */
7510 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7514 if (it
->method
== GET_FROM_STRING
)
7515 goto consider_string_end
;
7520 case GET_FROM_IMAGE
:
7521 case GET_FROM_STRETCH
:
7522 /* The position etc with which we have to proceed are on
7523 the stack. The position may be at the end of a string,
7524 if the `display' property takes up the whole string. */
7525 eassert (it
->sp
> 0);
7527 if (it
->method
== GET_FROM_STRING
)
7528 goto consider_string_end
;
7532 /* There are no other methods defined, so this should be a bug. */
7536 eassert (it
->method
!= GET_FROM_STRING
7537 || (STRINGP (it
->string
)
7538 && IT_STRING_CHARPOS (*it
) >= 0));
7541 /* Load IT's display element fields with information about the next
7542 display element which comes from a display table entry or from the
7543 result of translating a control character to one of the forms `^C'
7546 IT->dpvec holds the glyphs to return as characters.
7547 IT->saved_face_id holds the face id before the display vector--it
7548 is restored into IT->face_id in set_iterator_to_next. */
7551 next_element_from_display_vector (struct it
*it
)
7554 int prev_face_id
= it
->face_id
;
7558 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7560 it
->face_id
= it
->saved_face_id
;
7562 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7563 That seemed totally bogus - so I changed it... */
7564 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7566 if (GLYPH_CODE_P (gc
))
7568 struct face
*this_face
, *prev_face
, *next_face
;
7570 it
->c
= GLYPH_CODE_CHAR (gc
);
7571 it
->len
= CHAR_BYTES (it
->c
);
7573 /* The entry may contain a face id to use. Such a face id is
7574 the id of a Lisp face, not a realized face. A face id of
7575 zero means no face is specified. */
7576 if (it
->dpvec_face_id
>= 0)
7577 it
->face_id
= it
->dpvec_face_id
;
7580 int lface_id
= GLYPH_CODE_FACE (gc
);
7582 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7586 /* Glyphs in the display vector could have the box face, so we
7587 need to set the related flags in the iterator, as
7589 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7590 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7592 /* Is this character the first character of a box-face run? */
7593 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7595 || prev_face
->box
== FACE_NO_BOX
));
7597 /* For the last character of the box-face run, we need to look
7598 either at the next glyph from the display vector, or at the
7599 face we saw before the display vector. */
7600 next_face_id
= it
->saved_face_id
;
7601 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7603 if (it
->dpvec_face_id
>= 0)
7604 next_face_id
= it
->dpvec_face_id
;
7608 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7611 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7615 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7616 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7618 || next_face
->box
== FACE_NO_BOX
));
7619 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7622 /* Display table entry is invalid. Return a space. */
7623 it
->c
= ' ', it
->len
= 1;
7625 /* Don't change position and object of the iterator here. They are
7626 still the values of the character that had this display table
7627 entry or was translated, and that's what we want. */
7628 it
->what
= IT_CHARACTER
;
7632 /* Get the first element of string/buffer in the visual order, after
7633 being reseated to a new position in a string or a buffer. */
7635 get_visually_first_element (struct it
*it
)
7637 bool string_p
= STRINGP (it
->string
) || it
->s
;
7638 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7639 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7641 if (STRINGP (it
->string
))
7643 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7644 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7648 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7649 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7652 if (it
->bidi_it
.charpos
== eob
)
7654 /* Nothing to do, but reset the FIRST_ELT flag, like
7655 bidi_paragraph_init does, because we are not going to
7657 it
->bidi_it
.first_elt
= false;
7659 else if (it
->bidi_it
.charpos
== bob
7661 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7662 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7664 /* If we are at the beginning of a line/string, we can produce
7665 the next element right away. */
7666 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7667 bidi_move_to_visually_next (&it
->bidi_it
);
7671 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7673 /* We need to prime the bidi iterator starting at the line's or
7674 string's beginning, before we will be able to produce the
7677 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7679 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7680 IT_BYTEPOS (*it
), -1,
7681 &it
->bidi_it
.bytepos
);
7682 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7685 /* Now return to buffer/string position where we were asked
7686 to get the next display element, and produce that. */
7687 bidi_move_to_visually_next (&it
->bidi_it
);
7689 while (it
->bidi_it
.bytepos
!= orig_bytepos
7690 && it
->bidi_it
.charpos
< eob
);
7693 /* Adjust IT's position information to where we ended up. */
7694 if (STRINGP (it
->string
))
7696 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7697 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7701 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7702 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7705 if (STRINGP (it
->string
) || !it
->s
)
7707 ptrdiff_t stop
, charpos
, bytepos
;
7709 if (STRINGP (it
->string
))
7712 stop
= SCHARS (it
->string
);
7713 if (stop
> it
->end_charpos
)
7714 stop
= it
->end_charpos
;
7715 charpos
= IT_STRING_CHARPOS (*it
);
7716 bytepos
= IT_STRING_BYTEPOS (*it
);
7720 stop
= it
->end_charpos
;
7721 charpos
= IT_CHARPOS (*it
);
7722 bytepos
= IT_BYTEPOS (*it
);
7724 if (it
->bidi_it
.scan_dir
< 0)
7726 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7731 /* Load IT with the next display element from Lisp string IT->string.
7732 IT->current.string_pos is the current position within the string.
7733 If IT->current.overlay_string_index >= 0, the Lisp string is an
7737 next_element_from_string (struct it
*it
)
7739 struct text_pos position
;
7741 eassert (STRINGP (it
->string
));
7742 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7743 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7744 position
= it
->current
.string_pos
;
7746 /* With bidi reordering, the character to display might not be the
7747 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7748 that we were reseat()ed to a new string, whose paragraph
7749 direction is not known. */
7750 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7752 get_visually_first_element (it
);
7753 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7756 /* Time to check for invisible text? */
7757 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7759 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7762 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7763 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7765 /* With bidi non-linear iteration, we could find
7766 ourselves far beyond the last computed stop_charpos,
7767 with several other stop positions in between that we
7768 missed. Scan them all now, in buffer's logical
7769 order, until we find and handle the last stop_charpos
7770 that precedes our current position. */
7771 handle_stop_backwards (it
, it
->stop_charpos
);
7772 return GET_NEXT_DISPLAY_ELEMENT (it
);
7778 /* Take note of the stop position we just moved
7779 across, for when we will move back across it. */
7780 it
->prev_stop
= it
->stop_charpos
;
7781 /* If we are at base paragraph embedding level, take
7782 note of the last stop position seen at this
7784 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7785 it
->base_level_stop
= it
->stop_charpos
;
7789 /* Since a handler may have changed IT->method, we must
7791 return GET_NEXT_DISPLAY_ELEMENT (it
);
7795 /* If we are before prev_stop, we may have overstepped
7796 on our way backwards a stop_pos, and if so, we need
7797 to handle that stop_pos. */
7798 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7799 /* We can sometimes back up for reasons that have nothing
7800 to do with bidi reordering. E.g., compositions. The
7801 code below is only needed when we are above the base
7802 embedding level, so test for that explicitly. */
7803 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7805 /* If we lost track of base_level_stop, we have no better
7806 place for handle_stop_backwards to start from than string
7807 beginning. This happens, e.g., when we were reseated to
7808 the previous screenful of text by vertical-motion. */
7809 if (it
->base_level_stop
<= 0
7810 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7811 it
->base_level_stop
= 0;
7812 handle_stop_backwards (it
, it
->base_level_stop
);
7813 return GET_NEXT_DISPLAY_ELEMENT (it
);
7817 if (it
->current
.overlay_string_index
>= 0)
7819 /* Get the next character from an overlay string. In overlay
7820 strings, there is no field width or padding with spaces to
7822 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7827 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7828 IT_STRING_BYTEPOS (*it
),
7829 it
->bidi_it
.scan_dir
< 0
7831 : SCHARS (it
->string
))
7832 && next_element_from_composition (it
))
7836 else if (STRING_MULTIBYTE (it
->string
))
7838 const unsigned char *s
= (SDATA (it
->string
)
7839 + IT_STRING_BYTEPOS (*it
));
7840 it
->c
= string_char_and_length (s
, &it
->len
);
7844 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7850 /* Get the next character from a Lisp string that is not an
7851 overlay string. Such strings come from the mode line, for
7852 example. We may have to pad with spaces, or truncate the
7853 string. See also next_element_from_c_string. */
7854 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7859 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7861 /* Pad with spaces. */
7862 it
->c
= ' ', it
->len
= 1;
7863 CHARPOS (position
) = BYTEPOS (position
) = -1;
7865 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7866 IT_STRING_BYTEPOS (*it
),
7867 it
->bidi_it
.scan_dir
< 0
7869 : it
->string_nchars
)
7870 && next_element_from_composition (it
))
7874 else if (STRING_MULTIBYTE (it
->string
))
7876 const unsigned char *s
= (SDATA (it
->string
)
7877 + IT_STRING_BYTEPOS (*it
));
7878 it
->c
= string_char_and_length (s
, &it
->len
);
7882 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7887 /* Record what we have and where it came from. */
7888 it
->what
= IT_CHARACTER
;
7889 it
->object
= it
->string
;
7890 it
->position
= position
;
7895 /* Load IT with next display element from C string IT->s.
7896 IT->string_nchars is the maximum number of characters to return
7897 from the string. IT->end_charpos may be greater than
7898 IT->string_nchars when this function is called, in which case we
7899 may have to return padding spaces. Value is false if end of string
7900 reached, including padding spaces. */
7903 next_element_from_c_string (struct it
*it
)
7905 bool success_p
= true;
7908 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7909 it
->what
= IT_CHARACTER
;
7910 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7911 it
->object
= make_number (0);
7913 /* With bidi reordering, the character to display might not be the
7914 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7915 we were reseated to a new string, whose paragraph direction is
7917 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7918 get_visually_first_element (it
);
7920 /* IT's position can be greater than IT->string_nchars in case a
7921 field width or precision has been specified when the iterator was
7923 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7925 /* End of the game. */
7929 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7931 /* Pad with spaces. */
7932 it
->c
= ' ', it
->len
= 1;
7933 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7935 else if (it
->multibyte_p
)
7936 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7938 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7944 /* Set up IT to return characters from an ellipsis, if appropriate.
7945 The definition of the ellipsis glyphs may come from a display table
7946 entry. This function fills IT with the first glyph from the
7947 ellipsis if an ellipsis is to be displayed. */
7950 next_element_from_ellipsis (struct it
*it
)
7952 if (it
->selective_display_ellipsis_p
)
7953 setup_for_ellipsis (it
, it
->len
);
7956 /* The face at the current position may be different from the
7957 face we find after the invisible text. Remember what it
7958 was in IT->saved_face_id, and signal that it's there by
7959 setting face_before_selective_p. */
7960 it
->saved_face_id
= it
->face_id
;
7961 it
->method
= GET_FROM_BUFFER
;
7962 it
->object
= it
->w
->contents
;
7963 reseat_at_next_visible_line_start (it
, true);
7964 it
->face_before_selective_p
= true;
7967 return GET_NEXT_DISPLAY_ELEMENT (it
);
7971 /* Deliver an image display element. The iterator IT is already
7972 filled with image information (done in handle_display_prop). Value
7977 next_element_from_image (struct it
*it
)
7979 it
->what
= IT_IMAGE
;
7984 /* Fill iterator IT with next display element from a stretch glyph
7985 property. IT->object is the value of the text property. Value is
7989 next_element_from_stretch (struct it
*it
)
7991 it
->what
= IT_STRETCH
;
7995 /* Scan backwards from IT's current position until we find a stop
7996 position, or until BEGV. This is called when we find ourself
7997 before both the last known prev_stop and base_level_stop while
7998 reordering bidirectional text. */
8001 compute_stop_pos_backwards (struct it
*it
)
8003 const int SCAN_BACK_LIMIT
= 1000;
8004 struct text_pos pos
;
8005 struct display_pos save_current
= it
->current
;
8006 struct text_pos save_position
= it
->position
;
8007 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8008 ptrdiff_t where_we_are
= charpos
;
8009 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8010 ptrdiff_t save_end_pos
= it
->end_charpos
;
8012 eassert (NILP (it
->string
) && !it
->s
);
8013 eassert (it
->bidi_p
);
8017 it
->end_charpos
= min (charpos
+ 1, ZV
);
8018 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8019 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8020 reseat_1 (it
, pos
, false);
8021 compute_stop_pos (it
);
8022 /* We must advance forward, right? */
8023 if (it
->stop_charpos
<= charpos
)
8026 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8028 if (it
->stop_charpos
<= where_we_are
)
8029 it
->prev_stop
= it
->stop_charpos
;
8031 it
->prev_stop
= BEGV
;
8033 it
->current
= save_current
;
8034 it
->position
= save_position
;
8035 it
->stop_charpos
= save_stop_pos
;
8036 it
->end_charpos
= save_end_pos
;
8039 /* Scan forward from CHARPOS in the current buffer/string, until we
8040 find a stop position > current IT's position. Then handle the stop
8041 position before that. This is called when we bump into a stop
8042 position while reordering bidirectional text. CHARPOS should be
8043 the last previously processed stop_pos (or BEGV/0, if none were
8044 processed yet) whose position is less that IT's current
8048 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8050 bool bufp
= !STRINGP (it
->string
);
8051 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8052 struct display_pos save_current
= it
->current
;
8053 struct text_pos save_position
= it
->position
;
8054 struct text_pos pos1
;
8055 ptrdiff_t next_stop
;
8057 /* Scan in strict logical order. */
8058 eassert (it
->bidi_p
);
8062 it
->prev_stop
= charpos
;
8065 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8066 reseat_1 (it
, pos1
, false);
8069 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8070 compute_stop_pos (it
);
8071 /* We must advance forward, right? */
8072 if (it
->stop_charpos
<= it
->prev_stop
)
8074 charpos
= it
->stop_charpos
;
8076 while (charpos
<= where_we_are
);
8079 it
->current
= save_current
;
8080 it
->position
= save_position
;
8081 next_stop
= it
->stop_charpos
;
8082 it
->stop_charpos
= it
->prev_stop
;
8084 it
->stop_charpos
= next_stop
;
8087 /* Load IT with the next display element from current_buffer. Value
8088 is false if end of buffer reached. IT->stop_charpos is the next
8089 position at which to stop and check for text properties or buffer
8093 next_element_from_buffer (struct it
*it
)
8095 bool success_p
= true;
8097 eassert (IT_CHARPOS (*it
) >= BEGV
);
8098 eassert (NILP (it
->string
) && !it
->s
);
8099 eassert (!it
->bidi_p
8100 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8101 && it
->bidi_it
.string
.s
== NULL
));
8103 /* With bidi reordering, the character to display might not be the
8104 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8105 we were reseat()ed to a new buffer position, which is potentially
8106 a different paragraph. */
8107 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8109 get_visually_first_element (it
);
8110 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8113 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8115 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8117 bool overlay_strings_follow_p
;
8119 /* End of the game, except when overlay strings follow that
8120 haven't been returned yet. */
8121 if (it
->overlay_strings_at_end_processed_p
)
8122 overlay_strings_follow_p
= false;
8125 it
->overlay_strings_at_end_processed_p
= true;
8126 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8129 if (overlay_strings_follow_p
)
8130 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8134 it
->position
= it
->current
.pos
;
8138 else if (!(!it
->bidi_p
8139 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8140 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8142 /* With bidi non-linear iteration, we could find ourselves
8143 far beyond the last computed stop_charpos, with several
8144 other stop positions in between that we missed. Scan
8145 them all now, in buffer's logical order, until we find
8146 and handle the last stop_charpos that precedes our
8147 current position. */
8148 handle_stop_backwards (it
, it
->stop_charpos
);
8149 it
->ignore_overlay_strings_at_pos_p
= false;
8150 return GET_NEXT_DISPLAY_ELEMENT (it
);
8156 /* Take note of the stop position we just moved across,
8157 for when we will move back across it. */
8158 it
->prev_stop
= it
->stop_charpos
;
8159 /* If we are at base paragraph embedding level, take
8160 note of the last stop position seen at this
8162 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8163 it
->base_level_stop
= it
->stop_charpos
;
8166 it
->ignore_overlay_strings_at_pos_p
= false;
8167 return GET_NEXT_DISPLAY_ELEMENT (it
);
8171 /* If we are before prev_stop, we may have overstepped on
8172 our way backwards a stop_pos, and if so, we need to
8173 handle that stop_pos. */
8174 && IT_CHARPOS (*it
) < it
->prev_stop
8175 /* We can sometimes back up for reasons that have nothing
8176 to do with bidi reordering. E.g., compositions. The
8177 code below is only needed when we are above the base
8178 embedding level, so test for that explicitly. */
8179 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8181 if (it
->base_level_stop
<= 0
8182 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8184 /* If we lost track of base_level_stop, we need to find
8185 prev_stop by looking backwards. This happens, e.g., when
8186 we were reseated to the previous screenful of text by
8188 it
->base_level_stop
= BEGV
;
8189 compute_stop_pos_backwards (it
);
8190 handle_stop_backwards (it
, it
->prev_stop
);
8193 handle_stop_backwards (it
, it
->base_level_stop
);
8194 it
->ignore_overlay_strings_at_pos_p
= false;
8195 return GET_NEXT_DISPLAY_ELEMENT (it
);
8199 /* No face changes, overlays etc. in sight, so just return a
8200 character from current_buffer. */
8204 /* We moved to the next buffer position, so any info about
8205 previously seen overlays is no longer valid. */
8206 it
->ignore_overlay_strings_at_pos_p
= false;
8208 /* Maybe run the redisplay end trigger hook. Performance note:
8209 This doesn't seem to cost measurable time. */
8210 if (it
->redisplay_end_trigger_charpos
8212 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8213 run_redisplay_end_trigger_hook (it
);
8215 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8216 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8218 && next_element_from_composition (it
))
8223 /* Get the next character, maybe multibyte. */
8224 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8225 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8226 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8228 it
->c
= *p
, it
->len
= 1;
8230 /* Record what we have and where it came from. */
8231 it
->what
= IT_CHARACTER
;
8232 it
->object
= it
->w
->contents
;
8233 it
->position
= it
->current
.pos
;
8235 /* Normally we return the character found above, except when we
8236 really want to return an ellipsis for selective display. */
8241 /* A value of selective > 0 means hide lines indented more
8242 than that number of columns. */
8243 if (it
->selective
> 0
8244 && IT_CHARPOS (*it
) + 1 < ZV
8245 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8246 IT_BYTEPOS (*it
) + 1,
8249 success_p
= next_element_from_ellipsis (it
);
8250 it
->dpvec_char_len
= -1;
8253 else if (it
->c
== '\r' && it
->selective
== -1)
8255 /* A value of selective == -1 means that everything from the
8256 CR to the end of the line is invisible, with maybe an
8257 ellipsis displayed for it. */
8258 success_p
= next_element_from_ellipsis (it
);
8259 it
->dpvec_char_len
= -1;
8264 /* Value is false if end of buffer reached. */
8265 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8270 /* Run the redisplay end trigger hook for IT. */
8273 run_redisplay_end_trigger_hook (struct it
*it
)
8275 /* IT->glyph_row should be non-null, i.e. we should be actually
8276 displaying something, or otherwise we should not run the hook. */
8277 eassert (it
->glyph_row
);
8279 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8280 it
->redisplay_end_trigger_charpos
= 0;
8282 /* Since we are *trying* to run these functions, don't try to run
8283 them again, even if they get an error. */
8284 wset_redisplay_end_trigger (it
->w
, Qnil
);
8285 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8286 make_number (charpos
));
8288 /* Notice if it changed the face of the character we are on. */
8289 handle_face_prop (it
);
8293 /* Deliver a composition display element. Unlike the other
8294 next_element_from_XXX, this function is not registered in the array
8295 get_next_element[]. It is called from next_element_from_buffer and
8296 next_element_from_string when necessary. */
8299 next_element_from_composition (struct it
*it
)
8301 it
->what
= IT_COMPOSITION
;
8302 it
->len
= it
->cmp_it
.nbytes
;
8303 if (STRINGP (it
->string
))
8307 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8308 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8311 it
->position
= it
->current
.string_pos
;
8312 it
->object
= it
->string
;
8313 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8314 IT_STRING_BYTEPOS (*it
), it
->string
);
8320 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8321 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8324 if (it
->bidi_it
.new_paragraph
)
8325 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8327 /* Resync the bidi iterator with IT's new position.
8328 FIXME: this doesn't support bidirectional text. */
8329 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8330 bidi_move_to_visually_next (&it
->bidi_it
);
8334 it
->position
= it
->current
.pos
;
8335 it
->object
= it
->w
->contents
;
8336 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8337 IT_BYTEPOS (*it
), Qnil
);
8344 /***********************************************************************
8345 Moving an iterator without producing glyphs
8346 ***********************************************************************/
8348 /* Check if iterator is at a position corresponding to a valid buffer
8349 position after some move_it_ call. */
8351 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8352 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8355 /* Move iterator IT to a specified buffer or X position within one
8356 line on the display without producing glyphs.
8358 OP should be a bit mask including some or all of these bits:
8359 MOVE_TO_X: Stop upon reaching x-position TO_X.
8360 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8361 Regardless of OP's value, stop upon reaching the end of the display line.
8363 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8364 This means, in particular, that TO_X includes window's horizontal
8367 The return value has several possible values that
8368 say what condition caused the scan to stop:
8370 MOVE_POS_MATCH_OR_ZV
8371 - when TO_POS or ZV was reached.
8374 -when TO_X was reached before TO_POS or ZV were reached.
8377 - when we reached the end of the display area and the line must
8381 - when we reached the end of the display area and the line is
8385 - when we stopped at a line end, i.e. a newline or a CR and selective
8388 static enum move_it_result
8389 move_it_in_display_line_to (struct it
*it
,
8390 ptrdiff_t to_charpos
, int to_x
,
8391 enum move_operation_enum op
)
8393 enum move_it_result result
= MOVE_UNDEFINED
;
8394 struct glyph_row
*saved_glyph_row
;
8395 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8396 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8397 void *ppos_data
= NULL
;
8398 bool may_wrap
= false;
8399 enum it_method prev_method
= it
->method
;
8400 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8401 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8403 /* Don't produce glyphs in produce_glyphs. */
8404 saved_glyph_row
= it
->glyph_row
;
8405 it
->glyph_row
= NULL
;
8407 /* Use wrap_it to save a copy of IT wherever a word wrap could
8408 occur. Use atpos_it to save a copy of IT at the desired buffer
8409 position, if found, so that we can scan ahead and check if the
8410 word later overshoots the window edge. Use atx_it similarly, for
8416 /* Use ppos_it under bidi reordering to save a copy of IT for the
8417 initial position. We restore that position in IT when we have
8418 scanned the entire display line without finding a match for
8419 TO_CHARPOS and all the character positions are greater than
8420 TO_CHARPOS. We then restart the scan from the initial position,
8421 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8422 the closest to TO_CHARPOS. */
8425 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8427 SAVE_IT (ppos_it
, *it
, ppos_data
);
8428 closest_pos
= IT_CHARPOS (*it
);
8434 #define BUFFER_POS_REACHED_P() \
8435 ((op & MOVE_TO_POS) != 0 \
8436 && BUFFERP (it->object) \
8437 && (IT_CHARPOS (*it) == to_charpos \
8439 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8440 && IT_CHARPOS (*it) > to_charpos) \
8441 || (it->what == IT_COMPOSITION \
8442 && ((IT_CHARPOS (*it) > to_charpos \
8443 && to_charpos >= it->cmp_it.charpos) \
8444 || (IT_CHARPOS (*it) < to_charpos \
8445 && to_charpos <= it->cmp_it.charpos)))) \
8446 && (it->method == GET_FROM_BUFFER \
8447 || (it->method == GET_FROM_DISPLAY_VECTOR \
8448 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8450 /* If there's a line-/wrap-prefix, handle it. */
8451 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8452 && it
->current_y
< it
->last_visible_y
)
8453 handle_line_prefix (it
);
8455 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8456 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8460 int x
, i
, ascent
= 0, descent
= 0;
8462 /* Utility macro to reset an iterator with x, ascent, and descent. */
8463 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8464 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8465 (IT)->max_descent = descent)
8467 /* Stop if we move beyond TO_CHARPOS (after an image or a
8468 display string or stretch glyph). */
8469 if ((op
& MOVE_TO_POS
) != 0
8470 && BUFFERP (it
->object
)
8471 && it
->method
== GET_FROM_BUFFER
8473 /* When the iterator is at base embedding level, we
8474 are guaranteed that characters are delivered for
8475 display in strictly increasing order of their
8476 buffer positions. */
8477 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8478 && IT_CHARPOS (*it
) > to_charpos
)
8480 && (prev_method
== GET_FROM_IMAGE
8481 || prev_method
== GET_FROM_STRETCH
8482 || prev_method
== GET_FROM_STRING
)
8483 /* Passed TO_CHARPOS from left to right. */
8484 && ((prev_pos
< to_charpos
8485 && IT_CHARPOS (*it
) > to_charpos
)
8486 /* Passed TO_CHARPOS from right to left. */
8487 || (prev_pos
> to_charpos
8488 && IT_CHARPOS (*it
) < to_charpos
)))))
8490 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8492 result
= MOVE_POS_MATCH_OR_ZV
;
8495 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8496 /* If wrap_it is valid, the current position might be in a
8497 word that is wrapped. So, save the iterator in
8498 atpos_it and continue to see if wrapping happens. */
8499 SAVE_IT (atpos_it
, *it
, atpos_data
);
8502 /* Stop when ZV reached.
8503 We used to stop here when TO_CHARPOS reached as well, but that is
8504 too soon if this glyph does not fit on this line. So we handle it
8505 explicitly below. */
8506 if (!get_next_display_element (it
))
8508 result
= MOVE_POS_MATCH_OR_ZV
;
8512 if (it
->line_wrap
== TRUNCATE
)
8514 if (BUFFER_POS_REACHED_P ())
8516 result
= MOVE_POS_MATCH_OR_ZV
;
8522 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8524 if (IT_DISPLAYING_WHITESPACE (it
))
8528 /* We have reached a glyph that follows one or more
8529 whitespace characters. If the position is
8530 already found, we are done. */
8531 if (atpos_it
.sp
>= 0)
8533 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8534 result
= MOVE_POS_MATCH_OR_ZV
;
8539 RESTORE_IT (it
, &atx_it
, atx_data
);
8540 result
= MOVE_X_REACHED
;
8543 /* Otherwise, we can wrap here. */
8544 SAVE_IT (wrap_it
, *it
, wrap_data
);
8550 /* Remember the line height for the current line, in case
8551 the next element doesn't fit on the line. */
8552 ascent
= it
->max_ascent
;
8553 descent
= it
->max_descent
;
8555 /* The call to produce_glyphs will get the metrics of the
8556 display element IT is loaded with. Record the x-position
8557 before this display element, in case it doesn't fit on the
8561 PRODUCE_GLYPHS (it
);
8563 if (it
->area
!= TEXT_AREA
)
8565 prev_method
= it
->method
;
8566 if (it
->method
== GET_FROM_BUFFER
)
8567 prev_pos
= IT_CHARPOS (*it
);
8568 set_iterator_to_next (it
, true);
8569 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8570 SET_TEXT_POS (this_line_min_pos
,
8571 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8573 && (op
& MOVE_TO_POS
)
8574 && IT_CHARPOS (*it
) > to_charpos
8575 && IT_CHARPOS (*it
) < closest_pos
)
8576 closest_pos
= IT_CHARPOS (*it
);
8580 /* The number of glyphs we get back in IT->nglyphs will normally
8581 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8582 character on a terminal frame, or (iii) a line end. For the
8583 second case, IT->nglyphs - 1 padding glyphs will be present.
8584 (On X frames, there is only one glyph produced for a
8585 composite character.)
8587 The behavior implemented below means, for continuation lines,
8588 that as many spaces of a TAB as fit on the current line are
8589 displayed there. For terminal frames, as many glyphs of a
8590 multi-glyph character are displayed in the current line, too.
8591 This is what the old redisplay code did, and we keep it that
8592 way. Under X, the whole shape of a complex character must
8593 fit on the line or it will be completely displayed in the
8596 Note that both for tabs and padding glyphs, all glyphs have
8600 /* More than one glyph or glyph doesn't fit on line. All
8601 glyphs have the same width. */
8602 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8604 int x_before_this_char
= x
;
8605 int hpos_before_this_char
= it
->hpos
;
8607 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8609 new_x
= x
+ single_glyph_width
;
8611 /* We want to leave anything reaching TO_X to the caller. */
8612 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8614 if (BUFFER_POS_REACHED_P ())
8616 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8617 goto buffer_pos_reached
;
8618 if (atpos_it
.sp
< 0)
8620 SAVE_IT (atpos_it
, *it
, atpos_data
);
8621 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8626 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8629 result
= MOVE_X_REACHED
;
8634 SAVE_IT (atx_it
, *it
, atx_data
);
8635 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8640 if (/* Lines are continued. */
8641 it
->line_wrap
!= TRUNCATE
8642 && (/* And glyph doesn't fit on the line. */
8643 new_x
> it
->last_visible_x
8644 /* Or it fits exactly and we're on a window
8646 || (new_x
== it
->last_visible_x
8647 && FRAME_WINDOW_P (it
->f
)
8648 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8649 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8650 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8652 if (/* IT->hpos == 0 means the very first glyph
8653 doesn't fit on the line, e.g. a wide image. */
8655 || (new_x
== it
->last_visible_x
8656 && FRAME_WINDOW_P (it
->f
)))
8659 it
->current_x
= new_x
;
8661 /* The character's last glyph just barely fits
8663 if (i
== it
->nglyphs
- 1)
8665 /* If this is the destination position,
8666 return a position *before* it in this row,
8667 now that we know it fits in this row. */
8668 if (BUFFER_POS_REACHED_P ())
8670 if (it
->line_wrap
!= WORD_WRAP
8672 /* If we've just found whitespace to
8673 wrap, effectively ignore the
8674 previous wrap point -- it is no
8675 longer relevant, but we won't
8676 have an opportunity to update it,
8677 since we've reached the edge of
8678 this screen line. */
8680 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8682 it
->hpos
= hpos_before_this_char
;
8683 it
->current_x
= x_before_this_char
;
8684 result
= MOVE_POS_MATCH_OR_ZV
;
8687 if (it
->line_wrap
== WORD_WRAP
8690 SAVE_IT (atpos_it
, *it
, atpos_data
);
8691 atpos_it
.current_x
= x_before_this_char
;
8692 atpos_it
.hpos
= hpos_before_this_char
;
8696 prev_method
= it
->method
;
8697 if (it
->method
== GET_FROM_BUFFER
)
8698 prev_pos
= IT_CHARPOS (*it
);
8699 set_iterator_to_next (it
, true);
8700 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8701 SET_TEXT_POS (this_line_min_pos
,
8702 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8703 /* On graphical terminals, newlines may
8704 "overflow" into the fringe if
8705 overflow-newline-into-fringe is non-nil.
8706 On text terminals, and on graphical
8707 terminals with no right margin, newlines
8708 may overflow into the last glyph on the
8710 if (!FRAME_WINDOW_P (it
->f
)
8712 && it
->bidi_it
.paragraph_dir
== R2L
)
8713 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8714 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8715 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8717 if (!get_next_display_element (it
))
8719 result
= MOVE_POS_MATCH_OR_ZV
;
8722 if (BUFFER_POS_REACHED_P ())
8724 if (ITERATOR_AT_END_OF_LINE_P (it
))
8725 result
= MOVE_POS_MATCH_OR_ZV
;
8727 result
= MOVE_LINE_CONTINUED
;
8730 if (ITERATOR_AT_END_OF_LINE_P (it
)
8731 && (it
->line_wrap
!= WORD_WRAP
8733 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8735 result
= MOVE_NEWLINE_OR_CR
;
8742 IT_RESET_X_ASCENT_DESCENT (it
);
8744 /* If the screen line ends with whitespace, and we
8745 are under word-wrap, don't use wrap_it: it is no
8746 longer relevant, but we won't have an opportunity
8747 to update it, since we are done with this screen
8749 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8751 /* If we've found TO_X, go back there, as we now
8752 know the last word fits on this screen line. */
8753 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8756 RESTORE_IT (it
, &atx_it
, atx_data
);
8759 result
= MOVE_X_REACHED
;
8763 else if (wrap_it
.sp
>= 0)
8765 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8770 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8772 result
= MOVE_LINE_CONTINUED
;
8776 if (BUFFER_POS_REACHED_P ())
8778 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8779 goto buffer_pos_reached
;
8780 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8782 SAVE_IT (atpos_it
, *it
, atpos_data
);
8783 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8787 if (new_x
> it
->first_visible_x
)
8789 /* Glyph is visible. Increment number of glyphs that
8790 would be displayed. */
8795 if (result
!= MOVE_UNDEFINED
)
8798 else if (BUFFER_POS_REACHED_P ())
8801 IT_RESET_X_ASCENT_DESCENT (it
);
8802 result
= MOVE_POS_MATCH_OR_ZV
;
8805 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8807 /* Stop when TO_X specified and reached. This check is
8808 necessary here because of lines consisting of a line end,
8809 only. The line end will not produce any glyphs and we
8810 would never get MOVE_X_REACHED. */
8811 eassert (it
->nglyphs
== 0);
8812 result
= MOVE_X_REACHED
;
8816 /* Is this a line end? If yes, we're done. */
8817 if (ITERATOR_AT_END_OF_LINE_P (it
))
8819 /* If we are past TO_CHARPOS, but never saw any character
8820 positions smaller than TO_CHARPOS, return
8821 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8823 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8825 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8827 if (closest_pos
< ZV
)
8829 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8830 /* Don't recurse if closest_pos is equal to
8831 to_charpos, since we have just tried that. */
8832 if (closest_pos
!= to_charpos
)
8833 move_it_in_display_line_to (it
, closest_pos
, -1,
8835 result
= MOVE_POS_MATCH_OR_ZV
;
8838 goto buffer_pos_reached
;
8840 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8841 && IT_CHARPOS (*it
) > to_charpos
)
8842 goto buffer_pos_reached
;
8844 result
= MOVE_NEWLINE_OR_CR
;
8847 result
= MOVE_NEWLINE_OR_CR
;
8851 prev_method
= it
->method
;
8852 if (it
->method
== GET_FROM_BUFFER
)
8853 prev_pos
= IT_CHARPOS (*it
);
8854 /* The current display element has been consumed. Advance
8856 set_iterator_to_next (it
, true);
8857 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8858 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8859 if (IT_CHARPOS (*it
) < to_charpos
)
8860 saw_smaller_pos
= true;
8862 && (op
& MOVE_TO_POS
)
8863 && IT_CHARPOS (*it
) >= to_charpos
8864 && IT_CHARPOS (*it
) < closest_pos
)
8865 closest_pos
= IT_CHARPOS (*it
);
8867 /* Stop if lines are truncated and IT's current x-position is
8868 past the right edge of the window now. */
8869 if (it
->line_wrap
== TRUNCATE
8870 && it
->current_x
>= it
->last_visible_x
)
8872 if (!FRAME_WINDOW_P (it
->f
)
8873 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8874 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8875 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8876 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8878 bool at_eob_p
= false;
8880 if ((at_eob_p
= !get_next_display_element (it
))
8881 || BUFFER_POS_REACHED_P ()
8882 /* If we are past TO_CHARPOS, but never saw any
8883 character positions smaller than TO_CHARPOS,
8884 return MOVE_POS_MATCH_OR_ZV, like the
8885 unidirectional display did. */
8886 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8888 && IT_CHARPOS (*it
) > to_charpos
))
8891 && !BUFFER_POS_REACHED_P ()
8892 && !at_eob_p
&& closest_pos
< ZV
)
8894 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8895 if (closest_pos
!= to_charpos
)
8896 move_it_in_display_line_to (it
, closest_pos
, -1,
8899 result
= MOVE_POS_MATCH_OR_ZV
;
8902 if (ITERATOR_AT_END_OF_LINE_P (it
))
8904 result
= MOVE_NEWLINE_OR_CR
;
8908 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8910 && IT_CHARPOS (*it
) > to_charpos
)
8912 if (closest_pos
< ZV
)
8914 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8915 if (closest_pos
!= to_charpos
)
8916 move_it_in_display_line_to (it
, closest_pos
, -1,
8919 result
= MOVE_POS_MATCH_OR_ZV
;
8922 result
= MOVE_LINE_TRUNCATED
;
8925 #undef IT_RESET_X_ASCENT_DESCENT
8928 #undef BUFFER_POS_REACHED_P
8930 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8931 restore the saved iterator. */
8932 if (atpos_it
.sp
>= 0)
8933 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8934 else if (atx_it
.sp
>= 0)
8935 RESTORE_IT (it
, &atx_it
, atx_data
);
8940 bidi_unshelve_cache (atpos_data
, true);
8942 bidi_unshelve_cache (atx_data
, true);
8944 bidi_unshelve_cache (wrap_data
, true);
8946 bidi_unshelve_cache (ppos_data
, true);
8948 /* Restore the iterator settings altered at the beginning of this
8950 it
->glyph_row
= saved_glyph_row
;
8954 /* For external use. */
8956 move_it_in_display_line (struct it
*it
,
8957 ptrdiff_t to_charpos
, int to_x
,
8958 enum move_operation_enum op
)
8960 if (it
->line_wrap
== WORD_WRAP
8961 && (op
& MOVE_TO_X
))
8964 void *save_data
= NULL
;
8967 SAVE_IT (save_it
, *it
, save_data
);
8968 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8969 /* When word-wrap is on, TO_X may lie past the end
8970 of a wrapped line. Then it->current is the
8971 character on the next line, so backtrack to the
8972 space before the wrap point. */
8973 if (skip
== MOVE_LINE_CONTINUED
)
8975 int prev_x
= max (it
->current_x
- 1, 0);
8976 RESTORE_IT (it
, &save_it
, save_data
);
8977 move_it_in_display_line_to
8978 (it
, -1, prev_x
, MOVE_TO_X
);
8981 bidi_unshelve_cache (save_data
, true);
8984 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8988 /* Move IT forward until it satisfies one or more of the criteria in
8989 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8991 OP is a bit-mask that specifies where to stop, and in particular,
8992 which of those four position arguments makes a difference. See the
8993 description of enum move_operation_enum.
8995 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8996 screen line, this function will set IT to the next position that is
8997 displayed to the right of TO_CHARPOS on the screen.
8999 Return the maximum pixel length of any line scanned but never more
9000 than it.last_visible_x. */
9003 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9005 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9006 int line_height
, line_start_x
= 0, reached
= 0;
9007 int max_current_x
= 0;
9008 void *backup_data
= NULL
;
9012 if (op
& MOVE_TO_VPOS
)
9014 /* If no TO_CHARPOS and no TO_X specified, stop at the
9015 start of the line TO_VPOS. */
9016 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9018 if (it
->vpos
== to_vpos
)
9024 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9028 /* TO_VPOS >= 0 means stop at TO_X in the line at
9029 TO_VPOS, or at TO_POS, whichever comes first. */
9030 if (it
->vpos
== to_vpos
)
9036 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9038 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9043 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9045 /* We have reached TO_X but not in the line we want. */
9046 skip
= move_it_in_display_line_to (it
, to_charpos
,
9048 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9056 else if (op
& MOVE_TO_Y
)
9058 struct it it_backup
;
9060 if (it
->line_wrap
== WORD_WRAP
)
9061 SAVE_IT (it_backup
, *it
, backup_data
);
9063 /* TO_Y specified means stop at TO_X in the line containing
9064 TO_Y---or at TO_CHARPOS if this is reached first. The
9065 problem is that we can't really tell whether the line
9066 contains TO_Y before we have completely scanned it, and
9067 this may skip past TO_X. What we do is to first scan to
9070 If TO_X is not specified, use a TO_X of zero. The reason
9071 is to make the outcome of this function more predictable.
9072 If we didn't use TO_X == 0, we would stop at the end of
9073 the line which is probably not what a caller would expect
9075 skip
= move_it_in_display_line_to
9076 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9077 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9079 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9080 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9082 else if (skip
== MOVE_X_REACHED
)
9084 /* If TO_X was reached, we want to know whether TO_Y is
9085 in the line. We know this is the case if the already
9086 scanned glyphs make the line tall enough. Otherwise,
9087 we must check by scanning the rest of the line. */
9088 line_height
= it
->max_ascent
+ it
->max_descent
;
9089 if (to_y
>= it
->current_y
9090 && to_y
< it
->current_y
+ line_height
)
9095 SAVE_IT (it_backup
, *it
, backup_data
);
9096 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9097 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9099 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9100 line_height
= it
->max_ascent
+ it
->max_descent
;
9101 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9103 if (to_y
>= it
->current_y
9104 && to_y
< it
->current_y
+ line_height
)
9106 /* If TO_Y is in this line and TO_X was reached
9107 above, we scanned too far. We have to restore
9108 IT's settings to the ones before skipping. But
9109 keep the more accurate values of max_ascent and
9110 max_descent we've found while skipping the rest
9111 of the line, for the sake of callers, such as
9112 pos_visible_p, that need to know the line
9114 int max_ascent
= it
->max_ascent
;
9115 int max_descent
= it
->max_descent
;
9117 RESTORE_IT (it
, &it_backup
, backup_data
);
9118 it
->max_ascent
= max_ascent
;
9119 it
->max_descent
= max_descent
;
9125 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9131 /* Check whether TO_Y is in this line. */
9132 line_height
= it
->max_ascent
+ it
->max_descent
;
9133 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9135 if (to_y
>= it
->current_y
9136 && to_y
< it
->current_y
+ line_height
)
9138 if (to_y
> it
->current_y
)
9139 max_current_x
= max (it
->current_x
, max_current_x
);
9141 /* When word-wrap is on, TO_X may lie past the end
9142 of a wrapped line. Then it->current is the
9143 character on the next line, so backtrack to the
9144 space before the wrap point. */
9145 if (skip
== MOVE_LINE_CONTINUED
9146 && it
->line_wrap
== WORD_WRAP
)
9148 int prev_x
= max (it
->current_x
- 1, 0);
9149 RESTORE_IT (it
, &it_backup
, backup_data
);
9150 skip
= move_it_in_display_line_to
9151 (it
, -1, prev_x
, MOVE_TO_X
);
9160 max_current_x
= max (it
->current_x
, max_current_x
);
9164 else if (BUFFERP (it
->object
)
9165 && (it
->method
== GET_FROM_BUFFER
9166 || it
->method
== GET_FROM_STRETCH
)
9167 && IT_CHARPOS (*it
) >= to_charpos
9168 /* Under bidi iteration, a call to set_iterator_to_next
9169 can scan far beyond to_charpos if the initial
9170 portion of the next line needs to be reordered. In
9171 that case, give move_it_in_display_line_to another
9174 && it
->bidi_it
.scan_dir
== -1))
9175 skip
= MOVE_POS_MATCH_OR_ZV
;
9177 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9181 case MOVE_POS_MATCH_OR_ZV
:
9182 max_current_x
= max (it
->current_x
, max_current_x
);
9186 case MOVE_NEWLINE_OR_CR
:
9187 max_current_x
= max (it
->current_x
, max_current_x
);
9188 set_iterator_to_next (it
, true);
9189 it
->continuation_lines_width
= 0;
9192 case MOVE_LINE_TRUNCATED
:
9193 max_current_x
= it
->last_visible_x
;
9194 it
->continuation_lines_width
= 0;
9195 reseat_at_next_visible_line_start (it
, false);
9196 if ((op
& MOVE_TO_POS
) != 0
9197 && IT_CHARPOS (*it
) > to_charpos
)
9204 case MOVE_LINE_CONTINUED
:
9205 max_current_x
= it
->last_visible_x
;
9206 /* For continued lines ending in a tab, some of the glyphs
9207 associated with the tab are displayed on the current
9208 line. Since it->current_x does not include these glyphs,
9209 we use it->last_visible_x instead. */
9212 it
->continuation_lines_width
+= it
->last_visible_x
;
9213 /* When moving by vpos, ensure that the iterator really
9214 advances to the next line (bug#847, bug#969). Fixme:
9215 do we need to do this in other circumstances? */
9216 if (it
->current_x
!= it
->last_visible_x
9217 && (op
& MOVE_TO_VPOS
)
9218 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9220 line_start_x
= it
->current_x
+ it
->pixel_width
9221 - it
->last_visible_x
;
9222 if (FRAME_WINDOW_P (it
->f
))
9224 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9225 struct font
*face_font
= face
->font
;
9227 /* When display_line produces a continued line
9228 that ends in a TAB, it skips a tab stop that
9229 is closer than the font's space character
9230 width (see x_produce_glyphs where it produces
9231 the stretch glyph which represents a TAB).
9232 We need to reproduce the same logic here. */
9233 eassert (face_font
);
9236 if (line_start_x
< face_font
->space_width
)
9238 += it
->tab_width
* face_font
->space_width
;
9241 set_iterator_to_next (it
, false);
9245 it
->continuation_lines_width
+= it
->current_x
;
9252 /* Reset/increment for the next run. */
9253 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9254 it
->current_x
= line_start_x
;
9257 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9259 last_height
= it
->max_ascent
+ it
->max_descent
;
9260 it
->max_ascent
= it
->max_descent
= 0;
9265 /* On text terminals, we may stop at the end of a line in the middle
9266 of a multi-character glyph. If the glyph itself is continued,
9267 i.e. it is actually displayed on the next line, don't treat this
9268 stopping point as valid; move to the next line instead (unless
9269 that brings us offscreen). */
9270 if (!FRAME_WINDOW_P (it
->f
)
9272 && IT_CHARPOS (*it
) == to_charpos
9273 && it
->what
== IT_CHARACTER
9275 && it
->line_wrap
== WINDOW_WRAP
9276 && it
->current_x
== it
->last_visible_x
- 1
9279 && it
->w
->window_end_valid
9280 && it
->vpos
< it
->w
->window_end_vpos
)
9282 it
->continuation_lines_width
+= it
->current_x
;
9283 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9284 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9286 last_height
= it
->max_ascent
+ it
->max_descent
;
9290 bidi_unshelve_cache (backup_data
, true);
9292 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9294 return max_current_x
;
9298 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9300 If DY > 0, move IT backward at least that many pixels. DY = 0
9301 means move IT backward to the preceding line start or BEGV. This
9302 function may move over more than DY pixels if IT->current_y - DY
9303 ends up in the middle of a line; in this case IT->current_y will be
9304 set to the top of the line moved to. */
9307 move_it_vertically_backward (struct it
*it
, int dy
)
9311 void *it2data
= NULL
, *it3data
= NULL
;
9312 ptrdiff_t start_pos
;
9314 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9315 ptrdiff_t pos_limit
;
9320 start_pos
= IT_CHARPOS (*it
);
9322 /* Estimate how many newlines we must move back. */
9323 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9324 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9327 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9329 /* Set the iterator's position that many lines back. But don't go
9330 back more than NLINES full screen lines -- this wins a day with
9331 buffers which have very long lines. */
9332 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9333 back_to_previous_visible_line_start (it
);
9335 /* Reseat the iterator here. When moving backward, we don't want
9336 reseat to skip forward over invisible text, set up the iterator
9337 to deliver from overlay strings at the new position etc. So,
9338 use reseat_1 here. */
9339 reseat_1 (it
, it
->current
.pos
, true);
9341 /* We are now surely at a line start. */
9342 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9343 reordering is in effect. */
9344 it
->continuation_lines_width
= 0;
9346 /* Move forward and see what y-distance we moved. First move to the
9347 start of the next line so that we get its height. We need this
9348 height to be able to tell whether we reached the specified
9350 SAVE_IT (it2
, *it
, it2data
);
9351 it2
.max_ascent
= it2
.max_descent
= 0;
9354 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9355 MOVE_TO_POS
| MOVE_TO_VPOS
);
9357 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9358 /* If we are in a display string which starts at START_POS,
9359 and that display string includes a newline, and we are
9360 right after that newline (i.e. at the beginning of a
9361 display line), exit the loop, because otherwise we will
9362 infloop, since move_it_to will see that it is already at
9363 START_POS and will not move. */
9364 || (it2
.method
== GET_FROM_STRING
9365 && IT_CHARPOS (it2
) == start_pos
9366 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9367 eassert (IT_CHARPOS (*it
) >= BEGV
);
9368 SAVE_IT (it3
, it2
, it3data
);
9370 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9371 eassert (IT_CHARPOS (*it
) >= BEGV
);
9372 /* H is the actual vertical distance from the position in *IT
9373 and the starting position. */
9374 h
= it2
.current_y
- it
->current_y
;
9375 /* NLINES is the distance in number of lines. */
9376 nlines
= it2
.vpos
- it
->vpos
;
9378 /* Correct IT's y and vpos position
9379 so that they are relative to the starting point. */
9385 /* DY == 0 means move to the start of the screen line. The
9386 value of nlines is > 0 if continuation lines were involved,
9387 or if the original IT position was at start of a line. */
9388 RESTORE_IT (it
, it
, it2data
);
9390 move_it_by_lines (it
, nlines
);
9391 /* The above code moves us to some position NLINES down,
9392 usually to its first glyph (leftmost in an L2R line), but
9393 that's not necessarily the start of the line, under bidi
9394 reordering. We want to get to the character position
9395 that is immediately after the newline of the previous
9398 && !it
->continuation_lines_width
9399 && !STRINGP (it
->string
)
9400 && IT_CHARPOS (*it
) > BEGV
9401 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9403 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9406 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9407 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9409 bidi_unshelve_cache (it3data
, true);
9413 /* The y-position we try to reach, relative to *IT.
9414 Note that H has been subtracted in front of the if-statement. */
9415 int target_y
= it
->current_y
+ h
- dy
;
9416 int y0
= it3
.current_y
;
9420 RESTORE_IT (&it3
, &it3
, it3data
);
9421 y1
= line_bottom_y (&it3
);
9422 line_height
= y1
- y0
;
9423 RESTORE_IT (it
, it
, it2data
);
9424 /* If we did not reach target_y, try to move further backward if
9425 we can. If we moved too far backward, try to move forward. */
9426 if (target_y
< it
->current_y
9427 /* This is heuristic. In a window that's 3 lines high, with
9428 a line height of 13 pixels each, recentering with point
9429 on the bottom line will try to move -39/2 = 19 pixels
9430 backward. Try to avoid moving into the first line. */
9431 && (it
->current_y
- target_y
9432 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9433 && IT_CHARPOS (*it
) > BEGV
)
9435 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9436 target_y
- it
->current_y
));
9437 dy
= it
->current_y
- target_y
;
9438 goto move_further_back
;
9440 else if (target_y
>= it
->current_y
+ line_height
9441 && IT_CHARPOS (*it
) < ZV
)
9443 /* Should move forward by at least one line, maybe more.
9445 Note: Calling move_it_by_lines can be expensive on
9446 terminal frames, where compute_motion is used (via
9447 vmotion) to do the job, when there are very long lines
9448 and truncate-lines is nil. That's the reason for
9449 treating terminal frames specially here. */
9451 if (!FRAME_WINDOW_P (it
->f
))
9452 move_it_vertically (it
, target_y
- it
->current_y
);
9457 move_it_by_lines (it
, 1);
9459 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9466 /* Move IT by a specified amount of pixel lines DY. DY negative means
9467 move backwards. DY = 0 means move to start of screen line. At the
9468 end, IT will be on the start of a screen line. */
9471 move_it_vertically (struct it
*it
, int dy
)
9474 move_it_vertically_backward (it
, -dy
);
9477 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9478 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9479 MOVE_TO_POS
| MOVE_TO_Y
);
9480 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9482 /* If buffer ends in ZV without a newline, move to the start of
9483 the line to satisfy the post-condition. */
9484 if (IT_CHARPOS (*it
) == ZV
9486 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9487 move_it_by_lines (it
, 0);
9492 /* Move iterator IT past the end of the text line it is in. */
9495 move_it_past_eol (struct it
*it
)
9497 enum move_it_result rc
;
9499 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9500 if (rc
== MOVE_NEWLINE_OR_CR
)
9501 set_iterator_to_next (it
, false);
9505 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9506 negative means move up. DVPOS == 0 means move to the start of the
9509 Optimization idea: If we would know that IT->f doesn't use
9510 a face with proportional font, we could be faster for
9511 truncate-lines nil. */
9514 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9517 /* The commented-out optimization uses vmotion on terminals. This
9518 gives bad results, because elements like it->what, on which
9519 callers such as pos_visible_p rely, aren't updated. */
9520 /* struct position pos;
9521 if (!FRAME_WINDOW_P (it->f))
9523 struct text_pos textpos;
9525 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9526 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9527 reseat (it, textpos, true);
9528 it->vpos += pos.vpos;
9529 it->current_y += pos.vpos;
9535 /* DVPOS == 0 means move to the start of the screen line. */
9536 move_it_vertically_backward (it
, 0);
9537 /* Let next call to line_bottom_y calculate real line height. */
9542 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9543 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9545 /* Only move to the next buffer position if we ended up in a
9546 string from display property, not in an overlay string
9547 (before-string or after-string). That is because the
9548 latter don't conceal the underlying buffer position, so
9549 we can ask to move the iterator to the exact position we
9550 are interested in. Note that, even if we are already at
9551 IT_CHARPOS (*it), the call below is not a no-op, as it
9552 will detect that we are at the end of the string, pop the
9553 iterator, and compute it->current_x and it->hpos
9555 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9556 -1, -1, -1, MOVE_TO_POS
);
9562 void *it2data
= NULL
;
9563 ptrdiff_t start_charpos
, i
;
9565 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9566 bool hit_pos_limit
= false;
9567 ptrdiff_t pos_limit
;
9569 /* Start at the beginning of the screen line containing IT's
9570 position. This may actually move vertically backwards,
9571 in case of overlays, so adjust dvpos accordingly. */
9573 move_it_vertically_backward (it
, 0);
9576 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9577 screen lines, and reseat the iterator there. */
9578 start_charpos
= IT_CHARPOS (*it
);
9579 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9582 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9584 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9585 back_to_previous_visible_line_start (it
);
9586 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9587 hit_pos_limit
= true;
9588 reseat (it
, it
->current
.pos
, true);
9590 /* Move further back if we end up in a string or an image. */
9591 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9593 /* First try to move to start of display line. */
9595 move_it_vertically_backward (it
, 0);
9597 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9599 /* If start of line is still in string or image,
9600 move further back. */
9601 back_to_previous_visible_line_start (it
);
9602 reseat (it
, it
->current
.pos
, true);
9606 it
->current_x
= it
->hpos
= 0;
9608 /* Above call may have moved too far if continuation lines
9609 are involved. Scan forward and see if it did. */
9610 SAVE_IT (it2
, *it
, it2data
);
9611 it2
.vpos
= it2
.current_y
= 0;
9612 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9613 it
->vpos
-= it2
.vpos
;
9614 it
->current_y
-= it2
.current_y
;
9615 it
->current_x
= it
->hpos
= 0;
9617 /* If we moved too far back, move IT some lines forward. */
9618 if (it2
.vpos
> -dvpos
)
9620 int delta
= it2
.vpos
+ dvpos
;
9622 RESTORE_IT (&it2
, &it2
, it2data
);
9623 SAVE_IT (it2
, *it
, it2data
);
9624 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9625 /* Move back again if we got too far ahead. */
9626 if (IT_CHARPOS (*it
) >= start_charpos
)
9627 RESTORE_IT (it
, &it2
, it2data
);
9629 bidi_unshelve_cache (it2data
, true);
9631 else if (hit_pos_limit
&& pos_limit
> BEGV
9632 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9634 /* If we hit the limit, but still didn't make it far enough
9635 back, that means there's a display string with a newline
9636 covering a large chunk of text, and that caused
9637 back_to_previous_visible_line_start try to go too far.
9638 Punish those who commit such atrocities by going back
9639 until we've reached DVPOS, after lifting the limit, which
9640 could make it slow for very long lines. "If it hurts,
9643 RESTORE_IT (it
, it
, it2data
);
9644 for (i
= -dvpos
; i
> 0; --i
)
9646 back_to_previous_visible_line_start (it
);
9649 reseat_1 (it
, it
->current
.pos
, true);
9652 RESTORE_IT (it
, it
, it2data
);
9656 /* Return true if IT points into the middle of a display vector. */
9659 in_display_vector_p (struct it
*it
)
9661 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9662 && it
->current
.dpvec_index
> 0
9663 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9666 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9667 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9668 WINDOW must be a live window and defaults to the selected one. The
9669 return value is a cons of the maximum pixel-width of any text line and
9670 the maximum pixel-height of all text lines.
9672 The optional argument FROM, if non-nil, specifies the first text
9673 position and defaults to the minimum accessible position of the buffer.
9674 If FROM is t, use the minimum accessible position that is not a newline
9675 character. TO, if non-nil, specifies the last text position and
9676 defaults to the maximum accessible position of the buffer. If TO is t,
9677 use the maximum accessible position that is not a newline character.
9679 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9680 width that can be returned. X-LIMIT nil or omitted, means to use the
9681 pixel-width of WINDOW's body; use this if you do not intend to change
9682 the width of WINDOW. Use the maximum width WINDOW may assume if you
9683 intend to change WINDOW's width. In any case, text whose x-coordinate
9684 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9685 can take some time, it's always a good idea to make this argument as
9686 small as possible; in particular, if the buffer contains long lines that
9687 shall be truncated anyway.
9689 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9690 height that can be returned. Text lines whose y-coordinate is beyond
9691 Y-LIMIT are ignored. Since calculating the text height of a large
9692 buffer can take some time, it makes sense to specify this argument if
9693 the size of the buffer is unknown.
9695 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9696 include the height of the mode- or header-line of WINDOW in the return
9697 value. If it is either the symbol `mode-line' or `header-line', include
9698 only the height of that line, if present, in the return value. If t,
9699 include the height of both, if present, in the return value. */)
9700 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9701 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9703 struct window
*w
= decode_live_window (window
);
9704 Lisp_Object buffer
= w
->contents
;
9707 struct buffer
*old_b
= NULL
;
9708 ptrdiff_t start
, end
, pos
;
9709 struct text_pos startp
;
9710 void *itdata
= NULL
;
9711 int c
, max_y
= -1, x
= 0, y
= 0;
9713 CHECK_BUFFER (buffer
);
9714 b
= XBUFFER (buffer
);
9716 if (b
!= current_buffer
)
9718 old_b
= current_buffer
;
9719 set_buffer_internal (b
);
9724 else if (EQ (from
, Qt
))
9727 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9728 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9730 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9735 CHECK_NUMBER_COERCE_MARKER (from
);
9736 start
= min (max (XINT (from
), BEGV
), ZV
);
9741 else if (EQ (to
, Qt
))
9744 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9745 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9747 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9752 CHECK_NUMBER_COERCE_MARKER (to
);
9753 end
= max (start
, min (XINT (to
), ZV
));
9756 if (!NILP (y_limit
))
9758 CHECK_NUMBER (y_limit
);
9759 max_y
= min (XINT (y_limit
), INT_MAX
);
9762 itdata
= bidi_shelve_cache ();
9763 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9764 start_display (&it
, w
, startp
);
9767 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9770 CHECK_NUMBER (x_limit
);
9771 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9772 /* Actually, we never want move_it_to stop at to_x. But to make
9773 sure that move_it_in_display_line_to always moves far enough,
9774 we set it to INT_MAX and specify MOVE_TO_X. */
9775 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9776 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9779 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9781 if (!EQ (mode_and_header_line
, Qheader_line
)
9782 && !EQ (mode_and_header_line
, Qt
))
9783 /* Do not count the header-line which was counted automatically by
9785 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9787 if (EQ (mode_and_header_line
, Qmode_line
)
9788 || EQ (mode_and_header_line
, Qt
))
9789 /* Do count the mode-line which is not included automatically by
9791 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9793 bidi_unshelve_cache (itdata
, false);
9796 set_buffer_internal (old_b
);
9798 return Fcons (make_number (x
), make_number (y
));
9801 /***********************************************************************
9803 ***********************************************************************/
9805 /* Return the number of arguments the format string FORMAT needs. */
9808 format_nargs (char const *format
)
9810 ptrdiff_t nargs
= 0;
9811 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9819 /* Add a message with format string FORMAT and formatted arguments
9823 add_to_log (const char *format
, ...)
9826 va_start (ap
, format
);
9827 vadd_to_log (format
, ap
);
9832 vadd_to_log (char const *format
, va_list ap
)
9834 ptrdiff_t form_nargs
= format_nargs (format
);
9835 ptrdiff_t nargs
= 1 + form_nargs
;
9836 Lisp_Object args
[10];
9837 eassert (nargs
<= ARRAYELTS (args
));
9838 AUTO_STRING (args0
, format
);
9840 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9841 args
[i
] = va_arg (ap
, Lisp_Object
);
9842 Lisp_Object msg
= Qnil
;
9843 msg
= Fformat_message (nargs
, args
);
9845 ptrdiff_t len
= SBYTES (msg
) + 1;
9847 char *buffer
= SAFE_ALLOCA (len
);
9848 memcpy (buffer
, SDATA (msg
), len
);
9850 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9855 /* Output a newline in the *Messages* buffer if "needs" one. */
9858 message_log_maybe_newline (void)
9860 if (message_log_need_newline
)
9861 message_dolog ("", 0, true, false);
9865 /* Add a string M of length NBYTES to the message log, optionally
9866 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9867 true, means interpret the contents of M as multibyte. This
9868 function calls low-level routines in order to bypass text property
9869 hooks, etc. which might not be safe to run.
9871 This may GC (insert may run before/after change hooks),
9872 so the buffer M must NOT point to a Lisp string. */
9875 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9877 const unsigned char *msg
= (const unsigned char *) m
;
9879 if (!NILP (Vmemory_full
))
9882 if (!NILP (Vmessage_log_max
))
9884 struct buffer
*oldbuf
;
9885 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9886 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9887 ptrdiff_t point_at_end
= 0;
9888 ptrdiff_t zv_at_end
= 0;
9889 Lisp_Object old_deactivate_mark
;
9891 old_deactivate_mark
= Vdeactivate_mark
;
9892 oldbuf
= current_buffer
;
9894 /* Ensure the Messages buffer exists, and switch to it.
9895 If we created it, set the major-mode. */
9896 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9897 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9899 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9900 call0 (intern ("messages-buffer-mode"));
9902 bset_undo_list (current_buffer
, Qt
);
9903 bset_cache_long_scans (current_buffer
, Qnil
);
9905 oldpoint
= message_dolog_marker1
;
9906 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9907 oldbegv
= message_dolog_marker2
;
9908 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9909 oldzv
= message_dolog_marker3
;
9910 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9918 BEGV_BYTE
= BEG_BYTE
;
9921 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9923 /* Insert the string--maybe converting multibyte to single byte
9924 or vice versa, so that all the text fits the buffer. */
9926 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9932 /* Convert a multibyte string to single-byte
9933 for the *Message* buffer. */
9934 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9936 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9937 work
[0] = CHAR_TO_BYTE8 (c
);
9938 insert_1_both (work
, 1, 1, true, false, false);
9941 else if (! multibyte
9942 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9946 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9947 /* Convert a single-byte string to multibyte
9948 for the *Message* buffer. */
9949 for (i
= 0; i
< nbytes
; i
++)
9952 MAKE_CHAR_MULTIBYTE (c
);
9953 char_bytes
= CHAR_STRING (c
, str
);
9954 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9958 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9959 true, false, false);
9963 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9966 insert_1_both ("\n", 1, 1, true, false, false);
9968 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
9970 this_bol_byte
= PT_BYTE
;
9972 /* See if this line duplicates the previous one.
9973 If so, combine duplicates. */
9976 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
9978 prev_bol_byte
= PT_BYTE
;
9980 dups
= message_log_check_duplicate (prev_bol_byte
,
9984 del_range_both (prev_bol
, prev_bol_byte
,
9985 this_bol
, this_bol_byte
, false);
9988 char dupstr
[sizeof " [ times]"
9989 + INT_STRLEN_BOUND (printmax_t
)];
9991 /* If you change this format, don't forget to also
9992 change message_log_check_duplicate. */
9993 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9994 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9995 insert_1_both (dupstr
, duplen
, duplen
,
10001 /* If we have more than the desired maximum number of lines
10002 in the *Messages* buffer now, delete the oldest ones.
10003 This is safe because we don't have undo in this buffer. */
10005 if (NATNUMP (Vmessage_log_max
))
10007 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10008 -XFASTINT (Vmessage_log_max
) - 1, false);
10009 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10012 BEGV
= marker_position (oldbegv
);
10013 BEGV_BYTE
= marker_byte_position (oldbegv
);
10022 ZV
= marker_position (oldzv
);
10023 ZV_BYTE
= marker_byte_position (oldzv
);
10027 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10029 /* We can't do Fgoto_char (oldpoint) because it will run some
10031 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10032 marker_byte_position (oldpoint
));
10034 unchain_marker (XMARKER (oldpoint
));
10035 unchain_marker (XMARKER (oldbegv
));
10036 unchain_marker (XMARKER (oldzv
));
10038 /* We called insert_1_both above with its 5th argument (PREPARE)
10039 false, which prevents insert_1_both from calling
10040 prepare_to_modify_buffer, which in turns prevents us from
10041 incrementing windows_or_buffers_changed even if *Messages* is
10042 shown in some window. So we must manually set
10043 windows_or_buffers_changed here to make up for that. */
10044 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10045 bset_redisplay (current_buffer
);
10047 set_buffer_internal (oldbuf
);
10049 message_log_need_newline
= !nlflag
;
10050 Vdeactivate_mark
= old_deactivate_mark
;
10055 /* We are at the end of the buffer after just having inserted a newline.
10056 (Note: We depend on the fact we won't be crossing the gap.)
10057 Check to see if the most recent message looks a lot like the previous one.
10058 Return 0 if different, 1 if the new one should just replace it, or a
10059 value N > 1 if we should also append " [N times]". */
10062 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10065 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10066 bool seen_dots
= false;
10067 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10068 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10070 for (i
= 0; i
< len
; i
++)
10072 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10074 if (p1
[i
] != p2
[i
])
10080 if (*p1
++ == ' ' && *p1
++ == '[')
10083 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10084 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10091 /* Display an echo area message M with a specified length of NBYTES
10092 bytes. The string may include null characters. If M is not a
10093 string, clear out any existing message, and let the mini-buffer
10096 This function cancels echoing. */
10099 message3 (Lisp_Object m
)
10101 clear_message (true, true);
10104 /* First flush out any partial line written with print. */
10105 message_log_maybe_newline ();
10108 ptrdiff_t nbytes
= SBYTES (m
);
10109 bool multibyte
= STRING_MULTIBYTE (m
);
10112 SAFE_ALLOCA_STRING (buffer
, m
);
10113 message_dolog (buffer
, nbytes
, true, multibyte
);
10116 if (! inhibit_message
)
10117 message3_nolog (m
);
10120 /* Log the message M to stderr. Log an empty line if M is not a string. */
10123 message_to_stderr (Lisp_Object m
)
10125 if (noninteractive_need_newline
)
10127 noninteractive_need_newline
= false;
10128 fputc ('\n', stderr
);
10132 Lisp_Object s
= ENCODE_SYSTEM (m
);
10133 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10135 if (!cursor_in_echo_area
)
10136 fputc ('\n', stderr
);
10140 /* The non-logging version of message3.
10141 This does not cancel echoing, because it is used for echoing.
10142 Perhaps we need to make a separate function for echoing
10143 and make this cancel echoing. */
10146 message3_nolog (Lisp_Object m
)
10148 struct frame
*sf
= SELECTED_FRAME ();
10150 if (FRAME_INITIAL_P (sf
))
10151 message_to_stderr (m
);
10152 /* Error messages get reported properly by cmd_error, so this must be just an
10153 informative message; if the frame hasn't really been initialized yet, just
10155 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10157 /* Get the frame containing the mini-buffer
10158 that the selected frame is using. */
10159 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10160 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10161 struct frame
*f
= XFRAME (frame
);
10163 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10164 Fmake_frame_visible (frame
);
10166 if (STRINGP (m
) && SCHARS (m
) > 0)
10169 if (minibuffer_auto_raise
)
10170 Fraise_frame (frame
);
10171 /* Assume we are not echoing.
10172 (If we are, echo_now will override this.) */
10173 echo_message_buffer
= Qnil
;
10176 clear_message (true, true);
10178 do_pending_window_change (false);
10179 echo_area_display (true);
10180 do_pending_window_change (false);
10181 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10182 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10187 /* Display a null-terminated echo area message M. If M is 0, clear
10188 out any existing message, and let the mini-buffer text show through.
10190 The buffer M must continue to exist until after the echo area gets
10191 cleared or some other message gets displayed there. Do not pass
10192 text that is stored in a Lisp string. Do not pass text in a buffer
10193 that was alloca'd. */
10196 message1 (const char *m
)
10198 message3 (m
? build_unibyte_string (m
) : Qnil
);
10202 /* The non-logging counterpart of message1. */
10205 message1_nolog (const char *m
)
10207 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10210 /* Display a message M which contains a single %s
10211 which gets replaced with STRING. */
10214 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10216 CHECK_STRING (string
);
10219 if (noninteractive
)
10220 need_message
= !!m
;
10221 else if (!INTERACTIVE
)
10222 need_message
= false;
10225 /* The frame whose minibuffer we're going to display the message on.
10226 It may be larger than the selected frame, so we need
10227 to use its buffer, not the selected frame's buffer. */
10228 Lisp_Object mini_window
;
10229 struct frame
*f
, *sf
= SELECTED_FRAME ();
10231 /* Get the frame containing the minibuffer
10232 that the selected frame is using. */
10233 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10234 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10236 /* Error messages get reported properly by cmd_error, so this must be
10237 just an informative message; if the frame hasn't really been
10238 initialized yet, just toss it. */
10239 need_message
= f
->glyphs_initialized_p
;
10244 AUTO_STRING (fmt
, m
);
10245 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10247 if (noninteractive
)
10248 message_to_stderr (msg
);
10254 message3_nolog (msg
);
10256 /* Print should start at the beginning of the message
10257 buffer next time. */
10258 message_buf_print
= false;
10264 /* Dump an informative message to the minibuf. If M is 0, clear out
10265 any existing message, and let the mini-buffer text show through.
10267 The message must be safe ASCII and the format must not contain ` or
10268 '. If your message and format do not fit into this category,
10269 convert your arguments to Lisp objects and use Fmessage instead. */
10271 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10272 vmessage (const char *m
, va_list ap
)
10274 if (noninteractive
)
10278 if (noninteractive_need_newline
)
10279 putc ('\n', stderr
);
10280 noninteractive_need_newline
= false;
10281 vfprintf (stderr
, m
, ap
);
10282 if (!cursor_in_echo_area
)
10283 fprintf (stderr
, "\n");
10287 else if (INTERACTIVE
)
10289 /* The frame whose mini-buffer we're going to display the message
10290 on. It may be larger than the selected frame, so we need to
10291 use its buffer, not the selected frame's buffer. */
10292 Lisp_Object mini_window
;
10293 struct frame
*f
, *sf
= SELECTED_FRAME ();
10295 /* Get the frame containing the mini-buffer
10296 that the selected frame is using. */
10297 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10298 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10300 /* Error messages get reported properly by cmd_error, so this must be
10301 just an informative message; if the frame hasn't really been
10302 initialized yet, just toss it. */
10303 if (f
->glyphs_initialized_p
)
10308 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10310 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10312 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10314 message3 (make_string (message_buf
, len
));
10320 /* Print should start at the beginning of the message
10321 buffer next time. */
10322 message_buf_print
= false;
10328 message (const char *m
, ...)
10337 /* Display the current message in the current mini-buffer. This is
10338 only called from error handlers in process.c, and is not time
10342 update_echo_area (void)
10344 if (!NILP (echo_area_buffer
[0]))
10346 Lisp_Object string
;
10347 string
= Fcurrent_message ();
10353 /* Make sure echo area buffers in `echo_buffers' are live.
10354 If they aren't, make new ones. */
10357 ensure_echo_area_buffers (void)
10361 for (i
= 0; i
< 2; ++i
)
10362 if (!BUFFERP (echo_buffer
[i
])
10363 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10366 Lisp_Object old_buffer
;
10369 old_buffer
= echo_buffer
[i
];
10370 echo_buffer
[i
] = Fget_buffer_create
10371 (make_formatted_string (name
, " *Echo Area %d*", i
));
10372 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10373 /* to force word wrap in echo area -
10374 it was decided to postpone this*/
10375 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10377 for (j
= 0; j
< 2; ++j
)
10378 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10379 echo_area_buffer
[j
] = echo_buffer
[i
];
10384 /* Call FN with args A1..A2 with either the current or last displayed
10385 echo_area_buffer as current buffer.
10387 WHICH zero means use the current message buffer
10388 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10389 from echo_buffer[] and clear it.
10391 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10392 suitable buffer from echo_buffer[] and clear it.
10394 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10395 that the current message becomes the last displayed one, make
10396 choose a suitable buffer for echo_area_buffer[0], and clear it.
10398 Value is what FN returns. */
10401 with_echo_area_buffer (struct window
*w
, int which
,
10402 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10403 ptrdiff_t a1
, Lisp_Object a2
)
10405 Lisp_Object buffer
;
10406 bool this_one
, the_other
, clear_buffer_p
, rc
;
10407 ptrdiff_t count
= SPECPDL_INDEX ();
10409 /* If buffers aren't live, make new ones. */
10410 ensure_echo_area_buffers ();
10412 clear_buffer_p
= false;
10415 this_one
= false, the_other
= true;
10416 else if (which
> 0)
10417 this_one
= true, the_other
= false;
10420 this_one
= false, the_other
= true;
10421 clear_buffer_p
= true;
10423 /* We need a fresh one in case the current echo buffer equals
10424 the one containing the last displayed echo area message. */
10425 if (!NILP (echo_area_buffer
[this_one
])
10426 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10427 echo_area_buffer
[this_one
] = Qnil
;
10430 /* Choose a suitable buffer from echo_buffer[] is we don't
10432 if (NILP (echo_area_buffer
[this_one
]))
10434 echo_area_buffer
[this_one
]
10435 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10436 ? echo_buffer
[the_other
]
10437 : echo_buffer
[this_one
]);
10438 clear_buffer_p
= true;
10441 buffer
= echo_area_buffer
[this_one
];
10443 /* Don't get confused by reusing the buffer used for echoing
10444 for a different purpose. */
10445 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10448 record_unwind_protect (unwind_with_echo_area_buffer
,
10449 with_echo_area_buffer_unwind_data (w
));
10451 /* Make the echo area buffer current. Note that for display
10452 purposes, it is not necessary that the displayed window's buffer
10453 == current_buffer, except for text property lookup. So, let's
10454 only set that buffer temporarily here without doing a full
10455 Fset_window_buffer. We must also change w->pointm, though,
10456 because otherwise an assertions in unshow_buffer fails, and Emacs
10458 set_buffer_internal_1 (XBUFFER (buffer
));
10461 wset_buffer (w
, buffer
);
10462 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10463 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10466 bset_undo_list (current_buffer
, Qt
);
10467 bset_read_only (current_buffer
, Qnil
);
10468 specbind (Qinhibit_read_only
, Qt
);
10469 specbind (Qinhibit_modification_hooks
, Qt
);
10471 if (clear_buffer_p
&& Z
> BEG
)
10472 del_range (BEG
, Z
);
10474 eassert (BEGV
>= BEG
);
10475 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10479 eassert (BEGV
>= BEG
);
10480 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10482 unbind_to (count
, Qnil
);
10487 /* Save state that should be preserved around the call to the function
10488 FN called in with_echo_area_buffer. */
10491 with_echo_area_buffer_unwind_data (struct window
*w
)
10494 Lisp_Object vector
, tmp
;
10496 /* Reduce consing by keeping one vector in
10497 Vwith_echo_area_save_vector. */
10498 vector
= Vwith_echo_area_save_vector
;
10499 Vwith_echo_area_save_vector
= Qnil
;
10502 vector
= Fmake_vector (make_number (11), Qnil
);
10504 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10505 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10506 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10510 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10511 ASET (vector
, i
, w
->contents
); ++i
;
10512 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10513 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10514 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10515 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10516 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10517 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10522 for (; i
< end
; ++i
)
10523 ASET (vector
, i
, Qnil
);
10526 eassert (i
== ASIZE (vector
));
10531 /* Restore global state from VECTOR which was created by
10532 with_echo_area_buffer_unwind_data. */
10535 unwind_with_echo_area_buffer (Lisp_Object vector
)
10537 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10538 Vdeactivate_mark
= AREF (vector
, 1);
10539 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10541 if (WINDOWP (AREF (vector
, 3)))
10544 Lisp_Object buffer
;
10546 w
= XWINDOW (AREF (vector
, 3));
10547 buffer
= AREF (vector
, 4);
10549 wset_buffer (w
, buffer
);
10550 set_marker_both (w
->pointm
, buffer
,
10551 XFASTINT (AREF (vector
, 5)),
10552 XFASTINT (AREF (vector
, 6)));
10553 set_marker_both (w
->old_pointm
, buffer
,
10554 XFASTINT (AREF (vector
, 7)),
10555 XFASTINT (AREF (vector
, 8)));
10556 set_marker_both (w
->start
, buffer
,
10557 XFASTINT (AREF (vector
, 9)),
10558 XFASTINT (AREF (vector
, 10)));
10561 Vwith_echo_area_save_vector
= vector
;
10565 /* Set up the echo area for use by print functions. MULTIBYTE_P
10566 means we will print multibyte. */
10569 setup_echo_area_for_printing (bool multibyte_p
)
10571 /* If we can't find an echo area any more, exit. */
10572 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10573 Fkill_emacs (Qnil
);
10575 ensure_echo_area_buffers ();
10577 if (!message_buf_print
)
10579 /* A message has been output since the last time we printed.
10580 Choose a fresh echo area buffer. */
10581 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10582 echo_area_buffer
[0] = echo_buffer
[1];
10584 echo_area_buffer
[0] = echo_buffer
[0];
10586 /* Switch to that buffer and clear it. */
10587 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10588 bset_truncate_lines (current_buffer
, Qnil
);
10592 ptrdiff_t count
= SPECPDL_INDEX ();
10593 specbind (Qinhibit_read_only
, Qt
);
10594 /* Note that undo recording is always disabled. */
10595 del_range (BEG
, Z
);
10596 unbind_to (count
, Qnil
);
10598 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10600 /* Set up the buffer for the multibyteness we need. */
10602 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10603 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10605 /* Raise the frame containing the echo area. */
10606 if (minibuffer_auto_raise
)
10608 struct frame
*sf
= SELECTED_FRAME ();
10609 Lisp_Object mini_window
;
10610 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10611 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10614 message_log_maybe_newline ();
10615 message_buf_print
= true;
10619 if (NILP (echo_area_buffer
[0]))
10621 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10622 echo_area_buffer
[0] = echo_buffer
[1];
10624 echo_area_buffer
[0] = echo_buffer
[0];
10627 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10629 /* Someone switched buffers between print requests. */
10630 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10631 bset_truncate_lines (current_buffer
, Qnil
);
10637 /* Display an echo area message in window W. Value is true if W's
10638 height is changed. If display_last_displayed_message_p,
10639 display the message that was last displayed, otherwise
10640 display the current message. */
10643 display_echo_area (struct window
*w
)
10645 bool no_message_p
, window_height_changed_p
;
10647 /* Temporarily disable garbage collections while displaying the echo
10648 area. This is done because a GC can print a message itself.
10649 That message would modify the echo area buffer's contents while a
10650 redisplay of the buffer is going on, and seriously confuse
10652 ptrdiff_t count
= inhibit_garbage_collection ();
10654 /* If there is no message, we must call display_echo_area_1
10655 nevertheless because it resizes the window. But we will have to
10656 reset the echo_area_buffer in question to nil at the end because
10657 with_echo_area_buffer will sets it to an empty buffer. */
10658 bool i
= display_last_displayed_message_p
;
10659 no_message_p
= NILP (echo_area_buffer
[i
]);
10661 window_height_changed_p
10662 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10663 display_echo_area_1
,
10664 (intptr_t) w
, Qnil
);
10667 echo_area_buffer
[i
] = Qnil
;
10669 unbind_to (count
, Qnil
);
10670 return window_height_changed_p
;
10674 /* Helper for display_echo_area. Display the current buffer which
10675 contains the current echo area message in window W, a mini-window,
10676 a pointer to which is passed in A1. A2..A4 are currently not used.
10677 Change the height of W so that all of the message is displayed.
10678 Value is true if height of W was changed. */
10681 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10684 struct window
*w
= (struct window
*) i1
;
10685 Lisp_Object window
;
10686 struct text_pos start
;
10688 /* We are about to enter redisplay without going through
10689 redisplay_internal, so we need to forget these faces by hand
10691 forget_escape_and_glyphless_faces ();
10693 /* Do this before displaying, so that we have a large enough glyph
10694 matrix for the display. If we can't get enough space for the
10695 whole text, display the last N lines. That works by setting w->start. */
10696 bool window_height_changed_p
= resize_mini_window (w
, false);
10698 /* Use the starting position chosen by resize_mini_window. */
10699 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10702 clear_glyph_matrix (w
->desired_matrix
);
10703 XSETWINDOW (window
, w
);
10704 try_window (window
, start
, 0);
10706 return window_height_changed_p
;
10710 /* Resize the echo area window to exactly the size needed for the
10711 currently displayed message, if there is one. If a mini-buffer
10712 is active, don't shrink it. */
10715 resize_echo_area_exactly (void)
10717 if (BUFFERP (echo_area_buffer
[0])
10718 && WINDOWP (echo_area_window
))
10720 struct window
*w
= XWINDOW (echo_area_window
);
10721 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10722 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10723 (intptr_t) w
, resize_exactly
);
10726 windows_or_buffers_changed
= 42;
10727 update_mode_lines
= 30;
10728 redisplay_internal ();
10734 /* Callback function for with_echo_area_buffer, when used from
10735 resize_echo_area_exactly. A1 contains a pointer to the window to
10736 resize, EXACTLY non-nil means resize the mini-window exactly to the
10737 size of the text displayed. A3 and A4 are not used. Value is what
10738 resize_mini_window returns. */
10741 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10744 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10748 /* Resize mini-window W to fit the size of its contents. EXACT_P
10749 means size the window exactly to the size needed. Otherwise, it's
10750 only enlarged until W's buffer is empty.
10752 Set W->start to the right place to begin display. If the whole
10753 contents fit, start at the beginning. Otherwise, start so as
10754 to make the end of the contents appear. This is particularly
10755 important for y-or-n-p, but seems desirable generally.
10757 Value is true if the window height has been changed. */
10760 resize_mini_window (struct window
*w
, bool exact_p
)
10762 struct frame
*f
= XFRAME (w
->frame
);
10763 bool window_height_changed_p
= false;
10765 eassert (MINI_WINDOW_P (w
));
10767 /* By default, start display at the beginning. */
10768 set_marker_both (w
->start
, w
->contents
,
10769 BUF_BEGV (XBUFFER (w
->contents
)),
10770 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10772 /* Don't resize windows while redisplaying a window; it would
10773 confuse redisplay functions when the size of the window they are
10774 displaying changes from under them. Such a resizing can happen,
10775 for instance, when which-func prints a long message while
10776 we are running fontification-functions. We're running these
10777 functions with safe_call which binds inhibit-redisplay to t. */
10778 if (!NILP (Vinhibit_redisplay
))
10781 /* Nil means don't try to resize. */
10782 if (NILP (Vresize_mini_windows
)
10783 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10786 if (!FRAME_MINIBUF_ONLY_P (f
))
10789 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10790 + WINDOW_PIXEL_HEIGHT (w
));
10791 int unit
= FRAME_LINE_HEIGHT (f
);
10792 int height
, max_height
;
10793 struct text_pos start
;
10794 struct buffer
*old_current_buffer
= NULL
;
10796 if (current_buffer
!= XBUFFER (w
->contents
))
10798 old_current_buffer
= current_buffer
;
10799 set_buffer_internal (XBUFFER (w
->contents
));
10802 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10804 /* Compute the max. number of lines specified by the user. */
10805 if (FLOATP (Vmax_mini_window_height
))
10806 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10807 else if (INTEGERP (Vmax_mini_window_height
))
10808 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10810 max_height
= total_height
/ 4;
10812 /* Correct that max. height if it's bogus. */
10813 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10815 /* Find out the height of the text in the window. */
10816 if (it
.line_wrap
== TRUNCATE
)
10821 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10822 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10823 height
= it
.current_y
+ last_height
;
10825 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10826 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10829 /* Compute a suitable window start. */
10830 if (height
> max_height
)
10832 height
= (max_height
/ unit
) * unit
;
10833 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10834 move_it_vertically_backward (&it
, height
- unit
);
10835 start
= it
.current
.pos
;
10838 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10839 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10841 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10843 /* Let it grow only, until we display an empty message, in which
10844 case the window shrinks again. */
10845 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10847 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10849 FRAME_WINDOWS_FROZEN (f
) = true;
10850 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10851 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10853 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10854 && (exact_p
|| BEGV
== ZV
))
10856 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10858 FRAME_WINDOWS_FROZEN (f
) = false;
10859 shrink_mini_window (w
, true);
10860 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10865 /* Always resize to exact size needed. */
10866 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10868 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10870 FRAME_WINDOWS_FROZEN (f
) = true;
10871 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10872 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10874 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10876 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10878 FRAME_WINDOWS_FROZEN (f
) = false;
10879 shrink_mini_window (w
, true);
10883 FRAME_WINDOWS_FROZEN (f
) = true;
10884 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10887 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10891 if (old_current_buffer
)
10892 set_buffer_internal (old_current_buffer
);
10895 return window_height_changed_p
;
10899 /* Value is the current message, a string, or nil if there is no
10900 current message. */
10903 current_message (void)
10907 if (!BUFFERP (echo_area_buffer
[0]))
10911 with_echo_area_buffer (0, 0, current_message_1
,
10912 (intptr_t) &msg
, Qnil
);
10914 echo_area_buffer
[0] = Qnil
;
10922 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10925 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10928 *msg
= make_buffer_string (BEG
, Z
, true);
10935 /* Push the current message on Vmessage_stack for later restoration
10936 by restore_message. Value is true if the current message isn't
10937 empty. This is a relatively infrequent operation, so it's not
10938 worth optimizing. */
10941 push_message (void)
10943 Lisp_Object msg
= current_message ();
10944 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10945 return STRINGP (msg
);
10949 /* Restore message display from the top of Vmessage_stack. */
10952 restore_message (void)
10954 eassert (CONSP (Vmessage_stack
));
10955 message3_nolog (XCAR (Vmessage_stack
));
10959 /* Handler for unwind-protect calling pop_message. */
10962 pop_message_unwind (void)
10964 /* Pop the top-most entry off Vmessage_stack. */
10965 eassert (CONSP (Vmessage_stack
));
10966 Vmessage_stack
= XCDR (Vmessage_stack
);
10970 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10971 exits. If the stack is not empty, we have a missing pop_message
10975 check_message_stack (void)
10977 if (!NILP (Vmessage_stack
))
10982 /* Truncate to NCHARS what will be displayed in the echo area the next
10983 time we display it---but don't redisplay it now. */
10986 truncate_echo_area (ptrdiff_t nchars
)
10989 echo_area_buffer
[0] = Qnil
;
10990 else if (!noninteractive
10992 && !NILP (echo_area_buffer
[0]))
10994 struct frame
*sf
= SELECTED_FRAME ();
10995 /* Error messages get reported properly by cmd_error, so this must be
10996 just an informative message; if the frame hasn't really been
10997 initialized yet, just toss it. */
10998 if (sf
->glyphs_initialized_p
)
10999 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11004 /* Helper function for truncate_echo_area. Truncate the current
11005 message to at most NCHARS characters. */
11008 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11010 if (BEG
+ nchars
< Z
)
11011 del_range (BEG
+ nchars
, Z
);
11013 echo_area_buffer
[0] = Qnil
;
11017 /* Set the current message to STRING. */
11020 set_message (Lisp_Object string
)
11022 eassert (STRINGP (string
));
11024 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11026 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11027 message_buf_print
= false;
11028 help_echo_showing_p
= false;
11030 if (STRINGP (Vdebug_on_message
)
11031 && STRINGP (string
)
11032 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11033 call_debugger (list2 (Qerror
, string
));
11037 /* Helper function for set_message. First argument is ignored and second
11038 argument has the same meaning as for set_message.
11039 This function is called with the echo area buffer being current. */
11042 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11044 eassert (STRINGP (string
));
11046 /* Change multibyteness of the echo buffer appropriately. */
11047 if (message_enable_multibyte
11048 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11049 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11051 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11052 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11053 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11055 /* Insert new message at BEG. */
11056 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11058 /* This function takes care of single/multibyte conversion.
11059 We just have to ensure that the echo area buffer has the right
11060 setting of enable_multibyte_characters. */
11061 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11067 /* Clear messages. CURRENT_P means clear the current message.
11068 LAST_DISPLAYED_P means clear the message last displayed. */
11071 clear_message (bool current_p
, bool last_displayed_p
)
11075 echo_area_buffer
[0] = Qnil
;
11076 message_cleared_p
= true;
11079 if (last_displayed_p
)
11080 echo_area_buffer
[1] = Qnil
;
11082 message_buf_print
= false;
11085 /* Clear garbaged frames.
11087 This function is used where the old redisplay called
11088 redraw_garbaged_frames which in turn called redraw_frame which in
11089 turn called clear_frame. The call to clear_frame was a source of
11090 flickering. I believe a clear_frame is not necessary. It should
11091 suffice in the new redisplay to invalidate all current matrices,
11092 and ensure a complete redisplay of all windows. */
11095 clear_garbaged_frames (void)
11097 if (frame_garbaged
)
11099 Lisp_Object tail
, frame
;
11101 FOR_EACH_FRAME (tail
, frame
)
11103 struct frame
*f
= XFRAME (frame
);
11105 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11110 clear_current_matrices (f
);
11111 fset_redisplay (f
);
11112 f
->garbaged
= false;
11113 f
->resized_p
= false;
11117 frame_garbaged
= false;
11122 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11126 echo_area_display (bool update_frame_p
)
11128 Lisp_Object mini_window
;
11131 bool window_height_changed_p
= false;
11132 struct frame
*sf
= SELECTED_FRAME ();
11134 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11135 w
= XWINDOW (mini_window
);
11136 f
= XFRAME (WINDOW_FRAME (w
));
11138 /* Don't display if frame is invisible or not yet initialized. */
11139 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11142 #ifdef HAVE_WINDOW_SYSTEM
11143 /* When Emacs starts, selected_frame may be the initial terminal
11144 frame. If we let this through, a message would be displayed on
11146 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11148 #endif /* HAVE_WINDOW_SYSTEM */
11150 /* Redraw garbaged frames. */
11151 clear_garbaged_frames ();
11153 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11155 echo_area_window
= mini_window
;
11156 window_height_changed_p
= display_echo_area (w
);
11157 w
->must_be_updated_p
= true;
11159 /* Update the display, unless called from redisplay_internal.
11160 Also don't update the screen during redisplay itself. The
11161 update will happen at the end of redisplay, and an update
11162 here could cause confusion. */
11163 if (update_frame_p
&& !redisplaying_p
)
11167 /* If the display update has been interrupted by pending
11168 input, update mode lines in the frame. Due to the
11169 pending input, it might have been that redisplay hasn't
11170 been called, so that mode lines above the echo area are
11171 garbaged. This looks odd, so we prevent it here. */
11172 if (!display_completed
)
11173 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11175 if (window_height_changed_p
11176 /* Don't do this if Emacs is shutting down. Redisplay
11177 needs to run hooks. */
11178 && !NILP (Vrun_hooks
))
11180 /* Must update other windows. Likewise as in other
11181 cases, don't let this update be interrupted by
11183 ptrdiff_t count
= SPECPDL_INDEX ();
11184 specbind (Qredisplay_dont_pause
, Qt
);
11185 fset_redisplay (f
);
11186 redisplay_internal ();
11187 unbind_to (count
, Qnil
);
11189 else if (FRAME_WINDOW_P (f
) && n
== 0)
11191 /* Window configuration is the same as before.
11192 Can do with a display update of the echo area,
11193 unless we displayed some mode lines. */
11194 update_single_window (w
);
11198 update_frame (f
, true, true);
11200 /* If cursor is in the echo area, make sure that the next
11201 redisplay displays the minibuffer, so that the cursor will
11202 be replaced with what the minibuffer wants. */
11203 if (cursor_in_echo_area
)
11204 wset_redisplay (XWINDOW (mini_window
));
11207 else if (!EQ (mini_window
, selected_window
))
11208 wset_redisplay (XWINDOW (mini_window
));
11210 /* Last displayed message is now the current message. */
11211 echo_area_buffer
[1] = echo_area_buffer
[0];
11212 /* Inform read_char that we're not echoing. */
11213 echo_message_buffer
= Qnil
;
11215 /* Prevent redisplay optimization in redisplay_internal by resetting
11216 this_line_start_pos. This is done because the mini-buffer now
11217 displays the message instead of its buffer text. */
11218 if (EQ (mini_window
, selected_window
))
11219 CHARPOS (this_line_start_pos
) = 0;
11221 if (window_height_changed_p
)
11223 fset_redisplay (f
);
11225 /* If window configuration was changed, frames may have been
11226 marked garbaged. Clear them or we will experience
11227 surprises wrt scrolling.
11228 FIXME: How/why/when? */
11229 clear_garbaged_frames ();
11233 /* True if W's buffer was changed but not saved. */
11236 window_buffer_changed (struct window
*w
)
11238 struct buffer
*b
= XBUFFER (w
->contents
);
11240 eassert (BUFFER_LIVE_P (b
));
11242 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11245 /* True if W has %c in its mode line and mode line should be updated. */
11248 mode_line_update_needed (struct window
*w
)
11250 return (w
->column_number_displayed
!= -1
11251 && !(PT
== w
->last_point
&& !window_outdated (w
))
11252 && (w
->column_number_displayed
!= current_column ()));
11255 /* True if window start of W is frozen and may not be changed during
11259 window_frozen_p (struct window
*w
)
11261 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11263 Lisp_Object window
;
11265 XSETWINDOW (window
, w
);
11266 if (MINI_WINDOW_P (w
))
11268 else if (EQ (window
, selected_window
))
11270 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11271 && EQ (window
, Vminibuf_scroll_window
))
11272 /* This special window can't be frozen too. */
11280 /***********************************************************************
11281 Mode Lines and Frame Titles
11282 ***********************************************************************/
11284 /* A buffer for constructing non-propertized mode-line strings and
11285 frame titles in it; allocated from the heap in init_xdisp and
11286 resized as needed in store_mode_line_noprop_char. */
11288 static char *mode_line_noprop_buf
;
11290 /* The buffer's end, and a current output position in it. */
11292 static char *mode_line_noprop_buf_end
;
11293 static char *mode_line_noprop_ptr
;
11295 #define MODE_LINE_NOPROP_LEN(start) \
11296 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11299 MODE_LINE_DISPLAY
= 0,
11303 } mode_line_target
;
11305 /* Alist that caches the results of :propertize.
11306 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11307 static Lisp_Object mode_line_proptrans_alist
;
11309 /* List of strings making up the mode-line. */
11310 static Lisp_Object mode_line_string_list
;
11312 /* Base face property when building propertized mode line string. */
11313 static Lisp_Object mode_line_string_face
;
11314 static Lisp_Object mode_line_string_face_prop
;
11317 /* Unwind data for mode line strings */
11319 static Lisp_Object Vmode_line_unwind_vector
;
11322 format_mode_line_unwind_data (struct frame
*target_frame
,
11323 struct buffer
*obuf
,
11325 bool save_proptrans
)
11327 Lisp_Object vector
, tmp
;
11329 /* Reduce consing by keeping one vector in
11330 Vwith_echo_area_save_vector. */
11331 vector
= Vmode_line_unwind_vector
;
11332 Vmode_line_unwind_vector
= Qnil
;
11335 vector
= Fmake_vector (make_number (10), Qnil
);
11337 ASET (vector
, 0, make_number (mode_line_target
));
11338 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11339 ASET (vector
, 2, mode_line_string_list
);
11340 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11341 ASET (vector
, 4, mode_line_string_face
);
11342 ASET (vector
, 5, mode_line_string_face_prop
);
11345 XSETBUFFER (tmp
, obuf
);
11348 ASET (vector
, 6, tmp
);
11349 ASET (vector
, 7, owin
);
11352 /* Similarly to `with-selected-window', if the operation selects
11353 a window on another frame, we must restore that frame's
11354 selected window, and (for a tty) the top-frame. */
11355 ASET (vector
, 8, target_frame
->selected_window
);
11356 if (FRAME_TERMCAP_P (target_frame
))
11357 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11364 unwind_format_mode_line (Lisp_Object vector
)
11366 Lisp_Object old_window
= AREF (vector
, 7);
11367 Lisp_Object target_frame_window
= AREF (vector
, 8);
11368 Lisp_Object old_top_frame
= AREF (vector
, 9);
11370 mode_line_target
= XINT (AREF (vector
, 0));
11371 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11372 mode_line_string_list
= AREF (vector
, 2);
11373 if (! EQ (AREF (vector
, 3), Qt
))
11374 mode_line_proptrans_alist
= AREF (vector
, 3);
11375 mode_line_string_face
= AREF (vector
, 4);
11376 mode_line_string_face_prop
= AREF (vector
, 5);
11378 /* Select window before buffer, since it may change the buffer. */
11379 if (!NILP (old_window
))
11381 /* If the operation that we are unwinding had selected a window
11382 on a different frame, reset its frame-selected-window. For a
11383 text terminal, reset its top-frame if necessary. */
11384 if (!NILP (target_frame_window
))
11387 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11389 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11390 Fselect_window (target_frame_window
, Qt
);
11392 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11393 Fselect_frame (old_top_frame
, Qt
);
11396 Fselect_window (old_window
, Qt
);
11399 if (!NILP (AREF (vector
, 6)))
11401 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11402 ASET (vector
, 6, Qnil
);
11405 Vmode_line_unwind_vector
= vector
;
11409 /* Store a single character C for the frame title in mode_line_noprop_buf.
11410 Re-allocate mode_line_noprop_buf if necessary. */
11413 store_mode_line_noprop_char (char c
)
11415 /* If output position has reached the end of the allocated buffer,
11416 increase the buffer's size. */
11417 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11419 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11420 ptrdiff_t size
= len
;
11421 mode_line_noprop_buf
=
11422 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11423 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11424 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11427 *mode_line_noprop_ptr
++ = c
;
11431 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11432 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11433 characters that yield more columns than PRECISION; PRECISION <= 0
11434 means copy the whole string. Pad with spaces until FIELD_WIDTH
11435 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11436 pad. Called from display_mode_element when it is used to build a
11440 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11442 const unsigned char *str
= (const unsigned char *) string
;
11444 ptrdiff_t dummy
, nbytes
;
11446 /* Copy at most PRECISION chars from STR. */
11447 nbytes
= strlen (string
);
11448 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11450 store_mode_line_noprop_char (*str
++);
11452 /* Fill up with spaces until FIELD_WIDTH reached. */
11453 while (field_width
> 0
11454 && n
< field_width
)
11456 store_mode_line_noprop_char (' ');
11463 /***********************************************************************
11465 ***********************************************************************/
11467 #ifdef HAVE_WINDOW_SYSTEM
11469 /* Set the title of FRAME, if it has changed. The title format is
11470 Vicon_title_format if FRAME is iconified, otherwise it is
11471 frame_title_format. */
11474 x_consider_frame_title (Lisp_Object frame
)
11476 struct frame
*f
= XFRAME (frame
);
11478 if (FRAME_WINDOW_P (f
)
11479 || FRAME_MINIBUF_ONLY_P (f
)
11480 || f
->explicit_name
)
11482 /* Do we have more than one visible frame on this X display? */
11483 Lisp_Object tail
, other_frame
, fmt
;
11484 ptrdiff_t title_start
;
11488 ptrdiff_t count
= SPECPDL_INDEX ();
11490 FOR_EACH_FRAME (tail
, other_frame
)
11492 struct frame
*tf
= XFRAME (other_frame
);
11495 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11496 && !FRAME_MINIBUF_ONLY_P (tf
)
11497 && !EQ (other_frame
, tip_frame
)
11498 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11502 /* Set global variable indicating that multiple frames exist. */
11503 multiple_frames
= CONSP (tail
);
11505 /* Switch to the buffer of selected window of the frame. Set up
11506 mode_line_target so that display_mode_element will output into
11507 mode_line_noprop_buf; then display the title. */
11508 record_unwind_protect (unwind_format_mode_line
,
11509 format_mode_line_unwind_data
11510 (f
, current_buffer
, selected_window
, false));
11512 Fselect_window (f
->selected_window
, Qt
);
11513 set_buffer_internal_1
11514 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11515 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11517 mode_line_target
= MODE_LINE_TITLE
;
11518 title_start
= MODE_LINE_NOPROP_LEN (0);
11519 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11520 NULL
, DEFAULT_FACE_ID
);
11521 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11522 len
= MODE_LINE_NOPROP_LEN (title_start
);
11523 title
= mode_line_noprop_buf
+ title_start
;
11524 unbind_to (count
, Qnil
);
11526 /* Set the title only if it's changed. This avoids consing in
11527 the common case where it hasn't. (If it turns out that we've
11528 already wasted too much time by walking through the list with
11529 display_mode_element, then we might need to optimize at a
11530 higher level than this.) */
11531 if (! STRINGP (f
->name
)
11532 || SBYTES (f
->name
) != len
11533 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11534 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11538 #endif /* not HAVE_WINDOW_SYSTEM */
11541 /***********************************************************************
11543 ***********************************************************************/
11545 /* True if we will not redisplay all visible windows. */
11546 #define REDISPLAY_SOME_P() \
11547 ((windows_or_buffers_changed == 0 \
11548 || windows_or_buffers_changed == REDISPLAY_SOME) \
11549 && (update_mode_lines == 0 \
11550 || update_mode_lines == REDISPLAY_SOME))
11552 /* Prepare for redisplay by updating menu-bar item lists when
11553 appropriate. This can call eval. */
11556 prepare_menu_bars (void)
11558 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11559 bool some_windows
= REDISPLAY_SOME_P ();
11560 Lisp_Object tooltip_frame
;
11562 #ifdef HAVE_WINDOW_SYSTEM
11563 tooltip_frame
= tip_frame
;
11565 tooltip_frame
= Qnil
;
11568 if (FUNCTIONP (Vpre_redisplay_function
))
11570 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11571 if (all_windows
&& some_windows
)
11573 Lisp_Object ws
= window_list ();
11574 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11576 Lisp_Object
this = XCAR (ws
);
11577 struct window
*w
= XWINDOW (this);
11579 || XFRAME (w
->frame
)->redisplay
11580 || XBUFFER (w
->contents
)->text
->redisplay
)
11582 windows
= Fcons (this, windows
);
11586 safe__call1 (true, Vpre_redisplay_function
, windows
);
11589 /* Update all frame titles based on their buffer names, etc. We do
11590 this before the menu bars so that the buffer-menu will show the
11591 up-to-date frame titles. */
11592 #ifdef HAVE_WINDOW_SYSTEM
11595 Lisp_Object tail
, frame
;
11597 FOR_EACH_FRAME (tail
, frame
)
11599 struct frame
*f
= XFRAME (frame
);
11600 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11604 && !XBUFFER (w
->contents
)->text
->redisplay
)
11607 if (!EQ (frame
, tooltip_frame
)
11608 && (FRAME_ICONIFIED_P (f
)
11609 || FRAME_VISIBLE_P (f
) == 1
11610 /* Exclude TTY frames that are obscured because they
11611 are not the top frame on their console. This is
11612 because x_consider_frame_title actually switches
11613 to the frame, which for TTY frames means it is
11614 marked as garbaged, and will be completely
11615 redrawn on the next redisplay cycle. This causes
11616 TTY frames to be completely redrawn, when there
11617 are more than one of them, even though nothing
11618 should be changed on display. */
11619 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11620 x_consider_frame_title (frame
);
11623 #endif /* HAVE_WINDOW_SYSTEM */
11625 /* Update the menu bar item lists, if appropriate. This has to be
11626 done before any actual redisplay or generation of display lines. */
11630 Lisp_Object tail
, frame
;
11631 ptrdiff_t count
= SPECPDL_INDEX ();
11632 /* True means that update_menu_bar has run its hooks
11633 so any further calls to update_menu_bar shouldn't do so again. */
11634 bool menu_bar_hooks_run
= false;
11636 record_unwind_save_match_data ();
11638 FOR_EACH_FRAME (tail
, frame
)
11640 struct frame
*f
= XFRAME (frame
);
11641 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11643 /* Ignore tooltip frame. */
11644 if (EQ (frame
, tooltip_frame
))
11650 && !XBUFFER (w
->contents
)->text
->redisplay
)
11653 /* If a window on this frame changed size, report that to
11654 the user and clear the size-change flag. */
11655 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11657 Lisp_Object functions
;
11659 /* Clear flag first in case we get an error below. */
11660 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11661 functions
= Vwindow_size_change_functions
;
11663 while (CONSP (functions
))
11665 if (!EQ (XCAR (functions
), Qt
))
11666 call1 (XCAR (functions
), frame
);
11667 functions
= XCDR (functions
);
11671 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11672 #ifdef HAVE_WINDOW_SYSTEM
11673 update_tool_bar (f
, false);
11677 unbind_to (count
, Qnil
);
11681 struct frame
*sf
= SELECTED_FRAME ();
11682 update_menu_bar (sf
, true, false);
11683 #ifdef HAVE_WINDOW_SYSTEM
11684 update_tool_bar (sf
, true);
11690 /* Update the menu bar item list for frame F. This has to be done
11691 before we start to fill in any display lines, because it can call
11694 If SAVE_MATCH_DATA, we must save and restore it here.
11696 If HOOKS_RUN, a previous call to update_menu_bar
11697 already ran the menu bar hooks for this redisplay, so there
11698 is no need to run them again. The return value is the
11699 updated value of this flag, to pass to the next call. */
11702 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11704 Lisp_Object window
;
11707 /* If called recursively during a menu update, do nothing. This can
11708 happen when, for instance, an activate-menubar-hook causes a
11710 if (inhibit_menubar_update
)
11713 window
= FRAME_SELECTED_WINDOW (f
);
11714 w
= XWINDOW (window
);
11716 if (FRAME_WINDOW_P (f
)
11718 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11719 || defined (HAVE_NS) || defined (USE_GTK)
11720 FRAME_EXTERNAL_MENU_BAR (f
)
11722 FRAME_MENU_BAR_LINES (f
) > 0
11724 : FRAME_MENU_BAR_LINES (f
) > 0)
11726 /* If the user has switched buffers or windows, we need to
11727 recompute to reflect the new bindings. But we'll
11728 recompute when update_mode_lines is set too; that means
11729 that people can use force-mode-line-update to request
11730 that the menu bar be recomputed. The adverse effect on
11731 the rest of the redisplay algorithm is about the same as
11732 windows_or_buffers_changed anyway. */
11733 if (windows_or_buffers_changed
11734 /* This used to test w->update_mode_line, but we believe
11735 there is no need to recompute the menu in that case. */
11736 || update_mode_lines
11737 || window_buffer_changed (w
))
11739 struct buffer
*prev
= current_buffer
;
11740 ptrdiff_t count
= SPECPDL_INDEX ();
11742 specbind (Qinhibit_menubar_update
, Qt
);
11744 set_buffer_internal_1 (XBUFFER (w
->contents
));
11745 if (save_match_data
)
11746 record_unwind_save_match_data ();
11747 if (NILP (Voverriding_local_map_menu_flag
))
11749 specbind (Qoverriding_terminal_local_map
, Qnil
);
11750 specbind (Qoverriding_local_map
, Qnil
);
11755 /* Run the Lucid hook. */
11756 safe_run_hooks (Qactivate_menubar_hook
);
11758 /* If it has changed current-menubar from previous value,
11759 really recompute the menu-bar from the value. */
11760 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11761 call0 (Qrecompute_lucid_menubar
);
11763 safe_run_hooks (Qmenu_bar_update_hook
);
11768 XSETFRAME (Vmenu_updating_frame
, f
);
11769 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11771 /* Redisplay the menu bar in case we changed it. */
11772 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11773 || defined (HAVE_NS) || defined (USE_GTK)
11774 if (FRAME_WINDOW_P (f
))
11776 #if defined (HAVE_NS)
11777 /* All frames on Mac OS share the same menubar. So only
11778 the selected frame should be allowed to set it. */
11779 if (f
== SELECTED_FRAME ())
11781 set_frame_menubar (f
, false, false);
11784 /* On a terminal screen, the menu bar is an ordinary screen
11785 line, and this makes it get updated. */
11786 w
->update_mode_line
= true;
11787 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11788 /* In the non-toolkit version, the menu bar is an ordinary screen
11789 line, and this makes it get updated. */
11790 w
->update_mode_line
= true;
11791 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11793 unbind_to (count
, Qnil
);
11794 set_buffer_internal_1 (prev
);
11801 /***********************************************************************
11803 ***********************************************************************/
11805 #ifdef HAVE_WINDOW_SYSTEM
11807 /* Select `frame' temporarily without running all the code in
11809 FIXME: Maybe do_switch_frame should be trimmed down similarly
11810 when `norecord' is set. */
11812 fast_set_selected_frame (Lisp_Object frame
)
11814 if (!EQ (selected_frame
, frame
))
11816 selected_frame
= frame
;
11817 selected_window
= XFRAME (frame
)->selected_window
;
11821 /* Update the tool-bar item list for frame F. This has to be done
11822 before we start to fill in any display lines. Called from
11823 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11824 and restore it here. */
11827 update_tool_bar (struct frame
*f
, bool save_match_data
)
11829 #if defined (USE_GTK) || defined (HAVE_NS)
11830 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11832 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11833 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11838 Lisp_Object window
;
11841 window
= FRAME_SELECTED_WINDOW (f
);
11842 w
= XWINDOW (window
);
11844 /* If the user has switched buffers or windows, we need to
11845 recompute to reflect the new bindings. But we'll
11846 recompute when update_mode_lines is set too; that means
11847 that people can use force-mode-line-update to request
11848 that the menu bar be recomputed. The adverse effect on
11849 the rest of the redisplay algorithm is about the same as
11850 windows_or_buffers_changed anyway. */
11851 if (windows_or_buffers_changed
11852 || w
->update_mode_line
11853 || update_mode_lines
11854 || window_buffer_changed (w
))
11856 struct buffer
*prev
= current_buffer
;
11857 ptrdiff_t count
= SPECPDL_INDEX ();
11858 Lisp_Object frame
, new_tool_bar
;
11859 int new_n_tool_bar
;
11861 /* Set current_buffer to the buffer of the selected
11862 window of the frame, so that we get the right local
11864 set_buffer_internal_1 (XBUFFER (w
->contents
));
11866 /* Save match data, if we must. */
11867 if (save_match_data
)
11868 record_unwind_save_match_data ();
11870 /* Make sure that we don't accidentally use bogus keymaps. */
11871 if (NILP (Voverriding_local_map_menu_flag
))
11873 specbind (Qoverriding_terminal_local_map
, Qnil
);
11874 specbind (Qoverriding_local_map
, Qnil
);
11877 /* We must temporarily set the selected frame to this frame
11878 before calling tool_bar_items, because the calculation of
11879 the tool-bar keymap uses the selected frame (see
11880 `tool-bar-make-keymap' in tool-bar.el). */
11881 eassert (EQ (selected_window
,
11882 /* Since we only explicitly preserve selected_frame,
11883 check that selected_window would be redundant. */
11884 XFRAME (selected_frame
)->selected_window
));
11885 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11886 XSETFRAME (frame
, f
);
11887 fast_set_selected_frame (frame
);
11889 /* Build desired tool-bar items from keymaps. */
11891 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11894 /* Redisplay the tool-bar if we changed it. */
11895 if (new_n_tool_bar
!= f
->n_tool_bar_items
11896 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11898 /* Redisplay that happens asynchronously due to an expose event
11899 may access f->tool_bar_items. Make sure we update both
11900 variables within BLOCK_INPUT so no such event interrupts. */
11902 fset_tool_bar_items (f
, new_tool_bar
);
11903 f
->n_tool_bar_items
= new_n_tool_bar
;
11904 w
->update_mode_line
= true;
11908 unbind_to (count
, Qnil
);
11909 set_buffer_internal_1 (prev
);
11914 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11916 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11917 F's desired tool-bar contents. F->tool_bar_items must have
11918 been set up previously by calling prepare_menu_bars. */
11921 build_desired_tool_bar_string (struct frame
*f
)
11923 int i
, size
, size_needed
;
11924 Lisp_Object image
, plist
;
11926 image
= plist
= Qnil
;
11928 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11929 Otherwise, make a new string. */
11931 /* The size of the string we might be able to reuse. */
11932 size
= (STRINGP (f
->desired_tool_bar_string
)
11933 ? SCHARS (f
->desired_tool_bar_string
)
11936 /* We need one space in the string for each image. */
11937 size_needed
= f
->n_tool_bar_items
;
11939 /* Reuse f->desired_tool_bar_string, if possible. */
11940 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11941 fset_desired_tool_bar_string
11942 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11945 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11946 Fremove_text_properties (make_number (0), make_number (size
),
11947 props
, f
->desired_tool_bar_string
);
11950 /* Put a `display' property on the string for the images to display,
11951 put a `menu_item' property on tool-bar items with a value that
11952 is the index of the item in F's tool-bar item vector. */
11953 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11955 #define PROP(IDX) \
11956 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11958 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11959 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11960 int hmargin
, vmargin
, relief
, idx
, end
;
11962 /* If image is a vector, choose the image according to the
11964 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11965 if (VECTORP (image
))
11969 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11970 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11973 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11974 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11976 eassert (ASIZE (image
) >= idx
);
11977 image
= AREF (image
, idx
);
11982 /* Ignore invalid image specifications. */
11983 if (!valid_image_p (image
))
11986 /* Display the tool-bar button pressed, or depressed. */
11987 plist
= Fcopy_sequence (XCDR (image
));
11989 /* Compute margin and relief to draw. */
11990 relief
= (tool_bar_button_relief
>= 0
11991 ? tool_bar_button_relief
11992 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11993 hmargin
= vmargin
= relief
;
11995 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11996 INT_MAX
- max (hmargin
, vmargin
)))
11998 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11999 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12001 else if (CONSP (Vtool_bar_button_margin
))
12003 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12004 INT_MAX
- hmargin
))
12005 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12007 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12008 INT_MAX
- vmargin
))
12009 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12012 if (auto_raise_tool_bar_buttons_p
)
12014 /* Add a `:relief' property to the image spec if the item is
12018 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12025 /* If image is selected, display it pressed, i.e. with a
12026 negative relief. If it's not selected, display it with a
12028 plist
= Fplist_put (plist
, QCrelief
,
12030 ? make_number (-relief
)
12031 : make_number (relief
)));
12036 /* Put a margin around the image. */
12037 if (hmargin
|| vmargin
)
12039 if (hmargin
== vmargin
)
12040 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12042 plist
= Fplist_put (plist
, QCmargin
,
12043 Fcons (make_number (hmargin
),
12044 make_number (vmargin
)));
12047 /* If button is not enabled, and we don't have special images
12048 for the disabled state, make the image appear disabled by
12049 applying an appropriate algorithm to it. */
12050 if (!enabled_p
&& idx
< 0)
12051 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12053 /* Put a `display' text property on the string for the image to
12054 display. Put a `menu-item' property on the string that gives
12055 the start of this item's properties in the tool-bar items
12057 image
= Fcons (Qimage
, plist
);
12058 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12059 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12061 /* Let the last image hide all remaining spaces in the tool bar
12062 string. The string can be longer than needed when we reuse a
12063 previous string. */
12064 if (i
+ 1 == f
->n_tool_bar_items
)
12065 end
= SCHARS (f
->desired_tool_bar_string
);
12068 Fadd_text_properties (make_number (i
), make_number (end
),
12069 props
, f
->desired_tool_bar_string
);
12075 /* Display one line of the tool-bar of frame IT->f.
12077 HEIGHT specifies the desired height of the tool-bar line.
12078 If the actual height of the glyph row is less than HEIGHT, the
12079 row's height is increased to HEIGHT, and the icons are centered
12080 vertically in the new height.
12082 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12083 count a final empty row in case the tool-bar width exactly matches
12088 display_tool_bar_line (struct it
*it
, int height
)
12090 struct glyph_row
*row
= it
->glyph_row
;
12091 int max_x
= it
->last_visible_x
;
12092 struct glyph
*last
;
12094 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12095 clear_glyph_row (row
);
12096 row
->enabled_p
= true;
12097 row
->y
= it
->current_y
;
12099 /* Note that this isn't made use of if the face hasn't a box,
12100 so there's no need to check the face here. */
12101 it
->start_of_box_run_p
= true;
12103 while (it
->current_x
< max_x
)
12105 int x
, n_glyphs_before
, i
, nglyphs
;
12106 struct it it_before
;
12108 /* Get the next display element. */
12109 if (!get_next_display_element (it
))
12111 /* Don't count empty row if we are counting needed tool-bar lines. */
12112 if (height
< 0 && !it
->hpos
)
12117 /* Produce glyphs. */
12118 n_glyphs_before
= row
->used
[TEXT_AREA
];
12121 PRODUCE_GLYPHS (it
);
12123 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12125 x
= it_before
.current_x
;
12126 while (i
< nglyphs
)
12128 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12130 if (x
+ glyph
->pixel_width
> max_x
)
12132 /* Glyph doesn't fit on line. Backtrack. */
12133 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12135 /* If this is the only glyph on this line, it will never fit on the
12136 tool-bar, so skip it. But ensure there is at least one glyph,
12137 so we don't accidentally disable the tool-bar. */
12138 if (n_glyphs_before
== 0
12139 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12145 x
+= glyph
->pixel_width
;
12149 /* Stop at line end. */
12150 if (ITERATOR_AT_END_OF_LINE_P (it
))
12153 set_iterator_to_next (it
, true);
12158 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12160 /* Use default face for the border below the tool bar.
12162 FIXME: When auto-resize-tool-bars is grow-only, there is
12163 no additional border below the possibly empty tool-bar lines.
12164 So to make the extra empty lines look "normal", we have to
12165 use the tool-bar face for the border too. */
12166 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12167 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12168 it
->face_id
= DEFAULT_FACE_ID
;
12170 extend_face_to_end_of_line (it
);
12171 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12172 last
->right_box_line_p
= true;
12173 if (last
== row
->glyphs
[TEXT_AREA
])
12174 last
->left_box_line_p
= true;
12176 /* Make line the desired height and center it vertically. */
12177 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12179 /* Don't add more than one line height. */
12180 height
%= FRAME_LINE_HEIGHT (it
->f
);
12181 it
->max_ascent
+= height
/ 2;
12182 it
->max_descent
+= (height
+ 1) / 2;
12185 compute_line_metrics (it
);
12187 /* If line is empty, make it occupy the rest of the tool-bar. */
12188 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12190 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12191 row
->visible_height
= row
->height
;
12192 row
->ascent
= row
->phys_ascent
= 0;
12193 row
->extra_line_spacing
= 0;
12196 row
->full_width_p
= true;
12197 row
->continued_p
= false;
12198 row
->truncated_on_left_p
= false;
12199 row
->truncated_on_right_p
= false;
12201 it
->current_x
= it
->hpos
= 0;
12202 it
->current_y
+= row
->height
;
12208 /* Value is the number of pixels needed to make all tool-bar items of
12209 frame F visible. The actual number of glyph rows needed is
12210 returned in *N_ROWS if non-NULL. */
12212 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12214 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12216 /* tool_bar_height is called from redisplay_tool_bar after building
12217 the desired matrix, so use (unused) mode-line row as temporary row to
12218 avoid destroying the first tool-bar row. */
12219 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12221 /* Initialize an iterator for iteration over
12222 F->desired_tool_bar_string in the tool-bar window of frame F. */
12223 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12224 temp_row
->reversed_p
= false;
12225 it
.first_visible_x
= 0;
12226 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12227 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12228 it
.paragraph_embedding
= L2R
;
12230 while (!ITERATOR_AT_END_P (&it
))
12232 clear_glyph_row (temp_row
);
12233 it
.glyph_row
= temp_row
;
12234 display_tool_bar_line (&it
, -1);
12236 clear_glyph_row (temp_row
);
12238 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12240 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12243 return it
.current_y
;
12245 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12248 #endif /* !USE_GTK && !HAVE_NS */
12250 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12252 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12253 If FRAME is nil or omitted, use the selected frame. Optional argument
12254 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12255 (Lisp_Object frame
, Lisp_Object pixelwise
)
12259 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12260 struct frame
*f
= decode_any_frame (frame
);
12262 if (WINDOWP (f
->tool_bar_window
)
12263 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12265 update_tool_bar (f
, true);
12266 if (f
->n_tool_bar_items
)
12268 build_desired_tool_bar_string (f
);
12269 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12274 return make_number (height
);
12278 /* Display the tool-bar of frame F. Value is true if tool-bar's
12279 height should be changed. */
12281 redisplay_tool_bar (struct frame
*f
)
12283 #if defined (USE_GTK) || defined (HAVE_NS)
12285 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12286 update_frame_tool_bar (f
);
12289 #else /* !USE_GTK && !HAVE_NS */
12293 struct glyph_row
*row
;
12295 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12296 do anything. This means you must start with tool-bar-lines
12297 non-zero to get the auto-sizing effect. Or in other words, you
12298 can turn off tool-bars by specifying tool-bar-lines zero. */
12299 if (!WINDOWP (f
->tool_bar_window
)
12300 || (w
= XWINDOW (f
->tool_bar_window
),
12301 WINDOW_TOTAL_LINES (w
) == 0))
12304 /* Set up an iterator for the tool-bar window. */
12305 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12306 it
.first_visible_x
= 0;
12307 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12308 row
= it
.glyph_row
;
12309 row
->reversed_p
= false;
12311 /* Build a string that represents the contents of the tool-bar. */
12312 build_desired_tool_bar_string (f
);
12313 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12314 /* FIXME: This should be controlled by a user option. But it
12315 doesn't make sense to have an R2L tool bar if the menu bar cannot
12316 be drawn also R2L, and making the menu bar R2L is tricky due
12317 toolkit-specific code that implements it. If an R2L tool bar is
12318 ever supported, display_tool_bar_line should also be augmented to
12319 call unproduce_glyphs like display_line and display_string
12321 it
.paragraph_embedding
= L2R
;
12323 if (f
->n_tool_bar_rows
== 0)
12325 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12327 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12329 x_change_tool_bar_height (f
, new_height
);
12330 frame_default_tool_bar_height
= new_height
;
12331 /* Always do that now. */
12332 clear_glyph_matrix (w
->desired_matrix
);
12333 f
->fonts_changed
= true;
12338 /* Display as many lines as needed to display all tool-bar items. */
12340 if (f
->n_tool_bar_rows
> 0)
12342 int border
, rows
, height
, extra
;
12344 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12345 border
= XINT (Vtool_bar_border
);
12346 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12347 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12348 else if (EQ (Vtool_bar_border
, Qborder_width
))
12349 border
= f
->border_width
;
12355 rows
= f
->n_tool_bar_rows
;
12356 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12357 extra
= it
.last_visible_y
- border
- height
* rows
;
12359 while (it
.current_y
< it
.last_visible_y
)
12362 if (extra
> 0 && rows
-- > 0)
12364 h
= (extra
+ rows
- 1) / rows
;
12367 display_tool_bar_line (&it
, height
+ h
);
12372 while (it
.current_y
< it
.last_visible_y
)
12373 display_tool_bar_line (&it
, 0);
12376 /* It doesn't make much sense to try scrolling in the tool-bar
12377 window, so don't do it. */
12378 w
->desired_matrix
->no_scrolling_p
= true;
12379 w
->must_be_updated_p
= true;
12381 if (!NILP (Vauto_resize_tool_bars
))
12383 bool change_height_p
= true;
12385 /* If we couldn't display everything, change the tool-bar's
12386 height if there is room for more. */
12387 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12388 change_height_p
= true;
12390 /* We subtract 1 because display_tool_bar_line advances the
12391 glyph_row pointer before returning to its caller. We want to
12392 examine the last glyph row produced by
12393 display_tool_bar_line. */
12394 row
= it
.glyph_row
- 1;
12396 /* If there are blank lines at the end, except for a partially
12397 visible blank line at the end that is smaller than
12398 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12399 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12400 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12401 change_height_p
= true;
12403 /* If row displays tool-bar items, but is partially visible,
12404 change the tool-bar's height. */
12405 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12406 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12407 change_height_p
= true;
12409 /* Resize windows as needed by changing the `tool-bar-lines'
12410 frame parameter. */
12411 if (change_height_p
)
12414 int new_height
= tool_bar_height (f
, &nrows
, true);
12416 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12417 && !f
->minimize_tool_bar_window_p
)
12418 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12419 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12420 f
->minimize_tool_bar_window_p
= false;
12422 if (change_height_p
)
12424 x_change_tool_bar_height (f
, new_height
);
12425 frame_default_tool_bar_height
= new_height
;
12426 clear_glyph_matrix (w
->desired_matrix
);
12427 f
->n_tool_bar_rows
= nrows
;
12428 f
->fonts_changed
= true;
12435 f
->minimize_tool_bar_window_p
= false;
12438 #endif /* USE_GTK || HAVE_NS */
12441 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12443 /* Get information about the tool-bar item which is displayed in GLYPH
12444 on frame F. Return in *PROP_IDX the index where tool-bar item
12445 properties start in F->tool_bar_items. Value is false if
12446 GLYPH doesn't display a tool-bar item. */
12449 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12454 /* This function can be called asynchronously, which means we must
12455 exclude any possibility that Fget_text_property signals an
12457 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12458 charpos
= max (0, charpos
);
12460 /* Get the text property `menu-item' at pos. The value of that
12461 property is the start index of this item's properties in
12462 F->tool_bar_items. */
12463 prop
= Fget_text_property (make_number (charpos
),
12464 Qmenu_item
, f
->current_tool_bar_string
);
12465 if (! INTEGERP (prop
))
12467 *prop_idx
= XINT (prop
);
12472 /* Get information about the tool-bar item at position X/Y on frame F.
12473 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12474 the current matrix of the tool-bar window of F, or NULL if not
12475 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12476 item in F->tool_bar_items. Value is
12478 -1 if X/Y is not on a tool-bar item
12479 0 if X/Y is on the same item that was highlighted before.
12483 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12484 int *hpos
, int *vpos
, int *prop_idx
)
12486 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12487 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12490 /* Find the glyph under X/Y. */
12491 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12492 if (*glyph
== NULL
)
12495 /* Get the start of this tool-bar item's properties in
12496 f->tool_bar_items. */
12497 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12500 /* Is mouse on the highlighted item? */
12501 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12502 && *vpos
>= hlinfo
->mouse_face_beg_row
12503 && *vpos
<= hlinfo
->mouse_face_end_row
12504 && (*vpos
> hlinfo
->mouse_face_beg_row
12505 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12506 && (*vpos
< hlinfo
->mouse_face_end_row
12507 || *hpos
< hlinfo
->mouse_face_end_col
12508 || hlinfo
->mouse_face_past_end
))
12516 Handle mouse button event on the tool-bar of frame F, at
12517 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12518 false for button release. MODIFIERS is event modifiers for button
12522 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12525 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12526 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12527 int hpos
, vpos
, prop_idx
;
12528 struct glyph
*glyph
;
12529 Lisp_Object enabled_p
;
12532 /* If not on the highlighted tool-bar item, and mouse-highlight is
12533 non-nil, return. This is so we generate the tool-bar button
12534 click only when the mouse button is released on the same item as
12535 where it was pressed. However, when mouse-highlight is disabled,
12536 generate the click when the button is released regardless of the
12537 highlight, since tool-bar items are not highlighted in that
12539 frame_to_window_pixel_xy (w
, &x
, &y
);
12540 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12542 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12545 /* When mouse-highlight is off, generate the click for the item
12546 where the button was pressed, disregarding where it was
12548 if (NILP (Vmouse_highlight
) && !down_p
)
12549 prop_idx
= f
->last_tool_bar_item
;
12551 /* If item is disabled, do nothing. */
12552 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12553 if (NILP (enabled_p
))
12558 /* Show item in pressed state. */
12559 if (!NILP (Vmouse_highlight
))
12560 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12561 f
->last_tool_bar_item
= prop_idx
;
12565 Lisp_Object key
, frame
;
12566 struct input_event event
;
12567 EVENT_INIT (event
);
12569 /* Show item in released state. */
12570 if (!NILP (Vmouse_highlight
))
12571 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12573 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12575 XSETFRAME (frame
, f
);
12576 event
.kind
= TOOL_BAR_EVENT
;
12577 event
.frame_or_window
= frame
;
12579 kbd_buffer_store_event (&event
);
12581 event
.kind
= TOOL_BAR_EVENT
;
12582 event
.frame_or_window
= frame
;
12584 event
.modifiers
= modifiers
;
12585 kbd_buffer_store_event (&event
);
12586 f
->last_tool_bar_item
= -1;
12591 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12592 tool-bar window-relative coordinates X/Y. Called from
12593 note_mouse_highlight. */
12596 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12598 Lisp_Object window
= f
->tool_bar_window
;
12599 struct window
*w
= XWINDOW (window
);
12600 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12601 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12603 struct glyph
*glyph
;
12604 struct glyph_row
*row
;
12606 Lisp_Object enabled_p
;
12608 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12612 /* Function note_mouse_highlight is called with negative X/Y
12613 values when mouse moves outside of the frame. */
12614 if (x
<= 0 || y
<= 0)
12616 clear_mouse_face (hlinfo
);
12620 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12623 /* Not on tool-bar item. */
12624 clear_mouse_face (hlinfo
);
12628 /* On same tool-bar item as before. */
12629 goto set_help_echo
;
12631 clear_mouse_face (hlinfo
);
12633 /* Mouse is down, but on different tool-bar item? */
12634 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12635 && f
== dpyinfo
->last_mouse_frame
);
12637 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12640 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12642 /* If tool-bar item is not enabled, don't highlight it. */
12643 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12644 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12646 /* Compute the x-position of the glyph. In front and past the
12647 image is a space. We include this in the highlighted area. */
12648 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12649 for (i
= x
= 0; i
< hpos
; ++i
)
12650 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12652 /* Record this as the current active region. */
12653 hlinfo
->mouse_face_beg_col
= hpos
;
12654 hlinfo
->mouse_face_beg_row
= vpos
;
12655 hlinfo
->mouse_face_beg_x
= x
;
12656 hlinfo
->mouse_face_past_end
= false;
12658 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12659 hlinfo
->mouse_face_end_row
= vpos
;
12660 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12661 hlinfo
->mouse_face_window
= window
;
12662 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12664 /* Display it as active. */
12665 show_mouse_face (hlinfo
, draw
);
12670 /* Set help_echo_string to a help string to display for this tool-bar item.
12671 XTread_socket does the rest. */
12672 help_echo_object
= help_echo_window
= Qnil
;
12673 help_echo_pos
= -1;
12674 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12675 if (NILP (help_echo_string
))
12676 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12679 #endif /* !USE_GTK && !HAVE_NS */
12681 #endif /* HAVE_WINDOW_SYSTEM */
12685 /************************************************************************
12686 Horizontal scrolling
12687 ************************************************************************/
12689 /* For all leaf windows in the window tree rooted at WINDOW, set their
12690 hscroll value so that PT is (i) visible in the window, and (ii) so
12691 that it is not within a certain margin at the window's left and
12692 right border. Value is true if any window's hscroll has been
12696 hscroll_window_tree (Lisp_Object window
)
12698 bool hscrolled_p
= false;
12699 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12700 int hscroll_step_abs
= 0;
12701 double hscroll_step_rel
= 0;
12703 if (hscroll_relative_p
)
12705 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12706 if (hscroll_step_rel
< 0)
12708 hscroll_relative_p
= false;
12709 hscroll_step_abs
= 0;
12712 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12714 hscroll_step_abs
= XINT (Vhscroll_step
);
12715 if (hscroll_step_abs
< 0)
12716 hscroll_step_abs
= 0;
12719 hscroll_step_abs
= 0;
12721 while (WINDOWP (window
))
12723 struct window
*w
= XWINDOW (window
);
12725 if (WINDOWP (w
->contents
))
12726 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12727 else if (w
->cursor
.vpos
>= 0)
12730 int text_area_width
;
12731 struct glyph_row
*cursor_row
;
12732 struct glyph_row
*bottom_row
;
12734 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12735 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12736 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12738 cursor_row
= bottom_row
- 1;
12740 if (!cursor_row
->enabled_p
)
12742 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12743 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12744 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12746 cursor_row
= bottom_row
- 1;
12748 bool row_r2l_p
= cursor_row
->reversed_p
;
12750 text_area_width
= window_box_width (w
, TEXT_AREA
);
12752 /* Scroll when cursor is inside this scroll margin. */
12753 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12755 /* If the position of this window's point has explicitly
12756 changed, no more suspend auto hscrolling. */
12757 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12758 w
->suspend_auto_hscroll
= false;
12760 /* Remember window point. */
12761 Fset_marker (w
->old_pointm
,
12762 ((w
== XWINDOW (selected_window
))
12763 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12764 : Fmarker_position (w
->pointm
)),
12767 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12768 && !w
->suspend_auto_hscroll
12769 /* In some pathological cases, like restoring a window
12770 configuration into a frame that is much smaller than
12771 the one from which the configuration was saved, we
12772 get glyph rows whose start and end have zero buffer
12773 positions, which we cannot handle below. Just skip
12775 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12776 /* For left-to-right rows, hscroll when cursor is either
12777 (i) inside the right hscroll margin, or (ii) if it is
12778 inside the left margin and the window is already
12781 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12782 || (cursor_row
->enabled_p
12783 && cursor_row
->truncated_on_right_p
12784 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12785 /* For right-to-left rows, the logic is similar,
12786 except that rules for scrolling to left and right
12787 are reversed. E.g., if cursor.x <= h_margin, we
12788 need to hscroll "to the right" unconditionally,
12789 and that will scroll the screen to the left so as
12790 to reveal the next portion of the row. */
12792 && ((cursor_row
->enabled_p
12793 /* FIXME: It is confusing to set the
12794 truncated_on_right_p flag when R2L rows
12795 are actually truncated on the left. */
12796 && cursor_row
->truncated_on_right_p
12797 && w
->cursor
.x
<= h_margin
)
12799 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12803 struct buffer
*saved_current_buffer
;
12807 /* Find point in a display of infinite width. */
12808 saved_current_buffer
= current_buffer
;
12809 current_buffer
= XBUFFER (w
->contents
);
12811 if (w
== XWINDOW (selected_window
))
12814 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12816 /* Move iterator to pt starting at cursor_row->start in
12817 a line with infinite width. */
12818 init_to_row_start (&it
, w
, cursor_row
);
12819 it
.last_visible_x
= INFINITY
;
12820 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12821 current_buffer
= saved_current_buffer
;
12823 /* Position cursor in window. */
12824 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12825 hscroll
= max (0, (it
.current_x
12826 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12827 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12828 : (text_area_width
/ 2))))
12829 / FRAME_COLUMN_WIDTH (it
.f
);
12830 else if ((!row_r2l_p
12831 && w
->cursor
.x
>= text_area_width
- h_margin
)
12832 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12834 if (hscroll_relative_p
)
12835 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12838 wanted_x
= text_area_width
12839 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12842 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12846 if (hscroll_relative_p
)
12847 wanted_x
= text_area_width
* hscroll_step_rel
12850 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12853 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12855 hscroll
= max (hscroll
, w
->min_hscroll
);
12857 /* Don't prevent redisplay optimizations if hscroll
12858 hasn't changed, as it will unnecessarily slow down
12860 if (w
->hscroll
!= hscroll
)
12862 struct buffer
*b
= XBUFFER (w
->contents
);
12863 b
->prevent_redisplay_optimizations_p
= true;
12864 w
->hscroll
= hscroll
;
12865 hscrolled_p
= true;
12873 /* Value is true if hscroll of any leaf window has been changed. */
12874 return hscrolled_p
;
12878 /* Set hscroll so that cursor is visible and not inside horizontal
12879 scroll margins for all windows in the tree rooted at WINDOW. See
12880 also hscroll_window_tree above. Value is true if any window's
12881 hscroll has been changed. If it has, desired matrices on the frame
12882 of WINDOW are cleared. */
12885 hscroll_windows (Lisp_Object window
)
12887 bool hscrolled_p
= hscroll_window_tree (window
);
12889 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12890 return hscrolled_p
;
12895 /************************************************************************
12897 ************************************************************************/
12899 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12900 This is sometimes handy to have in a debugger session. */
12904 /* First and last unchanged row for try_window_id. */
12906 static int debug_first_unchanged_at_end_vpos
;
12907 static int debug_last_unchanged_at_beg_vpos
;
12909 /* Delta vpos and y. */
12911 static int debug_dvpos
, debug_dy
;
12913 /* Delta in characters and bytes for try_window_id. */
12915 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12917 /* Values of window_end_pos and window_end_vpos at the end of
12920 static ptrdiff_t debug_end_vpos
;
12922 /* Append a string to W->desired_matrix->method. FMT is a printf
12923 format string. If trace_redisplay_p is true also printf the
12924 resulting string to stderr. */
12926 static void debug_method_add (struct window
*, char const *, ...)
12927 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12930 debug_method_add (struct window
*w
, char const *fmt
, ...)
12933 char *method
= w
->desired_matrix
->method
;
12934 int len
= strlen (method
);
12935 int size
= sizeof w
->desired_matrix
->method
;
12936 int remaining
= size
- len
- 1;
12939 if (len
&& remaining
)
12942 --remaining
, ++len
;
12945 va_start (ap
, fmt
);
12946 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12949 if (trace_redisplay_p
)
12950 fprintf (stderr
, "%p (%s): %s\n",
12952 ((BUFFERP (w
->contents
)
12953 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12954 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12959 #endif /* GLYPH_DEBUG */
12962 /* Value is true if all changes in window W, which displays
12963 current_buffer, are in the text between START and END. START is a
12964 buffer position, END is given as a distance from Z. Used in
12965 redisplay_internal for display optimization. */
12968 text_outside_line_unchanged_p (struct window
*w
,
12969 ptrdiff_t start
, ptrdiff_t end
)
12971 bool unchanged_p
= true;
12973 /* If text or overlays have changed, see where. */
12974 if (window_outdated (w
))
12976 /* Gap in the line? */
12977 if (GPT
< start
|| Z
- GPT
< end
)
12978 unchanged_p
= false;
12980 /* Changes start in front of the line, or end after it? */
12982 && (BEG_UNCHANGED
< start
- 1
12983 || END_UNCHANGED
< end
))
12984 unchanged_p
= false;
12986 /* If selective display, can't optimize if changes start at the
12987 beginning of the line. */
12989 && INTEGERP (BVAR (current_buffer
, selective_display
))
12990 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12991 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12992 unchanged_p
= false;
12994 /* If there are overlays at the start or end of the line, these
12995 may have overlay strings with newlines in them. A change at
12996 START, for instance, may actually concern the display of such
12997 overlay strings as well, and they are displayed on different
12998 lines. So, quickly rule out this case. (For the future, it
12999 might be desirable to implement something more telling than
13000 just BEG/END_UNCHANGED.) */
13003 if (BEG
+ BEG_UNCHANGED
== start
13004 && overlay_touches_p (start
))
13005 unchanged_p
= false;
13006 if (END_UNCHANGED
== end
13007 && overlay_touches_p (Z
- end
))
13008 unchanged_p
= false;
13011 /* Under bidi reordering, adding or deleting a character in the
13012 beginning of a paragraph, before the first strong directional
13013 character, can change the base direction of the paragraph (unless
13014 the buffer specifies a fixed paragraph direction), which will
13015 require to redisplay the whole paragraph. It might be worthwhile
13016 to find the paragraph limits and widen the range of redisplayed
13017 lines to that, but for now just give up this optimization. */
13018 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13019 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13020 unchanged_p
= false;
13023 return unchanged_p
;
13027 /* Do a frame update, taking possible shortcuts into account. This is
13028 the main external entry point for redisplay.
13030 If the last redisplay displayed an echo area message and that message
13031 is no longer requested, we clear the echo area or bring back the
13032 mini-buffer if that is in use. */
13037 redisplay_internal ();
13042 overlay_arrow_string_or_property (Lisp_Object var
)
13046 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13049 return Voverlay_arrow_string
;
13052 /* Return true if there are any overlay-arrows in current_buffer. */
13054 overlay_arrow_in_current_buffer_p (void)
13058 for (vlist
= Voverlay_arrow_variable_list
;
13060 vlist
= XCDR (vlist
))
13062 Lisp_Object var
= XCAR (vlist
);
13065 if (!SYMBOLP (var
))
13067 val
= find_symbol_value (var
);
13069 && current_buffer
== XMARKER (val
)->buffer
)
13076 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13080 overlay_arrows_changed_p (void)
13084 for (vlist
= Voverlay_arrow_variable_list
;
13086 vlist
= XCDR (vlist
))
13088 Lisp_Object var
= XCAR (vlist
);
13089 Lisp_Object val
, pstr
;
13091 if (!SYMBOLP (var
))
13093 val
= find_symbol_value (var
);
13094 if (!MARKERP (val
))
13096 if (! EQ (COERCE_MARKER (val
),
13097 Fget (var
, Qlast_arrow_position
))
13098 || ! (pstr
= overlay_arrow_string_or_property (var
),
13099 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13105 /* Mark overlay arrows to be updated on next redisplay. */
13108 update_overlay_arrows (int up_to_date
)
13112 for (vlist
= Voverlay_arrow_variable_list
;
13114 vlist
= XCDR (vlist
))
13116 Lisp_Object var
= XCAR (vlist
);
13118 if (!SYMBOLP (var
))
13121 if (up_to_date
> 0)
13123 Lisp_Object val
= find_symbol_value (var
);
13124 Fput (var
, Qlast_arrow_position
,
13125 COERCE_MARKER (val
));
13126 Fput (var
, Qlast_arrow_string
,
13127 overlay_arrow_string_or_property (var
));
13129 else if (up_to_date
< 0
13130 || !NILP (Fget (var
, Qlast_arrow_position
)))
13132 Fput (var
, Qlast_arrow_position
, Qt
);
13133 Fput (var
, Qlast_arrow_string
, Qt
);
13139 /* Return overlay arrow string to display at row.
13140 Return integer (bitmap number) for arrow bitmap in left fringe.
13141 Return nil if no overlay arrow. */
13144 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13148 for (vlist
= Voverlay_arrow_variable_list
;
13150 vlist
= XCDR (vlist
))
13152 Lisp_Object var
= XCAR (vlist
);
13155 if (!SYMBOLP (var
))
13158 val
= find_symbol_value (var
);
13161 && current_buffer
== XMARKER (val
)->buffer
13162 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13164 if (FRAME_WINDOW_P (it
->f
)
13165 /* FIXME: if ROW->reversed_p is set, this should test
13166 the right fringe, not the left one. */
13167 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13169 #ifdef HAVE_WINDOW_SYSTEM
13170 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13172 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13173 if (fringe_bitmap
!= 0)
13174 return make_number (fringe_bitmap
);
13177 return make_number (-1); /* Use default arrow bitmap. */
13179 return overlay_arrow_string_or_property (var
);
13186 /* Return true if point moved out of or into a composition. Otherwise
13187 return false. PREV_BUF and PREV_PT are the last point buffer and
13188 position. BUF and PT are the current point buffer and position. */
13191 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13192 struct buffer
*buf
, ptrdiff_t pt
)
13194 ptrdiff_t start
, end
;
13196 Lisp_Object buffer
;
13198 XSETBUFFER (buffer
, buf
);
13199 /* Check a composition at the last point if point moved within the
13201 if (prev_buf
== buf
)
13204 /* Point didn't move. */
13207 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13208 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13209 && composition_valid_p (start
, end
, prop
)
13210 && start
< prev_pt
&& end
> prev_pt
)
13211 /* The last point was within the composition. Return true iff
13212 point moved out of the composition. */
13213 return (pt
<= start
|| pt
>= end
);
13216 /* Check a composition at the current point. */
13217 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13218 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13219 && composition_valid_p (start
, end
, prop
)
13220 && start
< pt
&& end
> pt
);
13223 /* Reconsider the clip changes of buffer which is displayed in W. */
13226 reconsider_clip_changes (struct window
*w
)
13228 struct buffer
*b
= XBUFFER (w
->contents
);
13230 if (b
->clip_changed
13231 && w
->window_end_valid
13232 && w
->current_matrix
->buffer
== b
13233 && w
->current_matrix
->zv
== BUF_ZV (b
)
13234 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13235 b
->clip_changed
= false;
13237 /* If display wasn't paused, and W is not a tool bar window, see if
13238 point has been moved into or out of a composition. In that case,
13239 set b->clip_changed to force updating the screen. If
13240 b->clip_changed has already been set, skip this check. */
13241 if (!b
->clip_changed
&& w
->window_end_valid
)
13243 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13244 ? PT
: marker_position (w
->pointm
));
13246 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13247 && check_point_in_composition (w
->current_matrix
->buffer
,
13248 w
->last_point
, b
, pt
))
13249 b
->clip_changed
= true;
13254 propagate_buffer_redisplay (void)
13255 { /* Resetting b->text->redisplay is problematic!
13256 We can't just reset it in the case that some window that displays
13257 it has not been redisplayed; and such a window can stay
13258 unredisplayed for a long time if it's currently invisible.
13259 But we do want to reset it at the end of redisplay otherwise
13260 its displayed windows will keep being redisplayed over and over
13262 So we copy all b->text->redisplay flags up to their windows here,
13263 such that mark_window_display_accurate can safely reset
13264 b->text->redisplay. */
13265 Lisp_Object ws
= window_list ();
13266 for (; CONSP (ws
); ws
= XCDR (ws
))
13268 struct window
*thisw
= XWINDOW (XCAR (ws
));
13269 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13270 if (thisb
->text
->redisplay
)
13271 thisw
->redisplay
= true;
13275 #define STOP_POLLING \
13276 do { if (! polling_stopped_here) stop_polling (); \
13277 polling_stopped_here = true; } while (false)
13279 #define RESUME_POLLING \
13280 do { if (polling_stopped_here) start_polling (); \
13281 polling_stopped_here = false; } while (false)
13284 /* Perhaps in the future avoid recentering windows if it
13285 is not necessary; currently that causes some problems. */
13288 redisplay_internal (void)
13290 struct window
*w
= XWINDOW (selected_window
);
13294 bool must_finish
= false, match_p
;
13295 struct text_pos tlbufpos
, tlendpos
;
13296 int number_of_visible_frames
;
13299 bool polling_stopped_here
= false;
13300 Lisp_Object tail
, frame
;
13302 /* True means redisplay has to consider all windows on all
13303 frames. False, only selected_window is considered. */
13304 bool consider_all_windows_p
;
13306 /* True means redisplay has to redisplay the miniwindow. */
13307 bool update_miniwindow_p
= false;
13309 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13311 /* No redisplay if running in batch mode or frame is not yet fully
13312 initialized, or redisplay is explicitly turned off by setting
13313 Vinhibit_redisplay. */
13314 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13315 || !NILP (Vinhibit_redisplay
))
13318 /* Don't examine these until after testing Vinhibit_redisplay.
13319 When Emacs is shutting down, perhaps because its connection to
13320 X has dropped, we should not look at them at all. */
13321 fr
= XFRAME (w
->frame
);
13322 sf
= SELECTED_FRAME ();
13324 if (!fr
->glyphs_initialized_p
)
13327 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13328 if (popup_activated ())
13332 /* I don't think this happens but let's be paranoid. */
13333 if (redisplaying_p
)
13336 /* Record a function that clears redisplaying_p
13337 when we leave this function. */
13338 count
= SPECPDL_INDEX ();
13339 record_unwind_protect_void (unwind_redisplay
);
13340 redisplaying_p
= true;
13341 specbind (Qinhibit_free_realized_faces
, Qnil
);
13343 /* Record this function, so it appears on the profiler's backtraces. */
13344 record_in_backtrace (Qredisplay_internal
, 0, 0);
13346 FOR_EACH_FRAME (tail
, frame
)
13347 XFRAME (frame
)->already_hscrolled_p
= false;
13350 /* Remember the currently selected window. */
13354 forget_escape_and_glyphless_faces ();
13356 /* If face_change, init_iterator will free all realized faces, which
13357 includes the faces referenced from current matrices. So, we
13358 can't reuse current matrices in this case. */
13360 windows_or_buffers_changed
= 47;
13362 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13363 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13365 /* Since frames on a single ASCII terminal share the same
13366 display area, displaying a different frame means redisplay
13367 the whole thing. */
13368 SET_FRAME_GARBAGED (sf
);
13370 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13372 FRAME_TTY (sf
)->previous_frame
= sf
;
13375 /* Set the visible flags for all frames. Do this before checking for
13376 resized or garbaged frames; they want to know if their frames are
13377 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13378 number_of_visible_frames
= 0;
13380 FOR_EACH_FRAME (tail
, frame
)
13382 struct frame
*f
= XFRAME (frame
);
13384 if (FRAME_VISIBLE_P (f
))
13386 ++number_of_visible_frames
;
13387 /* Adjust matrices for visible frames only. */
13388 if (f
->fonts_changed
)
13390 adjust_frame_glyphs (f
);
13391 /* Disable all redisplay optimizations for this frame.
13392 This is because adjust_frame_glyphs resets the
13393 enabled_p flag for all glyph rows of all windows, so
13394 many optimizations will fail anyway, and some might
13395 fail to test that flag and do bogus things as
13397 SET_FRAME_GARBAGED (f
);
13398 f
->fonts_changed
= false;
13400 /* If cursor type has been changed on the frame
13401 other than selected, consider all frames. */
13402 if (f
!= sf
&& f
->cursor_type_changed
)
13403 update_mode_lines
= 31;
13405 clear_desired_matrices (f
);
13408 /* Notice any pending interrupt request to change frame size. */
13409 do_pending_window_change (true);
13411 /* do_pending_window_change could change the selected_window due to
13412 frame resizing which makes the selected window too small. */
13413 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13416 /* Clear frames marked as garbaged. */
13417 clear_garbaged_frames ();
13419 /* Build menubar and tool-bar items. */
13420 if (NILP (Vmemory_full
))
13421 prepare_menu_bars ();
13423 reconsider_clip_changes (w
);
13425 /* In most cases selected window displays current buffer. */
13426 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13429 /* Detect case that we need to write or remove a star in the mode line. */
13430 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13431 w
->update_mode_line
= true;
13433 if (mode_line_update_needed (w
))
13434 w
->update_mode_line
= true;
13436 /* If reconsider_clip_changes above decided that the narrowing
13437 in the current buffer changed, make sure all other windows
13438 showing that buffer will be redisplayed. */
13439 if (current_buffer
->clip_changed
)
13440 bset_update_mode_line (current_buffer
);
13443 /* Normally the message* functions will have already displayed and
13444 updated the echo area, but the frame may have been trashed, or
13445 the update may have been preempted, so display the echo area
13446 again here. Checking message_cleared_p captures the case that
13447 the echo area should be cleared. */
13448 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13449 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13450 || (message_cleared_p
13451 && minibuf_level
== 0
13452 /* If the mini-window is currently selected, this means the
13453 echo-area doesn't show through. */
13454 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13456 echo_area_display (false);
13458 if (message_cleared_p
)
13459 update_miniwindow_p
= true;
13461 must_finish
= true;
13463 /* If we don't display the current message, don't clear the
13464 message_cleared_p flag, because, if we did, we wouldn't clear
13465 the echo area in the next redisplay which doesn't preserve
13467 if (!display_last_displayed_message_p
)
13468 message_cleared_p
= false;
13470 else if (EQ (selected_window
, minibuf_window
)
13471 && (current_buffer
->clip_changed
|| window_outdated (w
))
13472 && resize_mini_window (w
, false))
13474 /* Resized active mini-window to fit the size of what it is
13475 showing if its contents might have changed. */
13476 must_finish
= true;
13478 /* If window configuration was changed, frames may have been
13479 marked garbaged. Clear them or we will experience
13480 surprises wrt scrolling. */
13481 clear_garbaged_frames ();
13484 if (windows_or_buffers_changed
&& !update_mode_lines
)
13485 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13486 only the windows's contents needs to be refreshed, or whether the
13487 mode-lines also need a refresh. */
13488 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13489 ? REDISPLAY_SOME
: 32);
13491 /* If specs for an arrow have changed, do thorough redisplay
13492 to ensure we remove any arrow that should no longer exist. */
13493 if (overlay_arrows_changed_p ())
13494 /* Apparently, this is the only case where we update other windows,
13495 without updating other mode-lines. */
13496 windows_or_buffers_changed
= 49;
13498 consider_all_windows_p
= (update_mode_lines
13499 || windows_or_buffers_changed
);
13501 #define AINC(a,i) \
13502 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13503 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13505 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13506 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13508 /* Optimize the case that only the line containing the cursor in the
13509 selected window has changed. Variables starting with this_ are
13510 set in display_line and record information about the line
13511 containing the cursor. */
13512 tlbufpos
= this_line_start_pos
;
13513 tlendpos
= this_line_end_pos
;
13514 if (!consider_all_windows_p
13515 && CHARPOS (tlbufpos
) > 0
13516 && !w
->update_mode_line
13517 && !current_buffer
->clip_changed
13518 && !current_buffer
->prevent_redisplay_optimizations_p
13519 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13520 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13521 && !XFRAME (w
->frame
)->cursor_type_changed
13522 /* Make sure recorded data applies to current buffer, etc. */
13523 && this_line_buffer
== current_buffer
13526 && !w
->optional_new_start
13527 /* Point must be on the line that we have info recorded about. */
13528 && PT
>= CHARPOS (tlbufpos
)
13529 && PT
<= Z
- CHARPOS (tlendpos
)
13530 /* All text outside that line, including its final newline,
13531 must be unchanged. */
13532 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13533 CHARPOS (tlendpos
)))
13535 if (CHARPOS (tlbufpos
) > BEGV
13536 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13537 && (CHARPOS (tlbufpos
) == ZV
13538 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13539 /* Former continuation line has disappeared by becoming empty. */
13541 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13543 /* We have to handle the case of continuation around a
13544 wide-column character (see the comment in indent.c around
13547 For instance, in the following case:
13549 -------- Insert --------
13550 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13551 J_I_ ==> J_I_ `^^' are cursors.
13555 As we have to redraw the line above, we cannot use this
13559 int line_height_before
= this_line_pixel_height
;
13561 /* Note that start_display will handle the case that the
13562 line starting at tlbufpos is a continuation line. */
13563 start_display (&it
, w
, tlbufpos
);
13565 /* Implementation note: It this still necessary? */
13566 if (it
.current_x
!= this_line_start_x
)
13569 TRACE ((stderr
, "trying display optimization 1\n"));
13570 w
->cursor
.vpos
= -1;
13571 overlay_arrow_seen
= false;
13572 it
.vpos
= this_line_vpos
;
13573 it
.current_y
= this_line_y
;
13574 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13575 display_line (&it
);
13577 /* If line contains point, is not continued,
13578 and ends at same distance from eob as before, we win. */
13579 if (w
->cursor
.vpos
>= 0
13580 /* Line is not continued, otherwise this_line_start_pos
13581 would have been set to 0 in display_line. */
13582 && CHARPOS (this_line_start_pos
)
13583 /* Line ends as before. */
13584 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13585 /* Line has same height as before. Otherwise other lines
13586 would have to be shifted up or down. */
13587 && this_line_pixel_height
== line_height_before
)
13589 /* If this is not the window's last line, we must adjust
13590 the charstarts of the lines below. */
13591 if (it
.current_y
< it
.last_visible_y
)
13593 struct glyph_row
*row
13594 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13595 ptrdiff_t delta
, delta_bytes
;
13597 /* We used to distinguish between two cases here,
13598 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13599 when the line ends in a newline or the end of the
13600 buffer's accessible portion. But both cases did
13601 the same, so they were collapsed. */
13603 - CHARPOS (tlendpos
)
13604 - MATRIX_ROW_START_CHARPOS (row
));
13605 delta_bytes
= (Z_BYTE
13606 - BYTEPOS (tlendpos
)
13607 - MATRIX_ROW_START_BYTEPOS (row
));
13609 increment_matrix_positions (w
->current_matrix
,
13610 this_line_vpos
+ 1,
13611 w
->current_matrix
->nrows
,
13612 delta
, delta_bytes
);
13615 /* If this row displays text now but previously didn't,
13616 or vice versa, w->window_end_vpos may have to be
13618 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13620 if (w
->window_end_vpos
< this_line_vpos
)
13621 w
->window_end_vpos
= this_line_vpos
;
13623 else if (w
->window_end_vpos
== this_line_vpos
13624 && this_line_vpos
> 0)
13625 w
->window_end_vpos
= this_line_vpos
- 1;
13626 w
->window_end_valid
= false;
13628 /* Update hint: No need to try to scroll in update_window. */
13629 w
->desired_matrix
->no_scrolling_p
= true;
13632 *w
->desired_matrix
->method
= 0;
13633 debug_method_add (w
, "optimization 1");
13635 #ifdef HAVE_WINDOW_SYSTEM
13636 update_window_fringes (w
, false);
13643 else if (/* Cursor position hasn't changed. */
13644 PT
== w
->last_point
13645 /* Make sure the cursor was last displayed
13646 in this window. Otherwise we have to reposition it. */
13648 /* PXW: Must be converted to pixels, probably. */
13649 && 0 <= w
->cursor
.vpos
13650 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13654 do_pending_window_change (true);
13655 /* If selected_window changed, redisplay again. */
13656 if (WINDOWP (selected_window
)
13657 && (w
= XWINDOW (selected_window
)) != sw
)
13660 /* We used to always goto end_of_redisplay here, but this
13661 isn't enough if we have a blinking cursor. */
13662 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13663 goto end_of_redisplay
;
13667 /* If highlighting the region, or if the cursor is in the echo area,
13668 then we can't just move the cursor. */
13669 else if (NILP (Vshow_trailing_whitespace
)
13670 && !cursor_in_echo_area
)
13673 struct glyph_row
*row
;
13675 /* Skip from tlbufpos to PT and see where it is. Note that
13676 PT may be in invisible text. If so, we will end at the
13677 next visible position. */
13678 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13679 NULL
, DEFAULT_FACE_ID
);
13680 it
.current_x
= this_line_start_x
;
13681 it
.current_y
= this_line_y
;
13682 it
.vpos
= this_line_vpos
;
13684 /* The call to move_it_to stops in front of PT, but
13685 moves over before-strings. */
13686 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13688 if (it
.vpos
== this_line_vpos
13689 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13692 eassert (this_line_vpos
== it
.vpos
);
13693 eassert (this_line_y
== it
.current_y
);
13694 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13696 *w
->desired_matrix
->method
= 0;
13697 debug_method_add (w
, "optimization 3");
13706 /* Text changed drastically or point moved off of line. */
13707 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13710 CHARPOS (this_line_start_pos
) = 0;
13711 ++clear_face_cache_count
;
13712 #ifdef HAVE_WINDOW_SYSTEM
13713 ++clear_image_cache_count
;
13716 /* Build desired matrices, and update the display. If
13717 consider_all_windows_p, do it for all windows on all frames.
13718 Otherwise do it for selected_window, only. */
13720 if (consider_all_windows_p
)
13722 FOR_EACH_FRAME (tail
, frame
)
13723 XFRAME (frame
)->updated_p
= false;
13725 propagate_buffer_redisplay ();
13727 FOR_EACH_FRAME (tail
, frame
)
13729 struct frame
*f
= XFRAME (frame
);
13731 /* We don't have to do anything for unselected terminal
13733 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13734 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13738 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13741 /* Only GC scrollbars when we redisplay the whole frame. */
13742 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13743 /* Mark all the scroll bars to be removed; we'll redeem
13744 the ones we want when we redisplay their windows. */
13745 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13746 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13748 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13749 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13750 /* Remember that the invisible frames need to be redisplayed next
13751 time they're visible. */
13752 else if (!REDISPLAY_SOME_P ())
13753 f
->redisplay
= true;
13755 /* The X error handler may have deleted that frame. */
13756 if (!FRAME_LIVE_P (f
))
13759 /* Any scroll bars which redisplay_windows should have
13760 nuked should now go away. */
13761 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13762 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13764 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13766 /* If fonts changed on visible frame, display again. */
13767 if (f
->fonts_changed
)
13769 adjust_frame_glyphs (f
);
13770 /* Disable all redisplay optimizations for this
13771 frame. For the reasons, see the comment near
13772 the previous call to adjust_frame_glyphs above. */
13773 SET_FRAME_GARBAGED (f
);
13774 f
->fonts_changed
= false;
13778 /* See if we have to hscroll. */
13779 if (!f
->already_hscrolled_p
)
13781 f
->already_hscrolled_p
= true;
13782 if (hscroll_windows (f
->root_window
))
13786 /* Prevent various kinds of signals during display
13787 update. stdio is not robust about handling
13788 signals, which can cause an apparent I/O error. */
13789 if (interrupt_input
)
13790 unrequest_sigio ();
13793 pending
|= update_frame (f
, false, false);
13794 f
->cursor_type_changed
= false;
13795 f
->updated_p
= true;
13800 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13804 /* Do the mark_window_display_accurate after all windows have
13805 been redisplayed because this call resets flags in buffers
13806 which are needed for proper redisplay. */
13807 FOR_EACH_FRAME (tail
, frame
)
13809 struct frame
*f
= XFRAME (frame
);
13812 f
->redisplay
= false;
13813 mark_window_display_accurate (f
->root_window
, true);
13814 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13815 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13820 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13822 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13823 struct frame
*mini_frame
;
13825 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13826 /* Use list_of_error, not Qerror, so that
13827 we catch only errors and don't run the debugger. */
13828 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13830 redisplay_window_error
);
13831 if (update_miniwindow_p
)
13832 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13834 redisplay_window_error
);
13836 /* Compare desired and current matrices, perform output. */
13839 /* If fonts changed, display again. */
13840 if (sf
->fonts_changed
)
13843 /* Prevent various kinds of signals during display update.
13844 stdio is not robust about handling signals,
13845 which can cause an apparent I/O error. */
13846 if (interrupt_input
)
13847 unrequest_sigio ();
13850 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13852 if (hscroll_windows (selected_window
))
13855 XWINDOW (selected_window
)->must_be_updated_p
= true;
13856 pending
= update_frame (sf
, false, false);
13857 sf
->cursor_type_changed
= false;
13860 /* We may have called echo_area_display at the top of this
13861 function. If the echo area is on another frame, that may
13862 have put text on a frame other than the selected one, so the
13863 above call to update_frame would not have caught it. Catch
13865 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13866 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13868 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13870 XWINDOW (mini_window
)->must_be_updated_p
= true;
13871 pending
|= update_frame (mini_frame
, false, false);
13872 mini_frame
->cursor_type_changed
= false;
13873 if (!pending
&& hscroll_windows (mini_window
))
13878 /* If display was paused because of pending input, make sure we do a
13879 thorough update the next time. */
13882 /* Prevent the optimization at the beginning of
13883 redisplay_internal that tries a single-line update of the
13884 line containing the cursor in the selected window. */
13885 CHARPOS (this_line_start_pos
) = 0;
13887 /* Let the overlay arrow be updated the next time. */
13888 update_overlay_arrows (0);
13890 /* If we pause after scrolling, some rows in the current
13891 matrices of some windows are not valid. */
13892 if (!WINDOW_FULL_WIDTH_P (w
)
13893 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13894 update_mode_lines
= 36;
13898 if (!consider_all_windows_p
)
13900 /* This has already been done above if
13901 consider_all_windows_p is set. */
13902 if (XBUFFER (w
->contents
)->text
->redisplay
13903 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13904 /* This can happen if b->text->redisplay was set during
13906 propagate_buffer_redisplay ();
13907 mark_window_display_accurate_1 (w
, true);
13909 /* Say overlay arrows are up to date. */
13910 update_overlay_arrows (1);
13912 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13913 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13916 update_mode_lines
= 0;
13917 windows_or_buffers_changed
= 0;
13920 /* Start SIGIO interrupts coming again. Having them off during the
13921 code above makes it less likely one will discard output, but not
13922 impossible, since there might be stuff in the system buffer here.
13923 But it is much hairier to try to do anything about that. */
13924 if (interrupt_input
)
13928 /* If a frame has become visible which was not before, redisplay
13929 again, so that we display it. Expose events for such a frame
13930 (which it gets when becoming visible) don't call the parts of
13931 redisplay constructing glyphs, so simply exposing a frame won't
13932 display anything in this case. So, we have to display these
13933 frames here explicitly. */
13938 FOR_EACH_FRAME (tail
, frame
)
13940 if (XFRAME (frame
)->visible
)
13944 if (new_count
!= number_of_visible_frames
)
13945 windows_or_buffers_changed
= 52;
13948 /* Change frame size now if a change is pending. */
13949 do_pending_window_change (true);
13951 /* If we just did a pending size change, or have additional
13952 visible frames, or selected_window changed, redisplay again. */
13953 if ((windows_or_buffers_changed
&& !pending
)
13954 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13957 /* Clear the face and image caches.
13959 We used to do this only if consider_all_windows_p. But the cache
13960 needs to be cleared if a timer creates images in the current
13961 buffer (e.g. the test case in Bug#6230). */
13963 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13965 clear_face_cache (false);
13966 clear_face_cache_count
= 0;
13969 #ifdef HAVE_WINDOW_SYSTEM
13970 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13972 clear_image_caches (Qnil
);
13973 clear_image_cache_count
= 0;
13975 #endif /* HAVE_WINDOW_SYSTEM */
13979 ns_set_doc_edited ();
13981 if (interrupt_input
&& interrupts_deferred
)
13984 unbind_to (count
, Qnil
);
13989 /* Redisplay, but leave alone any recent echo area message unless
13990 another message has been requested in its place.
13992 This is useful in situations where you need to redisplay but no
13993 user action has occurred, making it inappropriate for the message
13994 area to be cleared. See tracking_off and
13995 wait_reading_process_output for examples of these situations.
13997 FROM_WHERE is an integer saying from where this function was
13998 called. This is useful for debugging. */
14001 redisplay_preserve_echo_area (int from_where
)
14003 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14005 if (!NILP (echo_area_buffer
[1]))
14007 /* We have a previously displayed message, but no current
14008 message. Redisplay the previous message. */
14009 display_last_displayed_message_p
= true;
14010 redisplay_internal ();
14011 display_last_displayed_message_p
= false;
14014 redisplay_internal ();
14016 flush_frame (SELECTED_FRAME ());
14020 /* Function registered with record_unwind_protect in redisplay_internal. */
14023 unwind_redisplay (void)
14025 redisplaying_p
= false;
14029 /* Mark the display of leaf window W as accurate or inaccurate.
14030 If ACCURATE_P, mark display of W as accurate.
14031 If !ACCURATE_P, arrange for W to be redisplayed the next
14032 time redisplay_internal is called. */
14035 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14037 struct buffer
*b
= XBUFFER (w
->contents
);
14039 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14040 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14041 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14045 b
->clip_changed
= false;
14046 b
->prevent_redisplay_optimizations_p
= false;
14047 eassert (buffer_window_count (b
) > 0);
14048 /* Resetting b->text->redisplay is problematic!
14049 In order to make it safer to do it here, redisplay_internal must
14050 have copied all b->text->redisplay to their respective windows. */
14051 b
->text
->redisplay
= false;
14053 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14054 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14055 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14056 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14058 w
->current_matrix
->buffer
= b
;
14059 w
->current_matrix
->begv
= BUF_BEGV (b
);
14060 w
->current_matrix
->zv
= BUF_ZV (b
);
14062 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14063 w
->last_cursor_off_p
= w
->cursor_off_p
;
14065 if (w
== XWINDOW (selected_window
))
14066 w
->last_point
= BUF_PT (b
);
14068 w
->last_point
= marker_position (w
->pointm
);
14070 w
->window_end_valid
= true;
14071 w
->update_mode_line
= false;
14074 w
->redisplay
= !accurate_p
;
14078 /* Mark the display of windows in the window tree rooted at WINDOW as
14079 accurate or inaccurate. If ACCURATE_P, mark display of
14080 windows as accurate. If !ACCURATE_P, arrange for windows to
14081 be redisplayed the next time redisplay_internal is called. */
14084 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14088 for (; !NILP (window
); window
= w
->next
)
14090 w
= XWINDOW (window
);
14091 if (WINDOWP (w
->contents
))
14092 mark_window_display_accurate (w
->contents
, accurate_p
);
14094 mark_window_display_accurate_1 (w
, accurate_p
);
14098 update_overlay_arrows (1);
14100 /* Force a thorough redisplay the next time by setting
14101 last_arrow_position and last_arrow_string to t, which is
14102 unequal to any useful value of Voverlay_arrow_... */
14103 update_overlay_arrows (-1);
14107 /* Return value in display table DP (Lisp_Char_Table *) for character
14108 C. Since a display table doesn't have any parent, we don't have to
14109 follow parent. Do not call this function directly but use the
14110 macro DISP_CHAR_VECTOR. */
14113 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14117 if (ASCII_CHAR_P (c
))
14120 if (SUB_CHAR_TABLE_P (val
))
14121 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14127 XSETCHAR_TABLE (table
, dp
);
14128 val
= char_table_ref (table
, c
);
14137 /***********************************************************************
14139 ***********************************************************************/
14141 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14144 redisplay_windows (Lisp_Object window
)
14146 while (!NILP (window
))
14148 struct window
*w
= XWINDOW (window
);
14150 if (WINDOWP (w
->contents
))
14151 redisplay_windows (w
->contents
);
14152 else if (BUFFERP (w
->contents
))
14154 displayed_buffer
= XBUFFER (w
->contents
);
14155 /* Use list_of_error, not Qerror, so that
14156 we catch only errors and don't run the debugger. */
14157 internal_condition_case_1 (redisplay_window_0
, window
,
14159 redisplay_window_error
);
14167 redisplay_window_error (Lisp_Object ignore
)
14169 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14174 redisplay_window_0 (Lisp_Object window
)
14176 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14177 redisplay_window (window
, false);
14182 redisplay_window_1 (Lisp_Object window
)
14184 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14185 redisplay_window (window
, true);
14190 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14191 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14192 which positions recorded in ROW differ from current buffer
14195 Return true iff cursor is on this row. */
14198 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14199 struct glyph_matrix
*matrix
,
14200 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14203 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14204 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14205 struct glyph
*cursor
= NULL
;
14206 /* The last known character position in row. */
14207 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14209 ptrdiff_t pt_old
= PT
- delta
;
14210 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14211 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14212 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14213 /* A glyph beyond the edge of TEXT_AREA which we should never
14215 struct glyph
*glyphs_end
= end
;
14216 /* True means we've found a match for cursor position, but that
14217 glyph has the avoid_cursor_p flag set. */
14218 bool match_with_avoid_cursor
= false;
14219 /* True means we've seen at least one glyph that came from a
14221 bool string_seen
= false;
14222 /* Largest and smallest buffer positions seen so far during scan of
14224 ptrdiff_t bpos_max
= pos_before
;
14225 ptrdiff_t bpos_min
= pos_after
;
14226 /* Last buffer position covered by an overlay string with an integer
14227 `cursor' property. */
14228 ptrdiff_t bpos_covered
= 0;
14229 /* True means the display string on which to display the cursor
14230 comes from a text property, not from an overlay. */
14231 bool string_from_text_prop
= false;
14233 /* Don't even try doing anything if called for a mode-line or
14234 header-line row, since the rest of the code isn't prepared to
14235 deal with such calamities. */
14236 eassert (!row
->mode_line_p
);
14237 if (row
->mode_line_p
)
14240 /* Skip over glyphs not having an object at the start and the end of
14241 the row. These are special glyphs like truncation marks on
14242 terminal frames. */
14243 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14245 if (!row
->reversed_p
)
14248 && NILP (glyph
->object
)
14249 && glyph
->charpos
< 0)
14251 x
+= glyph
->pixel_width
;
14255 && NILP ((end
- 1)->object
)
14256 /* CHARPOS is zero for blanks and stretch glyphs
14257 inserted by extend_face_to_end_of_line. */
14258 && (end
- 1)->charpos
<= 0)
14260 glyph_before
= glyph
- 1;
14267 /* If the glyph row is reversed, we need to process it from back
14268 to front, so swap the edge pointers. */
14269 glyphs_end
= end
= glyph
- 1;
14270 glyph
+= row
->used
[TEXT_AREA
] - 1;
14272 while (glyph
> end
+ 1
14273 && NILP (glyph
->object
)
14274 && glyph
->charpos
< 0)
14277 x
-= glyph
->pixel_width
;
14279 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14281 /* By default, in reversed rows we put the cursor on the
14282 rightmost (first in the reading order) glyph. */
14283 for (g
= end
+ 1; g
< glyph
; g
++)
14284 x
+= g
->pixel_width
;
14286 && NILP ((end
+ 1)->object
)
14287 && (end
+ 1)->charpos
<= 0)
14289 glyph_before
= glyph
+ 1;
14293 else if (row
->reversed_p
)
14295 /* In R2L rows that don't display text, put the cursor on the
14296 rightmost glyph. Case in point: an empty last line that is
14297 part of an R2L paragraph. */
14299 /* Avoid placing the cursor on the last glyph of the row, where
14300 on terminal frames we hold the vertical border between
14301 adjacent windows. */
14302 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14303 && !WINDOW_RIGHTMOST_P (w
)
14304 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14306 x
= -1; /* will be computed below, at label compute_x */
14309 /* Step 1: Try to find the glyph whose character position
14310 corresponds to point. If that's not possible, find 2 glyphs
14311 whose character positions are the closest to point, one before
14312 point, the other after it. */
14313 if (!row
->reversed_p
)
14314 while (/* not marched to end of glyph row */
14316 /* glyph was not inserted by redisplay for internal purposes */
14317 && !NILP (glyph
->object
))
14319 if (BUFFERP (glyph
->object
))
14321 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14323 if (glyph
->charpos
> bpos_max
)
14324 bpos_max
= glyph
->charpos
;
14325 if (glyph
->charpos
< bpos_min
)
14326 bpos_min
= glyph
->charpos
;
14327 if (!glyph
->avoid_cursor_p
)
14329 /* If we hit point, we've found the glyph on which to
14330 display the cursor. */
14333 match_with_avoid_cursor
= false;
14336 /* See if we've found a better approximation to
14337 POS_BEFORE or to POS_AFTER. */
14338 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14340 pos_before
= glyph
->charpos
;
14341 glyph_before
= glyph
;
14343 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14345 pos_after
= glyph
->charpos
;
14346 glyph_after
= glyph
;
14349 else if (dpos
== 0)
14350 match_with_avoid_cursor
= true;
14352 else if (STRINGP (glyph
->object
))
14354 Lisp_Object chprop
;
14355 ptrdiff_t glyph_pos
= glyph
->charpos
;
14357 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14359 if (!NILP (chprop
))
14361 /* If the string came from a `display' text property,
14362 look up the buffer position of that property and
14363 use that position to update bpos_max, as if we
14364 actually saw such a position in one of the row's
14365 glyphs. This helps with supporting integer values
14366 of `cursor' property on the display string in
14367 situations where most or all of the row's buffer
14368 text is completely covered by display properties,
14369 so that no glyph with valid buffer positions is
14370 ever seen in the row. */
14371 ptrdiff_t prop_pos
=
14372 string_buffer_position_lim (glyph
->object
, pos_before
,
14375 if (prop_pos
>= pos_before
)
14376 bpos_max
= prop_pos
;
14378 if (INTEGERP (chprop
))
14380 bpos_covered
= bpos_max
+ XINT (chprop
);
14381 /* If the `cursor' property covers buffer positions up
14382 to and including point, we should display cursor on
14383 this glyph. Note that, if a `cursor' property on one
14384 of the string's characters has an integer value, we
14385 will break out of the loop below _before_ we get to
14386 the position match above. IOW, integer values of
14387 the `cursor' property override the "exact match for
14388 point" strategy of positioning the cursor. */
14389 /* Implementation note: bpos_max == pt_old when, e.g.,
14390 we are in an empty line, where bpos_max is set to
14391 MATRIX_ROW_START_CHARPOS, see above. */
14392 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14399 string_seen
= true;
14401 x
+= glyph
->pixel_width
;
14404 else if (glyph
> end
) /* row is reversed */
14405 while (!NILP (glyph
->object
))
14407 if (BUFFERP (glyph
->object
))
14409 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14411 if (glyph
->charpos
> bpos_max
)
14412 bpos_max
= glyph
->charpos
;
14413 if (glyph
->charpos
< bpos_min
)
14414 bpos_min
= glyph
->charpos
;
14415 if (!glyph
->avoid_cursor_p
)
14419 match_with_avoid_cursor
= false;
14422 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14424 pos_before
= glyph
->charpos
;
14425 glyph_before
= glyph
;
14427 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14429 pos_after
= glyph
->charpos
;
14430 glyph_after
= glyph
;
14433 else if (dpos
== 0)
14434 match_with_avoid_cursor
= true;
14436 else if (STRINGP (glyph
->object
))
14438 Lisp_Object chprop
;
14439 ptrdiff_t glyph_pos
= glyph
->charpos
;
14441 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14443 if (!NILP (chprop
))
14445 ptrdiff_t prop_pos
=
14446 string_buffer_position_lim (glyph
->object
, pos_before
,
14449 if (prop_pos
>= pos_before
)
14450 bpos_max
= prop_pos
;
14452 if (INTEGERP (chprop
))
14454 bpos_covered
= bpos_max
+ XINT (chprop
);
14455 /* If the `cursor' property covers buffer positions up
14456 to and including point, we should display cursor on
14458 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14464 string_seen
= true;
14467 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14469 x
--; /* can't use any pixel_width */
14472 x
-= glyph
->pixel_width
;
14475 /* Step 2: If we didn't find an exact match for point, we need to
14476 look for a proper place to put the cursor among glyphs between
14477 GLYPH_BEFORE and GLYPH_AFTER. */
14478 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14479 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14480 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14482 /* An empty line has a single glyph whose OBJECT is nil and
14483 whose CHARPOS is the position of a newline on that line.
14484 Note that on a TTY, there are more glyphs after that, which
14485 were produced by extend_face_to_end_of_line, but their
14486 CHARPOS is zero or negative. */
14487 bool empty_line_p
=
14488 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14489 && NILP (glyph
->object
) && glyph
->charpos
> 0
14490 /* On a TTY, continued and truncated rows also have a glyph at
14491 their end whose OBJECT is nil and whose CHARPOS is
14492 positive (the continuation and truncation glyphs), but such
14493 rows are obviously not "empty". */
14494 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14496 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14498 ptrdiff_t ellipsis_pos
;
14500 /* Scan back over the ellipsis glyphs. */
14501 if (!row
->reversed_p
)
14503 ellipsis_pos
= (glyph
- 1)->charpos
;
14504 while (glyph
> row
->glyphs
[TEXT_AREA
]
14505 && (glyph
- 1)->charpos
== ellipsis_pos
)
14506 glyph
--, x
-= glyph
->pixel_width
;
14507 /* That loop always goes one position too far, including
14508 the glyph before the ellipsis. So scan forward over
14510 x
+= glyph
->pixel_width
;
14513 else /* row is reversed */
14515 ellipsis_pos
= (glyph
+ 1)->charpos
;
14516 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14517 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14518 glyph
++, x
+= glyph
->pixel_width
;
14519 x
-= glyph
->pixel_width
;
14523 else if (match_with_avoid_cursor
)
14525 cursor
= glyph_after
;
14528 else if (string_seen
)
14530 int incr
= row
->reversed_p
? -1 : +1;
14532 /* Need to find the glyph that came out of a string which is
14533 present at point. That glyph is somewhere between
14534 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14535 positioned between POS_BEFORE and POS_AFTER in the
14537 struct glyph
*start
, *stop
;
14538 ptrdiff_t pos
= pos_before
;
14542 /* If the row ends in a newline from a display string,
14543 reordering could have moved the glyphs belonging to the
14544 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14545 in this case we extend the search to the last glyph in
14546 the row that was not inserted by redisplay. */
14547 if (row
->ends_in_newline_from_string_p
)
14550 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14553 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14554 correspond to POS_BEFORE and POS_AFTER, respectively. We
14555 need START and STOP in the order that corresponds to the
14556 row's direction as given by its reversed_p flag. If the
14557 directionality of characters between POS_BEFORE and
14558 POS_AFTER is the opposite of the row's base direction,
14559 these characters will have been reordered for display,
14560 and we need to reverse START and STOP. */
14561 if (!row
->reversed_p
)
14563 start
= min (glyph_before
, glyph_after
);
14564 stop
= max (glyph_before
, glyph_after
);
14568 start
= max (glyph_before
, glyph_after
);
14569 stop
= min (glyph_before
, glyph_after
);
14571 for (glyph
= start
+ incr
;
14572 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14575 /* Any glyphs that come from the buffer are here because
14576 of bidi reordering. Skip them, and only pay
14577 attention to glyphs that came from some string. */
14578 if (STRINGP (glyph
->object
))
14582 /* If the display property covers the newline, we
14583 need to search for it one position farther. */
14584 ptrdiff_t lim
= pos_after
14585 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14587 string_from_text_prop
= false;
14588 str
= glyph
->object
;
14589 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14590 if (tem
== 0 /* from overlay */
14593 /* If the string from which this glyph came is
14594 found in the buffer at point, or at position
14595 that is closer to point than pos_after, then
14596 we've found the glyph we've been looking for.
14597 If it comes from an overlay (tem == 0), and
14598 it has the `cursor' property on one of its
14599 glyphs, record that glyph as a candidate for
14600 displaying the cursor. (As in the
14601 unidirectional version, we will display the
14602 cursor on the last candidate we find.) */
14605 || (tem
- pt_old
> 0 && tem
< pos_after
))
14607 /* The glyphs from this string could have
14608 been reordered. Find the one with the
14609 smallest string position. Or there could
14610 be a character in the string with the
14611 `cursor' property, which means display
14612 cursor on that character's glyph. */
14613 ptrdiff_t strpos
= glyph
->charpos
;
14618 string_from_text_prop
= true;
14621 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14622 && EQ (glyph
->object
, str
);
14626 ptrdiff_t gpos
= glyph
->charpos
;
14628 cprop
= Fget_char_property (make_number (gpos
),
14636 if (tem
&& glyph
->charpos
< strpos
)
14638 strpos
= glyph
->charpos
;
14644 || (tem
- pt_old
> 0 && tem
< pos_after
))
14648 pos
= tem
+ 1; /* don't find previous instances */
14650 /* This string is not what we want; skip all of the
14651 glyphs that came from it. */
14652 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14653 && EQ (glyph
->object
, str
))
14660 /* If we reached the end of the line, and END was from a string,
14661 the cursor is not on this line. */
14663 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14664 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14665 && STRINGP (end
->object
)
14666 && row
->continued_p
)
14669 /* A truncated row may not include PT among its character positions.
14670 Setting the cursor inside the scroll margin will trigger
14671 recalculation of hscroll in hscroll_window_tree. But if a
14672 display string covers point, defer to the string-handling
14673 code below to figure this out. */
14674 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14676 cursor
= glyph_before
;
14679 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14680 /* Zero-width characters produce no glyphs. */
14682 && (row
->reversed_p
14683 ? glyph_after
> glyphs_end
14684 : glyph_after
< glyphs_end
)))
14686 cursor
= glyph_after
;
14692 if (cursor
!= NULL
)
14694 else if (glyph
== glyphs_end
14695 && pos_before
== pos_after
14696 && STRINGP ((row
->reversed_p
14697 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14698 : row
->glyphs
[TEXT_AREA
])->object
))
14700 /* If all the glyphs of this row came from strings, put the
14701 cursor on the first glyph of the row. This avoids having the
14702 cursor outside of the text area in this very rare and hard
14706 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14707 : row
->glyphs
[TEXT_AREA
];
14713 /* Need to compute x that corresponds to GLYPH. */
14714 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14716 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14718 x
+= g
->pixel_width
;
14722 /* ROW could be part of a continued line, which, under bidi
14723 reordering, might have other rows whose start and end charpos
14724 occlude point. Only set w->cursor if we found a better
14725 approximation to the cursor position than we have from previously
14726 examined candidate rows belonging to the same continued line. */
14727 if (/* We already have a candidate row. */
14728 w
->cursor
.vpos
>= 0
14729 /* That candidate is not the row we are processing. */
14730 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14731 /* Make sure cursor.vpos specifies a row whose start and end
14732 charpos occlude point, and it is valid candidate for being a
14733 cursor-row. This is because some callers of this function
14734 leave cursor.vpos at the row where the cursor was displayed
14735 during the last redisplay cycle. */
14736 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14737 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14738 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14741 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14743 /* Don't consider glyphs that are outside TEXT_AREA. */
14744 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14746 /* Keep the candidate whose buffer position is the closest to
14747 point or has the `cursor' property. */
14748 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14749 w
->cursor
.hpos
>= 0
14750 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14751 && ((BUFFERP (g1
->object
)
14752 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14753 || (BUFFERP (glyph
->object
)
14754 && eabs (g1
->charpos
- pt_old
)
14755 < eabs (glyph
->charpos
- pt_old
))))
14756 /* Previous candidate is a glyph from a string that has
14757 a non-nil `cursor' property. */
14758 || (STRINGP (g1
->object
)
14759 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14760 Qcursor
, g1
->object
))
14761 /* Previous candidate is from the same display
14762 string as this one, and the display string
14763 came from a text property. */
14764 || (EQ (g1
->object
, glyph
->object
)
14765 && string_from_text_prop
)
14766 /* this candidate is from newline and its
14767 position is not an exact match */
14768 || (NILP (glyph
->object
)
14769 && glyph
->charpos
!= pt_old
)))))
14771 /* If this candidate gives an exact match, use that. */
14772 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14773 /* If this candidate is a glyph created for the
14774 terminating newline of a line, and point is on that
14775 newline, it wins because it's an exact match. */
14776 || (!row
->continued_p
14777 && NILP (glyph
->object
)
14778 && glyph
->charpos
== 0
14779 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14780 /* Otherwise, keep the candidate that comes from a row
14781 spanning less buffer positions. This may win when one or
14782 both candidate positions are on glyphs that came from
14783 display strings, for which we cannot compare buffer
14785 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14786 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14787 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14790 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14792 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14793 w
->cursor
.y
= row
->y
+ dy
;
14795 if (w
== XWINDOW (selected_window
))
14797 if (!row
->continued_p
14798 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14801 this_line_buffer
= XBUFFER (w
->contents
);
14803 CHARPOS (this_line_start_pos
)
14804 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14805 BYTEPOS (this_line_start_pos
)
14806 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14808 CHARPOS (this_line_end_pos
)
14809 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14810 BYTEPOS (this_line_end_pos
)
14811 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14813 this_line_y
= w
->cursor
.y
;
14814 this_line_pixel_height
= row
->height
;
14815 this_line_vpos
= w
->cursor
.vpos
;
14816 this_line_start_x
= row
->x
;
14819 CHARPOS (this_line_start_pos
) = 0;
14826 /* Run window scroll functions, if any, for WINDOW with new window
14827 start STARTP. Sets the window start of WINDOW to that position.
14829 We assume that the window's buffer is really current. */
14831 static struct text_pos
14832 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14834 struct window
*w
= XWINDOW (window
);
14835 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14837 eassert (current_buffer
== XBUFFER (w
->contents
));
14839 if (!NILP (Vwindow_scroll_functions
))
14841 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14842 make_number (CHARPOS (startp
)));
14843 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14844 /* In case the hook functions switch buffers. */
14845 set_buffer_internal (XBUFFER (w
->contents
));
14852 /* Make sure the line containing the cursor is fully visible.
14853 A value of true means there is nothing to be done.
14854 (Either the line is fully visible, or it cannot be made so,
14855 or we cannot tell.)
14857 If FORCE_P, return false even if partial visible cursor row
14858 is higher than window.
14860 If CURRENT_MATRIX_P, use the information from the
14861 window's current glyph matrix; otherwise use the desired glyph
14864 A value of false means the caller should do scrolling
14865 as if point had gone off the screen. */
14868 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14869 bool current_matrix_p
)
14871 struct glyph_matrix
*matrix
;
14872 struct glyph_row
*row
;
14875 if (!make_cursor_line_fully_visible_p
)
14878 /* It's not always possible to find the cursor, e.g, when a window
14879 is full of overlay strings. Don't do anything in that case. */
14880 if (w
->cursor
.vpos
< 0)
14883 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14884 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14886 /* If the cursor row is not partially visible, there's nothing to do. */
14887 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14890 /* If the row the cursor is in is taller than the window's height,
14891 it's not clear what to do, so do nothing. */
14892 window_height
= window_box_height (w
);
14893 if (row
->height
>= window_height
)
14895 if (!force_p
|| MINI_WINDOW_P (w
)
14896 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14903 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14904 means only WINDOW is redisplayed in redisplay_internal.
14905 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14906 in redisplay_window to bring a partially visible line into view in
14907 the case that only the cursor has moved.
14909 LAST_LINE_MISFIT should be true if we're scrolling because the
14910 last screen line's vertical height extends past the end of the screen.
14914 1 if scrolling succeeded
14916 0 if scrolling didn't find point.
14918 -1 if new fonts have been loaded so that we must interrupt
14919 redisplay, adjust glyph matrices, and try again. */
14925 SCROLLING_NEED_LARGER_MATRICES
14928 /* If scroll-conservatively is more than this, never recenter.
14930 If you change this, don't forget to update the doc string of
14931 `scroll-conservatively' and the Emacs manual. */
14932 #define SCROLL_LIMIT 100
14935 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14936 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14937 bool temp_scroll_step
, bool last_line_misfit
)
14939 struct window
*w
= XWINDOW (window
);
14940 struct frame
*f
= XFRAME (w
->frame
);
14941 struct text_pos pos
, startp
;
14943 int this_scroll_margin
, scroll_max
, rc
, height
;
14944 int dy
= 0, amount_to_scroll
= 0;
14945 bool scroll_down_p
= false;
14946 int extra_scroll_margin_lines
= last_line_misfit
;
14947 Lisp_Object aggressive
;
14948 /* We will never try scrolling more than this number of lines. */
14949 int scroll_limit
= SCROLL_LIMIT
;
14950 int frame_line_height
= default_line_pixel_height (w
);
14951 int window_total_lines
14952 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14955 debug_method_add (w
, "try_scrolling");
14958 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14960 /* Compute scroll margin height in pixels. We scroll when point is
14961 within this distance from the top or bottom of the window. */
14962 if (scroll_margin
> 0)
14963 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14964 * frame_line_height
;
14966 this_scroll_margin
= 0;
14968 /* Force arg_scroll_conservatively to have a reasonable value, to
14969 avoid scrolling too far away with slow move_it_* functions. Note
14970 that the user can supply scroll-conservatively equal to
14971 `most-positive-fixnum', which can be larger than INT_MAX. */
14972 if (arg_scroll_conservatively
> scroll_limit
)
14974 arg_scroll_conservatively
= scroll_limit
+ 1;
14975 scroll_max
= scroll_limit
* frame_line_height
;
14977 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14978 /* Compute how much we should try to scroll maximally to bring
14979 point into view. */
14980 scroll_max
= (max (scroll_step
,
14981 max (arg_scroll_conservatively
, temp_scroll_step
))
14982 * frame_line_height
);
14983 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14984 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14985 /* We're trying to scroll because of aggressive scrolling but no
14986 scroll_step is set. Choose an arbitrary one. */
14987 scroll_max
= 10 * frame_line_height
;
14993 /* Decide whether to scroll down. */
14994 if (PT
> CHARPOS (startp
))
14996 int scroll_margin_y
;
14998 /* Compute the pixel ypos of the scroll margin, then move IT to
14999 either that ypos or PT, whichever comes first. */
15000 start_display (&it
, w
, startp
);
15001 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15002 - frame_line_height
* extra_scroll_margin_lines
;
15003 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15004 (MOVE_TO_POS
| MOVE_TO_Y
));
15006 if (PT
> CHARPOS (it
.current
.pos
))
15008 int y0
= line_bottom_y (&it
);
15009 /* Compute how many pixels below window bottom to stop searching
15010 for PT. This avoids costly search for PT that is far away if
15011 the user limited scrolling by a small number of lines, but
15012 always finds PT if scroll_conservatively is set to a large
15013 number, such as most-positive-fixnum. */
15014 int slack
= max (scroll_max
, 10 * frame_line_height
);
15015 int y_to_move
= it
.last_visible_y
+ slack
;
15017 /* Compute the distance from the scroll margin to PT or to
15018 the scroll limit, whichever comes first. This should
15019 include the height of the cursor line, to make that line
15021 move_it_to (&it
, PT
, -1, y_to_move
,
15022 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15023 dy
= line_bottom_y (&it
) - y0
;
15025 if (dy
> scroll_max
)
15026 return SCROLLING_FAILED
;
15029 scroll_down_p
= true;
15035 /* Point is in or below the bottom scroll margin, so move the
15036 window start down. If scrolling conservatively, move it just
15037 enough down to make point visible. If scroll_step is set,
15038 move it down by scroll_step. */
15039 if (arg_scroll_conservatively
)
15041 = min (max (dy
, frame_line_height
),
15042 frame_line_height
* arg_scroll_conservatively
);
15043 else if (scroll_step
|| temp_scroll_step
)
15044 amount_to_scroll
= scroll_max
;
15047 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15048 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15049 if (NUMBERP (aggressive
))
15051 double float_amount
= XFLOATINT (aggressive
) * height
;
15052 int aggressive_scroll
= float_amount
;
15053 if (aggressive_scroll
== 0 && float_amount
> 0)
15054 aggressive_scroll
= 1;
15055 /* Don't let point enter the scroll margin near top of
15056 the window. This could happen if the value of
15057 scroll_up_aggressively is too large and there are
15058 non-zero margins, because scroll_up_aggressively
15059 means put point that fraction of window height
15060 _from_the_bottom_margin_. */
15061 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15062 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15063 amount_to_scroll
= dy
+ aggressive_scroll
;
15067 if (amount_to_scroll
<= 0)
15068 return SCROLLING_FAILED
;
15070 start_display (&it
, w
, startp
);
15071 if (arg_scroll_conservatively
<= scroll_limit
)
15072 move_it_vertically (&it
, amount_to_scroll
);
15075 /* Extra precision for users who set scroll-conservatively
15076 to a large number: make sure the amount we scroll
15077 the window start is never less than amount_to_scroll,
15078 which was computed as distance from window bottom to
15079 point. This matters when lines at window top and lines
15080 below window bottom have different height. */
15082 void *it1data
= NULL
;
15083 /* We use a temporary it1 because line_bottom_y can modify
15084 its argument, if it moves one line down; see there. */
15087 SAVE_IT (it1
, it
, it1data
);
15088 start_y
= line_bottom_y (&it1
);
15090 RESTORE_IT (&it
, &it
, it1data
);
15091 move_it_by_lines (&it
, 1);
15092 SAVE_IT (it1
, it
, it1data
);
15093 } while (IT_CHARPOS (it
) < ZV
15094 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15095 bidi_unshelve_cache (it1data
, true);
15098 /* If STARTP is unchanged, move it down another screen line. */
15099 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15100 move_it_by_lines (&it
, 1);
15101 startp
= it
.current
.pos
;
15105 struct text_pos scroll_margin_pos
= startp
;
15108 /* See if point is inside the scroll margin at the top of the
15110 if (this_scroll_margin
)
15114 start_display (&it
, w
, startp
);
15115 y_start
= it
.current_y
;
15116 move_it_vertically (&it
, this_scroll_margin
);
15117 scroll_margin_pos
= it
.current
.pos
;
15118 /* If we didn't move enough before hitting ZV, request
15119 additional amount of scroll, to move point out of the
15121 if (IT_CHARPOS (it
) == ZV
15122 && it
.current_y
- y_start
< this_scroll_margin
)
15123 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15126 if (PT
< CHARPOS (scroll_margin_pos
))
15128 /* Point is in the scroll margin at the top of the window or
15129 above what is displayed in the window. */
15132 /* Compute the vertical distance from PT to the scroll
15133 margin position. Move as far as scroll_max allows, or
15134 one screenful, or 10 screen lines, whichever is largest.
15135 Give up if distance is greater than scroll_max or if we
15136 didn't reach the scroll margin position. */
15137 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15138 start_display (&it
, w
, pos
);
15140 y_to_move
= max (it
.last_visible_y
,
15141 max (scroll_max
, 10 * frame_line_height
));
15142 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15144 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15145 dy
= it
.current_y
- y0
;
15146 if (dy
> scroll_max
15147 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15148 return SCROLLING_FAILED
;
15150 /* Additional scroll for when ZV was too close to point. */
15153 /* Compute new window start. */
15154 start_display (&it
, w
, startp
);
15156 if (arg_scroll_conservatively
)
15157 amount_to_scroll
= max (dy
, frame_line_height
15158 * max (scroll_step
, temp_scroll_step
));
15159 else if (scroll_step
|| temp_scroll_step
)
15160 amount_to_scroll
= scroll_max
;
15163 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15164 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15165 if (NUMBERP (aggressive
))
15167 double float_amount
= XFLOATINT (aggressive
) * height
;
15168 int aggressive_scroll
= float_amount
;
15169 if (aggressive_scroll
== 0 && float_amount
> 0)
15170 aggressive_scroll
= 1;
15171 /* Don't let point enter the scroll margin near
15172 bottom of the window, if the value of
15173 scroll_down_aggressively happens to be too
15175 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15176 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15177 amount_to_scroll
= dy
+ aggressive_scroll
;
15181 if (amount_to_scroll
<= 0)
15182 return SCROLLING_FAILED
;
15184 move_it_vertically_backward (&it
, amount_to_scroll
);
15185 startp
= it
.current
.pos
;
15189 /* Run window scroll functions. */
15190 startp
= run_window_scroll_functions (window
, startp
);
15192 /* Display the window. Give up if new fonts are loaded, or if point
15194 if (!try_window (window
, startp
, 0))
15195 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15196 else if (w
->cursor
.vpos
< 0)
15198 clear_glyph_matrix (w
->desired_matrix
);
15199 rc
= SCROLLING_FAILED
;
15203 /* Maybe forget recorded base line for line number display. */
15204 if (!just_this_one_p
15205 || current_buffer
->clip_changed
15206 || BEG_UNCHANGED
< CHARPOS (startp
))
15207 w
->base_line_number
= 0;
15209 /* If cursor ends up on a partially visible line,
15210 treat that as being off the bottom of the screen. */
15211 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15213 /* It's possible that the cursor is on the first line of the
15214 buffer, which is partially obscured due to a vscroll
15215 (Bug#7537). In that case, avoid looping forever. */
15216 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15218 clear_glyph_matrix (w
->desired_matrix
);
15219 ++extra_scroll_margin_lines
;
15222 rc
= SCROLLING_SUCCESS
;
15229 /* Compute a suitable window start for window W if display of W starts
15230 on a continuation line. Value is true if a new window start
15233 The new window start will be computed, based on W's width, starting
15234 from the start of the continued line. It is the start of the
15235 screen line with the minimum distance from the old start W->start. */
15238 compute_window_start_on_continuation_line (struct window
*w
)
15240 struct text_pos pos
, start_pos
;
15241 bool window_start_changed_p
= false;
15243 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15245 /* If window start is on a continuation line... Window start may be
15246 < BEGV in case there's invisible text at the start of the
15247 buffer (M-x rmail, for example). */
15248 if (CHARPOS (start_pos
) > BEGV
15249 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15252 struct glyph_row
*row
;
15254 /* Handle the case that the window start is out of range. */
15255 if (CHARPOS (start_pos
) < BEGV
)
15256 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15257 else if (CHARPOS (start_pos
) > ZV
)
15258 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15260 /* Find the start of the continued line. This should be fast
15261 because find_newline is fast (newline cache). */
15262 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15263 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15264 row
, DEFAULT_FACE_ID
);
15265 reseat_at_previous_visible_line_start (&it
);
15267 /* If the line start is "too far" away from the window start,
15268 say it takes too much time to compute a new window start. */
15269 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15270 /* PXW: Do we need upper bounds here? */
15271 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15273 int min_distance
, distance
;
15275 /* Move forward by display lines to find the new window
15276 start. If window width was enlarged, the new start can
15277 be expected to be > the old start. If window width was
15278 decreased, the new window start will be < the old start.
15279 So, we're looking for the display line start with the
15280 minimum distance from the old window start. */
15281 pos
= it
.current
.pos
;
15282 min_distance
= INFINITY
;
15283 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15284 distance
< min_distance
)
15286 min_distance
= distance
;
15287 pos
= it
.current
.pos
;
15288 if (it
.line_wrap
== WORD_WRAP
)
15290 /* Under WORD_WRAP, move_it_by_lines is likely to
15291 overshoot and stop not at the first, but the
15292 second character from the left margin. So in
15293 that case, we need a more tight control on the X
15294 coordinate of the iterator than move_it_by_lines
15295 promises in its contract. The method is to first
15296 go to the last (rightmost) visible character of a
15297 line, then move to the leftmost character on the
15298 next line in a separate call. */
15299 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15300 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15301 move_it_to (&it
, ZV
, 0,
15302 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15303 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15306 move_it_by_lines (&it
, 1);
15309 /* Set the window start there. */
15310 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15311 window_start_changed_p
= true;
15315 return window_start_changed_p
;
15319 /* Try cursor movement in case text has not changed in window WINDOW,
15320 with window start STARTP. Value is
15322 CURSOR_MOVEMENT_SUCCESS if successful
15324 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15326 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15327 display. *SCROLL_STEP is set to true, under certain circumstances, if
15328 we want to scroll as if scroll-step were set to 1. See the code.
15330 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15331 which case we have to abort this redisplay, and adjust matrices
15336 CURSOR_MOVEMENT_SUCCESS
,
15337 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15338 CURSOR_MOVEMENT_MUST_SCROLL
,
15339 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15343 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15346 struct window
*w
= XWINDOW (window
);
15347 struct frame
*f
= XFRAME (w
->frame
);
15348 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15351 if (inhibit_try_cursor_movement
)
15355 /* Previously, there was a check for Lisp integer in the
15356 if-statement below. Now, this field is converted to
15357 ptrdiff_t, thus zero means invalid position in a buffer. */
15358 eassert (w
->last_point
> 0);
15359 /* Likewise there was a check whether window_end_vpos is nil or larger
15360 than the window. Now window_end_vpos is int and so never nil, but
15361 let's leave eassert to check whether it fits in the window. */
15362 eassert (!w
->window_end_valid
15363 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15365 /* Handle case where text has not changed, only point, and it has
15366 not moved off the frame. */
15367 if (/* Point may be in this window. */
15368 PT
>= CHARPOS (startp
)
15369 /* Selective display hasn't changed. */
15370 && !current_buffer
->clip_changed
15371 /* Function force-mode-line-update is used to force a thorough
15372 redisplay. It sets either windows_or_buffers_changed or
15373 update_mode_lines. So don't take a shortcut here for these
15375 && !update_mode_lines
15376 && !windows_or_buffers_changed
15377 && !f
->cursor_type_changed
15378 && NILP (Vshow_trailing_whitespace
)
15379 /* This code is not used for mini-buffer for the sake of the case
15380 of redisplaying to replace an echo area message; since in
15381 that case the mini-buffer contents per se are usually
15382 unchanged. This code is of no real use in the mini-buffer
15383 since the handling of this_line_start_pos, etc., in redisplay
15384 handles the same cases. */
15385 && !EQ (window
, minibuf_window
)
15386 && (FRAME_WINDOW_P (f
)
15387 || !overlay_arrow_in_current_buffer_p ()))
15389 int this_scroll_margin
, top_scroll_margin
;
15390 struct glyph_row
*row
= NULL
;
15391 int frame_line_height
= default_line_pixel_height (w
);
15392 int window_total_lines
15393 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15396 debug_method_add (w
, "cursor movement");
15399 /* Scroll if point within this distance from the top or bottom
15400 of the window. This is a pixel value. */
15401 if (scroll_margin
> 0)
15403 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15404 this_scroll_margin
*= frame_line_height
;
15407 this_scroll_margin
= 0;
15409 top_scroll_margin
= this_scroll_margin
;
15410 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15411 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15413 /* Start with the row the cursor was displayed during the last
15414 not paused redisplay. Give up if that row is not valid. */
15415 if (w
->last_cursor_vpos
< 0
15416 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15417 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15420 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15421 if (row
->mode_line_p
)
15423 if (!row
->enabled_p
)
15424 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15427 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15429 bool scroll_p
= false, must_scroll
= false;
15430 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15432 if (PT
> w
->last_point
)
15434 /* Point has moved forward. */
15435 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15436 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15438 eassert (row
->enabled_p
);
15442 /* If the end position of a row equals the start
15443 position of the next row, and PT is at that position,
15444 we would rather display cursor in the next line. */
15445 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15446 && MATRIX_ROW_END_CHARPOS (row
) == PT
15447 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15448 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15449 && !cursor_row_p (row
))
15452 /* If within the scroll margin, scroll. Note that
15453 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15454 the next line would be drawn, and that
15455 this_scroll_margin can be zero. */
15456 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15457 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15458 /* Line is completely visible last line in window
15459 and PT is to be set in the next line. */
15460 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15461 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15462 && !row
->ends_at_zv_p
15463 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15466 else if (PT
< w
->last_point
)
15468 /* Cursor has to be moved backward. Note that PT >=
15469 CHARPOS (startp) because of the outer if-statement. */
15470 while (!row
->mode_line_p
15471 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15472 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15473 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15474 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15475 row
> w
->current_matrix
->rows
15476 && (row
-1)->ends_in_newline_from_string_p
))))
15477 && (row
->y
> top_scroll_margin
15478 || CHARPOS (startp
) == BEGV
))
15480 eassert (row
->enabled_p
);
15484 /* Consider the following case: Window starts at BEGV,
15485 there is invisible, intangible text at BEGV, so that
15486 display starts at some point START > BEGV. It can
15487 happen that we are called with PT somewhere between
15488 BEGV and START. Try to handle that case. */
15489 if (row
< w
->current_matrix
->rows
15490 || row
->mode_line_p
)
15492 row
= w
->current_matrix
->rows
;
15493 if (row
->mode_line_p
)
15497 /* Due to newlines in overlay strings, we may have to
15498 skip forward over overlay strings. */
15499 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15500 && MATRIX_ROW_END_CHARPOS (row
) == PT
15501 && !cursor_row_p (row
))
15504 /* If within the scroll margin, scroll. */
15505 if (row
->y
< top_scroll_margin
15506 && CHARPOS (startp
) != BEGV
)
15511 /* Cursor did not move. So don't scroll even if cursor line
15512 is partially visible, as it was so before. */
15513 rc
= CURSOR_MOVEMENT_SUCCESS
;
15516 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15517 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15519 /* if PT is not in the glyph row, give up. */
15520 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15521 must_scroll
= true;
15523 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15524 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15526 struct glyph_row
*row1
;
15528 /* If rows are bidi-reordered and point moved, back up
15529 until we find a row that does not belong to a
15530 continuation line. This is because we must consider
15531 all rows of a continued line as candidates for the
15532 new cursor positioning, since row start and end
15533 positions change non-linearly with vertical position
15535 /* FIXME: Revisit this when glyph ``spilling'' in
15536 continuation lines' rows is implemented for
15537 bidi-reordered rows. */
15538 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15539 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15542 /* If we hit the beginning of the displayed portion
15543 without finding the first row of a continued
15547 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15550 eassert (row
->enabled_p
);
15555 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15556 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15557 /* Make sure this isn't a header line by any chance, since
15558 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15559 && !row
->mode_line_p
15560 && make_cursor_line_fully_visible_p
)
15562 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15563 && !row
->ends_at_zv_p
15564 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15565 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15566 else if (row
->height
> window_box_height (w
))
15568 /* If we end up in a partially visible line, let's
15569 make it fully visible, except when it's taller
15570 than the window, in which case we can't do much
15572 *scroll_step
= true;
15573 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15577 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15578 if (!cursor_row_fully_visible_p (w
, false, true))
15579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15581 rc
= CURSOR_MOVEMENT_SUCCESS
;
15585 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15586 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15587 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15589 /* With bidi-reordered rows, there could be more than
15590 one candidate row whose start and end positions
15591 occlude point. We need to let set_cursor_from_row
15592 find the best candidate. */
15593 /* FIXME: Revisit this when glyph ``spilling'' in
15594 continuation lines' rows is implemented for
15595 bidi-reordered rows. */
15600 bool at_zv_p
= false, exact_match_p
= false;
15602 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15603 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15604 && cursor_row_p (row
))
15605 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15607 /* As soon as we've found the exact match for point,
15608 or the first suitable row whose ends_at_zv_p flag
15609 is set, we are done. */
15612 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15613 w
->cursor
.vpos
)->ends_at_zv_p
;
15615 && w
->cursor
.hpos
>= 0
15616 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15619 struct glyph_row
*candidate
=
15620 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15622 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15623 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15626 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15627 || (NILP (g
->object
)
15628 && (g
->charpos
== PT
15629 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15631 if (at_zv_p
|| exact_match_p
)
15633 rc
= CURSOR_MOVEMENT_SUCCESS
;
15637 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15641 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15642 || row
->continued_p
)
15643 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15644 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15645 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15646 /* If we didn't find any candidate rows, or exited the
15647 loop before all the candidates were examined, signal
15648 to the caller that this method failed. */
15649 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15651 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15652 && !row
->continued_p
))
15653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15655 rc
= CURSOR_MOVEMENT_SUCCESS
;
15661 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15663 rc
= CURSOR_MOVEMENT_SUCCESS
;
15668 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15669 && MATRIX_ROW_START_CHARPOS (row
) == PT
15670 && cursor_row_p (row
));
15680 set_vertical_scroll_bar (struct window
*w
)
15682 ptrdiff_t start
, end
, whole
;
15684 /* Calculate the start and end positions for the current window.
15685 At some point, it would be nice to choose between scrollbars
15686 which reflect the whole buffer size, with special markers
15687 indicating narrowing, and scrollbars which reflect only the
15690 Note that mini-buffers sometimes aren't displaying any text. */
15691 if (!MINI_WINDOW_P (w
)
15692 || (w
== XWINDOW (minibuf_window
)
15693 && NILP (echo_area_buffer
[0])))
15695 struct buffer
*buf
= XBUFFER (w
->contents
);
15696 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15697 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15698 /* I don't think this is guaranteed to be right. For the
15699 moment, we'll pretend it is. */
15700 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15704 if (whole
< (end
- start
))
15705 whole
= end
- start
;
15708 start
= end
= whole
= 0;
15710 /* Indicate what this scroll bar ought to be displaying now. */
15711 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15712 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15713 (w
, end
- start
, whole
, start
);
15718 set_horizontal_scroll_bar (struct window
*w
)
15720 int start
, end
, whole
, portion
;
15722 if (!MINI_WINDOW_P (w
)
15723 || (w
== XWINDOW (minibuf_window
)
15724 && NILP (echo_area_buffer
[0])))
15726 struct buffer
*b
= XBUFFER (w
->contents
);
15727 struct buffer
*old_buffer
= NULL
;
15729 struct text_pos startp
;
15731 if (b
!= current_buffer
)
15733 old_buffer
= current_buffer
;
15734 set_buffer_internal (b
);
15737 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15738 start_display (&it
, w
, startp
);
15739 it
.last_visible_x
= INT_MAX
;
15740 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15741 MOVE_TO_X
| MOVE_TO_Y
);
15742 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15743 window_box_height (w), -1,
15744 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15746 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15747 end
= start
+ window_box_width (w
, TEXT_AREA
);
15748 portion
= end
- start
;
15749 /* After enlarging a horizontally scrolled window such that it
15750 gets at least as wide as the text it contains, make sure that
15751 the thumb doesn't fill the entire scroll bar so we can still
15752 drag it back to see the entire text. */
15753 whole
= max (whole
, end
);
15759 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15760 if (EQ (pdir
, Qright_to_left
))
15762 start
= whole
- end
;
15763 end
= start
+ portion
;
15768 set_buffer_internal (old_buffer
);
15771 start
= end
= whole
= portion
= 0;
15773 w
->hscroll_whole
= whole
;
15775 /* Indicate what this scroll bar ought to be displaying now. */
15776 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15777 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15778 (w
, portion
, whole
, start
);
15782 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15783 selected_window is redisplayed.
15785 We can return without actually redisplaying the window if fonts has been
15786 changed on window's frame. In that case, redisplay_internal will retry.
15788 As one of the important parts of redisplaying a window, we need to
15789 decide whether the previous window-start position (stored in the
15790 window's w->start marker position) is still valid, and if it isn't,
15791 recompute it. Some details about that:
15793 . The previous window-start could be in a continuation line, in
15794 which case we need to recompute it when the window width
15795 changes. See compute_window_start_on_continuation_line and its
15798 . The text that changed since last redisplay could include the
15799 previous window-start position. In that case, we try to salvage
15800 what we can from the current glyph matrix by calling
15801 try_scrolling, which see.
15803 . Some Emacs command could force us to use a specific window-start
15804 position by setting the window's force_start flag, or gently
15805 propose doing that by setting the window's optional_new_start
15806 flag. In these cases, we try using the specified start point if
15807 that succeeds (i.e. the window desired matrix is successfully
15808 recomputed, and point location is within the window). In case
15809 of optional_new_start, we first check if the specified start
15810 position is feasible, i.e. if it will allow point to be
15811 displayed in the window. If using the specified start point
15812 fails, e.g., if new fonts are needed to be loaded, we abort the
15813 redisplay cycle and leave it up to the next cycle to figure out
15816 . Note that the window's force_start flag is sometimes set by
15817 redisplay itself, when it decides that the previous window start
15818 point is fine and should be kept. Search for "goto force_start"
15819 below to see the details. Like the values of window-start
15820 specified outside of redisplay, these internally-deduced values
15821 are tested for feasibility, and ignored if found to be
15824 . Note that the function try_window, used to completely redisplay
15825 a window, accepts the window's start point as its argument.
15826 This is used several times in the redisplay code to control
15827 where the window start will be, according to user options such
15828 as scroll-conservatively, and also to ensure the screen line
15829 showing point will be fully (as opposed to partially) visible on
15833 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15835 struct window
*w
= XWINDOW (window
);
15836 struct frame
*f
= XFRAME (w
->frame
);
15837 struct buffer
*buffer
= XBUFFER (w
->contents
);
15838 struct buffer
*old
= current_buffer
;
15839 struct text_pos lpoint
, opoint
, startp
;
15840 bool update_mode_line
;
15843 /* Record it now because it's overwritten. */
15844 bool current_matrix_up_to_date_p
= false;
15845 bool used_current_matrix_p
= false;
15846 /* This is less strict than current_matrix_up_to_date_p.
15847 It indicates that the buffer contents and narrowing are unchanged. */
15848 bool buffer_unchanged_p
= false;
15849 bool temp_scroll_step
= false;
15850 ptrdiff_t count
= SPECPDL_INDEX ();
15852 int centering_position
= -1;
15853 bool last_line_misfit
= false;
15854 ptrdiff_t beg_unchanged
, end_unchanged
;
15855 int frame_line_height
;
15857 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15861 *w
->desired_matrix
->method
= 0;
15864 if (!just_this_one_p
15865 && REDISPLAY_SOME_P ()
15867 && !w
->update_mode_line
15869 && !buffer
->text
->redisplay
15870 && BUF_PT (buffer
) == w
->last_point
)
15873 /* Make sure that both W's markers are valid. */
15874 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15875 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15877 /* We come here again if we need to run window-text-change-functions
15880 reconsider_clip_changes (w
);
15881 frame_line_height
= default_line_pixel_height (w
);
15883 /* Has the mode line to be updated? */
15884 update_mode_line
= (w
->update_mode_line
15885 || update_mode_lines
15886 || buffer
->clip_changed
15887 || buffer
->prevent_redisplay_optimizations_p
);
15889 if (!just_this_one_p
)
15890 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15891 cleverly elsewhere. */
15892 w
->must_be_updated_p
= true;
15894 if (MINI_WINDOW_P (w
))
15896 if (w
== XWINDOW (echo_area_window
)
15897 && !NILP (echo_area_buffer
[0]))
15899 if (update_mode_line
)
15900 /* We may have to update a tty frame's menu bar or a
15901 tool-bar. Example `M-x C-h C-h C-g'. */
15902 goto finish_menu_bars
;
15904 /* We've already displayed the echo area glyphs in this window. */
15905 goto finish_scroll_bars
;
15907 else if ((w
!= XWINDOW (minibuf_window
)
15908 || minibuf_level
== 0)
15909 /* When buffer is nonempty, redisplay window normally. */
15910 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15911 /* Quail displays non-mini buffers in minibuffer window.
15912 In that case, redisplay the window normally. */
15913 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15915 /* W is a mini-buffer window, but it's not active, so clear
15917 int yb
= window_text_bottom_y (w
);
15918 struct glyph_row
*row
;
15921 for (y
= 0, row
= w
->desired_matrix
->rows
;
15923 y
+= row
->height
, ++row
)
15924 blank_row (w
, row
, y
);
15925 goto finish_scroll_bars
;
15928 clear_glyph_matrix (w
->desired_matrix
);
15931 /* Otherwise set up data on this window; select its buffer and point
15933 /* Really select the buffer, for the sake of buffer-local
15935 set_buffer_internal_1 (XBUFFER (w
->contents
));
15937 current_matrix_up_to_date_p
15938 = (w
->window_end_valid
15939 && !current_buffer
->clip_changed
15940 && !current_buffer
->prevent_redisplay_optimizations_p
15941 && !window_outdated (w
));
15943 /* Run the window-text-change-functions
15944 if it is possible that the text on the screen has changed
15945 (either due to modification of the text, or any other reason). */
15946 if (!current_matrix_up_to_date_p
15947 && !NILP (Vwindow_text_change_functions
))
15949 safe_run_hooks (Qwindow_text_change_functions
);
15953 beg_unchanged
= BEG_UNCHANGED
;
15954 end_unchanged
= END_UNCHANGED
;
15956 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15958 specbind (Qinhibit_point_motion_hooks
, Qt
);
15961 = (w
->window_end_valid
15962 && !current_buffer
->clip_changed
15963 && !window_outdated (w
));
15965 /* When windows_or_buffers_changed is non-zero, we can't rely
15966 on the window end being valid, so set it to zero there. */
15967 if (windows_or_buffers_changed
)
15969 /* If window starts on a continuation line, maybe adjust the
15970 window start in case the window's width changed. */
15971 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15972 compute_window_start_on_continuation_line (w
);
15974 w
->window_end_valid
= false;
15975 /* If so, we also can't rely on current matrix
15976 and should not fool try_cursor_movement below. */
15977 current_matrix_up_to_date_p
= false;
15980 /* Some sanity checks. */
15981 CHECK_WINDOW_END (w
);
15982 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15984 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15987 if (mode_line_update_needed (w
))
15988 update_mode_line
= true;
15990 /* Point refers normally to the selected window. For any other
15991 window, set up appropriate value. */
15992 if (!EQ (window
, selected_window
))
15994 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15995 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16000 new_pt_byte
= BEGV_BYTE
;
16001 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16003 else if (new_pt
> (ZV
- 1))
16006 new_pt_byte
= ZV_BYTE
;
16007 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16010 /* We don't use SET_PT so that the point-motion hooks don't run. */
16011 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16014 /* If any of the character widths specified in the display table
16015 have changed, invalidate the width run cache. It's true that
16016 this may be a bit late to catch such changes, but the rest of
16017 redisplay goes (non-fatally) haywire when the display table is
16018 changed, so why should we worry about doing any better? */
16019 if (current_buffer
->width_run_cache
16020 || (current_buffer
->base_buffer
16021 && current_buffer
->base_buffer
->width_run_cache
))
16023 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16025 if (! disptab_matches_widthtab
16026 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16028 struct buffer
*buf
= current_buffer
;
16030 if (buf
->base_buffer
)
16031 buf
= buf
->base_buffer
;
16032 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16033 recompute_width_table (current_buffer
, disptab
);
16037 /* If window-start is screwed up, choose a new one. */
16038 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16041 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16043 /* If someone specified a new starting point but did not insist,
16044 check whether it can be used. */
16045 if ((w
->optional_new_start
|| window_frozen_p (w
))
16046 && CHARPOS (startp
) >= BEGV
16047 && CHARPOS (startp
) <= ZV
)
16049 ptrdiff_t it_charpos
;
16051 w
->optional_new_start
= false;
16052 start_display (&it
, w
, startp
);
16053 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16054 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16055 /* Record IT's position now, since line_bottom_y might change
16057 it_charpos
= IT_CHARPOS (it
);
16058 /* Make sure we set the force_start flag only if the cursor row
16059 will be fully visible. Otherwise, the code under force_start
16060 label below will try to move point back into view, which is
16061 not what the code which sets optional_new_start wants. */
16062 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16063 && !w
->force_start
)
16065 if (it_charpos
== PT
)
16066 w
->force_start
= true;
16067 /* IT may overshoot PT if text at PT is invisible. */
16068 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16069 w
->force_start
= true;
16071 if (w
->force_start
)
16073 if (window_frozen_p (w
))
16074 debug_method_add (w
, "set force_start from frozen window start");
16076 debug_method_add (w
, "set force_start from optional_new_start");
16084 /* Handle case where place to start displaying has been specified,
16085 unless the specified location is outside the accessible range. */
16086 if (w
->force_start
)
16088 /* We set this later on if we have to adjust point. */
16091 w
->force_start
= false;
16093 w
->window_end_valid
= false;
16095 /* Forget any recorded base line for line number display. */
16096 if (!buffer_unchanged_p
)
16097 w
->base_line_number
= 0;
16099 /* Redisplay the mode line. Select the buffer properly for that.
16100 Also, run the hook window-scroll-functions
16101 because we have scrolled. */
16102 /* Note, we do this after clearing force_start because
16103 if there's an error, it is better to forget about force_start
16104 than to get into an infinite loop calling the hook functions
16105 and having them get more errors. */
16106 if (!update_mode_line
16107 || ! NILP (Vwindow_scroll_functions
))
16109 update_mode_line
= true;
16110 w
->update_mode_line
= true;
16111 startp
= run_window_scroll_functions (window
, startp
);
16114 if (CHARPOS (startp
) < BEGV
)
16115 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16116 else if (CHARPOS (startp
) > ZV
)
16117 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16119 /* Redisplay, then check if cursor has been set during the
16120 redisplay. Give up if new fonts were loaded. */
16121 /* We used to issue a CHECK_MARGINS argument to try_window here,
16122 but this causes scrolling to fail when point begins inside
16123 the scroll margin (bug#148) -- cyd */
16124 if (!try_window (window
, startp
, 0))
16126 w
->force_start
= true;
16127 clear_glyph_matrix (w
->desired_matrix
);
16128 goto need_larger_matrices
;
16131 if (w
->cursor
.vpos
< 0)
16133 /* If point does not appear, try to move point so it does
16134 appear. The desired matrix has been built above, so we
16135 can use it here. */
16136 new_vpos
= window_box_height (w
) / 2;
16139 if (!cursor_row_fully_visible_p (w
, false, false))
16141 /* Point does appear, but on a line partly visible at end of window.
16142 Move it back to a fully-visible line. */
16143 new_vpos
= window_box_height (w
);
16144 /* But if window_box_height suggests a Y coordinate that is
16145 not less than we already have, that line will clearly not
16146 be fully visible, so give up and scroll the display.
16147 This can happen when the default face uses a font whose
16148 dimensions are different from the frame's default
16150 if (new_vpos
>= w
->cursor
.y
)
16152 w
->cursor
.vpos
= -1;
16153 clear_glyph_matrix (w
->desired_matrix
);
16154 goto try_to_scroll
;
16157 else if (w
->cursor
.vpos
>= 0)
16159 /* Some people insist on not letting point enter the scroll
16160 margin, even though this part handles windows that didn't
16162 int window_total_lines
16163 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16164 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16165 int pixel_margin
= margin
* frame_line_height
;
16166 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16168 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16169 below, which finds the row to move point to, advances by
16170 the Y coordinate of the _next_ row, see the definition of
16171 MATRIX_ROW_BOTTOM_Y. */
16172 if (w
->cursor
.vpos
< margin
+ header_line
)
16174 w
->cursor
.vpos
= -1;
16175 clear_glyph_matrix (w
->desired_matrix
);
16176 goto try_to_scroll
;
16180 int window_height
= window_box_height (w
);
16183 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16184 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16186 w
->cursor
.vpos
= -1;
16187 clear_glyph_matrix (w
->desired_matrix
);
16188 goto try_to_scroll
;
16193 /* If we need to move point for either of the above reasons,
16194 now actually do it. */
16197 struct glyph_row
*row
;
16199 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16200 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16203 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16204 MATRIX_ROW_START_BYTEPOS (row
));
16206 if (w
!= XWINDOW (selected_window
))
16207 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16208 else if (current_buffer
== old
)
16209 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16211 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16213 /* Re-run pre-redisplay-function so it can update the region
16214 according to the new position of point. */
16215 /* Other than the cursor, w's redisplay is done so we can set its
16216 redisplay to false. Also the buffer's redisplay can be set to
16217 false, since propagate_buffer_redisplay should have already
16218 propagated its info to `w' anyway. */
16219 w
->redisplay
= false;
16220 XBUFFER (w
->contents
)->text
->redisplay
= false;
16221 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16223 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16225 /* pre-redisplay-function made changes (e.g. move the region)
16226 that require another round of redisplay. */
16227 clear_glyph_matrix (w
->desired_matrix
);
16228 if (!try_window (window
, startp
, 0))
16229 goto need_larger_matrices
;
16232 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16234 clear_glyph_matrix (w
->desired_matrix
);
16235 goto try_to_scroll
;
16239 debug_method_add (w
, "forced window start");
16244 /* Handle case where text has not changed, only point, and it has
16245 not moved off the frame, and we are not retrying after hscroll.
16246 (current_matrix_up_to_date_p is true when retrying.) */
16247 if (current_matrix_up_to_date_p
16248 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16249 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16253 case CURSOR_MOVEMENT_SUCCESS
:
16254 used_current_matrix_p
= true;
16257 case CURSOR_MOVEMENT_MUST_SCROLL
:
16258 goto try_to_scroll
;
16264 /* If current starting point was originally the beginning of a line
16265 but no longer is, find a new starting point. */
16266 else if (w
->start_at_line_beg
16267 && !(CHARPOS (startp
) <= BEGV
16268 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16271 debug_method_add (w
, "recenter 1");
16276 /* Try scrolling with try_window_id. Value is > 0 if update has
16277 been done, it is -1 if we know that the same window start will
16278 not work. It is 0 if unsuccessful for some other reason. */
16279 else if ((tem
= try_window_id (w
)) != 0)
16282 debug_method_add (w
, "try_window_id %d", tem
);
16285 if (f
->fonts_changed
)
16286 goto need_larger_matrices
;
16290 /* Otherwise try_window_id has returned -1 which means that we
16291 don't want the alternative below this comment to execute. */
16293 else if (CHARPOS (startp
) >= BEGV
16294 && CHARPOS (startp
) <= ZV
16295 && PT
>= CHARPOS (startp
)
16296 && (CHARPOS (startp
) < ZV
16297 /* Avoid starting at end of buffer. */
16298 || CHARPOS (startp
) == BEGV
16299 || !window_outdated (w
)))
16301 int d1
, d2
, d5
, d6
;
16304 /* If first window line is a continuation line, and window start
16305 is inside the modified region, but the first change is before
16306 current window start, we must select a new window start.
16308 However, if this is the result of a down-mouse event (e.g. by
16309 extending the mouse-drag-overlay), we don't want to select a
16310 new window start, since that would change the position under
16311 the mouse, resulting in an unwanted mouse-movement rather
16312 than a simple mouse-click. */
16313 if (!w
->start_at_line_beg
16314 && NILP (do_mouse_tracking
)
16315 && CHARPOS (startp
) > BEGV
16316 && CHARPOS (startp
) > BEG
+ beg_unchanged
16317 && CHARPOS (startp
) <= Z
- end_unchanged
16318 /* Even if w->start_at_line_beg is nil, a new window may
16319 start at a line_beg, since that's how set_buffer_window
16320 sets it. So, we need to check the return value of
16321 compute_window_start_on_continuation_line. (See also
16323 && XMARKER (w
->start
)->buffer
== current_buffer
16324 && compute_window_start_on_continuation_line (w
)
16325 /* It doesn't make sense to force the window start like we
16326 do at label force_start if it is already known that point
16327 will not be fully visible in the resulting window, because
16328 doing so will move point from its correct position
16329 instead of scrolling the window to bring point into view.
16331 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16332 /* A very tall row could need more than the window height,
16333 in which case we accept that it is partially visible. */
16334 && (rtop
!= 0) == (rbot
!= 0))
16336 w
->force_start
= true;
16337 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16339 debug_method_add (w
, "recomputed window start in continuation line");
16345 debug_method_add (w
, "same window start");
16348 /* Try to redisplay starting at same place as before.
16349 If point has not moved off frame, accept the results. */
16350 if (!current_matrix_up_to_date_p
16351 /* Don't use try_window_reusing_current_matrix in this case
16352 because a window scroll function can have changed the
16354 || !NILP (Vwindow_scroll_functions
)
16355 || MINI_WINDOW_P (w
)
16356 || !(used_current_matrix_p
16357 = try_window_reusing_current_matrix (w
)))
16359 IF_DEBUG (debug_method_add (w
, "1"));
16360 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16361 /* -1 means we need to scroll.
16362 0 means we need new matrices, but fonts_changed
16363 is set in that case, so we will detect it below. */
16364 goto try_to_scroll
;
16367 if (f
->fonts_changed
)
16368 goto need_larger_matrices
;
16370 if (w
->cursor
.vpos
>= 0)
16372 if (!just_this_one_p
16373 || current_buffer
->clip_changed
16374 || BEG_UNCHANGED
< CHARPOS (startp
))
16375 /* Forget any recorded base line for line number display. */
16376 w
->base_line_number
= 0;
16378 if (!cursor_row_fully_visible_p (w
, true, false))
16380 clear_glyph_matrix (w
->desired_matrix
);
16381 last_line_misfit
= true;
16383 /* Drop through and scroll. */
16388 clear_glyph_matrix (w
->desired_matrix
);
16393 /* Redisplay the mode line. Select the buffer properly for that. */
16394 if (!update_mode_line
)
16396 update_mode_line
= true;
16397 w
->update_mode_line
= true;
16400 /* Try to scroll by specified few lines. */
16401 if ((scroll_conservatively
16402 || emacs_scroll_step
16403 || temp_scroll_step
16404 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16405 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16406 && CHARPOS (startp
) >= BEGV
16407 && CHARPOS (startp
) <= ZV
)
16409 /* The function returns -1 if new fonts were loaded, 1 if
16410 successful, 0 if not successful. */
16411 int ss
= try_scrolling (window
, just_this_one_p
,
16412 scroll_conservatively
,
16414 temp_scroll_step
, last_line_misfit
);
16417 case SCROLLING_SUCCESS
:
16420 case SCROLLING_NEED_LARGER_MATRICES
:
16421 goto need_larger_matrices
;
16423 case SCROLLING_FAILED
:
16431 /* Finally, just choose a place to start which positions point
16432 according to user preferences. */
16437 debug_method_add (w
, "recenter");
16440 /* Forget any previously recorded base line for line number display. */
16441 if (!buffer_unchanged_p
)
16442 w
->base_line_number
= 0;
16444 /* Determine the window start relative to point. */
16445 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16446 it
.current_y
= it
.last_visible_y
;
16447 if (centering_position
< 0)
16449 int window_total_lines
16450 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16452 = scroll_margin
> 0
16453 ? min (scroll_margin
, window_total_lines
/ 4)
16455 ptrdiff_t margin_pos
= CHARPOS (startp
);
16456 Lisp_Object aggressive
;
16459 /* If there is a scroll margin at the top of the window, find
16460 its character position. */
16462 /* Cannot call start_display if startp is not in the
16463 accessible region of the buffer. This can happen when we
16464 have just switched to a different buffer and/or changed
16465 its restriction. In that case, startp is initialized to
16466 the character position 1 (BEGV) because we did not yet
16467 have chance to display the buffer even once. */
16468 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16471 void *it1data
= NULL
;
16473 SAVE_IT (it1
, it
, it1data
);
16474 start_display (&it1
, w
, startp
);
16475 move_it_vertically (&it1
, margin
* frame_line_height
);
16476 margin_pos
= IT_CHARPOS (it1
);
16477 RESTORE_IT (&it
, &it
, it1data
);
16479 scrolling_up
= PT
> margin_pos
;
16482 ? BVAR (current_buffer
, scroll_up_aggressively
)
16483 : BVAR (current_buffer
, scroll_down_aggressively
);
16485 if (!MINI_WINDOW_P (w
)
16486 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16490 /* Setting scroll-conservatively overrides
16491 scroll-*-aggressively. */
16492 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16494 double float_amount
= XFLOATINT (aggressive
);
16496 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16497 if (pt_offset
== 0 && float_amount
> 0)
16499 if (pt_offset
&& margin
> 0)
16502 /* Compute how much to move the window start backward from
16503 point so that point will be displayed where the user
16507 centering_position
= it
.last_visible_y
;
16509 centering_position
-= pt_offset
;
16510 centering_position
-=
16511 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16512 + WINDOW_HEADER_LINE_HEIGHT (w
));
16513 /* Don't let point enter the scroll margin near top of
16515 if (centering_position
< margin
* frame_line_height
)
16516 centering_position
= margin
* frame_line_height
;
16519 centering_position
= margin
* frame_line_height
+ pt_offset
;
16522 /* Set the window start half the height of the window backward
16524 centering_position
= window_box_height (w
) / 2;
16526 move_it_vertically_backward (&it
, centering_position
);
16528 eassert (IT_CHARPOS (it
) >= BEGV
);
16530 /* The function move_it_vertically_backward may move over more
16531 than the specified y-distance. If it->w is small, e.g. a
16532 mini-buffer window, we may end up in front of the window's
16533 display area. Start displaying at the start of the line
16534 containing PT in this case. */
16535 if (it
.current_y
<= 0)
16537 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16538 move_it_vertically_backward (&it
, 0);
16542 it
.current_x
= it
.hpos
= 0;
16544 /* Set the window start position here explicitly, to avoid an
16545 infinite loop in case the functions in window-scroll-functions
16547 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16549 /* Run scroll hooks. */
16550 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16552 /* Redisplay the window. */
16553 if (!current_matrix_up_to_date_p
16554 || windows_or_buffers_changed
16555 || f
->cursor_type_changed
16556 /* Don't use try_window_reusing_current_matrix in this case
16557 because it can have changed the buffer. */
16558 || !NILP (Vwindow_scroll_functions
)
16559 || !just_this_one_p
16560 || MINI_WINDOW_P (w
)
16561 || !(used_current_matrix_p
16562 = try_window_reusing_current_matrix (w
)))
16563 try_window (window
, startp
, 0);
16565 /* If new fonts have been loaded (due to fontsets), give up. We
16566 have to start a new redisplay since we need to re-adjust glyph
16568 if (f
->fonts_changed
)
16569 goto need_larger_matrices
;
16571 /* If cursor did not appear assume that the middle of the window is
16572 in the first line of the window. Do it again with the next line.
16573 (Imagine a window of height 100, displaying two lines of height
16574 60. Moving back 50 from it->last_visible_y will end in the first
16576 if (w
->cursor
.vpos
< 0)
16578 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16580 clear_glyph_matrix (w
->desired_matrix
);
16581 move_it_by_lines (&it
, 1);
16582 try_window (window
, it
.current
.pos
, 0);
16584 else if (PT
< IT_CHARPOS (it
))
16586 clear_glyph_matrix (w
->desired_matrix
);
16587 move_it_by_lines (&it
, -1);
16588 try_window (window
, it
.current
.pos
, 0);
16592 /* Not much we can do about it. */
16596 /* Consider the following case: Window starts at BEGV, there is
16597 invisible, intangible text at BEGV, so that display starts at
16598 some point START > BEGV. It can happen that we are called with
16599 PT somewhere between BEGV and START. Try to handle that case,
16600 and similar ones. */
16601 if (w
->cursor
.vpos
< 0)
16603 /* First, try locating the proper glyph row for PT. */
16604 struct glyph_row
*row
=
16605 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16607 /* Sometimes point is at the beginning of invisible text that is
16608 before the 1st character displayed in the row. In that case,
16609 row_containing_pos fails to find the row, because no glyphs
16610 with appropriate buffer positions are present in the row.
16611 Therefore, we next try to find the row which shows the 1st
16612 position after the invisible text. */
16616 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16619 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16622 Lisp_Object invis_end
=
16623 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16626 if (NATNUMP (invis_end
))
16627 alt_pos
= XFASTINT (invis_end
);
16630 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16634 /* Finally, fall back on the first row of the window after the
16635 header line (if any). This is slightly better than not
16636 displaying the cursor at all. */
16639 row
= w
->current_matrix
->rows
;
16640 if (row
->mode_line_p
)
16643 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16646 if (!cursor_row_fully_visible_p (w
, false, false))
16648 /* If vscroll is enabled, disable it and try again. */
16652 clear_glyph_matrix (w
->desired_matrix
);
16656 /* Users who set scroll-conservatively to a large number want
16657 point just above/below the scroll margin. If we ended up
16658 with point's row partially visible, move the window start to
16659 make that row fully visible and out of the margin. */
16660 if (scroll_conservatively
> SCROLL_LIMIT
)
16662 int window_total_lines
16663 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16666 ? min (scroll_margin
, window_total_lines
/ 4)
16668 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16670 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16671 clear_glyph_matrix (w
->desired_matrix
);
16672 if (1 == try_window (window
, it
.current
.pos
,
16673 TRY_WINDOW_CHECK_MARGINS
))
16677 /* If centering point failed to make the whole line visible,
16678 put point at the top instead. That has to make the whole line
16679 visible, if it can be done. */
16680 if (centering_position
== 0)
16683 clear_glyph_matrix (w
->desired_matrix
);
16684 centering_position
= 0;
16690 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16691 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16692 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16694 /* Display the mode line, if we must. */
16695 if ((update_mode_line
16696 /* If window not full width, must redo its mode line
16697 if (a) the window to its side is being redone and
16698 (b) we do a frame-based redisplay. This is a consequence
16699 of how inverted lines are drawn in frame-based redisplay. */
16700 || (!just_this_one_p
16701 && !FRAME_WINDOW_P (f
)
16702 && !WINDOW_FULL_WIDTH_P (w
))
16703 /* Line number to display. */
16704 || w
->base_line_pos
> 0
16705 /* Column number is displayed and different from the one displayed. */
16706 || (w
->column_number_displayed
!= -1
16707 && (w
->column_number_displayed
!= current_column ())))
16708 /* This means that the window has a mode line. */
16709 && (WINDOW_WANTS_MODELINE_P (w
)
16710 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16713 display_mode_lines (w
);
16715 /* If mode line height has changed, arrange for a thorough
16716 immediate redisplay using the correct mode line height. */
16717 if (WINDOW_WANTS_MODELINE_P (w
)
16718 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16720 f
->fonts_changed
= true;
16721 w
->mode_line_height
= -1;
16722 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16723 = DESIRED_MODE_LINE_HEIGHT (w
);
16726 /* If header line height has changed, arrange for a thorough
16727 immediate redisplay using the correct header line height. */
16728 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16729 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16731 f
->fonts_changed
= true;
16732 w
->header_line_height
= -1;
16733 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16734 = DESIRED_HEADER_LINE_HEIGHT (w
);
16737 if (f
->fonts_changed
)
16738 goto need_larger_matrices
;
16741 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16743 w
->base_line_pos
= 0;
16744 w
->base_line_number
= 0;
16749 /* When we reach a frame's selected window, redo the frame's menu bar. */
16750 if (update_mode_line
16751 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16753 bool redisplay_menu_p
;
16755 if (FRAME_WINDOW_P (f
))
16757 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16758 || defined (HAVE_NS) || defined (USE_GTK)
16759 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16761 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16765 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16767 if (redisplay_menu_p
)
16768 display_menu_bar (w
);
16770 #ifdef HAVE_WINDOW_SYSTEM
16771 if (FRAME_WINDOW_P (f
))
16773 #if defined (USE_GTK) || defined (HAVE_NS)
16774 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16775 redisplay_tool_bar (f
);
16777 if (WINDOWP (f
->tool_bar_window
)
16778 && (FRAME_TOOL_BAR_LINES (f
) > 0
16779 || !NILP (Vauto_resize_tool_bars
))
16780 && redisplay_tool_bar (f
))
16781 ignore_mouse_drag_p
= true;
16787 #ifdef HAVE_WINDOW_SYSTEM
16788 if (FRAME_WINDOW_P (f
)
16789 && update_window_fringes (w
, (just_this_one_p
16790 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16791 || w
->pseudo_window_p
)))
16795 if (draw_window_fringes (w
, true))
16797 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16798 x_draw_right_divider (w
);
16800 x_draw_vertical_border (w
);
16806 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16807 x_draw_bottom_divider (w
);
16808 #endif /* HAVE_WINDOW_SYSTEM */
16810 /* We go to this label, with fonts_changed set, if it is
16811 necessary to try again using larger glyph matrices.
16812 We have to redeem the scroll bar even in this case,
16813 because the loop in redisplay_internal expects that. */
16814 need_larger_matrices
:
16816 finish_scroll_bars
:
16818 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16820 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16821 /* Set the thumb's position and size. */
16822 set_vertical_scroll_bar (w
);
16824 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16825 /* Set the thumb's position and size. */
16826 set_horizontal_scroll_bar (w
);
16828 /* Note that we actually used the scroll bar attached to this
16829 window, so it shouldn't be deleted at the end of redisplay. */
16830 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16831 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16834 /* Restore current_buffer and value of point in it. The window
16835 update may have changed the buffer, so first make sure `opoint'
16836 is still valid (Bug#6177). */
16837 if (CHARPOS (opoint
) < BEGV
)
16838 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16839 else if (CHARPOS (opoint
) > ZV
)
16840 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16842 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16844 set_buffer_internal_1 (old
);
16845 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16846 shorter. This can be caused by log truncation in *Messages*. */
16847 if (CHARPOS (lpoint
) <= ZV
)
16848 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16850 unbind_to (count
, Qnil
);
16854 /* Build the complete desired matrix of WINDOW with a window start
16855 buffer position POS.
16857 Value is 1 if successful. It is zero if fonts were loaded during
16858 redisplay which makes re-adjusting glyph matrices necessary, and -1
16859 if point would appear in the scroll margins.
16860 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16861 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16865 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16867 struct window
*w
= XWINDOW (window
);
16869 struct glyph_row
*last_text_row
= NULL
;
16870 struct frame
*f
= XFRAME (w
->frame
);
16871 int frame_line_height
= default_line_pixel_height (w
);
16873 /* Make POS the new window start. */
16874 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16876 /* Mark cursor position as unknown. No overlay arrow seen. */
16877 w
->cursor
.vpos
= -1;
16878 overlay_arrow_seen
= false;
16880 /* Initialize iterator and info to start at POS. */
16881 start_display (&it
, w
, pos
);
16882 it
.glyph_row
->reversed_p
= false;
16884 /* Display all lines of W. */
16885 while (it
.current_y
< it
.last_visible_y
)
16887 if (display_line (&it
))
16888 last_text_row
= it
.glyph_row
- 1;
16889 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16893 /* Don't let the cursor end in the scroll margins. */
16894 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16895 && !MINI_WINDOW_P (w
))
16897 int this_scroll_margin
;
16898 int window_total_lines
16899 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16901 if (scroll_margin
> 0)
16903 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16904 this_scroll_margin
*= frame_line_height
;
16907 this_scroll_margin
= 0;
16909 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16910 && w
->cursor
.y
< this_scroll_margin
16911 && CHARPOS (pos
) > BEGV
16912 && IT_CHARPOS (it
) < ZV
)
16913 /* rms: considering make_cursor_line_fully_visible_p here
16914 seems to give wrong results. We don't want to recenter
16915 when the last line is partly visible, we want to allow
16916 that case to be handled in the usual way. */
16917 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16919 w
->cursor
.vpos
= -1;
16920 clear_glyph_matrix (w
->desired_matrix
);
16925 /* If bottom moved off end of frame, change mode line percentage. */
16926 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16927 w
->update_mode_line
= true;
16929 /* Set window_end_pos to the offset of the last character displayed
16930 on the window from the end of current_buffer. Set
16931 window_end_vpos to its row number. */
16934 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16935 adjust_window_ends (w
, last_text_row
, false);
16937 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16938 w
->window_end_vpos
)));
16942 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16943 w
->window_end_pos
= Z
- ZV
;
16944 w
->window_end_vpos
= 0;
16947 /* But that is not valid info until redisplay finishes. */
16948 w
->window_end_valid
= false;
16954 /************************************************************************
16955 Window redisplay reusing current matrix when buffer has not changed
16956 ************************************************************************/
16958 /* Try redisplay of window W showing an unchanged buffer with a
16959 different window start than the last time it was displayed by
16960 reusing its current matrix. Value is true if successful.
16961 W->start is the new window start. */
16964 try_window_reusing_current_matrix (struct window
*w
)
16966 struct frame
*f
= XFRAME (w
->frame
);
16967 struct glyph_row
*bottom_row
;
16970 struct text_pos start
, new_start
;
16971 int nrows_scrolled
, i
;
16972 struct glyph_row
*last_text_row
;
16973 struct glyph_row
*last_reused_text_row
;
16974 struct glyph_row
*start_row
;
16975 int start_vpos
, min_y
, max_y
;
16978 if (inhibit_try_window_reusing
)
16982 if (/* This function doesn't handle terminal frames. */
16983 !FRAME_WINDOW_P (f
)
16984 /* Don't try to reuse the display if windows have been split
16986 || windows_or_buffers_changed
16987 || f
->cursor_type_changed
)
16990 /* Can't do this if showing trailing whitespace. */
16991 if (!NILP (Vshow_trailing_whitespace
))
16994 /* If top-line visibility has changed, give up. */
16995 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16996 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16999 /* Give up if old or new display is scrolled vertically. We could
17000 make this function handle this, but right now it doesn't. */
17001 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17002 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17005 /* The variable new_start now holds the new window start. The old
17006 start `start' can be determined from the current matrix. */
17007 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17008 start
= start_row
->minpos
;
17009 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17011 /* Clear the desired matrix for the display below. */
17012 clear_glyph_matrix (w
->desired_matrix
);
17014 if (CHARPOS (new_start
) <= CHARPOS (start
))
17016 /* Don't use this method if the display starts with an ellipsis
17017 displayed for invisible text. It's not easy to handle that case
17018 below, and it's certainly not worth the effort since this is
17019 not a frequent case. */
17020 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17023 IF_DEBUG (debug_method_add (w
, "twu1"));
17025 /* Display up to a row that can be reused. The variable
17026 last_text_row is set to the last row displayed that displays
17027 text. Note that it.vpos == 0 if or if not there is a
17028 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17029 start_display (&it
, w
, new_start
);
17030 w
->cursor
.vpos
= -1;
17031 last_text_row
= last_reused_text_row
= NULL
;
17033 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17035 /* If we have reached into the characters in the START row,
17036 that means the line boundaries have changed. So we
17037 can't start copying with the row START. Maybe it will
17038 work to start copying with the following row. */
17039 while (IT_CHARPOS (it
) > CHARPOS (start
))
17041 /* Advance to the next row as the "start". */
17043 start
= start_row
->minpos
;
17044 /* If there are no more rows to try, or just one, give up. */
17045 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17046 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17047 || CHARPOS (start
) == ZV
)
17049 clear_glyph_matrix (w
->desired_matrix
);
17053 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17055 /* If we have reached alignment, we can copy the rest of the
17057 if (IT_CHARPOS (it
) == CHARPOS (start
)
17058 /* Don't accept "alignment" inside a display vector,
17059 since start_row could have started in the middle of
17060 that same display vector (thus their character
17061 positions match), and we have no way of telling if
17062 that is the case. */
17063 && it
.current
.dpvec_index
< 0)
17066 it
.glyph_row
->reversed_p
= false;
17067 if (display_line (&it
))
17068 last_text_row
= it
.glyph_row
- 1;
17072 /* A value of current_y < last_visible_y means that we stopped
17073 at the previous window start, which in turn means that we
17074 have at least one reusable row. */
17075 if (it
.current_y
< it
.last_visible_y
)
17077 struct glyph_row
*row
;
17079 /* IT.vpos always starts from 0; it counts text lines. */
17080 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17082 /* Find PT if not already found in the lines displayed. */
17083 if (w
->cursor
.vpos
< 0)
17085 int dy
= it
.current_y
- start_row
->y
;
17087 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17088 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17090 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17091 dy
, nrows_scrolled
);
17094 clear_glyph_matrix (w
->desired_matrix
);
17099 /* Scroll the display. Do it before the current matrix is
17100 changed. The problem here is that update has not yet
17101 run, i.e. part of the current matrix is not up to date.
17102 scroll_run_hook will clear the cursor, and use the
17103 current matrix to get the height of the row the cursor is
17105 run
.current_y
= start_row
->y
;
17106 run
.desired_y
= it
.current_y
;
17107 run
.height
= it
.last_visible_y
- it
.current_y
;
17109 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17112 FRAME_RIF (f
)->update_window_begin_hook (w
);
17113 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17114 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17115 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17119 /* Shift current matrix down by nrows_scrolled lines. */
17120 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17121 rotate_matrix (w
->current_matrix
,
17123 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17126 /* Disable lines that must be updated. */
17127 for (i
= 0; i
< nrows_scrolled
; ++i
)
17128 (start_row
+ i
)->enabled_p
= false;
17130 /* Re-compute Y positions. */
17131 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17132 max_y
= it
.last_visible_y
;
17133 for (row
= start_row
+ nrows_scrolled
;
17137 row
->y
= it
.current_y
;
17138 row
->visible_height
= row
->height
;
17140 if (row
->y
< min_y
)
17141 row
->visible_height
-= min_y
- row
->y
;
17142 if (row
->y
+ row
->height
> max_y
)
17143 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17144 if (row
->fringe_bitmap_periodic_p
)
17145 row
->redraw_fringe_bitmaps_p
= true;
17147 it
.current_y
+= row
->height
;
17149 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17150 last_reused_text_row
= row
;
17151 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17155 /* Disable lines in the current matrix which are now
17156 below the window. */
17157 for (++row
; row
< bottom_row
; ++row
)
17158 row
->enabled_p
= row
->mode_line_p
= false;
17161 /* Update window_end_pos etc.; last_reused_text_row is the last
17162 reused row from the current matrix containing text, if any.
17163 The value of last_text_row is the last displayed line
17164 containing text. */
17165 if (last_reused_text_row
)
17166 adjust_window_ends (w
, last_reused_text_row
, true);
17167 else if (last_text_row
)
17168 adjust_window_ends (w
, last_text_row
, false);
17171 /* This window must be completely empty. */
17172 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17173 w
->window_end_pos
= Z
- ZV
;
17174 w
->window_end_vpos
= 0;
17176 w
->window_end_valid
= false;
17178 /* Update hint: don't try scrolling again in update_window. */
17179 w
->desired_matrix
->no_scrolling_p
= true;
17182 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17186 else if (CHARPOS (new_start
) > CHARPOS (start
))
17188 struct glyph_row
*pt_row
, *row
;
17189 struct glyph_row
*first_reusable_row
;
17190 struct glyph_row
*first_row_to_display
;
17192 int yb
= window_text_bottom_y (w
);
17194 /* Find the row starting at new_start, if there is one. Don't
17195 reuse a partially visible line at the end. */
17196 first_reusable_row
= start_row
;
17197 while (first_reusable_row
->enabled_p
17198 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17199 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17200 < CHARPOS (new_start
)))
17201 ++first_reusable_row
;
17203 /* Give up if there is no row to reuse. */
17204 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17205 || !first_reusable_row
->enabled_p
17206 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17207 != CHARPOS (new_start
)))
17210 /* We can reuse fully visible rows beginning with
17211 first_reusable_row to the end of the window. Set
17212 first_row_to_display to the first row that cannot be reused.
17213 Set pt_row to the row containing point, if there is any. */
17215 for (first_row_to_display
= first_reusable_row
;
17216 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17217 ++first_row_to_display
)
17219 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17220 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17221 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17222 && first_row_to_display
->ends_at_zv_p
17223 && pt_row
== NULL
)))
17224 pt_row
= first_row_to_display
;
17227 /* Start displaying at the start of first_row_to_display. */
17228 eassert (first_row_to_display
->y
< yb
);
17229 init_to_row_start (&it
, w
, first_row_to_display
);
17231 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17233 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17235 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17236 + WINDOW_HEADER_LINE_HEIGHT (w
));
17238 /* Display lines beginning with first_row_to_display in the
17239 desired matrix. Set last_text_row to the last row displayed
17240 that displays text. */
17241 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17242 if (pt_row
== NULL
)
17243 w
->cursor
.vpos
= -1;
17244 last_text_row
= NULL
;
17245 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17246 if (display_line (&it
))
17247 last_text_row
= it
.glyph_row
- 1;
17249 /* If point is in a reused row, adjust y and vpos of the cursor
17253 w
->cursor
.vpos
-= nrows_scrolled
;
17254 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17257 /* Give up if point isn't in a row displayed or reused. (This
17258 also handles the case where w->cursor.vpos < nrows_scrolled
17259 after the calls to display_line, which can happen with scroll
17260 margins. See bug#1295.) */
17261 if (w
->cursor
.vpos
< 0)
17263 clear_glyph_matrix (w
->desired_matrix
);
17267 /* Scroll the display. */
17268 run
.current_y
= first_reusable_row
->y
;
17269 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17270 run
.height
= it
.last_visible_y
- run
.current_y
;
17271 dy
= run
.current_y
- run
.desired_y
;
17276 FRAME_RIF (f
)->update_window_begin_hook (w
);
17277 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17278 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17279 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17283 /* Adjust Y positions of reused rows. */
17284 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17285 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17286 max_y
= it
.last_visible_y
;
17287 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17290 row
->visible_height
= row
->height
;
17291 if (row
->y
< min_y
)
17292 row
->visible_height
-= min_y
- row
->y
;
17293 if (row
->y
+ row
->height
> max_y
)
17294 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17295 if (row
->fringe_bitmap_periodic_p
)
17296 row
->redraw_fringe_bitmaps_p
= true;
17299 /* Scroll the current matrix. */
17300 eassert (nrows_scrolled
> 0);
17301 rotate_matrix (w
->current_matrix
,
17303 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17306 /* Disable rows not reused. */
17307 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17308 row
->enabled_p
= false;
17310 /* Point may have moved to a different line, so we cannot assume that
17311 the previous cursor position is valid; locate the correct row. */
17314 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17316 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17317 && !row
->ends_at_zv_p
;
17321 w
->cursor
.y
= row
->y
;
17323 if (row
< bottom_row
)
17325 /* Can't simply scan the row for point with
17326 bidi-reordered glyph rows. Let set_cursor_from_row
17327 figure out where to put the cursor, and if it fails,
17329 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17331 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17334 clear_glyph_matrix (w
->desired_matrix
);
17340 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17341 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17344 && (!BUFFERP (glyph
->object
)
17345 || glyph
->charpos
< PT
);
17349 w
->cursor
.x
+= glyph
->pixel_width
;
17355 /* Adjust window end. A null value of last_text_row means that
17356 the window end is in reused rows which in turn means that
17357 only its vpos can have changed. */
17359 adjust_window_ends (w
, last_text_row
, false);
17361 w
->window_end_vpos
-= nrows_scrolled
;
17363 w
->window_end_valid
= false;
17364 w
->desired_matrix
->no_scrolling_p
= true;
17367 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17377 /************************************************************************
17378 Window redisplay reusing current matrix when buffer has changed
17379 ************************************************************************/
17381 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17382 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17383 ptrdiff_t *, ptrdiff_t *);
17384 static struct glyph_row
*
17385 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17386 struct glyph_row
*);
17389 /* Return the last row in MATRIX displaying text. If row START is
17390 non-null, start searching with that row. IT gives the dimensions
17391 of the display. Value is null if matrix is empty; otherwise it is
17392 a pointer to the row found. */
17394 static struct glyph_row
*
17395 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17396 struct glyph_row
*start
)
17398 struct glyph_row
*row
, *row_found
;
17400 /* Set row_found to the last row in IT->w's current matrix
17401 displaying text. The loop looks funny but think of partially
17404 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17405 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17407 eassert (row
->enabled_p
);
17409 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17418 /* Return the last row in the current matrix of W that is not affected
17419 by changes at the start of current_buffer that occurred since W's
17420 current matrix was built. Value is null if no such row exists.
17422 BEG_UNCHANGED us the number of characters unchanged at the start of
17423 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17424 first changed character in current_buffer. Characters at positions <
17425 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17426 when the current matrix was built. */
17428 static struct glyph_row
*
17429 find_last_unchanged_at_beg_row (struct window
*w
)
17431 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17432 struct glyph_row
*row
;
17433 struct glyph_row
*row_found
= NULL
;
17434 int yb
= window_text_bottom_y (w
);
17436 /* Find the last row displaying unchanged text. */
17437 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17438 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17439 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17442 if (/* If row ends before first_changed_pos, it is unchanged,
17443 except in some case. */
17444 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17445 /* When row ends in ZV and we write at ZV it is not
17447 && !row
->ends_at_zv_p
17448 /* When first_changed_pos is the end of a continued line,
17449 row is not unchanged because it may be no longer
17451 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17452 && (row
->continued_p
17453 || row
->exact_window_width_line_p
))
17454 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17455 needs to be recomputed, so don't consider this row as
17456 unchanged. This happens when the last line was
17457 bidi-reordered and was killed immediately before this
17458 redisplay cycle. In that case, ROW->end stores the
17459 buffer position of the first visual-order character of
17460 the killed text, which is now beyond ZV. */
17461 && CHARPOS (row
->end
.pos
) <= ZV
)
17464 /* Stop if last visible row. */
17465 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17473 /* Find the first glyph row in the current matrix of W that is not
17474 affected by changes at the end of current_buffer since the
17475 time W's current matrix was built.
17477 Return in *DELTA the number of chars by which buffer positions in
17478 unchanged text at the end of current_buffer must be adjusted.
17480 Return in *DELTA_BYTES the corresponding number of bytes.
17482 Value is null if no such row exists, i.e. all rows are affected by
17485 static struct glyph_row
*
17486 find_first_unchanged_at_end_row (struct window
*w
,
17487 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17489 struct glyph_row
*row
;
17490 struct glyph_row
*row_found
= NULL
;
17492 *delta
= *delta_bytes
= 0;
17494 /* Display must not have been paused, otherwise the current matrix
17495 is not up to date. */
17496 eassert (w
->window_end_valid
);
17498 /* A value of window_end_pos >= END_UNCHANGED means that the window
17499 end is in the range of changed text. If so, there is no
17500 unchanged row at the end of W's current matrix. */
17501 if (w
->window_end_pos
>= END_UNCHANGED
)
17504 /* Set row to the last row in W's current matrix displaying text. */
17505 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17507 /* If matrix is entirely empty, no unchanged row exists. */
17508 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17510 /* The value of row is the last glyph row in the matrix having a
17511 meaningful buffer position in it. The end position of row
17512 corresponds to window_end_pos. This allows us to translate
17513 buffer positions in the current matrix to current buffer
17514 positions for characters not in changed text. */
17516 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17517 ptrdiff_t Z_BYTE_old
=
17518 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17519 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17520 struct glyph_row
*first_text_row
17521 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17523 *delta
= Z
- Z_old
;
17524 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17526 /* Set last_unchanged_pos to the buffer position of the last
17527 character in the buffer that has not been changed. Z is the
17528 index + 1 of the last character in current_buffer, i.e. by
17529 subtracting END_UNCHANGED we get the index of the last
17530 unchanged character, and we have to add BEG to get its buffer
17532 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17533 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17535 /* Search backward from ROW for a row displaying a line that
17536 starts at a minimum position >= last_unchanged_pos_old. */
17537 for (; row
> first_text_row
; --row
)
17539 /* This used to abort, but it can happen.
17540 It is ok to just stop the search instead here. KFS. */
17541 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17544 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17549 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17555 /* Make sure that glyph rows in the current matrix of window W
17556 reference the same glyph memory as corresponding rows in the
17557 frame's frame matrix. This function is called after scrolling W's
17558 current matrix on a terminal frame in try_window_id and
17559 try_window_reusing_current_matrix. */
17562 sync_frame_with_window_matrix_rows (struct window
*w
)
17564 struct frame
*f
= XFRAME (w
->frame
);
17565 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17567 /* Preconditions: W must be a leaf window and full-width. Its frame
17568 must have a frame matrix. */
17569 eassert (BUFFERP (w
->contents
));
17570 eassert (WINDOW_FULL_WIDTH_P (w
));
17571 eassert (!FRAME_WINDOW_P (f
));
17573 /* If W is a full-width window, glyph pointers in W's current matrix
17574 have, by definition, to be the same as glyph pointers in the
17575 corresponding frame matrix. Note that frame matrices have no
17576 marginal areas (see build_frame_matrix). */
17577 window_row
= w
->current_matrix
->rows
;
17578 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17579 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17580 while (window_row
< window_row_end
)
17582 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17583 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17585 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17586 frame_row
->glyphs
[TEXT_AREA
] = start
;
17587 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17588 frame_row
->glyphs
[LAST_AREA
] = end
;
17590 /* Disable frame rows whose corresponding window rows have
17591 been disabled in try_window_id. */
17592 if (!window_row
->enabled_p
)
17593 frame_row
->enabled_p
= false;
17595 ++window_row
, ++frame_row
;
17600 /* Find the glyph row in window W containing CHARPOS. Consider all
17601 rows between START and END (not inclusive). END null means search
17602 all rows to the end of the display area of W. Value is the row
17603 containing CHARPOS or null. */
17606 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17607 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17609 struct glyph_row
*row
= start
;
17610 struct glyph_row
*best_row
= NULL
;
17611 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17614 /* If we happen to start on a header-line, skip that. */
17615 if (row
->mode_line_p
)
17618 if ((end
&& row
>= end
) || !row
->enabled_p
)
17621 last_y
= window_text_bottom_y (w
) - dy
;
17625 /* Give up if we have gone too far. */
17626 if (end
&& row
>= end
)
17628 /* This formerly returned if they were equal.
17629 I think that both quantities are of a "last plus one" type;
17630 if so, when they are equal, the row is within the screen. -- rms. */
17631 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17634 /* If it is in this row, return this row. */
17635 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17636 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17637 /* The end position of a row equals the start
17638 position of the next row. If CHARPOS is there, we
17639 would rather consider it displayed in the next
17640 line, except when this line ends in ZV. */
17641 && !row_for_charpos_p (row
, charpos
)))
17642 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17646 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17647 || (!best_row
&& !row
->continued_p
))
17649 /* In bidi-reordered rows, there could be several rows whose
17650 edges surround CHARPOS, all of these rows belonging to
17651 the same continued line. We need to find the row which
17652 fits CHARPOS the best. */
17653 for (g
= row
->glyphs
[TEXT_AREA
];
17654 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17657 if (!STRINGP (g
->object
))
17659 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17661 mindif
= eabs (g
->charpos
- charpos
);
17663 /* Exact match always wins. */
17670 else if (best_row
&& !row
->continued_p
)
17677 /* Try to redisplay window W by reusing its existing display. W's
17678 current matrix must be up to date when this function is called,
17679 i.e., window_end_valid must be true.
17683 >= 1 if successful, i.e. display has been updated
17685 1 means the changes were in front of a newline that precedes
17686 the window start, and the whole current matrix was reused
17687 2 means the changes were after the last position displayed
17688 in the window, and the whole current matrix was reused
17689 3 means portions of the current matrix were reused, while
17690 some of the screen lines were redrawn
17691 -1 if redisplay with same window start is known not to succeed
17692 0 if otherwise unsuccessful
17694 The following steps are performed:
17696 1. Find the last row in the current matrix of W that is not
17697 affected by changes at the start of current_buffer. If no such row
17700 2. Find the first row in W's current matrix that is not affected by
17701 changes at the end of current_buffer. Maybe there is no such row.
17703 3. Display lines beginning with the row + 1 found in step 1 to the
17704 row found in step 2 or, if step 2 didn't find a row, to the end of
17707 4. If cursor is not known to appear on the window, give up.
17709 5. If display stopped at the row found in step 2, scroll the
17710 display and current matrix as needed.
17712 6. Maybe display some lines at the end of W, if we must. This can
17713 happen under various circumstances, like a partially visible line
17714 becoming fully visible, or because newly displayed lines are displayed
17715 in smaller font sizes.
17717 7. Update W's window end information. */
17720 try_window_id (struct window
*w
)
17722 struct frame
*f
= XFRAME (w
->frame
);
17723 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17724 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17725 struct glyph_row
*last_unchanged_at_beg_row
;
17726 struct glyph_row
*first_unchanged_at_end_row
;
17727 struct glyph_row
*row
;
17728 struct glyph_row
*bottom_row
;
17731 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17733 struct text_pos start_pos
;
17735 int first_unchanged_at_end_vpos
= 0;
17736 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17737 struct text_pos start
;
17738 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17741 if (inhibit_try_window_id
)
17745 /* This is handy for debugging. */
17747 #define GIVE_UP(X) \
17749 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17753 #define GIVE_UP(X) return 0
17756 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17758 /* Don't use this for mini-windows because these can show
17759 messages and mini-buffers, and we don't handle that here. */
17760 if (MINI_WINDOW_P (w
))
17763 /* This flag is used to prevent redisplay optimizations. */
17764 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17767 /* This function's optimizations cannot be used if overlays have
17768 changed in the buffer displayed by the window, so give up if they
17770 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17773 /* Verify that narrowing has not changed.
17774 Also verify that we were not told to prevent redisplay optimizations.
17775 It would be nice to further
17776 reduce the number of cases where this prevents try_window_id. */
17777 if (current_buffer
->clip_changed
17778 || current_buffer
->prevent_redisplay_optimizations_p
)
17781 /* Window must either use window-based redisplay or be full width. */
17782 if (!FRAME_WINDOW_P (f
)
17783 && (!FRAME_LINE_INS_DEL_OK (f
)
17784 || !WINDOW_FULL_WIDTH_P (w
)))
17787 /* Give up if point is known NOT to appear in W. */
17788 if (PT
< CHARPOS (start
))
17791 /* Another way to prevent redisplay optimizations. */
17792 if (w
->last_modified
== 0)
17795 /* Verify that window is not hscrolled. */
17796 if (w
->hscroll
!= 0)
17799 /* Verify that display wasn't paused. */
17800 if (!w
->window_end_valid
)
17803 /* Likewise if highlighting trailing whitespace. */
17804 if (!NILP (Vshow_trailing_whitespace
))
17807 /* Can't use this if overlay arrow position and/or string have
17809 if (overlay_arrows_changed_p ())
17812 /* When word-wrap is on, adding a space to the first word of a
17813 wrapped line can change the wrap position, altering the line
17814 above it. It might be worthwhile to handle this more
17815 intelligently, but for now just redisplay from scratch. */
17816 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17819 /* Under bidi reordering, adding or deleting a character in the
17820 beginning of a paragraph, before the first strong directional
17821 character, can change the base direction of the paragraph (unless
17822 the buffer specifies a fixed paragraph direction), which will
17823 require to redisplay the whole paragraph. It might be worthwhile
17824 to find the paragraph limits and widen the range of redisplayed
17825 lines to that, but for now just give up this optimization and
17826 redisplay from scratch. */
17827 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17828 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17831 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17832 to that variable require thorough redisplay. */
17833 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17836 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17837 only if buffer has really changed. The reason is that the gap is
17838 initially at Z for freshly visited files. The code below would
17839 set end_unchanged to 0 in that case. */
17840 if (MODIFF
> SAVE_MODIFF
17841 /* This seems to happen sometimes after saving a buffer. */
17842 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17844 if (GPT
- BEG
< BEG_UNCHANGED
)
17845 BEG_UNCHANGED
= GPT
- BEG
;
17846 if (Z
- GPT
< END_UNCHANGED
)
17847 END_UNCHANGED
= Z
- GPT
;
17850 /* The position of the first and last character that has been changed. */
17851 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17852 last_changed_charpos
= Z
- END_UNCHANGED
;
17854 /* If window starts after a line end, and the last change is in
17855 front of that newline, then changes don't affect the display.
17856 This case happens with stealth-fontification. Note that although
17857 the display is unchanged, glyph positions in the matrix have to
17858 be adjusted, of course. */
17859 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17860 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17861 && ((last_changed_charpos
< CHARPOS (start
)
17862 && CHARPOS (start
) == BEGV
)
17863 || (last_changed_charpos
< CHARPOS (start
) - 1
17864 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17866 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17867 struct glyph_row
*r0
;
17869 /* Compute how many chars/bytes have been added to or removed
17870 from the buffer. */
17871 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17872 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17873 Z_delta
= Z
- Z_old
;
17874 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17876 /* Give up if PT is not in the window. Note that it already has
17877 been checked at the start of try_window_id that PT is not in
17878 front of the window start. */
17879 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17882 /* If window start is unchanged, we can reuse the whole matrix
17883 as is, after adjusting glyph positions. No need to compute
17884 the window end again, since its offset from Z hasn't changed. */
17885 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17886 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17887 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17888 /* PT must not be in a partially visible line. */
17889 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17890 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17892 /* Adjust positions in the glyph matrix. */
17893 if (Z_delta
|| Z_delta_bytes
)
17895 struct glyph_row
*r1
17896 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17897 increment_matrix_positions (w
->current_matrix
,
17898 MATRIX_ROW_VPOS (r0
, current_matrix
),
17899 MATRIX_ROW_VPOS (r1
, current_matrix
),
17900 Z_delta
, Z_delta_bytes
);
17903 /* Set the cursor. */
17904 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17906 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17911 /* Handle the case that changes are all below what is displayed in
17912 the window, and that PT is in the window. This shortcut cannot
17913 be taken if ZV is visible in the window, and text has been added
17914 there that is visible in the window. */
17915 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17916 /* ZV is not visible in the window, or there are no
17917 changes at ZV, actually. */
17918 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17919 || first_changed_charpos
== last_changed_charpos
))
17921 struct glyph_row
*r0
;
17923 /* Give up if PT is not in the window. Note that it already has
17924 been checked at the start of try_window_id that PT is not in
17925 front of the window start. */
17926 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17929 /* If window start is unchanged, we can reuse the whole matrix
17930 as is, without changing glyph positions since no text has
17931 been added/removed in front of the window end. */
17932 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17933 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17934 /* PT must not be in a partially visible line. */
17935 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17936 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17938 /* We have to compute the window end anew since text
17939 could have been added/removed after it. */
17940 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17941 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17943 /* Set the cursor. */
17944 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17946 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17951 /* Give up if window start is in the changed area.
17953 The condition used to read
17955 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17957 but why that was tested escapes me at the moment. */
17958 if (CHARPOS (start
) >= first_changed_charpos
17959 && CHARPOS (start
) <= last_changed_charpos
)
17962 /* Check that window start agrees with the start of the first glyph
17963 row in its current matrix. Check this after we know the window
17964 start is not in changed text, otherwise positions would not be
17966 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17967 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17970 /* Give up if the window ends in strings. Overlay strings
17971 at the end are difficult to handle, so don't try. */
17972 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17973 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17976 /* Compute the position at which we have to start displaying new
17977 lines. Some of the lines at the top of the window might be
17978 reusable because they are not displaying changed text. Find the
17979 last row in W's current matrix not affected by changes at the
17980 start of current_buffer. Value is null if changes start in the
17981 first line of window. */
17982 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17983 if (last_unchanged_at_beg_row
)
17985 /* Avoid starting to display in the middle of a character, a TAB
17986 for instance. This is easier than to set up the iterator
17987 exactly, and it's not a frequent case, so the additional
17988 effort wouldn't really pay off. */
17989 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17990 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17991 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17992 --last_unchanged_at_beg_row
;
17994 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17997 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
17999 start_pos
= it
.current
.pos
;
18001 /* Start displaying new lines in the desired matrix at the same
18002 vpos we would use in the current matrix, i.e. below
18003 last_unchanged_at_beg_row. */
18004 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18006 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18007 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18009 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18013 /* There are no reusable lines at the start of the window.
18014 Start displaying in the first text line. */
18015 start_display (&it
, w
, start
);
18016 it
.vpos
= it
.first_vpos
;
18017 start_pos
= it
.current
.pos
;
18020 /* Find the first row that is not affected by changes at the end of
18021 the buffer. Value will be null if there is no unchanged row, in
18022 which case we must redisplay to the end of the window. delta
18023 will be set to the value by which buffer positions beginning with
18024 first_unchanged_at_end_row have to be adjusted due to text
18026 first_unchanged_at_end_row
18027 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18028 IF_DEBUG (debug_delta
= delta
);
18029 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18031 /* Set stop_pos to the buffer position up to which we will have to
18032 display new lines. If first_unchanged_at_end_row != NULL, this
18033 is the buffer position of the start of the line displayed in that
18034 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18035 that we don't stop at a buffer position. */
18037 if (first_unchanged_at_end_row
)
18039 eassert (last_unchanged_at_beg_row
== NULL
18040 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18042 /* If this is a continuation line, move forward to the next one
18043 that isn't. Changes in lines above affect this line.
18044 Caution: this may move first_unchanged_at_end_row to a row
18045 not displaying text. */
18046 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18047 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18048 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18049 < it
.last_visible_y
))
18050 ++first_unchanged_at_end_row
;
18052 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18053 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18054 >= it
.last_visible_y
))
18055 first_unchanged_at_end_row
= NULL
;
18058 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18060 first_unchanged_at_end_vpos
18061 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18062 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18065 else if (last_unchanged_at_beg_row
== NULL
)
18071 /* Either there is no unchanged row at the end, or the one we have
18072 now displays text. This is a necessary condition for the window
18073 end pos calculation at the end of this function. */
18074 eassert (first_unchanged_at_end_row
== NULL
18075 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18077 debug_last_unchanged_at_beg_vpos
18078 = (last_unchanged_at_beg_row
18079 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18081 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18083 #endif /* GLYPH_DEBUG */
18086 /* Display new lines. Set last_text_row to the last new line
18087 displayed which has text on it, i.e. might end up as being the
18088 line where the window_end_vpos is. */
18089 w
->cursor
.vpos
= -1;
18090 last_text_row
= NULL
;
18091 overlay_arrow_seen
= false;
18092 if (it
.current_y
< it
.last_visible_y
18093 && !f
->fonts_changed
18094 && (first_unchanged_at_end_row
== NULL
18095 || IT_CHARPOS (it
) < stop_pos
))
18096 it
.glyph_row
->reversed_p
= false;
18097 while (it
.current_y
< it
.last_visible_y
18098 && !f
->fonts_changed
18099 && (first_unchanged_at_end_row
== NULL
18100 || IT_CHARPOS (it
) < stop_pos
))
18102 if (display_line (&it
))
18103 last_text_row
= it
.glyph_row
- 1;
18106 if (f
->fonts_changed
)
18109 /* The redisplay iterations in display_line above could have
18110 triggered font-lock, which could have done something that
18111 invalidates IT->w window's end-point information, on which we
18112 rely below. E.g., one package, which will remain unnamed, used
18113 to install a font-lock-fontify-region-function that called
18114 bury-buffer, whose side effect is to switch the buffer displayed
18115 by IT->w, and that predictably resets IT->w's window_end_valid
18116 flag, which we already tested at the entry to this function.
18117 Amply punish such packages/modes by giving up on this
18118 optimization in those cases. */
18119 if (!w
->window_end_valid
)
18121 clear_glyph_matrix (w
->desired_matrix
);
18125 /* Compute differences in buffer positions, y-positions etc. for
18126 lines reused at the bottom of the window. Compute what we can
18128 if (first_unchanged_at_end_row
18129 /* No lines reused because we displayed everything up to the
18130 bottom of the window. */
18131 && it
.current_y
< it
.last_visible_y
)
18134 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18136 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18137 run
.current_y
= first_unchanged_at_end_row
->y
;
18138 run
.desired_y
= run
.current_y
+ dy
;
18139 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18143 delta
= delta_bytes
= dvpos
= dy
18144 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18145 first_unchanged_at_end_row
= NULL
;
18147 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18150 /* Find the cursor if not already found. We have to decide whether
18151 PT will appear on this window (it sometimes doesn't, but this is
18152 not a very frequent case.) This decision has to be made before
18153 the current matrix is altered. A value of cursor.vpos < 0 means
18154 that PT is either in one of the lines beginning at
18155 first_unchanged_at_end_row or below the window. Don't care for
18156 lines that might be displayed later at the window end; as
18157 mentioned, this is not a frequent case. */
18158 if (w
->cursor
.vpos
< 0)
18160 /* Cursor in unchanged rows at the top? */
18161 if (PT
< CHARPOS (start_pos
)
18162 && last_unchanged_at_beg_row
)
18164 row
= row_containing_pos (w
, PT
,
18165 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18166 last_unchanged_at_beg_row
+ 1, 0);
18168 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18171 /* Start from first_unchanged_at_end_row looking for PT. */
18172 else if (first_unchanged_at_end_row
)
18174 row
= row_containing_pos (w
, PT
- delta
,
18175 first_unchanged_at_end_row
, NULL
, 0);
18177 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18178 delta_bytes
, dy
, dvpos
);
18181 /* Give up if cursor was not found. */
18182 if (w
->cursor
.vpos
< 0)
18184 clear_glyph_matrix (w
->desired_matrix
);
18189 /* Don't let the cursor end in the scroll margins. */
18191 int this_scroll_margin
, cursor_height
;
18192 int frame_line_height
= default_line_pixel_height (w
);
18193 int window_total_lines
18194 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18196 this_scroll_margin
=
18197 max (0, min (scroll_margin
, window_total_lines
/ 4));
18198 this_scroll_margin
*= frame_line_height
;
18199 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18201 if ((w
->cursor
.y
< this_scroll_margin
18202 && CHARPOS (start
) > BEGV
)
18203 /* Old redisplay didn't take scroll margin into account at the bottom,
18204 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18205 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18206 ? cursor_height
+ this_scroll_margin
18207 : 1)) > it
.last_visible_y
)
18209 w
->cursor
.vpos
= -1;
18210 clear_glyph_matrix (w
->desired_matrix
);
18215 /* Scroll the display. Do it before changing the current matrix so
18216 that xterm.c doesn't get confused about where the cursor glyph is
18218 if (dy
&& run
.height
)
18222 if (FRAME_WINDOW_P (f
))
18224 FRAME_RIF (f
)->update_window_begin_hook (w
);
18225 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18226 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18227 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18231 /* Terminal frame. In this case, dvpos gives the number of
18232 lines to scroll by; dvpos < 0 means scroll up. */
18234 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18235 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18236 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18237 + WINDOW_WANTS_HEADER_LINE_P (w
)
18238 + window_internal_height (w
));
18240 #if defined (HAVE_GPM) || defined (MSDOS)
18241 x_clear_window_mouse_face (w
);
18243 /* Perform the operation on the screen. */
18246 /* Scroll last_unchanged_at_beg_row to the end of the
18247 window down dvpos lines. */
18248 set_terminal_window (f
, end
);
18250 /* On dumb terminals delete dvpos lines at the end
18251 before inserting dvpos empty lines. */
18252 if (!FRAME_SCROLL_REGION_OK (f
))
18253 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18255 /* Insert dvpos empty lines in front of
18256 last_unchanged_at_beg_row. */
18257 ins_del_lines (f
, from
, dvpos
);
18259 else if (dvpos
< 0)
18261 /* Scroll up last_unchanged_at_beg_vpos to the end of
18262 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18263 set_terminal_window (f
, end
);
18265 /* Delete dvpos lines in front of
18266 last_unchanged_at_beg_vpos. ins_del_lines will set
18267 the cursor to the given vpos and emit |dvpos| delete
18269 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18271 /* On a dumb terminal insert dvpos empty lines at the
18273 if (!FRAME_SCROLL_REGION_OK (f
))
18274 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18277 set_terminal_window (f
, 0);
18283 /* Shift reused rows of the current matrix to the right position.
18284 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18286 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18287 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18290 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18291 bottom_vpos
, dvpos
);
18292 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18295 else if (dvpos
> 0)
18297 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18298 bottom_vpos
, dvpos
);
18299 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18300 first_unchanged_at_end_vpos
+ dvpos
);
18303 /* For frame-based redisplay, make sure that current frame and window
18304 matrix are in sync with respect to glyph memory. */
18305 if (!FRAME_WINDOW_P (f
))
18306 sync_frame_with_window_matrix_rows (w
);
18308 /* Adjust buffer positions in reused rows. */
18309 if (delta
|| delta_bytes
)
18310 increment_matrix_positions (current_matrix
,
18311 first_unchanged_at_end_vpos
+ dvpos
,
18312 bottom_vpos
, delta
, delta_bytes
);
18314 /* Adjust Y positions. */
18316 shift_glyph_matrix (w
, current_matrix
,
18317 first_unchanged_at_end_vpos
+ dvpos
,
18320 if (first_unchanged_at_end_row
)
18322 first_unchanged_at_end_row
+= dvpos
;
18323 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18324 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18325 first_unchanged_at_end_row
= NULL
;
18328 /* If scrolling up, there may be some lines to display at the end of
18330 last_text_row_at_end
= NULL
;
18333 /* Scrolling up can leave for example a partially visible line
18334 at the end of the window to be redisplayed. */
18335 /* Set last_row to the glyph row in the current matrix where the
18336 window end line is found. It has been moved up or down in
18337 the matrix by dvpos. */
18338 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18339 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18341 /* If last_row is the window end line, it should display text. */
18342 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18344 /* If window end line was partially visible before, begin
18345 displaying at that line. Otherwise begin displaying with the
18346 line following it. */
18347 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18349 init_to_row_start (&it
, w
, last_row
);
18350 it
.vpos
= last_vpos
;
18351 it
.current_y
= last_row
->y
;
18355 init_to_row_end (&it
, w
, last_row
);
18356 it
.vpos
= 1 + last_vpos
;
18357 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18361 /* We may start in a continuation line. If so, we have to
18362 get the right continuation_lines_width and current_x. */
18363 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18364 it
.hpos
= it
.current_x
= 0;
18366 /* Display the rest of the lines at the window end. */
18367 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18368 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18370 /* Is it always sure that the display agrees with lines in
18371 the current matrix? I don't think so, so we mark rows
18372 displayed invalid in the current matrix by setting their
18373 enabled_p flag to false. */
18374 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18375 if (display_line (&it
))
18376 last_text_row_at_end
= it
.glyph_row
- 1;
18380 /* Update window_end_pos and window_end_vpos. */
18381 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18383 /* Window end line if one of the preserved rows from the current
18384 matrix. Set row to the last row displaying text in current
18385 matrix starting at first_unchanged_at_end_row, after
18387 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18388 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18389 first_unchanged_at_end_row
);
18390 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18391 adjust_window_ends (w
, row
, true);
18392 eassert (w
->window_end_bytepos
>= 0);
18393 IF_DEBUG (debug_method_add (w
, "A"));
18395 else if (last_text_row_at_end
)
18397 adjust_window_ends (w
, last_text_row_at_end
, false);
18398 eassert (w
->window_end_bytepos
>= 0);
18399 IF_DEBUG (debug_method_add (w
, "B"));
18401 else if (last_text_row
)
18403 /* We have displayed either to the end of the window or at the
18404 end of the window, i.e. the last row with text is to be found
18405 in the desired matrix. */
18406 adjust_window_ends (w
, last_text_row
, false);
18407 eassert (w
->window_end_bytepos
>= 0);
18409 else if (first_unchanged_at_end_row
== NULL
18410 && last_text_row
== NULL
18411 && last_text_row_at_end
== NULL
)
18413 /* Displayed to end of window, but no line containing text was
18414 displayed. Lines were deleted at the end of the window. */
18415 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18416 int vpos
= w
->window_end_vpos
;
18417 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18418 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18421 row
== NULL
&& vpos
>= first_vpos
;
18422 --vpos
, --current_row
, --desired_row
)
18424 if (desired_row
->enabled_p
)
18426 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18429 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18433 eassert (row
!= NULL
);
18434 w
->window_end_vpos
= vpos
+ 1;
18435 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18436 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18437 eassert (w
->window_end_bytepos
>= 0);
18438 IF_DEBUG (debug_method_add (w
, "C"));
18443 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18444 debug_end_vpos
= w
->window_end_vpos
));
18446 /* Record that display has not been completed. */
18447 w
->window_end_valid
= false;
18448 w
->desired_matrix
->no_scrolling_p
= true;
18456 /***********************************************************************
18457 More debugging support
18458 ***********************************************************************/
18462 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18463 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18464 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18467 /* Dump the contents of glyph matrix MATRIX on stderr.
18469 GLYPHS 0 means don't show glyph contents.
18470 GLYPHS 1 means show glyphs in short form
18471 GLYPHS > 1 means show glyphs in long form. */
18474 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18477 for (i
= 0; i
< matrix
->nrows
; ++i
)
18478 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18482 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18483 the glyph row and area where the glyph comes from. */
18486 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18488 if (glyph
->type
== CHAR_GLYPH
18489 || glyph
->type
== GLYPHLESS_GLYPH
)
18492 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18493 glyph
- row
->glyphs
[TEXT_AREA
],
18494 (glyph
->type
== CHAR_GLYPH
18498 (BUFFERP (glyph
->object
)
18500 : (STRINGP (glyph
->object
)
18502 : (NILP (glyph
->object
)
18505 glyph
->pixel_width
,
18507 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18511 glyph
->left_box_line_p
,
18512 glyph
->right_box_line_p
);
18514 else if (glyph
->type
== STRETCH_GLYPH
)
18517 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18518 glyph
- row
->glyphs
[TEXT_AREA
],
18521 (BUFFERP (glyph
->object
)
18523 : (STRINGP (glyph
->object
)
18525 : (NILP (glyph
->object
)
18528 glyph
->pixel_width
,
18532 glyph
->left_box_line_p
,
18533 glyph
->right_box_line_p
);
18535 else if (glyph
->type
== IMAGE_GLYPH
)
18538 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18539 glyph
- row
->glyphs
[TEXT_AREA
],
18542 (BUFFERP (glyph
->object
)
18544 : (STRINGP (glyph
->object
)
18546 : (NILP (glyph
->object
)
18549 glyph
->pixel_width
,
18553 glyph
->left_box_line_p
,
18554 glyph
->right_box_line_p
);
18556 else if (glyph
->type
== COMPOSITE_GLYPH
)
18559 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18560 glyph
- row
->glyphs
[TEXT_AREA
],
18563 (BUFFERP (glyph
->object
)
18565 : (STRINGP (glyph
->object
)
18567 : (NILP (glyph
->object
)
18570 glyph
->pixel_width
,
18572 if (glyph
->u
.cmp
.automatic
)
18575 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18576 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18578 glyph
->left_box_line_p
,
18579 glyph
->right_box_line_p
);
18584 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18585 GLYPHS 0 means don't show glyph contents.
18586 GLYPHS 1 means show glyphs in short form
18587 GLYPHS > 1 means show glyphs in long form. */
18590 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18594 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18595 fprintf (stderr
, "==============================================================================\n");
18597 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18598 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18600 MATRIX_ROW_START_CHARPOS (row
),
18601 MATRIX_ROW_END_CHARPOS (row
),
18602 row
->used
[TEXT_AREA
],
18603 row
->contains_overlapping_glyphs_p
,
18605 row
->truncated_on_left_p
,
18606 row
->truncated_on_right_p
,
18608 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18609 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18612 row
->ends_in_middle_of_char_p
,
18613 row
->starts_in_middle_of_char_p
,
18619 row
->visible_height
,
18622 /* The next 3 lines should align to "Start" in the header. */
18623 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18624 row
->end
.overlay_string_index
,
18625 row
->continuation_lines_width
);
18626 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18627 CHARPOS (row
->start
.string_pos
),
18628 CHARPOS (row
->end
.string_pos
));
18629 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18630 row
->end
.dpvec_index
);
18637 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18639 struct glyph
*glyph
= row
->glyphs
[area
];
18640 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18642 /* Glyph for a line end in text. */
18643 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18646 if (glyph
< glyph_end
)
18647 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18649 for (; glyph
< glyph_end
; ++glyph
)
18650 dump_glyph (row
, glyph
, area
);
18653 else if (glyphs
== 1)
18656 char s
[SHRT_MAX
+ 4];
18658 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18662 for (i
= 0; i
< row
->used
[area
]; ++i
)
18664 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18665 if (i
== row
->used
[area
] - 1
18666 && area
== TEXT_AREA
18667 && NILP (glyph
->object
)
18668 && glyph
->type
== CHAR_GLYPH
18669 && glyph
->u
.ch
== ' ')
18671 strcpy (&s
[i
], "[\\n]");
18674 else if (glyph
->type
== CHAR_GLYPH
18675 && glyph
->u
.ch
< 0x80
18676 && glyph
->u
.ch
>= ' ')
18677 s
[i
] = glyph
->u
.ch
;
18683 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18689 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18690 Sdump_glyph_matrix
, 0, 1, "p",
18691 doc
: /* Dump the current matrix of the selected window to stderr.
18692 Shows contents of glyph row structures. With non-nil
18693 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18694 glyphs in short form, otherwise show glyphs in long form.
18696 Interactively, no argument means show glyphs in short form;
18697 with numeric argument, its value is passed as the GLYPHS flag. */)
18698 (Lisp_Object glyphs
)
18700 struct window
*w
= XWINDOW (selected_window
);
18701 struct buffer
*buffer
= XBUFFER (w
->contents
);
18703 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18704 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18705 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18706 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18707 fprintf (stderr
, "=============================================\n");
18708 dump_glyph_matrix (w
->current_matrix
,
18709 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18714 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18715 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18716 Only text-mode frames have frame glyph matrices. */)
18719 struct frame
*f
= XFRAME (selected_frame
);
18721 if (f
->current_matrix
)
18722 dump_glyph_matrix (f
->current_matrix
, 1);
18724 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18729 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18730 doc
: /* Dump glyph row ROW to stderr.
18731 GLYPH 0 means don't dump glyphs.
18732 GLYPH 1 means dump glyphs in short form.
18733 GLYPH > 1 or omitted means dump glyphs in long form. */)
18734 (Lisp_Object row
, Lisp_Object glyphs
)
18736 struct glyph_matrix
*matrix
;
18739 CHECK_NUMBER (row
);
18740 matrix
= XWINDOW (selected_window
)->current_matrix
;
18742 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18743 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18745 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18750 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18751 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18752 GLYPH 0 means don't dump glyphs.
18753 GLYPH 1 means dump glyphs in short form.
18754 GLYPH > 1 or omitted means dump glyphs in long form.
18756 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18758 (Lisp_Object row
, Lisp_Object glyphs
)
18760 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18761 struct frame
*sf
= SELECTED_FRAME ();
18762 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18765 CHECK_NUMBER (row
);
18767 if (vpos
>= 0 && vpos
< m
->nrows
)
18768 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18769 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18775 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18776 doc
: /* Toggle tracing of redisplay.
18777 With ARG, turn tracing on if and only if ARG is positive. */)
18781 trace_redisplay_p
= !trace_redisplay_p
;
18784 arg
= Fprefix_numeric_value (arg
);
18785 trace_redisplay_p
= XINT (arg
) > 0;
18792 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18793 doc
: /* Like `format', but print result to stderr.
18794 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18795 (ptrdiff_t nargs
, Lisp_Object
*args
)
18797 Lisp_Object s
= Fformat (nargs
, args
);
18798 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18802 #endif /* GLYPH_DEBUG */
18806 /***********************************************************************
18807 Building Desired Matrix Rows
18808 ***********************************************************************/
18810 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18811 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18813 static struct glyph_row
*
18814 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18816 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18817 struct buffer
*buffer
= XBUFFER (w
->contents
);
18818 struct buffer
*old
= current_buffer
;
18819 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18820 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18821 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18822 const unsigned char *p
;
18825 int n_glyphs_before
;
18827 set_buffer_temp (buffer
);
18828 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18829 scratch_glyph_row
.reversed_p
= false;
18830 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18831 SET_TEXT_POS (it
.position
, 0, 0);
18833 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18835 while (p
< arrow_end
)
18837 Lisp_Object face
, ilisp
;
18839 /* Get the next character. */
18841 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18844 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18845 if (! ASCII_CHAR_P (it
.c
))
18846 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18850 /* Get its face. */
18851 ilisp
= make_number (p
- arrow_string
);
18852 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18853 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18855 /* Compute its width, get its glyphs. */
18856 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18857 SET_TEXT_POS (it
.position
, -1, -1);
18858 PRODUCE_GLYPHS (&it
);
18860 /* If this character doesn't fit any more in the line, we have
18861 to remove some glyphs. */
18862 if (it
.current_x
> it
.last_visible_x
)
18864 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18869 set_buffer_temp (old
);
18870 return it
.glyph_row
;
18874 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18875 glyphs to insert is determined by produce_special_glyphs. */
18878 insert_left_trunc_glyphs (struct it
*it
)
18880 struct it truncate_it
;
18881 struct glyph
*from
, *end
, *to
, *toend
;
18883 eassert (!FRAME_WINDOW_P (it
->f
)
18884 || (!it
->glyph_row
->reversed_p
18885 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18886 || (it
->glyph_row
->reversed_p
18887 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18889 /* Get the truncation glyphs. */
18891 truncate_it
.current_x
= 0;
18892 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18893 truncate_it
.glyph_row
= &scratch_glyph_row
;
18894 truncate_it
.area
= TEXT_AREA
;
18895 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18896 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18897 truncate_it
.object
= Qnil
;
18898 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18900 /* Overwrite glyphs from IT with truncation glyphs. */
18901 if (!it
->glyph_row
->reversed_p
)
18903 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18905 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18906 end
= from
+ tused
;
18907 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18908 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18909 if (FRAME_WINDOW_P (it
->f
))
18911 /* On GUI frames, when variable-size fonts are displayed,
18912 the truncation glyphs may need more pixels than the row's
18913 glyphs they overwrite. We overwrite more glyphs to free
18914 enough screen real estate, and enlarge the stretch glyph
18915 on the right (see display_line), if there is one, to
18916 preserve the screen position of the truncation glyphs on
18919 struct glyph
*g
= to
;
18922 /* The first glyph could be partially visible, in which case
18923 it->glyph_row->x will be negative. But we want the left
18924 truncation glyphs to be aligned at the left margin of the
18925 window, so we override the x coordinate at which the row
18927 it
->glyph_row
->x
= 0;
18928 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18930 w
+= g
->pixel_width
;
18933 if (g
- to
- tused
> 0)
18935 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18936 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18938 used
= it
->glyph_row
->used
[TEXT_AREA
];
18939 if (it
->glyph_row
->truncated_on_right_p
18940 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18941 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18944 int extra
= w
- it
->truncation_pixel_width
;
18946 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18953 /* There may be padding glyphs left over. Overwrite them too. */
18954 if (!FRAME_WINDOW_P (it
->f
))
18956 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18958 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18965 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18969 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18971 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18972 that back to front. */
18973 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18974 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18975 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18976 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18977 if (FRAME_WINDOW_P (it
->f
))
18980 struct glyph
*g
= to
;
18982 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18984 w
+= g
->pixel_width
;
18987 if (to
- g
- tused
> 0)
18989 if (it
->glyph_row
->truncated_on_right_p
18990 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18991 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18993 int extra
= w
- it
->truncation_pixel_width
;
18995 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18999 while (from
>= end
&& to
>= toend
)
19001 if (!FRAME_WINDOW_P (it
->f
))
19003 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19006 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19007 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19008 while (from
>= end
&& to
>= toend
)
19014 /* Need to free some room before prepending additional
19016 int move_by
= from
- end
+ 1;
19017 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19018 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19020 for ( ; g
>= g0
; g
--)
19022 while (from
>= end
)
19024 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19029 /* Compute the hash code for ROW. */
19031 row_hash (struct glyph_row
*row
)
19034 unsigned hashval
= 0;
19036 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19037 for (k
= 0; k
< row
->used
[area
]; ++k
)
19038 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19039 + row
->glyphs
[area
][k
].u
.val
19040 + row
->glyphs
[area
][k
].face_id
19041 + row
->glyphs
[area
][k
].padding_p
19042 + (row
->glyphs
[area
][k
].type
<< 2));
19047 /* Compute the pixel height and width of IT->glyph_row.
19049 Most of the time, ascent and height of a display line will be equal
19050 to the max_ascent and max_height values of the display iterator
19051 structure. This is not the case if
19053 1. We hit ZV without displaying anything. In this case, max_ascent
19054 and max_height will be zero.
19056 2. We have some glyphs that don't contribute to the line height.
19057 (The glyph row flag contributes_to_line_height_p is for future
19058 pixmap extensions).
19060 The first case is easily covered by using default values because in
19061 these cases, the line height does not really matter, except that it
19062 must not be zero. */
19065 compute_line_metrics (struct it
*it
)
19067 struct glyph_row
*row
= it
->glyph_row
;
19069 if (FRAME_WINDOW_P (it
->f
))
19071 int i
, min_y
, max_y
;
19073 /* The line may consist of one space only, that was added to
19074 place the cursor on it. If so, the row's height hasn't been
19076 if (row
->height
== 0)
19078 if (it
->max_ascent
+ it
->max_descent
== 0)
19079 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19080 row
->ascent
= it
->max_ascent
;
19081 row
->height
= it
->max_ascent
+ it
->max_descent
;
19082 row
->phys_ascent
= it
->max_phys_ascent
;
19083 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19084 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19087 /* Compute the width of this line. */
19088 row
->pixel_width
= row
->x
;
19089 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19090 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19092 eassert (row
->pixel_width
>= 0);
19093 eassert (row
->ascent
>= 0 && row
->height
> 0);
19095 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19096 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19098 /* If first line's physical ascent is larger than its logical
19099 ascent, use the physical ascent, and make the row taller.
19100 This makes accented characters fully visible. */
19101 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19102 && row
->phys_ascent
> row
->ascent
)
19104 row
->height
+= row
->phys_ascent
- row
->ascent
;
19105 row
->ascent
= row
->phys_ascent
;
19108 /* Compute how much of the line is visible. */
19109 row
->visible_height
= row
->height
;
19111 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19112 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19114 if (row
->y
< min_y
)
19115 row
->visible_height
-= min_y
- row
->y
;
19116 if (row
->y
+ row
->height
> max_y
)
19117 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19121 row
->pixel_width
= row
->used
[TEXT_AREA
];
19122 if (row
->continued_p
)
19123 row
->pixel_width
-= it
->continuation_pixel_width
;
19124 else if (row
->truncated_on_right_p
)
19125 row
->pixel_width
-= it
->truncation_pixel_width
;
19126 row
->ascent
= row
->phys_ascent
= 0;
19127 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19128 row
->extra_line_spacing
= 0;
19131 /* Compute a hash code for this row. */
19132 row
->hash
= row_hash (row
);
19134 it
->max_ascent
= it
->max_descent
= 0;
19135 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19139 /* Append one space to the glyph row of iterator IT if doing a
19140 window-based redisplay. The space has the same face as
19141 IT->face_id. Value is true if a space was added.
19143 This function is called to make sure that there is always one glyph
19144 at the end of a glyph row that the cursor can be set on under
19145 window-systems. (If there weren't such a glyph we would not know
19146 how wide and tall a box cursor should be displayed).
19148 At the same time this space let's a nicely handle clearing to the
19149 end of the line if the row ends in italic text. */
19152 append_space_for_newline (struct it
*it
, bool default_face_p
)
19154 if (FRAME_WINDOW_P (it
->f
))
19156 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19158 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19159 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19161 /* Save some values that must not be changed.
19162 Must save IT->c and IT->len because otherwise
19163 ITERATOR_AT_END_P wouldn't work anymore after
19164 append_space_for_newline has been called. */
19165 enum display_element_type saved_what
= it
->what
;
19166 int saved_c
= it
->c
, saved_len
= it
->len
;
19167 int saved_char_to_display
= it
->char_to_display
;
19168 int saved_x
= it
->current_x
;
19169 int saved_face_id
= it
->face_id
;
19170 bool saved_box_end
= it
->end_of_box_run_p
;
19171 struct text_pos saved_pos
;
19172 Lisp_Object saved_object
;
19176 saved_object
= it
->object
;
19177 saved_pos
= it
->position
;
19179 it
->what
= IT_CHARACTER
;
19180 memset (&it
->position
, 0, sizeof it
->position
);
19182 it
->c
= it
->char_to_display
= ' ';
19185 /* If the default face was remapped, be sure to use the
19186 remapped face for the appended newline. */
19187 if (default_face_p
)
19188 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19189 else if (it
->face_before_selective_p
)
19190 it
->face_id
= it
->saved_face_id
;
19191 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19192 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19193 /* In R2L rows, we will prepend a stretch glyph that will
19194 have the end_of_box_run_p flag set for it, so there's no
19195 need for the appended newline glyph to have that flag
19197 if (it
->glyph_row
->reversed_p
19198 /* But if the appended newline glyph goes all the way to
19199 the end of the row, there will be no stretch glyph,
19200 so leave the box flag set. */
19201 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19202 it
->end_of_box_run_p
= false;
19204 PRODUCE_GLYPHS (it
);
19206 #ifdef HAVE_WINDOW_SYSTEM
19207 /* Make sure this space glyph has the right ascent and
19208 descent values, or else cursor at end of line will look
19209 funny, and height of empty lines will be incorrect. */
19210 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19211 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19214 Lisp_Object height
, total_height
;
19215 int extra_line_spacing
= it
->extra_line_spacing
;
19216 int boff
= font
->baseline_offset
;
19218 if (font
->vertical_centering
)
19219 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19221 it
->object
= saved_object
; /* get_it_property needs this */
19222 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19223 /* Must do a subset of line height processing from
19224 x_produce_glyph for newline characters. */
19225 height
= get_it_property (it
, Qline_height
);
19227 && CONSP (XCDR (height
))
19228 && NILP (XCDR (XCDR (height
))))
19230 total_height
= XCAR (XCDR (height
));
19231 height
= XCAR (height
);
19234 total_height
= Qnil
;
19235 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19237 if (it
->override_ascent
>= 0)
19239 it
->ascent
= it
->override_ascent
;
19240 it
->descent
= it
->override_descent
;
19241 boff
= it
->override_boff
;
19243 if (EQ (height
, Qt
))
19244 extra_line_spacing
= 0;
19247 Lisp_Object spacing
;
19249 it
->phys_ascent
= it
->ascent
;
19250 it
->phys_descent
= it
->descent
;
19252 && XINT (height
) > it
->ascent
+ it
->descent
)
19253 it
->ascent
= XINT (height
) - it
->descent
;
19255 if (!NILP (total_height
))
19256 spacing
= calc_line_height_property (it
, total_height
, font
,
19260 spacing
= get_it_property (it
, Qline_spacing
);
19261 spacing
= calc_line_height_property (it
, spacing
, font
,
19264 if (INTEGERP (spacing
))
19266 extra_line_spacing
= XINT (spacing
);
19267 if (!NILP (total_height
))
19268 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19271 if (extra_line_spacing
> 0)
19273 it
->descent
+= extra_line_spacing
;
19274 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19275 it
->max_extra_line_spacing
= extra_line_spacing
;
19277 it
->max_ascent
= it
->ascent
;
19278 it
->max_descent
= it
->descent
;
19279 /* Make sure compute_line_metrics recomputes the row height. */
19280 it
->glyph_row
->height
= 0;
19283 g
->ascent
= it
->max_ascent
;
19284 g
->descent
= it
->max_descent
;
19287 it
->override_ascent
= -1;
19288 it
->constrain_row_ascent_descent_p
= false;
19289 it
->current_x
= saved_x
;
19290 it
->object
= saved_object
;
19291 it
->position
= saved_pos
;
19292 it
->what
= saved_what
;
19293 it
->face_id
= saved_face_id
;
19294 it
->len
= saved_len
;
19296 it
->char_to_display
= saved_char_to_display
;
19297 it
->end_of_box_run_p
= saved_box_end
;
19306 /* Extend the face of the last glyph in the text area of IT->glyph_row
19307 to the end of the display line. Called from display_line. If the
19308 glyph row is empty, add a space glyph to it so that we know the
19309 face to draw. Set the glyph row flag fill_line_p. If the glyph
19310 row is R2L, prepend a stretch glyph to cover the empty space to the
19311 left of the leftmost glyph. */
19314 extend_face_to_end_of_line (struct it
*it
)
19316 struct face
*face
, *default_face
;
19317 struct frame
*f
= it
->f
;
19319 /* If line is already filled, do nothing. Non window-system frames
19320 get a grace of one more ``pixel'' because their characters are
19321 1-``pixel'' wide, so they hit the equality too early. This grace
19322 is needed only for R2L rows that are not continued, to produce
19323 one extra blank where we could display the cursor. */
19324 if ((it
->current_x
>= it
->last_visible_x
19325 + (!FRAME_WINDOW_P (f
)
19326 && it
->glyph_row
->reversed_p
19327 && !it
->glyph_row
->continued_p
))
19328 /* If the window has display margins, we will need to extend
19329 their face even if the text area is filled. */
19330 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19331 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19334 /* The default face, possibly remapped. */
19335 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19337 /* Face extension extends the background and box of IT->face_id
19338 to the end of the line. If the background equals the background
19339 of the frame, we don't have to do anything. */
19340 if (it
->face_before_selective_p
)
19341 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19343 face
= FACE_FROM_ID (f
, it
->face_id
);
19345 if (FRAME_WINDOW_P (f
)
19346 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19347 && face
->box
== FACE_NO_BOX
19348 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19349 #ifdef HAVE_WINDOW_SYSTEM
19352 && !it
->glyph_row
->reversed_p
)
19355 /* Set the glyph row flag indicating that the face of the last glyph
19356 in the text area has to be drawn to the end of the text area. */
19357 it
->glyph_row
->fill_line_p
= true;
19359 /* If current character of IT is not ASCII, make sure we have the
19360 ASCII face. This will be automatically undone the next time
19361 get_next_display_element returns a multibyte character. Note
19362 that the character will always be single byte in unibyte
19364 if (!ASCII_CHAR_P (it
->c
))
19366 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19369 if (FRAME_WINDOW_P (f
))
19371 /* If the row is empty, add a space with the current face of IT,
19372 so that we know which face to draw. */
19373 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19375 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19376 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19377 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19379 /* Mode line and the header line don't have margins, and
19380 likewise the frame's tool-bar window, if there is any. */
19381 if (!(it
->glyph_row
->mode_line_p
19382 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19383 || (WINDOWP (f
->tool_bar_window
)
19384 && it
->w
== XWINDOW (f
->tool_bar_window
))
19388 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19389 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19391 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19392 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19394 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19396 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19397 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19399 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19400 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19402 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19405 #ifdef HAVE_WINDOW_SYSTEM
19406 if (it
->glyph_row
->reversed_p
)
19408 /* Prepend a stretch glyph to the row, such that the
19409 rightmost glyph will be drawn flushed all the way to the
19410 right margin of the window. The stretch glyph that will
19411 occupy the empty space, if any, to the left of the
19413 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19414 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19415 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19417 int row_width
, stretch_ascent
, stretch_width
;
19418 struct text_pos saved_pos
;
19420 bool saved_avoid_cursor
, saved_box_start
;
19422 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19423 row_width
+= g
->pixel_width
;
19425 /* FIXME: There are various minor display glitches in R2L
19426 rows when only one of the fringes is missing. The
19427 strange condition below produces the least bad effect. */
19428 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19429 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19430 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19431 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19433 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19434 stretch_width
-= row_width
;
19436 if (stretch_width
> 0)
19439 (((it
->ascent
+ it
->descent
)
19440 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19441 saved_pos
= it
->position
;
19442 memset (&it
->position
, 0, sizeof it
->position
);
19443 saved_avoid_cursor
= it
->avoid_cursor_p
;
19444 it
->avoid_cursor_p
= true;
19445 saved_face_id
= it
->face_id
;
19446 saved_box_start
= it
->start_of_box_run_p
;
19447 /* The last row's stretch glyph should get the default
19448 face, to avoid painting the rest of the window with
19449 the region face, if the region ends at ZV. */
19450 if (it
->glyph_row
->ends_at_zv_p
)
19451 it
->face_id
= default_face
->id
;
19453 it
->face_id
= face
->id
;
19454 it
->start_of_box_run_p
= false;
19455 append_stretch_glyph (it
, Qnil
, stretch_width
,
19456 it
->ascent
+ it
->descent
, stretch_ascent
);
19457 it
->position
= saved_pos
;
19458 it
->avoid_cursor_p
= saved_avoid_cursor
;
19459 it
->face_id
= saved_face_id
;
19460 it
->start_of_box_run_p
= saved_box_start
;
19462 /* If stretch_width comes out negative, it means that the
19463 last glyph is only partially visible. In R2L rows, we
19464 want the leftmost glyph to be partially visible, so we
19465 need to give the row the corresponding left offset. */
19466 if (stretch_width
< 0)
19467 it
->glyph_row
->x
= stretch_width
;
19469 #endif /* HAVE_WINDOW_SYSTEM */
19473 /* Save some values that must not be changed. */
19474 int saved_x
= it
->current_x
;
19475 struct text_pos saved_pos
;
19476 Lisp_Object saved_object
;
19477 enum display_element_type saved_what
= it
->what
;
19478 int saved_face_id
= it
->face_id
;
19480 saved_object
= it
->object
;
19481 saved_pos
= it
->position
;
19483 it
->what
= IT_CHARACTER
;
19484 memset (&it
->position
, 0, sizeof it
->position
);
19486 it
->c
= it
->char_to_display
= ' ';
19489 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19490 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19491 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19492 && !it
->glyph_row
->mode_line_p
19493 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19495 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19496 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19498 for (it
->current_x
= 0; g
< e
; g
++)
19499 it
->current_x
+= g
->pixel_width
;
19501 it
->area
= LEFT_MARGIN_AREA
;
19502 it
->face_id
= default_face
->id
;
19503 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19504 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19506 PRODUCE_GLYPHS (it
);
19507 /* term.c:produce_glyphs advances it->current_x only for
19509 it
->current_x
+= it
->pixel_width
;
19512 it
->current_x
= saved_x
;
19513 it
->area
= TEXT_AREA
;
19516 /* The last row's blank glyphs should get the default face, to
19517 avoid painting the rest of the window with the region face,
19518 if the region ends at ZV. */
19519 if (it
->glyph_row
->ends_at_zv_p
)
19520 it
->face_id
= default_face
->id
;
19522 it
->face_id
= face
->id
;
19523 PRODUCE_GLYPHS (it
);
19525 while (it
->current_x
<= it
->last_visible_x
)
19526 PRODUCE_GLYPHS (it
);
19528 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19529 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19530 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19531 && !it
->glyph_row
->mode_line_p
19532 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19534 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19535 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19537 for ( ; g
< e
; g
++)
19538 it
->current_x
+= g
->pixel_width
;
19540 it
->area
= RIGHT_MARGIN_AREA
;
19541 it
->face_id
= default_face
->id
;
19542 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19543 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19545 PRODUCE_GLYPHS (it
);
19546 it
->current_x
+= it
->pixel_width
;
19549 it
->area
= TEXT_AREA
;
19552 /* Don't count these blanks really. It would let us insert a left
19553 truncation glyph below and make us set the cursor on them, maybe. */
19554 it
->current_x
= saved_x
;
19555 it
->object
= saved_object
;
19556 it
->position
= saved_pos
;
19557 it
->what
= saved_what
;
19558 it
->face_id
= saved_face_id
;
19563 /* Value is true if text starting at CHARPOS in current_buffer is
19564 trailing whitespace. */
19567 trailing_whitespace_p (ptrdiff_t charpos
)
19569 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19572 while (bytepos
< ZV_BYTE
19573 && (c
= FETCH_CHAR (bytepos
),
19574 c
== ' ' || c
== '\t'))
19577 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19579 if (bytepos
!= PT_BYTE
)
19586 /* Highlight trailing whitespace, if any, in ROW. */
19589 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19591 int used
= row
->used
[TEXT_AREA
];
19595 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19596 struct glyph
*glyph
= start
+ used
- 1;
19598 if (row
->reversed_p
)
19600 /* Right-to-left rows need to be processed in the opposite
19601 direction, so swap the edge pointers. */
19603 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19606 /* Skip over glyphs inserted to display the cursor at the
19607 end of a line, for extending the face of the last glyph
19608 to the end of the line on terminals, and for truncation
19609 and continuation glyphs. */
19610 if (!row
->reversed_p
)
19612 while (glyph
>= start
19613 && glyph
->type
== CHAR_GLYPH
19614 && NILP (glyph
->object
))
19619 while (glyph
<= start
19620 && glyph
->type
== CHAR_GLYPH
19621 && NILP (glyph
->object
))
19625 /* If last glyph is a space or stretch, and it's trailing
19626 whitespace, set the face of all trailing whitespace glyphs in
19627 IT->glyph_row to `trailing-whitespace'. */
19628 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19629 && BUFFERP (glyph
->object
)
19630 && (glyph
->type
== STRETCH_GLYPH
19631 || (glyph
->type
== CHAR_GLYPH
19632 && glyph
->u
.ch
== ' '))
19633 && trailing_whitespace_p (glyph
->charpos
))
19635 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19639 if (!row
->reversed_p
)
19641 while (glyph
>= start
19642 && BUFFERP (glyph
->object
)
19643 && (glyph
->type
== STRETCH_GLYPH
19644 || (glyph
->type
== CHAR_GLYPH
19645 && glyph
->u
.ch
== ' ')))
19646 (glyph
--)->face_id
= face_id
;
19650 while (glyph
<= start
19651 && BUFFERP (glyph
->object
)
19652 && (glyph
->type
== STRETCH_GLYPH
19653 || (glyph
->type
== CHAR_GLYPH
19654 && glyph
->u
.ch
== ' ')))
19655 (glyph
++)->face_id
= face_id
;
19662 /* Value is true if glyph row ROW should be
19663 considered to hold the buffer position CHARPOS. */
19666 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19668 bool result
= true;
19670 if (charpos
== CHARPOS (row
->end
.pos
)
19671 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19673 /* Suppose the row ends on a string.
19674 Unless the row is continued, that means it ends on a newline
19675 in the string. If it's anything other than a display string
19676 (e.g., a before-string from an overlay), we don't want the
19677 cursor there. (This heuristic seems to give the optimal
19678 behavior for the various types of multi-line strings.)
19679 One exception: if the string has `cursor' property on one of
19680 its characters, we _do_ want the cursor there. */
19681 if (CHARPOS (row
->end
.string_pos
) >= 0)
19683 if (row
->continued_p
)
19687 /* Check for `display' property. */
19688 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19689 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19690 struct glyph
*glyph
;
19693 for (glyph
= end
; glyph
>= beg
; --glyph
)
19694 if (STRINGP (glyph
->object
))
19697 = Fget_char_property (make_number (charpos
),
19701 && display_prop_string_p (prop
, glyph
->object
));
19702 /* If there's a `cursor' property on one of the
19703 string's characters, this row is a cursor row,
19704 even though this is not a display string. */
19707 Lisp_Object s
= glyph
->object
;
19709 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19711 ptrdiff_t gpos
= glyph
->charpos
;
19713 if (!NILP (Fget_char_property (make_number (gpos
),
19725 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19727 /* If the row ends in middle of a real character,
19728 and the line is continued, we want the cursor here.
19729 That's because CHARPOS (ROW->end.pos) would equal
19730 PT if PT is before the character. */
19731 if (!row
->ends_in_ellipsis_p
)
19732 result
= row
->continued_p
;
19734 /* If the row ends in an ellipsis, then
19735 CHARPOS (ROW->end.pos) will equal point after the
19736 invisible text. We want that position to be displayed
19737 after the ellipsis. */
19740 /* If the row ends at ZV, display the cursor at the end of that
19741 row instead of at the start of the row below. */
19743 result
= row
->ends_at_zv_p
;
19749 /* Value is true if glyph row ROW should be
19750 used to hold the cursor. */
19753 cursor_row_p (struct glyph_row
*row
)
19755 return row_for_charpos_p (row
, PT
);
19760 /* Push the property PROP so that it will be rendered at the current
19761 position in IT. Return true if PROP was successfully pushed, false
19762 otherwise. Called from handle_line_prefix to handle the
19763 `line-prefix' and `wrap-prefix' properties. */
19766 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19768 struct text_pos pos
=
19769 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19771 eassert (it
->method
== GET_FROM_BUFFER
19772 || it
->method
== GET_FROM_DISPLAY_VECTOR
19773 || it
->method
== GET_FROM_STRING
);
19775 /* We need to save the current buffer/string position, so it will be
19776 restored by pop_it, because iterate_out_of_display_property
19777 depends on that being set correctly, but some situations leave
19778 it->position not yet set when this function is called. */
19779 push_it (it
, &pos
);
19781 if (STRINGP (prop
))
19783 if (SCHARS (prop
) == 0)
19790 it
->string_from_prefix_prop_p
= true;
19791 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19792 it
->current
.overlay_string_index
= -1;
19793 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19794 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19795 it
->method
= GET_FROM_STRING
;
19796 it
->stop_charpos
= 0;
19798 it
->base_level_stop
= 0;
19800 /* Force paragraph direction to be that of the parent
19802 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19803 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19805 it
->paragraph_embedding
= L2R
;
19807 /* Set up the bidi iterator for this display string. */
19810 it
->bidi_it
.string
.lstring
= it
->string
;
19811 it
->bidi_it
.string
.s
= NULL
;
19812 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19813 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19814 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19815 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19816 it
->bidi_it
.w
= it
->w
;
19817 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19820 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19822 it
->method
= GET_FROM_STRETCH
;
19825 #ifdef HAVE_WINDOW_SYSTEM
19826 else if (IMAGEP (prop
))
19828 it
->what
= IT_IMAGE
;
19829 it
->image_id
= lookup_image (it
->f
, prop
);
19830 it
->method
= GET_FROM_IMAGE
;
19832 #endif /* HAVE_WINDOW_SYSTEM */
19835 pop_it (it
); /* bogus display property, give up */
19842 /* Return the character-property PROP at the current position in IT. */
19845 get_it_property (struct it
*it
, Lisp_Object prop
)
19847 Lisp_Object position
, object
= it
->object
;
19849 if (STRINGP (object
))
19850 position
= make_number (IT_STRING_CHARPOS (*it
));
19851 else if (BUFFERP (object
))
19853 position
= make_number (IT_CHARPOS (*it
));
19854 object
= it
->window
;
19859 return Fget_char_property (position
, prop
, object
);
19862 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19865 handle_line_prefix (struct it
*it
)
19867 Lisp_Object prefix
;
19869 if (it
->continuation_lines_width
> 0)
19871 prefix
= get_it_property (it
, Qwrap_prefix
);
19873 prefix
= Vwrap_prefix
;
19877 prefix
= get_it_property (it
, Qline_prefix
);
19879 prefix
= Vline_prefix
;
19881 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19883 /* If the prefix is wider than the window, and we try to wrap
19884 it, it would acquire its own wrap prefix, and so on till the
19885 iterator stack overflows. So, don't wrap the prefix. */
19886 it
->line_wrap
= TRUNCATE
;
19887 it
->avoid_cursor_p
= true;
19893 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19894 only for R2L lines from display_line and display_string, when they
19895 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19896 the line/string needs to be continued on the next glyph row. */
19898 unproduce_glyphs (struct it
*it
, int n
)
19900 struct glyph
*glyph
, *end
;
19902 eassert (it
->glyph_row
);
19903 eassert (it
->glyph_row
->reversed_p
);
19904 eassert (it
->area
== TEXT_AREA
);
19905 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19907 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19908 n
= it
->glyph_row
->used
[TEXT_AREA
];
19909 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19910 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19911 for ( ; glyph
< end
; glyph
++)
19912 glyph
[-n
] = *glyph
;
19915 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19916 and ROW->maxpos. */
19918 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19919 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19920 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19922 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19923 lines' rows is implemented for bidi-reordered rows. */
19925 /* ROW->minpos is the value of min_pos, the minimal buffer position
19926 we have in ROW, or ROW->start.pos if that is smaller. */
19927 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19928 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19930 /* We didn't find buffer positions smaller than ROW->start, or
19931 didn't find _any_ valid buffer positions in any of the glyphs,
19932 so we must trust the iterator's computed positions. */
19933 row
->minpos
= row
->start
.pos
;
19936 max_pos
= CHARPOS (it
->current
.pos
);
19937 max_bpos
= BYTEPOS (it
->current
.pos
);
19940 /* Here are the various use-cases for ending the row, and the
19941 corresponding values for ROW->maxpos:
19943 Line ends in a newline from buffer eol_pos + 1
19944 Line is continued from buffer max_pos + 1
19945 Line is truncated on right it->current.pos
19946 Line ends in a newline from string max_pos + 1(*)
19947 (*) + 1 only when line ends in a forward scan
19948 Line is continued from string max_pos
19949 Line is continued from display vector max_pos
19950 Line is entirely from a string min_pos == max_pos
19951 Line is entirely from a display vector min_pos == max_pos
19952 Line that ends at ZV ZV
19954 If you discover other use-cases, please add them here as
19956 if (row
->ends_at_zv_p
)
19957 row
->maxpos
= it
->current
.pos
;
19958 else if (row
->used
[TEXT_AREA
])
19960 bool seen_this_string
= false;
19961 struct glyph_row
*r1
= row
- 1;
19963 /* Did we see the same display string on the previous row? */
19964 if (STRINGP (it
->object
)
19965 /* this is not the first row */
19966 && row
> it
->w
->desired_matrix
->rows
19967 /* previous row is not the header line */
19968 && !r1
->mode_line_p
19969 /* previous row also ends in a newline from a string */
19970 && r1
->ends_in_newline_from_string_p
)
19972 struct glyph
*start
, *end
;
19974 /* Search for the last glyph of the previous row that came
19975 from buffer or string. Depending on whether the row is
19976 L2R or R2L, we need to process it front to back or the
19977 other way round. */
19978 if (!r1
->reversed_p
)
19980 start
= r1
->glyphs
[TEXT_AREA
];
19981 end
= start
+ r1
->used
[TEXT_AREA
];
19982 /* Glyphs inserted by redisplay have nil as their object. */
19984 && NILP ((end
- 1)->object
)
19985 && (end
- 1)->charpos
<= 0)
19989 if (EQ ((end
- 1)->object
, it
->object
))
19990 seen_this_string
= true;
19993 /* If all the glyphs of the previous row were inserted
19994 by redisplay, it means the previous row was
19995 produced from a single newline, which is only
19996 possible if that newline came from the same string
19997 as the one which produced this ROW. */
19998 seen_this_string
= true;
20002 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20003 start
= end
+ r1
->used
[TEXT_AREA
];
20005 && NILP ((end
+ 1)->object
)
20006 && (end
+ 1)->charpos
<= 0)
20010 if (EQ ((end
+ 1)->object
, it
->object
))
20011 seen_this_string
= true;
20014 seen_this_string
= true;
20017 /* Take note of each display string that covers a newline only
20018 once, the first time we see it. This is for when a display
20019 string includes more than one newline in it. */
20020 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20022 /* If we were scanning the buffer forward when we displayed
20023 the string, we want to account for at least one buffer
20024 position that belongs to this row (position covered by
20025 the display string), so that cursor positioning will
20026 consider this row as a candidate when point is at the end
20027 of the visual line represented by this row. This is not
20028 required when scanning back, because max_pos will already
20029 have a much larger value. */
20030 if (CHARPOS (row
->end
.pos
) > max_pos
)
20031 INC_BOTH (max_pos
, max_bpos
);
20032 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20034 else if (CHARPOS (it
->eol_pos
) > 0)
20035 SET_TEXT_POS (row
->maxpos
,
20036 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20037 else if (row
->continued_p
)
20039 /* If max_pos is different from IT's current position, it
20040 means IT->method does not belong to the display element
20041 at max_pos. However, it also means that the display
20042 element at max_pos was displayed in its entirety on this
20043 line, which is equivalent to saying that the next line
20044 starts at the next buffer position. */
20045 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20046 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20049 INC_BOTH (max_pos
, max_bpos
);
20050 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20053 else if (row
->truncated_on_right_p
)
20054 /* display_line already called reseat_at_next_visible_line_start,
20055 which puts the iterator at the beginning of the next line, in
20056 the logical order. */
20057 row
->maxpos
= it
->current
.pos
;
20058 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20059 /* A line that is entirely from a string/image/stretch... */
20060 row
->maxpos
= row
->minpos
;
20065 row
->maxpos
= it
->current
.pos
;
20068 /* Construct the glyph row IT->glyph_row in the desired matrix of
20069 IT->w from text at the current position of IT. See dispextern.h
20070 for an overview of struct it. Value is true if
20071 IT->glyph_row displays text, as opposed to a line displaying ZV
20075 display_line (struct it
*it
)
20077 struct glyph_row
*row
= it
->glyph_row
;
20078 Lisp_Object overlay_arrow_string
;
20080 void *wrap_data
= NULL
;
20081 bool may_wrap
= false;
20082 int wrap_x
IF_LINT (= 0);
20083 int wrap_row_used
= -1;
20084 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20085 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20086 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20087 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20088 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20090 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20091 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20092 bool pending_handle_line_prefix
= false;
20094 /* We always start displaying at hpos zero even if hscrolled. */
20095 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20097 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20098 >= it
->w
->desired_matrix
->nrows
)
20100 it
->w
->nrows_scale_factor
++;
20101 it
->f
->fonts_changed
= true;
20105 /* Clear the result glyph row and enable it. */
20106 prepare_desired_row (it
->w
, row
, false);
20108 row
->y
= it
->current_y
;
20109 row
->start
= it
->start
;
20110 row
->continuation_lines_width
= it
->continuation_lines_width
;
20111 row
->displays_text_p
= true;
20112 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20113 it
->starts_in_middle_of_char_p
= false;
20115 /* Arrange the overlays nicely for our purposes. Usually, we call
20116 display_line on only one line at a time, in which case this
20117 can't really hurt too much, or we call it on lines which appear
20118 one after another in the buffer, in which case all calls to
20119 recenter_overlay_lists but the first will be pretty cheap. */
20120 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20122 /* Move over display elements that are not visible because we are
20123 hscrolled. This may stop at an x-position < IT->first_visible_x
20124 if the first glyph is partially visible or if we hit a line end. */
20125 if (it
->current_x
< it
->first_visible_x
)
20127 enum move_it_result move_result
;
20129 this_line_min_pos
= row
->start
.pos
;
20130 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20131 MOVE_TO_POS
| MOVE_TO_X
);
20132 /* If we are under a large hscroll, move_it_in_display_line_to
20133 could hit the end of the line without reaching
20134 it->first_visible_x. Pretend that we did reach it. This is
20135 especially important on a TTY, where we will call
20136 extend_face_to_end_of_line, which needs to know how many
20137 blank glyphs to produce. */
20138 if (it
->current_x
< it
->first_visible_x
20139 && (move_result
== MOVE_NEWLINE_OR_CR
20140 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20141 it
->current_x
= it
->first_visible_x
;
20143 /* Record the smallest positions seen while we moved over
20144 display elements that are not visible. This is needed by
20145 redisplay_internal for optimizing the case where the cursor
20146 stays inside the same line. The rest of this function only
20147 considers positions that are actually displayed, so
20148 RECORD_MAX_MIN_POS will not otherwise record positions that
20149 are hscrolled to the left of the left edge of the window. */
20150 min_pos
= CHARPOS (this_line_min_pos
);
20151 min_bpos
= BYTEPOS (this_line_min_pos
);
20153 else if (it
->area
== TEXT_AREA
)
20155 /* We only do this when not calling move_it_in_display_line_to
20156 above, because that function calls itself handle_line_prefix. */
20157 handle_line_prefix (it
);
20161 /* Line-prefix and wrap-prefix are always displayed in the text
20162 area. But if this is the first call to display_line after
20163 init_iterator, the iterator might have been set up to write
20164 into a marginal area, e.g. if the line begins with some
20165 display property that writes to the margins. So we need to
20166 wait with the call to handle_line_prefix until whatever
20167 writes to the margin has done its job. */
20168 pending_handle_line_prefix
= true;
20171 /* Get the initial row height. This is either the height of the
20172 text hscrolled, if there is any, or zero. */
20173 row
->ascent
= it
->max_ascent
;
20174 row
->height
= it
->max_ascent
+ it
->max_descent
;
20175 row
->phys_ascent
= it
->max_phys_ascent
;
20176 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20177 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20179 /* Utility macro to record max and min buffer positions seen until now. */
20180 #define RECORD_MAX_MIN_POS(IT) \
20183 bool composition_p \
20184 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20185 ptrdiff_t current_pos = \
20186 composition_p ? (IT)->cmp_it.charpos \
20187 : IT_CHARPOS (*(IT)); \
20188 ptrdiff_t current_bpos = \
20189 composition_p ? CHAR_TO_BYTE (current_pos) \
20190 : IT_BYTEPOS (*(IT)); \
20191 if (current_pos < min_pos) \
20193 min_pos = current_pos; \
20194 min_bpos = current_bpos; \
20196 if (IT_CHARPOS (*it) > max_pos) \
20198 max_pos = IT_CHARPOS (*it); \
20199 max_bpos = IT_BYTEPOS (*it); \
20204 /* Loop generating characters. The loop is left with IT on the next
20205 character to display. */
20208 int n_glyphs_before
, hpos_before
, x_before
;
20210 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20212 /* Retrieve the next thing to display. Value is false if end of
20214 if (!get_next_display_element (it
))
20216 /* Maybe add a space at the end of this line that is used to
20217 display the cursor there under X. Set the charpos of the
20218 first glyph of blank lines not corresponding to any text
20220 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20221 row
->exact_window_width_line_p
= true;
20222 else if ((append_space_for_newline (it
, true)
20223 && row
->used
[TEXT_AREA
] == 1)
20224 || row
->used
[TEXT_AREA
] == 0)
20226 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20227 row
->displays_text_p
= false;
20229 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20230 && (!MINI_WINDOW_P (it
->w
)
20231 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20232 row
->indicate_empty_line_p
= true;
20235 it
->continuation_lines_width
= 0;
20236 row
->ends_at_zv_p
= true;
20237 /* A row that displays right-to-left text must always have
20238 its last face extended all the way to the end of line,
20239 even if this row ends in ZV, because we still write to
20240 the screen left to right. We also need to extend the
20241 last face if the default face is remapped to some
20242 different face, otherwise the functions that clear
20243 portions of the screen will clear with the default face's
20244 background color. */
20245 if (row
->reversed_p
20246 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20247 extend_face_to_end_of_line (it
);
20251 /* Now, get the metrics of what we want to display. This also
20252 generates glyphs in `row' (which is IT->glyph_row). */
20253 n_glyphs_before
= row
->used
[TEXT_AREA
];
20256 /* Remember the line height so far in case the next element doesn't
20257 fit on the line. */
20258 if (it
->line_wrap
!= TRUNCATE
)
20260 ascent
= it
->max_ascent
;
20261 descent
= it
->max_descent
;
20262 phys_ascent
= it
->max_phys_ascent
;
20263 phys_descent
= it
->max_phys_descent
;
20265 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20267 if (IT_DISPLAYING_WHITESPACE (it
))
20271 SAVE_IT (wrap_it
, *it
, wrap_data
);
20273 wrap_row_used
= row
->used
[TEXT_AREA
];
20274 wrap_row_ascent
= row
->ascent
;
20275 wrap_row_height
= row
->height
;
20276 wrap_row_phys_ascent
= row
->phys_ascent
;
20277 wrap_row_phys_height
= row
->phys_height
;
20278 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20279 wrap_row_min_pos
= min_pos
;
20280 wrap_row_min_bpos
= min_bpos
;
20281 wrap_row_max_pos
= max_pos
;
20282 wrap_row_max_bpos
= max_bpos
;
20288 PRODUCE_GLYPHS (it
);
20290 /* If this display element was in marginal areas, continue with
20292 if (it
->area
!= TEXT_AREA
)
20294 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20295 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20296 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20297 row
->phys_height
= max (row
->phys_height
,
20298 it
->max_phys_ascent
+ it
->max_phys_descent
);
20299 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20300 it
->max_extra_line_spacing
);
20301 set_iterator_to_next (it
, true);
20302 /* If we didn't handle the line/wrap prefix above, and the
20303 call to set_iterator_to_next just switched to TEXT_AREA,
20304 process the prefix now. */
20305 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20307 pending_handle_line_prefix
= false;
20308 handle_line_prefix (it
);
20313 /* Does the display element fit on the line? If we truncate
20314 lines, we should draw past the right edge of the window. If
20315 we don't truncate, we want to stop so that we can display the
20316 continuation glyph before the right margin. If lines are
20317 continued, there are two possible strategies for characters
20318 resulting in more than 1 glyph (e.g. tabs): Display as many
20319 glyphs as possible in this line and leave the rest for the
20320 continuation line, or display the whole element in the next
20321 line. Original redisplay did the former, so we do it also. */
20322 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20323 hpos_before
= it
->hpos
;
20326 if (/* Not a newline. */
20328 /* Glyphs produced fit entirely in the line. */
20329 && it
->current_x
< it
->last_visible_x
)
20331 it
->hpos
+= nglyphs
;
20332 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20333 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20334 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20335 row
->phys_height
= max (row
->phys_height
,
20336 it
->max_phys_ascent
+ it
->max_phys_descent
);
20337 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20338 it
->max_extra_line_spacing
);
20339 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20340 /* In R2L rows, we arrange in extend_face_to_end_of_line
20341 to add a right offset to the line, by a suitable
20342 change to the stretch glyph that is the leftmost
20343 glyph of the line. */
20344 && !row
->reversed_p
)
20345 row
->x
= x
- it
->first_visible_x
;
20346 /* Record the maximum and minimum buffer positions seen so
20347 far in glyphs that will be displayed by this row. */
20349 RECORD_MAX_MIN_POS (it
);
20354 struct glyph
*glyph
;
20356 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20358 /* Identify the glyphs added by the last call to
20359 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20360 the previous glyphs. */
20361 if (!row
->reversed_p
)
20362 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20364 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20365 new_x
= x
+ glyph
->pixel_width
;
20367 if (/* Lines are continued. */
20368 it
->line_wrap
!= TRUNCATE
20369 && (/* Glyph doesn't fit on the line. */
20370 new_x
> it
->last_visible_x
20371 /* Or it fits exactly on a window system frame. */
20372 || (new_x
== it
->last_visible_x
20373 && FRAME_WINDOW_P (it
->f
)
20374 && (row
->reversed_p
20375 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20376 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20378 /* End of a continued line. */
20381 || (new_x
== it
->last_visible_x
20382 && FRAME_WINDOW_P (it
->f
)
20383 && (row
->reversed_p
20384 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20385 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20387 /* Current glyph is the only one on the line or
20388 fits exactly on the line. We must continue
20389 the line because we can't draw the cursor
20390 after the glyph. */
20391 row
->continued_p
= true;
20392 it
->current_x
= new_x
;
20393 it
->continuation_lines_width
+= new_x
;
20395 if (i
== nglyphs
- 1)
20397 /* If line-wrap is on, check if a previous
20398 wrap point was found. */
20399 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20400 && wrap_row_used
> 0
20401 /* Even if there is a previous wrap
20402 point, continue the line here as
20403 usual, if (i) the previous character
20404 was a space or tab AND (ii) the
20405 current character is not. */
20407 || IT_DISPLAYING_WHITESPACE (it
)))
20410 /* Record the maximum and minimum buffer
20411 positions seen so far in glyphs that will be
20412 displayed by this row. */
20414 RECORD_MAX_MIN_POS (it
);
20415 set_iterator_to_next (it
, true);
20416 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20418 if (!get_next_display_element (it
))
20420 row
->exact_window_width_line_p
= true;
20421 it
->continuation_lines_width
= 0;
20422 row
->continued_p
= false;
20423 row
->ends_at_zv_p
= true;
20425 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20427 row
->continued_p
= false;
20428 row
->exact_window_width_line_p
= true;
20430 /* If line-wrap is on, check if a
20431 previous wrap point was found. */
20432 else if (wrap_row_used
> 0
20433 /* Even if there is a previous wrap
20434 point, continue the line here as
20435 usual, if (i) the previous character
20436 was a space or tab AND (ii) the
20437 current character is not. */
20439 || IT_DISPLAYING_WHITESPACE (it
)))
20444 else if (it
->bidi_p
)
20445 RECORD_MAX_MIN_POS (it
);
20446 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20447 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20448 extend_face_to_end_of_line (it
);
20450 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20451 && !FRAME_WINDOW_P (it
->f
))
20453 /* A padding glyph that doesn't fit on this line.
20454 This means the whole character doesn't fit
20456 if (row
->reversed_p
)
20457 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20458 - n_glyphs_before
);
20459 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20461 /* Fill the rest of the row with continuation
20462 glyphs like in 20.x. */
20463 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20464 < row
->glyphs
[1 + TEXT_AREA
])
20465 produce_special_glyphs (it
, IT_CONTINUATION
);
20467 row
->continued_p
= true;
20468 it
->current_x
= x_before
;
20469 it
->continuation_lines_width
+= x_before
;
20471 /* Restore the height to what it was before the
20472 element not fitting on the line. */
20473 it
->max_ascent
= ascent
;
20474 it
->max_descent
= descent
;
20475 it
->max_phys_ascent
= phys_ascent
;
20476 it
->max_phys_descent
= phys_descent
;
20477 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20478 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20479 extend_face_to_end_of_line (it
);
20481 else if (wrap_row_used
> 0)
20484 if (row
->reversed_p
)
20485 unproduce_glyphs (it
,
20486 row
->used
[TEXT_AREA
] - wrap_row_used
);
20487 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20488 it
->continuation_lines_width
+= wrap_x
;
20489 row
->used
[TEXT_AREA
] = wrap_row_used
;
20490 row
->ascent
= wrap_row_ascent
;
20491 row
->height
= wrap_row_height
;
20492 row
->phys_ascent
= wrap_row_phys_ascent
;
20493 row
->phys_height
= wrap_row_phys_height
;
20494 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20495 min_pos
= wrap_row_min_pos
;
20496 min_bpos
= wrap_row_min_bpos
;
20497 max_pos
= wrap_row_max_pos
;
20498 max_bpos
= wrap_row_max_bpos
;
20499 row
->continued_p
= true;
20500 row
->ends_at_zv_p
= false;
20501 row
->exact_window_width_line_p
= false;
20502 it
->continuation_lines_width
+= x
;
20504 /* Make sure that a non-default face is extended
20505 up to the right margin of the window. */
20506 extend_face_to_end_of_line (it
);
20508 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20510 /* A TAB that extends past the right edge of the
20511 window. This produces a single glyph on
20512 window system frames. We leave the glyph in
20513 this row and let it fill the row, but don't
20514 consume the TAB. */
20515 if ((row
->reversed_p
20516 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20517 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20518 produce_special_glyphs (it
, IT_CONTINUATION
);
20519 it
->continuation_lines_width
+= it
->last_visible_x
;
20520 row
->ends_in_middle_of_char_p
= true;
20521 row
->continued_p
= true;
20522 glyph
->pixel_width
= it
->last_visible_x
- x
;
20523 it
->starts_in_middle_of_char_p
= true;
20524 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20525 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20526 extend_face_to_end_of_line (it
);
20530 /* Something other than a TAB that draws past
20531 the right edge of the window. Restore
20532 positions to values before the element. */
20533 if (row
->reversed_p
)
20534 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20535 - (n_glyphs_before
+ i
));
20536 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20538 /* Display continuation glyphs. */
20539 it
->current_x
= x_before
;
20540 it
->continuation_lines_width
+= x
;
20541 if (!FRAME_WINDOW_P (it
->f
)
20542 || (row
->reversed_p
20543 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20544 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20545 produce_special_glyphs (it
, IT_CONTINUATION
);
20546 row
->continued_p
= true;
20548 extend_face_to_end_of_line (it
);
20550 if (nglyphs
> 1 && i
> 0)
20552 row
->ends_in_middle_of_char_p
= true;
20553 it
->starts_in_middle_of_char_p
= true;
20556 /* Restore the height to what it was before the
20557 element not fitting on the line. */
20558 it
->max_ascent
= ascent
;
20559 it
->max_descent
= descent
;
20560 it
->max_phys_ascent
= phys_ascent
;
20561 it
->max_phys_descent
= phys_descent
;
20566 else if (new_x
> it
->first_visible_x
)
20568 /* Increment number of glyphs actually displayed. */
20571 /* Record the maximum and minimum buffer positions
20572 seen so far in glyphs that will be displayed by
20575 RECORD_MAX_MIN_POS (it
);
20577 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20578 /* Glyph is partially visible, i.e. row starts at
20579 negative X position. Don't do that in R2L
20580 rows, where we arrange to add a right offset to
20581 the line in extend_face_to_end_of_line, by a
20582 suitable change to the stretch glyph that is
20583 the leftmost glyph of the line. */
20584 row
->x
= x
- it
->first_visible_x
;
20585 /* When the last glyph of an R2L row only fits
20586 partially on the line, we need to set row->x to a
20587 negative offset, so that the leftmost glyph is
20588 the one that is partially visible. But if we are
20589 going to produce the truncation glyph, this will
20590 be taken care of in produce_special_glyphs. */
20591 if (row
->reversed_p
20592 && new_x
> it
->last_visible_x
20593 && !(it
->line_wrap
== TRUNCATE
20594 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20596 eassert (FRAME_WINDOW_P (it
->f
));
20597 row
->x
= it
->last_visible_x
- new_x
;
20602 /* Glyph is completely off the left margin of the
20603 window. This should not happen because of the
20604 move_it_in_display_line at the start of this
20605 function, unless the text display area of the
20606 window is empty. */
20607 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20610 /* Even if this display element produced no glyphs at all,
20611 we want to record its position. */
20612 if (it
->bidi_p
&& nglyphs
== 0)
20613 RECORD_MAX_MIN_POS (it
);
20615 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20616 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20617 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20618 row
->phys_height
= max (row
->phys_height
,
20619 it
->max_phys_ascent
+ it
->max_phys_descent
);
20620 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20621 it
->max_extra_line_spacing
);
20623 /* End of this display line if row is continued. */
20624 if (row
->continued_p
|| row
->ends_at_zv_p
)
20629 /* Is this a line end? If yes, we're also done, after making
20630 sure that a non-default face is extended up to the right
20631 margin of the window. */
20632 if (ITERATOR_AT_END_OF_LINE_P (it
))
20634 int used_before
= row
->used
[TEXT_AREA
];
20636 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20638 /* Add a space at the end of the line that is used to
20639 display the cursor there. */
20640 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20641 append_space_for_newline (it
, false);
20643 /* Extend the face to the end of the line. */
20644 extend_face_to_end_of_line (it
);
20646 /* Make sure we have the position. */
20647 if (used_before
== 0)
20648 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20650 /* Record the position of the newline, for use in
20652 it
->eol_pos
= it
->current
.pos
;
20654 /* Consume the line end. This skips over invisible lines. */
20655 set_iterator_to_next (it
, true);
20656 it
->continuation_lines_width
= 0;
20660 /* Proceed with next display element. Note that this skips
20661 over lines invisible because of selective display. */
20662 set_iterator_to_next (it
, true);
20664 /* If we truncate lines, we are done when the last displayed
20665 glyphs reach past the right margin of the window. */
20666 if (it
->line_wrap
== TRUNCATE
20667 && ((FRAME_WINDOW_P (it
->f
)
20668 /* Images are preprocessed in produce_image_glyph such
20669 that they are cropped at the right edge of the
20670 window, so an image glyph will always end exactly at
20671 last_visible_x, even if there's no right fringe. */
20672 && ((row
->reversed_p
20673 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20674 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20675 || it
->what
== IT_IMAGE
))
20676 ? (it
->current_x
>= it
->last_visible_x
)
20677 : (it
->current_x
> it
->last_visible_x
)))
20679 /* Maybe add truncation glyphs. */
20680 if (!FRAME_WINDOW_P (it
->f
)
20681 || (row
->reversed_p
20682 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20683 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20687 if (!row
->reversed_p
)
20689 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20690 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20695 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20696 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20698 /* Remove any padding glyphs at the front of ROW, to
20699 make room for the truncation glyphs we will be
20700 adding below. The loop below always inserts at
20701 least one truncation glyph, so also remove the
20702 last glyph added to ROW. */
20703 unproduce_glyphs (it
, i
+ 1);
20704 /* Adjust i for the loop below. */
20705 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20708 /* produce_special_glyphs overwrites the last glyph, so
20709 we don't want that if we want to keep that last
20710 glyph, which means it's an image. */
20711 if (it
->current_x
> it
->last_visible_x
)
20713 it
->current_x
= x_before
;
20714 if (!FRAME_WINDOW_P (it
->f
))
20716 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20718 row
->used
[TEXT_AREA
] = i
;
20719 produce_special_glyphs (it
, IT_TRUNCATION
);
20724 row
->used
[TEXT_AREA
] = i
;
20725 produce_special_glyphs (it
, IT_TRUNCATION
);
20727 it
->hpos
= hpos_before
;
20730 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20732 /* Don't truncate if we can overflow newline into fringe. */
20733 if (!get_next_display_element (it
))
20735 it
->continuation_lines_width
= 0;
20736 row
->ends_at_zv_p
= true;
20737 row
->exact_window_width_line_p
= true;
20740 if (ITERATOR_AT_END_OF_LINE_P (it
))
20742 row
->exact_window_width_line_p
= true;
20743 goto at_end_of_line
;
20745 it
->current_x
= x_before
;
20746 it
->hpos
= hpos_before
;
20749 row
->truncated_on_right_p
= true;
20750 it
->continuation_lines_width
= 0;
20751 reseat_at_next_visible_line_start (it
, false);
20752 /* We insist below that IT's position be at ZV because in
20753 bidi-reordered lines the character at visible line start
20754 might not be the character that follows the newline in
20755 the logical order. */
20756 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20757 row
->ends_at_zv_p
=
20758 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20760 row
->ends_at_zv_p
= false;
20766 bidi_unshelve_cache (wrap_data
, true);
20768 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20769 at the left window margin. */
20770 if (it
->first_visible_x
20771 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20773 if (!FRAME_WINDOW_P (it
->f
)
20774 || (((row
->reversed_p
20775 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20776 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20777 /* Don't let insert_left_trunc_glyphs overwrite the
20778 first glyph of the row if it is an image. */
20779 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20780 insert_left_trunc_glyphs (it
);
20781 row
->truncated_on_left_p
= true;
20784 /* Remember the position at which this line ends.
20786 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20787 cannot be before the call to find_row_edges below, since that is
20788 where these positions are determined. */
20789 row
->end
= it
->current
;
20792 row
->minpos
= row
->start
.pos
;
20793 row
->maxpos
= row
->end
.pos
;
20797 /* ROW->minpos and ROW->maxpos must be the smallest and
20798 `1 + the largest' buffer positions in ROW. But if ROW was
20799 bidi-reordered, these two positions can be anywhere in the
20800 row, so we must determine them now. */
20801 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20804 /* If the start of this line is the overlay arrow-position, then
20805 mark this glyph row as the one containing the overlay arrow.
20806 This is clearly a mess with variable size fonts. It would be
20807 better to let it be displayed like cursors under X. */
20808 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20809 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20810 !NILP (overlay_arrow_string
)))
20812 /* Overlay arrow in window redisplay is a fringe bitmap. */
20813 if (STRINGP (overlay_arrow_string
))
20815 struct glyph_row
*arrow_row
20816 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20817 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20818 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20819 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20820 struct glyph
*p2
, *end
;
20822 /* Copy the arrow glyphs. */
20823 while (glyph
< arrow_end
)
20826 /* Throw away padding glyphs. */
20828 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20829 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20835 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20840 eassert (INTEGERP (overlay_arrow_string
));
20841 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20843 overlay_arrow_seen
= true;
20846 /* Highlight trailing whitespace. */
20847 if (!NILP (Vshow_trailing_whitespace
))
20848 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20850 /* Compute pixel dimensions of this line. */
20851 compute_line_metrics (it
);
20853 /* Implementation note: No changes in the glyphs of ROW or in their
20854 faces can be done past this point, because compute_line_metrics
20855 computes ROW's hash value and stores it within the glyph_row
20858 /* Record whether this row ends inside an ellipsis. */
20859 row
->ends_in_ellipsis_p
20860 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20861 && it
->ellipsis_p
);
20863 /* Save fringe bitmaps in this row. */
20864 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20865 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20866 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20867 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20869 it
->left_user_fringe_bitmap
= 0;
20870 it
->left_user_fringe_face_id
= 0;
20871 it
->right_user_fringe_bitmap
= 0;
20872 it
->right_user_fringe_face_id
= 0;
20874 /* Maybe set the cursor. */
20875 cvpos
= it
->w
->cursor
.vpos
;
20877 /* In bidi-reordered rows, keep checking for proper cursor
20878 position even if one has been found already, because buffer
20879 positions in such rows change non-linearly with ROW->VPOS,
20880 when a line is continued. One exception: when we are at ZV,
20881 display cursor on the first suitable glyph row, since all
20882 the empty rows after that also have their position set to ZV. */
20883 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20884 lines' rows is implemented for bidi-reordered rows. */
20886 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20887 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20888 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20889 && cursor_row_p (row
))
20890 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20892 /* Prepare for the next line. This line starts horizontally at (X
20893 HPOS) = (0 0). Vertical positions are incremented. As a
20894 convenience for the caller, IT->glyph_row is set to the next
20896 it
->current_x
= it
->hpos
= 0;
20897 it
->current_y
+= row
->height
;
20898 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20901 /* The next row should by default use the same value of the
20902 reversed_p flag as this one. set_iterator_to_next decides when
20903 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20904 the flag accordingly. */
20905 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20906 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20907 it
->start
= row
->end
;
20908 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20910 #undef RECORD_MAX_MIN_POS
20913 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20914 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20915 doc
: /* Return paragraph direction at point in BUFFER.
20916 Value is either `left-to-right' or `right-to-left'.
20917 If BUFFER is omitted or nil, it defaults to the current buffer.
20919 Paragraph direction determines how the text in the paragraph is displayed.
20920 In left-to-right paragraphs, text begins at the left margin of the window
20921 and the reading direction is generally left to right. In right-to-left
20922 paragraphs, text begins at the right margin and is read from right to left.
20924 See also `bidi-paragraph-direction'. */)
20925 (Lisp_Object buffer
)
20927 struct buffer
*buf
= current_buffer
;
20928 struct buffer
*old
= buf
;
20930 if (! NILP (buffer
))
20932 CHECK_BUFFER (buffer
);
20933 buf
= XBUFFER (buffer
);
20936 if (NILP (BVAR (buf
, bidi_display_reordering
))
20937 || NILP (BVAR (buf
, enable_multibyte_characters
))
20938 /* When we are loading loadup.el, the character property tables
20939 needed for bidi iteration are not yet available. */
20940 || !NILP (Vpurify_flag
))
20941 return Qleft_to_right
;
20942 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20943 return BVAR (buf
, bidi_paragraph_direction
);
20946 /* Determine the direction from buffer text. We could try to
20947 use current_matrix if it is up to date, but this seems fast
20948 enough as it is. */
20949 struct bidi_it itb
;
20950 ptrdiff_t pos
= BUF_PT (buf
);
20951 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20953 void *itb_data
= bidi_shelve_cache ();
20955 set_buffer_temp (buf
);
20956 /* bidi_paragraph_init finds the base direction of the paragraph
20957 by searching forward from paragraph start. We need the base
20958 direction of the current or _previous_ paragraph, so we need
20959 to make sure we are within that paragraph. To that end, find
20960 the previous non-empty line. */
20961 if (pos
>= ZV
&& pos
> BEGV
)
20962 DEC_BOTH (pos
, bytepos
);
20963 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20964 if (fast_looking_at (trailing_white_space
,
20965 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20967 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20968 || c
== ' ' || c
== '\t' || c
== '\f')
20970 if (bytepos
<= BEGV_BYTE
)
20975 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20978 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20979 itb
.paragraph_dir
= NEUTRAL_DIR
;
20980 itb
.string
.s
= NULL
;
20981 itb
.string
.lstring
= Qnil
;
20982 itb
.string
.bufpos
= 0;
20983 itb
.string
.from_disp_str
= false;
20984 itb
.string
.unibyte
= false;
20985 /* We have no window to use here for ignoring window-specific
20986 overlays. Using NULL for window pointer will cause
20987 compute_display_string_pos to use the current buffer. */
20989 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
20990 bidi_unshelve_cache (itb_data
, false);
20991 set_buffer_temp (old
);
20992 switch (itb
.paragraph_dir
)
20995 return Qleft_to_right
;
20998 return Qright_to_left
;
21006 DEFUN ("bidi-find-overridden-directionality",
21007 Fbidi_find_overridden_directionality
,
21008 Sbidi_find_overridden_directionality
, 2, 3, 0,
21009 doc
: /* Return position between FROM and TO where directionality was overridden.
21011 This function returns the first character position in the specified
21012 region of OBJECT where there is a character whose `bidi-class' property
21013 is `L', but which was forced to display as `R' by a directional
21014 override, and likewise with characters whose `bidi-class' is `R'
21015 or `AL' that were forced to display as `L'.
21017 If no such character is found, the function returns nil.
21019 OBJECT is a Lisp string or buffer to search for overridden
21020 directionality, and defaults to the current buffer if nil or omitted.
21021 OBJECT can also be a window, in which case the function will search
21022 the buffer displayed in that window. Passing the window instead of
21023 a buffer is preferable when the buffer is displayed in some window,
21024 because this function will then be able to correctly account for
21025 window-specific overlays, which can affect the results.
21027 Strong directional characters `L', `R', and `AL' can have their
21028 intrinsic directionality overridden by directional override
21029 control characters RLO \(u+202e) and LRO \(u+202d). See the
21030 function `get-char-code-property' for a way to inquire about
21031 the `bidi-class' property of a character. */)
21032 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21034 struct buffer
*buf
= current_buffer
;
21035 struct buffer
*old
= buf
;
21036 struct window
*w
= NULL
;
21037 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21038 struct bidi_it itb
;
21039 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21042 if (!NILP (object
))
21044 if (BUFFERP (object
))
21045 buf
= XBUFFER (object
);
21046 else if (WINDOWP (object
))
21048 w
= decode_live_window (object
);
21049 buf
= XBUFFER (w
->contents
);
21050 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21053 CHECK_STRING (object
);
21056 if (STRINGP (object
))
21058 /* Characters in unibyte strings are always treated by bidi.c as
21060 if (!STRING_MULTIBYTE (object
)
21061 /* When we are loading loadup.el, the character property
21062 tables needed for bidi iteration are not yet
21064 || !NILP (Vpurify_flag
))
21067 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21068 if (from_pos
>= SCHARS (object
))
21071 /* Set up the bidi iterator. */
21072 itb_data
= bidi_shelve_cache ();
21073 itb
.paragraph_dir
= NEUTRAL_DIR
;
21074 itb
.string
.lstring
= object
;
21075 itb
.string
.s
= NULL
;
21076 itb
.string
.schars
= SCHARS (object
);
21077 itb
.string
.bufpos
= 0;
21078 itb
.string
.from_disp_str
= false;
21079 itb
.string
.unibyte
= false;
21081 bidi_init_it (0, 0, frame_window_p
, &itb
);
21085 /* Nothing this fancy can happen in unibyte buffers, or in a
21086 buffer that disabled reordering, or if FROM is at EOB. */
21087 if (NILP (BVAR (buf
, bidi_display_reordering
))
21088 || NILP (BVAR (buf
, enable_multibyte_characters
))
21089 /* When we are loading loadup.el, the character property
21090 tables needed for bidi iteration are not yet
21092 || !NILP (Vpurify_flag
))
21095 set_buffer_temp (buf
);
21096 validate_region (&from
, &to
);
21097 from_pos
= XINT (from
);
21098 to_pos
= XINT (to
);
21099 if (from_pos
>= ZV
)
21102 /* Set up the bidi iterator. */
21103 itb_data
= bidi_shelve_cache ();
21104 from_bpos
= CHAR_TO_BYTE (from_pos
);
21105 if (from_pos
== BEGV
)
21107 itb
.charpos
= BEGV
;
21108 itb
.bytepos
= BEGV_BYTE
;
21110 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21112 itb
.charpos
= from_pos
;
21113 itb
.bytepos
= from_bpos
;
21116 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21118 itb
.paragraph_dir
= NEUTRAL_DIR
;
21119 itb
.string
.s
= NULL
;
21120 itb
.string
.lstring
= Qnil
;
21121 itb
.string
.bufpos
= 0;
21122 itb
.string
.from_disp_str
= false;
21123 itb
.string
.unibyte
= false;
21125 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21130 /* For the purposes of this function, the actual base direction of
21131 the paragraph doesn't matter, so just set it to L2R. */
21132 bidi_paragraph_init (L2R
, &itb
, false);
21133 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21135 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21137 bidi_unshelve_cache (itb_data
, false);
21138 set_buffer_temp (old
);
21140 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21143 DEFUN ("move-point-visually", Fmove_point_visually
,
21144 Smove_point_visually
, 1, 1, 0,
21145 doc
: /* Move point in the visual order in the specified DIRECTION.
21146 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21149 Value is the new character position of point. */)
21150 (Lisp_Object direction
)
21152 struct window
*w
= XWINDOW (selected_window
);
21153 struct buffer
*b
= XBUFFER (w
->contents
);
21154 struct glyph_row
*row
;
21156 Lisp_Object paragraph_dir
;
21158 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21159 (!(ROW)->continued_p \
21160 && NILP ((GLYPH)->object) \
21161 && (GLYPH)->type == CHAR_GLYPH \
21162 && (GLYPH)->u.ch == ' ' \
21163 && (GLYPH)->charpos >= 0 \
21164 && !(GLYPH)->avoid_cursor_p)
21166 CHECK_NUMBER (direction
);
21167 dir
= XINT (direction
);
21173 /* If current matrix is up-to-date, we can use the information
21174 recorded in the glyphs, at least as long as the goal is on the
21176 if (w
->window_end_valid
21177 && !windows_or_buffers_changed
21179 && !b
->clip_changed
21180 && !b
->prevent_redisplay_optimizations_p
21181 && !window_outdated (w
)
21182 /* We rely below on the cursor coordinates to be up to date, but
21183 we cannot trust them if some command moved point since the
21184 last complete redisplay. */
21185 && w
->last_point
== BUF_PT (b
)
21186 && w
->cursor
.vpos
>= 0
21187 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21188 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21190 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21191 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21192 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21194 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21196 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21198 SET_PT (g
->charpos
);
21199 w
->cursor
.vpos
= -1;
21200 return make_number (PT
);
21202 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21206 if (BUFFERP (gpt
->object
))
21209 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21210 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21212 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21214 else if (BUFFERP (g
->object
))
21215 new_pos
= g
->charpos
;
21219 w
->cursor
.vpos
= -1;
21220 return make_number (PT
);
21222 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21224 /* Glyphs inserted at the end of a non-empty line for
21225 positioning the cursor have zero charpos, so we must
21226 deduce the value of point by other means. */
21227 if (g
->charpos
> 0)
21228 SET_PT (g
->charpos
);
21229 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21231 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21232 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21235 w
->cursor
.vpos
= -1;
21236 return make_number (PT
);
21239 if (g
== e
|| NILP (g
->object
))
21241 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21242 goto simulate_display
;
21243 if (!row
->reversed_p
)
21247 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21248 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21249 goto simulate_display
;
21253 if (row
->reversed_p
&& !row
->continued_p
)
21255 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21256 w
->cursor
.vpos
= -1;
21257 return make_number (PT
);
21259 g
= row
->glyphs
[TEXT_AREA
];
21260 e
= g
+ row
->used
[TEXT_AREA
];
21261 for ( ; g
< e
; g
++)
21263 if (BUFFERP (g
->object
)
21264 /* Empty lines have only one glyph, which stands
21265 for the newline, and whose charpos is the
21266 buffer position of the newline. */
21267 || ROW_GLYPH_NEWLINE_P (row
, g
)
21268 /* When the buffer ends in a newline, the line at
21269 EOB also has one glyph, but its charpos is -1. */
21270 || (row
->ends_at_zv_p
21271 && !row
->reversed_p
21272 && NILP (g
->object
)
21273 && g
->type
== CHAR_GLYPH
21274 && g
->u
.ch
== ' '))
21276 if (g
->charpos
> 0)
21277 SET_PT (g
->charpos
);
21278 else if (!row
->reversed_p
21279 && row
->ends_at_zv_p
21284 w
->cursor
.vpos
= -1;
21285 return make_number (PT
);
21291 if (!row
->reversed_p
&& !row
->continued_p
)
21293 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21294 w
->cursor
.vpos
= -1;
21295 return make_number (PT
);
21297 e
= row
->glyphs
[TEXT_AREA
];
21298 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21299 for ( ; g
>= e
; g
--)
21301 if (BUFFERP (g
->object
)
21302 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21304 /* Empty R2L lines on GUI frames have the buffer
21305 position of the newline stored in the stretch
21307 || g
->type
== STRETCH_GLYPH
21308 || (row
->ends_at_zv_p
21310 && NILP (g
->object
)
21311 && g
->type
== CHAR_GLYPH
21312 && g
->u
.ch
== ' '))
21314 if (g
->charpos
> 0)
21315 SET_PT (g
->charpos
);
21316 else if (row
->reversed_p
21317 && row
->ends_at_zv_p
21322 w
->cursor
.vpos
= -1;
21323 return make_number (PT
);
21332 /* If we wind up here, we failed to move by using the glyphs, so we
21333 need to simulate display instead. */
21336 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21338 paragraph_dir
= Qleft_to_right
;
21339 if (EQ (paragraph_dir
, Qright_to_left
))
21341 if (PT
<= BEGV
&& dir
< 0)
21342 xsignal0 (Qbeginning_of_buffer
);
21343 else if (PT
>= ZV
&& dir
> 0)
21344 xsignal0 (Qend_of_buffer
);
21347 struct text_pos pt
;
21349 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21351 bool overshoot_expected
= false;
21352 bool target_is_eol_p
= false;
21354 /* Setup the arena. */
21355 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21356 start_display (&it
, w
, pt
);
21357 /* When lines are truncated, we could be called with point
21358 outside of the windows edges, in which case move_it_*
21359 functions either prematurely stop at window's edge or jump to
21360 the next screen line, whereas we rely below on our ability to
21361 reach point, in order to start from its X coordinate. So we
21362 need to disregard the window's horizontal extent in that case. */
21363 if (it
.line_wrap
== TRUNCATE
)
21364 it
.last_visible_x
= INFINITY
;
21366 if (it
.cmp_it
.id
< 0
21367 && it
.method
== GET_FROM_STRING
21368 && it
.area
== TEXT_AREA
21369 && it
.string_from_display_prop_p
21370 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21371 overshoot_expected
= true;
21373 /* Find the X coordinate of point. We start from the beginning
21374 of this or previous line to make sure we are before point in
21375 the logical order (since the move_it_* functions can only
21378 reseat_at_previous_visible_line_start (&it
);
21379 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21380 if (IT_CHARPOS (it
) != PT
)
21382 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21383 -1, -1, -1, MOVE_TO_POS
);
21384 /* If we missed point because the character there is
21385 displayed out of a display vector that has more than one
21386 glyph, retry expecting overshoot. */
21387 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21388 && it
.current
.dpvec_index
> 0
21389 && !overshoot_expected
)
21391 overshoot_expected
= true;
21394 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21395 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21397 pt_x
= it
.current_x
;
21399 if (dir
> 0 || overshoot_expected
)
21401 struct glyph_row
*row
= it
.glyph_row
;
21403 /* When point is at beginning of line, we don't have
21404 information about the glyph there loaded into struct
21405 it. Calling get_next_display_element fixes that. */
21407 get_next_display_element (&it
);
21408 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21409 it
.glyph_row
= NULL
;
21410 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21411 it
.glyph_row
= row
;
21412 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21413 it, lest it will become out of sync with it's buffer
21415 it
.current_x
= pt_x
;
21418 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21419 pixel_width
= it
.pixel_width
;
21420 if (overshoot_expected
&& at_eol_p
)
21422 else if (pixel_width
<= 0)
21425 /* If there's a display string (or something similar) at point,
21426 we are actually at the glyph to the left of point, so we need
21427 to correct the X coordinate. */
21428 if (overshoot_expected
)
21431 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21433 pt_x
+= pixel_width
;
21436 /* Compute target X coordinate, either to the left or to the
21437 right of point. On TTY frames, all characters have the same
21438 pixel width of 1, so we can use that. On GUI frames we don't
21439 have an easy way of getting at the pixel width of the
21440 character to the left of point, so we use a different method
21441 of getting to that place. */
21443 target_x
= pt_x
+ pixel_width
;
21445 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21447 /* Target X coordinate could be one line above or below the line
21448 of point, in which case we need to adjust the target X
21449 coordinate. Also, if moving to the left, we need to begin at
21450 the left edge of the point's screen line. */
21455 start_display (&it
, w
, pt
);
21456 if (it
.line_wrap
== TRUNCATE
)
21457 it
.last_visible_x
= INFINITY
;
21458 reseat_at_previous_visible_line_start (&it
);
21459 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21461 move_it_by_lines (&it
, pt_vpos
);
21465 move_it_by_lines (&it
, -1);
21466 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21467 target_is_eol_p
= true;
21468 /* Under word-wrap, we don't know the x coordinate of
21469 the last character displayed on the previous line,
21470 which immediately precedes the wrap point. To find
21471 out its x coordinate, we try moving to the right
21472 margin of the window, which will stop at the wrap
21473 point, and then reset target_x to point at the
21474 character that precedes the wrap point. This is not
21475 needed on GUI frames, because (see below) there we
21476 move from the left margin one grapheme cluster at a
21477 time, and stop when we hit the wrap point. */
21478 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21480 void *it_data
= NULL
;
21483 SAVE_IT (it2
, it
, it_data
);
21484 move_it_in_display_line_to (&it
, ZV
, target_x
,
21485 MOVE_TO_POS
| MOVE_TO_X
);
21486 /* If we arrived at target_x, that _is_ the last
21487 character on the previous line. */
21488 if (it
.current_x
!= target_x
)
21489 target_x
= it
.current_x
- 1;
21490 RESTORE_IT (&it
, &it2
, it_data
);
21497 || (target_x
>= it
.last_visible_x
21498 && it
.line_wrap
!= TRUNCATE
))
21501 move_it_by_lines (&it
, 0);
21502 move_it_by_lines (&it
, 1);
21507 /* Move to the target X coordinate. */
21508 #ifdef HAVE_WINDOW_SYSTEM
21509 /* On GUI frames, as we don't know the X coordinate of the
21510 character to the left of point, moving point to the left
21511 requires walking, one grapheme cluster at a time, until we
21512 find ourself at a place immediately to the left of the
21513 character at point. */
21514 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21516 struct text_pos new_pos
;
21517 enum move_it_result rc
= MOVE_X_REACHED
;
21519 if (it
.current_x
== 0)
21520 get_next_display_element (&it
);
21521 if (it
.what
== IT_COMPOSITION
)
21523 new_pos
.charpos
= it
.cmp_it
.charpos
;
21524 new_pos
.bytepos
= -1;
21527 new_pos
= it
.current
.pos
;
21529 while (it
.current_x
+ it
.pixel_width
<= target_x
21530 && (rc
== MOVE_X_REACHED
21531 /* Under word-wrap, move_it_in_display_line_to
21532 stops at correct coordinates, but sometimes
21533 returns MOVE_POS_MATCH_OR_ZV. */
21534 || (it
.line_wrap
== WORD_WRAP
21535 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21537 int new_x
= it
.current_x
+ it
.pixel_width
;
21539 /* For composed characters, we want the position of the
21540 first character in the grapheme cluster (usually, the
21541 composition's base character), whereas it.current
21542 might give us the position of the _last_ one, e.g. if
21543 the composition is rendered in reverse due to bidi
21545 if (it
.what
== IT_COMPOSITION
)
21547 new_pos
.charpos
= it
.cmp_it
.charpos
;
21548 new_pos
.bytepos
= -1;
21551 new_pos
= it
.current
.pos
;
21552 if (new_x
== it
.current_x
)
21554 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21555 MOVE_TO_POS
| MOVE_TO_X
);
21556 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21559 /* The previous position we saw in the loop is the one we
21561 if (new_pos
.bytepos
== -1)
21562 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21563 it
.current
.pos
= new_pos
;
21567 if (it
.current_x
!= target_x
)
21568 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21570 /* If we ended up in a display string that covers point, move to
21571 buffer position to the right in the visual order. */
21574 while (IT_CHARPOS (it
) == PT
)
21576 set_iterator_to_next (&it
, false);
21577 if (!get_next_display_element (&it
))
21582 /* Move point to that position. */
21583 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21586 return make_number (PT
);
21588 #undef ROW_GLYPH_NEWLINE_P
21591 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21592 Sbidi_resolved_levels
, 0, 1, 0,
21593 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21595 The resolved levels are produced by the Emacs bidi reordering engine
21596 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21597 read the Unicode Standard Annex 9 (UAX#9) for background information
21598 about these levels.
21600 VPOS is the zero-based number of the current window's screen line
21601 for which to produce the resolved levels. If VPOS is nil or omitted,
21602 it defaults to the screen line of point. If the window displays a
21603 header line, VPOS of zero will report on the header line, and first
21604 line of text in the window will have VPOS of 1.
21606 Value is an array of resolved levels, indexed by glyph number.
21607 Glyphs are numbered from zero starting from the beginning of the
21608 screen line, i.e. the left edge of the window for left-to-right lines
21609 and from the right edge for right-to-left lines. The resolved levels
21610 are produced only for the window's text area; text in display margins
21613 If the selected window's display is not up-to-date, or if the specified
21614 screen line does not display text, this function returns nil. It is
21615 highly recommended to bind this function to some simple key, like F8,
21616 in order to avoid these problems.
21618 This function exists mainly for testing the correctness of the
21619 Emacs UBA implementation, in particular with the test suite. */)
21622 struct window
*w
= XWINDOW (selected_window
);
21623 struct buffer
*b
= XBUFFER (w
->contents
);
21625 struct glyph_row
*row
;
21629 int d1
, d2
, d3
, d4
, d5
;
21631 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21635 CHECK_NUMBER_COERCE_MARKER (vpos
);
21636 nrow
= XINT (vpos
);
21639 /* We require up-to-date glyph matrix for this window. */
21640 if (w
->window_end_valid
21641 && !windows_or_buffers_changed
21643 && !b
->clip_changed
21644 && !b
->prevent_redisplay_optimizations_p
21645 && !window_outdated (w
)
21647 && nrow
< w
->current_matrix
->nrows
21648 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21649 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21651 struct glyph
*g
, *e
, *g1
;
21653 Lisp_Object levels
;
21655 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21657 g
= g1
= row
->glyphs
[TEXT_AREA
];
21658 e
= g
+ row
->used
[TEXT_AREA
];
21660 /* Skip over glyphs at the start of the row that was
21661 generated by redisplay for its own needs. */
21663 && NILP (g
->object
)
21668 /* Count the "interesting" glyphs in this row. */
21669 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21672 /* Create and fill the array. */
21673 levels
= make_uninit_vector (nglyphs
);
21674 for (i
= 0; g1
< g
; i
++, g1
++)
21675 ASET (levels
, i
, make_number (g1
->resolved_level
));
21677 else /* Right-to-left glyph row. */
21679 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21680 e
= row
->glyphs
[TEXT_AREA
] - 1;
21682 && NILP (g
->object
)
21686 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21688 levels
= make_uninit_vector (nglyphs
);
21689 for (i
= 0; g1
> g
; i
++, g1
--)
21690 ASET (levels
, i
, make_number (g1
->resolved_level
));
21700 /***********************************************************************
21702 ***********************************************************************/
21704 /* Redisplay the menu bar in the frame for window W.
21706 The menu bar of X frames that don't have X toolkit support is
21707 displayed in a special window W->frame->menu_bar_window.
21709 The menu bar of terminal frames is treated specially as far as
21710 glyph matrices are concerned. Menu bar lines are not part of
21711 windows, so the update is done directly on the frame matrix rows
21712 for the menu bar. */
21715 display_menu_bar (struct window
*w
)
21717 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21722 /* Don't do all this for graphical frames. */
21724 if (FRAME_W32_P (f
))
21727 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21733 if (FRAME_NS_P (f
))
21735 #endif /* HAVE_NS */
21737 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21738 eassert (!FRAME_WINDOW_P (f
));
21739 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21740 it
.first_visible_x
= 0;
21741 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21742 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21743 if (FRAME_WINDOW_P (f
))
21745 /* Menu bar lines are displayed in the desired matrix of the
21746 dummy window menu_bar_window. */
21747 struct window
*menu_w
;
21748 menu_w
= XWINDOW (f
->menu_bar_window
);
21749 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21751 it
.first_visible_x
= 0;
21752 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21755 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21757 /* This is a TTY frame, i.e. character hpos/vpos are used as
21759 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21761 it
.first_visible_x
= 0;
21762 it
.last_visible_x
= FRAME_COLS (f
);
21765 /* FIXME: This should be controlled by a user option. See the
21766 comments in redisplay_tool_bar and display_mode_line about
21768 it
.paragraph_embedding
= L2R
;
21770 /* Clear all rows of the menu bar. */
21771 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21773 struct glyph_row
*row
= it
.glyph_row
+ i
;
21774 clear_glyph_row (row
);
21775 row
->enabled_p
= true;
21776 row
->full_width_p
= true;
21777 row
->reversed_p
= false;
21780 /* Display all items of the menu bar. */
21781 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21782 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21784 Lisp_Object string
;
21786 /* Stop at nil string. */
21787 string
= AREF (items
, i
+ 1);
21791 /* Remember where item was displayed. */
21792 ASET (items
, i
+ 3, make_number (it
.hpos
));
21794 /* Display the item, pad with one space. */
21795 if (it
.current_x
< it
.last_visible_x
)
21796 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21797 SCHARS (string
) + 1, 0, 0, -1);
21800 /* Fill out the line with spaces. */
21801 if (it
.current_x
< it
.last_visible_x
)
21802 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21804 /* Compute the total height of the lines. */
21805 compute_line_metrics (&it
);
21808 /* Deep copy of a glyph row, including the glyphs. */
21810 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21812 struct glyph
*pointers
[1 + LAST_AREA
];
21813 int to_used
= to
->used
[TEXT_AREA
];
21815 /* Save glyph pointers of TO. */
21816 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21818 /* Do a structure assignment. */
21821 /* Restore original glyph pointers of TO. */
21822 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21824 /* Copy the glyphs. */
21825 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21826 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21828 /* If we filled only part of the TO row, fill the rest with
21829 space_glyph (which will display as empty space). */
21830 if (to_used
> from
->used
[TEXT_AREA
])
21831 fill_up_frame_row_with_spaces (to
, to_used
);
21834 /* Display one menu item on a TTY, by overwriting the glyphs in the
21835 frame F's desired glyph matrix with glyphs produced from the menu
21836 item text. Called from term.c to display TTY drop-down menus one
21839 ITEM_TEXT is the menu item text as a C string.
21841 FACE_ID is the face ID to be used for this menu item. FACE_ID
21842 could specify one of 3 faces: a face for an enabled item, a face
21843 for a disabled item, or a face for a selected item.
21845 X and Y are coordinates of the first glyph in the frame's desired
21846 matrix to be overwritten by the menu item. Since this is a TTY, Y
21847 is the zero-based number of the glyph row and X is the zero-based
21848 glyph number in the row, starting from left, where to start
21849 displaying the item.
21851 SUBMENU means this menu item drops down a submenu, which
21852 should be indicated by displaying a proper visual cue after the
21856 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21857 int x
, int y
, bool submenu
)
21860 struct frame
*f
= SELECTED_FRAME ();
21861 struct window
*w
= XWINDOW (f
->selected_window
);
21862 struct glyph_row
*row
;
21863 size_t item_len
= strlen (item_text
);
21865 eassert (FRAME_TERMCAP_P (f
));
21867 /* Don't write beyond the matrix's last row. This can happen for
21868 TTY screens that are not high enough to show the entire menu.
21869 (This is actually a bit of defensive programming, as
21870 tty_menu_display already limits the number of menu items to one
21871 less than the number of screen lines.) */
21872 if (y
>= f
->desired_matrix
->nrows
)
21875 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21876 it
.first_visible_x
= 0;
21877 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21878 row
= it
.glyph_row
;
21879 /* Start with the row contents from the current matrix. */
21880 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21881 bool saved_width
= row
->full_width_p
;
21882 row
->full_width_p
= true;
21883 bool saved_reversed
= row
->reversed_p
;
21884 row
->reversed_p
= false;
21885 row
->enabled_p
= true;
21887 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21889 eassert (x
< f
->desired_matrix
->matrix_w
);
21890 it
.current_x
= it
.hpos
= x
;
21891 it
.current_y
= it
.vpos
= y
;
21892 int saved_used
= row
->used
[TEXT_AREA
];
21893 bool saved_truncated
= row
->truncated_on_right_p
;
21894 row
->used
[TEXT_AREA
] = x
;
21895 it
.face_id
= face_id
;
21896 it
.line_wrap
= TRUNCATE
;
21898 /* FIXME: This should be controlled by a user option. See the
21899 comments in redisplay_tool_bar and display_mode_line about this.
21900 Also, if paragraph_embedding could ever be R2L, changes will be
21901 needed to avoid shifting to the right the row characters in
21902 term.c:append_glyph. */
21903 it
.paragraph_embedding
= L2R
;
21905 /* Pad with a space on the left. */
21906 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21908 /* Display the menu item, pad with spaces to WIDTH. */
21911 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21912 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21914 /* Indicate with " >" that there's a submenu. */
21915 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21916 FRAME_COLS (f
) - 1, -1);
21919 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21920 width
, 0, FRAME_COLS (f
) - 1, -1);
21922 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21923 row
->truncated_on_right_p
= saved_truncated
;
21924 row
->hash
= row_hash (row
);
21925 row
->full_width_p
= saved_width
;
21926 row
->reversed_p
= saved_reversed
;
21929 /***********************************************************************
21931 ***********************************************************************/
21933 /* Redisplay mode lines in the window tree whose root is WINDOW.
21934 If FORCE, redisplay mode lines unconditionally.
21935 Otherwise, redisplay only mode lines that are garbaged. Value is
21936 the number of windows whose mode lines were redisplayed. */
21939 redisplay_mode_lines (Lisp_Object window
, bool force
)
21943 while (!NILP (window
))
21945 struct window
*w
= XWINDOW (window
);
21947 if (WINDOWP (w
->contents
))
21948 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21950 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21951 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21953 struct text_pos lpoint
;
21954 struct buffer
*old
= current_buffer
;
21956 /* Set the window's buffer for the mode line display. */
21957 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21958 set_buffer_internal_1 (XBUFFER (w
->contents
));
21960 /* Point refers normally to the selected window. For any
21961 other window, set up appropriate value. */
21962 if (!EQ (window
, selected_window
))
21964 struct text_pos pt
;
21966 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21967 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21970 /* Display mode lines. */
21971 clear_glyph_matrix (w
->desired_matrix
);
21972 if (display_mode_lines (w
))
21975 /* Restore old settings. */
21976 set_buffer_internal_1 (old
);
21977 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21987 /* Display the mode and/or header line of window W. Value is the
21988 sum number of mode lines and header lines displayed. */
21991 display_mode_lines (struct window
*w
)
21993 Lisp_Object old_selected_window
= selected_window
;
21994 Lisp_Object old_selected_frame
= selected_frame
;
21995 Lisp_Object new_frame
= w
->frame
;
21996 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21999 selected_frame
= new_frame
;
22000 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22001 or window's point, then we'd need select_window_1 here as well. */
22002 XSETWINDOW (selected_window
, w
);
22003 XFRAME (new_frame
)->selected_window
= selected_window
;
22005 /* These will be set while the mode line specs are processed. */
22006 line_number_displayed
= false;
22007 w
->column_number_displayed
= -1;
22009 if (WINDOW_WANTS_MODELINE_P (w
))
22011 struct window
*sel_w
= XWINDOW (old_selected_window
);
22013 /* Select mode line face based on the real selected window. */
22014 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22015 BVAR (current_buffer
, mode_line_format
));
22019 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22021 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22022 BVAR (current_buffer
, header_line_format
));
22026 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22027 selected_frame
= old_selected_frame
;
22028 selected_window
= old_selected_window
;
22030 w
->must_be_updated_p
= true;
22035 /* Display mode or header line of window W. FACE_ID specifies which
22036 line to display; it is either MODE_LINE_FACE_ID or
22037 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22038 display. Value is the pixel height of the mode/header line
22042 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22046 ptrdiff_t count
= SPECPDL_INDEX ();
22048 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22049 /* Don't extend on a previously drawn mode-line.
22050 This may happen if called from pos_visible_p. */
22051 it
.glyph_row
->enabled_p
= false;
22052 prepare_desired_row (w
, it
.glyph_row
, true);
22054 it
.glyph_row
->mode_line_p
= true;
22056 /* FIXME: This should be controlled by a user option. But
22057 supporting such an option is not trivial, since the mode line is
22058 made up of many separate strings. */
22059 it
.paragraph_embedding
= L2R
;
22061 record_unwind_protect (unwind_format_mode_line
,
22062 format_mode_line_unwind_data (NULL
, NULL
,
22065 mode_line_target
= MODE_LINE_DISPLAY
;
22067 /* Temporarily make frame's keyboard the current kboard so that
22068 kboard-local variables in the mode_line_format will get the right
22070 push_kboard (FRAME_KBOARD (it
.f
));
22071 record_unwind_save_match_data ();
22072 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22075 unbind_to (count
, Qnil
);
22077 /* Fill up with spaces. */
22078 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22080 compute_line_metrics (&it
);
22081 it
.glyph_row
->full_width_p
= true;
22082 it
.glyph_row
->continued_p
= false;
22083 it
.glyph_row
->truncated_on_left_p
= false;
22084 it
.glyph_row
->truncated_on_right_p
= false;
22086 /* Make a 3D mode-line have a shadow at its right end. */
22087 face
= FACE_FROM_ID (it
.f
, face_id
);
22088 extend_face_to_end_of_line (&it
);
22089 if (face
->box
!= FACE_NO_BOX
)
22091 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22092 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22093 last
->right_box_line_p
= true;
22096 return it
.glyph_row
->height
;
22099 /* Move element ELT in LIST to the front of LIST.
22100 Return the updated list. */
22103 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22105 register Lisp_Object tail
, prev
;
22106 register Lisp_Object tem
;
22110 while (CONSP (tail
))
22116 /* Splice out the link TAIL. */
22118 list
= XCDR (tail
);
22120 Fsetcdr (prev
, XCDR (tail
));
22122 /* Now make it the first. */
22123 Fsetcdr (tail
, list
);
22128 tail
= XCDR (tail
);
22132 /* Not found--return unchanged LIST. */
22136 /* Contribute ELT to the mode line for window IT->w. How it
22137 translates into text depends on its data type.
22139 IT describes the display environment in which we display, as usual.
22141 DEPTH is the depth in recursion. It is used to prevent
22142 infinite recursion here.
22144 FIELD_WIDTH is the number of characters the display of ELT should
22145 occupy in the mode line, and PRECISION is the maximum number of
22146 characters to display from ELT's representation. See
22147 display_string for details.
22149 Returns the hpos of the end of the text generated by ELT.
22151 PROPS is a property list to add to any string we encounter.
22153 If RISKY, remove (disregard) any properties in any string
22154 we encounter, and ignore :eval and :propertize.
22156 The global variable `mode_line_target' determines whether the
22157 output is passed to `store_mode_line_noprop',
22158 `store_mode_line_string', or `display_string'. */
22161 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22162 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22164 int n
= 0, field
, prec
;
22165 bool literal
= false;
22169 elt
= build_string ("*too-deep*");
22173 switch (XTYPE (elt
))
22177 /* A string: output it and check for %-constructs within it. */
22179 ptrdiff_t offset
= 0;
22181 if (SCHARS (elt
) > 0
22182 && (!NILP (props
) || risky
))
22184 Lisp_Object oprops
, aelt
;
22185 oprops
= Ftext_properties_at (make_number (0), elt
);
22187 /* If the starting string's properties are not what
22188 we want, translate the string. Also, if the string
22189 is risky, do that anyway. */
22191 if (NILP (Fequal (props
, oprops
)) || risky
)
22193 /* If the starting string has properties,
22194 merge the specified ones onto the existing ones. */
22195 if (! NILP (oprops
) && !risky
)
22199 oprops
= Fcopy_sequence (oprops
);
22201 while (CONSP (tem
))
22203 oprops
= Fplist_put (oprops
, XCAR (tem
),
22204 XCAR (XCDR (tem
)));
22205 tem
= XCDR (XCDR (tem
));
22210 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22211 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22213 /* AELT is what we want. Move it to the front
22214 without consing. */
22216 mode_line_proptrans_alist
22217 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22223 /* If AELT has the wrong props, it is useless.
22224 so get rid of it. */
22226 mode_line_proptrans_alist
22227 = Fdelq (aelt
, mode_line_proptrans_alist
);
22229 elt
= Fcopy_sequence (elt
);
22230 Fset_text_properties (make_number (0), Flength (elt
),
22232 /* Add this item to mode_line_proptrans_alist. */
22233 mode_line_proptrans_alist
22234 = Fcons (Fcons (elt
, props
),
22235 mode_line_proptrans_alist
);
22236 /* Truncate mode_line_proptrans_alist
22237 to at most 50 elements. */
22238 tem
= Fnthcdr (make_number (50),
22239 mode_line_proptrans_alist
);
22241 XSETCDR (tem
, Qnil
);
22250 prec
= precision
- n
;
22251 switch (mode_line_target
)
22253 case MODE_LINE_NOPROP
:
22254 case MODE_LINE_TITLE
:
22255 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22257 case MODE_LINE_STRING
:
22258 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22260 case MODE_LINE_DISPLAY
:
22261 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22262 0, prec
, 0, STRING_MULTIBYTE (elt
));
22269 /* Handle the non-literal case. */
22271 while ((precision
<= 0 || n
< precision
)
22272 && SREF (elt
, offset
) != 0
22273 && (mode_line_target
!= MODE_LINE_DISPLAY
22274 || it
->current_x
< it
->last_visible_x
))
22276 ptrdiff_t last_offset
= offset
;
22278 /* Advance to end of string or next format specifier. */
22279 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22282 if (offset
- 1 != last_offset
)
22284 ptrdiff_t nchars
, nbytes
;
22286 /* Output to end of string or up to '%'. Field width
22287 is length of string. Don't output more than
22288 PRECISION allows us. */
22291 prec
= c_string_width (SDATA (elt
) + last_offset
,
22292 offset
- last_offset
, precision
- n
,
22295 switch (mode_line_target
)
22297 case MODE_LINE_NOPROP
:
22298 case MODE_LINE_TITLE
:
22299 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22301 case MODE_LINE_STRING
:
22303 ptrdiff_t bytepos
= last_offset
;
22304 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22305 ptrdiff_t endpos
= (precision
<= 0
22306 ? string_byte_to_char (elt
, offset
)
22307 : charpos
+ nchars
);
22308 Lisp_Object mode_string
22309 = Fsubstring (elt
, make_number (charpos
),
22310 make_number (endpos
));
22311 n
+= store_mode_line_string (NULL
, mode_string
, false,
22315 case MODE_LINE_DISPLAY
:
22317 ptrdiff_t bytepos
= last_offset
;
22318 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22320 if (precision
<= 0)
22321 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22322 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22324 STRING_MULTIBYTE (elt
));
22329 else /* c == '%' */
22331 ptrdiff_t percent_position
= offset
;
22333 /* Get the specified minimum width. Zero means
22336 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22337 field
= field
* 10 + c
- '0';
22339 /* Don't pad beyond the total padding allowed. */
22340 if (field_width
- n
> 0 && field
> field_width
- n
)
22341 field
= field_width
- n
;
22343 /* Note that either PRECISION <= 0 or N < PRECISION. */
22344 prec
= precision
- n
;
22347 n
+= display_mode_element (it
, depth
, field
, prec
,
22348 Vglobal_mode_string
, props
,
22353 ptrdiff_t bytepos
, charpos
;
22355 Lisp_Object string
;
22357 bytepos
= percent_position
;
22358 charpos
= (STRING_MULTIBYTE (elt
)
22359 ? string_byte_to_char (elt
, bytepos
)
22361 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22362 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22364 switch (mode_line_target
)
22366 case MODE_LINE_NOPROP
:
22367 case MODE_LINE_TITLE
:
22368 n
+= store_mode_line_noprop (spec
, field
, prec
);
22370 case MODE_LINE_STRING
:
22372 Lisp_Object tem
= build_string (spec
);
22373 props
= Ftext_properties_at (make_number (charpos
), elt
);
22374 /* Should only keep face property in props */
22375 n
+= store_mode_line_string (NULL
, tem
, false,
22376 field
, prec
, props
);
22379 case MODE_LINE_DISPLAY
:
22381 int nglyphs_before
, nwritten
;
22383 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22384 nwritten
= display_string (spec
, string
, elt
,
22389 /* Assign to the glyphs written above the
22390 string where the `%x' came from, position
22394 struct glyph
*glyph
22395 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22399 for (i
= 0; i
< nwritten
; ++i
)
22401 glyph
[i
].object
= elt
;
22402 glyph
[i
].charpos
= charpos
;
22419 /* A symbol: process the value of the symbol recursively
22420 as if it appeared here directly. Avoid error if symbol void.
22421 Special case: if value of symbol is a string, output the string
22424 register Lisp_Object tem
;
22426 /* If the variable is not marked as risky to set
22427 then its contents are risky to use. */
22428 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22431 tem
= Fboundp (elt
);
22434 tem
= Fsymbol_value (elt
);
22435 /* If value is a string, output that string literally:
22436 don't check for % within it. */
22440 if (!EQ (tem
, elt
))
22442 /* Give up right away for nil or t. */
22452 register Lisp_Object car
, tem
;
22454 /* A cons cell: five distinct cases.
22455 If first element is :eval or :propertize, do something special.
22456 If first element is a string or a cons, process all the elements
22457 and effectively concatenate them.
22458 If first element is a negative number, truncate displaying cdr to
22459 at most that many characters. If positive, pad (with spaces)
22460 to at least that many characters.
22461 If first element is a symbol, process the cadr or caddr recursively
22462 according to whether the symbol's value is non-nil or nil. */
22464 if (EQ (car
, QCeval
))
22466 /* An element of the form (:eval FORM) means evaluate FORM
22467 and use the result as mode line elements. */
22472 if (CONSP (XCDR (elt
)))
22475 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22476 n
+= display_mode_element (it
, depth
, field_width
- n
,
22477 precision
- n
, spec
, props
,
22481 else if (EQ (car
, QCpropertize
))
22483 /* An element of the form (:propertize ELT PROPS...)
22484 means display ELT but applying properties PROPS. */
22489 if (CONSP (XCDR (elt
)))
22490 n
+= display_mode_element (it
, depth
, field_width
- n
,
22491 precision
- n
, XCAR (XCDR (elt
)),
22492 XCDR (XCDR (elt
)), risky
);
22494 else if (SYMBOLP (car
))
22496 tem
= Fboundp (car
);
22500 /* elt is now the cdr, and we know it is a cons cell.
22501 Use its car if CAR has a non-nil value. */
22504 tem
= Fsymbol_value (car
);
22511 /* Symbol's value is nil (or symbol is unbound)
22512 Get the cddr of the original list
22513 and if possible find the caddr and use that. */
22517 else if (!CONSP (elt
))
22522 else if (INTEGERP (car
))
22524 register int lim
= XINT (car
);
22528 /* Negative int means reduce maximum width. */
22529 if (precision
<= 0)
22532 precision
= min (precision
, -lim
);
22536 /* Padding specified. Don't let it be more than
22537 current maximum. */
22539 lim
= min (precision
, lim
);
22541 /* If that's more padding than already wanted, queue it.
22542 But don't reduce padding already specified even if
22543 that is beyond the current truncation point. */
22544 field_width
= max (lim
, field_width
);
22548 else if (STRINGP (car
) || CONSP (car
))
22550 Lisp_Object halftail
= elt
;
22554 && (precision
<= 0 || n
< precision
))
22556 n
+= display_mode_element (it
, depth
,
22557 /* Do padding only after the last
22558 element in the list. */
22559 (! CONSP (XCDR (elt
))
22562 precision
- n
, XCAR (elt
),
22566 if ((len
& 1) == 0)
22567 halftail
= XCDR (halftail
);
22568 /* Check for cycle. */
22569 if (EQ (halftail
, elt
))
22578 elt
= build_string ("*invalid*");
22582 /* Pad to FIELD_WIDTH. */
22583 if (field_width
> 0 && n
< field_width
)
22585 switch (mode_line_target
)
22587 case MODE_LINE_NOPROP
:
22588 case MODE_LINE_TITLE
:
22589 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22591 case MODE_LINE_STRING
:
22592 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22595 case MODE_LINE_DISPLAY
:
22596 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22605 /* Store a mode-line string element in mode_line_string_list.
22607 If STRING is non-null, display that C string. Otherwise, the Lisp
22608 string LISP_STRING is displayed.
22610 FIELD_WIDTH is the minimum number of output glyphs to produce.
22611 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22612 with spaces. FIELD_WIDTH <= 0 means don't pad.
22614 PRECISION is the maximum number of characters to output from
22615 STRING. PRECISION <= 0 means don't truncate the string.
22617 If COPY_STRING, make a copy of LISP_STRING before adding
22618 properties to the string.
22620 PROPS are the properties to add to the string.
22621 The mode_line_string_face face property is always added to the string.
22625 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22627 int field_width
, int precision
, Lisp_Object props
)
22632 if (string
!= NULL
)
22634 len
= strlen (string
);
22635 if (precision
> 0 && len
> precision
)
22637 lisp_string
= make_string (string
, len
);
22639 props
= mode_line_string_face_prop
;
22640 else if (!NILP (mode_line_string_face
))
22642 Lisp_Object face
= Fplist_get (props
, Qface
);
22643 props
= Fcopy_sequence (props
);
22645 face
= mode_line_string_face
;
22647 face
= list2 (face
, mode_line_string_face
);
22648 props
= Fplist_put (props
, Qface
, face
);
22650 Fadd_text_properties (make_number (0), make_number (len
),
22651 props
, lisp_string
);
22655 len
= XFASTINT (Flength (lisp_string
));
22656 if (precision
> 0 && len
> precision
)
22659 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22662 if (!NILP (mode_line_string_face
))
22666 props
= Ftext_properties_at (make_number (0), lisp_string
);
22667 face
= Fplist_get (props
, Qface
);
22669 face
= mode_line_string_face
;
22671 face
= list2 (face
, mode_line_string_face
);
22672 props
= list2 (Qface
, face
);
22674 lisp_string
= Fcopy_sequence (lisp_string
);
22677 Fadd_text_properties (make_number (0), make_number (len
),
22678 props
, lisp_string
);
22683 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22687 if (field_width
> len
)
22689 field_width
-= len
;
22690 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22692 Fadd_text_properties (make_number (0), make_number (field_width
),
22693 props
, lisp_string
);
22694 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22702 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22704 doc
: /* Format a string out of a mode line format specification.
22705 First arg FORMAT specifies the mode line format (see `mode-line-format'
22706 for details) to use.
22708 By default, the format is evaluated for the currently selected window.
22710 Optional second arg FACE specifies the face property to put on all
22711 characters for which no face is specified. The value nil means the
22712 default face. The value t means whatever face the window's mode line
22713 currently uses (either `mode-line' or `mode-line-inactive',
22714 depending on whether the window is the selected window or not).
22715 An integer value means the value string has no text
22718 Optional third and fourth args WINDOW and BUFFER specify the window
22719 and buffer to use as the context for the formatting (defaults
22720 are the selected window and the WINDOW's buffer). */)
22721 (Lisp_Object format
, Lisp_Object face
,
22722 Lisp_Object window
, Lisp_Object buffer
)
22727 struct buffer
*old_buffer
= NULL
;
22729 bool no_props
= INTEGERP (face
);
22730 ptrdiff_t count
= SPECPDL_INDEX ();
22732 int string_start
= 0;
22734 w
= decode_any_window (window
);
22735 XSETWINDOW (window
, w
);
22738 buffer
= w
->contents
;
22739 CHECK_BUFFER (buffer
);
22741 /* Make formatting the modeline a non-op when noninteractive, otherwise
22742 there will be problems later caused by a partially initialized frame. */
22743 if (NILP (format
) || noninteractive
)
22744 return empty_unibyte_string
;
22749 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22750 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22751 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22752 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22753 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22754 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22755 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22758 old_buffer
= current_buffer
;
22760 /* Save things including mode_line_proptrans_alist,
22761 and set that to nil so that we don't alter the outer value. */
22762 record_unwind_protect (unwind_format_mode_line
,
22763 format_mode_line_unwind_data
22764 (XFRAME (WINDOW_FRAME (w
)),
22765 old_buffer
, selected_window
, true));
22766 mode_line_proptrans_alist
= Qnil
;
22768 Fselect_window (window
, Qt
);
22769 set_buffer_internal_1 (XBUFFER (buffer
));
22771 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22775 mode_line_target
= MODE_LINE_NOPROP
;
22776 mode_line_string_face_prop
= Qnil
;
22777 mode_line_string_list
= Qnil
;
22778 string_start
= MODE_LINE_NOPROP_LEN (0);
22782 mode_line_target
= MODE_LINE_STRING
;
22783 mode_line_string_list
= Qnil
;
22784 mode_line_string_face
= face
;
22785 mode_line_string_face_prop
22786 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22789 push_kboard (FRAME_KBOARD (it
.f
));
22790 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22795 len
= MODE_LINE_NOPROP_LEN (string_start
);
22796 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22800 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22801 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22802 empty_unibyte_string
);
22805 unbind_to (count
, Qnil
);
22809 /* Write a null-terminated, right justified decimal representation of
22810 the positive integer D to BUF using a minimal field width WIDTH. */
22813 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22815 register char *p
= buf
;
22823 *p
++ = d
% 10 + '0';
22828 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22839 /* Write a null-terminated, right justified decimal and "human
22840 readable" representation of the nonnegative integer D to BUF using
22841 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22843 static const char power_letter
[] =
22857 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22859 /* We aim to represent the nonnegative integer D as
22860 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22861 ptrdiff_t quotient
= d
;
22863 /* -1 means: do not use TENTHS. */
22867 /* Length of QUOTIENT.TENTHS as a string. */
22873 if (quotient
>= 1000)
22875 /* Scale to the appropriate EXPONENT. */
22878 remainder
= quotient
% 1000;
22882 while (quotient
>= 1000);
22884 /* Round to nearest and decide whether to use TENTHS or not. */
22887 tenths
= remainder
/ 100;
22888 if (remainder
% 100 >= 50)
22895 if (quotient
== 10)
22903 if (remainder
>= 500)
22905 if (quotient
< 999)
22916 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22917 if (tenths
== -1 && quotient
<= 99)
22924 p
= psuffix
= buf
+ max (width
, length
);
22926 /* Print EXPONENT. */
22927 *psuffix
++ = power_letter
[exponent
];
22930 /* Print TENTHS. */
22933 *--p
= '0' + tenths
;
22937 /* Print QUOTIENT. */
22940 int digit
= quotient
% 10;
22941 *--p
= '0' + digit
;
22943 while ((quotient
/= 10) != 0);
22945 /* Print leading spaces. */
22950 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22951 If EOL_FLAG, set also a mnemonic character for end-of-line
22952 type of CODING_SYSTEM. Return updated pointer into BUF. */
22954 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22957 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
22960 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22961 const unsigned char *eol_str
;
22963 /* The EOL conversion we are using. */
22964 Lisp_Object eoltype
;
22966 val
= CODING_SYSTEM_SPEC (coding_system
);
22969 if (!VECTORP (val
)) /* Not yet decided. */
22971 *buf
++ = multibyte
? '-' : ' ';
22973 eoltype
= eol_mnemonic_undecided
;
22974 /* Don't mention EOL conversion if it isn't decided. */
22979 Lisp_Object eolvalue
;
22981 attrs
= AREF (val
, 0);
22982 eolvalue
= AREF (val
, 2);
22985 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22990 /* The EOL conversion that is normal on this system. */
22992 if (NILP (eolvalue
)) /* Not yet decided. */
22993 eoltype
= eol_mnemonic_undecided
;
22994 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22995 eoltype
= eol_mnemonic_undecided
;
22996 else /* eolvalue is Qunix, Qdos, or Qmac. */
22997 eoltype
= (EQ (eolvalue
, Qunix
)
22998 ? eol_mnemonic_unix
22999 : EQ (eolvalue
, Qdos
)
23000 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23006 /* Mention the EOL conversion if it is not the usual one. */
23007 if (STRINGP (eoltype
))
23009 eol_str
= SDATA (eoltype
);
23010 eol_str_len
= SBYTES (eoltype
);
23012 else if (CHARACTERP (eoltype
))
23014 int c
= XFASTINT (eoltype
);
23015 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23019 eol_str
= invalid_eol_type
;
23020 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23022 memcpy (buf
, eol_str
, eol_str_len
);
23023 buf
+= eol_str_len
;
23029 /* Return a string for the output of a mode line %-spec for window W,
23030 generated by character C. FIELD_WIDTH > 0 means pad the string
23031 returned with spaces to that value. Return a Lisp string in
23032 *STRING if the resulting string is taken from that Lisp string.
23034 Note we operate on the current buffer for most purposes. */
23036 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23038 static const char *
23039 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23040 Lisp_Object
*string
)
23043 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23044 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23045 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23046 produce strings from numerical values, so limit preposterously
23047 large values of FIELD_WIDTH to avoid overrunning the buffer's
23048 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23049 bytes plus the terminating null. */
23050 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23051 struct buffer
*b
= current_buffer
;
23059 if (!NILP (BVAR (b
, read_only
)))
23061 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23066 /* This differs from %* only for a modified read-only buffer. */
23067 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23069 if (!NILP (BVAR (b
, read_only
)))
23074 /* This differs from %* in ignoring read-only-ness. */
23075 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23087 if (command_loop_level
> 5)
23089 p
= decode_mode_spec_buf
;
23090 for (i
= 0; i
< command_loop_level
; i
++)
23093 return decode_mode_spec_buf
;
23101 if (command_loop_level
> 5)
23103 p
= decode_mode_spec_buf
;
23104 for (i
= 0; i
< command_loop_level
; i
++)
23107 return decode_mode_spec_buf
;
23114 /* Let lots_of_dashes be a string of infinite length. */
23115 if (mode_line_target
== MODE_LINE_NOPROP
23116 || mode_line_target
== MODE_LINE_STRING
)
23118 if (field_width
<= 0
23119 || field_width
> sizeof (lots_of_dashes
))
23121 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23122 decode_mode_spec_buf
[i
] = '-';
23123 decode_mode_spec_buf
[i
] = '\0';
23124 return decode_mode_spec_buf
;
23127 return lots_of_dashes
;
23131 obj
= BVAR (b
, name
);
23135 /* %c and %l are ignored in `frame-title-format'.
23136 (In redisplay_internal, the frame title is drawn _before_ the
23137 windows are updated, so the stuff which depends on actual
23138 window contents (such as %l) may fail to render properly, or
23139 even crash emacs.) */
23140 if (mode_line_target
== MODE_LINE_TITLE
)
23144 ptrdiff_t col
= current_column ();
23145 w
->column_number_displayed
= col
;
23146 pint2str (decode_mode_spec_buf
, width
, col
);
23147 return decode_mode_spec_buf
;
23151 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23153 if (NILP (Vmemory_full
))
23156 return "!MEM FULL! ";
23163 /* %F displays the frame name. */
23164 if (!NILP (f
->title
))
23165 return SSDATA (f
->title
);
23166 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23167 return SSDATA (f
->name
);
23171 obj
= BVAR (b
, filename
);
23176 ptrdiff_t size
= ZV
- BEGV
;
23177 pint2str (decode_mode_spec_buf
, width
, size
);
23178 return decode_mode_spec_buf
;
23183 ptrdiff_t size
= ZV
- BEGV
;
23184 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23185 return decode_mode_spec_buf
;
23190 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23191 ptrdiff_t topline
, nlines
, height
;
23194 /* %c and %l are ignored in `frame-title-format'. */
23195 if (mode_line_target
== MODE_LINE_TITLE
)
23198 startpos
= marker_position (w
->start
);
23199 startpos_byte
= marker_byte_position (w
->start
);
23200 height
= WINDOW_TOTAL_LINES (w
);
23202 /* If we decided that this buffer isn't suitable for line numbers,
23203 don't forget that too fast. */
23204 if (w
->base_line_pos
== -1)
23207 /* If the buffer is very big, don't waste time. */
23208 if (INTEGERP (Vline_number_display_limit
)
23209 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23211 w
->base_line_pos
= 0;
23212 w
->base_line_number
= 0;
23216 if (w
->base_line_number
> 0
23217 && w
->base_line_pos
> 0
23218 && w
->base_line_pos
<= startpos
)
23220 line
= w
->base_line_number
;
23221 linepos
= w
->base_line_pos
;
23222 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23227 linepos
= BUF_BEGV (b
);
23228 linepos_byte
= BUF_BEGV_BYTE (b
);
23231 /* Count lines from base line to window start position. */
23232 nlines
= display_count_lines (linepos_byte
,
23236 topline
= nlines
+ line
;
23238 /* Determine a new base line, if the old one is too close
23239 or too far away, or if we did not have one.
23240 "Too close" means it's plausible a scroll-down would
23241 go back past it. */
23242 if (startpos
== BUF_BEGV (b
))
23244 w
->base_line_number
= topline
;
23245 w
->base_line_pos
= BUF_BEGV (b
);
23247 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23248 || linepos
== BUF_BEGV (b
))
23250 ptrdiff_t limit
= BUF_BEGV (b
);
23251 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23252 ptrdiff_t position
;
23253 ptrdiff_t distance
=
23254 (height
* 2 + 30) * line_number_display_limit_width
;
23256 if (startpos
- distance
> limit
)
23258 limit
= startpos
- distance
;
23259 limit_byte
= CHAR_TO_BYTE (limit
);
23262 nlines
= display_count_lines (startpos_byte
,
23264 - (height
* 2 + 30),
23266 /* If we couldn't find the lines we wanted within
23267 line_number_display_limit_width chars per line,
23268 give up on line numbers for this window. */
23269 if (position
== limit_byte
&& limit
== startpos
- distance
)
23271 w
->base_line_pos
= -1;
23272 w
->base_line_number
= 0;
23276 w
->base_line_number
= topline
- nlines
;
23277 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23280 /* Now count lines from the start pos to point. */
23281 nlines
= display_count_lines (startpos_byte
,
23282 PT_BYTE
, PT
, &junk
);
23284 /* Record that we did display the line number. */
23285 line_number_displayed
= true;
23287 /* Make the string to show. */
23288 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23289 return decode_mode_spec_buf
;
23292 char *p
= decode_mode_spec_buf
;
23293 int pad
= width
- 2;
23299 return decode_mode_spec_buf
;
23305 obj
= BVAR (b
, mode_name
);
23309 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23315 ptrdiff_t pos
= marker_position (w
->start
);
23316 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23318 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23320 if (pos
<= BUF_BEGV (b
))
23325 else if (pos
<= BUF_BEGV (b
))
23329 if (total
> 1000000)
23330 /* Do it differently for a large value, to avoid overflow. */
23331 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23333 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23334 /* We can't normally display a 3-digit number,
23335 so get us a 2-digit number that is close. */
23338 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23339 return decode_mode_spec_buf
;
23343 /* Display percentage of size above the bottom of the screen. */
23346 ptrdiff_t toppos
= marker_position (w
->start
);
23347 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23348 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23350 if (botpos
>= BUF_ZV (b
))
23352 if (toppos
<= BUF_BEGV (b
))
23359 if (total
> 1000000)
23360 /* Do it differently for a large value, to avoid overflow. */
23361 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23363 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23364 /* We can't normally display a 3-digit number,
23365 so get us a 2-digit number that is close. */
23368 if (toppos
<= BUF_BEGV (b
))
23369 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23371 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23372 return decode_mode_spec_buf
;
23377 /* status of process */
23378 obj
= Fget_buffer_process (Fcurrent_buffer ());
23380 return "no process";
23382 obj
= Fsymbol_name (Fprocess_status (obj
));
23388 ptrdiff_t count
= inhibit_garbage_collection ();
23389 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23390 Lisp_Object val
= Qnil
;
23392 if (STRINGP (curdir
))
23393 val
= call1 (intern ("file-remote-p"), curdir
);
23395 unbind_to (count
, Qnil
);
23404 /* coding-system (not including end-of-line format) */
23406 /* coding-system (including end-of-line type) */
23408 bool eol_flag
= (c
== 'Z');
23409 char *p
= decode_mode_spec_buf
;
23411 if (! FRAME_WINDOW_P (f
))
23413 /* No need to mention EOL here--the terminal never needs
23414 to do EOL conversion. */
23415 p
= decode_mode_spec_coding (CODING_ID_NAME
23416 (FRAME_KEYBOARD_CODING (f
)->id
),
23418 p
= decode_mode_spec_coding (CODING_ID_NAME
23419 (FRAME_TERMINAL_CODING (f
)->id
),
23422 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23425 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23426 #ifdef subprocesses
23427 obj
= Fget_buffer_process (Fcurrent_buffer ());
23428 if (PROCESSP (obj
))
23430 p
= decode_mode_spec_coding
23431 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23432 p
= decode_mode_spec_coding
23433 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23435 #endif /* subprocesses */
23438 return decode_mode_spec_buf
;
23445 return SSDATA (obj
);
23452 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23453 means count lines back from START_BYTE. But don't go beyond
23454 LIMIT_BYTE. Return the number of lines thus found (always
23457 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23458 either the position COUNT lines after/before START_BYTE, if we
23459 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23463 display_count_lines (ptrdiff_t start_byte
,
23464 ptrdiff_t limit_byte
, ptrdiff_t count
,
23465 ptrdiff_t *byte_pos_ptr
)
23467 register unsigned char *cursor
;
23468 unsigned char *base
;
23470 register ptrdiff_t ceiling
;
23471 register unsigned char *ceiling_addr
;
23472 ptrdiff_t orig_count
= count
;
23474 /* If we are not in selective display mode,
23475 check only for newlines. */
23476 bool selective_display
23477 = (!NILP (BVAR (current_buffer
, selective_display
))
23478 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23482 while (start_byte
< limit_byte
)
23484 ceiling
= BUFFER_CEILING_OF (start_byte
);
23485 ceiling
= min (limit_byte
- 1, ceiling
);
23486 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23487 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23491 if (selective_display
)
23493 while (*cursor
!= '\n' && *cursor
!= 015
23494 && ++cursor
!= ceiling_addr
)
23496 if (cursor
== ceiling_addr
)
23501 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23510 start_byte
+= cursor
- base
;
23511 *byte_pos_ptr
= start_byte
;
23515 while (cursor
< ceiling_addr
);
23517 start_byte
+= ceiling_addr
- base
;
23522 while (start_byte
> limit_byte
)
23524 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23525 ceiling
= max (limit_byte
, ceiling
);
23526 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23527 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23530 if (selective_display
)
23532 while (--cursor
>= ceiling_addr
23533 && *cursor
!= '\n' && *cursor
!= 015)
23535 if (cursor
< ceiling_addr
)
23540 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23547 start_byte
+= cursor
- base
+ 1;
23548 *byte_pos_ptr
= start_byte
;
23549 /* When scanning backwards, we should
23550 not count the newline posterior to which we stop. */
23551 return - orig_count
- 1;
23554 start_byte
+= ceiling_addr
- base
;
23558 *byte_pos_ptr
= limit_byte
;
23561 return - orig_count
+ count
;
23562 return orig_count
- count
;
23568 /***********************************************************************
23570 ***********************************************************************/
23572 /* Display a NUL-terminated string, starting with index START.
23574 If STRING is non-null, display that C string. Otherwise, the Lisp
23575 string LISP_STRING is displayed. There's a case that STRING is
23576 non-null and LISP_STRING is not nil. It means STRING is a string
23577 data of LISP_STRING. In that case, we display LISP_STRING while
23578 ignoring its text properties.
23580 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23581 FACE_STRING. Display STRING or LISP_STRING with the face at
23582 FACE_STRING_POS in FACE_STRING:
23584 Display the string in the environment given by IT, but use the
23585 standard display table, temporarily.
23587 FIELD_WIDTH is the minimum number of output glyphs to produce.
23588 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23589 with spaces. If STRING has more characters, more than FIELD_WIDTH
23590 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23592 PRECISION is the maximum number of characters to output from
23593 STRING. PRECISION < 0 means don't truncate the string.
23595 This is roughly equivalent to printf format specifiers:
23597 FIELD_WIDTH PRECISION PRINTF
23598 ----------------------------------------
23604 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23605 display them, and < 0 means obey the current buffer's value of
23606 enable_multibyte_characters.
23608 Value is the number of columns displayed. */
23611 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23612 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23613 int field_width
, int precision
, int max_x
, int multibyte
)
23615 int hpos_at_start
= it
->hpos
;
23616 int saved_face_id
= it
->face_id
;
23617 struct glyph_row
*row
= it
->glyph_row
;
23618 ptrdiff_t it_charpos
;
23620 /* Initialize the iterator IT for iteration over STRING beginning
23621 with index START. */
23622 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23623 precision
, field_width
, multibyte
);
23624 if (string
&& STRINGP (lisp_string
))
23625 /* LISP_STRING is the one returned by decode_mode_spec. We should
23626 ignore its text properties. */
23627 it
->stop_charpos
= it
->end_charpos
;
23629 /* If displaying STRING, set up the face of the iterator from
23630 FACE_STRING, if that's given. */
23631 if (STRINGP (face_string
))
23637 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23638 0, &endptr
, it
->base_face_id
, false);
23639 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23640 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23643 /* Set max_x to the maximum allowed X position. Don't let it go
23644 beyond the right edge of the window. */
23646 max_x
= it
->last_visible_x
;
23648 max_x
= min (max_x
, it
->last_visible_x
);
23650 /* Skip over display elements that are not visible. because IT->w is
23652 if (it
->current_x
< it
->first_visible_x
)
23653 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23654 MOVE_TO_POS
| MOVE_TO_X
);
23656 row
->ascent
= it
->max_ascent
;
23657 row
->height
= it
->max_ascent
+ it
->max_descent
;
23658 row
->phys_ascent
= it
->max_phys_ascent
;
23659 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23660 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23662 if (STRINGP (it
->string
))
23663 it_charpos
= IT_STRING_CHARPOS (*it
);
23665 it_charpos
= IT_CHARPOS (*it
);
23667 /* This condition is for the case that we are called with current_x
23668 past last_visible_x. */
23669 while (it
->current_x
< max_x
)
23671 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23673 /* Get the next display element. */
23674 if (!get_next_display_element (it
))
23677 /* Produce glyphs. */
23678 x_before
= it
->current_x
;
23679 n_glyphs_before
= row
->used
[TEXT_AREA
];
23680 PRODUCE_GLYPHS (it
);
23682 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23685 while (i
< nglyphs
)
23687 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23689 if (it
->line_wrap
!= TRUNCATE
23690 && x
+ glyph
->pixel_width
> max_x
)
23692 /* End of continued line or max_x reached. */
23693 if (CHAR_GLYPH_PADDING_P (*glyph
))
23695 /* A wide character is unbreakable. */
23696 if (row
->reversed_p
)
23697 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23698 - n_glyphs_before
);
23699 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23700 it
->current_x
= x_before
;
23704 if (row
->reversed_p
)
23705 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23706 - (n_glyphs_before
+ i
));
23707 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23712 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23714 /* Glyph is at least partially visible. */
23716 if (x
< it
->first_visible_x
)
23717 row
->x
= x
- it
->first_visible_x
;
23721 /* Glyph is off the left margin of the display area.
23722 Should not happen. */
23726 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23727 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23728 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23729 row
->phys_height
= max (row
->phys_height
,
23730 it
->max_phys_ascent
+ it
->max_phys_descent
);
23731 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23732 it
->max_extra_line_spacing
);
23733 x
+= glyph
->pixel_width
;
23737 /* Stop if max_x reached. */
23741 /* Stop at line ends. */
23742 if (ITERATOR_AT_END_OF_LINE_P (it
))
23744 it
->continuation_lines_width
= 0;
23748 set_iterator_to_next (it
, true);
23749 if (STRINGP (it
->string
))
23750 it_charpos
= IT_STRING_CHARPOS (*it
);
23752 it_charpos
= IT_CHARPOS (*it
);
23754 /* Stop if truncating at the right edge. */
23755 if (it
->line_wrap
== TRUNCATE
23756 && it
->current_x
>= it
->last_visible_x
)
23758 /* Add truncation mark, but don't do it if the line is
23759 truncated at a padding space. */
23760 if (it_charpos
< it
->string_nchars
)
23762 if (!FRAME_WINDOW_P (it
->f
))
23766 if (it
->current_x
> it
->last_visible_x
)
23768 if (!row
->reversed_p
)
23770 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23771 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23776 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23777 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23779 unproduce_glyphs (it
, ii
+ 1);
23780 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23782 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23784 row
->used
[TEXT_AREA
] = ii
;
23785 produce_special_glyphs (it
, IT_TRUNCATION
);
23788 produce_special_glyphs (it
, IT_TRUNCATION
);
23790 row
->truncated_on_right_p
= true;
23796 /* Maybe insert a truncation at the left. */
23797 if (it
->first_visible_x
23800 if (!FRAME_WINDOW_P (it
->f
)
23801 || (row
->reversed_p
23802 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23803 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23804 insert_left_trunc_glyphs (it
);
23805 row
->truncated_on_left_p
= true;
23808 it
->face_id
= saved_face_id
;
23810 /* Value is number of columns displayed. */
23811 return it
->hpos
- hpos_at_start
;
23816 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23817 appears as an element of LIST or as the car of an element of LIST.
23818 If PROPVAL is a list, compare each element against LIST in that
23819 way, and return 1/2 if any element of PROPVAL is found in LIST.
23820 Otherwise return 0. This function cannot quit.
23821 The return value is 2 if the text is invisible but with an ellipsis
23822 and 1 if it's invisible and without an ellipsis. */
23825 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23827 Lisp_Object tail
, proptail
;
23829 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23831 register Lisp_Object tem
;
23833 if (EQ (propval
, tem
))
23835 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23836 return NILP (XCDR (tem
)) ? 1 : 2;
23839 if (CONSP (propval
))
23841 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23843 Lisp_Object propelt
;
23844 propelt
= XCAR (proptail
);
23845 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23847 register Lisp_Object tem
;
23849 if (EQ (propelt
, tem
))
23851 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23852 return NILP (XCDR (tem
)) ? 1 : 2;
23860 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23861 doc
: /* Non-nil if the property makes the text invisible.
23862 POS-OR-PROP can be a marker or number, in which case it is taken to be
23863 a position in the current buffer and the value of the `invisible' property
23864 is checked; or it can be some other value, which is then presumed to be the
23865 value of the `invisible' property of the text of interest.
23866 The non-nil value returned can be t for truly invisible text or something
23867 else if the text is replaced by an ellipsis. */)
23868 (Lisp_Object pos_or_prop
)
23871 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23872 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23874 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23875 return (invis
== 0 ? Qnil
23877 : make_number (invis
));
23880 /* Calculate a width or height in pixels from a specification using
23881 the following elements:
23884 NUM - a (fractional) multiple of the default font width/height
23885 (NUM) - specifies exactly NUM pixels
23886 UNIT - a fixed number of pixels, see below.
23887 ELEMENT - size of a display element in pixels, see below.
23888 (NUM . SPEC) - equals NUM * SPEC
23889 (+ SPEC SPEC ...) - add pixel values
23890 (- SPEC SPEC ...) - subtract pixel values
23891 (- SPEC) - negate pixel value
23894 INT or FLOAT - a number constant
23895 SYMBOL - use symbol's (buffer local) variable binding.
23898 in - pixels per inch *)
23899 mm - pixels per 1/1000 meter *)
23900 cm - pixels per 1/100 meter *)
23901 width - width of current font in pixels.
23902 height - height of current font in pixels.
23904 *) using the ratio(s) defined in display-pixels-per-inch.
23908 left-fringe - left fringe width in pixels
23909 right-fringe - right fringe width in pixels
23911 left-margin - left margin width in pixels
23912 right-margin - right margin width in pixels
23914 scroll-bar - scroll-bar area width in pixels
23918 Pixels corresponding to 5 inches:
23921 Total width of non-text areas on left side of window (if scroll-bar is on left):
23922 '(space :width (+ left-fringe left-margin scroll-bar))
23924 Align to first text column (in header line):
23925 '(space :align-to 0)
23927 Align to middle of text area minus half the width of variable `my-image'
23928 containing a loaded image:
23929 '(space :align-to (0.5 . (- text my-image)))
23931 Width of left margin minus width of 1 character in the default font:
23932 '(space :width (- left-margin 1))
23934 Width of left margin minus width of 2 characters in the current font:
23935 '(space :width (- left-margin (2 . width)))
23937 Center 1 character over left-margin (in header line):
23938 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23940 Different ways to express width of left fringe plus left margin minus one pixel:
23941 '(space :width (- (+ left-fringe left-margin) (1)))
23942 '(space :width (+ left-fringe left-margin (- (1))))
23943 '(space :width (+ left-fringe left-margin (-1)))
23948 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23949 struct font
*font
, bool width_p
, int *align_to
)
23953 # define OK_PIXELS(val) (*res = (val), true)
23954 # define OK_ALIGN_TO(val) (*align_to = (val), true)
23957 return OK_PIXELS (0);
23959 eassert (FRAME_LIVE_P (it
->f
));
23961 if (SYMBOLP (prop
))
23963 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23965 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23967 if (unit
[0] == 'i' && unit
[1] == 'n')
23969 else if (unit
[0] == 'm' && unit
[1] == 'm')
23971 else if (unit
[0] == 'c' && unit
[1] == 'm')
23977 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23978 : FRAME_RES_Y (it
->f
));
23981 return OK_PIXELS (ppi
/ pixels
);
23986 #ifdef HAVE_WINDOW_SYSTEM
23987 if (EQ (prop
, Qheight
))
23988 return OK_PIXELS (font
23989 ? normal_char_height (font
, -1)
23990 : FRAME_LINE_HEIGHT (it
->f
));
23991 if (EQ (prop
, Qwidth
))
23992 return OK_PIXELS (font
23993 ? FONT_WIDTH (font
)
23994 : FRAME_COLUMN_WIDTH (it
->f
));
23996 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23997 return OK_PIXELS (1);
24000 if (EQ (prop
, Qtext
))
24001 return OK_PIXELS (width_p
24002 ? window_box_width (it
->w
, TEXT_AREA
)
24003 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24005 if (align_to
&& *align_to
< 0)
24008 if (EQ (prop
, Qleft
))
24009 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24010 if (EQ (prop
, Qright
))
24011 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24012 if (EQ (prop
, Qcenter
))
24013 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24014 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24015 if (EQ (prop
, Qleft_fringe
))
24016 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24017 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24018 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24019 if (EQ (prop
, Qright_fringe
))
24020 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24021 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24022 : window_box_right_offset (it
->w
, TEXT_AREA
));
24023 if (EQ (prop
, Qleft_margin
))
24024 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24025 if (EQ (prop
, Qright_margin
))
24026 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24027 if (EQ (prop
, Qscroll_bar
))
24028 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24030 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24031 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24032 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24037 if (EQ (prop
, Qleft_fringe
))
24038 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24039 if (EQ (prop
, Qright_fringe
))
24040 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24041 if (EQ (prop
, Qleft_margin
))
24042 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24043 if (EQ (prop
, Qright_margin
))
24044 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24045 if (EQ (prop
, Qscroll_bar
))
24046 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24049 prop
= buffer_local_value (prop
, it
->w
->contents
);
24050 if (EQ (prop
, Qunbound
))
24054 if (NUMBERP (prop
))
24056 int base_unit
= (width_p
24057 ? FRAME_COLUMN_WIDTH (it
->f
)
24058 : FRAME_LINE_HEIGHT (it
->f
));
24059 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24064 Lisp_Object car
= XCAR (prop
);
24065 Lisp_Object cdr
= XCDR (prop
);
24069 #ifdef HAVE_WINDOW_SYSTEM
24070 if (FRAME_WINDOW_P (it
->f
)
24071 && valid_image_p (prop
))
24073 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24074 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24076 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24079 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24085 while (CONSP (cdr
))
24087 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24088 font
, width_p
, align_to
))
24091 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24096 if (EQ (car
, Qminus
))
24098 return OK_PIXELS (pixels
);
24101 car
= buffer_local_value (car
, it
->w
->contents
);
24102 if (EQ (car
, Qunbound
))
24109 pixels
= XFLOATINT (car
);
24111 return OK_PIXELS (pixels
);
24112 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24113 font
, width_p
, align_to
))
24114 return OK_PIXELS (pixels
* fact
);
24125 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24127 #ifdef HAVE_WINDOW_SYSTEM
24128 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24136 /***********************************************************************
24138 ***********************************************************************/
24140 #ifdef HAVE_WINDOW_SYSTEM
24145 dump_glyph_string (struct glyph_string
*s
)
24147 fprintf (stderr
, "glyph string\n");
24148 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24149 s
->x
, s
->y
, s
->width
, s
->height
);
24150 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24151 fprintf (stderr
, " hl = %d\n", s
->hl
);
24152 fprintf (stderr
, " left overhang = %d, right = %d\n",
24153 s
->left_overhang
, s
->right_overhang
);
24154 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24155 fprintf (stderr
, " extends to end of line = %d\n",
24156 s
->extends_to_end_of_line_p
);
24157 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24158 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24161 #endif /* GLYPH_DEBUG */
24163 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24164 of XChar2b structures for S; it can't be allocated in
24165 init_glyph_string because it must be allocated via `alloca'. W
24166 is the window on which S is drawn. ROW and AREA are the glyph row
24167 and area within the row from which S is constructed. START is the
24168 index of the first glyph structure covered by S. HL is a
24169 face-override for drawing S. */
24172 #define OPTIONAL_HDC(hdc) HDC hdc,
24173 #define DECLARE_HDC(hdc) HDC hdc;
24174 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24175 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24178 #ifndef OPTIONAL_HDC
24179 #define OPTIONAL_HDC(hdc)
24180 #define DECLARE_HDC(hdc)
24181 #define ALLOCATE_HDC(hdc, f)
24182 #define RELEASE_HDC(hdc, f)
24186 init_glyph_string (struct glyph_string
*s
,
24188 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24189 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24191 memset (s
, 0, sizeof *s
);
24193 s
->f
= XFRAME (w
->frame
);
24197 s
->display
= FRAME_X_DISPLAY (s
->f
);
24198 s
->window
= FRAME_X_WINDOW (s
->f
);
24199 s
->char2b
= char2b
;
24203 s
->first_glyph
= row
->glyphs
[area
] + start
;
24204 s
->height
= row
->height
;
24205 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24206 s
->ybase
= s
->y
+ row
->ascent
;
24210 /* Append the list of glyph strings with head H and tail T to the list
24211 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24214 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24215 struct glyph_string
*h
, struct glyph_string
*t
)
24229 /* Prepend the list of glyph strings with head H and tail T to the
24230 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24234 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24235 struct glyph_string
*h
, struct glyph_string
*t
)
24249 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24250 Set *HEAD and *TAIL to the resulting list. */
24253 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24254 struct glyph_string
*s
)
24256 s
->next
= s
->prev
= NULL
;
24257 append_glyph_string_lists (head
, tail
, s
, s
);
24261 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24262 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24263 make sure that X resources for the face returned are allocated.
24264 Value is a pointer to a realized face that is ready for display if
24267 static struct face
*
24268 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24269 XChar2b
*char2b
, bool display_p
)
24271 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24276 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24278 if (code
== FONT_INVALID_CODE
)
24281 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24283 /* Make sure X resources of the face are allocated. */
24284 #ifdef HAVE_X_WINDOWS
24288 eassert (face
!= NULL
);
24289 prepare_face_for_display (f
, face
);
24296 /* Get face and two-byte form of character glyph GLYPH on frame F.
24297 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24298 a pointer to a realized face that is ready for display. */
24300 static struct face
*
24301 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24307 eassert (glyph
->type
== CHAR_GLYPH
);
24308 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24310 /* Make sure X resources of the face are allocated. */
24311 eassert (face
!= NULL
);
24312 prepare_face_for_display (f
, face
);
24316 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24317 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24319 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24321 if (code
== FONT_INVALID_CODE
)
24325 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24330 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24331 Return true iff FONT has a glyph for C. */
24334 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24338 if (CHAR_BYTE8_P (c
))
24339 code
= CHAR_TO_BYTE8 (c
);
24341 code
= font
->driver
->encode_char (font
, c
);
24343 if (code
== FONT_INVALID_CODE
)
24345 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24350 /* Fill glyph string S with composition components specified by S->cmp.
24352 BASE_FACE is the base face of the composition.
24353 S->cmp_from is the index of the first component for S.
24355 OVERLAPS non-zero means S should draw the foreground only, and use
24356 its physical height for clipping. See also draw_glyphs.
24358 Value is the index of a component not in S. */
24361 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24365 /* For all glyphs of this composition, starting at the offset
24366 S->cmp_from, until we reach the end of the definition or encounter a
24367 glyph that requires the different face, add it to S. */
24372 s
->for_overlaps
= overlaps
;
24375 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24377 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24379 /* TAB in a composition means display glyphs with padding space
24380 on the left or right. */
24383 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24386 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24387 s
->char2b
+ i
, true);
24393 s
->font
= s
->face
->font
;
24395 else if (s
->face
!= face
)
24403 if (s
->face
== NULL
)
24405 s
->face
= base_face
->ascii_face
;
24406 s
->font
= s
->face
->font
;
24409 /* All glyph strings for the same composition has the same width,
24410 i.e. the width set for the first component of the composition. */
24411 s
->width
= s
->first_glyph
->pixel_width
;
24413 /* If the specified font could not be loaded, use the frame's
24414 default font, but record the fact that we couldn't load it in
24415 the glyph string so that we can draw rectangles for the
24416 characters of the glyph string. */
24417 if (s
->font
== NULL
)
24419 s
->font_not_found_p
= true;
24420 s
->font
= FRAME_FONT (s
->f
);
24423 /* Adjust base line for subscript/superscript text. */
24424 s
->ybase
+= s
->first_glyph
->voffset
;
24430 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24431 int start
, int end
, int overlaps
)
24433 struct glyph
*glyph
, *last
;
24434 Lisp_Object lgstring
;
24437 s
->for_overlaps
= overlaps
;
24438 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24439 last
= s
->row
->glyphs
[s
->area
] + end
;
24440 s
->cmp_id
= glyph
->u
.cmp
.id
;
24441 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24442 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24443 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24444 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24445 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24447 while (glyph
< last
24448 && glyph
->u
.cmp
.automatic
24449 && glyph
->u
.cmp
.id
== s
->cmp_id
24450 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24451 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24453 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24455 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24456 unsigned code
= LGLYPH_CODE (lglyph
);
24458 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24460 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24461 return glyph
- s
->row
->glyphs
[s
->area
];
24465 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24466 See the comment of fill_glyph_string for arguments.
24467 Value is the index of the first glyph not in S. */
24471 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24472 int start
, int end
, int overlaps
)
24474 struct glyph
*glyph
, *last
;
24477 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24478 s
->for_overlaps
= overlaps
;
24479 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24480 last
= s
->row
->glyphs
[s
->area
] + end
;
24481 voffset
= glyph
->voffset
;
24482 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24483 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24485 s
->width
= glyph
->pixel_width
;
24487 while (glyph
< last
24488 && glyph
->type
== GLYPHLESS_GLYPH
24489 && glyph
->voffset
== voffset
24490 && glyph
->face_id
== face_id
)
24493 s
->width
+= glyph
->pixel_width
;
24496 s
->ybase
+= voffset
;
24497 return glyph
- s
->row
->glyphs
[s
->area
];
24501 /* Fill glyph string S from a sequence of character glyphs.
24503 FACE_ID is the face id of the string. START is the index of the
24504 first glyph to consider, END is the index of the last + 1.
24505 OVERLAPS non-zero means S should draw the foreground only, and use
24506 its physical height for clipping. See also draw_glyphs.
24508 Value is the index of the first glyph not in S. */
24511 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24512 int start
, int end
, int overlaps
)
24514 struct glyph
*glyph
, *last
;
24516 bool glyph_not_available_p
;
24518 eassert (s
->f
== XFRAME (s
->w
->frame
));
24519 eassert (s
->nchars
== 0);
24520 eassert (start
>= 0 && end
> start
);
24522 s
->for_overlaps
= overlaps
;
24523 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24524 last
= s
->row
->glyphs
[s
->area
] + end
;
24525 voffset
= glyph
->voffset
;
24526 s
->padding_p
= glyph
->padding_p
;
24527 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24529 while (glyph
< last
24530 && glyph
->type
== CHAR_GLYPH
24531 && glyph
->voffset
== voffset
24532 /* Same face id implies same font, nowadays. */
24533 && glyph
->face_id
== face_id
24534 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24536 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24537 s
->char2b
+ s
->nchars
);
24539 eassert (s
->nchars
<= end
- start
);
24540 s
->width
+= glyph
->pixel_width
;
24541 if (glyph
++->padding_p
!= s
->padding_p
)
24545 s
->font
= s
->face
->font
;
24547 /* If the specified font could not be loaded, use the frame's font,
24548 but record the fact that we couldn't load it in
24549 S->font_not_found_p so that we can draw rectangles for the
24550 characters of the glyph string. */
24551 if (s
->font
== NULL
|| glyph_not_available_p
)
24553 s
->font_not_found_p
= true;
24554 s
->font
= FRAME_FONT (s
->f
);
24557 /* Adjust base line for subscript/superscript text. */
24558 s
->ybase
+= voffset
;
24560 eassert (s
->face
&& s
->face
->gc
);
24561 return glyph
- s
->row
->glyphs
[s
->area
];
24565 /* Fill glyph string S from image glyph S->first_glyph. */
24568 fill_image_glyph_string (struct glyph_string
*s
)
24570 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24571 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24573 s
->slice
= s
->first_glyph
->slice
.img
;
24574 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24575 s
->font
= s
->face
->font
;
24576 s
->width
= s
->first_glyph
->pixel_width
;
24578 /* Adjust base line for subscript/superscript text. */
24579 s
->ybase
+= s
->first_glyph
->voffset
;
24583 /* Fill glyph string S from a sequence of stretch glyphs.
24585 START is the index of the first glyph to consider,
24586 END is the index of the last + 1.
24588 Value is the index of the first glyph not in S. */
24591 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24593 struct glyph
*glyph
, *last
;
24594 int voffset
, face_id
;
24596 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24598 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24599 last
= s
->row
->glyphs
[s
->area
] + end
;
24600 face_id
= glyph
->face_id
;
24601 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24602 s
->font
= s
->face
->font
;
24603 s
->width
= glyph
->pixel_width
;
24605 voffset
= glyph
->voffset
;
24609 && glyph
->type
== STRETCH_GLYPH
24610 && glyph
->voffset
== voffset
24611 && glyph
->face_id
== face_id
);
24613 s
->width
+= glyph
->pixel_width
;
24615 /* Adjust base line for subscript/superscript text. */
24616 s
->ybase
+= voffset
;
24618 /* The case that face->gc == 0 is handled when drawing the glyph
24619 string by calling prepare_face_for_display. */
24621 return glyph
- s
->row
->glyphs
[s
->area
];
24624 static struct font_metrics
*
24625 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24627 static struct font_metrics metrics
;
24632 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24633 if (code
== FONT_INVALID_CODE
)
24635 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24639 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24640 for FONT. Values are taken from font-global ones, except for fonts
24641 that claim preposterously large values, but whose glyphs actually
24642 have reasonable dimensions. C is the character to use for metrics
24643 if the font-global values are too large; if C is negative, the
24644 function selects a default character. */
24646 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24648 *ascent
= FONT_BASE (font
);
24649 *descent
= FONT_DESCENT (font
);
24651 if (FONT_TOO_HIGH (font
))
24655 /* Get metrics of C, defaulting to a reasonably sized ASCII
24657 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24659 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24661 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24663 /* We add 1 pixel to character dimensions as heuristics
24664 that produces nicer display, e.g. when the face has
24665 the box attribute. */
24666 *ascent
= pcm
->ascent
+ 1;
24667 *descent
= pcm
->descent
+ 1;
24673 /* A subroutine that computes a reasonable "normal character height"
24674 for fonts that claim preposterously large vertical dimensions, but
24675 whose glyphs are actually reasonably sized. C is the character
24676 whose metrics to use for those fonts, or -1 for default
24679 normal_char_height (struct font
*font
, int c
)
24681 int ascent
, descent
;
24683 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24685 return ascent
+ descent
;
24689 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24690 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24691 assumed to be zero. */
24694 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24696 *left
= *right
= 0;
24698 if (glyph
->type
== CHAR_GLYPH
)
24701 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24704 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24707 if (pcm
->rbearing
> pcm
->width
)
24708 *right
= pcm
->rbearing
- pcm
->width
;
24709 if (pcm
->lbearing
< 0)
24710 *left
= -pcm
->lbearing
;
24714 else if (glyph
->type
== COMPOSITE_GLYPH
)
24716 if (! glyph
->u
.cmp
.automatic
)
24718 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24720 if (cmp
->rbearing
> cmp
->pixel_width
)
24721 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24722 if (cmp
->lbearing
< 0)
24723 *left
= - cmp
->lbearing
;
24727 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24728 struct font_metrics metrics
;
24730 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24731 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24732 if (metrics
.rbearing
> metrics
.width
)
24733 *right
= metrics
.rbearing
- metrics
.width
;
24734 if (metrics
.lbearing
< 0)
24735 *left
= - metrics
.lbearing
;
24741 /* Return the index of the first glyph preceding glyph string S that
24742 is overwritten by S because of S's left overhang. Value is -1
24743 if no glyphs are overwritten. */
24746 left_overwritten (struct glyph_string
*s
)
24750 if (s
->left_overhang
)
24753 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24754 int first
= s
->first_glyph
- glyphs
;
24756 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24757 x
-= glyphs
[i
].pixel_width
;
24768 /* Return the index of the first glyph preceding glyph string S that
24769 is overwriting S because of its right overhang. Value is -1 if no
24770 glyph in front of S overwrites S. */
24773 left_overwriting (struct glyph_string
*s
)
24776 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24777 int first
= s
->first_glyph
- glyphs
;
24781 for (i
= first
- 1; i
>= 0; --i
)
24784 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24787 x
-= glyphs
[i
].pixel_width
;
24794 /* Return the index of the last glyph following glyph string S that is
24795 overwritten by S because of S's right overhang. Value is -1 if
24796 no such glyph is found. */
24799 right_overwritten (struct glyph_string
*s
)
24803 if (s
->right_overhang
)
24806 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24807 int first
= (s
->first_glyph
- glyphs
24808 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24809 int end
= s
->row
->used
[s
->area
];
24811 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24812 x
+= glyphs
[i
].pixel_width
;
24821 /* Return the index of the last glyph following glyph string S that
24822 overwrites S because of its left overhang. Value is negative
24823 if no such glyph is found. */
24826 right_overwriting (struct glyph_string
*s
)
24829 int end
= s
->row
->used
[s
->area
];
24830 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24831 int first
= (s
->first_glyph
- glyphs
24832 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24836 for (i
= first
; i
< end
; ++i
)
24839 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24842 x
+= glyphs
[i
].pixel_width
;
24849 /* Set background width of glyph string S. START is the index of the
24850 first glyph following S. LAST_X is the right-most x-position + 1
24851 in the drawing area. */
24854 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24856 /* If the face of this glyph string has to be drawn to the end of
24857 the drawing area, set S->extends_to_end_of_line_p. */
24859 if (start
== s
->row
->used
[s
->area
]
24860 && ((s
->row
->fill_line_p
24861 && (s
->hl
== DRAW_NORMAL_TEXT
24862 || s
->hl
== DRAW_IMAGE_RAISED
24863 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24864 || s
->hl
== DRAW_MOUSE_FACE
))
24865 s
->extends_to_end_of_line_p
= true;
24867 /* If S extends its face to the end of the line, set its
24868 background_width to the distance to the right edge of the drawing
24870 if (s
->extends_to_end_of_line_p
)
24871 s
->background_width
= last_x
- s
->x
+ 1;
24873 s
->background_width
= s
->width
;
24877 /* Compute overhangs and x-positions for glyph string S and its
24878 predecessors, or successors. X is the starting x-position for S.
24879 BACKWARD_P means process predecessors. */
24882 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24888 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24889 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24899 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24900 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24910 /* The following macros are only called from draw_glyphs below.
24911 They reference the following parameters of that function directly:
24912 `w', `row', `area', and `overlap_p'
24913 as well as the following local variables:
24914 `s', `f', and `hdc' (in W32) */
24917 /* On W32, silently add local `hdc' variable to argument list of
24918 init_glyph_string. */
24919 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24920 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24922 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24923 init_glyph_string (s, char2b, w, row, area, start, hl)
24926 /* Add a glyph string for a stretch glyph to the list of strings
24927 between HEAD and TAIL. START is the index of the stretch glyph in
24928 row area AREA of glyph row ROW. END is the index of the last glyph
24929 in that glyph row area. X is the current output position assigned
24930 to the new glyph string constructed. HL overrides that face of the
24931 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24932 is the right-most x-position of the drawing area. */
24934 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24935 and below -- keep them on one line. */
24936 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24939 s = alloca (sizeof *s); \
24940 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24941 START = fill_stretch_glyph_string (s, START, END); \
24942 append_glyph_string (&HEAD, &TAIL, s); \
24948 /* Add a glyph string for an image glyph to the list of strings
24949 between HEAD and TAIL. START is the index of the image glyph in
24950 row area AREA of glyph row ROW. END is the index of the last glyph
24951 in that glyph row area. X is the current output position assigned
24952 to the new glyph string constructed. HL overrides that face of the
24953 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24954 is the right-most x-position of the drawing area. */
24956 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24959 s = alloca (sizeof *s); \
24960 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24961 fill_image_glyph_string (s); \
24962 append_glyph_string (&HEAD, &TAIL, s); \
24969 /* Add a glyph string for a sequence of character glyphs to the list
24970 of strings between HEAD and TAIL. START is the index of the first
24971 glyph in row area AREA of glyph row ROW that is part of the new
24972 glyph string. END is the index of the last glyph in that glyph row
24973 area. X is the current output position assigned to the new glyph
24974 string constructed. HL overrides that face of the glyph; e.g. it
24975 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24976 right-most x-position of the drawing area. */
24978 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24984 face_id = (row)->glyphs[area][START].face_id; \
24986 s = alloca (sizeof *s); \
24987 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24988 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24989 append_glyph_string (&HEAD, &TAIL, s); \
24991 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24996 /* Add a glyph string for a composite sequence to the list of strings
24997 between HEAD and TAIL. START is the index of the first glyph in
24998 row area AREA of glyph row ROW that is part of the new glyph
24999 string. END is the index of the last glyph in that glyph row area.
25000 X is the current output position assigned to the new glyph string
25001 constructed. HL overrides that face of the glyph; e.g. it is
25002 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25003 x-position of the drawing area. */
25005 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25007 int face_id = (row)->glyphs[area][START].face_id; \
25008 struct face *base_face = FACE_FROM_ID (f, face_id); \
25009 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25010 struct composition *cmp = composition_table[cmp_id]; \
25012 struct glyph_string *first_s = NULL; \
25015 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25017 /* Make glyph_strings for each glyph sequence that is drawable by \
25018 the same face, and append them to HEAD/TAIL. */ \
25019 for (n = 0; n < cmp->glyph_len;) \
25021 s = alloca (sizeof *s); \
25022 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25023 append_glyph_string (&(HEAD), &(TAIL), s); \
25029 n = fill_composite_glyph_string (s, base_face, overlaps); \
25037 /* Add a glyph string for a glyph-string sequence to the list of strings
25038 between HEAD and TAIL. */
25040 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25044 Lisp_Object gstring; \
25046 face_id = (row)->glyphs[area][START].face_id; \
25047 gstring = (composition_gstring_from_id \
25048 ((row)->glyphs[area][START].u.cmp.id)); \
25049 s = alloca (sizeof *s); \
25050 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25051 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25052 append_glyph_string (&(HEAD), &(TAIL), s); \
25054 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25058 /* Add a glyph string for a sequence of glyphless character's glyphs
25059 to the list of strings between HEAD and TAIL. The meanings of
25060 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25062 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25067 face_id = (row)->glyphs[area][START].face_id; \
25069 s = alloca (sizeof *s); \
25070 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25071 append_glyph_string (&HEAD, &TAIL, s); \
25073 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25079 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25080 of AREA of glyph row ROW on window W between indices START and END.
25081 HL overrides the face for drawing glyph strings, e.g. it is
25082 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25083 x-positions of the drawing area.
25085 This is an ugly monster macro construct because we must use alloca
25086 to allocate glyph strings (because draw_glyphs can be called
25087 asynchronously). */
25089 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25092 HEAD = TAIL = NULL; \
25093 while (START < END) \
25095 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25096 switch (first_glyph->type) \
25099 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25103 case COMPOSITE_GLYPH: \
25104 if (first_glyph->u.cmp.automatic) \
25105 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25108 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25112 case STRETCH_GLYPH: \
25113 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25117 case IMAGE_GLYPH: \
25118 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25122 case GLYPHLESS_GLYPH: \
25123 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25133 set_glyph_string_background_width (s, START, LAST_X); \
25140 /* Draw glyphs between START and END in AREA of ROW on window W,
25141 starting at x-position X. X is relative to AREA in W. HL is a
25142 face-override with the following meaning:
25144 DRAW_NORMAL_TEXT draw normally
25145 DRAW_CURSOR draw in cursor face
25146 DRAW_MOUSE_FACE draw in mouse face.
25147 DRAW_INVERSE_VIDEO draw in mode line face
25148 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25149 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25151 If OVERLAPS is non-zero, draw only the foreground of characters and
25152 clip to the physical height of ROW. Non-zero value also defines
25153 the overlapping part to be drawn:
25155 OVERLAPS_PRED overlap with preceding rows
25156 OVERLAPS_SUCC overlap with succeeding rows
25157 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25158 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25160 Value is the x-position reached, relative to AREA of W. */
25163 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25164 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25165 enum draw_glyphs_face hl
, int overlaps
)
25167 struct glyph_string
*head
, *tail
;
25168 struct glyph_string
*s
;
25169 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25170 int i
, j
, x_reached
, last_x
, area_left
= 0;
25171 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25174 ALLOCATE_HDC (hdc
, f
);
25176 /* Let's rather be paranoid than getting a SEGV. */
25177 end
= min (end
, row
->used
[area
]);
25178 start
= clip_to_bounds (0, start
, end
);
25180 /* Translate X to frame coordinates. Set last_x to the right
25181 end of the drawing area. */
25182 if (row
->full_width_p
)
25184 /* X is relative to the left edge of W, without scroll bars
25186 area_left
= WINDOW_LEFT_EDGE_X (w
);
25187 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25188 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25192 area_left
= window_box_left (w
, area
);
25193 last_x
= area_left
+ window_box_width (w
, area
);
25197 /* Build a doubly-linked list of glyph_string structures between
25198 head and tail from what we have to draw. Note that the macro
25199 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25200 the reason we use a separate variable `i'. */
25203 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25205 x_reached
= tail
->x
+ tail
->background_width
;
25209 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25210 the row, redraw some glyphs in front or following the glyph
25211 strings built above. */
25212 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25214 struct glyph_string
*h
, *t
;
25215 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25216 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25217 bool check_mouse_face
= false;
25220 /* If mouse highlighting is on, we may need to draw adjacent
25221 glyphs using mouse-face highlighting. */
25222 if (area
== TEXT_AREA
&& row
->mouse_face_p
25223 && hlinfo
->mouse_face_beg_row
>= 0
25224 && hlinfo
->mouse_face_end_row
>= 0)
25226 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25228 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25229 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25231 check_mouse_face
= true;
25232 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25233 ? hlinfo
->mouse_face_beg_col
: 0;
25234 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25235 ? hlinfo
->mouse_face_end_col
25236 : row
->used
[TEXT_AREA
];
25240 /* Compute overhangs for all glyph strings. */
25241 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25242 for (s
= head
; s
; s
= s
->next
)
25243 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25245 /* Prepend glyph strings for glyphs in front of the first glyph
25246 string that are overwritten because of the first glyph
25247 string's left overhang. The background of all strings
25248 prepended must be drawn because the first glyph string
25250 i
= left_overwritten (head
);
25253 enum draw_glyphs_face overlap_hl
;
25255 /* If this row contains mouse highlighting, attempt to draw
25256 the overlapped glyphs with the correct highlight. This
25257 code fails if the overlap encompasses more than one glyph
25258 and mouse-highlight spans only some of these glyphs.
25259 However, making it work perfectly involves a lot more
25260 code, and I don't know if the pathological case occurs in
25261 practice, so we'll stick to this for now. --- cyd */
25262 if (check_mouse_face
25263 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25264 overlap_hl
= DRAW_MOUSE_FACE
;
25266 overlap_hl
= DRAW_NORMAL_TEXT
;
25268 if (hl
!= overlap_hl
)
25271 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25272 overlap_hl
, dummy_x
, last_x
);
25274 compute_overhangs_and_x (t
, head
->x
, true);
25275 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25276 if (clip_head
== NULL
)
25280 /* Prepend glyph strings for glyphs in front of the first glyph
25281 string that overwrite that glyph string because of their
25282 right overhang. For these strings, only the foreground must
25283 be drawn, because it draws over the glyph string at `head'.
25284 The background must not be drawn because this would overwrite
25285 right overhangs of preceding glyphs for which no glyph
25287 i
= left_overwriting (head
);
25290 enum draw_glyphs_face overlap_hl
;
25292 if (check_mouse_face
25293 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25294 overlap_hl
= DRAW_MOUSE_FACE
;
25296 overlap_hl
= DRAW_NORMAL_TEXT
;
25298 if (hl
== overlap_hl
|| clip_head
== NULL
)
25300 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25301 overlap_hl
, dummy_x
, last_x
);
25302 for (s
= h
; s
; s
= s
->next
)
25303 s
->background_filled_p
= true;
25304 compute_overhangs_and_x (t
, head
->x
, true);
25305 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25308 /* Append glyphs strings for glyphs following the last glyph
25309 string tail that are overwritten by tail. The background of
25310 these strings has to be drawn because tail's foreground draws
25312 i
= right_overwritten (tail
);
25315 enum draw_glyphs_face overlap_hl
;
25317 if (check_mouse_face
25318 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25319 overlap_hl
= DRAW_MOUSE_FACE
;
25321 overlap_hl
= DRAW_NORMAL_TEXT
;
25323 if (hl
!= overlap_hl
)
25325 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25326 overlap_hl
, x
, last_x
);
25327 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25328 we don't have `end = i;' here. */
25329 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25330 append_glyph_string_lists (&head
, &tail
, h
, t
);
25331 if (clip_tail
== NULL
)
25335 /* Append glyph strings for glyphs following the last glyph
25336 string tail that overwrite tail. The foreground of such
25337 glyphs has to be drawn because it writes into the background
25338 of tail. The background must not be drawn because it could
25339 paint over the foreground of following glyphs. */
25340 i
= right_overwriting (tail
);
25343 enum draw_glyphs_face overlap_hl
;
25344 if (check_mouse_face
25345 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25346 overlap_hl
= DRAW_MOUSE_FACE
;
25348 overlap_hl
= DRAW_NORMAL_TEXT
;
25350 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25352 i
++; /* We must include the Ith glyph. */
25353 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25354 overlap_hl
, x
, last_x
);
25355 for (s
= h
; s
; s
= s
->next
)
25356 s
->background_filled_p
= true;
25357 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25358 append_glyph_string_lists (&head
, &tail
, h
, t
);
25360 if (clip_head
|| clip_tail
)
25361 for (s
= head
; s
; s
= s
->next
)
25363 s
->clip_head
= clip_head
;
25364 s
->clip_tail
= clip_tail
;
25368 /* Draw all strings. */
25369 for (s
= head
; s
; s
= s
->next
)
25370 FRAME_RIF (f
)->draw_glyph_string (s
);
25373 /* When focus a sole frame and move horizontally, this clears on_p
25374 causing a failure to erase prev cursor position. */
25375 if (area
== TEXT_AREA
25376 && !row
->full_width_p
25377 /* When drawing overlapping rows, only the glyph strings'
25378 foreground is drawn, which doesn't erase a cursor
25382 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25383 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25384 : (tail
? tail
->x
+ tail
->background_width
: x
));
25388 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25389 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25393 /* Value is the x-position up to which drawn, relative to AREA of W.
25394 This doesn't include parts drawn because of overhangs. */
25395 if (row
->full_width_p
)
25396 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25398 x_reached
-= area_left
;
25400 RELEASE_HDC (hdc
, f
);
25406 /* Expand row matrix if too narrow. Don't expand if area
25409 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25411 if (!it->f->fonts_changed \
25412 && (it->glyph_row->glyphs[area] \
25413 < it->glyph_row->glyphs[area + 1])) \
25415 it->w->ncols_scale_factor++; \
25416 it->f->fonts_changed = true; \
25420 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25421 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25424 append_glyph (struct it
*it
)
25426 struct glyph
*glyph
;
25427 enum glyph_row_area area
= it
->area
;
25429 eassert (it
->glyph_row
);
25430 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25432 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25433 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25435 /* If the glyph row is reversed, we need to prepend the glyph
25436 rather than append it. */
25437 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25441 /* Make room for the additional glyph. */
25442 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25444 glyph
= it
->glyph_row
->glyphs
[area
];
25446 glyph
->charpos
= CHARPOS (it
->position
);
25447 glyph
->object
= it
->object
;
25448 if (it
->pixel_width
> 0)
25450 glyph
->pixel_width
= it
->pixel_width
;
25451 glyph
->padding_p
= false;
25455 /* Assure at least 1-pixel width. Otherwise, cursor can't
25456 be displayed correctly. */
25457 glyph
->pixel_width
= 1;
25458 glyph
->padding_p
= true;
25460 glyph
->ascent
= it
->ascent
;
25461 glyph
->descent
= it
->descent
;
25462 glyph
->voffset
= it
->voffset
;
25463 glyph
->type
= CHAR_GLYPH
;
25464 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25465 glyph
->multibyte_p
= it
->multibyte_p
;
25466 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25468 /* In R2L rows, the left and the right box edges need to be
25469 drawn in reverse direction. */
25470 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25471 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25475 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25476 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25478 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25479 || it
->phys_descent
> it
->descent
);
25480 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25481 glyph
->face_id
= it
->face_id
;
25482 glyph
->u
.ch
= it
->char_to_display
;
25483 glyph
->slice
.img
= null_glyph_slice
;
25484 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25487 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25488 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25489 glyph
->bidi_type
= it
->bidi_it
.type
;
25493 glyph
->resolved_level
= 0;
25494 glyph
->bidi_type
= UNKNOWN_BT
;
25496 ++it
->glyph_row
->used
[area
];
25499 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25502 /* Store one glyph for the composition IT->cmp_it.id in
25503 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25507 append_composite_glyph (struct it
*it
)
25509 struct glyph
*glyph
;
25510 enum glyph_row_area area
= it
->area
;
25512 eassert (it
->glyph_row
);
25514 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25515 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25517 /* If the glyph row is reversed, we need to prepend the glyph
25518 rather than append it. */
25519 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25523 /* Make room for the new glyph. */
25524 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25526 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25528 glyph
->charpos
= it
->cmp_it
.charpos
;
25529 glyph
->object
= it
->object
;
25530 glyph
->pixel_width
= it
->pixel_width
;
25531 glyph
->ascent
= it
->ascent
;
25532 glyph
->descent
= it
->descent
;
25533 glyph
->voffset
= it
->voffset
;
25534 glyph
->type
= COMPOSITE_GLYPH
;
25535 if (it
->cmp_it
.ch
< 0)
25537 glyph
->u
.cmp
.automatic
= false;
25538 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25539 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25543 glyph
->u
.cmp
.automatic
= true;
25544 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25545 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25546 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25548 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25549 glyph
->multibyte_p
= it
->multibyte_p
;
25550 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25552 /* In R2L rows, the left and the right box edges need to be
25553 drawn in reverse direction. */
25554 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25555 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25559 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25560 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25562 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25563 || it
->phys_descent
> it
->descent
);
25564 glyph
->padding_p
= false;
25565 glyph
->glyph_not_available_p
= false;
25566 glyph
->face_id
= it
->face_id
;
25567 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25570 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25571 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25572 glyph
->bidi_type
= it
->bidi_it
.type
;
25574 ++it
->glyph_row
->used
[area
];
25577 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25581 /* Change IT->ascent and IT->height according to the setting of
25585 take_vertical_position_into_account (struct it
*it
)
25589 if (it
->voffset
< 0)
25590 /* Increase the ascent so that we can display the text higher
25592 it
->ascent
-= it
->voffset
;
25594 /* Increase the descent so that we can display the text lower
25596 it
->descent
+= it
->voffset
;
25601 /* Produce glyphs/get display metrics for the image IT is loaded with.
25602 See the description of struct display_iterator in dispextern.h for
25603 an overview of struct display_iterator. */
25606 produce_image_glyph (struct it
*it
)
25610 int glyph_ascent
, crop
;
25611 struct glyph_slice slice
;
25613 eassert (it
->what
== IT_IMAGE
);
25615 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25617 /* Make sure X resources of the face is loaded. */
25618 prepare_face_for_display (it
->f
, face
);
25620 if (it
->image_id
< 0)
25622 /* Fringe bitmap. */
25623 it
->ascent
= it
->phys_ascent
= 0;
25624 it
->descent
= it
->phys_descent
= 0;
25625 it
->pixel_width
= 0;
25630 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25632 /* Make sure X resources of the image is loaded. */
25633 prepare_image_for_display (it
->f
, img
);
25635 slice
.x
= slice
.y
= 0;
25636 slice
.width
= img
->width
;
25637 slice
.height
= img
->height
;
25639 if (INTEGERP (it
->slice
.x
))
25640 slice
.x
= XINT (it
->slice
.x
);
25641 else if (FLOATP (it
->slice
.x
))
25642 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25644 if (INTEGERP (it
->slice
.y
))
25645 slice
.y
= XINT (it
->slice
.y
);
25646 else if (FLOATP (it
->slice
.y
))
25647 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25649 if (INTEGERP (it
->slice
.width
))
25650 slice
.width
= XINT (it
->slice
.width
);
25651 else if (FLOATP (it
->slice
.width
))
25652 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25654 if (INTEGERP (it
->slice
.height
))
25655 slice
.height
= XINT (it
->slice
.height
);
25656 else if (FLOATP (it
->slice
.height
))
25657 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25659 if (slice
.x
>= img
->width
)
25660 slice
.x
= img
->width
;
25661 if (slice
.y
>= img
->height
)
25662 slice
.y
= img
->height
;
25663 if (slice
.x
+ slice
.width
>= img
->width
)
25664 slice
.width
= img
->width
- slice
.x
;
25665 if (slice
.y
+ slice
.height
> img
->height
)
25666 slice
.height
= img
->height
- slice
.y
;
25668 if (slice
.width
== 0 || slice
.height
== 0)
25671 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25673 it
->descent
= slice
.height
- glyph_ascent
;
25675 it
->descent
+= img
->vmargin
;
25676 if (slice
.y
+ slice
.height
== img
->height
)
25677 it
->descent
+= img
->vmargin
;
25678 it
->phys_descent
= it
->descent
;
25680 it
->pixel_width
= slice
.width
;
25682 it
->pixel_width
+= img
->hmargin
;
25683 if (slice
.x
+ slice
.width
== img
->width
)
25684 it
->pixel_width
+= img
->hmargin
;
25686 /* It's quite possible for images to have an ascent greater than
25687 their height, so don't get confused in that case. */
25688 if (it
->descent
< 0)
25693 if (face
->box
!= FACE_NO_BOX
)
25695 if (face
->box_line_width
> 0)
25698 it
->ascent
+= face
->box_line_width
;
25699 if (slice
.y
+ slice
.height
== img
->height
)
25700 it
->descent
+= face
->box_line_width
;
25703 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25704 it
->pixel_width
+= eabs (face
->box_line_width
);
25705 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25706 it
->pixel_width
+= eabs (face
->box_line_width
);
25709 take_vertical_position_into_account (it
);
25711 /* Automatically crop wide image glyphs at right edge so we can
25712 draw the cursor on same display row. */
25713 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25714 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25716 it
->pixel_width
-= crop
;
25717 slice
.width
-= crop
;
25722 struct glyph
*glyph
;
25723 enum glyph_row_area area
= it
->area
;
25725 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25726 if (it
->glyph_row
->reversed_p
)
25730 /* Make room for the new glyph. */
25731 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25733 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25735 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25737 glyph
->charpos
= CHARPOS (it
->position
);
25738 glyph
->object
= it
->object
;
25739 glyph
->pixel_width
= it
->pixel_width
;
25740 glyph
->ascent
= glyph_ascent
;
25741 glyph
->descent
= it
->descent
;
25742 glyph
->voffset
= it
->voffset
;
25743 glyph
->type
= IMAGE_GLYPH
;
25744 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25745 glyph
->multibyte_p
= it
->multibyte_p
;
25746 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25748 /* In R2L rows, the left and the right box edges need to be
25749 drawn in reverse direction. */
25750 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25751 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25755 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25756 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25758 glyph
->overlaps_vertically_p
= false;
25759 glyph
->padding_p
= false;
25760 glyph
->glyph_not_available_p
= false;
25761 glyph
->face_id
= it
->face_id
;
25762 glyph
->u
.img_id
= img
->id
;
25763 glyph
->slice
.img
= slice
;
25764 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25767 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25768 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25769 glyph
->bidi_type
= it
->bidi_it
.type
;
25771 ++it
->glyph_row
->used
[area
];
25774 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25779 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25780 of the glyph, WIDTH and HEIGHT are the width and height of the
25781 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25784 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25785 int width
, int height
, int ascent
)
25787 struct glyph
*glyph
;
25788 enum glyph_row_area area
= it
->area
;
25790 eassert (ascent
>= 0 && ascent
<= height
);
25792 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25793 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25795 /* If the glyph row is reversed, we need to prepend the glyph
25796 rather than append it. */
25797 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25801 /* Make room for the additional glyph. */
25802 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25804 glyph
= it
->glyph_row
->glyphs
[area
];
25806 /* Decrease the width of the first glyph of the row that
25807 begins before first_visible_x (e.g., due to hscroll).
25808 This is so the overall width of the row becomes smaller
25809 by the scroll amount, and the stretch glyph appended by
25810 extend_face_to_end_of_line will be wider, to shift the
25811 row glyphs to the right. (In L2R rows, the corresponding
25812 left-shift effect is accomplished by setting row->x to a
25813 negative value, which won't work with R2L rows.)
25815 This must leave us with a positive value of WIDTH, since
25816 otherwise the call to move_it_in_display_line_to at the
25817 beginning of display_line would have got past the entire
25818 first glyph, and then it->current_x would have been
25819 greater or equal to it->first_visible_x. */
25820 if (it
->current_x
< it
->first_visible_x
)
25821 width
-= it
->first_visible_x
- it
->current_x
;
25822 eassert (width
> 0);
25824 glyph
->charpos
= CHARPOS (it
->position
);
25825 glyph
->object
= object
;
25826 glyph
->pixel_width
= width
;
25827 glyph
->ascent
= ascent
;
25828 glyph
->descent
= height
- ascent
;
25829 glyph
->voffset
= it
->voffset
;
25830 glyph
->type
= STRETCH_GLYPH
;
25831 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25832 glyph
->multibyte_p
= it
->multibyte_p
;
25833 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25835 /* In R2L rows, the left and the right box edges need to be
25836 drawn in reverse direction. */
25837 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25838 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25842 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25843 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25845 glyph
->overlaps_vertically_p
= false;
25846 glyph
->padding_p
= false;
25847 glyph
->glyph_not_available_p
= false;
25848 glyph
->face_id
= it
->face_id
;
25849 glyph
->u
.stretch
.ascent
= ascent
;
25850 glyph
->u
.stretch
.height
= height
;
25851 glyph
->slice
.img
= null_glyph_slice
;
25852 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25855 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25856 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25857 glyph
->bidi_type
= it
->bidi_it
.type
;
25861 glyph
->resolved_level
= 0;
25862 glyph
->bidi_type
= UNKNOWN_BT
;
25864 ++it
->glyph_row
->used
[area
];
25867 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25870 #endif /* HAVE_WINDOW_SYSTEM */
25872 /* Produce a stretch glyph for iterator IT. IT->object is the value
25873 of the glyph property displayed. The value must be a list
25874 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25877 1. `:width WIDTH' specifies that the space should be WIDTH *
25878 canonical char width wide. WIDTH may be an integer or floating
25881 2. `:relative-width FACTOR' specifies that the width of the stretch
25882 should be computed from the width of the first character having the
25883 `glyph' property, and should be FACTOR times that width.
25885 3. `:align-to HPOS' specifies that the space should be wide enough
25886 to reach HPOS, a value in canonical character units.
25888 Exactly one of the above pairs must be present.
25890 4. `:height HEIGHT' specifies that the height of the stretch produced
25891 should be HEIGHT, measured in canonical character units.
25893 5. `:relative-height FACTOR' specifies that the height of the
25894 stretch should be FACTOR times the height of the characters having
25895 the glyph property.
25897 Either none or exactly one of 4 or 5 must be present.
25899 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25900 of the stretch should be used for the ascent of the stretch.
25901 ASCENT must be in the range 0 <= ASCENT <= 100. */
25904 produce_stretch_glyph (struct it
*it
)
25906 /* (space :width WIDTH :height HEIGHT ...) */
25907 Lisp_Object prop
, plist
;
25908 int width
= 0, height
= 0, align_to
= -1;
25909 bool zero_width_ok_p
= false;
25911 struct font
*font
= NULL
;
25913 #ifdef HAVE_WINDOW_SYSTEM
25915 bool zero_height_ok_p
= false;
25917 if (FRAME_WINDOW_P (it
->f
))
25919 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25920 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25921 prepare_face_for_display (it
->f
, face
);
25925 /* List should start with `space'. */
25926 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25927 plist
= XCDR (it
->object
);
25929 /* Compute the width of the stretch. */
25930 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25931 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
25933 /* Absolute width `:width WIDTH' specified and valid. */
25934 zero_width_ok_p
= true;
25937 #ifdef HAVE_WINDOW_SYSTEM
25938 else if (FRAME_WINDOW_P (it
->f
)
25939 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25941 /* Relative width `:relative-width FACTOR' specified and valid.
25942 Compute the width of the characters having the `glyph'
25945 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25948 if (it
->multibyte_p
)
25949 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25952 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25953 if (! ASCII_CHAR_P (it2
.c
))
25954 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25957 it2
.glyph_row
= NULL
;
25958 it2
.what
= IT_CHARACTER
;
25959 x_produce_glyphs (&it2
);
25960 width
= NUMVAL (prop
) * it2
.pixel_width
;
25962 #endif /* HAVE_WINDOW_SYSTEM */
25963 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25964 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
25967 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25968 align_to
= (align_to
< 0
25970 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25971 else if (align_to
< 0)
25972 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25973 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25974 zero_width_ok_p
= true;
25977 /* Nothing specified -> width defaults to canonical char width. */
25978 width
= FRAME_COLUMN_WIDTH (it
->f
);
25980 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25983 #ifdef HAVE_WINDOW_SYSTEM
25984 /* Compute height. */
25985 if (FRAME_WINDOW_P (it
->f
))
25987 int default_height
= normal_char_height (font
, ' ');
25989 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25990 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
25993 zero_height_ok_p
= true;
25995 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25997 height
= default_height
* NUMVAL (prop
);
25999 height
= default_height
;
26001 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26004 /* Compute percentage of height used for ascent. If
26005 `:ascent ASCENT' is present and valid, use that. Otherwise,
26006 derive the ascent from the font in use. */
26007 if (prop
= Fplist_get (plist
, QCascent
),
26008 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26009 ascent
= height
* NUMVAL (prop
) / 100.0;
26010 else if (!NILP (prop
)
26011 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26012 ascent
= min (max (0, (int)tem
), height
);
26014 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26017 #endif /* HAVE_WINDOW_SYSTEM */
26020 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26021 && it
->current_x
+ width
> it
->last_visible_x
)
26023 width
= it
->last_visible_x
- it
->current_x
;
26024 #ifdef HAVE_WINDOW_SYSTEM
26025 /* Subtract one more pixel from the stretch width, but only on
26026 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26027 width
-= FRAME_WINDOW_P (it
->f
);
26031 if (width
> 0 && height
> 0 && it
->glyph_row
)
26033 Lisp_Object o_object
= it
->object
;
26034 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26037 if (!STRINGP (object
))
26038 object
= it
->w
->contents
;
26039 #ifdef HAVE_WINDOW_SYSTEM
26040 if (FRAME_WINDOW_P (it
->f
))
26041 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26045 it
->object
= object
;
26046 it
->char_to_display
= ' ';
26047 it
->pixel_width
= it
->len
= 1;
26049 tty_append_glyph (it
);
26050 it
->object
= o_object
;
26054 it
->pixel_width
= width
;
26055 #ifdef HAVE_WINDOW_SYSTEM
26056 if (FRAME_WINDOW_P (it
->f
))
26058 it
->ascent
= it
->phys_ascent
= ascent
;
26059 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26060 it
->nglyphs
= width
> 0 && height
> 0;
26061 take_vertical_position_into_account (it
);
26065 it
->nglyphs
= width
;
26068 /* Get information about special display element WHAT in an
26069 environment described by IT. WHAT is one of IT_TRUNCATION or
26070 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26071 non-null glyph_row member. This function ensures that fields like
26072 face_id, c, len of IT are left untouched. */
26075 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26082 temp_it
.object
= Qnil
;
26083 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26085 if (what
== IT_CONTINUATION
)
26087 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26088 if (it
->bidi_it
.paragraph_dir
== R2L
)
26089 SET_GLYPH_FROM_CHAR (glyph
, '/');
26091 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26093 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26095 /* FIXME: Should we mirror GC for R2L lines? */
26096 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26097 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26100 else if (what
== IT_TRUNCATION
)
26102 /* Truncation glyph. */
26103 SET_GLYPH_FROM_CHAR (glyph
, '$');
26105 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26107 /* FIXME: Should we mirror GC for R2L lines? */
26108 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26109 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26115 #ifdef HAVE_WINDOW_SYSTEM
26116 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26117 is turned off, we precede the truncation/continuation glyphs by a
26118 stretch glyph whose width is computed such that these special
26119 glyphs are aligned at the window margin, even when very different
26120 fonts are used in different glyph rows. */
26121 if (FRAME_WINDOW_P (temp_it
.f
)
26122 /* init_iterator calls this with it->glyph_row == NULL, and it
26123 wants only the pixel width of the truncation/continuation
26125 && temp_it
.glyph_row
26126 /* insert_left_trunc_glyphs calls us at the beginning of the
26127 row, and it has its own calculation of the stretch glyph
26129 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26130 && (temp_it
.glyph_row
->reversed_p
26131 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26132 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26134 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26136 if (stretch_width
> 0)
26138 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26139 struct font
*font
=
26140 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26141 int stretch_ascent
=
26142 (((temp_it
.ascent
+ temp_it
.descent
)
26143 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26145 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26146 temp_it
.ascent
+ temp_it
.descent
,
26153 temp_it
.what
= IT_CHARACTER
;
26154 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26155 temp_it
.face_id
= GLYPH_FACE (glyph
);
26156 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26158 PRODUCE_GLYPHS (&temp_it
);
26159 it
->pixel_width
= temp_it
.pixel_width
;
26160 it
->nglyphs
= temp_it
.nglyphs
;
26163 #ifdef HAVE_WINDOW_SYSTEM
26165 /* Calculate line-height and line-spacing properties.
26166 An integer value specifies explicit pixel value.
26167 A float value specifies relative value to current face height.
26168 A cons (float . face-name) specifies relative value to
26169 height of specified face font.
26171 Returns height in pixels, or nil. */
26174 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26175 int boff
, bool override
)
26177 Lisp_Object face_name
= Qnil
;
26178 int ascent
, descent
, height
;
26180 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26185 face_name
= XCAR (val
);
26187 if (!NUMBERP (val
))
26188 val
= make_number (1);
26189 if (NILP (face_name
))
26191 height
= it
->ascent
+ it
->descent
;
26196 if (NILP (face_name
))
26198 font
= FRAME_FONT (it
->f
);
26199 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26201 else if (EQ (face_name
, Qt
))
26210 face_id
= lookup_named_face (it
->f
, face_name
, false);
26212 return make_number (-1);
26214 face
= FACE_FROM_ID (it
->f
, face_id
);
26217 return make_number (-1);
26218 boff
= font
->baseline_offset
;
26219 if (font
->vertical_centering
)
26220 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26223 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26227 it
->override_ascent
= ascent
;
26228 it
->override_descent
= descent
;
26229 it
->override_boff
= boff
;
26232 height
= ascent
+ descent
;
26236 height
= (int)(XFLOAT_DATA (val
) * height
);
26237 else if (INTEGERP (val
))
26238 height
*= XINT (val
);
26240 return make_number (height
);
26244 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26245 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26246 and only if this is for a character for which no font was found.
26248 If the display method (it->glyphless_method) is
26249 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26250 length of the acronym or the hexadecimal string, UPPER_XOFF and
26251 UPPER_YOFF are pixel offsets for the upper part of the string,
26252 LOWER_XOFF and LOWER_YOFF are for the lower part.
26254 For the other display methods, LEN through LOWER_YOFF are zero. */
26257 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26258 short upper_xoff
, short upper_yoff
,
26259 short lower_xoff
, short lower_yoff
)
26261 struct glyph
*glyph
;
26262 enum glyph_row_area area
= it
->area
;
26264 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26265 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26267 /* If the glyph row is reversed, we need to prepend the glyph
26268 rather than append it. */
26269 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26273 /* Make room for the additional glyph. */
26274 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26276 glyph
= it
->glyph_row
->glyphs
[area
];
26278 glyph
->charpos
= CHARPOS (it
->position
);
26279 glyph
->object
= it
->object
;
26280 glyph
->pixel_width
= it
->pixel_width
;
26281 glyph
->ascent
= it
->ascent
;
26282 glyph
->descent
= it
->descent
;
26283 glyph
->voffset
= it
->voffset
;
26284 glyph
->type
= GLYPHLESS_GLYPH
;
26285 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26286 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26287 glyph
->u
.glyphless
.len
= len
;
26288 glyph
->u
.glyphless
.ch
= it
->c
;
26289 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26290 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26291 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26292 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26293 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26294 glyph
->multibyte_p
= it
->multibyte_p
;
26295 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26297 /* In R2L rows, the left and the right box edges need to be
26298 drawn in reverse direction. */
26299 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26300 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26304 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26305 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26307 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26308 || it
->phys_descent
> it
->descent
);
26309 glyph
->padding_p
= false;
26310 glyph
->glyph_not_available_p
= false;
26311 glyph
->face_id
= face_id
;
26312 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26315 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26316 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26317 glyph
->bidi_type
= it
->bidi_it
.type
;
26319 ++it
->glyph_row
->used
[area
];
26322 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26326 /* Produce a glyph for a glyphless character for iterator IT.
26327 IT->glyphless_method specifies which method to use for displaying
26328 the character. See the description of enum
26329 glyphless_display_method in dispextern.h for the detail.
26331 FOR_NO_FONT is true if and only if this is for a character for
26332 which no font was found. ACRONYM, if non-nil, is an acronym string
26333 for the character. */
26336 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26341 int base_width
, base_height
, width
, height
;
26342 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26345 /* Get the metrics of the base font. We always refer to the current
26347 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26348 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26349 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26350 it
->ascent
+= font
->baseline_offset
;
26351 it
->descent
-= font
->baseline_offset
;
26352 base_height
= it
->ascent
+ it
->descent
;
26353 base_width
= font
->average_width
;
26355 face_id
= merge_glyphless_glyph_face (it
);
26357 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26359 it
->pixel_width
= THIN_SPACE_WIDTH
;
26361 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26363 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26365 width
= CHAR_WIDTH (it
->c
);
26368 else if (width
> 4)
26370 it
->pixel_width
= base_width
* width
;
26372 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26378 unsigned int code
[6];
26380 int ascent
, descent
;
26381 struct font_metrics metrics_upper
, metrics_lower
;
26383 face
= FACE_FROM_ID (it
->f
, face_id
);
26384 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26385 prepare_face_for_display (it
->f
, face
);
26387 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26389 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26390 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26391 if (CONSP (acronym
))
26392 acronym
= XCAR (acronym
);
26393 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26397 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26398 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26401 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26402 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26403 upper_len
= (len
+ 1) / 2;
26404 font
->driver
->text_extents (font
, code
, upper_len
,
26406 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26411 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26412 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26413 upper_xoff
= upper_yoff
= 2; /* the typical case */
26414 if (base_width
>= width
)
26416 /* Align the upper to the left, the lower to the right. */
26417 it
->pixel_width
= base_width
;
26418 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26422 /* Center the shorter one. */
26423 it
->pixel_width
= width
;
26424 if (metrics_upper
.width
>= metrics_lower
.width
)
26425 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26428 /* FIXME: This code doesn't look right. It formerly was
26429 missing the "lower_xoff = 0;", which couldn't have
26430 been right since it left lower_xoff uninitialized. */
26432 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26436 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26437 top, bottom, and between upper and lower strings. */
26438 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26439 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26440 /* Center vertically.
26441 H:base_height, D:base_descent
26442 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26444 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26445 descent = D - H/2 + h/2;
26446 lower_yoff = descent - 2 - ld;
26447 upper_yoff = lower_yoff - la - 1 - ud; */
26448 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26449 descent
= it
->descent
- (base_height
- height
) / 2;
26450 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26451 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26452 - metrics_upper
.descent
);
26453 /* Don't make the height shorter than the base height. */
26454 if (height
> base_height
)
26456 it
->ascent
= ascent
;
26457 it
->descent
= descent
;
26461 it
->phys_ascent
= it
->ascent
;
26462 it
->phys_descent
= it
->descent
;
26464 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26465 upper_xoff
, upper_yoff
,
26466 lower_xoff
, lower_yoff
);
26468 take_vertical_position_into_account (it
);
26473 Produce glyphs/get display metrics for the display element IT is
26474 loaded with. See the description of struct it in dispextern.h
26475 for an overview of struct it. */
26478 x_produce_glyphs (struct it
*it
)
26480 int extra_line_spacing
= it
->extra_line_spacing
;
26482 it
->glyph_not_available_p
= false;
26484 if (it
->what
== IT_CHARACTER
)
26487 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26488 struct font
*font
= face
->font
;
26489 struct font_metrics
*pcm
= NULL
;
26490 int boff
; /* Baseline offset. */
26494 /* When no suitable font is found, display this character by
26495 the method specified in the first extra slot of
26496 Vglyphless_char_display. */
26497 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26499 eassert (it
->what
== IT_GLYPHLESS
);
26500 produce_glyphless_glyph (it
, true,
26501 STRINGP (acronym
) ? acronym
: Qnil
);
26505 boff
= font
->baseline_offset
;
26506 if (font
->vertical_centering
)
26507 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26509 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26513 if (it
->override_ascent
>= 0)
26515 it
->ascent
= it
->override_ascent
;
26516 it
->descent
= it
->override_descent
;
26517 boff
= it
->override_boff
;
26521 it
->ascent
= FONT_BASE (font
) + boff
;
26522 it
->descent
= FONT_DESCENT (font
) - boff
;
26525 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26527 pcm
= get_per_char_metric (font
, &char2b
);
26528 if (pcm
->width
== 0
26529 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26535 it
->phys_ascent
= pcm
->ascent
+ boff
;
26536 it
->phys_descent
= pcm
->descent
- boff
;
26537 it
->pixel_width
= pcm
->width
;
26538 /* Don't use font-global values for ascent and descent
26539 if they result in an exceedingly large line height. */
26540 if (it
->override_ascent
< 0)
26542 if (FONT_TOO_HIGH (font
))
26544 it
->ascent
= it
->phys_ascent
;
26545 it
->descent
= it
->phys_descent
;
26546 /* These limitations are enforced by an
26547 assertion near the end of this function. */
26548 if (it
->ascent
< 0)
26550 if (it
->descent
< 0)
26557 it
->glyph_not_available_p
= true;
26558 it
->phys_ascent
= it
->ascent
;
26559 it
->phys_descent
= it
->descent
;
26560 it
->pixel_width
= font
->space_width
;
26563 if (it
->constrain_row_ascent_descent_p
)
26565 if (it
->descent
> it
->max_descent
)
26567 it
->ascent
+= it
->descent
- it
->max_descent
;
26568 it
->descent
= it
->max_descent
;
26570 if (it
->ascent
> it
->max_ascent
)
26572 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26573 it
->ascent
= it
->max_ascent
;
26575 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26576 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26577 extra_line_spacing
= 0;
26580 /* If this is a space inside a region of text with
26581 `space-width' property, change its width. */
26583 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26585 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26587 /* If face has a box, add the box thickness to the character
26588 height. If character has a box line to the left and/or
26589 right, add the box line width to the character's width. */
26590 if (face
->box
!= FACE_NO_BOX
)
26592 int thick
= face
->box_line_width
;
26596 it
->ascent
+= thick
;
26597 it
->descent
+= thick
;
26602 if (it
->start_of_box_run_p
)
26603 it
->pixel_width
+= thick
;
26604 if (it
->end_of_box_run_p
)
26605 it
->pixel_width
+= thick
;
26608 /* If face has an overline, add the height of the overline
26609 (1 pixel) and a 1 pixel margin to the character height. */
26610 if (face
->overline_p
)
26611 it
->ascent
+= overline_margin
;
26613 if (it
->constrain_row_ascent_descent_p
)
26615 if (it
->ascent
> it
->max_ascent
)
26616 it
->ascent
= it
->max_ascent
;
26617 if (it
->descent
> it
->max_descent
)
26618 it
->descent
= it
->max_descent
;
26621 take_vertical_position_into_account (it
);
26623 /* If we have to actually produce glyphs, do it. */
26628 /* Translate a space with a `space-width' property
26629 into a stretch glyph. */
26630 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26631 / FONT_HEIGHT (font
));
26632 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26633 it
->ascent
+ it
->descent
, ascent
);
26638 /* If characters with lbearing or rbearing are displayed
26639 in this line, record that fact in a flag of the
26640 glyph row. This is used to optimize X output code. */
26641 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26642 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26644 if (! stretched_p
&& it
->pixel_width
== 0)
26645 /* We assure that all visible glyphs have at least 1-pixel
26647 it
->pixel_width
= 1;
26649 else if (it
->char_to_display
== '\n')
26651 /* A newline has no width, but we need the height of the
26652 line. But if previous part of the line sets a height,
26653 don't increase that height. */
26655 Lisp_Object height
;
26656 Lisp_Object total_height
= Qnil
;
26658 it
->override_ascent
= -1;
26659 it
->pixel_width
= 0;
26662 height
= get_it_property (it
, Qline_height
);
26663 /* Split (line-height total-height) list. */
26665 && CONSP (XCDR (height
))
26666 && NILP (XCDR (XCDR (height
))))
26668 total_height
= XCAR (XCDR (height
));
26669 height
= XCAR (height
);
26671 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26673 if (it
->override_ascent
>= 0)
26675 it
->ascent
= it
->override_ascent
;
26676 it
->descent
= it
->override_descent
;
26677 boff
= it
->override_boff
;
26681 if (FONT_TOO_HIGH (font
))
26683 it
->ascent
= font
->pixel_size
+ boff
- 1;
26684 it
->descent
= -boff
+ 1;
26685 if (it
->descent
< 0)
26690 it
->ascent
= FONT_BASE (font
) + boff
;
26691 it
->descent
= FONT_DESCENT (font
) - boff
;
26695 if (EQ (height
, Qt
))
26697 if (it
->descent
> it
->max_descent
)
26699 it
->ascent
+= it
->descent
- it
->max_descent
;
26700 it
->descent
= it
->max_descent
;
26702 if (it
->ascent
> it
->max_ascent
)
26704 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26705 it
->ascent
= it
->max_ascent
;
26707 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26708 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26709 it
->constrain_row_ascent_descent_p
= true;
26710 extra_line_spacing
= 0;
26714 Lisp_Object spacing
;
26716 it
->phys_ascent
= it
->ascent
;
26717 it
->phys_descent
= it
->descent
;
26719 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26720 && face
->box
!= FACE_NO_BOX
26721 && face
->box_line_width
> 0)
26723 it
->ascent
+= face
->box_line_width
;
26724 it
->descent
+= face
->box_line_width
;
26727 && XINT (height
) > it
->ascent
+ it
->descent
)
26728 it
->ascent
= XINT (height
) - it
->descent
;
26730 if (!NILP (total_height
))
26731 spacing
= calc_line_height_property (it
, total_height
, font
,
26735 spacing
= get_it_property (it
, Qline_spacing
);
26736 spacing
= calc_line_height_property (it
, spacing
, font
,
26739 if (INTEGERP (spacing
))
26741 extra_line_spacing
= XINT (spacing
);
26742 if (!NILP (total_height
))
26743 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26747 else /* i.e. (it->char_to_display == '\t') */
26749 if (font
->space_width
> 0)
26751 int tab_width
= it
->tab_width
* font
->space_width
;
26752 int x
= it
->current_x
+ it
->continuation_lines_width
;
26753 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26755 /* If the distance from the current position to the next tab
26756 stop is less than a space character width, use the
26757 tab stop after that. */
26758 if (next_tab_x
- x
< font
->space_width
)
26759 next_tab_x
+= tab_width
;
26761 it
->pixel_width
= next_tab_x
- x
;
26763 if (FONT_TOO_HIGH (font
))
26765 if (get_char_glyph_code (' ', font
, &char2b
))
26767 pcm
= get_per_char_metric (font
, &char2b
);
26768 if (pcm
->width
== 0
26769 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26775 it
->ascent
= pcm
->ascent
+ boff
;
26776 it
->descent
= pcm
->descent
- boff
;
26780 it
->ascent
= font
->pixel_size
+ boff
- 1;
26781 it
->descent
= -boff
+ 1;
26783 if (it
->ascent
< 0)
26785 if (it
->descent
< 0)
26790 it
->ascent
= FONT_BASE (font
) + boff
;
26791 it
->descent
= FONT_DESCENT (font
) - boff
;
26793 it
->phys_ascent
= it
->ascent
;
26794 it
->phys_descent
= it
->descent
;
26798 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26799 it
->ascent
+ it
->descent
, it
->ascent
);
26804 it
->pixel_width
= 0;
26809 if (FONT_TOO_HIGH (font
))
26811 int font_ascent
, font_descent
;
26813 /* For very large fonts, where we ignore the declared font
26814 dimensions, and go by per-character metrics instead,
26815 don't let the row ascent and descent values (and the row
26816 height computed from them) be smaller than the "normal"
26817 character metrics. This avoids unpleasant effects
26818 whereby lines on display would change their height
26819 depending on which characters are shown. */
26820 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26821 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26822 it
->max_descent
= max (it
->max_descent
, font_descent
);
26825 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26827 /* A static composition.
26829 Note: A composition is represented as one glyph in the
26830 glyph matrix. There are no padding glyphs.
26832 Important note: pixel_width, ascent, and descent are the
26833 values of what is drawn by draw_glyphs (i.e. the values of
26834 the overall glyphs composed). */
26835 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26836 int boff
; /* baseline offset */
26837 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26838 int glyph_len
= cmp
->glyph_len
;
26839 struct font
*font
= face
->font
;
26843 /* If we have not yet calculated pixel size data of glyphs of
26844 the composition for the current face font, calculate them
26845 now. Theoretically, we have to check all fonts for the
26846 glyphs, but that requires much time and memory space. So,
26847 here we check only the font of the first glyph. This may
26848 lead to incorrect display, but it's very rare, and C-l
26849 (recenter-top-bottom) can correct the display anyway. */
26850 if (! cmp
->font
|| cmp
->font
!= font
)
26852 /* Ascent and descent of the font of the first character
26853 of this composition (adjusted by baseline offset).
26854 Ascent and descent of overall glyphs should not be less
26855 than these, respectively. */
26856 int font_ascent
, font_descent
, font_height
;
26857 /* Bounding box of the overall glyphs. */
26858 int leftmost
, rightmost
, lowest
, highest
;
26859 int lbearing
, rbearing
;
26860 int i
, width
, ascent
, descent
;
26861 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26863 struct font_metrics
*pcm
;
26866 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26867 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26869 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26870 for (i
= 0; i
< glyph_len
; i
++)
26872 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26874 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26876 bool left_padded
= i
> 0;
26878 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26879 : IT_CHARPOS (*it
));
26880 /* If no suitable font is found, use the default font. */
26881 bool font_not_found_p
= font
== NULL
;
26882 if (font_not_found_p
)
26884 face
= face
->ascii_face
;
26887 boff
= font
->baseline_offset
;
26888 if (font
->vertical_centering
)
26889 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26890 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26891 font_ascent
+= boff
;
26892 font_descent
-= boff
;
26893 font_height
= font_ascent
+ font_descent
;
26898 if (! font_not_found_p
)
26900 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26902 pcm
= get_per_char_metric (font
, &char2b
);
26905 /* Initialize the bounding box. */
26908 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26909 ascent
= pcm
->ascent
;
26910 descent
= pcm
->descent
;
26911 lbearing
= pcm
->lbearing
;
26912 rbearing
= pcm
->rbearing
;
26916 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26917 ascent
= FONT_BASE (font
);
26918 descent
= FONT_DESCENT (font
);
26925 lowest
= - descent
+ boff
;
26926 highest
= ascent
+ boff
;
26928 if (! font_not_found_p
26929 && font
->default_ascent
26930 && CHAR_TABLE_P (Vuse_default_ascent
)
26931 && !NILP (Faref (Vuse_default_ascent
,
26932 make_number (it
->char_to_display
))))
26933 highest
= font
->default_ascent
+ boff
;
26935 /* Draw the first glyph at the normal position. It may be
26936 shifted to right later if some other glyphs are drawn
26938 cmp
->offsets
[i
* 2] = 0;
26939 cmp
->offsets
[i
* 2 + 1] = boff
;
26940 cmp
->lbearing
= lbearing
;
26941 cmp
->rbearing
= rbearing
;
26943 /* Set cmp->offsets for the remaining glyphs. */
26944 for (i
++; i
< glyph_len
; i
++)
26946 int left
, right
, btm
, top
;
26947 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26949 struct face
*this_face
;
26953 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26954 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26955 font
= this_face
->font
;
26961 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26963 pcm
= get_per_char_metric (font
, &char2b
);
26966 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26969 width
= pcm
->width
;
26970 ascent
= pcm
->ascent
;
26971 descent
= pcm
->descent
;
26972 lbearing
= pcm
->lbearing
;
26973 rbearing
= pcm
->rbearing
;
26974 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26976 /* Relative composition with or without
26977 alternate chars. */
26978 left
= (leftmost
+ rightmost
- width
) / 2;
26979 btm
= - descent
+ boff
;
26980 if (font
->relative_compose
26981 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26982 || NILP (Faref (Vignore_relative_composition
,
26983 make_number (ch
)))))
26986 if (- descent
>= font
->relative_compose
)
26987 /* One extra pixel between two glyphs. */
26989 else if (ascent
<= 0)
26990 /* One extra pixel between two glyphs. */
26991 btm
= lowest
- 1 - ascent
- descent
;
26996 /* A composition rule is specified by an integer
26997 value that encodes global and new reference
26998 points (GREF and NREF). GREF and NREF are
26999 specified by numbers as below:
27001 0---1---2 -- ascent
27005 9--10--11 -- center
27007 ---3---4---5--- baseline
27009 6---7---8 -- descent
27011 int rule
= COMPOSITION_RULE (cmp
, i
);
27012 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27014 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27015 grefx
= gref
% 3, nrefx
= nref
% 3;
27016 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27018 xoff
= font_height
* (xoff
- 128) / 256;
27020 yoff
= font_height
* (yoff
- 128) / 256;
27023 + grefx
* (rightmost
- leftmost
) / 2
27024 - nrefx
* width
/ 2
27027 btm
= ((grefy
== 0 ? highest
27029 : grefy
== 2 ? lowest
27030 : (highest
+ lowest
) / 2)
27031 - (nrefy
== 0 ? ascent
+ descent
27032 : nrefy
== 1 ? descent
- boff
27034 : (ascent
+ descent
) / 2)
27038 cmp
->offsets
[i
* 2] = left
;
27039 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27041 /* Update the bounding box of the overall glyphs. */
27044 right
= left
+ width
;
27045 if (left
< leftmost
)
27047 if (right
> rightmost
)
27050 top
= btm
+ descent
+ ascent
;
27056 if (cmp
->lbearing
> left
+ lbearing
)
27057 cmp
->lbearing
= left
+ lbearing
;
27058 if (cmp
->rbearing
< left
+ rbearing
)
27059 cmp
->rbearing
= left
+ rbearing
;
27063 /* If there are glyphs whose x-offsets are negative,
27064 shift all glyphs to the right and make all x-offsets
27068 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27069 cmp
->offsets
[i
* 2] -= leftmost
;
27070 rightmost
-= leftmost
;
27071 cmp
->lbearing
-= leftmost
;
27072 cmp
->rbearing
-= leftmost
;
27075 if (left_padded
&& cmp
->lbearing
< 0)
27077 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27078 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27079 rightmost
-= cmp
->lbearing
;
27080 cmp
->rbearing
-= cmp
->lbearing
;
27083 if (right_padded
&& rightmost
< cmp
->rbearing
)
27085 rightmost
= cmp
->rbearing
;
27088 cmp
->pixel_width
= rightmost
;
27089 cmp
->ascent
= highest
;
27090 cmp
->descent
= - lowest
;
27091 if (cmp
->ascent
< font_ascent
)
27092 cmp
->ascent
= font_ascent
;
27093 if (cmp
->descent
< font_descent
)
27094 cmp
->descent
= font_descent
;
27098 && (cmp
->lbearing
< 0
27099 || cmp
->rbearing
> cmp
->pixel_width
))
27100 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27102 it
->pixel_width
= cmp
->pixel_width
;
27103 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27104 it
->descent
= it
->phys_descent
= cmp
->descent
;
27105 if (face
->box
!= FACE_NO_BOX
)
27107 int thick
= face
->box_line_width
;
27111 it
->ascent
+= thick
;
27112 it
->descent
+= thick
;
27117 if (it
->start_of_box_run_p
)
27118 it
->pixel_width
+= thick
;
27119 if (it
->end_of_box_run_p
)
27120 it
->pixel_width
+= thick
;
27123 /* If face has an overline, add the height of the overline
27124 (1 pixel) and a 1 pixel margin to the character height. */
27125 if (face
->overline_p
)
27126 it
->ascent
+= overline_margin
;
27128 take_vertical_position_into_account (it
);
27129 if (it
->ascent
< 0)
27131 if (it
->descent
< 0)
27134 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27135 append_composite_glyph (it
);
27137 else if (it
->what
== IT_COMPOSITION
)
27139 /* A dynamic (automatic) composition. */
27140 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27141 Lisp_Object gstring
;
27142 struct font_metrics metrics
;
27146 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27148 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27151 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27152 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27153 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27154 it
->descent
= it
->phys_descent
= metrics
.descent
;
27155 if (face
->box
!= FACE_NO_BOX
)
27157 int thick
= face
->box_line_width
;
27161 it
->ascent
+= thick
;
27162 it
->descent
+= thick
;
27167 if (it
->start_of_box_run_p
)
27168 it
->pixel_width
+= thick
;
27169 if (it
->end_of_box_run_p
)
27170 it
->pixel_width
+= thick
;
27172 /* If face has an overline, add the height of the overline
27173 (1 pixel) and a 1 pixel margin to the character height. */
27174 if (face
->overline_p
)
27175 it
->ascent
+= overline_margin
;
27176 take_vertical_position_into_account (it
);
27177 if (it
->ascent
< 0)
27179 if (it
->descent
< 0)
27183 append_composite_glyph (it
);
27185 else if (it
->what
== IT_GLYPHLESS
)
27186 produce_glyphless_glyph (it
, false, Qnil
);
27187 else if (it
->what
== IT_IMAGE
)
27188 produce_image_glyph (it
);
27189 else if (it
->what
== IT_STRETCH
)
27190 produce_stretch_glyph (it
);
27193 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27194 because this isn't true for images with `:ascent 100'. */
27195 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27196 if (it
->area
== TEXT_AREA
)
27197 it
->current_x
+= it
->pixel_width
;
27199 if (extra_line_spacing
> 0)
27201 it
->descent
+= extra_line_spacing
;
27202 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27203 it
->max_extra_line_spacing
= extra_line_spacing
;
27206 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27207 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27208 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27209 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27213 Output LEN glyphs starting at START at the nominal cursor position.
27214 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27215 being updated, and UPDATED_AREA is the area of that row being updated. */
27218 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27219 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27221 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27223 eassert (updated_row
);
27224 /* When the window is hscrolled, cursor hpos can legitimately be out
27225 of bounds, but we draw the cursor at the corresponding window
27226 margin in that case. */
27227 if (!updated_row
->reversed_p
&& chpos
< 0)
27229 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27230 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27234 /* Write glyphs. */
27236 hpos
= start
- updated_row
->glyphs
[updated_area
];
27237 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27238 updated_row
, updated_area
,
27240 DRAW_NORMAL_TEXT
, 0);
27242 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27243 if (updated_area
== TEXT_AREA
27244 && w
->phys_cursor_on_p
27245 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27247 && chpos
< hpos
+ len
)
27248 w
->phys_cursor_on_p
= false;
27252 /* Advance the output cursor. */
27253 w
->output_cursor
.hpos
+= len
;
27254 w
->output_cursor
.x
= x
;
27259 Insert LEN glyphs from START at the nominal cursor position. */
27262 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27263 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27266 int line_height
, shift_by_width
, shifted_region_width
;
27267 struct glyph_row
*row
;
27268 struct glyph
*glyph
;
27269 int frame_x
, frame_y
;
27272 eassert (updated_row
);
27274 f
= XFRAME (WINDOW_FRAME (w
));
27276 /* Get the height of the line we are in. */
27278 line_height
= row
->height
;
27280 /* Get the width of the glyphs to insert. */
27281 shift_by_width
= 0;
27282 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27283 shift_by_width
+= glyph
->pixel_width
;
27285 /* Get the width of the region to shift right. */
27286 shifted_region_width
= (window_box_width (w
, updated_area
)
27287 - w
->output_cursor
.x
27291 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27292 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27294 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27295 line_height
, shift_by_width
);
27297 /* Write the glyphs. */
27298 hpos
= start
- row
->glyphs
[updated_area
];
27299 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27301 DRAW_NORMAL_TEXT
, 0);
27303 /* Advance the output cursor. */
27304 w
->output_cursor
.hpos
+= len
;
27305 w
->output_cursor
.x
+= shift_by_width
;
27311 Erase the current text line from the nominal cursor position
27312 (inclusive) to pixel column TO_X (exclusive). The idea is that
27313 everything from TO_X onward is already erased.
27315 TO_X is a pixel position relative to UPDATED_AREA of currently
27316 updated window W. TO_X == -1 means clear to the end of this area. */
27319 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27320 enum glyph_row_area updated_area
, int to_x
)
27323 int max_x
, min_y
, max_y
;
27324 int from_x
, from_y
, to_y
;
27326 eassert (updated_row
);
27327 f
= XFRAME (w
->frame
);
27329 if (updated_row
->full_width_p
)
27330 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27331 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27333 max_x
= window_box_width (w
, updated_area
);
27334 max_y
= window_text_bottom_y (w
);
27336 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27337 of window. For TO_X > 0, truncate to end of drawing area. */
27343 to_x
= min (to_x
, max_x
);
27345 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27347 /* Notice if the cursor will be cleared by this operation. */
27348 if (!updated_row
->full_width_p
)
27349 notice_overwritten_cursor (w
, updated_area
,
27350 w
->output_cursor
.x
, -1,
27352 MATRIX_ROW_BOTTOM_Y (updated_row
));
27354 from_x
= w
->output_cursor
.x
;
27356 /* Translate to frame coordinates. */
27357 if (updated_row
->full_width_p
)
27359 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27360 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27364 int area_left
= window_box_left (w
, updated_area
);
27365 from_x
+= area_left
;
27369 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27370 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27371 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27373 /* Prevent inadvertently clearing to end of the X window. */
27374 if (to_x
> from_x
&& to_y
> from_y
)
27377 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27378 to_x
- from_x
, to_y
- from_y
);
27383 #endif /* HAVE_WINDOW_SYSTEM */
27387 /***********************************************************************
27389 ***********************************************************************/
27391 /* Value is the internal representation of the specified cursor type
27392 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27393 of the bar cursor. */
27395 static enum text_cursor_kinds
27396 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27398 enum text_cursor_kinds type
;
27403 if (EQ (arg
, Qbox
))
27404 return FILLED_BOX_CURSOR
;
27406 if (EQ (arg
, Qhollow
))
27407 return HOLLOW_BOX_CURSOR
;
27409 if (EQ (arg
, Qbar
))
27416 && EQ (XCAR (arg
), Qbar
)
27417 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27419 *width
= XINT (XCDR (arg
));
27423 if (EQ (arg
, Qhbar
))
27426 return HBAR_CURSOR
;
27430 && EQ (XCAR (arg
), Qhbar
)
27431 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27433 *width
= XINT (XCDR (arg
));
27434 return HBAR_CURSOR
;
27437 /* Treat anything unknown as "hollow box cursor".
27438 It was bad to signal an error; people have trouble fixing
27439 .Xdefaults with Emacs, when it has something bad in it. */
27440 type
= HOLLOW_BOX_CURSOR
;
27445 /* Set the default cursor types for specified frame. */
27447 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27452 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27453 FRAME_CURSOR_WIDTH (f
) = width
;
27455 /* By default, set up the blink-off state depending on the on-state. */
27457 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27460 FRAME_BLINK_OFF_CURSOR (f
)
27461 = get_specified_cursor_type (XCDR (tem
), &width
);
27462 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27465 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27467 /* Make sure the cursor gets redrawn. */
27468 f
->cursor_type_changed
= true;
27472 #ifdef HAVE_WINDOW_SYSTEM
27474 /* Return the cursor we want to be displayed in window W. Return
27475 width of bar/hbar cursor through WIDTH arg. Return with
27476 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27477 (i.e. if the `system caret' should track this cursor).
27479 In a mini-buffer window, we want the cursor only to appear if we
27480 are reading input from this window. For the selected window, we
27481 want the cursor type given by the frame parameter or buffer local
27482 setting of cursor-type. If explicitly marked off, draw no cursor.
27483 In all other cases, we want a hollow box cursor. */
27485 static enum text_cursor_kinds
27486 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27487 bool *active_cursor
)
27489 struct frame
*f
= XFRAME (w
->frame
);
27490 struct buffer
*b
= XBUFFER (w
->contents
);
27491 int cursor_type
= DEFAULT_CURSOR
;
27492 Lisp_Object alt_cursor
;
27493 bool non_selected
= false;
27495 *active_cursor
= true;
27498 if (cursor_in_echo_area
27499 && FRAME_HAS_MINIBUF_P (f
)
27500 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27502 if (w
== XWINDOW (echo_area_window
))
27504 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27506 *width
= FRAME_CURSOR_WIDTH (f
);
27507 return FRAME_DESIRED_CURSOR (f
);
27510 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27513 *active_cursor
= false;
27514 non_selected
= true;
27517 /* Detect a nonselected window or nonselected frame. */
27518 else if (w
!= XWINDOW (f
->selected_window
)
27519 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27521 *active_cursor
= false;
27523 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27526 non_selected
= true;
27529 /* Never display a cursor in a window in which cursor-type is nil. */
27530 if (NILP (BVAR (b
, cursor_type
)))
27533 /* Get the normal cursor type for this window. */
27534 if (EQ (BVAR (b
, cursor_type
), Qt
))
27536 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27537 *width
= FRAME_CURSOR_WIDTH (f
);
27540 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27542 /* Use cursor-in-non-selected-windows instead
27543 for non-selected window or frame. */
27546 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27547 if (!EQ (Qt
, alt_cursor
))
27548 return get_specified_cursor_type (alt_cursor
, width
);
27549 /* t means modify the normal cursor type. */
27550 if (cursor_type
== FILLED_BOX_CURSOR
)
27551 cursor_type
= HOLLOW_BOX_CURSOR
;
27552 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27554 return cursor_type
;
27557 /* Use normal cursor if not blinked off. */
27558 if (!w
->cursor_off_p
)
27560 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27562 if (cursor_type
== FILLED_BOX_CURSOR
)
27564 /* Using a block cursor on large images can be very annoying.
27565 So use a hollow cursor for "large" images.
27566 If image is not transparent (no mask), also use hollow cursor. */
27567 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27568 if (img
!= NULL
&& IMAGEP (img
->spec
))
27570 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27571 where N = size of default frame font size.
27572 This should cover most of the "tiny" icons people may use. */
27574 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27575 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27576 cursor_type
= HOLLOW_BOX_CURSOR
;
27579 else if (cursor_type
!= NO_CURSOR
)
27581 /* Display current only supports BOX and HOLLOW cursors for images.
27582 So for now, unconditionally use a HOLLOW cursor when cursor is
27583 not a solid box cursor. */
27584 cursor_type
= HOLLOW_BOX_CURSOR
;
27587 return cursor_type
;
27590 /* Cursor is blinked off, so determine how to "toggle" it. */
27592 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27593 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27594 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27596 /* Then see if frame has specified a specific blink off cursor type. */
27597 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27599 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27600 return FRAME_BLINK_OFF_CURSOR (f
);
27604 /* Some people liked having a permanently visible blinking cursor,
27605 while others had very strong opinions against it. So it was
27606 decided to remove it. KFS 2003-09-03 */
27608 /* Finally perform built-in cursor blinking:
27609 filled box <-> hollow box
27610 wide [h]bar <-> narrow [h]bar
27611 narrow [h]bar <-> no cursor
27612 other type <-> no cursor */
27614 if (cursor_type
== FILLED_BOX_CURSOR
)
27615 return HOLLOW_BOX_CURSOR
;
27617 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27620 return cursor_type
;
27628 /* Notice when the text cursor of window W has been completely
27629 overwritten by a drawing operation that outputs glyphs in AREA
27630 starting at X0 and ending at X1 in the line starting at Y0 and
27631 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27632 the rest of the line after X0 has been written. Y coordinates
27633 are window-relative. */
27636 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27637 int x0
, int x1
, int y0
, int y1
)
27639 int cx0
, cx1
, cy0
, cy1
;
27640 struct glyph_row
*row
;
27642 if (!w
->phys_cursor_on_p
)
27644 if (area
!= TEXT_AREA
)
27647 if (w
->phys_cursor
.vpos
< 0
27648 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27649 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27650 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27653 if (row
->cursor_in_fringe_p
)
27655 row
->cursor_in_fringe_p
= false;
27656 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27657 w
->phys_cursor_on_p
= false;
27661 cx0
= w
->phys_cursor
.x
;
27662 cx1
= cx0
+ w
->phys_cursor_width
;
27663 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27666 /* The cursor image will be completely removed from the
27667 screen if the output area intersects the cursor area in
27668 y-direction. When we draw in [y0 y1[, and some part of
27669 the cursor is at y < y0, that part must have been drawn
27670 before. When scrolling, the cursor is erased before
27671 actually scrolling, so we don't come here. When not
27672 scrolling, the rows above the old cursor row must have
27673 changed, and in this case these rows must have written
27674 over the cursor image.
27676 Likewise if part of the cursor is below y1, with the
27677 exception of the cursor being in the first blank row at
27678 the buffer and window end because update_text_area
27679 doesn't draw that row. (Except when it does, but
27680 that's handled in update_text_area.) */
27682 cy0
= w
->phys_cursor
.y
;
27683 cy1
= cy0
+ w
->phys_cursor_height
;
27684 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27687 w
->phys_cursor_on_p
= false;
27690 #endif /* HAVE_WINDOW_SYSTEM */
27693 /************************************************************************
27695 ************************************************************************/
27697 #ifdef HAVE_WINDOW_SYSTEM
27700 Fix the display of area AREA of overlapping row ROW in window W
27701 with respect to the overlapping part OVERLAPS. */
27704 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27705 enum glyph_row_area area
, int overlaps
)
27712 for (i
= 0; i
< row
->used
[area
];)
27714 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27716 int start
= i
, start_x
= x
;
27720 x
+= row
->glyphs
[area
][i
].pixel_width
;
27723 while (i
< row
->used
[area
]
27724 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27726 draw_glyphs (w
, start_x
, row
, area
,
27728 DRAW_NORMAL_TEXT
, overlaps
);
27732 x
+= row
->glyphs
[area
][i
].pixel_width
;
27742 Draw the cursor glyph of window W in glyph row ROW. See the
27743 comment of draw_glyphs for the meaning of HL. */
27746 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27747 enum draw_glyphs_face hl
)
27749 /* If cursor hpos is out of bounds, don't draw garbage. This can
27750 happen in mini-buffer windows when switching between echo area
27751 glyphs and mini-buffer. */
27752 if ((row
->reversed_p
27753 ? (w
->phys_cursor
.hpos
>= 0)
27754 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27756 bool on_p
= w
->phys_cursor_on_p
;
27758 int hpos
= w
->phys_cursor
.hpos
;
27760 /* When the window is hscrolled, cursor hpos can legitimately be
27761 out of bounds, but we draw the cursor at the corresponding
27762 window margin in that case. */
27763 if (!row
->reversed_p
&& hpos
< 0)
27765 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27766 hpos
= row
->used
[TEXT_AREA
] - 1;
27768 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27770 w
->phys_cursor_on_p
= on_p
;
27772 if (hl
== DRAW_CURSOR
)
27773 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27774 /* When we erase the cursor, and ROW is overlapped by other
27775 rows, make sure that these overlapping parts of other rows
27777 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27779 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27781 if (row
> w
->current_matrix
->rows
27782 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27783 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27784 OVERLAPS_ERASED_CURSOR
);
27786 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27787 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27788 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27789 OVERLAPS_ERASED_CURSOR
);
27795 /* Erase the image of a cursor of window W from the screen. */
27798 erase_phys_cursor (struct window
*w
)
27800 struct frame
*f
= XFRAME (w
->frame
);
27801 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27802 int hpos
= w
->phys_cursor
.hpos
;
27803 int vpos
= w
->phys_cursor
.vpos
;
27804 bool mouse_face_here_p
= false;
27805 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27806 struct glyph_row
*cursor_row
;
27807 struct glyph
*cursor_glyph
;
27808 enum draw_glyphs_face hl
;
27810 /* No cursor displayed or row invalidated => nothing to do on the
27812 if (w
->phys_cursor_type
== NO_CURSOR
)
27813 goto mark_cursor_off
;
27815 /* VPOS >= active_glyphs->nrows means that window has been resized.
27816 Don't bother to erase the cursor. */
27817 if (vpos
>= active_glyphs
->nrows
)
27818 goto mark_cursor_off
;
27820 /* If row containing cursor is marked invalid, there is nothing we
27822 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27823 if (!cursor_row
->enabled_p
)
27824 goto mark_cursor_off
;
27826 /* If line spacing is > 0, old cursor may only be partially visible in
27827 window after split-window. So adjust visible height. */
27828 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27829 window_text_bottom_y (w
) - cursor_row
->y
);
27831 /* If row is completely invisible, don't attempt to delete a cursor which
27832 isn't there. This can happen if cursor is at top of a window, and
27833 we switch to a buffer with a header line in that window. */
27834 if (cursor_row
->visible_height
<= 0)
27835 goto mark_cursor_off
;
27837 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27838 if (cursor_row
->cursor_in_fringe_p
)
27840 cursor_row
->cursor_in_fringe_p
= false;
27841 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27842 goto mark_cursor_off
;
27845 /* This can happen when the new row is shorter than the old one.
27846 In this case, either draw_glyphs or clear_end_of_line
27847 should have cleared the cursor. Note that we wouldn't be
27848 able to erase the cursor in this case because we don't have a
27849 cursor glyph at hand. */
27850 if ((cursor_row
->reversed_p
27851 ? (w
->phys_cursor
.hpos
< 0)
27852 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27853 goto mark_cursor_off
;
27855 /* When the window is hscrolled, cursor hpos can legitimately be out
27856 of bounds, but we draw the cursor at the corresponding window
27857 margin in that case. */
27858 if (!cursor_row
->reversed_p
&& hpos
< 0)
27860 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27861 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27863 /* If the cursor is in the mouse face area, redisplay that when
27864 we clear the cursor. */
27865 if (! NILP (hlinfo
->mouse_face_window
)
27866 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27867 /* Don't redraw the cursor's spot in mouse face if it is at the
27868 end of a line (on a newline). The cursor appears there, but
27869 mouse highlighting does not. */
27870 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27871 mouse_face_here_p
= true;
27873 /* Maybe clear the display under the cursor. */
27874 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27877 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27880 cursor_glyph
= get_phys_cursor_glyph (w
);
27881 if (cursor_glyph
== NULL
)
27882 goto mark_cursor_off
;
27884 width
= cursor_glyph
->pixel_width
;
27885 x
= w
->phys_cursor
.x
;
27891 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27892 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27893 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27896 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27899 /* Erase the cursor by redrawing the character underneath it. */
27900 if (mouse_face_here_p
)
27901 hl
= DRAW_MOUSE_FACE
;
27903 hl
= DRAW_NORMAL_TEXT
;
27904 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27907 w
->phys_cursor_on_p
= false;
27908 w
->phys_cursor_type
= NO_CURSOR
;
27912 /* Display or clear cursor of window W. If !ON, clear the cursor.
27913 If ON, display the cursor; where to put the cursor is specified by
27914 HPOS, VPOS, X and Y. */
27917 display_and_set_cursor (struct window
*w
, bool on
,
27918 int hpos
, int vpos
, int x
, int y
)
27920 struct frame
*f
= XFRAME (w
->frame
);
27921 int new_cursor_type
;
27922 int new_cursor_width
;
27923 bool active_cursor
;
27924 struct glyph_row
*glyph_row
;
27925 struct glyph
*glyph
;
27927 /* This is pointless on invisible frames, and dangerous on garbaged
27928 windows and frames; in the latter case, the frame or window may
27929 be in the midst of changing its size, and x and y may be off the
27931 if (! FRAME_VISIBLE_P (f
)
27932 || FRAME_GARBAGED_P (f
)
27933 || vpos
>= w
->current_matrix
->nrows
27934 || hpos
>= w
->current_matrix
->matrix_w
)
27937 /* If cursor is off and we want it off, return quickly. */
27938 if (!on
&& !w
->phys_cursor_on_p
)
27941 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27942 /* If cursor row is not enabled, we don't really know where to
27943 display the cursor. */
27944 if (!glyph_row
->enabled_p
)
27946 w
->phys_cursor_on_p
= false;
27951 if (!glyph_row
->exact_window_width_line_p
27952 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27953 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27955 eassert (input_blocked_p ());
27957 /* Set new_cursor_type to the cursor we want to be displayed. */
27958 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27959 &new_cursor_width
, &active_cursor
);
27961 /* If cursor is currently being shown and we don't want it to be or
27962 it is in the wrong place, or the cursor type is not what we want,
27964 if (w
->phys_cursor_on_p
27966 || w
->phys_cursor
.x
!= x
27967 || w
->phys_cursor
.y
!= y
27968 /* HPOS can be negative in R2L rows whose
27969 exact_window_width_line_p flag is set (i.e. their newline
27970 would "overflow into the fringe"). */
27972 || new_cursor_type
!= w
->phys_cursor_type
27973 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27974 && new_cursor_width
!= w
->phys_cursor_width
)))
27975 erase_phys_cursor (w
);
27977 /* Don't check phys_cursor_on_p here because that flag is only set
27978 to false in some cases where we know that the cursor has been
27979 completely erased, to avoid the extra work of erasing the cursor
27980 twice. In other words, phys_cursor_on_p can be true and the cursor
27981 still not be visible, or it has only been partly erased. */
27984 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27985 w
->phys_cursor_height
= glyph_row
->height
;
27987 /* Set phys_cursor_.* before x_draw_.* is called because some
27988 of them may need the information. */
27989 w
->phys_cursor
.x
= x
;
27990 w
->phys_cursor
.y
= glyph_row
->y
;
27991 w
->phys_cursor
.hpos
= hpos
;
27992 w
->phys_cursor
.vpos
= vpos
;
27995 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27996 new_cursor_type
, new_cursor_width
,
27997 on
, active_cursor
);
28001 /* Switch the display of W's cursor on or off, according to the value
28005 update_window_cursor (struct window
*w
, bool on
)
28007 /* Don't update cursor in windows whose frame is in the process
28008 of being deleted. */
28009 if (w
->current_matrix
)
28011 int hpos
= w
->phys_cursor
.hpos
;
28012 int vpos
= w
->phys_cursor
.vpos
;
28013 struct glyph_row
*row
;
28015 if (vpos
>= w
->current_matrix
->nrows
28016 || hpos
>= w
->current_matrix
->matrix_w
)
28019 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28021 /* When the window is hscrolled, cursor hpos can legitimately be
28022 out of bounds, but we draw the cursor at the corresponding
28023 window margin in that case. */
28024 if (!row
->reversed_p
&& hpos
< 0)
28026 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28027 hpos
= row
->used
[TEXT_AREA
] - 1;
28030 display_and_set_cursor (w
, on
, hpos
, vpos
,
28031 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28037 /* Call update_window_cursor with parameter ON_P on all leaf windows
28038 in the window tree rooted at W. */
28041 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28045 if (WINDOWP (w
->contents
))
28046 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28048 update_window_cursor (w
, on_p
);
28050 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28056 Display the cursor on window W, or clear it, according to ON_P.
28057 Don't change the cursor's position. */
28060 x_update_cursor (struct frame
*f
, bool on_p
)
28062 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28067 Clear the cursor of window W to background color, and mark the
28068 cursor as not shown. This is used when the text where the cursor
28069 is about to be rewritten. */
28072 x_clear_cursor (struct window
*w
)
28074 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28075 update_window_cursor (w
, false);
28078 #endif /* HAVE_WINDOW_SYSTEM */
28080 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28083 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28084 int start_hpos
, int end_hpos
,
28085 enum draw_glyphs_face draw
)
28087 #ifdef HAVE_WINDOW_SYSTEM
28088 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28090 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28094 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28095 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28099 /* Display the active region described by mouse_face_* according to DRAW. */
28102 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28104 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28105 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28107 if (/* If window is in the process of being destroyed, don't bother
28109 w
->current_matrix
!= NULL
28110 /* Don't update mouse highlight if hidden. */
28111 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28112 /* Recognize when we are called to operate on rows that don't exist
28113 anymore. This can happen when a window is split. */
28114 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28116 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28117 struct glyph_row
*row
, *first
, *last
;
28119 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28120 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28122 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28124 int start_hpos
, end_hpos
, start_x
;
28126 /* For all but the first row, the highlight starts at column 0. */
28129 /* R2L rows have BEG and END in reversed order, but the
28130 screen drawing geometry is always left to right. So
28131 we need to mirror the beginning and end of the
28132 highlighted area in R2L rows. */
28133 if (!row
->reversed_p
)
28135 start_hpos
= hlinfo
->mouse_face_beg_col
;
28136 start_x
= hlinfo
->mouse_face_beg_x
;
28138 else if (row
== last
)
28140 start_hpos
= hlinfo
->mouse_face_end_col
;
28141 start_x
= hlinfo
->mouse_face_end_x
;
28149 else if (row
->reversed_p
&& row
== last
)
28151 start_hpos
= hlinfo
->mouse_face_end_col
;
28152 start_x
= hlinfo
->mouse_face_end_x
;
28162 if (!row
->reversed_p
)
28163 end_hpos
= hlinfo
->mouse_face_end_col
;
28164 else if (row
== first
)
28165 end_hpos
= hlinfo
->mouse_face_beg_col
;
28168 end_hpos
= row
->used
[TEXT_AREA
];
28169 if (draw
== DRAW_NORMAL_TEXT
)
28170 row
->fill_line_p
= true; /* Clear to end of line. */
28173 else if (row
->reversed_p
&& row
== first
)
28174 end_hpos
= hlinfo
->mouse_face_beg_col
;
28177 end_hpos
= row
->used
[TEXT_AREA
];
28178 if (draw
== DRAW_NORMAL_TEXT
)
28179 row
->fill_line_p
= true; /* Clear to end of line. */
28182 if (end_hpos
> start_hpos
)
28184 draw_row_with_mouse_face (w
, start_x
, row
,
28185 start_hpos
, end_hpos
, draw
);
28188 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28192 #ifdef HAVE_WINDOW_SYSTEM
28193 /* When we've written over the cursor, arrange for it to
28194 be displayed again. */
28195 if (FRAME_WINDOW_P (f
)
28196 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28198 int hpos
= w
->phys_cursor
.hpos
;
28200 /* When the window is hscrolled, cursor hpos can legitimately be
28201 out of bounds, but we draw the cursor at the corresponding
28202 window margin in that case. */
28203 if (!row
->reversed_p
&& hpos
< 0)
28205 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28206 hpos
= row
->used
[TEXT_AREA
] - 1;
28209 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28210 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28213 #endif /* HAVE_WINDOW_SYSTEM */
28216 #ifdef HAVE_WINDOW_SYSTEM
28217 /* Change the mouse cursor. */
28218 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28220 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28221 if (draw
== DRAW_NORMAL_TEXT
28222 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28223 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28226 if (draw
== DRAW_MOUSE_FACE
)
28227 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28229 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28231 #endif /* HAVE_WINDOW_SYSTEM */
28235 Clear out the mouse-highlighted active region.
28236 Redraw it un-highlighted first. Value is true if mouse
28237 face was actually drawn unhighlighted. */
28240 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28243 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28245 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28246 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28247 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28248 hlinfo
->mouse_face_window
= Qnil
;
28249 hlinfo
->mouse_face_overlay
= Qnil
;
28253 /* Return true if the coordinates HPOS and VPOS on windows W are
28254 within the mouse face on that window. */
28256 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28258 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28260 /* Quickly resolve the easy cases. */
28261 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28262 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28264 if (vpos
< hlinfo
->mouse_face_beg_row
28265 || vpos
> hlinfo
->mouse_face_end_row
)
28267 if (vpos
> hlinfo
->mouse_face_beg_row
28268 && vpos
< hlinfo
->mouse_face_end_row
)
28271 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28273 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28275 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28278 else if ((vpos
== hlinfo
->mouse_face_beg_row
28279 && hpos
>= hlinfo
->mouse_face_beg_col
)
28280 || (vpos
== hlinfo
->mouse_face_end_row
28281 && hpos
< hlinfo
->mouse_face_end_col
))
28286 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28288 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28291 else if ((vpos
== hlinfo
->mouse_face_beg_row
28292 && hpos
<= hlinfo
->mouse_face_beg_col
)
28293 || (vpos
== hlinfo
->mouse_face_end_row
28294 && hpos
> hlinfo
->mouse_face_end_col
))
28302 True if physical cursor of window W is within mouse face. */
28305 cursor_in_mouse_face_p (struct window
*w
)
28307 int hpos
= w
->phys_cursor
.hpos
;
28308 int vpos
= w
->phys_cursor
.vpos
;
28309 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28311 /* When the window is hscrolled, cursor hpos can legitimately be out
28312 of bounds, but we draw the cursor at the corresponding window
28313 margin in that case. */
28314 if (!row
->reversed_p
&& hpos
< 0)
28316 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28317 hpos
= row
->used
[TEXT_AREA
] - 1;
28319 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28324 /* Find the glyph rows START_ROW and END_ROW of window W that display
28325 characters between buffer positions START_CHARPOS and END_CHARPOS
28326 (excluding END_CHARPOS). DISP_STRING is a display string that
28327 covers these buffer positions. This is similar to
28328 row_containing_pos, but is more accurate when bidi reordering makes
28329 buffer positions change non-linearly with glyph rows. */
28331 rows_from_pos_range (struct window
*w
,
28332 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28333 Lisp_Object disp_string
,
28334 struct glyph_row
**start
, struct glyph_row
**end
)
28336 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28337 int last_y
= window_text_bottom_y (w
);
28338 struct glyph_row
*row
;
28343 while (!first
->enabled_p
28344 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28347 /* Find the START row. */
28349 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28352 /* A row can potentially be the START row if the range of the
28353 characters it displays intersects the range
28354 [START_CHARPOS..END_CHARPOS). */
28355 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28356 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28357 /* See the commentary in row_containing_pos, for the
28358 explanation of the complicated way to check whether
28359 some position is beyond the end of the characters
28360 displayed by a row. */
28361 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28362 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28363 && !row
->ends_at_zv_p
28364 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28365 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28366 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28367 && !row
->ends_at_zv_p
28368 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28370 /* Found a candidate row. Now make sure at least one of the
28371 glyphs it displays has a charpos from the range
28372 [START_CHARPOS..END_CHARPOS).
28374 This is not obvious because bidi reordering could make
28375 buffer positions of a row be 1,2,3,102,101,100, and if we
28376 want to highlight characters in [50..60), we don't want
28377 this row, even though [50..60) does intersect [1..103),
28378 the range of character positions given by the row's start
28379 and end positions. */
28380 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28381 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28385 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28386 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28387 /* A glyph that comes from DISP_STRING is by
28388 definition to be highlighted. */
28389 || EQ (g
->object
, disp_string
))
28398 /* Find the END row. */
28400 /* If the last row is partially visible, start looking for END
28401 from that row, instead of starting from FIRST. */
28402 && !(row
->enabled_p
28403 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28405 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28407 struct glyph_row
*next
= row
+ 1;
28408 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28410 if (!next
->enabled_p
28411 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28412 /* The first row >= START whose range of displayed characters
28413 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28414 is the row END + 1. */
28415 || (start_charpos
< next_start
28416 && end_charpos
< next_start
)
28417 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28418 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28419 && !next
->ends_at_zv_p
28420 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28421 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28422 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28423 && !next
->ends_at_zv_p
28424 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28431 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28432 but none of the characters it displays are in the range, it is
28434 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28435 struct glyph
*s
= g
;
28436 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28440 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28441 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28442 /* If the buffer position of the first glyph in
28443 the row is equal to END_CHARPOS, it means
28444 the last character to be highlighted is the
28445 newline of ROW, and we must consider NEXT as
28447 || (((!next
->reversed_p
&& g
== s
)
28448 || (next
->reversed_p
&& g
== e
- 1))
28449 && (g
->charpos
== end_charpos
28450 /* Special case for when NEXT is an
28451 empty line at ZV. */
28452 || (g
->charpos
== -1
28453 && !row
->ends_at_zv_p
28454 && next_start
== end_charpos
)))))
28455 /* A glyph that comes from DISP_STRING is by
28456 definition to be highlighted. */
28457 || EQ (g
->object
, disp_string
))
28466 /* The first row that ends at ZV must be the last to be
28468 else if (next
->ends_at_zv_p
)
28477 /* This function sets the mouse_face_* elements of HLINFO, assuming
28478 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28479 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28480 for the overlay or run of text properties specifying the mouse
28481 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28482 before-string and after-string that must also be highlighted.
28483 DISP_STRING, if non-nil, is a display string that may cover some
28484 or all of the highlighted text. */
28487 mouse_face_from_buffer_pos (Lisp_Object window
,
28488 Mouse_HLInfo
*hlinfo
,
28489 ptrdiff_t mouse_charpos
,
28490 ptrdiff_t start_charpos
,
28491 ptrdiff_t end_charpos
,
28492 Lisp_Object before_string
,
28493 Lisp_Object after_string
,
28494 Lisp_Object disp_string
)
28496 struct window
*w
= XWINDOW (window
);
28497 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28498 struct glyph_row
*r1
, *r2
;
28499 struct glyph
*glyph
, *end
;
28500 ptrdiff_t ignore
, pos
;
28503 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28504 eassert (NILP (before_string
) || STRINGP (before_string
));
28505 eassert (NILP (after_string
) || STRINGP (after_string
));
28507 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28508 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28510 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28511 /* If the before-string or display-string contains newlines,
28512 rows_from_pos_range skips to its last row. Move back. */
28513 if (!NILP (before_string
) || !NILP (disp_string
))
28515 struct glyph_row
*prev
;
28516 while ((prev
= r1
- 1, prev
>= first
)
28517 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28518 && prev
->used
[TEXT_AREA
] > 0)
28520 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28521 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28522 while (--glyph
>= beg
&& NILP (glyph
->object
));
28524 || !(EQ (glyph
->object
, before_string
)
28525 || EQ (glyph
->object
, disp_string
)))
28532 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28533 hlinfo
->mouse_face_past_end
= true;
28535 else if (!NILP (after_string
))
28537 /* If the after-string has newlines, advance to its last row. */
28538 struct glyph_row
*next
;
28539 struct glyph_row
*last
28540 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28542 for (next
= r2
+ 1;
28544 && next
->used
[TEXT_AREA
] > 0
28545 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28549 /* The rest of the display engine assumes that mouse_face_beg_row is
28550 either above mouse_face_end_row or identical to it. But with
28551 bidi-reordered continued lines, the row for START_CHARPOS could
28552 be below the row for END_CHARPOS. If so, swap the rows and store
28553 them in correct order. */
28556 struct glyph_row
*tem
= r2
;
28562 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28563 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28565 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28566 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28567 could be anywhere in the row and in any order. The strategy
28568 below is to find the leftmost and the rightmost glyph that
28569 belongs to either of these 3 strings, or whose position is
28570 between START_CHARPOS and END_CHARPOS, and highlight all the
28571 glyphs between those two. This may cover more than just the text
28572 between START_CHARPOS and END_CHARPOS if the range of characters
28573 strides the bidi level boundary, e.g. if the beginning is in R2L
28574 text while the end is in L2R text or vice versa. */
28575 if (!r1
->reversed_p
)
28577 /* This row is in a left to right paragraph. Scan it left to
28579 glyph
= r1
->glyphs
[TEXT_AREA
];
28580 end
= glyph
+ r1
->used
[TEXT_AREA
];
28583 /* Skip truncation glyphs at the start of the glyph row. */
28584 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28586 && NILP (glyph
->object
)
28587 && glyph
->charpos
< 0;
28589 x
+= glyph
->pixel_width
;
28591 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28592 or DISP_STRING, and the first glyph from buffer whose
28593 position is between START_CHARPOS and END_CHARPOS. */
28595 && !NILP (glyph
->object
)
28596 && !EQ (glyph
->object
, disp_string
)
28597 && !(BUFFERP (glyph
->object
)
28598 && (glyph
->charpos
>= start_charpos
28599 && glyph
->charpos
< end_charpos
));
28602 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28603 are present at buffer positions between START_CHARPOS and
28604 END_CHARPOS, or if they come from an overlay. */
28605 if (EQ (glyph
->object
, before_string
))
28607 pos
= string_buffer_position (before_string
,
28609 /* If pos == 0, it means before_string came from an
28610 overlay, not from a buffer position. */
28611 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28614 else if (EQ (glyph
->object
, after_string
))
28616 pos
= string_buffer_position (after_string
, end_charpos
);
28617 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28620 x
+= glyph
->pixel_width
;
28622 hlinfo
->mouse_face_beg_x
= x
;
28623 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28627 /* This row is in a right to left paragraph. Scan it right to
28631 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28632 glyph
= end
+ r1
->used
[TEXT_AREA
];
28634 /* Skip truncation glyphs at the start of the glyph row. */
28635 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28637 && NILP (glyph
->object
)
28638 && glyph
->charpos
< 0;
28642 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28643 or DISP_STRING, and the first glyph from buffer whose
28644 position is between START_CHARPOS and END_CHARPOS. */
28646 && !NILP (glyph
->object
)
28647 && !EQ (glyph
->object
, disp_string
)
28648 && !(BUFFERP (glyph
->object
)
28649 && (glyph
->charpos
>= start_charpos
28650 && glyph
->charpos
< end_charpos
));
28653 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28654 are present at buffer positions between START_CHARPOS and
28655 END_CHARPOS, or if they come from an overlay. */
28656 if (EQ (glyph
->object
, before_string
))
28658 pos
= string_buffer_position (before_string
, start_charpos
);
28659 /* If pos == 0, it means before_string came from an
28660 overlay, not from a buffer position. */
28661 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28664 else if (EQ (glyph
->object
, after_string
))
28666 pos
= string_buffer_position (after_string
, end_charpos
);
28667 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28672 glyph
++; /* first glyph to the right of the highlighted area */
28673 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28674 x
+= g
->pixel_width
;
28675 hlinfo
->mouse_face_beg_x
= x
;
28676 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28679 /* If the highlight ends in a different row, compute GLYPH and END
28680 for the end row. Otherwise, reuse the values computed above for
28681 the row where the highlight begins. */
28684 if (!r2
->reversed_p
)
28686 glyph
= r2
->glyphs
[TEXT_AREA
];
28687 end
= glyph
+ r2
->used
[TEXT_AREA
];
28692 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28693 glyph
= end
+ r2
->used
[TEXT_AREA
];
28697 if (!r2
->reversed_p
)
28699 /* Skip truncation and continuation glyphs near the end of the
28700 row, and also blanks and stretch glyphs inserted by
28701 extend_face_to_end_of_line. */
28703 && NILP ((end
- 1)->object
))
28705 /* Scan the rest of the glyph row from the end, looking for the
28706 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28707 DISP_STRING, or whose position is between START_CHARPOS
28711 && !NILP (end
->object
)
28712 && !EQ (end
->object
, disp_string
)
28713 && !(BUFFERP (end
->object
)
28714 && (end
->charpos
>= start_charpos
28715 && end
->charpos
< end_charpos
));
28718 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28719 are present at buffer positions between START_CHARPOS and
28720 END_CHARPOS, or if they come from an overlay. */
28721 if (EQ (end
->object
, before_string
))
28723 pos
= string_buffer_position (before_string
, start_charpos
);
28724 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28727 else if (EQ (end
->object
, after_string
))
28729 pos
= string_buffer_position (after_string
, end_charpos
);
28730 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28734 /* Find the X coordinate of the last glyph to be highlighted. */
28735 for (; glyph
<= end
; ++glyph
)
28736 x
+= glyph
->pixel_width
;
28738 hlinfo
->mouse_face_end_x
= x
;
28739 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28743 /* Skip truncation and continuation glyphs near the end of the
28744 row, and also blanks and stretch glyphs inserted by
28745 extend_face_to_end_of_line. */
28749 && NILP (end
->object
))
28751 x
+= end
->pixel_width
;
28754 /* Scan the rest of the glyph row from the end, looking for the
28755 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28756 DISP_STRING, or whose position is between START_CHARPOS
28760 && !NILP (end
->object
)
28761 && !EQ (end
->object
, disp_string
)
28762 && !(BUFFERP (end
->object
)
28763 && (end
->charpos
>= start_charpos
28764 && end
->charpos
< end_charpos
));
28767 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28768 are present at buffer positions between START_CHARPOS and
28769 END_CHARPOS, or if they come from an overlay. */
28770 if (EQ (end
->object
, before_string
))
28772 pos
= string_buffer_position (before_string
, start_charpos
);
28773 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28776 else if (EQ (end
->object
, after_string
))
28778 pos
= string_buffer_position (after_string
, end_charpos
);
28779 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28782 x
+= end
->pixel_width
;
28784 /* If we exited the above loop because we arrived at the last
28785 glyph of the row, and its buffer position is still not in
28786 range, it means the last character in range is the preceding
28787 newline. Bump the end column and x values to get past the
28790 && BUFFERP (end
->object
)
28791 && (end
->charpos
< start_charpos
28792 || end
->charpos
>= end_charpos
))
28794 x
+= end
->pixel_width
;
28797 hlinfo
->mouse_face_end_x
= x
;
28798 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28801 hlinfo
->mouse_face_window
= window
;
28802 hlinfo
->mouse_face_face_id
28803 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28805 !hlinfo
->mouse_face_hidden
, -1);
28806 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28809 /* The following function is not used anymore (replaced with
28810 mouse_face_from_string_pos), but I leave it here for the time
28811 being, in case someone would. */
28813 #if false /* not used */
28815 /* Find the position of the glyph for position POS in OBJECT in
28816 window W's current matrix, and return in *X, *Y the pixel
28817 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28819 RIGHT_P means return the position of the right edge of the glyph.
28820 !RIGHT_P means return the left edge position.
28822 If no glyph for POS exists in the matrix, return the position of
28823 the glyph with the next smaller position that is in the matrix, if
28824 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28825 exists in the matrix, return the position of the glyph with the
28826 next larger position in OBJECT.
28828 Value is true if a glyph was found. */
28831 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28832 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28834 int yb
= window_text_bottom_y (w
);
28835 struct glyph_row
*r
;
28836 struct glyph
*best_glyph
= NULL
;
28837 struct glyph_row
*best_row
= NULL
;
28840 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28841 r
->enabled_p
&& r
->y
< yb
;
28844 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28845 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28848 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28849 if (EQ (g
->object
, object
))
28851 if (g
->charpos
== pos
)
28858 else if (best_glyph
== NULL
28859 || ((eabs (g
->charpos
- pos
)
28860 < eabs (best_glyph
->charpos
- pos
))
28863 : g
->charpos
> pos
)))
28877 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28881 *x
+= best_glyph
->pixel_width
;
28886 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28889 return best_glyph
!= NULL
;
28891 #endif /* not used */
28893 /* Find the positions of the first and the last glyphs in window W's
28894 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28895 (assumed to be a string), and return in HLINFO's mouse_face_*
28896 members the pixel and column/row coordinates of those glyphs. */
28899 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28900 Lisp_Object object
,
28901 ptrdiff_t startpos
, ptrdiff_t endpos
)
28903 int yb
= window_text_bottom_y (w
);
28904 struct glyph_row
*r
;
28905 struct glyph
*g
, *e
;
28907 bool found
= false;
28909 /* Find the glyph row with at least one position in the range
28910 [STARTPOS..ENDPOS), and the first glyph in that row whose
28911 position belongs to that range. */
28912 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28913 r
->enabled_p
&& r
->y
< yb
;
28916 if (!r
->reversed_p
)
28918 g
= r
->glyphs
[TEXT_AREA
];
28919 e
= g
+ r
->used
[TEXT_AREA
];
28920 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28921 if (EQ (g
->object
, object
)
28922 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28924 hlinfo
->mouse_face_beg_row
28925 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28926 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28927 hlinfo
->mouse_face_beg_x
= gx
;
28936 e
= r
->glyphs
[TEXT_AREA
];
28937 g
= e
+ r
->used
[TEXT_AREA
];
28938 for ( ; g
> e
; --g
)
28939 if (EQ ((g
-1)->object
, object
)
28940 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28942 hlinfo
->mouse_face_beg_row
28943 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28944 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28945 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28946 gx
+= g1
->pixel_width
;
28947 hlinfo
->mouse_face_beg_x
= gx
;
28959 /* Starting with the next row, look for the first row which does NOT
28960 include any glyphs whose positions are in the range. */
28961 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28963 g
= r
->glyphs
[TEXT_AREA
];
28964 e
= g
+ r
->used
[TEXT_AREA
];
28966 for ( ; g
< e
; ++g
)
28967 if (EQ (g
->object
, object
)
28968 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28977 /* The highlighted region ends on the previous row. */
28980 /* Set the end row. */
28981 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28983 /* Compute and set the end column and the end column's horizontal
28984 pixel coordinate. */
28985 if (!r
->reversed_p
)
28987 g
= r
->glyphs
[TEXT_AREA
];
28988 e
= g
+ r
->used
[TEXT_AREA
];
28989 for ( ; e
> g
; --e
)
28990 if (EQ ((e
-1)->object
, object
)
28991 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28993 hlinfo
->mouse_face_end_col
= e
- g
;
28995 for (gx
= r
->x
; g
< e
; ++g
)
28996 gx
+= g
->pixel_width
;
28997 hlinfo
->mouse_face_end_x
= gx
;
29001 e
= r
->glyphs
[TEXT_AREA
];
29002 g
= e
+ r
->used
[TEXT_AREA
];
29003 for (gx
= r
->x
; e
< g
; ++e
)
29005 if (EQ (e
->object
, object
)
29006 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29008 gx
+= e
->pixel_width
;
29010 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29011 hlinfo
->mouse_face_end_x
= gx
;
29015 #ifdef HAVE_WINDOW_SYSTEM
29017 /* See if position X, Y is within a hot-spot of an image. */
29020 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29022 if (!CONSP (hot_spot
))
29025 if (EQ (XCAR (hot_spot
), Qrect
))
29027 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29028 Lisp_Object rect
= XCDR (hot_spot
);
29032 if (!CONSP (XCAR (rect
)))
29034 if (!CONSP (XCDR (rect
)))
29036 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29038 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29040 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29042 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29046 else if (EQ (XCAR (hot_spot
), Qcircle
))
29048 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29049 Lisp_Object circ
= XCDR (hot_spot
);
29050 Lisp_Object lr
, lx0
, ly0
;
29052 && CONSP (XCAR (circ
))
29053 && (lr
= XCDR (circ
), NUMBERP (lr
))
29054 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29055 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29057 double r
= XFLOATINT (lr
);
29058 double dx
= XINT (lx0
) - x
;
29059 double dy
= XINT (ly0
) - y
;
29060 return (dx
* dx
+ dy
* dy
<= r
* r
);
29063 else if (EQ (XCAR (hot_spot
), Qpoly
))
29065 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29066 if (VECTORP (XCDR (hot_spot
)))
29068 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29069 Lisp_Object
*poly
= v
->contents
;
29070 ptrdiff_t n
= v
->header
.size
;
29072 bool inside
= false;
29073 Lisp_Object lx
, ly
;
29076 /* Need an even number of coordinates, and at least 3 edges. */
29077 if (n
< 6 || n
& 1)
29080 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29081 If count is odd, we are inside polygon. Pixels on edges
29082 may or may not be included depending on actual geometry of the
29084 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29085 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29087 x0
= XINT (lx
), y0
= XINT (ly
);
29088 for (i
= 0; i
< n
; i
+= 2)
29090 int x1
= x0
, y1
= y0
;
29091 if ((lx
= poly
[i
], !INTEGERP (lx
))
29092 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29094 x0
= XINT (lx
), y0
= XINT (ly
);
29096 /* Does this segment cross the X line? */
29104 if (y
> y0
&& y
> y1
)
29106 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29116 find_hot_spot (Lisp_Object map
, int x
, int y
)
29118 while (CONSP (map
))
29120 if (CONSP (XCAR (map
))
29121 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29129 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29131 doc
: /* Lookup in image map MAP coordinates X and Y.
29132 An image map is an alist where each element has the format (AREA ID PLIST).
29133 An AREA is specified as either a rectangle, a circle, or a polygon:
29134 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29135 pixel coordinates of the upper left and bottom right corners.
29136 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29137 and the radius of the circle; r may be a float or integer.
29138 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29139 vector describes one corner in the polygon.
29140 Returns the alist element for the first matching AREA in MAP. */)
29141 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29149 return find_hot_spot (map
,
29150 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29151 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29155 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29157 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29159 /* Do not change cursor shape while dragging mouse. */
29160 if (EQ (do_mouse_tracking
, Qdragging
))
29163 if (!NILP (pointer
))
29165 if (EQ (pointer
, Qarrow
))
29166 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29167 else if (EQ (pointer
, Qhand
))
29168 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29169 else if (EQ (pointer
, Qtext
))
29170 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29171 else if (EQ (pointer
, intern ("hdrag")))
29172 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29173 else if (EQ (pointer
, intern ("nhdrag")))
29174 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29175 #ifdef HAVE_X_WINDOWS
29176 else if (EQ (pointer
, intern ("vdrag")))
29177 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29179 else if (EQ (pointer
, intern ("hourglass")))
29180 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29181 else if (EQ (pointer
, Qmodeline
))
29182 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29184 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29187 if (cursor
!= No_Cursor
)
29188 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29191 #endif /* HAVE_WINDOW_SYSTEM */
29193 /* Take proper action when mouse has moved to the mode or header line
29194 or marginal area AREA of window W, x-position X and y-position Y.
29195 X is relative to the start of the text display area of W, so the
29196 width of bitmap areas and scroll bars must be subtracted to get a
29197 position relative to the start of the mode line. */
29200 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29201 enum window_part area
)
29203 struct window
*w
= XWINDOW (window
);
29204 struct frame
*f
= XFRAME (w
->frame
);
29205 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29206 #ifdef HAVE_WINDOW_SYSTEM
29207 Display_Info
*dpyinfo
;
29209 Cursor cursor
= No_Cursor
;
29210 Lisp_Object pointer
= Qnil
;
29211 int dx
, dy
, width
, height
;
29213 Lisp_Object string
, object
= Qnil
;
29214 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29216 Lisp_Object mouse_face
;
29217 int original_x_pixel
= x
;
29218 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29219 struct glyph_row
*row
IF_LINT (= 0);
29221 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29226 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29227 returns them in row/column units! */
29228 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29229 &object
, &dx
, &dy
, &width
, &height
);
29231 row
= (area
== ON_MODE_LINE
29232 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29233 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29235 /* Find the glyph under the mouse pointer. */
29236 if (row
->mode_line_p
&& row
->enabled_p
)
29238 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29239 end
= glyph
+ row
->used
[TEXT_AREA
];
29241 for (x0
= original_x_pixel
;
29242 glyph
< end
&& x0
>= glyph
->pixel_width
;
29244 x0
-= glyph
->pixel_width
;
29252 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29253 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29254 returns them in row/column units! */
29255 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29256 &object
, &dx
, &dy
, &width
, &height
);
29261 #ifdef HAVE_WINDOW_SYSTEM
29262 if (IMAGEP (object
))
29264 Lisp_Object image_map
, hotspot
;
29265 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29267 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29269 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29273 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29274 If so, we could look for mouse-enter, mouse-leave
29275 properties in PLIST (and do something...). */
29276 hotspot
= XCDR (hotspot
);
29277 if (CONSP (hotspot
)
29278 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29280 pointer
= Fplist_get (plist
, Qpointer
);
29281 if (NILP (pointer
))
29283 help
= Fplist_get (plist
, Qhelp_echo
);
29286 help_echo_string
= help
;
29287 XSETWINDOW (help_echo_window
, w
);
29288 help_echo_object
= w
->contents
;
29289 help_echo_pos
= charpos
;
29293 if (NILP (pointer
))
29294 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29296 #endif /* HAVE_WINDOW_SYSTEM */
29298 if (STRINGP (string
))
29299 pos
= make_number (charpos
);
29301 /* Set the help text and mouse pointer. If the mouse is on a part
29302 of the mode line without any text (e.g. past the right edge of
29303 the mode line text), use the default help text and pointer. */
29304 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29306 /* Arrange to display the help by setting the global variables
29307 help_echo_string, help_echo_object, and help_echo_pos. */
29310 if (STRINGP (string
))
29311 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29315 help_echo_string
= help
;
29316 XSETWINDOW (help_echo_window
, w
);
29317 help_echo_object
= string
;
29318 help_echo_pos
= charpos
;
29320 else if (area
== ON_MODE_LINE
)
29322 Lisp_Object default_help
29323 = buffer_local_value (Qmode_line_default_help_echo
,
29326 if (STRINGP (default_help
))
29328 help_echo_string
= default_help
;
29329 XSETWINDOW (help_echo_window
, w
);
29330 help_echo_object
= Qnil
;
29331 help_echo_pos
= -1;
29336 #ifdef HAVE_WINDOW_SYSTEM
29337 /* Change the mouse pointer according to what is under it. */
29338 if (FRAME_WINDOW_P (f
))
29340 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29342 || NILP (Vresize_mini_windows
));
29344 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29345 if (STRINGP (string
))
29347 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29349 if (NILP (pointer
))
29350 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29352 /* Change the mouse pointer according to what is under X/Y. */
29354 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29357 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29358 if (!KEYMAPP (map
))
29359 map
= Fget_text_property (pos
, Qkeymap
, string
);
29360 if (!KEYMAPP (map
) && draggable
)
29361 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29364 else if (draggable
)
29365 /* Default mode-line pointer. */
29366 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29371 /* Change the mouse face according to what is under X/Y. */
29372 bool mouse_face_shown
= false;
29373 if (STRINGP (string
))
29375 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29376 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29377 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29382 struct glyph
* tmp_glyph
;
29386 int total_pixel_width
;
29387 ptrdiff_t begpos
, endpos
, ignore
;
29391 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29392 Qmouse_face
, string
, Qnil
);
29398 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29400 endpos
= SCHARS (string
);
29404 /* Calculate the glyph position GPOS of GLYPH in the
29405 displayed string, relative to the beginning of the
29406 highlighted part of the string.
29408 Note: GPOS is different from CHARPOS. CHARPOS is the
29409 position of GLYPH in the internal string object. A mode
29410 line string format has structures which are converted to
29411 a flattened string by the Emacs Lisp interpreter. The
29412 internal string is an element of those structures. The
29413 displayed string is the flattened string. */
29414 tmp_glyph
= row_start_glyph
;
29415 while (tmp_glyph
< glyph
29416 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29417 && begpos
<= tmp_glyph
->charpos
29418 && tmp_glyph
->charpos
< endpos
)))
29420 gpos
= glyph
- tmp_glyph
;
29422 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29423 the highlighted part of the displayed string to which
29424 GLYPH belongs. Note: GSEQ_LENGTH is different from
29425 SCHARS (STRING), because the latter returns the length of
29426 the internal string. */
29427 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29429 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29430 && begpos
<= tmp_glyph
->charpos
29431 && tmp_glyph
->charpos
< endpos
));
29434 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29436 /* Calculate the total pixel width of all the glyphs between
29437 the beginning of the highlighted area and GLYPH. */
29438 total_pixel_width
= 0;
29439 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29440 total_pixel_width
+= tmp_glyph
->pixel_width
;
29442 /* Pre calculation of re-rendering position. Note: X is in
29443 column units here, after the call to mode_line_string or
29444 marginal_area_string. */
29446 vpos
= (area
== ON_MODE_LINE
29447 ? (w
->current_matrix
)->nrows
- 1
29450 /* If GLYPH's position is included in the region that is
29451 already drawn in mouse face, we have nothing to do. */
29452 if ( EQ (window
, hlinfo
->mouse_face_window
)
29453 && (!row
->reversed_p
29454 ? (hlinfo
->mouse_face_beg_col
<= hpos
29455 && hpos
< hlinfo
->mouse_face_end_col
)
29456 /* In R2L rows we swap BEG and END, see below. */
29457 : (hlinfo
->mouse_face_end_col
<= hpos
29458 && hpos
< hlinfo
->mouse_face_beg_col
))
29459 && hlinfo
->mouse_face_beg_row
== vpos
)
29462 if (clear_mouse_face (hlinfo
))
29463 cursor
= No_Cursor
;
29465 if (!row
->reversed_p
)
29467 hlinfo
->mouse_face_beg_col
= hpos
;
29468 hlinfo
->mouse_face_beg_x
= original_x_pixel
29469 - (total_pixel_width
+ dx
);
29470 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29471 hlinfo
->mouse_face_end_x
= 0;
29475 /* In R2L rows, show_mouse_face expects BEG and END
29476 coordinates to be swapped. */
29477 hlinfo
->mouse_face_end_col
= hpos
;
29478 hlinfo
->mouse_face_end_x
= original_x_pixel
29479 - (total_pixel_width
+ dx
);
29480 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29481 hlinfo
->mouse_face_beg_x
= 0;
29484 hlinfo
->mouse_face_beg_row
= vpos
;
29485 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29486 hlinfo
->mouse_face_past_end
= false;
29487 hlinfo
->mouse_face_window
= window
;
29489 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29494 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29495 mouse_face_shown
= true;
29497 if (NILP (pointer
))
29502 /* If mouse-face doesn't need to be shown, clear any existing
29504 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29505 clear_mouse_face (hlinfo
);
29507 #ifdef HAVE_WINDOW_SYSTEM
29508 if (FRAME_WINDOW_P (f
))
29509 define_frame_cursor1 (f
, cursor
, pointer
);
29515 Take proper action when the mouse has moved to position X, Y on
29516 frame F with regards to highlighting portions of display that have
29517 mouse-face properties. Also de-highlight portions of display where
29518 the mouse was before, set the mouse pointer shape as appropriate
29519 for the mouse coordinates, and activate help echo (tooltips).
29520 X and Y can be negative or out of range. */
29523 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29525 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29526 enum window_part part
= ON_NOTHING
;
29527 Lisp_Object window
;
29529 Cursor cursor
= No_Cursor
;
29530 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29533 /* When a menu is active, don't highlight because this looks odd. */
29534 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29535 if (popup_activated ())
29539 if (!f
->glyphs_initialized_p
29540 || f
->pointer_invisible
)
29543 hlinfo
->mouse_face_mouse_x
= x
;
29544 hlinfo
->mouse_face_mouse_y
= y
;
29545 hlinfo
->mouse_face_mouse_frame
= f
;
29547 if (hlinfo
->mouse_face_defer
)
29550 /* Which window is that in? */
29551 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29553 /* If displaying active text in another window, clear that. */
29554 if (! EQ (window
, hlinfo
->mouse_face_window
)
29555 /* Also clear if we move out of text area in same window. */
29556 || (!NILP (hlinfo
->mouse_face_window
)
29559 && part
!= ON_MODE_LINE
29560 && part
!= ON_HEADER_LINE
))
29561 clear_mouse_face (hlinfo
);
29563 /* Not on a window -> return. */
29564 if (!WINDOWP (window
))
29567 /* Reset help_echo_string. It will get recomputed below. */
29568 help_echo_string
= Qnil
;
29570 /* Convert to window-relative pixel coordinates. */
29571 w
= XWINDOW (window
);
29572 frame_to_window_pixel_xy (w
, &x
, &y
);
29574 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29575 /* Handle tool-bar window differently since it doesn't display a
29577 if (EQ (window
, f
->tool_bar_window
))
29579 note_tool_bar_highlight (f
, x
, y
);
29584 /* Mouse is on the mode, header line or margin? */
29585 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29586 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29588 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29590 #ifdef HAVE_WINDOW_SYSTEM
29591 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29593 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29594 /* Show non-text cursor (Bug#16647). */
29602 #ifdef HAVE_WINDOW_SYSTEM
29603 if (part
== ON_VERTICAL_BORDER
)
29605 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29606 help_echo_string
= build_string ("drag-mouse-1: resize");
29608 else if (part
== ON_RIGHT_DIVIDER
)
29610 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29611 help_echo_string
= build_string ("drag-mouse-1: resize");
29613 else if (part
== ON_BOTTOM_DIVIDER
)
29614 if (! WINDOW_BOTTOMMOST_P (w
)
29616 || NILP (Vresize_mini_windows
))
29618 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29619 help_echo_string
= build_string ("drag-mouse-1: resize");
29622 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29623 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29624 || part
== ON_VERTICAL_SCROLL_BAR
29625 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29626 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29628 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29631 /* Are we in a window whose display is up to date?
29632 And verify the buffer's text has not changed. */
29633 b
= XBUFFER (w
->contents
);
29634 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29636 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29638 struct glyph
*glyph
;
29639 Lisp_Object object
;
29640 Lisp_Object mouse_face
= Qnil
, position
;
29641 Lisp_Object
*overlay_vec
= NULL
;
29642 ptrdiff_t i
, noverlays
;
29643 struct buffer
*obuf
;
29644 ptrdiff_t obegv
, ozv
;
29647 /* Find the glyph under X/Y. */
29648 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29650 #ifdef HAVE_WINDOW_SYSTEM
29651 /* Look for :pointer property on image. */
29652 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29654 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29655 if (img
!= NULL
&& IMAGEP (img
->spec
))
29657 Lisp_Object image_map
, hotspot
;
29658 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29660 && (hotspot
= find_hot_spot (image_map
,
29661 glyph
->slice
.img
.x
+ dx
,
29662 glyph
->slice
.img
.y
+ dy
),
29664 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29668 /* Could check XCAR (hotspot) to see if we enter/leave
29670 If so, we could look for mouse-enter, mouse-leave
29671 properties in PLIST (and do something...). */
29672 hotspot
= XCDR (hotspot
);
29673 if (CONSP (hotspot
)
29674 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29676 pointer
= Fplist_get (plist
, Qpointer
);
29677 if (NILP (pointer
))
29679 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29680 if (!NILP (help_echo_string
))
29682 help_echo_window
= window
;
29683 help_echo_object
= glyph
->object
;
29684 help_echo_pos
= glyph
->charpos
;
29688 if (NILP (pointer
))
29689 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29692 #endif /* HAVE_WINDOW_SYSTEM */
29694 /* Clear mouse face if X/Y not over text. */
29696 || area
!= TEXT_AREA
29697 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29698 /* Glyph's OBJECT is nil for glyphs inserted by the
29699 display engine for its internal purposes, like truncation
29700 and continuation glyphs and blanks beyond the end of
29701 line's text on text terminals. If we are over such a
29702 glyph, we are not over any text. */
29703 || NILP (glyph
->object
)
29704 /* R2L rows have a stretch glyph at their front, which
29705 stands for no text, whereas L2R rows have no glyphs at
29706 all beyond the end of text. Treat such stretch glyphs
29707 like we do with NULL glyphs in L2R rows. */
29708 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29709 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29710 && glyph
->type
== STRETCH_GLYPH
29711 && glyph
->avoid_cursor_p
))
29713 if (clear_mouse_face (hlinfo
))
29714 cursor
= No_Cursor
;
29715 #ifdef HAVE_WINDOW_SYSTEM
29716 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29718 if (area
!= TEXT_AREA
)
29719 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29721 pointer
= Vvoid_text_area_pointer
;
29727 pos
= glyph
->charpos
;
29728 object
= glyph
->object
;
29729 if (!STRINGP (object
) && !BUFFERP (object
))
29732 /* If we get an out-of-range value, return now; avoid an error. */
29733 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29736 /* Make the window's buffer temporarily current for
29737 overlays_at and compute_char_face. */
29738 obuf
= current_buffer
;
29739 current_buffer
= b
;
29745 /* Is this char mouse-active or does it have help-echo? */
29746 position
= make_number (pos
);
29750 if (BUFFERP (object
))
29752 /* Put all the overlays we want in a vector in overlay_vec. */
29753 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29754 /* Sort overlays into increasing priority order. */
29755 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29760 if (NILP (Vmouse_highlight
))
29762 clear_mouse_face (hlinfo
);
29763 goto check_help_echo
;
29766 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29769 cursor
= No_Cursor
;
29771 /* Check mouse-face highlighting. */
29773 /* If there exists an overlay with mouse-face overlapping
29774 the one we are currently highlighting, we have to
29775 check if we enter the overlapping overlay, and then
29776 highlight only that. */
29777 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29778 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29780 /* Find the highest priority overlay with a mouse-face. */
29781 Lisp_Object overlay
= Qnil
;
29782 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29784 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29785 if (!NILP (mouse_face
))
29786 overlay
= overlay_vec
[i
];
29789 /* If we're highlighting the same overlay as before, there's
29790 no need to do that again. */
29791 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29792 goto check_help_echo
;
29793 hlinfo
->mouse_face_overlay
= overlay
;
29795 /* Clear the display of the old active region, if any. */
29796 if (clear_mouse_face (hlinfo
))
29797 cursor
= No_Cursor
;
29799 /* If no overlay applies, get a text property. */
29800 if (NILP (overlay
))
29801 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29803 /* Next, compute the bounds of the mouse highlighting and
29805 if (!NILP (mouse_face
) && STRINGP (object
))
29807 /* The mouse-highlighting comes from a display string
29808 with a mouse-face. */
29812 s
= Fprevious_single_property_change
29813 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29814 e
= Fnext_single_property_change
29815 (position
, Qmouse_face
, object
, Qnil
);
29817 s
= make_number (0);
29819 e
= make_number (SCHARS (object
));
29820 mouse_face_from_string_pos (w
, hlinfo
, object
,
29821 XINT (s
), XINT (e
));
29822 hlinfo
->mouse_face_past_end
= false;
29823 hlinfo
->mouse_face_window
= window
;
29824 hlinfo
->mouse_face_face_id
29825 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29826 glyph
->face_id
, true);
29827 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29828 cursor
= No_Cursor
;
29832 /* The mouse-highlighting, if any, comes from an overlay
29833 or text property in the buffer. */
29834 Lisp_Object buffer
IF_LINT (= Qnil
);
29835 Lisp_Object disp_string
IF_LINT (= Qnil
);
29837 if (STRINGP (object
))
29839 /* If we are on a display string with no mouse-face,
29840 check if the text under it has one. */
29841 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29842 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29843 pos
= string_buffer_position (object
, start
);
29846 mouse_face
= get_char_property_and_overlay
29847 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29848 buffer
= w
->contents
;
29849 disp_string
= object
;
29855 disp_string
= Qnil
;
29858 if (!NILP (mouse_face
))
29860 Lisp_Object before
, after
;
29861 Lisp_Object before_string
, after_string
;
29862 /* To correctly find the limits of mouse highlight
29863 in a bidi-reordered buffer, we must not use the
29864 optimization of limiting the search in
29865 previous-single-property-change and
29866 next-single-property-change, because
29867 rows_from_pos_range needs the real start and end
29868 positions to DTRT in this case. That's because
29869 the first row visible in a window does not
29870 necessarily display the character whose position
29871 is the smallest. */
29873 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29874 ? Fmarker_position (w
->start
)
29877 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29878 ? make_number (BUF_Z (XBUFFER (buffer
))
29879 - w
->window_end_pos
)
29882 if (NILP (overlay
))
29884 /* Handle the text property case. */
29885 before
= Fprevious_single_property_change
29886 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29887 after
= Fnext_single_property_change
29888 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29889 before_string
= after_string
= Qnil
;
29893 /* Handle the overlay case. */
29894 before
= Foverlay_start (overlay
);
29895 after
= Foverlay_end (overlay
);
29896 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29897 after_string
= Foverlay_get (overlay
, Qafter_string
);
29899 if (!STRINGP (before_string
)) before_string
= Qnil
;
29900 if (!STRINGP (after_string
)) after_string
= Qnil
;
29903 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29906 : XFASTINT (before
),
29908 ? BUF_Z (XBUFFER (buffer
))
29909 : XFASTINT (after
),
29910 before_string
, after_string
,
29912 cursor
= No_Cursor
;
29919 /* Look for a `help-echo' property. */
29920 if (NILP (help_echo_string
)) {
29921 Lisp_Object help
, overlay
;
29923 /* Check overlays first. */
29924 help
= overlay
= Qnil
;
29925 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29927 overlay
= overlay_vec
[i
];
29928 help
= Foverlay_get (overlay
, Qhelp_echo
);
29933 help_echo_string
= help
;
29934 help_echo_window
= window
;
29935 help_echo_object
= overlay
;
29936 help_echo_pos
= pos
;
29940 Lisp_Object obj
= glyph
->object
;
29941 ptrdiff_t charpos
= glyph
->charpos
;
29943 /* Try text properties. */
29946 && charpos
< SCHARS (obj
))
29948 help
= Fget_text_property (make_number (charpos
),
29952 /* If the string itself doesn't specify a help-echo,
29953 see if the buffer text ``under'' it does. */
29954 struct glyph_row
*r
29955 = MATRIX_ROW (w
->current_matrix
, vpos
);
29956 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29957 ptrdiff_t p
= string_buffer_position (obj
, start
);
29960 help
= Fget_char_property (make_number (p
),
29961 Qhelp_echo
, w
->contents
);
29970 else if (BUFFERP (obj
)
29973 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29978 help_echo_string
= help
;
29979 help_echo_window
= window
;
29980 help_echo_object
= obj
;
29981 help_echo_pos
= charpos
;
29986 #ifdef HAVE_WINDOW_SYSTEM
29987 /* Look for a `pointer' property. */
29988 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29990 /* Check overlays first. */
29991 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29992 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29994 if (NILP (pointer
))
29996 Lisp_Object obj
= glyph
->object
;
29997 ptrdiff_t charpos
= glyph
->charpos
;
29999 /* Try text properties. */
30002 && charpos
< SCHARS (obj
))
30004 pointer
= Fget_text_property (make_number (charpos
),
30006 if (NILP (pointer
))
30008 /* If the string itself doesn't specify a pointer,
30009 see if the buffer text ``under'' it does. */
30010 struct glyph_row
*r
30011 = MATRIX_ROW (w
->current_matrix
, vpos
);
30012 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30013 ptrdiff_t p
= string_buffer_position (obj
, start
);
30015 pointer
= Fget_char_property (make_number (p
),
30016 Qpointer
, w
->contents
);
30019 else if (BUFFERP (obj
)
30022 pointer
= Fget_text_property (make_number (charpos
),
30026 #endif /* HAVE_WINDOW_SYSTEM */
30030 current_buffer
= obuf
;
30036 #ifdef HAVE_WINDOW_SYSTEM
30037 if (FRAME_WINDOW_P (f
))
30038 define_frame_cursor1 (f
, cursor
, pointer
);
30040 /* This is here to prevent a compiler error, about "label at end of
30041 compound statement". */
30048 Clear any mouse-face on window W. This function is part of the
30049 redisplay interface, and is called from try_window_id and similar
30050 functions to ensure the mouse-highlight is off. */
30053 x_clear_window_mouse_face (struct window
*w
)
30055 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30056 Lisp_Object window
;
30059 XSETWINDOW (window
, w
);
30060 if (EQ (window
, hlinfo
->mouse_face_window
))
30061 clear_mouse_face (hlinfo
);
30067 Just discard the mouse face information for frame F, if any.
30068 This is used when the size of F is changed. */
30071 cancel_mouse_face (struct frame
*f
)
30073 Lisp_Object window
;
30074 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30076 window
= hlinfo
->mouse_face_window
;
30077 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30078 reset_mouse_highlight (hlinfo
);
30083 /***********************************************************************
30085 ***********************************************************************/
30087 #ifdef HAVE_WINDOW_SYSTEM
30089 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30090 which intersects rectangle R. R is in window-relative coordinates. */
30093 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30094 enum glyph_row_area area
)
30096 struct glyph
*first
= row
->glyphs
[area
];
30097 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30098 struct glyph
*last
;
30099 int first_x
, start_x
, x
;
30101 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30102 /* If row extends face to end of line write the whole line. */
30103 draw_glyphs (w
, 0, row
, area
,
30104 0, row
->used
[area
],
30105 DRAW_NORMAL_TEXT
, 0);
30108 /* Set START_X to the window-relative start position for drawing glyphs of
30109 AREA. The first glyph of the text area can be partially visible.
30110 The first glyphs of other areas cannot. */
30111 start_x
= window_box_left_offset (w
, area
);
30113 if (area
== TEXT_AREA
)
30116 /* Find the first glyph that must be redrawn. */
30118 && x
+ first
->pixel_width
< r
->x
)
30120 x
+= first
->pixel_width
;
30124 /* Find the last one. */
30127 /* Use a signed int intermediate value to avoid catastrophic
30128 failures due to comparison between signed and unsigned, when
30129 x is negative (can happen for wide images that are hscrolled). */
30130 int r_end
= r
->x
+ r
->width
;
30131 while (last
< end
&& x
< r_end
)
30133 x
+= last
->pixel_width
;
30139 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30140 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30141 DRAW_NORMAL_TEXT
, 0);
30146 /* Redraw the parts of the glyph row ROW on window W intersecting
30147 rectangle R. R is in window-relative coordinates. Value is
30148 true if mouse-face was overwritten. */
30151 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30153 eassert (row
->enabled_p
);
30155 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30156 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30157 0, row
->used
[TEXT_AREA
],
30158 DRAW_NORMAL_TEXT
, 0);
30161 if (row
->used
[LEFT_MARGIN_AREA
])
30162 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30163 if (row
->used
[TEXT_AREA
])
30164 expose_area (w
, row
, r
, TEXT_AREA
);
30165 if (row
->used
[RIGHT_MARGIN_AREA
])
30166 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30167 draw_row_fringe_bitmaps (w
, row
);
30170 return row
->mouse_face_p
;
30174 /* Redraw those parts of glyphs rows during expose event handling that
30175 overlap other rows. Redrawing of an exposed line writes over parts
30176 of lines overlapping that exposed line; this function fixes that.
30178 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30179 row in W's current matrix that is exposed and overlaps other rows.
30180 LAST_OVERLAPPING_ROW is the last such row. */
30183 expose_overlaps (struct window
*w
,
30184 struct glyph_row
*first_overlapping_row
,
30185 struct glyph_row
*last_overlapping_row
,
30188 struct glyph_row
*row
;
30190 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30191 if (row
->overlapping_p
)
30193 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30196 if (row
->used
[LEFT_MARGIN_AREA
])
30197 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30199 if (row
->used
[TEXT_AREA
])
30200 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30202 if (row
->used
[RIGHT_MARGIN_AREA
])
30203 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30209 /* Return true if W's cursor intersects rectangle R. */
30212 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30214 XRectangle cr
, result
;
30215 struct glyph
*cursor_glyph
;
30216 struct glyph_row
*row
;
30218 if (w
->phys_cursor
.vpos
>= 0
30219 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30220 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30222 && row
->cursor_in_fringe_p
)
30224 /* Cursor is in the fringe. */
30225 cr
.x
= window_box_right_offset (w
,
30226 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30227 ? RIGHT_MARGIN_AREA
30230 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30231 cr
.height
= row
->height
;
30232 return x_intersect_rectangles (&cr
, r
, &result
);
30235 cursor_glyph
= get_phys_cursor_glyph (w
);
30238 /* r is relative to W's box, but w->phys_cursor.x is relative
30239 to left edge of W's TEXT area. Adjust it. */
30240 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30241 cr
.y
= w
->phys_cursor
.y
;
30242 cr
.width
= cursor_glyph
->pixel_width
;
30243 cr
.height
= w
->phys_cursor_height
;
30244 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30245 I assume the effect is the same -- and this is portable. */
30246 return x_intersect_rectangles (&cr
, r
, &result
);
30248 /* If we don't understand the format, pretend we're not in the hot-spot. */
30254 Draw a vertical window border to the right of window W if W doesn't
30255 have vertical scroll bars. */
30258 x_draw_vertical_border (struct window
*w
)
30260 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30262 /* We could do better, if we knew what type of scroll-bar the adjacent
30263 windows (on either side) have... But we don't :-(
30264 However, I think this works ok. ++KFS 2003-04-25 */
30266 /* Redraw borders between horizontally adjacent windows. Don't
30267 do it for frames with vertical scroll bars because either the
30268 right scroll bar of a window, or the left scroll bar of its
30269 neighbor will suffice as a border. */
30270 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30273 /* Note: It is necessary to redraw both the left and the right
30274 borders, for when only this single window W is being
30276 if (!WINDOW_RIGHTMOST_P (w
)
30277 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30279 int x0
, x1
, y0
, y1
;
30281 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30284 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30287 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30290 if (!WINDOW_LEFTMOST_P (w
)
30291 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30293 int x0
, x1
, y0
, y1
;
30295 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30298 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30301 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30306 /* Draw window dividers for window W. */
30309 x_draw_right_divider (struct window
*w
)
30311 struct frame
*f
= WINDOW_XFRAME (w
);
30313 if (w
->mini
|| w
->pseudo_window_p
)
30315 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30317 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30318 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30319 int y0
= WINDOW_TOP_EDGE_Y (w
);
30320 /* The bottom divider prevails. */
30321 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30323 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30328 x_draw_bottom_divider (struct window
*w
)
30330 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30332 if (w
->mini
|| w
->pseudo_window_p
)
30334 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30336 int x0
= WINDOW_LEFT_EDGE_X (w
);
30337 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30338 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30339 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30341 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30345 /* Redraw the part of window W intersection rectangle FR. Pixel
30346 coordinates in FR are frame-relative. Call this function with
30347 input blocked. Value is true if the exposure overwrites
30351 expose_window (struct window
*w
, XRectangle
*fr
)
30353 struct frame
*f
= XFRAME (w
->frame
);
30355 bool mouse_face_overwritten_p
= false;
30357 /* If window is not yet fully initialized, do nothing. This can
30358 happen when toolkit scroll bars are used and a window is split.
30359 Reconfiguring the scroll bar will generate an expose for a newly
30361 if (w
->current_matrix
== NULL
)
30364 /* When we're currently updating the window, display and current
30365 matrix usually don't agree. Arrange for a thorough display
30367 if (w
->must_be_updated_p
)
30369 SET_FRAME_GARBAGED (f
);
30373 /* Frame-relative pixel rectangle of W. */
30374 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30375 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30376 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30377 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30379 if (x_intersect_rectangles (fr
, &wr
, &r
))
30381 int yb
= window_text_bottom_y (w
);
30382 struct glyph_row
*row
;
30383 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30385 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30386 r
.x
, r
.y
, r
.width
, r
.height
));
30388 /* Convert to window coordinates. */
30389 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30390 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30392 /* Turn off the cursor. */
30393 bool cursor_cleared_p
= (!w
->pseudo_window_p
30394 && phys_cursor_in_rect_p (w
, &r
));
30395 if (cursor_cleared_p
)
30396 x_clear_cursor (w
);
30398 /* If the row containing the cursor extends face to end of line,
30399 then expose_area might overwrite the cursor outside the
30400 rectangle and thus notice_overwritten_cursor might clear
30401 w->phys_cursor_on_p. We remember the original value and
30402 check later if it is changed. */
30403 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30405 /* Use a signed int intermediate value to avoid catastrophic
30406 failures due to comparison between signed and unsigned, when
30407 y0 or y1 is negative (can happen for tall images). */
30408 int r_bottom
= r
.y
+ r
.height
;
30410 /* Update lines intersecting rectangle R. */
30411 first_overlapping_row
= last_overlapping_row
= NULL
;
30412 for (row
= w
->current_matrix
->rows
;
30417 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30419 if ((y0
>= r
.y
&& y0
< r_bottom
)
30420 || (y1
> r
.y
&& y1
< r_bottom
)
30421 || (r
.y
>= y0
&& r
.y
< y1
)
30422 || (r_bottom
> y0
&& r_bottom
< y1
))
30424 /* A header line may be overlapping, but there is no need
30425 to fix overlapping areas for them. KFS 2005-02-12 */
30426 if (row
->overlapping_p
&& !row
->mode_line_p
)
30428 if (first_overlapping_row
== NULL
)
30429 first_overlapping_row
= row
;
30430 last_overlapping_row
= row
;
30434 if (expose_line (w
, row
, &r
))
30435 mouse_face_overwritten_p
= true;
30438 else if (row
->overlapping_p
)
30440 /* We must redraw a row overlapping the exposed area. */
30442 ? y0
+ row
->phys_height
> r
.y
30443 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30445 if (first_overlapping_row
== NULL
)
30446 first_overlapping_row
= row
;
30447 last_overlapping_row
= row
;
30455 /* Display the mode line if there is one. */
30456 if (WINDOW_WANTS_MODELINE_P (w
)
30457 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30459 && row
->y
< r_bottom
)
30461 if (expose_line (w
, row
, &r
))
30462 mouse_face_overwritten_p
= true;
30465 if (!w
->pseudo_window_p
)
30467 /* Fix the display of overlapping rows. */
30468 if (first_overlapping_row
)
30469 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30472 /* Draw border between windows. */
30473 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30474 x_draw_right_divider (w
);
30476 x_draw_vertical_border (w
);
30478 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30479 x_draw_bottom_divider (w
);
30481 /* Turn the cursor on again. */
30482 if (cursor_cleared_p
30483 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30484 update_window_cursor (w
, true);
30488 return mouse_face_overwritten_p
;
30493 /* Redraw (parts) of all windows in the window tree rooted at W that
30494 intersect R. R contains frame pixel coordinates. Value is
30495 true if the exposure overwrites mouse-face. */
30498 expose_window_tree (struct window
*w
, XRectangle
*r
)
30500 struct frame
*f
= XFRAME (w
->frame
);
30501 bool mouse_face_overwritten_p
= false;
30503 while (w
&& !FRAME_GARBAGED_P (f
))
30505 mouse_face_overwritten_p
30506 |= (WINDOWP (w
->contents
)
30507 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30508 : expose_window (w
, r
));
30510 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30513 return mouse_face_overwritten_p
;
30518 Redisplay an exposed area of frame F. X and Y are the upper-left
30519 corner of the exposed rectangle. W and H are width and height of
30520 the exposed area. All are pixel values. W or H zero means redraw
30521 the entire frame. */
30524 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30527 bool mouse_face_overwritten_p
= false;
30529 TRACE ((stderr
, "expose_frame "));
30531 /* No need to redraw if frame will be redrawn soon. */
30532 if (FRAME_GARBAGED_P (f
))
30534 TRACE ((stderr
, " garbaged\n"));
30538 /* If basic faces haven't been realized yet, there is no point in
30539 trying to redraw anything. This can happen when we get an expose
30540 event while Emacs is starting, e.g. by moving another window. */
30541 if (FRAME_FACE_CACHE (f
) == NULL
30542 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30544 TRACE ((stderr
, " no faces\n"));
30548 if (w
== 0 || h
== 0)
30551 r
.width
= FRAME_TEXT_WIDTH (f
);
30552 r
.height
= FRAME_TEXT_HEIGHT (f
);
30562 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30563 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30565 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30566 if (WINDOWP (f
->tool_bar_window
))
30567 mouse_face_overwritten_p
30568 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30571 #ifdef HAVE_X_WINDOWS
30573 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30574 if (WINDOWP (f
->menu_bar_window
))
30575 mouse_face_overwritten_p
30576 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30577 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30581 /* Some window managers support a focus-follows-mouse style with
30582 delayed raising of frames. Imagine a partially obscured frame,
30583 and moving the mouse into partially obscured mouse-face on that
30584 frame. The visible part of the mouse-face will be highlighted,
30585 then the WM raises the obscured frame. With at least one WM, KDE
30586 2.1, Emacs is not getting any event for the raising of the frame
30587 (even tried with SubstructureRedirectMask), only Expose events.
30588 These expose events will draw text normally, i.e. not
30589 highlighted. Which means we must redo the highlight here.
30590 Subsume it under ``we love X''. --gerd 2001-08-15 */
30591 /* Included in Windows version because Windows most likely does not
30592 do the right thing if any third party tool offers
30593 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30594 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30596 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30597 if (f
== hlinfo
->mouse_face_mouse_frame
)
30599 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30600 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30601 clear_mouse_face (hlinfo
);
30602 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30609 Determine the intersection of two rectangles R1 and R2. Return
30610 the intersection in *RESULT. Value is true if RESULT is not
30614 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30616 XRectangle
*left
, *right
;
30617 XRectangle
*upper
, *lower
;
30618 bool intersection_p
= false;
30620 /* Rearrange so that R1 is the left-most rectangle. */
30622 left
= r1
, right
= r2
;
30624 left
= r2
, right
= r1
;
30626 /* X0 of the intersection is right.x0, if this is inside R1,
30627 otherwise there is no intersection. */
30628 if (right
->x
<= left
->x
+ left
->width
)
30630 result
->x
= right
->x
;
30632 /* The right end of the intersection is the minimum of
30633 the right ends of left and right. */
30634 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30637 /* Same game for Y. */
30639 upper
= r1
, lower
= r2
;
30641 upper
= r2
, lower
= r1
;
30643 /* The upper end of the intersection is lower.y0, if this is inside
30644 of upper. Otherwise, there is no intersection. */
30645 if (lower
->y
<= upper
->y
+ upper
->height
)
30647 result
->y
= lower
->y
;
30649 /* The lower end of the intersection is the minimum of the lower
30650 ends of upper and lower. */
30651 result
->height
= (min (lower
->y
+ lower
->height
,
30652 upper
->y
+ upper
->height
)
30654 intersection_p
= true;
30658 return intersection_p
;
30661 #endif /* HAVE_WINDOW_SYSTEM */
30664 /***********************************************************************
30666 ***********************************************************************/
30669 syms_of_xdisp (void)
30671 Vwith_echo_area_save_vector
= Qnil
;
30672 staticpro (&Vwith_echo_area_save_vector
);
30674 Vmessage_stack
= Qnil
;
30675 staticpro (&Vmessage_stack
);
30677 /* Non-nil means don't actually do any redisplay. */
30678 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30680 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30682 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30683 doc
: /* Non-nil means calls to `message' are not displayed.
30684 They are still logged to the *Messages* buffer. */);
30685 inhibit_message
= 0;
30687 message_dolog_marker1
= Fmake_marker ();
30688 staticpro (&message_dolog_marker1
);
30689 message_dolog_marker2
= Fmake_marker ();
30690 staticpro (&message_dolog_marker2
);
30691 message_dolog_marker3
= Fmake_marker ();
30692 staticpro (&message_dolog_marker3
);
30695 defsubr (&Sdump_frame_glyph_matrix
);
30696 defsubr (&Sdump_glyph_matrix
);
30697 defsubr (&Sdump_glyph_row
);
30698 defsubr (&Sdump_tool_bar_row
);
30699 defsubr (&Strace_redisplay
);
30700 defsubr (&Strace_to_stderr
);
30702 #ifdef HAVE_WINDOW_SYSTEM
30703 defsubr (&Stool_bar_height
);
30704 defsubr (&Slookup_image_map
);
30706 defsubr (&Sline_pixel_height
);
30707 defsubr (&Sformat_mode_line
);
30708 defsubr (&Sinvisible_p
);
30709 defsubr (&Scurrent_bidi_paragraph_direction
);
30710 defsubr (&Swindow_text_pixel_size
);
30711 defsubr (&Smove_point_visually
);
30712 defsubr (&Sbidi_find_overridden_directionality
);
30714 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30715 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30716 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30717 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30718 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30719 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30720 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30721 DEFSYM (Qeval
, "eval");
30722 DEFSYM (QCdata
, ":data");
30724 /* Names of text properties relevant for redisplay. */
30725 DEFSYM (Qdisplay
, "display");
30726 DEFSYM (Qspace_width
, "space-width");
30727 DEFSYM (Qraise
, "raise");
30728 DEFSYM (Qslice
, "slice");
30729 DEFSYM (Qspace
, "space");
30730 DEFSYM (Qmargin
, "margin");
30731 DEFSYM (Qpointer
, "pointer");
30732 DEFSYM (Qleft_margin
, "left-margin");
30733 DEFSYM (Qright_margin
, "right-margin");
30734 DEFSYM (Qcenter
, "center");
30735 DEFSYM (Qline_height
, "line-height");
30736 DEFSYM (QCalign_to
, ":align-to");
30737 DEFSYM (QCrelative_width
, ":relative-width");
30738 DEFSYM (QCrelative_height
, ":relative-height");
30739 DEFSYM (QCeval
, ":eval");
30740 DEFSYM (QCpropertize
, ":propertize");
30741 DEFSYM (QCfile
, ":file");
30742 DEFSYM (Qfontified
, "fontified");
30743 DEFSYM (Qfontification_functions
, "fontification-functions");
30745 /* Name of the face used to highlight trailing whitespace. */
30746 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30748 /* Name and number of the face used to highlight escape glyphs. */
30749 DEFSYM (Qescape_glyph
, "escape-glyph");
30751 /* Name and number of the face used to highlight non-breaking spaces. */
30752 DEFSYM (Qnobreak_space
, "nobreak-space");
30754 /* The symbol 'image' which is the car of the lists used to represent
30755 images in Lisp. Also a tool bar style. */
30756 DEFSYM (Qimage
, "image");
30758 /* Tool bar styles. */
30759 DEFSYM (Qtext
, "text");
30760 DEFSYM (Qboth
, "both");
30761 DEFSYM (Qboth_horiz
, "both-horiz");
30762 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30764 /* The image map types. */
30765 DEFSYM (QCmap
, ":map");
30766 DEFSYM (QCpointer
, ":pointer");
30767 DEFSYM (Qrect
, "rect");
30768 DEFSYM (Qcircle
, "circle");
30769 DEFSYM (Qpoly
, "poly");
30771 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30773 DEFSYM (Qgrow_only
, "grow-only");
30774 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30775 DEFSYM (Qposition
, "position");
30776 DEFSYM (Qbuffer_position
, "buffer-position");
30777 DEFSYM (Qobject
, "object");
30779 /* Cursor shapes. */
30780 DEFSYM (Qbar
, "bar");
30781 DEFSYM (Qhbar
, "hbar");
30782 DEFSYM (Qbox
, "box");
30783 DEFSYM (Qhollow
, "hollow");
30785 /* Pointer shapes. */
30786 DEFSYM (Qhand
, "hand");
30787 DEFSYM (Qarrow
, "arrow");
30790 DEFSYM (Qdragging
, "dragging");
30792 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30794 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30795 staticpro (&list_of_error
);
30797 /* Values of those variables at last redisplay are stored as
30798 properties on 'overlay-arrow-position' symbol. However, if
30799 Voverlay_arrow_position is a marker, last-arrow-position is its
30800 numerical position. */
30801 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30802 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30804 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30805 properties on a symbol in overlay-arrow-variable-list. */
30806 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30807 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30809 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30810 staticpro (&echo_buffer
[0]);
30811 staticpro (&echo_buffer
[1]);
30813 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30814 staticpro (&echo_area_buffer
[0]);
30815 staticpro (&echo_area_buffer
[1]);
30817 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30818 staticpro (&Vmessages_buffer_name
);
30820 mode_line_proptrans_alist
= Qnil
;
30821 staticpro (&mode_line_proptrans_alist
);
30822 mode_line_string_list
= Qnil
;
30823 staticpro (&mode_line_string_list
);
30824 mode_line_string_face
= Qnil
;
30825 staticpro (&mode_line_string_face
);
30826 mode_line_string_face_prop
= Qnil
;
30827 staticpro (&mode_line_string_face_prop
);
30828 Vmode_line_unwind_vector
= Qnil
;
30829 staticpro (&Vmode_line_unwind_vector
);
30831 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30833 help_echo_string
= Qnil
;
30834 staticpro (&help_echo_string
);
30835 help_echo_object
= Qnil
;
30836 staticpro (&help_echo_object
);
30837 help_echo_window
= Qnil
;
30838 staticpro (&help_echo_window
);
30839 previous_help_echo_string
= Qnil
;
30840 staticpro (&previous_help_echo_string
);
30841 help_echo_pos
= -1;
30843 DEFSYM (Qright_to_left
, "right-to-left");
30844 DEFSYM (Qleft_to_right
, "left-to-right");
30845 defsubr (&Sbidi_resolved_levels
);
30847 #ifdef HAVE_WINDOW_SYSTEM
30848 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30849 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30850 For example, if a block cursor is over a tab, it will be drawn as
30851 wide as that tab on the display. */);
30852 x_stretch_cursor_p
= 0;
30855 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30856 doc
: /* Non-nil means highlight trailing whitespace.
30857 The face used for trailing whitespace is `trailing-whitespace'. */);
30858 Vshow_trailing_whitespace
= Qnil
;
30860 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30861 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30862 If the value is t, Emacs highlights non-ASCII chars which have the
30863 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30864 or `escape-glyph' face respectively.
30866 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30867 U+2011 (non-breaking hyphen) are affected.
30869 Any other non-nil value means to display these characters as a escape
30870 glyph followed by an ordinary space or hyphen.
30872 A value of nil means no special handling of these characters. */);
30873 Vnobreak_char_display
= Qt
;
30875 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30876 doc
: /* The pointer shape to show in void text areas.
30877 A value of nil means to show the text pointer. Other options are
30878 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30880 Vvoid_text_area_pointer
= Qarrow
;
30882 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30883 doc
: /* Non-nil means don't actually do any redisplay.
30884 This is used for internal purposes. */);
30885 Vinhibit_redisplay
= Qnil
;
30887 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30888 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30889 Vglobal_mode_string
= Qnil
;
30891 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30892 doc
: /* Marker for where to display an arrow on top of the buffer text.
30893 This must be the beginning of a line in order to work.
30894 See also `overlay-arrow-string'. */);
30895 Voverlay_arrow_position
= Qnil
;
30897 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30898 doc
: /* String to display as an arrow in non-window frames.
30899 See also `overlay-arrow-position'. */);
30900 Voverlay_arrow_string
= build_pure_c_string ("=>");
30902 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30903 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30904 The symbols on this list are examined during redisplay to determine
30905 where to display overlay arrows. */);
30906 Voverlay_arrow_variable_list
30907 = list1 (intern_c_string ("overlay-arrow-position"));
30909 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30910 doc
: /* The number of lines to try scrolling a window by when point moves out.
30911 If that fails to bring point back on frame, point is centered instead.
30912 If this is zero, point is always centered after it moves off frame.
30913 If you want scrolling to always be a line at a time, you should set
30914 `scroll-conservatively' to a large value rather than set this to 1. */);
30916 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30917 doc
: /* Scroll up to this many lines, to bring point back on screen.
30918 If point moves off-screen, redisplay will scroll by up to
30919 `scroll-conservatively' lines in order to bring point just barely
30920 onto the screen again. If that cannot be done, then redisplay
30921 recenters point as usual.
30923 If the value is greater than 100, redisplay will never recenter point,
30924 but will always scroll just enough text to bring point into view, even
30925 if you move far away.
30927 A value of zero means always recenter point if it moves off screen. */);
30928 scroll_conservatively
= 0;
30930 DEFVAR_INT ("scroll-margin", scroll_margin
,
30931 doc
: /* Number of lines of margin at the top and bottom of a window.
30932 Recenter the window whenever point gets within this many lines
30933 of the top or bottom of the window. */);
30936 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30937 doc
: /* Pixels per inch value for non-window system displays.
30938 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30939 Vdisplay_pixels_per_inch
= make_float (72.0);
30942 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30945 DEFVAR_LISP ("truncate-partial-width-windows",
30946 Vtruncate_partial_width_windows
,
30947 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30948 For an integer value, truncate lines in each window narrower than the
30949 full frame width, provided the window width is less than that integer;
30950 otherwise, respect the value of `truncate-lines'.
30952 For any other non-nil value, truncate lines in all windows that do
30953 not span the full frame width.
30955 A value of nil means to respect the value of `truncate-lines'.
30957 If `word-wrap' is enabled, you might want to reduce this. */);
30958 Vtruncate_partial_width_windows
= make_number (50);
30960 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30961 doc
: /* Maximum buffer size for which line number should be displayed.
30962 If the buffer is bigger than this, the line number does not appear
30963 in the mode line. A value of nil means no limit. */);
30964 Vline_number_display_limit
= Qnil
;
30966 DEFVAR_INT ("line-number-display-limit-width",
30967 line_number_display_limit_width
,
30968 doc
: /* Maximum line width (in characters) for line number display.
30969 If the average length of the lines near point is bigger than this, then the
30970 line number may be omitted from the mode line. */);
30971 line_number_display_limit_width
= 200;
30973 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30974 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30975 highlight_nonselected_windows
= false;
30977 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30978 doc
: /* Non-nil if more than one frame is visible on this display.
30979 Minibuffer-only frames don't count, but iconified frames do.
30980 This variable is not guaranteed to be accurate except while processing
30981 `frame-title-format' and `icon-title-format'. */);
30983 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30984 doc
: /* Template for displaying the title bar of visible frames.
30985 \(Assuming the window manager supports this feature.)
30987 This variable has the same structure as `mode-line-format', except that
30988 the %c and %l constructs are ignored. It is used only on frames for
30989 which no explicit name has been set \(see `modify-frame-parameters'). */);
30991 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30992 doc
: /* Template for displaying the title bar of an iconified frame.
30993 \(Assuming the window manager supports this feature.)
30994 This variable has the same structure as `mode-line-format' (which see),
30995 and is used only on frames for which no explicit name has been set
30996 \(see `modify-frame-parameters'). */);
30998 = Vframe_title_format
30999 = listn (CONSTYPE_PURE
, 3,
31000 intern_c_string ("multiple-frames"),
31001 build_pure_c_string ("%b"),
31002 listn (CONSTYPE_PURE
, 4,
31003 empty_unibyte_string
,
31004 intern_c_string ("invocation-name"),
31005 build_pure_c_string ("@"),
31006 intern_c_string ("system-name")));
31008 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31009 doc
: /* Maximum number of lines to keep in the message log buffer.
31010 If nil, disable message logging. If t, log messages but don't truncate
31011 the buffer when it becomes large. */);
31012 Vmessage_log_max
= make_number (1000);
31014 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31015 doc
: /* Functions called before redisplay, if window sizes have changed.
31016 The value should be a list of functions that take one argument.
31017 Just before redisplay, for each frame, if any of its windows have changed
31018 size since the last redisplay, or have been split or deleted,
31019 all the functions in the list are called, with the frame as argument. */);
31020 Vwindow_size_change_functions
= Qnil
;
31022 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31023 doc
: /* List of functions to call before redisplaying a window with scrolling.
31024 Each function is called with two arguments, the window and its new
31025 display-start position.
31026 These functions are called whenever the `window-start' marker is modified,
31027 either to point into another buffer (e.g. via `set-window-buffer') or another
31028 place in the same buffer.
31029 Note that the value of `window-end' is not valid when these functions are
31032 Warning: Do not use this feature to alter the way the window
31033 is scrolled. It is not designed for that, and such use probably won't
31035 Vwindow_scroll_functions
= Qnil
;
31037 DEFVAR_LISP ("window-text-change-functions",
31038 Vwindow_text_change_functions
,
31039 doc
: /* Functions to call in redisplay when text in the window might change. */);
31040 Vwindow_text_change_functions
= Qnil
;
31042 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31043 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31044 Each function is called with two arguments, the window and the end trigger value.
31045 See `set-window-redisplay-end-trigger'. */);
31046 Vredisplay_end_trigger_functions
= Qnil
;
31048 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31049 doc
: /* Non-nil means autoselect window with mouse pointer.
31050 If nil, do not autoselect windows.
31051 A positive number means delay autoselection by that many seconds: a
31052 window is autoselected only after the mouse has remained in that
31053 window for the duration of the delay.
31054 A negative number has a similar effect, but causes windows to be
31055 autoselected only after the mouse has stopped moving. \(Because of
31056 the way Emacs compares mouse events, you will occasionally wait twice
31057 that time before the window gets selected.\)
31058 Any other value means to autoselect window instantaneously when the
31059 mouse pointer enters it.
31061 Autoselection selects the minibuffer only if it is active, and never
31062 unselects the minibuffer if it is active.
31064 When customizing this variable make sure that the actual value of
31065 `focus-follows-mouse' matches the behavior of your window manager. */);
31066 Vmouse_autoselect_window
= Qnil
;
31068 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31069 doc
: /* Non-nil means automatically resize tool-bars.
31070 This dynamically changes the tool-bar's height to the minimum height
31071 that is needed to make all tool-bar items visible.
31072 If value is `grow-only', the tool-bar's height is only increased
31073 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31074 Vauto_resize_tool_bars
= Qt
;
31076 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31077 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31078 auto_raise_tool_bar_buttons_p
= true;
31080 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31081 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31082 make_cursor_line_fully_visible_p
= true;
31084 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31085 doc
: /* Border below tool-bar in pixels.
31086 If an integer, use it as the height of the border.
31087 If it is one of `internal-border-width' or `border-width', use the
31088 value of the corresponding frame parameter.
31089 Otherwise, no border is added below the tool-bar. */);
31090 Vtool_bar_border
= Qinternal_border_width
;
31092 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31093 doc
: /* Margin around tool-bar buttons in pixels.
31094 If an integer, use that for both horizontal and vertical margins.
31095 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31096 HORZ specifying the horizontal margin, and VERT specifying the
31097 vertical margin. */);
31098 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31100 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31101 doc
: /* Relief thickness of tool-bar buttons. */);
31102 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31104 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31105 doc
: /* Tool bar style to use.
31107 image - show images only
31108 text - show text only
31109 both - show both, text below image
31110 both-horiz - show text to the right of the image
31111 text-image-horiz - show text to the left of the image
31112 any other - use system default or image if no system default.
31114 This variable only affects the GTK+ toolkit version of Emacs. */);
31115 Vtool_bar_style
= Qnil
;
31117 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31118 doc
: /* Maximum number of characters a label can have to be shown.
31119 The tool bar style must also show labels for this to have any effect, see
31120 `tool-bar-style'. */);
31121 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31123 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31124 doc
: /* List of functions to call to fontify regions of text.
31125 Each function is called with one argument POS. Functions must
31126 fontify a region starting at POS in the current buffer, and give
31127 fontified regions the property `fontified'. */);
31128 Vfontification_functions
= Qnil
;
31129 Fmake_variable_buffer_local (Qfontification_functions
);
31131 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31132 unibyte_display_via_language_environment
,
31133 doc
: /* Non-nil means display unibyte text according to language environment.
31134 Specifically, this means that raw bytes in the range 160-255 decimal
31135 are displayed by converting them to the equivalent multibyte characters
31136 according to the current language environment. As a result, they are
31137 displayed according to the current fontset.
31139 Note that this variable affects only how these bytes are displayed,
31140 but does not change the fact they are interpreted as raw bytes. */);
31141 unibyte_display_via_language_environment
= false;
31143 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31144 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31145 If a float, it specifies a fraction of the mini-window frame's height.
31146 If an integer, it specifies a number of lines. */);
31147 Vmax_mini_window_height
= make_float (0.25);
31149 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31150 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31151 A value of nil means don't automatically resize mini-windows.
31152 A value of t means resize them to fit the text displayed in them.
31153 A value of `grow-only', the default, means let mini-windows grow only;
31154 they return to their normal size when the minibuffer is closed, or the
31155 echo area becomes empty. */);
31156 Vresize_mini_windows
= Qgrow_only
;
31158 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31159 doc
: /* Alist specifying how to blink the cursor off.
31160 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31161 `cursor-type' frame-parameter or variable equals ON-STATE,
31162 comparing using `equal', Emacs uses OFF-STATE to specify
31163 how to blink it off. ON-STATE and OFF-STATE are values for
31164 the `cursor-type' frame parameter.
31166 If a frame's ON-STATE has no entry in this list,
31167 the frame's other specifications determine how to blink the cursor off. */);
31168 Vblink_cursor_alist
= Qnil
;
31170 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31171 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31172 If non-nil, windows are automatically scrolled horizontally to make
31173 point visible. */);
31174 automatic_hscrolling_p
= true;
31175 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31177 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31178 doc
: /* How many columns away from the window edge point is allowed to get
31179 before automatic hscrolling will horizontally scroll the window. */);
31180 hscroll_margin
= 5;
31182 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31183 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31184 When point is less than `hscroll-margin' columns from the window
31185 edge, automatic hscrolling will scroll the window by the amount of columns
31186 determined by this variable. If its value is a positive integer, scroll that
31187 many columns. If it's a positive floating-point number, it specifies the
31188 fraction of the window's width to scroll. If it's nil or zero, point will be
31189 centered horizontally after the scroll. Any other value, including negative
31190 numbers, are treated as if the value were zero.
31192 Automatic hscrolling always moves point outside the scroll margin, so if
31193 point was more than scroll step columns inside the margin, the window will
31194 scroll more than the value given by the scroll step.
31196 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31197 and `scroll-right' overrides this variable's effect. */);
31198 Vhscroll_step
= make_number (0);
31200 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31201 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31202 Bind this around calls to `message' to let it take effect. */);
31203 message_truncate_lines
= false;
31205 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31206 doc
: /* Normal hook run to update the menu bar definitions.
31207 Redisplay runs this hook before it redisplays the menu bar.
31208 This is used to update menus such as Buffers, whose contents depend on
31210 Vmenu_bar_update_hook
= Qnil
;
31212 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31213 doc
: /* Frame for which we are updating a menu.
31214 The enable predicate for a menu binding should check this variable. */);
31215 Vmenu_updating_frame
= Qnil
;
31217 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31218 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31219 inhibit_menubar_update
= false;
31221 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31222 doc
: /* Prefix prepended to all continuation lines at display time.
31223 The value may be a string, an image, or a stretch-glyph; it is
31224 interpreted in the same way as the value of a `display' text property.
31226 This variable is overridden by any `wrap-prefix' text or overlay
31229 To add a prefix to non-continuation lines, use `line-prefix'. */);
31230 Vwrap_prefix
= Qnil
;
31231 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31232 Fmake_variable_buffer_local (Qwrap_prefix
);
31234 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31235 doc
: /* Prefix prepended to all non-continuation lines at display time.
31236 The value may be a string, an image, or a stretch-glyph; it is
31237 interpreted in the same way as the value of a `display' text property.
31239 This variable is overridden by any `line-prefix' text or overlay
31242 To add a prefix to continuation lines, use `wrap-prefix'. */);
31243 Vline_prefix
= Qnil
;
31244 DEFSYM (Qline_prefix
, "line-prefix");
31245 Fmake_variable_buffer_local (Qline_prefix
);
31247 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31248 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31249 inhibit_eval_during_redisplay
= false;
31251 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31252 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31253 inhibit_free_realized_faces
= false;
31255 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31256 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31257 Intended for use during debugging and for testing bidi display;
31258 see biditest.el in the test suite. */);
31259 inhibit_bidi_mirroring
= false;
31262 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31263 doc
: /* Inhibit try_window_id display optimization. */);
31264 inhibit_try_window_id
= false;
31266 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31267 doc
: /* Inhibit try_window_reusing display optimization. */);
31268 inhibit_try_window_reusing
= false;
31270 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31271 doc
: /* Inhibit try_cursor_movement display optimization. */);
31272 inhibit_try_cursor_movement
= false;
31273 #endif /* GLYPH_DEBUG */
31275 DEFVAR_INT ("overline-margin", overline_margin
,
31276 doc
: /* Space between overline and text, in pixels.
31277 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31278 margin to the character height. */);
31279 overline_margin
= 2;
31281 DEFVAR_INT ("underline-minimum-offset",
31282 underline_minimum_offset
,
31283 doc
: /* Minimum distance between baseline and underline.
31284 This can improve legibility of underlined text at small font sizes,
31285 particularly when using variable `x-use-underline-position-properties'
31286 with fonts that specify an UNDERLINE_POSITION relatively close to the
31287 baseline. The default value is 1. */);
31288 underline_minimum_offset
= 1;
31290 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31291 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31292 This feature only works when on a window system that can change
31293 cursor shapes. */);
31294 display_hourglass_p
= true;
31296 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31297 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31298 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31300 #ifdef HAVE_WINDOW_SYSTEM
31301 hourglass_atimer
= NULL
;
31302 hourglass_shown_p
= false;
31303 #endif /* HAVE_WINDOW_SYSTEM */
31305 /* Name of the face used to display glyphless characters. */
31306 DEFSYM (Qglyphless_char
, "glyphless-char");
31308 /* Method symbols for Vglyphless_char_display. */
31309 DEFSYM (Qhex_code
, "hex-code");
31310 DEFSYM (Qempty_box
, "empty-box");
31311 DEFSYM (Qthin_space
, "thin-space");
31312 DEFSYM (Qzero_width
, "zero-width");
31314 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31315 doc
: /* Function run just before redisplay.
31316 It is called with one argument, which is the set of windows that are to
31317 be redisplayed. This set can be nil (meaning, only the selected window),
31318 or t (meaning all windows). */);
31319 Vpre_redisplay_function
= intern ("ignore");
31321 /* Symbol for the purpose of Vglyphless_char_display. */
31322 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31323 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31325 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31326 doc
: /* Char-table defining glyphless characters.
31327 Each element, if non-nil, should be one of the following:
31328 an ASCII acronym string: display this string in a box
31329 `hex-code': display the hexadecimal code of a character in a box
31330 `empty-box': display as an empty box
31331 `thin-space': display as 1-pixel width space
31332 `zero-width': don't display
31333 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31334 display method for graphical terminals and text terminals respectively.
31335 GRAPHICAL and TEXT should each have one of the values listed above.
31337 The char-table has one extra slot to control the display of a character for
31338 which no font is found. This slot only takes effect on graphical terminals.
31339 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31340 `thin-space'. The default is `empty-box'.
31342 If a character has a non-nil entry in an active display table, the
31343 display table takes effect; in this case, Emacs does not consult
31344 `glyphless-char-display' at all. */);
31345 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31346 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31349 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31350 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31351 Vdebug_on_message
= Qnil
;
31353 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31355 Vredisplay__all_windows_cause
31356 = Fmake_vector (make_number (100), make_number (0));
31358 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31360 Vredisplay__mode_lines_cause
31361 = Fmake_vector (make_number (100), make_number (0));
31365 /* Initialize this module when Emacs starts. */
31370 CHARPOS (this_line_start_pos
) = 0;
31372 if (!noninteractive
)
31374 struct window
*m
= XWINDOW (minibuf_window
);
31375 Lisp_Object frame
= m
->frame
;
31376 struct frame
*f
= XFRAME (frame
);
31377 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31378 struct window
*r
= XWINDOW (root
);
31381 echo_area_window
= minibuf_window
;
31383 r
->top_line
= FRAME_TOP_MARGIN (f
);
31384 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31385 r
->total_cols
= FRAME_COLS (f
);
31386 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31387 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31388 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31390 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31391 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31392 m
->total_cols
= FRAME_COLS (f
);
31393 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31394 m
->total_lines
= 1;
31395 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31397 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31398 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31399 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31401 /* The default ellipsis glyphs `...'. */
31402 for (i
= 0; i
< 3; ++i
)
31403 default_invis_vector
[i
] = make_number ('.');
31407 /* Allocate the buffer for frame titles.
31408 Also used for `format-mode-line'. */
31410 mode_line_noprop_buf
= xmalloc (size
);
31411 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31412 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31413 mode_line_target
= MODE_LINE_DISPLAY
;
31416 help_echo_showing_p
= false;
31419 #ifdef HAVE_WINDOW_SYSTEM
31421 /* Platform-independent portion of hourglass implementation. */
31423 /* Timer function of hourglass_atimer. */
31426 show_hourglass (struct atimer
*timer
)
31428 /* The timer implementation will cancel this timer automatically
31429 after this function has run. Set hourglass_atimer to null
31430 so that we know the timer doesn't have to be canceled. */
31431 hourglass_atimer
= NULL
;
31433 if (!hourglass_shown_p
)
31435 Lisp_Object tail
, frame
;
31439 FOR_EACH_FRAME (tail
, frame
)
31441 struct frame
*f
= XFRAME (frame
);
31443 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31444 && FRAME_RIF (f
)->show_hourglass
)
31445 FRAME_RIF (f
)->show_hourglass (f
);
31448 hourglass_shown_p
= true;
31453 /* Cancel a currently active hourglass timer, and start a new one. */
31456 start_hourglass (void)
31458 struct timespec delay
;
31460 cancel_hourglass ();
31462 if (INTEGERP (Vhourglass_delay
)
31463 && XINT (Vhourglass_delay
) > 0)
31464 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31465 TYPE_MAXIMUM (time_t)),
31467 else if (FLOATP (Vhourglass_delay
)
31468 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31469 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31471 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31473 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31474 show_hourglass
, NULL
);
31477 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31481 cancel_hourglass (void)
31483 if (hourglass_atimer
)
31485 cancel_atimer (hourglass_atimer
);
31486 hourglass_atimer
= NULL
;
31489 if (hourglass_shown_p
)
31491 Lisp_Object tail
, frame
;
31495 FOR_EACH_FRAME (tail
, frame
)
31497 struct frame
*f
= XFRAME (frame
);
31499 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31500 && FRAME_RIF (f
)->hide_hourglass
)
31501 FRAME_RIF (f
)->hide_hourglass (f
);
31503 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31504 else if (!FRAME_W32_P (f
))
31505 w32_arrow_cursor ();
31509 hourglass_shown_p
= false;
31514 #endif /* HAVE_WINDOW_SYSTEM */