; Auto-commit of loaddefs files.
[emacs.git] / src / xdisp.c
blob8be74977b433df913a892c1432f825b134c5d8eb
1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
4 Inc.
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>.
23 Redisplay.
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
28 the display.
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) +----------------+ |
49 ^ | |
50 +----------------------------------+ |
51 Don't use this path when called |
52 asynchronously! |
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
71 terminology.
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
83 following functions:
85 . try_cursor_movement
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
95 scrolling).
97 . try_window_id
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
103 somesuch.)
105 . try_window
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.
131 Desired matrices.
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)
145 argument.
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
162 see in dispextern.h.
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).
176 Frame matrices.
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
245 category.
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. */
289 #include <config.h>
290 #include <stdio.h>
291 #include <limits.h>
293 #include "lisp.h"
294 #include "atimer.h"
295 #include "keyboard.h"
296 #include "frame.h"
297 #include "window.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
301 #include "buffer.h"
302 #include "charset.h"
303 #include "indent.h"
304 #include "commands.h"
305 #include "keymap.h"
306 #include "macros.h"
307 #include "disptab.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
311 #include "coding.h"
312 #include "process.h"
313 #include "region-cache.h"
314 #include "font.h"
315 #include "fontset.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
318 #include TERM_HEADER
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
323 #endif
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')) \
356 || (it->s \
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
441 full-redisplay). */
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
450 full-redisplay). */
452 int windows_or_buffers_changed;
454 /* True after display_mode_line if %l was used and it displayed a
455 line number. */
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
482 message. */
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) \
522 do { \
523 if (CACHE) \
524 bidi_unshelve_cache (CACHE, true); \
525 ITCOPY = ITORIG; \
526 CACHE = bidi_shelve_cache (); \
527 } while (false)
529 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
530 do { \
531 if (pITORIG != pITCOPY) \
532 *(pITORIG) = *(pITCOPY); \
533 bidi_unshelve_cache (CACHE, false); \
534 CACHE = NULL; \
535 } while (false)
537 /* Functions to mark elements as needing redisplay. */
538 enum { REDISPLAY_SOME = 2}; /* Arbitrary choice. */
540 void
541 redisplay_other_windows (void)
543 if (!windows_or_buffers_changed)
544 windows_or_buffers_changed = REDISPLAY_SOME;
547 void
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 ();
553 w->redisplay = true;
556 void
557 fset_redisplay (struct frame *f)
559 redisplay_other_windows ();
560 f->redisplay = true;
563 void
564 bset_redisplay (struct buffer *b)
566 int count = buffer_window_count (b);
567 if (count > 0)
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
574 not be omitted. */
575 b->text->redisplay = true;
579 void
580 bset_update_mode_line (struct buffer *b)
582 if (!update_mode_lines)
583 update_mode_lines = REDISPLAY_SOME;
584 b->text->redisplay = true;
587 #ifdef GLYPH_DEBUG
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
601 #else
602 #define TRACE_MOVE(x) (void) 0
603 #endif
605 /* Buffer being redisplayed -- for redisplay_window_error. */
607 static struct buffer *displayed_buffer;
609 /* Value returned from text property handlers (see below). */
611 enum prop_handled
613 HANDLED_NORMALLY,
614 HANDLED_RECOMPUTE_PROPS,
615 HANDLED_OVERLAY_STRING_CONSUMED,
616 HANDLED_RETURN
619 /* A description of text properties that redisplay is interested
620 in. */
622 struct props
624 /* The symbol index of the name of the property. */
625 short name;
627 /* A unique index for the property. */
628 enum prop_idx idx;
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},
653 {0, 0, NULL}
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. */
663 enum move_it_result
665 /* Not used. Undefined value. */
666 MOVE_UNDEFINED,
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. */
672 MOVE_X_REACHED,
674 /* Move within a line ended at the end of a line that must be
675 continued. */
676 MOVE_LINE_CONTINUED,
678 /* Move within a line ended at the end of a line that would
679 be displayed truncated. */
680 MOVE_LINE_TRUNCATED,
682 /* Move within a line ended at a line end. */
683 MOVE_NEWLINE_OR_CR
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
689 cleared. */
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 };
702 #endif
704 /* True while redisplay_internal is in progress. */
706 bool redisplaying_p;
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
734 cursor. */
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,
779 int, int);
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,
787 Lisp_Object, bool);
788 static int store_mode_line_string (const char *, Lisp_Object, bool, int, int,
789 Lisp_Object);
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,
793 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 *,
834 enum glyph_row_area,
835 int, int, int, int);
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,
840 int, int, int);
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);
876 return height;
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)
933 : 0);
934 if (ml_row && ml_row->mode_line_p)
935 height -= ml_row->height;
936 else
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)
945 : 0);
946 if (hl_row && hl_row->mode_line_p)
947 height -= hl_row->height;
948 else
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)
964 int x;
966 if (w->pseudo_window_p)
967 return 0;
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. */
994 static int
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),
999 w->pixel_width);
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);
1010 int x;
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));
1018 return x;
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. */
1039 void
1040 window_box (struct window *w, enum glyph_row_area area, int *box_x,
1041 int *box_y, int *box_width, int *box_height)
1043 if (box_width)
1044 *box_width = window_box_width (w, area);
1045 if (box_height)
1046 *box_height = window_box_height (w);
1047 if (box_x)
1048 *box_x = window_box_left (w, area);
1049 if (box_y)
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
1064 box. */
1066 static void
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 /***********************************************************************
1079 Utilities
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)
1093 if (last_height)
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
1100 : last_height);
1102 else
1104 struct glyph_row *row = it->glyph_row;
1106 /* Use the default character height. */
1107 it->glyph_row = NULL;
1108 it->what = IT_CHARACTER;
1109 it->c = ' ';
1110 it->len = 1;
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. */)
1125 (void)
1127 struct it it;
1128 struct text_pos pt;
1129 struct window *w = XWINDOW (selected_window);
1130 struct buffer *old_buffer = NULL;
1131 Lisp_Object result;
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;
1141 last_height = 0;
1142 result = make_number (line_bottom_y (&it));
1143 if (old_buffer)
1144 set_buffer_internal_1 (old_buffer);
1146 return result;
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
1152 parameter.
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
1162 properties. */
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);
1174 if (NILP (val))
1175 val = BVAR (&buffer_defaults, extra_line_spacing);
1176 if (!NILP (val))
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;
1184 if (addon >= 0)
1185 height += addon;
1188 else
1189 height += f->extra_line_spacing;
1192 return height;
1195 /* Subroutine of pos_visible_p below. Extracts a display string, if
1196 any, from the display spec given as its argument. */
1197 static Lisp_Object
1198 string_from_display_spec (Lisp_Object spec)
1200 if (CONSP (spec))
1202 while (CONSP (spec))
1204 if (STRINGP (XCAR (spec)))
1205 return XCAR (spec);
1206 spec = XCDR (spec);
1209 else if (VECTORP (spec))
1211 ptrdiff_t i;
1213 for (i = 0; i < ASIZE (spec); i++)
1215 if (STRINGP (AREF (spec, i)))
1216 return AREF (spec, i);
1218 return Qnil;
1221 return spec;
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. */
1228 static 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). */
1247 bool
1248 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1249 int *rtop, int *rbot, int *rowh, int *vpos)
1251 struct it it;
1252 void *itdata = bidi_shelve_cache ();
1253 struct text_pos top;
1254 bool visible_p = false;
1255 struct buffer *old_buffer = NULL;
1256 bool r2l = false;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1259 return visible_p;
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
1270 our backs. */
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))
1276 w->mode_line_height
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);
1289 if (charpos >= 0
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
1303 glyph. */
1304 int top_x = it.current_x;
1305 int top_y = it.current_y;
1306 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1307 int bottom_y;
1308 struct it save_it;
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);
1313 last_height = 0;
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)
1318 visible_p = true;
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)
1338 visible_p = false;
1341 RESTORE_IT (&it, &save_it, save_it_data);
1342 if (visible_p)
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;
1350 else
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)
1366 it2_prev = it2;
1367 else
1369 /* Iterate until we get out of the display
1370 vector that displays the character at
1371 CHARPOS - 1. */
1372 do {
1373 get_next_display_element (&it2);
1374 PRODUCE_GLYPHS (&it2);
1375 it2_prev = 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;
1383 else
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
1397 = (STRINGP (string)
1398 && memchr (SDATA (string), '\n', SBYTES (string)));
1400 SET_TEXT_POS (tpos, charpos, CHAR_TO_BYTE (charpos));
1401 bool replacing_spec_p
1402 = (!NILP (spec)
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
1414 display string. */
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;
1425 struct it it3;
1427 /* Find the first and the last buffer positions
1428 covered by the display string. */
1429 endpos =
1430 Fnext_single_char_property_change (cpos, Qdisplay,
1431 Qnil, Qnil);
1432 startpos =
1433 Fprevious_single_char_property_change (endpos, Qdisplay,
1434 Qnil, Qnil);
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
1447 && (it3.c == '\n'
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,
1451 it3.current_x
1452 + it3.pixel_width,
1453 MOVE_TO_X)
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
1459 fix that up. */
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;
1467 if (it3.bidi_p)
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
1481 begins. */
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
1497 display line. */
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))
1503 break;
1504 it3_moved = true;
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. */
1515 if (it3_moved
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))
1524 --g;
1525 top_x -= g->pixel_width;
1527 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1528 + it3.glyph_row->used[TEXT_AREA]);
1533 *x = top_x;
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)));
1539 *vpos = it.vpos;
1540 if (it.bidi_it.paragraph_dir == R2L)
1541 r2l = true;
1544 else
1546 /* Either we were asked to provide info about WINDOW_END, or
1547 CHARPOS is in the partially visible glyph row at end of
1548 window. */
1549 struct it it2;
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)))
1558 visible_p = true;
1559 RESTORE_IT (&it2, &it2, it2data);
1560 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1561 *x = it2.current_x;
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,
1567 it.last_visible_y)
1568 - max (it2.current_y,
1569 WINDOW_HEADER_LINE_HEIGHT (w))));
1570 *vpos = it2.vpos;
1571 if (it2.bidi_it.paragraph_dir == R2L)
1572 r2l = true;
1574 else
1575 bidi_unshelve_cache (it2data, true);
1577 bidi_unshelve_cache (itdata, false);
1579 if (old_buffer)
1580 set_buffer_internal_1 (old_buffer);
1582 if (visible_p)
1584 if (w->hscroll > 0)
1585 *x -=
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. */
1593 if (r2l)
1594 *x = window_box_width (w, TEXT_AREA) - *x - 1;
1597 #if false
1598 /* Debugging code. */
1599 if (visible_p)
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);
1602 else
1603 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1604 #endif
1606 return visible_p;
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. */
1615 static int
1616 string_char_and_length (const unsigned char *str, int *len)
1618 int c;
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
1624 characters. */
1625 c = '?';
1627 return c;
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);
1643 int len;
1645 while (nchars--)
1647 string_char_and_length (p, &len);
1648 p += len;
1649 CHARPOS (pos) += 1;
1650 BYTEPOS (pos) += len;
1653 else
1654 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1656 return pos;
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));
1670 return pos;
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);
1686 if (multibyte_p)
1688 int len;
1690 SET_TEXT_POS (pos, 0, 0);
1691 while (charpos--)
1693 string_char_and_length ((const unsigned char *) s, &len);
1694 s += len;
1695 CHARPOS (pos) += 1;
1696 BYTEPOS (pos) += len;
1699 else
1700 SET_TEXT_POS (pos, charpos, charpos);
1702 return pos;
1706 /* Value is the number of characters in C string S. MULTIBYTE_P
1707 means recognize multibyte characters. */
1709 static ptrdiff_t
1710 number_of_chars (const char *s, bool multibyte_p)
1712 ptrdiff_t nchars;
1714 if (multibyte_p)
1716 ptrdiff_t rest = strlen (s);
1717 int len;
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;
1726 else
1727 nchars = strlen (s);
1729 return nchars;
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. */
1737 static void
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));
1746 else
1747 BYTEPOS (*newpos) = CHARPOS (*newpos);
1750 /* EXPORT:
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);
1767 if (face)
1769 if (face->font)
1770 height = normal_char_height (face->font, -1);
1771 if (face->box_line_width > 0)
1772 height += 2 * face->box_line_width;
1776 return height;
1778 #endif
1780 return 1;
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. */
1788 void
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. */
1798 if (pix_x < 0)
1799 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1800 if (pix_y < 0)
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);
1806 if (bounds)
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? */
1814 if (!noclip)
1816 if (pix_x < 0)
1817 pix_x = 0;
1818 else if (pix_x > FRAME_TOTAL_COLS (f))
1819 pix_x = FRAME_TOTAL_COLS (f);
1821 if (pix_y < 0)
1822 pix_y = 0;
1823 else if (pix_y > FRAME_TOTAL_LINES (f))
1824 pix_y = FRAME_TOTAL_LINES (f);
1827 #endif
1829 *x = pix_x;
1830 *y = pix_y;
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
1840 date. */
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;
1848 int x0, i;
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)
1855 return NULL;
1856 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1857 break;
1860 *vpos = i;
1861 *hpos = 0;
1863 /* Give up if Y is not in the window. */
1864 if (i == w->current_matrix->nrows)
1865 return NULL;
1867 /* Get the glyph area containing X. */
1868 if (w->pseudo_window_p)
1870 *area = TEXT_AREA;
1871 x0 = 0;
1873 else
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))
1882 *area = TEXT_AREA;
1883 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
1885 else
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];
1895 x -= x0;
1896 while (glyph < end && x >= glyph->pixel_width)
1898 x -= glyph->pixel_width;
1899 ++glyph;
1902 if (glyph == end)
1903 return NULL;
1905 if (dx)
1907 *dx = x;
1908 *dy = y - (row->y + row->ascent - glyph->ascent);
1911 *hpos = glyph - row->glyphs[*area];
1912 return glyph;
1915 /* Convert frame-relative x/y to coordinates relative to window W.
1916 Takes pseudo-windows into account. */
1918 static void
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);
1929 else
1931 *x -= WINDOW_LEFT_EDGE_X (w);
1932 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1936 #ifdef HAVE_WINDOW_SYSTEM
1938 /* EXPORT:
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)
1945 XRectangle r;
1947 if (n <= 0)
1948 return 0;
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);
1956 else
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;
1963 else
1964 r.height = s->height;
1966 else
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;
1974 if (s->clip_head)
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;
1979 else
1980 r.width = 0;
1981 r.x = s->clip_head->x;
1983 if (s->clip_tail)
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;
1988 else
1989 r.width = 0;
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);
2017 else
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);
2025 else
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;
2036 int height, max_y;
2038 if (s->x > r.x)
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 */
2043 r.width = 0;
2044 r.x = s->x;
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)
2055 r.y = max_y;
2056 r.height = height;
2058 else
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);
2071 if (s->row->clip)
2073 XRectangle r_save = r;
2075 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2076 r.width = 0;
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);
2084 #else
2085 *rects = r;
2086 #endif
2087 return 1;
2089 else
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
2096 XRectangle rs[2];
2097 #else
2098 XRectangle *rs = rects;
2099 #endif
2100 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2102 if (s->for_overlaps & OVERLAPS_PRED)
2104 rs[i] = r;
2105 if (r.y + r.height > row_y)
2107 if (r.y < row_y)
2108 rs[i].height = row_y - r.y;
2109 else
2110 rs[i].height = 0;
2112 i++;
2114 if (s->for_overlaps & OVERLAPS_SUCC)
2116 rs[i] = r;
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;
2124 else
2125 rs[i].height = 0;
2127 i++;
2130 n = i;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i = 0; i < n; i++)
2133 CONVERT_FROM_XRECT (rs[i], rects[i]);
2134 #endif
2135 return n;
2139 /* EXPORT:
2140 Return in *NR the clipping rectangle for glyph string S. */
2142 void
2143 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2145 get_glyph_string_clip_rects (s, nr, 1);
2149 /* EXPORT:
2150 Return the position and height of the phys cursor in window W.
2151 Set w->phys_cursor_width to width of phys cursor.
2154 void
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
2164 width instead. */
2165 wd = glyph->pixel_width;
2167 x = w->phys_cursor.x;
2168 if (x < 0)
2170 wd += x;
2171 x = 0;
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);
2196 if (y < y0)
2198 h = max (h - (y0 - y) + 1, h0);
2199 y = y0 - 1;
2201 else
2203 y0 = window_text_bottom_y (w) - h0;
2204 if (y > y0)
2206 h += y - y0;
2207 y = y0;
2211 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2212 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2213 *heightp = h;
2217 * Remember which glyph the mouse is over.
2220 void
2221 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2223 Lisp_Object window;
2224 struct window *w;
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)
2235 width = height = 1;
2236 goto virtual_glyph;
2238 else if (!f->glyphs_initialized_p
2239 || (window = window_from_coordinates (f, gx, gy, &part, false),
2240 NILP (window)))
2242 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2243 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2244 goto virtual_glyph;
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)
2259 area = TEXT_AREA;
2260 part = ON_MODE_LINE; /* Don't adjust margin. */
2261 goto text_glyph;
2264 switch (part)
2266 case ON_LEFT_MARGIN:
2267 area = LEFT_MARGIN_AREA;
2268 goto text_glyph;
2270 case ON_RIGHT_MARGIN:
2271 area = RIGHT_MARGIN_AREA;
2272 goto text_glyph;
2274 case ON_HEADER_LINE:
2275 case ON_MODE_LINE:
2276 gr = (part == ON_HEADER_LINE
2277 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2278 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2279 gy = gr->y;
2280 area = TEXT_AREA;
2281 goto text_glyph_row_found;
2283 case ON_TEXT:
2284 area = TEXT_AREA;
2286 text_glyph:
2287 gr = 0; gy = 0;
2288 for (; r <= end_row && r->enabled_p; ++r)
2289 if (r->y + r->height > y)
2291 gr = r; gy = r->y;
2292 break;
2295 text_glyph_row_found:
2296 if (gr && gy <= y)
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)
2304 break;
2306 if (g < end)
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);
2313 return;
2315 width = g->pixel_width;
2317 else
2319 /* Use nominal char spacing at end of line. */
2320 x -= gx;
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));
2333 else
2335 /* Use nominal line height at end of window. */
2336 gx = (x / width) * width;
2337 y -= gy;
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));
2344 break;
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);
2351 goto row_glyph;
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;
2364 else
2365 width = WINDOW_PIXEL_WIDTH (w) - gx;
2366 else
2367 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2369 goto row_glyph;
2371 case ON_VERTICAL_BORDER:
2372 gx = WINDOW_PIXEL_WIDTH (w) - width;
2373 goto row_glyph;
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)
2381 : 0)));
2382 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2384 row_glyph:
2385 gr = 0, gy = 0;
2386 for (; r <= end_row && r->enabled_p; ++r)
2387 if (r->y + r->height > y)
2389 gr = r; gy = r->y;
2390 break;
2393 if (gr && gy <= y)
2394 height = gr->height;
2395 else
2397 /* Use nominal line height at end of window. */
2398 y -= gy;
2399 gy += (y / height) * height;
2401 break;
2403 case ON_RIGHT_DIVIDER:
2404 gx = WINDOW_PIXEL_WIDTH (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
2405 width = WINDOW_RIGHT_DIVIDER_WIDTH (w);
2406 gy = 0;
2407 /* The bottom divider prevails. */
2408 height = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2409 goto add_edge;
2411 case ON_BOTTOM_DIVIDER:
2412 gx = 0;
2413 width = WINDOW_PIXEL_WIDTH (w);
2414 gy = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2415 height = WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2416 goto add_edge;
2418 default:
2420 virtual_glyph:
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
2423 as our "glyph". */
2425 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2426 round down even for negative values. */
2427 if (gx < 0)
2428 gx -= width - 1;
2429 if (gy < 0)
2430 gy -= height - 1;
2432 gx = (gx / width) * width;
2433 gy = (gy / height) * height;
2435 goto store_rect;
2438 add_edge:
2439 gx += WINDOW_LEFT_EDGE_X (w);
2440 gy += WINDOW_TOP_EDGE_Y (w);
2442 store_rect:
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);
2450 #endif
2454 #endif /* HAVE_WINDOW_SYSTEM */
2456 static void
2457 adjust_window_ends (struct window *w, struct glyph_row *row, bool current)
2459 eassert (w);
2460 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
2461 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
2462 w->window_end_vpos
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. */
2472 static Lisp_Object
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);
2477 return Qnil;
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. */
2484 static Lisp_Object
2485 safe__call (bool inhibit_quit, ptrdiff_t nargs, Lisp_Object func, va_list ap)
2487 Lisp_Object val;
2489 if (inhibit_eval_during_redisplay)
2490 val = Qnil;
2491 else
2493 ptrdiff_t i;
2494 ptrdiff_t count = SPECPDL_INDEX ();
2495 Lisp_Object *args;
2496 USE_SAFE_ALLOCA;
2497 SAFE_ALLOCA_LISP (args, nargs);
2499 args[0] = func;
2500 for (i = 1; i < nargs; i++)
2501 args[i] = va_arg (ap, Lisp_Object);
2503 specbind (Qinhibit_redisplay, Qt);
2504 if (inhibit_quit)
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,
2509 safe_eval_handler);
2510 SAFE_FREE ();
2511 val = unbind_to (count, val);
2514 return val;
2517 Lisp_Object
2518 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2520 Lisp_Object retval;
2521 va_list ap;
2523 va_start (ap, func);
2524 retval = safe__call (false, nargs, func, ap);
2525 va_end (ap);
2526 return retval;
2529 /* Call function FN with one argument ARG.
2530 Return the result, or nil if something went wrong. */
2532 Lisp_Object
2533 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2535 return safe_call (2, fn, arg);
2538 static Lisp_Object
2539 safe__call1 (bool inhibit_quit, Lisp_Object fn, ...)
2541 Lisp_Object retval;
2542 va_list ap;
2544 va_start (ap, fn);
2545 retval = safe__call (inhibit_quit, 2, fn, ap);
2546 va_end (ap);
2547 return retval;
2550 Lisp_Object
2551 safe_eval (Lisp_Object sexpr)
2553 return safe__call1 (false, Qeval, sexpr);
2556 static Lisp_Object
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. */
2565 Lisp_Object
2566 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2568 return safe_call (3, fn, arg1, arg2);
2573 /***********************************************************************
2574 Debugging
2575 ***********************************************************************/
2577 /* Define CHECK_IT to perform sanity checks on iterators.
2578 This is for debugging. It is too slow to do unconditionally. */
2580 static void
2581 CHECK_IT (struct it *it)
2583 #if false
2584 if (it->method == GET_FROM_STRING)
2586 eassert (STRINGP (it->string));
2587 eassert (IT_STRING_CHARPOS (*it) >= 0);
2589 else
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)));
2599 if (it->dpvec)
2600 eassert (it->current.dpvec_index >= 0);
2601 else
2602 eassert (it->current.dpvec_index < 0);
2603 #endif
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. */
2610 static void
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),
2618 !row->enabled_p
2619 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2620 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2622 #endif
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
2633 CHARPOS.
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. */
2648 void
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)
2658 && charpos <= ZV));
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
2676 appropriate. */
2677 if (row == NULL)
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;
2694 it->bidi_it.w = w;
2696 /* The window in which we iterate over current_buffer: */
2697 XSETWINDOW (it->window, w);
2698 it->w = w;
2699 it->f = XFRAME (w->frame);
2701 it->cmp_it.id = -1;
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
2732 invisible. */
2733 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2734 ? (clip_to_bounds
2735 (-1, XINT (BVAR (current_buffer, selective_display)),
2736 PTRDIFF_MAX))
2737 : (!NILP (BVAR (current_buffer, selective_display))
2738 ? -1 : 0));
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),
2757 PTRDIFF_MAX);
2759 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2761 /* Are lines in the display truncated? */
2762 if (TRUNCATE != 0)
2763 it->line_wrap = TRUNCATE;
2764 if (base_face_id == DEFAULT_FACE_ID
2765 && !it->w->hscroll
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)))
2785 #endif
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;
2794 else
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);
2824 else
2826 it->first_visible_x
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;
2838 else
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)
2857 struct face *face;
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
2889 available. */
2890 it->bidi_p =
2891 NILP (Vpurify_flag)
2892 && !NILP (BVAR (current_buffer, bidi_display_reordering))
2893 && it->multibyte_p;
2895 /* If we are to reorder bidirectional text, init the bidi
2896 iterator. */
2897 if (it->bidi_p)
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;
2909 else
2910 it->last_visible_x -= it->continuation_pixel_width;
2912 /* Note the paragraph direction that this buffer wants to
2913 use. */
2914 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2915 Qleft_to_right))
2916 it->paragraph_embedding = L2R;
2917 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2918 Qright_to_left))
2919 it->paragraph_embedding = R2L;
2920 else
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),
2924 &it->bidi_it);
2927 /* Compute faces etc. */
2928 reseat (it, it->current.pos, true);
2931 CHECK_IT (it);
2935 /* Initialize IT for the display of window W with window start POS. */
2937 void
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)
2959 int new_x;
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
2977 system frame. */
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.) */
2991 && it->c != '\n')
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;
3014 it->vpos = 0;
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. */
3024 static bool
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
3038 && charpos > BEGV
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,
3045 window);
3046 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3049 return ellipses_p;
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. */
3058 static bool
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);
3062 int i;
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))
3071 --charpos;
3072 bytepos = 0;
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
3083 after-string. */
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')
3095 ++s;
3097 if (s < e)
3099 overlay_strings_with_newlines = true;
3100 break;
3104 /* If position is within an overlay string, set up IT to the right
3105 overlay string. */
3106 if (pos->overlay_string_index >= 0)
3108 int relative_index;
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)
3115 pop_it (it);
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;
3124 while (n--)
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. */
3140 if (it->bidi_p)
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)
3164 do {
3165 /* Paranoia. */
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));
3182 if (it->bidi_p)
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;
3197 CHECK_IT (it);
3198 return !overlay_strings_with_newlines;
3202 /* Initialize IT for stepping through current_buffer in window W
3203 starting at ROW->start. */
3205 static void
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;
3211 CHECK_IT (it);
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
3218 end position. */
3220 static bool
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;
3230 CHECK_IT (it);
3231 success = true;
3234 return success;
3240 /***********************************************************************
3241 Text properties
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
3246 to stop. */
3248 static void
3249 handle_stop (struct it *it)
3251 enum prop_handled handled;
3252 bool handle_overlay_change_p;
3253 struct props *p;
3255 it->dpvec = NULL;
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
3290 are processed.
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
3304 change. */
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)
3316 break;
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
3322 || it->sp > 1
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
3328 overlay strings. */
3329 || (it->current.overlay_string_index < 0
3330 && !get_overlay_strings_1 (it, 0, false)))
3332 if (it->ellipsis_p)
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))
3340 pop_it (it);
3341 return;
3343 else if (STRINGP (it->string) && !SCHARS (it->string))
3344 pop_it (it);
3345 else
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;
3352 break;
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);
3372 if (it->ellipsis_p)
3374 setup_for_ellipsis (it, 0);
3375 break;
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. */
3389 static void
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
3399 properties. */
3400 it->stop_charpos = it->end_charpos;
3401 object = it->string;
3402 limit = Qnil;
3403 charpos = IT_STRING_CHARPOS (*it);
3404 bytepos = IT_STRING_BYTEPOS (*it);
3406 else
3408 ptrdiff_t pos;
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
3419 follows. */
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);
3436 if (iv)
3438 Lisp_Object values_here[LAST_PROP_IDX];
3439 struct props *p;
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
3447 properties. */
3448 for (next_iv = next_interval (iv);
3449 (next_iv
3450 && (NILP (limit)
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))
3459 break;
3462 if (p->handler)
3463 break;
3466 if (next_iv)
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);
3472 else
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)
3483 stoppos = -1;
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
3497 xmalloc. */
3499 static ptrdiff_t
3500 next_overlay_change (ptrdiff_t pos)
3502 ptrdiff_t i, noverlays;
3503 ptrdiff_t endpos;
3504 Lisp_Object *overlays;
3505 USE_SAFE_ALLOCA;
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)
3514 Lisp_Object oend;
3515 ptrdiff_t oendpos;
3517 oend = OVERLAY_END (overlays[i]);
3518 oendpos = OVERLAY_POSITION (oend);
3519 endpos = min (endpos, oendpos);
3522 SAFE_FREE ();
3523 return endpos;
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. */
3543 ptrdiff_t
3544 compute_display_string_pos (struct text_pos *position,
3545 struct bidi_string_data *string,
3546 struct window *w,
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);
3556 ptrdiff_t lim =
3557 (charpos < eob - MAX_DISP_SCAN) ? charpos + MAX_DISP_SCAN : eob;
3558 struct text_pos tpos;
3559 int rv = 0;
3561 if (string && STRINGP (string->lstring))
3562 object1 = object = string->lstring;
3563 else if (w && !string_p)
3565 XSETWINDOW (object, w);
3566 object1 = Qnil;
3568 else
3569 object1 = object = Qnil;
3571 *disp_prop = 1;
3573 if (charpos >= eob
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)))
3580 *disp_prop = 0;
3581 return eob;
3584 /* If the character at CHARPOS is where the display string begins,
3585 return CHARPOS. */
3586 pos = make_number (charpos);
3587 if (STRINGP (object))
3588 bufpos = string->bufpos;
3589 else
3590 bufpos = charpos;
3591 tpos = *position;
3592 if (!NILP (spec = Fget_char_property (pos, Qdisplay, object))
3593 && (charpos <= begb
3594 || !EQ (Fget_char_property (make_number (charpos - 1), Qdisplay,
3595 object),
3596 spec))
3597 && (rv = handle_display_spec (NULL, spec, object, Qnil, &tpos, bufpos,
3598 frame_window_p)))
3600 if (rv == 2)
3601 *disp_prop = 2;
3602 return charpos;
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);
3608 do {
3609 pos = Fnext_single_char_property_change (pos, Qdisplay, object1, limpos);
3610 CHARPOS (tpos) = XFASTINT (pos);
3611 if (CHARPOS (tpos) >= lim)
3613 *disp_prop = 0;
3614 break;
3616 if (STRINGP (object))
3617 BYTEPOS (tpos) = string_char_to_byte (object, CHARPOS (tpos));
3618 else
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)));
3626 if (rv == 2)
3627 *disp_prop = 2;
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. */
3637 ptrdiff_t
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);
3644 ptrdiff_t eob =
3645 (STRINGP (object) || (string && string->s)) ? string->schars : ZV;
3647 if (charpos >= eob || (string->s && !STRINGP (object)))
3648 return eob;
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
3663 stop_charpos is. */
3664 if (NILP (Fget_char_property (pos, Qdisplay, object)))
3665 return -1;
3667 /* Look forward for the first character where the `display' property
3668 changes. */
3669 pos = Fnext_single_char_property_change (pos, Qdisplay, object, Qnil);
3671 return XFASTINT (pos);
3676 /***********************************************************************
3677 Fontification
3678 ***********************************************************************/
3680 /* Handle changes in the `fontified' property of the current buffer by
3681 calling hook functions from Qfontification_functions to fontify
3682 regions of text. */
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))
3691 return handled;
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)
3698 && it->s == NULL
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 ();
3708 Lisp_Object val;
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);
3720 else
3722 Lisp_Object fns, fn;
3723 struct gcpro gcpro1, gcpro2;
3725 fns = Qnil;
3726 GCPRO2 (val, fns);
3728 for (; CONSP (val); val = XCDR (val))
3730 fn = XCAR (val);
3732 if (EQ (fn, Qt))
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
3738 loop. */
3739 for (fns = Fdefault_value (Qfontification_functions);
3740 CONSP (fns);
3741 fns = XCDR (fns))
3743 fn = XCAR (fns);
3744 if (!EQ (fn, Qt))
3745 safe_call1 (fn, pos);
3748 else
3749 safe_call1 (fn, pos);
3752 UNGCPRO;
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;
3788 return handled;
3793 /***********************************************************************
3794 Faces
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)
3803 int new_face_id;
3804 ptrdiff_t next_stop;
3806 if (!STRINGP (it->string))
3808 new_face_id
3809 = face_at_buffer_position (it->w,
3810 IT_CHARPOS (*it),
3811 &next_stop,
3812 (IT_CHARPOS (*it)
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;
3848 else
3850 int base_face_id;
3851 ptrdiff_t bufpos;
3852 int i;
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]
3857 : Qnil);
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)
3869 from_overlay
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))
3876 break;
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. */
3884 base_face_id
3885 = face_for_overlay_string (it->w,
3886 IT_CHARPOS (*it),
3887 &next_stop,
3888 (IT_CHARPOS (*it)
3889 + TEXT_PROP_DISTANCE_LIMIT),
3890 false,
3891 from_overlay);
3893 else
3895 bufpos = 0;
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)
3916 : DEFAULT_FACE_ID)
3917 : underlying_face_id (it);
3920 new_face_id = face_at_string_position (it->w,
3921 it->string,
3922 IT_STRING_CHARPOS (*it),
3923 bufpos,
3924 &next_stop,
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. */
3958 static int
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;
3969 return 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. */
3978 static int
3979 face_before_or_after_it_pos (struct it *it, bool before_p)
3981 int face_id, limit;
3982 ptrdiff_t next_check_charpos;
3983 struct it it_copy;
3984 void *it_copy_data = NULL;
3986 eassert (it->s == NULL);
3988 if (STRINGP (it->string))
3990 ptrdiff_t bufpos, charpos;
3991 int base_face_id;
3993 /* No face change past the end of the string (for the case
3994 we are padding with spaces). No face change before the
3995 string start. */
3996 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string)
3997 || (IT_STRING_CHARPOS (*it) == 0 && before_p))
3998 return it->face_id;
4000 if (!it->bidi_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. */
4005 if (before_p)
4006 charpos = IT_STRING_CHARPOS (*it) - 1;
4007 else if (it->what == IT_COMPOSITION)
4008 /* For composition, we must check the character after the
4009 composition. */
4010 charpos = IT_STRING_CHARPOS (*it) + it->cmp_it.nchars;
4011 else
4012 charpos = IT_STRING_CHARPOS (*it) + 1;
4014 else
4016 if (before_p)
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)
4026 return it->face_id;
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
4032 cases here. */
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);
4038 else
4040 /* Set charpos to the string position of the character
4041 that comes after IT's current position in the visual
4042 order. */
4043 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4045 it_copy = *it;
4046 while (n--)
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);
4056 else
4057 bufpos = 0;
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,
4063 it->string,
4064 charpos,
4065 bufpos,
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);
4076 int c, len;
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);
4083 else
4085 struct text_pos pos;
4087 if ((IT_CHARPOS (*it) >= ZV && !before_p)
4088 || (IT_CHARPOS (*it) <= BEGV && before_p))
4089 return it->face_id;
4091 limit = IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT;
4092 pos = it->current.pos;
4094 if (!it->bidi_p)
4096 if (before_p)
4097 DEC_TEXT_POS (pos, it->multibyte_p);
4098 else
4100 if (it->what == IT_COMPOSITION)
4102 /* For composition, we must check the position after
4103 the composition. */
4104 pos.charpos += it->cmp_it.nchars;
4105 pos.bytepos += it->len;
4107 else
4108 INC_TEXT_POS (pos, it->multibyte_p);
4111 else
4113 if (before_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)
4123 return it->face_id;
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
4129 cases here. */
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);
4135 else
4137 /* Set charpos to the buffer position of the character
4138 that comes after IT's current position in the visual
4139 order. */
4140 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4142 it_copy = *it;
4143 while (n--)
4144 bidi_move_to_visually_next (&it_copy.bidi_it);
4146 SET_TEXT_POS (pos,
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,
4154 CHARPOS (pos),
4155 &next_check_charpos,
4156 limit, false, -1);
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);
4169 return face_id;
4174 /***********************************************************************
4175 Invisible text
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;
4185 int invis;
4186 Lisp_Object prop;
4188 if (STRINGP (it->string))
4190 Lisp_Object end_charpos, limit;
4192 /* Get the value of the invisible text property at the
4193 current position. Value will be nil if there is no such
4194 property. */
4195 end_charpos = make_number (IT_STRING_CHARPOS (*it));
4196 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4197 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4199 if (invis != 0 && IT_STRING_CHARPOS (*it) < it->end_charpos)
4201 /* Record whether we have to display an ellipsis for the
4202 invisible text. */
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
4215 = Fnext_single_property_change (end_charpos, Qinvisible,
4216 it->string, limit);
4217 /* Since LIMIT is always an integer, so should be the
4218 value returned by Fnext_single_property_change. */
4219 eassert (INTEGERP (end_charpos));
4220 if (INTEGERP (end_charpos))
4222 endpos = XFASTINT (end_charpos);
4223 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4224 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4225 if (invis == 2)
4226 display_ellipsis_p = true;
4228 else /* Should never happen; but if it does, exit the loop. */
4229 endpos = len;
4231 while (invis != 0 && endpos < len);
4233 if (display_ellipsis_p)
4234 it->ellipsis_p = true;
4236 if (endpos < len)
4238 /* Text at END_CHARPOS is visible. Move IT there. */
4239 struct text_pos old;
4240 ptrdiff_t oldpos;
4242 old = it->current.string_pos;
4243 oldpos = CHARPOS (old);
4244 if (it->bidi_p)
4246 if (it->bidi_it.first_elt
4247 && it->bidi_it.charpos < SCHARS (it->string))
4248 bidi_paragraph_init (it->paragraph_embedding,
4249 &it->bidi_it, true);
4250 /* Bidi-iterate out of the invisible text. */
4253 bidi_move_to_visually_next (&it->bidi_it);
4255 while (oldpos <= it->bidi_it.charpos
4256 && it->bidi_it.charpos < endpos);
4258 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
4259 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
4260 if (IT_CHARPOS (*it) >= endpos)
4261 it->prev_stop = endpos;
4263 else
4265 IT_STRING_CHARPOS (*it) = endpos;
4266 compute_string_pos (&it->current.string_pos, old, it->string);
4269 else
4271 /* The rest of the string is invisible. If this is an
4272 overlay string, proceed with the next overlay string
4273 or whatever comes and return a character from there. */
4274 if (it->current.overlay_string_index >= 0
4275 && !display_ellipsis_p)
4277 next_overlay_string (it);
4278 /* Don't check for overlay strings when we just
4279 finished processing them. */
4280 handled = HANDLED_OVERLAY_STRING_CONSUMED;
4282 else
4284 IT_STRING_CHARPOS (*it) = SCHARS (it->string);
4285 IT_STRING_BYTEPOS (*it) = SBYTES (it->string);
4290 else
4292 ptrdiff_t newpos, next_stop, start_charpos, tem;
4293 Lisp_Object pos, overlay;
4295 /* First of all, is there invisible text at this position? */
4296 tem = start_charpos = IT_CHARPOS (*it);
4297 pos = make_number (tem);
4298 prop = get_char_property_and_overlay (pos, Qinvisible, it->window,
4299 &overlay);
4300 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4302 /* If we are on invisible text, skip over it. */
4303 if (invis != 0 && start_charpos < it->end_charpos)
4305 /* Record whether we have to display an ellipsis for the
4306 invisible text. */
4307 bool display_ellipsis_p = invis == 2;
4309 handled = HANDLED_RECOMPUTE_PROPS;
4311 /* Loop skipping over invisible text. The loop is left at
4312 ZV or with IT on the first char being visible again. */
4315 /* Try to skip some invisible text. Return value is the
4316 position reached which can be equal to where we start
4317 if there is nothing invisible there. This skips both
4318 over invisible text properties and overlays with
4319 invisible property. */
4320 newpos = skip_invisible (tem, &next_stop, ZV, it->window);
4322 /* If we skipped nothing at all we weren't at invisible
4323 text in the first place. If everything to the end of
4324 the buffer was skipped, end the loop. */
4325 if (newpos == tem || newpos >= ZV)
4326 invis = 0;
4327 else
4329 /* We skipped some characters but not necessarily
4330 all there are. Check if we ended up on visible
4331 text. Fget_char_property returns the property of
4332 the char before the given position, i.e. if we
4333 get invis = 0, this means that the char at
4334 newpos is visible. */
4335 pos = make_number (newpos);
4336 prop = Fget_char_property (pos, Qinvisible, it->window);
4337 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4340 /* If we ended up on invisible text, proceed to
4341 skip starting with next_stop. */
4342 if (invis != 0)
4343 tem = next_stop;
4345 /* If there are adjacent invisible texts, don't lose the
4346 second one's ellipsis. */
4347 if (invis == 2)
4348 display_ellipsis_p = true;
4350 while (invis != 0);
4352 /* The position newpos is now either ZV or on visible text. */
4353 if (it->bidi_p)
4355 ptrdiff_t bpos = CHAR_TO_BYTE (newpos);
4356 bool on_newline
4357 = bpos == ZV_BYTE || FETCH_BYTE (bpos) == '\n';
4358 bool after_newline
4359 = newpos <= BEGV || FETCH_BYTE (bpos - 1) == '\n';
4361 /* If the invisible text ends on a newline or on a
4362 character after a newline, we can avoid the costly,
4363 character by character, bidi iteration to NEWPOS, and
4364 instead simply reseat the iterator there. That's
4365 because all bidi reordering information is tossed at
4366 the newline. This is a big win for modes that hide
4367 complete lines, like Outline, Org, etc. */
4368 if (on_newline || after_newline)
4370 struct text_pos tpos;
4371 bidi_dir_t pdir = it->bidi_it.paragraph_dir;
4373 SET_TEXT_POS (tpos, newpos, bpos);
4374 reseat_1 (it, tpos, false);
4375 /* If we reseat on a newline/ZV, we need to prep the
4376 bidi iterator for advancing to the next character
4377 after the newline/EOB, keeping the current paragraph
4378 direction (so that PRODUCE_GLYPHS does TRT wrt
4379 prepending/appending glyphs to a glyph row). */
4380 if (on_newline)
4382 it->bidi_it.first_elt = false;
4383 it->bidi_it.paragraph_dir = pdir;
4384 it->bidi_it.ch = (bpos == ZV_BYTE) ? -1 : '\n';
4385 it->bidi_it.nchars = 1;
4386 it->bidi_it.ch_len = 1;
4389 else /* Must use the slow method. */
4391 /* With bidi iteration, the region of invisible text
4392 could start and/or end in the middle of a
4393 non-base embedding level. Therefore, we need to
4394 skip invisible text using the bidi iterator,
4395 starting at IT's current position, until we find
4396 ourselves outside of the invisible text.
4397 Skipping invisible text _after_ bidi iteration
4398 avoids affecting the visual order of the
4399 displayed text when invisible properties are
4400 added or removed. */
4401 if (it->bidi_it.first_elt && it->bidi_it.charpos < ZV)
4403 /* If we were `reseat'ed to a new paragraph,
4404 determine the paragraph base direction. We
4405 need to do it now because
4406 next_element_from_buffer may not have a
4407 chance to do it, if we are going to skip any
4408 text at the beginning, which resets the
4409 FIRST_ELT flag. */
4410 bidi_paragraph_init (it->paragraph_embedding,
4411 &it->bidi_it, true);
4415 bidi_move_to_visually_next (&it->bidi_it);
4417 while (it->stop_charpos <= it->bidi_it.charpos
4418 && it->bidi_it.charpos < newpos);
4419 IT_CHARPOS (*it) = it->bidi_it.charpos;
4420 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
4421 /* If we overstepped NEWPOS, record its position in
4422 the iterator, so that we skip invisible text if
4423 later the bidi iteration lands us in the
4424 invisible region again. */
4425 if (IT_CHARPOS (*it) >= newpos)
4426 it->prev_stop = newpos;
4429 else
4431 IT_CHARPOS (*it) = newpos;
4432 IT_BYTEPOS (*it) = CHAR_TO_BYTE (newpos);
4435 if (display_ellipsis_p)
4437 /* Make sure that the glyphs of the ellipsis will get
4438 correct `charpos' values. If we would not update
4439 it->position here, the glyphs would belong to the
4440 last visible character _before_ the invisible
4441 text, which confuses `set_cursor_from_row'.
4443 We use the last invisible position instead of the
4444 first because this way the cursor is always drawn on
4445 the first "." of the ellipsis, whenever PT is inside
4446 the invisible text. Otherwise the cursor would be
4447 placed _after_ the ellipsis when the point is after the
4448 first invisible character. */
4449 if (!STRINGP (it->object))
4451 it->position.charpos = newpos - 1;
4452 it->position.bytepos = CHAR_TO_BYTE (it->position.charpos);
4456 /* If there are before-strings at the start of invisible
4457 text, and the text is invisible because of a text
4458 property, arrange to show before-strings because 20.x did
4459 it that way. (If the text is invisible because of an
4460 overlay property instead of a text property, this is
4461 already handled in the overlay code.) */
4462 if (NILP (overlay)
4463 && get_overlay_strings (it, it->stop_charpos))
4465 handled = HANDLED_RECOMPUTE_PROPS;
4466 if (it->sp > 0)
4468 it->stack[it->sp - 1].display_ellipsis_p = display_ellipsis_p;
4469 /* The call to get_overlay_strings above recomputes
4470 it->stop_charpos, but it only considers changes
4471 in properties and overlays beyond iterator's
4472 current position. This causes us to miss changes
4473 that happen exactly where the invisible property
4474 ended. So we play it safe here and force the
4475 iterator to check for potential stop positions
4476 immediately after the invisible text. Note that
4477 if get_overlay_strings returns true, it
4478 normally also pushed the iterator stack, so we
4479 need to update the stop position in the slot
4480 below the current one. */
4481 it->stack[it->sp - 1].stop_charpos
4482 = CHARPOS (it->stack[it->sp - 1].current.pos);
4485 else if (display_ellipsis_p)
4487 it->ellipsis_p = true;
4488 /* Let the ellipsis display before
4489 considering any properties of the following char.
4490 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4491 handled = HANDLED_RETURN;
4496 return handled;
4500 /* Make iterator IT return `...' next.
4501 Replaces LEN characters from buffer. */
4503 static void
4504 setup_for_ellipsis (struct it *it, int len)
4506 /* Use the display table definition for `...'. Invalid glyphs
4507 will be handled by the method returning elements from dpvec. */
4508 if (it->dp && VECTORP (DISP_INVIS_VECTOR (it->dp)))
4510 struct Lisp_Vector *v = XVECTOR (DISP_INVIS_VECTOR (it->dp));
4511 it->dpvec = v->contents;
4512 it->dpend = v->contents + v->header.size;
4514 else
4516 /* Default `...'. */
4517 it->dpvec = default_invis_vector;
4518 it->dpend = default_invis_vector + 3;
4521 it->dpvec_char_len = len;
4522 it->current.dpvec_index = 0;
4523 it->dpvec_face_id = -1;
4525 /* Remember the current face id in case glyphs specify faces.
4526 IT's face is restored in set_iterator_to_next.
4527 saved_face_id was set to preceding char's face in handle_stop. */
4528 if (it->saved_face_id < 0 || it->saved_face_id != it->face_id)
4529 it->saved_face_id = it->face_id = DEFAULT_FACE_ID;
4531 /* If the ellipsis represents buffer text, it means we advanced in
4532 the buffer, so we should no longer ignore overlay strings. */
4533 if (it->method == GET_FROM_BUFFER)
4534 it->ignore_overlay_strings_at_pos_p = false;
4536 it->method = GET_FROM_DISPLAY_VECTOR;
4537 it->ellipsis_p = true;
4542 /***********************************************************************
4543 'display' property
4544 ***********************************************************************/
4546 /* Set up iterator IT from `display' property at its current position.
4547 Called from handle_stop.
4548 We return HANDLED_RETURN if some part of the display property
4549 overrides the display of the buffer text itself.
4550 Otherwise we return HANDLED_NORMALLY. */
4552 static enum prop_handled
4553 handle_display_prop (struct it *it)
4555 Lisp_Object propval, object, overlay;
4556 struct text_pos *position;
4557 ptrdiff_t bufpos;
4558 /* Nonzero if some property replaces the display of the text itself. */
4559 int display_replaced = 0;
4561 if (STRINGP (it->string))
4563 object = it->string;
4564 position = &it->current.string_pos;
4565 bufpos = CHARPOS (it->current.pos);
4567 else
4569 XSETWINDOW (object, it->w);
4570 position = &it->current.pos;
4571 bufpos = CHARPOS (*position);
4574 /* Reset those iterator values set from display property values. */
4575 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
4576 it->space_width = Qnil;
4577 it->font_height = Qnil;
4578 it->voffset = 0;
4580 /* We don't support recursive `display' properties, i.e. string
4581 values that have a string `display' property, that have a string
4582 `display' property etc. */
4583 if (!it->string_from_display_prop_p)
4584 it->area = TEXT_AREA;
4586 propval = get_char_property_and_overlay (make_number (position->charpos),
4587 Qdisplay, object, &overlay);
4588 if (NILP (propval))
4589 return HANDLED_NORMALLY;
4590 /* Now OVERLAY is the overlay that gave us this property, or nil
4591 if it was a text property. */
4593 if (!STRINGP (it->string))
4594 object = it->w->contents;
4596 display_replaced = handle_display_spec (it, propval, object, overlay,
4597 position, bufpos,
4598 FRAME_WINDOW_P (it->f));
4599 return display_replaced != 0 ? HANDLED_RETURN : HANDLED_NORMALLY;
4602 /* Subroutine of handle_display_prop. Returns non-zero if the display
4603 specification in SPEC is a replacing specification, i.e. it would
4604 replace the text covered by `display' property with something else,
4605 such as an image or a display string. If SPEC includes any kind or
4606 `(space ...) specification, the value is 2; this is used by
4607 compute_display_string_pos, which see.
4609 See handle_single_display_spec for documentation of arguments.
4610 FRAME_WINDOW_P is true if the window being redisplayed is on a
4611 GUI frame; this argument is used only if IT is NULL, see below.
4613 IT can be NULL, if this is called by the bidi reordering code
4614 through compute_display_string_pos, which see. In that case, this
4615 function only examines SPEC, but does not otherwise "handle" it, in
4616 the sense that it doesn't set up members of IT from the display
4617 spec. */
4618 static int
4619 handle_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4620 Lisp_Object overlay, struct text_pos *position,
4621 ptrdiff_t bufpos, bool frame_window_p)
4623 int replacing = 0;
4625 if (CONSP (spec)
4626 /* Simple specifications. */
4627 && !EQ (XCAR (spec), Qimage)
4628 && !EQ (XCAR (spec), Qspace)
4629 && !EQ (XCAR (spec), Qwhen)
4630 && !EQ (XCAR (spec), Qslice)
4631 && !EQ (XCAR (spec), Qspace_width)
4632 && !EQ (XCAR (spec), Qheight)
4633 && !EQ (XCAR (spec), Qraise)
4634 /* Marginal area specifications. */
4635 && !(CONSP (XCAR (spec)) && EQ (XCAR (XCAR (spec)), Qmargin))
4636 && !EQ (XCAR (spec), Qleft_fringe)
4637 && !EQ (XCAR (spec), Qright_fringe)
4638 && !NILP (XCAR (spec)))
4640 for (; CONSP (spec); spec = XCDR (spec))
4642 int rv = handle_single_display_spec (it, XCAR (spec), object,
4643 overlay, position, bufpos,
4644 replacing, frame_window_p);
4645 if (rv != 0)
4647 replacing = rv;
4648 /* If some text in a string is replaced, `position' no
4649 longer points to the position of `object'. */
4650 if (!it || STRINGP (object))
4651 break;
4655 else if (VECTORP (spec))
4657 ptrdiff_t i;
4658 for (i = 0; i < ASIZE (spec); ++i)
4660 int rv = handle_single_display_spec (it, AREF (spec, i), object,
4661 overlay, position, bufpos,
4662 replacing, frame_window_p);
4663 if (rv != 0)
4665 replacing = rv;
4666 /* If some text in a string is replaced, `position' no
4667 longer points to the position of `object'. */
4668 if (!it || STRINGP (object))
4669 break;
4673 else
4674 replacing = handle_single_display_spec (it, spec, object, overlay, position,
4675 bufpos, 0, frame_window_p);
4676 return replacing;
4679 /* Value is the position of the end of the `display' property starting
4680 at START_POS in OBJECT. */
4682 static struct text_pos
4683 display_prop_end (struct it *it, Lisp_Object object, struct text_pos start_pos)
4685 Lisp_Object end;
4686 struct text_pos end_pos;
4688 end = Fnext_single_char_property_change (make_number (CHARPOS (start_pos)),
4689 Qdisplay, object, Qnil);
4690 CHARPOS (end_pos) = XFASTINT (end);
4691 if (STRINGP (object))
4692 compute_string_pos (&end_pos, start_pos, it->string);
4693 else
4694 BYTEPOS (end_pos) = CHAR_TO_BYTE (XFASTINT (end));
4696 return end_pos;
4700 /* Set up IT from a single `display' property specification SPEC. OBJECT
4701 is the object in which the `display' property was found. *POSITION
4702 is the position in OBJECT at which the `display' property was found.
4703 BUFPOS is the buffer position of OBJECT (different from POSITION if
4704 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4705 previously saw a display specification which already replaced text
4706 display with something else, for example an image; we ignore such
4707 properties after the first one has been processed.
4709 OVERLAY is the overlay this `display' property came from,
4710 or nil if it was a text property.
4712 If SPEC is a `space' or `image' specification, and in some other
4713 cases too, set *POSITION to the position where the `display'
4714 property ends.
4716 If IT is NULL, only examine the property specification in SPEC, but
4717 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4718 is intended to be displayed in a window on a GUI frame.
4720 Value is non-zero if something was found which replaces the display
4721 of buffer or string text. */
4723 static int
4724 handle_single_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4725 Lisp_Object overlay, struct text_pos *position,
4726 ptrdiff_t bufpos, int display_replaced,
4727 bool frame_window_p)
4729 Lisp_Object form;
4730 Lisp_Object location, value;
4731 struct text_pos start_pos = *position;
4733 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4734 If the result is non-nil, use VALUE instead of SPEC. */
4735 form = Qt;
4736 if (CONSP (spec) && EQ (XCAR (spec), Qwhen))
4738 spec = XCDR (spec);
4739 if (!CONSP (spec))
4740 return 0;
4741 form = XCAR (spec);
4742 spec = XCDR (spec);
4745 if (!NILP (form) && !EQ (form, Qt))
4747 ptrdiff_t count = SPECPDL_INDEX ();
4748 struct gcpro gcpro1;
4750 /* Bind `object' to the object having the `display' property, a
4751 buffer or string. Bind `position' to the position in the
4752 object where the property was found, and `buffer-position'
4753 to the current position in the buffer. */
4755 if (NILP (object))
4756 XSETBUFFER (object, current_buffer);
4757 specbind (Qobject, object);
4758 specbind (Qposition, make_number (CHARPOS (*position)));
4759 specbind (Qbuffer_position, make_number (bufpos));
4760 GCPRO1 (form);
4761 form = safe_eval (form);
4762 UNGCPRO;
4763 unbind_to (count, Qnil);
4766 if (NILP (form))
4767 return 0;
4769 /* Handle `(height HEIGHT)' specifications. */
4770 if (CONSP (spec)
4771 && EQ (XCAR (spec), Qheight)
4772 && CONSP (XCDR (spec)))
4774 if (it)
4776 if (!FRAME_WINDOW_P (it->f))
4777 return 0;
4779 it->font_height = XCAR (XCDR (spec));
4780 if (!NILP (it->font_height))
4782 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4783 int new_height = -1;
4785 if (CONSP (it->font_height)
4786 && (EQ (XCAR (it->font_height), Qplus)
4787 || EQ (XCAR (it->font_height), Qminus))
4788 && CONSP (XCDR (it->font_height))
4789 && RANGED_INTEGERP (0, XCAR (XCDR (it->font_height)), INT_MAX))
4791 /* `(+ N)' or `(- N)' where N is an integer. */
4792 int steps = XINT (XCAR (XCDR (it->font_height)));
4793 if (EQ (XCAR (it->font_height), Qplus))
4794 steps = - steps;
4795 it->face_id = smaller_face (it->f, it->face_id, steps);
4797 else if (FUNCTIONP (it->font_height))
4799 /* Call function with current height as argument.
4800 Value is the new height. */
4801 Lisp_Object height;
4802 height = safe_call1 (it->font_height,
4803 face->lface[LFACE_HEIGHT_INDEX]);
4804 if (NUMBERP (height))
4805 new_height = XFLOATINT (height);
4807 else if (NUMBERP (it->font_height))
4809 /* Value is a multiple of the canonical char height. */
4810 struct face *f;
4812 f = FACE_FROM_ID (it->f,
4813 lookup_basic_face (it->f, DEFAULT_FACE_ID));
4814 new_height = (XFLOATINT (it->font_height)
4815 * XINT (f->lface[LFACE_HEIGHT_INDEX]));
4817 else
4819 /* Evaluate IT->font_height with `height' bound to the
4820 current specified height to get the new height. */
4821 ptrdiff_t count = SPECPDL_INDEX ();
4823 specbind (Qheight, face->lface[LFACE_HEIGHT_INDEX]);
4824 value = safe_eval (it->font_height);
4825 unbind_to (count, Qnil);
4827 if (NUMBERP (value))
4828 new_height = XFLOATINT (value);
4831 if (new_height > 0)
4832 it->face_id = face_with_height (it->f, it->face_id, new_height);
4836 return 0;
4839 /* Handle `(space-width WIDTH)'. */
4840 if (CONSP (spec)
4841 && EQ (XCAR (spec), Qspace_width)
4842 && CONSP (XCDR (spec)))
4844 if (it)
4846 if (!FRAME_WINDOW_P (it->f))
4847 return 0;
4849 value = XCAR (XCDR (spec));
4850 if (NUMBERP (value) && XFLOATINT (value) > 0)
4851 it->space_width = value;
4854 return 0;
4857 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4858 if (CONSP (spec)
4859 && EQ (XCAR (spec), Qslice))
4861 Lisp_Object tem;
4863 if (it)
4865 if (!FRAME_WINDOW_P (it->f))
4866 return 0;
4868 if (tem = XCDR (spec), CONSP (tem))
4870 it->slice.x = XCAR (tem);
4871 if (tem = XCDR (tem), CONSP (tem))
4873 it->slice.y = XCAR (tem);
4874 if (tem = XCDR (tem), CONSP (tem))
4876 it->slice.width = XCAR (tem);
4877 if (tem = XCDR (tem), CONSP (tem))
4878 it->slice.height = XCAR (tem);
4884 return 0;
4887 /* Handle `(raise FACTOR)'. */
4888 if (CONSP (spec)
4889 && EQ (XCAR (spec), Qraise)
4890 && CONSP (XCDR (spec)))
4892 if (it)
4894 if (!FRAME_WINDOW_P (it->f))
4895 return 0;
4897 #ifdef HAVE_WINDOW_SYSTEM
4898 value = XCAR (XCDR (spec));
4899 if (NUMBERP (value))
4901 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4902 it->voffset = - (XFLOATINT (value)
4903 * (normal_char_height (face->font, -1)));
4905 #endif /* HAVE_WINDOW_SYSTEM */
4908 return 0;
4911 /* Don't handle the other kinds of display specifications
4912 inside a string that we got from a `display' property. */
4913 if (it && it->string_from_display_prop_p)
4914 return 0;
4916 /* Characters having this form of property are not displayed, so
4917 we have to find the end of the property. */
4918 if (it)
4920 start_pos = *position;
4921 *position = display_prop_end (it, object, start_pos);
4922 /* If the display property comes from an overlay, don't consider
4923 any potential stop_charpos values before the end of that
4924 overlay. Since display_prop_end will happily find another
4925 'display' property coming from some other overlay or text
4926 property on buffer positions before this overlay's end, we
4927 need to ignore them, or else we risk displaying this
4928 overlay's display string/image twice. */
4929 if (!NILP (overlay))
4931 ptrdiff_t ovendpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4933 if (ovendpos > CHARPOS (*position))
4934 SET_TEXT_POS (*position, ovendpos, CHAR_TO_BYTE (ovendpos));
4937 value = Qnil;
4939 /* Stop the scan at that end position--we assume that all
4940 text properties change there. */
4941 if (it)
4942 it->stop_charpos = position->charpos;
4944 /* Handle `(left-fringe BITMAP [FACE])'
4945 and `(right-fringe BITMAP [FACE])'. */
4946 if (CONSP (spec)
4947 && (EQ (XCAR (spec), Qleft_fringe)
4948 || EQ (XCAR (spec), Qright_fringe))
4949 && CONSP (XCDR (spec)))
4951 int fringe_bitmap;
4953 if (it)
4955 if (!FRAME_WINDOW_P (it->f))
4956 /* If we return here, POSITION has been advanced
4957 across the text with this property. */
4959 /* Synchronize the bidi iterator with POSITION. This is
4960 needed because we are not going to push the iterator
4961 on behalf of this display property, so there will be
4962 no pop_it call to do this synchronization for us. */
4963 if (it->bidi_p)
4965 it->position = *position;
4966 iterate_out_of_display_property (it);
4967 *position = it->position;
4969 return 1;
4972 else if (!frame_window_p)
4973 return 1;
4975 #ifdef HAVE_WINDOW_SYSTEM
4976 value = XCAR (XCDR (spec));
4977 if (!SYMBOLP (value)
4978 || !(fringe_bitmap = lookup_fringe_bitmap (value)))
4979 /* If we return here, POSITION has been advanced
4980 across the text with this property. */
4982 if (it && it->bidi_p)
4984 it->position = *position;
4985 iterate_out_of_display_property (it);
4986 *position = it->position;
4988 return 1;
4991 if (it)
4993 int face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
4995 if (CONSP (XCDR (XCDR (spec))))
4997 Lisp_Object face_name = XCAR (XCDR (XCDR (spec)));
4998 int face_id2 = lookup_derived_face (it->f, face_name,
4999 FRINGE_FACE_ID, false);
5000 if (face_id2 >= 0)
5001 face_id = face_id2;
5004 /* Save current settings of IT so that we can restore them
5005 when we are finished with the glyph property value. */
5006 push_it (it, position);
5008 it->area = TEXT_AREA;
5009 it->what = IT_IMAGE;
5010 it->image_id = -1; /* no image */
5011 it->position = start_pos;
5012 it->object = NILP (object) ? it->w->contents : object;
5013 it->method = GET_FROM_IMAGE;
5014 it->from_overlay = Qnil;
5015 it->face_id = face_id;
5016 it->from_disp_prop_p = true;
5018 /* Say that we haven't consumed the characters with
5019 `display' property yet. The call to pop_it in
5020 set_iterator_to_next will clean this up. */
5021 *position = start_pos;
5023 if (EQ (XCAR (spec), Qleft_fringe))
5025 it->left_user_fringe_bitmap = fringe_bitmap;
5026 it->left_user_fringe_face_id = face_id;
5028 else
5030 it->right_user_fringe_bitmap = fringe_bitmap;
5031 it->right_user_fringe_face_id = face_id;
5034 #endif /* HAVE_WINDOW_SYSTEM */
5035 return 1;
5038 /* Prepare to handle `((margin left-margin) ...)',
5039 `((margin right-margin) ...)' and `((margin nil) ...)'
5040 prefixes for display specifications. */
5041 location = Qunbound;
5042 if (CONSP (spec) && CONSP (XCAR (spec)))
5044 Lisp_Object tem;
5046 value = XCDR (spec);
5047 if (CONSP (value))
5048 value = XCAR (value);
5050 tem = XCAR (spec);
5051 if (EQ (XCAR (tem), Qmargin)
5052 && (tem = XCDR (tem),
5053 tem = CONSP (tem) ? XCAR (tem) : Qnil,
5054 (NILP (tem)
5055 || EQ (tem, Qleft_margin)
5056 || EQ (tem, Qright_margin))))
5057 location = tem;
5060 if (EQ (location, Qunbound))
5062 location = Qnil;
5063 value = spec;
5066 /* After this point, VALUE is the property after any
5067 margin prefix has been stripped. It must be a string,
5068 an image specification, or `(space ...)'.
5070 LOCATION specifies where to display: `left-margin',
5071 `right-margin' or nil. */
5073 bool valid_p = (STRINGP (value)
5074 #ifdef HAVE_WINDOW_SYSTEM
5075 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
5076 && valid_image_p (value))
5077 #endif /* not HAVE_WINDOW_SYSTEM */
5078 || (CONSP (value) && EQ (XCAR (value), Qspace)));
5080 if (valid_p && display_replaced == 0)
5082 int retval = 1;
5084 if (!it)
5086 /* Callers need to know whether the display spec is any kind
5087 of `(space ...)' spec that is about to affect text-area
5088 display. */
5089 if (CONSP (value) && EQ (XCAR (value), Qspace) && NILP (location))
5090 retval = 2;
5091 return retval;
5094 /* Save current settings of IT so that we can restore them
5095 when we are finished with the glyph property value. */
5096 push_it (it, position);
5097 it->from_overlay = overlay;
5098 it->from_disp_prop_p = true;
5100 if (NILP (location))
5101 it->area = TEXT_AREA;
5102 else if (EQ (location, Qleft_margin))
5103 it->area = LEFT_MARGIN_AREA;
5104 else
5105 it->area = RIGHT_MARGIN_AREA;
5107 if (STRINGP (value))
5109 it->string = value;
5110 it->multibyte_p = STRING_MULTIBYTE (it->string);
5111 it->current.overlay_string_index = -1;
5112 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5113 it->end_charpos = it->string_nchars = SCHARS (it->string);
5114 it->method = GET_FROM_STRING;
5115 it->stop_charpos = 0;
5116 it->prev_stop = 0;
5117 it->base_level_stop = 0;
5118 it->string_from_display_prop_p = true;
5119 /* Say that we haven't consumed the characters with
5120 `display' property yet. The call to pop_it in
5121 set_iterator_to_next will clean this up. */
5122 if (BUFFERP (object))
5123 *position = start_pos;
5125 /* Force paragraph direction to be that of the parent
5126 object. If the parent object's paragraph direction is
5127 not yet determined, default to L2R. */
5128 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5129 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5130 else
5131 it->paragraph_embedding = L2R;
5133 /* Set up the bidi iterator for this display string. */
5134 if (it->bidi_p)
5136 it->bidi_it.string.lstring = it->string;
5137 it->bidi_it.string.s = NULL;
5138 it->bidi_it.string.schars = it->end_charpos;
5139 it->bidi_it.string.bufpos = bufpos;
5140 it->bidi_it.string.from_disp_str = true;
5141 it->bidi_it.string.unibyte = !it->multibyte_p;
5142 it->bidi_it.w = it->w;
5143 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5146 else if (CONSP (value) && EQ (XCAR (value), Qspace))
5148 it->method = GET_FROM_STRETCH;
5149 it->object = value;
5150 *position = it->position = start_pos;
5151 retval = 1 + (it->area == TEXT_AREA);
5153 #ifdef HAVE_WINDOW_SYSTEM
5154 else
5156 it->what = IT_IMAGE;
5157 it->image_id = lookup_image (it->f, value);
5158 it->position = start_pos;
5159 it->object = NILP (object) ? it->w->contents : object;
5160 it->method = GET_FROM_IMAGE;
5162 /* Say that we haven't consumed the characters with
5163 `display' property yet. The call to pop_it in
5164 set_iterator_to_next will clean this up. */
5165 *position = start_pos;
5167 #endif /* HAVE_WINDOW_SYSTEM */
5169 return retval;
5172 /* Invalid property or property not supported. Restore
5173 POSITION to what it was before. */
5174 *position = start_pos;
5175 return 0;
5178 /* Check if PROP is a display property value whose text should be
5179 treated as intangible. OVERLAY is the overlay from which PROP
5180 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5181 specify the buffer position covered by PROP. */
5183 bool
5184 display_prop_intangible_p (Lisp_Object prop, Lisp_Object overlay,
5185 ptrdiff_t charpos, ptrdiff_t bytepos)
5187 bool frame_window_p = FRAME_WINDOW_P (XFRAME (selected_frame));
5188 struct text_pos position;
5190 SET_TEXT_POS (position, charpos, bytepos);
5191 return (handle_display_spec (NULL, prop, Qnil, overlay,
5192 &position, charpos, frame_window_p)
5193 != 0);
5197 /* Return true if PROP is a display sub-property value containing STRING.
5199 Implementation note: this and the following function are really
5200 special cases of handle_display_spec and
5201 handle_single_display_spec, and should ideally use the same code.
5202 Until they do, these two pairs must be consistent and must be
5203 modified in sync. */
5205 static bool
5206 single_display_spec_string_p (Lisp_Object prop, Lisp_Object string)
5208 if (EQ (string, prop))
5209 return true;
5211 /* Skip over `when FORM'. */
5212 if (CONSP (prop) && EQ (XCAR (prop), Qwhen))
5214 prop = XCDR (prop);
5215 if (!CONSP (prop))
5216 return false;
5217 /* Actually, the condition following `when' should be eval'ed,
5218 like handle_single_display_spec does, and we should return
5219 false if it evaluates to nil. However, this function is
5220 called only when the buffer was already displayed and some
5221 glyph in the glyph matrix was found to come from a display
5222 string. Therefore, the condition was already evaluated, and
5223 the result was non-nil, otherwise the display string wouldn't
5224 have been displayed and we would have never been called for
5225 this property. Thus, we can skip the evaluation and assume
5226 its result is non-nil. */
5227 prop = XCDR (prop);
5230 if (CONSP (prop))
5231 /* Skip over `margin LOCATION'. */
5232 if (EQ (XCAR (prop), Qmargin))
5234 prop = XCDR (prop);
5235 if (!CONSP (prop))
5236 return false;
5238 prop = XCDR (prop);
5239 if (!CONSP (prop))
5240 return false;
5243 return EQ (prop, string) || (CONSP (prop) && EQ (XCAR (prop), string));
5247 /* Return true if STRING appears in the `display' property PROP. */
5249 static bool
5250 display_prop_string_p (Lisp_Object prop, Lisp_Object string)
5252 if (CONSP (prop)
5253 && !EQ (XCAR (prop), Qwhen)
5254 && !(CONSP (XCAR (prop)) && EQ (Qmargin, XCAR (XCAR (prop)))))
5256 /* A list of sub-properties. */
5257 while (CONSP (prop))
5259 if (single_display_spec_string_p (XCAR (prop), string))
5260 return true;
5261 prop = XCDR (prop);
5264 else if (VECTORP (prop))
5266 /* A vector of sub-properties. */
5267 ptrdiff_t i;
5268 for (i = 0; i < ASIZE (prop); ++i)
5269 if (single_display_spec_string_p (AREF (prop, i), string))
5270 return true;
5272 else
5273 return single_display_spec_string_p (prop, string);
5275 return false;
5278 /* Look for STRING in overlays and text properties in the current
5279 buffer, between character positions FROM and TO (excluding TO).
5280 BACK_P means look back (in this case, TO is supposed to be
5281 less than FROM).
5282 Value is the first character position where STRING was found, or
5283 zero if it wasn't found before hitting TO.
5285 This function may only use code that doesn't eval because it is
5286 called asynchronously from note_mouse_highlight. */
5288 static ptrdiff_t
5289 string_buffer_position_lim (Lisp_Object string,
5290 ptrdiff_t from, ptrdiff_t to, bool back_p)
5292 Lisp_Object limit, prop, pos;
5293 bool found = false;
5295 pos = make_number (max (from, BEGV));
5297 if (!back_p) /* looking forward */
5299 limit = make_number (min (to, ZV));
5300 while (!found && !EQ (pos, limit))
5302 prop = Fget_char_property (pos, Qdisplay, Qnil);
5303 if (!NILP (prop) && display_prop_string_p (prop, string))
5304 found = true;
5305 else
5306 pos = Fnext_single_char_property_change (pos, Qdisplay, Qnil,
5307 limit);
5310 else /* looking back */
5312 limit = make_number (max (to, BEGV));
5313 while (!found && !EQ (pos, limit))
5315 prop = Fget_char_property (pos, Qdisplay, Qnil);
5316 if (!NILP (prop) && display_prop_string_p (prop, string))
5317 found = true;
5318 else
5319 pos = Fprevious_single_char_property_change (pos, Qdisplay, Qnil,
5320 limit);
5324 return found ? XINT (pos) : 0;
5327 /* Determine which buffer position in current buffer STRING comes from.
5328 AROUND_CHARPOS is an approximate position where it could come from.
5329 Value is the buffer position or 0 if it couldn't be determined.
5331 This function is necessary because we don't record buffer positions
5332 in glyphs generated from strings (to keep struct glyph small).
5333 This function may only use code that doesn't eval because it is
5334 called asynchronously from note_mouse_highlight. */
5336 static ptrdiff_t
5337 string_buffer_position (Lisp_Object string, ptrdiff_t around_charpos)
5339 const int MAX_DISTANCE = 1000;
5340 ptrdiff_t found = string_buffer_position_lim (string, around_charpos,
5341 around_charpos + MAX_DISTANCE,
5342 false);
5344 if (!found)
5345 found = string_buffer_position_lim (string, around_charpos,
5346 around_charpos - MAX_DISTANCE, true);
5347 return found;
5352 /***********************************************************************
5353 `composition' property
5354 ***********************************************************************/
5356 /* Set up iterator IT from `composition' property at its current
5357 position. Called from handle_stop. */
5359 static enum prop_handled
5360 handle_composition_prop (struct it *it)
5362 Lisp_Object prop, string;
5363 ptrdiff_t pos, pos_byte, start, end;
5365 if (STRINGP (it->string))
5367 unsigned char *s;
5369 pos = IT_STRING_CHARPOS (*it);
5370 pos_byte = IT_STRING_BYTEPOS (*it);
5371 string = it->string;
5372 s = SDATA (string) + pos_byte;
5373 it->c = STRING_CHAR (s);
5375 else
5377 pos = IT_CHARPOS (*it);
5378 pos_byte = IT_BYTEPOS (*it);
5379 string = Qnil;
5380 it->c = FETCH_CHAR (pos_byte);
5383 /* If there's a valid composition and point is not inside of the
5384 composition (in the case that the composition is from the current
5385 buffer), draw a glyph composed from the composition components. */
5386 if (find_composition (pos, -1, &start, &end, &prop, string)
5387 && composition_valid_p (start, end, prop)
5388 && (STRINGP (it->string) || (PT <= start || PT >= end)))
5390 if (start < pos)
5391 /* As we can't handle this situation (perhaps font-lock added
5392 a new composition), we just return here hoping that next
5393 redisplay will detect this composition much earlier. */
5394 return HANDLED_NORMALLY;
5395 if (start != pos)
5397 if (STRINGP (it->string))
5398 pos_byte = string_char_to_byte (it->string, start);
5399 else
5400 pos_byte = CHAR_TO_BYTE (start);
5402 it->cmp_it.id = get_composition_id (start, pos_byte, end - start,
5403 prop, string);
5405 if (it->cmp_it.id >= 0)
5407 it->cmp_it.ch = -1;
5408 it->cmp_it.nchars = COMPOSITION_LENGTH (prop);
5409 it->cmp_it.nglyphs = -1;
5413 return HANDLED_NORMALLY;
5418 /***********************************************************************
5419 Overlay strings
5420 ***********************************************************************/
5422 /* The following structure is used to record overlay strings for
5423 later sorting in load_overlay_strings. */
5425 struct overlay_entry
5427 Lisp_Object overlay;
5428 Lisp_Object string;
5429 EMACS_INT priority;
5430 bool after_string_p;
5434 /* Set up iterator IT from overlay strings at its current position.
5435 Called from handle_stop. */
5437 static enum prop_handled
5438 handle_overlay_change (struct it *it)
5440 if (!STRINGP (it->string) && get_overlay_strings (it, 0))
5441 return HANDLED_RECOMPUTE_PROPS;
5442 else
5443 return HANDLED_NORMALLY;
5447 /* Set up the next overlay string for delivery by IT, if there is an
5448 overlay string to deliver. Called by set_iterator_to_next when the
5449 end of the current overlay string is reached. If there are more
5450 overlay strings to display, IT->string and
5451 IT->current.overlay_string_index are set appropriately here.
5452 Otherwise IT->string is set to nil. */
5454 static void
5455 next_overlay_string (struct it *it)
5457 ++it->current.overlay_string_index;
5458 if (it->current.overlay_string_index == it->n_overlay_strings)
5460 /* No more overlay strings. Restore IT's settings to what
5461 they were before overlay strings were processed, and
5462 continue to deliver from current_buffer. */
5464 it->ellipsis_p = it->stack[it->sp - 1].display_ellipsis_p;
5465 pop_it (it);
5466 eassert (it->sp > 0
5467 || (NILP (it->string)
5468 && it->method == GET_FROM_BUFFER
5469 && it->stop_charpos >= BEGV
5470 && it->stop_charpos <= it->end_charpos));
5471 it->current.overlay_string_index = -1;
5472 it->n_overlay_strings = 0;
5473 /* If there's an empty display string on the stack, pop the
5474 stack, to resync the bidi iterator with IT's position. Such
5475 empty strings are pushed onto the stack in
5476 get_overlay_strings_1. */
5477 if (it->sp > 0 && STRINGP (it->string) && !SCHARS (it->string))
5478 pop_it (it);
5480 /* Since we've exhausted overlay strings at this buffer
5481 position, set the flag to ignore overlays until we move to
5482 another position. The flag is reset in
5483 next_element_from_buffer. */
5484 it->ignore_overlay_strings_at_pos_p = true;
5486 /* If we're at the end of the buffer, record that we have
5487 processed the overlay strings there already, so that
5488 next_element_from_buffer doesn't try it again. */
5489 if (NILP (it->string)
5490 && IT_CHARPOS (*it) >= it->end_charpos
5491 && it->overlay_strings_charpos >= it->end_charpos)
5492 it->overlay_strings_at_end_processed_p = true;
5493 /* Note: we reset overlay_strings_charpos only here, to make
5494 sure the just-processed overlays were indeed at EOB.
5495 Otherwise, overlays on text with invisible text property,
5496 which are processed with IT's position past the invisible
5497 text, might fool us into thinking the overlays at EOB were
5498 already processed (linum-mode can cause this, for
5499 example). */
5500 it->overlay_strings_charpos = -1;
5502 else
5504 /* There are more overlay strings to process. If
5505 IT->current.overlay_string_index has advanced to a position
5506 where we must load IT->overlay_strings with more strings, do
5507 it. We must load at the IT->overlay_strings_charpos where
5508 IT->n_overlay_strings was originally computed; when invisible
5509 text is present, this might not be IT_CHARPOS (Bug#7016). */
5510 int i = it->current.overlay_string_index % OVERLAY_STRING_CHUNK_SIZE;
5512 if (it->current.overlay_string_index && i == 0)
5513 load_overlay_strings (it, it->overlay_strings_charpos);
5515 /* Initialize IT to deliver display elements from the overlay
5516 string. */
5517 it->string = it->overlay_strings[i];
5518 it->multibyte_p = STRING_MULTIBYTE (it->string);
5519 SET_TEXT_POS (it->current.string_pos, 0, 0);
5520 it->method = GET_FROM_STRING;
5521 it->stop_charpos = 0;
5522 it->end_charpos = SCHARS (it->string);
5523 if (it->cmp_it.stop_pos >= 0)
5524 it->cmp_it.stop_pos = 0;
5525 it->prev_stop = 0;
5526 it->base_level_stop = 0;
5528 /* Set up the bidi iterator for this overlay string. */
5529 if (it->bidi_p)
5531 it->bidi_it.string.lstring = it->string;
5532 it->bidi_it.string.s = NULL;
5533 it->bidi_it.string.schars = SCHARS (it->string);
5534 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
5535 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5536 it->bidi_it.string.unibyte = !it->multibyte_p;
5537 it->bidi_it.w = it->w;
5538 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5542 CHECK_IT (it);
5546 /* Compare two overlay_entry structures E1 and E2. Used as a
5547 comparison function for qsort in load_overlay_strings. Overlay
5548 strings for the same position are sorted so that
5550 1. All after-strings come in front of before-strings, except
5551 when they come from the same overlay.
5553 2. Within after-strings, strings are sorted so that overlay strings
5554 from overlays with higher priorities come first.
5556 2. Within before-strings, strings are sorted so that overlay
5557 strings from overlays with higher priorities come last.
5559 Value is analogous to strcmp. */
5562 static int
5563 compare_overlay_entries (const void *e1, const void *e2)
5565 struct overlay_entry const *entry1 = e1;
5566 struct overlay_entry const *entry2 = e2;
5567 int result;
5569 if (entry1->after_string_p != entry2->after_string_p)
5571 /* Let after-strings appear in front of before-strings if
5572 they come from different overlays. */
5573 if (EQ (entry1->overlay, entry2->overlay))
5574 result = entry1->after_string_p ? 1 : -1;
5575 else
5576 result = entry1->after_string_p ? -1 : 1;
5578 else if (entry1->priority != entry2->priority)
5580 if (entry1->after_string_p)
5581 /* After-strings sorted in order of decreasing priority. */
5582 result = entry2->priority < entry1->priority ? -1 : 1;
5583 else
5584 /* Before-strings sorted in order of increasing priority. */
5585 result = entry1->priority < entry2->priority ? -1 : 1;
5587 else
5588 result = 0;
5590 return result;
5594 /* Load the vector IT->overlay_strings with overlay strings from IT's
5595 current buffer position, or from CHARPOS if that is > 0. Set
5596 IT->n_overlays to the total number of overlay strings found.
5598 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5599 a time. On entry into load_overlay_strings,
5600 IT->current.overlay_string_index gives the number of overlay
5601 strings that have already been loaded by previous calls to this
5602 function.
5604 IT->add_overlay_start contains an additional overlay start
5605 position to consider for taking overlay strings from, if non-zero.
5606 This position comes into play when the overlay has an `invisible'
5607 property, and both before and after-strings. When we've skipped to
5608 the end of the overlay, because of its `invisible' property, we
5609 nevertheless want its before-string to appear.
5610 IT->add_overlay_start will contain the overlay start position
5611 in this case.
5613 Overlay strings are sorted so that after-string strings come in
5614 front of before-string strings. Within before and after-strings,
5615 strings are sorted by overlay priority. See also function
5616 compare_overlay_entries. */
5618 static void
5619 load_overlay_strings (struct it *it, ptrdiff_t charpos)
5621 Lisp_Object overlay, window, str, invisible;
5622 struct Lisp_Overlay *ov;
5623 ptrdiff_t start, end;
5624 ptrdiff_t n = 0, i, j;
5625 int invis;
5626 struct overlay_entry entriesbuf[20];
5627 ptrdiff_t size = ARRAYELTS (entriesbuf);
5628 struct overlay_entry *entries = entriesbuf;
5629 USE_SAFE_ALLOCA;
5631 if (charpos <= 0)
5632 charpos = IT_CHARPOS (*it);
5634 /* Append the overlay string STRING of overlay OVERLAY to vector
5635 `entries' which has size `size' and currently contains `n'
5636 elements. AFTER_P means STRING is an after-string of
5637 OVERLAY. */
5638 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5639 do \
5641 Lisp_Object priority; \
5643 if (n == size) \
5645 struct overlay_entry *old = entries; \
5646 SAFE_NALLOCA (entries, 2, size); \
5647 memcpy (entries, old, size * sizeof *entries); \
5648 size *= 2; \
5651 entries[n].string = (STRING); \
5652 entries[n].overlay = (OVERLAY); \
5653 priority = Foverlay_get ((OVERLAY), Qpriority); \
5654 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5655 entries[n].after_string_p = (AFTER_P); \
5656 ++n; \
5658 while (false)
5660 /* Process overlay before the overlay center. */
5661 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5663 XSETMISC (overlay, ov);
5664 eassert (OVERLAYP (overlay));
5665 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5666 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5668 if (end < charpos)
5669 break;
5671 /* Skip this overlay if it doesn't start or end at IT's current
5672 position. */
5673 if (end != charpos && start != charpos)
5674 continue;
5676 /* Skip this overlay if it doesn't apply to IT->w. */
5677 window = Foverlay_get (overlay, Qwindow);
5678 if (WINDOWP (window) && XWINDOW (window) != it->w)
5679 continue;
5681 /* If the text ``under'' the overlay is invisible, both before-
5682 and after-strings from this overlay are visible; start and
5683 end position are indistinguishable. */
5684 invisible = Foverlay_get (overlay, Qinvisible);
5685 invis = TEXT_PROP_MEANS_INVISIBLE (invisible);
5687 /* If overlay has a non-empty before-string, record it. */
5688 if ((start == charpos || (end == charpos && invis != 0))
5689 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5690 && SCHARS (str))
5691 RECORD_OVERLAY_STRING (overlay, str, false);
5693 /* If overlay has a non-empty after-string, record it. */
5694 if ((end == charpos || (start == charpos && invis != 0))
5695 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5696 && SCHARS (str))
5697 RECORD_OVERLAY_STRING (overlay, str, true);
5700 /* Process overlays after the overlay center. */
5701 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5703 XSETMISC (overlay, ov);
5704 eassert (OVERLAYP (overlay));
5705 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5706 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5708 if (start > charpos)
5709 break;
5711 /* Skip this overlay if it doesn't start or end at IT's current
5712 position. */
5713 if (end != charpos && start != charpos)
5714 continue;
5716 /* Skip this overlay if it doesn't apply to IT->w. */
5717 window = Foverlay_get (overlay, Qwindow);
5718 if (WINDOWP (window) && XWINDOW (window) != it->w)
5719 continue;
5721 /* If the text ``under'' the overlay is invisible, it has a zero
5722 dimension, and both before- and after-strings apply. */
5723 invisible = Foverlay_get (overlay, Qinvisible);
5724 invis = TEXT_PROP_MEANS_INVISIBLE (invisible);
5726 /* If overlay has a non-empty before-string, record it. */
5727 if ((start == charpos || (end == charpos && invis != 0))
5728 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5729 && SCHARS (str))
5730 RECORD_OVERLAY_STRING (overlay, str, false);
5732 /* If overlay has a non-empty after-string, record it. */
5733 if ((end == charpos || (start == charpos && invis != 0))
5734 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5735 && SCHARS (str))
5736 RECORD_OVERLAY_STRING (overlay, str, true);
5739 #undef RECORD_OVERLAY_STRING
5741 /* Sort entries. */
5742 if (n > 1)
5743 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5745 /* Record number of overlay strings, and where we computed it. */
5746 it->n_overlay_strings = n;
5747 it->overlay_strings_charpos = charpos;
5749 /* IT->current.overlay_string_index is the number of overlay strings
5750 that have already been consumed by IT. Copy some of the
5751 remaining overlay strings to IT->overlay_strings. */
5752 i = 0;
5753 j = it->current.overlay_string_index;
5754 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5756 it->overlay_strings[i] = entries[j].string;
5757 it->string_overlays[i++] = entries[j++].overlay;
5760 CHECK_IT (it);
5761 SAFE_FREE ();
5765 /* Get the first chunk of overlay strings at IT's current buffer
5766 position, or at CHARPOS if that is > 0. Value is true if at
5767 least one overlay string was found. */
5769 static bool
5770 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, bool compute_stop_p)
5772 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5773 process. This fills IT->overlay_strings with strings, and sets
5774 IT->n_overlay_strings to the total number of strings to process.
5775 IT->pos.overlay_string_index has to be set temporarily to zero
5776 because load_overlay_strings needs this; it must be set to -1
5777 when no overlay strings are found because a zero value would
5778 indicate a position in the first overlay string. */
5779 it->current.overlay_string_index = 0;
5780 load_overlay_strings (it, charpos);
5782 /* If we found overlay strings, set up IT to deliver display
5783 elements from the first one. Otherwise set up IT to deliver
5784 from current_buffer. */
5785 if (it->n_overlay_strings)
5787 /* Make sure we know settings in current_buffer, so that we can
5788 restore meaningful values when we're done with the overlay
5789 strings. */
5790 if (compute_stop_p)
5791 compute_stop_pos (it);
5792 eassert (it->face_id >= 0);
5794 /* Save IT's settings. They are restored after all overlay
5795 strings have been processed. */
5796 eassert (!compute_stop_p || it->sp == 0);
5798 /* When called from handle_stop, there might be an empty display
5799 string loaded. In that case, don't bother saving it. But
5800 don't use this optimization with the bidi iterator, since we
5801 need the corresponding pop_it call to resync the bidi
5802 iterator's position with IT's position, after we are done
5803 with the overlay strings. (The corresponding call to pop_it
5804 in case of an empty display string is in
5805 next_overlay_string.) */
5806 if (!(!it->bidi_p
5807 && STRINGP (it->string) && !SCHARS (it->string)))
5808 push_it (it, NULL);
5810 /* Set up IT to deliver display elements from the first overlay
5811 string. */
5812 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5813 it->string = it->overlay_strings[0];
5814 it->from_overlay = Qnil;
5815 it->stop_charpos = 0;
5816 eassert (STRINGP (it->string));
5817 it->end_charpos = SCHARS (it->string);
5818 it->prev_stop = 0;
5819 it->base_level_stop = 0;
5820 it->multibyte_p = STRING_MULTIBYTE (it->string);
5821 it->method = GET_FROM_STRING;
5822 it->from_disp_prop_p = 0;
5824 /* Force paragraph direction to be that of the parent
5825 buffer. */
5826 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5827 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5828 else
5829 it->paragraph_embedding = L2R;
5831 /* Set up the bidi iterator for this overlay string. */
5832 if (it->bidi_p)
5834 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5836 it->bidi_it.string.lstring = it->string;
5837 it->bidi_it.string.s = NULL;
5838 it->bidi_it.string.schars = SCHARS (it->string);
5839 it->bidi_it.string.bufpos = pos;
5840 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5841 it->bidi_it.string.unibyte = !it->multibyte_p;
5842 it->bidi_it.w = it->w;
5843 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5845 return true;
5848 it->current.overlay_string_index = -1;
5849 return false;
5852 static bool
5853 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5855 it->string = Qnil;
5856 it->method = GET_FROM_BUFFER;
5858 get_overlay_strings_1 (it, charpos, true);
5860 CHECK_IT (it);
5862 /* Value is true if we found at least one overlay string. */
5863 return STRINGP (it->string);
5868 /***********************************************************************
5869 Saving and restoring state
5870 ***********************************************************************/
5872 /* Save current settings of IT on IT->stack. Called, for example,
5873 before setting up IT for an overlay string, to be able to restore
5874 IT's settings to what they were after the overlay string has been
5875 processed. If POSITION is non-NULL, it is the position to save on
5876 the stack instead of IT->position. */
5878 static void
5879 push_it (struct it *it, struct text_pos *position)
5881 struct iterator_stack_entry *p;
5883 eassert (it->sp < IT_STACK_SIZE);
5884 p = it->stack + it->sp;
5886 p->stop_charpos = it->stop_charpos;
5887 p->prev_stop = it->prev_stop;
5888 p->base_level_stop = it->base_level_stop;
5889 p->cmp_it = it->cmp_it;
5890 eassert (it->face_id >= 0);
5891 p->face_id = it->face_id;
5892 p->string = it->string;
5893 p->method = it->method;
5894 p->from_overlay = it->from_overlay;
5895 switch (p->method)
5897 case GET_FROM_IMAGE:
5898 p->u.image.object = it->object;
5899 p->u.image.image_id = it->image_id;
5900 p->u.image.slice = it->slice;
5901 break;
5902 case GET_FROM_STRETCH:
5903 p->u.stretch.object = it->object;
5904 break;
5906 p->position = position ? *position : it->position;
5907 p->current = it->current;
5908 p->end_charpos = it->end_charpos;
5909 p->string_nchars = it->string_nchars;
5910 p->area = it->area;
5911 p->multibyte_p = it->multibyte_p;
5912 p->avoid_cursor_p = it->avoid_cursor_p;
5913 p->space_width = it->space_width;
5914 p->font_height = it->font_height;
5915 p->voffset = it->voffset;
5916 p->string_from_display_prop_p = it->string_from_display_prop_p;
5917 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
5918 p->display_ellipsis_p = false;
5919 p->line_wrap = it->line_wrap;
5920 p->bidi_p = it->bidi_p;
5921 p->paragraph_embedding = it->paragraph_embedding;
5922 p->from_disp_prop_p = it->from_disp_prop_p;
5923 ++it->sp;
5925 /* Save the state of the bidi iterator as well. */
5926 if (it->bidi_p)
5927 bidi_push_it (&it->bidi_it);
5930 static void
5931 iterate_out_of_display_property (struct it *it)
5933 bool buffer_p = !STRINGP (it->string);
5934 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
5935 ptrdiff_t bob = (buffer_p ? BEGV : 0);
5937 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
5939 /* Maybe initialize paragraph direction. If we are at the beginning
5940 of a new paragraph, next_element_from_buffer may not have a
5941 chance to do that. */
5942 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
5943 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
5944 /* prev_stop can be zero, so check against BEGV as well. */
5945 while (it->bidi_it.charpos >= bob
5946 && it->prev_stop <= it->bidi_it.charpos
5947 && it->bidi_it.charpos < CHARPOS (it->position)
5948 && it->bidi_it.charpos < eob)
5949 bidi_move_to_visually_next (&it->bidi_it);
5950 /* Record the stop_pos we just crossed, for when we cross it
5951 back, maybe. */
5952 if (it->bidi_it.charpos > CHARPOS (it->position))
5953 it->prev_stop = CHARPOS (it->position);
5954 /* If we ended up not where pop_it put us, resync IT's
5955 positional members with the bidi iterator. */
5956 if (it->bidi_it.charpos != CHARPOS (it->position))
5957 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
5958 if (buffer_p)
5959 it->current.pos = it->position;
5960 else
5961 it->current.string_pos = it->position;
5964 /* Restore IT's settings from IT->stack. Called, for example, when no
5965 more overlay strings must be processed, and we return to delivering
5966 display elements from a buffer, or when the end of a string from a
5967 `display' property is reached and we return to delivering display
5968 elements from an overlay string, or from a buffer. */
5970 static void
5971 pop_it (struct it *it)
5973 struct iterator_stack_entry *p;
5974 bool from_display_prop = it->from_disp_prop_p;
5975 ptrdiff_t prev_pos = IT_CHARPOS (*it);
5977 eassert (it->sp > 0);
5978 --it->sp;
5979 p = it->stack + it->sp;
5980 it->stop_charpos = p->stop_charpos;
5981 it->prev_stop = p->prev_stop;
5982 it->base_level_stop = p->base_level_stop;
5983 it->cmp_it = p->cmp_it;
5984 it->face_id = p->face_id;
5985 it->current = p->current;
5986 it->position = p->position;
5987 it->string = p->string;
5988 it->from_overlay = p->from_overlay;
5989 if (NILP (it->string))
5990 SET_TEXT_POS (it->current.string_pos, -1, -1);
5991 it->method = p->method;
5992 switch (it->method)
5994 case GET_FROM_IMAGE:
5995 it->image_id = p->u.image.image_id;
5996 it->object = p->u.image.object;
5997 it->slice = p->u.image.slice;
5998 break;
5999 case GET_FROM_STRETCH:
6000 it->object = p->u.stretch.object;
6001 break;
6002 case GET_FROM_BUFFER:
6003 it->object = it->w->contents;
6004 break;
6005 case GET_FROM_STRING:
6007 struct face *face = FACE_FROM_ID (it->f, it->face_id);
6009 /* Restore the face_box_p flag, since it could have been
6010 overwritten by the face of the object that we just finished
6011 displaying. */
6012 if (face)
6013 it->face_box_p = face->box != FACE_NO_BOX;
6014 it->object = it->string;
6016 break;
6017 case GET_FROM_DISPLAY_VECTOR:
6018 if (it->s)
6019 it->method = GET_FROM_C_STRING;
6020 else if (STRINGP (it->string))
6021 it->method = GET_FROM_STRING;
6022 else
6024 it->method = GET_FROM_BUFFER;
6025 it->object = it->w->contents;
6028 it->end_charpos = p->end_charpos;
6029 it->string_nchars = p->string_nchars;
6030 it->area = p->area;
6031 it->multibyte_p = p->multibyte_p;
6032 it->avoid_cursor_p = p->avoid_cursor_p;
6033 it->space_width = p->space_width;
6034 it->font_height = p->font_height;
6035 it->voffset = p->voffset;
6036 it->string_from_display_prop_p = p->string_from_display_prop_p;
6037 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
6038 it->line_wrap = p->line_wrap;
6039 it->bidi_p = p->bidi_p;
6040 it->paragraph_embedding = p->paragraph_embedding;
6041 it->from_disp_prop_p = p->from_disp_prop_p;
6042 if (it->bidi_p)
6044 bidi_pop_it (&it->bidi_it);
6045 /* Bidi-iterate until we get out of the portion of text, if any,
6046 covered by a `display' text property or by an overlay with
6047 `display' property. (We cannot just jump there, because the
6048 internal coherency of the bidi iterator state can not be
6049 preserved across such jumps.) We also must determine the
6050 paragraph base direction if the overlay we just processed is
6051 at the beginning of a new paragraph. */
6052 if (from_display_prop
6053 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
6054 iterate_out_of_display_property (it);
6056 eassert ((BUFFERP (it->object)
6057 && IT_CHARPOS (*it) == it->bidi_it.charpos
6058 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
6059 || (STRINGP (it->object)
6060 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
6061 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
6062 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
6064 /* If we move the iterator over text covered by a display property
6065 to a new buffer position, any info about previously seen overlays
6066 is no longer valid. */
6067 if (from_display_prop && it->sp == 0 && CHARPOS (it->position) != prev_pos)
6068 it->ignore_overlay_strings_at_pos_p = false;
6073 /***********************************************************************
6074 Moving over lines
6075 ***********************************************************************/
6077 /* Set IT's current position to the previous line start. */
6079 static void
6080 back_to_previous_line_start (struct it *it)
6082 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
6084 DEC_BOTH (cp, bp);
6085 IT_CHARPOS (*it) = find_newline_no_quit (cp, bp, -1, &IT_BYTEPOS (*it));
6089 /* Move IT to the next line start.
6091 Value is true if a newline was found. Set *SKIPPED_P to true if
6092 we skipped over part of the text (as opposed to moving the iterator
6093 continuously over the text). Otherwise, don't change the value
6094 of *SKIPPED_P.
6096 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6097 iterator on the newline, if it was found.
6099 Newlines may come from buffer text, overlay strings, or strings
6100 displayed via the `display' property. That's the reason we can't
6101 simply use find_newline_no_quit.
6103 Note that this function may not skip over invisible text that is so
6104 because of text properties and immediately follows a newline. If
6105 it would, function reseat_at_next_visible_line_start, when called
6106 from set_iterator_to_next, would effectively make invisible
6107 characters following a newline part of the wrong glyph row, which
6108 leads to wrong cursor motion. */
6110 static bool
6111 forward_to_next_line_start (struct it *it, bool *skipped_p,
6112 struct bidi_it *bidi_it_prev)
6114 ptrdiff_t old_selective;
6115 bool newline_found_p = false;
6116 int n;
6117 const int MAX_NEWLINE_DISTANCE = 500;
6119 /* If already on a newline, just consume it to avoid unintended
6120 skipping over invisible text below. */
6121 if (it->what == IT_CHARACTER
6122 && it->c == '\n'
6123 && CHARPOS (it->position) == IT_CHARPOS (*it))
6125 if (it->bidi_p && bidi_it_prev)
6126 *bidi_it_prev = it->bidi_it;
6127 set_iterator_to_next (it, false);
6128 it->c = 0;
6129 return true;
6132 /* Don't handle selective display in the following. It's (a)
6133 unnecessary because it's done by the caller, and (b) leads to an
6134 infinite recursion because next_element_from_ellipsis indirectly
6135 calls this function. */
6136 old_selective = it->selective;
6137 it->selective = 0;
6139 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6140 from buffer text. */
6141 for (n = 0;
6142 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
6143 n += !STRINGP (it->string))
6145 if (!get_next_display_element (it))
6146 return false;
6147 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
6148 if (newline_found_p && it->bidi_p && bidi_it_prev)
6149 *bidi_it_prev = it->bidi_it;
6150 set_iterator_to_next (it, false);
6153 /* If we didn't find a newline near enough, see if we can use a
6154 short-cut. */
6155 if (!newline_found_p)
6157 ptrdiff_t bytepos, start = IT_CHARPOS (*it);
6158 ptrdiff_t limit = find_newline_no_quit (start, IT_BYTEPOS (*it),
6159 1, &bytepos);
6160 Lisp_Object pos;
6162 eassert (!STRINGP (it->string));
6164 /* If there isn't any `display' property in sight, and no
6165 overlays, we can just use the position of the newline in
6166 buffer text. */
6167 if (it->stop_charpos >= limit
6168 || ((pos = Fnext_single_property_change (make_number (start),
6169 Qdisplay, Qnil,
6170 make_number (limit)),
6171 NILP (pos))
6172 && next_overlay_change (start) == ZV))
6174 if (!it->bidi_p)
6176 IT_CHARPOS (*it) = limit;
6177 IT_BYTEPOS (*it) = bytepos;
6179 else
6181 struct bidi_it bprev;
6183 /* Help bidi.c avoid expensive searches for display
6184 properties and overlays, by telling it that there are
6185 none up to `limit'. */
6186 if (it->bidi_it.disp_pos < limit)
6188 it->bidi_it.disp_pos = limit;
6189 it->bidi_it.disp_prop = 0;
6191 do {
6192 bprev = it->bidi_it;
6193 bidi_move_to_visually_next (&it->bidi_it);
6194 } while (it->bidi_it.charpos != limit);
6195 IT_CHARPOS (*it) = limit;
6196 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6197 if (bidi_it_prev)
6198 *bidi_it_prev = bprev;
6200 *skipped_p = newline_found_p = true;
6202 else
6204 while (get_next_display_element (it)
6205 && !newline_found_p)
6207 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6208 if (newline_found_p && it->bidi_p && bidi_it_prev)
6209 *bidi_it_prev = it->bidi_it;
6210 set_iterator_to_next (it, false);
6215 it->selective = old_selective;
6216 return newline_found_p;
6220 /* Set IT's current position to the previous visible line start. Skip
6221 invisible text that is so either due to text properties or due to
6222 selective display. Caution: this does not change IT->current_x and
6223 IT->hpos. */
6225 static void
6226 back_to_previous_visible_line_start (struct it *it)
6228 while (IT_CHARPOS (*it) > BEGV)
6230 back_to_previous_line_start (it);
6232 if (IT_CHARPOS (*it) <= BEGV)
6233 break;
6235 /* If selective > 0, then lines indented more than its value are
6236 invisible. */
6237 if (it->selective > 0
6238 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6239 it->selective))
6240 continue;
6242 /* Check the newline before point for invisibility. */
6244 Lisp_Object prop;
6245 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6246 Qinvisible, it->window);
6247 if (TEXT_PROP_MEANS_INVISIBLE (prop) != 0)
6248 continue;
6251 if (IT_CHARPOS (*it) <= BEGV)
6252 break;
6255 struct it it2;
6256 void *it2data = NULL;
6257 ptrdiff_t pos;
6258 ptrdiff_t beg, end;
6259 Lisp_Object val, overlay;
6261 SAVE_IT (it2, *it, it2data);
6263 /* If newline is part of a composition, continue from start of composition */
6264 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6265 && beg < IT_CHARPOS (*it))
6266 goto replaced;
6268 /* If newline is replaced by a display property, find start of overlay
6269 or interval and continue search from that point. */
6270 pos = --IT_CHARPOS (it2);
6271 --IT_BYTEPOS (it2);
6272 it2.sp = 0;
6273 bidi_unshelve_cache (NULL, false);
6274 it2.string_from_display_prop_p = false;
6275 it2.from_disp_prop_p = false;
6276 if (handle_display_prop (&it2) == HANDLED_RETURN
6277 && !NILP (val = get_char_property_and_overlay
6278 (make_number (pos), Qdisplay, Qnil, &overlay))
6279 && (OVERLAYP (overlay)
6280 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6281 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6283 RESTORE_IT (it, it, it2data);
6284 goto replaced;
6287 /* Newline is not replaced by anything -- so we are done. */
6288 RESTORE_IT (it, it, it2data);
6289 break;
6291 replaced:
6292 if (beg < BEGV)
6293 beg = BEGV;
6294 IT_CHARPOS (*it) = beg;
6295 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6299 it->continuation_lines_width = 0;
6301 eassert (IT_CHARPOS (*it) >= BEGV);
6302 eassert (IT_CHARPOS (*it) == BEGV
6303 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6304 CHECK_IT (it);
6308 /* Reseat iterator IT at the previous visible line start. Skip
6309 invisible text that is so either due to text properties or due to
6310 selective display. At the end, update IT's overlay information,
6311 face information etc. */
6313 void
6314 reseat_at_previous_visible_line_start (struct it *it)
6316 back_to_previous_visible_line_start (it);
6317 reseat (it, it->current.pos, true);
6318 CHECK_IT (it);
6322 /* Reseat iterator IT on the next visible line start in the current
6323 buffer. ON_NEWLINE_P means position IT on the newline
6324 preceding the line start. Skip over invisible text that is so
6325 because of selective display. Compute faces, overlays etc at the
6326 new position. Note that this function does not skip over text that
6327 is invisible because of text properties. */
6329 static void
6330 reseat_at_next_visible_line_start (struct it *it, bool on_newline_p)
6332 bool skipped_p = false;
6333 struct bidi_it bidi_it_prev;
6334 bool newline_found_p
6335 = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6337 /* Skip over lines that are invisible because they are indented
6338 more than the value of IT->selective. */
6339 if (it->selective > 0)
6340 while (IT_CHARPOS (*it) < ZV
6341 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6342 it->selective))
6344 eassert (IT_BYTEPOS (*it) == BEGV
6345 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6346 newline_found_p =
6347 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6350 /* Position on the newline if that's what's requested. */
6351 if (on_newline_p && newline_found_p)
6353 if (STRINGP (it->string))
6355 if (IT_STRING_CHARPOS (*it) > 0)
6357 if (!it->bidi_p)
6359 --IT_STRING_CHARPOS (*it);
6360 --IT_STRING_BYTEPOS (*it);
6362 else
6364 /* We need to restore the bidi iterator to the state
6365 it had on the newline, and resync the IT's
6366 position with that. */
6367 it->bidi_it = bidi_it_prev;
6368 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6369 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6373 else if (IT_CHARPOS (*it) > BEGV)
6375 if (!it->bidi_p)
6377 --IT_CHARPOS (*it);
6378 --IT_BYTEPOS (*it);
6380 else
6382 /* We need to restore the bidi iterator to the state it
6383 had on the newline and resync IT with that. */
6384 it->bidi_it = bidi_it_prev;
6385 IT_CHARPOS (*it) = it->bidi_it.charpos;
6386 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6388 reseat (it, it->current.pos, false);
6391 else if (skipped_p)
6392 reseat (it, it->current.pos, false);
6394 CHECK_IT (it);
6399 /***********************************************************************
6400 Changing an iterator's position
6401 ***********************************************************************/
6403 /* Change IT's current position to POS in current_buffer.
6404 If FORCE_P, always check for text properties at the new position.
6405 Otherwise, text properties are only looked up if POS >=
6406 IT->check_charpos of a property. */
6408 static void
6409 reseat (struct it *it, struct text_pos pos, bool force_p)
6411 ptrdiff_t original_pos = IT_CHARPOS (*it);
6413 reseat_1 (it, pos, false);
6415 /* Determine where to check text properties. Avoid doing it
6416 where possible because text property lookup is very expensive. */
6417 if (force_p
6418 || CHARPOS (pos) > it->stop_charpos
6419 || CHARPOS (pos) < original_pos)
6421 if (it->bidi_p)
6423 /* For bidi iteration, we need to prime prev_stop and
6424 base_level_stop with our best estimations. */
6425 /* Implementation note: Of course, POS is not necessarily a
6426 stop position, so assigning prev_pos to it is a lie; we
6427 should have called compute_stop_backwards. However, if
6428 the current buffer does not include any R2L characters,
6429 that call would be a waste of cycles, because the
6430 iterator will never move back, and thus never cross this
6431 "fake" stop position. So we delay that backward search
6432 until the time we really need it, in next_element_from_buffer. */
6433 if (CHARPOS (pos) != it->prev_stop)
6434 it->prev_stop = CHARPOS (pos);
6435 if (CHARPOS (pos) < it->base_level_stop)
6436 it->base_level_stop = 0; /* meaning it's unknown */
6437 handle_stop (it);
6439 else
6441 handle_stop (it);
6442 it->prev_stop = it->base_level_stop = 0;
6447 CHECK_IT (it);
6451 /* Change IT's buffer position to POS. SET_STOP_P means set
6452 IT->stop_pos to POS, also. */
6454 static void
6455 reseat_1 (struct it *it, struct text_pos pos, bool set_stop_p)
6457 /* Don't call this function when scanning a C string. */
6458 eassert (it->s == NULL);
6460 /* POS must be a reasonable value. */
6461 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6463 it->current.pos = it->position = pos;
6464 it->end_charpos = ZV;
6465 it->dpvec = NULL;
6466 it->current.dpvec_index = -1;
6467 it->current.overlay_string_index = -1;
6468 IT_STRING_CHARPOS (*it) = -1;
6469 IT_STRING_BYTEPOS (*it) = -1;
6470 it->string = Qnil;
6471 it->method = GET_FROM_BUFFER;
6472 it->object = it->w->contents;
6473 it->area = TEXT_AREA;
6474 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6475 it->sp = 0;
6476 it->string_from_display_prop_p = false;
6477 it->string_from_prefix_prop_p = false;
6479 it->from_disp_prop_p = false;
6480 it->face_before_selective_p = false;
6481 if (it->bidi_p)
6483 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6484 &it->bidi_it);
6485 bidi_unshelve_cache (NULL, false);
6486 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6487 it->bidi_it.string.s = NULL;
6488 it->bidi_it.string.lstring = Qnil;
6489 it->bidi_it.string.bufpos = 0;
6490 it->bidi_it.string.from_disp_str = false;
6491 it->bidi_it.string.unibyte = false;
6492 it->bidi_it.w = it->w;
6495 if (set_stop_p)
6497 it->stop_charpos = CHARPOS (pos);
6498 it->base_level_stop = CHARPOS (pos);
6500 /* This make the information stored in it->cmp_it invalidate. */
6501 it->cmp_it.id = -1;
6505 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6506 If S is non-null, it is a C string to iterate over. Otherwise,
6507 STRING gives a Lisp string to iterate over.
6509 If PRECISION > 0, don't return more then PRECISION number of
6510 characters from the string.
6512 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6513 characters have been returned. FIELD_WIDTH < 0 means an infinite
6514 field width.
6516 MULTIBYTE = 0 means disable processing of multibyte characters,
6517 MULTIBYTE > 0 means enable it,
6518 MULTIBYTE < 0 means use IT->multibyte_p.
6520 IT must be initialized via a prior call to init_iterator before
6521 calling this function. */
6523 static void
6524 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6525 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6526 int multibyte)
6528 /* No text property checks performed by default, but see below. */
6529 it->stop_charpos = -1;
6531 /* Set iterator position and end position. */
6532 memset (&it->current, 0, sizeof it->current);
6533 it->current.overlay_string_index = -1;
6534 it->current.dpvec_index = -1;
6535 eassert (charpos >= 0);
6537 /* If STRING is specified, use its multibyteness, otherwise use the
6538 setting of MULTIBYTE, if specified. */
6539 if (multibyte >= 0)
6540 it->multibyte_p = multibyte > 0;
6542 /* Bidirectional reordering of strings is controlled by the default
6543 value of bidi-display-reordering. Don't try to reorder while
6544 loading loadup.el, as the necessary character property tables are
6545 not yet available. */
6546 it->bidi_p =
6547 NILP (Vpurify_flag)
6548 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6550 if (s == NULL)
6552 eassert (STRINGP (string));
6553 it->string = string;
6554 it->s = NULL;
6555 it->end_charpos = it->string_nchars = SCHARS (string);
6556 it->method = GET_FROM_STRING;
6557 it->current.string_pos = string_pos (charpos, string);
6559 if (it->bidi_p)
6561 it->bidi_it.string.lstring = string;
6562 it->bidi_it.string.s = NULL;
6563 it->bidi_it.string.schars = it->end_charpos;
6564 it->bidi_it.string.bufpos = 0;
6565 it->bidi_it.string.from_disp_str = false;
6566 it->bidi_it.string.unibyte = !it->multibyte_p;
6567 it->bidi_it.w = it->w;
6568 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6569 FRAME_WINDOW_P (it->f), &it->bidi_it);
6572 else
6574 it->s = (const unsigned char *) s;
6575 it->string = Qnil;
6577 /* Note that we use IT->current.pos, not it->current.string_pos,
6578 for displaying C strings. */
6579 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6580 if (it->multibyte_p)
6582 it->current.pos = c_string_pos (charpos, s, true);
6583 it->end_charpos = it->string_nchars = number_of_chars (s, true);
6585 else
6587 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6588 it->end_charpos = it->string_nchars = strlen (s);
6591 if (it->bidi_p)
6593 it->bidi_it.string.lstring = Qnil;
6594 it->bidi_it.string.s = (const unsigned char *) s;
6595 it->bidi_it.string.schars = it->end_charpos;
6596 it->bidi_it.string.bufpos = 0;
6597 it->bidi_it.string.from_disp_str = false;
6598 it->bidi_it.string.unibyte = !it->multibyte_p;
6599 it->bidi_it.w = it->w;
6600 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6601 &it->bidi_it);
6603 it->method = GET_FROM_C_STRING;
6606 /* PRECISION > 0 means don't return more than PRECISION characters
6607 from the string. */
6608 if (precision > 0 && it->end_charpos - charpos > precision)
6610 it->end_charpos = it->string_nchars = charpos + precision;
6611 if (it->bidi_p)
6612 it->bidi_it.string.schars = it->end_charpos;
6615 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6616 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6617 FIELD_WIDTH < 0 means infinite field width. This is useful for
6618 padding with `-' at the end of a mode line. */
6619 if (field_width < 0)
6620 field_width = INFINITY;
6621 /* Implementation note: We deliberately don't enlarge
6622 it->bidi_it.string.schars here to fit it->end_charpos, because
6623 the bidi iterator cannot produce characters out of thin air. */
6624 if (field_width > it->end_charpos - charpos)
6625 it->end_charpos = charpos + field_width;
6627 /* Use the standard display table for displaying strings. */
6628 if (DISP_TABLE_P (Vstandard_display_table))
6629 it->dp = XCHAR_TABLE (Vstandard_display_table);
6631 it->stop_charpos = charpos;
6632 it->prev_stop = charpos;
6633 it->base_level_stop = 0;
6634 if (it->bidi_p)
6636 it->bidi_it.first_elt = true;
6637 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6638 it->bidi_it.disp_pos = -1;
6640 if (s == NULL && it->multibyte_p)
6642 ptrdiff_t endpos = SCHARS (it->string);
6643 if (endpos > it->end_charpos)
6644 endpos = it->end_charpos;
6645 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6646 it->string);
6648 CHECK_IT (it);
6653 /***********************************************************************
6654 Iteration
6655 ***********************************************************************/
6657 /* Map enum it_method value to corresponding next_element_from_* function. */
6659 typedef bool (*next_element_function) (struct it *);
6661 static next_element_function const get_next_element[NUM_IT_METHODS] =
6663 next_element_from_buffer,
6664 next_element_from_display_vector,
6665 next_element_from_string,
6666 next_element_from_c_string,
6667 next_element_from_image,
6668 next_element_from_stretch
6671 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6674 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6675 (possibly with the following characters). */
6677 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6678 ((IT)->cmp_it.id >= 0 \
6679 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6680 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6681 END_CHARPOS, (IT)->w, \
6682 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6683 (IT)->string)))
6686 /* Lookup the char-table Vglyphless_char_display for character C (-1
6687 if we want information for no-font case), and return the display
6688 method symbol. By side-effect, update it->what and
6689 it->glyphless_method. This function is called from
6690 get_next_display_element for each character element, and from
6691 x_produce_glyphs when no suitable font was found. */
6693 Lisp_Object
6694 lookup_glyphless_char_display (int c, struct it *it)
6696 Lisp_Object glyphless_method = Qnil;
6698 if (CHAR_TABLE_P (Vglyphless_char_display)
6699 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6701 if (c >= 0)
6703 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6704 if (CONSP (glyphless_method))
6705 glyphless_method = FRAME_WINDOW_P (it->f)
6706 ? XCAR (glyphless_method)
6707 : XCDR (glyphless_method);
6709 else
6710 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6713 retry:
6714 if (NILP (glyphless_method))
6716 if (c >= 0)
6717 /* The default is to display the character by a proper font. */
6718 return Qnil;
6719 /* The default for the no-font case is to display an empty box. */
6720 glyphless_method = Qempty_box;
6722 if (EQ (glyphless_method, Qzero_width))
6724 if (c >= 0)
6725 return glyphless_method;
6726 /* This method can't be used for the no-font case. */
6727 glyphless_method = Qempty_box;
6729 if (EQ (glyphless_method, Qthin_space))
6730 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6731 else if (EQ (glyphless_method, Qempty_box))
6732 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6733 else if (EQ (glyphless_method, Qhex_code))
6734 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6735 else if (STRINGP (glyphless_method))
6736 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6737 else
6739 /* Invalid value. We use the default method. */
6740 glyphless_method = Qnil;
6741 goto retry;
6743 it->what = IT_GLYPHLESS;
6744 return glyphless_method;
6747 /* Merge escape glyph face and cache the result. */
6749 static struct frame *last_escape_glyph_frame = NULL;
6750 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6751 static int last_escape_glyph_merged_face_id = 0;
6753 static int
6754 merge_escape_glyph_face (struct it *it)
6756 int face_id;
6758 if (it->f == last_escape_glyph_frame
6759 && it->face_id == last_escape_glyph_face_id)
6760 face_id = last_escape_glyph_merged_face_id;
6761 else
6763 /* Merge the `escape-glyph' face into the current face. */
6764 face_id = merge_faces (it->f, Qescape_glyph, 0, it->face_id);
6765 last_escape_glyph_frame = it->f;
6766 last_escape_glyph_face_id = it->face_id;
6767 last_escape_glyph_merged_face_id = face_id;
6769 return face_id;
6772 /* Likewise for glyphless glyph face. */
6774 static struct frame *last_glyphless_glyph_frame = NULL;
6775 static int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6776 static int last_glyphless_glyph_merged_face_id = 0;
6779 merge_glyphless_glyph_face (struct it *it)
6781 int face_id;
6783 if (it->f == last_glyphless_glyph_frame
6784 && it->face_id == last_glyphless_glyph_face_id)
6785 face_id = last_glyphless_glyph_merged_face_id;
6786 else
6788 /* Merge the `glyphless-char' face into the current face. */
6789 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
6790 last_glyphless_glyph_frame = it->f;
6791 last_glyphless_glyph_face_id = it->face_id;
6792 last_glyphless_glyph_merged_face_id = face_id;
6794 return face_id;
6797 /* Load IT's display element fields with information about the next
6798 display element from the current position of IT. Value is false if
6799 end of buffer (or C string) is reached. */
6801 static bool
6802 get_next_display_element (struct it *it)
6804 /* True means that we found a display element. False means that
6805 we hit the end of what we iterate over. Performance note: the
6806 function pointer `method' used here turns out to be faster than
6807 using a sequence of if-statements. */
6808 bool success_p;
6810 get_next:
6811 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6813 if (it->what == IT_CHARACTER)
6815 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6816 and only if (a) the resolved directionality of that character
6817 is R..." */
6818 /* FIXME: Do we need an exception for characters from display
6819 tables? */
6820 if (it->bidi_p && it->bidi_it.type == STRONG_R
6821 && !inhibit_bidi_mirroring)
6822 it->c = bidi_mirror_char (it->c);
6823 /* Map via display table or translate control characters.
6824 IT->c, IT->len etc. have been set to the next character by
6825 the function call above. If we have a display table, and it
6826 contains an entry for IT->c, translate it. Don't do this if
6827 IT->c itself comes from a display table, otherwise we could
6828 end up in an infinite recursion. (An alternative could be to
6829 count the recursion depth of this function and signal an
6830 error when a certain maximum depth is reached.) Is it worth
6831 it? */
6832 if (success_p && it->dpvec == NULL)
6834 Lisp_Object dv;
6835 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6836 bool nonascii_space_p = false;
6837 bool nonascii_hyphen_p = false;
6838 int c = it->c; /* This is the character to display. */
6840 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6842 eassert (SINGLE_BYTE_CHAR_P (c));
6843 if (unibyte_display_via_language_environment)
6845 c = DECODE_CHAR (unibyte, c);
6846 if (c < 0)
6847 c = BYTE8_TO_CHAR (it->c);
6849 else
6850 c = BYTE8_TO_CHAR (it->c);
6853 if (it->dp
6854 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6855 VECTORP (dv)))
6857 struct Lisp_Vector *v = XVECTOR (dv);
6859 /* Return the first character from the display table
6860 entry, if not empty. If empty, don't display the
6861 current character. */
6862 if (v->header.size)
6864 it->dpvec_char_len = it->len;
6865 it->dpvec = v->contents;
6866 it->dpend = v->contents + v->header.size;
6867 it->current.dpvec_index = 0;
6868 it->dpvec_face_id = -1;
6869 it->saved_face_id = it->face_id;
6870 it->method = GET_FROM_DISPLAY_VECTOR;
6871 it->ellipsis_p = false;
6873 else
6875 set_iterator_to_next (it, false);
6877 goto get_next;
6880 if (! NILP (lookup_glyphless_char_display (c, it)))
6882 if (it->what == IT_GLYPHLESS)
6883 goto done;
6884 /* Don't display this character. */
6885 set_iterator_to_next (it, false);
6886 goto get_next;
6889 /* If `nobreak-char-display' is non-nil, we display
6890 non-ASCII spaces and hyphens specially. */
6891 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
6893 if (c == NO_BREAK_SPACE)
6894 nonascii_space_p = true;
6895 else if (c == SOFT_HYPHEN || c == HYPHEN
6896 || c == NON_BREAKING_HYPHEN)
6897 nonascii_hyphen_p = true;
6900 /* Translate control characters into `\003' or `^C' form.
6901 Control characters coming from a display table entry are
6902 currently not translated because we use IT->dpvec to hold
6903 the translation. This could easily be changed but I
6904 don't believe that it is worth doing.
6906 The characters handled by `nobreak-char-display' must be
6907 translated too.
6909 Non-printable characters and raw-byte characters are also
6910 translated to octal form. */
6911 if (((c < ' ' || c == 127) /* ASCII control chars. */
6912 ? (it->area != TEXT_AREA
6913 /* In mode line, treat \n, \t like other crl chars. */
6914 || (c != '\t'
6915 && it->glyph_row
6916 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
6917 || (c != '\n' && c != '\t'))
6918 : (nonascii_space_p
6919 || nonascii_hyphen_p
6920 || CHAR_BYTE8_P (c)
6921 || ! CHAR_PRINTABLE_P (c))))
6923 /* C is a control character, non-ASCII space/hyphen,
6924 raw-byte, or a non-printable character which must be
6925 displayed either as '\003' or as `^C' where the '\\'
6926 and '^' can be defined in the display table. Fill
6927 IT->ctl_chars with glyphs for what we have to
6928 display. Then, set IT->dpvec to these glyphs. */
6929 Lisp_Object gc;
6930 int ctl_len;
6931 int face_id;
6932 int lface_id = 0;
6933 int escape_glyph;
6935 /* Handle control characters with ^. */
6937 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
6939 int g;
6941 g = '^'; /* default glyph for Control */
6942 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6943 if (it->dp
6944 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
6946 g = GLYPH_CODE_CHAR (gc);
6947 lface_id = GLYPH_CODE_FACE (gc);
6950 face_id = (lface_id
6951 ? merge_faces (it->f, Qt, lface_id, it->face_id)
6952 : merge_escape_glyph_face (it));
6954 XSETINT (it->ctl_chars[0], g);
6955 XSETINT (it->ctl_chars[1], c ^ 0100);
6956 ctl_len = 2;
6957 goto display_control;
6960 /* Handle non-ascii space in the mode where it only gets
6961 highlighting. */
6963 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
6965 /* Merge `nobreak-space' into the current face. */
6966 face_id = merge_faces (it->f, Qnobreak_space, 0,
6967 it->face_id);
6968 XSETINT (it->ctl_chars[0], ' ');
6969 ctl_len = 1;
6970 goto display_control;
6973 /* Handle sequences that start with the "escape glyph". */
6975 /* the default escape glyph is \. */
6976 escape_glyph = '\\';
6978 if (it->dp
6979 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
6981 escape_glyph = GLYPH_CODE_CHAR (gc);
6982 lface_id = GLYPH_CODE_FACE (gc);
6985 face_id = (lface_id
6986 ? merge_faces (it->f, Qt, lface_id, it->face_id)
6987 : merge_escape_glyph_face (it));
6989 /* Draw non-ASCII hyphen with just highlighting: */
6991 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
6993 XSETINT (it->ctl_chars[0], '-');
6994 ctl_len = 1;
6995 goto display_control;
6998 /* Draw non-ASCII space/hyphen with escape glyph: */
7000 if (nonascii_space_p || nonascii_hyphen_p)
7002 XSETINT (it->ctl_chars[0], escape_glyph);
7003 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
7004 ctl_len = 2;
7005 goto display_control;
7009 char str[10];
7010 int len, i;
7012 if (CHAR_BYTE8_P (c))
7013 /* Display \200 instead of \17777600. */
7014 c = CHAR_TO_BYTE8 (c);
7015 len = sprintf (str, "%03o", c + 0u);
7017 XSETINT (it->ctl_chars[0], escape_glyph);
7018 for (i = 0; i < len; i++)
7019 XSETINT (it->ctl_chars[i + 1], str[i]);
7020 ctl_len = len + 1;
7023 display_control:
7024 /* Set up IT->dpvec and return first character from it. */
7025 it->dpvec_char_len = it->len;
7026 it->dpvec = it->ctl_chars;
7027 it->dpend = it->dpvec + ctl_len;
7028 it->current.dpvec_index = 0;
7029 it->dpvec_face_id = face_id;
7030 it->saved_face_id = it->face_id;
7031 it->method = GET_FROM_DISPLAY_VECTOR;
7032 it->ellipsis_p = false;
7033 goto get_next;
7035 it->char_to_display = c;
7037 else if (success_p)
7039 it->char_to_display = it->c;
7043 #ifdef HAVE_WINDOW_SYSTEM
7044 /* Adjust face id for a multibyte character. There are no multibyte
7045 character in unibyte text. */
7046 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
7047 && it->multibyte_p
7048 && success_p
7049 && FRAME_WINDOW_P (it->f))
7051 struct face *face = FACE_FROM_ID (it->f, it->face_id);
7053 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
7055 /* Automatic composition with glyph-string. */
7056 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
7058 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
7060 else
7062 ptrdiff_t pos = (it->s ? -1
7063 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
7064 : IT_CHARPOS (*it));
7065 int c;
7067 if (it->what == IT_CHARACTER)
7068 c = it->char_to_display;
7069 else
7071 struct composition *cmp = composition_table[it->cmp_it.id];
7072 int i;
7074 c = ' ';
7075 for (i = 0; i < cmp->glyph_len; i++)
7076 /* TAB in a composition means display glyphs with
7077 padding space on the left or right. */
7078 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
7079 break;
7081 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
7084 #endif /* HAVE_WINDOW_SYSTEM */
7086 done:
7087 /* Is this character the last one of a run of characters with
7088 box? If yes, set IT->end_of_box_run_p to true. */
7089 if (it->face_box_p
7090 && it->s == NULL)
7092 if (it->method == GET_FROM_STRING && it->sp)
7094 int face_id = underlying_face_id (it);
7095 struct face *face = FACE_FROM_ID (it->f, face_id);
7097 if (face)
7099 if (face->box == FACE_NO_BOX)
7101 /* If the box comes from face properties in a
7102 display string, check faces in that string. */
7103 int string_face_id = face_after_it_pos (it);
7104 it->end_of_box_run_p
7105 = (FACE_FROM_ID (it->f, string_face_id)->box
7106 == FACE_NO_BOX);
7108 /* Otherwise, the box comes from the underlying face.
7109 If this is the last string character displayed, check
7110 the next buffer location. */
7111 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
7112 /* n_overlay_strings is unreliable unless
7113 overlay_string_index is non-negative. */
7114 && ((it->current.overlay_string_index >= 0
7115 && (it->current.overlay_string_index
7116 == it->n_overlay_strings - 1))
7117 /* A string from display property. */
7118 || it->from_disp_prop_p))
7120 ptrdiff_t ignore;
7121 int next_face_id;
7122 struct text_pos pos = it->current.pos;
7124 /* For a string from a display property, the next
7125 buffer position is stored in the 'position'
7126 member of the iteration stack slot below the
7127 current one, see handle_single_display_spec. By
7128 contrast, it->current.pos was is not yet updated
7129 to point to that buffer position; that will
7130 happen in pop_it, after we finish displaying the
7131 current string. Note that we already checked
7132 above that it->sp is positive, so subtracting one
7133 from it is safe. */
7134 if (it->from_disp_prop_p)
7135 pos = (it->stack + it->sp - 1)->position;
7136 else
7137 INC_TEXT_POS (pos, it->multibyte_p);
7139 if (CHARPOS (pos) >= ZV)
7140 it->end_of_box_run_p = true;
7141 else
7143 next_face_id = face_at_buffer_position
7144 (it->w, CHARPOS (pos), &ignore,
7145 CHARPOS (pos) + TEXT_PROP_DISTANCE_LIMIT, false, -1);
7146 it->end_of_box_run_p
7147 = (FACE_FROM_ID (it->f, next_face_id)->box
7148 == FACE_NO_BOX);
7153 /* next_element_from_display_vector sets this flag according to
7154 faces of the display vector glyphs, see there. */
7155 else if (it->method != GET_FROM_DISPLAY_VECTOR)
7157 int face_id = face_after_it_pos (it);
7158 it->end_of_box_run_p
7159 = (face_id != it->face_id
7160 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
7163 /* If we reached the end of the object we've been iterating (e.g., a
7164 display string or an overlay string), and there's something on
7165 IT->stack, proceed with what's on the stack. It doesn't make
7166 sense to return false if there's unprocessed stuff on the stack,
7167 because otherwise that stuff will never be displayed. */
7168 if (!success_p && it->sp > 0)
7170 set_iterator_to_next (it, false);
7171 success_p = get_next_display_element (it);
7174 /* Value is false if end of buffer or string reached. */
7175 return success_p;
7179 /* Move IT to the next display element.
7181 RESEAT_P means if called on a newline in buffer text,
7182 skip to the next visible line start.
7184 Functions get_next_display_element and set_iterator_to_next are
7185 separate because I find this arrangement easier to handle than a
7186 get_next_display_element function that also increments IT's
7187 position. The way it is we can first look at an iterator's current
7188 display element, decide whether it fits on a line, and if it does,
7189 increment the iterator position. The other way around we probably
7190 would either need a flag indicating whether the iterator has to be
7191 incremented the next time, or we would have to implement a
7192 decrement position function which would not be easy to write. */
7194 void
7195 set_iterator_to_next (struct it *it, bool reseat_p)
7197 /* Reset flags indicating start and end of a sequence of characters
7198 with box. Reset them at the start of this function because
7199 moving the iterator to a new position might set them. */
7200 it->start_of_box_run_p = it->end_of_box_run_p = false;
7202 switch (it->method)
7204 case GET_FROM_BUFFER:
7205 /* The current display element of IT is a character from
7206 current_buffer. Advance in the buffer, and maybe skip over
7207 invisible lines that are so because of selective display. */
7208 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
7209 reseat_at_next_visible_line_start (it, false);
7210 else if (it->cmp_it.id >= 0)
7212 /* We are currently getting glyphs from a composition. */
7213 if (! it->bidi_p)
7215 IT_CHARPOS (*it) += it->cmp_it.nchars;
7216 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
7218 else
7220 int i;
7222 /* Update IT's char/byte positions to point to the first
7223 character of the next grapheme cluster, or to the
7224 character visually after the current composition. */
7225 for (i = 0; i < it->cmp_it.nchars; i++)
7226 bidi_move_to_visually_next (&it->bidi_it);
7227 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7228 IT_CHARPOS (*it) = it->bidi_it.charpos;
7231 if ((! it->bidi_p || ! it->cmp_it.reversed_p)
7232 && it->cmp_it.to < it->cmp_it.nglyphs)
7234 /* Composition created while scanning forward. Proceed
7235 to the next grapheme cluster. */
7236 it->cmp_it.from = it->cmp_it.to;
7238 else if ((it->bidi_p && it->cmp_it.reversed_p)
7239 && it->cmp_it.from > 0)
7241 /* Composition created while scanning backward. Proceed
7242 to the previous grapheme cluster. */
7243 it->cmp_it.to = it->cmp_it.from;
7245 else
7247 /* No more grapheme clusters in this composition.
7248 Find the next stop position. */
7249 ptrdiff_t stop = it->end_charpos;
7251 if (it->bidi_it.scan_dir < 0)
7252 /* Now we are scanning backward and don't know
7253 where to stop. */
7254 stop = -1;
7255 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7256 IT_BYTEPOS (*it), stop, Qnil);
7259 else
7261 eassert (it->len != 0);
7263 if (!it->bidi_p)
7265 IT_BYTEPOS (*it) += it->len;
7266 IT_CHARPOS (*it) += 1;
7268 else
7270 int prev_scan_dir = it->bidi_it.scan_dir;
7271 /* If this is a new paragraph, determine its base
7272 direction (a.k.a. its base embedding level). */
7273 if (it->bidi_it.new_paragraph)
7274 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it,
7275 false);
7276 bidi_move_to_visually_next (&it->bidi_it);
7277 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7278 IT_CHARPOS (*it) = it->bidi_it.charpos;
7279 if (prev_scan_dir != it->bidi_it.scan_dir)
7281 /* As the scan direction was changed, we must
7282 re-compute the stop position for composition. */
7283 ptrdiff_t stop = it->end_charpos;
7284 if (it->bidi_it.scan_dir < 0)
7285 stop = -1;
7286 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7287 IT_BYTEPOS (*it), stop, Qnil);
7290 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7292 break;
7294 case GET_FROM_C_STRING:
7295 /* Current display element of IT is from a C string. */
7296 if (!it->bidi_p
7297 /* If the string position is beyond string's end, it means
7298 next_element_from_c_string is padding the string with
7299 blanks, in which case we bypass the bidi iterator,
7300 because it cannot deal with such virtual characters. */
7301 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7303 IT_BYTEPOS (*it) += it->len;
7304 IT_CHARPOS (*it) += 1;
7306 else
7308 bidi_move_to_visually_next (&it->bidi_it);
7309 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7310 IT_CHARPOS (*it) = it->bidi_it.charpos;
7312 break;
7314 case GET_FROM_DISPLAY_VECTOR:
7315 /* Current display element of IT is from a display table entry.
7316 Advance in the display table definition. Reset it to null if
7317 end reached, and continue with characters from buffers/
7318 strings. */
7319 ++it->current.dpvec_index;
7321 /* Restore face of the iterator to what they were before the
7322 display vector entry (these entries may contain faces). */
7323 it->face_id = it->saved_face_id;
7325 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7327 bool recheck_faces = it->ellipsis_p;
7329 if (it->s)
7330 it->method = GET_FROM_C_STRING;
7331 else if (STRINGP (it->string))
7332 it->method = GET_FROM_STRING;
7333 else
7335 it->method = GET_FROM_BUFFER;
7336 it->object = it->w->contents;
7339 it->dpvec = NULL;
7340 it->current.dpvec_index = -1;
7342 /* Skip over characters which were displayed via IT->dpvec. */
7343 if (it->dpvec_char_len < 0)
7344 reseat_at_next_visible_line_start (it, true);
7345 else if (it->dpvec_char_len > 0)
7347 it->len = it->dpvec_char_len;
7348 set_iterator_to_next (it, reseat_p);
7351 /* Maybe recheck faces after display vector. */
7352 if (recheck_faces)
7354 if (it->method == GET_FROM_STRING)
7355 it->stop_charpos = IT_STRING_CHARPOS (*it);
7356 else
7357 it->stop_charpos = IT_CHARPOS (*it);
7360 break;
7362 case GET_FROM_STRING:
7363 /* Current display element is a character from a Lisp string. */
7364 eassert (it->s == NULL && STRINGP (it->string));
7365 /* Don't advance past string end. These conditions are true
7366 when set_iterator_to_next is called at the end of
7367 get_next_display_element, in which case the Lisp string is
7368 already exhausted, and all we want is pop the iterator
7369 stack. */
7370 if (it->current.overlay_string_index >= 0)
7372 /* This is an overlay string, so there's no padding with
7373 spaces, and the number of characters in the string is
7374 where the string ends. */
7375 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7376 goto consider_string_end;
7378 else
7380 /* Not an overlay string. There could be padding, so test
7381 against it->end_charpos. */
7382 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7383 goto consider_string_end;
7385 if (it->cmp_it.id >= 0)
7387 /* We are delivering display elements from a composition.
7388 Update the string position past the grapheme cluster
7389 we've just processed. */
7390 if (! it->bidi_p)
7392 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7393 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7395 else
7397 int i;
7399 for (i = 0; i < it->cmp_it.nchars; i++)
7400 bidi_move_to_visually_next (&it->bidi_it);
7401 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7402 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7405 /* Did we exhaust all the grapheme clusters of this
7406 composition? */
7407 if ((! it->bidi_p || ! it->cmp_it.reversed_p)
7408 && (it->cmp_it.to < it->cmp_it.nglyphs))
7410 /* Not all the grapheme clusters were processed yet;
7411 advance to the next cluster. */
7412 it->cmp_it.from = it->cmp_it.to;
7414 else if ((it->bidi_p && it->cmp_it.reversed_p)
7415 && it->cmp_it.from > 0)
7417 /* Likewise: advance to the next cluster, but going in
7418 the reverse direction. */
7419 it->cmp_it.to = it->cmp_it.from;
7421 else
7423 /* This composition was fully processed; find the next
7424 candidate place for checking for composed
7425 characters. */
7426 /* Always limit string searches to the string length;
7427 any padding spaces are not part of the string, and
7428 there cannot be any compositions in that padding. */
7429 ptrdiff_t stop = SCHARS (it->string);
7431 if (it->bidi_p && it->bidi_it.scan_dir < 0)
7432 stop = -1;
7433 else if (it->end_charpos < stop)
7435 /* Cf. PRECISION in reseat_to_string: we might be
7436 limited in how many of the string characters we
7437 need to deliver. */
7438 stop = it->end_charpos;
7440 composition_compute_stop_pos (&it->cmp_it,
7441 IT_STRING_CHARPOS (*it),
7442 IT_STRING_BYTEPOS (*it), stop,
7443 it->string);
7446 else
7448 if (!it->bidi_p
7449 /* If the string position is beyond string's end, it
7450 means next_element_from_string is padding the string
7451 with blanks, in which case we bypass the bidi
7452 iterator, because it cannot deal with such virtual
7453 characters. */
7454 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7456 IT_STRING_BYTEPOS (*it) += it->len;
7457 IT_STRING_CHARPOS (*it) += 1;
7459 else
7461 int prev_scan_dir = it->bidi_it.scan_dir;
7463 bidi_move_to_visually_next (&it->bidi_it);
7464 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7465 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7466 /* If the scan direction changes, we may need to update
7467 the place where to check for composed characters. */
7468 if (prev_scan_dir != it->bidi_it.scan_dir)
7470 ptrdiff_t stop = SCHARS (it->string);
7472 if (it->bidi_it.scan_dir < 0)
7473 stop = -1;
7474 else if (it->end_charpos < stop)
7475 stop = it->end_charpos;
7477 composition_compute_stop_pos (&it->cmp_it,
7478 IT_STRING_CHARPOS (*it),
7479 IT_STRING_BYTEPOS (*it), stop,
7480 it->string);
7485 consider_string_end:
7487 if (it->current.overlay_string_index >= 0)
7489 /* IT->string is an overlay string. Advance to the
7490 next, if there is one. */
7491 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7493 it->ellipsis_p = false;
7494 next_overlay_string (it);
7495 if (it->ellipsis_p)
7496 setup_for_ellipsis (it, 0);
7499 else
7501 /* IT->string is not an overlay string. If we reached
7502 its end, and there is something on IT->stack, proceed
7503 with what is on the stack. This can be either another
7504 string, this time an overlay string, or a buffer. */
7505 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7506 && it->sp > 0)
7508 pop_it (it);
7509 if (it->method == GET_FROM_STRING)
7510 goto consider_string_end;
7513 break;
7515 case GET_FROM_IMAGE:
7516 case GET_FROM_STRETCH:
7517 /* The position etc with which we have to proceed are on
7518 the stack. The position may be at the end of a string,
7519 if the `display' property takes up the whole string. */
7520 eassert (it->sp > 0);
7521 pop_it (it);
7522 if (it->method == GET_FROM_STRING)
7523 goto consider_string_end;
7524 break;
7526 default:
7527 /* There are no other methods defined, so this should be a bug. */
7528 emacs_abort ();
7531 eassert (it->method != GET_FROM_STRING
7532 || (STRINGP (it->string)
7533 && IT_STRING_CHARPOS (*it) >= 0));
7536 /* Load IT's display element fields with information about the next
7537 display element which comes from a display table entry or from the
7538 result of translating a control character to one of the forms `^C'
7539 or `\003'.
7541 IT->dpvec holds the glyphs to return as characters.
7542 IT->saved_face_id holds the face id before the display vector--it
7543 is restored into IT->face_id in set_iterator_to_next. */
7545 static bool
7546 next_element_from_display_vector (struct it *it)
7548 Lisp_Object gc;
7549 int prev_face_id = it->face_id;
7550 int next_face_id;
7552 /* Precondition. */
7553 eassert (it->dpvec && it->current.dpvec_index >= 0);
7555 it->face_id = it->saved_face_id;
7557 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7558 That seemed totally bogus - so I changed it... */
7559 gc = it->dpvec[it->current.dpvec_index];
7561 if (GLYPH_CODE_P (gc))
7563 struct face *this_face, *prev_face, *next_face;
7565 it->c = GLYPH_CODE_CHAR (gc);
7566 it->len = CHAR_BYTES (it->c);
7568 /* The entry may contain a face id to use. Such a face id is
7569 the id of a Lisp face, not a realized face. A face id of
7570 zero means no face is specified. */
7571 if (it->dpvec_face_id >= 0)
7572 it->face_id = it->dpvec_face_id;
7573 else
7575 int lface_id = GLYPH_CODE_FACE (gc);
7576 if (lface_id > 0)
7577 it->face_id = merge_faces (it->f, Qt, lface_id,
7578 it->saved_face_id);
7581 /* Glyphs in the display vector could have the box face, so we
7582 need to set the related flags in the iterator, as
7583 appropriate. */
7584 this_face = FACE_FROM_ID (it->f, it->face_id);
7585 prev_face = FACE_FROM_ID (it->f, prev_face_id);
7587 /* Is this character the first character of a box-face run? */
7588 it->start_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7589 && (!prev_face
7590 || prev_face->box == FACE_NO_BOX));
7592 /* For the last character of the box-face run, we need to look
7593 either at the next glyph from the display vector, or at the
7594 face we saw before the display vector. */
7595 next_face_id = it->saved_face_id;
7596 if (it->current.dpvec_index < it->dpend - it->dpvec - 1)
7598 if (it->dpvec_face_id >= 0)
7599 next_face_id = it->dpvec_face_id;
7600 else
7602 int lface_id =
7603 GLYPH_CODE_FACE (it->dpvec[it->current.dpvec_index + 1]);
7605 if (lface_id > 0)
7606 next_face_id = merge_faces (it->f, Qt, lface_id,
7607 it->saved_face_id);
7610 next_face = FACE_FROM_ID (it->f, next_face_id);
7611 it->end_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7612 && (!next_face
7613 || next_face->box == FACE_NO_BOX));
7614 it->face_box_p = this_face && this_face->box != FACE_NO_BOX;
7616 else
7617 /* Display table entry is invalid. Return a space. */
7618 it->c = ' ', it->len = 1;
7620 /* Don't change position and object of the iterator here. They are
7621 still the values of the character that had this display table
7622 entry or was translated, and that's what we want. */
7623 it->what = IT_CHARACTER;
7624 return true;
7627 /* Get the first element of string/buffer in the visual order, after
7628 being reseated to a new position in a string or a buffer. */
7629 static void
7630 get_visually_first_element (struct it *it)
7632 bool string_p = STRINGP (it->string) || it->s;
7633 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7634 ptrdiff_t bob = (string_p ? 0 : BEGV);
7636 if (STRINGP (it->string))
7638 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7639 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7641 else
7643 it->bidi_it.charpos = IT_CHARPOS (*it);
7644 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7647 if (it->bidi_it.charpos == eob)
7649 /* Nothing to do, but reset the FIRST_ELT flag, like
7650 bidi_paragraph_init does, because we are not going to
7651 call it. */
7652 it->bidi_it.first_elt = false;
7654 else if (it->bidi_it.charpos == bob
7655 || (!string_p
7656 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7657 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7659 /* If we are at the beginning of a line/string, we can produce
7660 the next element right away. */
7661 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
7662 bidi_move_to_visually_next (&it->bidi_it);
7664 else
7666 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7668 /* We need to prime the bidi iterator starting at the line's or
7669 string's beginning, before we will be able to produce the
7670 next element. */
7671 if (string_p)
7672 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7673 else
7674 it->bidi_it.charpos = find_newline_no_quit (IT_CHARPOS (*it),
7675 IT_BYTEPOS (*it), -1,
7676 &it->bidi_it.bytepos);
7677 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
7680 /* Now return to buffer/string position where we were asked
7681 to get the next display element, and produce that. */
7682 bidi_move_to_visually_next (&it->bidi_it);
7684 while (it->bidi_it.bytepos != orig_bytepos
7685 && it->bidi_it.charpos < eob);
7688 /* Adjust IT's position information to where we ended up. */
7689 if (STRINGP (it->string))
7691 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7692 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7694 else
7696 IT_CHARPOS (*it) = it->bidi_it.charpos;
7697 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7700 if (STRINGP (it->string) || !it->s)
7702 ptrdiff_t stop, charpos, bytepos;
7704 if (STRINGP (it->string))
7706 eassert (!it->s);
7707 stop = SCHARS (it->string);
7708 if (stop > it->end_charpos)
7709 stop = it->end_charpos;
7710 charpos = IT_STRING_CHARPOS (*it);
7711 bytepos = IT_STRING_BYTEPOS (*it);
7713 else
7715 stop = it->end_charpos;
7716 charpos = IT_CHARPOS (*it);
7717 bytepos = IT_BYTEPOS (*it);
7719 if (it->bidi_it.scan_dir < 0)
7720 stop = -1;
7721 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7722 it->string);
7726 /* Load IT with the next display element from Lisp string IT->string.
7727 IT->current.string_pos is the current position within the string.
7728 If IT->current.overlay_string_index >= 0, the Lisp string is an
7729 overlay string. */
7731 static bool
7732 next_element_from_string (struct it *it)
7734 struct text_pos position;
7736 eassert (STRINGP (it->string));
7737 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7738 eassert (IT_STRING_CHARPOS (*it) >= 0);
7739 position = it->current.string_pos;
7741 /* With bidi reordering, the character to display might not be the
7742 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7743 that we were reseat()ed to a new string, whose paragraph
7744 direction is not known. */
7745 if (it->bidi_p && it->bidi_it.first_elt)
7747 get_visually_first_element (it);
7748 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7751 /* Time to check for invisible text? */
7752 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7754 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7756 if (!(!it->bidi_p
7757 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7758 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7760 /* With bidi non-linear iteration, we could find
7761 ourselves far beyond the last computed stop_charpos,
7762 with several other stop positions in between that we
7763 missed. Scan them all now, in buffer's logical
7764 order, until we find and handle the last stop_charpos
7765 that precedes our current position. */
7766 handle_stop_backwards (it, it->stop_charpos);
7767 return GET_NEXT_DISPLAY_ELEMENT (it);
7769 else
7771 if (it->bidi_p)
7773 /* Take note of the stop position we just moved
7774 across, for when we will move back across it. */
7775 it->prev_stop = it->stop_charpos;
7776 /* If we are at base paragraph embedding level, take
7777 note of the last stop position seen at this
7778 level. */
7779 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7780 it->base_level_stop = it->stop_charpos;
7782 handle_stop (it);
7784 /* Since a handler may have changed IT->method, we must
7785 recurse here. */
7786 return GET_NEXT_DISPLAY_ELEMENT (it);
7789 else if (it->bidi_p
7790 /* If we are before prev_stop, we may have overstepped
7791 on our way backwards a stop_pos, and if so, we need
7792 to handle that stop_pos. */
7793 && IT_STRING_CHARPOS (*it) < it->prev_stop
7794 /* We can sometimes back up for reasons that have nothing
7795 to do with bidi reordering. E.g., compositions. The
7796 code below is only needed when we are above the base
7797 embedding level, so test for that explicitly. */
7798 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7800 /* If we lost track of base_level_stop, we have no better
7801 place for handle_stop_backwards to start from than string
7802 beginning. This happens, e.g., when we were reseated to
7803 the previous screenful of text by vertical-motion. */
7804 if (it->base_level_stop <= 0
7805 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7806 it->base_level_stop = 0;
7807 handle_stop_backwards (it, it->base_level_stop);
7808 return GET_NEXT_DISPLAY_ELEMENT (it);
7812 if (it->current.overlay_string_index >= 0)
7814 /* Get the next character from an overlay string. In overlay
7815 strings, there is no field width or padding with spaces to
7816 do. */
7817 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7819 it->what = IT_EOB;
7820 return false;
7822 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7823 IT_STRING_BYTEPOS (*it),
7824 it->bidi_it.scan_dir < 0
7825 ? -1
7826 : SCHARS (it->string))
7827 && next_element_from_composition (it))
7829 return true;
7831 else if (STRING_MULTIBYTE (it->string))
7833 const unsigned char *s = (SDATA (it->string)
7834 + IT_STRING_BYTEPOS (*it));
7835 it->c = string_char_and_length (s, &it->len);
7837 else
7839 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7840 it->len = 1;
7843 else
7845 /* Get the next character from a Lisp string that is not an
7846 overlay string. Such strings come from the mode line, for
7847 example. We may have to pad with spaces, or truncate the
7848 string. See also next_element_from_c_string. */
7849 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7851 it->what = IT_EOB;
7852 return false;
7854 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
7856 /* Pad with spaces. */
7857 it->c = ' ', it->len = 1;
7858 CHARPOS (position) = BYTEPOS (position) = -1;
7860 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7861 IT_STRING_BYTEPOS (*it),
7862 it->bidi_it.scan_dir < 0
7863 ? -1
7864 : it->string_nchars)
7865 && next_element_from_composition (it))
7867 return true;
7869 else if (STRING_MULTIBYTE (it->string))
7871 const unsigned char *s = (SDATA (it->string)
7872 + IT_STRING_BYTEPOS (*it));
7873 it->c = string_char_and_length (s, &it->len);
7875 else
7877 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7878 it->len = 1;
7882 /* Record what we have and where it came from. */
7883 it->what = IT_CHARACTER;
7884 it->object = it->string;
7885 it->position = position;
7886 return true;
7890 /* Load IT with next display element from C string IT->s.
7891 IT->string_nchars is the maximum number of characters to return
7892 from the string. IT->end_charpos may be greater than
7893 IT->string_nchars when this function is called, in which case we
7894 may have to return padding spaces. Value is false if end of string
7895 reached, including padding spaces. */
7897 static bool
7898 next_element_from_c_string (struct it *it)
7900 bool success_p = true;
7902 eassert (it->s);
7903 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
7904 it->what = IT_CHARACTER;
7905 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
7906 it->object = make_number (0);
7908 /* With bidi reordering, the character to display might not be the
7909 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7910 we were reseated to a new string, whose paragraph direction is
7911 not known. */
7912 if (it->bidi_p && it->bidi_it.first_elt)
7913 get_visually_first_element (it);
7915 /* IT's position can be greater than IT->string_nchars in case a
7916 field width or precision has been specified when the iterator was
7917 initialized. */
7918 if (IT_CHARPOS (*it) >= it->end_charpos)
7920 /* End of the game. */
7921 it->what = IT_EOB;
7922 success_p = false;
7924 else if (IT_CHARPOS (*it) >= it->string_nchars)
7926 /* Pad with spaces. */
7927 it->c = ' ', it->len = 1;
7928 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
7930 else if (it->multibyte_p)
7931 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
7932 else
7933 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
7935 return success_p;
7939 /* Set up IT to return characters from an ellipsis, if appropriate.
7940 The definition of the ellipsis glyphs may come from a display table
7941 entry. This function fills IT with the first glyph from the
7942 ellipsis if an ellipsis is to be displayed. */
7944 static bool
7945 next_element_from_ellipsis (struct it *it)
7947 if (it->selective_display_ellipsis_p)
7948 setup_for_ellipsis (it, it->len);
7949 else
7951 /* The face at the current position may be different from the
7952 face we find after the invisible text. Remember what it
7953 was in IT->saved_face_id, and signal that it's there by
7954 setting face_before_selective_p. */
7955 it->saved_face_id = it->face_id;
7956 it->method = GET_FROM_BUFFER;
7957 it->object = it->w->contents;
7958 reseat_at_next_visible_line_start (it, true);
7959 it->face_before_selective_p = true;
7962 return GET_NEXT_DISPLAY_ELEMENT (it);
7966 /* Deliver an image display element. The iterator IT is already
7967 filled with image information (done in handle_display_prop). Value
7968 is always true. */
7971 static bool
7972 next_element_from_image (struct it *it)
7974 it->what = IT_IMAGE;
7975 return true;
7979 /* Fill iterator IT with next display element from a stretch glyph
7980 property. IT->object is the value of the text property. Value is
7981 always true. */
7983 static bool
7984 next_element_from_stretch (struct it *it)
7986 it->what = IT_STRETCH;
7987 return true;
7990 /* Scan backwards from IT's current position until we find a stop
7991 position, or until BEGV. This is called when we find ourself
7992 before both the last known prev_stop and base_level_stop while
7993 reordering bidirectional text. */
7995 static void
7996 compute_stop_pos_backwards (struct it *it)
7998 const int SCAN_BACK_LIMIT = 1000;
7999 struct text_pos pos;
8000 struct display_pos save_current = it->current;
8001 struct text_pos save_position = it->position;
8002 ptrdiff_t charpos = IT_CHARPOS (*it);
8003 ptrdiff_t where_we_are = charpos;
8004 ptrdiff_t save_stop_pos = it->stop_charpos;
8005 ptrdiff_t save_end_pos = it->end_charpos;
8007 eassert (NILP (it->string) && !it->s);
8008 eassert (it->bidi_p);
8009 it->bidi_p = false;
8012 it->end_charpos = min (charpos + 1, ZV);
8013 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
8014 SET_TEXT_POS (pos, charpos, CHAR_TO_BYTE (charpos));
8015 reseat_1 (it, pos, false);
8016 compute_stop_pos (it);
8017 /* We must advance forward, right? */
8018 if (it->stop_charpos <= charpos)
8019 emacs_abort ();
8021 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
8023 if (it->stop_charpos <= where_we_are)
8024 it->prev_stop = it->stop_charpos;
8025 else
8026 it->prev_stop = BEGV;
8027 it->bidi_p = true;
8028 it->current = save_current;
8029 it->position = save_position;
8030 it->stop_charpos = save_stop_pos;
8031 it->end_charpos = save_end_pos;
8034 /* Scan forward from CHARPOS in the current buffer/string, until we
8035 find a stop position > current IT's position. Then handle the stop
8036 position before that. This is called when we bump into a stop
8037 position while reordering bidirectional text. CHARPOS should be
8038 the last previously processed stop_pos (or BEGV/0, if none were
8039 processed yet) whose position is less that IT's current
8040 position. */
8042 static void
8043 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
8045 bool bufp = !STRINGP (it->string);
8046 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
8047 struct display_pos save_current = it->current;
8048 struct text_pos save_position = it->position;
8049 struct text_pos pos1;
8050 ptrdiff_t next_stop;
8052 /* Scan in strict logical order. */
8053 eassert (it->bidi_p);
8054 it->bidi_p = false;
8057 it->prev_stop = charpos;
8058 if (bufp)
8060 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
8061 reseat_1 (it, pos1, false);
8063 else
8064 it->current.string_pos = string_pos (charpos, it->string);
8065 compute_stop_pos (it);
8066 /* We must advance forward, right? */
8067 if (it->stop_charpos <= it->prev_stop)
8068 emacs_abort ();
8069 charpos = it->stop_charpos;
8071 while (charpos <= where_we_are);
8073 it->bidi_p = true;
8074 it->current = save_current;
8075 it->position = save_position;
8076 next_stop = it->stop_charpos;
8077 it->stop_charpos = it->prev_stop;
8078 handle_stop (it);
8079 it->stop_charpos = next_stop;
8082 /* Load IT with the next display element from current_buffer. Value
8083 is false if end of buffer reached. IT->stop_charpos is the next
8084 position at which to stop and check for text properties or buffer
8085 end. */
8087 static bool
8088 next_element_from_buffer (struct it *it)
8090 bool success_p = true;
8092 eassert (IT_CHARPOS (*it) >= BEGV);
8093 eassert (NILP (it->string) && !it->s);
8094 eassert (!it->bidi_p
8095 || (EQ (it->bidi_it.string.lstring, Qnil)
8096 && it->bidi_it.string.s == NULL));
8098 /* With bidi reordering, the character to display might not be the
8099 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8100 we were reseat()ed to a new buffer position, which is potentially
8101 a different paragraph. */
8102 if (it->bidi_p && it->bidi_it.first_elt)
8104 get_visually_first_element (it);
8105 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8108 if (IT_CHARPOS (*it) >= it->stop_charpos)
8110 if (IT_CHARPOS (*it) >= it->end_charpos)
8112 bool overlay_strings_follow_p;
8114 /* End of the game, except when overlay strings follow that
8115 haven't been returned yet. */
8116 if (it->overlay_strings_at_end_processed_p)
8117 overlay_strings_follow_p = false;
8118 else
8120 it->overlay_strings_at_end_processed_p = true;
8121 overlay_strings_follow_p = get_overlay_strings (it, 0);
8124 if (overlay_strings_follow_p)
8125 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
8126 else
8128 it->what = IT_EOB;
8129 it->position = it->current.pos;
8130 success_p = false;
8133 else if (!(!it->bidi_p
8134 || BIDI_AT_BASE_LEVEL (it->bidi_it)
8135 || IT_CHARPOS (*it) == it->stop_charpos))
8137 /* With bidi non-linear iteration, we could find ourselves
8138 far beyond the last computed stop_charpos, with several
8139 other stop positions in between that we missed. Scan
8140 them all now, in buffer's logical order, until we find
8141 and handle the last stop_charpos that precedes our
8142 current position. */
8143 handle_stop_backwards (it, it->stop_charpos);
8144 it->ignore_overlay_strings_at_pos_p = false;
8145 return GET_NEXT_DISPLAY_ELEMENT (it);
8147 else
8149 if (it->bidi_p)
8151 /* Take note of the stop position we just moved across,
8152 for when we will move back across it. */
8153 it->prev_stop = it->stop_charpos;
8154 /* If we are at base paragraph embedding level, take
8155 note of the last stop position seen at this
8156 level. */
8157 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
8158 it->base_level_stop = it->stop_charpos;
8160 handle_stop (it);
8161 it->ignore_overlay_strings_at_pos_p = false;
8162 return GET_NEXT_DISPLAY_ELEMENT (it);
8165 else if (it->bidi_p
8166 /* If we are before prev_stop, we may have overstepped on
8167 our way backwards a stop_pos, and if so, we need to
8168 handle that stop_pos. */
8169 && IT_CHARPOS (*it) < it->prev_stop
8170 /* We can sometimes back up for reasons that have nothing
8171 to do with bidi reordering. E.g., compositions. The
8172 code below is only needed when we are above the base
8173 embedding level, so test for that explicitly. */
8174 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
8176 if (it->base_level_stop <= 0
8177 || IT_CHARPOS (*it) < it->base_level_stop)
8179 /* If we lost track of base_level_stop, we need to find
8180 prev_stop by looking backwards. This happens, e.g., when
8181 we were reseated to the previous screenful of text by
8182 vertical-motion. */
8183 it->base_level_stop = BEGV;
8184 compute_stop_pos_backwards (it);
8185 handle_stop_backwards (it, it->prev_stop);
8187 else
8188 handle_stop_backwards (it, it->base_level_stop);
8189 it->ignore_overlay_strings_at_pos_p = false;
8190 return GET_NEXT_DISPLAY_ELEMENT (it);
8192 else
8194 /* No face changes, overlays etc. in sight, so just return a
8195 character from current_buffer. */
8196 unsigned char *p;
8197 ptrdiff_t stop;
8199 /* We moved to the next buffer position, so any info about
8200 previously seen overlays is no longer valid. */
8201 it->ignore_overlay_strings_at_pos_p = false;
8203 /* Maybe run the redisplay end trigger hook. Performance note:
8204 This doesn't seem to cost measurable time. */
8205 if (it->redisplay_end_trigger_charpos
8206 && it->glyph_row
8207 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
8208 run_redisplay_end_trigger_hook (it);
8210 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
8211 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
8212 stop)
8213 && next_element_from_composition (it))
8215 return true;
8218 /* Get the next character, maybe multibyte. */
8219 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
8220 if (it->multibyte_p && !ASCII_CHAR_P (*p))
8221 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
8222 else
8223 it->c = *p, it->len = 1;
8225 /* Record what we have and where it came from. */
8226 it->what = IT_CHARACTER;
8227 it->object = it->w->contents;
8228 it->position = it->current.pos;
8230 /* Normally we return the character found above, except when we
8231 really want to return an ellipsis for selective display. */
8232 if (it->selective)
8234 if (it->c == '\n')
8236 /* A value of selective > 0 means hide lines indented more
8237 than that number of columns. */
8238 if (it->selective > 0
8239 && IT_CHARPOS (*it) + 1 < ZV
8240 && indented_beyond_p (IT_CHARPOS (*it) + 1,
8241 IT_BYTEPOS (*it) + 1,
8242 it->selective))
8244 success_p = next_element_from_ellipsis (it);
8245 it->dpvec_char_len = -1;
8248 else if (it->c == '\r' && it->selective == -1)
8250 /* A value of selective == -1 means that everything from the
8251 CR to the end of the line is invisible, with maybe an
8252 ellipsis displayed for it. */
8253 success_p = next_element_from_ellipsis (it);
8254 it->dpvec_char_len = -1;
8259 /* Value is false if end of buffer reached. */
8260 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8261 return success_p;
8265 /* Run the redisplay end trigger hook for IT. */
8267 static void
8268 run_redisplay_end_trigger_hook (struct it *it)
8270 /* IT->glyph_row should be non-null, i.e. we should be actually
8271 displaying something, or otherwise we should not run the hook. */
8272 eassert (it->glyph_row);
8274 ptrdiff_t charpos = it->redisplay_end_trigger_charpos;
8275 it->redisplay_end_trigger_charpos = 0;
8277 /* Since we are *trying* to run these functions, don't try to run
8278 them again, even if they get an error. */
8279 wset_redisplay_end_trigger (it->w, Qnil);
8280 CALLN (Frun_hook_with_args, Qredisplay_end_trigger_functions, it->window,
8281 make_number (charpos));
8283 /* Notice if it changed the face of the character we are on. */
8284 handle_face_prop (it);
8288 /* Deliver a composition display element. Unlike the other
8289 next_element_from_XXX, this function is not registered in the array
8290 get_next_element[]. It is called from next_element_from_buffer and
8291 next_element_from_string when necessary. */
8293 static bool
8294 next_element_from_composition (struct it *it)
8296 it->what = IT_COMPOSITION;
8297 it->len = it->cmp_it.nbytes;
8298 if (STRINGP (it->string))
8300 if (it->c < 0)
8302 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8303 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8304 return false;
8306 it->position = it->current.string_pos;
8307 it->object = it->string;
8308 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8309 IT_STRING_BYTEPOS (*it), it->string);
8311 else
8313 if (it->c < 0)
8315 IT_CHARPOS (*it) += it->cmp_it.nchars;
8316 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8317 if (it->bidi_p)
8319 if (it->bidi_it.new_paragraph)
8320 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it,
8321 false);
8322 /* Resync the bidi iterator with IT's new position.
8323 FIXME: this doesn't support bidirectional text. */
8324 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8325 bidi_move_to_visually_next (&it->bidi_it);
8327 return false;
8329 it->position = it->current.pos;
8330 it->object = it->w->contents;
8331 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8332 IT_BYTEPOS (*it), Qnil);
8334 return true;
8339 /***********************************************************************
8340 Moving an iterator without producing glyphs
8341 ***********************************************************************/
8343 /* Check if iterator is at a position corresponding to a valid buffer
8344 position after some move_it_ call. */
8346 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8347 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8350 /* Move iterator IT to a specified buffer or X position within one
8351 line on the display without producing glyphs.
8353 OP should be a bit mask including some or all of these bits:
8354 MOVE_TO_X: Stop upon reaching x-position TO_X.
8355 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8356 Regardless of OP's value, stop upon reaching the end of the display line.
8358 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8359 This means, in particular, that TO_X includes window's horizontal
8360 scroll amount.
8362 The return value has several possible values that
8363 say what condition caused the scan to stop:
8365 MOVE_POS_MATCH_OR_ZV
8366 - when TO_POS or ZV was reached.
8368 MOVE_X_REACHED
8369 -when TO_X was reached before TO_POS or ZV were reached.
8371 MOVE_LINE_CONTINUED
8372 - when we reached the end of the display area and the line must
8373 be continued.
8375 MOVE_LINE_TRUNCATED
8376 - when we reached the end of the display area and the line is
8377 truncated.
8379 MOVE_NEWLINE_OR_CR
8380 - when we stopped at a line end, i.e. a newline or a CR and selective
8381 display is on. */
8383 static enum move_it_result
8384 move_it_in_display_line_to (struct it *it,
8385 ptrdiff_t to_charpos, int to_x,
8386 enum move_operation_enum op)
8388 enum move_it_result result = MOVE_UNDEFINED;
8389 struct glyph_row *saved_glyph_row;
8390 struct it wrap_it, atpos_it, atx_it, ppos_it;
8391 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8392 void *ppos_data = NULL;
8393 bool may_wrap = false;
8394 enum it_method prev_method = it->method;
8395 ptrdiff_t closest_pos IF_LINT (= 0), prev_pos = IT_CHARPOS (*it);
8396 bool saw_smaller_pos = prev_pos < to_charpos;
8398 /* Don't produce glyphs in produce_glyphs. */
8399 saved_glyph_row = it->glyph_row;
8400 it->glyph_row = NULL;
8402 /* Use wrap_it to save a copy of IT wherever a word wrap could
8403 occur. Use atpos_it to save a copy of IT at the desired buffer
8404 position, if found, so that we can scan ahead and check if the
8405 word later overshoots the window edge. Use atx_it similarly, for
8406 pixel positions. */
8407 wrap_it.sp = -1;
8408 atpos_it.sp = -1;
8409 atx_it.sp = -1;
8411 /* Use ppos_it under bidi reordering to save a copy of IT for the
8412 initial position. We restore that position in IT when we have
8413 scanned the entire display line without finding a match for
8414 TO_CHARPOS and all the character positions are greater than
8415 TO_CHARPOS. We then restart the scan from the initial position,
8416 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8417 the closest to TO_CHARPOS. */
8418 if (it->bidi_p)
8420 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8422 SAVE_IT (ppos_it, *it, ppos_data);
8423 closest_pos = IT_CHARPOS (*it);
8425 else
8426 closest_pos = ZV;
8429 #define BUFFER_POS_REACHED_P() \
8430 ((op & MOVE_TO_POS) != 0 \
8431 && BUFFERP (it->object) \
8432 && (IT_CHARPOS (*it) == to_charpos \
8433 || ((!it->bidi_p \
8434 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8435 && IT_CHARPOS (*it) > to_charpos) \
8436 || (it->what == IT_COMPOSITION \
8437 && ((IT_CHARPOS (*it) > to_charpos \
8438 && to_charpos >= it->cmp_it.charpos) \
8439 || (IT_CHARPOS (*it) < to_charpos \
8440 && to_charpos <= it->cmp_it.charpos)))) \
8441 && (it->method == GET_FROM_BUFFER \
8442 || (it->method == GET_FROM_DISPLAY_VECTOR \
8443 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8445 /* If there's a line-/wrap-prefix, handle it. */
8446 if (it->hpos == 0 && it->method == GET_FROM_BUFFER
8447 && it->current_y < it->last_visible_y)
8448 handle_line_prefix (it);
8450 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8451 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8453 while (true)
8455 int x, i, ascent = 0, descent = 0;
8457 /* Utility macro to reset an iterator with x, ascent, and descent. */
8458 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8459 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8460 (IT)->max_descent = descent)
8462 /* Stop if we move beyond TO_CHARPOS (after an image or a
8463 display string or stretch glyph). */
8464 if ((op & MOVE_TO_POS) != 0
8465 && BUFFERP (it->object)
8466 && it->method == GET_FROM_BUFFER
8467 && (((!it->bidi_p
8468 /* When the iterator is at base embedding level, we
8469 are guaranteed that characters are delivered for
8470 display in strictly increasing order of their
8471 buffer positions. */
8472 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8473 && IT_CHARPOS (*it) > to_charpos)
8474 || (it->bidi_p
8475 && (prev_method == GET_FROM_IMAGE
8476 || prev_method == GET_FROM_STRETCH
8477 || prev_method == GET_FROM_STRING)
8478 /* Passed TO_CHARPOS from left to right. */
8479 && ((prev_pos < to_charpos
8480 && IT_CHARPOS (*it) > to_charpos)
8481 /* Passed TO_CHARPOS from right to left. */
8482 || (prev_pos > to_charpos
8483 && IT_CHARPOS (*it) < to_charpos)))))
8485 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8487 result = MOVE_POS_MATCH_OR_ZV;
8488 break;
8490 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8491 /* If wrap_it is valid, the current position might be in a
8492 word that is wrapped. So, save the iterator in
8493 atpos_it and continue to see if wrapping happens. */
8494 SAVE_IT (atpos_it, *it, atpos_data);
8497 /* Stop when ZV reached.
8498 We used to stop here when TO_CHARPOS reached as well, but that is
8499 too soon if this glyph does not fit on this line. So we handle it
8500 explicitly below. */
8501 if (!get_next_display_element (it))
8503 result = MOVE_POS_MATCH_OR_ZV;
8504 break;
8507 if (it->line_wrap == TRUNCATE)
8509 if (BUFFER_POS_REACHED_P ())
8511 result = MOVE_POS_MATCH_OR_ZV;
8512 break;
8515 else
8517 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
8519 if (IT_DISPLAYING_WHITESPACE (it))
8520 may_wrap = true;
8521 else if (may_wrap)
8523 /* We have reached a glyph that follows one or more
8524 whitespace characters. If the position is
8525 already found, we are done. */
8526 if (atpos_it.sp >= 0)
8528 RESTORE_IT (it, &atpos_it, atpos_data);
8529 result = MOVE_POS_MATCH_OR_ZV;
8530 goto done;
8532 if (atx_it.sp >= 0)
8534 RESTORE_IT (it, &atx_it, atx_data);
8535 result = MOVE_X_REACHED;
8536 goto done;
8538 /* Otherwise, we can wrap here. */
8539 SAVE_IT (wrap_it, *it, wrap_data);
8540 may_wrap = false;
8545 /* Remember the line height for the current line, in case
8546 the next element doesn't fit on the line. */
8547 ascent = it->max_ascent;
8548 descent = it->max_descent;
8550 /* The call to produce_glyphs will get the metrics of the
8551 display element IT is loaded with. Record the x-position
8552 before this display element, in case it doesn't fit on the
8553 line. */
8554 x = it->current_x;
8556 PRODUCE_GLYPHS (it);
8558 if (it->area != TEXT_AREA)
8560 prev_method = it->method;
8561 if (it->method == GET_FROM_BUFFER)
8562 prev_pos = IT_CHARPOS (*it);
8563 set_iterator_to_next (it, true);
8564 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8565 SET_TEXT_POS (this_line_min_pos,
8566 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8567 if (it->bidi_p
8568 && (op & MOVE_TO_POS)
8569 && IT_CHARPOS (*it) > to_charpos
8570 && IT_CHARPOS (*it) < closest_pos)
8571 closest_pos = IT_CHARPOS (*it);
8572 continue;
8575 /* The number of glyphs we get back in IT->nglyphs will normally
8576 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8577 character on a terminal frame, or (iii) a line end. For the
8578 second case, IT->nglyphs - 1 padding glyphs will be present.
8579 (On X frames, there is only one glyph produced for a
8580 composite character.)
8582 The behavior implemented below means, for continuation lines,
8583 that as many spaces of a TAB as fit on the current line are
8584 displayed there. For terminal frames, as many glyphs of a
8585 multi-glyph character are displayed in the current line, too.
8586 This is what the old redisplay code did, and we keep it that
8587 way. Under X, the whole shape of a complex character must
8588 fit on the line or it will be completely displayed in the
8589 next line.
8591 Note that both for tabs and padding glyphs, all glyphs have
8592 the same width. */
8593 if (it->nglyphs)
8595 /* More than one glyph or glyph doesn't fit on line. All
8596 glyphs have the same width. */
8597 int single_glyph_width = it->pixel_width / it->nglyphs;
8598 int new_x;
8599 int x_before_this_char = x;
8600 int hpos_before_this_char = it->hpos;
8602 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8604 new_x = x + single_glyph_width;
8606 /* We want to leave anything reaching TO_X to the caller. */
8607 if ((op & MOVE_TO_X) && new_x > to_x)
8609 if (BUFFER_POS_REACHED_P ())
8611 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8612 goto buffer_pos_reached;
8613 if (atpos_it.sp < 0)
8615 SAVE_IT (atpos_it, *it, atpos_data);
8616 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8619 else
8621 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8623 it->current_x = x;
8624 result = MOVE_X_REACHED;
8625 break;
8627 if (atx_it.sp < 0)
8629 SAVE_IT (atx_it, *it, atx_data);
8630 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8635 if (/* Lines are continued. */
8636 it->line_wrap != TRUNCATE
8637 && (/* And glyph doesn't fit on the line. */
8638 new_x > it->last_visible_x
8639 /* Or it fits exactly and we're on a window
8640 system frame. */
8641 || (new_x == it->last_visible_x
8642 && FRAME_WINDOW_P (it->f)
8643 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8644 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8645 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8647 if (/* IT->hpos == 0 means the very first glyph
8648 doesn't fit on the line, e.g. a wide image. */
8649 it->hpos == 0
8650 || (new_x == it->last_visible_x
8651 && FRAME_WINDOW_P (it->f)))
8653 ++it->hpos;
8654 it->current_x = new_x;
8656 /* The character's last glyph just barely fits
8657 in this row. */
8658 if (i == it->nglyphs - 1)
8660 /* If this is the destination position,
8661 return a position *before* it in this row,
8662 now that we know it fits in this row. */
8663 if (BUFFER_POS_REACHED_P ())
8665 if (it->line_wrap != WORD_WRAP
8666 || wrap_it.sp < 0
8667 /* If we've just found whitespace to
8668 wrap, effectively ignore the
8669 previous wrap point -- it is no
8670 longer relevant, but we won't
8671 have an opportunity to update it,
8672 since we've reached the edge of
8673 this screen line. */
8674 || (may_wrap
8675 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)))
8677 it->hpos = hpos_before_this_char;
8678 it->current_x = x_before_this_char;
8679 result = MOVE_POS_MATCH_OR_ZV;
8680 break;
8682 if (it->line_wrap == WORD_WRAP
8683 && atpos_it.sp < 0)
8685 SAVE_IT (atpos_it, *it, atpos_data);
8686 atpos_it.current_x = x_before_this_char;
8687 atpos_it.hpos = hpos_before_this_char;
8691 prev_method = it->method;
8692 if (it->method == GET_FROM_BUFFER)
8693 prev_pos = IT_CHARPOS (*it);
8694 set_iterator_to_next (it, true);
8695 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8696 SET_TEXT_POS (this_line_min_pos,
8697 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8698 /* On graphical terminals, newlines may
8699 "overflow" into the fringe if
8700 overflow-newline-into-fringe is non-nil.
8701 On text terminals, and on graphical
8702 terminals with no right margin, newlines
8703 may overflow into the last glyph on the
8704 display line.*/
8705 if (!FRAME_WINDOW_P (it->f)
8706 || ((it->bidi_p
8707 && it->bidi_it.paragraph_dir == R2L)
8708 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8709 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8710 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8712 if (!get_next_display_element (it))
8714 result = MOVE_POS_MATCH_OR_ZV;
8715 break;
8717 if (BUFFER_POS_REACHED_P ())
8719 if (ITERATOR_AT_END_OF_LINE_P (it))
8720 result = MOVE_POS_MATCH_OR_ZV;
8721 else
8722 result = MOVE_LINE_CONTINUED;
8723 break;
8725 if (ITERATOR_AT_END_OF_LINE_P (it)
8726 && (it->line_wrap != WORD_WRAP
8727 || wrap_it.sp < 0
8728 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)))
8730 result = MOVE_NEWLINE_OR_CR;
8731 break;
8736 else
8737 IT_RESET_X_ASCENT_DESCENT (it);
8739 /* If the screen line ends with whitespace, and we
8740 are under word-wrap, don't use wrap_it: it is no
8741 longer relevant, but we won't have an opportunity
8742 to update it, since we are done with this screen
8743 line. */
8744 if (may_wrap && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8746 /* If we've found TO_X, go back there, as we now
8747 know the last word fits on this screen line. */
8748 if ((op & MOVE_TO_X) && new_x == it->last_visible_x
8749 && atx_it.sp >= 0)
8751 RESTORE_IT (it, &atx_it, atx_data);
8752 atpos_it.sp = -1;
8753 atx_it.sp = -1;
8754 result = MOVE_X_REACHED;
8755 break;
8758 else if (wrap_it.sp >= 0)
8760 RESTORE_IT (it, &wrap_it, wrap_data);
8761 atpos_it.sp = -1;
8762 atx_it.sp = -1;
8765 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8766 IT_CHARPOS (*it)));
8767 result = MOVE_LINE_CONTINUED;
8768 break;
8771 if (BUFFER_POS_REACHED_P ())
8773 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8774 goto buffer_pos_reached;
8775 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8777 SAVE_IT (atpos_it, *it, atpos_data);
8778 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8782 if (new_x > it->first_visible_x)
8784 /* Glyph is visible. Increment number of glyphs that
8785 would be displayed. */
8786 ++it->hpos;
8790 if (result != MOVE_UNDEFINED)
8791 break;
8793 else if (BUFFER_POS_REACHED_P ())
8795 buffer_pos_reached:
8796 IT_RESET_X_ASCENT_DESCENT (it);
8797 result = MOVE_POS_MATCH_OR_ZV;
8798 break;
8800 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8802 /* Stop when TO_X specified and reached. This check is
8803 necessary here because of lines consisting of a line end,
8804 only. The line end will not produce any glyphs and we
8805 would never get MOVE_X_REACHED. */
8806 eassert (it->nglyphs == 0);
8807 result = MOVE_X_REACHED;
8808 break;
8811 /* Is this a line end? If yes, we're done. */
8812 if (ITERATOR_AT_END_OF_LINE_P (it))
8814 /* If we are past TO_CHARPOS, but never saw any character
8815 positions smaller than TO_CHARPOS, return
8816 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8817 did. */
8818 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
8820 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
8822 if (closest_pos < ZV)
8824 RESTORE_IT (it, &ppos_it, ppos_data);
8825 /* Don't recurse if closest_pos is equal to
8826 to_charpos, since we have just tried that. */
8827 if (closest_pos != to_charpos)
8828 move_it_in_display_line_to (it, closest_pos, -1,
8829 MOVE_TO_POS);
8830 result = MOVE_POS_MATCH_OR_ZV;
8832 else
8833 goto buffer_pos_reached;
8835 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
8836 && IT_CHARPOS (*it) > to_charpos)
8837 goto buffer_pos_reached;
8838 else
8839 result = MOVE_NEWLINE_OR_CR;
8841 else
8842 result = MOVE_NEWLINE_OR_CR;
8843 break;
8846 prev_method = it->method;
8847 if (it->method == GET_FROM_BUFFER)
8848 prev_pos = IT_CHARPOS (*it);
8849 /* The current display element has been consumed. Advance
8850 to the next. */
8851 set_iterator_to_next (it, true);
8852 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8853 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8854 if (IT_CHARPOS (*it) < to_charpos)
8855 saw_smaller_pos = true;
8856 if (it->bidi_p
8857 && (op & MOVE_TO_POS)
8858 && IT_CHARPOS (*it) >= to_charpos
8859 && IT_CHARPOS (*it) < closest_pos)
8860 closest_pos = IT_CHARPOS (*it);
8862 /* Stop if lines are truncated and IT's current x-position is
8863 past the right edge of the window now. */
8864 if (it->line_wrap == TRUNCATE
8865 && it->current_x >= it->last_visible_x)
8867 if (!FRAME_WINDOW_P (it->f)
8868 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8869 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8870 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8871 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8873 bool at_eob_p = false;
8875 if ((at_eob_p = !get_next_display_element (it))
8876 || BUFFER_POS_REACHED_P ()
8877 /* If we are past TO_CHARPOS, but never saw any
8878 character positions smaller than TO_CHARPOS,
8879 return MOVE_POS_MATCH_OR_ZV, like the
8880 unidirectional display did. */
8881 || (it->bidi_p && (op & MOVE_TO_POS) != 0
8882 && !saw_smaller_pos
8883 && IT_CHARPOS (*it) > to_charpos))
8885 if (it->bidi_p
8886 && !BUFFER_POS_REACHED_P ()
8887 && !at_eob_p && closest_pos < ZV)
8889 RESTORE_IT (it, &ppos_it, ppos_data);
8890 if (closest_pos != to_charpos)
8891 move_it_in_display_line_to (it, closest_pos, -1,
8892 MOVE_TO_POS);
8894 result = MOVE_POS_MATCH_OR_ZV;
8895 break;
8897 if (ITERATOR_AT_END_OF_LINE_P (it))
8899 result = MOVE_NEWLINE_OR_CR;
8900 break;
8903 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
8904 && !saw_smaller_pos
8905 && IT_CHARPOS (*it) > to_charpos)
8907 if (closest_pos < ZV)
8909 RESTORE_IT (it, &ppos_it, ppos_data);
8910 if (closest_pos != to_charpos)
8911 move_it_in_display_line_to (it, closest_pos, -1,
8912 MOVE_TO_POS);
8914 result = MOVE_POS_MATCH_OR_ZV;
8915 break;
8917 result = MOVE_LINE_TRUNCATED;
8918 break;
8920 #undef IT_RESET_X_ASCENT_DESCENT
8923 #undef BUFFER_POS_REACHED_P
8925 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8926 restore the saved iterator. */
8927 if (atpos_it.sp >= 0)
8928 RESTORE_IT (it, &atpos_it, atpos_data);
8929 else if (atx_it.sp >= 0)
8930 RESTORE_IT (it, &atx_it, atx_data);
8932 done:
8934 if (atpos_data)
8935 bidi_unshelve_cache (atpos_data, true);
8936 if (atx_data)
8937 bidi_unshelve_cache (atx_data, true);
8938 if (wrap_data)
8939 bidi_unshelve_cache (wrap_data, true);
8940 if (ppos_data)
8941 bidi_unshelve_cache (ppos_data, true);
8943 /* Restore the iterator settings altered at the beginning of this
8944 function. */
8945 it->glyph_row = saved_glyph_row;
8946 return result;
8949 /* For external use. */
8950 void
8951 move_it_in_display_line (struct it *it,
8952 ptrdiff_t to_charpos, int to_x,
8953 enum move_operation_enum op)
8955 if (it->line_wrap == WORD_WRAP
8956 && (op & MOVE_TO_X))
8958 struct it save_it;
8959 void *save_data = NULL;
8960 int skip;
8962 SAVE_IT (save_it, *it, save_data);
8963 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
8964 /* When word-wrap is on, TO_X may lie past the end
8965 of a wrapped line. Then it->current is the
8966 character on the next line, so backtrack to the
8967 space before the wrap point. */
8968 if (skip == MOVE_LINE_CONTINUED)
8970 int prev_x = max (it->current_x - 1, 0);
8971 RESTORE_IT (it, &save_it, save_data);
8972 move_it_in_display_line_to
8973 (it, -1, prev_x, MOVE_TO_X);
8975 else
8976 bidi_unshelve_cache (save_data, true);
8978 else
8979 move_it_in_display_line_to (it, to_charpos, to_x, op);
8983 /* Move IT forward until it satisfies one or more of the criteria in
8984 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8986 OP is a bit-mask that specifies where to stop, and in particular,
8987 which of those four position arguments makes a difference. See the
8988 description of enum move_operation_enum.
8990 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8991 screen line, this function will set IT to the next position that is
8992 displayed to the right of TO_CHARPOS on the screen.
8994 Return the maximum pixel length of any line scanned but never more
8995 than it.last_visible_x. */
8998 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
9000 enum move_it_result skip, skip2 = MOVE_X_REACHED;
9001 int line_height, line_start_x = 0, reached = 0;
9002 int max_current_x = 0;
9003 void *backup_data = NULL;
9005 for (;;)
9007 if (op & MOVE_TO_VPOS)
9009 /* If no TO_CHARPOS and no TO_X specified, stop at the
9010 start of the line TO_VPOS. */
9011 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
9013 if (it->vpos == to_vpos)
9015 reached = 1;
9016 break;
9018 else
9019 skip = move_it_in_display_line_to (it, -1, -1, 0);
9021 else
9023 /* TO_VPOS >= 0 means stop at TO_X in the line at
9024 TO_VPOS, or at TO_POS, whichever comes first. */
9025 if (it->vpos == to_vpos)
9027 reached = 2;
9028 break;
9031 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9033 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
9035 reached = 3;
9036 break;
9038 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
9040 /* We have reached TO_X but not in the line we want. */
9041 skip = move_it_in_display_line_to (it, to_charpos,
9042 -1, MOVE_TO_POS);
9043 if (skip == MOVE_POS_MATCH_OR_ZV)
9045 reached = 4;
9046 break;
9051 else if (op & MOVE_TO_Y)
9053 struct it it_backup;
9055 if (it->line_wrap == WORD_WRAP)
9056 SAVE_IT (it_backup, *it, backup_data);
9058 /* TO_Y specified means stop at TO_X in the line containing
9059 TO_Y---or at TO_CHARPOS if this is reached first. The
9060 problem is that we can't really tell whether the line
9061 contains TO_Y before we have completely scanned it, and
9062 this may skip past TO_X. What we do is to first scan to
9063 TO_X.
9065 If TO_X is not specified, use a TO_X of zero. The reason
9066 is to make the outcome of this function more predictable.
9067 If we didn't use TO_X == 0, we would stop at the end of
9068 the line which is probably not what a caller would expect
9069 to happen. */
9070 skip = move_it_in_display_line_to
9071 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
9072 (MOVE_TO_X | (op & MOVE_TO_POS)));
9074 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9075 if (skip == MOVE_POS_MATCH_OR_ZV)
9076 reached = 5;
9077 else if (skip == MOVE_X_REACHED)
9079 /* If TO_X was reached, we want to know whether TO_Y is
9080 in the line. We know this is the case if the already
9081 scanned glyphs make the line tall enough. Otherwise,
9082 we must check by scanning the rest of the line. */
9083 line_height = it->max_ascent + it->max_descent;
9084 if (to_y >= it->current_y
9085 && to_y < it->current_y + line_height)
9087 reached = 6;
9088 break;
9090 SAVE_IT (it_backup, *it, backup_data);
9091 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
9092 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
9093 op & MOVE_TO_POS);
9094 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
9095 line_height = it->max_ascent + it->max_descent;
9096 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9098 if (to_y >= it->current_y
9099 && to_y < it->current_y + line_height)
9101 /* If TO_Y is in this line and TO_X was reached
9102 above, we scanned too far. We have to restore
9103 IT's settings to the ones before skipping. But
9104 keep the more accurate values of max_ascent and
9105 max_descent we've found while skipping the rest
9106 of the line, for the sake of callers, such as
9107 pos_visible_p, that need to know the line
9108 height. */
9109 int max_ascent = it->max_ascent;
9110 int max_descent = it->max_descent;
9112 RESTORE_IT (it, &it_backup, backup_data);
9113 it->max_ascent = max_ascent;
9114 it->max_descent = max_descent;
9115 reached = 6;
9117 else
9119 skip = skip2;
9120 if (skip == MOVE_POS_MATCH_OR_ZV)
9121 reached = 7;
9124 else
9126 /* Check whether TO_Y is in this line. */
9127 line_height = it->max_ascent + it->max_descent;
9128 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9130 if (to_y >= it->current_y
9131 && to_y < it->current_y + line_height)
9133 if (to_y > it->current_y)
9134 max_current_x = max (it->current_x, max_current_x);
9136 /* When word-wrap is on, TO_X may lie past the end
9137 of a wrapped line. Then it->current is the
9138 character on the next line, so backtrack to the
9139 space before the wrap point. */
9140 if (skip == MOVE_LINE_CONTINUED
9141 && it->line_wrap == WORD_WRAP)
9143 int prev_x = max (it->current_x - 1, 0);
9144 RESTORE_IT (it, &it_backup, backup_data);
9145 skip = move_it_in_display_line_to
9146 (it, -1, prev_x, MOVE_TO_X);
9149 reached = 6;
9153 if (reached)
9155 max_current_x = max (it->current_x, max_current_x);
9156 break;
9159 else if (BUFFERP (it->object)
9160 && (it->method == GET_FROM_BUFFER
9161 || it->method == GET_FROM_STRETCH)
9162 && IT_CHARPOS (*it) >= to_charpos
9163 /* Under bidi iteration, a call to set_iterator_to_next
9164 can scan far beyond to_charpos if the initial
9165 portion of the next line needs to be reordered. In
9166 that case, give move_it_in_display_line_to another
9167 chance below. */
9168 && !(it->bidi_p
9169 && it->bidi_it.scan_dir == -1))
9170 skip = MOVE_POS_MATCH_OR_ZV;
9171 else
9172 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
9174 switch (skip)
9176 case MOVE_POS_MATCH_OR_ZV:
9177 max_current_x = max (it->current_x, max_current_x);
9178 reached = 8;
9179 goto out;
9181 case MOVE_NEWLINE_OR_CR:
9182 max_current_x = max (it->current_x, max_current_x);
9183 set_iterator_to_next (it, true);
9184 it->continuation_lines_width = 0;
9185 break;
9187 case MOVE_LINE_TRUNCATED:
9188 max_current_x = it->last_visible_x;
9189 it->continuation_lines_width = 0;
9190 reseat_at_next_visible_line_start (it, false);
9191 if ((op & MOVE_TO_POS) != 0
9192 && IT_CHARPOS (*it) > to_charpos)
9194 reached = 9;
9195 goto out;
9197 break;
9199 case MOVE_LINE_CONTINUED:
9200 max_current_x = it->last_visible_x;
9201 /* For continued lines ending in a tab, some of the glyphs
9202 associated with the tab are displayed on the current
9203 line. Since it->current_x does not include these glyphs,
9204 we use it->last_visible_x instead. */
9205 if (it->c == '\t')
9207 it->continuation_lines_width += it->last_visible_x;
9208 /* When moving by vpos, ensure that the iterator really
9209 advances to the next line (bug#847, bug#969). Fixme:
9210 do we need to do this in other circumstances? */
9211 if (it->current_x != it->last_visible_x
9212 && (op & MOVE_TO_VPOS)
9213 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
9215 line_start_x = it->current_x + it->pixel_width
9216 - it->last_visible_x;
9217 if (FRAME_WINDOW_P (it->f))
9219 struct face *face = FACE_FROM_ID (it->f, it->face_id);
9220 struct font *face_font = face->font;
9222 /* When display_line produces a continued line
9223 that ends in a TAB, it skips a tab stop that
9224 is closer than the font's space character
9225 width (see x_produce_glyphs where it produces
9226 the stretch glyph which represents a TAB).
9227 We need to reproduce the same logic here. */
9228 eassert (face_font);
9229 if (face_font)
9231 if (line_start_x < face_font->space_width)
9232 line_start_x
9233 += it->tab_width * face_font->space_width;
9236 set_iterator_to_next (it, false);
9239 else
9240 it->continuation_lines_width += it->current_x;
9241 break;
9243 default:
9244 emacs_abort ();
9247 /* Reset/increment for the next run. */
9248 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
9249 it->current_x = line_start_x;
9250 line_start_x = 0;
9251 it->hpos = 0;
9252 it->current_y += it->max_ascent + it->max_descent;
9253 ++it->vpos;
9254 last_height = it->max_ascent + it->max_descent;
9255 it->max_ascent = it->max_descent = 0;
9258 out:
9260 /* On text terminals, we may stop at the end of a line in the middle
9261 of a multi-character glyph. If the glyph itself is continued,
9262 i.e. it is actually displayed on the next line, don't treat this
9263 stopping point as valid; move to the next line instead (unless
9264 that brings us offscreen). */
9265 if (!FRAME_WINDOW_P (it->f)
9266 && op & MOVE_TO_POS
9267 && IT_CHARPOS (*it) == to_charpos
9268 && it->what == IT_CHARACTER
9269 && it->nglyphs > 1
9270 && it->line_wrap == WINDOW_WRAP
9271 && it->current_x == it->last_visible_x - 1
9272 && it->c != '\n'
9273 && it->c != '\t'
9274 && it->w->window_end_valid
9275 && it->vpos < it->w->window_end_vpos)
9277 it->continuation_lines_width += it->current_x;
9278 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
9279 it->current_y += it->max_ascent + it->max_descent;
9280 ++it->vpos;
9281 last_height = it->max_ascent + it->max_descent;
9284 if (backup_data)
9285 bidi_unshelve_cache (backup_data, true);
9287 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
9289 return max_current_x;
9293 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9295 If DY > 0, move IT backward at least that many pixels. DY = 0
9296 means move IT backward to the preceding line start or BEGV. This
9297 function may move over more than DY pixels if IT->current_y - DY
9298 ends up in the middle of a line; in this case IT->current_y will be
9299 set to the top of the line moved to. */
9301 void
9302 move_it_vertically_backward (struct it *it, int dy)
9304 int nlines, h;
9305 struct it it2, it3;
9306 void *it2data = NULL, *it3data = NULL;
9307 ptrdiff_t start_pos;
9308 int nchars_per_row
9309 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9310 ptrdiff_t pos_limit;
9312 move_further_back:
9313 eassert (dy >= 0);
9315 start_pos = IT_CHARPOS (*it);
9317 /* Estimate how many newlines we must move back. */
9318 nlines = max (1, dy / default_line_pixel_height (it->w));
9319 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9320 pos_limit = BEGV;
9321 else
9322 pos_limit = max (start_pos - nlines * nchars_per_row, BEGV);
9324 /* Set the iterator's position that many lines back. But don't go
9325 back more than NLINES full screen lines -- this wins a day with
9326 buffers which have very long lines. */
9327 while (nlines-- && IT_CHARPOS (*it) > pos_limit)
9328 back_to_previous_visible_line_start (it);
9330 /* Reseat the iterator here. When moving backward, we don't want
9331 reseat to skip forward over invisible text, set up the iterator
9332 to deliver from overlay strings at the new position etc. So,
9333 use reseat_1 here. */
9334 reseat_1 (it, it->current.pos, true);
9336 /* We are now surely at a line start. */
9337 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
9338 reordering is in effect. */
9339 it->continuation_lines_width = 0;
9341 /* Move forward and see what y-distance we moved. First move to the
9342 start of the next line so that we get its height. We need this
9343 height to be able to tell whether we reached the specified
9344 y-distance. */
9345 SAVE_IT (it2, *it, it2data);
9346 it2.max_ascent = it2.max_descent = 0;
9349 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
9350 MOVE_TO_POS | MOVE_TO_VPOS);
9352 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9353 /* If we are in a display string which starts at START_POS,
9354 and that display string includes a newline, and we are
9355 right after that newline (i.e. at the beginning of a
9356 display line), exit the loop, because otherwise we will
9357 infloop, since move_it_to will see that it is already at
9358 START_POS and will not move. */
9359 || (it2.method == GET_FROM_STRING
9360 && IT_CHARPOS (it2) == start_pos
9361 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9362 eassert (IT_CHARPOS (*it) >= BEGV);
9363 SAVE_IT (it3, it2, it3data);
9365 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9366 eassert (IT_CHARPOS (*it) >= BEGV);
9367 /* H is the actual vertical distance from the position in *IT
9368 and the starting position. */
9369 h = it2.current_y - it->current_y;
9370 /* NLINES is the distance in number of lines. */
9371 nlines = it2.vpos - it->vpos;
9373 /* Correct IT's y and vpos position
9374 so that they are relative to the starting point. */
9375 it->vpos -= nlines;
9376 it->current_y -= h;
9378 if (dy == 0)
9380 /* DY == 0 means move to the start of the screen line. The
9381 value of nlines is > 0 if continuation lines were involved,
9382 or if the original IT position was at start of a line. */
9383 RESTORE_IT (it, it, it2data);
9384 if (nlines > 0)
9385 move_it_by_lines (it, nlines);
9386 /* The above code moves us to some position NLINES down,
9387 usually to its first glyph (leftmost in an L2R line), but
9388 that's not necessarily the start of the line, under bidi
9389 reordering. We want to get to the character position
9390 that is immediately after the newline of the previous
9391 line. */
9392 if (it->bidi_p
9393 && !it->continuation_lines_width
9394 && !STRINGP (it->string)
9395 && IT_CHARPOS (*it) > BEGV
9396 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9398 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
9400 DEC_BOTH (cp, bp);
9401 cp = find_newline_no_quit (cp, bp, -1, NULL);
9402 move_it_to (it, cp, -1, -1, -1, MOVE_TO_POS);
9404 bidi_unshelve_cache (it3data, true);
9406 else
9408 /* The y-position we try to reach, relative to *IT.
9409 Note that H has been subtracted in front of the if-statement. */
9410 int target_y = it->current_y + h - dy;
9411 int y0 = it3.current_y;
9412 int y1;
9413 int line_height;
9415 RESTORE_IT (&it3, &it3, it3data);
9416 y1 = line_bottom_y (&it3);
9417 line_height = y1 - y0;
9418 RESTORE_IT (it, it, it2data);
9419 /* If we did not reach target_y, try to move further backward if
9420 we can. If we moved too far backward, try to move forward. */
9421 if (target_y < it->current_y
9422 /* This is heuristic. In a window that's 3 lines high, with
9423 a line height of 13 pixels each, recentering with point
9424 on the bottom line will try to move -39/2 = 19 pixels
9425 backward. Try to avoid moving into the first line. */
9426 && (it->current_y - target_y
9427 > min (window_box_height (it->w), line_height * 2 / 3))
9428 && IT_CHARPOS (*it) > BEGV)
9430 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9431 target_y - it->current_y));
9432 dy = it->current_y - target_y;
9433 goto move_further_back;
9435 else if (target_y >= it->current_y + line_height
9436 && IT_CHARPOS (*it) < ZV)
9438 /* Should move forward by at least one line, maybe more.
9440 Note: Calling move_it_by_lines can be expensive on
9441 terminal frames, where compute_motion is used (via
9442 vmotion) to do the job, when there are very long lines
9443 and truncate-lines is nil. That's the reason for
9444 treating terminal frames specially here. */
9446 if (!FRAME_WINDOW_P (it->f))
9447 move_it_vertically (it, target_y - it->current_y);
9448 else
9452 move_it_by_lines (it, 1);
9454 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9461 /* Move IT by a specified amount of pixel lines DY. DY negative means
9462 move backwards. DY = 0 means move to start of screen line. At the
9463 end, IT will be on the start of a screen line. */
9465 void
9466 move_it_vertically (struct it *it, int dy)
9468 if (dy <= 0)
9469 move_it_vertically_backward (it, -dy);
9470 else
9472 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9473 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9474 MOVE_TO_POS | MOVE_TO_Y);
9475 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9477 /* If buffer ends in ZV without a newline, move to the start of
9478 the line to satisfy the post-condition. */
9479 if (IT_CHARPOS (*it) == ZV
9480 && ZV > BEGV
9481 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9482 move_it_by_lines (it, 0);
9487 /* Move iterator IT past the end of the text line it is in. */
9489 void
9490 move_it_past_eol (struct it *it)
9492 enum move_it_result rc;
9494 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9495 if (rc == MOVE_NEWLINE_OR_CR)
9496 set_iterator_to_next (it, false);
9500 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9501 negative means move up. DVPOS == 0 means move to the start of the
9502 screen line.
9504 Optimization idea: If we would know that IT->f doesn't use
9505 a face with proportional font, we could be faster for
9506 truncate-lines nil. */
9508 void
9509 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9512 /* The commented-out optimization uses vmotion on terminals. This
9513 gives bad results, because elements like it->what, on which
9514 callers such as pos_visible_p rely, aren't updated. */
9515 /* struct position pos;
9516 if (!FRAME_WINDOW_P (it->f))
9518 struct text_pos textpos;
9520 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9521 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9522 reseat (it, textpos, true);
9523 it->vpos += pos.vpos;
9524 it->current_y += pos.vpos;
9526 else */
9528 if (dvpos == 0)
9530 /* DVPOS == 0 means move to the start of the screen line. */
9531 move_it_vertically_backward (it, 0);
9532 /* Let next call to line_bottom_y calculate real line height. */
9533 last_height = 0;
9535 else if (dvpos > 0)
9537 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9538 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9540 /* Only move to the next buffer position if we ended up in a
9541 string from display property, not in an overlay string
9542 (before-string or after-string). That is because the
9543 latter don't conceal the underlying buffer position, so
9544 we can ask to move the iterator to the exact position we
9545 are interested in. Note that, even if we are already at
9546 IT_CHARPOS (*it), the call below is not a no-op, as it
9547 will detect that we are at the end of the string, pop the
9548 iterator, and compute it->current_x and it->hpos
9549 correctly. */
9550 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9551 -1, -1, -1, MOVE_TO_POS);
9554 else
9556 struct it it2;
9557 void *it2data = NULL;
9558 ptrdiff_t start_charpos, i;
9559 int nchars_per_row
9560 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9561 bool hit_pos_limit = false;
9562 ptrdiff_t pos_limit;
9564 /* Start at the beginning of the screen line containing IT's
9565 position. This may actually move vertically backwards,
9566 in case of overlays, so adjust dvpos accordingly. */
9567 dvpos += it->vpos;
9568 move_it_vertically_backward (it, 0);
9569 dvpos -= it->vpos;
9571 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9572 screen lines, and reseat the iterator there. */
9573 start_charpos = IT_CHARPOS (*it);
9574 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9575 pos_limit = BEGV;
9576 else
9577 pos_limit = max (start_charpos + dvpos * nchars_per_row, BEGV);
9579 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > pos_limit; --i)
9580 back_to_previous_visible_line_start (it);
9581 if (i > 0 && IT_CHARPOS (*it) <= pos_limit)
9582 hit_pos_limit = true;
9583 reseat (it, it->current.pos, true);
9585 /* Move further back if we end up in a string or an image. */
9586 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9588 /* First try to move to start of display line. */
9589 dvpos += it->vpos;
9590 move_it_vertically_backward (it, 0);
9591 dvpos -= it->vpos;
9592 if (IT_POS_VALID_AFTER_MOVE_P (it))
9593 break;
9594 /* If start of line is still in string or image,
9595 move further back. */
9596 back_to_previous_visible_line_start (it);
9597 reseat (it, it->current.pos, true);
9598 dvpos--;
9601 it->current_x = it->hpos = 0;
9603 /* Above call may have moved too far if continuation lines
9604 are involved. Scan forward and see if it did. */
9605 SAVE_IT (it2, *it, it2data);
9606 it2.vpos = it2.current_y = 0;
9607 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9608 it->vpos -= it2.vpos;
9609 it->current_y -= it2.current_y;
9610 it->current_x = it->hpos = 0;
9612 /* If we moved too far back, move IT some lines forward. */
9613 if (it2.vpos > -dvpos)
9615 int delta = it2.vpos + dvpos;
9617 RESTORE_IT (&it2, &it2, it2data);
9618 SAVE_IT (it2, *it, it2data);
9619 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9620 /* Move back again if we got too far ahead. */
9621 if (IT_CHARPOS (*it) >= start_charpos)
9622 RESTORE_IT (it, &it2, it2data);
9623 else
9624 bidi_unshelve_cache (it2data, true);
9626 else if (hit_pos_limit && pos_limit > BEGV
9627 && dvpos < 0 && it2.vpos < -dvpos)
9629 /* If we hit the limit, but still didn't make it far enough
9630 back, that means there's a display string with a newline
9631 covering a large chunk of text, and that caused
9632 back_to_previous_visible_line_start try to go too far.
9633 Punish those who commit such atrocities by going back
9634 until we've reached DVPOS, after lifting the limit, which
9635 could make it slow for very long lines. "If it hurts,
9636 don't do that!" */
9637 dvpos += it2.vpos;
9638 RESTORE_IT (it, it, it2data);
9639 for (i = -dvpos; i > 0; --i)
9641 back_to_previous_visible_line_start (it);
9642 it->vpos--;
9644 reseat_1 (it, it->current.pos, true);
9646 else
9647 RESTORE_IT (it, it, it2data);
9651 /* Return true if IT points into the middle of a display vector. */
9653 bool
9654 in_display_vector_p (struct it *it)
9656 return (it->method == GET_FROM_DISPLAY_VECTOR
9657 && it->current.dpvec_index > 0
9658 && it->dpvec + it->current.dpvec_index != it->dpend);
9661 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9662 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9663 WINDOW must be a live window and defaults to the selected one. The
9664 return value is a cons of the maximum pixel-width of any text line and
9665 the maximum pixel-height of all text lines.
9667 The optional argument FROM, if non-nil, specifies the first text
9668 position and defaults to the minimum accessible position of the buffer.
9669 If FROM is t, use the minimum accessible position that is not a newline
9670 character. TO, if non-nil, specifies the last text position and
9671 defaults to the maximum accessible position of the buffer. If TO is t,
9672 use the maximum accessible position that is not a newline character.
9674 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9675 width that can be returned. X-LIMIT nil or omitted, means to use the
9676 pixel-width of WINDOW's body; use this if you do not intend to change
9677 the width of WINDOW. Use the maximum width WINDOW may assume if you
9678 intend to change WINDOW's width. In any case, text whose x-coordinate
9679 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9680 can take some time, it's always a good idea to make this argument as
9681 small as possible; in particular, if the buffer contains long lines that
9682 shall be truncated anyway.
9684 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9685 height that can be returned. Text lines whose y-coordinate is beyond
9686 Y-LIMIT are ignored. Since calculating the text height of a large
9687 buffer can take some time, it makes sense to specify this argument if
9688 the size of the buffer is unknown.
9690 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9691 include the height of the mode- or header-line of WINDOW in the return
9692 value. If it is either the symbol `mode-line' or `header-line', include
9693 only the height of that line, if present, in the return value. If t,
9694 include the height of both, if present, in the return value. */)
9695 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit,
9696 Lisp_Object y_limit, Lisp_Object mode_and_header_line)
9698 struct window *w = decode_live_window (window);
9699 Lisp_Object buffer = w->contents;
9700 struct buffer *b;
9701 struct it it;
9702 struct buffer *old_b = NULL;
9703 ptrdiff_t start, end, pos;
9704 struct text_pos startp;
9705 void *itdata = NULL;
9706 int c, max_y = -1, x = 0, y = 0;
9708 CHECK_BUFFER (buffer);
9709 b = XBUFFER (buffer);
9711 if (b != current_buffer)
9713 old_b = current_buffer;
9714 set_buffer_internal (b);
9717 if (NILP (from))
9718 start = BEGV;
9719 else if (EQ (from, Qt))
9721 start = pos = BEGV;
9722 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9723 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9724 start = pos;
9725 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9726 start = pos;
9728 else
9730 CHECK_NUMBER_COERCE_MARKER (from);
9731 start = min (max (XINT (from), BEGV), ZV);
9734 if (NILP (to))
9735 end = ZV;
9736 else if (EQ (to, Qt))
9738 end = pos = ZV;
9739 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9740 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9741 end = pos;
9742 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9743 end = pos;
9745 else
9747 CHECK_NUMBER_COERCE_MARKER (to);
9748 end = max (start, min (XINT (to), ZV));
9751 if (!NILP (y_limit))
9753 CHECK_NUMBER (y_limit);
9754 max_y = min (XINT (y_limit), INT_MAX);
9757 itdata = bidi_shelve_cache ();
9758 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9759 start_display (&it, w, startp);
9761 if (NILP (x_limit))
9762 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9763 else
9765 CHECK_NUMBER (x_limit);
9766 it.last_visible_x = min (XINT (x_limit), INFINITY);
9767 /* Actually, we never want move_it_to stop at to_x. But to make
9768 sure that move_it_in_display_line_to always moves far enough,
9769 we set it to INT_MAX and specify MOVE_TO_X. */
9770 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9771 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9774 y = it.current_y + it.max_ascent + it.max_descent;
9776 if (!EQ (mode_and_header_line, Qheader_line)
9777 && !EQ (mode_and_header_line, Qt))
9778 /* Do not count the header-line which was counted automatically by
9779 start_display. */
9780 y = y - WINDOW_HEADER_LINE_HEIGHT (w);
9782 if (EQ (mode_and_header_line, Qmode_line)
9783 || EQ (mode_and_header_line, Qt))
9784 /* Do count the mode-line which is not included automatically by
9785 start_display. */
9786 y = y + WINDOW_MODE_LINE_HEIGHT (w);
9788 bidi_unshelve_cache (itdata, false);
9790 if (old_b)
9791 set_buffer_internal (old_b);
9793 return Fcons (make_number (x), make_number (y));
9796 /***********************************************************************
9797 Messages
9798 ***********************************************************************/
9800 /* Return the number of arguments the format string FORMAT needs. */
9802 static ptrdiff_t
9803 format_nargs (char const *format)
9805 ptrdiff_t nargs = 0;
9806 for (char const *p = format; (p = strchr (p, '%')); p++)
9807 if (p[1] == '%')
9808 p++;
9809 else
9810 nargs++;
9811 return nargs;
9814 /* Add a message with format string FORMAT and formatted arguments
9815 to *Messages*. */
9817 void
9818 add_to_log (const char *format, ...)
9820 va_list ap;
9821 va_start (ap, format);
9822 vadd_to_log (format, ap);
9823 va_end (ap);
9826 void
9827 vadd_to_log (char const *format, va_list ap)
9829 ptrdiff_t form_nargs = format_nargs (format);
9830 ptrdiff_t nargs = 1 + form_nargs;
9831 Lisp_Object args[10];
9832 eassert (nargs <= ARRAYELTS (args));
9833 AUTO_STRING (args0, format);
9834 args[0] = args0;
9835 for (ptrdiff_t i = 1; i <= nargs; i++)
9836 args[i] = va_arg (ap, Lisp_Object);
9837 Lisp_Object msg = Qnil;
9838 struct gcpro gcpro1, gcpro2;
9839 GCPRO2 (args[1], msg);
9840 gcpro1.nvars = form_nargs;
9841 msg = Fformat (nargs, args);
9843 ptrdiff_t len = SBYTES (msg) + 1;
9844 USE_SAFE_ALLOCA;
9845 char *buffer = SAFE_ALLOCA (len);
9846 memcpy (buffer, SDATA (msg), len);
9848 message_dolog (buffer, len - 1, true, STRING_MULTIBYTE (msg));
9849 SAFE_FREE ();
9851 UNGCPRO;
9855 /* Output a newline in the *Messages* buffer if "needs" one. */
9857 void
9858 message_log_maybe_newline (void)
9860 if (message_log_need_newline)
9861 message_dolog ("", 0, true, false);
9865 /* Add a string M of length NBYTES to the message log, optionally
9866 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9867 true, means interpret the contents of M as multibyte. This
9868 function calls low-level routines in order to bypass text property
9869 hooks, etc. which might not be safe to run.
9871 This may GC (insert may run before/after change hooks),
9872 so the buffer M must NOT point to a Lisp string. */
9874 void
9875 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
9877 const unsigned char *msg = (const unsigned char *) m;
9879 if (!NILP (Vmemory_full))
9880 return;
9882 if (!NILP (Vmessage_log_max))
9884 struct buffer *oldbuf;
9885 Lisp_Object oldpoint, oldbegv, oldzv;
9886 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9887 ptrdiff_t point_at_end = 0;
9888 ptrdiff_t zv_at_end = 0;
9889 Lisp_Object old_deactivate_mark;
9890 struct gcpro gcpro1;
9892 old_deactivate_mark = Vdeactivate_mark;
9893 oldbuf = current_buffer;
9895 /* Ensure the Messages buffer exists, and switch to it.
9896 If we created it, set the major-mode. */
9897 bool newbuffer = NILP (Fget_buffer (Vmessages_buffer_name));
9898 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9899 if (newbuffer
9900 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9901 call0 (intern ("messages-buffer-mode"));
9903 bset_undo_list (current_buffer, Qt);
9904 bset_cache_long_scans (current_buffer, Qnil);
9906 oldpoint = message_dolog_marker1;
9907 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
9908 oldbegv = message_dolog_marker2;
9909 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
9910 oldzv = message_dolog_marker3;
9911 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
9912 GCPRO1 (old_deactivate_mark);
9914 if (PT == Z)
9915 point_at_end = 1;
9916 if (ZV == Z)
9917 zv_at_end = 1;
9919 BEGV = BEG;
9920 BEGV_BYTE = BEG_BYTE;
9921 ZV = Z;
9922 ZV_BYTE = Z_BYTE;
9923 TEMP_SET_PT_BOTH (Z, Z_BYTE);
9925 /* Insert the string--maybe converting multibyte to single byte
9926 or vice versa, so that all the text fits the buffer. */
9927 if (multibyte
9928 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
9930 ptrdiff_t i;
9931 int c, char_bytes;
9932 char work[1];
9934 /* Convert a multibyte string to single-byte
9935 for the *Message* buffer. */
9936 for (i = 0; i < nbytes; i += char_bytes)
9938 c = string_char_and_length (msg + i, &char_bytes);
9939 work[0] = CHAR_TO_BYTE8 (c);
9940 insert_1_both (work, 1, 1, true, false, false);
9943 else if (! multibyte
9944 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
9946 ptrdiff_t i;
9947 int c, char_bytes;
9948 unsigned char str[MAX_MULTIBYTE_LENGTH];
9949 /* Convert a single-byte string to multibyte
9950 for the *Message* buffer. */
9951 for (i = 0; i < nbytes; i++)
9953 c = msg[i];
9954 MAKE_CHAR_MULTIBYTE (c);
9955 char_bytes = CHAR_STRING (c, str);
9956 insert_1_both ((char *) str, 1, char_bytes, true, false, false);
9959 else if (nbytes)
9960 insert_1_both (m, chars_in_text (msg, nbytes), nbytes,
9961 true, false, false);
9963 if (nlflag)
9965 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
9966 printmax_t dups;
9968 insert_1_both ("\n", 1, 1, true, false, false);
9970 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, false);
9971 this_bol = PT;
9972 this_bol_byte = PT_BYTE;
9974 /* See if this line duplicates the previous one.
9975 If so, combine duplicates. */
9976 if (this_bol > BEG)
9978 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, false);
9979 prev_bol = PT;
9980 prev_bol_byte = PT_BYTE;
9982 dups = message_log_check_duplicate (prev_bol_byte,
9983 this_bol_byte);
9984 if (dups)
9986 del_range_both (prev_bol, prev_bol_byte,
9987 this_bol, this_bol_byte, false);
9988 if (dups > 1)
9990 char dupstr[sizeof " [ times]"
9991 + INT_STRLEN_BOUND (printmax_t)];
9993 /* If you change this format, don't forget to also
9994 change message_log_check_duplicate. */
9995 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
9996 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
9997 insert_1_both (dupstr, duplen, duplen,
9998 true, false, true);
10003 /* If we have more than the desired maximum number of lines
10004 in the *Messages* buffer now, delete the oldest ones.
10005 This is safe because we don't have undo in this buffer. */
10007 if (NATNUMP (Vmessage_log_max))
10009 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
10010 -XFASTINT (Vmessage_log_max) - 1, false);
10011 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, false);
10014 BEGV = marker_position (oldbegv);
10015 BEGV_BYTE = marker_byte_position (oldbegv);
10017 if (zv_at_end)
10019 ZV = Z;
10020 ZV_BYTE = Z_BYTE;
10022 else
10024 ZV = marker_position (oldzv);
10025 ZV_BYTE = marker_byte_position (oldzv);
10028 if (point_at_end)
10029 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10030 else
10031 /* We can't do Fgoto_char (oldpoint) because it will run some
10032 Lisp code. */
10033 TEMP_SET_PT_BOTH (marker_position (oldpoint),
10034 marker_byte_position (oldpoint));
10036 UNGCPRO;
10037 unchain_marker (XMARKER (oldpoint));
10038 unchain_marker (XMARKER (oldbegv));
10039 unchain_marker (XMARKER (oldzv));
10041 /* We called insert_1_both above with its 5th argument (PREPARE)
10042 false, which prevents insert_1_both from calling
10043 prepare_to_modify_buffer, which in turns prevents us from
10044 incrementing windows_or_buffers_changed even if *Messages* is
10045 shown in some window. So we must manually set
10046 windows_or_buffers_changed here to make up for that. */
10047 windows_or_buffers_changed = old_windows_or_buffers_changed;
10048 bset_redisplay (current_buffer);
10050 set_buffer_internal (oldbuf);
10052 message_log_need_newline = !nlflag;
10053 Vdeactivate_mark = old_deactivate_mark;
10058 /* We are at the end of the buffer after just having inserted a newline.
10059 (Note: We depend on the fact we won't be crossing the gap.)
10060 Check to see if the most recent message looks a lot like the previous one.
10061 Return 0 if different, 1 if the new one should just replace it, or a
10062 value N > 1 if we should also append " [N times]". */
10064 static intmax_t
10065 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
10067 ptrdiff_t i;
10068 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
10069 bool seen_dots = false;
10070 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
10071 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
10073 for (i = 0; i < len; i++)
10075 if (i >= 3 && p1[i - 3] == '.' && p1[i - 2] == '.' && p1[i - 1] == '.')
10076 seen_dots = true;
10077 if (p1[i] != p2[i])
10078 return seen_dots;
10080 p1 += len;
10081 if (*p1 == '\n')
10082 return 2;
10083 if (*p1++ == ' ' && *p1++ == '[')
10085 char *pend;
10086 intmax_t n = strtoimax ((char *) p1, &pend, 10);
10087 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
10088 return n + 1;
10090 return 0;
10094 /* Display an echo area message M with a specified length of NBYTES
10095 bytes. The string may include null characters. If M is not a
10096 string, clear out any existing message, and let the mini-buffer
10097 text show through.
10099 This function cancels echoing. */
10101 void
10102 message3 (Lisp_Object m)
10104 struct gcpro gcpro1;
10106 GCPRO1 (m);
10107 clear_message (true, true);
10108 cancel_echoing ();
10110 /* First flush out any partial line written with print. */
10111 message_log_maybe_newline ();
10112 if (STRINGP (m))
10114 ptrdiff_t nbytes = SBYTES (m);
10115 bool multibyte = STRING_MULTIBYTE (m);
10116 char *buffer;
10117 USE_SAFE_ALLOCA;
10118 SAFE_ALLOCA_STRING (buffer, m);
10119 message_dolog (buffer, nbytes, true, multibyte);
10120 SAFE_FREE ();
10122 if (! inhibit_message)
10123 message3_nolog (m);
10124 UNGCPRO;
10128 /* The non-logging version of message3.
10129 This does not cancel echoing, because it is used for echoing.
10130 Perhaps we need to make a separate function for echoing
10131 and make this cancel echoing. */
10133 void
10134 message3_nolog (Lisp_Object m)
10136 struct frame *sf = SELECTED_FRAME ();
10138 if (FRAME_INITIAL_P (sf))
10140 if (noninteractive_need_newline)
10141 putc ('\n', stderr);
10142 noninteractive_need_newline = false;
10143 if (STRINGP (m))
10145 Lisp_Object s = ENCODE_SYSTEM (m);
10147 fwrite (SDATA (s), SBYTES (s), 1, stderr);
10149 if (!cursor_in_echo_area)
10150 fprintf (stderr, "\n");
10151 fflush (stderr);
10153 /* Error messages get reported properly by cmd_error, so this must be just an
10154 informative message; if the frame hasn't really been initialized yet, just
10155 toss it. */
10156 else if (INTERACTIVE && sf->glyphs_initialized_p)
10158 /* Get the frame containing the mini-buffer
10159 that the selected frame is using. */
10160 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
10161 Lisp_Object frame = XWINDOW (mini_window)->frame;
10162 struct frame *f = XFRAME (frame);
10164 if (FRAME_VISIBLE_P (sf) && !FRAME_VISIBLE_P (f))
10165 Fmake_frame_visible (frame);
10167 if (STRINGP (m) && SCHARS (m) > 0)
10169 set_message (m);
10170 if (minibuffer_auto_raise)
10171 Fraise_frame (frame);
10172 /* Assume we are not echoing.
10173 (If we are, echo_now will override this.) */
10174 echo_message_buffer = Qnil;
10176 else
10177 clear_message (true, true);
10179 do_pending_window_change (false);
10180 echo_area_display (true);
10181 do_pending_window_change (false);
10182 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
10183 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
10188 /* Display a null-terminated echo area message M. If M is 0, clear
10189 out any existing message, and let the mini-buffer text show through.
10191 The buffer M must continue to exist until after the echo area gets
10192 cleared or some other message gets displayed there. Do not pass
10193 text that is stored in a Lisp string. Do not pass text in a buffer
10194 that was alloca'd. */
10196 void
10197 message1 (const char *m)
10199 message3 (m ? build_unibyte_string (m) : Qnil);
10203 /* The non-logging counterpart of message1. */
10205 void
10206 message1_nolog (const char *m)
10208 message3_nolog (m ? build_unibyte_string (m) : Qnil);
10211 /* Display a message M which contains a single %s
10212 which gets replaced with STRING. */
10214 void
10215 message_with_string (const char *m, Lisp_Object string, bool log)
10217 CHECK_STRING (string);
10219 if (noninteractive)
10221 if (m)
10223 /* ENCODE_SYSTEM below can GC and/or relocate the
10224 Lisp data, so make sure we don't use it here. */
10225 eassert (relocatable_string_data_p (m) != 1);
10227 if (noninteractive_need_newline)
10228 putc ('\n', stderr);
10229 noninteractive_need_newline = false;
10230 fprintf (stderr, m, SDATA (ENCODE_SYSTEM (string)));
10231 if (!cursor_in_echo_area)
10232 fprintf (stderr, "\n");
10233 fflush (stderr);
10236 else if (INTERACTIVE)
10238 /* The frame whose minibuffer we're going to display the message on.
10239 It may be larger than the selected frame, so we need
10240 to use its buffer, not the selected frame's buffer. */
10241 Lisp_Object mini_window;
10242 struct frame *f, *sf = SELECTED_FRAME ();
10244 /* Get the frame containing the minibuffer
10245 that the selected frame is using. */
10246 mini_window = FRAME_MINIBUF_WINDOW (sf);
10247 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10249 /* Error messages get reported properly by cmd_error, so this must be
10250 just an informative message; if the frame hasn't really been
10251 initialized yet, just toss it. */
10252 if (f->glyphs_initialized_p)
10254 struct gcpro gcpro1, gcpro2;
10256 Lisp_Object fmt = build_string (m);
10257 Lisp_Object msg = string;
10258 GCPRO2 (fmt, msg);
10260 msg = CALLN (Fformat, fmt, msg);
10262 if (log)
10263 message3 (msg);
10264 else
10265 message3_nolog (msg);
10267 UNGCPRO;
10269 /* Print should start at the beginning of the message
10270 buffer next time. */
10271 message_buf_print = false;
10277 /* Dump an informative message to the minibuf. If M is 0, clear out
10278 any existing message, and let the mini-buffer text show through.
10280 The message must be safe ASCII and the format must not contain ` or
10281 '. If your message and format do not fit into this category,
10282 convert your arguments to Lisp objects and use Fmessage instead. */
10284 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10285 vmessage (const char *m, va_list ap)
10287 if (noninteractive)
10289 if (m)
10291 if (noninteractive_need_newline)
10292 putc ('\n', stderr);
10293 noninteractive_need_newline = false;
10294 vfprintf (stderr, m, ap);
10295 if (!cursor_in_echo_area)
10296 fprintf (stderr, "\n");
10297 fflush (stderr);
10300 else if (INTERACTIVE)
10302 /* The frame whose mini-buffer we're going to display the message
10303 on. It may be larger than the selected frame, so we need to
10304 use its buffer, not the selected frame's buffer. */
10305 Lisp_Object mini_window;
10306 struct frame *f, *sf = SELECTED_FRAME ();
10308 /* Get the frame containing the mini-buffer
10309 that the selected frame is using. */
10310 mini_window = FRAME_MINIBUF_WINDOW (sf);
10311 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10313 /* Error messages get reported properly by cmd_error, so this must be
10314 just an informative message; if the frame hasn't really been
10315 initialized yet, just toss it. */
10316 if (f->glyphs_initialized_p)
10318 if (m)
10320 ptrdiff_t len;
10321 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10322 USE_SAFE_ALLOCA;
10323 char *message_buf = SAFE_ALLOCA (maxsize + 1);
10325 len = doprnt (message_buf, maxsize, m, 0, ap);
10327 message3 (make_string (message_buf, len));
10328 SAFE_FREE ();
10330 else
10331 message1 (0);
10333 /* Print should start at the beginning of the message
10334 buffer next time. */
10335 message_buf_print = false;
10340 void
10341 message (const char *m, ...)
10343 va_list ap;
10344 va_start (ap, m);
10345 vmessage (m, ap);
10346 va_end (ap);
10350 /* Display the current message in the current mini-buffer. This is
10351 only called from error handlers in process.c, and is not time
10352 critical. */
10354 void
10355 update_echo_area (void)
10357 if (!NILP (echo_area_buffer[0]))
10359 Lisp_Object string;
10360 string = Fcurrent_message ();
10361 message3 (string);
10366 /* Make sure echo area buffers in `echo_buffers' are live.
10367 If they aren't, make new ones. */
10369 static void
10370 ensure_echo_area_buffers (void)
10372 int i;
10374 for (i = 0; i < 2; ++i)
10375 if (!BUFFERP (echo_buffer[i])
10376 || !BUFFER_LIVE_P (XBUFFER (echo_buffer[i])))
10378 char name[30];
10379 Lisp_Object old_buffer;
10380 int j;
10382 old_buffer = echo_buffer[i];
10383 echo_buffer[i] = Fget_buffer_create
10384 (make_formatted_string (name, " *Echo Area %d*", i));
10385 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
10386 /* to force word wrap in echo area -
10387 it was decided to postpone this*/
10388 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10390 for (j = 0; j < 2; ++j)
10391 if (EQ (old_buffer, echo_area_buffer[j]))
10392 echo_area_buffer[j] = echo_buffer[i];
10397 /* Call FN with args A1..A2 with either the current or last displayed
10398 echo_area_buffer as current buffer.
10400 WHICH zero means use the current message buffer
10401 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10402 from echo_buffer[] and clear it.
10404 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10405 suitable buffer from echo_buffer[] and clear it.
10407 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10408 that the current message becomes the last displayed one, make
10409 choose a suitable buffer for echo_area_buffer[0], and clear it.
10411 Value is what FN returns. */
10413 static bool
10414 with_echo_area_buffer (struct window *w, int which,
10415 bool (*fn) (ptrdiff_t, Lisp_Object),
10416 ptrdiff_t a1, Lisp_Object a2)
10418 Lisp_Object buffer;
10419 bool this_one, the_other, clear_buffer_p, rc;
10420 ptrdiff_t count = SPECPDL_INDEX ();
10422 /* If buffers aren't live, make new ones. */
10423 ensure_echo_area_buffers ();
10425 clear_buffer_p = false;
10427 if (which == 0)
10428 this_one = false, the_other = true;
10429 else if (which > 0)
10430 this_one = true, the_other = false;
10431 else
10433 this_one = false, the_other = true;
10434 clear_buffer_p = true;
10436 /* We need a fresh one in case the current echo buffer equals
10437 the one containing the last displayed echo area message. */
10438 if (!NILP (echo_area_buffer[this_one])
10439 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
10440 echo_area_buffer[this_one] = Qnil;
10443 /* Choose a suitable buffer from echo_buffer[] is we don't
10444 have one. */
10445 if (NILP (echo_area_buffer[this_one]))
10447 echo_area_buffer[this_one]
10448 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
10449 ? echo_buffer[the_other]
10450 : echo_buffer[this_one]);
10451 clear_buffer_p = true;
10454 buffer = echo_area_buffer[this_one];
10456 /* Don't get confused by reusing the buffer used for echoing
10457 for a different purpose. */
10458 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
10459 cancel_echoing ();
10461 record_unwind_protect (unwind_with_echo_area_buffer,
10462 with_echo_area_buffer_unwind_data (w));
10464 /* Make the echo area buffer current. Note that for display
10465 purposes, it is not necessary that the displayed window's buffer
10466 == current_buffer, except for text property lookup. So, let's
10467 only set that buffer temporarily here without doing a full
10468 Fset_window_buffer. We must also change w->pointm, though,
10469 because otherwise an assertions in unshow_buffer fails, and Emacs
10470 aborts. */
10471 set_buffer_internal_1 (XBUFFER (buffer));
10472 if (w)
10474 wset_buffer (w, buffer);
10475 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10476 set_marker_both (w->old_pointm, buffer, BEG, BEG_BYTE);
10479 bset_undo_list (current_buffer, Qt);
10480 bset_read_only (current_buffer, Qnil);
10481 specbind (Qinhibit_read_only, Qt);
10482 specbind (Qinhibit_modification_hooks, Qt);
10484 if (clear_buffer_p && Z > BEG)
10485 del_range (BEG, Z);
10487 eassert (BEGV >= BEG);
10488 eassert (ZV <= Z && ZV >= BEGV);
10490 rc = fn (a1, a2);
10492 eassert (BEGV >= BEG);
10493 eassert (ZV <= Z && ZV >= BEGV);
10495 unbind_to (count, Qnil);
10496 return rc;
10500 /* Save state that should be preserved around the call to the function
10501 FN called in with_echo_area_buffer. */
10503 static Lisp_Object
10504 with_echo_area_buffer_unwind_data (struct window *w)
10506 int i = 0;
10507 Lisp_Object vector, tmp;
10509 /* Reduce consing by keeping one vector in
10510 Vwith_echo_area_save_vector. */
10511 vector = Vwith_echo_area_save_vector;
10512 Vwith_echo_area_save_vector = Qnil;
10514 if (NILP (vector))
10515 vector = Fmake_vector (make_number (11), Qnil);
10517 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10518 ASET (vector, i, Vdeactivate_mark); ++i;
10519 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10521 if (w)
10523 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10524 ASET (vector, i, w->contents); ++i;
10525 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10526 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10527 ASET (vector, i, make_number (marker_position (w->old_pointm))); ++i;
10528 ASET (vector, i, make_number (marker_byte_position (w->old_pointm))); ++i;
10529 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10530 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10532 else
10534 int end = i + 8;
10535 for (; i < end; ++i)
10536 ASET (vector, i, Qnil);
10539 eassert (i == ASIZE (vector));
10540 return vector;
10544 /* Restore global state from VECTOR which was created by
10545 with_echo_area_buffer_unwind_data. */
10547 static void
10548 unwind_with_echo_area_buffer (Lisp_Object vector)
10550 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10551 Vdeactivate_mark = AREF (vector, 1);
10552 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10554 if (WINDOWP (AREF (vector, 3)))
10556 struct window *w;
10557 Lisp_Object buffer;
10559 w = XWINDOW (AREF (vector, 3));
10560 buffer = AREF (vector, 4);
10562 wset_buffer (w, buffer);
10563 set_marker_both (w->pointm, buffer,
10564 XFASTINT (AREF (vector, 5)),
10565 XFASTINT (AREF (vector, 6)));
10566 set_marker_both (w->old_pointm, buffer,
10567 XFASTINT (AREF (vector, 7)),
10568 XFASTINT (AREF (vector, 8)));
10569 set_marker_both (w->start, buffer,
10570 XFASTINT (AREF (vector, 9)),
10571 XFASTINT (AREF (vector, 10)));
10574 Vwith_echo_area_save_vector = vector;
10578 /* Set up the echo area for use by print functions. MULTIBYTE_P
10579 means we will print multibyte. */
10581 void
10582 setup_echo_area_for_printing (bool multibyte_p)
10584 /* If we can't find an echo area any more, exit. */
10585 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10586 Fkill_emacs (Qnil);
10588 ensure_echo_area_buffers ();
10590 if (!message_buf_print)
10592 /* A message has been output since the last time we printed.
10593 Choose a fresh echo area buffer. */
10594 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10595 echo_area_buffer[0] = echo_buffer[1];
10596 else
10597 echo_area_buffer[0] = echo_buffer[0];
10599 /* Switch to that buffer and clear it. */
10600 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10601 bset_truncate_lines (current_buffer, Qnil);
10603 if (Z > BEG)
10605 ptrdiff_t count = SPECPDL_INDEX ();
10606 specbind (Qinhibit_read_only, Qt);
10607 /* Note that undo recording is always disabled. */
10608 del_range (BEG, Z);
10609 unbind_to (count, Qnil);
10611 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10613 /* Set up the buffer for the multibyteness we need. */
10614 if (multibyte_p
10615 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10616 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10618 /* Raise the frame containing the echo area. */
10619 if (minibuffer_auto_raise)
10621 struct frame *sf = SELECTED_FRAME ();
10622 Lisp_Object mini_window;
10623 mini_window = FRAME_MINIBUF_WINDOW (sf);
10624 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10627 message_log_maybe_newline ();
10628 message_buf_print = true;
10630 else
10632 if (NILP (echo_area_buffer[0]))
10634 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10635 echo_area_buffer[0] = echo_buffer[1];
10636 else
10637 echo_area_buffer[0] = echo_buffer[0];
10640 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10642 /* Someone switched buffers between print requests. */
10643 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10644 bset_truncate_lines (current_buffer, Qnil);
10650 /* Display an echo area message in window W. Value is true if W's
10651 height is changed. If display_last_displayed_message_p,
10652 display the message that was last displayed, otherwise
10653 display the current message. */
10655 static bool
10656 display_echo_area (struct window *w)
10658 bool no_message_p, window_height_changed_p;
10660 /* Temporarily disable garbage collections while displaying the echo
10661 area. This is done because a GC can print a message itself.
10662 That message would modify the echo area buffer's contents while a
10663 redisplay of the buffer is going on, and seriously confuse
10664 redisplay. */
10665 ptrdiff_t count = inhibit_garbage_collection ();
10667 /* If there is no message, we must call display_echo_area_1
10668 nevertheless because it resizes the window. But we will have to
10669 reset the echo_area_buffer in question to nil at the end because
10670 with_echo_area_buffer will sets it to an empty buffer. */
10671 bool i = display_last_displayed_message_p;
10672 no_message_p = NILP (echo_area_buffer[i]);
10674 window_height_changed_p
10675 = with_echo_area_buffer (w, display_last_displayed_message_p,
10676 display_echo_area_1,
10677 (intptr_t) w, Qnil);
10679 if (no_message_p)
10680 echo_area_buffer[i] = Qnil;
10682 unbind_to (count, Qnil);
10683 return window_height_changed_p;
10687 /* Helper for display_echo_area. Display the current buffer which
10688 contains the current echo area message in window W, a mini-window,
10689 a pointer to which is passed in A1. A2..A4 are currently not used.
10690 Change the height of W so that all of the message is displayed.
10691 Value is true if height of W was changed. */
10693 static bool
10694 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10696 intptr_t i1 = a1;
10697 struct window *w = (struct window *) i1;
10698 Lisp_Object window;
10699 struct text_pos start;
10701 /* Do this before displaying, so that we have a large enough glyph
10702 matrix for the display. If we can't get enough space for the
10703 whole text, display the last N lines. That works by setting w->start. */
10704 bool window_height_changed_p = resize_mini_window (w, false);
10706 /* Use the starting position chosen by resize_mini_window. */
10707 SET_TEXT_POS_FROM_MARKER (start, w->start);
10709 /* Display. */
10710 clear_glyph_matrix (w->desired_matrix);
10711 XSETWINDOW (window, w);
10712 try_window (window, start, 0);
10714 return window_height_changed_p;
10718 /* Resize the echo area window to exactly the size needed for the
10719 currently displayed message, if there is one. If a mini-buffer
10720 is active, don't shrink it. */
10722 void
10723 resize_echo_area_exactly (void)
10725 if (BUFFERP (echo_area_buffer[0])
10726 && WINDOWP (echo_area_window))
10728 struct window *w = XWINDOW (echo_area_window);
10729 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10730 bool resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10731 (intptr_t) w, resize_exactly);
10732 if (resized_p)
10734 windows_or_buffers_changed = 42;
10735 update_mode_lines = 30;
10736 redisplay_internal ();
10742 /* Callback function for with_echo_area_buffer, when used from
10743 resize_echo_area_exactly. A1 contains a pointer to the window to
10744 resize, EXACTLY non-nil means resize the mini-window exactly to the
10745 size of the text displayed. A3 and A4 are not used. Value is what
10746 resize_mini_window returns. */
10748 static bool
10749 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10751 intptr_t i1 = a1;
10752 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10756 /* Resize mini-window W to fit the size of its contents. EXACT_P
10757 means size the window exactly to the size needed. Otherwise, it's
10758 only enlarged until W's buffer is empty.
10760 Set W->start to the right place to begin display. If the whole
10761 contents fit, start at the beginning. Otherwise, start so as
10762 to make the end of the contents appear. This is particularly
10763 important for y-or-n-p, but seems desirable generally.
10765 Value is true if the window height has been changed. */
10767 bool
10768 resize_mini_window (struct window *w, bool exact_p)
10770 struct frame *f = XFRAME (w->frame);
10771 bool window_height_changed_p = false;
10773 eassert (MINI_WINDOW_P (w));
10775 /* By default, start display at the beginning. */
10776 set_marker_both (w->start, w->contents,
10777 BUF_BEGV (XBUFFER (w->contents)),
10778 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10780 /* Don't resize windows while redisplaying a window; it would
10781 confuse redisplay functions when the size of the window they are
10782 displaying changes from under them. Such a resizing can happen,
10783 for instance, when which-func prints a long message while
10784 we are running fontification-functions. We're running these
10785 functions with safe_call which binds inhibit-redisplay to t. */
10786 if (!NILP (Vinhibit_redisplay))
10787 return false;
10789 /* Nil means don't try to resize. */
10790 if (NILP (Vresize_mini_windows)
10791 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10792 return false;
10794 if (!FRAME_MINIBUF_ONLY_P (f))
10796 struct it it;
10797 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
10798 + WINDOW_PIXEL_HEIGHT (w));
10799 int unit = FRAME_LINE_HEIGHT (f);
10800 int height, max_height;
10801 struct text_pos start;
10802 struct buffer *old_current_buffer = NULL;
10804 if (current_buffer != XBUFFER (w->contents))
10806 old_current_buffer = current_buffer;
10807 set_buffer_internal (XBUFFER (w->contents));
10810 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10812 /* Compute the max. number of lines specified by the user. */
10813 if (FLOATP (Vmax_mini_window_height))
10814 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
10815 else if (INTEGERP (Vmax_mini_window_height))
10816 max_height = XINT (Vmax_mini_window_height) * unit;
10817 else
10818 max_height = total_height / 4;
10820 /* Correct that max. height if it's bogus. */
10821 max_height = clip_to_bounds (unit, max_height, total_height);
10823 /* Find out the height of the text in the window. */
10824 if (it.line_wrap == TRUNCATE)
10825 height = unit;
10826 else
10828 last_height = 0;
10829 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10830 if (it.max_ascent == 0 && it.max_descent == 0)
10831 height = it.current_y + last_height;
10832 else
10833 height = it.current_y + it.max_ascent + it.max_descent;
10834 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10837 /* Compute a suitable window start. */
10838 if (height > max_height)
10840 height = (max_height / unit) * unit;
10841 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10842 move_it_vertically_backward (&it, height - unit);
10843 start = it.current.pos;
10845 else
10846 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10847 SET_MARKER_FROM_TEXT_POS (w->start, start);
10849 if (EQ (Vresize_mini_windows, Qgrow_only))
10851 /* Let it grow only, until we display an empty message, in which
10852 case the window shrinks again. */
10853 if (height > WINDOW_PIXEL_HEIGHT (w))
10855 int old_height = WINDOW_PIXEL_HEIGHT (w);
10857 FRAME_WINDOWS_FROZEN (f) = true;
10858 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
10859 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10861 else if (height < WINDOW_PIXEL_HEIGHT (w)
10862 && (exact_p || BEGV == ZV))
10864 int old_height = WINDOW_PIXEL_HEIGHT (w);
10866 FRAME_WINDOWS_FROZEN (f) = false;
10867 shrink_mini_window (w, true);
10868 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10871 else
10873 /* Always resize to exact size needed. */
10874 if (height > WINDOW_PIXEL_HEIGHT (w))
10876 int old_height = WINDOW_PIXEL_HEIGHT (w);
10878 FRAME_WINDOWS_FROZEN (f) = true;
10879 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
10880 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10882 else if (height < WINDOW_PIXEL_HEIGHT (w))
10884 int old_height = WINDOW_PIXEL_HEIGHT (w);
10886 FRAME_WINDOWS_FROZEN (f) = false;
10887 shrink_mini_window (w, true);
10889 if (height)
10891 FRAME_WINDOWS_FROZEN (f) = true;
10892 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
10895 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10899 if (old_current_buffer)
10900 set_buffer_internal (old_current_buffer);
10903 return window_height_changed_p;
10907 /* Value is the current message, a string, or nil if there is no
10908 current message. */
10910 Lisp_Object
10911 current_message (void)
10913 Lisp_Object msg;
10915 if (!BUFFERP (echo_area_buffer[0]))
10916 msg = Qnil;
10917 else
10919 with_echo_area_buffer (0, 0, current_message_1,
10920 (intptr_t) &msg, Qnil);
10921 if (NILP (msg))
10922 echo_area_buffer[0] = Qnil;
10925 return msg;
10929 static bool
10930 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
10932 intptr_t i1 = a1;
10933 Lisp_Object *msg = (Lisp_Object *) i1;
10935 if (Z > BEG)
10936 *msg = make_buffer_string (BEG, Z, true);
10937 else
10938 *msg = Qnil;
10939 return false;
10943 /* Push the current message on Vmessage_stack for later restoration
10944 by restore_message. Value is true if the current message isn't
10945 empty. This is a relatively infrequent operation, so it's not
10946 worth optimizing. */
10948 bool
10949 push_message (void)
10951 Lisp_Object msg = current_message ();
10952 Vmessage_stack = Fcons (msg, Vmessage_stack);
10953 return STRINGP (msg);
10957 /* Restore message display from the top of Vmessage_stack. */
10959 void
10960 restore_message (void)
10962 eassert (CONSP (Vmessage_stack));
10963 message3_nolog (XCAR (Vmessage_stack));
10967 /* Handler for unwind-protect calling pop_message. */
10969 void
10970 pop_message_unwind (void)
10972 /* Pop the top-most entry off Vmessage_stack. */
10973 eassert (CONSP (Vmessage_stack));
10974 Vmessage_stack = XCDR (Vmessage_stack);
10978 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10979 exits. If the stack is not empty, we have a missing pop_message
10980 somewhere. */
10982 void
10983 check_message_stack (void)
10985 if (!NILP (Vmessage_stack))
10986 emacs_abort ();
10990 /* Truncate to NCHARS what will be displayed in the echo area the next
10991 time we display it---but don't redisplay it now. */
10993 void
10994 truncate_echo_area (ptrdiff_t nchars)
10996 if (nchars == 0)
10997 echo_area_buffer[0] = Qnil;
10998 else if (!noninteractive
10999 && INTERACTIVE
11000 && !NILP (echo_area_buffer[0]))
11002 struct frame *sf = SELECTED_FRAME ();
11003 /* Error messages get reported properly by cmd_error, so this must be
11004 just an informative message; if the frame hasn't really been
11005 initialized yet, just toss it. */
11006 if (sf->glyphs_initialized_p)
11007 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
11012 /* Helper function for truncate_echo_area. Truncate the current
11013 message to at most NCHARS characters. */
11015 static bool
11016 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11018 if (BEG + nchars < Z)
11019 del_range (BEG + nchars, Z);
11020 if (Z == BEG)
11021 echo_area_buffer[0] = Qnil;
11022 return false;
11025 /* Set the current message to STRING. */
11027 static void
11028 set_message (Lisp_Object string)
11030 eassert (STRINGP (string));
11032 message_enable_multibyte = STRING_MULTIBYTE (string);
11034 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11035 message_buf_print = false;
11036 help_echo_showing_p = false;
11038 if (STRINGP (Vdebug_on_message)
11039 && STRINGP (string)
11040 && fast_string_match (Vdebug_on_message, string) >= 0)
11041 call_debugger (list2 (Qerror, string));
11045 /* Helper function for set_message. First argument is ignored and second
11046 argument has the same meaning as for set_message.
11047 This function is called with the echo area buffer being current. */
11049 static bool
11050 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11052 eassert (STRINGP (string));
11054 /* Change multibyteness of the echo buffer appropriately. */
11055 if (message_enable_multibyte
11056 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11057 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11059 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11060 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11061 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11063 /* Insert new message at BEG. */
11064 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11066 /* This function takes care of single/multibyte conversion.
11067 We just have to ensure that the echo area buffer has the right
11068 setting of enable_multibyte_characters. */
11069 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), true);
11071 return false;
11075 /* Clear messages. CURRENT_P means clear the current message.
11076 LAST_DISPLAYED_P means clear the message last displayed. */
11078 void
11079 clear_message (bool current_p, bool last_displayed_p)
11081 if (current_p)
11083 echo_area_buffer[0] = Qnil;
11084 message_cleared_p = true;
11087 if (last_displayed_p)
11088 echo_area_buffer[1] = Qnil;
11090 message_buf_print = false;
11093 /* Clear garbaged frames.
11095 This function is used where the old redisplay called
11096 redraw_garbaged_frames which in turn called redraw_frame which in
11097 turn called clear_frame. The call to clear_frame was a source of
11098 flickering. I believe a clear_frame is not necessary. It should
11099 suffice in the new redisplay to invalidate all current matrices,
11100 and ensure a complete redisplay of all windows. */
11102 static void
11103 clear_garbaged_frames (void)
11105 if (frame_garbaged)
11107 Lisp_Object tail, frame;
11109 FOR_EACH_FRAME (tail, frame)
11111 struct frame *f = XFRAME (frame);
11113 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11115 if (f->resized_p)
11116 redraw_frame (f);
11117 else
11118 clear_current_matrices (f);
11119 fset_redisplay (f);
11120 f->garbaged = false;
11121 f->resized_p = false;
11125 frame_garbaged = false;
11130 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P,
11131 update selected_frame. Value is true if the mini-windows height
11132 has been changed. */
11134 static bool
11135 echo_area_display (bool update_frame_p)
11137 Lisp_Object mini_window;
11138 struct window *w;
11139 struct frame *f;
11140 bool window_height_changed_p = false;
11141 struct frame *sf = SELECTED_FRAME ();
11143 mini_window = FRAME_MINIBUF_WINDOW (sf);
11144 w = XWINDOW (mini_window);
11145 f = XFRAME (WINDOW_FRAME (w));
11147 /* Don't display if frame is invisible or not yet initialized. */
11148 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11149 return false;
11151 #ifdef HAVE_WINDOW_SYSTEM
11152 /* When Emacs starts, selected_frame may be the initial terminal
11153 frame. If we let this through, a message would be displayed on
11154 the terminal. */
11155 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11156 return false;
11157 #endif /* HAVE_WINDOW_SYSTEM */
11159 /* Redraw garbaged frames. */
11160 clear_garbaged_frames ();
11162 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11164 echo_area_window = mini_window;
11165 window_height_changed_p = display_echo_area (w);
11166 w->must_be_updated_p = true;
11168 /* Update the display, unless called from redisplay_internal.
11169 Also don't update the screen during redisplay itself. The
11170 update will happen at the end of redisplay, and an update
11171 here could cause confusion. */
11172 if (update_frame_p && !redisplaying_p)
11174 int n = 0;
11176 /* If the display update has been interrupted by pending
11177 input, update mode lines in the frame. Due to the
11178 pending input, it might have been that redisplay hasn't
11179 been called, so that mode lines above the echo area are
11180 garbaged. This looks odd, so we prevent it here. */
11181 if (!display_completed)
11182 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11184 if (window_height_changed_p
11185 /* Don't do this if Emacs is shutting down. Redisplay
11186 needs to run hooks. */
11187 && !NILP (Vrun_hooks))
11189 /* Must update other windows. Likewise as in other
11190 cases, don't let this update be interrupted by
11191 pending input. */
11192 ptrdiff_t count = SPECPDL_INDEX ();
11193 specbind (Qredisplay_dont_pause, Qt);
11194 windows_or_buffers_changed = 44;
11195 redisplay_internal ();
11196 unbind_to (count, Qnil);
11198 else if (FRAME_WINDOW_P (f) && n == 0)
11200 /* Window configuration is the same as before.
11201 Can do with a display update of the echo area,
11202 unless we displayed some mode lines. */
11203 update_single_window (w);
11204 flush_frame (f);
11206 else
11207 update_frame (f, true, true);
11209 /* If cursor is in the echo area, make sure that the next
11210 redisplay displays the minibuffer, so that the cursor will
11211 be replaced with what the minibuffer wants. */
11212 if (cursor_in_echo_area)
11213 wset_redisplay (XWINDOW (mini_window));
11216 else if (!EQ (mini_window, selected_window))
11217 wset_redisplay (XWINDOW (mini_window));
11219 /* Last displayed message is now the current message. */
11220 echo_area_buffer[1] = echo_area_buffer[0];
11221 /* Inform read_char that we're not echoing. */
11222 echo_message_buffer = Qnil;
11224 /* Prevent redisplay optimization in redisplay_internal by resetting
11225 this_line_start_pos. This is done because the mini-buffer now
11226 displays the message instead of its buffer text. */
11227 if (EQ (mini_window, selected_window))
11228 CHARPOS (this_line_start_pos) = 0;
11230 return window_height_changed_p;
11233 /* True if W's buffer was changed but not saved. */
11235 static bool
11236 window_buffer_changed (struct window *w)
11238 struct buffer *b = XBUFFER (w->contents);
11240 eassert (BUFFER_LIVE_P (b));
11242 return (BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star;
11245 /* True if W has %c in its mode line and mode line should be updated. */
11247 static bool
11248 mode_line_update_needed (struct window *w)
11250 return (w->column_number_displayed != -1
11251 && !(PT == w->last_point && !window_outdated (w))
11252 && (w->column_number_displayed != current_column ()));
11255 /* True if window start of W is frozen and may not be changed during
11256 redisplay. */
11258 static bool
11259 window_frozen_p (struct window *w)
11261 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11263 Lisp_Object window;
11265 XSETWINDOW (window, w);
11266 if (MINI_WINDOW_P (w))
11267 return false;
11268 else if (EQ (window, selected_window))
11269 return false;
11270 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11271 && EQ (window, Vminibuf_scroll_window))
11272 /* This special window can't be frozen too. */
11273 return false;
11274 else
11275 return true;
11277 return false;
11280 /***********************************************************************
11281 Mode Lines and Frame Titles
11282 ***********************************************************************/
11284 /* A buffer for constructing non-propertized mode-line strings and
11285 frame titles in it; allocated from the heap in init_xdisp and
11286 resized as needed in store_mode_line_noprop_char. */
11288 static char *mode_line_noprop_buf;
11290 /* The buffer's end, and a current output position in it. */
11292 static char *mode_line_noprop_buf_end;
11293 static char *mode_line_noprop_ptr;
11295 #define MODE_LINE_NOPROP_LEN(start) \
11296 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11298 static enum {
11299 MODE_LINE_DISPLAY = 0,
11300 MODE_LINE_TITLE,
11301 MODE_LINE_NOPROP,
11302 MODE_LINE_STRING
11303 } mode_line_target;
11305 /* Alist that caches the results of :propertize.
11306 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11307 static Lisp_Object mode_line_proptrans_alist;
11309 /* List of strings making up the mode-line. */
11310 static Lisp_Object mode_line_string_list;
11312 /* Base face property when building propertized mode line string. */
11313 static Lisp_Object mode_line_string_face;
11314 static Lisp_Object mode_line_string_face_prop;
11317 /* Unwind data for mode line strings */
11319 static Lisp_Object Vmode_line_unwind_vector;
11321 static Lisp_Object
11322 format_mode_line_unwind_data (struct frame *target_frame,
11323 struct buffer *obuf,
11324 Lisp_Object owin,
11325 bool save_proptrans)
11327 Lisp_Object vector, tmp;
11329 /* Reduce consing by keeping one vector in
11330 Vwith_echo_area_save_vector. */
11331 vector = Vmode_line_unwind_vector;
11332 Vmode_line_unwind_vector = Qnil;
11334 if (NILP (vector))
11335 vector = Fmake_vector (make_number (10), Qnil);
11337 ASET (vector, 0, make_number (mode_line_target));
11338 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11339 ASET (vector, 2, mode_line_string_list);
11340 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11341 ASET (vector, 4, mode_line_string_face);
11342 ASET (vector, 5, mode_line_string_face_prop);
11344 if (obuf)
11345 XSETBUFFER (tmp, obuf);
11346 else
11347 tmp = Qnil;
11348 ASET (vector, 6, tmp);
11349 ASET (vector, 7, owin);
11350 if (target_frame)
11352 /* Similarly to `with-selected-window', if the operation selects
11353 a window on another frame, we must restore that frame's
11354 selected window, and (for a tty) the top-frame. */
11355 ASET (vector, 8, target_frame->selected_window);
11356 if (FRAME_TERMCAP_P (target_frame))
11357 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11360 return vector;
11363 static void
11364 unwind_format_mode_line (Lisp_Object vector)
11366 Lisp_Object old_window = AREF (vector, 7);
11367 Lisp_Object target_frame_window = AREF (vector, 8);
11368 Lisp_Object old_top_frame = AREF (vector, 9);
11370 mode_line_target = XINT (AREF (vector, 0));
11371 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11372 mode_line_string_list = AREF (vector, 2);
11373 if (! EQ (AREF (vector, 3), Qt))
11374 mode_line_proptrans_alist = AREF (vector, 3);
11375 mode_line_string_face = AREF (vector, 4);
11376 mode_line_string_face_prop = AREF (vector, 5);
11378 /* Select window before buffer, since it may change the buffer. */
11379 if (!NILP (old_window))
11381 /* If the operation that we are unwinding had selected a window
11382 on a different frame, reset its frame-selected-window. For a
11383 text terminal, reset its top-frame if necessary. */
11384 if (!NILP (target_frame_window))
11386 Lisp_Object frame
11387 = WINDOW_FRAME (XWINDOW (target_frame_window));
11389 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11390 Fselect_window (target_frame_window, Qt);
11392 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11393 Fselect_frame (old_top_frame, Qt);
11396 Fselect_window (old_window, Qt);
11399 if (!NILP (AREF (vector, 6)))
11401 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11402 ASET (vector, 6, Qnil);
11405 Vmode_line_unwind_vector = vector;
11409 /* Store a single character C for the frame title in mode_line_noprop_buf.
11410 Re-allocate mode_line_noprop_buf if necessary. */
11412 static void
11413 store_mode_line_noprop_char (char c)
11415 /* If output position has reached the end of the allocated buffer,
11416 increase the buffer's size. */
11417 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11419 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11420 ptrdiff_t size = len;
11421 mode_line_noprop_buf =
11422 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11423 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11424 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11427 *mode_line_noprop_ptr++ = c;
11431 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11432 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11433 characters that yield more columns than PRECISION; PRECISION <= 0
11434 means copy the whole string. Pad with spaces until FIELD_WIDTH
11435 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11436 pad. Called from display_mode_element when it is used to build a
11437 frame title. */
11439 static int
11440 store_mode_line_noprop (const char *string, int field_width, int precision)
11442 const unsigned char *str = (const unsigned char *) string;
11443 int n = 0;
11444 ptrdiff_t dummy, nbytes;
11446 /* Copy at most PRECISION chars from STR. */
11447 nbytes = strlen (string);
11448 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11449 while (nbytes--)
11450 store_mode_line_noprop_char (*str++);
11452 /* Fill up with spaces until FIELD_WIDTH reached. */
11453 while (field_width > 0
11454 && n < field_width)
11456 store_mode_line_noprop_char (' ');
11457 ++n;
11460 return n;
11463 /***********************************************************************
11464 Frame Titles
11465 ***********************************************************************/
11467 #ifdef HAVE_WINDOW_SYSTEM
11469 /* Set the title of FRAME, if it has changed. The title format is
11470 Vicon_title_format if FRAME is iconified, otherwise it is
11471 frame_title_format. */
11473 static void
11474 x_consider_frame_title (Lisp_Object frame)
11476 struct frame *f = XFRAME (frame);
11478 if (FRAME_WINDOW_P (f)
11479 || FRAME_MINIBUF_ONLY_P (f)
11480 || f->explicit_name)
11482 /* Do we have more than one visible frame on this X display? */
11483 Lisp_Object tail, other_frame, fmt;
11484 ptrdiff_t title_start;
11485 char *title;
11486 ptrdiff_t len;
11487 struct it it;
11488 ptrdiff_t count = SPECPDL_INDEX ();
11490 FOR_EACH_FRAME (tail, other_frame)
11492 struct frame *tf = XFRAME (other_frame);
11494 if (tf != f
11495 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11496 && !FRAME_MINIBUF_ONLY_P (tf)
11497 && !EQ (other_frame, tip_frame)
11498 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11499 break;
11502 /* Set global variable indicating that multiple frames exist. */
11503 multiple_frames = CONSP (tail);
11505 /* Switch to the buffer of selected window of the frame. Set up
11506 mode_line_target so that display_mode_element will output into
11507 mode_line_noprop_buf; then display the title. */
11508 record_unwind_protect (unwind_format_mode_line,
11509 format_mode_line_unwind_data
11510 (f, current_buffer, selected_window, false));
11512 Fselect_window (f->selected_window, Qt);
11513 set_buffer_internal_1
11514 (XBUFFER (XWINDOW (f->selected_window)->contents));
11515 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11517 mode_line_target = MODE_LINE_TITLE;
11518 title_start = MODE_LINE_NOPROP_LEN (0);
11519 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11520 NULL, DEFAULT_FACE_ID);
11521 display_mode_element (&it, 0, -1, -1, fmt, Qnil, false);
11522 len = MODE_LINE_NOPROP_LEN (title_start);
11523 title = mode_line_noprop_buf + title_start;
11524 unbind_to (count, Qnil);
11526 /* Set the title only if it's changed. This avoids consing in
11527 the common case where it hasn't. (If it turns out that we've
11528 already wasted too much time by walking through the list with
11529 display_mode_element, then we might need to optimize at a
11530 higher level than this.) */
11531 if (! STRINGP (f->name)
11532 || SBYTES (f->name) != len
11533 || memcmp (title, SDATA (f->name), len) != 0)
11534 x_implicitly_set_name (f, make_string (title, len), Qnil);
11538 #endif /* not HAVE_WINDOW_SYSTEM */
11541 /***********************************************************************
11542 Menu Bars
11543 ***********************************************************************/
11545 /* True if we will not redisplay all visible windows. */
11546 #define REDISPLAY_SOME_P() \
11547 ((windows_or_buffers_changed == 0 \
11548 || windows_or_buffers_changed == REDISPLAY_SOME) \
11549 && (update_mode_lines == 0 \
11550 || update_mode_lines == REDISPLAY_SOME))
11552 /* Prepare for redisplay by updating menu-bar item lists when
11553 appropriate. This can call eval. */
11555 static void
11556 prepare_menu_bars (void)
11558 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11559 bool some_windows = REDISPLAY_SOME_P ();
11560 struct gcpro gcpro1, gcpro2;
11561 Lisp_Object tooltip_frame;
11563 #ifdef HAVE_WINDOW_SYSTEM
11564 tooltip_frame = tip_frame;
11565 #else
11566 tooltip_frame = Qnil;
11567 #endif
11569 if (FUNCTIONP (Vpre_redisplay_function))
11571 Lisp_Object windows = all_windows ? Qt : Qnil;
11572 if (all_windows && some_windows)
11574 Lisp_Object ws = window_list ();
11575 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11577 Lisp_Object this = XCAR (ws);
11578 struct window *w = XWINDOW (this);
11579 if (w->redisplay
11580 || XFRAME (w->frame)->redisplay
11581 || XBUFFER (w->contents)->text->redisplay)
11583 windows = Fcons (this, windows);
11587 safe__call1 (true, Vpre_redisplay_function, windows);
11590 /* Update all frame titles based on their buffer names, etc. We do
11591 this before the menu bars so that the buffer-menu will show the
11592 up-to-date frame titles. */
11593 #ifdef HAVE_WINDOW_SYSTEM
11594 if (all_windows)
11596 Lisp_Object tail, frame;
11598 FOR_EACH_FRAME (tail, frame)
11600 struct frame *f = XFRAME (frame);
11601 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11602 if (some_windows
11603 && !f->redisplay
11604 && !w->redisplay
11605 && !XBUFFER (w->contents)->text->redisplay)
11606 continue;
11608 if (!EQ (frame, tooltip_frame)
11609 && (FRAME_ICONIFIED_P (f)
11610 || FRAME_VISIBLE_P (f) == 1
11611 /* Exclude TTY frames that are obscured because they
11612 are not the top frame on their console. This is
11613 because x_consider_frame_title actually switches
11614 to the frame, which for TTY frames means it is
11615 marked as garbaged, and will be completely
11616 redrawn on the next redisplay cycle. This causes
11617 TTY frames to be completely redrawn, when there
11618 are more than one of them, even though nothing
11619 should be changed on display. */
11620 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11621 x_consider_frame_title (frame);
11624 #endif /* HAVE_WINDOW_SYSTEM */
11626 /* Update the menu bar item lists, if appropriate. This has to be
11627 done before any actual redisplay or generation of display lines. */
11629 if (all_windows)
11631 Lisp_Object tail, frame;
11632 ptrdiff_t count = SPECPDL_INDEX ();
11633 /* True means that update_menu_bar has run its hooks
11634 so any further calls to update_menu_bar shouldn't do so again. */
11635 bool menu_bar_hooks_run = false;
11637 record_unwind_save_match_data ();
11639 FOR_EACH_FRAME (tail, frame)
11641 struct frame *f = XFRAME (frame);
11642 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11644 /* Ignore tooltip frame. */
11645 if (EQ (frame, tooltip_frame))
11646 continue;
11648 if (some_windows
11649 && !f->redisplay
11650 && !w->redisplay
11651 && !XBUFFER (w->contents)->text->redisplay)
11652 continue;
11654 /* If a window on this frame changed size, report that to
11655 the user and clear the size-change flag. */
11656 if (FRAME_WINDOW_SIZES_CHANGED (f))
11658 Lisp_Object functions;
11660 /* Clear flag first in case we get an error below. */
11661 FRAME_WINDOW_SIZES_CHANGED (f) = false;
11662 functions = Vwindow_size_change_functions;
11663 GCPRO2 (tail, functions);
11665 while (CONSP (functions))
11667 if (!EQ (XCAR (functions), Qt))
11668 call1 (XCAR (functions), frame);
11669 functions = XCDR (functions);
11671 UNGCPRO;
11674 GCPRO1 (tail);
11675 menu_bar_hooks_run = update_menu_bar (f, false, menu_bar_hooks_run);
11676 #ifdef HAVE_WINDOW_SYSTEM
11677 update_tool_bar (f, false);
11678 #endif
11679 UNGCPRO;
11682 unbind_to (count, Qnil);
11684 else
11686 struct frame *sf = SELECTED_FRAME ();
11687 update_menu_bar (sf, true, false);
11688 #ifdef HAVE_WINDOW_SYSTEM
11689 update_tool_bar (sf, true);
11690 #endif
11695 /* Update the menu bar item list for frame F. This has to be done
11696 before we start to fill in any display lines, because it can call
11697 eval.
11699 If SAVE_MATCH_DATA, we must save and restore it here.
11701 If HOOKS_RUN, a previous call to update_menu_bar
11702 already ran the menu bar hooks for this redisplay, so there
11703 is no need to run them again. The return value is the
11704 updated value of this flag, to pass to the next call. */
11706 static bool
11707 update_menu_bar (struct frame *f, bool save_match_data, bool hooks_run)
11709 Lisp_Object window;
11710 struct window *w;
11712 /* If called recursively during a menu update, do nothing. This can
11713 happen when, for instance, an activate-menubar-hook causes a
11714 redisplay. */
11715 if (inhibit_menubar_update)
11716 return hooks_run;
11718 window = FRAME_SELECTED_WINDOW (f);
11719 w = XWINDOW (window);
11721 if (FRAME_WINDOW_P (f)
11723 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11724 || defined (HAVE_NS) || defined (USE_GTK)
11725 FRAME_EXTERNAL_MENU_BAR (f)
11726 #else
11727 FRAME_MENU_BAR_LINES (f) > 0
11728 #endif
11729 : FRAME_MENU_BAR_LINES (f) > 0)
11731 /* If the user has switched buffers or windows, we need to
11732 recompute to reflect the new bindings. But we'll
11733 recompute when update_mode_lines is set too; that means
11734 that people can use force-mode-line-update to request
11735 that the menu bar be recomputed. The adverse effect on
11736 the rest of the redisplay algorithm is about the same as
11737 windows_or_buffers_changed anyway. */
11738 if (windows_or_buffers_changed
11739 /* This used to test w->update_mode_line, but we believe
11740 there is no need to recompute the menu in that case. */
11741 || update_mode_lines
11742 || window_buffer_changed (w))
11744 struct buffer *prev = current_buffer;
11745 ptrdiff_t count = SPECPDL_INDEX ();
11747 specbind (Qinhibit_menubar_update, Qt);
11749 set_buffer_internal_1 (XBUFFER (w->contents));
11750 if (save_match_data)
11751 record_unwind_save_match_data ();
11752 if (NILP (Voverriding_local_map_menu_flag))
11754 specbind (Qoverriding_terminal_local_map, Qnil);
11755 specbind (Qoverriding_local_map, Qnil);
11758 if (!hooks_run)
11760 /* Run the Lucid hook. */
11761 safe_run_hooks (Qactivate_menubar_hook);
11763 /* If it has changed current-menubar from previous value,
11764 really recompute the menu-bar from the value. */
11765 if (! NILP (Vlucid_menu_bar_dirty_flag))
11766 call0 (Qrecompute_lucid_menubar);
11768 safe_run_hooks (Qmenu_bar_update_hook);
11770 hooks_run = true;
11773 XSETFRAME (Vmenu_updating_frame, f);
11774 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11776 /* Redisplay the menu bar in case we changed it. */
11777 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11778 || defined (HAVE_NS) || defined (USE_GTK)
11779 if (FRAME_WINDOW_P (f))
11781 #if defined (HAVE_NS)
11782 /* All frames on Mac OS share the same menubar. So only
11783 the selected frame should be allowed to set it. */
11784 if (f == SELECTED_FRAME ())
11785 #endif
11786 set_frame_menubar (f, false, false);
11788 else
11789 /* On a terminal screen, the menu bar is an ordinary screen
11790 line, and this makes it get updated. */
11791 w->update_mode_line = true;
11792 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11793 /* In the non-toolkit version, the menu bar is an ordinary screen
11794 line, and this makes it get updated. */
11795 w->update_mode_line = true;
11796 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11798 unbind_to (count, Qnil);
11799 set_buffer_internal_1 (prev);
11803 return hooks_run;
11806 /***********************************************************************
11807 Tool-bars
11808 ***********************************************************************/
11810 #ifdef HAVE_WINDOW_SYSTEM
11812 /* Select `frame' temporarily without running all the code in
11813 do_switch_frame.
11814 FIXME: Maybe do_switch_frame should be trimmed down similarly
11815 when `norecord' is set. */
11816 static void
11817 fast_set_selected_frame (Lisp_Object frame)
11819 if (!EQ (selected_frame, frame))
11821 selected_frame = frame;
11822 selected_window = XFRAME (frame)->selected_window;
11826 /* Update the tool-bar item list for frame F. This has to be done
11827 before we start to fill in any display lines. Called from
11828 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11829 and restore it here. */
11831 static void
11832 update_tool_bar (struct frame *f, bool save_match_data)
11834 #if defined (USE_GTK) || defined (HAVE_NS)
11835 bool do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11836 #else
11837 bool do_update = (WINDOWP (f->tool_bar_window)
11838 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0);
11839 #endif
11841 if (do_update)
11843 Lisp_Object window;
11844 struct window *w;
11846 window = FRAME_SELECTED_WINDOW (f);
11847 w = XWINDOW (window);
11849 /* If the user has switched buffers or windows, we need to
11850 recompute to reflect the new bindings. But we'll
11851 recompute when update_mode_lines is set too; that means
11852 that people can use force-mode-line-update to request
11853 that the menu bar be recomputed. The adverse effect on
11854 the rest of the redisplay algorithm is about the same as
11855 windows_or_buffers_changed anyway. */
11856 if (windows_or_buffers_changed
11857 || w->update_mode_line
11858 || update_mode_lines
11859 || window_buffer_changed (w))
11861 struct buffer *prev = current_buffer;
11862 ptrdiff_t count = SPECPDL_INDEX ();
11863 Lisp_Object frame, new_tool_bar;
11864 int new_n_tool_bar;
11865 struct gcpro gcpro1;
11867 /* Set current_buffer to the buffer of the selected
11868 window of the frame, so that we get the right local
11869 keymaps. */
11870 set_buffer_internal_1 (XBUFFER (w->contents));
11872 /* Save match data, if we must. */
11873 if (save_match_data)
11874 record_unwind_save_match_data ();
11876 /* Make sure that we don't accidentally use bogus keymaps. */
11877 if (NILP (Voverriding_local_map_menu_flag))
11879 specbind (Qoverriding_terminal_local_map, Qnil);
11880 specbind (Qoverriding_local_map, Qnil);
11883 GCPRO1 (new_tool_bar);
11885 /* We must temporarily set the selected frame to this frame
11886 before calling tool_bar_items, because the calculation of
11887 the tool-bar keymap uses the selected frame (see
11888 `tool-bar-make-keymap' in tool-bar.el). */
11889 eassert (EQ (selected_window,
11890 /* Since we only explicitly preserve selected_frame,
11891 check that selected_window would be redundant. */
11892 XFRAME (selected_frame)->selected_window));
11893 record_unwind_protect (fast_set_selected_frame, selected_frame);
11894 XSETFRAME (frame, f);
11895 fast_set_selected_frame (frame);
11897 /* Build desired tool-bar items from keymaps. */
11898 new_tool_bar
11899 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
11900 &new_n_tool_bar);
11902 /* Redisplay the tool-bar if we changed it. */
11903 if (new_n_tool_bar != f->n_tool_bar_items
11904 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
11906 /* Redisplay that happens asynchronously due to an expose event
11907 may access f->tool_bar_items. Make sure we update both
11908 variables within BLOCK_INPUT so no such event interrupts. */
11909 block_input ();
11910 fset_tool_bar_items (f, new_tool_bar);
11911 f->n_tool_bar_items = new_n_tool_bar;
11912 w->update_mode_line = true;
11913 unblock_input ();
11916 UNGCPRO;
11918 unbind_to (count, Qnil);
11919 set_buffer_internal_1 (prev);
11924 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11926 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11927 F's desired tool-bar contents. F->tool_bar_items must have
11928 been set up previously by calling prepare_menu_bars. */
11930 static void
11931 build_desired_tool_bar_string (struct frame *f)
11933 int i, size, size_needed;
11934 struct gcpro gcpro1, gcpro2;
11935 Lisp_Object image, plist;
11937 image = plist = Qnil;
11938 GCPRO2 (image, plist);
11940 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11941 Otherwise, make a new string. */
11943 /* The size of the string we might be able to reuse. */
11944 size = (STRINGP (f->desired_tool_bar_string)
11945 ? SCHARS (f->desired_tool_bar_string)
11946 : 0);
11948 /* We need one space in the string for each image. */
11949 size_needed = f->n_tool_bar_items;
11951 /* Reuse f->desired_tool_bar_string, if possible. */
11952 if (size < size_needed || NILP (f->desired_tool_bar_string))
11953 fset_desired_tool_bar_string
11954 (f, Fmake_string (make_number (size_needed), make_number (' ')));
11955 else
11957 AUTO_LIST4 (props, Qdisplay, Qnil, Qmenu_item, Qnil);
11958 struct gcpro gcpro1;
11959 GCPRO1 (props);
11960 Fremove_text_properties (make_number (0), make_number (size),
11961 props, f->desired_tool_bar_string);
11962 UNGCPRO;
11965 /* Put a `display' property on the string for the images to display,
11966 put a `menu_item' property on tool-bar items with a value that
11967 is the index of the item in F's tool-bar item vector. */
11968 for (i = 0; i < f->n_tool_bar_items; ++i)
11970 #define PROP(IDX) \
11971 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11973 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
11974 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
11975 int hmargin, vmargin, relief, idx, end;
11977 /* If image is a vector, choose the image according to the
11978 button state. */
11979 image = PROP (TOOL_BAR_ITEM_IMAGES);
11980 if (VECTORP (image))
11982 if (enabled_p)
11983 idx = (selected_p
11984 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11985 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
11986 else
11987 idx = (selected_p
11988 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11989 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
11991 eassert (ASIZE (image) >= idx);
11992 image = AREF (image, idx);
11994 else
11995 idx = -1;
11997 /* Ignore invalid image specifications. */
11998 if (!valid_image_p (image))
11999 continue;
12001 /* Display the tool-bar button pressed, or depressed. */
12002 plist = Fcopy_sequence (XCDR (image));
12004 /* Compute margin and relief to draw. */
12005 relief = (tool_bar_button_relief >= 0
12006 ? tool_bar_button_relief
12007 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12008 hmargin = vmargin = relief;
12010 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12011 INT_MAX - max (hmargin, vmargin)))
12013 hmargin += XFASTINT (Vtool_bar_button_margin);
12014 vmargin += XFASTINT (Vtool_bar_button_margin);
12016 else if (CONSP (Vtool_bar_button_margin))
12018 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12019 INT_MAX - hmargin))
12020 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12022 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12023 INT_MAX - vmargin))
12024 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12027 if (auto_raise_tool_bar_buttons_p)
12029 /* Add a `:relief' property to the image spec if the item is
12030 selected. */
12031 if (selected_p)
12033 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12034 hmargin -= relief;
12035 vmargin -= relief;
12038 else
12040 /* If image is selected, display it pressed, i.e. with a
12041 negative relief. If it's not selected, display it with a
12042 raised relief. */
12043 plist = Fplist_put (plist, QCrelief,
12044 (selected_p
12045 ? make_number (-relief)
12046 : make_number (relief)));
12047 hmargin -= relief;
12048 vmargin -= relief;
12051 /* Put a margin around the image. */
12052 if (hmargin || vmargin)
12054 if (hmargin == vmargin)
12055 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12056 else
12057 plist = Fplist_put (plist, QCmargin,
12058 Fcons (make_number (hmargin),
12059 make_number (vmargin)));
12062 /* If button is not enabled, and we don't have special images
12063 for the disabled state, make the image appear disabled by
12064 applying an appropriate algorithm to it. */
12065 if (!enabled_p && idx < 0)
12066 plist = Fplist_put (plist, QCconversion, Qdisabled);
12068 /* Put a `display' text property on the string for the image to
12069 display. Put a `menu-item' property on the string that gives
12070 the start of this item's properties in the tool-bar items
12071 vector. */
12072 image = Fcons (Qimage, plist);
12073 AUTO_LIST4 (props, Qdisplay, image, Qmenu_item,
12074 make_number (i * TOOL_BAR_ITEM_NSLOTS));
12075 struct gcpro gcpro1;
12076 GCPRO1 (props);
12078 /* Let the last image hide all remaining spaces in the tool bar
12079 string. The string can be longer than needed when we reuse a
12080 previous string. */
12081 if (i + 1 == f->n_tool_bar_items)
12082 end = SCHARS (f->desired_tool_bar_string);
12083 else
12084 end = i + 1;
12085 Fadd_text_properties (make_number (i), make_number (end),
12086 props, f->desired_tool_bar_string);
12087 UNGCPRO;
12088 #undef PROP
12091 UNGCPRO;
12095 /* Display one line of the tool-bar of frame IT->f.
12097 HEIGHT specifies the desired height of the tool-bar line.
12098 If the actual height of the glyph row is less than HEIGHT, the
12099 row's height is increased to HEIGHT, and the icons are centered
12100 vertically in the new height.
12102 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12103 count a final empty row in case the tool-bar width exactly matches
12104 the window width.
12107 static void
12108 display_tool_bar_line (struct it *it, int height)
12110 struct glyph_row *row = it->glyph_row;
12111 int max_x = it->last_visible_x;
12112 struct glyph *last;
12114 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12115 clear_glyph_row (row);
12116 row->enabled_p = true;
12117 row->y = it->current_y;
12119 /* Note that this isn't made use of if the face hasn't a box,
12120 so there's no need to check the face here. */
12121 it->start_of_box_run_p = true;
12123 while (it->current_x < max_x)
12125 int x, n_glyphs_before, i, nglyphs;
12126 struct it it_before;
12128 /* Get the next display element. */
12129 if (!get_next_display_element (it))
12131 /* Don't count empty row if we are counting needed tool-bar lines. */
12132 if (height < 0 && !it->hpos)
12133 return;
12134 break;
12137 /* Produce glyphs. */
12138 n_glyphs_before = row->used[TEXT_AREA];
12139 it_before = *it;
12141 PRODUCE_GLYPHS (it);
12143 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12144 i = 0;
12145 x = it_before.current_x;
12146 while (i < nglyphs)
12148 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12150 if (x + glyph->pixel_width > max_x)
12152 /* Glyph doesn't fit on line. Backtrack. */
12153 row->used[TEXT_AREA] = n_glyphs_before;
12154 *it = it_before;
12155 /* If this is the only glyph on this line, it will never fit on the
12156 tool-bar, so skip it. But ensure there is at least one glyph,
12157 so we don't accidentally disable the tool-bar. */
12158 if (n_glyphs_before == 0
12159 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12160 break;
12161 goto out;
12164 ++it->hpos;
12165 x += glyph->pixel_width;
12166 ++i;
12169 /* Stop at line end. */
12170 if (ITERATOR_AT_END_OF_LINE_P (it))
12171 break;
12173 set_iterator_to_next (it, true);
12176 out:;
12178 row->displays_text_p = row->used[TEXT_AREA] != 0;
12180 /* Use default face for the border below the tool bar.
12182 FIXME: When auto-resize-tool-bars is grow-only, there is
12183 no additional border below the possibly empty tool-bar lines.
12184 So to make the extra empty lines look "normal", we have to
12185 use the tool-bar face for the border too. */
12186 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12187 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12188 it->face_id = DEFAULT_FACE_ID;
12190 extend_face_to_end_of_line (it);
12191 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12192 last->right_box_line_p = true;
12193 if (last == row->glyphs[TEXT_AREA])
12194 last->left_box_line_p = true;
12196 /* Make line the desired height and center it vertically. */
12197 if ((height -= it->max_ascent + it->max_descent) > 0)
12199 /* Don't add more than one line height. */
12200 height %= FRAME_LINE_HEIGHT (it->f);
12201 it->max_ascent += height / 2;
12202 it->max_descent += (height + 1) / 2;
12205 compute_line_metrics (it);
12207 /* If line is empty, make it occupy the rest of the tool-bar. */
12208 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12210 row->height = row->phys_height = it->last_visible_y - row->y;
12211 row->visible_height = row->height;
12212 row->ascent = row->phys_ascent = 0;
12213 row->extra_line_spacing = 0;
12216 row->full_width_p = true;
12217 row->continued_p = false;
12218 row->truncated_on_left_p = false;
12219 row->truncated_on_right_p = false;
12221 it->current_x = it->hpos = 0;
12222 it->current_y += row->height;
12223 ++it->vpos;
12224 ++it->glyph_row;
12228 /* Value is the number of pixels needed to make all tool-bar items of
12229 frame F visible. The actual number of glyph rows needed is
12230 returned in *N_ROWS if non-NULL. */
12231 static int
12232 tool_bar_height (struct frame *f, int *n_rows, bool pixelwise)
12234 struct window *w = XWINDOW (f->tool_bar_window);
12235 struct it it;
12236 /* tool_bar_height is called from redisplay_tool_bar after building
12237 the desired matrix, so use (unused) mode-line row as temporary row to
12238 avoid destroying the first tool-bar row. */
12239 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
12241 /* Initialize an iterator for iteration over
12242 F->desired_tool_bar_string in the tool-bar window of frame F. */
12243 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
12244 temp_row->reversed_p = false;
12245 it.first_visible_x = 0;
12246 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12247 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12248 it.paragraph_embedding = L2R;
12250 while (!ITERATOR_AT_END_P (&it))
12252 clear_glyph_row (temp_row);
12253 it.glyph_row = temp_row;
12254 display_tool_bar_line (&it, -1);
12256 clear_glyph_row (temp_row);
12258 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12259 if (n_rows)
12260 *n_rows = it.vpos > 0 ? it.vpos : -1;
12262 if (pixelwise)
12263 return it.current_y;
12264 else
12265 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12268 #endif /* !USE_GTK && !HAVE_NS */
12270 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12271 0, 2, 0,
12272 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12273 If FRAME is nil or omitted, use the selected frame. Optional argument
12274 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12275 (Lisp_Object frame, Lisp_Object pixelwise)
12277 int height = 0;
12279 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12280 struct frame *f = decode_any_frame (frame);
12282 if (WINDOWP (f->tool_bar_window)
12283 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12285 update_tool_bar (f, true);
12286 if (f->n_tool_bar_items)
12288 build_desired_tool_bar_string (f);
12289 height = tool_bar_height (f, NULL, !NILP (pixelwise));
12292 #endif
12294 return make_number (height);
12298 /* Display the tool-bar of frame F. Value is true if tool-bar's
12299 height should be changed. */
12300 static bool
12301 redisplay_tool_bar (struct frame *f)
12303 #if defined (USE_GTK) || defined (HAVE_NS)
12305 if (FRAME_EXTERNAL_TOOL_BAR (f))
12306 update_frame_tool_bar (f);
12307 return false;
12309 #else /* !USE_GTK && !HAVE_NS */
12311 struct window *w;
12312 struct it it;
12313 struct glyph_row *row;
12315 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12316 do anything. This means you must start with tool-bar-lines
12317 non-zero to get the auto-sizing effect. Or in other words, you
12318 can turn off tool-bars by specifying tool-bar-lines zero. */
12319 if (!WINDOWP (f->tool_bar_window)
12320 || (w = XWINDOW (f->tool_bar_window),
12321 WINDOW_TOTAL_LINES (w) == 0))
12322 return false;
12324 /* Set up an iterator for the tool-bar window. */
12325 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12326 it.first_visible_x = 0;
12327 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12328 row = it.glyph_row;
12329 row->reversed_p = false;
12331 /* Build a string that represents the contents of the tool-bar. */
12332 build_desired_tool_bar_string (f);
12333 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12334 /* FIXME: This should be controlled by a user option. But it
12335 doesn't make sense to have an R2L tool bar if the menu bar cannot
12336 be drawn also R2L, and making the menu bar R2L is tricky due
12337 toolkit-specific code that implements it. If an R2L tool bar is
12338 ever supported, display_tool_bar_line should also be augmented to
12339 call unproduce_glyphs like display_line and display_string
12340 do. */
12341 it.paragraph_embedding = L2R;
12343 if (f->n_tool_bar_rows == 0)
12345 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, true);
12347 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12349 x_change_tool_bar_height (f, new_height);
12350 frame_default_tool_bar_height = new_height;
12351 /* Always do that now. */
12352 clear_glyph_matrix (w->desired_matrix);
12353 f->fonts_changed = true;
12354 return true;
12358 /* Display as many lines as needed to display all tool-bar items. */
12360 if (f->n_tool_bar_rows > 0)
12362 int border, rows, height, extra;
12364 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12365 border = XINT (Vtool_bar_border);
12366 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12367 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12368 else if (EQ (Vtool_bar_border, Qborder_width))
12369 border = f->border_width;
12370 else
12371 border = 0;
12372 if (border < 0)
12373 border = 0;
12375 rows = f->n_tool_bar_rows;
12376 height = max (1, (it.last_visible_y - border) / rows);
12377 extra = it.last_visible_y - border - height * rows;
12379 while (it.current_y < it.last_visible_y)
12381 int h = 0;
12382 if (extra > 0 && rows-- > 0)
12384 h = (extra + rows - 1) / rows;
12385 extra -= h;
12387 display_tool_bar_line (&it, height + h);
12390 else
12392 while (it.current_y < it.last_visible_y)
12393 display_tool_bar_line (&it, 0);
12396 /* It doesn't make much sense to try scrolling in the tool-bar
12397 window, so don't do it. */
12398 w->desired_matrix->no_scrolling_p = true;
12399 w->must_be_updated_p = true;
12401 if (!NILP (Vauto_resize_tool_bars))
12403 bool change_height_p = true;
12405 /* If we couldn't display everything, change the tool-bar's
12406 height if there is room for more. */
12407 if (IT_STRING_CHARPOS (it) < it.end_charpos)
12408 change_height_p = true;
12410 /* We subtract 1 because display_tool_bar_line advances the
12411 glyph_row pointer before returning to its caller. We want to
12412 examine the last glyph row produced by
12413 display_tool_bar_line. */
12414 row = it.glyph_row - 1;
12416 /* If there are blank lines at the end, except for a partially
12417 visible blank line at the end that is smaller than
12418 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12419 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12420 && row->height >= FRAME_LINE_HEIGHT (f))
12421 change_height_p = true;
12423 /* If row displays tool-bar items, but is partially visible,
12424 change the tool-bar's height. */
12425 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12426 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y)
12427 change_height_p = true;
12429 /* Resize windows as needed by changing the `tool-bar-lines'
12430 frame parameter. */
12431 if (change_height_p)
12433 int nrows;
12434 int new_height = tool_bar_height (f, &nrows, true);
12436 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12437 && !f->minimize_tool_bar_window_p)
12438 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12439 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12440 f->minimize_tool_bar_window_p = false;
12442 if (change_height_p)
12444 x_change_tool_bar_height (f, new_height);
12445 frame_default_tool_bar_height = new_height;
12446 clear_glyph_matrix (w->desired_matrix);
12447 f->n_tool_bar_rows = nrows;
12448 f->fonts_changed = true;
12450 return true;
12455 f->minimize_tool_bar_window_p = false;
12456 return false;
12458 #endif /* USE_GTK || HAVE_NS */
12461 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12463 /* Get information about the tool-bar item which is displayed in GLYPH
12464 on frame F. Return in *PROP_IDX the index where tool-bar item
12465 properties start in F->tool_bar_items. Value is false if
12466 GLYPH doesn't display a tool-bar item. */
12468 static bool
12469 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12471 Lisp_Object prop;
12472 int charpos;
12474 /* This function can be called asynchronously, which means we must
12475 exclude any possibility that Fget_text_property signals an
12476 error. */
12477 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12478 charpos = max (0, charpos);
12480 /* Get the text property `menu-item' at pos. The value of that
12481 property is the start index of this item's properties in
12482 F->tool_bar_items. */
12483 prop = Fget_text_property (make_number (charpos),
12484 Qmenu_item, f->current_tool_bar_string);
12485 if (! INTEGERP (prop))
12486 return false;
12487 *prop_idx = XINT (prop);
12488 return true;
12492 /* Get information about the tool-bar item at position X/Y on frame F.
12493 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12494 the current matrix of the tool-bar window of F, or NULL if not
12495 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12496 item in F->tool_bar_items. Value is
12498 -1 if X/Y is not on a tool-bar item
12499 0 if X/Y is on the same item that was highlighted before.
12500 1 otherwise. */
12502 static int
12503 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12504 int *hpos, int *vpos, int *prop_idx)
12506 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12507 struct window *w = XWINDOW (f->tool_bar_window);
12508 int area;
12510 /* Find the glyph under X/Y. */
12511 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12512 if (*glyph == NULL)
12513 return -1;
12515 /* Get the start of this tool-bar item's properties in
12516 f->tool_bar_items. */
12517 if (!tool_bar_item_info (f, *glyph, prop_idx))
12518 return -1;
12520 /* Is mouse on the highlighted item? */
12521 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12522 && *vpos >= hlinfo->mouse_face_beg_row
12523 && *vpos <= hlinfo->mouse_face_end_row
12524 && (*vpos > hlinfo->mouse_face_beg_row
12525 || *hpos >= hlinfo->mouse_face_beg_col)
12526 && (*vpos < hlinfo->mouse_face_end_row
12527 || *hpos < hlinfo->mouse_face_end_col
12528 || hlinfo->mouse_face_past_end))
12529 return 0;
12531 return 1;
12535 /* EXPORT:
12536 Handle mouse button event on the tool-bar of frame F, at
12537 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12538 false for button release. MODIFIERS is event modifiers for button
12539 release. */
12541 void
12542 handle_tool_bar_click (struct frame *f, int x, int y, bool down_p,
12543 int modifiers)
12545 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12546 struct window *w = XWINDOW (f->tool_bar_window);
12547 int hpos, vpos, prop_idx;
12548 struct glyph *glyph;
12549 Lisp_Object enabled_p;
12550 int ts;
12552 /* If not on the highlighted tool-bar item, and mouse-highlight is
12553 non-nil, return. This is so we generate the tool-bar button
12554 click only when the mouse button is released on the same item as
12555 where it was pressed. However, when mouse-highlight is disabled,
12556 generate the click when the button is released regardless of the
12557 highlight, since tool-bar items are not highlighted in that
12558 case. */
12559 frame_to_window_pixel_xy (w, &x, &y);
12560 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12561 if (ts == -1
12562 || (ts != 0 && !NILP (Vmouse_highlight)))
12563 return;
12565 /* When mouse-highlight is off, generate the click for the item
12566 where the button was pressed, disregarding where it was
12567 released. */
12568 if (NILP (Vmouse_highlight) && !down_p)
12569 prop_idx = f->last_tool_bar_item;
12571 /* If item is disabled, do nothing. */
12572 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12573 if (NILP (enabled_p))
12574 return;
12576 if (down_p)
12578 /* Show item in pressed state. */
12579 if (!NILP (Vmouse_highlight))
12580 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12581 f->last_tool_bar_item = prop_idx;
12583 else
12585 Lisp_Object key, frame;
12586 struct input_event event;
12587 EVENT_INIT (event);
12589 /* Show item in released state. */
12590 if (!NILP (Vmouse_highlight))
12591 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12593 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12595 XSETFRAME (frame, f);
12596 event.kind = TOOL_BAR_EVENT;
12597 event.frame_or_window = frame;
12598 event.arg = frame;
12599 kbd_buffer_store_event (&event);
12601 event.kind = TOOL_BAR_EVENT;
12602 event.frame_or_window = frame;
12603 event.arg = key;
12604 event.modifiers = modifiers;
12605 kbd_buffer_store_event (&event);
12606 f->last_tool_bar_item = -1;
12611 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12612 tool-bar window-relative coordinates X/Y. Called from
12613 note_mouse_highlight. */
12615 static void
12616 note_tool_bar_highlight (struct frame *f, int x, int y)
12618 Lisp_Object window = f->tool_bar_window;
12619 struct window *w = XWINDOW (window);
12620 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12621 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12622 int hpos, vpos;
12623 struct glyph *glyph;
12624 struct glyph_row *row;
12625 int i;
12626 Lisp_Object enabled_p;
12627 int prop_idx;
12628 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12629 bool mouse_down_p;
12630 int rc;
12632 /* Function note_mouse_highlight is called with negative X/Y
12633 values when mouse moves outside of the frame. */
12634 if (x <= 0 || y <= 0)
12636 clear_mouse_face (hlinfo);
12637 return;
12640 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12641 if (rc < 0)
12643 /* Not on tool-bar item. */
12644 clear_mouse_face (hlinfo);
12645 return;
12647 else if (rc == 0)
12648 /* On same tool-bar item as before. */
12649 goto set_help_echo;
12651 clear_mouse_face (hlinfo);
12653 /* Mouse is down, but on different tool-bar item? */
12654 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12655 && f == dpyinfo->last_mouse_frame);
12657 if (mouse_down_p && f->last_tool_bar_item != prop_idx)
12658 return;
12660 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12662 /* If tool-bar item is not enabled, don't highlight it. */
12663 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12664 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12666 /* Compute the x-position of the glyph. In front and past the
12667 image is a space. We include this in the highlighted area. */
12668 row = MATRIX_ROW (w->current_matrix, vpos);
12669 for (i = x = 0; i < hpos; ++i)
12670 x += row->glyphs[TEXT_AREA][i].pixel_width;
12672 /* Record this as the current active region. */
12673 hlinfo->mouse_face_beg_col = hpos;
12674 hlinfo->mouse_face_beg_row = vpos;
12675 hlinfo->mouse_face_beg_x = x;
12676 hlinfo->mouse_face_past_end = false;
12678 hlinfo->mouse_face_end_col = hpos + 1;
12679 hlinfo->mouse_face_end_row = vpos;
12680 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12681 hlinfo->mouse_face_window = window;
12682 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12684 /* Display it as active. */
12685 show_mouse_face (hlinfo, draw);
12688 set_help_echo:
12690 /* Set help_echo_string to a help string to display for this tool-bar item.
12691 XTread_socket does the rest. */
12692 help_echo_object = help_echo_window = Qnil;
12693 help_echo_pos = -1;
12694 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12695 if (NILP (help_echo_string))
12696 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12699 #endif /* !USE_GTK && !HAVE_NS */
12701 #endif /* HAVE_WINDOW_SYSTEM */
12705 /************************************************************************
12706 Horizontal scrolling
12707 ************************************************************************/
12709 /* For all leaf windows in the window tree rooted at WINDOW, set their
12710 hscroll value so that PT is (i) visible in the window, and (ii) so
12711 that it is not within a certain margin at the window's left and
12712 right border. Value is true if any window's hscroll has been
12713 changed. */
12715 static bool
12716 hscroll_window_tree (Lisp_Object window)
12718 bool hscrolled_p = false;
12719 bool hscroll_relative_p = FLOATP (Vhscroll_step);
12720 int hscroll_step_abs = 0;
12721 double hscroll_step_rel = 0;
12723 if (hscroll_relative_p)
12725 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12726 if (hscroll_step_rel < 0)
12728 hscroll_relative_p = false;
12729 hscroll_step_abs = 0;
12732 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12734 hscroll_step_abs = XINT (Vhscroll_step);
12735 if (hscroll_step_abs < 0)
12736 hscroll_step_abs = 0;
12738 else
12739 hscroll_step_abs = 0;
12741 while (WINDOWP (window))
12743 struct window *w = XWINDOW (window);
12745 if (WINDOWP (w->contents))
12746 hscrolled_p |= hscroll_window_tree (w->contents);
12747 else if (w->cursor.vpos >= 0)
12749 int h_margin;
12750 int text_area_width;
12751 struct glyph_row *cursor_row;
12752 struct glyph_row *bottom_row;
12754 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12755 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12756 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12757 else
12758 cursor_row = bottom_row - 1;
12760 if (!cursor_row->enabled_p)
12762 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12763 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12764 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12765 else
12766 cursor_row = bottom_row - 1;
12768 bool row_r2l_p = cursor_row->reversed_p;
12770 text_area_width = window_box_width (w, TEXT_AREA);
12772 /* Scroll when cursor is inside this scroll margin. */
12773 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12775 /* If the position of this window's point has explicitly
12776 changed, no more suspend auto hscrolling. */
12777 if (NILP (Fequal (Fwindow_point (window), Fwindow_old_point (window))))
12778 w->suspend_auto_hscroll = false;
12780 /* Remember window point. */
12781 Fset_marker (w->old_pointm,
12782 ((w == XWINDOW (selected_window))
12783 ? make_number (BUF_PT (XBUFFER (w->contents)))
12784 : Fmarker_position (w->pointm)),
12785 w->contents);
12787 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12788 && !w->suspend_auto_hscroll
12789 /* In some pathological cases, like restoring a window
12790 configuration into a frame that is much smaller than
12791 the one from which the configuration was saved, we
12792 get glyph rows whose start and end have zero buffer
12793 positions, which we cannot handle below. Just skip
12794 such windows. */
12795 && CHARPOS (cursor_row->start.pos) >= BUF_BEG (w->contents)
12796 /* For left-to-right rows, hscroll when cursor is either
12797 (i) inside the right hscroll margin, or (ii) if it is
12798 inside the left margin and the window is already
12799 hscrolled. */
12800 && ((!row_r2l_p
12801 && ((w->hscroll && w->cursor.x <= h_margin)
12802 || (cursor_row->enabled_p
12803 && cursor_row->truncated_on_right_p
12804 && (w->cursor.x >= text_area_width - h_margin))))
12805 /* For right-to-left rows, the logic is similar,
12806 except that rules for scrolling to left and right
12807 are reversed. E.g., if cursor.x <= h_margin, we
12808 need to hscroll "to the right" unconditionally,
12809 and that will scroll the screen to the left so as
12810 to reveal the next portion of the row. */
12811 || (row_r2l_p
12812 && ((cursor_row->enabled_p
12813 /* FIXME: It is confusing to set the
12814 truncated_on_right_p flag when R2L rows
12815 are actually truncated on the left. */
12816 && cursor_row->truncated_on_right_p
12817 && w->cursor.x <= h_margin)
12818 || (w->hscroll
12819 && (w->cursor.x >= text_area_width - h_margin))))))
12821 struct it it;
12822 ptrdiff_t hscroll;
12823 struct buffer *saved_current_buffer;
12824 ptrdiff_t pt;
12825 int wanted_x;
12827 /* Find point in a display of infinite width. */
12828 saved_current_buffer = current_buffer;
12829 current_buffer = XBUFFER (w->contents);
12831 if (w == XWINDOW (selected_window))
12832 pt = PT;
12833 else
12834 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
12836 /* Move iterator to pt starting at cursor_row->start in
12837 a line with infinite width. */
12838 init_to_row_start (&it, w, cursor_row);
12839 it.last_visible_x = INFINITY;
12840 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12841 current_buffer = saved_current_buffer;
12843 /* Position cursor in window. */
12844 if (!hscroll_relative_p && hscroll_step_abs == 0)
12845 hscroll = max (0, (it.current_x
12846 - (ITERATOR_AT_END_OF_LINE_P (&it)
12847 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12848 : (text_area_width / 2))))
12849 / FRAME_COLUMN_WIDTH (it.f);
12850 else if ((!row_r2l_p
12851 && w->cursor.x >= text_area_width - h_margin)
12852 || (row_r2l_p && w->cursor.x <= h_margin))
12854 if (hscroll_relative_p)
12855 wanted_x = text_area_width * (1 - hscroll_step_rel)
12856 - h_margin;
12857 else
12858 wanted_x = text_area_width
12859 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12860 - h_margin;
12861 hscroll
12862 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12864 else
12866 if (hscroll_relative_p)
12867 wanted_x = text_area_width * hscroll_step_rel
12868 + h_margin;
12869 else
12870 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12871 + h_margin;
12872 hscroll
12873 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12875 hscroll = max (hscroll, w->min_hscroll);
12877 /* Don't prevent redisplay optimizations if hscroll
12878 hasn't changed, as it will unnecessarily slow down
12879 redisplay. */
12880 if (w->hscroll != hscroll)
12882 struct buffer *b = XBUFFER (w->contents);
12883 b->prevent_redisplay_optimizations_p = true;
12884 w->hscroll = hscroll;
12885 hscrolled_p = true;
12890 window = w->next;
12893 /* Value is true if hscroll of any leaf window has been changed. */
12894 return hscrolled_p;
12898 /* Set hscroll so that cursor is visible and not inside horizontal
12899 scroll margins for all windows in the tree rooted at WINDOW. See
12900 also hscroll_window_tree above. Value is true if any window's
12901 hscroll has been changed. If it has, desired matrices on the frame
12902 of WINDOW are cleared. */
12904 static bool
12905 hscroll_windows (Lisp_Object window)
12907 bool hscrolled_p = hscroll_window_tree (window);
12908 if (hscrolled_p)
12909 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
12910 return hscrolled_p;
12915 /************************************************************************
12916 Redisplay
12917 ************************************************************************/
12919 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12920 This is sometimes handy to have in a debugger session. */
12922 #ifdef GLYPH_DEBUG
12924 /* First and last unchanged row for try_window_id. */
12926 static int debug_first_unchanged_at_end_vpos;
12927 static int debug_last_unchanged_at_beg_vpos;
12929 /* Delta vpos and y. */
12931 static int debug_dvpos, debug_dy;
12933 /* Delta in characters and bytes for try_window_id. */
12935 static ptrdiff_t debug_delta, debug_delta_bytes;
12937 /* Values of window_end_pos and window_end_vpos at the end of
12938 try_window_id. */
12940 static ptrdiff_t debug_end_vpos;
12942 /* Append a string to W->desired_matrix->method. FMT is a printf
12943 format string. If trace_redisplay_p is true also printf the
12944 resulting string to stderr. */
12946 static void debug_method_add (struct window *, char const *, ...)
12947 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12949 static void
12950 debug_method_add (struct window *w, char const *fmt, ...)
12952 void *ptr = w;
12953 char *method = w->desired_matrix->method;
12954 int len = strlen (method);
12955 int size = sizeof w->desired_matrix->method;
12956 int remaining = size - len - 1;
12957 va_list ap;
12959 if (len && remaining)
12961 method[len] = '|';
12962 --remaining, ++len;
12965 va_start (ap, fmt);
12966 vsnprintf (method + len, remaining + 1, fmt, ap);
12967 va_end (ap);
12969 if (trace_redisplay_p)
12970 fprintf (stderr, "%p (%s): %s\n",
12971 ptr,
12972 ((BUFFERP (w->contents)
12973 && STRINGP (BVAR (XBUFFER (w->contents), name)))
12974 ? SSDATA (BVAR (XBUFFER (w->contents), name))
12975 : "no buffer"),
12976 method + len);
12979 #endif /* GLYPH_DEBUG */
12982 /* Value is true if all changes in window W, which displays
12983 current_buffer, are in the text between START and END. START is a
12984 buffer position, END is given as a distance from Z. Used in
12985 redisplay_internal for display optimization. */
12987 static bool
12988 text_outside_line_unchanged_p (struct window *w,
12989 ptrdiff_t start, ptrdiff_t end)
12991 bool unchanged_p = true;
12993 /* If text or overlays have changed, see where. */
12994 if (window_outdated (w))
12996 /* Gap in the line? */
12997 if (GPT < start || Z - GPT < end)
12998 unchanged_p = false;
13000 /* Changes start in front of the line, or end after it? */
13001 if (unchanged_p
13002 && (BEG_UNCHANGED < start - 1
13003 || END_UNCHANGED < end))
13004 unchanged_p = false;
13006 /* If selective display, can't optimize if changes start at the
13007 beginning of the line. */
13008 if (unchanged_p
13009 && INTEGERP (BVAR (current_buffer, selective_display))
13010 && XINT (BVAR (current_buffer, selective_display)) > 0
13011 && (BEG_UNCHANGED < start || GPT <= start))
13012 unchanged_p = false;
13014 /* If there are overlays at the start or end of the line, these
13015 may have overlay strings with newlines in them. A change at
13016 START, for instance, may actually concern the display of such
13017 overlay strings as well, and they are displayed on different
13018 lines. So, quickly rule out this case. (For the future, it
13019 might be desirable to implement something more telling than
13020 just BEG/END_UNCHANGED.) */
13021 if (unchanged_p)
13023 if (BEG + BEG_UNCHANGED == start
13024 && overlay_touches_p (start))
13025 unchanged_p = false;
13026 if (END_UNCHANGED == end
13027 && overlay_touches_p (Z - end))
13028 unchanged_p = false;
13031 /* Under bidi reordering, adding or deleting a character in the
13032 beginning of a paragraph, before the first strong directional
13033 character, can change the base direction of the paragraph (unless
13034 the buffer specifies a fixed paragraph direction), which will
13035 require to redisplay the whole paragraph. It might be worthwhile
13036 to find the paragraph limits and widen the range of redisplayed
13037 lines to that, but for now just give up this optimization. */
13038 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13039 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13040 unchanged_p = false;
13043 return unchanged_p;
13047 /* Do a frame update, taking possible shortcuts into account. This is
13048 the main external entry point for redisplay.
13050 If the last redisplay displayed an echo area message and that message
13051 is no longer requested, we clear the echo area or bring back the
13052 mini-buffer if that is in use. */
13054 void
13055 redisplay (void)
13057 redisplay_internal ();
13061 static Lisp_Object
13062 overlay_arrow_string_or_property (Lisp_Object var)
13064 Lisp_Object val;
13066 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13067 return val;
13069 return Voverlay_arrow_string;
13072 /* Return true if there are any overlay-arrows in current_buffer. */
13073 static bool
13074 overlay_arrow_in_current_buffer_p (void)
13076 Lisp_Object vlist;
13078 for (vlist = Voverlay_arrow_variable_list;
13079 CONSP (vlist);
13080 vlist = XCDR (vlist))
13082 Lisp_Object var = XCAR (vlist);
13083 Lisp_Object val;
13085 if (!SYMBOLP (var))
13086 continue;
13087 val = find_symbol_value (var);
13088 if (MARKERP (val)
13089 && current_buffer == XMARKER (val)->buffer)
13090 return true;
13092 return false;
13096 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13097 has changed. */
13099 static bool
13100 overlay_arrows_changed_p (void)
13102 Lisp_Object vlist;
13104 for (vlist = Voverlay_arrow_variable_list;
13105 CONSP (vlist);
13106 vlist = XCDR (vlist))
13108 Lisp_Object var = XCAR (vlist);
13109 Lisp_Object val, pstr;
13111 if (!SYMBOLP (var))
13112 continue;
13113 val = find_symbol_value (var);
13114 if (!MARKERP (val))
13115 continue;
13116 if (! EQ (COERCE_MARKER (val),
13117 Fget (var, Qlast_arrow_position))
13118 || ! (pstr = overlay_arrow_string_or_property (var),
13119 EQ (pstr, Fget (var, Qlast_arrow_string))))
13120 return true;
13122 return false;
13125 /* Mark overlay arrows to be updated on next redisplay. */
13127 static void
13128 update_overlay_arrows (int up_to_date)
13130 Lisp_Object vlist;
13132 for (vlist = Voverlay_arrow_variable_list;
13133 CONSP (vlist);
13134 vlist = XCDR (vlist))
13136 Lisp_Object var = XCAR (vlist);
13138 if (!SYMBOLP (var))
13139 continue;
13141 if (up_to_date > 0)
13143 Lisp_Object val = find_symbol_value (var);
13144 Fput (var, Qlast_arrow_position,
13145 COERCE_MARKER (val));
13146 Fput (var, Qlast_arrow_string,
13147 overlay_arrow_string_or_property (var));
13149 else if (up_to_date < 0
13150 || !NILP (Fget (var, Qlast_arrow_position)))
13152 Fput (var, Qlast_arrow_position, Qt);
13153 Fput (var, Qlast_arrow_string, Qt);
13159 /* Return overlay arrow string to display at row.
13160 Return integer (bitmap number) for arrow bitmap in left fringe.
13161 Return nil if no overlay arrow. */
13163 static Lisp_Object
13164 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13166 Lisp_Object vlist;
13168 for (vlist = Voverlay_arrow_variable_list;
13169 CONSP (vlist);
13170 vlist = XCDR (vlist))
13172 Lisp_Object var = XCAR (vlist);
13173 Lisp_Object val;
13175 if (!SYMBOLP (var))
13176 continue;
13178 val = find_symbol_value (var);
13180 if (MARKERP (val)
13181 && current_buffer == XMARKER (val)->buffer
13182 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13184 if (FRAME_WINDOW_P (it->f)
13185 /* FIXME: if ROW->reversed_p is set, this should test
13186 the right fringe, not the left one. */
13187 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13189 #ifdef HAVE_WINDOW_SYSTEM
13190 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13192 int fringe_bitmap = lookup_fringe_bitmap (val);
13193 if (fringe_bitmap != 0)
13194 return make_number (fringe_bitmap);
13196 #endif
13197 return make_number (-1); /* Use default arrow bitmap. */
13199 return overlay_arrow_string_or_property (var);
13203 return Qnil;
13206 /* Return true if point moved out of or into a composition. Otherwise
13207 return false. PREV_BUF and PREV_PT are the last point buffer and
13208 position. BUF and PT are the current point buffer and position. */
13210 static bool
13211 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13212 struct buffer *buf, ptrdiff_t pt)
13214 ptrdiff_t start, end;
13215 Lisp_Object prop;
13216 Lisp_Object buffer;
13218 XSETBUFFER (buffer, buf);
13219 /* Check a composition at the last point if point moved within the
13220 same buffer. */
13221 if (prev_buf == buf)
13223 if (prev_pt == pt)
13224 /* Point didn't move. */
13225 return false;
13227 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13228 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13229 && composition_valid_p (start, end, prop)
13230 && start < prev_pt && end > prev_pt)
13231 /* The last point was within the composition. Return true iff
13232 point moved out of the composition. */
13233 return (pt <= start || pt >= end);
13236 /* Check a composition at the current point. */
13237 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13238 && find_composition (pt, -1, &start, &end, &prop, buffer)
13239 && composition_valid_p (start, end, prop)
13240 && start < pt && end > pt);
13243 /* Reconsider the clip changes of buffer which is displayed in W. */
13245 static void
13246 reconsider_clip_changes (struct window *w)
13248 struct buffer *b = XBUFFER (w->contents);
13250 if (b->clip_changed
13251 && w->window_end_valid
13252 && w->current_matrix->buffer == b
13253 && w->current_matrix->zv == BUF_ZV (b)
13254 && w->current_matrix->begv == BUF_BEGV (b))
13255 b->clip_changed = false;
13257 /* If display wasn't paused, and W is not a tool bar window, see if
13258 point has been moved into or out of a composition. In that case,
13259 set b->clip_changed to force updating the screen. If
13260 b->clip_changed has already been set, skip this check. */
13261 if (!b->clip_changed && w->window_end_valid)
13263 ptrdiff_t pt = (w == XWINDOW (selected_window)
13264 ? PT : marker_position (w->pointm));
13266 if ((w->current_matrix->buffer != b || pt != w->last_point)
13267 && check_point_in_composition (w->current_matrix->buffer,
13268 w->last_point, b, pt))
13269 b->clip_changed = true;
13273 static void
13274 propagate_buffer_redisplay (void)
13275 { /* Resetting b->text->redisplay is problematic!
13276 We can't just reset it in the case that some window that displays
13277 it has not been redisplayed; and such a window can stay
13278 unredisplayed for a long time if it's currently invisible.
13279 But we do want to reset it at the end of redisplay otherwise
13280 its displayed windows will keep being redisplayed over and over
13281 again.
13282 So we copy all b->text->redisplay flags up to their windows here,
13283 such that mark_window_display_accurate can safely reset
13284 b->text->redisplay. */
13285 Lisp_Object ws = window_list ();
13286 for (; CONSP (ws); ws = XCDR (ws))
13288 struct window *thisw = XWINDOW (XCAR (ws));
13289 struct buffer *thisb = XBUFFER (thisw->contents);
13290 if (thisb->text->redisplay)
13291 thisw->redisplay = true;
13295 #define STOP_POLLING \
13296 do { if (! polling_stopped_here) stop_polling (); \
13297 polling_stopped_here = true; } while (false)
13299 #define RESUME_POLLING \
13300 do { if (polling_stopped_here) start_polling (); \
13301 polling_stopped_here = false; } while (false)
13304 /* Perhaps in the future avoid recentering windows if it
13305 is not necessary; currently that causes some problems. */
13307 static void
13308 redisplay_internal (void)
13310 struct window *w = XWINDOW (selected_window);
13311 struct window *sw;
13312 struct frame *fr;
13313 bool pending;
13314 bool must_finish = false, match_p;
13315 struct text_pos tlbufpos, tlendpos;
13316 int number_of_visible_frames;
13317 ptrdiff_t count;
13318 struct frame *sf;
13319 bool polling_stopped_here = false;
13320 Lisp_Object tail, frame;
13322 /* True means redisplay has to consider all windows on all
13323 frames. False, only selected_window is considered. */
13324 bool consider_all_windows_p;
13326 /* True means redisplay has to redisplay the miniwindow. */
13327 bool update_miniwindow_p = false;
13329 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13331 /* No redisplay if running in batch mode or frame is not yet fully
13332 initialized, or redisplay is explicitly turned off by setting
13333 Vinhibit_redisplay. */
13334 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13335 || !NILP (Vinhibit_redisplay))
13336 return;
13338 /* Don't examine these until after testing Vinhibit_redisplay.
13339 When Emacs is shutting down, perhaps because its connection to
13340 X has dropped, we should not look at them at all. */
13341 fr = XFRAME (w->frame);
13342 sf = SELECTED_FRAME ();
13344 if (!fr->glyphs_initialized_p)
13345 return;
13347 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13348 if (popup_activated ())
13349 return;
13350 #endif
13352 /* I don't think this happens but let's be paranoid. */
13353 if (redisplaying_p)
13354 return;
13356 /* Record a function that clears redisplaying_p
13357 when we leave this function. */
13358 count = SPECPDL_INDEX ();
13359 record_unwind_protect_void (unwind_redisplay);
13360 redisplaying_p = true;
13361 specbind (Qinhibit_free_realized_faces, Qnil);
13363 /* Record this function, so it appears on the profiler's backtraces. */
13364 record_in_backtrace (Qredisplay_internal, 0, 0);
13366 FOR_EACH_FRAME (tail, frame)
13367 XFRAME (frame)->already_hscrolled_p = false;
13369 retry:
13370 /* Remember the currently selected window. */
13371 sw = w;
13373 pending = false;
13374 last_escape_glyph_frame = NULL;
13375 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
13376 last_glyphless_glyph_frame = NULL;
13377 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
13379 /* If face_change, init_iterator will free all realized faces, which
13380 includes the faces referenced from current matrices. So, we
13381 can't reuse current matrices in this case. */
13382 if (face_change)
13383 windows_or_buffers_changed = 47;
13385 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13386 && FRAME_TTY (sf)->previous_frame != sf)
13388 /* Since frames on a single ASCII terminal share the same
13389 display area, displaying a different frame means redisplay
13390 the whole thing. */
13391 SET_FRAME_GARBAGED (sf);
13392 #ifndef DOS_NT
13393 set_tty_color_mode (FRAME_TTY (sf), sf);
13394 #endif
13395 FRAME_TTY (sf)->previous_frame = sf;
13398 /* Set the visible flags for all frames. Do this before checking for
13399 resized or garbaged frames; they want to know if their frames are
13400 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13401 number_of_visible_frames = 0;
13403 FOR_EACH_FRAME (tail, frame)
13405 struct frame *f = XFRAME (frame);
13407 if (FRAME_VISIBLE_P (f))
13409 ++number_of_visible_frames;
13410 /* Adjust matrices for visible frames only. */
13411 if (f->fonts_changed)
13413 adjust_frame_glyphs (f);
13414 /* Disable all redisplay optimizations for this frame.
13415 This is because adjust_frame_glyphs resets the
13416 enabled_p flag for all glyph rows of all windows, so
13417 many optimizations will fail anyway, and some might
13418 fail to test that flag and do bogus things as
13419 result. */
13420 SET_FRAME_GARBAGED (f);
13421 f->fonts_changed = false;
13423 /* If cursor type has been changed on the frame
13424 other than selected, consider all frames. */
13425 if (f != sf && f->cursor_type_changed)
13426 update_mode_lines = 31;
13428 clear_desired_matrices (f);
13431 /* Notice any pending interrupt request to change frame size. */
13432 do_pending_window_change (true);
13434 /* do_pending_window_change could change the selected_window due to
13435 frame resizing which makes the selected window too small. */
13436 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13437 sw = w;
13439 /* Clear frames marked as garbaged. */
13440 clear_garbaged_frames ();
13442 /* Build menubar and tool-bar items. */
13443 if (NILP (Vmemory_full))
13444 prepare_menu_bars ();
13446 reconsider_clip_changes (w);
13448 /* In most cases selected window displays current buffer. */
13449 match_p = XBUFFER (w->contents) == current_buffer;
13450 if (match_p)
13452 /* Detect case that we need to write or remove a star in the mode line. */
13453 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13454 w->update_mode_line = true;
13456 if (mode_line_update_needed (w))
13457 w->update_mode_line = true;
13459 /* If reconsider_clip_changes above decided that the narrowing
13460 in the current buffer changed, make sure all other windows
13461 showing that buffer will be redisplayed. */
13462 if (current_buffer->clip_changed)
13463 bset_update_mode_line (current_buffer);
13466 /* Normally the message* functions will have already displayed and
13467 updated the echo area, but the frame may have been trashed, or
13468 the update may have been preempted, so display the echo area
13469 again here. Checking message_cleared_p captures the case that
13470 the echo area should be cleared. */
13471 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13472 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13473 || (message_cleared_p
13474 && minibuf_level == 0
13475 /* If the mini-window is currently selected, this means the
13476 echo-area doesn't show through. */
13477 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13479 bool window_height_changed_p = echo_area_display (false);
13481 if (message_cleared_p)
13482 update_miniwindow_p = true;
13484 must_finish = true;
13486 /* If we don't display the current message, don't clear the
13487 message_cleared_p flag, because, if we did, we wouldn't clear
13488 the echo area in the next redisplay which doesn't preserve
13489 the echo area. */
13490 if (!display_last_displayed_message_p)
13491 message_cleared_p = false;
13493 if (window_height_changed_p)
13495 windows_or_buffers_changed = 50;
13497 /* If window configuration was changed, frames may have been
13498 marked garbaged. Clear them or we will experience
13499 surprises wrt scrolling. */
13500 clear_garbaged_frames ();
13503 else if (EQ (selected_window, minibuf_window)
13504 && (current_buffer->clip_changed || window_outdated (w))
13505 && resize_mini_window (w, false))
13507 /* Resized active mini-window to fit the size of what it is
13508 showing if its contents might have changed. */
13509 must_finish = true;
13511 /* If window configuration was changed, frames may have been
13512 marked garbaged. Clear them or we will experience
13513 surprises wrt scrolling. */
13514 clear_garbaged_frames ();
13517 if (windows_or_buffers_changed && !update_mode_lines)
13518 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13519 only the windows's contents needs to be refreshed, or whether the
13520 mode-lines also need a refresh. */
13521 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13522 ? REDISPLAY_SOME : 32);
13524 /* If specs for an arrow have changed, do thorough redisplay
13525 to ensure we remove any arrow that should no longer exist. */
13526 if (overlay_arrows_changed_p ())
13527 /* Apparently, this is the only case where we update other windows,
13528 without updating other mode-lines. */
13529 windows_or_buffers_changed = 49;
13531 consider_all_windows_p = (update_mode_lines
13532 || windows_or_buffers_changed);
13534 #define AINC(a,i) \
13535 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13536 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13538 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13539 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13541 /* Optimize the case that only the line containing the cursor in the
13542 selected window has changed. Variables starting with this_ are
13543 set in display_line and record information about the line
13544 containing the cursor. */
13545 tlbufpos = this_line_start_pos;
13546 tlendpos = this_line_end_pos;
13547 if (!consider_all_windows_p
13548 && CHARPOS (tlbufpos) > 0
13549 && !w->update_mode_line
13550 && !current_buffer->clip_changed
13551 && !current_buffer->prevent_redisplay_optimizations_p
13552 && FRAME_VISIBLE_P (XFRAME (w->frame))
13553 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13554 && !XFRAME (w->frame)->cursor_type_changed
13555 /* Make sure recorded data applies to current buffer, etc. */
13556 && this_line_buffer == current_buffer
13557 && match_p
13558 && !w->force_start
13559 && !w->optional_new_start
13560 /* Point must be on the line that we have info recorded about. */
13561 && PT >= CHARPOS (tlbufpos)
13562 && PT <= Z - CHARPOS (tlendpos)
13563 /* All text outside that line, including its final newline,
13564 must be unchanged. */
13565 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13566 CHARPOS (tlendpos)))
13568 if (CHARPOS (tlbufpos) > BEGV
13569 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13570 && (CHARPOS (tlbufpos) == ZV
13571 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13572 /* Former continuation line has disappeared by becoming empty. */
13573 goto cancel;
13574 else if (window_outdated (w) || MINI_WINDOW_P (w))
13576 /* We have to handle the case of continuation around a
13577 wide-column character (see the comment in indent.c around
13578 line 1340).
13580 For instance, in the following case:
13582 -------- Insert --------
13583 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13584 J_I_ ==> J_I_ `^^' are cursors.
13585 ^^ ^^
13586 -------- --------
13588 As we have to redraw the line above, we cannot use this
13589 optimization. */
13591 struct it it;
13592 int line_height_before = this_line_pixel_height;
13594 /* Note that start_display will handle the case that the
13595 line starting at tlbufpos is a continuation line. */
13596 start_display (&it, w, tlbufpos);
13598 /* Implementation note: It this still necessary? */
13599 if (it.current_x != this_line_start_x)
13600 goto cancel;
13602 TRACE ((stderr, "trying display optimization 1\n"));
13603 w->cursor.vpos = -1;
13604 overlay_arrow_seen = false;
13605 it.vpos = this_line_vpos;
13606 it.current_y = this_line_y;
13607 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13608 display_line (&it);
13610 /* If line contains point, is not continued,
13611 and ends at same distance from eob as before, we win. */
13612 if (w->cursor.vpos >= 0
13613 /* Line is not continued, otherwise this_line_start_pos
13614 would have been set to 0 in display_line. */
13615 && CHARPOS (this_line_start_pos)
13616 /* Line ends as before. */
13617 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13618 /* Line has same height as before. Otherwise other lines
13619 would have to be shifted up or down. */
13620 && this_line_pixel_height == line_height_before)
13622 /* If this is not the window's last line, we must adjust
13623 the charstarts of the lines below. */
13624 if (it.current_y < it.last_visible_y)
13626 struct glyph_row *row
13627 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13628 ptrdiff_t delta, delta_bytes;
13630 /* We used to distinguish between two cases here,
13631 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13632 when the line ends in a newline or the end of the
13633 buffer's accessible portion. But both cases did
13634 the same, so they were collapsed. */
13635 delta = (Z
13636 - CHARPOS (tlendpos)
13637 - MATRIX_ROW_START_CHARPOS (row));
13638 delta_bytes = (Z_BYTE
13639 - BYTEPOS (tlendpos)
13640 - MATRIX_ROW_START_BYTEPOS (row));
13642 increment_matrix_positions (w->current_matrix,
13643 this_line_vpos + 1,
13644 w->current_matrix->nrows,
13645 delta, delta_bytes);
13648 /* If this row displays text now but previously didn't,
13649 or vice versa, w->window_end_vpos may have to be
13650 adjusted. */
13651 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13653 if (w->window_end_vpos < this_line_vpos)
13654 w->window_end_vpos = this_line_vpos;
13656 else if (w->window_end_vpos == this_line_vpos
13657 && this_line_vpos > 0)
13658 w->window_end_vpos = this_line_vpos - 1;
13659 w->window_end_valid = false;
13661 /* Update hint: No need to try to scroll in update_window. */
13662 w->desired_matrix->no_scrolling_p = true;
13664 #ifdef GLYPH_DEBUG
13665 *w->desired_matrix->method = 0;
13666 debug_method_add (w, "optimization 1");
13667 #endif
13668 #ifdef HAVE_WINDOW_SYSTEM
13669 update_window_fringes (w, false);
13670 #endif
13671 goto update;
13673 else
13674 goto cancel;
13676 else if (/* Cursor position hasn't changed. */
13677 PT == w->last_point
13678 /* Make sure the cursor was last displayed
13679 in this window. Otherwise we have to reposition it. */
13681 /* PXW: Must be converted to pixels, probably. */
13682 && 0 <= w->cursor.vpos
13683 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13685 if (!must_finish)
13687 do_pending_window_change (true);
13688 /* If selected_window changed, redisplay again. */
13689 if (WINDOWP (selected_window)
13690 && (w = XWINDOW (selected_window)) != sw)
13691 goto retry;
13693 /* We used to always goto end_of_redisplay here, but this
13694 isn't enough if we have a blinking cursor. */
13695 if (w->cursor_off_p == w->last_cursor_off_p)
13696 goto end_of_redisplay;
13698 goto update;
13700 /* If highlighting the region, or if the cursor is in the echo area,
13701 then we can't just move the cursor. */
13702 else if (NILP (Vshow_trailing_whitespace)
13703 && !cursor_in_echo_area)
13705 struct it it;
13706 struct glyph_row *row;
13708 /* Skip from tlbufpos to PT and see where it is. Note that
13709 PT may be in invisible text. If so, we will end at the
13710 next visible position. */
13711 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13712 NULL, DEFAULT_FACE_ID);
13713 it.current_x = this_line_start_x;
13714 it.current_y = this_line_y;
13715 it.vpos = this_line_vpos;
13717 /* The call to move_it_to stops in front of PT, but
13718 moves over before-strings. */
13719 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13721 if (it.vpos == this_line_vpos
13722 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13723 row->enabled_p))
13725 eassert (this_line_vpos == it.vpos);
13726 eassert (this_line_y == it.current_y);
13727 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13728 #ifdef GLYPH_DEBUG
13729 *w->desired_matrix->method = 0;
13730 debug_method_add (w, "optimization 3");
13731 #endif
13732 goto update;
13734 else
13735 goto cancel;
13738 cancel:
13739 /* Text changed drastically or point moved off of line. */
13740 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13743 CHARPOS (this_line_start_pos) = 0;
13744 ++clear_face_cache_count;
13745 #ifdef HAVE_WINDOW_SYSTEM
13746 ++clear_image_cache_count;
13747 #endif
13749 /* Build desired matrices, and update the display. If
13750 consider_all_windows_p, do it for all windows on all frames.
13751 Otherwise do it for selected_window, only. */
13753 if (consider_all_windows_p)
13755 FOR_EACH_FRAME (tail, frame)
13756 XFRAME (frame)->updated_p = false;
13758 propagate_buffer_redisplay ();
13760 FOR_EACH_FRAME (tail, frame)
13762 struct frame *f = XFRAME (frame);
13764 /* We don't have to do anything for unselected terminal
13765 frames. */
13766 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13767 && !EQ (FRAME_TTY (f)->top_frame, frame))
13768 continue;
13770 retry_frame:
13772 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_GTK) && !defined (HAVE_NS)
13773 /* Redisplay internal tool bar if this is the first time so we
13774 can adjust the frame height right now, if necessary. */
13775 if (!f->tool_bar_redisplayed_once)
13777 if (redisplay_tool_bar (f))
13778 adjust_frame_glyphs (f);
13779 f->tool_bar_redisplayed_once = true;
13781 #endif
13783 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13785 bool gcscrollbars
13786 /* Only GC scrollbars when we redisplay the whole frame. */
13787 = f->redisplay || !REDISPLAY_SOME_P ();
13788 /* Mark all the scroll bars to be removed; we'll redeem
13789 the ones we want when we redisplay their windows. */
13790 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13791 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13793 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13794 redisplay_windows (FRAME_ROOT_WINDOW (f));
13795 /* Remember that the invisible frames need to be redisplayed next
13796 time they're visible. */
13797 else if (!REDISPLAY_SOME_P ())
13798 f->redisplay = true;
13800 /* The X error handler may have deleted that frame. */
13801 if (!FRAME_LIVE_P (f))
13802 continue;
13804 /* Any scroll bars which redisplay_windows should have
13805 nuked should now go away. */
13806 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13807 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13809 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13811 /* If fonts changed on visible frame, display again. */
13812 if (f->fonts_changed)
13814 adjust_frame_glyphs (f);
13815 /* Disable all redisplay optimizations for this
13816 frame. For the reasons, see the comment near
13817 the previous call to adjust_frame_glyphs above. */
13818 SET_FRAME_GARBAGED (f);
13819 f->fonts_changed = false;
13820 goto retry_frame;
13823 /* See if we have to hscroll. */
13824 if (!f->already_hscrolled_p)
13826 f->already_hscrolled_p = true;
13827 if (hscroll_windows (f->root_window))
13828 goto retry_frame;
13831 /* Prevent various kinds of signals during display
13832 update. stdio is not robust about handling
13833 signals, which can cause an apparent I/O error. */
13834 if (interrupt_input)
13835 unrequest_sigio ();
13836 STOP_POLLING;
13838 pending |= update_frame (f, false, false);
13839 f->cursor_type_changed = false;
13840 f->updated_p = true;
13845 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
13847 if (!pending)
13849 /* Do the mark_window_display_accurate after all windows have
13850 been redisplayed because this call resets flags in buffers
13851 which are needed for proper redisplay. */
13852 FOR_EACH_FRAME (tail, frame)
13854 struct frame *f = XFRAME (frame);
13855 if (f->updated_p)
13857 f->redisplay = false;
13858 mark_window_display_accurate (f->root_window, true);
13859 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13860 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13865 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13867 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13868 struct frame *mini_frame;
13870 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
13871 /* Use list_of_error, not Qerror, so that
13872 we catch only errors and don't run the debugger. */
13873 internal_condition_case_1 (redisplay_window_1, selected_window,
13874 list_of_error,
13875 redisplay_window_error);
13876 if (update_miniwindow_p)
13877 internal_condition_case_1 (redisplay_window_1, mini_window,
13878 list_of_error,
13879 redisplay_window_error);
13881 /* Compare desired and current matrices, perform output. */
13883 update:
13884 /* If fonts changed, display again. */
13885 if (sf->fonts_changed)
13886 goto retry;
13888 /* Prevent various kinds of signals during display update.
13889 stdio is not robust about handling signals,
13890 which can cause an apparent I/O error. */
13891 if (interrupt_input)
13892 unrequest_sigio ();
13893 STOP_POLLING;
13895 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13897 if (hscroll_windows (selected_window))
13898 goto retry;
13900 XWINDOW (selected_window)->must_be_updated_p = true;
13901 pending = update_frame (sf, false, false);
13902 sf->cursor_type_changed = false;
13905 /* We may have called echo_area_display at the top of this
13906 function. If the echo area is on another frame, that may
13907 have put text on a frame other than the selected one, so the
13908 above call to update_frame would not have caught it. Catch
13909 it here. */
13910 mini_window = FRAME_MINIBUF_WINDOW (sf);
13911 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
13913 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
13915 XWINDOW (mini_window)->must_be_updated_p = true;
13916 pending |= update_frame (mini_frame, false, false);
13917 mini_frame->cursor_type_changed = false;
13918 if (!pending && hscroll_windows (mini_window))
13919 goto retry;
13923 /* If display was paused because of pending input, make sure we do a
13924 thorough update the next time. */
13925 if (pending)
13927 /* Prevent the optimization at the beginning of
13928 redisplay_internal that tries a single-line update of the
13929 line containing the cursor in the selected window. */
13930 CHARPOS (this_line_start_pos) = 0;
13932 /* Let the overlay arrow be updated the next time. */
13933 update_overlay_arrows (0);
13935 /* If we pause after scrolling, some rows in the current
13936 matrices of some windows are not valid. */
13937 if (!WINDOW_FULL_WIDTH_P (w)
13938 && !FRAME_WINDOW_P (XFRAME (w->frame)))
13939 update_mode_lines = 36;
13941 else
13943 if (!consider_all_windows_p)
13945 /* This has already been done above if
13946 consider_all_windows_p is set. */
13947 if (XBUFFER (w->contents)->text->redisplay
13948 && buffer_window_count (XBUFFER (w->contents)) > 1)
13949 /* This can happen if b->text->redisplay was set during
13950 jit-lock. */
13951 propagate_buffer_redisplay ();
13952 mark_window_display_accurate_1 (w, true);
13954 /* Say overlay arrows are up to date. */
13955 update_overlay_arrows (1);
13957 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
13958 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
13961 update_mode_lines = 0;
13962 windows_or_buffers_changed = 0;
13965 /* Start SIGIO interrupts coming again. Having them off during the
13966 code above makes it less likely one will discard output, but not
13967 impossible, since there might be stuff in the system buffer here.
13968 But it is much hairier to try to do anything about that. */
13969 if (interrupt_input)
13970 request_sigio ();
13971 RESUME_POLLING;
13973 /* If a frame has become visible which was not before, redisplay
13974 again, so that we display it. Expose events for such a frame
13975 (which it gets when becoming visible) don't call the parts of
13976 redisplay constructing glyphs, so simply exposing a frame won't
13977 display anything in this case. So, we have to display these
13978 frames here explicitly. */
13979 if (!pending)
13981 int new_count = 0;
13983 FOR_EACH_FRAME (tail, frame)
13985 if (XFRAME (frame)->visible)
13986 new_count++;
13989 if (new_count != number_of_visible_frames)
13990 windows_or_buffers_changed = 52;
13993 /* Change frame size now if a change is pending. */
13994 do_pending_window_change (true);
13996 /* If we just did a pending size change, or have additional
13997 visible frames, or selected_window changed, redisplay again. */
13998 if ((windows_or_buffers_changed && !pending)
13999 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
14000 goto retry;
14002 /* Clear the face and image caches.
14004 We used to do this only if consider_all_windows_p. But the cache
14005 needs to be cleared if a timer creates images in the current
14006 buffer (e.g. the test case in Bug#6230). */
14008 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14010 clear_face_cache (false);
14011 clear_face_cache_count = 0;
14014 #ifdef HAVE_WINDOW_SYSTEM
14015 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14017 clear_image_caches (Qnil);
14018 clear_image_cache_count = 0;
14020 #endif /* HAVE_WINDOW_SYSTEM */
14022 end_of_redisplay:
14023 #ifdef HAVE_NS
14024 ns_set_doc_edited ();
14025 #endif
14026 if (interrupt_input && interrupts_deferred)
14027 request_sigio ();
14029 unbind_to (count, Qnil);
14030 RESUME_POLLING;
14034 /* Redisplay, but leave alone any recent echo area message unless
14035 another message has been requested in its place.
14037 This is useful in situations where you need to redisplay but no
14038 user action has occurred, making it inappropriate for the message
14039 area to be cleared. See tracking_off and
14040 wait_reading_process_output for examples of these situations.
14042 FROM_WHERE is an integer saying from where this function was
14043 called. This is useful for debugging. */
14045 void
14046 redisplay_preserve_echo_area (int from_where)
14048 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14050 if (!NILP (echo_area_buffer[1]))
14052 /* We have a previously displayed message, but no current
14053 message. Redisplay the previous message. */
14054 display_last_displayed_message_p = true;
14055 redisplay_internal ();
14056 display_last_displayed_message_p = false;
14058 else
14059 redisplay_internal ();
14061 flush_frame (SELECTED_FRAME ());
14065 /* Function registered with record_unwind_protect in redisplay_internal. */
14067 static void
14068 unwind_redisplay (void)
14070 redisplaying_p = false;
14074 /* Mark the display of leaf window W as accurate or inaccurate.
14075 If ACCURATE_P, mark display of W as accurate.
14076 If !ACCURATE_P, arrange for W to be redisplayed the next
14077 time redisplay_internal is called. */
14079 static void
14080 mark_window_display_accurate_1 (struct window *w, bool accurate_p)
14082 struct buffer *b = XBUFFER (w->contents);
14084 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14085 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14086 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14088 if (accurate_p)
14090 b->clip_changed = false;
14091 b->prevent_redisplay_optimizations_p = false;
14092 eassert (buffer_window_count (b) > 0);
14093 /* Resetting b->text->redisplay is problematic!
14094 In order to make it safer to do it here, redisplay_internal must
14095 have copied all b->text->redisplay to their respective windows. */
14096 b->text->redisplay = false;
14098 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14099 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14100 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14101 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14103 w->current_matrix->buffer = b;
14104 w->current_matrix->begv = BUF_BEGV (b);
14105 w->current_matrix->zv = BUF_ZV (b);
14107 w->last_cursor_vpos = w->cursor.vpos;
14108 w->last_cursor_off_p = w->cursor_off_p;
14110 if (w == XWINDOW (selected_window))
14111 w->last_point = BUF_PT (b);
14112 else
14113 w->last_point = marker_position (w->pointm);
14115 w->window_end_valid = true;
14116 w->update_mode_line = false;
14119 w->redisplay = !accurate_p;
14123 /* Mark the display of windows in the window tree rooted at WINDOW as
14124 accurate or inaccurate. If ACCURATE_P, mark display of
14125 windows as accurate. If !ACCURATE_P, arrange for windows to
14126 be redisplayed the next time redisplay_internal is called. */
14128 void
14129 mark_window_display_accurate (Lisp_Object window, bool accurate_p)
14131 struct window *w;
14133 for (; !NILP (window); window = w->next)
14135 w = XWINDOW (window);
14136 if (WINDOWP (w->contents))
14137 mark_window_display_accurate (w->contents, accurate_p);
14138 else
14139 mark_window_display_accurate_1 (w, accurate_p);
14142 if (accurate_p)
14143 update_overlay_arrows (1);
14144 else
14145 /* Force a thorough redisplay the next time by setting
14146 last_arrow_position and last_arrow_string to t, which is
14147 unequal to any useful value of Voverlay_arrow_... */
14148 update_overlay_arrows (-1);
14152 /* Return value in display table DP (Lisp_Char_Table *) for character
14153 C. Since a display table doesn't have any parent, we don't have to
14154 follow parent. Do not call this function directly but use the
14155 macro DISP_CHAR_VECTOR. */
14157 Lisp_Object
14158 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14160 Lisp_Object val;
14162 if (ASCII_CHAR_P (c))
14164 val = dp->ascii;
14165 if (SUB_CHAR_TABLE_P (val))
14166 val = XSUB_CHAR_TABLE (val)->contents[c];
14168 else
14170 Lisp_Object table;
14172 XSETCHAR_TABLE (table, dp);
14173 val = char_table_ref (table, c);
14175 if (NILP (val))
14176 val = dp->defalt;
14177 return val;
14182 /***********************************************************************
14183 Window Redisplay
14184 ***********************************************************************/
14186 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14188 static void
14189 redisplay_windows (Lisp_Object window)
14191 while (!NILP (window))
14193 struct window *w = XWINDOW (window);
14195 if (WINDOWP (w->contents))
14196 redisplay_windows (w->contents);
14197 else if (BUFFERP (w->contents))
14199 displayed_buffer = XBUFFER (w->contents);
14200 /* Use list_of_error, not Qerror, so that
14201 we catch only errors and don't run the debugger. */
14202 internal_condition_case_1 (redisplay_window_0, window,
14203 list_of_error,
14204 redisplay_window_error);
14207 window = w->next;
14211 static Lisp_Object
14212 redisplay_window_error (Lisp_Object ignore)
14214 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14215 return Qnil;
14218 static Lisp_Object
14219 redisplay_window_0 (Lisp_Object window)
14221 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14222 redisplay_window (window, false);
14223 return Qnil;
14226 static Lisp_Object
14227 redisplay_window_1 (Lisp_Object window)
14229 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14230 redisplay_window (window, true);
14231 return Qnil;
14235 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14236 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14237 which positions recorded in ROW differ from current buffer
14238 positions.
14240 Return true iff cursor is on this row. */
14242 static bool
14243 set_cursor_from_row (struct window *w, struct glyph_row *row,
14244 struct glyph_matrix *matrix,
14245 ptrdiff_t delta, ptrdiff_t delta_bytes,
14246 int dy, int dvpos)
14248 struct glyph *glyph = row->glyphs[TEXT_AREA];
14249 struct glyph *end = glyph + row->used[TEXT_AREA];
14250 struct glyph *cursor = NULL;
14251 /* The last known character position in row. */
14252 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14253 int x = row->x;
14254 ptrdiff_t pt_old = PT - delta;
14255 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14256 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14257 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14258 /* A glyph beyond the edge of TEXT_AREA which we should never
14259 touch. */
14260 struct glyph *glyphs_end = end;
14261 /* True means we've found a match for cursor position, but that
14262 glyph has the avoid_cursor_p flag set. */
14263 bool match_with_avoid_cursor = false;
14264 /* True means we've seen at least one glyph that came from a
14265 display string. */
14266 bool string_seen = false;
14267 /* Largest and smallest buffer positions seen so far during scan of
14268 glyph row. */
14269 ptrdiff_t bpos_max = pos_before;
14270 ptrdiff_t bpos_min = pos_after;
14271 /* Last buffer position covered by an overlay string with an integer
14272 `cursor' property. */
14273 ptrdiff_t bpos_covered = 0;
14274 /* True means the display string on which to display the cursor
14275 comes from a text property, not from an overlay. */
14276 bool string_from_text_prop = false;
14278 /* Don't even try doing anything if called for a mode-line or
14279 header-line row, since the rest of the code isn't prepared to
14280 deal with such calamities. */
14281 eassert (!row->mode_line_p);
14282 if (row->mode_line_p)
14283 return false;
14285 /* Skip over glyphs not having an object at the start and the end of
14286 the row. These are special glyphs like truncation marks on
14287 terminal frames. */
14288 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14290 if (!row->reversed_p)
14292 while (glyph < end
14293 && NILP (glyph->object)
14294 && glyph->charpos < 0)
14296 x += glyph->pixel_width;
14297 ++glyph;
14299 while (end > glyph
14300 && NILP ((end - 1)->object)
14301 /* CHARPOS is zero for blanks and stretch glyphs
14302 inserted by extend_face_to_end_of_line. */
14303 && (end - 1)->charpos <= 0)
14304 --end;
14305 glyph_before = glyph - 1;
14306 glyph_after = end;
14308 else
14310 struct glyph *g;
14312 /* If the glyph row is reversed, we need to process it from back
14313 to front, so swap the edge pointers. */
14314 glyphs_end = end = glyph - 1;
14315 glyph += row->used[TEXT_AREA] - 1;
14317 while (glyph > end + 1
14318 && NILP (glyph->object)
14319 && glyph->charpos < 0)
14321 --glyph;
14322 x -= glyph->pixel_width;
14324 if (NILP (glyph->object) && glyph->charpos < 0)
14325 --glyph;
14326 /* By default, in reversed rows we put the cursor on the
14327 rightmost (first in the reading order) glyph. */
14328 for (g = end + 1; g < glyph; g++)
14329 x += g->pixel_width;
14330 while (end < glyph
14331 && NILP ((end + 1)->object)
14332 && (end + 1)->charpos <= 0)
14333 ++end;
14334 glyph_before = glyph + 1;
14335 glyph_after = end;
14338 else if (row->reversed_p)
14340 /* In R2L rows that don't display text, put the cursor on the
14341 rightmost glyph. Case in point: an empty last line that is
14342 part of an R2L paragraph. */
14343 cursor = end - 1;
14344 /* Avoid placing the cursor on the last glyph of the row, where
14345 on terminal frames we hold the vertical border between
14346 adjacent windows. */
14347 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14348 && !WINDOW_RIGHTMOST_P (w)
14349 && cursor == row->glyphs[LAST_AREA] - 1)
14350 cursor--;
14351 x = -1; /* will be computed below, at label compute_x */
14354 /* Step 1: Try to find the glyph whose character position
14355 corresponds to point. If that's not possible, find 2 glyphs
14356 whose character positions are the closest to point, one before
14357 point, the other after it. */
14358 if (!row->reversed_p)
14359 while (/* not marched to end of glyph row */
14360 glyph < end
14361 /* glyph was not inserted by redisplay for internal purposes */
14362 && !NILP (glyph->object))
14364 if (BUFFERP (glyph->object))
14366 ptrdiff_t dpos = glyph->charpos - pt_old;
14368 if (glyph->charpos > bpos_max)
14369 bpos_max = glyph->charpos;
14370 if (glyph->charpos < bpos_min)
14371 bpos_min = glyph->charpos;
14372 if (!glyph->avoid_cursor_p)
14374 /* If we hit point, we've found the glyph on which to
14375 display the cursor. */
14376 if (dpos == 0)
14378 match_with_avoid_cursor = false;
14379 break;
14381 /* See if we've found a better approximation to
14382 POS_BEFORE or to POS_AFTER. */
14383 if (0 > dpos && dpos > pos_before - pt_old)
14385 pos_before = glyph->charpos;
14386 glyph_before = glyph;
14388 else if (0 < dpos && dpos < pos_after - pt_old)
14390 pos_after = glyph->charpos;
14391 glyph_after = glyph;
14394 else if (dpos == 0)
14395 match_with_avoid_cursor = true;
14397 else if (STRINGP (glyph->object))
14399 Lisp_Object chprop;
14400 ptrdiff_t glyph_pos = glyph->charpos;
14402 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14403 glyph->object);
14404 if (!NILP (chprop))
14406 /* If the string came from a `display' text property,
14407 look up the buffer position of that property and
14408 use that position to update bpos_max, as if we
14409 actually saw such a position in one of the row's
14410 glyphs. This helps with supporting integer values
14411 of `cursor' property on the display string in
14412 situations where most or all of the row's buffer
14413 text is completely covered by display properties,
14414 so that no glyph with valid buffer positions is
14415 ever seen in the row. */
14416 ptrdiff_t prop_pos =
14417 string_buffer_position_lim (glyph->object, pos_before,
14418 pos_after, false);
14420 if (prop_pos >= pos_before)
14421 bpos_max = prop_pos;
14423 if (INTEGERP (chprop))
14425 bpos_covered = bpos_max + XINT (chprop);
14426 /* If the `cursor' property covers buffer positions up
14427 to and including point, we should display cursor on
14428 this glyph. Note that, if a `cursor' property on one
14429 of the string's characters has an integer value, we
14430 will break out of the loop below _before_ we get to
14431 the position match above. IOW, integer values of
14432 the `cursor' property override the "exact match for
14433 point" strategy of positioning the cursor. */
14434 /* Implementation note: bpos_max == pt_old when, e.g.,
14435 we are in an empty line, where bpos_max is set to
14436 MATRIX_ROW_START_CHARPOS, see above. */
14437 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14439 cursor = glyph;
14440 break;
14444 string_seen = true;
14446 x += glyph->pixel_width;
14447 ++glyph;
14449 else if (glyph > end) /* row is reversed */
14450 while (!NILP (glyph->object))
14452 if (BUFFERP (glyph->object))
14454 ptrdiff_t dpos = glyph->charpos - pt_old;
14456 if (glyph->charpos > bpos_max)
14457 bpos_max = glyph->charpos;
14458 if (glyph->charpos < bpos_min)
14459 bpos_min = glyph->charpos;
14460 if (!glyph->avoid_cursor_p)
14462 if (dpos == 0)
14464 match_with_avoid_cursor = false;
14465 break;
14467 if (0 > dpos && dpos > pos_before - pt_old)
14469 pos_before = glyph->charpos;
14470 glyph_before = glyph;
14472 else if (0 < dpos && dpos < pos_after - pt_old)
14474 pos_after = glyph->charpos;
14475 glyph_after = glyph;
14478 else if (dpos == 0)
14479 match_with_avoid_cursor = true;
14481 else if (STRINGP (glyph->object))
14483 Lisp_Object chprop;
14484 ptrdiff_t glyph_pos = glyph->charpos;
14486 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14487 glyph->object);
14488 if (!NILP (chprop))
14490 ptrdiff_t prop_pos =
14491 string_buffer_position_lim (glyph->object, pos_before,
14492 pos_after, false);
14494 if (prop_pos >= pos_before)
14495 bpos_max = prop_pos;
14497 if (INTEGERP (chprop))
14499 bpos_covered = bpos_max + XINT (chprop);
14500 /* If the `cursor' property covers buffer positions up
14501 to and including point, we should display cursor on
14502 this glyph. */
14503 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14505 cursor = glyph;
14506 break;
14509 string_seen = true;
14511 --glyph;
14512 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14514 x--; /* can't use any pixel_width */
14515 break;
14517 x -= glyph->pixel_width;
14520 /* Step 2: If we didn't find an exact match for point, we need to
14521 look for a proper place to put the cursor among glyphs between
14522 GLYPH_BEFORE and GLYPH_AFTER. */
14523 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14524 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14525 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14527 /* An empty line has a single glyph whose OBJECT is nil and
14528 whose CHARPOS is the position of a newline on that line.
14529 Note that on a TTY, there are more glyphs after that, which
14530 were produced by extend_face_to_end_of_line, but their
14531 CHARPOS is zero or negative. */
14532 bool empty_line_p =
14533 ((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14534 && NILP (glyph->object) && glyph->charpos > 0
14535 /* On a TTY, continued and truncated rows also have a glyph at
14536 their end whose OBJECT is nil and whose CHARPOS is
14537 positive (the continuation and truncation glyphs), but such
14538 rows are obviously not "empty". */
14539 && !(row->continued_p || row->truncated_on_right_p));
14541 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14543 ptrdiff_t ellipsis_pos;
14545 /* Scan back over the ellipsis glyphs. */
14546 if (!row->reversed_p)
14548 ellipsis_pos = (glyph - 1)->charpos;
14549 while (glyph > row->glyphs[TEXT_AREA]
14550 && (glyph - 1)->charpos == ellipsis_pos)
14551 glyph--, x -= glyph->pixel_width;
14552 /* That loop always goes one position too far, including
14553 the glyph before the ellipsis. So scan forward over
14554 that one. */
14555 x += glyph->pixel_width;
14556 glyph++;
14558 else /* row is reversed */
14560 ellipsis_pos = (glyph + 1)->charpos;
14561 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14562 && (glyph + 1)->charpos == ellipsis_pos)
14563 glyph++, x += glyph->pixel_width;
14564 x -= glyph->pixel_width;
14565 glyph--;
14568 else if (match_with_avoid_cursor)
14570 cursor = glyph_after;
14571 x = -1;
14573 else if (string_seen)
14575 int incr = row->reversed_p ? -1 : +1;
14577 /* Need to find the glyph that came out of a string which is
14578 present at point. That glyph is somewhere between
14579 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14580 positioned between POS_BEFORE and POS_AFTER in the
14581 buffer. */
14582 struct glyph *start, *stop;
14583 ptrdiff_t pos = pos_before;
14585 x = -1;
14587 /* If the row ends in a newline from a display string,
14588 reordering could have moved the glyphs belonging to the
14589 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14590 in this case we extend the search to the last glyph in
14591 the row that was not inserted by redisplay. */
14592 if (row->ends_in_newline_from_string_p)
14594 glyph_after = end;
14595 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14598 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14599 correspond to POS_BEFORE and POS_AFTER, respectively. We
14600 need START and STOP in the order that corresponds to the
14601 row's direction as given by its reversed_p flag. If the
14602 directionality of characters between POS_BEFORE and
14603 POS_AFTER is the opposite of the row's base direction,
14604 these characters will have been reordered for display,
14605 and we need to reverse START and STOP. */
14606 if (!row->reversed_p)
14608 start = min (glyph_before, glyph_after);
14609 stop = max (glyph_before, glyph_after);
14611 else
14613 start = max (glyph_before, glyph_after);
14614 stop = min (glyph_before, glyph_after);
14616 for (glyph = start + incr;
14617 row->reversed_p ? glyph > stop : glyph < stop; )
14620 /* Any glyphs that come from the buffer are here because
14621 of bidi reordering. Skip them, and only pay
14622 attention to glyphs that came from some string. */
14623 if (STRINGP (glyph->object))
14625 Lisp_Object str;
14626 ptrdiff_t tem;
14627 /* If the display property covers the newline, we
14628 need to search for it one position farther. */
14629 ptrdiff_t lim = pos_after
14630 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14632 string_from_text_prop = false;
14633 str = glyph->object;
14634 tem = string_buffer_position_lim (str, pos, lim, false);
14635 if (tem == 0 /* from overlay */
14636 || pos <= tem)
14638 /* If the string from which this glyph came is
14639 found in the buffer at point, or at position
14640 that is closer to point than pos_after, then
14641 we've found the glyph we've been looking for.
14642 If it comes from an overlay (tem == 0), and
14643 it has the `cursor' property on one of its
14644 glyphs, record that glyph as a candidate for
14645 displaying the cursor. (As in the
14646 unidirectional version, we will display the
14647 cursor on the last candidate we find.) */
14648 if (tem == 0
14649 || tem == pt_old
14650 || (tem - pt_old > 0 && tem < pos_after))
14652 /* The glyphs from this string could have
14653 been reordered. Find the one with the
14654 smallest string position. Or there could
14655 be a character in the string with the
14656 `cursor' property, which means display
14657 cursor on that character's glyph. */
14658 ptrdiff_t strpos = glyph->charpos;
14660 if (tem)
14662 cursor = glyph;
14663 string_from_text_prop = true;
14665 for ( ;
14666 (row->reversed_p ? glyph > stop : glyph < stop)
14667 && EQ (glyph->object, str);
14668 glyph += incr)
14670 Lisp_Object cprop;
14671 ptrdiff_t gpos = glyph->charpos;
14673 cprop = Fget_char_property (make_number (gpos),
14674 Qcursor,
14675 glyph->object);
14676 if (!NILP (cprop))
14678 cursor = glyph;
14679 break;
14681 if (tem && glyph->charpos < strpos)
14683 strpos = glyph->charpos;
14684 cursor = glyph;
14688 if (tem == pt_old
14689 || (tem - pt_old > 0 && tem < pos_after))
14690 goto compute_x;
14692 if (tem)
14693 pos = tem + 1; /* don't find previous instances */
14695 /* This string is not what we want; skip all of the
14696 glyphs that came from it. */
14697 while ((row->reversed_p ? glyph > stop : glyph < stop)
14698 && EQ (glyph->object, str))
14699 glyph += incr;
14701 else
14702 glyph += incr;
14705 /* If we reached the end of the line, and END was from a string,
14706 the cursor is not on this line. */
14707 if (cursor == NULL
14708 && (row->reversed_p ? glyph <= end : glyph >= end)
14709 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14710 && STRINGP (end->object)
14711 && row->continued_p)
14712 return false;
14714 /* A truncated row may not include PT among its character positions.
14715 Setting the cursor inside the scroll margin will trigger
14716 recalculation of hscroll in hscroll_window_tree. But if a
14717 display string covers point, defer to the string-handling
14718 code below to figure this out. */
14719 else if (row->truncated_on_left_p && pt_old < bpos_min)
14721 cursor = glyph_before;
14722 x = -1;
14724 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14725 /* Zero-width characters produce no glyphs. */
14726 || (!empty_line_p
14727 && (row->reversed_p
14728 ? glyph_after > glyphs_end
14729 : glyph_after < glyphs_end)))
14731 cursor = glyph_after;
14732 x = -1;
14736 compute_x:
14737 if (cursor != NULL)
14738 glyph = cursor;
14739 else if (glyph == glyphs_end
14740 && pos_before == pos_after
14741 && STRINGP ((row->reversed_p
14742 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14743 : row->glyphs[TEXT_AREA])->object))
14745 /* If all the glyphs of this row came from strings, put the
14746 cursor on the first glyph of the row. This avoids having the
14747 cursor outside of the text area in this very rare and hard
14748 use case. */
14749 glyph =
14750 row->reversed_p
14751 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14752 : row->glyphs[TEXT_AREA];
14754 if (x < 0)
14756 struct glyph *g;
14758 /* Need to compute x that corresponds to GLYPH. */
14759 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14761 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14762 emacs_abort ();
14763 x += g->pixel_width;
14767 /* ROW could be part of a continued line, which, under bidi
14768 reordering, might have other rows whose start and end charpos
14769 occlude point. Only set w->cursor if we found a better
14770 approximation to the cursor position than we have from previously
14771 examined candidate rows belonging to the same continued line. */
14772 if (/* We already have a candidate row. */
14773 w->cursor.vpos >= 0
14774 /* That candidate is not the row we are processing. */
14775 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14776 /* Make sure cursor.vpos specifies a row whose start and end
14777 charpos occlude point, and it is valid candidate for being a
14778 cursor-row. This is because some callers of this function
14779 leave cursor.vpos at the row where the cursor was displayed
14780 during the last redisplay cycle. */
14781 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14782 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14783 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14785 struct glyph *g1
14786 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14788 /* Don't consider glyphs that are outside TEXT_AREA. */
14789 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14790 return false;
14791 /* Keep the candidate whose buffer position is the closest to
14792 point or has the `cursor' property. */
14793 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14794 w->cursor.hpos >= 0
14795 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14796 && ((BUFFERP (g1->object)
14797 && (g1->charpos == pt_old /* An exact match always wins. */
14798 || (BUFFERP (glyph->object)
14799 && eabs (g1->charpos - pt_old)
14800 < eabs (glyph->charpos - pt_old))))
14801 /* Previous candidate is a glyph from a string that has
14802 a non-nil `cursor' property. */
14803 || (STRINGP (g1->object)
14804 && (!NILP (Fget_char_property (make_number (g1->charpos),
14805 Qcursor, g1->object))
14806 /* Previous candidate is from the same display
14807 string as this one, and the display string
14808 came from a text property. */
14809 || (EQ (g1->object, glyph->object)
14810 && string_from_text_prop)
14811 /* this candidate is from newline and its
14812 position is not an exact match */
14813 || (NILP (glyph->object)
14814 && glyph->charpos != pt_old)))))
14815 return false;
14816 /* If this candidate gives an exact match, use that. */
14817 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14818 /* If this candidate is a glyph created for the
14819 terminating newline of a line, and point is on that
14820 newline, it wins because it's an exact match. */
14821 || (!row->continued_p
14822 && NILP (glyph->object)
14823 && glyph->charpos == 0
14824 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14825 /* Otherwise, keep the candidate that comes from a row
14826 spanning less buffer positions. This may win when one or
14827 both candidate positions are on glyphs that came from
14828 display strings, for which we cannot compare buffer
14829 positions. */
14830 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14831 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14832 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14833 return false;
14835 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14836 w->cursor.x = x;
14837 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14838 w->cursor.y = row->y + dy;
14840 if (w == XWINDOW (selected_window))
14842 if (!row->continued_p
14843 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14844 && row->x == 0)
14846 this_line_buffer = XBUFFER (w->contents);
14848 CHARPOS (this_line_start_pos)
14849 = MATRIX_ROW_START_CHARPOS (row) + delta;
14850 BYTEPOS (this_line_start_pos)
14851 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14853 CHARPOS (this_line_end_pos)
14854 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14855 BYTEPOS (this_line_end_pos)
14856 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14858 this_line_y = w->cursor.y;
14859 this_line_pixel_height = row->height;
14860 this_line_vpos = w->cursor.vpos;
14861 this_line_start_x = row->x;
14863 else
14864 CHARPOS (this_line_start_pos) = 0;
14867 return true;
14871 /* Run window scroll functions, if any, for WINDOW with new window
14872 start STARTP. Sets the window start of WINDOW to that position.
14874 We assume that the window's buffer is really current. */
14876 static struct text_pos
14877 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
14879 struct window *w = XWINDOW (window);
14880 SET_MARKER_FROM_TEXT_POS (w->start, startp);
14882 eassert (current_buffer == XBUFFER (w->contents));
14884 if (!NILP (Vwindow_scroll_functions))
14886 run_hook_with_args_2 (Qwindow_scroll_functions, window,
14887 make_number (CHARPOS (startp)));
14888 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14889 /* In case the hook functions switch buffers. */
14890 set_buffer_internal (XBUFFER (w->contents));
14893 return startp;
14897 /* Make sure the line containing the cursor is fully visible.
14898 A value of true means there is nothing to be done.
14899 (Either the line is fully visible, or it cannot be made so,
14900 or we cannot tell.)
14902 If FORCE_P, return false even if partial visible cursor row
14903 is higher than window.
14905 If CURRENT_MATRIX_P, use the information from the
14906 window's current glyph matrix; otherwise use the desired glyph
14907 matrix.
14909 A value of false means the caller should do scrolling
14910 as if point had gone off the screen. */
14912 static bool
14913 cursor_row_fully_visible_p (struct window *w, bool force_p,
14914 bool current_matrix_p)
14916 struct glyph_matrix *matrix;
14917 struct glyph_row *row;
14918 int window_height;
14920 if (!make_cursor_line_fully_visible_p)
14921 return true;
14923 /* It's not always possible to find the cursor, e.g, when a window
14924 is full of overlay strings. Don't do anything in that case. */
14925 if (w->cursor.vpos < 0)
14926 return true;
14928 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
14929 row = MATRIX_ROW (matrix, w->cursor.vpos);
14931 /* If the cursor row is not partially visible, there's nothing to do. */
14932 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
14933 return true;
14935 /* If the row the cursor is in is taller than the window's height,
14936 it's not clear what to do, so do nothing. */
14937 window_height = window_box_height (w);
14938 if (row->height >= window_height)
14940 if (!force_p || MINI_WINDOW_P (w)
14941 || w->vscroll || w->cursor.vpos == 0)
14942 return true;
14944 return false;
14948 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14949 means only WINDOW is redisplayed in redisplay_internal.
14950 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14951 in redisplay_window to bring a partially visible line into view in
14952 the case that only the cursor has moved.
14954 LAST_LINE_MISFIT should be true if we're scrolling because the
14955 last screen line's vertical height extends past the end of the screen.
14957 Value is
14959 1 if scrolling succeeded
14961 0 if scrolling didn't find point.
14963 -1 if new fonts have been loaded so that we must interrupt
14964 redisplay, adjust glyph matrices, and try again. */
14966 enum
14968 SCROLLING_SUCCESS,
14969 SCROLLING_FAILED,
14970 SCROLLING_NEED_LARGER_MATRICES
14973 /* If scroll-conservatively is more than this, never recenter.
14975 If you change this, don't forget to update the doc string of
14976 `scroll-conservatively' and the Emacs manual. */
14977 #define SCROLL_LIMIT 100
14979 static int
14980 try_scrolling (Lisp_Object window, bool just_this_one_p,
14981 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
14982 bool temp_scroll_step, bool last_line_misfit)
14984 struct window *w = XWINDOW (window);
14985 struct frame *f = XFRAME (w->frame);
14986 struct text_pos pos, startp;
14987 struct it it;
14988 int this_scroll_margin, scroll_max, rc, height;
14989 int dy = 0, amount_to_scroll = 0;
14990 bool scroll_down_p = false;
14991 int extra_scroll_margin_lines = last_line_misfit;
14992 Lisp_Object aggressive;
14993 /* We will never try scrolling more than this number of lines. */
14994 int scroll_limit = SCROLL_LIMIT;
14995 int frame_line_height = default_line_pixel_height (w);
14996 int window_total_lines
14997 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
14999 #ifdef GLYPH_DEBUG
15000 debug_method_add (w, "try_scrolling");
15001 #endif
15003 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15005 /* Compute scroll margin height in pixels. We scroll when point is
15006 within this distance from the top or bottom of the window. */
15007 if (scroll_margin > 0)
15008 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
15009 * frame_line_height;
15010 else
15011 this_scroll_margin = 0;
15013 /* Force arg_scroll_conservatively to have a reasonable value, to
15014 avoid scrolling too far away with slow move_it_* functions. Note
15015 that the user can supply scroll-conservatively equal to
15016 `most-positive-fixnum', which can be larger than INT_MAX. */
15017 if (arg_scroll_conservatively > scroll_limit)
15019 arg_scroll_conservatively = scroll_limit + 1;
15020 scroll_max = scroll_limit * frame_line_height;
15022 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15023 /* Compute how much we should try to scroll maximally to bring
15024 point into view. */
15025 scroll_max = (max (scroll_step,
15026 max (arg_scroll_conservatively, temp_scroll_step))
15027 * frame_line_height);
15028 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15029 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15030 /* We're trying to scroll because of aggressive scrolling but no
15031 scroll_step is set. Choose an arbitrary one. */
15032 scroll_max = 10 * frame_line_height;
15033 else
15034 scroll_max = 0;
15036 too_near_end:
15038 /* Decide whether to scroll down. */
15039 if (PT > CHARPOS (startp))
15041 int scroll_margin_y;
15043 /* Compute the pixel ypos of the scroll margin, then move IT to
15044 either that ypos or PT, whichever comes first. */
15045 start_display (&it, w, startp);
15046 scroll_margin_y = it.last_visible_y - this_scroll_margin
15047 - frame_line_height * extra_scroll_margin_lines;
15048 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15049 (MOVE_TO_POS | MOVE_TO_Y));
15051 if (PT > CHARPOS (it.current.pos))
15053 int y0 = line_bottom_y (&it);
15054 /* Compute how many pixels below window bottom to stop searching
15055 for PT. This avoids costly search for PT that is far away if
15056 the user limited scrolling by a small number of lines, but
15057 always finds PT if scroll_conservatively is set to a large
15058 number, such as most-positive-fixnum. */
15059 int slack = max (scroll_max, 10 * frame_line_height);
15060 int y_to_move = it.last_visible_y + slack;
15062 /* Compute the distance from the scroll margin to PT or to
15063 the scroll limit, whichever comes first. This should
15064 include the height of the cursor line, to make that line
15065 fully visible. */
15066 move_it_to (&it, PT, -1, y_to_move,
15067 -1, MOVE_TO_POS | MOVE_TO_Y);
15068 dy = line_bottom_y (&it) - y0;
15070 if (dy > scroll_max)
15071 return SCROLLING_FAILED;
15073 if (dy > 0)
15074 scroll_down_p = true;
15078 if (scroll_down_p)
15080 /* Point is in or below the bottom scroll margin, so move the
15081 window start down. If scrolling conservatively, move it just
15082 enough down to make point visible. If scroll_step is set,
15083 move it down by scroll_step. */
15084 if (arg_scroll_conservatively)
15085 amount_to_scroll
15086 = min (max (dy, frame_line_height),
15087 frame_line_height * arg_scroll_conservatively);
15088 else if (scroll_step || temp_scroll_step)
15089 amount_to_scroll = scroll_max;
15090 else
15092 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15093 height = WINDOW_BOX_TEXT_HEIGHT (w);
15094 if (NUMBERP (aggressive))
15096 double float_amount = XFLOATINT (aggressive) * height;
15097 int aggressive_scroll = float_amount;
15098 if (aggressive_scroll == 0 && float_amount > 0)
15099 aggressive_scroll = 1;
15100 /* Don't let point enter the scroll margin near top of
15101 the window. This could happen if the value of
15102 scroll_up_aggressively is too large and there are
15103 non-zero margins, because scroll_up_aggressively
15104 means put point that fraction of window height
15105 _from_the_bottom_margin_. */
15106 if (aggressive_scroll + 2 * this_scroll_margin > height)
15107 aggressive_scroll = height - 2 * this_scroll_margin;
15108 amount_to_scroll = dy + aggressive_scroll;
15112 if (amount_to_scroll <= 0)
15113 return SCROLLING_FAILED;
15115 start_display (&it, w, startp);
15116 if (arg_scroll_conservatively <= scroll_limit)
15117 move_it_vertically (&it, amount_to_scroll);
15118 else
15120 /* Extra precision for users who set scroll-conservatively
15121 to a large number: make sure the amount we scroll
15122 the window start is never less than amount_to_scroll,
15123 which was computed as distance from window bottom to
15124 point. This matters when lines at window top and lines
15125 below window bottom have different height. */
15126 struct it it1;
15127 void *it1data = NULL;
15128 /* We use a temporary it1 because line_bottom_y can modify
15129 its argument, if it moves one line down; see there. */
15130 int start_y;
15132 SAVE_IT (it1, it, it1data);
15133 start_y = line_bottom_y (&it1);
15134 do {
15135 RESTORE_IT (&it, &it, it1data);
15136 move_it_by_lines (&it, 1);
15137 SAVE_IT (it1, it, it1data);
15138 } while (IT_CHARPOS (it) < ZV
15139 && line_bottom_y (&it1) - start_y < amount_to_scroll);
15140 bidi_unshelve_cache (it1data, true);
15143 /* If STARTP is unchanged, move it down another screen line. */
15144 if (IT_CHARPOS (it) == CHARPOS (startp))
15145 move_it_by_lines (&it, 1);
15146 startp = it.current.pos;
15148 else
15150 struct text_pos scroll_margin_pos = startp;
15151 int y_offset = 0;
15153 /* See if point is inside the scroll margin at the top of the
15154 window. */
15155 if (this_scroll_margin)
15157 int y_start;
15159 start_display (&it, w, startp);
15160 y_start = it.current_y;
15161 move_it_vertically (&it, this_scroll_margin);
15162 scroll_margin_pos = it.current.pos;
15163 /* If we didn't move enough before hitting ZV, request
15164 additional amount of scroll, to move point out of the
15165 scroll margin. */
15166 if (IT_CHARPOS (it) == ZV
15167 && it.current_y - y_start < this_scroll_margin)
15168 y_offset = this_scroll_margin - (it.current_y - y_start);
15171 if (PT < CHARPOS (scroll_margin_pos))
15173 /* Point is in the scroll margin at the top of the window or
15174 above what is displayed in the window. */
15175 int y0, y_to_move;
15177 /* Compute the vertical distance from PT to the scroll
15178 margin position. Move as far as scroll_max allows, or
15179 one screenful, or 10 screen lines, whichever is largest.
15180 Give up if distance is greater than scroll_max or if we
15181 didn't reach the scroll margin position. */
15182 SET_TEXT_POS (pos, PT, PT_BYTE);
15183 start_display (&it, w, pos);
15184 y0 = it.current_y;
15185 y_to_move = max (it.last_visible_y,
15186 max (scroll_max, 10 * frame_line_height));
15187 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15188 y_to_move, -1,
15189 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15190 dy = it.current_y - y0;
15191 if (dy > scroll_max
15192 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15193 return SCROLLING_FAILED;
15195 /* Additional scroll for when ZV was too close to point. */
15196 dy += y_offset;
15198 /* Compute new window start. */
15199 start_display (&it, w, startp);
15201 if (arg_scroll_conservatively)
15202 amount_to_scroll = max (dy, frame_line_height
15203 * max (scroll_step, temp_scroll_step));
15204 else if (scroll_step || temp_scroll_step)
15205 amount_to_scroll = scroll_max;
15206 else
15208 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15209 height = WINDOW_BOX_TEXT_HEIGHT (w);
15210 if (NUMBERP (aggressive))
15212 double float_amount = XFLOATINT (aggressive) * height;
15213 int aggressive_scroll = float_amount;
15214 if (aggressive_scroll == 0 && float_amount > 0)
15215 aggressive_scroll = 1;
15216 /* Don't let point enter the scroll margin near
15217 bottom of the window, if the value of
15218 scroll_down_aggressively happens to be too
15219 large. */
15220 if (aggressive_scroll + 2 * this_scroll_margin > height)
15221 aggressive_scroll = height - 2 * this_scroll_margin;
15222 amount_to_scroll = dy + aggressive_scroll;
15226 if (amount_to_scroll <= 0)
15227 return SCROLLING_FAILED;
15229 move_it_vertically_backward (&it, amount_to_scroll);
15230 startp = it.current.pos;
15234 /* Run window scroll functions. */
15235 startp = run_window_scroll_functions (window, startp);
15237 /* Display the window. Give up if new fonts are loaded, or if point
15238 doesn't appear. */
15239 if (!try_window (window, startp, 0))
15240 rc = SCROLLING_NEED_LARGER_MATRICES;
15241 else if (w->cursor.vpos < 0)
15243 clear_glyph_matrix (w->desired_matrix);
15244 rc = SCROLLING_FAILED;
15246 else
15248 /* Maybe forget recorded base line for line number display. */
15249 if (!just_this_one_p
15250 || current_buffer->clip_changed
15251 || BEG_UNCHANGED < CHARPOS (startp))
15252 w->base_line_number = 0;
15254 /* If cursor ends up on a partially visible line,
15255 treat that as being off the bottom of the screen. */
15256 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1,
15257 false)
15258 /* It's possible that the cursor is on the first line of the
15259 buffer, which is partially obscured due to a vscroll
15260 (Bug#7537). In that case, avoid looping forever. */
15261 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15263 clear_glyph_matrix (w->desired_matrix);
15264 ++extra_scroll_margin_lines;
15265 goto too_near_end;
15267 rc = SCROLLING_SUCCESS;
15270 return rc;
15274 /* Compute a suitable window start for window W if display of W starts
15275 on a continuation line. Value is true if a new window start
15276 was computed.
15278 The new window start will be computed, based on W's width, starting
15279 from the start of the continued line. It is the start of the
15280 screen line with the minimum distance from the old start W->start. */
15282 static bool
15283 compute_window_start_on_continuation_line (struct window *w)
15285 struct text_pos pos, start_pos;
15286 bool window_start_changed_p = false;
15288 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15290 /* If window start is on a continuation line... Window start may be
15291 < BEGV in case there's invisible text at the start of the
15292 buffer (M-x rmail, for example). */
15293 if (CHARPOS (start_pos) > BEGV
15294 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15296 struct it it;
15297 struct glyph_row *row;
15299 /* Handle the case that the window start is out of range. */
15300 if (CHARPOS (start_pos) < BEGV)
15301 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15302 else if (CHARPOS (start_pos) > ZV)
15303 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15305 /* Find the start of the continued line. This should be fast
15306 because find_newline is fast (newline cache). */
15307 row = w->desired_matrix->rows + WINDOW_WANTS_HEADER_LINE_P (w);
15308 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15309 row, DEFAULT_FACE_ID);
15310 reseat_at_previous_visible_line_start (&it);
15312 /* If the line start is "too far" away from the window start,
15313 say it takes too much time to compute a new window start. */
15314 if (CHARPOS (start_pos) - IT_CHARPOS (it)
15315 /* PXW: Do we need upper bounds here? */
15316 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
15318 int min_distance, distance;
15320 /* Move forward by display lines to find the new window
15321 start. If window width was enlarged, the new start can
15322 be expected to be > the old start. If window width was
15323 decreased, the new window start will be < the old start.
15324 So, we're looking for the display line start with the
15325 minimum distance from the old window start. */
15326 pos = it.current.pos;
15327 min_distance = INFINITY;
15328 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15329 distance < min_distance)
15331 min_distance = distance;
15332 pos = it.current.pos;
15333 if (it.line_wrap == WORD_WRAP)
15335 /* Under WORD_WRAP, move_it_by_lines is likely to
15336 overshoot and stop not at the first, but the
15337 second character from the left margin. So in
15338 that case, we need a more tight control on the X
15339 coordinate of the iterator than move_it_by_lines
15340 promises in its contract. The method is to first
15341 go to the last (rightmost) visible character of a
15342 line, then move to the leftmost character on the
15343 next line in a separate call. */
15344 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15345 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15346 move_it_to (&it, ZV, 0,
15347 it.current_y + it.max_ascent + it.max_descent, -1,
15348 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15350 else
15351 move_it_by_lines (&it, 1);
15354 /* Set the window start there. */
15355 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15356 window_start_changed_p = true;
15360 return window_start_changed_p;
15364 /* Try cursor movement in case text has not changed in window WINDOW,
15365 with window start STARTP. Value is
15367 CURSOR_MOVEMENT_SUCCESS if successful
15369 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15371 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15372 display. *SCROLL_STEP is set to true, under certain circumstances, if
15373 we want to scroll as if scroll-step were set to 1. See the code.
15375 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15376 which case we have to abort this redisplay, and adjust matrices
15377 first. */
15379 enum
15381 CURSOR_MOVEMENT_SUCCESS,
15382 CURSOR_MOVEMENT_CANNOT_BE_USED,
15383 CURSOR_MOVEMENT_MUST_SCROLL,
15384 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15387 static int
15388 try_cursor_movement (Lisp_Object window, struct text_pos startp,
15389 bool *scroll_step)
15391 struct window *w = XWINDOW (window);
15392 struct frame *f = XFRAME (w->frame);
15393 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15395 #ifdef GLYPH_DEBUG
15396 if (inhibit_try_cursor_movement)
15397 return rc;
15398 #endif
15400 /* Previously, there was a check for Lisp integer in the
15401 if-statement below. Now, this field is converted to
15402 ptrdiff_t, thus zero means invalid position in a buffer. */
15403 eassert (w->last_point > 0);
15404 /* Likewise there was a check whether window_end_vpos is nil or larger
15405 than the window. Now window_end_vpos is int and so never nil, but
15406 let's leave eassert to check whether it fits in the window. */
15407 eassert (!w->window_end_valid
15408 || w->window_end_vpos < w->current_matrix->nrows);
15410 /* Handle case where text has not changed, only point, and it has
15411 not moved off the frame. */
15412 if (/* Point may be in this window. */
15413 PT >= CHARPOS (startp)
15414 /* Selective display hasn't changed. */
15415 && !current_buffer->clip_changed
15416 /* Function force-mode-line-update is used to force a thorough
15417 redisplay. It sets either windows_or_buffers_changed or
15418 update_mode_lines. So don't take a shortcut here for these
15419 cases. */
15420 && !update_mode_lines
15421 && !windows_or_buffers_changed
15422 && !f->cursor_type_changed
15423 && NILP (Vshow_trailing_whitespace)
15424 /* This code is not used for mini-buffer for the sake of the case
15425 of redisplaying to replace an echo area message; since in
15426 that case the mini-buffer contents per se are usually
15427 unchanged. This code is of no real use in the mini-buffer
15428 since the handling of this_line_start_pos, etc., in redisplay
15429 handles the same cases. */
15430 && !EQ (window, minibuf_window)
15431 && (FRAME_WINDOW_P (f)
15432 || !overlay_arrow_in_current_buffer_p ()))
15434 int this_scroll_margin, top_scroll_margin;
15435 struct glyph_row *row = NULL;
15436 int frame_line_height = default_line_pixel_height (w);
15437 int window_total_lines
15438 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15440 #ifdef GLYPH_DEBUG
15441 debug_method_add (w, "cursor movement");
15442 #endif
15444 /* Scroll if point within this distance from the top or bottom
15445 of the window. This is a pixel value. */
15446 if (scroll_margin > 0)
15448 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15449 this_scroll_margin *= frame_line_height;
15451 else
15452 this_scroll_margin = 0;
15454 top_scroll_margin = this_scroll_margin;
15455 if (WINDOW_WANTS_HEADER_LINE_P (w))
15456 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15458 /* Start with the row the cursor was displayed during the last
15459 not paused redisplay. Give up if that row is not valid. */
15460 if (w->last_cursor_vpos < 0
15461 || w->last_cursor_vpos >= w->current_matrix->nrows)
15462 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15463 else
15465 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15466 if (row->mode_line_p)
15467 ++row;
15468 if (!row->enabled_p)
15469 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15472 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15474 bool scroll_p = false, must_scroll = false;
15475 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15477 if (PT > w->last_point)
15479 /* Point has moved forward. */
15480 while (MATRIX_ROW_END_CHARPOS (row) < PT
15481 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15483 eassert (row->enabled_p);
15484 ++row;
15487 /* If the end position of a row equals the start
15488 position of the next row, and PT is at that position,
15489 we would rather display cursor in the next line. */
15490 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15491 && MATRIX_ROW_END_CHARPOS (row) == PT
15492 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15493 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15494 && !cursor_row_p (row))
15495 ++row;
15497 /* If within the scroll margin, scroll. Note that
15498 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15499 the next line would be drawn, and that
15500 this_scroll_margin can be zero. */
15501 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15502 || PT > MATRIX_ROW_END_CHARPOS (row)
15503 /* Line is completely visible last line in window
15504 and PT is to be set in the next line. */
15505 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15506 && PT == MATRIX_ROW_END_CHARPOS (row)
15507 && !row->ends_at_zv_p
15508 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15509 scroll_p = true;
15511 else if (PT < w->last_point)
15513 /* Cursor has to be moved backward. Note that PT >=
15514 CHARPOS (startp) because of the outer if-statement. */
15515 while (!row->mode_line_p
15516 && (MATRIX_ROW_START_CHARPOS (row) > PT
15517 || (MATRIX_ROW_START_CHARPOS (row) == PT
15518 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15519 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15520 row > w->current_matrix->rows
15521 && (row-1)->ends_in_newline_from_string_p))))
15522 && (row->y > top_scroll_margin
15523 || CHARPOS (startp) == BEGV))
15525 eassert (row->enabled_p);
15526 --row;
15529 /* Consider the following case: Window starts at BEGV,
15530 there is invisible, intangible text at BEGV, so that
15531 display starts at some point START > BEGV. It can
15532 happen that we are called with PT somewhere between
15533 BEGV and START. Try to handle that case. */
15534 if (row < w->current_matrix->rows
15535 || row->mode_line_p)
15537 row = w->current_matrix->rows;
15538 if (row->mode_line_p)
15539 ++row;
15542 /* Due to newlines in overlay strings, we may have to
15543 skip forward over overlay strings. */
15544 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15545 && MATRIX_ROW_END_CHARPOS (row) == PT
15546 && !cursor_row_p (row))
15547 ++row;
15549 /* If within the scroll margin, scroll. */
15550 if (row->y < top_scroll_margin
15551 && CHARPOS (startp) != BEGV)
15552 scroll_p = true;
15554 else
15556 /* Cursor did not move. So don't scroll even if cursor line
15557 is partially visible, as it was so before. */
15558 rc = CURSOR_MOVEMENT_SUCCESS;
15561 if (PT < MATRIX_ROW_START_CHARPOS (row)
15562 || PT > MATRIX_ROW_END_CHARPOS (row))
15564 /* if PT is not in the glyph row, give up. */
15565 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15566 must_scroll = true;
15568 else if (rc != CURSOR_MOVEMENT_SUCCESS
15569 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15571 struct glyph_row *row1;
15573 /* If rows are bidi-reordered and point moved, back up
15574 until we find a row that does not belong to a
15575 continuation line. This is because we must consider
15576 all rows of a continued line as candidates for the
15577 new cursor positioning, since row start and end
15578 positions change non-linearly with vertical position
15579 in such rows. */
15580 /* FIXME: Revisit this when glyph ``spilling'' in
15581 continuation lines' rows is implemented for
15582 bidi-reordered rows. */
15583 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15584 MATRIX_ROW_CONTINUATION_LINE_P (row);
15585 --row)
15587 /* If we hit the beginning of the displayed portion
15588 without finding the first row of a continued
15589 line, give up. */
15590 if (row <= row1)
15592 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15593 break;
15595 eassert (row->enabled_p);
15598 if (must_scroll)
15600 else if (rc != CURSOR_MOVEMENT_SUCCESS
15601 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15602 /* Make sure this isn't a header line by any chance, since
15603 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15604 && !row->mode_line_p
15605 && make_cursor_line_fully_visible_p)
15607 if (PT == MATRIX_ROW_END_CHARPOS (row)
15608 && !row->ends_at_zv_p
15609 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15610 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15611 else if (row->height > window_box_height (w))
15613 /* If we end up in a partially visible line, let's
15614 make it fully visible, except when it's taller
15615 than the window, in which case we can't do much
15616 about it. */
15617 *scroll_step = true;
15618 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15620 else
15622 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15623 if (!cursor_row_fully_visible_p (w, false, true))
15624 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15625 else
15626 rc = CURSOR_MOVEMENT_SUCCESS;
15629 else if (scroll_p)
15630 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15631 else if (rc != CURSOR_MOVEMENT_SUCCESS
15632 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15634 /* With bidi-reordered rows, there could be more than
15635 one candidate row whose start and end positions
15636 occlude point. We need to let set_cursor_from_row
15637 find the best candidate. */
15638 /* FIXME: Revisit this when glyph ``spilling'' in
15639 continuation lines' rows is implemented for
15640 bidi-reordered rows. */
15641 bool rv = false;
15645 bool at_zv_p = false, exact_match_p = false;
15647 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15648 && PT <= MATRIX_ROW_END_CHARPOS (row)
15649 && cursor_row_p (row))
15650 rv |= set_cursor_from_row (w, row, w->current_matrix,
15651 0, 0, 0, 0);
15652 /* As soon as we've found the exact match for point,
15653 or the first suitable row whose ends_at_zv_p flag
15654 is set, we are done. */
15655 if (rv)
15657 at_zv_p = MATRIX_ROW (w->current_matrix,
15658 w->cursor.vpos)->ends_at_zv_p;
15659 if (!at_zv_p
15660 && w->cursor.hpos >= 0
15661 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15662 w->cursor.vpos))
15664 struct glyph_row *candidate =
15665 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15666 struct glyph *g =
15667 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15668 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15670 exact_match_p =
15671 (BUFFERP (g->object) && g->charpos == PT)
15672 || (NILP (g->object)
15673 && (g->charpos == PT
15674 || (g->charpos == 0 && endpos - 1 == PT)));
15676 if (at_zv_p || exact_match_p)
15678 rc = CURSOR_MOVEMENT_SUCCESS;
15679 break;
15682 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15683 break;
15684 ++row;
15686 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15687 || row->continued_p)
15688 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15689 || (MATRIX_ROW_START_CHARPOS (row) == PT
15690 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15691 /* If we didn't find any candidate rows, or exited the
15692 loop before all the candidates were examined, signal
15693 to the caller that this method failed. */
15694 if (rc != CURSOR_MOVEMENT_SUCCESS
15695 && !(rv
15696 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15697 && !row->continued_p))
15698 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15699 else if (rv)
15700 rc = CURSOR_MOVEMENT_SUCCESS;
15702 else
15706 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15708 rc = CURSOR_MOVEMENT_SUCCESS;
15709 break;
15711 ++row;
15713 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15714 && MATRIX_ROW_START_CHARPOS (row) == PT
15715 && cursor_row_p (row));
15720 return rc;
15724 void
15725 set_vertical_scroll_bar (struct window *w)
15727 ptrdiff_t start, end, whole;
15729 /* Calculate the start and end positions for the current window.
15730 At some point, it would be nice to choose between scrollbars
15731 which reflect the whole buffer size, with special markers
15732 indicating narrowing, and scrollbars which reflect only the
15733 visible region.
15735 Note that mini-buffers sometimes aren't displaying any text. */
15736 if (!MINI_WINDOW_P (w)
15737 || (w == XWINDOW (minibuf_window)
15738 && NILP (echo_area_buffer[0])))
15740 struct buffer *buf = XBUFFER (w->contents);
15741 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15742 start = marker_position (w->start) - BUF_BEGV (buf);
15743 /* I don't think this is guaranteed to be right. For the
15744 moment, we'll pretend it is. */
15745 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15747 if (end < start)
15748 end = start;
15749 if (whole < (end - start))
15750 whole = end - start;
15752 else
15753 start = end = whole = 0;
15755 /* Indicate what this scroll bar ought to be displaying now. */
15756 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15757 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15758 (w, end - start, whole, start);
15762 void
15763 set_horizontal_scroll_bar (struct window *w)
15765 int start, end, whole, portion;
15767 if (!MINI_WINDOW_P (w)
15768 || (w == XWINDOW (minibuf_window)
15769 && NILP (echo_area_buffer[0])))
15771 struct buffer *b = XBUFFER (w->contents);
15772 struct buffer *old_buffer = NULL;
15773 struct it it;
15774 struct text_pos startp;
15776 if (b != current_buffer)
15778 old_buffer = current_buffer;
15779 set_buffer_internal (b);
15782 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15783 start_display (&it, w, startp);
15784 it.last_visible_x = INT_MAX;
15785 whole = move_it_to (&it, -1, INT_MAX, window_box_height (w), -1,
15786 MOVE_TO_X | MOVE_TO_Y);
15787 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15788 window_box_height (w), -1,
15789 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15791 start = w->hscroll * FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));
15792 end = start + window_box_width (w, TEXT_AREA);
15793 portion = end - start;
15794 /* After enlarging a horizontally scrolled window such that it
15795 gets at least as wide as the text it contains, make sure that
15796 the thumb doesn't fill the entire scroll bar so we can still
15797 drag it back to see the entire text. */
15798 whole = max (whole, end);
15800 if (it.bidi_p)
15802 Lisp_Object pdir;
15804 pdir = Fcurrent_bidi_paragraph_direction (Qnil);
15805 if (EQ (pdir, Qright_to_left))
15807 start = whole - end;
15808 end = start + portion;
15812 if (old_buffer)
15813 set_buffer_internal (old_buffer);
15815 else
15816 start = end = whole = portion = 0;
15818 w->hscroll_whole = whole;
15820 /* Indicate what this scroll bar ought to be displaying now. */
15821 if (FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
15822 (*FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
15823 (w, portion, whole, start);
15827 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15828 selected_window is redisplayed.
15830 We can return without actually redisplaying the window if fonts has been
15831 changed on window's frame. In that case, redisplay_internal will retry.
15833 As one of the important parts of redisplaying a window, we need to
15834 decide whether the previous window-start position (stored in the
15835 window's w->start marker position) is still valid, and if it isn't,
15836 recompute it. Some details about that:
15838 . The previous window-start could be in a continuation line, in
15839 which case we need to recompute it when the window width
15840 changes. See compute_window_start_on_continuation_line and its
15841 call below.
15843 . The text that changed since last redisplay could include the
15844 previous window-start position. In that case, we try to salvage
15845 what we can from the current glyph matrix by calling
15846 try_scrolling, which see.
15848 . Some Emacs command could force us to use a specific window-start
15849 position by setting the window's force_start flag, or gently
15850 propose doing that by setting the window's optional_new_start
15851 flag. In these cases, we try using the specified start point if
15852 that succeeds (i.e. the window desired matrix is successfully
15853 recomputed, and point location is within the window). In case
15854 of optional_new_start, we first check if the specified start
15855 position is feasible, i.e. if it will allow point to be
15856 displayed in the window. If using the specified start point
15857 fails, e.g., if new fonts are needed to be loaded, we abort the
15858 redisplay cycle and leave it up to the next cycle to figure out
15859 things.
15861 . Note that the window's force_start flag is sometimes set by
15862 redisplay itself, when it decides that the previous window start
15863 point is fine and should be kept. Search for "goto force_start"
15864 below to see the details. Like the values of window-start
15865 specified outside of redisplay, these internally-deduced values
15866 are tested for feasibility, and ignored if found to be
15867 unfeasible.
15869 . Note that the function try_window, used to completely redisplay
15870 a window, accepts the window's start point as its argument.
15871 This is used several times in the redisplay code to control
15872 where the window start will be, according to user options such
15873 as scroll-conservatively, and also to ensure the screen line
15874 showing point will be fully (as opposed to partially) visible on
15875 display. */
15877 static void
15878 redisplay_window (Lisp_Object window, bool just_this_one_p)
15880 struct window *w = XWINDOW (window);
15881 struct frame *f = XFRAME (w->frame);
15882 struct buffer *buffer = XBUFFER (w->contents);
15883 struct buffer *old = current_buffer;
15884 struct text_pos lpoint, opoint, startp;
15885 bool update_mode_line;
15886 int tem;
15887 struct it it;
15888 /* Record it now because it's overwritten. */
15889 bool current_matrix_up_to_date_p = false;
15890 bool used_current_matrix_p = false;
15891 /* This is less strict than current_matrix_up_to_date_p.
15892 It indicates that the buffer contents and narrowing are unchanged. */
15893 bool buffer_unchanged_p = false;
15894 bool temp_scroll_step = false;
15895 ptrdiff_t count = SPECPDL_INDEX ();
15896 int rc;
15897 int centering_position = -1;
15898 bool last_line_misfit = false;
15899 ptrdiff_t beg_unchanged, end_unchanged;
15900 int frame_line_height;
15902 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15903 opoint = lpoint;
15905 #ifdef GLYPH_DEBUG
15906 *w->desired_matrix->method = 0;
15907 #endif
15909 if (!just_this_one_p
15910 && REDISPLAY_SOME_P ()
15911 && !w->redisplay
15912 && !w->update_mode_line
15913 && !f->redisplay
15914 && !buffer->text->redisplay
15915 && BUF_PT (buffer) == w->last_point)
15916 return;
15918 /* Make sure that both W's markers are valid. */
15919 eassert (XMARKER (w->start)->buffer == buffer);
15920 eassert (XMARKER (w->pointm)->buffer == buffer);
15922 /* We come here again if we need to run window-text-change-functions
15923 below. */
15924 restart:
15925 reconsider_clip_changes (w);
15926 frame_line_height = default_line_pixel_height (w);
15928 /* Has the mode line to be updated? */
15929 update_mode_line = (w->update_mode_line
15930 || update_mode_lines
15931 || buffer->clip_changed
15932 || buffer->prevent_redisplay_optimizations_p);
15934 if (!just_this_one_p)
15935 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15936 cleverly elsewhere. */
15937 w->must_be_updated_p = true;
15939 if (MINI_WINDOW_P (w))
15941 if (w == XWINDOW (echo_area_window)
15942 && !NILP (echo_area_buffer[0]))
15944 if (update_mode_line)
15945 /* We may have to update a tty frame's menu bar or a
15946 tool-bar. Example `M-x C-h C-h C-g'. */
15947 goto finish_menu_bars;
15948 else
15949 /* We've already displayed the echo area glyphs in this window. */
15950 goto finish_scroll_bars;
15952 else if ((w != XWINDOW (minibuf_window)
15953 || minibuf_level == 0)
15954 /* When buffer is nonempty, redisplay window normally. */
15955 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
15956 /* Quail displays non-mini buffers in minibuffer window.
15957 In that case, redisplay the window normally. */
15958 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
15960 /* W is a mini-buffer window, but it's not active, so clear
15961 it. */
15962 int yb = window_text_bottom_y (w);
15963 struct glyph_row *row;
15964 int y;
15966 for (y = 0, row = w->desired_matrix->rows;
15967 y < yb;
15968 y += row->height, ++row)
15969 blank_row (w, row, y);
15970 goto finish_scroll_bars;
15973 clear_glyph_matrix (w->desired_matrix);
15976 /* Otherwise set up data on this window; select its buffer and point
15977 value. */
15978 /* Really select the buffer, for the sake of buffer-local
15979 variables. */
15980 set_buffer_internal_1 (XBUFFER (w->contents));
15982 current_matrix_up_to_date_p
15983 = (w->window_end_valid
15984 && !current_buffer->clip_changed
15985 && !current_buffer->prevent_redisplay_optimizations_p
15986 && !window_outdated (w));
15988 /* Run the window-text-change-functions
15989 if it is possible that the text on the screen has changed
15990 (either due to modification of the text, or any other reason). */
15991 if (!current_matrix_up_to_date_p
15992 && !NILP (Vwindow_text_change_functions))
15994 safe_run_hooks (Qwindow_text_change_functions);
15995 goto restart;
15998 beg_unchanged = BEG_UNCHANGED;
15999 end_unchanged = END_UNCHANGED;
16001 SET_TEXT_POS (opoint, PT, PT_BYTE);
16003 specbind (Qinhibit_point_motion_hooks, Qt);
16005 buffer_unchanged_p
16006 = (w->window_end_valid
16007 && !current_buffer->clip_changed
16008 && !window_outdated (w));
16010 /* When windows_or_buffers_changed is non-zero, we can't rely
16011 on the window end being valid, so set it to zero there. */
16012 if (windows_or_buffers_changed)
16014 /* If window starts on a continuation line, maybe adjust the
16015 window start in case the window's width changed. */
16016 if (XMARKER (w->start)->buffer == current_buffer)
16017 compute_window_start_on_continuation_line (w);
16019 w->window_end_valid = false;
16020 /* If so, we also can't rely on current matrix
16021 and should not fool try_cursor_movement below. */
16022 current_matrix_up_to_date_p = false;
16025 /* Some sanity checks. */
16026 CHECK_WINDOW_END (w);
16027 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
16028 emacs_abort ();
16029 if (BYTEPOS (opoint) < CHARPOS (opoint))
16030 emacs_abort ();
16032 if (mode_line_update_needed (w))
16033 update_mode_line = true;
16035 /* Point refers normally to the selected window. For any other
16036 window, set up appropriate value. */
16037 if (!EQ (window, selected_window))
16039 ptrdiff_t new_pt = marker_position (w->pointm);
16040 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
16042 if (new_pt < BEGV)
16044 new_pt = BEGV;
16045 new_pt_byte = BEGV_BYTE;
16046 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
16048 else if (new_pt > (ZV - 1))
16050 new_pt = ZV;
16051 new_pt_byte = ZV_BYTE;
16052 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
16055 /* We don't use SET_PT so that the point-motion hooks don't run. */
16056 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
16059 /* If any of the character widths specified in the display table
16060 have changed, invalidate the width run cache. It's true that
16061 this may be a bit late to catch such changes, but the rest of
16062 redisplay goes (non-fatally) haywire when the display table is
16063 changed, so why should we worry about doing any better? */
16064 if (current_buffer->width_run_cache
16065 || (current_buffer->base_buffer
16066 && current_buffer->base_buffer->width_run_cache))
16068 struct Lisp_Char_Table *disptab = buffer_display_table ();
16070 if (! disptab_matches_widthtab
16071 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
16073 struct buffer *buf = current_buffer;
16075 if (buf->base_buffer)
16076 buf = buf->base_buffer;
16077 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
16078 recompute_width_table (current_buffer, disptab);
16082 /* If window-start is screwed up, choose a new one. */
16083 if (XMARKER (w->start)->buffer != current_buffer)
16084 goto recenter;
16086 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16088 /* If someone specified a new starting point but did not insist,
16089 check whether it can be used. */
16090 if ((w->optional_new_start || window_frozen_p (w))
16091 && CHARPOS (startp) >= BEGV
16092 && CHARPOS (startp) <= ZV)
16094 ptrdiff_t it_charpos;
16096 w->optional_new_start = false;
16097 start_display (&it, w, startp);
16098 move_it_to (&it, PT, 0, it.last_visible_y, -1,
16099 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
16100 /* Record IT's position now, since line_bottom_y might change
16101 that. */
16102 it_charpos = IT_CHARPOS (it);
16103 /* Make sure we set the force_start flag only if the cursor row
16104 will be fully visible. Otherwise, the code under force_start
16105 label below will try to move point back into view, which is
16106 not what the code which sets optional_new_start wants. */
16107 if ((it.current_y == 0 || line_bottom_y (&it) < it.last_visible_y)
16108 && !w->force_start)
16110 if (it_charpos == PT)
16111 w->force_start = true;
16112 /* IT may overshoot PT if text at PT is invisible. */
16113 else if (it_charpos > PT && CHARPOS (startp) <= PT)
16114 w->force_start = true;
16115 #ifdef GLYPH_DEBUG
16116 if (w->force_start)
16118 if (window_frozen_p (w))
16119 debug_method_add (w, "set force_start from frozen window start");
16120 else
16121 debug_method_add (w, "set force_start from optional_new_start");
16123 #endif
16127 force_start:
16129 /* Handle case where place to start displaying has been specified,
16130 unless the specified location is outside the accessible range. */
16131 if (w->force_start)
16133 /* We set this later on if we have to adjust point. */
16134 int new_vpos = -1;
16136 w->force_start = false;
16137 w->vscroll = 0;
16138 w->window_end_valid = false;
16140 /* Forget any recorded base line for line number display. */
16141 if (!buffer_unchanged_p)
16142 w->base_line_number = 0;
16144 /* Redisplay the mode line. Select the buffer properly for that.
16145 Also, run the hook window-scroll-functions
16146 because we have scrolled. */
16147 /* Note, we do this after clearing force_start because
16148 if there's an error, it is better to forget about force_start
16149 than to get into an infinite loop calling the hook functions
16150 and having them get more errors. */
16151 if (!update_mode_line
16152 || ! NILP (Vwindow_scroll_functions))
16154 update_mode_line = true;
16155 w->update_mode_line = true;
16156 startp = run_window_scroll_functions (window, startp);
16159 if (CHARPOS (startp) < BEGV)
16160 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16161 else if (CHARPOS (startp) > ZV)
16162 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16164 /* Redisplay, then check if cursor has been set during the
16165 redisplay. Give up if new fonts were loaded. */
16166 /* We used to issue a CHECK_MARGINS argument to try_window here,
16167 but this causes scrolling to fail when point begins inside
16168 the scroll margin (bug#148) -- cyd */
16169 if (!try_window (window, startp, 0))
16171 w->force_start = true;
16172 clear_glyph_matrix (w->desired_matrix);
16173 goto need_larger_matrices;
16176 if (w->cursor.vpos < 0)
16178 /* If point does not appear, try to move point so it does
16179 appear. The desired matrix has been built above, so we
16180 can use it here. */
16181 new_vpos = window_box_height (w) / 2;
16184 if (!cursor_row_fully_visible_p (w, false, false))
16186 /* Point does appear, but on a line partly visible at end of window.
16187 Move it back to a fully-visible line. */
16188 new_vpos = window_box_height (w);
16189 /* But if window_box_height suggests a Y coordinate that is
16190 not less than we already have, that line will clearly not
16191 be fully visible, so give up and scroll the display.
16192 This can happen when the default face uses a font whose
16193 dimensions are different from the frame's default
16194 font. */
16195 if (new_vpos >= w->cursor.y)
16197 w->cursor.vpos = -1;
16198 clear_glyph_matrix (w->desired_matrix);
16199 goto try_to_scroll;
16202 else if (w->cursor.vpos >= 0)
16204 /* Some people insist on not letting point enter the scroll
16205 margin, even though this part handles windows that didn't
16206 scroll at all. */
16207 int window_total_lines
16208 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16209 int margin = min (scroll_margin, window_total_lines / 4);
16210 int pixel_margin = margin * frame_line_height;
16211 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16213 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16214 below, which finds the row to move point to, advances by
16215 the Y coordinate of the _next_ row, see the definition of
16216 MATRIX_ROW_BOTTOM_Y. */
16217 if (w->cursor.vpos < margin + header_line)
16219 w->cursor.vpos = -1;
16220 clear_glyph_matrix (w->desired_matrix);
16221 goto try_to_scroll;
16223 else
16225 int window_height = window_box_height (w);
16227 if (header_line)
16228 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16229 if (w->cursor.y >= window_height - pixel_margin)
16231 w->cursor.vpos = -1;
16232 clear_glyph_matrix (w->desired_matrix);
16233 goto try_to_scroll;
16238 /* If we need to move point for either of the above reasons,
16239 now actually do it. */
16240 if (new_vpos >= 0)
16242 struct glyph_row *row;
16244 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16245 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16246 ++row;
16248 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16249 MATRIX_ROW_START_BYTEPOS (row));
16251 if (w != XWINDOW (selected_window))
16252 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16253 else if (current_buffer == old)
16254 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16256 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16258 /* Re-run pre-redisplay-function so it can update the region
16259 according to the new position of point. */
16260 /* Other than the cursor, w's redisplay is done so we can set its
16261 redisplay to false. Also the buffer's redisplay can be set to
16262 false, since propagate_buffer_redisplay should have already
16263 propagated its info to `w' anyway. */
16264 w->redisplay = false;
16265 XBUFFER (w->contents)->text->redisplay = false;
16266 safe__call1 (true, Vpre_redisplay_function, Fcons (window, Qnil));
16268 if (w->redisplay || XBUFFER (w->contents)->text->redisplay)
16270 /* pre-redisplay-function made changes (e.g. move the region)
16271 that require another round of redisplay. */
16272 clear_glyph_matrix (w->desired_matrix);
16273 if (!try_window (window, startp, 0))
16274 goto need_larger_matrices;
16277 if (w->cursor.vpos < 0 || !cursor_row_fully_visible_p (w, false, false))
16279 clear_glyph_matrix (w->desired_matrix);
16280 goto try_to_scroll;
16283 #ifdef GLYPH_DEBUG
16284 debug_method_add (w, "forced window start");
16285 #endif
16286 goto done;
16289 /* Handle case where text has not changed, only point, and it has
16290 not moved off the frame, and we are not retrying after hscroll.
16291 (current_matrix_up_to_date_p is true when retrying.) */
16292 if (current_matrix_up_to_date_p
16293 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16294 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16296 switch (rc)
16298 case CURSOR_MOVEMENT_SUCCESS:
16299 used_current_matrix_p = true;
16300 goto done;
16302 case CURSOR_MOVEMENT_MUST_SCROLL:
16303 goto try_to_scroll;
16305 default:
16306 emacs_abort ();
16309 /* If current starting point was originally the beginning of a line
16310 but no longer is, find a new starting point. */
16311 else if (w->start_at_line_beg
16312 && !(CHARPOS (startp) <= BEGV
16313 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16315 #ifdef GLYPH_DEBUG
16316 debug_method_add (w, "recenter 1");
16317 #endif
16318 goto recenter;
16321 /* Try scrolling with try_window_id. Value is > 0 if update has
16322 been done, it is -1 if we know that the same window start will
16323 not work. It is 0 if unsuccessful for some other reason. */
16324 else if ((tem = try_window_id (w)) != 0)
16326 #ifdef GLYPH_DEBUG
16327 debug_method_add (w, "try_window_id %d", tem);
16328 #endif
16330 if (f->fonts_changed)
16331 goto need_larger_matrices;
16332 if (tem > 0)
16333 goto done;
16335 /* Otherwise try_window_id has returned -1 which means that we
16336 don't want the alternative below this comment to execute. */
16338 else if (CHARPOS (startp) >= BEGV
16339 && CHARPOS (startp) <= ZV
16340 && PT >= CHARPOS (startp)
16341 && (CHARPOS (startp) < ZV
16342 /* Avoid starting at end of buffer. */
16343 || CHARPOS (startp) == BEGV
16344 || !window_outdated (w)))
16346 int d1, d2, d5, d6;
16347 int rtop, rbot;
16349 /* If first window line is a continuation line, and window start
16350 is inside the modified region, but the first change is before
16351 current window start, we must select a new window start.
16353 However, if this is the result of a down-mouse event (e.g. by
16354 extending the mouse-drag-overlay), we don't want to select a
16355 new window start, since that would change the position under
16356 the mouse, resulting in an unwanted mouse-movement rather
16357 than a simple mouse-click. */
16358 if (!w->start_at_line_beg
16359 && NILP (do_mouse_tracking)
16360 && CHARPOS (startp) > BEGV
16361 && CHARPOS (startp) > BEG + beg_unchanged
16362 && CHARPOS (startp) <= Z - end_unchanged
16363 /* Even if w->start_at_line_beg is nil, a new window may
16364 start at a line_beg, since that's how set_buffer_window
16365 sets it. So, we need to check the return value of
16366 compute_window_start_on_continuation_line. (See also
16367 bug#197). */
16368 && XMARKER (w->start)->buffer == current_buffer
16369 && compute_window_start_on_continuation_line (w)
16370 /* It doesn't make sense to force the window start like we
16371 do at label force_start if it is already known that point
16372 will not be fully visible in the resulting window, because
16373 doing so will move point from its correct position
16374 instead of scrolling the window to bring point into view.
16375 See bug#9324. */
16376 && pos_visible_p (w, PT, &d1, &d2, &rtop, &rbot, &d5, &d6)
16377 /* A very tall row could need more than the window height,
16378 in which case we accept that it is partially visible. */
16379 && (rtop != 0) == (rbot != 0))
16381 w->force_start = true;
16382 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16383 #ifdef GLYPH_DEBUG
16384 debug_method_add (w, "recomputed window start in continuation line");
16385 #endif
16386 goto force_start;
16389 #ifdef GLYPH_DEBUG
16390 debug_method_add (w, "same window start");
16391 #endif
16393 /* Try to redisplay starting at same place as before.
16394 If point has not moved off frame, accept the results. */
16395 if (!current_matrix_up_to_date_p
16396 /* Don't use try_window_reusing_current_matrix in this case
16397 because a window scroll function can have changed the
16398 buffer. */
16399 || !NILP (Vwindow_scroll_functions)
16400 || MINI_WINDOW_P (w)
16401 || !(used_current_matrix_p
16402 = try_window_reusing_current_matrix (w)))
16404 IF_DEBUG (debug_method_add (w, "1"));
16405 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16406 /* -1 means we need to scroll.
16407 0 means we need new matrices, but fonts_changed
16408 is set in that case, so we will detect it below. */
16409 goto try_to_scroll;
16412 if (f->fonts_changed)
16413 goto need_larger_matrices;
16415 if (w->cursor.vpos >= 0)
16417 if (!just_this_one_p
16418 || current_buffer->clip_changed
16419 || BEG_UNCHANGED < CHARPOS (startp))
16420 /* Forget any recorded base line for line number display. */
16421 w->base_line_number = 0;
16423 if (!cursor_row_fully_visible_p (w, true, false))
16425 clear_glyph_matrix (w->desired_matrix);
16426 last_line_misfit = true;
16428 /* Drop through and scroll. */
16429 else
16430 goto done;
16432 else
16433 clear_glyph_matrix (w->desired_matrix);
16436 try_to_scroll:
16438 /* Redisplay the mode line. Select the buffer properly for that. */
16439 if (!update_mode_line)
16441 update_mode_line = true;
16442 w->update_mode_line = true;
16445 /* Try to scroll by specified few lines. */
16446 if ((scroll_conservatively
16447 || emacs_scroll_step
16448 || temp_scroll_step
16449 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16450 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16451 && CHARPOS (startp) >= BEGV
16452 && CHARPOS (startp) <= ZV)
16454 /* The function returns -1 if new fonts were loaded, 1 if
16455 successful, 0 if not successful. */
16456 int ss = try_scrolling (window, just_this_one_p,
16457 scroll_conservatively,
16458 emacs_scroll_step,
16459 temp_scroll_step, last_line_misfit);
16460 switch (ss)
16462 case SCROLLING_SUCCESS:
16463 goto done;
16465 case SCROLLING_NEED_LARGER_MATRICES:
16466 goto need_larger_matrices;
16468 case SCROLLING_FAILED:
16469 break;
16471 default:
16472 emacs_abort ();
16476 /* Finally, just choose a place to start which positions point
16477 according to user preferences. */
16479 recenter:
16481 #ifdef GLYPH_DEBUG
16482 debug_method_add (w, "recenter");
16483 #endif
16485 /* Forget any previously recorded base line for line number display. */
16486 if (!buffer_unchanged_p)
16487 w->base_line_number = 0;
16489 /* Determine the window start relative to point. */
16490 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16491 it.current_y = it.last_visible_y;
16492 if (centering_position < 0)
16494 int window_total_lines
16495 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16496 int margin
16497 = scroll_margin > 0
16498 ? min (scroll_margin, window_total_lines / 4)
16499 : 0;
16500 ptrdiff_t margin_pos = CHARPOS (startp);
16501 Lisp_Object aggressive;
16502 bool scrolling_up;
16504 /* If there is a scroll margin at the top of the window, find
16505 its character position. */
16506 if (margin
16507 /* Cannot call start_display if startp is not in the
16508 accessible region of the buffer. This can happen when we
16509 have just switched to a different buffer and/or changed
16510 its restriction. In that case, startp is initialized to
16511 the character position 1 (BEGV) because we did not yet
16512 have chance to display the buffer even once. */
16513 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16515 struct it it1;
16516 void *it1data = NULL;
16518 SAVE_IT (it1, it, it1data);
16519 start_display (&it1, w, startp);
16520 move_it_vertically (&it1, margin * frame_line_height);
16521 margin_pos = IT_CHARPOS (it1);
16522 RESTORE_IT (&it, &it, it1data);
16524 scrolling_up = PT > margin_pos;
16525 aggressive =
16526 scrolling_up
16527 ? BVAR (current_buffer, scroll_up_aggressively)
16528 : BVAR (current_buffer, scroll_down_aggressively);
16530 if (!MINI_WINDOW_P (w)
16531 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16533 int pt_offset = 0;
16535 /* Setting scroll-conservatively overrides
16536 scroll-*-aggressively. */
16537 if (!scroll_conservatively && NUMBERP (aggressive))
16539 double float_amount = XFLOATINT (aggressive);
16541 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16542 if (pt_offset == 0 && float_amount > 0)
16543 pt_offset = 1;
16544 if (pt_offset && margin > 0)
16545 margin -= 1;
16547 /* Compute how much to move the window start backward from
16548 point so that point will be displayed where the user
16549 wants it. */
16550 if (scrolling_up)
16552 centering_position = it.last_visible_y;
16553 if (pt_offset)
16554 centering_position -= pt_offset;
16555 centering_position -=
16556 (frame_line_height * (1 + margin + last_line_misfit)
16557 + WINDOW_HEADER_LINE_HEIGHT (w));
16558 /* Don't let point enter the scroll margin near top of
16559 the window. */
16560 if (centering_position < margin * frame_line_height)
16561 centering_position = margin * frame_line_height;
16563 else
16564 centering_position = margin * frame_line_height + pt_offset;
16566 else
16567 /* Set the window start half the height of the window backward
16568 from point. */
16569 centering_position = window_box_height (w) / 2;
16571 move_it_vertically_backward (&it, centering_position);
16573 eassert (IT_CHARPOS (it) >= BEGV);
16575 /* The function move_it_vertically_backward may move over more
16576 than the specified y-distance. If it->w is small, e.g. a
16577 mini-buffer window, we may end up in front of the window's
16578 display area. Start displaying at the start of the line
16579 containing PT in this case. */
16580 if (it.current_y <= 0)
16582 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16583 move_it_vertically_backward (&it, 0);
16584 it.current_y = 0;
16587 it.current_x = it.hpos = 0;
16589 /* Set the window start position here explicitly, to avoid an
16590 infinite loop in case the functions in window-scroll-functions
16591 get errors. */
16592 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16594 /* Run scroll hooks. */
16595 startp = run_window_scroll_functions (window, it.current.pos);
16597 /* Redisplay the window. */
16598 if (!current_matrix_up_to_date_p
16599 || windows_or_buffers_changed
16600 || f->cursor_type_changed
16601 /* Don't use try_window_reusing_current_matrix in this case
16602 because it can have changed the buffer. */
16603 || !NILP (Vwindow_scroll_functions)
16604 || !just_this_one_p
16605 || MINI_WINDOW_P (w)
16606 || !(used_current_matrix_p
16607 = try_window_reusing_current_matrix (w)))
16608 try_window (window, startp, 0);
16610 /* If new fonts have been loaded (due to fontsets), give up. We
16611 have to start a new redisplay since we need to re-adjust glyph
16612 matrices. */
16613 if (f->fonts_changed)
16614 goto need_larger_matrices;
16616 /* If cursor did not appear assume that the middle of the window is
16617 in the first line of the window. Do it again with the next line.
16618 (Imagine a window of height 100, displaying two lines of height
16619 60. Moving back 50 from it->last_visible_y will end in the first
16620 line.) */
16621 if (w->cursor.vpos < 0)
16623 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16625 clear_glyph_matrix (w->desired_matrix);
16626 move_it_by_lines (&it, 1);
16627 try_window (window, it.current.pos, 0);
16629 else if (PT < IT_CHARPOS (it))
16631 clear_glyph_matrix (w->desired_matrix);
16632 move_it_by_lines (&it, -1);
16633 try_window (window, it.current.pos, 0);
16635 else
16637 /* Not much we can do about it. */
16641 /* Consider the following case: Window starts at BEGV, there is
16642 invisible, intangible text at BEGV, so that display starts at
16643 some point START > BEGV. It can happen that we are called with
16644 PT somewhere between BEGV and START. Try to handle that case,
16645 and similar ones. */
16646 if (w->cursor.vpos < 0)
16648 /* First, try locating the proper glyph row for PT. */
16649 struct glyph_row *row =
16650 row_containing_pos (w, PT, w->current_matrix->rows, NULL, 0);
16652 /* Sometimes point is at the beginning of invisible text that is
16653 before the 1st character displayed in the row. In that case,
16654 row_containing_pos fails to find the row, because no glyphs
16655 with appropriate buffer positions are present in the row.
16656 Therefore, we next try to find the row which shows the 1st
16657 position after the invisible text. */
16658 if (!row)
16660 Lisp_Object val =
16661 get_char_property_and_overlay (make_number (PT), Qinvisible,
16662 Qnil, NULL);
16664 if (TEXT_PROP_MEANS_INVISIBLE (val) != 0)
16666 ptrdiff_t alt_pos;
16667 Lisp_Object invis_end =
16668 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16669 Qnil, Qnil);
16671 if (NATNUMP (invis_end))
16672 alt_pos = XFASTINT (invis_end);
16673 else
16674 alt_pos = ZV;
16675 row = row_containing_pos (w, alt_pos, w->current_matrix->rows,
16676 NULL, 0);
16679 /* Finally, fall back on the first row of the window after the
16680 header line (if any). This is slightly better than not
16681 displaying the cursor at all. */
16682 if (!row)
16684 row = w->current_matrix->rows;
16685 if (row->mode_line_p)
16686 ++row;
16688 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16691 if (!cursor_row_fully_visible_p (w, false, false))
16693 /* If vscroll is enabled, disable it and try again. */
16694 if (w->vscroll)
16696 w->vscroll = 0;
16697 clear_glyph_matrix (w->desired_matrix);
16698 goto recenter;
16701 /* Users who set scroll-conservatively to a large number want
16702 point just above/below the scroll margin. If we ended up
16703 with point's row partially visible, move the window start to
16704 make that row fully visible and out of the margin. */
16705 if (scroll_conservatively > SCROLL_LIMIT)
16707 int window_total_lines
16708 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) * frame_line_height;
16709 int margin =
16710 scroll_margin > 0
16711 ? min (scroll_margin, window_total_lines / 4)
16712 : 0;
16713 bool move_down = w->cursor.vpos >= window_total_lines / 2;
16715 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16716 clear_glyph_matrix (w->desired_matrix);
16717 if (1 == try_window (window, it.current.pos,
16718 TRY_WINDOW_CHECK_MARGINS))
16719 goto done;
16722 /* If centering point failed to make the whole line visible,
16723 put point at the top instead. That has to make the whole line
16724 visible, if it can be done. */
16725 if (centering_position == 0)
16726 goto done;
16728 clear_glyph_matrix (w->desired_matrix);
16729 centering_position = 0;
16730 goto recenter;
16733 done:
16735 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16736 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16737 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16739 /* Display the mode line, if we must. */
16740 if ((update_mode_line
16741 /* If window not full width, must redo its mode line
16742 if (a) the window to its side is being redone and
16743 (b) we do a frame-based redisplay. This is a consequence
16744 of how inverted lines are drawn in frame-based redisplay. */
16745 || (!just_this_one_p
16746 && !FRAME_WINDOW_P (f)
16747 && !WINDOW_FULL_WIDTH_P (w))
16748 /* Line number to display. */
16749 || w->base_line_pos > 0
16750 /* Column number is displayed and different from the one displayed. */
16751 || (w->column_number_displayed != -1
16752 && (w->column_number_displayed != current_column ())))
16753 /* This means that the window has a mode line. */
16754 && (WINDOW_WANTS_MODELINE_P (w)
16755 || WINDOW_WANTS_HEADER_LINE_P (w)))
16758 display_mode_lines (w);
16760 /* If mode line height has changed, arrange for a thorough
16761 immediate redisplay using the correct mode line height. */
16762 if (WINDOW_WANTS_MODELINE_P (w)
16763 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16765 f->fonts_changed = true;
16766 w->mode_line_height = -1;
16767 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16768 = DESIRED_MODE_LINE_HEIGHT (w);
16771 /* If header line height has changed, arrange for a thorough
16772 immediate redisplay using the correct header line height. */
16773 if (WINDOW_WANTS_HEADER_LINE_P (w)
16774 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16776 f->fonts_changed = true;
16777 w->header_line_height = -1;
16778 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16779 = DESIRED_HEADER_LINE_HEIGHT (w);
16782 if (f->fonts_changed)
16783 goto need_larger_matrices;
16786 if (!line_number_displayed && w->base_line_pos != -1)
16788 w->base_line_pos = 0;
16789 w->base_line_number = 0;
16792 finish_menu_bars:
16794 /* When we reach a frame's selected window, redo the frame's menu bar. */
16795 if (update_mode_line
16796 && EQ (FRAME_SELECTED_WINDOW (f), window))
16798 bool redisplay_menu_p;
16800 if (FRAME_WINDOW_P (f))
16802 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16803 || defined (HAVE_NS) || defined (USE_GTK)
16804 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16805 #else
16806 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16807 #endif
16809 else
16810 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16812 if (redisplay_menu_p)
16813 display_menu_bar (w);
16815 #ifdef HAVE_WINDOW_SYSTEM
16816 if (FRAME_WINDOW_P (f))
16818 #if defined (USE_GTK) || defined (HAVE_NS)
16819 if (FRAME_EXTERNAL_TOOL_BAR (f))
16820 redisplay_tool_bar (f);
16821 #else
16822 if (WINDOWP (f->tool_bar_window)
16823 && (FRAME_TOOL_BAR_LINES (f) > 0
16824 || !NILP (Vauto_resize_tool_bars))
16825 && redisplay_tool_bar (f))
16826 ignore_mouse_drag_p = true;
16827 #endif
16829 #endif
16832 #ifdef HAVE_WINDOW_SYSTEM
16833 if (FRAME_WINDOW_P (f)
16834 && update_window_fringes (w, (just_this_one_p
16835 || (!used_current_matrix_p && !overlay_arrow_seen)
16836 || w->pseudo_window_p)))
16838 update_begin (f);
16839 block_input ();
16840 if (draw_window_fringes (w, true))
16842 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
16843 x_draw_right_divider (w);
16844 else
16845 x_draw_vertical_border (w);
16847 unblock_input ();
16848 update_end (f);
16851 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
16852 x_draw_bottom_divider (w);
16853 #endif /* HAVE_WINDOW_SYSTEM */
16855 /* We go to this label, with fonts_changed set, if it is
16856 necessary to try again using larger glyph matrices.
16857 We have to redeem the scroll bar even in this case,
16858 because the loop in redisplay_internal expects that. */
16859 need_larger_matrices:
16861 finish_scroll_bars:
16863 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
16865 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16866 /* Set the thumb's position and size. */
16867 set_vertical_scroll_bar (w);
16869 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
16870 /* Set the thumb's position and size. */
16871 set_horizontal_scroll_bar (w);
16873 /* Note that we actually used the scroll bar attached to this
16874 window, so it shouldn't be deleted at the end of redisplay. */
16875 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16876 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16879 /* Restore current_buffer and value of point in it. The window
16880 update may have changed the buffer, so first make sure `opoint'
16881 is still valid (Bug#6177). */
16882 if (CHARPOS (opoint) < BEGV)
16883 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16884 else if (CHARPOS (opoint) > ZV)
16885 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16886 else
16887 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16889 set_buffer_internal_1 (old);
16890 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16891 shorter. This can be caused by log truncation in *Messages*. */
16892 if (CHARPOS (lpoint) <= ZV)
16893 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16895 unbind_to (count, Qnil);
16899 /* Build the complete desired matrix of WINDOW with a window start
16900 buffer position POS.
16902 Value is 1 if successful. It is zero if fonts were loaded during
16903 redisplay which makes re-adjusting glyph matrices necessary, and -1
16904 if point would appear in the scroll margins.
16905 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16906 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16907 set in FLAGS.) */
16910 try_window (Lisp_Object window, struct text_pos pos, int flags)
16912 struct window *w = XWINDOW (window);
16913 struct it it;
16914 struct glyph_row *last_text_row = NULL;
16915 struct frame *f = XFRAME (w->frame);
16916 int frame_line_height = default_line_pixel_height (w);
16918 /* Make POS the new window start. */
16919 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
16921 /* Mark cursor position as unknown. No overlay arrow seen. */
16922 w->cursor.vpos = -1;
16923 overlay_arrow_seen = false;
16925 /* Initialize iterator and info to start at POS. */
16926 start_display (&it, w, pos);
16927 it.glyph_row->reversed_p = false;
16929 /* Display all lines of W. */
16930 while (it.current_y < it.last_visible_y)
16932 if (display_line (&it))
16933 last_text_row = it.glyph_row - 1;
16934 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
16935 return 0;
16938 /* Don't let the cursor end in the scroll margins. */
16939 if ((flags & TRY_WINDOW_CHECK_MARGINS)
16940 && !MINI_WINDOW_P (w))
16942 int this_scroll_margin;
16943 int window_total_lines
16944 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16946 if (scroll_margin > 0)
16948 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
16949 this_scroll_margin *= frame_line_height;
16951 else
16952 this_scroll_margin = 0;
16954 if ((w->cursor.y >= 0 /* not vscrolled */
16955 && w->cursor.y < this_scroll_margin
16956 && CHARPOS (pos) > BEGV
16957 && IT_CHARPOS (it) < ZV)
16958 /* rms: considering make_cursor_line_fully_visible_p here
16959 seems to give wrong results. We don't want to recenter
16960 when the last line is partly visible, we want to allow
16961 that case to be handled in the usual way. */
16962 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
16964 w->cursor.vpos = -1;
16965 clear_glyph_matrix (w->desired_matrix);
16966 return -1;
16970 /* If bottom moved off end of frame, change mode line percentage. */
16971 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
16972 w->update_mode_line = true;
16974 /* Set window_end_pos to the offset of the last character displayed
16975 on the window from the end of current_buffer. Set
16976 window_end_vpos to its row number. */
16977 if (last_text_row)
16979 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
16980 adjust_window_ends (w, last_text_row, false);
16981 eassert
16982 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
16983 w->window_end_vpos)));
16985 else
16987 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
16988 w->window_end_pos = Z - ZV;
16989 w->window_end_vpos = 0;
16992 /* But that is not valid info until redisplay finishes. */
16993 w->window_end_valid = false;
16994 return 1;
16999 /************************************************************************
17000 Window redisplay reusing current matrix when buffer has not changed
17001 ************************************************************************/
17003 /* Try redisplay of window W showing an unchanged buffer with a
17004 different window start than the last time it was displayed by
17005 reusing its current matrix. Value is true if successful.
17006 W->start is the new window start. */
17008 static bool
17009 try_window_reusing_current_matrix (struct window *w)
17011 struct frame *f = XFRAME (w->frame);
17012 struct glyph_row *bottom_row;
17013 struct it it;
17014 struct run run;
17015 struct text_pos start, new_start;
17016 int nrows_scrolled, i;
17017 struct glyph_row *last_text_row;
17018 struct glyph_row *last_reused_text_row;
17019 struct glyph_row *start_row;
17020 int start_vpos, min_y, max_y;
17022 #ifdef GLYPH_DEBUG
17023 if (inhibit_try_window_reusing)
17024 return false;
17025 #endif
17027 if (/* This function doesn't handle terminal frames. */
17028 !FRAME_WINDOW_P (f)
17029 /* Don't try to reuse the display if windows have been split
17030 or such. */
17031 || windows_or_buffers_changed
17032 || f->cursor_type_changed)
17033 return false;
17035 /* Can't do this if showing trailing whitespace. */
17036 if (!NILP (Vshow_trailing_whitespace))
17037 return false;
17039 /* If top-line visibility has changed, give up. */
17040 if (WINDOW_WANTS_HEADER_LINE_P (w)
17041 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
17042 return false;
17044 /* Give up if old or new display is scrolled vertically. We could
17045 make this function handle this, but right now it doesn't. */
17046 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17047 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
17048 return false;
17050 /* The variable new_start now holds the new window start. The old
17051 start `start' can be determined from the current matrix. */
17052 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
17053 start = start_row->minpos;
17054 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17056 /* Clear the desired matrix for the display below. */
17057 clear_glyph_matrix (w->desired_matrix);
17059 if (CHARPOS (new_start) <= CHARPOS (start))
17061 /* Don't use this method if the display starts with an ellipsis
17062 displayed for invisible text. It's not easy to handle that case
17063 below, and it's certainly not worth the effort since this is
17064 not a frequent case. */
17065 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
17066 return false;
17068 IF_DEBUG (debug_method_add (w, "twu1"));
17070 /* Display up to a row that can be reused. The variable
17071 last_text_row is set to the last row displayed that displays
17072 text. Note that it.vpos == 0 if or if not there is a
17073 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17074 start_display (&it, w, new_start);
17075 w->cursor.vpos = -1;
17076 last_text_row = last_reused_text_row = NULL;
17078 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17080 /* If we have reached into the characters in the START row,
17081 that means the line boundaries have changed. So we
17082 can't start copying with the row START. Maybe it will
17083 work to start copying with the following row. */
17084 while (IT_CHARPOS (it) > CHARPOS (start))
17086 /* Advance to the next row as the "start". */
17087 start_row++;
17088 start = start_row->minpos;
17089 /* If there are no more rows to try, or just one, give up. */
17090 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
17091 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
17092 || CHARPOS (start) == ZV)
17094 clear_glyph_matrix (w->desired_matrix);
17095 return false;
17098 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17100 /* If we have reached alignment, we can copy the rest of the
17101 rows. */
17102 if (IT_CHARPOS (it) == CHARPOS (start)
17103 /* Don't accept "alignment" inside a display vector,
17104 since start_row could have started in the middle of
17105 that same display vector (thus their character
17106 positions match), and we have no way of telling if
17107 that is the case. */
17108 && it.current.dpvec_index < 0)
17109 break;
17111 it.glyph_row->reversed_p = false;
17112 if (display_line (&it))
17113 last_text_row = it.glyph_row - 1;
17117 /* A value of current_y < last_visible_y means that we stopped
17118 at the previous window start, which in turn means that we
17119 have at least one reusable row. */
17120 if (it.current_y < it.last_visible_y)
17122 struct glyph_row *row;
17124 /* IT.vpos always starts from 0; it counts text lines. */
17125 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
17127 /* Find PT if not already found in the lines displayed. */
17128 if (w->cursor.vpos < 0)
17130 int dy = it.current_y - start_row->y;
17132 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17133 row = row_containing_pos (w, PT, row, NULL, dy);
17134 if (row)
17135 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
17136 dy, nrows_scrolled);
17137 else
17139 clear_glyph_matrix (w->desired_matrix);
17140 return false;
17144 /* Scroll the display. Do it before the current matrix is
17145 changed. The problem here is that update has not yet
17146 run, i.e. part of the current matrix is not up to date.
17147 scroll_run_hook will clear the cursor, and use the
17148 current matrix to get the height of the row the cursor is
17149 in. */
17150 run.current_y = start_row->y;
17151 run.desired_y = it.current_y;
17152 run.height = it.last_visible_y - it.current_y;
17154 if (run.height > 0 && run.current_y != run.desired_y)
17156 update_begin (f);
17157 FRAME_RIF (f)->update_window_begin_hook (w);
17158 FRAME_RIF (f)->clear_window_mouse_face (w);
17159 FRAME_RIF (f)->scroll_run_hook (w, &run);
17160 FRAME_RIF (f)->update_window_end_hook (w, false, false);
17161 update_end (f);
17164 /* Shift current matrix down by nrows_scrolled lines. */
17165 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17166 rotate_matrix (w->current_matrix,
17167 start_vpos,
17168 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17169 nrows_scrolled);
17171 /* Disable lines that must be updated. */
17172 for (i = 0; i < nrows_scrolled; ++i)
17173 (start_row + i)->enabled_p = false;
17175 /* Re-compute Y positions. */
17176 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17177 max_y = it.last_visible_y;
17178 for (row = start_row + nrows_scrolled;
17179 row < bottom_row;
17180 ++row)
17182 row->y = it.current_y;
17183 row->visible_height = row->height;
17185 if (row->y < min_y)
17186 row->visible_height -= min_y - row->y;
17187 if (row->y + row->height > max_y)
17188 row->visible_height -= row->y + row->height - max_y;
17189 if (row->fringe_bitmap_periodic_p)
17190 row->redraw_fringe_bitmaps_p = true;
17192 it.current_y += row->height;
17194 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17195 last_reused_text_row = row;
17196 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17197 break;
17200 /* Disable lines in the current matrix which are now
17201 below the window. */
17202 for (++row; row < bottom_row; ++row)
17203 row->enabled_p = row->mode_line_p = false;
17206 /* Update window_end_pos etc.; last_reused_text_row is the last
17207 reused row from the current matrix containing text, if any.
17208 The value of last_text_row is the last displayed line
17209 containing text. */
17210 if (last_reused_text_row)
17211 adjust_window_ends (w, last_reused_text_row, true);
17212 else if (last_text_row)
17213 adjust_window_ends (w, last_text_row, false);
17214 else
17216 /* This window must be completely empty. */
17217 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17218 w->window_end_pos = Z - ZV;
17219 w->window_end_vpos = 0;
17221 w->window_end_valid = false;
17223 /* Update hint: don't try scrolling again in update_window. */
17224 w->desired_matrix->no_scrolling_p = true;
17226 #ifdef GLYPH_DEBUG
17227 debug_method_add (w, "try_window_reusing_current_matrix 1");
17228 #endif
17229 return true;
17231 else if (CHARPOS (new_start) > CHARPOS (start))
17233 struct glyph_row *pt_row, *row;
17234 struct glyph_row *first_reusable_row;
17235 struct glyph_row *first_row_to_display;
17236 int dy;
17237 int yb = window_text_bottom_y (w);
17239 /* Find the row starting at new_start, if there is one. Don't
17240 reuse a partially visible line at the end. */
17241 first_reusable_row = start_row;
17242 while (first_reusable_row->enabled_p
17243 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17244 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17245 < CHARPOS (new_start)))
17246 ++first_reusable_row;
17248 /* Give up if there is no row to reuse. */
17249 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17250 || !first_reusable_row->enabled_p
17251 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17252 != CHARPOS (new_start)))
17253 return false;
17255 /* We can reuse fully visible rows beginning with
17256 first_reusable_row to the end of the window. Set
17257 first_row_to_display to the first row that cannot be reused.
17258 Set pt_row to the row containing point, if there is any. */
17259 pt_row = NULL;
17260 for (first_row_to_display = first_reusable_row;
17261 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17262 ++first_row_to_display)
17264 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17265 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17266 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17267 && first_row_to_display->ends_at_zv_p
17268 && pt_row == NULL)))
17269 pt_row = first_row_to_display;
17272 /* Start displaying at the start of first_row_to_display. */
17273 eassert (first_row_to_display->y < yb);
17274 init_to_row_start (&it, w, first_row_to_display);
17276 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17277 - start_vpos);
17278 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17279 - nrows_scrolled);
17280 it.current_y = (first_row_to_display->y - first_reusable_row->y
17281 + WINDOW_HEADER_LINE_HEIGHT (w));
17283 /* Display lines beginning with first_row_to_display in the
17284 desired matrix. Set last_text_row to the last row displayed
17285 that displays text. */
17286 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17287 if (pt_row == NULL)
17288 w->cursor.vpos = -1;
17289 last_text_row = NULL;
17290 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17291 if (display_line (&it))
17292 last_text_row = it.glyph_row - 1;
17294 /* If point is in a reused row, adjust y and vpos of the cursor
17295 position. */
17296 if (pt_row)
17298 w->cursor.vpos -= nrows_scrolled;
17299 w->cursor.y -= first_reusable_row->y - start_row->y;
17302 /* Give up if point isn't in a row displayed or reused. (This
17303 also handles the case where w->cursor.vpos < nrows_scrolled
17304 after the calls to display_line, which can happen with scroll
17305 margins. See bug#1295.) */
17306 if (w->cursor.vpos < 0)
17308 clear_glyph_matrix (w->desired_matrix);
17309 return false;
17312 /* Scroll the display. */
17313 run.current_y = first_reusable_row->y;
17314 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17315 run.height = it.last_visible_y - run.current_y;
17316 dy = run.current_y - run.desired_y;
17318 if (run.height)
17320 update_begin (f);
17321 FRAME_RIF (f)->update_window_begin_hook (w);
17322 FRAME_RIF (f)->clear_window_mouse_face (w);
17323 FRAME_RIF (f)->scroll_run_hook (w, &run);
17324 FRAME_RIF (f)->update_window_end_hook (w, false, false);
17325 update_end (f);
17328 /* Adjust Y positions of reused rows. */
17329 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17330 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17331 max_y = it.last_visible_y;
17332 for (row = first_reusable_row; row < first_row_to_display; ++row)
17334 row->y -= dy;
17335 row->visible_height = row->height;
17336 if (row->y < min_y)
17337 row->visible_height -= min_y - row->y;
17338 if (row->y + row->height > max_y)
17339 row->visible_height -= row->y + row->height - max_y;
17340 if (row->fringe_bitmap_periodic_p)
17341 row->redraw_fringe_bitmaps_p = true;
17344 /* Scroll the current matrix. */
17345 eassert (nrows_scrolled > 0);
17346 rotate_matrix (w->current_matrix,
17347 start_vpos,
17348 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17349 -nrows_scrolled);
17351 /* Disable rows not reused. */
17352 for (row -= nrows_scrolled; row < bottom_row; ++row)
17353 row->enabled_p = false;
17355 /* Point may have moved to a different line, so we cannot assume that
17356 the previous cursor position is valid; locate the correct row. */
17357 if (pt_row)
17359 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17360 row < bottom_row
17361 && PT >= MATRIX_ROW_END_CHARPOS (row)
17362 && !row->ends_at_zv_p;
17363 row++)
17365 w->cursor.vpos++;
17366 w->cursor.y = row->y;
17368 if (row < bottom_row)
17370 /* Can't simply scan the row for point with
17371 bidi-reordered glyph rows. Let set_cursor_from_row
17372 figure out where to put the cursor, and if it fails,
17373 give up. */
17374 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17376 if (!set_cursor_from_row (w, row, w->current_matrix,
17377 0, 0, 0, 0))
17379 clear_glyph_matrix (w->desired_matrix);
17380 return false;
17383 else
17385 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17386 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17388 for (; glyph < end
17389 && (!BUFFERP (glyph->object)
17390 || glyph->charpos < PT);
17391 glyph++)
17393 w->cursor.hpos++;
17394 w->cursor.x += glyph->pixel_width;
17400 /* Adjust window end. A null value of last_text_row means that
17401 the window end is in reused rows which in turn means that
17402 only its vpos can have changed. */
17403 if (last_text_row)
17404 adjust_window_ends (w, last_text_row, false);
17405 else
17406 w->window_end_vpos -= nrows_scrolled;
17408 w->window_end_valid = false;
17409 w->desired_matrix->no_scrolling_p = true;
17411 #ifdef GLYPH_DEBUG
17412 debug_method_add (w, "try_window_reusing_current_matrix 2");
17413 #endif
17414 return true;
17417 return false;
17422 /************************************************************************
17423 Window redisplay reusing current matrix when buffer has changed
17424 ************************************************************************/
17426 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17427 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17428 ptrdiff_t *, ptrdiff_t *);
17429 static struct glyph_row *
17430 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17431 struct glyph_row *);
17434 /* Return the last row in MATRIX displaying text. If row START is
17435 non-null, start searching with that row. IT gives the dimensions
17436 of the display. Value is null if matrix is empty; otherwise it is
17437 a pointer to the row found. */
17439 static struct glyph_row *
17440 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17441 struct glyph_row *start)
17443 struct glyph_row *row, *row_found;
17445 /* Set row_found to the last row in IT->w's current matrix
17446 displaying text. The loop looks funny but think of partially
17447 visible lines. */
17448 row_found = NULL;
17449 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17450 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17452 eassert (row->enabled_p);
17453 row_found = row;
17454 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17455 break;
17456 ++row;
17459 return row_found;
17463 /* Return the last row in the current matrix of W that is not affected
17464 by changes at the start of current_buffer that occurred since W's
17465 current matrix was built. Value is null if no such row exists.
17467 BEG_UNCHANGED us the number of characters unchanged at the start of
17468 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17469 first changed character in current_buffer. Characters at positions <
17470 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17471 when the current matrix was built. */
17473 static struct glyph_row *
17474 find_last_unchanged_at_beg_row (struct window *w)
17476 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17477 struct glyph_row *row;
17478 struct glyph_row *row_found = NULL;
17479 int yb = window_text_bottom_y (w);
17481 /* Find the last row displaying unchanged text. */
17482 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17483 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17484 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17485 ++row)
17487 if (/* If row ends before first_changed_pos, it is unchanged,
17488 except in some case. */
17489 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17490 /* When row ends in ZV and we write at ZV it is not
17491 unchanged. */
17492 && !row->ends_at_zv_p
17493 /* When first_changed_pos is the end of a continued line,
17494 row is not unchanged because it may be no longer
17495 continued. */
17496 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17497 && (row->continued_p
17498 || row->exact_window_width_line_p))
17499 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17500 needs to be recomputed, so don't consider this row as
17501 unchanged. This happens when the last line was
17502 bidi-reordered and was killed immediately before this
17503 redisplay cycle. In that case, ROW->end stores the
17504 buffer position of the first visual-order character of
17505 the killed text, which is now beyond ZV. */
17506 && CHARPOS (row->end.pos) <= ZV)
17507 row_found = row;
17509 /* Stop if last visible row. */
17510 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17511 break;
17514 return row_found;
17518 /* Find the first glyph row in the current matrix of W that is not
17519 affected by changes at the end of current_buffer since the
17520 time W's current matrix was built.
17522 Return in *DELTA the number of chars by which buffer positions in
17523 unchanged text at the end of current_buffer must be adjusted.
17525 Return in *DELTA_BYTES the corresponding number of bytes.
17527 Value is null if no such row exists, i.e. all rows are affected by
17528 changes. */
17530 static struct glyph_row *
17531 find_first_unchanged_at_end_row (struct window *w,
17532 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17534 struct glyph_row *row;
17535 struct glyph_row *row_found = NULL;
17537 *delta = *delta_bytes = 0;
17539 /* Display must not have been paused, otherwise the current matrix
17540 is not up to date. */
17541 eassert (w->window_end_valid);
17543 /* A value of window_end_pos >= END_UNCHANGED means that the window
17544 end is in the range of changed text. If so, there is no
17545 unchanged row at the end of W's current matrix. */
17546 if (w->window_end_pos >= END_UNCHANGED)
17547 return NULL;
17549 /* Set row to the last row in W's current matrix displaying text. */
17550 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17552 /* If matrix is entirely empty, no unchanged row exists. */
17553 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17555 /* The value of row is the last glyph row in the matrix having a
17556 meaningful buffer position in it. The end position of row
17557 corresponds to window_end_pos. This allows us to translate
17558 buffer positions in the current matrix to current buffer
17559 positions for characters not in changed text. */
17560 ptrdiff_t Z_old =
17561 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17562 ptrdiff_t Z_BYTE_old =
17563 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17564 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17565 struct glyph_row *first_text_row
17566 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17568 *delta = Z - Z_old;
17569 *delta_bytes = Z_BYTE - Z_BYTE_old;
17571 /* Set last_unchanged_pos to the buffer position of the last
17572 character in the buffer that has not been changed. Z is the
17573 index + 1 of the last character in current_buffer, i.e. by
17574 subtracting END_UNCHANGED we get the index of the last
17575 unchanged character, and we have to add BEG to get its buffer
17576 position. */
17577 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17578 last_unchanged_pos_old = last_unchanged_pos - *delta;
17580 /* Search backward from ROW for a row displaying a line that
17581 starts at a minimum position >= last_unchanged_pos_old. */
17582 for (; row > first_text_row; --row)
17584 /* This used to abort, but it can happen.
17585 It is ok to just stop the search instead here. KFS. */
17586 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17587 break;
17589 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17590 row_found = row;
17594 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17596 return row_found;
17600 /* Make sure that glyph rows in the current matrix of window W
17601 reference the same glyph memory as corresponding rows in the
17602 frame's frame matrix. This function is called after scrolling W's
17603 current matrix on a terminal frame in try_window_id and
17604 try_window_reusing_current_matrix. */
17606 static void
17607 sync_frame_with_window_matrix_rows (struct window *w)
17609 struct frame *f = XFRAME (w->frame);
17610 struct glyph_row *window_row, *window_row_end, *frame_row;
17612 /* Preconditions: W must be a leaf window and full-width. Its frame
17613 must have a frame matrix. */
17614 eassert (BUFFERP (w->contents));
17615 eassert (WINDOW_FULL_WIDTH_P (w));
17616 eassert (!FRAME_WINDOW_P (f));
17618 /* If W is a full-width window, glyph pointers in W's current matrix
17619 have, by definition, to be the same as glyph pointers in the
17620 corresponding frame matrix. Note that frame matrices have no
17621 marginal areas (see build_frame_matrix). */
17622 window_row = w->current_matrix->rows;
17623 window_row_end = window_row + w->current_matrix->nrows;
17624 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17625 while (window_row < window_row_end)
17627 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17628 struct glyph *end = window_row->glyphs[LAST_AREA];
17630 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17631 frame_row->glyphs[TEXT_AREA] = start;
17632 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17633 frame_row->glyphs[LAST_AREA] = end;
17635 /* Disable frame rows whose corresponding window rows have
17636 been disabled in try_window_id. */
17637 if (!window_row->enabled_p)
17638 frame_row->enabled_p = false;
17640 ++window_row, ++frame_row;
17645 /* Find the glyph row in window W containing CHARPOS. Consider all
17646 rows between START and END (not inclusive). END null means search
17647 all rows to the end of the display area of W. Value is the row
17648 containing CHARPOS or null. */
17650 struct glyph_row *
17651 row_containing_pos (struct window *w, ptrdiff_t charpos,
17652 struct glyph_row *start, struct glyph_row *end, int dy)
17654 struct glyph_row *row = start;
17655 struct glyph_row *best_row = NULL;
17656 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17657 int last_y;
17659 /* If we happen to start on a header-line, skip that. */
17660 if (row->mode_line_p)
17661 ++row;
17663 if ((end && row >= end) || !row->enabled_p)
17664 return NULL;
17666 last_y = window_text_bottom_y (w) - dy;
17668 while (true)
17670 /* Give up if we have gone too far. */
17671 if (end && row >= end)
17672 return NULL;
17673 /* This formerly returned if they were equal.
17674 I think that both quantities are of a "last plus one" type;
17675 if so, when they are equal, the row is within the screen. -- rms. */
17676 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17677 return NULL;
17679 /* If it is in this row, return this row. */
17680 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17681 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17682 /* The end position of a row equals the start
17683 position of the next row. If CHARPOS is there, we
17684 would rather consider it displayed in the next
17685 line, except when this line ends in ZV. */
17686 && !row_for_charpos_p (row, charpos)))
17687 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17689 struct glyph *g;
17691 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17692 || (!best_row && !row->continued_p))
17693 return row;
17694 /* In bidi-reordered rows, there could be several rows whose
17695 edges surround CHARPOS, all of these rows belonging to
17696 the same continued line. We need to find the row which
17697 fits CHARPOS the best. */
17698 for (g = row->glyphs[TEXT_AREA];
17699 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17700 g++)
17702 if (!STRINGP (g->object))
17704 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17706 mindif = eabs (g->charpos - charpos);
17707 best_row = row;
17708 /* Exact match always wins. */
17709 if (mindif == 0)
17710 return best_row;
17715 else if (best_row && !row->continued_p)
17716 return best_row;
17717 ++row;
17722 /* Try to redisplay window W by reusing its existing display. W's
17723 current matrix must be up to date when this function is called,
17724 i.e., window_end_valid must be true.
17726 Value is
17728 >= 1 if successful, i.e. display has been updated
17729 specifically:
17730 1 means the changes were in front of a newline that precedes
17731 the window start, and the whole current matrix was reused
17732 2 means the changes were after the last position displayed
17733 in the window, and the whole current matrix was reused
17734 3 means portions of the current matrix were reused, while
17735 some of the screen lines were redrawn
17736 -1 if redisplay with same window start is known not to succeed
17737 0 if otherwise unsuccessful
17739 The following steps are performed:
17741 1. Find the last row in the current matrix of W that is not
17742 affected by changes at the start of current_buffer. If no such row
17743 is found, give up.
17745 2. Find the first row in W's current matrix that is not affected by
17746 changes at the end of current_buffer. Maybe there is no such row.
17748 3. Display lines beginning with the row + 1 found in step 1 to the
17749 row found in step 2 or, if step 2 didn't find a row, to the end of
17750 the window.
17752 4. If cursor is not known to appear on the window, give up.
17754 5. If display stopped at the row found in step 2, scroll the
17755 display and current matrix as needed.
17757 6. Maybe display some lines at the end of W, if we must. This can
17758 happen under various circumstances, like a partially visible line
17759 becoming fully visible, or because newly displayed lines are displayed
17760 in smaller font sizes.
17762 7. Update W's window end information. */
17764 static int
17765 try_window_id (struct window *w)
17767 struct frame *f = XFRAME (w->frame);
17768 struct glyph_matrix *current_matrix = w->current_matrix;
17769 struct glyph_matrix *desired_matrix = w->desired_matrix;
17770 struct glyph_row *last_unchanged_at_beg_row;
17771 struct glyph_row *first_unchanged_at_end_row;
17772 struct glyph_row *row;
17773 struct glyph_row *bottom_row;
17774 int bottom_vpos;
17775 struct it it;
17776 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17777 int dvpos, dy;
17778 struct text_pos start_pos;
17779 struct run run;
17780 int first_unchanged_at_end_vpos = 0;
17781 struct glyph_row *last_text_row, *last_text_row_at_end;
17782 struct text_pos start;
17783 ptrdiff_t first_changed_charpos, last_changed_charpos;
17785 #ifdef GLYPH_DEBUG
17786 if (inhibit_try_window_id)
17787 return 0;
17788 #endif
17790 /* This is handy for debugging. */
17791 #if false
17792 #define GIVE_UP(X) \
17793 do { \
17794 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17795 return 0; \
17796 } while (false)
17797 #else
17798 #define GIVE_UP(X) return 0
17799 #endif
17801 SET_TEXT_POS_FROM_MARKER (start, w->start);
17803 /* Don't use this for mini-windows because these can show
17804 messages and mini-buffers, and we don't handle that here. */
17805 if (MINI_WINDOW_P (w))
17806 GIVE_UP (1);
17808 /* This flag is used to prevent redisplay optimizations. */
17809 if (windows_or_buffers_changed || f->cursor_type_changed)
17810 GIVE_UP (2);
17812 /* This function's optimizations cannot be used if overlays have
17813 changed in the buffer displayed by the window, so give up if they
17814 have. */
17815 if (w->last_overlay_modified != OVERLAY_MODIFF)
17816 GIVE_UP (200);
17818 /* Verify that narrowing has not changed.
17819 Also verify that we were not told to prevent redisplay optimizations.
17820 It would be nice to further
17821 reduce the number of cases where this prevents try_window_id. */
17822 if (current_buffer->clip_changed
17823 || current_buffer->prevent_redisplay_optimizations_p)
17824 GIVE_UP (3);
17826 /* Window must either use window-based redisplay or be full width. */
17827 if (!FRAME_WINDOW_P (f)
17828 && (!FRAME_LINE_INS_DEL_OK (f)
17829 || !WINDOW_FULL_WIDTH_P (w)))
17830 GIVE_UP (4);
17832 /* Give up if point is known NOT to appear in W. */
17833 if (PT < CHARPOS (start))
17834 GIVE_UP (5);
17836 /* Another way to prevent redisplay optimizations. */
17837 if (w->last_modified == 0)
17838 GIVE_UP (6);
17840 /* Verify that window is not hscrolled. */
17841 if (w->hscroll != 0)
17842 GIVE_UP (7);
17844 /* Verify that display wasn't paused. */
17845 if (!w->window_end_valid)
17846 GIVE_UP (8);
17848 /* Likewise if highlighting trailing whitespace. */
17849 if (!NILP (Vshow_trailing_whitespace))
17850 GIVE_UP (11);
17852 /* Can't use this if overlay arrow position and/or string have
17853 changed. */
17854 if (overlay_arrows_changed_p ())
17855 GIVE_UP (12);
17857 /* When word-wrap is on, adding a space to the first word of a
17858 wrapped line can change the wrap position, altering the line
17859 above it. It might be worthwhile to handle this more
17860 intelligently, but for now just redisplay from scratch. */
17861 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
17862 GIVE_UP (21);
17864 /* Under bidi reordering, adding or deleting a character in the
17865 beginning of a paragraph, before the first strong directional
17866 character, can change the base direction of the paragraph (unless
17867 the buffer specifies a fixed paragraph direction), which will
17868 require to redisplay the whole paragraph. It might be worthwhile
17869 to find the paragraph limits and widen the range of redisplayed
17870 lines to that, but for now just give up this optimization and
17871 redisplay from scratch. */
17872 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17873 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
17874 GIVE_UP (22);
17876 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17877 to that variable require thorough redisplay. */
17878 if (!NILP (BVAR (XBUFFER (w->contents), extra_line_spacing)))
17879 GIVE_UP (23);
17881 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17882 only if buffer has really changed. The reason is that the gap is
17883 initially at Z for freshly visited files. The code below would
17884 set end_unchanged to 0 in that case. */
17885 if (MODIFF > SAVE_MODIFF
17886 /* This seems to happen sometimes after saving a buffer. */
17887 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17889 if (GPT - BEG < BEG_UNCHANGED)
17890 BEG_UNCHANGED = GPT - BEG;
17891 if (Z - GPT < END_UNCHANGED)
17892 END_UNCHANGED = Z - GPT;
17895 /* The position of the first and last character that has been changed. */
17896 first_changed_charpos = BEG + BEG_UNCHANGED;
17897 last_changed_charpos = Z - END_UNCHANGED;
17899 /* If window starts after a line end, and the last change is in
17900 front of that newline, then changes don't affect the display.
17901 This case happens with stealth-fontification. Note that although
17902 the display is unchanged, glyph positions in the matrix have to
17903 be adjusted, of course. */
17904 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17905 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17906 && ((last_changed_charpos < CHARPOS (start)
17907 && CHARPOS (start) == BEGV)
17908 || (last_changed_charpos < CHARPOS (start) - 1
17909 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17911 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17912 struct glyph_row *r0;
17914 /* Compute how many chars/bytes have been added to or removed
17915 from the buffer. */
17916 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17917 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17918 Z_delta = Z - Z_old;
17919 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
17921 /* Give up if PT is not in the window. Note that it already has
17922 been checked at the start of try_window_id that PT is not in
17923 front of the window start. */
17924 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
17925 GIVE_UP (13);
17927 /* If window start is unchanged, we can reuse the whole matrix
17928 as is, after adjusting glyph positions. No need to compute
17929 the window end again, since its offset from Z hasn't changed. */
17930 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17931 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
17932 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
17933 /* PT must not be in a partially visible line. */
17934 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
17935 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17937 /* Adjust positions in the glyph matrix. */
17938 if (Z_delta || Z_delta_bytes)
17940 struct glyph_row *r1
17941 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17942 increment_matrix_positions (w->current_matrix,
17943 MATRIX_ROW_VPOS (r0, current_matrix),
17944 MATRIX_ROW_VPOS (r1, current_matrix),
17945 Z_delta, Z_delta_bytes);
17948 /* Set the cursor. */
17949 row = row_containing_pos (w, PT, r0, NULL, 0);
17950 if (row)
17951 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17952 return 1;
17956 /* Handle the case that changes are all below what is displayed in
17957 the window, and that PT is in the window. This shortcut cannot
17958 be taken if ZV is visible in the window, and text has been added
17959 there that is visible in the window. */
17960 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
17961 /* ZV is not visible in the window, or there are no
17962 changes at ZV, actually. */
17963 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
17964 || first_changed_charpos == last_changed_charpos))
17966 struct glyph_row *r0;
17968 /* Give up if PT is not in the window. Note that it already has
17969 been checked at the start of try_window_id that PT is not in
17970 front of the window start. */
17971 if (PT >= MATRIX_ROW_END_CHARPOS (row))
17972 GIVE_UP (14);
17974 /* If window start is unchanged, we can reuse the whole matrix
17975 as is, without changing glyph positions since no text has
17976 been added/removed in front of the window end. */
17977 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17978 if (TEXT_POS_EQUAL_P (start, r0->minpos)
17979 /* PT must not be in a partially visible line. */
17980 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
17981 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17983 /* We have to compute the window end anew since text
17984 could have been added/removed after it. */
17985 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
17986 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
17988 /* Set the cursor. */
17989 row = row_containing_pos (w, PT, r0, NULL, 0);
17990 if (row)
17991 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17992 return 2;
17996 /* Give up if window start is in the changed area.
17998 The condition used to read
18000 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18002 but why that was tested escapes me at the moment. */
18003 if (CHARPOS (start) >= first_changed_charpos
18004 && CHARPOS (start) <= last_changed_charpos)
18005 GIVE_UP (15);
18007 /* Check that window start agrees with the start of the first glyph
18008 row in its current matrix. Check this after we know the window
18009 start is not in changed text, otherwise positions would not be
18010 comparable. */
18011 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
18012 if (!TEXT_POS_EQUAL_P (start, row->minpos))
18013 GIVE_UP (16);
18015 /* Give up if the window ends in strings. Overlay strings
18016 at the end are difficult to handle, so don't try. */
18017 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
18018 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
18019 GIVE_UP (20);
18021 /* Compute the position at which we have to start displaying new
18022 lines. Some of the lines at the top of the window might be
18023 reusable because they are not displaying changed text. Find the
18024 last row in W's current matrix not affected by changes at the
18025 start of current_buffer. Value is null if changes start in the
18026 first line of window. */
18027 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
18028 if (last_unchanged_at_beg_row)
18030 /* Avoid starting to display in the middle of a character, a TAB
18031 for instance. This is easier than to set up the iterator
18032 exactly, and it's not a frequent case, so the additional
18033 effort wouldn't really pay off. */
18034 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
18035 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
18036 && last_unchanged_at_beg_row > w->current_matrix->rows)
18037 --last_unchanged_at_beg_row;
18039 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
18040 GIVE_UP (17);
18042 if (! init_to_row_end (&it, w, last_unchanged_at_beg_row))
18043 GIVE_UP (18);
18044 start_pos = it.current.pos;
18046 /* Start displaying new lines in the desired matrix at the same
18047 vpos we would use in the current matrix, i.e. below
18048 last_unchanged_at_beg_row. */
18049 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
18050 current_matrix);
18051 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18052 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
18054 eassert (it.hpos == 0 && it.current_x == 0);
18056 else
18058 /* There are no reusable lines at the start of the window.
18059 Start displaying in the first text line. */
18060 start_display (&it, w, start);
18061 it.vpos = it.first_vpos;
18062 start_pos = it.current.pos;
18065 /* Find the first row that is not affected by changes at the end of
18066 the buffer. Value will be null if there is no unchanged row, in
18067 which case we must redisplay to the end of the window. delta
18068 will be set to the value by which buffer positions beginning with
18069 first_unchanged_at_end_row have to be adjusted due to text
18070 changes. */
18071 first_unchanged_at_end_row
18072 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
18073 IF_DEBUG (debug_delta = delta);
18074 IF_DEBUG (debug_delta_bytes = delta_bytes);
18076 /* Set stop_pos to the buffer position up to which we will have to
18077 display new lines. If first_unchanged_at_end_row != NULL, this
18078 is the buffer position of the start of the line displayed in that
18079 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18080 that we don't stop at a buffer position. */
18081 stop_pos = 0;
18082 if (first_unchanged_at_end_row)
18084 eassert (last_unchanged_at_beg_row == NULL
18085 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
18087 /* If this is a continuation line, move forward to the next one
18088 that isn't. Changes in lines above affect this line.
18089 Caution: this may move first_unchanged_at_end_row to a row
18090 not displaying text. */
18091 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
18092 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18093 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18094 < it.last_visible_y))
18095 ++first_unchanged_at_end_row;
18097 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18098 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18099 >= it.last_visible_y))
18100 first_unchanged_at_end_row = NULL;
18101 else
18103 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
18104 + delta);
18105 first_unchanged_at_end_vpos
18106 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
18107 eassert (stop_pos >= Z - END_UNCHANGED);
18110 else if (last_unchanged_at_beg_row == NULL)
18111 GIVE_UP (19);
18114 #ifdef GLYPH_DEBUG
18116 /* Either there is no unchanged row at the end, or the one we have
18117 now displays text. This is a necessary condition for the window
18118 end pos calculation at the end of this function. */
18119 eassert (first_unchanged_at_end_row == NULL
18120 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18122 debug_last_unchanged_at_beg_vpos
18123 = (last_unchanged_at_beg_row
18124 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
18125 : -1);
18126 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
18128 #endif /* GLYPH_DEBUG */
18131 /* Display new lines. Set last_text_row to the last new line
18132 displayed which has text on it, i.e. might end up as being the
18133 line where the window_end_vpos is. */
18134 w->cursor.vpos = -1;
18135 last_text_row = NULL;
18136 overlay_arrow_seen = false;
18137 if (it.current_y < it.last_visible_y
18138 && !f->fonts_changed
18139 && (first_unchanged_at_end_row == NULL
18140 || IT_CHARPOS (it) < stop_pos))
18141 it.glyph_row->reversed_p = false;
18142 while (it.current_y < it.last_visible_y
18143 && !f->fonts_changed
18144 && (first_unchanged_at_end_row == NULL
18145 || IT_CHARPOS (it) < stop_pos))
18147 if (display_line (&it))
18148 last_text_row = it.glyph_row - 1;
18151 if (f->fonts_changed)
18152 return -1;
18154 /* The redisplay iterations in display_line above could have
18155 triggered font-lock, which could have done something that
18156 invalidates IT->w window's end-point information, on which we
18157 rely below. E.g., one package, which will remain unnamed, used
18158 to install a font-lock-fontify-region-function that called
18159 bury-buffer, whose side effect is to switch the buffer displayed
18160 by IT->w, and that predictably resets IT->w's window_end_valid
18161 flag, which we already tested at the entry to this function.
18162 Amply punish such packages/modes by giving up on this
18163 optimization in those cases. */
18164 if (!w->window_end_valid)
18166 clear_glyph_matrix (w->desired_matrix);
18167 return -1;
18170 /* Compute differences in buffer positions, y-positions etc. for
18171 lines reused at the bottom of the window. Compute what we can
18172 scroll. */
18173 if (first_unchanged_at_end_row
18174 /* No lines reused because we displayed everything up to the
18175 bottom of the window. */
18176 && it.current_y < it.last_visible_y)
18178 dvpos = (it.vpos
18179 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
18180 current_matrix));
18181 dy = it.current_y - first_unchanged_at_end_row->y;
18182 run.current_y = first_unchanged_at_end_row->y;
18183 run.desired_y = run.current_y + dy;
18184 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
18186 else
18188 delta = delta_bytes = dvpos = dy
18189 = run.current_y = run.desired_y = run.height = 0;
18190 first_unchanged_at_end_row = NULL;
18192 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
18195 /* Find the cursor if not already found. We have to decide whether
18196 PT will appear on this window (it sometimes doesn't, but this is
18197 not a very frequent case.) This decision has to be made before
18198 the current matrix is altered. A value of cursor.vpos < 0 means
18199 that PT is either in one of the lines beginning at
18200 first_unchanged_at_end_row or below the window. Don't care for
18201 lines that might be displayed later at the window end; as
18202 mentioned, this is not a frequent case. */
18203 if (w->cursor.vpos < 0)
18205 /* Cursor in unchanged rows at the top? */
18206 if (PT < CHARPOS (start_pos)
18207 && last_unchanged_at_beg_row)
18209 row = row_containing_pos (w, PT,
18210 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
18211 last_unchanged_at_beg_row + 1, 0);
18212 if (row)
18213 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
18216 /* Start from first_unchanged_at_end_row looking for PT. */
18217 else if (first_unchanged_at_end_row)
18219 row = row_containing_pos (w, PT - delta,
18220 first_unchanged_at_end_row, NULL, 0);
18221 if (row)
18222 set_cursor_from_row (w, row, w->current_matrix, delta,
18223 delta_bytes, dy, dvpos);
18226 /* Give up if cursor was not found. */
18227 if (w->cursor.vpos < 0)
18229 clear_glyph_matrix (w->desired_matrix);
18230 return -1;
18234 /* Don't let the cursor end in the scroll margins. */
18236 int this_scroll_margin, cursor_height;
18237 int frame_line_height = default_line_pixel_height (w);
18238 int window_total_lines
18239 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18241 this_scroll_margin =
18242 max (0, min (scroll_margin, window_total_lines / 4));
18243 this_scroll_margin *= frame_line_height;
18244 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18246 if ((w->cursor.y < this_scroll_margin
18247 && CHARPOS (start) > BEGV)
18248 /* Old redisplay didn't take scroll margin into account at the bottom,
18249 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18250 || (w->cursor.y + (make_cursor_line_fully_visible_p
18251 ? cursor_height + this_scroll_margin
18252 : 1)) > it.last_visible_y)
18254 w->cursor.vpos = -1;
18255 clear_glyph_matrix (w->desired_matrix);
18256 return -1;
18260 /* Scroll the display. Do it before changing the current matrix so
18261 that xterm.c doesn't get confused about where the cursor glyph is
18262 found. */
18263 if (dy && run.height)
18265 update_begin (f);
18267 if (FRAME_WINDOW_P (f))
18269 FRAME_RIF (f)->update_window_begin_hook (w);
18270 FRAME_RIF (f)->clear_window_mouse_face (w);
18271 FRAME_RIF (f)->scroll_run_hook (w, &run);
18272 FRAME_RIF (f)->update_window_end_hook (w, false, false);
18274 else
18276 /* Terminal frame. In this case, dvpos gives the number of
18277 lines to scroll by; dvpos < 0 means scroll up. */
18278 int from_vpos
18279 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18280 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18281 int end = (WINDOW_TOP_EDGE_LINE (w)
18282 + WINDOW_WANTS_HEADER_LINE_P (w)
18283 + window_internal_height (w));
18285 #if defined (HAVE_GPM) || defined (MSDOS)
18286 x_clear_window_mouse_face (w);
18287 #endif
18288 /* Perform the operation on the screen. */
18289 if (dvpos > 0)
18291 /* Scroll last_unchanged_at_beg_row to the end of the
18292 window down dvpos lines. */
18293 set_terminal_window (f, end);
18295 /* On dumb terminals delete dvpos lines at the end
18296 before inserting dvpos empty lines. */
18297 if (!FRAME_SCROLL_REGION_OK (f))
18298 ins_del_lines (f, end - dvpos, -dvpos);
18300 /* Insert dvpos empty lines in front of
18301 last_unchanged_at_beg_row. */
18302 ins_del_lines (f, from, dvpos);
18304 else if (dvpos < 0)
18306 /* Scroll up last_unchanged_at_beg_vpos to the end of
18307 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18308 set_terminal_window (f, end);
18310 /* Delete dvpos lines in front of
18311 last_unchanged_at_beg_vpos. ins_del_lines will set
18312 the cursor to the given vpos and emit |dvpos| delete
18313 line sequences. */
18314 ins_del_lines (f, from + dvpos, dvpos);
18316 /* On a dumb terminal insert dvpos empty lines at the
18317 end. */
18318 if (!FRAME_SCROLL_REGION_OK (f))
18319 ins_del_lines (f, end + dvpos, -dvpos);
18322 set_terminal_window (f, 0);
18325 update_end (f);
18328 /* Shift reused rows of the current matrix to the right position.
18329 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18330 text. */
18331 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18332 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18333 if (dvpos < 0)
18335 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18336 bottom_vpos, dvpos);
18337 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18338 bottom_vpos);
18340 else if (dvpos > 0)
18342 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18343 bottom_vpos, dvpos);
18344 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18345 first_unchanged_at_end_vpos + dvpos);
18348 /* For frame-based redisplay, make sure that current frame and window
18349 matrix are in sync with respect to glyph memory. */
18350 if (!FRAME_WINDOW_P (f))
18351 sync_frame_with_window_matrix_rows (w);
18353 /* Adjust buffer positions in reused rows. */
18354 if (delta || delta_bytes)
18355 increment_matrix_positions (current_matrix,
18356 first_unchanged_at_end_vpos + dvpos,
18357 bottom_vpos, delta, delta_bytes);
18359 /* Adjust Y positions. */
18360 if (dy)
18361 shift_glyph_matrix (w, current_matrix,
18362 first_unchanged_at_end_vpos + dvpos,
18363 bottom_vpos, dy);
18365 if (first_unchanged_at_end_row)
18367 first_unchanged_at_end_row += dvpos;
18368 if (first_unchanged_at_end_row->y >= it.last_visible_y
18369 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18370 first_unchanged_at_end_row = NULL;
18373 /* If scrolling up, there may be some lines to display at the end of
18374 the window. */
18375 last_text_row_at_end = NULL;
18376 if (dy < 0)
18378 /* Scrolling up can leave for example a partially visible line
18379 at the end of the window to be redisplayed. */
18380 /* Set last_row to the glyph row in the current matrix where the
18381 window end line is found. It has been moved up or down in
18382 the matrix by dvpos. */
18383 int last_vpos = w->window_end_vpos + dvpos;
18384 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18386 /* If last_row is the window end line, it should display text. */
18387 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18389 /* If window end line was partially visible before, begin
18390 displaying at that line. Otherwise begin displaying with the
18391 line following it. */
18392 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18394 init_to_row_start (&it, w, last_row);
18395 it.vpos = last_vpos;
18396 it.current_y = last_row->y;
18398 else
18400 init_to_row_end (&it, w, last_row);
18401 it.vpos = 1 + last_vpos;
18402 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18403 ++last_row;
18406 /* We may start in a continuation line. If so, we have to
18407 get the right continuation_lines_width and current_x. */
18408 it.continuation_lines_width = last_row->continuation_lines_width;
18409 it.hpos = it.current_x = 0;
18411 /* Display the rest of the lines at the window end. */
18412 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18413 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18415 /* Is it always sure that the display agrees with lines in
18416 the current matrix? I don't think so, so we mark rows
18417 displayed invalid in the current matrix by setting their
18418 enabled_p flag to false. */
18419 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18420 if (display_line (&it))
18421 last_text_row_at_end = it.glyph_row - 1;
18425 /* Update window_end_pos and window_end_vpos. */
18426 if (first_unchanged_at_end_row && !last_text_row_at_end)
18428 /* Window end line if one of the preserved rows from the current
18429 matrix. Set row to the last row displaying text in current
18430 matrix starting at first_unchanged_at_end_row, after
18431 scrolling. */
18432 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18433 row = find_last_row_displaying_text (w->current_matrix, &it,
18434 first_unchanged_at_end_row);
18435 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18436 adjust_window_ends (w, row, true);
18437 eassert (w->window_end_bytepos >= 0);
18438 IF_DEBUG (debug_method_add (w, "A"));
18440 else if (last_text_row_at_end)
18442 adjust_window_ends (w, last_text_row_at_end, false);
18443 eassert (w->window_end_bytepos >= 0);
18444 IF_DEBUG (debug_method_add (w, "B"));
18446 else if (last_text_row)
18448 /* We have displayed either to the end of the window or at the
18449 end of the window, i.e. the last row with text is to be found
18450 in the desired matrix. */
18451 adjust_window_ends (w, last_text_row, false);
18452 eassert (w->window_end_bytepos >= 0);
18454 else if (first_unchanged_at_end_row == NULL
18455 && last_text_row == NULL
18456 && last_text_row_at_end == NULL)
18458 /* Displayed to end of window, but no line containing text was
18459 displayed. Lines were deleted at the end of the window. */
18460 bool first_vpos = WINDOW_WANTS_HEADER_LINE_P (w);
18461 int vpos = w->window_end_vpos;
18462 struct glyph_row *current_row = current_matrix->rows + vpos;
18463 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18465 for (row = NULL;
18466 row == NULL && vpos >= first_vpos;
18467 --vpos, --current_row, --desired_row)
18469 if (desired_row->enabled_p)
18471 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18472 row = desired_row;
18474 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18475 row = current_row;
18478 eassert (row != NULL);
18479 w->window_end_vpos = vpos + 1;
18480 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18481 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18482 eassert (w->window_end_bytepos >= 0);
18483 IF_DEBUG (debug_method_add (w, "C"));
18485 else
18486 emacs_abort ();
18488 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18489 debug_end_vpos = w->window_end_vpos));
18491 /* Record that display has not been completed. */
18492 w->window_end_valid = false;
18493 w->desired_matrix->no_scrolling_p = true;
18494 return 3;
18496 #undef GIVE_UP
18501 /***********************************************************************
18502 More debugging support
18503 ***********************************************************************/
18505 #ifdef GLYPH_DEBUG
18507 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18508 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18509 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18512 /* Dump the contents of glyph matrix MATRIX on stderr.
18514 GLYPHS 0 means don't show glyph contents.
18515 GLYPHS 1 means show glyphs in short form
18516 GLYPHS > 1 means show glyphs in long form. */
18518 void
18519 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18521 int i;
18522 for (i = 0; i < matrix->nrows; ++i)
18523 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18527 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18528 the glyph row and area where the glyph comes from. */
18530 void
18531 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18533 if (glyph->type == CHAR_GLYPH
18534 || glyph->type == GLYPHLESS_GLYPH)
18536 fprintf (stderr,
18537 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18538 glyph - row->glyphs[TEXT_AREA],
18539 (glyph->type == CHAR_GLYPH
18540 ? 'C'
18541 : 'G'),
18542 glyph->charpos,
18543 (BUFFERP (glyph->object)
18544 ? 'B'
18545 : (STRINGP (glyph->object)
18546 ? 'S'
18547 : (NILP (glyph->object)
18548 ? '0'
18549 : '-'))),
18550 glyph->pixel_width,
18551 glyph->u.ch,
18552 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18553 ? glyph->u.ch
18554 : '.'),
18555 glyph->face_id,
18556 glyph->left_box_line_p,
18557 glyph->right_box_line_p);
18559 else if (glyph->type == STRETCH_GLYPH)
18561 fprintf (stderr,
18562 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18563 glyph - row->glyphs[TEXT_AREA],
18564 'S',
18565 glyph->charpos,
18566 (BUFFERP (glyph->object)
18567 ? 'B'
18568 : (STRINGP (glyph->object)
18569 ? 'S'
18570 : (NILP (glyph->object)
18571 ? '0'
18572 : '-'))),
18573 glyph->pixel_width,
18575 ' ',
18576 glyph->face_id,
18577 glyph->left_box_line_p,
18578 glyph->right_box_line_p);
18580 else if (glyph->type == IMAGE_GLYPH)
18582 fprintf (stderr,
18583 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18584 glyph - row->glyphs[TEXT_AREA],
18585 'I',
18586 glyph->charpos,
18587 (BUFFERP (glyph->object)
18588 ? 'B'
18589 : (STRINGP (glyph->object)
18590 ? 'S'
18591 : (NILP (glyph->object)
18592 ? '0'
18593 : '-'))),
18594 glyph->pixel_width,
18595 glyph->u.img_id,
18596 '.',
18597 glyph->face_id,
18598 glyph->left_box_line_p,
18599 glyph->right_box_line_p);
18601 else if (glyph->type == COMPOSITE_GLYPH)
18603 fprintf (stderr,
18604 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18605 glyph - row->glyphs[TEXT_AREA],
18606 '+',
18607 glyph->charpos,
18608 (BUFFERP (glyph->object)
18609 ? 'B'
18610 : (STRINGP (glyph->object)
18611 ? 'S'
18612 : (NILP (glyph->object)
18613 ? '0'
18614 : '-'))),
18615 glyph->pixel_width,
18616 glyph->u.cmp.id);
18617 if (glyph->u.cmp.automatic)
18618 fprintf (stderr,
18619 "[%d-%d]",
18620 glyph->slice.cmp.from, glyph->slice.cmp.to);
18621 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18622 glyph->face_id,
18623 glyph->left_box_line_p,
18624 glyph->right_box_line_p);
18629 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18630 GLYPHS 0 means don't show glyph contents.
18631 GLYPHS 1 means show glyphs in short form
18632 GLYPHS > 1 means show glyphs in long form. */
18634 void
18635 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18637 if (glyphs != 1)
18639 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18640 fprintf (stderr, "==============================================================================\n");
18642 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18643 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18644 vpos,
18645 MATRIX_ROW_START_CHARPOS (row),
18646 MATRIX_ROW_END_CHARPOS (row),
18647 row->used[TEXT_AREA],
18648 row->contains_overlapping_glyphs_p,
18649 row->enabled_p,
18650 row->truncated_on_left_p,
18651 row->truncated_on_right_p,
18652 row->continued_p,
18653 MATRIX_ROW_CONTINUATION_LINE_P (row),
18654 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18655 row->ends_at_zv_p,
18656 row->fill_line_p,
18657 row->ends_in_middle_of_char_p,
18658 row->starts_in_middle_of_char_p,
18659 row->mouse_face_p,
18660 row->x,
18661 row->y,
18662 row->pixel_width,
18663 row->height,
18664 row->visible_height,
18665 row->ascent,
18666 row->phys_ascent);
18667 /* The next 3 lines should align to "Start" in the header. */
18668 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18669 row->end.overlay_string_index,
18670 row->continuation_lines_width);
18671 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18672 CHARPOS (row->start.string_pos),
18673 CHARPOS (row->end.string_pos));
18674 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18675 row->end.dpvec_index);
18678 if (glyphs > 1)
18680 int area;
18682 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18684 struct glyph *glyph = row->glyphs[area];
18685 struct glyph *glyph_end = glyph + row->used[area];
18687 /* Glyph for a line end in text. */
18688 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18689 ++glyph_end;
18691 if (glyph < glyph_end)
18692 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
18694 for (; glyph < glyph_end; ++glyph)
18695 dump_glyph (row, glyph, area);
18698 else if (glyphs == 1)
18700 int area;
18701 char s[SHRT_MAX + 4];
18703 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18705 int i;
18707 for (i = 0; i < row->used[area]; ++i)
18709 struct glyph *glyph = row->glyphs[area] + i;
18710 if (i == row->used[area] - 1
18711 && area == TEXT_AREA
18712 && NILP (glyph->object)
18713 && glyph->type == CHAR_GLYPH
18714 && glyph->u.ch == ' ')
18716 strcpy (&s[i], "[\\n]");
18717 i += 4;
18719 else if (glyph->type == CHAR_GLYPH
18720 && glyph->u.ch < 0x80
18721 && glyph->u.ch >= ' ')
18722 s[i] = glyph->u.ch;
18723 else
18724 s[i] = '.';
18727 s[i] = '\0';
18728 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18734 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18735 Sdump_glyph_matrix, 0, 1, "p",
18736 doc: /* Dump the current matrix of the selected window to stderr.
18737 Shows contents of glyph row structures. With non-nil
18738 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18739 glyphs in short form, otherwise show glyphs in long form.
18741 Interactively, no argument means show glyphs in short form;
18742 with numeric argument, its value is passed as the GLYPHS flag. */)
18743 (Lisp_Object glyphs)
18745 struct window *w = XWINDOW (selected_window);
18746 struct buffer *buffer = XBUFFER (w->contents);
18748 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18749 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18750 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18751 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18752 fprintf (stderr, "=============================================\n");
18753 dump_glyph_matrix (w->current_matrix,
18754 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18755 return Qnil;
18759 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18760 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* Dump the current glyph matrix of the selected frame to stderr.
18761 Only text-mode frames have frame glyph matrices. */)
18762 (void)
18764 struct frame *f = XFRAME (selected_frame);
18766 if (f->current_matrix)
18767 dump_glyph_matrix (f->current_matrix, 1);
18768 else
18769 fprintf (stderr, "*** This frame doesn't have a frame glyph matrix ***\n");
18770 return Qnil;
18774 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18775 doc: /* Dump glyph row ROW to stderr.
18776 GLYPH 0 means don't dump glyphs.
18777 GLYPH 1 means dump glyphs in short form.
18778 GLYPH > 1 or omitted means dump glyphs in long form. */)
18779 (Lisp_Object row, Lisp_Object glyphs)
18781 struct glyph_matrix *matrix;
18782 EMACS_INT vpos;
18784 CHECK_NUMBER (row);
18785 matrix = XWINDOW (selected_window)->current_matrix;
18786 vpos = XINT (row);
18787 if (vpos >= 0 && vpos < matrix->nrows)
18788 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18789 vpos,
18790 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18791 return Qnil;
18795 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18796 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18797 GLYPH 0 means don't dump glyphs.
18798 GLYPH 1 means dump glyphs in short form.
18799 GLYPH > 1 or omitted means dump glyphs in long form.
18801 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18802 do nothing. */)
18803 (Lisp_Object row, Lisp_Object glyphs)
18805 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18806 struct frame *sf = SELECTED_FRAME ();
18807 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18808 EMACS_INT vpos;
18810 CHECK_NUMBER (row);
18811 vpos = XINT (row);
18812 if (vpos >= 0 && vpos < m->nrows)
18813 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18814 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18815 #endif
18816 return Qnil;
18820 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18821 doc: /* Toggle tracing of redisplay.
18822 With ARG, turn tracing on if and only if ARG is positive. */)
18823 (Lisp_Object arg)
18825 if (NILP (arg))
18826 trace_redisplay_p = !trace_redisplay_p;
18827 else
18829 arg = Fprefix_numeric_value (arg);
18830 trace_redisplay_p = XINT (arg) > 0;
18833 return Qnil;
18837 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18838 doc: /* Like `format', but print result to stderr.
18839 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18840 (ptrdiff_t nargs, Lisp_Object *args)
18842 Lisp_Object s = Fformat (nargs, args);
18843 fwrite (SDATA (s), 1, SBYTES (s), stderr);
18844 return Qnil;
18847 #endif /* GLYPH_DEBUG */
18851 /***********************************************************************
18852 Building Desired Matrix Rows
18853 ***********************************************************************/
18855 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18856 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18858 static struct glyph_row *
18859 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18861 struct frame *f = XFRAME (WINDOW_FRAME (w));
18862 struct buffer *buffer = XBUFFER (w->contents);
18863 struct buffer *old = current_buffer;
18864 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18865 ptrdiff_t arrow_len = SCHARS (overlay_arrow_string);
18866 const unsigned char *arrow_end = arrow_string + arrow_len;
18867 const unsigned char *p;
18868 struct it it;
18869 bool multibyte_p;
18870 int n_glyphs_before;
18872 set_buffer_temp (buffer);
18873 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18874 scratch_glyph_row.reversed_p = false;
18875 it.glyph_row->used[TEXT_AREA] = 0;
18876 SET_TEXT_POS (it.position, 0, 0);
18878 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18879 p = arrow_string;
18880 while (p < arrow_end)
18882 Lisp_Object face, ilisp;
18884 /* Get the next character. */
18885 if (multibyte_p)
18886 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18887 else
18889 it.c = it.char_to_display = *p, it.len = 1;
18890 if (! ASCII_CHAR_P (it.c))
18891 it.char_to_display = BYTE8_TO_CHAR (it.c);
18893 p += it.len;
18895 /* Get its face. */
18896 ilisp = make_number (p - arrow_string);
18897 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18898 it.face_id = compute_char_face (f, it.char_to_display, face);
18900 /* Compute its width, get its glyphs. */
18901 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18902 SET_TEXT_POS (it.position, -1, -1);
18903 PRODUCE_GLYPHS (&it);
18905 /* If this character doesn't fit any more in the line, we have
18906 to remove some glyphs. */
18907 if (it.current_x > it.last_visible_x)
18909 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18910 break;
18914 set_buffer_temp (old);
18915 return it.glyph_row;
18919 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18920 glyphs to insert is determined by produce_special_glyphs. */
18922 static void
18923 insert_left_trunc_glyphs (struct it *it)
18925 struct it truncate_it;
18926 struct glyph *from, *end, *to, *toend;
18928 eassert (!FRAME_WINDOW_P (it->f)
18929 || (!it->glyph_row->reversed_p
18930 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18931 || (it->glyph_row->reversed_p
18932 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
18934 /* Get the truncation glyphs. */
18935 truncate_it = *it;
18936 truncate_it.current_x = 0;
18937 truncate_it.face_id = DEFAULT_FACE_ID;
18938 truncate_it.glyph_row = &scratch_glyph_row;
18939 truncate_it.area = TEXT_AREA;
18940 truncate_it.glyph_row->used[TEXT_AREA] = 0;
18941 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
18942 truncate_it.object = Qnil;
18943 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
18945 /* Overwrite glyphs from IT with truncation glyphs. */
18946 if (!it->glyph_row->reversed_p)
18948 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18950 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18951 end = from + tused;
18952 to = it->glyph_row->glyphs[TEXT_AREA];
18953 toend = to + it->glyph_row->used[TEXT_AREA];
18954 if (FRAME_WINDOW_P (it->f))
18956 /* On GUI frames, when variable-size fonts are displayed,
18957 the truncation glyphs may need more pixels than the row's
18958 glyphs they overwrite. We overwrite more glyphs to free
18959 enough screen real estate, and enlarge the stretch glyph
18960 on the right (see display_line), if there is one, to
18961 preserve the screen position of the truncation glyphs on
18962 the right. */
18963 int w = 0;
18964 struct glyph *g = to;
18965 short used;
18967 /* The first glyph could be partially visible, in which case
18968 it->glyph_row->x will be negative. But we want the left
18969 truncation glyphs to be aligned at the left margin of the
18970 window, so we override the x coordinate at which the row
18971 will begin. */
18972 it->glyph_row->x = 0;
18973 while (g < toend && w < it->truncation_pixel_width)
18975 w += g->pixel_width;
18976 ++g;
18978 if (g - to - tused > 0)
18980 memmove (to + tused, g, (toend - g) * sizeof(*g));
18981 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
18983 used = it->glyph_row->used[TEXT_AREA];
18984 if (it->glyph_row->truncated_on_right_p
18985 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
18986 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
18987 == STRETCH_GLYPH)
18989 int extra = w - it->truncation_pixel_width;
18991 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
18995 while (from < end)
18996 *to++ = *from++;
18998 /* There may be padding glyphs left over. Overwrite them too. */
18999 if (!FRAME_WINDOW_P (it->f))
19001 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
19003 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19004 while (from < end)
19005 *to++ = *from++;
19009 if (to > toend)
19010 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
19012 else
19014 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19016 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19017 that back to front. */
19018 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
19019 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19020 toend = it->glyph_row->glyphs[TEXT_AREA];
19021 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
19022 if (FRAME_WINDOW_P (it->f))
19024 int w = 0;
19025 struct glyph *g = to;
19027 while (g >= toend && w < it->truncation_pixel_width)
19029 w += g->pixel_width;
19030 --g;
19032 if (to - g - tused > 0)
19033 to = g + tused;
19034 if (it->glyph_row->truncated_on_right_p
19035 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
19036 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
19038 int extra = w - it->truncation_pixel_width;
19040 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
19044 while (from >= end && to >= toend)
19045 *to-- = *from--;
19046 if (!FRAME_WINDOW_P (it->f))
19048 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
19050 from =
19051 truncate_it.glyph_row->glyphs[TEXT_AREA]
19052 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19053 while (from >= end && to >= toend)
19054 *to-- = *from--;
19057 if (from >= end)
19059 /* Need to free some room before prepending additional
19060 glyphs. */
19061 int move_by = from - end + 1;
19062 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
19063 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
19065 for ( ; g >= g0; g--)
19066 g[move_by] = *g;
19067 while (from >= end)
19068 *to-- = *from--;
19069 it->glyph_row->used[TEXT_AREA] += move_by;
19074 /* Compute the hash code for ROW. */
19075 unsigned
19076 row_hash (struct glyph_row *row)
19078 int area, k;
19079 unsigned hashval = 0;
19081 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19082 for (k = 0; k < row->used[area]; ++k)
19083 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
19084 + row->glyphs[area][k].u.val
19085 + row->glyphs[area][k].face_id
19086 + row->glyphs[area][k].padding_p
19087 + (row->glyphs[area][k].type << 2));
19089 return hashval;
19092 /* Compute the pixel height and width of IT->glyph_row.
19094 Most of the time, ascent and height of a display line will be equal
19095 to the max_ascent and max_height values of the display iterator
19096 structure. This is not the case if
19098 1. We hit ZV without displaying anything. In this case, max_ascent
19099 and max_height will be zero.
19101 2. We have some glyphs that don't contribute to the line height.
19102 (The glyph row flag contributes_to_line_height_p is for future
19103 pixmap extensions).
19105 The first case is easily covered by using default values because in
19106 these cases, the line height does not really matter, except that it
19107 must not be zero. */
19109 static void
19110 compute_line_metrics (struct it *it)
19112 struct glyph_row *row = it->glyph_row;
19114 if (FRAME_WINDOW_P (it->f))
19116 int i, min_y, max_y;
19118 /* The line may consist of one space only, that was added to
19119 place the cursor on it. If so, the row's height hasn't been
19120 computed yet. */
19121 if (row->height == 0)
19123 if (it->max_ascent + it->max_descent == 0)
19124 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
19125 row->ascent = it->max_ascent;
19126 row->height = it->max_ascent + it->max_descent;
19127 row->phys_ascent = it->max_phys_ascent;
19128 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19129 row->extra_line_spacing = it->max_extra_line_spacing;
19132 /* Compute the width of this line. */
19133 row->pixel_width = row->x;
19134 for (i = 0; i < row->used[TEXT_AREA]; ++i)
19135 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
19137 eassert (row->pixel_width >= 0);
19138 eassert (row->ascent >= 0 && row->height > 0);
19140 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
19141 || MATRIX_ROW_OVERLAPS_PRED_P (row));
19143 /* If first line's physical ascent is larger than its logical
19144 ascent, use the physical ascent, and make the row taller.
19145 This makes accented characters fully visible. */
19146 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
19147 && row->phys_ascent > row->ascent)
19149 row->height += row->phys_ascent - row->ascent;
19150 row->ascent = row->phys_ascent;
19153 /* Compute how much of the line is visible. */
19154 row->visible_height = row->height;
19156 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
19157 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
19159 if (row->y < min_y)
19160 row->visible_height -= min_y - row->y;
19161 if (row->y + row->height > max_y)
19162 row->visible_height -= row->y + row->height - max_y;
19164 else
19166 row->pixel_width = row->used[TEXT_AREA];
19167 if (row->continued_p)
19168 row->pixel_width -= it->continuation_pixel_width;
19169 else if (row->truncated_on_right_p)
19170 row->pixel_width -= it->truncation_pixel_width;
19171 row->ascent = row->phys_ascent = 0;
19172 row->height = row->phys_height = row->visible_height = 1;
19173 row->extra_line_spacing = 0;
19176 /* Compute a hash code for this row. */
19177 row->hash = row_hash (row);
19179 it->max_ascent = it->max_descent = 0;
19180 it->max_phys_ascent = it->max_phys_descent = 0;
19184 /* Append one space to the glyph row of iterator IT if doing a
19185 window-based redisplay. The space has the same face as
19186 IT->face_id. Value is true if a space was added.
19188 This function is called to make sure that there is always one glyph
19189 at the end of a glyph row that the cursor can be set on under
19190 window-systems. (If there weren't such a glyph we would not know
19191 how wide and tall a box cursor should be displayed).
19193 At the same time this space let's a nicely handle clearing to the
19194 end of the line if the row ends in italic text. */
19196 static bool
19197 append_space_for_newline (struct it *it, bool default_face_p)
19199 if (FRAME_WINDOW_P (it->f))
19201 int n = it->glyph_row->used[TEXT_AREA];
19203 if (it->glyph_row->glyphs[TEXT_AREA] + n
19204 < it->glyph_row->glyphs[1 + TEXT_AREA])
19206 /* Save some values that must not be changed.
19207 Must save IT->c and IT->len because otherwise
19208 ITERATOR_AT_END_P wouldn't work anymore after
19209 append_space_for_newline has been called. */
19210 enum display_element_type saved_what = it->what;
19211 int saved_c = it->c, saved_len = it->len;
19212 int saved_char_to_display = it->char_to_display;
19213 int saved_x = it->current_x;
19214 int saved_face_id = it->face_id;
19215 bool saved_box_end = it->end_of_box_run_p;
19216 struct text_pos saved_pos;
19217 Lisp_Object saved_object;
19218 struct face *face;
19219 struct glyph *g;
19221 saved_object = it->object;
19222 saved_pos = it->position;
19224 it->what = IT_CHARACTER;
19225 memset (&it->position, 0, sizeof it->position);
19226 it->object = Qnil;
19227 it->c = it->char_to_display = ' ';
19228 it->len = 1;
19230 /* If the default face was remapped, be sure to use the
19231 remapped face for the appended newline. */
19232 if (default_face_p)
19233 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19234 else if (it->face_before_selective_p)
19235 it->face_id = it->saved_face_id;
19236 face = FACE_FROM_ID (it->f, it->face_id);
19237 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19238 /* In R2L rows, we will prepend a stretch glyph that will
19239 have the end_of_box_run_p flag set for it, so there's no
19240 need for the appended newline glyph to have that flag
19241 set. */
19242 if (it->glyph_row->reversed_p
19243 /* But if the appended newline glyph goes all the way to
19244 the end of the row, there will be no stretch glyph,
19245 so leave the box flag set. */
19246 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19247 it->end_of_box_run_p = false;
19249 PRODUCE_GLYPHS (it);
19251 #ifdef HAVE_WINDOW_SYSTEM
19252 /* Make sure this space glyph has the right ascent and
19253 descent values, or else cursor at end of line will look
19254 funny, and height of empty lines will be incorrect. */
19255 g = it->glyph_row->glyphs[TEXT_AREA] + n;
19256 struct font *font = face->font ? face->font : FRAME_FONT (it->f);
19257 if (n == 0)
19259 Lisp_Object height, total_height;
19260 int extra_line_spacing = it->extra_line_spacing;
19261 int boff = font->baseline_offset;
19263 if (font->vertical_centering)
19264 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
19266 it->object = saved_object; /* get_it_property needs this */
19267 normal_char_ascent_descent (font, -1, &it->ascent, &it->descent);
19268 /* Must do a subset of line height processing from
19269 x_produce_glyph for newline characters. */
19270 height = get_it_property (it, Qline_height);
19271 if (CONSP (height)
19272 && CONSP (XCDR (height))
19273 && NILP (XCDR (XCDR (height))))
19275 total_height = XCAR (XCDR (height));
19276 height = XCAR (height);
19278 else
19279 total_height = Qnil;
19280 height = calc_line_height_property (it, height, font, boff, true);
19282 if (it->override_ascent >= 0)
19284 it->ascent = it->override_ascent;
19285 it->descent = it->override_descent;
19286 boff = it->override_boff;
19288 if (EQ (height, Qt))
19289 extra_line_spacing = 0;
19290 else
19292 Lisp_Object spacing;
19294 it->phys_ascent = it->ascent;
19295 it->phys_descent = it->descent;
19296 if (!NILP (height)
19297 && XINT (height) > it->ascent + it->descent)
19298 it->ascent = XINT (height) - it->descent;
19300 if (!NILP (total_height))
19301 spacing = calc_line_height_property (it, total_height, font,
19302 boff, false);
19303 else
19305 spacing = get_it_property (it, Qline_spacing);
19306 spacing = calc_line_height_property (it, spacing, font,
19307 boff, false);
19309 if (INTEGERP (spacing))
19311 extra_line_spacing = XINT (spacing);
19312 if (!NILP (total_height))
19313 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
19316 if (extra_line_spacing > 0)
19318 it->descent += extra_line_spacing;
19319 if (extra_line_spacing > it->max_extra_line_spacing)
19320 it->max_extra_line_spacing = extra_line_spacing;
19322 it->max_ascent = it->ascent;
19323 it->max_descent = it->descent;
19324 /* Make sure compute_line_metrics recomputes the row height. */
19325 it->glyph_row->height = 0;
19328 g->ascent = it->max_ascent;
19329 g->descent = it->max_descent;
19330 #endif
19332 it->override_ascent = -1;
19333 it->constrain_row_ascent_descent_p = false;
19334 it->current_x = saved_x;
19335 it->object = saved_object;
19336 it->position = saved_pos;
19337 it->what = saved_what;
19338 it->face_id = saved_face_id;
19339 it->len = saved_len;
19340 it->c = saved_c;
19341 it->char_to_display = saved_char_to_display;
19342 it->end_of_box_run_p = saved_box_end;
19343 return true;
19347 return false;
19351 /* Extend the face of the last glyph in the text area of IT->glyph_row
19352 to the end of the display line. Called from display_line. If the
19353 glyph row is empty, add a space glyph to it so that we know the
19354 face to draw. Set the glyph row flag fill_line_p. If the glyph
19355 row is R2L, prepend a stretch glyph to cover the empty space to the
19356 left of the leftmost glyph. */
19358 static void
19359 extend_face_to_end_of_line (struct it *it)
19361 struct face *face, *default_face;
19362 struct frame *f = it->f;
19364 /* If line is already filled, do nothing. Non window-system frames
19365 get a grace of one more ``pixel'' because their characters are
19366 1-``pixel'' wide, so they hit the equality too early. This grace
19367 is needed only for R2L rows that are not continued, to produce
19368 one extra blank where we could display the cursor. */
19369 if ((it->current_x >= it->last_visible_x
19370 + (!FRAME_WINDOW_P (f)
19371 && it->glyph_row->reversed_p
19372 && !it->glyph_row->continued_p))
19373 /* If the window has display margins, we will need to extend
19374 their face even if the text area is filled. */
19375 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19376 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19377 return;
19379 /* The default face, possibly remapped. */
19380 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
19382 /* Face extension extends the background and box of IT->face_id
19383 to the end of the line. If the background equals the background
19384 of the frame, we don't have to do anything. */
19385 if (it->face_before_selective_p)
19386 face = FACE_FROM_ID (f, it->saved_face_id);
19387 else
19388 face = FACE_FROM_ID (f, it->face_id);
19390 if (FRAME_WINDOW_P (f)
19391 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19392 && face->box == FACE_NO_BOX
19393 && face->background == FRAME_BACKGROUND_PIXEL (f)
19394 #ifdef HAVE_WINDOW_SYSTEM
19395 && !face->stipple
19396 #endif
19397 && !it->glyph_row->reversed_p)
19398 return;
19400 /* Set the glyph row flag indicating that the face of the last glyph
19401 in the text area has to be drawn to the end of the text area. */
19402 it->glyph_row->fill_line_p = true;
19404 /* If current character of IT is not ASCII, make sure we have the
19405 ASCII face. This will be automatically undone the next time
19406 get_next_display_element returns a multibyte character. Note
19407 that the character will always be single byte in unibyte
19408 text. */
19409 if (!ASCII_CHAR_P (it->c))
19411 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19414 if (FRAME_WINDOW_P (f))
19416 /* If the row is empty, add a space with the current face of IT,
19417 so that we know which face to draw. */
19418 if (it->glyph_row->used[TEXT_AREA] == 0)
19420 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19421 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19422 it->glyph_row->used[TEXT_AREA] = 1;
19424 /* Mode line and the header line don't have margins, and
19425 likewise the frame's tool-bar window, if there is any. */
19426 if (!(it->glyph_row->mode_line_p
19427 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19428 || (WINDOWP (f->tool_bar_window)
19429 && it->w == XWINDOW (f->tool_bar_window))
19430 #endif
19433 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19434 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19436 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19437 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19438 default_face->id;
19439 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19441 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19442 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19444 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19445 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19446 default_face->id;
19447 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19450 #ifdef HAVE_WINDOW_SYSTEM
19451 if (it->glyph_row->reversed_p)
19453 /* Prepend a stretch glyph to the row, such that the
19454 rightmost glyph will be drawn flushed all the way to the
19455 right margin of the window. The stretch glyph that will
19456 occupy the empty space, if any, to the left of the
19457 glyphs. */
19458 struct font *font = face->font ? face->font : FRAME_FONT (f);
19459 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19460 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19461 struct glyph *g;
19462 int row_width, stretch_ascent, stretch_width;
19463 struct text_pos saved_pos;
19464 int saved_face_id;
19465 bool saved_avoid_cursor, saved_box_start;
19467 for (row_width = 0, g = row_start; g < row_end; g++)
19468 row_width += g->pixel_width;
19470 /* FIXME: There are various minor display glitches in R2L
19471 rows when only one of the fringes is missing. The
19472 strange condition below produces the least bad effect. */
19473 if ((WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19474 == (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
19475 || WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
19476 stretch_width = window_box_width (it->w, TEXT_AREA);
19477 else
19478 stretch_width = it->last_visible_x - it->first_visible_x;
19479 stretch_width -= row_width;
19481 if (stretch_width > 0)
19483 stretch_ascent =
19484 (((it->ascent + it->descent)
19485 * FONT_BASE (font)) / FONT_HEIGHT (font));
19486 saved_pos = it->position;
19487 memset (&it->position, 0, sizeof it->position);
19488 saved_avoid_cursor = it->avoid_cursor_p;
19489 it->avoid_cursor_p = true;
19490 saved_face_id = it->face_id;
19491 saved_box_start = it->start_of_box_run_p;
19492 /* The last row's stretch glyph should get the default
19493 face, to avoid painting the rest of the window with
19494 the region face, if the region ends at ZV. */
19495 if (it->glyph_row->ends_at_zv_p)
19496 it->face_id = default_face->id;
19497 else
19498 it->face_id = face->id;
19499 it->start_of_box_run_p = false;
19500 append_stretch_glyph (it, Qnil, stretch_width,
19501 it->ascent + it->descent, stretch_ascent);
19502 it->position = saved_pos;
19503 it->avoid_cursor_p = saved_avoid_cursor;
19504 it->face_id = saved_face_id;
19505 it->start_of_box_run_p = saved_box_start;
19507 /* If stretch_width comes out negative, it means that the
19508 last glyph is only partially visible. In R2L rows, we
19509 want the leftmost glyph to be partially visible, so we
19510 need to give the row the corresponding left offset. */
19511 if (stretch_width < 0)
19512 it->glyph_row->x = stretch_width;
19514 #endif /* HAVE_WINDOW_SYSTEM */
19516 else
19518 /* Save some values that must not be changed. */
19519 int saved_x = it->current_x;
19520 struct text_pos saved_pos;
19521 Lisp_Object saved_object;
19522 enum display_element_type saved_what = it->what;
19523 int saved_face_id = it->face_id;
19525 saved_object = it->object;
19526 saved_pos = it->position;
19528 it->what = IT_CHARACTER;
19529 memset (&it->position, 0, sizeof it->position);
19530 it->object = Qnil;
19531 it->c = it->char_to_display = ' ';
19532 it->len = 1;
19534 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19535 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19536 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19537 && !it->glyph_row->mode_line_p
19538 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19540 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19541 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19543 for (it->current_x = 0; g < e; g++)
19544 it->current_x += g->pixel_width;
19546 it->area = LEFT_MARGIN_AREA;
19547 it->face_id = default_face->id;
19548 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19549 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19551 PRODUCE_GLYPHS (it);
19552 /* term.c:produce_glyphs advances it->current_x only for
19553 TEXT_AREA. */
19554 it->current_x += it->pixel_width;
19557 it->current_x = saved_x;
19558 it->area = TEXT_AREA;
19561 /* The last row's blank glyphs should get the default face, to
19562 avoid painting the rest of the window with the region face,
19563 if the region ends at ZV. */
19564 if (it->glyph_row->ends_at_zv_p)
19565 it->face_id = default_face->id;
19566 else
19567 it->face_id = face->id;
19568 PRODUCE_GLYPHS (it);
19570 while (it->current_x <= it->last_visible_x)
19571 PRODUCE_GLYPHS (it);
19573 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19574 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19575 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19576 && !it->glyph_row->mode_line_p
19577 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19579 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19580 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19582 for ( ; g < e; g++)
19583 it->current_x += g->pixel_width;
19585 it->area = RIGHT_MARGIN_AREA;
19586 it->face_id = default_face->id;
19587 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19588 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19590 PRODUCE_GLYPHS (it);
19591 it->current_x += it->pixel_width;
19594 it->area = TEXT_AREA;
19597 /* Don't count these blanks really. It would let us insert a left
19598 truncation glyph below and make us set the cursor on them, maybe. */
19599 it->current_x = saved_x;
19600 it->object = saved_object;
19601 it->position = saved_pos;
19602 it->what = saved_what;
19603 it->face_id = saved_face_id;
19608 /* Value is true if text starting at CHARPOS in current_buffer is
19609 trailing whitespace. */
19611 static bool
19612 trailing_whitespace_p (ptrdiff_t charpos)
19614 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19615 int c = 0;
19617 while (bytepos < ZV_BYTE
19618 && (c = FETCH_CHAR (bytepos),
19619 c == ' ' || c == '\t'))
19620 ++bytepos;
19622 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19624 if (bytepos != PT_BYTE)
19625 return true;
19627 return false;
19631 /* Highlight trailing whitespace, if any, in ROW. */
19633 static void
19634 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19636 int used = row->used[TEXT_AREA];
19638 if (used)
19640 struct glyph *start = row->glyphs[TEXT_AREA];
19641 struct glyph *glyph = start + used - 1;
19643 if (row->reversed_p)
19645 /* Right-to-left rows need to be processed in the opposite
19646 direction, so swap the edge pointers. */
19647 glyph = start;
19648 start = row->glyphs[TEXT_AREA] + used - 1;
19651 /* Skip over glyphs inserted to display the cursor at the
19652 end of a line, for extending the face of the last glyph
19653 to the end of the line on terminals, and for truncation
19654 and continuation glyphs. */
19655 if (!row->reversed_p)
19657 while (glyph >= start
19658 && glyph->type == CHAR_GLYPH
19659 && NILP (glyph->object))
19660 --glyph;
19662 else
19664 while (glyph <= start
19665 && glyph->type == CHAR_GLYPH
19666 && NILP (glyph->object))
19667 ++glyph;
19670 /* If last glyph is a space or stretch, and it's trailing
19671 whitespace, set the face of all trailing whitespace glyphs in
19672 IT->glyph_row to `trailing-whitespace'. */
19673 if ((row->reversed_p ? glyph <= start : glyph >= start)
19674 && BUFFERP (glyph->object)
19675 && (glyph->type == STRETCH_GLYPH
19676 || (glyph->type == CHAR_GLYPH
19677 && glyph->u.ch == ' '))
19678 && trailing_whitespace_p (glyph->charpos))
19680 int face_id = lookup_named_face (f, Qtrailing_whitespace, false);
19681 if (face_id < 0)
19682 return;
19684 if (!row->reversed_p)
19686 while (glyph >= start
19687 && BUFFERP (glyph->object)
19688 && (glyph->type == STRETCH_GLYPH
19689 || (glyph->type == CHAR_GLYPH
19690 && glyph->u.ch == ' ')))
19691 (glyph--)->face_id = face_id;
19693 else
19695 while (glyph <= start
19696 && BUFFERP (glyph->object)
19697 && (glyph->type == STRETCH_GLYPH
19698 || (glyph->type == CHAR_GLYPH
19699 && glyph->u.ch == ' ')))
19700 (glyph++)->face_id = face_id;
19707 /* Value is true if glyph row ROW should be
19708 considered to hold the buffer position CHARPOS. */
19710 static bool
19711 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
19713 bool result = true;
19715 if (charpos == CHARPOS (row->end.pos)
19716 || charpos == MATRIX_ROW_END_CHARPOS (row))
19718 /* Suppose the row ends on a string.
19719 Unless the row is continued, that means it ends on a newline
19720 in the string. If it's anything other than a display string
19721 (e.g., a before-string from an overlay), we don't want the
19722 cursor there. (This heuristic seems to give the optimal
19723 behavior for the various types of multi-line strings.)
19724 One exception: if the string has `cursor' property on one of
19725 its characters, we _do_ want the cursor there. */
19726 if (CHARPOS (row->end.string_pos) >= 0)
19728 if (row->continued_p)
19729 result = true;
19730 else
19732 /* Check for `display' property. */
19733 struct glyph *beg = row->glyphs[TEXT_AREA];
19734 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
19735 struct glyph *glyph;
19737 result = false;
19738 for (glyph = end; glyph >= beg; --glyph)
19739 if (STRINGP (glyph->object))
19741 Lisp_Object prop
19742 = Fget_char_property (make_number (charpos),
19743 Qdisplay, Qnil);
19744 result =
19745 (!NILP (prop)
19746 && display_prop_string_p (prop, glyph->object));
19747 /* If there's a `cursor' property on one of the
19748 string's characters, this row is a cursor row,
19749 even though this is not a display string. */
19750 if (!result)
19752 Lisp_Object s = glyph->object;
19754 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
19756 ptrdiff_t gpos = glyph->charpos;
19758 if (!NILP (Fget_char_property (make_number (gpos),
19759 Qcursor, s)))
19761 result = true;
19762 break;
19766 break;
19770 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
19772 /* If the row ends in middle of a real character,
19773 and the line is continued, we want the cursor here.
19774 That's because CHARPOS (ROW->end.pos) would equal
19775 PT if PT is before the character. */
19776 if (!row->ends_in_ellipsis_p)
19777 result = row->continued_p;
19778 else
19779 /* If the row ends in an ellipsis, then
19780 CHARPOS (ROW->end.pos) will equal point after the
19781 invisible text. We want that position to be displayed
19782 after the ellipsis. */
19783 result = false;
19785 /* If the row ends at ZV, display the cursor at the end of that
19786 row instead of at the start of the row below. */
19787 else
19788 result = row->ends_at_zv_p;
19791 return result;
19794 /* Value is true if glyph row ROW should be
19795 used to hold the cursor. */
19797 static bool
19798 cursor_row_p (struct glyph_row *row)
19800 return row_for_charpos_p (row, PT);
19805 /* Push the property PROP so that it will be rendered at the current
19806 position in IT. Return true if PROP was successfully pushed, false
19807 otherwise. Called from handle_line_prefix to handle the
19808 `line-prefix' and `wrap-prefix' properties. */
19810 static bool
19811 push_prefix_prop (struct it *it, Lisp_Object prop)
19813 struct text_pos pos =
19814 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
19816 eassert (it->method == GET_FROM_BUFFER
19817 || it->method == GET_FROM_DISPLAY_VECTOR
19818 || it->method == GET_FROM_STRING);
19820 /* We need to save the current buffer/string position, so it will be
19821 restored by pop_it, because iterate_out_of_display_property
19822 depends on that being set correctly, but some situations leave
19823 it->position not yet set when this function is called. */
19824 push_it (it, &pos);
19826 if (STRINGP (prop))
19828 if (SCHARS (prop) == 0)
19830 pop_it (it);
19831 return false;
19834 it->string = prop;
19835 it->string_from_prefix_prop_p = true;
19836 it->multibyte_p = STRING_MULTIBYTE (it->string);
19837 it->current.overlay_string_index = -1;
19838 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
19839 it->end_charpos = it->string_nchars = SCHARS (it->string);
19840 it->method = GET_FROM_STRING;
19841 it->stop_charpos = 0;
19842 it->prev_stop = 0;
19843 it->base_level_stop = 0;
19845 /* Force paragraph direction to be that of the parent
19846 buffer/string. */
19847 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
19848 it->paragraph_embedding = it->bidi_it.paragraph_dir;
19849 else
19850 it->paragraph_embedding = L2R;
19852 /* Set up the bidi iterator for this display string. */
19853 if (it->bidi_p)
19855 it->bidi_it.string.lstring = it->string;
19856 it->bidi_it.string.s = NULL;
19857 it->bidi_it.string.schars = it->end_charpos;
19858 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19859 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19860 it->bidi_it.string.unibyte = !it->multibyte_p;
19861 it->bidi_it.w = it->w;
19862 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19865 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19867 it->method = GET_FROM_STRETCH;
19868 it->object = prop;
19870 #ifdef HAVE_WINDOW_SYSTEM
19871 else if (IMAGEP (prop))
19873 it->what = IT_IMAGE;
19874 it->image_id = lookup_image (it->f, prop);
19875 it->method = GET_FROM_IMAGE;
19877 #endif /* HAVE_WINDOW_SYSTEM */
19878 else
19880 pop_it (it); /* bogus display property, give up */
19881 return false;
19884 return true;
19887 /* Return the character-property PROP at the current position in IT. */
19889 static Lisp_Object
19890 get_it_property (struct it *it, Lisp_Object prop)
19892 Lisp_Object position, object = it->object;
19894 if (STRINGP (object))
19895 position = make_number (IT_STRING_CHARPOS (*it));
19896 else if (BUFFERP (object))
19898 position = make_number (IT_CHARPOS (*it));
19899 object = it->window;
19901 else
19902 return Qnil;
19904 return Fget_char_property (position, prop, object);
19907 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19909 static void
19910 handle_line_prefix (struct it *it)
19912 Lisp_Object prefix;
19914 if (it->continuation_lines_width > 0)
19916 prefix = get_it_property (it, Qwrap_prefix);
19917 if (NILP (prefix))
19918 prefix = Vwrap_prefix;
19920 else
19922 prefix = get_it_property (it, Qline_prefix);
19923 if (NILP (prefix))
19924 prefix = Vline_prefix;
19926 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19928 /* If the prefix is wider than the window, and we try to wrap
19929 it, it would acquire its own wrap prefix, and so on till the
19930 iterator stack overflows. So, don't wrap the prefix. */
19931 it->line_wrap = TRUNCATE;
19932 it->avoid_cursor_p = true;
19938 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19939 only for R2L lines from display_line and display_string, when they
19940 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19941 the line/string needs to be continued on the next glyph row. */
19942 static void
19943 unproduce_glyphs (struct it *it, int n)
19945 struct glyph *glyph, *end;
19947 eassert (it->glyph_row);
19948 eassert (it->glyph_row->reversed_p);
19949 eassert (it->area == TEXT_AREA);
19950 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19952 if (n > it->glyph_row->used[TEXT_AREA])
19953 n = it->glyph_row->used[TEXT_AREA];
19954 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19955 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19956 for ( ; glyph < end; glyph++)
19957 glyph[-n] = *glyph;
19960 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19961 and ROW->maxpos. */
19962 static void
19963 find_row_edges (struct it *it, struct glyph_row *row,
19964 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19965 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19967 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19968 lines' rows is implemented for bidi-reordered rows. */
19970 /* ROW->minpos is the value of min_pos, the minimal buffer position
19971 we have in ROW, or ROW->start.pos if that is smaller. */
19972 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19973 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19974 else
19975 /* We didn't find buffer positions smaller than ROW->start, or
19976 didn't find _any_ valid buffer positions in any of the glyphs,
19977 so we must trust the iterator's computed positions. */
19978 row->minpos = row->start.pos;
19979 if (max_pos <= 0)
19981 max_pos = CHARPOS (it->current.pos);
19982 max_bpos = BYTEPOS (it->current.pos);
19985 /* Here are the various use-cases for ending the row, and the
19986 corresponding values for ROW->maxpos:
19988 Line ends in a newline from buffer eol_pos + 1
19989 Line is continued from buffer max_pos + 1
19990 Line is truncated on right it->current.pos
19991 Line ends in a newline from string max_pos + 1(*)
19992 (*) + 1 only when line ends in a forward scan
19993 Line is continued from string max_pos
19994 Line is continued from display vector max_pos
19995 Line is entirely from a string min_pos == max_pos
19996 Line is entirely from a display vector min_pos == max_pos
19997 Line that ends at ZV ZV
19999 If you discover other use-cases, please add them here as
20000 appropriate. */
20001 if (row->ends_at_zv_p)
20002 row->maxpos = it->current.pos;
20003 else if (row->used[TEXT_AREA])
20005 bool seen_this_string = false;
20006 struct glyph_row *r1 = row - 1;
20008 /* Did we see the same display string on the previous row? */
20009 if (STRINGP (it->object)
20010 /* this is not the first row */
20011 && row > it->w->desired_matrix->rows
20012 /* previous row is not the header line */
20013 && !r1->mode_line_p
20014 /* previous row also ends in a newline from a string */
20015 && r1->ends_in_newline_from_string_p)
20017 struct glyph *start, *end;
20019 /* Search for the last glyph of the previous row that came
20020 from buffer or string. Depending on whether the row is
20021 L2R or R2L, we need to process it front to back or the
20022 other way round. */
20023 if (!r1->reversed_p)
20025 start = r1->glyphs[TEXT_AREA];
20026 end = start + r1->used[TEXT_AREA];
20027 /* Glyphs inserted by redisplay have nil as their object. */
20028 while (end > start
20029 && NILP ((end - 1)->object)
20030 && (end - 1)->charpos <= 0)
20031 --end;
20032 if (end > start)
20034 if (EQ ((end - 1)->object, it->object))
20035 seen_this_string = true;
20037 else
20038 /* If all the glyphs of the previous row were inserted
20039 by redisplay, it means the previous row was
20040 produced from a single newline, which is only
20041 possible if that newline came from the same string
20042 as the one which produced this ROW. */
20043 seen_this_string = true;
20045 else
20047 end = r1->glyphs[TEXT_AREA] - 1;
20048 start = end + r1->used[TEXT_AREA];
20049 while (end < start
20050 && NILP ((end + 1)->object)
20051 && (end + 1)->charpos <= 0)
20052 ++end;
20053 if (end < start)
20055 if (EQ ((end + 1)->object, it->object))
20056 seen_this_string = true;
20058 else
20059 seen_this_string = true;
20062 /* Take note of each display string that covers a newline only
20063 once, the first time we see it. This is for when a display
20064 string includes more than one newline in it. */
20065 if (row->ends_in_newline_from_string_p && !seen_this_string)
20067 /* If we were scanning the buffer forward when we displayed
20068 the string, we want to account for at least one buffer
20069 position that belongs to this row (position covered by
20070 the display string), so that cursor positioning will
20071 consider this row as a candidate when point is at the end
20072 of the visual line represented by this row. This is not
20073 required when scanning back, because max_pos will already
20074 have a much larger value. */
20075 if (CHARPOS (row->end.pos) > max_pos)
20076 INC_BOTH (max_pos, max_bpos);
20077 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20079 else if (CHARPOS (it->eol_pos) > 0)
20080 SET_TEXT_POS (row->maxpos,
20081 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
20082 else if (row->continued_p)
20084 /* If max_pos is different from IT's current position, it
20085 means IT->method does not belong to the display element
20086 at max_pos. However, it also means that the display
20087 element at max_pos was displayed in its entirety on this
20088 line, which is equivalent to saying that the next line
20089 starts at the next buffer position. */
20090 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
20091 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20092 else
20094 INC_BOTH (max_pos, max_bpos);
20095 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20098 else if (row->truncated_on_right_p)
20099 /* display_line already called reseat_at_next_visible_line_start,
20100 which puts the iterator at the beginning of the next line, in
20101 the logical order. */
20102 row->maxpos = it->current.pos;
20103 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
20104 /* A line that is entirely from a string/image/stretch... */
20105 row->maxpos = row->minpos;
20106 else
20107 emacs_abort ();
20109 else
20110 row->maxpos = it->current.pos;
20113 /* Construct the glyph row IT->glyph_row in the desired matrix of
20114 IT->w from text at the current position of IT. See dispextern.h
20115 for an overview of struct it. Value is true if
20116 IT->glyph_row displays text, as opposed to a line displaying ZV
20117 only. */
20119 static bool
20120 display_line (struct it *it)
20122 struct glyph_row *row = it->glyph_row;
20123 Lisp_Object overlay_arrow_string;
20124 struct it wrap_it;
20125 void *wrap_data = NULL;
20126 bool may_wrap = false;
20127 int wrap_x IF_LINT (= 0);
20128 int wrap_row_used = -1;
20129 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
20130 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
20131 int wrap_row_extra_line_spacing IF_LINT (= 0);
20132 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
20133 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
20134 int cvpos;
20135 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
20136 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
20137 bool pending_handle_line_prefix = false;
20139 /* We always start displaying at hpos zero even if hscrolled. */
20140 eassert (it->hpos == 0 && it->current_x == 0);
20142 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
20143 >= it->w->desired_matrix->nrows)
20145 it->w->nrows_scale_factor++;
20146 it->f->fonts_changed = true;
20147 return false;
20150 /* Clear the result glyph row and enable it. */
20151 prepare_desired_row (it->w, row, false);
20153 row->y = it->current_y;
20154 row->start = it->start;
20155 row->continuation_lines_width = it->continuation_lines_width;
20156 row->displays_text_p = true;
20157 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
20158 it->starts_in_middle_of_char_p = false;
20160 /* Arrange the overlays nicely for our purposes. Usually, we call
20161 display_line on only one line at a time, in which case this
20162 can't really hurt too much, or we call it on lines which appear
20163 one after another in the buffer, in which case all calls to
20164 recenter_overlay_lists but the first will be pretty cheap. */
20165 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
20167 /* Move over display elements that are not visible because we are
20168 hscrolled. This may stop at an x-position < IT->first_visible_x
20169 if the first glyph is partially visible or if we hit a line end. */
20170 if (it->current_x < it->first_visible_x)
20172 enum move_it_result move_result;
20174 this_line_min_pos = row->start.pos;
20175 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
20176 MOVE_TO_POS | MOVE_TO_X);
20177 /* If we are under a large hscroll, move_it_in_display_line_to
20178 could hit the end of the line without reaching
20179 it->first_visible_x. Pretend that we did reach it. This is
20180 especially important on a TTY, where we will call
20181 extend_face_to_end_of_line, which needs to know how many
20182 blank glyphs to produce. */
20183 if (it->current_x < it->first_visible_x
20184 && (move_result == MOVE_NEWLINE_OR_CR
20185 || move_result == MOVE_POS_MATCH_OR_ZV))
20186 it->current_x = it->first_visible_x;
20188 /* Record the smallest positions seen while we moved over
20189 display elements that are not visible. This is needed by
20190 redisplay_internal for optimizing the case where the cursor
20191 stays inside the same line. The rest of this function only
20192 considers positions that are actually displayed, so
20193 RECORD_MAX_MIN_POS will not otherwise record positions that
20194 are hscrolled to the left of the left edge of the window. */
20195 min_pos = CHARPOS (this_line_min_pos);
20196 min_bpos = BYTEPOS (this_line_min_pos);
20198 else if (it->area == TEXT_AREA)
20200 /* We only do this when not calling move_it_in_display_line_to
20201 above, because that function calls itself handle_line_prefix. */
20202 handle_line_prefix (it);
20204 else
20206 /* Line-prefix and wrap-prefix are always displayed in the text
20207 area. But if this is the first call to display_line after
20208 init_iterator, the iterator might have been set up to write
20209 into a marginal area, e.g. if the line begins with some
20210 display property that writes to the margins. So we need to
20211 wait with the call to handle_line_prefix until whatever
20212 writes to the margin has done its job. */
20213 pending_handle_line_prefix = true;
20216 /* Get the initial row height. This is either the height of the
20217 text hscrolled, if there is any, or zero. */
20218 row->ascent = it->max_ascent;
20219 row->height = it->max_ascent + it->max_descent;
20220 row->phys_ascent = it->max_phys_ascent;
20221 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
20222 row->extra_line_spacing = it->max_extra_line_spacing;
20224 /* Utility macro to record max and min buffer positions seen until now. */
20225 #define RECORD_MAX_MIN_POS(IT) \
20226 do \
20228 bool composition_p \
20229 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20230 ptrdiff_t current_pos = \
20231 composition_p ? (IT)->cmp_it.charpos \
20232 : IT_CHARPOS (*(IT)); \
20233 ptrdiff_t current_bpos = \
20234 composition_p ? CHAR_TO_BYTE (current_pos) \
20235 : IT_BYTEPOS (*(IT)); \
20236 if (current_pos < min_pos) \
20238 min_pos = current_pos; \
20239 min_bpos = current_bpos; \
20241 if (IT_CHARPOS (*it) > max_pos) \
20243 max_pos = IT_CHARPOS (*it); \
20244 max_bpos = IT_BYTEPOS (*it); \
20247 while (false)
20249 /* Loop generating characters. The loop is left with IT on the next
20250 character to display. */
20251 while (true)
20253 int n_glyphs_before, hpos_before, x_before;
20254 int x, nglyphs;
20255 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
20257 /* Retrieve the next thing to display. Value is false if end of
20258 buffer reached. */
20259 if (!get_next_display_element (it))
20261 /* Maybe add a space at the end of this line that is used to
20262 display the cursor there under X. Set the charpos of the
20263 first glyph of blank lines not corresponding to any text
20264 to -1. */
20265 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20266 row->exact_window_width_line_p = true;
20267 else if ((append_space_for_newline (it, true)
20268 && row->used[TEXT_AREA] == 1)
20269 || row->used[TEXT_AREA] == 0)
20271 row->glyphs[TEXT_AREA]->charpos = -1;
20272 row->displays_text_p = false;
20274 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
20275 && (!MINI_WINDOW_P (it->w)
20276 || (minibuf_level && EQ (it->window, minibuf_window))))
20277 row->indicate_empty_line_p = true;
20280 it->continuation_lines_width = 0;
20281 row->ends_at_zv_p = true;
20282 /* A row that displays right-to-left text must always have
20283 its last face extended all the way to the end of line,
20284 even if this row ends in ZV, because we still write to
20285 the screen left to right. We also need to extend the
20286 last face if the default face is remapped to some
20287 different face, otherwise the functions that clear
20288 portions of the screen will clear with the default face's
20289 background color. */
20290 if (row->reversed_p
20291 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
20292 extend_face_to_end_of_line (it);
20293 break;
20296 /* Now, get the metrics of what we want to display. This also
20297 generates glyphs in `row' (which is IT->glyph_row). */
20298 n_glyphs_before = row->used[TEXT_AREA];
20299 x = it->current_x;
20301 /* Remember the line height so far in case the next element doesn't
20302 fit on the line. */
20303 if (it->line_wrap != TRUNCATE)
20305 ascent = it->max_ascent;
20306 descent = it->max_descent;
20307 phys_ascent = it->max_phys_ascent;
20308 phys_descent = it->max_phys_descent;
20310 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
20312 if (IT_DISPLAYING_WHITESPACE (it))
20313 may_wrap = true;
20314 else if (may_wrap)
20316 SAVE_IT (wrap_it, *it, wrap_data);
20317 wrap_x = x;
20318 wrap_row_used = row->used[TEXT_AREA];
20319 wrap_row_ascent = row->ascent;
20320 wrap_row_height = row->height;
20321 wrap_row_phys_ascent = row->phys_ascent;
20322 wrap_row_phys_height = row->phys_height;
20323 wrap_row_extra_line_spacing = row->extra_line_spacing;
20324 wrap_row_min_pos = min_pos;
20325 wrap_row_min_bpos = min_bpos;
20326 wrap_row_max_pos = max_pos;
20327 wrap_row_max_bpos = max_bpos;
20328 may_wrap = false;
20333 PRODUCE_GLYPHS (it);
20335 /* If this display element was in marginal areas, continue with
20336 the next one. */
20337 if (it->area != TEXT_AREA)
20339 row->ascent = max (row->ascent, it->max_ascent);
20340 row->height = max (row->height, it->max_ascent + it->max_descent);
20341 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20342 row->phys_height = max (row->phys_height,
20343 it->max_phys_ascent + it->max_phys_descent);
20344 row->extra_line_spacing = max (row->extra_line_spacing,
20345 it->max_extra_line_spacing);
20346 set_iterator_to_next (it, true);
20347 /* If we didn't handle the line/wrap prefix above, and the
20348 call to set_iterator_to_next just switched to TEXT_AREA,
20349 process the prefix now. */
20350 if (it->area == TEXT_AREA && pending_handle_line_prefix)
20352 pending_handle_line_prefix = false;
20353 handle_line_prefix (it);
20355 continue;
20358 /* Does the display element fit on the line? If we truncate
20359 lines, we should draw past the right edge of the window. If
20360 we don't truncate, we want to stop so that we can display the
20361 continuation glyph before the right margin. If lines are
20362 continued, there are two possible strategies for characters
20363 resulting in more than 1 glyph (e.g. tabs): Display as many
20364 glyphs as possible in this line and leave the rest for the
20365 continuation line, or display the whole element in the next
20366 line. Original redisplay did the former, so we do it also. */
20367 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20368 hpos_before = it->hpos;
20369 x_before = x;
20371 if (/* Not a newline. */
20372 nglyphs > 0
20373 /* Glyphs produced fit entirely in the line. */
20374 && it->current_x < it->last_visible_x)
20376 it->hpos += nglyphs;
20377 row->ascent = max (row->ascent, it->max_ascent);
20378 row->height = max (row->height, it->max_ascent + it->max_descent);
20379 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20380 row->phys_height = max (row->phys_height,
20381 it->max_phys_ascent + it->max_phys_descent);
20382 row->extra_line_spacing = max (row->extra_line_spacing,
20383 it->max_extra_line_spacing);
20384 if (it->current_x - it->pixel_width < it->first_visible_x
20385 /* In R2L rows, we arrange in extend_face_to_end_of_line
20386 to add a right offset to the line, by a suitable
20387 change to the stretch glyph that is the leftmost
20388 glyph of the line. */
20389 && !row->reversed_p)
20390 row->x = x - it->first_visible_x;
20391 /* Record the maximum and minimum buffer positions seen so
20392 far in glyphs that will be displayed by this row. */
20393 if (it->bidi_p)
20394 RECORD_MAX_MIN_POS (it);
20396 else
20398 int i, new_x;
20399 struct glyph *glyph;
20401 for (i = 0; i < nglyphs; ++i, x = new_x)
20403 /* Identify the glyphs added by the last call to
20404 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20405 the previous glyphs. */
20406 if (!row->reversed_p)
20407 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20408 else
20409 glyph = row->glyphs[TEXT_AREA] + nglyphs - 1 - i;
20410 new_x = x + glyph->pixel_width;
20412 if (/* Lines are continued. */
20413 it->line_wrap != TRUNCATE
20414 && (/* Glyph doesn't fit on the line. */
20415 new_x > it->last_visible_x
20416 /* Or it fits exactly on a window system frame. */
20417 || (new_x == it->last_visible_x
20418 && FRAME_WINDOW_P (it->f)
20419 && (row->reversed_p
20420 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20421 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20423 /* End of a continued line. */
20425 if (it->hpos == 0
20426 || (new_x == it->last_visible_x
20427 && FRAME_WINDOW_P (it->f)
20428 && (row->reversed_p
20429 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20430 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20432 /* Current glyph is the only one on the line or
20433 fits exactly on the line. We must continue
20434 the line because we can't draw the cursor
20435 after the glyph. */
20436 row->continued_p = true;
20437 it->current_x = new_x;
20438 it->continuation_lines_width += new_x;
20439 ++it->hpos;
20440 if (i == nglyphs - 1)
20442 /* If line-wrap is on, check if a previous
20443 wrap point was found. */
20444 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)
20445 && wrap_row_used > 0
20446 /* Even if there is a previous wrap
20447 point, continue the line here as
20448 usual, if (i) the previous character
20449 was a space or tab AND (ii) the
20450 current character is not. */
20451 && (!may_wrap
20452 || IT_DISPLAYING_WHITESPACE (it)))
20453 goto back_to_wrap;
20455 /* Record the maximum and minimum buffer
20456 positions seen so far in glyphs that will be
20457 displayed by this row. */
20458 if (it->bidi_p)
20459 RECORD_MAX_MIN_POS (it);
20460 set_iterator_to_next (it, true);
20461 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20463 if (!get_next_display_element (it))
20465 row->exact_window_width_line_p = true;
20466 it->continuation_lines_width = 0;
20467 row->continued_p = false;
20468 row->ends_at_zv_p = true;
20470 else if (ITERATOR_AT_END_OF_LINE_P (it))
20472 row->continued_p = false;
20473 row->exact_window_width_line_p = true;
20475 /* If line-wrap is on, check if a
20476 previous wrap point was found. */
20477 else if (wrap_row_used > 0
20478 /* Even if there is a previous wrap
20479 point, continue the line here as
20480 usual, if (i) the previous character
20481 was a space or tab AND (ii) the
20482 current character is not. */
20483 && (!may_wrap
20484 || IT_DISPLAYING_WHITESPACE (it)))
20485 goto back_to_wrap;
20489 else if (it->bidi_p)
20490 RECORD_MAX_MIN_POS (it);
20491 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20492 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20493 extend_face_to_end_of_line (it);
20495 else if (CHAR_GLYPH_PADDING_P (*glyph)
20496 && !FRAME_WINDOW_P (it->f))
20498 /* A padding glyph that doesn't fit on this line.
20499 This means the whole character doesn't fit
20500 on the line. */
20501 if (row->reversed_p)
20502 unproduce_glyphs (it, row->used[TEXT_AREA]
20503 - n_glyphs_before);
20504 row->used[TEXT_AREA] = n_glyphs_before;
20506 /* Fill the rest of the row with continuation
20507 glyphs like in 20.x. */
20508 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20509 < row->glyphs[1 + TEXT_AREA])
20510 produce_special_glyphs (it, IT_CONTINUATION);
20512 row->continued_p = true;
20513 it->current_x = x_before;
20514 it->continuation_lines_width += x_before;
20516 /* Restore the height to what it was before the
20517 element not fitting on the line. */
20518 it->max_ascent = ascent;
20519 it->max_descent = descent;
20520 it->max_phys_ascent = phys_ascent;
20521 it->max_phys_descent = phys_descent;
20522 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20523 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20524 extend_face_to_end_of_line (it);
20526 else if (wrap_row_used > 0)
20528 back_to_wrap:
20529 if (row->reversed_p)
20530 unproduce_glyphs (it,
20531 row->used[TEXT_AREA] - wrap_row_used);
20532 RESTORE_IT (it, &wrap_it, wrap_data);
20533 it->continuation_lines_width += wrap_x;
20534 row->used[TEXT_AREA] = wrap_row_used;
20535 row->ascent = wrap_row_ascent;
20536 row->height = wrap_row_height;
20537 row->phys_ascent = wrap_row_phys_ascent;
20538 row->phys_height = wrap_row_phys_height;
20539 row->extra_line_spacing = wrap_row_extra_line_spacing;
20540 min_pos = wrap_row_min_pos;
20541 min_bpos = wrap_row_min_bpos;
20542 max_pos = wrap_row_max_pos;
20543 max_bpos = wrap_row_max_bpos;
20544 row->continued_p = true;
20545 row->ends_at_zv_p = false;
20546 row->exact_window_width_line_p = false;
20547 it->continuation_lines_width += x;
20549 /* Make sure that a non-default face is extended
20550 up to the right margin of the window. */
20551 extend_face_to_end_of_line (it);
20553 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20555 /* A TAB that extends past the right edge of the
20556 window. This produces a single glyph on
20557 window system frames. We leave the glyph in
20558 this row and let it fill the row, but don't
20559 consume the TAB. */
20560 if ((row->reversed_p
20561 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20562 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20563 produce_special_glyphs (it, IT_CONTINUATION);
20564 it->continuation_lines_width += it->last_visible_x;
20565 row->ends_in_middle_of_char_p = true;
20566 row->continued_p = true;
20567 glyph->pixel_width = it->last_visible_x - x;
20568 it->starts_in_middle_of_char_p = true;
20569 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20570 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20571 extend_face_to_end_of_line (it);
20573 else
20575 /* Something other than a TAB that draws past
20576 the right edge of the window. Restore
20577 positions to values before the element. */
20578 if (row->reversed_p)
20579 unproduce_glyphs (it, row->used[TEXT_AREA]
20580 - (n_glyphs_before + i));
20581 row->used[TEXT_AREA] = n_glyphs_before + i;
20583 /* Display continuation glyphs. */
20584 it->current_x = x_before;
20585 it->continuation_lines_width += x;
20586 if (!FRAME_WINDOW_P (it->f)
20587 || (row->reversed_p
20588 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20589 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20590 produce_special_glyphs (it, IT_CONTINUATION);
20591 row->continued_p = true;
20593 extend_face_to_end_of_line (it);
20595 if (nglyphs > 1 && i > 0)
20597 row->ends_in_middle_of_char_p = true;
20598 it->starts_in_middle_of_char_p = true;
20601 /* Restore the height to what it was before the
20602 element not fitting on the line. */
20603 it->max_ascent = ascent;
20604 it->max_descent = descent;
20605 it->max_phys_ascent = phys_ascent;
20606 it->max_phys_descent = phys_descent;
20609 break;
20611 else if (new_x > it->first_visible_x)
20613 /* Increment number of glyphs actually displayed. */
20614 ++it->hpos;
20616 /* Record the maximum and minimum buffer positions
20617 seen so far in glyphs that will be displayed by
20618 this row. */
20619 if (it->bidi_p)
20620 RECORD_MAX_MIN_POS (it);
20622 if (x < it->first_visible_x && !row->reversed_p)
20623 /* Glyph is partially visible, i.e. row starts at
20624 negative X position. Don't do that in R2L
20625 rows, where we arrange to add a right offset to
20626 the line in extend_face_to_end_of_line, by a
20627 suitable change to the stretch glyph that is
20628 the leftmost glyph of the line. */
20629 row->x = x - it->first_visible_x;
20630 /* When the last glyph of an R2L row only fits
20631 partially on the line, we need to set row->x to a
20632 negative offset, so that the leftmost glyph is
20633 the one that is partially visible. But if we are
20634 going to produce the truncation glyph, this will
20635 be taken care of in produce_special_glyphs. */
20636 if (row->reversed_p
20637 && new_x > it->last_visible_x
20638 && !(it->line_wrap == TRUNCATE
20639 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
20641 eassert (FRAME_WINDOW_P (it->f));
20642 row->x = it->last_visible_x - new_x;
20645 else
20647 /* Glyph is completely off the left margin of the
20648 window. This should not happen because of the
20649 move_it_in_display_line at the start of this
20650 function, unless the text display area of the
20651 window is empty. */
20652 eassert (it->first_visible_x <= it->last_visible_x);
20655 /* Even if this display element produced no glyphs at all,
20656 we want to record its position. */
20657 if (it->bidi_p && nglyphs == 0)
20658 RECORD_MAX_MIN_POS (it);
20660 row->ascent = max (row->ascent, it->max_ascent);
20661 row->height = max (row->height, it->max_ascent + it->max_descent);
20662 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20663 row->phys_height = max (row->phys_height,
20664 it->max_phys_ascent + it->max_phys_descent);
20665 row->extra_line_spacing = max (row->extra_line_spacing,
20666 it->max_extra_line_spacing);
20668 /* End of this display line if row is continued. */
20669 if (row->continued_p || row->ends_at_zv_p)
20670 break;
20673 at_end_of_line:
20674 /* Is this a line end? If yes, we're also done, after making
20675 sure that a non-default face is extended up to the right
20676 margin of the window. */
20677 if (ITERATOR_AT_END_OF_LINE_P (it))
20679 int used_before = row->used[TEXT_AREA];
20681 row->ends_in_newline_from_string_p = STRINGP (it->object);
20683 /* Add a space at the end of the line that is used to
20684 display the cursor there. */
20685 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20686 append_space_for_newline (it, false);
20688 /* Extend the face to the end of the line. */
20689 extend_face_to_end_of_line (it);
20691 /* Make sure we have the position. */
20692 if (used_before == 0)
20693 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
20695 /* Record the position of the newline, for use in
20696 find_row_edges. */
20697 it->eol_pos = it->current.pos;
20699 /* Consume the line end. This skips over invisible lines. */
20700 set_iterator_to_next (it, true);
20701 it->continuation_lines_width = 0;
20702 break;
20705 /* Proceed with next display element. Note that this skips
20706 over lines invisible because of selective display. */
20707 set_iterator_to_next (it, true);
20709 /* If we truncate lines, we are done when the last displayed
20710 glyphs reach past the right margin of the window. */
20711 if (it->line_wrap == TRUNCATE
20712 && ((FRAME_WINDOW_P (it->f)
20713 /* Images are preprocessed in produce_image_glyph such
20714 that they are cropped at the right edge of the
20715 window, so an image glyph will always end exactly at
20716 last_visible_x, even if there's no right fringe. */
20717 && ((row->reversed_p
20718 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20719 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))
20720 || it->what == IT_IMAGE))
20721 ? (it->current_x >= it->last_visible_x)
20722 : (it->current_x > it->last_visible_x)))
20724 /* Maybe add truncation glyphs. */
20725 if (!FRAME_WINDOW_P (it->f)
20726 || (row->reversed_p
20727 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20728 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20730 int i, n;
20732 if (!row->reversed_p)
20734 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
20735 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20736 break;
20738 else
20740 for (i = 0; i < row->used[TEXT_AREA]; i++)
20741 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20742 break;
20743 /* Remove any padding glyphs at the front of ROW, to
20744 make room for the truncation glyphs we will be
20745 adding below. The loop below always inserts at
20746 least one truncation glyph, so also remove the
20747 last glyph added to ROW. */
20748 unproduce_glyphs (it, i + 1);
20749 /* Adjust i for the loop below. */
20750 i = row->used[TEXT_AREA] - (i + 1);
20753 /* produce_special_glyphs overwrites the last glyph, so
20754 we don't want that if we want to keep that last
20755 glyph, which means it's an image. */
20756 if (it->current_x > it->last_visible_x)
20758 it->current_x = x_before;
20759 if (!FRAME_WINDOW_P (it->f))
20761 for (n = row->used[TEXT_AREA]; i < n; ++i)
20763 row->used[TEXT_AREA] = i;
20764 produce_special_glyphs (it, IT_TRUNCATION);
20767 else
20769 row->used[TEXT_AREA] = i;
20770 produce_special_glyphs (it, IT_TRUNCATION);
20772 it->hpos = hpos_before;
20775 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20777 /* Don't truncate if we can overflow newline into fringe. */
20778 if (!get_next_display_element (it))
20780 it->continuation_lines_width = 0;
20781 row->ends_at_zv_p = true;
20782 row->exact_window_width_line_p = true;
20783 break;
20785 if (ITERATOR_AT_END_OF_LINE_P (it))
20787 row->exact_window_width_line_p = true;
20788 goto at_end_of_line;
20790 it->current_x = x_before;
20791 it->hpos = hpos_before;
20794 row->truncated_on_right_p = true;
20795 it->continuation_lines_width = 0;
20796 reseat_at_next_visible_line_start (it, false);
20797 /* We insist below that IT's position be at ZV because in
20798 bidi-reordered lines the character at visible line start
20799 might not be the character that follows the newline in
20800 the logical order. */
20801 if (IT_BYTEPOS (*it) > BEG_BYTE)
20802 row->ends_at_zv_p =
20803 IT_BYTEPOS (*it) >= ZV_BYTE && FETCH_BYTE (ZV_BYTE - 1) != '\n';
20804 else
20805 row->ends_at_zv_p = false;
20806 break;
20810 if (wrap_data)
20811 bidi_unshelve_cache (wrap_data, true);
20813 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20814 at the left window margin. */
20815 if (it->first_visible_x
20816 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
20818 if (!FRAME_WINDOW_P (it->f)
20819 || (((row->reversed_p
20820 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
20821 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
20822 /* Don't let insert_left_trunc_glyphs overwrite the
20823 first glyph of the row if it is an image. */
20824 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
20825 insert_left_trunc_glyphs (it);
20826 row->truncated_on_left_p = true;
20829 /* Remember the position at which this line ends.
20831 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20832 cannot be before the call to find_row_edges below, since that is
20833 where these positions are determined. */
20834 row->end = it->current;
20835 if (!it->bidi_p)
20837 row->minpos = row->start.pos;
20838 row->maxpos = row->end.pos;
20840 else
20842 /* ROW->minpos and ROW->maxpos must be the smallest and
20843 `1 + the largest' buffer positions in ROW. But if ROW was
20844 bidi-reordered, these two positions can be anywhere in the
20845 row, so we must determine them now. */
20846 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
20849 /* If the start of this line is the overlay arrow-position, then
20850 mark this glyph row as the one containing the overlay arrow.
20851 This is clearly a mess with variable size fonts. It would be
20852 better to let it be displayed like cursors under X. */
20853 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
20854 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
20855 !NILP (overlay_arrow_string)))
20857 /* Overlay arrow in window redisplay is a fringe bitmap. */
20858 if (STRINGP (overlay_arrow_string))
20860 struct glyph_row *arrow_row
20861 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
20862 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
20863 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
20864 struct glyph *p = row->glyphs[TEXT_AREA];
20865 struct glyph *p2, *end;
20867 /* Copy the arrow glyphs. */
20868 while (glyph < arrow_end)
20869 *p++ = *glyph++;
20871 /* Throw away padding glyphs. */
20872 p2 = p;
20873 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
20874 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
20875 ++p2;
20876 if (p2 > p)
20878 while (p2 < end)
20879 *p++ = *p2++;
20880 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
20883 else
20885 eassert (INTEGERP (overlay_arrow_string));
20886 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
20888 overlay_arrow_seen = true;
20891 /* Highlight trailing whitespace. */
20892 if (!NILP (Vshow_trailing_whitespace))
20893 highlight_trailing_whitespace (it->f, it->glyph_row);
20895 /* Compute pixel dimensions of this line. */
20896 compute_line_metrics (it);
20898 /* Implementation note: No changes in the glyphs of ROW or in their
20899 faces can be done past this point, because compute_line_metrics
20900 computes ROW's hash value and stores it within the glyph_row
20901 structure. */
20903 /* Record whether this row ends inside an ellipsis. */
20904 row->ends_in_ellipsis_p
20905 = (it->method == GET_FROM_DISPLAY_VECTOR
20906 && it->ellipsis_p);
20908 /* Save fringe bitmaps in this row. */
20909 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
20910 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
20911 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
20912 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
20914 it->left_user_fringe_bitmap = 0;
20915 it->left_user_fringe_face_id = 0;
20916 it->right_user_fringe_bitmap = 0;
20917 it->right_user_fringe_face_id = 0;
20919 /* Maybe set the cursor. */
20920 cvpos = it->w->cursor.vpos;
20921 if ((cvpos < 0
20922 /* In bidi-reordered rows, keep checking for proper cursor
20923 position even if one has been found already, because buffer
20924 positions in such rows change non-linearly with ROW->VPOS,
20925 when a line is continued. One exception: when we are at ZV,
20926 display cursor on the first suitable glyph row, since all
20927 the empty rows after that also have their position set to ZV. */
20928 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20929 lines' rows is implemented for bidi-reordered rows. */
20930 || (it->bidi_p
20931 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
20932 && PT >= MATRIX_ROW_START_CHARPOS (row)
20933 && PT <= MATRIX_ROW_END_CHARPOS (row)
20934 && cursor_row_p (row))
20935 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
20937 /* Prepare for the next line. This line starts horizontally at (X
20938 HPOS) = (0 0). Vertical positions are incremented. As a
20939 convenience for the caller, IT->glyph_row is set to the next
20940 row to be used. */
20941 it->current_x = it->hpos = 0;
20942 it->current_y += row->height;
20943 SET_TEXT_POS (it->eol_pos, 0, 0);
20944 ++it->vpos;
20945 ++it->glyph_row;
20946 /* The next row should by default use the same value of the
20947 reversed_p flag as this one. set_iterator_to_next decides when
20948 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20949 the flag accordingly. */
20950 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20951 it->glyph_row->reversed_p = row->reversed_p;
20952 it->start = row->end;
20953 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
20955 #undef RECORD_MAX_MIN_POS
20958 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20959 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20960 doc: /* Return paragraph direction at point in BUFFER.
20961 Value is either `left-to-right' or `right-to-left'.
20962 If BUFFER is omitted or nil, it defaults to the current buffer.
20964 Paragraph direction determines how the text in the paragraph is displayed.
20965 In left-to-right paragraphs, text begins at the left margin of the window
20966 and the reading direction is generally left to right. In right-to-left
20967 paragraphs, text begins at the right margin and is read from right to left.
20969 See also `bidi-paragraph-direction'. */)
20970 (Lisp_Object buffer)
20972 struct buffer *buf = current_buffer;
20973 struct buffer *old = buf;
20975 if (! NILP (buffer))
20977 CHECK_BUFFER (buffer);
20978 buf = XBUFFER (buffer);
20981 if (NILP (BVAR (buf, bidi_display_reordering))
20982 || NILP (BVAR (buf, enable_multibyte_characters))
20983 /* When we are loading loadup.el, the character property tables
20984 needed for bidi iteration are not yet available. */
20985 || !NILP (Vpurify_flag))
20986 return Qleft_to_right;
20987 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
20988 return BVAR (buf, bidi_paragraph_direction);
20989 else
20991 /* Determine the direction from buffer text. We could try to
20992 use current_matrix if it is up to date, but this seems fast
20993 enough as it is. */
20994 struct bidi_it itb;
20995 ptrdiff_t pos = BUF_PT (buf);
20996 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
20997 int c;
20998 void *itb_data = bidi_shelve_cache ();
21000 set_buffer_temp (buf);
21001 /* bidi_paragraph_init finds the base direction of the paragraph
21002 by searching forward from paragraph start. We need the base
21003 direction of the current or _previous_ paragraph, so we need
21004 to make sure we are within that paragraph. To that end, find
21005 the previous non-empty line. */
21006 if (pos >= ZV && pos > BEGV)
21007 DEC_BOTH (pos, bytepos);
21008 AUTO_STRING (trailing_white_space, "[\f\t ]*\n");
21009 if (fast_looking_at (trailing_white_space,
21010 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
21012 while ((c = FETCH_BYTE (bytepos)) == '\n'
21013 || c == ' ' || c == '\t' || c == '\f')
21015 if (bytepos <= BEGV_BYTE)
21016 break;
21017 bytepos--;
21018 pos--;
21020 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
21021 bytepos--;
21023 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
21024 itb.paragraph_dir = NEUTRAL_DIR;
21025 itb.string.s = NULL;
21026 itb.string.lstring = Qnil;
21027 itb.string.bufpos = 0;
21028 itb.string.from_disp_str = false;
21029 itb.string.unibyte = false;
21030 /* We have no window to use here for ignoring window-specific
21031 overlays. Using NULL for window pointer will cause
21032 compute_display_string_pos to use the current buffer. */
21033 itb.w = NULL;
21034 bidi_paragraph_init (NEUTRAL_DIR, &itb, true);
21035 bidi_unshelve_cache (itb_data, false);
21036 set_buffer_temp (old);
21037 switch (itb.paragraph_dir)
21039 case L2R:
21040 return Qleft_to_right;
21041 break;
21042 case R2L:
21043 return Qright_to_left;
21044 break;
21045 default:
21046 emacs_abort ();
21051 DEFUN ("bidi-find-overridden-directionality",
21052 Fbidi_find_overridden_directionality,
21053 Sbidi_find_overridden_directionality, 2, 3, 0,
21054 doc: /* Return position between FROM and TO where directionality was overridden.
21056 This function returns the first character position in the specified
21057 region of OBJECT where there is a character whose `bidi-class' property
21058 is `L', but which was forced to display as `R' by a directional
21059 override, and likewise with characters whose `bidi-class' is `R'
21060 or `AL' that were forced to display as `L'.
21062 If no such character is found, the function returns nil.
21064 OBJECT is a Lisp string or buffer to search for overridden
21065 directionality, and defaults to the current buffer if nil or omitted.
21066 OBJECT can also be a window, in which case the function will search
21067 the buffer displayed in that window. Passing the window instead of
21068 a buffer is preferable when the buffer is displayed in some window,
21069 because this function will then be able to correctly account for
21070 window-specific overlays, which can affect the results.
21072 Strong directional characters `L', `R', and `AL' can have their
21073 intrinsic directionality overridden by directional override
21074 control characters RLO \(u+202e) and LRO \(u+202d). See the
21075 function `get-char-code-property' for a way to inquire about
21076 the `bidi-class' property of a character. */)
21077 (Lisp_Object from, Lisp_Object to, Lisp_Object object)
21079 struct buffer *buf = current_buffer;
21080 struct buffer *old = buf;
21081 struct window *w = NULL;
21082 bool frame_window_p = FRAME_WINDOW_P (SELECTED_FRAME ());
21083 struct bidi_it itb;
21084 ptrdiff_t from_pos, to_pos, from_bpos;
21085 void *itb_data;
21087 if (!NILP (object))
21089 if (BUFFERP (object))
21090 buf = XBUFFER (object);
21091 else if (WINDOWP (object))
21093 w = decode_live_window (object);
21094 buf = XBUFFER (w->contents);
21095 frame_window_p = FRAME_WINDOW_P (XFRAME (w->frame));
21097 else
21098 CHECK_STRING (object);
21101 if (STRINGP (object))
21103 /* Characters in unibyte strings are always treated by bidi.c as
21104 strong LTR. */
21105 if (!STRING_MULTIBYTE (object)
21106 /* When we are loading loadup.el, the character property
21107 tables needed for bidi iteration are not yet
21108 available. */
21109 || !NILP (Vpurify_flag))
21110 return Qnil;
21112 validate_subarray (object, from, to, SCHARS (object), &from_pos, &to_pos);
21113 if (from_pos >= SCHARS (object))
21114 return Qnil;
21116 /* Set up the bidi iterator. */
21117 itb_data = bidi_shelve_cache ();
21118 itb.paragraph_dir = NEUTRAL_DIR;
21119 itb.string.lstring = object;
21120 itb.string.s = NULL;
21121 itb.string.schars = SCHARS (object);
21122 itb.string.bufpos = 0;
21123 itb.string.from_disp_str = false;
21124 itb.string.unibyte = false;
21125 itb.w = w;
21126 bidi_init_it (0, 0, frame_window_p, &itb);
21128 else
21130 /* Nothing this fancy can happen in unibyte buffers, or in a
21131 buffer that disabled reordering, or if FROM is at EOB. */
21132 if (NILP (BVAR (buf, bidi_display_reordering))
21133 || NILP (BVAR (buf, enable_multibyte_characters))
21134 /* When we are loading loadup.el, the character property
21135 tables needed for bidi iteration are not yet
21136 available. */
21137 || !NILP (Vpurify_flag))
21138 return Qnil;
21140 set_buffer_temp (buf);
21141 validate_region (&from, &to);
21142 from_pos = XINT (from);
21143 to_pos = XINT (to);
21144 if (from_pos >= ZV)
21145 return Qnil;
21147 /* Set up the bidi iterator. */
21148 itb_data = bidi_shelve_cache ();
21149 from_bpos = CHAR_TO_BYTE (from_pos);
21150 if (from_pos == BEGV)
21152 itb.charpos = BEGV;
21153 itb.bytepos = BEGV_BYTE;
21155 else if (FETCH_CHAR (from_bpos - 1) == '\n')
21157 itb.charpos = from_pos;
21158 itb.bytepos = from_bpos;
21160 else
21161 itb.charpos = find_newline_no_quit (from_pos, CHAR_TO_BYTE (from_pos),
21162 -1, &itb.bytepos);
21163 itb.paragraph_dir = NEUTRAL_DIR;
21164 itb.string.s = NULL;
21165 itb.string.lstring = Qnil;
21166 itb.string.bufpos = 0;
21167 itb.string.from_disp_str = false;
21168 itb.string.unibyte = false;
21169 itb.w = w;
21170 bidi_init_it (itb.charpos, itb.bytepos, frame_window_p, &itb);
21173 ptrdiff_t found;
21174 do {
21175 /* For the purposes of this function, the actual base direction of
21176 the paragraph doesn't matter, so just set it to L2R. */
21177 bidi_paragraph_init (L2R, &itb, false);
21178 while ((found = bidi_find_first_overridden (&itb)) < from_pos)
21180 } while (found == ZV && itb.ch == '\n' && itb.charpos < to_pos);
21182 bidi_unshelve_cache (itb_data, false);
21183 set_buffer_temp (old);
21185 return (from_pos <= found && found < to_pos) ? make_number (found) : Qnil;
21188 DEFUN ("move-point-visually", Fmove_point_visually,
21189 Smove_point_visually, 1, 1, 0,
21190 doc: /* Move point in the visual order in the specified DIRECTION.
21191 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21192 left.
21194 Value is the new character position of point. */)
21195 (Lisp_Object direction)
21197 struct window *w = XWINDOW (selected_window);
21198 struct buffer *b = XBUFFER (w->contents);
21199 struct glyph_row *row;
21200 int dir;
21201 Lisp_Object paragraph_dir;
21203 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21204 (!(ROW)->continued_p \
21205 && NILP ((GLYPH)->object) \
21206 && (GLYPH)->type == CHAR_GLYPH \
21207 && (GLYPH)->u.ch == ' ' \
21208 && (GLYPH)->charpos >= 0 \
21209 && !(GLYPH)->avoid_cursor_p)
21211 CHECK_NUMBER (direction);
21212 dir = XINT (direction);
21213 if (dir > 0)
21214 dir = 1;
21215 else
21216 dir = -1;
21218 /* If current matrix is up-to-date, we can use the information
21219 recorded in the glyphs, at least as long as the goal is on the
21220 screen. */
21221 if (w->window_end_valid
21222 && !windows_or_buffers_changed
21223 && b
21224 && !b->clip_changed
21225 && !b->prevent_redisplay_optimizations_p
21226 && !window_outdated (w)
21227 /* We rely below on the cursor coordinates to be up to date, but
21228 we cannot trust them if some command moved point since the
21229 last complete redisplay. */
21230 && w->last_point == BUF_PT (b)
21231 && w->cursor.vpos >= 0
21232 && w->cursor.vpos < w->current_matrix->nrows
21233 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
21235 struct glyph *g = row->glyphs[TEXT_AREA];
21236 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
21237 struct glyph *gpt = g + w->cursor.hpos;
21239 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
21241 if (BUFFERP (g->object) && g->charpos != PT)
21243 SET_PT (g->charpos);
21244 w->cursor.vpos = -1;
21245 return make_number (PT);
21247 else if (!NILP (g->object) && !EQ (g->object, gpt->object))
21249 ptrdiff_t new_pos;
21251 if (BUFFERP (gpt->object))
21253 new_pos = PT;
21254 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
21255 new_pos += (row->reversed_p ? -dir : dir);
21256 else
21257 new_pos -= (row->reversed_p ? -dir : dir);
21259 else if (BUFFERP (g->object))
21260 new_pos = g->charpos;
21261 else
21262 break;
21263 SET_PT (new_pos);
21264 w->cursor.vpos = -1;
21265 return make_number (PT);
21267 else if (ROW_GLYPH_NEWLINE_P (row, g))
21269 /* Glyphs inserted at the end of a non-empty line for
21270 positioning the cursor have zero charpos, so we must
21271 deduce the value of point by other means. */
21272 if (g->charpos > 0)
21273 SET_PT (g->charpos);
21274 else if (row->ends_at_zv_p && PT != ZV)
21275 SET_PT (ZV);
21276 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
21277 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21278 else
21279 break;
21280 w->cursor.vpos = -1;
21281 return make_number (PT);
21284 if (g == e || NILP (g->object))
21286 if (row->truncated_on_left_p || row->truncated_on_right_p)
21287 goto simulate_display;
21288 if (!row->reversed_p)
21289 row += dir;
21290 else
21291 row -= dir;
21292 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
21293 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
21294 goto simulate_display;
21296 if (dir > 0)
21298 if (row->reversed_p && !row->continued_p)
21300 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21301 w->cursor.vpos = -1;
21302 return make_number (PT);
21304 g = row->glyphs[TEXT_AREA];
21305 e = g + row->used[TEXT_AREA];
21306 for ( ; g < e; g++)
21308 if (BUFFERP (g->object)
21309 /* Empty lines have only one glyph, which stands
21310 for the newline, and whose charpos is the
21311 buffer position of the newline. */
21312 || ROW_GLYPH_NEWLINE_P (row, g)
21313 /* When the buffer ends in a newline, the line at
21314 EOB also has one glyph, but its charpos is -1. */
21315 || (row->ends_at_zv_p
21316 && !row->reversed_p
21317 && NILP (g->object)
21318 && g->type == CHAR_GLYPH
21319 && g->u.ch == ' '))
21321 if (g->charpos > 0)
21322 SET_PT (g->charpos);
21323 else if (!row->reversed_p
21324 && row->ends_at_zv_p
21325 && PT != ZV)
21326 SET_PT (ZV);
21327 else
21328 continue;
21329 w->cursor.vpos = -1;
21330 return make_number (PT);
21334 else
21336 if (!row->reversed_p && !row->continued_p)
21338 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21339 w->cursor.vpos = -1;
21340 return make_number (PT);
21342 e = row->glyphs[TEXT_AREA];
21343 g = e + row->used[TEXT_AREA] - 1;
21344 for ( ; g >= e; g--)
21346 if (BUFFERP (g->object)
21347 || (ROW_GLYPH_NEWLINE_P (row, g)
21348 && g->charpos > 0)
21349 /* Empty R2L lines on GUI frames have the buffer
21350 position of the newline stored in the stretch
21351 glyph. */
21352 || g->type == STRETCH_GLYPH
21353 || (row->ends_at_zv_p
21354 && row->reversed_p
21355 && NILP (g->object)
21356 && g->type == CHAR_GLYPH
21357 && g->u.ch == ' '))
21359 if (g->charpos > 0)
21360 SET_PT (g->charpos);
21361 else if (row->reversed_p
21362 && row->ends_at_zv_p
21363 && PT != ZV)
21364 SET_PT (ZV);
21365 else
21366 continue;
21367 w->cursor.vpos = -1;
21368 return make_number (PT);
21375 simulate_display:
21377 /* If we wind up here, we failed to move by using the glyphs, so we
21378 need to simulate display instead. */
21380 if (b)
21381 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
21382 else
21383 paragraph_dir = Qleft_to_right;
21384 if (EQ (paragraph_dir, Qright_to_left))
21385 dir = -dir;
21386 if (PT <= BEGV && dir < 0)
21387 xsignal0 (Qbeginning_of_buffer);
21388 else if (PT >= ZV && dir > 0)
21389 xsignal0 (Qend_of_buffer);
21390 else
21392 struct text_pos pt;
21393 struct it it;
21394 int pt_x, target_x, pixel_width, pt_vpos;
21395 bool at_eol_p;
21396 bool overshoot_expected = false;
21397 bool target_is_eol_p = false;
21399 /* Setup the arena. */
21400 SET_TEXT_POS (pt, PT, PT_BYTE);
21401 start_display (&it, w, pt);
21402 /* When lines are truncated, we could be called with point
21403 outside of the windows edges, in which case move_it_*
21404 functions either prematurely stop at window's edge or jump to
21405 the next screen line, whereas we rely below on our ability to
21406 reach point, in order to start from its X coordinate. So we
21407 need to disregard the window's horizontal extent in that case. */
21408 if (it.line_wrap == TRUNCATE)
21409 it.last_visible_x = INFINITY;
21411 if (it.cmp_it.id < 0
21412 && it.method == GET_FROM_STRING
21413 && it.area == TEXT_AREA
21414 && it.string_from_display_prop_p
21415 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
21416 overshoot_expected = true;
21418 /* Find the X coordinate of point. We start from the beginning
21419 of this or previous line to make sure we are before point in
21420 the logical order (since the move_it_* functions can only
21421 move forward). */
21422 reseat:
21423 reseat_at_previous_visible_line_start (&it);
21424 it.current_x = it.hpos = it.current_y = it.vpos = 0;
21425 if (IT_CHARPOS (it) != PT)
21427 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
21428 -1, -1, -1, MOVE_TO_POS);
21429 /* If we missed point because the character there is
21430 displayed out of a display vector that has more than one
21431 glyph, retry expecting overshoot. */
21432 if (it.method == GET_FROM_DISPLAY_VECTOR
21433 && it.current.dpvec_index > 0
21434 && !overshoot_expected)
21436 overshoot_expected = true;
21437 goto reseat;
21439 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
21440 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
21442 pt_x = it.current_x;
21443 pt_vpos = it.vpos;
21444 if (dir > 0 || overshoot_expected)
21446 struct glyph_row *row = it.glyph_row;
21448 /* When point is at beginning of line, we don't have
21449 information about the glyph there loaded into struct
21450 it. Calling get_next_display_element fixes that. */
21451 if (pt_x == 0)
21452 get_next_display_element (&it);
21453 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21454 it.glyph_row = NULL;
21455 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
21456 it.glyph_row = row;
21457 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21458 it, lest it will become out of sync with it's buffer
21459 position. */
21460 it.current_x = pt_x;
21462 else
21463 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21464 pixel_width = it.pixel_width;
21465 if (overshoot_expected && at_eol_p)
21466 pixel_width = 0;
21467 else if (pixel_width <= 0)
21468 pixel_width = 1;
21470 /* If there's a display string (or something similar) at point,
21471 we are actually at the glyph to the left of point, so we need
21472 to correct the X coordinate. */
21473 if (overshoot_expected)
21475 if (it.bidi_p)
21476 pt_x += pixel_width * it.bidi_it.scan_dir;
21477 else
21478 pt_x += pixel_width;
21481 /* Compute target X coordinate, either to the left or to the
21482 right of point. On TTY frames, all characters have the same
21483 pixel width of 1, so we can use that. On GUI frames we don't
21484 have an easy way of getting at the pixel width of the
21485 character to the left of point, so we use a different method
21486 of getting to that place. */
21487 if (dir > 0)
21488 target_x = pt_x + pixel_width;
21489 else
21490 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
21492 /* Target X coordinate could be one line above or below the line
21493 of point, in which case we need to adjust the target X
21494 coordinate. Also, if moving to the left, we need to begin at
21495 the left edge of the point's screen line. */
21496 if (dir < 0)
21498 if (pt_x > 0)
21500 start_display (&it, w, pt);
21501 if (it.line_wrap == TRUNCATE)
21502 it.last_visible_x = INFINITY;
21503 reseat_at_previous_visible_line_start (&it);
21504 it.current_x = it.current_y = it.hpos = 0;
21505 if (pt_vpos != 0)
21506 move_it_by_lines (&it, pt_vpos);
21508 else
21510 move_it_by_lines (&it, -1);
21511 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
21512 target_is_eol_p = true;
21513 /* Under word-wrap, we don't know the x coordinate of
21514 the last character displayed on the previous line,
21515 which immediately precedes the wrap point. To find
21516 out its x coordinate, we try moving to the right
21517 margin of the window, which will stop at the wrap
21518 point, and then reset target_x to point at the
21519 character that precedes the wrap point. This is not
21520 needed on GUI frames, because (see below) there we
21521 move from the left margin one grapheme cluster at a
21522 time, and stop when we hit the wrap point. */
21523 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
21525 void *it_data = NULL;
21526 struct it it2;
21528 SAVE_IT (it2, it, it_data);
21529 move_it_in_display_line_to (&it, ZV, target_x,
21530 MOVE_TO_POS | MOVE_TO_X);
21531 /* If we arrived at target_x, that _is_ the last
21532 character on the previous line. */
21533 if (it.current_x != target_x)
21534 target_x = it.current_x - 1;
21535 RESTORE_IT (&it, &it2, it_data);
21539 else
21541 if (at_eol_p
21542 || (target_x >= it.last_visible_x
21543 && it.line_wrap != TRUNCATE))
21545 if (pt_x > 0)
21546 move_it_by_lines (&it, 0);
21547 move_it_by_lines (&it, 1);
21548 target_x = 0;
21552 /* Move to the target X coordinate. */
21553 #ifdef HAVE_WINDOW_SYSTEM
21554 /* On GUI frames, as we don't know the X coordinate of the
21555 character to the left of point, moving point to the left
21556 requires walking, one grapheme cluster at a time, until we
21557 find ourself at a place immediately to the left of the
21558 character at point. */
21559 if (FRAME_WINDOW_P (it.f) && dir < 0)
21561 struct text_pos new_pos;
21562 enum move_it_result rc = MOVE_X_REACHED;
21564 if (it.current_x == 0)
21565 get_next_display_element (&it);
21566 if (it.what == IT_COMPOSITION)
21568 new_pos.charpos = it.cmp_it.charpos;
21569 new_pos.bytepos = -1;
21571 else
21572 new_pos = it.current.pos;
21574 while (it.current_x + it.pixel_width <= target_x
21575 && (rc == MOVE_X_REACHED
21576 /* Under word-wrap, move_it_in_display_line_to
21577 stops at correct coordinates, but sometimes
21578 returns MOVE_POS_MATCH_OR_ZV. */
21579 || (it.line_wrap == WORD_WRAP
21580 && rc == MOVE_POS_MATCH_OR_ZV)))
21582 int new_x = it.current_x + it.pixel_width;
21584 /* For composed characters, we want the position of the
21585 first character in the grapheme cluster (usually, the
21586 composition's base character), whereas it.current
21587 might give us the position of the _last_ one, e.g. if
21588 the composition is rendered in reverse due to bidi
21589 reordering. */
21590 if (it.what == IT_COMPOSITION)
21592 new_pos.charpos = it.cmp_it.charpos;
21593 new_pos.bytepos = -1;
21595 else
21596 new_pos = it.current.pos;
21597 if (new_x == it.current_x)
21598 new_x++;
21599 rc = move_it_in_display_line_to (&it, ZV, new_x,
21600 MOVE_TO_POS | MOVE_TO_X);
21601 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21602 break;
21604 /* The previous position we saw in the loop is the one we
21605 want. */
21606 if (new_pos.bytepos == -1)
21607 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21608 it.current.pos = new_pos;
21610 else
21611 #endif
21612 if (it.current_x != target_x)
21613 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21615 /* If we ended up in a display string that covers point, move to
21616 buffer position to the right in the visual order. */
21617 if (dir > 0)
21619 while (IT_CHARPOS (it) == PT)
21621 set_iterator_to_next (&it, false);
21622 if (!get_next_display_element (&it))
21623 break;
21627 /* Move point to that position. */
21628 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21631 return make_number (PT);
21633 #undef ROW_GLYPH_NEWLINE_P
21636 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels,
21637 Sbidi_resolved_levels, 0, 1, 0,
21638 doc: /* Return the resolved bidirectional levels of characters at VPOS.
21640 The resolved levels are produced by the Emacs bidi reordering engine
21641 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21642 read the Unicode Standard Annex 9 (UAX#9) for background information
21643 about these levels.
21645 VPOS is the zero-based number of the current window's screen line
21646 for which to produce the resolved levels. If VPOS is nil or omitted,
21647 it defaults to the screen line of point. If the window displays a
21648 header line, VPOS of zero will report on the header line, and first
21649 line of text in the window will have VPOS of 1.
21651 Value is an array of resolved levels, indexed by glyph number.
21652 Glyphs are numbered from zero starting from the beginning of the
21653 screen line, i.e. the left edge of the window for left-to-right lines
21654 and from the right edge for right-to-left lines. The resolved levels
21655 are produced only for the window's text area; text in display margins
21656 is not included.
21658 If the selected window's display is not up-to-date, or if the specified
21659 screen line does not display text, this function returns nil. It is
21660 highly recommended to bind this function to some simple key, like F8,
21661 in order to avoid these problems.
21663 This function exists mainly for testing the correctness of the
21664 Emacs UBA implementation, in particular with the test suite. */)
21665 (Lisp_Object vpos)
21667 struct window *w = XWINDOW (selected_window);
21668 struct buffer *b = XBUFFER (w->contents);
21669 int nrow;
21670 struct glyph_row *row;
21672 if (NILP (vpos))
21674 int d1, d2, d3, d4, d5;
21676 pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &nrow);
21678 else
21680 CHECK_NUMBER_COERCE_MARKER (vpos);
21681 nrow = XINT (vpos);
21684 /* We require up-to-date glyph matrix for this window. */
21685 if (w->window_end_valid
21686 && !windows_or_buffers_changed
21687 && b
21688 && !b->clip_changed
21689 && !b->prevent_redisplay_optimizations_p
21690 && !window_outdated (w)
21691 && nrow >= 0
21692 && nrow < w->current_matrix->nrows
21693 && (row = MATRIX_ROW (w->current_matrix, nrow))->enabled_p
21694 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
21696 struct glyph *g, *e, *g1;
21697 int nglyphs, i;
21698 Lisp_Object levels;
21700 if (!row->reversed_p) /* Left-to-right glyph row. */
21702 g = g1 = row->glyphs[TEXT_AREA];
21703 e = g + row->used[TEXT_AREA];
21705 /* Skip over glyphs at the start of the row that was
21706 generated by redisplay for its own needs. */
21707 while (g < e
21708 && NILP (g->object)
21709 && g->charpos < 0)
21710 g++;
21711 g1 = g;
21713 /* Count the "interesting" glyphs in this row. */
21714 for (nglyphs = 0; g < e && !NILP (g->object); g++)
21715 nglyphs++;
21717 /* Create and fill the array. */
21718 levels = make_uninit_vector (nglyphs);
21719 for (i = 0; g1 < g; i++, g1++)
21720 ASET (levels, i, make_number (g1->resolved_level));
21722 else /* Right-to-left glyph row. */
21724 g = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
21725 e = row->glyphs[TEXT_AREA] - 1;
21726 while (g > e
21727 && NILP (g->object)
21728 && g->charpos < 0)
21729 g--;
21730 g1 = g;
21731 for (nglyphs = 0; g > e && !NILP (g->object); g--)
21732 nglyphs++;
21733 levels = make_uninit_vector (nglyphs);
21734 for (i = 0; g1 > g; i++, g1--)
21735 ASET (levels, i, make_number (g1->resolved_level));
21737 return levels;
21739 else
21740 return Qnil;
21745 /***********************************************************************
21746 Menu Bar
21747 ***********************************************************************/
21749 /* Redisplay the menu bar in the frame for window W.
21751 The menu bar of X frames that don't have X toolkit support is
21752 displayed in a special window W->frame->menu_bar_window.
21754 The menu bar of terminal frames is treated specially as far as
21755 glyph matrices are concerned. Menu bar lines are not part of
21756 windows, so the update is done directly on the frame matrix rows
21757 for the menu bar. */
21759 static void
21760 display_menu_bar (struct window *w)
21762 struct frame *f = XFRAME (WINDOW_FRAME (w));
21763 struct it it;
21764 Lisp_Object items;
21765 int i;
21767 /* Don't do all this for graphical frames. */
21768 #ifdef HAVE_NTGUI
21769 if (FRAME_W32_P (f))
21770 return;
21771 #endif
21772 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21773 if (FRAME_X_P (f))
21774 return;
21775 #endif
21777 #ifdef HAVE_NS
21778 if (FRAME_NS_P (f))
21779 return;
21780 #endif /* HAVE_NS */
21782 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21783 eassert (!FRAME_WINDOW_P (f));
21784 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
21785 it.first_visible_x = 0;
21786 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21787 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21788 if (FRAME_WINDOW_P (f))
21790 /* Menu bar lines are displayed in the desired matrix of the
21791 dummy window menu_bar_window. */
21792 struct window *menu_w;
21793 menu_w = XWINDOW (f->menu_bar_window);
21794 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
21795 MENU_FACE_ID);
21796 it.first_visible_x = 0;
21797 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21799 else
21800 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21802 /* This is a TTY frame, i.e. character hpos/vpos are used as
21803 pixel x/y. */
21804 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
21805 MENU_FACE_ID);
21806 it.first_visible_x = 0;
21807 it.last_visible_x = FRAME_COLS (f);
21810 /* FIXME: This should be controlled by a user option. See the
21811 comments in redisplay_tool_bar and display_mode_line about
21812 this. */
21813 it.paragraph_embedding = L2R;
21815 /* Clear all rows of the menu bar. */
21816 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
21818 struct glyph_row *row = it.glyph_row + i;
21819 clear_glyph_row (row);
21820 row->enabled_p = true;
21821 row->full_width_p = true;
21822 row->reversed_p = false;
21825 /* Display all items of the menu bar. */
21826 items = FRAME_MENU_BAR_ITEMS (it.f);
21827 for (i = 0; i < ASIZE (items); i += 4)
21829 Lisp_Object string;
21831 /* Stop at nil string. */
21832 string = AREF (items, i + 1);
21833 if (NILP (string))
21834 break;
21836 /* Remember where item was displayed. */
21837 ASET (items, i + 3, make_number (it.hpos));
21839 /* Display the item, pad with one space. */
21840 if (it.current_x < it.last_visible_x)
21841 display_string (NULL, string, Qnil, 0, 0, &it,
21842 SCHARS (string) + 1, 0, 0, -1);
21845 /* Fill out the line with spaces. */
21846 if (it.current_x < it.last_visible_x)
21847 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
21849 /* Compute the total height of the lines. */
21850 compute_line_metrics (&it);
21853 /* Deep copy of a glyph row, including the glyphs. */
21854 static void
21855 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
21857 struct glyph *pointers[1 + LAST_AREA];
21858 int to_used = to->used[TEXT_AREA];
21860 /* Save glyph pointers of TO. */
21861 memcpy (pointers, to->glyphs, sizeof to->glyphs);
21863 /* Do a structure assignment. */
21864 *to = *from;
21866 /* Restore original glyph pointers of TO. */
21867 memcpy (to->glyphs, pointers, sizeof to->glyphs);
21869 /* Copy the glyphs. */
21870 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
21871 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
21873 /* If we filled only part of the TO row, fill the rest with
21874 space_glyph (which will display as empty space). */
21875 if (to_used > from->used[TEXT_AREA])
21876 fill_up_frame_row_with_spaces (to, to_used);
21879 /* Display one menu item on a TTY, by overwriting the glyphs in the
21880 frame F's desired glyph matrix with glyphs produced from the menu
21881 item text. Called from term.c to display TTY drop-down menus one
21882 item at a time.
21884 ITEM_TEXT is the menu item text as a C string.
21886 FACE_ID is the face ID to be used for this menu item. FACE_ID
21887 could specify one of 3 faces: a face for an enabled item, a face
21888 for a disabled item, or a face for a selected item.
21890 X and Y are coordinates of the first glyph in the frame's desired
21891 matrix to be overwritten by the menu item. Since this is a TTY, Y
21892 is the zero-based number of the glyph row and X is the zero-based
21893 glyph number in the row, starting from left, where to start
21894 displaying the item.
21896 SUBMENU means this menu item drops down a submenu, which
21897 should be indicated by displaying a proper visual cue after the
21898 item text. */
21900 void
21901 display_tty_menu_item (const char *item_text, int width, int face_id,
21902 int x, int y, bool submenu)
21904 struct it it;
21905 struct frame *f = SELECTED_FRAME ();
21906 struct window *w = XWINDOW (f->selected_window);
21907 struct glyph_row *row;
21908 size_t item_len = strlen (item_text);
21910 eassert (FRAME_TERMCAP_P (f));
21912 /* Don't write beyond the matrix's last row. This can happen for
21913 TTY screens that are not high enough to show the entire menu.
21914 (This is actually a bit of defensive programming, as
21915 tty_menu_display already limits the number of menu items to one
21916 less than the number of screen lines.) */
21917 if (y >= f->desired_matrix->nrows)
21918 return;
21920 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
21921 it.first_visible_x = 0;
21922 it.last_visible_x = FRAME_COLS (f) - 1;
21923 row = it.glyph_row;
21924 /* Start with the row contents from the current matrix. */
21925 deep_copy_glyph_row (row, f->current_matrix->rows + y);
21926 bool saved_width = row->full_width_p;
21927 row->full_width_p = true;
21928 bool saved_reversed = row->reversed_p;
21929 row->reversed_p = false;
21930 row->enabled_p = true;
21932 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21933 desired face. */
21934 eassert (x < f->desired_matrix->matrix_w);
21935 it.current_x = it.hpos = x;
21936 it.current_y = it.vpos = y;
21937 int saved_used = row->used[TEXT_AREA];
21938 bool saved_truncated = row->truncated_on_right_p;
21939 row->used[TEXT_AREA] = x;
21940 it.face_id = face_id;
21941 it.line_wrap = TRUNCATE;
21943 /* FIXME: This should be controlled by a user option. See the
21944 comments in redisplay_tool_bar and display_mode_line about this.
21945 Also, if paragraph_embedding could ever be R2L, changes will be
21946 needed to avoid shifting to the right the row characters in
21947 term.c:append_glyph. */
21948 it.paragraph_embedding = L2R;
21950 /* Pad with a space on the left. */
21951 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
21952 width--;
21953 /* Display the menu item, pad with spaces to WIDTH. */
21954 if (submenu)
21956 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21957 item_len, 0, FRAME_COLS (f) - 1, -1);
21958 width -= item_len;
21959 /* Indicate with " >" that there's a submenu. */
21960 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
21961 FRAME_COLS (f) - 1, -1);
21963 else
21964 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21965 width, 0, FRAME_COLS (f) - 1, -1);
21967 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
21968 row->truncated_on_right_p = saved_truncated;
21969 row->hash = row_hash (row);
21970 row->full_width_p = saved_width;
21971 row->reversed_p = saved_reversed;
21974 /***********************************************************************
21975 Mode Line
21976 ***********************************************************************/
21978 /* Redisplay mode lines in the window tree whose root is WINDOW.
21979 If FORCE, redisplay mode lines unconditionally.
21980 Otherwise, redisplay only mode lines that are garbaged. Value is
21981 the number of windows whose mode lines were redisplayed. */
21983 static int
21984 redisplay_mode_lines (Lisp_Object window, bool force)
21986 int nwindows = 0;
21988 while (!NILP (window))
21990 struct window *w = XWINDOW (window);
21992 if (WINDOWP (w->contents))
21993 nwindows += redisplay_mode_lines (w->contents, force);
21994 else if (force
21995 || FRAME_GARBAGED_P (XFRAME (w->frame))
21996 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
21998 struct text_pos lpoint;
21999 struct buffer *old = current_buffer;
22001 /* Set the window's buffer for the mode line display. */
22002 SET_TEXT_POS (lpoint, PT, PT_BYTE);
22003 set_buffer_internal_1 (XBUFFER (w->contents));
22005 /* Point refers normally to the selected window. For any
22006 other window, set up appropriate value. */
22007 if (!EQ (window, selected_window))
22009 struct text_pos pt;
22011 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
22012 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
22015 /* Display mode lines. */
22016 clear_glyph_matrix (w->desired_matrix);
22017 if (display_mode_lines (w))
22018 ++nwindows;
22020 /* Restore old settings. */
22021 set_buffer_internal_1 (old);
22022 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
22025 window = w->next;
22028 return nwindows;
22032 /* Display the mode and/or header line of window W. Value is the
22033 sum number of mode lines and header lines displayed. */
22035 static int
22036 display_mode_lines (struct window *w)
22038 Lisp_Object old_selected_window = selected_window;
22039 Lisp_Object old_selected_frame = selected_frame;
22040 Lisp_Object new_frame = w->frame;
22041 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
22042 int n = 0;
22044 selected_frame = new_frame;
22045 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22046 or window's point, then we'd need select_window_1 here as well. */
22047 XSETWINDOW (selected_window, w);
22048 XFRAME (new_frame)->selected_window = selected_window;
22050 /* These will be set while the mode line specs are processed. */
22051 line_number_displayed = false;
22052 w->column_number_displayed = -1;
22054 if (WINDOW_WANTS_MODELINE_P (w))
22056 struct window *sel_w = XWINDOW (old_selected_window);
22058 /* Select mode line face based on the real selected window. */
22059 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
22060 BVAR (current_buffer, mode_line_format));
22061 ++n;
22064 if (WINDOW_WANTS_HEADER_LINE_P (w))
22066 display_mode_line (w, HEADER_LINE_FACE_ID,
22067 BVAR (current_buffer, header_line_format));
22068 ++n;
22071 XFRAME (new_frame)->selected_window = old_frame_selected_window;
22072 selected_frame = old_selected_frame;
22073 selected_window = old_selected_window;
22074 if (n > 0)
22075 w->must_be_updated_p = true;
22076 return n;
22080 /* Display mode or header line of window W. FACE_ID specifies which
22081 line to display; it is either MODE_LINE_FACE_ID or
22082 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22083 display. Value is the pixel height of the mode/header line
22084 displayed. */
22086 static int
22087 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
22089 struct it it;
22090 struct face *face;
22091 ptrdiff_t count = SPECPDL_INDEX ();
22093 init_iterator (&it, w, -1, -1, NULL, face_id);
22094 /* Don't extend on a previously drawn mode-line.
22095 This may happen if called from pos_visible_p. */
22096 it.glyph_row->enabled_p = false;
22097 prepare_desired_row (w, it.glyph_row, true);
22099 it.glyph_row->mode_line_p = true;
22101 /* FIXME: This should be controlled by a user option. But
22102 supporting such an option is not trivial, since the mode line is
22103 made up of many separate strings. */
22104 it.paragraph_embedding = L2R;
22106 record_unwind_protect (unwind_format_mode_line,
22107 format_mode_line_unwind_data (NULL, NULL,
22108 Qnil, false));
22110 mode_line_target = MODE_LINE_DISPLAY;
22112 /* Temporarily make frame's keyboard the current kboard so that
22113 kboard-local variables in the mode_line_format will get the right
22114 values. */
22115 push_kboard (FRAME_KBOARD (it.f));
22116 record_unwind_save_match_data ();
22117 display_mode_element (&it, 0, 0, 0, format, Qnil, false);
22118 pop_kboard ();
22120 unbind_to (count, Qnil);
22122 /* Fill up with spaces. */
22123 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
22125 compute_line_metrics (&it);
22126 it.glyph_row->full_width_p = true;
22127 it.glyph_row->continued_p = false;
22128 it.glyph_row->truncated_on_left_p = false;
22129 it.glyph_row->truncated_on_right_p = false;
22131 /* Make a 3D mode-line have a shadow at its right end. */
22132 face = FACE_FROM_ID (it.f, face_id);
22133 extend_face_to_end_of_line (&it);
22134 if (face->box != FACE_NO_BOX)
22136 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
22137 + it.glyph_row->used[TEXT_AREA] - 1);
22138 last->right_box_line_p = true;
22141 return it.glyph_row->height;
22144 /* Move element ELT in LIST to the front of LIST.
22145 Return the updated list. */
22147 static Lisp_Object
22148 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
22150 register Lisp_Object tail, prev;
22151 register Lisp_Object tem;
22153 tail = list;
22154 prev = Qnil;
22155 while (CONSP (tail))
22157 tem = XCAR (tail);
22159 if (EQ (elt, tem))
22161 /* Splice out the link TAIL. */
22162 if (NILP (prev))
22163 list = XCDR (tail);
22164 else
22165 Fsetcdr (prev, XCDR (tail));
22167 /* Now make it the first. */
22168 Fsetcdr (tail, list);
22169 return tail;
22171 else
22172 prev = tail;
22173 tail = XCDR (tail);
22174 QUIT;
22177 /* Not found--return unchanged LIST. */
22178 return list;
22181 /* Contribute ELT to the mode line for window IT->w. How it
22182 translates into text depends on its data type.
22184 IT describes the display environment in which we display, as usual.
22186 DEPTH is the depth in recursion. It is used to prevent
22187 infinite recursion here.
22189 FIELD_WIDTH is the number of characters the display of ELT should
22190 occupy in the mode line, and PRECISION is the maximum number of
22191 characters to display from ELT's representation. See
22192 display_string for details.
22194 Returns the hpos of the end of the text generated by ELT.
22196 PROPS is a property list to add to any string we encounter.
22198 If RISKY, remove (disregard) any properties in any string
22199 we encounter, and ignore :eval and :propertize.
22201 The global variable `mode_line_target' determines whether the
22202 output is passed to `store_mode_line_noprop',
22203 `store_mode_line_string', or `display_string'. */
22205 static int
22206 display_mode_element (struct it *it, int depth, int field_width, int precision,
22207 Lisp_Object elt, Lisp_Object props, bool risky)
22209 int n = 0, field, prec;
22210 bool literal = false;
22212 tail_recurse:
22213 if (depth > 100)
22214 elt = build_string ("*too-deep*");
22216 depth++;
22218 switch (XTYPE (elt))
22220 case Lisp_String:
22222 /* A string: output it and check for %-constructs within it. */
22223 unsigned char c;
22224 ptrdiff_t offset = 0;
22226 if (SCHARS (elt) > 0
22227 && (!NILP (props) || risky))
22229 Lisp_Object oprops, aelt;
22230 oprops = Ftext_properties_at (make_number (0), elt);
22232 /* If the starting string's properties are not what
22233 we want, translate the string. Also, if the string
22234 is risky, do that anyway. */
22236 if (NILP (Fequal (props, oprops)) || risky)
22238 /* If the starting string has properties,
22239 merge the specified ones onto the existing ones. */
22240 if (! NILP (oprops) && !risky)
22242 Lisp_Object tem;
22244 oprops = Fcopy_sequence (oprops);
22245 tem = props;
22246 while (CONSP (tem))
22248 oprops = Fplist_put (oprops, XCAR (tem),
22249 XCAR (XCDR (tem)));
22250 tem = XCDR (XCDR (tem));
22252 props = oprops;
22255 aelt = Fassoc (elt, mode_line_proptrans_alist);
22256 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
22258 /* AELT is what we want. Move it to the front
22259 without consing. */
22260 elt = XCAR (aelt);
22261 mode_line_proptrans_alist
22262 = move_elt_to_front (aelt, mode_line_proptrans_alist);
22264 else
22266 Lisp_Object tem;
22268 /* If AELT has the wrong props, it is useless.
22269 so get rid of it. */
22270 if (! NILP (aelt))
22271 mode_line_proptrans_alist
22272 = Fdelq (aelt, mode_line_proptrans_alist);
22274 elt = Fcopy_sequence (elt);
22275 Fset_text_properties (make_number (0), Flength (elt),
22276 props, elt);
22277 /* Add this item to mode_line_proptrans_alist. */
22278 mode_line_proptrans_alist
22279 = Fcons (Fcons (elt, props),
22280 mode_line_proptrans_alist);
22281 /* Truncate mode_line_proptrans_alist
22282 to at most 50 elements. */
22283 tem = Fnthcdr (make_number (50),
22284 mode_line_proptrans_alist);
22285 if (! NILP (tem))
22286 XSETCDR (tem, Qnil);
22291 offset = 0;
22293 if (literal)
22295 prec = precision - n;
22296 switch (mode_line_target)
22298 case MODE_LINE_NOPROP:
22299 case MODE_LINE_TITLE:
22300 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
22301 break;
22302 case MODE_LINE_STRING:
22303 n += store_mode_line_string (NULL, elt, true, 0, prec, Qnil);
22304 break;
22305 case MODE_LINE_DISPLAY:
22306 n += display_string (NULL, elt, Qnil, 0, 0, it,
22307 0, prec, 0, STRING_MULTIBYTE (elt));
22308 break;
22311 break;
22314 /* Handle the non-literal case. */
22316 while ((precision <= 0 || n < precision)
22317 && SREF (elt, offset) != 0
22318 && (mode_line_target != MODE_LINE_DISPLAY
22319 || it->current_x < it->last_visible_x))
22321 ptrdiff_t last_offset = offset;
22323 /* Advance to end of string or next format specifier. */
22324 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
22327 if (offset - 1 != last_offset)
22329 ptrdiff_t nchars, nbytes;
22331 /* Output to end of string or up to '%'. Field width
22332 is length of string. Don't output more than
22333 PRECISION allows us. */
22334 offset--;
22336 prec = c_string_width (SDATA (elt) + last_offset,
22337 offset - last_offset, precision - n,
22338 &nchars, &nbytes);
22340 switch (mode_line_target)
22342 case MODE_LINE_NOPROP:
22343 case MODE_LINE_TITLE:
22344 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
22345 break;
22346 case MODE_LINE_STRING:
22348 ptrdiff_t bytepos = last_offset;
22349 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22350 ptrdiff_t endpos = (precision <= 0
22351 ? string_byte_to_char (elt, offset)
22352 : charpos + nchars);
22353 Lisp_Object mode_string
22354 = Fsubstring (elt, make_number (charpos),
22355 make_number (endpos));
22356 n += store_mode_line_string (NULL, mode_string, false,
22357 0, 0, Qnil);
22359 break;
22360 case MODE_LINE_DISPLAY:
22362 ptrdiff_t bytepos = last_offset;
22363 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22365 if (precision <= 0)
22366 nchars = string_byte_to_char (elt, offset) - charpos;
22367 n += display_string (NULL, elt, Qnil, 0, charpos,
22368 it, 0, nchars, 0,
22369 STRING_MULTIBYTE (elt));
22371 break;
22374 else /* c == '%' */
22376 ptrdiff_t percent_position = offset;
22378 /* Get the specified minimum width. Zero means
22379 don't pad. */
22380 field = 0;
22381 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
22382 field = field * 10 + c - '0';
22384 /* Don't pad beyond the total padding allowed. */
22385 if (field_width - n > 0 && field > field_width - n)
22386 field = field_width - n;
22388 /* Note that either PRECISION <= 0 or N < PRECISION. */
22389 prec = precision - n;
22391 if (c == 'M')
22392 n += display_mode_element (it, depth, field, prec,
22393 Vglobal_mode_string, props,
22394 risky);
22395 else if (c != 0)
22397 bool multibyte;
22398 ptrdiff_t bytepos, charpos;
22399 const char *spec;
22400 Lisp_Object string;
22402 bytepos = percent_position;
22403 charpos = (STRING_MULTIBYTE (elt)
22404 ? string_byte_to_char (elt, bytepos)
22405 : bytepos);
22406 spec = decode_mode_spec (it->w, c, field, &string);
22407 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
22409 switch (mode_line_target)
22411 case MODE_LINE_NOPROP:
22412 case MODE_LINE_TITLE:
22413 n += store_mode_line_noprop (spec, field, prec);
22414 break;
22415 case MODE_LINE_STRING:
22417 Lisp_Object tem = build_string (spec);
22418 props = Ftext_properties_at (make_number (charpos), elt);
22419 /* Should only keep face property in props */
22420 n += store_mode_line_string (NULL, tem, false,
22421 field, prec, props);
22423 break;
22424 case MODE_LINE_DISPLAY:
22426 int nglyphs_before, nwritten;
22428 nglyphs_before = it->glyph_row->used[TEXT_AREA];
22429 nwritten = display_string (spec, string, elt,
22430 charpos, 0, it,
22431 field, prec, 0,
22432 multibyte);
22434 /* Assign to the glyphs written above the
22435 string where the `%x' came from, position
22436 of the `%'. */
22437 if (nwritten > 0)
22439 struct glyph *glyph
22440 = (it->glyph_row->glyphs[TEXT_AREA]
22441 + nglyphs_before);
22442 int i;
22444 for (i = 0; i < nwritten; ++i)
22446 glyph[i].object = elt;
22447 glyph[i].charpos = charpos;
22450 n += nwritten;
22453 break;
22456 else /* c == 0 */
22457 break;
22461 break;
22463 case Lisp_Symbol:
22464 /* A symbol: process the value of the symbol recursively
22465 as if it appeared here directly. Avoid error if symbol void.
22466 Special case: if value of symbol is a string, output the string
22467 literally. */
22469 register Lisp_Object tem;
22471 /* If the variable is not marked as risky to set
22472 then its contents are risky to use. */
22473 if (NILP (Fget (elt, Qrisky_local_variable)))
22474 risky = true;
22476 tem = Fboundp (elt);
22477 if (!NILP (tem))
22479 tem = Fsymbol_value (elt);
22480 /* If value is a string, output that string literally:
22481 don't check for % within it. */
22482 if (STRINGP (tem))
22483 literal = true;
22485 if (!EQ (tem, elt))
22487 /* Give up right away for nil or t. */
22488 elt = tem;
22489 goto tail_recurse;
22493 break;
22495 case Lisp_Cons:
22497 register Lisp_Object car, tem;
22499 /* A cons cell: five distinct cases.
22500 If first element is :eval or :propertize, do something special.
22501 If first element is a string or a cons, process all the elements
22502 and effectively concatenate them.
22503 If first element is a negative number, truncate displaying cdr to
22504 at most that many characters. If positive, pad (with spaces)
22505 to at least that many characters.
22506 If first element is a symbol, process the cadr or caddr recursively
22507 according to whether the symbol's value is non-nil or nil. */
22508 car = XCAR (elt);
22509 if (EQ (car, QCeval))
22511 /* An element of the form (:eval FORM) means evaluate FORM
22512 and use the result as mode line elements. */
22514 if (risky)
22515 break;
22517 if (CONSP (XCDR (elt)))
22519 Lisp_Object spec;
22520 spec = safe__eval (true, XCAR (XCDR (elt)));
22521 n += display_mode_element (it, depth, field_width - n,
22522 precision - n, spec, props,
22523 risky);
22526 else if (EQ (car, QCpropertize))
22528 /* An element of the form (:propertize ELT PROPS...)
22529 means display ELT but applying properties PROPS. */
22531 if (risky)
22532 break;
22534 if (CONSP (XCDR (elt)))
22535 n += display_mode_element (it, depth, field_width - n,
22536 precision - n, XCAR (XCDR (elt)),
22537 XCDR (XCDR (elt)), risky);
22539 else if (SYMBOLP (car))
22541 tem = Fboundp (car);
22542 elt = XCDR (elt);
22543 if (!CONSP (elt))
22544 goto invalid;
22545 /* elt is now the cdr, and we know it is a cons cell.
22546 Use its car if CAR has a non-nil value. */
22547 if (!NILP (tem))
22549 tem = Fsymbol_value (car);
22550 if (!NILP (tem))
22552 elt = XCAR (elt);
22553 goto tail_recurse;
22556 /* Symbol's value is nil (or symbol is unbound)
22557 Get the cddr of the original list
22558 and if possible find the caddr and use that. */
22559 elt = XCDR (elt);
22560 if (NILP (elt))
22561 break;
22562 else if (!CONSP (elt))
22563 goto invalid;
22564 elt = XCAR (elt);
22565 goto tail_recurse;
22567 else if (INTEGERP (car))
22569 register int lim = XINT (car);
22570 elt = XCDR (elt);
22571 if (lim < 0)
22573 /* Negative int means reduce maximum width. */
22574 if (precision <= 0)
22575 precision = -lim;
22576 else
22577 precision = min (precision, -lim);
22579 else if (lim > 0)
22581 /* Padding specified. Don't let it be more than
22582 current maximum. */
22583 if (precision > 0)
22584 lim = min (precision, lim);
22586 /* If that's more padding than already wanted, queue it.
22587 But don't reduce padding already specified even if
22588 that is beyond the current truncation point. */
22589 field_width = max (lim, field_width);
22591 goto tail_recurse;
22593 else if (STRINGP (car) || CONSP (car))
22595 Lisp_Object halftail = elt;
22596 int len = 0;
22598 while (CONSP (elt)
22599 && (precision <= 0 || n < precision))
22601 n += display_mode_element (it, depth,
22602 /* Do padding only after the last
22603 element in the list. */
22604 (! CONSP (XCDR (elt))
22605 ? field_width - n
22606 : 0),
22607 precision - n, XCAR (elt),
22608 props, risky);
22609 elt = XCDR (elt);
22610 len++;
22611 if ((len & 1) == 0)
22612 halftail = XCDR (halftail);
22613 /* Check for cycle. */
22614 if (EQ (halftail, elt))
22615 break;
22619 break;
22621 default:
22622 invalid:
22623 elt = build_string ("*invalid*");
22624 goto tail_recurse;
22627 /* Pad to FIELD_WIDTH. */
22628 if (field_width > 0 && n < field_width)
22630 switch (mode_line_target)
22632 case MODE_LINE_NOPROP:
22633 case MODE_LINE_TITLE:
22634 n += store_mode_line_noprop ("", field_width - n, 0);
22635 break;
22636 case MODE_LINE_STRING:
22637 n += store_mode_line_string ("", Qnil, false, field_width - n, 0,
22638 Qnil);
22639 break;
22640 case MODE_LINE_DISPLAY:
22641 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22642 0, 0, 0);
22643 break;
22647 return n;
22650 /* Store a mode-line string element in mode_line_string_list.
22652 If STRING is non-null, display that C string. Otherwise, the Lisp
22653 string LISP_STRING is displayed.
22655 FIELD_WIDTH is the minimum number of output glyphs to produce.
22656 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22657 with spaces. FIELD_WIDTH <= 0 means don't pad.
22659 PRECISION is the maximum number of characters to output from
22660 STRING. PRECISION <= 0 means don't truncate the string.
22662 If COPY_STRING, make a copy of LISP_STRING before adding
22663 properties to the string.
22665 PROPS are the properties to add to the string.
22666 The mode_line_string_face face property is always added to the string.
22669 static int
22670 store_mode_line_string (const char *string, Lisp_Object lisp_string,
22671 bool copy_string,
22672 int field_width, int precision, Lisp_Object props)
22674 ptrdiff_t len;
22675 int n = 0;
22677 if (string != NULL)
22679 len = strlen (string);
22680 if (precision > 0 && len > precision)
22681 len = precision;
22682 lisp_string = make_string (string, len);
22683 if (NILP (props))
22684 props = mode_line_string_face_prop;
22685 else if (!NILP (mode_line_string_face))
22687 Lisp_Object face = Fplist_get (props, Qface);
22688 props = Fcopy_sequence (props);
22689 if (NILP (face))
22690 face = mode_line_string_face;
22691 else
22692 face = list2 (face, mode_line_string_face);
22693 props = Fplist_put (props, Qface, face);
22695 Fadd_text_properties (make_number (0), make_number (len),
22696 props, lisp_string);
22698 else
22700 len = XFASTINT (Flength (lisp_string));
22701 if (precision > 0 && len > precision)
22703 len = precision;
22704 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
22705 precision = -1;
22707 if (!NILP (mode_line_string_face))
22709 Lisp_Object face;
22710 if (NILP (props))
22711 props = Ftext_properties_at (make_number (0), lisp_string);
22712 face = Fplist_get (props, Qface);
22713 if (NILP (face))
22714 face = mode_line_string_face;
22715 else
22716 face = list2 (face, mode_line_string_face);
22717 props = list2 (Qface, face);
22718 if (copy_string)
22719 lisp_string = Fcopy_sequence (lisp_string);
22721 if (!NILP (props))
22722 Fadd_text_properties (make_number (0), make_number (len),
22723 props, lisp_string);
22726 if (len > 0)
22728 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22729 n += len;
22732 if (field_width > len)
22734 field_width -= len;
22735 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
22736 if (!NILP (props))
22737 Fadd_text_properties (make_number (0), make_number (field_width),
22738 props, lisp_string);
22739 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22740 n += field_width;
22743 return n;
22747 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
22748 1, 4, 0,
22749 doc: /* Format a string out of a mode line format specification.
22750 First arg FORMAT specifies the mode line format (see `mode-line-format'
22751 for details) to use.
22753 By default, the format is evaluated for the currently selected window.
22755 Optional second arg FACE specifies the face property to put on all
22756 characters for which no face is specified. The value nil means the
22757 default face. The value t means whatever face the window's mode line
22758 currently uses (either `mode-line' or `mode-line-inactive',
22759 depending on whether the window is the selected window or not).
22760 An integer value means the value string has no text
22761 properties.
22763 Optional third and fourth args WINDOW and BUFFER specify the window
22764 and buffer to use as the context for the formatting (defaults
22765 are the selected window and the WINDOW's buffer). */)
22766 (Lisp_Object format, Lisp_Object face,
22767 Lisp_Object window, Lisp_Object buffer)
22769 struct it it;
22770 int len;
22771 struct window *w;
22772 struct buffer *old_buffer = NULL;
22773 int face_id;
22774 bool no_props = INTEGERP (face);
22775 ptrdiff_t count = SPECPDL_INDEX ();
22776 Lisp_Object str;
22777 int string_start = 0;
22779 w = decode_any_window (window);
22780 XSETWINDOW (window, w);
22782 if (NILP (buffer))
22783 buffer = w->contents;
22784 CHECK_BUFFER (buffer);
22786 /* Make formatting the modeline a non-op when noninteractive, otherwise
22787 there will be problems later caused by a partially initialized frame. */
22788 if (NILP (format) || noninteractive)
22789 return empty_unibyte_string;
22791 if (no_props)
22792 face = Qnil;
22794 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
22795 : EQ (face, Qt) ? (EQ (window, selected_window)
22796 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
22797 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
22798 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
22799 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
22800 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
22801 : DEFAULT_FACE_ID;
22803 old_buffer = current_buffer;
22805 /* Save things including mode_line_proptrans_alist,
22806 and set that to nil so that we don't alter the outer value. */
22807 record_unwind_protect (unwind_format_mode_line,
22808 format_mode_line_unwind_data
22809 (XFRAME (WINDOW_FRAME (w)),
22810 old_buffer, selected_window, true));
22811 mode_line_proptrans_alist = Qnil;
22813 Fselect_window (window, Qt);
22814 set_buffer_internal_1 (XBUFFER (buffer));
22816 init_iterator (&it, w, -1, -1, NULL, face_id);
22818 if (no_props)
22820 mode_line_target = MODE_LINE_NOPROP;
22821 mode_line_string_face_prop = Qnil;
22822 mode_line_string_list = Qnil;
22823 string_start = MODE_LINE_NOPROP_LEN (0);
22825 else
22827 mode_line_target = MODE_LINE_STRING;
22828 mode_line_string_list = Qnil;
22829 mode_line_string_face = face;
22830 mode_line_string_face_prop
22831 = NILP (face) ? Qnil : list2 (Qface, face);
22834 push_kboard (FRAME_KBOARD (it.f));
22835 display_mode_element (&it, 0, 0, 0, format, Qnil, false);
22836 pop_kboard ();
22838 if (no_props)
22840 len = MODE_LINE_NOPROP_LEN (string_start);
22841 str = make_string (mode_line_noprop_buf + string_start, len);
22843 else
22845 mode_line_string_list = Fnreverse (mode_line_string_list);
22846 str = Fmapconcat (Qidentity, mode_line_string_list,
22847 empty_unibyte_string);
22850 unbind_to (count, Qnil);
22851 return str;
22854 /* Write a null-terminated, right justified decimal representation of
22855 the positive integer D to BUF using a minimal field width WIDTH. */
22857 static void
22858 pint2str (register char *buf, register int width, register ptrdiff_t d)
22860 register char *p = buf;
22862 if (d <= 0)
22863 *p++ = '0';
22864 else
22866 while (d > 0)
22868 *p++ = d % 10 + '0';
22869 d /= 10;
22873 for (width -= (int) (p - buf); width > 0; --width)
22874 *p++ = ' ';
22875 *p-- = '\0';
22876 while (p > buf)
22878 d = *buf;
22879 *buf++ = *p;
22880 *p-- = d;
22884 /* Write a null-terminated, right justified decimal and "human
22885 readable" representation of the nonnegative integer D to BUF using
22886 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22888 static const char power_letter[] =
22890 0, /* no letter */
22891 'k', /* kilo */
22892 'M', /* mega */
22893 'G', /* giga */
22894 'T', /* tera */
22895 'P', /* peta */
22896 'E', /* exa */
22897 'Z', /* zetta */
22898 'Y' /* yotta */
22901 static void
22902 pint2hrstr (char *buf, int width, ptrdiff_t d)
22904 /* We aim to represent the nonnegative integer D as
22905 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22906 ptrdiff_t quotient = d;
22907 int remainder = 0;
22908 /* -1 means: do not use TENTHS. */
22909 int tenths = -1;
22910 int exponent = 0;
22912 /* Length of QUOTIENT.TENTHS as a string. */
22913 int length;
22915 char * psuffix;
22916 char * p;
22918 if (quotient >= 1000)
22920 /* Scale to the appropriate EXPONENT. */
22923 remainder = quotient % 1000;
22924 quotient /= 1000;
22925 exponent++;
22927 while (quotient >= 1000);
22929 /* Round to nearest and decide whether to use TENTHS or not. */
22930 if (quotient <= 9)
22932 tenths = remainder / 100;
22933 if (remainder % 100 >= 50)
22935 if (tenths < 9)
22936 tenths++;
22937 else
22939 quotient++;
22940 if (quotient == 10)
22941 tenths = -1;
22942 else
22943 tenths = 0;
22947 else
22948 if (remainder >= 500)
22950 if (quotient < 999)
22951 quotient++;
22952 else
22954 quotient = 1;
22955 exponent++;
22956 tenths = 0;
22961 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22962 if (tenths == -1 && quotient <= 99)
22963 if (quotient <= 9)
22964 length = 1;
22965 else
22966 length = 2;
22967 else
22968 length = 3;
22969 p = psuffix = buf + max (width, length);
22971 /* Print EXPONENT. */
22972 *psuffix++ = power_letter[exponent];
22973 *psuffix = '\0';
22975 /* Print TENTHS. */
22976 if (tenths >= 0)
22978 *--p = '0' + tenths;
22979 *--p = '.';
22982 /* Print QUOTIENT. */
22985 int digit = quotient % 10;
22986 *--p = '0' + digit;
22988 while ((quotient /= 10) != 0);
22990 /* Print leading spaces. */
22991 while (buf < p)
22992 *--p = ' ';
22995 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22996 If EOL_FLAG, set also a mnemonic character for end-of-line
22997 type of CODING_SYSTEM. Return updated pointer into BUF. */
22999 static unsigned char invalid_eol_type[] = "(*invalid*)";
23001 static char *
23002 decode_mode_spec_coding (Lisp_Object coding_system, char *buf, bool eol_flag)
23004 Lisp_Object val;
23005 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
23006 const unsigned char *eol_str;
23007 int eol_str_len;
23008 /* The EOL conversion we are using. */
23009 Lisp_Object eoltype;
23011 val = CODING_SYSTEM_SPEC (coding_system);
23012 eoltype = Qnil;
23014 if (!VECTORP (val)) /* Not yet decided. */
23016 *buf++ = multibyte ? '-' : ' ';
23017 if (eol_flag)
23018 eoltype = eol_mnemonic_undecided;
23019 /* Don't mention EOL conversion if it isn't decided. */
23021 else
23023 Lisp_Object attrs;
23024 Lisp_Object eolvalue;
23026 attrs = AREF (val, 0);
23027 eolvalue = AREF (val, 2);
23029 *buf++ = multibyte
23030 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
23031 : ' ';
23033 if (eol_flag)
23035 /* The EOL conversion that is normal on this system. */
23037 if (NILP (eolvalue)) /* Not yet decided. */
23038 eoltype = eol_mnemonic_undecided;
23039 else if (VECTORP (eolvalue)) /* Not yet decided. */
23040 eoltype = eol_mnemonic_undecided;
23041 else /* eolvalue is Qunix, Qdos, or Qmac. */
23042 eoltype = (EQ (eolvalue, Qunix)
23043 ? eol_mnemonic_unix
23044 : EQ (eolvalue, Qdos)
23045 ? eol_mnemonic_dos : eol_mnemonic_mac);
23049 if (eol_flag)
23051 /* Mention the EOL conversion if it is not the usual one. */
23052 if (STRINGP (eoltype))
23054 eol_str = SDATA (eoltype);
23055 eol_str_len = SBYTES (eoltype);
23057 else if (CHARACTERP (eoltype))
23059 int c = XFASTINT (eoltype);
23060 return buf + CHAR_STRING (c, (unsigned char *) buf);
23062 else
23064 eol_str = invalid_eol_type;
23065 eol_str_len = sizeof (invalid_eol_type) - 1;
23067 memcpy (buf, eol_str, eol_str_len);
23068 buf += eol_str_len;
23071 return buf;
23074 /* Return a string for the output of a mode line %-spec for window W,
23075 generated by character C. FIELD_WIDTH > 0 means pad the string
23076 returned with spaces to that value. Return a Lisp string in
23077 *STRING if the resulting string is taken from that Lisp string.
23079 Note we operate on the current buffer for most purposes. */
23081 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23083 static const char *
23084 decode_mode_spec (struct window *w, register int c, int field_width,
23085 Lisp_Object *string)
23087 Lisp_Object obj;
23088 struct frame *f = XFRAME (WINDOW_FRAME (w));
23089 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
23090 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23091 produce strings from numerical values, so limit preposterously
23092 large values of FIELD_WIDTH to avoid overrunning the buffer's
23093 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23094 bytes plus the terminating null. */
23095 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
23096 struct buffer *b = current_buffer;
23098 obj = Qnil;
23099 *string = Qnil;
23101 switch (c)
23103 case '*':
23104 if (!NILP (BVAR (b, read_only)))
23105 return "%";
23106 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23107 return "*";
23108 return "-";
23110 case '+':
23111 /* This differs from %* only for a modified read-only buffer. */
23112 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23113 return "*";
23114 if (!NILP (BVAR (b, read_only)))
23115 return "%";
23116 return "-";
23118 case '&':
23119 /* This differs from %* in ignoring read-only-ness. */
23120 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23121 return "*";
23122 return "-";
23124 case '%':
23125 return "%";
23127 case '[':
23129 int i;
23130 char *p;
23132 if (command_loop_level > 5)
23133 return "[[[... ";
23134 p = decode_mode_spec_buf;
23135 for (i = 0; i < command_loop_level; i++)
23136 *p++ = '[';
23137 *p = 0;
23138 return decode_mode_spec_buf;
23141 case ']':
23143 int i;
23144 char *p;
23146 if (command_loop_level > 5)
23147 return " ...]]]";
23148 p = decode_mode_spec_buf;
23149 for (i = 0; i < command_loop_level; i++)
23150 *p++ = ']';
23151 *p = 0;
23152 return decode_mode_spec_buf;
23155 case '-':
23157 register int i;
23159 /* Let lots_of_dashes be a string of infinite length. */
23160 if (mode_line_target == MODE_LINE_NOPROP
23161 || mode_line_target == MODE_LINE_STRING)
23162 return "--";
23163 if (field_width <= 0
23164 || field_width > sizeof (lots_of_dashes))
23166 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
23167 decode_mode_spec_buf[i] = '-';
23168 decode_mode_spec_buf[i] = '\0';
23169 return decode_mode_spec_buf;
23171 else
23172 return lots_of_dashes;
23175 case 'b':
23176 obj = BVAR (b, name);
23177 break;
23179 case 'c':
23180 /* %c and %l are ignored in `frame-title-format'.
23181 (In redisplay_internal, the frame title is drawn _before_ the
23182 windows are updated, so the stuff which depends on actual
23183 window contents (such as %l) may fail to render properly, or
23184 even crash emacs.) */
23185 if (mode_line_target == MODE_LINE_TITLE)
23186 return "";
23187 else
23189 ptrdiff_t col = current_column ();
23190 w->column_number_displayed = col;
23191 pint2str (decode_mode_spec_buf, width, col);
23192 return decode_mode_spec_buf;
23195 case 'e':
23196 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23198 if (NILP (Vmemory_full))
23199 return "";
23200 else
23201 return "!MEM FULL! ";
23203 #else
23204 return "";
23205 #endif
23207 case 'F':
23208 /* %F displays the frame name. */
23209 if (!NILP (f->title))
23210 return SSDATA (f->title);
23211 if (f->explicit_name || ! FRAME_WINDOW_P (f))
23212 return SSDATA (f->name);
23213 return "Emacs";
23215 case 'f':
23216 obj = BVAR (b, filename);
23217 break;
23219 case 'i':
23221 ptrdiff_t size = ZV - BEGV;
23222 pint2str (decode_mode_spec_buf, width, size);
23223 return decode_mode_spec_buf;
23226 case 'I':
23228 ptrdiff_t size = ZV - BEGV;
23229 pint2hrstr (decode_mode_spec_buf, width, size);
23230 return decode_mode_spec_buf;
23233 case 'l':
23235 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
23236 ptrdiff_t topline, nlines, height;
23237 ptrdiff_t junk;
23239 /* %c and %l are ignored in `frame-title-format'. */
23240 if (mode_line_target == MODE_LINE_TITLE)
23241 return "";
23243 startpos = marker_position (w->start);
23244 startpos_byte = marker_byte_position (w->start);
23245 height = WINDOW_TOTAL_LINES (w);
23247 /* If we decided that this buffer isn't suitable for line numbers,
23248 don't forget that too fast. */
23249 if (w->base_line_pos == -1)
23250 goto no_value;
23252 /* If the buffer is very big, don't waste time. */
23253 if (INTEGERP (Vline_number_display_limit)
23254 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
23256 w->base_line_pos = 0;
23257 w->base_line_number = 0;
23258 goto no_value;
23261 if (w->base_line_number > 0
23262 && w->base_line_pos > 0
23263 && w->base_line_pos <= startpos)
23265 line = w->base_line_number;
23266 linepos = w->base_line_pos;
23267 linepos_byte = buf_charpos_to_bytepos (b, linepos);
23269 else
23271 line = 1;
23272 linepos = BUF_BEGV (b);
23273 linepos_byte = BUF_BEGV_BYTE (b);
23276 /* Count lines from base line to window start position. */
23277 nlines = display_count_lines (linepos_byte,
23278 startpos_byte,
23279 startpos, &junk);
23281 topline = nlines + line;
23283 /* Determine a new base line, if the old one is too close
23284 or too far away, or if we did not have one.
23285 "Too close" means it's plausible a scroll-down would
23286 go back past it. */
23287 if (startpos == BUF_BEGV (b))
23289 w->base_line_number = topline;
23290 w->base_line_pos = BUF_BEGV (b);
23292 else if (nlines < height + 25 || nlines > height * 3 + 50
23293 || linepos == BUF_BEGV (b))
23295 ptrdiff_t limit = BUF_BEGV (b);
23296 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
23297 ptrdiff_t position;
23298 ptrdiff_t distance =
23299 (height * 2 + 30) * line_number_display_limit_width;
23301 if (startpos - distance > limit)
23303 limit = startpos - distance;
23304 limit_byte = CHAR_TO_BYTE (limit);
23307 nlines = display_count_lines (startpos_byte,
23308 limit_byte,
23309 - (height * 2 + 30),
23310 &position);
23311 /* If we couldn't find the lines we wanted within
23312 line_number_display_limit_width chars per line,
23313 give up on line numbers for this window. */
23314 if (position == limit_byte && limit == startpos - distance)
23316 w->base_line_pos = -1;
23317 w->base_line_number = 0;
23318 goto no_value;
23321 w->base_line_number = topline - nlines;
23322 w->base_line_pos = BYTE_TO_CHAR (position);
23325 /* Now count lines from the start pos to point. */
23326 nlines = display_count_lines (startpos_byte,
23327 PT_BYTE, PT, &junk);
23329 /* Record that we did display the line number. */
23330 line_number_displayed = true;
23332 /* Make the string to show. */
23333 pint2str (decode_mode_spec_buf, width, topline + nlines);
23334 return decode_mode_spec_buf;
23335 no_value:
23337 char *p = decode_mode_spec_buf;
23338 int pad = width - 2;
23339 while (pad-- > 0)
23340 *p++ = ' ';
23341 *p++ = '?';
23342 *p++ = '?';
23343 *p = '\0';
23344 return decode_mode_spec_buf;
23347 break;
23349 case 'm':
23350 obj = BVAR (b, mode_name);
23351 break;
23353 case 'n':
23354 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
23355 return " Narrow";
23356 break;
23358 case 'p':
23360 ptrdiff_t pos = marker_position (w->start);
23361 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23363 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
23365 if (pos <= BUF_BEGV (b))
23366 return "All";
23367 else
23368 return "Bottom";
23370 else if (pos <= BUF_BEGV (b))
23371 return "Top";
23372 else
23374 if (total > 1000000)
23375 /* Do it differently for a large value, to avoid overflow. */
23376 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23377 else
23378 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
23379 /* We can't normally display a 3-digit number,
23380 so get us a 2-digit number that is close. */
23381 if (total == 100)
23382 total = 99;
23383 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23384 return decode_mode_spec_buf;
23388 /* Display percentage of size above the bottom of the screen. */
23389 case 'P':
23391 ptrdiff_t toppos = marker_position (w->start);
23392 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
23393 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23395 if (botpos >= BUF_ZV (b))
23397 if (toppos <= BUF_BEGV (b))
23398 return "All";
23399 else
23400 return "Bottom";
23402 else
23404 if (total > 1000000)
23405 /* Do it differently for a large value, to avoid overflow. */
23406 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23407 else
23408 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
23409 /* We can't normally display a 3-digit number,
23410 so get us a 2-digit number that is close. */
23411 if (total == 100)
23412 total = 99;
23413 if (toppos <= BUF_BEGV (b))
23414 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
23415 else
23416 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23417 return decode_mode_spec_buf;
23421 case 's':
23422 /* status of process */
23423 obj = Fget_buffer_process (Fcurrent_buffer ());
23424 if (NILP (obj))
23425 return "no process";
23426 #ifndef MSDOS
23427 obj = Fsymbol_name (Fprocess_status (obj));
23428 #endif
23429 break;
23431 case '@':
23433 ptrdiff_t count = inhibit_garbage_collection ();
23434 Lisp_Object curdir = BVAR (current_buffer, directory);
23435 Lisp_Object val = Qnil;
23437 if (STRINGP (curdir))
23438 val = call1 (intern ("file-remote-p"), curdir);
23440 unbind_to (count, Qnil);
23442 if (NILP (val))
23443 return "-";
23444 else
23445 return "@";
23448 case 'z':
23449 /* coding-system (not including end-of-line format) */
23450 case 'Z':
23451 /* coding-system (including end-of-line type) */
23453 bool eol_flag = (c == 'Z');
23454 char *p = decode_mode_spec_buf;
23456 if (! FRAME_WINDOW_P (f))
23458 /* No need to mention EOL here--the terminal never needs
23459 to do EOL conversion. */
23460 p = decode_mode_spec_coding (CODING_ID_NAME
23461 (FRAME_KEYBOARD_CODING (f)->id),
23462 p, false);
23463 p = decode_mode_spec_coding (CODING_ID_NAME
23464 (FRAME_TERMINAL_CODING (f)->id),
23465 p, false);
23467 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
23468 p, eol_flag);
23470 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23471 #ifdef subprocesses
23472 obj = Fget_buffer_process (Fcurrent_buffer ());
23473 if (PROCESSP (obj))
23475 p = decode_mode_spec_coding
23476 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
23477 p = decode_mode_spec_coding
23478 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
23480 #endif /* subprocesses */
23481 #endif /* false */
23482 *p = 0;
23483 return decode_mode_spec_buf;
23487 if (STRINGP (obj))
23489 *string = obj;
23490 return SSDATA (obj);
23492 else
23493 return "";
23497 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23498 means count lines back from START_BYTE. But don't go beyond
23499 LIMIT_BYTE. Return the number of lines thus found (always
23500 nonnegative).
23502 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23503 either the position COUNT lines after/before START_BYTE, if we
23504 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23505 COUNT lines. */
23507 static ptrdiff_t
23508 display_count_lines (ptrdiff_t start_byte,
23509 ptrdiff_t limit_byte, ptrdiff_t count,
23510 ptrdiff_t *byte_pos_ptr)
23512 register unsigned char *cursor;
23513 unsigned char *base;
23515 register ptrdiff_t ceiling;
23516 register unsigned char *ceiling_addr;
23517 ptrdiff_t orig_count = count;
23519 /* If we are not in selective display mode,
23520 check only for newlines. */
23521 bool selective_display
23522 = (!NILP (BVAR (current_buffer, selective_display))
23523 && !INTEGERP (BVAR (current_buffer, selective_display)));
23525 if (count > 0)
23527 while (start_byte < limit_byte)
23529 ceiling = BUFFER_CEILING_OF (start_byte);
23530 ceiling = min (limit_byte - 1, ceiling);
23531 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
23532 base = (cursor = BYTE_POS_ADDR (start_byte));
23536 if (selective_display)
23538 while (*cursor != '\n' && *cursor != 015
23539 && ++cursor != ceiling_addr)
23540 continue;
23541 if (cursor == ceiling_addr)
23542 break;
23544 else
23546 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
23547 if (! cursor)
23548 break;
23551 cursor++;
23553 if (--count == 0)
23555 start_byte += cursor - base;
23556 *byte_pos_ptr = start_byte;
23557 return orig_count;
23560 while (cursor < ceiling_addr);
23562 start_byte += ceiling_addr - base;
23565 else
23567 while (start_byte > limit_byte)
23569 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
23570 ceiling = max (limit_byte, ceiling);
23571 ceiling_addr = BYTE_POS_ADDR (ceiling);
23572 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
23573 while (true)
23575 if (selective_display)
23577 while (--cursor >= ceiling_addr
23578 && *cursor != '\n' && *cursor != 015)
23579 continue;
23580 if (cursor < ceiling_addr)
23581 break;
23583 else
23585 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
23586 if (! cursor)
23587 break;
23590 if (++count == 0)
23592 start_byte += cursor - base + 1;
23593 *byte_pos_ptr = start_byte;
23594 /* When scanning backwards, we should
23595 not count the newline posterior to which we stop. */
23596 return - orig_count - 1;
23599 start_byte += ceiling_addr - base;
23603 *byte_pos_ptr = limit_byte;
23605 if (count < 0)
23606 return - orig_count + count;
23607 return orig_count - count;
23613 /***********************************************************************
23614 Displaying strings
23615 ***********************************************************************/
23617 /* Display a NUL-terminated string, starting with index START.
23619 If STRING is non-null, display that C string. Otherwise, the Lisp
23620 string LISP_STRING is displayed. There's a case that STRING is
23621 non-null and LISP_STRING is not nil. It means STRING is a string
23622 data of LISP_STRING. In that case, we display LISP_STRING while
23623 ignoring its text properties.
23625 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23626 FACE_STRING. Display STRING or LISP_STRING with the face at
23627 FACE_STRING_POS in FACE_STRING:
23629 Display the string in the environment given by IT, but use the
23630 standard display table, temporarily.
23632 FIELD_WIDTH is the minimum number of output glyphs to produce.
23633 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23634 with spaces. If STRING has more characters, more than FIELD_WIDTH
23635 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23637 PRECISION is the maximum number of characters to output from
23638 STRING. PRECISION < 0 means don't truncate the string.
23640 This is roughly equivalent to printf format specifiers:
23642 FIELD_WIDTH PRECISION PRINTF
23643 ----------------------------------------
23644 -1 -1 %s
23645 -1 10 %.10s
23646 10 -1 %10s
23647 20 10 %20.10s
23649 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23650 display them, and < 0 means obey the current buffer's value of
23651 enable_multibyte_characters.
23653 Value is the number of columns displayed. */
23655 static int
23656 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23657 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23658 int field_width, int precision, int max_x, int multibyte)
23660 int hpos_at_start = it->hpos;
23661 int saved_face_id = it->face_id;
23662 struct glyph_row *row = it->glyph_row;
23663 ptrdiff_t it_charpos;
23665 /* Initialize the iterator IT for iteration over STRING beginning
23666 with index START. */
23667 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23668 precision, field_width, multibyte);
23669 if (string && STRINGP (lisp_string))
23670 /* LISP_STRING is the one returned by decode_mode_spec. We should
23671 ignore its text properties. */
23672 it->stop_charpos = it->end_charpos;
23674 /* If displaying STRING, set up the face of the iterator from
23675 FACE_STRING, if that's given. */
23676 if (STRINGP (face_string))
23678 ptrdiff_t endptr;
23679 struct face *face;
23681 it->face_id
23682 = face_at_string_position (it->w, face_string, face_string_pos,
23683 0, &endptr, it->base_face_id, false);
23684 face = FACE_FROM_ID (it->f, it->face_id);
23685 it->face_box_p = face->box != FACE_NO_BOX;
23688 /* Set max_x to the maximum allowed X position. Don't let it go
23689 beyond the right edge of the window. */
23690 if (max_x <= 0)
23691 max_x = it->last_visible_x;
23692 else
23693 max_x = min (max_x, it->last_visible_x);
23695 /* Skip over display elements that are not visible. because IT->w is
23696 hscrolled. */
23697 if (it->current_x < it->first_visible_x)
23698 move_it_in_display_line_to (it, 100000, it->first_visible_x,
23699 MOVE_TO_POS | MOVE_TO_X);
23701 row->ascent = it->max_ascent;
23702 row->height = it->max_ascent + it->max_descent;
23703 row->phys_ascent = it->max_phys_ascent;
23704 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
23705 row->extra_line_spacing = it->max_extra_line_spacing;
23707 if (STRINGP (it->string))
23708 it_charpos = IT_STRING_CHARPOS (*it);
23709 else
23710 it_charpos = IT_CHARPOS (*it);
23712 /* This condition is for the case that we are called with current_x
23713 past last_visible_x. */
23714 while (it->current_x < max_x)
23716 int x_before, x, n_glyphs_before, i, nglyphs;
23718 /* Get the next display element. */
23719 if (!get_next_display_element (it))
23720 break;
23722 /* Produce glyphs. */
23723 x_before = it->current_x;
23724 n_glyphs_before = row->used[TEXT_AREA];
23725 PRODUCE_GLYPHS (it);
23727 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
23728 i = 0;
23729 x = x_before;
23730 while (i < nglyphs)
23732 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
23734 if (it->line_wrap != TRUNCATE
23735 && x + glyph->pixel_width > max_x)
23737 /* End of continued line or max_x reached. */
23738 if (CHAR_GLYPH_PADDING_P (*glyph))
23740 /* A wide character is unbreakable. */
23741 if (row->reversed_p)
23742 unproduce_glyphs (it, row->used[TEXT_AREA]
23743 - n_glyphs_before);
23744 row->used[TEXT_AREA] = n_glyphs_before;
23745 it->current_x = x_before;
23747 else
23749 if (row->reversed_p)
23750 unproduce_glyphs (it, row->used[TEXT_AREA]
23751 - (n_glyphs_before + i));
23752 row->used[TEXT_AREA] = n_glyphs_before + i;
23753 it->current_x = x;
23755 break;
23757 else if (x + glyph->pixel_width >= it->first_visible_x)
23759 /* Glyph is at least partially visible. */
23760 ++it->hpos;
23761 if (x < it->first_visible_x)
23762 row->x = x - it->first_visible_x;
23764 else
23766 /* Glyph is off the left margin of the display area.
23767 Should not happen. */
23768 emacs_abort ();
23771 row->ascent = max (row->ascent, it->max_ascent);
23772 row->height = max (row->height, it->max_ascent + it->max_descent);
23773 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
23774 row->phys_height = max (row->phys_height,
23775 it->max_phys_ascent + it->max_phys_descent);
23776 row->extra_line_spacing = max (row->extra_line_spacing,
23777 it->max_extra_line_spacing);
23778 x += glyph->pixel_width;
23779 ++i;
23782 /* Stop if max_x reached. */
23783 if (i < nglyphs)
23784 break;
23786 /* Stop at line ends. */
23787 if (ITERATOR_AT_END_OF_LINE_P (it))
23789 it->continuation_lines_width = 0;
23790 break;
23793 set_iterator_to_next (it, true);
23794 if (STRINGP (it->string))
23795 it_charpos = IT_STRING_CHARPOS (*it);
23796 else
23797 it_charpos = IT_CHARPOS (*it);
23799 /* Stop if truncating at the right edge. */
23800 if (it->line_wrap == TRUNCATE
23801 && it->current_x >= it->last_visible_x)
23803 /* Add truncation mark, but don't do it if the line is
23804 truncated at a padding space. */
23805 if (it_charpos < it->string_nchars)
23807 if (!FRAME_WINDOW_P (it->f))
23809 int ii, n;
23811 if (it->current_x > it->last_visible_x)
23813 if (!row->reversed_p)
23815 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
23816 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23817 break;
23819 else
23821 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
23822 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23823 break;
23824 unproduce_glyphs (it, ii + 1);
23825 ii = row->used[TEXT_AREA] - (ii + 1);
23827 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
23829 row->used[TEXT_AREA] = ii;
23830 produce_special_glyphs (it, IT_TRUNCATION);
23833 produce_special_glyphs (it, IT_TRUNCATION);
23835 row->truncated_on_right_p = true;
23837 break;
23841 /* Maybe insert a truncation at the left. */
23842 if (it->first_visible_x
23843 && it_charpos > 0)
23845 if (!FRAME_WINDOW_P (it->f)
23846 || (row->reversed_p
23847 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23848 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
23849 insert_left_trunc_glyphs (it);
23850 row->truncated_on_left_p = true;
23853 it->face_id = saved_face_id;
23855 /* Value is number of columns displayed. */
23856 return it->hpos - hpos_at_start;
23861 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23862 appears as an element of LIST or as the car of an element of LIST.
23863 If PROPVAL is a list, compare each element against LIST in that
23864 way, and return 1/2 if any element of PROPVAL is found in LIST.
23865 Otherwise return 0. This function cannot quit.
23866 The return value is 2 if the text is invisible but with an ellipsis
23867 and 1 if it's invisible and without an ellipsis. */
23870 invisible_prop (Lisp_Object propval, Lisp_Object list)
23872 Lisp_Object tail, proptail;
23874 for (tail = list; CONSP (tail); tail = XCDR (tail))
23876 register Lisp_Object tem;
23877 tem = XCAR (tail);
23878 if (EQ (propval, tem))
23879 return 1;
23880 if (CONSP (tem) && EQ (propval, XCAR (tem)))
23881 return NILP (XCDR (tem)) ? 1 : 2;
23884 if (CONSP (propval))
23886 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
23888 Lisp_Object propelt;
23889 propelt = XCAR (proptail);
23890 for (tail = list; CONSP (tail); tail = XCDR (tail))
23892 register Lisp_Object tem;
23893 tem = XCAR (tail);
23894 if (EQ (propelt, tem))
23895 return 1;
23896 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
23897 return NILP (XCDR (tem)) ? 1 : 2;
23902 return 0;
23905 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
23906 doc: /* Non-nil if the property makes the text invisible.
23907 POS-OR-PROP can be a marker or number, in which case it is taken to be
23908 a position in the current buffer and the value of the `invisible' property
23909 is checked; or it can be some other value, which is then presumed to be the
23910 value of the `invisible' property of the text of interest.
23911 The non-nil value returned can be t for truly invisible text or something
23912 else if the text is replaced by an ellipsis. */)
23913 (Lisp_Object pos_or_prop)
23915 Lisp_Object prop
23916 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
23917 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
23918 : pos_or_prop);
23919 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
23920 return (invis == 0 ? Qnil
23921 : invis == 1 ? Qt
23922 : make_number (invis));
23925 /* Calculate a width or height in pixels from a specification using
23926 the following elements:
23928 SPEC ::=
23929 NUM - a (fractional) multiple of the default font width/height
23930 (NUM) - specifies exactly NUM pixels
23931 UNIT - a fixed number of pixels, see below.
23932 ELEMENT - size of a display element in pixels, see below.
23933 (NUM . SPEC) - equals NUM * SPEC
23934 (+ SPEC SPEC ...) - add pixel values
23935 (- SPEC SPEC ...) - subtract pixel values
23936 (- SPEC) - negate pixel value
23938 NUM ::=
23939 INT or FLOAT - a number constant
23940 SYMBOL - use symbol's (buffer local) variable binding.
23942 UNIT ::=
23943 in - pixels per inch *)
23944 mm - pixels per 1/1000 meter *)
23945 cm - pixels per 1/100 meter *)
23946 width - width of current font in pixels.
23947 height - height of current font in pixels.
23949 *) using the ratio(s) defined in display-pixels-per-inch.
23951 ELEMENT ::=
23953 left-fringe - left fringe width in pixels
23954 right-fringe - right fringe width in pixels
23956 left-margin - left margin width in pixels
23957 right-margin - right margin width in pixels
23959 scroll-bar - scroll-bar area width in pixels
23961 Examples:
23963 Pixels corresponding to 5 inches:
23964 (5 . in)
23966 Total width of non-text areas on left side of window (if scroll-bar is on left):
23967 '(space :width (+ left-fringe left-margin scroll-bar))
23969 Align to first text column (in header line):
23970 '(space :align-to 0)
23972 Align to middle of text area minus half the width of variable `my-image'
23973 containing a loaded image:
23974 '(space :align-to (0.5 . (- text my-image)))
23976 Width of left margin minus width of 1 character in the default font:
23977 '(space :width (- left-margin 1))
23979 Width of left margin minus width of 2 characters in the current font:
23980 '(space :width (- left-margin (2 . width)))
23982 Center 1 character over left-margin (in header line):
23983 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23985 Different ways to express width of left fringe plus left margin minus one pixel:
23986 '(space :width (- (+ left-fringe left-margin) (1)))
23987 '(space :width (+ left-fringe left-margin (- (1))))
23988 '(space :width (+ left-fringe left-margin (-1)))
23992 static bool
23993 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
23994 struct font *font, bool width_p, int *align_to)
23996 double pixels;
23998 # define OK_PIXELS(val) (*res = (val), true)
23999 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24001 if (NILP (prop))
24002 return OK_PIXELS (0);
24004 eassert (FRAME_LIVE_P (it->f));
24006 if (SYMBOLP (prop))
24008 if (SCHARS (SYMBOL_NAME (prop)) == 2)
24010 char *unit = SSDATA (SYMBOL_NAME (prop));
24012 if (unit[0] == 'i' && unit[1] == 'n')
24013 pixels = 1.0;
24014 else if (unit[0] == 'm' && unit[1] == 'm')
24015 pixels = 25.4;
24016 else if (unit[0] == 'c' && unit[1] == 'm')
24017 pixels = 2.54;
24018 else
24019 pixels = 0;
24020 if (pixels > 0)
24022 double ppi = (width_p ? FRAME_RES_X (it->f)
24023 : FRAME_RES_Y (it->f));
24025 if (ppi > 0)
24026 return OK_PIXELS (ppi / pixels);
24027 return false;
24031 #ifdef HAVE_WINDOW_SYSTEM
24032 if (EQ (prop, Qheight))
24033 return OK_PIXELS (font
24034 ? normal_char_height (font, -1)
24035 : FRAME_LINE_HEIGHT (it->f));
24036 if (EQ (prop, Qwidth))
24037 return OK_PIXELS (font
24038 ? FONT_WIDTH (font)
24039 : FRAME_COLUMN_WIDTH (it->f));
24040 #else
24041 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
24042 return OK_PIXELS (1);
24043 #endif
24045 if (EQ (prop, Qtext))
24046 return OK_PIXELS (width_p
24047 ? window_box_width (it->w, TEXT_AREA)
24048 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
24050 if (align_to && *align_to < 0)
24052 *res = 0;
24053 if (EQ (prop, Qleft))
24054 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
24055 if (EQ (prop, Qright))
24056 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
24057 if (EQ (prop, Qcenter))
24058 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
24059 + window_box_width (it->w, TEXT_AREA) / 2);
24060 if (EQ (prop, Qleft_fringe))
24061 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24062 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
24063 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
24064 if (EQ (prop, Qright_fringe))
24065 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24066 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
24067 : window_box_right_offset (it->w, TEXT_AREA));
24068 if (EQ (prop, Qleft_margin))
24069 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
24070 if (EQ (prop, Qright_margin))
24071 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
24072 if (EQ (prop, Qscroll_bar))
24073 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
24075 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
24076 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24077 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
24078 : 0)));
24080 else
24082 if (EQ (prop, Qleft_fringe))
24083 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
24084 if (EQ (prop, Qright_fringe))
24085 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
24086 if (EQ (prop, Qleft_margin))
24087 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
24088 if (EQ (prop, Qright_margin))
24089 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
24090 if (EQ (prop, Qscroll_bar))
24091 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
24094 prop = buffer_local_value (prop, it->w->contents);
24095 if (EQ (prop, Qunbound))
24096 prop = Qnil;
24099 if (INTEGERP (prop) || FLOATP (prop))
24101 int base_unit = (width_p
24102 ? FRAME_COLUMN_WIDTH (it->f)
24103 : FRAME_LINE_HEIGHT (it->f));
24104 return OK_PIXELS (XFLOATINT (prop) * base_unit);
24107 if (CONSP (prop))
24109 Lisp_Object car = XCAR (prop);
24110 Lisp_Object cdr = XCDR (prop);
24112 if (SYMBOLP (car))
24114 #ifdef HAVE_WINDOW_SYSTEM
24115 if (FRAME_WINDOW_P (it->f)
24116 && valid_image_p (prop))
24118 ptrdiff_t id = lookup_image (it->f, prop);
24119 struct image *img = IMAGE_FROM_ID (it->f, id);
24121 return OK_PIXELS (width_p ? img->width : img->height);
24123 #endif
24124 if (EQ (car, Qplus) || EQ (car, Qminus))
24126 bool first = true;
24127 double px;
24129 pixels = 0;
24130 while (CONSP (cdr))
24132 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
24133 font, width_p, align_to))
24134 return false;
24135 if (first)
24136 pixels = (EQ (car, Qplus) ? px : -px), first = false;
24137 else
24138 pixels += px;
24139 cdr = XCDR (cdr);
24141 if (EQ (car, Qminus))
24142 pixels = -pixels;
24143 return OK_PIXELS (pixels);
24146 car = buffer_local_value (car, it->w->contents);
24147 if (EQ (car, Qunbound))
24148 car = Qnil;
24151 if (INTEGERP (car) || FLOATP (car))
24153 double fact;
24154 pixels = XFLOATINT (car);
24155 if (NILP (cdr))
24156 return OK_PIXELS (pixels);
24157 if (calc_pixel_width_or_height (&fact, it, cdr,
24158 font, width_p, align_to))
24159 return OK_PIXELS (pixels * fact);
24160 return false;
24163 return false;
24166 return false;
24169 void
24170 get_font_ascent_descent (struct font *font, int *ascent, int *descent)
24172 #ifdef HAVE_WINDOW_SYSTEM
24173 normal_char_ascent_descent (font, -1, ascent, descent);
24174 #else
24175 *ascent = 1;
24176 *descent = 0;
24177 #endif
24181 /***********************************************************************
24182 Glyph Display
24183 ***********************************************************************/
24185 #ifdef HAVE_WINDOW_SYSTEM
24187 #ifdef GLYPH_DEBUG
24189 void
24190 dump_glyph_string (struct glyph_string *s)
24192 fprintf (stderr, "glyph string\n");
24193 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
24194 s->x, s->y, s->width, s->height);
24195 fprintf (stderr, " ybase = %d\n", s->ybase);
24196 fprintf (stderr, " hl = %d\n", s->hl);
24197 fprintf (stderr, " left overhang = %d, right = %d\n",
24198 s->left_overhang, s->right_overhang);
24199 fprintf (stderr, " nchars = %d\n", s->nchars);
24200 fprintf (stderr, " extends to end of line = %d\n",
24201 s->extends_to_end_of_line_p);
24202 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
24203 fprintf (stderr, " bg width = %d\n", s->background_width);
24206 #endif /* GLYPH_DEBUG */
24208 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24209 of XChar2b structures for S; it can't be allocated in
24210 init_glyph_string because it must be allocated via `alloca'. W
24211 is the window on which S is drawn. ROW and AREA are the glyph row
24212 and area within the row from which S is constructed. START is the
24213 index of the first glyph structure covered by S. HL is a
24214 face-override for drawing S. */
24216 #ifdef HAVE_NTGUI
24217 #define OPTIONAL_HDC(hdc) HDC hdc,
24218 #define DECLARE_HDC(hdc) HDC hdc;
24219 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24220 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24221 #endif
24223 #ifndef OPTIONAL_HDC
24224 #define OPTIONAL_HDC(hdc)
24225 #define DECLARE_HDC(hdc)
24226 #define ALLOCATE_HDC(hdc, f)
24227 #define RELEASE_HDC(hdc, f)
24228 #endif
24230 static void
24231 init_glyph_string (struct glyph_string *s,
24232 OPTIONAL_HDC (hdc)
24233 XChar2b *char2b, struct window *w, struct glyph_row *row,
24234 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
24236 memset (s, 0, sizeof *s);
24237 s->w = w;
24238 s->f = XFRAME (w->frame);
24239 #ifdef HAVE_NTGUI
24240 s->hdc = hdc;
24241 #endif
24242 s->display = FRAME_X_DISPLAY (s->f);
24243 s->window = FRAME_X_WINDOW (s->f);
24244 s->char2b = char2b;
24245 s->hl = hl;
24246 s->row = row;
24247 s->area = area;
24248 s->first_glyph = row->glyphs[area] + start;
24249 s->height = row->height;
24250 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
24251 s->ybase = s->y + row->ascent;
24255 /* Append the list of glyph strings with head H and tail T to the list
24256 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24258 static void
24259 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24260 struct glyph_string *h, struct glyph_string *t)
24262 if (h)
24264 if (*head)
24265 (*tail)->next = h;
24266 else
24267 *head = h;
24268 h->prev = *tail;
24269 *tail = t;
24274 /* Prepend the list of glyph strings with head H and tail T to the
24275 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24276 result. */
24278 static void
24279 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24280 struct glyph_string *h, struct glyph_string *t)
24282 if (h)
24284 if (*head)
24285 (*head)->prev = t;
24286 else
24287 *tail = t;
24288 t->next = *head;
24289 *head = h;
24294 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24295 Set *HEAD and *TAIL to the resulting list. */
24297 static void
24298 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
24299 struct glyph_string *s)
24301 s->next = s->prev = NULL;
24302 append_glyph_string_lists (head, tail, s, s);
24306 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24307 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24308 make sure that X resources for the face returned are allocated.
24309 Value is a pointer to a realized face that is ready for display if
24310 DISPLAY_P. */
24312 static struct face *
24313 get_char_face_and_encoding (struct frame *f, int c, int face_id,
24314 XChar2b *char2b, bool display_p)
24316 struct face *face = FACE_FROM_ID (f, face_id);
24317 unsigned code = 0;
24319 if (face->font)
24321 code = face->font->driver->encode_char (face->font, c);
24323 if (code == FONT_INVALID_CODE)
24324 code = 0;
24326 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24328 /* Make sure X resources of the face are allocated. */
24329 #ifdef HAVE_X_WINDOWS
24330 if (display_p)
24331 #endif
24333 eassert (face != NULL);
24334 prepare_face_for_display (f, face);
24337 return face;
24341 /* Get face and two-byte form of character glyph GLYPH on frame F.
24342 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24343 a pointer to a realized face that is ready for display. */
24345 static struct face *
24346 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
24347 XChar2b *char2b)
24349 struct face *face;
24350 unsigned code = 0;
24352 eassert (glyph->type == CHAR_GLYPH);
24353 face = FACE_FROM_ID (f, glyph->face_id);
24355 /* Make sure X resources of the face are allocated. */
24356 eassert (face != NULL);
24357 prepare_face_for_display (f, face);
24359 if (face->font)
24361 if (CHAR_BYTE8_P (glyph->u.ch))
24362 code = CHAR_TO_BYTE8 (glyph->u.ch);
24363 else
24364 code = face->font->driver->encode_char (face->font, glyph->u.ch);
24366 if (code == FONT_INVALID_CODE)
24367 code = 0;
24370 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24371 return face;
24375 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24376 Return true iff FONT has a glyph for C. */
24378 static bool
24379 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
24381 unsigned code;
24383 if (CHAR_BYTE8_P (c))
24384 code = CHAR_TO_BYTE8 (c);
24385 else
24386 code = font->driver->encode_char (font, c);
24388 if (code == FONT_INVALID_CODE)
24389 return false;
24390 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24391 return true;
24395 /* Fill glyph string S with composition components specified by S->cmp.
24397 BASE_FACE is the base face of the composition.
24398 S->cmp_from is the index of the first component for S.
24400 OVERLAPS non-zero means S should draw the foreground only, and use
24401 its physical height for clipping. See also draw_glyphs.
24403 Value is the index of a component not in S. */
24405 static int
24406 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
24407 int overlaps)
24409 int i;
24410 /* For all glyphs of this composition, starting at the offset
24411 S->cmp_from, until we reach the end of the definition or encounter a
24412 glyph that requires the different face, add it to S. */
24413 struct face *face;
24415 eassert (s);
24417 s->for_overlaps = overlaps;
24418 s->face = NULL;
24419 s->font = NULL;
24420 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
24422 int c = COMPOSITION_GLYPH (s->cmp, i);
24424 /* TAB in a composition means display glyphs with padding space
24425 on the left or right. */
24426 if (c != '\t')
24428 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
24429 -1, Qnil);
24431 face = get_char_face_and_encoding (s->f, c, face_id,
24432 s->char2b + i, true);
24433 if (face)
24435 if (! s->face)
24437 s->face = face;
24438 s->font = s->face->font;
24440 else if (s->face != face)
24441 break;
24444 ++s->nchars;
24446 s->cmp_to = i;
24448 if (s->face == NULL)
24450 s->face = base_face->ascii_face;
24451 s->font = s->face->font;
24454 /* All glyph strings for the same composition has the same width,
24455 i.e. the width set for the first component of the composition. */
24456 s->width = s->first_glyph->pixel_width;
24458 /* If the specified font could not be loaded, use the frame's
24459 default font, but record the fact that we couldn't load it in
24460 the glyph string so that we can draw rectangles for the
24461 characters of the glyph string. */
24462 if (s->font == NULL)
24464 s->font_not_found_p = true;
24465 s->font = FRAME_FONT (s->f);
24468 /* Adjust base line for subscript/superscript text. */
24469 s->ybase += s->first_glyph->voffset;
24471 return s->cmp_to;
24474 static int
24475 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
24476 int start, int end, int overlaps)
24478 struct glyph *glyph, *last;
24479 Lisp_Object lgstring;
24480 int i;
24482 s->for_overlaps = overlaps;
24483 glyph = s->row->glyphs[s->area] + start;
24484 last = s->row->glyphs[s->area] + end;
24485 s->cmp_id = glyph->u.cmp.id;
24486 s->cmp_from = glyph->slice.cmp.from;
24487 s->cmp_to = glyph->slice.cmp.to + 1;
24488 s->face = FACE_FROM_ID (s->f, face_id);
24489 lgstring = composition_gstring_from_id (s->cmp_id);
24490 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
24491 glyph++;
24492 while (glyph < last
24493 && glyph->u.cmp.automatic
24494 && glyph->u.cmp.id == s->cmp_id
24495 && s->cmp_to == glyph->slice.cmp.from)
24496 s->cmp_to = (glyph++)->slice.cmp.to + 1;
24498 for (i = s->cmp_from; i < s->cmp_to; i++)
24500 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
24501 unsigned code = LGLYPH_CODE (lglyph);
24503 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
24505 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
24506 return glyph - s->row->glyphs[s->area];
24510 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24511 See the comment of fill_glyph_string for arguments.
24512 Value is the index of the first glyph not in S. */
24515 static int
24516 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
24517 int start, int end, int overlaps)
24519 struct glyph *glyph, *last;
24520 int voffset;
24522 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
24523 s->for_overlaps = overlaps;
24524 glyph = s->row->glyphs[s->area] + start;
24525 last = s->row->glyphs[s->area] + end;
24526 voffset = glyph->voffset;
24527 s->face = FACE_FROM_ID (s->f, face_id);
24528 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
24529 s->nchars = 1;
24530 s->width = glyph->pixel_width;
24531 glyph++;
24532 while (glyph < last
24533 && glyph->type == GLYPHLESS_GLYPH
24534 && glyph->voffset == voffset
24535 && glyph->face_id == face_id)
24537 s->nchars++;
24538 s->width += glyph->pixel_width;
24539 glyph++;
24541 s->ybase += voffset;
24542 return glyph - s->row->glyphs[s->area];
24546 /* Fill glyph string S from a sequence of character glyphs.
24548 FACE_ID is the face id of the string. START is the index of the
24549 first glyph to consider, END is the index of the last + 1.
24550 OVERLAPS non-zero means S should draw the foreground only, and use
24551 its physical height for clipping. See also draw_glyphs.
24553 Value is the index of the first glyph not in S. */
24555 static int
24556 fill_glyph_string (struct glyph_string *s, int face_id,
24557 int start, int end, int overlaps)
24559 struct glyph *glyph, *last;
24560 int voffset;
24561 bool glyph_not_available_p;
24563 eassert (s->f == XFRAME (s->w->frame));
24564 eassert (s->nchars == 0);
24565 eassert (start >= 0 && end > start);
24567 s->for_overlaps = overlaps;
24568 glyph = s->row->glyphs[s->area] + start;
24569 last = s->row->glyphs[s->area] + end;
24570 voffset = glyph->voffset;
24571 s->padding_p = glyph->padding_p;
24572 glyph_not_available_p = glyph->glyph_not_available_p;
24574 while (glyph < last
24575 && glyph->type == CHAR_GLYPH
24576 && glyph->voffset == voffset
24577 /* Same face id implies same font, nowadays. */
24578 && glyph->face_id == face_id
24579 && glyph->glyph_not_available_p == glyph_not_available_p)
24581 s->face = get_glyph_face_and_encoding (s->f, glyph,
24582 s->char2b + s->nchars);
24583 ++s->nchars;
24584 eassert (s->nchars <= end - start);
24585 s->width += glyph->pixel_width;
24586 if (glyph++->padding_p != s->padding_p)
24587 break;
24590 s->font = s->face->font;
24592 /* If the specified font could not be loaded, use the frame's font,
24593 but record the fact that we couldn't load it in
24594 S->font_not_found_p so that we can draw rectangles for the
24595 characters of the glyph string. */
24596 if (s->font == NULL || glyph_not_available_p)
24598 s->font_not_found_p = true;
24599 s->font = FRAME_FONT (s->f);
24602 /* Adjust base line for subscript/superscript text. */
24603 s->ybase += voffset;
24605 eassert (s->face && s->face->gc);
24606 return glyph - s->row->glyphs[s->area];
24610 /* Fill glyph string S from image glyph S->first_glyph. */
24612 static void
24613 fill_image_glyph_string (struct glyph_string *s)
24615 eassert (s->first_glyph->type == IMAGE_GLYPH);
24616 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
24617 eassert (s->img);
24618 s->slice = s->first_glyph->slice.img;
24619 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24620 s->font = s->face->font;
24621 s->width = s->first_glyph->pixel_width;
24623 /* Adjust base line for subscript/superscript text. */
24624 s->ybase += s->first_glyph->voffset;
24628 /* Fill glyph string S from a sequence of stretch glyphs.
24630 START is the index of the first glyph to consider,
24631 END is the index of the last + 1.
24633 Value is the index of the first glyph not in S. */
24635 static int
24636 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
24638 struct glyph *glyph, *last;
24639 int voffset, face_id;
24641 eassert (s->first_glyph->type == STRETCH_GLYPH);
24643 glyph = s->row->glyphs[s->area] + start;
24644 last = s->row->glyphs[s->area] + end;
24645 face_id = glyph->face_id;
24646 s->face = FACE_FROM_ID (s->f, face_id);
24647 s->font = s->face->font;
24648 s->width = glyph->pixel_width;
24649 s->nchars = 1;
24650 voffset = glyph->voffset;
24652 for (++glyph;
24653 (glyph < last
24654 && glyph->type == STRETCH_GLYPH
24655 && glyph->voffset == voffset
24656 && glyph->face_id == face_id);
24657 ++glyph)
24658 s->width += glyph->pixel_width;
24660 /* Adjust base line for subscript/superscript text. */
24661 s->ybase += voffset;
24663 /* The case that face->gc == 0 is handled when drawing the glyph
24664 string by calling prepare_face_for_display. */
24665 eassert (s->face);
24666 return glyph - s->row->glyphs[s->area];
24669 static struct font_metrics *
24670 get_per_char_metric (struct font *font, XChar2b *char2b)
24672 static struct font_metrics metrics;
24673 unsigned code;
24675 if (! font)
24676 return NULL;
24677 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24678 if (code == FONT_INVALID_CODE)
24679 return NULL;
24680 font->driver->text_extents (font, &code, 1, &metrics);
24681 return &metrics;
24684 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24685 for FONT. Values are taken from font-global ones, except for fonts
24686 that claim preposterously large values, but whose glyphs actually
24687 have reasonable dimensions. C is the character to use for metrics
24688 if the font-global values are too large; if C is negative, the
24689 function selects a default character. */
24690 static void
24691 normal_char_ascent_descent (struct font *font, int c, int *ascent, int *descent)
24693 *ascent = FONT_BASE (font);
24694 *descent = FONT_DESCENT (font);
24696 if (FONT_TOO_HIGH (font))
24698 XChar2b char2b;
24700 /* Get metrics of C, defaulting to a reasonably sized ASCII
24701 character. */
24702 if (get_char_glyph_code (c >= 0 ? c : '{', font, &char2b))
24704 struct font_metrics *pcm = get_per_char_metric (font, &char2b);
24706 if (!(pcm->width == 0 && pcm->rbearing == 0 && pcm->lbearing == 0))
24708 /* We add 1 pixel to character dimensions as heuristics
24709 that produces nicer display, e.g. when the face has
24710 the box attribute. */
24711 *ascent = pcm->ascent + 1;
24712 *descent = pcm->descent + 1;
24718 /* A subroutine that computes a reasonable "normal character height"
24719 for fonts that claim preposterously large vertical dimensions, but
24720 whose glyphs are actually reasonably sized. C is the character
24721 whose metrics to use for those fonts, or -1 for default
24722 character. */
24723 static int
24724 normal_char_height (struct font *font, int c)
24726 int ascent, descent;
24728 normal_char_ascent_descent (font, c, &ascent, &descent);
24730 return ascent + descent;
24733 /* EXPORT for RIF:
24734 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24735 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24736 assumed to be zero. */
24738 void
24739 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
24741 *left = *right = 0;
24743 if (glyph->type == CHAR_GLYPH)
24745 XChar2b char2b;
24746 struct face *face = get_glyph_face_and_encoding (f, glyph, &char2b);
24747 if (face->font)
24749 struct font_metrics *pcm = get_per_char_metric (face->font, &char2b);
24750 if (pcm)
24752 if (pcm->rbearing > pcm->width)
24753 *right = pcm->rbearing - pcm->width;
24754 if (pcm->lbearing < 0)
24755 *left = -pcm->lbearing;
24759 else if (glyph->type == COMPOSITE_GLYPH)
24761 if (! glyph->u.cmp.automatic)
24763 struct composition *cmp = composition_table[glyph->u.cmp.id];
24765 if (cmp->rbearing > cmp->pixel_width)
24766 *right = cmp->rbearing - cmp->pixel_width;
24767 if (cmp->lbearing < 0)
24768 *left = - cmp->lbearing;
24770 else
24772 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
24773 struct font_metrics metrics;
24775 composition_gstring_width (gstring, glyph->slice.cmp.from,
24776 glyph->slice.cmp.to + 1, &metrics);
24777 if (metrics.rbearing > metrics.width)
24778 *right = metrics.rbearing - metrics.width;
24779 if (metrics.lbearing < 0)
24780 *left = - metrics.lbearing;
24786 /* Return the index of the first glyph preceding glyph string S that
24787 is overwritten by S because of S's left overhang. Value is -1
24788 if no glyphs are overwritten. */
24790 static int
24791 left_overwritten (struct glyph_string *s)
24793 int k;
24795 if (s->left_overhang)
24797 int x = 0, i;
24798 struct glyph *glyphs = s->row->glyphs[s->area];
24799 int first = s->first_glyph - glyphs;
24801 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
24802 x -= glyphs[i].pixel_width;
24804 k = i + 1;
24806 else
24807 k = -1;
24809 return k;
24813 /* Return the index of the first glyph preceding glyph string S that
24814 is overwriting S because of its right overhang. Value is -1 if no
24815 glyph in front of S overwrites S. */
24817 static int
24818 left_overwriting (struct glyph_string *s)
24820 int i, k, x;
24821 struct glyph *glyphs = s->row->glyphs[s->area];
24822 int first = s->first_glyph - glyphs;
24824 k = -1;
24825 x = 0;
24826 for (i = first - 1; i >= 0; --i)
24828 int left, right;
24829 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24830 if (x + right > 0)
24831 k = i;
24832 x -= glyphs[i].pixel_width;
24835 return k;
24839 /* Return the index of the last glyph following glyph string S that is
24840 overwritten by S because of S's right overhang. Value is -1 if
24841 no such glyph is found. */
24843 static int
24844 right_overwritten (struct glyph_string *s)
24846 int k = -1;
24848 if (s->right_overhang)
24850 int x = 0, i;
24851 struct glyph *glyphs = s->row->glyphs[s->area];
24852 int first = (s->first_glyph - glyphs
24853 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24854 int end = s->row->used[s->area];
24856 for (i = first; i < end && s->right_overhang > x; ++i)
24857 x += glyphs[i].pixel_width;
24859 k = i;
24862 return k;
24866 /* Return the index of the last glyph following glyph string S that
24867 overwrites S because of its left overhang. Value is negative
24868 if no such glyph is found. */
24870 static int
24871 right_overwriting (struct glyph_string *s)
24873 int i, k, x;
24874 int end = s->row->used[s->area];
24875 struct glyph *glyphs = s->row->glyphs[s->area];
24876 int first = (s->first_glyph - glyphs
24877 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24879 k = -1;
24880 x = 0;
24881 for (i = first; i < end; ++i)
24883 int left, right;
24884 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24885 if (x - left < 0)
24886 k = i;
24887 x += glyphs[i].pixel_width;
24890 return k;
24894 /* Set background width of glyph string S. START is the index of the
24895 first glyph following S. LAST_X is the right-most x-position + 1
24896 in the drawing area. */
24898 static void
24899 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
24901 /* If the face of this glyph string has to be drawn to the end of
24902 the drawing area, set S->extends_to_end_of_line_p. */
24904 if (start == s->row->used[s->area]
24905 && ((s->row->fill_line_p
24906 && (s->hl == DRAW_NORMAL_TEXT
24907 || s->hl == DRAW_IMAGE_RAISED
24908 || s->hl == DRAW_IMAGE_SUNKEN))
24909 || s->hl == DRAW_MOUSE_FACE))
24910 s->extends_to_end_of_line_p = true;
24912 /* If S extends its face to the end of the line, set its
24913 background_width to the distance to the right edge of the drawing
24914 area. */
24915 if (s->extends_to_end_of_line_p)
24916 s->background_width = last_x - s->x + 1;
24917 else
24918 s->background_width = s->width;
24922 /* Compute overhangs and x-positions for glyph string S and its
24923 predecessors, or successors. X is the starting x-position for S.
24924 BACKWARD_P means process predecessors. */
24926 static void
24927 compute_overhangs_and_x (struct glyph_string *s, int x, bool backward_p)
24929 if (backward_p)
24931 while (s)
24933 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24934 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24935 x -= s->width;
24936 s->x = x;
24937 s = s->prev;
24940 else
24942 while (s)
24944 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24945 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24946 s->x = x;
24947 x += s->width;
24948 s = s->next;
24955 /* The following macros are only called from draw_glyphs below.
24956 They reference the following parameters of that function directly:
24957 `w', `row', `area', and `overlap_p'
24958 as well as the following local variables:
24959 `s', `f', and `hdc' (in W32) */
24961 #ifdef HAVE_NTGUI
24962 /* On W32, silently add local `hdc' variable to argument list of
24963 init_glyph_string. */
24964 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24965 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24966 #else
24967 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24968 init_glyph_string (s, char2b, w, row, area, start, hl)
24969 #endif
24971 /* Add a glyph string for a stretch glyph to the list of strings
24972 between HEAD and TAIL. START is the index of the stretch glyph in
24973 row area AREA of glyph row ROW. END is the index of the last glyph
24974 in that glyph row area. X is the current output position assigned
24975 to the new glyph string constructed. HL overrides that face of the
24976 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24977 is the right-most x-position of the drawing area. */
24979 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24980 and below -- keep them on one line. */
24981 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24982 do \
24984 s = alloca (sizeof *s); \
24985 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24986 START = fill_stretch_glyph_string (s, START, END); \
24987 append_glyph_string (&HEAD, &TAIL, s); \
24988 s->x = (X); \
24990 while (false)
24993 /* Add a glyph string for an image glyph to the list of strings
24994 between HEAD and TAIL. START is the index of the image glyph in
24995 row area AREA of glyph row ROW. END is the index of the last glyph
24996 in that glyph row area. X is the current output position assigned
24997 to the new glyph string constructed. HL overrides that face of the
24998 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24999 is the right-most x-position of the drawing area. */
25001 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25002 do \
25004 s = alloca (sizeof *s); \
25005 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25006 fill_image_glyph_string (s); \
25007 append_glyph_string (&HEAD, &TAIL, s); \
25008 ++START; \
25009 s->x = (X); \
25011 while (false)
25014 /* Add a glyph string for a sequence of character glyphs to the list
25015 of strings between HEAD and TAIL. START is the index of the first
25016 glyph in row area AREA of glyph row ROW that is part of the new
25017 glyph string. END is the index of the last glyph in that glyph row
25018 area. X is the current output position assigned to the new glyph
25019 string constructed. HL overrides that face of the glyph; e.g. it
25020 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25021 right-most x-position of the drawing area. */
25023 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25024 do \
25026 int face_id; \
25027 XChar2b *char2b; \
25029 face_id = (row)->glyphs[area][START].face_id; \
25031 s = alloca (sizeof *s); \
25032 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25033 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25034 append_glyph_string (&HEAD, &TAIL, s); \
25035 s->x = (X); \
25036 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25038 while (false)
25041 /* Add a glyph string for a composite sequence to the list of strings
25042 between HEAD and TAIL. START is the index of the first glyph in
25043 row area AREA of glyph row ROW that is part of the new glyph
25044 string. END is the index of the last glyph in that glyph row area.
25045 X is the current output position assigned to the new glyph string
25046 constructed. HL overrides that face of the glyph; e.g. it is
25047 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25048 x-position of the drawing area. */
25050 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25051 do { \
25052 int face_id = (row)->glyphs[area][START].face_id; \
25053 struct face *base_face = FACE_FROM_ID (f, face_id); \
25054 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25055 struct composition *cmp = composition_table[cmp_id]; \
25056 XChar2b *char2b; \
25057 struct glyph_string *first_s = NULL; \
25058 int n; \
25060 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25062 /* Make glyph_strings for each glyph sequence that is drawable by \
25063 the same face, and append them to HEAD/TAIL. */ \
25064 for (n = 0; n < cmp->glyph_len;) \
25066 s = alloca (sizeof *s); \
25067 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25068 append_glyph_string (&(HEAD), &(TAIL), s); \
25069 s->cmp = cmp; \
25070 s->cmp_from = n; \
25071 s->x = (X); \
25072 if (n == 0) \
25073 first_s = s; \
25074 n = fill_composite_glyph_string (s, base_face, overlaps); \
25077 ++START; \
25078 s = first_s; \
25079 } while (false)
25082 /* Add a glyph string for a glyph-string sequence to the list of strings
25083 between HEAD and TAIL. */
25085 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25086 do { \
25087 int face_id; \
25088 XChar2b *char2b; \
25089 Lisp_Object gstring; \
25091 face_id = (row)->glyphs[area][START].face_id; \
25092 gstring = (composition_gstring_from_id \
25093 ((row)->glyphs[area][START].u.cmp.id)); \
25094 s = alloca (sizeof *s); \
25095 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25096 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25097 append_glyph_string (&(HEAD), &(TAIL), s); \
25098 s->x = (X); \
25099 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25100 } while (false)
25103 /* Add a glyph string for a sequence of glyphless character's glyphs
25104 to the list of strings between HEAD and TAIL. The meanings of
25105 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25107 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25108 do \
25110 int face_id; \
25112 face_id = (row)->glyphs[area][START].face_id; \
25114 s = alloca (sizeof *s); \
25115 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25116 append_glyph_string (&HEAD, &TAIL, s); \
25117 s->x = (X); \
25118 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25119 overlaps); \
25121 while (false)
25124 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25125 of AREA of glyph row ROW on window W between indices START and END.
25126 HL overrides the face for drawing glyph strings, e.g. it is
25127 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25128 x-positions of the drawing area.
25130 This is an ugly monster macro construct because we must use alloca
25131 to allocate glyph strings (because draw_glyphs can be called
25132 asynchronously). */
25134 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25135 do \
25137 HEAD = TAIL = NULL; \
25138 while (START < END) \
25140 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25141 switch (first_glyph->type) \
25143 case CHAR_GLYPH: \
25144 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25145 HL, X, LAST_X); \
25146 break; \
25148 case COMPOSITE_GLYPH: \
25149 if (first_glyph->u.cmp.automatic) \
25150 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25151 HL, X, LAST_X); \
25152 else \
25153 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25154 HL, X, LAST_X); \
25155 break; \
25157 case STRETCH_GLYPH: \
25158 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25159 HL, X, LAST_X); \
25160 break; \
25162 case IMAGE_GLYPH: \
25163 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25164 HL, X, LAST_X); \
25165 break; \
25167 case GLYPHLESS_GLYPH: \
25168 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25169 HL, X, LAST_X); \
25170 break; \
25172 default: \
25173 emacs_abort (); \
25176 if (s) \
25178 set_glyph_string_background_width (s, START, LAST_X); \
25179 (X) += s->width; \
25182 } while (false)
25185 /* Draw glyphs between START and END in AREA of ROW on window W,
25186 starting at x-position X. X is relative to AREA in W. HL is a
25187 face-override with the following meaning:
25189 DRAW_NORMAL_TEXT draw normally
25190 DRAW_CURSOR draw in cursor face
25191 DRAW_MOUSE_FACE draw in mouse face.
25192 DRAW_INVERSE_VIDEO draw in mode line face
25193 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25194 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25196 If OVERLAPS is non-zero, draw only the foreground of characters and
25197 clip to the physical height of ROW. Non-zero value also defines
25198 the overlapping part to be drawn:
25200 OVERLAPS_PRED overlap with preceding rows
25201 OVERLAPS_SUCC overlap with succeeding rows
25202 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25203 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25205 Value is the x-position reached, relative to AREA of W. */
25207 static int
25208 draw_glyphs (struct window *w, int x, struct glyph_row *row,
25209 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
25210 enum draw_glyphs_face hl, int overlaps)
25212 struct glyph_string *head, *tail;
25213 struct glyph_string *s;
25214 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
25215 int i, j, x_reached, last_x, area_left = 0;
25216 struct frame *f = XFRAME (WINDOW_FRAME (w));
25217 DECLARE_HDC (hdc);
25219 ALLOCATE_HDC (hdc, f);
25221 /* Let's rather be paranoid than getting a SEGV. */
25222 end = min (end, row->used[area]);
25223 start = clip_to_bounds (0, start, end);
25225 /* Translate X to frame coordinates. Set last_x to the right
25226 end of the drawing area. */
25227 if (row->full_width_p)
25229 /* X is relative to the left edge of W, without scroll bars
25230 or fringes. */
25231 area_left = WINDOW_LEFT_EDGE_X (w);
25232 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
25233 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
25235 else
25237 area_left = window_box_left (w, area);
25238 last_x = area_left + window_box_width (w, area);
25240 x += area_left;
25242 /* Build a doubly-linked list of glyph_string structures between
25243 head and tail from what we have to draw. Note that the macro
25244 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25245 the reason we use a separate variable `i'. */
25246 i = start;
25247 USE_SAFE_ALLOCA;
25248 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
25249 if (tail)
25250 x_reached = tail->x + tail->background_width;
25251 else
25252 x_reached = x;
25254 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25255 the row, redraw some glyphs in front or following the glyph
25256 strings built above. */
25257 if (head && !overlaps && row->contains_overlapping_glyphs_p)
25259 struct glyph_string *h, *t;
25260 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
25261 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
25262 bool check_mouse_face = false;
25263 int dummy_x = 0;
25265 /* If mouse highlighting is on, we may need to draw adjacent
25266 glyphs using mouse-face highlighting. */
25267 if (area == TEXT_AREA && row->mouse_face_p
25268 && hlinfo->mouse_face_beg_row >= 0
25269 && hlinfo->mouse_face_end_row >= 0)
25271 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
25273 if (row_vpos >= hlinfo->mouse_face_beg_row
25274 && row_vpos <= hlinfo->mouse_face_end_row)
25276 check_mouse_face = true;
25277 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
25278 ? hlinfo->mouse_face_beg_col : 0;
25279 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
25280 ? hlinfo->mouse_face_end_col
25281 : row->used[TEXT_AREA];
25285 /* Compute overhangs for all glyph strings. */
25286 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
25287 for (s = head; s; s = s->next)
25288 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
25290 /* Prepend glyph strings for glyphs in front of the first glyph
25291 string that are overwritten because of the first glyph
25292 string's left overhang. The background of all strings
25293 prepended must be drawn because the first glyph string
25294 draws over it. */
25295 i = left_overwritten (head);
25296 if (i >= 0)
25298 enum draw_glyphs_face overlap_hl;
25300 /* If this row contains mouse highlighting, attempt to draw
25301 the overlapped glyphs with the correct highlight. This
25302 code fails if the overlap encompasses more than one glyph
25303 and mouse-highlight spans only some of these glyphs.
25304 However, making it work perfectly involves a lot more
25305 code, and I don't know if the pathological case occurs in
25306 practice, so we'll stick to this for now. --- cyd */
25307 if (check_mouse_face
25308 && mouse_beg_col < start && mouse_end_col > i)
25309 overlap_hl = DRAW_MOUSE_FACE;
25310 else
25311 overlap_hl = DRAW_NORMAL_TEXT;
25313 if (hl != overlap_hl)
25314 clip_head = head;
25315 j = i;
25316 BUILD_GLYPH_STRINGS (j, start, h, t,
25317 overlap_hl, dummy_x, last_x);
25318 start = i;
25319 compute_overhangs_and_x (t, head->x, true);
25320 prepend_glyph_string_lists (&head, &tail, h, t);
25321 if (clip_head == NULL)
25322 clip_head = head;
25325 /* Prepend glyph strings for glyphs in front of the first glyph
25326 string that overwrite that glyph string because of their
25327 right overhang. For these strings, only the foreground must
25328 be drawn, because it draws over the glyph string at `head'.
25329 The background must not be drawn because this would overwrite
25330 right overhangs of preceding glyphs for which no glyph
25331 strings exist. */
25332 i = left_overwriting (head);
25333 if (i >= 0)
25335 enum draw_glyphs_face overlap_hl;
25337 if (check_mouse_face
25338 && mouse_beg_col < start && mouse_end_col > i)
25339 overlap_hl = DRAW_MOUSE_FACE;
25340 else
25341 overlap_hl = DRAW_NORMAL_TEXT;
25343 if (hl == overlap_hl || clip_head == NULL)
25344 clip_head = head;
25345 BUILD_GLYPH_STRINGS (i, start, h, t,
25346 overlap_hl, dummy_x, last_x);
25347 for (s = h; s; s = s->next)
25348 s->background_filled_p = true;
25349 compute_overhangs_and_x (t, head->x, true);
25350 prepend_glyph_string_lists (&head, &tail, h, t);
25353 /* Append glyphs strings for glyphs following the last glyph
25354 string tail that are overwritten by tail. The background of
25355 these strings has to be drawn because tail's foreground draws
25356 over it. */
25357 i = right_overwritten (tail);
25358 if (i >= 0)
25360 enum draw_glyphs_face overlap_hl;
25362 if (check_mouse_face
25363 && mouse_beg_col < i && mouse_end_col > end)
25364 overlap_hl = DRAW_MOUSE_FACE;
25365 else
25366 overlap_hl = DRAW_NORMAL_TEXT;
25368 if (hl != overlap_hl)
25369 clip_tail = tail;
25370 BUILD_GLYPH_STRINGS (end, i, h, t,
25371 overlap_hl, x, last_x);
25372 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25373 we don't have `end = i;' here. */
25374 compute_overhangs_and_x (h, tail->x + tail->width, false);
25375 append_glyph_string_lists (&head, &tail, h, t);
25376 if (clip_tail == NULL)
25377 clip_tail = tail;
25380 /* Append glyph strings for glyphs following the last glyph
25381 string tail that overwrite tail. The foreground of such
25382 glyphs has to be drawn because it writes into the background
25383 of tail. The background must not be drawn because it could
25384 paint over the foreground of following glyphs. */
25385 i = right_overwriting (tail);
25386 if (i >= 0)
25388 enum draw_glyphs_face overlap_hl;
25389 if (check_mouse_face
25390 && mouse_beg_col < i && mouse_end_col > end)
25391 overlap_hl = DRAW_MOUSE_FACE;
25392 else
25393 overlap_hl = DRAW_NORMAL_TEXT;
25395 if (hl == overlap_hl || clip_tail == NULL)
25396 clip_tail = tail;
25397 i++; /* We must include the Ith glyph. */
25398 BUILD_GLYPH_STRINGS (end, i, h, t,
25399 overlap_hl, x, last_x);
25400 for (s = h; s; s = s->next)
25401 s->background_filled_p = true;
25402 compute_overhangs_and_x (h, tail->x + tail->width, false);
25403 append_glyph_string_lists (&head, &tail, h, t);
25405 if (clip_head || clip_tail)
25406 for (s = head; s; s = s->next)
25408 s->clip_head = clip_head;
25409 s->clip_tail = clip_tail;
25413 /* Draw all strings. */
25414 for (s = head; s; s = s->next)
25415 FRAME_RIF (f)->draw_glyph_string (s);
25417 #ifndef HAVE_NS
25418 /* When focus a sole frame and move horizontally, this clears on_p
25419 causing a failure to erase prev cursor position. */
25420 if (area == TEXT_AREA
25421 && !row->full_width_p
25422 /* When drawing overlapping rows, only the glyph strings'
25423 foreground is drawn, which doesn't erase a cursor
25424 completely. */
25425 && !overlaps)
25427 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
25428 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
25429 : (tail ? tail->x + tail->background_width : x));
25430 x0 -= area_left;
25431 x1 -= area_left;
25433 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
25434 row->y, MATRIX_ROW_BOTTOM_Y (row));
25436 #endif
25438 /* Value is the x-position up to which drawn, relative to AREA of W.
25439 This doesn't include parts drawn because of overhangs. */
25440 if (row->full_width_p)
25441 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
25442 else
25443 x_reached -= area_left;
25445 RELEASE_HDC (hdc, f);
25447 SAFE_FREE ();
25448 return x_reached;
25451 /* Expand row matrix if too narrow. Don't expand if area
25452 is not present. */
25454 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25456 if (!it->f->fonts_changed \
25457 && (it->glyph_row->glyphs[area] \
25458 < it->glyph_row->glyphs[area + 1])) \
25460 it->w->ncols_scale_factor++; \
25461 it->f->fonts_changed = true; \
25465 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25466 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25468 static void
25469 append_glyph (struct it *it)
25471 struct glyph *glyph;
25472 enum glyph_row_area area = it->area;
25474 eassert (it->glyph_row);
25475 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
25477 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25478 if (glyph < it->glyph_row->glyphs[area + 1])
25480 /* If the glyph row is reversed, we need to prepend the glyph
25481 rather than append it. */
25482 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25484 struct glyph *g;
25486 /* Make room for the additional glyph. */
25487 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25488 g[1] = *g;
25489 glyph = it->glyph_row->glyphs[area];
25491 glyph->charpos = CHARPOS (it->position);
25492 glyph->object = it->object;
25493 if (it->pixel_width > 0)
25495 glyph->pixel_width = it->pixel_width;
25496 glyph->padding_p = false;
25498 else
25500 /* Assure at least 1-pixel width. Otherwise, cursor can't
25501 be displayed correctly. */
25502 glyph->pixel_width = 1;
25503 glyph->padding_p = true;
25505 glyph->ascent = it->ascent;
25506 glyph->descent = it->descent;
25507 glyph->voffset = it->voffset;
25508 glyph->type = CHAR_GLYPH;
25509 glyph->avoid_cursor_p = it->avoid_cursor_p;
25510 glyph->multibyte_p = it->multibyte_p;
25511 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25513 /* In R2L rows, the left and the right box edges need to be
25514 drawn in reverse direction. */
25515 glyph->right_box_line_p = it->start_of_box_run_p;
25516 glyph->left_box_line_p = it->end_of_box_run_p;
25518 else
25520 glyph->left_box_line_p = it->start_of_box_run_p;
25521 glyph->right_box_line_p = it->end_of_box_run_p;
25523 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25524 || it->phys_descent > it->descent);
25525 glyph->glyph_not_available_p = it->glyph_not_available_p;
25526 glyph->face_id = it->face_id;
25527 glyph->u.ch = it->char_to_display;
25528 glyph->slice.img = null_glyph_slice;
25529 glyph->font_type = FONT_TYPE_UNKNOWN;
25530 if (it->bidi_p)
25532 glyph->resolved_level = it->bidi_it.resolved_level;
25533 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25534 glyph->bidi_type = it->bidi_it.type;
25536 else
25538 glyph->resolved_level = 0;
25539 glyph->bidi_type = UNKNOWN_BT;
25541 ++it->glyph_row->used[area];
25543 else
25544 IT_EXPAND_MATRIX_WIDTH (it, area);
25547 /* Store one glyph for the composition IT->cmp_it.id in
25548 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25549 non-null. */
25551 static void
25552 append_composite_glyph (struct it *it)
25554 struct glyph *glyph;
25555 enum glyph_row_area area = it->area;
25557 eassert (it->glyph_row);
25559 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25560 if (glyph < it->glyph_row->glyphs[area + 1])
25562 /* If the glyph row is reversed, we need to prepend the glyph
25563 rather than append it. */
25564 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
25566 struct glyph *g;
25568 /* Make room for the new glyph. */
25569 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25570 g[1] = *g;
25571 glyph = it->glyph_row->glyphs[it->area];
25573 glyph->charpos = it->cmp_it.charpos;
25574 glyph->object = it->object;
25575 glyph->pixel_width = it->pixel_width;
25576 glyph->ascent = it->ascent;
25577 glyph->descent = it->descent;
25578 glyph->voffset = it->voffset;
25579 glyph->type = COMPOSITE_GLYPH;
25580 if (it->cmp_it.ch < 0)
25582 glyph->u.cmp.automatic = false;
25583 glyph->u.cmp.id = it->cmp_it.id;
25584 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
25586 else
25588 glyph->u.cmp.automatic = true;
25589 glyph->u.cmp.id = it->cmp_it.id;
25590 glyph->slice.cmp.from = it->cmp_it.from;
25591 glyph->slice.cmp.to = it->cmp_it.to - 1;
25593 glyph->avoid_cursor_p = it->avoid_cursor_p;
25594 glyph->multibyte_p = it->multibyte_p;
25595 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25597 /* In R2L rows, the left and the right box edges need to be
25598 drawn in reverse direction. */
25599 glyph->right_box_line_p = it->start_of_box_run_p;
25600 glyph->left_box_line_p = it->end_of_box_run_p;
25602 else
25604 glyph->left_box_line_p = it->start_of_box_run_p;
25605 glyph->right_box_line_p = it->end_of_box_run_p;
25607 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25608 || it->phys_descent > it->descent);
25609 glyph->padding_p = false;
25610 glyph->glyph_not_available_p = false;
25611 glyph->face_id = it->face_id;
25612 glyph->font_type = FONT_TYPE_UNKNOWN;
25613 if (it->bidi_p)
25615 glyph->resolved_level = it->bidi_it.resolved_level;
25616 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25617 glyph->bidi_type = it->bidi_it.type;
25619 ++it->glyph_row->used[area];
25621 else
25622 IT_EXPAND_MATRIX_WIDTH (it, area);
25626 /* Change IT->ascent and IT->height according to the setting of
25627 IT->voffset. */
25629 static void
25630 take_vertical_position_into_account (struct it *it)
25632 if (it->voffset)
25634 if (it->voffset < 0)
25635 /* Increase the ascent so that we can display the text higher
25636 in the line. */
25637 it->ascent -= it->voffset;
25638 else
25639 /* Increase the descent so that we can display the text lower
25640 in the line. */
25641 it->descent += it->voffset;
25646 /* Produce glyphs/get display metrics for the image IT is loaded with.
25647 See the description of struct display_iterator in dispextern.h for
25648 an overview of struct display_iterator. */
25650 static void
25651 produce_image_glyph (struct it *it)
25653 struct image *img;
25654 struct face *face;
25655 int glyph_ascent, crop;
25656 struct glyph_slice slice;
25658 eassert (it->what == IT_IMAGE);
25660 face = FACE_FROM_ID (it->f, it->face_id);
25661 eassert (face);
25662 /* Make sure X resources of the face is loaded. */
25663 prepare_face_for_display (it->f, face);
25665 if (it->image_id < 0)
25667 /* Fringe bitmap. */
25668 it->ascent = it->phys_ascent = 0;
25669 it->descent = it->phys_descent = 0;
25670 it->pixel_width = 0;
25671 it->nglyphs = 0;
25672 return;
25675 img = IMAGE_FROM_ID (it->f, it->image_id);
25676 eassert (img);
25677 /* Make sure X resources of the image is loaded. */
25678 prepare_image_for_display (it->f, img);
25680 slice.x = slice.y = 0;
25681 slice.width = img->width;
25682 slice.height = img->height;
25684 if (INTEGERP (it->slice.x))
25685 slice.x = XINT (it->slice.x);
25686 else if (FLOATP (it->slice.x))
25687 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
25689 if (INTEGERP (it->slice.y))
25690 slice.y = XINT (it->slice.y);
25691 else if (FLOATP (it->slice.y))
25692 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
25694 if (INTEGERP (it->slice.width))
25695 slice.width = XINT (it->slice.width);
25696 else if (FLOATP (it->slice.width))
25697 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
25699 if (INTEGERP (it->slice.height))
25700 slice.height = XINT (it->slice.height);
25701 else if (FLOATP (it->slice.height))
25702 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
25704 if (slice.x >= img->width)
25705 slice.x = img->width;
25706 if (slice.y >= img->height)
25707 slice.y = img->height;
25708 if (slice.x + slice.width >= img->width)
25709 slice.width = img->width - slice.x;
25710 if (slice.y + slice.height > img->height)
25711 slice.height = img->height - slice.y;
25713 if (slice.width == 0 || slice.height == 0)
25714 return;
25716 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
25718 it->descent = slice.height - glyph_ascent;
25719 if (slice.y == 0)
25720 it->descent += img->vmargin;
25721 if (slice.y + slice.height == img->height)
25722 it->descent += img->vmargin;
25723 it->phys_descent = it->descent;
25725 it->pixel_width = slice.width;
25726 if (slice.x == 0)
25727 it->pixel_width += img->hmargin;
25728 if (slice.x + slice.width == img->width)
25729 it->pixel_width += img->hmargin;
25731 /* It's quite possible for images to have an ascent greater than
25732 their height, so don't get confused in that case. */
25733 if (it->descent < 0)
25734 it->descent = 0;
25736 it->nglyphs = 1;
25738 if (face->box != FACE_NO_BOX)
25740 if (face->box_line_width > 0)
25742 if (slice.y == 0)
25743 it->ascent += face->box_line_width;
25744 if (slice.y + slice.height == img->height)
25745 it->descent += face->box_line_width;
25748 if (it->start_of_box_run_p && slice.x == 0)
25749 it->pixel_width += eabs (face->box_line_width);
25750 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
25751 it->pixel_width += eabs (face->box_line_width);
25754 take_vertical_position_into_account (it);
25756 /* Automatically crop wide image glyphs at right edge so we can
25757 draw the cursor on same display row. */
25758 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
25759 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
25761 it->pixel_width -= crop;
25762 slice.width -= crop;
25765 if (it->glyph_row)
25767 struct glyph *glyph;
25768 enum glyph_row_area area = it->area;
25770 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25771 if (it->glyph_row->reversed_p)
25773 struct glyph *g;
25775 /* Make room for the new glyph. */
25776 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25777 g[1] = *g;
25778 glyph = it->glyph_row->glyphs[it->area];
25780 if (glyph < it->glyph_row->glyphs[area + 1])
25782 glyph->charpos = CHARPOS (it->position);
25783 glyph->object = it->object;
25784 glyph->pixel_width = it->pixel_width;
25785 glyph->ascent = glyph_ascent;
25786 glyph->descent = it->descent;
25787 glyph->voffset = it->voffset;
25788 glyph->type = IMAGE_GLYPH;
25789 glyph->avoid_cursor_p = it->avoid_cursor_p;
25790 glyph->multibyte_p = it->multibyte_p;
25791 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25793 /* In R2L rows, the left and the right box edges need to be
25794 drawn in reverse direction. */
25795 glyph->right_box_line_p = it->start_of_box_run_p;
25796 glyph->left_box_line_p = it->end_of_box_run_p;
25798 else
25800 glyph->left_box_line_p = it->start_of_box_run_p;
25801 glyph->right_box_line_p = it->end_of_box_run_p;
25803 glyph->overlaps_vertically_p = false;
25804 glyph->padding_p = false;
25805 glyph->glyph_not_available_p = false;
25806 glyph->face_id = it->face_id;
25807 glyph->u.img_id = img->id;
25808 glyph->slice.img = slice;
25809 glyph->font_type = FONT_TYPE_UNKNOWN;
25810 if (it->bidi_p)
25812 glyph->resolved_level = it->bidi_it.resolved_level;
25813 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25814 glyph->bidi_type = it->bidi_it.type;
25816 ++it->glyph_row->used[area];
25818 else
25819 IT_EXPAND_MATRIX_WIDTH (it, area);
25824 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25825 of the glyph, WIDTH and HEIGHT are the width and height of the
25826 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25828 static void
25829 append_stretch_glyph (struct it *it, Lisp_Object object,
25830 int width, int height, int ascent)
25832 struct glyph *glyph;
25833 enum glyph_row_area area = it->area;
25835 eassert (ascent >= 0 && ascent <= height);
25837 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25838 if (glyph < it->glyph_row->glyphs[area + 1])
25840 /* If the glyph row is reversed, we need to prepend the glyph
25841 rather than append it. */
25842 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25844 struct glyph *g;
25846 /* Make room for the additional glyph. */
25847 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25848 g[1] = *g;
25849 glyph = it->glyph_row->glyphs[area];
25851 /* Decrease the width of the first glyph of the row that
25852 begins before first_visible_x (e.g., due to hscroll).
25853 This is so the overall width of the row becomes smaller
25854 by the scroll amount, and the stretch glyph appended by
25855 extend_face_to_end_of_line will be wider, to shift the
25856 row glyphs to the right. (In L2R rows, the corresponding
25857 left-shift effect is accomplished by setting row->x to a
25858 negative value, which won't work with R2L rows.)
25860 This must leave us with a positive value of WIDTH, since
25861 otherwise the call to move_it_in_display_line_to at the
25862 beginning of display_line would have got past the entire
25863 first glyph, and then it->current_x would have been
25864 greater or equal to it->first_visible_x. */
25865 if (it->current_x < it->first_visible_x)
25866 width -= it->first_visible_x - it->current_x;
25867 eassert (width > 0);
25869 glyph->charpos = CHARPOS (it->position);
25870 glyph->object = object;
25871 glyph->pixel_width = width;
25872 glyph->ascent = ascent;
25873 glyph->descent = height - ascent;
25874 glyph->voffset = it->voffset;
25875 glyph->type = STRETCH_GLYPH;
25876 glyph->avoid_cursor_p = it->avoid_cursor_p;
25877 glyph->multibyte_p = it->multibyte_p;
25878 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25880 /* In R2L rows, the left and the right box edges need to be
25881 drawn in reverse direction. */
25882 glyph->right_box_line_p = it->start_of_box_run_p;
25883 glyph->left_box_line_p = it->end_of_box_run_p;
25885 else
25887 glyph->left_box_line_p = it->start_of_box_run_p;
25888 glyph->right_box_line_p = it->end_of_box_run_p;
25890 glyph->overlaps_vertically_p = false;
25891 glyph->padding_p = false;
25892 glyph->glyph_not_available_p = false;
25893 glyph->face_id = it->face_id;
25894 glyph->u.stretch.ascent = ascent;
25895 glyph->u.stretch.height = height;
25896 glyph->slice.img = null_glyph_slice;
25897 glyph->font_type = FONT_TYPE_UNKNOWN;
25898 if (it->bidi_p)
25900 glyph->resolved_level = it->bidi_it.resolved_level;
25901 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25902 glyph->bidi_type = it->bidi_it.type;
25904 else
25906 glyph->resolved_level = 0;
25907 glyph->bidi_type = UNKNOWN_BT;
25909 ++it->glyph_row->used[area];
25911 else
25912 IT_EXPAND_MATRIX_WIDTH (it, area);
25915 #endif /* HAVE_WINDOW_SYSTEM */
25917 /* Produce a stretch glyph for iterator IT. IT->object is the value
25918 of the glyph property displayed. The value must be a list
25919 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25920 being recognized:
25922 1. `:width WIDTH' specifies that the space should be WIDTH *
25923 canonical char width wide. WIDTH may be an integer or floating
25924 point number.
25926 2. `:relative-width FACTOR' specifies that the width of the stretch
25927 should be computed from the width of the first character having the
25928 `glyph' property, and should be FACTOR times that width.
25930 3. `:align-to HPOS' specifies that the space should be wide enough
25931 to reach HPOS, a value in canonical character units.
25933 Exactly one of the above pairs must be present.
25935 4. `:height HEIGHT' specifies that the height of the stretch produced
25936 should be HEIGHT, measured in canonical character units.
25938 5. `:relative-height FACTOR' specifies that the height of the
25939 stretch should be FACTOR times the height of the characters having
25940 the glyph property.
25942 Either none or exactly one of 4 or 5 must be present.
25944 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25945 of the stretch should be used for the ascent of the stretch.
25946 ASCENT must be in the range 0 <= ASCENT <= 100. */
25948 void
25949 produce_stretch_glyph (struct it *it)
25951 /* (space :width WIDTH :height HEIGHT ...) */
25952 Lisp_Object prop, plist;
25953 int width = 0, height = 0, align_to = -1;
25954 bool zero_width_ok_p = false;
25955 double tem;
25956 struct font *font = NULL;
25958 #ifdef HAVE_WINDOW_SYSTEM
25959 int ascent = 0;
25960 bool zero_height_ok_p = false;
25962 if (FRAME_WINDOW_P (it->f))
25964 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25965 font = face->font ? face->font : FRAME_FONT (it->f);
25966 prepare_face_for_display (it->f, face);
25968 #endif
25970 /* List should start with `space'. */
25971 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
25972 plist = XCDR (it->object);
25974 /* Compute the width of the stretch. */
25975 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
25976 && calc_pixel_width_or_height (&tem, it, prop, font, true, 0))
25978 /* Absolute width `:width WIDTH' specified and valid. */
25979 zero_width_ok_p = true;
25980 width = (int)tem;
25982 #ifdef HAVE_WINDOW_SYSTEM
25983 else if (FRAME_WINDOW_P (it->f)
25984 && (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0))
25986 /* Relative width `:relative-width FACTOR' specified and valid.
25987 Compute the width of the characters having the `glyph'
25988 property. */
25989 struct it it2;
25990 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
25992 it2 = *it;
25993 if (it->multibyte_p)
25994 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
25995 else
25997 it2.c = it2.char_to_display = *p, it2.len = 1;
25998 if (! ASCII_CHAR_P (it2.c))
25999 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
26002 it2.glyph_row = NULL;
26003 it2.what = IT_CHARACTER;
26004 x_produce_glyphs (&it2);
26005 width = NUMVAL (prop) * it2.pixel_width;
26007 #endif /* HAVE_WINDOW_SYSTEM */
26008 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
26009 && calc_pixel_width_or_height (&tem, it, prop, font, true,
26010 &align_to))
26012 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
26013 align_to = (align_to < 0
26015 : align_to - window_box_left_offset (it->w, TEXT_AREA));
26016 else if (align_to < 0)
26017 align_to = window_box_left_offset (it->w, TEXT_AREA);
26018 width = max (0, (int)tem + align_to - it->current_x);
26019 zero_width_ok_p = true;
26021 else
26022 /* Nothing specified -> width defaults to canonical char width. */
26023 width = FRAME_COLUMN_WIDTH (it->f);
26025 if (width <= 0 && (width < 0 || !zero_width_ok_p))
26026 width = 1;
26028 #ifdef HAVE_WINDOW_SYSTEM
26029 /* Compute height. */
26030 if (FRAME_WINDOW_P (it->f))
26032 int default_height = normal_char_height (font, ' ');
26034 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
26035 && calc_pixel_width_or_height (&tem, it, prop, font, false, 0))
26037 height = (int)tem;
26038 zero_height_ok_p = true;
26040 else if (prop = Fplist_get (plist, QCrelative_height),
26041 NUMVAL (prop) > 0)
26042 height = default_height * NUMVAL (prop);
26043 else
26044 height = default_height;
26046 if (height <= 0 && (height < 0 || !zero_height_ok_p))
26047 height = 1;
26049 /* Compute percentage of height used for ascent. If
26050 `:ascent ASCENT' is present and valid, use that. Otherwise,
26051 derive the ascent from the font in use. */
26052 if (prop = Fplist_get (plist, QCascent),
26053 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
26054 ascent = height * NUMVAL (prop) / 100.0;
26055 else if (!NILP (prop)
26056 && calc_pixel_width_or_height (&tem, it, prop, font, false, 0))
26057 ascent = min (max (0, (int)tem), height);
26058 else
26059 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
26061 else
26062 #endif /* HAVE_WINDOW_SYSTEM */
26063 height = 1;
26065 if (width > 0 && it->line_wrap != TRUNCATE
26066 && it->current_x + width > it->last_visible_x)
26068 width = it->last_visible_x - it->current_x;
26069 #ifdef HAVE_WINDOW_SYSTEM
26070 /* Subtract one more pixel from the stretch width, but only on
26071 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26072 width -= FRAME_WINDOW_P (it->f);
26073 #endif
26076 if (width > 0 && height > 0 && it->glyph_row)
26078 Lisp_Object o_object = it->object;
26079 Lisp_Object object = it->stack[it->sp - 1].string;
26080 int n = width;
26082 if (!STRINGP (object))
26083 object = it->w->contents;
26084 #ifdef HAVE_WINDOW_SYSTEM
26085 if (FRAME_WINDOW_P (it->f))
26086 append_stretch_glyph (it, object, width, height, ascent);
26087 else
26088 #endif
26090 it->object = object;
26091 it->char_to_display = ' ';
26092 it->pixel_width = it->len = 1;
26093 while (n--)
26094 tty_append_glyph (it);
26095 it->object = o_object;
26099 it->pixel_width = width;
26100 #ifdef HAVE_WINDOW_SYSTEM
26101 if (FRAME_WINDOW_P (it->f))
26103 it->ascent = it->phys_ascent = ascent;
26104 it->descent = it->phys_descent = height - it->ascent;
26105 it->nglyphs = width > 0 && height > 0;
26106 take_vertical_position_into_account (it);
26108 else
26109 #endif
26110 it->nglyphs = width;
26113 /* Get information about special display element WHAT in an
26114 environment described by IT. WHAT is one of IT_TRUNCATION or
26115 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26116 non-null glyph_row member. This function ensures that fields like
26117 face_id, c, len of IT are left untouched. */
26119 static void
26120 produce_special_glyphs (struct it *it, enum display_element_type what)
26122 struct it temp_it;
26123 Lisp_Object gc;
26124 GLYPH glyph;
26126 temp_it = *it;
26127 temp_it.object = Qnil;
26128 memset (&temp_it.current, 0, sizeof temp_it.current);
26130 if (what == IT_CONTINUATION)
26132 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26133 if (it->bidi_it.paragraph_dir == R2L)
26134 SET_GLYPH_FROM_CHAR (glyph, '/');
26135 else
26136 SET_GLYPH_FROM_CHAR (glyph, '\\');
26137 if (it->dp
26138 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
26140 /* FIXME: Should we mirror GC for R2L lines? */
26141 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
26142 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
26145 else if (what == IT_TRUNCATION)
26147 /* Truncation glyph. */
26148 SET_GLYPH_FROM_CHAR (glyph, '$');
26149 if (it->dp
26150 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
26152 /* FIXME: Should we mirror GC for R2L lines? */
26153 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
26154 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
26157 else
26158 emacs_abort ();
26160 #ifdef HAVE_WINDOW_SYSTEM
26161 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26162 is turned off, we precede the truncation/continuation glyphs by a
26163 stretch glyph whose width is computed such that these special
26164 glyphs are aligned at the window margin, even when very different
26165 fonts are used in different glyph rows. */
26166 if (FRAME_WINDOW_P (temp_it.f)
26167 /* init_iterator calls this with it->glyph_row == NULL, and it
26168 wants only the pixel width of the truncation/continuation
26169 glyphs. */
26170 && temp_it.glyph_row
26171 /* insert_left_trunc_glyphs calls us at the beginning of the
26172 row, and it has its own calculation of the stretch glyph
26173 width. */
26174 && temp_it.glyph_row->used[TEXT_AREA] > 0
26175 && (temp_it.glyph_row->reversed_p
26176 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
26177 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
26179 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
26181 if (stretch_width > 0)
26183 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
26184 struct font *font =
26185 face->font ? face->font : FRAME_FONT (temp_it.f);
26186 int stretch_ascent =
26187 (((temp_it.ascent + temp_it.descent)
26188 * FONT_BASE (font)) / FONT_HEIGHT (font));
26190 append_stretch_glyph (&temp_it, Qnil, stretch_width,
26191 temp_it.ascent + temp_it.descent,
26192 stretch_ascent);
26195 #endif
26197 temp_it.dp = NULL;
26198 temp_it.what = IT_CHARACTER;
26199 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
26200 temp_it.face_id = GLYPH_FACE (glyph);
26201 temp_it.len = CHAR_BYTES (temp_it.c);
26203 PRODUCE_GLYPHS (&temp_it);
26204 it->pixel_width = temp_it.pixel_width;
26205 it->nglyphs = temp_it.nglyphs;
26208 #ifdef HAVE_WINDOW_SYSTEM
26210 /* Calculate line-height and line-spacing properties.
26211 An integer value specifies explicit pixel value.
26212 A float value specifies relative value to current face height.
26213 A cons (float . face-name) specifies relative value to
26214 height of specified face font.
26216 Returns height in pixels, or nil. */
26218 static Lisp_Object
26219 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
26220 int boff, bool override)
26222 Lisp_Object face_name = Qnil;
26223 int ascent, descent, height;
26225 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
26226 return val;
26228 if (CONSP (val))
26230 face_name = XCAR (val);
26231 val = XCDR (val);
26232 if (!NUMBERP (val))
26233 val = make_number (1);
26234 if (NILP (face_name))
26236 height = it->ascent + it->descent;
26237 goto scale;
26241 if (NILP (face_name))
26243 font = FRAME_FONT (it->f);
26244 boff = FRAME_BASELINE_OFFSET (it->f);
26246 else if (EQ (face_name, Qt))
26248 override = false;
26250 else
26252 int face_id;
26253 struct face *face;
26255 face_id = lookup_named_face (it->f, face_name, false);
26256 if (face_id < 0)
26257 return make_number (-1);
26259 face = FACE_FROM_ID (it->f, face_id);
26260 font = face->font;
26261 if (font == NULL)
26262 return make_number (-1);
26263 boff = font->baseline_offset;
26264 if (font->vertical_centering)
26265 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26268 normal_char_ascent_descent (font, -1, &ascent, &descent);
26270 if (override)
26272 it->override_ascent = ascent;
26273 it->override_descent = descent;
26274 it->override_boff = boff;
26277 height = ascent + descent;
26279 scale:
26280 if (FLOATP (val))
26281 height = (int)(XFLOAT_DATA (val) * height);
26282 else if (INTEGERP (val))
26283 height *= XINT (val);
26285 return make_number (height);
26289 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26290 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26291 and only if this is for a character for which no font was found.
26293 If the display method (it->glyphless_method) is
26294 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26295 length of the acronym or the hexadecimal string, UPPER_XOFF and
26296 UPPER_YOFF are pixel offsets for the upper part of the string,
26297 LOWER_XOFF and LOWER_YOFF are for the lower part.
26299 For the other display methods, LEN through LOWER_YOFF are zero. */
26301 static void
26302 append_glyphless_glyph (struct it *it, int face_id, bool for_no_font, int len,
26303 short upper_xoff, short upper_yoff,
26304 short lower_xoff, short lower_yoff)
26306 struct glyph *glyph;
26307 enum glyph_row_area area = it->area;
26309 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26310 if (glyph < it->glyph_row->glyphs[area + 1])
26312 /* If the glyph row is reversed, we need to prepend the glyph
26313 rather than append it. */
26314 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26316 struct glyph *g;
26318 /* Make room for the additional glyph. */
26319 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
26320 g[1] = *g;
26321 glyph = it->glyph_row->glyphs[area];
26323 glyph->charpos = CHARPOS (it->position);
26324 glyph->object = it->object;
26325 glyph->pixel_width = it->pixel_width;
26326 glyph->ascent = it->ascent;
26327 glyph->descent = it->descent;
26328 glyph->voffset = it->voffset;
26329 glyph->type = GLYPHLESS_GLYPH;
26330 glyph->u.glyphless.method = it->glyphless_method;
26331 glyph->u.glyphless.for_no_font = for_no_font;
26332 glyph->u.glyphless.len = len;
26333 glyph->u.glyphless.ch = it->c;
26334 glyph->slice.glyphless.upper_xoff = upper_xoff;
26335 glyph->slice.glyphless.upper_yoff = upper_yoff;
26336 glyph->slice.glyphless.lower_xoff = lower_xoff;
26337 glyph->slice.glyphless.lower_yoff = lower_yoff;
26338 glyph->avoid_cursor_p = it->avoid_cursor_p;
26339 glyph->multibyte_p = it->multibyte_p;
26340 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26342 /* In R2L rows, the left and the right box edges need to be
26343 drawn in reverse direction. */
26344 glyph->right_box_line_p = it->start_of_box_run_p;
26345 glyph->left_box_line_p = it->end_of_box_run_p;
26347 else
26349 glyph->left_box_line_p = it->start_of_box_run_p;
26350 glyph->right_box_line_p = it->end_of_box_run_p;
26352 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
26353 || it->phys_descent > it->descent);
26354 glyph->padding_p = false;
26355 glyph->glyph_not_available_p = false;
26356 glyph->face_id = face_id;
26357 glyph->font_type = FONT_TYPE_UNKNOWN;
26358 if (it->bidi_p)
26360 glyph->resolved_level = it->bidi_it.resolved_level;
26361 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26362 glyph->bidi_type = it->bidi_it.type;
26364 ++it->glyph_row->used[area];
26366 else
26367 IT_EXPAND_MATRIX_WIDTH (it, area);
26371 /* Produce a glyph for a glyphless character for iterator IT.
26372 IT->glyphless_method specifies which method to use for displaying
26373 the character. See the description of enum
26374 glyphless_display_method in dispextern.h for the detail.
26376 FOR_NO_FONT is true if and only if this is for a character for
26377 which no font was found. ACRONYM, if non-nil, is an acronym string
26378 for the character. */
26380 static void
26381 produce_glyphless_glyph (struct it *it, bool for_no_font, Lisp_Object acronym)
26383 int face_id;
26384 struct face *face;
26385 struct font *font;
26386 int base_width, base_height, width, height;
26387 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
26388 int len;
26390 /* Get the metrics of the base font. We always refer to the current
26391 ASCII face. */
26392 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
26393 font = face->font ? face->font : FRAME_FONT (it->f);
26394 normal_char_ascent_descent (font, -1, &it->ascent, &it->descent);
26395 it->ascent += font->baseline_offset;
26396 it->descent -= font->baseline_offset;
26397 base_height = it->ascent + it->descent;
26398 base_width = font->average_width;
26400 face_id = merge_glyphless_glyph_face (it);
26402 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
26404 it->pixel_width = THIN_SPACE_WIDTH;
26405 len = 0;
26406 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26408 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
26410 width = CHAR_WIDTH (it->c);
26411 if (width == 0)
26412 width = 1;
26413 else if (width > 4)
26414 width = 4;
26415 it->pixel_width = base_width * width;
26416 len = 0;
26417 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26419 else
26421 char buf[7];
26422 const char *str;
26423 unsigned int code[6];
26424 int upper_len;
26425 int ascent, descent;
26426 struct font_metrics metrics_upper, metrics_lower;
26428 face = FACE_FROM_ID (it->f, face_id);
26429 font = face->font ? face->font : FRAME_FONT (it->f);
26430 prepare_face_for_display (it->f, face);
26432 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
26434 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
26435 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
26436 if (CONSP (acronym))
26437 acronym = XCAR (acronym);
26438 str = STRINGP (acronym) ? SSDATA (acronym) : "";
26440 else
26442 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
26443 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c + 0u);
26444 str = buf;
26446 for (len = 0; str[len] && ASCII_CHAR_P (str[len]) && len < 6; len++)
26447 code[len] = font->driver->encode_char (font, str[len]);
26448 upper_len = (len + 1) / 2;
26449 font->driver->text_extents (font, code, upper_len,
26450 &metrics_upper);
26451 font->driver->text_extents (font, code + upper_len, len - upper_len,
26452 &metrics_lower);
26456 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26457 width = max (metrics_upper.width, metrics_lower.width) + 4;
26458 upper_xoff = upper_yoff = 2; /* the typical case */
26459 if (base_width >= width)
26461 /* Align the upper to the left, the lower to the right. */
26462 it->pixel_width = base_width;
26463 lower_xoff = base_width - 2 - metrics_lower.width;
26465 else
26467 /* Center the shorter one. */
26468 it->pixel_width = width;
26469 if (metrics_upper.width >= metrics_lower.width)
26470 lower_xoff = (width - metrics_lower.width) / 2;
26471 else
26473 /* FIXME: This code doesn't look right. It formerly was
26474 missing the "lower_xoff = 0;", which couldn't have
26475 been right since it left lower_xoff uninitialized. */
26476 lower_xoff = 0;
26477 upper_xoff = (width - metrics_upper.width) / 2;
26481 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26482 top, bottom, and between upper and lower strings. */
26483 height = (metrics_upper.ascent + metrics_upper.descent
26484 + metrics_lower.ascent + metrics_lower.descent) + 5;
26485 /* Center vertically.
26486 H:base_height, D:base_descent
26487 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26489 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26490 descent = D - H/2 + h/2;
26491 lower_yoff = descent - 2 - ld;
26492 upper_yoff = lower_yoff - la - 1 - ud; */
26493 ascent = - (it->descent - (base_height + height + 1) / 2);
26494 descent = it->descent - (base_height - height) / 2;
26495 lower_yoff = descent - 2 - metrics_lower.descent;
26496 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
26497 - metrics_upper.descent);
26498 /* Don't make the height shorter than the base height. */
26499 if (height > base_height)
26501 it->ascent = ascent;
26502 it->descent = descent;
26506 it->phys_ascent = it->ascent;
26507 it->phys_descent = it->descent;
26508 if (it->glyph_row)
26509 append_glyphless_glyph (it, face_id, for_no_font, len,
26510 upper_xoff, upper_yoff,
26511 lower_xoff, lower_yoff);
26512 it->nglyphs = 1;
26513 take_vertical_position_into_account (it);
26517 /* RIF:
26518 Produce glyphs/get display metrics for the display element IT is
26519 loaded with. See the description of struct it in dispextern.h
26520 for an overview of struct it. */
26522 void
26523 x_produce_glyphs (struct it *it)
26525 int extra_line_spacing = it->extra_line_spacing;
26527 it->glyph_not_available_p = false;
26529 if (it->what == IT_CHARACTER)
26531 XChar2b char2b;
26532 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26533 struct font *font = face->font;
26534 struct font_metrics *pcm = NULL;
26535 int boff; /* Baseline offset. */
26537 if (font == NULL)
26539 /* When no suitable font is found, display this character by
26540 the method specified in the first extra slot of
26541 Vglyphless_char_display. */
26542 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
26544 eassert (it->what == IT_GLYPHLESS);
26545 produce_glyphless_glyph (it, true,
26546 STRINGP (acronym) ? acronym : Qnil);
26547 goto done;
26550 boff = font->baseline_offset;
26551 if (font->vertical_centering)
26552 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26554 if (it->char_to_display != '\n' && it->char_to_display != '\t')
26556 it->nglyphs = 1;
26558 if (it->override_ascent >= 0)
26560 it->ascent = it->override_ascent;
26561 it->descent = it->override_descent;
26562 boff = it->override_boff;
26564 else
26566 it->ascent = FONT_BASE (font) + boff;
26567 it->descent = FONT_DESCENT (font) - boff;
26570 if (get_char_glyph_code (it->char_to_display, font, &char2b))
26572 pcm = get_per_char_metric (font, &char2b);
26573 if (pcm->width == 0
26574 && pcm->rbearing == 0 && pcm->lbearing == 0)
26575 pcm = NULL;
26578 if (pcm)
26580 it->phys_ascent = pcm->ascent + boff;
26581 it->phys_descent = pcm->descent - boff;
26582 it->pixel_width = pcm->width;
26583 /* Don't use font-global values for ascent and descent
26584 if they result in an exceedingly large line height. */
26585 if (it->override_ascent < 0)
26587 if (FONT_TOO_HIGH (font))
26589 it->ascent = it->phys_ascent;
26590 it->descent = it->phys_descent;
26591 /* These limitations are enforced by an
26592 assertion near the end of this function. */
26593 if (it->ascent < 0)
26594 it->ascent = 0;
26595 if (it->descent < 0)
26596 it->descent = 0;
26600 else
26602 it->glyph_not_available_p = true;
26603 it->phys_ascent = it->ascent;
26604 it->phys_descent = it->descent;
26605 it->pixel_width = font->space_width;
26608 if (it->constrain_row_ascent_descent_p)
26610 if (it->descent > it->max_descent)
26612 it->ascent += it->descent - it->max_descent;
26613 it->descent = it->max_descent;
26615 if (it->ascent > it->max_ascent)
26617 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26618 it->ascent = it->max_ascent;
26620 it->phys_ascent = min (it->phys_ascent, it->ascent);
26621 it->phys_descent = min (it->phys_descent, it->descent);
26622 extra_line_spacing = 0;
26625 /* If this is a space inside a region of text with
26626 `space-width' property, change its width. */
26627 bool stretched_p
26628 = it->char_to_display == ' ' && !NILP (it->space_width);
26629 if (stretched_p)
26630 it->pixel_width *= XFLOATINT (it->space_width);
26632 /* If face has a box, add the box thickness to the character
26633 height. If character has a box line to the left and/or
26634 right, add the box line width to the character's width. */
26635 if (face->box != FACE_NO_BOX)
26637 int thick = face->box_line_width;
26639 if (thick > 0)
26641 it->ascent += thick;
26642 it->descent += thick;
26644 else
26645 thick = -thick;
26647 if (it->start_of_box_run_p)
26648 it->pixel_width += thick;
26649 if (it->end_of_box_run_p)
26650 it->pixel_width += thick;
26653 /* If face has an overline, add the height of the overline
26654 (1 pixel) and a 1 pixel margin to the character height. */
26655 if (face->overline_p)
26656 it->ascent += overline_margin;
26658 if (it->constrain_row_ascent_descent_p)
26660 if (it->ascent > it->max_ascent)
26661 it->ascent = it->max_ascent;
26662 if (it->descent > it->max_descent)
26663 it->descent = it->max_descent;
26666 take_vertical_position_into_account (it);
26668 /* If we have to actually produce glyphs, do it. */
26669 if (it->glyph_row)
26671 if (stretched_p)
26673 /* Translate a space with a `space-width' property
26674 into a stretch glyph. */
26675 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
26676 / FONT_HEIGHT (font));
26677 append_stretch_glyph (it, it->object, it->pixel_width,
26678 it->ascent + it->descent, ascent);
26680 else
26681 append_glyph (it);
26683 /* If characters with lbearing or rbearing are displayed
26684 in this line, record that fact in a flag of the
26685 glyph row. This is used to optimize X output code. */
26686 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
26687 it->glyph_row->contains_overlapping_glyphs_p = true;
26689 if (! stretched_p && it->pixel_width == 0)
26690 /* We assure that all visible glyphs have at least 1-pixel
26691 width. */
26692 it->pixel_width = 1;
26694 else if (it->char_to_display == '\n')
26696 /* A newline has no width, but we need the height of the
26697 line. But if previous part of the line sets a height,
26698 don't increase that height. */
26700 Lisp_Object height;
26701 Lisp_Object total_height = Qnil;
26703 it->override_ascent = -1;
26704 it->pixel_width = 0;
26705 it->nglyphs = 0;
26707 height = get_it_property (it, Qline_height);
26708 /* Split (line-height total-height) list. */
26709 if (CONSP (height)
26710 && CONSP (XCDR (height))
26711 && NILP (XCDR (XCDR (height))))
26713 total_height = XCAR (XCDR (height));
26714 height = XCAR (height);
26716 height = calc_line_height_property (it, height, font, boff, true);
26718 if (it->override_ascent >= 0)
26720 it->ascent = it->override_ascent;
26721 it->descent = it->override_descent;
26722 boff = it->override_boff;
26724 else
26726 if (FONT_TOO_HIGH (font))
26728 it->ascent = font->pixel_size + boff - 1;
26729 it->descent = -boff + 1;
26730 if (it->descent < 0)
26731 it->descent = 0;
26733 else
26735 it->ascent = FONT_BASE (font) + boff;
26736 it->descent = FONT_DESCENT (font) - boff;
26740 if (EQ (height, Qt))
26742 if (it->descent > it->max_descent)
26744 it->ascent += it->descent - it->max_descent;
26745 it->descent = it->max_descent;
26747 if (it->ascent > it->max_ascent)
26749 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26750 it->ascent = it->max_ascent;
26752 it->phys_ascent = min (it->phys_ascent, it->ascent);
26753 it->phys_descent = min (it->phys_descent, it->descent);
26754 it->constrain_row_ascent_descent_p = true;
26755 extra_line_spacing = 0;
26757 else
26759 Lisp_Object spacing;
26761 it->phys_ascent = it->ascent;
26762 it->phys_descent = it->descent;
26764 if ((it->max_ascent > 0 || it->max_descent > 0)
26765 && face->box != FACE_NO_BOX
26766 && face->box_line_width > 0)
26768 it->ascent += face->box_line_width;
26769 it->descent += face->box_line_width;
26771 if (!NILP (height)
26772 && XINT (height) > it->ascent + it->descent)
26773 it->ascent = XINT (height) - it->descent;
26775 if (!NILP (total_height))
26776 spacing = calc_line_height_property (it, total_height, font,
26777 boff, false);
26778 else
26780 spacing = get_it_property (it, Qline_spacing);
26781 spacing = calc_line_height_property (it, spacing, font,
26782 boff, false);
26784 if (INTEGERP (spacing))
26786 extra_line_spacing = XINT (spacing);
26787 if (!NILP (total_height))
26788 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
26792 else /* i.e. (it->char_to_display == '\t') */
26794 if (font->space_width > 0)
26796 int tab_width = it->tab_width * font->space_width;
26797 int x = it->current_x + it->continuation_lines_width;
26798 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
26800 /* If the distance from the current position to the next tab
26801 stop is less than a space character width, use the
26802 tab stop after that. */
26803 if (next_tab_x - x < font->space_width)
26804 next_tab_x += tab_width;
26806 it->pixel_width = next_tab_x - x;
26807 it->nglyphs = 1;
26808 if (FONT_TOO_HIGH (font))
26810 if (get_char_glyph_code (' ', font, &char2b))
26812 pcm = get_per_char_metric (font, &char2b);
26813 if (pcm->width == 0
26814 && pcm->rbearing == 0 && pcm->lbearing == 0)
26815 pcm = NULL;
26818 if (pcm)
26820 it->ascent = pcm->ascent + boff;
26821 it->descent = pcm->descent - boff;
26823 else
26825 it->ascent = font->pixel_size + boff - 1;
26826 it->descent = -boff + 1;
26828 if (it->ascent < 0)
26829 it->ascent = 0;
26830 if (it->descent < 0)
26831 it->descent = 0;
26833 else
26835 it->ascent = FONT_BASE (font) + boff;
26836 it->descent = FONT_DESCENT (font) - boff;
26838 it->phys_ascent = it->ascent;
26839 it->phys_descent = it->descent;
26841 if (it->glyph_row)
26843 append_stretch_glyph (it, it->object, it->pixel_width,
26844 it->ascent + it->descent, it->ascent);
26847 else
26849 it->pixel_width = 0;
26850 it->nglyphs = 1;
26854 if (FONT_TOO_HIGH (font))
26856 int font_ascent, font_descent;
26858 /* For very large fonts, where we ignore the declared font
26859 dimensions, and go by per-character metrics instead,
26860 don't let the row ascent and descent values (and the row
26861 height computed from them) be smaller than the "normal"
26862 character metrics. This avoids unpleasant effects
26863 whereby lines on display would change their height
26864 depending on which characters are shown. */
26865 normal_char_ascent_descent (font, -1, &font_ascent, &font_descent);
26866 it->max_ascent = max (it->max_ascent, font_ascent);
26867 it->max_descent = max (it->max_descent, font_descent);
26870 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
26872 /* A static composition.
26874 Note: A composition is represented as one glyph in the
26875 glyph matrix. There are no padding glyphs.
26877 Important note: pixel_width, ascent, and descent are the
26878 values of what is drawn by draw_glyphs (i.e. the values of
26879 the overall glyphs composed). */
26880 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26881 int boff; /* baseline offset */
26882 struct composition *cmp = composition_table[it->cmp_it.id];
26883 int glyph_len = cmp->glyph_len;
26884 struct font *font = face->font;
26886 it->nglyphs = 1;
26888 /* If we have not yet calculated pixel size data of glyphs of
26889 the composition for the current face font, calculate them
26890 now. Theoretically, we have to check all fonts for the
26891 glyphs, but that requires much time and memory space. So,
26892 here we check only the font of the first glyph. This may
26893 lead to incorrect display, but it's very rare, and C-l
26894 (recenter-top-bottom) can correct the display anyway. */
26895 if (! cmp->font || cmp->font != font)
26897 /* Ascent and descent of the font of the first character
26898 of this composition (adjusted by baseline offset).
26899 Ascent and descent of overall glyphs should not be less
26900 than these, respectively. */
26901 int font_ascent, font_descent, font_height;
26902 /* Bounding box of the overall glyphs. */
26903 int leftmost, rightmost, lowest, highest;
26904 int lbearing, rbearing;
26905 int i, width, ascent, descent;
26906 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26907 XChar2b char2b;
26908 struct font_metrics *pcm;
26909 ptrdiff_t pos;
26911 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
26912 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
26913 break;
26914 bool right_padded = glyph_len < cmp->glyph_len;
26915 for (i = 0; i < glyph_len; i++)
26917 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
26918 break;
26919 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26921 bool left_padded = i > 0;
26923 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
26924 : IT_CHARPOS (*it));
26925 /* If no suitable font is found, use the default font. */
26926 bool font_not_found_p = font == NULL;
26927 if (font_not_found_p)
26929 face = face->ascii_face;
26930 font = face->font;
26932 boff = font->baseline_offset;
26933 if (font->vertical_centering)
26934 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26935 normal_char_ascent_descent (font, -1, &font_ascent, &font_descent);
26936 font_ascent += boff;
26937 font_descent -= boff;
26938 font_height = font_ascent + font_descent;
26940 cmp->font = font;
26942 pcm = NULL;
26943 if (! font_not_found_p)
26945 get_char_face_and_encoding (it->f, c, it->face_id,
26946 &char2b, false);
26947 pcm = get_per_char_metric (font, &char2b);
26950 /* Initialize the bounding box. */
26951 if (pcm)
26953 width = cmp->glyph_len > 0 ? pcm->width : 0;
26954 ascent = pcm->ascent;
26955 descent = pcm->descent;
26956 lbearing = pcm->lbearing;
26957 rbearing = pcm->rbearing;
26959 else
26961 width = cmp->glyph_len > 0 ? font->space_width : 0;
26962 ascent = FONT_BASE (font);
26963 descent = FONT_DESCENT (font);
26964 lbearing = 0;
26965 rbearing = width;
26968 rightmost = width;
26969 leftmost = 0;
26970 lowest = - descent + boff;
26971 highest = ascent + boff;
26973 if (! font_not_found_p
26974 && font->default_ascent
26975 && CHAR_TABLE_P (Vuse_default_ascent)
26976 && !NILP (Faref (Vuse_default_ascent,
26977 make_number (it->char_to_display))))
26978 highest = font->default_ascent + boff;
26980 /* Draw the first glyph at the normal position. It may be
26981 shifted to right later if some other glyphs are drawn
26982 at the left. */
26983 cmp->offsets[i * 2] = 0;
26984 cmp->offsets[i * 2 + 1] = boff;
26985 cmp->lbearing = lbearing;
26986 cmp->rbearing = rbearing;
26988 /* Set cmp->offsets for the remaining glyphs. */
26989 for (i++; i < glyph_len; i++)
26991 int left, right, btm, top;
26992 int ch = COMPOSITION_GLYPH (cmp, i);
26993 int face_id;
26994 struct face *this_face;
26996 if (ch == '\t')
26997 ch = ' ';
26998 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
26999 this_face = FACE_FROM_ID (it->f, face_id);
27000 font = this_face->font;
27002 if (font == NULL)
27003 pcm = NULL;
27004 else
27006 get_char_face_and_encoding (it->f, ch, face_id,
27007 &char2b, false);
27008 pcm = get_per_char_metric (font, &char2b);
27010 if (! pcm)
27011 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
27012 else
27014 width = pcm->width;
27015 ascent = pcm->ascent;
27016 descent = pcm->descent;
27017 lbearing = pcm->lbearing;
27018 rbearing = pcm->rbearing;
27019 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
27021 /* Relative composition with or without
27022 alternate chars. */
27023 left = (leftmost + rightmost - width) / 2;
27024 btm = - descent + boff;
27025 if (font->relative_compose
27026 && (! CHAR_TABLE_P (Vignore_relative_composition)
27027 || NILP (Faref (Vignore_relative_composition,
27028 make_number (ch)))))
27031 if (- descent >= font->relative_compose)
27032 /* One extra pixel between two glyphs. */
27033 btm = highest + 1;
27034 else if (ascent <= 0)
27035 /* One extra pixel between two glyphs. */
27036 btm = lowest - 1 - ascent - descent;
27039 else
27041 /* A composition rule is specified by an integer
27042 value that encodes global and new reference
27043 points (GREF and NREF). GREF and NREF are
27044 specified by numbers as below:
27046 0---1---2 -- ascent
27050 9--10--11 -- center
27052 ---3---4---5--- baseline
27054 6---7---8 -- descent
27056 int rule = COMPOSITION_RULE (cmp, i);
27057 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
27059 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
27060 grefx = gref % 3, nrefx = nref % 3;
27061 grefy = gref / 3, nrefy = nref / 3;
27062 if (xoff)
27063 xoff = font_height * (xoff - 128) / 256;
27064 if (yoff)
27065 yoff = font_height * (yoff - 128) / 256;
27067 left = (leftmost
27068 + grefx * (rightmost - leftmost) / 2
27069 - nrefx * width / 2
27070 + xoff);
27072 btm = ((grefy == 0 ? highest
27073 : grefy == 1 ? 0
27074 : grefy == 2 ? lowest
27075 : (highest + lowest) / 2)
27076 - (nrefy == 0 ? ascent + descent
27077 : nrefy == 1 ? descent - boff
27078 : nrefy == 2 ? 0
27079 : (ascent + descent) / 2)
27080 + yoff);
27083 cmp->offsets[i * 2] = left;
27084 cmp->offsets[i * 2 + 1] = btm + descent;
27086 /* Update the bounding box of the overall glyphs. */
27087 if (width > 0)
27089 right = left + width;
27090 if (left < leftmost)
27091 leftmost = left;
27092 if (right > rightmost)
27093 rightmost = right;
27095 top = btm + descent + ascent;
27096 if (top > highest)
27097 highest = top;
27098 if (btm < lowest)
27099 lowest = btm;
27101 if (cmp->lbearing > left + lbearing)
27102 cmp->lbearing = left + lbearing;
27103 if (cmp->rbearing < left + rbearing)
27104 cmp->rbearing = left + rbearing;
27108 /* If there are glyphs whose x-offsets are negative,
27109 shift all glyphs to the right and make all x-offsets
27110 non-negative. */
27111 if (leftmost < 0)
27113 for (i = 0; i < cmp->glyph_len; i++)
27114 cmp->offsets[i * 2] -= leftmost;
27115 rightmost -= leftmost;
27116 cmp->lbearing -= leftmost;
27117 cmp->rbearing -= leftmost;
27120 if (left_padded && cmp->lbearing < 0)
27122 for (i = 0; i < cmp->glyph_len; i++)
27123 cmp->offsets[i * 2] -= cmp->lbearing;
27124 rightmost -= cmp->lbearing;
27125 cmp->rbearing -= cmp->lbearing;
27126 cmp->lbearing = 0;
27128 if (right_padded && rightmost < cmp->rbearing)
27130 rightmost = cmp->rbearing;
27133 cmp->pixel_width = rightmost;
27134 cmp->ascent = highest;
27135 cmp->descent = - lowest;
27136 if (cmp->ascent < font_ascent)
27137 cmp->ascent = font_ascent;
27138 if (cmp->descent < font_descent)
27139 cmp->descent = font_descent;
27142 if (it->glyph_row
27143 && (cmp->lbearing < 0
27144 || cmp->rbearing > cmp->pixel_width))
27145 it->glyph_row->contains_overlapping_glyphs_p = true;
27147 it->pixel_width = cmp->pixel_width;
27148 it->ascent = it->phys_ascent = cmp->ascent;
27149 it->descent = it->phys_descent = cmp->descent;
27150 if (face->box != FACE_NO_BOX)
27152 int thick = face->box_line_width;
27154 if (thick > 0)
27156 it->ascent += thick;
27157 it->descent += thick;
27159 else
27160 thick = - thick;
27162 if (it->start_of_box_run_p)
27163 it->pixel_width += thick;
27164 if (it->end_of_box_run_p)
27165 it->pixel_width += thick;
27168 /* If face has an overline, add the height of the overline
27169 (1 pixel) and a 1 pixel margin to the character height. */
27170 if (face->overline_p)
27171 it->ascent += overline_margin;
27173 take_vertical_position_into_account (it);
27174 if (it->ascent < 0)
27175 it->ascent = 0;
27176 if (it->descent < 0)
27177 it->descent = 0;
27179 if (it->glyph_row && cmp->glyph_len > 0)
27180 append_composite_glyph (it);
27182 else if (it->what == IT_COMPOSITION)
27184 /* A dynamic (automatic) composition. */
27185 struct face *face = FACE_FROM_ID (it->f, it->face_id);
27186 Lisp_Object gstring;
27187 struct font_metrics metrics;
27189 it->nglyphs = 1;
27191 gstring = composition_gstring_from_id (it->cmp_it.id);
27192 it->pixel_width
27193 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
27194 &metrics);
27195 if (it->glyph_row
27196 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
27197 it->glyph_row->contains_overlapping_glyphs_p = true;
27198 it->ascent = it->phys_ascent = metrics.ascent;
27199 it->descent = it->phys_descent = metrics.descent;
27200 if (face->box != FACE_NO_BOX)
27202 int thick = face->box_line_width;
27204 if (thick > 0)
27206 it->ascent += thick;
27207 it->descent += thick;
27209 else
27210 thick = - thick;
27212 if (it->start_of_box_run_p)
27213 it->pixel_width += thick;
27214 if (it->end_of_box_run_p)
27215 it->pixel_width += thick;
27217 /* If face has an overline, add the height of the overline
27218 (1 pixel) and a 1 pixel margin to the character height. */
27219 if (face->overline_p)
27220 it->ascent += overline_margin;
27221 take_vertical_position_into_account (it);
27222 if (it->ascent < 0)
27223 it->ascent = 0;
27224 if (it->descent < 0)
27225 it->descent = 0;
27227 if (it->glyph_row)
27228 append_composite_glyph (it);
27230 else if (it->what == IT_GLYPHLESS)
27231 produce_glyphless_glyph (it, false, Qnil);
27232 else if (it->what == IT_IMAGE)
27233 produce_image_glyph (it);
27234 else if (it->what == IT_STRETCH)
27235 produce_stretch_glyph (it);
27237 done:
27238 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27239 because this isn't true for images with `:ascent 100'. */
27240 eassert (it->ascent >= 0 && it->descent >= 0);
27241 if (it->area == TEXT_AREA)
27242 it->current_x += it->pixel_width;
27244 if (extra_line_spacing > 0)
27246 it->descent += extra_line_spacing;
27247 if (extra_line_spacing > it->max_extra_line_spacing)
27248 it->max_extra_line_spacing = extra_line_spacing;
27251 it->max_ascent = max (it->max_ascent, it->ascent);
27252 it->max_descent = max (it->max_descent, it->descent);
27253 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
27254 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
27257 /* EXPORT for RIF:
27258 Output LEN glyphs starting at START at the nominal cursor position.
27259 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27260 being updated, and UPDATED_AREA is the area of that row being updated. */
27262 void
27263 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
27264 struct glyph *start, enum glyph_row_area updated_area, int len)
27266 int x, hpos, chpos = w->phys_cursor.hpos;
27268 eassert (updated_row);
27269 /* When the window is hscrolled, cursor hpos can legitimately be out
27270 of bounds, but we draw the cursor at the corresponding window
27271 margin in that case. */
27272 if (!updated_row->reversed_p && chpos < 0)
27273 chpos = 0;
27274 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
27275 chpos = updated_row->used[TEXT_AREA] - 1;
27277 block_input ();
27279 /* Write glyphs. */
27281 hpos = start - updated_row->glyphs[updated_area];
27282 x = draw_glyphs (w, w->output_cursor.x,
27283 updated_row, updated_area,
27284 hpos, hpos + len,
27285 DRAW_NORMAL_TEXT, 0);
27287 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27288 if (updated_area == TEXT_AREA
27289 && w->phys_cursor_on_p
27290 && w->phys_cursor.vpos == w->output_cursor.vpos
27291 && chpos >= hpos
27292 && chpos < hpos + len)
27293 w->phys_cursor_on_p = false;
27295 unblock_input ();
27297 /* Advance the output cursor. */
27298 w->output_cursor.hpos += len;
27299 w->output_cursor.x = x;
27303 /* EXPORT for RIF:
27304 Insert LEN glyphs from START at the nominal cursor position. */
27306 void
27307 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
27308 struct glyph *start, enum glyph_row_area updated_area, int len)
27310 struct frame *f;
27311 int line_height, shift_by_width, shifted_region_width;
27312 struct glyph_row *row;
27313 struct glyph *glyph;
27314 int frame_x, frame_y;
27315 ptrdiff_t hpos;
27317 eassert (updated_row);
27318 block_input ();
27319 f = XFRAME (WINDOW_FRAME (w));
27321 /* Get the height of the line we are in. */
27322 row = updated_row;
27323 line_height = row->height;
27325 /* Get the width of the glyphs to insert. */
27326 shift_by_width = 0;
27327 for (glyph = start; glyph < start + len; ++glyph)
27328 shift_by_width += glyph->pixel_width;
27330 /* Get the width of the region to shift right. */
27331 shifted_region_width = (window_box_width (w, updated_area)
27332 - w->output_cursor.x
27333 - shift_by_width);
27335 /* Shift right. */
27336 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
27337 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
27339 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
27340 line_height, shift_by_width);
27342 /* Write the glyphs. */
27343 hpos = start - row->glyphs[updated_area];
27344 draw_glyphs (w, w->output_cursor.x, row, updated_area,
27345 hpos, hpos + len,
27346 DRAW_NORMAL_TEXT, 0);
27348 /* Advance the output cursor. */
27349 w->output_cursor.hpos += len;
27350 w->output_cursor.x += shift_by_width;
27351 unblock_input ();
27355 /* EXPORT for RIF:
27356 Erase the current text line from the nominal cursor position
27357 (inclusive) to pixel column TO_X (exclusive). The idea is that
27358 everything from TO_X onward is already erased.
27360 TO_X is a pixel position relative to UPDATED_AREA of currently
27361 updated window W. TO_X == -1 means clear to the end of this area. */
27363 void
27364 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
27365 enum glyph_row_area updated_area, int to_x)
27367 struct frame *f;
27368 int max_x, min_y, max_y;
27369 int from_x, from_y, to_y;
27371 eassert (updated_row);
27372 f = XFRAME (w->frame);
27374 if (updated_row->full_width_p)
27375 max_x = (WINDOW_PIXEL_WIDTH (w)
27376 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
27377 else
27378 max_x = window_box_width (w, updated_area);
27379 max_y = window_text_bottom_y (w);
27381 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27382 of window. For TO_X > 0, truncate to end of drawing area. */
27383 if (to_x == 0)
27384 return;
27385 else if (to_x < 0)
27386 to_x = max_x;
27387 else
27388 to_x = min (to_x, max_x);
27390 to_y = min (max_y, w->output_cursor.y + updated_row->height);
27392 /* Notice if the cursor will be cleared by this operation. */
27393 if (!updated_row->full_width_p)
27394 notice_overwritten_cursor (w, updated_area,
27395 w->output_cursor.x, -1,
27396 updated_row->y,
27397 MATRIX_ROW_BOTTOM_Y (updated_row));
27399 from_x = w->output_cursor.x;
27401 /* Translate to frame coordinates. */
27402 if (updated_row->full_width_p)
27404 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
27405 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
27407 else
27409 int area_left = window_box_left (w, updated_area);
27410 from_x += area_left;
27411 to_x += area_left;
27414 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
27415 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
27416 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
27418 /* Prevent inadvertently clearing to end of the X window. */
27419 if (to_x > from_x && to_y > from_y)
27421 block_input ();
27422 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
27423 to_x - from_x, to_y - from_y);
27424 unblock_input ();
27428 #endif /* HAVE_WINDOW_SYSTEM */
27432 /***********************************************************************
27433 Cursor types
27434 ***********************************************************************/
27436 /* Value is the internal representation of the specified cursor type
27437 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27438 of the bar cursor. */
27440 static enum text_cursor_kinds
27441 get_specified_cursor_type (Lisp_Object arg, int *width)
27443 enum text_cursor_kinds type;
27445 if (NILP (arg))
27446 return NO_CURSOR;
27448 if (EQ (arg, Qbox))
27449 return FILLED_BOX_CURSOR;
27451 if (EQ (arg, Qhollow))
27452 return HOLLOW_BOX_CURSOR;
27454 if (EQ (arg, Qbar))
27456 *width = 2;
27457 return BAR_CURSOR;
27460 if (CONSP (arg)
27461 && EQ (XCAR (arg), Qbar)
27462 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27464 *width = XINT (XCDR (arg));
27465 return BAR_CURSOR;
27468 if (EQ (arg, Qhbar))
27470 *width = 2;
27471 return HBAR_CURSOR;
27474 if (CONSP (arg)
27475 && EQ (XCAR (arg), Qhbar)
27476 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27478 *width = XINT (XCDR (arg));
27479 return HBAR_CURSOR;
27482 /* Treat anything unknown as "hollow box cursor".
27483 It was bad to signal an error; people have trouble fixing
27484 .Xdefaults with Emacs, when it has something bad in it. */
27485 type = HOLLOW_BOX_CURSOR;
27487 return type;
27490 /* Set the default cursor types for specified frame. */
27491 void
27492 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
27494 int width = 1;
27495 Lisp_Object tem;
27497 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
27498 FRAME_CURSOR_WIDTH (f) = width;
27500 /* By default, set up the blink-off state depending on the on-state. */
27502 tem = Fassoc (arg, Vblink_cursor_alist);
27503 if (!NILP (tem))
27505 FRAME_BLINK_OFF_CURSOR (f)
27506 = get_specified_cursor_type (XCDR (tem), &width);
27507 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
27509 else
27510 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
27512 /* Make sure the cursor gets redrawn. */
27513 f->cursor_type_changed = true;
27517 #ifdef HAVE_WINDOW_SYSTEM
27519 /* Return the cursor we want to be displayed in window W. Return
27520 width of bar/hbar cursor through WIDTH arg. Return with
27521 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27522 (i.e. if the `system caret' should track this cursor).
27524 In a mini-buffer window, we want the cursor only to appear if we
27525 are reading input from this window. For the selected window, we
27526 want the cursor type given by the frame parameter or buffer local
27527 setting of cursor-type. If explicitly marked off, draw no cursor.
27528 In all other cases, we want a hollow box cursor. */
27530 static enum text_cursor_kinds
27531 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
27532 bool *active_cursor)
27534 struct frame *f = XFRAME (w->frame);
27535 struct buffer *b = XBUFFER (w->contents);
27536 int cursor_type = DEFAULT_CURSOR;
27537 Lisp_Object alt_cursor;
27538 bool non_selected = false;
27540 *active_cursor = true;
27542 /* Echo area */
27543 if (cursor_in_echo_area
27544 && FRAME_HAS_MINIBUF_P (f)
27545 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
27547 if (w == XWINDOW (echo_area_window))
27549 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
27551 *width = FRAME_CURSOR_WIDTH (f);
27552 return FRAME_DESIRED_CURSOR (f);
27554 else
27555 return get_specified_cursor_type (BVAR (b, cursor_type), width);
27558 *active_cursor = false;
27559 non_selected = true;
27562 /* Detect a nonselected window or nonselected frame. */
27563 else if (w != XWINDOW (f->selected_window)
27564 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
27566 *active_cursor = false;
27568 if (MINI_WINDOW_P (w) && minibuf_level == 0)
27569 return NO_CURSOR;
27571 non_selected = true;
27574 /* Never display a cursor in a window in which cursor-type is nil. */
27575 if (NILP (BVAR (b, cursor_type)))
27576 return NO_CURSOR;
27578 /* Get the normal cursor type for this window. */
27579 if (EQ (BVAR (b, cursor_type), Qt))
27581 cursor_type = FRAME_DESIRED_CURSOR (f);
27582 *width = FRAME_CURSOR_WIDTH (f);
27584 else
27585 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
27587 /* Use cursor-in-non-selected-windows instead
27588 for non-selected window or frame. */
27589 if (non_selected)
27591 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
27592 if (!EQ (Qt, alt_cursor))
27593 return get_specified_cursor_type (alt_cursor, width);
27594 /* t means modify the normal cursor type. */
27595 if (cursor_type == FILLED_BOX_CURSOR)
27596 cursor_type = HOLLOW_BOX_CURSOR;
27597 else if (cursor_type == BAR_CURSOR && *width > 1)
27598 --*width;
27599 return cursor_type;
27602 /* Use normal cursor if not blinked off. */
27603 if (!w->cursor_off_p)
27605 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
27607 if (cursor_type == FILLED_BOX_CURSOR)
27609 /* Using a block cursor on large images can be very annoying.
27610 So use a hollow cursor for "large" images.
27611 If image is not transparent (no mask), also use hollow cursor. */
27612 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
27613 if (img != NULL && IMAGEP (img->spec))
27615 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27616 where N = size of default frame font size.
27617 This should cover most of the "tiny" icons people may use. */
27618 if (!img->mask
27619 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
27620 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
27621 cursor_type = HOLLOW_BOX_CURSOR;
27624 else if (cursor_type != NO_CURSOR)
27626 /* Display current only supports BOX and HOLLOW cursors for images.
27627 So for now, unconditionally use a HOLLOW cursor when cursor is
27628 not a solid box cursor. */
27629 cursor_type = HOLLOW_BOX_CURSOR;
27632 return cursor_type;
27635 /* Cursor is blinked off, so determine how to "toggle" it. */
27637 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27638 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
27639 return get_specified_cursor_type (XCDR (alt_cursor), width);
27641 /* Then see if frame has specified a specific blink off cursor type. */
27642 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
27644 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
27645 return FRAME_BLINK_OFF_CURSOR (f);
27648 #if false
27649 /* Some people liked having a permanently visible blinking cursor,
27650 while others had very strong opinions against it. So it was
27651 decided to remove it. KFS 2003-09-03 */
27653 /* Finally perform built-in cursor blinking:
27654 filled box <-> hollow box
27655 wide [h]bar <-> narrow [h]bar
27656 narrow [h]bar <-> no cursor
27657 other type <-> no cursor */
27659 if (cursor_type == FILLED_BOX_CURSOR)
27660 return HOLLOW_BOX_CURSOR;
27662 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
27664 *width = 1;
27665 return cursor_type;
27667 #endif
27669 return NO_CURSOR;
27673 /* Notice when the text cursor of window W has been completely
27674 overwritten by a drawing operation that outputs glyphs in AREA
27675 starting at X0 and ending at X1 in the line starting at Y0 and
27676 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27677 the rest of the line after X0 has been written. Y coordinates
27678 are window-relative. */
27680 static void
27681 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
27682 int x0, int x1, int y0, int y1)
27684 int cx0, cx1, cy0, cy1;
27685 struct glyph_row *row;
27687 if (!w->phys_cursor_on_p)
27688 return;
27689 if (area != TEXT_AREA)
27690 return;
27692 if (w->phys_cursor.vpos < 0
27693 || w->phys_cursor.vpos >= w->current_matrix->nrows
27694 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
27695 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
27696 return;
27698 if (row->cursor_in_fringe_p)
27700 row->cursor_in_fringe_p = false;
27701 draw_fringe_bitmap (w, row, row->reversed_p);
27702 w->phys_cursor_on_p = false;
27703 return;
27706 cx0 = w->phys_cursor.x;
27707 cx1 = cx0 + w->phys_cursor_width;
27708 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
27709 return;
27711 /* The cursor image will be completely removed from the
27712 screen if the output area intersects the cursor area in
27713 y-direction. When we draw in [y0 y1[, and some part of
27714 the cursor is at y < y0, that part must have been drawn
27715 before. When scrolling, the cursor is erased before
27716 actually scrolling, so we don't come here. When not
27717 scrolling, the rows above the old cursor row must have
27718 changed, and in this case these rows must have written
27719 over the cursor image.
27721 Likewise if part of the cursor is below y1, with the
27722 exception of the cursor being in the first blank row at
27723 the buffer and window end because update_text_area
27724 doesn't draw that row. (Except when it does, but
27725 that's handled in update_text_area.) */
27727 cy0 = w->phys_cursor.y;
27728 cy1 = cy0 + w->phys_cursor_height;
27729 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
27730 return;
27732 w->phys_cursor_on_p = false;
27735 #endif /* HAVE_WINDOW_SYSTEM */
27738 /************************************************************************
27739 Mouse Face
27740 ************************************************************************/
27742 #ifdef HAVE_WINDOW_SYSTEM
27744 /* EXPORT for RIF:
27745 Fix the display of area AREA of overlapping row ROW in window W
27746 with respect to the overlapping part OVERLAPS. */
27748 void
27749 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
27750 enum glyph_row_area area, int overlaps)
27752 int i, x;
27754 block_input ();
27756 x = 0;
27757 for (i = 0; i < row->used[area];)
27759 if (row->glyphs[area][i].overlaps_vertically_p)
27761 int start = i, start_x = x;
27765 x += row->glyphs[area][i].pixel_width;
27766 ++i;
27768 while (i < row->used[area]
27769 && row->glyphs[area][i].overlaps_vertically_p);
27771 draw_glyphs (w, start_x, row, area,
27772 start, i,
27773 DRAW_NORMAL_TEXT, overlaps);
27775 else
27777 x += row->glyphs[area][i].pixel_width;
27778 ++i;
27782 unblock_input ();
27786 /* EXPORT:
27787 Draw the cursor glyph of window W in glyph row ROW. See the
27788 comment of draw_glyphs for the meaning of HL. */
27790 void
27791 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
27792 enum draw_glyphs_face hl)
27794 /* If cursor hpos is out of bounds, don't draw garbage. This can
27795 happen in mini-buffer windows when switching between echo area
27796 glyphs and mini-buffer. */
27797 if ((row->reversed_p
27798 ? (w->phys_cursor.hpos >= 0)
27799 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
27801 bool on_p = w->phys_cursor_on_p;
27802 int x1;
27803 int hpos = w->phys_cursor.hpos;
27805 /* When the window is hscrolled, cursor hpos can legitimately be
27806 out of bounds, but we draw the cursor at the corresponding
27807 window margin in that case. */
27808 if (!row->reversed_p && hpos < 0)
27809 hpos = 0;
27810 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27811 hpos = row->used[TEXT_AREA] - 1;
27813 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
27814 hl, 0);
27815 w->phys_cursor_on_p = on_p;
27817 if (hl == DRAW_CURSOR)
27818 w->phys_cursor_width = x1 - w->phys_cursor.x;
27819 /* When we erase the cursor, and ROW is overlapped by other
27820 rows, make sure that these overlapping parts of other rows
27821 are redrawn. */
27822 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
27824 w->phys_cursor_width = x1 - w->phys_cursor.x;
27826 if (row > w->current_matrix->rows
27827 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
27828 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
27829 OVERLAPS_ERASED_CURSOR);
27831 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
27832 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
27833 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
27834 OVERLAPS_ERASED_CURSOR);
27840 /* Erase the image of a cursor of window W from the screen. */
27842 void
27843 erase_phys_cursor (struct window *w)
27845 struct frame *f = XFRAME (w->frame);
27846 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27847 int hpos = w->phys_cursor.hpos;
27848 int vpos = w->phys_cursor.vpos;
27849 bool mouse_face_here_p = false;
27850 struct glyph_matrix *active_glyphs = w->current_matrix;
27851 struct glyph_row *cursor_row;
27852 struct glyph *cursor_glyph;
27853 enum draw_glyphs_face hl;
27855 /* No cursor displayed or row invalidated => nothing to do on the
27856 screen. */
27857 if (w->phys_cursor_type == NO_CURSOR)
27858 goto mark_cursor_off;
27860 /* VPOS >= active_glyphs->nrows means that window has been resized.
27861 Don't bother to erase the cursor. */
27862 if (vpos >= active_glyphs->nrows)
27863 goto mark_cursor_off;
27865 /* If row containing cursor is marked invalid, there is nothing we
27866 can do. */
27867 cursor_row = MATRIX_ROW (active_glyphs, vpos);
27868 if (!cursor_row->enabled_p)
27869 goto mark_cursor_off;
27871 /* If line spacing is > 0, old cursor may only be partially visible in
27872 window after split-window. So adjust visible height. */
27873 cursor_row->visible_height = min (cursor_row->visible_height,
27874 window_text_bottom_y (w) - cursor_row->y);
27876 /* If row is completely invisible, don't attempt to delete a cursor which
27877 isn't there. This can happen if cursor is at top of a window, and
27878 we switch to a buffer with a header line in that window. */
27879 if (cursor_row->visible_height <= 0)
27880 goto mark_cursor_off;
27882 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27883 if (cursor_row->cursor_in_fringe_p)
27885 cursor_row->cursor_in_fringe_p = false;
27886 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
27887 goto mark_cursor_off;
27890 /* This can happen when the new row is shorter than the old one.
27891 In this case, either draw_glyphs or clear_end_of_line
27892 should have cleared the cursor. Note that we wouldn't be
27893 able to erase the cursor in this case because we don't have a
27894 cursor glyph at hand. */
27895 if ((cursor_row->reversed_p
27896 ? (w->phys_cursor.hpos < 0)
27897 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
27898 goto mark_cursor_off;
27900 /* When the window is hscrolled, cursor hpos can legitimately be out
27901 of bounds, but we draw the cursor at the corresponding window
27902 margin in that case. */
27903 if (!cursor_row->reversed_p && hpos < 0)
27904 hpos = 0;
27905 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
27906 hpos = cursor_row->used[TEXT_AREA] - 1;
27908 /* If the cursor is in the mouse face area, redisplay that when
27909 we clear the cursor. */
27910 if (! NILP (hlinfo->mouse_face_window)
27911 && coords_in_mouse_face_p (w, hpos, vpos)
27912 /* Don't redraw the cursor's spot in mouse face if it is at the
27913 end of a line (on a newline). The cursor appears there, but
27914 mouse highlighting does not. */
27915 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
27916 mouse_face_here_p = true;
27918 /* Maybe clear the display under the cursor. */
27919 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
27921 int x, y;
27922 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
27923 int width;
27925 cursor_glyph = get_phys_cursor_glyph (w);
27926 if (cursor_glyph == NULL)
27927 goto mark_cursor_off;
27929 width = cursor_glyph->pixel_width;
27930 x = w->phys_cursor.x;
27931 if (x < 0)
27933 width += x;
27934 x = 0;
27936 width = min (width, window_box_width (w, TEXT_AREA) - x);
27937 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
27938 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
27940 if (width > 0)
27941 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
27944 /* Erase the cursor by redrawing the character underneath it. */
27945 if (mouse_face_here_p)
27946 hl = DRAW_MOUSE_FACE;
27947 else
27948 hl = DRAW_NORMAL_TEXT;
27949 draw_phys_cursor_glyph (w, cursor_row, hl);
27951 mark_cursor_off:
27952 w->phys_cursor_on_p = false;
27953 w->phys_cursor_type = NO_CURSOR;
27957 /* Display or clear cursor of window W. If !ON, clear the cursor.
27958 If ON, display the cursor; where to put the cursor is specified by
27959 HPOS, VPOS, X and Y. */
27961 void
27962 display_and_set_cursor (struct window *w, bool on,
27963 int hpos, int vpos, int x, int y)
27965 struct frame *f = XFRAME (w->frame);
27966 int new_cursor_type;
27967 int new_cursor_width;
27968 bool active_cursor;
27969 struct glyph_row *glyph_row;
27970 struct glyph *glyph;
27972 /* This is pointless on invisible frames, and dangerous on garbaged
27973 windows and frames; in the latter case, the frame or window may
27974 be in the midst of changing its size, and x and y may be off the
27975 window. */
27976 if (! FRAME_VISIBLE_P (f)
27977 || FRAME_GARBAGED_P (f)
27978 || vpos >= w->current_matrix->nrows
27979 || hpos >= w->current_matrix->matrix_w)
27980 return;
27982 /* If cursor is off and we want it off, return quickly. */
27983 if (!on && !w->phys_cursor_on_p)
27984 return;
27986 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
27987 /* If cursor row is not enabled, we don't really know where to
27988 display the cursor. */
27989 if (!glyph_row->enabled_p)
27991 w->phys_cursor_on_p = false;
27992 return;
27995 glyph = NULL;
27996 if (!glyph_row->exact_window_width_line_p
27997 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
27998 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
28000 eassert (input_blocked_p ());
28002 /* Set new_cursor_type to the cursor we want to be displayed. */
28003 new_cursor_type = get_window_cursor_type (w, glyph,
28004 &new_cursor_width, &active_cursor);
28006 /* If cursor is currently being shown and we don't want it to be or
28007 it is in the wrong place, or the cursor type is not what we want,
28008 erase it. */
28009 if (w->phys_cursor_on_p
28010 && (!on
28011 || w->phys_cursor.x != x
28012 || w->phys_cursor.y != y
28013 /* HPOS can be negative in R2L rows whose
28014 exact_window_width_line_p flag is set (i.e. their newline
28015 would "overflow into the fringe"). */
28016 || hpos < 0
28017 || new_cursor_type != w->phys_cursor_type
28018 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
28019 && new_cursor_width != w->phys_cursor_width)))
28020 erase_phys_cursor (w);
28022 /* Don't check phys_cursor_on_p here because that flag is only set
28023 to false in some cases where we know that the cursor has been
28024 completely erased, to avoid the extra work of erasing the cursor
28025 twice. In other words, phys_cursor_on_p can be true and the cursor
28026 still not be visible, or it has only been partly erased. */
28027 if (on)
28029 w->phys_cursor_ascent = glyph_row->ascent;
28030 w->phys_cursor_height = glyph_row->height;
28032 /* Set phys_cursor_.* before x_draw_.* is called because some
28033 of them may need the information. */
28034 w->phys_cursor.x = x;
28035 w->phys_cursor.y = glyph_row->y;
28036 w->phys_cursor.hpos = hpos;
28037 w->phys_cursor.vpos = vpos;
28040 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
28041 new_cursor_type, new_cursor_width,
28042 on, active_cursor);
28046 /* Switch the display of W's cursor on or off, according to the value
28047 of ON. */
28049 static void
28050 update_window_cursor (struct window *w, bool on)
28052 /* Don't update cursor in windows whose frame is in the process
28053 of being deleted. */
28054 if (w->current_matrix)
28056 int hpos = w->phys_cursor.hpos;
28057 int vpos = w->phys_cursor.vpos;
28058 struct glyph_row *row;
28060 if (vpos >= w->current_matrix->nrows
28061 || hpos >= w->current_matrix->matrix_w)
28062 return;
28064 row = MATRIX_ROW (w->current_matrix, vpos);
28066 /* When the window is hscrolled, cursor hpos can legitimately be
28067 out of bounds, but we draw the cursor at the corresponding
28068 window margin in that case. */
28069 if (!row->reversed_p && hpos < 0)
28070 hpos = 0;
28071 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28072 hpos = row->used[TEXT_AREA] - 1;
28074 block_input ();
28075 display_and_set_cursor (w, on, hpos, vpos,
28076 w->phys_cursor.x, w->phys_cursor.y);
28077 unblock_input ();
28082 /* Call update_window_cursor with parameter ON_P on all leaf windows
28083 in the window tree rooted at W. */
28085 static void
28086 update_cursor_in_window_tree (struct window *w, bool on_p)
28088 while (w)
28090 if (WINDOWP (w->contents))
28091 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
28092 else
28093 update_window_cursor (w, on_p);
28095 w = NILP (w->next) ? 0 : XWINDOW (w->next);
28100 /* EXPORT:
28101 Display the cursor on window W, or clear it, according to ON_P.
28102 Don't change the cursor's position. */
28104 void
28105 x_update_cursor (struct frame *f, bool on_p)
28107 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
28111 /* EXPORT:
28112 Clear the cursor of window W to background color, and mark the
28113 cursor as not shown. This is used when the text where the cursor
28114 is about to be rewritten. */
28116 void
28117 x_clear_cursor (struct window *w)
28119 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
28120 update_window_cursor (w, false);
28123 #endif /* HAVE_WINDOW_SYSTEM */
28125 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28126 and MSDOS. */
28127 static void
28128 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
28129 int start_hpos, int end_hpos,
28130 enum draw_glyphs_face draw)
28132 #ifdef HAVE_WINDOW_SYSTEM
28133 if (FRAME_WINDOW_P (XFRAME (w->frame)))
28135 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
28136 return;
28138 #endif
28139 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28140 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
28141 #endif
28144 /* Display the active region described by mouse_face_* according to DRAW. */
28146 static void
28147 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
28149 struct window *w = XWINDOW (hlinfo->mouse_face_window);
28150 struct frame *f = XFRAME (WINDOW_FRAME (w));
28152 if (/* If window is in the process of being destroyed, don't bother
28153 to do anything. */
28154 w->current_matrix != NULL
28155 /* Don't update mouse highlight if hidden. */
28156 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
28157 /* Recognize when we are called to operate on rows that don't exist
28158 anymore. This can happen when a window is split. */
28159 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
28161 bool phys_cursor_on_p = w->phys_cursor_on_p;
28162 struct glyph_row *row, *first, *last;
28164 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
28165 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
28167 for (row = first; row <= last && row->enabled_p; ++row)
28169 int start_hpos, end_hpos, start_x;
28171 /* For all but the first row, the highlight starts at column 0. */
28172 if (row == first)
28174 /* R2L rows have BEG and END in reversed order, but the
28175 screen drawing geometry is always left to right. So
28176 we need to mirror the beginning and end of the
28177 highlighted area in R2L rows. */
28178 if (!row->reversed_p)
28180 start_hpos = hlinfo->mouse_face_beg_col;
28181 start_x = hlinfo->mouse_face_beg_x;
28183 else if (row == last)
28185 start_hpos = hlinfo->mouse_face_end_col;
28186 start_x = hlinfo->mouse_face_end_x;
28188 else
28190 start_hpos = 0;
28191 start_x = 0;
28194 else if (row->reversed_p && row == last)
28196 start_hpos = hlinfo->mouse_face_end_col;
28197 start_x = hlinfo->mouse_face_end_x;
28199 else
28201 start_hpos = 0;
28202 start_x = 0;
28205 if (row == last)
28207 if (!row->reversed_p)
28208 end_hpos = hlinfo->mouse_face_end_col;
28209 else if (row == first)
28210 end_hpos = hlinfo->mouse_face_beg_col;
28211 else
28213 end_hpos = row->used[TEXT_AREA];
28214 if (draw == DRAW_NORMAL_TEXT)
28215 row->fill_line_p = true; /* Clear to end of line. */
28218 else if (row->reversed_p && row == first)
28219 end_hpos = hlinfo->mouse_face_beg_col;
28220 else
28222 end_hpos = row->used[TEXT_AREA];
28223 if (draw == DRAW_NORMAL_TEXT)
28224 row->fill_line_p = true; /* Clear to end of line. */
28227 if (end_hpos > start_hpos)
28229 draw_row_with_mouse_face (w, start_x, row,
28230 start_hpos, end_hpos, draw);
28232 row->mouse_face_p
28233 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
28237 #ifdef HAVE_WINDOW_SYSTEM
28238 /* When we've written over the cursor, arrange for it to
28239 be displayed again. */
28240 if (FRAME_WINDOW_P (f)
28241 && phys_cursor_on_p && !w->phys_cursor_on_p)
28243 int hpos = w->phys_cursor.hpos;
28245 /* When the window is hscrolled, cursor hpos can legitimately be
28246 out of bounds, but we draw the cursor at the corresponding
28247 window margin in that case. */
28248 if (!row->reversed_p && hpos < 0)
28249 hpos = 0;
28250 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28251 hpos = row->used[TEXT_AREA] - 1;
28253 block_input ();
28254 display_and_set_cursor (w, true, hpos, w->phys_cursor.vpos,
28255 w->phys_cursor.x, w->phys_cursor.y);
28256 unblock_input ();
28258 #endif /* HAVE_WINDOW_SYSTEM */
28261 #ifdef HAVE_WINDOW_SYSTEM
28262 /* Change the mouse cursor. */
28263 if (FRAME_WINDOW_P (f) && NILP (do_mouse_tracking))
28265 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28266 if (draw == DRAW_NORMAL_TEXT
28267 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
28268 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
28269 else
28270 #endif
28271 if (draw == DRAW_MOUSE_FACE)
28272 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
28273 else
28274 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
28276 #endif /* HAVE_WINDOW_SYSTEM */
28279 /* EXPORT:
28280 Clear out the mouse-highlighted active region.
28281 Redraw it un-highlighted first. Value is true if mouse
28282 face was actually drawn unhighlighted. */
28284 bool
28285 clear_mouse_face (Mouse_HLInfo *hlinfo)
28287 bool cleared
28288 = !hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window);
28289 if (cleared)
28290 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
28291 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
28292 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
28293 hlinfo->mouse_face_window = Qnil;
28294 hlinfo->mouse_face_overlay = Qnil;
28295 return cleared;
28298 /* Return true if the coordinates HPOS and VPOS on windows W are
28299 within the mouse face on that window. */
28300 static bool
28301 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
28303 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
28305 /* Quickly resolve the easy cases. */
28306 if (!(WINDOWP (hlinfo->mouse_face_window)
28307 && XWINDOW (hlinfo->mouse_face_window) == w))
28308 return false;
28309 if (vpos < hlinfo->mouse_face_beg_row
28310 || vpos > hlinfo->mouse_face_end_row)
28311 return false;
28312 if (vpos > hlinfo->mouse_face_beg_row
28313 && vpos < hlinfo->mouse_face_end_row)
28314 return true;
28316 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
28318 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28320 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
28321 return true;
28323 else if ((vpos == hlinfo->mouse_face_beg_row
28324 && hpos >= hlinfo->mouse_face_beg_col)
28325 || (vpos == hlinfo->mouse_face_end_row
28326 && hpos < hlinfo->mouse_face_end_col))
28327 return true;
28329 else
28331 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28333 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
28334 return true;
28336 else if ((vpos == hlinfo->mouse_face_beg_row
28337 && hpos <= hlinfo->mouse_face_beg_col)
28338 || (vpos == hlinfo->mouse_face_end_row
28339 && hpos > hlinfo->mouse_face_end_col))
28340 return true;
28342 return false;
28346 /* EXPORT:
28347 True if physical cursor of window W is within mouse face. */
28349 bool
28350 cursor_in_mouse_face_p (struct window *w)
28352 int hpos = w->phys_cursor.hpos;
28353 int vpos = w->phys_cursor.vpos;
28354 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
28356 /* When the window is hscrolled, cursor hpos can legitimately be out
28357 of bounds, but we draw the cursor at the corresponding window
28358 margin in that case. */
28359 if (!row->reversed_p && hpos < 0)
28360 hpos = 0;
28361 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28362 hpos = row->used[TEXT_AREA] - 1;
28364 return coords_in_mouse_face_p (w, hpos, vpos);
28369 /* Find the glyph rows START_ROW and END_ROW of window W that display
28370 characters between buffer positions START_CHARPOS and END_CHARPOS
28371 (excluding END_CHARPOS). DISP_STRING is a display string that
28372 covers these buffer positions. This is similar to
28373 row_containing_pos, but is more accurate when bidi reordering makes
28374 buffer positions change non-linearly with glyph rows. */
28375 static void
28376 rows_from_pos_range (struct window *w,
28377 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
28378 Lisp_Object disp_string,
28379 struct glyph_row **start, struct glyph_row **end)
28381 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28382 int last_y = window_text_bottom_y (w);
28383 struct glyph_row *row;
28385 *start = NULL;
28386 *end = NULL;
28388 while (!first->enabled_p
28389 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
28390 first++;
28392 /* Find the START row. */
28393 for (row = first;
28394 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
28395 row++)
28397 /* A row can potentially be the START row if the range of the
28398 characters it displays intersects the range
28399 [START_CHARPOS..END_CHARPOS). */
28400 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
28401 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
28402 /* See the commentary in row_containing_pos, for the
28403 explanation of the complicated way to check whether
28404 some position is beyond the end of the characters
28405 displayed by a row. */
28406 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
28407 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
28408 && !row->ends_at_zv_p
28409 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
28410 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
28411 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
28412 && !row->ends_at_zv_p
28413 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
28415 /* Found a candidate row. Now make sure at least one of the
28416 glyphs it displays has a charpos from the range
28417 [START_CHARPOS..END_CHARPOS).
28419 This is not obvious because bidi reordering could make
28420 buffer positions of a row be 1,2,3,102,101,100, and if we
28421 want to highlight characters in [50..60), we don't want
28422 this row, even though [50..60) does intersect [1..103),
28423 the range of character positions given by the row's start
28424 and end positions. */
28425 struct glyph *g = row->glyphs[TEXT_AREA];
28426 struct glyph *e = g + row->used[TEXT_AREA];
28428 while (g < e)
28430 if (((BUFFERP (g->object) || NILP (g->object))
28431 && start_charpos <= g->charpos && g->charpos < end_charpos)
28432 /* A glyph that comes from DISP_STRING is by
28433 definition to be highlighted. */
28434 || EQ (g->object, disp_string))
28435 *start = row;
28436 g++;
28438 if (*start)
28439 break;
28443 /* Find the END row. */
28444 if (!*start
28445 /* If the last row is partially visible, start looking for END
28446 from that row, instead of starting from FIRST. */
28447 && !(row->enabled_p
28448 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
28449 row = first;
28450 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
28452 struct glyph_row *next = row + 1;
28453 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
28455 if (!next->enabled_p
28456 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
28457 /* The first row >= START whose range of displayed characters
28458 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28459 is the row END + 1. */
28460 || (start_charpos < next_start
28461 && end_charpos < next_start)
28462 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
28463 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
28464 && !next->ends_at_zv_p
28465 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
28466 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
28467 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
28468 && !next->ends_at_zv_p
28469 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
28471 *end = row;
28472 break;
28474 else
28476 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28477 but none of the characters it displays are in the range, it is
28478 also END + 1. */
28479 struct glyph *g = next->glyphs[TEXT_AREA];
28480 struct glyph *s = g;
28481 struct glyph *e = g + next->used[TEXT_AREA];
28483 while (g < e)
28485 if (((BUFFERP (g->object) || NILP (g->object))
28486 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
28487 /* If the buffer position of the first glyph in
28488 the row is equal to END_CHARPOS, it means
28489 the last character to be highlighted is the
28490 newline of ROW, and we must consider NEXT as
28491 END, not END+1. */
28492 || (((!next->reversed_p && g == s)
28493 || (next->reversed_p && g == e - 1))
28494 && (g->charpos == end_charpos
28495 /* Special case for when NEXT is an
28496 empty line at ZV. */
28497 || (g->charpos == -1
28498 && !row->ends_at_zv_p
28499 && next_start == end_charpos)))))
28500 /* A glyph that comes from DISP_STRING is by
28501 definition to be highlighted. */
28502 || EQ (g->object, disp_string))
28503 break;
28504 g++;
28506 if (g == e)
28508 *end = row;
28509 break;
28511 /* The first row that ends at ZV must be the last to be
28512 highlighted. */
28513 else if (next->ends_at_zv_p)
28515 *end = next;
28516 break;
28522 /* This function sets the mouse_face_* elements of HLINFO, assuming
28523 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28524 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28525 for the overlay or run of text properties specifying the mouse
28526 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28527 before-string and after-string that must also be highlighted.
28528 DISP_STRING, if non-nil, is a display string that may cover some
28529 or all of the highlighted text. */
28531 static void
28532 mouse_face_from_buffer_pos (Lisp_Object window,
28533 Mouse_HLInfo *hlinfo,
28534 ptrdiff_t mouse_charpos,
28535 ptrdiff_t start_charpos,
28536 ptrdiff_t end_charpos,
28537 Lisp_Object before_string,
28538 Lisp_Object after_string,
28539 Lisp_Object disp_string)
28541 struct window *w = XWINDOW (window);
28542 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28543 struct glyph_row *r1, *r2;
28544 struct glyph *glyph, *end;
28545 ptrdiff_t ignore, pos;
28546 int x;
28548 eassert (NILP (disp_string) || STRINGP (disp_string));
28549 eassert (NILP (before_string) || STRINGP (before_string));
28550 eassert (NILP (after_string) || STRINGP (after_string));
28552 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28553 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
28554 if (r1 == NULL)
28555 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28556 /* If the before-string or display-string contains newlines,
28557 rows_from_pos_range skips to its last row. Move back. */
28558 if (!NILP (before_string) || !NILP (disp_string))
28560 struct glyph_row *prev;
28561 while ((prev = r1 - 1, prev >= first)
28562 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
28563 && prev->used[TEXT_AREA] > 0)
28565 struct glyph *beg = prev->glyphs[TEXT_AREA];
28566 glyph = beg + prev->used[TEXT_AREA];
28567 while (--glyph >= beg && NILP (glyph->object));
28568 if (glyph < beg
28569 || !(EQ (glyph->object, before_string)
28570 || EQ (glyph->object, disp_string)))
28571 break;
28572 r1 = prev;
28575 if (r2 == NULL)
28577 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28578 hlinfo->mouse_face_past_end = true;
28580 else if (!NILP (after_string))
28582 /* If the after-string has newlines, advance to its last row. */
28583 struct glyph_row *next;
28584 struct glyph_row *last
28585 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28587 for (next = r2 + 1;
28588 next <= last
28589 && next->used[TEXT_AREA] > 0
28590 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
28591 ++next)
28592 r2 = next;
28594 /* The rest of the display engine assumes that mouse_face_beg_row is
28595 either above mouse_face_end_row or identical to it. But with
28596 bidi-reordered continued lines, the row for START_CHARPOS could
28597 be below the row for END_CHARPOS. If so, swap the rows and store
28598 them in correct order. */
28599 if (r1->y > r2->y)
28601 struct glyph_row *tem = r2;
28603 r2 = r1;
28604 r1 = tem;
28607 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
28608 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
28610 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28611 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28612 could be anywhere in the row and in any order. The strategy
28613 below is to find the leftmost and the rightmost glyph that
28614 belongs to either of these 3 strings, or whose position is
28615 between START_CHARPOS and END_CHARPOS, and highlight all the
28616 glyphs between those two. This may cover more than just the text
28617 between START_CHARPOS and END_CHARPOS if the range of characters
28618 strides the bidi level boundary, e.g. if the beginning is in R2L
28619 text while the end is in L2R text or vice versa. */
28620 if (!r1->reversed_p)
28622 /* This row is in a left to right paragraph. Scan it left to
28623 right. */
28624 glyph = r1->glyphs[TEXT_AREA];
28625 end = glyph + r1->used[TEXT_AREA];
28626 x = r1->x;
28628 /* Skip truncation glyphs at the start of the glyph row. */
28629 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28630 for (; glyph < end
28631 && NILP (glyph->object)
28632 && glyph->charpos < 0;
28633 ++glyph)
28634 x += glyph->pixel_width;
28636 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28637 or DISP_STRING, and the first glyph from buffer whose
28638 position is between START_CHARPOS and END_CHARPOS. */
28639 for (; glyph < end
28640 && !NILP (glyph->object)
28641 && !EQ (glyph->object, disp_string)
28642 && !(BUFFERP (glyph->object)
28643 && (glyph->charpos >= start_charpos
28644 && glyph->charpos < end_charpos));
28645 ++glyph)
28647 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28648 are present at buffer positions between START_CHARPOS and
28649 END_CHARPOS, or if they come from an overlay. */
28650 if (EQ (glyph->object, before_string))
28652 pos = string_buffer_position (before_string,
28653 start_charpos);
28654 /* If pos == 0, it means before_string came from an
28655 overlay, not from a buffer position. */
28656 if (!pos || (pos >= start_charpos && pos < end_charpos))
28657 break;
28659 else if (EQ (glyph->object, after_string))
28661 pos = string_buffer_position (after_string, end_charpos);
28662 if (!pos || (pos >= start_charpos && pos < end_charpos))
28663 break;
28665 x += glyph->pixel_width;
28667 hlinfo->mouse_face_beg_x = x;
28668 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28670 else
28672 /* This row is in a right to left paragraph. Scan it right to
28673 left. */
28674 struct glyph *g;
28676 end = r1->glyphs[TEXT_AREA] - 1;
28677 glyph = end + r1->used[TEXT_AREA];
28679 /* Skip truncation glyphs at the start of the glyph row. */
28680 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28681 for (; glyph > end
28682 && NILP (glyph->object)
28683 && glyph->charpos < 0;
28684 --glyph)
28687 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28688 or DISP_STRING, and the first glyph from buffer whose
28689 position is between START_CHARPOS and END_CHARPOS. */
28690 for (; glyph > end
28691 && !NILP (glyph->object)
28692 && !EQ (glyph->object, disp_string)
28693 && !(BUFFERP (glyph->object)
28694 && (glyph->charpos >= start_charpos
28695 && glyph->charpos < end_charpos));
28696 --glyph)
28698 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28699 are present at buffer positions between START_CHARPOS and
28700 END_CHARPOS, or if they come from an overlay. */
28701 if (EQ (glyph->object, before_string))
28703 pos = string_buffer_position (before_string, start_charpos);
28704 /* If pos == 0, it means before_string came from an
28705 overlay, not from a buffer position. */
28706 if (!pos || (pos >= start_charpos && pos < end_charpos))
28707 break;
28709 else if (EQ (glyph->object, after_string))
28711 pos = string_buffer_position (after_string, end_charpos);
28712 if (!pos || (pos >= start_charpos && pos < end_charpos))
28713 break;
28717 glyph++; /* first glyph to the right of the highlighted area */
28718 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
28719 x += g->pixel_width;
28720 hlinfo->mouse_face_beg_x = x;
28721 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28724 /* If the highlight ends in a different row, compute GLYPH and END
28725 for the end row. Otherwise, reuse the values computed above for
28726 the row where the highlight begins. */
28727 if (r2 != r1)
28729 if (!r2->reversed_p)
28731 glyph = r2->glyphs[TEXT_AREA];
28732 end = glyph + r2->used[TEXT_AREA];
28733 x = r2->x;
28735 else
28737 end = r2->glyphs[TEXT_AREA] - 1;
28738 glyph = end + r2->used[TEXT_AREA];
28742 if (!r2->reversed_p)
28744 /* Skip truncation and continuation glyphs near the end of the
28745 row, and also blanks and stretch glyphs inserted by
28746 extend_face_to_end_of_line. */
28747 while (end > glyph
28748 && NILP ((end - 1)->object))
28749 --end;
28750 /* Scan the rest of the glyph row from the end, looking for the
28751 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28752 DISP_STRING, or whose position is between START_CHARPOS
28753 and END_CHARPOS */
28754 for (--end;
28755 end > glyph
28756 && !NILP (end->object)
28757 && !EQ (end->object, disp_string)
28758 && !(BUFFERP (end->object)
28759 && (end->charpos >= start_charpos
28760 && end->charpos < end_charpos));
28761 --end)
28763 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28764 are present at buffer positions between START_CHARPOS and
28765 END_CHARPOS, or if they come from an overlay. */
28766 if (EQ (end->object, before_string))
28768 pos = string_buffer_position (before_string, start_charpos);
28769 if (!pos || (pos >= start_charpos && pos < end_charpos))
28770 break;
28772 else if (EQ (end->object, after_string))
28774 pos = string_buffer_position (after_string, end_charpos);
28775 if (!pos || (pos >= start_charpos && pos < end_charpos))
28776 break;
28779 /* Find the X coordinate of the last glyph to be highlighted. */
28780 for (; glyph <= end; ++glyph)
28781 x += glyph->pixel_width;
28783 hlinfo->mouse_face_end_x = x;
28784 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
28786 else
28788 /* Skip truncation and continuation glyphs near the end of the
28789 row, and also blanks and stretch glyphs inserted by
28790 extend_face_to_end_of_line. */
28791 x = r2->x;
28792 end++;
28793 while (end < glyph
28794 && NILP (end->object))
28796 x += end->pixel_width;
28797 ++end;
28799 /* Scan the rest of the glyph row from the end, looking for the
28800 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28801 DISP_STRING, or whose position is between START_CHARPOS
28802 and END_CHARPOS */
28803 for ( ;
28804 end < glyph
28805 && !NILP (end->object)
28806 && !EQ (end->object, disp_string)
28807 && !(BUFFERP (end->object)
28808 && (end->charpos >= start_charpos
28809 && end->charpos < end_charpos));
28810 ++end)
28812 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28813 are present at buffer positions between START_CHARPOS and
28814 END_CHARPOS, or if they come from an overlay. */
28815 if (EQ (end->object, before_string))
28817 pos = string_buffer_position (before_string, start_charpos);
28818 if (!pos || (pos >= start_charpos && pos < end_charpos))
28819 break;
28821 else if (EQ (end->object, after_string))
28823 pos = string_buffer_position (after_string, end_charpos);
28824 if (!pos || (pos >= start_charpos && pos < end_charpos))
28825 break;
28827 x += end->pixel_width;
28829 /* If we exited the above loop because we arrived at the last
28830 glyph of the row, and its buffer position is still not in
28831 range, it means the last character in range is the preceding
28832 newline. Bump the end column and x values to get past the
28833 last glyph. */
28834 if (end == glyph
28835 && BUFFERP (end->object)
28836 && (end->charpos < start_charpos
28837 || end->charpos >= end_charpos))
28839 x += end->pixel_width;
28840 ++end;
28842 hlinfo->mouse_face_end_x = x;
28843 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
28846 hlinfo->mouse_face_window = window;
28847 hlinfo->mouse_face_face_id
28848 = face_at_buffer_position (w, mouse_charpos, &ignore,
28849 mouse_charpos + 1,
28850 !hlinfo->mouse_face_hidden, -1);
28851 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28854 /* The following function is not used anymore (replaced with
28855 mouse_face_from_string_pos), but I leave it here for the time
28856 being, in case someone would. */
28858 #if false /* not used */
28860 /* Find the position of the glyph for position POS in OBJECT in
28861 window W's current matrix, and return in *X, *Y the pixel
28862 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28864 RIGHT_P means return the position of the right edge of the glyph.
28865 !RIGHT_P means return the left edge position.
28867 If no glyph for POS exists in the matrix, return the position of
28868 the glyph with the next smaller position that is in the matrix, if
28869 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28870 exists in the matrix, return the position of the glyph with the
28871 next larger position in OBJECT.
28873 Value is true if a glyph was found. */
28875 static bool
28876 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
28877 int *hpos, int *vpos, int *x, int *y, bool right_p)
28879 int yb = window_text_bottom_y (w);
28880 struct glyph_row *r;
28881 struct glyph *best_glyph = NULL;
28882 struct glyph_row *best_row = NULL;
28883 int best_x = 0;
28885 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28886 r->enabled_p && r->y < yb;
28887 ++r)
28889 struct glyph *g = r->glyphs[TEXT_AREA];
28890 struct glyph *e = g + r->used[TEXT_AREA];
28891 int gx;
28893 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28894 if (EQ (g->object, object))
28896 if (g->charpos == pos)
28898 best_glyph = g;
28899 best_x = gx;
28900 best_row = r;
28901 goto found;
28903 else if (best_glyph == NULL
28904 || ((eabs (g->charpos - pos)
28905 < eabs (best_glyph->charpos - pos))
28906 && (right_p
28907 ? g->charpos < pos
28908 : g->charpos > pos)))
28910 best_glyph = g;
28911 best_x = gx;
28912 best_row = r;
28917 found:
28919 if (best_glyph)
28921 *x = best_x;
28922 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
28924 if (right_p)
28926 *x += best_glyph->pixel_width;
28927 ++*hpos;
28930 *y = best_row->y;
28931 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
28934 return best_glyph != NULL;
28936 #endif /* not used */
28938 /* Find the positions of the first and the last glyphs in window W's
28939 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28940 (assumed to be a string), and return in HLINFO's mouse_face_*
28941 members the pixel and column/row coordinates of those glyphs. */
28943 static void
28944 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
28945 Lisp_Object object,
28946 ptrdiff_t startpos, ptrdiff_t endpos)
28948 int yb = window_text_bottom_y (w);
28949 struct glyph_row *r;
28950 struct glyph *g, *e;
28951 int gx;
28952 bool found = false;
28954 /* Find the glyph row with at least one position in the range
28955 [STARTPOS..ENDPOS), and the first glyph in that row whose
28956 position belongs to that range. */
28957 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28958 r->enabled_p && r->y < yb;
28959 ++r)
28961 if (!r->reversed_p)
28963 g = r->glyphs[TEXT_AREA];
28964 e = g + r->used[TEXT_AREA];
28965 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28966 if (EQ (g->object, object)
28967 && startpos <= g->charpos && g->charpos < endpos)
28969 hlinfo->mouse_face_beg_row
28970 = MATRIX_ROW_VPOS (r, w->current_matrix);
28971 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28972 hlinfo->mouse_face_beg_x = gx;
28973 found = true;
28974 break;
28977 else
28979 struct glyph *g1;
28981 e = r->glyphs[TEXT_AREA];
28982 g = e + r->used[TEXT_AREA];
28983 for ( ; g > e; --g)
28984 if (EQ ((g-1)->object, object)
28985 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
28987 hlinfo->mouse_face_beg_row
28988 = MATRIX_ROW_VPOS (r, w->current_matrix);
28989 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28990 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
28991 gx += g1->pixel_width;
28992 hlinfo->mouse_face_beg_x = gx;
28993 found = true;
28994 break;
28997 if (found)
28998 break;
29001 if (!found)
29002 return;
29004 /* Starting with the next row, look for the first row which does NOT
29005 include any glyphs whose positions are in the range. */
29006 for (++r; r->enabled_p && r->y < yb; ++r)
29008 g = r->glyphs[TEXT_AREA];
29009 e = g + r->used[TEXT_AREA];
29010 found = false;
29011 for ( ; g < e; ++g)
29012 if (EQ (g->object, object)
29013 && startpos <= g->charpos && g->charpos < endpos)
29015 found = true;
29016 break;
29018 if (!found)
29019 break;
29022 /* The highlighted region ends on the previous row. */
29023 r--;
29025 /* Set the end row. */
29026 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
29028 /* Compute and set the end column and the end column's horizontal
29029 pixel coordinate. */
29030 if (!r->reversed_p)
29032 g = r->glyphs[TEXT_AREA];
29033 e = g + r->used[TEXT_AREA];
29034 for ( ; e > g; --e)
29035 if (EQ ((e-1)->object, object)
29036 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
29037 break;
29038 hlinfo->mouse_face_end_col = e - g;
29040 for (gx = r->x; g < e; ++g)
29041 gx += g->pixel_width;
29042 hlinfo->mouse_face_end_x = gx;
29044 else
29046 e = r->glyphs[TEXT_AREA];
29047 g = e + r->used[TEXT_AREA];
29048 for (gx = r->x ; e < g; ++e)
29050 if (EQ (e->object, object)
29051 && startpos <= e->charpos && e->charpos < endpos)
29052 break;
29053 gx += e->pixel_width;
29055 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
29056 hlinfo->mouse_face_end_x = gx;
29060 #ifdef HAVE_WINDOW_SYSTEM
29062 /* See if position X, Y is within a hot-spot of an image. */
29064 static bool
29065 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
29067 if (!CONSP (hot_spot))
29068 return false;
29070 if (EQ (XCAR (hot_spot), Qrect))
29072 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29073 Lisp_Object rect = XCDR (hot_spot);
29074 Lisp_Object tem;
29075 if (!CONSP (rect))
29076 return false;
29077 if (!CONSP (XCAR (rect)))
29078 return false;
29079 if (!CONSP (XCDR (rect)))
29080 return false;
29081 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
29082 return false;
29083 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
29084 return false;
29085 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
29086 return false;
29087 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
29088 return false;
29089 return true;
29091 else if (EQ (XCAR (hot_spot), Qcircle))
29093 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29094 Lisp_Object circ = XCDR (hot_spot);
29095 Lisp_Object lr, lx0, ly0;
29096 if (CONSP (circ)
29097 && CONSP (XCAR (circ))
29098 && (lr = XCDR (circ), INTEGERP (lr) || FLOATP (lr))
29099 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
29100 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
29102 double r = XFLOATINT (lr);
29103 double dx = XINT (lx0) - x;
29104 double dy = XINT (ly0) - y;
29105 return (dx * dx + dy * dy <= r * r);
29108 else if (EQ (XCAR (hot_spot), Qpoly))
29110 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29111 if (VECTORP (XCDR (hot_spot)))
29113 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
29114 Lisp_Object *poly = v->contents;
29115 ptrdiff_t n = v->header.size;
29116 ptrdiff_t i;
29117 bool inside = false;
29118 Lisp_Object lx, ly;
29119 int x0, y0;
29121 /* Need an even number of coordinates, and at least 3 edges. */
29122 if (n < 6 || n & 1)
29123 return false;
29125 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29126 If count is odd, we are inside polygon. Pixels on edges
29127 may or may not be included depending on actual geometry of the
29128 polygon. */
29129 if ((lx = poly[n-2], !INTEGERP (lx))
29130 || (ly = poly[n-1], !INTEGERP (lx)))
29131 return false;
29132 x0 = XINT (lx), y0 = XINT (ly);
29133 for (i = 0; i < n; i += 2)
29135 int x1 = x0, y1 = y0;
29136 if ((lx = poly[i], !INTEGERP (lx))
29137 || (ly = poly[i+1], !INTEGERP (ly)))
29138 return false;
29139 x0 = XINT (lx), y0 = XINT (ly);
29141 /* Does this segment cross the X line? */
29142 if (x0 >= x)
29144 if (x1 >= x)
29145 continue;
29147 else if (x1 < x)
29148 continue;
29149 if (y > y0 && y > y1)
29150 continue;
29151 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
29152 inside = !inside;
29154 return inside;
29157 return false;
29160 Lisp_Object
29161 find_hot_spot (Lisp_Object map, int x, int y)
29163 while (CONSP (map))
29165 if (CONSP (XCAR (map))
29166 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
29167 return XCAR (map);
29168 map = XCDR (map);
29171 return Qnil;
29174 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
29175 3, 3, 0,
29176 doc: /* Lookup in image map MAP coordinates X and Y.
29177 An image map is an alist where each element has the format (AREA ID PLIST).
29178 An AREA is specified as either a rectangle, a circle, or a polygon:
29179 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29180 pixel coordinates of the upper left and bottom right corners.
29181 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29182 and the radius of the circle; r may be a float or integer.
29183 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29184 vector describes one corner in the polygon.
29185 Returns the alist element for the first matching AREA in MAP. */)
29186 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
29188 if (NILP (map))
29189 return Qnil;
29191 CHECK_NUMBER (x);
29192 CHECK_NUMBER (y);
29194 return find_hot_spot (map,
29195 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
29196 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
29200 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29201 static void
29202 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
29204 /* Do not change cursor shape while dragging mouse. */
29205 if (EQ (do_mouse_tracking, Qdragging))
29206 return;
29208 if (!NILP (pointer))
29210 if (EQ (pointer, Qarrow))
29211 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29212 else if (EQ (pointer, Qhand))
29213 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
29214 else if (EQ (pointer, Qtext))
29215 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29216 else if (EQ (pointer, intern ("hdrag")))
29217 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29218 else if (EQ (pointer, intern ("nhdrag")))
29219 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29220 #ifdef HAVE_X_WINDOWS
29221 else if (EQ (pointer, intern ("vdrag")))
29222 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29223 #endif
29224 else if (EQ (pointer, intern ("hourglass")))
29225 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
29226 else if (EQ (pointer, Qmodeline))
29227 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
29228 else
29229 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29232 if (cursor != No_Cursor)
29233 FRAME_RIF (f)->define_frame_cursor (f, cursor);
29236 #endif /* HAVE_WINDOW_SYSTEM */
29238 /* Take proper action when mouse has moved to the mode or header line
29239 or marginal area AREA of window W, x-position X and y-position Y.
29240 X is relative to the start of the text display area of W, so the
29241 width of bitmap areas and scroll bars must be subtracted to get a
29242 position relative to the start of the mode line. */
29244 static void
29245 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
29246 enum window_part area)
29248 struct window *w = XWINDOW (window);
29249 struct frame *f = XFRAME (w->frame);
29250 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29251 #ifdef HAVE_WINDOW_SYSTEM
29252 Display_Info *dpyinfo;
29253 #endif
29254 Cursor cursor = No_Cursor;
29255 Lisp_Object pointer = Qnil;
29256 int dx, dy, width, height;
29257 ptrdiff_t charpos;
29258 Lisp_Object string, object = Qnil;
29259 Lisp_Object pos IF_LINT (= Qnil), help;
29261 Lisp_Object mouse_face;
29262 int original_x_pixel = x;
29263 struct glyph * glyph = NULL, * row_start_glyph = NULL;
29264 struct glyph_row *row IF_LINT (= 0);
29266 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
29268 int x0;
29269 struct glyph *end;
29271 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29272 returns them in row/column units! */
29273 string = mode_line_string (w, area, &x, &y, &charpos,
29274 &object, &dx, &dy, &width, &height);
29276 row = (area == ON_MODE_LINE
29277 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
29278 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
29280 /* Find the glyph under the mouse pointer. */
29281 if (row->mode_line_p && row->enabled_p)
29283 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
29284 end = glyph + row->used[TEXT_AREA];
29286 for (x0 = original_x_pixel;
29287 glyph < end && x0 >= glyph->pixel_width;
29288 ++glyph)
29289 x0 -= glyph->pixel_width;
29291 if (glyph >= end)
29292 glyph = NULL;
29295 else
29297 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
29298 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29299 returns them in row/column units! */
29300 string = marginal_area_string (w, area, &x, &y, &charpos,
29301 &object, &dx, &dy, &width, &height);
29304 help = Qnil;
29306 #ifdef HAVE_WINDOW_SYSTEM
29307 if (IMAGEP (object))
29309 Lisp_Object image_map, hotspot;
29310 if ((image_map = Fplist_get (XCDR (object), QCmap),
29311 !NILP (image_map))
29312 && (hotspot = find_hot_spot (image_map, dx, dy),
29313 CONSP (hotspot))
29314 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29316 Lisp_Object plist;
29318 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29319 If so, we could look for mouse-enter, mouse-leave
29320 properties in PLIST (and do something...). */
29321 hotspot = XCDR (hotspot);
29322 if (CONSP (hotspot)
29323 && (plist = XCAR (hotspot), CONSP (plist)))
29325 pointer = Fplist_get (plist, Qpointer);
29326 if (NILP (pointer))
29327 pointer = Qhand;
29328 help = Fplist_get (plist, Qhelp_echo);
29329 if (!NILP (help))
29331 help_echo_string = help;
29332 XSETWINDOW (help_echo_window, w);
29333 help_echo_object = w->contents;
29334 help_echo_pos = charpos;
29338 if (NILP (pointer))
29339 pointer = Fplist_get (XCDR (object), QCpointer);
29341 #endif /* HAVE_WINDOW_SYSTEM */
29343 if (STRINGP (string))
29344 pos = make_number (charpos);
29346 /* Set the help text and mouse pointer. If the mouse is on a part
29347 of the mode line without any text (e.g. past the right edge of
29348 the mode line text), use the default help text and pointer. */
29349 if (STRINGP (string) || area == ON_MODE_LINE)
29351 /* Arrange to display the help by setting the global variables
29352 help_echo_string, help_echo_object, and help_echo_pos. */
29353 if (NILP (help))
29355 if (STRINGP (string))
29356 help = Fget_text_property (pos, Qhelp_echo, string);
29358 if (!NILP (help))
29360 help_echo_string = help;
29361 XSETWINDOW (help_echo_window, w);
29362 help_echo_object = string;
29363 help_echo_pos = charpos;
29365 else if (area == ON_MODE_LINE)
29367 Lisp_Object default_help
29368 = buffer_local_value (Qmode_line_default_help_echo,
29369 w->contents);
29371 if (STRINGP (default_help))
29373 help_echo_string = default_help;
29374 XSETWINDOW (help_echo_window, w);
29375 help_echo_object = Qnil;
29376 help_echo_pos = -1;
29381 #ifdef HAVE_WINDOW_SYSTEM
29382 /* Change the mouse pointer according to what is under it. */
29383 if (FRAME_WINDOW_P (f))
29385 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
29386 || minibuf_level
29387 || NILP (Vresize_mini_windows));
29389 dpyinfo = FRAME_DISPLAY_INFO (f);
29390 if (STRINGP (string))
29392 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29394 if (NILP (pointer))
29395 pointer = Fget_text_property (pos, Qpointer, string);
29397 /* Change the mouse pointer according to what is under X/Y. */
29398 if (NILP (pointer)
29399 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
29401 Lisp_Object map;
29402 map = Fget_text_property (pos, Qlocal_map, string);
29403 if (!KEYMAPP (map))
29404 map = Fget_text_property (pos, Qkeymap, string);
29405 if (!KEYMAPP (map) && draggable)
29406 cursor = dpyinfo->vertical_scroll_bar_cursor;
29409 else if (draggable)
29410 /* Default mode-line pointer. */
29411 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29413 #endif
29416 /* Change the mouse face according to what is under X/Y. */
29417 bool mouse_face_shown = false;
29418 if (STRINGP (string))
29420 mouse_face = Fget_text_property (pos, Qmouse_face, string);
29421 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
29422 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29423 && glyph)
29425 Lisp_Object b, e;
29427 struct glyph * tmp_glyph;
29429 int gpos;
29430 int gseq_length;
29431 int total_pixel_width;
29432 ptrdiff_t begpos, endpos, ignore;
29434 int vpos, hpos;
29436 b = Fprevious_single_property_change (make_number (charpos + 1),
29437 Qmouse_face, string, Qnil);
29438 if (NILP (b))
29439 begpos = 0;
29440 else
29441 begpos = XINT (b);
29443 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
29444 if (NILP (e))
29445 endpos = SCHARS (string);
29446 else
29447 endpos = XINT (e);
29449 /* Calculate the glyph position GPOS of GLYPH in the
29450 displayed string, relative to the beginning of the
29451 highlighted part of the string.
29453 Note: GPOS is different from CHARPOS. CHARPOS is the
29454 position of GLYPH in the internal string object. A mode
29455 line string format has structures which are converted to
29456 a flattened string by the Emacs Lisp interpreter. The
29457 internal string is an element of those structures. The
29458 displayed string is the flattened string. */
29459 tmp_glyph = row_start_glyph;
29460 while (tmp_glyph < glyph
29461 && (!(EQ (tmp_glyph->object, glyph->object)
29462 && begpos <= tmp_glyph->charpos
29463 && tmp_glyph->charpos < endpos)))
29464 tmp_glyph++;
29465 gpos = glyph - tmp_glyph;
29467 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29468 the highlighted part of the displayed string to which
29469 GLYPH belongs. Note: GSEQ_LENGTH is different from
29470 SCHARS (STRING), because the latter returns the length of
29471 the internal string. */
29472 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
29473 tmp_glyph > glyph
29474 && (!(EQ (tmp_glyph->object, glyph->object)
29475 && begpos <= tmp_glyph->charpos
29476 && tmp_glyph->charpos < endpos));
29477 tmp_glyph--)
29479 gseq_length = gpos + (tmp_glyph - glyph) + 1;
29481 /* Calculate the total pixel width of all the glyphs between
29482 the beginning of the highlighted area and GLYPH. */
29483 total_pixel_width = 0;
29484 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
29485 total_pixel_width += tmp_glyph->pixel_width;
29487 /* Pre calculation of re-rendering position. Note: X is in
29488 column units here, after the call to mode_line_string or
29489 marginal_area_string. */
29490 hpos = x - gpos;
29491 vpos = (area == ON_MODE_LINE
29492 ? (w->current_matrix)->nrows - 1
29493 : 0);
29495 /* If GLYPH's position is included in the region that is
29496 already drawn in mouse face, we have nothing to do. */
29497 if ( EQ (window, hlinfo->mouse_face_window)
29498 && (!row->reversed_p
29499 ? (hlinfo->mouse_face_beg_col <= hpos
29500 && hpos < hlinfo->mouse_face_end_col)
29501 /* In R2L rows we swap BEG and END, see below. */
29502 : (hlinfo->mouse_face_end_col <= hpos
29503 && hpos < hlinfo->mouse_face_beg_col))
29504 && hlinfo->mouse_face_beg_row == vpos )
29505 return;
29507 if (clear_mouse_face (hlinfo))
29508 cursor = No_Cursor;
29510 if (!row->reversed_p)
29512 hlinfo->mouse_face_beg_col = hpos;
29513 hlinfo->mouse_face_beg_x = original_x_pixel
29514 - (total_pixel_width + dx);
29515 hlinfo->mouse_face_end_col = hpos + gseq_length;
29516 hlinfo->mouse_face_end_x = 0;
29518 else
29520 /* In R2L rows, show_mouse_face expects BEG and END
29521 coordinates to be swapped. */
29522 hlinfo->mouse_face_end_col = hpos;
29523 hlinfo->mouse_face_end_x = original_x_pixel
29524 - (total_pixel_width + dx);
29525 hlinfo->mouse_face_beg_col = hpos + gseq_length;
29526 hlinfo->mouse_face_beg_x = 0;
29529 hlinfo->mouse_face_beg_row = vpos;
29530 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
29531 hlinfo->mouse_face_past_end = false;
29532 hlinfo->mouse_face_window = window;
29534 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
29535 charpos,
29536 0, &ignore,
29537 glyph->face_id,
29538 true);
29539 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29540 mouse_face_shown = true;
29542 if (NILP (pointer))
29543 pointer = Qhand;
29547 /* If mouse-face doesn't need to be shown, clear any existing
29548 mouse-face. */
29549 if ((area == ON_MODE_LINE || area == ON_HEADER_LINE) && !mouse_face_shown)
29550 clear_mouse_face (hlinfo);
29552 #ifdef HAVE_WINDOW_SYSTEM
29553 if (FRAME_WINDOW_P (f))
29554 define_frame_cursor1 (f, cursor, pointer);
29555 #endif
29559 /* EXPORT:
29560 Take proper action when the mouse has moved to position X, Y on
29561 frame F with regards to highlighting portions of display that have
29562 mouse-face properties. Also de-highlight portions of display where
29563 the mouse was before, set the mouse pointer shape as appropriate
29564 for the mouse coordinates, and activate help echo (tooltips).
29565 X and Y can be negative or out of range. */
29567 void
29568 note_mouse_highlight (struct frame *f, int x, int y)
29570 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29571 enum window_part part = ON_NOTHING;
29572 Lisp_Object window;
29573 struct window *w;
29574 Cursor cursor = No_Cursor;
29575 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
29576 struct buffer *b;
29578 /* When a menu is active, don't highlight because this looks odd. */
29579 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29580 if (popup_activated ())
29581 return;
29582 #endif
29584 if (!f->glyphs_initialized_p
29585 || f->pointer_invisible)
29586 return;
29588 hlinfo->mouse_face_mouse_x = x;
29589 hlinfo->mouse_face_mouse_y = y;
29590 hlinfo->mouse_face_mouse_frame = f;
29592 if (hlinfo->mouse_face_defer)
29593 return;
29595 /* Which window is that in? */
29596 window = window_from_coordinates (f, x, y, &part, true);
29598 /* If displaying active text in another window, clear that. */
29599 if (! EQ (window, hlinfo->mouse_face_window)
29600 /* Also clear if we move out of text area in same window. */
29601 || (!NILP (hlinfo->mouse_face_window)
29602 && !NILP (window)
29603 && part != ON_TEXT
29604 && part != ON_MODE_LINE
29605 && part != ON_HEADER_LINE))
29606 clear_mouse_face (hlinfo);
29608 /* Not on a window -> return. */
29609 if (!WINDOWP (window))
29610 return;
29612 /* Reset help_echo_string. It will get recomputed below. */
29613 help_echo_string = Qnil;
29615 /* Convert to window-relative pixel coordinates. */
29616 w = XWINDOW (window);
29617 frame_to_window_pixel_xy (w, &x, &y);
29619 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29620 /* Handle tool-bar window differently since it doesn't display a
29621 buffer. */
29622 if (EQ (window, f->tool_bar_window))
29624 note_tool_bar_highlight (f, x, y);
29625 return;
29627 #endif
29629 /* Mouse is on the mode, header line or margin? */
29630 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
29631 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29633 note_mode_line_or_margin_highlight (window, x, y, part);
29635 #ifdef HAVE_WINDOW_SYSTEM
29636 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29638 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29639 /* Show non-text cursor (Bug#16647). */
29640 goto set_cursor;
29642 else
29643 #endif
29644 return;
29647 #ifdef HAVE_WINDOW_SYSTEM
29648 if (part == ON_VERTICAL_BORDER)
29650 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29651 help_echo_string = build_string ("drag-mouse-1: resize");
29653 else if (part == ON_RIGHT_DIVIDER)
29655 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29656 help_echo_string = build_string ("drag-mouse-1: resize");
29658 else if (part == ON_BOTTOM_DIVIDER)
29659 if (! WINDOW_BOTTOMMOST_P (w)
29660 || minibuf_level
29661 || NILP (Vresize_mini_windows))
29663 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29664 help_echo_string = build_string ("drag-mouse-1: resize");
29666 else
29667 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29668 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
29669 || part == ON_VERTICAL_SCROLL_BAR
29670 || part == ON_HORIZONTAL_SCROLL_BAR)
29671 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29672 else
29673 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29674 #endif
29676 /* Are we in a window whose display is up to date?
29677 And verify the buffer's text has not changed. */
29678 b = XBUFFER (w->contents);
29679 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
29681 int hpos, vpos, dx, dy, area = LAST_AREA;
29682 ptrdiff_t pos;
29683 struct glyph *glyph;
29684 Lisp_Object object;
29685 Lisp_Object mouse_face = Qnil, position;
29686 Lisp_Object *overlay_vec = NULL;
29687 ptrdiff_t i, noverlays;
29688 struct buffer *obuf;
29689 ptrdiff_t obegv, ozv;
29690 bool same_region;
29692 /* Find the glyph under X/Y. */
29693 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
29695 #ifdef HAVE_WINDOW_SYSTEM
29696 /* Look for :pointer property on image. */
29697 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
29699 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
29700 if (img != NULL && IMAGEP (img->spec))
29702 Lisp_Object image_map, hotspot;
29703 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
29704 !NILP (image_map))
29705 && (hotspot = find_hot_spot (image_map,
29706 glyph->slice.img.x + dx,
29707 glyph->slice.img.y + dy),
29708 CONSP (hotspot))
29709 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29711 Lisp_Object plist;
29713 /* Could check XCAR (hotspot) to see if we enter/leave
29714 this hot-spot.
29715 If so, we could look for mouse-enter, mouse-leave
29716 properties in PLIST (and do something...). */
29717 hotspot = XCDR (hotspot);
29718 if (CONSP (hotspot)
29719 && (plist = XCAR (hotspot), CONSP (plist)))
29721 pointer = Fplist_get (plist, Qpointer);
29722 if (NILP (pointer))
29723 pointer = Qhand;
29724 help_echo_string = Fplist_get (plist, Qhelp_echo);
29725 if (!NILP (help_echo_string))
29727 help_echo_window = window;
29728 help_echo_object = glyph->object;
29729 help_echo_pos = glyph->charpos;
29733 if (NILP (pointer))
29734 pointer = Fplist_get (XCDR (img->spec), QCpointer);
29737 #endif /* HAVE_WINDOW_SYSTEM */
29739 /* Clear mouse face if X/Y not over text. */
29740 if (glyph == NULL
29741 || area != TEXT_AREA
29742 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
29743 /* Glyph's OBJECT is nil for glyphs inserted by the
29744 display engine for its internal purposes, like truncation
29745 and continuation glyphs and blanks beyond the end of
29746 line's text on text terminals. If we are over such a
29747 glyph, we are not over any text. */
29748 || NILP (glyph->object)
29749 /* R2L rows have a stretch glyph at their front, which
29750 stands for no text, whereas L2R rows have no glyphs at
29751 all beyond the end of text. Treat such stretch glyphs
29752 like we do with NULL glyphs in L2R rows. */
29753 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
29754 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
29755 && glyph->type == STRETCH_GLYPH
29756 && glyph->avoid_cursor_p))
29758 if (clear_mouse_face (hlinfo))
29759 cursor = No_Cursor;
29760 #ifdef HAVE_WINDOW_SYSTEM
29761 if (FRAME_WINDOW_P (f) && NILP (pointer))
29763 if (area != TEXT_AREA)
29764 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29765 else
29766 pointer = Vvoid_text_area_pointer;
29768 #endif
29769 goto set_cursor;
29772 pos = glyph->charpos;
29773 object = glyph->object;
29774 if (!STRINGP (object) && !BUFFERP (object))
29775 goto set_cursor;
29777 /* If we get an out-of-range value, return now; avoid an error. */
29778 if (BUFFERP (object) && pos > BUF_Z (b))
29779 goto set_cursor;
29781 /* Make the window's buffer temporarily current for
29782 overlays_at and compute_char_face. */
29783 obuf = current_buffer;
29784 current_buffer = b;
29785 obegv = BEGV;
29786 ozv = ZV;
29787 BEGV = BEG;
29788 ZV = Z;
29790 /* Is this char mouse-active or does it have help-echo? */
29791 position = make_number (pos);
29793 USE_SAFE_ALLOCA;
29795 if (BUFFERP (object))
29797 /* Put all the overlays we want in a vector in overlay_vec. */
29798 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, false);
29799 /* Sort overlays into increasing priority order. */
29800 noverlays = sort_overlays (overlay_vec, noverlays, w);
29802 else
29803 noverlays = 0;
29805 if (NILP (Vmouse_highlight))
29807 clear_mouse_face (hlinfo);
29808 goto check_help_echo;
29811 same_region = coords_in_mouse_face_p (w, hpos, vpos);
29813 if (same_region)
29814 cursor = No_Cursor;
29816 /* Check mouse-face highlighting. */
29817 if (! same_region
29818 /* If there exists an overlay with mouse-face overlapping
29819 the one we are currently highlighting, we have to
29820 check if we enter the overlapping overlay, and then
29821 highlight only that. */
29822 || (OVERLAYP (hlinfo->mouse_face_overlay)
29823 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
29825 /* Find the highest priority overlay with a mouse-face. */
29826 Lisp_Object overlay = Qnil;
29827 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
29829 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
29830 if (!NILP (mouse_face))
29831 overlay = overlay_vec[i];
29834 /* If we're highlighting the same overlay as before, there's
29835 no need to do that again. */
29836 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
29837 goto check_help_echo;
29838 hlinfo->mouse_face_overlay = overlay;
29840 /* Clear the display of the old active region, if any. */
29841 if (clear_mouse_face (hlinfo))
29842 cursor = No_Cursor;
29844 /* If no overlay applies, get a text property. */
29845 if (NILP (overlay))
29846 mouse_face = Fget_text_property (position, Qmouse_face, object);
29848 /* Next, compute the bounds of the mouse highlighting and
29849 display it. */
29850 if (!NILP (mouse_face) && STRINGP (object))
29852 /* The mouse-highlighting comes from a display string
29853 with a mouse-face. */
29854 Lisp_Object s, e;
29855 ptrdiff_t ignore;
29857 s = Fprevious_single_property_change
29858 (make_number (pos + 1), Qmouse_face, object, Qnil);
29859 e = Fnext_single_property_change
29860 (position, Qmouse_face, object, Qnil);
29861 if (NILP (s))
29862 s = make_number (0);
29863 if (NILP (e))
29864 e = make_number (SCHARS (object));
29865 mouse_face_from_string_pos (w, hlinfo, object,
29866 XINT (s), XINT (e));
29867 hlinfo->mouse_face_past_end = false;
29868 hlinfo->mouse_face_window = window;
29869 hlinfo->mouse_face_face_id
29870 = face_at_string_position (w, object, pos, 0, &ignore,
29871 glyph->face_id, true);
29872 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29873 cursor = No_Cursor;
29875 else
29877 /* The mouse-highlighting, if any, comes from an overlay
29878 or text property in the buffer. */
29879 Lisp_Object buffer IF_LINT (= Qnil);
29880 Lisp_Object disp_string IF_LINT (= Qnil);
29882 if (STRINGP (object))
29884 /* If we are on a display string with no mouse-face,
29885 check if the text under it has one. */
29886 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
29887 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29888 pos = string_buffer_position (object, start);
29889 if (pos > 0)
29891 mouse_face = get_char_property_and_overlay
29892 (make_number (pos), Qmouse_face, w->contents, &overlay);
29893 buffer = w->contents;
29894 disp_string = object;
29897 else
29899 buffer = object;
29900 disp_string = Qnil;
29903 if (!NILP (mouse_face))
29905 Lisp_Object before, after;
29906 Lisp_Object before_string, after_string;
29907 /* To correctly find the limits of mouse highlight
29908 in a bidi-reordered buffer, we must not use the
29909 optimization of limiting the search in
29910 previous-single-property-change and
29911 next-single-property-change, because
29912 rows_from_pos_range needs the real start and end
29913 positions to DTRT in this case. That's because
29914 the first row visible in a window does not
29915 necessarily display the character whose position
29916 is the smallest. */
29917 Lisp_Object lim1
29918 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29919 ? Fmarker_position (w->start)
29920 : Qnil;
29921 Lisp_Object lim2
29922 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29923 ? make_number (BUF_Z (XBUFFER (buffer))
29924 - w->window_end_pos)
29925 : Qnil;
29927 if (NILP (overlay))
29929 /* Handle the text property case. */
29930 before = Fprevious_single_property_change
29931 (make_number (pos + 1), Qmouse_face, buffer, lim1);
29932 after = Fnext_single_property_change
29933 (make_number (pos), Qmouse_face, buffer, lim2);
29934 before_string = after_string = Qnil;
29936 else
29938 /* Handle the overlay case. */
29939 before = Foverlay_start (overlay);
29940 after = Foverlay_end (overlay);
29941 before_string = Foverlay_get (overlay, Qbefore_string);
29942 after_string = Foverlay_get (overlay, Qafter_string);
29944 if (!STRINGP (before_string)) before_string = Qnil;
29945 if (!STRINGP (after_string)) after_string = Qnil;
29948 mouse_face_from_buffer_pos (window, hlinfo, pos,
29949 NILP (before)
29951 : XFASTINT (before),
29952 NILP (after)
29953 ? BUF_Z (XBUFFER (buffer))
29954 : XFASTINT (after),
29955 before_string, after_string,
29956 disp_string);
29957 cursor = No_Cursor;
29962 check_help_echo:
29964 /* Look for a `help-echo' property. */
29965 if (NILP (help_echo_string)) {
29966 Lisp_Object help, overlay;
29968 /* Check overlays first. */
29969 help = overlay = Qnil;
29970 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
29972 overlay = overlay_vec[i];
29973 help = Foverlay_get (overlay, Qhelp_echo);
29976 if (!NILP (help))
29978 help_echo_string = help;
29979 help_echo_window = window;
29980 help_echo_object = overlay;
29981 help_echo_pos = pos;
29983 else
29985 Lisp_Object obj = glyph->object;
29986 ptrdiff_t charpos = glyph->charpos;
29988 /* Try text properties. */
29989 if (STRINGP (obj)
29990 && charpos >= 0
29991 && charpos < SCHARS (obj))
29993 help = Fget_text_property (make_number (charpos),
29994 Qhelp_echo, obj);
29995 if (NILP (help))
29997 /* If the string itself doesn't specify a help-echo,
29998 see if the buffer text ``under'' it does. */
29999 struct glyph_row *r
30000 = MATRIX_ROW (w->current_matrix, vpos);
30001 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30002 ptrdiff_t p = string_buffer_position (obj, start);
30003 if (p > 0)
30005 help = Fget_char_property (make_number (p),
30006 Qhelp_echo, w->contents);
30007 if (!NILP (help))
30009 charpos = p;
30010 obj = w->contents;
30015 else if (BUFFERP (obj)
30016 && charpos >= BEGV
30017 && charpos < ZV)
30018 help = Fget_text_property (make_number (charpos), Qhelp_echo,
30019 obj);
30021 if (!NILP (help))
30023 help_echo_string = help;
30024 help_echo_window = window;
30025 help_echo_object = obj;
30026 help_echo_pos = charpos;
30031 #ifdef HAVE_WINDOW_SYSTEM
30032 /* Look for a `pointer' property. */
30033 if (FRAME_WINDOW_P (f) && NILP (pointer))
30035 /* Check overlays first. */
30036 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
30037 pointer = Foverlay_get (overlay_vec[i], Qpointer);
30039 if (NILP (pointer))
30041 Lisp_Object obj = glyph->object;
30042 ptrdiff_t charpos = glyph->charpos;
30044 /* Try text properties. */
30045 if (STRINGP (obj)
30046 && charpos >= 0
30047 && charpos < SCHARS (obj))
30049 pointer = Fget_text_property (make_number (charpos),
30050 Qpointer, obj);
30051 if (NILP (pointer))
30053 /* If the string itself doesn't specify a pointer,
30054 see if the buffer text ``under'' it does. */
30055 struct glyph_row *r
30056 = MATRIX_ROW (w->current_matrix, vpos);
30057 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30058 ptrdiff_t p = string_buffer_position (obj, start);
30059 if (p > 0)
30060 pointer = Fget_char_property (make_number (p),
30061 Qpointer, w->contents);
30064 else if (BUFFERP (obj)
30065 && charpos >= BEGV
30066 && charpos < ZV)
30067 pointer = Fget_text_property (make_number (charpos),
30068 Qpointer, obj);
30071 #endif /* HAVE_WINDOW_SYSTEM */
30073 BEGV = obegv;
30074 ZV = ozv;
30075 current_buffer = obuf;
30076 SAFE_FREE ();
30079 set_cursor:
30081 #ifdef HAVE_WINDOW_SYSTEM
30082 if (FRAME_WINDOW_P (f))
30083 define_frame_cursor1 (f, cursor, pointer);
30084 #else
30085 /* This is here to prevent a compiler error, about "label at end of
30086 compound statement". */
30087 return;
30088 #endif
30092 /* EXPORT for RIF:
30093 Clear any mouse-face on window W. This function is part of the
30094 redisplay interface, and is called from try_window_id and similar
30095 functions to ensure the mouse-highlight is off. */
30097 void
30098 x_clear_window_mouse_face (struct window *w)
30100 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
30101 Lisp_Object window;
30103 block_input ();
30104 XSETWINDOW (window, w);
30105 if (EQ (window, hlinfo->mouse_face_window))
30106 clear_mouse_face (hlinfo);
30107 unblock_input ();
30111 /* EXPORT:
30112 Just discard the mouse face information for frame F, if any.
30113 This is used when the size of F is changed. */
30115 void
30116 cancel_mouse_face (struct frame *f)
30118 Lisp_Object window;
30119 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30121 window = hlinfo->mouse_face_window;
30122 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
30123 reset_mouse_highlight (hlinfo);
30128 /***********************************************************************
30129 Exposure Events
30130 ***********************************************************************/
30132 #ifdef HAVE_WINDOW_SYSTEM
30134 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30135 which intersects rectangle R. R is in window-relative coordinates. */
30137 static void
30138 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
30139 enum glyph_row_area area)
30141 struct glyph *first = row->glyphs[area];
30142 struct glyph *end = row->glyphs[area] + row->used[area];
30143 struct glyph *last;
30144 int first_x, start_x, x;
30146 if (area == TEXT_AREA && row->fill_line_p)
30147 /* If row extends face to end of line write the whole line. */
30148 draw_glyphs (w, 0, row, area,
30149 0, row->used[area],
30150 DRAW_NORMAL_TEXT, 0);
30151 else
30153 /* Set START_X to the window-relative start position for drawing glyphs of
30154 AREA. The first glyph of the text area can be partially visible.
30155 The first glyphs of other areas cannot. */
30156 start_x = window_box_left_offset (w, area);
30157 x = start_x;
30158 if (area == TEXT_AREA)
30159 x += row->x;
30161 /* Find the first glyph that must be redrawn. */
30162 while (first < end
30163 && x + first->pixel_width < r->x)
30165 x += first->pixel_width;
30166 ++first;
30169 /* Find the last one. */
30170 last = first;
30171 first_x = x;
30172 /* Use a signed int intermediate value to avoid catastrophic
30173 failures due to comparison between signed and unsigned, when
30174 x is negative (can happen for wide images that are hscrolled). */
30175 int r_end = r->x + r->width;
30176 while (last < end && x < r_end)
30178 x += last->pixel_width;
30179 ++last;
30182 /* Repaint. */
30183 if (last > first)
30184 draw_glyphs (w, first_x - start_x, row, area,
30185 first - row->glyphs[area], last - row->glyphs[area],
30186 DRAW_NORMAL_TEXT, 0);
30191 /* Redraw the parts of the glyph row ROW on window W intersecting
30192 rectangle R. R is in window-relative coordinates. Value is
30193 true if mouse-face was overwritten. */
30195 static bool
30196 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
30198 eassert (row->enabled_p);
30200 if (row->mode_line_p || w->pseudo_window_p)
30201 draw_glyphs (w, 0, row, TEXT_AREA,
30202 0, row->used[TEXT_AREA],
30203 DRAW_NORMAL_TEXT, 0);
30204 else
30206 if (row->used[LEFT_MARGIN_AREA])
30207 expose_area (w, row, r, LEFT_MARGIN_AREA);
30208 if (row->used[TEXT_AREA])
30209 expose_area (w, row, r, TEXT_AREA);
30210 if (row->used[RIGHT_MARGIN_AREA])
30211 expose_area (w, row, r, RIGHT_MARGIN_AREA);
30212 draw_row_fringe_bitmaps (w, row);
30215 return row->mouse_face_p;
30219 /* Redraw those parts of glyphs rows during expose event handling that
30220 overlap other rows. Redrawing of an exposed line writes over parts
30221 of lines overlapping that exposed line; this function fixes that.
30223 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30224 row in W's current matrix that is exposed and overlaps other rows.
30225 LAST_OVERLAPPING_ROW is the last such row. */
30227 static void
30228 expose_overlaps (struct window *w,
30229 struct glyph_row *first_overlapping_row,
30230 struct glyph_row *last_overlapping_row,
30231 XRectangle *r)
30233 struct glyph_row *row;
30235 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
30236 if (row->overlapping_p)
30238 eassert (row->enabled_p && !row->mode_line_p);
30240 row->clip = r;
30241 if (row->used[LEFT_MARGIN_AREA])
30242 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
30244 if (row->used[TEXT_AREA])
30245 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
30247 if (row->used[RIGHT_MARGIN_AREA])
30248 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
30249 row->clip = NULL;
30254 /* Return true if W's cursor intersects rectangle R. */
30256 static bool
30257 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
30259 XRectangle cr, result;
30260 struct glyph *cursor_glyph;
30261 struct glyph_row *row;
30263 if (w->phys_cursor.vpos >= 0
30264 && w->phys_cursor.vpos < w->current_matrix->nrows
30265 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
30266 row->enabled_p)
30267 && row->cursor_in_fringe_p)
30269 /* Cursor is in the fringe. */
30270 cr.x = window_box_right_offset (w,
30271 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
30272 ? RIGHT_MARGIN_AREA
30273 : TEXT_AREA));
30274 cr.y = row->y;
30275 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
30276 cr.height = row->height;
30277 return x_intersect_rectangles (&cr, r, &result);
30280 cursor_glyph = get_phys_cursor_glyph (w);
30281 if (cursor_glyph)
30283 /* r is relative to W's box, but w->phys_cursor.x is relative
30284 to left edge of W's TEXT area. Adjust it. */
30285 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
30286 cr.y = w->phys_cursor.y;
30287 cr.width = cursor_glyph->pixel_width;
30288 cr.height = w->phys_cursor_height;
30289 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30290 I assume the effect is the same -- and this is portable. */
30291 return x_intersect_rectangles (&cr, r, &result);
30293 /* If we don't understand the format, pretend we're not in the hot-spot. */
30294 return false;
30298 /* EXPORT:
30299 Draw a vertical window border to the right of window W if W doesn't
30300 have vertical scroll bars. */
30302 void
30303 x_draw_vertical_border (struct window *w)
30305 struct frame *f = XFRAME (WINDOW_FRAME (w));
30307 /* We could do better, if we knew what type of scroll-bar the adjacent
30308 windows (on either side) have... But we don't :-(
30309 However, I think this works ok. ++KFS 2003-04-25 */
30311 /* Redraw borders between horizontally adjacent windows. Don't
30312 do it for frames with vertical scroll bars because either the
30313 right scroll bar of a window, or the left scroll bar of its
30314 neighbor will suffice as a border. */
30315 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
30316 return;
30318 /* Note: It is necessary to redraw both the left and the right
30319 borders, for when only this single window W is being
30320 redisplayed. */
30321 if (!WINDOW_RIGHTMOST_P (w)
30322 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
30324 int x0, x1, y0, y1;
30326 window_box_edges (w, &x0, &y0, &x1, &y1);
30327 y1 -= 1;
30329 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30330 x1 -= 1;
30332 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
30335 if (!WINDOW_LEFTMOST_P (w)
30336 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
30338 int x0, x1, y0, y1;
30340 window_box_edges (w, &x0, &y0, &x1, &y1);
30341 y1 -= 1;
30343 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30344 x0 -= 1;
30346 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
30351 /* Draw window dividers for window W. */
30353 void
30354 x_draw_right_divider (struct window *w)
30356 struct frame *f = WINDOW_XFRAME (w);
30358 if (w->mini || w->pseudo_window_p)
30359 return;
30360 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30362 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
30363 int x1 = WINDOW_RIGHT_EDGE_X (w);
30364 int y0 = WINDOW_TOP_EDGE_Y (w);
30365 /* The bottom divider prevails. */
30366 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30368 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30372 static void
30373 x_draw_bottom_divider (struct window *w)
30375 struct frame *f = XFRAME (WINDOW_FRAME (w));
30377 if (w->mini || w->pseudo_window_p)
30378 return;
30379 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30381 int x0 = WINDOW_LEFT_EDGE_X (w);
30382 int x1 = WINDOW_RIGHT_EDGE_X (w);
30383 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30384 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
30386 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30390 /* Redraw the part of window W intersection rectangle FR. Pixel
30391 coordinates in FR are frame-relative. Call this function with
30392 input blocked. Value is true if the exposure overwrites
30393 mouse-face. */
30395 static bool
30396 expose_window (struct window *w, XRectangle *fr)
30398 struct frame *f = XFRAME (w->frame);
30399 XRectangle wr, r;
30400 bool mouse_face_overwritten_p = false;
30402 /* If window is not yet fully initialized, do nothing. This can
30403 happen when toolkit scroll bars are used and a window is split.
30404 Reconfiguring the scroll bar will generate an expose for a newly
30405 created window. */
30406 if (w->current_matrix == NULL)
30407 return false;
30409 /* When we're currently updating the window, display and current
30410 matrix usually don't agree. Arrange for a thorough display
30411 later. */
30412 if (w->must_be_updated_p)
30414 SET_FRAME_GARBAGED (f);
30415 return false;
30418 /* Frame-relative pixel rectangle of W. */
30419 wr.x = WINDOW_LEFT_EDGE_X (w);
30420 wr.y = WINDOW_TOP_EDGE_Y (w);
30421 wr.width = WINDOW_PIXEL_WIDTH (w);
30422 wr.height = WINDOW_PIXEL_HEIGHT (w);
30424 if (x_intersect_rectangles (fr, &wr, &r))
30426 int yb = window_text_bottom_y (w);
30427 struct glyph_row *row;
30428 struct glyph_row *first_overlapping_row, *last_overlapping_row;
30430 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
30431 r.x, r.y, r.width, r.height));
30433 /* Convert to window coordinates. */
30434 r.x -= WINDOW_LEFT_EDGE_X (w);
30435 r.y -= WINDOW_TOP_EDGE_Y (w);
30437 /* Turn off the cursor. */
30438 bool cursor_cleared_p = (!w->pseudo_window_p
30439 && phys_cursor_in_rect_p (w, &r));
30440 if (cursor_cleared_p)
30441 x_clear_cursor (w);
30443 /* If the row containing the cursor extends face to end of line,
30444 then expose_area might overwrite the cursor outside the
30445 rectangle and thus notice_overwritten_cursor might clear
30446 w->phys_cursor_on_p. We remember the original value and
30447 check later if it is changed. */
30448 bool phys_cursor_on_p = w->phys_cursor_on_p;
30450 /* Use a signed int intermediate value to avoid catastrophic
30451 failures due to comparison between signed and unsigned, when
30452 y0 or y1 is negative (can happen for tall images). */
30453 int r_bottom = r.y + r.height;
30455 /* Update lines intersecting rectangle R. */
30456 first_overlapping_row = last_overlapping_row = NULL;
30457 for (row = w->current_matrix->rows;
30458 row->enabled_p;
30459 ++row)
30461 int y0 = row->y;
30462 int y1 = MATRIX_ROW_BOTTOM_Y (row);
30464 if ((y0 >= r.y && y0 < r_bottom)
30465 || (y1 > r.y && y1 < r_bottom)
30466 || (r.y >= y0 && r.y < y1)
30467 || (r_bottom > y0 && r_bottom < y1))
30469 /* A header line may be overlapping, but there is no need
30470 to fix overlapping areas for them. KFS 2005-02-12 */
30471 if (row->overlapping_p && !row->mode_line_p)
30473 if (first_overlapping_row == NULL)
30474 first_overlapping_row = row;
30475 last_overlapping_row = row;
30478 row->clip = fr;
30479 if (expose_line (w, row, &r))
30480 mouse_face_overwritten_p = true;
30481 row->clip = NULL;
30483 else if (row->overlapping_p)
30485 /* We must redraw a row overlapping the exposed area. */
30486 if (y0 < r.y
30487 ? y0 + row->phys_height > r.y
30488 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
30490 if (first_overlapping_row == NULL)
30491 first_overlapping_row = row;
30492 last_overlapping_row = row;
30496 if (y1 >= yb)
30497 break;
30500 /* Display the mode line if there is one. */
30501 if (WINDOW_WANTS_MODELINE_P (w)
30502 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
30503 row->enabled_p)
30504 && row->y < r_bottom)
30506 if (expose_line (w, row, &r))
30507 mouse_face_overwritten_p = true;
30510 if (!w->pseudo_window_p)
30512 /* Fix the display of overlapping rows. */
30513 if (first_overlapping_row)
30514 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
30515 fr);
30517 /* Draw border between windows. */
30518 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30519 x_draw_right_divider (w);
30520 else
30521 x_draw_vertical_border (w);
30523 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30524 x_draw_bottom_divider (w);
30526 /* Turn the cursor on again. */
30527 if (cursor_cleared_p
30528 || (phys_cursor_on_p && !w->phys_cursor_on_p))
30529 update_window_cursor (w, true);
30533 return mouse_face_overwritten_p;
30538 /* Redraw (parts) of all windows in the window tree rooted at W that
30539 intersect R. R contains frame pixel coordinates. Value is
30540 true if the exposure overwrites mouse-face. */
30542 static bool
30543 expose_window_tree (struct window *w, XRectangle *r)
30545 struct frame *f = XFRAME (w->frame);
30546 bool mouse_face_overwritten_p = false;
30548 while (w && !FRAME_GARBAGED_P (f))
30550 mouse_face_overwritten_p
30551 |= (WINDOWP (w->contents)
30552 ? expose_window_tree (XWINDOW (w->contents), r)
30553 : expose_window (w, r));
30555 w = NILP (w->next) ? NULL : XWINDOW (w->next);
30558 return mouse_face_overwritten_p;
30562 /* EXPORT:
30563 Redisplay an exposed area of frame F. X and Y are the upper-left
30564 corner of the exposed rectangle. W and H are width and height of
30565 the exposed area. All are pixel values. W or H zero means redraw
30566 the entire frame. */
30568 void
30569 expose_frame (struct frame *f, int x, int y, int w, int h)
30571 XRectangle r;
30572 bool mouse_face_overwritten_p = false;
30574 TRACE ((stderr, "expose_frame "));
30576 /* No need to redraw if frame will be redrawn soon. */
30577 if (FRAME_GARBAGED_P (f))
30579 TRACE ((stderr, " garbaged\n"));
30580 return;
30583 /* If basic faces haven't been realized yet, there is no point in
30584 trying to redraw anything. This can happen when we get an expose
30585 event while Emacs is starting, e.g. by moving another window. */
30586 if (FRAME_FACE_CACHE (f) == NULL
30587 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
30589 TRACE ((stderr, " no faces\n"));
30590 return;
30593 if (w == 0 || h == 0)
30595 r.x = r.y = 0;
30596 r.width = FRAME_TEXT_WIDTH (f);
30597 r.height = FRAME_TEXT_HEIGHT (f);
30599 else
30601 r.x = x;
30602 r.y = y;
30603 r.width = w;
30604 r.height = h;
30607 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
30608 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
30610 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30611 if (WINDOWP (f->tool_bar_window))
30612 mouse_face_overwritten_p
30613 |= expose_window (XWINDOW (f->tool_bar_window), &r);
30614 #endif
30616 #ifdef HAVE_X_WINDOWS
30617 #ifndef MSDOS
30618 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30619 if (WINDOWP (f->menu_bar_window))
30620 mouse_face_overwritten_p
30621 |= expose_window (XWINDOW (f->menu_bar_window), &r);
30622 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30623 #endif
30624 #endif
30626 /* Some window managers support a focus-follows-mouse style with
30627 delayed raising of frames. Imagine a partially obscured frame,
30628 and moving the mouse into partially obscured mouse-face on that
30629 frame. The visible part of the mouse-face will be highlighted,
30630 then the WM raises the obscured frame. With at least one WM, KDE
30631 2.1, Emacs is not getting any event for the raising of the frame
30632 (even tried with SubstructureRedirectMask), only Expose events.
30633 These expose events will draw text normally, i.e. not
30634 highlighted. Which means we must redo the highlight here.
30635 Subsume it under ``we love X''. --gerd 2001-08-15 */
30636 /* Included in Windows version because Windows most likely does not
30637 do the right thing if any third party tool offers
30638 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30639 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
30641 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30642 if (f == hlinfo->mouse_face_mouse_frame)
30644 int mouse_x = hlinfo->mouse_face_mouse_x;
30645 int mouse_y = hlinfo->mouse_face_mouse_y;
30646 clear_mouse_face (hlinfo);
30647 note_mouse_highlight (f, mouse_x, mouse_y);
30653 /* EXPORT:
30654 Determine the intersection of two rectangles R1 and R2. Return
30655 the intersection in *RESULT. Value is true if RESULT is not
30656 empty. */
30658 bool
30659 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
30661 XRectangle *left, *right;
30662 XRectangle *upper, *lower;
30663 bool intersection_p = false;
30665 /* Rearrange so that R1 is the left-most rectangle. */
30666 if (r1->x < r2->x)
30667 left = r1, right = r2;
30668 else
30669 left = r2, right = r1;
30671 /* X0 of the intersection is right.x0, if this is inside R1,
30672 otherwise there is no intersection. */
30673 if (right->x <= left->x + left->width)
30675 result->x = right->x;
30677 /* The right end of the intersection is the minimum of
30678 the right ends of left and right. */
30679 result->width = (min (left->x + left->width, right->x + right->width)
30680 - result->x);
30682 /* Same game for Y. */
30683 if (r1->y < r2->y)
30684 upper = r1, lower = r2;
30685 else
30686 upper = r2, lower = r1;
30688 /* The upper end of the intersection is lower.y0, if this is inside
30689 of upper. Otherwise, there is no intersection. */
30690 if (lower->y <= upper->y + upper->height)
30692 result->y = lower->y;
30694 /* The lower end of the intersection is the minimum of the lower
30695 ends of upper and lower. */
30696 result->height = (min (lower->y + lower->height,
30697 upper->y + upper->height)
30698 - result->y);
30699 intersection_p = true;
30703 return intersection_p;
30706 #endif /* HAVE_WINDOW_SYSTEM */
30709 /***********************************************************************
30710 Initialization
30711 ***********************************************************************/
30713 void
30714 syms_of_xdisp (void)
30716 Vwith_echo_area_save_vector = Qnil;
30717 staticpro (&Vwith_echo_area_save_vector);
30719 Vmessage_stack = Qnil;
30720 staticpro (&Vmessage_stack);
30722 /* Non-nil means don't actually do any redisplay. */
30723 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
30725 DEFSYM (Qredisplay_internal, "redisplay_internal (C function)");
30727 DEFVAR_BOOL("inhibit-message", inhibit_message,
30728 doc: /* Non-nil means calls to `message' are not displayed.
30729 They are still logged to the *Messages* buffer. */);
30730 inhibit_message = 0;
30732 message_dolog_marker1 = Fmake_marker ();
30733 staticpro (&message_dolog_marker1);
30734 message_dolog_marker2 = Fmake_marker ();
30735 staticpro (&message_dolog_marker2);
30736 message_dolog_marker3 = Fmake_marker ();
30737 staticpro (&message_dolog_marker3);
30739 #ifdef GLYPH_DEBUG
30740 defsubr (&Sdump_frame_glyph_matrix);
30741 defsubr (&Sdump_glyph_matrix);
30742 defsubr (&Sdump_glyph_row);
30743 defsubr (&Sdump_tool_bar_row);
30744 defsubr (&Strace_redisplay);
30745 defsubr (&Strace_to_stderr);
30746 #endif
30747 #ifdef HAVE_WINDOW_SYSTEM
30748 defsubr (&Stool_bar_height);
30749 defsubr (&Slookup_image_map);
30750 #endif
30751 defsubr (&Sline_pixel_height);
30752 defsubr (&Sformat_mode_line);
30753 defsubr (&Sinvisible_p);
30754 defsubr (&Scurrent_bidi_paragraph_direction);
30755 defsubr (&Swindow_text_pixel_size);
30756 defsubr (&Smove_point_visually);
30757 defsubr (&Sbidi_find_overridden_directionality);
30759 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
30760 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
30761 DEFSYM (Qoverriding_local_map, "overriding-local-map");
30762 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
30763 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
30764 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
30765 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
30766 DEFSYM (Qeval, "eval");
30767 DEFSYM (QCdata, ":data");
30769 /* Names of text properties relevant for redisplay. */
30770 DEFSYM (Qdisplay, "display");
30771 DEFSYM (Qspace_width, "space-width");
30772 DEFSYM (Qraise, "raise");
30773 DEFSYM (Qslice, "slice");
30774 DEFSYM (Qspace, "space");
30775 DEFSYM (Qmargin, "margin");
30776 DEFSYM (Qpointer, "pointer");
30777 DEFSYM (Qleft_margin, "left-margin");
30778 DEFSYM (Qright_margin, "right-margin");
30779 DEFSYM (Qcenter, "center");
30780 DEFSYM (Qline_height, "line-height");
30781 DEFSYM (QCalign_to, ":align-to");
30782 DEFSYM (QCrelative_width, ":relative-width");
30783 DEFSYM (QCrelative_height, ":relative-height");
30784 DEFSYM (QCeval, ":eval");
30785 DEFSYM (QCpropertize, ":propertize");
30786 DEFSYM (QCfile, ":file");
30787 DEFSYM (Qfontified, "fontified");
30788 DEFSYM (Qfontification_functions, "fontification-functions");
30790 /* Name of the face used to highlight trailing whitespace. */
30791 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
30793 /* Name and number of the face used to highlight escape glyphs. */
30794 DEFSYM (Qescape_glyph, "escape-glyph");
30796 /* Name and number of the face used to highlight non-breaking spaces. */
30797 DEFSYM (Qnobreak_space, "nobreak-space");
30799 /* The symbol 'image' which is the car of the lists used to represent
30800 images in Lisp. Also a tool bar style. */
30801 DEFSYM (Qimage, "image");
30803 /* Tool bar styles. */
30804 DEFSYM (Qtext, "text");
30805 DEFSYM (Qboth, "both");
30806 DEFSYM (Qboth_horiz, "both-horiz");
30807 DEFSYM (Qtext_image_horiz, "text-image-horiz");
30809 /* The image map types. */
30810 DEFSYM (QCmap, ":map");
30811 DEFSYM (QCpointer, ":pointer");
30812 DEFSYM (Qrect, "rect");
30813 DEFSYM (Qcircle, "circle");
30814 DEFSYM (Qpoly, "poly");
30816 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
30818 DEFSYM (Qgrow_only, "grow-only");
30819 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
30820 DEFSYM (Qposition, "position");
30821 DEFSYM (Qbuffer_position, "buffer-position");
30822 DEFSYM (Qobject, "object");
30824 /* Cursor shapes. */
30825 DEFSYM (Qbar, "bar");
30826 DEFSYM (Qhbar, "hbar");
30827 DEFSYM (Qbox, "box");
30828 DEFSYM (Qhollow, "hollow");
30830 /* Pointer shapes. */
30831 DEFSYM (Qhand, "hand");
30832 DEFSYM (Qarrow, "arrow");
30833 /* also Qtext */
30835 DEFSYM (Qdragging, "dragging");
30837 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
30839 list_of_error = list1 (list2 (Qerror, Qvoid_variable));
30840 staticpro (&list_of_error);
30842 /* Values of those variables at last redisplay are stored as
30843 properties on 'overlay-arrow-position' symbol. However, if
30844 Voverlay_arrow_position is a marker, last-arrow-position is its
30845 numerical position. */
30846 DEFSYM (Qlast_arrow_position, "last-arrow-position");
30847 DEFSYM (Qlast_arrow_string, "last-arrow-string");
30849 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30850 properties on a symbol in overlay-arrow-variable-list. */
30851 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
30852 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
30854 echo_buffer[0] = echo_buffer[1] = Qnil;
30855 staticpro (&echo_buffer[0]);
30856 staticpro (&echo_buffer[1]);
30858 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
30859 staticpro (&echo_area_buffer[0]);
30860 staticpro (&echo_area_buffer[1]);
30862 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
30863 staticpro (&Vmessages_buffer_name);
30865 mode_line_proptrans_alist = Qnil;
30866 staticpro (&mode_line_proptrans_alist);
30867 mode_line_string_list = Qnil;
30868 staticpro (&mode_line_string_list);
30869 mode_line_string_face = Qnil;
30870 staticpro (&mode_line_string_face);
30871 mode_line_string_face_prop = Qnil;
30872 staticpro (&mode_line_string_face_prop);
30873 Vmode_line_unwind_vector = Qnil;
30874 staticpro (&Vmode_line_unwind_vector);
30876 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
30878 help_echo_string = Qnil;
30879 staticpro (&help_echo_string);
30880 help_echo_object = Qnil;
30881 staticpro (&help_echo_object);
30882 help_echo_window = Qnil;
30883 staticpro (&help_echo_window);
30884 previous_help_echo_string = Qnil;
30885 staticpro (&previous_help_echo_string);
30886 help_echo_pos = -1;
30888 DEFSYM (Qright_to_left, "right-to-left");
30889 DEFSYM (Qleft_to_right, "left-to-right");
30890 defsubr (&Sbidi_resolved_levels);
30892 #ifdef HAVE_WINDOW_SYSTEM
30893 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
30894 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
30895 For example, if a block cursor is over a tab, it will be drawn as
30896 wide as that tab on the display. */);
30897 x_stretch_cursor_p = 0;
30898 #endif
30900 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
30901 doc: /* Non-nil means highlight trailing whitespace.
30902 The face used for trailing whitespace is `trailing-whitespace'. */);
30903 Vshow_trailing_whitespace = Qnil;
30905 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
30906 doc: /* Control highlighting of non-ASCII space and hyphen chars.
30907 If the value is t, Emacs highlights non-ASCII chars which have the
30908 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30909 or `escape-glyph' face respectively.
30911 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30912 U+2011 (non-breaking hyphen) are affected.
30914 Any other non-nil value means to display these characters as a escape
30915 glyph followed by an ordinary space or hyphen.
30917 A value of nil means no special handling of these characters. */);
30918 Vnobreak_char_display = Qt;
30920 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
30921 doc: /* The pointer shape to show in void text areas.
30922 A value of nil means to show the text pointer. Other options are
30923 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30924 `hourglass'. */);
30925 Vvoid_text_area_pointer = Qarrow;
30927 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
30928 doc: /* Non-nil means don't actually do any redisplay.
30929 This is used for internal purposes. */);
30930 Vinhibit_redisplay = Qnil;
30932 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
30933 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30934 Vglobal_mode_string = Qnil;
30936 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
30937 doc: /* Marker for where to display an arrow on top of the buffer text.
30938 This must be the beginning of a line in order to work.
30939 See also `overlay-arrow-string'. */);
30940 Voverlay_arrow_position = Qnil;
30942 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
30943 doc: /* String to display as an arrow in non-window frames.
30944 See also `overlay-arrow-position'. */);
30945 Voverlay_arrow_string = build_pure_c_string ("=>");
30947 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
30948 doc: /* List of variables (symbols) which hold markers for overlay arrows.
30949 The symbols on this list are examined during redisplay to determine
30950 where to display overlay arrows. */);
30951 Voverlay_arrow_variable_list
30952 = list1 (intern_c_string ("overlay-arrow-position"));
30954 DEFVAR_INT ("scroll-step", emacs_scroll_step,
30955 doc: /* The number of lines to try scrolling a window by when point moves out.
30956 If that fails to bring point back on frame, point is centered instead.
30957 If this is zero, point is always centered after it moves off frame.
30958 If you want scrolling to always be a line at a time, you should set
30959 `scroll-conservatively' to a large value rather than set this to 1. */);
30961 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
30962 doc: /* Scroll up to this many lines, to bring point back on screen.
30963 If point moves off-screen, redisplay will scroll by up to
30964 `scroll-conservatively' lines in order to bring point just barely
30965 onto the screen again. If that cannot be done, then redisplay
30966 recenters point as usual.
30968 If the value is greater than 100, redisplay will never recenter point,
30969 but will always scroll just enough text to bring point into view, even
30970 if you move far away.
30972 A value of zero means always recenter point if it moves off screen. */);
30973 scroll_conservatively = 0;
30975 DEFVAR_INT ("scroll-margin", scroll_margin,
30976 doc: /* Number of lines of margin at the top and bottom of a window.
30977 Recenter the window whenever point gets within this many lines
30978 of the top or bottom of the window. */);
30979 scroll_margin = 0;
30981 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
30982 doc: /* Pixels per inch value for non-window system displays.
30983 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30984 Vdisplay_pixels_per_inch = make_float (72.0);
30986 #ifdef GLYPH_DEBUG
30987 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
30988 #endif
30990 DEFVAR_LISP ("truncate-partial-width-windows",
30991 Vtruncate_partial_width_windows,
30992 doc: /* Non-nil means truncate lines in windows narrower than the frame.
30993 For an integer value, truncate lines in each window narrower than the
30994 full frame width, provided the window width is less than that integer;
30995 otherwise, respect the value of `truncate-lines'.
30997 For any other non-nil value, truncate lines in all windows that do
30998 not span the full frame width.
31000 A value of nil means to respect the value of `truncate-lines'.
31002 If `word-wrap' is enabled, you might want to reduce this. */);
31003 Vtruncate_partial_width_windows = make_number (50);
31005 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
31006 doc: /* Maximum buffer size for which line number should be displayed.
31007 If the buffer is bigger than this, the line number does not appear
31008 in the mode line. A value of nil means no limit. */);
31009 Vline_number_display_limit = Qnil;
31011 DEFVAR_INT ("line-number-display-limit-width",
31012 line_number_display_limit_width,
31013 doc: /* Maximum line width (in characters) for line number display.
31014 If the average length of the lines near point is bigger than this, then the
31015 line number may be omitted from the mode line. */);
31016 line_number_display_limit_width = 200;
31018 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
31019 doc: /* Non-nil means highlight region even in nonselected windows. */);
31020 highlight_nonselected_windows = false;
31022 DEFVAR_BOOL ("multiple-frames", multiple_frames,
31023 doc: /* Non-nil if more than one frame is visible on this display.
31024 Minibuffer-only frames don't count, but iconified frames do.
31025 This variable is not guaranteed to be accurate except while processing
31026 `frame-title-format' and `icon-title-format'. */);
31028 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
31029 doc: /* Template for displaying the title bar of visible frames.
31030 \(Assuming the window manager supports this feature.)
31032 This variable has the same structure as `mode-line-format', except that
31033 the %c and %l constructs are ignored. It is used only on frames for
31034 which no explicit name has been set \(see `modify-frame-parameters'). */);
31036 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
31037 doc: /* Template for displaying the title bar of an iconified frame.
31038 \(Assuming the window manager supports this feature.)
31039 This variable has the same structure as `mode-line-format' (which see),
31040 and is used only on frames for which no explicit name has been set
31041 \(see `modify-frame-parameters'). */);
31042 Vicon_title_format
31043 = Vframe_title_format
31044 = listn (CONSTYPE_PURE, 3,
31045 intern_c_string ("multiple-frames"),
31046 build_pure_c_string ("%b"),
31047 listn (CONSTYPE_PURE, 4,
31048 empty_unibyte_string,
31049 intern_c_string ("invocation-name"),
31050 build_pure_c_string ("@"),
31051 intern_c_string ("system-name")));
31053 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
31054 doc: /* Maximum number of lines to keep in the message log buffer.
31055 If nil, disable message logging. If t, log messages but don't truncate
31056 the buffer when it becomes large. */);
31057 Vmessage_log_max = make_number (1000);
31059 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
31060 doc: /* Functions called before redisplay, if window sizes have changed.
31061 The value should be a list of functions that take one argument.
31062 Just before redisplay, for each frame, if any of its windows have changed
31063 size since the last redisplay, or have been split or deleted,
31064 all the functions in the list are called, with the frame as argument. */);
31065 Vwindow_size_change_functions = Qnil;
31067 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
31068 doc: /* List of functions to call before redisplaying a window with scrolling.
31069 Each function is called with two arguments, the window and its new
31070 display-start position.
31071 These functions are called whenever the `window-start' marker is modified,
31072 either to point into another buffer (e.g. via `set-window-buffer') or another
31073 place in the same buffer.
31074 Note that the value of `window-end' is not valid when these functions are
31075 called.
31077 Warning: Do not use this feature to alter the way the window
31078 is scrolled. It is not designed for that, and such use probably won't
31079 work. */);
31080 Vwindow_scroll_functions = Qnil;
31082 DEFVAR_LISP ("window-text-change-functions",
31083 Vwindow_text_change_functions,
31084 doc: /* Functions to call in redisplay when text in the window might change. */);
31085 Vwindow_text_change_functions = Qnil;
31087 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
31088 doc: /* Functions called when redisplay of a window reaches the end trigger.
31089 Each function is called with two arguments, the window and the end trigger value.
31090 See `set-window-redisplay-end-trigger'. */);
31091 Vredisplay_end_trigger_functions = Qnil;
31093 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
31094 doc: /* Non-nil means autoselect window with mouse pointer.
31095 If nil, do not autoselect windows.
31096 A positive number means delay autoselection by that many seconds: a
31097 window is autoselected only after the mouse has remained in that
31098 window for the duration of the delay.
31099 A negative number has a similar effect, but causes windows to be
31100 autoselected only after the mouse has stopped moving. \(Because of
31101 the way Emacs compares mouse events, you will occasionally wait twice
31102 that time before the window gets selected.\)
31103 Any other value means to autoselect window instantaneously when the
31104 mouse pointer enters it.
31106 Autoselection selects the minibuffer only if it is active, and never
31107 unselects the minibuffer if it is active.
31109 When customizing this variable make sure that the actual value of
31110 `focus-follows-mouse' matches the behavior of your window manager. */);
31111 Vmouse_autoselect_window = Qnil;
31113 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
31114 doc: /* Non-nil means automatically resize tool-bars.
31115 This dynamically changes the tool-bar's height to the minimum height
31116 that is needed to make all tool-bar items visible.
31117 If value is `grow-only', the tool-bar's height is only increased
31118 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31119 Vauto_resize_tool_bars = Qt;
31121 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
31122 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31123 auto_raise_tool_bar_buttons_p = true;
31125 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
31126 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31127 make_cursor_line_fully_visible_p = true;
31129 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
31130 doc: /* Border below tool-bar in pixels.
31131 If an integer, use it as the height of the border.
31132 If it is one of `internal-border-width' or `border-width', use the
31133 value of the corresponding frame parameter.
31134 Otherwise, no border is added below the tool-bar. */);
31135 Vtool_bar_border = Qinternal_border_width;
31137 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
31138 doc: /* Margin around tool-bar buttons in pixels.
31139 If an integer, use that for both horizontal and vertical margins.
31140 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31141 HORZ specifying the horizontal margin, and VERT specifying the
31142 vertical margin. */);
31143 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
31145 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
31146 doc: /* Relief thickness of tool-bar buttons. */);
31147 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
31149 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
31150 doc: /* Tool bar style to use.
31151 It can be one of
31152 image - show images only
31153 text - show text only
31154 both - show both, text below image
31155 both-horiz - show text to the right of the image
31156 text-image-horiz - show text to the left of the image
31157 any other - use system default or image if no system default.
31159 This variable only affects the GTK+ toolkit version of Emacs. */);
31160 Vtool_bar_style = Qnil;
31162 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
31163 doc: /* Maximum number of characters a label can have to be shown.
31164 The tool bar style must also show labels for this to have any effect, see
31165 `tool-bar-style'. */);
31166 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
31168 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
31169 doc: /* List of functions to call to fontify regions of text.
31170 Each function is called with one argument POS. Functions must
31171 fontify a region starting at POS in the current buffer, and give
31172 fontified regions the property `fontified'. */);
31173 Vfontification_functions = Qnil;
31174 Fmake_variable_buffer_local (Qfontification_functions);
31176 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31177 unibyte_display_via_language_environment,
31178 doc: /* Non-nil means display unibyte text according to language environment.
31179 Specifically, this means that raw bytes in the range 160-255 decimal
31180 are displayed by converting them to the equivalent multibyte characters
31181 according to the current language environment. As a result, they are
31182 displayed according to the current fontset.
31184 Note that this variable affects only how these bytes are displayed,
31185 but does not change the fact they are interpreted as raw bytes. */);
31186 unibyte_display_via_language_environment = false;
31188 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
31189 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31190 If a float, it specifies a fraction of the mini-window frame's height.
31191 If an integer, it specifies a number of lines. */);
31192 Vmax_mini_window_height = make_float (0.25);
31194 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
31195 doc: /* How to resize mini-windows (the minibuffer and the echo area).
31196 A value of nil means don't automatically resize mini-windows.
31197 A value of t means resize them to fit the text displayed in them.
31198 A value of `grow-only', the default, means let mini-windows grow only;
31199 they return to their normal size when the minibuffer is closed, or the
31200 echo area becomes empty. */);
31201 Vresize_mini_windows = Qgrow_only;
31203 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
31204 doc: /* Alist specifying how to blink the cursor off.
31205 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31206 `cursor-type' frame-parameter or variable equals ON-STATE,
31207 comparing using `equal', Emacs uses OFF-STATE to specify
31208 how to blink it off. ON-STATE and OFF-STATE are values for
31209 the `cursor-type' frame parameter.
31211 If a frame's ON-STATE has no entry in this list,
31212 the frame's other specifications determine how to blink the cursor off. */);
31213 Vblink_cursor_alist = Qnil;
31215 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
31216 doc: /* Allow or disallow automatic horizontal scrolling of windows.
31217 If non-nil, windows are automatically scrolled horizontally to make
31218 point visible. */);
31219 automatic_hscrolling_p = true;
31220 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
31222 DEFVAR_INT ("hscroll-margin", hscroll_margin,
31223 doc: /* How many columns away from the window edge point is allowed to get
31224 before automatic hscrolling will horizontally scroll the window. */);
31225 hscroll_margin = 5;
31227 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
31228 doc: /* How many columns to scroll the window when point gets too close to the edge.
31229 When point is less than `hscroll-margin' columns from the window
31230 edge, automatic hscrolling will scroll the window by the amount of columns
31231 determined by this variable. If its value is a positive integer, scroll that
31232 many columns. If it's a positive floating-point number, it specifies the
31233 fraction of the window's width to scroll. If it's nil or zero, point will be
31234 centered horizontally after the scroll. Any other value, including negative
31235 numbers, are treated as if the value were zero.
31237 Automatic hscrolling always moves point outside the scroll margin, so if
31238 point was more than scroll step columns inside the margin, the window will
31239 scroll more than the value given by the scroll step.
31241 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31242 and `scroll-right' overrides this variable's effect. */);
31243 Vhscroll_step = make_number (0);
31245 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
31246 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
31247 Bind this around calls to `message' to let it take effect. */);
31248 message_truncate_lines = false;
31250 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
31251 doc: /* Normal hook run to update the menu bar definitions.
31252 Redisplay runs this hook before it redisplays the menu bar.
31253 This is used to update menus such as Buffers, whose contents depend on
31254 various data. */);
31255 Vmenu_bar_update_hook = Qnil;
31257 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
31258 doc: /* Frame for which we are updating a menu.
31259 The enable predicate for a menu binding should check this variable. */);
31260 Vmenu_updating_frame = Qnil;
31262 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
31263 doc: /* Non-nil means don't update menu bars. Internal use only. */);
31264 inhibit_menubar_update = false;
31266 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
31267 doc: /* Prefix prepended to all continuation lines at display time.
31268 The value may be a string, an image, or a stretch-glyph; it is
31269 interpreted in the same way as the value of a `display' text property.
31271 This variable is overridden by any `wrap-prefix' text or overlay
31272 property.
31274 To add a prefix to non-continuation lines, use `line-prefix'. */);
31275 Vwrap_prefix = Qnil;
31276 DEFSYM (Qwrap_prefix, "wrap-prefix");
31277 Fmake_variable_buffer_local (Qwrap_prefix);
31279 DEFVAR_LISP ("line-prefix", Vline_prefix,
31280 doc: /* Prefix prepended to all non-continuation lines at display time.
31281 The value may be a string, an image, or a stretch-glyph; it is
31282 interpreted in the same way as the value of a `display' text property.
31284 This variable is overridden by any `line-prefix' text or overlay
31285 property.
31287 To add a prefix to continuation lines, use `wrap-prefix'. */);
31288 Vline_prefix = Qnil;
31289 DEFSYM (Qline_prefix, "line-prefix");
31290 Fmake_variable_buffer_local (Qline_prefix);
31292 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
31293 doc: /* Non-nil means don't eval Lisp during redisplay. */);
31294 inhibit_eval_during_redisplay = false;
31296 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
31297 doc: /* Non-nil means don't free realized faces. Internal use only. */);
31298 inhibit_free_realized_faces = false;
31300 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring,
31301 doc: /* Non-nil means don't mirror characters even when bidi context requires that.
31302 Intended for use during debugging and for testing bidi display;
31303 see biditest.el in the test suite. */);
31304 inhibit_bidi_mirroring = false;
31306 #ifdef GLYPH_DEBUG
31307 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
31308 doc: /* Inhibit try_window_id display optimization. */);
31309 inhibit_try_window_id = false;
31311 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
31312 doc: /* Inhibit try_window_reusing display optimization. */);
31313 inhibit_try_window_reusing = false;
31315 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
31316 doc: /* Inhibit try_cursor_movement display optimization. */);
31317 inhibit_try_cursor_movement = false;
31318 #endif /* GLYPH_DEBUG */
31320 DEFVAR_INT ("overline-margin", overline_margin,
31321 doc: /* Space between overline and text, in pixels.
31322 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31323 margin to the character height. */);
31324 overline_margin = 2;
31326 DEFVAR_INT ("underline-minimum-offset",
31327 underline_minimum_offset,
31328 doc: /* Minimum distance between baseline and underline.
31329 This can improve legibility of underlined text at small font sizes,
31330 particularly when using variable `x-use-underline-position-properties'
31331 with fonts that specify an UNDERLINE_POSITION relatively close to the
31332 baseline. The default value is 1. */);
31333 underline_minimum_offset = 1;
31335 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
31336 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31337 This feature only works when on a window system that can change
31338 cursor shapes. */);
31339 display_hourglass_p = true;
31341 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
31342 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31343 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
31345 #ifdef HAVE_WINDOW_SYSTEM
31346 hourglass_atimer = NULL;
31347 hourglass_shown_p = false;
31348 #endif /* HAVE_WINDOW_SYSTEM */
31350 /* Name of the face used to display glyphless characters. */
31351 DEFSYM (Qglyphless_char, "glyphless-char");
31353 /* Method symbols for Vglyphless_char_display. */
31354 DEFSYM (Qhex_code, "hex-code");
31355 DEFSYM (Qempty_box, "empty-box");
31356 DEFSYM (Qthin_space, "thin-space");
31357 DEFSYM (Qzero_width, "zero-width");
31359 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
31360 doc: /* Function run just before redisplay.
31361 It is called with one argument, which is the set of windows that are to
31362 be redisplayed. This set can be nil (meaning, only the selected window),
31363 or t (meaning all windows). */);
31364 Vpre_redisplay_function = intern ("ignore");
31366 /* Symbol for the purpose of Vglyphless_char_display. */
31367 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
31368 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
31370 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
31371 doc: /* Char-table defining glyphless characters.
31372 Each element, if non-nil, should be one of the following:
31373 an ASCII acronym string: display this string in a box
31374 `hex-code': display the hexadecimal code of a character in a box
31375 `empty-box': display as an empty box
31376 `thin-space': display as 1-pixel width space
31377 `zero-width': don't display
31378 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31379 display method for graphical terminals and text terminals respectively.
31380 GRAPHICAL and TEXT should each have one of the values listed above.
31382 The char-table has one extra slot to control the display of a character for
31383 which no font is found. This slot only takes effect on graphical terminals.
31384 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31385 `thin-space'. The default is `empty-box'.
31387 If a character has a non-nil entry in an active display table, the
31388 display table takes effect; in this case, Emacs does not consult
31389 `glyphless-char-display' at all. */);
31390 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
31391 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
31392 Qempty_box);
31394 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
31395 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
31396 Vdebug_on_message = Qnil;
31398 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
31399 doc: /* */);
31400 Vredisplay__all_windows_cause
31401 = Fmake_vector (make_number (100), make_number (0));
31403 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
31404 doc: /* */);
31405 Vredisplay__mode_lines_cause
31406 = Fmake_vector (make_number (100), make_number (0));
31410 /* Initialize this module when Emacs starts. */
31412 void
31413 init_xdisp (void)
31415 CHARPOS (this_line_start_pos) = 0;
31417 if (!noninteractive)
31419 struct window *m = XWINDOW (minibuf_window);
31420 Lisp_Object frame = m->frame;
31421 struct frame *f = XFRAME (frame);
31422 Lisp_Object root = FRAME_ROOT_WINDOW (f);
31423 struct window *r = XWINDOW (root);
31424 int i;
31426 echo_area_window = minibuf_window;
31428 r->top_line = FRAME_TOP_MARGIN (f);
31429 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
31430 r->total_cols = FRAME_COLS (f);
31431 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
31432 r->total_lines = FRAME_TOTAL_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
31433 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
31435 m->top_line = FRAME_TOTAL_LINES (f) - 1;
31436 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
31437 m->total_cols = FRAME_COLS (f);
31438 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
31439 m->total_lines = 1;
31440 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
31442 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
31443 scratch_glyph_row.glyphs[TEXT_AREA + 1]
31444 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
31446 /* The default ellipsis glyphs `...'. */
31447 for (i = 0; i < 3; ++i)
31448 default_invis_vector[i] = make_number ('.');
31452 /* Allocate the buffer for frame titles.
31453 Also used for `format-mode-line'. */
31454 int size = 100;
31455 mode_line_noprop_buf = xmalloc (size);
31456 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
31457 mode_line_noprop_ptr = mode_line_noprop_buf;
31458 mode_line_target = MODE_LINE_DISPLAY;
31461 help_echo_showing_p = false;
31464 #ifdef HAVE_WINDOW_SYSTEM
31466 /* Platform-independent portion of hourglass implementation. */
31468 /* Timer function of hourglass_atimer. */
31470 static void
31471 show_hourglass (struct atimer *timer)
31473 /* The timer implementation will cancel this timer automatically
31474 after this function has run. Set hourglass_atimer to null
31475 so that we know the timer doesn't have to be canceled. */
31476 hourglass_atimer = NULL;
31478 if (!hourglass_shown_p)
31480 Lisp_Object tail, frame;
31482 block_input ();
31484 FOR_EACH_FRAME (tail, frame)
31486 struct frame *f = XFRAME (frame);
31488 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31489 && FRAME_RIF (f)->show_hourglass)
31490 FRAME_RIF (f)->show_hourglass (f);
31493 hourglass_shown_p = true;
31494 unblock_input ();
31498 /* Cancel a currently active hourglass timer, and start a new one. */
31500 void
31501 start_hourglass (void)
31503 struct timespec delay;
31505 cancel_hourglass ();
31507 if (INTEGERP (Vhourglass_delay)
31508 && XINT (Vhourglass_delay) > 0)
31509 delay = make_timespec (min (XINT (Vhourglass_delay),
31510 TYPE_MAXIMUM (time_t)),
31512 else if (FLOATP (Vhourglass_delay)
31513 && XFLOAT_DATA (Vhourglass_delay) > 0)
31514 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
31515 else
31516 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
31518 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
31519 show_hourglass, NULL);
31522 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31523 shown. */
31525 void
31526 cancel_hourglass (void)
31528 if (hourglass_atimer)
31530 cancel_atimer (hourglass_atimer);
31531 hourglass_atimer = NULL;
31534 if (hourglass_shown_p)
31536 Lisp_Object tail, frame;
31538 block_input ();
31540 FOR_EACH_FRAME (tail, frame)
31542 struct frame *f = XFRAME (frame);
31544 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31545 && FRAME_RIF (f)->hide_hourglass)
31546 FRAME_RIF (f)->hide_hourglass (f);
31547 #ifdef HAVE_NTGUI
31548 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31549 else if (!FRAME_W32_P (f))
31550 w32_arrow_cursor ();
31551 #endif
31554 hourglass_shown_p = false;
31555 unblock_input ();
31559 #endif /* HAVE_WINDOW_SYSTEM */