1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2016 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "composite.h"
296 #include "keyboard.h"
300 #include "termchar.h"
301 #include "dispextern.h"
302 #include "character.h"
306 #include "commands.h"
309 #include "termhooks.h"
310 #include "termopts.h"
311 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
318 #ifdef HAVE_WINDOW_SYSTEM
320 #endif /* HAVE_WINDOW_SYSTEM */
322 #ifndef FRAME_X_OUTPUT
323 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
326 #define INFINITY 10000000
328 /* Holds the list (error). */
329 static Lisp_Object list_of_error
;
331 #ifdef HAVE_WINDOW_SYSTEM
333 /* Test if overflow newline into fringe. Called with iterator IT
334 at or past right window margin, and with IT->current_x set. */
336 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
337 (!NILP (Voverflow_newline_into_fringe) \
338 && FRAME_WINDOW_P ((IT)->f) \
339 && ((IT)->bidi_it.paragraph_dir == R2L \
340 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
341 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
342 && (IT)->current_x == (IT)->last_visible_x)
344 #else /* !HAVE_WINDOW_SYSTEM */
345 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
346 #endif /* HAVE_WINDOW_SYSTEM */
348 /* Test if the display element loaded in IT, or the underlying buffer
349 or string character, is a space or a TAB character. This is used
350 to determine where word wrapping can occur. */
352 #define IT_DISPLAYING_WHITESPACE(it) \
353 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
354 || ((STRINGP (it->string) \
355 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
356 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
358 && (it->s[IT_BYTEPOS (*it)] == ' ' \
359 || it->s[IT_BYTEPOS (*it)] == '\t')) \
360 || (IT_BYTEPOS (*it) < ZV_BYTE \
361 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
362 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
364 /* True means print newline to stdout before next mini-buffer message. */
366 bool noninteractive_need_newline
;
368 /* True means print newline to message log before next message. */
370 static bool message_log_need_newline
;
372 /* Three markers that message_dolog uses.
373 It could allocate them itself, but that causes trouble
374 in handling memory-full errors. */
375 static Lisp_Object message_dolog_marker1
;
376 static Lisp_Object message_dolog_marker2
;
377 static Lisp_Object message_dolog_marker3
;
379 /* The buffer position of the first character appearing entirely or
380 partially on the line of the selected window which contains the
381 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
382 redisplay optimization in redisplay_internal. */
384 static struct text_pos this_line_start_pos
;
386 /* Number of characters past the end of the line above, including the
387 terminating newline. */
389 static struct text_pos this_line_end_pos
;
391 /* The vertical positions and the height of this line. */
393 static int this_line_vpos
;
394 static int this_line_y
;
395 static int this_line_pixel_height
;
397 /* X position at which this display line starts. Usually zero;
398 negative if first character is partially visible. */
400 static int this_line_start_x
;
402 /* The smallest character position seen by move_it_* functions as they
403 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
404 hscrolled lines, see display_line. */
406 static struct text_pos this_line_min_pos
;
408 /* Buffer that this_line_.* variables are referring to. */
410 static struct buffer
*this_line_buffer
;
412 /* True if an overlay arrow has been displayed in this window. */
414 static bool overlay_arrow_seen
;
416 /* Vector containing glyphs for an ellipsis `...'. */
418 static Lisp_Object default_invis_vector
[3];
420 /* This is the window where the echo area message was displayed. It
421 is always a mini-buffer window, but it may not be the same window
422 currently active as a mini-buffer. */
424 Lisp_Object echo_area_window
;
426 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
427 pushes the current message and the value of
428 message_enable_multibyte on the stack, the function restore_message
429 pops the stack and displays MESSAGE again. */
431 static Lisp_Object Vmessage_stack
;
433 /* True means multibyte characters were enabled when the echo area
434 message was specified. */
436 static bool message_enable_multibyte
;
438 /* At each redisplay cycle, we should refresh everything there is to refresh.
439 To do that efficiently, we use many optimizations that try to make sure we
440 don't waste too much time updating things that haven't changed.
441 The coarsest such optimization is that, in the most common cases, we only
442 look at the selected-window.
444 To know whether other windows should be considered for redisplay, we use the
445 variable windows_or_buffers_changed: as long as it is 0, it means that we
446 have not noticed anything that should require updating anything else than
447 the selected-window. If it is set to REDISPLAY_SOME, it means that since
448 last redisplay, some changes have been made which could impact other
449 windows. To know which ones need redisplay, every buffer, window, and frame
450 has a `redisplay' bit, which (if true) means that this object needs to be
451 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
452 looking for those `redisplay' bits (actually, there might be some such bits
453 set, but then only on objects which aren't displayed anyway).
455 OTOH if it's non-zero we wil have to loop through all windows and then check
456 the `redisplay' bit of the corresponding window, frame, and buffer, in order
457 to decide whether that window needs attention or not. Note that we can't
458 just look at the frame's redisplay bit to decide that the whole frame can be
459 skipped, since even if the frame's redisplay bit is unset, some of its
460 windows's redisplay bits may be set.
462 Mostly for historical reasons, windows_or_buffers_changed can also take
463 other non-zero values. In that case, the precise value doesn't matter (it
464 encodes the cause of the setting but is only used for debugging purposes),
465 and what it means is that we shouldn't pay attention to any `redisplay' bits
466 and we should simply try and redisplay every window out there. */
468 int windows_or_buffers_changed
;
470 /* Nonzero if we should redraw the mode lines on the next redisplay.
471 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
472 then only redisplay the mode lines in those buffers/windows/frames where the
473 `redisplay' bit has been set.
474 For any other value, redisplay all mode lines (the number used is then only
475 used to track down the cause for this full-redisplay).
477 Since the frame title uses the same %-constructs as the mode line
478 (except %c and %l), if this variable is non-zero, we also consider
479 redisplaying the title of each frame, see x_consider_frame_title.
481 The `redisplay' bits are the same as those used for
482 windows_or_buffers_changed, and setting windows_or_buffers_changed also
483 causes recomputation of the mode lines of all those windows. IOW this
484 variable only has an effect if windows_or_buffers_changed is zero, in which
485 case we should only need to redisplay the mode-line of those objects with
486 a `redisplay' bit set but not the window's text content (tho we may still
487 need to refresh the text content of the selected-window). */
489 int update_mode_lines
;
491 /* True after display_mode_line if %l was used and it displayed a
494 static bool line_number_displayed
;
496 /* The name of the *Messages* buffer, a string. */
498 static Lisp_Object Vmessages_buffer_name
;
500 /* Current, index 0, and last displayed echo area message. Either
501 buffers from echo_buffers, or nil to indicate no message. */
503 Lisp_Object echo_area_buffer
[2];
505 /* The buffers referenced from echo_area_buffer. */
507 static Lisp_Object echo_buffer
[2];
509 /* A vector saved used in with_area_buffer to reduce consing. */
511 static Lisp_Object Vwith_echo_area_save_vector
;
513 /* True means display_echo_area should display the last echo area
514 message again. Set by redisplay_preserve_echo_area. */
516 static bool display_last_displayed_message_p
;
518 /* True if echo area is being used by print; false if being used by
521 static bool message_buf_print
;
523 /* Set to true in clear_message to make redisplay_internal aware
524 of an emptied echo area. */
526 static bool message_cleared_p
;
528 /* A scratch glyph row with contents used for generating truncation
529 glyphs. Also used in direct_output_for_insert. */
531 #define MAX_SCRATCH_GLYPHS 100
532 static struct glyph_row scratch_glyph_row
;
533 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
535 /* Ascent and height of the last line processed by move_it_to. */
537 static int last_height
;
539 /* True if there's a help-echo in the echo area. */
541 bool help_echo_showing_p
;
543 /* The maximum distance to look ahead for text properties. Values
544 that are too small let us call compute_char_face and similar
545 functions too often which is expensive. Values that are too large
546 let us call compute_char_face and alike too often because we
547 might not be interested in text properties that far away. */
549 #define TEXT_PROP_DISTANCE_LIMIT 100
551 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
552 iterator state and later restore it. This is needed because the
553 bidi iterator on bidi.c keeps a stacked cache of its states, which
554 is really a singleton. When we use scratch iterator objects to
555 move around the buffer, we can cause the bidi cache to be pushed or
556 popped, and therefore we need to restore the cache state when we
557 return to the original iterator. */
558 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
561 bidi_unshelve_cache (CACHE, true); \
563 CACHE = bidi_shelve_cache (); \
566 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
568 if (pITORIG != pITCOPY) \
569 *(pITORIG) = *(pITCOPY); \
570 bidi_unshelve_cache (CACHE, false); \
574 /* Functions to mark elements as needing redisplay. */
575 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
578 redisplay_other_windows (void)
580 if (!windows_or_buffers_changed
)
581 windows_or_buffers_changed
= REDISPLAY_SOME
;
585 wset_redisplay (struct window
*w
)
587 /* Beware: selected_window can be nil during early stages. */
588 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
589 redisplay_other_windows ();
594 fset_redisplay (struct frame
*f
)
596 redisplay_other_windows ();
601 bset_redisplay (struct buffer
*b
)
603 int count
= buffer_window_count (b
);
606 /* ... it's visible in other window than selected, */
607 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
608 redisplay_other_windows ();
609 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
610 so that if we later set windows_or_buffers_changed, this buffer will
612 b
->text
->redisplay
= true;
617 bset_update_mode_line (struct buffer
*b
)
619 if (!update_mode_lines
)
620 update_mode_lines
= REDISPLAY_SOME
;
621 b
->text
->redisplay
= true;
625 maybe_set_redisplay (Lisp_Object symbol
)
627 if (HASH_TABLE_P (Vredisplay__variables
)
628 && hash_lookup (XHASH_TABLE (Vredisplay__variables
), symbol
, NULL
) >= 0)
630 bset_update_mode_line (current_buffer
);
631 current_buffer
->prevent_redisplay_optimizations_p
= true;
637 /* True means print traces of redisplay if compiled with
638 GLYPH_DEBUG defined. */
640 bool trace_redisplay_p
;
642 #endif /* GLYPH_DEBUG */
644 #ifdef DEBUG_TRACE_MOVE
645 /* True means trace with TRACE_MOVE to stderr. */
646 static bool trace_move
;
648 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
650 #define TRACE_MOVE(x) (void) 0
653 /* Buffer being redisplayed -- for redisplay_window_error. */
655 static struct buffer
*displayed_buffer
;
657 /* Value returned from text property handlers (see below). */
662 HANDLED_RECOMPUTE_PROPS
,
663 HANDLED_OVERLAY_STRING_CONSUMED
,
667 /* A description of text properties that redisplay is interested
672 /* The symbol index of the name of the property. */
675 /* A unique index for the property. */
678 /* A handler function called to set up iterator IT from the property
679 at IT's current position. Value is used to steer handle_stop. */
680 enum prop_handled (*handler
) (struct it
*it
);
683 static enum prop_handled
handle_face_prop (struct it
*);
684 static enum prop_handled
handle_invisible_prop (struct it
*);
685 static enum prop_handled
handle_display_prop (struct it
*);
686 static enum prop_handled
handle_composition_prop (struct it
*);
687 static enum prop_handled
handle_overlay_change (struct it
*);
688 static enum prop_handled
handle_fontified_prop (struct it
*);
690 /* Properties handled by iterators. */
692 static struct props it_props
[] =
694 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
695 /* Handle `face' before `display' because some sub-properties of
696 `display' need to know the face. */
697 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
698 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
699 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
700 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
704 /* Value is the position described by X. If X is a marker, value is
705 the marker_position of X. Otherwise, value is X. */
707 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
709 /* Enumeration returned by some move_it_.* functions internally. */
713 /* Not used. Undefined value. */
716 /* Move ended at the requested buffer position or ZV. */
717 MOVE_POS_MATCH_OR_ZV
,
719 /* Move ended at the requested X pixel position. */
722 /* Move within a line ended at the end of a line that must be
726 /* Move within a line ended at the end of a line that would
727 be displayed truncated. */
730 /* Move within a line ended at a line end. */
734 /* This counter is used to clear the face cache every once in a while
735 in redisplay_internal. It is incremented for each redisplay.
736 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
739 #define CLEAR_FACE_CACHE_COUNT 500
740 static int clear_face_cache_count
;
742 /* Similarly for the image cache. */
744 #ifdef HAVE_WINDOW_SYSTEM
745 #define CLEAR_IMAGE_CACHE_COUNT 101
746 static int clear_image_cache_count
;
748 /* Null glyph slice */
749 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
752 /* True while redisplay_internal is in progress. */
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
759 Lisp_Object help_echo_string
;
760 Lisp_Object help_echo_window
;
761 Lisp_Object help_echo_object
;
762 ptrdiff_t help_echo_pos
;
764 /* Temporary variable for XTread_socket. */
766 Lisp_Object previous_help_echo_string
;
768 /* Platform-independent portion of hourglass implementation. */
770 #ifdef HAVE_WINDOW_SYSTEM
772 /* True means an hourglass cursor is currently shown. */
773 static bool hourglass_shown_p
;
775 /* If non-null, an asynchronous timer that, when it expires, displays
776 an hourglass cursor on all frames. */
777 static struct atimer
*hourglass_atimer
;
779 #endif /* HAVE_WINDOW_SYSTEM */
781 /* Default number of seconds to wait before displaying an hourglass
783 #define DEFAULT_HOURGLASS_DELAY 1
785 #ifdef HAVE_WINDOW_SYSTEM
787 /* Default pixel width of `thin-space' display method. */
788 #define THIN_SPACE_WIDTH 1
790 #endif /* HAVE_WINDOW_SYSTEM */
792 /* Function prototypes. */
794 static void setup_for_ellipsis (struct it
*, int);
795 static void set_iterator_to_next (struct it
*, bool);
796 static void mark_window_display_accurate_1 (struct window
*, bool);
797 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
798 static bool cursor_row_p (struct glyph_row
*);
799 static int redisplay_mode_lines (Lisp_Object
, bool);
801 static void handle_line_prefix (struct it
*);
803 static void handle_stop_backwards (struct it
*, ptrdiff_t);
804 static void unwind_with_echo_area_buffer (Lisp_Object
);
805 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
806 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
807 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
808 static void set_message (Lisp_Object
);
809 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
810 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
811 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
812 static void unwind_redisplay (void);
813 static void extend_face_to_end_of_line (struct it
*);
814 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
815 static void push_it (struct it
*, struct text_pos
*);
816 static void iterate_out_of_display_property (struct it
*);
817 static void pop_it (struct it
*);
818 static void redisplay_internal (void);
819 static void echo_area_display (bool);
820 static void redisplay_windows (Lisp_Object
);
821 static void redisplay_window (Lisp_Object
, bool);
822 static Lisp_Object
redisplay_window_error (Lisp_Object
);
823 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
824 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
825 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
826 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
828 static bool cursor_row_fully_visible_p (struct window
*, bool, bool);
829 static bool update_menu_bar (struct frame
*, bool, bool);
830 static bool try_window_reusing_current_matrix (struct window
*);
831 static int try_window_id (struct window
*);
832 static bool display_line (struct it
*);
833 static int display_mode_lines (struct window
*);
834 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
835 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
837 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
839 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
840 static void display_menu_bar (struct window
*);
841 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
843 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
844 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
845 static void compute_line_metrics (struct it
*);
846 static void run_redisplay_end_trigger_hook (struct it
*);
847 static bool get_overlay_strings (struct it
*, ptrdiff_t);
848 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
849 static void next_overlay_string (struct it
*);
850 static void reseat (struct it
*, struct text_pos
, bool);
851 static void reseat_1 (struct it
*, struct text_pos
, bool);
852 static bool next_element_from_display_vector (struct it
*);
853 static bool next_element_from_string (struct it
*);
854 static bool next_element_from_c_string (struct it
*);
855 static bool next_element_from_buffer (struct it
*);
856 static bool next_element_from_composition (struct it
*);
857 static bool next_element_from_image (struct it
*);
858 static bool next_element_from_stretch (struct it
*);
859 static bool next_element_from_xwidget (struct it
*);
860 static void load_overlay_strings (struct it
*, ptrdiff_t);
861 static bool get_next_display_element (struct it
*);
862 static enum move_it_result
863 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
864 enum move_operation_enum
);
865 static void get_visually_first_element (struct it
*);
866 static void compute_stop_pos (struct it
*);
867 static int face_before_or_after_it_pos (struct it
*, bool);
868 static ptrdiff_t next_overlay_change (ptrdiff_t);
869 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
870 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
871 static int handle_single_display_spec (struct it
*, Lisp_Object
,
872 Lisp_Object
, Lisp_Object
,
873 struct text_pos
*, ptrdiff_t, int, bool);
874 static int underlying_face_id (struct it
*);
876 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
877 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
879 #ifdef HAVE_WINDOW_SYSTEM
881 static void update_tool_bar (struct frame
*, bool);
882 static void x_draw_bottom_divider (struct window
*w
);
883 static void notice_overwritten_cursor (struct window
*,
886 static int normal_char_height (struct font
*, int);
887 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
889 static void append_stretch_glyph (struct it
*, Lisp_Object
,
892 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
893 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
894 struct font
*, int, bool);
896 #endif /* HAVE_WINDOW_SYSTEM */
898 static void produce_special_glyphs (struct it
*, enum display_element_type
);
899 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
900 static bool coords_in_mouse_face_p (struct window
*, int, int);
904 /***********************************************************************
905 Window display dimensions
906 ***********************************************************************/
908 /* Return the bottom boundary y-position for text lines in window W.
909 This is the first y position at which a line cannot start.
910 It is relative to the top of the window.
912 This is the height of W minus the height of a mode line, if any. */
915 window_text_bottom_y (struct window
*w
)
917 int height
= WINDOW_PIXEL_HEIGHT (w
);
919 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
921 if (WINDOW_WANTS_MODELINE_P (w
))
922 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
924 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
929 /* Return the pixel width of display area AREA of window W.
930 ANY_AREA means return the total width of W, not including
931 fringes to the left and right of the window. */
934 window_box_width (struct window
*w
, enum glyph_row_area area
)
936 int width
= w
->pixel_width
;
938 if (!w
->pseudo_window_p
)
940 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
941 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
943 if (area
== TEXT_AREA
)
944 width
-= (WINDOW_MARGINS_WIDTH (w
)
945 + WINDOW_FRINGES_WIDTH (w
));
946 else if (area
== LEFT_MARGIN_AREA
)
947 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
948 else if (area
== RIGHT_MARGIN_AREA
)
949 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
952 /* With wide margins, fringes, etc. we might end up with a negative
953 width, correct that here. */
954 return max (0, width
);
958 /* Return the pixel height of the display area of window W, not
959 including mode lines of W, if any. */
962 window_box_height (struct window
*w
)
964 struct frame
*f
= XFRAME (w
->frame
);
965 int height
= WINDOW_PIXEL_HEIGHT (w
);
967 eassert (height
>= 0);
969 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
970 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
972 /* Note: the code below that determines the mode-line/header-line
973 height is essentially the same as that contained in the macro
974 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
975 the appropriate glyph row has its `mode_line_p' flag set,
976 and if it doesn't, uses estimate_mode_line_height instead. */
978 if (WINDOW_WANTS_MODELINE_P (w
))
980 struct glyph_row
*ml_row
981 = (w
->current_matrix
&& w
->current_matrix
->rows
982 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
984 if (ml_row
&& ml_row
->mode_line_p
)
985 height
-= ml_row
->height
;
987 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
990 if (WINDOW_WANTS_HEADER_LINE_P (w
))
992 struct glyph_row
*hl_row
993 = (w
->current_matrix
&& w
->current_matrix
->rows
994 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
996 if (hl_row
&& hl_row
->mode_line_p
)
997 height
-= hl_row
->height
;
999 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1002 /* With a very small font and a mode-line that's taller than
1003 default, we might end up with a negative height. */
1004 return max (0, height
);
1007 /* Return the window-relative coordinate of the left edge of display
1008 area AREA of window W. ANY_AREA means return the left edge of the
1009 whole window, to the right of the left fringe of W. */
1012 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1016 if (w
->pseudo_window_p
)
1019 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1021 if (area
== TEXT_AREA
)
1022 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1023 + window_box_width (w
, LEFT_MARGIN_AREA
));
1024 else if (area
== RIGHT_MARGIN_AREA
)
1025 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1026 + window_box_width (w
, LEFT_MARGIN_AREA
)
1027 + window_box_width (w
, TEXT_AREA
)
1028 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1030 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1031 else if (area
== LEFT_MARGIN_AREA
1032 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1033 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1035 /* Don't return more than the window's pixel width. */
1036 return min (x
, w
->pixel_width
);
1040 /* Return the window-relative coordinate of the right edge of display
1041 area AREA of window W. ANY_AREA means return the right edge of the
1042 whole window, to the left of the right fringe of W. */
1045 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1047 /* Don't return more than the window's pixel width. */
1048 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1052 /* Return the frame-relative coordinate of the left edge of display
1053 area AREA of window W. ANY_AREA means return the left edge of the
1054 whole window, to the right of the left fringe of W. */
1057 window_box_left (struct window
*w
, enum glyph_row_area area
)
1059 struct frame
*f
= XFRAME (w
->frame
);
1062 if (w
->pseudo_window_p
)
1063 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1065 x
= (WINDOW_LEFT_EDGE_X (w
)
1066 + window_box_left_offset (w
, area
));
1072 /* Return the frame-relative coordinate of the right edge of display
1073 area AREA of window W. ANY_AREA means return the right edge of the
1074 whole window, to the left of the right fringe of W. */
1077 window_box_right (struct window
*w
, enum glyph_row_area area
)
1079 return window_box_left (w
, area
) + window_box_width (w
, area
);
1082 /* Get the bounding box of the display area AREA of window W, without
1083 mode lines, in frame-relative coordinates. ANY_AREA means the
1084 whole window, not including the left and right fringes of
1085 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1086 coordinates of the upper-left corner of the box. Return in
1087 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1090 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1091 int *box_y
, int *box_width
, int *box_height
)
1094 *box_width
= window_box_width (w
, area
);
1096 *box_height
= window_box_height (w
);
1098 *box_x
= window_box_left (w
, area
);
1101 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1102 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1103 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1107 #ifdef HAVE_WINDOW_SYSTEM
1109 /* Get the bounding box of the display area AREA of window W, without
1110 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1111 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1112 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1113 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1117 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1118 int *bottom_right_x
, int *bottom_right_y
)
1120 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1121 bottom_right_x
, bottom_right_y
);
1122 *bottom_right_x
+= *top_left_x
;
1123 *bottom_right_y
+= *top_left_y
;
1126 #endif /* HAVE_WINDOW_SYSTEM */
1128 /***********************************************************************
1130 ***********************************************************************/
1132 /* Return the bottom y-position of the line the iterator IT is in.
1133 This can modify IT's settings. */
1136 line_bottom_y (struct it
*it
)
1138 int line_height
= it
->max_ascent
+ it
->max_descent
;
1139 int line_top_y
= it
->current_y
;
1141 if (line_height
== 0)
1144 line_height
= last_height
;
1145 else if (IT_CHARPOS (*it
) < ZV
)
1147 move_it_by_lines (it
, 1);
1148 line_height
= (it
->max_ascent
|| it
->max_descent
1149 ? it
->max_ascent
+ it
->max_descent
1154 struct glyph_row
*row
= it
->glyph_row
;
1156 /* Use the default character height. */
1157 it
->glyph_row
= NULL
;
1158 it
->what
= IT_CHARACTER
;
1161 PRODUCE_GLYPHS (it
);
1162 line_height
= it
->ascent
+ it
->descent
;
1163 it
->glyph_row
= row
;
1167 return line_top_y
+ line_height
;
1170 DEFUN ("line-pixel-height", Fline_pixel_height
,
1171 Sline_pixel_height
, 0, 0, 0,
1172 doc
: /* Return height in pixels of text line in the selected window.
1174 Value is the height in pixels of the line at point. */)
1179 struct window
*w
= XWINDOW (selected_window
);
1180 struct buffer
*old_buffer
= NULL
;
1183 if (XBUFFER (w
->contents
) != current_buffer
)
1185 old_buffer
= current_buffer
;
1186 set_buffer_internal_1 (XBUFFER (w
->contents
));
1188 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1189 start_display (&it
, w
, pt
);
1190 it
.vpos
= it
.current_y
= 0;
1192 result
= make_number (line_bottom_y (&it
));
1194 set_buffer_internal_1 (old_buffer
);
1199 /* Return the default pixel height of text lines in window W. The
1200 value is the canonical height of the W frame's default font, plus
1201 any extra space required by the line-spacing variable or frame
1204 Implementation note: this ignores any line-spacing text properties
1205 put on the newline characters. This is because those properties
1206 only affect the _screen_ line ending in the newline (i.e., in a
1207 continued line, only the last screen line will be affected), which
1208 means only a small number of lines in a buffer can ever use this
1209 feature. Since this function is used to compute the default pixel
1210 equivalent of text lines in a window, we can safely ignore those
1211 few lines. For the same reasons, we ignore the line-height
1214 default_line_pixel_height (struct window
*w
)
1216 struct frame
*f
= WINDOW_XFRAME (w
);
1217 int height
= FRAME_LINE_HEIGHT (f
);
1219 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1221 struct buffer
*b
= XBUFFER (w
->contents
);
1222 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1225 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1228 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1229 height
+= XFASTINT (val
);
1230 else if (FLOATP (val
))
1232 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1239 height
+= f
->extra_line_spacing
;
1245 /* Subroutine of pos_visible_p below. Extracts a display string, if
1246 any, from the display spec given as its argument. */
1248 string_from_display_spec (Lisp_Object spec
)
1252 while (CONSP (spec
))
1254 if (STRINGP (XCAR (spec
)))
1259 else if (VECTORP (spec
))
1263 for (i
= 0; i
< ASIZE (spec
); i
++)
1265 if (STRINGP (AREF (spec
, i
)))
1266 return AREF (spec
, i
);
1275 /* Limit insanely large values of W->hscroll on frame F to the largest
1276 value that will still prevent first_visible_x and last_visible_x of
1277 'struct it' from overflowing an int. */
1279 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1281 ptrdiff_t window_hscroll
= w
->hscroll
;
1282 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1283 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1285 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1286 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1288 return window_hscroll
;
1291 /* Return true if position CHARPOS is visible in window W.
1292 CHARPOS < 0 means return info about WINDOW_END position.
1293 If visible, set *X and *Y to pixel coordinates of top left corner.
1294 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1295 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1298 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1299 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1302 void *itdata
= bidi_shelve_cache ();
1303 struct text_pos top
;
1304 bool visible_p
= false;
1305 struct buffer
*old_buffer
= NULL
;
1308 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1311 if (XBUFFER (w
->contents
) != current_buffer
)
1313 old_buffer
= current_buffer
;
1314 set_buffer_internal_1 (XBUFFER (w
->contents
));
1317 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1318 /* Scrolling a minibuffer window via scroll bar when the echo area
1319 shows long text sometimes resets the minibuffer contents behind
1321 if (CHARPOS (top
) > ZV
)
1322 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1324 /* Compute exact mode line heights. */
1325 if (WINDOW_WANTS_MODELINE_P (w
))
1327 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1328 BVAR (current_buffer
, mode_line_format
));
1330 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1331 w
->header_line_height
1332 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1333 BVAR (current_buffer
, header_line_format
));
1335 start_display (&it
, w
, top
);
1336 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1337 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1340 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1341 && IT_CHARPOS (it
) >= charpos
)
1342 /* When scanning backwards under bidi iteration, move_it_to
1343 stops at or _before_ CHARPOS, because it stops at or to
1344 the _right_ of the character at CHARPOS. */
1345 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1346 && IT_CHARPOS (it
) <= charpos
)))
1348 /* We have reached CHARPOS, or passed it. How the call to
1349 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1350 or covered by a display property, move_it_to stops at the end
1351 of the invisible text, to the right of CHARPOS. (ii) If
1352 CHARPOS is in a display vector, move_it_to stops on its last
1354 int top_x
= it
.current_x
;
1355 int top_y
= it
.current_y
;
1356 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1359 void *save_it_data
= NULL
;
1361 /* Calling line_bottom_y may change it.method, it.position, etc. */
1362 SAVE_IT (save_it
, it
, save_it_data
);
1364 bottom_y
= line_bottom_y (&it
);
1365 if (top_y
< window_top_y
)
1366 visible_p
= bottom_y
> window_top_y
;
1367 else if (top_y
< it
.last_visible_y
)
1369 if (bottom_y
>= it
.last_visible_y
1370 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1371 && IT_CHARPOS (it
) < charpos
)
1373 /* When the last line of the window is scanned backwards
1374 under bidi iteration, we could be duped into thinking
1375 that we have passed CHARPOS, when in fact move_it_to
1376 simply stopped short of CHARPOS because it reached
1377 last_visible_y. To see if that's what happened, we call
1378 move_it_to again with a slightly larger vertical limit,
1379 and see if it actually moved vertically; if it did, we
1380 didn't really reach CHARPOS, which is beyond window end. */
1381 /* Why 10? because we don't know how many canonical lines
1382 will the height of the next line(s) be. So we guess. */
1383 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1385 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1386 MOVE_TO_POS
| MOVE_TO_Y
);
1387 if (it
.current_y
> top_y
)
1391 RESTORE_IT (&it
, &save_it
, save_it_data
);
1394 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1396 /* We stopped on the last glyph of a display vector.
1397 Try and recompute. Hack alert! */
1398 if (charpos
< 2 || top
.charpos
>= charpos
)
1399 top_x
= it
.glyph_row
->x
;
1402 struct it it2
, it2_prev
;
1403 /* The idea is to get to the previous buffer
1404 position, consume the character there, and use
1405 the pixel coordinates we get after that. But if
1406 the previous buffer position is also displayed
1407 from a display vector, we need to consume all of
1408 the glyphs from that display vector. */
1409 start_display (&it2
, w
, top
);
1410 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1411 /* If we didn't get to CHARPOS - 1, there's some
1412 replacing display property at that position, and
1413 we stopped after it. That is exactly the place
1414 whose coordinates we want. */
1415 if (IT_CHARPOS (it2
) != charpos
- 1)
1419 /* Iterate until we get out of the display
1420 vector that displays the character at
1423 get_next_display_element (&it2
);
1424 PRODUCE_GLYPHS (&it2
);
1426 set_iterator_to_next (&it2
, true);
1427 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1428 && IT_CHARPOS (it2
) < charpos
);
1430 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1431 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1432 top_x
= it
.glyph_row
->x
;
1435 top_x
= it2_prev
.current_x
;
1436 top_y
= it2_prev
.current_y
;
1440 else if (IT_CHARPOS (it
) != charpos
)
1442 Lisp_Object cpos
= make_number (charpos
);
1443 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1444 Lisp_Object string
= string_from_display_spec (spec
);
1445 struct text_pos tpos
;
1446 bool newline_in_string
1448 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1450 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1451 bool replacing_spec_p
1453 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1454 charpos
, FRAME_WINDOW_P (it
.f
)));
1455 /* The tricky code below is needed because there's a
1456 discrepancy between move_it_to and how we set cursor
1457 when PT is at the beginning of a portion of text
1458 covered by a display property or an overlay with a
1459 display property, or the display line ends in a
1460 newline from a display string. move_it_to will stop
1461 _after_ such display strings, whereas
1462 set_cursor_from_row conspires with cursor_row_p to
1463 place the cursor on the first glyph produced from the
1466 /* We have overshoot PT because it is covered by a
1467 display property that replaces the text it covers.
1468 If the string includes embedded newlines, we are also
1469 in the wrong display line. Backtrack to the correct
1470 line, where the display property begins. */
1471 if (replacing_spec_p
)
1473 Lisp_Object startpos
, endpos
;
1474 EMACS_INT start
, end
;
1477 /* Find the first and the last buffer positions
1478 covered by the display string. */
1480 Fnext_single_char_property_change (cpos
, Qdisplay
,
1483 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1485 start
= XFASTINT (startpos
);
1486 end
= XFASTINT (endpos
);
1487 /* Move to the last buffer position before the
1488 display property. */
1489 start_display (&it3
, w
, top
);
1490 if (start
> CHARPOS (top
))
1491 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1492 /* Move forward one more line if the position before
1493 the display string is a newline or if it is the
1494 rightmost character on a line that is
1495 continued or word-wrapped. */
1496 if (it3
.method
== GET_FROM_BUFFER
1498 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1499 move_it_by_lines (&it3
, 1);
1500 else if (move_it_in_display_line_to (&it3
, -1,
1504 == MOVE_LINE_CONTINUED
)
1506 move_it_by_lines (&it3
, 1);
1507 /* When we are under word-wrap, the #$@%!
1508 move_it_by_lines moves 2 lines, so we need to
1510 if (it3
.line_wrap
== WORD_WRAP
)
1511 move_it_by_lines (&it3
, -1);
1514 /* Record the vertical coordinate of the display
1515 line where we wound up. */
1516 top_y
= it3
.current_y
;
1519 /* When characters are reordered for display,
1520 the character displayed to the left of the
1521 display string could be _after_ the display
1522 property in the logical order. Use the
1523 smallest vertical position of these two. */
1524 start_display (&it3
, w
, top
);
1525 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1526 if (it3
.current_y
< top_y
)
1527 top_y
= it3
.current_y
;
1529 /* Move from the top of the window to the beginning
1530 of the display line where the display string
1532 start_display (&it3
, w
, top
);
1533 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1534 /* If it3_moved stays false after the 'while' loop
1535 below, that means we already were at a newline
1536 before the loop (e.g., the display string begins
1537 with a newline), so we don't need to (and cannot)
1538 inspect the glyphs of it3.glyph_row, because
1539 PRODUCE_GLYPHS will not produce anything for a
1540 newline, and thus it3.glyph_row stays at its
1541 stale content it got at top of the window. */
1542 bool it3_moved
= false;
1543 /* Finally, advance the iterator until we hit the
1544 first display element whose character position is
1545 CHARPOS, or until the first newline from the
1546 display string, which signals the end of the
1548 while (get_next_display_element (&it3
))
1550 PRODUCE_GLYPHS (&it3
);
1551 if (IT_CHARPOS (it3
) == charpos
1552 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1555 set_iterator_to_next (&it3
, false);
1557 top_x
= it3
.current_x
- it3
.pixel_width
;
1558 /* Normally, we would exit the above loop because we
1559 found the display element whose character
1560 position is CHARPOS. For the contingency that we
1561 didn't, and stopped at the first newline from the
1562 display string, move back over the glyphs
1563 produced from the string, until we find the
1564 rightmost glyph not from the string. */
1566 && newline_in_string
1567 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1569 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1570 + it3
.glyph_row
->used
[TEXT_AREA
];
1572 while (EQ ((g
- 1)->object
, string
))
1575 top_x
-= g
->pixel_width
;
1577 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1578 + it3
.glyph_row
->used
[TEXT_AREA
]);
1584 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1585 *rtop
= max (0, window_top_y
- top_y
);
1586 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1587 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1588 - max (top_y
, window_top_y
)));
1590 if (it
.bidi_it
.paragraph_dir
== R2L
)
1596 /* Either we were asked to provide info about WINDOW_END, or
1597 CHARPOS is in the partially visible glyph row at end of
1600 void *it2data
= NULL
;
1602 SAVE_IT (it2
, it
, it2data
);
1603 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1604 move_it_by_lines (&it
, 1);
1605 if (charpos
< IT_CHARPOS (it
)
1606 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1609 RESTORE_IT (&it2
, &it2
, it2data
);
1610 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1612 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1613 *rtop
= max (0, -it2
.current_y
);
1614 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1615 - it
.last_visible_y
));
1616 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1618 - max (it2
.current_y
,
1619 WINDOW_HEADER_LINE_HEIGHT (w
))));
1621 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1625 bidi_unshelve_cache (it2data
, true);
1627 bidi_unshelve_cache (itdata
, false);
1630 set_buffer_internal_1 (old_buffer
);
1636 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1637 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1638 /* For lines in an R2L paragraph, we need to mirror the X pixel
1639 coordinate wrt the text area. For the reasons, see the
1640 commentary in buffer_posn_from_coords and the explanation of
1641 the geometry used by the move_it_* functions at the end of
1642 the large commentary near the beginning of this file. */
1644 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1648 /* Debugging code. */
1650 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1651 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1653 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1660 /* Return the next character from STR. Return in *LEN the length of
1661 the character. This is like STRING_CHAR_AND_LENGTH but never
1662 returns an invalid character. If we find one, we return a `?', but
1663 with the length of the invalid character. */
1666 string_char_and_length (const unsigned char *str
, int *len
)
1670 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1671 if (!CHAR_VALID_P (c
))
1672 /* We may not change the length here because other places in Emacs
1673 don't use this function, i.e. they silently accept invalid
1682 /* Given a position POS containing a valid character and byte position
1683 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1685 static struct text_pos
1686 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1688 eassert (STRINGP (string
) && nchars
>= 0);
1690 if (STRING_MULTIBYTE (string
))
1692 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1697 string_char_and_length (p
, &len
);
1700 BYTEPOS (pos
) += len
;
1704 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1710 /* Value is the text position, i.e. character and byte position,
1711 for character position CHARPOS in STRING. */
1713 static struct text_pos
1714 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1716 struct text_pos pos
;
1717 eassert (STRINGP (string
));
1718 eassert (charpos
>= 0);
1719 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1724 /* Value is a text position, i.e. character and byte position, for
1725 character position CHARPOS in C string S. MULTIBYTE_P
1726 means recognize multibyte characters. */
1728 static struct text_pos
1729 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1731 struct text_pos pos
;
1733 eassert (s
!= NULL
);
1734 eassert (charpos
>= 0);
1740 SET_TEXT_POS (pos
, 0, 0);
1743 string_char_and_length ((const unsigned char *) s
, &len
);
1746 BYTEPOS (pos
) += len
;
1750 SET_TEXT_POS (pos
, charpos
, charpos
);
1756 /* Value is the number of characters in C string S. MULTIBYTE_P
1757 means recognize multibyte characters. */
1760 number_of_chars (const char *s
, bool multibyte_p
)
1766 ptrdiff_t rest
= strlen (s
);
1768 const unsigned char *p
= (const unsigned char *) s
;
1770 for (nchars
= 0; rest
> 0; ++nchars
)
1772 string_char_and_length (p
, &len
);
1773 rest
-= len
, p
+= len
;
1777 nchars
= strlen (s
);
1783 /* Compute byte position NEWPOS->bytepos corresponding to
1784 NEWPOS->charpos. POS is a known position in string STRING.
1785 NEWPOS->charpos must be >= POS.charpos. */
1788 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1790 eassert (STRINGP (string
));
1791 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1793 if (STRING_MULTIBYTE (string
))
1794 *newpos
= string_pos_nchars_ahead (pos
, string
,
1795 CHARPOS (*newpos
) - CHARPOS (pos
));
1797 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1801 Return an estimation of the pixel height of mode or header lines on
1802 frame F. FACE_ID specifies what line's height to estimate. */
1805 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1807 #ifdef HAVE_WINDOW_SYSTEM
1808 if (FRAME_WINDOW_P (f
))
1810 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1812 /* This function is called so early when Emacs starts that the face
1813 cache and mode line face are not yet initialized. */
1814 if (FRAME_FACE_CACHE (f
))
1816 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1820 height
= normal_char_height (face
->font
, -1);
1821 if (face
->box_line_width
> 0)
1822 height
+= 2 * face
->box_line_width
;
1833 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1834 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1835 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1836 not force the value into range. */
1839 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1840 NativeRectangle
*bounds
, bool noclip
)
1843 #ifdef HAVE_WINDOW_SYSTEM
1844 if (FRAME_WINDOW_P (f
))
1846 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1847 even for negative values. */
1849 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1851 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1853 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1854 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1857 STORE_NATIVE_RECT (*bounds
,
1858 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1859 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1860 FRAME_COLUMN_WIDTH (f
) - 1,
1861 FRAME_LINE_HEIGHT (f
) - 1);
1863 /* PXW: Should we clip pixels before converting to columns/lines? */
1868 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1869 pix_x
= FRAME_TOTAL_COLS (f
);
1873 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1874 pix_y
= FRAME_TOTAL_LINES (f
);
1884 /* Find the glyph under window-relative coordinates X/Y in window W.
1885 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1886 strings. Return in *HPOS and *VPOS the row and column number of
1887 the glyph found. Return in *AREA the glyph area containing X.
1888 Value is a pointer to the glyph found or null if X/Y is not on
1889 text, or we can't tell because W's current matrix is not up to
1892 static struct glyph
*
1893 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1894 int *dx
, int *dy
, int *area
)
1896 struct glyph
*glyph
, *end
;
1897 struct glyph_row
*row
= NULL
;
1900 /* Find row containing Y. Give up if some row is not enabled. */
1901 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1903 row
= MATRIX_ROW (w
->current_matrix
, i
);
1904 if (!row
->enabled_p
)
1906 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1913 /* Give up if Y is not in the window. */
1914 if (i
== w
->current_matrix
->nrows
)
1917 /* Get the glyph area containing X. */
1918 if (w
->pseudo_window_p
)
1925 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1927 *area
= LEFT_MARGIN_AREA
;
1928 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1930 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1933 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1937 *area
= RIGHT_MARGIN_AREA
;
1938 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1942 /* Find glyph containing X. */
1943 glyph
= row
->glyphs
[*area
];
1944 end
= glyph
+ row
->used
[*area
];
1946 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1948 x
-= glyph
->pixel_width
;
1958 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1961 *hpos
= glyph
- row
->glyphs
[*area
];
1965 /* Convert frame-relative x/y to coordinates relative to window W.
1966 Takes pseudo-windows into account. */
1969 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1971 if (w
->pseudo_window_p
)
1973 /* A pseudo-window is always full-width, and starts at the
1974 left edge of the frame, plus a frame border. */
1975 struct frame
*f
= XFRAME (w
->frame
);
1976 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1977 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1981 *x
-= WINDOW_LEFT_EDGE_X (w
);
1982 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1986 #ifdef HAVE_WINDOW_SYSTEM
1989 Return in RECTS[] at most N clipping rectangles for glyph string S.
1990 Return the number of stored rectangles. */
1993 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2000 if (s
->row
->full_width_p
)
2002 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2003 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2004 if (s
->row
->mode_line_p
)
2005 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2007 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2009 /* Unless displaying a mode or menu bar line, which are always
2010 fully visible, clip to the visible part of the row. */
2011 if (s
->w
->pseudo_window_p
)
2012 r
.height
= s
->row
->visible_height
;
2014 r
.height
= s
->height
;
2018 /* This is a text line that may be partially visible. */
2019 r
.x
= window_box_left (s
->w
, s
->area
);
2020 r
.width
= window_box_width (s
->w
, s
->area
);
2021 r
.height
= s
->row
->visible_height
;
2025 if (r
.x
< s
->clip_head
->x
)
2027 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2028 r
.width
-= s
->clip_head
->x
- r
.x
;
2031 r
.x
= s
->clip_head
->x
;
2034 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2036 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2037 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2042 /* If S draws overlapping rows, it's sufficient to use the top and
2043 bottom of the window for clipping because this glyph string
2044 intentionally draws over other lines. */
2045 if (s
->for_overlaps
)
2047 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2048 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2050 /* Alas, the above simple strategy does not work for the
2051 environments with anti-aliased text: if the same text is
2052 drawn onto the same place multiple times, it gets thicker.
2053 If the overlap we are processing is for the erased cursor, we
2054 take the intersection with the rectangle of the cursor. */
2055 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2057 XRectangle rc
, r_save
= r
;
2059 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2060 rc
.y
= s
->w
->phys_cursor
.y
;
2061 rc
.width
= s
->w
->phys_cursor_width
;
2062 rc
.height
= s
->w
->phys_cursor_height
;
2064 x_intersect_rectangles (&r_save
, &rc
, &r
);
2069 /* Don't use S->y for clipping because it doesn't take partially
2070 visible lines into account. For example, it can be negative for
2071 partially visible lines at the top of a window. */
2072 if (!s
->row
->full_width_p
2073 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2074 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2076 r
.y
= max (0, s
->row
->y
);
2079 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2081 /* If drawing the cursor, don't let glyph draw outside its
2082 advertised boundaries. Cleartype does this under some circumstances. */
2083 if (s
->hl
== DRAW_CURSOR
)
2085 struct glyph
*glyph
= s
->first_glyph
;
2090 if (r
.width
>= s
->x
- r
.x
)
2091 r
.width
-= s
->x
- r
.x
;
2092 else /* R2L hscrolled row with cursor outside text area */
2096 r
.width
= min (r
.width
, glyph
->pixel_width
);
2098 /* If r.y is below window bottom, ensure that we still see a cursor. */
2099 height
= min (glyph
->ascent
+ glyph
->descent
,
2100 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2101 max_y
= window_text_bottom_y (s
->w
) - height
;
2102 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2103 if (s
->ybase
- glyph
->ascent
> max_y
)
2110 /* Don't draw cursor glyph taller than our actual glyph. */
2111 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2112 if (height
< r
.height
)
2114 max_y
= r
.y
+ r
.height
;
2115 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2116 r
.height
= min (max_y
- r
.y
, height
);
2123 XRectangle r_save
= r
;
2125 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2129 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2130 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2132 #ifdef CONVERT_FROM_XRECT
2133 CONVERT_FROM_XRECT (r
, *rects
);
2141 /* If we are processing overlapping and allowed to return
2142 multiple clipping rectangles, we exclude the row of the glyph
2143 string from the clipping rectangle. This is to avoid drawing
2144 the same text on the environment with anti-aliasing. */
2145 #ifdef CONVERT_FROM_XRECT
2148 XRectangle
*rs
= rects
;
2150 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2152 if (s
->for_overlaps
& OVERLAPS_PRED
)
2155 if (r
.y
+ r
.height
> row_y
)
2158 rs
[i
].height
= row_y
- r
.y
;
2164 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2167 if (r
.y
< row_y
+ s
->row
->visible_height
)
2169 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2171 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2172 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2181 #ifdef CONVERT_FROM_XRECT
2182 for (i
= 0; i
< n
; i
++)
2183 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2190 Return in *NR the clipping rectangle for glyph string S. */
2193 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2195 get_glyph_string_clip_rects (s
, nr
, 1);
2200 Return the position and height of the phys cursor in window W.
2201 Set w->phys_cursor_width to width of phys cursor.
2205 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2206 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2208 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2209 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2211 /* Compute the width of the rectangle to draw. If on a stretch
2212 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2213 rectangle as wide as the glyph, but use a canonical character
2215 wd
= glyph
->pixel_width
;
2217 x
= w
->phys_cursor
.x
;
2224 if (glyph
->type
== STRETCH_GLYPH
2225 && !x_stretch_cursor_p
)
2226 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2227 w
->phys_cursor_width
= wd
;
2229 /* Don't let the hollow cursor glyph descend below the glyph row's
2230 ascent value, lest the hollow cursor looks funny. */
2231 y
= w
->phys_cursor
.y
;
2232 ascent
= row
->ascent
;
2233 if (row
->ascent
< glyph
->ascent
)
2235 y
=- glyph
->ascent
- row
->ascent
;
2236 ascent
= glyph
->ascent
;
2239 /* If y is below window bottom, ensure that we still see a cursor. */
2240 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2242 h
= max (h0
, ascent
+ glyph
->descent
);
2243 h0
= min (h0
, ascent
+ glyph
->descent
);
2245 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2248 h
= max (h
- (y0
- y
) + 1, h0
);
2253 y0
= window_text_bottom_y (w
) - h0
;
2261 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2262 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2267 * Remember which glyph the mouse is over.
2271 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2275 struct glyph_row
*r
, *gr
, *end_row
;
2276 enum window_part part
;
2277 enum glyph_row_area area
;
2278 int x
, y
, width
, height
;
2280 /* Try to determine frame pixel position and size of the glyph under
2281 frame pixel coordinates X/Y on frame F. */
2283 if (window_resize_pixelwise
)
2288 else if (!f
->glyphs_initialized_p
2289 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2292 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2293 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2297 w
= XWINDOW (window
);
2298 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2299 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2301 x
= window_relative_x_coord (w
, part
, gx
);
2302 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2304 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2305 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2307 if (w
->pseudo_window_p
)
2310 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2316 case ON_LEFT_MARGIN
:
2317 area
= LEFT_MARGIN_AREA
;
2320 case ON_RIGHT_MARGIN
:
2321 area
= RIGHT_MARGIN_AREA
;
2324 case ON_HEADER_LINE
:
2326 gr
= (part
== ON_HEADER_LINE
2327 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2328 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2331 goto text_glyph_row_found
;
2338 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2339 if (r
->y
+ r
->height
> y
)
2345 text_glyph_row_found
:
2348 struct glyph
*g
= gr
->glyphs
[area
];
2349 struct glyph
*end
= g
+ gr
->used
[area
];
2351 height
= gr
->height
;
2352 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2353 if (gx
+ g
->pixel_width
> x
)
2358 if (g
->type
== IMAGE_GLYPH
)
2360 /* Don't remember when mouse is over image, as
2361 image may have hot-spots. */
2362 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2365 width
= g
->pixel_width
;
2369 /* Use nominal char spacing at end of line. */
2371 gx
+= (x
/ width
) * width
;
2374 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2376 gx
+= window_box_left_offset (w
, area
);
2377 /* Don't expand over the modeline to make sure the vertical
2378 drag cursor is shown early enough. */
2379 height
= min (height
,
2380 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2385 /* Use nominal line height at end of window. */
2386 gx
= (x
/ width
) * width
;
2388 gy
+= (y
/ height
) * height
;
2389 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2390 /* See comment above. */
2391 height
= min (height
,
2392 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2396 case ON_LEFT_FRINGE
:
2397 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2398 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2399 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2400 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2403 case ON_RIGHT_FRINGE
:
2404 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2405 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2406 : window_box_right_offset (w
, TEXT_AREA
));
2407 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2409 && !WINDOW_RIGHTMOST_P (w
))
2410 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2411 /* Make sure the vertical border can get her own glyph to the
2412 right of the one we build here. */
2413 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2415 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2417 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2421 case ON_VERTICAL_BORDER
:
2422 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2425 case ON_VERTICAL_SCROLL_BAR
:
2426 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2428 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2429 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2430 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2432 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2436 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2437 if (r
->y
+ r
->height
> y
)
2444 height
= gr
->height
;
2447 /* Use nominal line height at end of window. */
2449 gy
+= (y
/ height
) * height
;
2453 case ON_RIGHT_DIVIDER
:
2454 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2455 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2457 /* The bottom divider prevails. */
2458 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2461 case ON_BOTTOM_DIVIDER
:
2463 width
= WINDOW_PIXEL_WIDTH (w
);
2464 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2465 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2471 /* If there is no glyph under the mouse, then we divide the screen
2472 into a grid of the smallest glyph in the frame, and use that
2475 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2476 round down even for negative values. */
2482 gx
= (gx
/ width
) * width
;
2483 gy
= (gy
/ height
) * height
;
2489 gx
+= WINDOW_LEFT_EDGE_X (w
);
2490 gy
+= WINDOW_TOP_EDGE_Y (w
);
2493 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2495 /* Visible feedback for debugging. */
2496 #if false && defined HAVE_X_WINDOWS
2497 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2498 f
->output_data
.x
->normal_gc
,
2499 gx
, gy
, width
, height
);
2504 #endif /* HAVE_WINDOW_SYSTEM */
2507 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2510 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2513 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2516 /***********************************************************************
2517 Lisp form evaluation
2518 ***********************************************************************/
2520 /* Error handler for safe_eval and safe_call. */
2523 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2525 add_to_log ("Error during redisplay: %S signaled %S",
2526 Flist (nargs
, args
), arg
);
2530 /* Call function FUNC with the rest of NARGS - 1 arguments
2531 following. Return the result, or nil if something went
2532 wrong. Prevent redisplay during the evaluation. */
2535 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2539 if (inhibit_eval_during_redisplay
)
2544 ptrdiff_t count
= SPECPDL_INDEX ();
2547 SAFE_ALLOCA_LISP (args
, nargs
);
2550 for (i
= 1; i
< nargs
; i
++)
2551 args
[i
] = va_arg (ap
, Lisp_Object
);
2553 specbind (Qinhibit_redisplay
, Qt
);
2555 specbind (Qinhibit_quit
, Qt
);
2556 /* Use Qt to ensure debugger does not run,
2557 so there is no possibility of wanting to redisplay. */
2558 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2561 val
= unbind_to (count
, val
);
2568 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2573 va_start (ap
, func
);
2574 retval
= safe__call (false, nargs
, func
, ap
);
2579 /* Call function FN with one argument ARG.
2580 Return the result, or nil if something went wrong. */
2583 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2585 return safe_call (2, fn
, arg
);
2589 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2595 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2601 safe_eval (Lisp_Object sexpr
)
2603 return safe__call1 (false, Qeval
, sexpr
);
2607 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2609 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2612 /* Call function FN with two arguments ARG1 and ARG2.
2613 Return the result, or nil if something went wrong. */
2616 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2618 return safe_call (3, fn
, arg1
, arg2
);
2623 /***********************************************************************
2625 ***********************************************************************/
2627 /* Define CHECK_IT to perform sanity checks on iterators.
2628 This is for debugging. It is too slow to do unconditionally. */
2631 CHECK_IT (struct it
*it
)
2634 if (it
->method
== GET_FROM_STRING
)
2636 eassert (STRINGP (it
->string
));
2637 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2641 eassert (IT_STRING_CHARPOS (*it
) < 0);
2642 if (it
->method
== GET_FROM_BUFFER
)
2644 /* Check that character and byte positions agree. */
2645 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2650 eassert (it
->current
.dpvec_index
>= 0);
2652 eassert (it
->current
.dpvec_index
< 0);
2657 /* Check that the window end of window W is what we expect it
2658 to be---the last row in the current matrix displaying text. */
2661 CHECK_WINDOW_END (struct window
*w
)
2663 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2664 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2666 struct glyph_row
*row
;
2667 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2669 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2670 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2675 /***********************************************************************
2676 Iterator initialization
2677 ***********************************************************************/
2679 /* Initialize IT for displaying current_buffer in window W, starting
2680 at character position CHARPOS. CHARPOS < 0 means that no buffer
2681 position is specified which is useful when the iterator is assigned
2682 a position later. BYTEPOS is the byte position corresponding to
2685 If ROW is not null, calls to produce_glyphs with IT as parameter
2686 will produce glyphs in that row.
2688 BASE_FACE_ID is the id of a base face to use. It must be one of
2689 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2690 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2691 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2693 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2694 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2695 will be initialized to use the corresponding mode line glyph row of
2696 the desired matrix of W. */
2699 init_iterator (struct it
*it
, struct window
*w
,
2700 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2701 struct glyph_row
*row
, enum face_id base_face_id
)
2703 enum face_id remapped_base_face_id
= base_face_id
;
2705 /* Some precondition checks. */
2706 eassert (w
!= NULL
&& it
!= NULL
);
2707 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2710 /* If face attributes have been changed since the last redisplay,
2711 free realized faces now because they depend on face definitions
2712 that might have changed. Don't free faces while there might be
2713 desired matrices pending which reference these faces. */
2714 if (!inhibit_free_realized_faces
)
2718 face_change
= false;
2719 free_all_realized_faces (Qnil
);
2721 else if (XFRAME (w
->frame
)->face_change
)
2723 XFRAME (w
->frame
)->face_change
= 0;
2724 free_all_realized_faces (w
->frame
);
2728 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2729 if (! NILP (Vface_remapping_alist
))
2730 remapped_base_face_id
2731 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2733 /* Use one of the mode line rows of W's desired matrix if
2737 if (base_face_id
== MODE_LINE_FACE_ID
2738 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2739 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2740 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2741 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2744 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2745 Other parts of redisplay rely on that. */
2746 memclear (it
, sizeof *it
);
2747 it
->current
.overlay_string_index
= -1;
2748 it
->current
.dpvec_index
= -1;
2749 it
->base_face_id
= remapped_base_face_id
;
2750 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2751 it
->paragraph_embedding
= L2R
;
2754 /* The window in which we iterate over current_buffer: */
2755 XSETWINDOW (it
->window
, w
);
2757 it
->f
= XFRAME (w
->frame
);
2761 /* Extra space between lines (on window systems only). */
2762 if (base_face_id
== DEFAULT_FACE_ID
2763 && FRAME_WINDOW_P (it
->f
))
2765 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2766 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2767 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2768 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2769 * FRAME_LINE_HEIGHT (it
->f
));
2770 else if (it
->f
->extra_line_spacing
> 0)
2771 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2774 /* If realized faces have been removed, e.g. because of face
2775 attribute changes of named faces, recompute them. When running
2776 in batch mode, the face cache of the initial frame is null. If
2777 we happen to get called, make a dummy face cache. */
2778 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2779 init_frame_faces (it
->f
);
2780 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2781 recompute_basic_faces (it
->f
);
2783 it
->override_ascent
= -1;
2785 /* Are control characters displayed as `^C'? */
2786 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2788 /* -1 means everything between a CR and the following line end
2789 is invisible. >0 means lines indented more than this value are
2791 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2793 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2795 : (!NILP (BVAR (current_buffer
, selective_display
))
2797 it
->selective_display_ellipsis_p
2798 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2800 /* Display table to use. */
2801 it
->dp
= window_display_table (w
);
2803 /* Are multibyte characters enabled in current_buffer? */
2804 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2806 /* Get the position at which the redisplay_end_trigger hook should
2807 be run, if it is to be run at all. */
2808 if (MARKERP (w
->redisplay_end_trigger
)
2809 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2810 it
->redisplay_end_trigger_charpos
2811 = marker_position (w
->redisplay_end_trigger
);
2812 else if (INTEGERP (w
->redisplay_end_trigger
))
2813 it
->redisplay_end_trigger_charpos
2814 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2817 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2819 /* Are lines in the display truncated? */
2821 it
->line_wrap
= TRUNCATE
;
2822 if (base_face_id
== DEFAULT_FACE_ID
2824 && (WINDOW_FULL_WIDTH_P (it
->w
)
2825 || NILP (Vtruncate_partial_width_windows
)
2826 || (INTEGERP (Vtruncate_partial_width_windows
)
2827 /* PXW: Shall we do something about this? */
2828 && (XINT (Vtruncate_partial_width_windows
)
2829 <= WINDOW_TOTAL_COLS (it
->w
))))
2830 && NILP (BVAR (current_buffer
, truncate_lines
)))
2831 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2832 ? WINDOW_WRAP
: WORD_WRAP
;
2834 /* Get dimensions of truncation and continuation glyphs. These are
2835 displayed as fringe bitmaps under X, but we need them for such
2836 frames when the fringes are turned off. But leave the dimensions
2837 zero for tooltip frames, as these glyphs look ugly there and also
2838 sabotage calculations of tooltip dimensions in x-show-tip. */
2839 #ifdef HAVE_WINDOW_SYSTEM
2840 if (!(FRAME_WINDOW_P (it
->f
)
2841 && FRAMEP (tip_frame
)
2842 && it
->f
== XFRAME (tip_frame
)))
2845 if (it
->line_wrap
== TRUNCATE
)
2847 /* We will need the truncation glyph. */
2848 eassert (it
->glyph_row
== NULL
);
2849 produce_special_glyphs (it
, IT_TRUNCATION
);
2850 it
->truncation_pixel_width
= it
->pixel_width
;
2854 /* We will need the continuation glyph. */
2855 eassert (it
->glyph_row
== NULL
);
2856 produce_special_glyphs (it
, IT_CONTINUATION
);
2857 it
->continuation_pixel_width
= it
->pixel_width
;
2861 /* Reset these values to zero because the produce_special_glyphs
2862 above has changed them. */
2863 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2864 it
->phys_ascent
= it
->phys_descent
= 0;
2866 /* Set this after getting the dimensions of truncation and
2867 continuation glyphs, so that we don't produce glyphs when calling
2868 produce_special_glyphs, above. */
2869 it
->glyph_row
= row
;
2870 it
->area
= TEXT_AREA
;
2872 /* Get the dimensions of the display area. The display area
2873 consists of the visible window area plus a horizontally scrolled
2874 part to the left of the window. All x-values are relative to the
2875 start of this total display area. */
2876 if (base_face_id
!= DEFAULT_FACE_ID
)
2878 /* Mode lines, menu bar in terminal frames. */
2879 it
->first_visible_x
= 0;
2880 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2885 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2886 it
->last_visible_x
= (it
->first_visible_x
2887 + window_box_width (w
, TEXT_AREA
));
2889 /* If we truncate lines, leave room for the truncation glyph(s) at
2890 the right margin. Otherwise, leave room for the continuation
2891 glyph(s). Done only if the window has no right fringe. */
2892 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2894 if (it
->line_wrap
== TRUNCATE
)
2895 it
->last_visible_x
-= it
->truncation_pixel_width
;
2897 it
->last_visible_x
-= it
->continuation_pixel_width
;
2900 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2901 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2904 /* Leave room for a border glyph. */
2905 if (!FRAME_WINDOW_P (it
->f
)
2906 && !WINDOW_RIGHTMOST_P (it
->w
))
2907 it
->last_visible_x
-= 1;
2909 it
->last_visible_y
= window_text_bottom_y (w
);
2911 /* For mode lines and alike, arrange for the first glyph having a
2912 left box line if the face specifies a box. */
2913 if (base_face_id
!= DEFAULT_FACE_ID
)
2917 it
->face_id
= remapped_base_face_id
;
2919 /* If we have a boxed mode line, make the first character appear
2920 with a left box line. */
2921 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2922 if (face
&& face
->box
!= FACE_NO_BOX
)
2923 it
->start_of_box_run_p
= true;
2926 /* If a buffer position was specified, set the iterator there,
2927 getting overlays and face properties from that position. */
2928 if (charpos
>= BUF_BEG (current_buffer
))
2930 it
->stop_charpos
= charpos
;
2931 it
->end_charpos
= ZV
;
2932 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2933 IT_CHARPOS (*it
) = charpos
;
2934 IT_BYTEPOS (*it
) = bytepos
;
2936 /* We will rely on `reseat' to set this up properly, via
2937 handle_face_prop. */
2938 it
->face_id
= it
->base_face_id
;
2940 it
->start
= it
->current
;
2941 /* Do we need to reorder bidirectional text? Not if this is a
2942 unibyte buffer: by definition, none of the single-byte
2943 characters are strong R2L, so no reordering is needed. And
2944 bidi.c doesn't support unibyte buffers anyway. Also, don't
2945 reorder while we are loading loadup.el, since the tables of
2946 character properties needed for reordering are not yet
2950 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2953 /* If we are to reorder bidirectional text, init the bidi
2957 /* Since we don't know at this point whether there will be
2958 any R2L lines in the window, we reserve space for
2959 truncation/continuation glyphs even if only the left
2960 fringe is absent. */
2961 if (base_face_id
== DEFAULT_FACE_ID
2962 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2963 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2965 if (it
->line_wrap
== TRUNCATE
)
2966 it
->last_visible_x
-= it
->truncation_pixel_width
;
2968 it
->last_visible_x
-= it
->continuation_pixel_width
;
2970 /* Note the paragraph direction that this buffer wants to
2972 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2974 it
->paragraph_embedding
= L2R
;
2975 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2977 it
->paragraph_embedding
= R2L
;
2979 it
->paragraph_embedding
= NEUTRAL_DIR
;
2980 bidi_unshelve_cache (NULL
, false);
2981 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2985 /* Compute faces etc. */
2986 reseat (it
, it
->current
.pos
, true);
2993 /* Initialize IT for the display of window W with window start POS. */
2996 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2998 struct glyph_row
*row
;
2999 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
3001 row
= w
->desired_matrix
->rows
+ first_vpos
;
3002 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3003 it
->first_vpos
= first_vpos
;
3005 /* Don't reseat to previous visible line start if current start
3006 position is in a string or image. */
3007 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3009 int first_y
= it
->current_y
;
3011 /* If window start is not at a line start, skip forward to POS to
3012 get the correct continuation lines width. */
3013 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3014 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3015 if (!start_at_line_beg_p
)
3019 reseat_at_previous_visible_line_start (it
);
3020 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3022 new_x
= it
->current_x
+ it
->pixel_width
;
3024 /* If lines are continued, this line may end in the middle
3025 of a multi-glyph character (e.g. a control character
3026 displayed as \003, or in the middle of an overlay
3027 string). In this case move_it_to above will not have
3028 taken us to the start of the continuation line but to the
3029 end of the continued line. */
3030 if (it
->current_x
> 0
3031 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3032 && (/* And glyph doesn't fit on the line. */
3033 new_x
> it
->last_visible_x
3034 /* Or it fits exactly and we're on a window
3036 || (new_x
== it
->last_visible_x
3037 && FRAME_WINDOW_P (it
->f
)
3038 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3039 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3040 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3042 if ((it
->current
.dpvec_index
>= 0
3043 || it
->current
.overlay_string_index
>= 0)
3044 /* If we are on a newline from a display vector or
3045 overlay string, then we are already at the end of
3046 a screen line; no need to go to the next line in
3047 that case, as this line is not really continued.
3048 (If we do go to the next line, C-e will not DTRT.) */
3051 set_iterator_to_next (it
, true);
3052 move_it_in_display_line_to (it
, -1, -1, 0);
3055 it
->continuation_lines_width
+= it
->current_x
;
3057 /* If the character at POS is displayed via a display
3058 vector, move_it_to above stops at the final glyph of
3059 IT->dpvec. To make the caller redisplay that character
3060 again (a.k.a. start at POS), we need to reset the
3061 dpvec_index to the beginning of IT->dpvec. */
3062 else if (it
->current
.dpvec_index
>= 0)
3063 it
->current
.dpvec_index
= 0;
3065 /* We're starting a new display line, not affected by the
3066 height of the continued line, so clear the appropriate
3067 fields in the iterator structure. */
3068 it
->max_ascent
= it
->max_descent
= 0;
3069 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3071 it
->current_y
= first_y
;
3073 it
->current_x
= it
->hpos
= 0;
3079 /* Return true if POS is a position in ellipses displayed for invisible
3080 text. W is the window we display, for text property lookup. */
3083 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3085 Lisp_Object prop
, window
;
3086 bool ellipses_p
= false;
3087 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3089 /* If POS specifies a position in a display vector, this might
3090 be for an ellipsis displayed for invisible text. We won't
3091 get the iterator set up for delivering that ellipsis unless
3092 we make sure that it gets aware of the invisible text. */
3093 if (pos
->dpvec_index
>= 0
3094 && pos
->overlay_string_index
< 0
3095 && CHARPOS (pos
->string_pos
) < 0
3097 && (XSETWINDOW (window
, w
),
3098 prop
= Fget_char_property (make_number (charpos
),
3099 Qinvisible
, window
),
3100 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3102 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3104 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3111 /* Initialize IT for stepping through current_buffer in window W,
3112 starting at position POS that includes overlay string and display
3113 vector/ control character translation position information. Value
3114 is false if there are overlay strings with newlines at POS. */
3117 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3119 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3121 bool overlay_strings_with_newlines
= false;
3123 /* If POS specifies a position in a display vector, this might
3124 be for an ellipsis displayed for invisible text. We won't
3125 get the iterator set up for delivering that ellipsis unless
3126 we make sure that it gets aware of the invisible text. */
3127 if (in_ellipses_for_invisible_text_p (pos
, w
))
3133 /* Keep in mind: the call to reseat in init_iterator skips invisible
3134 text, so we might end up at a position different from POS. This
3135 is only a problem when POS is a row start after a newline and an
3136 overlay starts there with an after-string, and the overlay has an
3137 invisible property. Since we don't skip invisible text in
3138 display_line and elsewhere immediately after consuming the
3139 newline before the row start, such a POS will not be in a string,
3140 but the call to init_iterator below will move us to the
3142 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3144 /* This only scans the current chunk -- it should scan all chunks.
3145 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3146 to 16 in 22.1 to make this a lesser problem. */
3147 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3149 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3150 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3152 while (s
< e
&& *s
!= '\n')
3157 overlay_strings_with_newlines
= true;
3162 /* If position is within an overlay string, set up IT to the right
3164 if (pos
->overlay_string_index
>= 0)
3168 /* If the first overlay string happens to have a `display'
3169 property for an image, the iterator will be set up for that
3170 image, and we have to undo that setup first before we can
3171 correct the overlay string index. */
3172 if (it
->method
== GET_FROM_IMAGE
)
3175 /* We already have the first chunk of overlay strings in
3176 IT->overlay_strings. Load more until the one for
3177 pos->overlay_string_index is in IT->overlay_strings. */
3178 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3180 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3181 it
->current
.overlay_string_index
= 0;
3184 load_overlay_strings (it
, 0);
3185 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3189 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3190 relative_index
= (it
->current
.overlay_string_index
3191 % OVERLAY_STRING_CHUNK_SIZE
);
3192 it
->string
= it
->overlay_strings
[relative_index
];
3193 eassert (STRINGP (it
->string
));
3194 it
->current
.string_pos
= pos
->string_pos
;
3195 it
->method
= GET_FROM_STRING
;
3196 it
->end_charpos
= SCHARS (it
->string
);
3197 /* Set up the bidi iterator for this overlay string. */
3200 it
->bidi_it
.string
.lstring
= it
->string
;
3201 it
->bidi_it
.string
.s
= NULL
;
3202 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3203 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3204 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3205 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3206 it
->bidi_it
.w
= it
->w
;
3207 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3208 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3210 /* Synchronize the state of the bidi iterator with
3211 pos->string_pos. For any string position other than
3212 zero, this will be done automagically when we resume
3213 iteration over the string and get_visually_first_element
3214 is called. But if string_pos is zero, and the string is
3215 to be reordered for display, we need to resync manually,
3216 since it could be that the iteration state recorded in
3217 pos ended at string_pos of 0 moving backwards in string. */
3218 if (CHARPOS (pos
->string_pos
) == 0)
3220 get_visually_first_element (it
);
3221 if (IT_STRING_CHARPOS (*it
) != 0)
3224 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3225 bidi_move_to_visually_next (&it
->bidi_it
);
3226 } while (it
->bidi_it
.charpos
!= 0);
3228 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3229 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3233 if (CHARPOS (pos
->string_pos
) >= 0)
3235 /* Recorded position is not in an overlay string, but in another
3236 string. This can only be a string from a `display' property.
3237 IT should already be filled with that string. */
3238 it
->current
.string_pos
= pos
->string_pos
;
3239 eassert (STRINGP (it
->string
));
3241 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3242 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3245 /* Restore position in display vector translations, control
3246 character translations or ellipses. */
3247 if (pos
->dpvec_index
>= 0)
3249 if (it
->dpvec
== NULL
)
3250 get_next_display_element (it
);
3251 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3252 it
->current
.dpvec_index
= pos
->dpvec_index
;
3256 return !overlay_strings_with_newlines
;
3260 /* Initialize IT for stepping through current_buffer in window W
3261 starting at ROW->start. */
3264 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3266 init_from_display_pos (it
, w
, &row
->start
);
3267 it
->start
= row
->start
;
3268 it
->continuation_lines_width
= row
->continuation_lines_width
;
3273 /* Initialize IT for stepping through current_buffer in window W
3274 starting in the line following ROW, i.e. starting at ROW->end.
3275 Value is false if there are overlay strings with newlines at ROW's
3279 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3281 bool success
= false;
3283 if (init_from_display_pos (it
, w
, &row
->end
))
3285 if (row
->continued_p
)
3286 it
->continuation_lines_width
3287 = row
->continuation_lines_width
+ row
->pixel_width
;
3298 /***********************************************************************
3300 ***********************************************************************/
3302 /* Called when IT reaches IT->stop_charpos. Handle text property and
3303 overlay changes. Set IT->stop_charpos to the next position where
3307 handle_stop (struct it
*it
)
3309 enum prop_handled handled
;
3310 bool handle_overlay_change_p
;
3314 it
->current
.dpvec_index
= -1;
3315 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3316 it
->ellipsis_p
= false;
3318 /* Use face of preceding text for ellipsis (if invisible) */
3319 if (it
->selective_display_ellipsis_p
)
3320 it
->saved_face_id
= it
->face_id
;
3322 /* Here's the description of the semantics of, and the logic behind,
3323 the various HANDLED_* statuses:
3325 HANDLED_NORMALLY means the handler did its job, and the loop
3326 should proceed to calling the next handler in order.
3328 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3329 change in the properties and overlays at current position, so the
3330 loop should be restarted, to re-invoke the handlers that were
3331 already called. This happens when fontification-functions were
3332 called by handle_fontified_prop, and actually fontified
3333 something. Another case where HANDLED_RECOMPUTE_PROPS is
3334 returned is when we discover overlay strings that need to be
3335 displayed right away. The loop below will continue for as long
3336 as the status is HANDLED_RECOMPUTE_PROPS.
3338 HANDLED_RETURN means return immediately to the caller, to
3339 continue iteration without calling any further handlers. This is
3340 used when we need to act on some property right away, for example
3341 when we need to display the ellipsis or a replacing display
3342 property, such as display string or image.
3344 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3345 consumed, and the handler switched to the next overlay string.
3346 This signals the loop below to refrain from looking for more
3347 overlays before all the overlay strings of the current overlay
3350 Some of the handlers called by the loop push the iterator state
3351 onto the stack (see 'push_it'), and arrange for the iteration to
3352 continue with another object, such as an image, a display string,
3353 or an overlay string. In most such cases, it->stop_charpos is
3354 set to the first character of the string, so that when the
3355 iteration resumes, this function will immediately be called
3356 again, to examine the properties at the beginning of the string.
3358 When a display or overlay string is exhausted, the iterator state
3359 is popped (see 'pop_it'), and iteration continues with the
3360 previous object. Again, in many such cases this function is
3361 called again to find the next position where properties might
3366 handled
= HANDLED_NORMALLY
;
3368 /* Call text property handlers. */
3369 for (p
= it_props
; p
->handler
; ++p
)
3371 handled
= p
->handler (it
);
3373 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3375 else if (handled
== HANDLED_RETURN
)
3377 /* We still want to show before and after strings from
3378 overlays even if the actual buffer text is replaced. */
3379 if (!handle_overlay_change_p
3381 /* Don't call get_overlay_strings_1 if we already
3382 have overlay strings loaded, because doing so
3383 will load them again and push the iterator state
3384 onto the stack one more time, which is not
3385 expected by the rest of the code that processes
3387 || (it
->current
.overlay_string_index
< 0
3388 && !get_overlay_strings_1 (it
, 0, false)))
3391 setup_for_ellipsis (it
, 0);
3392 /* When handling a display spec, we might load an
3393 empty string. In that case, discard it here. We
3394 used to discard it in handle_single_display_spec,
3395 but that causes get_overlay_strings_1, above, to
3396 ignore overlay strings that we must check. */
3397 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3405 it
->string_from_display_prop_p
= false;
3406 it
->from_disp_prop_p
= false;
3407 handle_overlay_change_p
= false;
3409 handled
= HANDLED_RECOMPUTE_PROPS
;
3412 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3413 handle_overlay_change_p
= false;
3416 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3418 /* Don't check for overlay strings below when set to deliver
3419 characters from a display vector. */
3420 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3421 handle_overlay_change_p
= false;
3423 /* Handle overlay changes.
3424 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3425 if it finds overlays. */
3426 if (handle_overlay_change_p
)
3427 handled
= handle_overlay_change (it
);
3432 setup_for_ellipsis (it
, 0);
3436 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3438 /* Determine where to stop next. */
3439 if (handled
== HANDLED_NORMALLY
)
3440 compute_stop_pos (it
);
3444 /* Compute IT->stop_charpos from text property and overlay change
3445 information for IT's current position. */
3448 compute_stop_pos (struct it
*it
)
3450 register INTERVAL iv
, next_iv
;
3451 Lisp_Object object
, limit
, position
;
3452 ptrdiff_t charpos
, bytepos
;
3454 if (STRINGP (it
->string
))
3456 /* Strings are usually short, so don't limit the search for
3458 it
->stop_charpos
= it
->end_charpos
;
3459 object
= it
->string
;
3461 charpos
= IT_STRING_CHARPOS (*it
);
3462 bytepos
= IT_STRING_BYTEPOS (*it
);
3468 /* If end_charpos is out of range for some reason, such as a
3469 misbehaving display function, rationalize it (Bug#5984). */
3470 if (it
->end_charpos
> ZV
)
3471 it
->end_charpos
= ZV
;
3472 it
->stop_charpos
= it
->end_charpos
;
3474 /* If next overlay change is in front of the current stop pos
3475 (which is IT->end_charpos), stop there. Note: value of
3476 next_overlay_change is point-max if no overlay change
3478 charpos
= IT_CHARPOS (*it
);
3479 bytepos
= IT_BYTEPOS (*it
);
3480 pos
= next_overlay_change (charpos
);
3481 if (pos
< it
->stop_charpos
)
3482 it
->stop_charpos
= pos
;
3484 /* Set up variables for computing the stop position from text
3485 property changes. */
3486 XSETBUFFER (object
, current_buffer
);
3487 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3490 /* Get the interval containing IT's position. Value is a null
3491 interval if there isn't such an interval. */
3492 position
= make_number (charpos
);
3493 iv
= validate_interval_range (object
, &position
, &position
, false);
3496 Lisp_Object values_here
[LAST_PROP_IDX
];
3499 /* Get properties here. */
3500 for (p
= it_props
; p
->handler
; ++p
)
3501 values_here
[p
->idx
] = textget (iv
->plist
,
3502 builtin_lisp_symbol (p
->name
));
3504 /* Look for an interval following iv that has different
3506 for (next_iv
= next_interval (iv
);
3509 || XFASTINT (limit
) > next_iv
->position
));
3510 next_iv
= next_interval (next_iv
))
3512 for (p
= it_props
; p
->handler
; ++p
)
3514 Lisp_Object new_value
= textget (next_iv
->plist
,
3515 builtin_lisp_symbol (p
->name
));
3516 if (!EQ (values_here
[p
->idx
], new_value
))
3526 if (INTEGERP (limit
)
3527 && next_iv
->position
>= XFASTINT (limit
))
3528 /* No text property change up to limit. */
3529 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3531 /* Text properties change in next_iv. */
3532 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3536 if (it
->cmp_it
.id
< 0)
3538 ptrdiff_t stoppos
= it
->end_charpos
;
3540 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3542 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3543 stoppos
, it
->string
);
3546 eassert (STRINGP (it
->string
)
3547 || (it
->stop_charpos
>= BEGV
3548 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3552 /* Return the position of the next overlay change after POS in
3553 current_buffer. Value is point-max if no overlay change
3554 follows. This is like `next-overlay-change' but doesn't use
3558 next_overlay_change (ptrdiff_t pos
)
3560 ptrdiff_t i
, noverlays
;
3562 Lisp_Object
*overlays
;
3565 /* Get all overlays at the given position. */
3566 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3568 /* If any of these overlays ends before endpos,
3569 use its ending point instead. */
3570 for (i
= 0; i
< noverlays
; ++i
)
3575 oend
= OVERLAY_END (overlays
[i
]);
3576 oendpos
= OVERLAY_POSITION (oend
);
3577 endpos
= min (endpos
, oendpos
);
3584 /* How many characters forward to search for a display property or
3585 display string. Searching too far forward makes the bidi display
3586 sluggish, especially in small windows. */
3587 #define MAX_DISP_SCAN 250
3589 /* Return the character position of a display string at or after
3590 position specified by POSITION. If no display string exists at or
3591 after POSITION, return ZV. A display string is either an overlay
3592 with `display' property whose value is a string, or a `display'
3593 text property whose value is a string. STRING is data about the
3594 string to iterate; if STRING->lstring is nil, we are iterating a
3595 buffer. FRAME_WINDOW_P is true when we are displaying a window
3596 on a GUI frame. DISP_PROP is set to zero if we searched
3597 MAX_DISP_SCAN characters forward without finding any display
3598 strings, non-zero otherwise. It is set to 2 if the display string
3599 uses any kind of `(space ...)' spec that will produce a stretch of
3600 white space in the text area. */
3602 compute_display_string_pos (struct text_pos
*position
,
3603 struct bidi_string_data
*string
,
3605 bool frame_window_p
, int *disp_prop
)
3607 /* OBJECT = nil means current buffer. */
3608 Lisp_Object object
, object1
;
3609 Lisp_Object pos
, spec
, limpos
;
3610 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3611 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3612 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3613 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3615 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3616 struct text_pos tpos
;
3619 if (string
&& STRINGP (string
->lstring
))
3620 object1
= object
= string
->lstring
;
3621 else if (w
&& !string_p
)
3623 XSETWINDOW (object
, w
);
3627 object1
= object
= Qnil
;
3632 /* We don't support display properties whose values are strings
3633 that have display string properties. */
3634 || string
->from_disp_str
3635 /* C strings cannot have display properties. */
3636 || (string
->s
&& !STRINGP (object
)))
3642 /* If the character at CHARPOS is where the display string begins,
3644 pos
= make_number (charpos
);
3645 if (STRINGP (object
))
3646 bufpos
= string
->bufpos
;
3650 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3652 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3655 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3663 /* Look forward for the first character with a `display' property
3664 that will replace the underlying text when displayed. */
3665 limpos
= make_number (lim
);
3667 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3668 CHARPOS (tpos
) = XFASTINT (pos
);
3669 if (CHARPOS (tpos
) >= lim
)
3674 if (STRINGP (object
))
3675 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3677 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3678 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3679 if (!STRINGP (object
))
3680 bufpos
= CHARPOS (tpos
);
3681 } while (NILP (spec
)
3682 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3683 bufpos
, frame_window_p
)));
3687 return CHARPOS (tpos
);
3690 /* Return the character position of the end of the display string that
3691 started at CHARPOS. If there's no display string at CHARPOS,
3692 return -1. A display string is either an overlay with `display'
3693 property whose value is a string or a `display' text property whose
3694 value is a string. */
3696 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3698 /* OBJECT = nil means current buffer. */
3699 Lisp_Object object
=
3700 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3701 Lisp_Object pos
= make_number (charpos
);
3703 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3705 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3708 /* It could happen that the display property or overlay was removed
3709 since we found it in compute_display_string_pos above. One way
3710 this can happen is if JIT font-lock was called (through
3711 handle_fontified_prop), and jit-lock-functions remove text
3712 properties or overlays from the portion of buffer that includes
3713 CHARPOS. Muse mode is known to do that, for example. In this
3714 case, we return -1 to the caller, to signal that no display
3715 string is actually present at CHARPOS. See bidi_fetch_char for
3716 how this is handled.
3718 An alternative would be to never look for display properties past
3719 it->stop_charpos. But neither compute_display_string_pos nor
3720 bidi_fetch_char that calls it know or care where the next
3722 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3725 /* Look forward for the first character where the `display' property
3727 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3729 return XFASTINT (pos
);
3734 /***********************************************************************
3736 ***********************************************************************/
3738 /* Handle changes in the `fontified' property of the current buffer by
3739 calling hook functions from Qfontification_functions to fontify
3742 static enum prop_handled
3743 handle_fontified_prop (struct it
*it
)
3745 Lisp_Object prop
, pos
;
3746 enum prop_handled handled
= HANDLED_NORMALLY
;
3748 if (!NILP (Vmemory_full
))
3751 /* Get the value of the `fontified' property at IT's current buffer
3752 position. (The `fontified' property doesn't have a special
3753 meaning in strings.) If the value is nil, call functions from
3754 Qfontification_functions. */
3755 if (!STRINGP (it
->string
)
3757 && !NILP (Vfontification_functions
)
3758 && !NILP (Vrun_hooks
)
3759 && (pos
= make_number (IT_CHARPOS (*it
)),
3760 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3761 /* Ignore the special cased nil value always present at EOB since
3762 no amount of fontifying will be able to change it. */
3763 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3765 ptrdiff_t count
= SPECPDL_INDEX ();
3767 struct buffer
*obuf
= current_buffer
;
3768 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3769 bool old_clip_changed
= current_buffer
->clip_changed
;
3771 val
= Vfontification_functions
;
3772 specbind (Qfontification_functions
, Qnil
);
3774 eassert (it
->end_charpos
== ZV
);
3776 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3777 safe_call1 (val
, pos
);
3780 Lisp_Object fns
, fn
;
3784 for (; CONSP (val
); val
= XCDR (val
))
3790 /* A value of t indicates this hook has a local
3791 binding; it means to run the global binding too.
3792 In a global value, t should not occur. If it
3793 does, we must ignore it to avoid an endless
3795 for (fns
= Fdefault_value (Qfontification_functions
);
3801 safe_call1 (fn
, pos
);
3805 safe_call1 (fn
, pos
);
3809 unbind_to (count
, Qnil
);
3811 /* Fontification functions routinely call `save-restriction'.
3812 Normally, this tags clip_changed, which can confuse redisplay
3813 (see discussion in Bug#6671). Since we don't perform any
3814 special handling of fontification changes in the case where
3815 `save-restriction' isn't called, there's no point doing so in
3816 this case either. So, if the buffer's restrictions are
3817 actually left unchanged, reset clip_changed. */
3818 if (obuf
== current_buffer
)
3820 if (begv
== BEGV
&& zv
== ZV
)
3821 current_buffer
->clip_changed
= old_clip_changed
;
3823 /* There isn't much we can reasonably do to protect against
3824 misbehaving fontification, but here's a fig leaf. */
3825 else if (BUFFER_LIVE_P (obuf
))
3826 set_buffer_internal_1 (obuf
);
3828 /* The fontification code may have added/removed text.
3829 It could do even a lot worse, but let's at least protect against
3830 the most obvious case where only the text past `pos' gets changed',
3831 as is/was done in grep.el where some escapes sequences are turned
3832 into face properties (bug#7876). */
3833 it
->end_charpos
= ZV
;
3835 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3836 something. This avoids an endless loop if they failed to
3837 fontify the text for which reason ever. */
3838 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3839 handled
= HANDLED_RECOMPUTE_PROPS
;
3847 /***********************************************************************
3849 ***********************************************************************/
3851 /* Set up iterator IT from face properties at its current position.
3852 Called from handle_stop. */
3854 static enum prop_handled
3855 handle_face_prop (struct it
*it
)
3858 ptrdiff_t next_stop
;
3860 if (!STRINGP (it
->string
))
3863 = face_at_buffer_position (it
->w
,
3867 + TEXT_PROP_DISTANCE_LIMIT
),
3868 false, it
->base_face_id
);
3870 /* Is this a start of a run of characters with box face?
3871 Caveat: this can be called for a freshly initialized
3872 iterator; face_id is -1 in this case. We know that the new
3873 face will not change until limit, i.e. if the new face has a
3874 box, all characters up to limit will have one. But, as
3875 usual, we don't know whether limit is really the end. */
3876 if (new_face_id
!= it
->face_id
)
3878 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3879 /* If it->face_id is -1, old_face below will be NULL, see
3880 the definition of FACE_FROM_ID. This will happen if this
3881 is the initial call that gets the face. */
3882 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3884 /* If the value of face_id of the iterator is -1, we have to
3885 look in front of IT's position and see whether there is a
3886 face there that's different from new_face_id. */
3887 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3889 int prev_face_id
= face_before_it_pos (it
);
3891 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3894 /* If the new face has a box, but the old face does not,
3895 this is the start of a run of characters with box face,
3896 i.e. this character has a shadow on the left side. */
3897 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3898 && (old_face
== NULL
|| !old_face
->box
));
3899 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3907 Lisp_Object from_overlay
3908 = (it
->current
.overlay_string_index
>= 0
3909 ? it
->string_overlays
[it
->current
.overlay_string_index
3910 % OVERLAY_STRING_CHUNK_SIZE
]
3913 /* See if we got to this string directly or indirectly from
3914 an overlay property. That includes the before-string or
3915 after-string of an overlay, strings in display properties
3916 provided by an overlay, their text properties, etc.
3918 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3919 if (! NILP (from_overlay
))
3920 for (i
= it
->sp
- 1; i
>= 0; i
--)
3922 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3924 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3925 % OVERLAY_STRING_CHUNK_SIZE
];
3926 else if (! NILP (it
->stack
[i
].from_overlay
))
3927 from_overlay
= it
->stack
[i
].from_overlay
;
3929 if (!NILP (from_overlay
))
3933 if (! NILP (from_overlay
))
3935 bufpos
= IT_CHARPOS (*it
);
3936 /* For a string from an overlay, the base face depends
3937 only on text properties and ignores overlays. */
3939 = face_for_overlay_string (it
->w
,
3943 + TEXT_PROP_DISTANCE_LIMIT
),
3951 /* For strings from a `display' property, use the face at
3952 IT's current buffer position as the base face to merge
3953 with, so that overlay strings appear in the same face as
3954 surrounding text, unless they specify their own faces.
3955 For strings from wrap-prefix and line-prefix properties,
3956 use the default face, possibly remapped via
3957 Vface_remapping_alist. */
3958 /* Note that the fact that we use the face at _buffer_
3959 position means that a 'display' property on an overlay
3960 string will not inherit the face of that overlay string,
3961 but will instead revert to the face of buffer text
3962 covered by the overlay. This is visible, e.g., when the
3963 overlay specifies a box face, but neither the buffer nor
3964 the display string do. This sounds like a design bug,
3965 but Emacs always did that since v21.1, so changing that
3966 might be a big deal. */
3967 base_face_id
= it
->string_from_prefix_prop_p
3968 ? (!NILP (Vface_remapping_alist
)
3969 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3971 : underlying_face_id (it
);
3974 new_face_id
= face_at_string_position (it
->w
,
3976 IT_STRING_CHARPOS (*it
),
3979 base_face_id
, false);
3981 /* Is this a start of a run of characters with box? Caveat:
3982 this can be called for a freshly allocated iterator; face_id
3983 is -1 is this case. We know that the new face will not
3984 change until the next check pos, i.e. if the new face has a
3985 box, all characters up to that position will have a
3986 box. But, as usual, we don't know whether that position
3987 is really the end. */
3988 if (new_face_id
!= it
->face_id
)
3990 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3991 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3993 /* If new face has a box but old face hasn't, this is the
3994 start of a run of characters with box, i.e. it has a
3995 shadow on the left side. */
3996 it
->start_of_box_run_p
3997 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3998 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4002 it
->face_id
= new_face_id
;
4003 return HANDLED_NORMALLY
;
4007 /* Return the ID of the face ``underlying'' IT's current position,
4008 which is in a string. If the iterator is associated with a
4009 buffer, return the face at IT's current buffer position.
4010 Otherwise, use the iterator's base_face_id. */
4013 underlying_face_id (struct it
*it
)
4015 int face_id
= it
->base_face_id
, i
;
4017 eassert (STRINGP (it
->string
));
4019 for (i
= it
->sp
- 1; i
>= 0; --i
)
4020 if (NILP (it
->stack
[i
].string
))
4021 face_id
= it
->stack
[i
].face_id
;
4027 /* Compute the face one character before or after the current position
4028 of IT, in the visual order. BEFORE_P means get the face
4029 in front (to the left in L2R paragraphs, to the right in R2L
4030 paragraphs) of IT's screen position. Value is the ID of the face. */
4033 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4036 ptrdiff_t next_check_charpos
;
4038 void *it_copy_data
= NULL
;
4040 eassert (it
->s
== NULL
);
4042 if (STRINGP (it
->string
))
4044 ptrdiff_t bufpos
, charpos
;
4047 /* No face change past the end of the string (for the case
4048 we are padding with spaces). No face change before the
4050 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4051 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4056 /* Set charpos to the position before or after IT's current
4057 position, in the logical order, which in the non-bidi
4058 case is the same as the visual order. */
4060 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4061 else if (it
->what
== IT_COMPOSITION
)
4062 /* For composition, we must check the character after the
4064 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4066 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4072 /* With bidi iteration, the character before the current
4073 in the visual order cannot be found by simple
4074 iteration, because "reverse" reordering is not
4075 supported. Instead, we need to start from the string
4076 beginning and go all the way to the current string
4077 position, remembering the previous position. */
4078 /* Ignore face changes before the first visible
4079 character on this display line. */
4080 if (it
->current_x
<= it
->first_visible_x
)
4082 SAVE_IT (it_copy
, *it
, it_copy_data
);
4083 IT_STRING_CHARPOS (it_copy
) = 0;
4084 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 if (charpos
>= SCHARS (it
->string
))
4091 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4093 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4095 RESTORE_IT (it
, it
, it_copy_data
);
4099 /* Set charpos to the string position of the character
4100 that comes after IT's current position in the visual
4102 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4106 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4108 charpos
= it_copy
.bidi_it
.charpos
;
4111 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4113 if (it
->current
.overlay_string_index
>= 0)
4114 bufpos
= IT_CHARPOS (*it
);
4118 base_face_id
= underlying_face_id (it
);
4120 /* Get the face for ASCII, or unibyte. */
4121 face_id
= face_at_string_position (it
->w
,
4125 &next_check_charpos
,
4126 base_face_id
, false);
4128 /* Correct the face for charsets different from ASCII. Do it
4129 for the multibyte case only. The face returned above is
4130 suitable for unibyte text if IT->string is unibyte. */
4131 if (STRING_MULTIBYTE (it
->string
))
4133 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4134 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4136 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4138 c
= string_char_and_length (p
, &len
);
4139 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4144 struct text_pos pos
;
4146 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4147 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4150 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4151 pos
= it
->current
.pos
;
4156 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4159 if (it
->what
== IT_COMPOSITION
)
4161 /* For composition, we must check the position after
4163 pos
.charpos
+= it
->cmp_it
.nchars
;
4164 pos
.bytepos
+= it
->len
;
4167 INC_TEXT_POS (pos
, it
->multibyte_p
);
4176 /* With bidi iteration, the character before the current
4177 in the visual order cannot be found by simple
4178 iteration, because "reverse" reordering is not
4179 supported. Instead, we need to use the move_it_*
4180 family of functions, and move to the previous
4181 character starting from the beginning of the visual
4183 /* Ignore face changes before the first visible
4184 character on this display line. */
4185 if (it
->current_x
<= it
->first_visible_x
)
4187 SAVE_IT (it_copy
, *it
, it_copy_data
);
4188 /* Implementation note: Since move_it_in_display_line
4189 works in the iterator geometry, and thinks the first
4190 character is always the leftmost, even in R2L lines,
4191 we don't need to distinguish between the R2L and L2R
4193 current_x
= it_copy
.current_x
;
4194 move_it_vertically_backward (&it_copy
, 0);
4195 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4196 pos
= it_copy
.current
.pos
;
4197 RESTORE_IT (it
, it
, it_copy_data
);
4201 /* Set charpos to the buffer position of the character
4202 that comes after IT's current position in the visual
4204 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4208 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4211 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4214 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4216 /* Determine face for CHARSET_ASCII, or unibyte. */
4217 face_id
= face_at_buffer_position (it
->w
,
4219 &next_check_charpos
,
4222 /* Correct the face for charsets different from ASCII. Do it
4223 for the multibyte case only. The face returned above is
4224 suitable for unibyte text if current_buffer is unibyte. */
4225 if (it
->multibyte_p
)
4227 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4228 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4229 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from invisible properties at its current
4243 position. Called from handle_stop. */
4245 static enum prop_handled
4246 handle_invisible_prop (struct it
*it
)
4248 enum prop_handled handled
= HANDLED_NORMALLY
;
4252 if (STRINGP (it
->string
))
4254 Lisp_Object end_charpos
, limit
;
4256 /* Get the value of the invisible text property at the
4257 current position. Value will be nil if there is no such
4259 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4260 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4261 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4263 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4265 /* Record whether we have to display an ellipsis for the
4267 bool display_ellipsis_p
= (invis
== 2);
4268 ptrdiff_t len
, endpos
;
4270 handled
= HANDLED_RECOMPUTE_PROPS
;
4272 /* Get the position at which the next visible text can be
4273 found in IT->string, if any. */
4274 endpos
= len
= SCHARS (it
->string
);
4275 XSETINT (limit
, len
);
4279 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4281 /* Since LIMIT is always an integer, so should be the
4282 value returned by Fnext_single_property_change. */
4283 eassert (INTEGERP (end_charpos
));
4284 if (INTEGERP (end_charpos
))
4286 endpos
= XFASTINT (end_charpos
);
4287 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4288 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4290 display_ellipsis_p
= true;
4292 else /* Should never happen; but if it does, exit the loop. */
4295 while (invis
!= 0 && endpos
< len
);
4297 if (display_ellipsis_p
)
4298 it
->ellipsis_p
= true;
4302 /* Text at END_CHARPOS is visible. Move IT there. */
4303 struct text_pos old
;
4306 old
= it
->current
.string_pos
;
4307 oldpos
= CHARPOS (old
);
4310 if (it
->bidi_it
.first_elt
4311 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4312 bidi_paragraph_init (it
->paragraph_embedding
,
4313 &it
->bidi_it
, true);
4314 /* Bidi-iterate out of the invisible text. */
4317 bidi_move_to_visually_next (&it
->bidi_it
);
4319 while (oldpos
<= it
->bidi_it
.charpos
4320 && it
->bidi_it
.charpos
< endpos
);
4322 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4323 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4324 if (IT_CHARPOS (*it
) >= endpos
)
4325 it
->prev_stop
= endpos
;
4329 IT_STRING_CHARPOS (*it
) = endpos
;
4330 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4335 /* The rest of the string is invisible. If this is an
4336 overlay string, proceed with the next overlay string
4337 or whatever comes and return a character from there. */
4338 if (it
->current
.overlay_string_index
>= 0
4339 && !display_ellipsis_p
)
4341 next_overlay_string (it
);
4342 /* Don't check for overlay strings when we just
4343 finished processing them. */
4344 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4348 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4349 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4356 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4357 Lisp_Object pos
, overlay
;
4359 /* First of all, is there invisible text at this position? */
4360 tem
= start_charpos
= IT_CHARPOS (*it
);
4361 pos
= make_number (tem
);
4362 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4364 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4366 /* If we are on invisible text, skip over it. */
4367 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 bool display_ellipsis_p
= invis
== 2;
4373 handled
= HANDLED_RECOMPUTE_PROPS
;
4375 /* Loop skipping over invisible text. The loop is left at
4376 ZV or with IT on the first char being visible again. */
4379 /* Try to skip some invisible text. Return value is the
4380 position reached which can be equal to where we start
4381 if there is nothing invisible there. This skips both
4382 over invisible text properties and overlays with
4383 invisible property. */
4384 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4386 /* If we skipped nothing at all we weren't at invisible
4387 text in the first place. If everything to the end of
4388 the buffer was skipped, end the loop. */
4389 if (newpos
== tem
|| newpos
>= ZV
)
4393 /* We skipped some characters but not necessarily
4394 all there are. Check if we ended up on visible
4395 text. Fget_char_property returns the property of
4396 the char before the given position, i.e. if we
4397 get invis = 0, this means that the char at
4398 newpos is visible. */
4399 pos
= make_number (newpos
);
4400 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4401 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4404 /* If we ended up on invisible text, proceed to
4405 skip starting with next_stop. */
4409 /* If there are adjacent invisible texts, don't lose the
4410 second one's ellipsis. */
4412 display_ellipsis_p
= true;
4416 /* The position newpos is now either ZV or on visible text. */
4419 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4421 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4423 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4425 /* If the invisible text ends on a newline or on a
4426 character after a newline, we can avoid the costly,
4427 character by character, bidi iteration to NEWPOS, and
4428 instead simply reseat the iterator there. That's
4429 because all bidi reordering information is tossed at
4430 the newline. This is a big win for modes that hide
4431 complete lines, like Outline, Org, etc. */
4432 if (on_newline
|| after_newline
)
4434 struct text_pos tpos
;
4435 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4437 SET_TEXT_POS (tpos
, newpos
, bpos
);
4438 reseat_1 (it
, tpos
, false);
4439 /* If we reseat on a newline/ZV, we need to prep the
4440 bidi iterator for advancing to the next character
4441 after the newline/EOB, keeping the current paragraph
4442 direction (so that PRODUCE_GLYPHS does TRT wrt
4443 prepending/appending glyphs to a glyph row). */
4446 it
->bidi_it
.first_elt
= false;
4447 it
->bidi_it
.paragraph_dir
= pdir
;
4448 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4449 it
->bidi_it
.nchars
= 1;
4450 it
->bidi_it
.ch_len
= 1;
4453 else /* Must use the slow method. */
4455 /* With bidi iteration, the region of invisible text
4456 could start and/or end in the middle of a
4457 non-base embedding level. Therefore, we need to
4458 skip invisible text using the bidi iterator,
4459 starting at IT's current position, until we find
4460 ourselves outside of the invisible text.
4461 Skipping invisible text _after_ bidi iteration
4462 avoids affecting the visual order of the
4463 displayed text when invisible properties are
4464 added or removed. */
4465 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4467 /* If we were `reseat'ed to a new paragraph,
4468 determine the paragraph base direction. We
4469 need to do it now because
4470 next_element_from_buffer may not have a
4471 chance to do it, if we are going to skip any
4472 text at the beginning, which resets the
4474 bidi_paragraph_init (it
->paragraph_embedding
,
4475 &it
->bidi_it
, true);
4479 bidi_move_to_visually_next (&it
->bidi_it
);
4481 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4482 && it
->bidi_it
.charpos
< newpos
);
4483 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4484 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4485 /* If we overstepped NEWPOS, record its position in
4486 the iterator, so that we skip invisible text if
4487 later the bidi iteration lands us in the
4488 invisible region again. */
4489 if (IT_CHARPOS (*it
) >= newpos
)
4490 it
->prev_stop
= newpos
;
4495 IT_CHARPOS (*it
) = newpos
;
4496 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4499 if (display_ellipsis_p
)
4501 /* Make sure that the glyphs of the ellipsis will get
4502 correct `charpos' values. If we would not update
4503 it->position here, the glyphs would belong to the
4504 last visible character _before_ the invisible
4505 text, which confuses `set_cursor_from_row'.
4507 We use the last invisible position instead of the
4508 first because this way the cursor is always drawn on
4509 the first "." of the ellipsis, whenever PT is inside
4510 the invisible text. Otherwise the cursor would be
4511 placed _after_ the ellipsis when the point is after the
4512 first invisible character. */
4513 if (!STRINGP (it
->object
))
4515 it
->position
.charpos
= newpos
- 1;
4516 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4520 /* If there are before-strings at the start of invisible
4521 text, and the text is invisible because of a text
4522 property, arrange to show before-strings because 20.x did
4523 it that way. (If the text is invisible because of an
4524 overlay property instead of a text property, this is
4525 already handled in the overlay code.) */
4527 && get_overlay_strings (it
, it
->stop_charpos
))
4529 handled
= HANDLED_RECOMPUTE_PROPS
;
4532 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4533 /* The call to get_overlay_strings above recomputes
4534 it->stop_charpos, but it only considers changes
4535 in properties and overlays beyond iterator's
4536 current position. This causes us to miss changes
4537 that happen exactly where the invisible property
4538 ended. So we play it safe here and force the
4539 iterator to check for potential stop positions
4540 immediately after the invisible text. Note that
4541 if get_overlay_strings returns true, it
4542 normally also pushed the iterator stack, so we
4543 need to update the stop position in the slot
4544 below the current one. */
4545 it
->stack
[it
->sp
- 1].stop_charpos
4546 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4549 else if (display_ellipsis_p
)
4551 it
->ellipsis_p
= true;
4552 /* Let the ellipsis display before
4553 considering any properties of the following char.
4554 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4555 handled
= HANDLED_RETURN
;
4564 /* Make iterator IT return `...' next.
4565 Replaces LEN characters from buffer. */
4568 setup_for_ellipsis (struct it
*it
, int len
)
4570 /* Use the display table definition for `...'. Invalid glyphs
4571 will be handled by the method returning elements from dpvec. */
4572 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4574 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4575 it
->dpvec
= v
->contents
;
4576 it
->dpend
= v
->contents
+ v
->header
.size
;
4580 /* Default `...'. */
4581 it
->dpvec
= default_invis_vector
;
4582 it
->dpend
= default_invis_vector
+ 3;
4585 it
->dpvec_char_len
= len
;
4586 it
->current
.dpvec_index
= 0;
4587 it
->dpvec_face_id
= -1;
4589 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4590 face as the preceding text. IT->saved_face_id was set in
4591 handle_stop to the face of the preceding character, and will be
4592 different from IT->face_id only if the invisible text skipped in
4593 handle_invisible_prop has some non-default face on its first
4594 character. We thus ignore the face of the invisible text when we
4595 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4596 if (it
->saved_face_id
>= 0)
4597 it
->face_id
= it
->saved_face_id
;
4599 /* If the ellipsis represents buffer text, it means we advanced in
4600 the buffer, so we should no longer ignore overlay strings. */
4601 if (it
->method
== GET_FROM_BUFFER
)
4602 it
->ignore_overlay_strings_at_pos_p
= false;
4604 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4605 it
->ellipsis_p
= true;
4610 /***********************************************************************
4612 ***********************************************************************/
4614 /* Set up iterator IT from `display' property at its current position.
4615 Called from handle_stop.
4616 We return HANDLED_RETURN if some part of the display property
4617 overrides the display of the buffer text itself.
4618 Otherwise we return HANDLED_NORMALLY. */
4620 static enum prop_handled
4621 handle_display_prop (struct it
*it
)
4623 Lisp_Object propval
, object
, overlay
;
4624 struct text_pos
*position
;
4626 /* Nonzero if some property replaces the display of the text itself. */
4627 int display_replaced
= 0;
4629 if (STRINGP (it
->string
))
4631 object
= it
->string
;
4632 position
= &it
->current
.string_pos
;
4633 bufpos
= CHARPOS (it
->current
.pos
);
4637 XSETWINDOW (object
, it
->w
);
4638 position
= &it
->current
.pos
;
4639 bufpos
= CHARPOS (*position
);
4642 /* Reset those iterator values set from display property values. */
4643 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4644 it
->space_width
= Qnil
;
4645 it
->font_height
= Qnil
;
4648 /* We don't support recursive `display' properties, i.e. string
4649 values that have a string `display' property, that have a string
4650 `display' property etc. */
4651 if (!it
->string_from_display_prop_p
)
4652 it
->area
= TEXT_AREA
;
4654 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4655 Qdisplay
, object
, &overlay
);
4657 return HANDLED_NORMALLY
;
4658 /* Now OVERLAY is the overlay that gave us this property, or nil
4659 if it was a text property. */
4661 if (!STRINGP (it
->string
))
4662 object
= it
->w
->contents
;
4664 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4666 FRAME_WINDOW_P (it
->f
));
4667 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4670 /* Subroutine of handle_display_prop. Returns non-zero if the display
4671 specification in SPEC is a replacing specification, i.e. it would
4672 replace the text covered by `display' property with something else,
4673 such as an image or a display string. If SPEC includes any kind or
4674 `(space ...) specification, the value is 2; this is used by
4675 compute_display_string_pos, which see.
4677 See handle_single_display_spec for documentation of arguments.
4678 FRAME_WINDOW_P is true if the window being redisplayed is on a
4679 GUI frame; this argument is used only if IT is NULL, see below.
4681 IT can be NULL, if this is called by the bidi reordering code
4682 through compute_display_string_pos, which see. In that case, this
4683 function only examines SPEC, but does not otherwise "handle" it, in
4684 the sense that it doesn't set up members of IT from the display
4687 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4688 Lisp_Object overlay
, struct text_pos
*position
,
4689 ptrdiff_t bufpos
, bool frame_window_p
)
4694 /* Simple specifications. */
4695 && !EQ (XCAR (spec
), Qimage
)
4696 #ifdef HAVE_XWIDGETS
4697 && !EQ (XCAR (spec
), Qxwidget
)
4699 && !EQ (XCAR (spec
), Qspace
)
4700 && !EQ (XCAR (spec
), Qwhen
)
4701 && !EQ (XCAR (spec
), Qslice
)
4702 && !EQ (XCAR (spec
), Qspace_width
)
4703 && !EQ (XCAR (spec
), Qheight
)
4704 && !EQ (XCAR (spec
), Qraise
)
4705 /* Marginal area specifications. */
4706 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4707 && !EQ (XCAR (spec
), Qleft_fringe
)
4708 && !EQ (XCAR (spec
), Qright_fringe
)
4709 && !NILP (XCAR (spec
)))
4711 for (; CONSP (spec
); spec
= XCDR (spec
))
4713 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4714 overlay
, position
, bufpos
,
4715 replacing
, frame_window_p
);
4719 /* If some text in a string is replaced, `position' no
4720 longer points to the position of `object'. */
4721 if (!it
|| STRINGP (object
))
4726 else if (VECTORP (spec
))
4729 for (i
= 0; i
< ASIZE (spec
); ++i
)
4731 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4732 overlay
, position
, bufpos
,
4733 replacing
, frame_window_p
);
4737 /* If some text in a string is replaced, `position' no
4738 longer points to the position of `object'. */
4739 if (!it
|| STRINGP (object
))
4745 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4746 bufpos
, 0, frame_window_p
);
4750 /* Value is the position of the end of the `display' property starting
4751 at START_POS in OBJECT. */
4753 static struct text_pos
4754 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4757 struct text_pos end_pos
;
4759 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4760 Qdisplay
, object
, Qnil
);
4761 CHARPOS (end_pos
) = XFASTINT (end
);
4762 if (STRINGP (object
))
4763 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4765 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4771 /* Set up IT from a single `display' property specification SPEC. OBJECT
4772 is the object in which the `display' property was found. *POSITION
4773 is the position in OBJECT at which the `display' property was found.
4774 BUFPOS is the buffer position of OBJECT (different from POSITION if
4775 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4776 previously saw a display specification which already replaced text
4777 display with something else, for example an image; we ignore such
4778 properties after the first one has been processed.
4780 OVERLAY is the overlay this `display' property came from,
4781 or nil if it was a text property.
4783 If SPEC is a `space' or `image' specification, and in some other
4784 cases too, set *POSITION to the position where the `display'
4787 If IT is NULL, only examine the property specification in SPEC, but
4788 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4789 is intended to be displayed in a window on a GUI frame.
4791 Value is non-zero if something was found which replaces the display
4792 of buffer or string text. */
4795 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4796 Lisp_Object overlay
, struct text_pos
*position
,
4797 ptrdiff_t bufpos
, int display_replaced
,
4798 bool frame_window_p
)
4801 Lisp_Object location
, value
;
4802 struct text_pos start_pos
= *position
;
4804 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4805 If the result is non-nil, use VALUE instead of SPEC. */
4807 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4816 if (!NILP (form
) && !EQ (form
, Qt
))
4818 ptrdiff_t count
= SPECPDL_INDEX ();
4820 /* Bind `object' to the object having the `display' property, a
4821 buffer or string. Bind `position' to the position in the
4822 object where the property was found, and `buffer-position'
4823 to the current position in the buffer. */
4826 XSETBUFFER (object
, current_buffer
);
4827 specbind (Qobject
, object
);
4828 specbind (Qposition
, make_number (CHARPOS (*position
)));
4829 specbind (Qbuffer_position
, make_number (bufpos
));
4830 form
= safe_eval (form
);
4831 unbind_to (count
, Qnil
);
4837 /* Handle `(height HEIGHT)' specifications. */
4839 && EQ (XCAR (spec
), Qheight
)
4840 && CONSP (XCDR (spec
)))
4844 if (!FRAME_WINDOW_P (it
->f
))
4847 it
->font_height
= XCAR (XCDR (spec
));
4848 if (!NILP (it
->font_height
))
4850 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4851 int new_height
= -1;
4853 if (CONSP (it
->font_height
)
4854 && (EQ (XCAR (it
->font_height
), Qplus
)
4855 || EQ (XCAR (it
->font_height
), Qminus
))
4856 && CONSP (XCDR (it
->font_height
))
4857 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4859 /* `(+ N)' or `(- N)' where N is an integer. */
4860 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4861 if (EQ (XCAR (it
->font_height
), Qplus
))
4863 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4865 else if (FUNCTIONP (it
->font_height
))
4867 /* Call function with current height as argument.
4868 Value is the new height. */
4870 height
= safe_call1 (it
->font_height
,
4871 face
->lface
[LFACE_HEIGHT_INDEX
]);
4872 if (NUMBERP (height
))
4873 new_height
= XFLOATINT (height
);
4875 else if (NUMBERP (it
->font_height
))
4877 /* Value is a multiple of the canonical char height. */
4880 f
= FACE_FROM_ID (it
->f
,
4881 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4882 new_height
= (XFLOATINT (it
->font_height
)
4883 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4887 /* Evaluate IT->font_height with `height' bound to the
4888 current specified height to get the new height. */
4889 ptrdiff_t count
= SPECPDL_INDEX ();
4891 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4892 value
= safe_eval (it
->font_height
);
4893 unbind_to (count
, Qnil
);
4895 if (NUMBERP (value
))
4896 new_height
= XFLOATINT (value
);
4900 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4907 /* Handle `(space-width WIDTH)'. */
4909 && EQ (XCAR (spec
), Qspace_width
)
4910 && CONSP (XCDR (spec
)))
4914 if (!FRAME_WINDOW_P (it
->f
))
4917 value
= XCAR (XCDR (spec
));
4918 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4919 it
->space_width
= value
;
4925 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4927 && EQ (XCAR (spec
), Qslice
))
4933 if (!FRAME_WINDOW_P (it
->f
))
4936 if (tem
= XCDR (spec
), CONSP (tem
))
4938 it
->slice
.x
= XCAR (tem
);
4939 if (tem
= XCDR (tem
), CONSP (tem
))
4941 it
->slice
.y
= XCAR (tem
);
4942 if (tem
= XCDR (tem
), CONSP (tem
))
4944 it
->slice
.width
= XCAR (tem
);
4945 if (tem
= XCDR (tem
), CONSP (tem
))
4946 it
->slice
.height
= XCAR (tem
);
4955 /* Handle `(raise FACTOR)'. */
4957 && EQ (XCAR (spec
), Qraise
)
4958 && CONSP (XCDR (spec
)))
4962 if (!FRAME_WINDOW_P (it
->f
))
4965 #ifdef HAVE_WINDOW_SYSTEM
4966 value
= XCAR (XCDR (spec
));
4967 if (NUMBERP (value
))
4969 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4970 it
->voffset
= - (XFLOATINT (value
)
4971 * (normal_char_height (face
->font
, -1)));
4973 #endif /* HAVE_WINDOW_SYSTEM */
4979 /* Don't handle the other kinds of display specifications
4980 inside a string that we got from a `display' property. */
4981 if (it
&& it
->string_from_display_prop_p
)
4984 /* Characters having this form of property are not displayed, so
4985 we have to find the end of the property. */
4988 start_pos
= *position
;
4989 *position
= display_prop_end (it
, object
, start_pos
);
4990 /* If the display property comes from an overlay, don't consider
4991 any potential stop_charpos values before the end of that
4992 overlay. Since display_prop_end will happily find another
4993 'display' property coming from some other overlay or text
4994 property on buffer positions before this overlay's end, we
4995 need to ignore them, or else we risk displaying this
4996 overlay's display string/image twice. */
4997 if (!NILP (overlay
))
4999 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5001 if (ovendpos
> CHARPOS (*position
))
5002 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
5007 /* Stop the scan at that end position--we assume that all
5008 text properties change there. */
5010 it
->stop_charpos
= position
->charpos
;
5012 /* Handle `(left-fringe BITMAP [FACE])'
5013 and `(right-fringe BITMAP [FACE])'. */
5015 && (EQ (XCAR (spec
), Qleft_fringe
)
5016 || EQ (XCAR (spec
), Qright_fringe
))
5017 && CONSP (XCDR (spec
)))
5023 if (!FRAME_WINDOW_P (it
->f
))
5024 /* If we return here, POSITION has been advanced
5025 across the text with this property. */
5027 /* Synchronize the bidi iterator with POSITION. This is
5028 needed because we are not going to push the iterator
5029 on behalf of this display property, so there will be
5030 no pop_it call to do this synchronization for us. */
5033 it
->position
= *position
;
5034 iterate_out_of_display_property (it
);
5035 *position
= it
->position
;
5040 else if (!frame_window_p
)
5043 #ifdef HAVE_WINDOW_SYSTEM
5044 value
= XCAR (XCDR (spec
));
5045 if (!SYMBOLP (value
)
5046 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5047 /* If we return here, POSITION has been advanced
5048 across the text with this property. */
5050 if (it
&& it
->bidi_p
)
5052 it
->position
= *position
;
5053 iterate_out_of_display_property (it
);
5054 *position
= it
->position
;
5061 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5063 if (CONSP (XCDR (XCDR (spec
))))
5065 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5066 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5067 FRINGE_FACE_ID
, false);
5072 /* Save current settings of IT so that we can restore them
5073 when we are finished with the glyph property value. */
5074 push_it (it
, position
);
5076 it
->area
= TEXT_AREA
;
5077 it
->what
= IT_IMAGE
;
5078 it
->image_id
= -1; /* no image */
5079 it
->position
= start_pos
;
5080 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5081 it
->method
= GET_FROM_IMAGE
;
5082 it
->from_overlay
= Qnil
;
5083 it
->face_id
= face_id
;
5084 it
->from_disp_prop_p
= true;
5086 /* Say that we haven't consumed the characters with
5087 `display' property yet. The call to pop_it in
5088 set_iterator_to_next will clean this up. */
5089 *position
= start_pos
;
5091 if (EQ (XCAR (spec
), Qleft_fringe
))
5093 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5094 it
->left_user_fringe_face_id
= face_id
;
5098 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5099 it
->right_user_fringe_face_id
= face_id
;
5102 #endif /* HAVE_WINDOW_SYSTEM */
5106 /* Prepare to handle `((margin left-margin) ...)',
5107 `((margin right-margin) ...)' and `((margin nil) ...)'
5108 prefixes for display specifications. */
5109 location
= Qunbound
;
5110 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5114 value
= XCDR (spec
);
5116 value
= XCAR (value
);
5119 if (EQ (XCAR (tem
), Qmargin
)
5120 && (tem
= XCDR (tem
),
5121 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5123 || EQ (tem
, Qleft_margin
)
5124 || EQ (tem
, Qright_margin
))))
5128 if (EQ (location
, Qunbound
))
5134 /* After this point, VALUE is the property after any
5135 margin prefix has been stripped. It must be a string,
5136 an image specification, or `(space ...)'.
5138 LOCATION specifies where to display: `left-margin',
5139 `right-margin' or nil. */
5141 bool valid_p
= (STRINGP (value
)
5142 #ifdef HAVE_WINDOW_SYSTEM
5143 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5144 && valid_image_p (value
))
5145 #endif /* not HAVE_WINDOW_SYSTEM */
5146 || (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5147 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5148 && valid_xwidget_spec_p (value
)));
5150 if (valid_p
&& display_replaced
== 0)
5156 /* Callers need to know whether the display spec is any kind
5157 of `(space ...)' spec that is about to affect text-area
5159 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5164 /* Save current settings of IT so that we can restore them
5165 when we are finished with the glyph property value. */
5166 push_it (it
, position
);
5167 it
->from_overlay
= overlay
;
5168 it
->from_disp_prop_p
= true;
5170 if (NILP (location
))
5171 it
->area
= TEXT_AREA
;
5172 else if (EQ (location
, Qleft_margin
))
5173 it
->area
= LEFT_MARGIN_AREA
;
5175 it
->area
= RIGHT_MARGIN_AREA
;
5177 if (STRINGP (value
))
5180 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5181 it
->current
.overlay_string_index
= -1;
5182 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5183 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5184 it
->method
= GET_FROM_STRING
;
5185 it
->stop_charpos
= 0;
5187 it
->base_level_stop
= 0;
5188 it
->string_from_display_prop_p
= true;
5189 /* Say that we haven't consumed the characters with
5190 `display' property yet. The call to pop_it in
5191 set_iterator_to_next will clean this up. */
5192 if (BUFFERP (object
))
5193 *position
= start_pos
;
5195 /* Force paragraph direction to be that of the parent
5196 object. If the parent object's paragraph direction is
5197 not yet determined, default to L2R. */
5198 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5199 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5201 it
->paragraph_embedding
= L2R
;
5203 /* Set up the bidi iterator for this display string. */
5206 it
->bidi_it
.string
.lstring
= it
->string
;
5207 it
->bidi_it
.string
.s
= NULL
;
5208 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5209 it
->bidi_it
.string
.bufpos
= bufpos
;
5210 it
->bidi_it
.string
.from_disp_str
= true;
5211 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5212 it
->bidi_it
.w
= it
->w
;
5213 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5216 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5218 it
->method
= GET_FROM_STRETCH
;
5220 *position
= it
->position
= start_pos
;
5221 retval
= 1 + (it
->area
== TEXT_AREA
);
5223 else if (valid_xwidget_spec_p (value
))
5225 it
->what
= IT_XWIDGET
;
5226 it
->method
= GET_FROM_XWIDGET
;
5227 it
->position
= start_pos
;
5228 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5229 *position
= start_pos
;
5230 it
->xwidget
= lookup_xwidget (value
);
5232 #ifdef HAVE_WINDOW_SYSTEM
5235 it
->what
= IT_IMAGE
;
5236 it
->image_id
= lookup_image (it
->f
, value
);
5237 it
->position
= start_pos
;
5238 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5239 it
->method
= GET_FROM_IMAGE
;
5241 /* Say that we haven't consumed the characters with
5242 `display' property yet. The call to pop_it in
5243 set_iterator_to_next will clean this up. */
5244 *position
= start_pos
;
5246 #endif /* HAVE_WINDOW_SYSTEM */
5251 /* Invalid property or property not supported. Restore
5252 POSITION to what it was before. */
5253 *position
= start_pos
;
5257 /* Check if PROP is a display property value whose text should be
5258 treated as intangible. OVERLAY is the overlay from which PROP
5259 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5260 specify the buffer position covered by PROP. */
5263 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5264 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5266 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5267 struct text_pos position
;
5269 SET_TEXT_POS (position
, charpos
, bytepos
);
5270 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5271 &position
, charpos
, frame_window_p
)
5276 /* Return true if PROP is a display sub-property value containing STRING.
5278 Implementation note: this and the following function are really
5279 special cases of handle_display_spec and
5280 handle_single_display_spec, and should ideally use the same code.
5281 Until they do, these two pairs must be consistent and must be
5282 modified in sync. */
5285 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5287 if (EQ (string
, prop
))
5290 /* Skip over `when FORM'. */
5291 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5296 /* Actually, the condition following `when' should be eval'ed,
5297 like handle_single_display_spec does, and we should return
5298 false if it evaluates to nil. However, this function is
5299 called only when the buffer was already displayed and some
5300 glyph in the glyph matrix was found to come from a display
5301 string. Therefore, the condition was already evaluated, and
5302 the result was non-nil, otherwise the display string wouldn't
5303 have been displayed and we would have never been called for
5304 this property. Thus, we can skip the evaluation and assume
5305 its result is non-nil. */
5310 /* Skip over `margin LOCATION'. */
5311 if (EQ (XCAR (prop
), Qmargin
))
5322 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5326 /* Return true if STRING appears in the `display' property PROP. */
5329 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5332 && !EQ (XCAR (prop
), Qwhen
)
5333 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5335 /* A list of sub-properties. */
5336 while (CONSP (prop
))
5338 if (single_display_spec_string_p (XCAR (prop
), string
))
5343 else if (VECTORP (prop
))
5345 /* A vector of sub-properties. */
5347 for (i
= 0; i
< ASIZE (prop
); ++i
)
5348 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5352 return single_display_spec_string_p (prop
, string
);
5357 /* Look for STRING in overlays and text properties in the current
5358 buffer, between character positions FROM and TO (excluding TO).
5359 BACK_P means look back (in this case, TO is supposed to be
5361 Value is the first character position where STRING was found, or
5362 zero if it wasn't found before hitting TO.
5364 This function may only use code that doesn't eval because it is
5365 called asynchronously from note_mouse_highlight. */
5368 string_buffer_position_lim (Lisp_Object string
,
5369 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5371 Lisp_Object limit
, prop
, pos
;
5374 pos
= make_number (max (from
, BEGV
));
5376 if (!back_p
) /* looking forward */
5378 limit
= make_number (min (to
, ZV
));
5379 while (!found
&& !EQ (pos
, limit
))
5381 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5382 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5385 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5389 else /* looking back */
5391 limit
= make_number (max (to
, BEGV
));
5392 while (!found
&& !EQ (pos
, limit
))
5394 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5395 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5398 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5403 return found
? XINT (pos
) : 0;
5406 /* Determine which buffer position in current buffer STRING comes from.
5407 AROUND_CHARPOS is an approximate position where it could come from.
5408 Value is the buffer position or 0 if it couldn't be determined.
5410 This function is necessary because we don't record buffer positions
5411 in glyphs generated from strings (to keep struct glyph small).
5412 This function may only use code that doesn't eval because it is
5413 called asynchronously from note_mouse_highlight. */
5416 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5418 const int MAX_DISTANCE
= 1000;
5419 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5420 around_charpos
+ MAX_DISTANCE
,
5424 found
= string_buffer_position_lim (string
, around_charpos
,
5425 around_charpos
- MAX_DISTANCE
, true);
5431 /***********************************************************************
5432 `composition' property
5433 ***********************************************************************/
5435 /* Set up iterator IT from `composition' property at its current
5436 position. Called from handle_stop. */
5438 static enum prop_handled
5439 handle_composition_prop (struct it
*it
)
5441 Lisp_Object prop
, string
;
5442 ptrdiff_t pos
, pos_byte
, start
, end
;
5444 if (STRINGP (it
->string
))
5448 pos
= IT_STRING_CHARPOS (*it
);
5449 pos_byte
= IT_STRING_BYTEPOS (*it
);
5450 string
= it
->string
;
5451 s
= SDATA (string
) + pos_byte
;
5452 it
->c
= STRING_CHAR (s
);
5456 pos
= IT_CHARPOS (*it
);
5457 pos_byte
= IT_BYTEPOS (*it
);
5459 it
->c
= FETCH_CHAR (pos_byte
);
5462 /* If there's a valid composition and point is not inside of the
5463 composition (in the case that the composition is from the current
5464 buffer), draw a glyph composed from the composition components. */
5465 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5466 && composition_valid_p (start
, end
, prop
)
5467 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5470 /* As we can't handle this situation (perhaps font-lock added
5471 a new composition), we just return here hoping that next
5472 redisplay will detect this composition much earlier. */
5473 return HANDLED_NORMALLY
;
5476 if (STRINGP (it
->string
))
5477 pos_byte
= string_char_to_byte (it
->string
, start
);
5479 pos_byte
= CHAR_TO_BYTE (start
);
5481 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5484 if (it
->cmp_it
.id
>= 0)
5487 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5488 it
->cmp_it
.nglyphs
= -1;
5492 return HANDLED_NORMALLY
;
5497 /***********************************************************************
5499 ***********************************************************************/
5501 /* The following structure is used to record overlay strings for
5502 later sorting in load_overlay_strings. */
5504 struct overlay_entry
5506 Lisp_Object overlay
;
5509 bool after_string_p
;
5513 /* Set up iterator IT from overlay strings at its current position.
5514 Called from handle_stop. */
5516 static enum prop_handled
5517 handle_overlay_change (struct it
*it
)
5519 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5520 return HANDLED_RECOMPUTE_PROPS
;
5522 return HANDLED_NORMALLY
;
5526 /* Set up the next overlay string for delivery by IT, if there is an
5527 overlay string to deliver. Called by set_iterator_to_next when the
5528 end of the current overlay string is reached. If there are more
5529 overlay strings to display, IT->string and
5530 IT->current.overlay_string_index are set appropriately here.
5531 Otherwise IT->string is set to nil. */
5534 next_overlay_string (struct it
*it
)
5536 ++it
->current
.overlay_string_index
;
5537 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5539 /* No more overlay strings. Restore IT's settings to what
5540 they were before overlay strings were processed, and
5541 continue to deliver from current_buffer. */
5543 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5546 || (NILP (it
->string
)
5547 && it
->method
== GET_FROM_BUFFER
5548 && it
->stop_charpos
>= BEGV
5549 && it
->stop_charpos
<= it
->end_charpos
));
5550 it
->current
.overlay_string_index
= -1;
5551 it
->n_overlay_strings
= 0;
5552 /* If there's an empty display string on the stack, pop the
5553 stack, to resync the bidi iterator with IT's position. Such
5554 empty strings are pushed onto the stack in
5555 get_overlay_strings_1. */
5556 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5559 /* Since we've exhausted overlay strings at this buffer
5560 position, set the flag to ignore overlays until we move to
5561 another position. The flag is reset in
5562 next_element_from_buffer. */
5563 it
->ignore_overlay_strings_at_pos_p
= true;
5565 /* If we're at the end of the buffer, record that we have
5566 processed the overlay strings there already, so that
5567 next_element_from_buffer doesn't try it again. */
5568 if (NILP (it
->string
)
5569 && IT_CHARPOS (*it
) >= it
->end_charpos
5570 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5571 it
->overlay_strings_at_end_processed_p
= true;
5572 /* Note: we reset overlay_strings_charpos only here, to make
5573 sure the just-processed overlays were indeed at EOB.
5574 Otherwise, overlays on text with invisible text property,
5575 which are processed with IT's position past the invisible
5576 text, might fool us into thinking the overlays at EOB were
5577 already processed (linum-mode can cause this, for
5579 it
->overlay_strings_charpos
= -1;
5583 /* There are more overlay strings to process. If
5584 IT->current.overlay_string_index has advanced to a position
5585 where we must load IT->overlay_strings with more strings, do
5586 it. We must load at the IT->overlay_strings_charpos where
5587 IT->n_overlay_strings was originally computed; when invisible
5588 text is present, this might not be IT_CHARPOS (Bug#7016). */
5589 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5591 if (it
->current
.overlay_string_index
&& i
== 0)
5592 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5594 /* Initialize IT to deliver display elements from the overlay
5596 it
->string
= it
->overlay_strings
[i
];
5597 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5598 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5599 it
->method
= GET_FROM_STRING
;
5600 it
->stop_charpos
= 0;
5601 it
->end_charpos
= SCHARS (it
->string
);
5602 if (it
->cmp_it
.stop_pos
>= 0)
5603 it
->cmp_it
.stop_pos
= 0;
5605 it
->base_level_stop
= 0;
5607 /* Set up the bidi iterator for this overlay string. */
5610 it
->bidi_it
.string
.lstring
= it
->string
;
5611 it
->bidi_it
.string
.s
= NULL
;
5612 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5613 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5614 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5615 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5616 it
->bidi_it
.w
= it
->w
;
5617 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5625 /* Compare two overlay_entry structures E1 and E2. Used as a
5626 comparison function for qsort in load_overlay_strings. Overlay
5627 strings for the same position are sorted so that
5629 1. All after-strings come in front of before-strings, except
5630 when they come from the same overlay.
5632 2. Within after-strings, strings are sorted so that overlay strings
5633 from overlays with higher priorities come first.
5635 2. Within before-strings, strings are sorted so that overlay
5636 strings from overlays with higher priorities come last.
5638 Value is analogous to strcmp. */
5642 compare_overlay_entries (const void *e1
, const void *e2
)
5644 struct overlay_entry
const *entry1
= e1
;
5645 struct overlay_entry
const *entry2
= e2
;
5648 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5650 /* Let after-strings appear in front of before-strings if
5651 they come from different overlays. */
5652 if (EQ (entry1
->overlay
, entry2
->overlay
))
5653 result
= entry1
->after_string_p
? 1 : -1;
5655 result
= entry1
->after_string_p
? -1 : 1;
5657 else if (entry1
->priority
!= entry2
->priority
)
5659 if (entry1
->after_string_p
)
5660 /* After-strings sorted in order of decreasing priority. */
5661 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5663 /* Before-strings sorted in order of increasing priority. */
5664 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5673 /* Load the vector IT->overlay_strings with overlay strings from IT's
5674 current buffer position, or from CHARPOS if that is > 0. Set
5675 IT->n_overlays to the total number of overlay strings found.
5677 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5678 a time. On entry into load_overlay_strings,
5679 IT->current.overlay_string_index gives the number of overlay
5680 strings that have already been loaded by previous calls to this
5683 IT->add_overlay_start contains an additional overlay start
5684 position to consider for taking overlay strings from, if non-zero.
5685 This position comes into play when the overlay has an `invisible'
5686 property, and both before and after-strings. When we've skipped to
5687 the end of the overlay, because of its `invisible' property, we
5688 nevertheless want its before-string to appear.
5689 IT->add_overlay_start will contain the overlay start position
5692 Overlay strings are sorted so that after-string strings come in
5693 front of before-string strings. Within before and after-strings,
5694 strings are sorted by overlay priority. See also function
5695 compare_overlay_entries. */
5698 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5700 Lisp_Object overlay
, window
, str
, invisible
;
5701 struct Lisp_Overlay
*ov
;
5702 ptrdiff_t start
, end
;
5703 ptrdiff_t n
= 0, i
, j
;
5705 struct overlay_entry entriesbuf
[20];
5706 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5707 struct overlay_entry
*entries
= entriesbuf
;
5711 charpos
= IT_CHARPOS (*it
);
5713 /* Append the overlay string STRING of overlay OVERLAY to vector
5714 `entries' which has size `size' and currently contains `n'
5715 elements. AFTER_P means STRING is an after-string of
5717 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5720 Lisp_Object priority; \
5724 struct overlay_entry *old = entries; \
5725 SAFE_NALLOCA (entries, 2, size); \
5726 memcpy (entries, old, size * sizeof *entries); \
5730 entries[n].string = (STRING); \
5731 entries[n].overlay = (OVERLAY); \
5732 priority = Foverlay_get ((OVERLAY), Qpriority); \
5733 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5734 entries[n].after_string_p = (AFTER_P); \
5739 /* Process overlay before the overlay center. */
5740 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5742 XSETMISC (overlay
, ov
);
5743 eassert (OVERLAYP (overlay
));
5744 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5745 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5750 /* Skip this overlay if it doesn't start or end at IT's current
5752 if (end
!= charpos
&& start
!= charpos
)
5755 /* Skip this overlay if it doesn't apply to IT->w. */
5756 window
= Foverlay_get (overlay
, Qwindow
);
5757 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5760 /* If the text ``under'' the overlay is invisible, both before-
5761 and after-strings from this overlay are visible; start and
5762 end position are indistinguishable. */
5763 invisible
= Foverlay_get (overlay
, Qinvisible
);
5764 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5766 /* If overlay has a non-empty before-string, record it. */
5767 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5768 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5770 RECORD_OVERLAY_STRING (overlay
, str
, false);
5772 /* If overlay has a non-empty after-string, record it. */
5773 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5774 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5776 RECORD_OVERLAY_STRING (overlay
, str
, true);
5779 /* Process overlays after the overlay center. */
5780 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5782 XSETMISC (overlay
, ov
);
5783 eassert (OVERLAYP (overlay
));
5784 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5785 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5787 if (start
> charpos
)
5790 /* Skip this overlay if it doesn't start or end at IT's current
5792 if (end
!= charpos
&& start
!= charpos
)
5795 /* Skip this overlay if it doesn't apply to IT->w. */
5796 window
= Foverlay_get (overlay
, Qwindow
);
5797 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5800 /* If the text ``under'' the overlay is invisible, it has a zero
5801 dimension, and both before- and after-strings apply. */
5802 invisible
= Foverlay_get (overlay
, Qinvisible
);
5803 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5805 /* If overlay has a non-empty before-string, record it. */
5806 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5807 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5809 RECORD_OVERLAY_STRING (overlay
, str
, false);
5811 /* If overlay has a non-empty after-string, record it. */
5812 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5813 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5815 RECORD_OVERLAY_STRING (overlay
, str
, true);
5818 #undef RECORD_OVERLAY_STRING
5822 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5824 /* Record number of overlay strings, and where we computed it. */
5825 it
->n_overlay_strings
= n
;
5826 it
->overlay_strings_charpos
= charpos
;
5828 /* IT->current.overlay_string_index is the number of overlay strings
5829 that have already been consumed by IT. Copy some of the
5830 remaining overlay strings to IT->overlay_strings. */
5832 j
= it
->current
.overlay_string_index
;
5833 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5835 it
->overlay_strings
[i
] = entries
[j
].string
;
5836 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5844 /* Get the first chunk of overlay strings at IT's current buffer
5845 position, or at CHARPOS if that is > 0. Value is true if at
5846 least one overlay string was found. */
5849 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5851 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5852 process. This fills IT->overlay_strings with strings, and sets
5853 IT->n_overlay_strings to the total number of strings to process.
5854 IT->pos.overlay_string_index has to be set temporarily to zero
5855 because load_overlay_strings needs this; it must be set to -1
5856 when no overlay strings are found because a zero value would
5857 indicate a position in the first overlay string. */
5858 it
->current
.overlay_string_index
= 0;
5859 load_overlay_strings (it
, charpos
);
5861 /* If we found overlay strings, set up IT to deliver display
5862 elements from the first one. Otherwise set up IT to deliver
5863 from current_buffer. */
5864 if (it
->n_overlay_strings
)
5866 /* Make sure we know settings in current_buffer, so that we can
5867 restore meaningful values when we're done with the overlay
5870 compute_stop_pos (it
);
5871 eassert (it
->face_id
>= 0);
5873 /* Save IT's settings. They are restored after all overlay
5874 strings have been processed. */
5875 eassert (!compute_stop_p
|| it
->sp
== 0);
5877 /* When called from handle_stop, there might be an empty display
5878 string loaded. In that case, don't bother saving it. But
5879 don't use this optimization with the bidi iterator, since we
5880 need the corresponding pop_it call to resync the bidi
5881 iterator's position with IT's position, after we are done
5882 with the overlay strings. (The corresponding call to pop_it
5883 in case of an empty display string is in
5884 next_overlay_string.) */
5886 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5889 /* Set up IT to deliver display elements from the first overlay
5891 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5892 it
->string
= it
->overlay_strings
[0];
5893 it
->from_overlay
= Qnil
;
5894 it
->stop_charpos
= 0;
5895 eassert (STRINGP (it
->string
));
5896 it
->end_charpos
= SCHARS (it
->string
);
5898 it
->base_level_stop
= 0;
5899 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5900 it
->method
= GET_FROM_STRING
;
5901 it
->from_disp_prop_p
= 0;
5903 /* Force paragraph direction to be that of the parent
5905 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5906 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5908 it
->paragraph_embedding
= L2R
;
5910 /* Set up the bidi iterator for this overlay string. */
5913 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5915 it
->bidi_it
.string
.lstring
= it
->string
;
5916 it
->bidi_it
.string
.s
= NULL
;
5917 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5918 it
->bidi_it
.string
.bufpos
= pos
;
5919 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5920 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5921 it
->bidi_it
.w
= it
->w
;
5922 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5927 it
->current
.overlay_string_index
= -1;
5932 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5935 it
->method
= GET_FROM_BUFFER
;
5937 get_overlay_strings_1 (it
, charpos
, true);
5941 /* Value is true if we found at least one overlay string. */
5942 return STRINGP (it
->string
);
5947 /***********************************************************************
5948 Saving and restoring state
5949 ***********************************************************************/
5951 /* Save current settings of IT on IT->stack. Called, for example,
5952 before setting up IT for an overlay string, to be able to restore
5953 IT's settings to what they were after the overlay string has been
5954 processed. If POSITION is non-NULL, it is the position to save on
5955 the stack instead of IT->position. */
5958 push_it (struct it
*it
, struct text_pos
*position
)
5960 struct iterator_stack_entry
*p
;
5962 eassert (it
->sp
< IT_STACK_SIZE
);
5963 p
= it
->stack
+ it
->sp
;
5965 p
->stop_charpos
= it
->stop_charpos
;
5966 p
->prev_stop
= it
->prev_stop
;
5967 p
->base_level_stop
= it
->base_level_stop
;
5968 p
->cmp_it
= it
->cmp_it
;
5969 eassert (it
->face_id
>= 0);
5970 p
->face_id
= it
->face_id
;
5971 p
->string
= it
->string
;
5972 p
->method
= it
->method
;
5973 p
->from_overlay
= it
->from_overlay
;
5976 case GET_FROM_IMAGE
:
5977 p
->u
.image
.object
= it
->object
;
5978 p
->u
.image
.image_id
= it
->image_id
;
5979 p
->u
.image
.slice
= it
->slice
;
5981 case GET_FROM_STRETCH
:
5982 p
->u
.stretch
.object
= it
->object
;
5984 case GET_FROM_XWIDGET
:
5985 p
->u
.xwidget
.object
= it
->object
;
5987 case GET_FROM_BUFFER
:
5988 case GET_FROM_DISPLAY_VECTOR
:
5989 case GET_FROM_STRING
:
5990 case GET_FROM_C_STRING
:
5995 p
->position
= position
? *position
: it
->position
;
5996 p
->current
= it
->current
;
5997 p
->end_charpos
= it
->end_charpos
;
5998 p
->string_nchars
= it
->string_nchars
;
6000 p
->multibyte_p
= it
->multibyte_p
;
6001 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6002 p
->space_width
= it
->space_width
;
6003 p
->font_height
= it
->font_height
;
6004 p
->voffset
= it
->voffset
;
6005 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6006 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6007 p
->display_ellipsis_p
= false;
6008 p
->line_wrap
= it
->line_wrap
;
6009 p
->bidi_p
= it
->bidi_p
;
6010 p
->paragraph_embedding
= it
->paragraph_embedding
;
6011 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6014 /* Save the state of the bidi iterator as well. */
6016 bidi_push_it (&it
->bidi_it
);
6020 iterate_out_of_display_property (struct it
*it
)
6022 bool buffer_p
= !STRINGP (it
->string
);
6023 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6024 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6026 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6028 /* Maybe initialize paragraph direction. If we are at the beginning
6029 of a new paragraph, next_element_from_buffer may not have a
6030 chance to do that. */
6031 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6032 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
6033 /* prev_stop can be zero, so check against BEGV as well. */
6034 while (it
->bidi_it
.charpos
>= bob
6035 && it
->prev_stop
<= it
->bidi_it
.charpos
6036 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6037 && it
->bidi_it
.charpos
< eob
)
6038 bidi_move_to_visually_next (&it
->bidi_it
);
6039 /* Record the stop_pos we just crossed, for when we cross it
6041 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6042 it
->prev_stop
= CHARPOS (it
->position
);
6043 /* If we ended up not where pop_it put us, resync IT's
6044 positional members with the bidi iterator. */
6045 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6046 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6048 it
->current
.pos
= it
->position
;
6050 it
->current
.string_pos
= it
->position
;
6053 /* Restore IT's settings from IT->stack. Called, for example, when no
6054 more overlay strings must be processed, and we return to delivering
6055 display elements from a buffer, or when the end of a string from a
6056 `display' property is reached and we return to delivering display
6057 elements from an overlay string, or from a buffer. */
6060 pop_it (struct it
*it
)
6062 struct iterator_stack_entry
*p
;
6063 bool from_display_prop
= it
->from_disp_prop_p
;
6064 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6066 eassert (it
->sp
> 0);
6068 p
= it
->stack
+ it
->sp
;
6069 it
->stop_charpos
= p
->stop_charpos
;
6070 it
->prev_stop
= p
->prev_stop
;
6071 it
->base_level_stop
= p
->base_level_stop
;
6072 it
->cmp_it
= p
->cmp_it
;
6073 it
->face_id
= p
->face_id
;
6074 it
->current
= p
->current
;
6075 it
->position
= p
->position
;
6076 it
->string
= p
->string
;
6077 it
->from_overlay
= p
->from_overlay
;
6078 if (NILP (it
->string
))
6079 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6080 it
->method
= p
->method
;
6083 case GET_FROM_IMAGE
:
6084 it
->image_id
= p
->u
.image
.image_id
;
6085 it
->object
= p
->u
.image
.object
;
6086 it
->slice
= p
->u
.image
.slice
;
6088 case GET_FROM_XWIDGET
:
6089 it
->object
= p
->u
.xwidget
.object
;
6091 case GET_FROM_STRETCH
:
6092 it
->object
= p
->u
.stretch
.object
;
6094 case GET_FROM_BUFFER
:
6095 it
->object
= it
->w
->contents
;
6097 case GET_FROM_STRING
:
6099 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6101 /* Restore the face_box_p flag, since it could have been
6102 overwritten by the face of the object that we just finished
6105 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6106 it
->object
= it
->string
;
6109 case GET_FROM_DISPLAY_VECTOR
:
6111 it
->method
= GET_FROM_C_STRING
;
6112 else if (STRINGP (it
->string
))
6113 it
->method
= GET_FROM_STRING
;
6116 it
->method
= GET_FROM_BUFFER
;
6117 it
->object
= it
->w
->contents
;
6120 case GET_FROM_C_STRING
:
6125 it
->end_charpos
= p
->end_charpos
;
6126 it
->string_nchars
= p
->string_nchars
;
6128 it
->multibyte_p
= p
->multibyte_p
;
6129 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6130 it
->space_width
= p
->space_width
;
6131 it
->font_height
= p
->font_height
;
6132 it
->voffset
= p
->voffset
;
6133 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6134 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6135 it
->line_wrap
= p
->line_wrap
;
6136 it
->bidi_p
= p
->bidi_p
;
6137 it
->paragraph_embedding
= p
->paragraph_embedding
;
6138 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6141 bidi_pop_it (&it
->bidi_it
);
6142 /* Bidi-iterate until we get out of the portion of text, if any,
6143 covered by a `display' text property or by an overlay with
6144 `display' property. (We cannot just jump there, because the
6145 internal coherency of the bidi iterator state can not be
6146 preserved across such jumps.) We also must determine the
6147 paragraph base direction if the overlay we just processed is
6148 at the beginning of a new paragraph. */
6149 if (from_display_prop
6150 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6151 iterate_out_of_display_property (it
);
6153 eassert ((BUFFERP (it
->object
)
6154 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6155 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6156 || (STRINGP (it
->object
)
6157 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6158 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6159 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6161 /* If we move the iterator over text covered by a display property
6162 to a new buffer position, any info about previously seen overlays
6163 is no longer valid. */
6164 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6165 it
->ignore_overlay_strings_at_pos_p
= false;
6170 /***********************************************************************
6172 ***********************************************************************/
6174 /* Set IT's current position to the previous line start. */
6177 back_to_previous_line_start (struct it
*it
)
6179 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6182 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6186 /* Move IT to the next line start.
6188 Value is true if a newline was found. Set *SKIPPED_P to true if
6189 we skipped over part of the text (as opposed to moving the iterator
6190 continuously over the text). Otherwise, don't change the value
6193 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6194 iterator on the newline, if it was found.
6196 Newlines may come from buffer text, overlay strings, or strings
6197 displayed via the `display' property. That's the reason we can't
6198 simply use find_newline_no_quit.
6200 Note that this function may not skip over invisible text that is so
6201 because of text properties and immediately follows a newline. If
6202 it would, function reseat_at_next_visible_line_start, when called
6203 from set_iterator_to_next, would effectively make invisible
6204 characters following a newline part of the wrong glyph row, which
6205 leads to wrong cursor motion. */
6208 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6209 struct bidi_it
*bidi_it_prev
)
6211 ptrdiff_t old_selective
;
6212 bool newline_found_p
= false;
6214 const int MAX_NEWLINE_DISTANCE
= 500;
6216 /* If already on a newline, just consume it to avoid unintended
6217 skipping over invisible text below. */
6218 if (it
->what
== IT_CHARACTER
6220 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6222 if (it
->bidi_p
&& bidi_it_prev
)
6223 *bidi_it_prev
= it
->bidi_it
;
6224 set_iterator_to_next (it
, false);
6229 /* Don't handle selective display in the following. It's (a)
6230 unnecessary because it's done by the caller, and (b) leads to an
6231 infinite recursion because next_element_from_ellipsis indirectly
6232 calls this function. */
6233 old_selective
= it
->selective
;
6236 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6237 from buffer text. */
6239 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6240 n
+= !STRINGP (it
->string
))
6242 if (!get_next_display_element (it
))
6244 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6245 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6246 *bidi_it_prev
= it
->bidi_it
;
6247 set_iterator_to_next (it
, false);
6250 /* If we didn't find a newline near enough, see if we can use a
6252 if (!newline_found_p
)
6254 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6255 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6259 eassert (!STRINGP (it
->string
));
6261 /* If there isn't any `display' property in sight, and no
6262 overlays, we can just use the position of the newline in
6264 if (it
->stop_charpos
>= limit
6265 || ((pos
= Fnext_single_property_change (make_number (start
),
6267 make_number (limit
)),
6269 && next_overlay_change (start
) == ZV
))
6273 IT_CHARPOS (*it
) = limit
;
6274 IT_BYTEPOS (*it
) = bytepos
;
6278 struct bidi_it bprev
;
6280 /* Help bidi.c avoid expensive searches for display
6281 properties and overlays, by telling it that there are
6282 none up to `limit'. */
6283 if (it
->bidi_it
.disp_pos
< limit
)
6285 it
->bidi_it
.disp_pos
= limit
;
6286 it
->bidi_it
.disp_prop
= 0;
6289 bprev
= it
->bidi_it
;
6290 bidi_move_to_visually_next (&it
->bidi_it
);
6291 } while (it
->bidi_it
.charpos
!= limit
);
6292 IT_CHARPOS (*it
) = limit
;
6293 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6295 *bidi_it_prev
= bprev
;
6297 *skipped_p
= newline_found_p
= true;
6301 while (get_next_display_element (it
)
6302 && !newline_found_p
)
6304 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6305 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6306 *bidi_it_prev
= it
->bidi_it
;
6307 set_iterator_to_next (it
, false);
6312 it
->selective
= old_selective
;
6313 return newline_found_p
;
6317 /* Set IT's current position to the previous visible line start. Skip
6318 invisible text that is so either due to text properties or due to
6319 selective display. Caution: this does not change IT->current_x and
6323 back_to_previous_visible_line_start (struct it
*it
)
6325 while (IT_CHARPOS (*it
) > BEGV
)
6327 back_to_previous_line_start (it
);
6329 if (IT_CHARPOS (*it
) <= BEGV
)
6332 /* If selective > 0, then lines indented more than its value are
6334 if (it
->selective
> 0
6335 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6339 /* Check the newline before point for invisibility. */
6342 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6343 Qinvisible
, it
->window
);
6344 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6348 if (IT_CHARPOS (*it
) <= BEGV
)
6353 void *it2data
= NULL
;
6356 Lisp_Object val
, overlay
;
6358 SAVE_IT (it2
, *it
, it2data
);
6360 /* If newline is part of a composition, continue from start of composition */
6361 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6362 && beg
< IT_CHARPOS (*it
))
6365 /* If newline is replaced by a display property, find start of overlay
6366 or interval and continue search from that point. */
6367 pos
= --IT_CHARPOS (it2
);
6370 bidi_unshelve_cache (NULL
, false);
6371 it2
.string_from_display_prop_p
= false;
6372 it2
.from_disp_prop_p
= false;
6373 if (handle_display_prop (&it2
) == HANDLED_RETURN
6374 && !NILP (val
= get_char_property_and_overlay
6375 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6376 && (OVERLAYP (overlay
)
6377 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6378 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6380 RESTORE_IT (it
, it
, it2data
);
6384 /* Newline is not replaced by anything -- so we are done. */
6385 RESTORE_IT (it
, it
, it2data
);
6391 IT_CHARPOS (*it
) = beg
;
6392 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6396 it
->continuation_lines_width
= 0;
6398 eassert (IT_CHARPOS (*it
) >= BEGV
);
6399 eassert (IT_CHARPOS (*it
) == BEGV
6400 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6405 /* Reseat iterator IT at the previous visible line start. Skip
6406 invisible text that is so either due to text properties or due to
6407 selective display. At the end, update IT's overlay information,
6408 face information etc. */
6411 reseat_at_previous_visible_line_start (struct it
*it
)
6413 back_to_previous_visible_line_start (it
);
6414 reseat (it
, it
->current
.pos
, true);
6419 /* Reseat iterator IT on the next visible line start in the current
6420 buffer. ON_NEWLINE_P means position IT on the newline
6421 preceding the line start. Skip over invisible text that is so
6422 because of selective display. Compute faces, overlays etc at the
6423 new position. Note that this function does not skip over text that
6424 is invisible because of text properties. */
6427 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6429 bool skipped_p
= false;
6430 struct bidi_it bidi_it_prev
;
6431 bool newline_found_p
6432 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6434 /* Skip over lines that are invisible because they are indented
6435 more than the value of IT->selective. */
6436 if (it
->selective
> 0)
6437 while (IT_CHARPOS (*it
) < ZV
6438 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6441 eassert (IT_BYTEPOS (*it
) == BEGV
6442 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6444 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6447 /* Position on the newline if that's what's requested. */
6448 if (on_newline_p
&& newline_found_p
)
6450 if (STRINGP (it
->string
))
6452 if (IT_STRING_CHARPOS (*it
) > 0)
6456 --IT_STRING_CHARPOS (*it
);
6457 --IT_STRING_BYTEPOS (*it
);
6461 /* We need to restore the bidi iterator to the state
6462 it had on the newline, and resync the IT's
6463 position with that. */
6464 it
->bidi_it
= bidi_it_prev
;
6465 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6466 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6470 else if (IT_CHARPOS (*it
) > BEGV
)
6479 /* We need to restore the bidi iterator to the state it
6480 had on the newline and resync IT with that. */
6481 it
->bidi_it
= bidi_it_prev
;
6482 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6483 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6485 reseat (it
, it
->current
.pos
, false);
6489 reseat (it
, it
->current
.pos
, false);
6496 /***********************************************************************
6497 Changing an iterator's position
6498 ***********************************************************************/
6500 /* Change IT's current position to POS in current_buffer.
6501 If FORCE_P, always check for text properties at the new position.
6502 Otherwise, text properties are only looked up if POS >=
6503 IT->check_charpos of a property. */
6506 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6508 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6510 reseat_1 (it
, pos
, false);
6512 /* Determine where to check text properties. Avoid doing it
6513 where possible because text property lookup is very expensive. */
6515 || CHARPOS (pos
) > it
->stop_charpos
6516 || CHARPOS (pos
) < original_pos
)
6520 /* For bidi iteration, we need to prime prev_stop and
6521 base_level_stop with our best estimations. */
6522 /* Implementation note: Of course, POS is not necessarily a
6523 stop position, so assigning prev_pos to it is a lie; we
6524 should have called compute_stop_backwards. However, if
6525 the current buffer does not include any R2L characters,
6526 that call would be a waste of cycles, because the
6527 iterator will never move back, and thus never cross this
6528 "fake" stop position. So we delay that backward search
6529 until the time we really need it, in next_element_from_buffer. */
6530 if (CHARPOS (pos
) != it
->prev_stop
)
6531 it
->prev_stop
= CHARPOS (pos
);
6532 if (CHARPOS (pos
) < it
->base_level_stop
)
6533 it
->base_level_stop
= 0; /* meaning it's unknown */
6539 it
->prev_stop
= it
->base_level_stop
= 0;
6548 /* Change IT's buffer position to POS. SET_STOP_P means set
6549 IT->stop_pos to POS, also. */
6552 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6554 /* Don't call this function when scanning a C string. */
6555 eassert (it
->s
== NULL
);
6557 /* POS must be a reasonable value. */
6558 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6560 it
->current
.pos
= it
->position
= pos
;
6561 it
->end_charpos
= ZV
;
6563 it
->current
.dpvec_index
= -1;
6564 it
->current
.overlay_string_index
= -1;
6565 IT_STRING_CHARPOS (*it
) = -1;
6566 IT_STRING_BYTEPOS (*it
) = -1;
6568 it
->method
= GET_FROM_BUFFER
;
6569 it
->object
= it
->w
->contents
;
6570 it
->area
= TEXT_AREA
;
6571 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6573 it
->string_from_display_prop_p
= false;
6574 it
->string_from_prefix_prop_p
= false;
6576 it
->from_disp_prop_p
= false;
6577 it
->face_before_selective_p
= false;
6580 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6582 bidi_unshelve_cache (NULL
, false);
6583 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6584 it
->bidi_it
.string
.s
= NULL
;
6585 it
->bidi_it
.string
.lstring
= Qnil
;
6586 it
->bidi_it
.string
.bufpos
= 0;
6587 it
->bidi_it
.string
.from_disp_str
= false;
6588 it
->bidi_it
.string
.unibyte
= false;
6589 it
->bidi_it
.w
= it
->w
;
6594 it
->stop_charpos
= CHARPOS (pos
);
6595 it
->base_level_stop
= CHARPOS (pos
);
6597 /* This make the information stored in it->cmp_it invalidate. */
6602 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6603 If S is non-null, it is a C string to iterate over. Otherwise,
6604 STRING gives a Lisp string to iterate over.
6606 If PRECISION > 0, don't return more then PRECISION number of
6607 characters from the string.
6609 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6610 characters have been returned. FIELD_WIDTH < 0 means an infinite
6613 MULTIBYTE = 0 means disable processing of multibyte characters,
6614 MULTIBYTE > 0 means enable it,
6615 MULTIBYTE < 0 means use IT->multibyte_p.
6617 IT must be initialized via a prior call to init_iterator before
6618 calling this function. */
6621 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6622 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6625 /* No text property checks performed by default, but see below. */
6626 it
->stop_charpos
= -1;
6628 /* Set iterator position and end position. */
6629 memset (&it
->current
, 0, sizeof it
->current
);
6630 it
->current
.overlay_string_index
= -1;
6631 it
->current
.dpvec_index
= -1;
6632 eassert (charpos
>= 0);
6634 /* If STRING is specified, use its multibyteness, otherwise use the
6635 setting of MULTIBYTE, if specified. */
6637 it
->multibyte_p
= multibyte
> 0;
6639 /* Bidirectional reordering of strings is controlled by the default
6640 value of bidi-display-reordering. Don't try to reorder while
6641 loading loadup.el, as the necessary character property tables are
6642 not yet available. */
6645 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6649 eassert (STRINGP (string
));
6650 it
->string
= string
;
6652 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6653 it
->method
= GET_FROM_STRING
;
6654 it
->current
.string_pos
= string_pos (charpos
, string
);
6658 it
->bidi_it
.string
.lstring
= string
;
6659 it
->bidi_it
.string
.s
= NULL
;
6660 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6661 it
->bidi_it
.string
.bufpos
= 0;
6662 it
->bidi_it
.string
.from_disp_str
= false;
6663 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6664 it
->bidi_it
.w
= it
->w
;
6665 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6666 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6671 it
->s
= (const unsigned char *) s
;
6674 /* Note that we use IT->current.pos, not it->current.string_pos,
6675 for displaying C strings. */
6676 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6677 if (it
->multibyte_p
)
6679 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6680 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6684 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6685 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6690 it
->bidi_it
.string
.lstring
= Qnil
;
6691 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6692 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6693 it
->bidi_it
.string
.bufpos
= 0;
6694 it
->bidi_it
.string
.from_disp_str
= false;
6695 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6696 it
->bidi_it
.w
= it
->w
;
6697 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6700 it
->method
= GET_FROM_C_STRING
;
6703 /* PRECISION > 0 means don't return more than PRECISION characters
6705 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6707 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6709 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6712 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6713 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6714 FIELD_WIDTH < 0 means infinite field width. This is useful for
6715 padding with `-' at the end of a mode line. */
6716 if (field_width
< 0)
6717 field_width
= INFINITY
;
6718 /* Implementation note: We deliberately don't enlarge
6719 it->bidi_it.string.schars here to fit it->end_charpos, because
6720 the bidi iterator cannot produce characters out of thin air. */
6721 if (field_width
> it
->end_charpos
- charpos
)
6722 it
->end_charpos
= charpos
+ field_width
;
6724 /* Use the standard display table for displaying strings. */
6725 if (DISP_TABLE_P (Vstandard_display_table
))
6726 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6728 it
->stop_charpos
= charpos
;
6729 it
->prev_stop
= charpos
;
6730 it
->base_level_stop
= 0;
6733 it
->bidi_it
.first_elt
= true;
6734 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6735 it
->bidi_it
.disp_pos
= -1;
6737 if (s
== NULL
&& it
->multibyte_p
)
6739 ptrdiff_t endpos
= SCHARS (it
->string
);
6740 if (endpos
> it
->end_charpos
)
6741 endpos
= it
->end_charpos
;
6742 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6750 /***********************************************************************
6752 ***********************************************************************/
6754 /* Map enum it_method value to corresponding next_element_from_* function. */
6756 typedef bool (*next_element_function
) (struct it
*);
6758 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6760 next_element_from_buffer
,
6761 next_element_from_display_vector
,
6762 next_element_from_string
,
6763 next_element_from_c_string
,
6764 next_element_from_image
,
6765 next_element_from_stretch
,
6766 next_element_from_xwidget
,
6769 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6772 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6773 (possibly with the following characters). */
6775 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6776 ((IT)->cmp_it.id >= 0 \
6777 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6778 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6779 END_CHARPOS, (IT)->w, \
6780 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6784 /* Lookup the char-table Vglyphless_char_display for character C (-1
6785 if we want information for no-font case), and return the display
6786 method symbol. By side-effect, update it->what and
6787 it->glyphless_method. This function is called from
6788 get_next_display_element for each character element, and from
6789 x_produce_glyphs when no suitable font was found. */
6792 lookup_glyphless_char_display (int c
, struct it
*it
)
6794 Lisp_Object glyphless_method
= Qnil
;
6796 if (CHAR_TABLE_P (Vglyphless_char_display
)
6797 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6801 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6802 if (CONSP (glyphless_method
))
6803 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6804 ? XCAR (glyphless_method
)
6805 : XCDR (glyphless_method
);
6808 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6812 if (NILP (glyphless_method
))
6815 /* The default is to display the character by a proper font. */
6817 /* The default for the no-font case is to display an empty box. */
6818 glyphless_method
= Qempty_box
;
6820 if (EQ (glyphless_method
, Qzero_width
))
6823 return glyphless_method
;
6824 /* This method can't be used for the no-font case. */
6825 glyphless_method
= Qempty_box
;
6827 if (EQ (glyphless_method
, Qthin_space
))
6828 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6829 else if (EQ (glyphless_method
, Qempty_box
))
6830 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6831 else if (EQ (glyphless_method
, Qhex_code
))
6832 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6833 else if (STRINGP (glyphless_method
))
6834 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6837 /* Invalid value. We use the default method. */
6838 glyphless_method
= Qnil
;
6841 it
->what
= IT_GLYPHLESS
;
6842 return glyphless_method
;
6845 /* Merge escape glyph face and cache the result. */
6847 static struct frame
*last_escape_glyph_frame
= NULL
;
6848 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6849 static int last_escape_glyph_merged_face_id
= 0;
6852 merge_escape_glyph_face (struct it
*it
)
6856 if (it
->f
== last_escape_glyph_frame
6857 && it
->face_id
== last_escape_glyph_face_id
)
6858 face_id
= last_escape_glyph_merged_face_id
;
6861 /* Merge the `escape-glyph' face into the current face. */
6862 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6863 last_escape_glyph_frame
= it
->f
;
6864 last_escape_glyph_face_id
= it
->face_id
;
6865 last_escape_glyph_merged_face_id
= face_id
;
6870 /* Likewise for glyphless glyph face. */
6872 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6873 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6874 static int last_glyphless_glyph_merged_face_id
= 0;
6877 merge_glyphless_glyph_face (struct it
*it
)
6881 if (it
->f
== last_glyphless_glyph_frame
6882 && it
->face_id
== last_glyphless_glyph_face_id
)
6883 face_id
= last_glyphless_glyph_merged_face_id
;
6886 /* Merge the `glyphless-char' face into the current face. */
6887 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6888 last_glyphless_glyph_frame
= it
->f
;
6889 last_glyphless_glyph_face_id
= it
->face_id
;
6890 last_glyphless_glyph_merged_face_id
= face_id
;
6895 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6896 be called before redisplaying windows, and when the frame's face
6899 forget_escape_and_glyphless_faces (void)
6901 last_escape_glyph_frame
= NULL
;
6902 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6903 last_glyphless_glyph_frame
= NULL
;
6904 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6907 /* Load IT's display element fields with information about the next
6908 display element from the current position of IT. Value is false if
6909 end of buffer (or C string) is reached. */
6912 get_next_display_element (struct it
*it
)
6914 /* True means that we found a display element. False means that
6915 we hit the end of what we iterate over. Performance note: the
6916 function pointer `method' used here turns out to be faster than
6917 using a sequence of if-statements. */
6921 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6923 if (it
->what
== IT_CHARACTER
)
6925 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6926 and only if (a) the resolved directionality of that character
6928 /* FIXME: Do we need an exception for characters from display
6930 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6931 && !inhibit_bidi_mirroring
)
6932 it
->c
= bidi_mirror_char (it
->c
);
6933 /* Map via display table or translate control characters.
6934 IT->c, IT->len etc. have been set to the next character by
6935 the function call above. If we have a display table, and it
6936 contains an entry for IT->c, translate it. Don't do this if
6937 IT->c itself comes from a display table, otherwise we could
6938 end up in an infinite recursion. (An alternative could be to
6939 count the recursion depth of this function and signal an
6940 error when a certain maximum depth is reached.) Is it worth
6942 if (success_p
&& it
->dpvec
== NULL
)
6945 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6946 bool nonascii_space_p
= false;
6947 bool nonascii_hyphen_p
= false;
6948 int c
= it
->c
; /* This is the character to display. */
6950 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6952 eassert (SINGLE_BYTE_CHAR_P (c
));
6953 if (unibyte_display_via_language_environment
)
6955 c
= DECODE_CHAR (unibyte
, c
);
6957 c
= BYTE8_TO_CHAR (it
->c
);
6960 c
= BYTE8_TO_CHAR (it
->c
);
6964 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6967 struct Lisp_Vector
*v
= XVECTOR (dv
);
6969 /* Return the first character from the display table
6970 entry, if not empty. If empty, don't display the
6971 current character. */
6974 it
->dpvec_char_len
= it
->len
;
6975 it
->dpvec
= v
->contents
;
6976 it
->dpend
= v
->contents
+ v
->header
.size
;
6977 it
->current
.dpvec_index
= 0;
6978 it
->dpvec_face_id
= -1;
6979 it
->saved_face_id
= it
->face_id
;
6980 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6981 it
->ellipsis_p
= false;
6985 set_iterator_to_next (it
, false);
6990 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6992 if (it
->what
== IT_GLYPHLESS
)
6994 /* Don't display this character. */
6995 set_iterator_to_next (it
, false);
6999 /* If `nobreak-char-display' is non-nil, we display
7000 non-ASCII spaces and hyphens specially. */
7001 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7003 if (c
== NO_BREAK_SPACE
)
7004 nonascii_space_p
= true;
7005 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
7006 || c
== NON_BREAKING_HYPHEN
)
7007 nonascii_hyphen_p
= true;
7010 /* Translate control characters into `\003' or `^C' form.
7011 Control characters coming from a display table entry are
7012 currently not translated because we use IT->dpvec to hold
7013 the translation. This could easily be changed but I
7014 don't believe that it is worth doing.
7016 The characters handled by `nobreak-char-display' must be
7019 Non-printable characters and raw-byte characters are also
7020 translated to octal form. */
7021 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7022 ? (it
->area
!= TEXT_AREA
7023 /* In mode line, treat \n, \t like other crl chars. */
7026 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7027 || (c
!= '\n' && c
!= '\t'))
7029 || nonascii_hyphen_p
7031 || ! CHAR_PRINTABLE_P (c
))))
7033 /* C is a control character, non-ASCII space/hyphen,
7034 raw-byte, or a non-printable character which must be
7035 displayed either as '\003' or as `^C' where the '\\'
7036 and '^' can be defined in the display table. Fill
7037 IT->ctl_chars with glyphs for what we have to
7038 display. Then, set IT->dpvec to these glyphs. */
7045 /* Handle control characters with ^. */
7047 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7051 g
= '^'; /* default glyph for Control */
7052 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7054 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7056 g
= GLYPH_CODE_CHAR (gc
);
7057 lface_id
= GLYPH_CODE_FACE (gc
);
7061 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7062 : merge_escape_glyph_face (it
));
7064 XSETINT (it
->ctl_chars
[0], g
);
7065 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7067 goto display_control
;
7070 /* Handle non-ascii space in the mode where it only gets
7073 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7075 /* Merge `nobreak-space' into the current face. */
7076 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7078 XSETINT (it
->ctl_chars
[0], ' ');
7080 goto display_control
;
7083 /* Handle sequences that start with the "escape glyph". */
7085 /* the default escape glyph is \. */
7086 escape_glyph
= '\\';
7089 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7091 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7092 lface_id
= GLYPH_CODE_FACE (gc
);
7096 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7097 : merge_escape_glyph_face (it
));
7099 /* Draw non-ASCII hyphen with just highlighting: */
7101 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7103 XSETINT (it
->ctl_chars
[0], '-');
7105 goto display_control
;
7108 /* Draw non-ASCII space/hyphen with escape glyph: */
7110 if (nonascii_space_p
|| nonascii_hyphen_p
)
7112 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7113 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7115 goto display_control
;
7122 if (CHAR_BYTE8_P (c
))
7123 /* Display \200 instead of \17777600. */
7124 c
= CHAR_TO_BYTE8 (c
);
7125 len
= sprintf (str
, "%03o", c
+ 0u);
7127 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7128 for (i
= 0; i
< len
; i
++)
7129 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7134 /* Set up IT->dpvec and return first character from it. */
7135 it
->dpvec_char_len
= it
->len
;
7136 it
->dpvec
= it
->ctl_chars
;
7137 it
->dpend
= it
->dpvec
+ ctl_len
;
7138 it
->current
.dpvec_index
= 0;
7139 it
->dpvec_face_id
= face_id
;
7140 it
->saved_face_id
= it
->face_id
;
7141 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7142 it
->ellipsis_p
= false;
7145 it
->char_to_display
= c
;
7149 it
->char_to_display
= it
->c
;
7153 #ifdef HAVE_WINDOW_SYSTEM
7154 /* Adjust face id for a multibyte character. There are no multibyte
7155 character in unibyte text. */
7156 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7159 && FRAME_WINDOW_P (it
->f
))
7161 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7163 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7165 /* Automatic composition with glyph-string. */
7166 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7168 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7172 ptrdiff_t pos
= (it
->s
? -1
7173 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7174 : IT_CHARPOS (*it
));
7177 if (it
->what
== IT_CHARACTER
)
7178 c
= it
->char_to_display
;
7181 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7185 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7186 /* TAB in a composition means display glyphs with
7187 padding space on the left or right. */
7188 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7191 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7194 #endif /* HAVE_WINDOW_SYSTEM */
7197 /* Is this character the last one of a run of characters with
7198 box? If yes, set IT->end_of_box_run_p to true. */
7202 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7204 int face_id
= underlying_face_id (it
);
7205 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7209 if (face
->box
== FACE_NO_BOX
)
7211 /* If the box comes from face properties in a
7212 display string, check faces in that string. */
7213 int string_face_id
= face_after_it_pos (it
);
7214 it
->end_of_box_run_p
7215 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7218 /* Otherwise, the box comes from the underlying face.
7219 If this is the last string character displayed, check
7220 the next buffer location. */
7221 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7222 /* n_overlay_strings is unreliable unless
7223 overlay_string_index is non-negative. */
7224 && ((it
->current
.overlay_string_index
>= 0
7225 && (it
->current
.overlay_string_index
7226 == it
->n_overlay_strings
- 1))
7227 /* A string from display property. */
7228 || it
->from_disp_prop_p
))
7232 struct text_pos pos
= it
->current
.pos
;
7234 /* For a string from a display property, the next
7235 buffer position is stored in the 'position'
7236 member of the iteration stack slot below the
7237 current one, see handle_single_display_spec. By
7238 contrast, it->current.pos was not yet updated
7239 to point to that buffer position; that will
7240 happen in pop_it, after we finish displaying the
7241 current string. Note that we already checked
7242 above that it->sp is positive, so subtracting one
7244 if (it
->from_disp_prop_p
)
7246 int stackp
= it
->sp
- 1;
7248 /* Find the stack level with data from buffer. */
7250 && STRINGP ((it
->stack
+ stackp
)->string
))
7252 eassert (stackp
>= 0);
7253 pos
= (it
->stack
+ stackp
)->position
;
7256 INC_TEXT_POS (pos
, it
->multibyte_p
);
7258 if (CHARPOS (pos
) >= ZV
)
7259 it
->end_of_box_run_p
= true;
7262 next_face_id
= face_at_buffer_position
7263 (it
->w
, CHARPOS (pos
), &ignore
,
7264 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7265 it
->end_of_box_run_p
7266 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7272 /* next_element_from_display_vector sets this flag according to
7273 faces of the display vector glyphs, see there. */
7274 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7276 int face_id
= face_after_it_pos (it
);
7277 it
->end_of_box_run_p
7278 = (face_id
!= it
->face_id
7279 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7282 /* If we reached the end of the object we've been iterating (e.g., a
7283 display string or an overlay string), and there's something on
7284 IT->stack, proceed with what's on the stack. It doesn't make
7285 sense to return false if there's unprocessed stuff on the stack,
7286 because otherwise that stuff will never be displayed. */
7287 if (!success_p
&& it
->sp
> 0)
7289 set_iterator_to_next (it
, false);
7290 success_p
= get_next_display_element (it
);
7293 /* Value is false if end of buffer or string reached. */
7298 /* Move IT to the next display element.
7300 RESEAT_P means if called on a newline in buffer text,
7301 skip to the next visible line start.
7303 Functions get_next_display_element and set_iterator_to_next are
7304 separate because I find this arrangement easier to handle than a
7305 get_next_display_element function that also increments IT's
7306 position. The way it is we can first look at an iterator's current
7307 display element, decide whether it fits on a line, and if it does,
7308 increment the iterator position. The other way around we probably
7309 would either need a flag indicating whether the iterator has to be
7310 incremented the next time, or we would have to implement a
7311 decrement position function which would not be easy to write. */
7314 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7316 /* Reset flags indicating start and end of a sequence of characters
7317 with box. Reset them at the start of this function because
7318 moving the iterator to a new position might set them. */
7319 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7323 case GET_FROM_BUFFER
:
7324 /* The current display element of IT is a character from
7325 current_buffer. Advance in the buffer, and maybe skip over
7326 invisible lines that are so because of selective display. */
7327 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7328 reseat_at_next_visible_line_start (it
, false);
7329 else if (it
->cmp_it
.id
>= 0)
7331 /* We are currently getting glyphs from a composition. */
7334 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7335 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7341 /* Update IT's char/byte positions to point to the first
7342 character of the next grapheme cluster, or to the
7343 character visually after the current composition. */
7344 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7345 bidi_move_to_visually_next (&it
->bidi_it
);
7346 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7347 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7350 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7351 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7353 /* Composition created while scanning forward. Proceed
7354 to the next grapheme cluster. */
7355 it
->cmp_it
.from
= it
->cmp_it
.to
;
7357 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7358 && it
->cmp_it
.from
> 0)
7360 /* Composition created while scanning backward. Proceed
7361 to the previous grapheme cluster. */
7362 it
->cmp_it
.to
= it
->cmp_it
.from
;
7366 /* No more grapheme clusters in this composition.
7367 Find the next stop position. */
7368 ptrdiff_t stop
= it
->end_charpos
;
7370 if (it
->bidi_it
.scan_dir
< 0)
7371 /* Now we are scanning backward and don't know
7374 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7375 IT_BYTEPOS (*it
), stop
, Qnil
);
7380 eassert (it
->len
!= 0);
7384 IT_BYTEPOS (*it
) += it
->len
;
7385 IT_CHARPOS (*it
) += 1;
7389 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7390 /* If this is a new paragraph, determine its base
7391 direction (a.k.a. its base embedding level). */
7392 if (it
->bidi_it
.new_paragraph
)
7393 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7395 bidi_move_to_visually_next (&it
->bidi_it
);
7396 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7397 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7398 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7400 /* As the scan direction was changed, we must
7401 re-compute the stop position for composition. */
7402 ptrdiff_t stop
= it
->end_charpos
;
7403 if (it
->bidi_it
.scan_dir
< 0)
7405 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7406 IT_BYTEPOS (*it
), stop
, Qnil
);
7409 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7413 case GET_FROM_C_STRING
:
7414 /* Current display element of IT is from a C string. */
7416 /* If the string position is beyond string's end, it means
7417 next_element_from_c_string is padding the string with
7418 blanks, in which case we bypass the bidi iterator,
7419 because it cannot deal with such virtual characters. */
7420 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7422 IT_BYTEPOS (*it
) += it
->len
;
7423 IT_CHARPOS (*it
) += 1;
7427 bidi_move_to_visually_next (&it
->bidi_it
);
7428 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7429 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7433 case GET_FROM_DISPLAY_VECTOR
:
7434 /* Current display element of IT is from a display table entry.
7435 Advance in the display table definition. Reset it to null if
7436 end reached, and continue with characters from buffers/
7438 ++it
->current
.dpvec_index
;
7440 /* Restore face of the iterator to what they were before the
7441 display vector entry (these entries may contain faces). */
7442 it
->face_id
= it
->saved_face_id
;
7444 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7446 bool recheck_faces
= it
->ellipsis_p
;
7449 it
->method
= GET_FROM_C_STRING
;
7450 else if (STRINGP (it
->string
))
7451 it
->method
= GET_FROM_STRING
;
7454 it
->method
= GET_FROM_BUFFER
;
7455 it
->object
= it
->w
->contents
;
7459 it
->current
.dpvec_index
= -1;
7461 /* Skip over characters which were displayed via IT->dpvec. */
7462 if (it
->dpvec_char_len
< 0)
7463 reseat_at_next_visible_line_start (it
, true);
7464 else if (it
->dpvec_char_len
> 0)
7466 it
->len
= it
->dpvec_char_len
;
7467 set_iterator_to_next (it
, reseat_p
);
7470 /* Maybe recheck faces after display vector. */
7473 if (it
->method
== GET_FROM_STRING
)
7474 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7476 it
->stop_charpos
= IT_CHARPOS (*it
);
7481 case GET_FROM_STRING
:
7482 /* Current display element is a character from a Lisp string. */
7483 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7484 /* Don't advance past string end. These conditions are true
7485 when set_iterator_to_next is called at the end of
7486 get_next_display_element, in which case the Lisp string is
7487 already exhausted, and all we want is pop the iterator
7489 if (it
->current
.overlay_string_index
>= 0)
7491 /* This is an overlay string, so there's no padding with
7492 spaces, and the number of characters in the string is
7493 where the string ends. */
7494 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7495 goto consider_string_end
;
7499 /* Not an overlay string. There could be padding, so test
7500 against it->end_charpos. */
7501 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7502 goto consider_string_end
;
7504 if (it
->cmp_it
.id
>= 0)
7506 /* We are delivering display elements from a composition.
7507 Update the string position past the grapheme cluster
7508 we've just processed. */
7511 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7512 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7518 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7519 bidi_move_to_visually_next (&it
->bidi_it
);
7520 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7521 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7524 /* Did we exhaust all the grapheme clusters of this
7526 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7527 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7529 /* Not all the grapheme clusters were processed yet;
7530 advance to the next cluster. */
7531 it
->cmp_it
.from
= it
->cmp_it
.to
;
7533 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7534 && it
->cmp_it
.from
> 0)
7536 /* Likewise: advance to the next cluster, but going in
7537 the reverse direction. */
7538 it
->cmp_it
.to
= it
->cmp_it
.from
;
7542 /* This composition was fully processed; find the next
7543 candidate place for checking for composed
7545 /* Always limit string searches to the string length;
7546 any padding spaces are not part of the string, and
7547 there cannot be any compositions in that padding. */
7548 ptrdiff_t stop
= SCHARS (it
->string
);
7550 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7552 else if (it
->end_charpos
< stop
)
7554 /* Cf. PRECISION in reseat_to_string: we might be
7555 limited in how many of the string characters we
7557 stop
= it
->end_charpos
;
7559 composition_compute_stop_pos (&it
->cmp_it
,
7560 IT_STRING_CHARPOS (*it
),
7561 IT_STRING_BYTEPOS (*it
), stop
,
7568 /* If the string position is beyond string's end, it
7569 means next_element_from_string is padding the string
7570 with blanks, in which case we bypass the bidi
7571 iterator, because it cannot deal with such virtual
7573 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7575 IT_STRING_BYTEPOS (*it
) += it
->len
;
7576 IT_STRING_CHARPOS (*it
) += 1;
7580 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7582 bidi_move_to_visually_next (&it
->bidi_it
);
7583 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7584 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7585 /* If the scan direction changes, we may need to update
7586 the place where to check for composed characters. */
7587 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7589 ptrdiff_t stop
= SCHARS (it
->string
);
7591 if (it
->bidi_it
.scan_dir
< 0)
7593 else if (it
->end_charpos
< stop
)
7594 stop
= it
->end_charpos
;
7596 composition_compute_stop_pos (&it
->cmp_it
,
7597 IT_STRING_CHARPOS (*it
),
7598 IT_STRING_BYTEPOS (*it
), stop
,
7604 consider_string_end
:
7606 if (it
->current
.overlay_string_index
>= 0)
7608 /* IT->string is an overlay string. Advance to the
7609 next, if there is one. */
7610 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7612 it
->ellipsis_p
= false;
7613 next_overlay_string (it
);
7615 setup_for_ellipsis (it
, 0);
7620 /* IT->string is not an overlay string. If we reached
7621 its end, and there is something on IT->stack, proceed
7622 with what is on the stack. This can be either another
7623 string, this time an overlay string, or a buffer. */
7624 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7628 if (it
->method
== GET_FROM_STRING
)
7629 goto consider_string_end
;
7634 case GET_FROM_IMAGE
:
7635 case GET_FROM_STRETCH
:
7636 case GET_FROM_XWIDGET
:
7638 /* The position etc with which we have to proceed are on
7639 the stack. The position may be at the end of a string,
7640 if the `display' property takes up the whole string. */
7641 eassert (it
->sp
> 0);
7643 if (it
->method
== GET_FROM_STRING
)
7644 goto consider_string_end
;
7648 /* There are no other methods defined, so this should be a bug. */
7652 eassert (it
->method
!= GET_FROM_STRING
7653 || (STRINGP (it
->string
)
7654 && IT_STRING_CHARPOS (*it
) >= 0));
7657 /* Load IT's display element fields with information about the next
7658 display element which comes from a display table entry or from the
7659 result of translating a control character to one of the forms `^C'
7662 IT->dpvec holds the glyphs to return as characters.
7663 IT->saved_face_id holds the face id before the display vector--it
7664 is restored into IT->face_id in set_iterator_to_next. */
7667 next_element_from_display_vector (struct it
*it
)
7670 int prev_face_id
= it
->face_id
;
7674 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7676 it
->face_id
= it
->saved_face_id
;
7678 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7679 That seemed totally bogus - so I changed it... */
7680 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7682 if (GLYPH_CODE_P (gc
))
7684 struct face
*this_face
, *prev_face
, *next_face
;
7686 it
->c
= GLYPH_CODE_CHAR (gc
);
7687 it
->len
= CHAR_BYTES (it
->c
);
7689 /* The entry may contain a face id to use. Such a face id is
7690 the id of a Lisp face, not a realized face. A face id of
7691 zero means no face is specified. */
7692 if (it
->dpvec_face_id
>= 0)
7693 it
->face_id
= it
->dpvec_face_id
;
7696 int lface_id
= GLYPH_CODE_FACE (gc
);
7698 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7702 /* Glyphs in the display vector could have the box face, so we
7703 need to set the related flags in the iterator, as
7705 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7706 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7708 /* Is this character the first character of a box-face run? */
7709 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7711 || prev_face
->box
== FACE_NO_BOX
));
7713 /* For the last character of the box-face run, we need to look
7714 either at the next glyph from the display vector, or at the
7715 face we saw before the display vector. */
7716 next_face_id
= it
->saved_face_id
;
7717 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7719 if (it
->dpvec_face_id
>= 0)
7720 next_face_id
= it
->dpvec_face_id
;
7724 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7727 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7731 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7732 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7734 || next_face
->box
== FACE_NO_BOX
));
7735 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7738 /* Display table entry is invalid. Return a space. */
7739 it
->c
= ' ', it
->len
= 1;
7741 /* Don't change position and object of the iterator here. They are
7742 still the values of the character that had this display table
7743 entry or was translated, and that's what we want. */
7744 it
->what
= IT_CHARACTER
;
7748 /* Get the first element of string/buffer in the visual order, after
7749 being reseated to a new position in a string or a buffer. */
7751 get_visually_first_element (struct it
*it
)
7753 bool string_p
= STRINGP (it
->string
) || it
->s
;
7754 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7755 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7757 if (STRINGP (it
->string
))
7759 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7760 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7764 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7765 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7768 if (it
->bidi_it
.charpos
== eob
)
7770 /* Nothing to do, but reset the FIRST_ELT flag, like
7771 bidi_paragraph_init does, because we are not going to
7773 it
->bidi_it
.first_elt
= false;
7775 else if (it
->bidi_it
.charpos
== bob
7777 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7778 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7780 /* If we are at the beginning of a line/string, we can produce
7781 the next element right away. */
7782 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7783 bidi_move_to_visually_next (&it
->bidi_it
);
7787 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7789 /* We need to prime the bidi iterator starting at the line's or
7790 string's beginning, before we will be able to produce the
7793 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7795 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7796 IT_BYTEPOS (*it
), -1,
7797 &it
->bidi_it
.bytepos
);
7798 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7801 /* Now return to buffer/string position where we were asked
7802 to get the next display element, and produce that. */
7803 bidi_move_to_visually_next (&it
->bidi_it
);
7805 while (it
->bidi_it
.bytepos
!= orig_bytepos
7806 && it
->bidi_it
.charpos
< eob
);
7809 /* Adjust IT's position information to where we ended up. */
7810 if (STRINGP (it
->string
))
7812 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7813 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7817 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7818 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7821 if (STRINGP (it
->string
) || !it
->s
)
7823 ptrdiff_t stop
, charpos
, bytepos
;
7825 if (STRINGP (it
->string
))
7828 stop
= SCHARS (it
->string
);
7829 if (stop
> it
->end_charpos
)
7830 stop
= it
->end_charpos
;
7831 charpos
= IT_STRING_CHARPOS (*it
);
7832 bytepos
= IT_STRING_BYTEPOS (*it
);
7836 stop
= it
->end_charpos
;
7837 charpos
= IT_CHARPOS (*it
);
7838 bytepos
= IT_BYTEPOS (*it
);
7840 if (it
->bidi_it
.scan_dir
< 0)
7842 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7847 /* Load IT with the next display element from Lisp string IT->string.
7848 IT->current.string_pos is the current position within the string.
7849 If IT->current.overlay_string_index >= 0, the Lisp string is an
7853 next_element_from_string (struct it
*it
)
7855 struct text_pos position
;
7857 eassert (STRINGP (it
->string
));
7858 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7859 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7860 position
= it
->current
.string_pos
;
7862 /* With bidi reordering, the character to display might not be the
7863 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7864 that we were reseat()ed to a new string, whose paragraph
7865 direction is not known. */
7866 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7868 get_visually_first_element (it
);
7869 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7872 /* Time to check for invisible text? */
7873 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7875 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7878 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7879 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7881 /* With bidi non-linear iteration, we could find
7882 ourselves far beyond the last computed stop_charpos,
7883 with several other stop positions in between that we
7884 missed. Scan them all now, in buffer's logical
7885 order, until we find and handle the last stop_charpos
7886 that precedes our current position. */
7887 handle_stop_backwards (it
, it
->stop_charpos
);
7888 return GET_NEXT_DISPLAY_ELEMENT (it
);
7894 /* Take note of the stop position we just moved
7895 across, for when we will move back across it. */
7896 it
->prev_stop
= it
->stop_charpos
;
7897 /* If we are at base paragraph embedding level, take
7898 note of the last stop position seen at this
7900 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7901 it
->base_level_stop
= it
->stop_charpos
;
7905 /* Since a handler may have changed IT->method, we must
7907 return GET_NEXT_DISPLAY_ELEMENT (it
);
7911 /* If we are before prev_stop, we may have overstepped
7912 on our way backwards a stop_pos, and if so, we need
7913 to handle that stop_pos. */
7914 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7915 /* We can sometimes back up for reasons that have nothing
7916 to do with bidi reordering. E.g., compositions. The
7917 code below is only needed when we are above the base
7918 embedding level, so test for that explicitly. */
7919 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7921 /* If we lost track of base_level_stop, we have no better
7922 place for handle_stop_backwards to start from than string
7923 beginning. This happens, e.g., when we were reseated to
7924 the previous screenful of text by vertical-motion. */
7925 if (it
->base_level_stop
<= 0
7926 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7927 it
->base_level_stop
= 0;
7928 handle_stop_backwards (it
, it
->base_level_stop
);
7929 return GET_NEXT_DISPLAY_ELEMENT (it
);
7933 if (it
->current
.overlay_string_index
>= 0)
7935 /* Get the next character from an overlay string. In overlay
7936 strings, there is no field width or padding with spaces to
7938 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7943 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7944 IT_STRING_BYTEPOS (*it
),
7945 it
->bidi_it
.scan_dir
< 0
7947 : SCHARS (it
->string
))
7948 && next_element_from_composition (it
))
7952 else if (STRING_MULTIBYTE (it
->string
))
7954 const unsigned char *s
= (SDATA (it
->string
)
7955 + IT_STRING_BYTEPOS (*it
));
7956 it
->c
= string_char_and_length (s
, &it
->len
);
7960 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7966 /* Get the next character from a Lisp string that is not an
7967 overlay string. Such strings come from the mode line, for
7968 example. We may have to pad with spaces, or truncate the
7969 string. See also next_element_from_c_string. */
7970 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7975 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7977 /* Pad with spaces. */
7978 it
->c
= ' ', it
->len
= 1;
7979 CHARPOS (position
) = BYTEPOS (position
) = -1;
7981 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7982 IT_STRING_BYTEPOS (*it
),
7983 it
->bidi_it
.scan_dir
< 0
7985 : it
->string_nchars
)
7986 && next_element_from_composition (it
))
7990 else if (STRING_MULTIBYTE (it
->string
))
7992 const unsigned char *s
= (SDATA (it
->string
)
7993 + IT_STRING_BYTEPOS (*it
));
7994 it
->c
= string_char_and_length (s
, &it
->len
);
7998 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8003 /* Record what we have and where it came from. */
8004 it
->what
= IT_CHARACTER
;
8005 it
->object
= it
->string
;
8006 it
->position
= position
;
8011 /* Load IT with next display element from C string IT->s.
8012 IT->string_nchars is the maximum number of characters to return
8013 from the string. IT->end_charpos may be greater than
8014 IT->string_nchars when this function is called, in which case we
8015 may have to return padding spaces. Value is false if end of string
8016 reached, including padding spaces. */
8019 next_element_from_c_string (struct it
*it
)
8021 bool success_p
= true;
8024 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8025 it
->what
= IT_CHARACTER
;
8026 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8027 it
->object
= make_number (0);
8029 /* With bidi reordering, the character to display might not be the
8030 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8031 we were reseated to a new string, whose paragraph direction is
8033 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8034 get_visually_first_element (it
);
8036 /* IT's position can be greater than IT->string_nchars in case a
8037 field width or precision has been specified when the iterator was
8039 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8041 /* End of the game. */
8045 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8047 /* Pad with spaces. */
8048 it
->c
= ' ', it
->len
= 1;
8049 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8051 else if (it
->multibyte_p
)
8052 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8054 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8060 /* Set up IT to return characters from an ellipsis, if appropriate.
8061 The definition of the ellipsis glyphs may come from a display table
8062 entry. This function fills IT with the first glyph from the
8063 ellipsis if an ellipsis is to be displayed. */
8066 next_element_from_ellipsis (struct it
*it
)
8068 if (it
->selective_display_ellipsis_p
)
8069 setup_for_ellipsis (it
, it
->len
);
8072 /* The face at the current position may be different from the
8073 face we find after the invisible text. Remember what it
8074 was in IT->saved_face_id, and signal that it's there by
8075 setting face_before_selective_p. */
8076 it
->saved_face_id
= it
->face_id
;
8077 it
->method
= GET_FROM_BUFFER
;
8078 it
->object
= it
->w
->contents
;
8079 reseat_at_next_visible_line_start (it
, true);
8080 it
->face_before_selective_p
= true;
8083 return GET_NEXT_DISPLAY_ELEMENT (it
);
8087 /* Deliver an image display element. The iterator IT is already
8088 filled with image information (done in handle_display_prop). Value
8093 next_element_from_image (struct it
*it
)
8095 it
->what
= IT_IMAGE
;
8100 next_element_from_xwidget (struct it
*it
)
8102 it
->what
= IT_XWIDGET
;
8107 /* Fill iterator IT with next display element from a stretch glyph
8108 property. IT->object is the value of the text property. Value is
8112 next_element_from_stretch (struct it
*it
)
8114 it
->what
= IT_STRETCH
;
8118 /* Scan backwards from IT's current position until we find a stop
8119 position, or until BEGV. This is called when we find ourself
8120 before both the last known prev_stop and base_level_stop while
8121 reordering bidirectional text. */
8124 compute_stop_pos_backwards (struct it
*it
)
8126 const int SCAN_BACK_LIMIT
= 1000;
8127 struct text_pos pos
;
8128 struct display_pos save_current
= it
->current
;
8129 struct text_pos save_position
= it
->position
;
8130 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8131 ptrdiff_t where_we_are
= charpos
;
8132 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8133 ptrdiff_t save_end_pos
= it
->end_charpos
;
8135 eassert (NILP (it
->string
) && !it
->s
);
8136 eassert (it
->bidi_p
);
8140 it
->end_charpos
= min (charpos
+ 1, ZV
);
8141 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8142 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8143 reseat_1 (it
, pos
, false);
8144 compute_stop_pos (it
);
8145 /* We must advance forward, right? */
8146 if (it
->stop_charpos
<= charpos
)
8149 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8151 if (it
->stop_charpos
<= where_we_are
)
8152 it
->prev_stop
= it
->stop_charpos
;
8154 it
->prev_stop
= BEGV
;
8156 it
->current
= save_current
;
8157 it
->position
= save_position
;
8158 it
->stop_charpos
= save_stop_pos
;
8159 it
->end_charpos
= save_end_pos
;
8162 /* Scan forward from CHARPOS in the current buffer/string, until we
8163 find a stop position > current IT's position. Then handle the stop
8164 position before that. This is called when we bump into a stop
8165 position while reordering bidirectional text. CHARPOS should be
8166 the last previously processed stop_pos (or BEGV/0, if none were
8167 processed yet) whose position is less that IT's current
8171 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8173 bool bufp
= !STRINGP (it
->string
);
8174 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8175 struct display_pos save_current
= it
->current
;
8176 struct text_pos save_position
= it
->position
;
8177 struct text_pos pos1
;
8178 ptrdiff_t next_stop
;
8180 /* Scan in strict logical order. */
8181 eassert (it
->bidi_p
);
8185 it
->prev_stop
= charpos
;
8188 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8189 reseat_1 (it
, pos1
, false);
8192 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8193 compute_stop_pos (it
);
8194 /* We must advance forward, right? */
8195 if (it
->stop_charpos
<= it
->prev_stop
)
8197 charpos
= it
->stop_charpos
;
8199 while (charpos
<= where_we_are
);
8202 it
->current
= save_current
;
8203 it
->position
= save_position
;
8204 next_stop
= it
->stop_charpos
;
8205 it
->stop_charpos
= it
->prev_stop
;
8207 it
->stop_charpos
= next_stop
;
8210 /* Load IT with the next display element from current_buffer. Value
8211 is false if end of buffer reached. IT->stop_charpos is the next
8212 position at which to stop and check for text properties or buffer
8216 next_element_from_buffer (struct it
*it
)
8218 bool success_p
= true;
8220 eassert (IT_CHARPOS (*it
) >= BEGV
);
8221 eassert (NILP (it
->string
) && !it
->s
);
8222 eassert (!it
->bidi_p
8223 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8224 && it
->bidi_it
.string
.s
== NULL
));
8226 /* With bidi reordering, the character to display might not be the
8227 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8228 we were reseat()ed to a new buffer position, which is potentially
8229 a different paragraph. */
8230 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8232 get_visually_first_element (it
);
8233 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8236 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8238 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8240 bool overlay_strings_follow_p
;
8242 /* End of the game, except when overlay strings follow that
8243 haven't been returned yet. */
8244 if (it
->overlay_strings_at_end_processed_p
)
8245 overlay_strings_follow_p
= false;
8248 it
->overlay_strings_at_end_processed_p
= true;
8249 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8252 if (overlay_strings_follow_p
)
8253 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8257 it
->position
= it
->current
.pos
;
8261 else if (!(!it
->bidi_p
8262 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8263 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8265 /* With bidi non-linear iteration, we could find ourselves
8266 far beyond the last computed stop_charpos, with several
8267 other stop positions in between that we missed. Scan
8268 them all now, in buffer's logical order, until we find
8269 and handle the last stop_charpos that precedes our
8270 current position. */
8271 handle_stop_backwards (it
, it
->stop_charpos
);
8272 it
->ignore_overlay_strings_at_pos_p
= false;
8273 return GET_NEXT_DISPLAY_ELEMENT (it
);
8279 /* Take note of the stop position we just moved across,
8280 for when we will move back across it. */
8281 it
->prev_stop
= it
->stop_charpos
;
8282 /* If we are at base paragraph embedding level, take
8283 note of the last stop position seen at this
8285 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8286 it
->base_level_stop
= it
->stop_charpos
;
8289 it
->ignore_overlay_strings_at_pos_p
= false;
8290 return GET_NEXT_DISPLAY_ELEMENT (it
);
8294 /* If we are before prev_stop, we may have overstepped on
8295 our way backwards a stop_pos, and if so, we need to
8296 handle that stop_pos. */
8297 && IT_CHARPOS (*it
) < it
->prev_stop
8298 /* We can sometimes back up for reasons that have nothing
8299 to do with bidi reordering. E.g., compositions. The
8300 code below is only needed when we are above the base
8301 embedding level, so test for that explicitly. */
8302 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8304 if (it
->base_level_stop
<= 0
8305 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8307 /* If we lost track of base_level_stop, we need to find
8308 prev_stop by looking backwards. This happens, e.g., when
8309 we were reseated to the previous screenful of text by
8311 it
->base_level_stop
= BEGV
;
8312 compute_stop_pos_backwards (it
);
8313 handle_stop_backwards (it
, it
->prev_stop
);
8316 handle_stop_backwards (it
, it
->base_level_stop
);
8317 it
->ignore_overlay_strings_at_pos_p
= false;
8318 return GET_NEXT_DISPLAY_ELEMENT (it
);
8322 /* No face changes, overlays etc. in sight, so just return a
8323 character from current_buffer. */
8327 /* We moved to the next buffer position, so any info about
8328 previously seen overlays is no longer valid. */
8329 it
->ignore_overlay_strings_at_pos_p
= false;
8331 /* Maybe run the redisplay end trigger hook. Performance note:
8332 This doesn't seem to cost measurable time. */
8333 if (it
->redisplay_end_trigger_charpos
8335 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8336 run_redisplay_end_trigger_hook (it
);
8338 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8339 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8341 && next_element_from_composition (it
))
8346 /* Get the next character, maybe multibyte. */
8347 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8348 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8349 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8351 it
->c
= *p
, it
->len
= 1;
8353 /* Record what we have and where it came from. */
8354 it
->what
= IT_CHARACTER
;
8355 it
->object
= it
->w
->contents
;
8356 it
->position
= it
->current
.pos
;
8358 /* Normally we return the character found above, except when we
8359 really want to return an ellipsis for selective display. */
8364 /* A value of selective > 0 means hide lines indented more
8365 than that number of columns. */
8366 if (it
->selective
> 0
8367 && IT_CHARPOS (*it
) + 1 < ZV
8368 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8369 IT_BYTEPOS (*it
) + 1,
8372 success_p
= next_element_from_ellipsis (it
);
8373 it
->dpvec_char_len
= -1;
8376 else if (it
->c
== '\r' && it
->selective
== -1)
8378 /* A value of selective == -1 means that everything from the
8379 CR to the end of the line is invisible, with maybe an
8380 ellipsis displayed for it. */
8381 success_p
= next_element_from_ellipsis (it
);
8382 it
->dpvec_char_len
= -1;
8387 /* Value is false if end of buffer reached. */
8388 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8393 /* Run the redisplay end trigger hook for IT. */
8396 run_redisplay_end_trigger_hook (struct it
*it
)
8398 /* IT->glyph_row should be non-null, i.e. we should be actually
8399 displaying something, or otherwise we should not run the hook. */
8400 eassert (it
->glyph_row
);
8402 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8403 it
->redisplay_end_trigger_charpos
= 0;
8405 /* Since we are *trying* to run these functions, don't try to run
8406 them again, even if they get an error. */
8407 wset_redisplay_end_trigger (it
->w
, Qnil
);
8408 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8409 make_number (charpos
));
8411 /* Notice if it changed the face of the character we are on. */
8412 handle_face_prop (it
);
8416 /* Deliver a composition display element. Unlike the other
8417 next_element_from_XXX, this function is not registered in the array
8418 get_next_element[]. It is called from next_element_from_buffer and
8419 next_element_from_string when necessary. */
8422 next_element_from_composition (struct it
*it
)
8424 it
->what
= IT_COMPOSITION
;
8425 it
->len
= it
->cmp_it
.nbytes
;
8426 if (STRINGP (it
->string
))
8430 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8431 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8434 it
->position
= it
->current
.string_pos
;
8435 it
->object
= it
->string
;
8436 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8437 IT_STRING_BYTEPOS (*it
), it
->string
);
8443 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8444 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8447 if (it
->bidi_it
.new_paragraph
)
8448 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8450 /* Resync the bidi iterator with IT's new position.
8451 FIXME: this doesn't support bidirectional text. */
8452 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8453 bidi_move_to_visually_next (&it
->bidi_it
);
8457 it
->position
= it
->current
.pos
;
8458 it
->object
= it
->w
->contents
;
8459 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8460 IT_BYTEPOS (*it
), Qnil
);
8467 /***********************************************************************
8468 Moving an iterator without producing glyphs
8469 ***********************************************************************/
8471 /* Check if iterator is at a position corresponding to a valid buffer
8472 position after some move_it_ call. */
8474 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8475 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8478 /* Move iterator IT to a specified buffer or X position within one
8479 line on the display without producing glyphs.
8481 OP should be a bit mask including some or all of these bits:
8482 MOVE_TO_X: Stop upon reaching x-position TO_X.
8483 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8484 Regardless of OP's value, stop upon reaching the end of the display line.
8486 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8487 This means, in particular, that TO_X includes window's horizontal
8490 The return value has several possible values that
8491 say what condition caused the scan to stop:
8493 MOVE_POS_MATCH_OR_ZV
8494 - when TO_POS or ZV was reached.
8497 -when TO_X was reached before TO_POS or ZV were reached.
8500 - when we reached the end of the display area and the line must
8504 - when we reached the end of the display area and the line is
8508 - when we stopped at a line end, i.e. a newline or a CR and selective
8511 static enum move_it_result
8512 move_it_in_display_line_to (struct it
*it
,
8513 ptrdiff_t to_charpos
, int to_x
,
8514 enum move_operation_enum op
)
8516 enum move_it_result result
= MOVE_UNDEFINED
;
8517 struct glyph_row
*saved_glyph_row
;
8518 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8519 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8520 void *ppos_data
= NULL
;
8521 bool may_wrap
= false;
8522 enum it_method prev_method
= it
->method
;
8523 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8524 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8526 /* Don't produce glyphs in produce_glyphs. */
8527 saved_glyph_row
= it
->glyph_row
;
8528 it
->glyph_row
= NULL
;
8530 /* Use wrap_it to save a copy of IT wherever a word wrap could
8531 occur. Use atpos_it to save a copy of IT at the desired buffer
8532 position, if found, so that we can scan ahead and check if the
8533 word later overshoots the window edge. Use atx_it similarly, for
8539 /* Use ppos_it under bidi reordering to save a copy of IT for the
8540 initial position. We restore that position in IT when we have
8541 scanned the entire display line without finding a match for
8542 TO_CHARPOS and all the character positions are greater than
8543 TO_CHARPOS. We then restart the scan from the initial position,
8544 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8545 the closest to TO_CHARPOS. */
8548 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8550 SAVE_IT (ppos_it
, *it
, ppos_data
);
8551 closest_pos
= IT_CHARPOS (*it
);
8557 #define BUFFER_POS_REACHED_P() \
8558 ((op & MOVE_TO_POS) != 0 \
8559 && BUFFERP (it->object) \
8560 && (IT_CHARPOS (*it) == to_charpos \
8562 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8563 && IT_CHARPOS (*it) > to_charpos) \
8564 || (it->what == IT_COMPOSITION \
8565 && ((IT_CHARPOS (*it) > to_charpos \
8566 && to_charpos >= it->cmp_it.charpos) \
8567 || (IT_CHARPOS (*it) < to_charpos \
8568 && to_charpos <= it->cmp_it.charpos)))) \
8569 && (it->method == GET_FROM_BUFFER \
8570 || (it->method == GET_FROM_DISPLAY_VECTOR \
8571 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8573 /* If there's a line-/wrap-prefix, handle it. */
8574 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8575 && it
->current_y
< it
->last_visible_y
)
8576 handle_line_prefix (it
);
8578 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8579 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8583 int x
, i
, ascent
= 0, descent
= 0;
8585 /* Utility macro to reset an iterator with x, ascent, and descent. */
8586 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8587 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8588 (IT)->max_descent = descent)
8590 /* Stop if we move beyond TO_CHARPOS (after an image or a
8591 display string or stretch glyph). */
8592 if ((op
& MOVE_TO_POS
) != 0
8593 && BUFFERP (it
->object
)
8594 && it
->method
== GET_FROM_BUFFER
8596 /* When the iterator is at base embedding level, we
8597 are guaranteed that characters are delivered for
8598 display in strictly increasing order of their
8599 buffer positions. */
8600 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8601 && IT_CHARPOS (*it
) > to_charpos
)
8603 && (prev_method
== GET_FROM_IMAGE
8604 || prev_method
== GET_FROM_STRETCH
8605 || prev_method
== GET_FROM_STRING
)
8606 /* Passed TO_CHARPOS from left to right. */
8607 && ((prev_pos
< to_charpos
8608 && IT_CHARPOS (*it
) > to_charpos
)
8609 /* Passed TO_CHARPOS from right to left. */
8610 || (prev_pos
> to_charpos
8611 && IT_CHARPOS (*it
) < to_charpos
)))))
8613 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8615 result
= MOVE_POS_MATCH_OR_ZV
;
8618 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8619 /* If wrap_it is valid, the current position might be in a
8620 word that is wrapped. So, save the iterator in
8621 atpos_it and continue to see if wrapping happens. */
8622 SAVE_IT (atpos_it
, *it
, atpos_data
);
8625 /* Stop when ZV reached.
8626 We used to stop here when TO_CHARPOS reached as well, but that is
8627 too soon if this glyph does not fit on this line. So we handle it
8628 explicitly below. */
8629 if (!get_next_display_element (it
))
8631 result
= MOVE_POS_MATCH_OR_ZV
;
8635 if (it
->line_wrap
== TRUNCATE
)
8637 if (BUFFER_POS_REACHED_P ())
8639 result
= MOVE_POS_MATCH_OR_ZV
;
8645 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8647 if (IT_DISPLAYING_WHITESPACE (it
))
8651 /* We have reached a glyph that follows one or more
8652 whitespace characters. If the position is
8653 already found, we are done. */
8654 if (atpos_it
.sp
>= 0)
8656 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8657 result
= MOVE_POS_MATCH_OR_ZV
;
8662 RESTORE_IT (it
, &atx_it
, atx_data
);
8663 result
= MOVE_X_REACHED
;
8666 /* Otherwise, we can wrap here. */
8667 SAVE_IT (wrap_it
, *it
, wrap_data
);
8673 /* Remember the line height for the current line, in case
8674 the next element doesn't fit on the line. */
8675 ascent
= it
->max_ascent
;
8676 descent
= it
->max_descent
;
8678 /* The call to produce_glyphs will get the metrics of the
8679 display element IT is loaded with. Record the x-position
8680 before this display element, in case it doesn't fit on the
8684 PRODUCE_GLYPHS (it
);
8686 if (it
->area
!= TEXT_AREA
)
8688 prev_method
= it
->method
;
8689 if (it
->method
== GET_FROM_BUFFER
)
8690 prev_pos
= IT_CHARPOS (*it
);
8691 set_iterator_to_next (it
, true);
8692 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8693 SET_TEXT_POS (this_line_min_pos
,
8694 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8696 && (op
& MOVE_TO_POS
)
8697 && IT_CHARPOS (*it
) > to_charpos
8698 && IT_CHARPOS (*it
) < closest_pos
)
8699 closest_pos
= IT_CHARPOS (*it
);
8703 /* The number of glyphs we get back in IT->nglyphs will normally
8704 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8705 character on a terminal frame, or (iii) a line end. For the
8706 second case, IT->nglyphs - 1 padding glyphs will be present.
8707 (On X frames, there is only one glyph produced for a
8708 composite character.)
8710 The behavior implemented below means, for continuation lines,
8711 that as many spaces of a TAB as fit on the current line are
8712 displayed there. For terminal frames, as many glyphs of a
8713 multi-glyph character are displayed in the current line, too.
8714 This is what the old redisplay code did, and we keep it that
8715 way. Under X, the whole shape of a complex character must
8716 fit on the line or it will be completely displayed in the
8719 Note that both for tabs and padding glyphs, all glyphs have
8723 /* More than one glyph or glyph doesn't fit on line. All
8724 glyphs have the same width. */
8725 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8727 int x_before_this_char
= x
;
8728 int hpos_before_this_char
= it
->hpos
;
8730 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8732 new_x
= x
+ single_glyph_width
;
8734 /* We want to leave anything reaching TO_X to the caller. */
8735 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8737 if (BUFFER_POS_REACHED_P ())
8739 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8740 goto buffer_pos_reached
;
8741 if (atpos_it
.sp
< 0)
8743 SAVE_IT (atpos_it
, *it
, atpos_data
);
8744 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8749 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8752 result
= MOVE_X_REACHED
;
8757 SAVE_IT (atx_it
, *it
, atx_data
);
8758 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8763 if (/* Lines are continued. */
8764 it
->line_wrap
!= TRUNCATE
8765 && (/* And glyph doesn't fit on the line. */
8766 new_x
> it
->last_visible_x
8767 /* Or it fits exactly and we're on a window
8769 || (new_x
== it
->last_visible_x
8770 && FRAME_WINDOW_P (it
->f
)
8771 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8772 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8773 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8775 if (/* IT->hpos == 0 means the very first glyph
8776 doesn't fit on the line, e.g. a wide image. */
8778 || (new_x
== it
->last_visible_x
8779 && FRAME_WINDOW_P (it
->f
)))
8782 it
->current_x
= new_x
;
8784 /* The character's last glyph just barely fits
8786 if (i
== it
->nglyphs
- 1)
8788 /* If this is the destination position,
8789 return a position *before* it in this row,
8790 now that we know it fits in this row. */
8791 if (BUFFER_POS_REACHED_P ())
8793 if (it
->line_wrap
!= WORD_WRAP
8795 /* If we've just found whitespace to
8796 wrap, effectively ignore the
8797 previous wrap point -- it is no
8798 longer relevant, but we won't
8799 have an opportunity to update it,
8800 since we've reached the edge of
8801 this screen line. */
8803 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8805 it
->hpos
= hpos_before_this_char
;
8806 it
->current_x
= x_before_this_char
;
8807 result
= MOVE_POS_MATCH_OR_ZV
;
8810 if (it
->line_wrap
== WORD_WRAP
8813 SAVE_IT (atpos_it
, *it
, atpos_data
);
8814 atpos_it
.current_x
= x_before_this_char
;
8815 atpos_it
.hpos
= hpos_before_this_char
;
8819 prev_method
= it
->method
;
8820 if (it
->method
== GET_FROM_BUFFER
)
8821 prev_pos
= IT_CHARPOS (*it
);
8822 set_iterator_to_next (it
, true);
8823 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8824 SET_TEXT_POS (this_line_min_pos
,
8825 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8826 /* On graphical terminals, newlines may
8827 "overflow" into the fringe if
8828 overflow-newline-into-fringe is non-nil.
8829 On text terminals, and on graphical
8830 terminals with no right margin, newlines
8831 may overflow into the last glyph on the
8833 if (!FRAME_WINDOW_P (it
->f
)
8835 && it
->bidi_it
.paragraph_dir
== R2L
)
8836 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8837 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8838 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8840 if (!get_next_display_element (it
))
8842 result
= MOVE_POS_MATCH_OR_ZV
;
8845 if (BUFFER_POS_REACHED_P ())
8847 if (ITERATOR_AT_END_OF_LINE_P (it
))
8848 result
= MOVE_POS_MATCH_OR_ZV
;
8850 result
= MOVE_LINE_CONTINUED
;
8853 if (ITERATOR_AT_END_OF_LINE_P (it
)
8854 && (it
->line_wrap
!= WORD_WRAP
8856 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8858 result
= MOVE_NEWLINE_OR_CR
;
8865 IT_RESET_X_ASCENT_DESCENT (it
);
8867 /* If the screen line ends with whitespace, and we
8868 are under word-wrap, don't use wrap_it: it is no
8869 longer relevant, but we won't have an opportunity
8870 to update it, since we are done with this screen
8872 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8874 /* If we've found TO_X, go back there, as we now
8875 know the last word fits on this screen line. */
8876 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8879 RESTORE_IT (it
, &atx_it
, atx_data
);
8882 result
= MOVE_X_REACHED
;
8886 else if (wrap_it
.sp
>= 0)
8888 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8893 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8895 result
= MOVE_LINE_CONTINUED
;
8899 if (BUFFER_POS_REACHED_P ())
8901 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8902 goto buffer_pos_reached
;
8903 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8905 SAVE_IT (atpos_it
, *it
, atpos_data
);
8906 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8910 if (new_x
> it
->first_visible_x
)
8912 /* Glyph is visible. Increment number of glyphs that
8913 would be displayed. */
8918 if (result
!= MOVE_UNDEFINED
)
8921 else if (BUFFER_POS_REACHED_P ())
8924 IT_RESET_X_ASCENT_DESCENT (it
);
8925 result
= MOVE_POS_MATCH_OR_ZV
;
8928 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8930 /* Stop when TO_X specified and reached. This check is
8931 necessary here because of lines consisting of a line end,
8932 only. The line end will not produce any glyphs and we
8933 would never get MOVE_X_REACHED. */
8934 eassert (it
->nglyphs
== 0);
8935 result
= MOVE_X_REACHED
;
8939 /* Is this a line end? If yes, we're done. */
8940 if (ITERATOR_AT_END_OF_LINE_P (it
))
8942 /* If we are past TO_CHARPOS, but never saw any character
8943 positions smaller than TO_CHARPOS, return
8944 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8946 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8948 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8950 if (closest_pos
< ZV
)
8952 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8953 /* Don't recurse if closest_pos is equal to
8954 to_charpos, since we have just tried that. */
8955 if (closest_pos
!= to_charpos
)
8956 move_it_in_display_line_to (it
, closest_pos
, -1,
8958 result
= MOVE_POS_MATCH_OR_ZV
;
8961 goto buffer_pos_reached
;
8963 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8964 && IT_CHARPOS (*it
) > to_charpos
)
8965 goto buffer_pos_reached
;
8967 result
= MOVE_NEWLINE_OR_CR
;
8970 result
= MOVE_NEWLINE_OR_CR
;
8974 prev_method
= it
->method
;
8975 if (it
->method
== GET_FROM_BUFFER
)
8976 prev_pos
= IT_CHARPOS (*it
);
8977 /* The current display element has been consumed. Advance
8979 set_iterator_to_next (it
, true);
8980 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8981 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8982 if (IT_CHARPOS (*it
) < to_charpos
)
8983 saw_smaller_pos
= true;
8985 && (op
& MOVE_TO_POS
)
8986 && IT_CHARPOS (*it
) >= to_charpos
8987 && IT_CHARPOS (*it
) < closest_pos
)
8988 closest_pos
= IT_CHARPOS (*it
);
8990 /* Stop if lines are truncated and IT's current x-position is
8991 past the right edge of the window now. */
8992 if (it
->line_wrap
== TRUNCATE
8993 && it
->current_x
>= it
->last_visible_x
)
8995 if (!FRAME_WINDOW_P (it
->f
)
8996 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8997 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8998 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8999 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
9001 bool at_eob_p
= false;
9003 if ((at_eob_p
= !get_next_display_element (it
))
9004 || BUFFER_POS_REACHED_P ()
9005 /* If we are past TO_CHARPOS, but never saw any
9006 character positions smaller than TO_CHARPOS,
9007 return MOVE_POS_MATCH_OR_ZV, like the
9008 unidirectional display did. */
9009 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9011 && IT_CHARPOS (*it
) > to_charpos
))
9014 && !BUFFER_POS_REACHED_P ()
9015 && !at_eob_p
&& closest_pos
< ZV
)
9017 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9018 if (closest_pos
!= to_charpos
)
9019 move_it_in_display_line_to (it
, closest_pos
, -1,
9022 result
= MOVE_POS_MATCH_OR_ZV
;
9025 if (ITERATOR_AT_END_OF_LINE_P (it
))
9027 result
= MOVE_NEWLINE_OR_CR
;
9031 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9033 && IT_CHARPOS (*it
) > to_charpos
)
9035 if (closest_pos
< ZV
)
9037 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9038 if (closest_pos
!= to_charpos
)
9039 move_it_in_display_line_to (it
, closest_pos
, -1,
9042 result
= MOVE_POS_MATCH_OR_ZV
;
9045 result
= MOVE_LINE_TRUNCATED
;
9048 #undef IT_RESET_X_ASCENT_DESCENT
9051 #undef BUFFER_POS_REACHED_P
9053 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9054 restore the saved iterator. */
9055 if (atpos_it
.sp
>= 0)
9056 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9057 else if (atx_it
.sp
>= 0)
9058 RESTORE_IT (it
, &atx_it
, atx_data
);
9063 bidi_unshelve_cache (atpos_data
, true);
9065 bidi_unshelve_cache (atx_data
, true);
9067 bidi_unshelve_cache (wrap_data
, true);
9069 bidi_unshelve_cache (ppos_data
, true);
9071 /* Restore the iterator settings altered at the beginning of this
9073 it
->glyph_row
= saved_glyph_row
;
9077 /* For external use. */
9079 move_it_in_display_line (struct it
*it
,
9080 ptrdiff_t to_charpos
, int to_x
,
9081 enum move_operation_enum op
)
9083 if (it
->line_wrap
== WORD_WRAP
9084 && (op
& MOVE_TO_X
))
9087 void *save_data
= NULL
;
9090 SAVE_IT (save_it
, *it
, save_data
);
9091 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9092 /* When word-wrap is on, TO_X may lie past the end
9093 of a wrapped line. Then it->current is the
9094 character on the next line, so backtrack to the
9095 space before the wrap point. */
9096 if (skip
== MOVE_LINE_CONTINUED
)
9098 int prev_x
= max (it
->current_x
- 1, 0);
9099 RESTORE_IT (it
, &save_it
, save_data
);
9100 move_it_in_display_line_to
9101 (it
, -1, prev_x
, MOVE_TO_X
);
9104 bidi_unshelve_cache (save_data
, true);
9107 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9111 /* Move IT forward until it satisfies one or more of the criteria in
9112 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9114 OP is a bit-mask that specifies where to stop, and in particular,
9115 which of those four position arguments makes a difference. See the
9116 description of enum move_operation_enum.
9118 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9119 screen line, this function will set IT to the next position that is
9120 displayed to the right of TO_CHARPOS on the screen.
9122 Return the maximum pixel length of any line scanned but never more
9123 than it.last_visible_x. */
9126 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9128 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9129 int line_height
, line_start_x
= 0, reached
= 0;
9130 int max_current_x
= 0;
9131 void *backup_data
= NULL
;
9135 if (op
& MOVE_TO_VPOS
)
9137 /* If no TO_CHARPOS and no TO_X specified, stop at the
9138 start of the line TO_VPOS. */
9139 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9141 if (it
->vpos
== to_vpos
)
9147 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9151 /* TO_VPOS >= 0 means stop at TO_X in the line at
9152 TO_VPOS, or at TO_POS, whichever comes first. */
9153 if (it
->vpos
== to_vpos
)
9159 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9161 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9166 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9168 /* We have reached TO_X but not in the line we want. */
9169 skip
= move_it_in_display_line_to (it
, to_charpos
,
9171 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9179 else if (op
& MOVE_TO_Y
)
9181 struct it it_backup
;
9183 if (it
->line_wrap
== WORD_WRAP
)
9184 SAVE_IT (it_backup
, *it
, backup_data
);
9186 /* TO_Y specified means stop at TO_X in the line containing
9187 TO_Y---or at TO_CHARPOS if this is reached first. The
9188 problem is that we can't really tell whether the line
9189 contains TO_Y before we have completely scanned it, and
9190 this may skip past TO_X. What we do is to first scan to
9193 If TO_X is not specified, use a TO_X of zero. The reason
9194 is to make the outcome of this function more predictable.
9195 If we didn't use TO_X == 0, we would stop at the end of
9196 the line which is probably not what a caller would expect
9198 skip
= move_it_in_display_line_to
9199 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9200 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9202 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9203 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9205 else if (skip
== MOVE_X_REACHED
)
9207 /* If TO_X was reached, we want to know whether TO_Y is
9208 in the line. We know this is the case if the already
9209 scanned glyphs make the line tall enough. Otherwise,
9210 we must check by scanning the rest of the line. */
9211 line_height
= it
->max_ascent
+ it
->max_descent
;
9212 if (to_y
>= it
->current_y
9213 && to_y
< it
->current_y
+ line_height
)
9218 SAVE_IT (it_backup
, *it
, backup_data
);
9219 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9220 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9222 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9223 line_height
= it
->max_ascent
+ it
->max_descent
;
9224 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9226 if (to_y
>= it
->current_y
9227 && to_y
< it
->current_y
+ line_height
)
9229 /* If TO_Y is in this line and TO_X was reached
9230 above, we scanned too far. We have to restore
9231 IT's settings to the ones before skipping. But
9232 keep the more accurate values of max_ascent and
9233 max_descent we've found while skipping the rest
9234 of the line, for the sake of callers, such as
9235 pos_visible_p, that need to know the line
9237 int max_ascent
= it
->max_ascent
;
9238 int max_descent
= it
->max_descent
;
9240 RESTORE_IT (it
, &it_backup
, backup_data
);
9241 it
->max_ascent
= max_ascent
;
9242 it
->max_descent
= max_descent
;
9248 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9254 /* Check whether TO_Y is in this line. */
9255 line_height
= it
->max_ascent
+ it
->max_descent
;
9256 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9258 if (to_y
>= it
->current_y
9259 && to_y
< it
->current_y
+ line_height
)
9261 if (to_y
> it
->current_y
)
9262 max_current_x
= max (it
->current_x
, max_current_x
);
9264 /* When word-wrap is on, TO_X may lie past the end
9265 of a wrapped line. Then it->current is the
9266 character on the next line, so backtrack to the
9267 space before the wrap point. */
9268 if (skip
== MOVE_LINE_CONTINUED
9269 && it
->line_wrap
== WORD_WRAP
)
9271 int prev_x
= max (it
->current_x
- 1, 0);
9272 RESTORE_IT (it
, &it_backup
, backup_data
);
9273 skip
= move_it_in_display_line_to
9274 (it
, -1, prev_x
, MOVE_TO_X
);
9283 max_current_x
= max (it
->current_x
, max_current_x
);
9287 else if (BUFFERP (it
->object
)
9288 && (it
->method
== GET_FROM_BUFFER
9289 || it
->method
== GET_FROM_STRETCH
)
9290 && IT_CHARPOS (*it
) >= to_charpos
9291 /* Under bidi iteration, a call to set_iterator_to_next
9292 can scan far beyond to_charpos if the initial
9293 portion of the next line needs to be reordered. In
9294 that case, give move_it_in_display_line_to another
9297 && it
->bidi_it
.scan_dir
== -1))
9298 skip
= MOVE_POS_MATCH_OR_ZV
;
9300 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9304 case MOVE_POS_MATCH_OR_ZV
:
9305 max_current_x
= max (it
->current_x
, max_current_x
);
9309 case MOVE_NEWLINE_OR_CR
:
9310 max_current_x
= max (it
->current_x
, max_current_x
);
9311 set_iterator_to_next (it
, true);
9312 it
->continuation_lines_width
= 0;
9315 case MOVE_LINE_TRUNCATED
:
9316 max_current_x
= it
->last_visible_x
;
9317 it
->continuation_lines_width
= 0;
9318 reseat_at_next_visible_line_start (it
, false);
9319 if ((op
& MOVE_TO_POS
) != 0
9320 && IT_CHARPOS (*it
) > to_charpos
)
9327 case MOVE_LINE_CONTINUED
:
9328 max_current_x
= it
->last_visible_x
;
9329 /* For continued lines ending in a tab, some of the glyphs
9330 associated with the tab are displayed on the current
9331 line. Since it->current_x does not include these glyphs,
9332 we use it->last_visible_x instead. */
9335 it
->continuation_lines_width
+= it
->last_visible_x
;
9336 /* When moving by vpos, ensure that the iterator really
9337 advances to the next line (bug#847, bug#969). Fixme:
9338 do we need to do this in other circumstances? */
9339 if (it
->current_x
!= it
->last_visible_x
9340 && (op
& MOVE_TO_VPOS
)
9341 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9343 line_start_x
= it
->current_x
+ it
->pixel_width
9344 - it
->last_visible_x
;
9345 if (FRAME_WINDOW_P (it
->f
))
9347 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9348 struct font
*face_font
= face
->font
;
9350 /* When display_line produces a continued line
9351 that ends in a TAB, it skips a tab stop that
9352 is closer than the font's space character
9353 width (see x_produce_glyphs where it produces
9354 the stretch glyph which represents a TAB).
9355 We need to reproduce the same logic here. */
9356 eassert (face_font
);
9359 if (line_start_x
< face_font
->space_width
)
9361 += it
->tab_width
* face_font
->space_width
;
9364 set_iterator_to_next (it
, false);
9368 it
->continuation_lines_width
+= it
->current_x
;
9375 /* Reset/increment for the next run. */
9376 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9377 it
->current_x
= line_start_x
;
9380 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9382 last_height
= it
->max_ascent
+ it
->max_descent
;
9383 it
->max_ascent
= it
->max_descent
= 0;
9388 /* On text terminals, we may stop at the end of a line in the middle
9389 of a multi-character glyph. If the glyph itself is continued,
9390 i.e. it is actually displayed on the next line, don't treat this
9391 stopping point as valid; move to the next line instead (unless
9392 that brings us offscreen). */
9393 if (!FRAME_WINDOW_P (it
->f
)
9395 && IT_CHARPOS (*it
) == to_charpos
9396 && it
->what
== IT_CHARACTER
9398 && it
->line_wrap
== WINDOW_WRAP
9399 && it
->current_x
== it
->last_visible_x
- 1
9402 && it
->w
->window_end_valid
9403 && it
->vpos
< it
->w
->window_end_vpos
)
9405 it
->continuation_lines_width
+= it
->current_x
;
9406 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9407 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9409 last_height
= it
->max_ascent
+ it
->max_descent
;
9413 bidi_unshelve_cache (backup_data
, true);
9415 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9417 return max_current_x
;
9421 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9423 If DY > 0, move IT backward at least that many pixels. DY = 0
9424 means move IT backward to the preceding line start or BEGV. This
9425 function may move over more than DY pixels if IT->current_y - DY
9426 ends up in the middle of a line; in this case IT->current_y will be
9427 set to the top of the line moved to. */
9430 move_it_vertically_backward (struct it
*it
, int dy
)
9434 void *it2data
= NULL
, *it3data
= NULL
;
9435 ptrdiff_t start_pos
;
9437 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9438 ptrdiff_t pos_limit
;
9443 start_pos
= IT_CHARPOS (*it
);
9445 /* Estimate how many newlines we must move back. */
9446 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9447 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9450 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9452 /* Set the iterator's position that many lines back. But don't go
9453 back more than NLINES full screen lines -- this wins a day with
9454 buffers which have very long lines. */
9455 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9456 back_to_previous_visible_line_start (it
);
9458 /* Reseat the iterator here. When moving backward, we don't want
9459 reseat to skip forward over invisible text, set up the iterator
9460 to deliver from overlay strings at the new position etc. So,
9461 use reseat_1 here. */
9462 reseat_1 (it
, it
->current
.pos
, true);
9464 /* We are now surely at a line start. */
9465 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9466 reordering is in effect. */
9467 it
->continuation_lines_width
= 0;
9469 /* Move forward and see what y-distance we moved. First move to the
9470 start of the next line so that we get its height. We need this
9471 height to be able to tell whether we reached the specified
9473 SAVE_IT (it2
, *it
, it2data
);
9474 it2
.max_ascent
= it2
.max_descent
= 0;
9477 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9478 MOVE_TO_POS
| MOVE_TO_VPOS
);
9480 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9481 /* If we are in a display string which starts at START_POS,
9482 and that display string includes a newline, and we are
9483 right after that newline (i.e. at the beginning of a
9484 display line), exit the loop, because otherwise we will
9485 infloop, since move_it_to will see that it is already at
9486 START_POS and will not move. */
9487 || (it2
.method
== GET_FROM_STRING
9488 && IT_CHARPOS (it2
) == start_pos
9489 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9490 eassert (IT_CHARPOS (*it
) >= BEGV
);
9491 SAVE_IT (it3
, it2
, it3data
);
9493 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9494 eassert (IT_CHARPOS (*it
) >= BEGV
);
9495 /* H is the actual vertical distance from the position in *IT
9496 and the starting position. */
9497 h
= it2
.current_y
- it
->current_y
;
9498 /* NLINES is the distance in number of lines. */
9499 nlines
= it2
.vpos
- it
->vpos
;
9501 /* Correct IT's y and vpos position
9502 so that they are relative to the starting point. */
9508 /* DY == 0 means move to the start of the screen line. The
9509 value of nlines is > 0 if continuation lines were involved,
9510 or if the original IT position was at start of a line. */
9511 RESTORE_IT (it
, it
, it2data
);
9513 move_it_by_lines (it
, nlines
);
9514 /* The above code moves us to some position NLINES down,
9515 usually to its first glyph (leftmost in an L2R line), but
9516 that's not necessarily the start of the line, under bidi
9517 reordering. We want to get to the character position
9518 that is immediately after the newline of the previous
9521 && !it
->continuation_lines_width
9522 && !STRINGP (it
->string
)
9523 && IT_CHARPOS (*it
) > BEGV
9524 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9526 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9529 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9530 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9532 bidi_unshelve_cache (it3data
, true);
9536 /* The y-position we try to reach, relative to *IT.
9537 Note that H has been subtracted in front of the if-statement. */
9538 int target_y
= it
->current_y
+ h
- dy
;
9539 int y0
= it3
.current_y
;
9543 RESTORE_IT (&it3
, &it3
, it3data
);
9544 y1
= line_bottom_y (&it3
);
9545 line_height
= y1
- y0
;
9546 RESTORE_IT (it
, it
, it2data
);
9547 /* If we did not reach target_y, try to move further backward if
9548 we can. If we moved too far backward, try to move forward. */
9549 if (target_y
< it
->current_y
9550 /* This is heuristic. In a window that's 3 lines high, with
9551 a line height of 13 pixels each, recentering with point
9552 on the bottom line will try to move -39/2 = 19 pixels
9553 backward. Try to avoid moving into the first line. */
9554 && (it
->current_y
- target_y
9555 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9556 && IT_CHARPOS (*it
) > BEGV
)
9558 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9559 target_y
- it
->current_y
));
9560 dy
= it
->current_y
- target_y
;
9561 goto move_further_back
;
9563 else if (target_y
>= it
->current_y
+ line_height
9564 && IT_CHARPOS (*it
) < ZV
)
9566 /* Should move forward by at least one line, maybe more.
9568 Note: Calling move_it_by_lines can be expensive on
9569 terminal frames, where compute_motion is used (via
9570 vmotion) to do the job, when there are very long lines
9571 and truncate-lines is nil. That's the reason for
9572 treating terminal frames specially here. */
9574 if (!FRAME_WINDOW_P (it
->f
))
9575 move_it_vertically (it
, target_y
- it
->current_y
);
9580 move_it_by_lines (it
, 1);
9582 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9589 /* Move IT by a specified amount of pixel lines DY. DY negative means
9590 move backwards. DY = 0 means move to start of screen line. At the
9591 end, IT will be on the start of a screen line. */
9594 move_it_vertically (struct it
*it
, int dy
)
9597 move_it_vertically_backward (it
, -dy
);
9600 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9601 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9602 MOVE_TO_POS
| MOVE_TO_Y
);
9603 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9605 /* If buffer ends in ZV without a newline, move to the start of
9606 the line to satisfy the post-condition. */
9607 if (IT_CHARPOS (*it
) == ZV
9609 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9610 move_it_by_lines (it
, 0);
9615 /* Move iterator IT past the end of the text line it is in. */
9618 move_it_past_eol (struct it
*it
)
9620 enum move_it_result rc
;
9622 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9623 if (rc
== MOVE_NEWLINE_OR_CR
)
9624 set_iterator_to_next (it
, false);
9628 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9629 negative means move up. DVPOS == 0 means move to the start of the
9632 Optimization idea: If we would know that IT->f doesn't use
9633 a face with proportional font, we could be faster for
9634 truncate-lines nil. */
9637 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9640 /* The commented-out optimization uses vmotion on terminals. This
9641 gives bad results, because elements like it->what, on which
9642 callers such as pos_visible_p rely, aren't updated. */
9643 /* struct position pos;
9644 if (!FRAME_WINDOW_P (it->f))
9646 struct text_pos textpos;
9648 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9649 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9650 reseat (it, textpos, true);
9651 it->vpos += pos.vpos;
9652 it->current_y += pos.vpos;
9658 /* DVPOS == 0 means move to the start of the screen line. */
9659 move_it_vertically_backward (it
, 0);
9660 /* Let next call to line_bottom_y calculate real line height. */
9665 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9666 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9668 /* Only move to the next buffer position if we ended up in a
9669 string from display property, not in an overlay string
9670 (before-string or after-string). That is because the
9671 latter don't conceal the underlying buffer position, so
9672 we can ask to move the iterator to the exact position we
9673 are interested in. Note that, even if we are already at
9674 IT_CHARPOS (*it), the call below is not a no-op, as it
9675 will detect that we are at the end of the string, pop the
9676 iterator, and compute it->current_x and it->hpos
9678 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9679 -1, -1, -1, MOVE_TO_POS
);
9685 void *it2data
= NULL
;
9686 ptrdiff_t start_charpos
, i
;
9688 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9689 bool hit_pos_limit
= false;
9690 ptrdiff_t pos_limit
;
9692 /* Start at the beginning of the screen line containing IT's
9693 position. This may actually move vertically backwards,
9694 in case of overlays, so adjust dvpos accordingly. */
9696 move_it_vertically_backward (it
, 0);
9699 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9700 screen lines, and reseat the iterator there. */
9701 start_charpos
= IT_CHARPOS (*it
);
9702 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9705 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9707 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9708 back_to_previous_visible_line_start (it
);
9709 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9710 hit_pos_limit
= true;
9711 reseat (it
, it
->current
.pos
, true);
9713 /* Move further back if we end up in a string or an image. */
9714 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9716 /* First try to move to start of display line. */
9718 move_it_vertically_backward (it
, 0);
9720 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9722 /* If start of line is still in string or image,
9723 move further back. */
9724 back_to_previous_visible_line_start (it
);
9725 reseat (it
, it
->current
.pos
, true);
9729 it
->current_x
= it
->hpos
= 0;
9731 /* Above call may have moved too far if continuation lines
9732 are involved. Scan forward and see if it did. */
9733 SAVE_IT (it2
, *it
, it2data
);
9734 it2
.vpos
= it2
.current_y
= 0;
9735 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9736 it
->vpos
-= it2
.vpos
;
9737 it
->current_y
-= it2
.current_y
;
9738 it
->current_x
= it
->hpos
= 0;
9740 /* If we moved too far back, move IT some lines forward. */
9741 if (it2
.vpos
> -dvpos
)
9743 int delta
= it2
.vpos
+ dvpos
;
9745 RESTORE_IT (&it2
, &it2
, it2data
);
9746 SAVE_IT (it2
, *it
, it2data
);
9747 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9748 /* Move back again if we got too far ahead. */
9749 if (IT_CHARPOS (*it
) >= start_charpos
)
9750 RESTORE_IT (it
, &it2
, it2data
);
9752 bidi_unshelve_cache (it2data
, true);
9754 else if (hit_pos_limit
&& pos_limit
> BEGV
9755 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9757 /* If we hit the limit, but still didn't make it far enough
9758 back, that means there's a display string with a newline
9759 covering a large chunk of text, and that caused
9760 back_to_previous_visible_line_start try to go too far.
9761 Punish those who commit such atrocities by going back
9762 until we've reached DVPOS, after lifting the limit, which
9763 could make it slow for very long lines. "If it hurts,
9766 RESTORE_IT (it
, it
, it2data
);
9767 for (i
= -dvpos
; i
> 0; --i
)
9769 back_to_previous_visible_line_start (it
);
9772 reseat_1 (it
, it
->current
.pos
, true);
9775 RESTORE_IT (it
, it
, it2data
);
9779 /* Return true if IT points into the middle of a display vector. */
9782 in_display_vector_p (struct it
*it
)
9784 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9785 && it
->current
.dpvec_index
> 0
9786 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9789 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9790 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9791 WINDOW must be a live window and defaults to the selected one. The
9792 return value is a cons of the maximum pixel-width of any text line and
9793 the maximum pixel-height of all text lines.
9795 The optional argument FROM, if non-nil, specifies the first text
9796 position and defaults to the minimum accessible position of the buffer.
9797 If FROM is t, use the minimum accessible position that is not a newline
9798 character. TO, if non-nil, specifies the last text position and
9799 defaults to the maximum accessible position of the buffer. If TO is t,
9800 use the maximum accessible position that is not a newline character.
9802 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9803 width that can be returned. X-LIMIT nil or omitted, means to use the
9804 pixel-width of WINDOW's body; use this if you do not intend to change
9805 the width of WINDOW. Use the maximum width WINDOW may assume if you
9806 intend to change WINDOW's width. In any case, text whose x-coordinate
9807 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9808 can take some time, it's always a good idea to make this argument as
9809 small as possible; in particular, if the buffer contains long lines that
9810 shall be truncated anyway.
9812 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9813 height that can be returned. Text lines whose y-coordinate is beyond
9814 Y-LIMIT are ignored. Since calculating the text height of a large
9815 buffer can take some time, it makes sense to specify this argument if
9816 the size of the buffer is unknown.
9818 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9819 include the height of the mode- or header-line of WINDOW in the return
9820 value. If it is either the symbol `mode-line' or `header-line', include
9821 only the height of that line, if present, in the return value. If t,
9822 include the height of both, if present, in the return value. */)
9823 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9824 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9826 struct window
*w
= decode_live_window (window
);
9827 Lisp_Object buffer
= w
->contents
;
9830 struct buffer
*old_b
= NULL
;
9831 ptrdiff_t start
, end
, pos
;
9832 struct text_pos startp
;
9833 void *itdata
= NULL
;
9834 int c
, max_y
= -1, x
= 0, y
= 0;
9836 CHECK_BUFFER (buffer
);
9837 b
= XBUFFER (buffer
);
9839 if (b
!= current_buffer
)
9841 old_b
= current_buffer
;
9842 set_buffer_internal (b
);
9847 else if (EQ (from
, Qt
))
9850 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9851 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9853 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9858 CHECK_NUMBER_COERCE_MARKER (from
);
9859 start
= min (max (XINT (from
), BEGV
), ZV
);
9864 else if (EQ (to
, Qt
))
9867 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9868 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9870 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9875 CHECK_NUMBER_COERCE_MARKER (to
);
9876 end
= max (start
, min (XINT (to
), ZV
));
9879 if (!NILP (y_limit
))
9881 CHECK_NUMBER (y_limit
);
9882 max_y
= min (XINT (y_limit
), INT_MAX
);
9885 itdata
= bidi_shelve_cache ();
9886 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9887 start_display (&it
, w
, startp
);
9890 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9893 CHECK_NUMBER (x_limit
);
9894 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9895 /* Actually, we never want move_it_to stop at to_x. But to make
9896 sure that move_it_in_display_line_to always moves far enough,
9897 we set it to INT_MAX and specify MOVE_TO_X. */
9898 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9899 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9902 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9904 if (!EQ (mode_and_header_line
, Qheader_line
)
9905 && !EQ (mode_and_header_line
, Qt
))
9906 /* Do not count the header-line which was counted automatically by
9908 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9910 if (EQ (mode_and_header_line
, Qmode_line
)
9911 || EQ (mode_and_header_line
, Qt
))
9912 /* Do count the mode-line which is not included automatically by
9914 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9916 bidi_unshelve_cache (itdata
, false);
9919 set_buffer_internal (old_b
);
9921 return Fcons (make_number (x
), make_number (y
));
9924 /***********************************************************************
9926 ***********************************************************************/
9928 /* Return the number of arguments the format string FORMAT needs. */
9931 format_nargs (char const *format
)
9933 ptrdiff_t nargs
= 0;
9934 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9942 /* Add a message with format string FORMAT and formatted arguments
9946 add_to_log (const char *format
, ...)
9949 va_start (ap
, format
);
9950 vadd_to_log (format
, ap
);
9955 vadd_to_log (char const *format
, va_list ap
)
9957 ptrdiff_t form_nargs
= format_nargs (format
);
9958 ptrdiff_t nargs
= 1 + form_nargs
;
9959 Lisp_Object args
[10];
9960 eassert (nargs
<= ARRAYELTS (args
));
9961 AUTO_STRING (args0
, format
);
9963 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9964 args
[i
] = va_arg (ap
, Lisp_Object
);
9965 Lisp_Object msg
= Qnil
;
9966 msg
= Fformat_message (nargs
, args
);
9968 ptrdiff_t len
= SBYTES (msg
) + 1;
9970 char *buffer
= SAFE_ALLOCA (len
);
9971 memcpy (buffer
, SDATA (msg
), len
);
9973 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9978 /* Output a newline in the *Messages* buffer if "needs" one. */
9981 message_log_maybe_newline (void)
9983 if (message_log_need_newline
)
9984 message_dolog ("", 0, true, false);
9988 /* Add a string M of length NBYTES to the message log, optionally
9989 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9990 true, means interpret the contents of M as multibyte. This
9991 function calls low-level routines in order to bypass text property
9992 hooks, etc. which might not be safe to run.
9994 This may GC (insert may run before/after change hooks),
9995 so the buffer M must NOT point to a Lisp string. */
9998 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
10000 const unsigned char *msg
= (const unsigned char *) m
;
10002 if (!NILP (Vmemory_full
))
10005 if (!NILP (Vmessage_log_max
))
10007 struct buffer
*oldbuf
;
10008 Lisp_Object oldpoint
, oldbegv
, oldzv
;
10009 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10010 ptrdiff_t point_at_end
= 0;
10011 ptrdiff_t zv_at_end
= 0;
10012 Lisp_Object old_deactivate_mark
;
10014 old_deactivate_mark
= Vdeactivate_mark
;
10015 oldbuf
= current_buffer
;
10017 /* Ensure the Messages buffer exists, and switch to it.
10018 If we created it, set the major-mode. */
10019 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
10020 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
10022 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10023 call0 (intern ("messages-buffer-mode"));
10025 bset_undo_list (current_buffer
, Qt
);
10026 bset_cache_long_scans (current_buffer
, Qnil
);
10028 oldpoint
= message_dolog_marker1
;
10029 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10030 oldbegv
= message_dolog_marker2
;
10031 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10032 oldzv
= message_dolog_marker3
;
10033 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10041 BEGV_BYTE
= BEG_BYTE
;
10044 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10046 /* Insert the string--maybe converting multibyte to single byte
10047 or vice versa, so that all the text fits the buffer. */
10049 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10055 /* Convert a multibyte string to single-byte
10056 for the *Message* buffer. */
10057 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10059 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10060 work
[0] = CHAR_TO_BYTE8 (c
);
10061 insert_1_both (work
, 1, 1, true, false, false);
10064 else if (! multibyte
10065 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10069 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10070 /* Convert a single-byte string to multibyte
10071 for the *Message* buffer. */
10072 for (i
= 0; i
< nbytes
; i
++)
10075 MAKE_CHAR_MULTIBYTE (c
);
10076 char_bytes
= CHAR_STRING (c
, str
);
10077 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10081 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10082 true, false, false);
10086 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10089 insert_1_both ("\n", 1, 1, true, false, false);
10091 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10093 this_bol_byte
= PT_BYTE
;
10095 /* See if this line duplicates the previous one.
10096 If so, combine duplicates. */
10097 if (this_bol
> BEG
)
10099 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10101 prev_bol_byte
= PT_BYTE
;
10103 dups
= message_log_check_duplicate (prev_bol_byte
,
10107 del_range_both (prev_bol
, prev_bol_byte
,
10108 this_bol
, this_bol_byte
, false);
10111 char dupstr
[sizeof " [ times]"
10112 + INT_STRLEN_BOUND (printmax_t
)];
10114 /* If you change this format, don't forget to also
10115 change message_log_check_duplicate. */
10116 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10117 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10118 insert_1_both (dupstr
, duplen
, duplen
,
10119 true, false, true);
10124 /* If we have more than the desired maximum number of lines
10125 in the *Messages* buffer now, delete the oldest ones.
10126 This is safe because we don't have undo in this buffer. */
10128 if (NATNUMP (Vmessage_log_max
))
10130 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10131 -XFASTINT (Vmessage_log_max
) - 1, false);
10132 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10135 BEGV
= marker_position (oldbegv
);
10136 BEGV_BYTE
= marker_byte_position (oldbegv
);
10145 ZV
= marker_position (oldzv
);
10146 ZV_BYTE
= marker_byte_position (oldzv
);
10150 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10152 /* We can't do Fgoto_char (oldpoint) because it will run some
10154 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10155 marker_byte_position (oldpoint
));
10157 unchain_marker (XMARKER (oldpoint
));
10158 unchain_marker (XMARKER (oldbegv
));
10159 unchain_marker (XMARKER (oldzv
));
10161 /* We called insert_1_both above with its 5th argument (PREPARE)
10162 false, which prevents insert_1_both from calling
10163 prepare_to_modify_buffer, which in turns prevents us from
10164 incrementing windows_or_buffers_changed even if *Messages* is
10165 shown in some window. So we must manually set
10166 windows_or_buffers_changed here to make up for that. */
10167 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10168 bset_redisplay (current_buffer
);
10170 set_buffer_internal (oldbuf
);
10172 message_log_need_newline
= !nlflag
;
10173 Vdeactivate_mark
= old_deactivate_mark
;
10178 /* We are at the end of the buffer after just having inserted a newline.
10179 (Note: We depend on the fact we won't be crossing the gap.)
10180 Check to see if the most recent message looks a lot like the previous one.
10181 Return 0 if different, 1 if the new one should just replace it, or a
10182 value N > 1 if we should also append " [N times]". */
10185 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10188 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10189 bool seen_dots
= false;
10190 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10191 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10193 for (i
= 0; i
< len
; i
++)
10195 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10197 if (p1
[i
] != p2
[i
])
10203 if (*p1
++ == ' ' && *p1
++ == '[')
10206 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10207 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10214 /* Display an echo area message M with a specified length of NBYTES
10215 bytes. The string may include null characters. If M is not a
10216 string, clear out any existing message, and let the mini-buffer
10219 This function cancels echoing. */
10222 message3 (Lisp_Object m
)
10224 clear_message (true, true);
10227 /* First flush out any partial line written with print. */
10228 message_log_maybe_newline ();
10231 ptrdiff_t nbytes
= SBYTES (m
);
10232 bool multibyte
= STRING_MULTIBYTE (m
);
10235 SAFE_ALLOCA_STRING (buffer
, m
);
10236 message_dolog (buffer
, nbytes
, true, multibyte
);
10239 if (! inhibit_message
)
10240 message3_nolog (m
);
10243 /* Log the message M to stderr. Log an empty line if M is not a string. */
10246 message_to_stderr (Lisp_Object m
)
10248 if (noninteractive_need_newline
)
10250 noninteractive_need_newline
= false;
10251 fputc ('\n', stderr
);
10255 Lisp_Object coding_system
= Vlocale_coding_system
;
10258 if (!NILP (Vcoding_system_for_write
))
10259 coding_system
= Vcoding_system_for_write
;
10260 if (!NILP (coding_system
))
10261 s
= code_convert_string_norecord (m
, coding_system
, true);
10265 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10267 if (!cursor_in_echo_area
)
10268 fputc ('\n', stderr
);
10272 /* The non-logging version of message3.
10273 This does not cancel echoing, because it is used for echoing.
10274 Perhaps we need to make a separate function for echoing
10275 and make this cancel echoing. */
10278 message3_nolog (Lisp_Object m
)
10280 struct frame
*sf
= SELECTED_FRAME ();
10282 if (FRAME_INITIAL_P (sf
))
10283 message_to_stderr (m
);
10284 /* Error messages get reported properly by cmd_error, so this must be just an
10285 informative message; if the frame hasn't really been initialized yet, just
10287 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10289 /* Get the frame containing the mini-buffer
10290 that the selected frame is using. */
10291 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10292 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10293 struct frame
*f
= XFRAME (frame
);
10295 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10296 Fmake_frame_visible (frame
);
10298 if (STRINGP (m
) && SCHARS (m
) > 0)
10301 if (minibuffer_auto_raise
)
10302 Fraise_frame (frame
);
10303 /* Assume we are not echoing.
10304 (If we are, echo_now will override this.) */
10305 echo_message_buffer
= Qnil
;
10308 clear_message (true, true);
10310 do_pending_window_change (false);
10311 echo_area_display (true);
10312 do_pending_window_change (false);
10313 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10314 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10319 /* Display a null-terminated echo area message M. If M is 0, clear
10320 out any existing message, and let the mini-buffer text show through.
10322 The buffer M must continue to exist until after the echo area gets
10323 cleared or some other message gets displayed there. Do not pass
10324 text that is stored in a Lisp string. Do not pass text in a buffer
10325 that was alloca'd. */
10328 message1 (const char *m
)
10330 message3 (m
? build_unibyte_string (m
) : Qnil
);
10334 /* The non-logging counterpart of message1. */
10337 message1_nolog (const char *m
)
10339 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10342 /* Display a message M which contains a single %s
10343 which gets replaced with STRING. */
10346 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10348 CHECK_STRING (string
);
10351 if (noninteractive
)
10352 need_message
= !!m
;
10353 else if (!INTERACTIVE
)
10354 need_message
= false;
10357 /* The frame whose minibuffer we're going to display the message on.
10358 It may be larger than the selected frame, so we need
10359 to use its buffer, not the selected frame's buffer. */
10360 Lisp_Object mini_window
;
10361 struct frame
*f
, *sf
= SELECTED_FRAME ();
10363 /* Get the frame containing the minibuffer
10364 that the selected frame is using. */
10365 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10366 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10368 /* Error messages get reported properly by cmd_error, so this must be
10369 just an informative message; if the frame hasn't really been
10370 initialized yet, just toss it. */
10371 need_message
= f
->glyphs_initialized_p
;
10376 AUTO_STRING (fmt
, m
);
10377 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10379 if (noninteractive
)
10380 message_to_stderr (msg
);
10386 message3_nolog (msg
);
10388 /* Print should start at the beginning of the message
10389 buffer next time. */
10390 message_buf_print
= false;
10396 /* Dump an informative message to the minibuf. If M is 0, clear out
10397 any existing message, and let the mini-buffer text show through.
10399 The message must be safe ASCII and the format must not contain ` or
10400 '. If your message and format do not fit into this category,
10401 convert your arguments to Lisp objects and use Fmessage instead. */
10403 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10404 vmessage (const char *m
, va_list ap
)
10406 if (noninteractive
)
10410 if (noninteractive_need_newline
)
10411 putc ('\n', stderr
);
10412 noninteractive_need_newline
= false;
10413 vfprintf (stderr
, m
, ap
);
10414 if (!cursor_in_echo_area
)
10415 fprintf (stderr
, "\n");
10419 else if (INTERACTIVE
)
10421 /* The frame whose mini-buffer we're going to display the message
10422 on. It may be larger than the selected frame, so we need to
10423 use its buffer, not the selected frame's buffer. */
10424 Lisp_Object mini_window
;
10425 struct frame
*f
, *sf
= SELECTED_FRAME ();
10427 /* Get the frame containing the mini-buffer
10428 that the selected frame is using. */
10429 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10430 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10432 /* Error messages get reported properly by cmd_error, so this must be
10433 just an informative message; if the frame hasn't really been
10434 initialized yet, just toss it. */
10435 if (f
->glyphs_initialized_p
)
10440 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10442 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10444 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10446 message3 (make_string (message_buf
, len
));
10452 /* Print should start at the beginning of the message
10453 buffer next time. */
10454 message_buf_print
= false;
10460 message (const char *m
, ...)
10469 /* Display the current message in the current mini-buffer. This is
10470 only called from error handlers in process.c, and is not time
10474 update_echo_area (void)
10476 if (!NILP (echo_area_buffer
[0]))
10478 Lisp_Object string
;
10479 string
= Fcurrent_message ();
10485 /* Make sure echo area buffers in `echo_buffers' are live.
10486 If they aren't, make new ones. */
10489 ensure_echo_area_buffers (void)
10493 for (i
= 0; i
< 2; ++i
)
10494 if (!BUFFERP (echo_buffer
[i
])
10495 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10498 Lisp_Object old_buffer
;
10501 old_buffer
= echo_buffer
[i
];
10502 echo_buffer
[i
] = Fget_buffer_create
10503 (make_formatted_string (name
, " *Echo Area %d*", i
));
10504 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10505 /* to force word wrap in echo area -
10506 it was decided to postpone this*/
10507 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10509 for (j
= 0; j
< 2; ++j
)
10510 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10511 echo_area_buffer
[j
] = echo_buffer
[i
];
10516 /* Call FN with args A1..A2 with either the current or last displayed
10517 echo_area_buffer as current buffer.
10519 WHICH zero means use the current message buffer
10520 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10521 from echo_buffer[] and clear it.
10523 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10524 suitable buffer from echo_buffer[] and clear it.
10526 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10527 that the current message becomes the last displayed one, make
10528 choose a suitable buffer for echo_area_buffer[0], and clear it.
10530 Value is what FN returns. */
10533 with_echo_area_buffer (struct window
*w
, int which
,
10534 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10535 ptrdiff_t a1
, Lisp_Object a2
)
10537 Lisp_Object buffer
;
10538 bool this_one
, the_other
, clear_buffer_p
, rc
;
10539 ptrdiff_t count
= SPECPDL_INDEX ();
10541 /* If buffers aren't live, make new ones. */
10542 ensure_echo_area_buffers ();
10544 clear_buffer_p
= false;
10547 this_one
= false, the_other
= true;
10548 else if (which
> 0)
10549 this_one
= true, the_other
= false;
10552 this_one
= false, the_other
= true;
10553 clear_buffer_p
= true;
10555 /* We need a fresh one in case the current echo buffer equals
10556 the one containing the last displayed echo area message. */
10557 if (!NILP (echo_area_buffer
[this_one
])
10558 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10559 echo_area_buffer
[this_one
] = Qnil
;
10562 /* Choose a suitable buffer from echo_buffer[] is we don't
10564 if (NILP (echo_area_buffer
[this_one
]))
10566 echo_area_buffer
[this_one
]
10567 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10568 ? echo_buffer
[the_other
]
10569 : echo_buffer
[this_one
]);
10570 clear_buffer_p
= true;
10573 buffer
= echo_area_buffer
[this_one
];
10575 /* Don't get confused by reusing the buffer used for echoing
10576 for a different purpose. */
10577 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10580 record_unwind_protect (unwind_with_echo_area_buffer
,
10581 with_echo_area_buffer_unwind_data (w
));
10583 /* Make the echo area buffer current. Note that for display
10584 purposes, it is not necessary that the displayed window's buffer
10585 == current_buffer, except for text property lookup. So, let's
10586 only set that buffer temporarily here without doing a full
10587 Fset_window_buffer. We must also change w->pointm, though,
10588 because otherwise an assertions in unshow_buffer fails, and Emacs
10590 set_buffer_internal_1 (XBUFFER (buffer
));
10593 wset_buffer (w
, buffer
);
10594 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10595 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10598 bset_undo_list (current_buffer
, Qt
);
10599 bset_read_only (current_buffer
, Qnil
);
10600 specbind (Qinhibit_read_only
, Qt
);
10601 specbind (Qinhibit_modification_hooks
, Qt
);
10603 if (clear_buffer_p
&& Z
> BEG
)
10604 del_range (BEG
, Z
);
10606 eassert (BEGV
>= BEG
);
10607 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10611 eassert (BEGV
>= BEG
);
10612 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10614 unbind_to (count
, Qnil
);
10619 /* Save state that should be preserved around the call to the function
10620 FN called in with_echo_area_buffer. */
10623 with_echo_area_buffer_unwind_data (struct window
*w
)
10626 Lisp_Object vector
, tmp
;
10628 /* Reduce consing by keeping one vector in
10629 Vwith_echo_area_save_vector. */
10630 vector
= Vwith_echo_area_save_vector
;
10631 Vwith_echo_area_save_vector
= Qnil
;
10634 vector
= Fmake_vector (make_number (11), Qnil
);
10636 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10637 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10638 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10642 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10643 ASET (vector
, i
, w
->contents
); ++i
;
10644 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10645 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10646 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10647 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10648 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10649 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10654 for (; i
< end
; ++i
)
10655 ASET (vector
, i
, Qnil
);
10658 eassert (i
== ASIZE (vector
));
10663 /* Restore global state from VECTOR which was created by
10664 with_echo_area_buffer_unwind_data. */
10667 unwind_with_echo_area_buffer (Lisp_Object vector
)
10669 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10670 Vdeactivate_mark
= AREF (vector
, 1);
10671 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10673 if (WINDOWP (AREF (vector
, 3)))
10676 Lisp_Object buffer
;
10678 w
= XWINDOW (AREF (vector
, 3));
10679 buffer
= AREF (vector
, 4);
10681 wset_buffer (w
, buffer
);
10682 set_marker_both (w
->pointm
, buffer
,
10683 XFASTINT (AREF (vector
, 5)),
10684 XFASTINT (AREF (vector
, 6)));
10685 set_marker_both (w
->old_pointm
, buffer
,
10686 XFASTINT (AREF (vector
, 7)),
10687 XFASTINT (AREF (vector
, 8)));
10688 set_marker_both (w
->start
, buffer
,
10689 XFASTINT (AREF (vector
, 9)),
10690 XFASTINT (AREF (vector
, 10)));
10693 Vwith_echo_area_save_vector
= vector
;
10697 /* Set up the echo area for use by print functions. MULTIBYTE_P
10698 means we will print multibyte. */
10701 setup_echo_area_for_printing (bool multibyte_p
)
10703 /* If we can't find an echo area any more, exit. */
10704 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10705 Fkill_emacs (Qnil
);
10707 ensure_echo_area_buffers ();
10709 if (!message_buf_print
)
10711 /* A message has been output since the last time we printed.
10712 Choose a fresh echo area buffer. */
10713 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10714 echo_area_buffer
[0] = echo_buffer
[1];
10716 echo_area_buffer
[0] = echo_buffer
[0];
10718 /* Switch to that buffer and clear it. */
10719 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10720 bset_truncate_lines (current_buffer
, Qnil
);
10724 ptrdiff_t count
= SPECPDL_INDEX ();
10725 specbind (Qinhibit_read_only
, Qt
);
10726 /* Note that undo recording is always disabled. */
10727 del_range (BEG
, Z
);
10728 unbind_to (count
, Qnil
);
10730 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10732 /* Set up the buffer for the multibyteness we need. */
10734 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10735 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10737 /* Raise the frame containing the echo area. */
10738 if (minibuffer_auto_raise
)
10740 struct frame
*sf
= SELECTED_FRAME ();
10741 Lisp_Object mini_window
;
10742 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10743 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10746 message_log_maybe_newline ();
10747 message_buf_print
= true;
10751 if (NILP (echo_area_buffer
[0]))
10753 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10754 echo_area_buffer
[0] = echo_buffer
[1];
10756 echo_area_buffer
[0] = echo_buffer
[0];
10759 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10761 /* Someone switched buffers between print requests. */
10762 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10763 bset_truncate_lines (current_buffer
, Qnil
);
10769 /* Display an echo area message in window W. Value is true if W's
10770 height is changed. If display_last_displayed_message_p,
10771 display the message that was last displayed, otherwise
10772 display the current message. */
10775 display_echo_area (struct window
*w
)
10777 bool no_message_p
, window_height_changed_p
;
10779 /* Temporarily disable garbage collections while displaying the echo
10780 area. This is done because a GC can print a message itself.
10781 That message would modify the echo area buffer's contents while a
10782 redisplay of the buffer is going on, and seriously confuse
10784 ptrdiff_t count
= inhibit_garbage_collection ();
10786 /* If there is no message, we must call display_echo_area_1
10787 nevertheless because it resizes the window. But we will have to
10788 reset the echo_area_buffer in question to nil at the end because
10789 with_echo_area_buffer will sets it to an empty buffer. */
10790 bool i
= display_last_displayed_message_p
;
10791 /* According to the C99, C11 and C++11 standards, the integral value
10792 of a "bool" is always 0 or 1, so this array access is safe here,
10794 no_message_p
= NILP (echo_area_buffer
[i
]);
10796 window_height_changed_p
10797 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10798 display_echo_area_1
,
10799 (intptr_t) w
, Qnil
);
10802 echo_area_buffer
[i
] = Qnil
;
10804 unbind_to (count
, Qnil
);
10805 return window_height_changed_p
;
10809 /* Helper for display_echo_area. Display the current buffer which
10810 contains the current echo area message in window W, a mini-window,
10811 a pointer to which is passed in A1. A2..A4 are currently not used.
10812 Change the height of W so that all of the message is displayed.
10813 Value is true if height of W was changed. */
10816 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10819 struct window
*w
= (struct window
*) i1
;
10820 Lisp_Object window
;
10821 struct text_pos start
;
10823 /* We are about to enter redisplay without going through
10824 redisplay_internal, so we need to forget these faces by hand
10826 forget_escape_and_glyphless_faces ();
10828 /* Do this before displaying, so that we have a large enough glyph
10829 matrix for the display. If we can't get enough space for the
10830 whole text, display the last N lines. That works by setting w->start. */
10831 bool window_height_changed_p
= resize_mini_window (w
, false);
10833 /* Use the starting position chosen by resize_mini_window. */
10834 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10837 clear_glyph_matrix (w
->desired_matrix
);
10838 XSETWINDOW (window
, w
);
10839 try_window (window
, start
, 0);
10841 return window_height_changed_p
;
10845 /* Resize the echo area window to exactly the size needed for the
10846 currently displayed message, if there is one. If a mini-buffer
10847 is active, don't shrink it. */
10850 resize_echo_area_exactly (void)
10852 if (BUFFERP (echo_area_buffer
[0])
10853 && WINDOWP (echo_area_window
))
10855 struct window
*w
= XWINDOW (echo_area_window
);
10856 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10857 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10858 (intptr_t) w
, resize_exactly
);
10861 windows_or_buffers_changed
= 42;
10862 update_mode_lines
= 30;
10863 redisplay_internal ();
10869 /* Callback function for with_echo_area_buffer, when used from
10870 resize_echo_area_exactly. A1 contains a pointer to the window to
10871 resize, EXACTLY non-nil means resize the mini-window exactly to the
10872 size of the text displayed. A3 and A4 are not used. Value is what
10873 resize_mini_window returns. */
10876 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10879 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10883 /* Resize mini-window W to fit the size of its contents. EXACT_P
10884 means size the window exactly to the size needed. Otherwise, it's
10885 only enlarged until W's buffer is empty.
10887 Set W->start to the right place to begin display. If the whole
10888 contents fit, start at the beginning. Otherwise, start so as
10889 to make the end of the contents appear. This is particularly
10890 important for y-or-n-p, but seems desirable generally.
10892 Value is true if the window height has been changed. */
10895 resize_mini_window (struct window
*w
, bool exact_p
)
10897 struct frame
*f
= XFRAME (w
->frame
);
10898 bool window_height_changed_p
= false;
10900 eassert (MINI_WINDOW_P (w
));
10902 /* By default, start display at the beginning. */
10903 set_marker_both (w
->start
, w
->contents
,
10904 BUF_BEGV (XBUFFER (w
->contents
)),
10905 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10907 /* Don't resize windows while redisplaying a window; it would
10908 confuse redisplay functions when the size of the window they are
10909 displaying changes from under them. Such a resizing can happen,
10910 for instance, when which-func prints a long message while
10911 we are running fontification-functions. We're running these
10912 functions with safe_call which binds inhibit-redisplay to t. */
10913 if (!NILP (Vinhibit_redisplay
))
10916 /* Nil means don't try to resize. */
10917 if (NILP (Vresize_mini_windows
)
10918 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10921 if (!FRAME_MINIBUF_ONLY_P (f
))
10924 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10925 + WINDOW_PIXEL_HEIGHT (w
));
10926 int unit
= FRAME_LINE_HEIGHT (f
);
10927 int height
, max_height
;
10928 struct text_pos start
;
10929 struct buffer
*old_current_buffer
= NULL
;
10931 if (current_buffer
!= XBUFFER (w
->contents
))
10933 old_current_buffer
= current_buffer
;
10934 set_buffer_internal (XBUFFER (w
->contents
));
10937 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10939 /* Compute the max. number of lines specified by the user. */
10940 if (FLOATP (Vmax_mini_window_height
))
10941 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10942 else if (INTEGERP (Vmax_mini_window_height
))
10943 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10945 max_height
= total_height
/ 4;
10947 /* Correct that max. height if it's bogus. */
10948 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10950 /* Find out the height of the text in the window. */
10951 if (it
.line_wrap
== TRUNCATE
)
10956 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10957 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10958 height
= it
.current_y
+ last_height
;
10960 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10961 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10964 /* Compute a suitable window start. */
10965 if (height
> max_height
)
10967 height
= (max_height
/ unit
) * unit
;
10968 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10969 move_it_vertically_backward (&it
, height
- unit
);
10970 start
= it
.current
.pos
;
10973 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10974 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10976 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10978 /* Let it grow only, until we display an empty message, in which
10979 case the window shrinks again. */
10980 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10982 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10984 FRAME_WINDOWS_FROZEN (f
) = true;
10985 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10986 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10988 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10989 && (exact_p
|| BEGV
== ZV
))
10991 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10993 FRAME_WINDOWS_FROZEN (f
) = false;
10994 shrink_mini_window (w
, true);
10995 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11000 /* Always resize to exact size needed. */
11001 if (height
> WINDOW_PIXEL_HEIGHT (w
))
11003 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11005 FRAME_WINDOWS_FROZEN (f
) = true;
11006 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11007 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11009 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
11011 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
11013 FRAME_WINDOWS_FROZEN (f
) = false;
11014 shrink_mini_window (w
, true);
11018 FRAME_WINDOWS_FROZEN (f
) = true;
11019 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
11022 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11026 if (old_current_buffer
)
11027 set_buffer_internal (old_current_buffer
);
11030 return window_height_changed_p
;
11034 /* Value is the current message, a string, or nil if there is no
11035 current message. */
11038 current_message (void)
11042 if (!BUFFERP (echo_area_buffer
[0]))
11046 with_echo_area_buffer (0, 0, current_message_1
,
11047 (intptr_t) &msg
, Qnil
);
11049 echo_area_buffer
[0] = Qnil
;
11057 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11060 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11063 *msg
= make_buffer_string (BEG
, Z
, true);
11070 /* Push the current message on Vmessage_stack for later restoration
11071 by restore_message. Value is true if the current message isn't
11072 empty. This is a relatively infrequent operation, so it's not
11073 worth optimizing. */
11076 push_message (void)
11078 Lisp_Object msg
= current_message ();
11079 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11080 return STRINGP (msg
);
11084 /* Restore message display from the top of Vmessage_stack. */
11087 restore_message (void)
11089 eassert (CONSP (Vmessage_stack
));
11090 message3_nolog (XCAR (Vmessage_stack
));
11094 /* Handler for unwind-protect calling pop_message. */
11097 pop_message_unwind (void)
11099 /* Pop the top-most entry off Vmessage_stack. */
11100 eassert (CONSP (Vmessage_stack
));
11101 Vmessage_stack
= XCDR (Vmessage_stack
);
11105 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11106 exits. If the stack is not empty, we have a missing pop_message
11110 check_message_stack (void)
11112 if (!NILP (Vmessage_stack
))
11117 /* Truncate to NCHARS what will be displayed in the echo area the next
11118 time we display it---but don't redisplay it now. */
11121 truncate_echo_area (ptrdiff_t nchars
)
11124 echo_area_buffer
[0] = Qnil
;
11125 else if (!noninteractive
11127 && !NILP (echo_area_buffer
[0]))
11129 struct frame
*sf
= SELECTED_FRAME ();
11130 /* Error messages get reported properly by cmd_error, so this must be
11131 just an informative message; if the frame hasn't really been
11132 initialized yet, just toss it. */
11133 if (sf
->glyphs_initialized_p
)
11134 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11139 /* Helper function for truncate_echo_area. Truncate the current
11140 message to at most NCHARS characters. */
11143 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11145 if (BEG
+ nchars
< Z
)
11146 del_range (BEG
+ nchars
, Z
);
11148 echo_area_buffer
[0] = Qnil
;
11152 /* Set the current message to STRING. */
11155 set_message (Lisp_Object string
)
11157 eassert (STRINGP (string
));
11159 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11161 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11162 message_buf_print
= false;
11163 help_echo_showing_p
= false;
11165 if (STRINGP (Vdebug_on_message
)
11166 && STRINGP (string
)
11167 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11168 call_debugger (list2 (Qerror
, string
));
11172 /* Helper function for set_message. First argument is ignored and second
11173 argument has the same meaning as for set_message.
11174 This function is called with the echo area buffer being current. */
11177 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11179 eassert (STRINGP (string
));
11181 /* Change multibyteness of the echo buffer appropriately. */
11182 if (message_enable_multibyte
11183 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11184 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11186 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11187 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11188 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11190 /* Insert new message at BEG. */
11191 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11193 /* This function takes care of single/multibyte conversion.
11194 We just have to ensure that the echo area buffer has the right
11195 setting of enable_multibyte_characters. */
11196 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11202 /* Clear messages. CURRENT_P means clear the current message.
11203 LAST_DISPLAYED_P means clear the message last displayed. */
11206 clear_message (bool current_p
, bool last_displayed_p
)
11210 echo_area_buffer
[0] = Qnil
;
11211 message_cleared_p
= true;
11214 if (last_displayed_p
)
11215 echo_area_buffer
[1] = Qnil
;
11217 message_buf_print
= false;
11220 /* Clear garbaged frames.
11222 This function is used where the old redisplay called
11223 redraw_garbaged_frames which in turn called redraw_frame which in
11224 turn called clear_frame. The call to clear_frame was a source of
11225 flickering. I believe a clear_frame is not necessary. It should
11226 suffice in the new redisplay to invalidate all current matrices,
11227 and ensure a complete redisplay of all windows. */
11230 clear_garbaged_frames (void)
11232 if (frame_garbaged
)
11234 Lisp_Object tail
, frame
;
11235 struct frame
*sf
= SELECTED_FRAME ();
11237 FOR_EACH_FRAME (tail
, frame
)
11239 struct frame
*f
= XFRAME (frame
);
11241 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11244 /* It makes no sense to redraw a non-selected TTY
11245 frame, since that will actually clear the
11246 selected frame, and might leave the selected
11247 frame with corrupted display, if it happens not
11248 to be marked garbaged. */
11249 && !(f
!= sf
&& (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))))
11252 clear_current_matrices (f
);
11253 fset_redisplay (f
);
11254 f
->garbaged
= false;
11255 f
->resized_p
= false;
11259 frame_garbaged
= false;
11264 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11268 echo_area_display (bool update_frame_p
)
11270 Lisp_Object mini_window
;
11273 bool window_height_changed_p
= false;
11274 struct frame
*sf
= SELECTED_FRAME ();
11276 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11277 w
= XWINDOW (mini_window
);
11278 f
= XFRAME (WINDOW_FRAME (w
));
11280 /* Don't display if frame is invisible or not yet initialized. */
11281 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11284 #ifdef HAVE_WINDOW_SYSTEM
11285 /* When Emacs starts, selected_frame may be the initial terminal
11286 frame. If we let this through, a message would be displayed on
11288 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11290 #endif /* HAVE_WINDOW_SYSTEM */
11292 /* Redraw garbaged frames. */
11293 clear_garbaged_frames ();
11295 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11297 echo_area_window
= mini_window
;
11298 window_height_changed_p
= display_echo_area (w
);
11299 w
->must_be_updated_p
= true;
11301 /* Update the display, unless called from redisplay_internal.
11302 Also don't update the screen during redisplay itself. The
11303 update will happen at the end of redisplay, and an update
11304 here could cause confusion. */
11305 if (update_frame_p
&& !redisplaying_p
)
11309 /* If the display update has been interrupted by pending
11310 input, update mode lines in the frame. Due to the
11311 pending input, it might have been that redisplay hasn't
11312 been called, so that mode lines above the echo area are
11313 garbaged. This looks odd, so we prevent it here. */
11314 if (!display_completed
)
11315 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11317 if (window_height_changed_p
11318 /* Don't do this if Emacs is shutting down. Redisplay
11319 needs to run hooks. */
11320 && !NILP (Vrun_hooks
))
11322 /* Must update other windows. Likewise as in other
11323 cases, don't let this update be interrupted by
11325 ptrdiff_t count
= SPECPDL_INDEX ();
11326 specbind (Qredisplay_dont_pause
, Qt
);
11327 fset_redisplay (f
);
11328 redisplay_internal ();
11329 unbind_to (count
, Qnil
);
11331 else if (FRAME_WINDOW_P (f
) && n
== 0)
11333 /* Window configuration is the same as before.
11334 Can do with a display update of the echo area,
11335 unless we displayed some mode lines. */
11336 update_single_window (w
);
11340 update_frame (f
, true, true);
11342 /* If cursor is in the echo area, make sure that the next
11343 redisplay displays the minibuffer, so that the cursor will
11344 be replaced with what the minibuffer wants. */
11345 if (cursor_in_echo_area
)
11346 wset_redisplay (XWINDOW (mini_window
));
11349 else if (!EQ (mini_window
, selected_window
))
11350 wset_redisplay (XWINDOW (mini_window
));
11352 /* Last displayed message is now the current message. */
11353 echo_area_buffer
[1] = echo_area_buffer
[0];
11354 /* Inform read_char that we're not echoing. */
11355 echo_message_buffer
= Qnil
;
11357 /* Prevent redisplay optimization in redisplay_internal by resetting
11358 this_line_start_pos. This is done because the mini-buffer now
11359 displays the message instead of its buffer text. */
11360 if (EQ (mini_window
, selected_window
))
11361 CHARPOS (this_line_start_pos
) = 0;
11363 if (window_height_changed_p
)
11365 fset_redisplay (f
);
11367 /* If window configuration was changed, frames may have been
11368 marked garbaged. Clear them or we will experience
11369 surprises wrt scrolling.
11370 FIXME: How/why/when? */
11371 clear_garbaged_frames ();
11375 /* True if W's buffer was changed but not saved. */
11378 window_buffer_changed (struct window
*w
)
11380 struct buffer
*b
= XBUFFER (w
->contents
);
11382 eassert (BUFFER_LIVE_P (b
));
11384 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11387 /* True if W has %c in its mode line and mode line should be updated. */
11390 mode_line_update_needed (struct window
*w
)
11392 return (w
->column_number_displayed
!= -1
11393 && !(PT
== w
->last_point
&& !window_outdated (w
))
11394 && (w
->column_number_displayed
!= current_column ()));
11397 /* True if window start of W is frozen and may not be changed during
11401 window_frozen_p (struct window
*w
)
11403 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11405 Lisp_Object window
;
11407 XSETWINDOW (window
, w
);
11408 if (MINI_WINDOW_P (w
))
11410 else if (EQ (window
, selected_window
))
11412 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11413 && EQ (window
, Vminibuf_scroll_window
))
11414 /* This special window can't be frozen too. */
11422 /***********************************************************************
11423 Mode Lines and Frame Titles
11424 ***********************************************************************/
11426 /* A buffer for constructing non-propertized mode-line strings and
11427 frame titles in it; allocated from the heap in init_xdisp and
11428 resized as needed in store_mode_line_noprop_char. */
11430 static char *mode_line_noprop_buf
;
11432 /* The buffer's end, and a current output position in it. */
11434 static char *mode_line_noprop_buf_end
;
11435 static char *mode_line_noprop_ptr
;
11437 #define MODE_LINE_NOPROP_LEN(start) \
11438 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11441 MODE_LINE_DISPLAY
= 0,
11445 } mode_line_target
;
11447 /* Alist that caches the results of :propertize.
11448 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11449 static Lisp_Object mode_line_proptrans_alist
;
11451 /* List of strings making up the mode-line. */
11452 static Lisp_Object mode_line_string_list
;
11454 /* Base face property when building propertized mode line string. */
11455 static Lisp_Object mode_line_string_face
;
11456 static Lisp_Object mode_line_string_face_prop
;
11459 /* Unwind data for mode line strings */
11461 static Lisp_Object Vmode_line_unwind_vector
;
11464 format_mode_line_unwind_data (struct frame
*target_frame
,
11465 struct buffer
*obuf
,
11467 bool save_proptrans
)
11469 Lisp_Object vector
, tmp
;
11471 /* Reduce consing by keeping one vector in
11472 Vwith_echo_area_save_vector. */
11473 vector
= Vmode_line_unwind_vector
;
11474 Vmode_line_unwind_vector
= Qnil
;
11477 vector
= Fmake_vector (make_number (10), Qnil
);
11479 ASET (vector
, 0, make_number (mode_line_target
));
11480 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11481 ASET (vector
, 2, mode_line_string_list
);
11482 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11483 ASET (vector
, 4, mode_line_string_face
);
11484 ASET (vector
, 5, mode_line_string_face_prop
);
11487 XSETBUFFER (tmp
, obuf
);
11490 ASET (vector
, 6, tmp
);
11491 ASET (vector
, 7, owin
);
11494 /* Similarly to `with-selected-window', if the operation selects
11495 a window on another frame, we must restore that frame's
11496 selected window, and (for a tty) the top-frame. */
11497 ASET (vector
, 8, target_frame
->selected_window
);
11498 if (FRAME_TERMCAP_P (target_frame
))
11499 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11506 unwind_format_mode_line (Lisp_Object vector
)
11508 Lisp_Object old_window
= AREF (vector
, 7);
11509 Lisp_Object target_frame_window
= AREF (vector
, 8);
11510 Lisp_Object old_top_frame
= AREF (vector
, 9);
11512 mode_line_target
= XINT (AREF (vector
, 0));
11513 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11514 mode_line_string_list
= AREF (vector
, 2);
11515 if (! EQ (AREF (vector
, 3), Qt
))
11516 mode_line_proptrans_alist
= AREF (vector
, 3);
11517 mode_line_string_face
= AREF (vector
, 4);
11518 mode_line_string_face_prop
= AREF (vector
, 5);
11520 /* Select window before buffer, since it may change the buffer. */
11521 if (!NILP (old_window
))
11523 /* If the operation that we are unwinding had selected a window
11524 on a different frame, reset its frame-selected-window. For a
11525 text terminal, reset its top-frame if necessary. */
11526 if (!NILP (target_frame_window
))
11529 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11531 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11532 Fselect_window (target_frame_window
, Qt
);
11534 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11535 Fselect_frame (old_top_frame
, Qt
);
11538 Fselect_window (old_window
, Qt
);
11541 if (!NILP (AREF (vector
, 6)))
11543 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11544 ASET (vector
, 6, Qnil
);
11547 Vmode_line_unwind_vector
= vector
;
11551 /* Store a single character C for the frame title in mode_line_noprop_buf.
11552 Re-allocate mode_line_noprop_buf if necessary. */
11555 store_mode_line_noprop_char (char c
)
11557 /* If output position has reached the end of the allocated buffer,
11558 increase the buffer's size. */
11559 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11561 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11562 ptrdiff_t size
= len
;
11563 mode_line_noprop_buf
=
11564 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11565 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11566 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11569 *mode_line_noprop_ptr
++ = c
;
11573 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11574 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11575 characters that yield more columns than PRECISION; PRECISION <= 0
11576 means copy the whole string. Pad with spaces until FIELD_WIDTH
11577 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11578 pad. Called from display_mode_element when it is used to build a
11582 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11584 const unsigned char *str
= (const unsigned char *) string
;
11586 ptrdiff_t dummy
, nbytes
;
11588 /* Copy at most PRECISION chars from STR. */
11589 nbytes
= strlen (string
);
11590 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11592 store_mode_line_noprop_char (*str
++);
11594 /* Fill up with spaces until FIELD_WIDTH reached. */
11595 while (field_width
> 0
11596 && n
< field_width
)
11598 store_mode_line_noprop_char (' ');
11605 /***********************************************************************
11607 ***********************************************************************/
11609 #ifdef HAVE_WINDOW_SYSTEM
11611 /* Set the title of FRAME, if it has changed. The title format is
11612 Vicon_title_format if FRAME is iconified, otherwise it is
11613 frame_title_format. */
11616 x_consider_frame_title (Lisp_Object frame
)
11618 struct frame
*f
= XFRAME (frame
);
11620 if ((FRAME_WINDOW_P (f
)
11621 || FRAME_MINIBUF_ONLY_P (f
)
11622 || f
->explicit_name
)
11623 && NILP (Fframe_parameter (frame
, Qtooltip
)))
11625 /* Do we have more than one visible frame on this X display? */
11626 Lisp_Object tail
, other_frame
, fmt
;
11627 ptrdiff_t title_start
;
11631 ptrdiff_t count
= SPECPDL_INDEX ();
11633 FOR_EACH_FRAME (tail
, other_frame
)
11635 struct frame
*tf
= XFRAME (other_frame
);
11638 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11639 && !FRAME_MINIBUF_ONLY_P (tf
)
11640 && !EQ (other_frame
, tip_frame
)
11641 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11645 /* Set global variable indicating that multiple frames exist. */
11646 multiple_frames
= CONSP (tail
);
11648 /* Switch to the buffer of selected window of the frame. Set up
11649 mode_line_target so that display_mode_element will output into
11650 mode_line_noprop_buf; then display the title. */
11651 record_unwind_protect (unwind_format_mode_line
,
11652 format_mode_line_unwind_data
11653 (f
, current_buffer
, selected_window
, false));
11655 Fselect_window (f
->selected_window
, Qt
);
11656 set_buffer_internal_1
11657 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11658 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11660 mode_line_target
= MODE_LINE_TITLE
;
11661 title_start
= MODE_LINE_NOPROP_LEN (0);
11662 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11663 NULL
, DEFAULT_FACE_ID
);
11664 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11665 len
= MODE_LINE_NOPROP_LEN (title_start
);
11666 title
= mode_line_noprop_buf
+ title_start
;
11667 unbind_to (count
, Qnil
);
11669 /* Set the title only if it's changed. This avoids consing in
11670 the common case where it hasn't. (If it turns out that we've
11671 already wasted too much time by walking through the list with
11672 display_mode_element, then we might need to optimize at a
11673 higher level than this.) */
11674 if (! STRINGP (f
->name
)
11675 || SBYTES (f
->name
) != len
11676 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11677 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11681 #endif /* not HAVE_WINDOW_SYSTEM */
11684 /***********************************************************************
11686 ***********************************************************************/
11688 /* True if we will not redisplay all visible windows. */
11689 #define REDISPLAY_SOME_P() \
11690 ((windows_or_buffers_changed == 0 \
11691 || windows_or_buffers_changed == REDISPLAY_SOME) \
11692 && (update_mode_lines == 0 \
11693 || update_mode_lines == REDISPLAY_SOME))
11695 /* Prepare for redisplay by updating menu-bar item lists when
11696 appropriate. This can call eval. */
11699 prepare_menu_bars (void)
11701 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11702 bool some_windows
= REDISPLAY_SOME_P ();
11703 Lisp_Object tooltip_frame
;
11705 #ifdef HAVE_WINDOW_SYSTEM
11706 tooltip_frame
= tip_frame
;
11708 tooltip_frame
= Qnil
;
11711 if (FUNCTIONP (Vpre_redisplay_function
))
11713 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11714 if (all_windows
&& some_windows
)
11716 Lisp_Object ws
= window_list ();
11717 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11719 Lisp_Object
this = XCAR (ws
);
11720 struct window
*w
= XWINDOW (this);
11722 || XFRAME (w
->frame
)->redisplay
11723 || XBUFFER (w
->contents
)->text
->redisplay
)
11725 windows
= Fcons (this, windows
);
11729 safe__call1 (true, Vpre_redisplay_function
, windows
);
11732 /* Update all frame titles based on their buffer names, etc. We do
11733 this before the menu bars so that the buffer-menu will show the
11734 up-to-date frame titles. */
11735 #ifdef HAVE_WINDOW_SYSTEM
11738 Lisp_Object tail
, frame
;
11740 FOR_EACH_FRAME (tail
, frame
)
11742 struct frame
*f
= XFRAME (frame
);
11743 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11747 && !XBUFFER (w
->contents
)->text
->redisplay
)
11750 if (!EQ (frame
, tooltip_frame
)
11751 && (FRAME_ICONIFIED_P (f
)
11752 || FRAME_VISIBLE_P (f
) == 1
11753 /* Exclude TTY frames that are obscured because they
11754 are not the top frame on their console. This is
11755 because x_consider_frame_title actually switches
11756 to the frame, which for TTY frames means it is
11757 marked as garbaged, and will be completely
11758 redrawn on the next redisplay cycle. This causes
11759 TTY frames to be completely redrawn, when there
11760 are more than one of them, even though nothing
11761 should be changed on display. */
11762 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11763 x_consider_frame_title (frame
);
11766 #endif /* HAVE_WINDOW_SYSTEM */
11768 /* Update the menu bar item lists, if appropriate. This has to be
11769 done before any actual redisplay or generation of display lines. */
11773 Lisp_Object tail
, frame
;
11774 ptrdiff_t count
= SPECPDL_INDEX ();
11775 /* True means that update_menu_bar has run its hooks
11776 so any further calls to update_menu_bar shouldn't do so again. */
11777 bool menu_bar_hooks_run
= false;
11779 record_unwind_save_match_data ();
11781 FOR_EACH_FRAME (tail
, frame
)
11783 struct frame
*f
= XFRAME (frame
);
11784 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11786 /* Ignore tooltip frame. */
11787 if (EQ (frame
, tooltip_frame
))
11793 && !XBUFFER (w
->contents
)->text
->redisplay
)
11796 run_window_size_change_functions (frame
);
11797 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11798 #ifdef HAVE_WINDOW_SYSTEM
11799 update_tool_bar (f
, false);
11803 unbind_to (count
, Qnil
);
11807 struct frame
*sf
= SELECTED_FRAME ();
11808 update_menu_bar (sf
, true, false);
11809 #ifdef HAVE_WINDOW_SYSTEM
11810 update_tool_bar (sf
, true);
11816 /* Update the menu bar item list for frame F. This has to be done
11817 before we start to fill in any display lines, because it can call
11820 If SAVE_MATCH_DATA, we must save and restore it here.
11822 If HOOKS_RUN, a previous call to update_menu_bar
11823 already ran the menu bar hooks for this redisplay, so there
11824 is no need to run them again. The return value is the
11825 updated value of this flag, to pass to the next call. */
11828 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11830 Lisp_Object window
;
11833 /* If called recursively during a menu update, do nothing. This can
11834 happen when, for instance, an activate-menubar-hook causes a
11836 if (inhibit_menubar_update
)
11839 window
= FRAME_SELECTED_WINDOW (f
);
11840 w
= XWINDOW (window
);
11842 if (FRAME_WINDOW_P (f
)
11844 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11845 || defined (HAVE_NS) || defined (USE_GTK)
11846 FRAME_EXTERNAL_MENU_BAR (f
)
11848 FRAME_MENU_BAR_LINES (f
) > 0
11850 : FRAME_MENU_BAR_LINES (f
) > 0)
11852 /* If the user has switched buffers or windows, we need to
11853 recompute to reflect the new bindings. But we'll
11854 recompute when update_mode_lines is set too; that means
11855 that people can use force-mode-line-update to request
11856 that the menu bar be recomputed. The adverse effect on
11857 the rest of the redisplay algorithm is about the same as
11858 windows_or_buffers_changed anyway. */
11859 if (windows_or_buffers_changed
11860 /* This used to test w->update_mode_line, but we believe
11861 there is no need to recompute the menu in that case. */
11862 || update_mode_lines
11863 || window_buffer_changed (w
))
11865 struct buffer
*prev
= current_buffer
;
11866 ptrdiff_t count
= SPECPDL_INDEX ();
11868 specbind (Qinhibit_menubar_update
, Qt
);
11870 set_buffer_internal_1 (XBUFFER (w
->contents
));
11871 if (save_match_data
)
11872 record_unwind_save_match_data ();
11873 if (NILP (Voverriding_local_map_menu_flag
))
11875 specbind (Qoverriding_terminal_local_map
, Qnil
);
11876 specbind (Qoverriding_local_map
, Qnil
);
11881 /* Run the Lucid hook. */
11882 safe_run_hooks (Qactivate_menubar_hook
);
11884 /* If it has changed current-menubar from previous value,
11885 really recompute the menu-bar from the value. */
11886 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11887 call0 (Qrecompute_lucid_menubar
);
11889 safe_run_hooks (Qmenu_bar_update_hook
);
11894 XSETFRAME (Vmenu_updating_frame
, f
);
11895 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11897 /* Redisplay the menu bar in case we changed it. */
11898 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11899 || defined (HAVE_NS) || defined (USE_GTK)
11900 if (FRAME_WINDOW_P (f
))
11902 #if defined (HAVE_NS)
11903 /* All frames on Mac OS share the same menubar. So only
11904 the selected frame should be allowed to set it. */
11905 if (f
== SELECTED_FRAME ())
11907 set_frame_menubar (f
, false, false);
11910 /* On a terminal screen, the menu bar is an ordinary screen
11911 line, and this makes it get updated. */
11912 w
->update_mode_line
= true;
11913 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11914 /* In the non-toolkit version, the menu bar is an ordinary screen
11915 line, and this makes it get updated. */
11916 w
->update_mode_line
= true;
11917 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11919 unbind_to (count
, Qnil
);
11920 set_buffer_internal_1 (prev
);
11927 /***********************************************************************
11929 ***********************************************************************/
11931 #ifdef HAVE_WINDOW_SYSTEM
11933 /* Select `frame' temporarily without running all the code in
11935 FIXME: Maybe do_switch_frame should be trimmed down similarly
11936 when `norecord' is set. */
11938 fast_set_selected_frame (Lisp_Object frame
)
11940 if (!EQ (selected_frame
, frame
))
11942 selected_frame
= frame
;
11943 selected_window
= XFRAME (frame
)->selected_window
;
11947 /* Update the tool-bar item list for frame F. This has to be done
11948 before we start to fill in any display lines. Called from
11949 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11950 and restore it here. */
11953 update_tool_bar (struct frame
*f
, bool save_match_data
)
11955 #if defined (USE_GTK) || defined (HAVE_NS)
11956 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11958 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11959 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11964 Lisp_Object window
;
11967 window
= FRAME_SELECTED_WINDOW (f
);
11968 w
= XWINDOW (window
);
11970 /* If the user has switched buffers or windows, we need to
11971 recompute to reflect the new bindings. But we'll
11972 recompute when update_mode_lines is set too; that means
11973 that people can use force-mode-line-update to request
11974 that the menu bar be recomputed. The adverse effect on
11975 the rest of the redisplay algorithm is about the same as
11976 windows_or_buffers_changed anyway. */
11977 if (windows_or_buffers_changed
11978 || w
->update_mode_line
11979 || update_mode_lines
11980 || window_buffer_changed (w
))
11982 struct buffer
*prev
= current_buffer
;
11983 ptrdiff_t count
= SPECPDL_INDEX ();
11984 Lisp_Object frame
, new_tool_bar
;
11985 int new_n_tool_bar
;
11987 /* Set current_buffer to the buffer of the selected
11988 window of the frame, so that we get the right local
11990 set_buffer_internal_1 (XBUFFER (w
->contents
));
11992 /* Save match data, if we must. */
11993 if (save_match_data
)
11994 record_unwind_save_match_data ();
11996 /* Make sure that we don't accidentally use bogus keymaps. */
11997 if (NILP (Voverriding_local_map_menu_flag
))
11999 specbind (Qoverriding_terminal_local_map
, Qnil
);
12000 specbind (Qoverriding_local_map
, Qnil
);
12003 /* We must temporarily set the selected frame to this frame
12004 before calling tool_bar_items, because the calculation of
12005 the tool-bar keymap uses the selected frame (see
12006 `tool-bar-make-keymap' in tool-bar.el). */
12007 eassert (EQ (selected_window
,
12008 /* Since we only explicitly preserve selected_frame,
12009 check that selected_window would be redundant. */
12010 XFRAME (selected_frame
)->selected_window
));
12011 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12012 XSETFRAME (frame
, f
);
12013 fast_set_selected_frame (frame
);
12015 /* Build desired tool-bar items from keymaps. */
12017 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12020 /* Redisplay the tool-bar if we changed it. */
12021 if (new_n_tool_bar
!= f
->n_tool_bar_items
12022 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12024 /* Redisplay that happens asynchronously due to an expose event
12025 may access f->tool_bar_items. Make sure we update both
12026 variables within BLOCK_INPUT so no such event interrupts. */
12028 fset_tool_bar_items (f
, new_tool_bar
);
12029 f
->n_tool_bar_items
= new_n_tool_bar
;
12030 w
->update_mode_line
= true;
12034 unbind_to (count
, Qnil
);
12035 set_buffer_internal_1 (prev
);
12040 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12042 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12043 F's desired tool-bar contents. F->tool_bar_items must have
12044 been set up previously by calling prepare_menu_bars. */
12047 build_desired_tool_bar_string (struct frame
*f
)
12049 int i
, size
, size_needed
;
12050 Lisp_Object image
, plist
;
12052 image
= plist
= Qnil
;
12054 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12055 Otherwise, make a new string. */
12057 /* The size of the string we might be able to reuse. */
12058 size
= (STRINGP (f
->desired_tool_bar_string
)
12059 ? SCHARS (f
->desired_tool_bar_string
)
12062 /* We need one space in the string for each image. */
12063 size_needed
= f
->n_tool_bar_items
;
12065 /* Reuse f->desired_tool_bar_string, if possible. */
12066 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12067 fset_desired_tool_bar_string
12068 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12071 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12072 Fremove_text_properties (make_number (0), make_number (size
),
12073 props
, f
->desired_tool_bar_string
);
12076 /* Put a `display' property on the string for the images to display,
12077 put a `menu_item' property on tool-bar items with a value that
12078 is the index of the item in F's tool-bar item vector. */
12079 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12081 #define PROP(IDX) \
12082 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12084 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12085 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12086 int hmargin
, vmargin
, relief
, idx
, end
;
12088 /* If image is a vector, choose the image according to the
12090 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12091 if (VECTORP (image
))
12095 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12096 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12099 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12100 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12102 eassert (ASIZE (image
) >= idx
);
12103 image
= AREF (image
, idx
);
12108 /* Ignore invalid image specifications. */
12109 if (!valid_image_p (image
))
12112 /* Display the tool-bar button pressed, or depressed. */
12113 plist
= Fcopy_sequence (XCDR (image
));
12115 /* Compute margin and relief to draw. */
12116 relief
= (tool_bar_button_relief
>= 0
12117 ? tool_bar_button_relief
12118 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12119 hmargin
= vmargin
= relief
;
12121 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12122 INT_MAX
- max (hmargin
, vmargin
)))
12124 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12125 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12127 else if (CONSP (Vtool_bar_button_margin
))
12129 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12130 INT_MAX
- hmargin
))
12131 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12133 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12134 INT_MAX
- vmargin
))
12135 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12138 if (auto_raise_tool_bar_buttons_p
)
12140 /* Add a `:relief' property to the image spec if the item is
12144 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12151 /* If image is selected, display it pressed, i.e. with a
12152 negative relief. If it's not selected, display it with a
12154 plist
= Fplist_put (plist
, QCrelief
,
12156 ? make_number (-relief
)
12157 : make_number (relief
)));
12162 /* Put a margin around the image. */
12163 if (hmargin
|| vmargin
)
12165 if (hmargin
== vmargin
)
12166 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12168 plist
= Fplist_put (plist
, QCmargin
,
12169 Fcons (make_number (hmargin
),
12170 make_number (vmargin
)));
12173 /* If button is not enabled, and we don't have special images
12174 for the disabled state, make the image appear disabled by
12175 applying an appropriate algorithm to it. */
12176 if (!enabled_p
&& idx
< 0)
12177 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12179 /* Put a `display' text property on the string for the image to
12180 display. Put a `menu-item' property on the string that gives
12181 the start of this item's properties in the tool-bar items
12183 image
= Fcons (Qimage
, plist
);
12184 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12185 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12187 /* Let the last image hide all remaining spaces in the tool bar
12188 string. The string can be longer than needed when we reuse a
12189 previous string. */
12190 if (i
+ 1 == f
->n_tool_bar_items
)
12191 end
= SCHARS (f
->desired_tool_bar_string
);
12194 Fadd_text_properties (make_number (i
), make_number (end
),
12195 props
, f
->desired_tool_bar_string
);
12201 /* Display one line of the tool-bar of frame IT->f.
12203 HEIGHT specifies the desired height of the tool-bar line.
12204 If the actual height of the glyph row is less than HEIGHT, the
12205 row's height is increased to HEIGHT, and the icons are centered
12206 vertically in the new height.
12208 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12209 count a final empty row in case the tool-bar width exactly matches
12214 display_tool_bar_line (struct it
*it
, int height
)
12216 struct glyph_row
*row
= it
->glyph_row
;
12217 int max_x
= it
->last_visible_x
;
12218 struct glyph
*last
;
12220 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12221 clear_glyph_row (row
);
12222 row
->enabled_p
= true;
12223 row
->y
= it
->current_y
;
12225 /* Note that this isn't made use of if the face hasn't a box,
12226 so there's no need to check the face here. */
12227 it
->start_of_box_run_p
= true;
12229 while (it
->current_x
< max_x
)
12231 int x
, n_glyphs_before
, i
, nglyphs
;
12232 struct it it_before
;
12234 /* Get the next display element. */
12235 if (!get_next_display_element (it
))
12237 /* Don't count empty row if we are counting needed tool-bar lines. */
12238 if (height
< 0 && !it
->hpos
)
12243 /* Produce glyphs. */
12244 n_glyphs_before
= row
->used
[TEXT_AREA
];
12247 PRODUCE_GLYPHS (it
);
12249 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12251 x
= it_before
.current_x
;
12252 while (i
< nglyphs
)
12254 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12256 if (x
+ glyph
->pixel_width
> max_x
)
12258 /* Glyph doesn't fit on line. Backtrack. */
12259 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12261 /* If this is the only glyph on this line, it will never fit on the
12262 tool-bar, so skip it. But ensure there is at least one glyph,
12263 so we don't accidentally disable the tool-bar. */
12264 if (n_glyphs_before
== 0
12265 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12271 x
+= glyph
->pixel_width
;
12275 /* Stop at line end. */
12276 if (ITERATOR_AT_END_OF_LINE_P (it
))
12279 set_iterator_to_next (it
, true);
12284 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12286 /* Use default face for the border below the tool bar.
12288 FIXME: When auto-resize-tool-bars is grow-only, there is
12289 no additional border below the possibly empty tool-bar lines.
12290 So to make the extra empty lines look "normal", we have to
12291 use the tool-bar face for the border too. */
12292 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12293 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12294 it
->face_id
= DEFAULT_FACE_ID
;
12296 extend_face_to_end_of_line (it
);
12297 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12298 last
->right_box_line_p
= true;
12299 if (last
== row
->glyphs
[TEXT_AREA
])
12300 last
->left_box_line_p
= true;
12302 /* Make line the desired height and center it vertically. */
12303 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12305 /* Don't add more than one line height. */
12306 height
%= FRAME_LINE_HEIGHT (it
->f
);
12307 it
->max_ascent
+= height
/ 2;
12308 it
->max_descent
+= (height
+ 1) / 2;
12311 compute_line_metrics (it
);
12313 /* If line is empty, make it occupy the rest of the tool-bar. */
12314 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12316 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12317 row
->visible_height
= row
->height
;
12318 row
->ascent
= row
->phys_ascent
= 0;
12319 row
->extra_line_spacing
= 0;
12322 row
->full_width_p
= true;
12323 row
->continued_p
= false;
12324 row
->truncated_on_left_p
= false;
12325 row
->truncated_on_right_p
= false;
12327 it
->current_x
= it
->hpos
= 0;
12328 it
->current_y
+= row
->height
;
12334 /* Value is the number of pixels needed to make all tool-bar items of
12335 frame F visible. The actual number of glyph rows needed is
12336 returned in *N_ROWS if non-NULL. */
12338 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12340 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12342 /* tool_bar_height is called from redisplay_tool_bar after building
12343 the desired matrix, so use (unused) mode-line row as temporary row to
12344 avoid destroying the first tool-bar row. */
12345 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12347 /* Initialize an iterator for iteration over
12348 F->desired_tool_bar_string in the tool-bar window of frame F. */
12349 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12350 temp_row
->reversed_p
= false;
12351 it
.first_visible_x
= 0;
12352 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12353 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12354 it
.paragraph_embedding
= L2R
;
12356 while (!ITERATOR_AT_END_P (&it
))
12358 clear_glyph_row (temp_row
);
12359 it
.glyph_row
= temp_row
;
12360 display_tool_bar_line (&it
, -1);
12362 clear_glyph_row (temp_row
);
12364 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12366 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12369 return it
.current_y
;
12371 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12374 #endif /* !USE_GTK && !HAVE_NS */
12376 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12378 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12379 If FRAME is nil or omitted, use the selected frame. Optional argument
12380 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12381 (Lisp_Object frame
, Lisp_Object pixelwise
)
12385 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12386 struct frame
*f
= decode_any_frame (frame
);
12388 if (WINDOWP (f
->tool_bar_window
)
12389 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12391 update_tool_bar (f
, true);
12392 if (f
->n_tool_bar_items
)
12394 build_desired_tool_bar_string (f
);
12395 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12400 return make_number (height
);
12404 /* Display the tool-bar of frame F. Value is true if tool-bar's
12405 height should be changed. */
12407 redisplay_tool_bar (struct frame
*f
)
12409 f
->tool_bar_redisplayed
= true;
12410 #if defined (USE_GTK) || defined (HAVE_NS)
12412 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12413 update_frame_tool_bar (f
);
12416 #else /* !USE_GTK && !HAVE_NS */
12420 struct glyph_row
*row
;
12422 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12423 do anything. This means you must start with tool-bar-lines
12424 non-zero to get the auto-sizing effect. Or in other words, you
12425 can turn off tool-bars by specifying tool-bar-lines zero. */
12426 if (!WINDOWP (f
->tool_bar_window
)
12427 || (w
= XWINDOW (f
->tool_bar_window
),
12428 WINDOW_TOTAL_LINES (w
) == 0))
12431 /* Set up an iterator for the tool-bar window. */
12432 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12433 it
.first_visible_x
= 0;
12434 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12435 row
= it
.glyph_row
;
12436 row
->reversed_p
= false;
12438 /* Build a string that represents the contents of the tool-bar. */
12439 build_desired_tool_bar_string (f
);
12440 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12441 /* FIXME: This should be controlled by a user option. But it
12442 doesn't make sense to have an R2L tool bar if the menu bar cannot
12443 be drawn also R2L, and making the menu bar R2L is tricky due
12444 toolkit-specific code that implements it. If an R2L tool bar is
12445 ever supported, display_tool_bar_line should also be augmented to
12446 call unproduce_glyphs like display_line and display_string
12448 it
.paragraph_embedding
= L2R
;
12450 if (f
->n_tool_bar_rows
== 0)
12452 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12454 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12456 x_change_tool_bar_height (f
, new_height
);
12457 frame_default_tool_bar_height
= new_height
;
12458 /* Always do that now. */
12459 clear_glyph_matrix (w
->desired_matrix
);
12460 f
->fonts_changed
= true;
12465 /* Display as many lines as needed to display all tool-bar items. */
12467 if (f
->n_tool_bar_rows
> 0)
12469 int border
, rows
, height
, extra
;
12471 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12472 border
= XINT (Vtool_bar_border
);
12473 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12474 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12475 else if (EQ (Vtool_bar_border
, Qborder_width
))
12476 border
= f
->border_width
;
12482 rows
= f
->n_tool_bar_rows
;
12483 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12484 extra
= it
.last_visible_y
- border
- height
* rows
;
12486 while (it
.current_y
< it
.last_visible_y
)
12489 if (extra
> 0 && rows
-- > 0)
12491 h
= (extra
+ rows
- 1) / rows
;
12494 display_tool_bar_line (&it
, height
+ h
);
12499 while (it
.current_y
< it
.last_visible_y
)
12500 display_tool_bar_line (&it
, 0);
12503 /* It doesn't make much sense to try scrolling in the tool-bar
12504 window, so don't do it. */
12505 w
->desired_matrix
->no_scrolling_p
= true;
12506 w
->must_be_updated_p
= true;
12508 if (!NILP (Vauto_resize_tool_bars
))
12510 bool change_height_p
= true;
12512 /* If we couldn't display everything, change the tool-bar's
12513 height if there is room for more. */
12514 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12515 change_height_p
= true;
12517 /* We subtract 1 because display_tool_bar_line advances the
12518 glyph_row pointer before returning to its caller. We want to
12519 examine the last glyph row produced by
12520 display_tool_bar_line. */
12521 row
= it
.glyph_row
- 1;
12523 /* If there are blank lines at the end, except for a partially
12524 visible blank line at the end that is smaller than
12525 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12526 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12527 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12528 change_height_p
= true;
12530 /* If row displays tool-bar items, but is partially visible,
12531 change the tool-bar's height. */
12532 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12533 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12534 change_height_p
= true;
12536 /* Resize windows as needed by changing the `tool-bar-lines'
12537 frame parameter. */
12538 if (change_height_p
)
12541 int new_height
= tool_bar_height (f
, &nrows
, true);
12543 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12544 && !f
->minimize_tool_bar_window_p
)
12545 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12546 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12547 f
->minimize_tool_bar_window_p
= false;
12549 if (change_height_p
)
12551 x_change_tool_bar_height (f
, new_height
);
12552 frame_default_tool_bar_height
= new_height
;
12553 clear_glyph_matrix (w
->desired_matrix
);
12554 f
->n_tool_bar_rows
= nrows
;
12555 f
->fonts_changed
= true;
12562 f
->minimize_tool_bar_window_p
= false;
12565 #endif /* USE_GTK || HAVE_NS */
12568 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12570 /* Get information about the tool-bar item which is displayed in GLYPH
12571 on frame F. Return in *PROP_IDX the index where tool-bar item
12572 properties start in F->tool_bar_items. Value is false if
12573 GLYPH doesn't display a tool-bar item. */
12576 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12581 /* This function can be called asynchronously, which means we must
12582 exclude any possibility that Fget_text_property signals an
12584 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12585 charpos
= max (0, charpos
);
12587 /* Get the text property `menu-item' at pos. The value of that
12588 property is the start index of this item's properties in
12589 F->tool_bar_items. */
12590 prop
= Fget_text_property (make_number (charpos
),
12591 Qmenu_item
, f
->current_tool_bar_string
);
12592 if (! INTEGERP (prop
))
12594 *prop_idx
= XINT (prop
);
12599 /* Get information about the tool-bar item at position X/Y on frame F.
12600 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12601 the current matrix of the tool-bar window of F, or NULL if not
12602 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12603 item in F->tool_bar_items. Value is
12605 -1 if X/Y is not on a tool-bar item
12606 0 if X/Y is on the same item that was highlighted before.
12610 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12611 int *hpos
, int *vpos
, int *prop_idx
)
12613 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12614 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12617 /* Find the glyph under X/Y. */
12618 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12619 if (*glyph
== NULL
)
12622 /* Get the start of this tool-bar item's properties in
12623 f->tool_bar_items. */
12624 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12627 /* Is mouse on the highlighted item? */
12628 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12629 && *vpos
>= hlinfo
->mouse_face_beg_row
12630 && *vpos
<= hlinfo
->mouse_face_end_row
12631 && (*vpos
> hlinfo
->mouse_face_beg_row
12632 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12633 && (*vpos
< hlinfo
->mouse_face_end_row
12634 || *hpos
< hlinfo
->mouse_face_end_col
12635 || hlinfo
->mouse_face_past_end
))
12643 Handle mouse button event on the tool-bar of frame F, at
12644 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12645 false for button release. MODIFIERS is event modifiers for button
12649 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12652 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12653 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12654 int hpos
, vpos
, prop_idx
;
12655 struct glyph
*glyph
;
12656 Lisp_Object enabled_p
;
12659 /* If not on the highlighted tool-bar item, and mouse-highlight is
12660 non-nil, return. This is so we generate the tool-bar button
12661 click only when the mouse button is released on the same item as
12662 where it was pressed. However, when mouse-highlight is disabled,
12663 generate the click when the button is released regardless of the
12664 highlight, since tool-bar items are not highlighted in that
12666 frame_to_window_pixel_xy (w
, &x
, &y
);
12667 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12669 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12672 /* When mouse-highlight is off, generate the click for the item
12673 where the button was pressed, disregarding where it was
12675 if (NILP (Vmouse_highlight
) && !down_p
)
12676 prop_idx
= f
->last_tool_bar_item
;
12678 /* If item is disabled, do nothing. */
12679 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12680 if (NILP (enabled_p
))
12685 /* Show item in pressed state. */
12686 if (!NILP (Vmouse_highlight
))
12687 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12688 f
->last_tool_bar_item
= prop_idx
;
12692 Lisp_Object key
, frame
;
12693 struct input_event event
;
12694 EVENT_INIT (event
);
12696 /* Show item in released state. */
12697 if (!NILP (Vmouse_highlight
))
12698 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12700 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12702 XSETFRAME (frame
, f
);
12703 event
.kind
= TOOL_BAR_EVENT
;
12704 event
.frame_or_window
= frame
;
12706 kbd_buffer_store_event (&event
);
12708 event
.kind
= TOOL_BAR_EVENT
;
12709 event
.frame_or_window
= frame
;
12711 event
.modifiers
= modifiers
;
12712 kbd_buffer_store_event (&event
);
12713 f
->last_tool_bar_item
= -1;
12718 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12719 tool-bar window-relative coordinates X/Y. Called from
12720 note_mouse_highlight. */
12723 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12725 Lisp_Object window
= f
->tool_bar_window
;
12726 struct window
*w
= XWINDOW (window
);
12727 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12728 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12730 struct glyph
*glyph
;
12731 struct glyph_row
*row
;
12733 Lisp_Object enabled_p
;
12735 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12739 /* Function note_mouse_highlight is called with negative X/Y
12740 values when mouse moves outside of the frame. */
12741 if (x
<= 0 || y
<= 0)
12743 clear_mouse_face (hlinfo
);
12747 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12750 /* Not on tool-bar item. */
12751 clear_mouse_face (hlinfo
);
12755 /* On same tool-bar item as before. */
12756 goto set_help_echo
;
12758 clear_mouse_face (hlinfo
);
12760 /* Mouse is down, but on different tool-bar item? */
12761 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12762 && f
== dpyinfo
->last_mouse_frame
);
12764 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12767 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12769 /* If tool-bar item is not enabled, don't highlight it. */
12770 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12771 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12773 /* Compute the x-position of the glyph. In front and past the
12774 image is a space. We include this in the highlighted area. */
12775 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12776 for (i
= x
= 0; i
< hpos
; ++i
)
12777 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12779 /* Record this as the current active region. */
12780 hlinfo
->mouse_face_beg_col
= hpos
;
12781 hlinfo
->mouse_face_beg_row
= vpos
;
12782 hlinfo
->mouse_face_beg_x
= x
;
12783 hlinfo
->mouse_face_past_end
= false;
12785 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12786 hlinfo
->mouse_face_end_row
= vpos
;
12787 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12788 hlinfo
->mouse_face_window
= window
;
12789 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12791 /* Display it as active. */
12792 show_mouse_face (hlinfo
, draw
);
12797 /* Set help_echo_string to a help string to display for this tool-bar item.
12798 XTread_socket does the rest. */
12799 help_echo_object
= help_echo_window
= Qnil
;
12800 help_echo_pos
= -1;
12801 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12802 if (NILP (help_echo_string
))
12803 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12806 #endif /* !USE_GTK && !HAVE_NS */
12808 #endif /* HAVE_WINDOW_SYSTEM */
12812 /************************************************************************
12813 Horizontal scrolling
12814 ************************************************************************/
12816 /* For all leaf windows in the window tree rooted at WINDOW, set their
12817 hscroll value so that PT is (i) visible in the window, and (ii) so
12818 that it is not within a certain margin at the window's left and
12819 right border. Value is true if any window's hscroll has been
12823 hscroll_window_tree (Lisp_Object window
)
12825 bool hscrolled_p
= false;
12826 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12827 int hscroll_step_abs
= 0;
12828 double hscroll_step_rel
= 0;
12830 if (hscroll_relative_p
)
12832 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12833 if (hscroll_step_rel
< 0)
12835 hscroll_relative_p
= false;
12836 hscroll_step_abs
= 0;
12839 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12841 hscroll_step_abs
= XINT (Vhscroll_step
);
12842 if (hscroll_step_abs
< 0)
12843 hscroll_step_abs
= 0;
12846 hscroll_step_abs
= 0;
12848 while (WINDOWP (window
))
12850 struct window
*w
= XWINDOW (window
);
12852 if (WINDOWP (w
->contents
))
12853 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12854 else if (w
->cursor
.vpos
>= 0)
12857 int text_area_width
;
12858 struct glyph_row
*cursor_row
;
12859 struct glyph_row
*bottom_row
;
12861 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12862 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12863 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12865 cursor_row
= bottom_row
- 1;
12867 if (!cursor_row
->enabled_p
)
12869 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12870 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12871 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12873 cursor_row
= bottom_row
- 1;
12875 bool row_r2l_p
= cursor_row
->reversed_p
;
12877 text_area_width
= window_box_width (w
, TEXT_AREA
);
12879 /* Scroll when cursor is inside this scroll margin. */
12880 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12882 /* If the position of this window's point has explicitly
12883 changed, no more suspend auto hscrolling. */
12884 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12885 w
->suspend_auto_hscroll
= false;
12887 /* Remember window point. */
12888 Fset_marker (w
->old_pointm
,
12889 ((w
== XWINDOW (selected_window
))
12890 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12891 : Fmarker_position (w
->pointm
)),
12894 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12895 && !w
->suspend_auto_hscroll
12896 /* In some pathological cases, like restoring a window
12897 configuration into a frame that is much smaller than
12898 the one from which the configuration was saved, we
12899 get glyph rows whose start and end have zero buffer
12900 positions, which we cannot handle below. Just skip
12902 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12903 /* For left-to-right rows, hscroll when cursor is either
12904 (i) inside the right hscroll margin, or (ii) if it is
12905 inside the left margin and the window is already
12908 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12909 || (cursor_row
->enabled_p
12910 && cursor_row
->truncated_on_right_p
12911 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12912 /* For right-to-left rows, the logic is similar,
12913 except that rules for scrolling to left and right
12914 are reversed. E.g., if cursor.x <= h_margin, we
12915 need to hscroll "to the right" unconditionally,
12916 and that will scroll the screen to the left so as
12917 to reveal the next portion of the row. */
12919 && ((cursor_row
->enabled_p
12920 /* FIXME: It is confusing to set the
12921 truncated_on_right_p flag when R2L rows
12922 are actually truncated on the left. */
12923 && cursor_row
->truncated_on_right_p
12924 && w
->cursor
.x
<= h_margin
)
12926 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12930 struct buffer
*saved_current_buffer
;
12934 /* Find point in a display of infinite width. */
12935 saved_current_buffer
= current_buffer
;
12936 current_buffer
= XBUFFER (w
->contents
);
12938 if (w
== XWINDOW (selected_window
))
12941 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12943 /* Move iterator to pt starting at cursor_row->start in
12944 a line with infinite width. */
12945 init_to_row_start (&it
, w
, cursor_row
);
12946 it
.last_visible_x
= INFINITY
;
12947 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12948 current_buffer
= saved_current_buffer
;
12950 /* Position cursor in window. */
12951 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12952 hscroll
= max (0, (it
.current_x
12953 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12954 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12955 : (text_area_width
/ 2))))
12956 / FRAME_COLUMN_WIDTH (it
.f
);
12957 else if ((!row_r2l_p
12958 && w
->cursor
.x
>= text_area_width
- h_margin
)
12959 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12961 if (hscroll_relative_p
)
12962 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12965 wanted_x
= text_area_width
12966 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12969 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12973 if (hscroll_relative_p
)
12974 wanted_x
= text_area_width
* hscroll_step_rel
12977 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12980 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12982 hscroll
= max (hscroll
, w
->min_hscroll
);
12984 /* Don't prevent redisplay optimizations if hscroll
12985 hasn't changed, as it will unnecessarily slow down
12987 if (w
->hscroll
!= hscroll
)
12989 struct buffer
*b
= XBUFFER (w
->contents
);
12990 b
->prevent_redisplay_optimizations_p
= true;
12991 w
->hscroll
= hscroll
;
12992 hscrolled_p
= true;
13000 /* Value is true if hscroll of any leaf window has been changed. */
13001 return hscrolled_p
;
13005 /* Set hscroll so that cursor is visible and not inside horizontal
13006 scroll margins for all windows in the tree rooted at WINDOW. See
13007 also hscroll_window_tree above. Value is true if any window's
13008 hscroll has been changed. If it has, desired matrices on the frame
13009 of WINDOW are cleared. */
13012 hscroll_windows (Lisp_Object window
)
13014 bool hscrolled_p
= hscroll_window_tree (window
);
13016 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13017 return hscrolled_p
;
13022 /************************************************************************
13024 ************************************************************************/
13026 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13027 This is sometimes handy to have in a debugger session. */
13031 /* First and last unchanged row for try_window_id. */
13033 static int debug_first_unchanged_at_end_vpos
;
13034 static int debug_last_unchanged_at_beg_vpos
;
13036 /* Delta vpos and y. */
13038 static int debug_dvpos
, debug_dy
;
13040 /* Delta in characters and bytes for try_window_id. */
13042 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13044 /* Values of window_end_pos and window_end_vpos at the end of
13047 static ptrdiff_t debug_end_vpos
;
13049 /* Append a string to W->desired_matrix->method. FMT is a printf
13050 format string. If trace_redisplay_p is true also printf the
13051 resulting string to stderr. */
13053 static void debug_method_add (struct window
*, char const *, ...)
13054 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13057 debug_method_add (struct window
*w
, char const *fmt
, ...)
13060 char *method
= w
->desired_matrix
->method
;
13061 int len
= strlen (method
);
13062 int size
= sizeof w
->desired_matrix
->method
;
13063 int remaining
= size
- len
- 1;
13066 if (len
&& remaining
)
13069 --remaining
, ++len
;
13072 va_start (ap
, fmt
);
13073 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13076 if (trace_redisplay_p
)
13077 fprintf (stderr
, "%p (%s): %s\n",
13079 ((BUFFERP (w
->contents
)
13080 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13081 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13086 #endif /* GLYPH_DEBUG */
13089 /* Value is true if all changes in window W, which displays
13090 current_buffer, are in the text between START and END. START is a
13091 buffer position, END is given as a distance from Z. Used in
13092 redisplay_internal for display optimization. */
13095 text_outside_line_unchanged_p (struct window
*w
,
13096 ptrdiff_t start
, ptrdiff_t end
)
13098 bool unchanged_p
= true;
13100 /* If text or overlays have changed, see where. */
13101 if (window_outdated (w
))
13103 /* Gap in the line? */
13104 if (GPT
< start
|| Z
- GPT
< end
)
13105 unchanged_p
= false;
13107 /* Changes start in front of the line, or end after it? */
13109 && (BEG_UNCHANGED
< start
- 1
13110 || END_UNCHANGED
< end
))
13111 unchanged_p
= false;
13113 /* If selective display, can't optimize if changes start at the
13114 beginning of the line. */
13116 && INTEGERP (BVAR (current_buffer
, selective_display
))
13117 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13118 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13119 unchanged_p
= false;
13121 /* If there are overlays at the start or end of the line, these
13122 may have overlay strings with newlines in them. A change at
13123 START, for instance, may actually concern the display of such
13124 overlay strings as well, and they are displayed on different
13125 lines. So, quickly rule out this case. (For the future, it
13126 might be desirable to implement something more telling than
13127 just BEG/END_UNCHANGED.) */
13130 if (BEG
+ BEG_UNCHANGED
== start
13131 && overlay_touches_p (start
))
13132 unchanged_p
= false;
13133 if (END_UNCHANGED
== end
13134 && overlay_touches_p (Z
- end
))
13135 unchanged_p
= false;
13138 /* Under bidi reordering, adding or deleting a character in the
13139 beginning of a paragraph, before the first strong directional
13140 character, can change the base direction of the paragraph (unless
13141 the buffer specifies a fixed paragraph direction), which will
13142 require redisplaying the whole paragraph. It might be worthwhile
13143 to find the paragraph limits and widen the range of redisplayed
13144 lines to that, but for now just give up this optimization. */
13145 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13146 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13147 unchanged_p
= false;
13150 return unchanged_p
;
13154 /* Do a frame update, taking possible shortcuts into account. This is
13155 the main external entry point for redisplay.
13157 If the last redisplay displayed an echo area message and that message
13158 is no longer requested, we clear the echo area or bring back the
13159 mini-buffer if that is in use. */
13164 redisplay_internal ();
13169 overlay_arrow_string_or_property (Lisp_Object var
)
13173 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13176 return Voverlay_arrow_string
;
13179 /* Return true if there are any overlay-arrows in current_buffer. */
13181 overlay_arrow_in_current_buffer_p (void)
13185 for (vlist
= Voverlay_arrow_variable_list
;
13187 vlist
= XCDR (vlist
))
13189 Lisp_Object var
= XCAR (vlist
);
13192 if (!SYMBOLP (var
))
13194 val
= find_symbol_value (var
);
13196 && current_buffer
== XMARKER (val
)->buffer
)
13203 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13207 overlay_arrows_changed_p (void)
13211 for (vlist
= Voverlay_arrow_variable_list
;
13213 vlist
= XCDR (vlist
))
13215 Lisp_Object var
= XCAR (vlist
);
13216 Lisp_Object val
, pstr
;
13218 if (!SYMBOLP (var
))
13220 val
= find_symbol_value (var
);
13221 if (!MARKERP (val
))
13223 if (! EQ (COERCE_MARKER (val
),
13224 Fget (var
, Qlast_arrow_position
))
13225 || ! (pstr
= overlay_arrow_string_or_property (var
),
13226 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13232 /* Mark overlay arrows to be updated on next redisplay. */
13235 update_overlay_arrows (int up_to_date
)
13239 for (vlist
= Voverlay_arrow_variable_list
;
13241 vlist
= XCDR (vlist
))
13243 Lisp_Object var
= XCAR (vlist
);
13245 if (!SYMBOLP (var
))
13248 if (up_to_date
> 0)
13250 Lisp_Object val
= find_symbol_value (var
);
13251 Fput (var
, Qlast_arrow_position
,
13252 COERCE_MARKER (val
));
13253 Fput (var
, Qlast_arrow_string
,
13254 overlay_arrow_string_or_property (var
));
13256 else if (up_to_date
< 0
13257 || !NILP (Fget (var
, Qlast_arrow_position
)))
13259 Fput (var
, Qlast_arrow_position
, Qt
);
13260 Fput (var
, Qlast_arrow_string
, Qt
);
13266 /* Return overlay arrow string to display at row.
13267 Return integer (bitmap number) for arrow bitmap in left fringe.
13268 Return nil if no overlay arrow. */
13271 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13275 for (vlist
= Voverlay_arrow_variable_list
;
13277 vlist
= XCDR (vlist
))
13279 Lisp_Object var
= XCAR (vlist
);
13282 if (!SYMBOLP (var
))
13285 val
= find_symbol_value (var
);
13288 && current_buffer
== XMARKER (val
)->buffer
13289 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13291 if (FRAME_WINDOW_P (it
->f
)
13292 /* FIXME: if ROW->reversed_p is set, this should test
13293 the right fringe, not the left one. */
13294 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13296 #ifdef HAVE_WINDOW_SYSTEM
13297 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13299 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13300 if (fringe_bitmap
!= 0)
13301 return make_number (fringe_bitmap
);
13304 return make_number (-1); /* Use default arrow bitmap. */
13306 return overlay_arrow_string_or_property (var
);
13313 /* Return true if point moved out of or into a composition. Otherwise
13314 return false. PREV_BUF and PREV_PT are the last point buffer and
13315 position. BUF and PT are the current point buffer and position. */
13318 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13319 struct buffer
*buf
, ptrdiff_t pt
)
13321 ptrdiff_t start
, end
;
13323 Lisp_Object buffer
;
13325 XSETBUFFER (buffer
, buf
);
13326 /* Check a composition at the last point if point moved within the
13328 if (prev_buf
== buf
)
13331 /* Point didn't move. */
13334 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13335 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13336 && composition_valid_p (start
, end
, prop
)
13337 && start
< prev_pt
&& end
> prev_pt
)
13338 /* The last point was within the composition. Return true iff
13339 point moved out of the composition. */
13340 return (pt
<= start
|| pt
>= end
);
13343 /* Check a composition at the current point. */
13344 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13345 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13346 && composition_valid_p (start
, end
, prop
)
13347 && start
< pt
&& end
> pt
);
13350 /* Reconsider the clip changes of buffer which is displayed in W. */
13353 reconsider_clip_changes (struct window
*w
)
13355 struct buffer
*b
= XBUFFER (w
->contents
);
13357 if (b
->clip_changed
13358 && w
->window_end_valid
13359 && w
->current_matrix
->buffer
== b
13360 && w
->current_matrix
->zv
== BUF_ZV (b
)
13361 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13362 b
->clip_changed
= false;
13364 /* If display wasn't paused, and W is not a tool bar window, see if
13365 point has been moved into or out of a composition. In that case,
13366 set b->clip_changed to force updating the screen. If
13367 b->clip_changed has already been set, skip this check. */
13368 if (!b
->clip_changed
&& w
->window_end_valid
)
13370 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13371 ? PT
: marker_position (w
->pointm
));
13373 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13374 && check_point_in_composition (w
->current_matrix
->buffer
,
13375 w
->last_point
, b
, pt
))
13376 b
->clip_changed
= true;
13381 propagate_buffer_redisplay (void)
13382 { /* Resetting b->text->redisplay is problematic!
13383 We can't just reset it in the case that some window that displays
13384 it has not been redisplayed; and such a window can stay
13385 unredisplayed for a long time if it's currently invisible.
13386 But we do want to reset it at the end of redisplay otherwise
13387 its displayed windows will keep being redisplayed over and over
13389 So we copy all b->text->redisplay flags up to their windows here,
13390 such that mark_window_display_accurate can safely reset
13391 b->text->redisplay. */
13392 Lisp_Object ws
= window_list ();
13393 for (; CONSP (ws
); ws
= XCDR (ws
))
13395 struct window
*thisw
= XWINDOW (XCAR (ws
));
13396 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13397 if (thisb
->text
->redisplay
)
13398 thisw
->redisplay
= true;
13402 #define STOP_POLLING \
13403 do { if (! polling_stopped_here) stop_polling (); \
13404 polling_stopped_here = true; } while (false)
13406 #define RESUME_POLLING \
13407 do { if (polling_stopped_here) start_polling (); \
13408 polling_stopped_here = false; } while (false)
13411 /* Perhaps in the future avoid recentering windows if it
13412 is not necessary; currently that causes some problems. */
13415 redisplay_internal (void)
13417 struct window
*w
= XWINDOW (selected_window
);
13421 bool must_finish
= false, match_p
;
13422 struct text_pos tlbufpos
, tlendpos
;
13423 int number_of_visible_frames
;
13426 bool polling_stopped_here
= false;
13427 Lisp_Object tail
, frame
;
13429 /* True means redisplay has to consider all windows on all
13430 frames. False, only selected_window is considered. */
13431 bool consider_all_windows_p
;
13433 /* True means redisplay has to redisplay the miniwindow. */
13434 bool update_miniwindow_p
= false;
13436 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13438 /* No redisplay if running in batch mode or frame is not yet fully
13439 initialized, or redisplay is explicitly turned off by setting
13440 Vinhibit_redisplay. */
13441 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13442 || !NILP (Vinhibit_redisplay
))
13445 /* Don't examine these until after testing Vinhibit_redisplay.
13446 When Emacs is shutting down, perhaps because its connection to
13447 X has dropped, we should not look at them at all. */
13448 fr
= XFRAME (w
->frame
);
13449 sf
= SELECTED_FRAME ();
13451 if (!fr
->glyphs_initialized_p
)
13454 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13455 if (popup_activated ())
13459 /* I don't think this happens but let's be paranoid. */
13460 if (redisplaying_p
)
13463 /* Record a function that clears redisplaying_p
13464 when we leave this function. */
13465 count
= SPECPDL_INDEX ();
13466 record_unwind_protect_void (unwind_redisplay
);
13467 redisplaying_p
= true;
13468 specbind (Qinhibit_free_realized_faces
, Qnil
);
13470 /* Record this function, so it appears on the profiler's backtraces. */
13471 record_in_backtrace (Qredisplay_internal
, 0, 0);
13473 FOR_EACH_FRAME (tail
, frame
)
13474 XFRAME (frame
)->already_hscrolled_p
= false;
13477 /* Remember the currently selected window. */
13481 forget_escape_and_glyphless_faces ();
13483 inhibit_free_realized_faces
= false;
13485 /* If face_change, init_iterator will free all realized faces, which
13486 includes the faces referenced from current matrices. So, we
13487 can't reuse current matrices in this case. */
13489 windows_or_buffers_changed
= 47;
13491 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13492 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13494 /* Since frames on a single ASCII terminal share the same
13495 display area, displaying a different frame means redisplay
13496 the whole thing. */
13497 SET_FRAME_GARBAGED (sf
);
13499 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13501 FRAME_TTY (sf
)->previous_frame
= sf
;
13504 /* Set the visible flags for all frames. Do this before checking for
13505 resized or garbaged frames; they want to know if their frames are
13506 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13507 number_of_visible_frames
= 0;
13509 FOR_EACH_FRAME (tail
, frame
)
13511 struct frame
*f
= XFRAME (frame
);
13513 if (FRAME_VISIBLE_P (f
))
13515 ++number_of_visible_frames
;
13516 /* Adjust matrices for visible frames only. */
13517 if (f
->fonts_changed
)
13519 adjust_frame_glyphs (f
);
13520 /* Disable all redisplay optimizations for this frame.
13521 This is because adjust_frame_glyphs resets the
13522 enabled_p flag for all glyph rows of all windows, so
13523 many optimizations will fail anyway, and some might
13524 fail to test that flag and do bogus things as
13526 SET_FRAME_GARBAGED (f
);
13527 f
->fonts_changed
= false;
13529 /* If cursor type has been changed on the frame
13530 other than selected, consider all frames. */
13531 if (f
!= sf
&& f
->cursor_type_changed
)
13532 fset_redisplay (f
);
13534 clear_desired_matrices (f
);
13537 /* Notice any pending interrupt request to change frame size. */
13538 do_pending_window_change (true);
13540 /* do_pending_window_change could change the selected_window due to
13541 frame resizing which makes the selected window too small. */
13542 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13545 /* Clear frames marked as garbaged. */
13546 clear_garbaged_frames ();
13548 /* Build menubar and tool-bar items. */
13549 if (NILP (Vmemory_full
))
13550 prepare_menu_bars ();
13552 reconsider_clip_changes (w
);
13554 /* In most cases selected window displays current buffer. */
13555 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13558 /* Detect case that we need to write or remove a star in the mode line. */
13559 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13560 w
->update_mode_line
= true;
13562 if (mode_line_update_needed (w
))
13563 w
->update_mode_line
= true;
13565 /* If reconsider_clip_changes above decided that the narrowing
13566 in the current buffer changed, make sure all other windows
13567 showing that buffer will be redisplayed. */
13568 if (current_buffer
->clip_changed
)
13569 bset_update_mode_line (current_buffer
);
13572 /* Normally the message* functions will have already displayed and
13573 updated the echo area, but the frame may have been trashed, or
13574 the update may have been preempted, so display the echo area
13575 again here. Checking message_cleared_p captures the case that
13576 the echo area should be cleared. */
13577 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13578 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13579 || (message_cleared_p
13580 && minibuf_level
== 0
13581 /* If the mini-window is currently selected, this means the
13582 echo-area doesn't show through. */
13583 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13585 echo_area_display (false);
13587 /* If echo_area_display resizes the mini-window, the redisplay and
13588 window_sizes_changed flags of the selected frame are set, but
13589 it's too late for the hooks in window-size-change-functions,
13590 which have been examined already in prepare_menu_bars. So in
13591 that case we call the hooks here only for the selected frame. */
13594 ptrdiff_t count1
= SPECPDL_INDEX ();
13596 record_unwind_save_match_data ();
13597 run_window_size_change_functions (selected_frame
);
13598 unbind_to (count1
, Qnil
);
13601 if (message_cleared_p
)
13602 update_miniwindow_p
= true;
13604 must_finish
= true;
13606 /* If we don't display the current message, don't clear the
13607 message_cleared_p flag, because, if we did, we wouldn't clear
13608 the echo area in the next redisplay which doesn't preserve
13610 if (!display_last_displayed_message_p
)
13611 message_cleared_p
= false;
13613 else if (EQ (selected_window
, minibuf_window
)
13614 && (current_buffer
->clip_changed
|| window_outdated (w
))
13615 && resize_mini_window (w
, false))
13619 ptrdiff_t count1
= SPECPDL_INDEX ();
13621 record_unwind_save_match_data ();
13622 run_window_size_change_functions (selected_frame
);
13623 unbind_to (count1
, Qnil
);
13626 /* Resized active mini-window to fit the size of what it is
13627 showing if its contents might have changed. */
13628 must_finish
= true;
13630 /* If window configuration was changed, frames may have been
13631 marked garbaged. Clear them or we will experience
13632 surprises wrt scrolling. */
13633 clear_garbaged_frames ();
13636 if (windows_or_buffers_changed
&& !update_mode_lines
)
13637 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13638 only the windows's contents needs to be refreshed, or whether the
13639 mode-lines also need a refresh. */
13640 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13641 ? REDISPLAY_SOME
: 32);
13643 /* If specs for an arrow have changed, do thorough redisplay
13644 to ensure we remove any arrow that should no longer exist. */
13645 if (overlay_arrows_changed_p ())
13646 /* Apparently, this is the only case where we update other windows,
13647 without updating other mode-lines. */
13648 windows_or_buffers_changed
= 49;
13650 consider_all_windows_p
= (update_mode_lines
13651 || windows_or_buffers_changed
);
13653 #define AINC(a,i) \
13655 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13656 if (INTEGERP (entry)) \
13657 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13660 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13661 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13663 /* Optimize the case that only the line containing the cursor in the
13664 selected window has changed. Variables starting with this_ are
13665 set in display_line and record information about the line
13666 containing the cursor. */
13667 tlbufpos
= this_line_start_pos
;
13668 tlendpos
= this_line_end_pos
;
13669 if (!consider_all_windows_p
13670 && CHARPOS (tlbufpos
) > 0
13671 && !w
->update_mode_line
13672 && !current_buffer
->clip_changed
13673 && !current_buffer
->prevent_redisplay_optimizations_p
13674 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13675 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13676 && !XFRAME (w
->frame
)->cursor_type_changed
13677 && !XFRAME (w
->frame
)->face_change
13678 /* Make sure recorded data applies to current buffer, etc. */
13679 && this_line_buffer
== current_buffer
13682 && !w
->optional_new_start
13683 /* Point must be on the line that we have info recorded about. */
13684 && PT
>= CHARPOS (tlbufpos
)
13685 && PT
<= Z
- CHARPOS (tlendpos
)
13686 /* All text outside that line, including its final newline,
13687 must be unchanged. */
13688 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13689 CHARPOS (tlendpos
)))
13691 if (CHARPOS (tlbufpos
) > BEGV
13692 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13693 && (CHARPOS (tlbufpos
) == ZV
13694 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13695 /* Former continuation line has disappeared by becoming empty. */
13697 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13699 /* We have to handle the case of continuation around a
13700 wide-column character (see the comment in indent.c around
13703 For instance, in the following case:
13705 -------- Insert --------
13706 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13707 J_I_ ==> J_I_ `^^' are cursors.
13711 As we have to redraw the line above, we cannot use this
13715 int line_height_before
= this_line_pixel_height
;
13717 /* Note that start_display will handle the case that the
13718 line starting at tlbufpos is a continuation line. */
13719 start_display (&it
, w
, tlbufpos
);
13721 /* Implementation note: It this still necessary? */
13722 if (it
.current_x
!= this_line_start_x
)
13725 TRACE ((stderr
, "trying display optimization 1\n"));
13726 w
->cursor
.vpos
= -1;
13727 overlay_arrow_seen
= false;
13728 it
.vpos
= this_line_vpos
;
13729 it
.current_y
= this_line_y
;
13730 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13731 display_line (&it
);
13733 /* If line contains point, is not continued,
13734 and ends at same distance from eob as before, we win. */
13735 if (w
->cursor
.vpos
>= 0
13736 /* Line is not continued, otherwise this_line_start_pos
13737 would have been set to 0 in display_line. */
13738 && CHARPOS (this_line_start_pos
)
13739 /* Line ends as before. */
13740 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13741 /* Line has same height as before. Otherwise other lines
13742 would have to be shifted up or down. */
13743 && this_line_pixel_height
== line_height_before
)
13745 /* If this is not the window's last line, we must adjust
13746 the charstarts of the lines below. */
13747 if (it
.current_y
< it
.last_visible_y
)
13749 struct glyph_row
*row
13750 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13751 ptrdiff_t delta
, delta_bytes
;
13753 /* We used to distinguish between two cases here,
13754 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13755 when the line ends in a newline or the end of the
13756 buffer's accessible portion. But both cases did
13757 the same, so they were collapsed. */
13759 - CHARPOS (tlendpos
)
13760 - MATRIX_ROW_START_CHARPOS (row
));
13761 delta_bytes
= (Z_BYTE
13762 - BYTEPOS (tlendpos
)
13763 - MATRIX_ROW_START_BYTEPOS (row
));
13765 increment_matrix_positions (w
->current_matrix
,
13766 this_line_vpos
+ 1,
13767 w
->current_matrix
->nrows
,
13768 delta
, delta_bytes
);
13771 /* If this row displays text now but previously didn't,
13772 or vice versa, w->window_end_vpos may have to be
13774 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13776 if (w
->window_end_vpos
< this_line_vpos
)
13777 w
->window_end_vpos
= this_line_vpos
;
13779 else if (w
->window_end_vpos
== this_line_vpos
13780 && this_line_vpos
> 0)
13781 w
->window_end_vpos
= this_line_vpos
- 1;
13782 w
->window_end_valid
= false;
13784 /* Update hint: No need to try to scroll in update_window. */
13785 w
->desired_matrix
->no_scrolling_p
= true;
13788 *w
->desired_matrix
->method
= 0;
13789 debug_method_add (w
, "optimization 1");
13791 #ifdef HAVE_WINDOW_SYSTEM
13792 update_window_fringes (w
, false);
13799 else if (/* Cursor position hasn't changed. */
13800 PT
== w
->last_point
13801 /* Make sure the cursor was last displayed
13802 in this window. Otherwise we have to reposition it. */
13804 /* PXW: Must be converted to pixels, probably. */
13805 && 0 <= w
->cursor
.vpos
13806 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13810 do_pending_window_change (true);
13811 /* If selected_window changed, redisplay again. */
13812 if (WINDOWP (selected_window
)
13813 && (w
= XWINDOW (selected_window
)) != sw
)
13816 /* We used to always goto end_of_redisplay here, but this
13817 isn't enough if we have a blinking cursor. */
13818 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13819 goto end_of_redisplay
;
13823 /* If highlighting the region, or if the cursor is in the echo area,
13824 then we can't just move the cursor. */
13825 else if (NILP (Vshow_trailing_whitespace
)
13826 && !cursor_in_echo_area
)
13829 struct glyph_row
*row
;
13831 /* Skip from tlbufpos to PT and see where it is. Note that
13832 PT may be in invisible text. If so, we will end at the
13833 next visible position. */
13834 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13835 NULL
, DEFAULT_FACE_ID
);
13836 it
.current_x
= this_line_start_x
;
13837 it
.current_y
= this_line_y
;
13838 it
.vpos
= this_line_vpos
;
13840 /* The call to move_it_to stops in front of PT, but
13841 moves over before-strings. */
13842 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13844 if (it
.vpos
== this_line_vpos
13845 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13848 eassert (this_line_vpos
== it
.vpos
);
13849 eassert (this_line_y
== it
.current_y
);
13850 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13851 if (cursor_row_fully_visible_p (w
, false, true))
13854 *w
->desired_matrix
->method
= 0;
13855 debug_method_add (w
, "optimization 3");
13867 /* Text changed drastically or point moved off of line. */
13868 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13871 CHARPOS (this_line_start_pos
) = 0;
13872 ++clear_face_cache_count
;
13873 #ifdef HAVE_WINDOW_SYSTEM
13874 ++clear_image_cache_count
;
13877 /* Build desired matrices, and update the display. If
13878 consider_all_windows_p, do it for all windows on all frames that
13879 require redisplay, as specified by their 'redisplay' flag.
13880 Otherwise do it for selected_window, only. */
13882 if (consider_all_windows_p
)
13884 FOR_EACH_FRAME (tail
, frame
)
13885 XFRAME (frame
)->updated_p
= false;
13887 propagate_buffer_redisplay ();
13889 FOR_EACH_FRAME (tail
, frame
)
13891 struct frame
*f
= XFRAME (frame
);
13893 /* We don't have to do anything for unselected terminal
13895 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13896 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13900 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13903 /* Only GC scrollbars when we redisplay the whole frame. */
13904 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13905 bool f_redisplay_flag
= f
->redisplay
;
13906 /* Mark all the scroll bars to be removed; we'll redeem
13907 the ones we want when we redisplay their windows. */
13908 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13909 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13911 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13912 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13913 /* Remember that the invisible frames need to be redisplayed next
13914 time they're visible. */
13915 else if (!REDISPLAY_SOME_P ())
13916 f
->redisplay
= true;
13918 /* The X error handler may have deleted that frame. */
13919 if (!FRAME_LIVE_P (f
))
13922 /* Any scroll bars which redisplay_windows should have
13923 nuked should now go away. */
13924 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13925 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13927 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13929 /* If fonts changed on visible frame, display again. */
13930 if (f
->fonts_changed
)
13932 adjust_frame_glyphs (f
);
13933 /* Disable all redisplay optimizations for this
13934 frame. For the reasons, see the comment near
13935 the previous call to adjust_frame_glyphs above. */
13936 SET_FRAME_GARBAGED (f
);
13937 f
->fonts_changed
= false;
13941 /* See if we have to hscroll. */
13942 if (!f
->already_hscrolled_p
)
13944 f
->already_hscrolled_p
= true;
13945 if (hscroll_windows (f
->root_window
))
13949 /* If the frame's redisplay flag was not set before
13950 we went about redisplaying its windows, but it is
13951 set now, that means we employed some redisplay
13952 optimizations inside redisplay_windows, and
13953 bypassed producing some screen lines. But if
13954 f->redisplay is now set, it might mean the old
13955 faces are no longer valid (e.g., if redisplaying
13956 some window called some Lisp which defined a new
13957 face or redefined an existing face), so trying to
13958 use them in update_frame will segfault.
13959 Therefore, we must redisplay this frame. */
13960 if (!f_redisplay_flag
&& f
->redisplay
)
13963 /* Prevent various kinds of signals during display
13964 update. stdio is not robust about handling
13965 signals, which can cause an apparent I/O error. */
13966 if (interrupt_input
)
13967 unrequest_sigio ();
13970 pending
|= update_frame (f
, false, false);
13971 f
->cursor_type_changed
= false;
13972 f
->updated_p
= true;
13977 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13981 /* Do the mark_window_display_accurate after all windows have
13982 been redisplayed because this call resets flags in buffers
13983 which are needed for proper redisplay. */
13984 FOR_EACH_FRAME (tail
, frame
)
13986 struct frame
*f
= XFRAME (frame
);
13989 f
->redisplay
= false;
13990 mark_window_display_accurate (f
->root_window
, true);
13991 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13992 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13997 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13999 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
14000 /* Use list_of_error, not Qerror, so that
14001 we catch only errors and don't run the debugger. */
14002 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14004 redisplay_window_error
);
14005 if (update_miniwindow_p
)
14006 internal_condition_case_1 (redisplay_window_1
,
14007 FRAME_MINIBUF_WINDOW (sf
), list_of_error
,
14008 redisplay_window_error
);
14010 /* Compare desired and current matrices, perform output. */
14013 /* If fonts changed, display again. Likewise if redisplay_window_1
14014 above caused some change (e.g., a change in faces) that requires
14015 considering the entire frame again. */
14016 if (sf
->fonts_changed
|| sf
->redisplay
)
14020 /* Set this to force a more thorough redisplay.
14021 Otherwise, we might immediately loop back to the
14022 above "else-if" clause (since all the conditions that
14023 led here might still be true), and we will then
14024 infloop, because the selected-frame's redisplay flag
14025 is not (and cannot be) reset. */
14026 windows_or_buffers_changed
= 50;
14031 /* Prevent freeing of realized faces, since desired matrices are
14032 pending that reference the faces we computed and cached. */
14033 inhibit_free_realized_faces
= true;
14035 /* Prevent various kinds of signals during display update.
14036 stdio is not robust about handling signals,
14037 which can cause an apparent I/O error. */
14038 if (interrupt_input
)
14039 unrequest_sigio ();
14042 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14044 if (hscroll_windows (selected_window
))
14047 XWINDOW (selected_window
)->must_be_updated_p
= true;
14048 pending
= update_frame (sf
, false, false);
14049 sf
->cursor_type_changed
= false;
14052 /* We may have called echo_area_display at the top of this
14053 function. If the echo area is on another frame, that may
14054 have put text on a frame other than the selected one, so the
14055 above call to update_frame would not have caught it. Catch
14057 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14058 struct frame
*mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14060 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14062 XWINDOW (mini_window
)->must_be_updated_p
= true;
14063 pending
|= update_frame (mini_frame
, false, false);
14064 mini_frame
->cursor_type_changed
= false;
14065 if (!pending
&& hscroll_windows (mini_window
))
14070 /* If display was paused because of pending input, make sure we do a
14071 thorough update the next time. */
14074 /* Prevent the optimization at the beginning of
14075 redisplay_internal that tries a single-line update of the
14076 line containing the cursor in the selected window. */
14077 CHARPOS (this_line_start_pos
) = 0;
14079 /* Let the overlay arrow be updated the next time. */
14080 update_overlay_arrows (0);
14082 /* If we pause after scrolling, some rows in the current
14083 matrices of some windows are not valid. */
14084 if (!WINDOW_FULL_WIDTH_P (w
)
14085 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14086 update_mode_lines
= 36;
14090 if (!consider_all_windows_p
)
14092 /* This has already been done above if
14093 consider_all_windows_p is set. */
14094 if (XBUFFER (w
->contents
)->text
->redisplay
14095 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14096 /* This can happen if b->text->redisplay was set during
14098 propagate_buffer_redisplay ();
14099 mark_window_display_accurate_1 (w
, true);
14101 /* Say overlay arrows are up to date. */
14102 update_overlay_arrows (1);
14104 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14105 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14108 update_mode_lines
= 0;
14109 windows_or_buffers_changed
= 0;
14112 /* Start SIGIO interrupts coming again. Having them off during the
14113 code above makes it less likely one will discard output, but not
14114 impossible, since there might be stuff in the system buffer here.
14115 But it is much hairier to try to do anything about that. */
14116 if (interrupt_input
)
14120 /* If a frame has become visible which was not before, redisplay
14121 again, so that we display it. Expose events for such a frame
14122 (which it gets when becoming visible) don't call the parts of
14123 redisplay constructing glyphs, so simply exposing a frame won't
14124 display anything in this case. So, we have to display these
14125 frames here explicitly. */
14130 FOR_EACH_FRAME (tail
, frame
)
14132 if (XFRAME (frame
)->visible
)
14136 if (new_count
!= number_of_visible_frames
)
14137 windows_or_buffers_changed
= 52;
14140 /* Change frame size now if a change is pending. */
14141 do_pending_window_change (true);
14143 /* If we just did a pending size change, or have additional
14144 visible frames, or selected_window changed, redisplay again. */
14145 if ((windows_or_buffers_changed
&& !pending
)
14146 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14149 /* Clear the face and image caches.
14151 We used to do this only if consider_all_windows_p. But the cache
14152 needs to be cleared if a timer creates images in the current
14153 buffer (e.g. the test case in Bug#6230). */
14155 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14157 clear_face_cache (false);
14158 clear_face_cache_count
= 0;
14161 #ifdef HAVE_WINDOW_SYSTEM
14162 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14164 clear_image_caches (Qnil
);
14165 clear_image_cache_count
= 0;
14167 #endif /* HAVE_WINDOW_SYSTEM */
14171 ns_set_doc_edited ();
14173 if (interrupt_input
&& interrupts_deferred
)
14176 unbind_to (count
, Qnil
);
14181 /* Redisplay, but leave alone any recent echo area message unless
14182 another message has been requested in its place.
14184 This is useful in situations where you need to redisplay but no
14185 user action has occurred, making it inappropriate for the message
14186 area to be cleared. See tracking_off and
14187 wait_reading_process_output for examples of these situations.
14189 FROM_WHERE is an integer saying from where this function was
14190 called. This is useful for debugging. */
14193 redisplay_preserve_echo_area (int from_where
)
14195 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14197 if (!NILP (echo_area_buffer
[1]))
14199 /* We have a previously displayed message, but no current
14200 message. Redisplay the previous message. */
14201 display_last_displayed_message_p
= true;
14202 redisplay_internal ();
14203 display_last_displayed_message_p
= false;
14206 redisplay_internal ();
14208 flush_frame (SELECTED_FRAME ());
14212 /* Function registered with record_unwind_protect in redisplay_internal. */
14215 unwind_redisplay (void)
14217 redisplaying_p
= false;
14221 /* Mark the display of leaf window W as accurate or inaccurate.
14222 If ACCURATE_P, mark display of W as accurate.
14223 If !ACCURATE_P, arrange for W to be redisplayed the next
14224 time redisplay_internal is called. */
14227 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14229 struct buffer
*b
= XBUFFER (w
->contents
);
14231 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14232 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14233 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14237 b
->clip_changed
= false;
14238 b
->prevent_redisplay_optimizations_p
= false;
14239 eassert (buffer_window_count (b
) > 0);
14240 /* Resetting b->text->redisplay is problematic!
14241 In order to make it safer to do it here, redisplay_internal must
14242 have copied all b->text->redisplay to their respective windows. */
14243 b
->text
->redisplay
= false;
14245 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14246 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14247 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14248 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14250 w
->current_matrix
->buffer
= b
;
14251 w
->current_matrix
->begv
= BUF_BEGV (b
);
14252 w
->current_matrix
->zv
= BUF_ZV (b
);
14254 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14255 w
->last_cursor_off_p
= w
->cursor_off_p
;
14257 if (w
== XWINDOW (selected_window
))
14258 w
->last_point
= BUF_PT (b
);
14260 w
->last_point
= marker_position (w
->pointm
);
14262 w
->window_end_valid
= true;
14263 w
->update_mode_line
= false;
14266 w
->redisplay
= !accurate_p
;
14270 /* Mark the display of windows in the window tree rooted at WINDOW as
14271 accurate or inaccurate. If ACCURATE_P, mark display of
14272 windows as accurate. If !ACCURATE_P, arrange for windows to
14273 be redisplayed the next time redisplay_internal is called. */
14276 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14280 for (; !NILP (window
); window
= w
->next
)
14282 w
= XWINDOW (window
);
14283 if (WINDOWP (w
->contents
))
14284 mark_window_display_accurate (w
->contents
, accurate_p
);
14286 mark_window_display_accurate_1 (w
, accurate_p
);
14290 update_overlay_arrows (1);
14292 /* Force a thorough redisplay the next time by setting
14293 last_arrow_position and last_arrow_string to t, which is
14294 unequal to any useful value of Voverlay_arrow_... */
14295 update_overlay_arrows (-1);
14299 /* Return value in display table DP (Lisp_Char_Table *) for character
14300 C. Since a display table doesn't have any parent, we don't have to
14301 follow parent. Do not call this function directly but use the
14302 macro DISP_CHAR_VECTOR. */
14305 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14309 if (ASCII_CHAR_P (c
))
14312 if (SUB_CHAR_TABLE_P (val
))
14313 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14319 XSETCHAR_TABLE (table
, dp
);
14320 val
= char_table_ref (table
, c
);
14329 /***********************************************************************
14331 ***********************************************************************/
14333 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14336 redisplay_windows (Lisp_Object window
)
14338 while (!NILP (window
))
14340 struct window
*w
= XWINDOW (window
);
14342 if (WINDOWP (w
->contents
))
14343 redisplay_windows (w
->contents
);
14344 else if (BUFFERP (w
->contents
))
14346 displayed_buffer
= XBUFFER (w
->contents
);
14347 /* Use list_of_error, not Qerror, so that
14348 we catch only errors and don't run the debugger. */
14349 internal_condition_case_1 (redisplay_window_0
, window
,
14351 redisplay_window_error
);
14359 redisplay_window_error (Lisp_Object ignore
)
14361 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14366 redisplay_window_0 (Lisp_Object window
)
14368 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14369 redisplay_window (window
, false);
14374 redisplay_window_1 (Lisp_Object window
)
14376 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14377 redisplay_window (window
, true);
14382 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14383 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14384 which positions recorded in ROW differ from current buffer
14387 Return true iff cursor is on this row. */
14390 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14391 struct glyph_matrix
*matrix
,
14392 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14395 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14396 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14397 struct glyph
*cursor
= NULL
;
14398 /* The last known character position in row. */
14399 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14401 ptrdiff_t pt_old
= PT
- delta
;
14402 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14403 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14404 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14405 /* A glyph beyond the edge of TEXT_AREA which we should never
14407 struct glyph
*glyphs_end
= end
;
14408 /* True means we've found a match for cursor position, but that
14409 glyph has the avoid_cursor_p flag set. */
14410 bool match_with_avoid_cursor
= false;
14411 /* True means we've seen at least one glyph that came from a
14413 bool string_seen
= false;
14414 /* Largest and smallest buffer positions seen so far during scan of
14416 ptrdiff_t bpos_max
= pos_before
;
14417 ptrdiff_t bpos_min
= pos_after
;
14418 /* Last buffer position covered by an overlay string with an integer
14419 `cursor' property. */
14420 ptrdiff_t bpos_covered
= 0;
14421 /* True means the display string on which to display the cursor
14422 comes from a text property, not from an overlay. */
14423 bool string_from_text_prop
= false;
14425 /* Don't even try doing anything if called for a mode-line or
14426 header-line row, since the rest of the code isn't prepared to
14427 deal with such calamities. */
14428 eassert (!row
->mode_line_p
);
14429 if (row
->mode_line_p
)
14432 /* Skip over glyphs not having an object at the start and the end of
14433 the row. These are special glyphs like truncation marks on
14434 terminal frames. */
14435 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14437 if (!row
->reversed_p
)
14440 && NILP (glyph
->object
)
14441 && glyph
->charpos
< 0)
14443 x
+= glyph
->pixel_width
;
14447 && NILP ((end
- 1)->object
)
14448 /* CHARPOS is zero for blanks and stretch glyphs
14449 inserted by extend_face_to_end_of_line. */
14450 && (end
- 1)->charpos
<= 0)
14452 glyph_before
= glyph
- 1;
14459 /* If the glyph row is reversed, we need to process it from back
14460 to front, so swap the edge pointers. */
14461 glyphs_end
= end
= glyph
- 1;
14462 glyph
+= row
->used
[TEXT_AREA
] - 1;
14464 while (glyph
> end
+ 1
14465 && NILP (glyph
->object
)
14466 && glyph
->charpos
< 0)
14469 x
-= glyph
->pixel_width
;
14471 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14473 /* By default, in reversed rows we put the cursor on the
14474 rightmost (first in the reading order) glyph. */
14475 for (g
= end
+ 1; g
< glyph
; g
++)
14476 x
+= g
->pixel_width
;
14478 && NILP ((end
+ 1)->object
)
14479 && (end
+ 1)->charpos
<= 0)
14481 glyph_before
= glyph
+ 1;
14485 else if (row
->reversed_p
)
14487 /* In R2L rows that don't display text, put the cursor on the
14488 rightmost glyph. Case in point: an empty last line that is
14489 part of an R2L paragraph. */
14491 /* Avoid placing the cursor on the last glyph of the row, where
14492 on terminal frames we hold the vertical border between
14493 adjacent windows. */
14494 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14495 && !WINDOW_RIGHTMOST_P (w
)
14496 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14498 x
= -1; /* will be computed below, at label compute_x */
14501 /* Step 1: Try to find the glyph whose character position
14502 corresponds to point. If that's not possible, find 2 glyphs
14503 whose character positions are the closest to point, one before
14504 point, the other after it. */
14505 if (!row
->reversed_p
)
14506 while (/* not marched to end of glyph row */
14508 /* glyph was not inserted by redisplay for internal purposes */
14509 && !NILP (glyph
->object
))
14511 if (BUFFERP (glyph
->object
))
14513 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14515 if (glyph
->charpos
> bpos_max
)
14516 bpos_max
= glyph
->charpos
;
14517 if (glyph
->charpos
< bpos_min
)
14518 bpos_min
= glyph
->charpos
;
14519 if (!glyph
->avoid_cursor_p
)
14521 /* If we hit point, we've found the glyph on which to
14522 display the cursor. */
14525 match_with_avoid_cursor
= false;
14528 /* See if we've found a better approximation to
14529 POS_BEFORE or to POS_AFTER. */
14530 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14532 pos_before
= glyph
->charpos
;
14533 glyph_before
= glyph
;
14535 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14537 pos_after
= glyph
->charpos
;
14538 glyph_after
= glyph
;
14541 else if (dpos
== 0)
14542 match_with_avoid_cursor
= true;
14544 else if (STRINGP (glyph
->object
))
14546 Lisp_Object chprop
;
14547 ptrdiff_t glyph_pos
= glyph
->charpos
;
14549 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14551 if (!NILP (chprop
))
14553 /* If the string came from a `display' text property,
14554 look up the buffer position of that property and
14555 use that position to update bpos_max, as if we
14556 actually saw such a position in one of the row's
14557 glyphs. This helps with supporting integer values
14558 of `cursor' property on the display string in
14559 situations where most or all of the row's buffer
14560 text is completely covered by display properties,
14561 so that no glyph with valid buffer positions is
14562 ever seen in the row. */
14563 ptrdiff_t prop_pos
=
14564 string_buffer_position_lim (glyph
->object
, pos_before
,
14567 if (prop_pos
>= pos_before
)
14568 bpos_max
= prop_pos
;
14570 if (INTEGERP (chprop
))
14572 bpos_covered
= bpos_max
+ XINT (chprop
);
14573 /* If the `cursor' property covers buffer positions up
14574 to and including point, we should display cursor on
14575 this glyph. Note that, if a `cursor' property on one
14576 of the string's characters has an integer value, we
14577 will break out of the loop below _before_ we get to
14578 the position match above. IOW, integer values of
14579 the `cursor' property override the "exact match for
14580 point" strategy of positioning the cursor. */
14581 /* Implementation note: bpos_max == pt_old when, e.g.,
14582 we are in an empty line, where bpos_max is set to
14583 MATRIX_ROW_START_CHARPOS, see above. */
14584 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14591 string_seen
= true;
14593 x
+= glyph
->pixel_width
;
14596 else if (glyph
> end
) /* row is reversed */
14597 while (!NILP (glyph
->object
))
14599 if (BUFFERP (glyph
->object
))
14601 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14603 if (glyph
->charpos
> bpos_max
)
14604 bpos_max
= glyph
->charpos
;
14605 if (glyph
->charpos
< bpos_min
)
14606 bpos_min
= glyph
->charpos
;
14607 if (!glyph
->avoid_cursor_p
)
14611 match_with_avoid_cursor
= false;
14614 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14616 pos_before
= glyph
->charpos
;
14617 glyph_before
= glyph
;
14619 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14621 pos_after
= glyph
->charpos
;
14622 glyph_after
= glyph
;
14625 else if (dpos
== 0)
14626 match_with_avoid_cursor
= true;
14628 else if (STRINGP (glyph
->object
))
14630 Lisp_Object chprop
;
14631 ptrdiff_t glyph_pos
= glyph
->charpos
;
14633 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14635 if (!NILP (chprop
))
14637 ptrdiff_t prop_pos
=
14638 string_buffer_position_lim (glyph
->object
, pos_before
,
14641 if (prop_pos
>= pos_before
)
14642 bpos_max
= prop_pos
;
14644 if (INTEGERP (chprop
))
14646 bpos_covered
= bpos_max
+ XINT (chprop
);
14647 /* If the `cursor' property covers buffer positions up
14648 to and including point, we should display cursor on
14650 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14656 string_seen
= true;
14659 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14661 x
--; /* can't use any pixel_width */
14664 x
-= glyph
->pixel_width
;
14667 /* Step 2: If we didn't find an exact match for point, we need to
14668 look for a proper place to put the cursor among glyphs between
14669 GLYPH_BEFORE and GLYPH_AFTER. */
14670 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14671 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14672 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14674 /* An empty line has a single glyph whose OBJECT is nil and
14675 whose CHARPOS is the position of a newline on that line.
14676 Note that on a TTY, there are more glyphs after that, which
14677 were produced by extend_face_to_end_of_line, but their
14678 CHARPOS is zero or negative. */
14679 bool empty_line_p
=
14680 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14681 && NILP (glyph
->object
) && glyph
->charpos
> 0
14682 /* On a TTY, continued and truncated rows also have a glyph at
14683 their end whose OBJECT is nil and whose CHARPOS is
14684 positive (the continuation and truncation glyphs), but such
14685 rows are obviously not "empty". */
14686 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14688 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14690 ptrdiff_t ellipsis_pos
;
14692 /* Scan back over the ellipsis glyphs. */
14693 if (!row
->reversed_p
)
14695 ellipsis_pos
= (glyph
- 1)->charpos
;
14696 while (glyph
> row
->glyphs
[TEXT_AREA
]
14697 && (glyph
- 1)->charpos
== ellipsis_pos
)
14698 glyph
--, x
-= glyph
->pixel_width
;
14699 /* That loop always goes one position too far, including
14700 the glyph before the ellipsis. So scan forward over
14702 x
+= glyph
->pixel_width
;
14705 else /* row is reversed */
14707 ellipsis_pos
= (glyph
+ 1)->charpos
;
14708 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14709 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14710 glyph
++, x
+= glyph
->pixel_width
;
14711 x
-= glyph
->pixel_width
;
14715 else if (match_with_avoid_cursor
)
14717 cursor
= glyph_after
;
14720 else if (string_seen
)
14722 int incr
= row
->reversed_p
? -1 : +1;
14724 /* Need to find the glyph that came out of a string which is
14725 present at point. That glyph is somewhere between
14726 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14727 positioned between POS_BEFORE and POS_AFTER in the
14729 struct glyph
*start
, *stop
;
14730 ptrdiff_t pos
= pos_before
;
14734 /* If the row ends in a newline from a display string,
14735 reordering could have moved the glyphs belonging to the
14736 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14737 in this case we extend the search to the last glyph in
14738 the row that was not inserted by redisplay. */
14739 if (row
->ends_in_newline_from_string_p
)
14742 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14745 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14746 correspond to POS_BEFORE and POS_AFTER, respectively. We
14747 need START and STOP in the order that corresponds to the
14748 row's direction as given by its reversed_p flag. If the
14749 directionality of characters between POS_BEFORE and
14750 POS_AFTER is the opposite of the row's base direction,
14751 these characters will have been reordered for display,
14752 and we need to reverse START and STOP. */
14753 if (!row
->reversed_p
)
14755 start
= min (glyph_before
, glyph_after
);
14756 stop
= max (glyph_before
, glyph_after
);
14760 start
= max (glyph_before
, glyph_after
);
14761 stop
= min (glyph_before
, glyph_after
);
14763 for (glyph
= start
+ incr
;
14764 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14767 /* Any glyphs that come from the buffer are here because
14768 of bidi reordering. Skip them, and only pay
14769 attention to glyphs that came from some string. */
14770 if (STRINGP (glyph
->object
))
14774 /* If the display property covers the newline, we
14775 need to search for it one position farther. */
14776 ptrdiff_t lim
= pos_after
14777 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14779 string_from_text_prop
= false;
14780 str
= glyph
->object
;
14781 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14782 if (tem
== 0 /* from overlay */
14785 /* If the string from which this glyph came is
14786 found in the buffer at point, or at position
14787 that is closer to point than pos_after, then
14788 we've found the glyph we've been looking for.
14789 If it comes from an overlay (tem == 0), and
14790 it has the `cursor' property on one of its
14791 glyphs, record that glyph as a candidate for
14792 displaying the cursor. (As in the
14793 unidirectional version, we will display the
14794 cursor on the last candidate we find.) */
14797 || (tem
- pt_old
> 0 && tem
< pos_after
))
14799 /* The glyphs from this string could have
14800 been reordered. Find the one with the
14801 smallest string position. Or there could
14802 be a character in the string with the
14803 `cursor' property, which means display
14804 cursor on that character's glyph. */
14805 ptrdiff_t strpos
= glyph
->charpos
;
14810 string_from_text_prop
= true;
14813 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14814 && EQ (glyph
->object
, str
);
14818 ptrdiff_t gpos
= glyph
->charpos
;
14820 cprop
= Fget_char_property (make_number (gpos
),
14828 if (tem
&& glyph
->charpos
< strpos
)
14830 strpos
= glyph
->charpos
;
14836 || (tem
- pt_old
> 0 && tem
< pos_after
))
14840 pos
= tem
+ 1; /* don't find previous instances */
14842 /* This string is not what we want; skip all of the
14843 glyphs that came from it. */
14844 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14845 && EQ (glyph
->object
, str
))
14852 /* If we reached the end of the line, and END was from a string,
14853 the cursor is not on this line. */
14855 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14856 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14857 && STRINGP (end
->object
)
14858 && row
->continued_p
)
14861 /* A truncated row may not include PT among its character positions.
14862 Setting the cursor inside the scroll margin will trigger
14863 recalculation of hscroll in hscroll_window_tree. But if a
14864 display string covers point, defer to the string-handling
14865 code below to figure this out. */
14866 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14868 cursor
= glyph_before
;
14871 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14872 /* Zero-width characters produce no glyphs. */
14874 && (row
->reversed_p
14875 ? glyph_after
> glyphs_end
14876 : glyph_after
< glyphs_end
)))
14878 cursor
= glyph_after
;
14884 if (cursor
!= NULL
)
14886 else if (glyph
== glyphs_end
14887 && pos_before
== pos_after
14888 && STRINGP ((row
->reversed_p
14889 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14890 : row
->glyphs
[TEXT_AREA
])->object
))
14892 /* If all the glyphs of this row came from strings, put the
14893 cursor on the first glyph of the row. This avoids having the
14894 cursor outside of the text area in this very rare and hard
14898 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14899 : row
->glyphs
[TEXT_AREA
];
14905 /* Need to compute x that corresponds to GLYPH. */
14906 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14908 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14910 x
+= g
->pixel_width
;
14914 /* ROW could be part of a continued line, which, under bidi
14915 reordering, might have other rows whose start and end charpos
14916 occlude point. Only set w->cursor if we found a better
14917 approximation to the cursor position than we have from previously
14918 examined candidate rows belonging to the same continued line. */
14919 if (/* We already have a candidate row. */
14920 w
->cursor
.vpos
>= 0
14921 /* That candidate is not the row we are processing. */
14922 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14923 /* Make sure cursor.vpos specifies a row whose start and end
14924 charpos occlude point, and it is valid candidate for being a
14925 cursor-row. This is because some callers of this function
14926 leave cursor.vpos at the row where the cursor was displayed
14927 during the last redisplay cycle. */
14928 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14929 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14930 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14933 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14935 /* Don't consider glyphs that are outside TEXT_AREA. */
14936 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14938 /* Keep the candidate whose buffer position is the closest to
14939 point or has the `cursor' property. */
14940 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14941 w
->cursor
.hpos
>= 0
14942 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14943 && ((BUFFERP (g1
->object
)
14944 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14945 || (BUFFERP (glyph
->object
)
14946 && eabs (g1
->charpos
- pt_old
)
14947 < eabs (glyph
->charpos
- pt_old
))))
14948 /* Previous candidate is a glyph from a string that has
14949 a non-nil `cursor' property. */
14950 || (STRINGP (g1
->object
)
14951 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14952 Qcursor
, g1
->object
))
14953 /* Previous candidate is from the same display
14954 string as this one, and the display string
14955 came from a text property. */
14956 || (EQ (g1
->object
, glyph
->object
)
14957 && string_from_text_prop
)
14958 /* this candidate is from newline and its
14959 position is not an exact match */
14960 || (NILP (glyph
->object
)
14961 && glyph
->charpos
!= pt_old
)))))
14963 /* If this candidate gives an exact match, use that. */
14964 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14965 /* If this candidate is a glyph created for the
14966 terminating newline of a line, and point is on that
14967 newline, it wins because it's an exact match. */
14968 || (!row
->continued_p
14969 && NILP (glyph
->object
)
14970 && glyph
->charpos
== 0
14971 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14972 /* Otherwise, keep the candidate that comes from a row
14973 spanning less buffer positions. This may win when one or
14974 both candidate positions are on glyphs that came from
14975 display strings, for which we cannot compare buffer
14977 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14978 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14979 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14982 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14984 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14985 w
->cursor
.y
= row
->y
+ dy
;
14987 if (w
== XWINDOW (selected_window
))
14989 if (!row
->continued_p
14990 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14993 this_line_buffer
= XBUFFER (w
->contents
);
14995 CHARPOS (this_line_start_pos
)
14996 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14997 BYTEPOS (this_line_start_pos
)
14998 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
15000 CHARPOS (this_line_end_pos
)
15001 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
15002 BYTEPOS (this_line_end_pos
)
15003 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
15005 this_line_y
= w
->cursor
.y
;
15006 this_line_pixel_height
= row
->height
;
15007 this_line_vpos
= w
->cursor
.vpos
;
15008 this_line_start_x
= row
->x
;
15011 CHARPOS (this_line_start_pos
) = 0;
15018 /* Run window scroll functions, if any, for WINDOW with new window
15019 start STARTP. Sets the window start of WINDOW to that position.
15021 We assume that the window's buffer is really current. */
15023 static struct text_pos
15024 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15026 struct window
*w
= XWINDOW (window
);
15027 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15029 eassert (current_buffer
== XBUFFER (w
->contents
));
15031 if (!NILP (Vwindow_scroll_functions
))
15033 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15034 make_number (CHARPOS (startp
)));
15035 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15036 /* In case the hook functions switch buffers. */
15037 set_buffer_internal (XBUFFER (w
->contents
));
15044 /* Make sure the line containing the cursor is fully visible.
15045 A value of true means there is nothing to be done.
15046 (Either the line is fully visible, or it cannot be made so,
15047 or we cannot tell.)
15049 If FORCE_P, return false even if partial visible cursor row
15050 is higher than window.
15052 If CURRENT_MATRIX_P, use the information from the
15053 window's current glyph matrix; otherwise use the desired glyph
15056 A value of false means the caller should do scrolling
15057 as if point had gone off the screen. */
15060 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
15061 bool current_matrix_p
)
15063 struct glyph_matrix
*matrix
;
15064 struct glyph_row
*row
;
15067 if (!make_cursor_line_fully_visible_p
)
15070 /* It's not always possible to find the cursor, e.g, when a window
15071 is full of overlay strings. Don't do anything in that case. */
15072 if (w
->cursor
.vpos
< 0)
15075 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15076 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15078 /* If the cursor row is not partially visible, there's nothing to do. */
15079 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15082 /* If the row the cursor is in is taller than the window's height,
15083 it's not clear what to do, so do nothing. */
15084 window_height
= window_box_height (w
);
15085 if (row
->height
>= window_height
)
15087 if (!force_p
|| MINI_WINDOW_P (w
)
15088 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15095 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15096 means only WINDOW is redisplayed in redisplay_internal.
15097 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15098 in redisplay_window to bring a partially visible line into view in
15099 the case that only the cursor has moved.
15101 LAST_LINE_MISFIT should be true if we're scrolling because the
15102 last screen line's vertical height extends past the end of the screen.
15106 1 if scrolling succeeded
15108 0 if scrolling didn't find point.
15110 -1 if new fonts have been loaded so that we must interrupt
15111 redisplay, adjust glyph matrices, and try again. */
15117 SCROLLING_NEED_LARGER_MATRICES
15120 /* If scroll-conservatively is more than this, never recenter.
15122 If you change this, don't forget to update the doc string of
15123 `scroll-conservatively' and the Emacs manual. */
15124 #define SCROLL_LIMIT 100
15127 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15128 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15129 bool temp_scroll_step
, bool last_line_misfit
)
15131 struct window
*w
= XWINDOW (window
);
15132 struct frame
*f
= XFRAME (w
->frame
);
15133 struct text_pos pos
, startp
;
15135 int this_scroll_margin
, scroll_max
, rc
, height
;
15136 int dy
= 0, amount_to_scroll
= 0;
15137 bool scroll_down_p
= false;
15138 int extra_scroll_margin_lines
= last_line_misfit
;
15139 Lisp_Object aggressive
;
15140 /* We will never try scrolling more than this number of lines. */
15141 int scroll_limit
= SCROLL_LIMIT
;
15142 int frame_line_height
= default_line_pixel_height (w
);
15143 int window_total_lines
15144 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15147 debug_method_add (w
, "try_scrolling");
15150 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15152 /* Compute scroll margin height in pixels. We scroll when point is
15153 within this distance from the top or bottom of the window. */
15154 if (scroll_margin
> 0)
15155 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15156 * frame_line_height
;
15158 this_scroll_margin
= 0;
15160 /* Force arg_scroll_conservatively to have a reasonable value, to
15161 avoid scrolling too far away with slow move_it_* functions. Note
15162 that the user can supply scroll-conservatively equal to
15163 `most-positive-fixnum', which can be larger than INT_MAX. */
15164 if (arg_scroll_conservatively
> scroll_limit
)
15166 arg_scroll_conservatively
= scroll_limit
+ 1;
15167 scroll_max
= scroll_limit
* frame_line_height
;
15169 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15170 /* Compute how much we should try to scroll maximally to bring
15171 point into view. */
15172 scroll_max
= (max (scroll_step
,
15173 max (arg_scroll_conservatively
, temp_scroll_step
))
15174 * frame_line_height
);
15175 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15176 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15177 /* We're trying to scroll because of aggressive scrolling but no
15178 scroll_step is set. Choose an arbitrary one. */
15179 scroll_max
= 10 * frame_line_height
;
15185 /* Decide whether to scroll down. */
15186 if (PT
> CHARPOS (startp
))
15188 int scroll_margin_y
;
15190 /* Compute the pixel ypos of the scroll margin, then move IT to
15191 either that ypos or PT, whichever comes first. */
15192 start_display (&it
, w
, startp
);
15193 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15194 - frame_line_height
* extra_scroll_margin_lines
;
15195 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15196 (MOVE_TO_POS
| MOVE_TO_Y
));
15198 if (PT
> CHARPOS (it
.current
.pos
))
15200 int y0
= line_bottom_y (&it
);
15201 /* Compute how many pixels below window bottom to stop searching
15202 for PT. This avoids costly search for PT that is far away if
15203 the user limited scrolling by a small number of lines, but
15204 always finds PT if scroll_conservatively is set to a large
15205 number, such as most-positive-fixnum. */
15206 int slack
= max (scroll_max
, 10 * frame_line_height
);
15207 int y_to_move
= it
.last_visible_y
+ slack
;
15209 /* Compute the distance from the scroll margin to PT or to
15210 the scroll limit, whichever comes first. This should
15211 include the height of the cursor line, to make that line
15213 move_it_to (&it
, PT
, -1, y_to_move
,
15214 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15215 dy
= line_bottom_y (&it
) - y0
;
15217 if (dy
> scroll_max
)
15218 return SCROLLING_FAILED
;
15221 scroll_down_p
= true;
15227 /* Point is in or below the bottom scroll margin, so move the
15228 window start down. If scrolling conservatively, move it just
15229 enough down to make point visible. If scroll_step is set,
15230 move it down by scroll_step. */
15231 if (arg_scroll_conservatively
)
15233 = min (max (dy
, frame_line_height
),
15234 frame_line_height
* arg_scroll_conservatively
);
15235 else if (scroll_step
|| temp_scroll_step
)
15236 amount_to_scroll
= scroll_max
;
15239 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15240 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15241 if (NUMBERP (aggressive
))
15243 double float_amount
= XFLOATINT (aggressive
) * height
;
15244 int aggressive_scroll
= float_amount
;
15245 if (aggressive_scroll
== 0 && float_amount
> 0)
15246 aggressive_scroll
= 1;
15247 /* Don't let point enter the scroll margin near top of
15248 the window. This could happen if the value of
15249 scroll_up_aggressively is too large and there are
15250 non-zero margins, because scroll_up_aggressively
15251 means put point that fraction of window height
15252 _from_the_bottom_margin_. */
15253 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15254 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15255 amount_to_scroll
= dy
+ aggressive_scroll
;
15259 if (amount_to_scroll
<= 0)
15260 return SCROLLING_FAILED
;
15262 start_display (&it
, w
, startp
);
15263 if (arg_scroll_conservatively
<= scroll_limit
)
15264 move_it_vertically (&it
, amount_to_scroll
);
15267 /* Extra precision for users who set scroll-conservatively
15268 to a large number: make sure the amount we scroll
15269 the window start is never less than amount_to_scroll,
15270 which was computed as distance from window bottom to
15271 point. This matters when lines at window top and lines
15272 below window bottom have different height. */
15274 void *it1data
= NULL
;
15275 /* We use a temporary it1 because line_bottom_y can modify
15276 its argument, if it moves one line down; see there. */
15279 SAVE_IT (it1
, it
, it1data
);
15280 start_y
= line_bottom_y (&it1
);
15282 RESTORE_IT (&it
, &it
, it1data
);
15283 move_it_by_lines (&it
, 1);
15284 SAVE_IT (it1
, it
, it1data
);
15285 } while (IT_CHARPOS (it
) < ZV
15286 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15287 bidi_unshelve_cache (it1data
, true);
15290 /* If STARTP is unchanged, move it down another screen line. */
15291 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15292 move_it_by_lines (&it
, 1);
15293 startp
= it
.current
.pos
;
15297 struct text_pos scroll_margin_pos
= startp
;
15300 /* See if point is inside the scroll margin at the top of the
15302 if (this_scroll_margin
)
15306 start_display (&it
, w
, startp
);
15307 y_start
= it
.current_y
;
15308 move_it_vertically (&it
, this_scroll_margin
);
15309 scroll_margin_pos
= it
.current
.pos
;
15310 /* If we didn't move enough before hitting ZV, request
15311 additional amount of scroll, to move point out of the
15313 if (IT_CHARPOS (it
) == ZV
15314 && it
.current_y
- y_start
< this_scroll_margin
)
15315 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15318 if (PT
< CHARPOS (scroll_margin_pos
))
15320 /* Point is in the scroll margin at the top of the window or
15321 above what is displayed in the window. */
15324 /* Compute the vertical distance from PT to the scroll
15325 margin position. Move as far as scroll_max allows, or
15326 one screenful, or 10 screen lines, whichever is largest.
15327 Give up if distance is greater than scroll_max or if we
15328 didn't reach the scroll margin position. */
15329 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15330 start_display (&it
, w
, pos
);
15332 y_to_move
= max (it
.last_visible_y
,
15333 max (scroll_max
, 10 * frame_line_height
));
15334 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15336 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15337 dy
= it
.current_y
- y0
;
15338 if (dy
> scroll_max
15339 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15340 return SCROLLING_FAILED
;
15342 /* Additional scroll for when ZV was too close to point. */
15345 /* Compute new window start. */
15346 start_display (&it
, w
, startp
);
15348 if (arg_scroll_conservatively
)
15349 amount_to_scroll
= max (dy
, frame_line_height
15350 * max (scroll_step
, temp_scroll_step
));
15351 else if (scroll_step
|| temp_scroll_step
)
15352 amount_to_scroll
= scroll_max
;
15355 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15356 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15357 if (NUMBERP (aggressive
))
15359 double float_amount
= XFLOATINT (aggressive
) * height
;
15360 int aggressive_scroll
= float_amount
;
15361 if (aggressive_scroll
== 0 && float_amount
> 0)
15362 aggressive_scroll
= 1;
15363 /* Don't let point enter the scroll margin near
15364 bottom of the window, if the value of
15365 scroll_down_aggressively happens to be too
15367 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15368 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15369 amount_to_scroll
= dy
+ aggressive_scroll
;
15373 if (amount_to_scroll
<= 0)
15374 return SCROLLING_FAILED
;
15376 move_it_vertically_backward (&it
, amount_to_scroll
);
15377 startp
= it
.current
.pos
;
15381 /* Run window scroll functions. */
15382 startp
= run_window_scroll_functions (window
, startp
);
15384 /* Display the window. Give up if new fonts are loaded, or if point
15386 if (!try_window (window
, startp
, 0))
15387 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15388 else if (w
->cursor
.vpos
< 0)
15390 clear_glyph_matrix (w
->desired_matrix
);
15391 rc
= SCROLLING_FAILED
;
15395 /* Maybe forget recorded base line for line number display. */
15396 if (!just_this_one_p
15397 || current_buffer
->clip_changed
15398 || BEG_UNCHANGED
< CHARPOS (startp
))
15399 w
->base_line_number
= 0;
15401 /* If cursor ends up on a partially visible line,
15402 treat that as being off the bottom of the screen. */
15403 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15405 /* It's possible that the cursor is on the first line of the
15406 buffer, which is partially obscured due to a vscroll
15407 (Bug#7537). In that case, avoid looping forever. */
15408 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15410 clear_glyph_matrix (w
->desired_matrix
);
15411 ++extra_scroll_margin_lines
;
15414 rc
= SCROLLING_SUCCESS
;
15421 /* Compute a suitable window start for window W if display of W starts
15422 on a continuation line. Value is true if a new window start
15425 The new window start will be computed, based on W's width, starting
15426 from the start of the continued line. It is the start of the
15427 screen line with the minimum distance from the old start W->start. */
15430 compute_window_start_on_continuation_line (struct window
*w
)
15432 struct text_pos pos
, start_pos
;
15433 bool window_start_changed_p
= false;
15435 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15437 /* If window start is on a continuation line... Window start may be
15438 < BEGV in case there's invisible text at the start of the
15439 buffer (M-x rmail, for example). */
15440 if (CHARPOS (start_pos
) > BEGV
15441 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15444 struct glyph_row
*row
;
15446 /* Handle the case that the window start is out of range. */
15447 if (CHARPOS (start_pos
) < BEGV
)
15448 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15449 else if (CHARPOS (start_pos
) > ZV
)
15450 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15452 /* Find the start of the continued line. This should be fast
15453 because find_newline is fast (newline cache). */
15454 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15455 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15456 row
, DEFAULT_FACE_ID
);
15457 reseat_at_previous_visible_line_start (&it
);
15459 /* If the line start is "too far" away from the window start,
15460 say it takes too much time to compute a new window start. */
15461 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15462 /* PXW: Do we need upper bounds here? */
15463 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15465 int min_distance
, distance
;
15467 /* Move forward by display lines to find the new window
15468 start. If window width was enlarged, the new start can
15469 be expected to be > the old start. If window width was
15470 decreased, the new window start will be < the old start.
15471 So, we're looking for the display line start with the
15472 minimum distance from the old window start. */
15473 pos
= it
.current
.pos
;
15474 min_distance
= INFINITY
;
15475 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15476 distance
< min_distance
)
15478 min_distance
= distance
;
15479 pos
= it
.current
.pos
;
15480 if (it
.line_wrap
== WORD_WRAP
)
15482 /* Under WORD_WRAP, move_it_by_lines is likely to
15483 overshoot and stop not at the first, but the
15484 second character from the left margin. So in
15485 that case, we need a more tight control on the X
15486 coordinate of the iterator than move_it_by_lines
15487 promises in its contract. The method is to first
15488 go to the last (rightmost) visible character of a
15489 line, then move to the leftmost character on the
15490 next line in a separate call. */
15491 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15492 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15493 move_it_to (&it
, ZV
, 0,
15494 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15495 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15498 move_it_by_lines (&it
, 1);
15501 /* Set the window start there. */
15502 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15503 window_start_changed_p
= true;
15507 return window_start_changed_p
;
15511 /* Try cursor movement in case text has not changed in window WINDOW,
15512 with window start STARTP. Value is
15514 CURSOR_MOVEMENT_SUCCESS if successful
15516 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15518 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15519 display. *SCROLL_STEP is set to true, under certain circumstances, if
15520 we want to scroll as if scroll-step were set to 1. See the code.
15522 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15523 which case we have to abort this redisplay, and adjust matrices
15528 CURSOR_MOVEMENT_SUCCESS
,
15529 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15530 CURSOR_MOVEMENT_MUST_SCROLL
,
15531 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15535 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15538 struct window
*w
= XWINDOW (window
);
15539 struct frame
*f
= XFRAME (w
->frame
);
15540 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15543 if (inhibit_try_cursor_movement
)
15547 /* Previously, there was a check for Lisp integer in the
15548 if-statement below. Now, this field is converted to
15549 ptrdiff_t, thus zero means invalid position in a buffer. */
15550 eassert (w
->last_point
> 0);
15551 /* Likewise there was a check whether window_end_vpos is nil or larger
15552 than the window. Now window_end_vpos is int and so never nil, but
15553 let's leave eassert to check whether it fits in the window. */
15554 eassert (!w
->window_end_valid
15555 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15557 /* Handle case where text has not changed, only point, and it has
15558 not moved off the frame. */
15559 if (/* Point may be in this window. */
15560 PT
>= CHARPOS (startp
)
15561 /* Selective display hasn't changed. */
15562 && !current_buffer
->clip_changed
15563 /* Function force-mode-line-update is used to force a thorough
15564 redisplay. It sets either windows_or_buffers_changed or
15565 update_mode_lines. So don't take a shortcut here for these
15567 && !update_mode_lines
15568 && !windows_or_buffers_changed
15569 && !f
->cursor_type_changed
15570 && NILP (Vshow_trailing_whitespace
)
15571 /* This code is not used for mini-buffer for the sake of the case
15572 of redisplaying to replace an echo area message; since in
15573 that case the mini-buffer contents per se are usually
15574 unchanged. This code is of no real use in the mini-buffer
15575 since the handling of this_line_start_pos, etc., in redisplay
15576 handles the same cases. */
15577 && !EQ (window
, minibuf_window
)
15578 && (FRAME_WINDOW_P (f
)
15579 || !overlay_arrow_in_current_buffer_p ()))
15581 int this_scroll_margin
, top_scroll_margin
;
15582 struct glyph_row
*row
= NULL
;
15583 int frame_line_height
= default_line_pixel_height (w
);
15584 int window_total_lines
15585 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15588 debug_method_add (w
, "cursor movement");
15591 /* Scroll if point within this distance from the top or bottom
15592 of the window. This is a pixel value. */
15593 if (scroll_margin
> 0)
15595 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15596 this_scroll_margin
*= frame_line_height
;
15599 this_scroll_margin
= 0;
15601 top_scroll_margin
= this_scroll_margin
;
15602 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15603 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15605 /* Start with the row the cursor was displayed during the last
15606 not paused redisplay. Give up if that row is not valid. */
15607 if (w
->last_cursor_vpos
< 0
15608 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15609 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15612 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15613 if (row
->mode_line_p
)
15615 if (!row
->enabled_p
)
15616 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15619 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15621 bool scroll_p
= false, must_scroll
= false;
15622 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15624 if (PT
> w
->last_point
)
15626 /* Point has moved forward. */
15627 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15628 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15630 eassert (row
->enabled_p
);
15634 /* If the end position of a row equals the start
15635 position of the next row, and PT is at that position,
15636 we would rather display cursor in the next line. */
15637 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15638 && MATRIX_ROW_END_CHARPOS (row
) == PT
15639 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15640 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15641 && !cursor_row_p (row
))
15644 /* If within the scroll margin, scroll. Note that
15645 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15646 the next line would be drawn, and that
15647 this_scroll_margin can be zero. */
15648 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15649 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15650 /* Line is completely visible last line in window
15651 and PT is to be set in the next line. */
15652 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15653 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15654 && !row
->ends_at_zv_p
15655 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15658 else if (PT
< w
->last_point
)
15660 /* Cursor has to be moved backward. Note that PT >=
15661 CHARPOS (startp) because of the outer if-statement. */
15662 while (!row
->mode_line_p
15663 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15664 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15665 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15666 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15667 row
> w
->current_matrix
->rows
15668 && (row
-1)->ends_in_newline_from_string_p
))))
15669 && (row
->y
> top_scroll_margin
15670 || CHARPOS (startp
) == BEGV
))
15672 eassert (row
->enabled_p
);
15676 /* Consider the following case: Window starts at BEGV,
15677 there is invisible, intangible text at BEGV, so that
15678 display starts at some point START > BEGV. It can
15679 happen that we are called with PT somewhere between
15680 BEGV and START. Try to handle that case. */
15681 if (row
< w
->current_matrix
->rows
15682 || row
->mode_line_p
)
15684 row
= w
->current_matrix
->rows
;
15685 if (row
->mode_line_p
)
15689 /* Due to newlines in overlay strings, we may have to
15690 skip forward over overlay strings. */
15691 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15692 && MATRIX_ROW_END_CHARPOS (row
) == PT
15693 && !cursor_row_p (row
))
15696 /* If within the scroll margin, scroll. */
15697 if (row
->y
< top_scroll_margin
15698 && CHARPOS (startp
) != BEGV
)
15703 /* Cursor did not move. So don't scroll even if cursor line
15704 is partially visible, as it was so before. */
15705 rc
= CURSOR_MOVEMENT_SUCCESS
;
15708 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15709 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15711 /* if PT is not in the glyph row, give up. */
15712 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15713 must_scroll
= true;
15715 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15716 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15718 struct glyph_row
*row1
;
15720 /* If rows are bidi-reordered and point moved, back up
15721 until we find a row that does not belong to a
15722 continuation line. This is because we must consider
15723 all rows of a continued line as candidates for the
15724 new cursor positioning, since row start and end
15725 positions change non-linearly with vertical position
15727 /* FIXME: Revisit this when glyph ``spilling'' in
15728 continuation lines' rows is implemented for
15729 bidi-reordered rows. */
15730 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15731 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15734 /* If we hit the beginning of the displayed portion
15735 without finding the first row of a continued
15739 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15742 eassert (row
->enabled_p
);
15747 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15748 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15749 /* Make sure this isn't a header line by any chance, since
15750 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15751 && !row
->mode_line_p
15752 && make_cursor_line_fully_visible_p
)
15754 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15755 && !row
->ends_at_zv_p
15756 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15757 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15758 else if (row
->height
> window_box_height (w
))
15760 /* If we end up in a partially visible line, let's
15761 make it fully visible, except when it's taller
15762 than the window, in which case we can't do much
15764 *scroll_step
= true;
15765 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15769 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15770 if (!cursor_row_fully_visible_p (w
, false, true))
15771 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15773 rc
= CURSOR_MOVEMENT_SUCCESS
;
15777 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15778 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15779 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15781 /* With bidi-reordered rows, there could be more than
15782 one candidate row whose start and end positions
15783 occlude point. We need to let set_cursor_from_row
15784 find the best candidate. */
15785 /* FIXME: Revisit this when glyph ``spilling'' in
15786 continuation lines' rows is implemented for
15787 bidi-reordered rows. */
15792 bool at_zv_p
= false, exact_match_p
= false;
15794 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15795 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15796 && cursor_row_p (row
))
15797 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15799 /* As soon as we've found the exact match for point,
15800 or the first suitable row whose ends_at_zv_p flag
15801 is set, we are done. */
15804 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15805 w
->cursor
.vpos
)->ends_at_zv_p
;
15807 && w
->cursor
.hpos
>= 0
15808 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15811 struct glyph_row
*candidate
=
15812 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15814 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15815 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15818 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15819 || (NILP (g
->object
)
15820 && (g
->charpos
== PT
15821 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15823 if (at_zv_p
|| exact_match_p
)
15825 rc
= CURSOR_MOVEMENT_SUCCESS
;
15829 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15833 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15834 || row
->continued_p
)
15835 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15836 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15837 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15838 /* If we didn't find any candidate rows, or exited the
15839 loop before all the candidates were examined, signal
15840 to the caller that this method failed. */
15841 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15843 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15844 && !row
->continued_p
))
15845 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15847 rc
= CURSOR_MOVEMENT_SUCCESS
;
15853 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15855 rc
= CURSOR_MOVEMENT_SUCCESS
;
15860 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15861 && MATRIX_ROW_START_CHARPOS (row
) == PT
15862 && cursor_row_p (row
));
15872 set_vertical_scroll_bar (struct window
*w
)
15874 ptrdiff_t start
, end
, whole
;
15876 /* Calculate the start and end positions for the current window.
15877 At some point, it would be nice to choose between scrollbars
15878 which reflect the whole buffer size, with special markers
15879 indicating narrowing, and scrollbars which reflect only the
15882 Note that mini-buffers sometimes aren't displaying any text. */
15883 if (!MINI_WINDOW_P (w
)
15884 || (w
== XWINDOW (minibuf_window
)
15885 && NILP (echo_area_buffer
[0])))
15887 struct buffer
*buf
= XBUFFER (w
->contents
);
15888 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15889 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15890 /* I don't think this is guaranteed to be right. For the
15891 moment, we'll pretend it is. */
15892 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15896 if (whole
< (end
- start
))
15897 whole
= end
- start
;
15900 start
= end
= whole
= 0;
15902 /* Indicate what this scroll bar ought to be displaying now. */
15903 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15904 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15905 (w
, end
- start
, whole
, start
);
15910 set_horizontal_scroll_bar (struct window
*w
)
15912 int start
, end
, whole
, portion
;
15914 if (!MINI_WINDOW_P (w
)
15915 || (w
== XWINDOW (minibuf_window
)
15916 && NILP (echo_area_buffer
[0])))
15918 struct buffer
*b
= XBUFFER (w
->contents
);
15919 struct buffer
*old_buffer
= NULL
;
15921 struct text_pos startp
;
15923 if (b
!= current_buffer
)
15925 old_buffer
= current_buffer
;
15926 set_buffer_internal (b
);
15929 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15930 start_display (&it
, w
, startp
);
15931 it
.last_visible_x
= INT_MAX
;
15932 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15933 MOVE_TO_X
| MOVE_TO_Y
);
15934 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15935 window_box_height (w), -1,
15936 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15938 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15939 end
= start
+ window_box_width (w
, TEXT_AREA
);
15940 portion
= end
- start
;
15941 /* After enlarging a horizontally scrolled window such that it
15942 gets at least as wide as the text it contains, make sure that
15943 the thumb doesn't fill the entire scroll bar so we can still
15944 drag it back to see the entire text. */
15945 whole
= max (whole
, end
);
15951 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15952 if (EQ (pdir
, Qright_to_left
))
15954 start
= whole
- end
;
15955 end
= start
+ portion
;
15960 set_buffer_internal (old_buffer
);
15963 start
= end
= whole
= portion
= 0;
15965 w
->hscroll_whole
= whole
;
15967 /* Indicate what this scroll bar ought to be displaying now. */
15968 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15969 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15970 (w
, portion
, whole
, start
);
15974 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15975 selected_window is redisplayed.
15977 We can return without actually redisplaying the window if fonts has been
15978 changed on window's frame. In that case, redisplay_internal will retry.
15980 As one of the important parts of redisplaying a window, we need to
15981 decide whether the previous window-start position (stored in the
15982 window's w->start marker position) is still valid, and if it isn't,
15983 recompute it. Some details about that:
15985 . The previous window-start could be in a continuation line, in
15986 which case we need to recompute it when the window width
15987 changes. See compute_window_start_on_continuation_line and its
15990 . The text that changed since last redisplay could include the
15991 previous window-start position. In that case, we try to salvage
15992 what we can from the current glyph matrix by calling
15993 try_scrolling, which see.
15995 . Some Emacs command could force us to use a specific window-start
15996 position by setting the window's force_start flag, or gently
15997 propose doing that by setting the window's optional_new_start
15998 flag. In these cases, we try using the specified start point if
15999 that succeeds (i.e. the window desired matrix is successfully
16000 recomputed, and point location is within the window). In case
16001 of optional_new_start, we first check if the specified start
16002 position is feasible, i.e. if it will allow point to be
16003 displayed in the window. If using the specified start point
16004 fails, e.g., if new fonts are needed to be loaded, we abort the
16005 redisplay cycle and leave it up to the next cycle to figure out
16008 . Note that the window's force_start flag is sometimes set by
16009 redisplay itself, when it decides that the previous window start
16010 point is fine and should be kept. Search for "goto force_start"
16011 below to see the details. Like the values of window-start
16012 specified outside of redisplay, these internally-deduced values
16013 are tested for feasibility, and ignored if found to be
16016 . Note that the function try_window, used to completely redisplay
16017 a window, accepts the window's start point as its argument.
16018 This is used several times in the redisplay code to control
16019 where the window start will be, according to user options such
16020 as scroll-conservatively, and also to ensure the screen line
16021 showing point will be fully (as opposed to partially) visible on
16025 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
16027 struct window
*w
= XWINDOW (window
);
16028 struct frame
*f
= XFRAME (w
->frame
);
16029 struct buffer
*buffer
= XBUFFER (w
->contents
);
16030 struct buffer
*old
= current_buffer
;
16031 struct text_pos lpoint
, opoint
, startp
;
16032 bool update_mode_line
;
16035 /* Record it now because it's overwritten. */
16036 bool current_matrix_up_to_date_p
= false;
16037 bool used_current_matrix_p
= false;
16038 /* This is less strict than current_matrix_up_to_date_p.
16039 It indicates that the buffer contents and narrowing are unchanged. */
16040 bool buffer_unchanged_p
= false;
16041 bool temp_scroll_step
= false;
16042 ptrdiff_t count
= SPECPDL_INDEX ();
16044 int centering_position
= -1;
16045 bool last_line_misfit
= false;
16046 ptrdiff_t beg_unchanged
, end_unchanged
;
16047 int frame_line_height
;
16048 bool use_desired_matrix
;
16050 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16054 *w
->desired_matrix
->method
= 0;
16057 if (!just_this_one_p
16058 && REDISPLAY_SOME_P ()
16060 && !w
->update_mode_line
16063 && !buffer
->text
->redisplay
16064 && BUF_PT (buffer
) == w
->last_point
)
16067 /* Make sure that both W's markers are valid. */
16068 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16069 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16071 /* We come here again if we need to run window-text-change-functions
16074 reconsider_clip_changes (w
);
16075 frame_line_height
= default_line_pixel_height (w
);
16077 /* Has the mode line to be updated? */
16078 update_mode_line
= (w
->update_mode_line
16079 || update_mode_lines
16080 || buffer
->clip_changed
16081 || buffer
->prevent_redisplay_optimizations_p
);
16083 if (!just_this_one_p
)
16084 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16085 cleverly elsewhere. */
16086 w
->must_be_updated_p
= true;
16088 if (MINI_WINDOW_P (w
))
16090 if (w
== XWINDOW (echo_area_window
)
16091 && !NILP (echo_area_buffer
[0]))
16093 if (update_mode_line
)
16094 /* We may have to update a tty frame's menu bar or a
16095 tool-bar. Example `M-x C-h C-h C-g'. */
16096 goto finish_menu_bars
;
16098 /* We've already displayed the echo area glyphs in this window. */
16099 goto finish_scroll_bars
;
16101 else if ((w
!= XWINDOW (minibuf_window
)
16102 || minibuf_level
== 0)
16103 /* When buffer is nonempty, redisplay window normally. */
16104 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16105 /* Quail displays non-mini buffers in minibuffer window.
16106 In that case, redisplay the window normally. */
16107 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16109 /* W is a mini-buffer window, but it's not active, so clear
16111 int yb
= window_text_bottom_y (w
);
16112 struct glyph_row
*row
;
16115 for (y
= 0, row
= w
->desired_matrix
->rows
;
16117 y
+= row
->height
, ++row
)
16118 blank_row (w
, row
, y
);
16119 goto finish_scroll_bars
;
16122 clear_glyph_matrix (w
->desired_matrix
);
16125 /* Otherwise set up data on this window; select its buffer and point
16127 /* Really select the buffer, for the sake of buffer-local
16129 set_buffer_internal_1 (XBUFFER (w
->contents
));
16131 current_matrix_up_to_date_p
16132 = (w
->window_end_valid
16133 && !current_buffer
->clip_changed
16134 && !current_buffer
->prevent_redisplay_optimizations_p
16135 && !window_outdated (w
));
16137 /* Run the window-text-change-functions
16138 if it is possible that the text on the screen has changed
16139 (either due to modification of the text, or any other reason). */
16140 if (!current_matrix_up_to_date_p
16141 && !NILP (Vwindow_text_change_functions
))
16143 safe_run_hooks (Qwindow_text_change_functions
);
16147 beg_unchanged
= BEG_UNCHANGED
;
16148 end_unchanged
= END_UNCHANGED
;
16150 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16152 specbind (Qinhibit_point_motion_hooks
, Qt
);
16155 = (w
->window_end_valid
16156 && !current_buffer
->clip_changed
16157 && !window_outdated (w
));
16159 /* When windows_or_buffers_changed is non-zero, we can't rely
16160 on the window end being valid, so set it to zero there. */
16161 if (windows_or_buffers_changed
)
16163 /* If window starts on a continuation line, maybe adjust the
16164 window start in case the window's width changed. */
16165 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16166 compute_window_start_on_continuation_line (w
);
16168 w
->window_end_valid
= false;
16169 /* If so, we also can't rely on current matrix
16170 and should not fool try_cursor_movement below. */
16171 current_matrix_up_to_date_p
= false;
16174 /* Some sanity checks. */
16175 CHECK_WINDOW_END (w
);
16176 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16178 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16181 if (mode_line_update_needed (w
))
16182 update_mode_line
= true;
16184 /* Point refers normally to the selected window. For any other
16185 window, set up appropriate value. */
16186 if (!EQ (window
, selected_window
))
16188 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16189 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16194 new_pt_byte
= BEGV_BYTE
;
16195 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16197 else if (new_pt
> (ZV
- 1))
16200 new_pt_byte
= ZV_BYTE
;
16201 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16204 /* We don't use SET_PT so that the point-motion hooks don't run. */
16205 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16208 /* If any of the character widths specified in the display table
16209 have changed, invalidate the width run cache. It's true that
16210 this may be a bit late to catch such changes, but the rest of
16211 redisplay goes (non-fatally) haywire when the display table is
16212 changed, so why should we worry about doing any better? */
16213 if (current_buffer
->width_run_cache
16214 || (current_buffer
->base_buffer
16215 && current_buffer
->base_buffer
->width_run_cache
))
16217 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16219 if (! disptab_matches_widthtab
16220 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16222 struct buffer
*buf
= current_buffer
;
16224 if (buf
->base_buffer
)
16225 buf
= buf
->base_buffer
;
16226 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16227 recompute_width_table (current_buffer
, disptab
);
16231 /* If window-start is screwed up, choose a new one. */
16232 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16235 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16237 /* If someone specified a new starting point but did not insist,
16238 check whether it can be used. */
16239 if ((w
->optional_new_start
|| window_frozen_p (w
))
16240 && CHARPOS (startp
) >= BEGV
16241 && CHARPOS (startp
) <= ZV
)
16243 ptrdiff_t it_charpos
;
16245 w
->optional_new_start
= false;
16246 start_display (&it
, w
, startp
);
16247 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16248 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16249 /* Record IT's position now, since line_bottom_y might change
16251 it_charpos
= IT_CHARPOS (it
);
16252 /* Make sure we set the force_start flag only if the cursor row
16253 will be fully visible. Otherwise, the code under force_start
16254 label below will try to move point back into view, which is
16255 not what the code which sets optional_new_start wants. */
16256 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16257 && !w
->force_start
)
16259 if (it_charpos
== PT
)
16260 w
->force_start
= true;
16261 /* IT may overshoot PT if text at PT is invisible. */
16262 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16263 w
->force_start
= true;
16265 if (w
->force_start
)
16267 if (window_frozen_p (w
))
16268 debug_method_add (w
, "set force_start from frozen window start");
16270 debug_method_add (w
, "set force_start from optional_new_start");
16278 /* Handle case where place to start displaying has been specified,
16279 unless the specified location is outside the accessible range. */
16280 if (w
->force_start
)
16282 /* We set this later on if we have to adjust point. */
16285 w
->force_start
= false;
16287 w
->window_end_valid
= false;
16289 /* Forget any recorded base line for line number display. */
16290 if (!buffer_unchanged_p
)
16291 w
->base_line_number
= 0;
16293 /* Redisplay the mode line. Select the buffer properly for that.
16294 Also, run the hook window-scroll-functions
16295 because we have scrolled. */
16296 /* Note, we do this after clearing force_start because
16297 if there's an error, it is better to forget about force_start
16298 than to get into an infinite loop calling the hook functions
16299 and having them get more errors. */
16300 if (!update_mode_line
16301 || ! NILP (Vwindow_scroll_functions
))
16303 update_mode_line
= true;
16304 w
->update_mode_line
= true;
16305 startp
= run_window_scroll_functions (window
, startp
);
16308 if (CHARPOS (startp
) < BEGV
)
16309 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16310 else if (CHARPOS (startp
) > ZV
)
16311 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16313 /* Redisplay, then check if cursor has been set during the
16314 redisplay. Give up if new fonts were loaded. */
16315 /* We used to issue a CHECK_MARGINS argument to try_window here,
16316 but this causes scrolling to fail when point begins inside
16317 the scroll margin (bug#148) -- cyd */
16318 if (!try_window (window
, startp
, 0))
16320 w
->force_start
= true;
16321 clear_glyph_matrix (w
->desired_matrix
);
16322 goto need_larger_matrices
;
16325 if (w
->cursor
.vpos
< 0)
16327 /* If point does not appear, try to move point so it does
16328 appear. The desired matrix has been built above, so we
16329 can use it here. First see if point is in invisible
16330 text, and if so, move it to the first visible buffer
16331 position past that. */
16332 struct glyph_row
*r
= NULL
;
16333 Lisp_Object invprop
=
16334 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16337 if (TEXT_PROP_MEANS_INVISIBLE (invprop
) != 0)
16340 Lisp_Object invprop_end
=
16341 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16344 if (NATNUMP (invprop_end
))
16345 alt_pt
= XFASTINT (invprop_end
);
16348 r
= row_containing_pos (w
, alt_pt
, w
->desired_matrix
->rows
,
16352 new_vpos
= MATRIX_ROW_BOTTOM_Y (r
);
16353 else /* Give up and just move to the middle of the window. */
16354 new_vpos
= window_box_height (w
) / 2;
16357 if (!cursor_row_fully_visible_p (w
, false, false))
16359 /* Point does appear, but on a line partly visible at end of window.
16360 Move it back to a fully-visible line. */
16361 new_vpos
= window_box_height (w
);
16362 /* But if window_box_height suggests a Y coordinate that is
16363 not less than we already have, that line will clearly not
16364 be fully visible, so give up and scroll the display.
16365 This can happen when the default face uses a font whose
16366 dimensions are different from the frame's default
16368 if (new_vpos
>= w
->cursor
.y
)
16370 w
->cursor
.vpos
= -1;
16371 clear_glyph_matrix (w
->desired_matrix
);
16372 goto try_to_scroll
;
16375 else if (w
->cursor
.vpos
>= 0)
16377 /* Some people insist on not letting point enter the scroll
16378 margin, even though this part handles windows that didn't
16380 int window_total_lines
16381 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16382 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16383 int pixel_margin
= margin
* frame_line_height
;
16384 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16386 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16387 below, which finds the row to move point to, advances by
16388 the Y coordinate of the _next_ row, see the definition of
16389 MATRIX_ROW_BOTTOM_Y. */
16390 if (w
->cursor
.vpos
< margin
+ header_line
)
16392 w
->cursor
.vpos
= -1;
16393 clear_glyph_matrix (w
->desired_matrix
);
16394 goto try_to_scroll
;
16398 int window_height
= window_box_height (w
);
16401 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16402 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16404 w
->cursor
.vpos
= -1;
16405 clear_glyph_matrix (w
->desired_matrix
);
16406 goto try_to_scroll
;
16411 /* If we need to move point for either of the above reasons,
16412 now actually do it. */
16415 struct glyph_row
*row
;
16417 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16418 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16421 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16422 MATRIX_ROW_START_BYTEPOS (row
));
16424 if (w
!= XWINDOW (selected_window
))
16425 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16426 else if (current_buffer
== old
)
16427 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16429 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16431 /* Re-run pre-redisplay-function so it can update the region
16432 according to the new position of point. */
16433 /* Other than the cursor, w's redisplay is done so we can set its
16434 redisplay to false. Also the buffer's redisplay can be set to
16435 false, since propagate_buffer_redisplay should have already
16436 propagated its info to `w' anyway. */
16437 w
->redisplay
= false;
16438 XBUFFER (w
->contents
)->text
->redisplay
= false;
16439 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16441 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16443 /* pre-redisplay-function made changes (e.g. move the region)
16444 that require another round of redisplay. */
16445 clear_glyph_matrix (w
->desired_matrix
);
16446 if (!try_window (window
, startp
, 0))
16447 goto need_larger_matrices
;
16450 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16452 clear_glyph_matrix (w
->desired_matrix
);
16453 goto try_to_scroll
;
16457 debug_method_add (w
, "forced window start");
16462 /* Handle case where text has not changed, only point, and it has
16463 not moved off the frame, and we are not retrying after hscroll.
16464 (current_matrix_up_to_date_p is true when retrying.) */
16465 if (current_matrix_up_to_date_p
16466 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16467 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16471 case CURSOR_MOVEMENT_SUCCESS
:
16472 used_current_matrix_p
= true;
16475 case CURSOR_MOVEMENT_MUST_SCROLL
:
16476 goto try_to_scroll
;
16482 /* If current starting point was originally the beginning of a line
16483 but no longer is, find a new starting point. */
16484 else if (w
->start_at_line_beg
16485 && !(CHARPOS (startp
) <= BEGV
16486 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16489 debug_method_add (w
, "recenter 1");
16494 /* Try scrolling with try_window_id. Value is > 0 if update has
16495 been done, it is -1 if we know that the same window start will
16496 not work. It is 0 if unsuccessful for some other reason. */
16497 else if ((tem
= try_window_id (w
)) != 0)
16500 debug_method_add (w
, "try_window_id %d", tem
);
16503 if (f
->fonts_changed
)
16504 goto need_larger_matrices
;
16508 /* Otherwise try_window_id has returned -1 which means that we
16509 don't want the alternative below this comment to execute. */
16511 else if (CHARPOS (startp
) >= BEGV
16512 && CHARPOS (startp
) <= ZV
16513 && PT
>= CHARPOS (startp
)
16514 && (CHARPOS (startp
) < ZV
16515 /* Avoid starting at end of buffer. */
16516 || CHARPOS (startp
) == BEGV
16517 || !window_outdated (w
)))
16519 int d1
, d2
, d5
, d6
;
16522 /* If first window line is a continuation line, and window start
16523 is inside the modified region, but the first change is before
16524 current window start, we must select a new window start.
16526 However, if this is the result of a down-mouse event (e.g. by
16527 extending the mouse-drag-overlay), we don't want to select a
16528 new window start, since that would change the position under
16529 the mouse, resulting in an unwanted mouse-movement rather
16530 than a simple mouse-click. */
16531 if (!w
->start_at_line_beg
16532 && NILP (do_mouse_tracking
)
16533 && CHARPOS (startp
) > BEGV
16534 && CHARPOS (startp
) > BEG
+ beg_unchanged
16535 && CHARPOS (startp
) <= Z
- end_unchanged
16536 /* Even if w->start_at_line_beg is nil, a new window may
16537 start at a line_beg, since that's how set_buffer_window
16538 sets it. So, we need to check the return value of
16539 compute_window_start_on_continuation_line. (See also
16541 && XMARKER (w
->start
)->buffer
== current_buffer
16542 && compute_window_start_on_continuation_line (w
)
16543 /* It doesn't make sense to force the window start like we
16544 do at label force_start if it is already known that point
16545 will not be fully visible in the resulting window, because
16546 doing so will move point from its correct position
16547 instead of scrolling the window to bring point into view.
16549 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16550 /* A very tall row could need more than the window height,
16551 in which case we accept that it is partially visible. */
16552 && (rtop
!= 0) == (rbot
!= 0))
16554 w
->force_start
= true;
16555 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16557 debug_method_add (w
, "recomputed window start in continuation line");
16563 debug_method_add (w
, "same window start");
16566 /* Try to redisplay starting at same place as before.
16567 If point has not moved off frame, accept the results. */
16568 if (!current_matrix_up_to_date_p
16569 /* Don't use try_window_reusing_current_matrix in this case
16570 because a window scroll function can have changed the
16572 || !NILP (Vwindow_scroll_functions
)
16573 || MINI_WINDOW_P (w
)
16574 || !(used_current_matrix_p
16575 = try_window_reusing_current_matrix (w
)))
16577 IF_DEBUG (debug_method_add (w
, "1"));
16578 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16579 /* -1 means we need to scroll.
16580 0 means we need new matrices, but fonts_changed
16581 is set in that case, so we will detect it below. */
16582 goto try_to_scroll
;
16585 if (f
->fonts_changed
)
16586 goto need_larger_matrices
;
16588 if (w
->cursor
.vpos
>= 0)
16590 if (!just_this_one_p
16591 || current_buffer
->clip_changed
16592 || BEG_UNCHANGED
< CHARPOS (startp
))
16593 /* Forget any recorded base line for line number display. */
16594 w
->base_line_number
= 0;
16596 if (!cursor_row_fully_visible_p (w
, true, false))
16598 clear_glyph_matrix (w
->desired_matrix
);
16599 last_line_misfit
= true;
16601 /* Drop through and scroll. */
16606 clear_glyph_matrix (w
->desired_matrix
);
16611 /* Redisplay the mode line. Select the buffer properly for that. */
16612 if (!update_mode_line
)
16614 update_mode_line
= true;
16615 w
->update_mode_line
= true;
16618 /* Try to scroll by specified few lines. */
16619 if ((scroll_conservatively
16620 || emacs_scroll_step
16621 || temp_scroll_step
16622 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16623 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16624 && CHARPOS (startp
) >= BEGV
16625 && CHARPOS (startp
) <= ZV
)
16627 /* The function returns -1 if new fonts were loaded, 1 if
16628 successful, 0 if not successful. */
16629 int ss
= try_scrolling (window
, just_this_one_p
,
16630 scroll_conservatively
,
16632 temp_scroll_step
, last_line_misfit
);
16635 case SCROLLING_SUCCESS
:
16638 case SCROLLING_NEED_LARGER_MATRICES
:
16639 goto need_larger_matrices
;
16641 case SCROLLING_FAILED
:
16649 /* Finally, just choose a place to start which positions point
16650 according to user preferences. */
16655 debug_method_add (w
, "recenter");
16658 /* Forget any previously recorded base line for line number display. */
16659 if (!buffer_unchanged_p
)
16660 w
->base_line_number
= 0;
16662 /* Determine the window start relative to point. */
16663 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16664 it
.current_y
= it
.last_visible_y
;
16665 if (centering_position
< 0)
16667 int window_total_lines
16668 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16670 = scroll_margin
> 0
16671 ? min (scroll_margin
, window_total_lines
/ 4)
16673 ptrdiff_t margin_pos
= CHARPOS (startp
);
16674 Lisp_Object aggressive
;
16677 /* If there is a scroll margin at the top of the window, find
16678 its character position. */
16680 /* Cannot call start_display if startp is not in the
16681 accessible region of the buffer. This can happen when we
16682 have just switched to a different buffer and/or changed
16683 its restriction. In that case, startp is initialized to
16684 the character position 1 (BEGV) because we did not yet
16685 have chance to display the buffer even once. */
16686 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16689 void *it1data
= NULL
;
16691 SAVE_IT (it1
, it
, it1data
);
16692 start_display (&it1
, w
, startp
);
16693 move_it_vertically (&it1
, margin
* frame_line_height
);
16694 margin_pos
= IT_CHARPOS (it1
);
16695 RESTORE_IT (&it
, &it
, it1data
);
16697 scrolling_up
= PT
> margin_pos
;
16700 ? BVAR (current_buffer
, scroll_up_aggressively
)
16701 : BVAR (current_buffer
, scroll_down_aggressively
);
16703 if (!MINI_WINDOW_P (w
)
16704 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16708 /* Setting scroll-conservatively overrides
16709 scroll-*-aggressively. */
16710 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16712 double float_amount
= XFLOATINT (aggressive
);
16714 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16715 if (pt_offset
== 0 && float_amount
> 0)
16717 if (pt_offset
&& margin
> 0)
16720 /* Compute how much to move the window start backward from
16721 point so that point will be displayed where the user
16725 centering_position
= it
.last_visible_y
;
16727 centering_position
-= pt_offset
;
16728 centering_position
-=
16729 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16730 + WINDOW_HEADER_LINE_HEIGHT (w
));
16731 /* Don't let point enter the scroll margin near top of
16733 if (centering_position
< margin
* frame_line_height
)
16734 centering_position
= margin
* frame_line_height
;
16737 centering_position
= margin
* frame_line_height
+ pt_offset
;
16740 /* Set the window start half the height of the window backward
16742 centering_position
= window_box_height (w
) / 2;
16744 move_it_vertically_backward (&it
, centering_position
);
16746 eassert (IT_CHARPOS (it
) >= BEGV
);
16748 /* The function move_it_vertically_backward may move over more
16749 than the specified y-distance. If it->w is small, e.g. a
16750 mini-buffer window, we may end up in front of the window's
16751 display area. Start displaying at the start of the line
16752 containing PT in this case. */
16753 if (it
.current_y
<= 0)
16755 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16756 move_it_vertically_backward (&it
, 0);
16760 it
.current_x
= it
.hpos
= 0;
16762 /* Set the window start position here explicitly, to avoid an
16763 infinite loop in case the functions in window-scroll-functions
16765 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16767 /* Run scroll hooks. */
16768 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16770 /* Redisplay the window. */
16771 use_desired_matrix
= false;
16772 if (!current_matrix_up_to_date_p
16773 || windows_or_buffers_changed
16774 || f
->cursor_type_changed
16775 /* Don't use try_window_reusing_current_matrix in this case
16776 because it can have changed the buffer. */
16777 || !NILP (Vwindow_scroll_functions
)
16778 || !just_this_one_p
16779 || MINI_WINDOW_P (w
)
16780 || !(used_current_matrix_p
16781 = try_window_reusing_current_matrix (w
)))
16782 use_desired_matrix
= (try_window (window
, startp
, 0) == 1);
16784 /* If new fonts have been loaded (due to fontsets), give up. We
16785 have to start a new redisplay since we need to re-adjust glyph
16787 if (f
->fonts_changed
)
16788 goto need_larger_matrices
;
16790 /* If cursor did not appear assume that the middle of the window is
16791 in the first line of the window. Do it again with the next line.
16792 (Imagine a window of height 100, displaying two lines of height
16793 60. Moving back 50 from it->last_visible_y will end in the first
16795 if (w
->cursor
.vpos
< 0)
16797 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16799 clear_glyph_matrix (w
->desired_matrix
);
16800 move_it_by_lines (&it
, 1);
16801 try_window (window
, it
.current
.pos
, 0);
16803 else if (PT
< IT_CHARPOS (it
))
16805 clear_glyph_matrix (w
->desired_matrix
);
16806 move_it_by_lines (&it
, -1);
16807 try_window (window
, it
.current
.pos
, 0);
16811 /* Not much we can do about it. */
16815 /* Consider the following case: Window starts at BEGV, there is
16816 invisible, intangible text at BEGV, so that display starts at
16817 some point START > BEGV. It can happen that we are called with
16818 PT somewhere between BEGV and START. Try to handle that case,
16819 and similar ones. */
16820 if (w
->cursor
.vpos
< 0)
16822 /* Prefer the desired matrix to the current matrix, if possible,
16823 in the fallback calculations below. This is because using
16824 the current matrix might completely goof, e.g. if its first
16825 row is after point. */
16826 struct glyph_matrix
*matrix
=
16827 use_desired_matrix
? w
->desired_matrix
: w
->current_matrix
;
16828 /* First, try locating the proper glyph row for PT. */
16829 struct glyph_row
*row
=
16830 row_containing_pos (w
, PT
, matrix
->rows
, NULL
, 0);
16832 /* Sometimes point is at the beginning of invisible text that is
16833 before the 1st character displayed in the row. In that case,
16834 row_containing_pos fails to find the row, because no glyphs
16835 with appropriate buffer positions are present in the row.
16836 Therefore, we next try to find the row which shows the 1st
16837 position after the invisible text. */
16841 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16844 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16847 Lisp_Object invis_end
=
16848 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16851 if (NATNUMP (invis_end
))
16852 alt_pos
= XFASTINT (invis_end
);
16855 row
= row_containing_pos (w
, alt_pos
, matrix
->rows
, NULL
, 0);
16858 /* Finally, fall back on the first row of the window after the
16859 header line (if any). This is slightly better than not
16860 displaying the cursor at all. */
16863 row
= matrix
->rows
;
16864 if (row
->mode_line_p
)
16867 set_cursor_from_row (w
, row
, matrix
, 0, 0, 0, 0);
16870 if (!cursor_row_fully_visible_p (w
, false, false))
16872 /* If vscroll is enabled, disable it and try again. */
16876 clear_glyph_matrix (w
->desired_matrix
);
16880 /* Users who set scroll-conservatively to a large number want
16881 point just above/below the scroll margin. If we ended up
16882 with point's row partially visible, move the window start to
16883 make that row fully visible and out of the margin. */
16884 if (scroll_conservatively
> SCROLL_LIMIT
)
16886 int window_total_lines
16887 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16890 ? min (scroll_margin
, window_total_lines
/ 4)
16892 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16894 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16895 clear_glyph_matrix (w
->desired_matrix
);
16896 if (1 == try_window (window
, it
.current
.pos
,
16897 TRY_WINDOW_CHECK_MARGINS
))
16901 /* If centering point failed to make the whole line visible,
16902 put point at the top instead. That has to make the whole line
16903 visible, if it can be done. */
16904 if (centering_position
== 0)
16907 clear_glyph_matrix (w
->desired_matrix
);
16908 centering_position
= 0;
16914 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16915 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16916 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16918 /* Display the mode line, if we must. */
16919 if ((update_mode_line
16920 /* If window not full width, must redo its mode line
16921 if (a) the window to its side is being redone and
16922 (b) we do a frame-based redisplay. This is a consequence
16923 of how inverted lines are drawn in frame-based redisplay. */
16924 || (!just_this_one_p
16925 && !FRAME_WINDOW_P (f
)
16926 && !WINDOW_FULL_WIDTH_P (w
))
16927 /* Line number to display. */
16928 || w
->base_line_pos
> 0
16929 /* Column number is displayed and different from the one displayed. */
16930 || (w
->column_number_displayed
!= -1
16931 && (w
->column_number_displayed
!= current_column ())))
16932 /* This means that the window has a mode line. */
16933 && (WINDOW_WANTS_MODELINE_P (w
)
16934 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16937 display_mode_lines (w
);
16939 /* If mode line height has changed, arrange for a thorough
16940 immediate redisplay using the correct mode line height. */
16941 if (WINDOW_WANTS_MODELINE_P (w
)
16942 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16944 f
->fonts_changed
= true;
16945 w
->mode_line_height
= -1;
16946 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16947 = DESIRED_MODE_LINE_HEIGHT (w
);
16950 /* If header line height has changed, arrange for a thorough
16951 immediate redisplay using the correct header line height. */
16952 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16953 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16955 f
->fonts_changed
= true;
16956 w
->header_line_height
= -1;
16957 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16958 = DESIRED_HEADER_LINE_HEIGHT (w
);
16961 if (f
->fonts_changed
)
16962 goto need_larger_matrices
;
16965 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16967 w
->base_line_pos
= 0;
16968 w
->base_line_number
= 0;
16973 /* When we reach a frame's selected window, redo the frame's menu
16974 bar and the frame's title. */
16975 if (update_mode_line
16976 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16978 bool redisplay_menu_p
;
16980 if (FRAME_WINDOW_P (f
))
16982 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16983 || defined (HAVE_NS) || defined (USE_GTK)
16984 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16986 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16990 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16992 if (redisplay_menu_p
)
16993 display_menu_bar (w
);
16995 #ifdef HAVE_WINDOW_SYSTEM
16996 if (FRAME_WINDOW_P (f
))
16998 #if defined (USE_GTK) || defined (HAVE_NS)
16999 if (FRAME_EXTERNAL_TOOL_BAR (f
))
17000 redisplay_tool_bar (f
);
17002 if (WINDOWP (f
->tool_bar_window
)
17003 && (FRAME_TOOL_BAR_LINES (f
) > 0
17004 || !NILP (Vauto_resize_tool_bars
))
17005 && redisplay_tool_bar (f
))
17006 ignore_mouse_drag_p
= true;
17009 x_consider_frame_title (w
->frame
);
17013 #ifdef HAVE_WINDOW_SYSTEM
17014 if (FRAME_WINDOW_P (f
)
17015 && update_window_fringes (w
, (just_this_one_p
17016 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
17017 || w
->pseudo_window_p
)))
17021 if (draw_window_fringes (w
, true))
17023 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
17024 x_draw_right_divider (w
);
17026 x_draw_vertical_border (w
);
17032 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
17033 x_draw_bottom_divider (w
);
17034 #endif /* HAVE_WINDOW_SYSTEM */
17036 /* We go to this label, with fonts_changed set, if it is
17037 necessary to try again using larger glyph matrices.
17038 We have to redeem the scroll bar even in this case,
17039 because the loop in redisplay_internal expects that. */
17040 need_larger_matrices
:
17042 finish_scroll_bars
:
17044 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17046 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
17047 /* Set the thumb's position and size. */
17048 set_vertical_scroll_bar (w
);
17050 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
17051 /* Set the thumb's position and size. */
17052 set_horizontal_scroll_bar (w
);
17054 /* Note that we actually used the scroll bar attached to this
17055 window, so it shouldn't be deleted at the end of redisplay. */
17056 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
17057 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
17060 /* Restore current_buffer and value of point in it. The window
17061 update may have changed the buffer, so first make sure `opoint'
17062 is still valid (Bug#6177). */
17063 if (CHARPOS (opoint
) < BEGV
)
17064 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17065 else if (CHARPOS (opoint
) > ZV
)
17066 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
17068 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
17070 set_buffer_internal_1 (old
);
17071 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17072 shorter. This can be caused by log truncation in *Messages*. */
17073 if (CHARPOS (lpoint
) <= ZV
)
17074 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17076 unbind_to (count
, Qnil
);
17080 /* Build the complete desired matrix of WINDOW with a window start
17081 buffer position POS.
17083 Value is 1 if successful. It is zero if fonts were loaded during
17084 redisplay which makes re-adjusting glyph matrices necessary, and -1
17085 if point would appear in the scroll margins.
17086 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17087 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17091 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
17093 struct window
*w
= XWINDOW (window
);
17095 struct glyph_row
*last_text_row
= NULL
;
17096 struct frame
*f
= XFRAME (w
->frame
);
17097 int frame_line_height
= default_line_pixel_height (w
);
17099 /* Make POS the new window start. */
17100 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17102 /* Mark cursor position as unknown. No overlay arrow seen. */
17103 w
->cursor
.vpos
= -1;
17104 overlay_arrow_seen
= false;
17106 /* Initialize iterator and info to start at POS. */
17107 start_display (&it
, w
, pos
);
17108 it
.glyph_row
->reversed_p
= false;
17110 /* Display all lines of W. */
17111 while (it
.current_y
< it
.last_visible_y
)
17113 if (display_line (&it
))
17114 last_text_row
= it
.glyph_row
- 1;
17115 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17119 /* Don't let the cursor end in the scroll margins. */
17120 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17121 && !MINI_WINDOW_P (w
))
17123 int this_scroll_margin
;
17124 int window_total_lines
17125 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17127 if (scroll_margin
> 0)
17129 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17130 this_scroll_margin
*= frame_line_height
;
17133 this_scroll_margin
= 0;
17135 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17136 && w
->cursor
.y
< this_scroll_margin
17137 && CHARPOS (pos
) > BEGV
17138 && IT_CHARPOS (it
) < ZV
)
17139 /* rms: considering make_cursor_line_fully_visible_p here
17140 seems to give wrong results. We don't want to recenter
17141 when the last line is partly visible, we want to allow
17142 that case to be handled in the usual way. */
17143 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17145 w
->cursor
.vpos
= -1;
17146 clear_glyph_matrix (w
->desired_matrix
);
17151 /* If bottom moved off end of frame, change mode line percentage. */
17152 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17153 w
->update_mode_line
= true;
17155 /* Set window_end_pos to the offset of the last character displayed
17156 on the window from the end of current_buffer. Set
17157 window_end_vpos to its row number. */
17160 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17161 adjust_window_ends (w
, last_text_row
, false);
17163 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17164 w
->window_end_vpos
)));
17168 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17169 w
->window_end_pos
= Z
- ZV
;
17170 w
->window_end_vpos
= 0;
17173 /* But that is not valid info until redisplay finishes. */
17174 w
->window_end_valid
= false;
17180 /************************************************************************
17181 Window redisplay reusing current matrix when buffer has not changed
17182 ************************************************************************/
17184 /* Try redisplay of window W showing an unchanged buffer with a
17185 different window start than the last time it was displayed by
17186 reusing its current matrix. Value is true if successful.
17187 W->start is the new window start. */
17190 try_window_reusing_current_matrix (struct window
*w
)
17192 struct frame
*f
= XFRAME (w
->frame
);
17193 struct glyph_row
*bottom_row
;
17196 struct text_pos start
, new_start
;
17197 int nrows_scrolled
, i
;
17198 struct glyph_row
*last_text_row
;
17199 struct glyph_row
*last_reused_text_row
;
17200 struct glyph_row
*start_row
;
17201 int start_vpos
, min_y
, max_y
;
17204 if (inhibit_try_window_reusing
)
17208 if (/* This function doesn't handle terminal frames. */
17209 !FRAME_WINDOW_P (f
)
17210 /* Don't try to reuse the display if windows have been split
17212 || windows_or_buffers_changed
17213 || f
->cursor_type_changed
)
17216 /* Can't do this if showing trailing whitespace. */
17217 if (!NILP (Vshow_trailing_whitespace
))
17220 /* If top-line visibility has changed, give up. */
17221 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17222 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17225 /* Give up if old or new display is scrolled vertically. We could
17226 make this function handle this, but right now it doesn't. */
17227 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17228 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17231 /* The variable new_start now holds the new window start. The old
17232 start `start' can be determined from the current matrix. */
17233 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17234 start
= start_row
->minpos
;
17235 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17237 /* Clear the desired matrix for the display below. */
17238 clear_glyph_matrix (w
->desired_matrix
);
17240 if (CHARPOS (new_start
) <= CHARPOS (start
))
17242 /* Don't use this method if the display starts with an ellipsis
17243 displayed for invisible text. It's not easy to handle that case
17244 below, and it's certainly not worth the effort since this is
17245 not a frequent case. */
17246 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17249 IF_DEBUG (debug_method_add (w
, "twu1"));
17251 /* Display up to a row that can be reused. The variable
17252 last_text_row is set to the last row displayed that displays
17253 text. Note that it.vpos == 0 if or if not there is a
17254 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17255 start_display (&it
, w
, new_start
);
17256 w
->cursor
.vpos
= -1;
17257 last_text_row
= last_reused_text_row
= NULL
;
17259 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17261 /* If we have reached into the characters in the START row,
17262 that means the line boundaries have changed. So we
17263 can't start copying with the row START. Maybe it will
17264 work to start copying with the following row. */
17265 while (IT_CHARPOS (it
) > CHARPOS (start
))
17267 /* Advance to the next row as the "start". */
17269 start
= start_row
->minpos
;
17270 /* If there are no more rows to try, or just one, give up. */
17271 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17272 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17273 || CHARPOS (start
) == ZV
)
17275 clear_glyph_matrix (w
->desired_matrix
);
17279 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17281 /* If we have reached alignment, we can copy the rest of the
17283 if (IT_CHARPOS (it
) == CHARPOS (start
)
17284 /* Don't accept "alignment" inside a display vector,
17285 since start_row could have started in the middle of
17286 that same display vector (thus their character
17287 positions match), and we have no way of telling if
17288 that is the case. */
17289 && it
.current
.dpvec_index
< 0)
17292 it
.glyph_row
->reversed_p
= false;
17293 if (display_line (&it
))
17294 last_text_row
= it
.glyph_row
- 1;
17298 /* A value of current_y < last_visible_y means that we stopped
17299 at the previous window start, which in turn means that we
17300 have at least one reusable row. */
17301 if (it
.current_y
< it
.last_visible_y
)
17303 struct glyph_row
*row
;
17305 /* IT.vpos always starts from 0; it counts text lines. */
17306 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17308 /* Find PT if not already found in the lines displayed. */
17309 if (w
->cursor
.vpos
< 0)
17311 int dy
= it
.current_y
- start_row
->y
;
17313 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17314 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17316 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17317 dy
, nrows_scrolled
);
17320 clear_glyph_matrix (w
->desired_matrix
);
17325 /* Scroll the display. Do it before the current matrix is
17326 changed. The problem here is that update has not yet
17327 run, i.e. part of the current matrix is not up to date.
17328 scroll_run_hook will clear the cursor, and use the
17329 current matrix to get the height of the row the cursor is
17331 run
.current_y
= start_row
->y
;
17332 run
.desired_y
= it
.current_y
;
17333 run
.height
= it
.last_visible_y
- it
.current_y
;
17335 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17338 FRAME_RIF (f
)->update_window_begin_hook (w
);
17339 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17340 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17341 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17345 /* Shift current matrix down by nrows_scrolled lines. */
17346 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17347 rotate_matrix (w
->current_matrix
,
17349 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17352 /* Disable lines that must be updated. */
17353 for (i
= 0; i
< nrows_scrolled
; ++i
)
17354 (start_row
+ i
)->enabled_p
= false;
17356 /* Re-compute Y positions. */
17357 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17358 max_y
= it
.last_visible_y
;
17359 for (row
= start_row
+ nrows_scrolled
;
17363 row
->y
= it
.current_y
;
17364 row
->visible_height
= row
->height
;
17366 if (row
->y
< min_y
)
17367 row
->visible_height
-= min_y
- row
->y
;
17368 if (row
->y
+ row
->height
> max_y
)
17369 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17370 if (row
->fringe_bitmap_periodic_p
)
17371 row
->redraw_fringe_bitmaps_p
= true;
17373 it
.current_y
+= row
->height
;
17375 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17376 last_reused_text_row
= row
;
17377 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17381 /* Disable lines in the current matrix which are now
17382 below the window. */
17383 for (++row
; row
< bottom_row
; ++row
)
17384 row
->enabled_p
= row
->mode_line_p
= false;
17387 /* Update window_end_pos etc.; last_reused_text_row is the last
17388 reused row from the current matrix containing text, if any.
17389 The value of last_text_row is the last displayed line
17390 containing text. */
17391 if (last_reused_text_row
)
17392 adjust_window_ends (w
, last_reused_text_row
, true);
17393 else if (last_text_row
)
17394 adjust_window_ends (w
, last_text_row
, false);
17397 /* This window must be completely empty. */
17398 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17399 w
->window_end_pos
= Z
- ZV
;
17400 w
->window_end_vpos
= 0;
17402 w
->window_end_valid
= false;
17404 /* Update hint: don't try scrolling again in update_window. */
17405 w
->desired_matrix
->no_scrolling_p
= true;
17408 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17412 else if (CHARPOS (new_start
) > CHARPOS (start
))
17414 struct glyph_row
*pt_row
, *row
;
17415 struct glyph_row
*first_reusable_row
;
17416 struct glyph_row
*first_row_to_display
;
17418 int yb
= window_text_bottom_y (w
);
17420 /* Find the row starting at new_start, if there is one. Don't
17421 reuse a partially visible line at the end. */
17422 first_reusable_row
= start_row
;
17423 while (first_reusable_row
->enabled_p
17424 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17425 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17426 < CHARPOS (new_start
)))
17427 ++first_reusable_row
;
17429 /* Give up if there is no row to reuse. */
17430 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17431 || !first_reusable_row
->enabled_p
17432 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17433 != CHARPOS (new_start
)))
17436 /* We can reuse fully visible rows beginning with
17437 first_reusable_row to the end of the window. Set
17438 first_row_to_display to the first row that cannot be reused.
17439 Set pt_row to the row containing point, if there is any. */
17441 for (first_row_to_display
= first_reusable_row
;
17442 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17443 ++first_row_to_display
)
17445 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17446 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17447 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17448 && first_row_to_display
->ends_at_zv_p
17449 && pt_row
== NULL
)))
17450 pt_row
= first_row_to_display
;
17453 /* Start displaying at the start of first_row_to_display. */
17454 eassert (first_row_to_display
->y
< yb
);
17455 init_to_row_start (&it
, w
, first_row_to_display
);
17457 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17459 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17461 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17462 + WINDOW_HEADER_LINE_HEIGHT (w
));
17464 /* Display lines beginning with first_row_to_display in the
17465 desired matrix. Set last_text_row to the last row displayed
17466 that displays text. */
17467 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17468 if (pt_row
== NULL
)
17469 w
->cursor
.vpos
= -1;
17470 last_text_row
= NULL
;
17471 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17472 if (display_line (&it
))
17473 last_text_row
= it
.glyph_row
- 1;
17475 /* If point is in a reused row, adjust y and vpos of the cursor
17479 w
->cursor
.vpos
-= nrows_scrolled
;
17480 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17483 /* Give up if point isn't in a row displayed or reused. (This
17484 also handles the case where w->cursor.vpos < nrows_scrolled
17485 after the calls to display_line, which can happen with scroll
17486 margins. See bug#1295.) */
17487 if (w
->cursor
.vpos
< 0)
17489 clear_glyph_matrix (w
->desired_matrix
);
17493 /* Scroll the display. */
17494 run
.current_y
= first_reusable_row
->y
;
17495 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17496 run
.height
= it
.last_visible_y
- run
.current_y
;
17497 dy
= run
.current_y
- run
.desired_y
;
17502 FRAME_RIF (f
)->update_window_begin_hook (w
);
17503 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17504 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17505 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17509 /* Adjust Y positions of reused rows. */
17510 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17511 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17512 max_y
= it
.last_visible_y
;
17513 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17516 row
->visible_height
= row
->height
;
17517 if (row
->y
< min_y
)
17518 row
->visible_height
-= min_y
- row
->y
;
17519 if (row
->y
+ row
->height
> max_y
)
17520 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17521 if (row
->fringe_bitmap_periodic_p
)
17522 row
->redraw_fringe_bitmaps_p
= true;
17525 /* Scroll the current matrix. */
17526 eassert (nrows_scrolled
> 0);
17527 rotate_matrix (w
->current_matrix
,
17529 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17532 /* Disable rows not reused. */
17533 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17534 row
->enabled_p
= false;
17536 /* Point may have moved to a different line, so we cannot assume that
17537 the previous cursor position is valid; locate the correct row. */
17540 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17542 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17543 && !row
->ends_at_zv_p
;
17547 w
->cursor
.y
= row
->y
;
17549 if (row
< bottom_row
)
17551 /* Can't simply scan the row for point with
17552 bidi-reordered glyph rows. Let set_cursor_from_row
17553 figure out where to put the cursor, and if it fails,
17555 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17557 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17560 clear_glyph_matrix (w
->desired_matrix
);
17566 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17567 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17570 && (!BUFFERP (glyph
->object
)
17571 || glyph
->charpos
< PT
);
17575 w
->cursor
.x
+= glyph
->pixel_width
;
17581 /* Adjust window end. A null value of last_text_row means that
17582 the window end is in reused rows which in turn means that
17583 only its vpos can have changed. */
17585 adjust_window_ends (w
, last_text_row
, false);
17587 w
->window_end_vpos
-= nrows_scrolled
;
17589 w
->window_end_valid
= false;
17590 w
->desired_matrix
->no_scrolling_p
= true;
17593 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17603 /************************************************************************
17604 Window redisplay reusing current matrix when buffer has changed
17605 ************************************************************************/
17607 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17608 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17609 ptrdiff_t *, ptrdiff_t *);
17610 static struct glyph_row
*
17611 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17612 struct glyph_row
*);
17615 /* Return the last row in MATRIX displaying text. If row START is
17616 non-null, start searching with that row. IT gives the dimensions
17617 of the display. Value is null if matrix is empty; otherwise it is
17618 a pointer to the row found. */
17620 static struct glyph_row
*
17621 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17622 struct glyph_row
*start
)
17624 struct glyph_row
*row
, *row_found
;
17626 /* Set row_found to the last row in IT->w's current matrix
17627 displaying text. The loop looks funny but think of partially
17630 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17631 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17633 eassert (row
->enabled_p
);
17635 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17644 /* Return the last row in the current matrix of W that is not affected
17645 by changes at the start of current_buffer that occurred since W's
17646 current matrix was built. Value is null if no such row exists.
17648 BEG_UNCHANGED us the number of characters unchanged at the start of
17649 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17650 first changed character in current_buffer. Characters at positions <
17651 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17652 when the current matrix was built. */
17654 static struct glyph_row
*
17655 find_last_unchanged_at_beg_row (struct window
*w
)
17657 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17658 struct glyph_row
*row
;
17659 struct glyph_row
*row_found
= NULL
;
17660 int yb
= window_text_bottom_y (w
);
17662 /* Find the last row displaying unchanged text. */
17663 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17664 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17665 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17668 if (/* If row ends before first_changed_pos, it is unchanged,
17669 except in some case. */
17670 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17671 /* When row ends in ZV and we write at ZV it is not
17673 && !row
->ends_at_zv_p
17674 /* When first_changed_pos is the end of a continued line,
17675 row is not unchanged because it may be no longer
17677 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17678 && (row
->continued_p
17679 || row
->exact_window_width_line_p
))
17680 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17681 needs to be recomputed, so don't consider this row as
17682 unchanged. This happens when the last line was
17683 bidi-reordered and was killed immediately before this
17684 redisplay cycle. In that case, ROW->end stores the
17685 buffer position of the first visual-order character of
17686 the killed text, which is now beyond ZV. */
17687 && CHARPOS (row
->end
.pos
) <= ZV
)
17690 /* Stop if last visible row. */
17691 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17699 /* Find the first glyph row in the current matrix of W that is not
17700 affected by changes at the end of current_buffer since the
17701 time W's current matrix was built.
17703 Return in *DELTA the number of chars by which buffer positions in
17704 unchanged text at the end of current_buffer must be adjusted.
17706 Return in *DELTA_BYTES the corresponding number of bytes.
17708 Value is null if no such row exists, i.e. all rows are affected by
17711 static struct glyph_row
*
17712 find_first_unchanged_at_end_row (struct window
*w
,
17713 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17715 struct glyph_row
*row
;
17716 struct glyph_row
*row_found
= NULL
;
17718 *delta
= *delta_bytes
= 0;
17720 /* Display must not have been paused, otherwise the current matrix
17721 is not up to date. */
17722 eassert (w
->window_end_valid
);
17724 /* A value of window_end_pos >= END_UNCHANGED means that the window
17725 end is in the range of changed text. If so, there is no
17726 unchanged row at the end of W's current matrix. */
17727 if (w
->window_end_pos
>= END_UNCHANGED
)
17730 /* Set row to the last row in W's current matrix displaying text. */
17731 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17733 /* If matrix is entirely empty, no unchanged row exists. */
17734 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17736 /* The value of row is the last glyph row in the matrix having a
17737 meaningful buffer position in it. The end position of row
17738 corresponds to window_end_pos. This allows us to translate
17739 buffer positions in the current matrix to current buffer
17740 positions for characters not in changed text. */
17742 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17743 ptrdiff_t Z_BYTE_old
=
17744 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17745 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17746 struct glyph_row
*first_text_row
17747 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17749 *delta
= Z
- Z_old
;
17750 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17752 /* Set last_unchanged_pos to the buffer position of the last
17753 character in the buffer that has not been changed. Z is the
17754 index + 1 of the last character in current_buffer, i.e. by
17755 subtracting END_UNCHANGED we get the index of the last
17756 unchanged character, and we have to add BEG to get its buffer
17758 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17759 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17761 /* Search backward from ROW for a row displaying a line that
17762 starts at a minimum position >= last_unchanged_pos_old. */
17763 for (; row
> first_text_row
; --row
)
17765 /* This used to abort, but it can happen.
17766 It is ok to just stop the search instead here. KFS. */
17767 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17770 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17775 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17781 /* Make sure that glyph rows in the current matrix of window W
17782 reference the same glyph memory as corresponding rows in the
17783 frame's frame matrix. This function is called after scrolling W's
17784 current matrix on a terminal frame in try_window_id and
17785 try_window_reusing_current_matrix. */
17788 sync_frame_with_window_matrix_rows (struct window
*w
)
17790 struct frame
*f
= XFRAME (w
->frame
);
17791 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17793 /* Preconditions: W must be a leaf window and full-width. Its frame
17794 must have a frame matrix. */
17795 eassert (BUFFERP (w
->contents
));
17796 eassert (WINDOW_FULL_WIDTH_P (w
));
17797 eassert (!FRAME_WINDOW_P (f
));
17799 /* If W is a full-width window, glyph pointers in W's current matrix
17800 have, by definition, to be the same as glyph pointers in the
17801 corresponding frame matrix. Note that frame matrices have no
17802 marginal areas (see build_frame_matrix). */
17803 window_row
= w
->current_matrix
->rows
;
17804 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17805 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17806 while (window_row
< window_row_end
)
17808 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17809 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17811 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17812 frame_row
->glyphs
[TEXT_AREA
] = start
;
17813 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17814 frame_row
->glyphs
[LAST_AREA
] = end
;
17816 /* Disable frame rows whose corresponding window rows have
17817 been disabled in try_window_id. */
17818 if (!window_row
->enabled_p
)
17819 frame_row
->enabled_p
= false;
17821 ++window_row
, ++frame_row
;
17826 /* Find the glyph row in window W containing CHARPOS. Consider all
17827 rows between START and END (not inclusive). END null means search
17828 all rows to the end of the display area of W. Value is the row
17829 containing CHARPOS or null. */
17832 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17833 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17835 struct glyph_row
*row
= start
;
17836 struct glyph_row
*best_row
= NULL
;
17837 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17840 /* If we happen to start on a header-line, skip that. */
17841 if (row
->mode_line_p
)
17844 if ((end
&& row
>= end
) || !row
->enabled_p
)
17847 last_y
= window_text_bottom_y (w
) - dy
;
17851 /* Give up if we have gone too far. */
17852 if ((end
&& row
>= end
) || !row
->enabled_p
)
17854 /* This formerly returned if they were equal.
17855 I think that both quantities are of a "last plus one" type;
17856 if so, when they are equal, the row is within the screen. -- rms. */
17857 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17860 /* If it is in this row, return this row. */
17861 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17862 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17863 /* The end position of a row equals the start
17864 position of the next row. If CHARPOS is there, we
17865 would rather consider it displayed in the next
17866 line, except when this line ends in ZV. */
17867 && !row_for_charpos_p (row
, charpos
)))
17868 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17872 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17873 || (!best_row
&& !row
->continued_p
))
17875 /* In bidi-reordered rows, there could be several rows whose
17876 edges surround CHARPOS, all of these rows belonging to
17877 the same continued line. We need to find the row which
17878 fits CHARPOS the best. */
17879 for (g
= row
->glyphs
[TEXT_AREA
];
17880 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17883 if (!STRINGP (g
->object
))
17885 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17887 mindif
= eabs (g
->charpos
- charpos
);
17889 /* Exact match always wins. */
17896 else if (best_row
&& !row
->continued_p
)
17903 /* Try to redisplay window W by reusing its existing display. W's
17904 current matrix must be up to date when this function is called,
17905 i.e., window_end_valid must be true.
17909 >= 1 if successful, i.e. display has been updated
17911 1 means the changes were in front of a newline that precedes
17912 the window start, and the whole current matrix was reused
17913 2 means the changes were after the last position displayed
17914 in the window, and the whole current matrix was reused
17915 3 means portions of the current matrix were reused, while
17916 some of the screen lines were redrawn
17917 -1 if redisplay with same window start is known not to succeed
17918 0 if otherwise unsuccessful
17920 The following steps are performed:
17922 1. Find the last row in the current matrix of W that is not
17923 affected by changes at the start of current_buffer. If no such row
17926 2. Find the first row in W's current matrix that is not affected by
17927 changes at the end of current_buffer. Maybe there is no such row.
17929 3. Display lines beginning with the row + 1 found in step 1 to the
17930 row found in step 2 or, if step 2 didn't find a row, to the end of
17933 4. If cursor is not known to appear on the window, give up.
17935 5. If display stopped at the row found in step 2, scroll the
17936 display and current matrix as needed.
17938 6. Maybe display some lines at the end of W, if we must. This can
17939 happen under various circumstances, like a partially visible line
17940 becoming fully visible, or because newly displayed lines are displayed
17941 in smaller font sizes.
17943 7. Update W's window end information. */
17946 try_window_id (struct window
*w
)
17948 struct frame
*f
= XFRAME (w
->frame
);
17949 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17950 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17951 struct glyph_row
*last_unchanged_at_beg_row
;
17952 struct glyph_row
*first_unchanged_at_end_row
;
17953 struct glyph_row
*row
;
17954 struct glyph_row
*bottom_row
;
17957 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17959 struct text_pos start_pos
;
17961 int first_unchanged_at_end_vpos
= 0;
17962 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17963 struct text_pos start
;
17964 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17967 if (inhibit_try_window_id
)
17971 /* This is handy for debugging. */
17973 #define GIVE_UP(X) \
17975 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17979 #define GIVE_UP(X) return 0
17982 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17984 /* Don't use this for mini-windows because these can show
17985 messages and mini-buffers, and we don't handle that here. */
17986 if (MINI_WINDOW_P (w
))
17989 /* This flag is used to prevent redisplay optimizations. */
17990 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17993 /* This function's optimizations cannot be used if overlays have
17994 changed in the buffer displayed by the window, so give up if they
17996 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17999 /* Verify that narrowing has not changed.
18000 Also verify that we were not told to prevent redisplay optimizations.
18001 It would be nice to further
18002 reduce the number of cases where this prevents try_window_id. */
18003 if (current_buffer
->clip_changed
18004 || current_buffer
->prevent_redisplay_optimizations_p
)
18007 /* Window must either use window-based redisplay or be full width. */
18008 if (!FRAME_WINDOW_P (f
)
18009 && (!FRAME_LINE_INS_DEL_OK (f
)
18010 || !WINDOW_FULL_WIDTH_P (w
)))
18013 /* Give up if point is known NOT to appear in W. */
18014 if (PT
< CHARPOS (start
))
18017 /* Another way to prevent redisplay optimizations. */
18018 if (w
->last_modified
== 0)
18021 /* Verify that window is not hscrolled. */
18022 if (w
->hscroll
!= 0)
18025 /* Verify that display wasn't paused. */
18026 if (!w
->window_end_valid
)
18029 /* Likewise if highlighting trailing whitespace. */
18030 if (!NILP (Vshow_trailing_whitespace
))
18033 /* Can't use this if overlay arrow position and/or string have
18035 if (overlay_arrows_changed_p ())
18038 /* When word-wrap is on, adding a space to the first word of a
18039 wrapped line can change the wrap position, altering the line
18040 above it. It might be worthwhile to handle this more
18041 intelligently, but for now just redisplay from scratch. */
18042 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
18045 /* Under bidi reordering, adding or deleting a character in the
18046 beginning of a paragraph, before the first strong directional
18047 character, can change the base direction of the paragraph (unless
18048 the buffer specifies a fixed paragraph direction), which will
18049 require redisplaying the whole paragraph. It might be worthwhile
18050 to find the paragraph limits and widen the range of redisplayed
18051 lines to that, but for now just give up this optimization and
18052 redisplay from scratch. */
18053 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
18054 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
18057 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18058 to that variable require thorough redisplay. */
18059 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
18062 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18063 only if buffer has really changed. The reason is that the gap is
18064 initially at Z for freshly visited files. The code below would
18065 set end_unchanged to 0 in that case. */
18066 if (MODIFF
> SAVE_MODIFF
18067 /* This seems to happen sometimes after saving a buffer. */
18068 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
18070 if (GPT
- BEG
< BEG_UNCHANGED
)
18071 BEG_UNCHANGED
= GPT
- BEG
;
18072 if (Z
- GPT
< END_UNCHANGED
)
18073 END_UNCHANGED
= Z
- GPT
;
18076 /* The position of the first and last character that has been changed. */
18077 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
18078 last_changed_charpos
= Z
- END_UNCHANGED
;
18080 /* If window starts after a line end, and the last change is in
18081 front of that newline, then changes don't affect the display.
18082 This case happens with stealth-fontification. Note that although
18083 the display is unchanged, glyph positions in the matrix have to
18084 be adjusted, of course. */
18085 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
18086 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
18087 && ((last_changed_charpos
< CHARPOS (start
)
18088 && CHARPOS (start
) == BEGV
)
18089 || (last_changed_charpos
< CHARPOS (start
) - 1
18090 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
18092 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
18093 struct glyph_row
*r0
;
18095 /* Compute how many chars/bytes have been added to or removed
18096 from the buffer. */
18097 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
18098 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
18099 Z_delta
= Z
- Z_old
;
18100 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
18102 /* Give up if PT is not in the window. Note that it already has
18103 been checked at the start of try_window_id that PT is not in
18104 front of the window start. */
18105 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18108 /* If window start is unchanged, we can reuse the whole matrix
18109 as is, after adjusting glyph positions. No need to compute
18110 the window end again, since its offset from Z hasn't changed. */
18111 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18112 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18113 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18114 /* PT must not be in a partially visible line. */
18115 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18116 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18118 /* Adjust positions in the glyph matrix. */
18119 if (Z_delta
|| Z_delta_bytes
)
18121 struct glyph_row
*r1
18122 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18123 increment_matrix_positions (w
->current_matrix
,
18124 MATRIX_ROW_VPOS (r0
, current_matrix
),
18125 MATRIX_ROW_VPOS (r1
, current_matrix
),
18126 Z_delta
, Z_delta_bytes
);
18129 /* Set the cursor. */
18130 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18132 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18137 /* Handle the case that changes are all below what is displayed in
18138 the window, and that PT is in the window. This shortcut cannot
18139 be taken if ZV is visible in the window, and text has been added
18140 there that is visible in the window. */
18141 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18142 /* ZV is not visible in the window, or there are no
18143 changes at ZV, actually. */
18144 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18145 || first_changed_charpos
== last_changed_charpos
))
18147 struct glyph_row
*r0
;
18149 /* Give up if PT is not in the window. Note that it already has
18150 been checked at the start of try_window_id that PT is not in
18151 front of the window start. */
18152 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18155 /* If window start is unchanged, we can reuse the whole matrix
18156 as is, without changing glyph positions since no text has
18157 been added/removed in front of the window end. */
18158 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18159 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18160 /* PT must not be in a partially visible line. */
18161 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18162 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18164 /* We have to compute the window end anew since text
18165 could have been added/removed after it. */
18166 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18167 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18169 /* Set the cursor. */
18170 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18172 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18177 /* Give up if window start is in the changed area.
18179 The condition used to read
18181 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18183 but why that was tested escapes me at the moment. */
18184 if (CHARPOS (start
) >= first_changed_charpos
18185 && CHARPOS (start
) <= last_changed_charpos
)
18188 /* Check that window start agrees with the start of the first glyph
18189 row in its current matrix. Check this after we know the window
18190 start is not in changed text, otherwise positions would not be
18192 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18193 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18196 /* Give up if the window ends in strings. Overlay strings
18197 at the end are difficult to handle, so don't try. */
18198 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18199 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18202 /* Compute the position at which we have to start displaying new
18203 lines. Some of the lines at the top of the window might be
18204 reusable because they are not displaying changed text. Find the
18205 last row in W's current matrix not affected by changes at the
18206 start of current_buffer. Value is null if changes start in the
18207 first line of window. */
18208 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18209 if (last_unchanged_at_beg_row
)
18211 /* Avoid starting to display in the middle of a character, a TAB
18212 for instance. This is easier than to set up the iterator
18213 exactly, and it's not a frequent case, so the additional
18214 effort wouldn't really pay off. */
18215 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18216 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18217 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18218 --last_unchanged_at_beg_row
;
18220 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18223 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18225 start_pos
= it
.current
.pos
;
18227 /* Start displaying new lines in the desired matrix at the same
18228 vpos we would use in the current matrix, i.e. below
18229 last_unchanged_at_beg_row. */
18230 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18232 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18233 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18235 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18239 /* There are no reusable lines at the start of the window.
18240 Start displaying in the first text line. */
18241 start_display (&it
, w
, start
);
18242 it
.vpos
= it
.first_vpos
;
18243 start_pos
= it
.current
.pos
;
18246 /* Find the first row that is not affected by changes at the end of
18247 the buffer. Value will be null if there is no unchanged row, in
18248 which case we must redisplay to the end of the window. delta
18249 will be set to the value by which buffer positions beginning with
18250 first_unchanged_at_end_row have to be adjusted due to text
18252 first_unchanged_at_end_row
18253 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18254 IF_DEBUG (debug_delta
= delta
);
18255 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18257 /* Set stop_pos to the buffer position up to which we will have to
18258 display new lines. If first_unchanged_at_end_row != NULL, this
18259 is the buffer position of the start of the line displayed in that
18260 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18261 that we don't stop at a buffer position. */
18263 if (first_unchanged_at_end_row
)
18265 eassert (last_unchanged_at_beg_row
== NULL
18266 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18268 /* If this is a continuation line, move forward to the next one
18269 that isn't. Changes in lines above affect this line.
18270 Caution: this may move first_unchanged_at_end_row to a row
18271 not displaying text. */
18272 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18273 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18274 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18275 < it
.last_visible_y
))
18276 ++first_unchanged_at_end_row
;
18278 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18279 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18280 >= it
.last_visible_y
))
18281 first_unchanged_at_end_row
= NULL
;
18284 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18286 first_unchanged_at_end_vpos
18287 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18288 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18291 else if (last_unchanged_at_beg_row
== NULL
)
18297 /* Either there is no unchanged row at the end, or the one we have
18298 now displays text. This is a necessary condition for the window
18299 end pos calculation at the end of this function. */
18300 eassert (first_unchanged_at_end_row
== NULL
18301 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18303 debug_last_unchanged_at_beg_vpos
18304 = (last_unchanged_at_beg_row
18305 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18307 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18309 #endif /* GLYPH_DEBUG */
18312 /* Display new lines. Set last_text_row to the last new line
18313 displayed which has text on it, i.e. might end up as being the
18314 line where the window_end_vpos is. */
18315 w
->cursor
.vpos
= -1;
18316 last_text_row
= NULL
;
18317 overlay_arrow_seen
= false;
18318 if (it
.current_y
< it
.last_visible_y
18319 && !f
->fonts_changed
18320 && (first_unchanged_at_end_row
== NULL
18321 || IT_CHARPOS (it
) < stop_pos
))
18322 it
.glyph_row
->reversed_p
= false;
18323 while (it
.current_y
< it
.last_visible_y
18324 && !f
->fonts_changed
18325 && (first_unchanged_at_end_row
== NULL
18326 || IT_CHARPOS (it
) < stop_pos
))
18328 if (display_line (&it
))
18329 last_text_row
= it
.glyph_row
- 1;
18332 if (f
->fonts_changed
)
18335 /* The redisplay iterations in display_line above could have
18336 triggered font-lock, which could have done something that
18337 invalidates IT->w window's end-point information, on which we
18338 rely below. E.g., one package, which will remain unnamed, used
18339 to install a font-lock-fontify-region-function that called
18340 bury-buffer, whose side effect is to switch the buffer displayed
18341 by IT->w, and that predictably resets IT->w's window_end_valid
18342 flag, which we already tested at the entry to this function.
18343 Amply punish such packages/modes by giving up on this
18344 optimization in those cases. */
18345 if (!w
->window_end_valid
)
18347 clear_glyph_matrix (w
->desired_matrix
);
18351 /* Compute differences in buffer positions, y-positions etc. for
18352 lines reused at the bottom of the window. Compute what we can
18354 if (first_unchanged_at_end_row
18355 /* No lines reused because we displayed everything up to the
18356 bottom of the window. */
18357 && it
.current_y
< it
.last_visible_y
)
18360 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18362 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18363 run
.current_y
= first_unchanged_at_end_row
->y
;
18364 run
.desired_y
= run
.current_y
+ dy
;
18365 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18369 delta
= delta_bytes
= dvpos
= dy
18370 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18371 first_unchanged_at_end_row
= NULL
;
18373 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18376 /* Find the cursor if not already found. We have to decide whether
18377 PT will appear on this window (it sometimes doesn't, but this is
18378 not a very frequent case.) This decision has to be made before
18379 the current matrix is altered. A value of cursor.vpos < 0 means
18380 that PT is either in one of the lines beginning at
18381 first_unchanged_at_end_row or below the window. Don't care for
18382 lines that might be displayed later at the window end; as
18383 mentioned, this is not a frequent case. */
18384 if (w
->cursor
.vpos
< 0)
18386 /* Cursor in unchanged rows at the top? */
18387 if (PT
< CHARPOS (start_pos
)
18388 && last_unchanged_at_beg_row
)
18390 row
= row_containing_pos (w
, PT
,
18391 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18392 last_unchanged_at_beg_row
+ 1, 0);
18394 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18397 /* Start from first_unchanged_at_end_row looking for PT. */
18398 else if (first_unchanged_at_end_row
)
18400 row
= row_containing_pos (w
, PT
- delta
,
18401 first_unchanged_at_end_row
, NULL
, 0);
18403 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18404 delta_bytes
, dy
, dvpos
);
18407 /* Give up if cursor was not found. */
18408 if (w
->cursor
.vpos
< 0)
18410 clear_glyph_matrix (w
->desired_matrix
);
18415 /* Don't let the cursor end in the scroll margins. */
18417 int this_scroll_margin
, cursor_height
;
18418 int frame_line_height
= default_line_pixel_height (w
);
18419 int window_total_lines
18420 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18422 this_scroll_margin
=
18423 max (0, min (scroll_margin
, window_total_lines
/ 4));
18424 this_scroll_margin
*= frame_line_height
;
18425 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18427 if ((w
->cursor
.y
< this_scroll_margin
18428 && CHARPOS (start
) > BEGV
)
18429 /* Old redisplay didn't take scroll margin into account at the bottom,
18430 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18431 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18432 ? cursor_height
+ this_scroll_margin
18433 : 1)) > it
.last_visible_y
)
18435 w
->cursor
.vpos
= -1;
18436 clear_glyph_matrix (w
->desired_matrix
);
18441 /* Scroll the display. Do it before changing the current matrix so
18442 that xterm.c doesn't get confused about where the cursor glyph is
18444 if (dy
&& run
.height
)
18448 if (FRAME_WINDOW_P (f
))
18450 FRAME_RIF (f
)->update_window_begin_hook (w
);
18451 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18452 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18453 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18457 /* Terminal frame. In this case, dvpos gives the number of
18458 lines to scroll by; dvpos < 0 means scroll up. */
18460 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18461 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18462 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18463 + WINDOW_WANTS_HEADER_LINE_P (w
)
18464 + window_internal_height (w
));
18466 #if defined (HAVE_GPM) || defined (MSDOS)
18467 x_clear_window_mouse_face (w
);
18469 /* Perform the operation on the screen. */
18472 /* Scroll last_unchanged_at_beg_row to the end of the
18473 window down dvpos lines. */
18474 set_terminal_window (f
, end
);
18476 /* On dumb terminals delete dvpos lines at the end
18477 before inserting dvpos empty lines. */
18478 if (!FRAME_SCROLL_REGION_OK (f
))
18479 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18481 /* Insert dvpos empty lines in front of
18482 last_unchanged_at_beg_row. */
18483 ins_del_lines (f
, from
, dvpos
);
18485 else if (dvpos
< 0)
18487 /* Scroll up last_unchanged_at_beg_vpos to the end of
18488 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18489 set_terminal_window (f
, end
);
18491 /* Delete dvpos lines in front of
18492 last_unchanged_at_beg_vpos. ins_del_lines will set
18493 the cursor to the given vpos and emit |dvpos| delete
18495 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18497 /* On a dumb terminal insert dvpos empty lines at the
18499 if (!FRAME_SCROLL_REGION_OK (f
))
18500 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18503 set_terminal_window (f
, 0);
18509 /* Shift reused rows of the current matrix to the right position.
18510 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18512 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18513 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18516 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18517 bottom_vpos
, dvpos
);
18518 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18521 else if (dvpos
> 0)
18523 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18524 bottom_vpos
, dvpos
);
18525 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18526 first_unchanged_at_end_vpos
+ dvpos
);
18529 /* For frame-based redisplay, make sure that current frame and window
18530 matrix are in sync with respect to glyph memory. */
18531 if (!FRAME_WINDOW_P (f
))
18532 sync_frame_with_window_matrix_rows (w
);
18534 /* Adjust buffer positions in reused rows. */
18535 if (delta
|| delta_bytes
)
18536 increment_matrix_positions (current_matrix
,
18537 first_unchanged_at_end_vpos
+ dvpos
,
18538 bottom_vpos
, delta
, delta_bytes
);
18540 /* Adjust Y positions. */
18542 shift_glyph_matrix (w
, current_matrix
,
18543 first_unchanged_at_end_vpos
+ dvpos
,
18546 if (first_unchanged_at_end_row
)
18548 first_unchanged_at_end_row
+= dvpos
;
18549 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18550 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18551 first_unchanged_at_end_row
= NULL
;
18554 /* If scrolling up, there may be some lines to display at the end of
18556 last_text_row_at_end
= NULL
;
18559 /* Scrolling up can leave for example a partially visible line
18560 at the end of the window to be redisplayed. */
18561 /* Set last_row to the glyph row in the current matrix where the
18562 window end line is found. It has been moved up or down in
18563 the matrix by dvpos. */
18564 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18565 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18567 /* If last_row is the window end line, it should display text. */
18568 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18570 /* If window end line was partially visible before, begin
18571 displaying at that line. Otherwise begin displaying with the
18572 line following it. */
18573 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18575 init_to_row_start (&it
, w
, last_row
);
18576 it
.vpos
= last_vpos
;
18577 it
.current_y
= last_row
->y
;
18581 init_to_row_end (&it
, w
, last_row
);
18582 it
.vpos
= 1 + last_vpos
;
18583 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18587 /* We may start in a continuation line. If so, we have to
18588 get the right continuation_lines_width and current_x. */
18589 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18590 it
.hpos
= it
.current_x
= 0;
18592 /* Display the rest of the lines at the window end. */
18593 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18594 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18596 /* Is it always sure that the display agrees with lines in
18597 the current matrix? I don't think so, so we mark rows
18598 displayed invalid in the current matrix by setting their
18599 enabled_p flag to false. */
18600 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18601 if (display_line (&it
))
18602 last_text_row_at_end
= it
.glyph_row
- 1;
18606 /* Update window_end_pos and window_end_vpos. */
18607 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18609 /* Window end line if one of the preserved rows from the current
18610 matrix. Set row to the last row displaying text in current
18611 matrix starting at first_unchanged_at_end_row, after
18613 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18614 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18615 first_unchanged_at_end_row
);
18616 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18617 adjust_window_ends (w
, row
, true);
18618 eassert (w
->window_end_bytepos
>= 0);
18619 IF_DEBUG (debug_method_add (w
, "A"));
18621 else if (last_text_row_at_end
)
18623 adjust_window_ends (w
, last_text_row_at_end
, false);
18624 eassert (w
->window_end_bytepos
>= 0);
18625 IF_DEBUG (debug_method_add (w
, "B"));
18627 else if (last_text_row
)
18629 /* We have displayed either to the end of the window or at the
18630 end of the window, i.e. the last row with text is to be found
18631 in the desired matrix. */
18632 adjust_window_ends (w
, last_text_row
, false);
18633 eassert (w
->window_end_bytepos
>= 0);
18635 else if (first_unchanged_at_end_row
== NULL
18636 && last_text_row
== NULL
18637 && last_text_row_at_end
== NULL
)
18639 /* Displayed to end of window, but no line containing text was
18640 displayed. Lines were deleted at the end of the window. */
18641 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18642 int vpos
= w
->window_end_vpos
;
18643 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18644 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18647 row
== NULL
&& vpos
>= first_vpos
;
18648 --vpos
, --current_row
, --desired_row
)
18650 if (desired_row
->enabled_p
)
18652 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18655 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18659 eassert (row
!= NULL
);
18660 w
->window_end_vpos
= vpos
+ 1;
18661 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18662 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18663 eassert (w
->window_end_bytepos
>= 0);
18664 IF_DEBUG (debug_method_add (w
, "C"));
18669 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18670 debug_end_vpos
= w
->window_end_vpos
));
18672 /* Record that display has not been completed. */
18673 w
->window_end_valid
= false;
18674 w
->desired_matrix
->no_scrolling_p
= true;
18682 /***********************************************************************
18683 More debugging support
18684 ***********************************************************************/
18688 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18689 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18690 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18693 /* Dump the contents of glyph matrix MATRIX on stderr.
18695 GLYPHS 0 means don't show glyph contents.
18696 GLYPHS 1 means show glyphs in short form
18697 GLYPHS > 1 means show glyphs in long form. */
18700 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18703 for (i
= 0; i
< matrix
->nrows
; ++i
)
18704 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18708 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18709 the glyph row and area where the glyph comes from. */
18712 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18714 if (glyph
->type
== CHAR_GLYPH
18715 || glyph
->type
== GLYPHLESS_GLYPH
)
18718 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18719 glyph
- row
->glyphs
[TEXT_AREA
],
18720 (glyph
->type
== CHAR_GLYPH
18724 (BUFFERP (glyph
->object
)
18726 : (STRINGP (glyph
->object
)
18728 : (NILP (glyph
->object
)
18731 glyph
->pixel_width
,
18733 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18737 glyph
->left_box_line_p
,
18738 glyph
->right_box_line_p
);
18740 else if (glyph
->type
== STRETCH_GLYPH
)
18743 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18744 glyph
- row
->glyphs
[TEXT_AREA
],
18747 (BUFFERP (glyph
->object
)
18749 : (STRINGP (glyph
->object
)
18751 : (NILP (glyph
->object
)
18754 glyph
->pixel_width
,
18758 glyph
->left_box_line_p
,
18759 glyph
->right_box_line_p
);
18761 else if (glyph
->type
== IMAGE_GLYPH
)
18764 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18765 glyph
- row
->glyphs
[TEXT_AREA
],
18768 (BUFFERP (glyph
->object
)
18770 : (STRINGP (glyph
->object
)
18772 : (NILP (glyph
->object
)
18775 glyph
->pixel_width
,
18779 glyph
->left_box_line_p
,
18780 glyph
->right_box_line_p
);
18782 else if (glyph
->type
== COMPOSITE_GLYPH
)
18785 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18786 glyph
- row
->glyphs
[TEXT_AREA
],
18789 (BUFFERP (glyph
->object
)
18791 : (STRINGP (glyph
->object
)
18793 : (NILP (glyph
->object
)
18796 glyph
->pixel_width
,
18798 if (glyph
->u
.cmp
.automatic
)
18801 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18802 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18804 glyph
->left_box_line_p
,
18805 glyph
->right_box_line_p
);
18807 else if (glyph
->type
== XWIDGET_GLYPH
)
18809 #ifndef HAVE_XWIDGETS
18813 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18814 glyph
- row
->glyphs
[TEXT_AREA
],
18817 (BUFFERP (glyph
->object
)
18819 : (STRINGP (glyph
->object
)
18822 glyph
->pixel_width
,
18826 glyph
->left_box_line_p
,
18827 glyph
->right_box_line_p
);
18833 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18834 GLYPHS 0 means don't show glyph contents.
18835 GLYPHS 1 means show glyphs in short form
18836 GLYPHS > 1 means show glyphs in long form. */
18839 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18843 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18844 fprintf (stderr
, "==============================================================================\n");
18846 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18847 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18849 MATRIX_ROW_START_CHARPOS (row
),
18850 MATRIX_ROW_END_CHARPOS (row
),
18851 row
->used
[TEXT_AREA
],
18852 row
->contains_overlapping_glyphs_p
,
18854 row
->truncated_on_left_p
,
18855 row
->truncated_on_right_p
,
18857 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18858 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18861 row
->ends_in_middle_of_char_p
,
18862 row
->starts_in_middle_of_char_p
,
18868 row
->visible_height
,
18871 /* The next 3 lines should align to "Start" in the header. */
18872 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18873 row
->end
.overlay_string_index
,
18874 row
->continuation_lines_width
);
18875 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18876 CHARPOS (row
->start
.string_pos
),
18877 CHARPOS (row
->end
.string_pos
));
18878 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18879 row
->end
.dpvec_index
);
18886 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18888 struct glyph
*glyph
= row
->glyphs
[area
];
18889 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18891 /* Glyph for a line end in text. */
18892 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18895 if (glyph
< glyph_end
)
18896 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18898 for (; glyph
< glyph_end
; ++glyph
)
18899 dump_glyph (row
, glyph
, area
);
18902 else if (glyphs
== 1)
18905 char s
[SHRT_MAX
+ 4];
18907 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18911 for (i
= 0; i
< row
->used
[area
]; ++i
)
18913 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18914 if (i
== row
->used
[area
] - 1
18915 && area
== TEXT_AREA
18916 && NILP (glyph
->object
)
18917 && glyph
->type
== CHAR_GLYPH
18918 && glyph
->u
.ch
== ' ')
18920 strcpy (&s
[i
], "[\\n]");
18923 else if (glyph
->type
== CHAR_GLYPH
18924 && glyph
->u
.ch
< 0x80
18925 && glyph
->u
.ch
>= ' ')
18926 s
[i
] = glyph
->u
.ch
;
18932 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18938 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18939 Sdump_glyph_matrix
, 0, 1, "p",
18940 doc
: /* Dump the current matrix of the selected window to stderr.
18941 Shows contents of glyph row structures. With non-nil
18942 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18943 glyphs in short form, otherwise show glyphs in long form.
18945 Interactively, no argument means show glyphs in short form;
18946 with numeric argument, its value is passed as the GLYPHS flag. */)
18947 (Lisp_Object glyphs
)
18949 struct window
*w
= XWINDOW (selected_window
);
18950 struct buffer
*buffer
= XBUFFER (w
->contents
);
18952 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18953 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18954 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18955 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18956 fprintf (stderr
, "=============================================\n");
18957 dump_glyph_matrix (w
->current_matrix
,
18958 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18963 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18964 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18965 Only text-mode frames have frame glyph matrices. */)
18968 struct frame
*f
= XFRAME (selected_frame
);
18970 if (f
->current_matrix
)
18971 dump_glyph_matrix (f
->current_matrix
, 1);
18973 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18978 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18979 doc
: /* Dump glyph row ROW to stderr.
18980 GLYPH 0 means don't dump glyphs.
18981 GLYPH 1 means dump glyphs in short form.
18982 GLYPH > 1 or omitted means dump glyphs in long form. */)
18983 (Lisp_Object row
, Lisp_Object glyphs
)
18985 struct glyph_matrix
*matrix
;
18988 CHECK_NUMBER (row
);
18989 matrix
= XWINDOW (selected_window
)->current_matrix
;
18991 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18992 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18994 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18999 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
19000 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19001 GLYPH 0 means don't dump glyphs.
19002 GLYPH 1 means dump glyphs in short form.
19003 GLYPH > 1 or omitted means dump glyphs in long form.
19005 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19007 (Lisp_Object row
, Lisp_Object glyphs
)
19009 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19010 struct frame
*sf
= SELECTED_FRAME ();
19011 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
19014 CHECK_NUMBER (row
);
19016 if (vpos
>= 0 && vpos
< m
->nrows
)
19017 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
19018 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
19024 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
19025 doc
: /* Toggle tracing of redisplay.
19026 With ARG, turn tracing on if and only if ARG is positive. */)
19030 trace_redisplay_p
= !trace_redisplay_p
;
19033 arg
= Fprefix_numeric_value (arg
);
19034 trace_redisplay_p
= XINT (arg
) > 0;
19041 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
19042 doc
: /* Like `format', but print result to stderr.
19043 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19044 (ptrdiff_t nargs
, Lisp_Object
*args
)
19046 Lisp_Object s
= Fformat (nargs
, args
);
19047 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
19051 #endif /* GLYPH_DEBUG */
19055 /***********************************************************************
19056 Building Desired Matrix Rows
19057 ***********************************************************************/
19059 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19060 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19062 static struct glyph_row
*
19063 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
19065 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19066 struct buffer
*buffer
= XBUFFER (w
->contents
);
19067 struct buffer
*old
= current_buffer
;
19068 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
19069 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
19070 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
19071 const unsigned char *p
;
19074 int n_glyphs_before
;
19076 set_buffer_temp (buffer
);
19077 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
19078 scratch_glyph_row
.reversed_p
= false;
19079 it
.glyph_row
->used
[TEXT_AREA
] = 0;
19080 SET_TEXT_POS (it
.position
, 0, 0);
19082 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
19084 while (p
< arrow_end
)
19086 Lisp_Object face
, ilisp
;
19088 /* Get the next character. */
19090 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
19093 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
19094 if (! ASCII_CHAR_P (it
.c
))
19095 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
19099 /* Get its face. */
19100 ilisp
= make_number (p
- arrow_string
);
19101 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
19102 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
19104 /* Compute its width, get its glyphs. */
19105 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
19106 SET_TEXT_POS (it
.position
, -1, -1);
19107 PRODUCE_GLYPHS (&it
);
19109 /* If this character doesn't fit any more in the line, we have
19110 to remove some glyphs. */
19111 if (it
.current_x
> it
.last_visible_x
)
19113 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19118 set_buffer_temp (old
);
19119 return it
.glyph_row
;
19123 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19124 glyphs to insert is determined by produce_special_glyphs. */
19127 insert_left_trunc_glyphs (struct it
*it
)
19129 struct it truncate_it
;
19130 struct glyph
*from
, *end
, *to
, *toend
;
19132 eassert (!FRAME_WINDOW_P (it
->f
)
19133 || (!it
->glyph_row
->reversed_p
19134 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19135 || (it
->glyph_row
->reversed_p
19136 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
19138 /* Get the truncation glyphs. */
19140 truncate_it
.current_x
= 0;
19141 truncate_it
.face_id
= DEFAULT_FACE_ID
;
19142 truncate_it
.glyph_row
= &scratch_glyph_row
;
19143 truncate_it
.area
= TEXT_AREA
;
19144 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
19145 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
19146 truncate_it
.object
= Qnil
;
19147 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
19149 /* Overwrite glyphs from IT with truncation glyphs. */
19150 if (!it
->glyph_row
->reversed_p
)
19152 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19154 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19155 end
= from
+ tused
;
19156 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19157 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19158 if (FRAME_WINDOW_P (it
->f
))
19160 /* On GUI frames, when variable-size fonts are displayed,
19161 the truncation glyphs may need more pixels than the row's
19162 glyphs they overwrite. We overwrite more glyphs to free
19163 enough screen real estate, and enlarge the stretch glyph
19164 on the right (see display_line), if there is one, to
19165 preserve the screen position of the truncation glyphs on
19168 struct glyph
*g
= to
;
19171 /* The first glyph could be partially visible, in which case
19172 it->glyph_row->x will be negative. But we want the left
19173 truncation glyphs to be aligned at the left margin of the
19174 window, so we override the x coordinate at which the row
19176 it
->glyph_row
->x
= 0;
19177 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19179 w
+= g
->pixel_width
;
19182 if (g
- to
- tused
> 0)
19184 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19185 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19187 used
= it
->glyph_row
->used
[TEXT_AREA
];
19188 if (it
->glyph_row
->truncated_on_right_p
19189 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19190 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19193 int extra
= w
- it
->truncation_pixel_width
;
19195 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19202 /* There may be padding glyphs left over. Overwrite them too. */
19203 if (!FRAME_WINDOW_P (it
->f
))
19205 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19207 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19214 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19218 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19220 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19221 that back to front. */
19222 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19223 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19224 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19225 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19226 if (FRAME_WINDOW_P (it
->f
))
19229 struct glyph
*g
= to
;
19231 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19233 w
+= g
->pixel_width
;
19236 if (to
- g
- tused
> 0)
19238 if (it
->glyph_row
->truncated_on_right_p
19239 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19240 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19242 int extra
= w
- it
->truncation_pixel_width
;
19244 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19248 while (from
>= end
&& to
>= toend
)
19250 if (!FRAME_WINDOW_P (it
->f
))
19252 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19255 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19256 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19257 while (from
>= end
&& to
>= toend
)
19263 /* Need to free some room before prepending additional
19265 int move_by
= from
- end
+ 1;
19266 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19267 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19269 for ( ; g
>= g0
; g
--)
19271 while (from
>= end
)
19273 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19278 /* Compute the hash code for ROW. */
19280 row_hash (struct glyph_row
*row
)
19283 unsigned hashval
= 0;
19285 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19286 for (k
= 0; k
< row
->used
[area
]; ++k
)
19287 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19288 + row
->glyphs
[area
][k
].u
.val
19289 + row
->glyphs
[area
][k
].face_id
19290 + row
->glyphs
[area
][k
].padding_p
19291 + (row
->glyphs
[area
][k
].type
<< 2));
19296 /* Compute the pixel height and width of IT->glyph_row.
19298 Most of the time, ascent and height of a display line will be equal
19299 to the max_ascent and max_height values of the display iterator
19300 structure. This is not the case if
19302 1. We hit ZV without displaying anything. In this case, max_ascent
19303 and max_height will be zero.
19305 2. We have some glyphs that don't contribute to the line height.
19306 (The glyph row flag contributes_to_line_height_p is for future
19307 pixmap extensions).
19309 The first case is easily covered by using default values because in
19310 these cases, the line height does not really matter, except that it
19311 must not be zero. */
19314 compute_line_metrics (struct it
*it
)
19316 struct glyph_row
*row
= it
->glyph_row
;
19318 if (FRAME_WINDOW_P (it
->f
))
19320 int i
, min_y
, max_y
;
19322 /* The line may consist of one space only, that was added to
19323 place the cursor on it. If so, the row's height hasn't been
19325 if (row
->height
== 0)
19327 if (it
->max_ascent
+ it
->max_descent
== 0)
19328 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19329 row
->ascent
= it
->max_ascent
;
19330 row
->height
= it
->max_ascent
+ it
->max_descent
;
19331 row
->phys_ascent
= it
->max_phys_ascent
;
19332 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19333 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19336 /* Compute the width of this line. */
19337 row
->pixel_width
= row
->x
;
19338 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19339 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19341 eassert (row
->pixel_width
>= 0);
19342 eassert (row
->ascent
>= 0 && row
->height
> 0);
19344 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19345 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19347 /* If first line's physical ascent is larger than its logical
19348 ascent, use the physical ascent, and make the row taller.
19349 This makes accented characters fully visible. */
19350 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19351 && row
->phys_ascent
> row
->ascent
)
19353 row
->height
+= row
->phys_ascent
- row
->ascent
;
19354 row
->ascent
= row
->phys_ascent
;
19357 /* Compute how much of the line is visible. */
19358 row
->visible_height
= row
->height
;
19360 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19361 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19363 if (row
->y
< min_y
)
19364 row
->visible_height
-= min_y
- row
->y
;
19365 if (row
->y
+ row
->height
> max_y
)
19366 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19370 row
->pixel_width
= row
->used
[TEXT_AREA
];
19371 if (row
->continued_p
)
19372 row
->pixel_width
-= it
->continuation_pixel_width
;
19373 else if (row
->truncated_on_right_p
)
19374 row
->pixel_width
-= it
->truncation_pixel_width
;
19375 row
->ascent
= row
->phys_ascent
= 0;
19376 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19377 row
->extra_line_spacing
= 0;
19380 /* Compute a hash code for this row. */
19381 row
->hash
= row_hash (row
);
19383 it
->max_ascent
= it
->max_descent
= 0;
19384 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19388 /* Append one space to the glyph row of iterator IT if doing a
19389 window-based redisplay. The space has the same face as
19390 IT->face_id. Value is true if a space was added.
19392 This function is called to make sure that there is always one glyph
19393 at the end of a glyph row that the cursor can be set on under
19394 window-systems. (If there weren't such a glyph we would not know
19395 how wide and tall a box cursor should be displayed).
19397 At the same time this space let's a nicely handle clearing to the
19398 end of the line if the row ends in italic text. */
19401 append_space_for_newline (struct it
*it
, bool default_face_p
)
19403 if (FRAME_WINDOW_P (it
->f
))
19405 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19407 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19408 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19410 /* Save some values that must not be changed.
19411 Must save IT->c and IT->len because otherwise
19412 ITERATOR_AT_END_P wouldn't work anymore after
19413 append_space_for_newline has been called. */
19414 enum display_element_type saved_what
= it
->what
;
19415 int saved_c
= it
->c
, saved_len
= it
->len
;
19416 int saved_char_to_display
= it
->char_to_display
;
19417 int saved_x
= it
->current_x
;
19418 int saved_face_id
= it
->face_id
;
19419 bool saved_box_end
= it
->end_of_box_run_p
;
19420 struct text_pos saved_pos
;
19421 Lisp_Object saved_object
;
19425 saved_object
= it
->object
;
19426 saved_pos
= it
->position
;
19428 it
->what
= IT_CHARACTER
;
19429 memset (&it
->position
, 0, sizeof it
->position
);
19431 it
->c
= it
->char_to_display
= ' ';
19434 /* If the default face was remapped, be sure to use the
19435 remapped face for the appended newline. */
19436 if (default_face_p
)
19437 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19438 else if (it
->face_before_selective_p
)
19439 it
->face_id
= it
->saved_face_id
;
19440 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19441 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19442 /* In R2L rows, we will prepend a stretch glyph that will
19443 have the end_of_box_run_p flag set for it, so there's no
19444 need for the appended newline glyph to have that flag
19446 if (it
->glyph_row
->reversed_p
19447 /* But if the appended newline glyph goes all the way to
19448 the end of the row, there will be no stretch glyph,
19449 so leave the box flag set. */
19450 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19451 it
->end_of_box_run_p
= false;
19453 PRODUCE_GLYPHS (it
);
19455 #ifdef HAVE_WINDOW_SYSTEM
19456 /* Make sure this space glyph has the right ascent and
19457 descent values, or else cursor at end of line will look
19458 funny, and height of empty lines will be incorrect. */
19459 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19460 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19463 Lisp_Object height
, total_height
;
19464 int extra_line_spacing
= it
->extra_line_spacing
;
19465 int boff
= font
->baseline_offset
;
19467 if (font
->vertical_centering
)
19468 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19470 it
->object
= saved_object
; /* get_it_property needs this */
19471 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19472 /* Must do a subset of line height processing from
19473 x_produce_glyph for newline characters. */
19474 height
= get_it_property (it
, Qline_height
);
19476 && CONSP (XCDR (height
))
19477 && NILP (XCDR (XCDR (height
))))
19479 total_height
= XCAR (XCDR (height
));
19480 height
= XCAR (height
);
19483 total_height
= Qnil
;
19484 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19486 if (it
->override_ascent
>= 0)
19488 it
->ascent
= it
->override_ascent
;
19489 it
->descent
= it
->override_descent
;
19490 boff
= it
->override_boff
;
19492 if (EQ (height
, Qt
))
19493 extra_line_spacing
= 0;
19496 Lisp_Object spacing
;
19498 it
->phys_ascent
= it
->ascent
;
19499 it
->phys_descent
= it
->descent
;
19501 && XINT (height
) > it
->ascent
+ it
->descent
)
19502 it
->ascent
= XINT (height
) - it
->descent
;
19504 if (!NILP (total_height
))
19505 spacing
= calc_line_height_property (it
, total_height
, font
,
19509 spacing
= get_it_property (it
, Qline_spacing
);
19510 spacing
= calc_line_height_property (it
, spacing
, font
,
19513 if (INTEGERP (spacing
))
19515 extra_line_spacing
= XINT (spacing
);
19516 if (!NILP (total_height
))
19517 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19520 if (extra_line_spacing
> 0)
19522 it
->descent
+= extra_line_spacing
;
19523 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19524 it
->max_extra_line_spacing
= extra_line_spacing
;
19526 it
->max_ascent
= it
->ascent
;
19527 it
->max_descent
= it
->descent
;
19528 /* Make sure compute_line_metrics recomputes the row height. */
19529 it
->glyph_row
->height
= 0;
19532 g
->ascent
= it
->max_ascent
;
19533 g
->descent
= it
->max_descent
;
19536 it
->override_ascent
= -1;
19537 it
->constrain_row_ascent_descent_p
= false;
19538 it
->current_x
= saved_x
;
19539 it
->object
= saved_object
;
19540 it
->position
= saved_pos
;
19541 it
->what
= saved_what
;
19542 it
->face_id
= saved_face_id
;
19543 it
->len
= saved_len
;
19545 it
->char_to_display
= saved_char_to_display
;
19546 it
->end_of_box_run_p
= saved_box_end
;
19555 /* Extend the face of the last glyph in the text area of IT->glyph_row
19556 to the end of the display line. Called from display_line. If the
19557 glyph row is empty, add a space glyph to it so that we know the
19558 face to draw. Set the glyph row flag fill_line_p. If the glyph
19559 row is R2L, prepend a stretch glyph to cover the empty space to the
19560 left of the leftmost glyph. */
19563 extend_face_to_end_of_line (struct it
*it
)
19565 struct face
*face
, *default_face
;
19566 struct frame
*f
= it
->f
;
19568 /* If line is already filled, do nothing. Non window-system frames
19569 get a grace of one more ``pixel'' because their characters are
19570 1-``pixel'' wide, so they hit the equality too early. This grace
19571 is needed only for R2L rows that are not continued, to produce
19572 one extra blank where we could display the cursor. */
19573 if ((it
->current_x
>= it
->last_visible_x
19574 + (!FRAME_WINDOW_P (f
)
19575 && it
->glyph_row
->reversed_p
19576 && !it
->glyph_row
->continued_p
))
19577 /* If the window has display margins, we will need to extend
19578 their face even if the text area is filled. */
19579 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19580 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19583 /* The default face, possibly remapped. */
19584 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19586 /* Face extension extends the background and box of IT->face_id
19587 to the end of the line. If the background equals the background
19588 of the frame, we don't have to do anything. */
19589 if (it
->face_before_selective_p
)
19590 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19592 face
= FACE_FROM_ID (f
, it
->face_id
);
19594 if (FRAME_WINDOW_P (f
)
19595 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19596 && face
->box
== FACE_NO_BOX
19597 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19598 #ifdef HAVE_WINDOW_SYSTEM
19601 && !it
->glyph_row
->reversed_p
)
19604 /* Set the glyph row flag indicating that the face of the last glyph
19605 in the text area has to be drawn to the end of the text area. */
19606 it
->glyph_row
->fill_line_p
= true;
19608 /* If current character of IT is not ASCII, make sure we have the
19609 ASCII face. This will be automatically undone the next time
19610 get_next_display_element returns a multibyte character. Note
19611 that the character will always be single byte in unibyte
19613 if (!ASCII_CHAR_P (it
->c
))
19615 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19618 if (FRAME_WINDOW_P (f
))
19620 /* If the row is empty, add a space with the current face of IT,
19621 so that we know which face to draw. */
19622 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19624 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19625 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19626 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19628 /* Mode line and the header line don't have margins, and
19629 likewise the frame's tool-bar window, if there is any. */
19630 if (!(it
->glyph_row
->mode_line_p
19631 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19632 || (WINDOWP (f
->tool_bar_window
)
19633 && it
->w
== XWINDOW (f
->tool_bar_window
))
19637 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19638 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19640 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19641 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19643 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19645 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19646 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19648 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19649 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19651 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19654 #ifdef HAVE_WINDOW_SYSTEM
19655 if (it
->glyph_row
->reversed_p
)
19657 /* Prepend a stretch glyph to the row, such that the
19658 rightmost glyph will be drawn flushed all the way to the
19659 right margin of the window. The stretch glyph that will
19660 occupy the empty space, if any, to the left of the
19662 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19663 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19664 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19666 int row_width
, stretch_ascent
, stretch_width
;
19667 struct text_pos saved_pos
;
19669 bool saved_avoid_cursor
, saved_box_start
;
19671 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19672 row_width
+= g
->pixel_width
;
19674 /* FIXME: There are various minor display glitches in R2L
19675 rows when only one of the fringes is missing. The
19676 strange condition below produces the least bad effect. */
19677 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19678 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19679 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19680 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19682 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19683 stretch_width
-= row_width
;
19685 if (stretch_width
> 0)
19688 (((it
->ascent
+ it
->descent
)
19689 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19690 saved_pos
= it
->position
;
19691 memset (&it
->position
, 0, sizeof it
->position
);
19692 saved_avoid_cursor
= it
->avoid_cursor_p
;
19693 it
->avoid_cursor_p
= true;
19694 saved_face_id
= it
->face_id
;
19695 saved_box_start
= it
->start_of_box_run_p
;
19696 /* The last row's stretch glyph should get the default
19697 face, to avoid painting the rest of the window with
19698 the region face, if the region ends at ZV. */
19699 if (it
->glyph_row
->ends_at_zv_p
)
19700 it
->face_id
= default_face
->id
;
19702 it
->face_id
= face
->id
;
19703 it
->start_of_box_run_p
= false;
19704 append_stretch_glyph (it
, Qnil
, stretch_width
,
19705 it
->ascent
+ it
->descent
, stretch_ascent
);
19706 it
->position
= saved_pos
;
19707 it
->avoid_cursor_p
= saved_avoid_cursor
;
19708 it
->face_id
= saved_face_id
;
19709 it
->start_of_box_run_p
= saved_box_start
;
19711 /* If stretch_width comes out negative, it means that the
19712 last glyph is only partially visible. In R2L rows, we
19713 want the leftmost glyph to be partially visible, so we
19714 need to give the row the corresponding left offset. */
19715 if (stretch_width
< 0)
19716 it
->glyph_row
->x
= stretch_width
;
19718 #endif /* HAVE_WINDOW_SYSTEM */
19722 /* Save some values that must not be changed. */
19723 int saved_x
= it
->current_x
;
19724 struct text_pos saved_pos
;
19725 Lisp_Object saved_object
;
19726 enum display_element_type saved_what
= it
->what
;
19727 int saved_face_id
= it
->face_id
;
19729 saved_object
= it
->object
;
19730 saved_pos
= it
->position
;
19732 it
->what
= IT_CHARACTER
;
19733 memset (&it
->position
, 0, sizeof it
->position
);
19735 it
->c
= it
->char_to_display
= ' ';
19738 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19739 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19740 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19741 && !it
->glyph_row
->mode_line_p
19742 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19744 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19745 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19747 for (it
->current_x
= 0; g
< e
; g
++)
19748 it
->current_x
+= g
->pixel_width
;
19750 it
->area
= LEFT_MARGIN_AREA
;
19751 it
->face_id
= default_face
->id
;
19752 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19753 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19755 PRODUCE_GLYPHS (it
);
19756 /* term.c:produce_glyphs advances it->current_x only for
19758 it
->current_x
+= it
->pixel_width
;
19761 it
->current_x
= saved_x
;
19762 it
->area
= TEXT_AREA
;
19765 /* The last row's blank glyphs should get the default face, to
19766 avoid painting the rest of the window with the region face,
19767 if the region ends at ZV. */
19768 if (it
->glyph_row
->ends_at_zv_p
)
19769 it
->face_id
= default_face
->id
;
19771 it
->face_id
= face
->id
;
19772 PRODUCE_GLYPHS (it
);
19774 while (it
->current_x
<= it
->last_visible_x
)
19775 PRODUCE_GLYPHS (it
);
19777 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19778 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19779 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19780 && !it
->glyph_row
->mode_line_p
19781 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19783 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19784 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19786 for ( ; g
< e
; g
++)
19787 it
->current_x
+= g
->pixel_width
;
19789 it
->area
= RIGHT_MARGIN_AREA
;
19790 it
->face_id
= default_face
->id
;
19791 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19792 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19794 PRODUCE_GLYPHS (it
);
19795 it
->current_x
+= it
->pixel_width
;
19798 it
->area
= TEXT_AREA
;
19801 /* Don't count these blanks really. It would let us insert a left
19802 truncation glyph below and make us set the cursor on them, maybe. */
19803 it
->current_x
= saved_x
;
19804 it
->object
= saved_object
;
19805 it
->position
= saved_pos
;
19806 it
->what
= saved_what
;
19807 it
->face_id
= saved_face_id
;
19812 /* Value is true if text starting at CHARPOS in current_buffer is
19813 trailing whitespace. */
19816 trailing_whitespace_p (ptrdiff_t charpos
)
19818 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19821 while (bytepos
< ZV_BYTE
19822 && (c
= FETCH_CHAR (bytepos
),
19823 c
== ' ' || c
== '\t'))
19826 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19828 if (bytepos
!= PT_BYTE
)
19835 /* Highlight trailing whitespace, if any, in ROW. */
19838 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19840 int used
= row
->used
[TEXT_AREA
];
19844 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19845 struct glyph
*glyph
= start
+ used
- 1;
19847 if (row
->reversed_p
)
19849 /* Right-to-left rows need to be processed in the opposite
19850 direction, so swap the edge pointers. */
19852 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19855 /* Skip over glyphs inserted to display the cursor at the
19856 end of a line, for extending the face of the last glyph
19857 to the end of the line on terminals, and for truncation
19858 and continuation glyphs. */
19859 if (!row
->reversed_p
)
19861 while (glyph
>= start
19862 && glyph
->type
== CHAR_GLYPH
19863 && NILP (glyph
->object
))
19868 while (glyph
<= start
19869 && glyph
->type
== CHAR_GLYPH
19870 && NILP (glyph
->object
))
19874 /* If last glyph is a space or stretch, and it's trailing
19875 whitespace, set the face of all trailing whitespace glyphs in
19876 IT->glyph_row to `trailing-whitespace'. */
19877 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19878 && BUFFERP (glyph
->object
)
19879 && (glyph
->type
== STRETCH_GLYPH
19880 || (glyph
->type
== CHAR_GLYPH
19881 && glyph
->u
.ch
== ' '))
19882 && trailing_whitespace_p (glyph
->charpos
))
19884 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19888 if (!row
->reversed_p
)
19890 while (glyph
>= start
19891 && BUFFERP (glyph
->object
)
19892 && (glyph
->type
== STRETCH_GLYPH
19893 || (glyph
->type
== CHAR_GLYPH
19894 && glyph
->u
.ch
== ' ')))
19895 (glyph
--)->face_id
= face_id
;
19899 while (glyph
<= start
19900 && BUFFERP (glyph
->object
)
19901 && (glyph
->type
== STRETCH_GLYPH
19902 || (glyph
->type
== CHAR_GLYPH
19903 && glyph
->u
.ch
== ' ')))
19904 (glyph
++)->face_id
= face_id
;
19911 /* Value is true if glyph row ROW should be
19912 considered to hold the buffer position CHARPOS. */
19915 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19917 bool result
= true;
19919 if (charpos
== CHARPOS (row
->end
.pos
)
19920 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19922 /* Suppose the row ends on a string.
19923 Unless the row is continued, that means it ends on a newline
19924 in the string. If it's anything other than a display string
19925 (e.g., a before-string from an overlay), we don't want the
19926 cursor there. (This heuristic seems to give the optimal
19927 behavior for the various types of multi-line strings.)
19928 One exception: if the string has `cursor' property on one of
19929 its characters, we _do_ want the cursor there. */
19930 if (CHARPOS (row
->end
.string_pos
) >= 0)
19932 if (row
->continued_p
)
19936 /* Check for `display' property. */
19937 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19938 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19939 struct glyph
*glyph
;
19942 for (glyph
= end
; glyph
>= beg
; --glyph
)
19943 if (STRINGP (glyph
->object
))
19946 = Fget_char_property (make_number (charpos
),
19950 && display_prop_string_p (prop
, glyph
->object
));
19951 /* If there's a `cursor' property on one of the
19952 string's characters, this row is a cursor row,
19953 even though this is not a display string. */
19956 Lisp_Object s
= glyph
->object
;
19958 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19960 ptrdiff_t gpos
= glyph
->charpos
;
19962 if (!NILP (Fget_char_property (make_number (gpos
),
19974 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19976 /* If the row ends in middle of a real character,
19977 and the line is continued, we want the cursor here.
19978 That's because CHARPOS (ROW->end.pos) would equal
19979 PT if PT is before the character. */
19980 if (!row
->ends_in_ellipsis_p
)
19981 result
= row
->continued_p
;
19983 /* If the row ends in an ellipsis, then
19984 CHARPOS (ROW->end.pos) will equal point after the
19985 invisible text. We want that position to be displayed
19986 after the ellipsis. */
19989 /* If the row ends at ZV, display the cursor at the end of that
19990 row instead of at the start of the row below. */
19992 result
= row
->ends_at_zv_p
;
19998 /* Value is true if glyph row ROW should be
19999 used to hold the cursor. */
20002 cursor_row_p (struct glyph_row
*row
)
20004 return row_for_charpos_p (row
, PT
);
20009 /* Push the property PROP so that it will be rendered at the current
20010 position in IT. Return true if PROP was successfully pushed, false
20011 otherwise. Called from handle_line_prefix to handle the
20012 `line-prefix' and `wrap-prefix' properties. */
20015 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
20017 struct text_pos pos
=
20018 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
20020 eassert (it
->method
== GET_FROM_BUFFER
20021 || it
->method
== GET_FROM_DISPLAY_VECTOR
20022 || it
->method
== GET_FROM_STRING
20023 || it
->method
== GET_FROM_IMAGE
);
20025 /* We need to save the current buffer/string position, so it will be
20026 restored by pop_it, because iterate_out_of_display_property
20027 depends on that being set correctly, but some situations leave
20028 it->position not yet set when this function is called. */
20029 push_it (it
, &pos
);
20031 if (STRINGP (prop
))
20033 if (SCHARS (prop
) == 0)
20040 it
->string_from_prefix_prop_p
= true;
20041 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
20042 it
->current
.overlay_string_index
= -1;
20043 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
20044 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
20045 it
->method
= GET_FROM_STRING
;
20046 it
->stop_charpos
= 0;
20048 it
->base_level_stop
= 0;
20050 /* Force paragraph direction to be that of the parent
20052 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
20053 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
20055 it
->paragraph_embedding
= L2R
;
20057 /* Set up the bidi iterator for this display string. */
20060 it
->bidi_it
.string
.lstring
= it
->string
;
20061 it
->bidi_it
.string
.s
= NULL
;
20062 it
->bidi_it
.string
.schars
= it
->end_charpos
;
20063 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
20064 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
20065 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
20066 it
->bidi_it
.w
= it
->w
;
20067 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
20070 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
20072 it
->method
= GET_FROM_STRETCH
;
20075 #ifdef HAVE_WINDOW_SYSTEM
20076 else if (IMAGEP (prop
))
20078 it
->what
= IT_IMAGE
;
20079 it
->image_id
= lookup_image (it
->f
, prop
);
20080 it
->method
= GET_FROM_IMAGE
;
20082 #endif /* HAVE_WINDOW_SYSTEM */
20085 pop_it (it
); /* bogus display property, give up */
20092 /* Return the character-property PROP at the current position in IT. */
20095 get_it_property (struct it
*it
, Lisp_Object prop
)
20097 Lisp_Object position
, object
= it
->object
;
20099 if (STRINGP (object
))
20100 position
= make_number (IT_STRING_CHARPOS (*it
));
20101 else if (BUFFERP (object
))
20103 position
= make_number (IT_CHARPOS (*it
));
20104 object
= it
->window
;
20109 return Fget_char_property (position
, prop
, object
);
20112 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20115 handle_line_prefix (struct it
*it
)
20117 Lisp_Object prefix
;
20119 if (it
->continuation_lines_width
> 0)
20121 prefix
= get_it_property (it
, Qwrap_prefix
);
20123 prefix
= Vwrap_prefix
;
20127 prefix
= get_it_property (it
, Qline_prefix
);
20129 prefix
= Vline_prefix
;
20131 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
20133 /* If the prefix is wider than the window, and we try to wrap
20134 it, it would acquire its own wrap prefix, and so on till the
20135 iterator stack overflows. So, don't wrap the prefix. */
20136 it
->line_wrap
= TRUNCATE
;
20137 it
->avoid_cursor_p
= true;
20143 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20144 only for R2L lines from display_line and display_string, when they
20145 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20146 the line/string needs to be continued on the next glyph row. */
20148 unproduce_glyphs (struct it
*it
, int n
)
20150 struct glyph
*glyph
, *end
;
20152 eassert (it
->glyph_row
);
20153 eassert (it
->glyph_row
->reversed_p
);
20154 eassert (it
->area
== TEXT_AREA
);
20155 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20157 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20158 n
= it
->glyph_row
->used
[TEXT_AREA
];
20159 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20160 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20161 for ( ; glyph
< end
; glyph
++)
20162 glyph
[-n
] = *glyph
;
20165 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20166 and ROW->maxpos. */
20168 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20169 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20170 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20172 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20173 lines' rows is implemented for bidi-reordered rows. */
20175 /* ROW->minpos is the value of min_pos, the minimal buffer position
20176 we have in ROW, or ROW->start.pos if that is smaller. */
20177 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20178 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20180 /* We didn't find buffer positions smaller than ROW->start, or
20181 didn't find _any_ valid buffer positions in any of the glyphs,
20182 so we must trust the iterator's computed positions. */
20183 row
->minpos
= row
->start
.pos
;
20186 max_pos
= CHARPOS (it
->current
.pos
);
20187 max_bpos
= BYTEPOS (it
->current
.pos
);
20190 /* Here are the various use-cases for ending the row, and the
20191 corresponding values for ROW->maxpos:
20193 Line ends in a newline from buffer eol_pos + 1
20194 Line is continued from buffer max_pos + 1
20195 Line is truncated on right it->current.pos
20196 Line ends in a newline from string max_pos + 1(*)
20197 (*) + 1 only when line ends in a forward scan
20198 Line is continued from string max_pos
20199 Line is continued from display vector max_pos
20200 Line is entirely from a string min_pos == max_pos
20201 Line is entirely from a display vector min_pos == max_pos
20202 Line that ends at ZV ZV
20204 If you discover other use-cases, please add them here as
20206 if (row
->ends_at_zv_p
)
20207 row
->maxpos
= it
->current
.pos
;
20208 else if (row
->used
[TEXT_AREA
])
20210 bool seen_this_string
= false;
20211 struct glyph_row
*r1
= row
- 1;
20213 /* Did we see the same display string on the previous row? */
20214 if (STRINGP (it
->object
)
20215 /* this is not the first row */
20216 && row
> it
->w
->desired_matrix
->rows
20217 /* previous row is not the header line */
20218 && !r1
->mode_line_p
20219 /* previous row also ends in a newline from a string */
20220 && r1
->ends_in_newline_from_string_p
)
20222 struct glyph
*start
, *end
;
20224 /* Search for the last glyph of the previous row that came
20225 from buffer or string. Depending on whether the row is
20226 L2R or R2L, we need to process it front to back or the
20227 other way round. */
20228 if (!r1
->reversed_p
)
20230 start
= r1
->glyphs
[TEXT_AREA
];
20231 end
= start
+ r1
->used
[TEXT_AREA
];
20232 /* Glyphs inserted by redisplay have nil as their object. */
20234 && NILP ((end
- 1)->object
)
20235 && (end
- 1)->charpos
<= 0)
20239 if (EQ ((end
- 1)->object
, it
->object
))
20240 seen_this_string
= true;
20243 /* If all the glyphs of the previous row were inserted
20244 by redisplay, it means the previous row was
20245 produced from a single newline, which is only
20246 possible if that newline came from the same string
20247 as the one which produced this ROW. */
20248 seen_this_string
= true;
20252 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20253 start
= end
+ r1
->used
[TEXT_AREA
];
20255 && NILP ((end
+ 1)->object
)
20256 && (end
+ 1)->charpos
<= 0)
20260 if (EQ ((end
+ 1)->object
, it
->object
))
20261 seen_this_string
= true;
20264 seen_this_string
= true;
20267 /* Take note of each display string that covers a newline only
20268 once, the first time we see it. This is for when a display
20269 string includes more than one newline in it. */
20270 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20272 /* If we were scanning the buffer forward when we displayed
20273 the string, we want to account for at least one buffer
20274 position that belongs to this row (position covered by
20275 the display string), so that cursor positioning will
20276 consider this row as a candidate when point is at the end
20277 of the visual line represented by this row. This is not
20278 required when scanning back, because max_pos will already
20279 have a much larger value. */
20280 if (CHARPOS (row
->end
.pos
) > max_pos
)
20281 INC_BOTH (max_pos
, max_bpos
);
20282 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20284 else if (CHARPOS (it
->eol_pos
) > 0)
20285 SET_TEXT_POS (row
->maxpos
,
20286 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20287 else if (row
->continued_p
)
20289 /* If max_pos is different from IT's current position, it
20290 means IT->method does not belong to the display element
20291 at max_pos. However, it also means that the display
20292 element at max_pos was displayed in its entirety on this
20293 line, which is equivalent to saying that the next line
20294 starts at the next buffer position. */
20295 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20296 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20299 INC_BOTH (max_pos
, max_bpos
);
20300 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20303 else if (row
->truncated_on_right_p
)
20304 /* display_line already called reseat_at_next_visible_line_start,
20305 which puts the iterator at the beginning of the next line, in
20306 the logical order. */
20307 row
->maxpos
= it
->current
.pos
;
20308 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20309 /* A line that is entirely from a string/image/stretch... */
20310 row
->maxpos
= row
->minpos
;
20315 row
->maxpos
= it
->current
.pos
;
20318 /* Construct the glyph row IT->glyph_row in the desired matrix of
20319 IT->w from text at the current position of IT. See dispextern.h
20320 for an overview of struct it. Value is true if
20321 IT->glyph_row displays text, as opposed to a line displaying ZV
20325 display_line (struct it
*it
)
20327 struct glyph_row
*row
= it
->glyph_row
;
20328 Lisp_Object overlay_arrow_string
;
20330 void *wrap_data
= NULL
;
20331 bool may_wrap
= false;
20332 int wrap_x
IF_LINT (= 0);
20333 int wrap_row_used
= -1;
20334 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20335 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20336 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20337 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20338 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20340 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20341 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20342 bool pending_handle_line_prefix
= false;
20344 /* We always start displaying at hpos zero even if hscrolled. */
20345 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20347 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20348 >= it
->w
->desired_matrix
->nrows
)
20350 it
->w
->nrows_scale_factor
++;
20351 it
->f
->fonts_changed
= true;
20355 /* Clear the result glyph row and enable it. */
20356 prepare_desired_row (it
->w
, row
, false);
20358 row
->y
= it
->current_y
;
20359 row
->start
= it
->start
;
20360 row
->continuation_lines_width
= it
->continuation_lines_width
;
20361 row
->displays_text_p
= true;
20362 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20363 it
->starts_in_middle_of_char_p
= false;
20365 /* Arrange the overlays nicely for our purposes. Usually, we call
20366 display_line on only one line at a time, in which case this
20367 can't really hurt too much, or we call it on lines which appear
20368 one after another in the buffer, in which case all calls to
20369 recenter_overlay_lists but the first will be pretty cheap. */
20370 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20372 /* Move over display elements that are not visible because we are
20373 hscrolled. This may stop at an x-position < IT->first_visible_x
20374 if the first glyph is partially visible or if we hit a line end. */
20375 if (it
->current_x
< it
->first_visible_x
)
20377 enum move_it_result move_result
;
20379 this_line_min_pos
= row
->start
.pos
;
20380 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20381 MOVE_TO_POS
| MOVE_TO_X
);
20382 /* If we are under a large hscroll, move_it_in_display_line_to
20383 could hit the end of the line without reaching
20384 it->first_visible_x. Pretend that we did reach it. This is
20385 especially important on a TTY, where we will call
20386 extend_face_to_end_of_line, which needs to know how many
20387 blank glyphs to produce. */
20388 if (it
->current_x
< it
->first_visible_x
20389 && (move_result
== MOVE_NEWLINE_OR_CR
20390 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20391 it
->current_x
= it
->first_visible_x
;
20393 /* Record the smallest positions seen while we moved over
20394 display elements that are not visible. This is needed by
20395 redisplay_internal for optimizing the case where the cursor
20396 stays inside the same line. The rest of this function only
20397 considers positions that are actually displayed, so
20398 RECORD_MAX_MIN_POS will not otherwise record positions that
20399 are hscrolled to the left of the left edge of the window. */
20400 min_pos
= CHARPOS (this_line_min_pos
);
20401 min_bpos
= BYTEPOS (this_line_min_pos
);
20403 else if (it
->area
== TEXT_AREA
)
20405 /* We only do this when not calling move_it_in_display_line_to
20406 above, because that function calls itself handle_line_prefix. */
20407 handle_line_prefix (it
);
20411 /* Line-prefix and wrap-prefix are always displayed in the text
20412 area. But if this is the first call to display_line after
20413 init_iterator, the iterator might have been set up to write
20414 into a marginal area, e.g. if the line begins with some
20415 display property that writes to the margins. So we need to
20416 wait with the call to handle_line_prefix until whatever
20417 writes to the margin has done its job. */
20418 pending_handle_line_prefix
= true;
20421 /* Get the initial row height. This is either the height of the
20422 text hscrolled, if there is any, or zero. */
20423 row
->ascent
= it
->max_ascent
;
20424 row
->height
= it
->max_ascent
+ it
->max_descent
;
20425 row
->phys_ascent
= it
->max_phys_ascent
;
20426 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20427 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20429 /* Utility macro to record max and min buffer positions seen until now. */
20430 #define RECORD_MAX_MIN_POS(IT) \
20433 bool composition_p \
20434 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20435 ptrdiff_t current_pos = \
20436 composition_p ? (IT)->cmp_it.charpos \
20437 : IT_CHARPOS (*(IT)); \
20438 ptrdiff_t current_bpos = \
20439 composition_p ? CHAR_TO_BYTE (current_pos) \
20440 : IT_BYTEPOS (*(IT)); \
20441 if (current_pos < min_pos) \
20443 min_pos = current_pos; \
20444 min_bpos = current_bpos; \
20446 if (IT_CHARPOS (*it) > max_pos) \
20448 max_pos = IT_CHARPOS (*it); \
20449 max_bpos = IT_BYTEPOS (*it); \
20454 /* Loop generating characters. The loop is left with IT on the next
20455 character to display. */
20458 int n_glyphs_before
, hpos_before
, x_before
;
20460 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20462 /* Retrieve the next thing to display. Value is false if end of
20464 if (!get_next_display_element (it
))
20466 /* Maybe add a space at the end of this line that is used to
20467 display the cursor there under X. Set the charpos of the
20468 first glyph of blank lines not corresponding to any text
20470 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20471 row
->exact_window_width_line_p
= true;
20472 else if ((append_space_for_newline (it
, true)
20473 && row
->used
[TEXT_AREA
] == 1)
20474 || row
->used
[TEXT_AREA
] == 0)
20476 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20477 row
->displays_text_p
= false;
20479 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20480 && (!MINI_WINDOW_P (it
->w
)
20481 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20482 row
->indicate_empty_line_p
= true;
20485 it
->continuation_lines_width
= 0;
20486 row
->ends_at_zv_p
= true;
20487 /* A row that displays right-to-left text must always have
20488 its last face extended all the way to the end of line,
20489 even if this row ends in ZV, because we still write to
20490 the screen left to right. We also need to extend the
20491 last face if the default face is remapped to some
20492 different face, otherwise the functions that clear
20493 portions of the screen will clear with the default face's
20494 background color. */
20495 if (row
->reversed_p
20496 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20497 extend_face_to_end_of_line (it
);
20501 /* Now, get the metrics of what we want to display. This also
20502 generates glyphs in `row' (which is IT->glyph_row). */
20503 n_glyphs_before
= row
->used
[TEXT_AREA
];
20506 /* Remember the line height so far in case the next element doesn't
20507 fit on the line. */
20508 if (it
->line_wrap
!= TRUNCATE
)
20510 ascent
= it
->max_ascent
;
20511 descent
= it
->max_descent
;
20512 phys_ascent
= it
->max_phys_ascent
;
20513 phys_descent
= it
->max_phys_descent
;
20515 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20517 if (IT_DISPLAYING_WHITESPACE (it
))
20521 SAVE_IT (wrap_it
, *it
, wrap_data
);
20523 wrap_row_used
= row
->used
[TEXT_AREA
];
20524 wrap_row_ascent
= row
->ascent
;
20525 wrap_row_height
= row
->height
;
20526 wrap_row_phys_ascent
= row
->phys_ascent
;
20527 wrap_row_phys_height
= row
->phys_height
;
20528 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20529 wrap_row_min_pos
= min_pos
;
20530 wrap_row_min_bpos
= min_bpos
;
20531 wrap_row_max_pos
= max_pos
;
20532 wrap_row_max_bpos
= max_bpos
;
20538 PRODUCE_GLYPHS (it
);
20540 /* If this display element was in marginal areas, continue with
20542 if (it
->area
!= TEXT_AREA
)
20544 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20545 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20546 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20547 row
->phys_height
= max (row
->phys_height
,
20548 it
->max_phys_ascent
+ it
->max_phys_descent
);
20549 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20550 it
->max_extra_line_spacing
);
20551 set_iterator_to_next (it
, true);
20552 /* If we didn't handle the line/wrap prefix above, and the
20553 call to set_iterator_to_next just switched to TEXT_AREA,
20554 process the prefix now. */
20555 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20557 pending_handle_line_prefix
= false;
20558 handle_line_prefix (it
);
20563 /* Does the display element fit on the line? If we truncate
20564 lines, we should draw past the right edge of the window. If
20565 we don't truncate, we want to stop so that we can display the
20566 continuation glyph before the right margin. If lines are
20567 continued, there are two possible strategies for characters
20568 resulting in more than 1 glyph (e.g. tabs): Display as many
20569 glyphs as possible in this line and leave the rest for the
20570 continuation line, or display the whole element in the next
20571 line. Original redisplay did the former, so we do it also. */
20572 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20573 hpos_before
= it
->hpos
;
20576 if (/* Not a newline. */
20578 /* Glyphs produced fit entirely in the line. */
20579 && it
->current_x
< it
->last_visible_x
)
20581 it
->hpos
+= nglyphs
;
20582 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20583 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20584 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20585 row
->phys_height
= max (row
->phys_height
,
20586 it
->max_phys_ascent
+ it
->max_phys_descent
);
20587 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20588 it
->max_extra_line_spacing
);
20589 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20590 /* In R2L rows, we arrange in extend_face_to_end_of_line
20591 to add a right offset to the line, by a suitable
20592 change to the stretch glyph that is the leftmost
20593 glyph of the line. */
20594 && !row
->reversed_p
)
20595 row
->x
= x
- it
->first_visible_x
;
20596 /* Record the maximum and minimum buffer positions seen so
20597 far in glyphs that will be displayed by this row. */
20599 RECORD_MAX_MIN_POS (it
);
20604 struct glyph
*glyph
;
20606 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20608 /* Identify the glyphs added by the last call to
20609 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20610 the previous glyphs. */
20611 if (!row
->reversed_p
)
20612 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20614 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20615 new_x
= x
+ glyph
->pixel_width
;
20617 if (/* Lines are continued. */
20618 it
->line_wrap
!= TRUNCATE
20619 && (/* Glyph doesn't fit on the line. */
20620 new_x
> it
->last_visible_x
20621 /* Or it fits exactly on a window system frame. */
20622 || (new_x
== it
->last_visible_x
20623 && FRAME_WINDOW_P (it
->f
)
20624 && (row
->reversed_p
20625 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20626 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20628 /* End of a continued line. */
20631 || (new_x
== it
->last_visible_x
20632 && FRAME_WINDOW_P (it
->f
)
20633 && (row
->reversed_p
20634 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20635 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20637 /* Current glyph is the only one on the line or
20638 fits exactly on the line. We must continue
20639 the line because we can't draw the cursor
20640 after the glyph. */
20641 row
->continued_p
= true;
20642 it
->current_x
= new_x
;
20643 it
->continuation_lines_width
+= new_x
;
20645 if (i
== nglyphs
- 1)
20647 /* If line-wrap is on, check if a previous
20648 wrap point was found. */
20649 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20650 && wrap_row_used
> 0
20651 /* Even if there is a previous wrap
20652 point, continue the line here as
20653 usual, if (i) the previous character
20654 was a space or tab AND (ii) the
20655 current character is not. */
20657 || IT_DISPLAYING_WHITESPACE (it
)))
20660 /* Record the maximum and minimum buffer
20661 positions seen so far in glyphs that will be
20662 displayed by this row. */
20664 RECORD_MAX_MIN_POS (it
);
20665 set_iterator_to_next (it
, true);
20666 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20668 if (!get_next_display_element (it
))
20670 row
->exact_window_width_line_p
= true;
20671 it
->continuation_lines_width
= 0;
20672 row
->continued_p
= false;
20673 row
->ends_at_zv_p
= true;
20675 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20677 row
->continued_p
= false;
20678 row
->exact_window_width_line_p
= true;
20680 /* If line-wrap is on, check if a
20681 previous wrap point was found. */
20682 else if (wrap_row_used
> 0
20683 /* Even if there is a previous wrap
20684 point, continue the line here as
20685 usual, if (i) the previous character
20686 was a space or tab AND (ii) the
20687 current character is not. */
20689 || IT_DISPLAYING_WHITESPACE (it
)))
20694 else if (it
->bidi_p
)
20695 RECORD_MAX_MIN_POS (it
);
20696 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20697 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20698 extend_face_to_end_of_line (it
);
20700 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20701 && !FRAME_WINDOW_P (it
->f
))
20703 /* A padding glyph that doesn't fit on this line.
20704 This means the whole character doesn't fit
20706 if (row
->reversed_p
)
20707 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20708 - n_glyphs_before
);
20709 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20711 /* Fill the rest of the row with continuation
20712 glyphs like in 20.x. */
20713 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20714 < row
->glyphs
[1 + TEXT_AREA
])
20715 produce_special_glyphs (it
, IT_CONTINUATION
);
20717 row
->continued_p
= true;
20718 it
->current_x
= x_before
;
20719 it
->continuation_lines_width
+= x_before
;
20721 /* Restore the height to what it was before the
20722 element not fitting on the line. */
20723 it
->max_ascent
= ascent
;
20724 it
->max_descent
= descent
;
20725 it
->max_phys_ascent
= phys_ascent
;
20726 it
->max_phys_descent
= phys_descent
;
20727 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20728 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20729 extend_face_to_end_of_line (it
);
20731 else if (wrap_row_used
> 0)
20734 if (row
->reversed_p
)
20735 unproduce_glyphs (it
,
20736 row
->used
[TEXT_AREA
] - wrap_row_used
);
20737 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20738 it
->continuation_lines_width
+= wrap_x
;
20739 row
->used
[TEXT_AREA
] = wrap_row_used
;
20740 row
->ascent
= wrap_row_ascent
;
20741 row
->height
= wrap_row_height
;
20742 row
->phys_ascent
= wrap_row_phys_ascent
;
20743 row
->phys_height
= wrap_row_phys_height
;
20744 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20745 min_pos
= wrap_row_min_pos
;
20746 min_bpos
= wrap_row_min_bpos
;
20747 max_pos
= wrap_row_max_pos
;
20748 max_bpos
= wrap_row_max_bpos
;
20749 row
->continued_p
= true;
20750 row
->ends_at_zv_p
= false;
20751 row
->exact_window_width_line_p
= false;
20752 it
->continuation_lines_width
+= x
;
20754 /* Make sure that a non-default face is extended
20755 up to the right margin of the window. */
20756 extend_face_to_end_of_line (it
);
20758 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20760 /* A TAB that extends past the right edge of the
20761 window. This produces a single glyph on
20762 window system frames. We leave the glyph in
20763 this row and let it fill the row, but don't
20764 consume the TAB. */
20765 if ((row
->reversed_p
20766 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20767 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20768 produce_special_glyphs (it
, IT_CONTINUATION
);
20769 it
->continuation_lines_width
+= it
->last_visible_x
;
20770 row
->ends_in_middle_of_char_p
= true;
20771 row
->continued_p
= true;
20772 glyph
->pixel_width
= it
->last_visible_x
- x
;
20773 it
->starts_in_middle_of_char_p
= true;
20774 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20775 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20776 extend_face_to_end_of_line (it
);
20780 /* Something other than a TAB that draws past
20781 the right edge of the window. Restore
20782 positions to values before the element. */
20783 if (row
->reversed_p
)
20784 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20785 - (n_glyphs_before
+ i
));
20786 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20788 /* Display continuation glyphs. */
20789 it
->current_x
= x_before
;
20790 it
->continuation_lines_width
+= x
;
20791 if (!FRAME_WINDOW_P (it
->f
)
20792 || (row
->reversed_p
20793 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20794 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20795 produce_special_glyphs (it
, IT_CONTINUATION
);
20796 row
->continued_p
= true;
20798 extend_face_to_end_of_line (it
);
20800 if (nglyphs
> 1 && i
> 0)
20802 row
->ends_in_middle_of_char_p
= true;
20803 it
->starts_in_middle_of_char_p
= true;
20806 /* Restore the height to what it was before the
20807 element not fitting on the line. */
20808 it
->max_ascent
= ascent
;
20809 it
->max_descent
= descent
;
20810 it
->max_phys_ascent
= phys_ascent
;
20811 it
->max_phys_descent
= phys_descent
;
20816 else if (new_x
> it
->first_visible_x
)
20818 /* Increment number of glyphs actually displayed. */
20821 /* Record the maximum and minimum buffer positions
20822 seen so far in glyphs that will be displayed by
20825 RECORD_MAX_MIN_POS (it
);
20827 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20828 /* Glyph is partially visible, i.e. row starts at
20829 negative X position. Don't do that in R2L
20830 rows, where we arrange to add a right offset to
20831 the line in extend_face_to_end_of_line, by a
20832 suitable change to the stretch glyph that is
20833 the leftmost glyph of the line. */
20834 row
->x
= x
- it
->first_visible_x
;
20835 /* When the last glyph of an R2L row only fits
20836 partially on the line, we need to set row->x to a
20837 negative offset, so that the leftmost glyph is
20838 the one that is partially visible. But if we are
20839 going to produce the truncation glyph, this will
20840 be taken care of in produce_special_glyphs. */
20841 if (row
->reversed_p
20842 && new_x
> it
->last_visible_x
20843 && !(it
->line_wrap
== TRUNCATE
20844 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20846 eassert (FRAME_WINDOW_P (it
->f
));
20847 row
->x
= it
->last_visible_x
- new_x
;
20852 /* Glyph is completely off the left margin of the
20853 window. This should not happen because of the
20854 move_it_in_display_line at the start of this
20855 function, unless the text display area of the
20856 window is empty. */
20857 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20860 /* Even if this display element produced no glyphs at all,
20861 we want to record its position. */
20862 if (it
->bidi_p
&& nglyphs
== 0)
20863 RECORD_MAX_MIN_POS (it
);
20865 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20866 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20867 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20868 row
->phys_height
= max (row
->phys_height
,
20869 it
->max_phys_ascent
+ it
->max_phys_descent
);
20870 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20871 it
->max_extra_line_spacing
);
20873 /* End of this display line if row is continued. */
20874 if (row
->continued_p
|| row
->ends_at_zv_p
)
20879 /* Is this a line end? If yes, we're also done, after making
20880 sure that a non-default face is extended up to the right
20881 margin of the window. */
20882 if (ITERATOR_AT_END_OF_LINE_P (it
))
20884 int used_before
= row
->used
[TEXT_AREA
];
20886 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20888 /* Add a space at the end of the line that is used to
20889 display the cursor there. */
20890 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20891 append_space_for_newline (it
, false);
20893 /* Extend the face to the end of the line. */
20894 extend_face_to_end_of_line (it
);
20896 /* Make sure we have the position. */
20897 if (used_before
== 0)
20898 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20900 /* Record the position of the newline, for use in
20902 it
->eol_pos
= it
->current
.pos
;
20904 /* Consume the line end. This skips over invisible lines. */
20905 set_iterator_to_next (it
, true);
20906 it
->continuation_lines_width
= 0;
20910 /* Proceed with next display element. Note that this skips
20911 over lines invisible because of selective display. */
20912 set_iterator_to_next (it
, true);
20914 /* If we truncate lines, we are done when the last displayed
20915 glyphs reach past the right margin of the window. */
20916 if (it
->line_wrap
== TRUNCATE
20917 && ((FRAME_WINDOW_P (it
->f
)
20918 /* Images are preprocessed in produce_image_glyph such
20919 that they are cropped at the right edge of the
20920 window, so an image glyph will always end exactly at
20921 last_visible_x, even if there's no right fringe. */
20922 && ((row
->reversed_p
20923 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20924 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20925 || it
->what
== IT_IMAGE
))
20926 ? (it
->current_x
>= it
->last_visible_x
)
20927 : (it
->current_x
> it
->last_visible_x
)))
20929 /* Maybe add truncation glyphs. */
20930 if (!FRAME_WINDOW_P (it
->f
)
20931 || (row
->reversed_p
20932 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20933 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20937 if (!row
->reversed_p
)
20939 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20940 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20945 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20946 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20948 /* Remove any padding glyphs at the front of ROW, to
20949 make room for the truncation glyphs we will be
20950 adding below. The loop below always inserts at
20951 least one truncation glyph, so also remove the
20952 last glyph added to ROW. */
20953 unproduce_glyphs (it
, i
+ 1);
20954 /* Adjust i for the loop below. */
20955 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20958 /* produce_special_glyphs overwrites the last glyph, so
20959 we don't want that if we want to keep that last
20960 glyph, which means it's an image. */
20961 if (it
->current_x
> it
->last_visible_x
)
20963 it
->current_x
= x_before
;
20964 if (!FRAME_WINDOW_P (it
->f
))
20966 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20968 row
->used
[TEXT_AREA
] = i
;
20969 produce_special_glyphs (it
, IT_TRUNCATION
);
20974 row
->used
[TEXT_AREA
] = i
;
20975 produce_special_glyphs (it
, IT_TRUNCATION
);
20977 it
->hpos
= hpos_before
;
20980 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20982 /* Don't truncate if we can overflow newline into fringe. */
20983 if (!get_next_display_element (it
))
20985 it
->continuation_lines_width
= 0;
20986 row
->ends_at_zv_p
= true;
20987 row
->exact_window_width_line_p
= true;
20990 if (ITERATOR_AT_END_OF_LINE_P (it
))
20992 row
->exact_window_width_line_p
= true;
20993 goto at_end_of_line
;
20995 it
->current_x
= x_before
;
20996 it
->hpos
= hpos_before
;
20999 row
->truncated_on_right_p
= true;
21000 it
->continuation_lines_width
= 0;
21001 reseat_at_next_visible_line_start (it
, false);
21002 /* We insist below that IT's position be at ZV because in
21003 bidi-reordered lines the character at visible line start
21004 might not be the character that follows the newline in
21005 the logical order. */
21006 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
21007 row
->ends_at_zv_p
=
21008 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
21010 row
->ends_at_zv_p
= false;
21016 bidi_unshelve_cache (wrap_data
, true);
21018 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21019 at the left window margin. */
21020 if (it
->first_visible_x
21021 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
21023 if (!FRAME_WINDOW_P (it
->f
)
21024 || (((row
->reversed_p
21025 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21026 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
21027 /* Don't let insert_left_trunc_glyphs overwrite the
21028 first glyph of the row if it is an image. */
21029 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
21030 insert_left_trunc_glyphs (it
);
21031 row
->truncated_on_left_p
= true;
21034 /* Remember the position at which this line ends.
21036 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21037 cannot be before the call to find_row_edges below, since that is
21038 where these positions are determined. */
21039 row
->end
= it
->current
;
21042 row
->minpos
= row
->start
.pos
;
21043 row
->maxpos
= row
->end
.pos
;
21047 /* ROW->minpos and ROW->maxpos must be the smallest and
21048 `1 + the largest' buffer positions in ROW. But if ROW was
21049 bidi-reordered, these two positions can be anywhere in the
21050 row, so we must determine them now. */
21051 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
21054 /* If the start of this line is the overlay arrow-position, then
21055 mark this glyph row as the one containing the overlay arrow.
21056 This is clearly a mess with variable size fonts. It would be
21057 better to let it be displayed like cursors under X. */
21058 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
21059 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
21060 !NILP (overlay_arrow_string
)))
21062 /* Overlay arrow in window redisplay is a fringe bitmap. */
21063 if (STRINGP (overlay_arrow_string
))
21065 struct glyph_row
*arrow_row
21066 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
21067 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
21068 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
21069 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
21070 struct glyph
*p2
, *end
;
21072 /* Copy the arrow glyphs. */
21073 while (glyph
< arrow_end
)
21076 /* Throw away padding glyphs. */
21078 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
21079 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
21085 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
21090 eassert (INTEGERP (overlay_arrow_string
));
21091 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
21093 overlay_arrow_seen
= true;
21096 /* Highlight trailing whitespace. */
21097 if (!NILP (Vshow_trailing_whitespace
))
21098 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
21100 /* Compute pixel dimensions of this line. */
21101 compute_line_metrics (it
);
21103 /* Implementation note: No changes in the glyphs of ROW or in their
21104 faces can be done past this point, because compute_line_metrics
21105 computes ROW's hash value and stores it within the glyph_row
21108 /* Record whether this row ends inside an ellipsis. */
21109 row
->ends_in_ellipsis_p
21110 = (it
->method
== GET_FROM_DISPLAY_VECTOR
21111 && it
->ellipsis_p
);
21113 /* Save fringe bitmaps in this row. */
21114 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
21115 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
21116 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
21117 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
21119 it
->left_user_fringe_bitmap
= 0;
21120 it
->left_user_fringe_face_id
= 0;
21121 it
->right_user_fringe_bitmap
= 0;
21122 it
->right_user_fringe_face_id
= 0;
21124 /* Maybe set the cursor. */
21125 cvpos
= it
->w
->cursor
.vpos
;
21127 /* In bidi-reordered rows, keep checking for proper cursor
21128 position even if one has been found already, because buffer
21129 positions in such rows change non-linearly with ROW->VPOS,
21130 when a line is continued. One exception: when we are at ZV,
21131 display cursor on the first suitable glyph row, since all
21132 the empty rows after that also have their position set to ZV. */
21133 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21134 lines' rows is implemented for bidi-reordered rows. */
21136 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
21137 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
21138 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
21139 && cursor_row_p (row
))
21140 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
21142 /* Prepare for the next line. This line starts horizontally at (X
21143 HPOS) = (0 0). Vertical positions are incremented. As a
21144 convenience for the caller, IT->glyph_row is set to the next
21146 it
->current_x
= it
->hpos
= 0;
21147 it
->current_y
+= row
->height
;
21148 SET_TEXT_POS (it
->eol_pos
, 0, 0);
21151 /* The next row should by default use the same value of the
21152 reversed_p flag as this one. set_iterator_to_next decides when
21153 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21154 the flag accordingly. */
21155 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
21156 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21157 it
->start
= row
->end
;
21158 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21160 #undef RECORD_MAX_MIN_POS
21163 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21164 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21165 doc
: /* Return paragraph direction at point in BUFFER.
21166 Value is either `left-to-right' or `right-to-left'.
21167 If BUFFER is omitted or nil, it defaults to the current buffer.
21169 Paragraph direction determines how the text in the paragraph is displayed.
21170 In left-to-right paragraphs, text begins at the left margin of the window
21171 and the reading direction is generally left to right. In right-to-left
21172 paragraphs, text begins at the right margin and is read from right to left.
21174 See also `bidi-paragraph-direction'. */)
21175 (Lisp_Object buffer
)
21177 struct buffer
*buf
= current_buffer
;
21178 struct buffer
*old
= buf
;
21180 if (! NILP (buffer
))
21182 CHECK_BUFFER (buffer
);
21183 buf
= XBUFFER (buffer
);
21186 if (NILP (BVAR (buf
, bidi_display_reordering
))
21187 || NILP (BVAR (buf
, enable_multibyte_characters
))
21188 /* When we are loading loadup.el, the character property tables
21189 needed for bidi iteration are not yet available. */
21190 || !NILP (Vpurify_flag
))
21191 return Qleft_to_right
;
21192 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21193 return BVAR (buf
, bidi_paragraph_direction
);
21196 /* Determine the direction from buffer text. We could try to
21197 use current_matrix if it is up to date, but this seems fast
21198 enough as it is. */
21199 struct bidi_it itb
;
21200 ptrdiff_t pos
= BUF_PT (buf
);
21201 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21203 void *itb_data
= bidi_shelve_cache ();
21205 set_buffer_temp (buf
);
21206 /* bidi_paragraph_init finds the base direction of the paragraph
21207 by searching forward from paragraph start. We need the base
21208 direction of the current or _previous_ paragraph, so we need
21209 to make sure we are within that paragraph. To that end, find
21210 the previous non-empty line. */
21211 if (pos
>= ZV
&& pos
> BEGV
)
21212 DEC_BOTH (pos
, bytepos
);
21213 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21214 if (fast_looking_at (trailing_white_space
,
21215 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21217 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21218 || c
== ' ' || c
== '\t' || c
== '\f')
21220 if (bytepos
<= BEGV_BYTE
)
21225 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21228 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21229 itb
.paragraph_dir
= NEUTRAL_DIR
;
21230 itb
.string
.s
= NULL
;
21231 itb
.string
.lstring
= Qnil
;
21232 itb
.string
.bufpos
= 0;
21233 itb
.string
.from_disp_str
= false;
21234 itb
.string
.unibyte
= false;
21235 /* We have no window to use here for ignoring window-specific
21236 overlays. Using NULL for window pointer will cause
21237 compute_display_string_pos to use the current buffer. */
21239 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21240 bidi_unshelve_cache (itb_data
, false);
21241 set_buffer_temp (old
);
21242 switch (itb
.paragraph_dir
)
21245 return Qleft_to_right
;
21248 return Qright_to_left
;
21256 DEFUN ("bidi-find-overridden-directionality",
21257 Fbidi_find_overridden_directionality
,
21258 Sbidi_find_overridden_directionality
, 2, 3, 0,
21259 doc
: /* Return position between FROM and TO where directionality was overridden.
21261 This function returns the first character position in the specified
21262 region of OBJECT where there is a character whose `bidi-class' property
21263 is `L', but which was forced to display as `R' by a directional
21264 override, and likewise with characters whose `bidi-class' is `R'
21265 or `AL' that were forced to display as `L'.
21267 If no such character is found, the function returns nil.
21269 OBJECT is a Lisp string or buffer to search for overridden
21270 directionality, and defaults to the current buffer if nil or omitted.
21271 OBJECT can also be a window, in which case the function will search
21272 the buffer displayed in that window. Passing the window instead of
21273 a buffer is preferable when the buffer is displayed in some window,
21274 because this function will then be able to correctly account for
21275 window-specific overlays, which can affect the results.
21277 Strong directional characters `L', `R', and `AL' can have their
21278 intrinsic directionality overridden by directional override
21279 control characters RLO (u+202e) and LRO (u+202d). See the
21280 function `get-char-code-property' for a way to inquire about
21281 the `bidi-class' property of a character. */)
21282 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21284 struct buffer
*buf
= current_buffer
;
21285 struct buffer
*old
= buf
;
21286 struct window
*w
= NULL
;
21287 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21288 struct bidi_it itb
;
21289 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21292 if (!NILP (object
))
21294 if (BUFFERP (object
))
21295 buf
= XBUFFER (object
);
21296 else if (WINDOWP (object
))
21298 w
= decode_live_window (object
);
21299 buf
= XBUFFER (w
->contents
);
21300 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21303 CHECK_STRING (object
);
21306 if (STRINGP (object
))
21308 /* Characters in unibyte strings are always treated by bidi.c as
21310 if (!STRING_MULTIBYTE (object
)
21311 /* When we are loading loadup.el, the character property
21312 tables needed for bidi iteration are not yet
21314 || !NILP (Vpurify_flag
))
21317 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21318 if (from_pos
>= SCHARS (object
))
21321 /* Set up the bidi iterator. */
21322 itb_data
= bidi_shelve_cache ();
21323 itb
.paragraph_dir
= NEUTRAL_DIR
;
21324 itb
.string
.lstring
= object
;
21325 itb
.string
.s
= NULL
;
21326 itb
.string
.schars
= SCHARS (object
);
21327 itb
.string
.bufpos
= 0;
21328 itb
.string
.from_disp_str
= false;
21329 itb
.string
.unibyte
= false;
21331 bidi_init_it (0, 0, frame_window_p
, &itb
);
21335 /* Nothing this fancy can happen in unibyte buffers, or in a
21336 buffer that disabled reordering, or if FROM is at EOB. */
21337 if (NILP (BVAR (buf
, bidi_display_reordering
))
21338 || NILP (BVAR (buf
, enable_multibyte_characters
))
21339 /* When we are loading loadup.el, the character property
21340 tables needed for bidi iteration are not yet
21342 || !NILP (Vpurify_flag
))
21345 set_buffer_temp (buf
);
21346 validate_region (&from
, &to
);
21347 from_pos
= XINT (from
);
21348 to_pos
= XINT (to
);
21349 if (from_pos
>= ZV
)
21352 /* Set up the bidi iterator. */
21353 itb_data
= bidi_shelve_cache ();
21354 from_bpos
= CHAR_TO_BYTE (from_pos
);
21355 if (from_pos
== BEGV
)
21357 itb
.charpos
= BEGV
;
21358 itb
.bytepos
= BEGV_BYTE
;
21360 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21362 itb
.charpos
= from_pos
;
21363 itb
.bytepos
= from_bpos
;
21366 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21368 itb
.paragraph_dir
= NEUTRAL_DIR
;
21369 itb
.string
.s
= NULL
;
21370 itb
.string
.lstring
= Qnil
;
21371 itb
.string
.bufpos
= 0;
21372 itb
.string
.from_disp_str
= false;
21373 itb
.string
.unibyte
= false;
21375 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21380 /* For the purposes of this function, the actual base direction of
21381 the paragraph doesn't matter, so just set it to L2R. */
21382 bidi_paragraph_init (L2R
, &itb
, false);
21383 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21385 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21387 bidi_unshelve_cache (itb_data
, false);
21388 set_buffer_temp (old
);
21390 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21393 DEFUN ("move-point-visually", Fmove_point_visually
,
21394 Smove_point_visually
, 1, 1, 0,
21395 doc
: /* Move point in the visual order in the specified DIRECTION.
21396 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21399 Value is the new character position of point. */)
21400 (Lisp_Object direction
)
21402 struct window
*w
= XWINDOW (selected_window
);
21403 struct buffer
*b
= XBUFFER (w
->contents
);
21404 struct glyph_row
*row
;
21406 Lisp_Object paragraph_dir
;
21408 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21409 (!(ROW)->continued_p \
21410 && NILP ((GLYPH)->object) \
21411 && (GLYPH)->type == CHAR_GLYPH \
21412 && (GLYPH)->u.ch == ' ' \
21413 && (GLYPH)->charpos >= 0 \
21414 && !(GLYPH)->avoid_cursor_p)
21416 CHECK_NUMBER (direction
);
21417 dir
= XINT (direction
);
21423 /* If current matrix is up-to-date, we can use the information
21424 recorded in the glyphs, at least as long as the goal is on the
21426 if (w
->window_end_valid
21427 && !windows_or_buffers_changed
21429 && !b
->clip_changed
21430 && !b
->prevent_redisplay_optimizations_p
21431 && !window_outdated (w
)
21432 /* We rely below on the cursor coordinates to be up to date, but
21433 we cannot trust them if some command moved point since the
21434 last complete redisplay. */
21435 && w
->last_point
== BUF_PT (b
)
21436 && w
->cursor
.vpos
>= 0
21437 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21438 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21440 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21441 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21442 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21444 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21446 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21448 SET_PT (g
->charpos
);
21449 w
->cursor
.vpos
= -1;
21450 return make_number (PT
);
21452 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21456 if (BUFFERP (gpt
->object
))
21459 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21460 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21462 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21464 else if (BUFFERP (g
->object
))
21465 new_pos
= g
->charpos
;
21469 w
->cursor
.vpos
= -1;
21470 return make_number (PT
);
21472 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21474 /* Glyphs inserted at the end of a non-empty line for
21475 positioning the cursor have zero charpos, so we must
21476 deduce the value of point by other means. */
21477 if (g
->charpos
> 0)
21478 SET_PT (g
->charpos
);
21479 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21481 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21482 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21485 w
->cursor
.vpos
= -1;
21486 return make_number (PT
);
21489 if (g
== e
|| NILP (g
->object
))
21491 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21492 goto simulate_display
;
21493 if (!row
->reversed_p
)
21497 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21498 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21499 goto simulate_display
;
21503 if (row
->reversed_p
&& !row
->continued_p
)
21505 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21506 w
->cursor
.vpos
= -1;
21507 return make_number (PT
);
21509 g
= row
->glyphs
[TEXT_AREA
];
21510 e
= g
+ row
->used
[TEXT_AREA
];
21511 for ( ; g
< e
; g
++)
21513 if (BUFFERP (g
->object
)
21514 /* Empty lines have only one glyph, which stands
21515 for the newline, and whose charpos is the
21516 buffer position of the newline. */
21517 || ROW_GLYPH_NEWLINE_P (row
, g
)
21518 /* When the buffer ends in a newline, the line at
21519 EOB also has one glyph, but its charpos is -1. */
21520 || (row
->ends_at_zv_p
21521 && !row
->reversed_p
21522 && NILP (g
->object
)
21523 && g
->type
== CHAR_GLYPH
21524 && g
->u
.ch
== ' '))
21526 if (g
->charpos
> 0)
21527 SET_PT (g
->charpos
);
21528 else if (!row
->reversed_p
21529 && row
->ends_at_zv_p
21534 w
->cursor
.vpos
= -1;
21535 return make_number (PT
);
21541 if (!row
->reversed_p
&& !row
->continued_p
)
21543 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21544 w
->cursor
.vpos
= -1;
21545 return make_number (PT
);
21547 e
= row
->glyphs
[TEXT_AREA
];
21548 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21549 for ( ; g
>= e
; g
--)
21551 if (BUFFERP (g
->object
)
21552 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21554 /* Empty R2L lines on GUI frames have the buffer
21555 position of the newline stored in the stretch
21557 || g
->type
== STRETCH_GLYPH
21558 || (row
->ends_at_zv_p
21560 && NILP (g
->object
)
21561 && g
->type
== CHAR_GLYPH
21562 && g
->u
.ch
== ' '))
21564 if (g
->charpos
> 0)
21565 SET_PT (g
->charpos
);
21566 else if (row
->reversed_p
21567 && row
->ends_at_zv_p
21572 w
->cursor
.vpos
= -1;
21573 return make_number (PT
);
21582 /* If we wind up here, we failed to move by using the glyphs, so we
21583 need to simulate display instead. */
21586 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21588 paragraph_dir
= Qleft_to_right
;
21589 if (EQ (paragraph_dir
, Qright_to_left
))
21591 if (PT
<= BEGV
&& dir
< 0)
21592 xsignal0 (Qbeginning_of_buffer
);
21593 else if (PT
>= ZV
&& dir
> 0)
21594 xsignal0 (Qend_of_buffer
);
21597 struct text_pos pt
;
21599 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21601 bool overshoot_expected
= false;
21602 bool target_is_eol_p
= false;
21604 /* Setup the arena. */
21605 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21606 start_display (&it
, w
, pt
);
21607 /* When lines are truncated, we could be called with point
21608 outside of the windows edges, in which case move_it_*
21609 functions either prematurely stop at window's edge or jump to
21610 the next screen line, whereas we rely below on our ability to
21611 reach point, in order to start from its X coordinate. So we
21612 need to disregard the window's horizontal extent in that case. */
21613 if (it
.line_wrap
== TRUNCATE
)
21614 it
.last_visible_x
= INFINITY
;
21616 if (it
.cmp_it
.id
< 0
21617 && it
.method
== GET_FROM_STRING
21618 && it
.area
== TEXT_AREA
21619 && it
.string_from_display_prop_p
21620 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21621 overshoot_expected
= true;
21623 /* Find the X coordinate of point. We start from the beginning
21624 of this or previous line to make sure we are before point in
21625 the logical order (since the move_it_* functions can only
21628 reseat_at_previous_visible_line_start (&it
);
21629 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21630 if (IT_CHARPOS (it
) != PT
)
21632 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21633 -1, -1, -1, MOVE_TO_POS
);
21634 /* If we missed point because the character there is
21635 displayed out of a display vector that has more than one
21636 glyph, retry expecting overshoot. */
21637 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21638 && it
.current
.dpvec_index
> 0
21639 && !overshoot_expected
)
21641 overshoot_expected
= true;
21644 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21645 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21647 pt_x
= it
.current_x
;
21649 if (dir
> 0 || overshoot_expected
)
21651 struct glyph_row
*row
= it
.glyph_row
;
21653 /* When point is at beginning of line, we don't have
21654 information about the glyph there loaded into struct
21655 it. Calling get_next_display_element fixes that. */
21657 get_next_display_element (&it
);
21658 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21659 it
.glyph_row
= NULL
;
21660 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21661 it
.glyph_row
= row
;
21662 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21663 it, lest it will become out of sync with it's buffer
21665 it
.current_x
= pt_x
;
21668 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21669 pixel_width
= it
.pixel_width
;
21670 if (overshoot_expected
&& at_eol_p
)
21672 else if (pixel_width
<= 0)
21675 /* If there's a display string (or something similar) at point,
21676 we are actually at the glyph to the left of point, so we need
21677 to correct the X coordinate. */
21678 if (overshoot_expected
)
21681 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21683 pt_x
+= pixel_width
;
21686 /* Compute target X coordinate, either to the left or to the
21687 right of point. On TTY frames, all characters have the same
21688 pixel width of 1, so we can use that. On GUI frames we don't
21689 have an easy way of getting at the pixel width of the
21690 character to the left of point, so we use a different method
21691 of getting to that place. */
21693 target_x
= pt_x
+ pixel_width
;
21695 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21697 /* Target X coordinate could be one line above or below the line
21698 of point, in which case we need to adjust the target X
21699 coordinate. Also, if moving to the left, we need to begin at
21700 the left edge of the point's screen line. */
21705 start_display (&it
, w
, pt
);
21706 if (it
.line_wrap
== TRUNCATE
)
21707 it
.last_visible_x
= INFINITY
;
21708 reseat_at_previous_visible_line_start (&it
);
21709 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21711 move_it_by_lines (&it
, pt_vpos
);
21715 move_it_by_lines (&it
, -1);
21716 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21717 target_is_eol_p
= true;
21718 /* Under word-wrap, we don't know the x coordinate of
21719 the last character displayed on the previous line,
21720 which immediately precedes the wrap point. To find
21721 out its x coordinate, we try moving to the right
21722 margin of the window, which will stop at the wrap
21723 point, and then reset target_x to point at the
21724 character that precedes the wrap point. This is not
21725 needed on GUI frames, because (see below) there we
21726 move from the left margin one grapheme cluster at a
21727 time, and stop when we hit the wrap point. */
21728 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21730 void *it_data
= NULL
;
21733 SAVE_IT (it2
, it
, it_data
);
21734 move_it_in_display_line_to (&it
, ZV
, target_x
,
21735 MOVE_TO_POS
| MOVE_TO_X
);
21736 /* If we arrived at target_x, that _is_ the last
21737 character on the previous line. */
21738 if (it
.current_x
!= target_x
)
21739 target_x
= it
.current_x
- 1;
21740 RESTORE_IT (&it
, &it2
, it_data
);
21747 || (target_x
>= it
.last_visible_x
21748 && it
.line_wrap
!= TRUNCATE
))
21751 move_it_by_lines (&it
, 0);
21752 move_it_by_lines (&it
, 1);
21757 /* Move to the target X coordinate. */
21758 #ifdef HAVE_WINDOW_SYSTEM
21759 /* On GUI frames, as we don't know the X coordinate of the
21760 character to the left of point, moving point to the left
21761 requires walking, one grapheme cluster at a time, until we
21762 find ourself at a place immediately to the left of the
21763 character at point. */
21764 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21766 struct text_pos new_pos
;
21767 enum move_it_result rc
= MOVE_X_REACHED
;
21769 if (it
.current_x
== 0)
21770 get_next_display_element (&it
);
21771 if (it
.what
== IT_COMPOSITION
)
21773 new_pos
.charpos
= it
.cmp_it
.charpos
;
21774 new_pos
.bytepos
= -1;
21777 new_pos
= it
.current
.pos
;
21779 while (it
.current_x
+ it
.pixel_width
<= target_x
21780 && (rc
== MOVE_X_REACHED
21781 /* Under word-wrap, move_it_in_display_line_to
21782 stops at correct coordinates, but sometimes
21783 returns MOVE_POS_MATCH_OR_ZV. */
21784 || (it
.line_wrap
== WORD_WRAP
21785 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21787 int new_x
= it
.current_x
+ it
.pixel_width
;
21789 /* For composed characters, we want the position of the
21790 first character in the grapheme cluster (usually, the
21791 composition's base character), whereas it.current
21792 might give us the position of the _last_ one, e.g. if
21793 the composition is rendered in reverse due to bidi
21795 if (it
.what
== IT_COMPOSITION
)
21797 new_pos
.charpos
= it
.cmp_it
.charpos
;
21798 new_pos
.bytepos
= -1;
21801 new_pos
= it
.current
.pos
;
21802 if (new_x
== it
.current_x
)
21804 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21805 MOVE_TO_POS
| MOVE_TO_X
);
21806 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21809 /* The previous position we saw in the loop is the one we
21811 if (new_pos
.bytepos
== -1)
21812 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21813 it
.current
.pos
= new_pos
;
21817 if (it
.current_x
!= target_x
)
21818 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21820 /* If we ended up in a display string that covers point, move to
21821 buffer position to the right in the visual order. */
21824 while (IT_CHARPOS (it
) == PT
)
21826 set_iterator_to_next (&it
, false);
21827 if (!get_next_display_element (&it
))
21832 /* Move point to that position. */
21833 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21836 return make_number (PT
);
21838 #undef ROW_GLYPH_NEWLINE_P
21841 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21842 Sbidi_resolved_levels
, 0, 1, 0,
21843 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21845 The resolved levels are produced by the Emacs bidi reordering engine
21846 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21847 read the Unicode Standard Annex 9 (UAX#9) for background information
21848 about these levels.
21850 VPOS is the zero-based number of the current window's screen line
21851 for which to produce the resolved levels. If VPOS is nil or omitted,
21852 it defaults to the screen line of point. If the window displays a
21853 header line, VPOS of zero will report on the header line, and first
21854 line of text in the window will have VPOS of 1.
21856 Value is an array of resolved levels, indexed by glyph number.
21857 Glyphs are numbered from zero starting from the beginning of the
21858 screen line, i.e. the left edge of the window for left-to-right lines
21859 and from the right edge for right-to-left lines. The resolved levels
21860 are produced only for the window's text area; text in display margins
21863 If the selected window's display is not up-to-date, or if the specified
21864 screen line does not display text, this function returns nil. It is
21865 highly recommended to bind this function to some simple key, like F8,
21866 in order to avoid these problems.
21868 This function exists mainly for testing the correctness of the
21869 Emacs UBA implementation, in particular with the test suite. */)
21872 struct window
*w
= XWINDOW (selected_window
);
21873 struct buffer
*b
= XBUFFER (w
->contents
);
21875 struct glyph_row
*row
;
21879 int d1
, d2
, d3
, d4
, d5
;
21881 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21885 CHECK_NUMBER_COERCE_MARKER (vpos
);
21886 nrow
= XINT (vpos
);
21889 /* We require up-to-date glyph matrix for this window. */
21890 if (w
->window_end_valid
21891 && !windows_or_buffers_changed
21893 && !b
->clip_changed
21894 && !b
->prevent_redisplay_optimizations_p
21895 && !window_outdated (w
)
21897 && nrow
< w
->current_matrix
->nrows
21898 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21899 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21901 struct glyph
*g
, *e
, *g1
;
21903 Lisp_Object levels
;
21905 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21907 g
= g1
= row
->glyphs
[TEXT_AREA
];
21908 e
= g
+ row
->used
[TEXT_AREA
];
21910 /* Skip over glyphs at the start of the row that was
21911 generated by redisplay for its own needs. */
21913 && NILP (g
->object
)
21918 /* Count the "interesting" glyphs in this row. */
21919 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21922 /* Create and fill the array. */
21923 levels
= make_uninit_vector (nglyphs
);
21924 for (i
= 0; g1
< g
; i
++, g1
++)
21925 ASET (levels
, i
, make_number (g1
->resolved_level
));
21927 else /* Right-to-left glyph row. */
21929 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21930 e
= row
->glyphs
[TEXT_AREA
] - 1;
21932 && NILP (g
->object
)
21936 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21938 levels
= make_uninit_vector (nglyphs
);
21939 for (i
= 0; g1
> g
; i
++, g1
--)
21940 ASET (levels
, i
, make_number (g1
->resolved_level
));
21950 /***********************************************************************
21952 ***********************************************************************/
21954 /* Redisplay the menu bar in the frame for window W.
21956 The menu bar of X frames that don't have X toolkit support is
21957 displayed in a special window W->frame->menu_bar_window.
21959 The menu bar of terminal frames is treated specially as far as
21960 glyph matrices are concerned. Menu bar lines are not part of
21961 windows, so the update is done directly on the frame matrix rows
21962 for the menu bar. */
21965 display_menu_bar (struct window
*w
)
21967 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21972 /* Don't do all this for graphical frames. */
21974 if (FRAME_W32_P (f
))
21977 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21983 if (FRAME_NS_P (f
))
21985 #endif /* HAVE_NS */
21987 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21988 eassert (!FRAME_WINDOW_P (f
));
21989 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21990 it
.first_visible_x
= 0;
21991 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21992 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21993 if (FRAME_WINDOW_P (f
))
21995 /* Menu bar lines are displayed in the desired matrix of the
21996 dummy window menu_bar_window. */
21997 struct window
*menu_w
;
21998 menu_w
= XWINDOW (f
->menu_bar_window
);
21999 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
22001 it
.first_visible_x
= 0;
22002 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
22005 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22007 /* This is a TTY frame, i.e. character hpos/vpos are used as
22009 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
22011 it
.first_visible_x
= 0;
22012 it
.last_visible_x
= FRAME_COLS (f
);
22015 /* FIXME: This should be controlled by a user option. See the
22016 comments in redisplay_tool_bar and display_mode_line about
22018 it
.paragraph_embedding
= L2R
;
22020 /* Clear all rows of the menu bar. */
22021 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
22023 struct glyph_row
*row
= it
.glyph_row
+ i
;
22024 clear_glyph_row (row
);
22025 row
->enabled_p
= true;
22026 row
->full_width_p
= true;
22027 row
->reversed_p
= false;
22030 /* Display all items of the menu bar. */
22031 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
22032 for (i
= 0; i
< ASIZE (items
); i
+= 4)
22034 Lisp_Object string
;
22036 /* Stop at nil string. */
22037 string
= AREF (items
, i
+ 1);
22041 /* Remember where item was displayed. */
22042 ASET (items
, i
+ 3, make_number (it
.hpos
));
22044 /* Display the item, pad with one space. */
22045 if (it
.current_x
< it
.last_visible_x
)
22046 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
22047 SCHARS (string
) + 1, 0, 0, -1);
22050 /* Fill out the line with spaces. */
22051 if (it
.current_x
< it
.last_visible_x
)
22052 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
22054 /* Compute the total height of the lines. */
22055 compute_line_metrics (&it
);
22058 /* Deep copy of a glyph row, including the glyphs. */
22060 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
22062 struct glyph
*pointers
[1 + LAST_AREA
];
22063 int to_used
= to
->used
[TEXT_AREA
];
22065 /* Save glyph pointers of TO. */
22066 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
22068 /* Do a structure assignment. */
22071 /* Restore original glyph pointers of TO. */
22072 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
22074 /* Copy the glyphs. */
22075 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
22076 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
22078 /* If we filled only part of the TO row, fill the rest with
22079 space_glyph (which will display as empty space). */
22080 if (to_used
> from
->used
[TEXT_AREA
])
22081 fill_up_frame_row_with_spaces (to
, to_used
);
22084 /* Display one menu item on a TTY, by overwriting the glyphs in the
22085 frame F's desired glyph matrix with glyphs produced from the menu
22086 item text. Called from term.c to display TTY drop-down menus one
22089 ITEM_TEXT is the menu item text as a C string.
22091 FACE_ID is the face ID to be used for this menu item. FACE_ID
22092 could specify one of 3 faces: a face for an enabled item, a face
22093 for a disabled item, or a face for a selected item.
22095 X and Y are coordinates of the first glyph in the frame's desired
22096 matrix to be overwritten by the menu item. Since this is a TTY, Y
22097 is the zero-based number of the glyph row and X is the zero-based
22098 glyph number in the row, starting from left, where to start
22099 displaying the item.
22101 SUBMENU means this menu item drops down a submenu, which
22102 should be indicated by displaying a proper visual cue after the
22106 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
22107 int x
, int y
, bool submenu
)
22110 struct frame
*f
= SELECTED_FRAME ();
22111 struct window
*w
= XWINDOW (f
->selected_window
);
22112 struct glyph_row
*row
;
22113 size_t item_len
= strlen (item_text
);
22115 eassert (FRAME_TERMCAP_P (f
));
22117 /* Don't write beyond the matrix's last row. This can happen for
22118 TTY screens that are not high enough to show the entire menu.
22119 (This is actually a bit of defensive programming, as
22120 tty_menu_display already limits the number of menu items to one
22121 less than the number of screen lines.) */
22122 if (y
>= f
->desired_matrix
->nrows
)
22125 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
22126 it
.first_visible_x
= 0;
22127 it
.last_visible_x
= FRAME_COLS (f
) - 1;
22128 row
= it
.glyph_row
;
22129 /* Start with the row contents from the current matrix. */
22130 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
22131 bool saved_width
= row
->full_width_p
;
22132 row
->full_width_p
= true;
22133 bool saved_reversed
= row
->reversed_p
;
22134 row
->reversed_p
= false;
22135 row
->enabled_p
= true;
22137 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22139 eassert (x
< f
->desired_matrix
->matrix_w
);
22140 it
.current_x
= it
.hpos
= x
;
22141 it
.current_y
= it
.vpos
= y
;
22142 int saved_used
= row
->used
[TEXT_AREA
];
22143 bool saved_truncated
= row
->truncated_on_right_p
;
22144 row
->used
[TEXT_AREA
] = x
;
22145 it
.face_id
= face_id
;
22146 it
.line_wrap
= TRUNCATE
;
22148 /* FIXME: This should be controlled by a user option. See the
22149 comments in redisplay_tool_bar and display_mode_line about this.
22150 Also, if paragraph_embedding could ever be R2L, changes will be
22151 needed to avoid shifting to the right the row characters in
22152 term.c:append_glyph. */
22153 it
.paragraph_embedding
= L2R
;
22155 /* Pad with a space on the left. */
22156 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22158 /* Display the menu item, pad with spaces to WIDTH. */
22161 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22162 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22164 /* Indicate with " >" that there's a submenu. */
22165 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22166 FRAME_COLS (f
) - 1, -1);
22169 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22170 width
, 0, FRAME_COLS (f
) - 1, -1);
22172 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22173 row
->truncated_on_right_p
= saved_truncated
;
22174 row
->hash
= row_hash (row
);
22175 row
->full_width_p
= saved_width
;
22176 row
->reversed_p
= saved_reversed
;
22179 /***********************************************************************
22181 ***********************************************************************/
22183 /* Redisplay mode lines in the window tree whose root is WINDOW.
22184 If FORCE, redisplay mode lines unconditionally.
22185 Otherwise, redisplay only mode lines that are garbaged. Value is
22186 the number of windows whose mode lines were redisplayed. */
22189 redisplay_mode_lines (Lisp_Object window
, bool force
)
22193 while (!NILP (window
))
22195 struct window
*w
= XWINDOW (window
);
22197 if (WINDOWP (w
->contents
))
22198 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22200 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22201 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22203 struct text_pos lpoint
;
22204 struct buffer
*old
= current_buffer
;
22206 /* Set the window's buffer for the mode line display. */
22207 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22208 set_buffer_internal_1 (XBUFFER (w
->contents
));
22210 /* Point refers normally to the selected window. For any
22211 other window, set up appropriate value. */
22212 if (!EQ (window
, selected_window
))
22214 struct text_pos pt
;
22216 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22217 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22220 /* Display mode lines. */
22221 clear_glyph_matrix (w
->desired_matrix
);
22222 if (display_mode_lines (w
))
22225 /* Restore old settings. */
22226 set_buffer_internal_1 (old
);
22227 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22237 /* Display the mode and/or header line of window W. Value is the
22238 sum number of mode lines and header lines displayed. */
22241 display_mode_lines (struct window
*w
)
22243 Lisp_Object old_selected_window
= selected_window
;
22244 Lisp_Object old_selected_frame
= selected_frame
;
22245 Lisp_Object new_frame
= w
->frame
;
22246 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22249 selected_frame
= new_frame
;
22250 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22251 or window's point, then we'd need select_window_1 here as well. */
22252 XSETWINDOW (selected_window
, w
);
22253 XFRAME (new_frame
)->selected_window
= selected_window
;
22255 /* These will be set while the mode line specs are processed. */
22256 line_number_displayed
= false;
22257 w
->column_number_displayed
= -1;
22259 if (WINDOW_WANTS_MODELINE_P (w
))
22261 struct window
*sel_w
= XWINDOW (old_selected_window
);
22263 /* Select mode line face based on the real selected window. */
22264 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22265 BVAR (current_buffer
, mode_line_format
));
22269 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22271 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22272 BVAR (current_buffer
, header_line_format
));
22276 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22277 selected_frame
= old_selected_frame
;
22278 selected_window
= old_selected_window
;
22280 w
->must_be_updated_p
= true;
22285 /* Display mode or header line of window W. FACE_ID specifies which
22286 line to display; it is either MODE_LINE_FACE_ID or
22287 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22288 display. Value is the pixel height of the mode/header line
22292 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22296 ptrdiff_t count
= SPECPDL_INDEX ();
22298 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22299 /* Don't extend on a previously drawn mode-line.
22300 This may happen if called from pos_visible_p. */
22301 it
.glyph_row
->enabled_p
= false;
22302 prepare_desired_row (w
, it
.glyph_row
, true);
22304 it
.glyph_row
->mode_line_p
= true;
22306 /* FIXME: This should be controlled by a user option. But
22307 supporting such an option is not trivial, since the mode line is
22308 made up of many separate strings. */
22309 it
.paragraph_embedding
= L2R
;
22311 record_unwind_protect (unwind_format_mode_line
,
22312 format_mode_line_unwind_data (NULL
, NULL
,
22315 mode_line_target
= MODE_LINE_DISPLAY
;
22317 /* Temporarily make frame's keyboard the current kboard so that
22318 kboard-local variables in the mode_line_format will get the right
22320 push_kboard (FRAME_KBOARD (it
.f
));
22321 record_unwind_save_match_data ();
22322 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22325 unbind_to (count
, Qnil
);
22327 /* Fill up with spaces. */
22328 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22330 compute_line_metrics (&it
);
22331 it
.glyph_row
->full_width_p
= true;
22332 it
.glyph_row
->continued_p
= false;
22333 it
.glyph_row
->truncated_on_left_p
= false;
22334 it
.glyph_row
->truncated_on_right_p
= false;
22336 /* Make a 3D mode-line have a shadow at its right end. */
22337 face
= FACE_FROM_ID (it
.f
, face_id
);
22338 extend_face_to_end_of_line (&it
);
22339 if (face
->box
!= FACE_NO_BOX
)
22341 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22342 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22343 last
->right_box_line_p
= true;
22346 return it
.glyph_row
->height
;
22349 /* Move element ELT in LIST to the front of LIST.
22350 Return the updated list. */
22353 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22355 register Lisp_Object tail
, prev
;
22356 register Lisp_Object tem
;
22360 while (CONSP (tail
))
22366 /* Splice out the link TAIL. */
22368 list
= XCDR (tail
);
22370 Fsetcdr (prev
, XCDR (tail
));
22372 /* Now make it the first. */
22373 Fsetcdr (tail
, list
);
22378 tail
= XCDR (tail
);
22382 /* Not found--return unchanged LIST. */
22386 /* Contribute ELT to the mode line for window IT->w. How it
22387 translates into text depends on its data type.
22389 IT describes the display environment in which we display, as usual.
22391 DEPTH is the depth in recursion. It is used to prevent
22392 infinite recursion here.
22394 FIELD_WIDTH is the number of characters the display of ELT should
22395 occupy in the mode line, and PRECISION is the maximum number of
22396 characters to display from ELT's representation. See
22397 display_string for details.
22399 Returns the hpos of the end of the text generated by ELT.
22401 PROPS is a property list to add to any string we encounter.
22403 If RISKY, remove (disregard) any properties in any string
22404 we encounter, and ignore :eval and :propertize.
22406 The global variable `mode_line_target' determines whether the
22407 output is passed to `store_mode_line_noprop',
22408 `store_mode_line_string', or `display_string'. */
22411 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22412 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22414 int n
= 0, field
, prec
;
22415 bool literal
= false;
22419 elt
= build_string ("*too-deep*");
22423 switch (XTYPE (elt
))
22427 /* A string: output it and check for %-constructs within it. */
22429 ptrdiff_t offset
= 0;
22431 if (SCHARS (elt
) > 0
22432 && (!NILP (props
) || risky
))
22434 Lisp_Object oprops
, aelt
;
22435 oprops
= Ftext_properties_at (make_number (0), elt
);
22437 /* If the starting string's properties are not what
22438 we want, translate the string. Also, if the string
22439 is risky, do that anyway. */
22441 if (NILP (Fequal (props
, oprops
)) || risky
)
22443 /* If the starting string has properties,
22444 merge the specified ones onto the existing ones. */
22445 if (! NILP (oprops
) && !risky
)
22449 oprops
= Fcopy_sequence (oprops
);
22451 while (CONSP (tem
))
22453 oprops
= Fplist_put (oprops
, XCAR (tem
),
22454 XCAR (XCDR (tem
)));
22455 tem
= XCDR (XCDR (tem
));
22460 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22461 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22463 /* AELT is what we want. Move it to the front
22464 without consing. */
22466 mode_line_proptrans_alist
22467 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22473 /* If AELT has the wrong props, it is useless.
22474 so get rid of it. */
22476 mode_line_proptrans_alist
22477 = Fdelq (aelt
, mode_line_proptrans_alist
);
22479 elt
= Fcopy_sequence (elt
);
22480 Fset_text_properties (make_number (0), Flength (elt
),
22482 /* Add this item to mode_line_proptrans_alist. */
22483 mode_line_proptrans_alist
22484 = Fcons (Fcons (elt
, props
),
22485 mode_line_proptrans_alist
);
22486 /* Truncate mode_line_proptrans_alist
22487 to at most 50 elements. */
22488 tem
= Fnthcdr (make_number (50),
22489 mode_line_proptrans_alist
);
22491 XSETCDR (tem
, Qnil
);
22500 prec
= precision
- n
;
22501 switch (mode_line_target
)
22503 case MODE_LINE_NOPROP
:
22504 case MODE_LINE_TITLE
:
22505 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22507 case MODE_LINE_STRING
:
22508 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22510 case MODE_LINE_DISPLAY
:
22511 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22512 0, prec
, 0, STRING_MULTIBYTE (elt
));
22519 /* Handle the non-literal case. */
22521 while ((precision
<= 0 || n
< precision
)
22522 && SREF (elt
, offset
) != 0
22523 && (mode_line_target
!= MODE_LINE_DISPLAY
22524 || it
->current_x
< it
->last_visible_x
))
22526 ptrdiff_t last_offset
= offset
;
22528 /* Advance to end of string or next format specifier. */
22529 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22532 if (offset
- 1 != last_offset
)
22534 ptrdiff_t nchars
, nbytes
;
22536 /* Output to end of string or up to '%'. Field width
22537 is length of string. Don't output more than
22538 PRECISION allows us. */
22541 prec
= c_string_width (SDATA (elt
) + last_offset
,
22542 offset
- last_offset
, precision
- n
,
22545 switch (mode_line_target
)
22547 case MODE_LINE_NOPROP
:
22548 case MODE_LINE_TITLE
:
22549 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22551 case MODE_LINE_STRING
:
22553 ptrdiff_t bytepos
= last_offset
;
22554 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22555 ptrdiff_t endpos
= (precision
<= 0
22556 ? string_byte_to_char (elt
, offset
)
22557 : charpos
+ nchars
);
22558 Lisp_Object mode_string
22559 = Fsubstring (elt
, make_number (charpos
),
22560 make_number (endpos
));
22561 n
+= store_mode_line_string (NULL
, mode_string
, false,
22565 case MODE_LINE_DISPLAY
:
22567 ptrdiff_t bytepos
= last_offset
;
22568 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22570 if (precision
<= 0)
22571 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22572 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22574 STRING_MULTIBYTE (elt
));
22579 else /* c == '%' */
22581 ptrdiff_t percent_position
= offset
;
22583 /* Get the specified minimum width. Zero means
22586 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22587 field
= field
* 10 + c
- '0';
22589 /* Don't pad beyond the total padding allowed. */
22590 if (field_width
- n
> 0 && field
> field_width
- n
)
22591 field
= field_width
- n
;
22593 /* Note that either PRECISION <= 0 or N < PRECISION. */
22594 prec
= precision
- n
;
22597 n
+= display_mode_element (it
, depth
, field
, prec
,
22598 Vglobal_mode_string
, props
,
22603 ptrdiff_t bytepos
, charpos
;
22605 Lisp_Object string
;
22607 bytepos
= percent_position
;
22608 charpos
= (STRING_MULTIBYTE (elt
)
22609 ? string_byte_to_char (elt
, bytepos
)
22611 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22612 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22614 switch (mode_line_target
)
22616 case MODE_LINE_NOPROP
:
22617 case MODE_LINE_TITLE
:
22618 n
+= store_mode_line_noprop (spec
, field
, prec
);
22620 case MODE_LINE_STRING
:
22622 Lisp_Object tem
= build_string (spec
);
22623 props
= Ftext_properties_at (make_number (charpos
), elt
);
22624 /* Should only keep face property in props */
22625 n
+= store_mode_line_string (NULL
, tem
, false,
22626 field
, prec
, props
);
22629 case MODE_LINE_DISPLAY
:
22631 int nglyphs_before
, nwritten
;
22633 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22634 nwritten
= display_string (spec
, string
, elt
,
22639 /* Assign to the glyphs written above the
22640 string where the `%x' came from, position
22644 struct glyph
*glyph
22645 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22649 for (i
= 0; i
< nwritten
; ++i
)
22651 glyph
[i
].object
= elt
;
22652 glyph
[i
].charpos
= charpos
;
22669 /* A symbol: process the value of the symbol recursively
22670 as if it appeared here directly. Avoid error if symbol void.
22671 Special case: if value of symbol is a string, output the string
22674 register Lisp_Object tem
;
22676 /* If the variable is not marked as risky to set
22677 then its contents are risky to use. */
22678 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22681 tem
= Fboundp (elt
);
22684 tem
= Fsymbol_value (elt
);
22685 /* If value is a string, output that string literally:
22686 don't check for % within it. */
22690 if (!EQ (tem
, elt
))
22692 /* Give up right away for nil or t. */
22702 register Lisp_Object car
, tem
;
22704 /* A cons cell: five distinct cases.
22705 If first element is :eval or :propertize, do something special.
22706 If first element is a string or a cons, process all the elements
22707 and effectively concatenate them.
22708 If first element is a negative number, truncate displaying cdr to
22709 at most that many characters. If positive, pad (with spaces)
22710 to at least that many characters.
22711 If first element is a symbol, process the cadr or caddr recursively
22712 according to whether the symbol's value is non-nil or nil. */
22714 if (EQ (car
, QCeval
))
22716 /* An element of the form (:eval FORM) means evaluate FORM
22717 and use the result as mode line elements. */
22722 if (CONSP (XCDR (elt
)))
22725 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22726 n
+= display_mode_element (it
, depth
, field_width
- n
,
22727 precision
- n
, spec
, props
,
22731 else if (EQ (car
, QCpropertize
))
22733 /* An element of the form (:propertize ELT PROPS...)
22734 means display ELT but applying properties PROPS. */
22739 if (CONSP (XCDR (elt
)))
22740 n
+= display_mode_element (it
, depth
, field_width
- n
,
22741 precision
- n
, XCAR (XCDR (elt
)),
22742 XCDR (XCDR (elt
)), risky
);
22744 else if (SYMBOLP (car
))
22746 tem
= Fboundp (car
);
22750 /* elt is now the cdr, and we know it is a cons cell.
22751 Use its car if CAR has a non-nil value. */
22754 tem
= Fsymbol_value (car
);
22761 /* Symbol's value is nil (or symbol is unbound)
22762 Get the cddr of the original list
22763 and if possible find the caddr and use that. */
22767 else if (!CONSP (elt
))
22772 else if (INTEGERP (car
))
22774 register int lim
= XINT (car
);
22778 /* Negative int means reduce maximum width. */
22779 if (precision
<= 0)
22782 precision
= min (precision
, -lim
);
22786 /* Padding specified. Don't let it be more than
22787 current maximum. */
22789 lim
= min (precision
, lim
);
22791 /* If that's more padding than already wanted, queue it.
22792 But don't reduce padding already specified even if
22793 that is beyond the current truncation point. */
22794 field_width
= max (lim
, field_width
);
22798 else if (STRINGP (car
) || CONSP (car
))
22800 Lisp_Object halftail
= elt
;
22804 && (precision
<= 0 || n
< precision
))
22806 n
+= display_mode_element (it
, depth
,
22807 /* Do padding only after the last
22808 element in the list. */
22809 (! CONSP (XCDR (elt
))
22812 precision
- n
, XCAR (elt
),
22816 if ((len
& 1) == 0)
22817 halftail
= XCDR (halftail
);
22818 /* Check for cycle. */
22819 if (EQ (halftail
, elt
))
22828 elt
= build_string ("*invalid*");
22832 /* Pad to FIELD_WIDTH. */
22833 if (field_width
> 0 && n
< field_width
)
22835 switch (mode_line_target
)
22837 case MODE_LINE_NOPROP
:
22838 case MODE_LINE_TITLE
:
22839 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22841 case MODE_LINE_STRING
:
22842 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22845 case MODE_LINE_DISPLAY
:
22846 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22855 /* Store a mode-line string element in mode_line_string_list.
22857 If STRING is non-null, display that C string. Otherwise, the Lisp
22858 string LISP_STRING is displayed.
22860 FIELD_WIDTH is the minimum number of output glyphs to produce.
22861 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22862 with spaces. FIELD_WIDTH <= 0 means don't pad.
22864 PRECISION is the maximum number of characters to output from
22865 STRING. PRECISION <= 0 means don't truncate the string.
22867 If COPY_STRING, make a copy of LISP_STRING before adding
22868 properties to the string.
22870 PROPS are the properties to add to the string.
22871 The mode_line_string_face face property is always added to the string.
22875 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22877 int field_width
, int precision
, Lisp_Object props
)
22882 if (string
!= NULL
)
22884 len
= strlen (string
);
22885 if (precision
> 0 && len
> precision
)
22887 lisp_string
= make_string (string
, len
);
22889 props
= mode_line_string_face_prop
;
22890 else if (!NILP (mode_line_string_face
))
22892 Lisp_Object face
= Fplist_get (props
, Qface
);
22893 props
= Fcopy_sequence (props
);
22895 face
= mode_line_string_face
;
22897 face
= list2 (face
, mode_line_string_face
);
22898 props
= Fplist_put (props
, Qface
, face
);
22900 Fadd_text_properties (make_number (0), make_number (len
),
22901 props
, lisp_string
);
22905 len
= XFASTINT (Flength (lisp_string
));
22906 if (precision
> 0 && len
> precision
)
22909 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22912 if (!NILP (mode_line_string_face
))
22916 props
= Ftext_properties_at (make_number (0), lisp_string
);
22917 face
= Fplist_get (props
, Qface
);
22919 face
= mode_line_string_face
;
22921 face
= list2 (face
, mode_line_string_face
);
22922 props
= list2 (Qface
, face
);
22924 lisp_string
= Fcopy_sequence (lisp_string
);
22927 Fadd_text_properties (make_number (0), make_number (len
),
22928 props
, lisp_string
);
22933 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22937 if (field_width
> len
)
22939 field_width
-= len
;
22940 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22942 Fadd_text_properties (make_number (0), make_number (field_width
),
22943 props
, lisp_string
);
22944 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22952 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22954 doc
: /* Format a string out of a mode line format specification.
22955 First arg FORMAT specifies the mode line format (see `mode-line-format'
22956 for details) to use.
22958 By default, the format is evaluated for the currently selected window.
22960 Optional second arg FACE specifies the face property to put on all
22961 characters for which no face is specified. The value nil means the
22962 default face. The value t means whatever face the window's mode line
22963 currently uses (either `mode-line' or `mode-line-inactive',
22964 depending on whether the window is the selected window or not).
22965 An integer value means the value string has no text
22968 Optional third and fourth args WINDOW and BUFFER specify the window
22969 and buffer to use as the context for the formatting (defaults
22970 are the selected window and the WINDOW's buffer). */)
22971 (Lisp_Object format
, Lisp_Object face
,
22972 Lisp_Object window
, Lisp_Object buffer
)
22977 struct buffer
*old_buffer
= NULL
;
22979 bool no_props
= INTEGERP (face
);
22980 ptrdiff_t count
= SPECPDL_INDEX ();
22982 int string_start
= 0;
22984 w
= decode_any_window (window
);
22985 XSETWINDOW (window
, w
);
22988 buffer
= w
->contents
;
22989 CHECK_BUFFER (buffer
);
22991 /* Make formatting the modeline a non-op when noninteractive, otherwise
22992 there will be problems later caused by a partially initialized frame. */
22993 if (NILP (format
) || noninteractive
)
22994 return empty_unibyte_string
;
22999 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
23000 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
23001 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
23002 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
23003 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
23004 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
23005 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
23008 old_buffer
= current_buffer
;
23010 /* Save things including mode_line_proptrans_alist,
23011 and set that to nil so that we don't alter the outer value. */
23012 record_unwind_protect (unwind_format_mode_line
,
23013 format_mode_line_unwind_data
23014 (XFRAME (WINDOW_FRAME (w
)),
23015 old_buffer
, selected_window
, true));
23016 mode_line_proptrans_alist
= Qnil
;
23018 Fselect_window (window
, Qt
);
23019 set_buffer_internal_1 (XBUFFER (buffer
));
23021 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
23025 mode_line_target
= MODE_LINE_NOPROP
;
23026 mode_line_string_face_prop
= Qnil
;
23027 mode_line_string_list
= Qnil
;
23028 string_start
= MODE_LINE_NOPROP_LEN (0);
23032 mode_line_target
= MODE_LINE_STRING
;
23033 mode_line_string_list
= Qnil
;
23034 mode_line_string_face
= face
;
23035 mode_line_string_face_prop
23036 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
23039 push_kboard (FRAME_KBOARD (it
.f
));
23040 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
23045 len
= MODE_LINE_NOPROP_LEN (string_start
);
23046 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
23050 mode_line_string_list
= Fnreverse (mode_line_string_list
);
23051 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
23052 empty_unibyte_string
);
23055 unbind_to (count
, Qnil
);
23059 /* Write a null-terminated, right justified decimal representation of
23060 the positive integer D to BUF using a minimal field width WIDTH. */
23063 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
23065 register char *p
= buf
;
23073 *p
++ = d
% 10 + '0';
23078 for (width
-= (int) (p
- buf
); width
> 0; --width
)
23089 /* Write a null-terminated, right justified decimal and "human
23090 readable" representation of the nonnegative integer D to BUF using
23091 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23093 static const char power_letter
[] =
23107 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
23109 /* We aim to represent the nonnegative integer D as
23110 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23111 ptrdiff_t quotient
= d
;
23113 /* -1 means: do not use TENTHS. */
23117 /* Length of QUOTIENT.TENTHS as a string. */
23123 if (quotient
>= 1000)
23125 /* Scale to the appropriate EXPONENT. */
23128 remainder
= quotient
% 1000;
23132 while (quotient
>= 1000);
23134 /* Round to nearest and decide whether to use TENTHS or not. */
23137 tenths
= remainder
/ 100;
23138 if (remainder
% 100 >= 50)
23145 if (quotient
== 10)
23153 if (remainder
>= 500)
23155 if (quotient
< 999)
23166 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23167 if (tenths
== -1 && quotient
<= 99)
23174 p
= psuffix
= buf
+ max (width
, length
);
23176 /* Print EXPONENT. */
23177 *psuffix
++ = power_letter
[exponent
];
23180 /* Print TENTHS. */
23183 *--p
= '0' + tenths
;
23187 /* Print QUOTIENT. */
23190 int digit
= quotient
% 10;
23191 *--p
= '0' + digit
;
23193 while ((quotient
/= 10) != 0);
23195 /* Print leading spaces. */
23200 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23201 If EOL_FLAG, set also a mnemonic character for end-of-line
23202 type of CODING_SYSTEM. Return updated pointer into BUF. */
23204 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23207 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23210 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23211 const unsigned char *eol_str
;
23213 /* The EOL conversion we are using. */
23214 Lisp_Object eoltype
;
23216 val
= CODING_SYSTEM_SPEC (coding_system
);
23219 if (!VECTORP (val
)) /* Not yet decided. */
23221 *buf
++ = multibyte
? '-' : ' ';
23223 eoltype
= eol_mnemonic_undecided
;
23224 /* Don't mention EOL conversion if it isn't decided. */
23229 Lisp_Object eolvalue
;
23231 attrs
= AREF (val
, 0);
23232 eolvalue
= AREF (val
, 2);
23235 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23240 /* The EOL conversion that is normal on this system. */
23242 if (NILP (eolvalue
)) /* Not yet decided. */
23243 eoltype
= eol_mnemonic_undecided
;
23244 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23245 eoltype
= eol_mnemonic_undecided
;
23246 else /* eolvalue is Qunix, Qdos, or Qmac. */
23247 eoltype
= (EQ (eolvalue
, Qunix
)
23248 ? eol_mnemonic_unix
23249 : EQ (eolvalue
, Qdos
)
23250 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23256 /* Mention the EOL conversion if it is not the usual one. */
23257 if (STRINGP (eoltype
))
23259 eol_str
= SDATA (eoltype
);
23260 eol_str_len
= SBYTES (eoltype
);
23262 else if (CHARACTERP (eoltype
))
23264 int c
= XFASTINT (eoltype
);
23265 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23269 eol_str
= invalid_eol_type
;
23270 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23272 memcpy (buf
, eol_str
, eol_str_len
);
23273 buf
+= eol_str_len
;
23279 /* Return a string for the output of a mode line %-spec for window W,
23280 generated by character C. FIELD_WIDTH > 0 means pad the string
23281 returned with spaces to that value. Return a Lisp string in
23282 *STRING if the resulting string is taken from that Lisp string.
23284 Note we operate on the current buffer for most purposes. */
23286 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23288 static const char *
23289 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23290 Lisp_Object
*string
)
23293 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23294 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23295 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23296 produce strings from numerical values, so limit preposterously
23297 large values of FIELD_WIDTH to avoid overrunning the buffer's
23298 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23299 bytes plus the terminating null. */
23300 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23301 struct buffer
*b
= current_buffer
;
23309 if (!NILP (BVAR (b
, read_only
)))
23311 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23316 /* This differs from %* only for a modified read-only buffer. */
23317 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23319 if (!NILP (BVAR (b
, read_only
)))
23324 /* This differs from %* in ignoring read-only-ness. */
23325 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23337 if (command_loop_level
> 5)
23339 p
= decode_mode_spec_buf
;
23340 for (i
= 0; i
< command_loop_level
; i
++)
23343 return decode_mode_spec_buf
;
23351 if (command_loop_level
> 5)
23353 p
= decode_mode_spec_buf
;
23354 for (i
= 0; i
< command_loop_level
; i
++)
23357 return decode_mode_spec_buf
;
23364 /* Let lots_of_dashes be a string of infinite length. */
23365 if (mode_line_target
== MODE_LINE_NOPROP
23366 || mode_line_target
== MODE_LINE_STRING
)
23368 if (field_width
<= 0
23369 || field_width
> sizeof (lots_of_dashes
))
23371 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23372 decode_mode_spec_buf
[i
] = '-';
23373 decode_mode_spec_buf
[i
] = '\0';
23374 return decode_mode_spec_buf
;
23377 return lots_of_dashes
;
23381 obj
= BVAR (b
, name
);
23385 /* %c and %l are ignored in `frame-title-format'.
23386 (In redisplay_internal, the frame title is drawn _before_ the
23387 windows are updated, so the stuff which depends on actual
23388 window contents (such as %l) may fail to render properly, or
23389 even crash emacs.) */
23390 if (mode_line_target
== MODE_LINE_TITLE
)
23394 ptrdiff_t col
= current_column ();
23395 w
->column_number_displayed
= col
;
23396 pint2str (decode_mode_spec_buf
, width
, col
);
23397 return decode_mode_spec_buf
;
23401 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23403 if (NILP (Vmemory_full
))
23406 return "!MEM FULL! ";
23413 /* %F displays the frame name. */
23414 if (!NILP (f
->title
))
23415 return SSDATA (f
->title
);
23416 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23417 return SSDATA (f
->name
);
23421 obj
= BVAR (b
, filename
);
23426 ptrdiff_t size
= ZV
- BEGV
;
23427 pint2str (decode_mode_spec_buf
, width
, size
);
23428 return decode_mode_spec_buf
;
23433 ptrdiff_t size
= ZV
- BEGV
;
23434 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23435 return decode_mode_spec_buf
;
23440 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23441 ptrdiff_t topline
, nlines
, height
;
23444 /* %c and %l are ignored in `frame-title-format'. */
23445 if (mode_line_target
== MODE_LINE_TITLE
)
23448 startpos
= marker_position (w
->start
);
23449 startpos_byte
= marker_byte_position (w
->start
);
23450 height
= WINDOW_TOTAL_LINES (w
);
23452 /* If we decided that this buffer isn't suitable for line numbers,
23453 don't forget that too fast. */
23454 if (w
->base_line_pos
== -1)
23457 /* If the buffer is very big, don't waste time. */
23458 if (INTEGERP (Vline_number_display_limit
)
23459 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23461 w
->base_line_pos
= 0;
23462 w
->base_line_number
= 0;
23466 if (w
->base_line_number
> 0
23467 && w
->base_line_pos
> 0
23468 && w
->base_line_pos
<= startpos
)
23470 line
= w
->base_line_number
;
23471 linepos
= w
->base_line_pos
;
23472 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23477 linepos
= BUF_BEGV (b
);
23478 linepos_byte
= BUF_BEGV_BYTE (b
);
23481 /* Count lines from base line to window start position. */
23482 nlines
= display_count_lines (linepos_byte
,
23486 topline
= nlines
+ line
;
23488 /* Determine a new base line, if the old one is too close
23489 or too far away, or if we did not have one.
23490 "Too close" means it's plausible a scroll-down would
23491 go back past it. */
23492 if (startpos
== BUF_BEGV (b
))
23494 w
->base_line_number
= topline
;
23495 w
->base_line_pos
= BUF_BEGV (b
);
23497 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23498 || linepos
== BUF_BEGV (b
))
23500 ptrdiff_t limit
= BUF_BEGV (b
);
23501 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23502 ptrdiff_t position
;
23503 ptrdiff_t distance
=
23504 (height
* 2 + 30) * line_number_display_limit_width
;
23506 if (startpos
- distance
> limit
)
23508 limit
= startpos
- distance
;
23509 limit_byte
= CHAR_TO_BYTE (limit
);
23512 nlines
= display_count_lines (startpos_byte
,
23514 - (height
* 2 + 30),
23516 /* If we couldn't find the lines we wanted within
23517 line_number_display_limit_width chars per line,
23518 give up on line numbers for this window. */
23519 if (position
== limit_byte
&& limit
== startpos
- distance
)
23521 w
->base_line_pos
= -1;
23522 w
->base_line_number
= 0;
23526 w
->base_line_number
= topline
- nlines
;
23527 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23530 /* Now count lines from the start pos to point. */
23531 nlines
= display_count_lines (startpos_byte
,
23532 PT_BYTE
, PT
, &junk
);
23534 /* Record that we did display the line number. */
23535 line_number_displayed
= true;
23537 /* Make the string to show. */
23538 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23539 return decode_mode_spec_buf
;
23542 char *p
= decode_mode_spec_buf
;
23543 int pad
= width
- 2;
23549 return decode_mode_spec_buf
;
23555 obj
= BVAR (b
, mode_name
);
23559 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23565 ptrdiff_t pos
= marker_position (w
->start
);
23566 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23568 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23570 if (pos
<= BUF_BEGV (b
))
23575 else if (pos
<= BUF_BEGV (b
))
23579 if (total
> 1000000)
23580 /* Do it differently for a large value, to avoid overflow. */
23581 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23583 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23584 /* We can't normally display a 3-digit number,
23585 so get us a 2-digit number that is close. */
23588 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23589 return decode_mode_spec_buf
;
23593 /* Display percentage of size above the bottom of the screen. */
23596 ptrdiff_t toppos
= marker_position (w
->start
);
23597 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23598 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23600 if (botpos
>= BUF_ZV (b
))
23602 if (toppos
<= BUF_BEGV (b
))
23609 if (total
> 1000000)
23610 /* Do it differently for a large value, to avoid overflow. */
23611 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23613 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23614 /* We can't normally display a 3-digit number,
23615 so get us a 2-digit number that is close. */
23618 if (toppos
<= BUF_BEGV (b
))
23619 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23621 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23622 return decode_mode_spec_buf
;
23627 /* status of process */
23628 obj
= Fget_buffer_process (Fcurrent_buffer ());
23630 return "no process";
23632 obj
= Fsymbol_name (Fprocess_status (obj
));
23638 ptrdiff_t count
= inhibit_garbage_collection ();
23639 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23640 Lisp_Object val
= Qnil
;
23642 if (STRINGP (curdir
))
23643 val
= call1 (intern ("file-remote-p"), curdir
);
23645 unbind_to (count
, Qnil
);
23654 /* coding-system (not including end-of-line format) */
23656 /* coding-system (including end-of-line type) */
23658 bool eol_flag
= (c
== 'Z');
23659 char *p
= decode_mode_spec_buf
;
23661 if (! FRAME_WINDOW_P (f
))
23663 /* No need to mention EOL here--the terminal never needs
23664 to do EOL conversion. */
23665 p
= decode_mode_spec_coding (CODING_ID_NAME
23666 (FRAME_KEYBOARD_CODING (f
)->id
),
23668 p
= decode_mode_spec_coding (CODING_ID_NAME
23669 (FRAME_TERMINAL_CODING (f
)->id
),
23672 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23675 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23676 #ifdef subprocesses
23677 obj
= Fget_buffer_process (Fcurrent_buffer ());
23678 if (PROCESSP (obj
))
23680 p
= decode_mode_spec_coding
23681 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23682 p
= decode_mode_spec_coding
23683 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23685 #endif /* subprocesses */
23688 return decode_mode_spec_buf
;
23695 return SSDATA (obj
);
23702 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23703 means count lines back from START_BYTE. But don't go beyond
23704 LIMIT_BYTE. Return the number of lines thus found (always
23707 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23708 either the position COUNT lines after/before START_BYTE, if we
23709 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23713 display_count_lines (ptrdiff_t start_byte
,
23714 ptrdiff_t limit_byte
, ptrdiff_t count
,
23715 ptrdiff_t *byte_pos_ptr
)
23717 register unsigned char *cursor
;
23718 unsigned char *base
;
23720 register ptrdiff_t ceiling
;
23721 register unsigned char *ceiling_addr
;
23722 ptrdiff_t orig_count
= count
;
23724 /* If we are not in selective display mode,
23725 check only for newlines. */
23726 bool selective_display
23727 = (!NILP (BVAR (current_buffer
, selective_display
))
23728 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23732 while (start_byte
< limit_byte
)
23734 ceiling
= BUFFER_CEILING_OF (start_byte
);
23735 ceiling
= min (limit_byte
- 1, ceiling
);
23736 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23737 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23741 if (selective_display
)
23743 while (*cursor
!= '\n' && *cursor
!= 015
23744 && ++cursor
!= ceiling_addr
)
23746 if (cursor
== ceiling_addr
)
23751 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23760 start_byte
+= cursor
- base
;
23761 *byte_pos_ptr
= start_byte
;
23765 while (cursor
< ceiling_addr
);
23767 start_byte
+= ceiling_addr
- base
;
23772 while (start_byte
> limit_byte
)
23774 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23775 ceiling
= max (limit_byte
, ceiling
);
23776 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23777 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23780 if (selective_display
)
23782 while (--cursor
>= ceiling_addr
23783 && *cursor
!= '\n' && *cursor
!= 015)
23785 if (cursor
< ceiling_addr
)
23790 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23797 start_byte
+= cursor
- base
+ 1;
23798 *byte_pos_ptr
= start_byte
;
23799 /* When scanning backwards, we should
23800 not count the newline posterior to which we stop. */
23801 return - orig_count
- 1;
23804 start_byte
+= ceiling_addr
- base
;
23808 *byte_pos_ptr
= limit_byte
;
23811 return - orig_count
+ count
;
23812 return orig_count
- count
;
23818 /***********************************************************************
23820 ***********************************************************************/
23822 /* Display a NUL-terminated string, starting with index START.
23824 If STRING is non-null, display that C string. Otherwise, the Lisp
23825 string LISP_STRING is displayed. There's a case that STRING is
23826 non-null and LISP_STRING is not nil. It means STRING is a string
23827 data of LISP_STRING. In that case, we display LISP_STRING while
23828 ignoring its text properties.
23830 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23831 FACE_STRING. Display STRING or LISP_STRING with the face at
23832 FACE_STRING_POS in FACE_STRING:
23834 Display the string in the environment given by IT, but use the
23835 standard display table, temporarily.
23837 FIELD_WIDTH is the minimum number of output glyphs to produce.
23838 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23839 with spaces. If STRING has more characters, more than FIELD_WIDTH
23840 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23842 PRECISION is the maximum number of characters to output from
23843 STRING. PRECISION < 0 means don't truncate the string.
23845 This is roughly equivalent to printf format specifiers:
23847 FIELD_WIDTH PRECISION PRINTF
23848 ----------------------------------------
23854 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23855 display them, and < 0 means obey the current buffer's value of
23856 enable_multibyte_characters.
23858 Value is the number of columns displayed. */
23861 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23862 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23863 int field_width
, int precision
, int max_x
, int multibyte
)
23865 int hpos_at_start
= it
->hpos
;
23866 int saved_face_id
= it
->face_id
;
23867 struct glyph_row
*row
= it
->glyph_row
;
23868 ptrdiff_t it_charpos
;
23870 /* Initialize the iterator IT for iteration over STRING beginning
23871 with index START. */
23872 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23873 precision
, field_width
, multibyte
);
23874 if (string
&& STRINGP (lisp_string
))
23875 /* LISP_STRING is the one returned by decode_mode_spec. We should
23876 ignore its text properties. */
23877 it
->stop_charpos
= it
->end_charpos
;
23879 /* If displaying STRING, set up the face of the iterator from
23880 FACE_STRING, if that's given. */
23881 if (STRINGP (face_string
))
23887 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23888 0, &endptr
, it
->base_face_id
, false);
23889 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23890 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23893 /* Set max_x to the maximum allowed X position. Don't let it go
23894 beyond the right edge of the window. */
23896 max_x
= it
->last_visible_x
;
23898 max_x
= min (max_x
, it
->last_visible_x
);
23900 /* Skip over display elements that are not visible. because IT->w is
23902 if (it
->current_x
< it
->first_visible_x
)
23903 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23904 MOVE_TO_POS
| MOVE_TO_X
);
23906 row
->ascent
= it
->max_ascent
;
23907 row
->height
= it
->max_ascent
+ it
->max_descent
;
23908 row
->phys_ascent
= it
->max_phys_ascent
;
23909 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23910 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23912 if (STRINGP (it
->string
))
23913 it_charpos
= IT_STRING_CHARPOS (*it
);
23915 it_charpos
= IT_CHARPOS (*it
);
23917 /* This condition is for the case that we are called with current_x
23918 past last_visible_x. */
23919 while (it
->current_x
< max_x
)
23921 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23923 /* Get the next display element. */
23924 if (!get_next_display_element (it
))
23927 /* Produce glyphs. */
23928 x_before
= it
->current_x
;
23929 n_glyphs_before
= row
->used
[TEXT_AREA
];
23930 PRODUCE_GLYPHS (it
);
23932 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23935 while (i
< nglyphs
)
23937 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23939 if (it
->line_wrap
!= TRUNCATE
23940 && x
+ glyph
->pixel_width
> max_x
)
23942 /* End of continued line or max_x reached. */
23943 if (CHAR_GLYPH_PADDING_P (*glyph
))
23945 /* A wide character is unbreakable. */
23946 if (row
->reversed_p
)
23947 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23948 - n_glyphs_before
);
23949 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23950 it
->current_x
= x_before
;
23954 if (row
->reversed_p
)
23955 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23956 - (n_glyphs_before
+ i
));
23957 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23962 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23964 /* Glyph is at least partially visible. */
23966 if (x
< it
->first_visible_x
)
23967 row
->x
= x
- it
->first_visible_x
;
23971 /* Glyph is off the left margin of the display area.
23972 Should not happen. */
23976 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23977 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23978 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23979 row
->phys_height
= max (row
->phys_height
,
23980 it
->max_phys_ascent
+ it
->max_phys_descent
);
23981 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23982 it
->max_extra_line_spacing
);
23983 x
+= glyph
->pixel_width
;
23987 /* Stop if max_x reached. */
23991 /* Stop at line ends. */
23992 if (ITERATOR_AT_END_OF_LINE_P (it
))
23994 it
->continuation_lines_width
= 0;
23998 set_iterator_to_next (it
, true);
23999 if (STRINGP (it
->string
))
24000 it_charpos
= IT_STRING_CHARPOS (*it
);
24002 it_charpos
= IT_CHARPOS (*it
);
24004 /* Stop if truncating at the right edge. */
24005 if (it
->line_wrap
== TRUNCATE
24006 && it
->current_x
>= it
->last_visible_x
)
24008 /* Add truncation mark, but don't do it if the line is
24009 truncated at a padding space. */
24010 if (it_charpos
< it
->string_nchars
)
24012 if (!FRAME_WINDOW_P (it
->f
))
24016 if (it
->current_x
> it
->last_visible_x
)
24018 if (!row
->reversed_p
)
24020 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
24021 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24026 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
24027 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
24029 unproduce_glyphs (it
, ii
+ 1);
24030 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
24032 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
24034 row
->used
[TEXT_AREA
] = ii
;
24035 produce_special_glyphs (it
, IT_TRUNCATION
);
24038 produce_special_glyphs (it
, IT_TRUNCATION
);
24040 row
->truncated_on_right_p
= true;
24046 /* Maybe insert a truncation at the left. */
24047 if (it
->first_visible_x
24050 if (!FRAME_WINDOW_P (it
->f
)
24051 || (row
->reversed_p
24052 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24053 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
24054 insert_left_trunc_glyphs (it
);
24055 row
->truncated_on_left_p
= true;
24058 it
->face_id
= saved_face_id
;
24060 /* Value is number of columns displayed. */
24061 return it
->hpos
- hpos_at_start
;
24066 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24067 appears as an element of LIST or as the car of an element of LIST.
24068 If PROPVAL is a list, compare each element against LIST in that
24069 way, and return 1/2 if any element of PROPVAL is found in LIST.
24070 Otherwise return 0. This function cannot quit.
24071 The return value is 2 if the text is invisible but with an ellipsis
24072 and 1 if it's invisible and without an ellipsis. */
24075 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
24077 Lisp_Object tail
, proptail
;
24079 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24081 register Lisp_Object tem
;
24083 if (EQ (propval
, tem
))
24085 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
24086 return NILP (XCDR (tem
)) ? 1 : 2;
24089 if (CONSP (propval
))
24091 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
24093 Lisp_Object propelt
;
24094 propelt
= XCAR (proptail
);
24095 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
24097 register Lisp_Object tem
;
24099 if (EQ (propelt
, tem
))
24101 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
24102 return NILP (XCDR (tem
)) ? 1 : 2;
24110 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
24111 doc
: /* Non-nil if the property makes the text invisible.
24112 POS-OR-PROP can be a marker or number, in which case it is taken to be
24113 a position in the current buffer and the value of the `invisible' property
24114 is checked; or it can be some other value, which is then presumed to be the
24115 value of the `invisible' property of the text of interest.
24116 The non-nil value returned can be t for truly invisible text or something
24117 else if the text is replaced by an ellipsis. */)
24118 (Lisp_Object pos_or_prop
)
24121 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
24122 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
24124 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
24125 return (invis
== 0 ? Qnil
24127 : make_number (invis
));
24130 /* Calculate a width or height in pixels from a specification using
24131 the following elements:
24134 NUM - a (fractional) multiple of the default font width/height
24135 (NUM) - specifies exactly NUM pixels
24136 UNIT - a fixed number of pixels, see below.
24137 ELEMENT - size of a display element in pixels, see below.
24138 (NUM . SPEC) - equals NUM * SPEC
24139 (+ SPEC SPEC ...) - add pixel values
24140 (- SPEC SPEC ...) - subtract pixel values
24141 (- SPEC) - negate pixel value
24144 INT or FLOAT - a number constant
24145 SYMBOL - use symbol's (buffer local) variable binding.
24148 in - pixels per inch *)
24149 mm - pixels per 1/1000 meter *)
24150 cm - pixels per 1/100 meter *)
24151 width - width of current font in pixels.
24152 height - height of current font in pixels.
24154 *) using the ratio(s) defined in display-pixels-per-inch.
24158 left-fringe - left fringe width in pixels
24159 right-fringe - right fringe width in pixels
24161 left-margin - left margin width in pixels
24162 right-margin - right margin width in pixels
24164 scroll-bar - scroll-bar area width in pixels
24168 Pixels corresponding to 5 inches:
24171 Total width of non-text areas on left side of window (if scroll-bar is on left):
24172 '(space :width (+ left-fringe left-margin scroll-bar))
24174 Align to first text column (in header line):
24175 '(space :align-to 0)
24177 Align to middle of text area minus half the width of variable `my-image'
24178 containing a loaded image:
24179 '(space :align-to (0.5 . (- text my-image)))
24181 Width of left margin minus width of 1 character in the default font:
24182 '(space :width (- left-margin 1))
24184 Width of left margin minus width of 2 characters in the current font:
24185 '(space :width (- left-margin (2 . width)))
24187 Center 1 character over left-margin (in header line):
24188 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24190 Different ways to express width of left fringe plus left margin minus one pixel:
24191 '(space :width (- (+ left-fringe left-margin) (1)))
24192 '(space :width (+ left-fringe left-margin (- (1))))
24193 '(space :width (+ left-fringe left-margin (-1)))
24198 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24199 struct font
*font
, bool width_p
, int *align_to
)
24203 # define OK_PIXELS(val) (*res = (val), true)
24204 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24207 return OK_PIXELS (0);
24209 eassert (FRAME_LIVE_P (it
->f
));
24211 if (SYMBOLP (prop
))
24213 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24215 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24217 if (unit
[0] == 'i' && unit
[1] == 'n')
24219 else if (unit
[0] == 'm' && unit
[1] == 'm')
24221 else if (unit
[0] == 'c' && unit
[1] == 'm')
24227 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24228 : FRAME_RES_Y (it
->f
));
24231 return OK_PIXELS (ppi
/ pixels
);
24236 #ifdef HAVE_WINDOW_SYSTEM
24237 if (EQ (prop
, Qheight
))
24238 return OK_PIXELS (font
24239 ? normal_char_height (font
, -1)
24240 : FRAME_LINE_HEIGHT (it
->f
));
24241 if (EQ (prop
, Qwidth
))
24242 return OK_PIXELS (font
24243 ? FONT_WIDTH (font
)
24244 : FRAME_COLUMN_WIDTH (it
->f
));
24246 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24247 return OK_PIXELS (1);
24250 if (EQ (prop
, Qtext
))
24251 return OK_PIXELS (width_p
24252 ? window_box_width (it
->w
, TEXT_AREA
)
24253 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24255 if (align_to
&& *align_to
< 0)
24258 if (EQ (prop
, Qleft
))
24259 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24260 if (EQ (prop
, Qright
))
24261 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24262 if (EQ (prop
, Qcenter
))
24263 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24264 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24265 if (EQ (prop
, Qleft_fringe
))
24266 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24267 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24268 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24269 if (EQ (prop
, Qright_fringe
))
24270 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24271 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24272 : window_box_right_offset (it
->w
, TEXT_AREA
));
24273 if (EQ (prop
, Qleft_margin
))
24274 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24275 if (EQ (prop
, Qright_margin
))
24276 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24277 if (EQ (prop
, Qscroll_bar
))
24278 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24280 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24281 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24282 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24287 if (EQ (prop
, Qleft_fringe
))
24288 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24289 if (EQ (prop
, Qright_fringe
))
24290 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24291 if (EQ (prop
, Qleft_margin
))
24292 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24293 if (EQ (prop
, Qright_margin
))
24294 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24295 if (EQ (prop
, Qscroll_bar
))
24296 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24299 prop
= buffer_local_value (prop
, it
->w
->contents
);
24300 if (EQ (prop
, Qunbound
))
24304 if (NUMBERP (prop
))
24306 int base_unit
= (width_p
24307 ? FRAME_COLUMN_WIDTH (it
->f
)
24308 : FRAME_LINE_HEIGHT (it
->f
));
24309 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24314 Lisp_Object car
= XCAR (prop
);
24315 Lisp_Object cdr
= XCDR (prop
);
24319 #ifdef HAVE_WINDOW_SYSTEM
24320 if (FRAME_WINDOW_P (it
->f
)
24321 && valid_image_p (prop
))
24323 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24324 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24326 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24328 if (FRAME_WINDOW_P (it
->f
) && valid_xwidget_spec_p (prop
))
24330 // TODO: Don't return dummy size.
24331 return OK_PIXELS (100);
24334 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24340 while (CONSP (cdr
))
24342 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24343 font
, width_p
, align_to
))
24346 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24351 if (EQ (car
, Qminus
))
24353 return OK_PIXELS (pixels
);
24356 car
= buffer_local_value (car
, it
->w
->contents
);
24357 if (EQ (car
, Qunbound
))
24364 pixels
= XFLOATINT (car
);
24366 return OK_PIXELS (pixels
);
24367 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24368 font
, width_p
, align_to
))
24369 return OK_PIXELS (pixels
* fact
);
24380 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24382 #ifdef HAVE_WINDOW_SYSTEM
24383 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24391 /***********************************************************************
24393 ***********************************************************************/
24395 #ifdef HAVE_WINDOW_SYSTEM
24400 dump_glyph_string (struct glyph_string
*s
)
24402 fprintf (stderr
, "glyph string\n");
24403 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24404 s
->x
, s
->y
, s
->width
, s
->height
);
24405 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24406 fprintf (stderr
, " hl = %d\n", s
->hl
);
24407 fprintf (stderr
, " left overhang = %d, right = %d\n",
24408 s
->left_overhang
, s
->right_overhang
);
24409 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24410 fprintf (stderr
, " extends to end of line = %d\n",
24411 s
->extends_to_end_of_line_p
);
24412 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24413 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24416 #endif /* GLYPH_DEBUG */
24418 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24419 of XChar2b structures for S; it can't be allocated in
24420 init_glyph_string because it must be allocated via `alloca'. W
24421 is the window on which S is drawn. ROW and AREA are the glyph row
24422 and area within the row from which S is constructed. START is the
24423 index of the first glyph structure covered by S. HL is a
24424 face-override for drawing S. */
24427 #define OPTIONAL_HDC(hdc) HDC hdc,
24428 #define DECLARE_HDC(hdc) HDC hdc;
24429 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24430 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24433 #ifndef OPTIONAL_HDC
24434 #define OPTIONAL_HDC(hdc)
24435 #define DECLARE_HDC(hdc)
24436 #define ALLOCATE_HDC(hdc, f)
24437 #define RELEASE_HDC(hdc, f)
24441 init_glyph_string (struct glyph_string
*s
,
24443 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24444 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24446 memset (s
, 0, sizeof *s
);
24448 s
->f
= XFRAME (w
->frame
);
24452 s
->display
= FRAME_X_DISPLAY (s
->f
);
24453 s
->window
= FRAME_X_WINDOW (s
->f
);
24454 s
->char2b
= char2b
;
24458 s
->first_glyph
= row
->glyphs
[area
] + start
;
24459 s
->height
= row
->height
;
24460 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24461 s
->ybase
= s
->y
+ row
->ascent
;
24465 /* Append the list of glyph strings with head H and tail T to the list
24466 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24469 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24470 struct glyph_string
*h
, struct glyph_string
*t
)
24484 /* Prepend the list of glyph strings with head H and tail T to the
24485 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24489 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24490 struct glyph_string
*h
, struct glyph_string
*t
)
24504 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24505 Set *HEAD and *TAIL to the resulting list. */
24508 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24509 struct glyph_string
*s
)
24511 s
->next
= s
->prev
= NULL
;
24512 append_glyph_string_lists (head
, tail
, s
, s
);
24516 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24517 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24518 make sure that X resources for the face returned are allocated.
24519 Value is a pointer to a realized face that is ready for display if
24522 static struct face
*
24523 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24524 XChar2b
*char2b
, bool display_p
)
24526 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24531 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24533 if (code
== FONT_INVALID_CODE
)
24536 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24538 /* Make sure X resources of the face are allocated. */
24539 #ifdef HAVE_X_WINDOWS
24543 eassert (face
!= NULL
);
24544 prepare_face_for_display (f
, face
);
24551 /* Get face and two-byte form of character glyph GLYPH on frame F.
24552 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24553 a pointer to a realized face that is ready for display. */
24555 static struct face
*
24556 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24562 eassert (glyph
->type
== CHAR_GLYPH
);
24563 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24565 /* Make sure X resources of the face are allocated. */
24566 eassert (face
!= NULL
);
24567 prepare_face_for_display (f
, face
);
24571 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24572 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24574 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24576 if (code
== FONT_INVALID_CODE
)
24580 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24585 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24586 Return true iff FONT has a glyph for C. */
24589 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24593 if (CHAR_BYTE8_P (c
))
24594 code
= CHAR_TO_BYTE8 (c
);
24596 code
= font
->driver
->encode_char (font
, c
);
24598 if (code
== FONT_INVALID_CODE
)
24600 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24605 /* Fill glyph string S with composition components specified by S->cmp.
24607 BASE_FACE is the base face of the composition.
24608 S->cmp_from is the index of the first component for S.
24610 OVERLAPS non-zero means S should draw the foreground only, and use
24611 its physical height for clipping. See also draw_glyphs.
24613 Value is the index of a component not in S. */
24616 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24620 /* For all glyphs of this composition, starting at the offset
24621 S->cmp_from, until we reach the end of the definition or encounter a
24622 glyph that requires the different face, add it to S. */
24627 s
->for_overlaps
= overlaps
;
24630 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24632 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24634 /* TAB in a composition means display glyphs with padding space
24635 on the left or right. */
24638 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24641 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24642 s
->char2b
+ i
, true);
24648 s
->font
= s
->face
->font
;
24650 else if (s
->face
!= face
)
24658 if (s
->face
== NULL
)
24660 s
->face
= base_face
->ascii_face
;
24661 s
->font
= s
->face
->font
;
24664 /* All glyph strings for the same composition has the same width,
24665 i.e. the width set for the first component of the composition. */
24666 s
->width
= s
->first_glyph
->pixel_width
;
24668 /* If the specified font could not be loaded, use the frame's
24669 default font, but record the fact that we couldn't load it in
24670 the glyph string so that we can draw rectangles for the
24671 characters of the glyph string. */
24672 if (s
->font
== NULL
)
24674 s
->font_not_found_p
= true;
24675 s
->font
= FRAME_FONT (s
->f
);
24678 /* Adjust base line for subscript/superscript text. */
24679 s
->ybase
+= s
->first_glyph
->voffset
;
24685 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24686 int start
, int end
, int overlaps
)
24688 struct glyph
*glyph
, *last
;
24689 Lisp_Object lgstring
;
24692 s
->for_overlaps
= overlaps
;
24693 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24694 last
= s
->row
->glyphs
[s
->area
] + end
;
24695 s
->cmp_id
= glyph
->u
.cmp
.id
;
24696 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24697 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24698 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24699 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24700 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24702 while (glyph
< last
24703 && glyph
->u
.cmp
.automatic
24704 && glyph
->u
.cmp
.id
== s
->cmp_id
24705 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24706 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24708 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24710 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24711 unsigned code
= LGLYPH_CODE (lglyph
);
24713 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24715 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24716 return glyph
- s
->row
->glyphs
[s
->area
];
24720 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24721 See the comment of fill_glyph_string for arguments.
24722 Value is the index of the first glyph not in S. */
24726 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24727 int start
, int end
, int overlaps
)
24729 struct glyph
*glyph
, *last
;
24732 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24733 s
->for_overlaps
= overlaps
;
24734 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24735 last
= s
->row
->glyphs
[s
->area
] + end
;
24736 voffset
= glyph
->voffset
;
24737 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24738 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24740 s
->width
= glyph
->pixel_width
;
24742 while (glyph
< last
24743 && glyph
->type
== GLYPHLESS_GLYPH
24744 && glyph
->voffset
== voffset
24745 && glyph
->face_id
== face_id
)
24748 s
->width
+= glyph
->pixel_width
;
24751 s
->ybase
+= voffset
;
24752 return glyph
- s
->row
->glyphs
[s
->area
];
24756 /* Fill glyph string S from a sequence of character glyphs.
24758 FACE_ID is the face id of the string. START is the index of the
24759 first glyph to consider, END is the index of the last + 1.
24760 OVERLAPS non-zero means S should draw the foreground only, and use
24761 its physical height for clipping. See also draw_glyphs.
24763 Value is the index of the first glyph not in S. */
24766 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24767 int start
, int end
, int overlaps
)
24769 struct glyph
*glyph
, *last
;
24771 bool glyph_not_available_p
;
24773 eassert (s
->f
== XFRAME (s
->w
->frame
));
24774 eassert (s
->nchars
== 0);
24775 eassert (start
>= 0 && end
> start
);
24777 s
->for_overlaps
= overlaps
;
24778 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24779 last
= s
->row
->glyphs
[s
->area
] + end
;
24780 voffset
= glyph
->voffset
;
24781 s
->padding_p
= glyph
->padding_p
;
24782 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24784 while (glyph
< last
24785 && glyph
->type
== CHAR_GLYPH
24786 && glyph
->voffset
== voffset
24787 /* Same face id implies same font, nowadays. */
24788 && glyph
->face_id
== face_id
24789 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24791 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24792 s
->char2b
+ s
->nchars
);
24794 eassert (s
->nchars
<= end
- start
);
24795 s
->width
+= glyph
->pixel_width
;
24796 if (glyph
++->padding_p
!= s
->padding_p
)
24800 s
->font
= s
->face
->font
;
24802 /* If the specified font could not be loaded, use the frame's font,
24803 but record the fact that we couldn't load it in
24804 S->font_not_found_p so that we can draw rectangles for the
24805 characters of the glyph string. */
24806 if (s
->font
== NULL
|| glyph_not_available_p
)
24808 s
->font_not_found_p
= true;
24809 s
->font
= FRAME_FONT (s
->f
);
24812 /* Adjust base line for subscript/superscript text. */
24813 s
->ybase
+= voffset
;
24815 eassert (s
->face
&& s
->face
->gc
);
24816 return glyph
- s
->row
->glyphs
[s
->area
];
24820 /* Fill glyph string S from image glyph S->first_glyph. */
24823 fill_image_glyph_string (struct glyph_string
*s
)
24825 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24826 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24828 s
->slice
= s
->first_glyph
->slice
.img
;
24829 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24830 s
->font
= s
->face
->font
;
24831 s
->width
= s
->first_glyph
->pixel_width
;
24833 /* Adjust base line for subscript/superscript text. */
24834 s
->ybase
+= s
->first_glyph
->voffset
;
24838 #ifdef HAVE_XWIDGETS
24840 fill_xwidget_glyph_string (struct glyph_string
*s
)
24842 eassert (s
->first_glyph
->type
== XWIDGET_GLYPH
);
24843 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24844 s
->font
= s
->face
->font
;
24845 s
->width
= s
->first_glyph
->pixel_width
;
24846 s
->ybase
+= s
->first_glyph
->voffset
;
24847 s
->xwidget
= s
->first_glyph
->u
.xwidget
;
24850 /* Fill glyph string S from a sequence of stretch glyphs.
24852 START is the index of the first glyph to consider,
24853 END is the index of the last + 1.
24855 Value is the index of the first glyph not in S. */
24858 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24860 struct glyph
*glyph
, *last
;
24861 int voffset
, face_id
;
24863 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24865 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24866 last
= s
->row
->glyphs
[s
->area
] + end
;
24867 face_id
= glyph
->face_id
;
24868 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24869 s
->font
= s
->face
->font
;
24870 s
->width
= glyph
->pixel_width
;
24872 voffset
= glyph
->voffset
;
24876 && glyph
->type
== STRETCH_GLYPH
24877 && glyph
->voffset
== voffset
24878 && glyph
->face_id
== face_id
);
24880 s
->width
+= glyph
->pixel_width
;
24882 /* Adjust base line for subscript/superscript text. */
24883 s
->ybase
+= voffset
;
24885 /* The case that face->gc == 0 is handled when drawing the glyph
24886 string by calling prepare_face_for_display. */
24888 return glyph
- s
->row
->glyphs
[s
->area
];
24891 static struct font_metrics
*
24892 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24894 static struct font_metrics metrics
;
24899 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24900 if (code
== FONT_INVALID_CODE
)
24902 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24906 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24907 for FONT. Values are taken from font-global ones, except for fonts
24908 that claim preposterously large values, but whose glyphs actually
24909 have reasonable dimensions. C is the character to use for metrics
24910 if the font-global values are too large; if C is negative, the
24911 function selects a default character. */
24913 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24915 *ascent
= FONT_BASE (font
);
24916 *descent
= FONT_DESCENT (font
);
24918 if (FONT_TOO_HIGH (font
))
24922 /* Get metrics of C, defaulting to a reasonably sized ASCII
24924 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24926 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24928 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24930 /* We add 1 pixel to character dimensions as heuristics
24931 that produces nicer display, e.g. when the face has
24932 the box attribute. */
24933 *ascent
= pcm
->ascent
+ 1;
24934 *descent
= pcm
->descent
+ 1;
24940 /* A subroutine that computes a reasonable "normal character height"
24941 for fonts that claim preposterously large vertical dimensions, but
24942 whose glyphs are actually reasonably sized. C is the character
24943 whose metrics to use for those fonts, or -1 for default
24946 normal_char_height (struct font
*font
, int c
)
24948 int ascent
, descent
;
24950 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24952 return ascent
+ descent
;
24956 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24957 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24958 assumed to be zero. */
24961 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24963 *left
= *right
= 0;
24965 if (glyph
->type
== CHAR_GLYPH
)
24968 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24971 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24974 if (pcm
->rbearing
> pcm
->width
)
24975 *right
= pcm
->rbearing
- pcm
->width
;
24976 if (pcm
->lbearing
< 0)
24977 *left
= -pcm
->lbearing
;
24981 else if (glyph
->type
== COMPOSITE_GLYPH
)
24983 if (! glyph
->u
.cmp
.automatic
)
24985 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24987 if (cmp
->rbearing
> cmp
->pixel_width
)
24988 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24989 if (cmp
->lbearing
< 0)
24990 *left
= - cmp
->lbearing
;
24994 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24995 struct font_metrics metrics
;
24997 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24998 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24999 if (metrics
.rbearing
> metrics
.width
)
25000 *right
= metrics
.rbearing
- metrics
.width
;
25001 if (metrics
.lbearing
< 0)
25002 *left
= - metrics
.lbearing
;
25008 /* Return the index of the first glyph preceding glyph string S that
25009 is overwritten by S because of S's left overhang. Value is -1
25010 if no glyphs are overwritten. */
25013 left_overwritten (struct glyph_string
*s
)
25017 if (s
->left_overhang
)
25020 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25021 int first
= s
->first_glyph
- glyphs
;
25023 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
25024 x
-= glyphs
[i
].pixel_width
;
25035 /* Return the index of the first glyph preceding glyph string S that
25036 is overwriting S because of its right overhang. Value is -1 if no
25037 glyph in front of S overwrites S. */
25040 left_overwriting (struct glyph_string
*s
)
25043 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25044 int first
= s
->first_glyph
- glyphs
;
25048 for (i
= first
- 1; i
>= 0; --i
)
25051 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25054 x
-= glyphs
[i
].pixel_width
;
25061 /* Return the index of the last glyph following glyph string S that is
25062 overwritten by S because of S's right overhang. Value is -1 if
25063 no such glyph is found. */
25066 right_overwritten (struct glyph_string
*s
)
25070 if (s
->right_overhang
)
25073 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25074 int first
= (s
->first_glyph
- glyphs
25075 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25076 int end
= s
->row
->used
[s
->area
];
25078 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
25079 x
+= glyphs
[i
].pixel_width
;
25088 /* Return the index of the last glyph following glyph string S that
25089 overwrites S because of its left overhang. Value is negative
25090 if no such glyph is found. */
25093 right_overwriting (struct glyph_string
*s
)
25096 int end
= s
->row
->used
[s
->area
];
25097 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
25098 int first
= (s
->first_glyph
- glyphs
25099 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
25103 for (i
= first
; i
< end
; ++i
)
25106 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
25109 x
+= glyphs
[i
].pixel_width
;
25116 /* Set background width of glyph string S. START is the index of the
25117 first glyph following S. LAST_X is the right-most x-position + 1
25118 in the drawing area. */
25121 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
25123 /* If the face of this glyph string has to be drawn to the end of
25124 the drawing area, set S->extends_to_end_of_line_p. */
25126 if (start
== s
->row
->used
[s
->area
]
25127 && ((s
->row
->fill_line_p
25128 && (s
->hl
== DRAW_NORMAL_TEXT
25129 || s
->hl
== DRAW_IMAGE_RAISED
25130 || s
->hl
== DRAW_IMAGE_SUNKEN
))
25131 || s
->hl
== DRAW_MOUSE_FACE
))
25132 s
->extends_to_end_of_line_p
= true;
25134 /* If S extends its face to the end of the line, set its
25135 background_width to the distance to the right edge of the drawing
25137 if (s
->extends_to_end_of_line_p
)
25138 s
->background_width
= last_x
- s
->x
+ 1;
25140 s
->background_width
= s
->width
;
25144 /* Compute overhangs and x-positions for glyph string S and its
25145 predecessors, or successors. X is the starting x-position for S.
25146 BACKWARD_P means process predecessors. */
25149 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
25155 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25156 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25166 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
25167 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25177 /* The following macros are only called from draw_glyphs below.
25178 They reference the following parameters of that function directly:
25179 `w', `row', `area', and `overlap_p'
25180 as well as the following local variables:
25181 `s', `f', and `hdc' (in W32) */
25184 /* On W32, silently add local `hdc' variable to argument list of
25185 init_glyph_string. */
25186 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25187 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25189 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25190 init_glyph_string (s, char2b, w, row, area, start, hl)
25193 /* Add a glyph string for a stretch glyph to the list of strings
25194 between HEAD and TAIL. START is the index of the stretch glyph in
25195 row area AREA of glyph row ROW. END is the index of the last glyph
25196 in that glyph row area. X is the current output position assigned
25197 to the new glyph string constructed. HL overrides that face of the
25198 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25199 is the right-most x-position of the drawing area. */
25201 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25202 and below -- keep them on one line. */
25203 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25206 s = alloca (sizeof *s); \
25207 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25208 START = fill_stretch_glyph_string (s, START, END); \
25209 append_glyph_string (&HEAD, &TAIL, s); \
25215 /* Add a glyph string for an image glyph to the list of strings
25216 between HEAD and TAIL. START is the index of the image glyph in
25217 row area AREA of glyph row ROW. END is the index of the last glyph
25218 in that glyph row area. X is the current output position assigned
25219 to the new glyph string constructed. HL overrides that face of the
25220 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25221 is the right-most x-position of the drawing area. */
25223 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25226 s = alloca (sizeof *s); \
25227 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25228 fill_image_glyph_string (s); \
25229 append_glyph_string (&HEAD, &TAIL, s); \
25235 #ifndef HAVE_XWIDGETS
25236 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25239 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25242 s = alloca (sizeof *s); \
25243 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25244 fill_xwidget_glyph_string (s); \
25245 append_glyph_string (&(HEAD), &(TAIL), s); \
25252 /* Add a glyph string for a sequence of character glyphs to the list
25253 of strings between HEAD and TAIL. START is the index of the first
25254 glyph in row area AREA of glyph row ROW that is part of the new
25255 glyph string. END is the index of the last glyph in that glyph row
25256 area. X is the current output position assigned to the new glyph
25257 string constructed. HL overrides that face of the glyph; e.g. it
25258 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25259 right-most x-position of the drawing area. */
25261 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25267 face_id = (row)->glyphs[area][START].face_id; \
25269 s = alloca (sizeof *s); \
25270 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25271 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25272 append_glyph_string (&HEAD, &TAIL, s); \
25274 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25279 /* Add a glyph string for a composite sequence to the list of strings
25280 between HEAD and TAIL. START is the index of the first glyph in
25281 row area AREA of glyph row ROW that is part of the new glyph
25282 string. END is the index of the last glyph in that glyph row area.
25283 X is the current output position assigned to the new glyph string
25284 constructed. HL overrides that face of the glyph; e.g. it is
25285 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25286 x-position of the drawing area. */
25288 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25290 int face_id = (row)->glyphs[area][START].face_id; \
25291 struct face *base_face = FACE_FROM_ID (f, face_id); \
25292 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25293 struct composition *cmp = composition_table[cmp_id]; \
25295 struct glyph_string *first_s = NULL; \
25298 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25300 /* Make glyph_strings for each glyph sequence that is drawable by \
25301 the same face, and append them to HEAD/TAIL. */ \
25302 for (n = 0; n < cmp->glyph_len;) \
25304 s = alloca (sizeof *s); \
25305 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25306 append_glyph_string (&(HEAD), &(TAIL), s); \
25312 n = fill_composite_glyph_string (s, base_face, overlaps); \
25320 /* Add a glyph string for a glyph-string sequence to the list of strings
25321 between HEAD and TAIL. */
25323 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25327 Lisp_Object gstring; \
25329 face_id = (row)->glyphs[area][START].face_id; \
25330 gstring = (composition_gstring_from_id \
25331 ((row)->glyphs[area][START].u.cmp.id)); \
25332 s = alloca (sizeof *s); \
25333 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25334 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25335 append_glyph_string (&(HEAD), &(TAIL), s); \
25337 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25341 /* Add a glyph string for a sequence of glyphless character's glyphs
25342 to the list of strings between HEAD and TAIL. The meanings of
25343 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25345 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25350 face_id = (row)->glyphs[area][START].face_id; \
25352 s = alloca (sizeof *s); \
25353 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25354 append_glyph_string (&HEAD, &TAIL, s); \
25356 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25362 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25363 of AREA of glyph row ROW on window W between indices START and END.
25364 HL overrides the face for drawing glyph strings, e.g. it is
25365 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25366 x-positions of the drawing area.
25368 This is an ugly monster macro construct because we must use alloca
25369 to allocate glyph strings (because draw_glyphs can be called
25370 asynchronously). */
25372 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25375 HEAD = TAIL = NULL; \
25376 while (START < END) \
25378 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25379 switch (first_glyph->type) \
25382 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25386 case COMPOSITE_GLYPH: \
25387 if (first_glyph->u.cmp.automatic) \
25388 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25391 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25395 case STRETCH_GLYPH: \
25396 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25400 case IMAGE_GLYPH: \
25401 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25405 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25406 case XWIDGET_GLYPH: \
25407 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25411 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25412 case GLYPHLESS_GLYPH: \
25413 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25423 set_glyph_string_background_width (s, START, LAST_X); \
25430 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25431 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25432 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25433 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25436 /* Draw glyphs between START and END in AREA of ROW on window W,
25437 starting at x-position X. X is relative to AREA in W. HL is a
25438 face-override with the following meaning:
25440 DRAW_NORMAL_TEXT draw normally
25441 DRAW_CURSOR draw in cursor face
25442 DRAW_MOUSE_FACE draw in mouse face.
25443 DRAW_INVERSE_VIDEO draw in mode line face
25444 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25445 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25447 If OVERLAPS is non-zero, draw only the foreground of characters and
25448 clip to the physical height of ROW. Non-zero value also defines
25449 the overlapping part to be drawn:
25451 OVERLAPS_PRED overlap with preceding rows
25452 OVERLAPS_SUCC overlap with succeeding rows
25453 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25454 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25456 Value is the x-position reached, relative to AREA of W. */
25459 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25460 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25461 enum draw_glyphs_face hl
, int overlaps
)
25463 struct glyph_string
*head
, *tail
;
25464 struct glyph_string
*s
;
25465 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25466 int i
, j
, x_reached
, last_x
, area_left
= 0;
25467 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25470 ALLOCATE_HDC (hdc
, f
);
25472 /* Let's rather be paranoid than getting a SEGV. */
25473 end
= min (end
, row
->used
[area
]);
25474 start
= clip_to_bounds (0, start
, end
);
25476 /* Translate X to frame coordinates. Set last_x to the right
25477 end of the drawing area. */
25478 if (row
->full_width_p
)
25480 /* X is relative to the left edge of W, without scroll bars
25482 area_left
= WINDOW_LEFT_EDGE_X (w
);
25483 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25484 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25488 area_left
= window_box_left (w
, area
);
25489 last_x
= area_left
+ window_box_width (w
, area
);
25493 /* Build a doubly-linked list of glyph_string structures between
25494 head and tail from what we have to draw. Note that the macro
25495 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25496 the reason we use a separate variable `i'. */
25499 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25501 x_reached
= tail
->x
+ tail
->background_width
;
25505 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25506 the row, redraw some glyphs in front or following the glyph
25507 strings built above. */
25508 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25510 struct glyph_string
*h
, *t
;
25511 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25512 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25513 bool check_mouse_face
= false;
25516 /* If mouse highlighting is on, we may need to draw adjacent
25517 glyphs using mouse-face highlighting. */
25518 if (area
== TEXT_AREA
&& row
->mouse_face_p
25519 && hlinfo
->mouse_face_beg_row
>= 0
25520 && hlinfo
->mouse_face_end_row
>= 0)
25522 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25524 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25525 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25527 check_mouse_face
= true;
25528 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25529 ? hlinfo
->mouse_face_beg_col
: 0;
25530 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25531 ? hlinfo
->mouse_face_end_col
25532 : row
->used
[TEXT_AREA
];
25536 /* Compute overhangs for all glyph strings. */
25537 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25538 for (s
= head
; s
; s
= s
->next
)
25539 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25541 /* Prepend glyph strings for glyphs in front of the first glyph
25542 string that are overwritten because of the first glyph
25543 string's left overhang. The background of all strings
25544 prepended must be drawn because the first glyph string
25546 i
= left_overwritten (head
);
25549 enum draw_glyphs_face overlap_hl
;
25551 /* If this row contains mouse highlighting, attempt to draw
25552 the overlapped glyphs with the correct highlight. This
25553 code fails if the overlap encompasses more than one glyph
25554 and mouse-highlight spans only some of these glyphs.
25555 However, making it work perfectly involves a lot more
25556 code, and I don't know if the pathological case occurs in
25557 practice, so we'll stick to this for now. --- cyd */
25558 if (check_mouse_face
25559 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25560 overlap_hl
= DRAW_MOUSE_FACE
;
25562 overlap_hl
= DRAW_NORMAL_TEXT
;
25564 if (hl
!= overlap_hl
)
25567 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25568 overlap_hl
, dummy_x
, last_x
);
25570 compute_overhangs_and_x (t
, head
->x
, true);
25571 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25572 if (clip_head
== NULL
)
25576 /* Prepend glyph strings for glyphs in front of the first glyph
25577 string that overwrite that glyph string because of their
25578 right overhang. For these strings, only the foreground must
25579 be drawn, because it draws over the glyph string at `head'.
25580 The background must not be drawn because this would overwrite
25581 right overhangs of preceding glyphs for which no glyph
25583 i
= left_overwriting (head
);
25586 enum draw_glyphs_face overlap_hl
;
25588 if (check_mouse_face
25589 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25590 overlap_hl
= DRAW_MOUSE_FACE
;
25592 overlap_hl
= DRAW_NORMAL_TEXT
;
25594 if (hl
== overlap_hl
|| clip_head
== NULL
)
25596 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25597 overlap_hl
, dummy_x
, last_x
);
25598 for (s
= h
; s
; s
= s
->next
)
25599 s
->background_filled_p
= true;
25600 compute_overhangs_and_x (t
, head
->x
, true);
25601 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25604 /* Append glyphs strings for glyphs following the last glyph
25605 string tail that are overwritten by tail. The background of
25606 these strings has to be drawn because tail's foreground draws
25608 i
= right_overwritten (tail
);
25611 enum draw_glyphs_face overlap_hl
;
25613 if (check_mouse_face
25614 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25615 overlap_hl
= DRAW_MOUSE_FACE
;
25617 overlap_hl
= DRAW_NORMAL_TEXT
;
25619 if (hl
!= overlap_hl
)
25621 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25622 overlap_hl
, x
, last_x
);
25623 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25624 we don't have `end = i;' here. */
25625 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25626 append_glyph_string_lists (&head
, &tail
, h
, t
);
25627 if (clip_tail
== NULL
)
25631 /* Append glyph strings for glyphs following the last glyph
25632 string tail that overwrite tail. The foreground of such
25633 glyphs has to be drawn because it writes into the background
25634 of tail. The background must not be drawn because it could
25635 paint over the foreground of following glyphs. */
25636 i
= right_overwriting (tail
);
25639 enum draw_glyphs_face overlap_hl
;
25640 if (check_mouse_face
25641 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25642 overlap_hl
= DRAW_MOUSE_FACE
;
25644 overlap_hl
= DRAW_NORMAL_TEXT
;
25646 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25648 i
++; /* We must include the Ith glyph. */
25649 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25650 overlap_hl
, x
, last_x
);
25651 for (s
= h
; s
; s
= s
->next
)
25652 s
->background_filled_p
= true;
25653 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25654 append_glyph_string_lists (&head
, &tail
, h
, t
);
25656 if (clip_head
|| clip_tail
)
25657 for (s
= head
; s
; s
= s
->next
)
25659 s
->clip_head
= clip_head
;
25660 s
->clip_tail
= clip_tail
;
25664 /* Draw all strings. */
25665 for (s
= head
; s
; s
= s
->next
)
25666 FRAME_RIF (f
)->draw_glyph_string (s
);
25669 /* When focus a sole frame and move horizontally, this clears on_p
25670 causing a failure to erase prev cursor position. */
25671 if (area
== TEXT_AREA
25672 && !row
->full_width_p
25673 /* When drawing overlapping rows, only the glyph strings'
25674 foreground is drawn, which doesn't erase a cursor
25678 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25679 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25680 : (tail
? tail
->x
+ tail
->background_width
: x
));
25684 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25685 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25689 /* Value is the x-position up to which drawn, relative to AREA of W.
25690 This doesn't include parts drawn because of overhangs. */
25691 if (row
->full_width_p
)
25692 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25694 x_reached
-= area_left
;
25696 RELEASE_HDC (hdc
, f
);
25702 /* Expand row matrix if too narrow. Don't expand if area
25705 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25707 if (!it->f->fonts_changed \
25708 && (it->glyph_row->glyphs[area] \
25709 < it->glyph_row->glyphs[area + 1])) \
25711 it->w->ncols_scale_factor++; \
25712 it->f->fonts_changed = true; \
25716 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25717 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25720 append_glyph (struct it
*it
)
25722 struct glyph
*glyph
;
25723 enum glyph_row_area area
= it
->area
;
25725 eassert (it
->glyph_row
);
25726 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25728 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25729 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25731 /* If the glyph row is reversed, we need to prepend the glyph
25732 rather than append it. */
25733 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25737 /* Make room for the additional glyph. */
25738 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25740 glyph
= it
->glyph_row
->glyphs
[area
];
25742 glyph
->charpos
= CHARPOS (it
->position
);
25743 glyph
->object
= it
->object
;
25744 if (it
->pixel_width
> 0)
25746 glyph
->pixel_width
= it
->pixel_width
;
25747 glyph
->padding_p
= false;
25751 /* Assure at least 1-pixel width. Otherwise, cursor can't
25752 be displayed correctly. */
25753 glyph
->pixel_width
= 1;
25754 glyph
->padding_p
= true;
25756 glyph
->ascent
= it
->ascent
;
25757 glyph
->descent
= it
->descent
;
25758 glyph
->voffset
= it
->voffset
;
25759 glyph
->type
= CHAR_GLYPH
;
25760 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25761 glyph
->multibyte_p
= it
->multibyte_p
;
25762 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25764 /* In R2L rows, the left and the right box edges need to be
25765 drawn in reverse direction. */
25766 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25767 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25771 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25772 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25774 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25775 || it
->phys_descent
> it
->descent
);
25776 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25777 glyph
->face_id
= it
->face_id
;
25778 glyph
->u
.ch
= it
->char_to_display
;
25779 glyph
->slice
.img
= null_glyph_slice
;
25780 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25783 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25784 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25785 glyph
->bidi_type
= it
->bidi_it
.type
;
25789 glyph
->resolved_level
= 0;
25790 glyph
->bidi_type
= UNKNOWN_BT
;
25792 ++it
->glyph_row
->used
[area
];
25795 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25798 /* Store one glyph for the composition IT->cmp_it.id in
25799 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25803 append_composite_glyph (struct it
*it
)
25805 struct glyph
*glyph
;
25806 enum glyph_row_area area
= it
->area
;
25808 eassert (it
->glyph_row
);
25810 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25811 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25813 /* If the glyph row is reversed, we need to prepend the glyph
25814 rather than append it. */
25815 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25819 /* Make room for the new glyph. */
25820 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25822 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25824 glyph
->charpos
= it
->cmp_it
.charpos
;
25825 glyph
->object
= it
->object
;
25826 glyph
->pixel_width
= it
->pixel_width
;
25827 glyph
->ascent
= it
->ascent
;
25828 glyph
->descent
= it
->descent
;
25829 glyph
->voffset
= it
->voffset
;
25830 glyph
->type
= COMPOSITE_GLYPH
;
25831 if (it
->cmp_it
.ch
< 0)
25833 glyph
->u
.cmp
.automatic
= false;
25834 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25835 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25839 glyph
->u
.cmp
.automatic
= true;
25840 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25841 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25842 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25844 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25845 glyph
->multibyte_p
= it
->multibyte_p
;
25846 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25848 /* In R2L rows, the left and the right box edges need to be
25849 drawn in reverse direction. */
25850 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25851 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25855 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25856 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25858 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25859 || it
->phys_descent
> it
->descent
);
25860 glyph
->padding_p
= false;
25861 glyph
->glyph_not_available_p
= false;
25862 glyph
->face_id
= it
->face_id
;
25863 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25866 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25867 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25868 glyph
->bidi_type
= it
->bidi_it
.type
;
25870 ++it
->glyph_row
->used
[area
];
25873 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25877 /* Change IT->ascent and IT->height according to the setting of
25881 take_vertical_position_into_account (struct it
*it
)
25885 if (it
->voffset
< 0)
25886 /* Increase the ascent so that we can display the text higher
25888 it
->ascent
-= it
->voffset
;
25890 /* Increase the descent so that we can display the text lower
25892 it
->descent
+= it
->voffset
;
25897 /* Produce glyphs/get display metrics for the image IT is loaded with.
25898 See the description of struct display_iterator in dispextern.h for
25899 an overview of struct display_iterator. */
25902 produce_image_glyph (struct it
*it
)
25906 int glyph_ascent
, crop
;
25907 struct glyph_slice slice
;
25909 eassert (it
->what
== IT_IMAGE
);
25911 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25913 /* Make sure X resources of the face is loaded. */
25914 prepare_face_for_display (it
->f
, face
);
25916 if (it
->image_id
< 0)
25918 /* Fringe bitmap. */
25919 it
->ascent
= it
->phys_ascent
= 0;
25920 it
->descent
= it
->phys_descent
= 0;
25921 it
->pixel_width
= 0;
25926 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25928 /* Make sure X resources of the image is loaded. */
25929 prepare_image_for_display (it
->f
, img
);
25931 slice
.x
= slice
.y
= 0;
25932 slice
.width
= img
->width
;
25933 slice
.height
= img
->height
;
25935 if (INTEGERP (it
->slice
.x
))
25936 slice
.x
= XINT (it
->slice
.x
);
25937 else if (FLOATP (it
->slice
.x
))
25938 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25940 if (INTEGERP (it
->slice
.y
))
25941 slice
.y
= XINT (it
->slice
.y
);
25942 else if (FLOATP (it
->slice
.y
))
25943 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25945 if (INTEGERP (it
->slice
.width
))
25946 slice
.width
= XINT (it
->slice
.width
);
25947 else if (FLOATP (it
->slice
.width
))
25948 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25950 if (INTEGERP (it
->slice
.height
))
25951 slice
.height
= XINT (it
->slice
.height
);
25952 else if (FLOATP (it
->slice
.height
))
25953 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25955 if (slice
.x
>= img
->width
)
25956 slice
.x
= img
->width
;
25957 if (slice
.y
>= img
->height
)
25958 slice
.y
= img
->height
;
25959 if (slice
.x
+ slice
.width
>= img
->width
)
25960 slice
.width
= img
->width
- slice
.x
;
25961 if (slice
.y
+ slice
.height
> img
->height
)
25962 slice
.height
= img
->height
- slice
.y
;
25964 if (slice
.width
== 0 || slice
.height
== 0)
25967 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25969 it
->descent
= slice
.height
- glyph_ascent
;
25971 it
->descent
+= img
->vmargin
;
25972 if (slice
.y
+ slice
.height
== img
->height
)
25973 it
->descent
+= img
->vmargin
;
25974 it
->phys_descent
= it
->descent
;
25976 it
->pixel_width
= slice
.width
;
25978 it
->pixel_width
+= img
->hmargin
;
25979 if (slice
.x
+ slice
.width
== img
->width
)
25980 it
->pixel_width
+= img
->hmargin
;
25982 /* It's quite possible for images to have an ascent greater than
25983 their height, so don't get confused in that case. */
25984 if (it
->descent
< 0)
25989 if (face
->box
!= FACE_NO_BOX
)
25991 if (face
->box_line_width
> 0)
25994 it
->ascent
+= face
->box_line_width
;
25995 if (slice
.y
+ slice
.height
== img
->height
)
25996 it
->descent
+= face
->box_line_width
;
25999 if (it
->start_of_box_run_p
&& slice
.x
== 0)
26000 it
->pixel_width
+= eabs (face
->box_line_width
);
26001 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
26002 it
->pixel_width
+= eabs (face
->box_line_width
);
26005 take_vertical_position_into_account (it
);
26007 /* Automatically crop wide image glyphs at right edge so we can
26008 draw the cursor on same display row. */
26009 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
26010 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26012 it
->pixel_width
-= crop
;
26013 slice
.width
-= crop
;
26018 struct glyph
*glyph
;
26019 enum glyph_row_area area
= it
->area
;
26021 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26022 if (it
->glyph_row
->reversed_p
)
26026 /* Make room for the new glyph. */
26027 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26029 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26031 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26033 glyph
->charpos
= CHARPOS (it
->position
);
26034 glyph
->object
= it
->object
;
26035 glyph
->pixel_width
= it
->pixel_width
;
26036 glyph
->ascent
= glyph_ascent
;
26037 glyph
->descent
= it
->descent
;
26038 glyph
->voffset
= it
->voffset
;
26039 glyph
->type
= IMAGE_GLYPH
;
26040 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26041 glyph
->multibyte_p
= it
->multibyte_p
;
26042 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26044 /* In R2L rows, the left and the right box edges need to be
26045 drawn in reverse direction. */
26046 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26047 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26051 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26052 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26054 glyph
->overlaps_vertically_p
= false;
26055 glyph
->padding_p
= false;
26056 glyph
->glyph_not_available_p
= false;
26057 glyph
->face_id
= it
->face_id
;
26058 glyph
->u
.img_id
= img
->id
;
26059 glyph
->slice
.img
= slice
;
26060 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26063 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26064 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26065 glyph
->bidi_type
= it
->bidi_it
.type
;
26067 ++it
->glyph_row
->used
[area
];
26070 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26075 produce_xwidget_glyph (struct it
*it
)
26077 #ifdef HAVE_XWIDGETS
26078 struct xwidget
*xw
;
26079 int glyph_ascent
, crop
;
26080 eassert (it
->what
== IT_XWIDGET
);
26082 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26084 /* Make sure X resources of the face is loaded. */
26085 prepare_face_for_display (it
->f
, face
);
26088 it
->ascent
= it
->phys_ascent
= glyph_ascent
= xw
->height
/2;
26089 it
->descent
= xw
->height
/2;
26090 it
->phys_descent
= it
->descent
;
26091 it
->pixel_width
= xw
->width
;
26092 /* It's quite possible for images to have an ascent greater than
26093 their height, so don't get confused in that case. */
26094 if (it
->descent
< 0)
26099 if (face
->box
!= FACE_NO_BOX
)
26101 if (face
->box_line_width
> 0)
26103 it
->ascent
+= face
->box_line_width
;
26104 it
->descent
+= face
->box_line_width
;
26107 if (it
->start_of_box_run_p
)
26108 it
->pixel_width
+= eabs (face
->box_line_width
);
26109 it
->pixel_width
+= eabs (face
->box_line_width
);
26112 take_vertical_position_into_account (it
);
26114 /* Automatically crop wide image glyphs at right edge so we can
26115 draw the cursor on same display row. */
26116 crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
);
26117 if (crop
> 0 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
26118 it
->pixel_width
-= crop
;
26122 enum glyph_row_area area
= it
->area
;
26123 struct glyph
*glyph
26124 = it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26126 if (it
->glyph_row
->reversed_p
)
26130 /* Make room for the new glyph. */
26131 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
26133 glyph
= it
->glyph_row
->glyphs
[it
->area
];
26135 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26137 glyph
->charpos
= CHARPOS (it
->position
);
26138 glyph
->object
= it
->object
;
26139 glyph
->pixel_width
= it
->pixel_width
;
26140 glyph
->ascent
= glyph_ascent
;
26141 glyph
->descent
= it
->descent
;
26142 glyph
->voffset
= it
->voffset
;
26143 glyph
->type
= XWIDGET_GLYPH
;
26144 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26145 glyph
->multibyte_p
= it
->multibyte_p
;
26146 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26148 /* In R2L rows, the left and the right box edges need to be
26149 drawn in reverse direction. */
26150 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26151 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26155 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26156 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26158 glyph
->overlaps_vertically_p
= 0;
26159 glyph
->padding_p
= 0;
26160 glyph
->glyph_not_available_p
= 0;
26161 glyph
->face_id
= it
->face_id
;
26162 glyph
->u
.xwidget
= it
->xwidget
;
26163 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26166 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26167 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26168 glyph
->bidi_type
= it
->bidi_it
.type
;
26170 ++it
->glyph_row
->used
[area
];
26173 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26178 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26179 of the glyph, WIDTH and HEIGHT are the width and height of the
26180 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26183 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
26184 int width
, int height
, int ascent
)
26186 struct glyph
*glyph
;
26187 enum glyph_row_area area
= it
->area
;
26189 eassert (ascent
>= 0 && ascent
<= height
);
26191 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26192 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26194 /* If the glyph row is reversed, we need to prepend the glyph
26195 rather than append it. */
26196 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26200 /* Make room for the additional glyph. */
26201 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26203 glyph
= it
->glyph_row
->glyphs
[area
];
26205 /* Decrease the width of the first glyph of the row that
26206 begins before first_visible_x (e.g., due to hscroll).
26207 This is so the overall width of the row becomes smaller
26208 by the scroll amount, and the stretch glyph appended by
26209 extend_face_to_end_of_line will be wider, to shift the
26210 row glyphs to the right. (In L2R rows, the corresponding
26211 left-shift effect is accomplished by setting row->x to a
26212 negative value, which won't work with R2L rows.)
26214 This must leave us with a positive value of WIDTH, since
26215 otherwise the call to move_it_in_display_line_to at the
26216 beginning of display_line would have got past the entire
26217 first glyph, and then it->current_x would have been
26218 greater or equal to it->first_visible_x. */
26219 if (it
->current_x
< it
->first_visible_x
)
26220 width
-= it
->first_visible_x
- it
->current_x
;
26221 eassert (width
> 0);
26223 glyph
->charpos
= CHARPOS (it
->position
);
26224 glyph
->object
= object
;
26225 glyph
->pixel_width
= width
;
26226 glyph
->ascent
= ascent
;
26227 glyph
->descent
= height
- ascent
;
26228 glyph
->voffset
= it
->voffset
;
26229 glyph
->type
= STRETCH_GLYPH
;
26230 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26231 glyph
->multibyte_p
= it
->multibyte_p
;
26232 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26234 /* In R2L rows, the left and the right box edges need to be
26235 drawn in reverse direction. */
26236 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26237 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26241 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26242 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26244 glyph
->overlaps_vertically_p
= false;
26245 glyph
->padding_p
= false;
26246 glyph
->glyph_not_available_p
= false;
26247 glyph
->face_id
= it
->face_id
;
26248 glyph
->u
.stretch
.ascent
= ascent
;
26249 glyph
->u
.stretch
.height
= height
;
26250 glyph
->slice
.img
= null_glyph_slice
;
26251 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26254 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26255 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26256 glyph
->bidi_type
= it
->bidi_it
.type
;
26260 glyph
->resolved_level
= 0;
26261 glyph
->bidi_type
= UNKNOWN_BT
;
26263 ++it
->glyph_row
->used
[area
];
26266 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26269 #endif /* HAVE_WINDOW_SYSTEM */
26271 /* Produce a stretch glyph for iterator IT. IT->object is the value
26272 of the glyph property displayed. The value must be a list
26273 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26276 1. `:width WIDTH' specifies that the space should be WIDTH *
26277 canonical char width wide. WIDTH may be an integer or floating
26280 2. `:relative-width FACTOR' specifies that the width of the stretch
26281 should be computed from the width of the first character having the
26282 `glyph' property, and should be FACTOR times that width.
26284 3. `:align-to HPOS' specifies that the space should be wide enough
26285 to reach HPOS, a value in canonical character units.
26287 Exactly one of the above pairs must be present.
26289 4. `:height HEIGHT' specifies that the height of the stretch produced
26290 should be HEIGHT, measured in canonical character units.
26292 5. `:relative-height FACTOR' specifies that the height of the
26293 stretch should be FACTOR times the height of the characters having
26294 the glyph property.
26296 Either none or exactly one of 4 or 5 must be present.
26298 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26299 of the stretch should be used for the ascent of the stretch.
26300 ASCENT must be in the range 0 <= ASCENT <= 100. */
26303 produce_stretch_glyph (struct it
*it
)
26305 /* (space :width WIDTH :height HEIGHT ...) */
26306 Lisp_Object prop
, plist
;
26307 int width
= 0, height
= 0, align_to
= -1;
26308 bool zero_width_ok_p
= false;
26310 struct font
*font
= NULL
;
26312 #ifdef HAVE_WINDOW_SYSTEM
26314 bool zero_height_ok_p
= false;
26316 if (FRAME_WINDOW_P (it
->f
))
26318 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26319 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26320 prepare_face_for_display (it
->f
, face
);
26324 /* List should start with `space'. */
26325 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26326 plist
= XCDR (it
->object
);
26328 /* Compute the width of the stretch. */
26329 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26330 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26332 /* Absolute width `:width WIDTH' specified and valid. */
26333 zero_width_ok_p
= true;
26336 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26338 /* Relative width `:relative-width FACTOR' specified and valid.
26339 Compute the width of the characters having the `glyph'
26342 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26345 if (it
->multibyte_p
)
26346 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26349 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26350 if (! ASCII_CHAR_P (it2
.c
))
26351 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26354 it2
.glyph_row
= NULL
;
26355 it2
.what
= IT_CHARACTER
;
26356 PRODUCE_GLYPHS (&it2
);
26357 width
= NUMVAL (prop
) * it2
.pixel_width
;
26359 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26360 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26363 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26364 align_to
= (align_to
< 0
26366 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26367 else if (align_to
< 0)
26368 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26369 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26370 zero_width_ok_p
= true;
26373 /* Nothing specified -> width defaults to canonical char width. */
26374 width
= FRAME_COLUMN_WIDTH (it
->f
);
26376 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26379 #ifdef HAVE_WINDOW_SYSTEM
26380 /* Compute height. */
26381 if (FRAME_WINDOW_P (it
->f
))
26383 int default_height
= normal_char_height (font
, ' ');
26385 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26386 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26389 zero_height_ok_p
= true;
26391 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26393 height
= default_height
* NUMVAL (prop
);
26395 height
= default_height
;
26397 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26400 /* Compute percentage of height used for ascent. If
26401 `:ascent ASCENT' is present and valid, use that. Otherwise,
26402 derive the ascent from the font in use. */
26403 if (prop
= Fplist_get (plist
, QCascent
),
26404 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26405 ascent
= height
* NUMVAL (prop
) / 100.0;
26406 else if (!NILP (prop
)
26407 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26408 ascent
= min (max (0, (int)tem
), height
);
26410 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26413 #endif /* HAVE_WINDOW_SYSTEM */
26416 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26417 && it
->current_x
+ width
> it
->last_visible_x
)
26419 width
= it
->last_visible_x
- it
->current_x
;
26420 #ifdef HAVE_WINDOW_SYSTEM
26421 /* Subtract one more pixel from the stretch width, but only on
26422 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26423 width
-= FRAME_WINDOW_P (it
->f
);
26427 if (width
> 0 && height
> 0 && it
->glyph_row
)
26429 Lisp_Object o_object
= it
->object
;
26430 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26433 if (!STRINGP (object
))
26434 object
= it
->w
->contents
;
26435 #ifdef HAVE_WINDOW_SYSTEM
26436 if (FRAME_WINDOW_P (it
->f
))
26437 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26441 it
->object
= object
;
26442 it
->char_to_display
= ' ';
26443 it
->pixel_width
= it
->len
= 1;
26445 tty_append_glyph (it
);
26446 it
->object
= o_object
;
26450 it
->pixel_width
= width
;
26451 #ifdef HAVE_WINDOW_SYSTEM
26452 if (FRAME_WINDOW_P (it
->f
))
26454 it
->ascent
= it
->phys_ascent
= ascent
;
26455 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26456 it
->nglyphs
= width
> 0 && height
> 0;
26457 take_vertical_position_into_account (it
);
26461 it
->nglyphs
= width
;
26464 /* Get information about special display element WHAT in an
26465 environment described by IT. WHAT is one of IT_TRUNCATION or
26466 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26467 non-null glyph_row member. This function ensures that fields like
26468 face_id, c, len of IT are left untouched. */
26471 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26478 temp_it
.object
= Qnil
;
26479 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26481 if (what
== IT_CONTINUATION
)
26483 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26484 if (it
->bidi_it
.paragraph_dir
== R2L
)
26485 SET_GLYPH_FROM_CHAR (glyph
, '/');
26487 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26489 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26491 /* FIXME: Should we mirror GC for R2L lines? */
26492 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26493 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26496 else if (what
== IT_TRUNCATION
)
26498 /* Truncation glyph. */
26499 SET_GLYPH_FROM_CHAR (glyph
, '$');
26501 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26503 /* FIXME: Should we mirror GC for R2L lines? */
26504 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26505 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26511 #ifdef HAVE_WINDOW_SYSTEM
26512 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26513 is turned off, we precede the truncation/continuation glyphs by a
26514 stretch glyph whose width is computed such that these special
26515 glyphs are aligned at the window margin, even when very different
26516 fonts are used in different glyph rows. */
26517 if (FRAME_WINDOW_P (temp_it
.f
)
26518 /* init_iterator calls this with it->glyph_row == NULL, and it
26519 wants only the pixel width of the truncation/continuation
26521 && temp_it
.glyph_row
26522 /* insert_left_trunc_glyphs calls us at the beginning of the
26523 row, and it has its own calculation of the stretch glyph
26525 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26526 && (temp_it
.glyph_row
->reversed_p
26527 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26528 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26530 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26532 if (stretch_width
> 0)
26534 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26535 struct font
*font
=
26536 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26537 int stretch_ascent
=
26538 (((temp_it
.ascent
+ temp_it
.descent
)
26539 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26541 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26542 temp_it
.ascent
+ temp_it
.descent
,
26549 temp_it
.what
= IT_CHARACTER
;
26550 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26551 temp_it
.face_id
= GLYPH_FACE (glyph
);
26552 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26554 PRODUCE_GLYPHS (&temp_it
);
26555 it
->pixel_width
= temp_it
.pixel_width
;
26556 it
->nglyphs
= temp_it
.nglyphs
;
26559 #ifdef HAVE_WINDOW_SYSTEM
26561 /* Calculate line-height and line-spacing properties.
26562 An integer value specifies explicit pixel value.
26563 A float value specifies relative value to current face height.
26564 A cons (float . face-name) specifies relative value to
26565 height of specified face font.
26567 Returns height in pixels, or nil. */
26570 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26571 int boff
, bool override
)
26573 Lisp_Object face_name
= Qnil
;
26574 int ascent
, descent
, height
;
26576 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26581 face_name
= XCAR (val
);
26583 if (!NUMBERP (val
))
26584 val
= make_number (1);
26585 if (NILP (face_name
))
26587 height
= it
->ascent
+ it
->descent
;
26592 if (NILP (face_name
))
26594 font
= FRAME_FONT (it
->f
);
26595 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26597 else if (EQ (face_name
, Qt
))
26606 face_id
= lookup_named_face (it
->f
, face_name
, false);
26608 return make_number (-1);
26610 face
= FACE_FROM_ID (it
->f
, face_id
);
26613 return make_number (-1);
26614 boff
= font
->baseline_offset
;
26615 if (font
->vertical_centering
)
26616 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26619 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26623 it
->override_ascent
= ascent
;
26624 it
->override_descent
= descent
;
26625 it
->override_boff
= boff
;
26628 height
= ascent
+ descent
;
26632 height
= (int)(XFLOAT_DATA (val
) * height
);
26633 else if (INTEGERP (val
))
26634 height
*= XINT (val
);
26636 return make_number (height
);
26640 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26641 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26642 and only if this is for a character for which no font was found.
26644 If the display method (it->glyphless_method) is
26645 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26646 length of the acronym or the hexadecimal string, UPPER_XOFF and
26647 UPPER_YOFF are pixel offsets for the upper part of the string,
26648 LOWER_XOFF and LOWER_YOFF are for the lower part.
26650 For the other display methods, LEN through LOWER_YOFF are zero. */
26653 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26654 short upper_xoff
, short upper_yoff
,
26655 short lower_xoff
, short lower_yoff
)
26657 struct glyph
*glyph
;
26658 enum glyph_row_area area
= it
->area
;
26660 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26661 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26663 /* If the glyph row is reversed, we need to prepend the glyph
26664 rather than append it. */
26665 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26669 /* Make room for the additional glyph. */
26670 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26672 glyph
= it
->glyph_row
->glyphs
[area
];
26674 glyph
->charpos
= CHARPOS (it
->position
);
26675 glyph
->object
= it
->object
;
26676 glyph
->pixel_width
= it
->pixel_width
;
26677 glyph
->ascent
= it
->ascent
;
26678 glyph
->descent
= it
->descent
;
26679 glyph
->voffset
= it
->voffset
;
26680 glyph
->type
= GLYPHLESS_GLYPH
;
26681 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26682 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26683 glyph
->u
.glyphless
.len
= len
;
26684 glyph
->u
.glyphless
.ch
= it
->c
;
26685 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26686 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26687 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26688 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26689 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26690 glyph
->multibyte_p
= it
->multibyte_p
;
26691 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26693 /* In R2L rows, the left and the right box edges need to be
26694 drawn in reverse direction. */
26695 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26696 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26700 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26701 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26703 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26704 || it
->phys_descent
> it
->descent
);
26705 glyph
->padding_p
= false;
26706 glyph
->glyph_not_available_p
= false;
26707 glyph
->face_id
= face_id
;
26708 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26711 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26712 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26713 glyph
->bidi_type
= it
->bidi_it
.type
;
26715 ++it
->glyph_row
->used
[area
];
26718 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26722 /* Produce a glyph for a glyphless character for iterator IT.
26723 IT->glyphless_method specifies which method to use for displaying
26724 the character. See the description of enum
26725 glyphless_display_method in dispextern.h for the detail.
26727 FOR_NO_FONT is true if and only if this is for a character for
26728 which no font was found. ACRONYM, if non-nil, is an acronym string
26729 for the character. */
26732 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26737 int base_width
, base_height
, width
, height
;
26738 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26741 /* Get the metrics of the base font. We always refer to the current
26743 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26744 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26745 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26746 it
->ascent
+= font
->baseline_offset
;
26747 it
->descent
-= font
->baseline_offset
;
26748 base_height
= it
->ascent
+ it
->descent
;
26749 base_width
= font
->average_width
;
26751 face_id
= merge_glyphless_glyph_face (it
);
26753 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26755 it
->pixel_width
= THIN_SPACE_WIDTH
;
26757 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26759 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26761 width
= CHAR_WIDTH (it
->c
);
26764 else if (width
> 4)
26766 it
->pixel_width
= base_width
* width
;
26768 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26774 unsigned int code
[6];
26776 int ascent
, descent
;
26777 struct font_metrics metrics_upper
, metrics_lower
;
26779 face
= FACE_FROM_ID (it
->f
, face_id
);
26780 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26781 prepare_face_for_display (it
->f
, face
);
26783 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26785 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26786 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26787 if (CONSP (acronym
))
26788 acronym
= XCAR (acronym
);
26789 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26793 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26794 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26797 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26798 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26799 upper_len
= (len
+ 1) / 2;
26800 font
->driver
->text_extents (font
, code
, upper_len
,
26802 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26807 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26808 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26809 upper_xoff
= upper_yoff
= 2; /* the typical case */
26810 if (base_width
>= width
)
26812 /* Align the upper to the left, the lower to the right. */
26813 it
->pixel_width
= base_width
;
26814 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26818 /* Center the shorter one. */
26819 it
->pixel_width
= width
;
26820 if (metrics_upper
.width
>= metrics_lower
.width
)
26821 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26824 /* FIXME: This code doesn't look right. It formerly was
26825 missing the "lower_xoff = 0;", which couldn't have
26826 been right since it left lower_xoff uninitialized. */
26828 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26832 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26833 top, bottom, and between upper and lower strings. */
26834 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26835 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26836 /* Center vertically.
26837 H:base_height, D:base_descent
26838 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26840 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26841 descent = D - H/2 + h/2;
26842 lower_yoff = descent - 2 - ld;
26843 upper_yoff = lower_yoff - la - 1 - ud; */
26844 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26845 descent
= it
->descent
- (base_height
- height
) / 2;
26846 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26847 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26848 - metrics_upper
.descent
);
26849 /* Don't make the height shorter than the base height. */
26850 if (height
> base_height
)
26852 it
->ascent
= ascent
;
26853 it
->descent
= descent
;
26857 it
->phys_ascent
= it
->ascent
;
26858 it
->phys_descent
= it
->descent
;
26860 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26861 upper_xoff
, upper_yoff
,
26862 lower_xoff
, lower_yoff
);
26864 take_vertical_position_into_account (it
);
26869 Produce glyphs/get display metrics for the display element IT is
26870 loaded with. See the description of struct it in dispextern.h
26871 for an overview of struct it. */
26874 x_produce_glyphs (struct it
*it
)
26876 int extra_line_spacing
= it
->extra_line_spacing
;
26878 it
->glyph_not_available_p
= false;
26880 if (it
->what
== IT_CHARACTER
)
26883 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26884 struct font
*font
= face
->font
;
26885 struct font_metrics
*pcm
= NULL
;
26886 int boff
; /* Baseline offset. */
26890 /* When no suitable font is found, display this character by
26891 the method specified in the first extra slot of
26892 Vglyphless_char_display. */
26893 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26895 eassert (it
->what
== IT_GLYPHLESS
);
26896 produce_glyphless_glyph (it
, true,
26897 STRINGP (acronym
) ? acronym
: Qnil
);
26901 boff
= font
->baseline_offset
;
26902 if (font
->vertical_centering
)
26903 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26905 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26909 if (it
->override_ascent
>= 0)
26911 it
->ascent
= it
->override_ascent
;
26912 it
->descent
= it
->override_descent
;
26913 boff
= it
->override_boff
;
26917 it
->ascent
= FONT_BASE (font
) + boff
;
26918 it
->descent
= FONT_DESCENT (font
) - boff
;
26921 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26923 pcm
= get_per_char_metric (font
, &char2b
);
26924 if (pcm
->width
== 0
26925 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26931 it
->phys_ascent
= pcm
->ascent
+ boff
;
26932 it
->phys_descent
= pcm
->descent
- boff
;
26933 it
->pixel_width
= pcm
->width
;
26934 /* Don't use font-global values for ascent and descent
26935 if they result in an exceedingly large line height. */
26936 if (it
->override_ascent
< 0)
26938 if (FONT_TOO_HIGH (font
))
26940 it
->ascent
= it
->phys_ascent
;
26941 it
->descent
= it
->phys_descent
;
26942 /* These limitations are enforced by an
26943 assertion near the end of this function. */
26944 if (it
->ascent
< 0)
26946 if (it
->descent
< 0)
26953 it
->glyph_not_available_p
= true;
26954 it
->phys_ascent
= it
->ascent
;
26955 it
->phys_descent
= it
->descent
;
26956 it
->pixel_width
= font
->space_width
;
26959 if (it
->constrain_row_ascent_descent_p
)
26961 if (it
->descent
> it
->max_descent
)
26963 it
->ascent
+= it
->descent
- it
->max_descent
;
26964 it
->descent
= it
->max_descent
;
26966 if (it
->ascent
> it
->max_ascent
)
26968 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26969 it
->ascent
= it
->max_ascent
;
26971 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26972 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26973 extra_line_spacing
= 0;
26976 /* If this is a space inside a region of text with
26977 `space-width' property, change its width. */
26979 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26981 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26983 /* If face has a box, add the box thickness to the character
26984 height. If character has a box line to the left and/or
26985 right, add the box line width to the character's width. */
26986 if (face
->box
!= FACE_NO_BOX
)
26988 int thick
= face
->box_line_width
;
26992 it
->ascent
+= thick
;
26993 it
->descent
+= thick
;
26998 if (it
->start_of_box_run_p
)
26999 it
->pixel_width
+= thick
;
27000 if (it
->end_of_box_run_p
)
27001 it
->pixel_width
+= thick
;
27004 /* If face has an overline, add the height of the overline
27005 (1 pixel) and a 1 pixel margin to the character height. */
27006 if (face
->overline_p
)
27007 it
->ascent
+= overline_margin
;
27009 if (it
->constrain_row_ascent_descent_p
)
27011 if (it
->ascent
> it
->max_ascent
)
27012 it
->ascent
= it
->max_ascent
;
27013 if (it
->descent
> it
->max_descent
)
27014 it
->descent
= it
->max_descent
;
27017 take_vertical_position_into_account (it
);
27019 /* If we have to actually produce glyphs, do it. */
27024 /* Translate a space with a `space-width' property
27025 into a stretch glyph. */
27026 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
27027 / FONT_HEIGHT (font
));
27028 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27029 it
->ascent
+ it
->descent
, ascent
);
27034 /* If characters with lbearing or rbearing are displayed
27035 in this line, record that fact in a flag of the
27036 glyph row. This is used to optimize X output code. */
27037 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
27038 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27040 if (! stretched_p
&& it
->pixel_width
== 0)
27041 /* We assure that all visible glyphs have at least 1-pixel
27043 it
->pixel_width
= 1;
27045 else if (it
->char_to_display
== '\n')
27047 /* A newline has no width, but we need the height of the
27048 line. But if previous part of the line sets a height,
27049 don't increase that height. */
27051 Lisp_Object height
;
27052 Lisp_Object total_height
= Qnil
;
27054 it
->override_ascent
= -1;
27055 it
->pixel_width
= 0;
27058 height
= get_it_property (it
, Qline_height
);
27059 /* Split (line-height total-height) list. */
27061 && CONSP (XCDR (height
))
27062 && NILP (XCDR (XCDR (height
))))
27064 total_height
= XCAR (XCDR (height
));
27065 height
= XCAR (height
);
27067 height
= calc_line_height_property (it
, height
, font
, boff
, true);
27069 if (it
->override_ascent
>= 0)
27071 it
->ascent
= it
->override_ascent
;
27072 it
->descent
= it
->override_descent
;
27073 boff
= it
->override_boff
;
27077 if (FONT_TOO_HIGH (font
))
27079 it
->ascent
= font
->pixel_size
+ boff
- 1;
27080 it
->descent
= -boff
+ 1;
27081 if (it
->descent
< 0)
27086 it
->ascent
= FONT_BASE (font
) + boff
;
27087 it
->descent
= FONT_DESCENT (font
) - boff
;
27091 if (EQ (height
, Qt
))
27093 if (it
->descent
> it
->max_descent
)
27095 it
->ascent
+= it
->descent
- it
->max_descent
;
27096 it
->descent
= it
->max_descent
;
27098 if (it
->ascent
> it
->max_ascent
)
27100 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
27101 it
->ascent
= it
->max_ascent
;
27103 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
27104 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
27105 it
->constrain_row_ascent_descent_p
= true;
27106 extra_line_spacing
= 0;
27110 Lisp_Object spacing
;
27112 it
->phys_ascent
= it
->ascent
;
27113 it
->phys_descent
= it
->descent
;
27115 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
27116 && face
->box
!= FACE_NO_BOX
27117 && face
->box_line_width
> 0)
27119 it
->ascent
+= face
->box_line_width
;
27120 it
->descent
+= face
->box_line_width
;
27123 && XINT (height
) > it
->ascent
+ it
->descent
)
27124 it
->ascent
= XINT (height
) - it
->descent
;
27126 if (!NILP (total_height
))
27127 spacing
= calc_line_height_property (it
, total_height
, font
,
27131 spacing
= get_it_property (it
, Qline_spacing
);
27132 spacing
= calc_line_height_property (it
, spacing
, font
,
27135 if (INTEGERP (spacing
))
27137 extra_line_spacing
= XINT (spacing
);
27138 if (!NILP (total_height
))
27139 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
27143 else /* i.e. (it->char_to_display == '\t') */
27145 if (font
->space_width
> 0)
27147 int tab_width
= it
->tab_width
* font
->space_width
;
27148 int x
= it
->current_x
+ it
->continuation_lines_width
;
27149 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
27151 /* If the distance from the current position to the next tab
27152 stop is less than a space character width, use the
27153 tab stop after that. */
27154 if (next_tab_x
- x
< font
->space_width
)
27155 next_tab_x
+= tab_width
;
27157 it
->pixel_width
= next_tab_x
- x
;
27159 if (FONT_TOO_HIGH (font
))
27161 if (get_char_glyph_code (' ', font
, &char2b
))
27163 pcm
= get_per_char_metric (font
, &char2b
);
27164 if (pcm
->width
== 0
27165 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
27171 it
->ascent
= pcm
->ascent
+ boff
;
27172 it
->descent
= pcm
->descent
- boff
;
27176 it
->ascent
= font
->pixel_size
+ boff
- 1;
27177 it
->descent
= -boff
+ 1;
27179 if (it
->ascent
< 0)
27181 if (it
->descent
< 0)
27186 it
->ascent
= FONT_BASE (font
) + boff
;
27187 it
->descent
= FONT_DESCENT (font
) - boff
;
27189 it
->phys_ascent
= it
->ascent
;
27190 it
->phys_descent
= it
->descent
;
27194 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
27195 it
->ascent
+ it
->descent
, it
->ascent
);
27200 it
->pixel_width
= 0;
27205 if (FONT_TOO_HIGH (font
))
27207 int font_ascent
, font_descent
;
27209 /* For very large fonts, where we ignore the declared font
27210 dimensions, and go by per-character metrics instead,
27211 don't let the row ascent and descent values (and the row
27212 height computed from them) be smaller than the "normal"
27213 character metrics. This avoids unpleasant effects
27214 whereby lines on display would change their height
27215 depending on which characters are shown. */
27216 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27217 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
27218 it
->max_descent
= max (it
->max_descent
, font_descent
);
27221 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
27223 /* A static composition.
27225 Note: A composition is represented as one glyph in the
27226 glyph matrix. There are no padding glyphs.
27228 Important note: pixel_width, ascent, and descent are the
27229 values of what is drawn by draw_glyphs (i.e. the values of
27230 the overall glyphs composed). */
27231 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27232 int boff
; /* baseline offset */
27233 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
27234 int glyph_len
= cmp
->glyph_len
;
27235 struct font
*font
= face
->font
;
27239 /* If we have not yet calculated pixel size data of glyphs of
27240 the composition for the current face font, calculate them
27241 now. Theoretically, we have to check all fonts for the
27242 glyphs, but that requires much time and memory space. So,
27243 here we check only the font of the first glyph. This may
27244 lead to incorrect display, but it's very rare, and C-l
27245 (recenter-top-bottom) can correct the display anyway. */
27246 if (! cmp
->font
|| cmp
->font
!= font
)
27248 /* Ascent and descent of the font of the first character
27249 of this composition (adjusted by baseline offset).
27250 Ascent and descent of overall glyphs should not be less
27251 than these, respectively. */
27252 int font_ascent
, font_descent
, font_height
;
27253 /* Bounding box of the overall glyphs. */
27254 int leftmost
, rightmost
, lowest
, highest
;
27255 int lbearing
, rbearing
;
27256 int i
, width
, ascent
, descent
;
27257 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
27259 struct font_metrics
*pcm
;
27262 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
27263 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
27265 bool right_padded
= glyph_len
< cmp
->glyph_len
;
27266 for (i
= 0; i
< glyph_len
; i
++)
27268 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
27270 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27272 bool left_padded
= i
> 0;
27274 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
27275 : IT_CHARPOS (*it
));
27276 /* If no suitable font is found, use the default font. */
27277 bool font_not_found_p
= font
== NULL
;
27278 if (font_not_found_p
)
27280 face
= face
->ascii_face
;
27283 boff
= font
->baseline_offset
;
27284 if (font
->vertical_centering
)
27285 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
27286 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
27287 font_ascent
+= boff
;
27288 font_descent
-= boff
;
27289 font_height
= font_ascent
+ font_descent
;
27294 if (! font_not_found_p
)
27296 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
27298 pcm
= get_per_char_metric (font
, &char2b
);
27301 /* Initialize the bounding box. */
27304 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
27305 ascent
= pcm
->ascent
;
27306 descent
= pcm
->descent
;
27307 lbearing
= pcm
->lbearing
;
27308 rbearing
= pcm
->rbearing
;
27312 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27313 ascent
= FONT_BASE (font
);
27314 descent
= FONT_DESCENT (font
);
27321 lowest
= - descent
+ boff
;
27322 highest
= ascent
+ boff
;
27324 if (! font_not_found_p
27325 && font
->default_ascent
27326 && CHAR_TABLE_P (Vuse_default_ascent
)
27327 && !NILP (Faref (Vuse_default_ascent
,
27328 make_number (it
->char_to_display
))))
27329 highest
= font
->default_ascent
+ boff
;
27331 /* Draw the first glyph at the normal position. It may be
27332 shifted to right later if some other glyphs are drawn
27334 cmp
->offsets
[i
* 2] = 0;
27335 cmp
->offsets
[i
* 2 + 1] = boff
;
27336 cmp
->lbearing
= lbearing
;
27337 cmp
->rbearing
= rbearing
;
27339 /* Set cmp->offsets for the remaining glyphs. */
27340 for (i
++; i
< glyph_len
; i
++)
27342 int left
, right
, btm
, top
;
27343 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27345 struct face
*this_face
;
27349 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27350 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27351 font
= this_face
->font
;
27357 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27359 pcm
= get_per_char_metric (font
, &char2b
);
27362 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27365 width
= pcm
->width
;
27366 ascent
= pcm
->ascent
;
27367 descent
= pcm
->descent
;
27368 lbearing
= pcm
->lbearing
;
27369 rbearing
= pcm
->rbearing
;
27370 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27372 /* Relative composition with or without
27373 alternate chars. */
27374 left
= (leftmost
+ rightmost
- width
) / 2;
27375 btm
= - descent
+ boff
;
27376 if (font
->relative_compose
27377 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27378 || NILP (Faref (Vignore_relative_composition
,
27379 make_number (ch
)))))
27382 if (- descent
>= font
->relative_compose
)
27383 /* One extra pixel between two glyphs. */
27385 else if (ascent
<= 0)
27386 /* One extra pixel between two glyphs. */
27387 btm
= lowest
- 1 - ascent
- descent
;
27392 /* A composition rule is specified by an integer
27393 value that encodes global and new reference
27394 points (GREF and NREF). GREF and NREF are
27395 specified by numbers as below:
27397 0---1---2 -- ascent
27401 9--10--11 -- center
27403 ---3---4---5--- baseline
27405 6---7---8 -- descent
27407 int rule
= COMPOSITION_RULE (cmp
, i
);
27408 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27410 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27411 grefx
= gref
% 3, nrefx
= nref
% 3;
27412 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27414 xoff
= font_height
* (xoff
- 128) / 256;
27416 yoff
= font_height
* (yoff
- 128) / 256;
27419 + grefx
* (rightmost
- leftmost
) / 2
27420 - nrefx
* width
/ 2
27423 btm
= ((grefy
== 0 ? highest
27425 : grefy
== 2 ? lowest
27426 : (highest
+ lowest
) / 2)
27427 - (nrefy
== 0 ? ascent
+ descent
27428 : nrefy
== 1 ? descent
- boff
27430 : (ascent
+ descent
) / 2)
27434 cmp
->offsets
[i
* 2] = left
;
27435 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27437 /* Update the bounding box of the overall glyphs. */
27440 right
= left
+ width
;
27441 if (left
< leftmost
)
27443 if (right
> rightmost
)
27446 top
= btm
+ descent
+ ascent
;
27452 if (cmp
->lbearing
> left
+ lbearing
)
27453 cmp
->lbearing
= left
+ lbearing
;
27454 if (cmp
->rbearing
< left
+ rbearing
)
27455 cmp
->rbearing
= left
+ rbearing
;
27459 /* If there are glyphs whose x-offsets are negative,
27460 shift all glyphs to the right and make all x-offsets
27464 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27465 cmp
->offsets
[i
* 2] -= leftmost
;
27466 rightmost
-= leftmost
;
27467 cmp
->lbearing
-= leftmost
;
27468 cmp
->rbearing
-= leftmost
;
27471 if (left_padded
&& cmp
->lbearing
< 0)
27473 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27474 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27475 rightmost
-= cmp
->lbearing
;
27476 cmp
->rbearing
-= cmp
->lbearing
;
27479 if (right_padded
&& rightmost
< cmp
->rbearing
)
27481 rightmost
= cmp
->rbearing
;
27484 cmp
->pixel_width
= rightmost
;
27485 cmp
->ascent
= highest
;
27486 cmp
->descent
= - lowest
;
27487 if (cmp
->ascent
< font_ascent
)
27488 cmp
->ascent
= font_ascent
;
27489 if (cmp
->descent
< font_descent
)
27490 cmp
->descent
= font_descent
;
27494 && (cmp
->lbearing
< 0
27495 || cmp
->rbearing
> cmp
->pixel_width
))
27496 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27498 it
->pixel_width
= cmp
->pixel_width
;
27499 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27500 it
->descent
= it
->phys_descent
= cmp
->descent
;
27501 if (face
->box
!= FACE_NO_BOX
)
27503 int thick
= face
->box_line_width
;
27507 it
->ascent
+= thick
;
27508 it
->descent
+= thick
;
27513 if (it
->start_of_box_run_p
)
27514 it
->pixel_width
+= thick
;
27515 if (it
->end_of_box_run_p
)
27516 it
->pixel_width
+= thick
;
27519 /* If face has an overline, add the height of the overline
27520 (1 pixel) and a 1 pixel margin to the character height. */
27521 if (face
->overline_p
)
27522 it
->ascent
+= overline_margin
;
27524 take_vertical_position_into_account (it
);
27525 if (it
->ascent
< 0)
27527 if (it
->descent
< 0)
27530 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27531 append_composite_glyph (it
);
27533 else if (it
->what
== IT_COMPOSITION
)
27535 /* A dynamic (automatic) composition. */
27536 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27537 Lisp_Object gstring
;
27538 struct font_metrics metrics
;
27542 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27544 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27547 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27548 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27549 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27550 it
->descent
= it
->phys_descent
= metrics
.descent
;
27551 if (face
->box
!= FACE_NO_BOX
)
27553 int thick
= face
->box_line_width
;
27557 it
->ascent
+= thick
;
27558 it
->descent
+= thick
;
27563 if (it
->start_of_box_run_p
)
27564 it
->pixel_width
+= thick
;
27565 if (it
->end_of_box_run_p
)
27566 it
->pixel_width
+= thick
;
27568 /* If face has an overline, add the height of the overline
27569 (1 pixel) and a 1 pixel margin to the character height. */
27570 if (face
->overline_p
)
27571 it
->ascent
+= overline_margin
;
27572 take_vertical_position_into_account (it
);
27573 if (it
->ascent
< 0)
27575 if (it
->descent
< 0)
27579 append_composite_glyph (it
);
27581 else if (it
->what
== IT_GLYPHLESS
)
27582 produce_glyphless_glyph (it
, false, Qnil
);
27583 else if (it
->what
== IT_IMAGE
)
27584 produce_image_glyph (it
);
27585 else if (it
->what
== IT_STRETCH
)
27586 produce_stretch_glyph (it
);
27587 else if (it
->what
== IT_XWIDGET
)
27588 produce_xwidget_glyph (it
);
27591 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27592 because this isn't true for images with `:ascent 100'. */
27593 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27594 if (it
->area
== TEXT_AREA
)
27595 it
->current_x
+= it
->pixel_width
;
27597 if (extra_line_spacing
> 0)
27599 it
->descent
+= extra_line_spacing
;
27600 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27601 it
->max_extra_line_spacing
= extra_line_spacing
;
27604 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27605 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27606 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27607 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27611 Output LEN glyphs starting at START at the nominal cursor position.
27612 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27613 being updated, and UPDATED_AREA is the area of that row being updated. */
27616 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27617 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27619 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27621 eassert (updated_row
);
27622 /* When the window is hscrolled, cursor hpos can legitimately be out
27623 of bounds, but we draw the cursor at the corresponding window
27624 margin in that case. */
27625 if (!updated_row
->reversed_p
&& chpos
< 0)
27627 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27628 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27632 /* Write glyphs. */
27634 hpos
= start
- updated_row
->glyphs
[updated_area
];
27635 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27636 updated_row
, updated_area
,
27638 DRAW_NORMAL_TEXT
, 0);
27640 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27641 if (updated_area
== TEXT_AREA
27642 && w
->phys_cursor_on_p
27643 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27645 && chpos
< hpos
+ len
)
27646 w
->phys_cursor_on_p
= false;
27650 /* Advance the output cursor. */
27651 w
->output_cursor
.hpos
+= len
;
27652 w
->output_cursor
.x
= x
;
27657 Insert LEN glyphs from START at the nominal cursor position. */
27660 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27661 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27664 int line_height
, shift_by_width
, shifted_region_width
;
27665 struct glyph_row
*row
;
27666 struct glyph
*glyph
;
27667 int frame_x
, frame_y
;
27670 eassert (updated_row
);
27672 f
= XFRAME (WINDOW_FRAME (w
));
27674 /* Get the height of the line we are in. */
27676 line_height
= row
->height
;
27678 /* Get the width of the glyphs to insert. */
27679 shift_by_width
= 0;
27680 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27681 shift_by_width
+= glyph
->pixel_width
;
27683 /* Get the width of the region to shift right. */
27684 shifted_region_width
= (window_box_width (w
, updated_area
)
27685 - w
->output_cursor
.x
27689 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27690 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27692 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27693 line_height
, shift_by_width
);
27695 /* Write the glyphs. */
27696 hpos
= start
- row
->glyphs
[updated_area
];
27697 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27699 DRAW_NORMAL_TEXT
, 0);
27701 /* Advance the output cursor. */
27702 w
->output_cursor
.hpos
+= len
;
27703 w
->output_cursor
.x
+= shift_by_width
;
27709 Erase the current text line from the nominal cursor position
27710 (inclusive) to pixel column TO_X (exclusive). The idea is that
27711 everything from TO_X onward is already erased.
27713 TO_X is a pixel position relative to UPDATED_AREA of currently
27714 updated window W. TO_X == -1 means clear to the end of this area. */
27717 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27718 enum glyph_row_area updated_area
, int to_x
)
27721 int max_x
, min_y
, max_y
;
27722 int from_x
, from_y
, to_y
;
27724 eassert (updated_row
);
27725 f
= XFRAME (w
->frame
);
27727 if (updated_row
->full_width_p
)
27728 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27729 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27731 max_x
= window_box_width (w
, updated_area
);
27732 max_y
= window_text_bottom_y (w
);
27734 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27735 of window. For TO_X > 0, truncate to end of drawing area. */
27741 to_x
= min (to_x
, max_x
);
27743 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27745 /* Notice if the cursor will be cleared by this operation. */
27746 if (!updated_row
->full_width_p
)
27747 notice_overwritten_cursor (w
, updated_area
,
27748 w
->output_cursor
.x
, -1,
27750 MATRIX_ROW_BOTTOM_Y (updated_row
));
27752 from_x
= w
->output_cursor
.x
;
27754 /* Translate to frame coordinates. */
27755 if (updated_row
->full_width_p
)
27757 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27758 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27762 int area_left
= window_box_left (w
, updated_area
);
27763 from_x
+= area_left
;
27767 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27768 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27769 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27771 /* Prevent inadvertently clearing to end of the X window. */
27772 if (to_x
> from_x
&& to_y
> from_y
)
27775 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27776 to_x
- from_x
, to_y
- from_y
);
27781 #endif /* HAVE_WINDOW_SYSTEM */
27785 /***********************************************************************
27787 ***********************************************************************/
27789 /* Value is the internal representation of the specified cursor type
27790 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27791 of the bar cursor. */
27793 static enum text_cursor_kinds
27794 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27796 enum text_cursor_kinds type
;
27801 if (EQ (arg
, Qbox
))
27802 return FILLED_BOX_CURSOR
;
27804 if (EQ (arg
, Qhollow
))
27805 return HOLLOW_BOX_CURSOR
;
27807 if (EQ (arg
, Qbar
))
27814 && EQ (XCAR (arg
), Qbar
)
27815 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27817 *width
= XINT (XCDR (arg
));
27821 if (EQ (arg
, Qhbar
))
27824 return HBAR_CURSOR
;
27828 && EQ (XCAR (arg
), Qhbar
)
27829 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27831 *width
= XINT (XCDR (arg
));
27832 return HBAR_CURSOR
;
27835 /* Treat anything unknown as "hollow box cursor".
27836 It was bad to signal an error; people have trouble fixing
27837 .Xdefaults with Emacs, when it has something bad in it. */
27838 type
= HOLLOW_BOX_CURSOR
;
27843 /* Set the default cursor types for specified frame. */
27845 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27850 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27851 FRAME_CURSOR_WIDTH (f
) = width
;
27853 /* By default, set up the blink-off state depending on the on-state. */
27855 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27858 FRAME_BLINK_OFF_CURSOR (f
)
27859 = get_specified_cursor_type (XCDR (tem
), &width
);
27860 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27863 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27865 /* Make sure the cursor gets redrawn. */
27866 f
->cursor_type_changed
= true;
27870 #ifdef HAVE_WINDOW_SYSTEM
27872 /* Return the cursor we want to be displayed in window W. Return
27873 width of bar/hbar cursor through WIDTH arg. Return with
27874 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27875 (i.e. if the `system caret' should track this cursor).
27877 In a mini-buffer window, we want the cursor only to appear if we
27878 are reading input from this window. For the selected window, we
27879 want the cursor type given by the frame parameter or buffer local
27880 setting of cursor-type. If explicitly marked off, draw no cursor.
27881 In all other cases, we want a hollow box cursor. */
27883 static enum text_cursor_kinds
27884 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27885 bool *active_cursor
)
27887 struct frame
*f
= XFRAME (w
->frame
);
27888 struct buffer
*b
= XBUFFER (w
->contents
);
27889 int cursor_type
= DEFAULT_CURSOR
;
27890 Lisp_Object alt_cursor
;
27891 bool non_selected
= false;
27893 *active_cursor
= true;
27896 if (cursor_in_echo_area
27897 && FRAME_HAS_MINIBUF_P (f
)
27898 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27900 if (w
== XWINDOW (echo_area_window
))
27902 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27904 *width
= FRAME_CURSOR_WIDTH (f
);
27905 return FRAME_DESIRED_CURSOR (f
);
27908 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27911 *active_cursor
= false;
27912 non_selected
= true;
27915 /* Detect a nonselected window or nonselected frame. */
27916 else if (w
!= XWINDOW (f
->selected_window
)
27917 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27919 *active_cursor
= false;
27921 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27924 non_selected
= true;
27927 /* Never display a cursor in a window in which cursor-type is nil. */
27928 if (NILP (BVAR (b
, cursor_type
)))
27931 /* Get the normal cursor type for this window. */
27932 if (EQ (BVAR (b
, cursor_type
), Qt
))
27934 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27935 *width
= FRAME_CURSOR_WIDTH (f
);
27938 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27940 /* Use cursor-in-non-selected-windows instead
27941 for non-selected window or frame. */
27944 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27945 if (!EQ (Qt
, alt_cursor
))
27946 return get_specified_cursor_type (alt_cursor
, width
);
27947 /* t means modify the normal cursor type. */
27948 if (cursor_type
== FILLED_BOX_CURSOR
)
27949 cursor_type
= HOLLOW_BOX_CURSOR
;
27950 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27952 return cursor_type
;
27955 /* Use normal cursor if not blinked off. */
27956 if (!w
->cursor_off_p
)
27958 if (glyph
!= NULL
&& glyph
->type
== XWIDGET_GLYPH
)
27960 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27962 if (cursor_type
== FILLED_BOX_CURSOR
)
27964 /* Using a block cursor on large images can be very annoying.
27965 So use a hollow cursor for "large" images.
27966 If image is not transparent (no mask), also use hollow cursor. */
27967 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27968 if (img
!= NULL
&& IMAGEP (img
->spec
))
27970 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27971 where N = size of default frame font size.
27972 This should cover most of the "tiny" icons people may use. */
27974 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27975 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27976 cursor_type
= HOLLOW_BOX_CURSOR
;
27979 else if (cursor_type
!= NO_CURSOR
)
27981 /* Display current only supports BOX and HOLLOW cursors for images.
27982 So for now, unconditionally use a HOLLOW cursor when cursor is
27983 not a solid box cursor. */
27984 cursor_type
= HOLLOW_BOX_CURSOR
;
27987 return cursor_type
;
27990 /* Cursor is blinked off, so determine how to "toggle" it. */
27992 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27993 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27994 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27996 /* Then see if frame has specified a specific blink off cursor type. */
27997 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27999 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
28000 return FRAME_BLINK_OFF_CURSOR (f
);
28004 /* Some people liked having a permanently visible blinking cursor,
28005 while others had very strong opinions against it. So it was
28006 decided to remove it. KFS 2003-09-03 */
28008 /* Finally perform built-in cursor blinking:
28009 filled box <-> hollow box
28010 wide [h]bar <-> narrow [h]bar
28011 narrow [h]bar <-> no cursor
28012 other type <-> no cursor */
28014 if (cursor_type
== FILLED_BOX_CURSOR
)
28015 return HOLLOW_BOX_CURSOR
;
28017 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
28020 return cursor_type
;
28028 /* Notice when the text cursor of window W has been completely
28029 overwritten by a drawing operation that outputs glyphs in AREA
28030 starting at X0 and ending at X1 in the line starting at Y0 and
28031 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28032 the rest of the line after X0 has been written. Y coordinates
28033 are window-relative. */
28036 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
28037 int x0
, int x1
, int y0
, int y1
)
28039 int cx0
, cx1
, cy0
, cy1
;
28040 struct glyph_row
*row
;
28042 if (!w
->phys_cursor_on_p
)
28044 if (area
!= TEXT_AREA
)
28047 if (w
->phys_cursor
.vpos
< 0
28048 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
28049 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
28050 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
28053 if (row
->cursor_in_fringe_p
)
28055 row
->cursor_in_fringe_p
= false;
28056 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
28057 w
->phys_cursor_on_p
= false;
28061 cx0
= w
->phys_cursor
.x
;
28062 cx1
= cx0
+ w
->phys_cursor_width
;
28063 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
28066 /* The cursor image will be completely removed from the
28067 screen if the output area intersects the cursor area in
28068 y-direction. When we draw in [y0 y1[, and some part of
28069 the cursor is at y < y0, that part must have been drawn
28070 before. When scrolling, the cursor is erased before
28071 actually scrolling, so we don't come here. When not
28072 scrolling, the rows above the old cursor row must have
28073 changed, and in this case these rows must have written
28074 over the cursor image.
28076 Likewise if part of the cursor is below y1, with the
28077 exception of the cursor being in the first blank row at
28078 the buffer and window end because update_text_area
28079 doesn't draw that row. (Except when it does, but
28080 that's handled in update_text_area.) */
28082 cy0
= w
->phys_cursor
.y
;
28083 cy1
= cy0
+ w
->phys_cursor_height
;
28084 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
28087 w
->phys_cursor_on_p
= false;
28090 #endif /* HAVE_WINDOW_SYSTEM */
28093 /************************************************************************
28095 ************************************************************************/
28097 #ifdef HAVE_WINDOW_SYSTEM
28100 Fix the display of area AREA of overlapping row ROW in window W
28101 with respect to the overlapping part OVERLAPS. */
28104 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
28105 enum glyph_row_area area
, int overlaps
)
28112 for (i
= 0; i
< row
->used
[area
];)
28114 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
28116 int start
= i
, start_x
= x
;
28120 x
+= row
->glyphs
[area
][i
].pixel_width
;
28123 while (i
< row
->used
[area
]
28124 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
28126 draw_glyphs (w
, start_x
, row
, area
,
28128 DRAW_NORMAL_TEXT
, overlaps
);
28132 x
+= row
->glyphs
[area
][i
].pixel_width
;
28142 Draw the cursor glyph of window W in glyph row ROW. See the
28143 comment of draw_glyphs for the meaning of HL. */
28146 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
28147 enum draw_glyphs_face hl
)
28149 /* If cursor hpos is out of bounds, don't draw garbage. This can
28150 happen in mini-buffer windows when switching between echo area
28151 glyphs and mini-buffer. */
28152 if ((row
->reversed_p
28153 ? (w
->phys_cursor
.hpos
>= 0)
28154 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
28156 bool on_p
= w
->phys_cursor_on_p
;
28158 int hpos
= w
->phys_cursor
.hpos
;
28160 /* When the window is hscrolled, cursor hpos can legitimately be
28161 out of bounds, but we draw the cursor at the corresponding
28162 window margin in that case. */
28163 if (!row
->reversed_p
&& hpos
< 0)
28165 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28166 hpos
= row
->used
[TEXT_AREA
] - 1;
28168 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
28170 w
->phys_cursor_on_p
= on_p
;
28172 if (hl
== DRAW_CURSOR
)
28173 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28174 /* When we erase the cursor, and ROW is overlapped by other
28175 rows, make sure that these overlapping parts of other rows
28177 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
28179 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
28181 if (row
> w
->current_matrix
->rows
28182 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
28183 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
28184 OVERLAPS_ERASED_CURSOR
);
28186 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
28187 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
28188 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
28189 OVERLAPS_ERASED_CURSOR
);
28195 /* Erase the image of a cursor of window W from the screen. */
28198 erase_phys_cursor (struct window
*w
)
28200 struct frame
*f
= XFRAME (w
->frame
);
28201 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28202 int hpos
= w
->phys_cursor
.hpos
;
28203 int vpos
= w
->phys_cursor
.vpos
;
28204 bool mouse_face_here_p
= false;
28205 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
28206 struct glyph_row
*cursor_row
;
28207 struct glyph
*cursor_glyph
;
28208 enum draw_glyphs_face hl
;
28210 /* No cursor displayed or row invalidated => nothing to do on the
28212 if (w
->phys_cursor_type
== NO_CURSOR
)
28213 goto mark_cursor_off
;
28215 /* VPOS >= active_glyphs->nrows means that window has been resized.
28216 Don't bother to erase the cursor. */
28217 if (vpos
>= active_glyphs
->nrows
)
28218 goto mark_cursor_off
;
28220 /* If row containing cursor is marked invalid, there is nothing we
28222 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
28223 if (!cursor_row
->enabled_p
)
28224 goto mark_cursor_off
;
28226 /* If line spacing is > 0, old cursor may only be partially visible in
28227 window after split-window. So adjust visible height. */
28228 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
28229 window_text_bottom_y (w
) - cursor_row
->y
);
28231 /* If row is completely invisible, don't attempt to delete a cursor which
28232 isn't there. This can happen if cursor is at top of a window, and
28233 we switch to a buffer with a header line in that window. */
28234 if (cursor_row
->visible_height
<= 0)
28235 goto mark_cursor_off
;
28237 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28238 if (cursor_row
->cursor_in_fringe_p
)
28240 cursor_row
->cursor_in_fringe_p
= false;
28241 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
28242 goto mark_cursor_off
;
28245 /* This can happen when the new row is shorter than the old one.
28246 In this case, either draw_glyphs or clear_end_of_line
28247 should have cleared the cursor. Note that we wouldn't be
28248 able to erase the cursor in this case because we don't have a
28249 cursor glyph at hand. */
28250 if ((cursor_row
->reversed_p
28251 ? (w
->phys_cursor
.hpos
< 0)
28252 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
28253 goto mark_cursor_off
;
28255 /* When the window is hscrolled, cursor hpos can legitimately be out
28256 of bounds, but we draw the cursor at the corresponding window
28257 margin in that case. */
28258 if (!cursor_row
->reversed_p
&& hpos
< 0)
28260 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
28261 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
28263 /* If the cursor is in the mouse face area, redisplay that when
28264 we clear the cursor. */
28265 if (! NILP (hlinfo
->mouse_face_window
)
28266 && coords_in_mouse_face_p (w
, hpos
, vpos
)
28267 /* Don't redraw the cursor's spot in mouse face if it is at the
28268 end of a line (on a newline). The cursor appears there, but
28269 mouse highlighting does not. */
28270 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
28271 mouse_face_here_p
= true;
28273 /* Maybe clear the display under the cursor. */
28274 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
28277 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
28280 cursor_glyph
= get_phys_cursor_glyph (w
);
28281 if (cursor_glyph
== NULL
)
28282 goto mark_cursor_off
;
28284 width
= cursor_glyph
->pixel_width
;
28285 x
= w
->phys_cursor
.x
;
28291 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
28292 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
28293 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
28296 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
28299 /* Erase the cursor by redrawing the character underneath it. */
28300 if (mouse_face_here_p
)
28301 hl
= DRAW_MOUSE_FACE
;
28303 hl
= DRAW_NORMAL_TEXT
;
28304 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
28307 w
->phys_cursor_on_p
= false;
28308 w
->phys_cursor_type
= NO_CURSOR
;
28312 /* Display or clear cursor of window W. If !ON, clear the cursor.
28313 If ON, display the cursor; where to put the cursor is specified by
28314 HPOS, VPOS, X and Y. */
28317 display_and_set_cursor (struct window
*w
, bool on
,
28318 int hpos
, int vpos
, int x
, int y
)
28320 struct frame
*f
= XFRAME (w
->frame
);
28321 int new_cursor_type
;
28322 int new_cursor_width
;
28323 bool active_cursor
;
28324 struct glyph_row
*glyph_row
;
28325 struct glyph
*glyph
;
28327 /* This is pointless on invisible frames, and dangerous on garbaged
28328 windows and frames; in the latter case, the frame or window may
28329 be in the midst of changing its size, and x and y may be off the
28331 if (! FRAME_VISIBLE_P (f
)
28332 || FRAME_GARBAGED_P (f
)
28333 || vpos
>= w
->current_matrix
->nrows
28334 || hpos
>= w
->current_matrix
->matrix_w
)
28337 /* If cursor is off and we want it off, return quickly. */
28338 if (!on
&& !w
->phys_cursor_on_p
)
28341 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28342 /* If cursor row is not enabled, we don't really know where to
28343 display the cursor. */
28344 if (!glyph_row
->enabled_p
)
28346 w
->phys_cursor_on_p
= false;
28351 if (!glyph_row
->exact_window_width_line_p
28352 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28353 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28355 eassert (input_blocked_p ());
28357 /* Set new_cursor_type to the cursor we want to be displayed. */
28358 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28359 &new_cursor_width
, &active_cursor
);
28361 /* If cursor is currently being shown and we don't want it to be or
28362 it is in the wrong place, or the cursor type is not what we want,
28364 if (w
->phys_cursor_on_p
28366 || w
->phys_cursor
.x
!= x
28367 || w
->phys_cursor
.y
!= y
28368 /* HPOS can be negative in R2L rows whose
28369 exact_window_width_line_p flag is set (i.e. their newline
28370 would "overflow into the fringe"). */
28372 || new_cursor_type
!= w
->phys_cursor_type
28373 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28374 && new_cursor_width
!= w
->phys_cursor_width
)))
28375 erase_phys_cursor (w
);
28377 /* Don't check phys_cursor_on_p here because that flag is only set
28378 to false in some cases where we know that the cursor has been
28379 completely erased, to avoid the extra work of erasing the cursor
28380 twice. In other words, phys_cursor_on_p can be true and the cursor
28381 still not be visible, or it has only been partly erased. */
28384 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28385 w
->phys_cursor_height
= glyph_row
->height
;
28387 /* Set phys_cursor_.* before x_draw_.* is called because some
28388 of them may need the information. */
28389 w
->phys_cursor
.x
= x
;
28390 w
->phys_cursor
.y
= glyph_row
->y
;
28391 w
->phys_cursor
.hpos
= hpos
;
28392 w
->phys_cursor
.vpos
= vpos
;
28395 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28396 new_cursor_type
, new_cursor_width
,
28397 on
, active_cursor
);
28401 /* Switch the display of W's cursor on or off, according to the value
28405 update_window_cursor (struct window
*w
, bool on
)
28407 /* Don't update cursor in windows whose frame is in the process
28408 of being deleted. */
28409 if (w
->current_matrix
)
28411 int hpos
= w
->phys_cursor
.hpos
;
28412 int vpos
= w
->phys_cursor
.vpos
;
28413 struct glyph_row
*row
;
28415 if (vpos
>= w
->current_matrix
->nrows
28416 || hpos
>= w
->current_matrix
->matrix_w
)
28419 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28421 /* When the window is hscrolled, cursor hpos can legitimately be
28422 out of bounds, but we draw the cursor at the corresponding
28423 window margin in that case. */
28424 if (!row
->reversed_p
&& hpos
< 0)
28426 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28427 hpos
= row
->used
[TEXT_AREA
] - 1;
28430 display_and_set_cursor (w
, on
, hpos
, vpos
,
28431 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28437 /* Call update_window_cursor with parameter ON_P on all leaf windows
28438 in the window tree rooted at W. */
28441 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28445 if (WINDOWP (w
->contents
))
28446 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28448 update_window_cursor (w
, on_p
);
28450 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28456 Display the cursor on window W, or clear it, according to ON_P.
28457 Don't change the cursor's position. */
28460 x_update_cursor (struct frame
*f
, bool on_p
)
28462 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28467 Clear the cursor of window W to background color, and mark the
28468 cursor as not shown. This is used when the text where the cursor
28469 is about to be rewritten. */
28472 x_clear_cursor (struct window
*w
)
28474 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28475 update_window_cursor (w
, false);
28478 #endif /* HAVE_WINDOW_SYSTEM */
28480 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28483 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28484 int start_hpos
, int end_hpos
,
28485 enum draw_glyphs_face draw
)
28487 #ifdef HAVE_WINDOW_SYSTEM
28488 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28490 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28494 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28495 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28499 /* Display the active region described by mouse_face_* according to DRAW. */
28502 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28504 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28505 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28507 if (/* If window is in the process of being destroyed, don't bother
28509 w
->current_matrix
!= NULL
28510 /* Don't update mouse highlight if hidden. */
28511 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28512 /* Recognize when we are called to operate on rows that don't exist
28513 anymore. This can happen when a window is split. */
28514 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28516 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28517 struct glyph_row
*row
, *first
, *last
;
28519 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28520 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28522 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28524 int start_hpos
, end_hpos
, start_x
;
28526 /* For all but the first row, the highlight starts at column 0. */
28529 /* R2L rows have BEG and END in reversed order, but the
28530 screen drawing geometry is always left to right. So
28531 we need to mirror the beginning and end of the
28532 highlighted area in R2L rows. */
28533 if (!row
->reversed_p
)
28535 start_hpos
= hlinfo
->mouse_face_beg_col
;
28536 start_x
= hlinfo
->mouse_face_beg_x
;
28538 else if (row
== last
)
28540 start_hpos
= hlinfo
->mouse_face_end_col
;
28541 start_x
= hlinfo
->mouse_face_end_x
;
28549 else if (row
->reversed_p
&& row
== last
)
28551 start_hpos
= hlinfo
->mouse_face_end_col
;
28552 start_x
= hlinfo
->mouse_face_end_x
;
28562 if (!row
->reversed_p
)
28563 end_hpos
= hlinfo
->mouse_face_end_col
;
28564 else if (row
== first
)
28565 end_hpos
= hlinfo
->mouse_face_beg_col
;
28568 end_hpos
= row
->used
[TEXT_AREA
];
28569 if (draw
== DRAW_NORMAL_TEXT
)
28570 row
->fill_line_p
= true; /* Clear to end of line. */
28573 else if (row
->reversed_p
&& row
== first
)
28574 end_hpos
= hlinfo
->mouse_face_beg_col
;
28577 end_hpos
= row
->used
[TEXT_AREA
];
28578 if (draw
== DRAW_NORMAL_TEXT
)
28579 row
->fill_line_p
= true; /* Clear to end of line. */
28582 if (end_hpos
> start_hpos
)
28584 draw_row_with_mouse_face (w
, start_x
, row
,
28585 start_hpos
, end_hpos
, draw
);
28588 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28592 #ifdef HAVE_WINDOW_SYSTEM
28593 /* When we've written over the cursor, arrange for it to
28594 be displayed again. */
28595 if (FRAME_WINDOW_P (f
)
28596 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28598 int hpos
= w
->phys_cursor
.hpos
;
28600 /* When the window is hscrolled, cursor hpos can legitimately be
28601 out of bounds, but we draw the cursor at the corresponding
28602 window margin in that case. */
28603 if (!row
->reversed_p
&& hpos
< 0)
28605 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28606 hpos
= row
->used
[TEXT_AREA
] - 1;
28609 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28610 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28613 #endif /* HAVE_WINDOW_SYSTEM */
28616 #ifdef HAVE_WINDOW_SYSTEM
28617 /* Change the mouse cursor. */
28618 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28620 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28621 if (draw
== DRAW_NORMAL_TEXT
28622 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28623 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28626 if (draw
== DRAW_MOUSE_FACE
)
28627 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28629 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28631 #endif /* HAVE_WINDOW_SYSTEM */
28635 Clear out the mouse-highlighted active region.
28636 Redraw it un-highlighted first. Value is true if mouse
28637 face was actually drawn unhighlighted. */
28640 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28643 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28645 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28646 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28647 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28648 hlinfo
->mouse_face_window
= Qnil
;
28649 hlinfo
->mouse_face_overlay
= Qnil
;
28653 /* Return true if the coordinates HPOS and VPOS on windows W are
28654 within the mouse face on that window. */
28656 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28658 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28660 /* Quickly resolve the easy cases. */
28661 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28662 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28664 if (vpos
< hlinfo
->mouse_face_beg_row
28665 || vpos
> hlinfo
->mouse_face_end_row
)
28667 if (vpos
> hlinfo
->mouse_face_beg_row
28668 && vpos
< hlinfo
->mouse_face_end_row
)
28671 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28673 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28675 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28678 else if ((vpos
== hlinfo
->mouse_face_beg_row
28679 && hpos
>= hlinfo
->mouse_face_beg_col
)
28680 || (vpos
== hlinfo
->mouse_face_end_row
28681 && hpos
< hlinfo
->mouse_face_end_col
))
28686 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28688 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28691 else if ((vpos
== hlinfo
->mouse_face_beg_row
28692 && hpos
<= hlinfo
->mouse_face_beg_col
)
28693 || (vpos
== hlinfo
->mouse_face_end_row
28694 && hpos
> hlinfo
->mouse_face_end_col
))
28702 True if physical cursor of window W is within mouse face. */
28705 cursor_in_mouse_face_p (struct window
*w
)
28707 int hpos
= w
->phys_cursor
.hpos
;
28708 int vpos
= w
->phys_cursor
.vpos
;
28709 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28711 /* When the window is hscrolled, cursor hpos can legitimately be out
28712 of bounds, but we draw the cursor at the corresponding window
28713 margin in that case. */
28714 if (!row
->reversed_p
&& hpos
< 0)
28716 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28717 hpos
= row
->used
[TEXT_AREA
] - 1;
28719 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28724 /* Find the glyph rows START_ROW and END_ROW of window W that display
28725 characters between buffer positions START_CHARPOS and END_CHARPOS
28726 (excluding END_CHARPOS). DISP_STRING is a display string that
28727 covers these buffer positions. This is similar to
28728 row_containing_pos, but is more accurate when bidi reordering makes
28729 buffer positions change non-linearly with glyph rows. */
28731 rows_from_pos_range (struct window
*w
,
28732 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28733 Lisp_Object disp_string
,
28734 struct glyph_row
**start
, struct glyph_row
**end
)
28736 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28737 int last_y
= window_text_bottom_y (w
);
28738 struct glyph_row
*row
;
28743 while (!first
->enabled_p
28744 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28747 /* Find the START row. */
28749 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28752 /* A row can potentially be the START row if the range of the
28753 characters it displays intersects the range
28754 [START_CHARPOS..END_CHARPOS). */
28755 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28756 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28757 /* See the commentary in row_containing_pos, for the
28758 explanation of the complicated way to check whether
28759 some position is beyond the end of the characters
28760 displayed by a row. */
28761 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28762 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28763 && !row
->ends_at_zv_p
28764 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28765 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28766 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28767 && !row
->ends_at_zv_p
28768 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28770 /* Found a candidate row. Now make sure at least one of the
28771 glyphs it displays has a charpos from the range
28772 [START_CHARPOS..END_CHARPOS).
28774 This is not obvious because bidi reordering could make
28775 buffer positions of a row be 1,2,3,102,101,100, and if we
28776 want to highlight characters in [50..60), we don't want
28777 this row, even though [50..60) does intersect [1..103),
28778 the range of character positions given by the row's start
28779 and end positions. */
28780 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28781 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28785 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28786 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28787 /* A glyph that comes from DISP_STRING is by
28788 definition to be highlighted. */
28789 || EQ (g
->object
, disp_string
))
28798 /* Find the END row. */
28800 /* If the last row is partially visible, start looking for END
28801 from that row, instead of starting from FIRST. */
28802 && !(row
->enabled_p
28803 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28805 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28807 struct glyph_row
*next
= row
+ 1;
28808 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28810 if (!next
->enabled_p
28811 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28812 /* The first row >= START whose range of displayed characters
28813 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28814 is the row END + 1. */
28815 || (start_charpos
< next_start
28816 && end_charpos
< next_start
)
28817 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28818 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28819 && !next
->ends_at_zv_p
28820 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28821 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28822 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28823 && !next
->ends_at_zv_p
28824 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28831 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28832 but none of the characters it displays are in the range, it is
28834 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28835 struct glyph
*s
= g
;
28836 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28840 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28841 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28842 /* If the buffer position of the first glyph in
28843 the row is equal to END_CHARPOS, it means
28844 the last character to be highlighted is the
28845 newline of ROW, and we must consider NEXT as
28847 || (((!next
->reversed_p
&& g
== s
)
28848 || (next
->reversed_p
&& g
== e
- 1))
28849 && (g
->charpos
== end_charpos
28850 /* Special case for when NEXT is an
28851 empty line at ZV. */
28852 || (g
->charpos
== -1
28853 && !row
->ends_at_zv_p
28854 && next_start
== end_charpos
)))))
28855 /* A glyph that comes from DISP_STRING is by
28856 definition to be highlighted. */
28857 || EQ (g
->object
, disp_string
))
28866 /* The first row that ends at ZV must be the last to be
28868 else if (next
->ends_at_zv_p
)
28877 /* This function sets the mouse_face_* elements of HLINFO, assuming
28878 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28879 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28880 for the overlay or run of text properties specifying the mouse
28881 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28882 before-string and after-string that must also be highlighted.
28883 DISP_STRING, if non-nil, is a display string that may cover some
28884 or all of the highlighted text. */
28887 mouse_face_from_buffer_pos (Lisp_Object window
,
28888 Mouse_HLInfo
*hlinfo
,
28889 ptrdiff_t mouse_charpos
,
28890 ptrdiff_t start_charpos
,
28891 ptrdiff_t end_charpos
,
28892 Lisp_Object before_string
,
28893 Lisp_Object after_string
,
28894 Lisp_Object disp_string
)
28896 struct window
*w
= XWINDOW (window
);
28897 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28898 struct glyph_row
*r1
, *r2
;
28899 struct glyph
*glyph
, *end
;
28900 ptrdiff_t ignore
, pos
;
28903 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28904 eassert (NILP (before_string
) || STRINGP (before_string
));
28905 eassert (NILP (after_string
) || STRINGP (after_string
));
28907 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28908 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28910 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28911 /* If the before-string or display-string contains newlines,
28912 rows_from_pos_range skips to its last row. Move back. */
28913 if (!NILP (before_string
) || !NILP (disp_string
))
28915 struct glyph_row
*prev
;
28916 while ((prev
= r1
- 1, prev
>= first
)
28917 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28918 && prev
->used
[TEXT_AREA
] > 0)
28920 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28921 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28922 while (--glyph
>= beg
&& NILP (glyph
->object
));
28924 || !(EQ (glyph
->object
, before_string
)
28925 || EQ (glyph
->object
, disp_string
)))
28932 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28933 hlinfo
->mouse_face_past_end
= true;
28935 else if (!NILP (after_string
))
28937 /* If the after-string has newlines, advance to its last row. */
28938 struct glyph_row
*next
;
28939 struct glyph_row
*last
28940 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28942 for (next
= r2
+ 1;
28944 && next
->used
[TEXT_AREA
] > 0
28945 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28949 /* The rest of the display engine assumes that mouse_face_beg_row is
28950 either above mouse_face_end_row or identical to it. But with
28951 bidi-reordered continued lines, the row for START_CHARPOS could
28952 be below the row for END_CHARPOS. If so, swap the rows and store
28953 them in correct order. */
28956 struct glyph_row
*tem
= r2
;
28962 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28963 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28965 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28966 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28967 could be anywhere in the row and in any order. The strategy
28968 below is to find the leftmost and the rightmost glyph that
28969 belongs to either of these 3 strings, or whose position is
28970 between START_CHARPOS and END_CHARPOS, and highlight all the
28971 glyphs between those two. This may cover more than just the text
28972 between START_CHARPOS and END_CHARPOS if the range of characters
28973 strides the bidi level boundary, e.g. if the beginning is in R2L
28974 text while the end is in L2R text or vice versa. */
28975 if (!r1
->reversed_p
)
28977 /* This row is in a left to right paragraph. Scan it left to
28979 glyph
= r1
->glyphs
[TEXT_AREA
];
28980 end
= glyph
+ r1
->used
[TEXT_AREA
];
28983 /* Skip truncation glyphs at the start of the glyph row. */
28984 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28986 && NILP (glyph
->object
)
28987 && glyph
->charpos
< 0;
28989 x
+= glyph
->pixel_width
;
28991 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28992 or DISP_STRING, and the first glyph from buffer whose
28993 position is between START_CHARPOS and END_CHARPOS. */
28995 && !NILP (glyph
->object
)
28996 && !EQ (glyph
->object
, disp_string
)
28997 && !(BUFFERP (glyph
->object
)
28998 && (glyph
->charpos
>= start_charpos
28999 && glyph
->charpos
< end_charpos
));
29002 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29003 are present at buffer positions between START_CHARPOS and
29004 END_CHARPOS, or if they come from an overlay. */
29005 if (EQ (glyph
->object
, before_string
))
29007 pos
= string_buffer_position (before_string
,
29009 /* If pos == 0, it means before_string came from an
29010 overlay, not from a buffer position. */
29011 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29014 else if (EQ (glyph
->object
, after_string
))
29016 pos
= string_buffer_position (after_string
, end_charpos
);
29017 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29020 x
+= glyph
->pixel_width
;
29022 hlinfo
->mouse_face_beg_x
= x
;
29023 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29027 /* This row is in a right to left paragraph. Scan it right to
29031 end
= r1
->glyphs
[TEXT_AREA
] - 1;
29032 glyph
= end
+ r1
->used
[TEXT_AREA
];
29034 /* Skip truncation glyphs at the start of the glyph row. */
29035 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
29037 && NILP (glyph
->object
)
29038 && glyph
->charpos
< 0;
29042 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29043 or DISP_STRING, and the first glyph from buffer whose
29044 position is between START_CHARPOS and END_CHARPOS. */
29046 && !NILP (glyph
->object
)
29047 && !EQ (glyph
->object
, disp_string
)
29048 && !(BUFFERP (glyph
->object
)
29049 && (glyph
->charpos
>= start_charpos
29050 && glyph
->charpos
< end_charpos
));
29053 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29054 are present at buffer positions between START_CHARPOS and
29055 END_CHARPOS, or if they come from an overlay. */
29056 if (EQ (glyph
->object
, before_string
))
29058 pos
= string_buffer_position (before_string
, start_charpos
);
29059 /* If pos == 0, it means before_string came from an
29060 overlay, not from a buffer position. */
29061 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29064 else if (EQ (glyph
->object
, after_string
))
29066 pos
= string_buffer_position (after_string
, end_charpos
);
29067 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29072 glyph
++; /* first glyph to the right of the highlighted area */
29073 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
29074 x
+= g
->pixel_width
;
29075 hlinfo
->mouse_face_beg_x
= x
;
29076 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
29079 /* If the highlight ends in a different row, compute GLYPH and END
29080 for the end row. Otherwise, reuse the values computed above for
29081 the row where the highlight begins. */
29084 if (!r2
->reversed_p
)
29086 glyph
= r2
->glyphs
[TEXT_AREA
];
29087 end
= glyph
+ r2
->used
[TEXT_AREA
];
29092 end
= r2
->glyphs
[TEXT_AREA
] - 1;
29093 glyph
= end
+ r2
->used
[TEXT_AREA
];
29097 if (!r2
->reversed_p
)
29099 /* Skip truncation and continuation glyphs near the end of the
29100 row, and also blanks and stretch glyphs inserted by
29101 extend_face_to_end_of_line. */
29103 && NILP ((end
- 1)->object
))
29105 /* Scan the rest of the glyph row from the end, looking for the
29106 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29107 DISP_STRING, or whose position is between START_CHARPOS
29111 && !NILP (end
->object
)
29112 && !EQ (end
->object
, disp_string
)
29113 && !(BUFFERP (end
->object
)
29114 && (end
->charpos
>= start_charpos
29115 && end
->charpos
< end_charpos
));
29118 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29119 are present at buffer positions between START_CHARPOS and
29120 END_CHARPOS, or if they come from an overlay. */
29121 if (EQ (end
->object
, before_string
))
29123 pos
= string_buffer_position (before_string
, start_charpos
);
29124 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29127 else if (EQ (end
->object
, after_string
))
29129 pos
= string_buffer_position (after_string
, end_charpos
);
29130 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29134 /* Find the X coordinate of the last glyph to be highlighted. */
29135 for (; glyph
<= end
; ++glyph
)
29136 x
+= glyph
->pixel_width
;
29138 hlinfo
->mouse_face_end_x
= x
;
29139 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
29143 /* Skip truncation and continuation glyphs near the end of the
29144 row, and also blanks and stretch glyphs inserted by
29145 extend_face_to_end_of_line. */
29149 && NILP (end
->object
))
29151 x
+= end
->pixel_width
;
29154 /* Scan the rest of the glyph row from the end, looking for the
29155 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29156 DISP_STRING, or whose position is between START_CHARPOS
29160 && !NILP (end
->object
)
29161 && !EQ (end
->object
, disp_string
)
29162 && !(BUFFERP (end
->object
)
29163 && (end
->charpos
>= start_charpos
29164 && end
->charpos
< end_charpos
));
29167 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29168 are present at buffer positions between START_CHARPOS and
29169 END_CHARPOS, or if they come from an overlay. */
29170 if (EQ (end
->object
, before_string
))
29172 pos
= string_buffer_position (before_string
, start_charpos
);
29173 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29176 else if (EQ (end
->object
, after_string
))
29178 pos
= string_buffer_position (after_string
, end_charpos
);
29179 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
29182 x
+= end
->pixel_width
;
29184 /* If we exited the above loop because we arrived at the last
29185 glyph of the row, and its buffer position is still not in
29186 range, it means the last character in range is the preceding
29187 newline. Bump the end column and x values to get past the
29190 && BUFFERP (end
->object
)
29191 && (end
->charpos
< start_charpos
29192 || end
->charpos
>= end_charpos
))
29194 x
+= end
->pixel_width
;
29197 hlinfo
->mouse_face_end_x
= x
;
29198 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
29201 hlinfo
->mouse_face_window
= window
;
29202 hlinfo
->mouse_face_face_id
29203 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
29205 !hlinfo
->mouse_face_hidden
, -1);
29206 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29209 /* The following function is not used anymore (replaced with
29210 mouse_face_from_string_pos), but I leave it here for the time
29211 being, in case someone would. */
29213 #if false /* not used */
29215 /* Find the position of the glyph for position POS in OBJECT in
29216 window W's current matrix, and return in *X, *Y the pixel
29217 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29219 RIGHT_P means return the position of the right edge of the glyph.
29220 !RIGHT_P means return the left edge position.
29222 If no glyph for POS exists in the matrix, return the position of
29223 the glyph with the next smaller position that is in the matrix, if
29224 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29225 exists in the matrix, return the position of the glyph with the
29226 next larger position in OBJECT.
29228 Value is true if a glyph was found. */
29231 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
29232 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
29234 int yb
= window_text_bottom_y (w
);
29235 struct glyph_row
*r
;
29236 struct glyph
*best_glyph
= NULL
;
29237 struct glyph_row
*best_row
= NULL
;
29240 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29241 r
->enabled_p
&& r
->y
< yb
;
29244 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
29245 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
29248 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29249 if (EQ (g
->object
, object
))
29251 if (g
->charpos
== pos
)
29258 else if (best_glyph
== NULL
29259 || ((eabs (g
->charpos
- pos
)
29260 < eabs (best_glyph
->charpos
- pos
))
29263 : g
->charpos
> pos
)))
29277 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
29281 *x
+= best_glyph
->pixel_width
;
29286 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
29289 return best_glyph
!= NULL
;
29291 #endif /* not used */
29293 /* Find the positions of the first and the last glyphs in window W's
29294 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29295 (assumed to be a string), and return in HLINFO's mouse_face_*
29296 members the pixel and column/row coordinates of those glyphs. */
29299 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
29300 Lisp_Object object
,
29301 ptrdiff_t startpos
, ptrdiff_t endpos
)
29303 int yb
= window_text_bottom_y (w
);
29304 struct glyph_row
*r
;
29305 struct glyph
*g
, *e
;
29307 bool found
= false;
29309 /* Find the glyph row with at least one position in the range
29310 [STARTPOS..ENDPOS), and the first glyph in that row whose
29311 position belongs to that range. */
29312 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29313 r
->enabled_p
&& r
->y
< yb
;
29316 if (!r
->reversed_p
)
29318 g
= r
->glyphs
[TEXT_AREA
];
29319 e
= g
+ r
->used
[TEXT_AREA
];
29320 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29321 if (EQ (g
->object
, object
)
29322 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29324 hlinfo
->mouse_face_beg_row
29325 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29326 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29327 hlinfo
->mouse_face_beg_x
= gx
;
29336 e
= r
->glyphs
[TEXT_AREA
];
29337 g
= e
+ r
->used
[TEXT_AREA
];
29338 for ( ; g
> e
; --g
)
29339 if (EQ ((g
-1)->object
, object
)
29340 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29342 hlinfo
->mouse_face_beg_row
29343 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29344 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29345 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29346 gx
+= g1
->pixel_width
;
29347 hlinfo
->mouse_face_beg_x
= gx
;
29359 /* Starting with the next row, look for the first row which does NOT
29360 include any glyphs whose positions are in the range. */
29361 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29363 g
= r
->glyphs
[TEXT_AREA
];
29364 e
= g
+ r
->used
[TEXT_AREA
];
29366 for ( ; g
< e
; ++g
)
29367 if (EQ (g
->object
, object
)
29368 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29377 /* The highlighted region ends on the previous row. */
29380 /* Set the end row. */
29381 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29383 /* Compute and set the end column and the end column's horizontal
29384 pixel coordinate. */
29385 if (!r
->reversed_p
)
29387 g
= r
->glyphs
[TEXT_AREA
];
29388 e
= g
+ r
->used
[TEXT_AREA
];
29389 for ( ; e
> g
; --e
)
29390 if (EQ ((e
-1)->object
, object
)
29391 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29393 hlinfo
->mouse_face_end_col
= e
- g
;
29395 for (gx
= r
->x
; g
< e
; ++g
)
29396 gx
+= g
->pixel_width
;
29397 hlinfo
->mouse_face_end_x
= gx
;
29401 e
= r
->glyphs
[TEXT_AREA
];
29402 g
= e
+ r
->used
[TEXT_AREA
];
29403 for (gx
= r
->x
; e
< g
; ++e
)
29405 if (EQ (e
->object
, object
)
29406 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29408 gx
+= e
->pixel_width
;
29410 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29411 hlinfo
->mouse_face_end_x
= gx
;
29415 #ifdef HAVE_WINDOW_SYSTEM
29417 /* See if position X, Y is within a hot-spot of an image. */
29420 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29422 if (!CONSP (hot_spot
))
29425 if (EQ (XCAR (hot_spot
), Qrect
))
29427 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29428 Lisp_Object rect
= XCDR (hot_spot
);
29432 if (!CONSP (XCAR (rect
)))
29434 if (!CONSP (XCDR (rect
)))
29436 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29438 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29440 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29442 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29446 else if (EQ (XCAR (hot_spot
), Qcircle
))
29448 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29449 Lisp_Object circ
= XCDR (hot_spot
);
29450 Lisp_Object lr
, lx0
, ly0
;
29452 && CONSP (XCAR (circ
))
29453 && (lr
= XCDR (circ
), NUMBERP (lr
))
29454 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29455 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29457 double r
= XFLOATINT (lr
);
29458 double dx
= XINT (lx0
) - x
;
29459 double dy
= XINT (ly0
) - y
;
29460 return (dx
* dx
+ dy
* dy
<= r
* r
);
29463 else if (EQ (XCAR (hot_spot
), Qpoly
))
29465 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29466 if (VECTORP (XCDR (hot_spot
)))
29468 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29469 Lisp_Object
*poly
= v
->contents
;
29470 ptrdiff_t n
= v
->header
.size
;
29472 bool inside
= false;
29473 Lisp_Object lx
, ly
;
29476 /* Need an even number of coordinates, and at least 3 edges. */
29477 if (n
< 6 || n
& 1)
29480 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29481 If count is odd, we are inside polygon. Pixels on edges
29482 may or may not be included depending on actual geometry of the
29484 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29485 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29487 x0
= XINT (lx
), y0
= XINT (ly
);
29488 for (i
= 0; i
< n
; i
+= 2)
29490 int x1
= x0
, y1
= y0
;
29491 if ((lx
= poly
[i
], !INTEGERP (lx
))
29492 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29494 x0
= XINT (lx
), y0
= XINT (ly
);
29496 /* Does this segment cross the X line? */
29504 if (y
> y0
&& y
> y1
)
29506 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29516 find_hot_spot (Lisp_Object map
, int x
, int y
)
29518 while (CONSP (map
))
29520 if (CONSP (XCAR (map
))
29521 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29529 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29531 doc
: /* Lookup in image map MAP coordinates X and Y.
29532 An image map is an alist where each element has the format (AREA ID PLIST).
29533 An AREA is specified as either a rectangle, a circle, or a polygon:
29534 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29535 pixel coordinates of the upper left and bottom right corners.
29536 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29537 and the radius of the circle; r may be a float or integer.
29538 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29539 vector describes one corner in the polygon.
29540 Returns the alist element for the first matching AREA in MAP. */)
29541 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29549 return find_hot_spot (map
,
29550 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29551 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29555 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29557 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29559 /* Do not change cursor shape while dragging mouse. */
29560 if (EQ (do_mouse_tracking
, Qdragging
))
29563 if (!NILP (pointer
))
29565 if (EQ (pointer
, Qarrow
))
29566 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29567 else if (EQ (pointer
, Qhand
))
29568 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29569 else if (EQ (pointer
, Qtext
))
29570 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29571 else if (EQ (pointer
, intern ("hdrag")))
29572 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29573 else if (EQ (pointer
, intern ("nhdrag")))
29574 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29575 #ifdef HAVE_X_WINDOWS
29576 else if (EQ (pointer
, intern ("vdrag")))
29577 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29579 else if (EQ (pointer
, intern ("hourglass")))
29580 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29581 else if (EQ (pointer
, Qmodeline
))
29582 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29584 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29587 if (cursor
!= No_Cursor
)
29588 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29591 #endif /* HAVE_WINDOW_SYSTEM */
29593 /* Take proper action when mouse has moved to the mode or header line
29594 or marginal area AREA of window W, x-position X and y-position Y.
29595 X is relative to the start of the text display area of W, so the
29596 width of bitmap areas and scroll bars must be subtracted to get a
29597 position relative to the start of the mode line. */
29600 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29601 enum window_part area
)
29603 struct window
*w
= XWINDOW (window
);
29604 struct frame
*f
= XFRAME (w
->frame
);
29605 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29606 #ifdef HAVE_WINDOW_SYSTEM
29607 Display_Info
*dpyinfo
;
29609 Cursor cursor
= No_Cursor
;
29610 Lisp_Object pointer
= Qnil
;
29611 int dx
, dy
, width
, height
;
29613 Lisp_Object string
, object
= Qnil
;
29614 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29616 Lisp_Object mouse_face
;
29617 int original_x_pixel
= x
;
29618 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29619 struct glyph_row
*row
IF_LINT (= 0);
29621 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29626 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29627 returns them in row/column units! */
29628 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29629 &object
, &dx
, &dy
, &width
, &height
);
29631 row
= (area
== ON_MODE_LINE
29632 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29633 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29635 /* Find the glyph under the mouse pointer. */
29636 if (row
->mode_line_p
&& row
->enabled_p
)
29638 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29639 end
= glyph
+ row
->used
[TEXT_AREA
];
29641 for (x0
= original_x_pixel
;
29642 glyph
< end
&& x0
>= glyph
->pixel_width
;
29644 x0
-= glyph
->pixel_width
;
29652 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29653 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29654 returns them in row/column units! */
29655 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29656 &object
, &dx
, &dy
, &width
, &height
);
29661 #ifdef HAVE_WINDOW_SYSTEM
29662 if (IMAGEP (object
))
29664 Lisp_Object image_map
, hotspot
;
29665 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29667 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29669 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29673 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29674 If so, we could look for mouse-enter, mouse-leave
29675 properties in PLIST (and do something...). */
29676 hotspot
= XCDR (hotspot
);
29677 if (CONSP (hotspot
)
29678 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29680 pointer
= Fplist_get (plist
, Qpointer
);
29681 if (NILP (pointer
))
29683 help
= Fplist_get (plist
, Qhelp_echo
);
29686 help_echo_string
= help
;
29687 XSETWINDOW (help_echo_window
, w
);
29688 help_echo_object
= w
->contents
;
29689 help_echo_pos
= charpos
;
29693 if (NILP (pointer
))
29694 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29696 #endif /* HAVE_WINDOW_SYSTEM */
29698 if (STRINGP (string
))
29699 pos
= make_number (charpos
);
29701 /* Set the help text and mouse pointer. If the mouse is on a part
29702 of the mode line without any text (e.g. past the right edge of
29703 the mode line text), use the default help text and pointer. */
29704 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29706 /* Arrange to display the help by setting the global variables
29707 help_echo_string, help_echo_object, and help_echo_pos. */
29710 if (STRINGP (string
))
29711 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29715 help_echo_string
= help
;
29716 XSETWINDOW (help_echo_window
, w
);
29717 help_echo_object
= string
;
29718 help_echo_pos
= charpos
;
29720 else if (area
== ON_MODE_LINE
)
29722 Lisp_Object default_help
29723 = buffer_local_value (Qmode_line_default_help_echo
,
29726 if (STRINGP (default_help
))
29728 help_echo_string
= default_help
;
29729 XSETWINDOW (help_echo_window
, w
);
29730 help_echo_object
= Qnil
;
29731 help_echo_pos
= -1;
29736 #ifdef HAVE_WINDOW_SYSTEM
29737 /* Change the mouse pointer according to what is under it. */
29738 if (FRAME_WINDOW_P (f
))
29740 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29742 || NILP (Vresize_mini_windows
));
29744 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29745 if (STRINGP (string
))
29747 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29749 if (NILP (pointer
))
29750 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29752 /* Change the mouse pointer according to what is under X/Y. */
29754 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29757 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29758 if (!KEYMAPP (map
))
29759 map
= Fget_text_property (pos
, Qkeymap
, string
);
29760 if (!KEYMAPP (map
) && draggable
)
29761 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29764 else if (draggable
)
29765 /* Default mode-line pointer. */
29766 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29771 /* Change the mouse face according to what is under X/Y. */
29772 bool mouse_face_shown
= false;
29773 if (STRINGP (string
))
29775 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29776 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29777 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29782 struct glyph
* tmp_glyph
;
29786 int total_pixel_width
;
29787 ptrdiff_t begpos
, endpos
, ignore
;
29791 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29792 Qmouse_face
, string
, Qnil
);
29798 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29800 endpos
= SCHARS (string
);
29804 /* Calculate the glyph position GPOS of GLYPH in the
29805 displayed string, relative to the beginning of the
29806 highlighted part of the string.
29808 Note: GPOS is different from CHARPOS. CHARPOS is the
29809 position of GLYPH in the internal string object. A mode
29810 line string format has structures which are converted to
29811 a flattened string by the Emacs Lisp interpreter. The
29812 internal string is an element of those structures. The
29813 displayed string is the flattened string. */
29814 tmp_glyph
= row_start_glyph
;
29815 while (tmp_glyph
< glyph
29816 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29817 && begpos
<= tmp_glyph
->charpos
29818 && tmp_glyph
->charpos
< endpos
)))
29820 gpos
= glyph
- tmp_glyph
;
29822 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29823 the highlighted part of the displayed string to which
29824 GLYPH belongs. Note: GSEQ_LENGTH is different from
29825 SCHARS (STRING), because the latter returns the length of
29826 the internal string. */
29827 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29829 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29830 && begpos
<= tmp_glyph
->charpos
29831 && tmp_glyph
->charpos
< endpos
));
29834 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29836 /* Calculate the total pixel width of all the glyphs between
29837 the beginning of the highlighted area and GLYPH. */
29838 total_pixel_width
= 0;
29839 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29840 total_pixel_width
+= tmp_glyph
->pixel_width
;
29842 /* Pre calculation of re-rendering position. Note: X is in
29843 column units here, after the call to mode_line_string or
29844 marginal_area_string. */
29846 vpos
= (area
== ON_MODE_LINE
29847 ? (w
->current_matrix
)->nrows
- 1
29850 /* If GLYPH's position is included in the region that is
29851 already drawn in mouse face, we have nothing to do. */
29852 if ( EQ (window
, hlinfo
->mouse_face_window
)
29853 && (!row
->reversed_p
29854 ? (hlinfo
->mouse_face_beg_col
<= hpos
29855 && hpos
< hlinfo
->mouse_face_end_col
)
29856 /* In R2L rows we swap BEG and END, see below. */
29857 : (hlinfo
->mouse_face_end_col
<= hpos
29858 && hpos
< hlinfo
->mouse_face_beg_col
))
29859 && hlinfo
->mouse_face_beg_row
== vpos
)
29862 if (clear_mouse_face (hlinfo
))
29863 cursor
= No_Cursor
;
29865 if (!row
->reversed_p
)
29867 hlinfo
->mouse_face_beg_col
= hpos
;
29868 hlinfo
->mouse_face_beg_x
= original_x_pixel
29869 - (total_pixel_width
+ dx
);
29870 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29871 hlinfo
->mouse_face_end_x
= 0;
29875 /* In R2L rows, show_mouse_face expects BEG and END
29876 coordinates to be swapped. */
29877 hlinfo
->mouse_face_end_col
= hpos
;
29878 hlinfo
->mouse_face_end_x
= original_x_pixel
29879 - (total_pixel_width
+ dx
);
29880 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29881 hlinfo
->mouse_face_beg_x
= 0;
29884 hlinfo
->mouse_face_beg_row
= vpos
;
29885 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29886 hlinfo
->mouse_face_past_end
= false;
29887 hlinfo
->mouse_face_window
= window
;
29889 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29894 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29895 mouse_face_shown
= true;
29897 if (NILP (pointer
))
29902 /* If mouse-face doesn't need to be shown, clear any existing
29904 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29905 clear_mouse_face (hlinfo
);
29907 #ifdef HAVE_WINDOW_SYSTEM
29908 if (FRAME_WINDOW_P (f
))
29909 define_frame_cursor1 (f
, cursor
, pointer
);
29915 Take proper action when the mouse has moved to position X, Y on
29916 frame F with regards to highlighting portions of display that have
29917 mouse-face properties. Also de-highlight portions of display where
29918 the mouse was before, set the mouse pointer shape as appropriate
29919 for the mouse coordinates, and activate help echo (tooltips).
29920 X and Y can be negative or out of range. */
29923 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29925 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29926 enum window_part part
= ON_NOTHING
;
29927 Lisp_Object window
;
29929 Cursor cursor
= No_Cursor
;
29930 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29933 /* When a menu is active, don't highlight because this looks odd. */
29934 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29935 if (popup_activated ())
29939 if (!f
->glyphs_initialized_p
29940 || f
->pointer_invisible
)
29943 hlinfo
->mouse_face_mouse_x
= x
;
29944 hlinfo
->mouse_face_mouse_y
= y
;
29945 hlinfo
->mouse_face_mouse_frame
= f
;
29947 if (hlinfo
->mouse_face_defer
)
29950 /* Which window is that in? */
29951 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29953 /* If displaying active text in another window, clear that. */
29954 if (! EQ (window
, hlinfo
->mouse_face_window
)
29955 /* Also clear if we move out of text area in same window. */
29956 || (!NILP (hlinfo
->mouse_face_window
)
29959 && part
!= ON_MODE_LINE
29960 && part
!= ON_HEADER_LINE
))
29961 clear_mouse_face (hlinfo
);
29963 /* Not on a window -> return. */
29964 if (!WINDOWP (window
))
29967 /* Reset help_echo_string. It will get recomputed below. */
29968 help_echo_string
= Qnil
;
29970 /* Convert to window-relative pixel coordinates. */
29971 w
= XWINDOW (window
);
29972 frame_to_window_pixel_xy (w
, &x
, &y
);
29974 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29975 /* Handle tool-bar window differently since it doesn't display a
29977 if (EQ (window
, f
->tool_bar_window
))
29979 note_tool_bar_highlight (f
, x
, y
);
29984 /* Mouse is on the mode, header line or margin? */
29985 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29986 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29988 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29990 #ifdef HAVE_WINDOW_SYSTEM
29991 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29993 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29994 /* Show non-text cursor (Bug#16647). */
30002 #ifdef HAVE_WINDOW_SYSTEM
30003 if (part
== ON_VERTICAL_BORDER
)
30005 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30006 help_echo_string
= build_string ("drag-mouse-1: resize");
30008 else if (part
== ON_RIGHT_DIVIDER
)
30010 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
30011 help_echo_string
= build_string ("drag-mouse-1: resize");
30013 else if (part
== ON_BOTTOM_DIVIDER
)
30014 if (! WINDOW_BOTTOMMOST_P (w
)
30016 || NILP (Vresize_mini_windows
))
30018 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
30019 help_echo_string
= build_string ("drag-mouse-1: resize");
30022 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30023 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
30024 || part
== ON_VERTICAL_SCROLL_BAR
30025 || part
== ON_HORIZONTAL_SCROLL_BAR
)
30026 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30028 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
30031 /* Are we in a window whose display is up to date?
30032 And verify the buffer's text has not changed. */
30033 b
= XBUFFER (w
->contents
);
30034 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
30036 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
30038 struct glyph
*glyph
;
30039 Lisp_Object object
;
30040 Lisp_Object mouse_face
= Qnil
, position
;
30041 Lisp_Object
*overlay_vec
= NULL
;
30042 ptrdiff_t i
, noverlays
;
30043 struct buffer
*obuf
;
30044 ptrdiff_t obegv
, ozv
;
30047 /* Find the glyph under X/Y. */
30048 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
30050 #ifdef HAVE_WINDOW_SYSTEM
30051 /* Look for :pointer property on image. */
30052 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
30054 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
30055 if (img
!= NULL
&& IMAGEP (img
->spec
))
30057 Lisp_Object image_map
, hotspot
;
30058 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
30060 && (hotspot
= find_hot_spot (image_map
,
30061 glyph
->slice
.img
.x
+ dx
,
30062 glyph
->slice
.img
.y
+ dy
),
30064 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
30068 /* Could check XCAR (hotspot) to see if we enter/leave
30070 If so, we could look for mouse-enter, mouse-leave
30071 properties in PLIST (and do something...). */
30072 hotspot
= XCDR (hotspot
);
30073 if (CONSP (hotspot
)
30074 && (plist
= XCAR (hotspot
), CONSP (plist
)))
30076 pointer
= Fplist_get (plist
, Qpointer
);
30077 if (NILP (pointer
))
30079 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
30080 if (!NILP (help_echo_string
))
30082 help_echo_window
= window
;
30083 help_echo_object
= glyph
->object
;
30084 help_echo_pos
= glyph
->charpos
;
30088 if (NILP (pointer
))
30089 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
30092 #endif /* HAVE_WINDOW_SYSTEM */
30094 /* Clear mouse face if X/Y not over text. */
30096 || area
!= TEXT_AREA
30097 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
30098 /* Glyph's OBJECT is nil for glyphs inserted by the
30099 display engine for its internal purposes, like truncation
30100 and continuation glyphs and blanks beyond the end of
30101 line's text on text terminals. If we are over such a
30102 glyph, we are not over any text. */
30103 || NILP (glyph
->object
)
30104 /* R2L rows have a stretch glyph at their front, which
30105 stands for no text, whereas L2R rows have no glyphs at
30106 all beyond the end of text. Treat such stretch glyphs
30107 like we do with NULL glyphs in L2R rows. */
30108 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
30109 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
30110 && glyph
->type
== STRETCH_GLYPH
30111 && glyph
->avoid_cursor_p
))
30113 if (clear_mouse_face (hlinfo
))
30114 cursor
= No_Cursor
;
30115 #ifdef HAVE_WINDOW_SYSTEM
30116 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30118 if (area
!= TEXT_AREA
)
30119 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
30121 pointer
= Vvoid_text_area_pointer
;
30127 pos
= glyph
->charpos
;
30128 object
= glyph
->object
;
30129 if (!STRINGP (object
) && !BUFFERP (object
))
30132 /* If we get an out-of-range value, return now; avoid an error. */
30133 if (BUFFERP (object
) && pos
> BUF_Z (b
))
30136 /* Make the window's buffer temporarily current for
30137 overlays_at and compute_char_face. */
30138 obuf
= current_buffer
;
30139 current_buffer
= b
;
30145 /* Is this char mouse-active or does it have help-echo? */
30146 position
= make_number (pos
);
30150 if (BUFFERP (object
))
30152 /* Put all the overlays we want in a vector in overlay_vec. */
30153 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
30154 /* Sort overlays into increasing priority order. */
30155 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
30160 if (NILP (Vmouse_highlight
))
30162 clear_mouse_face (hlinfo
);
30163 goto check_help_echo
;
30166 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
30169 cursor
= No_Cursor
;
30171 /* Check mouse-face highlighting. */
30173 /* If there exists an overlay with mouse-face overlapping
30174 the one we are currently highlighting, we have to
30175 check if we enter the overlapping overlay, and then
30176 highlight only that. */
30177 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
30178 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
30180 /* Find the highest priority overlay with a mouse-face. */
30181 Lisp_Object overlay
= Qnil
;
30182 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
30184 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
30185 if (!NILP (mouse_face
))
30186 overlay
= overlay_vec
[i
];
30189 /* If we're highlighting the same overlay as before, there's
30190 no need to do that again. */
30191 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
30192 goto check_help_echo
;
30193 hlinfo
->mouse_face_overlay
= overlay
;
30195 /* Clear the display of the old active region, if any. */
30196 if (clear_mouse_face (hlinfo
))
30197 cursor
= No_Cursor
;
30199 /* If no overlay applies, get a text property. */
30200 if (NILP (overlay
))
30201 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
30203 /* Next, compute the bounds of the mouse highlighting and
30205 if (!NILP (mouse_face
) && STRINGP (object
))
30207 /* The mouse-highlighting comes from a display string
30208 with a mouse-face. */
30212 s
= Fprevious_single_property_change
30213 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
30214 e
= Fnext_single_property_change
30215 (position
, Qmouse_face
, object
, Qnil
);
30217 s
= make_number (0);
30219 e
= make_number (SCHARS (object
));
30220 mouse_face_from_string_pos (w
, hlinfo
, object
,
30221 XINT (s
), XINT (e
));
30222 hlinfo
->mouse_face_past_end
= false;
30223 hlinfo
->mouse_face_window
= window
;
30224 hlinfo
->mouse_face_face_id
30225 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
30226 glyph
->face_id
, true);
30227 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
30228 cursor
= No_Cursor
;
30232 /* The mouse-highlighting, if any, comes from an overlay
30233 or text property in the buffer. */
30234 Lisp_Object buffer
IF_LINT (= Qnil
);
30235 Lisp_Object disp_string
IF_LINT (= Qnil
);
30237 if (STRINGP (object
))
30239 /* If we are on a display string with no mouse-face,
30240 check if the text under it has one. */
30241 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
30242 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30243 pos
= string_buffer_position (object
, start
);
30246 mouse_face
= get_char_property_and_overlay
30247 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
30248 buffer
= w
->contents
;
30249 disp_string
= object
;
30255 disp_string
= Qnil
;
30258 if (!NILP (mouse_face
))
30260 Lisp_Object before
, after
;
30261 Lisp_Object before_string
, after_string
;
30262 /* To correctly find the limits of mouse highlight
30263 in a bidi-reordered buffer, we must not use the
30264 optimization of limiting the search in
30265 previous-single-property-change and
30266 next-single-property-change, because
30267 rows_from_pos_range needs the real start and end
30268 positions to DTRT in this case. That's because
30269 the first row visible in a window does not
30270 necessarily display the character whose position
30271 is the smallest. */
30273 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30274 ? Fmarker_position (w
->start
)
30277 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
30278 ? make_number (BUF_Z (XBUFFER (buffer
))
30279 - w
->window_end_pos
)
30282 if (NILP (overlay
))
30284 /* Handle the text property case. */
30285 before
= Fprevious_single_property_change
30286 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
30287 after
= Fnext_single_property_change
30288 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
30289 before_string
= after_string
= Qnil
;
30293 /* Handle the overlay case. */
30294 before
= Foverlay_start (overlay
);
30295 after
= Foverlay_end (overlay
);
30296 before_string
= Foverlay_get (overlay
, Qbefore_string
);
30297 after_string
= Foverlay_get (overlay
, Qafter_string
);
30299 if (!STRINGP (before_string
)) before_string
= Qnil
;
30300 if (!STRINGP (after_string
)) after_string
= Qnil
;
30303 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
30306 : XFASTINT (before
),
30308 ? BUF_Z (XBUFFER (buffer
))
30309 : XFASTINT (after
),
30310 before_string
, after_string
,
30312 cursor
= No_Cursor
;
30319 /* Look for a `help-echo' property. */
30320 if (NILP (help_echo_string
)) {
30321 Lisp_Object help
, overlay
;
30323 /* Check overlays first. */
30324 help
= overlay
= Qnil
;
30325 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30327 overlay
= overlay_vec
[i
];
30328 help
= Foverlay_get (overlay
, Qhelp_echo
);
30333 help_echo_string
= help
;
30334 help_echo_window
= window
;
30335 help_echo_object
= overlay
;
30336 help_echo_pos
= pos
;
30340 Lisp_Object obj
= glyph
->object
;
30341 ptrdiff_t charpos
= glyph
->charpos
;
30343 /* Try text properties. */
30346 && charpos
< SCHARS (obj
))
30348 help
= Fget_text_property (make_number (charpos
),
30352 /* If the string itself doesn't specify a help-echo,
30353 see if the buffer text ``under'' it does. */
30354 struct glyph_row
*r
30355 = MATRIX_ROW (w
->current_matrix
, vpos
);
30356 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30357 ptrdiff_t p
= string_buffer_position (obj
, start
);
30360 help
= Fget_char_property (make_number (p
),
30361 Qhelp_echo
, w
->contents
);
30370 else if (BUFFERP (obj
)
30373 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30378 help_echo_string
= help
;
30379 help_echo_window
= window
;
30380 help_echo_object
= obj
;
30381 help_echo_pos
= charpos
;
30386 #ifdef HAVE_WINDOW_SYSTEM
30387 /* Look for a `pointer' property. */
30388 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30390 /* Check overlays first. */
30391 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30392 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30394 if (NILP (pointer
))
30396 Lisp_Object obj
= glyph
->object
;
30397 ptrdiff_t charpos
= glyph
->charpos
;
30399 /* Try text properties. */
30402 && charpos
< SCHARS (obj
))
30404 pointer
= Fget_text_property (make_number (charpos
),
30406 if (NILP (pointer
))
30408 /* If the string itself doesn't specify a pointer,
30409 see if the buffer text ``under'' it does. */
30410 struct glyph_row
*r
30411 = MATRIX_ROW (w
->current_matrix
, vpos
);
30412 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30413 ptrdiff_t p
= string_buffer_position (obj
, start
);
30415 pointer
= Fget_char_property (make_number (p
),
30416 Qpointer
, w
->contents
);
30419 else if (BUFFERP (obj
)
30422 pointer
= Fget_text_property (make_number (charpos
),
30426 #endif /* HAVE_WINDOW_SYSTEM */
30430 current_buffer
= obuf
;
30436 #ifdef HAVE_WINDOW_SYSTEM
30437 if (FRAME_WINDOW_P (f
))
30438 define_frame_cursor1 (f
, cursor
, pointer
);
30440 /* This is here to prevent a compiler error, about "label at end of
30441 compound statement". */
30448 Clear any mouse-face on window W. This function is part of the
30449 redisplay interface, and is called from try_window_id and similar
30450 functions to ensure the mouse-highlight is off. */
30453 x_clear_window_mouse_face (struct window
*w
)
30455 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30456 Lisp_Object window
;
30459 XSETWINDOW (window
, w
);
30460 if (EQ (window
, hlinfo
->mouse_face_window
))
30461 clear_mouse_face (hlinfo
);
30467 Just discard the mouse face information for frame F, if any.
30468 This is used when the size of F is changed. */
30471 cancel_mouse_face (struct frame
*f
)
30473 Lisp_Object window
;
30474 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30476 window
= hlinfo
->mouse_face_window
;
30477 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30478 reset_mouse_highlight (hlinfo
);
30483 /***********************************************************************
30485 ***********************************************************************/
30487 #ifdef HAVE_WINDOW_SYSTEM
30489 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30490 which intersects rectangle R. R is in window-relative coordinates. */
30493 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30494 enum glyph_row_area area
)
30496 struct glyph
*first
= row
->glyphs
[area
];
30497 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30498 struct glyph
*last
;
30499 int first_x
, start_x
, x
;
30501 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30502 /* If row extends face to end of line write the whole line. */
30503 draw_glyphs (w
, 0, row
, area
,
30504 0, row
->used
[area
],
30505 DRAW_NORMAL_TEXT
, 0);
30508 /* Set START_X to the window-relative start position for drawing glyphs of
30509 AREA. The first glyph of the text area can be partially visible.
30510 The first glyphs of other areas cannot. */
30511 start_x
= window_box_left_offset (w
, area
);
30513 if (area
== TEXT_AREA
)
30516 /* Find the first glyph that must be redrawn. */
30518 && x
+ first
->pixel_width
< r
->x
)
30520 x
+= first
->pixel_width
;
30524 /* Find the last one. */
30527 /* Use a signed int intermediate value to avoid catastrophic
30528 failures due to comparison between signed and unsigned, when
30529 x is negative (can happen for wide images that are hscrolled). */
30530 int r_end
= r
->x
+ r
->width
;
30531 while (last
< end
&& x
< r_end
)
30533 x
+= last
->pixel_width
;
30539 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30540 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30541 DRAW_NORMAL_TEXT
, 0);
30546 /* Redraw the parts of the glyph row ROW on window W intersecting
30547 rectangle R. R is in window-relative coordinates. Value is
30548 true if mouse-face was overwritten. */
30551 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30553 eassert (row
->enabled_p
);
30555 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30556 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30557 0, row
->used
[TEXT_AREA
],
30558 DRAW_NORMAL_TEXT
, 0);
30561 if (row
->used
[LEFT_MARGIN_AREA
])
30562 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30563 if (row
->used
[TEXT_AREA
])
30564 expose_area (w
, row
, r
, TEXT_AREA
);
30565 if (row
->used
[RIGHT_MARGIN_AREA
])
30566 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30567 draw_row_fringe_bitmaps (w
, row
);
30570 return row
->mouse_face_p
;
30574 /* Redraw those parts of glyphs rows during expose event handling that
30575 overlap other rows. Redrawing of an exposed line writes over parts
30576 of lines overlapping that exposed line; this function fixes that.
30578 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30579 row in W's current matrix that is exposed and overlaps other rows.
30580 LAST_OVERLAPPING_ROW is the last such row. */
30583 expose_overlaps (struct window
*w
,
30584 struct glyph_row
*first_overlapping_row
,
30585 struct glyph_row
*last_overlapping_row
,
30588 struct glyph_row
*row
;
30590 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30591 if (row
->overlapping_p
)
30593 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30596 if (row
->used
[LEFT_MARGIN_AREA
])
30597 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30599 if (row
->used
[TEXT_AREA
])
30600 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30602 if (row
->used
[RIGHT_MARGIN_AREA
])
30603 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30609 /* Return true if W's cursor intersects rectangle R. */
30612 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30614 XRectangle cr
, result
;
30615 struct glyph
*cursor_glyph
;
30616 struct glyph_row
*row
;
30618 if (w
->phys_cursor
.vpos
>= 0
30619 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30620 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30622 && row
->cursor_in_fringe_p
)
30624 /* Cursor is in the fringe. */
30625 cr
.x
= window_box_right_offset (w
,
30626 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30627 ? RIGHT_MARGIN_AREA
30630 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30631 cr
.height
= row
->height
;
30632 return x_intersect_rectangles (&cr
, r
, &result
);
30635 cursor_glyph
= get_phys_cursor_glyph (w
);
30638 /* r is relative to W's box, but w->phys_cursor.x is relative
30639 to left edge of W's TEXT area. Adjust it. */
30640 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30641 cr
.y
= w
->phys_cursor
.y
;
30642 cr
.width
= cursor_glyph
->pixel_width
;
30643 cr
.height
= w
->phys_cursor_height
;
30644 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30645 I assume the effect is the same -- and this is portable. */
30646 return x_intersect_rectangles (&cr
, r
, &result
);
30648 /* If we don't understand the format, pretend we're not in the hot-spot. */
30654 Draw a vertical window border to the right of window W if W doesn't
30655 have vertical scroll bars. */
30658 x_draw_vertical_border (struct window
*w
)
30660 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30662 /* We could do better, if we knew what type of scroll-bar the adjacent
30663 windows (on either side) have... But we don't :-(
30664 However, I think this works ok. ++KFS 2003-04-25 */
30666 /* Redraw borders between horizontally adjacent windows. Don't
30667 do it for frames with vertical scroll bars because either the
30668 right scroll bar of a window, or the left scroll bar of its
30669 neighbor will suffice as a border. */
30670 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30673 /* Note: It is necessary to redraw both the left and the right
30674 borders, for when only this single window W is being
30676 if (!WINDOW_RIGHTMOST_P (w
)
30677 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30679 int x0
, x1
, y0
, y1
;
30681 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30684 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30687 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30690 if (!WINDOW_LEFTMOST_P (w
)
30691 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30693 int x0
, x1
, y0
, y1
;
30695 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30698 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30701 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30706 /* Draw window dividers for window W. */
30709 x_draw_right_divider (struct window
*w
)
30711 struct frame
*f
= WINDOW_XFRAME (w
);
30713 if (w
->mini
|| w
->pseudo_window_p
)
30715 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30717 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30718 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30719 int y0
= WINDOW_TOP_EDGE_Y (w
);
30720 /* The bottom divider prevails. */
30721 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30723 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30728 x_draw_bottom_divider (struct window
*w
)
30730 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30732 if (w
->mini
|| w
->pseudo_window_p
)
30734 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30736 int x0
= WINDOW_LEFT_EDGE_X (w
);
30737 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30738 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30739 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30741 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30745 /* Redraw the part of window W intersection rectangle FR. Pixel
30746 coordinates in FR are frame-relative. Call this function with
30747 input blocked. Value is true if the exposure overwrites
30751 expose_window (struct window
*w
, XRectangle
*fr
)
30753 struct frame
*f
= XFRAME (w
->frame
);
30755 bool mouse_face_overwritten_p
= false;
30757 /* If window is not yet fully initialized, do nothing. This can
30758 happen when toolkit scroll bars are used and a window is split.
30759 Reconfiguring the scroll bar will generate an expose for a newly
30761 if (w
->current_matrix
== NULL
)
30764 /* When we're currently updating the window, display and current
30765 matrix usually don't agree. Arrange for a thorough display
30767 if (w
->must_be_updated_p
)
30769 SET_FRAME_GARBAGED (f
);
30773 /* Frame-relative pixel rectangle of W. */
30774 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30775 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30776 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30777 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30779 if (x_intersect_rectangles (fr
, &wr
, &r
))
30781 int yb
= window_text_bottom_y (w
);
30782 struct glyph_row
*row
;
30783 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30785 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30786 r
.x
, r
.y
, r
.width
, r
.height
));
30788 /* Convert to window coordinates. */
30789 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30790 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30792 /* Turn off the cursor. */
30793 bool cursor_cleared_p
= (!w
->pseudo_window_p
30794 && phys_cursor_in_rect_p (w
, &r
));
30795 if (cursor_cleared_p
)
30796 x_clear_cursor (w
);
30798 /* If the row containing the cursor extends face to end of line,
30799 then expose_area might overwrite the cursor outside the
30800 rectangle and thus notice_overwritten_cursor might clear
30801 w->phys_cursor_on_p. We remember the original value and
30802 check later if it is changed. */
30803 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30805 /* Use a signed int intermediate value to avoid catastrophic
30806 failures due to comparison between signed and unsigned, when
30807 y0 or y1 is negative (can happen for tall images). */
30808 int r_bottom
= r
.y
+ r
.height
;
30810 /* Update lines intersecting rectangle R. */
30811 first_overlapping_row
= last_overlapping_row
= NULL
;
30812 for (row
= w
->current_matrix
->rows
;
30817 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30819 if ((y0
>= r
.y
&& y0
< r_bottom
)
30820 || (y1
> r
.y
&& y1
< r_bottom
)
30821 || (r
.y
>= y0
&& r
.y
< y1
)
30822 || (r_bottom
> y0
&& r_bottom
< y1
))
30824 /* A header line may be overlapping, but there is no need
30825 to fix overlapping areas for them. KFS 2005-02-12 */
30826 if (row
->overlapping_p
&& !row
->mode_line_p
)
30828 if (first_overlapping_row
== NULL
)
30829 first_overlapping_row
= row
;
30830 last_overlapping_row
= row
;
30834 if (expose_line (w
, row
, &r
))
30835 mouse_face_overwritten_p
= true;
30838 else if (row
->overlapping_p
)
30840 /* We must redraw a row overlapping the exposed area. */
30842 ? y0
+ row
->phys_height
> r
.y
30843 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30845 if (first_overlapping_row
== NULL
)
30846 first_overlapping_row
= row
;
30847 last_overlapping_row
= row
;
30855 /* Display the mode line if there is one. */
30856 if (WINDOW_WANTS_MODELINE_P (w
)
30857 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30859 && row
->y
< r_bottom
)
30861 if (expose_line (w
, row
, &r
))
30862 mouse_face_overwritten_p
= true;
30865 if (!w
->pseudo_window_p
)
30867 /* Fix the display of overlapping rows. */
30868 if (first_overlapping_row
)
30869 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30872 /* Draw border between windows. */
30873 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30874 x_draw_right_divider (w
);
30876 x_draw_vertical_border (w
);
30878 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30879 x_draw_bottom_divider (w
);
30881 /* Turn the cursor on again. */
30882 if (cursor_cleared_p
30883 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30884 update_window_cursor (w
, true);
30888 return mouse_face_overwritten_p
;
30893 /* Redraw (parts) of all windows in the window tree rooted at W that
30894 intersect R. R contains frame pixel coordinates. Value is
30895 true if the exposure overwrites mouse-face. */
30898 expose_window_tree (struct window
*w
, XRectangle
*r
)
30900 struct frame
*f
= XFRAME (w
->frame
);
30901 bool mouse_face_overwritten_p
= false;
30903 while (w
&& !FRAME_GARBAGED_P (f
))
30905 mouse_face_overwritten_p
30906 |= (WINDOWP (w
->contents
)
30907 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30908 : expose_window (w
, r
));
30910 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30913 return mouse_face_overwritten_p
;
30918 Redisplay an exposed area of frame F. X and Y are the upper-left
30919 corner of the exposed rectangle. W and H are width and height of
30920 the exposed area. All are pixel values. W or H zero means redraw
30921 the entire frame. */
30924 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30927 bool mouse_face_overwritten_p
= false;
30929 TRACE ((stderr
, "expose_frame "));
30931 /* No need to redraw if frame will be redrawn soon. */
30932 if (FRAME_GARBAGED_P (f
))
30934 TRACE ((stderr
, " garbaged\n"));
30938 /* If basic faces haven't been realized yet, there is no point in
30939 trying to redraw anything. This can happen when we get an expose
30940 event while Emacs is starting, e.g. by moving another window. */
30941 if (FRAME_FACE_CACHE (f
) == NULL
30942 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30944 TRACE ((stderr
, " no faces\n"));
30948 if (w
== 0 || h
== 0)
30951 r
.width
= FRAME_TEXT_WIDTH (f
);
30952 r
.height
= FRAME_TEXT_HEIGHT (f
);
30962 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30963 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30965 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30966 if (WINDOWP (f
->tool_bar_window
))
30967 mouse_face_overwritten_p
30968 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30971 #ifdef HAVE_X_WINDOWS
30973 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30974 if (WINDOWP (f
->menu_bar_window
))
30975 mouse_face_overwritten_p
30976 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30977 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30981 /* Some window managers support a focus-follows-mouse style with
30982 delayed raising of frames. Imagine a partially obscured frame,
30983 and moving the mouse into partially obscured mouse-face on that
30984 frame. The visible part of the mouse-face will be highlighted,
30985 then the WM raises the obscured frame. With at least one WM, KDE
30986 2.1, Emacs is not getting any event for the raising of the frame
30987 (even tried with SubstructureRedirectMask), only Expose events.
30988 These expose events will draw text normally, i.e. not
30989 highlighted. Which means we must redo the highlight here.
30990 Subsume it under ``we love X''. --gerd 2001-08-15 */
30991 /* Included in Windows version because Windows most likely does not
30992 do the right thing if any third party tool offers
30993 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30994 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30996 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30997 if (f
== hlinfo
->mouse_face_mouse_frame
)
30999 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
31000 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
31001 clear_mouse_face (hlinfo
);
31002 note_mouse_highlight (f
, mouse_x
, mouse_y
);
31009 Determine the intersection of two rectangles R1 and R2. Return
31010 the intersection in *RESULT. Value is true if RESULT is not
31014 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
31016 XRectangle
*left
, *right
;
31017 XRectangle
*upper
, *lower
;
31018 bool intersection_p
= false;
31020 /* Rearrange so that R1 is the left-most rectangle. */
31022 left
= r1
, right
= r2
;
31024 left
= r2
, right
= r1
;
31026 /* X0 of the intersection is right.x0, if this is inside R1,
31027 otherwise there is no intersection. */
31028 if (right
->x
<= left
->x
+ left
->width
)
31030 result
->x
= right
->x
;
31032 /* The right end of the intersection is the minimum of
31033 the right ends of left and right. */
31034 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
31037 /* Same game for Y. */
31039 upper
= r1
, lower
= r2
;
31041 upper
= r2
, lower
= r1
;
31043 /* The upper end of the intersection is lower.y0, if this is inside
31044 of upper. Otherwise, there is no intersection. */
31045 if (lower
->y
<= upper
->y
+ upper
->height
)
31047 result
->y
= lower
->y
;
31049 /* The lower end of the intersection is the minimum of the lower
31050 ends of upper and lower. */
31051 result
->height
= (min (lower
->y
+ lower
->height
,
31052 upper
->y
+ upper
->height
)
31054 intersection_p
= true;
31058 return intersection_p
;
31061 #endif /* HAVE_WINDOW_SYSTEM */
31064 /***********************************************************************
31066 ***********************************************************************/
31069 syms_of_xdisp (void)
31071 Vwith_echo_area_save_vector
= Qnil
;
31072 staticpro (&Vwith_echo_area_save_vector
);
31074 Vmessage_stack
= Qnil
;
31075 staticpro (&Vmessage_stack
);
31077 /* Non-nil means don't actually do any redisplay. */
31078 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
31080 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
31082 DEFVAR_BOOL("inhibit-message", inhibit_message
,
31083 doc
: /* Non-nil means calls to `message' are not displayed.
31084 They are still logged to the *Messages* buffer. */);
31085 inhibit_message
= 0;
31087 message_dolog_marker1
= Fmake_marker ();
31088 staticpro (&message_dolog_marker1
);
31089 message_dolog_marker2
= Fmake_marker ();
31090 staticpro (&message_dolog_marker2
);
31091 message_dolog_marker3
= Fmake_marker ();
31092 staticpro (&message_dolog_marker3
);
31095 defsubr (&Sdump_frame_glyph_matrix
);
31096 defsubr (&Sdump_glyph_matrix
);
31097 defsubr (&Sdump_glyph_row
);
31098 defsubr (&Sdump_tool_bar_row
);
31099 defsubr (&Strace_redisplay
);
31100 defsubr (&Strace_to_stderr
);
31102 #ifdef HAVE_WINDOW_SYSTEM
31103 defsubr (&Stool_bar_height
);
31104 defsubr (&Slookup_image_map
);
31106 defsubr (&Sline_pixel_height
);
31107 defsubr (&Sformat_mode_line
);
31108 defsubr (&Sinvisible_p
);
31109 defsubr (&Scurrent_bidi_paragraph_direction
);
31110 defsubr (&Swindow_text_pixel_size
);
31111 defsubr (&Smove_point_visually
);
31112 defsubr (&Sbidi_find_overridden_directionality
);
31114 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
31115 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
31116 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
31117 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
31118 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
31119 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
31120 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
31121 DEFSYM (Qeval
, "eval");
31122 DEFSYM (QCdata
, ":data");
31124 /* Names of text properties relevant for redisplay. */
31125 DEFSYM (Qdisplay
, "display");
31126 DEFSYM (Qspace_width
, "space-width");
31127 DEFSYM (Qraise
, "raise");
31128 DEFSYM (Qslice
, "slice");
31129 DEFSYM (Qspace
, "space");
31130 DEFSYM (Qmargin
, "margin");
31131 DEFSYM (Qpointer
, "pointer");
31132 DEFSYM (Qleft_margin
, "left-margin");
31133 DEFSYM (Qright_margin
, "right-margin");
31134 DEFSYM (Qcenter
, "center");
31135 DEFSYM (Qline_height
, "line-height");
31136 DEFSYM (QCalign_to
, ":align-to");
31137 DEFSYM (QCrelative_width
, ":relative-width");
31138 DEFSYM (QCrelative_height
, ":relative-height");
31139 DEFSYM (QCeval
, ":eval");
31140 DEFSYM (QCpropertize
, ":propertize");
31141 DEFSYM (QCfile
, ":file");
31142 DEFSYM (Qfontified
, "fontified");
31143 DEFSYM (Qfontification_functions
, "fontification-functions");
31145 /* Name of the face used to highlight trailing whitespace. */
31146 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
31148 /* Name and number of the face used to highlight escape glyphs. */
31149 DEFSYM (Qescape_glyph
, "escape-glyph");
31151 /* Name and number of the face used to highlight non-breaking spaces. */
31152 DEFSYM (Qnobreak_space
, "nobreak-space");
31154 /* The symbol 'image' which is the car of the lists used to represent
31155 images in Lisp. Also a tool bar style. */
31156 DEFSYM (Qimage
, "image");
31158 /* Tool bar styles. */
31159 DEFSYM (Qtext
, "text");
31160 DEFSYM (Qboth
, "both");
31161 DEFSYM (Qboth_horiz
, "both-horiz");
31162 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
31164 /* The image map types. */
31165 DEFSYM (QCmap
, ":map");
31166 DEFSYM (QCpointer
, ":pointer");
31167 DEFSYM (Qrect
, "rect");
31168 DEFSYM (Qcircle
, "circle");
31169 DEFSYM (Qpoly
, "poly");
31171 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
31173 DEFSYM (Qgrow_only
, "grow-only");
31174 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
31175 DEFSYM (Qposition
, "position");
31176 DEFSYM (Qbuffer_position
, "buffer-position");
31177 DEFSYM (Qobject
, "object");
31179 /* Cursor shapes. */
31180 DEFSYM (Qbar
, "bar");
31181 DEFSYM (Qhbar
, "hbar");
31182 DEFSYM (Qbox
, "box");
31183 DEFSYM (Qhollow
, "hollow");
31185 /* Pointer shapes. */
31186 DEFSYM (Qhand
, "hand");
31187 DEFSYM (Qarrow
, "arrow");
31190 DEFSYM (Qdragging
, "dragging");
31192 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
31194 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
31195 staticpro (&list_of_error
);
31197 /* Values of those variables at last redisplay are stored as
31198 properties on 'overlay-arrow-position' symbol. However, if
31199 Voverlay_arrow_position is a marker, last-arrow-position is its
31200 numerical position. */
31201 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
31202 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
31204 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31205 properties on a symbol in overlay-arrow-variable-list. */
31206 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
31207 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
31209 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
31210 staticpro (&echo_buffer
[0]);
31211 staticpro (&echo_buffer
[1]);
31213 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
31214 staticpro (&echo_area_buffer
[0]);
31215 staticpro (&echo_area_buffer
[1]);
31217 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
31218 staticpro (&Vmessages_buffer_name
);
31220 mode_line_proptrans_alist
= Qnil
;
31221 staticpro (&mode_line_proptrans_alist
);
31222 mode_line_string_list
= Qnil
;
31223 staticpro (&mode_line_string_list
);
31224 mode_line_string_face
= Qnil
;
31225 staticpro (&mode_line_string_face
);
31226 mode_line_string_face_prop
= Qnil
;
31227 staticpro (&mode_line_string_face_prop
);
31228 Vmode_line_unwind_vector
= Qnil
;
31229 staticpro (&Vmode_line_unwind_vector
);
31231 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
31233 help_echo_string
= Qnil
;
31234 staticpro (&help_echo_string
);
31235 help_echo_object
= Qnil
;
31236 staticpro (&help_echo_object
);
31237 help_echo_window
= Qnil
;
31238 staticpro (&help_echo_window
);
31239 previous_help_echo_string
= Qnil
;
31240 staticpro (&previous_help_echo_string
);
31241 help_echo_pos
= -1;
31243 DEFSYM (Qright_to_left
, "right-to-left");
31244 DEFSYM (Qleft_to_right
, "left-to-right");
31245 defsubr (&Sbidi_resolved_levels
);
31247 #ifdef HAVE_WINDOW_SYSTEM
31248 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
31249 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
31250 For example, if a block cursor is over a tab, it will be drawn as
31251 wide as that tab on the display. */);
31252 x_stretch_cursor_p
= 0;
31255 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
31256 doc
: /* Non-nil means highlight trailing whitespace.
31257 The face used for trailing whitespace is `trailing-whitespace'. */);
31258 Vshow_trailing_whitespace
= Qnil
;
31260 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
31261 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
31262 If the value is t, Emacs highlights non-ASCII chars which have the
31263 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31264 or `escape-glyph' face respectively.
31266 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31267 U+2011 (non-breaking hyphen) are affected.
31269 Any other non-nil value means to display these characters as a escape
31270 glyph followed by an ordinary space or hyphen.
31272 A value of nil means no special handling of these characters. */);
31273 Vnobreak_char_display
= Qt
;
31275 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
31276 doc
: /* The pointer shape to show in void text areas.
31277 A value of nil means to show the text pointer. Other options are
31278 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31280 Vvoid_text_area_pointer
= Qarrow
;
31282 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
31283 doc
: /* Non-nil means don't actually do any redisplay.
31284 This is used for internal purposes. */);
31285 Vinhibit_redisplay
= Qnil
;
31287 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
31288 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31289 Vglobal_mode_string
= Qnil
;
31291 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
31292 doc
: /* Marker for where to display an arrow on top of the buffer text.
31293 This must be the beginning of a line in order to work.
31294 See also `overlay-arrow-string'. */);
31295 Voverlay_arrow_position
= Qnil
;
31297 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
31298 doc
: /* String to display as an arrow in non-window frames.
31299 See also `overlay-arrow-position'. */);
31300 Voverlay_arrow_string
= build_pure_c_string ("=>");
31302 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
31303 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
31304 The symbols on this list are examined during redisplay to determine
31305 where to display overlay arrows. */);
31306 Voverlay_arrow_variable_list
31307 = list1 (intern_c_string ("overlay-arrow-position"));
31309 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31310 doc
: /* The number of lines to try scrolling a window by when point moves out.
31311 If that fails to bring point back on frame, point is centered instead.
31312 If this is zero, point is always centered after it moves off frame.
31313 If you want scrolling to always be a line at a time, you should set
31314 `scroll-conservatively' to a large value rather than set this to 1. */);
31316 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31317 doc
: /* Scroll up to this many lines, to bring point back on screen.
31318 If point moves off-screen, redisplay will scroll by up to
31319 `scroll-conservatively' lines in order to bring point just barely
31320 onto the screen again. If that cannot be done, then redisplay
31321 recenters point as usual.
31323 If the value is greater than 100, redisplay will never recenter point,
31324 but will always scroll just enough text to bring point into view, even
31325 if you move far away.
31327 A value of zero means always recenter point if it moves off screen. */);
31328 scroll_conservatively
= 0;
31330 DEFVAR_INT ("scroll-margin", scroll_margin
,
31331 doc
: /* Number of lines of margin at the top and bottom of a window.
31332 Recenter the window whenever point gets within this many lines
31333 of the top or bottom of the window. */);
31336 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31337 doc
: /* Pixels per inch value for non-window system displays.
31338 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31339 Vdisplay_pixels_per_inch
= make_float (72.0);
31342 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31345 DEFVAR_LISP ("truncate-partial-width-windows",
31346 Vtruncate_partial_width_windows
,
31347 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31348 For an integer value, truncate lines in each window narrower than the
31349 full frame width, provided the window width is less than that integer;
31350 otherwise, respect the value of `truncate-lines'.
31352 For any other non-nil value, truncate lines in all windows that do
31353 not span the full frame width.
31355 A value of nil means to respect the value of `truncate-lines'.
31357 If `word-wrap' is enabled, you might want to reduce this. */);
31358 Vtruncate_partial_width_windows
= make_number (50);
31360 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31361 doc
: /* Maximum buffer size for which line number should be displayed.
31362 If the buffer is bigger than this, the line number does not appear
31363 in the mode line. A value of nil means no limit. */);
31364 Vline_number_display_limit
= Qnil
;
31366 DEFVAR_INT ("line-number-display-limit-width",
31367 line_number_display_limit_width
,
31368 doc
: /* Maximum line width (in characters) for line number display.
31369 If the average length of the lines near point is bigger than this, then the
31370 line number may be omitted from the mode line. */);
31371 line_number_display_limit_width
= 200;
31373 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31374 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31375 highlight_nonselected_windows
= false;
31377 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31378 doc
: /* Non-nil if more than one frame is visible on this display.
31379 Minibuffer-only frames don't count, but iconified frames do.
31380 This variable is not guaranteed to be accurate except while processing
31381 `frame-title-format' and `icon-title-format'. */);
31383 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31384 doc
: /* Template for displaying the title bar of visible frames.
31385 (Assuming the window manager supports this feature.)
31387 This variable has the same structure as `mode-line-format', except that
31388 the %c and %l constructs are ignored. It is used only on frames for
31389 which no explicit name has been set (see `modify-frame-parameters'). */);
31391 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31392 doc
: /* Template for displaying the title bar of an iconified frame.
31393 (Assuming the window manager supports this feature.)
31394 This variable has the same structure as `mode-line-format' (which see),
31395 and is used only on frames for which no explicit name has been set
31396 (see `modify-frame-parameters'). */);
31398 = Vframe_title_format
31399 = listn (CONSTYPE_PURE
, 3,
31400 intern_c_string ("multiple-frames"),
31401 build_pure_c_string ("%b"),
31402 listn (CONSTYPE_PURE
, 4,
31403 empty_unibyte_string
,
31404 intern_c_string ("invocation-name"),
31405 build_pure_c_string ("@"),
31406 intern_c_string ("system-name")));
31408 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31409 doc
: /* Maximum number of lines to keep in the message log buffer.
31410 If nil, disable message logging. If t, log messages but don't truncate
31411 the buffer when it becomes large. */);
31412 Vmessage_log_max
= make_number (1000);
31414 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31415 doc
: /* List of functions to call before redisplaying a window with scrolling.
31416 Each function is called with two arguments, the window and its new
31417 display-start position.
31418 These functions are called whenever the `window-start' marker is modified,
31419 either to point into another buffer (e.g. via `set-window-buffer') or another
31420 place in the same buffer.
31421 Note that the value of `window-end' is not valid when these functions are
31424 Warning: Do not use this feature to alter the way the window
31425 is scrolled. It is not designed for that, and such use probably won't
31427 Vwindow_scroll_functions
= Qnil
;
31429 DEFVAR_LISP ("window-text-change-functions",
31430 Vwindow_text_change_functions
,
31431 doc
: /* Functions to call in redisplay when text in the window might change. */);
31432 Vwindow_text_change_functions
= Qnil
;
31434 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31435 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31436 Each function is called with two arguments, the window and the end trigger value.
31437 See `set-window-redisplay-end-trigger'. */);
31438 Vredisplay_end_trigger_functions
= Qnil
;
31440 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31441 doc
: /* Non-nil means autoselect window with mouse pointer.
31442 If nil, do not autoselect windows.
31443 A positive number means delay autoselection by that many seconds: a
31444 window is autoselected only after the mouse has remained in that
31445 window for the duration of the delay.
31446 A negative number has a similar effect, but causes windows to be
31447 autoselected only after the mouse has stopped moving. (Because of
31448 the way Emacs compares mouse events, you will occasionally wait twice
31449 that time before the window gets selected.)
31450 Any other value means to autoselect window instantaneously when the
31451 mouse pointer enters it.
31453 Autoselection selects the minibuffer only if it is active, and never
31454 unselects the minibuffer if it is active.
31456 When customizing this variable make sure that the actual value of
31457 `focus-follows-mouse' matches the behavior of your window manager. */);
31458 Vmouse_autoselect_window
= Qnil
;
31460 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31461 doc
: /* Non-nil means automatically resize tool-bars.
31462 This dynamically changes the tool-bar's height to the minimum height
31463 that is needed to make all tool-bar items visible.
31464 If value is `grow-only', the tool-bar's height is only increased
31465 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31466 Vauto_resize_tool_bars
= Qt
;
31468 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31469 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31470 auto_raise_tool_bar_buttons_p
= true;
31472 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31473 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31474 make_cursor_line_fully_visible_p
= true;
31476 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31477 doc
: /* Border below tool-bar in pixels.
31478 If an integer, use it as the height of the border.
31479 If it is one of `internal-border-width' or `border-width', use the
31480 value of the corresponding frame parameter.
31481 Otherwise, no border is added below the tool-bar. */);
31482 Vtool_bar_border
= Qinternal_border_width
;
31484 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31485 doc
: /* Margin around tool-bar buttons in pixels.
31486 If an integer, use that for both horizontal and vertical margins.
31487 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31488 HORZ specifying the horizontal margin, and VERT specifying the
31489 vertical margin. */);
31490 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31492 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31493 doc
: /* Relief thickness of tool-bar buttons. */);
31494 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31496 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31497 doc
: /* Tool bar style to use.
31499 image - show images only
31500 text - show text only
31501 both - show both, text below image
31502 both-horiz - show text to the right of the image
31503 text-image-horiz - show text to the left of the image
31504 any other - use system default or image if no system default.
31506 This variable only affects the GTK+ toolkit version of Emacs. */);
31507 Vtool_bar_style
= Qnil
;
31509 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31510 doc
: /* Maximum number of characters a label can have to be shown.
31511 The tool bar style must also show labels for this to have any effect, see
31512 `tool-bar-style'. */);
31513 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31515 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31516 doc
: /* List of functions to call to fontify regions of text.
31517 Each function is called with one argument POS. Functions must
31518 fontify a region starting at POS in the current buffer, and give
31519 fontified regions the property `fontified'. */);
31520 Vfontification_functions
= Qnil
;
31521 Fmake_variable_buffer_local (Qfontification_functions
);
31523 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31524 unibyte_display_via_language_environment
,
31525 doc
: /* Non-nil means display unibyte text according to language environment.
31526 Specifically, this means that raw bytes in the range 160-255 decimal
31527 are displayed by converting them to the equivalent multibyte characters
31528 according to the current language environment. As a result, they are
31529 displayed according to the current fontset.
31531 Note that this variable affects only how these bytes are displayed,
31532 but does not change the fact they are interpreted as raw bytes. */);
31533 unibyte_display_via_language_environment
= false;
31535 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31536 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31537 If a float, it specifies a fraction of the mini-window frame's height.
31538 If an integer, it specifies a number of lines. */);
31539 Vmax_mini_window_height
= make_float (0.25);
31541 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31542 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31543 A value of nil means don't automatically resize mini-windows.
31544 A value of t means resize them to fit the text displayed in them.
31545 A value of `grow-only', the default, means let mini-windows grow only;
31546 they return to their normal size when the minibuffer is closed, or the
31547 echo area becomes empty. */);
31548 Vresize_mini_windows
= Qgrow_only
;
31550 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31551 doc
: /* Alist specifying how to blink the cursor off.
31552 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31553 `cursor-type' frame-parameter or variable equals ON-STATE,
31554 comparing using `equal', Emacs uses OFF-STATE to specify
31555 how to blink it off. ON-STATE and OFF-STATE are values for
31556 the `cursor-type' frame parameter.
31558 If a frame's ON-STATE has no entry in this list,
31559 the frame's other specifications determine how to blink the cursor off. */);
31560 Vblink_cursor_alist
= Qnil
;
31562 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31563 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31564 If non-nil, windows are automatically scrolled horizontally to make
31565 point visible. */);
31566 automatic_hscrolling_p
= true;
31567 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31569 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31570 doc
: /* How many columns away from the window edge point is allowed to get
31571 before automatic hscrolling will horizontally scroll the window. */);
31572 hscroll_margin
= 5;
31574 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31575 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31576 When point is less than `hscroll-margin' columns from the window
31577 edge, automatic hscrolling will scroll the window by the amount of columns
31578 determined by this variable. If its value is a positive integer, scroll that
31579 many columns. If it's a positive floating-point number, it specifies the
31580 fraction of the window's width to scroll. If it's nil or zero, point will be
31581 centered horizontally after the scroll. Any other value, including negative
31582 numbers, are treated as if the value were zero.
31584 Automatic hscrolling always moves point outside the scroll margin, so if
31585 point was more than scroll step columns inside the margin, the window will
31586 scroll more than the value given by the scroll step.
31588 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31589 and `scroll-right' overrides this variable's effect. */);
31590 Vhscroll_step
= make_number (0);
31592 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31593 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31594 Bind this around calls to `message' to let it take effect. */);
31595 message_truncate_lines
= false;
31597 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31598 doc
: /* Normal hook run to update the menu bar definitions.
31599 Redisplay runs this hook before it redisplays the menu bar.
31600 This is used to update menus such as Buffers, whose contents depend on
31602 Vmenu_bar_update_hook
= Qnil
;
31604 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31605 doc
: /* Frame for which we are updating a menu.
31606 The enable predicate for a menu binding should check this variable. */);
31607 Vmenu_updating_frame
= Qnil
;
31609 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31610 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31611 inhibit_menubar_update
= false;
31613 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31614 doc
: /* Prefix prepended to all continuation lines at display time.
31615 The value may be a string, an image, or a stretch-glyph; it is
31616 interpreted in the same way as the value of a `display' text property.
31618 This variable is overridden by any `wrap-prefix' text or overlay
31621 To add a prefix to non-continuation lines, use `line-prefix'. */);
31622 Vwrap_prefix
= Qnil
;
31623 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31624 Fmake_variable_buffer_local (Qwrap_prefix
);
31626 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31627 doc
: /* Prefix prepended to all non-continuation lines at display time.
31628 The value may be a string, an image, or a stretch-glyph; it is
31629 interpreted in the same way as the value of a `display' text property.
31631 This variable is overridden by any `line-prefix' text or overlay
31634 To add a prefix to continuation lines, use `wrap-prefix'. */);
31635 Vline_prefix
= Qnil
;
31636 DEFSYM (Qline_prefix
, "line-prefix");
31637 Fmake_variable_buffer_local (Qline_prefix
);
31639 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31640 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31641 inhibit_eval_during_redisplay
= false;
31643 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31644 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31645 inhibit_free_realized_faces
= false;
31647 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31648 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31649 Intended for use during debugging and for testing bidi display;
31650 see biditest.el in the test suite. */);
31651 inhibit_bidi_mirroring
= false;
31654 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31655 doc
: /* Inhibit try_window_id display optimization. */);
31656 inhibit_try_window_id
= false;
31658 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31659 doc
: /* Inhibit try_window_reusing display optimization. */);
31660 inhibit_try_window_reusing
= false;
31662 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31663 doc
: /* Inhibit try_cursor_movement display optimization. */);
31664 inhibit_try_cursor_movement
= false;
31665 #endif /* GLYPH_DEBUG */
31667 DEFVAR_INT ("overline-margin", overline_margin
,
31668 doc
: /* Space between overline and text, in pixels.
31669 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31670 margin to the character height. */);
31671 overline_margin
= 2;
31673 DEFVAR_INT ("underline-minimum-offset",
31674 underline_minimum_offset
,
31675 doc
: /* Minimum distance between baseline and underline.
31676 This can improve legibility of underlined text at small font sizes,
31677 particularly when using variable `x-use-underline-position-properties'
31678 with fonts that specify an UNDERLINE_POSITION relatively close to the
31679 baseline. The default value is 1. */);
31680 underline_minimum_offset
= 1;
31682 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31683 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31684 This feature only works when on a window system that can change
31685 cursor shapes. */);
31686 display_hourglass_p
= true;
31688 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31689 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31690 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31692 #ifdef HAVE_WINDOW_SYSTEM
31693 hourglass_atimer
= NULL
;
31694 hourglass_shown_p
= false;
31695 #endif /* HAVE_WINDOW_SYSTEM */
31697 /* Name of the face used to display glyphless characters. */
31698 DEFSYM (Qglyphless_char
, "glyphless-char");
31700 /* Method symbols for Vglyphless_char_display. */
31701 DEFSYM (Qhex_code
, "hex-code");
31702 DEFSYM (Qempty_box
, "empty-box");
31703 DEFSYM (Qthin_space
, "thin-space");
31704 DEFSYM (Qzero_width
, "zero-width");
31706 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31707 doc
: /* Function run just before redisplay.
31708 It is called with one argument, which is the set of windows that are to
31709 be redisplayed. This set can be nil (meaning, only the selected window),
31710 or t (meaning all windows). */);
31711 Vpre_redisplay_function
= intern ("ignore");
31713 /* Symbol for the purpose of Vglyphless_char_display. */
31714 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31715 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31717 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31718 doc
: /* Char-table defining glyphless characters.
31719 Each element, if non-nil, should be one of the following:
31720 an ASCII acronym string: display this string in a box
31721 `hex-code': display the hexadecimal code of a character in a box
31722 `empty-box': display as an empty box
31723 `thin-space': display as 1-pixel width space
31724 `zero-width': don't display
31725 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31726 display method for graphical terminals and text terminals respectively.
31727 GRAPHICAL and TEXT should each have one of the values listed above.
31729 The char-table has one extra slot to control the display of a character for
31730 which no font is found. This slot only takes effect on graphical terminals.
31731 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31732 `thin-space'. The default is `empty-box'.
31734 If a character has a non-nil entry in an active display table, the
31735 display table takes effect; in this case, Emacs does not consult
31736 `glyphless-char-display' at all. */);
31737 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31738 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31741 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31742 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31743 Vdebug_on_message
= Qnil
;
31745 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31747 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31749 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31751 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31753 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables
,
31754 doc
: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31755 Vredisplay__variables
= Qnil
;
31759 /* Initialize this module when Emacs starts. */
31764 CHARPOS (this_line_start_pos
) = 0;
31766 if (!noninteractive
)
31768 struct window
*m
= XWINDOW (minibuf_window
);
31769 Lisp_Object frame
= m
->frame
;
31770 struct frame
*f
= XFRAME (frame
);
31771 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31772 struct window
*r
= XWINDOW (root
);
31775 echo_area_window
= minibuf_window
;
31777 r
->top_line
= FRAME_TOP_MARGIN (f
);
31778 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31779 r
->total_cols
= FRAME_COLS (f
);
31780 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31781 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31782 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31784 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31785 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31786 m
->total_cols
= FRAME_COLS (f
);
31787 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31788 m
->total_lines
= 1;
31789 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31791 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31792 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31793 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31795 /* The default ellipsis glyphs `...'. */
31796 for (i
= 0; i
< 3; ++i
)
31797 default_invis_vector
[i
] = make_number ('.');
31801 /* Allocate the buffer for frame titles.
31802 Also used for `format-mode-line'. */
31804 mode_line_noprop_buf
= xmalloc (size
);
31805 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31806 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31807 mode_line_target
= MODE_LINE_DISPLAY
;
31810 help_echo_showing_p
= false;
31813 #ifdef HAVE_WINDOW_SYSTEM
31815 /* Platform-independent portion of hourglass implementation. */
31817 /* Timer function of hourglass_atimer. */
31820 show_hourglass (struct atimer
*timer
)
31822 /* The timer implementation will cancel this timer automatically
31823 after this function has run. Set hourglass_atimer to null
31824 so that we know the timer doesn't have to be canceled. */
31825 hourglass_atimer
= NULL
;
31827 if (!hourglass_shown_p
)
31829 Lisp_Object tail
, frame
;
31833 FOR_EACH_FRAME (tail
, frame
)
31835 struct frame
*f
= XFRAME (frame
);
31837 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31838 && FRAME_RIF (f
)->show_hourglass
)
31839 FRAME_RIF (f
)->show_hourglass (f
);
31842 hourglass_shown_p
= true;
31847 /* Cancel a currently active hourglass timer, and start a new one. */
31850 start_hourglass (void)
31852 struct timespec delay
;
31854 cancel_hourglass ();
31856 if (INTEGERP (Vhourglass_delay
)
31857 && XINT (Vhourglass_delay
) > 0)
31858 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31859 TYPE_MAXIMUM (time_t)),
31861 else if (FLOATP (Vhourglass_delay
)
31862 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31863 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31865 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31867 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31868 show_hourglass
, NULL
);
31871 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31875 cancel_hourglass (void)
31877 if (hourglass_atimer
)
31879 cancel_atimer (hourglass_atimer
);
31880 hourglass_atimer
= NULL
;
31883 if (hourglass_shown_p
)
31885 Lisp_Object tail
, frame
;
31889 FOR_EACH_FRAME (tail
, frame
)
31891 struct frame
*f
= XFRAME (frame
);
31893 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31894 && FRAME_RIF (f
)->hide_hourglass
)
31895 FRAME_RIF (f
)->hide_hourglass (f
);
31897 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31898 else if (!FRAME_W32_P (f
))
31899 w32_arrow_cursor ();
31903 hourglass_shown_p
= false;
31908 #endif /* HAVE_WINDOW_SYSTEM */