1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 /* Holds the list (error). */
328 static Lisp_Object list_of_error
;
330 #ifdef HAVE_WINDOW_SYSTEM
332 /* Test if overflow newline into fringe. Called with iterator IT
333 at or past right window margin, and with IT->current_x set. */
335 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
336 (!NILP (Voverflow_newline_into_fringe) \
337 && FRAME_WINDOW_P ((IT)->f) \
338 && ((IT)->bidi_it.paragraph_dir == R2L \
339 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
340 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
341 && (IT)->current_x == (IT)->last_visible_x)
343 #else /* !HAVE_WINDOW_SYSTEM */
344 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
345 #endif /* HAVE_WINDOW_SYSTEM */
347 /* Test if the display element loaded in IT, or the underlying buffer
348 or string character, is a space or a TAB character. This is used
349 to determine where word wrapping can occur. */
351 #define IT_DISPLAYING_WHITESPACE(it) \
352 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
353 || ((STRINGP (it->string) \
354 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
355 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
357 && (it->s[IT_BYTEPOS (*it)] == ' ' \
358 || it->s[IT_BYTEPOS (*it)] == '\t')) \
359 || (IT_BYTEPOS (*it) < ZV_BYTE \
360 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
361 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
363 /* True means print newline to stdout before next mini-buffer message. */
365 bool noninteractive_need_newline
;
367 /* True means print newline to message log before next message. */
369 static bool message_log_need_newline
;
371 /* Three markers that message_dolog uses.
372 It could allocate them itself, but that causes trouble
373 in handling memory-full errors. */
374 static Lisp_Object message_dolog_marker1
;
375 static Lisp_Object message_dolog_marker2
;
376 static Lisp_Object message_dolog_marker3
;
378 /* The buffer position of the first character appearing entirely or
379 partially on the line of the selected window which contains the
380 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
381 redisplay optimization in redisplay_internal. */
383 static struct text_pos this_line_start_pos
;
385 /* Number of characters past the end of the line above, including the
386 terminating newline. */
388 static struct text_pos this_line_end_pos
;
390 /* The vertical positions and the height of this line. */
392 static int this_line_vpos
;
393 static int this_line_y
;
394 static int this_line_pixel_height
;
396 /* X position at which this display line starts. Usually zero;
397 negative if first character is partially visible. */
399 static int this_line_start_x
;
401 /* The smallest character position seen by move_it_* functions as they
402 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
403 hscrolled lines, see display_line. */
405 static struct text_pos this_line_min_pos
;
407 /* Buffer that this_line_.* variables are referring to. */
409 static struct buffer
*this_line_buffer
;
411 /* True if an overlay arrow has been displayed in this window. */
413 static bool overlay_arrow_seen
;
415 /* Vector containing glyphs for an ellipsis `...'. */
417 static Lisp_Object default_invis_vector
[3];
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 static Lisp_Object Vmessage_stack
;
432 /* True means multibyte characters were enabled when the echo area
433 message was specified. */
435 static bool message_enable_multibyte
;
437 /* Nonzero if we should redraw the mode lines on the next redisplay.
438 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
439 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
440 (the number used is then only used to track down the cause for this
443 int update_mode_lines
;
445 /* Nonzero if window sizes or contents other than selected-window have changed
446 since last redisplay that finished.
447 If it has value REDISPLAY_SOME, then only redisplay the windows where
448 the `redisplay' bit has been set. Otherwise, redisplay all windows
449 (the number used is then only used to track down the cause for this
452 int windows_or_buffers_changed
;
454 /* True after display_mode_line if %l was used and it displayed a
457 static bool line_number_displayed
;
459 /* The name of the *Messages* buffer, a string. */
461 static Lisp_Object Vmessages_buffer_name
;
463 /* Current, index 0, and last displayed echo area message. Either
464 buffers from echo_buffers, or nil to indicate no message. */
466 Lisp_Object echo_area_buffer
[2];
468 /* The buffers referenced from echo_area_buffer. */
470 static Lisp_Object echo_buffer
[2];
472 /* A vector saved used in with_area_buffer to reduce consing. */
474 static Lisp_Object Vwith_echo_area_save_vector
;
476 /* True means display_echo_area should display the last echo area
477 message again. Set by redisplay_preserve_echo_area. */
479 static bool display_last_displayed_message_p
;
481 /* True if echo area is being used by print; false if being used by
484 static bool message_buf_print
;
486 /* Set to true in clear_message to make redisplay_internal aware
487 of an emptied echo area. */
489 static bool message_cleared_p
;
491 /* A scratch glyph row with contents used for generating truncation
492 glyphs. Also used in direct_output_for_insert. */
494 #define MAX_SCRATCH_GLYPHS 100
495 static struct glyph_row scratch_glyph_row
;
496 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
498 /* Ascent and height of the last line processed by move_it_to. */
500 static int last_height
;
502 /* True if there's a help-echo in the echo area. */
504 bool help_echo_showing_p
;
506 /* The maximum distance to look ahead for text properties. Values
507 that are too small let us call compute_char_face and similar
508 functions too often which is expensive. Values that are too large
509 let us call compute_char_face and alike too often because we
510 might not be interested in text properties that far away. */
512 #define TEXT_PROP_DISTANCE_LIMIT 100
514 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
515 iterator state and later restore it. This is needed because the
516 bidi iterator on bidi.c keeps a stacked cache of its states, which
517 is really a singleton. When we use scratch iterator objects to
518 move around the buffer, we can cause the bidi cache to be pushed or
519 popped, and therefore we need to restore the cache state when we
520 return to the original iterator. */
521 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
524 bidi_unshelve_cache (CACHE, true); \
526 CACHE = bidi_shelve_cache (); \
529 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
531 if (pITORIG != pITCOPY) \
532 *(pITORIG) = *(pITCOPY); \
533 bidi_unshelve_cache (CACHE, false); \
537 /* Functions to mark elements as needing redisplay. */
538 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
541 redisplay_other_windows (void)
543 if (!windows_or_buffers_changed
)
544 windows_or_buffers_changed
= REDISPLAY_SOME
;
548 wset_redisplay (struct window
*w
)
550 /* Beware: selected_window can be nil during early stages. */
551 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
552 redisplay_other_windows ();
557 fset_redisplay (struct frame
*f
)
559 redisplay_other_windows ();
564 bset_redisplay (struct buffer
*b
)
566 int count
= buffer_window_count (b
);
569 /* ... it's visible in other window than selected, */
570 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
571 redisplay_other_windows ();
572 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
573 so that if we later set windows_or_buffers_changed, this buffer will
575 b
->text
->redisplay
= true;
580 bset_update_mode_line (struct buffer
*b
)
582 if (!update_mode_lines
)
583 update_mode_lines
= REDISPLAY_SOME
;
584 b
->text
->redisplay
= true;
589 /* True means print traces of redisplay if compiled with
590 GLYPH_DEBUG defined. */
592 bool trace_redisplay_p
;
594 #endif /* GLYPH_DEBUG */
596 #ifdef DEBUG_TRACE_MOVE
597 /* True means trace with TRACE_MOVE to stderr. */
598 static bool trace_move
;
600 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
602 #define TRACE_MOVE(x) (void) 0
605 /* Buffer being redisplayed -- for redisplay_window_error. */
607 static struct buffer
*displayed_buffer
;
609 /* Value returned from text property handlers (see below). */
614 HANDLED_RECOMPUTE_PROPS
,
615 HANDLED_OVERLAY_STRING_CONSUMED
,
619 /* A description of text properties that redisplay is interested
624 /* The symbol index of the name of the property. */
627 /* A unique index for the property. */
630 /* A handler function called to set up iterator IT from the property
631 at IT's current position. Value is used to steer handle_stop. */
632 enum prop_handled (*handler
) (struct it
*it
);
635 static enum prop_handled
handle_face_prop (struct it
*);
636 static enum prop_handled
handle_invisible_prop (struct it
*);
637 static enum prop_handled
handle_display_prop (struct it
*);
638 static enum prop_handled
handle_composition_prop (struct it
*);
639 static enum prop_handled
handle_overlay_change (struct it
*);
640 static enum prop_handled
handle_fontified_prop (struct it
*);
642 /* Properties handled by iterators. */
644 static struct props it_props
[] =
646 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
647 /* Handle `face' before `display' because some sub-properties of
648 `display' need to know the face. */
649 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
650 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
651 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
652 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
656 /* Value is the position described by X. If X is a marker, value is
657 the marker_position of X. Otherwise, value is X. */
659 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
661 /* Enumeration returned by some move_it_.* functions internally. */
665 /* Not used. Undefined value. */
668 /* Move ended at the requested buffer position or ZV. */
669 MOVE_POS_MATCH_OR_ZV
,
671 /* Move ended at the requested X pixel position. */
674 /* Move within a line ended at the end of a line that must be
678 /* Move within a line ended at the end of a line that would
679 be displayed truncated. */
682 /* Move within a line ended at a line end. */
686 /* This counter is used to clear the face cache every once in a while
687 in redisplay_internal. It is incremented for each redisplay.
688 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
691 #define CLEAR_FACE_CACHE_COUNT 500
692 static int clear_face_cache_count
;
694 /* Similarly for the image cache. */
696 #ifdef HAVE_WINDOW_SYSTEM
697 #define CLEAR_IMAGE_CACHE_COUNT 101
698 static int clear_image_cache_count
;
700 /* Null glyph slice */
701 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
704 /* True while redisplay_internal is in progress. */
708 /* If a string, XTread_socket generates an event to display that string.
709 (The display is done in read_char.) */
711 Lisp_Object help_echo_string
;
712 Lisp_Object help_echo_window
;
713 Lisp_Object help_echo_object
;
714 ptrdiff_t help_echo_pos
;
716 /* Temporary variable for XTread_socket. */
718 Lisp_Object previous_help_echo_string
;
720 /* Platform-independent portion of hourglass implementation. */
722 #ifdef HAVE_WINDOW_SYSTEM
724 /* True means an hourglass cursor is currently shown. */
725 static bool hourglass_shown_p
;
727 /* If non-null, an asynchronous timer that, when it expires, displays
728 an hourglass cursor on all frames. */
729 static struct atimer
*hourglass_atimer
;
731 #endif /* HAVE_WINDOW_SYSTEM */
733 /* Default number of seconds to wait before displaying an hourglass
735 #define DEFAULT_HOURGLASS_DELAY 1
737 #ifdef HAVE_WINDOW_SYSTEM
739 /* Default pixel width of `thin-space' display method. */
740 #define THIN_SPACE_WIDTH 1
742 #endif /* HAVE_WINDOW_SYSTEM */
744 /* Function prototypes. */
746 static void setup_for_ellipsis (struct it
*, int);
747 static void set_iterator_to_next (struct it
*, bool);
748 static void mark_window_display_accurate_1 (struct window
*, bool);
749 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
750 static bool cursor_row_p (struct glyph_row
*);
751 static int redisplay_mode_lines (Lisp_Object
, bool);
753 static void handle_line_prefix (struct it
*);
755 static void handle_stop_backwards (struct it
*, ptrdiff_t);
756 static void unwind_with_echo_area_buffer (Lisp_Object
);
757 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
758 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
759 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
760 static void set_message (Lisp_Object
);
761 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
762 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
763 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
764 static void unwind_redisplay (void);
765 static void extend_face_to_end_of_line (struct it
*);
766 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
767 static void push_it (struct it
*, struct text_pos
*);
768 static void iterate_out_of_display_property (struct it
*);
769 static void pop_it (struct it
*);
770 static void redisplay_internal (void);
771 static bool echo_area_display (bool);
772 static void redisplay_windows (Lisp_Object
);
773 static void redisplay_window (Lisp_Object
, bool);
774 static Lisp_Object
redisplay_window_error (Lisp_Object
);
775 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
776 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
777 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
778 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
780 static bool update_menu_bar (struct frame
*, bool, bool);
781 static bool try_window_reusing_current_matrix (struct window
*);
782 static int try_window_id (struct window
*);
783 static bool display_line (struct it
*);
784 static int display_mode_lines (struct window
*);
785 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
786 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
788 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
790 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
791 static void display_menu_bar (struct window
*);
792 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
794 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
795 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
796 static void compute_line_metrics (struct it
*);
797 static void run_redisplay_end_trigger_hook (struct it
*);
798 static bool get_overlay_strings (struct it
*, ptrdiff_t);
799 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
800 static void next_overlay_string (struct it
*);
801 static void reseat (struct it
*, struct text_pos
, bool);
802 static void reseat_1 (struct it
*, struct text_pos
, bool);
803 static bool next_element_from_display_vector (struct it
*);
804 static bool next_element_from_string (struct it
*);
805 static bool next_element_from_c_string (struct it
*);
806 static bool next_element_from_buffer (struct it
*);
807 static bool next_element_from_composition (struct it
*);
808 static bool next_element_from_image (struct it
*);
809 static bool next_element_from_stretch (struct it
*);
810 static void load_overlay_strings (struct it
*, ptrdiff_t);
811 static bool get_next_display_element (struct it
*);
812 static enum move_it_result
813 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
814 enum move_operation_enum
);
815 static void get_visually_first_element (struct it
*);
816 static void compute_stop_pos (struct it
*);
817 static int face_before_or_after_it_pos (struct it
*, bool);
818 static ptrdiff_t next_overlay_change (ptrdiff_t);
819 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
820 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
821 static int handle_single_display_spec (struct it
*, Lisp_Object
,
822 Lisp_Object
, Lisp_Object
,
823 struct text_pos
*, ptrdiff_t, int, bool);
824 static int underlying_face_id (struct it
*);
826 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
827 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
829 #ifdef HAVE_WINDOW_SYSTEM
831 static void update_tool_bar (struct frame
*, bool);
832 static void x_draw_bottom_divider (struct window
*w
);
833 static void notice_overwritten_cursor (struct window
*,
836 static int normal_char_height (struct font
*, int);
837 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
839 static void append_stretch_glyph (struct it
*, Lisp_Object
,
842 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
843 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
844 struct font
*, int, bool);
846 #endif /* HAVE_WINDOW_SYSTEM */
848 static void produce_special_glyphs (struct it
*, enum display_element_type
);
849 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
850 static bool coords_in_mouse_face_p (struct window
*, int, int);
854 /***********************************************************************
855 Window display dimensions
856 ***********************************************************************/
858 /* Return the bottom boundary y-position for text lines in window W.
859 This is the first y position at which a line cannot start.
860 It is relative to the top of the window.
862 This is the height of W minus the height of a mode line, if any. */
865 window_text_bottom_y (struct window
*w
)
867 int height
= WINDOW_PIXEL_HEIGHT (w
);
869 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
871 if (WINDOW_WANTS_MODELINE_P (w
))
872 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
874 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
879 /* Return the pixel width of display area AREA of window W.
880 ANY_AREA means return the total width of W, not including
881 fringes to the left and right of the window. */
884 window_box_width (struct window
*w
, enum glyph_row_area area
)
886 int width
= w
->pixel_width
;
888 if (!w
->pseudo_window_p
)
890 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
891 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
893 if (area
== TEXT_AREA
)
894 width
-= (WINDOW_MARGINS_WIDTH (w
)
895 + WINDOW_FRINGES_WIDTH (w
));
896 else if (area
== LEFT_MARGIN_AREA
)
897 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
898 else if (area
== RIGHT_MARGIN_AREA
)
899 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
902 /* With wide margins, fringes, etc. we might end up with a negative
903 width, correct that here. */
904 return max (0, width
);
908 /* Return the pixel height of the display area of window W, not
909 including mode lines of W, if any. */
912 window_box_height (struct window
*w
)
914 struct frame
*f
= XFRAME (w
->frame
);
915 int height
= WINDOW_PIXEL_HEIGHT (w
);
917 eassert (height
>= 0);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
920 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
922 /* Note: the code below that determines the mode-line/header-line
923 height is essentially the same as that contained in the macro
924 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
925 the appropriate glyph row has its `mode_line_p' flag set,
926 and if it doesn't, uses estimate_mode_line_height instead. */
928 if (WINDOW_WANTS_MODELINE_P (w
))
930 struct glyph_row
*ml_row
931 = (w
->current_matrix
&& w
->current_matrix
->rows
932 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
934 if (ml_row
&& ml_row
->mode_line_p
)
935 height
-= ml_row
->height
;
937 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
940 if (WINDOW_WANTS_HEADER_LINE_P (w
))
942 struct glyph_row
*hl_row
943 = (w
->current_matrix
&& w
->current_matrix
->rows
944 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
946 if (hl_row
&& hl_row
->mode_line_p
)
947 height
-= hl_row
->height
;
949 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
952 /* With a very small font and a mode-line that's taller than
953 default, we might end up with a negative height. */
954 return max (0, height
);
957 /* Return the window-relative coordinate of the left edge of display
958 area AREA of window W. ANY_AREA means return the left edge of the
959 whole window, to the right of the left fringe of W. */
962 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
966 if (w
->pseudo_window_p
)
969 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
971 if (area
== TEXT_AREA
)
972 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
973 + window_box_width (w
, LEFT_MARGIN_AREA
));
974 else if (area
== RIGHT_MARGIN_AREA
)
975 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
976 + window_box_width (w
, LEFT_MARGIN_AREA
)
977 + window_box_width (w
, TEXT_AREA
)
978 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
980 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
981 else if (area
== LEFT_MARGIN_AREA
982 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
983 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
985 /* Don't return more than the window's pixel width. */
986 return min (x
, w
->pixel_width
);
990 /* Return the window-relative coordinate of the right edge of display
991 area AREA of window W. ANY_AREA means return the right edge of the
992 whole window, to the left of the right fringe of W. */
995 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
997 /* Don't return more than the window's pixel width. */
998 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1002 /* Return the frame-relative coordinate of the left edge of display
1003 area AREA of window W. ANY_AREA means return the left edge of the
1004 whole window, to the right of the left fringe of W. */
1007 window_box_left (struct window
*w
, enum glyph_row_area area
)
1009 struct frame
*f
= XFRAME (w
->frame
);
1012 if (w
->pseudo_window_p
)
1013 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1015 x
= (WINDOW_LEFT_EDGE_X (w
)
1016 + window_box_left_offset (w
, area
));
1022 /* Return the frame-relative coordinate of the right edge of display
1023 area AREA of window W. ANY_AREA means return the right edge of the
1024 whole window, to the left of the right fringe of W. */
1027 window_box_right (struct window
*w
, enum glyph_row_area area
)
1029 return window_box_left (w
, area
) + window_box_width (w
, area
);
1032 /* Get the bounding box of the display area AREA of window W, without
1033 mode lines, in frame-relative coordinates. ANY_AREA means the
1034 whole window, not including the left and right fringes of
1035 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1036 coordinates of the upper-left corner of the box. Return in
1037 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1040 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1041 int *box_y
, int *box_width
, int *box_height
)
1044 *box_width
= window_box_width (w
, area
);
1046 *box_height
= window_box_height (w
);
1048 *box_x
= window_box_left (w
, area
);
1051 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1052 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1053 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1057 #ifdef HAVE_WINDOW_SYSTEM
1059 /* Get the bounding box of the display area AREA of window W, without
1060 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1061 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1062 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1063 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1067 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1068 int *bottom_right_x
, int *bottom_right_y
)
1070 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1071 bottom_right_x
, bottom_right_y
);
1072 *bottom_right_x
+= *top_left_x
;
1073 *bottom_right_y
+= *top_left_y
;
1076 #endif /* HAVE_WINDOW_SYSTEM */
1078 /***********************************************************************
1080 ***********************************************************************/
1082 /* Return the bottom y-position of the line the iterator IT is in.
1083 This can modify IT's settings. */
1086 line_bottom_y (struct it
*it
)
1088 int line_height
= it
->max_ascent
+ it
->max_descent
;
1089 int line_top_y
= it
->current_y
;
1091 if (line_height
== 0)
1094 line_height
= last_height
;
1095 else if (IT_CHARPOS (*it
) < ZV
)
1097 move_it_by_lines (it
, 1);
1098 line_height
= (it
->max_ascent
|| it
->max_descent
1099 ? it
->max_ascent
+ it
->max_descent
1104 struct glyph_row
*row
= it
->glyph_row
;
1106 /* Use the default character height. */
1107 it
->glyph_row
= NULL
;
1108 it
->what
= IT_CHARACTER
;
1111 PRODUCE_GLYPHS (it
);
1112 line_height
= it
->ascent
+ it
->descent
;
1113 it
->glyph_row
= row
;
1117 return line_top_y
+ line_height
;
1120 DEFUN ("line-pixel-height", Fline_pixel_height
,
1121 Sline_pixel_height
, 0, 0, 0,
1122 doc
: /* Return height in pixels of text line in the selected window.
1124 Value is the height in pixels of the line at point. */)
1129 struct window
*w
= XWINDOW (selected_window
);
1130 struct buffer
*old_buffer
= NULL
;
1133 if (XBUFFER (w
->contents
) != current_buffer
)
1135 old_buffer
= current_buffer
;
1136 set_buffer_internal_1 (XBUFFER (w
->contents
));
1138 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1139 start_display (&it
, w
, pt
);
1140 it
.vpos
= it
.current_y
= 0;
1142 result
= make_number (line_bottom_y (&it
));
1144 set_buffer_internal_1 (old_buffer
);
1149 /* Return the default pixel height of text lines in window W. The
1150 value is the canonical height of the W frame's default font, plus
1151 any extra space required by the line-spacing variable or frame
1154 Implementation note: this ignores any line-spacing text properties
1155 put on the newline characters. This is because those properties
1156 only affect the _screen_ line ending in the newline (i.e., in a
1157 continued line, only the last screen line will be affected), which
1158 means only a small number of lines in a buffer can ever use this
1159 feature. Since this function is used to compute the default pixel
1160 equivalent of text lines in a window, we can safely ignore those
1161 few lines. For the same reasons, we ignore the line-height
1164 default_line_pixel_height (struct window
*w
)
1166 struct frame
*f
= WINDOW_XFRAME (w
);
1167 int height
= FRAME_LINE_HEIGHT (f
);
1169 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1171 struct buffer
*b
= XBUFFER (w
->contents
);
1172 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1175 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1178 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1179 height
+= XFASTINT (val
);
1180 else if (FLOATP (val
))
1182 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1189 height
+= f
->extra_line_spacing
;
1195 /* Subroutine of pos_visible_p below. Extracts a display string, if
1196 any, from the display spec given as its argument. */
1198 string_from_display_spec (Lisp_Object spec
)
1202 while (CONSP (spec
))
1204 if (STRINGP (XCAR (spec
)))
1209 else if (VECTORP (spec
))
1213 for (i
= 0; i
< ASIZE (spec
); i
++)
1215 if (STRINGP (AREF (spec
, i
)))
1216 return AREF (spec
, i
);
1225 /* Limit insanely large values of W->hscroll on frame F to the largest
1226 value that will still prevent first_visible_x and last_visible_x of
1227 'struct it' from overflowing an int. */
1229 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1231 ptrdiff_t window_hscroll
= w
->hscroll
;
1232 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1233 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1235 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1236 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1238 return window_hscroll
;
1241 /* Return true if position CHARPOS is visible in window W.
1242 CHARPOS < 0 means return info about WINDOW_END position.
1243 If visible, set *X and *Y to pixel coordinates of top left corner.
1244 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1245 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1248 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1249 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1252 void *itdata
= bidi_shelve_cache ();
1253 struct text_pos top
;
1254 bool visible_p
= false;
1255 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->contents
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->contents
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1268 /* Scrolling a minibuffer window via scroll bar when the echo area
1269 shows long text sometimes resets the minibuffer contents behind
1271 if (CHARPOS (top
) > ZV
)
1272 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1274 /* Compute exact mode line heights. */
1275 if (WINDOW_WANTS_MODELINE_P (w
))
1277 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1278 BVAR (current_buffer
, mode_line_format
));
1280 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1281 w
->header_line_height
1282 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1283 BVAR (current_buffer
, header_line_format
));
1285 start_display (&it
, w
, top
);
1286 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1287 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1290 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1291 && IT_CHARPOS (it
) >= charpos
)
1292 /* When scanning backwards under bidi iteration, move_it_to
1293 stops at or _before_ CHARPOS, because it stops at or to
1294 the _right_ of the character at CHARPOS. */
1295 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1296 && IT_CHARPOS (it
) <= charpos
)))
1298 /* We have reached CHARPOS, or passed it. How the call to
1299 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1300 or covered by a display property, move_it_to stops at the end
1301 of the invisible text, to the right of CHARPOS. (ii) If
1302 CHARPOS is in a display vector, move_it_to stops on its last
1304 int top_x
= it
.current_x
;
1305 int top_y
= it
.current_y
;
1306 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1309 void *save_it_data
= NULL
;
1311 /* Calling line_bottom_y may change it.method, it.position, etc. */
1312 SAVE_IT (save_it
, it
, save_it_data
);
1314 bottom_y
= line_bottom_y (&it
);
1315 if (top_y
< window_top_y
)
1316 visible_p
= bottom_y
> window_top_y
;
1317 else if (top_y
< it
.last_visible_y
)
1319 if (bottom_y
>= it
.last_visible_y
1320 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1321 && IT_CHARPOS (it
) < charpos
)
1323 /* When the last line of the window is scanned backwards
1324 under bidi iteration, we could be duped into thinking
1325 that we have passed CHARPOS, when in fact move_it_to
1326 simply stopped short of CHARPOS because it reached
1327 last_visible_y. To see if that's what happened, we call
1328 move_it_to again with a slightly larger vertical limit,
1329 and see if it actually moved vertically; if it did, we
1330 didn't really reach CHARPOS, which is beyond window end. */
1331 /* Why 10? because we don't know how many canonical lines
1332 will the height of the next line(s) be. So we guess. */
1333 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1335 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1336 MOVE_TO_POS
| MOVE_TO_Y
);
1337 if (it
.current_y
> top_y
)
1341 RESTORE_IT (&it
, &save_it
, save_it_data
);
1344 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1346 /* We stopped on the last glyph of a display vector.
1347 Try and recompute. Hack alert! */
1348 if (charpos
< 2 || top
.charpos
>= charpos
)
1349 top_x
= it
.glyph_row
->x
;
1352 struct it it2
, it2_prev
;
1353 /* The idea is to get to the previous buffer
1354 position, consume the character there, and use
1355 the pixel coordinates we get after that. But if
1356 the previous buffer position is also displayed
1357 from a display vector, we need to consume all of
1358 the glyphs from that display vector. */
1359 start_display (&it2
, w
, top
);
1360 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1361 /* If we didn't get to CHARPOS - 1, there's some
1362 replacing display property at that position, and
1363 we stopped after it. That is exactly the place
1364 whose coordinates we want. */
1365 if (IT_CHARPOS (it2
) != charpos
- 1)
1369 /* Iterate until we get out of the display
1370 vector that displays the character at
1373 get_next_display_element (&it2
);
1374 PRODUCE_GLYPHS (&it2
);
1376 set_iterator_to_next (&it2
, true);
1377 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1378 && IT_CHARPOS (it2
) < charpos
);
1380 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1381 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1382 top_x
= it
.glyph_row
->x
;
1385 top_x
= it2_prev
.current_x
;
1386 top_y
= it2_prev
.current_y
;
1390 else if (IT_CHARPOS (it
) != charpos
)
1392 Lisp_Object cpos
= make_number (charpos
);
1393 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1394 Lisp_Object string
= string_from_display_spec (spec
);
1395 struct text_pos tpos
;
1396 bool newline_in_string
1398 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1400 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1401 bool replacing_spec_p
1403 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1404 charpos
, FRAME_WINDOW_P (it
.f
)));
1405 /* The tricky code below is needed because there's a
1406 discrepancy between move_it_to and how we set cursor
1407 when PT is at the beginning of a portion of text
1408 covered by a display property or an overlay with a
1409 display property, or the display line ends in a
1410 newline from a display string. move_it_to will stop
1411 _after_ such display strings, whereas
1412 set_cursor_from_row conspires with cursor_row_p to
1413 place the cursor on the first glyph produced from the
1416 /* We have overshoot PT because it is covered by a
1417 display property that replaces the text it covers.
1418 If the string includes embedded newlines, we are also
1419 in the wrong display line. Backtrack to the correct
1420 line, where the display property begins. */
1421 if (replacing_spec_p
)
1423 Lisp_Object startpos
, endpos
;
1424 EMACS_INT start
, end
;
1427 /* Find the first and the last buffer positions
1428 covered by the display string. */
1430 Fnext_single_char_property_change (cpos
, Qdisplay
,
1433 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1435 start
= XFASTINT (startpos
);
1436 end
= XFASTINT (endpos
);
1437 /* Move to the last buffer position before the
1438 display property. */
1439 start_display (&it3
, w
, top
);
1440 if (start
> CHARPOS (top
))
1441 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1442 /* Move forward one more line if the position before
1443 the display string is a newline or if it is the
1444 rightmost character on a line that is
1445 continued or word-wrapped. */
1446 if (it3
.method
== GET_FROM_BUFFER
1448 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1449 move_it_by_lines (&it3
, 1);
1450 else if (move_it_in_display_line_to (&it3
, -1,
1454 == MOVE_LINE_CONTINUED
)
1456 move_it_by_lines (&it3
, 1);
1457 /* When we are under word-wrap, the #$@%!
1458 move_it_by_lines moves 2 lines, so we need to
1460 if (it3
.line_wrap
== WORD_WRAP
)
1461 move_it_by_lines (&it3
, -1);
1464 /* Record the vertical coordinate of the display
1465 line where we wound up. */
1466 top_y
= it3
.current_y
;
1469 /* When characters are reordered for display,
1470 the character displayed to the left of the
1471 display string could be _after_ the display
1472 property in the logical order. Use the
1473 smallest vertical position of these two. */
1474 start_display (&it3
, w
, top
);
1475 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1476 if (it3
.current_y
< top_y
)
1477 top_y
= it3
.current_y
;
1479 /* Move from the top of the window to the beginning
1480 of the display line where the display string
1482 start_display (&it3
, w
, top
);
1483 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1484 /* If it3_moved stays false after the 'while' loop
1485 below, that means we already were at a newline
1486 before the loop (e.g., the display string begins
1487 with a newline), so we don't need to (and cannot)
1488 inspect the glyphs of it3.glyph_row, because
1489 PRODUCE_GLYPHS will not produce anything for a
1490 newline, and thus it3.glyph_row stays at its
1491 stale content it got at top of the window. */
1492 bool it3_moved
= false;
1493 /* Finally, advance the iterator until we hit the
1494 first display element whose character position is
1495 CHARPOS, or until the first newline from the
1496 display string, which signals the end of the
1498 while (get_next_display_element (&it3
))
1500 PRODUCE_GLYPHS (&it3
);
1501 if (IT_CHARPOS (it3
) == charpos
1502 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1505 set_iterator_to_next (&it3
, false);
1507 top_x
= it3
.current_x
- it3
.pixel_width
;
1508 /* Normally, we would exit the above loop because we
1509 found the display element whose character
1510 position is CHARPOS. For the contingency that we
1511 didn't, and stopped at the first newline from the
1512 display string, move back over the glyphs
1513 produced from the string, until we find the
1514 rightmost glyph not from the string. */
1516 && newline_in_string
1517 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1519 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1520 + it3
.glyph_row
->used
[TEXT_AREA
];
1522 while (EQ ((g
- 1)->object
, string
))
1525 top_x
-= g
->pixel_width
;
1527 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1528 + it3
.glyph_row
->used
[TEXT_AREA
]);
1534 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1535 *rtop
= max (0, window_top_y
- top_y
);
1536 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1537 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1538 - max (top_y
, window_top_y
)));
1540 if (it
.bidi_it
.paragraph_dir
== R2L
)
1546 /* Either we were asked to provide info about WINDOW_END, or
1547 CHARPOS is in the partially visible glyph row at end of
1550 void *it2data
= NULL
;
1552 SAVE_IT (it2
, it
, it2data
);
1553 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1554 move_it_by_lines (&it
, 1);
1555 if (charpos
< IT_CHARPOS (it
)
1556 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1559 RESTORE_IT (&it2
, &it2
, it2data
);
1560 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1562 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1563 *rtop
= max (0, -it2
.current_y
);
1564 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1565 - it
.last_visible_y
));
1566 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1568 - max (it2
.current_y
,
1569 WINDOW_HEADER_LINE_HEIGHT (w
))));
1571 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1575 bidi_unshelve_cache (it2data
, true);
1577 bidi_unshelve_cache (itdata
, false);
1580 set_buffer_internal_1 (old_buffer
);
1586 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1587 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1588 /* For lines in an R2L paragraph, we need to mirror the X pixel
1589 coordinate wrt the text area. For the reasons, see the
1590 commentary in buffer_posn_from_coords and the explanation of
1591 the geometry used by the move_it_* functions at the end of
1592 the large commentary near the beginning of this file. */
1594 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1598 /* Debugging code. */
1600 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1601 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1603 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1610 /* Return the next character from STR. Return in *LEN the length of
1611 the character. This is like STRING_CHAR_AND_LENGTH but never
1612 returns an invalid character. If we find one, we return a `?', but
1613 with the length of the invalid character. */
1616 string_char_and_length (const unsigned char *str
, int *len
)
1620 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1621 if (!CHAR_VALID_P (c
))
1622 /* We may not change the length here because other places in Emacs
1623 don't use this function, i.e. they silently accept invalid
1632 /* Given a position POS containing a valid character and byte position
1633 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1635 static struct text_pos
1636 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1638 eassert (STRINGP (string
) && nchars
>= 0);
1640 if (STRING_MULTIBYTE (string
))
1642 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1647 string_char_and_length (p
, &len
);
1650 BYTEPOS (pos
) += len
;
1654 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1660 /* Value is the text position, i.e. character and byte position,
1661 for character position CHARPOS in STRING. */
1663 static struct text_pos
1664 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1666 struct text_pos pos
;
1667 eassert (STRINGP (string
));
1668 eassert (charpos
>= 0);
1669 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1674 /* Value is a text position, i.e. character and byte position, for
1675 character position CHARPOS in C string S. MULTIBYTE_P
1676 means recognize multibyte characters. */
1678 static struct text_pos
1679 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1681 struct text_pos pos
;
1683 eassert (s
!= NULL
);
1684 eassert (charpos
>= 0);
1690 SET_TEXT_POS (pos
, 0, 0);
1693 string_char_and_length ((const unsigned char *) s
, &len
);
1696 BYTEPOS (pos
) += len
;
1700 SET_TEXT_POS (pos
, charpos
, charpos
);
1706 /* Value is the number of characters in C string S. MULTIBYTE_P
1707 means recognize multibyte characters. */
1710 number_of_chars (const char *s
, bool multibyte_p
)
1716 ptrdiff_t rest
= strlen (s
);
1718 const unsigned char *p
= (const unsigned char *) s
;
1720 for (nchars
= 0; rest
> 0; ++nchars
)
1722 string_char_and_length (p
, &len
);
1723 rest
-= len
, p
+= len
;
1727 nchars
= strlen (s
);
1733 /* Compute byte position NEWPOS->bytepos corresponding to
1734 NEWPOS->charpos. POS is a known position in string STRING.
1735 NEWPOS->charpos must be >= POS.charpos. */
1738 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1740 eassert (STRINGP (string
));
1741 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1743 if (STRING_MULTIBYTE (string
))
1744 *newpos
= string_pos_nchars_ahead (pos
, string
,
1745 CHARPOS (*newpos
) - CHARPOS (pos
));
1747 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1751 Return an estimation of the pixel height of mode or header lines on
1752 frame F. FACE_ID specifies what line's height to estimate. */
1755 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1757 #ifdef HAVE_WINDOW_SYSTEM
1758 if (FRAME_WINDOW_P (f
))
1760 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1762 /* This function is called so early when Emacs starts that the face
1763 cache and mode line face are not yet initialized. */
1764 if (FRAME_FACE_CACHE (f
))
1766 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1770 height
= normal_char_height (face
->font
, -1);
1771 if (face
->box_line_width
> 0)
1772 height
+= 2 * face
->box_line_width
;
1783 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1784 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1785 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1786 not force the value into range. */
1789 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1790 NativeRectangle
*bounds
, bool noclip
)
1793 #ifdef HAVE_WINDOW_SYSTEM
1794 if (FRAME_WINDOW_P (f
))
1796 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1797 even for negative values. */
1799 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1801 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1803 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1804 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1807 STORE_NATIVE_RECT (*bounds
,
1808 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1809 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1810 FRAME_COLUMN_WIDTH (f
) - 1,
1811 FRAME_LINE_HEIGHT (f
) - 1);
1813 /* PXW: Should we clip pixels before converting to columns/lines? */
1818 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1819 pix_x
= FRAME_TOTAL_COLS (f
);
1823 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1824 pix_y
= FRAME_TOTAL_LINES (f
);
1834 /* Find the glyph under window-relative coordinates X/Y in window W.
1835 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1836 strings. Return in *HPOS and *VPOS the row and column number of
1837 the glyph found. Return in *AREA the glyph area containing X.
1838 Value is a pointer to the glyph found or null if X/Y is not on
1839 text, or we can't tell because W's current matrix is not up to
1842 static struct glyph
*
1843 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1844 int *dx
, int *dy
, int *area
)
1846 struct glyph
*glyph
, *end
;
1847 struct glyph_row
*row
= NULL
;
1850 /* Find row containing Y. Give up if some row is not enabled. */
1851 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1853 row
= MATRIX_ROW (w
->current_matrix
, i
);
1854 if (!row
->enabled_p
)
1856 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1863 /* Give up if Y is not in the window. */
1864 if (i
== w
->current_matrix
->nrows
)
1867 /* Get the glyph area containing X. */
1868 if (w
->pseudo_window_p
)
1875 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1877 *area
= LEFT_MARGIN_AREA
;
1878 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1880 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1883 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1887 *area
= RIGHT_MARGIN_AREA
;
1888 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1892 /* Find glyph containing X. */
1893 glyph
= row
->glyphs
[*area
];
1894 end
= glyph
+ row
->used
[*area
];
1896 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1898 x
-= glyph
->pixel_width
;
1908 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1911 *hpos
= glyph
- row
->glyphs
[*area
];
1915 /* Convert frame-relative x/y to coordinates relative to window W.
1916 Takes pseudo-windows into account. */
1919 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1921 if (w
->pseudo_window_p
)
1923 /* A pseudo-window is always full-width, and starts at the
1924 left edge of the frame, plus a frame border. */
1925 struct frame
*f
= XFRAME (w
->frame
);
1926 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1927 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1931 *x
-= WINDOW_LEFT_EDGE_X (w
);
1932 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1936 #ifdef HAVE_WINDOW_SYSTEM
1939 Return in RECTS[] at most N clipping rectangles for glyph string S.
1940 Return the number of stored rectangles. */
1943 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1950 if (s
->row
->full_width_p
)
1952 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1953 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1954 if (s
->row
->mode_line_p
)
1955 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
1957 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
1959 /* Unless displaying a mode or menu bar line, which are always
1960 fully visible, clip to the visible part of the row. */
1961 if (s
->w
->pseudo_window_p
)
1962 r
.height
= s
->row
->visible_height
;
1964 r
.height
= s
->height
;
1968 /* This is a text line that may be partially visible. */
1969 r
.x
= window_box_left (s
->w
, s
->area
);
1970 r
.width
= window_box_width (s
->w
, s
->area
);
1971 r
.height
= s
->row
->visible_height
;
1975 if (r
.x
< s
->clip_head
->x
)
1977 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1978 r
.width
-= s
->clip_head
->x
- r
.x
;
1981 r
.x
= s
->clip_head
->x
;
1984 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1986 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1987 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1992 /* If S draws overlapping rows, it's sufficient to use the top and
1993 bottom of the window for clipping because this glyph string
1994 intentionally draws over other lines. */
1995 if (s
->for_overlaps
)
1997 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1998 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2000 /* Alas, the above simple strategy does not work for the
2001 environments with anti-aliased text: if the same text is
2002 drawn onto the same place multiple times, it gets thicker.
2003 If the overlap we are processing is for the erased cursor, we
2004 take the intersection with the rectangle of the cursor. */
2005 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2007 XRectangle rc
, r_save
= r
;
2009 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2010 rc
.y
= s
->w
->phys_cursor
.y
;
2011 rc
.width
= s
->w
->phys_cursor_width
;
2012 rc
.height
= s
->w
->phys_cursor_height
;
2014 x_intersect_rectangles (&r_save
, &rc
, &r
);
2019 /* Don't use S->y for clipping because it doesn't take partially
2020 visible lines into account. For example, it can be negative for
2021 partially visible lines at the top of a window. */
2022 if (!s
->row
->full_width_p
2023 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2024 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2026 r
.y
= max (0, s
->row
->y
);
2029 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2031 /* If drawing the cursor, don't let glyph draw outside its
2032 advertised boundaries. Cleartype does this under some circumstances. */
2033 if (s
->hl
== DRAW_CURSOR
)
2035 struct glyph
*glyph
= s
->first_glyph
;
2040 if (r
.width
>= s
->x
- r
.x
)
2041 r
.width
-= s
->x
- r
.x
;
2042 else /* R2L hscrolled row with cursor outside text area */
2046 r
.width
= min (r
.width
, glyph
->pixel_width
);
2048 /* If r.y is below window bottom, ensure that we still see a cursor. */
2049 height
= min (glyph
->ascent
+ glyph
->descent
,
2050 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2051 max_y
= window_text_bottom_y (s
->w
) - height
;
2052 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2053 if (s
->ybase
- glyph
->ascent
> max_y
)
2060 /* Don't draw cursor glyph taller than our actual glyph. */
2061 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2062 if (height
< r
.height
)
2064 max_y
= r
.y
+ r
.height
;
2065 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2066 r
.height
= min (max_y
- r
.y
, height
);
2073 XRectangle r_save
= r
;
2075 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2079 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2080 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2082 #ifdef CONVERT_FROM_XRECT
2083 CONVERT_FROM_XRECT (r
, *rects
);
2091 /* If we are processing overlapping and allowed to return
2092 multiple clipping rectangles, we exclude the row of the glyph
2093 string from the clipping rectangle. This is to avoid drawing
2094 the same text on the environment with anti-aliasing. */
2095 #ifdef CONVERT_FROM_XRECT
2098 XRectangle
*rs
= rects
;
2100 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2102 if (s
->for_overlaps
& OVERLAPS_PRED
)
2105 if (r
.y
+ r
.height
> row_y
)
2108 rs
[i
].height
= row_y
- r
.y
;
2114 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2117 if (r
.y
< row_y
+ s
->row
->visible_height
)
2119 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2121 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2122 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i
= 0; i
< n
; i
++)
2133 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2140 Return in *NR the clipping rectangle for glyph string S. */
2143 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2145 get_glyph_string_clip_rects (s
, nr
, 1);
2150 Return the position and height of the phys cursor in window W.
2151 Set w->phys_cursor_width to width of phys cursor.
2155 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2156 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2158 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2159 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2161 /* Compute the width of the rectangle to draw. If on a stretch
2162 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2163 rectangle as wide as the glyph, but use a canonical character
2165 wd
= glyph
->pixel_width
;
2167 x
= w
->phys_cursor
.x
;
2174 if (glyph
->type
== STRETCH_GLYPH
2175 && !x_stretch_cursor_p
)
2176 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2177 w
->phys_cursor_width
= wd
;
2179 /* Don't let the hollow cursor glyph descend below the glyph row's
2180 ascent value, lest the hollow cursor looks funny. */
2181 y
= w
->phys_cursor
.y
;
2182 ascent
= row
->ascent
;
2183 if (row
->ascent
< glyph
->ascent
)
2185 y
=- glyph
->ascent
- row
->ascent
;
2186 ascent
= glyph
->ascent
;
2189 /* If y is below window bottom, ensure that we still see a cursor. */
2190 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2192 h
= max (h0
, ascent
+ glyph
->descent
);
2193 h0
= min (h0
, ascent
+ glyph
->descent
);
2195 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2198 h
= max (h
- (y0
- y
) + 1, h0
);
2203 y0
= window_text_bottom_y (w
) - h0
;
2211 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2212 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2217 * Remember which glyph the mouse is over.
2221 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2225 struct glyph_row
*r
, *gr
, *end_row
;
2226 enum window_part part
;
2227 enum glyph_row_area area
;
2228 int x
, y
, width
, height
;
2230 /* Try to determine frame pixel position and size of the glyph under
2231 frame pixel coordinates X/Y on frame F. */
2233 if (window_resize_pixelwise
)
2238 else if (!f
->glyphs_initialized_p
2239 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2242 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2243 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2247 w
= XWINDOW (window
);
2248 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2249 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2251 x
= window_relative_x_coord (w
, part
, gx
);
2252 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2254 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2255 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2257 if (w
->pseudo_window_p
)
2260 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2266 case ON_LEFT_MARGIN
:
2267 area
= LEFT_MARGIN_AREA
;
2270 case ON_RIGHT_MARGIN
:
2271 area
= RIGHT_MARGIN_AREA
;
2274 case ON_HEADER_LINE
:
2276 gr
= (part
== ON_HEADER_LINE
2277 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2278 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2281 goto text_glyph_row_found
;
2288 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2289 if (r
->y
+ r
->height
> y
)
2295 text_glyph_row_found
:
2298 struct glyph
*g
= gr
->glyphs
[area
];
2299 struct glyph
*end
= g
+ gr
->used
[area
];
2301 height
= gr
->height
;
2302 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2303 if (gx
+ g
->pixel_width
> x
)
2308 if (g
->type
== IMAGE_GLYPH
)
2310 /* Don't remember when mouse is over image, as
2311 image may have hot-spots. */
2312 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2315 width
= g
->pixel_width
;
2319 /* Use nominal char spacing at end of line. */
2321 gx
+= (x
/ width
) * width
;
2324 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2326 gx
+= window_box_left_offset (w
, area
);
2327 /* Don't expand over the modeline to make sure the vertical
2328 drag cursor is shown early enough. */
2329 height
= min (height
,
2330 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2335 /* Use nominal line height at end of window. */
2336 gx
= (x
/ width
) * width
;
2338 gy
+= (y
/ height
) * height
;
2339 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2340 /* See comment above. */
2341 height
= min (height
,
2342 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2346 case ON_LEFT_FRINGE
:
2347 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2348 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2349 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2350 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2353 case ON_RIGHT_FRINGE
:
2354 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2355 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2356 : window_box_right_offset (w
, TEXT_AREA
));
2357 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2358 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2359 && !WINDOW_RIGHTMOST_P (w
))
2360 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2361 /* Make sure the vertical border can get her own glyph to the
2362 right of the one we build here. */
2363 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2365 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2367 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2371 case ON_VERTICAL_BORDER
:
2372 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2375 case ON_VERTICAL_SCROLL_BAR
:
2376 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2378 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2379 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2380 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2382 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2386 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2387 if (r
->y
+ r
->height
> y
)
2394 height
= gr
->height
;
2397 /* Use nominal line height at end of window. */
2399 gy
+= (y
/ height
) * height
;
2403 case ON_RIGHT_DIVIDER
:
2404 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2405 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2407 /* The bottom divider prevails. */
2408 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2411 case ON_BOTTOM_DIVIDER
:
2413 width
= WINDOW_PIXEL_WIDTH (w
);
2414 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2415 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2421 /* If there is no glyph under the mouse, then we divide the screen
2422 into a grid of the smallest glyph in the frame, and use that
2425 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2426 round down even for negative values. */
2432 gx
= (gx
/ width
) * width
;
2433 gy
= (gy
/ height
) * height
;
2439 gx
+= WINDOW_LEFT_EDGE_X (w
);
2440 gy
+= WINDOW_TOP_EDGE_Y (w
);
2443 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2445 /* Visible feedback for debugging. */
2446 #if false && defined HAVE_X_WINDOWS
2447 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2448 f
->output_data
.x
->normal_gc
,
2449 gx
, gy
, width
, height
);
2454 #endif /* HAVE_WINDOW_SYSTEM */
2457 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2460 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2461 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2463 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2466 /***********************************************************************
2467 Lisp form evaluation
2468 ***********************************************************************/
2470 /* Error handler for safe_eval and safe_call. */
2473 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2475 add_to_log ("Error during redisplay: %S signaled %S",
2476 Flist (nargs
, args
), arg
);
2480 /* Call function FUNC with the rest of NARGS - 1 arguments
2481 following. Return the result, or nil if something went
2482 wrong. Prevent redisplay during the evaluation. */
2485 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2489 if (inhibit_eval_during_redisplay
)
2494 ptrdiff_t count
= SPECPDL_INDEX ();
2497 SAFE_ALLOCA_LISP (args
, nargs
);
2500 for (i
= 1; i
< nargs
; i
++)
2501 args
[i
] = va_arg (ap
, Lisp_Object
);
2503 specbind (Qinhibit_redisplay
, Qt
);
2505 specbind (Qinhibit_quit
, Qt
);
2506 /* Use Qt to ensure debugger does not run,
2507 so there is no possibility of wanting to redisplay. */
2508 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2511 val
= unbind_to (count
, val
);
2518 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2523 va_start (ap
, func
);
2524 retval
= safe__call (false, nargs
, func
, ap
);
2529 /* Call function FN with one argument ARG.
2530 Return the result, or nil if something went wrong. */
2533 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2535 return safe_call (2, fn
, arg
);
2539 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2545 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2551 safe_eval (Lisp_Object sexpr
)
2553 return safe__call1 (false, Qeval
, sexpr
);
2557 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2559 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2562 /* Call function FN with two arguments ARG1 and ARG2.
2563 Return the result, or nil if something went wrong. */
2566 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2568 return safe_call (3, fn
, arg1
, arg2
);
2573 /***********************************************************************
2575 ***********************************************************************/
2577 /* Define CHECK_IT to perform sanity checks on iterators.
2578 This is for debugging. It is too slow to do unconditionally. */
2581 CHECK_IT (struct it
*it
)
2584 if (it
->method
== GET_FROM_STRING
)
2586 eassert (STRINGP (it
->string
));
2587 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2591 eassert (IT_STRING_CHARPOS (*it
) < 0);
2592 if (it
->method
== GET_FROM_BUFFER
)
2594 /* Check that character and byte positions agree. */
2595 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2600 eassert (it
->current
.dpvec_index
>= 0);
2602 eassert (it
->current
.dpvec_index
< 0);
2607 /* Check that the window end of window W is what we expect it
2608 to be---the last row in the current matrix displaying text. */
2611 CHECK_WINDOW_END (struct window
*w
)
2613 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2614 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2616 struct glyph_row
*row
;
2617 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2619 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2620 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2625 /***********************************************************************
2626 Iterator initialization
2627 ***********************************************************************/
2629 /* Initialize IT for displaying current_buffer in window W, starting
2630 at character position CHARPOS. CHARPOS < 0 means that no buffer
2631 position is specified which is useful when the iterator is assigned
2632 a position later. BYTEPOS is the byte position corresponding to
2635 If ROW is not null, calls to produce_glyphs with IT as parameter
2636 will produce glyphs in that row.
2638 BASE_FACE_ID is the id of a base face to use. It must be one of
2639 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2640 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2641 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2643 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2644 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2645 will be initialized to use the corresponding mode line glyph row of
2646 the desired matrix of W. */
2649 init_iterator (struct it
*it
, struct window
*w
,
2650 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2651 struct glyph_row
*row
, enum face_id base_face_id
)
2653 enum face_id remapped_base_face_id
= base_face_id
;
2655 /* Some precondition checks. */
2656 eassert (w
!= NULL
&& it
!= NULL
);
2657 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2660 /* If face attributes have been changed since the last redisplay,
2661 free realized faces now because they depend on face definitions
2662 that might have changed. Don't free faces while there might be
2663 desired matrices pending which reference these faces. */
2664 if (face_change
&& !inhibit_free_realized_faces
)
2666 face_change
= false;
2667 free_all_realized_faces (Qnil
);
2670 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2671 if (! NILP (Vface_remapping_alist
))
2672 remapped_base_face_id
2673 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2675 /* Use one of the mode line rows of W's desired matrix if
2679 if (base_face_id
== MODE_LINE_FACE_ID
2680 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2681 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2682 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2683 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2686 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2687 Other parts of redisplay rely on that. */
2688 memclear (it
, sizeof *it
);
2689 it
->current
.overlay_string_index
= -1;
2690 it
->current
.dpvec_index
= -1;
2691 it
->base_face_id
= remapped_base_face_id
;
2692 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2693 it
->paragraph_embedding
= L2R
;
2696 /* The window in which we iterate over current_buffer: */
2697 XSETWINDOW (it
->window
, w
);
2699 it
->f
= XFRAME (w
->frame
);
2703 /* Extra space between lines (on window systems only). */
2704 if (base_face_id
== DEFAULT_FACE_ID
2705 && FRAME_WINDOW_P (it
->f
))
2707 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2708 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2709 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2710 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2711 * FRAME_LINE_HEIGHT (it
->f
));
2712 else if (it
->f
->extra_line_spacing
> 0)
2713 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2716 /* If realized faces have been removed, e.g. because of face
2717 attribute changes of named faces, recompute them. When running
2718 in batch mode, the face cache of the initial frame is null. If
2719 we happen to get called, make a dummy face cache. */
2720 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2721 init_frame_faces (it
->f
);
2722 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2723 recompute_basic_faces (it
->f
);
2725 it
->override_ascent
= -1;
2727 /* Are control characters displayed as `^C'? */
2728 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2730 /* -1 means everything between a CR and the following line end
2731 is invisible. >0 means lines indented more than this value are
2733 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2735 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2737 : (!NILP (BVAR (current_buffer
, selective_display
))
2739 it
->selective_display_ellipsis_p
2740 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2742 /* Display table to use. */
2743 it
->dp
= window_display_table (w
);
2745 /* Are multibyte characters enabled in current_buffer? */
2746 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2748 /* Get the position at which the redisplay_end_trigger hook should
2749 be run, if it is to be run at all. */
2750 if (MARKERP (w
->redisplay_end_trigger
)
2751 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2752 it
->redisplay_end_trigger_charpos
2753 = marker_position (w
->redisplay_end_trigger
);
2754 else if (INTEGERP (w
->redisplay_end_trigger
))
2755 it
->redisplay_end_trigger_charpos
2756 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2759 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2761 /* Are lines in the display truncated? */
2763 it
->line_wrap
= TRUNCATE
;
2764 if (base_face_id
== DEFAULT_FACE_ID
2766 && (WINDOW_FULL_WIDTH_P (it
->w
)
2767 || NILP (Vtruncate_partial_width_windows
)
2768 || (INTEGERP (Vtruncate_partial_width_windows
)
2769 /* PXW: Shall we do something about this? */
2770 && (XINT (Vtruncate_partial_width_windows
)
2771 <= WINDOW_TOTAL_COLS (it
->w
))))
2772 && NILP (BVAR (current_buffer
, truncate_lines
)))
2773 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2774 ? WINDOW_WRAP
: WORD_WRAP
;
2776 /* Get dimensions of truncation and continuation glyphs. These are
2777 displayed as fringe bitmaps under X, but we need them for such
2778 frames when the fringes are turned off. But leave the dimensions
2779 zero for tooltip frames, as these glyphs look ugly there and also
2780 sabotage calculations of tooltip dimensions in x-show-tip. */
2781 #ifdef HAVE_WINDOW_SYSTEM
2782 if (!(FRAME_WINDOW_P (it
->f
)
2783 && FRAMEP (tip_frame
)
2784 && it
->f
== XFRAME (tip_frame
)))
2787 if (it
->line_wrap
== TRUNCATE
)
2789 /* We will need the truncation glyph. */
2790 eassert (it
->glyph_row
== NULL
);
2791 produce_special_glyphs (it
, IT_TRUNCATION
);
2792 it
->truncation_pixel_width
= it
->pixel_width
;
2796 /* We will need the continuation glyph. */
2797 eassert (it
->glyph_row
== NULL
);
2798 produce_special_glyphs (it
, IT_CONTINUATION
);
2799 it
->continuation_pixel_width
= it
->pixel_width
;
2803 /* Reset these values to zero because the produce_special_glyphs
2804 above has changed them. */
2805 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2806 it
->phys_ascent
= it
->phys_descent
= 0;
2808 /* Set this after getting the dimensions of truncation and
2809 continuation glyphs, so that we don't produce glyphs when calling
2810 produce_special_glyphs, above. */
2811 it
->glyph_row
= row
;
2812 it
->area
= TEXT_AREA
;
2814 /* Get the dimensions of the display area. The display area
2815 consists of the visible window area plus a horizontally scrolled
2816 part to the left of the window. All x-values are relative to the
2817 start of this total display area. */
2818 if (base_face_id
!= DEFAULT_FACE_ID
)
2820 /* Mode lines, menu bar in terminal frames. */
2821 it
->first_visible_x
= 0;
2822 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2827 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2828 it
->last_visible_x
= (it
->first_visible_x
2829 + window_box_width (w
, TEXT_AREA
));
2831 /* If we truncate lines, leave room for the truncation glyph(s) at
2832 the right margin. Otherwise, leave room for the continuation
2833 glyph(s). Done only if the window has no right fringe. */
2834 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2836 if (it
->line_wrap
== TRUNCATE
)
2837 it
->last_visible_x
-= it
->truncation_pixel_width
;
2839 it
->last_visible_x
-= it
->continuation_pixel_width
;
2842 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2843 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2846 /* Leave room for a border glyph. */
2847 if (!FRAME_WINDOW_P (it
->f
)
2848 && !WINDOW_RIGHTMOST_P (it
->w
))
2849 it
->last_visible_x
-= 1;
2851 it
->last_visible_y
= window_text_bottom_y (w
);
2853 /* For mode lines and alike, arrange for the first glyph having a
2854 left box line if the face specifies a box. */
2855 if (base_face_id
!= DEFAULT_FACE_ID
)
2859 it
->face_id
= remapped_base_face_id
;
2861 /* If we have a boxed mode line, make the first character appear
2862 with a left box line. */
2863 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2864 if (face
&& face
->box
!= FACE_NO_BOX
)
2865 it
->start_of_box_run_p
= true;
2868 /* If a buffer position was specified, set the iterator there,
2869 getting overlays and face properties from that position. */
2870 if (charpos
>= BUF_BEG (current_buffer
))
2872 it
->stop_charpos
= charpos
;
2873 it
->end_charpos
= ZV
;
2874 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2875 IT_CHARPOS (*it
) = charpos
;
2876 IT_BYTEPOS (*it
) = bytepos
;
2878 /* We will rely on `reseat' to set this up properly, via
2879 handle_face_prop. */
2880 it
->face_id
= it
->base_face_id
;
2882 it
->start
= it
->current
;
2883 /* Do we need to reorder bidirectional text? Not if this is a
2884 unibyte buffer: by definition, none of the single-byte
2885 characters are strong R2L, so no reordering is needed. And
2886 bidi.c doesn't support unibyte buffers anyway. Also, don't
2887 reorder while we are loading loadup.el, since the tables of
2888 character properties needed for reordering are not yet
2892 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2895 /* If we are to reorder bidirectional text, init the bidi
2899 /* Since we don't know at this point whether there will be
2900 any R2L lines in the window, we reserve space for
2901 truncation/continuation glyphs even if only the left
2902 fringe is absent. */
2903 if (base_face_id
== DEFAULT_FACE_ID
2904 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2905 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2907 if (it
->line_wrap
== TRUNCATE
)
2908 it
->last_visible_x
-= it
->truncation_pixel_width
;
2910 it
->last_visible_x
-= it
->continuation_pixel_width
;
2912 /* Note the paragraph direction that this buffer wants to
2914 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2916 it
->paragraph_embedding
= L2R
;
2917 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2919 it
->paragraph_embedding
= R2L
;
2921 it
->paragraph_embedding
= NEUTRAL_DIR
;
2922 bidi_unshelve_cache (NULL
, false);
2923 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2927 /* Compute faces etc. */
2928 reseat (it
, it
->current
.pos
, true);
2935 /* Initialize IT for the display of window W with window start POS. */
2938 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2940 struct glyph_row
*row
;
2941 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2943 row
= w
->desired_matrix
->rows
+ first_vpos
;
2944 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2945 it
->first_vpos
= first_vpos
;
2947 /* Don't reseat to previous visible line start if current start
2948 position is in a string or image. */
2949 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2951 int first_y
= it
->current_y
;
2953 /* If window start is not at a line start, skip forward to POS to
2954 get the correct continuation lines width. */
2955 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2956 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2957 if (!start_at_line_beg_p
)
2961 reseat_at_previous_visible_line_start (it
);
2962 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2964 new_x
= it
->current_x
+ it
->pixel_width
;
2966 /* If lines are continued, this line may end in the middle
2967 of a multi-glyph character (e.g. a control character
2968 displayed as \003, or in the middle of an overlay
2969 string). In this case move_it_to above will not have
2970 taken us to the start of the continuation line but to the
2971 end of the continued line. */
2972 if (it
->current_x
> 0
2973 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2974 && (/* And glyph doesn't fit on the line. */
2975 new_x
> it
->last_visible_x
2976 /* Or it fits exactly and we're on a window
2978 || (new_x
== it
->last_visible_x
2979 && FRAME_WINDOW_P (it
->f
)
2980 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
2981 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
2982 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
2984 if ((it
->current
.dpvec_index
>= 0
2985 || it
->current
.overlay_string_index
>= 0)
2986 /* If we are on a newline from a display vector or
2987 overlay string, then we are already at the end of
2988 a screen line; no need to go to the next line in
2989 that case, as this line is not really continued.
2990 (If we do go to the next line, C-e will not DTRT.) */
2993 set_iterator_to_next (it
, true);
2994 move_it_in_display_line_to (it
, -1, -1, 0);
2997 it
->continuation_lines_width
+= it
->current_x
;
2999 /* If the character at POS is displayed via a display
3000 vector, move_it_to above stops at the final glyph of
3001 IT->dpvec. To make the caller redisplay that character
3002 again (a.k.a. start at POS), we need to reset the
3003 dpvec_index to the beginning of IT->dpvec. */
3004 else if (it
->current
.dpvec_index
>= 0)
3005 it
->current
.dpvec_index
= 0;
3007 /* We're starting a new display line, not affected by the
3008 height of the continued line, so clear the appropriate
3009 fields in the iterator structure. */
3010 it
->max_ascent
= it
->max_descent
= 0;
3011 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3013 it
->current_y
= first_y
;
3015 it
->current_x
= it
->hpos
= 0;
3021 /* Return true if POS is a position in ellipses displayed for invisible
3022 text. W is the window we display, for text property lookup. */
3025 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3027 Lisp_Object prop
, window
;
3028 bool ellipses_p
= false;
3029 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3031 /* If POS specifies a position in a display vector, this might
3032 be for an ellipsis displayed for invisible text. We won't
3033 get the iterator set up for delivering that ellipsis unless
3034 we make sure that it gets aware of the invisible text. */
3035 if (pos
->dpvec_index
>= 0
3036 && pos
->overlay_string_index
< 0
3037 && CHARPOS (pos
->string_pos
) < 0
3039 && (XSETWINDOW (window
, w
),
3040 prop
= Fget_char_property (make_number (charpos
),
3041 Qinvisible
, window
),
3042 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3044 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3046 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3053 /* Initialize IT for stepping through current_buffer in window W,
3054 starting at position POS that includes overlay string and display
3055 vector/ control character translation position information. Value
3056 is false if there are overlay strings with newlines at POS. */
3059 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3061 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3063 bool overlay_strings_with_newlines
= false;
3065 /* If POS specifies a position in a display vector, this might
3066 be for an ellipsis displayed for invisible text. We won't
3067 get the iterator set up for delivering that ellipsis unless
3068 we make sure that it gets aware of the invisible text. */
3069 if (in_ellipses_for_invisible_text_p (pos
, w
))
3075 /* Keep in mind: the call to reseat in init_iterator skips invisible
3076 text, so we might end up at a position different from POS. This
3077 is only a problem when POS is a row start after a newline and an
3078 overlay starts there with an after-string, and the overlay has an
3079 invisible property. Since we don't skip invisible text in
3080 display_line and elsewhere immediately after consuming the
3081 newline before the row start, such a POS will not be in a string,
3082 but the call to init_iterator below will move us to the
3084 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3086 /* This only scans the current chunk -- it should scan all chunks.
3087 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3088 to 16 in 22.1 to make this a lesser problem. */
3089 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3091 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3092 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3094 while (s
< e
&& *s
!= '\n')
3099 overlay_strings_with_newlines
= true;
3104 /* If position is within an overlay string, set up IT to the right
3106 if (pos
->overlay_string_index
>= 0)
3110 /* If the first overlay string happens to have a `display'
3111 property for an image, the iterator will be set up for that
3112 image, and we have to undo that setup first before we can
3113 correct the overlay string index. */
3114 if (it
->method
== GET_FROM_IMAGE
)
3117 /* We already have the first chunk of overlay strings in
3118 IT->overlay_strings. Load more until the one for
3119 pos->overlay_string_index is in IT->overlay_strings. */
3120 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3122 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3123 it
->current
.overlay_string_index
= 0;
3126 load_overlay_strings (it
, 0);
3127 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3131 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3132 relative_index
= (it
->current
.overlay_string_index
3133 % OVERLAY_STRING_CHUNK_SIZE
);
3134 it
->string
= it
->overlay_strings
[relative_index
];
3135 eassert (STRINGP (it
->string
));
3136 it
->current
.string_pos
= pos
->string_pos
;
3137 it
->method
= GET_FROM_STRING
;
3138 it
->end_charpos
= SCHARS (it
->string
);
3139 /* Set up the bidi iterator for this overlay string. */
3142 it
->bidi_it
.string
.lstring
= it
->string
;
3143 it
->bidi_it
.string
.s
= NULL
;
3144 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3145 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3146 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3147 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3148 it
->bidi_it
.w
= it
->w
;
3149 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3150 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3152 /* Synchronize the state of the bidi iterator with
3153 pos->string_pos. For any string position other than
3154 zero, this will be done automagically when we resume
3155 iteration over the string and get_visually_first_element
3156 is called. But if string_pos is zero, and the string is
3157 to be reordered for display, we need to resync manually,
3158 since it could be that the iteration state recorded in
3159 pos ended at string_pos of 0 moving backwards in string. */
3160 if (CHARPOS (pos
->string_pos
) == 0)
3162 get_visually_first_element (it
);
3163 if (IT_STRING_CHARPOS (*it
) != 0)
3166 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3167 bidi_move_to_visually_next (&it
->bidi_it
);
3168 } while (it
->bidi_it
.charpos
!= 0);
3170 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3171 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3175 if (CHARPOS (pos
->string_pos
) >= 0)
3177 /* Recorded position is not in an overlay string, but in another
3178 string. This can only be a string from a `display' property.
3179 IT should already be filled with that string. */
3180 it
->current
.string_pos
= pos
->string_pos
;
3181 eassert (STRINGP (it
->string
));
3183 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3184 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3187 /* Restore position in display vector translations, control
3188 character translations or ellipses. */
3189 if (pos
->dpvec_index
>= 0)
3191 if (it
->dpvec
== NULL
)
3192 get_next_display_element (it
);
3193 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3194 it
->current
.dpvec_index
= pos
->dpvec_index
;
3198 return !overlay_strings_with_newlines
;
3202 /* Initialize IT for stepping through current_buffer in window W
3203 starting at ROW->start. */
3206 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3208 init_from_display_pos (it
, w
, &row
->start
);
3209 it
->start
= row
->start
;
3210 it
->continuation_lines_width
= row
->continuation_lines_width
;
3215 /* Initialize IT for stepping through current_buffer in window W
3216 starting in the line following ROW, i.e. starting at ROW->end.
3217 Value is false if there are overlay strings with newlines at ROW's
3221 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3223 bool success
= false;
3225 if (init_from_display_pos (it
, w
, &row
->end
))
3227 if (row
->continued_p
)
3228 it
->continuation_lines_width
3229 = row
->continuation_lines_width
+ row
->pixel_width
;
3240 /***********************************************************************
3242 ***********************************************************************/
3244 /* Called when IT reaches IT->stop_charpos. Handle text property and
3245 overlay changes. Set IT->stop_charpos to the next position where
3249 handle_stop (struct it
*it
)
3251 enum prop_handled handled
;
3252 bool handle_overlay_change_p
;
3256 it
->current
.dpvec_index
= -1;
3257 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3258 it
->ellipsis_p
= false;
3260 /* Use face of preceding text for ellipsis (if invisible) */
3261 if (it
->selective_display_ellipsis_p
)
3262 it
->saved_face_id
= it
->face_id
;
3264 /* Here's the description of the semantics of, and the logic behind,
3265 the various HANDLED_* statuses:
3267 HANDLED_NORMALLY means the handler did its job, and the loop
3268 should proceed to calling the next handler in order.
3270 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3271 change in the properties and overlays at current position, so the
3272 loop should be restarted, to re-invoke the handlers that were
3273 already called. This happens when fontification-functions were
3274 called by handle_fontified_prop, and actually fontified
3275 something. Another case where HANDLED_RECOMPUTE_PROPS is
3276 returned is when we discover overlay strings that need to be
3277 displayed right away. The loop below will continue for as long
3278 as the status is HANDLED_RECOMPUTE_PROPS.
3280 HANDLED_RETURN means return immediately to the caller, to
3281 continue iteration without calling any further handlers. This is
3282 used when we need to act on some property right away, for example
3283 when we need to display the ellipsis or a replacing display
3284 property, such as display string or image.
3286 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3287 consumed, and the handler switched to the next overlay string.
3288 This signals the loop below to refrain from looking for more
3289 overlays before all the overlay strings of the current overlay
3292 Some of the handlers called by the loop push the iterator state
3293 onto the stack (see 'push_it'), and arrange for the iteration to
3294 continue with another object, such as an image, a display string,
3295 or an overlay string. In most such cases, it->stop_charpos is
3296 set to the first character of the string, so that when the
3297 iteration resumes, this function will immediately be called
3298 again, to examine the properties at the beginning of the string.
3300 When a display or overlay string is exhausted, the iterator state
3301 is popped (see 'pop_it'), and iteration continues with the
3302 previous object. Again, in many such cases this function is
3303 called again to find the next position where properties might
3308 handled
= HANDLED_NORMALLY
;
3310 /* Call text property handlers. */
3311 for (p
= it_props
; p
->handler
; ++p
)
3313 handled
= p
->handler (it
);
3315 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3317 else if (handled
== HANDLED_RETURN
)
3319 /* We still want to show before and after strings from
3320 overlays even if the actual buffer text is replaced. */
3321 if (!handle_overlay_change_p
3323 /* Don't call get_overlay_strings_1 if we already
3324 have overlay strings loaded, because doing so
3325 will load them again and push the iterator state
3326 onto the stack one more time, which is not
3327 expected by the rest of the code that processes
3329 || (it
->current
.overlay_string_index
< 0
3330 && !get_overlay_strings_1 (it
, 0, false)))
3333 setup_for_ellipsis (it
, 0);
3334 /* When handling a display spec, we might load an
3335 empty string. In that case, discard it here. We
3336 used to discard it in handle_single_display_spec,
3337 but that causes get_overlay_strings_1, above, to
3338 ignore overlay strings that we must check. */
3339 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3343 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3347 it
->string_from_display_prop_p
= false;
3348 it
->from_disp_prop_p
= false;
3349 handle_overlay_change_p
= false;
3351 handled
= HANDLED_RECOMPUTE_PROPS
;
3354 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3355 handle_overlay_change_p
= false;
3358 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3360 /* Don't check for overlay strings below when set to deliver
3361 characters from a display vector. */
3362 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3363 handle_overlay_change_p
= false;
3365 /* Handle overlay changes.
3366 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3367 if it finds overlays. */
3368 if (handle_overlay_change_p
)
3369 handled
= handle_overlay_change (it
);
3374 setup_for_ellipsis (it
, 0);
3378 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3380 /* Determine where to stop next. */
3381 if (handled
== HANDLED_NORMALLY
)
3382 compute_stop_pos (it
);
3386 /* Compute IT->stop_charpos from text property and overlay change
3387 information for IT's current position. */
3390 compute_stop_pos (struct it
*it
)
3392 register INTERVAL iv
, next_iv
;
3393 Lisp_Object object
, limit
, position
;
3394 ptrdiff_t charpos
, bytepos
;
3396 if (STRINGP (it
->string
))
3398 /* Strings are usually short, so don't limit the search for
3400 it
->stop_charpos
= it
->end_charpos
;
3401 object
= it
->string
;
3403 charpos
= IT_STRING_CHARPOS (*it
);
3404 bytepos
= IT_STRING_BYTEPOS (*it
);
3410 /* If end_charpos is out of range for some reason, such as a
3411 misbehaving display function, rationalize it (Bug#5984). */
3412 if (it
->end_charpos
> ZV
)
3413 it
->end_charpos
= ZV
;
3414 it
->stop_charpos
= it
->end_charpos
;
3416 /* If next overlay change is in front of the current stop pos
3417 (which is IT->end_charpos), stop there. Note: value of
3418 next_overlay_change is point-max if no overlay change
3420 charpos
= IT_CHARPOS (*it
);
3421 bytepos
= IT_BYTEPOS (*it
);
3422 pos
= next_overlay_change (charpos
);
3423 if (pos
< it
->stop_charpos
)
3424 it
->stop_charpos
= pos
;
3426 /* Set up variables for computing the stop position from text
3427 property changes. */
3428 XSETBUFFER (object
, current_buffer
);
3429 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3432 /* Get the interval containing IT's position. Value is a null
3433 interval if there isn't such an interval. */
3434 position
= make_number (charpos
);
3435 iv
= validate_interval_range (object
, &position
, &position
, false);
3438 Lisp_Object values_here
[LAST_PROP_IDX
];
3441 /* Get properties here. */
3442 for (p
= it_props
; p
->handler
; ++p
)
3443 values_here
[p
->idx
] = textget (iv
->plist
,
3444 builtin_lisp_symbol (p
->name
));
3446 /* Look for an interval following iv that has different
3448 for (next_iv
= next_interval (iv
);
3451 || XFASTINT (limit
) > next_iv
->position
));
3452 next_iv
= next_interval (next_iv
))
3454 for (p
= it_props
; p
->handler
; ++p
)
3456 Lisp_Object new_value
= textget (next_iv
->plist
,
3457 builtin_lisp_symbol (p
->name
));
3458 if (!EQ (values_here
[p
->idx
], new_value
))
3468 if (INTEGERP (limit
)
3469 && next_iv
->position
>= XFASTINT (limit
))
3470 /* No text property change up to limit. */
3471 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3473 /* Text properties change in next_iv. */
3474 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3478 if (it
->cmp_it
.id
< 0)
3480 ptrdiff_t stoppos
= it
->end_charpos
;
3482 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3484 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3485 stoppos
, it
->string
);
3488 eassert (STRINGP (it
->string
)
3489 || (it
->stop_charpos
>= BEGV
3490 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3494 /* Return the position of the next overlay change after POS in
3495 current_buffer. Value is point-max if no overlay change
3496 follows. This is like `next-overlay-change' but doesn't use
3500 next_overlay_change (ptrdiff_t pos
)
3502 ptrdiff_t i
, noverlays
;
3504 Lisp_Object
*overlays
;
3507 /* Get all overlays at the given position. */
3508 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3510 /* If any of these overlays ends before endpos,
3511 use its ending point instead. */
3512 for (i
= 0; i
< noverlays
; ++i
)
3517 oend
= OVERLAY_END (overlays
[i
]);
3518 oendpos
= OVERLAY_POSITION (oend
);
3519 endpos
= min (endpos
, oendpos
);
3526 /* How many characters forward to search for a display property or
3527 display string. Searching too far forward makes the bidi display
3528 sluggish, especially in small windows. */
3529 #define MAX_DISP_SCAN 250
3531 /* Return the character position of a display string at or after
3532 position specified by POSITION. If no display string exists at or
3533 after POSITION, return ZV. A display string is either an overlay
3534 with `display' property whose value is a string, or a `display'
3535 text property whose value is a string. STRING is data about the
3536 string to iterate; if STRING->lstring is nil, we are iterating a
3537 buffer. FRAME_WINDOW_P is true when we are displaying a window
3538 on a GUI frame. DISP_PROP is set to zero if we searched
3539 MAX_DISP_SCAN characters forward without finding any display
3540 strings, non-zero otherwise. It is set to 2 if the display string
3541 uses any kind of `(space ...)' spec that will produce a stretch of
3542 white space in the text area. */
3544 compute_display_string_pos (struct text_pos
*position
,
3545 struct bidi_string_data
*string
,
3547 bool frame_window_p
, int *disp_prop
)
3549 /* OBJECT = nil means current buffer. */
3550 Lisp_Object object
, object1
;
3551 Lisp_Object pos
, spec
, limpos
;
3552 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3553 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3554 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3555 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3557 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3558 struct text_pos tpos
;
3561 if (string
&& STRINGP (string
->lstring
))
3562 object1
= object
= string
->lstring
;
3563 else if (w
&& !string_p
)
3565 XSETWINDOW (object
, w
);
3569 object1
= object
= Qnil
;
3574 /* We don't support display properties whose values are strings
3575 that have display string properties. */
3576 || string
->from_disp_str
3577 /* C strings cannot have display properties. */
3578 || (string
->s
&& !STRINGP (object
)))
3584 /* If the character at CHARPOS is where the display string begins,
3586 pos
= make_number (charpos
);
3587 if (STRINGP (object
))
3588 bufpos
= string
->bufpos
;
3592 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3594 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3597 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3605 /* Look forward for the first character with a `display' property
3606 that will replace the underlying text when displayed. */
3607 limpos
= make_number (lim
);
3609 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3610 CHARPOS (tpos
) = XFASTINT (pos
);
3611 if (CHARPOS (tpos
) >= lim
)
3616 if (STRINGP (object
))
3617 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3619 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3620 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3621 if (!STRINGP (object
))
3622 bufpos
= CHARPOS (tpos
);
3623 } while (NILP (spec
)
3624 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3625 bufpos
, frame_window_p
)));
3629 return CHARPOS (tpos
);
3632 /* Return the character position of the end of the display string that
3633 started at CHARPOS. If there's no display string at CHARPOS,
3634 return -1. A display string is either an overlay with `display'
3635 property whose value is a string or a `display' text property whose
3636 value is a string. */
3638 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3640 /* OBJECT = nil means current buffer. */
3641 Lisp_Object object
=
3642 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3643 Lisp_Object pos
= make_number (charpos
);
3645 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3647 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3650 /* It could happen that the display property or overlay was removed
3651 since we found it in compute_display_string_pos above. One way
3652 this can happen is if JIT font-lock was called (through
3653 handle_fontified_prop), and jit-lock-functions remove text
3654 properties or overlays from the portion of buffer that includes
3655 CHARPOS. Muse mode is known to do that, for example. In this
3656 case, we return -1 to the caller, to signal that no display
3657 string is actually present at CHARPOS. See bidi_fetch_char for
3658 how this is handled.
3660 An alternative would be to never look for display properties past
3661 it->stop_charpos. But neither compute_display_string_pos nor
3662 bidi_fetch_char that calls it know or care where the next
3664 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3667 /* Look forward for the first character where the `display' property
3669 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3671 return XFASTINT (pos
);
3676 /***********************************************************************
3678 ***********************************************************************/
3680 /* Handle changes in the `fontified' property of the current buffer by
3681 calling hook functions from Qfontification_functions to fontify
3684 static enum prop_handled
3685 handle_fontified_prop (struct it
*it
)
3687 Lisp_Object prop
, pos
;
3688 enum prop_handled handled
= HANDLED_NORMALLY
;
3690 if (!NILP (Vmemory_full
))
3693 /* Get the value of the `fontified' property at IT's current buffer
3694 position. (The `fontified' property doesn't have a special
3695 meaning in strings.) If the value is nil, call functions from
3696 Qfontification_functions. */
3697 if (!STRINGP (it
->string
)
3699 && !NILP (Vfontification_functions
)
3700 && !NILP (Vrun_hooks
)
3701 && (pos
= make_number (IT_CHARPOS (*it
)),
3702 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3703 /* Ignore the special cased nil value always present at EOB since
3704 no amount of fontifying will be able to change it. */
3705 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3707 ptrdiff_t count
= SPECPDL_INDEX ();
3709 struct buffer
*obuf
= current_buffer
;
3710 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3711 bool old_clip_changed
= current_buffer
->clip_changed
;
3713 val
= Vfontification_functions
;
3714 specbind (Qfontification_functions
, Qnil
);
3716 eassert (it
->end_charpos
== ZV
);
3718 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3719 safe_call1 (val
, pos
);
3722 Lisp_Object fns
, fn
;
3723 struct gcpro gcpro1
, gcpro2
;
3728 for (; CONSP (val
); val
= XCDR (val
))
3734 /* A value of t indicates this hook has a local
3735 binding; it means to run the global binding too.
3736 In a global value, t should not occur. If it
3737 does, we must ignore it to avoid an endless
3739 for (fns
= Fdefault_value (Qfontification_functions
);
3745 safe_call1 (fn
, pos
);
3749 safe_call1 (fn
, pos
);
3755 unbind_to (count
, Qnil
);
3757 /* Fontification functions routinely call `save-restriction'.
3758 Normally, this tags clip_changed, which can confuse redisplay
3759 (see discussion in Bug#6671). Since we don't perform any
3760 special handling of fontification changes in the case where
3761 `save-restriction' isn't called, there's no point doing so in
3762 this case either. So, if the buffer's restrictions are
3763 actually left unchanged, reset clip_changed. */
3764 if (obuf
== current_buffer
)
3766 if (begv
== BEGV
&& zv
== ZV
)
3767 current_buffer
->clip_changed
= old_clip_changed
;
3769 /* There isn't much we can reasonably do to protect against
3770 misbehaving fontification, but here's a fig leaf. */
3771 else if (BUFFER_LIVE_P (obuf
))
3772 set_buffer_internal_1 (obuf
);
3774 /* The fontification code may have added/removed text.
3775 It could do even a lot worse, but let's at least protect against
3776 the most obvious case where only the text past `pos' gets changed',
3777 as is/was done in grep.el where some escapes sequences are turned
3778 into face properties (bug#7876). */
3779 it
->end_charpos
= ZV
;
3781 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3782 something. This avoids an endless loop if they failed to
3783 fontify the text for which reason ever. */
3784 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3785 handled
= HANDLED_RECOMPUTE_PROPS
;
3793 /***********************************************************************
3795 ***********************************************************************/
3797 /* Set up iterator IT from face properties at its current position.
3798 Called from handle_stop. */
3800 static enum prop_handled
3801 handle_face_prop (struct it
*it
)
3804 ptrdiff_t next_stop
;
3806 if (!STRINGP (it
->string
))
3809 = face_at_buffer_position (it
->w
,
3813 + TEXT_PROP_DISTANCE_LIMIT
),
3814 false, it
->base_face_id
);
3816 /* Is this a start of a run of characters with box face?
3817 Caveat: this can be called for a freshly initialized
3818 iterator; face_id is -1 in this case. We know that the new
3819 face will not change until limit, i.e. if the new face has a
3820 box, all characters up to limit will have one. But, as
3821 usual, we don't know whether limit is really the end. */
3822 if (new_face_id
!= it
->face_id
)
3824 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3825 /* If it->face_id is -1, old_face below will be NULL, see
3826 the definition of FACE_FROM_ID. This will happen if this
3827 is the initial call that gets the face. */
3828 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3830 /* If the value of face_id of the iterator is -1, we have to
3831 look in front of IT's position and see whether there is a
3832 face there that's different from new_face_id. */
3833 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3835 int prev_face_id
= face_before_it_pos (it
);
3837 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3840 /* If the new face has a box, but the old face does not,
3841 this is the start of a run of characters with box face,
3842 i.e. this character has a shadow on the left side. */
3843 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3844 && (old_face
== NULL
|| !old_face
->box
));
3845 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3853 Lisp_Object from_overlay
3854 = (it
->current
.overlay_string_index
>= 0
3855 ? it
->string_overlays
[it
->current
.overlay_string_index
3856 % OVERLAY_STRING_CHUNK_SIZE
]
3859 /* See if we got to this string directly or indirectly from
3860 an overlay property. That includes the before-string or
3861 after-string of an overlay, strings in display properties
3862 provided by an overlay, their text properties, etc.
3864 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3865 if (! NILP (from_overlay
))
3866 for (i
= it
->sp
- 1; i
>= 0; i
--)
3868 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3870 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3871 % OVERLAY_STRING_CHUNK_SIZE
];
3872 else if (! NILP (it
->stack
[i
].from_overlay
))
3873 from_overlay
= it
->stack
[i
].from_overlay
;
3875 if (!NILP (from_overlay
))
3879 if (! NILP (from_overlay
))
3881 bufpos
= IT_CHARPOS (*it
);
3882 /* For a string from an overlay, the base face depends
3883 only on text properties and ignores overlays. */
3885 = face_for_overlay_string (it
->w
,
3889 + TEXT_PROP_DISTANCE_LIMIT
),
3897 /* For strings from a `display' property, use the face at
3898 IT's current buffer position as the base face to merge
3899 with, so that overlay strings appear in the same face as
3900 surrounding text, unless they specify their own faces.
3901 For strings from wrap-prefix and line-prefix properties,
3902 use the default face, possibly remapped via
3903 Vface_remapping_alist. */
3904 /* Note that the fact that we use the face at _buffer_
3905 position means that a 'display' property on an overlay
3906 string will not inherit the face of that overlay string,
3907 but will instead revert to the face of buffer text
3908 covered by the overlay. This is visible, e.g., when the
3909 overlay specifies a box face, but neither the buffer nor
3910 the display string do. This sounds like a design bug,
3911 but Emacs always did that since v21.1, so changing that
3912 might be a big deal. */
3913 base_face_id
= it
->string_from_prefix_prop_p
3914 ? (!NILP (Vface_remapping_alist
)
3915 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3917 : underlying_face_id (it
);
3920 new_face_id
= face_at_string_position (it
->w
,
3922 IT_STRING_CHARPOS (*it
),
3925 base_face_id
, false);
3927 /* Is this a start of a run of characters with box? Caveat:
3928 this can be called for a freshly allocated iterator; face_id
3929 is -1 is this case. We know that the new face will not
3930 change until the next check pos, i.e. if the new face has a
3931 box, all characters up to that position will have a
3932 box. But, as usual, we don't know whether that position
3933 is really the end. */
3934 if (new_face_id
!= it
->face_id
)
3936 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3937 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3939 /* If new face has a box but old face hasn't, this is the
3940 start of a run of characters with box, i.e. it has a
3941 shadow on the left side. */
3942 it
->start_of_box_run_p
3943 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3944 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3948 it
->face_id
= new_face_id
;
3949 return HANDLED_NORMALLY
;
3953 /* Return the ID of the face ``underlying'' IT's current position,
3954 which is in a string. If the iterator is associated with a
3955 buffer, return the face at IT's current buffer position.
3956 Otherwise, use the iterator's base_face_id. */
3959 underlying_face_id (struct it
*it
)
3961 int face_id
= it
->base_face_id
, i
;
3963 eassert (STRINGP (it
->string
));
3965 for (i
= it
->sp
- 1; i
>= 0; --i
)
3966 if (NILP (it
->stack
[i
].string
))
3967 face_id
= it
->stack
[i
].face_id
;
3973 /* Compute the face one character before or after the current position
3974 of IT, in the visual order. BEFORE_P means get the face
3975 in front (to the left in L2R paragraphs, to the right in R2L
3976 paragraphs) of IT's screen position. Value is the ID of the face. */
3979 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
3982 ptrdiff_t next_check_charpos
;
3984 void *it_copy_data
= NULL
;
3986 eassert (it
->s
== NULL
);
3988 if (STRINGP (it
->string
))
3990 ptrdiff_t bufpos
, charpos
;
3993 /* No face change past the end of the string (for the case
3994 we are padding with spaces). No face change before the
3996 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3997 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4002 /* Set charpos to the position before or after IT's current
4003 position, in the logical order, which in the non-bidi
4004 case is the same as the visual order. */
4006 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4007 else if (it
->what
== IT_COMPOSITION
)
4008 /* For composition, we must check the character after the
4010 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4012 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4018 /* With bidi iteration, the character before the current
4019 in the visual order cannot be found by simple
4020 iteration, because "reverse" reordering is not
4021 supported. Instead, we need to use the move_it_*
4022 family of functions. */
4023 /* Ignore face changes before the first visible
4024 character on this display line. */
4025 if (it
->current_x
<= it
->first_visible_x
)
4027 SAVE_IT (it_copy
, *it
, it_copy_data
);
4028 /* Implementation note: Since move_it_in_display_line
4029 works in the iterator geometry, and thinks the first
4030 character is always the leftmost, even in R2L lines,
4031 we don't need to distinguish between the R2L and L2R
4033 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4034 it_copy
.current_x
- 1, MOVE_TO_X
);
4035 charpos
= IT_STRING_CHARPOS (it_copy
);
4036 RESTORE_IT (it
, it
, it_copy_data
);
4040 /* Set charpos to the string position of the character
4041 that comes after IT's current position in the visual
4043 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4047 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4049 charpos
= it_copy
.bidi_it
.charpos
;
4052 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4054 if (it
->current
.overlay_string_index
>= 0)
4055 bufpos
= IT_CHARPOS (*it
);
4059 base_face_id
= underlying_face_id (it
);
4061 /* Get the face for ASCII, or unibyte. */
4062 face_id
= face_at_string_position (it
->w
,
4066 &next_check_charpos
,
4067 base_face_id
, false);
4069 /* Correct the face for charsets different from ASCII. Do it
4070 for the multibyte case only. The face returned above is
4071 suitable for unibyte text if IT->string is unibyte. */
4072 if (STRING_MULTIBYTE (it
->string
))
4074 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4075 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4077 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4079 c
= string_char_and_length (p
, &len
);
4080 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4085 struct text_pos pos
;
4087 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4088 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4091 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4092 pos
= it
->current
.pos
;
4097 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4100 if (it
->what
== IT_COMPOSITION
)
4102 /* For composition, we must check the position after
4104 pos
.charpos
+= it
->cmp_it
.nchars
;
4105 pos
.bytepos
+= it
->len
;
4108 INC_TEXT_POS (pos
, it
->multibyte_p
);
4115 /* With bidi iteration, the character before the current
4116 in the visual order cannot be found by simple
4117 iteration, because "reverse" reordering is not
4118 supported. Instead, we need to use the move_it_*
4119 family of functions. */
4120 /* Ignore face changes before the first visible
4121 character on this display line. */
4122 if (it
->current_x
<= it
->first_visible_x
)
4124 SAVE_IT (it_copy
, *it
, it_copy_data
);
4125 /* Implementation note: Since move_it_in_display_line
4126 works in the iterator geometry, and thinks the first
4127 character is always the leftmost, even in R2L lines,
4128 we don't need to distinguish between the R2L and L2R
4130 move_it_in_display_line (&it_copy
, ZV
,
4131 it_copy
.current_x
- 1, MOVE_TO_X
);
4132 pos
= it_copy
.current
.pos
;
4133 RESTORE_IT (it
, it
, it_copy_data
);
4137 /* Set charpos to the buffer position of the character
4138 that comes after IT's current position in the visual
4140 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4144 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4147 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4150 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4152 /* Determine face for CHARSET_ASCII, or unibyte. */
4153 face_id
= face_at_buffer_position (it
->w
,
4155 &next_check_charpos
,
4158 /* Correct the face for charsets different from ASCII. Do it
4159 for the multibyte case only. The face returned above is
4160 suitable for unibyte text if current_buffer is unibyte. */
4161 if (it
->multibyte_p
)
4163 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4164 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4165 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4174 /***********************************************************************
4176 ***********************************************************************/
4178 /* Set up iterator IT from invisible properties at its current
4179 position. Called from handle_stop. */
4181 static enum prop_handled
4182 handle_invisible_prop (struct it
*it
)
4184 enum prop_handled handled
= HANDLED_NORMALLY
;
4188 if (STRINGP (it
->string
))
4190 Lisp_Object end_charpos
, limit
, charpos
;
4192 /* Get the value of the invisible text property at the
4193 current position. Value will be nil if there is no such
4195 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4196 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4197 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4199 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4201 /* Record whether we have to display an ellipsis for the
4203 bool display_ellipsis_p
= (invis
== 2);
4204 ptrdiff_t len
, endpos
;
4206 handled
= HANDLED_RECOMPUTE_PROPS
;
4208 /* Get the position at which the next visible text can be
4209 found in IT->string, if any. */
4210 endpos
= len
= SCHARS (it
->string
);
4211 XSETINT (limit
, len
);
4214 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
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;
4225 while (invis
!= 0 && endpos
< len
);
4227 if (display_ellipsis_p
)
4228 it
->ellipsis_p
= true;
4232 /* Text at END_CHARPOS is visible. Move IT there. */
4233 struct text_pos old
;
4236 old
= it
->current
.string_pos
;
4237 oldpos
= CHARPOS (old
);
4240 if (it
->bidi_it
.first_elt
4241 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4242 bidi_paragraph_init (it
->paragraph_embedding
,
4243 &it
->bidi_it
, true);
4244 /* Bidi-iterate out of the invisible text. */
4247 bidi_move_to_visually_next (&it
->bidi_it
);
4249 while (oldpos
<= it
->bidi_it
.charpos
4250 && it
->bidi_it
.charpos
< endpos
);
4252 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4253 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4254 if (IT_CHARPOS (*it
) >= endpos
)
4255 it
->prev_stop
= endpos
;
4259 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4260 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4265 /* The rest of the string is invisible. If this is an
4266 overlay string, proceed with the next overlay string
4267 or whatever comes and return a character from there. */
4268 if (it
->current
.overlay_string_index
>= 0
4269 && !display_ellipsis_p
)
4271 next_overlay_string (it
);
4272 /* Don't check for overlay strings when we just
4273 finished processing them. */
4274 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4278 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4279 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4286 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4287 Lisp_Object pos
, overlay
;
4289 /* First of all, is there invisible text at this position? */
4290 tem
= start_charpos
= IT_CHARPOS (*it
);
4291 pos
= make_number (tem
);
4292 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4294 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4296 /* If we are on invisible text, skip over it. */
4297 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4299 /* Record whether we have to display an ellipsis for the
4301 bool display_ellipsis_p
= invis
== 2;
4303 handled
= HANDLED_RECOMPUTE_PROPS
;
4305 /* Loop skipping over invisible text. The loop is left at
4306 ZV or with IT on the first char being visible again. */
4309 /* Try to skip some invisible text. Return value is the
4310 position reached which can be equal to where we start
4311 if there is nothing invisible there. This skips both
4312 over invisible text properties and overlays with
4313 invisible property. */
4314 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4316 /* If we skipped nothing at all we weren't at invisible
4317 text in the first place. If everything to the end of
4318 the buffer was skipped, end the loop. */
4319 if (newpos
== tem
|| newpos
>= ZV
)
4323 /* We skipped some characters but not necessarily
4324 all there are. Check if we ended up on visible
4325 text. Fget_char_property returns the property of
4326 the char before the given position, i.e. if we
4327 get invis = 0, this means that the char at
4328 newpos is visible. */
4329 pos
= make_number (newpos
);
4330 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4331 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4334 /* If we ended up on invisible text, proceed to
4335 skip starting with next_stop. */
4339 /* If there are adjacent invisible texts, don't lose the
4340 second one's ellipsis. */
4342 display_ellipsis_p
= true;
4346 /* The position newpos is now either ZV or on visible text. */
4349 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4351 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4353 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4355 /* If the invisible text ends on a newline or on a
4356 character after a newline, we can avoid the costly,
4357 character by character, bidi iteration to NEWPOS, and
4358 instead simply reseat the iterator there. That's
4359 because all bidi reordering information is tossed at
4360 the newline. This is a big win for modes that hide
4361 complete lines, like Outline, Org, etc. */
4362 if (on_newline
|| after_newline
)
4364 struct text_pos tpos
;
4365 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4367 SET_TEXT_POS (tpos
, newpos
, bpos
);
4368 reseat_1 (it
, tpos
, false);
4369 /* If we reseat on a newline/ZV, we need to prep the
4370 bidi iterator for advancing to the next character
4371 after the newline/EOB, keeping the current paragraph
4372 direction (so that PRODUCE_GLYPHS does TRT wrt
4373 prepending/appending glyphs to a glyph row). */
4376 it
->bidi_it
.first_elt
= false;
4377 it
->bidi_it
.paragraph_dir
= pdir
;
4378 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4379 it
->bidi_it
.nchars
= 1;
4380 it
->bidi_it
.ch_len
= 1;
4383 else /* Must use the slow method. */
4385 /* With bidi iteration, the region of invisible text
4386 could start and/or end in the middle of a
4387 non-base embedding level. Therefore, we need to
4388 skip invisible text using the bidi iterator,
4389 starting at IT's current position, until we find
4390 ourselves outside of the invisible text.
4391 Skipping invisible text _after_ bidi iteration
4392 avoids affecting the visual order of the
4393 displayed text when invisible properties are
4394 added or removed. */
4395 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4397 /* If we were `reseat'ed to a new paragraph,
4398 determine the paragraph base direction. We
4399 need to do it now because
4400 next_element_from_buffer may not have a
4401 chance to do it, if we are going to skip any
4402 text at the beginning, which resets the
4404 bidi_paragraph_init (it
->paragraph_embedding
,
4405 &it
->bidi_it
, true);
4409 bidi_move_to_visually_next (&it
->bidi_it
);
4411 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4412 && it
->bidi_it
.charpos
< newpos
);
4413 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4414 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4415 /* If we overstepped NEWPOS, record its position in
4416 the iterator, so that we skip invisible text if
4417 later the bidi iteration lands us in the
4418 invisible region again. */
4419 if (IT_CHARPOS (*it
) >= newpos
)
4420 it
->prev_stop
= newpos
;
4425 IT_CHARPOS (*it
) = newpos
;
4426 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4429 if (display_ellipsis_p
)
4431 /* Make sure that the glyphs of the ellipsis will get
4432 correct `charpos' values. If we would not update
4433 it->position here, the glyphs would belong to the
4434 last visible character _before_ the invisible
4435 text, which confuses `set_cursor_from_row'.
4437 We use the last invisible position instead of the
4438 first because this way the cursor is always drawn on
4439 the first "." of the ellipsis, whenever PT is inside
4440 the invisible text. Otherwise the cursor would be
4441 placed _after_ the ellipsis when the point is after the
4442 first invisible character. */
4443 if (!STRINGP (it
->object
))
4445 it
->position
.charpos
= newpos
- 1;
4446 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4450 /* If there are before-strings at the start of invisible
4451 text, and the text is invisible because of a text
4452 property, arrange to show before-strings because 20.x did
4453 it that way. (If the text is invisible because of an
4454 overlay property instead of a text property, this is
4455 already handled in the overlay code.) */
4457 && get_overlay_strings (it
, it
->stop_charpos
))
4459 handled
= HANDLED_RECOMPUTE_PROPS
;
4462 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4463 /* The call to get_overlay_strings above recomputes
4464 it->stop_charpos, but it only considers changes
4465 in properties and overlays beyond iterator's
4466 current position. This causes us to miss changes
4467 that happen exactly where the invisible property
4468 ended. So we play it safe here and force the
4469 iterator to check for potential stop positions
4470 immediately after the invisible text. Note that
4471 if get_overlay_strings returns true, it
4472 normally also pushed the iterator stack, so we
4473 need to update the stop position in the slot
4474 below the current one. */
4475 it
->stack
[it
->sp
- 1].stop_charpos
4476 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4479 else if (display_ellipsis_p
)
4481 it
->ellipsis_p
= true;
4482 /* Let the ellipsis display before
4483 considering any properties of the following char.
4484 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4485 handled
= HANDLED_RETURN
;
4494 /* Make iterator IT return `...' next.
4495 Replaces LEN characters from buffer. */
4498 setup_for_ellipsis (struct it
*it
, int len
)
4500 /* Use the display table definition for `...'. Invalid glyphs
4501 will be handled by the method returning elements from dpvec. */
4502 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4504 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4505 it
->dpvec
= v
->contents
;
4506 it
->dpend
= v
->contents
+ v
->header
.size
;
4510 /* Default `...'. */
4511 it
->dpvec
= default_invis_vector
;
4512 it
->dpend
= default_invis_vector
+ 3;
4515 it
->dpvec_char_len
= len
;
4516 it
->current
.dpvec_index
= 0;
4517 it
->dpvec_face_id
= -1;
4519 /* Remember the current face id in case glyphs specify faces.
4520 IT's face is restored in set_iterator_to_next.
4521 saved_face_id was set to preceding char's face in handle_stop. */
4522 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4523 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4525 /* If the ellipsis represents buffer text, it means we advanced in
4526 the buffer, so we should no longer ignore overlay strings. */
4527 if (it
->method
== GET_FROM_BUFFER
)
4528 it
->ignore_overlay_strings_at_pos_p
= false;
4530 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4531 it
->ellipsis_p
= true;
4536 /***********************************************************************
4538 ***********************************************************************/
4540 /* Set up iterator IT from `display' property at its current position.
4541 Called from handle_stop.
4542 We return HANDLED_RETURN if some part of the display property
4543 overrides the display of the buffer text itself.
4544 Otherwise we return HANDLED_NORMALLY. */
4546 static enum prop_handled
4547 handle_display_prop (struct it
*it
)
4549 Lisp_Object propval
, object
, overlay
;
4550 struct text_pos
*position
;
4552 /* Nonzero if some property replaces the display of the text itself. */
4553 int display_replaced
= 0;
4555 if (STRINGP (it
->string
))
4557 object
= it
->string
;
4558 position
= &it
->current
.string_pos
;
4559 bufpos
= CHARPOS (it
->current
.pos
);
4563 XSETWINDOW (object
, it
->w
);
4564 position
= &it
->current
.pos
;
4565 bufpos
= CHARPOS (*position
);
4568 /* Reset those iterator values set from display property values. */
4569 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4570 it
->space_width
= Qnil
;
4571 it
->font_height
= Qnil
;
4574 /* We don't support recursive `display' properties, i.e. string
4575 values that have a string `display' property, that have a string
4576 `display' property etc. */
4577 if (!it
->string_from_display_prop_p
)
4578 it
->area
= TEXT_AREA
;
4580 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4581 Qdisplay
, object
, &overlay
);
4583 return HANDLED_NORMALLY
;
4584 /* Now OVERLAY is the overlay that gave us this property, or nil
4585 if it was a text property. */
4587 if (!STRINGP (it
->string
))
4588 object
= it
->w
->contents
;
4590 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4592 FRAME_WINDOW_P (it
->f
));
4593 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4596 /* Subroutine of handle_display_prop. Returns non-zero if the display
4597 specification in SPEC is a replacing specification, i.e. it would
4598 replace the text covered by `display' property with something else,
4599 such as an image or a display string. If SPEC includes any kind or
4600 `(space ...) specification, the value is 2; this is used by
4601 compute_display_string_pos, which see.
4603 See handle_single_display_spec for documentation of arguments.
4604 FRAME_WINDOW_P is true if the window being redisplayed is on a
4605 GUI frame; this argument is used only if IT is NULL, see below.
4607 IT can be NULL, if this is called by the bidi reordering code
4608 through compute_display_string_pos, which see. In that case, this
4609 function only examines SPEC, but does not otherwise "handle" it, in
4610 the sense that it doesn't set up members of IT from the display
4613 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4614 Lisp_Object overlay
, struct text_pos
*position
,
4615 ptrdiff_t bufpos
, bool frame_window_p
)
4620 /* Simple specifications. */
4621 && !EQ (XCAR (spec
), Qimage
)
4622 && !EQ (XCAR (spec
), Qspace
)
4623 && !EQ (XCAR (spec
), Qwhen
)
4624 && !EQ (XCAR (spec
), Qslice
)
4625 && !EQ (XCAR (spec
), Qspace_width
)
4626 && !EQ (XCAR (spec
), Qheight
)
4627 && !EQ (XCAR (spec
), Qraise
)
4628 /* Marginal area specifications. */
4629 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4630 && !EQ (XCAR (spec
), Qleft_fringe
)
4631 && !EQ (XCAR (spec
), Qright_fringe
)
4632 && !NILP (XCAR (spec
)))
4634 for (; CONSP (spec
); spec
= XCDR (spec
))
4636 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4637 overlay
, position
, bufpos
,
4638 replacing
, frame_window_p
);
4642 /* If some text in a string is replaced, `position' no
4643 longer points to the position of `object'. */
4644 if (!it
|| STRINGP (object
))
4649 else if (VECTORP (spec
))
4652 for (i
= 0; i
< ASIZE (spec
); ++i
)
4654 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4655 overlay
, position
, bufpos
,
4656 replacing
, frame_window_p
);
4660 /* If some text in a string is replaced, `position' no
4661 longer points to the position of `object'. */
4662 if (!it
|| STRINGP (object
))
4668 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4669 bufpos
, 0, frame_window_p
);
4673 /* Value is the position of the end of the `display' property starting
4674 at START_POS in OBJECT. */
4676 static struct text_pos
4677 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4680 struct text_pos end_pos
;
4682 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4683 Qdisplay
, object
, Qnil
);
4684 CHARPOS (end_pos
) = XFASTINT (end
);
4685 if (STRINGP (object
))
4686 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4688 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4694 /* Set up IT from a single `display' property specification SPEC. OBJECT
4695 is the object in which the `display' property was found. *POSITION
4696 is the position in OBJECT at which the `display' property was found.
4697 BUFPOS is the buffer position of OBJECT (different from POSITION if
4698 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4699 previously saw a display specification which already replaced text
4700 display with something else, for example an image; we ignore such
4701 properties after the first one has been processed.
4703 OVERLAY is the overlay this `display' property came from,
4704 or nil if it was a text property.
4706 If SPEC is a `space' or `image' specification, and in some other
4707 cases too, set *POSITION to the position where the `display'
4710 If IT is NULL, only examine the property specification in SPEC, but
4711 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4712 is intended to be displayed in a window on a GUI frame.
4714 Value is non-zero if something was found which replaces the display
4715 of buffer or string text. */
4718 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4719 Lisp_Object overlay
, struct text_pos
*position
,
4720 ptrdiff_t bufpos
, int display_replaced
,
4721 bool frame_window_p
)
4724 Lisp_Object location
, value
;
4725 struct text_pos start_pos
= *position
;
4727 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4728 If the result is non-nil, use VALUE instead of SPEC. */
4730 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4739 if (!NILP (form
) && !EQ (form
, Qt
))
4741 ptrdiff_t count
= SPECPDL_INDEX ();
4742 struct gcpro gcpro1
;
4744 /* Bind `object' to the object having the `display' property, a
4745 buffer or string. Bind `position' to the position in the
4746 object where the property was found, and `buffer-position'
4747 to the current position in the buffer. */
4750 XSETBUFFER (object
, current_buffer
);
4751 specbind (Qobject
, object
);
4752 specbind (Qposition
, make_number (CHARPOS (*position
)));
4753 specbind (Qbuffer_position
, make_number (bufpos
));
4755 form
= safe_eval (form
);
4757 unbind_to (count
, Qnil
);
4763 /* Handle `(height HEIGHT)' specifications. */
4765 && EQ (XCAR (spec
), Qheight
)
4766 && CONSP (XCDR (spec
)))
4770 if (!FRAME_WINDOW_P (it
->f
))
4773 it
->font_height
= XCAR (XCDR (spec
));
4774 if (!NILP (it
->font_height
))
4776 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4777 int new_height
= -1;
4779 if (CONSP (it
->font_height
)
4780 && (EQ (XCAR (it
->font_height
), Qplus
)
4781 || EQ (XCAR (it
->font_height
), Qminus
))
4782 && CONSP (XCDR (it
->font_height
))
4783 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4785 /* `(+ N)' or `(- N)' where N is an integer. */
4786 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4787 if (EQ (XCAR (it
->font_height
), Qplus
))
4789 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4791 else if (FUNCTIONP (it
->font_height
))
4793 /* Call function with current height as argument.
4794 Value is the new height. */
4796 height
= safe_call1 (it
->font_height
,
4797 face
->lface
[LFACE_HEIGHT_INDEX
]);
4798 if (NUMBERP (height
))
4799 new_height
= XFLOATINT (height
);
4801 else if (NUMBERP (it
->font_height
))
4803 /* Value is a multiple of the canonical char height. */
4806 f
= FACE_FROM_ID (it
->f
,
4807 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4808 new_height
= (XFLOATINT (it
->font_height
)
4809 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4813 /* Evaluate IT->font_height with `height' bound to the
4814 current specified height to get the new height. */
4815 ptrdiff_t count
= SPECPDL_INDEX ();
4817 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4818 value
= safe_eval (it
->font_height
);
4819 unbind_to (count
, Qnil
);
4821 if (NUMBERP (value
))
4822 new_height
= XFLOATINT (value
);
4826 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4833 /* Handle `(space-width WIDTH)'. */
4835 && EQ (XCAR (spec
), Qspace_width
)
4836 && CONSP (XCDR (spec
)))
4840 if (!FRAME_WINDOW_P (it
->f
))
4843 value
= XCAR (XCDR (spec
));
4844 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4845 it
->space_width
= value
;
4851 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4853 && EQ (XCAR (spec
), Qslice
))
4859 if (!FRAME_WINDOW_P (it
->f
))
4862 if (tem
= XCDR (spec
), CONSP (tem
))
4864 it
->slice
.x
= XCAR (tem
);
4865 if (tem
= XCDR (tem
), CONSP (tem
))
4867 it
->slice
.y
= XCAR (tem
);
4868 if (tem
= XCDR (tem
), CONSP (tem
))
4870 it
->slice
.width
= XCAR (tem
);
4871 if (tem
= XCDR (tem
), CONSP (tem
))
4872 it
->slice
.height
= XCAR (tem
);
4881 /* Handle `(raise FACTOR)'. */
4883 && EQ (XCAR (spec
), Qraise
)
4884 && CONSP (XCDR (spec
)))
4888 if (!FRAME_WINDOW_P (it
->f
))
4891 #ifdef HAVE_WINDOW_SYSTEM
4892 value
= XCAR (XCDR (spec
));
4893 if (NUMBERP (value
))
4895 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4896 it
->voffset
= - (XFLOATINT (value
)
4897 * (normal_char_height (face
->font
, -1)));
4899 #endif /* HAVE_WINDOW_SYSTEM */
4905 /* Don't handle the other kinds of display specifications
4906 inside a string that we got from a `display' property. */
4907 if (it
&& it
->string_from_display_prop_p
)
4910 /* Characters having this form of property are not displayed, so
4911 we have to find the end of the property. */
4914 start_pos
= *position
;
4915 *position
= display_prop_end (it
, object
, start_pos
);
4916 /* If the display property comes from an overlay, don't consider
4917 any potential stop_charpos values before the end of that
4918 overlay. Since display_prop_end will happily find another
4919 'display' property coming from some other overlay or text
4920 property on buffer positions before this overlay's end, we
4921 need to ignore them, or else we risk displaying this
4922 overlay's display string/image twice. */
4923 if (!NILP (overlay
))
4925 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4927 if (ovendpos
> CHARPOS (*position
))
4928 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4933 /* Stop the scan at that end position--we assume that all
4934 text properties change there. */
4936 it
->stop_charpos
= position
->charpos
;
4938 /* Handle `(left-fringe BITMAP [FACE])'
4939 and `(right-fringe BITMAP [FACE])'. */
4941 && (EQ (XCAR (spec
), Qleft_fringe
)
4942 || EQ (XCAR (spec
), Qright_fringe
))
4943 && CONSP (XCDR (spec
)))
4949 if (!FRAME_WINDOW_P (it
->f
))
4950 /* If we return here, POSITION has been advanced
4951 across the text with this property. */
4953 /* Synchronize the bidi iterator with POSITION. This is
4954 needed because we are not going to push the iterator
4955 on behalf of this display property, so there will be
4956 no pop_it call to do this synchronization for us. */
4959 it
->position
= *position
;
4960 iterate_out_of_display_property (it
);
4961 *position
= it
->position
;
4966 else if (!frame_window_p
)
4969 #ifdef HAVE_WINDOW_SYSTEM
4970 value
= XCAR (XCDR (spec
));
4971 if (!SYMBOLP (value
)
4972 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4973 /* If we return here, POSITION has been advanced
4974 across the text with this property. */
4976 if (it
&& it
->bidi_p
)
4978 it
->position
= *position
;
4979 iterate_out_of_display_property (it
);
4980 *position
= it
->position
;
4987 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4989 if (CONSP (XCDR (XCDR (spec
))))
4991 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4992 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4993 FRINGE_FACE_ID
, false);
4998 /* Save current settings of IT so that we can restore them
4999 when we are finished with the glyph property value. */
5000 push_it (it
, position
);
5002 it
->area
= TEXT_AREA
;
5003 it
->what
= IT_IMAGE
;
5004 it
->image_id
= -1; /* no image */
5005 it
->position
= start_pos
;
5006 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5007 it
->method
= GET_FROM_IMAGE
;
5008 it
->from_overlay
= Qnil
;
5009 it
->face_id
= face_id
;
5010 it
->from_disp_prop_p
= true;
5012 /* Say that we haven't consumed the characters with
5013 `display' property yet. The call to pop_it in
5014 set_iterator_to_next will clean this up. */
5015 *position
= start_pos
;
5017 if (EQ (XCAR (spec
), Qleft_fringe
))
5019 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5020 it
->left_user_fringe_face_id
= face_id
;
5024 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5025 it
->right_user_fringe_face_id
= face_id
;
5028 #endif /* HAVE_WINDOW_SYSTEM */
5032 /* Prepare to handle `((margin left-margin) ...)',
5033 `((margin right-margin) ...)' and `((margin nil) ...)'
5034 prefixes for display specifications. */
5035 location
= Qunbound
;
5036 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5040 value
= XCDR (spec
);
5042 value
= XCAR (value
);
5045 if (EQ (XCAR (tem
), Qmargin
)
5046 && (tem
= XCDR (tem
),
5047 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5049 || EQ (tem
, Qleft_margin
)
5050 || EQ (tem
, Qright_margin
))))
5054 if (EQ (location
, Qunbound
))
5060 /* After this point, VALUE is the property after any
5061 margin prefix has been stripped. It must be a string,
5062 an image specification, or `(space ...)'.
5064 LOCATION specifies where to display: `left-margin',
5065 `right-margin' or nil. */
5067 bool valid_p
= (STRINGP (value
)
5068 #ifdef HAVE_WINDOW_SYSTEM
5069 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5070 && valid_image_p (value
))
5071 #endif /* not HAVE_WINDOW_SYSTEM */
5072 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5074 if (valid_p
&& display_replaced
== 0)
5080 /* Callers need to know whether the display spec is any kind
5081 of `(space ...)' spec that is about to affect text-area
5083 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5088 /* Save current settings of IT so that we can restore them
5089 when we are finished with the glyph property value. */
5090 push_it (it
, position
);
5091 it
->from_overlay
= overlay
;
5092 it
->from_disp_prop_p
= true;
5094 if (NILP (location
))
5095 it
->area
= TEXT_AREA
;
5096 else if (EQ (location
, Qleft_margin
))
5097 it
->area
= LEFT_MARGIN_AREA
;
5099 it
->area
= RIGHT_MARGIN_AREA
;
5101 if (STRINGP (value
))
5104 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5105 it
->current
.overlay_string_index
= -1;
5106 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5107 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5108 it
->method
= GET_FROM_STRING
;
5109 it
->stop_charpos
= 0;
5111 it
->base_level_stop
= 0;
5112 it
->string_from_display_prop_p
= true;
5113 /* Say that we haven't consumed the characters with
5114 `display' property yet. The call to pop_it in
5115 set_iterator_to_next will clean this up. */
5116 if (BUFFERP (object
))
5117 *position
= start_pos
;
5119 /* Force paragraph direction to be that of the parent
5120 object. If the parent object's paragraph direction is
5121 not yet determined, default to L2R. */
5122 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5123 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5125 it
->paragraph_embedding
= L2R
;
5127 /* Set up the bidi iterator for this display string. */
5130 it
->bidi_it
.string
.lstring
= it
->string
;
5131 it
->bidi_it
.string
.s
= NULL
;
5132 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5133 it
->bidi_it
.string
.bufpos
= bufpos
;
5134 it
->bidi_it
.string
.from_disp_str
= true;
5135 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5136 it
->bidi_it
.w
= it
->w
;
5137 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5140 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5142 it
->method
= GET_FROM_STRETCH
;
5144 *position
= it
->position
= start_pos
;
5145 retval
= 1 + (it
->area
== TEXT_AREA
);
5147 #ifdef HAVE_WINDOW_SYSTEM
5150 it
->what
= IT_IMAGE
;
5151 it
->image_id
= lookup_image (it
->f
, value
);
5152 it
->position
= start_pos
;
5153 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5154 it
->method
= GET_FROM_IMAGE
;
5156 /* Say that we haven't consumed the characters with
5157 `display' property yet. The call to pop_it in
5158 set_iterator_to_next will clean this up. */
5159 *position
= start_pos
;
5161 #endif /* HAVE_WINDOW_SYSTEM */
5166 /* Invalid property or property not supported. Restore
5167 POSITION to what it was before. */
5168 *position
= start_pos
;
5172 /* Check if PROP is a display property value whose text should be
5173 treated as intangible. OVERLAY is the overlay from which PROP
5174 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5175 specify the buffer position covered by PROP. */
5178 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5179 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5181 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5182 struct text_pos position
;
5184 SET_TEXT_POS (position
, charpos
, bytepos
);
5185 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5186 &position
, charpos
, frame_window_p
)
5191 /* Return true if PROP is a display sub-property value containing STRING.
5193 Implementation note: this and the following function are really
5194 special cases of handle_display_spec and
5195 handle_single_display_spec, and should ideally use the same code.
5196 Until they do, these two pairs must be consistent and must be
5197 modified in sync. */
5200 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5202 if (EQ (string
, prop
))
5205 /* Skip over `when FORM'. */
5206 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5211 /* Actually, the condition following `when' should be eval'ed,
5212 like handle_single_display_spec does, and we should return
5213 false if it evaluates to nil. However, this function is
5214 called only when the buffer was already displayed and some
5215 glyph in the glyph matrix was found to come from a display
5216 string. Therefore, the condition was already evaluated, and
5217 the result was non-nil, otherwise the display string wouldn't
5218 have been displayed and we would have never been called for
5219 this property. Thus, we can skip the evaluation and assume
5220 its result is non-nil. */
5225 /* Skip over `margin LOCATION'. */
5226 if (EQ (XCAR (prop
), Qmargin
))
5237 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5241 /* Return true if STRING appears in the `display' property PROP. */
5244 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5247 && !EQ (XCAR (prop
), Qwhen
)
5248 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5250 /* A list of sub-properties. */
5251 while (CONSP (prop
))
5253 if (single_display_spec_string_p (XCAR (prop
), string
))
5258 else if (VECTORP (prop
))
5260 /* A vector of sub-properties. */
5262 for (i
= 0; i
< ASIZE (prop
); ++i
)
5263 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5267 return single_display_spec_string_p (prop
, string
);
5272 /* Look for STRING in overlays and text properties in the current
5273 buffer, between character positions FROM and TO (excluding TO).
5274 BACK_P means look back (in this case, TO is supposed to be
5276 Value is the first character position where STRING was found, or
5277 zero if it wasn't found before hitting TO.
5279 This function may only use code that doesn't eval because it is
5280 called asynchronously from note_mouse_highlight. */
5283 string_buffer_position_lim (Lisp_Object string
,
5284 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5286 Lisp_Object limit
, prop
, pos
;
5289 pos
= make_number (max (from
, BEGV
));
5291 if (!back_p
) /* looking forward */
5293 limit
= make_number (min (to
, ZV
));
5294 while (!found
&& !EQ (pos
, limit
))
5296 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5297 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5300 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5304 else /* looking back */
5306 limit
= make_number (max (to
, BEGV
));
5307 while (!found
&& !EQ (pos
, limit
))
5309 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5310 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5313 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5318 return found
? XINT (pos
) : 0;
5321 /* Determine which buffer position in current buffer STRING comes from.
5322 AROUND_CHARPOS is an approximate position where it could come from.
5323 Value is the buffer position or 0 if it couldn't be determined.
5325 This function is necessary because we don't record buffer positions
5326 in glyphs generated from strings (to keep struct glyph small).
5327 This function may only use code that doesn't eval because it is
5328 called asynchronously from note_mouse_highlight. */
5331 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5333 const int MAX_DISTANCE
= 1000;
5334 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5335 around_charpos
+ MAX_DISTANCE
,
5339 found
= string_buffer_position_lim (string
, around_charpos
,
5340 around_charpos
- MAX_DISTANCE
, true);
5346 /***********************************************************************
5347 `composition' property
5348 ***********************************************************************/
5350 /* Set up iterator IT from `composition' property at its current
5351 position. Called from handle_stop. */
5353 static enum prop_handled
5354 handle_composition_prop (struct it
*it
)
5356 Lisp_Object prop
, string
;
5357 ptrdiff_t pos
, pos_byte
, start
, end
;
5359 if (STRINGP (it
->string
))
5363 pos
= IT_STRING_CHARPOS (*it
);
5364 pos_byte
= IT_STRING_BYTEPOS (*it
);
5365 string
= it
->string
;
5366 s
= SDATA (string
) + pos_byte
;
5367 it
->c
= STRING_CHAR (s
);
5371 pos
= IT_CHARPOS (*it
);
5372 pos_byte
= IT_BYTEPOS (*it
);
5374 it
->c
= FETCH_CHAR (pos_byte
);
5377 /* If there's a valid composition and point is not inside of the
5378 composition (in the case that the composition is from the current
5379 buffer), draw a glyph composed from the composition components. */
5380 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5381 && composition_valid_p (start
, end
, prop
)
5382 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5385 /* As we can't handle this situation (perhaps font-lock added
5386 a new composition), we just return here hoping that next
5387 redisplay will detect this composition much earlier. */
5388 return HANDLED_NORMALLY
;
5391 if (STRINGP (it
->string
))
5392 pos_byte
= string_char_to_byte (it
->string
, start
);
5394 pos_byte
= CHAR_TO_BYTE (start
);
5396 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5399 if (it
->cmp_it
.id
>= 0)
5402 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5403 it
->cmp_it
.nglyphs
= -1;
5407 return HANDLED_NORMALLY
;
5412 /***********************************************************************
5414 ***********************************************************************/
5416 /* The following structure is used to record overlay strings for
5417 later sorting in load_overlay_strings. */
5419 struct overlay_entry
5421 Lisp_Object overlay
;
5424 bool after_string_p
;
5428 /* Set up iterator IT from overlay strings at its current position.
5429 Called from handle_stop. */
5431 static enum prop_handled
5432 handle_overlay_change (struct it
*it
)
5434 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5435 return HANDLED_RECOMPUTE_PROPS
;
5437 return HANDLED_NORMALLY
;
5441 /* Set up the next overlay string for delivery by IT, if there is an
5442 overlay string to deliver. Called by set_iterator_to_next when the
5443 end of the current overlay string is reached. If there are more
5444 overlay strings to display, IT->string and
5445 IT->current.overlay_string_index are set appropriately here.
5446 Otherwise IT->string is set to nil. */
5449 next_overlay_string (struct it
*it
)
5451 ++it
->current
.overlay_string_index
;
5452 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5454 /* No more overlay strings. Restore IT's settings to what
5455 they were before overlay strings were processed, and
5456 continue to deliver from current_buffer. */
5458 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5461 || (NILP (it
->string
)
5462 && it
->method
== GET_FROM_BUFFER
5463 && it
->stop_charpos
>= BEGV
5464 && it
->stop_charpos
<= it
->end_charpos
));
5465 it
->current
.overlay_string_index
= -1;
5466 it
->n_overlay_strings
= 0;
5467 /* If there's an empty display string on the stack, pop the
5468 stack, to resync the bidi iterator with IT's position. Such
5469 empty strings are pushed onto the stack in
5470 get_overlay_strings_1. */
5471 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5474 /* Since we've exhausted overlay strings at this buffer
5475 position, set the flag to ignore overlays until we move to
5476 another position. The flag is reset in
5477 next_element_from_buffer. */
5478 it
->ignore_overlay_strings_at_pos_p
= true;
5480 /* If we're at the end of the buffer, record that we have
5481 processed the overlay strings there already, so that
5482 next_element_from_buffer doesn't try it again. */
5483 if (NILP (it
->string
)
5484 && IT_CHARPOS (*it
) >= it
->end_charpos
5485 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5486 it
->overlay_strings_at_end_processed_p
= true;
5487 /* Note: we reset overlay_strings_charpos only here, to make
5488 sure the just-processed overlays were indeed at EOB.
5489 Otherwise, overlays on text with invisible text property,
5490 which are processed with IT's position past the invisible
5491 text, might fool us into thinking the overlays at EOB were
5492 already processed (linum-mode can cause this, for
5494 it
->overlay_strings_charpos
= -1;
5498 /* There are more overlay strings to process. If
5499 IT->current.overlay_string_index has advanced to a position
5500 where we must load IT->overlay_strings with more strings, do
5501 it. We must load at the IT->overlay_strings_charpos where
5502 IT->n_overlay_strings was originally computed; when invisible
5503 text is present, this might not be IT_CHARPOS (Bug#7016). */
5504 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5506 if (it
->current
.overlay_string_index
&& i
== 0)
5507 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5509 /* Initialize IT to deliver display elements from the overlay
5511 it
->string
= it
->overlay_strings
[i
];
5512 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5513 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5514 it
->method
= GET_FROM_STRING
;
5515 it
->stop_charpos
= 0;
5516 it
->end_charpos
= SCHARS (it
->string
);
5517 if (it
->cmp_it
.stop_pos
>= 0)
5518 it
->cmp_it
.stop_pos
= 0;
5520 it
->base_level_stop
= 0;
5522 /* Set up the bidi iterator for this overlay string. */
5525 it
->bidi_it
.string
.lstring
= it
->string
;
5526 it
->bidi_it
.string
.s
= NULL
;
5527 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5528 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5529 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5530 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5531 it
->bidi_it
.w
= it
->w
;
5532 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5540 /* Compare two overlay_entry structures E1 and E2. Used as a
5541 comparison function for qsort in load_overlay_strings. Overlay
5542 strings for the same position are sorted so that
5544 1. All after-strings come in front of before-strings, except
5545 when they come from the same overlay.
5547 2. Within after-strings, strings are sorted so that overlay strings
5548 from overlays with higher priorities come first.
5550 2. Within before-strings, strings are sorted so that overlay
5551 strings from overlays with higher priorities come last.
5553 Value is analogous to strcmp. */
5557 compare_overlay_entries (const void *e1
, const void *e2
)
5559 struct overlay_entry
const *entry1
= e1
;
5560 struct overlay_entry
const *entry2
= e2
;
5563 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5565 /* Let after-strings appear in front of before-strings if
5566 they come from different overlays. */
5567 if (EQ (entry1
->overlay
, entry2
->overlay
))
5568 result
= entry1
->after_string_p
? 1 : -1;
5570 result
= entry1
->after_string_p
? -1 : 1;
5572 else if (entry1
->priority
!= entry2
->priority
)
5574 if (entry1
->after_string_p
)
5575 /* After-strings sorted in order of decreasing priority. */
5576 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5578 /* Before-strings sorted in order of increasing priority. */
5579 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5588 /* Load the vector IT->overlay_strings with overlay strings from IT's
5589 current buffer position, or from CHARPOS if that is > 0. Set
5590 IT->n_overlays to the total number of overlay strings found.
5592 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5593 a time. On entry into load_overlay_strings,
5594 IT->current.overlay_string_index gives the number of overlay
5595 strings that have already been loaded by previous calls to this
5598 IT->add_overlay_start contains an additional overlay start
5599 position to consider for taking overlay strings from, if non-zero.
5600 This position comes into play when the overlay has an `invisible'
5601 property, and both before and after-strings. When we've skipped to
5602 the end of the overlay, because of its `invisible' property, we
5603 nevertheless want its before-string to appear.
5604 IT->add_overlay_start will contain the overlay start position
5607 Overlay strings are sorted so that after-string strings come in
5608 front of before-string strings. Within before and after-strings,
5609 strings are sorted by overlay priority. See also function
5610 compare_overlay_entries. */
5613 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5615 Lisp_Object overlay
, window
, str
, invisible
;
5616 struct Lisp_Overlay
*ov
;
5617 ptrdiff_t start
, end
;
5618 ptrdiff_t n
= 0, i
, j
;
5620 struct overlay_entry entriesbuf
[20];
5621 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5622 struct overlay_entry
*entries
= entriesbuf
;
5626 charpos
= IT_CHARPOS (*it
);
5628 /* Append the overlay string STRING of overlay OVERLAY to vector
5629 `entries' which has size `size' and currently contains `n'
5630 elements. AFTER_P means STRING is an after-string of
5632 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5635 Lisp_Object priority; \
5639 struct overlay_entry *old = entries; \
5640 SAFE_NALLOCA (entries, 2, size); \
5641 memcpy (entries, old, size * sizeof *entries); \
5645 entries[n].string = (STRING); \
5646 entries[n].overlay = (OVERLAY); \
5647 priority = Foverlay_get ((OVERLAY), Qpriority); \
5648 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5649 entries[n].after_string_p = (AFTER_P); \
5654 /* Process overlay before the overlay center. */
5655 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5657 XSETMISC (overlay
, ov
);
5658 eassert (OVERLAYP (overlay
));
5659 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5660 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5665 /* Skip this overlay if it doesn't start or end at IT's current
5667 if (end
!= charpos
&& start
!= charpos
)
5670 /* Skip this overlay if it doesn't apply to IT->w. */
5671 window
= Foverlay_get (overlay
, Qwindow
);
5672 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5675 /* If the text ``under'' the overlay is invisible, both before-
5676 and after-strings from this overlay are visible; start and
5677 end position are indistinguishable. */
5678 invisible
= Foverlay_get (overlay
, Qinvisible
);
5679 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5681 /* If overlay has a non-empty before-string, record it. */
5682 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5683 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5685 RECORD_OVERLAY_STRING (overlay
, str
, false);
5687 /* If overlay has a non-empty after-string, record it. */
5688 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5689 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5691 RECORD_OVERLAY_STRING (overlay
, str
, true);
5694 /* Process overlays after the overlay center. */
5695 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5697 XSETMISC (overlay
, ov
);
5698 eassert (OVERLAYP (overlay
));
5699 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5700 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5702 if (start
> charpos
)
5705 /* Skip this overlay if it doesn't start or end at IT's current
5707 if (end
!= charpos
&& start
!= charpos
)
5710 /* Skip this overlay if it doesn't apply to IT->w. */
5711 window
= Foverlay_get (overlay
, Qwindow
);
5712 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5715 /* If the text ``under'' the overlay is invisible, it has a zero
5716 dimension, and both before- and after-strings apply. */
5717 invisible
= Foverlay_get (overlay
, Qinvisible
);
5718 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5720 /* If overlay has a non-empty before-string, record it. */
5721 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5722 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5724 RECORD_OVERLAY_STRING (overlay
, str
, false);
5726 /* If overlay has a non-empty after-string, record it. */
5727 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5728 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5730 RECORD_OVERLAY_STRING (overlay
, str
, true);
5733 #undef RECORD_OVERLAY_STRING
5737 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5739 /* Record number of overlay strings, and where we computed it. */
5740 it
->n_overlay_strings
= n
;
5741 it
->overlay_strings_charpos
= charpos
;
5743 /* IT->current.overlay_string_index is the number of overlay strings
5744 that have already been consumed by IT. Copy some of the
5745 remaining overlay strings to IT->overlay_strings. */
5747 j
= it
->current
.overlay_string_index
;
5748 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5750 it
->overlay_strings
[i
] = entries
[j
].string
;
5751 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5759 /* Get the first chunk of overlay strings at IT's current buffer
5760 position, or at CHARPOS if that is > 0. Value is true if at
5761 least one overlay string was found. */
5764 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5766 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5767 process. This fills IT->overlay_strings with strings, and sets
5768 IT->n_overlay_strings to the total number of strings to process.
5769 IT->pos.overlay_string_index has to be set temporarily to zero
5770 because load_overlay_strings needs this; it must be set to -1
5771 when no overlay strings are found because a zero value would
5772 indicate a position in the first overlay string. */
5773 it
->current
.overlay_string_index
= 0;
5774 load_overlay_strings (it
, charpos
);
5776 /* If we found overlay strings, set up IT to deliver display
5777 elements from the first one. Otherwise set up IT to deliver
5778 from current_buffer. */
5779 if (it
->n_overlay_strings
)
5781 /* Make sure we know settings in current_buffer, so that we can
5782 restore meaningful values when we're done with the overlay
5785 compute_stop_pos (it
);
5786 eassert (it
->face_id
>= 0);
5788 /* Save IT's settings. They are restored after all overlay
5789 strings have been processed. */
5790 eassert (!compute_stop_p
|| it
->sp
== 0);
5792 /* When called from handle_stop, there might be an empty display
5793 string loaded. In that case, don't bother saving it. But
5794 don't use this optimization with the bidi iterator, since we
5795 need the corresponding pop_it call to resync the bidi
5796 iterator's position with IT's position, after we are done
5797 with the overlay strings. (The corresponding call to pop_it
5798 in case of an empty display string is in
5799 next_overlay_string.) */
5801 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5804 /* Set up IT to deliver display elements from the first overlay
5806 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5807 it
->string
= it
->overlay_strings
[0];
5808 it
->from_overlay
= Qnil
;
5809 it
->stop_charpos
= 0;
5810 eassert (STRINGP (it
->string
));
5811 it
->end_charpos
= SCHARS (it
->string
);
5813 it
->base_level_stop
= 0;
5814 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5815 it
->method
= GET_FROM_STRING
;
5816 it
->from_disp_prop_p
= 0;
5818 /* Force paragraph direction to be that of the parent
5820 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5821 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5823 it
->paragraph_embedding
= L2R
;
5825 /* Set up the bidi iterator for this overlay string. */
5828 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5830 it
->bidi_it
.string
.lstring
= it
->string
;
5831 it
->bidi_it
.string
.s
= NULL
;
5832 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5833 it
->bidi_it
.string
.bufpos
= pos
;
5834 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5835 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5836 it
->bidi_it
.w
= it
->w
;
5837 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5842 it
->current
.overlay_string_index
= -1;
5847 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5850 it
->method
= GET_FROM_BUFFER
;
5852 get_overlay_strings_1 (it
, charpos
, true);
5856 /* Value is true if we found at least one overlay string. */
5857 return STRINGP (it
->string
);
5862 /***********************************************************************
5863 Saving and restoring state
5864 ***********************************************************************/
5866 /* Save current settings of IT on IT->stack. Called, for example,
5867 before setting up IT for an overlay string, to be able to restore
5868 IT's settings to what they were after the overlay string has been
5869 processed. If POSITION is non-NULL, it is the position to save on
5870 the stack instead of IT->position. */
5873 push_it (struct it
*it
, struct text_pos
*position
)
5875 struct iterator_stack_entry
*p
;
5877 eassert (it
->sp
< IT_STACK_SIZE
);
5878 p
= it
->stack
+ it
->sp
;
5880 p
->stop_charpos
= it
->stop_charpos
;
5881 p
->prev_stop
= it
->prev_stop
;
5882 p
->base_level_stop
= it
->base_level_stop
;
5883 p
->cmp_it
= it
->cmp_it
;
5884 eassert (it
->face_id
>= 0);
5885 p
->face_id
= it
->face_id
;
5886 p
->string
= it
->string
;
5887 p
->method
= it
->method
;
5888 p
->from_overlay
= it
->from_overlay
;
5891 case GET_FROM_IMAGE
:
5892 p
->u
.image
.object
= it
->object
;
5893 p
->u
.image
.image_id
= it
->image_id
;
5894 p
->u
.image
.slice
= it
->slice
;
5896 case GET_FROM_STRETCH
:
5897 p
->u
.stretch
.object
= it
->object
;
5900 p
->position
= position
? *position
: it
->position
;
5901 p
->current
= it
->current
;
5902 p
->end_charpos
= it
->end_charpos
;
5903 p
->string_nchars
= it
->string_nchars
;
5905 p
->multibyte_p
= it
->multibyte_p
;
5906 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5907 p
->space_width
= it
->space_width
;
5908 p
->font_height
= it
->font_height
;
5909 p
->voffset
= it
->voffset
;
5910 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5911 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5912 p
->display_ellipsis_p
= false;
5913 p
->line_wrap
= it
->line_wrap
;
5914 p
->bidi_p
= it
->bidi_p
;
5915 p
->paragraph_embedding
= it
->paragraph_embedding
;
5916 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5919 /* Save the state of the bidi iterator as well. */
5921 bidi_push_it (&it
->bidi_it
);
5925 iterate_out_of_display_property (struct it
*it
)
5927 bool buffer_p
= !STRINGP (it
->string
);
5928 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5929 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5931 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5933 /* Maybe initialize paragraph direction. If we are at the beginning
5934 of a new paragraph, next_element_from_buffer may not have a
5935 chance to do that. */
5936 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5937 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5938 /* prev_stop can be zero, so check against BEGV as well. */
5939 while (it
->bidi_it
.charpos
>= bob
5940 && it
->prev_stop
<= it
->bidi_it
.charpos
5941 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5942 && it
->bidi_it
.charpos
< eob
)
5943 bidi_move_to_visually_next (&it
->bidi_it
);
5944 /* Record the stop_pos we just crossed, for when we cross it
5946 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5947 it
->prev_stop
= CHARPOS (it
->position
);
5948 /* If we ended up not where pop_it put us, resync IT's
5949 positional members with the bidi iterator. */
5950 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5951 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5953 it
->current
.pos
= it
->position
;
5955 it
->current
.string_pos
= it
->position
;
5958 /* Restore IT's settings from IT->stack. Called, for example, when no
5959 more overlay strings must be processed, and we return to delivering
5960 display elements from a buffer, or when the end of a string from a
5961 `display' property is reached and we return to delivering display
5962 elements from an overlay string, or from a buffer. */
5965 pop_it (struct it
*it
)
5967 struct iterator_stack_entry
*p
;
5968 bool from_display_prop
= it
->from_disp_prop_p
;
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
));
6061 /***********************************************************************
6063 ***********************************************************************/
6065 /* Set IT's current position to the previous line start. */
6068 back_to_previous_line_start (struct it
*it
)
6070 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6073 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6077 /* Move IT to the next line start.
6079 Value is true if a newline was found. Set *SKIPPED_P to true if
6080 we skipped over part of the text (as opposed to moving the iterator
6081 continuously over the text). Otherwise, don't change the value
6084 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6085 iterator on the newline, if it was found.
6087 Newlines may come from buffer text, overlay strings, or strings
6088 displayed via the `display' property. That's the reason we can't
6089 simply use find_newline_no_quit.
6091 Note that this function may not skip over invisible text that is so
6092 because of text properties and immediately follows a newline. If
6093 it would, function reseat_at_next_visible_line_start, when called
6094 from set_iterator_to_next, would effectively make invisible
6095 characters following a newline part of the wrong glyph row, which
6096 leads to wrong cursor motion. */
6099 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6100 struct bidi_it
*bidi_it_prev
)
6102 ptrdiff_t old_selective
;
6103 bool newline_found_p
= false;
6105 const int MAX_NEWLINE_DISTANCE
= 500;
6107 /* If already on a newline, just consume it to avoid unintended
6108 skipping over invisible text below. */
6109 if (it
->what
== IT_CHARACTER
6111 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6113 if (it
->bidi_p
&& bidi_it_prev
)
6114 *bidi_it_prev
= it
->bidi_it
;
6115 set_iterator_to_next (it
, false);
6120 /* Don't handle selective display in the following. It's (a)
6121 unnecessary because it's done by the caller, and (b) leads to an
6122 infinite recursion because next_element_from_ellipsis indirectly
6123 calls this function. */
6124 old_selective
= it
->selective
;
6127 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6128 from buffer text. */
6130 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6131 n
+= !STRINGP (it
->string
))
6133 if (!get_next_display_element (it
))
6135 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6136 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6137 *bidi_it_prev
= it
->bidi_it
;
6138 set_iterator_to_next (it
, false);
6141 /* If we didn't find a newline near enough, see if we can use a
6143 if (!newline_found_p
)
6145 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6146 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6150 eassert (!STRINGP (it
->string
));
6152 /* If there isn't any `display' property in sight, and no
6153 overlays, we can just use the position of the newline in
6155 if (it
->stop_charpos
>= limit
6156 || ((pos
= Fnext_single_property_change (make_number (start
),
6158 make_number (limit
)),
6160 && next_overlay_change (start
) == ZV
))
6164 IT_CHARPOS (*it
) = limit
;
6165 IT_BYTEPOS (*it
) = bytepos
;
6169 struct bidi_it bprev
;
6171 /* Help bidi.c avoid expensive searches for display
6172 properties and overlays, by telling it that there are
6173 none up to `limit'. */
6174 if (it
->bidi_it
.disp_pos
< limit
)
6176 it
->bidi_it
.disp_pos
= limit
;
6177 it
->bidi_it
.disp_prop
= 0;
6180 bprev
= it
->bidi_it
;
6181 bidi_move_to_visually_next (&it
->bidi_it
);
6182 } while (it
->bidi_it
.charpos
!= limit
);
6183 IT_CHARPOS (*it
) = limit
;
6184 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6186 *bidi_it_prev
= bprev
;
6188 *skipped_p
= newline_found_p
= true;
6192 while (get_next_display_element (it
)
6193 && !newline_found_p
)
6195 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6196 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6197 *bidi_it_prev
= it
->bidi_it
;
6198 set_iterator_to_next (it
, false);
6203 it
->selective
= old_selective
;
6204 return newline_found_p
;
6208 /* Set IT's current position to the previous visible line start. Skip
6209 invisible text that is so either due to text properties or due to
6210 selective display. Caution: this does not change IT->current_x and
6214 back_to_previous_visible_line_start (struct it
*it
)
6216 while (IT_CHARPOS (*it
) > BEGV
)
6218 back_to_previous_line_start (it
);
6220 if (IT_CHARPOS (*it
) <= BEGV
)
6223 /* If selective > 0, then lines indented more than its value are
6225 if (it
->selective
> 0
6226 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6230 /* Check the newline before point for invisibility. */
6233 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6234 Qinvisible
, it
->window
);
6235 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6239 if (IT_CHARPOS (*it
) <= BEGV
)
6244 void *it2data
= NULL
;
6247 Lisp_Object val
, overlay
;
6249 SAVE_IT (it2
, *it
, it2data
);
6251 /* If newline is part of a composition, continue from start of composition */
6252 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6253 && beg
< IT_CHARPOS (*it
))
6256 /* If newline is replaced by a display property, find start of overlay
6257 or interval and continue search from that point. */
6258 pos
= --IT_CHARPOS (it2
);
6261 bidi_unshelve_cache (NULL
, false);
6262 it2
.string_from_display_prop_p
= false;
6263 it2
.from_disp_prop_p
= false;
6264 if (handle_display_prop (&it2
) == HANDLED_RETURN
6265 && !NILP (val
= get_char_property_and_overlay
6266 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6267 && (OVERLAYP (overlay
)
6268 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6269 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6271 RESTORE_IT (it
, it
, it2data
);
6275 /* Newline is not replaced by anything -- so we are done. */
6276 RESTORE_IT (it
, it
, it2data
);
6282 IT_CHARPOS (*it
) = beg
;
6283 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6287 it
->continuation_lines_width
= 0;
6289 eassert (IT_CHARPOS (*it
) >= BEGV
);
6290 eassert (IT_CHARPOS (*it
) == BEGV
6291 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6296 /* Reseat iterator IT at the previous visible line start. Skip
6297 invisible text that is so either due to text properties or due to
6298 selective display. At the end, update IT's overlay information,
6299 face information etc. */
6302 reseat_at_previous_visible_line_start (struct it
*it
)
6304 back_to_previous_visible_line_start (it
);
6305 reseat (it
, it
->current
.pos
, true);
6310 /* Reseat iterator IT on the next visible line start in the current
6311 buffer. ON_NEWLINE_P means position IT on the newline
6312 preceding the line start. Skip over invisible text that is so
6313 because of selective display. Compute faces, overlays etc at the
6314 new position. Note that this function does not skip over text that
6315 is invisible because of text properties. */
6318 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6320 bool skipped_p
= false;
6321 struct bidi_it bidi_it_prev
;
6322 bool newline_found_p
6323 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6325 /* Skip over lines that are invisible because they are indented
6326 more than the value of IT->selective. */
6327 if (it
->selective
> 0)
6328 while (IT_CHARPOS (*it
) < ZV
6329 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6332 eassert (IT_BYTEPOS (*it
) == BEGV
6333 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6335 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6338 /* Position on the newline if that's what's requested. */
6339 if (on_newline_p
&& newline_found_p
)
6341 if (STRINGP (it
->string
))
6343 if (IT_STRING_CHARPOS (*it
) > 0)
6347 --IT_STRING_CHARPOS (*it
);
6348 --IT_STRING_BYTEPOS (*it
);
6352 /* We need to restore the bidi iterator to the state
6353 it had on the newline, and resync the IT's
6354 position with that. */
6355 it
->bidi_it
= bidi_it_prev
;
6356 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6357 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6361 else if (IT_CHARPOS (*it
) > BEGV
)
6370 /* We need to restore the bidi iterator to the state it
6371 had on the newline and resync IT with that. */
6372 it
->bidi_it
= bidi_it_prev
;
6373 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6374 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6376 reseat (it
, it
->current
.pos
, false);
6380 reseat (it
, it
->current
.pos
, false);
6387 /***********************************************************************
6388 Changing an iterator's position
6389 ***********************************************************************/
6391 /* Change IT's current position to POS in current_buffer.
6392 If FORCE_P, always check for text properties at the new position.
6393 Otherwise, text properties are only looked up if POS >=
6394 IT->check_charpos of a property. */
6397 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6399 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6401 reseat_1 (it
, pos
, false);
6403 /* Determine where to check text properties. Avoid doing it
6404 where possible because text property lookup is very expensive. */
6406 || CHARPOS (pos
) > it
->stop_charpos
6407 || CHARPOS (pos
) < original_pos
)
6411 /* For bidi iteration, we need to prime prev_stop and
6412 base_level_stop with our best estimations. */
6413 /* Implementation note: Of course, POS is not necessarily a
6414 stop position, so assigning prev_pos to it is a lie; we
6415 should have called compute_stop_backwards. However, if
6416 the current buffer does not include any R2L characters,
6417 that call would be a waste of cycles, because the
6418 iterator will never move back, and thus never cross this
6419 "fake" stop position. So we delay that backward search
6420 until the time we really need it, in next_element_from_buffer. */
6421 if (CHARPOS (pos
) != it
->prev_stop
)
6422 it
->prev_stop
= CHARPOS (pos
);
6423 if (CHARPOS (pos
) < it
->base_level_stop
)
6424 it
->base_level_stop
= 0; /* meaning it's unknown */
6430 it
->prev_stop
= it
->base_level_stop
= 0;
6439 /* Change IT's buffer position to POS. SET_STOP_P means set
6440 IT->stop_pos to POS, also. */
6443 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6445 /* Don't call this function when scanning a C string. */
6446 eassert (it
->s
== NULL
);
6448 /* POS must be a reasonable value. */
6449 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6451 it
->current
.pos
= it
->position
= pos
;
6452 it
->end_charpos
= ZV
;
6454 it
->current
.dpvec_index
= -1;
6455 it
->current
.overlay_string_index
= -1;
6456 IT_STRING_CHARPOS (*it
) = -1;
6457 IT_STRING_BYTEPOS (*it
) = -1;
6459 it
->method
= GET_FROM_BUFFER
;
6460 it
->object
= it
->w
->contents
;
6461 it
->area
= TEXT_AREA
;
6462 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6464 it
->string_from_display_prop_p
= false;
6465 it
->string_from_prefix_prop_p
= false;
6467 it
->from_disp_prop_p
= false;
6468 it
->face_before_selective_p
= false;
6471 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6473 bidi_unshelve_cache (NULL
, false);
6474 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6475 it
->bidi_it
.string
.s
= NULL
;
6476 it
->bidi_it
.string
.lstring
= Qnil
;
6477 it
->bidi_it
.string
.bufpos
= 0;
6478 it
->bidi_it
.string
.from_disp_str
= false;
6479 it
->bidi_it
.string
.unibyte
= false;
6480 it
->bidi_it
.w
= it
->w
;
6485 it
->stop_charpos
= CHARPOS (pos
);
6486 it
->base_level_stop
= CHARPOS (pos
);
6488 /* This make the information stored in it->cmp_it invalidate. */
6493 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6494 If S is non-null, it is a C string to iterate over. Otherwise,
6495 STRING gives a Lisp string to iterate over.
6497 If PRECISION > 0, don't return more then PRECISION number of
6498 characters from the string.
6500 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6501 characters have been returned. FIELD_WIDTH < 0 means an infinite
6504 MULTIBYTE = 0 means disable processing of multibyte characters,
6505 MULTIBYTE > 0 means enable it,
6506 MULTIBYTE < 0 means use IT->multibyte_p.
6508 IT must be initialized via a prior call to init_iterator before
6509 calling this function. */
6512 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6513 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6516 /* No text property checks performed by default, but see below. */
6517 it
->stop_charpos
= -1;
6519 /* Set iterator position and end position. */
6520 memset (&it
->current
, 0, sizeof it
->current
);
6521 it
->current
.overlay_string_index
= -1;
6522 it
->current
.dpvec_index
= -1;
6523 eassert (charpos
>= 0);
6525 /* If STRING is specified, use its multibyteness, otherwise use the
6526 setting of MULTIBYTE, if specified. */
6528 it
->multibyte_p
= multibyte
> 0;
6530 /* Bidirectional reordering of strings is controlled by the default
6531 value of bidi-display-reordering. Don't try to reorder while
6532 loading loadup.el, as the necessary character property tables are
6533 not yet available. */
6536 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6540 eassert (STRINGP (string
));
6541 it
->string
= string
;
6543 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6544 it
->method
= GET_FROM_STRING
;
6545 it
->current
.string_pos
= string_pos (charpos
, string
);
6549 it
->bidi_it
.string
.lstring
= string
;
6550 it
->bidi_it
.string
.s
= NULL
;
6551 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6552 it
->bidi_it
.string
.bufpos
= 0;
6553 it
->bidi_it
.string
.from_disp_str
= false;
6554 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6555 it
->bidi_it
.w
= it
->w
;
6556 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6557 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6562 it
->s
= (const unsigned char *) s
;
6565 /* Note that we use IT->current.pos, not it->current.string_pos,
6566 for displaying C strings. */
6567 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6568 if (it
->multibyte_p
)
6570 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6571 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6575 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6576 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6581 it
->bidi_it
.string
.lstring
= Qnil
;
6582 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6583 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6584 it
->bidi_it
.string
.bufpos
= 0;
6585 it
->bidi_it
.string
.from_disp_str
= false;
6586 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6587 it
->bidi_it
.w
= it
->w
;
6588 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6591 it
->method
= GET_FROM_C_STRING
;
6594 /* PRECISION > 0 means don't return more than PRECISION characters
6596 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6598 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6600 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6603 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6604 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6605 FIELD_WIDTH < 0 means infinite field width. This is useful for
6606 padding with `-' at the end of a mode line. */
6607 if (field_width
< 0)
6608 field_width
= INFINITY
;
6609 /* Implementation note: We deliberately don't enlarge
6610 it->bidi_it.string.schars here to fit it->end_charpos, because
6611 the bidi iterator cannot produce characters out of thin air. */
6612 if (field_width
> it
->end_charpos
- charpos
)
6613 it
->end_charpos
= charpos
+ field_width
;
6615 /* Use the standard display table for displaying strings. */
6616 if (DISP_TABLE_P (Vstandard_display_table
))
6617 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6619 it
->stop_charpos
= charpos
;
6620 it
->prev_stop
= charpos
;
6621 it
->base_level_stop
= 0;
6624 it
->bidi_it
.first_elt
= true;
6625 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6626 it
->bidi_it
.disp_pos
= -1;
6628 if (s
== NULL
&& it
->multibyte_p
)
6630 ptrdiff_t endpos
= SCHARS (it
->string
);
6631 if (endpos
> it
->end_charpos
)
6632 endpos
= it
->end_charpos
;
6633 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6641 /***********************************************************************
6643 ***********************************************************************/
6645 /* Map enum it_method value to corresponding next_element_from_* function. */
6647 typedef bool (*next_element_function
) (struct it
*);
6649 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6651 next_element_from_buffer
,
6652 next_element_from_display_vector
,
6653 next_element_from_string
,
6654 next_element_from_c_string
,
6655 next_element_from_image
,
6656 next_element_from_stretch
6659 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6662 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6663 (possibly with the following characters). */
6665 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6666 ((IT)->cmp_it.id >= 0 \
6667 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6668 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6669 END_CHARPOS, (IT)->w, \
6670 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6674 /* Lookup the char-table Vglyphless_char_display for character C (-1
6675 if we want information for no-font case), and return the display
6676 method symbol. By side-effect, update it->what and
6677 it->glyphless_method. This function is called from
6678 get_next_display_element for each character element, and from
6679 x_produce_glyphs when no suitable font was found. */
6682 lookup_glyphless_char_display (int c
, struct it
*it
)
6684 Lisp_Object glyphless_method
= Qnil
;
6686 if (CHAR_TABLE_P (Vglyphless_char_display
)
6687 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6691 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6692 if (CONSP (glyphless_method
))
6693 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6694 ? XCAR (glyphless_method
)
6695 : XCDR (glyphless_method
);
6698 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6702 if (NILP (glyphless_method
))
6705 /* The default is to display the character by a proper font. */
6707 /* The default for the no-font case is to display an empty box. */
6708 glyphless_method
= Qempty_box
;
6710 if (EQ (glyphless_method
, Qzero_width
))
6713 return glyphless_method
;
6714 /* This method can't be used for the no-font case. */
6715 glyphless_method
= Qempty_box
;
6717 if (EQ (glyphless_method
, Qthin_space
))
6718 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6719 else if (EQ (glyphless_method
, Qempty_box
))
6720 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6721 else if (EQ (glyphless_method
, Qhex_code
))
6722 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6723 else if (STRINGP (glyphless_method
))
6724 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6727 /* Invalid value. We use the default method. */
6728 glyphless_method
= Qnil
;
6731 it
->what
= IT_GLYPHLESS
;
6732 return glyphless_method
;
6735 /* Merge escape glyph face and cache the result. */
6737 static struct frame
*last_escape_glyph_frame
= NULL
;
6738 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6739 static int last_escape_glyph_merged_face_id
= 0;
6742 merge_escape_glyph_face (struct it
*it
)
6746 if (it
->f
== last_escape_glyph_frame
6747 && it
->face_id
== last_escape_glyph_face_id
)
6748 face_id
= last_escape_glyph_merged_face_id
;
6751 /* Merge the `escape-glyph' face into the current face. */
6752 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6753 last_escape_glyph_frame
= it
->f
;
6754 last_escape_glyph_face_id
= it
->face_id
;
6755 last_escape_glyph_merged_face_id
= face_id
;
6760 /* Likewise for glyphless glyph face. */
6762 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6763 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6764 static int last_glyphless_glyph_merged_face_id
= 0;
6767 merge_glyphless_glyph_face (struct it
*it
)
6771 if (it
->f
== last_glyphless_glyph_frame
6772 && it
->face_id
== last_glyphless_glyph_face_id
)
6773 face_id
= last_glyphless_glyph_merged_face_id
;
6776 /* Merge the `glyphless-char' face into the current face. */
6777 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6778 last_glyphless_glyph_frame
= it
->f
;
6779 last_glyphless_glyph_face_id
= it
->face_id
;
6780 last_glyphless_glyph_merged_face_id
= face_id
;
6785 /* Load IT's display element fields with information about the next
6786 display element from the current position of IT. Value is false if
6787 end of buffer (or C string) is reached. */
6790 get_next_display_element (struct it
*it
)
6792 /* True means that we found a display element. False means that
6793 we hit the end of what we iterate over. Performance note: the
6794 function pointer `method' used here turns out to be faster than
6795 using a sequence of if-statements. */
6799 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6801 if (it
->what
== IT_CHARACTER
)
6803 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6804 and only if (a) the resolved directionality of that character
6806 /* FIXME: Do we need an exception for characters from display
6808 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6809 && !inhibit_bidi_mirroring
)
6810 it
->c
= bidi_mirror_char (it
->c
);
6811 /* Map via display table or translate control characters.
6812 IT->c, IT->len etc. have been set to the next character by
6813 the function call above. If we have a display table, and it
6814 contains an entry for IT->c, translate it. Don't do this if
6815 IT->c itself comes from a display table, otherwise we could
6816 end up in an infinite recursion. (An alternative could be to
6817 count the recursion depth of this function and signal an
6818 error when a certain maximum depth is reached.) Is it worth
6820 if (success_p
&& it
->dpvec
== NULL
)
6823 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6824 bool nonascii_space_p
= false;
6825 bool nonascii_hyphen_p
= false;
6826 int c
= it
->c
; /* This is the character to display. */
6828 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6830 eassert (SINGLE_BYTE_CHAR_P (c
));
6831 if (unibyte_display_via_language_environment
)
6833 c
= DECODE_CHAR (unibyte
, c
);
6835 c
= BYTE8_TO_CHAR (it
->c
);
6838 c
= BYTE8_TO_CHAR (it
->c
);
6842 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6845 struct Lisp_Vector
*v
= XVECTOR (dv
);
6847 /* Return the first character from the display table
6848 entry, if not empty. If empty, don't display the
6849 current character. */
6852 it
->dpvec_char_len
= it
->len
;
6853 it
->dpvec
= v
->contents
;
6854 it
->dpend
= v
->contents
+ v
->header
.size
;
6855 it
->current
.dpvec_index
= 0;
6856 it
->dpvec_face_id
= -1;
6857 it
->saved_face_id
= it
->face_id
;
6858 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6859 it
->ellipsis_p
= false;
6863 set_iterator_to_next (it
, false);
6868 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6870 if (it
->what
== IT_GLYPHLESS
)
6872 /* Don't display this character. */
6873 set_iterator_to_next (it
, false);
6877 /* If `nobreak-char-display' is non-nil, we display
6878 non-ASCII spaces and hyphens specially. */
6879 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6882 nonascii_space_p
= true;
6883 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6884 nonascii_hyphen_p
= true;
6887 /* Translate control characters into `\003' or `^C' form.
6888 Control characters coming from a display table entry are
6889 currently not translated because we use IT->dpvec to hold
6890 the translation. This could easily be changed but I
6891 don't believe that it is worth doing.
6893 The characters handled by `nobreak-char-display' must be
6896 Non-printable characters and raw-byte characters are also
6897 translated to octal form. */
6898 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6899 ? (it
->area
!= TEXT_AREA
6900 /* In mode line, treat \n, \t like other crl chars. */
6903 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6904 || (c
!= '\n' && c
!= '\t'))
6906 || nonascii_hyphen_p
6908 || ! CHAR_PRINTABLE_P (c
))))
6910 /* C is a control character, non-ASCII space/hyphen,
6911 raw-byte, or a non-printable character which must be
6912 displayed either as '\003' or as `^C' where the '\\'
6913 and '^' can be defined in the display table. Fill
6914 IT->ctl_chars with glyphs for what we have to
6915 display. Then, set IT->dpvec to these glyphs. */
6922 /* Handle control characters with ^. */
6924 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6928 g
= '^'; /* default glyph for Control */
6929 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6931 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6933 g
= GLYPH_CODE_CHAR (gc
);
6934 lface_id
= GLYPH_CODE_FACE (gc
);
6938 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6939 : merge_escape_glyph_face (it
));
6941 XSETINT (it
->ctl_chars
[0], g
);
6942 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6944 goto display_control
;
6947 /* Handle non-ascii space in the mode where it only gets
6950 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6952 /* Merge `nobreak-space' into the current face. */
6953 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6955 XSETINT (it
->ctl_chars
[0], ' ');
6957 goto display_control
;
6960 /* Handle sequences that start with the "escape glyph". */
6962 /* the default escape glyph is \. */
6963 escape_glyph
= '\\';
6966 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6968 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6969 lface_id
= GLYPH_CODE_FACE (gc
);
6973 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6974 : merge_escape_glyph_face (it
));
6976 /* Draw non-ASCII hyphen with just highlighting: */
6978 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6980 XSETINT (it
->ctl_chars
[0], '-');
6982 goto display_control
;
6985 /* Draw non-ASCII space/hyphen with escape glyph: */
6987 if (nonascii_space_p
|| nonascii_hyphen_p
)
6989 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6990 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6992 goto display_control
;
6999 if (CHAR_BYTE8_P (c
))
7000 /* Display \200 instead of \17777600. */
7001 c
= CHAR_TO_BYTE8 (c
);
7002 len
= sprintf (str
, "%03o", c
+ 0u);
7004 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7005 for (i
= 0; i
< len
; i
++)
7006 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7011 /* Set up IT->dpvec and return first character from it. */
7012 it
->dpvec_char_len
= it
->len
;
7013 it
->dpvec
= it
->ctl_chars
;
7014 it
->dpend
= it
->dpvec
+ ctl_len
;
7015 it
->current
.dpvec_index
= 0;
7016 it
->dpvec_face_id
= face_id
;
7017 it
->saved_face_id
= it
->face_id
;
7018 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7019 it
->ellipsis_p
= false;
7022 it
->char_to_display
= c
;
7026 it
->char_to_display
= it
->c
;
7030 #ifdef HAVE_WINDOW_SYSTEM
7031 /* Adjust face id for a multibyte character. There are no multibyte
7032 character in unibyte text. */
7033 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7036 && FRAME_WINDOW_P (it
->f
))
7038 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7040 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7042 /* Automatic composition with glyph-string. */
7043 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7045 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7049 ptrdiff_t pos
= (it
->s
? -1
7050 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7051 : IT_CHARPOS (*it
));
7054 if (it
->what
== IT_CHARACTER
)
7055 c
= it
->char_to_display
;
7058 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7062 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7063 /* TAB in a composition means display glyphs with
7064 padding space on the left or right. */
7065 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7068 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7071 #endif /* HAVE_WINDOW_SYSTEM */
7074 /* Is this character the last one of a run of characters with
7075 box? If yes, set IT->end_of_box_run_p to true. */
7079 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7081 int face_id
= underlying_face_id (it
);
7082 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7086 if (face
->box
== FACE_NO_BOX
)
7088 /* If the box comes from face properties in a
7089 display string, check faces in that string. */
7090 int string_face_id
= face_after_it_pos (it
);
7091 it
->end_of_box_run_p
7092 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7095 /* Otherwise, the box comes from the underlying face.
7096 If this is the last string character displayed, check
7097 the next buffer location. */
7098 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7099 /* n_overlay_strings is unreliable unless
7100 overlay_string_index is non-negative. */
7101 && ((it
->current
.overlay_string_index
>= 0
7102 && (it
->current
.overlay_string_index
7103 == it
->n_overlay_strings
- 1))
7104 /* A string from display property. */
7105 || it
->from_disp_prop_p
))
7109 struct text_pos pos
= it
->current
.pos
;
7111 /* For a string from a display property, the next
7112 buffer position is stored in the 'position'
7113 member of the iteration stack slot below the
7114 current one, see handle_single_display_spec. By
7115 contrast, it->current.pos was is not yet updated
7116 to point to that buffer position; that will
7117 happen in pop_it, after we finish displaying the
7118 current string. Note that we already checked
7119 above that it->sp is positive, so subtracting one
7121 if (it
->from_disp_prop_p
)
7122 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7124 INC_TEXT_POS (pos
, it
->multibyte_p
);
7126 if (CHARPOS (pos
) >= ZV
)
7127 it
->end_of_box_run_p
= true;
7130 next_face_id
= face_at_buffer_position
7131 (it
->w
, CHARPOS (pos
), &ignore
,
7132 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7133 it
->end_of_box_run_p
7134 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7140 /* next_element_from_display_vector sets this flag according to
7141 faces of the display vector glyphs, see there. */
7142 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7144 int face_id
= face_after_it_pos (it
);
7145 it
->end_of_box_run_p
7146 = (face_id
!= it
->face_id
7147 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7150 /* If we reached the end of the object we've been iterating (e.g., a
7151 display string or an overlay string), and there's something on
7152 IT->stack, proceed with what's on the stack. It doesn't make
7153 sense to return false if there's unprocessed stuff on the stack,
7154 because otherwise that stuff will never be displayed. */
7155 if (!success_p
&& it
->sp
> 0)
7157 set_iterator_to_next (it
, false);
7158 success_p
= get_next_display_element (it
);
7161 /* Value is false if end of buffer or string reached. */
7166 /* Move IT to the next display element.
7168 RESEAT_P means if called on a newline in buffer text,
7169 skip to the next visible line start.
7171 Functions get_next_display_element and set_iterator_to_next are
7172 separate because I find this arrangement easier to handle than a
7173 get_next_display_element function that also increments IT's
7174 position. The way it is we can first look at an iterator's current
7175 display element, decide whether it fits on a line, and if it does,
7176 increment the iterator position. The other way around we probably
7177 would either need a flag indicating whether the iterator has to be
7178 incremented the next time, or we would have to implement a
7179 decrement position function which would not be easy to write. */
7182 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7184 /* Reset flags indicating start and end of a sequence of characters
7185 with box. Reset them at the start of this function because
7186 moving the iterator to a new position might set them. */
7187 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7191 case GET_FROM_BUFFER
:
7192 /* The current display element of IT is a character from
7193 current_buffer. Advance in the buffer, and maybe skip over
7194 invisible lines that are so because of selective display. */
7195 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7196 reseat_at_next_visible_line_start (it
, false);
7197 else if (it
->cmp_it
.id
>= 0)
7199 /* We are currently getting glyphs from a composition. */
7202 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7203 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7209 /* Update IT's char/byte positions to point to the first
7210 character of the next grapheme cluster, or to the
7211 character visually after the current composition. */
7212 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7213 bidi_move_to_visually_next (&it
->bidi_it
);
7214 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7215 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7218 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7219 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7221 /* Composition created while scanning forward. Proceed
7222 to the next grapheme cluster. */
7223 it
->cmp_it
.from
= it
->cmp_it
.to
;
7225 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7226 && it
->cmp_it
.from
> 0)
7228 /* Composition created while scanning backward. Proceed
7229 to the previous grapheme cluster. */
7230 it
->cmp_it
.to
= it
->cmp_it
.from
;
7234 /* No more grapheme clusters in this composition.
7235 Find the next stop position. */
7236 ptrdiff_t stop
= it
->end_charpos
;
7238 if (it
->bidi_it
.scan_dir
< 0)
7239 /* Now we are scanning backward and don't know
7242 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7243 IT_BYTEPOS (*it
), stop
, Qnil
);
7248 eassert (it
->len
!= 0);
7252 IT_BYTEPOS (*it
) += it
->len
;
7253 IT_CHARPOS (*it
) += 1;
7257 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7258 /* If this is a new paragraph, determine its base
7259 direction (a.k.a. its base embedding level). */
7260 if (it
->bidi_it
.new_paragraph
)
7261 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7263 bidi_move_to_visually_next (&it
->bidi_it
);
7264 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7265 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7266 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7268 /* As the scan direction was changed, we must
7269 re-compute the stop position for composition. */
7270 ptrdiff_t stop
= it
->end_charpos
;
7271 if (it
->bidi_it
.scan_dir
< 0)
7273 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7274 IT_BYTEPOS (*it
), stop
, Qnil
);
7277 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7281 case GET_FROM_C_STRING
:
7282 /* Current display element of IT is from a C string. */
7284 /* If the string position is beyond string's end, it means
7285 next_element_from_c_string is padding the string with
7286 blanks, in which case we bypass the bidi iterator,
7287 because it cannot deal with such virtual characters. */
7288 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7290 IT_BYTEPOS (*it
) += it
->len
;
7291 IT_CHARPOS (*it
) += 1;
7295 bidi_move_to_visually_next (&it
->bidi_it
);
7296 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7297 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7301 case GET_FROM_DISPLAY_VECTOR
:
7302 /* Current display element of IT is from a display table entry.
7303 Advance in the display table definition. Reset it to null if
7304 end reached, and continue with characters from buffers/
7306 ++it
->current
.dpvec_index
;
7308 /* Restore face of the iterator to what they were before the
7309 display vector entry (these entries may contain faces). */
7310 it
->face_id
= it
->saved_face_id
;
7312 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7314 bool recheck_faces
= it
->ellipsis_p
;
7317 it
->method
= GET_FROM_C_STRING
;
7318 else if (STRINGP (it
->string
))
7319 it
->method
= GET_FROM_STRING
;
7322 it
->method
= GET_FROM_BUFFER
;
7323 it
->object
= it
->w
->contents
;
7327 it
->current
.dpvec_index
= -1;
7329 /* Skip over characters which were displayed via IT->dpvec. */
7330 if (it
->dpvec_char_len
< 0)
7331 reseat_at_next_visible_line_start (it
, true);
7332 else if (it
->dpvec_char_len
> 0)
7334 it
->len
= it
->dpvec_char_len
;
7335 set_iterator_to_next (it
, reseat_p
);
7338 /* Maybe recheck faces after display vector. */
7341 if (it
->method
== GET_FROM_STRING
)
7342 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7344 it
->stop_charpos
= IT_CHARPOS (*it
);
7349 case GET_FROM_STRING
:
7350 /* Current display element is a character from a Lisp string. */
7351 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7352 /* Don't advance past string end. These conditions are true
7353 when set_iterator_to_next is called at the end of
7354 get_next_display_element, in which case the Lisp string is
7355 already exhausted, and all we want is pop the iterator
7357 if (it
->current
.overlay_string_index
>= 0)
7359 /* This is an overlay string, so there's no padding with
7360 spaces, and the number of characters in the string is
7361 where the string ends. */
7362 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7363 goto consider_string_end
;
7367 /* Not an overlay string. There could be padding, so test
7368 against it->end_charpos. */
7369 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7370 goto consider_string_end
;
7372 if (it
->cmp_it
.id
>= 0)
7374 /* We are delivering display elements from a composition.
7375 Update the string position past the grapheme cluster
7376 we've just processed. */
7379 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7380 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7386 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7387 bidi_move_to_visually_next (&it
->bidi_it
);
7388 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7389 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7392 /* Did we exhaust all the grapheme clusters of this
7394 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7395 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7397 /* Not all the grapheme clusters were processed yet;
7398 advance to the next cluster. */
7399 it
->cmp_it
.from
= it
->cmp_it
.to
;
7401 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7402 && it
->cmp_it
.from
> 0)
7404 /* Likewise: advance to the next cluster, but going in
7405 the reverse direction. */
7406 it
->cmp_it
.to
= it
->cmp_it
.from
;
7410 /* This composition was fully processed; find the next
7411 candidate place for checking for composed
7413 /* Always limit string searches to the string length;
7414 any padding spaces are not part of the string, and
7415 there cannot be any compositions in that padding. */
7416 ptrdiff_t stop
= SCHARS (it
->string
);
7418 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7420 else if (it
->end_charpos
< stop
)
7422 /* Cf. PRECISION in reseat_to_string: we might be
7423 limited in how many of the string characters we
7425 stop
= it
->end_charpos
;
7427 composition_compute_stop_pos (&it
->cmp_it
,
7428 IT_STRING_CHARPOS (*it
),
7429 IT_STRING_BYTEPOS (*it
), stop
,
7436 /* If the string position is beyond string's end, it
7437 means next_element_from_string is padding the string
7438 with blanks, in which case we bypass the bidi
7439 iterator, because it cannot deal with such virtual
7441 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7443 IT_STRING_BYTEPOS (*it
) += it
->len
;
7444 IT_STRING_CHARPOS (*it
) += 1;
7448 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7450 bidi_move_to_visually_next (&it
->bidi_it
);
7451 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7452 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7453 /* If the scan direction changes, we may need to update
7454 the place where to check for composed characters. */
7455 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7457 ptrdiff_t stop
= SCHARS (it
->string
);
7459 if (it
->bidi_it
.scan_dir
< 0)
7461 else if (it
->end_charpos
< stop
)
7462 stop
= it
->end_charpos
;
7464 composition_compute_stop_pos (&it
->cmp_it
,
7465 IT_STRING_CHARPOS (*it
),
7466 IT_STRING_BYTEPOS (*it
), stop
,
7472 consider_string_end
:
7474 if (it
->current
.overlay_string_index
>= 0)
7476 /* IT->string is an overlay string. Advance to the
7477 next, if there is one. */
7478 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7480 it
->ellipsis_p
= false;
7481 next_overlay_string (it
);
7483 setup_for_ellipsis (it
, 0);
7488 /* IT->string is not an overlay string. If we reached
7489 its end, and there is something on IT->stack, proceed
7490 with what is on the stack. This can be either another
7491 string, this time an overlay string, or a buffer. */
7492 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7496 if (it
->method
== GET_FROM_STRING
)
7497 goto consider_string_end
;
7502 case GET_FROM_IMAGE
:
7503 case GET_FROM_STRETCH
:
7504 /* The position etc with which we have to proceed are on
7505 the stack. The position may be at the end of a string,
7506 if the `display' property takes up the whole string. */
7507 eassert (it
->sp
> 0);
7509 if (it
->method
== GET_FROM_STRING
)
7510 goto consider_string_end
;
7514 /* There are no other methods defined, so this should be a bug. */
7518 eassert (it
->method
!= GET_FROM_STRING
7519 || (STRINGP (it
->string
)
7520 && IT_STRING_CHARPOS (*it
) >= 0));
7523 /* Load IT's display element fields with information about the next
7524 display element which comes from a display table entry or from the
7525 result of translating a control character to one of the forms `^C'
7528 IT->dpvec holds the glyphs to return as characters.
7529 IT->saved_face_id holds the face id before the display vector--it
7530 is restored into IT->face_id in set_iterator_to_next. */
7533 next_element_from_display_vector (struct it
*it
)
7536 int prev_face_id
= it
->face_id
;
7540 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7542 it
->face_id
= it
->saved_face_id
;
7544 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7545 That seemed totally bogus - so I changed it... */
7546 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7548 if (GLYPH_CODE_P (gc
))
7550 struct face
*this_face
, *prev_face
, *next_face
;
7552 it
->c
= GLYPH_CODE_CHAR (gc
);
7553 it
->len
= CHAR_BYTES (it
->c
);
7555 /* The entry may contain a face id to use. Such a face id is
7556 the id of a Lisp face, not a realized face. A face id of
7557 zero means no face is specified. */
7558 if (it
->dpvec_face_id
>= 0)
7559 it
->face_id
= it
->dpvec_face_id
;
7562 int lface_id
= GLYPH_CODE_FACE (gc
);
7564 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7568 /* Glyphs in the display vector could have the box face, so we
7569 need to set the related flags in the iterator, as
7571 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7572 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7574 /* Is this character the first character of a box-face run? */
7575 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7577 || prev_face
->box
== FACE_NO_BOX
));
7579 /* For the last character of the box-face run, we need to look
7580 either at the next glyph from the display vector, or at the
7581 face we saw before the display vector. */
7582 next_face_id
= it
->saved_face_id
;
7583 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7585 if (it
->dpvec_face_id
>= 0)
7586 next_face_id
= it
->dpvec_face_id
;
7590 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7593 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7597 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7598 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7600 || next_face
->box
== FACE_NO_BOX
));
7601 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7604 /* Display table entry is invalid. Return a space. */
7605 it
->c
= ' ', it
->len
= 1;
7607 /* Don't change position and object of the iterator here. They are
7608 still the values of the character that had this display table
7609 entry or was translated, and that's what we want. */
7610 it
->what
= IT_CHARACTER
;
7614 /* Get the first element of string/buffer in the visual order, after
7615 being reseated to a new position in a string or a buffer. */
7617 get_visually_first_element (struct it
*it
)
7619 bool string_p
= STRINGP (it
->string
) || it
->s
;
7620 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7621 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7623 if (STRINGP (it
->string
))
7625 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7626 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7630 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7631 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7634 if (it
->bidi_it
.charpos
== eob
)
7636 /* Nothing to do, but reset the FIRST_ELT flag, like
7637 bidi_paragraph_init does, because we are not going to
7639 it
->bidi_it
.first_elt
= false;
7641 else if (it
->bidi_it
.charpos
== bob
7643 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7644 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7646 /* If we are at the beginning of a line/string, we can produce
7647 the next element right away. */
7648 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7649 bidi_move_to_visually_next (&it
->bidi_it
);
7653 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7655 /* We need to prime the bidi iterator starting at the line's or
7656 string's beginning, before we will be able to produce the
7659 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7661 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7662 IT_BYTEPOS (*it
), -1,
7663 &it
->bidi_it
.bytepos
);
7664 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7667 /* Now return to buffer/string position where we were asked
7668 to get the next display element, and produce that. */
7669 bidi_move_to_visually_next (&it
->bidi_it
);
7671 while (it
->bidi_it
.bytepos
!= orig_bytepos
7672 && it
->bidi_it
.charpos
< eob
);
7675 /* Adjust IT's position information to where we ended up. */
7676 if (STRINGP (it
->string
))
7678 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7679 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7683 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7684 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7687 if (STRINGP (it
->string
) || !it
->s
)
7689 ptrdiff_t stop
, charpos
, bytepos
;
7691 if (STRINGP (it
->string
))
7694 stop
= SCHARS (it
->string
);
7695 if (stop
> it
->end_charpos
)
7696 stop
= it
->end_charpos
;
7697 charpos
= IT_STRING_CHARPOS (*it
);
7698 bytepos
= IT_STRING_BYTEPOS (*it
);
7702 stop
= it
->end_charpos
;
7703 charpos
= IT_CHARPOS (*it
);
7704 bytepos
= IT_BYTEPOS (*it
);
7706 if (it
->bidi_it
.scan_dir
< 0)
7708 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7713 /* Load IT with the next display element from Lisp string IT->string.
7714 IT->current.string_pos is the current position within the string.
7715 If IT->current.overlay_string_index >= 0, the Lisp string is an
7719 next_element_from_string (struct it
*it
)
7721 struct text_pos position
;
7723 eassert (STRINGP (it
->string
));
7724 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7725 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7726 position
= it
->current
.string_pos
;
7728 /* With bidi reordering, the character to display might not be the
7729 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7730 that we were reseat()ed to a new string, whose paragraph
7731 direction is not known. */
7732 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7734 get_visually_first_element (it
);
7735 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7738 /* Time to check for invisible text? */
7739 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7741 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7744 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7745 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7747 /* With bidi non-linear iteration, we could find
7748 ourselves far beyond the last computed stop_charpos,
7749 with several other stop positions in between that we
7750 missed. Scan them all now, in buffer's logical
7751 order, until we find and handle the last stop_charpos
7752 that precedes our current position. */
7753 handle_stop_backwards (it
, it
->stop_charpos
);
7754 return GET_NEXT_DISPLAY_ELEMENT (it
);
7760 /* Take note of the stop position we just moved
7761 across, for when we will move back across it. */
7762 it
->prev_stop
= it
->stop_charpos
;
7763 /* If we are at base paragraph embedding level, take
7764 note of the last stop position seen at this
7766 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7767 it
->base_level_stop
= it
->stop_charpos
;
7771 /* Since a handler may have changed IT->method, we must
7773 return GET_NEXT_DISPLAY_ELEMENT (it
);
7777 /* If we are before prev_stop, we may have overstepped
7778 on our way backwards a stop_pos, and if so, we need
7779 to handle that stop_pos. */
7780 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7781 /* We can sometimes back up for reasons that have nothing
7782 to do with bidi reordering. E.g., compositions. The
7783 code below is only needed when we are above the base
7784 embedding level, so test for that explicitly. */
7785 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7787 /* If we lost track of base_level_stop, we have no better
7788 place for handle_stop_backwards to start from than string
7789 beginning. This happens, e.g., when we were reseated to
7790 the previous screenful of text by vertical-motion. */
7791 if (it
->base_level_stop
<= 0
7792 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7793 it
->base_level_stop
= 0;
7794 handle_stop_backwards (it
, it
->base_level_stop
);
7795 return GET_NEXT_DISPLAY_ELEMENT (it
);
7799 if (it
->current
.overlay_string_index
>= 0)
7801 /* Get the next character from an overlay string. In overlay
7802 strings, there is no field width or padding with spaces to
7804 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7809 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7810 IT_STRING_BYTEPOS (*it
),
7811 it
->bidi_it
.scan_dir
< 0
7813 : SCHARS (it
->string
))
7814 && next_element_from_composition (it
))
7818 else if (STRING_MULTIBYTE (it
->string
))
7820 const unsigned char *s
= (SDATA (it
->string
)
7821 + IT_STRING_BYTEPOS (*it
));
7822 it
->c
= string_char_and_length (s
, &it
->len
);
7826 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7832 /* Get the next character from a Lisp string that is not an
7833 overlay string. Such strings come from the mode line, for
7834 example. We may have to pad with spaces, or truncate the
7835 string. See also next_element_from_c_string. */
7836 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7841 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7843 /* Pad with spaces. */
7844 it
->c
= ' ', it
->len
= 1;
7845 CHARPOS (position
) = BYTEPOS (position
) = -1;
7847 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7848 IT_STRING_BYTEPOS (*it
),
7849 it
->bidi_it
.scan_dir
< 0
7851 : it
->string_nchars
)
7852 && next_element_from_composition (it
))
7856 else if (STRING_MULTIBYTE (it
->string
))
7858 const unsigned char *s
= (SDATA (it
->string
)
7859 + IT_STRING_BYTEPOS (*it
));
7860 it
->c
= string_char_and_length (s
, &it
->len
);
7864 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7869 /* Record what we have and where it came from. */
7870 it
->what
= IT_CHARACTER
;
7871 it
->object
= it
->string
;
7872 it
->position
= position
;
7877 /* Load IT with next display element from C string IT->s.
7878 IT->string_nchars is the maximum number of characters to return
7879 from the string. IT->end_charpos may be greater than
7880 IT->string_nchars when this function is called, in which case we
7881 may have to return padding spaces. Value is false if end of string
7882 reached, including padding spaces. */
7885 next_element_from_c_string (struct it
*it
)
7887 bool success_p
= true;
7890 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7891 it
->what
= IT_CHARACTER
;
7892 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7893 it
->object
= make_number (0);
7895 /* With bidi reordering, the character to display might not be the
7896 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7897 we were reseated to a new string, whose paragraph direction is
7899 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7900 get_visually_first_element (it
);
7902 /* IT's position can be greater than IT->string_nchars in case a
7903 field width or precision has been specified when the iterator was
7905 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7907 /* End of the game. */
7911 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7913 /* Pad with spaces. */
7914 it
->c
= ' ', it
->len
= 1;
7915 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7917 else if (it
->multibyte_p
)
7918 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7920 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7926 /* Set up IT to return characters from an ellipsis, if appropriate.
7927 The definition of the ellipsis glyphs may come from a display table
7928 entry. This function fills IT with the first glyph from the
7929 ellipsis if an ellipsis is to be displayed. */
7932 next_element_from_ellipsis (struct it
*it
)
7934 if (it
->selective_display_ellipsis_p
)
7935 setup_for_ellipsis (it
, it
->len
);
7938 /* The face at the current position may be different from the
7939 face we find after the invisible text. Remember what it
7940 was in IT->saved_face_id, and signal that it's there by
7941 setting face_before_selective_p. */
7942 it
->saved_face_id
= it
->face_id
;
7943 it
->method
= GET_FROM_BUFFER
;
7944 it
->object
= it
->w
->contents
;
7945 reseat_at_next_visible_line_start (it
, true);
7946 it
->face_before_selective_p
= true;
7949 return GET_NEXT_DISPLAY_ELEMENT (it
);
7953 /* Deliver an image display element. The iterator IT is already
7954 filled with image information (done in handle_display_prop). Value
7959 next_element_from_image (struct it
*it
)
7961 it
->what
= IT_IMAGE
;
7966 /* Fill iterator IT with next display element from a stretch glyph
7967 property. IT->object is the value of the text property. Value is
7971 next_element_from_stretch (struct it
*it
)
7973 it
->what
= IT_STRETCH
;
7977 /* Scan backwards from IT's current position until we find a stop
7978 position, or until BEGV. This is called when we find ourself
7979 before both the last known prev_stop and base_level_stop while
7980 reordering bidirectional text. */
7983 compute_stop_pos_backwards (struct it
*it
)
7985 const int SCAN_BACK_LIMIT
= 1000;
7986 struct text_pos pos
;
7987 struct display_pos save_current
= it
->current
;
7988 struct text_pos save_position
= it
->position
;
7989 ptrdiff_t charpos
= IT_CHARPOS (*it
);
7990 ptrdiff_t where_we_are
= charpos
;
7991 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
7992 ptrdiff_t save_end_pos
= it
->end_charpos
;
7994 eassert (NILP (it
->string
) && !it
->s
);
7995 eassert (it
->bidi_p
);
7999 it
->end_charpos
= min (charpos
+ 1, ZV
);
8000 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8001 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8002 reseat_1 (it
, pos
, false);
8003 compute_stop_pos (it
);
8004 /* We must advance forward, right? */
8005 if (it
->stop_charpos
<= charpos
)
8008 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8010 if (it
->stop_charpos
<= where_we_are
)
8011 it
->prev_stop
= it
->stop_charpos
;
8013 it
->prev_stop
= BEGV
;
8015 it
->current
= save_current
;
8016 it
->position
= save_position
;
8017 it
->stop_charpos
= save_stop_pos
;
8018 it
->end_charpos
= save_end_pos
;
8021 /* Scan forward from CHARPOS in the current buffer/string, until we
8022 find a stop position > current IT's position. Then handle the stop
8023 position before that. This is called when we bump into a stop
8024 position while reordering bidirectional text. CHARPOS should be
8025 the last previously processed stop_pos (or BEGV/0, if none were
8026 processed yet) whose position is less that IT's current
8030 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8032 bool bufp
= !STRINGP (it
->string
);
8033 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8034 struct display_pos save_current
= it
->current
;
8035 struct text_pos save_position
= it
->position
;
8036 struct text_pos pos1
;
8037 ptrdiff_t next_stop
;
8039 /* Scan in strict logical order. */
8040 eassert (it
->bidi_p
);
8044 it
->prev_stop
= charpos
;
8047 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8048 reseat_1 (it
, pos1
, false);
8051 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8052 compute_stop_pos (it
);
8053 /* We must advance forward, right? */
8054 if (it
->stop_charpos
<= it
->prev_stop
)
8056 charpos
= it
->stop_charpos
;
8058 while (charpos
<= where_we_are
);
8061 it
->current
= save_current
;
8062 it
->position
= save_position
;
8063 next_stop
= it
->stop_charpos
;
8064 it
->stop_charpos
= it
->prev_stop
;
8066 it
->stop_charpos
= next_stop
;
8069 /* Load IT with the next display element from current_buffer. Value
8070 is false if end of buffer reached. IT->stop_charpos is the next
8071 position at which to stop and check for text properties or buffer
8075 next_element_from_buffer (struct it
*it
)
8077 bool success_p
= true;
8079 eassert (IT_CHARPOS (*it
) >= BEGV
);
8080 eassert (NILP (it
->string
) && !it
->s
);
8081 eassert (!it
->bidi_p
8082 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8083 && it
->bidi_it
.string
.s
== NULL
));
8085 /* With bidi reordering, the character to display might not be the
8086 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8087 we were reseat()ed to a new buffer position, which is potentially
8088 a different paragraph. */
8089 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8091 get_visually_first_element (it
);
8092 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8095 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8097 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8099 bool overlay_strings_follow_p
;
8101 /* End of the game, except when overlay strings follow that
8102 haven't been returned yet. */
8103 if (it
->overlay_strings_at_end_processed_p
)
8104 overlay_strings_follow_p
= false;
8107 it
->overlay_strings_at_end_processed_p
= true;
8108 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8111 if (overlay_strings_follow_p
)
8112 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8116 it
->position
= it
->current
.pos
;
8120 else if (!(!it
->bidi_p
8121 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8122 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8124 /* With bidi non-linear iteration, we could find ourselves
8125 far beyond the last computed stop_charpos, with several
8126 other stop positions in between that we missed. Scan
8127 them all now, in buffer's logical order, until we find
8128 and handle the last stop_charpos that precedes our
8129 current position. */
8130 handle_stop_backwards (it
, it
->stop_charpos
);
8131 it
->ignore_overlay_strings_at_pos_p
= false;
8132 return GET_NEXT_DISPLAY_ELEMENT (it
);
8138 /* Take note of the stop position we just moved across,
8139 for when we will move back across it. */
8140 it
->prev_stop
= it
->stop_charpos
;
8141 /* If we are at base paragraph embedding level, take
8142 note of the last stop position seen at this
8144 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8145 it
->base_level_stop
= it
->stop_charpos
;
8148 it
->ignore_overlay_strings_at_pos_p
= false;
8149 return GET_NEXT_DISPLAY_ELEMENT (it
);
8153 /* If we are before prev_stop, we may have overstepped on
8154 our way backwards a stop_pos, and if so, we need to
8155 handle that stop_pos. */
8156 && IT_CHARPOS (*it
) < it
->prev_stop
8157 /* We can sometimes back up for reasons that have nothing
8158 to do with bidi reordering. E.g., compositions. The
8159 code below is only needed when we are above the base
8160 embedding level, so test for that explicitly. */
8161 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8163 if (it
->base_level_stop
<= 0
8164 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8166 /* If we lost track of base_level_stop, we need to find
8167 prev_stop by looking backwards. This happens, e.g., when
8168 we were reseated to the previous screenful of text by
8170 it
->base_level_stop
= BEGV
;
8171 compute_stop_pos_backwards (it
);
8172 handle_stop_backwards (it
, it
->prev_stop
);
8175 handle_stop_backwards (it
, it
->base_level_stop
);
8176 it
->ignore_overlay_strings_at_pos_p
= false;
8177 return GET_NEXT_DISPLAY_ELEMENT (it
);
8181 /* No face changes, overlays etc. in sight, so just return a
8182 character from current_buffer. */
8186 /* We moved to the next buffer position, so any info about
8187 previously seen overlays is no longer valid. */
8188 it
->ignore_overlay_strings_at_pos_p
= false;
8190 /* Maybe run the redisplay end trigger hook. Performance note:
8191 This doesn't seem to cost measurable time. */
8192 if (it
->redisplay_end_trigger_charpos
8194 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8195 run_redisplay_end_trigger_hook (it
);
8197 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8198 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8200 && next_element_from_composition (it
))
8205 /* Get the next character, maybe multibyte. */
8206 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8207 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8208 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8210 it
->c
= *p
, it
->len
= 1;
8212 /* Record what we have and where it came from. */
8213 it
->what
= IT_CHARACTER
;
8214 it
->object
= it
->w
->contents
;
8215 it
->position
= it
->current
.pos
;
8217 /* Normally we return the character found above, except when we
8218 really want to return an ellipsis for selective display. */
8223 /* A value of selective > 0 means hide lines indented more
8224 than that number of columns. */
8225 if (it
->selective
> 0
8226 && IT_CHARPOS (*it
) + 1 < ZV
8227 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8228 IT_BYTEPOS (*it
) + 1,
8231 success_p
= next_element_from_ellipsis (it
);
8232 it
->dpvec_char_len
= -1;
8235 else if (it
->c
== '\r' && it
->selective
== -1)
8237 /* A value of selective == -1 means that everything from the
8238 CR to the end of the line is invisible, with maybe an
8239 ellipsis displayed for it. */
8240 success_p
= next_element_from_ellipsis (it
);
8241 it
->dpvec_char_len
= -1;
8246 /* Value is false if end of buffer reached. */
8247 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8252 /* Run the redisplay end trigger hook for IT. */
8255 run_redisplay_end_trigger_hook (struct it
*it
)
8257 /* IT->glyph_row should be non-null, i.e. we should be actually
8258 displaying something, or otherwise we should not run the hook. */
8259 eassert (it
->glyph_row
);
8261 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8262 it
->redisplay_end_trigger_charpos
= 0;
8264 /* Since we are *trying* to run these functions, don't try to run
8265 them again, even if they get an error. */
8266 wset_redisplay_end_trigger (it
->w
, Qnil
);
8267 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8268 make_number (charpos
));
8270 /* Notice if it changed the face of the character we are on. */
8271 handle_face_prop (it
);
8275 /* Deliver a composition display element. Unlike the other
8276 next_element_from_XXX, this function is not registered in the array
8277 get_next_element[]. It is called from next_element_from_buffer and
8278 next_element_from_string when necessary. */
8281 next_element_from_composition (struct it
*it
)
8283 it
->what
= IT_COMPOSITION
;
8284 it
->len
= it
->cmp_it
.nbytes
;
8285 if (STRINGP (it
->string
))
8289 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8290 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8293 it
->position
= it
->current
.string_pos
;
8294 it
->object
= it
->string
;
8295 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8296 IT_STRING_BYTEPOS (*it
), it
->string
);
8302 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8303 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8306 if (it
->bidi_it
.new_paragraph
)
8307 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8309 /* Resync the bidi iterator with IT's new position.
8310 FIXME: this doesn't support bidirectional text. */
8311 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8312 bidi_move_to_visually_next (&it
->bidi_it
);
8316 it
->position
= it
->current
.pos
;
8317 it
->object
= it
->w
->contents
;
8318 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8319 IT_BYTEPOS (*it
), Qnil
);
8326 /***********************************************************************
8327 Moving an iterator without producing glyphs
8328 ***********************************************************************/
8330 /* Check if iterator is at a position corresponding to a valid buffer
8331 position after some move_it_ call. */
8333 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8334 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8337 /* Move iterator IT to a specified buffer or X position within one
8338 line on the display without producing glyphs.
8340 OP should be a bit mask including some or all of these bits:
8341 MOVE_TO_X: Stop upon reaching x-position TO_X.
8342 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8343 Regardless of OP's value, stop upon reaching the end of the display line.
8345 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8346 This means, in particular, that TO_X includes window's horizontal
8349 The return value has several possible values that
8350 say what condition caused the scan to stop:
8352 MOVE_POS_MATCH_OR_ZV
8353 - when TO_POS or ZV was reached.
8356 -when TO_X was reached before TO_POS or ZV were reached.
8359 - when we reached the end of the display area and the line must
8363 - when we reached the end of the display area and the line is
8367 - when we stopped at a line end, i.e. a newline or a CR and selective
8370 static enum move_it_result
8371 move_it_in_display_line_to (struct it
*it
,
8372 ptrdiff_t to_charpos
, int to_x
,
8373 enum move_operation_enum op
)
8375 enum move_it_result result
= MOVE_UNDEFINED
;
8376 struct glyph_row
*saved_glyph_row
;
8377 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8378 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8379 void *ppos_data
= NULL
;
8380 bool may_wrap
= false;
8381 enum it_method prev_method
= it
->method
;
8382 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8383 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8385 /* Don't produce glyphs in produce_glyphs. */
8386 saved_glyph_row
= it
->glyph_row
;
8387 it
->glyph_row
= NULL
;
8389 /* Use wrap_it to save a copy of IT wherever a word wrap could
8390 occur. Use atpos_it to save a copy of IT at the desired buffer
8391 position, if found, so that we can scan ahead and check if the
8392 word later overshoots the window edge. Use atx_it similarly, for
8398 /* Use ppos_it under bidi reordering to save a copy of IT for the
8399 initial position. We restore that position in IT when we have
8400 scanned the entire display line without finding a match for
8401 TO_CHARPOS and all the character positions are greater than
8402 TO_CHARPOS. We then restart the scan from the initial position,
8403 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8404 the closest to TO_CHARPOS. */
8407 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8409 SAVE_IT (ppos_it
, *it
, ppos_data
);
8410 closest_pos
= IT_CHARPOS (*it
);
8416 #define BUFFER_POS_REACHED_P() \
8417 ((op & MOVE_TO_POS) != 0 \
8418 && BUFFERP (it->object) \
8419 && (IT_CHARPOS (*it) == to_charpos \
8421 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8422 && IT_CHARPOS (*it) > to_charpos) \
8423 || (it->what == IT_COMPOSITION \
8424 && ((IT_CHARPOS (*it) > to_charpos \
8425 && to_charpos >= it->cmp_it.charpos) \
8426 || (IT_CHARPOS (*it) < to_charpos \
8427 && to_charpos <= it->cmp_it.charpos)))) \
8428 && (it->method == GET_FROM_BUFFER \
8429 || (it->method == GET_FROM_DISPLAY_VECTOR \
8430 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8432 /* If there's a line-/wrap-prefix, handle it. */
8433 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8434 && it
->current_y
< it
->last_visible_y
)
8435 handle_line_prefix (it
);
8437 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8438 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8442 int x
, i
, ascent
= 0, descent
= 0;
8444 /* Utility macro to reset an iterator with x, ascent, and descent. */
8445 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8446 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8447 (IT)->max_descent = descent)
8449 /* Stop if we move beyond TO_CHARPOS (after an image or a
8450 display string or stretch glyph). */
8451 if ((op
& MOVE_TO_POS
) != 0
8452 && BUFFERP (it
->object
)
8453 && it
->method
== GET_FROM_BUFFER
8455 /* When the iterator is at base embedding level, we
8456 are guaranteed that characters are delivered for
8457 display in strictly increasing order of their
8458 buffer positions. */
8459 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8460 && IT_CHARPOS (*it
) > to_charpos
)
8462 && (prev_method
== GET_FROM_IMAGE
8463 || prev_method
== GET_FROM_STRETCH
8464 || prev_method
== GET_FROM_STRING
)
8465 /* Passed TO_CHARPOS from left to right. */
8466 && ((prev_pos
< to_charpos
8467 && IT_CHARPOS (*it
) > to_charpos
)
8468 /* Passed TO_CHARPOS from right to left. */
8469 || (prev_pos
> to_charpos
8470 && IT_CHARPOS (*it
) < to_charpos
)))))
8472 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8474 result
= MOVE_POS_MATCH_OR_ZV
;
8477 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8478 /* If wrap_it is valid, the current position might be in a
8479 word that is wrapped. So, save the iterator in
8480 atpos_it and continue to see if wrapping happens. */
8481 SAVE_IT (atpos_it
, *it
, atpos_data
);
8484 /* Stop when ZV reached.
8485 We used to stop here when TO_CHARPOS reached as well, but that is
8486 too soon if this glyph does not fit on this line. So we handle it
8487 explicitly below. */
8488 if (!get_next_display_element (it
))
8490 result
= MOVE_POS_MATCH_OR_ZV
;
8494 if (it
->line_wrap
== TRUNCATE
)
8496 if (BUFFER_POS_REACHED_P ())
8498 result
= MOVE_POS_MATCH_OR_ZV
;
8504 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8506 if (IT_DISPLAYING_WHITESPACE (it
))
8510 /* We have reached a glyph that follows one or more
8511 whitespace characters. If the position is
8512 already found, we are done. */
8513 if (atpos_it
.sp
>= 0)
8515 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8516 result
= MOVE_POS_MATCH_OR_ZV
;
8521 RESTORE_IT (it
, &atx_it
, atx_data
);
8522 result
= MOVE_X_REACHED
;
8525 /* Otherwise, we can wrap here. */
8526 SAVE_IT (wrap_it
, *it
, wrap_data
);
8532 /* Remember the line height for the current line, in case
8533 the next element doesn't fit on the line. */
8534 ascent
= it
->max_ascent
;
8535 descent
= it
->max_descent
;
8537 /* The call to produce_glyphs will get the metrics of the
8538 display element IT is loaded with. Record the x-position
8539 before this display element, in case it doesn't fit on the
8543 PRODUCE_GLYPHS (it
);
8545 if (it
->area
!= TEXT_AREA
)
8547 prev_method
= it
->method
;
8548 if (it
->method
== GET_FROM_BUFFER
)
8549 prev_pos
= IT_CHARPOS (*it
);
8550 set_iterator_to_next (it
, true);
8551 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8552 SET_TEXT_POS (this_line_min_pos
,
8553 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8555 && (op
& MOVE_TO_POS
)
8556 && IT_CHARPOS (*it
) > to_charpos
8557 && IT_CHARPOS (*it
) < closest_pos
)
8558 closest_pos
= IT_CHARPOS (*it
);
8562 /* The number of glyphs we get back in IT->nglyphs will normally
8563 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8564 character on a terminal frame, or (iii) a line end. For the
8565 second case, IT->nglyphs - 1 padding glyphs will be present.
8566 (On X frames, there is only one glyph produced for a
8567 composite character.)
8569 The behavior implemented below means, for continuation lines,
8570 that as many spaces of a TAB as fit on the current line are
8571 displayed there. For terminal frames, as many glyphs of a
8572 multi-glyph character are displayed in the current line, too.
8573 This is what the old redisplay code did, and we keep it that
8574 way. Under X, the whole shape of a complex character must
8575 fit on the line or it will be completely displayed in the
8578 Note that both for tabs and padding glyphs, all glyphs have
8582 /* More than one glyph or glyph doesn't fit on line. All
8583 glyphs have the same width. */
8584 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8586 int x_before_this_char
= x
;
8587 int hpos_before_this_char
= it
->hpos
;
8589 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8591 new_x
= x
+ single_glyph_width
;
8593 /* We want to leave anything reaching TO_X to the caller. */
8594 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8596 if (BUFFER_POS_REACHED_P ())
8598 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8599 goto buffer_pos_reached
;
8600 if (atpos_it
.sp
< 0)
8602 SAVE_IT (atpos_it
, *it
, atpos_data
);
8603 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8608 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8611 result
= MOVE_X_REACHED
;
8616 SAVE_IT (atx_it
, *it
, atx_data
);
8617 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8622 if (/* Lines are continued. */
8623 it
->line_wrap
!= TRUNCATE
8624 && (/* And glyph doesn't fit on the line. */
8625 new_x
> it
->last_visible_x
8626 /* Or it fits exactly and we're on a window
8628 || (new_x
== it
->last_visible_x
8629 && FRAME_WINDOW_P (it
->f
)
8630 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8631 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8632 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8634 if (/* IT->hpos == 0 means the very first glyph
8635 doesn't fit on the line, e.g. a wide image. */
8637 || (new_x
== it
->last_visible_x
8638 && FRAME_WINDOW_P (it
->f
)))
8641 it
->current_x
= new_x
;
8643 /* The character's last glyph just barely fits
8645 if (i
== it
->nglyphs
- 1)
8647 /* If this is the destination position,
8648 return a position *before* it in this row,
8649 now that we know it fits in this row. */
8650 if (BUFFER_POS_REACHED_P ())
8652 if (it
->line_wrap
!= WORD_WRAP
8654 /* If we've just found whitespace to
8655 wrap, effectively ignore the
8656 previous wrap point -- it is no
8657 longer relevant, but we won't
8658 have an opportunity to update it,
8659 since we've reached the edge of
8660 this screen line. */
8662 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8664 it
->hpos
= hpos_before_this_char
;
8665 it
->current_x
= x_before_this_char
;
8666 result
= MOVE_POS_MATCH_OR_ZV
;
8669 if (it
->line_wrap
== WORD_WRAP
8672 SAVE_IT (atpos_it
, *it
, atpos_data
);
8673 atpos_it
.current_x
= x_before_this_char
;
8674 atpos_it
.hpos
= hpos_before_this_char
;
8678 prev_method
= it
->method
;
8679 if (it
->method
== GET_FROM_BUFFER
)
8680 prev_pos
= IT_CHARPOS (*it
);
8681 set_iterator_to_next (it
, true);
8682 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8683 SET_TEXT_POS (this_line_min_pos
,
8684 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8685 /* On graphical terminals, newlines may
8686 "overflow" into the fringe if
8687 overflow-newline-into-fringe is non-nil.
8688 On text terminals, and on graphical
8689 terminals with no right margin, newlines
8690 may overflow into the last glyph on the
8692 if (!FRAME_WINDOW_P (it
->f
)
8694 && it
->bidi_it
.paragraph_dir
== R2L
)
8695 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8696 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8697 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8699 if (!get_next_display_element (it
))
8701 result
= MOVE_POS_MATCH_OR_ZV
;
8704 if (BUFFER_POS_REACHED_P ())
8706 if (ITERATOR_AT_END_OF_LINE_P (it
))
8707 result
= MOVE_POS_MATCH_OR_ZV
;
8709 result
= MOVE_LINE_CONTINUED
;
8712 if (ITERATOR_AT_END_OF_LINE_P (it
)
8713 && (it
->line_wrap
!= WORD_WRAP
8715 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8717 result
= MOVE_NEWLINE_OR_CR
;
8724 IT_RESET_X_ASCENT_DESCENT (it
);
8726 /* If the screen line ends with whitespace, and we
8727 are under word-wrap, don't use wrap_it: it is no
8728 longer relevant, but we won't have an opportunity
8729 to update it, since we are done with this screen
8731 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8733 /* If we've found TO_X, go back there, as we now
8734 know the last word fits on this screen line. */
8735 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8738 RESTORE_IT (it
, &atx_it
, atx_data
);
8741 result
= MOVE_X_REACHED
;
8745 else if (wrap_it
.sp
>= 0)
8747 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8752 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8754 result
= MOVE_LINE_CONTINUED
;
8758 if (BUFFER_POS_REACHED_P ())
8760 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8761 goto buffer_pos_reached
;
8762 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8764 SAVE_IT (atpos_it
, *it
, atpos_data
);
8765 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8769 if (new_x
> it
->first_visible_x
)
8771 /* Glyph is visible. Increment number of glyphs that
8772 would be displayed. */
8777 if (result
!= MOVE_UNDEFINED
)
8780 else if (BUFFER_POS_REACHED_P ())
8783 IT_RESET_X_ASCENT_DESCENT (it
);
8784 result
= MOVE_POS_MATCH_OR_ZV
;
8787 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8789 /* Stop when TO_X specified and reached. This check is
8790 necessary here because of lines consisting of a line end,
8791 only. The line end will not produce any glyphs and we
8792 would never get MOVE_X_REACHED. */
8793 eassert (it
->nglyphs
== 0);
8794 result
= MOVE_X_REACHED
;
8798 /* Is this a line end? If yes, we're done. */
8799 if (ITERATOR_AT_END_OF_LINE_P (it
))
8801 /* If we are past TO_CHARPOS, but never saw any character
8802 positions smaller than TO_CHARPOS, return
8803 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8805 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8807 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8809 if (closest_pos
< ZV
)
8811 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8812 /* Don't recurse if closest_pos is equal to
8813 to_charpos, since we have just tried that. */
8814 if (closest_pos
!= to_charpos
)
8815 move_it_in_display_line_to (it
, closest_pos
, -1,
8817 result
= MOVE_POS_MATCH_OR_ZV
;
8820 goto buffer_pos_reached
;
8822 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8823 && IT_CHARPOS (*it
) > to_charpos
)
8824 goto buffer_pos_reached
;
8826 result
= MOVE_NEWLINE_OR_CR
;
8829 result
= MOVE_NEWLINE_OR_CR
;
8833 prev_method
= it
->method
;
8834 if (it
->method
== GET_FROM_BUFFER
)
8835 prev_pos
= IT_CHARPOS (*it
);
8836 /* The current display element has been consumed. Advance
8838 set_iterator_to_next (it
, true);
8839 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8840 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8841 if (IT_CHARPOS (*it
) < to_charpos
)
8842 saw_smaller_pos
= true;
8844 && (op
& MOVE_TO_POS
)
8845 && IT_CHARPOS (*it
) >= to_charpos
8846 && IT_CHARPOS (*it
) < closest_pos
)
8847 closest_pos
= IT_CHARPOS (*it
);
8849 /* Stop if lines are truncated and IT's current x-position is
8850 past the right edge of the window now. */
8851 if (it
->line_wrap
== TRUNCATE
8852 && it
->current_x
>= it
->last_visible_x
)
8854 if (!FRAME_WINDOW_P (it
->f
)
8855 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8856 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8857 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8858 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8860 bool at_eob_p
= false;
8862 if ((at_eob_p
= !get_next_display_element (it
))
8863 || BUFFER_POS_REACHED_P ()
8864 /* If we are past TO_CHARPOS, but never saw any
8865 character positions smaller than TO_CHARPOS,
8866 return MOVE_POS_MATCH_OR_ZV, like the
8867 unidirectional display did. */
8868 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8870 && IT_CHARPOS (*it
) > to_charpos
))
8873 && !BUFFER_POS_REACHED_P ()
8874 && !at_eob_p
&& closest_pos
< ZV
)
8876 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8877 if (closest_pos
!= to_charpos
)
8878 move_it_in_display_line_to (it
, closest_pos
, -1,
8881 result
= MOVE_POS_MATCH_OR_ZV
;
8884 if (ITERATOR_AT_END_OF_LINE_P (it
))
8886 result
= MOVE_NEWLINE_OR_CR
;
8890 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8892 && IT_CHARPOS (*it
) > to_charpos
)
8894 if (closest_pos
< ZV
)
8896 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8897 if (closest_pos
!= to_charpos
)
8898 move_it_in_display_line_to (it
, closest_pos
, -1,
8901 result
= MOVE_POS_MATCH_OR_ZV
;
8904 result
= MOVE_LINE_TRUNCATED
;
8907 #undef IT_RESET_X_ASCENT_DESCENT
8910 #undef BUFFER_POS_REACHED_P
8912 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8913 restore the saved iterator. */
8914 if (atpos_it
.sp
>= 0)
8915 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8916 else if (atx_it
.sp
>= 0)
8917 RESTORE_IT (it
, &atx_it
, atx_data
);
8922 bidi_unshelve_cache (atpos_data
, true);
8924 bidi_unshelve_cache (atx_data
, true);
8926 bidi_unshelve_cache (wrap_data
, true);
8928 bidi_unshelve_cache (ppos_data
, true);
8930 /* Restore the iterator settings altered at the beginning of this
8932 it
->glyph_row
= saved_glyph_row
;
8936 /* For external use. */
8938 move_it_in_display_line (struct it
*it
,
8939 ptrdiff_t to_charpos
, int to_x
,
8940 enum move_operation_enum op
)
8942 if (it
->line_wrap
== WORD_WRAP
8943 && (op
& MOVE_TO_X
))
8946 void *save_data
= NULL
;
8949 SAVE_IT (save_it
, *it
, save_data
);
8950 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8951 /* When word-wrap is on, TO_X may lie past the end
8952 of a wrapped line. Then it->current is the
8953 character on the next line, so backtrack to the
8954 space before the wrap point. */
8955 if (skip
== MOVE_LINE_CONTINUED
)
8957 int prev_x
= max (it
->current_x
- 1, 0);
8958 RESTORE_IT (it
, &save_it
, save_data
);
8959 move_it_in_display_line_to
8960 (it
, -1, prev_x
, MOVE_TO_X
);
8963 bidi_unshelve_cache (save_data
, true);
8966 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8970 /* Move IT forward until it satisfies one or more of the criteria in
8971 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8973 OP is a bit-mask that specifies where to stop, and in particular,
8974 which of those four position arguments makes a difference. See the
8975 description of enum move_operation_enum.
8977 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8978 screen line, this function will set IT to the next position that is
8979 displayed to the right of TO_CHARPOS on the screen.
8981 Return the maximum pixel length of any line scanned but never more
8982 than it.last_visible_x. */
8985 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8987 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8988 int line_height
, line_start_x
= 0, reached
= 0;
8989 int max_current_x
= 0;
8990 void *backup_data
= NULL
;
8994 if (op
& MOVE_TO_VPOS
)
8996 /* If no TO_CHARPOS and no TO_X specified, stop at the
8997 start of the line TO_VPOS. */
8998 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9000 if (it
->vpos
== to_vpos
)
9006 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9010 /* TO_VPOS >= 0 means stop at TO_X in the line at
9011 TO_VPOS, or at TO_POS, whichever comes first. */
9012 if (it
->vpos
== to_vpos
)
9018 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9020 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9025 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9027 /* We have reached TO_X but not in the line we want. */
9028 skip
= move_it_in_display_line_to (it
, to_charpos
,
9030 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9038 else if (op
& MOVE_TO_Y
)
9040 struct it it_backup
;
9042 if (it
->line_wrap
== WORD_WRAP
)
9043 SAVE_IT (it_backup
, *it
, backup_data
);
9045 /* TO_Y specified means stop at TO_X in the line containing
9046 TO_Y---or at TO_CHARPOS if this is reached first. The
9047 problem is that we can't really tell whether the line
9048 contains TO_Y before we have completely scanned it, and
9049 this may skip past TO_X. What we do is to first scan to
9052 If TO_X is not specified, use a TO_X of zero. The reason
9053 is to make the outcome of this function more predictable.
9054 If we didn't use TO_X == 0, we would stop at the end of
9055 the line which is probably not what a caller would expect
9057 skip
= move_it_in_display_line_to
9058 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9059 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9061 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9062 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9064 else if (skip
== MOVE_X_REACHED
)
9066 /* If TO_X was reached, we want to know whether TO_Y is
9067 in the line. We know this is the case if the already
9068 scanned glyphs make the line tall enough. Otherwise,
9069 we must check by scanning the rest of the line. */
9070 line_height
= it
->max_ascent
+ it
->max_descent
;
9071 if (to_y
>= it
->current_y
9072 && to_y
< it
->current_y
+ line_height
)
9077 SAVE_IT (it_backup
, *it
, backup_data
);
9078 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9079 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9081 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9082 line_height
= it
->max_ascent
+ it
->max_descent
;
9083 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9085 if (to_y
>= it
->current_y
9086 && to_y
< it
->current_y
+ line_height
)
9088 /* If TO_Y is in this line and TO_X was reached
9089 above, we scanned too far. We have to restore
9090 IT's settings to the ones before skipping. But
9091 keep the more accurate values of max_ascent and
9092 max_descent we've found while skipping the rest
9093 of the line, for the sake of callers, such as
9094 pos_visible_p, that need to know the line
9096 int max_ascent
= it
->max_ascent
;
9097 int max_descent
= it
->max_descent
;
9099 RESTORE_IT (it
, &it_backup
, backup_data
);
9100 it
->max_ascent
= max_ascent
;
9101 it
->max_descent
= max_descent
;
9107 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9113 /* Check whether TO_Y is in this line. */
9114 line_height
= it
->max_ascent
+ it
->max_descent
;
9115 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9117 if (to_y
>= it
->current_y
9118 && to_y
< it
->current_y
+ line_height
)
9120 if (to_y
> it
->current_y
)
9121 max_current_x
= max (it
->current_x
, max_current_x
);
9123 /* When word-wrap is on, TO_X may lie past the end
9124 of a wrapped line. Then it->current is the
9125 character on the next line, so backtrack to the
9126 space before the wrap point. */
9127 if (skip
== MOVE_LINE_CONTINUED
9128 && it
->line_wrap
== WORD_WRAP
)
9130 int prev_x
= max (it
->current_x
- 1, 0);
9131 RESTORE_IT (it
, &it_backup
, backup_data
);
9132 skip
= move_it_in_display_line_to
9133 (it
, -1, prev_x
, MOVE_TO_X
);
9142 max_current_x
= max (it
->current_x
, max_current_x
);
9146 else if (BUFFERP (it
->object
)
9147 && (it
->method
== GET_FROM_BUFFER
9148 || it
->method
== GET_FROM_STRETCH
)
9149 && IT_CHARPOS (*it
) >= to_charpos
9150 /* Under bidi iteration, a call to set_iterator_to_next
9151 can scan far beyond to_charpos if the initial
9152 portion of the next line needs to be reordered. In
9153 that case, give move_it_in_display_line_to another
9156 && it
->bidi_it
.scan_dir
== -1))
9157 skip
= MOVE_POS_MATCH_OR_ZV
;
9159 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9163 case MOVE_POS_MATCH_OR_ZV
:
9164 max_current_x
= max (it
->current_x
, max_current_x
);
9168 case MOVE_NEWLINE_OR_CR
:
9169 max_current_x
= max (it
->current_x
, max_current_x
);
9170 set_iterator_to_next (it
, true);
9171 it
->continuation_lines_width
= 0;
9174 case MOVE_LINE_TRUNCATED
:
9175 max_current_x
= it
->last_visible_x
;
9176 it
->continuation_lines_width
= 0;
9177 reseat_at_next_visible_line_start (it
, false);
9178 if ((op
& MOVE_TO_POS
) != 0
9179 && IT_CHARPOS (*it
) > to_charpos
)
9186 case MOVE_LINE_CONTINUED
:
9187 max_current_x
= it
->last_visible_x
;
9188 /* For continued lines ending in a tab, some of the glyphs
9189 associated with the tab are displayed on the current
9190 line. Since it->current_x does not include these glyphs,
9191 we use it->last_visible_x instead. */
9194 it
->continuation_lines_width
+= it
->last_visible_x
;
9195 /* When moving by vpos, ensure that the iterator really
9196 advances to the next line (bug#847, bug#969). Fixme:
9197 do we need to do this in other circumstances? */
9198 if (it
->current_x
!= it
->last_visible_x
9199 && (op
& MOVE_TO_VPOS
)
9200 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9202 line_start_x
= it
->current_x
+ it
->pixel_width
9203 - it
->last_visible_x
;
9204 if (FRAME_WINDOW_P (it
->f
))
9206 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9207 struct font
*face_font
= face
->font
;
9209 /* When display_line produces a continued line
9210 that ends in a TAB, it skips a tab stop that
9211 is closer than the font's space character
9212 width (see x_produce_glyphs where it produces
9213 the stretch glyph which represents a TAB).
9214 We need to reproduce the same logic here. */
9215 eassert (face_font
);
9218 if (line_start_x
< face_font
->space_width
)
9220 += it
->tab_width
* face_font
->space_width
;
9223 set_iterator_to_next (it
, false);
9227 it
->continuation_lines_width
+= it
->current_x
;
9234 /* Reset/increment for the next run. */
9235 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9236 it
->current_x
= line_start_x
;
9239 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9241 last_height
= it
->max_ascent
+ it
->max_descent
;
9242 it
->max_ascent
= it
->max_descent
= 0;
9247 /* On text terminals, we may stop at the end of a line in the middle
9248 of a multi-character glyph. If the glyph itself is continued,
9249 i.e. it is actually displayed on the next line, don't treat this
9250 stopping point as valid; move to the next line instead (unless
9251 that brings us offscreen). */
9252 if (!FRAME_WINDOW_P (it
->f
)
9254 && IT_CHARPOS (*it
) == to_charpos
9255 && it
->what
== IT_CHARACTER
9257 && it
->line_wrap
== WINDOW_WRAP
9258 && it
->current_x
== it
->last_visible_x
- 1
9261 && it
->w
->window_end_valid
9262 && it
->vpos
< it
->w
->window_end_vpos
)
9264 it
->continuation_lines_width
+= it
->current_x
;
9265 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9266 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9268 last_height
= it
->max_ascent
+ it
->max_descent
;
9272 bidi_unshelve_cache (backup_data
, true);
9274 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9276 return max_current_x
;
9280 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9282 If DY > 0, move IT backward at least that many pixels. DY = 0
9283 means move IT backward to the preceding line start or BEGV. This
9284 function may move over more than DY pixels if IT->current_y - DY
9285 ends up in the middle of a line; in this case IT->current_y will be
9286 set to the top of the line moved to. */
9289 move_it_vertically_backward (struct it
*it
, int dy
)
9293 void *it2data
= NULL
, *it3data
= NULL
;
9294 ptrdiff_t start_pos
;
9296 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9297 ptrdiff_t pos_limit
;
9302 start_pos
= IT_CHARPOS (*it
);
9304 /* Estimate how many newlines we must move back. */
9305 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9306 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9309 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9311 /* Set the iterator's position that many lines back. But don't go
9312 back more than NLINES full screen lines -- this wins a day with
9313 buffers which have very long lines. */
9314 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9315 back_to_previous_visible_line_start (it
);
9317 /* Reseat the iterator here. When moving backward, we don't want
9318 reseat to skip forward over invisible text, set up the iterator
9319 to deliver from overlay strings at the new position etc. So,
9320 use reseat_1 here. */
9321 reseat_1 (it
, it
->current
.pos
, true);
9323 /* We are now surely at a line start. */
9324 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9325 reordering is in effect. */
9326 it
->continuation_lines_width
= 0;
9328 /* Move forward and see what y-distance we moved. First move to the
9329 start of the next line so that we get its height. We need this
9330 height to be able to tell whether we reached the specified
9332 SAVE_IT (it2
, *it
, it2data
);
9333 it2
.max_ascent
= it2
.max_descent
= 0;
9336 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9337 MOVE_TO_POS
| MOVE_TO_VPOS
);
9339 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9340 /* If we are in a display string which starts at START_POS,
9341 and that display string includes a newline, and we are
9342 right after that newline (i.e. at the beginning of a
9343 display line), exit the loop, because otherwise we will
9344 infloop, since move_it_to will see that it is already at
9345 START_POS and will not move. */
9346 || (it2
.method
== GET_FROM_STRING
9347 && IT_CHARPOS (it2
) == start_pos
9348 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9349 eassert (IT_CHARPOS (*it
) >= BEGV
);
9350 SAVE_IT (it3
, it2
, it3data
);
9352 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9353 eassert (IT_CHARPOS (*it
) >= BEGV
);
9354 /* H is the actual vertical distance from the position in *IT
9355 and the starting position. */
9356 h
= it2
.current_y
- it
->current_y
;
9357 /* NLINES is the distance in number of lines. */
9358 nlines
= it2
.vpos
- it
->vpos
;
9360 /* Correct IT's y and vpos position
9361 so that they are relative to the starting point. */
9367 /* DY == 0 means move to the start of the screen line. The
9368 value of nlines is > 0 if continuation lines were involved,
9369 or if the original IT position was at start of a line. */
9370 RESTORE_IT (it
, it
, it2data
);
9372 move_it_by_lines (it
, nlines
);
9373 /* The above code moves us to some position NLINES down,
9374 usually to its first glyph (leftmost in an L2R line), but
9375 that's not necessarily the start of the line, under bidi
9376 reordering. We want to get to the character position
9377 that is immediately after the newline of the previous
9380 && !it
->continuation_lines_width
9381 && !STRINGP (it
->string
)
9382 && IT_CHARPOS (*it
) > BEGV
9383 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9385 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9388 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9389 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9391 bidi_unshelve_cache (it3data
, true);
9395 /* The y-position we try to reach, relative to *IT.
9396 Note that H has been subtracted in front of the if-statement. */
9397 int target_y
= it
->current_y
+ h
- dy
;
9398 int y0
= it3
.current_y
;
9402 RESTORE_IT (&it3
, &it3
, it3data
);
9403 y1
= line_bottom_y (&it3
);
9404 line_height
= y1
- y0
;
9405 RESTORE_IT (it
, it
, it2data
);
9406 /* If we did not reach target_y, try to move further backward if
9407 we can. If we moved too far backward, try to move forward. */
9408 if (target_y
< it
->current_y
9409 /* This is heuristic. In a window that's 3 lines high, with
9410 a line height of 13 pixels each, recentering with point
9411 on the bottom line will try to move -39/2 = 19 pixels
9412 backward. Try to avoid moving into the first line. */
9413 && (it
->current_y
- target_y
9414 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9415 && IT_CHARPOS (*it
) > BEGV
)
9417 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9418 target_y
- it
->current_y
));
9419 dy
= it
->current_y
- target_y
;
9420 goto move_further_back
;
9422 else if (target_y
>= it
->current_y
+ line_height
9423 && IT_CHARPOS (*it
) < ZV
)
9425 /* Should move forward by at least one line, maybe more.
9427 Note: Calling move_it_by_lines can be expensive on
9428 terminal frames, where compute_motion is used (via
9429 vmotion) to do the job, when there are very long lines
9430 and truncate-lines is nil. That's the reason for
9431 treating terminal frames specially here. */
9433 if (!FRAME_WINDOW_P (it
->f
))
9434 move_it_vertically (it
, target_y
- it
->current_y
);
9439 move_it_by_lines (it
, 1);
9441 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9448 /* Move IT by a specified amount of pixel lines DY. DY negative means
9449 move backwards. DY = 0 means move to start of screen line. At the
9450 end, IT will be on the start of a screen line. */
9453 move_it_vertically (struct it
*it
, int dy
)
9456 move_it_vertically_backward (it
, -dy
);
9459 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9460 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9461 MOVE_TO_POS
| MOVE_TO_Y
);
9462 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9464 /* If buffer ends in ZV without a newline, move to the start of
9465 the line to satisfy the post-condition. */
9466 if (IT_CHARPOS (*it
) == ZV
9468 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9469 move_it_by_lines (it
, 0);
9474 /* Move iterator IT past the end of the text line it is in. */
9477 move_it_past_eol (struct it
*it
)
9479 enum move_it_result rc
;
9481 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9482 if (rc
== MOVE_NEWLINE_OR_CR
)
9483 set_iterator_to_next (it
, false);
9487 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9488 negative means move up. DVPOS == 0 means move to the start of the
9491 Optimization idea: If we would know that IT->f doesn't use
9492 a face with proportional font, we could be faster for
9493 truncate-lines nil. */
9496 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9499 /* The commented-out optimization uses vmotion on terminals. This
9500 gives bad results, because elements like it->what, on which
9501 callers such as pos_visible_p rely, aren't updated. */
9502 /* struct position pos;
9503 if (!FRAME_WINDOW_P (it->f))
9505 struct text_pos textpos;
9507 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9508 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9509 reseat (it, textpos, true);
9510 it->vpos += pos.vpos;
9511 it->current_y += pos.vpos;
9517 /* DVPOS == 0 means move to the start of the screen line. */
9518 move_it_vertically_backward (it
, 0);
9519 /* Let next call to line_bottom_y calculate real line height. */
9524 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9525 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9527 /* Only move to the next buffer position if we ended up in a
9528 string from display property, not in an overlay string
9529 (before-string or after-string). That is because the
9530 latter don't conceal the underlying buffer position, so
9531 we can ask to move the iterator to the exact position we
9532 are interested in. Note that, even if we are already at
9533 IT_CHARPOS (*it), the call below is not a no-op, as it
9534 will detect that we are at the end of the string, pop the
9535 iterator, and compute it->current_x and it->hpos
9537 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9538 -1, -1, -1, MOVE_TO_POS
);
9544 void *it2data
= NULL
;
9545 ptrdiff_t start_charpos
, i
;
9547 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9548 bool hit_pos_limit
= false;
9549 ptrdiff_t pos_limit
;
9551 /* Start at the beginning of the screen line containing IT's
9552 position. This may actually move vertically backwards,
9553 in case of overlays, so adjust dvpos accordingly. */
9555 move_it_vertically_backward (it
, 0);
9558 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9559 screen lines, and reseat the iterator there. */
9560 start_charpos
= IT_CHARPOS (*it
);
9561 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9564 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9566 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9567 back_to_previous_visible_line_start (it
);
9568 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9569 hit_pos_limit
= true;
9570 reseat (it
, it
->current
.pos
, true);
9572 /* Move further back if we end up in a string or an image. */
9573 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9575 /* First try to move to start of display line. */
9577 move_it_vertically_backward (it
, 0);
9579 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9581 /* If start of line is still in string or image,
9582 move further back. */
9583 back_to_previous_visible_line_start (it
);
9584 reseat (it
, it
->current
.pos
, true);
9588 it
->current_x
= it
->hpos
= 0;
9590 /* Above call may have moved too far if continuation lines
9591 are involved. Scan forward and see if it did. */
9592 SAVE_IT (it2
, *it
, it2data
);
9593 it2
.vpos
= it2
.current_y
= 0;
9594 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9595 it
->vpos
-= it2
.vpos
;
9596 it
->current_y
-= it2
.current_y
;
9597 it
->current_x
= it
->hpos
= 0;
9599 /* If we moved too far back, move IT some lines forward. */
9600 if (it2
.vpos
> -dvpos
)
9602 int delta
= it2
.vpos
+ dvpos
;
9604 RESTORE_IT (&it2
, &it2
, it2data
);
9605 SAVE_IT (it2
, *it
, it2data
);
9606 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9607 /* Move back again if we got too far ahead. */
9608 if (IT_CHARPOS (*it
) >= start_charpos
)
9609 RESTORE_IT (it
, &it2
, it2data
);
9611 bidi_unshelve_cache (it2data
, true);
9613 else if (hit_pos_limit
&& pos_limit
> BEGV
9614 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9616 /* If we hit the limit, but still didn't make it far enough
9617 back, that means there's a display string with a newline
9618 covering a large chunk of text, and that caused
9619 back_to_previous_visible_line_start try to go too far.
9620 Punish those who commit such atrocities by going back
9621 until we've reached DVPOS, after lifting the limit, which
9622 could make it slow for very long lines. "If it hurts,
9625 RESTORE_IT (it
, it
, it2data
);
9626 for (i
= -dvpos
; i
> 0; --i
)
9628 back_to_previous_visible_line_start (it
);
9631 reseat_1 (it
, it
->current
.pos
, true);
9634 RESTORE_IT (it
, it
, it2data
);
9638 /* Return true if IT points into the middle of a display vector. */
9641 in_display_vector_p (struct it
*it
)
9643 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9644 && it
->current
.dpvec_index
> 0
9645 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9648 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9649 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9650 WINDOW must be a live window and defaults to the selected one. The
9651 return value is a cons of the maximum pixel-width of any text line and
9652 the maximum pixel-height of all text lines.
9654 The optional argument FROM, if non-nil, specifies the first text
9655 position and defaults to the minimum accessible position of the buffer.
9656 If FROM is t, use the minimum accessible position that is not a newline
9657 character. TO, if non-nil, specifies the last text position and
9658 defaults to the maximum accessible position of the buffer. If TO is t,
9659 use the maximum accessible position that is not a newline character.
9661 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9662 width that can be returned. X-LIMIT nil or omitted, means to use the
9663 pixel-width of WINDOW's body; use this if you do not intend to change
9664 the width of WINDOW. Use the maximum width WINDOW may assume if you
9665 intend to change WINDOW's width. In any case, text whose x-coordinate
9666 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9667 can take some time, it's always a good idea to make this argument as
9668 small as possible; in particular, if the buffer contains long lines that
9669 shall be truncated anyway.
9671 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9672 height that can be returned. Text lines whose y-coordinate is beyond
9673 Y-LIMIT are ignored. Since calculating the text height of a large
9674 buffer can take some time, it makes sense to specify this argument if
9675 the size of the buffer is unknown.
9677 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9678 include the height of the mode- or header-line of WINDOW in the return
9679 value. If it is either the symbol `mode-line' or `header-line', include
9680 only the height of that line, if present, in the return value. If t,
9681 include the height of both, if present, in the return value. */)
9682 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9683 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9685 struct window
*w
= decode_live_window (window
);
9686 Lisp_Object buffer
= w
->contents
;
9689 struct buffer
*old_b
= NULL
;
9690 ptrdiff_t start
, end
, pos
;
9691 struct text_pos startp
;
9692 void *itdata
= NULL
;
9693 int c
, max_y
= -1, x
= 0, y
= 0;
9695 CHECK_BUFFER (buffer
);
9696 b
= XBUFFER (buffer
);
9698 if (b
!= current_buffer
)
9700 old_b
= current_buffer
;
9701 set_buffer_internal (b
);
9706 else if (EQ (from
, Qt
))
9709 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9710 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9712 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9717 CHECK_NUMBER_COERCE_MARKER (from
);
9718 start
= min (max (XINT (from
), BEGV
), ZV
);
9723 else if (EQ (to
, Qt
))
9726 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9727 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9729 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9734 CHECK_NUMBER_COERCE_MARKER (to
);
9735 end
= max (start
, min (XINT (to
), ZV
));
9738 if (!NILP (y_limit
))
9740 CHECK_NUMBER (y_limit
);
9741 max_y
= min (XINT (y_limit
), INT_MAX
);
9744 itdata
= bidi_shelve_cache ();
9745 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9746 start_display (&it
, w
, startp
);
9749 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9752 CHECK_NUMBER (x_limit
);
9753 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9754 /* Actually, we never want move_it_to stop at to_x. But to make
9755 sure that move_it_in_display_line_to always moves far enough,
9756 we set it to INT_MAX and specify MOVE_TO_X. */
9757 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9758 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9761 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9763 if (!EQ (mode_and_header_line
, Qheader_line
)
9764 && !EQ (mode_and_header_line
, Qt
))
9765 /* Do not count the header-line which was counted automatically by
9767 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9769 if (EQ (mode_and_header_line
, Qmode_line
)
9770 || EQ (mode_and_header_line
, Qt
))
9771 /* Do count the mode-line which is not included automatically by
9773 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9775 bidi_unshelve_cache (itdata
, false);
9778 set_buffer_internal (old_b
);
9780 return Fcons (make_number (x
), make_number (y
));
9783 /***********************************************************************
9785 ***********************************************************************/
9788 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9792 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9794 Lisp_Object msg
, fmt
;
9797 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9801 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9803 fmt
= build_string (format
);
9804 msg
= CALLN (Fformat
, fmt
, arg1
, arg2
);
9806 len
= SBYTES (msg
) + 1;
9807 buffer
= SAFE_ALLOCA (len
);
9808 memcpy (buffer
, SDATA (msg
), len
);
9810 message_dolog (buffer
, len
- 1, true, false);
9817 /* Output a newline in the *Messages* buffer if "needs" one. */
9820 message_log_maybe_newline (void)
9822 if (message_log_need_newline
)
9823 message_dolog ("", 0, true, false);
9827 /* Add a string M of length NBYTES to the message log, optionally
9828 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9829 true, means interpret the contents of M as multibyte. This
9830 function calls low-level routines in order to bypass text property
9831 hooks, etc. which might not be safe to run.
9833 This may GC (insert may run before/after change hooks),
9834 so the buffer M must NOT point to a Lisp string. */
9837 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9839 const unsigned char *msg
= (const unsigned char *) m
;
9841 if (!NILP (Vmemory_full
))
9844 if (!NILP (Vmessage_log_max
))
9846 struct buffer
*oldbuf
;
9847 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9848 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9849 ptrdiff_t point_at_end
= 0;
9850 ptrdiff_t zv_at_end
= 0;
9851 Lisp_Object old_deactivate_mark
;
9852 struct gcpro gcpro1
;
9854 old_deactivate_mark
= Vdeactivate_mark
;
9855 oldbuf
= current_buffer
;
9857 /* Ensure the Messages buffer exists, and switch to it.
9858 If we created it, set the major-mode. */
9859 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9860 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9862 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9863 call0 (intern ("messages-buffer-mode"));
9865 bset_undo_list (current_buffer
, Qt
);
9866 bset_cache_long_scans (current_buffer
, Qnil
);
9868 oldpoint
= message_dolog_marker1
;
9869 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9870 oldbegv
= message_dolog_marker2
;
9871 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9872 oldzv
= message_dolog_marker3
;
9873 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9874 GCPRO1 (old_deactivate_mark
);
9882 BEGV_BYTE
= BEG_BYTE
;
9885 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9887 /* Insert the string--maybe converting multibyte to single byte
9888 or vice versa, so that all the text fits the buffer. */
9890 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9896 /* Convert a multibyte string to single-byte
9897 for the *Message* buffer. */
9898 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9900 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9901 work
[0] = CHAR_TO_BYTE8 (c
);
9902 insert_1_both (work
, 1, 1, true, false, false);
9905 else if (! multibyte
9906 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9910 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9911 /* Convert a single-byte string to multibyte
9912 for the *Message* buffer. */
9913 for (i
= 0; i
< nbytes
; i
++)
9916 MAKE_CHAR_MULTIBYTE (c
);
9917 char_bytes
= CHAR_STRING (c
, str
);
9918 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
9922 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
9923 true, false, false);
9927 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9930 insert_1_both ("\n", 1, 1, true, false, false);
9932 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
9934 this_bol_byte
= PT_BYTE
;
9936 /* See if this line duplicates the previous one.
9937 If so, combine duplicates. */
9940 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
9942 prev_bol_byte
= PT_BYTE
;
9944 dups
= message_log_check_duplicate (prev_bol_byte
,
9948 del_range_both (prev_bol
, prev_bol_byte
,
9949 this_bol
, this_bol_byte
, false);
9952 char dupstr
[sizeof " [ times]"
9953 + INT_STRLEN_BOUND (printmax_t
)];
9955 /* If you change this format, don't forget to also
9956 change message_log_check_duplicate. */
9957 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9958 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9959 insert_1_both (dupstr
, duplen
, duplen
,
9965 /* If we have more than the desired maximum number of lines
9966 in the *Messages* buffer now, delete the oldest ones.
9967 This is safe because we don't have undo in this buffer. */
9969 if (NATNUMP (Vmessage_log_max
))
9971 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9972 -XFASTINT (Vmessage_log_max
) - 1, false);
9973 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
9976 BEGV
= marker_position (oldbegv
);
9977 BEGV_BYTE
= marker_byte_position (oldbegv
);
9986 ZV
= marker_position (oldzv
);
9987 ZV_BYTE
= marker_byte_position (oldzv
);
9991 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9993 /* We can't do Fgoto_char (oldpoint) because it will run some
9995 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9996 marker_byte_position (oldpoint
));
9999 unchain_marker (XMARKER (oldpoint
));
10000 unchain_marker (XMARKER (oldbegv
));
10001 unchain_marker (XMARKER (oldzv
));
10003 /* We called insert_1_both above with its 5th argument (PREPARE)
10004 false, which prevents insert_1_both from calling
10005 prepare_to_modify_buffer, which in turns prevents us from
10006 incrementing windows_or_buffers_changed even if *Messages* is
10007 shown in some window. So we must manually set
10008 windows_or_buffers_changed here to make up for that. */
10009 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10010 bset_redisplay (current_buffer
);
10012 set_buffer_internal (oldbuf
);
10014 message_log_need_newline
= !nlflag
;
10015 Vdeactivate_mark
= old_deactivate_mark
;
10020 /* We are at the end of the buffer after just having inserted a newline.
10021 (Note: We depend on the fact we won't be crossing the gap.)
10022 Check to see if the most recent message looks a lot like the previous one.
10023 Return 0 if different, 1 if the new one should just replace it, or a
10024 value N > 1 if we should also append " [N times]". */
10027 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10030 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10031 bool seen_dots
= false;
10032 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10033 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10035 for (i
= 0; i
< len
; i
++)
10037 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10039 if (p1
[i
] != p2
[i
])
10045 if (*p1
++ == ' ' && *p1
++ == '[')
10048 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10049 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10056 /* Display an echo area message M with a specified length of NBYTES
10057 bytes. The string may include null characters. If M is not a
10058 string, clear out any existing message, and let the mini-buffer
10061 This function cancels echoing. */
10064 message3 (Lisp_Object m
)
10066 struct gcpro gcpro1
;
10069 clear_message (true, true);
10072 /* First flush out any partial line written with print. */
10073 message_log_maybe_newline ();
10076 ptrdiff_t nbytes
= SBYTES (m
);
10077 bool multibyte
= STRING_MULTIBYTE (m
);
10080 SAFE_ALLOCA_STRING (buffer
, m
);
10081 message_dolog (buffer
, nbytes
, true, multibyte
);
10084 if (! inhibit_message
)
10085 message3_nolog (m
);
10090 /* The non-logging version of message3.
10091 This does not cancel echoing, because it is used for echoing.
10092 Perhaps we need to make a separate function for echoing
10093 and make this cancel echoing. */
10096 message3_nolog (Lisp_Object m
)
10098 struct frame
*sf
= SELECTED_FRAME ();
10100 if (FRAME_INITIAL_P (sf
))
10102 if (noninteractive_need_newline
)
10103 putc ('\n', stderr
);
10104 noninteractive_need_newline
= false;
10107 Lisp_Object s
= ENCODE_SYSTEM (m
);
10109 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10111 if (!cursor_in_echo_area
)
10112 fprintf (stderr
, "\n");
10115 /* Error messages get reported properly by cmd_error, so this must be just an
10116 informative message; if the frame hasn't really been initialized yet, just
10118 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10120 /* Get the frame containing the mini-buffer
10121 that the selected frame is using. */
10122 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10123 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10124 struct frame
*f
= XFRAME (frame
);
10126 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10127 Fmake_frame_visible (frame
);
10129 if (STRINGP (m
) && SCHARS (m
) > 0)
10132 if (minibuffer_auto_raise
)
10133 Fraise_frame (frame
);
10134 /* Assume we are not echoing.
10135 (If we are, echo_now will override this.) */
10136 echo_message_buffer
= Qnil
;
10139 clear_message (true, true);
10141 do_pending_window_change (false);
10142 echo_area_display (true);
10143 do_pending_window_change (false);
10144 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10145 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10150 /* Display a null-terminated echo area message M. If M is 0, clear
10151 out any existing message, and let the mini-buffer text show through.
10153 The buffer M must continue to exist until after the echo area gets
10154 cleared or some other message gets displayed there. Do not pass
10155 text that is stored in a Lisp string. Do not pass text in a buffer
10156 that was alloca'd. */
10159 message1 (const char *m
)
10161 message3 (m
? build_unibyte_string (m
) : Qnil
);
10165 /* The non-logging counterpart of message1. */
10168 message1_nolog (const char *m
)
10170 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10173 /* Display a message M which contains a single %s
10174 which gets replaced with STRING. */
10177 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10179 CHECK_STRING (string
);
10181 if (noninteractive
)
10185 /* ENCODE_SYSTEM below can GC and/or relocate the
10186 Lisp data, so make sure we don't use it here. */
10187 eassert (relocatable_string_data_p (m
) != 1);
10189 if (noninteractive_need_newline
)
10190 putc ('\n', stderr
);
10191 noninteractive_need_newline
= false;
10192 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10193 if (!cursor_in_echo_area
)
10194 fprintf (stderr
, "\n");
10198 else if (INTERACTIVE
)
10200 /* The frame whose minibuffer we're going to display the message on.
10201 It may be larger than the selected frame, so we need
10202 to use its buffer, not the selected frame's buffer. */
10203 Lisp_Object mini_window
;
10204 struct frame
*f
, *sf
= SELECTED_FRAME ();
10206 /* Get the frame containing the minibuffer
10207 that the selected frame is using. */
10208 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10209 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10211 /* Error messages get reported properly by cmd_error, so this must be
10212 just an informative message; if the frame hasn't really been
10213 initialized yet, just toss it. */
10214 if (f
->glyphs_initialized_p
)
10216 struct gcpro gcpro1
, gcpro2
;
10218 Lisp_Object fmt
= build_string (m
);
10219 Lisp_Object msg
= string
;
10222 msg
= CALLN (Fformat
, fmt
, msg
);
10227 message3_nolog (msg
);
10231 /* Print should start at the beginning of the message
10232 buffer next time. */
10233 message_buf_print
= false;
10239 /* Dump an informative message to the minibuf. If M is 0, clear out
10240 any existing message, and let the mini-buffer text show through.
10242 The message must be safe ASCII only. If strings may contain escape
10243 sequences or non-ASCII characters, convert them to Lisp strings and
10246 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10247 vmessage (const char *m
, va_list ap
)
10249 if (noninteractive
)
10253 if (noninteractive_need_newline
)
10254 putc ('\n', stderr
);
10255 noninteractive_need_newline
= false;
10256 vfprintf (stderr
, m
, ap
);
10257 if (!cursor_in_echo_area
)
10258 fprintf (stderr
, "\n");
10262 else if (INTERACTIVE
)
10264 /* The frame whose mini-buffer we're going to display the message
10265 on. It may be larger than the selected frame, so we need to
10266 use its buffer, not the selected frame's buffer. */
10267 Lisp_Object mini_window
;
10268 struct frame
*f
, *sf
= SELECTED_FRAME ();
10270 /* Get the frame containing the mini-buffer
10271 that the selected frame is using. */
10272 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10273 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10275 /* Error messages get reported properly by cmd_error, so this must be
10276 just an informative message; if the frame hasn't really been
10277 initialized yet, just toss it. */
10278 if (f
->glyphs_initialized_p
)
10283 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10285 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10287 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10289 message3 (make_string (message_buf
, len
));
10295 /* Print should start at the beginning of the message
10296 buffer next time. */
10297 message_buf_print
= false;
10303 message (const char *m
, ...)
10312 /* Display the current message in the current mini-buffer. This is
10313 only called from error handlers in process.c, and is not time
10317 update_echo_area (void)
10319 if (!NILP (echo_area_buffer
[0]))
10321 Lisp_Object string
;
10322 string
= Fcurrent_message ();
10328 /* Make sure echo area buffers in `echo_buffers' are live.
10329 If they aren't, make new ones. */
10332 ensure_echo_area_buffers (void)
10336 for (i
= 0; i
< 2; ++i
)
10337 if (!BUFFERP (echo_buffer
[i
])
10338 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10341 Lisp_Object old_buffer
;
10344 old_buffer
= echo_buffer
[i
];
10345 echo_buffer
[i
] = Fget_buffer_create
10346 (make_formatted_string (name
, " *Echo Area %d*", i
));
10347 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10348 /* to force word wrap in echo area -
10349 it was decided to postpone this*/
10350 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10352 for (j
= 0; j
< 2; ++j
)
10353 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10354 echo_area_buffer
[j
] = echo_buffer
[i
];
10359 /* Call FN with args A1..A2 with either the current or last displayed
10360 echo_area_buffer as current buffer.
10362 WHICH zero means use the current message buffer
10363 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10364 from echo_buffer[] and clear it.
10366 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10367 suitable buffer from echo_buffer[] and clear it.
10369 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10370 that the current message becomes the last displayed one, make
10371 choose a suitable buffer for echo_area_buffer[0], and clear it.
10373 Value is what FN returns. */
10376 with_echo_area_buffer (struct window
*w
, int which
,
10377 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10378 ptrdiff_t a1
, Lisp_Object a2
)
10380 Lisp_Object buffer
;
10381 bool this_one
, the_other
, clear_buffer_p
, rc
;
10382 ptrdiff_t count
= SPECPDL_INDEX ();
10384 /* If buffers aren't live, make new ones. */
10385 ensure_echo_area_buffers ();
10387 clear_buffer_p
= false;
10390 this_one
= false, the_other
= true;
10391 else if (which
> 0)
10392 this_one
= true, the_other
= false;
10395 this_one
= false, the_other
= true;
10396 clear_buffer_p
= true;
10398 /* We need a fresh one in case the current echo buffer equals
10399 the one containing the last displayed echo area message. */
10400 if (!NILP (echo_area_buffer
[this_one
])
10401 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10402 echo_area_buffer
[this_one
] = Qnil
;
10405 /* Choose a suitable buffer from echo_buffer[] is we don't
10407 if (NILP (echo_area_buffer
[this_one
]))
10409 echo_area_buffer
[this_one
]
10410 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10411 ? echo_buffer
[the_other
]
10412 : echo_buffer
[this_one
]);
10413 clear_buffer_p
= true;
10416 buffer
= echo_area_buffer
[this_one
];
10418 /* Don't get confused by reusing the buffer used for echoing
10419 for a different purpose. */
10420 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10423 record_unwind_protect (unwind_with_echo_area_buffer
,
10424 with_echo_area_buffer_unwind_data (w
));
10426 /* Make the echo area buffer current. Note that for display
10427 purposes, it is not necessary that the displayed window's buffer
10428 == current_buffer, except for text property lookup. So, let's
10429 only set that buffer temporarily here without doing a full
10430 Fset_window_buffer. We must also change w->pointm, though,
10431 because otherwise an assertions in unshow_buffer fails, and Emacs
10433 set_buffer_internal_1 (XBUFFER (buffer
));
10436 wset_buffer (w
, buffer
);
10437 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10438 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10441 bset_undo_list (current_buffer
, Qt
);
10442 bset_read_only (current_buffer
, Qnil
);
10443 specbind (Qinhibit_read_only
, Qt
);
10444 specbind (Qinhibit_modification_hooks
, Qt
);
10446 if (clear_buffer_p
&& Z
> BEG
)
10447 del_range (BEG
, Z
);
10449 eassert (BEGV
>= BEG
);
10450 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10454 eassert (BEGV
>= BEG
);
10455 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10457 unbind_to (count
, Qnil
);
10462 /* Save state that should be preserved around the call to the function
10463 FN called in with_echo_area_buffer. */
10466 with_echo_area_buffer_unwind_data (struct window
*w
)
10469 Lisp_Object vector
, tmp
;
10471 /* Reduce consing by keeping one vector in
10472 Vwith_echo_area_save_vector. */
10473 vector
= Vwith_echo_area_save_vector
;
10474 Vwith_echo_area_save_vector
= Qnil
;
10477 vector
= Fmake_vector (make_number (11), Qnil
);
10479 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10480 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10481 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10485 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10486 ASET (vector
, i
, w
->contents
); ++i
;
10487 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10488 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10489 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10490 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10491 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10492 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10497 for (; i
< end
; ++i
)
10498 ASET (vector
, i
, Qnil
);
10501 eassert (i
== ASIZE (vector
));
10506 /* Restore global state from VECTOR which was created by
10507 with_echo_area_buffer_unwind_data. */
10510 unwind_with_echo_area_buffer (Lisp_Object vector
)
10512 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10513 Vdeactivate_mark
= AREF (vector
, 1);
10514 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10516 if (WINDOWP (AREF (vector
, 3)))
10519 Lisp_Object buffer
;
10521 w
= XWINDOW (AREF (vector
, 3));
10522 buffer
= AREF (vector
, 4);
10524 wset_buffer (w
, buffer
);
10525 set_marker_both (w
->pointm
, buffer
,
10526 XFASTINT (AREF (vector
, 5)),
10527 XFASTINT (AREF (vector
, 6)));
10528 set_marker_both (w
->old_pointm
, buffer
,
10529 XFASTINT (AREF (vector
, 7)),
10530 XFASTINT (AREF (vector
, 8)));
10531 set_marker_both (w
->start
, buffer
,
10532 XFASTINT (AREF (vector
, 9)),
10533 XFASTINT (AREF (vector
, 10)));
10536 Vwith_echo_area_save_vector
= vector
;
10540 /* Set up the echo area for use by print functions. MULTIBYTE_P
10541 means we will print multibyte. */
10544 setup_echo_area_for_printing (bool multibyte_p
)
10546 /* If we can't find an echo area any more, exit. */
10547 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10548 Fkill_emacs (Qnil
);
10550 ensure_echo_area_buffers ();
10552 if (!message_buf_print
)
10554 /* A message has been output since the last time we printed.
10555 Choose a fresh echo area buffer. */
10556 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10557 echo_area_buffer
[0] = echo_buffer
[1];
10559 echo_area_buffer
[0] = echo_buffer
[0];
10561 /* Switch to that buffer and clear it. */
10562 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10563 bset_truncate_lines (current_buffer
, Qnil
);
10567 ptrdiff_t count
= SPECPDL_INDEX ();
10568 specbind (Qinhibit_read_only
, Qt
);
10569 /* Note that undo recording is always disabled. */
10570 del_range (BEG
, Z
);
10571 unbind_to (count
, Qnil
);
10573 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10575 /* Set up the buffer for the multibyteness we need. */
10577 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10578 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10580 /* Raise the frame containing the echo area. */
10581 if (minibuffer_auto_raise
)
10583 struct frame
*sf
= SELECTED_FRAME ();
10584 Lisp_Object mini_window
;
10585 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10586 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10589 message_log_maybe_newline ();
10590 message_buf_print
= true;
10594 if (NILP (echo_area_buffer
[0]))
10596 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10597 echo_area_buffer
[0] = echo_buffer
[1];
10599 echo_area_buffer
[0] = echo_buffer
[0];
10602 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10604 /* Someone switched buffers between print requests. */
10605 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10606 bset_truncate_lines (current_buffer
, Qnil
);
10612 /* Display an echo area message in window W. Value is true if W's
10613 height is changed. If display_last_displayed_message_p,
10614 display the message that was last displayed, otherwise
10615 display the current message. */
10618 display_echo_area (struct window
*w
)
10620 bool no_message_p
, window_height_changed_p
;
10622 /* Temporarily disable garbage collections while displaying the echo
10623 area. This is done because a GC can print a message itself.
10624 That message would modify the echo area buffer's contents while a
10625 redisplay of the buffer is going on, and seriously confuse
10627 ptrdiff_t count
= inhibit_garbage_collection ();
10629 /* If there is no message, we must call display_echo_area_1
10630 nevertheless because it resizes the window. But we will have to
10631 reset the echo_area_buffer in question to nil at the end because
10632 with_echo_area_buffer will sets it to an empty buffer. */
10633 bool i
= display_last_displayed_message_p
;
10634 no_message_p
= NILP (echo_area_buffer
[i
]);
10636 window_height_changed_p
10637 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10638 display_echo_area_1
,
10639 (intptr_t) w
, Qnil
);
10642 echo_area_buffer
[i
] = Qnil
;
10644 unbind_to (count
, Qnil
);
10645 return window_height_changed_p
;
10649 /* Helper for display_echo_area. Display the current buffer which
10650 contains the current echo area message in window W, a mini-window,
10651 a pointer to which is passed in A1. A2..A4 are currently not used.
10652 Change the height of W so that all of the message is displayed.
10653 Value is true if height of W was changed. */
10656 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10659 struct window
*w
= (struct window
*) i1
;
10660 Lisp_Object window
;
10661 struct text_pos start
;
10663 /* Do this before displaying, so that we have a large enough glyph
10664 matrix for the display. If we can't get enough space for the
10665 whole text, display the last N lines. That works by setting w->start. */
10666 bool window_height_changed_p
= resize_mini_window (w
, false);
10668 /* Use the starting position chosen by resize_mini_window. */
10669 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10672 clear_glyph_matrix (w
->desired_matrix
);
10673 XSETWINDOW (window
, w
);
10674 try_window (window
, start
, 0);
10676 return window_height_changed_p
;
10680 /* Resize the echo area window to exactly the size needed for the
10681 currently displayed message, if there is one. If a mini-buffer
10682 is active, don't shrink it. */
10685 resize_echo_area_exactly (void)
10687 if (BUFFERP (echo_area_buffer
[0])
10688 && WINDOWP (echo_area_window
))
10690 struct window
*w
= XWINDOW (echo_area_window
);
10691 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10692 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10693 (intptr_t) w
, resize_exactly
);
10696 windows_or_buffers_changed
= 42;
10697 update_mode_lines
= 30;
10698 redisplay_internal ();
10704 /* Callback function for with_echo_area_buffer, when used from
10705 resize_echo_area_exactly. A1 contains a pointer to the window to
10706 resize, EXACTLY non-nil means resize the mini-window exactly to the
10707 size of the text displayed. A3 and A4 are not used. Value is what
10708 resize_mini_window returns. */
10711 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10714 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10718 /* Resize mini-window W to fit the size of its contents. EXACT_P
10719 means size the window exactly to the size needed. Otherwise, it's
10720 only enlarged until W's buffer is empty.
10722 Set W->start to the right place to begin display. If the whole
10723 contents fit, start at the beginning. Otherwise, start so as
10724 to make the end of the contents appear. This is particularly
10725 important for y-or-n-p, but seems desirable generally.
10727 Value is true if the window height has been changed. */
10730 resize_mini_window (struct window
*w
, bool exact_p
)
10732 struct frame
*f
= XFRAME (w
->frame
);
10733 bool window_height_changed_p
= false;
10735 eassert (MINI_WINDOW_P (w
));
10737 /* By default, start display at the beginning. */
10738 set_marker_both (w
->start
, w
->contents
,
10739 BUF_BEGV (XBUFFER (w
->contents
)),
10740 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10742 /* Don't resize windows while redisplaying a window; it would
10743 confuse redisplay functions when the size of the window they are
10744 displaying changes from under them. Such a resizing can happen,
10745 for instance, when which-func prints a long message while
10746 we are running fontification-functions. We're running these
10747 functions with safe_call which binds inhibit-redisplay to t. */
10748 if (!NILP (Vinhibit_redisplay
))
10751 /* Nil means don't try to resize. */
10752 if (NILP (Vresize_mini_windows
)
10753 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10756 if (!FRAME_MINIBUF_ONLY_P (f
))
10759 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10760 + WINDOW_PIXEL_HEIGHT (w
));
10761 int unit
= FRAME_LINE_HEIGHT (f
);
10762 int height
, max_height
;
10763 struct text_pos start
;
10764 struct buffer
*old_current_buffer
= NULL
;
10766 if (current_buffer
!= XBUFFER (w
->contents
))
10768 old_current_buffer
= current_buffer
;
10769 set_buffer_internal (XBUFFER (w
->contents
));
10772 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10774 /* Compute the max. number of lines specified by the user. */
10775 if (FLOATP (Vmax_mini_window_height
))
10776 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10777 else if (INTEGERP (Vmax_mini_window_height
))
10778 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10780 max_height
= total_height
/ 4;
10782 /* Correct that max. height if it's bogus. */
10783 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10785 /* Find out the height of the text in the window. */
10786 if (it
.line_wrap
== TRUNCATE
)
10791 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10792 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10793 height
= it
.current_y
+ last_height
;
10795 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10796 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10799 /* Compute a suitable window start. */
10800 if (height
> max_height
)
10802 height
= (max_height
/ unit
) * unit
;
10803 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10804 move_it_vertically_backward (&it
, height
- unit
);
10805 start
= it
.current
.pos
;
10808 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10809 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10811 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10813 /* Let it grow only, until we display an empty message, in which
10814 case the window shrinks again. */
10815 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10817 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10819 FRAME_WINDOWS_FROZEN (f
) = true;
10820 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10821 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10823 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10824 && (exact_p
|| BEGV
== ZV
))
10826 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10828 FRAME_WINDOWS_FROZEN (f
) = false;
10829 shrink_mini_window (w
, true);
10830 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10835 /* Always resize to exact size needed. */
10836 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10838 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10840 FRAME_WINDOWS_FROZEN (f
) = true;
10841 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10842 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10844 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10846 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10848 FRAME_WINDOWS_FROZEN (f
) = false;
10849 shrink_mini_window (w
, true);
10853 FRAME_WINDOWS_FROZEN (f
) = true;
10854 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10857 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10861 if (old_current_buffer
)
10862 set_buffer_internal (old_current_buffer
);
10865 return window_height_changed_p
;
10869 /* Value is the current message, a string, or nil if there is no
10870 current message. */
10873 current_message (void)
10877 if (!BUFFERP (echo_area_buffer
[0]))
10881 with_echo_area_buffer (0, 0, current_message_1
,
10882 (intptr_t) &msg
, Qnil
);
10884 echo_area_buffer
[0] = Qnil
;
10892 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10895 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10898 *msg
= make_buffer_string (BEG
, Z
, true);
10905 /* Push the current message on Vmessage_stack for later restoration
10906 by restore_message. Value is true if the current message isn't
10907 empty. This is a relatively infrequent operation, so it's not
10908 worth optimizing. */
10911 push_message (void)
10913 Lisp_Object msg
= current_message ();
10914 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10915 return STRINGP (msg
);
10919 /* Restore message display from the top of Vmessage_stack. */
10922 restore_message (void)
10924 eassert (CONSP (Vmessage_stack
));
10925 message3_nolog (XCAR (Vmessage_stack
));
10929 /* Handler for unwind-protect calling pop_message. */
10932 pop_message_unwind (void)
10934 /* Pop the top-most entry off Vmessage_stack. */
10935 eassert (CONSP (Vmessage_stack
));
10936 Vmessage_stack
= XCDR (Vmessage_stack
);
10940 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10941 exits. If the stack is not empty, we have a missing pop_message
10945 check_message_stack (void)
10947 if (!NILP (Vmessage_stack
))
10952 /* Truncate to NCHARS what will be displayed in the echo area the next
10953 time we display it---but don't redisplay it now. */
10956 truncate_echo_area (ptrdiff_t nchars
)
10959 echo_area_buffer
[0] = Qnil
;
10960 else if (!noninteractive
10962 && !NILP (echo_area_buffer
[0]))
10964 struct frame
*sf
= SELECTED_FRAME ();
10965 /* Error messages get reported properly by cmd_error, so this must be
10966 just an informative message; if the frame hasn't really been
10967 initialized yet, just toss it. */
10968 if (sf
->glyphs_initialized_p
)
10969 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10974 /* Helper function for truncate_echo_area. Truncate the current
10975 message to at most NCHARS characters. */
10978 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10980 if (BEG
+ nchars
< Z
)
10981 del_range (BEG
+ nchars
, Z
);
10983 echo_area_buffer
[0] = Qnil
;
10987 /* Set the current message to STRING. */
10990 set_message (Lisp_Object string
)
10992 eassert (STRINGP (string
));
10994 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10996 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10997 message_buf_print
= false;
10998 help_echo_showing_p
= false;
11000 if (STRINGP (Vdebug_on_message
)
11001 && STRINGP (string
)
11002 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11003 call_debugger (list2 (Qerror
, string
));
11007 /* Helper function for set_message. First argument is ignored and second
11008 argument has the same meaning as for set_message.
11009 This function is called with the echo area buffer being current. */
11012 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11014 eassert (STRINGP (string
));
11016 /* Change multibyteness of the echo buffer appropriately. */
11017 if (message_enable_multibyte
11018 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11019 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11021 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11022 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11023 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11025 /* Insert new message at BEG. */
11026 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11028 /* This function takes care of single/multibyte conversion.
11029 We just have to ensure that the echo area buffer has the right
11030 setting of enable_multibyte_characters. */
11031 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11037 /* Clear messages. CURRENT_P means clear the current message.
11038 LAST_DISPLAYED_P means clear the message last displayed. */
11041 clear_message (bool current_p
, bool last_displayed_p
)
11045 echo_area_buffer
[0] = Qnil
;
11046 message_cleared_p
= true;
11049 if (last_displayed_p
)
11050 echo_area_buffer
[1] = Qnil
;
11052 message_buf_print
= false;
11055 /* Clear garbaged frames.
11057 This function is used where the old redisplay called
11058 redraw_garbaged_frames which in turn called redraw_frame which in
11059 turn called clear_frame. The call to clear_frame was a source of
11060 flickering. I believe a clear_frame is not necessary. It should
11061 suffice in the new redisplay to invalidate all current matrices,
11062 and ensure a complete redisplay of all windows. */
11065 clear_garbaged_frames (void)
11067 if (frame_garbaged
)
11069 Lisp_Object tail
, frame
;
11071 FOR_EACH_FRAME (tail
, frame
)
11073 struct frame
*f
= XFRAME (frame
);
11075 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11080 clear_current_matrices (f
);
11081 fset_redisplay (f
);
11082 f
->garbaged
= false;
11083 f
->resized_p
= false;
11087 frame_garbaged
= false;
11092 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P,
11093 update selected_frame. Value is true if the mini-windows height
11094 has been changed. */
11097 echo_area_display (bool update_frame_p
)
11099 Lisp_Object mini_window
;
11102 bool window_height_changed_p
= false;
11103 struct frame
*sf
= SELECTED_FRAME ();
11105 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11106 w
= XWINDOW (mini_window
);
11107 f
= XFRAME (WINDOW_FRAME (w
));
11109 /* Don't display if frame is invisible or not yet initialized. */
11110 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11113 #ifdef HAVE_WINDOW_SYSTEM
11114 /* When Emacs starts, selected_frame may be the initial terminal
11115 frame. If we let this through, a message would be displayed on
11117 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11119 #endif /* HAVE_WINDOW_SYSTEM */
11121 /* Redraw garbaged frames. */
11122 clear_garbaged_frames ();
11124 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11126 echo_area_window
= mini_window
;
11127 window_height_changed_p
= display_echo_area (w
);
11128 w
->must_be_updated_p
= true;
11130 /* Update the display, unless called from redisplay_internal.
11131 Also don't update the screen during redisplay itself. The
11132 update will happen at the end of redisplay, and an update
11133 here could cause confusion. */
11134 if (update_frame_p
&& !redisplaying_p
)
11138 /* If the display update has been interrupted by pending
11139 input, update mode lines in the frame. Due to the
11140 pending input, it might have been that redisplay hasn't
11141 been called, so that mode lines above the echo area are
11142 garbaged. This looks odd, so we prevent it here. */
11143 if (!display_completed
)
11144 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11146 if (window_height_changed_p
11147 /* Don't do this if Emacs is shutting down. Redisplay
11148 needs to run hooks. */
11149 && !NILP (Vrun_hooks
))
11151 /* Must update other windows. Likewise as in other
11152 cases, don't let this update be interrupted by
11154 ptrdiff_t count
= SPECPDL_INDEX ();
11155 specbind (Qredisplay_dont_pause
, Qt
);
11156 windows_or_buffers_changed
= 44;
11157 redisplay_internal ();
11158 unbind_to (count
, Qnil
);
11160 else if (FRAME_WINDOW_P (f
) && n
== 0)
11162 /* Window configuration is the same as before.
11163 Can do with a display update of the echo area,
11164 unless we displayed some mode lines. */
11165 update_single_window (w
);
11169 update_frame (f
, true, true);
11171 /* If cursor is in the echo area, make sure that the next
11172 redisplay displays the minibuffer, so that the cursor will
11173 be replaced with what the minibuffer wants. */
11174 if (cursor_in_echo_area
)
11175 wset_redisplay (XWINDOW (mini_window
));
11178 else if (!EQ (mini_window
, selected_window
))
11179 wset_redisplay (XWINDOW (mini_window
));
11181 /* Last displayed message is now the current message. */
11182 echo_area_buffer
[1] = echo_area_buffer
[0];
11183 /* Inform read_char that we're not echoing. */
11184 echo_message_buffer
= Qnil
;
11186 /* Prevent redisplay optimization in redisplay_internal by resetting
11187 this_line_start_pos. This is done because the mini-buffer now
11188 displays the message instead of its buffer text. */
11189 if (EQ (mini_window
, selected_window
))
11190 CHARPOS (this_line_start_pos
) = 0;
11192 return window_height_changed_p
;
11195 /* True if W's buffer was changed but not saved. */
11198 window_buffer_changed (struct window
*w
)
11200 struct buffer
*b
= XBUFFER (w
->contents
);
11202 eassert (BUFFER_LIVE_P (b
));
11204 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11207 /* True if W has %c in its mode line and mode line should be updated. */
11210 mode_line_update_needed (struct window
*w
)
11212 return (w
->column_number_displayed
!= -1
11213 && !(PT
== w
->last_point
&& !window_outdated (w
))
11214 && (w
->column_number_displayed
!= current_column ()));
11217 /* True if window start of W is frozen and may not be changed during
11221 window_frozen_p (struct window
*w
)
11223 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11225 Lisp_Object window
;
11227 XSETWINDOW (window
, w
);
11228 if (MINI_WINDOW_P (w
))
11230 else if (EQ (window
, selected_window
))
11232 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11233 && EQ (window
, Vminibuf_scroll_window
))
11234 /* This special window can't be frozen too. */
11242 /***********************************************************************
11243 Mode Lines and Frame Titles
11244 ***********************************************************************/
11246 /* A buffer for constructing non-propertized mode-line strings and
11247 frame titles in it; allocated from the heap in init_xdisp and
11248 resized as needed in store_mode_line_noprop_char. */
11250 static char *mode_line_noprop_buf
;
11252 /* The buffer's end, and a current output position in it. */
11254 static char *mode_line_noprop_buf_end
;
11255 static char *mode_line_noprop_ptr
;
11257 #define MODE_LINE_NOPROP_LEN(start) \
11258 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11261 MODE_LINE_DISPLAY
= 0,
11265 } mode_line_target
;
11267 /* Alist that caches the results of :propertize.
11268 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11269 static Lisp_Object mode_line_proptrans_alist
;
11271 /* List of strings making up the mode-line. */
11272 static Lisp_Object mode_line_string_list
;
11274 /* Base face property when building propertized mode line string. */
11275 static Lisp_Object mode_line_string_face
;
11276 static Lisp_Object mode_line_string_face_prop
;
11279 /* Unwind data for mode line strings */
11281 static Lisp_Object Vmode_line_unwind_vector
;
11284 format_mode_line_unwind_data (struct frame
*target_frame
,
11285 struct buffer
*obuf
,
11287 bool save_proptrans
)
11289 Lisp_Object vector
, tmp
;
11291 /* Reduce consing by keeping one vector in
11292 Vwith_echo_area_save_vector. */
11293 vector
= Vmode_line_unwind_vector
;
11294 Vmode_line_unwind_vector
= Qnil
;
11297 vector
= Fmake_vector (make_number (10), Qnil
);
11299 ASET (vector
, 0, make_number (mode_line_target
));
11300 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11301 ASET (vector
, 2, mode_line_string_list
);
11302 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11303 ASET (vector
, 4, mode_line_string_face
);
11304 ASET (vector
, 5, mode_line_string_face_prop
);
11307 XSETBUFFER (tmp
, obuf
);
11310 ASET (vector
, 6, tmp
);
11311 ASET (vector
, 7, owin
);
11314 /* Similarly to `with-selected-window', if the operation selects
11315 a window on another frame, we must restore that frame's
11316 selected window, and (for a tty) the top-frame. */
11317 ASET (vector
, 8, target_frame
->selected_window
);
11318 if (FRAME_TERMCAP_P (target_frame
))
11319 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11326 unwind_format_mode_line (Lisp_Object vector
)
11328 Lisp_Object old_window
= AREF (vector
, 7);
11329 Lisp_Object target_frame_window
= AREF (vector
, 8);
11330 Lisp_Object old_top_frame
= AREF (vector
, 9);
11332 mode_line_target
= XINT (AREF (vector
, 0));
11333 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11334 mode_line_string_list
= AREF (vector
, 2);
11335 if (! EQ (AREF (vector
, 3), Qt
))
11336 mode_line_proptrans_alist
= AREF (vector
, 3);
11337 mode_line_string_face
= AREF (vector
, 4);
11338 mode_line_string_face_prop
= AREF (vector
, 5);
11340 /* Select window before buffer, since it may change the buffer. */
11341 if (!NILP (old_window
))
11343 /* If the operation that we are unwinding had selected a window
11344 on a different frame, reset its frame-selected-window. For a
11345 text terminal, reset its top-frame if necessary. */
11346 if (!NILP (target_frame_window
))
11349 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11351 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11352 Fselect_window (target_frame_window
, Qt
);
11354 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11355 Fselect_frame (old_top_frame
, Qt
);
11358 Fselect_window (old_window
, Qt
);
11361 if (!NILP (AREF (vector
, 6)))
11363 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11364 ASET (vector
, 6, Qnil
);
11367 Vmode_line_unwind_vector
= vector
;
11371 /* Store a single character C for the frame title in mode_line_noprop_buf.
11372 Re-allocate mode_line_noprop_buf if necessary. */
11375 store_mode_line_noprop_char (char c
)
11377 /* If output position has reached the end of the allocated buffer,
11378 increase the buffer's size. */
11379 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11381 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11382 ptrdiff_t size
= len
;
11383 mode_line_noprop_buf
=
11384 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11385 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11386 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11389 *mode_line_noprop_ptr
++ = c
;
11393 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11394 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11395 characters that yield more columns than PRECISION; PRECISION <= 0
11396 means copy the whole string. Pad with spaces until FIELD_WIDTH
11397 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11398 pad. Called from display_mode_element when it is used to build a
11402 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11404 const unsigned char *str
= (const unsigned char *) string
;
11406 ptrdiff_t dummy
, nbytes
;
11408 /* Copy at most PRECISION chars from STR. */
11409 nbytes
= strlen (string
);
11410 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11412 store_mode_line_noprop_char (*str
++);
11414 /* Fill up with spaces until FIELD_WIDTH reached. */
11415 while (field_width
> 0
11416 && n
< field_width
)
11418 store_mode_line_noprop_char (' ');
11425 /***********************************************************************
11427 ***********************************************************************/
11429 #ifdef HAVE_WINDOW_SYSTEM
11431 /* Set the title of FRAME, if it has changed. The title format is
11432 Vicon_title_format if FRAME is iconified, otherwise it is
11433 frame_title_format. */
11436 x_consider_frame_title (Lisp_Object frame
)
11438 struct frame
*f
= XFRAME (frame
);
11440 if (FRAME_WINDOW_P (f
)
11441 || FRAME_MINIBUF_ONLY_P (f
)
11442 || f
->explicit_name
)
11444 /* Do we have more than one visible frame on this X display? */
11445 Lisp_Object tail
, other_frame
, fmt
;
11446 ptrdiff_t title_start
;
11450 ptrdiff_t count
= SPECPDL_INDEX ();
11452 FOR_EACH_FRAME (tail
, other_frame
)
11454 struct frame
*tf
= XFRAME (other_frame
);
11457 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11458 && !FRAME_MINIBUF_ONLY_P (tf
)
11459 && !EQ (other_frame
, tip_frame
)
11460 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11464 /* Set global variable indicating that multiple frames exist. */
11465 multiple_frames
= CONSP (tail
);
11467 /* Switch to the buffer of selected window of the frame. Set up
11468 mode_line_target so that display_mode_element will output into
11469 mode_line_noprop_buf; then display the title. */
11470 record_unwind_protect (unwind_format_mode_line
,
11471 format_mode_line_unwind_data
11472 (f
, current_buffer
, selected_window
, false));
11474 Fselect_window (f
->selected_window
, Qt
);
11475 set_buffer_internal_1
11476 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11477 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11479 mode_line_target
= MODE_LINE_TITLE
;
11480 title_start
= MODE_LINE_NOPROP_LEN (0);
11481 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11482 NULL
, DEFAULT_FACE_ID
);
11483 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11484 len
= MODE_LINE_NOPROP_LEN (title_start
);
11485 title
= mode_line_noprop_buf
+ title_start
;
11486 unbind_to (count
, Qnil
);
11488 /* Set the title only if it's changed. This avoids consing in
11489 the common case where it hasn't. (If it turns out that we've
11490 already wasted too much time by walking through the list with
11491 display_mode_element, then we might need to optimize at a
11492 higher level than this.) */
11493 if (! STRINGP (f
->name
)
11494 || SBYTES (f
->name
) != len
11495 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11496 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11500 #endif /* not HAVE_WINDOW_SYSTEM */
11503 /***********************************************************************
11505 ***********************************************************************/
11507 /* True if we will not redisplay all visible windows. */
11508 #define REDISPLAY_SOME_P() \
11509 ((windows_or_buffers_changed == 0 \
11510 || windows_or_buffers_changed == REDISPLAY_SOME) \
11511 && (update_mode_lines == 0 \
11512 || update_mode_lines == REDISPLAY_SOME))
11514 /* Prepare for redisplay by updating menu-bar item lists when
11515 appropriate. This can call eval. */
11518 prepare_menu_bars (void)
11520 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11521 bool some_windows
= REDISPLAY_SOME_P ();
11522 struct gcpro gcpro1
, gcpro2
;
11523 Lisp_Object tooltip_frame
;
11525 #ifdef HAVE_WINDOW_SYSTEM
11526 tooltip_frame
= tip_frame
;
11528 tooltip_frame
= Qnil
;
11531 if (FUNCTIONP (Vpre_redisplay_function
))
11533 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11534 if (all_windows
&& some_windows
)
11536 Lisp_Object ws
= window_list ();
11537 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11539 Lisp_Object
this = XCAR (ws
);
11540 struct window
*w
= XWINDOW (this);
11542 || XFRAME (w
->frame
)->redisplay
11543 || XBUFFER (w
->contents
)->text
->redisplay
)
11545 windows
= Fcons (this, windows
);
11549 safe__call1 (true, Vpre_redisplay_function
, windows
);
11552 /* Update all frame titles based on their buffer names, etc. We do
11553 this before the menu bars so that the buffer-menu will show the
11554 up-to-date frame titles. */
11555 #ifdef HAVE_WINDOW_SYSTEM
11558 Lisp_Object tail
, frame
;
11560 FOR_EACH_FRAME (tail
, frame
)
11562 struct frame
*f
= XFRAME (frame
);
11563 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11567 && !XBUFFER (w
->contents
)->text
->redisplay
)
11570 if (!EQ (frame
, tooltip_frame
)
11571 && (FRAME_ICONIFIED_P (f
)
11572 || FRAME_VISIBLE_P (f
) == 1
11573 /* Exclude TTY frames that are obscured because they
11574 are not the top frame on their console. This is
11575 because x_consider_frame_title actually switches
11576 to the frame, which for TTY frames means it is
11577 marked as garbaged, and will be completely
11578 redrawn on the next redisplay cycle. This causes
11579 TTY frames to be completely redrawn, when there
11580 are more than one of them, even though nothing
11581 should be changed on display. */
11582 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11583 x_consider_frame_title (frame
);
11586 #endif /* HAVE_WINDOW_SYSTEM */
11588 /* Update the menu bar item lists, if appropriate. This has to be
11589 done before any actual redisplay or generation of display lines. */
11593 Lisp_Object tail
, frame
;
11594 ptrdiff_t count
= SPECPDL_INDEX ();
11595 /* True means that update_menu_bar has run its hooks
11596 so any further calls to update_menu_bar shouldn't do so again. */
11597 bool menu_bar_hooks_run
= false;
11599 record_unwind_save_match_data ();
11601 FOR_EACH_FRAME (tail
, frame
)
11603 struct frame
*f
= XFRAME (frame
);
11604 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11606 /* Ignore tooltip frame. */
11607 if (EQ (frame
, tooltip_frame
))
11613 && !XBUFFER (w
->contents
)->text
->redisplay
)
11616 /* If a window on this frame changed size, report that to
11617 the user and clear the size-change flag. */
11618 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11620 Lisp_Object functions
;
11622 /* Clear flag first in case we get an error below. */
11623 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11624 functions
= Vwindow_size_change_functions
;
11625 GCPRO2 (tail
, functions
);
11627 while (CONSP (functions
))
11629 if (!EQ (XCAR (functions
), Qt
))
11630 call1 (XCAR (functions
), frame
);
11631 functions
= XCDR (functions
);
11637 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11638 #ifdef HAVE_WINDOW_SYSTEM
11639 update_tool_bar (f
, false);
11644 unbind_to (count
, Qnil
);
11648 struct frame
*sf
= SELECTED_FRAME ();
11649 update_menu_bar (sf
, true, false);
11650 #ifdef HAVE_WINDOW_SYSTEM
11651 update_tool_bar (sf
, true);
11657 /* Update the menu bar item list for frame F. This has to be done
11658 before we start to fill in any display lines, because it can call
11661 If SAVE_MATCH_DATA, we must save and restore it here.
11663 If HOOKS_RUN, a previous call to update_menu_bar
11664 already ran the menu bar hooks for this redisplay, so there
11665 is no need to run them again. The return value is the
11666 updated value of this flag, to pass to the next call. */
11669 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11671 Lisp_Object window
;
11674 /* If called recursively during a menu update, do nothing. This can
11675 happen when, for instance, an activate-menubar-hook causes a
11677 if (inhibit_menubar_update
)
11680 window
= FRAME_SELECTED_WINDOW (f
);
11681 w
= XWINDOW (window
);
11683 if (FRAME_WINDOW_P (f
)
11685 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11686 || defined (HAVE_NS) || defined (USE_GTK)
11687 FRAME_EXTERNAL_MENU_BAR (f
)
11689 FRAME_MENU_BAR_LINES (f
) > 0
11691 : FRAME_MENU_BAR_LINES (f
) > 0)
11693 /* If the user has switched buffers or windows, we need to
11694 recompute to reflect the new bindings. But we'll
11695 recompute when update_mode_lines is set too; that means
11696 that people can use force-mode-line-update to request
11697 that the menu bar be recomputed. The adverse effect on
11698 the rest of the redisplay algorithm is about the same as
11699 windows_or_buffers_changed anyway. */
11700 if (windows_or_buffers_changed
11701 /* This used to test w->update_mode_line, but we believe
11702 there is no need to recompute the menu in that case. */
11703 || update_mode_lines
11704 || window_buffer_changed (w
))
11706 struct buffer
*prev
= current_buffer
;
11707 ptrdiff_t count
= SPECPDL_INDEX ();
11709 specbind (Qinhibit_menubar_update
, Qt
);
11711 set_buffer_internal_1 (XBUFFER (w
->contents
));
11712 if (save_match_data
)
11713 record_unwind_save_match_data ();
11714 if (NILP (Voverriding_local_map_menu_flag
))
11716 specbind (Qoverriding_terminal_local_map
, Qnil
);
11717 specbind (Qoverriding_local_map
, Qnil
);
11722 /* Run the Lucid hook. */
11723 safe_run_hooks (Qactivate_menubar_hook
);
11725 /* If it has changed current-menubar from previous value,
11726 really recompute the menu-bar from the value. */
11727 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11728 call0 (Qrecompute_lucid_menubar
);
11730 safe_run_hooks (Qmenu_bar_update_hook
);
11735 XSETFRAME (Vmenu_updating_frame
, f
);
11736 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11738 /* Redisplay the menu bar in case we changed it. */
11739 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11740 || defined (HAVE_NS) || defined (USE_GTK)
11741 if (FRAME_WINDOW_P (f
))
11743 #if defined (HAVE_NS)
11744 /* All frames on Mac OS share the same menubar. So only
11745 the selected frame should be allowed to set it. */
11746 if (f
== SELECTED_FRAME ())
11748 set_frame_menubar (f
, false, false);
11751 /* On a terminal screen, the menu bar is an ordinary screen
11752 line, and this makes it get updated. */
11753 w
->update_mode_line
= true;
11754 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11755 /* In the non-toolkit version, the menu bar is an ordinary screen
11756 line, and this makes it get updated. */
11757 w
->update_mode_line
= true;
11758 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11760 unbind_to (count
, Qnil
);
11761 set_buffer_internal_1 (prev
);
11768 /***********************************************************************
11770 ***********************************************************************/
11772 #ifdef HAVE_WINDOW_SYSTEM
11774 /* Select `frame' temporarily without running all the code in
11776 FIXME: Maybe do_switch_frame should be trimmed down similarly
11777 when `norecord' is set. */
11779 fast_set_selected_frame (Lisp_Object frame
)
11781 if (!EQ (selected_frame
, frame
))
11783 selected_frame
= frame
;
11784 selected_window
= XFRAME (frame
)->selected_window
;
11788 /* Update the tool-bar item list for frame F. This has to be done
11789 before we start to fill in any display lines. Called from
11790 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11791 and restore it here. */
11794 update_tool_bar (struct frame
*f
, bool save_match_data
)
11796 #if defined (USE_GTK) || defined (HAVE_NS)
11797 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11799 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11800 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11805 Lisp_Object window
;
11808 window
= FRAME_SELECTED_WINDOW (f
);
11809 w
= XWINDOW (window
);
11811 /* If the user has switched buffers or windows, we need to
11812 recompute to reflect the new bindings. But we'll
11813 recompute when update_mode_lines is set too; that means
11814 that people can use force-mode-line-update to request
11815 that the menu bar be recomputed. The adverse effect on
11816 the rest of the redisplay algorithm is about the same as
11817 windows_or_buffers_changed anyway. */
11818 if (windows_or_buffers_changed
11819 || w
->update_mode_line
11820 || update_mode_lines
11821 || window_buffer_changed (w
))
11823 struct buffer
*prev
= current_buffer
;
11824 ptrdiff_t count
= SPECPDL_INDEX ();
11825 Lisp_Object frame
, new_tool_bar
;
11826 int new_n_tool_bar
;
11827 struct gcpro gcpro1
;
11829 /* Set current_buffer to the buffer of the selected
11830 window of the frame, so that we get the right local
11832 set_buffer_internal_1 (XBUFFER (w
->contents
));
11834 /* Save match data, if we must. */
11835 if (save_match_data
)
11836 record_unwind_save_match_data ();
11838 /* Make sure that we don't accidentally use bogus keymaps. */
11839 if (NILP (Voverriding_local_map_menu_flag
))
11841 specbind (Qoverriding_terminal_local_map
, Qnil
);
11842 specbind (Qoverriding_local_map
, Qnil
);
11845 GCPRO1 (new_tool_bar
);
11847 /* We must temporarily set the selected frame to this frame
11848 before calling tool_bar_items, because the calculation of
11849 the tool-bar keymap uses the selected frame (see
11850 `tool-bar-make-keymap' in tool-bar.el). */
11851 eassert (EQ (selected_window
,
11852 /* Since we only explicitly preserve selected_frame,
11853 check that selected_window would be redundant. */
11854 XFRAME (selected_frame
)->selected_window
));
11855 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11856 XSETFRAME (frame
, f
);
11857 fast_set_selected_frame (frame
);
11859 /* Build desired tool-bar items from keymaps. */
11861 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11864 /* Redisplay the tool-bar if we changed it. */
11865 if (new_n_tool_bar
!= f
->n_tool_bar_items
11866 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11868 /* Redisplay that happens asynchronously due to an expose event
11869 may access f->tool_bar_items. Make sure we update both
11870 variables within BLOCK_INPUT so no such event interrupts. */
11872 fset_tool_bar_items (f
, new_tool_bar
);
11873 f
->n_tool_bar_items
= new_n_tool_bar
;
11874 w
->update_mode_line
= true;
11880 unbind_to (count
, Qnil
);
11881 set_buffer_internal_1 (prev
);
11886 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11888 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11889 F's desired tool-bar contents. F->tool_bar_items must have
11890 been set up previously by calling prepare_menu_bars. */
11893 build_desired_tool_bar_string (struct frame
*f
)
11895 int i
, size
, size_needed
;
11896 struct gcpro gcpro1
, gcpro2
;
11897 Lisp_Object image
, plist
;
11899 image
= plist
= Qnil
;
11900 GCPRO2 (image
, plist
);
11902 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11903 Otherwise, make a new string. */
11905 /* The size of the string we might be able to reuse. */
11906 size
= (STRINGP (f
->desired_tool_bar_string
)
11907 ? SCHARS (f
->desired_tool_bar_string
)
11910 /* We need one space in the string for each image. */
11911 size_needed
= f
->n_tool_bar_items
;
11913 /* Reuse f->desired_tool_bar_string, if possible. */
11914 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11915 fset_desired_tool_bar_string
11916 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11919 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11920 struct gcpro gcpro1
;
11922 Fremove_text_properties (make_number (0), make_number (size
),
11923 props
, f
->desired_tool_bar_string
);
11927 /* Put a `display' property on the string for the images to display,
11928 put a `menu_item' property on tool-bar items with a value that
11929 is the index of the item in F's tool-bar item vector. */
11930 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11932 #define PROP(IDX) \
11933 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11935 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11936 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11937 int hmargin
, vmargin
, relief
, idx
, end
;
11939 /* If image is a vector, choose the image according to the
11941 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11942 if (VECTORP (image
))
11946 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11947 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11950 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11951 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11953 eassert (ASIZE (image
) >= idx
);
11954 image
= AREF (image
, idx
);
11959 /* Ignore invalid image specifications. */
11960 if (!valid_image_p (image
))
11963 /* Display the tool-bar button pressed, or depressed. */
11964 plist
= Fcopy_sequence (XCDR (image
));
11966 /* Compute margin and relief to draw. */
11967 relief
= (tool_bar_button_relief
>= 0
11968 ? tool_bar_button_relief
11969 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11970 hmargin
= vmargin
= relief
;
11972 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11973 INT_MAX
- max (hmargin
, vmargin
)))
11975 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11976 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11978 else if (CONSP (Vtool_bar_button_margin
))
11980 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11981 INT_MAX
- hmargin
))
11982 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11984 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11985 INT_MAX
- vmargin
))
11986 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11989 if (auto_raise_tool_bar_buttons_p
)
11991 /* Add a `:relief' property to the image spec if the item is
11995 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12002 /* If image is selected, display it pressed, i.e. with a
12003 negative relief. If it's not selected, display it with a
12005 plist
= Fplist_put (plist
, QCrelief
,
12007 ? make_number (-relief
)
12008 : make_number (relief
)));
12013 /* Put a margin around the image. */
12014 if (hmargin
|| vmargin
)
12016 if (hmargin
== vmargin
)
12017 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12019 plist
= Fplist_put (plist
, QCmargin
,
12020 Fcons (make_number (hmargin
),
12021 make_number (vmargin
)));
12024 /* If button is not enabled, and we don't have special images
12025 for the disabled state, make the image appear disabled by
12026 applying an appropriate algorithm to it. */
12027 if (!enabled_p
&& idx
< 0)
12028 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12030 /* Put a `display' text property on the string for the image to
12031 display. Put a `menu-item' property on the string that gives
12032 the start of this item's properties in the tool-bar items
12034 image
= Fcons (Qimage
, plist
);
12035 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12036 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12037 struct gcpro gcpro1
;
12040 /* Let the last image hide all remaining spaces in the tool bar
12041 string. The string can be longer than needed when we reuse a
12042 previous string. */
12043 if (i
+ 1 == f
->n_tool_bar_items
)
12044 end
= SCHARS (f
->desired_tool_bar_string
);
12047 Fadd_text_properties (make_number (i
), make_number (end
),
12048 props
, f
->desired_tool_bar_string
);
12057 /* Display one line of the tool-bar of frame IT->f.
12059 HEIGHT specifies the desired height of the tool-bar line.
12060 If the actual height of the glyph row is less than HEIGHT, the
12061 row's height is increased to HEIGHT, and the icons are centered
12062 vertically in the new height.
12064 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12065 count a final empty row in case the tool-bar width exactly matches
12070 display_tool_bar_line (struct it
*it
, int height
)
12072 struct glyph_row
*row
= it
->glyph_row
;
12073 int max_x
= it
->last_visible_x
;
12074 struct glyph
*last
;
12076 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12077 clear_glyph_row (row
);
12078 row
->enabled_p
= true;
12079 row
->y
= it
->current_y
;
12081 /* Note that this isn't made use of if the face hasn't a box,
12082 so there's no need to check the face here. */
12083 it
->start_of_box_run_p
= true;
12085 while (it
->current_x
< max_x
)
12087 int x
, n_glyphs_before
, i
, nglyphs
;
12088 struct it it_before
;
12090 /* Get the next display element. */
12091 if (!get_next_display_element (it
))
12093 /* Don't count empty row if we are counting needed tool-bar lines. */
12094 if (height
< 0 && !it
->hpos
)
12099 /* Produce glyphs. */
12100 n_glyphs_before
= row
->used
[TEXT_AREA
];
12103 PRODUCE_GLYPHS (it
);
12105 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12107 x
= it_before
.current_x
;
12108 while (i
< nglyphs
)
12110 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12112 if (x
+ glyph
->pixel_width
> max_x
)
12114 /* Glyph doesn't fit on line. Backtrack. */
12115 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12117 /* If this is the only glyph on this line, it will never fit on the
12118 tool-bar, so skip it. But ensure there is at least one glyph,
12119 so we don't accidentally disable the tool-bar. */
12120 if (n_glyphs_before
== 0
12121 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12127 x
+= glyph
->pixel_width
;
12131 /* Stop at line end. */
12132 if (ITERATOR_AT_END_OF_LINE_P (it
))
12135 set_iterator_to_next (it
, true);
12140 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12142 /* Use default face for the border below the tool bar.
12144 FIXME: When auto-resize-tool-bars is grow-only, there is
12145 no additional border below the possibly empty tool-bar lines.
12146 So to make the extra empty lines look "normal", we have to
12147 use the tool-bar face for the border too. */
12148 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12149 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12150 it
->face_id
= DEFAULT_FACE_ID
;
12152 extend_face_to_end_of_line (it
);
12153 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12154 last
->right_box_line_p
= true;
12155 if (last
== row
->glyphs
[TEXT_AREA
])
12156 last
->left_box_line_p
= true;
12158 /* Make line the desired height and center it vertically. */
12159 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12161 /* Don't add more than one line height. */
12162 height
%= FRAME_LINE_HEIGHT (it
->f
);
12163 it
->max_ascent
+= height
/ 2;
12164 it
->max_descent
+= (height
+ 1) / 2;
12167 compute_line_metrics (it
);
12169 /* If line is empty, make it occupy the rest of the tool-bar. */
12170 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12172 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12173 row
->visible_height
= row
->height
;
12174 row
->ascent
= row
->phys_ascent
= 0;
12175 row
->extra_line_spacing
= 0;
12178 row
->full_width_p
= true;
12179 row
->continued_p
= false;
12180 row
->truncated_on_left_p
= false;
12181 row
->truncated_on_right_p
= false;
12183 it
->current_x
= it
->hpos
= 0;
12184 it
->current_y
+= row
->height
;
12190 /* Value is the number of pixels needed to make all tool-bar items of
12191 frame F visible. The actual number of glyph rows needed is
12192 returned in *N_ROWS if non-NULL. */
12194 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12196 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12198 /* tool_bar_height is called from redisplay_tool_bar after building
12199 the desired matrix, so use (unused) mode-line row as temporary row to
12200 avoid destroying the first tool-bar row. */
12201 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12203 /* Initialize an iterator for iteration over
12204 F->desired_tool_bar_string in the tool-bar window of frame F. */
12205 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12206 temp_row
->reversed_p
= false;
12207 it
.first_visible_x
= 0;
12208 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12209 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12210 it
.paragraph_embedding
= L2R
;
12212 while (!ITERATOR_AT_END_P (&it
))
12214 clear_glyph_row (temp_row
);
12215 it
.glyph_row
= temp_row
;
12216 display_tool_bar_line (&it
, -1);
12218 clear_glyph_row (temp_row
);
12220 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12222 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12225 return it
.current_y
;
12227 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12230 #endif /* !USE_GTK && !HAVE_NS */
12232 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12234 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12235 If FRAME is nil or omitted, use the selected frame. Optional argument
12236 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12237 (Lisp_Object frame
, Lisp_Object pixelwise
)
12241 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12242 struct frame
*f
= decode_any_frame (frame
);
12244 if (WINDOWP (f
->tool_bar_window
)
12245 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12247 update_tool_bar (f
, true);
12248 if (f
->n_tool_bar_items
)
12250 build_desired_tool_bar_string (f
);
12251 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12256 return make_number (height
);
12260 /* Display the tool-bar of frame F. Value is true if tool-bar's
12261 height should be changed. */
12263 redisplay_tool_bar (struct frame
*f
)
12265 #if defined (USE_GTK) || defined (HAVE_NS)
12267 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12268 update_frame_tool_bar (f
);
12271 #else /* !USE_GTK && !HAVE_NS */
12275 struct glyph_row
*row
;
12277 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12278 do anything. This means you must start with tool-bar-lines
12279 non-zero to get the auto-sizing effect. Or in other words, you
12280 can turn off tool-bars by specifying tool-bar-lines zero. */
12281 if (!WINDOWP (f
->tool_bar_window
)
12282 || (w
= XWINDOW (f
->tool_bar_window
),
12283 WINDOW_TOTAL_LINES (w
) == 0))
12286 /* Set up an iterator for the tool-bar window. */
12287 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12288 it
.first_visible_x
= 0;
12289 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12290 row
= it
.glyph_row
;
12291 row
->reversed_p
= false;
12293 /* Build a string that represents the contents of the tool-bar. */
12294 build_desired_tool_bar_string (f
);
12295 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12296 /* FIXME: This should be controlled by a user option. But it
12297 doesn't make sense to have an R2L tool bar if the menu bar cannot
12298 be drawn also R2L, and making the menu bar R2L is tricky due
12299 toolkit-specific code that implements it. If an R2L tool bar is
12300 ever supported, display_tool_bar_line should also be augmented to
12301 call unproduce_glyphs like display_line and display_string
12303 it
.paragraph_embedding
= L2R
;
12305 if (f
->n_tool_bar_rows
== 0)
12307 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12309 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12311 x_change_tool_bar_height (f
, new_height
);
12312 frame_default_tool_bar_height
= new_height
;
12313 /* Always do that now. */
12314 clear_glyph_matrix (w
->desired_matrix
);
12315 f
->fonts_changed
= true;
12320 /* Display as many lines as needed to display all tool-bar items. */
12322 if (f
->n_tool_bar_rows
> 0)
12324 int border
, rows
, height
, extra
;
12326 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12327 border
= XINT (Vtool_bar_border
);
12328 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12329 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12330 else if (EQ (Vtool_bar_border
, Qborder_width
))
12331 border
= f
->border_width
;
12337 rows
= f
->n_tool_bar_rows
;
12338 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12339 extra
= it
.last_visible_y
- border
- height
* rows
;
12341 while (it
.current_y
< it
.last_visible_y
)
12344 if (extra
> 0 && rows
-- > 0)
12346 h
= (extra
+ rows
- 1) / rows
;
12349 display_tool_bar_line (&it
, height
+ h
);
12354 while (it
.current_y
< it
.last_visible_y
)
12355 display_tool_bar_line (&it
, 0);
12358 /* It doesn't make much sense to try scrolling in the tool-bar
12359 window, so don't do it. */
12360 w
->desired_matrix
->no_scrolling_p
= true;
12361 w
->must_be_updated_p
= true;
12363 if (!NILP (Vauto_resize_tool_bars
))
12365 bool change_height_p
= true;
12367 /* If we couldn't display everything, change the tool-bar's
12368 height if there is room for more. */
12369 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12370 change_height_p
= true;
12372 /* We subtract 1 because display_tool_bar_line advances the
12373 glyph_row pointer before returning to its caller. We want to
12374 examine the last glyph row produced by
12375 display_tool_bar_line. */
12376 row
= it
.glyph_row
- 1;
12378 /* If there are blank lines at the end, except for a partially
12379 visible blank line at the end that is smaller than
12380 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12381 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12382 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12383 change_height_p
= true;
12385 /* If row displays tool-bar items, but is partially visible,
12386 change the tool-bar's height. */
12387 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12388 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12389 change_height_p
= true;
12391 /* Resize windows as needed by changing the `tool-bar-lines'
12392 frame parameter. */
12393 if (change_height_p
)
12396 int new_height
= tool_bar_height (f
, &nrows
, true);
12398 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12399 && !f
->minimize_tool_bar_window_p
)
12400 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12401 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12402 f
->minimize_tool_bar_window_p
= false;
12404 if (change_height_p
)
12406 x_change_tool_bar_height (f
, new_height
);
12407 frame_default_tool_bar_height
= new_height
;
12408 clear_glyph_matrix (w
->desired_matrix
);
12409 f
->n_tool_bar_rows
= nrows
;
12410 f
->fonts_changed
= true;
12417 f
->minimize_tool_bar_window_p
= false;
12420 #endif /* USE_GTK || HAVE_NS */
12423 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12425 /* Get information about the tool-bar item which is displayed in GLYPH
12426 on frame F. Return in *PROP_IDX the index where tool-bar item
12427 properties start in F->tool_bar_items. Value is false if
12428 GLYPH doesn't display a tool-bar item. */
12431 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12436 /* This function can be called asynchronously, which means we must
12437 exclude any possibility that Fget_text_property signals an
12439 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12440 charpos
= max (0, charpos
);
12442 /* Get the text property `menu-item' at pos. The value of that
12443 property is the start index of this item's properties in
12444 F->tool_bar_items. */
12445 prop
= Fget_text_property (make_number (charpos
),
12446 Qmenu_item
, f
->current_tool_bar_string
);
12447 if (! INTEGERP (prop
))
12449 *prop_idx
= XINT (prop
);
12454 /* Get information about the tool-bar item at position X/Y on frame F.
12455 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12456 the current matrix of the tool-bar window of F, or NULL if not
12457 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12458 item in F->tool_bar_items. Value is
12460 -1 if X/Y is not on a tool-bar item
12461 0 if X/Y is on the same item that was highlighted before.
12465 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12466 int *hpos
, int *vpos
, int *prop_idx
)
12468 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12469 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12472 /* Find the glyph under X/Y. */
12473 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12474 if (*glyph
== NULL
)
12477 /* Get the start of this tool-bar item's properties in
12478 f->tool_bar_items. */
12479 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12482 /* Is mouse on the highlighted item? */
12483 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12484 && *vpos
>= hlinfo
->mouse_face_beg_row
12485 && *vpos
<= hlinfo
->mouse_face_end_row
12486 && (*vpos
> hlinfo
->mouse_face_beg_row
12487 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12488 && (*vpos
< hlinfo
->mouse_face_end_row
12489 || *hpos
< hlinfo
->mouse_face_end_col
12490 || hlinfo
->mouse_face_past_end
))
12498 Handle mouse button event on the tool-bar of frame F, at
12499 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12500 false for button release. MODIFIERS is event modifiers for button
12504 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12507 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12508 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12509 int hpos
, vpos
, prop_idx
;
12510 struct glyph
*glyph
;
12511 Lisp_Object enabled_p
;
12514 /* If not on the highlighted tool-bar item, and mouse-highlight is
12515 non-nil, return. This is so we generate the tool-bar button
12516 click only when the mouse button is released on the same item as
12517 where it was pressed. However, when mouse-highlight is disabled,
12518 generate the click when the button is released regardless of the
12519 highlight, since tool-bar items are not highlighted in that
12521 frame_to_window_pixel_xy (w
, &x
, &y
);
12522 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12524 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12527 /* When mouse-highlight is off, generate the click for the item
12528 where the button was pressed, disregarding where it was
12530 if (NILP (Vmouse_highlight
) && !down_p
)
12531 prop_idx
= f
->last_tool_bar_item
;
12533 /* If item is disabled, do nothing. */
12534 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12535 if (NILP (enabled_p
))
12540 /* Show item in pressed state. */
12541 if (!NILP (Vmouse_highlight
))
12542 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12543 f
->last_tool_bar_item
= prop_idx
;
12547 Lisp_Object key
, frame
;
12548 struct input_event event
;
12549 EVENT_INIT (event
);
12551 /* Show item in released state. */
12552 if (!NILP (Vmouse_highlight
))
12553 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12555 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12557 XSETFRAME (frame
, f
);
12558 event
.kind
= TOOL_BAR_EVENT
;
12559 event
.frame_or_window
= frame
;
12561 kbd_buffer_store_event (&event
);
12563 event
.kind
= TOOL_BAR_EVENT
;
12564 event
.frame_or_window
= frame
;
12566 event
.modifiers
= modifiers
;
12567 kbd_buffer_store_event (&event
);
12568 f
->last_tool_bar_item
= -1;
12573 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12574 tool-bar window-relative coordinates X/Y. Called from
12575 note_mouse_highlight. */
12578 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12580 Lisp_Object window
= f
->tool_bar_window
;
12581 struct window
*w
= XWINDOW (window
);
12582 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12583 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12585 struct glyph
*glyph
;
12586 struct glyph_row
*row
;
12588 Lisp_Object enabled_p
;
12590 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12594 /* Function note_mouse_highlight is called with negative X/Y
12595 values when mouse moves outside of the frame. */
12596 if (x
<= 0 || y
<= 0)
12598 clear_mouse_face (hlinfo
);
12602 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12605 /* Not on tool-bar item. */
12606 clear_mouse_face (hlinfo
);
12610 /* On same tool-bar item as before. */
12611 goto set_help_echo
;
12613 clear_mouse_face (hlinfo
);
12615 /* Mouse is down, but on different tool-bar item? */
12616 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12617 && f
== dpyinfo
->last_mouse_frame
);
12619 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12622 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12624 /* If tool-bar item is not enabled, don't highlight it. */
12625 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12626 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12628 /* Compute the x-position of the glyph. In front and past the
12629 image is a space. We include this in the highlighted area. */
12630 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12631 for (i
= x
= 0; i
< hpos
; ++i
)
12632 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12634 /* Record this as the current active region. */
12635 hlinfo
->mouse_face_beg_col
= hpos
;
12636 hlinfo
->mouse_face_beg_row
= vpos
;
12637 hlinfo
->mouse_face_beg_x
= x
;
12638 hlinfo
->mouse_face_past_end
= false;
12640 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12641 hlinfo
->mouse_face_end_row
= vpos
;
12642 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12643 hlinfo
->mouse_face_window
= window
;
12644 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12646 /* Display it as active. */
12647 show_mouse_face (hlinfo
, draw
);
12652 /* Set help_echo_string to a help string to display for this tool-bar item.
12653 XTread_socket does the rest. */
12654 help_echo_object
= help_echo_window
= Qnil
;
12655 help_echo_pos
= -1;
12656 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12657 if (NILP (help_echo_string
))
12658 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12661 #endif /* !USE_GTK && !HAVE_NS */
12663 #endif /* HAVE_WINDOW_SYSTEM */
12667 /************************************************************************
12668 Horizontal scrolling
12669 ************************************************************************/
12671 /* For all leaf windows in the window tree rooted at WINDOW, set their
12672 hscroll value so that PT is (i) visible in the window, and (ii) so
12673 that it is not within a certain margin at the window's left and
12674 right border. Value is true if any window's hscroll has been
12678 hscroll_window_tree (Lisp_Object window
)
12680 bool hscrolled_p
= false;
12681 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12682 int hscroll_step_abs
= 0;
12683 double hscroll_step_rel
= 0;
12685 if (hscroll_relative_p
)
12687 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12688 if (hscroll_step_rel
< 0)
12690 hscroll_relative_p
= false;
12691 hscroll_step_abs
= 0;
12694 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12696 hscroll_step_abs
= XINT (Vhscroll_step
);
12697 if (hscroll_step_abs
< 0)
12698 hscroll_step_abs
= 0;
12701 hscroll_step_abs
= 0;
12703 while (WINDOWP (window
))
12705 struct window
*w
= XWINDOW (window
);
12707 if (WINDOWP (w
->contents
))
12708 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12709 else if (w
->cursor
.vpos
>= 0)
12712 int text_area_width
;
12713 struct glyph_row
*cursor_row
;
12714 struct glyph_row
*bottom_row
;
12716 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12717 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12718 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12720 cursor_row
= bottom_row
- 1;
12722 if (!cursor_row
->enabled_p
)
12724 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12725 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12726 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12728 cursor_row
= bottom_row
- 1;
12730 bool row_r2l_p
= cursor_row
->reversed_p
;
12732 text_area_width
= window_box_width (w
, TEXT_AREA
);
12734 /* Scroll when cursor is inside this scroll margin. */
12735 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12737 /* If the position of this window's point has explicitly
12738 changed, no more suspend auto hscrolling. */
12739 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12740 w
->suspend_auto_hscroll
= false;
12742 /* Remember window point. */
12743 Fset_marker (w
->old_pointm
,
12744 ((w
== XWINDOW (selected_window
))
12745 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12746 : Fmarker_position (w
->pointm
)),
12749 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12750 && !w
->suspend_auto_hscroll
12751 /* In some pathological cases, like restoring a window
12752 configuration into a frame that is much smaller than
12753 the one from which the configuration was saved, we
12754 get glyph rows whose start and end have zero buffer
12755 positions, which we cannot handle below. Just skip
12757 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12758 /* For left-to-right rows, hscroll when cursor is either
12759 (i) inside the right hscroll margin, or (ii) if it is
12760 inside the left margin and the window is already
12763 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12764 || (cursor_row
->enabled_p
12765 && cursor_row
->truncated_on_right_p
12766 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12767 /* For right-to-left rows, the logic is similar,
12768 except that rules for scrolling to left and right
12769 are reversed. E.g., if cursor.x <= h_margin, we
12770 need to hscroll "to the right" unconditionally,
12771 and that will scroll the screen to the left so as
12772 to reveal the next portion of the row. */
12774 && ((cursor_row
->enabled_p
12775 /* FIXME: It is confusing to set the
12776 truncated_on_right_p flag when R2L rows
12777 are actually truncated on the left. */
12778 && cursor_row
->truncated_on_right_p
12779 && w
->cursor
.x
<= h_margin
)
12781 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12785 struct buffer
*saved_current_buffer
;
12789 /* Find point in a display of infinite width. */
12790 saved_current_buffer
= current_buffer
;
12791 current_buffer
= XBUFFER (w
->contents
);
12793 if (w
== XWINDOW (selected_window
))
12796 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12798 /* Move iterator to pt starting at cursor_row->start in
12799 a line with infinite width. */
12800 init_to_row_start (&it
, w
, cursor_row
);
12801 it
.last_visible_x
= INFINITY
;
12802 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12803 current_buffer
= saved_current_buffer
;
12805 /* Position cursor in window. */
12806 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12807 hscroll
= max (0, (it
.current_x
12808 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12809 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12810 : (text_area_width
/ 2))))
12811 / FRAME_COLUMN_WIDTH (it
.f
);
12812 else if ((!row_r2l_p
12813 && w
->cursor
.x
>= text_area_width
- h_margin
)
12814 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12816 if (hscroll_relative_p
)
12817 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12820 wanted_x
= text_area_width
12821 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12824 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12828 if (hscroll_relative_p
)
12829 wanted_x
= text_area_width
* hscroll_step_rel
12832 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12835 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12837 hscroll
= max (hscroll
, w
->min_hscroll
);
12839 /* Don't prevent redisplay optimizations if hscroll
12840 hasn't changed, as it will unnecessarily slow down
12842 if (w
->hscroll
!= hscroll
)
12844 struct buffer
*b
= XBUFFER (w
->contents
);
12845 b
->prevent_redisplay_optimizations_p
= true;
12846 w
->hscroll
= hscroll
;
12847 hscrolled_p
= true;
12855 /* Value is true if hscroll of any leaf window has been changed. */
12856 return hscrolled_p
;
12860 /* Set hscroll so that cursor is visible and not inside horizontal
12861 scroll margins for all windows in the tree rooted at WINDOW. See
12862 also hscroll_window_tree above. Value is true if any window's
12863 hscroll has been changed. If it has, desired matrices on the frame
12864 of WINDOW are cleared. */
12867 hscroll_windows (Lisp_Object window
)
12869 bool hscrolled_p
= hscroll_window_tree (window
);
12871 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12872 return hscrolled_p
;
12877 /************************************************************************
12879 ************************************************************************/
12881 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12882 This is sometimes handy to have in a debugger session. */
12886 /* First and last unchanged row for try_window_id. */
12888 static int debug_first_unchanged_at_end_vpos
;
12889 static int debug_last_unchanged_at_beg_vpos
;
12891 /* Delta vpos and y. */
12893 static int debug_dvpos
, debug_dy
;
12895 /* Delta in characters and bytes for try_window_id. */
12897 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12899 /* Values of window_end_pos and window_end_vpos at the end of
12902 static ptrdiff_t debug_end_vpos
;
12904 /* Append a string to W->desired_matrix->method. FMT is a printf
12905 format string. If trace_redisplay_p is true also printf the
12906 resulting string to stderr. */
12908 static void debug_method_add (struct window
*, char const *, ...)
12909 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12912 debug_method_add (struct window
*w
, char const *fmt
, ...)
12915 char *method
= w
->desired_matrix
->method
;
12916 int len
= strlen (method
);
12917 int size
= sizeof w
->desired_matrix
->method
;
12918 int remaining
= size
- len
- 1;
12921 if (len
&& remaining
)
12924 --remaining
, ++len
;
12927 va_start (ap
, fmt
);
12928 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12931 if (trace_redisplay_p
)
12932 fprintf (stderr
, "%p (%s): %s\n",
12934 ((BUFFERP (w
->contents
)
12935 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12936 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12941 #endif /* GLYPH_DEBUG */
12944 /* Value is true if all changes in window W, which displays
12945 current_buffer, are in the text between START and END. START is a
12946 buffer position, END is given as a distance from Z. Used in
12947 redisplay_internal for display optimization. */
12950 text_outside_line_unchanged_p (struct window
*w
,
12951 ptrdiff_t start
, ptrdiff_t end
)
12953 bool unchanged_p
= true;
12955 /* If text or overlays have changed, see where. */
12956 if (window_outdated (w
))
12958 /* Gap in the line? */
12959 if (GPT
< start
|| Z
- GPT
< end
)
12960 unchanged_p
= false;
12962 /* Changes start in front of the line, or end after it? */
12964 && (BEG_UNCHANGED
< start
- 1
12965 || END_UNCHANGED
< end
))
12966 unchanged_p
= false;
12968 /* If selective display, can't optimize if changes start at the
12969 beginning of the line. */
12971 && INTEGERP (BVAR (current_buffer
, selective_display
))
12972 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12973 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12974 unchanged_p
= false;
12976 /* If there are overlays at the start or end of the line, these
12977 may have overlay strings with newlines in them. A change at
12978 START, for instance, may actually concern the display of such
12979 overlay strings as well, and they are displayed on different
12980 lines. So, quickly rule out this case. (For the future, it
12981 might be desirable to implement something more telling than
12982 just BEG/END_UNCHANGED.) */
12985 if (BEG
+ BEG_UNCHANGED
== start
12986 && overlay_touches_p (start
))
12987 unchanged_p
= false;
12988 if (END_UNCHANGED
== end
12989 && overlay_touches_p (Z
- end
))
12990 unchanged_p
= false;
12993 /* Under bidi reordering, adding or deleting a character in the
12994 beginning of a paragraph, before the first strong directional
12995 character, can change the base direction of the paragraph (unless
12996 the buffer specifies a fixed paragraph direction), which will
12997 require to redisplay the whole paragraph. It might be worthwhile
12998 to find the paragraph limits and widen the range of redisplayed
12999 lines to that, but for now just give up this optimization. */
13000 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13001 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13002 unchanged_p
= false;
13005 return unchanged_p
;
13009 /* Do a frame update, taking possible shortcuts into account. This is
13010 the main external entry point for redisplay.
13012 If the last redisplay displayed an echo area message and that message
13013 is no longer requested, we clear the echo area or bring back the
13014 mini-buffer if that is in use. */
13019 redisplay_internal ();
13024 overlay_arrow_string_or_property (Lisp_Object var
)
13028 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13031 return Voverlay_arrow_string
;
13034 /* Return true if there are any overlay-arrows in current_buffer. */
13036 overlay_arrow_in_current_buffer_p (void)
13040 for (vlist
= Voverlay_arrow_variable_list
;
13042 vlist
= XCDR (vlist
))
13044 Lisp_Object var
= XCAR (vlist
);
13047 if (!SYMBOLP (var
))
13049 val
= find_symbol_value (var
);
13051 && current_buffer
== XMARKER (val
)->buffer
)
13058 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13062 overlay_arrows_changed_p (void)
13066 for (vlist
= Voverlay_arrow_variable_list
;
13068 vlist
= XCDR (vlist
))
13070 Lisp_Object var
= XCAR (vlist
);
13071 Lisp_Object val
, pstr
;
13073 if (!SYMBOLP (var
))
13075 val
= find_symbol_value (var
);
13076 if (!MARKERP (val
))
13078 if (! EQ (COERCE_MARKER (val
),
13079 Fget (var
, Qlast_arrow_position
))
13080 || ! (pstr
= overlay_arrow_string_or_property (var
),
13081 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13087 /* Mark overlay arrows to be updated on next redisplay. */
13090 update_overlay_arrows (int up_to_date
)
13094 for (vlist
= Voverlay_arrow_variable_list
;
13096 vlist
= XCDR (vlist
))
13098 Lisp_Object var
= XCAR (vlist
);
13100 if (!SYMBOLP (var
))
13103 if (up_to_date
> 0)
13105 Lisp_Object val
= find_symbol_value (var
);
13106 Fput (var
, Qlast_arrow_position
,
13107 COERCE_MARKER (val
));
13108 Fput (var
, Qlast_arrow_string
,
13109 overlay_arrow_string_or_property (var
));
13111 else if (up_to_date
< 0
13112 || !NILP (Fget (var
, Qlast_arrow_position
)))
13114 Fput (var
, Qlast_arrow_position
, Qt
);
13115 Fput (var
, Qlast_arrow_string
, Qt
);
13121 /* Return overlay arrow string to display at row.
13122 Return integer (bitmap number) for arrow bitmap in left fringe.
13123 Return nil if no overlay arrow. */
13126 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13130 for (vlist
= Voverlay_arrow_variable_list
;
13132 vlist
= XCDR (vlist
))
13134 Lisp_Object var
= XCAR (vlist
);
13137 if (!SYMBOLP (var
))
13140 val
= find_symbol_value (var
);
13143 && current_buffer
== XMARKER (val
)->buffer
13144 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13146 if (FRAME_WINDOW_P (it
->f
)
13147 /* FIXME: if ROW->reversed_p is set, this should test
13148 the right fringe, not the left one. */
13149 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13151 #ifdef HAVE_WINDOW_SYSTEM
13152 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13154 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13155 if (fringe_bitmap
!= 0)
13156 return make_number (fringe_bitmap
);
13159 return make_number (-1); /* Use default arrow bitmap. */
13161 return overlay_arrow_string_or_property (var
);
13168 /* Return true if point moved out of or into a composition. Otherwise
13169 return false. PREV_BUF and PREV_PT are the last point buffer and
13170 position. BUF and PT are the current point buffer and position. */
13173 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13174 struct buffer
*buf
, ptrdiff_t pt
)
13176 ptrdiff_t start
, end
;
13178 Lisp_Object buffer
;
13180 XSETBUFFER (buffer
, buf
);
13181 /* Check a composition at the last point if point moved within the
13183 if (prev_buf
== buf
)
13186 /* Point didn't move. */
13189 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13190 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13191 && composition_valid_p (start
, end
, prop
)
13192 && start
< prev_pt
&& end
> prev_pt
)
13193 /* The last point was within the composition. Return true iff
13194 point moved out of the composition. */
13195 return (pt
<= start
|| pt
>= end
);
13198 /* Check a composition at the current point. */
13199 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13200 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13201 && composition_valid_p (start
, end
, prop
)
13202 && start
< pt
&& end
> pt
);
13205 /* Reconsider the clip changes of buffer which is displayed in W. */
13208 reconsider_clip_changes (struct window
*w
)
13210 struct buffer
*b
= XBUFFER (w
->contents
);
13212 if (b
->clip_changed
13213 && w
->window_end_valid
13214 && w
->current_matrix
->buffer
== b
13215 && w
->current_matrix
->zv
== BUF_ZV (b
)
13216 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13217 b
->clip_changed
= false;
13219 /* If display wasn't paused, and W is not a tool bar window, see if
13220 point has been moved into or out of a composition. In that case,
13221 set b->clip_changed to force updating the screen. If
13222 b->clip_changed has already been set, skip this check. */
13223 if (!b
->clip_changed
&& w
->window_end_valid
)
13225 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13226 ? PT
: marker_position (w
->pointm
));
13228 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13229 && check_point_in_composition (w
->current_matrix
->buffer
,
13230 w
->last_point
, b
, pt
))
13231 b
->clip_changed
= true;
13236 propagate_buffer_redisplay (void)
13237 { /* Resetting b->text->redisplay is problematic!
13238 We can't just reset it in the case that some window that displays
13239 it has not been redisplayed; and such a window can stay
13240 unredisplayed for a long time if it's currently invisible.
13241 But we do want to reset it at the end of redisplay otherwise
13242 its displayed windows will keep being redisplayed over and over
13244 So we copy all b->text->redisplay flags up to their windows here,
13245 such that mark_window_display_accurate can safely reset
13246 b->text->redisplay. */
13247 Lisp_Object ws
= window_list ();
13248 for (; CONSP (ws
); ws
= XCDR (ws
))
13250 struct window
*thisw
= XWINDOW (XCAR (ws
));
13251 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13252 if (thisb
->text
->redisplay
)
13253 thisw
->redisplay
= true;
13257 #define STOP_POLLING \
13258 do { if (! polling_stopped_here) stop_polling (); \
13259 polling_stopped_here = true; } while (false)
13261 #define RESUME_POLLING \
13262 do { if (polling_stopped_here) start_polling (); \
13263 polling_stopped_here = false; } while (false)
13266 /* Perhaps in the future avoid recentering windows if it
13267 is not necessary; currently that causes some problems. */
13270 redisplay_internal (void)
13272 struct window
*w
= XWINDOW (selected_window
);
13276 bool must_finish
= false, match_p
;
13277 struct text_pos tlbufpos
, tlendpos
;
13278 int number_of_visible_frames
;
13281 bool polling_stopped_here
= false;
13282 Lisp_Object tail
, frame
;
13284 /* True means redisplay has to consider all windows on all
13285 frames. False, only selected_window is considered. */
13286 bool consider_all_windows_p
;
13288 /* True means redisplay has to redisplay the miniwindow. */
13289 bool update_miniwindow_p
= false;
13291 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13293 /* No redisplay if running in batch mode or frame is not yet fully
13294 initialized, or redisplay is explicitly turned off by setting
13295 Vinhibit_redisplay. */
13296 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13297 || !NILP (Vinhibit_redisplay
))
13300 /* Don't examine these until after testing Vinhibit_redisplay.
13301 When Emacs is shutting down, perhaps because its connection to
13302 X has dropped, we should not look at them at all. */
13303 fr
= XFRAME (w
->frame
);
13304 sf
= SELECTED_FRAME ();
13306 if (!fr
->glyphs_initialized_p
)
13309 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13310 if (popup_activated ())
13314 /* I don't think this happens but let's be paranoid. */
13315 if (redisplaying_p
)
13318 /* Record a function that clears redisplaying_p
13319 when we leave this function. */
13320 count
= SPECPDL_INDEX ();
13321 record_unwind_protect_void (unwind_redisplay
);
13322 redisplaying_p
= true;
13323 specbind (Qinhibit_free_realized_faces
, Qnil
);
13325 /* Record this function, so it appears on the profiler's backtraces. */
13326 record_in_backtrace (Qredisplay_internal
, 0, 0);
13328 FOR_EACH_FRAME (tail
, frame
)
13329 XFRAME (frame
)->already_hscrolled_p
= false;
13332 /* Remember the currently selected window. */
13336 last_escape_glyph_frame
= NULL
;
13337 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13338 last_glyphless_glyph_frame
= NULL
;
13339 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13341 /* If face_change, init_iterator will free all realized faces, which
13342 includes the faces referenced from current matrices. So, we
13343 can't reuse current matrices in this case. */
13345 windows_or_buffers_changed
= 47;
13347 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13348 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13350 /* Since frames on a single ASCII terminal share the same
13351 display area, displaying a different frame means redisplay
13352 the whole thing. */
13353 SET_FRAME_GARBAGED (sf
);
13355 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13357 FRAME_TTY (sf
)->previous_frame
= sf
;
13360 /* Set the visible flags for all frames. Do this before checking for
13361 resized or garbaged frames; they want to know if their frames are
13362 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13363 number_of_visible_frames
= 0;
13365 FOR_EACH_FRAME (tail
, frame
)
13367 struct frame
*f
= XFRAME (frame
);
13369 if (FRAME_VISIBLE_P (f
))
13371 ++number_of_visible_frames
;
13372 /* Adjust matrices for visible frames only. */
13373 if (f
->fonts_changed
)
13375 adjust_frame_glyphs (f
);
13376 /* Disable all redisplay optimizations for this frame.
13377 This is because adjust_frame_glyphs resets the
13378 enabled_p flag for all glyph rows of all windows, so
13379 many optimizations will fail anyway, and some might
13380 fail to test that flag and do bogus things as
13382 SET_FRAME_GARBAGED (f
);
13383 f
->fonts_changed
= false;
13385 /* If cursor type has been changed on the frame
13386 other than selected, consider all frames. */
13387 if (f
!= sf
&& f
->cursor_type_changed
)
13388 update_mode_lines
= 31;
13390 clear_desired_matrices (f
);
13393 /* Notice any pending interrupt request to change frame size. */
13394 do_pending_window_change (true);
13396 /* do_pending_window_change could change the selected_window due to
13397 frame resizing which makes the selected window too small. */
13398 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13401 /* Clear frames marked as garbaged. */
13402 clear_garbaged_frames ();
13404 /* Build menubar and tool-bar items. */
13405 if (NILP (Vmemory_full
))
13406 prepare_menu_bars ();
13408 reconsider_clip_changes (w
);
13410 /* In most cases selected window displays current buffer. */
13411 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13414 /* Detect case that we need to write or remove a star in the mode line. */
13415 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13416 w
->update_mode_line
= true;
13418 if (mode_line_update_needed (w
))
13419 w
->update_mode_line
= true;
13421 /* If reconsider_clip_changes above decided that the narrowing
13422 in the current buffer changed, make sure all other windows
13423 showing that buffer will be redisplayed. */
13424 if (current_buffer
->clip_changed
)
13425 bset_update_mode_line (current_buffer
);
13428 /* Normally the message* functions will have already displayed and
13429 updated the echo area, but the frame may have been trashed, or
13430 the update may have been preempted, so display the echo area
13431 again here. Checking message_cleared_p captures the case that
13432 the echo area should be cleared. */
13433 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13434 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13435 || (message_cleared_p
13436 && minibuf_level
== 0
13437 /* If the mini-window is currently selected, this means the
13438 echo-area doesn't show through. */
13439 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13441 bool window_height_changed_p
= echo_area_display (false);
13443 if (message_cleared_p
)
13444 update_miniwindow_p
= true;
13446 must_finish
= true;
13448 /* If we don't display the current message, don't clear the
13449 message_cleared_p flag, because, if we did, we wouldn't clear
13450 the echo area in the next redisplay which doesn't preserve
13452 if (!display_last_displayed_message_p
)
13453 message_cleared_p
= false;
13455 if (window_height_changed_p
)
13457 windows_or_buffers_changed
= 50;
13459 /* If window configuration was changed, frames may have been
13460 marked garbaged. Clear them or we will experience
13461 surprises wrt scrolling. */
13462 clear_garbaged_frames ();
13465 else if (EQ (selected_window
, minibuf_window
)
13466 && (current_buffer
->clip_changed
|| window_outdated (w
))
13467 && resize_mini_window (w
, false))
13469 /* Resized active mini-window to fit the size of what it is
13470 showing if its contents might have changed. */
13471 must_finish
= true;
13473 /* If window configuration was changed, frames may have been
13474 marked garbaged. Clear them or we will experience
13475 surprises wrt scrolling. */
13476 clear_garbaged_frames ();
13479 if (windows_or_buffers_changed
&& !update_mode_lines
)
13480 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13481 only the windows's contents needs to be refreshed, or whether the
13482 mode-lines also need a refresh. */
13483 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13484 ? REDISPLAY_SOME
: 32);
13486 /* If specs for an arrow have changed, do thorough redisplay
13487 to ensure we remove any arrow that should no longer exist. */
13488 if (overlay_arrows_changed_p ())
13489 /* Apparently, this is the only case where we update other windows,
13490 without updating other mode-lines. */
13491 windows_or_buffers_changed
= 49;
13493 consider_all_windows_p
= (update_mode_lines
13494 || windows_or_buffers_changed
);
13496 #define AINC(a,i) \
13497 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13498 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13500 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13501 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13503 /* Optimize the case that only the line containing the cursor in the
13504 selected window has changed. Variables starting with this_ are
13505 set in display_line and record information about the line
13506 containing the cursor. */
13507 tlbufpos
= this_line_start_pos
;
13508 tlendpos
= this_line_end_pos
;
13509 if (!consider_all_windows_p
13510 && CHARPOS (tlbufpos
) > 0
13511 && !w
->update_mode_line
13512 && !current_buffer
->clip_changed
13513 && !current_buffer
->prevent_redisplay_optimizations_p
13514 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13515 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13516 && !XFRAME (w
->frame
)->cursor_type_changed
13517 /* Make sure recorded data applies to current buffer, etc. */
13518 && this_line_buffer
== current_buffer
13521 && !w
->optional_new_start
13522 /* Point must be on the line that we have info recorded about. */
13523 && PT
>= CHARPOS (tlbufpos
)
13524 && PT
<= Z
- CHARPOS (tlendpos
)
13525 /* All text outside that line, including its final newline,
13526 must be unchanged. */
13527 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13528 CHARPOS (tlendpos
)))
13530 if (CHARPOS (tlbufpos
) > BEGV
13531 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13532 && (CHARPOS (tlbufpos
) == ZV
13533 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13534 /* Former continuation line has disappeared by becoming empty. */
13536 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13538 /* We have to handle the case of continuation around a
13539 wide-column character (see the comment in indent.c around
13542 For instance, in the following case:
13544 -------- Insert --------
13545 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13546 J_I_ ==> J_I_ `^^' are cursors.
13550 As we have to redraw the line above, we cannot use this
13554 int line_height_before
= this_line_pixel_height
;
13556 /* Note that start_display will handle the case that the
13557 line starting at tlbufpos is a continuation line. */
13558 start_display (&it
, w
, tlbufpos
);
13560 /* Implementation note: It this still necessary? */
13561 if (it
.current_x
!= this_line_start_x
)
13564 TRACE ((stderr
, "trying display optimization 1\n"));
13565 w
->cursor
.vpos
= -1;
13566 overlay_arrow_seen
= false;
13567 it
.vpos
= this_line_vpos
;
13568 it
.current_y
= this_line_y
;
13569 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13570 display_line (&it
);
13572 /* If line contains point, is not continued,
13573 and ends at same distance from eob as before, we win. */
13574 if (w
->cursor
.vpos
>= 0
13575 /* Line is not continued, otherwise this_line_start_pos
13576 would have been set to 0 in display_line. */
13577 && CHARPOS (this_line_start_pos
)
13578 /* Line ends as before. */
13579 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13580 /* Line has same height as before. Otherwise other lines
13581 would have to be shifted up or down. */
13582 && this_line_pixel_height
== line_height_before
)
13584 /* If this is not the window's last line, we must adjust
13585 the charstarts of the lines below. */
13586 if (it
.current_y
< it
.last_visible_y
)
13588 struct glyph_row
*row
13589 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13590 ptrdiff_t delta
, delta_bytes
;
13592 /* We used to distinguish between two cases here,
13593 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13594 when the line ends in a newline or the end of the
13595 buffer's accessible portion. But both cases did
13596 the same, so they were collapsed. */
13598 - CHARPOS (tlendpos
)
13599 - MATRIX_ROW_START_CHARPOS (row
));
13600 delta_bytes
= (Z_BYTE
13601 - BYTEPOS (tlendpos
)
13602 - MATRIX_ROW_START_BYTEPOS (row
));
13604 increment_matrix_positions (w
->current_matrix
,
13605 this_line_vpos
+ 1,
13606 w
->current_matrix
->nrows
,
13607 delta
, delta_bytes
);
13610 /* If this row displays text now but previously didn't,
13611 or vice versa, w->window_end_vpos may have to be
13613 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13615 if (w
->window_end_vpos
< this_line_vpos
)
13616 w
->window_end_vpos
= this_line_vpos
;
13618 else if (w
->window_end_vpos
== this_line_vpos
13619 && this_line_vpos
> 0)
13620 w
->window_end_vpos
= this_line_vpos
- 1;
13621 w
->window_end_valid
= false;
13623 /* Update hint: No need to try to scroll in update_window. */
13624 w
->desired_matrix
->no_scrolling_p
= true;
13627 *w
->desired_matrix
->method
= 0;
13628 debug_method_add (w
, "optimization 1");
13630 #ifdef HAVE_WINDOW_SYSTEM
13631 update_window_fringes (w
, false);
13638 else if (/* Cursor position hasn't changed. */
13639 PT
== w
->last_point
13640 /* Make sure the cursor was last displayed
13641 in this window. Otherwise we have to reposition it. */
13643 /* PXW: Must be converted to pixels, probably. */
13644 && 0 <= w
->cursor
.vpos
13645 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13649 do_pending_window_change (true);
13650 /* If selected_window changed, redisplay again. */
13651 if (WINDOWP (selected_window
)
13652 && (w
= XWINDOW (selected_window
)) != sw
)
13655 /* We used to always goto end_of_redisplay here, but this
13656 isn't enough if we have a blinking cursor. */
13657 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13658 goto end_of_redisplay
;
13662 /* If highlighting the region, or if the cursor is in the echo area,
13663 then we can't just move the cursor. */
13664 else if (NILP (Vshow_trailing_whitespace
)
13665 && !cursor_in_echo_area
)
13668 struct glyph_row
*row
;
13670 /* Skip from tlbufpos to PT and see where it is. Note that
13671 PT may be in invisible text. If so, we will end at the
13672 next visible position. */
13673 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13674 NULL
, DEFAULT_FACE_ID
);
13675 it
.current_x
= this_line_start_x
;
13676 it
.current_y
= this_line_y
;
13677 it
.vpos
= this_line_vpos
;
13679 /* The call to move_it_to stops in front of PT, but
13680 moves over before-strings. */
13681 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13683 if (it
.vpos
== this_line_vpos
13684 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13687 eassert (this_line_vpos
== it
.vpos
);
13688 eassert (this_line_y
== it
.current_y
);
13689 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13691 *w
->desired_matrix
->method
= 0;
13692 debug_method_add (w
, "optimization 3");
13701 /* Text changed drastically or point moved off of line. */
13702 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13705 CHARPOS (this_line_start_pos
) = 0;
13706 ++clear_face_cache_count
;
13707 #ifdef HAVE_WINDOW_SYSTEM
13708 ++clear_image_cache_count
;
13711 /* Build desired matrices, and update the display. If
13712 consider_all_windows_p, do it for all windows on all frames.
13713 Otherwise do it for selected_window, only. */
13715 if (consider_all_windows_p
)
13717 FOR_EACH_FRAME (tail
, frame
)
13718 XFRAME (frame
)->updated_p
= false;
13720 propagate_buffer_redisplay ();
13722 FOR_EACH_FRAME (tail
, frame
)
13724 struct frame
*f
= XFRAME (frame
);
13726 /* We don't have to do anything for unselected terminal
13728 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13729 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13734 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13735 /* Redisplay internal tool bar if this is the first time so we
13736 can adjust the frame height right now, if necessary. */
13737 if (!f
->tool_bar_redisplayed_once
)
13739 if (redisplay_tool_bar (f
))
13740 adjust_frame_glyphs (f
);
13741 f
->tool_bar_redisplayed_once
= true;
13745 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13748 /* Only GC scrollbars when we redisplay the whole frame. */
13749 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13750 /* Mark all the scroll bars to be removed; we'll redeem
13751 the ones we want when we redisplay their windows. */
13752 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13753 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13755 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13756 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13757 /* Remember that the invisible frames need to be redisplayed next
13758 time they're visible. */
13759 else if (!REDISPLAY_SOME_P ())
13760 f
->redisplay
= true;
13762 /* The X error handler may have deleted that frame. */
13763 if (!FRAME_LIVE_P (f
))
13766 /* Any scroll bars which redisplay_windows should have
13767 nuked should now go away. */
13768 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13769 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13771 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13773 /* If fonts changed on visible frame, display again. */
13774 if (f
->fonts_changed
)
13776 adjust_frame_glyphs (f
);
13777 /* Disable all redisplay optimizations for this
13778 frame. For the reasons, see the comment near
13779 the previous call to adjust_frame_glyphs above. */
13780 SET_FRAME_GARBAGED (f
);
13781 f
->fonts_changed
= false;
13785 /* See if we have to hscroll. */
13786 if (!f
->already_hscrolled_p
)
13788 f
->already_hscrolled_p
= true;
13789 if (hscroll_windows (f
->root_window
))
13793 /* Prevent various kinds of signals during display
13794 update. stdio is not robust about handling
13795 signals, which can cause an apparent I/O error. */
13796 if (interrupt_input
)
13797 unrequest_sigio ();
13800 pending
|= update_frame (f
, false, false);
13801 f
->cursor_type_changed
= false;
13802 f
->updated_p
= true;
13807 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13811 /* Do the mark_window_display_accurate after all windows have
13812 been redisplayed because this call resets flags in buffers
13813 which are needed for proper redisplay. */
13814 FOR_EACH_FRAME (tail
, frame
)
13816 struct frame
*f
= XFRAME (frame
);
13819 f
->redisplay
= false;
13820 mark_window_display_accurate (f
->root_window
, true);
13821 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13822 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13827 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13829 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13830 struct frame
*mini_frame
;
13832 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13833 /* Use list_of_error, not Qerror, so that
13834 we catch only errors and don't run the debugger. */
13835 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13837 redisplay_window_error
);
13838 if (update_miniwindow_p
)
13839 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13841 redisplay_window_error
);
13843 /* Compare desired and current matrices, perform output. */
13846 /* If fonts changed, display again. */
13847 if (sf
->fonts_changed
)
13850 /* Prevent various kinds of signals during display update.
13851 stdio is not robust about handling signals,
13852 which can cause an apparent I/O error. */
13853 if (interrupt_input
)
13854 unrequest_sigio ();
13857 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13859 if (hscroll_windows (selected_window
))
13862 XWINDOW (selected_window
)->must_be_updated_p
= true;
13863 pending
= update_frame (sf
, false, false);
13864 sf
->cursor_type_changed
= false;
13867 /* We may have called echo_area_display at the top of this
13868 function. If the echo area is on another frame, that may
13869 have put text on a frame other than the selected one, so the
13870 above call to update_frame would not have caught it. Catch
13872 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13873 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13875 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13877 XWINDOW (mini_window
)->must_be_updated_p
= true;
13878 pending
|= update_frame (mini_frame
, false, false);
13879 mini_frame
->cursor_type_changed
= false;
13880 if (!pending
&& hscroll_windows (mini_window
))
13885 /* If display was paused because of pending input, make sure we do a
13886 thorough update the next time. */
13889 /* Prevent the optimization at the beginning of
13890 redisplay_internal that tries a single-line update of the
13891 line containing the cursor in the selected window. */
13892 CHARPOS (this_line_start_pos
) = 0;
13894 /* Let the overlay arrow be updated the next time. */
13895 update_overlay_arrows (0);
13897 /* If we pause after scrolling, some rows in the current
13898 matrices of some windows are not valid. */
13899 if (!WINDOW_FULL_WIDTH_P (w
)
13900 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13901 update_mode_lines
= 36;
13905 if (!consider_all_windows_p
)
13907 /* This has already been done above if
13908 consider_all_windows_p is set. */
13909 if (XBUFFER (w
->contents
)->text
->redisplay
13910 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13911 /* This can happen if b->text->redisplay was set during
13913 propagate_buffer_redisplay ();
13914 mark_window_display_accurate_1 (w
, true);
13916 /* Say overlay arrows are up to date. */
13917 update_overlay_arrows (1);
13919 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13920 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13923 update_mode_lines
= 0;
13924 windows_or_buffers_changed
= 0;
13927 /* Start SIGIO interrupts coming again. Having them off during the
13928 code above makes it less likely one will discard output, but not
13929 impossible, since there might be stuff in the system buffer here.
13930 But it is much hairier to try to do anything about that. */
13931 if (interrupt_input
)
13935 /* If a frame has become visible which was not before, redisplay
13936 again, so that we display it. Expose events for such a frame
13937 (which it gets when becoming visible) don't call the parts of
13938 redisplay constructing glyphs, so simply exposing a frame won't
13939 display anything in this case. So, we have to display these
13940 frames here explicitly. */
13945 FOR_EACH_FRAME (tail
, frame
)
13947 if (XFRAME (frame
)->visible
)
13951 if (new_count
!= number_of_visible_frames
)
13952 windows_or_buffers_changed
= 52;
13955 /* Change frame size now if a change is pending. */
13956 do_pending_window_change (true);
13958 /* If we just did a pending size change, or have additional
13959 visible frames, or selected_window changed, redisplay again. */
13960 if ((windows_or_buffers_changed
&& !pending
)
13961 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13964 /* Clear the face and image caches.
13966 We used to do this only if consider_all_windows_p. But the cache
13967 needs to be cleared if a timer creates images in the current
13968 buffer (e.g. the test case in Bug#6230). */
13970 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13972 clear_face_cache (false);
13973 clear_face_cache_count
= 0;
13976 #ifdef HAVE_WINDOW_SYSTEM
13977 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13979 clear_image_caches (Qnil
);
13980 clear_image_cache_count
= 0;
13982 #endif /* HAVE_WINDOW_SYSTEM */
13986 ns_set_doc_edited ();
13988 if (interrupt_input
&& interrupts_deferred
)
13991 unbind_to (count
, Qnil
);
13996 /* Redisplay, but leave alone any recent echo area message unless
13997 another message has been requested in its place.
13999 This is useful in situations where you need to redisplay but no
14000 user action has occurred, making it inappropriate for the message
14001 area to be cleared. See tracking_off and
14002 wait_reading_process_output for examples of these situations.
14004 FROM_WHERE is an integer saying from where this function was
14005 called. This is useful for debugging. */
14008 redisplay_preserve_echo_area (int from_where
)
14010 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14012 if (!NILP (echo_area_buffer
[1]))
14014 /* We have a previously displayed message, but no current
14015 message. Redisplay the previous message. */
14016 display_last_displayed_message_p
= true;
14017 redisplay_internal ();
14018 display_last_displayed_message_p
= false;
14021 redisplay_internal ();
14023 flush_frame (SELECTED_FRAME ());
14027 /* Function registered with record_unwind_protect in redisplay_internal. */
14030 unwind_redisplay (void)
14032 redisplaying_p
= false;
14036 /* Mark the display of leaf window W as accurate or inaccurate.
14037 If ACCURATE_P, mark display of W as accurate.
14038 If !ACCURATE_P, arrange for W to be redisplayed the next
14039 time redisplay_internal is called. */
14042 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14044 struct buffer
*b
= XBUFFER (w
->contents
);
14046 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14047 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14048 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14052 b
->clip_changed
= false;
14053 b
->prevent_redisplay_optimizations_p
= false;
14054 eassert (buffer_window_count (b
) > 0);
14055 /* Resetting b->text->redisplay is problematic!
14056 In order to make it safer to do it here, redisplay_internal must
14057 have copied all b->text->redisplay to their respective windows. */
14058 b
->text
->redisplay
= false;
14060 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14061 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14062 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14063 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14065 w
->current_matrix
->buffer
= b
;
14066 w
->current_matrix
->begv
= BUF_BEGV (b
);
14067 w
->current_matrix
->zv
= BUF_ZV (b
);
14069 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14070 w
->last_cursor_off_p
= w
->cursor_off_p
;
14072 if (w
== XWINDOW (selected_window
))
14073 w
->last_point
= BUF_PT (b
);
14075 w
->last_point
= marker_position (w
->pointm
);
14077 w
->window_end_valid
= true;
14078 w
->update_mode_line
= false;
14081 w
->redisplay
= !accurate_p
;
14085 /* Mark the display of windows in the window tree rooted at WINDOW as
14086 accurate or inaccurate. If ACCURATE_P, mark display of
14087 windows as accurate. If !ACCURATE_P, arrange for windows to
14088 be redisplayed the next time redisplay_internal is called. */
14091 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14095 for (; !NILP (window
); window
= w
->next
)
14097 w
= XWINDOW (window
);
14098 if (WINDOWP (w
->contents
))
14099 mark_window_display_accurate (w
->contents
, accurate_p
);
14101 mark_window_display_accurate_1 (w
, accurate_p
);
14105 update_overlay_arrows (1);
14107 /* Force a thorough redisplay the next time by setting
14108 last_arrow_position and last_arrow_string to t, which is
14109 unequal to any useful value of Voverlay_arrow_... */
14110 update_overlay_arrows (-1);
14114 /* Return value in display table DP (Lisp_Char_Table *) for character
14115 C. Since a display table doesn't have any parent, we don't have to
14116 follow parent. Do not call this function directly but use the
14117 macro DISP_CHAR_VECTOR. */
14120 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14124 if (ASCII_CHAR_P (c
))
14127 if (SUB_CHAR_TABLE_P (val
))
14128 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14134 XSETCHAR_TABLE (table
, dp
);
14135 val
= char_table_ref (table
, c
);
14144 /***********************************************************************
14146 ***********************************************************************/
14148 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14151 redisplay_windows (Lisp_Object window
)
14153 while (!NILP (window
))
14155 struct window
*w
= XWINDOW (window
);
14157 if (WINDOWP (w
->contents
))
14158 redisplay_windows (w
->contents
);
14159 else if (BUFFERP (w
->contents
))
14161 displayed_buffer
= XBUFFER (w
->contents
);
14162 /* Use list_of_error, not Qerror, so that
14163 we catch only errors and don't run the debugger. */
14164 internal_condition_case_1 (redisplay_window_0
, window
,
14166 redisplay_window_error
);
14174 redisplay_window_error (Lisp_Object ignore
)
14176 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14181 redisplay_window_0 (Lisp_Object window
)
14183 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14184 redisplay_window (window
, false);
14189 redisplay_window_1 (Lisp_Object window
)
14191 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14192 redisplay_window (window
, true);
14197 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14198 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14199 which positions recorded in ROW differ from current buffer
14202 Return true iff cursor is on this row. */
14205 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14206 struct glyph_matrix
*matrix
,
14207 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14210 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14211 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14212 struct glyph
*cursor
= NULL
;
14213 /* The last known character position in row. */
14214 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14216 ptrdiff_t pt_old
= PT
- delta
;
14217 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14218 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14219 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14220 /* A glyph beyond the edge of TEXT_AREA which we should never
14222 struct glyph
*glyphs_end
= end
;
14223 /* True means we've found a match for cursor position, but that
14224 glyph has the avoid_cursor_p flag set. */
14225 bool match_with_avoid_cursor
= false;
14226 /* True means we've seen at least one glyph that came from a
14228 bool string_seen
= false;
14229 /* Largest and smallest buffer positions seen so far during scan of
14231 ptrdiff_t bpos_max
= pos_before
;
14232 ptrdiff_t bpos_min
= pos_after
;
14233 /* Last buffer position covered by an overlay string with an integer
14234 `cursor' property. */
14235 ptrdiff_t bpos_covered
= 0;
14236 /* True means the display string on which to display the cursor
14237 comes from a text property, not from an overlay. */
14238 bool string_from_text_prop
= false;
14240 /* Don't even try doing anything if called for a mode-line or
14241 header-line row, since the rest of the code isn't prepared to
14242 deal with such calamities. */
14243 eassert (!row
->mode_line_p
);
14244 if (row
->mode_line_p
)
14247 /* Skip over glyphs not having an object at the start and the end of
14248 the row. These are special glyphs like truncation marks on
14249 terminal frames. */
14250 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14252 if (!row
->reversed_p
)
14255 && NILP (glyph
->object
)
14256 && glyph
->charpos
< 0)
14258 x
+= glyph
->pixel_width
;
14262 && NILP ((end
- 1)->object
)
14263 /* CHARPOS is zero for blanks and stretch glyphs
14264 inserted by extend_face_to_end_of_line. */
14265 && (end
- 1)->charpos
<= 0)
14267 glyph_before
= glyph
- 1;
14274 /* If the glyph row is reversed, we need to process it from back
14275 to front, so swap the edge pointers. */
14276 glyphs_end
= end
= glyph
- 1;
14277 glyph
+= row
->used
[TEXT_AREA
] - 1;
14279 while (glyph
> end
+ 1
14280 && NILP (glyph
->object
)
14281 && glyph
->charpos
< 0)
14284 x
-= glyph
->pixel_width
;
14286 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14288 /* By default, in reversed rows we put the cursor on the
14289 rightmost (first in the reading order) glyph. */
14290 for (g
= end
+ 1; g
< glyph
; g
++)
14291 x
+= g
->pixel_width
;
14293 && NILP ((end
+ 1)->object
)
14294 && (end
+ 1)->charpos
<= 0)
14296 glyph_before
= glyph
+ 1;
14300 else if (row
->reversed_p
)
14302 /* In R2L rows that don't display text, put the cursor on the
14303 rightmost glyph. Case in point: an empty last line that is
14304 part of an R2L paragraph. */
14306 /* Avoid placing the cursor on the last glyph of the row, where
14307 on terminal frames we hold the vertical border between
14308 adjacent windows. */
14309 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14310 && !WINDOW_RIGHTMOST_P (w
)
14311 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14313 x
= -1; /* will be computed below, at label compute_x */
14316 /* Step 1: Try to find the glyph whose character position
14317 corresponds to point. If that's not possible, find 2 glyphs
14318 whose character positions are the closest to point, one before
14319 point, the other after it. */
14320 if (!row
->reversed_p
)
14321 while (/* not marched to end of glyph row */
14323 /* glyph was not inserted by redisplay for internal purposes */
14324 && !NILP (glyph
->object
))
14326 if (BUFFERP (glyph
->object
))
14328 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14330 if (glyph
->charpos
> bpos_max
)
14331 bpos_max
= glyph
->charpos
;
14332 if (glyph
->charpos
< bpos_min
)
14333 bpos_min
= glyph
->charpos
;
14334 if (!glyph
->avoid_cursor_p
)
14336 /* If we hit point, we've found the glyph on which to
14337 display the cursor. */
14340 match_with_avoid_cursor
= false;
14343 /* See if we've found a better approximation to
14344 POS_BEFORE or to POS_AFTER. */
14345 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14347 pos_before
= glyph
->charpos
;
14348 glyph_before
= glyph
;
14350 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14352 pos_after
= glyph
->charpos
;
14353 glyph_after
= glyph
;
14356 else if (dpos
== 0)
14357 match_with_avoid_cursor
= true;
14359 else if (STRINGP (glyph
->object
))
14361 Lisp_Object chprop
;
14362 ptrdiff_t glyph_pos
= glyph
->charpos
;
14364 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14366 if (!NILP (chprop
))
14368 /* If the string came from a `display' text property,
14369 look up the buffer position of that property and
14370 use that position to update bpos_max, as if we
14371 actually saw such a position in one of the row's
14372 glyphs. This helps with supporting integer values
14373 of `cursor' property on the display string in
14374 situations where most or all of the row's buffer
14375 text is completely covered by display properties,
14376 so that no glyph with valid buffer positions is
14377 ever seen in the row. */
14378 ptrdiff_t prop_pos
=
14379 string_buffer_position_lim (glyph
->object
, pos_before
,
14382 if (prop_pos
>= pos_before
)
14383 bpos_max
= prop_pos
;
14385 if (INTEGERP (chprop
))
14387 bpos_covered
= bpos_max
+ XINT (chprop
);
14388 /* If the `cursor' property covers buffer positions up
14389 to and including point, we should display cursor on
14390 this glyph. Note that, if a `cursor' property on one
14391 of the string's characters has an integer value, we
14392 will break out of the loop below _before_ we get to
14393 the position match above. IOW, integer values of
14394 the `cursor' property override the "exact match for
14395 point" strategy of positioning the cursor. */
14396 /* Implementation note: bpos_max == pt_old when, e.g.,
14397 we are in an empty line, where bpos_max is set to
14398 MATRIX_ROW_START_CHARPOS, see above. */
14399 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14406 string_seen
= true;
14408 x
+= glyph
->pixel_width
;
14411 else if (glyph
> end
) /* row is reversed */
14412 while (!NILP (glyph
->object
))
14414 if (BUFFERP (glyph
->object
))
14416 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14418 if (glyph
->charpos
> bpos_max
)
14419 bpos_max
= glyph
->charpos
;
14420 if (glyph
->charpos
< bpos_min
)
14421 bpos_min
= glyph
->charpos
;
14422 if (!glyph
->avoid_cursor_p
)
14426 match_with_avoid_cursor
= false;
14429 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14431 pos_before
= glyph
->charpos
;
14432 glyph_before
= glyph
;
14434 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14436 pos_after
= glyph
->charpos
;
14437 glyph_after
= glyph
;
14440 else if (dpos
== 0)
14441 match_with_avoid_cursor
= true;
14443 else if (STRINGP (glyph
->object
))
14445 Lisp_Object chprop
;
14446 ptrdiff_t glyph_pos
= glyph
->charpos
;
14448 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14450 if (!NILP (chprop
))
14452 ptrdiff_t prop_pos
=
14453 string_buffer_position_lim (glyph
->object
, pos_before
,
14456 if (prop_pos
>= pos_before
)
14457 bpos_max
= prop_pos
;
14459 if (INTEGERP (chprop
))
14461 bpos_covered
= bpos_max
+ XINT (chprop
);
14462 /* If the `cursor' property covers buffer positions up
14463 to and including point, we should display cursor on
14465 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14471 string_seen
= true;
14474 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14476 x
--; /* can't use any pixel_width */
14479 x
-= glyph
->pixel_width
;
14482 /* Step 2: If we didn't find an exact match for point, we need to
14483 look for a proper place to put the cursor among glyphs between
14484 GLYPH_BEFORE and GLYPH_AFTER. */
14485 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14486 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14487 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14489 /* An empty line has a single glyph whose OBJECT is nil and
14490 whose CHARPOS is the position of a newline on that line.
14491 Note that on a TTY, there are more glyphs after that, which
14492 were produced by extend_face_to_end_of_line, but their
14493 CHARPOS is zero or negative. */
14494 bool empty_line_p
=
14495 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14496 && NILP (glyph
->object
) && glyph
->charpos
> 0
14497 /* On a TTY, continued and truncated rows also have a glyph at
14498 their end whose OBJECT is nil and whose CHARPOS is
14499 positive (the continuation and truncation glyphs), but such
14500 rows are obviously not "empty". */
14501 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14503 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14505 ptrdiff_t ellipsis_pos
;
14507 /* Scan back over the ellipsis glyphs. */
14508 if (!row
->reversed_p
)
14510 ellipsis_pos
= (glyph
- 1)->charpos
;
14511 while (glyph
> row
->glyphs
[TEXT_AREA
]
14512 && (glyph
- 1)->charpos
== ellipsis_pos
)
14513 glyph
--, x
-= glyph
->pixel_width
;
14514 /* That loop always goes one position too far, including
14515 the glyph before the ellipsis. So scan forward over
14517 x
+= glyph
->pixel_width
;
14520 else /* row is reversed */
14522 ellipsis_pos
= (glyph
+ 1)->charpos
;
14523 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14524 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14525 glyph
++, x
+= glyph
->pixel_width
;
14526 x
-= glyph
->pixel_width
;
14530 else if (match_with_avoid_cursor
)
14532 cursor
= glyph_after
;
14535 else if (string_seen
)
14537 int incr
= row
->reversed_p
? -1 : +1;
14539 /* Need to find the glyph that came out of a string which is
14540 present at point. That glyph is somewhere between
14541 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14542 positioned between POS_BEFORE and POS_AFTER in the
14544 struct glyph
*start
, *stop
;
14545 ptrdiff_t pos
= pos_before
;
14549 /* If the row ends in a newline from a display string,
14550 reordering could have moved the glyphs belonging to the
14551 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14552 in this case we extend the search to the last glyph in
14553 the row that was not inserted by redisplay. */
14554 if (row
->ends_in_newline_from_string_p
)
14557 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14560 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14561 correspond to POS_BEFORE and POS_AFTER, respectively. We
14562 need START and STOP in the order that corresponds to the
14563 row's direction as given by its reversed_p flag. If the
14564 directionality of characters between POS_BEFORE and
14565 POS_AFTER is the opposite of the row's base direction,
14566 these characters will have been reordered for display,
14567 and we need to reverse START and STOP. */
14568 if (!row
->reversed_p
)
14570 start
= min (glyph_before
, glyph_after
);
14571 stop
= max (glyph_before
, glyph_after
);
14575 start
= max (glyph_before
, glyph_after
);
14576 stop
= min (glyph_before
, glyph_after
);
14578 for (glyph
= start
+ incr
;
14579 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14582 /* Any glyphs that come from the buffer are here because
14583 of bidi reordering. Skip them, and only pay
14584 attention to glyphs that came from some string. */
14585 if (STRINGP (glyph
->object
))
14589 /* If the display property covers the newline, we
14590 need to search for it one position farther. */
14591 ptrdiff_t lim
= pos_after
14592 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14594 string_from_text_prop
= false;
14595 str
= glyph
->object
;
14596 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14597 if (tem
== 0 /* from overlay */
14600 /* If the string from which this glyph came is
14601 found in the buffer at point, or at position
14602 that is closer to point than pos_after, then
14603 we've found the glyph we've been looking for.
14604 If it comes from an overlay (tem == 0), and
14605 it has the `cursor' property on one of its
14606 glyphs, record that glyph as a candidate for
14607 displaying the cursor. (As in the
14608 unidirectional version, we will display the
14609 cursor on the last candidate we find.) */
14612 || (tem
- pt_old
> 0 && tem
< pos_after
))
14614 /* The glyphs from this string could have
14615 been reordered. Find the one with the
14616 smallest string position. Or there could
14617 be a character in the string with the
14618 `cursor' property, which means display
14619 cursor on that character's glyph. */
14620 ptrdiff_t strpos
= glyph
->charpos
;
14625 string_from_text_prop
= true;
14628 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14629 && EQ (glyph
->object
, str
);
14633 ptrdiff_t gpos
= glyph
->charpos
;
14635 cprop
= Fget_char_property (make_number (gpos
),
14643 if (tem
&& glyph
->charpos
< strpos
)
14645 strpos
= glyph
->charpos
;
14651 || (tem
- pt_old
> 0 && tem
< pos_after
))
14655 pos
= tem
+ 1; /* don't find previous instances */
14657 /* This string is not what we want; skip all of the
14658 glyphs that came from it. */
14659 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14660 && EQ (glyph
->object
, str
))
14667 /* If we reached the end of the line, and END was from a string,
14668 the cursor is not on this line. */
14670 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14671 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14672 && STRINGP (end
->object
)
14673 && row
->continued_p
)
14676 /* A truncated row may not include PT among its character positions.
14677 Setting the cursor inside the scroll margin will trigger
14678 recalculation of hscroll in hscroll_window_tree. But if a
14679 display string covers point, defer to the string-handling
14680 code below to figure this out. */
14681 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14683 cursor
= glyph_before
;
14686 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14687 /* Zero-width characters produce no glyphs. */
14689 && (row
->reversed_p
14690 ? glyph_after
> glyphs_end
14691 : glyph_after
< glyphs_end
)))
14693 cursor
= glyph_after
;
14699 if (cursor
!= NULL
)
14701 else if (glyph
== glyphs_end
14702 && pos_before
== pos_after
14703 && STRINGP ((row
->reversed_p
14704 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14705 : row
->glyphs
[TEXT_AREA
])->object
))
14707 /* If all the glyphs of this row came from strings, put the
14708 cursor on the first glyph of the row. This avoids having the
14709 cursor outside of the text area in this very rare and hard
14713 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14714 : row
->glyphs
[TEXT_AREA
];
14720 /* Need to compute x that corresponds to GLYPH. */
14721 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14723 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14725 x
+= g
->pixel_width
;
14729 /* ROW could be part of a continued line, which, under bidi
14730 reordering, might have other rows whose start and end charpos
14731 occlude point. Only set w->cursor if we found a better
14732 approximation to the cursor position than we have from previously
14733 examined candidate rows belonging to the same continued line. */
14734 if (/* We already have a candidate row. */
14735 w
->cursor
.vpos
>= 0
14736 /* That candidate is not the row we are processing. */
14737 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14738 /* Make sure cursor.vpos specifies a row whose start and end
14739 charpos occlude point, and it is valid candidate for being a
14740 cursor-row. This is because some callers of this function
14741 leave cursor.vpos at the row where the cursor was displayed
14742 during the last redisplay cycle. */
14743 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14744 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14745 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14748 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14750 /* Don't consider glyphs that are outside TEXT_AREA. */
14751 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14753 /* Keep the candidate whose buffer position is the closest to
14754 point or has the `cursor' property. */
14755 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14756 w
->cursor
.hpos
>= 0
14757 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14758 && ((BUFFERP (g1
->object
)
14759 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14760 || (BUFFERP (glyph
->object
)
14761 && eabs (g1
->charpos
- pt_old
)
14762 < eabs (glyph
->charpos
- pt_old
))))
14763 /* Previous candidate is a glyph from a string that has
14764 a non-nil `cursor' property. */
14765 || (STRINGP (g1
->object
)
14766 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14767 Qcursor
, g1
->object
))
14768 /* Previous candidate is from the same display
14769 string as this one, and the display string
14770 came from a text property. */
14771 || (EQ (g1
->object
, glyph
->object
)
14772 && string_from_text_prop
)
14773 /* this candidate is from newline and its
14774 position is not an exact match */
14775 || (NILP (glyph
->object
)
14776 && glyph
->charpos
!= pt_old
)))))
14778 /* If this candidate gives an exact match, use that. */
14779 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14780 /* If this candidate is a glyph created for the
14781 terminating newline of a line, and point is on that
14782 newline, it wins because it's an exact match. */
14783 || (!row
->continued_p
14784 && NILP (glyph
->object
)
14785 && glyph
->charpos
== 0
14786 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14787 /* Otherwise, keep the candidate that comes from a row
14788 spanning less buffer positions. This may win when one or
14789 both candidate positions are on glyphs that came from
14790 display strings, for which we cannot compare buffer
14792 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14793 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14794 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14797 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14799 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14800 w
->cursor
.y
= row
->y
+ dy
;
14802 if (w
== XWINDOW (selected_window
))
14804 if (!row
->continued_p
14805 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14808 this_line_buffer
= XBUFFER (w
->contents
);
14810 CHARPOS (this_line_start_pos
)
14811 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14812 BYTEPOS (this_line_start_pos
)
14813 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14815 CHARPOS (this_line_end_pos
)
14816 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14817 BYTEPOS (this_line_end_pos
)
14818 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14820 this_line_y
= w
->cursor
.y
;
14821 this_line_pixel_height
= row
->height
;
14822 this_line_vpos
= w
->cursor
.vpos
;
14823 this_line_start_x
= row
->x
;
14826 CHARPOS (this_line_start_pos
) = 0;
14833 /* Run window scroll functions, if any, for WINDOW with new window
14834 start STARTP. Sets the window start of WINDOW to that position.
14836 We assume that the window's buffer is really current. */
14838 static struct text_pos
14839 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14841 struct window
*w
= XWINDOW (window
);
14842 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14844 eassert (current_buffer
== XBUFFER (w
->contents
));
14846 if (!NILP (Vwindow_scroll_functions
))
14848 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14849 make_number (CHARPOS (startp
)));
14850 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14851 /* In case the hook functions switch buffers. */
14852 set_buffer_internal (XBUFFER (w
->contents
));
14859 /* Make sure the line containing the cursor is fully visible.
14860 A value of true means there is nothing to be done.
14861 (Either the line is fully visible, or it cannot be made so,
14862 or we cannot tell.)
14864 If FORCE_P, return false even if partial visible cursor row
14865 is higher than window.
14867 If CURRENT_MATRIX_P, use the information from the
14868 window's current glyph matrix; otherwise use the desired glyph
14871 A value of false means the caller should do scrolling
14872 as if point had gone off the screen. */
14875 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14876 bool current_matrix_p
)
14878 struct glyph_matrix
*matrix
;
14879 struct glyph_row
*row
;
14882 if (!make_cursor_line_fully_visible_p
)
14885 /* It's not always possible to find the cursor, e.g, when a window
14886 is full of overlay strings. Don't do anything in that case. */
14887 if (w
->cursor
.vpos
< 0)
14890 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14891 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14893 /* If the cursor row is not partially visible, there's nothing to do. */
14894 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14897 /* If the row the cursor is in is taller than the window's height,
14898 it's not clear what to do, so do nothing. */
14899 window_height
= window_box_height (w
);
14900 if (row
->height
>= window_height
)
14902 if (!force_p
|| MINI_WINDOW_P (w
)
14903 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14910 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14911 means only WINDOW is redisplayed in redisplay_internal.
14912 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14913 in redisplay_window to bring a partially visible line into view in
14914 the case that only the cursor has moved.
14916 LAST_LINE_MISFIT should be true if we're scrolling because the
14917 last screen line's vertical height extends past the end of the screen.
14921 1 if scrolling succeeded
14923 0 if scrolling didn't find point.
14925 -1 if new fonts have been loaded so that we must interrupt
14926 redisplay, adjust glyph matrices, and try again. */
14932 SCROLLING_NEED_LARGER_MATRICES
14935 /* If scroll-conservatively is more than this, never recenter.
14937 If you change this, don't forget to update the doc string of
14938 `scroll-conservatively' and the Emacs manual. */
14939 #define SCROLL_LIMIT 100
14942 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
14943 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14944 bool temp_scroll_step
, bool last_line_misfit
)
14946 struct window
*w
= XWINDOW (window
);
14947 struct frame
*f
= XFRAME (w
->frame
);
14948 struct text_pos pos
, startp
;
14950 int this_scroll_margin
, scroll_max
, rc
, height
;
14951 int dy
= 0, amount_to_scroll
= 0;
14952 bool scroll_down_p
= false;
14953 int extra_scroll_margin_lines
= last_line_misfit
;
14954 Lisp_Object aggressive
;
14955 /* We will never try scrolling more than this number of lines. */
14956 int scroll_limit
= SCROLL_LIMIT
;
14957 int frame_line_height
= default_line_pixel_height (w
);
14958 int window_total_lines
14959 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14962 debug_method_add (w
, "try_scrolling");
14965 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14967 /* Compute scroll margin height in pixels. We scroll when point is
14968 within this distance from the top or bottom of the window. */
14969 if (scroll_margin
> 0)
14970 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14971 * frame_line_height
;
14973 this_scroll_margin
= 0;
14975 /* Force arg_scroll_conservatively to have a reasonable value, to
14976 avoid scrolling too far away with slow move_it_* functions. Note
14977 that the user can supply scroll-conservatively equal to
14978 `most-positive-fixnum', which can be larger than INT_MAX. */
14979 if (arg_scroll_conservatively
> scroll_limit
)
14981 arg_scroll_conservatively
= scroll_limit
+ 1;
14982 scroll_max
= scroll_limit
* frame_line_height
;
14984 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14985 /* Compute how much we should try to scroll maximally to bring
14986 point into view. */
14987 scroll_max
= (max (scroll_step
,
14988 max (arg_scroll_conservatively
, temp_scroll_step
))
14989 * frame_line_height
);
14990 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14991 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14992 /* We're trying to scroll because of aggressive scrolling but no
14993 scroll_step is set. Choose an arbitrary one. */
14994 scroll_max
= 10 * frame_line_height
;
15000 /* Decide whether to scroll down. */
15001 if (PT
> CHARPOS (startp
))
15003 int scroll_margin_y
;
15005 /* Compute the pixel ypos of the scroll margin, then move IT to
15006 either that ypos or PT, whichever comes first. */
15007 start_display (&it
, w
, startp
);
15008 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15009 - frame_line_height
* extra_scroll_margin_lines
;
15010 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15011 (MOVE_TO_POS
| MOVE_TO_Y
));
15013 if (PT
> CHARPOS (it
.current
.pos
))
15015 int y0
= line_bottom_y (&it
);
15016 /* Compute how many pixels below window bottom to stop searching
15017 for PT. This avoids costly search for PT that is far away if
15018 the user limited scrolling by a small number of lines, but
15019 always finds PT if scroll_conservatively is set to a large
15020 number, such as most-positive-fixnum. */
15021 int slack
= max (scroll_max
, 10 * frame_line_height
);
15022 int y_to_move
= it
.last_visible_y
+ slack
;
15024 /* Compute the distance from the scroll margin to PT or to
15025 the scroll limit, whichever comes first. This should
15026 include the height of the cursor line, to make that line
15028 move_it_to (&it
, PT
, -1, y_to_move
,
15029 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15030 dy
= line_bottom_y (&it
) - y0
;
15032 if (dy
> scroll_max
)
15033 return SCROLLING_FAILED
;
15036 scroll_down_p
= true;
15042 /* Point is in or below the bottom scroll margin, so move the
15043 window start down. If scrolling conservatively, move it just
15044 enough down to make point visible. If scroll_step is set,
15045 move it down by scroll_step. */
15046 if (arg_scroll_conservatively
)
15048 = min (max (dy
, frame_line_height
),
15049 frame_line_height
* arg_scroll_conservatively
);
15050 else if (scroll_step
|| temp_scroll_step
)
15051 amount_to_scroll
= scroll_max
;
15054 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15055 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15056 if (NUMBERP (aggressive
))
15058 double float_amount
= XFLOATINT (aggressive
) * height
;
15059 int aggressive_scroll
= float_amount
;
15060 if (aggressive_scroll
== 0 && float_amount
> 0)
15061 aggressive_scroll
= 1;
15062 /* Don't let point enter the scroll margin near top of
15063 the window. This could happen if the value of
15064 scroll_up_aggressively is too large and there are
15065 non-zero margins, because scroll_up_aggressively
15066 means put point that fraction of window height
15067 _from_the_bottom_margin_. */
15068 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15069 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15070 amount_to_scroll
= dy
+ aggressive_scroll
;
15074 if (amount_to_scroll
<= 0)
15075 return SCROLLING_FAILED
;
15077 start_display (&it
, w
, startp
);
15078 if (arg_scroll_conservatively
<= scroll_limit
)
15079 move_it_vertically (&it
, amount_to_scroll
);
15082 /* Extra precision for users who set scroll-conservatively
15083 to a large number: make sure the amount we scroll
15084 the window start is never less than amount_to_scroll,
15085 which was computed as distance from window bottom to
15086 point. This matters when lines at window top and lines
15087 below window bottom have different height. */
15089 void *it1data
= NULL
;
15090 /* We use a temporary it1 because line_bottom_y can modify
15091 its argument, if it moves one line down; see there. */
15094 SAVE_IT (it1
, it
, it1data
);
15095 start_y
= line_bottom_y (&it1
);
15097 RESTORE_IT (&it
, &it
, it1data
);
15098 move_it_by_lines (&it
, 1);
15099 SAVE_IT (it1
, it
, it1data
);
15100 } while (IT_CHARPOS (it
) < ZV
15101 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15102 bidi_unshelve_cache (it1data
, true);
15105 /* If STARTP is unchanged, move it down another screen line. */
15106 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15107 move_it_by_lines (&it
, 1);
15108 startp
= it
.current
.pos
;
15112 struct text_pos scroll_margin_pos
= startp
;
15115 /* See if point is inside the scroll margin at the top of the
15117 if (this_scroll_margin
)
15121 start_display (&it
, w
, startp
);
15122 y_start
= it
.current_y
;
15123 move_it_vertically (&it
, this_scroll_margin
);
15124 scroll_margin_pos
= it
.current
.pos
;
15125 /* If we didn't move enough before hitting ZV, request
15126 additional amount of scroll, to move point out of the
15128 if (IT_CHARPOS (it
) == ZV
15129 && it
.current_y
- y_start
< this_scroll_margin
)
15130 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15133 if (PT
< CHARPOS (scroll_margin_pos
))
15135 /* Point is in the scroll margin at the top of the window or
15136 above what is displayed in the window. */
15139 /* Compute the vertical distance from PT to the scroll
15140 margin position. Move as far as scroll_max allows, or
15141 one screenful, or 10 screen lines, whichever is largest.
15142 Give up if distance is greater than scroll_max or if we
15143 didn't reach the scroll margin position. */
15144 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15145 start_display (&it
, w
, pos
);
15147 y_to_move
= max (it
.last_visible_y
,
15148 max (scroll_max
, 10 * frame_line_height
));
15149 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15151 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15152 dy
= it
.current_y
- y0
;
15153 if (dy
> scroll_max
15154 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15155 return SCROLLING_FAILED
;
15157 /* Additional scroll for when ZV was too close to point. */
15160 /* Compute new window start. */
15161 start_display (&it
, w
, startp
);
15163 if (arg_scroll_conservatively
)
15164 amount_to_scroll
= max (dy
, frame_line_height
15165 * max (scroll_step
, temp_scroll_step
));
15166 else if (scroll_step
|| temp_scroll_step
)
15167 amount_to_scroll
= scroll_max
;
15170 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15171 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15172 if (NUMBERP (aggressive
))
15174 double float_amount
= XFLOATINT (aggressive
) * height
;
15175 int aggressive_scroll
= float_amount
;
15176 if (aggressive_scroll
== 0 && float_amount
> 0)
15177 aggressive_scroll
= 1;
15178 /* Don't let point enter the scroll margin near
15179 bottom of the window, if the value of
15180 scroll_down_aggressively happens to be too
15182 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15183 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15184 amount_to_scroll
= dy
+ aggressive_scroll
;
15188 if (amount_to_scroll
<= 0)
15189 return SCROLLING_FAILED
;
15191 move_it_vertically_backward (&it
, amount_to_scroll
);
15192 startp
= it
.current
.pos
;
15196 /* Run window scroll functions. */
15197 startp
= run_window_scroll_functions (window
, startp
);
15199 /* Display the window. Give up if new fonts are loaded, or if point
15201 if (!try_window (window
, startp
, 0))
15202 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15203 else if (w
->cursor
.vpos
< 0)
15205 clear_glyph_matrix (w
->desired_matrix
);
15206 rc
= SCROLLING_FAILED
;
15210 /* Maybe forget recorded base line for line number display. */
15211 if (!just_this_one_p
15212 || current_buffer
->clip_changed
15213 || BEG_UNCHANGED
< CHARPOS (startp
))
15214 w
->base_line_number
= 0;
15216 /* If cursor ends up on a partially visible line,
15217 treat that as being off the bottom of the screen. */
15218 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15220 /* It's possible that the cursor is on the first line of the
15221 buffer, which is partially obscured due to a vscroll
15222 (Bug#7537). In that case, avoid looping forever. */
15223 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15225 clear_glyph_matrix (w
->desired_matrix
);
15226 ++extra_scroll_margin_lines
;
15229 rc
= SCROLLING_SUCCESS
;
15236 /* Compute a suitable window start for window W if display of W starts
15237 on a continuation line. Value is true if a new window start
15240 The new window start will be computed, based on W's width, starting
15241 from the start of the continued line. It is the start of the
15242 screen line with the minimum distance from the old start W->start. */
15245 compute_window_start_on_continuation_line (struct window
*w
)
15247 struct text_pos pos
, start_pos
;
15248 bool window_start_changed_p
= false;
15250 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15252 /* If window start is on a continuation line... Window start may be
15253 < BEGV in case there's invisible text at the start of the
15254 buffer (M-x rmail, for example). */
15255 if (CHARPOS (start_pos
) > BEGV
15256 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15259 struct glyph_row
*row
;
15261 /* Handle the case that the window start is out of range. */
15262 if (CHARPOS (start_pos
) < BEGV
)
15263 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15264 else if (CHARPOS (start_pos
) > ZV
)
15265 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15267 /* Find the start of the continued line. This should be fast
15268 because find_newline is fast (newline cache). */
15269 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15270 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15271 row
, DEFAULT_FACE_ID
);
15272 reseat_at_previous_visible_line_start (&it
);
15274 /* If the line start is "too far" away from the window start,
15275 say it takes too much time to compute a new window start. */
15276 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15277 /* PXW: Do we need upper bounds here? */
15278 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15280 int min_distance
, distance
;
15282 /* Move forward by display lines to find the new window
15283 start. If window width was enlarged, the new start can
15284 be expected to be > the old start. If window width was
15285 decreased, the new window start will be < the old start.
15286 So, we're looking for the display line start with the
15287 minimum distance from the old window start. */
15288 pos
= it
.current
.pos
;
15289 min_distance
= INFINITY
;
15290 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15291 distance
< min_distance
)
15293 min_distance
= distance
;
15294 pos
= it
.current
.pos
;
15295 if (it
.line_wrap
== WORD_WRAP
)
15297 /* Under WORD_WRAP, move_it_by_lines is likely to
15298 overshoot and stop not at the first, but the
15299 second character from the left margin. So in
15300 that case, we need a more tight control on the X
15301 coordinate of the iterator than move_it_by_lines
15302 promises in its contract. The method is to first
15303 go to the last (rightmost) visible character of a
15304 line, then move to the leftmost character on the
15305 next line in a separate call. */
15306 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15307 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15308 move_it_to (&it
, ZV
, 0,
15309 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15310 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15313 move_it_by_lines (&it
, 1);
15316 /* Set the window start there. */
15317 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15318 window_start_changed_p
= true;
15322 return window_start_changed_p
;
15326 /* Try cursor movement in case text has not changed in window WINDOW,
15327 with window start STARTP. Value is
15329 CURSOR_MOVEMENT_SUCCESS if successful
15331 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15333 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15334 display. *SCROLL_STEP is set to true, under certain circumstances, if
15335 we want to scroll as if scroll-step were set to 1. See the code.
15337 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15338 which case we have to abort this redisplay, and adjust matrices
15343 CURSOR_MOVEMENT_SUCCESS
,
15344 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15345 CURSOR_MOVEMENT_MUST_SCROLL
,
15346 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15350 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15353 struct window
*w
= XWINDOW (window
);
15354 struct frame
*f
= XFRAME (w
->frame
);
15355 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15358 if (inhibit_try_cursor_movement
)
15362 /* Previously, there was a check for Lisp integer in the
15363 if-statement below. Now, this field is converted to
15364 ptrdiff_t, thus zero means invalid position in a buffer. */
15365 eassert (w
->last_point
> 0);
15366 /* Likewise there was a check whether window_end_vpos is nil or larger
15367 than the window. Now window_end_vpos is int and so never nil, but
15368 let's leave eassert to check whether it fits in the window. */
15369 eassert (!w
->window_end_valid
15370 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15372 /* Handle case where text has not changed, only point, and it has
15373 not moved off the frame. */
15374 if (/* Point may be in this window. */
15375 PT
>= CHARPOS (startp
)
15376 /* Selective display hasn't changed. */
15377 && !current_buffer
->clip_changed
15378 /* Function force-mode-line-update is used to force a thorough
15379 redisplay. It sets either windows_or_buffers_changed or
15380 update_mode_lines. So don't take a shortcut here for these
15382 && !update_mode_lines
15383 && !windows_or_buffers_changed
15384 && !f
->cursor_type_changed
15385 && NILP (Vshow_trailing_whitespace
)
15386 /* This code is not used for mini-buffer for the sake of the case
15387 of redisplaying to replace an echo area message; since in
15388 that case the mini-buffer contents per se are usually
15389 unchanged. This code is of no real use in the mini-buffer
15390 since the handling of this_line_start_pos, etc., in redisplay
15391 handles the same cases. */
15392 && !EQ (window
, minibuf_window
)
15393 && (FRAME_WINDOW_P (f
)
15394 || !overlay_arrow_in_current_buffer_p ()))
15396 int this_scroll_margin
, top_scroll_margin
;
15397 struct glyph_row
*row
= NULL
;
15398 int frame_line_height
= default_line_pixel_height (w
);
15399 int window_total_lines
15400 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15403 debug_method_add (w
, "cursor movement");
15406 /* Scroll if point within this distance from the top or bottom
15407 of the window. This is a pixel value. */
15408 if (scroll_margin
> 0)
15410 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15411 this_scroll_margin
*= frame_line_height
;
15414 this_scroll_margin
= 0;
15416 top_scroll_margin
= this_scroll_margin
;
15417 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15418 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15420 /* Start with the row the cursor was displayed during the last
15421 not paused redisplay. Give up if that row is not valid. */
15422 if (w
->last_cursor_vpos
< 0
15423 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15424 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15427 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15428 if (row
->mode_line_p
)
15430 if (!row
->enabled_p
)
15431 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15434 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15436 bool scroll_p
= false, must_scroll
= false;
15437 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15439 if (PT
> w
->last_point
)
15441 /* Point has moved forward. */
15442 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15443 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15445 eassert (row
->enabled_p
);
15449 /* If the end position of a row equals the start
15450 position of the next row, and PT is at that position,
15451 we would rather display cursor in the next line. */
15452 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15453 && MATRIX_ROW_END_CHARPOS (row
) == PT
15454 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15455 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15456 && !cursor_row_p (row
))
15459 /* If within the scroll margin, scroll. Note that
15460 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15461 the next line would be drawn, and that
15462 this_scroll_margin can be zero. */
15463 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15464 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15465 /* Line is completely visible last line in window
15466 and PT is to be set in the next line. */
15467 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15468 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15469 && !row
->ends_at_zv_p
15470 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15473 else if (PT
< w
->last_point
)
15475 /* Cursor has to be moved backward. Note that PT >=
15476 CHARPOS (startp) because of the outer if-statement. */
15477 while (!row
->mode_line_p
15478 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15479 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15480 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15481 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15482 row
> w
->current_matrix
->rows
15483 && (row
-1)->ends_in_newline_from_string_p
))))
15484 && (row
->y
> top_scroll_margin
15485 || CHARPOS (startp
) == BEGV
))
15487 eassert (row
->enabled_p
);
15491 /* Consider the following case: Window starts at BEGV,
15492 there is invisible, intangible text at BEGV, so that
15493 display starts at some point START > BEGV. It can
15494 happen that we are called with PT somewhere between
15495 BEGV and START. Try to handle that case. */
15496 if (row
< w
->current_matrix
->rows
15497 || row
->mode_line_p
)
15499 row
= w
->current_matrix
->rows
;
15500 if (row
->mode_line_p
)
15504 /* Due to newlines in overlay strings, we may have to
15505 skip forward over overlay strings. */
15506 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15507 && MATRIX_ROW_END_CHARPOS (row
) == PT
15508 && !cursor_row_p (row
))
15511 /* If within the scroll margin, scroll. */
15512 if (row
->y
< top_scroll_margin
15513 && CHARPOS (startp
) != BEGV
)
15518 /* Cursor did not move. So don't scroll even if cursor line
15519 is partially visible, as it was so before. */
15520 rc
= CURSOR_MOVEMENT_SUCCESS
;
15523 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15524 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15526 /* if PT is not in the glyph row, give up. */
15527 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15528 must_scroll
= true;
15530 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15531 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15533 struct glyph_row
*row1
;
15535 /* If rows are bidi-reordered and point moved, back up
15536 until we find a row that does not belong to a
15537 continuation line. This is because we must consider
15538 all rows of a continued line as candidates for the
15539 new cursor positioning, since row start and end
15540 positions change non-linearly with vertical position
15542 /* FIXME: Revisit this when glyph ``spilling'' in
15543 continuation lines' rows is implemented for
15544 bidi-reordered rows. */
15545 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15546 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15549 /* If we hit the beginning of the displayed portion
15550 without finding the first row of a continued
15554 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15557 eassert (row
->enabled_p
);
15562 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15563 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15564 /* Make sure this isn't a header line by any chance, since
15565 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15566 && !row
->mode_line_p
15567 && make_cursor_line_fully_visible_p
)
15569 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15570 && !row
->ends_at_zv_p
15571 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15572 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15573 else if (row
->height
> window_box_height (w
))
15575 /* If we end up in a partially visible line, let's
15576 make it fully visible, except when it's taller
15577 than the window, in which case we can't do much
15579 *scroll_step
= true;
15580 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15584 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15585 if (!cursor_row_fully_visible_p (w
, false, true))
15586 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15588 rc
= CURSOR_MOVEMENT_SUCCESS
;
15592 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15593 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15594 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15596 /* With bidi-reordered rows, there could be more than
15597 one candidate row whose start and end positions
15598 occlude point. We need to let set_cursor_from_row
15599 find the best candidate. */
15600 /* FIXME: Revisit this when glyph ``spilling'' in
15601 continuation lines' rows is implemented for
15602 bidi-reordered rows. */
15607 bool at_zv_p
= false, exact_match_p
= false;
15609 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15610 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15611 && cursor_row_p (row
))
15612 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15614 /* As soon as we've found the exact match for point,
15615 or the first suitable row whose ends_at_zv_p flag
15616 is set, we are done. */
15619 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15620 w
->cursor
.vpos
)->ends_at_zv_p
;
15622 && w
->cursor
.hpos
>= 0
15623 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15626 struct glyph_row
*candidate
=
15627 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15629 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15630 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15633 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15634 || (NILP (g
->object
)
15635 && (g
->charpos
== PT
15636 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15638 if (at_zv_p
|| exact_match_p
)
15640 rc
= CURSOR_MOVEMENT_SUCCESS
;
15644 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15648 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15649 || row
->continued_p
)
15650 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15651 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15652 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15653 /* If we didn't find any candidate rows, or exited the
15654 loop before all the candidates were examined, signal
15655 to the caller that this method failed. */
15656 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15658 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15659 && !row
->continued_p
))
15660 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15662 rc
= CURSOR_MOVEMENT_SUCCESS
;
15668 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15670 rc
= CURSOR_MOVEMENT_SUCCESS
;
15675 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15676 && MATRIX_ROW_START_CHARPOS (row
) == PT
15677 && cursor_row_p (row
));
15687 set_vertical_scroll_bar (struct window
*w
)
15689 ptrdiff_t start
, end
, whole
;
15691 /* Calculate the start and end positions for the current window.
15692 At some point, it would be nice to choose between scrollbars
15693 which reflect the whole buffer size, with special markers
15694 indicating narrowing, and scrollbars which reflect only the
15697 Note that mini-buffers sometimes aren't displaying any text. */
15698 if (!MINI_WINDOW_P (w
)
15699 || (w
== XWINDOW (minibuf_window
)
15700 && NILP (echo_area_buffer
[0])))
15702 struct buffer
*buf
= XBUFFER (w
->contents
);
15703 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15704 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15705 /* I don't think this is guaranteed to be right. For the
15706 moment, we'll pretend it is. */
15707 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15711 if (whole
< (end
- start
))
15712 whole
= end
- start
;
15715 start
= end
= whole
= 0;
15717 /* Indicate what this scroll bar ought to be displaying now. */
15718 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15719 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15720 (w
, end
- start
, whole
, start
);
15725 set_horizontal_scroll_bar (struct window
*w
)
15727 int start
, end
, whole
, portion
;
15729 if (!MINI_WINDOW_P (w
)
15730 || (w
== XWINDOW (minibuf_window
)
15731 && NILP (echo_area_buffer
[0])))
15733 struct buffer
*b
= XBUFFER (w
->contents
);
15734 struct buffer
*old_buffer
= NULL
;
15736 struct text_pos startp
;
15738 if (b
!= current_buffer
)
15740 old_buffer
= current_buffer
;
15741 set_buffer_internal (b
);
15744 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15745 start_display (&it
, w
, startp
);
15746 it
.last_visible_x
= INT_MAX
;
15747 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15748 MOVE_TO_X
| MOVE_TO_Y
);
15749 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15750 window_box_height (w), -1,
15751 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15753 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15754 end
= start
+ window_box_width (w
, TEXT_AREA
);
15755 portion
= end
- start
;
15756 /* After enlarging a horizontally scrolled window such that it
15757 gets at least as wide as the text it contains, make sure that
15758 the thumb doesn't fill the entire scroll bar so we can still
15759 drag it back to see the entire text. */
15760 whole
= max (whole
, end
);
15766 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15767 if (EQ (pdir
, Qright_to_left
))
15769 start
= whole
- end
;
15770 end
= start
+ portion
;
15775 set_buffer_internal (old_buffer
);
15778 start
= end
= whole
= portion
= 0;
15780 w
->hscroll_whole
= whole
;
15782 /* Indicate what this scroll bar ought to be displaying now. */
15783 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15784 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15785 (w
, portion
, whole
, start
);
15789 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15790 selected_window is redisplayed.
15792 We can return without actually redisplaying the window if fonts has been
15793 changed on window's frame. In that case, redisplay_internal will retry.
15795 As one of the important parts of redisplaying a window, we need to
15796 decide whether the previous window-start position (stored in the
15797 window's w->start marker position) is still valid, and if it isn't,
15798 recompute it. Some details about that:
15800 . The previous window-start could be in a continuation line, in
15801 which case we need to recompute it when the window width
15802 changes. See compute_window_start_on_continuation_line and its
15805 . The text that changed since last redisplay could include the
15806 previous window-start position. In that case, we try to salvage
15807 what we can from the current glyph matrix by calling
15808 try_scrolling, which see.
15810 . Some Emacs command could force us to use a specific window-start
15811 position by setting the window's force_start flag, or gently
15812 propose doing that by setting the window's optional_new_start
15813 flag. In these cases, we try using the specified start point if
15814 that succeeds (i.e. the window desired matrix is successfully
15815 recomputed, and point location is within the window). In case
15816 of optional_new_start, we first check if the specified start
15817 position is feasible, i.e. if it will allow point to be
15818 displayed in the window. If using the specified start point
15819 fails, e.g., if new fonts are needed to be loaded, we abort the
15820 redisplay cycle and leave it up to the next cycle to figure out
15823 . Note that the window's force_start flag is sometimes set by
15824 redisplay itself, when it decides that the previous window start
15825 point is fine and should be kept. Search for "goto force_start"
15826 below to see the details. Like the values of window-start
15827 specified outside of redisplay, these internally-deduced values
15828 are tested for feasibility, and ignored if found to be
15831 . Note that the function try_window, used to completely redisplay
15832 a window, accepts the window's start point as its argument.
15833 This is used several times in the redisplay code to control
15834 where the window start will be, according to user options such
15835 as scroll-conservatively, and also to ensure the screen line
15836 showing point will be fully (as opposed to partially) visible on
15840 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15842 struct window
*w
= XWINDOW (window
);
15843 struct frame
*f
= XFRAME (w
->frame
);
15844 struct buffer
*buffer
= XBUFFER (w
->contents
);
15845 struct buffer
*old
= current_buffer
;
15846 struct text_pos lpoint
, opoint
, startp
;
15847 bool update_mode_line
;
15850 /* Record it now because it's overwritten. */
15851 bool current_matrix_up_to_date_p
= false;
15852 bool used_current_matrix_p
= false;
15853 /* This is less strict than current_matrix_up_to_date_p.
15854 It indicates that the buffer contents and narrowing are unchanged. */
15855 bool buffer_unchanged_p
= false;
15856 bool temp_scroll_step
= false;
15857 ptrdiff_t count
= SPECPDL_INDEX ();
15859 int centering_position
= -1;
15860 bool last_line_misfit
= false;
15861 ptrdiff_t beg_unchanged
, end_unchanged
;
15862 int frame_line_height
;
15864 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15868 *w
->desired_matrix
->method
= 0;
15871 if (!just_this_one_p
15872 && REDISPLAY_SOME_P ()
15874 && !w
->update_mode_line
15876 && !buffer
->text
->redisplay
15877 && BUF_PT (buffer
) == w
->last_point
)
15880 /* Make sure that both W's markers are valid. */
15881 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15882 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15884 /* We come here again if we need to run window-text-change-functions
15887 reconsider_clip_changes (w
);
15888 frame_line_height
= default_line_pixel_height (w
);
15890 /* Has the mode line to be updated? */
15891 update_mode_line
= (w
->update_mode_line
15892 || update_mode_lines
15893 || buffer
->clip_changed
15894 || buffer
->prevent_redisplay_optimizations_p
);
15896 if (!just_this_one_p
)
15897 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15898 cleverly elsewhere. */
15899 w
->must_be_updated_p
= true;
15901 if (MINI_WINDOW_P (w
))
15903 if (w
== XWINDOW (echo_area_window
)
15904 && !NILP (echo_area_buffer
[0]))
15906 if (update_mode_line
)
15907 /* We may have to update a tty frame's menu bar or a
15908 tool-bar. Example `M-x C-h C-h C-g'. */
15909 goto finish_menu_bars
;
15911 /* We've already displayed the echo area glyphs in this window. */
15912 goto finish_scroll_bars
;
15914 else if ((w
!= XWINDOW (minibuf_window
)
15915 || minibuf_level
== 0)
15916 /* When buffer is nonempty, redisplay window normally. */
15917 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15918 /* Quail displays non-mini buffers in minibuffer window.
15919 In that case, redisplay the window normally. */
15920 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15922 /* W is a mini-buffer window, but it's not active, so clear
15924 int yb
= window_text_bottom_y (w
);
15925 struct glyph_row
*row
;
15928 for (y
= 0, row
= w
->desired_matrix
->rows
;
15930 y
+= row
->height
, ++row
)
15931 blank_row (w
, row
, y
);
15932 goto finish_scroll_bars
;
15935 clear_glyph_matrix (w
->desired_matrix
);
15938 /* Otherwise set up data on this window; select its buffer and point
15940 /* Really select the buffer, for the sake of buffer-local
15942 set_buffer_internal_1 (XBUFFER (w
->contents
));
15944 current_matrix_up_to_date_p
15945 = (w
->window_end_valid
15946 && !current_buffer
->clip_changed
15947 && !current_buffer
->prevent_redisplay_optimizations_p
15948 && !window_outdated (w
));
15950 /* Run the window-text-change-functions
15951 if it is possible that the text on the screen has changed
15952 (either due to modification of the text, or any other reason). */
15953 if (!current_matrix_up_to_date_p
15954 && !NILP (Vwindow_text_change_functions
))
15956 safe_run_hooks (Qwindow_text_change_functions
);
15960 beg_unchanged
= BEG_UNCHANGED
;
15961 end_unchanged
= END_UNCHANGED
;
15963 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15965 specbind (Qinhibit_point_motion_hooks
, Qt
);
15968 = (w
->window_end_valid
15969 && !current_buffer
->clip_changed
15970 && !window_outdated (w
));
15972 /* When windows_or_buffers_changed is non-zero, we can't rely
15973 on the window end being valid, so set it to zero there. */
15974 if (windows_or_buffers_changed
)
15976 /* If window starts on a continuation line, maybe adjust the
15977 window start in case the window's width changed. */
15978 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15979 compute_window_start_on_continuation_line (w
);
15981 w
->window_end_valid
= false;
15982 /* If so, we also can't rely on current matrix
15983 and should not fool try_cursor_movement below. */
15984 current_matrix_up_to_date_p
= false;
15987 /* Some sanity checks. */
15988 CHECK_WINDOW_END (w
);
15989 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15991 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15994 if (mode_line_update_needed (w
))
15995 update_mode_line
= true;
15997 /* Point refers normally to the selected window. For any other
15998 window, set up appropriate value. */
15999 if (!EQ (window
, selected_window
))
16001 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16002 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16007 new_pt_byte
= BEGV_BYTE
;
16008 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16010 else if (new_pt
> (ZV
- 1))
16013 new_pt_byte
= ZV_BYTE
;
16014 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16017 /* We don't use SET_PT so that the point-motion hooks don't run. */
16018 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16021 /* If any of the character widths specified in the display table
16022 have changed, invalidate the width run cache. It's true that
16023 this may be a bit late to catch such changes, but the rest of
16024 redisplay goes (non-fatally) haywire when the display table is
16025 changed, so why should we worry about doing any better? */
16026 if (current_buffer
->width_run_cache
16027 || (current_buffer
->base_buffer
16028 && current_buffer
->base_buffer
->width_run_cache
))
16030 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16032 if (! disptab_matches_widthtab
16033 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16035 struct buffer
*buf
= current_buffer
;
16037 if (buf
->base_buffer
)
16038 buf
= buf
->base_buffer
;
16039 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16040 recompute_width_table (current_buffer
, disptab
);
16044 /* If window-start is screwed up, choose a new one. */
16045 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16048 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16050 /* If someone specified a new starting point but did not insist,
16051 check whether it can be used. */
16052 if ((w
->optional_new_start
|| window_frozen_p (w
))
16053 && CHARPOS (startp
) >= BEGV
16054 && CHARPOS (startp
) <= ZV
)
16056 ptrdiff_t it_charpos
;
16058 w
->optional_new_start
= false;
16059 start_display (&it
, w
, startp
);
16060 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16061 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16062 /* Record IT's position now, since line_bottom_y might change
16064 it_charpos
= IT_CHARPOS (it
);
16065 /* Make sure we set the force_start flag only if the cursor row
16066 will be fully visible. Otherwise, the code under force_start
16067 label below will try to move point back into view, which is
16068 not what the code which sets optional_new_start wants. */
16069 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16070 && !w
->force_start
)
16072 if (it_charpos
== PT
)
16073 w
->force_start
= true;
16074 /* IT may overshoot PT if text at PT is invisible. */
16075 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16076 w
->force_start
= true;
16078 if (w
->force_start
)
16080 if (window_frozen_p (w
))
16081 debug_method_add (w
, "set force_start from frozen window start");
16083 debug_method_add (w
, "set force_start from optional_new_start");
16091 /* Handle case where place to start displaying has been specified,
16092 unless the specified location is outside the accessible range. */
16093 if (w
->force_start
)
16095 /* We set this later on if we have to adjust point. */
16098 w
->force_start
= false;
16100 w
->window_end_valid
= false;
16102 /* Forget any recorded base line for line number display. */
16103 if (!buffer_unchanged_p
)
16104 w
->base_line_number
= 0;
16106 /* Redisplay the mode line. Select the buffer properly for that.
16107 Also, run the hook window-scroll-functions
16108 because we have scrolled. */
16109 /* Note, we do this after clearing force_start because
16110 if there's an error, it is better to forget about force_start
16111 than to get into an infinite loop calling the hook functions
16112 and having them get more errors. */
16113 if (!update_mode_line
16114 || ! NILP (Vwindow_scroll_functions
))
16116 update_mode_line
= true;
16117 w
->update_mode_line
= true;
16118 startp
= run_window_scroll_functions (window
, startp
);
16121 if (CHARPOS (startp
) < BEGV
)
16122 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16123 else if (CHARPOS (startp
) > ZV
)
16124 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16126 /* Redisplay, then check if cursor has been set during the
16127 redisplay. Give up if new fonts were loaded. */
16128 /* We used to issue a CHECK_MARGINS argument to try_window here,
16129 but this causes scrolling to fail when point begins inside
16130 the scroll margin (bug#148) -- cyd */
16131 if (!try_window (window
, startp
, 0))
16133 w
->force_start
= true;
16134 clear_glyph_matrix (w
->desired_matrix
);
16135 goto need_larger_matrices
;
16138 if (w
->cursor
.vpos
< 0)
16140 /* If point does not appear, try to move point so it does
16141 appear. The desired matrix has been built above, so we
16142 can use it here. */
16143 new_vpos
= window_box_height (w
) / 2;
16146 if (!cursor_row_fully_visible_p (w
, false, false))
16148 /* Point does appear, but on a line partly visible at end of window.
16149 Move it back to a fully-visible line. */
16150 new_vpos
= window_box_height (w
);
16151 /* But if window_box_height suggests a Y coordinate that is
16152 not less than we already have, that line will clearly not
16153 be fully visible, so give up and scroll the display.
16154 This can happen when the default face uses a font whose
16155 dimensions are different from the frame's default
16157 if (new_vpos
>= w
->cursor
.y
)
16159 w
->cursor
.vpos
= -1;
16160 clear_glyph_matrix (w
->desired_matrix
);
16161 goto try_to_scroll
;
16164 else if (w
->cursor
.vpos
>= 0)
16166 /* Some people insist on not letting point enter the scroll
16167 margin, even though this part handles windows that didn't
16169 int window_total_lines
16170 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16171 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16172 int pixel_margin
= margin
* frame_line_height
;
16173 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16175 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16176 below, which finds the row to move point to, advances by
16177 the Y coordinate of the _next_ row, see the definition of
16178 MATRIX_ROW_BOTTOM_Y. */
16179 if (w
->cursor
.vpos
< margin
+ header_line
)
16181 w
->cursor
.vpos
= -1;
16182 clear_glyph_matrix (w
->desired_matrix
);
16183 goto try_to_scroll
;
16187 int window_height
= window_box_height (w
);
16190 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16191 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16193 w
->cursor
.vpos
= -1;
16194 clear_glyph_matrix (w
->desired_matrix
);
16195 goto try_to_scroll
;
16200 /* If we need to move point for either of the above reasons,
16201 now actually do it. */
16204 struct glyph_row
*row
;
16206 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16207 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16210 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16211 MATRIX_ROW_START_BYTEPOS (row
));
16213 if (w
!= XWINDOW (selected_window
))
16214 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16215 else if (current_buffer
== old
)
16216 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16218 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16220 /* Re-run pre-redisplay-function so it can update the region
16221 according to the new position of point. */
16222 /* Other than the cursor, w's redisplay is done so we can set its
16223 redisplay to false. Also the buffer's redisplay can be set to
16224 false, since propagate_buffer_redisplay should have already
16225 propagated its info to `w' anyway. */
16226 w
->redisplay
= false;
16227 XBUFFER (w
->contents
)->text
->redisplay
= false;
16228 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16230 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16232 /* pre-redisplay-function made changes (e.g. move the region)
16233 that require another round of redisplay. */
16234 clear_glyph_matrix (w
->desired_matrix
);
16235 if (!try_window (window
, startp
, 0))
16236 goto need_larger_matrices
;
16239 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16241 clear_glyph_matrix (w
->desired_matrix
);
16242 goto try_to_scroll
;
16246 debug_method_add (w
, "forced window start");
16251 /* Handle case where text has not changed, only point, and it has
16252 not moved off the frame, and we are not retrying after hscroll.
16253 (current_matrix_up_to_date_p is true when retrying.) */
16254 if (current_matrix_up_to_date_p
16255 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16256 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16260 case CURSOR_MOVEMENT_SUCCESS
:
16261 used_current_matrix_p
= true;
16264 case CURSOR_MOVEMENT_MUST_SCROLL
:
16265 goto try_to_scroll
;
16271 /* If current starting point was originally the beginning of a line
16272 but no longer is, find a new starting point. */
16273 else if (w
->start_at_line_beg
16274 && !(CHARPOS (startp
) <= BEGV
16275 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16278 debug_method_add (w
, "recenter 1");
16283 /* Try scrolling with try_window_id. Value is > 0 if update has
16284 been done, it is -1 if we know that the same window start will
16285 not work. It is 0 if unsuccessful for some other reason. */
16286 else if ((tem
= try_window_id (w
)) != 0)
16289 debug_method_add (w
, "try_window_id %d", tem
);
16292 if (f
->fonts_changed
)
16293 goto need_larger_matrices
;
16297 /* Otherwise try_window_id has returned -1 which means that we
16298 don't want the alternative below this comment to execute. */
16300 else if (CHARPOS (startp
) >= BEGV
16301 && CHARPOS (startp
) <= ZV
16302 && PT
>= CHARPOS (startp
)
16303 && (CHARPOS (startp
) < ZV
16304 /* Avoid starting at end of buffer. */
16305 || CHARPOS (startp
) == BEGV
16306 || !window_outdated (w
)))
16308 int d1
, d2
, d5
, d6
;
16311 /* If first window line is a continuation line, and window start
16312 is inside the modified region, but the first change is before
16313 current window start, we must select a new window start.
16315 However, if this is the result of a down-mouse event (e.g. by
16316 extending the mouse-drag-overlay), we don't want to select a
16317 new window start, since that would change the position under
16318 the mouse, resulting in an unwanted mouse-movement rather
16319 than a simple mouse-click. */
16320 if (!w
->start_at_line_beg
16321 && NILP (do_mouse_tracking
)
16322 && CHARPOS (startp
) > BEGV
16323 && CHARPOS (startp
) > BEG
+ beg_unchanged
16324 && CHARPOS (startp
) <= Z
- end_unchanged
16325 /* Even if w->start_at_line_beg is nil, a new window may
16326 start at a line_beg, since that's how set_buffer_window
16327 sets it. So, we need to check the return value of
16328 compute_window_start_on_continuation_line. (See also
16330 && XMARKER (w
->start
)->buffer
== current_buffer
16331 && compute_window_start_on_continuation_line (w
)
16332 /* It doesn't make sense to force the window start like we
16333 do at label force_start if it is already known that point
16334 will not be fully visible in the resulting window, because
16335 doing so will move point from its correct position
16336 instead of scrolling the window to bring point into view.
16338 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16339 /* A very tall row could need more than the window height,
16340 in which case we accept that it is partially visible. */
16341 && (rtop
!= 0) == (rbot
!= 0))
16343 w
->force_start
= true;
16344 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16346 debug_method_add (w
, "recomputed window start in continuation line");
16352 debug_method_add (w
, "same window start");
16355 /* Try to redisplay starting at same place as before.
16356 If point has not moved off frame, accept the results. */
16357 if (!current_matrix_up_to_date_p
16358 /* Don't use try_window_reusing_current_matrix in this case
16359 because a window scroll function can have changed the
16361 || !NILP (Vwindow_scroll_functions
)
16362 || MINI_WINDOW_P (w
)
16363 || !(used_current_matrix_p
16364 = try_window_reusing_current_matrix (w
)))
16366 IF_DEBUG (debug_method_add (w
, "1"));
16367 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16368 /* -1 means we need to scroll.
16369 0 means we need new matrices, but fonts_changed
16370 is set in that case, so we will detect it below. */
16371 goto try_to_scroll
;
16374 if (f
->fonts_changed
)
16375 goto need_larger_matrices
;
16377 if (w
->cursor
.vpos
>= 0)
16379 if (!just_this_one_p
16380 || current_buffer
->clip_changed
16381 || BEG_UNCHANGED
< CHARPOS (startp
))
16382 /* Forget any recorded base line for line number display. */
16383 w
->base_line_number
= 0;
16385 if (!cursor_row_fully_visible_p (w
, true, false))
16387 clear_glyph_matrix (w
->desired_matrix
);
16388 last_line_misfit
= true;
16390 /* Drop through and scroll. */
16395 clear_glyph_matrix (w
->desired_matrix
);
16400 /* Redisplay the mode line. Select the buffer properly for that. */
16401 if (!update_mode_line
)
16403 update_mode_line
= true;
16404 w
->update_mode_line
= true;
16407 /* Try to scroll by specified few lines. */
16408 if ((scroll_conservatively
16409 || emacs_scroll_step
16410 || temp_scroll_step
16411 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16412 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16413 && CHARPOS (startp
) >= BEGV
16414 && CHARPOS (startp
) <= ZV
)
16416 /* The function returns -1 if new fonts were loaded, 1 if
16417 successful, 0 if not successful. */
16418 int ss
= try_scrolling (window
, just_this_one_p
,
16419 scroll_conservatively
,
16421 temp_scroll_step
, last_line_misfit
);
16424 case SCROLLING_SUCCESS
:
16427 case SCROLLING_NEED_LARGER_MATRICES
:
16428 goto need_larger_matrices
;
16430 case SCROLLING_FAILED
:
16438 /* Finally, just choose a place to start which positions point
16439 according to user preferences. */
16444 debug_method_add (w
, "recenter");
16447 /* Forget any previously recorded base line for line number display. */
16448 if (!buffer_unchanged_p
)
16449 w
->base_line_number
= 0;
16451 /* Determine the window start relative to point. */
16452 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16453 it
.current_y
= it
.last_visible_y
;
16454 if (centering_position
< 0)
16456 int window_total_lines
16457 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16459 = scroll_margin
> 0
16460 ? min (scroll_margin
, window_total_lines
/ 4)
16462 ptrdiff_t margin_pos
= CHARPOS (startp
);
16463 Lisp_Object aggressive
;
16466 /* If there is a scroll margin at the top of the window, find
16467 its character position. */
16469 /* Cannot call start_display if startp is not in the
16470 accessible region of the buffer. This can happen when we
16471 have just switched to a different buffer and/or changed
16472 its restriction. In that case, startp is initialized to
16473 the character position 1 (BEGV) because we did not yet
16474 have chance to display the buffer even once. */
16475 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16478 void *it1data
= NULL
;
16480 SAVE_IT (it1
, it
, it1data
);
16481 start_display (&it1
, w
, startp
);
16482 move_it_vertically (&it1
, margin
* frame_line_height
);
16483 margin_pos
= IT_CHARPOS (it1
);
16484 RESTORE_IT (&it
, &it
, it1data
);
16486 scrolling_up
= PT
> margin_pos
;
16489 ? BVAR (current_buffer
, scroll_up_aggressively
)
16490 : BVAR (current_buffer
, scroll_down_aggressively
);
16492 if (!MINI_WINDOW_P (w
)
16493 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16497 /* Setting scroll-conservatively overrides
16498 scroll-*-aggressively. */
16499 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16501 double float_amount
= XFLOATINT (aggressive
);
16503 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16504 if (pt_offset
== 0 && float_amount
> 0)
16506 if (pt_offset
&& margin
> 0)
16509 /* Compute how much to move the window start backward from
16510 point so that point will be displayed where the user
16514 centering_position
= it
.last_visible_y
;
16516 centering_position
-= pt_offset
;
16517 centering_position
-=
16518 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16519 + WINDOW_HEADER_LINE_HEIGHT (w
));
16520 /* Don't let point enter the scroll margin near top of
16522 if (centering_position
< margin
* frame_line_height
)
16523 centering_position
= margin
* frame_line_height
;
16526 centering_position
= margin
* frame_line_height
+ pt_offset
;
16529 /* Set the window start half the height of the window backward
16531 centering_position
= window_box_height (w
) / 2;
16533 move_it_vertically_backward (&it
, centering_position
);
16535 eassert (IT_CHARPOS (it
) >= BEGV
);
16537 /* The function move_it_vertically_backward may move over more
16538 than the specified y-distance. If it->w is small, e.g. a
16539 mini-buffer window, we may end up in front of the window's
16540 display area. Start displaying at the start of the line
16541 containing PT in this case. */
16542 if (it
.current_y
<= 0)
16544 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16545 move_it_vertically_backward (&it
, 0);
16549 it
.current_x
= it
.hpos
= 0;
16551 /* Set the window start position here explicitly, to avoid an
16552 infinite loop in case the functions in window-scroll-functions
16554 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16556 /* Run scroll hooks. */
16557 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16559 /* Redisplay the window. */
16560 if (!current_matrix_up_to_date_p
16561 || windows_or_buffers_changed
16562 || f
->cursor_type_changed
16563 /* Don't use try_window_reusing_current_matrix in this case
16564 because it can have changed the buffer. */
16565 || !NILP (Vwindow_scroll_functions
)
16566 || !just_this_one_p
16567 || MINI_WINDOW_P (w
)
16568 || !(used_current_matrix_p
16569 = try_window_reusing_current_matrix (w
)))
16570 try_window (window
, startp
, 0);
16572 /* If new fonts have been loaded (due to fontsets), give up. We
16573 have to start a new redisplay since we need to re-adjust glyph
16575 if (f
->fonts_changed
)
16576 goto need_larger_matrices
;
16578 /* If cursor did not appear assume that the middle of the window is
16579 in the first line of the window. Do it again with the next line.
16580 (Imagine a window of height 100, displaying two lines of height
16581 60. Moving back 50 from it->last_visible_y will end in the first
16583 if (w
->cursor
.vpos
< 0)
16585 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16587 clear_glyph_matrix (w
->desired_matrix
);
16588 move_it_by_lines (&it
, 1);
16589 try_window (window
, it
.current
.pos
, 0);
16591 else if (PT
< IT_CHARPOS (it
))
16593 clear_glyph_matrix (w
->desired_matrix
);
16594 move_it_by_lines (&it
, -1);
16595 try_window (window
, it
.current
.pos
, 0);
16599 /* Not much we can do about it. */
16603 /* Consider the following case: Window starts at BEGV, there is
16604 invisible, intangible text at BEGV, so that display starts at
16605 some point START > BEGV. It can happen that we are called with
16606 PT somewhere between BEGV and START. Try to handle that case,
16607 and similar ones. */
16608 if (w
->cursor
.vpos
< 0)
16610 /* First, try locating the proper glyph row for PT. */
16611 struct glyph_row
*row
=
16612 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16614 /* Sometimes point is at the beginning of invisible text that is
16615 before the 1st character displayed in the row. In that case,
16616 row_containing_pos fails to find the row, because no glyphs
16617 with appropriate buffer positions are present in the row.
16618 Therefore, we next try to find the row which shows the 1st
16619 position after the invisible text. */
16623 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16626 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16629 Lisp_Object invis_end
=
16630 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16633 if (NATNUMP (invis_end
))
16634 alt_pos
= XFASTINT (invis_end
);
16637 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16641 /* Finally, fall back on the first row of the window after the
16642 header line (if any). This is slightly better than not
16643 displaying the cursor at all. */
16646 row
= w
->current_matrix
->rows
;
16647 if (row
->mode_line_p
)
16650 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16653 if (!cursor_row_fully_visible_p (w
, false, false))
16655 /* If vscroll is enabled, disable it and try again. */
16659 clear_glyph_matrix (w
->desired_matrix
);
16663 /* Users who set scroll-conservatively to a large number want
16664 point just above/below the scroll margin. If we ended up
16665 with point's row partially visible, move the window start to
16666 make that row fully visible and out of the margin. */
16667 if (scroll_conservatively
> SCROLL_LIMIT
)
16669 int window_total_lines
16670 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16673 ? min (scroll_margin
, window_total_lines
/ 4)
16675 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16677 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16678 clear_glyph_matrix (w
->desired_matrix
);
16679 if (1 == try_window (window
, it
.current
.pos
,
16680 TRY_WINDOW_CHECK_MARGINS
))
16684 /* If centering point failed to make the whole line visible,
16685 put point at the top instead. That has to make the whole line
16686 visible, if it can be done. */
16687 if (centering_position
== 0)
16690 clear_glyph_matrix (w
->desired_matrix
);
16691 centering_position
= 0;
16697 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16698 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16699 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16701 /* Display the mode line, if we must. */
16702 if ((update_mode_line
16703 /* If window not full width, must redo its mode line
16704 if (a) the window to its side is being redone and
16705 (b) we do a frame-based redisplay. This is a consequence
16706 of how inverted lines are drawn in frame-based redisplay. */
16707 || (!just_this_one_p
16708 && !FRAME_WINDOW_P (f
)
16709 && !WINDOW_FULL_WIDTH_P (w
))
16710 /* Line number to display. */
16711 || w
->base_line_pos
> 0
16712 /* Column number is displayed and different from the one displayed. */
16713 || (w
->column_number_displayed
!= -1
16714 && (w
->column_number_displayed
!= current_column ())))
16715 /* This means that the window has a mode line. */
16716 && (WINDOW_WANTS_MODELINE_P (w
)
16717 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16720 display_mode_lines (w
);
16722 /* If mode line height has changed, arrange for a thorough
16723 immediate redisplay using the correct mode line height. */
16724 if (WINDOW_WANTS_MODELINE_P (w
)
16725 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16727 f
->fonts_changed
= true;
16728 w
->mode_line_height
= -1;
16729 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16730 = DESIRED_MODE_LINE_HEIGHT (w
);
16733 /* If header line height has changed, arrange for a thorough
16734 immediate redisplay using the correct header line height. */
16735 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16736 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16738 f
->fonts_changed
= true;
16739 w
->header_line_height
= -1;
16740 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16741 = DESIRED_HEADER_LINE_HEIGHT (w
);
16744 if (f
->fonts_changed
)
16745 goto need_larger_matrices
;
16748 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16750 w
->base_line_pos
= 0;
16751 w
->base_line_number
= 0;
16756 /* When we reach a frame's selected window, redo the frame's menu bar. */
16757 if (update_mode_line
16758 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16760 bool redisplay_menu_p
;
16762 if (FRAME_WINDOW_P (f
))
16764 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16765 || defined (HAVE_NS) || defined (USE_GTK)
16766 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16768 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16772 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16774 if (redisplay_menu_p
)
16775 display_menu_bar (w
);
16777 #ifdef HAVE_WINDOW_SYSTEM
16778 if (FRAME_WINDOW_P (f
))
16780 #if defined (USE_GTK) || defined (HAVE_NS)
16781 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16782 redisplay_tool_bar (f
);
16784 if (WINDOWP (f
->tool_bar_window
)
16785 && (FRAME_TOOL_BAR_LINES (f
) > 0
16786 || !NILP (Vauto_resize_tool_bars
))
16787 && redisplay_tool_bar (f
))
16788 ignore_mouse_drag_p
= true;
16794 #ifdef HAVE_WINDOW_SYSTEM
16795 if (FRAME_WINDOW_P (f
)
16796 && update_window_fringes (w
, (just_this_one_p
16797 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16798 || w
->pseudo_window_p
)))
16802 if (draw_window_fringes (w
, true))
16804 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16805 x_draw_right_divider (w
);
16807 x_draw_vertical_border (w
);
16813 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16814 x_draw_bottom_divider (w
);
16815 #endif /* HAVE_WINDOW_SYSTEM */
16817 /* We go to this label, with fonts_changed set, if it is
16818 necessary to try again using larger glyph matrices.
16819 We have to redeem the scroll bar even in this case,
16820 because the loop in redisplay_internal expects that. */
16821 need_larger_matrices
:
16823 finish_scroll_bars
:
16825 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16827 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16828 /* Set the thumb's position and size. */
16829 set_vertical_scroll_bar (w
);
16831 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16832 /* Set the thumb's position and size. */
16833 set_horizontal_scroll_bar (w
);
16835 /* Note that we actually used the scroll bar attached to this
16836 window, so it shouldn't be deleted at the end of redisplay. */
16837 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16838 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16841 /* Restore current_buffer and value of point in it. The window
16842 update may have changed the buffer, so first make sure `opoint'
16843 is still valid (Bug#6177). */
16844 if (CHARPOS (opoint
) < BEGV
)
16845 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16846 else if (CHARPOS (opoint
) > ZV
)
16847 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16849 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16851 set_buffer_internal_1 (old
);
16852 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16853 shorter. This can be caused by log truncation in *Messages*. */
16854 if (CHARPOS (lpoint
) <= ZV
)
16855 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16857 unbind_to (count
, Qnil
);
16861 /* Build the complete desired matrix of WINDOW with a window start
16862 buffer position POS.
16864 Value is 1 if successful. It is zero if fonts were loaded during
16865 redisplay which makes re-adjusting glyph matrices necessary, and -1
16866 if point would appear in the scroll margins.
16867 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16868 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16872 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16874 struct window
*w
= XWINDOW (window
);
16876 struct glyph_row
*last_text_row
= NULL
;
16877 struct frame
*f
= XFRAME (w
->frame
);
16878 int frame_line_height
= default_line_pixel_height (w
);
16880 /* Make POS the new window start. */
16881 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16883 /* Mark cursor position as unknown. No overlay arrow seen. */
16884 w
->cursor
.vpos
= -1;
16885 overlay_arrow_seen
= false;
16887 /* Initialize iterator and info to start at POS. */
16888 start_display (&it
, w
, pos
);
16889 it
.glyph_row
->reversed_p
= false;
16891 /* Display all lines of W. */
16892 while (it
.current_y
< it
.last_visible_y
)
16894 if (display_line (&it
))
16895 last_text_row
= it
.glyph_row
- 1;
16896 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16900 /* Don't let the cursor end in the scroll margins. */
16901 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16902 && !MINI_WINDOW_P (w
))
16904 int this_scroll_margin
;
16905 int window_total_lines
16906 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16908 if (scroll_margin
> 0)
16910 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16911 this_scroll_margin
*= frame_line_height
;
16914 this_scroll_margin
= 0;
16916 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16917 && w
->cursor
.y
< this_scroll_margin
16918 && CHARPOS (pos
) > BEGV
16919 && IT_CHARPOS (it
) < ZV
)
16920 /* rms: considering make_cursor_line_fully_visible_p here
16921 seems to give wrong results. We don't want to recenter
16922 when the last line is partly visible, we want to allow
16923 that case to be handled in the usual way. */
16924 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16926 w
->cursor
.vpos
= -1;
16927 clear_glyph_matrix (w
->desired_matrix
);
16932 /* If bottom moved off end of frame, change mode line percentage. */
16933 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16934 w
->update_mode_line
= true;
16936 /* Set window_end_pos to the offset of the last character displayed
16937 on the window from the end of current_buffer. Set
16938 window_end_vpos to its row number. */
16941 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16942 adjust_window_ends (w
, last_text_row
, false);
16944 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16945 w
->window_end_vpos
)));
16949 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16950 w
->window_end_pos
= Z
- ZV
;
16951 w
->window_end_vpos
= 0;
16954 /* But that is not valid info until redisplay finishes. */
16955 w
->window_end_valid
= false;
16961 /************************************************************************
16962 Window redisplay reusing current matrix when buffer has not changed
16963 ************************************************************************/
16965 /* Try redisplay of window W showing an unchanged buffer with a
16966 different window start than the last time it was displayed by
16967 reusing its current matrix. Value is true if successful.
16968 W->start is the new window start. */
16971 try_window_reusing_current_matrix (struct window
*w
)
16973 struct frame
*f
= XFRAME (w
->frame
);
16974 struct glyph_row
*bottom_row
;
16977 struct text_pos start
, new_start
;
16978 int nrows_scrolled
, i
;
16979 struct glyph_row
*last_text_row
;
16980 struct glyph_row
*last_reused_text_row
;
16981 struct glyph_row
*start_row
;
16982 int start_vpos
, min_y
, max_y
;
16985 if (inhibit_try_window_reusing
)
16989 if (/* This function doesn't handle terminal frames. */
16990 !FRAME_WINDOW_P (f
)
16991 /* Don't try to reuse the display if windows have been split
16993 || windows_or_buffers_changed
16994 || f
->cursor_type_changed
)
16997 /* Can't do this if showing trailing whitespace. */
16998 if (!NILP (Vshow_trailing_whitespace
))
17001 /* If top-line visibility has changed, give up. */
17002 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17003 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17006 /* Give up if old or new display is scrolled vertically. We could
17007 make this function handle this, but right now it doesn't. */
17008 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17009 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17012 /* The variable new_start now holds the new window start. The old
17013 start `start' can be determined from the current matrix. */
17014 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17015 start
= start_row
->minpos
;
17016 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17018 /* Clear the desired matrix for the display below. */
17019 clear_glyph_matrix (w
->desired_matrix
);
17021 if (CHARPOS (new_start
) <= CHARPOS (start
))
17023 /* Don't use this method if the display starts with an ellipsis
17024 displayed for invisible text. It's not easy to handle that case
17025 below, and it's certainly not worth the effort since this is
17026 not a frequent case. */
17027 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17030 IF_DEBUG (debug_method_add (w
, "twu1"));
17032 /* Display up to a row that can be reused. The variable
17033 last_text_row is set to the last row displayed that displays
17034 text. Note that it.vpos == 0 if or if not there is a
17035 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17036 start_display (&it
, w
, new_start
);
17037 w
->cursor
.vpos
= -1;
17038 last_text_row
= last_reused_text_row
= NULL
;
17040 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17042 /* If we have reached into the characters in the START row,
17043 that means the line boundaries have changed. So we
17044 can't start copying with the row START. Maybe it will
17045 work to start copying with the following row. */
17046 while (IT_CHARPOS (it
) > CHARPOS (start
))
17048 /* Advance to the next row as the "start". */
17050 start
= start_row
->minpos
;
17051 /* If there are no more rows to try, or just one, give up. */
17052 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17053 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17054 || CHARPOS (start
) == ZV
)
17056 clear_glyph_matrix (w
->desired_matrix
);
17060 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17062 /* If we have reached alignment, we can copy the rest of the
17064 if (IT_CHARPOS (it
) == CHARPOS (start
)
17065 /* Don't accept "alignment" inside a display vector,
17066 since start_row could have started in the middle of
17067 that same display vector (thus their character
17068 positions match), and we have no way of telling if
17069 that is the case. */
17070 && it
.current
.dpvec_index
< 0)
17073 it
.glyph_row
->reversed_p
= false;
17074 if (display_line (&it
))
17075 last_text_row
= it
.glyph_row
- 1;
17079 /* A value of current_y < last_visible_y means that we stopped
17080 at the previous window start, which in turn means that we
17081 have at least one reusable row. */
17082 if (it
.current_y
< it
.last_visible_y
)
17084 struct glyph_row
*row
;
17086 /* IT.vpos always starts from 0; it counts text lines. */
17087 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17089 /* Find PT if not already found in the lines displayed. */
17090 if (w
->cursor
.vpos
< 0)
17092 int dy
= it
.current_y
- start_row
->y
;
17094 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17095 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17097 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17098 dy
, nrows_scrolled
);
17101 clear_glyph_matrix (w
->desired_matrix
);
17106 /* Scroll the display. Do it before the current matrix is
17107 changed. The problem here is that update has not yet
17108 run, i.e. part of the current matrix is not up to date.
17109 scroll_run_hook will clear the cursor, and use the
17110 current matrix to get the height of the row the cursor is
17112 run
.current_y
= start_row
->y
;
17113 run
.desired_y
= it
.current_y
;
17114 run
.height
= it
.last_visible_y
- it
.current_y
;
17116 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17119 FRAME_RIF (f
)->update_window_begin_hook (w
);
17120 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17121 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17122 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17126 /* Shift current matrix down by nrows_scrolled lines. */
17127 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17128 rotate_matrix (w
->current_matrix
,
17130 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17133 /* Disable lines that must be updated. */
17134 for (i
= 0; i
< nrows_scrolled
; ++i
)
17135 (start_row
+ i
)->enabled_p
= false;
17137 /* Re-compute Y positions. */
17138 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17139 max_y
= it
.last_visible_y
;
17140 for (row
= start_row
+ nrows_scrolled
;
17144 row
->y
= it
.current_y
;
17145 row
->visible_height
= row
->height
;
17147 if (row
->y
< min_y
)
17148 row
->visible_height
-= min_y
- row
->y
;
17149 if (row
->y
+ row
->height
> max_y
)
17150 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17151 if (row
->fringe_bitmap_periodic_p
)
17152 row
->redraw_fringe_bitmaps_p
= true;
17154 it
.current_y
+= row
->height
;
17156 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17157 last_reused_text_row
= row
;
17158 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17162 /* Disable lines in the current matrix which are now
17163 below the window. */
17164 for (++row
; row
< bottom_row
; ++row
)
17165 row
->enabled_p
= row
->mode_line_p
= false;
17168 /* Update window_end_pos etc.; last_reused_text_row is the last
17169 reused row from the current matrix containing text, if any.
17170 The value of last_text_row is the last displayed line
17171 containing text. */
17172 if (last_reused_text_row
)
17173 adjust_window_ends (w
, last_reused_text_row
, true);
17174 else if (last_text_row
)
17175 adjust_window_ends (w
, last_text_row
, false);
17178 /* This window must be completely empty. */
17179 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17180 w
->window_end_pos
= Z
- ZV
;
17181 w
->window_end_vpos
= 0;
17183 w
->window_end_valid
= false;
17185 /* Update hint: don't try scrolling again in update_window. */
17186 w
->desired_matrix
->no_scrolling_p
= true;
17189 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17193 else if (CHARPOS (new_start
) > CHARPOS (start
))
17195 struct glyph_row
*pt_row
, *row
;
17196 struct glyph_row
*first_reusable_row
;
17197 struct glyph_row
*first_row_to_display
;
17199 int yb
= window_text_bottom_y (w
);
17201 /* Find the row starting at new_start, if there is one. Don't
17202 reuse a partially visible line at the end. */
17203 first_reusable_row
= start_row
;
17204 while (first_reusable_row
->enabled_p
17205 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17206 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17207 < CHARPOS (new_start
)))
17208 ++first_reusable_row
;
17210 /* Give up if there is no row to reuse. */
17211 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17212 || !first_reusable_row
->enabled_p
17213 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17214 != CHARPOS (new_start
)))
17217 /* We can reuse fully visible rows beginning with
17218 first_reusable_row to the end of the window. Set
17219 first_row_to_display to the first row that cannot be reused.
17220 Set pt_row to the row containing point, if there is any. */
17222 for (first_row_to_display
= first_reusable_row
;
17223 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17224 ++first_row_to_display
)
17226 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17227 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17228 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17229 && first_row_to_display
->ends_at_zv_p
17230 && pt_row
== NULL
)))
17231 pt_row
= first_row_to_display
;
17234 /* Start displaying at the start of first_row_to_display. */
17235 eassert (first_row_to_display
->y
< yb
);
17236 init_to_row_start (&it
, w
, first_row_to_display
);
17238 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17240 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17242 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17243 + WINDOW_HEADER_LINE_HEIGHT (w
));
17245 /* Display lines beginning with first_row_to_display in the
17246 desired matrix. Set last_text_row to the last row displayed
17247 that displays text. */
17248 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17249 if (pt_row
== NULL
)
17250 w
->cursor
.vpos
= -1;
17251 last_text_row
= NULL
;
17252 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17253 if (display_line (&it
))
17254 last_text_row
= it
.glyph_row
- 1;
17256 /* If point is in a reused row, adjust y and vpos of the cursor
17260 w
->cursor
.vpos
-= nrows_scrolled
;
17261 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17264 /* Give up if point isn't in a row displayed or reused. (This
17265 also handles the case where w->cursor.vpos < nrows_scrolled
17266 after the calls to display_line, which can happen with scroll
17267 margins. See bug#1295.) */
17268 if (w
->cursor
.vpos
< 0)
17270 clear_glyph_matrix (w
->desired_matrix
);
17274 /* Scroll the display. */
17275 run
.current_y
= first_reusable_row
->y
;
17276 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17277 run
.height
= it
.last_visible_y
- run
.current_y
;
17278 dy
= run
.current_y
- run
.desired_y
;
17283 FRAME_RIF (f
)->update_window_begin_hook (w
);
17284 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17285 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17286 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17290 /* Adjust Y positions of reused rows. */
17291 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17292 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17293 max_y
= it
.last_visible_y
;
17294 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17297 row
->visible_height
= row
->height
;
17298 if (row
->y
< min_y
)
17299 row
->visible_height
-= min_y
- row
->y
;
17300 if (row
->y
+ row
->height
> max_y
)
17301 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17302 if (row
->fringe_bitmap_periodic_p
)
17303 row
->redraw_fringe_bitmaps_p
= true;
17306 /* Scroll the current matrix. */
17307 eassert (nrows_scrolled
> 0);
17308 rotate_matrix (w
->current_matrix
,
17310 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17313 /* Disable rows not reused. */
17314 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17315 row
->enabled_p
= false;
17317 /* Point may have moved to a different line, so we cannot assume that
17318 the previous cursor position is valid; locate the correct row. */
17321 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17323 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17324 && !row
->ends_at_zv_p
;
17328 w
->cursor
.y
= row
->y
;
17330 if (row
< bottom_row
)
17332 /* Can't simply scan the row for point with
17333 bidi-reordered glyph rows. Let set_cursor_from_row
17334 figure out where to put the cursor, and if it fails,
17336 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17338 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17341 clear_glyph_matrix (w
->desired_matrix
);
17347 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17348 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17351 && (!BUFFERP (glyph
->object
)
17352 || glyph
->charpos
< PT
);
17356 w
->cursor
.x
+= glyph
->pixel_width
;
17362 /* Adjust window end. A null value of last_text_row means that
17363 the window end is in reused rows which in turn means that
17364 only its vpos can have changed. */
17366 adjust_window_ends (w
, last_text_row
, false);
17368 w
->window_end_vpos
-= nrows_scrolled
;
17370 w
->window_end_valid
= false;
17371 w
->desired_matrix
->no_scrolling_p
= true;
17374 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17384 /************************************************************************
17385 Window redisplay reusing current matrix when buffer has changed
17386 ************************************************************************/
17388 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17389 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17390 ptrdiff_t *, ptrdiff_t *);
17391 static struct glyph_row
*
17392 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17393 struct glyph_row
*);
17396 /* Return the last row in MATRIX displaying text. If row START is
17397 non-null, start searching with that row. IT gives the dimensions
17398 of the display. Value is null if matrix is empty; otherwise it is
17399 a pointer to the row found. */
17401 static struct glyph_row
*
17402 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17403 struct glyph_row
*start
)
17405 struct glyph_row
*row
, *row_found
;
17407 /* Set row_found to the last row in IT->w's current matrix
17408 displaying text. The loop looks funny but think of partially
17411 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17412 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17414 eassert (row
->enabled_p
);
17416 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17425 /* Return the last row in the current matrix of W that is not affected
17426 by changes at the start of current_buffer that occurred since W's
17427 current matrix was built. Value is null if no such row exists.
17429 BEG_UNCHANGED us the number of characters unchanged at the start of
17430 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17431 first changed character in current_buffer. Characters at positions <
17432 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17433 when the current matrix was built. */
17435 static struct glyph_row
*
17436 find_last_unchanged_at_beg_row (struct window
*w
)
17438 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17439 struct glyph_row
*row
;
17440 struct glyph_row
*row_found
= NULL
;
17441 int yb
= window_text_bottom_y (w
);
17443 /* Find the last row displaying unchanged text. */
17444 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17445 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17446 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17449 if (/* If row ends before first_changed_pos, it is unchanged,
17450 except in some case. */
17451 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17452 /* When row ends in ZV and we write at ZV it is not
17454 && !row
->ends_at_zv_p
17455 /* When first_changed_pos is the end of a continued line,
17456 row is not unchanged because it may be no longer
17458 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17459 && (row
->continued_p
17460 || row
->exact_window_width_line_p
))
17461 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17462 needs to be recomputed, so don't consider this row as
17463 unchanged. This happens when the last line was
17464 bidi-reordered and was killed immediately before this
17465 redisplay cycle. In that case, ROW->end stores the
17466 buffer position of the first visual-order character of
17467 the killed text, which is now beyond ZV. */
17468 && CHARPOS (row
->end
.pos
) <= ZV
)
17471 /* Stop if last visible row. */
17472 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17480 /* Find the first glyph row in the current matrix of W that is not
17481 affected by changes at the end of current_buffer since the
17482 time W's current matrix was built.
17484 Return in *DELTA the number of chars by which buffer positions in
17485 unchanged text at the end of current_buffer must be adjusted.
17487 Return in *DELTA_BYTES the corresponding number of bytes.
17489 Value is null if no such row exists, i.e. all rows are affected by
17492 static struct glyph_row
*
17493 find_first_unchanged_at_end_row (struct window
*w
,
17494 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17496 struct glyph_row
*row
;
17497 struct glyph_row
*row_found
= NULL
;
17499 *delta
= *delta_bytes
= 0;
17501 /* Display must not have been paused, otherwise the current matrix
17502 is not up to date. */
17503 eassert (w
->window_end_valid
);
17505 /* A value of window_end_pos >= END_UNCHANGED means that the window
17506 end is in the range of changed text. If so, there is no
17507 unchanged row at the end of W's current matrix. */
17508 if (w
->window_end_pos
>= END_UNCHANGED
)
17511 /* Set row to the last row in W's current matrix displaying text. */
17512 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17514 /* If matrix is entirely empty, no unchanged row exists. */
17515 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17517 /* The value of row is the last glyph row in the matrix having a
17518 meaningful buffer position in it. The end position of row
17519 corresponds to window_end_pos. This allows us to translate
17520 buffer positions in the current matrix to current buffer
17521 positions for characters not in changed text. */
17523 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17524 ptrdiff_t Z_BYTE_old
=
17525 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17526 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17527 struct glyph_row
*first_text_row
17528 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17530 *delta
= Z
- Z_old
;
17531 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17533 /* Set last_unchanged_pos to the buffer position of the last
17534 character in the buffer that has not been changed. Z is the
17535 index + 1 of the last character in current_buffer, i.e. by
17536 subtracting END_UNCHANGED we get the index of the last
17537 unchanged character, and we have to add BEG to get its buffer
17539 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17540 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17542 /* Search backward from ROW for a row displaying a line that
17543 starts at a minimum position >= last_unchanged_pos_old. */
17544 for (; row
> first_text_row
; --row
)
17546 /* This used to abort, but it can happen.
17547 It is ok to just stop the search instead here. KFS. */
17548 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17551 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17556 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17562 /* Make sure that glyph rows in the current matrix of window W
17563 reference the same glyph memory as corresponding rows in the
17564 frame's frame matrix. This function is called after scrolling W's
17565 current matrix on a terminal frame in try_window_id and
17566 try_window_reusing_current_matrix. */
17569 sync_frame_with_window_matrix_rows (struct window
*w
)
17571 struct frame
*f
= XFRAME (w
->frame
);
17572 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17574 /* Preconditions: W must be a leaf window and full-width. Its frame
17575 must have a frame matrix. */
17576 eassert (BUFFERP (w
->contents
));
17577 eassert (WINDOW_FULL_WIDTH_P (w
));
17578 eassert (!FRAME_WINDOW_P (f
));
17580 /* If W is a full-width window, glyph pointers in W's current matrix
17581 have, by definition, to be the same as glyph pointers in the
17582 corresponding frame matrix. Note that frame matrices have no
17583 marginal areas (see build_frame_matrix). */
17584 window_row
= w
->current_matrix
->rows
;
17585 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17586 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17587 while (window_row
< window_row_end
)
17589 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17590 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17592 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17593 frame_row
->glyphs
[TEXT_AREA
] = start
;
17594 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17595 frame_row
->glyphs
[LAST_AREA
] = end
;
17597 /* Disable frame rows whose corresponding window rows have
17598 been disabled in try_window_id. */
17599 if (!window_row
->enabled_p
)
17600 frame_row
->enabled_p
= false;
17602 ++window_row
, ++frame_row
;
17607 /* Find the glyph row in window W containing CHARPOS. Consider all
17608 rows between START and END (not inclusive). END null means search
17609 all rows to the end of the display area of W. Value is the row
17610 containing CHARPOS or null. */
17613 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17614 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17616 struct glyph_row
*row
= start
;
17617 struct glyph_row
*best_row
= NULL
;
17618 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17621 /* If we happen to start on a header-line, skip that. */
17622 if (row
->mode_line_p
)
17625 if ((end
&& row
>= end
) || !row
->enabled_p
)
17628 last_y
= window_text_bottom_y (w
) - dy
;
17632 /* Give up if we have gone too far. */
17633 if (end
&& row
>= end
)
17635 /* This formerly returned if they were equal.
17636 I think that both quantities are of a "last plus one" type;
17637 if so, when they are equal, the row is within the screen. -- rms. */
17638 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17641 /* If it is in this row, return this row. */
17642 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17643 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17644 /* The end position of a row equals the start
17645 position of the next row. If CHARPOS is there, we
17646 would rather consider it displayed in the next
17647 line, except when this line ends in ZV. */
17648 && !row_for_charpos_p (row
, charpos
)))
17649 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17653 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17654 || (!best_row
&& !row
->continued_p
))
17656 /* In bidi-reordered rows, there could be several rows whose
17657 edges surround CHARPOS, all of these rows belonging to
17658 the same continued line. We need to find the row which
17659 fits CHARPOS the best. */
17660 for (g
= row
->glyphs
[TEXT_AREA
];
17661 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17664 if (!STRINGP (g
->object
))
17666 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17668 mindif
= eabs (g
->charpos
- charpos
);
17670 /* Exact match always wins. */
17677 else if (best_row
&& !row
->continued_p
)
17684 /* Try to redisplay window W by reusing its existing display. W's
17685 current matrix must be up to date when this function is called,
17686 i.e., window_end_valid must be true.
17690 >= 1 if successful, i.e. display has been updated
17692 1 means the changes were in front of a newline that precedes
17693 the window start, and the whole current matrix was reused
17694 2 means the changes were after the last position displayed
17695 in the window, and the whole current matrix was reused
17696 3 means portions of the current matrix were reused, while
17697 some of the screen lines were redrawn
17698 -1 if redisplay with same window start is known not to succeed
17699 0 if otherwise unsuccessful
17701 The following steps are performed:
17703 1. Find the last row in the current matrix of W that is not
17704 affected by changes at the start of current_buffer. If no such row
17707 2. Find the first row in W's current matrix that is not affected by
17708 changes at the end of current_buffer. Maybe there is no such row.
17710 3. Display lines beginning with the row + 1 found in step 1 to the
17711 row found in step 2 or, if step 2 didn't find a row, to the end of
17714 4. If cursor is not known to appear on the window, give up.
17716 5. If display stopped at the row found in step 2, scroll the
17717 display and current matrix as needed.
17719 6. Maybe display some lines at the end of W, if we must. This can
17720 happen under various circumstances, like a partially visible line
17721 becoming fully visible, or because newly displayed lines are displayed
17722 in smaller font sizes.
17724 7. Update W's window end information. */
17727 try_window_id (struct window
*w
)
17729 struct frame
*f
= XFRAME (w
->frame
);
17730 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17731 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17732 struct glyph_row
*last_unchanged_at_beg_row
;
17733 struct glyph_row
*first_unchanged_at_end_row
;
17734 struct glyph_row
*row
;
17735 struct glyph_row
*bottom_row
;
17738 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17740 struct text_pos start_pos
;
17742 int first_unchanged_at_end_vpos
= 0;
17743 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17744 struct text_pos start
;
17745 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17748 if (inhibit_try_window_id
)
17752 /* This is handy for debugging. */
17754 #define GIVE_UP(X) \
17756 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17760 #define GIVE_UP(X) return 0
17763 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17765 /* Don't use this for mini-windows because these can show
17766 messages and mini-buffers, and we don't handle that here. */
17767 if (MINI_WINDOW_P (w
))
17770 /* This flag is used to prevent redisplay optimizations. */
17771 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17774 /* This function's optimizations cannot be used if overlays have
17775 changed in the buffer displayed by the window, so give up if they
17777 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17780 /* Verify that narrowing has not changed.
17781 Also verify that we were not told to prevent redisplay optimizations.
17782 It would be nice to further
17783 reduce the number of cases where this prevents try_window_id. */
17784 if (current_buffer
->clip_changed
17785 || current_buffer
->prevent_redisplay_optimizations_p
)
17788 /* Window must either use window-based redisplay or be full width. */
17789 if (!FRAME_WINDOW_P (f
)
17790 && (!FRAME_LINE_INS_DEL_OK (f
)
17791 || !WINDOW_FULL_WIDTH_P (w
)))
17794 /* Give up if point is known NOT to appear in W. */
17795 if (PT
< CHARPOS (start
))
17798 /* Another way to prevent redisplay optimizations. */
17799 if (w
->last_modified
== 0)
17802 /* Verify that window is not hscrolled. */
17803 if (w
->hscroll
!= 0)
17806 /* Verify that display wasn't paused. */
17807 if (!w
->window_end_valid
)
17810 /* Likewise if highlighting trailing whitespace. */
17811 if (!NILP (Vshow_trailing_whitespace
))
17814 /* Can't use this if overlay arrow position and/or string have
17816 if (overlay_arrows_changed_p ())
17819 /* When word-wrap is on, adding a space to the first word of a
17820 wrapped line can change the wrap position, altering the line
17821 above it. It might be worthwhile to handle this more
17822 intelligently, but for now just redisplay from scratch. */
17823 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17826 /* Under bidi reordering, adding or deleting a character in the
17827 beginning of a paragraph, before the first strong directional
17828 character, can change the base direction of the paragraph (unless
17829 the buffer specifies a fixed paragraph direction), which will
17830 require to redisplay the whole paragraph. It might be worthwhile
17831 to find the paragraph limits and widen the range of redisplayed
17832 lines to that, but for now just give up this optimization and
17833 redisplay from scratch. */
17834 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17835 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17838 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17839 only if buffer has really changed. The reason is that the gap is
17840 initially at Z for freshly visited files. The code below would
17841 set end_unchanged to 0 in that case. */
17842 if (MODIFF
> SAVE_MODIFF
17843 /* This seems to happen sometimes after saving a buffer. */
17844 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17846 if (GPT
- BEG
< BEG_UNCHANGED
)
17847 BEG_UNCHANGED
= GPT
- BEG
;
17848 if (Z
- GPT
< END_UNCHANGED
)
17849 END_UNCHANGED
= Z
- GPT
;
17852 /* The position of the first and last character that has been changed. */
17853 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17854 last_changed_charpos
= Z
- END_UNCHANGED
;
17856 /* If window starts after a line end, and the last change is in
17857 front of that newline, then changes don't affect the display.
17858 This case happens with stealth-fontification. Note that although
17859 the display is unchanged, glyph positions in the matrix have to
17860 be adjusted, of course. */
17861 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17862 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17863 && ((last_changed_charpos
< CHARPOS (start
)
17864 && CHARPOS (start
) == BEGV
)
17865 || (last_changed_charpos
< CHARPOS (start
) - 1
17866 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17868 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17869 struct glyph_row
*r0
;
17871 /* Compute how many chars/bytes have been added to or removed
17872 from the buffer. */
17873 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17874 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17875 Z_delta
= Z
- Z_old
;
17876 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17878 /* Give up if PT is not in the window. Note that it already has
17879 been checked at the start of try_window_id that PT is not in
17880 front of the window start. */
17881 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17884 /* If window start is unchanged, we can reuse the whole matrix
17885 as is, after adjusting glyph positions. No need to compute
17886 the window end again, since its offset from Z hasn't changed. */
17887 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17888 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17889 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17890 /* PT must not be in a partially visible line. */
17891 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17892 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17894 /* Adjust positions in the glyph matrix. */
17895 if (Z_delta
|| Z_delta_bytes
)
17897 struct glyph_row
*r1
17898 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17899 increment_matrix_positions (w
->current_matrix
,
17900 MATRIX_ROW_VPOS (r0
, current_matrix
),
17901 MATRIX_ROW_VPOS (r1
, current_matrix
),
17902 Z_delta
, Z_delta_bytes
);
17905 /* Set the cursor. */
17906 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17908 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17913 /* Handle the case that changes are all below what is displayed in
17914 the window, and that PT is in the window. This shortcut cannot
17915 be taken if ZV is visible in the window, and text has been added
17916 there that is visible in the window. */
17917 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17918 /* ZV is not visible in the window, or there are no
17919 changes at ZV, actually. */
17920 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17921 || first_changed_charpos
== last_changed_charpos
))
17923 struct glyph_row
*r0
;
17925 /* Give up if PT is not in the window. Note that it already has
17926 been checked at the start of try_window_id that PT is not in
17927 front of the window start. */
17928 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17931 /* If window start is unchanged, we can reuse the whole matrix
17932 as is, without changing glyph positions since no text has
17933 been added/removed in front of the window end. */
17934 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17935 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17936 /* PT must not be in a partially visible line. */
17937 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17938 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17940 /* We have to compute the window end anew since text
17941 could have been added/removed after it. */
17942 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17943 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17945 /* Set the cursor. */
17946 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17948 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17953 /* Give up if window start is in the changed area.
17955 The condition used to read
17957 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17959 but why that was tested escapes me at the moment. */
17960 if (CHARPOS (start
) >= first_changed_charpos
17961 && CHARPOS (start
) <= last_changed_charpos
)
17964 /* Check that window start agrees with the start of the first glyph
17965 row in its current matrix. Check this after we know the window
17966 start is not in changed text, otherwise positions would not be
17968 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17969 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17972 /* Give up if the window ends in strings. Overlay strings
17973 at the end are difficult to handle, so don't try. */
17974 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17975 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17978 /* Compute the position at which we have to start displaying new
17979 lines. Some of the lines at the top of the window might be
17980 reusable because they are not displaying changed text. Find the
17981 last row in W's current matrix not affected by changes at the
17982 start of current_buffer. Value is null if changes start in the
17983 first line of window. */
17984 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17985 if (last_unchanged_at_beg_row
)
17987 /* Avoid starting to display in the middle of a character, a TAB
17988 for instance. This is easier than to set up the iterator
17989 exactly, and it's not a frequent case, so the additional
17990 effort wouldn't really pay off. */
17991 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17992 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17993 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17994 --last_unchanged_at_beg_row
;
17996 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17999 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18001 start_pos
= it
.current
.pos
;
18003 /* Start displaying new lines in the desired matrix at the same
18004 vpos we would use in the current matrix, i.e. below
18005 last_unchanged_at_beg_row. */
18006 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18008 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18009 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18011 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18015 /* There are no reusable lines at the start of the window.
18016 Start displaying in the first text line. */
18017 start_display (&it
, w
, start
);
18018 it
.vpos
= it
.first_vpos
;
18019 start_pos
= it
.current
.pos
;
18022 /* Find the first row that is not affected by changes at the end of
18023 the buffer. Value will be null if there is no unchanged row, in
18024 which case we must redisplay to the end of the window. delta
18025 will be set to the value by which buffer positions beginning with
18026 first_unchanged_at_end_row have to be adjusted due to text
18028 first_unchanged_at_end_row
18029 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18030 IF_DEBUG (debug_delta
= delta
);
18031 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18033 /* Set stop_pos to the buffer position up to which we will have to
18034 display new lines. If first_unchanged_at_end_row != NULL, this
18035 is the buffer position of the start of the line displayed in that
18036 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18037 that we don't stop at a buffer position. */
18039 if (first_unchanged_at_end_row
)
18041 eassert (last_unchanged_at_beg_row
== NULL
18042 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18044 /* If this is a continuation line, move forward to the next one
18045 that isn't. Changes in lines above affect this line.
18046 Caution: this may move first_unchanged_at_end_row to a row
18047 not displaying text. */
18048 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18049 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18050 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18051 < it
.last_visible_y
))
18052 ++first_unchanged_at_end_row
;
18054 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18055 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18056 >= it
.last_visible_y
))
18057 first_unchanged_at_end_row
= NULL
;
18060 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18062 first_unchanged_at_end_vpos
18063 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18064 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18067 else if (last_unchanged_at_beg_row
== NULL
)
18073 /* Either there is no unchanged row at the end, or the one we have
18074 now displays text. This is a necessary condition for the window
18075 end pos calculation at the end of this function. */
18076 eassert (first_unchanged_at_end_row
== NULL
18077 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18079 debug_last_unchanged_at_beg_vpos
18080 = (last_unchanged_at_beg_row
18081 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18083 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18085 #endif /* GLYPH_DEBUG */
18088 /* Display new lines. Set last_text_row to the last new line
18089 displayed which has text on it, i.e. might end up as being the
18090 line where the window_end_vpos is. */
18091 w
->cursor
.vpos
= -1;
18092 last_text_row
= NULL
;
18093 overlay_arrow_seen
= false;
18094 if (it
.current_y
< it
.last_visible_y
18095 && !f
->fonts_changed
18096 && (first_unchanged_at_end_row
== NULL
18097 || IT_CHARPOS (it
) < stop_pos
))
18098 it
.glyph_row
->reversed_p
= false;
18099 while (it
.current_y
< it
.last_visible_y
18100 && !f
->fonts_changed
18101 && (first_unchanged_at_end_row
== NULL
18102 || IT_CHARPOS (it
) < stop_pos
))
18104 if (display_line (&it
))
18105 last_text_row
= it
.glyph_row
- 1;
18108 if (f
->fonts_changed
)
18111 /* The redisplay iterations in display_line above could have
18112 triggered font-lock, which could have done something that
18113 invalidates IT->w window's end-point information, on which we
18114 rely below. E.g., one package, which will remain unnamed, used
18115 to install a font-lock-fontify-region-function that called
18116 bury-buffer, whose side effect is to switch the buffer displayed
18117 by IT->w, and that predictably resets IT->w's window_end_valid
18118 flag, which we already tested at the entry to this function.
18119 Amply punish such packages/modes by giving up on this
18120 optimization in those cases. */
18121 if (!w
->window_end_valid
)
18123 clear_glyph_matrix (w
->desired_matrix
);
18127 /* Compute differences in buffer positions, y-positions etc. for
18128 lines reused at the bottom of the window. Compute what we can
18130 if (first_unchanged_at_end_row
18131 /* No lines reused because we displayed everything up to the
18132 bottom of the window. */
18133 && it
.current_y
< it
.last_visible_y
)
18136 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18138 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18139 run
.current_y
= first_unchanged_at_end_row
->y
;
18140 run
.desired_y
= run
.current_y
+ dy
;
18141 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18145 delta
= delta_bytes
= dvpos
= dy
18146 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18147 first_unchanged_at_end_row
= NULL
;
18149 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18152 /* Find the cursor if not already found. We have to decide whether
18153 PT will appear on this window (it sometimes doesn't, but this is
18154 not a very frequent case.) This decision has to be made before
18155 the current matrix is altered. A value of cursor.vpos < 0 means
18156 that PT is either in one of the lines beginning at
18157 first_unchanged_at_end_row or below the window. Don't care for
18158 lines that might be displayed later at the window end; as
18159 mentioned, this is not a frequent case. */
18160 if (w
->cursor
.vpos
< 0)
18162 /* Cursor in unchanged rows at the top? */
18163 if (PT
< CHARPOS (start_pos
)
18164 && last_unchanged_at_beg_row
)
18166 row
= row_containing_pos (w
, PT
,
18167 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18168 last_unchanged_at_beg_row
+ 1, 0);
18170 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18173 /* Start from first_unchanged_at_end_row looking for PT. */
18174 else if (first_unchanged_at_end_row
)
18176 row
= row_containing_pos (w
, PT
- delta
,
18177 first_unchanged_at_end_row
, NULL
, 0);
18179 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18180 delta_bytes
, dy
, dvpos
);
18183 /* Give up if cursor was not found. */
18184 if (w
->cursor
.vpos
< 0)
18186 clear_glyph_matrix (w
->desired_matrix
);
18191 /* Don't let the cursor end in the scroll margins. */
18193 int this_scroll_margin
, cursor_height
;
18194 int frame_line_height
= default_line_pixel_height (w
);
18195 int window_total_lines
18196 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18198 this_scroll_margin
=
18199 max (0, min (scroll_margin
, window_total_lines
/ 4));
18200 this_scroll_margin
*= frame_line_height
;
18201 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18203 if ((w
->cursor
.y
< this_scroll_margin
18204 && CHARPOS (start
) > BEGV
)
18205 /* Old redisplay didn't take scroll margin into account at the bottom,
18206 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18207 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18208 ? cursor_height
+ this_scroll_margin
18209 : 1)) > it
.last_visible_y
)
18211 w
->cursor
.vpos
= -1;
18212 clear_glyph_matrix (w
->desired_matrix
);
18217 /* Scroll the display. Do it before changing the current matrix so
18218 that xterm.c doesn't get confused about where the cursor glyph is
18220 if (dy
&& run
.height
)
18224 if (FRAME_WINDOW_P (f
))
18226 FRAME_RIF (f
)->update_window_begin_hook (w
);
18227 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18228 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18229 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18233 /* Terminal frame. In this case, dvpos gives the number of
18234 lines to scroll by; dvpos < 0 means scroll up. */
18236 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18237 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18238 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18239 + WINDOW_WANTS_HEADER_LINE_P (w
)
18240 + window_internal_height (w
));
18242 #if defined (HAVE_GPM) || defined (MSDOS)
18243 x_clear_window_mouse_face (w
);
18245 /* Perform the operation on the screen. */
18248 /* Scroll last_unchanged_at_beg_row to the end of the
18249 window down dvpos lines. */
18250 set_terminal_window (f
, end
);
18252 /* On dumb terminals delete dvpos lines at the end
18253 before inserting dvpos empty lines. */
18254 if (!FRAME_SCROLL_REGION_OK (f
))
18255 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18257 /* Insert dvpos empty lines in front of
18258 last_unchanged_at_beg_row. */
18259 ins_del_lines (f
, from
, dvpos
);
18261 else if (dvpos
< 0)
18263 /* Scroll up last_unchanged_at_beg_vpos to the end of
18264 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18265 set_terminal_window (f
, end
);
18267 /* Delete dvpos lines in front of
18268 last_unchanged_at_beg_vpos. ins_del_lines will set
18269 the cursor to the given vpos and emit |dvpos| delete
18271 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18273 /* On a dumb terminal insert dvpos empty lines at the
18275 if (!FRAME_SCROLL_REGION_OK (f
))
18276 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18279 set_terminal_window (f
, 0);
18285 /* Shift reused rows of the current matrix to the right position.
18286 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18288 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18289 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18292 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18293 bottom_vpos
, dvpos
);
18294 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18297 else if (dvpos
> 0)
18299 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18300 bottom_vpos
, dvpos
);
18301 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18302 first_unchanged_at_end_vpos
+ dvpos
);
18305 /* For frame-based redisplay, make sure that current frame and window
18306 matrix are in sync with respect to glyph memory. */
18307 if (!FRAME_WINDOW_P (f
))
18308 sync_frame_with_window_matrix_rows (w
);
18310 /* Adjust buffer positions in reused rows. */
18311 if (delta
|| delta_bytes
)
18312 increment_matrix_positions (current_matrix
,
18313 first_unchanged_at_end_vpos
+ dvpos
,
18314 bottom_vpos
, delta
, delta_bytes
);
18316 /* Adjust Y positions. */
18318 shift_glyph_matrix (w
, current_matrix
,
18319 first_unchanged_at_end_vpos
+ dvpos
,
18322 if (first_unchanged_at_end_row
)
18324 first_unchanged_at_end_row
+= dvpos
;
18325 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18326 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18327 first_unchanged_at_end_row
= NULL
;
18330 /* If scrolling up, there may be some lines to display at the end of
18332 last_text_row_at_end
= NULL
;
18335 /* Scrolling up can leave for example a partially visible line
18336 at the end of the window to be redisplayed. */
18337 /* Set last_row to the glyph row in the current matrix where the
18338 window end line is found. It has been moved up or down in
18339 the matrix by dvpos. */
18340 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18341 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18343 /* If last_row is the window end line, it should display text. */
18344 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18346 /* If window end line was partially visible before, begin
18347 displaying at that line. Otherwise begin displaying with the
18348 line following it. */
18349 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18351 init_to_row_start (&it
, w
, last_row
);
18352 it
.vpos
= last_vpos
;
18353 it
.current_y
= last_row
->y
;
18357 init_to_row_end (&it
, w
, last_row
);
18358 it
.vpos
= 1 + last_vpos
;
18359 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18363 /* We may start in a continuation line. If so, we have to
18364 get the right continuation_lines_width and current_x. */
18365 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18366 it
.hpos
= it
.current_x
= 0;
18368 /* Display the rest of the lines at the window end. */
18369 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18370 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18372 /* Is it always sure that the display agrees with lines in
18373 the current matrix? I don't think so, so we mark rows
18374 displayed invalid in the current matrix by setting their
18375 enabled_p flag to false. */
18376 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18377 if (display_line (&it
))
18378 last_text_row_at_end
= it
.glyph_row
- 1;
18382 /* Update window_end_pos and window_end_vpos. */
18383 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18385 /* Window end line if one of the preserved rows from the current
18386 matrix. Set row to the last row displaying text in current
18387 matrix starting at first_unchanged_at_end_row, after
18389 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18390 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18391 first_unchanged_at_end_row
);
18392 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18393 adjust_window_ends (w
, row
, true);
18394 eassert (w
->window_end_bytepos
>= 0);
18395 IF_DEBUG (debug_method_add (w
, "A"));
18397 else if (last_text_row_at_end
)
18399 adjust_window_ends (w
, last_text_row_at_end
, false);
18400 eassert (w
->window_end_bytepos
>= 0);
18401 IF_DEBUG (debug_method_add (w
, "B"));
18403 else if (last_text_row
)
18405 /* We have displayed either to the end of the window or at the
18406 end of the window, i.e. the last row with text is to be found
18407 in the desired matrix. */
18408 adjust_window_ends (w
, last_text_row
, false);
18409 eassert (w
->window_end_bytepos
>= 0);
18411 else if (first_unchanged_at_end_row
== NULL
18412 && last_text_row
== NULL
18413 && last_text_row_at_end
== NULL
)
18415 /* Displayed to end of window, but no line containing text was
18416 displayed. Lines were deleted at the end of the window. */
18417 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18418 int vpos
= w
->window_end_vpos
;
18419 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18420 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18423 row
== NULL
&& vpos
>= first_vpos
;
18424 --vpos
, --current_row
, --desired_row
)
18426 if (desired_row
->enabled_p
)
18428 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18431 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18435 eassert (row
!= NULL
);
18436 w
->window_end_vpos
= vpos
+ 1;
18437 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18438 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18439 eassert (w
->window_end_bytepos
>= 0);
18440 IF_DEBUG (debug_method_add (w
, "C"));
18445 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18446 debug_end_vpos
= w
->window_end_vpos
));
18448 /* Record that display has not been completed. */
18449 w
->window_end_valid
= false;
18450 w
->desired_matrix
->no_scrolling_p
= true;
18458 /***********************************************************************
18459 More debugging support
18460 ***********************************************************************/
18464 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18465 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18466 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18469 /* Dump the contents of glyph matrix MATRIX on stderr.
18471 GLYPHS 0 means don't show glyph contents.
18472 GLYPHS 1 means show glyphs in short form
18473 GLYPHS > 1 means show glyphs in long form. */
18476 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18479 for (i
= 0; i
< matrix
->nrows
; ++i
)
18480 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18484 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18485 the glyph row and area where the glyph comes from. */
18488 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18490 if (glyph
->type
== CHAR_GLYPH
18491 || glyph
->type
== GLYPHLESS_GLYPH
)
18494 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18495 glyph
- row
->glyphs
[TEXT_AREA
],
18496 (glyph
->type
== CHAR_GLYPH
18500 (BUFFERP (glyph
->object
)
18502 : (STRINGP (glyph
->object
)
18504 : (NILP (glyph
->object
)
18507 glyph
->pixel_width
,
18509 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18513 glyph
->left_box_line_p
,
18514 glyph
->right_box_line_p
);
18516 else if (glyph
->type
== STRETCH_GLYPH
)
18519 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18520 glyph
- row
->glyphs
[TEXT_AREA
],
18523 (BUFFERP (glyph
->object
)
18525 : (STRINGP (glyph
->object
)
18527 : (NILP (glyph
->object
)
18530 glyph
->pixel_width
,
18534 glyph
->left_box_line_p
,
18535 glyph
->right_box_line_p
);
18537 else if (glyph
->type
== IMAGE_GLYPH
)
18540 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18541 glyph
- row
->glyphs
[TEXT_AREA
],
18544 (BUFFERP (glyph
->object
)
18546 : (STRINGP (glyph
->object
)
18548 : (NILP (glyph
->object
)
18551 glyph
->pixel_width
,
18555 glyph
->left_box_line_p
,
18556 glyph
->right_box_line_p
);
18558 else if (glyph
->type
== COMPOSITE_GLYPH
)
18561 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18562 glyph
- row
->glyphs
[TEXT_AREA
],
18565 (BUFFERP (glyph
->object
)
18567 : (STRINGP (glyph
->object
)
18569 : (NILP (glyph
->object
)
18572 glyph
->pixel_width
,
18574 if (glyph
->u
.cmp
.automatic
)
18577 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18578 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18580 glyph
->left_box_line_p
,
18581 glyph
->right_box_line_p
);
18586 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18587 GLYPHS 0 means don't show glyph contents.
18588 GLYPHS 1 means show glyphs in short form
18589 GLYPHS > 1 means show glyphs in long form. */
18592 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18596 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18597 fprintf (stderr
, "==============================================================================\n");
18599 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18600 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18602 MATRIX_ROW_START_CHARPOS (row
),
18603 MATRIX_ROW_END_CHARPOS (row
),
18604 row
->used
[TEXT_AREA
],
18605 row
->contains_overlapping_glyphs_p
,
18607 row
->truncated_on_left_p
,
18608 row
->truncated_on_right_p
,
18610 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18611 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18614 row
->ends_in_middle_of_char_p
,
18615 row
->starts_in_middle_of_char_p
,
18621 row
->visible_height
,
18624 /* The next 3 lines should align to "Start" in the header. */
18625 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18626 row
->end
.overlay_string_index
,
18627 row
->continuation_lines_width
);
18628 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18629 CHARPOS (row
->start
.string_pos
),
18630 CHARPOS (row
->end
.string_pos
));
18631 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18632 row
->end
.dpvec_index
);
18639 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18641 struct glyph
*glyph
= row
->glyphs
[area
];
18642 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18644 /* Glyph for a line end in text. */
18645 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18648 if (glyph
< glyph_end
)
18649 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18651 for (; glyph
< glyph_end
; ++glyph
)
18652 dump_glyph (row
, glyph
, area
);
18655 else if (glyphs
== 1)
18658 char s
[SHRT_MAX
+ 4];
18660 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18664 for (i
= 0; i
< row
->used
[area
]; ++i
)
18666 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18667 if (i
== row
->used
[area
] - 1
18668 && area
== TEXT_AREA
18669 && NILP (glyph
->object
)
18670 && glyph
->type
== CHAR_GLYPH
18671 && glyph
->u
.ch
== ' ')
18673 strcpy (&s
[i
], "[\\n]");
18676 else if (glyph
->type
== CHAR_GLYPH
18677 && glyph
->u
.ch
< 0x80
18678 && glyph
->u
.ch
>= ' ')
18679 s
[i
] = glyph
->u
.ch
;
18685 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18691 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18692 Sdump_glyph_matrix
, 0, 1, "p",
18693 doc
: /* Dump the current matrix of the selected window to stderr.
18694 Shows contents of glyph row structures. With non-nil
18695 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18696 glyphs in short form, otherwise show glyphs in long form.
18698 Interactively, no argument means show glyphs in short form;
18699 with numeric argument, its value is passed as the GLYPHS flag. */)
18700 (Lisp_Object glyphs
)
18702 struct window
*w
= XWINDOW (selected_window
);
18703 struct buffer
*buffer
= XBUFFER (w
->contents
);
18705 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18706 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18707 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18708 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18709 fprintf (stderr
, "=============================================\n");
18710 dump_glyph_matrix (w
->current_matrix
,
18711 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18716 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18717 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18718 Only text-mode frames have frame glyph matrices. */)
18721 struct frame
*f
= XFRAME (selected_frame
);
18723 if (f
->current_matrix
)
18724 dump_glyph_matrix (f
->current_matrix
, 1);
18726 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18731 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18732 doc
: /* Dump glyph row ROW to stderr.
18733 GLYPH 0 means don't dump glyphs.
18734 GLYPH 1 means dump glyphs in short form.
18735 GLYPH > 1 or omitted means dump glyphs in long form. */)
18736 (Lisp_Object row
, Lisp_Object glyphs
)
18738 struct glyph_matrix
*matrix
;
18741 CHECK_NUMBER (row
);
18742 matrix
= XWINDOW (selected_window
)->current_matrix
;
18744 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18745 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18747 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18752 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18753 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18754 GLYPH 0 means don't dump glyphs.
18755 GLYPH 1 means dump glyphs in short form.
18756 GLYPH > 1 or omitted means dump glyphs in long form.
18758 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18760 (Lisp_Object row
, Lisp_Object glyphs
)
18762 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18763 struct frame
*sf
= SELECTED_FRAME ();
18764 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18767 CHECK_NUMBER (row
);
18769 if (vpos
>= 0 && vpos
< m
->nrows
)
18770 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18771 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18777 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18778 doc
: /* Toggle tracing of redisplay.
18779 With ARG, turn tracing on if and only if ARG is positive. */)
18783 trace_redisplay_p
= !trace_redisplay_p
;
18786 arg
= Fprefix_numeric_value (arg
);
18787 trace_redisplay_p
= XINT (arg
) > 0;
18794 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18795 doc
: /* Like `format', but print result to stderr.
18796 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18797 (ptrdiff_t nargs
, Lisp_Object
*args
)
18799 Lisp_Object s
= Fformat (nargs
, args
);
18800 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18804 #endif /* GLYPH_DEBUG */
18808 /***********************************************************************
18809 Building Desired Matrix Rows
18810 ***********************************************************************/
18812 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18813 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18815 static struct glyph_row
*
18816 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18818 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18819 struct buffer
*buffer
= XBUFFER (w
->contents
);
18820 struct buffer
*old
= current_buffer
;
18821 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18822 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18823 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18824 const unsigned char *p
;
18827 int n_glyphs_before
;
18829 set_buffer_temp (buffer
);
18830 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18831 scratch_glyph_row
.reversed_p
= false;
18832 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18833 SET_TEXT_POS (it
.position
, 0, 0);
18835 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18837 while (p
< arrow_end
)
18839 Lisp_Object face
, ilisp
;
18841 /* Get the next character. */
18843 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18846 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18847 if (! ASCII_CHAR_P (it
.c
))
18848 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18852 /* Get its face. */
18853 ilisp
= make_number (p
- arrow_string
);
18854 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18855 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18857 /* Compute its width, get its glyphs. */
18858 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18859 SET_TEXT_POS (it
.position
, -1, -1);
18860 PRODUCE_GLYPHS (&it
);
18862 /* If this character doesn't fit any more in the line, we have
18863 to remove some glyphs. */
18864 if (it
.current_x
> it
.last_visible_x
)
18866 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18871 set_buffer_temp (old
);
18872 return it
.glyph_row
;
18876 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18877 glyphs to insert is determined by produce_special_glyphs. */
18880 insert_left_trunc_glyphs (struct it
*it
)
18882 struct it truncate_it
;
18883 struct glyph
*from
, *end
, *to
, *toend
;
18885 eassert (!FRAME_WINDOW_P (it
->f
)
18886 || (!it
->glyph_row
->reversed_p
18887 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18888 || (it
->glyph_row
->reversed_p
18889 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18891 /* Get the truncation glyphs. */
18893 truncate_it
.current_x
= 0;
18894 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18895 truncate_it
.glyph_row
= &scratch_glyph_row
;
18896 truncate_it
.area
= TEXT_AREA
;
18897 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18898 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18899 truncate_it
.object
= Qnil
;
18900 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18902 /* Overwrite glyphs from IT with truncation glyphs. */
18903 if (!it
->glyph_row
->reversed_p
)
18905 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18907 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18908 end
= from
+ tused
;
18909 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18910 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18911 if (FRAME_WINDOW_P (it
->f
))
18913 /* On GUI frames, when variable-size fonts are displayed,
18914 the truncation glyphs may need more pixels than the row's
18915 glyphs they overwrite. We overwrite more glyphs to free
18916 enough screen real estate, and enlarge the stretch glyph
18917 on the right (see display_line), if there is one, to
18918 preserve the screen position of the truncation glyphs on
18921 struct glyph
*g
= to
;
18924 /* The first glyph could be partially visible, in which case
18925 it->glyph_row->x will be negative. But we want the left
18926 truncation glyphs to be aligned at the left margin of the
18927 window, so we override the x coordinate at which the row
18929 it
->glyph_row
->x
= 0;
18930 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18932 w
+= g
->pixel_width
;
18935 if (g
- to
- tused
> 0)
18937 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18938 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18940 used
= it
->glyph_row
->used
[TEXT_AREA
];
18941 if (it
->glyph_row
->truncated_on_right_p
18942 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18943 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18946 int extra
= w
- it
->truncation_pixel_width
;
18948 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18955 /* There may be padding glyphs left over. Overwrite them too. */
18956 if (!FRAME_WINDOW_P (it
->f
))
18958 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18960 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18967 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18971 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18973 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18974 that back to front. */
18975 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18976 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18977 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18978 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18979 if (FRAME_WINDOW_P (it
->f
))
18982 struct glyph
*g
= to
;
18984 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18986 w
+= g
->pixel_width
;
18989 if (to
- g
- tused
> 0)
18991 if (it
->glyph_row
->truncated_on_right_p
18992 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18993 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18995 int extra
= w
- it
->truncation_pixel_width
;
18997 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19001 while (from
>= end
&& to
>= toend
)
19003 if (!FRAME_WINDOW_P (it
->f
))
19005 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19008 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19009 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19010 while (from
>= end
&& to
>= toend
)
19016 /* Need to free some room before prepending additional
19018 int move_by
= from
- end
+ 1;
19019 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19020 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19022 for ( ; g
>= g0
; g
--)
19024 while (from
>= end
)
19026 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19031 /* Compute the hash code for ROW. */
19033 row_hash (struct glyph_row
*row
)
19036 unsigned hashval
= 0;
19038 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19039 for (k
= 0; k
< row
->used
[area
]; ++k
)
19040 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19041 + row
->glyphs
[area
][k
].u
.val
19042 + row
->glyphs
[area
][k
].face_id
19043 + row
->glyphs
[area
][k
].padding_p
19044 + (row
->glyphs
[area
][k
].type
<< 2));
19049 /* Compute the pixel height and width of IT->glyph_row.
19051 Most of the time, ascent and height of a display line will be equal
19052 to the max_ascent and max_height values of the display iterator
19053 structure. This is not the case if
19055 1. We hit ZV without displaying anything. In this case, max_ascent
19056 and max_height will be zero.
19058 2. We have some glyphs that don't contribute to the line height.
19059 (The glyph row flag contributes_to_line_height_p is for future
19060 pixmap extensions).
19062 The first case is easily covered by using default values because in
19063 these cases, the line height does not really matter, except that it
19064 must not be zero. */
19067 compute_line_metrics (struct it
*it
)
19069 struct glyph_row
*row
= it
->glyph_row
;
19071 if (FRAME_WINDOW_P (it
->f
))
19073 int i
, min_y
, max_y
;
19075 /* The line may consist of one space only, that was added to
19076 place the cursor on it. If so, the row's height hasn't been
19078 if (row
->height
== 0)
19080 if (it
->max_ascent
+ it
->max_descent
== 0)
19081 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19082 row
->ascent
= it
->max_ascent
;
19083 row
->height
= it
->max_ascent
+ it
->max_descent
;
19084 row
->phys_ascent
= it
->max_phys_ascent
;
19085 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19086 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19089 /* Compute the width of this line. */
19090 row
->pixel_width
= row
->x
;
19091 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19092 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19094 eassert (row
->pixel_width
>= 0);
19095 eassert (row
->ascent
>= 0 && row
->height
> 0);
19097 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19098 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19100 /* If first line's physical ascent is larger than its logical
19101 ascent, use the physical ascent, and make the row taller.
19102 This makes accented characters fully visible. */
19103 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19104 && row
->phys_ascent
> row
->ascent
)
19106 row
->height
+= row
->phys_ascent
- row
->ascent
;
19107 row
->ascent
= row
->phys_ascent
;
19110 /* Compute how much of the line is visible. */
19111 row
->visible_height
= row
->height
;
19113 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19114 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19116 if (row
->y
< min_y
)
19117 row
->visible_height
-= min_y
- row
->y
;
19118 if (row
->y
+ row
->height
> max_y
)
19119 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19123 row
->pixel_width
= row
->used
[TEXT_AREA
];
19124 if (row
->continued_p
)
19125 row
->pixel_width
-= it
->continuation_pixel_width
;
19126 else if (row
->truncated_on_right_p
)
19127 row
->pixel_width
-= it
->truncation_pixel_width
;
19128 row
->ascent
= row
->phys_ascent
= 0;
19129 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19130 row
->extra_line_spacing
= 0;
19133 /* Compute a hash code for this row. */
19134 row
->hash
= row_hash (row
);
19136 it
->max_ascent
= it
->max_descent
= 0;
19137 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19141 /* Append one space to the glyph row of iterator IT if doing a
19142 window-based redisplay. The space has the same face as
19143 IT->face_id. Value is true if a space was added.
19145 This function is called to make sure that there is always one glyph
19146 at the end of a glyph row that the cursor can be set on under
19147 window-systems. (If there weren't such a glyph we would not know
19148 how wide and tall a box cursor should be displayed).
19150 At the same time this space let's a nicely handle clearing to the
19151 end of the line if the row ends in italic text. */
19154 append_space_for_newline (struct it
*it
, bool default_face_p
)
19156 if (FRAME_WINDOW_P (it
->f
))
19158 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19160 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19161 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19163 /* Save some values that must not be changed.
19164 Must save IT->c and IT->len because otherwise
19165 ITERATOR_AT_END_P wouldn't work anymore after
19166 append_space_for_newline has been called. */
19167 enum display_element_type saved_what
= it
->what
;
19168 int saved_c
= it
->c
, saved_len
= it
->len
;
19169 int saved_char_to_display
= it
->char_to_display
;
19170 int saved_x
= it
->current_x
;
19171 int saved_face_id
= it
->face_id
;
19172 bool saved_box_end
= it
->end_of_box_run_p
;
19173 struct text_pos saved_pos
;
19174 Lisp_Object saved_object
;
19178 saved_object
= it
->object
;
19179 saved_pos
= it
->position
;
19181 it
->what
= IT_CHARACTER
;
19182 memset (&it
->position
, 0, sizeof it
->position
);
19184 it
->c
= it
->char_to_display
= ' ';
19187 /* If the default face was remapped, be sure to use the
19188 remapped face for the appended newline. */
19189 if (default_face_p
)
19190 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19191 else if (it
->face_before_selective_p
)
19192 it
->face_id
= it
->saved_face_id
;
19193 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19194 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19195 /* In R2L rows, we will prepend a stretch glyph that will
19196 have the end_of_box_run_p flag set for it, so there's no
19197 need for the appended newline glyph to have that flag
19199 if (it
->glyph_row
->reversed_p
19200 /* But if the appended newline glyph goes all the way to
19201 the end of the row, there will be no stretch glyph,
19202 so leave the box flag set. */
19203 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19204 it
->end_of_box_run_p
= false;
19206 PRODUCE_GLYPHS (it
);
19208 #ifdef HAVE_WINDOW_SYSTEM
19209 /* Make sure this space glyph has the right ascent and
19210 descent values, or else cursor at end of line will look
19211 funny, and height of empty lines will be incorrect. */
19212 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19213 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19214 if (n
== 0 || it
->glyph_row
->height
< font
->pixel_size
)
19216 Lisp_Object height
, total_height
;
19217 int extra_line_spacing
= it
->extra_line_spacing
;
19218 int boff
= font
->baseline_offset
;
19220 if (font
->vertical_centering
)
19221 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19223 it
->object
= saved_object
; /* get_it_property needs this */
19224 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19225 /* Must do a subset of line height processing from
19226 x_produce_glyph for newline characters. */
19227 height
= get_it_property (it
, Qline_height
);
19229 && CONSP (XCDR (height
))
19230 && NILP (XCDR (XCDR (height
))))
19232 total_height
= XCAR (XCDR (height
));
19233 height
= XCAR (height
);
19236 total_height
= Qnil
;
19237 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19239 if (it
->override_ascent
>= 0)
19241 it
->ascent
= it
->override_ascent
;
19242 it
->descent
= it
->override_descent
;
19243 boff
= it
->override_boff
;
19245 if (EQ (height
, Qt
))
19246 extra_line_spacing
= 0;
19249 Lisp_Object spacing
;
19251 it
->phys_ascent
= it
->ascent
;
19252 it
->phys_descent
= it
->descent
;
19254 && XINT (height
) > it
->ascent
+ it
->descent
)
19255 it
->ascent
= XINT (height
) - it
->descent
;
19257 if (!NILP (total_height
))
19258 spacing
= calc_line_height_property (it
, total_height
, font
,
19262 spacing
= get_it_property (it
, Qline_spacing
);
19263 spacing
= calc_line_height_property (it
, spacing
, font
,
19266 if (INTEGERP (spacing
))
19268 extra_line_spacing
= XINT (spacing
);
19269 if (!NILP (total_height
))
19270 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19273 if (extra_line_spacing
> 0)
19275 it
->descent
+= extra_line_spacing
;
19276 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19277 it
->max_extra_line_spacing
= extra_line_spacing
;
19279 it
->max_ascent
= it
->ascent
;
19280 it
->max_descent
= it
->descent
;
19281 /* Make sure compute_line_metrics recomputes the row height. */
19282 it
->glyph_row
->height
= 0;
19285 g
->ascent
= it
->max_ascent
;
19286 g
->descent
= it
->max_descent
;
19289 it
->override_ascent
= -1;
19290 it
->constrain_row_ascent_descent_p
= false;
19291 it
->current_x
= saved_x
;
19292 it
->object
= saved_object
;
19293 it
->position
= saved_pos
;
19294 it
->what
= saved_what
;
19295 it
->face_id
= saved_face_id
;
19296 it
->len
= saved_len
;
19298 it
->char_to_display
= saved_char_to_display
;
19299 it
->end_of_box_run_p
= saved_box_end
;
19308 /* Extend the face of the last glyph in the text area of IT->glyph_row
19309 to the end of the display line. Called from display_line. If the
19310 glyph row is empty, add a space glyph to it so that we know the
19311 face to draw. Set the glyph row flag fill_line_p. If the glyph
19312 row is R2L, prepend a stretch glyph to cover the empty space to the
19313 left of the leftmost glyph. */
19316 extend_face_to_end_of_line (struct it
*it
)
19318 struct face
*face
, *default_face
;
19319 struct frame
*f
= it
->f
;
19321 /* If line is already filled, do nothing. Non window-system frames
19322 get a grace of one more ``pixel'' because their characters are
19323 1-``pixel'' wide, so they hit the equality too early. This grace
19324 is needed only for R2L rows that are not continued, to produce
19325 one extra blank where we could display the cursor. */
19326 if ((it
->current_x
>= it
->last_visible_x
19327 + (!FRAME_WINDOW_P (f
)
19328 && it
->glyph_row
->reversed_p
19329 && !it
->glyph_row
->continued_p
))
19330 /* If the window has display margins, we will need to extend
19331 their face even if the text area is filled. */
19332 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19333 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19336 /* The default face, possibly remapped. */
19337 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19339 /* Face extension extends the background and box of IT->face_id
19340 to the end of the line. If the background equals the background
19341 of the frame, we don't have to do anything. */
19342 if (it
->face_before_selective_p
)
19343 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19345 face
= FACE_FROM_ID (f
, it
->face_id
);
19347 if (FRAME_WINDOW_P (f
)
19348 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19349 && face
->box
== FACE_NO_BOX
19350 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19351 #ifdef HAVE_WINDOW_SYSTEM
19354 && !it
->glyph_row
->reversed_p
)
19357 /* Set the glyph row flag indicating that the face of the last glyph
19358 in the text area has to be drawn to the end of the text area. */
19359 it
->glyph_row
->fill_line_p
= true;
19361 /* If current character of IT is not ASCII, make sure we have the
19362 ASCII face. This will be automatically undone the next time
19363 get_next_display_element returns a multibyte character. Note
19364 that the character will always be single byte in unibyte
19366 if (!ASCII_CHAR_P (it
->c
))
19368 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19371 if (FRAME_WINDOW_P (f
))
19373 /* If the row is empty, add a space with the current face of IT,
19374 so that we know which face to draw. */
19375 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19377 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19378 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19379 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19381 /* Mode line and the header line don't have margins, and
19382 likewise the frame's tool-bar window, if there is any. */
19383 if (!(it
->glyph_row
->mode_line_p
19384 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19385 || (WINDOWP (f
->tool_bar_window
)
19386 && it
->w
== XWINDOW (f
->tool_bar_window
))
19390 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19391 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19393 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19394 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19396 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19398 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19399 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19401 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19402 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19404 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19407 #ifdef HAVE_WINDOW_SYSTEM
19408 if (it
->glyph_row
->reversed_p
)
19410 /* Prepend a stretch glyph to the row, such that the
19411 rightmost glyph will be drawn flushed all the way to the
19412 right margin of the window. The stretch glyph that will
19413 occupy the empty space, if any, to the left of the
19415 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19416 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19417 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19419 int row_width
, stretch_ascent
, stretch_width
;
19420 struct text_pos saved_pos
;
19422 bool saved_avoid_cursor
, saved_box_start
;
19424 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19425 row_width
+= g
->pixel_width
;
19427 /* FIXME: There are various minor display glitches in R2L
19428 rows when only one of the fringes is missing. The
19429 strange condition below produces the least bad effect. */
19430 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19431 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19432 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19433 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19435 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19436 stretch_width
-= row_width
;
19438 if (stretch_width
> 0)
19441 (((it
->ascent
+ it
->descent
)
19442 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19443 saved_pos
= it
->position
;
19444 memset (&it
->position
, 0, sizeof it
->position
);
19445 saved_avoid_cursor
= it
->avoid_cursor_p
;
19446 it
->avoid_cursor_p
= true;
19447 saved_face_id
= it
->face_id
;
19448 saved_box_start
= it
->start_of_box_run_p
;
19449 /* The last row's stretch glyph should get the default
19450 face, to avoid painting the rest of the window with
19451 the region face, if the region ends at ZV. */
19452 if (it
->glyph_row
->ends_at_zv_p
)
19453 it
->face_id
= default_face
->id
;
19455 it
->face_id
= face
->id
;
19456 it
->start_of_box_run_p
= false;
19457 append_stretch_glyph (it
, Qnil
, stretch_width
,
19458 it
->ascent
+ it
->descent
, stretch_ascent
);
19459 it
->position
= saved_pos
;
19460 it
->avoid_cursor_p
= saved_avoid_cursor
;
19461 it
->face_id
= saved_face_id
;
19462 it
->start_of_box_run_p
= saved_box_start
;
19464 /* If stretch_width comes out negative, it means that the
19465 last glyph is only partially visible. In R2L rows, we
19466 want the leftmost glyph to be partially visible, so we
19467 need to give the row the corresponding left offset. */
19468 if (stretch_width
< 0)
19469 it
->glyph_row
->x
= stretch_width
;
19471 #endif /* HAVE_WINDOW_SYSTEM */
19475 /* Save some values that must not be changed. */
19476 int saved_x
= it
->current_x
;
19477 struct text_pos saved_pos
;
19478 Lisp_Object saved_object
;
19479 enum display_element_type saved_what
= it
->what
;
19480 int saved_face_id
= it
->face_id
;
19482 saved_object
= it
->object
;
19483 saved_pos
= it
->position
;
19485 it
->what
= IT_CHARACTER
;
19486 memset (&it
->position
, 0, sizeof it
->position
);
19488 it
->c
= it
->char_to_display
= ' ';
19491 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19492 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19493 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19494 && !it
->glyph_row
->mode_line_p
19495 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19497 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19498 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19500 for (it
->current_x
= 0; g
< e
; g
++)
19501 it
->current_x
+= g
->pixel_width
;
19503 it
->area
= LEFT_MARGIN_AREA
;
19504 it
->face_id
= default_face
->id
;
19505 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19506 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19508 PRODUCE_GLYPHS (it
);
19509 /* term.c:produce_glyphs advances it->current_x only for
19511 it
->current_x
+= it
->pixel_width
;
19514 it
->current_x
= saved_x
;
19515 it
->area
= TEXT_AREA
;
19518 /* The last row's blank glyphs should get the default face, to
19519 avoid painting the rest of the window with the region face,
19520 if the region ends at ZV. */
19521 if (it
->glyph_row
->ends_at_zv_p
)
19522 it
->face_id
= default_face
->id
;
19524 it
->face_id
= face
->id
;
19525 PRODUCE_GLYPHS (it
);
19527 while (it
->current_x
<= it
->last_visible_x
)
19528 PRODUCE_GLYPHS (it
);
19530 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19531 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19532 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19533 && !it
->glyph_row
->mode_line_p
19534 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19536 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19537 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19539 for ( ; g
< e
; g
++)
19540 it
->current_x
+= g
->pixel_width
;
19542 it
->area
= RIGHT_MARGIN_AREA
;
19543 it
->face_id
= default_face
->id
;
19544 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19545 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19547 PRODUCE_GLYPHS (it
);
19548 it
->current_x
+= it
->pixel_width
;
19551 it
->area
= TEXT_AREA
;
19554 /* Don't count these blanks really. It would let us insert a left
19555 truncation glyph below and make us set the cursor on them, maybe. */
19556 it
->current_x
= saved_x
;
19557 it
->object
= saved_object
;
19558 it
->position
= saved_pos
;
19559 it
->what
= saved_what
;
19560 it
->face_id
= saved_face_id
;
19565 /* Value is true if text starting at CHARPOS in current_buffer is
19566 trailing whitespace. */
19569 trailing_whitespace_p (ptrdiff_t charpos
)
19571 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19574 while (bytepos
< ZV_BYTE
19575 && (c
= FETCH_CHAR (bytepos
),
19576 c
== ' ' || c
== '\t'))
19579 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19581 if (bytepos
!= PT_BYTE
)
19588 /* Highlight trailing whitespace, if any, in ROW. */
19591 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19593 int used
= row
->used
[TEXT_AREA
];
19597 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19598 struct glyph
*glyph
= start
+ used
- 1;
19600 if (row
->reversed_p
)
19602 /* Right-to-left rows need to be processed in the opposite
19603 direction, so swap the edge pointers. */
19605 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19608 /* Skip over glyphs inserted to display the cursor at the
19609 end of a line, for extending the face of the last glyph
19610 to the end of the line on terminals, and for truncation
19611 and continuation glyphs. */
19612 if (!row
->reversed_p
)
19614 while (glyph
>= start
19615 && glyph
->type
== CHAR_GLYPH
19616 && NILP (glyph
->object
))
19621 while (glyph
<= start
19622 && glyph
->type
== CHAR_GLYPH
19623 && NILP (glyph
->object
))
19627 /* If last glyph is a space or stretch, and it's trailing
19628 whitespace, set the face of all trailing whitespace glyphs in
19629 IT->glyph_row to `trailing-whitespace'. */
19630 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19631 && BUFFERP (glyph
->object
)
19632 && (glyph
->type
== STRETCH_GLYPH
19633 || (glyph
->type
== CHAR_GLYPH
19634 && glyph
->u
.ch
== ' '))
19635 && trailing_whitespace_p (glyph
->charpos
))
19637 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19641 if (!row
->reversed_p
)
19643 while (glyph
>= start
19644 && BUFFERP (glyph
->object
)
19645 && (glyph
->type
== STRETCH_GLYPH
19646 || (glyph
->type
== CHAR_GLYPH
19647 && glyph
->u
.ch
== ' ')))
19648 (glyph
--)->face_id
= face_id
;
19652 while (glyph
<= start
19653 && BUFFERP (glyph
->object
)
19654 && (glyph
->type
== STRETCH_GLYPH
19655 || (glyph
->type
== CHAR_GLYPH
19656 && glyph
->u
.ch
== ' ')))
19657 (glyph
++)->face_id
= face_id
;
19664 /* Value is true if glyph row ROW should be
19665 considered to hold the buffer position CHARPOS. */
19668 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19670 bool result
= true;
19672 if (charpos
== CHARPOS (row
->end
.pos
)
19673 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19675 /* Suppose the row ends on a string.
19676 Unless the row is continued, that means it ends on a newline
19677 in the string. If it's anything other than a display string
19678 (e.g., a before-string from an overlay), we don't want the
19679 cursor there. (This heuristic seems to give the optimal
19680 behavior for the various types of multi-line strings.)
19681 One exception: if the string has `cursor' property on one of
19682 its characters, we _do_ want the cursor there. */
19683 if (CHARPOS (row
->end
.string_pos
) >= 0)
19685 if (row
->continued_p
)
19689 /* Check for `display' property. */
19690 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19691 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19692 struct glyph
*glyph
;
19695 for (glyph
= end
; glyph
>= beg
; --glyph
)
19696 if (STRINGP (glyph
->object
))
19699 = Fget_char_property (make_number (charpos
),
19703 && display_prop_string_p (prop
, glyph
->object
));
19704 /* If there's a `cursor' property on one of the
19705 string's characters, this row is a cursor row,
19706 even though this is not a display string. */
19709 Lisp_Object s
= glyph
->object
;
19711 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19713 ptrdiff_t gpos
= glyph
->charpos
;
19715 if (!NILP (Fget_char_property (make_number (gpos
),
19727 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19729 /* If the row ends in middle of a real character,
19730 and the line is continued, we want the cursor here.
19731 That's because CHARPOS (ROW->end.pos) would equal
19732 PT if PT is before the character. */
19733 if (!row
->ends_in_ellipsis_p
)
19734 result
= row
->continued_p
;
19736 /* If the row ends in an ellipsis, then
19737 CHARPOS (ROW->end.pos) will equal point after the
19738 invisible text. We want that position to be displayed
19739 after the ellipsis. */
19742 /* If the row ends at ZV, display the cursor at the end of that
19743 row instead of at the start of the row below. */
19745 result
= row
->ends_at_zv_p
;
19751 /* Value is true if glyph row ROW should be
19752 used to hold the cursor. */
19755 cursor_row_p (struct glyph_row
*row
)
19757 return row_for_charpos_p (row
, PT
);
19762 /* Push the property PROP so that it will be rendered at the current
19763 position in IT. Return true if PROP was successfully pushed, false
19764 otherwise. Called from handle_line_prefix to handle the
19765 `line-prefix' and `wrap-prefix' properties. */
19768 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19770 struct text_pos pos
=
19771 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19773 eassert (it
->method
== GET_FROM_BUFFER
19774 || it
->method
== GET_FROM_DISPLAY_VECTOR
19775 || it
->method
== GET_FROM_STRING
);
19777 /* We need to save the current buffer/string position, so it will be
19778 restored by pop_it, because iterate_out_of_display_property
19779 depends on that being set correctly, but some situations leave
19780 it->position not yet set when this function is called. */
19781 push_it (it
, &pos
);
19783 if (STRINGP (prop
))
19785 if (SCHARS (prop
) == 0)
19792 it
->string_from_prefix_prop_p
= true;
19793 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19794 it
->current
.overlay_string_index
= -1;
19795 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19796 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19797 it
->method
= GET_FROM_STRING
;
19798 it
->stop_charpos
= 0;
19800 it
->base_level_stop
= 0;
19802 /* Force paragraph direction to be that of the parent
19804 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19805 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19807 it
->paragraph_embedding
= L2R
;
19809 /* Set up the bidi iterator for this display string. */
19812 it
->bidi_it
.string
.lstring
= it
->string
;
19813 it
->bidi_it
.string
.s
= NULL
;
19814 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19815 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19816 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19817 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19818 it
->bidi_it
.w
= it
->w
;
19819 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19822 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19824 it
->method
= GET_FROM_STRETCH
;
19827 #ifdef HAVE_WINDOW_SYSTEM
19828 else if (IMAGEP (prop
))
19830 it
->what
= IT_IMAGE
;
19831 it
->image_id
= lookup_image (it
->f
, prop
);
19832 it
->method
= GET_FROM_IMAGE
;
19834 #endif /* HAVE_WINDOW_SYSTEM */
19837 pop_it (it
); /* bogus display property, give up */
19844 /* Return the character-property PROP at the current position in IT. */
19847 get_it_property (struct it
*it
, Lisp_Object prop
)
19849 Lisp_Object position
, object
= it
->object
;
19851 if (STRINGP (object
))
19852 position
= make_number (IT_STRING_CHARPOS (*it
));
19853 else if (BUFFERP (object
))
19855 position
= make_number (IT_CHARPOS (*it
));
19856 object
= it
->window
;
19861 return Fget_char_property (position
, prop
, object
);
19864 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19867 handle_line_prefix (struct it
*it
)
19869 Lisp_Object prefix
;
19871 if (it
->continuation_lines_width
> 0)
19873 prefix
= get_it_property (it
, Qwrap_prefix
);
19875 prefix
= Vwrap_prefix
;
19879 prefix
= get_it_property (it
, Qline_prefix
);
19881 prefix
= Vline_prefix
;
19883 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19885 /* If the prefix is wider than the window, and we try to wrap
19886 it, it would acquire its own wrap prefix, and so on till the
19887 iterator stack overflows. So, don't wrap the prefix. */
19888 it
->line_wrap
= TRUNCATE
;
19889 it
->avoid_cursor_p
= true;
19895 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19896 only for R2L lines from display_line and display_string, when they
19897 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19898 the line/string needs to be continued on the next glyph row. */
19900 unproduce_glyphs (struct it
*it
, int n
)
19902 struct glyph
*glyph
, *end
;
19904 eassert (it
->glyph_row
);
19905 eassert (it
->glyph_row
->reversed_p
);
19906 eassert (it
->area
== TEXT_AREA
);
19907 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19909 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19910 n
= it
->glyph_row
->used
[TEXT_AREA
];
19911 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19912 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19913 for ( ; glyph
< end
; glyph
++)
19914 glyph
[-n
] = *glyph
;
19917 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19918 and ROW->maxpos. */
19920 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19921 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19922 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19924 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19925 lines' rows is implemented for bidi-reordered rows. */
19927 /* ROW->minpos is the value of min_pos, the minimal buffer position
19928 we have in ROW, or ROW->start.pos if that is smaller. */
19929 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19930 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19932 /* We didn't find buffer positions smaller than ROW->start, or
19933 didn't find _any_ valid buffer positions in any of the glyphs,
19934 so we must trust the iterator's computed positions. */
19935 row
->minpos
= row
->start
.pos
;
19938 max_pos
= CHARPOS (it
->current
.pos
);
19939 max_bpos
= BYTEPOS (it
->current
.pos
);
19942 /* Here are the various use-cases for ending the row, and the
19943 corresponding values for ROW->maxpos:
19945 Line ends in a newline from buffer eol_pos + 1
19946 Line is continued from buffer max_pos + 1
19947 Line is truncated on right it->current.pos
19948 Line ends in a newline from string max_pos + 1(*)
19949 (*) + 1 only when line ends in a forward scan
19950 Line is continued from string max_pos
19951 Line is continued from display vector max_pos
19952 Line is entirely from a string min_pos == max_pos
19953 Line is entirely from a display vector min_pos == max_pos
19954 Line that ends at ZV ZV
19956 If you discover other use-cases, please add them here as
19958 if (row
->ends_at_zv_p
)
19959 row
->maxpos
= it
->current
.pos
;
19960 else if (row
->used
[TEXT_AREA
])
19962 bool seen_this_string
= false;
19963 struct glyph_row
*r1
= row
- 1;
19965 /* Did we see the same display string on the previous row? */
19966 if (STRINGP (it
->object
)
19967 /* this is not the first row */
19968 && row
> it
->w
->desired_matrix
->rows
19969 /* previous row is not the header line */
19970 && !r1
->mode_line_p
19971 /* previous row also ends in a newline from a string */
19972 && r1
->ends_in_newline_from_string_p
)
19974 struct glyph
*start
, *end
;
19976 /* Search for the last glyph of the previous row that came
19977 from buffer or string. Depending on whether the row is
19978 L2R or R2L, we need to process it front to back or the
19979 other way round. */
19980 if (!r1
->reversed_p
)
19982 start
= r1
->glyphs
[TEXT_AREA
];
19983 end
= start
+ r1
->used
[TEXT_AREA
];
19984 /* Glyphs inserted by redisplay have nil as their object. */
19986 && NILP ((end
- 1)->object
)
19987 && (end
- 1)->charpos
<= 0)
19991 if (EQ ((end
- 1)->object
, it
->object
))
19992 seen_this_string
= true;
19995 /* If all the glyphs of the previous row were inserted
19996 by redisplay, it means the previous row was
19997 produced from a single newline, which is only
19998 possible if that newline came from the same string
19999 as the one which produced this ROW. */
20000 seen_this_string
= true;
20004 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20005 start
= end
+ r1
->used
[TEXT_AREA
];
20007 && NILP ((end
+ 1)->object
)
20008 && (end
+ 1)->charpos
<= 0)
20012 if (EQ ((end
+ 1)->object
, it
->object
))
20013 seen_this_string
= true;
20016 seen_this_string
= true;
20019 /* Take note of each display string that covers a newline only
20020 once, the first time we see it. This is for when a display
20021 string includes more than one newline in it. */
20022 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20024 /* If we were scanning the buffer forward when we displayed
20025 the string, we want to account for at least one buffer
20026 position that belongs to this row (position covered by
20027 the display string), so that cursor positioning will
20028 consider this row as a candidate when point is at the end
20029 of the visual line represented by this row. This is not
20030 required when scanning back, because max_pos will already
20031 have a much larger value. */
20032 if (CHARPOS (row
->end
.pos
) > max_pos
)
20033 INC_BOTH (max_pos
, max_bpos
);
20034 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20036 else if (CHARPOS (it
->eol_pos
) > 0)
20037 SET_TEXT_POS (row
->maxpos
,
20038 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20039 else if (row
->continued_p
)
20041 /* If max_pos is different from IT's current position, it
20042 means IT->method does not belong to the display element
20043 at max_pos. However, it also means that the display
20044 element at max_pos was displayed in its entirety on this
20045 line, which is equivalent to saying that the next line
20046 starts at the next buffer position. */
20047 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20048 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20051 INC_BOTH (max_pos
, max_bpos
);
20052 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20055 else if (row
->truncated_on_right_p
)
20056 /* display_line already called reseat_at_next_visible_line_start,
20057 which puts the iterator at the beginning of the next line, in
20058 the logical order. */
20059 row
->maxpos
= it
->current
.pos
;
20060 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20061 /* A line that is entirely from a string/image/stretch... */
20062 row
->maxpos
= row
->minpos
;
20067 row
->maxpos
= it
->current
.pos
;
20070 /* Construct the glyph row IT->glyph_row in the desired matrix of
20071 IT->w from text at the current position of IT. See dispextern.h
20072 for an overview of struct it. Value is true if
20073 IT->glyph_row displays text, as opposed to a line displaying ZV
20077 display_line (struct it
*it
)
20079 struct glyph_row
*row
= it
->glyph_row
;
20080 Lisp_Object overlay_arrow_string
;
20082 void *wrap_data
= NULL
;
20083 bool may_wrap
= false;
20084 int wrap_x
IF_LINT (= 0);
20085 int wrap_row_used
= -1;
20086 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20087 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20088 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20089 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20090 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20092 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20093 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20094 bool pending_handle_line_prefix
= false;
20096 /* We always start displaying at hpos zero even if hscrolled. */
20097 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20099 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20100 >= it
->w
->desired_matrix
->nrows
)
20102 it
->w
->nrows_scale_factor
++;
20103 it
->f
->fonts_changed
= true;
20107 /* Clear the result glyph row and enable it. */
20108 prepare_desired_row (it
->w
, row
, false);
20110 row
->y
= it
->current_y
;
20111 row
->start
= it
->start
;
20112 row
->continuation_lines_width
= it
->continuation_lines_width
;
20113 row
->displays_text_p
= true;
20114 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20115 it
->starts_in_middle_of_char_p
= false;
20117 /* Arrange the overlays nicely for our purposes. Usually, we call
20118 display_line on only one line at a time, in which case this
20119 can't really hurt too much, or we call it on lines which appear
20120 one after another in the buffer, in which case all calls to
20121 recenter_overlay_lists but the first will be pretty cheap. */
20122 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20124 /* Move over display elements that are not visible because we are
20125 hscrolled. This may stop at an x-position < IT->first_visible_x
20126 if the first glyph is partially visible or if we hit a line end. */
20127 if (it
->current_x
< it
->first_visible_x
)
20129 enum move_it_result move_result
;
20131 this_line_min_pos
= row
->start
.pos
;
20132 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20133 MOVE_TO_POS
| MOVE_TO_X
);
20134 /* If we are under a large hscroll, move_it_in_display_line_to
20135 could hit the end of the line without reaching
20136 it->first_visible_x. Pretend that we did reach it. This is
20137 especially important on a TTY, where we will call
20138 extend_face_to_end_of_line, which needs to know how many
20139 blank glyphs to produce. */
20140 if (it
->current_x
< it
->first_visible_x
20141 && (move_result
== MOVE_NEWLINE_OR_CR
20142 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20143 it
->current_x
= it
->first_visible_x
;
20145 /* Record the smallest positions seen while we moved over
20146 display elements that are not visible. This is needed by
20147 redisplay_internal for optimizing the case where the cursor
20148 stays inside the same line. The rest of this function only
20149 considers positions that are actually displayed, so
20150 RECORD_MAX_MIN_POS will not otherwise record positions that
20151 are hscrolled to the left of the left edge of the window. */
20152 min_pos
= CHARPOS (this_line_min_pos
);
20153 min_bpos
= BYTEPOS (this_line_min_pos
);
20155 else if (it
->area
== TEXT_AREA
)
20157 /* We only do this when not calling move_it_in_display_line_to
20158 above, because that function calls itself handle_line_prefix. */
20159 handle_line_prefix (it
);
20163 /* Line-prefix and wrap-prefix are always displayed in the text
20164 area. But if this is the first call to display_line after
20165 init_iterator, the iterator might have been set up to write
20166 into a marginal area, e.g. if the line begins with some
20167 display property that writes to the margins. So we need to
20168 wait with the call to handle_line_prefix until whatever
20169 writes to the margin has done its job. */
20170 pending_handle_line_prefix
= true;
20173 /* Get the initial row height. This is either the height of the
20174 text hscrolled, if there is any, or zero. */
20175 row
->ascent
= it
->max_ascent
;
20176 row
->height
= it
->max_ascent
+ it
->max_descent
;
20177 row
->phys_ascent
= it
->max_phys_ascent
;
20178 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20179 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20181 /* Utility macro to record max and min buffer positions seen until now. */
20182 #define RECORD_MAX_MIN_POS(IT) \
20185 bool composition_p \
20186 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20187 ptrdiff_t current_pos = \
20188 composition_p ? (IT)->cmp_it.charpos \
20189 : IT_CHARPOS (*(IT)); \
20190 ptrdiff_t current_bpos = \
20191 composition_p ? CHAR_TO_BYTE (current_pos) \
20192 : IT_BYTEPOS (*(IT)); \
20193 if (current_pos < min_pos) \
20195 min_pos = current_pos; \
20196 min_bpos = current_bpos; \
20198 if (IT_CHARPOS (*it) > max_pos) \
20200 max_pos = IT_CHARPOS (*it); \
20201 max_bpos = IT_BYTEPOS (*it); \
20206 /* Loop generating characters. The loop is left with IT on the next
20207 character to display. */
20210 int n_glyphs_before
, hpos_before
, x_before
;
20212 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20214 /* Retrieve the next thing to display. Value is false if end of
20216 if (!get_next_display_element (it
))
20218 /* Maybe add a space at the end of this line that is used to
20219 display the cursor there under X. Set the charpos of the
20220 first glyph of blank lines not corresponding to any text
20222 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20223 row
->exact_window_width_line_p
= true;
20224 else if ((append_space_for_newline (it
, true)
20225 && row
->used
[TEXT_AREA
] == 1)
20226 || row
->used
[TEXT_AREA
] == 0)
20228 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20229 row
->displays_text_p
= false;
20231 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20232 && (!MINI_WINDOW_P (it
->w
)
20233 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20234 row
->indicate_empty_line_p
= true;
20237 it
->continuation_lines_width
= 0;
20238 row
->ends_at_zv_p
= true;
20239 /* A row that displays right-to-left text must always have
20240 its last face extended all the way to the end of line,
20241 even if this row ends in ZV, because we still write to
20242 the screen left to right. We also need to extend the
20243 last face if the default face is remapped to some
20244 different face, otherwise the functions that clear
20245 portions of the screen will clear with the default face's
20246 background color. */
20247 if (row
->reversed_p
20248 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20249 extend_face_to_end_of_line (it
);
20253 /* Now, get the metrics of what we want to display. This also
20254 generates glyphs in `row' (which is IT->glyph_row). */
20255 n_glyphs_before
= row
->used
[TEXT_AREA
];
20258 /* Remember the line height so far in case the next element doesn't
20259 fit on the line. */
20260 if (it
->line_wrap
!= TRUNCATE
)
20262 ascent
= it
->max_ascent
;
20263 descent
= it
->max_descent
;
20264 phys_ascent
= it
->max_phys_ascent
;
20265 phys_descent
= it
->max_phys_descent
;
20267 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20269 if (IT_DISPLAYING_WHITESPACE (it
))
20273 SAVE_IT (wrap_it
, *it
, wrap_data
);
20275 wrap_row_used
= row
->used
[TEXT_AREA
];
20276 wrap_row_ascent
= row
->ascent
;
20277 wrap_row_height
= row
->height
;
20278 wrap_row_phys_ascent
= row
->phys_ascent
;
20279 wrap_row_phys_height
= row
->phys_height
;
20280 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20281 wrap_row_min_pos
= min_pos
;
20282 wrap_row_min_bpos
= min_bpos
;
20283 wrap_row_max_pos
= max_pos
;
20284 wrap_row_max_bpos
= max_bpos
;
20290 PRODUCE_GLYPHS (it
);
20292 /* If this display element was in marginal areas, continue with
20294 if (it
->area
!= TEXT_AREA
)
20296 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20297 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20298 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20299 row
->phys_height
= max (row
->phys_height
,
20300 it
->max_phys_ascent
+ it
->max_phys_descent
);
20301 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20302 it
->max_extra_line_spacing
);
20303 set_iterator_to_next (it
, true);
20304 /* If we didn't handle the line/wrap prefix above, and the
20305 call to set_iterator_to_next just switched to TEXT_AREA,
20306 process the prefix now. */
20307 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20309 pending_handle_line_prefix
= false;
20310 handle_line_prefix (it
);
20315 /* Does the display element fit on the line? If we truncate
20316 lines, we should draw past the right edge of the window. If
20317 we don't truncate, we want to stop so that we can display the
20318 continuation glyph before the right margin. If lines are
20319 continued, there are two possible strategies for characters
20320 resulting in more than 1 glyph (e.g. tabs): Display as many
20321 glyphs as possible in this line and leave the rest for the
20322 continuation line, or display the whole element in the next
20323 line. Original redisplay did the former, so we do it also. */
20324 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20325 hpos_before
= it
->hpos
;
20328 if (/* Not a newline. */
20330 /* Glyphs produced fit entirely in the line. */
20331 && it
->current_x
< it
->last_visible_x
)
20333 it
->hpos
+= nglyphs
;
20334 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20335 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20336 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20337 row
->phys_height
= max (row
->phys_height
,
20338 it
->max_phys_ascent
+ it
->max_phys_descent
);
20339 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20340 it
->max_extra_line_spacing
);
20341 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20342 /* In R2L rows, we arrange in extend_face_to_end_of_line
20343 to add a right offset to the line, by a suitable
20344 change to the stretch glyph that is the leftmost
20345 glyph of the line. */
20346 && !row
->reversed_p
)
20347 row
->x
= x
- it
->first_visible_x
;
20348 /* Record the maximum and minimum buffer positions seen so
20349 far in glyphs that will be displayed by this row. */
20351 RECORD_MAX_MIN_POS (it
);
20356 struct glyph
*glyph
;
20358 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20360 /* Identify the glyphs added by the last call to
20361 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20362 the previous glyphs. */
20363 if (!row
->reversed_p
)
20364 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20366 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20367 new_x
= x
+ glyph
->pixel_width
;
20369 if (/* Lines are continued. */
20370 it
->line_wrap
!= TRUNCATE
20371 && (/* Glyph doesn't fit on the line. */
20372 new_x
> it
->last_visible_x
20373 /* Or it fits exactly on a window system frame. */
20374 || (new_x
== it
->last_visible_x
20375 && FRAME_WINDOW_P (it
->f
)
20376 && (row
->reversed_p
20377 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20378 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20380 /* End of a continued line. */
20383 || (new_x
== it
->last_visible_x
20384 && FRAME_WINDOW_P (it
->f
)
20385 && (row
->reversed_p
20386 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20387 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20389 /* Current glyph is the only one on the line or
20390 fits exactly on the line. We must continue
20391 the line because we can't draw the cursor
20392 after the glyph. */
20393 row
->continued_p
= true;
20394 it
->current_x
= new_x
;
20395 it
->continuation_lines_width
+= new_x
;
20397 if (i
== nglyphs
- 1)
20399 /* If line-wrap is on, check if a previous
20400 wrap point was found. */
20401 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20402 && wrap_row_used
> 0
20403 /* Even if there is a previous wrap
20404 point, continue the line here as
20405 usual, if (i) the previous character
20406 was a space or tab AND (ii) the
20407 current character is not. */
20409 || IT_DISPLAYING_WHITESPACE (it
)))
20412 /* Record the maximum and minimum buffer
20413 positions seen so far in glyphs that will be
20414 displayed by this row. */
20416 RECORD_MAX_MIN_POS (it
);
20417 set_iterator_to_next (it
, true);
20418 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20420 if (!get_next_display_element (it
))
20422 row
->exact_window_width_line_p
= true;
20423 it
->continuation_lines_width
= 0;
20424 row
->continued_p
= false;
20425 row
->ends_at_zv_p
= true;
20427 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20429 row
->continued_p
= false;
20430 row
->exact_window_width_line_p
= true;
20432 /* If line-wrap is on, check if a
20433 previous wrap point was found. */
20434 else if (wrap_row_used
> 0
20435 /* Even if there is a previous wrap
20436 point, continue the line here as
20437 usual, if (i) the previous character
20438 was a space or tab AND (ii) the
20439 current character is not. */
20441 || IT_DISPLAYING_WHITESPACE (it
)))
20446 else if (it
->bidi_p
)
20447 RECORD_MAX_MIN_POS (it
);
20448 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20449 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20450 extend_face_to_end_of_line (it
);
20452 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20453 && !FRAME_WINDOW_P (it
->f
))
20455 /* A padding glyph that doesn't fit on this line.
20456 This means the whole character doesn't fit
20458 if (row
->reversed_p
)
20459 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20460 - n_glyphs_before
);
20461 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20463 /* Fill the rest of the row with continuation
20464 glyphs like in 20.x. */
20465 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20466 < row
->glyphs
[1 + TEXT_AREA
])
20467 produce_special_glyphs (it
, IT_CONTINUATION
);
20469 row
->continued_p
= true;
20470 it
->current_x
= x_before
;
20471 it
->continuation_lines_width
+= x_before
;
20473 /* Restore the height to what it was before the
20474 element not fitting on the line. */
20475 it
->max_ascent
= ascent
;
20476 it
->max_descent
= descent
;
20477 it
->max_phys_ascent
= phys_ascent
;
20478 it
->max_phys_descent
= phys_descent
;
20479 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20480 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20481 extend_face_to_end_of_line (it
);
20483 else if (wrap_row_used
> 0)
20486 if (row
->reversed_p
)
20487 unproduce_glyphs (it
,
20488 row
->used
[TEXT_AREA
] - wrap_row_used
);
20489 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20490 it
->continuation_lines_width
+= wrap_x
;
20491 row
->used
[TEXT_AREA
] = wrap_row_used
;
20492 row
->ascent
= wrap_row_ascent
;
20493 row
->height
= wrap_row_height
;
20494 row
->phys_ascent
= wrap_row_phys_ascent
;
20495 row
->phys_height
= wrap_row_phys_height
;
20496 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20497 min_pos
= wrap_row_min_pos
;
20498 min_bpos
= wrap_row_min_bpos
;
20499 max_pos
= wrap_row_max_pos
;
20500 max_bpos
= wrap_row_max_bpos
;
20501 row
->continued_p
= true;
20502 row
->ends_at_zv_p
= false;
20503 row
->exact_window_width_line_p
= false;
20504 it
->continuation_lines_width
+= x
;
20506 /* Make sure that a non-default face is extended
20507 up to the right margin of the window. */
20508 extend_face_to_end_of_line (it
);
20510 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20512 /* A TAB that extends past the right edge of the
20513 window. This produces a single glyph on
20514 window system frames. We leave the glyph in
20515 this row and let it fill the row, but don't
20516 consume the TAB. */
20517 if ((row
->reversed_p
20518 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20519 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20520 produce_special_glyphs (it
, IT_CONTINUATION
);
20521 it
->continuation_lines_width
+= it
->last_visible_x
;
20522 row
->ends_in_middle_of_char_p
= true;
20523 row
->continued_p
= true;
20524 glyph
->pixel_width
= it
->last_visible_x
- x
;
20525 it
->starts_in_middle_of_char_p
= true;
20526 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20527 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20528 extend_face_to_end_of_line (it
);
20532 /* Something other than a TAB that draws past
20533 the right edge of the window. Restore
20534 positions to values before the element. */
20535 if (row
->reversed_p
)
20536 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20537 - (n_glyphs_before
+ i
));
20538 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20540 /* Display continuation glyphs. */
20541 it
->current_x
= x_before
;
20542 it
->continuation_lines_width
+= x
;
20543 if (!FRAME_WINDOW_P (it
->f
)
20544 || (row
->reversed_p
20545 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20546 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20547 produce_special_glyphs (it
, IT_CONTINUATION
);
20548 row
->continued_p
= true;
20550 extend_face_to_end_of_line (it
);
20552 if (nglyphs
> 1 && i
> 0)
20554 row
->ends_in_middle_of_char_p
= true;
20555 it
->starts_in_middle_of_char_p
= true;
20558 /* Restore the height to what it was before the
20559 element not fitting on the line. */
20560 it
->max_ascent
= ascent
;
20561 it
->max_descent
= descent
;
20562 it
->max_phys_ascent
= phys_ascent
;
20563 it
->max_phys_descent
= phys_descent
;
20568 else if (new_x
> it
->first_visible_x
)
20570 /* Increment number of glyphs actually displayed. */
20573 /* Record the maximum and minimum buffer positions
20574 seen so far in glyphs that will be displayed by
20577 RECORD_MAX_MIN_POS (it
);
20579 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20580 /* Glyph is partially visible, i.e. row starts at
20581 negative X position. Don't do that in R2L
20582 rows, where we arrange to add a right offset to
20583 the line in extend_face_to_end_of_line, by a
20584 suitable change to the stretch glyph that is
20585 the leftmost glyph of the line. */
20586 row
->x
= x
- it
->first_visible_x
;
20587 /* When the last glyph of an R2L row only fits
20588 partially on the line, we need to set row->x to a
20589 negative offset, so that the leftmost glyph is
20590 the one that is partially visible. But if we are
20591 going to produce the truncation glyph, this will
20592 be taken care of in produce_special_glyphs. */
20593 if (row
->reversed_p
20594 && new_x
> it
->last_visible_x
20595 && !(it
->line_wrap
== TRUNCATE
20596 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20598 eassert (FRAME_WINDOW_P (it
->f
));
20599 row
->x
= it
->last_visible_x
- new_x
;
20604 /* Glyph is completely off the left margin of the
20605 window. This should not happen because of the
20606 move_it_in_display_line at the start of this
20607 function, unless the text display area of the
20608 window is empty. */
20609 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20612 /* Even if this display element produced no glyphs at all,
20613 we want to record its position. */
20614 if (it
->bidi_p
&& nglyphs
== 0)
20615 RECORD_MAX_MIN_POS (it
);
20617 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20618 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20619 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20620 row
->phys_height
= max (row
->phys_height
,
20621 it
->max_phys_ascent
+ it
->max_phys_descent
);
20622 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20623 it
->max_extra_line_spacing
);
20625 /* End of this display line if row is continued. */
20626 if (row
->continued_p
|| row
->ends_at_zv_p
)
20631 /* Is this a line end? If yes, we're also done, after making
20632 sure that a non-default face is extended up to the right
20633 margin of the window. */
20634 if (ITERATOR_AT_END_OF_LINE_P (it
))
20636 int used_before
= row
->used
[TEXT_AREA
];
20638 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20640 /* Add a space at the end of the line that is used to
20641 display the cursor there. */
20642 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20643 append_space_for_newline (it
, false);
20645 /* Extend the face to the end of the line. */
20646 extend_face_to_end_of_line (it
);
20648 /* Make sure we have the position. */
20649 if (used_before
== 0)
20650 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20652 /* Record the position of the newline, for use in
20654 it
->eol_pos
= it
->current
.pos
;
20656 /* Consume the line end. This skips over invisible lines. */
20657 set_iterator_to_next (it
, true);
20658 it
->continuation_lines_width
= 0;
20662 /* Proceed with next display element. Note that this skips
20663 over lines invisible because of selective display. */
20664 set_iterator_to_next (it
, true);
20666 /* If we truncate lines, we are done when the last displayed
20667 glyphs reach past the right margin of the window. */
20668 if (it
->line_wrap
== TRUNCATE
20669 && ((FRAME_WINDOW_P (it
->f
)
20670 /* Images are preprocessed in produce_image_glyph such
20671 that they are cropped at the right edge of the
20672 window, so an image glyph will always end exactly at
20673 last_visible_x, even if there's no right fringe. */
20674 && ((row
->reversed_p
20675 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20676 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20677 || it
->what
== IT_IMAGE
))
20678 ? (it
->current_x
>= it
->last_visible_x
)
20679 : (it
->current_x
> it
->last_visible_x
)))
20681 /* Maybe add truncation glyphs. */
20682 if (!FRAME_WINDOW_P (it
->f
)
20683 || (row
->reversed_p
20684 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20685 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20689 if (!row
->reversed_p
)
20691 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20692 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20697 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20698 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20700 /* Remove any padding glyphs at the front of ROW, to
20701 make room for the truncation glyphs we will be
20702 adding below. The loop below always inserts at
20703 least one truncation glyph, so also remove the
20704 last glyph added to ROW. */
20705 unproduce_glyphs (it
, i
+ 1);
20706 /* Adjust i for the loop below. */
20707 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20710 /* produce_special_glyphs overwrites the last glyph, so
20711 we don't want that if we want to keep that last
20712 glyph, which means it's an image. */
20713 if (it
->current_x
> it
->last_visible_x
)
20715 it
->current_x
= x_before
;
20716 if (!FRAME_WINDOW_P (it
->f
))
20718 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20720 row
->used
[TEXT_AREA
] = i
;
20721 produce_special_glyphs (it
, IT_TRUNCATION
);
20726 row
->used
[TEXT_AREA
] = i
;
20727 produce_special_glyphs (it
, IT_TRUNCATION
);
20729 it
->hpos
= hpos_before
;
20732 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20734 /* Don't truncate if we can overflow newline into fringe. */
20735 if (!get_next_display_element (it
))
20737 it
->continuation_lines_width
= 0;
20738 row
->ends_at_zv_p
= true;
20739 row
->exact_window_width_line_p
= true;
20742 if (ITERATOR_AT_END_OF_LINE_P (it
))
20744 row
->exact_window_width_line_p
= true;
20745 goto at_end_of_line
;
20747 it
->current_x
= x_before
;
20748 it
->hpos
= hpos_before
;
20751 row
->truncated_on_right_p
= true;
20752 it
->continuation_lines_width
= 0;
20753 reseat_at_next_visible_line_start (it
, false);
20754 /* We insist below that IT's position be at ZV because in
20755 bidi-reordered lines the character at visible line start
20756 might not be the character that follows the newline in
20757 the logical order. */
20758 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20759 row
->ends_at_zv_p
=
20760 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20762 row
->ends_at_zv_p
= false;
20768 bidi_unshelve_cache (wrap_data
, true);
20770 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20771 at the left window margin. */
20772 if (it
->first_visible_x
20773 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20775 if (!FRAME_WINDOW_P (it
->f
)
20776 || (((row
->reversed_p
20777 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20778 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20779 /* Don't let insert_left_trunc_glyphs overwrite the
20780 first glyph of the row if it is an image. */
20781 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20782 insert_left_trunc_glyphs (it
);
20783 row
->truncated_on_left_p
= true;
20786 /* Remember the position at which this line ends.
20788 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20789 cannot be before the call to find_row_edges below, since that is
20790 where these positions are determined. */
20791 row
->end
= it
->current
;
20794 row
->minpos
= row
->start
.pos
;
20795 row
->maxpos
= row
->end
.pos
;
20799 /* ROW->minpos and ROW->maxpos must be the smallest and
20800 `1 + the largest' buffer positions in ROW. But if ROW was
20801 bidi-reordered, these two positions can be anywhere in the
20802 row, so we must determine them now. */
20803 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20806 /* If the start of this line is the overlay arrow-position, then
20807 mark this glyph row as the one containing the overlay arrow.
20808 This is clearly a mess with variable size fonts. It would be
20809 better to let it be displayed like cursors under X. */
20810 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20811 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20812 !NILP (overlay_arrow_string
)))
20814 /* Overlay arrow in window redisplay is a fringe bitmap. */
20815 if (STRINGP (overlay_arrow_string
))
20817 struct glyph_row
*arrow_row
20818 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20819 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20820 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20821 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20822 struct glyph
*p2
, *end
;
20824 /* Copy the arrow glyphs. */
20825 while (glyph
< arrow_end
)
20828 /* Throw away padding glyphs. */
20830 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20831 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20837 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20842 eassert (INTEGERP (overlay_arrow_string
));
20843 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20845 overlay_arrow_seen
= true;
20848 /* Highlight trailing whitespace. */
20849 if (!NILP (Vshow_trailing_whitespace
))
20850 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20852 /* Compute pixel dimensions of this line. */
20853 compute_line_metrics (it
);
20855 /* Implementation note: No changes in the glyphs of ROW or in their
20856 faces can be done past this point, because compute_line_metrics
20857 computes ROW's hash value and stores it within the glyph_row
20860 /* Record whether this row ends inside an ellipsis. */
20861 row
->ends_in_ellipsis_p
20862 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20863 && it
->ellipsis_p
);
20865 /* Save fringe bitmaps in this row. */
20866 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20867 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20868 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20869 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20871 it
->left_user_fringe_bitmap
= 0;
20872 it
->left_user_fringe_face_id
= 0;
20873 it
->right_user_fringe_bitmap
= 0;
20874 it
->right_user_fringe_face_id
= 0;
20876 /* Maybe set the cursor. */
20877 cvpos
= it
->w
->cursor
.vpos
;
20879 /* In bidi-reordered rows, keep checking for proper cursor
20880 position even if one has been found already, because buffer
20881 positions in such rows change non-linearly with ROW->VPOS,
20882 when a line is continued. One exception: when we are at ZV,
20883 display cursor on the first suitable glyph row, since all
20884 the empty rows after that also have their position set to ZV. */
20885 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20886 lines' rows is implemented for bidi-reordered rows. */
20888 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20889 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20890 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20891 && cursor_row_p (row
))
20892 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20894 /* Prepare for the next line. This line starts horizontally at (X
20895 HPOS) = (0 0). Vertical positions are incremented. As a
20896 convenience for the caller, IT->glyph_row is set to the next
20898 it
->current_x
= it
->hpos
= 0;
20899 it
->current_y
+= row
->height
;
20900 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20903 /* The next row should by default use the same value of the
20904 reversed_p flag as this one. set_iterator_to_next decides when
20905 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20906 the flag accordingly. */
20907 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20908 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20909 it
->start
= row
->end
;
20910 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20912 #undef RECORD_MAX_MIN_POS
20915 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20916 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20917 doc
: /* Return paragraph direction at point in BUFFER.
20918 Value is either `left-to-right' or `right-to-left'.
20919 If BUFFER is omitted or nil, it defaults to the current buffer.
20921 Paragraph direction determines how the text in the paragraph is displayed.
20922 In left-to-right paragraphs, text begins at the left margin of the window
20923 and the reading direction is generally left to right. In right-to-left
20924 paragraphs, text begins at the right margin and is read from right to left.
20926 See also `bidi-paragraph-direction'. */)
20927 (Lisp_Object buffer
)
20929 struct buffer
*buf
= current_buffer
;
20930 struct buffer
*old
= buf
;
20932 if (! NILP (buffer
))
20934 CHECK_BUFFER (buffer
);
20935 buf
= XBUFFER (buffer
);
20938 if (NILP (BVAR (buf
, bidi_display_reordering
))
20939 || NILP (BVAR (buf
, enable_multibyte_characters
))
20940 /* When we are loading loadup.el, the character property tables
20941 needed for bidi iteration are not yet available. */
20942 || !NILP (Vpurify_flag
))
20943 return Qleft_to_right
;
20944 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20945 return BVAR (buf
, bidi_paragraph_direction
);
20948 /* Determine the direction from buffer text. We could try to
20949 use current_matrix if it is up to date, but this seems fast
20950 enough as it is. */
20951 struct bidi_it itb
;
20952 ptrdiff_t pos
= BUF_PT (buf
);
20953 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20955 void *itb_data
= bidi_shelve_cache ();
20957 set_buffer_temp (buf
);
20958 /* bidi_paragraph_init finds the base direction of the paragraph
20959 by searching forward from paragraph start. We need the base
20960 direction of the current or _previous_ paragraph, so we need
20961 to make sure we are within that paragraph. To that end, find
20962 the previous non-empty line. */
20963 if (pos
>= ZV
&& pos
> BEGV
)
20964 DEC_BOTH (pos
, bytepos
);
20965 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20966 if (fast_looking_at (trailing_white_space
,
20967 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20969 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20970 || c
== ' ' || c
== '\t' || c
== '\f')
20972 if (bytepos
<= BEGV_BYTE
)
20977 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20980 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20981 itb
.paragraph_dir
= NEUTRAL_DIR
;
20982 itb
.string
.s
= NULL
;
20983 itb
.string
.lstring
= Qnil
;
20984 itb
.string
.bufpos
= 0;
20985 itb
.string
.from_disp_str
= false;
20986 itb
.string
.unibyte
= false;
20987 /* We have no window to use here for ignoring window-specific
20988 overlays. Using NULL for window pointer will cause
20989 compute_display_string_pos to use the current buffer. */
20991 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
20992 bidi_unshelve_cache (itb_data
, false);
20993 set_buffer_temp (old
);
20994 switch (itb
.paragraph_dir
)
20997 return Qleft_to_right
;
21000 return Qright_to_left
;
21008 DEFUN ("bidi-find-overridden-directionality",
21009 Fbidi_find_overridden_directionality
,
21010 Sbidi_find_overridden_directionality
, 2, 3, 0,
21011 doc
: /* Return position between FROM and TO where directionality was overridden.
21013 This function returns the first character position in the specified
21014 region of OBJECT where there is a character whose `bidi-class' property
21015 is `L', but which was forced to display as `R' by a directional
21016 override, and likewise with characters whose `bidi-class' is `R'
21017 or `AL' that were forced to display as `L'.
21019 If no such character is found, the function returns nil.
21021 OBJECT is a Lisp string or buffer to search for overridden
21022 directionality, and defaults to the current buffer if nil or omitted.
21023 OBJECT can also be a window, in which case the function will search
21024 the buffer displayed in that window. Passing the window instead of
21025 a buffer is preferable when the buffer is displayed in some window,
21026 because this function will then be able to correctly account for
21027 window-specific overlays, which can affect the results.
21029 Strong directional characters `L', `R', and `AL' can have their
21030 intrinsic directionality overridden by directional override
21031 control characters RLO \(u+202e) and LRO \(u+202d). See the
21032 function `get-char-code-property' for a way to inquire about
21033 the `bidi-class' property of a character. */)
21034 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21036 struct buffer
*buf
= current_buffer
;
21037 struct buffer
*old
= buf
;
21038 struct window
*w
= NULL
;
21039 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21040 struct bidi_it itb
;
21041 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21044 if (!NILP (object
))
21046 if (BUFFERP (object
))
21047 buf
= XBUFFER (object
);
21048 else if (WINDOWP (object
))
21050 w
= decode_live_window (object
);
21051 buf
= XBUFFER (w
->contents
);
21052 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21055 CHECK_STRING (object
);
21058 if (STRINGP (object
))
21060 /* Characters in unibyte strings are always treated by bidi.c as
21062 if (!STRING_MULTIBYTE (object
)
21063 /* When we are loading loadup.el, the character property
21064 tables needed for bidi iteration are not yet
21066 || !NILP (Vpurify_flag
))
21069 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21070 if (from_pos
>= SCHARS (object
))
21073 /* Set up the bidi iterator. */
21074 itb_data
= bidi_shelve_cache ();
21075 itb
.paragraph_dir
= NEUTRAL_DIR
;
21076 itb
.string
.lstring
= object
;
21077 itb
.string
.s
= NULL
;
21078 itb
.string
.schars
= SCHARS (object
);
21079 itb
.string
.bufpos
= 0;
21080 itb
.string
.from_disp_str
= false;
21081 itb
.string
.unibyte
= false;
21083 bidi_init_it (0, 0, frame_window_p
, &itb
);
21087 /* Nothing this fancy can happen in unibyte buffers, or in a
21088 buffer that disabled reordering, or if FROM is at EOB. */
21089 if (NILP (BVAR (buf
, bidi_display_reordering
))
21090 || NILP (BVAR (buf
, enable_multibyte_characters
))
21091 /* When we are loading loadup.el, the character property
21092 tables needed for bidi iteration are not yet
21094 || !NILP (Vpurify_flag
))
21097 set_buffer_temp (buf
);
21098 validate_region (&from
, &to
);
21099 from_pos
= XINT (from
);
21100 to_pos
= XINT (to
);
21101 if (from_pos
>= ZV
)
21104 /* Set up the bidi iterator. */
21105 itb_data
= bidi_shelve_cache ();
21106 from_bpos
= CHAR_TO_BYTE (from_pos
);
21107 if (from_pos
== BEGV
)
21109 itb
.charpos
= BEGV
;
21110 itb
.bytepos
= BEGV_BYTE
;
21112 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21114 itb
.charpos
= from_pos
;
21115 itb
.bytepos
= from_bpos
;
21118 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21120 itb
.paragraph_dir
= NEUTRAL_DIR
;
21121 itb
.string
.s
= NULL
;
21122 itb
.string
.lstring
= Qnil
;
21123 itb
.string
.bufpos
= 0;
21124 itb
.string
.from_disp_str
= false;
21125 itb
.string
.unibyte
= false;
21127 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21132 /* For the purposes of this function, the actual base direction of
21133 the paragraph doesn't matter, so just set it to L2R. */
21134 bidi_paragraph_init (L2R
, &itb
, false);
21135 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21137 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21139 bidi_unshelve_cache (itb_data
, false);
21140 set_buffer_temp (old
);
21142 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21145 DEFUN ("move-point-visually", Fmove_point_visually
,
21146 Smove_point_visually
, 1, 1, 0,
21147 doc
: /* Move point in the visual order in the specified DIRECTION.
21148 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21151 Value is the new character position of point. */)
21152 (Lisp_Object direction
)
21154 struct window
*w
= XWINDOW (selected_window
);
21155 struct buffer
*b
= XBUFFER (w
->contents
);
21156 struct glyph_row
*row
;
21158 Lisp_Object paragraph_dir
;
21160 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21161 (!(ROW)->continued_p \
21162 && NILP ((GLYPH)->object) \
21163 && (GLYPH)->type == CHAR_GLYPH \
21164 && (GLYPH)->u.ch == ' ' \
21165 && (GLYPH)->charpos >= 0 \
21166 && !(GLYPH)->avoid_cursor_p)
21168 CHECK_NUMBER (direction
);
21169 dir
= XINT (direction
);
21175 /* If current matrix is up-to-date, we can use the information
21176 recorded in the glyphs, at least as long as the goal is on the
21178 if (w
->window_end_valid
21179 && !windows_or_buffers_changed
21181 && !b
->clip_changed
21182 && !b
->prevent_redisplay_optimizations_p
21183 && !window_outdated (w
)
21184 /* We rely below on the cursor coordinates to be up to date, but
21185 we cannot trust them if some command moved point since the
21186 last complete redisplay. */
21187 && w
->last_point
== BUF_PT (b
)
21188 && w
->cursor
.vpos
>= 0
21189 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21190 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21192 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21193 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21194 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21196 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21198 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21200 SET_PT (g
->charpos
);
21201 w
->cursor
.vpos
= -1;
21202 return make_number (PT
);
21204 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21208 if (BUFFERP (gpt
->object
))
21211 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21212 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21214 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21216 else if (BUFFERP (g
->object
))
21217 new_pos
= g
->charpos
;
21221 w
->cursor
.vpos
= -1;
21222 return make_number (PT
);
21224 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21226 /* Glyphs inserted at the end of a non-empty line for
21227 positioning the cursor have zero charpos, so we must
21228 deduce the value of point by other means. */
21229 if (g
->charpos
> 0)
21230 SET_PT (g
->charpos
);
21231 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21233 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21234 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21237 w
->cursor
.vpos
= -1;
21238 return make_number (PT
);
21241 if (g
== e
|| NILP (g
->object
))
21243 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21244 goto simulate_display
;
21245 if (!row
->reversed_p
)
21249 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21250 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21251 goto simulate_display
;
21255 if (row
->reversed_p
&& !row
->continued_p
)
21257 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21258 w
->cursor
.vpos
= -1;
21259 return make_number (PT
);
21261 g
= row
->glyphs
[TEXT_AREA
];
21262 e
= g
+ row
->used
[TEXT_AREA
];
21263 for ( ; g
< e
; g
++)
21265 if (BUFFERP (g
->object
)
21266 /* Empty lines have only one glyph, which stands
21267 for the newline, and whose charpos is the
21268 buffer position of the newline. */
21269 || ROW_GLYPH_NEWLINE_P (row
, g
)
21270 /* When the buffer ends in a newline, the line at
21271 EOB also has one glyph, but its charpos is -1. */
21272 || (row
->ends_at_zv_p
21273 && !row
->reversed_p
21274 && NILP (g
->object
)
21275 && g
->type
== CHAR_GLYPH
21276 && g
->u
.ch
== ' '))
21278 if (g
->charpos
> 0)
21279 SET_PT (g
->charpos
);
21280 else if (!row
->reversed_p
21281 && row
->ends_at_zv_p
21286 w
->cursor
.vpos
= -1;
21287 return make_number (PT
);
21293 if (!row
->reversed_p
&& !row
->continued_p
)
21295 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21296 w
->cursor
.vpos
= -1;
21297 return make_number (PT
);
21299 e
= row
->glyphs
[TEXT_AREA
];
21300 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21301 for ( ; g
>= e
; g
--)
21303 if (BUFFERP (g
->object
)
21304 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21306 /* Empty R2L lines on GUI frames have the buffer
21307 position of the newline stored in the stretch
21309 || g
->type
== STRETCH_GLYPH
21310 || (row
->ends_at_zv_p
21312 && NILP (g
->object
)
21313 && g
->type
== CHAR_GLYPH
21314 && g
->u
.ch
== ' '))
21316 if (g
->charpos
> 0)
21317 SET_PT (g
->charpos
);
21318 else if (row
->reversed_p
21319 && row
->ends_at_zv_p
21324 w
->cursor
.vpos
= -1;
21325 return make_number (PT
);
21334 /* If we wind up here, we failed to move by using the glyphs, so we
21335 need to simulate display instead. */
21338 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21340 paragraph_dir
= Qleft_to_right
;
21341 if (EQ (paragraph_dir
, Qright_to_left
))
21343 if (PT
<= BEGV
&& dir
< 0)
21344 xsignal0 (Qbeginning_of_buffer
);
21345 else if (PT
>= ZV
&& dir
> 0)
21346 xsignal0 (Qend_of_buffer
);
21349 struct text_pos pt
;
21351 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21353 bool overshoot_expected
= false;
21354 bool target_is_eol_p
= false;
21356 /* Setup the arena. */
21357 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21358 start_display (&it
, w
, pt
);
21359 /* When lines are truncated, we could be called with point
21360 outside of the windows edges, in which case move_it_*
21361 functions either prematurely stop at window's edge or jump to
21362 the next screen line, whereas we rely below on our ability to
21363 reach point, in order to start from its X coordinate. So we
21364 need to disregard the window's horizontal extent in that case. */
21365 if (it
.line_wrap
== TRUNCATE
)
21366 it
.last_visible_x
= INFINITY
;
21368 if (it
.cmp_it
.id
< 0
21369 && it
.method
== GET_FROM_STRING
21370 && it
.area
== TEXT_AREA
21371 && it
.string_from_display_prop_p
21372 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21373 overshoot_expected
= true;
21375 /* Find the X coordinate of point. We start from the beginning
21376 of this or previous line to make sure we are before point in
21377 the logical order (since the move_it_* functions can only
21380 reseat_at_previous_visible_line_start (&it
);
21381 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21382 if (IT_CHARPOS (it
) != PT
)
21384 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21385 -1, -1, -1, MOVE_TO_POS
);
21386 /* If we missed point because the character there is
21387 displayed out of a display vector that has more than one
21388 glyph, retry expecting overshoot. */
21389 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21390 && it
.current
.dpvec_index
> 0
21391 && !overshoot_expected
)
21393 overshoot_expected
= true;
21396 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21397 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21399 pt_x
= it
.current_x
;
21401 if (dir
> 0 || overshoot_expected
)
21403 struct glyph_row
*row
= it
.glyph_row
;
21405 /* When point is at beginning of line, we don't have
21406 information about the glyph there loaded into struct
21407 it. Calling get_next_display_element fixes that. */
21409 get_next_display_element (&it
);
21410 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21411 it
.glyph_row
= NULL
;
21412 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21413 it
.glyph_row
= row
;
21414 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21415 it, lest it will become out of sync with it's buffer
21417 it
.current_x
= pt_x
;
21420 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21421 pixel_width
= it
.pixel_width
;
21422 if (overshoot_expected
&& at_eol_p
)
21424 else if (pixel_width
<= 0)
21427 /* If there's a display string (or something similar) at point,
21428 we are actually at the glyph to the left of point, so we need
21429 to correct the X coordinate. */
21430 if (overshoot_expected
)
21433 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21435 pt_x
+= pixel_width
;
21438 /* Compute target X coordinate, either to the left or to the
21439 right of point. On TTY frames, all characters have the same
21440 pixel width of 1, so we can use that. On GUI frames we don't
21441 have an easy way of getting at the pixel width of the
21442 character to the left of point, so we use a different method
21443 of getting to that place. */
21445 target_x
= pt_x
+ pixel_width
;
21447 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21449 /* Target X coordinate could be one line above or below the line
21450 of point, in which case we need to adjust the target X
21451 coordinate. Also, if moving to the left, we need to begin at
21452 the left edge of the point's screen line. */
21457 start_display (&it
, w
, pt
);
21458 if (it
.line_wrap
== TRUNCATE
)
21459 it
.last_visible_x
= INFINITY
;
21460 reseat_at_previous_visible_line_start (&it
);
21461 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21463 move_it_by_lines (&it
, pt_vpos
);
21467 move_it_by_lines (&it
, -1);
21468 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21469 target_is_eol_p
= true;
21470 /* Under word-wrap, we don't know the x coordinate of
21471 the last character displayed on the previous line,
21472 which immediately precedes the wrap point. To find
21473 out its x coordinate, we try moving to the right
21474 margin of the window, which will stop at the wrap
21475 point, and then reset target_x to point at the
21476 character that precedes the wrap point. This is not
21477 needed on GUI frames, because (see below) there we
21478 move from the left margin one grapheme cluster at a
21479 time, and stop when we hit the wrap point. */
21480 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21482 void *it_data
= NULL
;
21485 SAVE_IT (it2
, it
, it_data
);
21486 move_it_in_display_line_to (&it
, ZV
, target_x
,
21487 MOVE_TO_POS
| MOVE_TO_X
);
21488 /* If we arrived at target_x, that _is_ the last
21489 character on the previous line. */
21490 if (it
.current_x
!= target_x
)
21491 target_x
= it
.current_x
- 1;
21492 RESTORE_IT (&it
, &it2
, it_data
);
21499 || (target_x
>= it
.last_visible_x
21500 && it
.line_wrap
!= TRUNCATE
))
21503 move_it_by_lines (&it
, 0);
21504 move_it_by_lines (&it
, 1);
21509 /* Move to the target X coordinate. */
21510 #ifdef HAVE_WINDOW_SYSTEM
21511 /* On GUI frames, as we don't know the X coordinate of the
21512 character to the left of point, moving point to the left
21513 requires walking, one grapheme cluster at a time, until we
21514 find ourself at a place immediately to the left of the
21515 character at point. */
21516 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21518 struct text_pos new_pos
;
21519 enum move_it_result rc
= MOVE_X_REACHED
;
21521 if (it
.current_x
== 0)
21522 get_next_display_element (&it
);
21523 if (it
.what
== IT_COMPOSITION
)
21525 new_pos
.charpos
= it
.cmp_it
.charpos
;
21526 new_pos
.bytepos
= -1;
21529 new_pos
= it
.current
.pos
;
21531 while (it
.current_x
+ it
.pixel_width
<= target_x
21532 && (rc
== MOVE_X_REACHED
21533 /* Under word-wrap, move_it_in_display_line_to
21534 stops at correct coordinates, but sometimes
21535 returns MOVE_POS_MATCH_OR_ZV. */
21536 || (it
.line_wrap
== WORD_WRAP
21537 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21539 int new_x
= it
.current_x
+ it
.pixel_width
;
21541 /* For composed characters, we want the position of the
21542 first character in the grapheme cluster (usually, the
21543 composition's base character), whereas it.current
21544 might give us the position of the _last_ one, e.g. if
21545 the composition is rendered in reverse due to bidi
21547 if (it
.what
== IT_COMPOSITION
)
21549 new_pos
.charpos
= it
.cmp_it
.charpos
;
21550 new_pos
.bytepos
= -1;
21553 new_pos
= it
.current
.pos
;
21554 if (new_x
== it
.current_x
)
21556 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21557 MOVE_TO_POS
| MOVE_TO_X
);
21558 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21561 /* The previous position we saw in the loop is the one we
21563 if (new_pos
.bytepos
== -1)
21564 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21565 it
.current
.pos
= new_pos
;
21569 if (it
.current_x
!= target_x
)
21570 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21572 /* If we ended up in a display string that covers point, move to
21573 buffer position to the right in the visual order. */
21576 while (IT_CHARPOS (it
) == PT
)
21578 set_iterator_to_next (&it
, false);
21579 if (!get_next_display_element (&it
))
21584 /* Move point to that position. */
21585 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21588 return make_number (PT
);
21590 #undef ROW_GLYPH_NEWLINE_P
21593 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21594 Sbidi_resolved_levels
, 0, 1, 0,
21595 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21597 The resolved levels are produced by the Emacs bidi reordering engine
21598 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21599 read the Unicode Standard Annex 9 (UAX#9) for background information
21600 about these levels.
21602 VPOS is the zero-based number of the current window's screen line
21603 for which to produce the resolved levels. If VPOS is nil or omitted,
21604 it defaults to the screen line of point. If the window displays a
21605 header line, VPOS of zero will report on the header line, and first
21606 line of text in the window will have VPOS of 1.
21608 Value is an array of resolved levels, indexed by glyph number.
21609 Glyphs are numbered from zero starting from the beginning of the
21610 screen line, i.e. the left edge of the window for left-to-right lines
21611 and from the right edge for right-to-left lines. The resolved levels
21612 are produced only for the window's text area; text in display margins
21615 If the selected window's display is not up-to-date, or if the specified
21616 screen line does not display text, this function returns nil. It is
21617 highly recommended to bind this function to some simple key, like F8,
21618 in order to avoid these problems.
21620 This function exists mainly for testing the correctness of the
21621 Emacs UBA implementation, in particular with the test suite. */)
21624 struct window
*w
= XWINDOW (selected_window
);
21625 struct buffer
*b
= XBUFFER (w
->contents
);
21627 struct glyph_row
*row
;
21631 int d1
, d2
, d3
, d4
, d5
;
21633 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21637 CHECK_NUMBER_COERCE_MARKER (vpos
);
21638 nrow
= XINT (vpos
);
21641 /* We require up-to-date glyph matrix for this window. */
21642 if (w
->window_end_valid
21643 && !windows_or_buffers_changed
21645 && !b
->clip_changed
21646 && !b
->prevent_redisplay_optimizations_p
21647 && !window_outdated (w
)
21649 && nrow
< w
->current_matrix
->nrows
21650 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21651 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21653 struct glyph
*g
, *e
, *g1
;
21655 Lisp_Object levels
;
21657 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21659 g
= g1
= row
->glyphs
[TEXT_AREA
];
21660 e
= g
+ row
->used
[TEXT_AREA
];
21662 /* Skip over glyphs at the start of the row that was
21663 generated by redisplay for its own needs. */
21665 && NILP (g
->object
)
21670 /* Count the "interesting" glyphs in this row. */
21671 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21674 /* Create and fill the array. */
21675 levels
= make_uninit_vector (nglyphs
);
21676 for (i
= 0; g1
< g
; i
++, g1
++)
21677 ASET (levels
, i
, make_number (g1
->resolved_level
));
21679 else /* Right-to-left glyph row. */
21681 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21682 e
= row
->glyphs
[TEXT_AREA
] - 1;
21684 && NILP (g
->object
)
21688 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21690 levels
= make_uninit_vector (nglyphs
);
21691 for (i
= 0; g1
> g
; i
++, g1
--)
21692 ASET (levels
, i
, make_number (g1
->resolved_level
));
21702 /***********************************************************************
21704 ***********************************************************************/
21706 /* Redisplay the menu bar in the frame for window W.
21708 The menu bar of X frames that don't have X toolkit support is
21709 displayed in a special window W->frame->menu_bar_window.
21711 The menu bar of terminal frames is treated specially as far as
21712 glyph matrices are concerned. Menu bar lines are not part of
21713 windows, so the update is done directly on the frame matrix rows
21714 for the menu bar. */
21717 display_menu_bar (struct window
*w
)
21719 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21724 /* Don't do all this for graphical frames. */
21726 if (FRAME_W32_P (f
))
21729 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21735 if (FRAME_NS_P (f
))
21737 #endif /* HAVE_NS */
21739 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21740 eassert (!FRAME_WINDOW_P (f
));
21741 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21742 it
.first_visible_x
= 0;
21743 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21744 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21745 if (FRAME_WINDOW_P (f
))
21747 /* Menu bar lines are displayed in the desired matrix of the
21748 dummy window menu_bar_window. */
21749 struct window
*menu_w
;
21750 menu_w
= XWINDOW (f
->menu_bar_window
);
21751 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21753 it
.first_visible_x
= 0;
21754 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21757 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21759 /* This is a TTY frame, i.e. character hpos/vpos are used as
21761 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21763 it
.first_visible_x
= 0;
21764 it
.last_visible_x
= FRAME_COLS (f
);
21767 /* FIXME: This should be controlled by a user option. See the
21768 comments in redisplay_tool_bar and display_mode_line about
21770 it
.paragraph_embedding
= L2R
;
21772 /* Clear all rows of the menu bar. */
21773 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21775 struct glyph_row
*row
= it
.glyph_row
+ i
;
21776 clear_glyph_row (row
);
21777 row
->enabled_p
= true;
21778 row
->full_width_p
= true;
21779 row
->reversed_p
= false;
21782 /* Display all items of the menu bar. */
21783 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21784 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21786 Lisp_Object string
;
21788 /* Stop at nil string. */
21789 string
= AREF (items
, i
+ 1);
21793 /* Remember where item was displayed. */
21794 ASET (items
, i
+ 3, make_number (it
.hpos
));
21796 /* Display the item, pad with one space. */
21797 if (it
.current_x
< it
.last_visible_x
)
21798 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21799 SCHARS (string
) + 1, 0, 0, -1);
21802 /* Fill out the line with spaces. */
21803 if (it
.current_x
< it
.last_visible_x
)
21804 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21806 /* Compute the total height of the lines. */
21807 compute_line_metrics (&it
);
21810 /* Deep copy of a glyph row, including the glyphs. */
21812 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21814 struct glyph
*pointers
[1 + LAST_AREA
];
21815 int to_used
= to
->used
[TEXT_AREA
];
21817 /* Save glyph pointers of TO. */
21818 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21820 /* Do a structure assignment. */
21823 /* Restore original glyph pointers of TO. */
21824 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21826 /* Copy the glyphs. */
21827 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21828 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21830 /* If we filled only part of the TO row, fill the rest with
21831 space_glyph (which will display as empty space). */
21832 if (to_used
> from
->used
[TEXT_AREA
])
21833 fill_up_frame_row_with_spaces (to
, to_used
);
21836 /* Display one menu item on a TTY, by overwriting the glyphs in the
21837 frame F's desired glyph matrix with glyphs produced from the menu
21838 item text. Called from term.c to display TTY drop-down menus one
21841 ITEM_TEXT is the menu item text as a C string.
21843 FACE_ID is the face ID to be used for this menu item. FACE_ID
21844 could specify one of 3 faces: a face for an enabled item, a face
21845 for a disabled item, or a face for a selected item.
21847 X and Y are coordinates of the first glyph in the frame's desired
21848 matrix to be overwritten by the menu item. Since this is a TTY, Y
21849 is the zero-based number of the glyph row and X is the zero-based
21850 glyph number in the row, starting from left, where to start
21851 displaying the item.
21853 SUBMENU means this menu item drops down a submenu, which
21854 should be indicated by displaying a proper visual cue after the
21858 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21859 int x
, int y
, bool submenu
)
21862 struct frame
*f
= SELECTED_FRAME ();
21863 struct window
*w
= XWINDOW (f
->selected_window
);
21864 struct glyph_row
*row
;
21865 size_t item_len
= strlen (item_text
);
21867 eassert (FRAME_TERMCAP_P (f
));
21869 /* Don't write beyond the matrix's last row. This can happen for
21870 TTY screens that are not high enough to show the entire menu.
21871 (This is actually a bit of defensive programming, as
21872 tty_menu_display already limits the number of menu items to one
21873 less than the number of screen lines.) */
21874 if (y
>= f
->desired_matrix
->nrows
)
21877 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21878 it
.first_visible_x
= 0;
21879 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21880 row
= it
.glyph_row
;
21881 /* Start with the row contents from the current matrix. */
21882 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21883 bool saved_width
= row
->full_width_p
;
21884 row
->full_width_p
= true;
21885 bool saved_reversed
= row
->reversed_p
;
21886 row
->reversed_p
= false;
21887 row
->enabled_p
= true;
21889 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21891 eassert (x
< f
->desired_matrix
->matrix_w
);
21892 it
.current_x
= it
.hpos
= x
;
21893 it
.current_y
= it
.vpos
= y
;
21894 int saved_used
= row
->used
[TEXT_AREA
];
21895 bool saved_truncated
= row
->truncated_on_right_p
;
21896 row
->used
[TEXT_AREA
] = x
;
21897 it
.face_id
= face_id
;
21898 it
.line_wrap
= TRUNCATE
;
21900 /* FIXME: This should be controlled by a user option. See the
21901 comments in redisplay_tool_bar and display_mode_line about this.
21902 Also, if paragraph_embedding could ever be R2L, changes will be
21903 needed to avoid shifting to the right the row characters in
21904 term.c:append_glyph. */
21905 it
.paragraph_embedding
= L2R
;
21907 /* Pad with a space on the left. */
21908 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21910 /* Display the menu item, pad with spaces to WIDTH. */
21913 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21914 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21916 /* Indicate with " >" that there's a submenu. */
21917 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21918 FRAME_COLS (f
) - 1, -1);
21921 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21922 width
, 0, FRAME_COLS (f
) - 1, -1);
21924 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21925 row
->truncated_on_right_p
= saved_truncated
;
21926 row
->hash
= row_hash (row
);
21927 row
->full_width_p
= saved_width
;
21928 row
->reversed_p
= saved_reversed
;
21931 /***********************************************************************
21933 ***********************************************************************/
21935 /* Redisplay mode lines in the window tree whose root is WINDOW.
21936 If FORCE, redisplay mode lines unconditionally.
21937 Otherwise, redisplay only mode lines that are garbaged. Value is
21938 the number of windows whose mode lines were redisplayed. */
21941 redisplay_mode_lines (Lisp_Object window
, bool force
)
21945 while (!NILP (window
))
21947 struct window
*w
= XWINDOW (window
);
21949 if (WINDOWP (w
->contents
))
21950 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21952 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21953 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21955 struct text_pos lpoint
;
21956 struct buffer
*old
= current_buffer
;
21958 /* Set the window's buffer for the mode line display. */
21959 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21960 set_buffer_internal_1 (XBUFFER (w
->contents
));
21962 /* Point refers normally to the selected window. For any
21963 other window, set up appropriate value. */
21964 if (!EQ (window
, selected_window
))
21966 struct text_pos pt
;
21968 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21969 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21972 /* Display mode lines. */
21973 clear_glyph_matrix (w
->desired_matrix
);
21974 if (display_mode_lines (w
))
21977 /* Restore old settings. */
21978 set_buffer_internal_1 (old
);
21979 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21989 /* Display the mode and/or header line of window W. Value is the
21990 sum number of mode lines and header lines displayed. */
21993 display_mode_lines (struct window
*w
)
21995 Lisp_Object old_selected_window
= selected_window
;
21996 Lisp_Object old_selected_frame
= selected_frame
;
21997 Lisp_Object new_frame
= w
->frame
;
21998 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22001 selected_frame
= new_frame
;
22002 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22003 or window's point, then we'd need select_window_1 here as well. */
22004 XSETWINDOW (selected_window
, w
);
22005 XFRAME (new_frame
)->selected_window
= selected_window
;
22007 /* These will be set while the mode line specs are processed. */
22008 line_number_displayed
= false;
22009 w
->column_number_displayed
= -1;
22011 if (WINDOW_WANTS_MODELINE_P (w
))
22013 struct window
*sel_w
= XWINDOW (old_selected_window
);
22015 /* Select mode line face based on the real selected window. */
22016 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22017 BVAR (current_buffer
, mode_line_format
));
22021 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22023 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22024 BVAR (current_buffer
, header_line_format
));
22028 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22029 selected_frame
= old_selected_frame
;
22030 selected_window
= old_selected_window
;
22032 w
->must_be_updated_p
= true;
22037 /* Display mode or header line of window W. FACE_ID specifies which
22038 line to display; it is either MODE_LINE_FACE_ID or
22039 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22040 display. Value is the pixel height of the mode/header line
22044 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22048 ptrdiff_t count
= SPECPDL_INDEX ();
22050 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22051 /* Don't extend on a previously drawn mode-line.
22052 This may happen if called from pos_visible_p. */
22053 it
.glyph_row
->enabled_p
= false;
22054 prepare_desired_row (w
, it
.glyph_row
, true);
22056 it
.glyph_row
->mode_line_p
= true;
22058 /* FIXME: This should be controlled by a user option. But
22059 supporting such an option is not trivial, since the mode line is
22060 made up of many separate strings. */
22061 it
.paragraph_embedding
= L2R
;
22063 record_unwind_protect (unwind_format_mode_line
,
22064 format_mode_line_unwind_data (NULL
, NULL
,
22067 mode_line_target
= MODE_LINE_DISPLAY
;
22069 /* Temporarily make frame's keyboard the current kboard so that
22070 kboard-local variables in the mode_line_format will get the right
22072 push_kboard (FRAME_KBOARD (it
.f
));
22073 record_unwind_save_match_data ();
22074 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22077 unbind_to (count
, Qnil
);
22079 /* Fill up with spaces. */
22080 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22082 compute_line_metrics (&it
);
22083 it
.glyph_row
->full_width_p
= true;
22084 it
.glyph_row
->continued_p
= false;
22085 it
.glyph_row
->truncated_on_left_p
= false;
22086 it
.glyph_row
->truncated_on_right_p
= false;
22088 /* Make a 3D mode-line have a shadow at its right end. */
22089 face
= FACE_FROM_ID (it
.f
, face_id
);
22090 extend_face_to_end_of_line (&it
);
22091 if (face
->box
!= FACE_NO_BOX
)
22093 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22094 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22095 last
->right_box_line_p
= true;
22098 return it
.glyph_row
->height
;
22101 /* Move element ELT in LIST to the front of LIST.
22102 Return the updated list. */
22105 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22107 register Lisp_Object tail
, prev
;
22108 register Lisp_Object tem
;
22112 while (CONSP (tail
))
22118 /* Splice out the link TAIL. */
22120 list
= XCDR (tail
);
22122 Fsetcdr (prev
, XCDR (tail
));
22124 /* Now make it the first. */
22125 Fsetcdr (tail
, list
);
22130 tail
= XCDR (tail
);
22134 /* Not found--return unchanged LIST. */
22138 /* Contribute ELT to the mode line for window IT->w. How it
22139 translates into text depends on its data type.
22141 IT describes the display environment in which we display, as usual.
22143 DEPTH is the depth in recursion. It is used to prevent
22144 infinite recursion here.
22146 FIELD_WIDTH is the number of characters the display of ELT should
22147 occupy in the mode line, and PRECISION is the maximum number of
22148 characters to display from ELT's representation. See
22149 display_string for details.
22151 Returns the hpos of the end of the text generated by ELT.
22153 PROPS is a property list to add to any string we encounter.
22155 If RISKY, remove (disregard) any properties in any string
22156 we encounter, and ignore :eval and :propertize.
22158 The global variable `mode_line_target' determines whether the
22159 output is passed to `store_mode_line_noprop',
22160 `store_mode_line_string', or `display_string'. */
22163 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22164 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22166 int n
= 0, field
, prec
;
22167 bool literal
= false;
22171 elt
= build_string ("*too-deep*");
22175 switch (XTYPE (elt
))
22179 /* A string: output it and check for %-constructs within it. */
22181 ptrdiff_t offset
= 0;
22183 if (SCHARS (elt
) > 0
22184 && (!NILP (props
) || risky
))
22186 Lisp_Object oprops
, aelt
;
22187 oprops
= Ftext_properties_at (make_number (0), elt
);
22189 /* If the starting string's properties are not what
22190 we want, translate the string. Also, if the string
22191 is risky, do that anyway. */
22193 if (NILP (Fequal (props
, oprops
)) || risky
)
22195 /* If the starting string has properties,
22196 merge the specified ones onto the existing ones. */
22197 if (! NILP (oprops
) && !risky
)
22201 oprops
= Fcopy_sequence (oprops
);
22203 while (CONSP (tem
))
22205 oprops
= Fplist_put (oprops
, XCAR (tem
),
22206 XCAR (XCDR (tem
)));
22207 tem
= XCDR (XCDR (tem
));
22212 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22213 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22215 /* AELT is what we want. Move it to the front
22216 without consing. */
22218 mode_line_proptrans_alist
22219 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22225 /* If AELT has the wrong props, it is useless.
22226 so get rid of it. */
22228 mode_line_proptrans_alist
22229 = Fdelq (aelt
, mode_line_proptrans_alist
);
22231 elt
= Fcopy_sequence (elt
);
22232 Fset_text_properties (make_number (0), Flength (elt
),
22234 /* Add this item to mode_line_proptrans_alist. */
22235 mode_line_proptrans_alist
22236 = Fcons (Fcons (elt
, props
),
22237 mode_line_proptrans_alist
);
22238 /* Truncate mode_line_proptrans_alist
22239 to at most 50 elements. */
22240 tem
= Fnthcdr (make_number (50),
22241 mode_line_proptrans_alist
);
22243 XSETCDR (tem
, Qnil
);
22252 prec
= precision
- n
;
22253 switch (mode_line_target
)
22255 case MODE_LINE_NOPROP
:
22256 case MODE_LINE_TITLE
:
22257 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22259 case MODE_LINE_STRING
:
22260 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22262 case MODE_LINE_DISPLAY
:
22263 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22264 0, prec
, 0, STRING_MULTIBYTE (elt
));
22271 /* Handle the non-literal case. */
22273 while ((precision
<= 0 || n
< precision
)
22274 && SREF (elt
, offset
) != 0
22275 && (mode_line_target
!= MODE_LINE_DISPLAY
22276 || it
->current_x
< it
->last_visible_x
))
22278 ptrdiff_t last_offset
= offset
;
22280 /* Advance to end of string or next format specifier. */
22281 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22284 if (offset
- 1 != last_offset
)
22286 ptrdiff_t nchars
, nbytes
;
22288 /* Output to end of string or up to '%'. Field width
22289 is length of string. Don't output more than
22290 PRECISION allows us. */
22293 prec
= c_string_width (SDATA (elt
) + last_offset
,
22294 offset
- last_offset
, precision
- n
,
22297 switch (mode_line_target
)
22299 case MODE_LINE_NOPROP
:
22300 case MODE_LINE_TITLE
:
22301 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22303 case MODE_LINE_STRING
:
22305 ptrdiff_t bytepos
= last_offset
;
22306 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22307 ptrdiff_t endpos
= (precision
<= 0
22308 ? string_byte_to_char (elt
, offset
)
22309 : charpos
+ nchars
);
22310 Lisp_Object mode_string
22311 = Fsubstring (elt
, make_number (charpos
),
22312 make_number (endpos
));
22313 n
+= store_mode_line_string (NULL
, mode_string
, false,
22317 case MODE_LINE_DISPLAY
:
22319 ptrdiff_t bytepos
= last_offset
;
22320 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22322 if (precision
<= 0)
22323 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22324 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22326 STRING_MULTIBYTE (elt
));
22331 else /* c == '%' */
22333 ptrdiff_t percent_position
= offset
;
22335 /* Get the specified minimum width. Zero means
22338 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22339 field
= field
* 10 + c
- '0';
22341 /* Don't pad beyond the total padding allowed. */
22342 if (field_width
- n
> 0 && field
> field_width
- n
)
22343 field
= field_width
- n
;
22345 /* Note that either PRECISION <= 0 or N < PRECISION. */
22346 prec
= precision
- n
;
22349 n
+= display_mode_element (it
, depth
, field
, prec
,
22350 Vglobal_mode_string
, props
,
22355 ptrdiff_t bytepos
, charpos
;
22357 Lisp_Object string
;
22359 bytepos
= percent_position
;
22360 charpos
= (STRING_MULTIBYTE (elt
)
22361 ? string_byte_to_char (elt
, bytepos
)
22363 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22364 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22366 switch (mode_line_target
)
22368 case MODE_LINE_NOPROP
:
22369 case MODE_LINE_TITLE
:
22370 n
+= store_mode_line_noprop (spec
, field
, prec
);
22372 case MODE_LINE_STRING
:
22374 Lisp_Object tem
= build_string (spec
);
22375 props
= Ftext_properties_at (make_number (charpos
), elt
);
22376 /* Should only keep face property in props */
22377 n
+= store_mode_line_string (NULL
, tem
, false,
22378 field
, prec
, props
);
22381 case MODE_LINE_DISPLAY
:
22383 int nglyphs_before
, nwritten
;
22385 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22386 nwritten
= display_string (spec
, string
, elt
,
22391 /* Assign to the glyphs written above the
22392 string where the `%x' came from, position
22396 struct glyph
*glyph
22397 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22401 for (i
= 0; i
< nwritten
; ++i
)
22403 glyph
[i
].object
= elt
;
22404 glyph
[i
].charpos
= charpos
;
22421 /* A symbol: process the value of the symbol recursively
22422 as if it appeared here directly. Avoid error if symbol void.
22423 Special case: if value of symbol is a string, output the string
22426 register Lisp_Object tem
;
22428 /* If the variable is not marked as risky to set
22429 then its contents are risky to use. */
22430 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22433 tem
= Fboundp (elt
);
22436 tem
= Fsymbol_value (elt
);
22437 /* If value is a string, output that string literally:
22438 don't check for % within it. */
22442 if (!EQ (tem
, elt
))
22444 /* Give up right away for nil or t. */
22454 register Lisp_Object car
, tem
;
22456 /* A cons cell: five distinct cases.
22457 If first element is :eval or :propertize, do something special.
22458 If first element is a string or a cons, process all the elements
22459 and effectively concatenate them.
22460 If first element is a negative number, truncate displaying cdr to
22461 at most that many characters. If positive, pad (with spaces)
22462 to at least that many characters.
22463 If first element is a symbol, process the cadr or caddr recursively
22464 according to whether the symbol's value is non-nil or nil. */
22466 if (EQ (car
, QCeval
))
22468 /* An element of the form (:eval FORM) means evaluate FORM
22469 and use the result as mode line elements. */
22474 if (CONSP (XCDR (elt
)))
22477 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22478 n
+= display_mode_element (it
, depth
, field_width
- n
,
22479 precision
- n
, spec
, props
,
22483 else if (EQ (car
, QCpropertize
))
22485 /* An element of the form (:propertize ELT PROPS...)
22486 means display ELT but applying properties PROPS. */
22491 if (CONSP (XCDR (elt
)))
22492 n
+= display_mode_element (it
, depth
, field_width
- n
,
22493 precision
- n
, XCAR (XCDR (elt
)),
22494 XCDR (XCDR (elt
)), risky
);
22496 else if (SYMBOLP (car
))
22498 tem
= Fboundp (car
);
22502 /* elt is now the cdr, and we know it is a cons cell.
22503 Use its car if CAR has a non-nil value. */
22506 tem
= Fsymbol_value (car
);
22513 /* Symbol's value is nil (or symbol is unbound)
22514 Get the cddr of the original list
22515 and if possible find the caddr and use that. */
22519 else if (!CONSP (elt
))
22524 else if (INTEGERP (car
))
22526 register int lim
= XINT (car
);
22530 /* Negative int means reduce maximum width. */
22531 if (precision
<= 0)
22534 precision
= min (precision
, -lim
);
22538 /* Padding specified. Don't let it be more than
22539 current maximum. */
22541 lim
= min (precision
, lim
);
22543 /* If that's more padding than already wanted, queue it.
22544 But don't reduce padding already specified even if
22545 that is beyond the current truncation point. */
22546 field_width
= max (lim
, field_width
);
22550 else if (STRINGP (car
) || CONSP (car
))
22552 Lisp_Object halftail
= elt
;
22556 && (precision
<= 0 || n
< precision
))
22558 n
+= display_mode_element (it
, depth
,
22559 /* Do padding only after the last
22560 element in the list. */
22561 (! CONSP (XCDR (elt
))
22564 precision
- n
, XCAR (elt
),
22568 if ((len
& 1) == 0)
22569 halftail
= XCDR (halftail
);
22570 /* Check for cycle. */
22571 if (EQ (halftail
, elt
))
22580 elt
= build_string ("*invalid*");
22584 /* Pad to FIELD_WIDTH. */
22585 if (field_width
> 0 && n
< field_width
)
22587 switch (mode_line_target
)
22589 case MODE_LINE_NOPROP
:
22590 case MODE_LINE_TITLE
:
22591 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22593 case MODE_LINE_STRING
:
22594 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22597 case MODE_LINE_DISPLAY
:
22598 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22607 /* Store a mode-line string element in mode_line_string_list.
22609 If STRING is non-null, display that C string. Otherwise, the Lisp
22610 string LISP_STRING is displayed.
22612 FIELD_WIDTH is the minimum number of output glyphs to produce.
22613 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22614 with spaces. FIELD_WIDTH <= 0 means don't pad.
22616 PRECISION is the maximum number of characters to output from
22617 STRING. PRECISION <= 0 means don't truncate the string.
22619 If COPY_STRING, make a copy of LISP_STRING before adding
22620 properties to the string.
22622 PROPS are the properties to add to the string.
22623 The mode_line_string_face face property is always added to the string.
22627 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22629 int field_width
, int precision
, Lisp_Object props
)
22634 if (string
!= NULL
)
22636 len
= strlen (string
);
22637 if (precision
> 0 && len
> precision
)
22639 lisp_string
= make_string (string
, len
);
22641 props
= mode_line_string_face_prop
;
22642 else if (!NILP (mode_line_string_face
))
22644 Lisp_Object face
= Fplist_get (props
, Qface
);
22645 props
= Fcopy_sequence (props
);
22647 face
= mode_line_string_face
;
22649 face
= list2 (face
, mode_line_string_face
);
22650 props
= Fplist_put (props
, Qface
, face
);
22652 Fadd_text_properties (make_number (0), make_number (len
),
22653 props
, lisp_string
);
22657 len
= XFASTINT (Flength (lisp_string
));
22658 if (precision
> 0 && len
> precision
)
22661 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22664 if (!NILP (mode_line_string_face
))
22668 props
= Ftext_properties_at (make_number (0), lisp_string
);
22669 face
= Fplist_get (props
, Qface
);
22671 face
= mode_line_string_face
;
22673 face
= list2 (face
, mode_line_string_face
);
22674 props
= list2 (Qface
, face
);
22676 lisp_string
= Fcopy_sequence (lisp_string
);
22679 Fadd_text_properties (make_number (0), make_number (len
),
22680 props
, lisp_string
);
22685 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22689 if (field_width
> len
)
22691 field_width
-= len
;
22692 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22694 Fadd_text_properties (make_number (0), make_number (field_width
),
22695 props
, lisp_string
);
22696 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22704 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22706 doc
: /* Format a string out of a mode line format specification.
22707 First arg FORMAT specifies the mode line format (see `mode-line-format'
22708 for details) to use.
22710 By default, the format is evaluated for the currently selected window.
22712 Optional second arg FACE specifies the face property to put on all
22713 characters for which no face is specified. The value nil means the
22714 default face. The value t means whatever face the window's mode line
22715 currently uses (either `mode-line' or `mode-line-inactive',
22716 depending on whether the window is the selected window or not).
22717 An integer value means the value string has no text
22720 Optional third and fourth args WINDOW and BUFFER specify the window
22721 and buffer to use as the context for the formatting (defaults
22722 are the selected window and the WINDOW's buffer). */)
22723 (Lisp_Object format
, Lisp_Object face
,
22724 Lisp_Object window
, Lisp_Object buffer
)
22729 struct buffer
*old_buffer
= NULL
;
22731 bool no_props
= INTEGERP (face
);
22732 ptrdiff_t count
= SPECPDL_INDEX ();
22734 int string_start
= 0;
22736 w
= decode_any_window (window
);
22737 XSETWINDOW (window
, w
);
22740 buffer
= w
->contents
;
22741 CHECK_BUFFER (buffer
);
22743 /* Make formatting the modeline a non-op when noninteractive, otherwise
22744 there will be problems later caused by a partially initialized frame. */
22745 if (NILP (format
) || noninteractive
)
22746 return empty_unibyte_string
;
22751 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22752 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22753 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22754 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22755 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22756 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22757 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22760 old_buffer
= current_buffer
;
22762 /* Save things including mode_line_proptrans_alist,
22763 and set that to nil so that we don't alter the outer value. */
22764 record_unwind_protect (unwind_format_mode_line
,
22765 format_mode_line_unwind_data
22766 (XFRAME (WINDOW_FRAME (w
)),
22767 old_buffer
, selected_window
, true));
22768 mode_line_proptrans_alist
= Qnil
;
22770 Fselect_window (window
, Qt
);
22771 set_buffer_internal_1 (XBUFFER (buffer
));
22773 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22777 mode_line_target
= MODE_LINE_NOPROP
;
22778 mode_line_string_face_prop
= Qnil
;
22779 mode_line_string_list
= Qnil
;
22780 string_start
= MODE_LINE_NOPROP_LEN (0);
22784 mode_line_target
= MODE_LINE_STRING
;
22785 mode_line_string_list
= Qnil
;
22786 mode_line_string_face
= face
;
22787 mode_line_string_face_prop
22788 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22791 push_kboard (FRAME_KBOARD (it
.f
));
22792 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22797 len
= MODE_LINE_NOPROP_LEN (string_start
);
22798 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22802 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22803 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22804 empty_unibyte_string
);
22807 unbind_to (count
, Qnil
);
22811 /* Write a null-terminated, right justified decimal representation of
22812 the positive integer D to BUF using a minimal field width WIDTH. */
22815 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22817 register char *p
= buf
;
22825 *p
++ = d
% 10 + '0';
22830 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22841 /* Write a null-terminated, right justified decimal and "human
22842 readable" representation of the nonnegative integer D to BUF using
22843 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22845 static const char power_letter
[] =
22859 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22861 /* We aim to represent the nonnegative integer D as
22862 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22863 ptrdiff_t quotient
= d
;
22865 /* -1 means: do not use TENTHS. */
22869 /* Length of QUOTIENT.TENTHS as a string. */
22875 if (quotient
>= 1000)
22877 /* Scale to the appropriate EXPONENT. */
22880 remainder
= quotient
% 1000;
22884 while (quotient
>= 1000);
22886 /* Round to nearest and decide whether to use TENTHS or not. */
22889 tenths
= remainder
/ 100;
22890 if (remainder
% 100 >= 50)
22897 if (quotient
== 10)
22905 if (remainder
>= 500)
22907 if (quotient
< 999)
22918 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22919 if (tenths
== -1 && quotient
<= 99)
22926 p
= psuffix
= buf
+ max (width
, length
);
22928 /* Print EXPONENT. */
22929 *psuffix
++ = power_letter
[exponent
];
22932 /* Print TENTHS. */
22935 *--p
= '0' + tenths
;
22939 /* Print QUOTIENT. */
22942 int digit
= quotient
% 10;
22943 *--p
= '0' + digit
;
22945 while ((quotient
/= 10) != 0);
22947 /* Print leading spaces. */
22952 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22953 If EOL_FLAG, set also a mnemonic character for end-of-line
22954 type of CODING_SYSTEM. Return updated pointer into BUF. */
22956 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22959 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
22962 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22963 const unsigned char *eol_str
;
22965 /* The EOL conversion we are using. */
22966 Lisp_Object eoltype
;
22968 val
= CODING_SYSTEM_SPEC (coding_system
);
22971 if (!VECTORP (val
)) /* Not yet decided. */
22973 *buf
++ = multibyte
? '-' : ' ';
22975 eoltype
= eol_mnemonic_undecided
;
22976 /* Don't mention EOL conversion if it isn't decided. */
22981 Lisp_Object eolvalue
;
22983 attrs
= AREF (val
, 0);
22984 eolvalue
= AREF (val
, 2);
22987 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22992 /* The EOL conversion that is normal on this system. */
22994 if (NILP (eolvalue
)) /* Not yet decided. */
22995 eoltype
= eol_mnemonic_undecided
;
22996 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22997 eoltype
= eol_mnemonic_undecided
;
22998 else /* eolvalue is Qunix, Qdos, or Qmac. */
22999 eoltype
= (EQ (eolvalue
, Qunix
)
23000 ? eol_mnemonic_unix
23001 : EQ (eolvalue
, Qdos
)
23002 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23008 /* Mention the EOL conversion if it is not the usual one. */
23009 if (STRINGP (eoltype
))
23011 eol_str
= SDATA (eoltype
);
23012 eol_str_len
= SBYTES (eoltype
);
23014 else if (CHARACTERP (eoltype
))
23016 int c
= XFASTINT (eoltype
);
23017 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23021 eol_str
= invalid_eol_type
;
23022 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23024 memcpy (buf
, eol_str
, eol_str_len
);
23025 buf
+= eol_str_len
;
23031 /* Return a string for the output of a mode line %-spec for window W,
23032 generated by character C. FIELD_WIDTH > 0 means pad the string
23033 returned with spaces to that value. Return a Lisp string in
23034 *STRING if the resulting string is taken from that Lisp string.
23036 Note we operate on the current buffer for most purposes. */
23038 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23040 static const char *
23041 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23042 Lisp_Object
*string
)
23045 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23046 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23047 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23048 produce strings from numerical values, so limit preposterously
23049 large values of FIELD_WIDTH to avoid overrunning the buffer's
23050 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23051 bytes plus the terminating null. */
23052 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23053 struct buffer
*b
= current_buffer
;
23061 if (!NILP (BVAR (b
, read_only
)))
23063 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23068 /* This differs from %* only for a modified read-only buffer. */
23069 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23071 if (!NILP (BVAR (b
, read_only
)))
23076 /* This differs from %* in ignoring read-only-ness. */
23077 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23089 if (command_loop_level
> 5)
23091 p
= decode_mode_spec_buf
;
23092 for (i
= 0; i
< command_loop_level
; i
++)
23095 return decode_mode_spec_buf
;
23103 if (command_loop_level
> 5)
23105 p
= decode_mode_spec_buf
;
23106 for (i
= 0; i
< command_loop_level
; i
++)
23109 return decode_mode_spec_buf
;
23116 /* Let lots_of_dashes be a string of infinite length. */
23117 if (mode_line_target
== MODE_LINE_NOPROP
23118 || mode_line_target
== MODE_LINE_STRING
)
23120 if (field_width
<= 0
23121 || field_width
> sizeof (lots_of_dashes
))
23123 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23124 decode_mode_spec_buf
[i
] = '-';
23125 decode_mode_spec_buf
[i
] = '\0';
23126 return decode_mode_spec_buf
;
23129 return lots_of_dashes
;
23133 obj
= BVAR (b
, name
);
23137 /* %c and %l are ignored in `frame-title-format'.
23138 (In redisplay_internal, the frame title is drawn _before_ the
23139 windows are updated, so the stuff which depends on actual
23140 window contents (such as %l) may fail to render properly, or
23141 even crash emacs.) */
23142 if (mode_line_target
== MODE_LINE_TITLE
)
23146 ptrdiff_t col
= current_column ();
23147 w
->column_number_displayed
= col
;
23148 pint2str (decode_mode_spec_buf
, width
, col
);
23149 return decode_mode_spec_buf
;
23153 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23155 if (NILP (Vmemory_full
))
23158 return "!MEM FULL! ";
23165 /* %F displays the frame name. */
23166 if (!NILP (f
->title
))
23167 return SSDATA (f
->title
);
23168 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23169 return SSDATA (f
->name
);
23173 obj
= BVAR (b
, filename
);
23178 ptrdiff_t size
= ZV
- BEGV
;
23179 pint2str (decode_mode_spec_buf
, width
, size
);
23180 return decode_mode_spec_buf
;
23185 ptrdiff_t size
= ZV
- BEGV
;
23186 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23187 return decode_mode_spec_buf
;
23192 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23193 ptrdiff_t topline
, nlines
, height
;
23196 /* %c and %l are ignored in `frame-title-format'. */
23197 if (mode_line_target
== MODE_LINE_TITLE
)
23200 startpos
= marker_position (w
->start
);
23201 startpos_byte
= marker_byte_position (w
->start
);
23202 height
= WINDOW_TOTAL_LINES (w
);
23204 /* If we decided that this buffer isn't suitable for line numbers,
23205 don't forget that too fast. */
23206 if (w
->base_line_pos
== -1)
23209 /* If the buffer is very big, don't waste time. */
23210 if (INTEGERP (Vline_number_display_limit
)
23211 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23213 w
->base_line_pos
= 0;
23214 w
->base_line_number
= 0;
23218 if (w
->base_line_number
> 0
23219 && w
->base_line_pos
> 0
23220 && w
->base_line_pos
<= startpos
)
23222 line
= w
->base_line_number
;
23223 linepos
= w
->base_line_pos
;
23224 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23229 linepos
= BUF_BEGV (b
);
23230 linepos_byte
= BUF_BEGV_BYTE (b
);
23233 /* Count lines from base line to window start position. */
23234 nlines
= display_count_lines (linepos_byte
,
23238 topline
= nlines
+ line
;
23240 /* Determine a new base line, if the old one is too close
23241 or too far away, or if we did not have one.
23242 "Too close" means it's plausible a scroll-down would
23243 go back past it. */
23244 if (startpos
== BUF_BEGV (b
))
23246 w
->base_line_number
= topline
;
23247 w
->base_line_pos
= BUF_BEGV (b
);
23249 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23250 || linepos
== BUF_BEGV (b
))
23252 ptrdiff_t limit
= BUF_BEGV (b
);
23253 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23254 ptrdiff_t position
;
23255 ptrdiff_t distance
=
23256 (height
* 2 + 30) * line_number_display_limit_width
;
23258 if (startpos
- distance
> limit
)
23260 limit
= startpos
- distance
;
23261 limit_byte
= CHAR_TO_BYTE (limit
);
23264 nlines
= display_count_lines (startpos_byte
,
23266 - (height
* 2 + 30),
23268 /* If we couldn't find the lines we wanted within
23269 line_number_display_limit_width chars per line,
23270 give up on line numbers for this window. */
23271 if (position
== limit_byte
&& limit
== startpos
- distance
)
23273 w
->base_line_pos
= -1;
23274 w
->base_line_number
= 0;
23278 w
->base_line_number
= topline
- nlines
;
23279 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23282 /* Now count lines from the start pos to point. */
23283 nlines
= display_count_lines (startpos_byte
,
23284 PT_BYTE
, PT
, &junk
);
23286 /* Record that we did display the line number. */
23287 line_number_displayed
= true;
23289 /* Make the string to show. */
23290 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23291 return decode_mode_spec_buf
;
23294 char *p
= decode_mode_spec_buf
;
23295 int pad
= width
- 2;
23301 return decode_mode_spec_buf
;
23307 obj
= BVAR (b
, mode_name
);
23311 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23317 ptrdiff_t pos
= marker_position (w
->start
);
23318 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23320 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23322 if (pos
<= BUF_BEGV (b
))
23327 else if (pos
<= BUF_BEGV (b
))
23331 if (total
> 1000000)
23332 /* Do it differently for a large value, to avoid overflow. */
23333 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23335 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23336 /* We can't normally display a 3-digit number,
23337 so get us a 2-digit number that is close. */
23340 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23341 return decode_mode_spec_buf
;
23345 /* Display percentage of size above the bottom of the screen. */
23348 ptrdiff_t toppos
= marker_position (w
->start
);
23349 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23350 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23352 if (botpos
>= BUF_ZV (b
))
23354 if (toppos
<= BUF_BEGV (b
))
23361 if (total
> 1000000)
23362 /* Do it differently for a large value, to avoid overflow. */
23363 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23365 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23366 /* We can't normally display a 3-digit number,
23367 so get us a 2-digit number that is close. */
23370 if (toppos
<= BUF_BEGV (b
))
23371 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23373 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23374 return decode_mode_spec_buf
;
23379 /* status of process */
23380 obj
= Fget_buffer_process (Fcurrent_buffer ());
23382 return "no process";
23384 obj
= Fsymbol_name (Fprocess_status (obj
));
23390 ptrdiff_t count
= inhibit_garbage_collection ();
23391 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23392 Lisp_Object val
= Qnil
;
23394 if (STRINGP (curdir
))
23395 val
= call1 (intern ("file-remote-p"), curdir
);
23397 unbind_to (count
, Qnil
);
23406 /* coding-system (not including end-of-line format) */
23408 /* coding-system (including end-of-line type) */
23410 bool eol_flag
= (c
== 'Z');
23411 char *p
= decode_mode_spec_buf
;
23413 if (! FRAME_WINDOW_P (f
))
23415 /* No need to mention EOL here--the terminal never needs
23416 to do EOL conversion. */
23417 p
= decode_mode_spec_coding (CODING_ID_NAME
23418 (FRAME_KEYBOARD_CODING (f
)->id
),
23420 p
= decode_mode_spec_coding (CODING_ID_NAME
23421 (FRAME_TERMINAL_CODING (f
)->id
),
23424 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23427 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23428 #ifdef subprocesses
23429 obj
= Fget_buffer_process (Fcurrent_buffer ());
23430 if (PROCESSP (obj
))
23432 p
= decode_mode_spec_coding
23433 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23434 p
= decode_mode_spec_coding
23435 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23437 #endif /* subprocesses */
23440 return decode_mode_spec_buf
;
23447 return SSDATA (obj
);
23454 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23455 means count lines back from START_BYTE. But don't go beyond
23456 LIMIT_BYTE. Return the number of lines thus found (always
23459 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23460 either the position COUNT lines after/before START_BYTE, if we
23461 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23465 display_count_lines (ptrdiff_t start_byte
,
23466 ptrdiff_t limit_byte
, ptrdiff_t count
,
23467 ptrdiff_t *byte_pos_ptr
)
23469 register unsigned char *cursor
;
23470 unsigned char *base
;
23472 register ptrdiff_t ceiling
;
23473 register unsigned char *ceiling_addr
;
23474 ptrdiff_t orig_count
= count
;
23476 /* If we are not in selective display mode,
23477 check only for newlines. */
23478 bool selective_display
23479 = (!NILP (BVAR (current_buffer
, selective_display
))
23480 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23484 while (start_byte
< limit_byte
)
23486 ceiling
= BUFFER_CEILING_OF (start_byte
);
23487 ceiling
= min (limit_byte
- 1, ceiling
);
23488 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23489 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23493 if (selective_display
)
23495 while (*cursor
!= '\n' && *cursor
!= 015
23496 && ++cursor
!= ceiling_addr
)
23498 if (cursor
== ceiling_addr
)
23503 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23512 start_byte
+= cursor
- base
;
23513 *byte_pos_ptr
= start_byte
;
23517 while (cursor
< ceiling_addr
);
23519 start_byte
+= ceiling_addr
- base
;
23524 while (start_byte
> limit_byte
)
23526 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23527 ceiling
= max (limit_byte
, ceiling
);
23528 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23529 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23532 if (selective_display
)
23534 while (--cursor
>= ceiling_addr
23535 && *cursor
!= '\n' && *cursor
!= 015)
23537 if (cursor
< ceiling_addr
)
23542 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23549 start_byte
+= cursor
- base
+ 1;
23550 *byte_pos_ptr
= start_byte
;
23551 /* When scanning backwards, we should
23552 not count the newline posterior to which we stop. */
23553 return - orig_count
- 1;
23556 start_byte
+= ceiling_addr
- base
;
23560 *byte_pos_ptr
= limit_byte
;
23563 return - orig_count
+ count
;
23564 return orig_count
- count
;
23570 /***********************************************************************
23572 ***********************************************************************/
23574 /* Display a NUL-terminated string, starting with index START.
23576 If STRING is non-null, display that C string. Otherwise, the Lisp
23577 string LISP_STRING is displayed. There's a case that STRING is
23578 non-null and LISP_STRING is not nil. It means STRING is a string
23579 data of LISP_STRING. In that case, we display LISP_STRING while
23580 ignoring its text properties.
23582 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23583 FACE_STRING. Display STRING or LISP_STRING with the face at
23584 FACE_STRING_POS in FACE_STRING:
23586 Display the string in the environment given by IT, but use the
23587 standard display table, temporarily.
23589 FIELD_WIDTH is the minimum number of output glyphs to produce.
23590 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23591 with spaces. If STRING has more characters, more than FIELD_WIDTH
23592 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23594 PRECISION is the maximum number of characters to output from
23595 STRING. PRECISION < 0 means don't truncate the string.
23597 This is roughly equivalent to printf format specifiers:
23599 FIELD_WIDTH PRECISION PRINTF
23600 ----------------------------------------
23606 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23607 display them, and < 0 means obey the current buffer's value of
23608 enable_multibyte_characters.
23610 Value is the number of columns displayed. */
23613 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23614 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23615 int field_width
, int precision
, int max_x
, int multibyte
)
23617 int hpos_at_start
= it
->hpos
;
23618 int saved_face_id
= it
->face_id
;
23619 struct glyph_row
*row
= it
->glyph_row
;
23620 ptrdiff_t it_charpos
;
23622 /* Initialize the iterator IT for iteration over STRING beginning
23623 with index START. */
23624 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23625 precision
, field_width
, multibyte
);
23626 if (string
&& STRINGP (lisp_string
))
23627 /* LISP_STRING is the one returned by decode_mode_spec. We should
23628 ignore its text properties. */
23629 it
->stop_charpos
= it
->end_charpos
;
23631 /* If displaying STRING, set up the face of the iterator from
23632 FACE_STRING, if that's given. */
23633 if (STRINGP (face_string
))
23639 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23640 0, &endptr
, it
->base_face_id
, false);
23641 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23642 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23645 /* Set max_x to the maximum allowed X position. Don't let it go
23646 beyond the right edge of the window. */
23648 max_x
= it
->last_visible_x
;
23650 max_x
= min (max_x
, it
->last_visible_x
);
23652 /* Skip over display elements that are not visible. because IT->w is
23654 if (it
->current_x
< it
->first_visible_x
)
23655 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23656 MOVE_TO_POS
| MOVE_TO_X
);
23658 row
->ascent
= it
->max_ascent
;
23659 row
->height
= it
->max_ascent
+ it
->max_descent
;
23660 row
->phys_ascent
= it
->max_phys_ascent
;
23661 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23662 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23664 if (STRINGP (it
->string
))
23665 it_charpos
= IT_STRING_CHARPOS (*it
);
23667 it_charpos
= IT_CHARPOS (*it
);
23669 /* This condition is for the case that we are called with current_x
23670 past last_visible_x. */
23671 while (it
->current_x
< max_x
)
23673 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23675 /* Get the next display element. */
23676 if (!get_next_display_element (it
))
23679 /* Produce glyphs. */
23680 x_before
= it
->current_x
;
23681 n_glyphs_before
= row
->used
[TEXT_AREA
];
23682 PRODUCE_GLYPHS (it
);
23684 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23687 while (i
< nglyphs
)
23689 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23691 if (it
->line_wrap
!= TRUNCATE
23692 && x
+ glyph
->pixel_width
> max_x
)
23694 /* End of continued line or max_x reached. */
23695 if (CHAR_GLYPH_PADDING_P (*glyph
))
23697 /* A wide character is unbreakable. */
23698 if (row
->reversed_p
)
23699 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23700 - n_glyphs_before
);
23701 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23702 it
->current_x
= x_before
;
23706 if (row
->reversed_p
)
23707 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23708 - (n_glyphs_before
+ i
));
23709 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23714 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23716 /* Glyph is at least partially visible. */
23718 if (x
< it
->first_visible_x
)
23719 row
->x
= x
- it
->first_visible_x
;
23723 /* Glyph is off the left margin of the display area.
23724 Should not happen. */
23728 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23729 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23730 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23731 row
->phys_height
= max (row
->phys_height
,
23732 it
->max_phys_ascent
+ it
->max_phys_descent
);
23733 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23734 it
->max_extra_line_spacing
);
23735 x
+= glyph
->pixel_width
;
23739 /* Stop if max_x reached. */
23743 /* Stop at line ends. */
23744 if (ITERATOR_AT_END_OF_LINE_P (it
))
23746 it
->continuation_lines_width
= 0;
23750 set_iterator_to_next (it
, true);
23751 if (STRINGP (it
->string
))
23752 it_charpos
= IT_STRING_CHARPOS (*it
);
23754 it_charpos
= IT_CHARPOS (*it
);
23756 /* Stop if truncating at the right edge. */
23757 if (it
->line_wrap
== TRUNCATE
23758 && it
->current_x
>= it
->last_visible_x
)
23760 /* Add truncation mark, but don't do it if the line is
23761 truncated at a padding space. */
23762 if (it_charpos
< it
->string_nchars
)
23764 if (!FRAME_WINDOW_P (it
->f
))
23768 if (it
->current_x
> it
->last_visible_x
)
23770 if (!row
->reversed_p
)
23772 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23773 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23778 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23779 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23781 unproduce_glyphs (it
, ii
+ 1);
23782 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23784 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23786 row
->used
[TEXT_AREA
] = ii
;
23787 produce_special_glyphs (it
, IT_TRUNCATION
);
23790 produce_special_glyphs (it
, IT_TRUNCATION
);
23792 row
->truncated_on_right_p
= true;
23798 /* Maybe insert a truncation at the left. */
23799 if (it
->first_visible_x
23802 if (!FRAME_WINDOW_P (it
->f
)
23803 || (row
->reversed_p
23804 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23805 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23806 insert_left_trunc_glyphs (it
);
23807 row
->truncated_on_left_p
= true;
23810 it
->face_id
= saved_face_id
;
23812 /* Value is number of columns displayed. */
23813 return it
->hpos
- hpos_at_start
;
23818 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23819 appears as an element of LIST or as the car of an element of LIST.
23820 If PROPVAL is a list, compare each element against LIST in that
23821 way, and return 1/2 if any element of PROPVAL is found in LIST.
23822 Otherwise return 0. This function cannot quit.
23823 The return value is 2 if the text is invisible but with an ellipsis
23824 and 1 if it's invisible and without an ellipsis. */
23827 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23829 Lisp_Object tail
, proptail
;
23831 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23833 register Lisp_Object tem
;
23835 if (EQ (propval
, tem
))
23837 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23838 return NILP (XCDR (tem
)) ? 1 : 2;
23841 if (CONSP (propval
))
23843 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23845 Lisp_Object propelt
;
23846 propelt
= XCAR (proptail
);
23847 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23849 register Lisp_Object tem
;
23851 if (EQ (propelt
, tem
))
23853 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23854 return NILP (XCDR (tem
)) ? 1 : 2;
23862 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23863 doc
: /* Non-nil if the property makes the text invisible.
23864 POS-OR-PROP can be a marker or number, in which case it is taken to be
23865 a position in the current buffer and the value of the `invisible' property
23866 is checked; or it can be some other value, which is then presumed to be the
23867 value of the `invisible' property of the text of interest.
23868 The non-nil value returned can be t for truly invisible text or something
23869 else if the text is replaced by an ellipsis. */)
23870 (Lisp_Object pos_or_prop
)
23873 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23874 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23876 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23877 return (invis
== 0 ? Qnil
23879 : make_number (invis
));
23882 /* Calculate a width or height in pixels from a specification using
23883 the following elements:
23886 NUM - a (fractional) multiple of the default font width/height
23887 (NUM) - specifies exactly NUM pixels
23888 UNIT - a fixed number of pixels, see below.
23889 ELEMENT - size of a display element in pixels, see below.
23890 (NUM . SPEC) - equals NUM * SPEC
23891 (+ SPEC SPEC ...) - add pixel values
23892 (- SPEC SPEC ...) - subtract pixel values
23893 (- SPEC) - negate pixel value
23896 INT or FLOAT - a number constant
23897 SYMBOL - use symbol's (buffer local) variable binding.
23900 in - pixels per inch *)
23901 mm - pixels per 1/1000 meter *)
23902 cm - pixels per 1/100 meter *)
23903 width - width of current font in pixels.
23904 height - height of current font in pixels.
23906 *) using the ratio(s) defined in display-pixels-per-inch.
23910 left-fringe - left fringe width in pixels
23911 right-fringe - right fringe width in pixels
23913 left-margin - left margin width in pixels
23914 right-margin - right margin width in pixels
23916 scroll-bar - scroll-bar area width in pixels
23920 Pixels corresponding to 5 inches:
23923 Total width of non-text areas on left side of window (if scroll-bar is on left):
23924 '(space :width (+ left-fringe left-margin scroll-bar))
23926 Align to first text column (in header line):
23927 '(space :align-to 0)
23929 Align to middle of text area minus half the width of variable `my-image'
23930 containing a loaded image:
23931 '(space :align-to (0.5 . (- text my-image)))
23933 Width of left margin minus width of 1 character in the default font:
23934 '(space :width (- left-margin 1))
23936 Width of left margin minus width of 2 characters in the current font:
23937 '(space :width (- left-margin (2 . width)))
23939 Center 1 character over left-margin (in header line):
23940 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23942 Different ways to express width of left fringe plus left margin minus one pixel:
23943 '(space :width (- (+ left-fringe left-margin) (1)))
23944 '(space :width (+ left-fringe left-margin (- (1))))
23945 '(space :width (+ left-fringe left-margin (-1)))
23950 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23951 struct font
*font
, bool width_p
, int *align_to
)
23955 # define OK_PIXELS(val) (*res = (val), true)
23956 # define OK_ALIGN_TO(val) (*align_to = (val), true)
23959 return OK_PIXELS (0);
23961 eassert (FRAME_LIVE_P (it
->f
));
23963 if (SYMBOLP (prop
))
23965 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23967 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23969 if (unit
[0] == 'i' && unit
[1] == 'n')
23971 else if (unit
[0] == 'm' && unit
[1] == 'm')
23973 else if (unit
[0] == 'c' && unit
[1] == 'm')
23979 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23980 : FRAME_RES_Y (it
->f
));
23983 return OK_PIXELS (ppi
/ pixels
);
23988 #ifdef HAVE_WINDOW_SYSTEM
23989 if (EQ (prop
, Qheight
))
23990 return OK_PIXELS (font
23991 ? normal_char_height (font
, -1)
23992 : FRAME_LINE_HEIGHT (it
->f
));
23993 if (EQ (prop
, Qwidth
))
23994 return OK_PIXELS (font
23995 ? FONT_WIDTH (font
)
23996 : FRAME_COLUMN_WIDTH (it
->f
));
23998 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23999 return OK_PIXELS (1);
24002 if (EQ (prop
, Qtext
))
24003 return OK_PIXELS (width_p
24004 ? window_box_width (it
->w
, TEXT_AREA
)
24005 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24007 if (align_to
&& *align_to
< 0)
24010 if (EQ (prop
, Qleft
))
24011 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24012 if (EQ (prop
, Qright
))
24013 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24014 if (EQ (prop
, Qcenter
))
24015 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24016 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24017 if (EQ (prop
, Qleft_fringe
))
24018 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24019 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24020 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24021 if (EQ (prop
, Qright_fringe
))
24022 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24023 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24024 : window_box_right_offset (it
->w
, TEXT_AREA
));
24025 if (EQ (prop
, Qleft_margin
))
24026 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24027 if (EQ (prop
, Qright_margin
))
24028 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24029 if (EQ (prop
, Qscroll_bar
))
24030 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24032 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24033 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24034 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24039 if (EQ (prop
, Qleft_fringe
))
24040 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24041 if (EQ (prop
, Qright_fringe
))
24042 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24043 if (EQ (prop
, Qleft_margin
))
24044 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24045 if (EQ (prop
, Qright_margin
))
24046 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24047 if (EQ (prop
, Qscroll_bar
))
24048 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24051 prop
= buffer_local_value (prop
, it
->w
->contents
);
24052 if (EQ (prop
, Qunbound
))
24056 if (INTEGERP (prop
) || FLOATP (prop
))
24058 int base_unit
= (width_p
24059 ? FRAME_COLUMN_WIDTH (it
->f
)
24060 : FRAME_LINE_HEIGHT (it
->f
));
24061 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24066 Lisp_Object car
= XCAR (prop
);
24067 Lisp_Object cdr
= XCDR (prop
);
24071 #ifdef HAVE_WINDOW_SYSTEM
24072 if (FRAME_WINDOW_P (it
->f
)
24073 && valid_image_p (prop
))
24075 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24076 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24078 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24081 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24087 while (CONSP (cdr
))
24089 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24090 font
, width_p
, align_to
))
24093 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24098 if (EQ (car
, Qminus
))
24100 return OK_PIXELS (pixels
);
24103 car
= buffer_local_value (car
, it
->w
->contents
);
24104 if (EQ (car
, Qunbound
))
24108 if (INTEGERP (car
) || FLOATP (car
))
24111 pixels
= XFLOATINT (car
);
24113 return OK_PIXELS (pixels
);
24114 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24115 font
, width_p
, align_to
))
24116 return OK_PIXELS (pixels
* fact
);
24127 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24129 #ifdef HAVE_WINDOW_SYSTEM
24130 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24138 /***********************************************************************
24140 ***********************************************************************/
24142 #ifdef HAVE_WINDOW_SYSTEM
24147 dump_glyph_string (struct glyph_string
*s
)
24149 fprintf (stderr
, "glyph string\n");
24150 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24151 s
->x
, s
->y
, s
->width
, s
->height
);
24152 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24153 fprintf (stderr
, " hl = %d\n", s
->hl
);
24154 fprintf (stderr
, " left overhang = %d, right = %d\n",
24155 s
->left_overhang
, s
->right_overhang
);
24156 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24157 fprintf (stderr
, " extends to end of line = %d\n",
24158 s
->extends_to_end_of_line_p
);
24159 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24160 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24163 #endif /* GLYPH_DEBUG */
24165 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24166 of XChar2b structures for S; it can't be allocated in
24167 init_glyph_string because it must be allocated via `alloca'. W
24168 is the window on which S is drawn. ROW and AREA are the glyph row
24169 and area within the row from which S is constructed. START is the
24170 index of the first glyph structure covered by S. HL is a
24171 face-override for drawing S. */
24174 #define OPTIONAL_HDC(hdc) HDC hdc,
24175 #define DECLARE_HDC(hdc) HDC hdc;
24176 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24177 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24180 #ifndef OPTIONAL_HDC
24181 #define OPTIONAL_HDC(hdc)
24182 #define DECLARE_HDC(hdc)
24183 #define ALLOCATE_HDC(hdc, f)
24184 #define RELEASE_HDC(hdc, f)
24188 init_glyph_string (struct glyph_string
*s
,
24190 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24191 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24193 memset (s
, 0, sizeof *s
);
24195 s
->f
= XFRAME (w
->frame
);
24199 s
->display
= FRAME_X_DISPLAY (s
->f
);
24200 s
->window
= FRAME_X_WINDOW (s
->f
);
24201 s
->char2b
= char2b
;
24205 s
->first_glyph
= row
->glyphs
[area
] + start
;
24206 s
->height
= row
->height
;
24207 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24208 s
->ybase
= s
->y
+ row
->ascent
;
24212 /* Append the list of glyph strings with head H and tail T to the list
24213 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24216 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24217 struct glyph_string
*h
, struct glyph_string
*t
)
24231 /* Prepend the list of glyph strings with head H and tail T to the
24232 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24236 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24237 struct glyph_string
*h
, struct glyph_string
*t
)
24251 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24252 Set *HEAD and *TAIL to the resulting list. */
24255 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24256 struct glyph_string
*s
)
24258 s
->next
= s
->prev
= NULL
;
24259 append_glyph_string_lists (head
, tail
, s
, s
);
24263 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24264 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24265 make sure that X resources for the face returned are allocated.
24266 Value is a pointer to a realized face that is ready for display if
24269 static struct face
*
24270 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24271 XChar2b
*char2b
, bool display_p
)
24273 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24278 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24280 if (code
== FONT_INVALID_CODE
)
24283 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24285 /* Make sure X resources of the face are allocated. */
24286 #ifdef HAVE_X_WINDOWS
24290 eassert (face
!= NULL
);
24291 prepare_face_for_display (f
, face
);
24298 /* Get face and two-byte form of character glyph GLYPH on frame F.
24299 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24300 a pointer to a realized face that is ready for display. */
24302 static struct face
*
24303 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24309 eassert (glyph
->type
== CHAR_GLYPH
);
24310 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24312 /* Make sure X resources of the face are allocated. */
24313 eassert (face
!= NULL
);
24314 prepare_face_for_display (f
, face
);
24318 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24319 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24321 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24323 if (code
== FONT_INVALID_CODE
)
24327 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24332 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24333 Return true iff FONT has a glyph for C. */
24336 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24340 if (CHAR_BYTE8_P (c
))
24341 code
= CHAR_TO_BYTE8 (c
);
24343 code
= font
->driver
->encode_char (font
, c
);
24345 if (code
== FONT_INVALID_CODE
)
24347 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24352 /* Fill glyph string S with composition components specified by S->cmp.
24354 BASE_FACE is the base face of the composition.
24355 S->cmp_from is the index of the first component for S.
24357 OVERLAPS non-zero means S should draw the foreground only, and use
24358 its physical height for clipping. See also draw_glyphs.
24360 Value is the index of a component not in S. */
24363 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24367 /* For all glyphs of this composition, starting at the offset
24368 S->cmp_from, until we reach the end of the definition or encounter a
24369 glyph that requires the different face, add it to S. */
24374 s
->for_overlaps
= overlaps
;
24377 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24379 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24381 /* TAB in a composition means display glyphs with padding space
24382 on the left or right. */
24385 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24388 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24389 s
->char2b
+ i
, true);
24395 s
->font
= s
->face
->font
;
24397 else if (s
->face
!= face
)
24405 if (s
->face
== NULL
)
24407 s
->face
= base_face
->ascii_face
;
24408 s
->font
= s
->face
->font
;
24411 /* All glyph strings for the same composition has the same width,
24412 i.e. the width set for the first component of the composition. */
24413 s
->width
= s
->first_glyph
->pixel_width
;
24415 /* If the specified font could not be loaded, use the frame's
24416 default font, but record the fact that we couldn't load it in
24417 the glyph string so that we can draw rectangles for the
24418 characters of the glyph string. */
24419 if (s
->font
== NULL
)
24421 s
->font_not_found_p
= true;
24422 s
->font
= FRAME_FONT (s
->f
);
24425 /* Adjust base line for subscript/superscript text. */
24426 s
->ybase
+= s
->first_glyph
->voffset
;
24432 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24433 int start
, int end
, int overlaps
)
24435 struct glyph
*glyph
, *last
;
24436 Lisp_Object lgstring
;
24439 s
->for_overlaps
= overlaps
;
24440 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24441 last
= s
->row
->glyphs
[s
->area
] + end
;
24442 s
->cmp_id
= glyph
->u
.cmp
.id
;
24443 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24444 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24445 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24446 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24447 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24449 while (glyph
< last
24450 && glyph
->u
.cmp
.automatic
24451 && glyph
->u
.cmp
.id
== s
->cmp_id
24452 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24453 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24455 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24457 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24458 unsigned code
= LGLYPH_CODE (lglyph
);
24460 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24462 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24463 return glyph
- s
->row
->glyphs
[s
->area
];
24467 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24468 See the comment of fill_glyph_string for arguments.
24469 Value is the index of the first glyph not in S. */
24473 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24474 int start
, int end
, int overlaps
)
24476 struct glyph
*glyph
, *last
;
24479 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24480 s
->for_overlaps
= overlaps
;
24481 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24482 last
= s
->row
->glyphs
[s
->area
] + end
;
24483 voffset
= glyph
->voffset
;
24484 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24485 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24487 s
->width
= glyph
->pixel_width
;
24489 while (glyph
< last
24490 && glyph
->type
== GLYPHLESS_GLYPH
24491 && glyph
->voffset
== voffset
24492 && glyph
->face_id
== face_id
)
24495 s
->width
+= glyph
->pixel_width
;
24498 s
->ybase
+= voffset
;
24499 return glyph
- s
->row
->glyphs
[s
->area
];
24503 /* Fill glyph string S from a sequence of character glyphs.
24505 FACE_ID is the face id of the string. START is the index of the
24506 first glyph to consider, END is the index of the last + 1.
24507 OVERLAPS non-zero means S should draw the foreground only, and use
24508 its physical height for clipping. See also draw_glyphs.
24510 Value is the index of the first glyph not in S. */
24513 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24514 int start
, int end
, int overlaps
)
24516 struct glyph
*glyph
, *last
;
24518 bool glyph_not_available_p
;
24520 eassert (s
->f
== XFRAME (s
->w
->frame
));
24521 eassert (s
->nchars
== 0);
24522 eassert (start
>= 0 && end
> start
);
24524 s
->for_overlaps
= overlaps
;
24525 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24526 last
= s
->row
->glyphs
[s
->area
] + end
;
24527 voffset
= glyph
->voffset
;
24528 s
->padding_p
= glyph
->padding_p
;
24529 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24531 while (glyph
< last
24532 && glyph
->type
== CHAR_GLYPH
24533 && glyph
->voffset
== voffset
24534 /* Same face id implies same font, nowadays. */
24535 && glyph
->face_id
== face_id
24536 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24538 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24539 s
->char2b
+ s
->nchars
);
24541 eassert (s
->nchars
<= end
- start
);
24542 s
->width
+= glyph
->pixel_width
;
24543 if (glyph
++->padding_p
!= s
->padding_p
)
24547 s
->font
= s
->face
->font
;
24549 /* If the specified font could not be loaded, use the frame's font,
24550 but record the fact that we couldn't load it in
24551 S->font_not_found_p so that we can draw rectangles for the
24552 characters of the glyph string. */
24553 if (s
->font
== NULL
|| glyph_not_available_p
)
24555 s
->font_not_found_p
= true;
24556 s
->font
= FRAME_FONT (s
->f
);
24559 /* Adjust base line for subscript/superscript text. */
24560 s
->ybase
+= voffset
;
24562 eassert (s
->face
&& s
->face
->gc
);
24563 return glyph
- s
->row
->glyphs
[s
->area
];
24567 /* Fill glyph string S from image glyph S->first_glyph. */
24570 fill_image_glyph_string (struct glyph_string
*s
)
24572 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24573 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24575 s
->slice
= s
->first_glyph
->slice
.img
;
24576 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24577 s
->font
= s
->face
->font
;
24578 s
->width
= s
->first_glyph
->pixel_width
;
24580 /* Adjust base line for subscript/superscript text. */
24581 s
->ybase
+= s
->first_glyph
->voffset
;
24585 /* Fill glyph string S from a sequence of stretch glyphs.
24587 START is the index of the first glyph to consider,
24588 END is the index of the last + 1.
24590 Value is the index of the first glyph not in S. */
24593 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24595 struct glyph
*glyph
, *last
;
24596 int voffset
, face_id
;
24598 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24600 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24601 last
= s
->row
->glyphs
[s
->area
] + end
;
24602 face_id
= glyph
->face_id
;
24603 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24604 s
->font
= s
->face
->font
;
24605 s
->width
= glyph
->pixel_width
;
24607 voffset
= glyph
->voffset
;
24611 && glyph
->type
== STRETCH_GLYPH
24612 && glyph
->voffset
== voffset
24613 && glyph
->face_id
== face_id
);
24615 s
->width
+= glyph
->pixel_width
;
24617 /* Adjust base line for subscript/superscript text. */
24618 s
->ybase
+= voffset
;
24620 /* The case that face->gc == 0 is handled when drawing the glyph
24621 string by calling prepare_face_for_display. */
24623 return glyph
- s
->row
->glyphs
[s
->area
];
24626 static struct font_metrics
*
24627 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24629 static struct font_metrics metrics
;
24634 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24635 if (code
== FONT_INVALID_CODE
)
24637 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24641 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24642 for FONT. Values are taken from font-global ones, except for fonts
24643 that claim preposterously large values, but whose glyphs actually
24644 have reasonable dimensions. C is the character to use for metrics
24645 if the font-global values are too large; if C is negative, the
24646 function selects a default character. */
24648 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24650 *ascent
= FONT_BASE (font
);
24651 *descent
= FONT_DESCENT (font
);
24653 if (FONT_TOO_HIGH (font
))
24657 /* Get metrics of C, defaulting to a reasonably sized ASCII
24659 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24661 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24663 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24665 /* We add 1 pixel to character dimensions as heuristics
24666 that produces nicer display, e.g. when the face has
24667 the box attribute. */
24668 *ascent
= pcm
->ascent
+ 1;
24669 *descent
= pcm
->descent
+ 1;
24675 /* A subroutine that computes a reasonable "normal character height"
24676 for fonts that claim preposterously large vertical dimensions, but
24677 whose glyphs are actually reasonably sized. C is the character
24678 whose metrics to use for those fonts, or -1 for default
24681 normal_char_height (struct font
*font
, int c
)
24683 int ascent
, descent
;
24685 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24687 return ascent
+ descent
;
24691 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24692 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24693 assumed to be zero. */
24696 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24698 *left
= *right
= 0;
24700 if (glyph
->type
== CHAR_GLYPH
)
24703 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24706 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24709 if (pcm
->rbearing
> pcm
->width
)
24710 *right
= pcm
->rbearing
- pcm
->width
;
24711 if (pcm
->lbearing
< 0)
24712 *left
= -pcm
->lbearing
;
24716 else if (glyph
->type
== COMPOSITE_GLYPH
)
24718 if (! glyph
->u
.cmp
.automatic
)
24720 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24722 if (cmp
->rbearing
> cmp
->pixel_width
)
24723 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24724 if (cmp
->lbearing
< 0)
24725 *left
= - cmp
->lbearing
;
24729 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24730 struct font_metrics metrics
;
24732 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24733 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24734 if (metrics
.rbearing
> metrics
.width
)
24735 *right
= metrics
.rbearing
- metrics
.width
;
24736 if (metrics
.lbearing
< 0)
24737 *left
= - metrics
.lbearing
;
24743 /* Return the index of the first glyph preceding glyph string S that
24744 is overwritten by S because of S's left overhang. Value is -1
24745 if no glyphs are overwritten. */
24748 left_overwritten (struct glyph_string
*s
)
24752 if (s
->left_overhang
)
24755 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24756 int first
= s
->first_glyph
- glyphs
;
24758 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24759 x
-= glyphs
[i
].pixel_width
;
24770 /* Return the index of the first glyph preceding glyph string S that
24771 is overwriting S because of its right overhang. Value is -1 if no
24772 glyph in front of S overwrites S. */
24775 left_overwriting (struct glyph_string
*s
)
24778 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24779 int first
= s
->first_glyph
- glyphs
;
24783 for (i
= first
- 1; i
>= 0; --i
)
24786 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24789 x
-= glyphs
[i
].pixel_width
;
24796 /* Return the index of the last glyph following glyph string S that is
24797 overwritten by S because of S's right overhang. Value is -1 if
24798 no such glyph is found. */
24801 right_overwritten (struct glyph_string
*s
)
24805 if (s
->right_overhang
)
24808 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24809 int first
= (s
->first_glyph
- glyphs
24810 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24811 int end
= s
->row
->used
[s
->area
];
24813 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24814 x
+= glyphs
[i
].pixel_width
;
24823 /* Return the index of the last glyph following glyph string S that
24824 overwrites S because of its left overhang. Value is negative
24825 if no such glyph is found. */
24828 right_overwriting (struct glyph_string
*s
)
24831 int end
= s
->row
->used
[s
->area
];
24832 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24833 int first
= (s
->first_glyph
- glyphs
24834 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24838 for (i
= first
; i
< end
; ++i
)
24841 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24844 x
+= glyphs
[i
].pixel_width
;
24851 /* Set background width of glyph string S. START is the index of the
24852 first glyph following S. LAST_X is the right-most x-position + 1
24853 in the drawing area. */
24856 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24858 /* If the face of this glyph string has to be drawn to the end of
24859 the drawing area, set S->extends_to_end_of_line_p. */
24861 if (start
== s
->row
->used
[s
->area
]
24862 && ((s
->row
->fill_line_p
24863 && (s
->hl
== DRAW_NORMAL_TEXT
24864 || s
->hl
== DRAW_IMAGE_RAISED
24865 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24866 || s
->hl
== DRAW_MOUSE_FACE
))
24867 s
->extends_to_end_of_line_p
= true;
24869 /* If S extends its face to the end of the line, set its
24870 background_width to the distance to the right edge of the drawing
24872 if (s
->extends_to_end_of_line_p
)
24873 s
->background_width
= last_x
- s
->x
+ 1;
24875 s
->background_width
= s
->width
;
24879 /* Compute overhangs and x-positions for glyph string S and its
24880 predecessors, or successors. X is the starting x-position for S.
24881 BACKWARD_P means process predecessors. */
24884 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24890 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24891 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24901 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24902 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24912 /* The following macros are only called from draw_glyphs below.
24913 They reference the following parameters of that function directly:
24914 `w', `row', `area', and `overlap_p'
24915 as well as the following local variables:
24916 `s', `f', and `hdc' (in W32) */
24919 /* On W32, silently add local `hdc' variable to argument list of
24920 init_glyph_string. */
24921 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24922 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24924 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24925 init_glyph_string (s, char2b, w, row, area, start, hl)
24928 /* Add a glyph string for a stretch glyph to the list of strings
24929 between HEAD and TAIL. START is the index of the stretch glyph in
24930 row area AREA of glyph row ROW. END is the index of the last glyph
24931 in that glyph row area. X is the current output position assigned
24932 to the new glyph string constructed. HL overrides that face of the
24933 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24934 is the right-most x-position of the drawing area. */
24936 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24937 and below -- keep them on one line. */
24938 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24941 s = alloca (sizeof *s); \
24942 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24943 START = fill_stretch_glyph_string (s, START, END); \
24944 append_glyph_string (&HEAD, &TAIL, s); \
24950 /* Add a glyph string for an image glyph to the list of strings
24951 between HEAD and TAIL. START is the index of the image glyph in
24952 row area AREA of glyph row ROW. END is the index of the last glyph
24953 in that glyph row area. X is the current output position assigned
24954 to the new glyph string constructed. HL overrides that face of the
24955 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24956 is the right-most x-position of the drawing area. */
24958 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24961 s = alloca (sizeof *s); \
24962 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24963 fill_image_glyph_string (s); \
24964 append_glyph_string (&HEAD, &TAIL, s); \
24971 /* Add a glyph string for a sequence of character glyphs to the list
24972 of strings between HEAD and TAIL. START is the index of the first
24973 glyph in row area AREA of glyph row ROW that is part of the new
24974 glyph string. END is the index of the last glyph in that glyph row
24975 area. X is the current output position assigned to the new glyph
24976 string constructed. HL overrides that face of the glyph; e.g. it
24977 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24978 right-most x-position of the drawing area. */
24980 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24986 face_id = (row)->glyphs[area][START].face_id; \
24988 s = alloca (sizeof *s); \
24989 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24990 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24991 append_glyph_string (&HEAD, &TAIL, s); \
24993 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24998 /* Add a glyph string for a composite sequence to the list of strings
24999 between HEAD and TAIL. START is the index of the first glyph in
25000 row area AREA of glyph row ROW that is part of the new glyph
25001 string. END is the index of the last glyph in that glyph row area.
25002 X is the current output position assigned to the new glyph string
25003 constructed. HL overrides that face of the glyph; e.g. it is
25004 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25005 x-position of the drawing area. */
25007 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25009 int face_id = (row)->glyphs[area][START].face_id; \
25010 struct face *base_face = FACE_FROM_ID (f, face_id); \
25011 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25012 struct composition *cmp = composition_table[cmp_id]; \
25014 struct glyph_string *first_s = NULL; \
25017 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25019 /* Make glyph_strings for each glyph sequence that is drawable by \
25020 the same face, and append them to HEAD/TAIL. */ \
25021 for (n = 0; n < cmp->glyph_len;) \
25023 s = alloca (sizeof *s); \
25024 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25025 append_glyph_string (&(HEAD), &(TAIL), s); \
25031 n = fill_composite_glyph_string (s, base_face, overlaps); \
25039 /* Add a glyph string for a glyph-string sequence to the list of strings
25040 between HEAD and TAIL. */
25042 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25046 Lisp_Object gstring; \
25048 face_id = (row)->glyphs[area][START].face_id; \
25049 gstring = (composition_gstring_from_id \
25050 ((row)->glyphs[area][START].u.cmp.id)); \
25051 s = alloca (sizeof *s); \
25052 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25053 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25054 append_glyph_string (&(HEAD), &(TAIL), s); \
25056 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25060 /* Add a glyph string for a sequence of glyphless character's glyphs
25061 to the list of strings between HEAD and TAIL. The meanings of
25062 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25064 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25069 face_id = (row)->glyphs[area][START].face_id; \
25071 s = alloca (sizeof *s); \
25072 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25073 append_glyph_string (&HEAD, &TAIL, s); \
25075 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25081 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25082 of AREA of glyph row ROW on window W between indices START and END.
25083 HL overrides the face for drawing glyph strings, e.g. it is
25084 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25085 x-positions of the drawing area.
25087 This is an ugly monster macro construct because we must use alloca
25088 to allocate glyph strings (because draw_glyphs can be called
25089 asynchronously). */
25091 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25094 HEAD = TAIL = NULL; \
25095 while (START < END) \
25097 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25098 switch (first_glyph->type) \
25101 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25105 case COMPOSITE_GLYPH: \
25106 if (first_glyph->u.cmp.automatic) \
25107 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25110 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25114 case STRETCH_GLYPH: \
25115 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25119 case IMAGE_GLYPH: \
25120 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25124 case GLYPHLESS_GLYPH: \
25125 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25135 set_glyph_string_background_width (s, START, LAST_X); \
25142 /* Draw glyphs between START and END in AREA of ROW on window W,
25143 starting at x-position X. X is relative to AREA in W. HL is a
25144 face-override with the following meaning:
25146 DRAW_NORMAL_TEXT draw normally
25147 DRAW_CURSOR draw in cursor face
25148 DRAW_MOUSE_FACE draw in mouse face.
25149 DRAW_INVERSE_VIDEO draw in mode line face
25150 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25151 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25153 If OVERLAPS is non-zero, draw only the foreground of characters and
25154 clip to the physical height of ROW. Non-zero value also defines
25155 the overlapping part to be drawn:
25157 OVERLAPS_PRED overlap with preceding rows
25158 OVERLAPS_SUCC overlap with succeeding rows
25159 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25160 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25162 Value is the x-position reached, relative to AREA of W. */
25165 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25166 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25167 enum draw_glyphs_face hl
, int overlaps
)
25169 struct glyph_string
*head
, *tail
;
25170 struct glyph_string
*s
;
25171 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25172 int i
, j
, x_reached
, last_x
, area_left
= 0;
25173 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25176 ALLOCATE_HDC (hdc
, f
);
25178 /* Let's rather be paranoid than getting a SEGV. */
25179 end
= min (end
, row
->used
[area
]);
25180 start
= clip_to_bounds (0, start
, end
);
25182 /* Translate X to frame coordinates. Set last_x to the right
25183 end of the drawing area. */
25184 if (row
->full_width_p
)
25186 /* X is relative to the left edge of W, without scroll bars
25188 area_left
= WINDOW_LEFT_EDGE_X (w
);
25189 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25190 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25194 area_left
= window_box_left (w
, area
);
25195 last_x
= area_left
+ window_box_width (w
, area
);
25199 /* Build a doubly-linked list of glyph_string structures between
25200 head and tail from what we have to draw. Note that the macro
25201 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25202 the reason we use a separate variable `i'. */
25205 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25207 x_reached
= tail
->x
+ tail
->background_width
;
25211 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25212 the row, redraw some glyphs in front or following the glyph
25213 strings built above. */
25214 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25216 struct glyph_string
*h
, *t
;
25217 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25218 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25219 bool check_mouse_face
= false;
25222 /* If mouse highlighting is on, we may need to draw adjacent
25223 glyphs using mouse-face highlighting. */
25224 if (area
== TEXT_AREA
&& row
->mouse_face_p
25225 && hlinfo
->mouse_face_beg_row
>= 0
25226 && hlinfo
->mouse_face_end_row
>= 0)
25228 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25230 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25231 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25233 check_mouse_face
= true;
25234 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25235 ? hlinfo
->mouse_face_beg_col
: 0;
25236 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25237 ? hlinfo
->mouse_face_end_col
25238 : row
->used
[TEXT_AREA
];
25242 /* Compute overhangs for all glyph strings. */
25243 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25244 for (s
= head
; s
; s
= s
->next
)
25245 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25247 /* Prepend glyph strings for glyphs in front of the first glyph
25248 string that are overwritten because of the first glyph
25249 string's left overhang. The background of all strings
25250 prepended must be drawn because the first glyph string
25252 i
= left_overwritten (head
);
25255 enum draw_glyphs_face overlap_hl
;
25257 /* If this row contains mouse highlighting, attempt to draw
25258 the overlapped glyphs with the correct highlight. This
25259 code fails if the overlap encompasses more than one glyph
25260 and mouse-highlight spans only some of these glyphs.
25261 However, making it work perfectly involves a lot more
25262 code, and I don't know if the pathological case occurs in
25263 practice, so we'll stick to this for now. --- cyd */
25264 if (check_mouse_face
25265 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25266 overlap_hl
= DRAW_MOUSE_FACE
;
25268 overlap_hl
= DRAW_NORMAL_TEXT
;
25270 if (hl
!= overlap_hl
)
25273 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25274 overlap_hl
, dummy_x
, last_x
);
25276 compute_overhangs_and_x (t
, head
->x
, true);
25277 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25278 if (clip_head
== NULL
)
25282 /* Prepend glyph strings for glyphs in front of the first glyph
25283 string that overwrite that glyph string because of their
25284 right overhang. For these strings, only the foreground must
25285 be drawn, because it draws over the glyph string at `head'.
25286 The background must not be drawn because this would overwrite
25287 right overhangs of preceding glyphs for which no glyph
25289 i
= left_overwriting (head
);
25292 enum draw_glyphs_face overlap_hl
;
25294 if (check_mouse_face
25295 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25296 overlap_hl
= DRAW_MOUSE_FACE
;
25298 overlap_hl
= DRAW_NORMAL_TEXT
;
25300 if (hl
== overlap_hl
|| clip_head
== NULL
)
25302 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25303 overlap_hl
, dummy_x
, last_x
);
25304 for (s
= h
; s
; s
= s
->next
)
25305 s
->background_filled_p
= true;
25306 compute_overhangs_and_x (t
, head
->x
, true);
25307 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25310 /* Append glyphs strings for glyphs following the last glyph
25311 string tail that are overwritten by tail. The background of
25312 these strings has to be drawn because tail's foreground draws
25314 i
= right_overwritten (tail
);
25317 enum draw_glyphs_face overlap_hl
;
25319 if (check_mouse_face
25320 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25321 overlap_hl
= DRAW_MOUSE_FACE
;
25323 overlap_hl
= DRAW_NORMAL_TEXT
;
25325 if (hl
!= overlap_hl
)
25327 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25328 overlap_hl
, x
, last_x
);
25329 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25330 we don't have `end = i;' here. */
25331 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25332 append_glyph_string_lists (&head
, &tail
, h
, t
);
25333 if (clip_tail
== NULL
)
25337 /* Append glyph strings for glyphs following the last glyph
25338 string tail that overwrite tail. The foreground of such
25339 glyphs has to be drawn because it writes into the background
25340 of tail. The background must not be drawn because it could
25341 paint over the foreground of following glyphs. */
25342 i
= right_overwriting (tail
);
25345 enum draw_glyphs_face overlap_hl
;
25346 if (check_mouse_face
25347 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25348 overlap_hl
= DRAW_MOUSE_FACE
;
25350 overlap_hl
= DRAW_NORMAL_TEXT
;
25352 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25354 i
++; /* We must include the Ith glyph. */
25355 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25356 overlap_hl
, x
, last_x
);
25357 for (s
= h
; s
; s
= s
->next
)
25358 s
->background_filled_p
= true;
25359 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25360 append_glyph_string_lists (&head
, &tail
, h
, t
);
25362 if (clip_head
|| clip_tail
)
25363 for (s
= head
; s
; s
= s
->next
)
25365 s
->clip_head
= clip_head
;
25366 s
->clip_tail
= clip_tail
;
25370 /* Draw all strings. */
25371 for (s
= head
; s
; s
= s
->next
)
25372 FRAME_RIF (f
)->draw_glyph_string (s
);
25375 /* When focus a sole frame and move horizontally, this clears on_p
25376 causing a failure to erase prev cursor position. */
25377 if (area
== TEXT_AREA
25378 && !row
->full_width_p
25379 /* When drawing overlapping rows, only the glyph strings'
25380 foreground is drawn, which doesn't erase a cursor
25384 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25385 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25386 : (tail
? tail
->x
+ tail
->background_width
: x
));
25390 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25391 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25395 /* Value is the x-position up to which drawn, relative to AREA of W.
25396 This doesn't include parts drawn because of overhangs. */
25397 if (row
->full_width_p
)
25398 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25400 x_reached
-= area_left
;
25402 RELEASE_HDC (hdc
, f
);
25408 /* Expand row matrix if too narrow. Don't expand if area
25411 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25413 if (!it->f->fonts_changed \
25414 && (it->glyph_row->glyphs[area] \
25415 < it->glyph_row->glyphs[area + 1])) \
25417 it->w->ncols_scale_factor++; \
25418 it->f->fonts_changed = true; \
25422 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25423 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25426 append_glyph (struct it
*it
)
25428 struct glyph
*glyph
;
25429 enum glyph_row_area area
= it
->area
;
25431 eassert (it
->glyph_row
);
25432 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25434 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25435 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25437 /* If the glyph row is reversed, we need to prepend the glyph
25438 rather than append it. */
25439 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25443 /* Make room for the additional glyph. */
25444 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25446 glyph
= it
->glyph_row
->glyphs
[area
];
25448 glyph
->charpos
= CHARPOS (it
->position
);
25449 glyph
->object
= it
->object
;
25450 if (it
->pixel_width
> 0)
25452 glyph
->pixel_width
= it
->pixel_width
;
25453 glyph
->padding_p
= false;
25457 /* Assure at least 1-pixel width. Otherwise, cursor can't
25458 be displayed correctly. */
25459 glyph
->pixel_width
= 1;
25460 glyph
->padding_p
= true;
25462 glyph
->ascent
= it
->ascent
;
25463 glyph
->descent
= it
->descent
;
25464 glyph
->voffset
= it
->voffset
;
25465 glyph
->type
= CHAR_GLYPH
;
25466 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25467 glyph
->multibyte_p
= it
->multibyte_p
;
25468 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25470 /* In R2L rows, the left and the right box edges need to be
25471 drawn in reverse direction. */
25472 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25473 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25477 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25478 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25480 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25481 || it
->phys_descent
> it
->descent
);
25482 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25483 glyph
->face_id
= it
->face_id
;
25484 glyph
->u
.ch
= it
->char_to_display
;
25485 glyph
->slice
.img
= null_glyph_slice
;
25486 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25489 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25490 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25491 glyph
->bidi_type
= it
->bidi_it
.type
;
25495 glyph
->resolved_level
= 0;
25496 glyph
->bidi_type
= UNKNOWN_BT
;
25498 ++it
->glyph_row
->used
[area
];
25501 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25504 /* Store one glyph for the composition IT->cmp_it.id in
25505 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25509 append_composite_glyph (struct it
*it
)
25511 struct glyph
*glyph
;
25512 enum glyph_row_area area
= it
->area
;
25514 eassert (it
->glyph_row
);
25516 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25517 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25519 /* If the glyph row is reversed, we need to prepend the glyph
25520 rather than append it. */
25521 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25525 /* Make room for the new glyph. */
25526 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25528 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25530 glyph
->charpos
= it
->cmp_it
.charpos
;
25531 glyph
->object
= it
->object
;
25532 glyph
->pixel_width
= it
->pixel_width
;
25533 glyph
->ascent
= it
->ascent
;
25534 glyph
->descent
= it
->descent
;
25535 glyph
->voffset
= it
->voffset
;
25536 glyph
->type
= COMPOSITE_GLYPH
;
25537 if (it
->cmp_it
.ch
< 0)
25539 glyph
->u
.cmp
.automatic
= false;
25540 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25541 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25545 glyph
->u
.cmp
.automatic
= true;
25546 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25547 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25548 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25550 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25551 glyph
->multibyte_p
= it
->multibyte_p
;
25552 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25554 /* In R2L rows, the left and the right box edges need to be
25555 drawn in reverse direction. */
25556 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25557 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25561 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25562 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25564 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25565 || it
->phys_descent
> it
->descent
);
25566 glyph
->padding_p
= false;
25567 glyph
->glyph_not_available_p
= false;
25568 glyph
->face_id
= it
->face_id
;
25569 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25572 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25573 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25574 glyph
->bidi_type
= it
->bidi_it
.type
;
25576 ++it
->glyph_row
->used
[area
];
25579 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25583 /* Change IT->ascent and IT->height according to the setting of
25587 take_vertical_position_into_account (struct it
*it
)
25591 if (it
->voffset
< 0)
25592 /* Increase the ascent so that we can display the text higher
25594 it
->ascent
-= it
->voffset
;
25596 /* Increase the descent so that we can display the text lower
25598 it
->descent
+= it
->voffset
;
25603 /* Produce glyphs/get display metrics for the image IT is loaded with.
25604 See the description of struct display_iterator in dispextern.h for
25605 an overview of struct display_iterator. */
25608 produce_image_glyph (struct it
*it
)
25612 int glyph_ascent
, crop
;
25613 struct glyph_slice slice
;
25615 eassert (it
->what
== IT_IMAGE
);
25617 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25619 /* Make sure X resources of the face is loaded. */
25620 prepare_face_for_display (it
->f
, face
);
25622 if (it
->image_id
< 0)
25624 /* Fringe bitmap. */
25625 it
->ascent
= it
->phys_ascent
= 0;
25626 it
->descent
= it
->phys_descent
= 0;
25627 it
->pixel_width
= 0;
25632 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25634 /* Make sure X resources of the image is loaded. */
25635 prepare_image_for_display (it
->f
, img
);
25637 slice
.x
= slice
.y
= 0;
25638 slice
.width
= img
->width
;
25639 slice
.height
= img
->height
;
25641 if (INTEGERP (it
->slice
.x
))
25642 slice
.x
= XINT (it
->slice
.x
);
25643 else if (FLOATP (it
->slice
.x
))
25644 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25646 if (INTEGERP (it
->slice
.y
))
25647 slice
.y
= XINT (it
->slice
.y
);
25648 else if (FLOATP (it
->slice
.y
))
25649 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25651 if (INTEGERP (it
->slice
.width
))
25652 slice
.width
= XINT (it
->slice
.width
);
25653 else if (FLOATP (it
->slice
.width
))
25654 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25656 if (INTEGERP (it
->slice
.height
))
25657 slice
.height
= XINT (it
->slice
.height
);
25658 else if (FLOATP (it
->slice
.height
))
25659 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25661 if (slice
.x
>= img
->width
)
25662 slice
.x
= img
->width
;
25663 if (slice
.y
>= img
->height
)
25664 slice
.y
= img
->height
;
25665 if (slice
.x
+ slice
.width
>= img
->width
)
25666 slice
.width
= img
->width
- slice
.x
;
25667 if (slice
.y
+ slice
.height
> img
->height
)
25668 slice
.height
= img
->height
- slice
.y
;
25670 if (slice
.width
== 0 || slice
.height
== 0)
25673 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25675 it
->descent
= slice
.height
- glyph_ascent
;
25677 it
->descent
+= img
->vmargin
;
25678 if (slice
.y
+ slice
.height
== img
->height
)
25679 it
->descent
+= img
->vmargin
;
25680 it
->phys_descent
= it
->descent
;
25682 it
->pixel_width
= slice
.width
;
25684 it
->pixel_width
+= img
->hmargin
;
25685 if (slice
.x
+ slice
.width
== img
->width
)
25686 it
->pixel_width
+= img
->hmargin
;
25688 /* It's quite possible for images to have an ascent greater than
25689 their height, so don't get confused in that case. */
25690 if (it
->descent
< 0)
25695 if (face
->box
!= FACE_NO_BOX
)
25697 if (face
->box_line_width
> 0)
25700 it
->ascent
+= face
->box_line_width
;
25701 if (slice
.y
+ slice
.height
== img
->height
)
25702 it
->descent
+= face
->box_line_width
;
25705 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25706 it
->pixel_width
+= eabs (face
->box_line_width
);
25707 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25708 it
->pixel_width
+= eabs (face
->box_line_width
);
25711 take_vertical_position_into_account (it
);
25713 /* Automatically crop wide image glyphs at right edge so we can
25714 draw the cursor on same display row. */
25715 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25716 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25718 it
->pixel_width
-= crop
;
25719 slice
.width
-= crop
;
25724 struct glyph
*glyph
;
25725 enum glyph_row_area area
= it
->area
;
25727 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25728 if (it
->glyph_row
->reversed_p
)
25732 /* Make room for the new glyph. */
25733 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25735 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25737 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25739 glyph
->charpos
= CHARPOS (it
->position
);
25740 glyph
->object
= it
->object
;
25741 glyph
->pixel_width
= it
->pixel_width
;
25742 glyph
->ascent
= glyph_ascent
;
25743 glyph
->descent
= it
->descent
;
25744 glyph
->voffset
= it
->voffset
;
25745 glyph
->type
= IMAGE_GLYPH
;
25746 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25747 glyph
->multibyte_p
= it
->multibyte_p
;
25748 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25750 /* In R2L rows, the left and the right box edges need to be
25751 drawn in reverse direction. */
25752 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25753 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25757 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25758 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25760 glyph
->overlaps_vertically_p
= false;
25761 glyph
->padding_p
= false;
25762 glyph
->glyph_not_available_p
= false;
25763 glyph
->face_id
= it
->face_id
;
25764 glyph
->u
.img_id
= img
->id
;
25765 glyph
->slice
.img
= slice
;
25766 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25769 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25770 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25771 glyph
->bidi_type
= it
->bidi_it
.type
;
25773 ++it
->glyph_row
->used
[area
];
25776 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25781 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25782 of the glyph, WIDTH and HEIGHT are the width and height of the
25783 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25786 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25787 int width
, int height
, int ascent
)
25789 struct glyph
*glyph
;
25790 enum glyph_row_area area
= it
->area
;
25792 eassert (ascent
>= 0 && ascent
<= height
);
25794 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25795 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25797 /* If the glyph row is reversed, we need to prepend the glyph
25798 rather than append it. */
25799 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25803 /* Make room for the additional glyph. */
25804 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25806 glyph
= it
->glyph_row
->glyphs
[area
];
25808 /* Decrease the width of the first glyph of the row that
25809 begins before first_visible_x (e.g., due to hscroll).
25810 This is so the overall width of the row becomes smaller
25811 by the scroll amount, and the stretch glyph appended by
25812 extend_face_to_end_of_line will be wider, to shift the
25813 row glyphs to the right. (In L2R rows, the corresponding
25814 left-shift effect is accomplished by setting row->x to a
25815 negative value, which won't work with R2L rows.)
25817 This must leave us with a positive value of WIDTH, since
25818 otherwise the call to move_it_in_display_line_to at the
25819 beginning of display_line would have got past the entire
25820 first glyph, and then it->current_x would have been
25821 greater or equal to it->first_visible_x. */
25822 if (it
->current_x
< it
->first_visible_x
)
25823 width
-= it
->first_visible_x
- it
->current_x
;
25824 eassert (width
> 0);
25826 glyph
->charpos
= CHARPOS (it
->position
);
25827 glyph
->object
= object
;
25828 glyph
->pixel_width
= width
;
25829 glyph
->ascent
= ascent
;
25830 glyph
->descent
= height
- ascent
;
25831 glyph
->voffset
= it
->voffset
;
25832 glyph
->type
= STRETCH_GLYPH
;
25833 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25834 glyph
->multibyte_p
= it
->multibyte_p
;
25835 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25837 /* In R2L rows, the left and the right box edges need to be
25838 drawn in reverse direction. */
25839 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25840 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25844 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25845 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25847 glyph
->overlaps_vertically_p
= false;
25848 glyph
->padding_p
= false;
25849 glyph
->glyph_not_available_p
= false;
25850 glyph
->face_id
= it
->face_id
;
25851 glyph
->u
.stretch
.ascent
= ascent
;
25852 glyph
->u
.stretch
.height
= height
;
25853 glyph
->slice
.img
= null_glyph_slice
;
25854 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25857 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25858 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25859 glyph
->bidi_type
= it
->bidi_it
.type
;
25863 glyph
->resolved_level
= 0;
25864 glyph
->bidi_type
= UNKNOWN_BT
;
25866 ++it
->glyph_row
->used
[area
];
25869 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25872 #endif /* HAVE_WINDOW_SYSTEM */
25874 /* Produce a stretch glyph for iterator IT. IT->object is the value
25875 of the glyph property displayed. The value must be a list
25876 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25879 1. `:width WIDTH' specifies that the space should be WIDTH *
25880 canonical char width wide. WIDTH may be an integer or floating
25883 2. `:relative-width FACTOR' specifies that the width of the stretch
25884 should be computed from the width of the first character having the
25885 `glyph' property, and should be FACTOR times that width.
25887 3. `:align-to HPOS' specifies that the space should be wide enough
25888 to reach HPOS, a value in canonical character units.
25890 Exactly one of the above pairs must be present.
25892 4. `:height HEIGHT' specifies that the height of the stretch produced
25893 should be HEIGHT, measured in canonical character units.
25895 5. `:relative-height FACTOR' specifies that the height of the
25896 stretch should be FACTOR times the height of the characters having
25897 the glyph property.
25899 Either none or exactly one of 4 or 5 must be present.
25901 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25902 of the stretch should be used for the ascent of the stretch.
25903 ASCENT must be in the range 0 <= ASCENT <= 100. */
25906 produce_stretch_glyph (struct it
*it
)
25908 /* (space :width WIDTH :height HEIGHT ...) */
25909 Lisp_Object prop
, plist
;
25910 int width
= 0, height
= 0, align_to
= -1;
25911 bool zero_width_ok_p
= false;
25913 struct font
*font
= NULL
;
25915 #ifdef HAVE_WINDOW_SYSTEM
25917 bool zero_height_ok_p
= false;
25919 if (FRAME_WINDOW_P (it
->f
))
25921 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25922 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25923 prepare_face_for_display (it
->f
, face
);
25927 /* List should start with `space'. */
25928 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25929 plist
= XCDR (it
->object
);
25931 /* Compute the width of the stretch. */
25932 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25933 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
25935 /* Absolute width `:width WIDTH' specified and valid. */
25936 zero_width_ok_p
= true;
25939 #ifdef HAVE_WINDOW_SYSTEM
25940 else if (FRAME_WINDOW_P (it
->f
)
25941 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25943 /* Relative width `:relative-width FACTOR' specified and valid.
25944 Compute the width of the characters having the `glyph'
25947 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25950 if (it
->multibyte_p
)
25951 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25954 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25955 if (! ASCII_CHAR_P (it2
.c
))
25956 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25959 it2
.glyph_row
= NULL
;
25960 it2
.what
= IT_CHARACTER
;
25961 x_produce_glyphs (&it2
);
25962 width
= NUMVAL (prop
) * it2
.pixel_width
;
25964 #endif /* HAVE_WINDOW_SYSTEM */
25965 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25966 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
25969 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25970 align_to
= (align_to
< 0
25972 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25973 else if (align_to
< 0)
25974 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25975 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25976 zero_width_ok_p
= true;
25979 /* Nothing specified -> width defaults to canonical char width. */
25980 width
= FRAME_COLUMN_WIDTH (it
->f
);
25982 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25985 #ifdef HAVE_WINDOW_SYSTEM
25986 /* Compute height. */
25987 if (FRAME_WINDOW_P (it
->f
))
25989 int default_height
= normal_char_height (font
, ' ');
25991 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25992 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
25995 zero_height_ok_p
= true;
25997 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25999 height
= default_height
* NUMVAL (prop
);
26001 height
= default_height
;
26003 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26006 /* Compute percentage of height used for ascent. If
26007 `:ascent ASCENT' is present and valid, use that. Otherwise,
26008 derive the ascent from the font in use. */
26009 if (prop
= Fplist_get (plist
, QCascent
),
26010 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26011 ascent
= height
* NUMVAL (prop
) / 100.0;
26012 else if (!NILP (prop
)
26013 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26014 ascent
= min (max (0, (int)tem
), height
);
26016 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26019 #endif /* HAVE_WINDOW_SYSTEM */
26022 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26023 && it
->current_x
+ width
> it
->last_visible_x
)
26025 width
= it
->last_visible_x
- it
->current_x
;
26026 #ifdef HAVE_WINDOW_SYSTEM
26027 /* Subtract one more pixel from the stretch width, but only on
26028 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26029 width
-= FRAME_WINDOW_P (it
->f
);
26033 if (width
> 0 && height
> 0 && it
->glyph_row
)
26035 Lisp_Object o_object
= it
->object
;
26036 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26039 if (!STRINGP (object
))
26040 object
= it
->w
->contents
;
26041 #ifdef HAVE_WINDOW_SYSTEM
26042 if (FRAME_WINDOW_P (it
->f
))
26043 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26047 it
->object
= object
;
26048 it
->char_to_display
= ' ';
26049 it
->pixel_width
= it
->len
= 1;
26051 tty_append_glyph (it
);
26052 it
->object
= o_object
;
26056 it
->pixel_width
= width
;
26057 #ifdef HAVE_WINDOW_SYSTEM
26058 if (FRAME_WINDOW_P (it
->f
))
26060 it
->ascent
= it
->phys_ascent
= ascent
;
26061 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26062 it
->nglyphs
= width
> 0 && height
> 0;
26063 take_vertical_position_into_account (it
);
26067 it
->nglyphs
= width
;
26070 /* Get information about special display element WHAT in an
26071 environment described by IT. WHAT is one of IT_TRUNCATION or
26072 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26073 non-null glyph_row member. This function ensures that fields like
26074 face_id, c, len of IT are left untouched. */
26077 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26084 temp_it
.object
= Qnil
;
26085 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26087 if (what
== IT_CONTINUATION
)
26089 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26090 if (it
->bidi_it
.paragraph_dir
== R2L
)
26091 SET_GLYPH_FROM_CHAR (glyph
, '/');
26093 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26095 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26097 /* FIXME: Should we mirror GC for R2L lines? */
26098 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26099 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26102 else if (what
== IT_TRUNCATION
)
26104 /* Truncation glyph. */
26105 SET_GLYPH_FROM_CHAR (glyph
, '$');
26107 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26109 /* FIXME: Should we mirror GC for R2L lines? */
26110 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26111 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26117 #ifdef HAVE_WINDOW_SYSTEM
26118 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26119 is turned off, we precede the truncation/continuation glyphs by a
26120 stretch glyph whose width is computed such that these special
26121 glyphs are aligned at the window margin, even when very different
26122 fonts are used in different glyph rows. */
26123 if (FRAME_WINDOW_P (temp_it
.f
)
26124 /* init_iterator calls this with it->glyph_row == NULL, and it
26125 wants only the pixel width of the truncation/continuation
26127 && temp_it
.glyph_row
26128 /* insert_left_trunc_glyphs calls us at the beginning of the
26129 row, and it has its own calculation of the stretch glyph
26131 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26132 && (temp_it
.glyph_row
->reversed_p
26133 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26134 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26136 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26138 if (stretch_width
> 0)
26140 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26141 struct font
*font
=
26142 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26143 int stretch_ascent
=
26144 (((temp_it
.ascent
+ temp_it
.descent
)
26145 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26147 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26148 temp_it
.ascent
+ temp_it
.descent
,
26155 temp_it
.what
= IT_CHARACTER
;
26156 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26157 temp_it
.face_id
= GLYPH_FACE (glyph
);
26158 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26160 PRODUCE_GLYPHS (&temp_it
);
26161 it
->pixel_width
= temp_it
.pixel_width
;
26162 it
->nglyphs
= temp_it
.nglyphs
;
26165 #ifdef HAVE_WINDOW_SYSTEM
26167 /* Calculate line-height and line-spacing properties.
26168 An integer value specifies explicit pixel value.
26169 A float value specifies relative value to current face height.
26170 A cons (float . face-name) specifies relative value to
26171 height of specified face font.
26173 Returns height in pixels, or nil. */
26176 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26177 int boff
, bool override
)
26179 Lisp_Object face_name
= Qnil
;
26180 int ascent
, descent
, height
;
26182 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26187 face_name
= XCAR (val
);
26189 if (!NUMBERP (val
))
26190 val
= make_number (1);
26191 if (NILP (face_name
))
26193 height
= it
->ascent
+ it
->descent
;
26198 if (NILP (face_name
))
26200 font
= FRAME_FONT (it
->f
);
26201 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26203 else if (EQ (face_name
, Qt
))
26212 face_id
= lookup_named_face (it
->f
, face_name
, false);
26214 return make_number (-1);
26216 face
= FACE_FROM_ID (it
->f
, face_id
);
26219 return make_number (-1);
26220 boff
= font
->baseline_offset
;
26221 if (font
->vertical_centering
)
26222 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26225 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26229 it
->override_ascent
= ascent
;
26230 it
->override_descent
= descent
;
26231 it
->override_boff
= boff
;
26234 height
= ascent
+ descent
;
26238 height
= (int)(XFLOAT_DATA (val
) * height
);
26239 else if (INTEGERP (val
))
26240 height
*= XINT (val
);
26242 return make_number (height
);
26246 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26247 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26248 and only if this is for a character for which no font was found.
26250 If the display method (it->glyphless_method) is
26251 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26252 length of the acronym or the hexadecimal string, UPPER_XOFF and
26253 UPPER_YOFF are pixel offsets for the upper part of the string,
26254 LOWER_XOFF and LOWER_YOFF are for the lower part.
26256 For the other display methods, LEN through LOWER_YOFF are zero. */
26259 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26260 short upper_xoff
, short upper_yoff
,
26261 short lower_xoff
, short lower_yoff
)
26263 struct glyph
*glyph
;
26264 enum glyph_row_area area
= it
->area
;
26266 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26267 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26269 /* If the glyph row is reversed, we need to prepend the glyph
26270 rather than append it. */
26271 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26275 /* Make room for the additional glyph. */
26276 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26278 glyph
= it
->glyph_row
->glyphs
[area
];
26280 glyph
->charpos
= CHARPOS (it
->position
);
26281 glyph
->object
= it
->object
;
26282 glyph
->pixel_width
= it
->pixel_width
;
26283 glyph
->ascent
= it
->ascent
;
26284 glyph
->descent
= it
->descent
;
26285 glyph
->voffset
= it
->voffset
;
26286 glyph
->type
= GLYPHLESS_GLYPH
;
26287 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26288 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26289 glyph
->u
.glyphless
.len
= len
;
26290 glyph
->u
.glyphless
.ch
= it
->c
;
26291 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26292 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26293 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26294 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26295 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26296 glyph
->multibyte_p
= it
->multibyte_p
;
26297 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26299 /* In R2L rows, the left and the right box edges need to be
26300 drawn in reverse direction. */
26301 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26302 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26306 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26307 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26309 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26310 || it
->phys_descent
> it
->descent
);
26311 glyph
->padding_p
= false;
26312 glyph
->glyph_not_available_p
= false;
26313 glyph
->face_id
= face_id
;
26314 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26317 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26318 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26319 glyph
->bidi_type
= it
->bidi_it
.type
;
26321 ++it
->glyph_row
->used
[area
];
26324 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26328 /* Produce a glyph for a glyphless character for iterator IT.
26329 IT->glyphless_method specifies which method to use for displaying
26330 the character. See the description of enum
26331 glyphless_display_method in dispextern.h for the detail.
26333 FOR_NO_FONT is true if and only if this is for a character for
26334 which no font was found. ACRONYM, if non-nil, is an acronym string
26335 for the character. */
26338 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26343 int base_width
, base_height
, width
, height
;
26344 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26347 /* Get the metrics of the base font. We always refer to the current
26349 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26350 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26351 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26352 it
->ascent
+= font
->baseline_offset
;
26353 it
->descent
-= font
->baseline_offset
;
26354 base_height
= it
->ascent
+ it
->descent
;
26355 base_width
= font
->average_width
;
26357 face_id
= merge_glyphless_glyph_face (it
);
26359 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26361 it
->pixel_width
= THIN_SPACE_WIDTH
;
26363 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26365 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26367 width
= CHAR_WIDTH (it
->c
);
26370 else if (width
> 4)
26372 it
->pixel_width
= base_width
* width
;
26374 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26380 unsigned int code
[6];
26382 int ascent
, descent
;
26383 struct font_metrics metrics_upper
, metrics_lower
;
26385 face
= FACE_FROM_ID (it
->f
, face_id
);
26386 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26387 prepare_face_for_display (it
->f
, face
);
26389 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26391 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26392 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26393 if (CONSP (acronym
))
26394 acronym
= XCAR (acronym
);
26395 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26399 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26400 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26403 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26404 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26405 upper_len
= (len
+ 1) / 2;
26406 font
->driver
->text_extents (font
, code
, upper_len
,
26408 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26413 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26414 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26415 upper_xoff
= upper_yoff
= 2; /* the typical case */
26416 if (base_width
>= width
)
26418 /* Align the upper to the left, the lower to the right. */
26419 it
->pixel_width
= base_width
;
26420 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26424 /* Center the shorter one. */
26425 it
->pixel_width
= width
;
26426 if (metrics_upper
.width
>= metrics_lower
.width
)
26427 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26430 /* FIXME: This code doesn't look right. It formerly was
26431 missing the "lower_xoff = 0;", which couldn't have
26432 been right since it left lower_xoff uninitialized. */
26434 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26438 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26439 top, bottom, and between upper and lower strings. */
26440 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26441 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26442 /* Center vertically.
26443 H:base_height, D:base_descent
26444 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26446 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26447 descent = D - H/2 + h/2;
26448 lower_yoff = descent - 2 - ld;
26449 upper_yoff = lower_yoff - la - 1 - ud; */
26450 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26451 descent
= it
->descent
- (base_height
- height
) / 2;
26452 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26453 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26454 - metrics_upper
.descent
);
26455 /* Don't make the height shorter than the base height. */
26456 if (height
> base_height
)
26458 it
->ascent
= ascent
;
26459 it
->descent
= descent
;
26463 it
->phys_ascent
= it
->ascent
;
26464 it
->phys_descent
= it
->descent
;
26466 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26467 upper_xoff
, upper_yoff
,
26468 lower_xoff
, lower_yoff
);
26470 take_vertical_position_into_account (it
);
26475 Produce glyphs/get display metrics for the display element IT is
26476 loaded with. See the description of struct it in dispextern.h
26477 for an overview of struct it. */
26480 x_produce_glyphs (struct it
*it
)
26482 int extra_line_spacing
= it
->extra_line_spacing
;
26484 it
->glyph_not_available_p
= false;
26486 if (it
->what
== IT_CHARACTER
)
26489 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26490 struct font
*font
= face
->font
;
26491 struct font_metrics
*pcm
= NULL
;
26492 int boff
; /* Baseline offset. */
26496 /* When no suitable font is found, display this character by
26497 the method specified in the first extra slot of
26498 Vglyphless_char_display. */
26499 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26501 eassert (it
->what
== IT_GLYPHLESS
);
26502 produce_glyphless_glyph (it
, true,
26503 STRINGP (acronym
) ? acronym
: Qnil
);
26507 boff
= font
->baseline_offset
;
26508 if (font
->vertical_centering
)
26509 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26511 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26515 if (it
->override_ascent
>= 0)
26517 it
->ascent
= it
->override_ascent
;
26518 it
->descent
= it
->override_descent
;
26519 boff
= it
->override_boff
;
26523 it
->ascent
= FONT_BASE (font
) + boff
;
26524 it
->descent
= FONT_DESCENT (font
) - boff
;
26527 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26529 pcm
= get_per_char_metric (font
, &char2b
);
26530 if (pcm
->width
== 0
26531 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26537 it
->phys_ascent
= pcm
->ascent
+ boff
;
26538 it
->phys_descent
= pcm
->descent
- boff
;
26539 it
->pixel_width
= pcm
->width
;
26540 /* Don't use font-global values for ascent and descent
26541 if they result in an exceedingly large line height. */
26542 if (it
->override_ascent
< 0)
26544 if (FONT_TOO_HIGH (font
))
26546 it
->ascent
= it
->phys_ascent
;
26547 it
->descent
= it
->phys_descent
;
26548 /* These limitations are enforced by an
26549 assertion near the end of this function. */
26550 if (it
->ascent
< 0)
26552 if (it
->descent
< 0)
26559 it
->glyph_not_available_p
= true;
26560 it
->phys_ascent
= it
->ascent
;
26561 it
->phys_descent
= it
->descent
;
26562 it
->pixel_width
= font
->space_width
;
26565 if (it
->constrain_row_ascent_descent_p
)
26567 if (it
->descent
> it
->max_descent
)
26569 it
->ascent
+= it
->descent
- it
->max_descent
;
26570 it
->descent
= it
->max_descent
;
26572 if (it
->ascent
> it
->max_ascent
)
26574 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26575 it
->ascent
= it
->max_ascent
;
26577 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26578 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26579 extra_line_spacing
= 0;
26582 /* If this is a space inside a region of text with
26583 `space-width' property, change its width. */
26585 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26587 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26589 /* If face has a box, add the box thickness to the character
26590 height. If character has a box line to the left and/or
26591 right, add the box line width to the character's width. */
26592 if (face
->box
!= FACE_NO_BOX
)
26594 int thick
= face
->box_line_width
;
26598 it
->ascent
+= thick
;
26599 it
->descent
+= thick
;
26604 if (it
->start_of_box_run_p
)
26605 it
->pixel_width
+= thick
;
26606 if (it
->end_of_box_run_p
)
26607 it
->pixel_width
+= thick
;
26610 /* If face has an overline, add the height of the overline
26611 (1 pixel) and a 1 pixel margin to the character height. */
26612 if (face
->overline_p
)
26613 it
->ascent
+= overline_margin
;
26615 if (it
->constrain_row_ascent_descent_p
)
26617 if (it
->ascent
> it
->max_ascent
)
26618 it
->ascent
= it
->max_ascent
;
26619 if (it
->descent
> it
->max_descent
)
26620 it
->descent
= it
->max_descent
;
26623 take_vertical_position_into_account (it
);
26625 /* If we have to actually produce glyphs, do it. */
26630 /* Translate a space with a `space-width' property
26631 into a stretch glyph. */
26632 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26633 / FONT_HEIGHT (font
));
26634 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26635 it
->ascent
+ it
->descent
, ascent
);
26640 /* If characters with lbearing or rbearing are displayed
26641 in this line, record that fact in a flag of the
26642 glyph row. This is used to optimize X output code. */
26643 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26644 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26646 if (! stretched_p
&& it
->pixel_width
== 0)
26647 /* We assure that all visible glyphs have at least 1-pixel
26649 it
->pixel_width
= 1;
26651 else if (it
->char_to_display
== '\n')
26653 /* A newline has no width, but we need the height of the
26654 line. But if previous part of the line sets a height,
26655 don't increase that height. */
26657 Lisp_Object height
;
26658 Lisp_Object total_height
= Qnil
;
26660 it
->override_ascent
= -1;
26661 it
->pixel_width
= 0;
26664 height
= get_it_property (it
, Qline_height
);
26665 /* Split (line-height total-height) list. */
26667 && CONSP (XCDR (height
))
26668 && NILP (XCDR (XCDR (height
))))
26670 total_height
= XCAR (XCDR (height
));
26671 height
= XCAR (height
);
26673 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26675 if (it
->override_ascent
>= 0)
26677 it
->ascent
= it
->override_ascent
;
26678 it
->descent
= it
->override_descent
;
26679 boff
= it
->override_boff
;
26683 if (FONT_TOO_HIGH (font
))
26685 it
->ascent
= font
->pixel_size
+ boff
- 1;
26686 it
->descent
= -boff
+ 1;
26687 if (it
->descent
< 0)
26692 it
->ascent
= FONT_BASE (font
) + boff
;
26693 it
->descent
= FONT_DESCENT (font
) - boff
;
26697 if (EQ (height
, Qt
))
26699 if (it
->descent
> it
->max_descent
)
26701 it
->ascent
+= it
->descent
- it
->max_descent
;
26702 it
->descent
= it
->max_descent
;
26704 if (it
->ascent
> it
->max_ascent
)
26706 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26707 it
->ascent
= it
->max_ascent
;
26709 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26710 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26711 it
->constrain_row_ascent_descent_p
= true;
26712 extra_line_spacing
= 0;
26716 Lisp_Object spacing
;
26718 it
->phys_ascent
= it
->ascent
;
26719 it
->phys_descent
= it
->descent
;
26721 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26722 && face
->box
!= FACE_NO_BOX
26723 && face
->box_line_width
> 0)
26725 it
->ascent
+= face
->box_line_width
;
26726 it
->descent
+= face
->box_line_width
;
26729 && XINT (height
) > it
->ascent
+ it
->descent
)
26730 it
->ascent
= XINT (height
) - it
->descent
;
26732 if (!NILP (total_height
))
26733 spacing
= calc_line_height_property (it
, total_height
, font
,
26737 spacing
= get_it_property (it
, Qline_spacing
);
26738 spacing
= calc_line_height_property (it
, spacing
, font
,
26741 if (INTEGERP (spacing
))
26743 extra_line_spacing
= XINT (spacing
);
26744 if (!NILP (total_height
))
26745 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26749 else /* i.e. (it->char_to_display == '\t') */
26751 if (font
->space_width
> 0)
26753 int tab_width
= it
->tab_width
* font
->space_width
;
26754 int x
= it
->current_x
+ it
->continuation_lines_width
;
26755 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26757 /* If the distance from the current position to the next tab
26758 stop is less than a space character width, use the
26759 tab stop after that. */
26760 if (next_tab_x
- x
< font
->space_width
)
26761 next_tab_x
+= tab_width
;
26763 it
->pixel_width
= next_tab_x
- x
;
26765 if (FONT_TOO_HIGH (font
))
26767 if (get_char_glyph_code (' ', font
, &char2b
))
26769 pcm
= get_per_char_metric (font
, &char2b
);
26770 if (pcm
->width
== 0
26771 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26777 it
->ascent
= pcm
->ascent
+ boff
;
26778 it
->descent
= pcm
->descent
- boff
;
26782 it
->ascent
= font
->pixel_size
+ boff
- 1;
26783 it
->descent
= -boff
+ 1;
26785 if (it
->ascent
< 0)
26787 if (it
->descent
< 0)
26792 it
->ascent
= FONT_BASE (font
) + boff
;
26793 it
->descent
= FONT_DESCENT (font
) - boff
;
26795 it
->phys_ascent
= it
->ascent
;
26796 it
->phys_descent
= it
->descent
;
26800 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26801 it
->ascent
+ it
->descent
, it
->ascent
);
26806 it
->pixel_width
= 0;
26811 if (FONT_TOO_HIGH (font
))
26813 int font_ascent
, font_descent
;
26815 /* For very large fonts, where we ignore the declared font
26816 dimensions, and go by per-character metrics instead,
26817 don't let the row ascent and descent values (and the row
26818 height computed from them) be smaller than the "normal"
26819 character metrics. This avoids unpleasant effects
26820 whereby lines on display would change their height
26821 depending on which characters are shown. */
26822 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26823 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26824 it
->max_descent
= max (it
->max_descent
, font_descent
);
26827 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26829 /* A static composition.
26831 Note: A composition is represented as one glyph in the
26832 glyph matrix. There are no padding glyphs.
26834 Important note: pixel_width, ascent, and descent are the
26835 values of what is drawn by draw_glyphs (i.e. the values of
26836 the overall glyphs composed). */
26837 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26838 int boff
; /* baseline offset */
26839 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26840 int glyph_len
= cmp
->glyph_len
;
26841 struct font
*font
= face
->font
;
26845 /* If we have not yet calculated pixel size data of glyphs of
26846 the composition for the current face font, calculate them
26847 now. Theoretically, we have to check all fonts for the
26848 glyphs, but that requires much time and memory space. So,
26849 here we check only the font of the first glyph. This may
26850 lead to incorrect display, but it's very rare, and C-l
26851 (recenter-top-bottom) can correct the display anyway. */
26852 if (! cmp
->font
|| cmp
->font
!= font
)
26854 /* Ascent and descent of the font of the first character
26855 of this composition (adjusted by baseline offset).
26856 Ascent and descent of overall glyphs should not be less
26857 than these, respectively. */
26858 int font_ascent
, font_descent
, font_height
;
26859 /* Bounding box of the overall glyphs. */
26860 int leftmost
, rightmost
, lowest
, highest
;
26861 int lbearing
, rbearing
;
26862 int i
, width
, ascent
, descent
;
26863 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26865 struct font_metrics
*pcm
;
26868 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26869 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26871 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26872 for (i
= 0; i
< glyph_len
; i
++)
26874 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26876 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26878 bool left_padded
= i
> 0;
26880 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26881 : IT_CHARPOS (*it
));
26882 /* If no suitable font is found, use the default font. */
26883 bool font_not_found_p
= font
== NULL
;
26884 if (font_not_found_p
)
26886 face
= face
->ascii_face
;
26889 boff
= font
->baseline_offset
;
26890 if (font
->vertical_centering
)
26891 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26892 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26893 font_ascent
+= boff
;
26894 font_descent
-= boff
;
26895 font_height
= font_ascent
+ font_descent
;
26900 if (! font_not_found_p
)
26902 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26904 pcm
= get_per_char_metric (font
, &char2b
);
26907 /* Initialize the bounding box. */
26910 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26911 ascent
= pcm
->ascent
;
26912 descent
= pcm
->descent
;
26913 lbearing
= pcm
->lbearing
;
26914 rbearing
= pcm
->rbearing
;
26918 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26919 ascent
= FONT_BASE (font
);
26920 descent
= FONT_DESCENT (font
);
26927 lowest
= - descent
+ boff
;
26928 highest
= ascent
+ boff
;
26930 if (! font_not_found_p
26931 && font
->default_ascent
26932 && CHAR_TABLE_P (Vuse_default_ascent
)
26933 && !NILP (Faref (Vuse_default_ascent
,
26934 make_number (it
->char_to_display
))))
26935 highest
= font
->default_ascent
+ boff
;
26937 /* Draw the first glyph at the normal position. It may be
26938 shifted to right later if some other glyphs are drawn
26940 cmp
->offsets
[i
* 2] = 0;
26941 cmp
->offsets
[i
* 2 + 1] = boff
;
26942 cmp
->lbearing
= lbearing
;
26943 cmp
->rbearing
= rbearing
;
26945 /* Set cmp->offsets for the remaining glyphs. */
26946 for (i
++; i
< glyph_len
; i
++)
26948 int left
, right
, btm
, top
;
26949 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26951 struct face
*this_face
;
26955 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26956 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26957 font
= this_face
->font
;
26963 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26965 pcm
= get_per_char_metric (font
, &char2b
);
26968 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26971 width
= pcm
->width
;
26972 ascent
= pcm
->ascent
;
26973 descent
= pcm
->descent
;
26974 lbearing
= pcm
->lbearing
;
26975 rbearing
= pcm
->rbearing
;
26976 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26978 /* Relative composition with or without
26979 alternate chars. */
26980 left
= (leftmost
+ rightmost
- width
) / 2;
26981 btm
= - descent
+ boff
;
26982 if (font
->relative_compose
26983 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26984 || NILP (Faref (Vignore_relative_composition
,
26985 make_number (ch
)))))
26988 if (- descent
>= font
->relative_compose
)
26989 /* One extra pixel between two glyphs. */
26991 else if (ascent
<= 0)
26992 /* One extra pixel between two glyphs. */
26993 btm
= lowest
- 1 - ascent
- descent
;
26998 /* A composition rule is specified by an integer
26999 value that encodes global and new reference
27000 points (GREF and NREF). GREF and NREF are
27001 specified by numbers as below:
27003 0---1---2 -- ascent
27007 9--10--11 -- center
27009 ---3---4---5--- baseline
27011 6---7---8 -- descent
27013 int rule
= COMPOSITION_RULE (cmp
, i
);
27014 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27016 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27017 grefx
= gref
% 3, nrefx
= nref
% 3;
27018 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27020 xoff
= font_height
* (xoff
- 128) / 256;
27022 yoff
= font_height
* (yoff
- 128) / 256;
27025 + grefx
* (rightmost
- leftmost
) / 2
27026 - nrefx
* width
/ 2
27029 btm
= ((grefy
== 0 ? highest
27031 : grefy
== 2 ? lowest
27032 : (highest
+ lowest
) / 2)
27033 - (nrefy
== 0 ? ascent
+ descent
27034 : nrefy
== 1 ? descent
- boff
27036 : (ascent
+ descent
) / 2)
27040 cmp
->offsets
[i
* 2] = left
;
27041 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27043 /* Update the bounding box of the overall glyphs. */
27046 right
= left
+ width
;
27047 if (left
< leftmost
)
27049 if (right
> rightmost
)
27052 top
= btm
+ descent
+ ascent
;
27058 if (cmp
->lbearing
> left
+ lbearing
)
27059 cmp
->lbearing
= left
+ lbearing
;
27060 if (cmp
->rbearing
< left
+ rbearing
)
27061 cmp
->rbearing
= left
+ rbearing
;
27065 /* If there are glyphs whose x-offsets are negative,
27066 shift all glyphs to the right and make all x-offsets
27070 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27071 cmp
->offsets
[i
* 2] -= leftmost
;
27072 rightmost
-= leftmost
;
27073 cmp
->lbearing
-= leftmost
;
27074 cmp
->rbearing
-= leftmost
;
27077 if (left_padded
&& cmp
->lbearing
< 0)
27079 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27080 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27081 rightmost
-= cmp
->lbearing
;
27082 cmp
->rbearing
-= cmp
->lbearing
;
27085 if (right_padded
&& rightmost
< cmp
->rbearing
)
27087 rightmost
= cmp
->rbearing
;
27090 cmp
->pixel_width
= rightmost
;
27091 cmp
->ascent
= highest
;
27092 cmp
->descent
= - lowest
;
27093 if (cmp
->ascent
< font_ascent
)
27094 cmp
->ascent
= font_ascent
;
27095 if (cmp
->descent
< font_descent
)
27096 cmp
->descent
= font_descent
;
27100 && (cmp
->lbearing
< 0
27101 || cmp
->rbearing
> cmp
->pixel_width
))
27102 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27104 it
->pixel_width
= cmp
->pixel_width
;
27105 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27106 it
->descent
= it
->phys_descent
= cmp
->descent
;
27107 if (face
->box
!= FACE_NO_BOX
)
27109 int thick
= face
->box_line_width
;
27113 it
->ascent
+= thick
;
27114 it
->descent
+= thick
;
27119 if (it
->start_of_box_run_p
)
27120 it
->pixel_width
+= thick
;
27121 if (it
->end_of_box_run_p
)
27122 it
->pixel_width
+= thick
;
27125 /* If face has an overline, add the height of the overline
27126 (1 pixel) and a 1 pixel margin to the character height. */
27127 if (face
->overline_p
)
27128 it
->ascent
+= overline_margin
;
27130 take_vertical_position_into_account (it
);
27131 if (it
->ascent
< 0)
27133 if (it
->descent
< 0)
27136 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27137 append_composite_glyph (it
);
27139 else if (it
->what
== IT_COMPOSITION
)
27141 /* A dynamic (automatic) composition. */
27142 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27143 Lisp_Object gstring
;
27144 struct font_metrics metrics
;
27148 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27150 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27153 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27154 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27155 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27156 it
->descent
= it
->phys_descent
= metrics
.descent
;
27157 if (face
->box
!= FACE_NO_BOX
)
27159 int thick
= face
->box_line_width
;
27163 it
->ascent
+= thick
;
27164 it
->descent
+= thick
;
27169 if (it
->start_of_box_run_p
)
27170 it
->pixel_width
+= thick
;
27171 if (it
->end_of_box_run_p
)
27172 it
->pixel_width
+= thick
;
27174 /* If face has an overline, add the height of the overline
27175 (1 pixel) and a 1 pixel margin to the character height. */
27176 if (face
->overline_p
)
27177 it
->ascent
+= overline_margin
;
27178 take_vertical_position_into_account (it
);
27179 if (it
->ascent
< 0)
27181 if (it
->descent
< 0)
27185 append_composite_glyph (it
);
27187 else if (it
->what
== IT_GLYPHLESS
)
27188 produce_glyphless_glyph (it
, false, Qnil
);
27189 else if (it
->what
== IT_IMAGE
)
27190 produce_image_glyph (it
);
27191 else if (it
->what
== IT_STRETCH
)
27192 produce_stretch_glyph (it
);
27195 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27196 because this isn't true for images with `:ascent 100'. */
27197 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27198 if (it
->area
== TEXT_AREA
)
27199 it
->current_x
+= it
->pixel_width
;
27201 if (extra_line_spacing
> 0)
27203 it
->descent
+= extra_line_spacing
;
27204 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27205 it
->max_extra_line_spacing
= extra_line_spacing
;
27208 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27209 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27210 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27211 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27215 Output LEN glyphs starting at START at the nominal cursor position.
27216 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27217 being updated, and UPDATED_AREA is the area of that row being updated. */
27220 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27221 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27223 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27225 eassert (updated_row
);
27226 /* When the window is hscrolled, cursor hpos can legitimately be out
27227 of bounds, but we draw the cursor at the corresponding window
27228 margin in that case. */
27229 if (!updated_row
->reversed_p
&& chpos
< 0)
27231 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27232 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27236 /* Write glyphs. */
27238 hpos
= start
- updated_row
->glyphs
[updated_area
];
27239 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27240 updated_row
, updated_area
,
27242 DRAW_NORMAL_TEXT
, 0);
27244 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27245 if (updated_area
== TEXT_AREA
27246 && w
->phys_cursor_on_p
27247 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27249 && chpos
< hpos
+ len
)
27250 w
->phys_cursor_on_p
= false;
27254 /* Advance the output cursor. */
27255 w
->output_cursor
.hpos
+= len
;
27256 w
->output_cursor
.x
= x
;
27261 Insert LEN glyphs from START at the nominal cursor position. */
27264 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27265 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27268 int line_height
, shift_by_width
, shifted_region_width
;
27269 struct glyph_row
*row
;
27270 struct glyph
*glyph
;
27271 int frame_x
, frame_y
;
27274 eassert (updated_row
);
27276 f
= XFRAME (WINDOW_FRAME (w
));
27278 /* Get the height of the line we are in. */
27280 line_height
= row
->height
;
27282 /* Get the width of the glyphs to insert. */
27283 shift_by_width
= 0;
27284 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27285 shift_by_width
+= glyph
->pixel_width
;
27287 /* Get the width of the region to shift right. */
27288 shifted_region_width
= (window_box_width (w
, updated_area
)
27289 - w
->output_cursor
.x
27293 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27294 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27296 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27297 line_height
, shift_by_width
);
27299 /* Write the glyphs. */
27300 hpos
= start
- row
->glyphs
[updated_area
];
27301 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27303 DRAW_NORMAL_TEXT
, 0);
27305 /* Advance the output cursor. */
27306 w
->output_cursor
.hpos
+= len
;
27307 w
->output_cursor
.x
+= shift_by_width
;
27313 Erase the current text line from the nominal cursor position
27314 (inclusive) to pixel column TO_X (exclusive). The idea is that
27315 everything from TO_X onward is already erased.
27317 TO_X is a pixel position relative to UPDATED_AREA of currently
27318 updated window W. TO_X == -1 means clear to the end of this area. */
27321 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27322 enum glyph_row_area updated_area
, int to_x
)
27325 int max_x
, min_y
, max_y
;
27326 int from_x
, from_y
, to_y
;
27328 eassert (updated_row
);
27329 f
= XFRAME (w
->frame
);
27331 if (updated_row
->full_width_p
)
27332 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27333 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27335 max_x
= window_box_width (w
, updated_area
);
27336 max_y
= window_text_bottom_y (w
);
27338 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27339 of window. For TO_X > 0, truncate to end of drawing area. */
27345 to_x
= min (to_x
, max_x
);
27347 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27349 /* Notice if the cursor will be cleared by this operation. */
27350 if (!updated_row
->full_width_p
)
27351 notice_overwritten_cursor (w
, updated_area
,
27352 w
->output_cursor
.x
, -1,
27354 MATRIX_ROW_BOTTOM_Y (updated_row
));
27356 from_x
= w
->output_cursor
.x
;
27358 /* Translate to frame coordinates. */
27359 if (updated_row
->full_width_p
)
27361 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27362 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27366 int area_left
= window_box_left (w
, updated_area
);
27367 from_x
+= area_left
;
27371 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27372 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27373 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27375 /* Prevent inadvertently clearing to end of the X window. */
27376 if (to_x
> from_x
&& to_y
> from_y
)
27379 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27380 to_x
- from_x
, to_y
- from_y
);
27385 #endif /* HAVE_WINDOW_SYSTEM */
27389 /***********************************************************************
27391 ***********************************************************************/
27393 /* Value is the internal representation of the specified cursor type
27394 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27395 of the bar cursor. */
27397 static enum text_cursor_kinds
27398 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27400 enum text_cursor_kinds type
;
27405 if (EQ (arg
, Qbox
))
27406 return FILLED_BOX_CURSOR
;
27408 if (EQ (arg
, Qhollow
))
27409 return HOLLOW_BOX_CURSOR
;
27411 if (EQ (arg
, Qbar
))
27418 && EQ (XCAR (arg
), Qbar
)
27419 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27421 *width
= XINT (XCDR (arg
));
27425 if (EQ (arg
, Qhbar
))
27428 return HBAR_CURSOR
;
27432 && EQ (XCAR (arg
), Qhbar
)
27433 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27435 *width
= XINT (XCDR (arg
));
27436 return HBAR_CURSOR
;
27439 /* Treat anything unknown as "hollow box cursor".
27440 It was bad to signal an error; people have trouble fixing
27441 .Xdefaults with Emacs, when it has something bad in it. */
27442 type
= HOLLOW_BOX_CURSOR
;
27447 /* Set the default cursor types for specified frame. */
27449 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27454 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27455 FRAME_CURSOR_WIDTH (f
) = width
;
27457 /* By default, set up the blink-off state depending on the on-state. */
27459 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27462 FRAME_BLINK_OFF_CURSOR (f
)
27463 = get_specified_cursor_type (XCDR (tem
), &width
);
27464 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27467 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27469 /* Make sure the cursor gets redrawn. */
27470 f
->cursor_type_changed
= true;
27474 #ifdef HAVE_WINDOW_SYSTEM
27476 /* Return the cursor we want to be displayed in window W. Return
27477 width of bar/hbar cursor through WIDTH arg. Return with
27478 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27479 (i.e. if the `system caret' should track this cursor).
27481 In a mini-buffer window, we want the cursor only to appear if we
27482 are reading input from this window. For the selected window, we
27483 want the cursor type given by the frame parameter or buffer local
27484 setting of cursor-type. If explicitly marked off, draw no cursor.
27485 In all other cases, we want a hollow box cursor. */
27487 static enum text_cursor_kinds
27488 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27489 bool *active_cursor
)
27491 struct frame
*f
= XFRAME (w
->frame
);
27492 struct buffer
*b
= XBUFFER (w
->contents
);
27493 int cursor_type
= DEFAULT_CURSOR
;
27494 Lisp_Object alt_cursor
;
27495 bool non_selected
= false;
27497 *active_cursor
= true;
27500 if (cursor_in_echo_area
27501 && FRAME_HAS_MINIBUF_P (f
)
27502 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27504 if (w
== XWINDOW (echo_area_window
))
27506 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27508 *width
= FRAME_CURSOR_WIDTH (f
);
27509 return FRAME_DESIRED_CURSOR (f
);
27512 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27515 *active_cursor
= false;
27516 non_selected
= true;
27519 /* Detect a nonselected window or nonselected frame. */
27520 else if (w
!= XWINDOW (f
->selected_window
)
27521 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27523 *active_cursor
= false;
27525 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27528 non_selected
= true;
27531 /* Never display a cursor in a window in which cursor-type is nil. */
27532 if (NILP (BVAR (b
, cursor_type
)))
27535 /* Get the normal cursor type for this window. */
27536 if (EQ (BVAR (b
, cursor_type
), Qt
))
27538 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27539 *width
= FRAME_CURSOR_WIDTH (f
);
27542 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27544 /* Use cursor-in-non-selected-windows instead
27545 for non-selected window or frame. */
27548 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27549 if (!EQ (Qt
, alt_cursor
))
27550 return get_specified_cursor_type (alt_cursor
, width
);
27551 /* t means modify the normal cursor type. */
27552 if (cursor_type
== FILLED_BOX_CURSOR
)
27553 cursor_type
= HOLLOW_BOX_CURSOR
;
27554 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27556 return cursor_type
;
27559 /* Use normal cursor if not blinked off. */
27560 if (!w
->cursor_off_p
)
27562 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27564 if (cursor_type
== FILLED_BOX_CURSOR
)
27566 /* Using a block cursor on large images can be very annoying.
27567 So use a hollow cursor for "large" images.
27568 If image is not transparent (no mask), also use hollow cursor. */
27569 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27570 if (img
!= NULL
&& IMAGEP (img
->spec
))
27572 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27573 where N = size of default frame font size.
27574 This should cover most of the "tiny" icons people may use. */
27576 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27577 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27578 cursor_type
= HOLLOW_BOX_CURSOR
;
27581 else if (cursor_type
!= NO_CURSOR
)
27583 /* Display current only supports BOX and HOLLOW cursors for images.
27584 So for now, unconditionally use a HOLLOW cursor when cursor is
27585 not a solid box cursor. */
27586 cursor_type
= HOLLOW_BOX_CURSOR
;
27589 return cursor_type
;
27592 /* Cursor is blinked off, so determine how to "toggle" it. */
27594 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27595 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27596 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27598 /* Then see if frame has specified a specific blink off cursor type. */
27599 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27601 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27602 return FRAME_BLINK_OFF_CURSOR (f
);
27606 /* Some people liked having a permanently visible blinking cursor,
27607 while others had very strong opinions against it. So it was
27608 decided to remove it. KFS 2003-09-03 */
27610 /* Finally perform built-in cursor blinking:
27611 filled box <-> hollow box
27612 wide [h]bar <-> narrow [h]bar
27613 narrow [h]bar <-> no cursor
27614 other type <-> no cursor */
27616 if (cursor_type
== FILLED_BOX_CURSOR
)
27617 return HOLLOW_BOX_CURSOR
;
27619 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27622 return cursor_type
;
27630 /* Notice when the text cursor of window W has been completely
27631 overwritten by a drawing operation that outputs glyphs in AREA
27632 starting at X0 and ending at X1 in the line starting at Y0 and
27633 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27634 the rest of the line after X0 has been written. Y coordinates
27635 are window-relative. */
27638 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27639 int x0
, int x1
, int y0
, int y1
)
27641 int cx0
, cx1
, cy0
, cy1
;
27642 struct glyph_row
*row
;
27644 if (!w
->phys_cursor_on_p
)
27646 if (area
!= TEXT_AREA
)
27649 if (w
->phys_cursor
.vpos
< 0
27650 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27651 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27652 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27655 if (row
->cursor_in_fringe_p
)
27657 row
->cursor_in_fringe_p
= false;
27658 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27659 w
->phys_cursor_on_p
= false;
27663 cx0
= w
->phys_cursor
.x
;
27664 cx1
= cx0
+ w
->phys_cursor_width
;
27665 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27668 /* The cursor image will be completely removed from the
27669 screen if the output area intersects the cursor area in
27670 y-direction. When we draw in [y0 y1[, and some part of
27671 the cursor is at y < y0, that part must have been drawn
27672 before. When scrolling, the cursor is erased before
27673 actually scrolling, so we don't come here. When not
27674 scrolling, the rows above the old cursor row must have
27675 changed, and in this case these rows must have written
27676 over the cursor image.
27678 Likewise if part of the cursor is below y1, with the
27679 exception of the cursor being in the first blank row at
27680 the buffer and window end because update_text_area
27681 doesn't draw that row. (Except when it does, but
27682 that's handled in update_text_area.) */
27684 cy0
= w
->phys_cursor
.y
;
27685 cy1
= cy0
+ w
->phys_cursor_height
;
27686 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27689 w
->phys_cursor_on_p
= false;
27692 #endif /* HAVE_WINDOW_SYSTEM */
27695 /************************************************************************
27697 ************************************************************************/
27699 #ifdef HAVE_WINDOW_SYSTEM
27702 Fix the display of area AREA of overlapping row ROW in window W
27703 with respect to the overlapping part OVERLAPS. */
27706 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27707 enum glyph_row_area area
, int overlaps
)
27714 for (i
= 0; i
< row
->used
[area
];)
27716 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27718 int start
= i
, start_x
= x
;
27722 x
+= row
->glyphs
[area
][i
].pixel_width
;
27725 while (i
< row
->used
[area
]
27726 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27728 draw_glyphs (w
, start_x
, row
, area
,
27730 DRAW_NORMAL_TEXT
, overlaps
);
27734 x
+= row
->glyphs
[area
][i
].pixel_width
;
27744 Draw the cursor glyph of window W in glyph row ROW. See the
27745 comment of draw_glyphs for the meaning of HL. */
27748 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27749 enum draw_glyphs_face hl
)
27751 /* If cursor hpos is out of bounds, don't draw garbage. This can
27752 happen in mini-buffer windows when switching between echo area
27753 glyphs and mini-buffer. */
27754 if ((row
->reversed_p
27755 ? (w
->phys_cursor
.hpos
>= 0)
27756 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27758 bool on_p
= w
->phys_cursor_on_p
;
27760 int hpos
= w
->phys_cursor
.hpos
;
27762 /* When the window is hscrolled, cursor hpos can legitimately be
27763 out of bounds, but we draw the cursor at the corresponding
27764 window margin in that case. */
27765 if (!row
->reversed_p
&& hpos
< 0)
27767 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27768 hpos
= row
->used
[TEXT_AREA
] - 1;
27770 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27772 w
->phys_cursor_on_p
= on_p
;
27774 if (hl
== DRAW_CURSOR
)
27775 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27776 /* When we erase the cursor, and ROW is overlapped by other
27777 rows, make sure that these overlapping parts of other rows
27779 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27781 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27783 if (row
> w
->current_matrix
->rows
27784 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27785 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27786 OVERLAPS_ERASED_CURSOR
);
27788 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27789 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27790 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27791 OVERLAPS_ERASED_CURSOR
);
27797 /* Erase the image of a cursor of window W from the screen. */
27800 erase_phys_cursor (struct window
*w
)
27802 struct frame
*f
= XFRAME (w
->frame
);
27803 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27804 int hpos
= w
->phys_cursor
.hpos
;
27805 int vpos
= w
->phys_cursor
.vpos
;
27806 bool mouse_face_here_p
= false;
27807 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27808 struct glyph_row
*cursor_row
;
27809 struct glyph
*cursor_glyph
;
27810 enum draw_glyphs_face hl
;
27812 /* No cursor displayed or row invalidated => nothing to do on the
27814 if (w
->phys_cursor_type
== NO_CURSOR
)
27815 goto mark_cursor_off
;
27817 /* VPOS >= active_glyphs->nrows means that window has been resized.
27818 Don't bother to erase the cursor. */
27819 if (vpos
>= active_glyphs
->nrows
)
27820 goto mark_cursor_off
;
27822 /* If row containing cursor is marked invalid, there is nothing we
27824 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27825 if (!cursor_row
->enabled_p
)
27826 goto mark_cursor_off
;
27828 /* If line spacing is > 0, old cursor may only be partially visible in
27829 window after split-window. So adjust visible height. */
27830 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27831 window_text_bottom_y (w
) - cursor_row
->y
);
27833 /* If row is completely invisible, don't attempt to delete a cursor which
27834 isn't there. This can happen if cursor is at top of a window, and
27835 we switch to a buffer with a header line in that window. */
27836 if (cursor_row
->visible_height
<= 0)
27837 goto mark_cursor_off
;
27839 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27840 if (cursor_row
->cursor_in_fringe_p
)
27842 cursor_row
->cursor_in_fringe_p
= false;
27843 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27844 goto mark_cursor_off
;
27847 /* This can happen when the new row is shorter than the old one.
27848 In this case, either draw_glyphs or clear_end_of_line
27849 should have cleared the cursor. Note that we wouldn't be
27850 able to erase the cursor in this case because we don't have a
27851 cursor glyph at hand. */
27852 if ((cursor_row
->reversed_p
27853 ? (w
->phys_cursor
.hpos
< 0)
27854 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27855 goto mark_cursor_off
;
27857 /* When the window is hscrolled, cursor hpos can legitimately be out
27858 of bounds, but we draw the cursor at the corresponding window
27859 margin in that case. */
27860 if (!cursor_row
->reversed_p
&& hpos
< 0)
27862 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27863 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27865 /* If the cursor is in the mouse face area, redisplay that when
27866 we clear the cursor. */
27867 if (! NILP (hlinfo
->mouse_face_window
)
27868 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27869 /* Don't redraw the cursor's spot in mouse face if it is at the
27870 end of a line (on a newline). The cursor appears there, but
27871 mouse highlighting does not. */
27872 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27873 mouse_face_here_p
= true;
27875 /* Maybe clear the display under the cursor. */
27876 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27879 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27882 cursor_glyph
= get_phys_cursor_glyph (w
);
27883 if (cursor_glyph
== NULL
)
27884 goto mark_cursor_off
;
27886 width
= cursor_glyph
->pixel_width
;
27887 x
= w
->phys_cursor
.x
;
27893 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27894 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27895 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27898 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27901 /* Erase the cursor by redrawing the character underneath it. */
27902 if (mouse_face_here_p
)
27903 hl
= DRAW_MOUSE_FACE
;
27905 hl
= DRAW_NORMAL_TEXT
;
27906 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27909 w
->phys_cursor_on_p
= false;
27910 w
->phys_cursor_type
= NO_CURSOR
;
27914 /* Display or clear cursor of window W. If !ON, clear the cursor.
27915 If ON, display the cursor; where to put the cursor is specified by
27916 HPOS, VPOS, X and Y. */
27919 display_and_set_cursor (struct window
*w
, bool on
,
27920 int hpos
, int vpos
, int x
, int y
)
27922 struct frame
*f
= XFRAME (w
->frame
);
27923 int new_cursor_type
;
27924 int new_cursor_width
;
27925 bool active_cursor
;
27926 struct glyph_row
*glyph_row
;
27927 struct glyph
*glyph
;
27929 /* This is pointless on invisible frames, and dangerous on garbaged
27930 windows and frames; in the latter case, the frame or window may
27931 be in the midst of changing its size, and x and y may be off the
27933 if (! FRAME_VISIBLE_P (f
)
27934 || FRAME_GARBAGED_P (f
)
27935 || vpos
>= w
->current_matrix
->nrows
27936 || hpos
>= w
->current_matrix
->matrix_w
)
27939 /* If cursor is off and we want it off, return quickly. */
27940 if (!on
&& !w
->phys_cursor_on_p
)
27943 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27944 /* If cursor row is not enabled, we don't really know where to
27945 display the cursor. */
27946 if (!glyph_row
->enabled_p
)
27948 w
->phys_cursor_on_p
= false;
27953 if (!glyph_row
->exact_window_width_line_p
27954 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27955 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27957 eassert (input_blocked_p ());
27959 /* Set new_cursor_type to the cursor we want to be displayed. */
27960 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27961 &new_cursor_width
, &active_cursor
);
27963 /* If cursor is currently being shown and we don't want it to be or
27964 it is in the wrong place, or the cursor type is not what we want,
27966 if (w
->phys_cursor_on_p
27968 || w
->phys_cursor
.x
!= x
27969 || w
->phys_cursor
.y
!= y
27970 /* HPOS can be negative in R2L rows whose
27971 exact_window_width_line_p flag is set (i.e. their newline
27972 would "overflow into the fringe"). */
27974 || new_cursor_type
!= w
->phys_cursor_type
27975 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27976 && new_cursor_width
!= w
->phys_cursor_width
)))
27977 erase_phys_cursor (w
);
27979 /* Don't check phys_cursor_on_p here because that flag is only set
27980 to false in some cases where we know that the cursor has been
27981 completely erased, to avoid the extra work of erasing the cursor
27982 twice. In other words, phys_cursor_on_p can be true and the cursor
27983 still not be visible, or it has only been partly erased. */
27986 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27987 w
->phys_cursor_height
= glyph_row
->height
;
27989 /* Set phys_cursor_.* before x_draw_.* is called because some
27990 of them may need the information. */
27991 w
->phys_cursor
.x
= x
;
27992 w
->phys_cursor
.y
= glyph_row
->y
;
27993 w
->phys_cursor
.hpos
= hpos
;
27994 w
->phys_cursor
.vpos
= vpos
;
27997 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27998 new_cursor_type
, new_cursor_width
,
27999 on
, active_cursor
);
28003 /* Switch the display of W's cursor on or off, according to the value
28007 update_window_cursor (struct window
*w
, bool on
)
28009 /* Don't update cursor in windows whose frame is in the process
28010 of being deleted. */
28011 if (w
->current_matrix
)
28013 int hpos
= w
->phys_cursor
.hpos
;
28014 int vpos
= w
->phys_cursor
.vpos
;
28015 struct glyph_row
*row
;
28017 if (vpos
>= w
->current_matrix
->nrows
28018 || hpos
>= w
->current_matrix
->matrix_w
)
28021 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28023 /* When the window is hscrolled, cursor hpos can legitimately be
28024 out of bounds, but we draw the cursor at the corresponding
28025 window margin in that case. */
28026 if (!row
->reversed_p
&& hpos
< 0)
28028 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28029 hpos
= row
->used
[TEXT_AREA
] - 1;
28032 display_and_set_cursor (w
, on
, hpos
, vpos
,
28033 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28039 /* Call update_window_cursor with parameter ON_P on all leaf windows
28040 in the window tree rooted at W. */
28043 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28047 if (WINDOWP (w
->contents
))
28048 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28050 update_window_cursor (w
, on_p
);
28052 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28058 Display the cursor on window W, or clear it, according to ON_P.
28059 Don't change the cursor's position. */
28062 x_update_cursor (struct frame
*f
, bool on_p
)
28064 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28069 Clear the cursor of window W to background color, and mark the
28070 cursor as not shown. This is used when the text where the cursor
28071 is about to be rewritten. */
28074 x_clear_cursor (struct window
*w
)
28076 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28077 update_window_cursor (w
, false);
28080 #endif /* HAVE_WINDOW_SYSTEM */
28082 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28085 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28086 int start_hpos
, int end_hpos
,
28087 enum draw_glyphs_face draw
)
28089 #ifdef HAVE_WINDOW_SYSTEM
28090 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28092 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28096 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28097 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28101 /* Display the active region described by mouse_face_* according to DRAW. */
28104 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28106 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28107 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28109 if (/* If window is in the process of being destroyed, don't bother
28111 w
->current_matrix
!= NULL
28112 /* Don't update mouse highlight if hidden. */
28113 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28114 /* Recognize when we are called to operate on rows that don't exist
28115 anymore. This can happen when a window is split. */
28116 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28118 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28119 struct glyph_row
*row
, *first
, *last
;
28121 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28122 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28124 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28126 int start_hpos
, end_hpos
, start_x
;
28128 /* For all but the first row, the highlight starts at column 0. */
28131 /* R2L rows have BEG and END in reversed order, but the
28132 screen drawing geometry is always left to right. So
28133 we need to mirror the beginning and end of the
28134 highlighted area in R2L rows. */
28135 if (!row
->reversed_p
)
28137 start_hpos
= hlinfo
->mouse_face_beg_col
;
28138 start_x
= hlinfo
->mouse_face_beg_x
;
28140 else if (row
== last
)
28142 start_hpos
= hlinfo
->mouse_face_end_col
;
28143 start_x
= hlinfo
->mouse_face_end_x
;
28151 else if (row
->reversed_p
&& row
== last
)
28153 start_hpos
= hlinfo
->mouse_face_end_col
;
28154 start_x
= hlinfo
->mouse_face_end_x
;
28164 if (!row
->reversed_p
)
28165 end_hpos
= hlinfo
->mouse_face_end_col
;
28166 else if (row
== first
)
28167 end_hpos
= hlinfo
->mouse_face_beg_col
;
28170 end_hpos
= row
->used
[TEXT_AREA
];
28171 if (draw
== DRAW_NORMAL_TEXT
)
28172 row
->fill_line_p
= true; /* Clear to end of line. */
28175 else if (row
->reversed_p
&& row
== first
)
28176 end_hpos
= hlinfo
->mouse_face_beg_col
;
28179 end_hpos
= row
->used
[TEXT_AREA
];
28180 if (draw
== DRAW_NORMAL_TEXT
)
28181 row
->fill_line_p
= true; /* Clear to end of line. */
28184 if (end_hpos
> start_hpos
)
28186 draw_row_with_mouse_face (w
, start_x
, row
,
28187 start_hpos
, end_hpos
, draw
);
28190 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28194 #ifdef HAVE_WINDOW_SYSTEM
28195 /* When we've written over the cursor, arrange for it to
28196 be displayed again. */
28197 if (FRAME_WINDOW_P (f
)
28198 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28200 int hpos
= w
->phys_cursor
.hpos
;
28202 /* When the window is hscrolled, cursor hpos can legitimately be
28203 out of bounds, but we draw the cursor at the corresponding
28204 window margin in that case. */
28205 if (!row
->reversed_p
&& hpos
< 0)
28207 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28208 hpos
= row
->used
[TEXT_AREA
] - 1;
28211 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28212 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28215 #endif /* HAVE_WINDOW_SYSTEM */
28218 #ifdef HAVE_WINDOW_SYSTEM
28219 /* Change the mouse cursor. */
28220 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28222 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28223 if (draw
== DRAW_NORMAL_TEXT
28224 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28225 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28228 if (draw
== DRAW_MOUSE_FACE
)
28229 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28231 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28233 #endif /* HAVE_WINDOW_SYSTEM */
28237 Clear out the mouse-highlighted active region.
28238 Redraw it un-highlighted first. Value is true if mouse
28239 face was actually drawn unhighlighted. */
28242 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28245 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28247 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28248 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28249 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28250 hlinfo
->mouse_face_window
= Qnil
;
28251 hlinfo
->mouse_face_overlay
= Qnil
;
28255 /* Return true if the coordinates HPOS and VPOS on windows W are
28256 within the mouse face on that window. */
28258 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28260 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28262 /* Quickly resolve the easy cases. */
28263 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28264 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28266 if (vpos
< hlinfo
->mouse_face_beg_row
28267 || vpos
> hlinfo
->mouse_face_end_row
)
28269 if (vpos
> hlinfo
->mouse_face_beg_row
28270 && vpos
< hlinfo
->mouse_face_end_row
)
28273 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28275 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28277 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28280 else if ((vpos
== hlinfo
->mouse_face_beg_row
28281 && hpos
>= hlinfo
->mouse_face_beg_col
)
28282 || (vpos
== hlinfo
->mouse_face_end_row
28283 && hpos
< hlinfo
->mouse_face_end_col
))
28288 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28290 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28293 else if ((vpos
== hlinfo
->mouse_face_beg_row
28294 && hpos
<= hlinfo
->mouse_face_beg_col
)
28295 || (vpos
== hlinfo
->mouse_face_end_row
28296 && hpos
> hlinfo
->mouse_face_end_col
))
28304 True if physical cursor of window W is within mouse face. */
28307 cursor_in_mouse_face_p (struct window
*w
)
28309 int hpos
= w
->phys_cursor
.hpos
;
28310 int vpos
= w
->phys_cursor
.vpos
;
28311 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28313 /* When the window is hscrolled, cursor hpos can legitimately be out
28314 of bounds, but we draw the cursor at the corresponding window
28315 margin in that case. */
28316 if (!row
->reversed_p
&& hpos
< 0)
28318 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28319 hpos
= row
->used
[TEXT_AREA
] - 1;
28321 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28326 /* Find the glyph rows START_ROW and END_ROW of window W that display
28327 characters between buffer positions START_CHARPOS and END_CHARPOS
28328 (excluding END_CHARPOS). DISP_STRING is a display string that
28329 covers these buffer positions. This is similar to
28330 row_containing_pos, but is more accurate when bidi reordering makes
28331 buffer positions change non-linearly with glyph rows. */
28333 rows_from_pos_range (struct window
*w
,
28334 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28335 Lisp_Object disp_string
,
28336 struct glyph_row
**start
, struct glyph_row
**end
)
28338 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28339 int last_y
= window_text_bottom_y (w
);
28340 struct glyph_row
*row
;
28345 while (!first
->enabled_p
28346 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28349 /* Find the START row. */
28351 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28354 /* A row can potentially be the START row if the range of the
28355 characters it displays intersects the range
28356 [START_CHARPOS..END_CHARPOS). */
28357 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28358 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28359 /* See the commentary in row_containing_pos, for the
28360 explanation of the complicated way to check whether
28361 some position is beyond the end of the characters
28362 displayed by a row. */
28363 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28364 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28365 && !row
->ends_at_zv_p
28366 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28367 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28368 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28369 && !row
->ends_at_zv_p
28370 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28372 /* Found a candidate row. Now make sure at least one of the
28373 glyphs it displays has a charpos from the range
28374 [START_CHARPOS..END_CHARPOS).
28376 This is not obvious because bidi reordering could make
28377 buffer positions of a row be 1,2,3,102,101,100, and if we
28378 want to highlight characters in [50..60), we don't want
28379 this row, even though [50..60) does intersect [1..103),
28380 the range of character positions given by the row's start
28381 and end positions. */
28382 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28383 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28387 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28388 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28389 /* A glyph that comes from DISP_STRING is by
28390 definition to be highlighted. */
28391 || EQ (g
->object
, disp_string
))
28400 /* Find the END row. */
28402 /* If the last row is partially visible, start looking for END
28403 from that row, instead of starting from FIRST. */
28404 && !(row
->enabled_p
28405 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28407 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28409 struct glyph_row
*next
= row
+ 1;
28410 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28412 if (!next
->enabled_p
28413 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28414 /* The first row >= START whose range of displayed characters
28415 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28416 is the row END + 1. */
28417 || (start_charpos
< next_start
28418 && end_charpos
< next_start
)
28419 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28420 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28421 && !next
->ends_at_zv_p
28422 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28423 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28424 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28425 && !next
->ends_at_zv_p
28426 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28433 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28434 but none of the characters it displays are in the range, it is
28436 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28437 struct glyph
*s
= g
;
28438 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28442 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28443 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28444 /* If the buffer position of the first glyph in
28445 the row is equal to END_CHARPOS, it means
28446 the last character to be highlighted is the
28447 newline of ROW, and we must consider NEXT as
28449 || (((!next
->reversed_p
&& g
== s
)
28450 || (next
->reversed_p
&& g
== e
- 1))
28451 && (g
->charpos
== end_charpos
28452 /* Special case for when NEXT is an
28453 empty line at ZV. */
28454 || (g
->charpos
== -1
28455 && !row
->ends_at_zv_p
28456 && next_start
== end_charpos
)))))
28457 /* A glyph that comes from DISP_STRING is by
28458 definition to be highlighted. */
28459 || EQ (g
->object
, disp_string
))
28468 /* The first row that ends at ZV must be the last to be
28470 else if (next
->ends_at_zv_p
)
28479 /* This function sets the mouse_face_* elements of HLINFO, assuming
28480 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28481 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28482 for the overlay or run of text properties specifying the mouse
28483 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28484 before-string and after-string that must also be highlighted.
28485 DISP_STRING, if non-nil, is a display string that may cover some
28486 or all of the highlighted text. */
28489 mouse_face_from_buffer_pos (Lisp_Object window
,
28490 Mouse_HLInfo
*hlinfo
,
28491 ptrdiff_t mouse_charpos
,
28492 ptrdiff_t start_charpos
,
28493 ptrdiff_t end_charpos
,
28494 Lisp_Object before_string
,
28495 Lisp_Object after_string
,
28496 Lisp_Object disp_string
)
28498 struct window
*w
= XWINDOW (window
);
28499 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28500 struct glyph_row
*r1
, *r2
;
28501 struct glyph
*glyph
, *end
;
28502 ptrdiff_t ignore
, pos
;
28505 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28506 eassert (NILP (before_string
) || STRINGP (before_string
));
28507 eassert (NILP (after_string
) || STRINGP (after_string
));
28509 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28510 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28512 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28513 /* If the before-string or display-string contains newlines,
28514 rows_from_pos_range skips to its last row. Move back. */
28515 if (!NILP (before_string
) || !NILP (disp_string
))
28517 struct glyph_row
*prev
;
28518 while ((prev
= r1
- 1, prev
>= first
)
28519 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28520 && prev
->used
[TEXT_AREA
] > 0)
28522 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28523 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28524 while (--glyph
>= beg
&& NILP (glyph
->object
));
28526 || !(EQ (glyph
->object
, before_string
)
28527 || EQ (glyph
->object
, disp_string
)))
28534 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28535 hlinfo
->mouse_face_past_end
= true;
28537 else if (!NILP (after_string
))
28539 /* If the after-string has newlines, advance to its last row. */
28540 struct glyph_row
*next
;
28541 struct glyph_row
*last
28542 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28544 for (next
= r2
+ 1;
28546 && next
->used
[TEXT_AREA
] > 0
28547 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28551 /* The rest of the display engine assumes that mouse_face_beg_row is
28552 either above mouse_face_end_row or identical to it. But with
28553 bidi-reordered continued lines, the row for START_CHARPOS could
28554 be below the row for END_CHARPOS. If so, swap the rows and store
28555 them in correct order. */
28558 struct glyph_row
*tem
= r2
;
28564 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28565 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28567 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28568 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28569 could be anywhere in the row and in any order. The strategy
28570 below is to find the leftmost and the rightmost glyph that
28571 belongs to either of these 3 strings, or whose position is
28572 between START_CHARPOS and END_CHARPOS, and highlight all the
28573 glyphs between those two. This may cover more than just the text
28574 between START_CHARPOS and END_CHARPOS if the range of characters
28575 strides the bidi level boundary, e.g. if the beginning is in R2L
28576 text while the end is in L2R text or vice versa. */
28577 if (!r1
->reversed_p
)
28579 /* This row is in a left to right paragraph. Scan it left to
28581 glyph
= r1
->glyphs
[TEXT_AREA
];
28582 end
= glyph
+ r1
->used
[TEXT_AREA
];
28585 /* Skip truncation glyphs at the start of the glyph row. */
28586 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28588 && NILP (glyph
->object
)
28589 && glyph
->charpos
< 0;
28591 x
+= glyph
->pixel_width
;
28593 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28594 or DISP_STRING, and the first glyph from buffer whose
28595 position is between START_CHARPOS and END_CHARPOS. */
28597 && !NILP (glyph
->object
)
28598 && !EQ (glyph
->object
, disp_string
)
28599 && !(BUFFERP (glyph
->object
)
28600 && (glyph
->charpos
>= start_charpos
28601 && glyph
->charpos
< end_charpos
));
28604 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28605 are present at buffer positions between START_CHARPOS and
28606 END_CHARPOS, or if they come from an overlay. */
28607 if (EQ (glyph
->object
, before_string
))
28609 pos
= string_buffer_position (before_string
,
28611 /* If pos == 0, it means before_string came from an
28612 overlay, not from a buffer position. */
28613 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28616 else if (EQ (glyph
->object
, after_string
))
28618 pos
= string_buffer_position (after_string
, end_charpos
);
28619 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28622 x
+= glyph
->pixel_width
;
28624 hlinfo
->mouse_face_beg_x
= x
;
28625 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28629 /* This row is in a right to left paragraph. Scan it right to
28633 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28634 glyph
= end
+ r1
->used
[TEXT_AREA
];
28636 /* Skip truncation glyphs at the start of the glyph row. */
28637 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28639 && NILP (glyph
->object
)
28640 && glyph
->charpos
< 0;
28644 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28645 or DISP_STRING, and the first glyph from buffer whose
28646 position is between START_CHARPOS and END_CHARPOS. */
28648 && !NILP (glyph
->object
)
28649 && !EQ (glyph
->object
, disp_string
)
28650 && !(BUFFERP (glyph
->object
)
28651 && (glyph
->charpos
>= start_charpos
28652 && glyph
->charpos
< end_charpos
));
28655 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28656 are present at buffer positions between START_CHARPOS and
28657 END_CHARPOS, or if they come from an overlay. */
28658 if (EQ (glyph
->object
, before_string
))
28660 pos
= string_buffer_position (before_string
, start_charpos
);
28661 /* If pos == 0, it means before_string came from an
28662 overlay, not from a buffer position. */
28663 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28666 else if (EQ (glyph
->object
, after_string
))
28668 pos
= string_buffer_position (after_string
, end_charpos
);
28669 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28674 glyph
++; /* first glyph to the right of the highlighted area */
28675 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28676 x
+= g
->pixel_width
;
28677 hlinfo
->mouse_face_beg_x
= x
;
28678 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28681 /* If the highlight ends in a different row, compute GLYPH and END
28682 for the end row. Otherwise, reuse the values computed above for
28683 the row where the highlight begins. */
28686 if (!r2
->reversed_p
)
28688 glyph
= r2
->glyphs
[TEXT_AREA
];
28689 end
= glyph
+ r2
->used
[TEXT_AREA
];
28694 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28695 glyph
= end
+ r2
->used
[TEXT_AREA
];
28699 if (!r2
->reversed_p
)
28701 /* Skip truncation and continuation glyphs near the end of the
28702 row, and also blanks and stretch glyphs inserted by
28703 extend_face_to_end_of_line. */
28705 && NILP ((end
- 1)->object
))
28707 /* Scan the rest of the glyph row from the end, looking for the
28708 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28709 DISP_STRING, or whose position is between START_CHARPOS
28713 && !NILP (end
->object
)
28714 && !EQ (end
->object
, disp_string
)
28715 && !(BUFFERP (end
->object
)
28716 && (end
->charpos
>= start_charpos
28717 && end
->charpos
< end_charpos
));
28720 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28721 are present at buffer positions between START_CHARPOS and
28722 END_CHARPOS, or if they come from an overlay. */
28723 if (EQ (end
->object
, before_string
))
28725 pos
= string_buffer_position (before_string
, start_charpos
);
28726 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28729 else if (EQ (end
->object
, after_string
))
28731 pos
= string_buffer_position (after_string
, end_charpos
);
28732 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28736 /* Find the X coordinate of the last glyph to be highlighted. */
28737 for (; glyph
<= end
; ++glyph
)
28738 x
+= glyph
->pixel_width
;
28740 hlinfo
->mouse_face_end_x
= x
;
28741 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28745 /* Skip truncation and continuation glyphs near the end of the
28746 row, and also blanks and stretch glyphs inserted by
28747 extend_face_to_end_of_line. */
28751 && NILP (end
->object
))
28753 x
+= end
->pixel_width
;
28756 /* Scan the rest of the glyph row from the end, looking for the
28757 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28758 DISP_STRING, or whose position is between START_CHARPOS
28762 && !NILP (end
->object
)
28763 && !EQ (end
->object
, disp_string
)
28764 && !(BUFFERP (end
->object
)
28765 && (end
->charpos
>= start_charpos
28766 && end
->charpos
< end_charpos
));
28769 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28770 are present at buffer positions between START_CHARPOS and
28771 END_CHARPOS, or if they come from an overlay. */
28772 if (EQ (end
->object
, before_string
))
28774 pos
= string_buffer_position (before_string
, start_charpos
);
28775 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28778 else if (EQ (end
->object
, after_string
))
28780 pos
= string_buffer_position (after_string
, end_charpos
);
28781 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28784 x
+= end
->pixel_width
;
28786 /* If we exited the above loop because we arrived at the last
28787 glyph of the row, and its buffer position is still not in
28788 range, it means the last character in range is the preceding
28789 newline. Bump the end column and x values to get past the
28792 && BUFFERP (end
->object
)
28793 && (end
->charpos
< start_charpos
28794 || end
->charpos
>= end_charpos
))
28796 x
+= end
->pixel_width
;
28799 hlinfo
->mouse_face_end_x
= x
;
28800 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28803 hlinfo
->mouse_face_window
= window
;
28804 hlinfo
->mouse_face_face_id
28805 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28807 !hlinfo
->mouse_face_hidden
, -1);
28808 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28811 /* The following function is not used anymore (replaced with
28812 mouse_face_from_string_pos), but I leave it here for the time
28813 being, in case someone would. */
28815 #if false /* not used */
28817 /* Find the position of the glyph for position POS in OBJECT in
28818 window W's current matrix, and return in *X, *Y the pixel
28819 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28821 RIGHT_P means return the position of the right edge of the glyph.
28822 !RIGHT_P means return the left edge position.
28824 If no glyph for POS exists in the matrix, return the position of
28825 the glyph with the next smaller position that is in the matrix, if
28826 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28827 exists in the matrix, return the position of the glyph with the
28828 next larger position in OBJECT.
28830 Value is true if a glyph was found. */
28833 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28834 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28836 int yb
= window_text_bottom_y (w
);
28837 struct glyph_row
*r
;
28838 struct glyph
*best_glyph
= NULL
;
28839 struct glyph_row
*best_row
= NULL
;
28842 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28843 r
->enabled_p
&& r
->y
< yb
;
28846 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28847 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28850 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28851 if (EQ (g
->object
, object
))
28853 if (g
->charpos
== pos
)
28860 else if (best_glyph
== NULL
28861 || ((eabs (g
->charpos
- pos
)
28862 < eabs (best_glyph
->charpos
- pos
))
28865 : g
->charpos
> pos
)))
28879 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28883 *x
+= best_glyph
->pixel_width
;
28888 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28891 return best_glyph
!= NULL
;
28893 #endif /* not used */
28895 /* Find the positions of the first and the last glyphs in window W's
28896 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28897 (assumed to be a string), and return in HLINFO's mouse_face_*
28898 members the pixel and column/row coordinates of those glyphs. */
28901 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28902 Lisp_Object object
,
28903 ptrdiff_t startpos
, ptrdiff_t endpos
)
28905 int yb
= window_text_bottom_y (w
);
28906 struct glyph_row
*r
;
28907 struct glyph
*g
, *e
;
28909 bool found
= false;
28911 /* Find the glyph row with at least one position in the range
28912 [STARTPOS..ENDPOS), and the first glyph in that row whose
28913 position belongs to that range. */
28914 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28915 r
->enabled_p
&& r
->y
< yb
;
28918 if (!r
->reversed_p
)
28920 g
= r
->glyphs
[TEXT_AREA
];
28921 e
= g
+ r
->used
[TEXT_AREA
];
28922 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28923 if (EQ (g
->object
, object
)
28924 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28926 hlinfo
->mouse_face_beg_row
28927 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28928 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28929 hlinfo
->mouse_face_beg_x
= gx
;
28938 e
= r
->glyphs
[TEXT_AREA
];
28939 g
= e
+ r
->used
[TEXT_AREA
];
28940 for ( ; g
> e
; --g
)
28941 if (EQ ((g
-1)->object
, object
)
28942 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28944 hlinfo
->mouse_face_beg_row
28945 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28946 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28947 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28948 gx
+= g1
->pixel_width
;
28949 hlinfo
->mouse_face_beg_x
= gx
;
28961 /* Starting with the next row, look for the first row which does NOT
28962 include any glyphs whose positions are in the range. */
28963 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28965 g
= r
->glyphs
[TEXT_AREA
];
28966 e
= g
+ r
->used
[TEXT_AREA
];
28968 for ( ; g
< e
; ++g
)
28969 if (EQ (g
->object
, object
)
28970 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28979 /* The highlighted region ends on the previous row. */
28982 /* Set the end row. */
28983 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28985 /* Compute and set the end column and the end column's horizontal
28986 pixel coordinate. */
28987 if (!r
->reversed_p
)
28989 g
= r
->glyphs
[TEXT_AREA
];
28990 e
= g
+ r
->used
[TEXT_AREA
];
28991 for ( ; e
> g
; --e
)
28992 if (EQ ((e
-1)->object
, object
)
28993 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28995 hlinfo
->mouse_face_end_col
= e
- g
;
28997 for (gx
= r
->x
; g
< e
; ++g
)
28998 gx
+= g
->pixel_width
;
28999 hlinfo
->mouse_face_end_x
= gx
;
29003 e
= r
->glyphs
[TEXT_AREA
];
29004 g
= e
+ r
->used
[TEXT_AREA
];
29005 for (gx
= r
->x
; e
< g
; ++e
)
29007 if (EQ (e
->object
, object
)
29008 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29010 gx
+= e
->pixel_width
;
29012 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29013 hlinfo
->mouse_face_end_x
= gx
;
29017 #ifdef HAVE_WINDOW_SYSTEM
29019 /* See if position X, Y is within a hot-spot of an image. */
29022 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29024 if (!CONSP (hot_spot
))
29027 if (EQ (XCAR (hot_spot
), Qrect
))
29029 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29030 Lisp_Object rect
= XCDR (hot_spot
);
29034 if (!CONSP (XCAR (rect
)))
29036 if (!CONSP (XCDR (rect
)))
29038 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29040 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29042 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29044 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29048 else if (EQ (XCAR (hot_spot
), Qcircle
))
29050 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29051 Lisp_Object circ
= XCDR (hot_spot
);
29052 Lisp_Object lr
, lx0
, ly0
;
29054 && CONSP (XCAR (circ
))
29055 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
29056 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29057 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29059 double r
= XFLOATINT (lr
);
29060 double dx
= XINT (lx0
) - x
;
29061 double dy
= XINT (ly0
) - y
;
29062 return (dx
* dx
+ dy
* dy
<= r
* r
);
29065 else if (EQ (XCAR (hot_spot
), Qpoly
))
29067 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29068 if (VECTORP (XCDR (hot_spot
)))
29070 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29071 Lisp_Object
*poly
= v
->contents
;
29072 ptrdiff_t n
= v
->header
.size
;
29074 bool inside
= false;
29075 Lisp_Object lx
, ly
;
29078 /* Need an even number of coordinates, and at least 3 edges. */
29079 if (n
< 6 || n
& 1)
29082 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29083 If count is odd, we are inside polygon. Pixels on edges
29084 may or may not be included depending on actual geometry of the
29086 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29087 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29089 x0
= XINT (lx
), y0
= XINT (ly
);
29090 for (i
= 0; i
< n
; i
+= 2)
29092 int x1
= x0
, y1
= y0
;
29093 if ((lx
= poly
[i
], !INTEGERP (lx
))
29094 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29096 x0
= XINT (lx
), y0
= XINT (ly
);
29098 /* Does this segment cross the X line? */
29106 if (y
> y0
&& y
> y1
)
29108 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29118 find_hot_spot (Lisp_Object map
, int x
, int y
)
29120 while (CONSP (map
))
29122 if (CONSP (XCAR (map
))
29123 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29131 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29133 doc
: /* Lookup in image map MAP coordinates X and Y.
29134 An image map is an alist where each element has the format (AREA ID PLIST).
29135 An AREA is specified as either a rectangle, a circle, or a polygon:
29136 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29137 pixel coordinates of the upper left and bottom right corners.
29138 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29139 and the radius of the circle; r may be a float or integer.
29140 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29141 vector describes one corner in the polygon.
29142 Returns the alist element for the first matching AREA in MAP. */)
29143 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29151 return find_hot_spot (map
,
29152 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29153 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29157 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29159 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29161 /* Do not change cursor shape while dragging mouse. */
29162 if (EQ (do_mouse_tracking
, Qdragging
))
29165 if (!NILP (pointer
))
29167 if (EQ (pointer
, Qarrow
))
29168 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29169 else if (EQ (pointer
, Qhand
))
29170 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29171 else if (EQ (pointer
, Qtext
))
29172 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29173 else if (EQ (pointer
, intern ("hdrag")))
29174 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29175 else if (EQ (pointer
, intern ("nhdrag")))
29176 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29177 #ifdef HAVE_X_WINDOWS
29178 else if (EQ (pointer
, intern ("vdrag")))
29179 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29181 else if (EQ (pointer
, intern ("hourglass")))
29182 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29183 else if (EQ (pointer
, Qmodeline
))
29184 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29186 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29189 if (cursor
!= No_Cursor
)
29190 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29193 #endif /* HAVE_WINDOW_SYSTEM */
29195 /* Take proper action when mouse has moved to the mode or header line
29196 or marginal area AREA of window W, x-position X and y-position Y.
29197 X is relative to the start of the text display area of W, so the
29198 width of bitmap areas and scroll bars must be subtracted to get a
29199 position relative to the start of the mode line. */
29202 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29203 enum window_part area
)
29205 struct window
*w
= XWINDOW (window
);
29206 struct frame
*f
= XFRAME (w
->frame
);
29207 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29208 #ifdef HAVE_WINDOW_SYSTEM
29209 Display_Info
*dpyinfo
;
29211 Cursor cursor
= No_Cursor
;
29212 Lisp_Object pointer
= Qnil
;
29213 int dx
, dy
, width
, height
;
29215 Lisp_Object string
, object
= Qnil
;
29216 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29218 Lisp_Object mouse_face
;
29219 int original_x_pixel
= x
;
29220 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29221 struct glyph_row
*row
IF_LINT (= 0);
29223 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29228 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29229 returns them in row/column units! */
29230 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29231 &object
, &dx
, &dy
, &width
, &height
);
29233 row
= (area
== ON_MODE_LINE
29234 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29235 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29237 /* Find the glyph under the mouse pointer. */
29238 if (row
->mode_line_p
&& row
->enabled_p
)
29240 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29241 end
= glyph
+ row
->used
[TEXT_AREA
];
29243 for (x0
= original_x_pixel
;
29244 glyph
< end
&& x0
>= glyph
->pixel_width
;
29246 x0
-= glyph
->pixel_width
;
29254 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29255 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29256 returns them in row/column units! */
29257 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29258 &object
, &dx
, &dy
, &width
, &height
);
29263 #ifdef HAVE_WINDOW_SYSTEM
29264 if (IMAGEP (object
))
29266 Lisp_Object image_map
, hotspot
;
29267 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29269 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29271 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29275 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29276 If so, we could look for mouse-enter, mouse-leave
29277 properties in PLIST (and do something...). */
29278 hotspot
= XCDR (hotspot
);
29279 if (CONSP (hotspot
)
29280 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29282 pointer
= Fplist_get (plist
, Qpointer
);
29283 if (NILP (pointer
))
29285 help
= Fplist_get (plist
, Qhelp_echo
);
29288 help_echo_string
= help
;
29289 XSETWINDOW (help_echo_window
, w
);
29290 help_echo_object
= w
->contents
;
29291 help_echo_pos
= charpos
;
29295 if (NILP (pointer
))
29296 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29298 #endif /* HAVE_WINDOW_SYSTEM */
29300 if (STRINGP (string
))
29301 pos
= make_number (charpos
);
29303 /* Set the help text and mouse pointer. If the mouse is on a part
29304 of the mode line without any text (e.g. past the right edge of
29305 the mode line text), use the default help text and pointer. */
29306 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29308 /* Arrange to display the help by setting the global variables
29309 help_echo_string, help_echo_object, and help_echo_pos. */
29312 if (STRINGP (string
))
29313 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29317 help_echo_string
= help
;
29318 XSETWINDOW (help_echo_window
, w
);
29319 help_echo_object
= string
;
29320 help_echo_pos
= charpos
;
29322 else if (area
== ON_MODE_LINE
)
29324 Lisp_Object default_help
29325 = buffer_local_value (Qmode_line_default_help_echo
,
29328 if (STRINGP (default_help
))
29330 help_echo_string
= default_help
;
29331 XSETWINDOW (help_echo_window
, w
);
29332 help_echo_object
= Qnil
;
29333 help_echo_pos
= -1;
29338 #ifdef HAVE_WINDOW_SYSTEM
29339 /* Change the mouse pointer according to what is under it. */
29340 if (FRAME_WINDOW_P (f
))
29342 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29344 || NILP (Vresize_mini_windows
));
29346 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29347 if (STRINGP (string
))
29349 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29351 if (NILP (pointer
))
29352 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29354 /* Change the mouse pointer according to what is under X/Y. */
29356 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29359 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29360 if (!KEYMAPP (map
))
29361 map
= Fget_text_property (pos
, Qkeymap
, string
);
29362 if (!KEYMAPP (map
) && draggable
)
29363 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29366 else if (draggable
)
29367 /* Default mode-line pointer. */
29368 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29373 /* Change the mouse face according to what is under X/Y. */
29374 bool mouse_face_shown
= false;
29375 if (STRINGP (string
))
29377 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29378 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29379 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29384 struct glyph
* tmp_glyph
;
29388 int total_pixel_width
;
29389 ptrdiff_t begpos
, endpos
, ignore
;
29393 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29394 Qmouse_face
, string
, Qnil
);
29400 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29402 endpos
= SCHARS (string
);
29406 /* Calculate the glyph position GPOS of GLYPH in the
29407 displayed string, relative to the beginning of the
29408 highlighted part of the string.
29410 Note: GPOS is different from CHARPOS. CHARPOS is the
29411 position of GLYPH in the internal string object. A mode
29412 line string format has structures which are converted to
29413 a flattened string by the Emacs Lisp interpreter. The
29414 internal string is an element of those structures. The
29415 displayed string is the flattened string. */
29416 tmp_glyph
= row_start_glyph
;
29417 while (tmp_glyph
< glyph
29418 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29419 && begpos
<= tmp_glyph
->charpos
29420 && tmp_glyph
->charpos
< endpos
)))
29422 gpos
= glyph
- tmp_glyph
;
29424 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29425 the highlighted part of the displayed string to which
29426 GLYPH belongs. Note: GSEQ_LENGTH is different from
29427 SCHARS (STRING), because the latter returns the length of
29428 the internal string. */
29429 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29431 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29432 && begpos
<= tmp_glyph
->charpos
29433 && tmp_glyph
->charpos
< endpos
));
29436 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29438 /* Calculate the total pixel width of all the glyphs between
29439 the beginning of the highlighted area and GLYPH. */
29440 total_pixel_width
= 0;
29441 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29442 total_pixel_width
+= tmp_glyph
->pixel_width
;
29444 /* Pre calculation of re-rendering position. Note: X is in
29445 column units here, after the call to mode_line_string or
29446 marginal_area_string. */
29448 vpos
= (area
== ON_MODE_LINE
29449 ? (w
->current_matrix
)->nrows
- 1
29452 /* If GLYPH's position is included in the region that is
29453 already drawn in mouse face, we have nothing to do. */
29454 if ( EQ (window
, hlinfo
->mouse_face_window
)
29455 && (!row
->reversed_p
29456 ? (hlinfo
->mouse_face_beg_col
<= hpos
29457 && hpos
< hlinfo
->mouse_face_end_col
)
29458 /* In R2L rows we swap BEG and END, see below. */
29459 : (hlinfo
->mouse_face_end_col
<= hpos
29460 && hpos
< hlinfo
->mouse_face_beg_col
))
29461 && hlinfo
->mouse_face_beg_row
== vpos
)
29464 if (clear_mouse_face (hlinfo
))
29465 cursor
= No_Cursor
;
29467 if (!row
->reversed_p
)
29469 hlinfo
->mouse_face_beg_col
= hpos
;
29470 hlinfo
->mouse_face_beg_x
= original_x_pixel
29471 - (total_pixel_width
+ dx
);
29472 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29473 hlinfo
->mouse_face_end_x
= 0;
29477 /* In R2L rows, show_mouse_face expects BEG and END
29478 coordinates to be swapped. */
29479 hlinfo
->mouse_face_end_col
= hpos
;
29480 hlinfo
->mouse_face_end_x
= original_x_pixel
29481 - (total_pixel_width
+ dx
);
29482 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29483 hlinfo
->mouse_face_beg_x
= 0;
29486 hlinfo
->mouse_face_beg_row
= vpos
;
29487 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29488 hlinfo
->mouse_face_past_end
= false;
29489 hlinfo
->mouse_face_window
= window
;
29491 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29496 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29497 mouse_face_shown
= true;
29499 if (NILP (pointer
))
29504 /* If mouse-face doesn't need to be shown, clear any existing
29506 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29507 clear_mouse_face (hlinfo
);
29509 #ifdef HAVE_WINDOW_SYSTEM
29510 if (FRAME_WINDOW_P (f
))
29511 define_frame_cursor1 (f
, cursor
, pointer
);
29517 Take proper action when the mouse has moved to position X, Y on
29518 frame F with regards to highlighting portions of display that have
29519 mouse-face properties. Also de-highlight portions of display where
29520 the mouse was before, set the mouse pointer shape as appropriate
29521 for the mouse coordinates, and activate help echo (tooltips).
29522 X and Y can be negative or out of range. */
29525 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29527 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29528 enum window_part part
= ON_NOTHING
;
29529 Lisp_Object window
;
29531 Cursor cursor
= No_Cursor
;
29532 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29535 /* When a menu is active, don't highlight because this looks odd. */
29536 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29537 if (popup_activated ())
29541 if (!f
->glyphs_initialized_p
29542 || f
->pointer_invisible
)
29545 hlinfo
->mouse_face_mouse_x
= x
;
29546 hlinfo
->mouse_face_mouse_y
= y
;
29547 hlinfo
->mouse_face_mouse_frame
= f
;
29549 if (hlinfo
->mouse_face_defer
)
29552 /* Which window is that in? */
29553 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29555 /* If displaying active text in another window, clear that. */
29556 if (! EQ (window
, hlinfo
->mouse_face_window
)
29557 /* Also clear if we move out of text area in same window. */
29558 || (!NILP (hlinfo
->mouse_face_window
)
29561 && part
!= ON_MODE_LINE
29562 && part
!= ON_HEADER_LINE
))
29563 clear_mouse_face (hlinfo
);
29565 /* Not on a window -> return. */
29566 if (!WINDOWP (window
))
29569 /* Reset help_echo_string. It will get recomputed below. */
29570 help_echo_string
= Qnil
;
29572 /* Convert to window-relative pixel coordinates. */
29573 w
= XWINDOW (window
);
29574 frame_to_window_pixel_xy (w
, &x
, &y
);
29576 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29577 /* Handle tool-bar window differently since it doesn't display a
29579 if (EQ (window
, f
->tool_bar_window
))
29581 note_tool_bar_highlight (f
, x
, y
);
29586 /* Mouse is on the mode, header line or margin? */
29587 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29588 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29590 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29592 #ifdef HAVE_WINDOW_SYSTEM
29593 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29595 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29596 /* Show non-text cursor (Bug#16647). */
29604 #ifdef HAVE_WINDOW_SYSTEM
29605 if (part
== ON_VERTICAL_BORDER
)
29607 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29608 help_echo_string
= build_string ("drag-mouse-1: resize");
29610 else if (part
== ON_RIGHT_DIVIDER
)
29612 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29613 help_echo_string
= build_string ("drag-mouse-1: resize");
29615 else if (part
== ON_BOTTOM_DIVIDER
)
29616 if (! WINDOW_BOTTOMMOST_P (w
)
29618 || NILP (Vresize_mini_windows
))
29620 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29621 help_echo_string
= build_string ("drag-mouse-1: resize");
29624 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29625 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29626 || part
== ON_VERTICAL_SCROLL_BAR
29627 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29628 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29630 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29633 /* Are we in a window whose display is up to date?
29634 And verify the buffer's text has not changed. */
29635 b
= XBUFFER (w
->contents
);
29636 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29638 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29640 struct glyph
*glyph
;
29641 Lisp_Object object
;
29642 Lisp_Object mouse_face
= Qnil
, position
;
29643 Lisp_Object
*overlay_vec
= NULL
;
29644 ptrdiff_t i
, noverlays
;
29645 struct buffer
*obuf
;
29646 ptrdiff_t obegv
, ozv
;
29649 /* Find the glyph under X/Y. */
29650 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29652 #ifdef HAVE_WINDOW_SYSTEM
29653 /* Look for :pointer property on image. */
29654 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29656 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29657 if (img
!= NULL
&& IMAGEP (img
->spec
))
29659 Lisp_Object image_map
, hotspot
;
29660 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29662 && (hotspot
= find_hot_spot (image_map
,
29663 glyph
->slice
.img
.x
+ dx
,
29664 glyph
->slice
.img
.y
+ dy
),
29666 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29670 /* Could check XCAR (hotspot) to see if we enter/leave
29672 If so, we could look for mouse-enter, mouse-leave
29673 properties in PLIST (and do something...). */
29674 hotspot
= XCDR (hotspot
);
29675 if (CONSP (hotspot
)
29676 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29678 pointer
= Fplist_get (plist
, Qpointer
);
29679 if (NILP (pointer
))
29681 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29682 if (!NILP (help_echo_string
))
29684 help_echo_window
= window
;
29685 help_echo_object
= glyph
->object
;
29686 help_echo_pos
= glyph
->charpos
;
29690 if (NILP (pointer
))
29691 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29694 #endif /* HAVE_WINDOW_SYSTEM */
29696 /* Clear mouse face if X/Y not over text. */
29698 || area
!= TEXT_AREA
29699 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29700 /* Glyph's OBJECT is nil for glyphs inserted by the
29701 display engine for its internal purposes, like truncation
29702 and continuation glyphs and blanks beyond the end of
29703 line's text on text terminals. If we are over such a
29704 glyph, we are not over any text. */
29705 || NILP (glyph
->object
)
29706 /* R2L rows have a stretch glyph at their front, which
29707 stands for no text, whereas L2R rows have no glyphs at
29708 all beyond the end of text. Treat such stretch glyphs
29709 like we do with NULL glyphs in L2R rows. */
29710 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29711 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29712 && glyph
->type
== STRETCH_GLYPH
29713 && glyph
->avoid_cursor_p
))
29715 if (clear_mouse_face (hlinfo
))
29716 cursor
= No_Cursor
;
29717 #ifdef HAVE_WINDOW_SYSTEM
29718 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29720 if (area
!= TEXT_AREA
)
29721 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29723 pointer
= Vvoid_text_area_pointer
;
29729 pos
= glyph
->charpos
;
29730 object
= glyph
->object
;
29731 if (!STRINGP (object
) && !BUFFERP (object
))
29734 /* If we get an out-of-range value, return now; avoid an error. */
29735 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29738 /* Make the window's buffer temporarily current for
29739 overlays_at and compute_char_face. */
29740 obuf
= current_buffer
;
29741 current_buffer
= b
;
29747 /* Is this char mouse-active or does it have help-echo? */
29748 position
= make_number (pos
);
29752 if (BUFFERP (object
))
29754 /* Put all the overlays we want in a vector in overlay_vec. */
29755 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29756 /* Sort overlays into increasing priority order. */
29757 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29762 if (NILP (Vmouse_highlight
))
29764 clear_mouse_face (hlinfo
);
29765 goto check_help_echo
;
29768 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29771 cursor
= No_Cursor
;
29773 /* Check mouse-face highlighting. */
29775 /* If there exists an overlay with mouse-face overlapping
29776 the one we are currently highlighting, we have to
29777 check if we enter the overlapping overlay, and then
29778 highlight only that. */
29779 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29780 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29782 /* Find the highest priority overlay with a mouse-face. */
29783 Lisp_Object overlay
= Qnil
;
29784 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29786 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29787 if (!NILP (mouse_face
))
29788 overlay
= overlay_vec
[i
];
29791 /* If we're highlighting the same overlay as before, there's
29792 no need to do that again. */
29793 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29794 goto check_help_echo
;
29795 hlinfo
->mouse_face_overlay
= overlay
;
29797 /* Clear the display of the old active region, if any. */
29798 if (clear_mouse_face (hlinfo
))
29799 cursor
= No_Cursor
;
29801 /* If no overlay applies, get a text property. */
29802 if (NILP (overlay
))
29803 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29805 /* Next, compute the bounds of the mouse highlighting and
29807 if (!NILP (mouse_face
) && STRINGP (object
))
29809 /* The mouse-highlighting comes from a display string
29810 with a mouse-face. */
29814 s
= Fprevious_single_property_change
29815 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29816 e
= Fnext_single_property_change
29817 (position
, Qmouse_face
, object
, Qnil
);
29819 s
= make_number (0);
29821 e
= make_number (SCHARS (object
));
29822 mouse_face_from_string_pos (w
, hlinfo
, object
,
29823 XINT (s
), XINT (e
));
29824 hlinfo
->mouse_face_past_end
= false;
29825 hlinfo
->mouse_face_window
= window
;
29826 hlinfo
->mouse_face_face_id
29827 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29828 glyph
->face_id
, true);
29829 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29830 cursor
= No_Cursor
;
29834 /* The mouse-highlighting, if any, comes from an overlay
29835 or text property in the buffer. */
29836 Lisp_Object buffer
IF_LINT (= Qnil
);
29837 Lisp_Object disp_string
IF_LINT (= Qnil
);
29839 if (STRINGP (object
))
29841 /* If we are on a display string with no mouse-face,
29842 check if the text under it has one. */
29843 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29844 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29845 pos
= string_buffer_position (object
, start
);
29848 mouse_face
= get_char_property_and_overlay
29849 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29850 buffer
= w
->contents
;
29851 disp_string
= object
;
29857 disp_string
= Qnil
;
29860 if (!NILP (mouse_face
))
29862 Lisp_Object before
, after
;
29863 Lisp_Object before_string
, after_string
;
29864 /* To correctly find the limits of mouse highlight
29865 in a bidi-reordered buffer, we must not use the
29866 optimization of limiting the search in
29867 previous-single-property-change and
29868 next-single-property-change, because
29869 rows_from_pos_range needs the real start and end
29870 positions to DTRT in this case. That's because
29871 the first row visible in a window does not
29872 necessarily display the character whose position
29873 is the smallest. */
29875 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29876 ? Fmarker_position (w
->start
)
29879 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29880 ? make_number (BUF_Z (XBUFFER (buffer
))
29881 - w
->window_end_pos
)
29884 if (NILP (overlay
))
29886 /* Handle the text property case. */
29887 before
= Fprevious_single_property_change
29888 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29889 after
= Fnext_single_property_change
29890 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29891 before_string
= after_string
= Qnil
;
29895 /* Handle the overlay case. */
29896 before
= Foverlay_start (overlay
);
29897 after
= Foverlay_end (overlay
);
29898 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29899 after_string
= Foverlay_get (overlay
, Qafter_string
);
29901 if (!STRINGP (before_string
)) before_string
= Qnil
;
29902 if (!STRINGP (after_string
)) after_string
= Qnil
;
29905 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29908 : XFASTINT (before
),
29910 ? BUF_Z (XBUFFER (buffer
))
29911 : XFASTINT (after
),
29912 before_string
, after_string
,
29914 cursor
= No_Cursor
;
29921 /* Look for a `help-echo' property. */
29922 if (NILP (help_echo_string
)) {
29923 Lisp_Object help
, overlay
;
29925 /* Check overlays first. */
29926 help
= overlay
= Qnil
;
29927 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29929 overlay
= overlay_vec
[i
];
29930 help
= Foverlay_get (overlay
, Qhelp_echo
);
29935 help_echo_string
= help
;
29936 help_echo_window
= window
;
29937 help_echo_object
= overlay
;
29938 help_echo_pos
= pos
;
29942 Lisp_Object obj
= glyph
->object
;
29943 ptrdiff_t charpos
= glyph
->charpos
;
29945 /* Try text properties. */
29948 && charpos
< SCHARS (obj
))
29950 help
= Fget_text_property (make_number (charpos
),
29954 /* If the string itself doesn't specify a help-echo,
29955 see if the buffer text ``under'' it does. */
29956 struct glyph_row
*r
29957 = MATRIX_ROW (w
->current_matrix
, vpos
);
29958 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29959 ptrdiff_t p
= string_buffer_position (obj
, start
);
29962 help
= Fget_char_property (make_number (p
),
29963 Qhelp_echo
, w
->contents
);
29972 else if (BUFFERP (obj
)
29975 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29980 help_echo_string
= help
;
29981 help_echo_window
= window
;
29982 help_echo_object
= obj
;
29983 help_echo_pos
= charpos
;
29988 #ifdef HAVE_WINDOW_SYSTEM
29989 /* Look for a `pointer' property. */
29990 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29992 /* Check overlays first. */
29993 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29994 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29996 if (NILP (pointer
))
29998 Lisp_Object obj
= glyph
->object
;
29999 ptrdiff_t charpos
= glyph
->charpos
;
30001 /* Try text properties. */
30004 && charpos
< SCHARS (obj
))
30006 pointer
= Fget_text_property (make_number (charpos
),
30008 if (NILP (pointer
))
30010 /* If the string itself doesn't specify a pointer,
30011 see if the buffer text ``under'' it does. */
30012 struct glyph_row
*r
30013 = MATRIX_ROW (w
->current_matrix
, vpos
);
30014 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30015 ptrdiff_t p
= string_buffer_position (obj
, start
);
30017 pointer
= Fget_char_property (make_number (p
),
30018 Qpointer
, w
->contents
);
30021 else if (BUFFERP (obj
)
30024 pointer
= Fget_text_property (make_number (charpos
),
30028 #endif /* HAVE_WINDOW_SYSTEM */
30032 current_buffer
= obuf
;
30038 #ifdef HAVE_WINDOW_SYSTEM
30039 if (FRAME_WINDOW_P (f
))
30040 define_frame_cursor1 (f
, cursor
, pointer
);
30042 /* This is here to prevent a compiler error, about "label at end of
30043 compound statement". */
30050 Clear any mouse-face on window W. This function is part of the
30051 redisplay interface, and is called from try_window_id and similar
30052 functions to ensure the mouse-highlight is off. */
30055 x_clear_window_mouse_face (struct window
*w
)
30057 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30058 Lisp_Object window
;
30061 XSETWINDOW (window
, w
);
30062 if (EQ (window
, hlinfo
->mouse_face_window
))
30063 clear_mouse_face (hlinfo
);
30069 Just discard the mouse face information for frame F, if any.
30070 This is used when the size of F is changed. */
30073 cancel_mouse_face (struct frame
*f
)
30075 Lisp_Object window
;
30076 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30078 window
= hlinfo
->mouse_face_window
;
30079 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30080 reset_mouse_highlight (hlinfo
);
30085 /***********************************************************************
30087 ***********************************************************************/
30089 #ifdef HAVE_WINDOW_SYSTEM
30091 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30092 which intersects rectangle R. R is in window-relative coordinates. */
30095 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30096 enum glyph_row_area area
)
30098 struct glyph
*first
= row
->glyphs
[area
];
30099 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30100 struct glyph
*last
;
30101 int first_x
, start_x
, x
;
30103 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30104 /* If row extends face to end of line write the whole line. */
30105 draw_glyphs (w
, 0, row
, area
,
30106 0, row
->used
[area
],
30107 DRAW_NORMAL_TEXT
, 0);
30110 /* Set START_X to the window-relative start position for drawing glyphs of
30111 AREA. The first glyph of the text area can be partially visible.
30112 The first glyphs of other areas cannot. */
30113 start_x
= window_box_left_offset (w
, area
);
30115 if (area
== TEXT_AREA
)
30118 /* Find the first glyph that must be redrawn. */
30120 && x
+ first
->pixel_width
< r
->x
)
30122 x
+= first
->pixel_width
;
30126 /* Find the last one. */
30129 /* Use a signed int intermediate value to avoid catastrophic
30130 failures due to comparison between signed and unsigned, when
30131 x is negative (can happen for wide images that are hscrolled). */
30132 int r_end
= r
->x
+ r
->width
;
30133 while (last
< end
&& x
< r_end
)
30135 x
+= last
->pixel_width
;
30141 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30142 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30143 DRAW_NORMAL_TEXT
, 0);
30148 /* Redraw the parts of the glyph row ROW on window W intersecting
30149 rectangle R. R is in window-relative coordinates. Value is
30150 true if mouse-face was overwritten. */
30153 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30155 eassert (row
->enabled_p
);
30157 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30158 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30159 0, row
->used
[TEXT_AREA
],
30160 DRAW_NORMAL_TEXT
, 0);
30163 if (row
->used
[LEFT_MARGIN_AREA
])
30164 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30165 if (row
->used
[TEXT_AREA
])
30166 expose_area (w
, row
, r
, TEXT_AREA
);
30167 if (row
->used
[RIGHT_MARGIN_AREA
])
30168 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30169 draw_row_fringe_bitmaps (w
, row
);
30172 return row
->mouse_face_p
;
30176 /* Redraw those parts of glyphs rows during expose event handling that
30177 overlap other rows. Redrawing of an exposed line writes over parts
30178 of lines overlapping that exposed line; this function fixes that.
30180 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30181 row in W's current matrix that is exposed and overlaps other rows.
30182 LAST_OVERLAPPING_ROW is the last such row. */
30185 expose_overlaps (struct window
*w
,
30186 struct glyph_row
*first_overlapping_row
,
30187 struct glyph_row
*last_overlapping_row
,
30190 struct glyph_row
*row
;
30192 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30193 if (row
->overlapping_p
)
30195 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30198 if (row
->used
[LEFT_MARGIN_AREA
])
30199 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30201 if (row
->used
[TEXT_AREA
])
30202 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30204 if (row
->used
[RIGHT_MARGIN_AREA
])
30205 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30211 /* Return true if W's cursor intersects rectangle R. */
30214 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30216 XRectangle cr
, result
;
30217 struct glyph
*cursor_glyph
;
30218 struct glyph_row
*row
;
30220 if (w
->phys_cursor
.vpos
>= 0
30221 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30222 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30224 && row
->cursor_in_fringe_p
)
30226 /* Cursor is in the fringe. */
30227 cr
.x
= window_box_right_offset (w
,
30228 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30229 ? RIGHT_MARGIN_AREA
30232 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30233 cr
.height
= row
->height
;
30234 return x_intersect_rectangles (&cr
, r
, &result
);
30237 cursor_glyph
= get_phys_cursor_glyph (w
);
30240 /* r is relative to W's box, but w->phys_cursor.x is relative
30241 to left edge of W's TEXT area. Adjust it. */
30242 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30243 cr
.y
= w
->phys_cursor
.y
;
30244 cr
.width
= cursor_glyph
->pixel_width
;
30245 cr
.height
= w
->phys_cursor_height
;
30246 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30247 I assume the effect is the same -- and this is portable. */
30248 return x_intersect_rectangles (&cr
, r
, &result
);
30250 /* If we don't understand the format, pretend we're not in the hot-spot. */
30256 Draw a vertical window border to the right of window W if W doesn't
30257 have vertical scroll bars. */
30260 x_draw_vertical_border (struct window
*w
)
30262 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30264 /* We could do better, if we knew what type of scroll-bar the adjacent
30265 windows (on either side) have... But we don't :-(
30266 However, I think this works ok. ++KFS 2003-04-25 */
30268 /* Redraw borders between horizontally adjacent windows. Don't
30269 do it for frames with vertical scroll bars because either the
30270 right scroll bar of a window, or the left scroll bar of its
30271 neighbor will suffice as a border. */
30272 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30275 /* Note: It is necessary to redraw both the left and the right
30276 borders, for when only this single window W is being
30278 if (!WINDOW_RIGHTMOST_P (w
)
30279 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30281 int x0
, x1
, y0
, y1
;
30283 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30286 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30289 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30292 if (!WINDOW_LEFTMOST_P (w
)
30293 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30295 int x0
, x1
, y0
, y1
;
30297 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30300 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30303 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30308 /* Draw window dividers for window W. */
30311 x_draw_right_divider (struct window
*w
)
30313 struct frame
*f
= WINDOW_XFRAME (w
);
30315 if (w
->mini
|| w
->pseudo_window_p
)
30317 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30319 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30320 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30321 int y0
= WINDOW_TOP_EDGE_Y (w
);
30322 /* The bottom divider prevails. */
30323 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30325 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30330 x_draw_bottom_divider (struct window
*w
)
30332 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30334 if (w
->mini
|| w
->pseudo_window_p
)
30336 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30338 int x0
= WINDOW_LEFT_EDGE_X (w
);
30339 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30340 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30341 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30343 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30347 /* Redraw the part of window W intersection rectangle FR. Pixel
30348 coordinates in FR are frame-relative. Call this function with
30349 input blocked. Value is true if the exposure overwrites
30353 expose_window (struct window
*w
, XRectangle
*fr
)
30355 struct frame
*f
= XFRAME (w
->frame
);
30357 bool mouse_face_overwritten_p
= false;
30359 /* If window is not yet fully initialized, do nothing. This can
30360 happen when toolkit scroll bars are used and a window is split.
30361 Reconfiguring the scroll bar will generate an expose for a newly
30363 if (w
->current_matrix
== NULL
)
30366 /* When we're currently updating the window, display and current
30367 matrix usually don't agree. Arrange for a thorough display
30369 if (w
->must_be_updated_p
)
30371 SET_FRAME_GARBAGED (f
);
30375 /* Frame-relative pixel rectangle of W. */
30376 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30377 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30378 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30379 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30381 if (x_intersect_rectangles (fr
, &wr
, &r
))
30383 int yb
= window_text_bottom_y (w
);
30384 struct glyph_row
*row
;
30385 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30387 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30388 r
.x
, r
.y
, r
.width
, r
.height
));
30390 /* Convert to window coordinates. */
30391 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30392 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30394 /* Turn off the cursor. */
30395 bool cursor_cleared_p
= (!w
->pseudo_window_p
30396 && phys_cursor_in_rect_p (w
, &r
));
30397 if (cursor_cleared_p
)
30398 x_clear_cursor (w
);
30400 /* If the row containing the cursor extends face to end of line,
30401 then expose_area might overwrite the cursor outside the
30402 rectangle and thus notice_overwritten_cursor might clear
30403 w->phys_cursor_on_p. We remember the original value and
30404 check later if it is changed. */
30405 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30407 /* Use a signed int intermediate value to avoid catastrophic
30408 failures due to comparison between signed and unsigned, when
30409 y0 or y1 is negative (can happen for tall images). */
30410 int r_bottom
= r
.y
+ r
.height
;
30412 /* Update lines intersecting rectangle R. */
30413 first_overlapping_row
= last_overlapping_row
= NULL
;
30414 for (row
= w
->current_matrix
->rows
;
30419 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30421 if ((y0
>= r
.y
&& y0
< r_bottom
)
30422 || (y1
> r
.y
&& y1
< r_bottom
)
30423 || (r
.y
>= y0
&& r
.y
< y1
)
30424 || (r_bottom
> y0
&& r_bottom
< y1
))
30426 /* A header line may be overlapping, but there is no need
30427 to fix overlapping areas for them. KFS 2005-02-12 */
30428 if (row
->overlapping_p
&& !row
->mode_line_p
)
30430 if (first_overlapping_row
== NULL
)
30431 first_overlapping_row
= row
;
30432 last_overlapping_row
= row
;
30436 if (expose_line (w
, row
, &r
))
30437 mouse_face_overwritten_p
= true;
30440 else if (row
->overlapping_p
)
30442 /* We must redraw a row overlapping the exposed area. */
30444 ? y0
+ row
->phys_height
> r
.y
30445 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30447 if (first_overlapping_row
== NULL
)
30448 first_overlapping_row
= row
;
30449 last_overlapping_row
= row
;
30457 /* Display the mode line if there is one. */
30458 if (WINDOW_WANTS_MODELINE_P (w
)
30459 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30461 && row
->y
< r_bottom
)
30463 if (expose_line (w
, row
, &r
))
30464 mouse_face_overwritten_p
= true;
30467 if (!w
->pseudo_window_p
)
30469 /* Fix the display of overlapping rows. */
30470 if (first_overlapping_row
)
30471 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30474 /* Draw border between windows. */
30475 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30476 x_draw_right_divider (w
);
30478 x_draw_vertical_border (w
);
30480 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30481 x_draw_bottom_divider (w
);
30483 /* Turn the cursor on again. */
30484 if (cursor_cleared_p
30485 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30486 update_window_cursor (w
, true);
30490 return mouse_face_overwritten_p
;
30495 /* Redraw (parts) of all windows in the window tree rooted at W that
30496 intersect R. R contains frame pixel coordinates. Value is
30497 true if the exposure overwrites mouse-face. */
30500 expose_window_tree (struct window
*w
, XRectangle
*r
)
30502 struct frame
*f
= XFRAME (w
->frame
);
30503 bool mouse_face_overwritten_p
= false;
30505 while (w
&& !FRAME_GARBAGED_P (f
))
30507 mouse_face_overwritten_p
30508 |= (WINDOWP (w
->contents
)
30509 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30510 : expose_window (w
, r
));
30512 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30515 return mouse_face_overwritten_p
;
30520 Redisplay an exposed area of frame F. X and Y are the upper-left
30521 corner of the exposed rectangle. W and H are width and height of
30522 the exposed area. All are pixel values. W or H zero means redraw
30523 the entire frame. */
30526 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30529 bool mouse_face_overwritten_p
= false;
30531 TRACE ((stderr
, "expose_frame "));
30533 /* No need to redraw if frame will be redrawn soon. */
30534 if (FRAME_GARBAGED_P (f
))
30536 TRACE ((stderr
, " garbaged\n"));
30540 /* If basic faces haven't been realized yet, there is no point in
30541 trying to redraw anything. This can happen when we get an expose
30542 event while Emacs is starting, e.g. by moving another window. */
30543 if (FRAME_FACE_CACHE (f
) == NULL
30544 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30546 TRACE ((stderr
, " no faces\n"));
30550 if (w
== 0 || h
== 0)
30553 r
.width
= FRAME_TEXT_WIDTH (f
);
30554 r
.height
= FRAME_TEXT_HEIGHT (f
);
30564 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30565 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30567 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30568 if (WINDOWP (f
->tool_bar_window
))
30569 mouse_face_overwritten_p
30570 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30573 #ifdef HAVE_X_WINDOWS
30575 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30576 if (WINDOWP (f
->menu_bar_window
))
30577 mouse_face_overwritten_p
30578 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30579 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30583 /* Some window managers support a focus-follows-mouse style with
30584 delayed raising of frames. Imagine a partially obscured frame,
30585 and moving the mouse into partially obscured mouse-face on that
30586 frame. The visible part of the mouse-face will be highlighted,
30587 then the WM raises the obscured frame. With at least one WM, KDE
30588 2.1, Emacs is not getting any event for the raising of the frame
30589 (even tried with SubstructureRedirectMask), only Expose events.
30590 These expose events will draw text normally, i.e. not
30591 highlighted. Which means we must redo the highlight here.
30592 Subsume it under ``we love X''. --gerd 2001-08-15 */
30593 /* Included in Windows version because Windows most likely does not
30594 do the right thing if any third party tool offers
30595 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30596 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30598 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30599 if (f
== hlinfo
->mouse_face_mouse_frame
)
30601 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30602 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30603 clear_mouse_face (hlinfo
);
30604 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30611 Determine the intersection of two rectangles R1 and R2. Return
30612 the intersection in *RESULT. Value is true if RESULT is not
30616 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30618 XRectangle
*left
, *right
;
30619 XRectangle
*upper
, *lower
;
30620 bool intersection_p
= false;
30622 /* Rearrange so that R1 is the left-most rectangle. */
30624 left
= r1
, right
= r2
;
30626 left
= r2
, right
= r1
;
30628 /* X0 of the intersection is right.x0, if this is inside R1,
30629 otherwise there is no intersection. */
30630 if (right
->x
<= left
->x
+ left
->width
)
30632 result
->x
= right
->x
;
30634 /* The right end of the intersection is the minimum of
30635 the right ends of left and right. */
30636 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30639 /* Same game for Y. */
30641 upper
= r1
, lower
= r2
;
30643 upper
= r2
, lower
= r1
;
30645 /* The upper end of the intersection is lower.y0, if this is inside
30646 of upper. Otherwise, there is no intersection. */
30647 if (lower
->y
<= upper
->y
+ upper
->height
)
30649 result
->y
= lower
->y
;
30651 /* The lower end of the intersection is the minimum of the lower
30652 ends of upper and lower. */
30653 result
->height
= (min (lower
->y
+ lower
->height
,
30654 upper
->y
+ upper
->height
)
30656 intersection_p
= true;
30660 return intersection_p
;
30663 #endif /* HAVE_WINDOW_SYSTEM */
30666 /***********************************************************************
30668 ***********************************************************************/
30671 syms_of_xdisp (void)
30673 Vwith_echo_area_save_vector
= Qnil
;
30674 staticpro (&Vwith_echo_area_save_vector
);
30676 Vmessage_stack
= Qnil
;
30677 staticpro (&Vmessage_stack
);
30679 /* Non-nil means don't actually do any redisplay. */
30680 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30682 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30684 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30685 doc
: /* Non-nil means calls to `message' are not displayed.
30686 They are still logged to the *Messages* buffer. */);
30687 inhibit_message
= 0;
30689 message_dolog_marker1
= Fmake_marker ();
30690 staticpro (&message_dolog_marker1
);
30691 message_dolog_marker2
= Fmake_marker ();
30692 staticpro (&message_dolog_marker2
);
30693 message_dolog_marker3
= Fmake_marker ();
30694 staticpro (&message_dolog_marker3
);
30697 defsubr (&Sdump_frame_glyph_matrix
);
30698 defsubr (&Sdump_glyph_matrix
);
30699 defsubr (&Sdump_glyph_row
);
30700 defsubr (&Sdump_tool_bar_row
);
30701 defsubr (&Strace_redisplay
);
30702 defsubr (&Strace_to_stderr
);
30704 #ifdef HAVE_WINDOW_SYSTEM
30705 defsubr (&Stool_bar_height
);
30706 defsubr (&Slookup_image_map
);
30708 defsubr (&Sline_pixel_height
);
30709 defsubr (&Sformat_mode_line
);
30710 defsubr (&Sinvisible_p
);
30711 defsubr (&Scurrent_bidi_paragraph_direction
);
30712 defsubr (&Swindow_text_pixel_size
);
30713 defsubr (&Smove_point_visually
);
30714 defsubr (&Sbidi_find_overridden_directionality
);
30716 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30717 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30718 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30719 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30720 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30721 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30722 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30723 DEFSYM (Qeval
, "eval");
30724 DEFSYM (QCdata
, ":data");
30726 /* Names of text properties relevant for redisplay. */
30727 DEFSYM (Qdisplay
, "display");
30728 DEFSYM (Qspace_width
, "space-width");
30729 DEFSYM (Qraise
, "raise");
30730 DEFSYM (Qslice
, "slice");
30731 DEFSYM (Qspace
, "space");
30732 DEFSYM (Qmargin
, "margin");
30733 DEFSYM (Qpointer
, "pointer");
30734 DEFSYM (Qleft_margin
, "left-margin");
30735 DEFSYM (Qright_margin
, "right-margin");
30736 DEFSYM (Qcenter
, "center");
30737 DEFSYM (Qline_height
, "line-height");
30738 DEFSYM (QCalign_to
, ":align-to");
30739 DEFSYM (QCrelative_width
, ":relative-width");
30740 DEFSYM (QCrelative_height
, ":relative-height");
30741 DEFSYM (QCeval
, ":eval");
30742 DEFSYM (QCpropertize
, ":propertize");
30743 DEFSYM (QCfile
, ":file");
30744 DEFSYM (Qfontified
, "fontified");
30745 DEFSYM (Qfontification_functions
, "fontification-functions");
30747 /* Name of the face used to highlight trailing whitespace. */
30748 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30750 /* Name and number of the face used to highlight escape glyphs. */
30751 DEFSYM (Qescape_glyph
, "escape-glyph");
30753 /* Name and number of the face used to highlight non-breaking spaces. */
30754 DEFSYM (Qnobreak_space
, "nobreak-space");
30756 /* The symbol 'image' which is the car of the lists used to represent
30757 images in Lisp. Also a tool bar style. */
30758 DEFSYM (Qimage
, "image");
30760 /* Tool bar styles. */
30761 DEFSYM (Qtext
, "text");
30762 DEFSYM (Qboth
, "both");
30763 DEFSYM (Qboth_horiz
, "both-horiz");
30764 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30766 /* The image map types. */
30767 DEFSYM (QCmap
, ":map");
30768 DEFSYM (QCpointer
, ":pointer");
30769 DEFSYM (Qrect
, "rect");
30770 DEFSYM (Qcircle
, "circle");
30771 DEFSYM (Qpoly
, "poly");
30773 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30775 DEFSYM (Qgrow_only
, "grow-only");
30776 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30777 DEFSYM (Qposition
, "position");
30778 DEFSYM (Qbuffer_position
, "buffer-position");
30779 DEFSYM (Qobject
, "object");
30781 /* Cursor shapes. */
30782 DEFSYM (Qbar
, "bar");
30783 DEFSYM (Qhbar
, "hbar");
30784 DEFSYM (Qbox
, "box");
30785 DEFSYM (Qhollow
, "hollow");
30787 /* Pointer shapes. */
30788 DEFSYM (Qhand
, "hand");
30789 DEFSYM (Qarrow
, "arrow");
30792 DEFSYM (Qdragging
, "dragging");
30794 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30796 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30797 staticpro (&list_of_error
);
30799 /* Values of those variables at last redisplay are stored as
30800 properties on 'overlay-arrow-position' symbol. However, if
30801 Voverlay_arrow_position is a marker, last-arrow-position is its
30802 numerical position. */
30803 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30804 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30806 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30807 properties on a symbol in overlay-arrow-variable-list. */
30808 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30809 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30811 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30812 staticpro (&echo_buffer
[0]);
30813 staticpro (&echo_buffer
[1]);
30815 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30816 staticpro (&echo_area_buffer
[0]);
30817 staticpro (&echo_area_buffer
[1]);
30819 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30820 staticpro (&Vmessages_buffer_name
);
30822 mode_line_proptrans_alist
= Qnil
;
30823 staticpro (&mode_line_proptrans_alist
);
30824 mode_line_string_list
= Qnil
;
30825 staticpro (&mode_line_string_list
);
30826 mode_line_string_face
= Qnil
;
30827 staticpro (&mode_line_string_face
);
30828 mode_line_string_face_prop
= Qnil
;
30829 staticpro (&mode_line_string_face_prop
);
30830 Vmode_line_unwind_vector
= Qnil
;
30831 staticpro (&Vmode_line_unwind_vector
);
30833 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30835 help_echo_string
= Qnil
;
30836 staticpro (&help_echo_string
);
30837 help_echo_object
= Qnil
;
30838 staticpro (&help_echo_object
);
30839 help_echo_window
= Qnil
;
30840 staticpro (&help_echo_window
);
30841 previous_help_echo_string
= Qnil
;
30842 staticpro (&previous_help_echo_string
);
30843 help_echo_pos
= -1;
30845 DEFSYM (Qright_to_left
, "right-to-left");
30846 DEFSYM (Qleft_to_right
, "left-to-right");
30847 defsubr (&Sbidi_resolved_levels
);
30849 #ifdef HAVE_WINDOW_SYSTEM
30850 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30851 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30852 For example, if a block cursor is over a tab, it will be drawn as
30853 wide as that tab on the display. */);
30854 x_stretch_cursor_p
= 0;
30857 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30858 doc
: /* Non-nil means highlight trailing whitespace.
30859 The face used for trailing whitespace is `trailing-whitespace'. */);
30860 Vshow_trailing_whitespace
= Qnil
;
30862 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30863 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30864 If the value is t, Emacs highlights non-ASCII chars which have the
30865 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30866 or `escape-glyph' face respectively.
30868 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30869 U+2011 (non-breaking hyphen) are affected.
30871 Any other non-nil value means to display these characters as a escape
30872 glyph followed by an ordinary space or hyphen.
30874 A value of nil means no special handling of these characters. */);
30875 Vnobreak_char_display
= Qt
;
30877 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30878 doc
: /* The pointer shape to show in void text areas.
30879 A value of nil means to show the text pointer. Other options are
30880 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30882 Vvoid_text_area_pointer
= Qarrow
;
30884 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30885 doc
: /* Non-nil means don't actually do any redisplay.
30886 This is used for internal purposes. */);
30887 Vinhibit_redisplay
= Qnil
;
30889 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30890 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30891 Vglobal_mode_string
= Qnil
;
30893 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30894 doc
: /* Marker for where to display an arrow on top of the buffer text.
30895 This must be the beginning of a line in order to work.
30896 See also `overlay-arrow-string'. */);
30897 Voverlay_arrow_position
= Qnil
;
30899 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30900 doc
: /* String to display as an arrow in non-window frames.
30901 See also `overlay-arrow-position'. */);
30902 Voverlay_arrow_string
= build_pure_c_string ("=>");
30904 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30905 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30906 The symbols on this list are examined during redisplay to determine
30907 where to display overlay arrows. */);
30908 Voverlay_arrow_variable_list
30909 = list1 (intern_c_string ("overlay-arrow-position"));
30911 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30912 doc
: /* The number of lines to try scrolling a window by when point moves out.
30913 If that fails to bring point back on frame, point is centered instead.
30914 If this is zero, point is always centered after it moves off frame.
30915 If you want scrolling to always be a line at a time, you should set
30916 `scroll-conservatively' to a large value rather than set this to 1. */);
30918 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30919 doc
: /* Scroll up to this many lines, to bring point back on screen.
30920 If point moves off-screen, redisplay will scroll by up to
30921 `scroll-conservatively' lines in order to bring point just barely
30922 onto the screen again. If that cannot be done, then redisplay
30923 recenters point as usual.
30925 If the value is greater than 100, redisplay will never recenter point,
30926 but will always scroll just enough text to bring point into view, even
30927 if you move far away.
30929 A value of zero means always recenter point if it moves off screen. */);
30930 scroll_conservatively
= 0;
30932 DEFVAR_INT ("scroll-margin", scroll_margin
,
30933 doc
: /* Number of lines of margin at the top and bottom of a window.
30934 Recenter the window whenever point gets within this many lines
30935 of the top or bottom of the window. */);
30938 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30939 doc
: /* Pixels per inch value for non-window system displays.
30940 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30941 Vdisplay_pixels_per_inch
= make_float (72.0);
30944 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30947 DEFVAR_LISP ("truncate-partial-width-windows",
30948 Vtruncate_partial_width_windows
,
30949 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30950 For an integer value, truncate lines in each window narrower than the
30951 full frame width, provided the window width is less than that integer;
30952 otherwise, respect the value of `truncate-lines'.
30954 For any other non-nil value, truncate lines in all windows that do
30955 not span the full frame width.
30957 A value of nil means to respect the value of `truncate-lines'.
30959 If `word-wrap' is enabled, you might want to reduce this. */);
30960 Vtruncate_partial_width_windows
= make_number (50);
30962 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30963 doc
: /* Maximum buffer size for which line number should be displayed.
30964 If the buffer is bigger than this, the line number does not appear
30965 in the mode line. A value of nil means no limit. */);
30966 Vline_number_display_limit
= Qnil
;
30968 DEFVAR_INT ("line-number-display-limit-width",
30969 line_number_display_limit_width
,
30970 doc
: /* Maximum line width (in characters) for line number display.
30971 If the average length of the lines near point is bigger than this, then the
30972 line number may be omitted from the mode line. */);
30973 line_number_display_limit_width
= 200;
30975 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30976 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30977 highlight_nonselected_windows
= false;
30979 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30980 doc
: /* Non-nil if more than one frame is visible on this display.
30981 Minibuffer-only frames don't count, but iconified frames do.
30982 This variable is not guaranteed to be accurate except while processing
30983 `frame-title-format' and `icon-title-format'. */);
30985 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30986 doc
: /* Template for displaying the title bar of visible frames.
30987 \(Assuming the window manager supports this feature.)
30989 This variable has the same structure as `mode-line-format', except that
30990 the %c and %l constructs are ignored. It is used only on frames for
30991 which no explicit name has been set \(see `modify-frame-parameters'). */);
30993 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30994 doc
: /* Template for displaying the title bar of an iconified frame.
30995 \(Assuming the window manager supports this feature.)
30996 This variable has the same structure as `mode-line-format' (which see),
30997 and is used only on frames for which no explicit name has been set
30998 \(see `modify-frame-parameters'). */);
31000 = Vframe_title_format
31001 = listn (CONSTYPE_PURE
, 3,
31002 intern_c_string ("multiple-frames"),
31003 build_pure_c_string ("%b"),
31004 listn (CONSTYPE_PURE
, 4,
31005 empty_unibyte_string
,
31006 intern_c_string ("invocation-name"),
31007 build_pure_c_string ("@"),
31008 intern_c_string ("system-name")));
31010 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31011 doc
: /* Maximum number of lines to keep in the message log buffer.
31012 If nil, disable message logging. If t, log messages but don't truncate
31013 the buffer when it becomes large. */);
31014 Vmessage_log_max
= make_number (1000);
31016 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31017 doc
: /* Functions called before redisplay, if window sizes have changed.
31018 The value should be a list of functions that take one argument.
31019 Just before redisplay, for each frame, if any of its windows have changed
31020 size since the last redisplay, or have been split or deleted,
31021 all the functions in the list are called, with the frame as argument. */);
31022 Vwindow_size_change_functions
= Qnil
;
31024 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31025 doc
: /* List of functions to call before redisplaying a window with scrolling.
31026 Each function is called with two arguments, the window and its new
31027 display-start position.
31028 These functions are called whenever the `window-start' marker is modified,
31029 either to point into another buffer (e.g. via `set-window-buffer') or another
31030 place in the same buffer.
31031 Note that the value of `window-end' is not valid when these functions are
31034 Warning: Do not use this feature to alter the way the window
31035 is scrolled. It is not designed for that, and such use probably won't
31037 Vwindow_scroll_functions
= Qnil
;
31039 DEFVAR_LISP ("window-text-change-functions",
31040 Vwindow_text_change_functions
,
31041 doc
: /* Functions to call in redisplay when text in the window might change. */);
31042 Vwindow_text_change_functions
= Qnil
;
31044 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31045 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31046 Each function is called with two arguments, the window and the end trigger value.
31047 See `set-window-redisplay-end-trigger'. */);
31048 Vredisplay_end_trigger_functions
= Qnil
;
31050 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31051 doc
: /* Non-nil means autoselect window with mouse pointer.
31052 If nil, do not autoselect windows.
31053 A positive number means delay autoselection by that many seconds: a
31054 window is autoselected only after the mouse has remained in that
31055 window for the duration of the delay.
31056 A negative number has a similar effect, but causes windows to be
31057 autoselected only after the mouse has stopped moving. \(Because of
31058 the way Emacs compares mouse events, you will occasionally wait twice
31059 that time before the window gets selected.\)
31060 Any other value means to autoselect window instantaneously when the
31061 mouse pointer enters it.
31063 Autoselection selects the minibuffer only if it is active, and never
31064 unselects the minibuffer if it is active.
31066 When customizing this variable make sure that the actual value of
31067 `focus-follows-mouse' matches the behavior of your window manager. */);
31068 Vmouse_autoselect_window
= Qnil
;
31070 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31071 doc
: /* Non-nil means automatically resize tool-bars.
31072 This dynamically changes the tool-bar's height to the minimum height
31073 that is needed to make all tool-bar items visible.
31074 If value is `grow-only', the tool-bar's height is only increased
31075 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31076 Vauto_resize_tool_bars
= Qt
;
31078 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31079 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31080 auto_raise_tool_bar_buttons_p
= true;
31082 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31083 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31084 make_cursor_line_fully_visible_p
= true;
31086 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31087 doc
: /* Border below tool-bar in pixels.
31088 If an integer, use it as the height of the border.
31089 If it is one of `internal-border-width' or `border-width', use the
31090 value of the corresponding frame parameter.
31091 Otherwise, no border is added below the tool-bar. */);
31092 Vtool_bar_border
= Qinternal_border_width
;
31094 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31095 doc
: /* Margin around tool-bar buttons in pixels.
31096 If an integer, use that for both horizontal and vertical margins.
31097 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31098 HORZ specifying the horizontal margin, and VERT specifying the
31099 vertical margin. */);
31100 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31102 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31103 doc
: /* Relief thickness of tool-bar buttons. */);
31104 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31106 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31107 doc
: /* Tool bar style to use.
31109 image - show images only
31110 text - show text only
31111 both - show both, text below image
31112 both-horiz - show text to the right of the image
31113 text-image-horiz - show text to the left of the image
31114 any other - use system default or image if no system default.
31116 This variable only affects the GTK+ toolkit version of Emacs. */);
31117 Vtool_bar_style
= Qnil
;
31119 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31120 doc
: /* Maximum number of characters a label can have to be shown.
31121 The tool bar style must also show labels for this to have any effect, see
31122 `tool-bar-style'. */);
31123 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31125 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31126 doc
: /* List of functions to call to fontify regions of text.
31127 Each function is called with one argument POS. Functions must
31128 fontify a region starting at POS in the current buffer, and give
31129 fontified regions the property `fontified'. */);
31130 Vfontification_functions
= Qnil
;
31131 Fmake_variable_buffer_local (Qfontification_functions
);
31133 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31134 unibyte_display_via_language_environment
,
31135 doc
: /* Non-nil means display unibyte text according to language environment.
31136 Specifically, this means that raw bytes in the range 160-255 decimal
31137 are displayed by converting them to the equivalent multibyte characters
31138 according to the current language environment. As a result, they are
31139 displayed according to the current fontset.
31141 Note that this variable affects only how these bytes are displayed,
31142 but does not change the fact they are interpreted as raw bytes. */);
31143 unibyte_display_via_language_environment
= false;
31145 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31146 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31147 If a float, it specifies a fraction of the mini-window frame's height.
31148 If an integer, it specifies a number of lines. */);
31149 Vmax_mini_window_height
= make_float (0.25);
31151 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31152 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31153 A value of nil means don't automatically resize mini-windows.
31154 A value of t means resize them to fit the text displayed in them.
31155 A value of `grow-only', the default, means let mini-windows grow only;
31156 they return to their normal size when the minibuffer is closed, or the
31157 echo area becomes empty. */);
31158 Vresize_mini_windows
= Qgrow_only
;
31160 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31161 doc
: /* Alist specifying how to blink the cursor off.
31162 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31163 `cursor-type' frame-parameter or variable equals ON-STATE,
31164 comparing using `equal', Emacs uses OFF-STATE to specify
31165 how to blink it off. ON-STATE and OFF-STATE are values for
31166 the `cursor-type' frame parameter.
31168 If a frame's ON-STATE has no entry in this list,
31169 the frame's other specifications determine how to blink the cursor off. */);
31170 Vblink_cursor_alist
= Qnil
;
31172 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31173 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31174 If non-nil, windows are automatically scrolled horizontally to make
31175 point visible. */);
31176 automatic_hscrolling_p
= true;
31177 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31179 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31180 doc
: /* How many columns away from the window edge point is allowed to get
31181 before automatic hscrolling will horizontally scroll the window. */);
31182 hscroll_margin
= 5;
31184 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31185 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31186 When point is less than `hscroll-margin' columns from the window
31187 edge, automatic hscrolling will scroll the window by the amount of columns
31188 determined by this variable. If its value is a positive integer, scroll that
31189 many columns. If it's a positive floating-point number, it specifies the
31190 fraction of the window's width to scroll. If it's nil or zero, point will be
31191 centered horizontally after the scroll. Any other value, including negative
31192 numbers, are treated as if the value were zero.
31194 Automatic hscrolling always moves point outside the scroll margin, so if
31195 point was more than scroll step columns inside the margin, the window will
31196 scroll more than the value given by the scroll step.
31198 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31199 and `scroll-right' overrides this variable's effect. */);
31200 Vhscroll_step
= make_number (0);
31202 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31203 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31204 Bind this around calls to `message' to let it take effect. */);
31205 message_truncate_lines
= false;
31207 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31208 doc
: /* Normal hook run to update the menu bar definitions.
31209 Redisplay runs this hook before it redisplays the menu bar.
31210 This is used to update menus such as Buffers, whose contents depend on
31212 Vmenu_bar_update_hook
= Qnil
;
31214 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31215 doc
: /* Frame for which we are updating a menu.
31216 The enable predicate for a menu binding should check this variable. */);
31217 Vmenu_updating_frame
= Qnil
;
31219 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31220 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31221 inhibit_menubar_update
= false;
31223 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31224 doc
: /* Prefix prepended to all continuation lines at display time.
31225 The value may be a string, an image, or a stretch-glyph; it is
31226 interpreted in the same way as the value of a `display' text property.
31228 This variable is overridden by any `wrap-prefix' text or overlay
31231 To add a prefix to non-continuation lines, use `line-prefix'. */);
31232 Vwrap_prefix
= Qnil
;
31233 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31234 Fmake_variable_buffer_local (Qwrap_prefix
);
31236 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31237 doc
: /* Prefix prepended to all non-continuation lines at display time.
31238 The value may be a string, an image, or a stretch-glyph; it is
31239 interpreted in the same way as the value of a `display' text property.
31241 This variable is overridden by any `line-prefix' text or overlay
31244 To add a prefix to continuation lines, use `wrap-prefix'. */);
31245 Vline_prefix
= Qnil
;
31246 DEFSYM (Qline_prefix
, "line-prefix");
31247 Fmake_variable_buffer_local (Qline_prefix
);
31249 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31250 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31251 inhibit_eval_during_redisplay
= false;
31253 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31254 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31255 inhibit_free_realized_faces
= false;
31257 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31258 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31259 Intended for use during debugging and for testing bidi display;
31260 see biditest.el in the test suite. */);
31261 inhibit_bidi_mirroring
= false;
31264 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31265 doc
: /* Inhibit try_window_id display optimization. */);
31266 inhibit_try_window_id
= false;
31268 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31269 doc
: /* Inhibit try_window_reusing display optimization. */);
31270 inhibit_try_window_reusing
= false;
31272 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31273 doc
: /* Inhibit try_cursor_movement display optimization. */);
31274 inhibit_try_cursor_movement
= false;
31275 #endif /* GLYPH_DEBUG */
31277 DEFVAR_INT ("overline-margin", overline_margin
,
31278 doc
: /* Space between overline and text, in pixels.
31279 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31280 margin to the character height. */);
31281 overline_margin
= 2;
31283 DEFVAR_INT ("underline-minimum-offset",
31284 underline_minimum_offset
,
31285 doc
: /* Minimum distance between baseline and underline.
31286 This can improve legibility of underlined text at small font sizes,
31287 particularly when using variable `x-use-underline-position-properties'
31288 with fonts that specify an UNDERLINE_POSITION relatively close to the
31289 baseline. The default value is 1. */);
31290 underline_minimum_offset
= 1;
31292 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31293 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31294 This feature only works when on a window system that can change
31295 cursor shapes. */);
31296 display_hourglass_p
= true;
31298 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31299 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31300 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31302 #ifdef HAVE_WINDOW_SYSTEM
31303 hourglass_atimer
= NULL
;
31304 hourglass_shown_p
= false;
31305 #endif /* HAVE_WINDOW_SYSTEM */
31307 /* Name of the face used to display glyphless characters. */
31308 DEFSYM (Qglyphless_char
, "glyphless-char");
31310 /* Method symbols for Vglyphless_char_display. */
31311 DEFSYM (Qhex_code
, "hex-code");
31312 DEFSYM (Qempty_box
, "empty-box");
31313 DEFSYM (Qthin_space
, "thin-space");
31314 DEFSYM (Qzero_width
, "zero-width");
31316 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31317 doc
: /* Function run just before redisplay.
31318 It is called with one argument, which is the set of windows that are to
31319 be redisplayed. This set can be nil (meaning, only the selected window),
31320 or t (meaning all windows). */);
31321 Vpre_redisplay_function
= intern ("ignore");
31323 /* Symbol for the purpose of Vglyphless_char_display. */
31324 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31325 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31327 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31328 doc
: /* Char-table defining glyphless characters.
31329 Each element, if non-nil, should be one of the following:
31330 an ASCII acronym string: display this string in a box
31331 `hex-code': display the hexadecimal code of a character in a box
31332 `empty-box': display as an empty box
31333 `thin-space': display as 1-pixel width space
31334 `zero-width': don't display
31335 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31336 display method for graphical terminals and text terminals respectively.
31337 GRAPHICAL and TEXT should each have one of the values listed above.
31339 The char-table has one extra slot to control the display of a character for
31340 which no font is found. This slot only takes effect on graphical terminals.
31341 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31342 `thin-space'. The default is `empty-box'.
31344 If a character has a non-nil entry in an active display table, the
31345 display table takes effect; in this case, Emacs does not consult
31346 `glyphless-char-display' at all. */);
31347 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31348 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31351 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31352 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31353 Vdebug_on_message
= Qnil
;
31355 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31357 Vredisplay__all_windows_cause
31358 = Fmake_vector (make_number (100), make_number (0));
31360 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31362 Vredisplay__mode_lines_cause
31363 = Fmake_vector (make_number (100), make_number (0));
31367 /* Initialize this module when Emacs starts. */
31372 CHARPOS (this_line_start_pos
) = 0;
31374 if (!noninteractive
)
31376 struct window
*m
= XWINDOW (minibuf_window
);
31377 Lisp_Object frame
= m
->frame
;
31378 struct frame
*f
= XFRAME (frame
);
31379 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31380 struct window
*r
= XWINDOW (root
);
31383 echo_area_window
= minibuf_window
;
31385 r
->top_line
= FRAME_TOP_MARGIN (f
);
31386 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31387 r
->total_cols
= FRAME_COLS (f
);
31388 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31389 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31390 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31392 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31393 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31394 m
->total_cols
= FRAME_COLS (f
);
31395 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31396 m
->total_lines
= 1;
31397 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31399 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31400 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31401 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31403 /* The default ellipsis glyphs `...'. */
31404 for (i
= 0; i
< 3; ++i
)
31405 default_invis_vector
[i
] = make_number ('.');
31409 /* Allocate the buffer for frame titles.
31410 Also used for `format-mode-line'. */
31412 mode_line_noprop_buf
= xmalloc (size
);
31413 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31414 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31415 mode_line_target
= MODE_LINE_DISPLAY
;
31418 help_echo_showing_p
= false;
31421 #ifdef HAVE_WINDOW_SYSTEM
31423 /* Platform-independent portion of hourglass implementation. */
31425 /* Timer function of hourglass_atimer. */
31428 show_hourglass (struct atimer
*timer
)
31430 /* The timer implementation will cancel this timer automatically
31431 after this function has run. Set hourglass_atimer to null
31432 so that we know the timer doesn't have to be canceled. */
31433 hourglass_atimer
= NULL
;
31435 if (!hourglass_shown_p
)
31437 Lisp_Object tail
, frame
;
31441 FOR_EACH_FRAME (tail
, frame
)
31443 struct frame
*f
= XFRAME (frame
);
31445 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31446 && FRAME_RIF (f
)->show_hourglass
)
31447 FRAME_RIF (f
)->show_hourglass (f
);
31450 hourglass_shown_p
= true;
31455 /* Cancel a currently active hourglass timer, and start a new one. */
31458 start_hourglass (void)
31460 struct timespec delay
;
31462 cancel_hourglass ();
31464 if (INTEGERP (Vhourglass_delay
)
31465 && XINT (Vhourglass_delay
) > 0)
31466 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31467 TYPE_MAXIMUM (time_t)),
31469 else if (FLOATP (Vhourglass_delay
)
31470 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31471 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31473 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31475 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31476 show_hourglass
, NULL
);
31479 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31483 cancel_hourglass (void)
31485 if (hourglass_atimer
)
31487 cancel_atimer (hourglass_atimer
);
31488 hourglass_atimer
= NULL
;
31491 if (hourglass_shown_p
)
31493 Lisp_Object tail
, frame
;
31497 FOR_EACH_FRAME (tail
, frame
)
31499 struct frame
*f
= XFRAME (frame
);
31501 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31502 && FRAME_RIF (f
)->hide_hourglass
)
31503 FRAME_RIF (f
)->hide_hourglass (f
);
31505 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31506 else if (!FRAME_W32_P (f
))
31507 w32_arrow_cursor ();
31511 hourglass_shown_p
= false;
31516 #endif /* HAVE_WINDOW_SYSTEM */