1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 /* Holds the list (error). */
328 static Lisp_Object list_of_error
;
330 #ifdef HAVE_WINDOW_SYSTEM
332 /* Test if overflow newline into fringe. Called with iterator IT
333 at or past right window margin, and with IT->current_x set. */
335 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
336 (!NILP (Voverflow_newline_into_fringe) \
337 && FRAME_WINDOW_P ((IT)->f) \
338 && ((IT)->bidi_it.paragraph_dir == R2L \
339 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
340 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
341 && (IT)->current_x == (IT)->last_visible_x)
343 #else /* !HAVE_WINDOW_SYSTEM */
344 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
345 #endif /* HAVE_WINDOW_SYSTEM */
347 /* Test if the display element loaded in IT, or the underlying buffer
348 or string character, is a space or a TAB character. This is used
349 to determine where word wrapping can occur. */
351 #define IT_DISPLAYING_WHITESPACE(it) \
352 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
353 || ((STRINGP (it->string) \
354 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
355 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
357 && (it->s[IT_BYTEPOS (*it)] == ' ' \
358 || it->s[IT_BYTEPOS (*it)] == '\t')) \
359 || (IT_BYTEPOS (*it) < ZV_BYTE \
360 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
361 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
363 /* True means print newline to stdout before next mini-buffer message. */
365 bool noninteractive_need_newline
;
367 /* True means print newline to message log before next message. */
369 static bool message_log_need_newline
;
371 /* Three markers that message_dolog uses.
372 It could allocate them itself, but that causes trouble
373 in handling memory-full errors. */
374 static Lisp_Object message_dolog_marker1
;
375 static Lisp_Object message_dolog_marker2
;
376 static Lisp_Object message_dolog_marker3
;
378 /* The buffer position of the first character appearing entirely or
379 partially on the line of the selected window which contains the
380 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
381 redisplay optimization in redisplay_internal. */
383 static struct text_pos this_line_start_pos
;
385 /* Number of characters past the end of the line above, including the
386 terminating newline. */
388 static struct text_pos this_line_end_pos
;
390 /* The vertical positions and the height of this line. */
392 static int this_line_vpos
;
393 static int this_line_y
;
394 static int this_line_pixel_height
;
396 /* X position at which this display line starts. Usually zero;
397 negative if first character is partially visible. */
399 static int this_line_start_x
;
401 /* The smallest character position seen by move_it_* functions as they
402 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
403 hscrolled lines, see display_line. */
405 static struct text_pos this_line_min_pos
;
407 /* Buffer that this_line_.* variables are referring to. */
409 static struct buffer
*this_line_buffer
;
411 /* True if an overlay arrow has been displayed in this window. */
413 static bool overlay_arrow_seen
;
415 /* Vector containing glyphs for an ellipsis `...'. */
417 static Lisp_Object default_invis_vector
[3];
419 /* This is the window where the echo area message was displayed. It
420 is always a mini-buffer window, but it may not be the same window
421 currently active as a mini-buffer. */
423 Lisp_Object echo_area_window
;
425 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
426 pushes the current message and the value of
427 message_enable_multibyte on the stack, the function restore_message
428 pops the stack and displays MESSAGE again. */
430 static Lisp_Object Vmessage_stack
;
432 /* True means multibyte characters were enabled when the echo area
433 message was specified. */
435 static bool message_enable_multibyte
;
437 /* At each redisplay cycle, we should refresh everything there is to refresh.
438 To do that efficiently, we use many optimizations that try to make sure we
439 don't waste too much time updating things that haven't changed.
440 The coarsest such optimization is that, in the most common cases, we only
441 look at the selected-window.
443 To know whether other windows should be considered for redisplay, we use the
444 variable windows_or_buffers_changed: as long as it is 0, it means that we
445 have not noticed anything that should require updating anything else than
446 the selected-window. If it is set to REDISPLAY_SOME, it means that since
447 last redisplay, some changes have been made which could impact other
448 windows. To know which ones need redisplay, every buffer, window, and frame
449 has a `redisplay' bit, which (if true) means that this object needs to be
450 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
451 looking for those `redisplay' bits (actually, there might be some such bits
452 set, but then only on objects which aren't displayed anyway).
454 OTOH if it's non-zero we wil have to loop through all windows and then check
455 the `redisplay' bit of the corresponding window, frame, and buffer, in order
456 to decide whether that window needs attention or not. Not that we can't
457 just look at the frame's redisplay bit to decide that the whole frame can be
458 skipped, since even if the frame's redisplay bit is unset, some of its
459 windows's redisplay bits may be set.
461 Mostly for historical reasons, windows_or_buffers_changed can also take
462 other non-zero values. In that case, the precise value doesn't matter (it
463 encodes the cause of the setting but is only used for debugging purposes),
464 and what it means is that we shouldn't pay attention to any `redisplay' bits
465 and we should simply try and redisplay every window out there. */
467 int windows_or_buffers_changed
;
469 /* Nonzero if we should redraw the mode lines on the next redisplay.
470 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
471 then only redisplay the mode lines in those buffers/windows/frames where the
472 `redisplay' bit has been set.
473 For any other value, redisplay all mode lines (the number used is then only
474 used to track down the cause for this full-redisplay).
476 The `redisplay' bits are the same as those used for
477 windows_or_buffers_changed, and setting windows_or_buffers_changed also
478 causes recomputation of the mode lines of all those windows. IOW this
479 variable only has an effect if windows_or_buffers_changed is zero, in which
480 case we should only need to redisplay the mode-line of those objects with
481 a `redisplay' bit set but not the window's text content (tho we may still
482 need to refresh the text content of the selected-window). */
484 int update_mode_lines
;
486 /* True after display_mode_line if %l was used and it displayed a
489 static bool line_number_displayed
;
491 /* The name of the *Messages* buffer, a string. */
493 static Lisp_Object Vmessages_buffer_name
;
495 /* Current, index 0, and last displayed echo area message. Either
496 buffers from echo_buffers, or nil to indicate no message. */
498 Lisp_Object echo_area_buffer
[2];
500 /* The buffers referenced from echo_area_buffer. */
502 static Lisp_Object echo_buffer
[2];
504 /* A vector saved used in with_area_buffer to reduce consing. */
506 static Lisp_Object Vwith_echo_area_save_vector
;
508 /* True means display_echo_area should display the last echo area
509 message again. Set by redisplay_preserve_echo_area. */
511 static bool display_last_displayed_message_p
;
513 /* True if echo area is being used by print; false if being used by
516 static bool message_buf_print
;
518 /* Set to true in clear_message to make redisplay_internal aware
519 of an emptied echo area. */
521 static bool message_cleared_p
;
523 /* A scratch glyph row with contents used for generating truncation
524 glyphs. Also used in direct_output_for_insert. */
526 #define MAX_SCRATCH_GLYPHS 100
527 static struct glyph_row scratch_glyph_row
;
528 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
530 /* Ascent and height of the last line processed by move_it_to. */
532 static int last_height
;
534 /* True if there's a help-echo in the echo area. */
536 bool help_echo_showing_p
;
538 /* The maximum distance to look ahead for text properties. Values
539 that are too small let us call compute_char_face and similar
540 functions too often which is expensive. Values that are too large
541 let us call compute_char_face and alike too often because we
542 might not be interested in text properties that far away. */
544 #define TEXT_PROP_DISTANCE_LIMIT 100
546 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
547 iterator state and later restore it. This is needed because the
548 bidi iterator on bidi.c keeps a stacked cache of its states, which
549 is really a singleton. When we use scratch iterator objects to
550 move around the buffer, we can cause the bidi cache to be pushed or
551 popped, and therefore we need to restore the cache state when we
552 return to the original iterator. */
553 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
556 bidi_unshelve_cache (CACHE, true); \
558 CACHE = bidi_shelve_cache (); \
561 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
563 if (pITORIG != pITCOPY) \
564 *(pITORIG) = *(pITCOPY); \
565 bidi_unshelve_cache (CACHE, false); \
569 /* Functions to mark elements as needing redisplay. */
570 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
573 redisplay_other_windows (void)
575 if (!windows_or_buffers_changed
)
576 windows_or_buffers_changed
= REDISPLAY_SOME
;
580 wset_redisplay (struct window
*w
)
582 /* Beware: selected_window can be nil during early stages. */
583 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
584 redisplay_other_windows ();
589 fset_redisplay (struct frame
*f
)
591 redisplay_other_windows ();
596 bset_redisplay (struct buffer
*b
)
598 int count
= buffer_window_count (b
);
601 /* ... it's visible in other window than selected, */
602 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
603 redisplay_other_windows ();
604 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
605 so that if we later set windows_or_buffers_changed, this buffer will
607 b
->text
->redisplay
= true;
612 bset_update_mode_line (struct buffer
*b
)
614 if (!update_mode_lines
)
615 update_mode_lines
= REDISPLAY_SOME
;
616 b
->text
->redisplay
= true;
621 /* True means print traces of redisplay if compiled with
622 GLYPH_DEBUG defined. */
624 bool trace_redisplay_p
;
626 #endif /* GLYPH_DEBUG */
628 #ifdef DEBUG_TRACE_MOVE
629 /* True means trace with TRACE_MOVE to stderr. */
630 static bool trace_move
;
632 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
634 #define TRACE_MOVE(x) (void) 0
637 /* Buffer being redisplayed -- for redisplay_window_error. */
639 static struct buffer
*displayed_buffer
;
641 /* Value returned from text property handlers (see below). */
646 HANDLED_RECOMPUTE_PROPS
,
647 HANDLED_OVERLAY_STRING_CONSUMED
,
651 /* A description of text properties that redisplay is interested
656 /* The symbol index of the name of the property. */
659 /* A unique index for the property. */
662 /* A handler function called to set up iterator IT from the property
663 at IT's current position. Value is used to steer handle_stop. */
664 enum prop_handled (*handler
) (struct it
*it
);
667 static enum prop_handled
handle_face_prop (struct it
*);
668 static enum prop_handled
handle_invisible_prop (struct it
*);
669 static enum prop_handled
handle_display_prop (struct it
*);
670 static enum prop_handled
handle_composition_prop (struct it
*);
671 static enum prop_handled
handle_overlay_change (struct it
*);
672 static enum prop_handled
handle_fontified_prop (struct it
*);
674 /* Properties handled by iterators. */
676 static struct props it_props
[] =
678 {SYMBOL_INDEX (Qfontified
), FONTIFIED_PROP_IDX
, handle_fontified_prop
},
679 /* Handle `face' before `display' because some sub-properties of
680 `display' need to know the face. */
681 {SYMBOL_INDEX (Qface
), FACE_PROP_IDX
, handle_face_prop
},
682 {SYMBOL_INDEX (Qdisplay
), DISPLAY_PROP_IDX
, handle_display_prop
},
683 {SYMBOL_INDEX (Qinvisible
), INVISIBLE_PROP_IDX
, handle_invisible_prop
},
684 {SYMBOL_INDEX (Qcomposition
), COMPOSITION_PROP_IDX
, handle_composition_prop
},
688 /* Value is the position described by X. If X is a marker, value is
689 the marker_position of X. Otherwise, value is X. */
691 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
693 /* Enumeration returned by some move_it_.* functions internally. */
697 /* Not used. Undefined value. */
700 /* Move ended at the requested buffer position or ZV. */
701 MOVE_POS_MATCH_OR_ZV
,
703 /* Move ended at the requested X pixel position. */
706 /* Move within a line ended at the end of a line that must be
710 /* Move within a line ended at the end of a line that would
711 be displayed truncated. */
714 /* Move within a line ended at a line end. */
718 /* This counter is used to clear the face cache every once in a while
719 in redisplay_internal. It is incremented for each redisplay.
720 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
723 #define CLEAR_FACE_CACHE_COUNT 500
724 static int clear_face_cache_count
;
726 /* Similarly for the image cache. */
728 #ifdef HAVE_WINDOW_SYSTEM
729 #define CLEAR_IMAGE_CACHE_COUNT 101
730 static int clear_image_cache_count
;
732 /* Null glyph slice */
733 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
736 /* True while redisplay_internal is in progress. */
740 /* If a string, XTread_socket generates an event to display that string.
741 (The display is done in read_char.) */
743 Lisp_Object help_echo_string
;
744 Lisp_Object help_echo_window
;
745 Lisp_Object help_echo_object
;
746 ptrdiff_t help_echo_pos
;
748 /* Temporary variable for XTread_socket. */
750 Lisp_Object previous_help_echo_string
;
752 /* Platform-independent portion of hourglass implementation. */
754 #ifdef HAVE_WINDOW_SYSTEM
756 /* True means an hourglass cursor is currently shown. */
757 static bool hourglass_shown_p
;
759 /* If non-null, an asynchronous timer that, when it expires, displays
760 an hourglass cursor on all frames. */
761 static struct atimer
*hourglass_atimer
;
763 #endif /* HAVE_WINDOW_SYSTEM */
765 /* Default number of seconds to wait before displaying an hourglass
767 #define DEFAULT_HOURGLASS_DELAY 1
769 #ifdef HAVE_WINDOW_SYSTEM
771 /* Default pixel width of `thin-space' display method. */
772 #define THIN_SPACE_WIDTH 1
774 #endif /* HAVE_WINDOW_SYSTEM */
776 /* Function prototypes. */
778 static void setup_for_ellipsis (struct it
*, int);
779 static void set_iterator_to_next (struct it
*, bool);
780 static void mark_window_display_accurate_1 (struct window
*, bool);
781 static bool row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
782 static bool cursor_row_p (struct glyph_row
*);
783 static int redisplay_mode_lines (Lisp_Object
, bool);
785 static void handle_line_prefix (struct it
*);
787 static void handle_stop_backwards (struct it
*, ptrdiff_t);
788 static void unwind_with_echo_area_buffer (Lisp_Object
);
789 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
790 static bool current_message_1 (ptrdiff_t, Lisp_Object
);
791 static bool truncate_message_1 (ptrdiff_t, Lisp_Object
);
792 static void set_message (Lisp_Object
);
793 static bool set_message_1 (ptrdiff_t, Lisp_Object
);
794 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object
);
795 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
796 static void unwind_redisplay (void);
797 static void extend_face_to_end_of_line (struct it
*);
798 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
799 static void push_it (struct it
*, struct text_pos
*);
800 static void iterate_out_of_display_property (struct it
*);
801 static void pop_it (struct it
*);
802 static void redisplay_internal (void);
803 static void echo_area_display (bool);
804 static void redisplay_windows (Lisp_Object
);
805 static void redisplay_window (Lisp_Object
, bool);
806 static Lisp_Object
redisplay_window_error (Lisp_Object
);
807 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
808 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
809 static bool set_cursor_from_row (struct window
*, struct glyph_row
*,
810 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
812 static bool update_menu_bar (struct frame
*, bool, bool);
813 static bool try_window_reusing_current_matrix (struct window
*);
814 static int try_window_id (struct window
*);
815 static bool display_line (struct it
*);
816 static int display_mode_lines (struct window
*);
817 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
818 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
,
820 static int store_mode_line_string (const char *, Lisp_Object
, bool, int, int,
822 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
823 static void display_menu_bar (struct window
*);
824 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
826 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
827 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
828 static void compute_line_metrics (struct it
*);
829 static void run_redisplay_end_trigger_hook (struct it
*);
830 static bool get_overlay_strings (struct it
*, ptrdiff_t);
831 static bool get_overlay_strings_1 (struct it
*, ptrdiff_t, bool);
832 static void next_overlay_string (struct it
*);
833 static void reseat (struct it
*, struct text_pos
, bool);
834 static void reseat_1 (struct it
*, struct text_pos
, bool);
835 static bool next_element_from_display_vector (struct it
*);
836 static bool next_element_from_string (struct it
*);
837 static bool next_element_from_c_string (struct it
*);
838 static bool next_element_from_buffer (struct it
*);
839 static bool next_element_from_composition (struct it
*);
840 static bool next_element_from_image (struct it
*);
841 static bool next_element_from_stretch (struct it
*);
842 static void load_overlay_strings (struct it
*, ptrdiff_t);
843 static bool get_next_display_element (struct it
*);
844 static enum move_it_result
845 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
846 enum move_operation_enum
);
847 static void get_visually_first_element (struct it
*);
848 static void compute_stop_pos (struct it
*);
849 static int face_before_or_after_it_pos (struct it
*, bool);
850 static ptrdiff_t next_overlay_change (ptrdiff_t);
851 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
852 Lisp_Object
, struct text_pos
*, ptrdiff_t, bool);
853 static int handle_single_display_spec (struct it
*, Lisp_Object
,
854 Lisp_Object
, Lisp_Object
,
855 struct text_pos
*, ptrdiff_t, int, bool);
856 static int underlying_face_id (struct it
*);
858 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
859 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
861 #ifdef HAVE_WINDOW_SYSTEM
863 static void update_tool_bar (struct frame
*, bool);
864 static void x_draw_bottom_divider (struct window
*w
);
865 static void notice_overwritten_cursor (struct window
*,
868 static int normal_char_height (struct font
*, int);
869 static void normal_char_ascent_descent (struct font
*, int, int *, int *);
871 static void append_stretch_glyph (struct it
*, Lisp_Object
,
874 static Lisp_Object
get_it_property (struct it
*, Lisp_Object
);
875 static Lisp_Object
calc_line_height_property (struct it
*, Lisp_Object
,
876 struct font
*, int, bool);
878 #endif /* HAVE_WINDOW_SYSTEM */
880 static void produce_special_glyphs (struct it
*, enum display_element_type
);
881 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
882 static bool coords_in_mouse_face_p (struct window
*, int, int);
886 /***********************************************************************
887 Window display dimensions
888 ***********************************************************************/
890 /* Return the bottom boundary y-position for text lines in window W.
891 This is the first y position at which a line cannot start.
892 It is relative to the top of the window.
894 This is the height of W minus the height of a mode line, if any. */
897 window_text_bottom_y (struct window
*w
)
899 int height
= WINDOW_PIXEL_HEIGHT (w
);
901 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
903 if (WINDOW_WANTS_MODELINE_P (w
))
904 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
906 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
911 /* Return the pixel width of display area AREA of window W.
912 ANY_AREA means return the total width of W, not including
913 fringes to the left and right of the window. */
916 window_box_width (struct window
*w
, enum glyph_row_area area
)
918 int width
= w
->pixel_width
;
920 if (!w
->pseudo_window_p
)
922 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
923 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
925 if (area
== TEXT_AREA
)
926 width
-= (WINDOW_MARGINS_WIDTH (w
)
927 + WINDOW_FRINGES_WIDTH (w
));
928 else if (area
== LEFT_MARGIN_AREA
)
929 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
930 else if (area
== RIGHT_MARGIN_AREA
)
931 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
934 /* With wide margins, fringes, etc. we might end up with a negative
935 width, correct that here. */
936 return max (0, width
);
940 /* Return the pixel height of the display area of window W, not
941 including mode lines of W, if any. */
944 window_box_height (struct window
*w
)
946 struct frame
*f
= XFRAME (w
->frame
);
947 int height
= WINDOW_PIXEL_HEIGHT (w
);
949 eassert (height
>= 0);
951 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
952 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
954 /* Note: the code below that determines the mode-line/header-line
955 height is essentially the same as that contained in the macro
956 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
957 the appropriate glyph row has its `mode_line_p' flag set,
958 and if it doesn't, uses estimate_mode_line_height instead. */
960 if (WINDOW_WANTS_MODELINE_P (w
))
962 struct glyph_row
*ml_row
963 = (w
->current_matrix
&& w
->current_matrix
->rows
964 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
966 if (ml_row
&& ml_row
->mode_line_p
)
967 height
-= ml_row
->height
;
969 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
972 if (WINDOW_WANTS_HEADER_LINE_P (w
))
974 struct glyph_row
*hl_row
975 = (w
->current_matrix
&& w
->current_matrix
->rows
976 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
978 if (hl_row
&& hl_row
->mode_line_p
)
979 height
-= hl_row
->height
;
981 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
984 /* With a very small font and a mode-line that's taller than
985 default, we might end up with a negative height. */
986 return max (0, height
);
989 /* Return the window-relative coordinate of the left edge of display
990 area AREA of window W. ANY_AREA means return the left edge of the
991 whole window, to the right of the left fringe of W. */
994 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
998 if (w
->pseudo_window_p
)
1001 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1003 if (area
== TEXT_AREA
)
1004 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1005 + window_box_width (w
, LEFT_MARGIN_AREA
));
1006 else if (area
== RIGHT_MARGIN_AREA
)
1007 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1008 + window_box_width (w
, LEFT_MARGIN_AREA
)
1009 + window_box_width (w
, TEXT_AREA
)
1010 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1012 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1013 else if (area
== LEFT_MARGIN_AREA
1014 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1015 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1017 /* Don't return more than the window's pixel width. */
1018 return min (x
, w
->pixel_width
);
1022 /* Return the window-relative coordinate of the right edge of display
1023 area AREA of window W. ANY_AREA means return the right edge of the
1024 whole window, to the left of the right fringe of W. */
1027 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1029 /* Don't return more than the window's pixel width. */
1030 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1034 /* Return the frame-relative coordinate of the left edge of display
1035 area AREA of window W. ANY_AREA means return the left edge of the
1036 whole window, to the right of the left fringe of W. */
1039 window_box_left (struct window
*w
, enum glyph_row_area area
)
1041 struct frame
*f
= XFRAME (w
->frame
);
1044 if (w
->pseudo_window_p
)
1045 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1047 x
= (WINDOW_LEFT_EDGE_X (w
)
1048 + window_box_left_offset (w
, area
));
1054 /* Return the frame-relative coordinate of the right edge of display
1055 area AREA of window W. ANY_AREA means return the right edge of the
1056 whole window, to the left of the right fringe of W. */
1059 window_box_right (struct window
*w
, enum glyph_row_area area
)
1061 return window_box_left (w
, area
) + window_box_width (w
, area
);
1064 /* Get the bounding box of the display area AREA of window W, without
1065 mode lines, in frame-relative coordinates. ANY_AREA means the
1066 whole window, not including the left and right fringes of
1067 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1068 coordinates of the upper-left corner of the box. Return in
1069 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1072 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1073 int *box_y
, int *box_width
, int *box_height
)
1076 *box_width
= window_box_width (w
, area
);
1078 *box_height
= window_box_height (w
);
1080 *box_x
= window_box_left (w
, area
);
1083 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1084 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1085 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1089 #ifdef HAVE_WINDOW_SYSTEM
1091 /* Get the bounding box of the display area AREA of window W, without
1092 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1093 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1094 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1095 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1099 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1100 int *bottom_right_x
, int *bottom_right_y
)
1102 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1103 bottom_right_x
, bottom_right_y
);
1104 *bottom_right_x
+= *top_left_x
;
1105 *bottom_right_y
+= *top_left_y
;
1108 #endif /* HAVE_WINDOW_SYSTEM */
1110 /***********************************************************************
1112 ***********************************************************************/
1114 /* Return the bottom y-position of the line the iterator IT is in.
1115 This can modify IT's settings. */
1118 line_bottom_y (struct it
*it
)
1120 int line_height
= it
->max_ascent
+ it
->max_descent
;
1121 int line_top_y
= it
->current_y
;
1123 if (line_height
== 0)
1126 line_height
= last_height
;
1127 else if (IT_CHARPOS (*it
) < ZV
)
1129 move_it_by_lines (it
, 1);
1130 line_height
= (it
->max_ascent
|| it
->max_descent
1131 ? it
->max_ascent
+ it
->max_descent
1136 struct glyph_row
*row
= it
->glyph_row
;
1138 /* Use the default character height. */
1139 it
->glyph_row
= NULL
;
1140 it
->what
= IT_CHARACTER
;
1143 PRODUCE_GLYPHS (it
);
1144 line_height
= it
->ascent
+ it
->descent
;
1145 it
->glyph_row
= row
;
1149 return line_top_y
+ line_height
;
1152 DEFUN ("line-pixel-height", Fline_pixel_height
,
1153 Sline_pixel_height
, 0, 0, 0,
1154 doc
: /* Return height in pixels of text line in the selected window.
1156 Value is the height in pixels of the line at point. */)
1161 struct window
*w
= XWINDOW (selected_window
);
1162 struct buffer
*old_buffer
= NULL
;
1165 if (XBUFFER (w
->contents
) != current_buffer
)
1167 old_buffer
= current_buffer
;
1168 set_buffer_internal_1 (XBUFFER (w
->contents
));
1170 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1171 start_display (&it
, w
, pt
);
1172 it
.vpos
= it
.current_y
= 0;
1174 result
= make_number (line_bottom_y (&it
));
1176 set_buffer_internal_1 (old_buffer
);
1181 /* Return the default pixel height of text lines in window W. The
1182 value is the canonical height of the W frame's default font, plus
1183 any extra space required by the line-spacing variable or frame
1186 Implementation note: this ignores any line-spacing text properties
1187 put on the newline characters. This is because those properties
1188 only affect the _screen_ line ending in the newline (i.e., in a
1189 continued line, only the last screen line will be affected), which
1190 means only a small number of lines in a buffer can ever use this
1191 feature. Since this function is used to compute the default pixel
1192 equivalent of text lines in a window, we can safely ignore those
1193 few lines. For the same reasons, we ignore the line-height
1196 default_line_pixel_height (struct window
*w
)
1198 struct frame
*f
= WINDOW_XFRAME (w
);
1199 int height
= FRAME_LINE_HEIGHT (f
);
1201 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1203 struct buffer
*b
= XBUFFER (w
->contents
);
1204 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1207 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1210 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1211 height
+= XFASTINT (val
);
1212 else if (FLOATP (val
))
1214 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1221 height
+= f
->extra_line_spacing
;
1227 /* Subroutine of pos_visible_p below. Extracts a display string, if
1228 any, from the display spec given as its argument. */
1230 string_from_display_spec (Lisp_Object spec
)
1234 while (CONSP (spec
))
1236 if (STRINGP (XCAR (spec
)))
1241 else if (VECTORP (spec
))
1245 for (i
= 0; i
< ASIZE (spec
); i
++)
1247 if (STRINGP (AREF (spec
, i
)))
1248 return AREF (spec
, i
);
1257 /* Limit insanely large values of W->hscroll on frame F to the largest
1258 value that will still prevent first_visible_x and last_visible_x of
1259 'struct it' from overflowing an int. */
1261 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1263 ptrdiff_t window_hscroll
= w
->hscroll
;
1264 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1265 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1267 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1268 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1270 return window_hscroll
;
1273 /* Return true if position CHARPOS is visible in window W.
1274 CHARPOS < 0 means return info about WINDOW_END position.
1275 If visible, set *X and *Y to pixel coordinates of top left corner.
1276 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1277 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1280 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1281 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1284 void *itdata
= bidi_shelve_cache ();
1285 struct text_pos top
;
1286 bool visible_p
= false;
1287 struct buffer
*old_buffer
= NULL
;
1290 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1293 if (XBUFFER (w
->contents
) != current_buffer
)
1295 old_buffer
= current_buffer
;
1296 set_buffer_internal_1 (XBUFFER (w
->contents
));
1299 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1300 /* Scrolling a minibuffer window via scroll bar when the echo area
1301 shows long text sometimes resets the minibuffer contents behind
1303 if (CHARPOS (top
) > ZV
)
1304 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1306 /* Compute exact mode line heights. */
1307 if (WINDOW_WANTS_MODELINE_P (w
))
1309 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1310 BVAR (current_buffer
, mode_line_format
));
1312 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1313 w
->header_line_height
1314 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1315 BVAR (current_buffer
, header_line_format
));
1317 start_display (&it
, w
, top
);
1318 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1319 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1322 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1323 && IT_CHARPOS (it
) >= charpos
)
1324 /* When scanning backwards under bidi iteration, move_it_to
1325 stops at or _before_ CHARPOS, because it stops at or to
1326 the _right_ of the character at CHARPOS. */
1327 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1328 && IT_CHARPOS (it
) <= charpos
)))
1330 /* We have reached CHARPOS, or passed it. How the call to
1331 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1332 or covered by a display property, move_it_to stops at the end
1333 of the invisible text, to the right of CHARPOS. (ii) If
1334 CHARPOS is in a display vector, move_it_to stops on its last
1336 int top_x
= it
.current_x
;
1337 int top_y
= it
.current_y
;
1338 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1341 void *save_it_data
= NULL
;
1343 /* Calling line_bottom_y may change it.method, it.position, etc. */
1344 SAVE_IT (save_it
, it
, save_it_data
);
1346 bottom_y
= line_bottom_y (&it
);
1347 if (top_y
< window_top_y
)
1348 visible_p
= bottom_y
> window_top_y
;
1349 else if (top_y
< it
.last_visible_y
)
1351 if (bottom_y
>= it
.last_visible_y
1352 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1353 && IT_CHARPOS (it
) < charpos
)
1355 /* When the last line of the window is scanned backwards
1356 under bidi iteration, we could be duped into thinking
1357 that we have passed CHARPOS, when in fact move_it_to
1358 simply stopped short of CHARPOS because it reached
1359 last_visible_y. To see if that's what happened, we call
1360 move_it_to again with a slightly larger vertical limit,
1361 and see if it actually moved vertically; if it did, we
1362 didn't really reach CHARPOS, which is beyond window end. */
1363 /* Why 10? because we don't know how many canonical lines
1364 will the height of the next line(s) be. So we guess. */
1365 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1367 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1368 MOVE_TO_POS
| MOVE_TO_Y
);
1369 if (it
.current_y
> top_y
)
1373 RESTORE_IT (&it
, &save_it
, save_it_data
);
1376 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1378 /* We stopped on the last glyph of a display vector.
1379 Try and recompute. Hack alert! */
1380 if (charpos
< 2 || top
.charpos
>= charpos
)
1381 top_x
= it
.glyph_row
->x
;
1384 struct it it2
, it2_prev
;
1385 /* The idea is to get to the previous buffer
1386 position, consume the character there, and use
1387 the pixel coordinates we get after that. But if
1388 the previous buffer position is also displayed
1389 from a display vector, we need to consume all of
1390 the glyphs from that display vector. */
1391 start_display (&it2
, w
, top
);
1392 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1393 /* If we didn't get to CHARPOS - 1, there's some
1394 replacing display property at that position, and
1395 we stopped after it. That is exactly the place
1396 whose coordinates we want. */
1397 if (IT_CHARPOS (it2
) != charpos
- 1)
1401 /* Iterate until we get out of the display
1402 vector that displays the character at
1405 get_next_display_element (&it2
);
1406 PRODUCE_GLYPHS (&it2
);
1408 set_iterator_to_next (&it2
, true);
1409 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1410 && IT_CHARPOS (it2
) < charpos
);
1412 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1413 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1414 top_x
= it
.glyph_row
->x
;
1417 top_x
= it2_prev
.current_x
;
1418 top_y
= it2_prev
.current_y
;
1422 else if (IT_CHARPOS (it
) != charpos
)
1424 Lisp_Object cpos
= make_number (charpos
);
1425 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1426 Lisp_Object string
= string_from_display_spec (spec
);
1427 struct text_pos tpos
;
1428 bool newline_in_string
1430 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1432 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1433 bool replacing_spec_p
1435 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1436 charpos
, FRAME_WINDOW_P (it
.f
)));
1437 /* The tricky code below is needed because there's a
1438 discrepancy between move_it_to and how we set cursor
1439 when PT is at the beginning of a portion of text
1440 covered by a display property or an overlay with a
1441 display property, or the display line ends in a
1442 newline from a display string. move_it_to will stop
1443 _after_ such display strings, whereas
1444 set_cursor_from_row conspires with cursor_row_p to
1445 place the cursor on the first glyph produced from the
1448 /* We have overshoot PT because it is covered by a
1449 display property that replaces the text it covers.
1450 If the string includes embedded newlines, we are also
1451 in the wrong display line. Backtrack to the correct
1452 line, where the display property begins. */
1453 if (replacing_spec_p
)
1455 Lisp_Object startpos
, endpos
;
1456 EMACS_INT start
, end
;
1459 /* Find the first and the last buffer positions
1460 covered by the display string. */
1462 Fnext_single_char_property_change (cpos
, Qdisplay
,
1465 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1467 start
= XFASTINT (startpos
);
1468 end
= XFASTINT (endpos
);
1469 /* Move to the last buffer position before the
1470 display property. */
1471 start_display (&it3
, w
, top
);
1472 if (start
> CHARPOS (top
))
1473 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1474 /* Move forward one more line if the position before
1475 the display string is a newline or if it is the
1476 rightmost character on a line that is
1477 continued or word-wrapped. */
1478 if (it3
.method
== GET_FROM_BUFFER
1480 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1481 move_it_by_lines (&it3
, 1);
1482 else if (move_it_in_display_line_to (&it3
, -1,
1486 == MOVE_LINE_CONTINUED
)
1488 move_it_by_lines (&it3
, 1);
1489 /* When we are under word-wrap, the #$@%!
1490 move_it_by_lines moves 2 lines, so we need to
1492 if (it3
.line_wrap
== WORD_WRAP
)
1493 move_it_by_lines (&it3
, -1);
1496 /* Record the vertical coordinate of the display
1497 line where we wound up. */
1498 top_y
= it3
.current_y
;
1501 /* When characters are reordered for display,
1502 the character displayed to the left of the
1503 display string could be _after_ the display
1504 property in the logical order. Use the
1505 smallest vertical position of these two. */
1506 start_display (&it3
, w
, top
);
1507 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1508 if (it3
.current_y
< top_y
)
1509 top_y
= it3
.current_y
;
1511 /* Move from the top of the window to the beginning
1512 of the display line where the display string
1514 start_display (&it3
, w
, top
);
1515 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1516 /* If it3_moved stays false after the 'while' loop
1517 below, that means we already were at a newline
1518 before the loop (e.g., the display string begins
1519 with a newline), so we don't need to (and cannot)
1520 inspect the glyphs of it3.glyph_row, because
1521 PRODUCE_GLYPHS will not produce anything for a
1522 newline, and thus it3.glyph_row stays at its
1523 stale content it got at top of the window. */
1524 bool it3_moved
= false;
1525 /* Finally, advance the iterator until we hit the
1526 first display element whose character position is
1527 CHARPOS, or until the first newline from the
1528 display string, which signals the end of the
1530 while (get_next_display_element (&it3
))
1532 PRODUCE_GLYPHS (&it3
);
1533 if (IT_CHARPOS (it3
) == charpos
1534 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1537 set_iterator_to_next (&it3
, false);
1539 top_x
= it3
.current_x
- it3
.pixel_width
;
1540 /* Normally, we would exit the above loop because we
1541 found the display element whose character
1542 position is CHARPOS. For the contingency that we
1543 didn't, and stopped at the first newline from the
1544 display string, move back over the glyphs
1545 produced from the string, until we find the
1546 rightmost glyph not from the string. */
1548 && newline_in_string
1549 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1551 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1552 + it3
.glyph_row
->used
[TEXT_AREA
];
1554 while (EQ ((g
- 1)->object
, string
))
1557 top_x
-= g
->pixel_width
;
1559 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1560 + it3
.glyph_row
->used
[TEXT_AREA
]);
1566 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1567 *rtop
= max (0, window_top_y
- top_y
);
1568 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1569 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1570 - max (top_y
, window_top_y
)));
1572 if (it
.bidi_it
.paragraph_dir
== R2L
)
1578 /* Either we were asked to provide info about WINDOW_END, or
1579 CHARPOS is in the partially visible glyph row at end of
1582 void *it2data
= NULL
;
1584 SAVE_IT (it2
, it
, it2data
);
1585 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1586 move_it_by_lines (&it
, 1);
1587 if (charpos
< IT_CHARPOS (it
)
1588 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1591 RESTORE_IT (&it2
, &it2
, it2data
);
1592 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1594 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1595 *rtop
= max (0, -it2
.current_y
);
1596 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1597 - it
.last_visible_y
));
1598 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1600 - max (it2
.current_y
,
1601 WINDOW_HEADER_LINE_HEIGHT (w
))));
1603 if (it2
.bidi_it
.paragraph_dir
== R2L
)
1607 bidi_unshelve_cache (it2data
, true);
1609 bidi_unshelve_cache (itdata
, false);
1612 set_buffer_internal_1 (old_buffer
);
1618 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1619 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1620 /* For lines in an R2L paragraph, we need to mirror the X pixel
1621 coordinate wrt the text area. For the reasons, see the
1622 commentary in buffer_posn_from_coords and the explanation of
1623 the geometry used by the move_it_* functions at the end of
1624 the large commentary near the beginning of this file. */
1626 *x
= window_box_width (w
, TEXT_AREA
) - *x
- 1;
1630 /* Debugging code. */
1632 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1633 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1635 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1642 /* Return the next character from STR. Return in *LEN the length of
1643 the character. This is like STRING_CHAR_AND_LENGTH but never
1644 returns an invalid character. If we find one, we return a `?', but
1645 with the length of the invalid character. */
1648 string_char_and_length (const unsigned char *str
, int *len
)
1652 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1653 if (!CHAR_VALID_P (c
))
1654 /* We may not change the length here because other places in Emacs
1655 don't use this function, i.e. they silently accept invalid
1664 /* Given a position POS containing a valid character and byte position
1665 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1667 static struct text_pos
1668 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1670 eassert (STRINGP (string
) && nchars
>= 0);
1672 if (STRING_MULTIBYTE (string
))
1674 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1679 string_char_and_length (p
, &len
);
1682 BYTEPOS (pos
) += len
;
1686 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1692 /* Value is the text position, i.e. character and byte position,
1693 for character position CHARPOS in STRING. */
1695 static struct text_pos
1696 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1698 struct text_pos pos
;
1699 eassert (STRINGP (string
));
1700 eassert (charpos
>= 0);
1701 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1706 /* Value is a text position, i.e. character and byte position, for
1707 character position CHARPOS in C string S. MULTIBYTE_P
1708 means recognize multibyte characters. */
1710 static struct text_pos
1711 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1713 struct text_pos pos
;
1715 eassert (s
!= NULL
);
1716 eassert (charpos
>= 0);
1722 SET_TEXT_POS (pos
, 0, 0);
1725 string_char_and_length ((const unsigned char *) s
, &len
);
1728 BYTEPOS (pos
) += len
;
1732 SET_TEXT_POS (pos
, charpos
, charpos
);
1738 /* Value is the number of characters in C string S. MULTIBYTE_P
1739 means recognize multibyte characters. */
1742 number_of_chars (const char *s
, bool multibyte_p
)
1748 ptrdiff_t rest
= strlen (s
);
1750 const unsigned char *p
= (const unsigned char *) s
;
1752 for (nchars
= 0; rest
> 0; ++nchars
)
1754 string_char_and_length (p
, &len
);
1755 rest
-= len
, p
+= len
;
1759 nchars
= strlen (s
);
1765 /* Compute byte position NEWPOS->bytepos corresponding to
1766 NEWPOS->charpos. POS is a known position in string STRING.
1767 NEWPOS->charpos must be >= POS.charpos. */
1770 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1772 eassert (STRINGP (string
));
1773 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1775 if (STRING_MULTIBYTE (string
))
1776 *newpos
= string_pos_nchars_ahead (pos
, string
,
1777 CHARPOS (*newpos
) - CHARPOS (pos
));
1779 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1783 Return an estimation of the pixel height of mode or header lines on
1784 frame F. FACE_ID specifies what line's height to estimate. */
1787 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1789 #ifdef HAVE_WINDOW_SYSTEM
1790 if (FRAME_WINDOW_P (f
))
1792 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1794 /* This function is called so early when Emacs starts that the face
1795 cache and mode line face are not yet initialized. */
1796 if (FRAME_FACE_CACHE (f
))
1798 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1802 height
= normal_char_height (face
->font
, -1);
1803 if (face
->box_line_width
> 0)
1804 height
+= 2 * face
->box_line_width
;
1815 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1816 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1817 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1818 not force the value into range. */
1821 pixel_to_glyph_coords (struct frame
*f
, int pix_x
, int pix_y
, int *x
, int *y
,
1822 NativeRectangle
*bounds
, bool noclip
)
1825 #ifdef HAVE_WINDOW_SYSTEM
1826 if (FRAME_WINDOW_P (f
))
1828 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1829 even for negative values. */
1831 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1833 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1835 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1836 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1839 STORE_NATIVE_RECT (*bounds
,
1840 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1841 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1842 FRAME_COLUMN_WIDTH (f
) - 1,
1843 FRAME_LINE_HEIGHT (f
) - 1);
1845 /* PXW: Should we clip pixels before converting to columns/lines? */
1850 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1851 pix_x
= FRAME_TOTAL_COLS (f
);
1855 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1856 pix_y
= FRAME_TOTAL_LINES (f
);
1866 /* Find the glyph under window-relative coordinates X/Y in window W.
1867 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1868 strings. Return in *HPOS and *VPOS the row and column number of
1869 the glyph found. Return in *AREA the glyph area containing X.
1870 Value is a pointer to the glyph found or null if X/Y is not on
1871 text, or we can't tell because W's current matrix is not up to
1874 static struct glyph
*
1875 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1876 int *dx
, int *dy
, int *area
)
1878 struct glyph
*glyph
, *end
;
1879 struct glyph_row
*row
= NULL
;
1882 /* Find row containing Y. Give up if some row is not enabled. */
1883 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1885 row
= MATRIX_ROW (w
->current_matrix
, i
);
1886 if (!row
->enabled_p
)
1888 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1895 /* Give up if Y is not in the window. */
1896 if (i
== w
->current_matrix
->nrows
)
1899 /* Get the glyph area containing X. */
1900 if (w
->pseudo_window_p
)
1907 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1909 *area
= LEFT_MARGIN_AREA
;
1910 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1912 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1915 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1919 *area
= RIGHT_MARGIN_AREA
;
1920 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1924 /* Find glyph containing X. */
1925 glyph
= row
->glyphs
[*area
];
1926 end
= glyph
+ row
->used
[*area
];
1928 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1930 x
-= glyph
->pixel_width
;
1940 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1943 *hpos
= glyph
- row
->glyphs
[*area
];
1947 /* Convert frame-relative x/y to coordinates relative to window W.
1948 Takes pseudo-windows into account. */
1951 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1953 if (w
->pseudo_window_p
)
1955 /* A pseudo-window is always full-width, and starts at the
1956 left edge of the frame, plus a frame border. */
1957 struct frame
*f
= XFRAME (w
->frame
);
1958 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1959 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1963 *x
-= WINDOW_LEFT_EDGE_X (w
);
1964 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1968 #ifdef HAVE_WINDOW_SYSTEM
1971 Return in RECTS[] at most N clipping rectangles for glyph string S.
1972 Return the number of stored rectangles. */
1975 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1982 if (s
->row
->full_width_p
)
1984 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1985 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1986 if (s
->row
->mode_line_p
)
1987 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
1989 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
1991 /* Unless displaying a mode or menu bar line, which are always
1992 fully visible, clip to the visible part of the row. */
1993 if (s
->w
->pseudo_window_p
)
1994 r
.height
= s
->row
->visible_height
;
1996 r
.height
= s
->height
;
2000 /* This is a text line that may be partially visible. */
2001 r
.x
= window_box_left (s
->w
, s
->area
);
2002 r
.width
= window_box_width (s
->w
, s
->area
);
2003 r
.height
= s
->row
->visible_height
;
2007 if (r
.x
< s
->clip_head
->x
)
2009 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2010 r
.width
-= s
->clip_head
->x
- r
.x
;
2013 r
.x
= s
->clip_head
->x
;
2016 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2018 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2019 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2024 /* If S draws overlapping rows, it's sufficient to use the top and
2025 bottom of the window for clipping because this glyph string
2026 intentionally draws over other lines. */
2027 if (s
->for_overlaps
)
2029 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2030 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2032 /* Alas, the above simple strategy does not work for the
2033 environments with anti-aliased text: if the same text is
2034 drawn onto the same place multiple times, it gets thicker.
2035 If the overlap we are processing is for the erased cursor, we
2036 take the intersection with the rectangle of the cursor. */
2037 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2039 XRectangle rc
, r_save
= r
;
2041 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2042 rc
.y
= s
->w
->phys_cursor
.y
;
2043 rc
.width
= s
->w
->phys_cursor_width
;
2044 rc
.height
= s
->w
->phys_cursor_height
;
2046 x_intersect_rectangles (&r_save
, &rc
, &r
);
2051 /* Don't use S->y for clipping because it doesn't take partially
2052 visible lines into account. For example, it can be negative for
2053 partially visible lines at the top of a window. */
2054 if (!s
->row
->full_width_p
2055 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2056 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2058 r
.y
= max (0, s
->row
->y
);
2061 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2063 /* If drawing the cursor, don't let glyph draw outside its
2064 advertised boundaries. Cleartype does this under some circumstances. */
2065 if (s
->hl
== DRAW_CURSOR
)
2067 struct glyph
*glyph
= s
->first_glyph
;
2072 if (r
.width
>= s
->x
- r
.x
)
2073 r
.width
-= s
->x
- r
.x
;
2074 else /* R2L hscrolled row with cursor outside text area */
2078 r
.width
= min (r
.width
, glyph
->pixel_width
);
2080 /* If r.y is below window bottom, ensure that we still see a cursor. */
2081 height
= min (glyph
->ascent
+ glyph
->descent
,
2082 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2083 max_y
= window_text_bottom_y (s
->w
) - height
;
2084 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2085 if (s
->ybase
- glyph
->ascent
> max_y
)
2092 /* Don't draw cursor glyph taller than our actual glyph. */
2093 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2094 if (height
< r
.height
)
2096 max_y
= r
.y
+ r
.height
;
2097 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2098 r
.height
= min (max_y
- r
.y
, height
);
2105 XRectangle r_save
= r
;
2107 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2111 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2112 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2114 #ifdef CONVERT_FROM_XRECT
2115 CONVERT_FROM_XRECT (r
, *rects
);
2123 /* If we are processing overlapping and allowed to return
2124 multiple clipping rectangles, we exclude the row of the glyph
2125 string from the clipping rectangle. This is to avoid drawing
2126 the same text on the environment with anti-aliasing. */
2127 #ifdef CONVERT_FROM_XRECT
2130 XRectangle
*rs
= rects
;
2132 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2134 if (s
->for_overlaps
& OVERLAPS_PRED
)
2137 if (r
.y
+ r
.height
> row_y
)
2140 rs
[i
].height
= row_y
- r
.y
;
2146 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2149 if (r
.y
< row_y
+ s
->row
->visible_height
)
2151 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2153 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2154 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2163 #ifdef CONVERT_FROM_XRECT
2164 for (i
= 0; i
< n
; i
++)
2165 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2172 Return in *NR the clipping rectangle for glyph string S. */
2175 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2177 get_glyph_string_clip_rects (s
, nr
, 1);
2182 Return the position and height of the phys cursor in window W.
2183 Set w->phys_cursor_width to width of phys cursor.
2187 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2188 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2190 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2191 int x
, y
, wd
, h
, h0
, y0
, ascent
;
2193 /* Compute the width of the rectangle to draw. If on a stretch
2194 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2195 rectangle as wide as the glyph, but use a canonical character
2197 wd
= glyph
->pixel_width
;
2199 x
= w
->phys_cursor
.x
;
2206 if (glyph
->type
== STRETCH_GLYPH
2207 && !x_stretch_cursor_p
)
2208 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2209 w
->phys_cursor_width
= wd
;
2211 /* Don't let the hollow cursor glyph descend below the glyph row's
2212 ascent value, lest the hollow cursor looks funny. */
2213 y
= w
->phys_cursor
.y
;
2214 ascent
= row
->ascent
;
2215 if (row
->ascent
< glyph
->ascent
)
2217 y
=- glyph
->ascent
- row
->ascent
;
2218 ascent
= glyph
->ascent
;
2221 /* If y is below window bottom, ensure that we still see a cursor. */
2222 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2224 h
= max (h0
, ascent
+ glyph
->descent
);
2225 h0
= min (h0
, ascent
+ glyph
->descent
);
2227 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2230 h
= max (h
- (y0
- y
) + 1, h0
);
2235 y0
= window_text_bottom_y (w
) - h0
;
2243 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2244 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2249 * Remember which glyph the mouse is over.
2253 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2257 struct glyph_row
*r
, *gr
, *end_row
;
2258 enum window_part part
;
2259 enum glyph_row_area area
;
2260 int x
, y
, width
, height
;
2262 /* Try to determine frame pixel position and size of the glyph under
2263 frame pixel coordinates X/Y on frame F. */
2265 if (window_resize_pixelwise
)
2270 else if (!f
->glyphs_initialized_p
2271 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, false),
2274 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2275 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2279 w
= XWINDOW (window
);
2280 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2281 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2283 x
= window_relative_x_coord (w
, part
, gx
);
2284 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2286 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2287 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2289 if (w
->pseudo_window_p
)
2292 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2298 case ON_LEFT_MARGIN
:
2299 area
= LEFT_MARGIN_AREA
;
2302 case ON_RIGHT_MARGIN
:
2303 area
= RIGHT_MARGIN_AREA
;
2306 case ON_HEADER_LINE
:
2308 gr
= (part
== ON_HEADER_LINE
2309 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2310 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2313 goto text_glyph_row_found
;
2320 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2321 if (r
->y
+ r
->height
> y
)
2327 text_glyph_row_found
:
2330 struct glyph
*g
= gr
->glyphs
[area
];
2331 struct glyph
*end
= g
+ gr
->used
[area
];
2333 height
= gr
->height
;
2334 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2335 if (gx
+ g
->pixel_width
> x
)
2340 if (g
->type
== IMAGE_GLYPH
)
2342 /* Don't remember when mouse is over image, as
2343 image may have hot-spots. */
2344 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2347 width
= g
->pixel_width
;
2351 /* Use nominal char spacing at end of line. */
2353 gx
+= (x
/ width
) * width
;
2356 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2358 gx
+= window_box_left_offset (w
, area
);
2359 /* Don't expand over the modeline to make sure the vertical
2360 drag cursor is shown early enough. */
2361 height
= min (height
,
2362 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2367 /* Use nominal line height at end of window. */
2368 gx
= (x
/ width
) * width
;
2370 gy
+= (y
/ height
) * height
;
2371 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2372 /* See comment above. */
2373 height
= min (height
,
2374 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2378 case ON_LEFT_FRINGE
:
2379 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2380 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2381 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2382 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2385 case ON_RIGHT_FRINGE
:
2386 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2387 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2388 : window_box_right_offset (w
, TEXT_AREA
));
2389 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2390 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2391 && !WINDOW_RIGHTMOST_P (w
))
2392 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2393 /* Make sure the vertical border can get her own glyph to the
2394 right of the one we build here. */
2395 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2397 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2399 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2403 case ON_VERTICAL_BORDER
:
2404 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2407 case ON_VERTICAL_SCROLL_BAR
:
2408 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2410 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2411 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2412 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2414 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2418 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2419 if (r
->y
+ r
->height
> y
)
2426 height
= gr
->height
;
2429 /* Use nominal line height at end of window. */
2431 gy
+= (y
/ height
) * height
;
2435 case ON_RIGHT_DIVIDER
:
2436 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2437 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2439 /* The bottom divider prevails. */
2440 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2443 case ON_BOTTOM_DIVIDER
:
2445 width
= WINDOW_PIXEL_WIDTH (w
);
2446 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2447 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2453 /* If there is no glyph under the mouse, then we divide the screen
2454 into a grid of the smallest glyph in the frame, and use that
2457 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2458 round down even for negative values. */
2464 gx
= (gx
/ width
) * width
;
2465 gy
= (gy
/ height
) * height
;
2471 gx
+= WINDOW_LEFT_EDGE_X (w
);
2472 gy
+= WINDOW_TOP_EDGE_Y (w
);
2475 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2477 /* Visible feedback for debugging. */
2478 #if false && defined HAVE_X_WINDOWS
2479 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2480 f
->output_data
.x
->normal_gc
,
2481 gx
, gy
, width
, height
);
2486 #endif /* HAVE_WINDOW_SYSTEM */
2489 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2492 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2493 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2495 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2498 /***********************************************************************
2499 Lisp form evaluation
2500 ***********************************************************************/
2502 /* Error handler for safe_eval and safe_call. */
2505 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2507 add_to_log ("Error during redisplay: %S signaled %S",
2508 Flist (nargs
, args
), arg
);
2512 /* Call function FUNC with the rest of NARGS - 1 arguments
2513 following. Return the result, or nil if something went
2514 wrong. Prevent redisplay during the evaluation. */
2517 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2521 if (inhibit_eval_during_redisplay
)
2526 ptrdiff_t count
= SPECPDL_INDEX ();
2529 SAFE_ALLOCA_LISP (args
, nargs
);
2532 for (i
= 1; i
< nargs
; i
++)
2533 args
[i
] = va_arg (ap
, Lisp_Object
);
2535 specbind (Qinhibit_redisplay
, Qt
);
2537 specbind (Qinhibit_quit
, Qt
);
2538 /* Use Qt to ensure debugger does not run,
2539 so there is no possibility of wanting to redisplay. */
2540 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2543 val
= unbind_to (count
, val
);
2550 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2555 va_start (ap
, func
);
2556 retval
= safe__call (false, nargs
, func
, ap
);
2561 /* Call function FN with one argument ARG.
2562 Return the result, or nil if something went wrong. */
2565 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2567 return safe_call (2, fn
, arg
);
2571 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2577 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2583 safe_eval (Lisp_Object sexpr
)
2585 return safe__call1 (false, Qeval
, sexpr
);
2589 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2591 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2594 /* Call function FN with two arguments ARG1 and ARG2.
2595 Return the result, or nil if something went wrong. */
2598 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2600 return safe_call (3, fn
, arg1
, arg2
);
2605 /***********************************************************************
2607 ***********************************************************************/
2609 /* Define CHECK_IT to perform sanity checks on iterators.
2610 This is for debugging. It is too slow to do unconditionally. */
2613 CHECK_IT (struct it
*it
)
2616 if (it
->method
== GET_FROM_STRING
)
2618 eassert (STRINGP (it
->string
));
2619 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2623 eassert (IT_STRING_CHARPOS (*it
) < 0);
2624 if (it
->method
== GET_FROM_BUFFER
)
2626 /* Check that character and byte positions agree. */
2627 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2632 eassert (it
->current
.dpvec_index
>= 0);
2634 eassert (it
->current
.dpvec_index
< 0);
2639 /* Check that the window end of window W is what we expect it
2640 to be---the last row in the current matrix displaying text. */
2643 CHECK_WINDOW_END (struct window
*w
)
2645 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2646 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2648 struct glyph_row
*row
;
2649 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2651 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2652 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2657 /***********************************************************************
2658 Iterator initialization
2659 ***********************************************************************/
2661 /* Initialize IT for displaying current_buffer in window W, starting
2662 at character position CHARPOS. CHARPOS < 0 means that no buffer
2663 position is specified which is useful when the iterator is assigned
2664 a position later. BYTEPOS is the byte position corresponding to
2667 If ROW is not null, calls to produce_glyphs with IT as parameter
2668 will produce glyphs in that row.
2670 BASE_FACE_ID is the id of a base face to use. It must be one of
2671 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2672 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2673 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2675 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2676 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2677 will be initialized to use the corresponding mode line glyph row of
2678 the desired matrix of W. */
2681 init_iterator (struct it
*it
, struct window
*w
,
2682 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2683 struct glyph_row
*row
, enum face_id base_face_id
)
2685 enum face_id remapped_base_face_id
= base_face_id
;
2687 /* Some precondition checks. */
2688 eassert (w
!= NULL
&& it
!= NULL
);
2689 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2692 /* If face attributes have been changed since the last redisplay,
2693 free realized faces now because they depend on face definitions
2694 that might have changed. Don't free faces while there might be
2695 desired matrices pending which reference these faces. */
2696 if (!inhibit_free_realized_faces
)
2700 face_change
= false;
2701 free_all_realized_faces (Qnil
);
2703 else if (XFRAME (w
->frame
)->face_change
)
2705 XFRAME (w
->frame
)->face_change
= 0;
2706 free_all_realized_faces (w
->frame
);
2710 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2711 if (! NILP (Vface_remapping_alist
))
2712 remapped_base_face_id
2713 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2715 /* Use one of the mode line rows of W's desired matrix if
2719 if (base_face_id
== MODE_LINE_FACE_ID
2720 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2721 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2722 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2723 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2726 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2727 Other parts of redisplay rely on that. */
2728 memclear (it
, sizeof *it
);
2729 it
->current
.overlay_string_index
= -1;
2730 it
->current
.dpvec_index
= -1;
2731 it
->base_face_id
= remapped_base_face_id
;
2732 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2733 it
->paragraph_embedding
= L2R
;
2736 /* The window in which we iterate over current_buffer: */
2737 XSETWINDOW (it
->window
, w
);
2739 it
->f
= XFRAME (w
->frame
);
2743 /* Extra space between lines (on window systems only). */
2744 if (base_face_id
== DEFAULT_FACE_ID
2745 && FRAME_WINDOW_P (it
->f
))
2747 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2748 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2749 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2750 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2751 * FRAME_LINE_HEIGHT (it
->f
));
2752 else if (it
->f
->extra_line_spacing
> 0)
2753 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2756 /* If realized faces have been removed, e.g. because of face
2757 attribute changes of named faces, recompute them. When running
2758 in batch mode, the face cache of the initial frame is null. If
2759 we happen to get called, make a dummy face cache. */
2760 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2761 init_frame_faces (it
->f
);
2762 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2763 recompute_basic_faces (it
->f
);
2765 it
->override_ascent
= -1;
2767 /* Are control characters displayed as `^C'? */
2768 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2770 /* -1 means everything between a CR and the following line end
2771 is invisible. >0 means lines indented more than this value are
2773 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2775 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2777 : (!NILP (BVAR (current_buffer
, selective_display
))
2779 it
->selective_display_ellipsis_p
2780 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2782 /* Display table to use. */
2783 it
->dp
= window_display_table (w
);
2785 /* Are multibyte characters enabled in current_buffer? */
2786 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2788 /* Get the position at which the redisplay_end_trigger hook should
2789 be run, if it is to be run at all. */
2790 if (MARKERP (w
->redisplay_end_trigger
)
2791 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2792 it
->redisplay_end_trigger_charpos
2793 = marker_position (w
->redisplay_end_trigger
);
2794 else if (INTEGERP (w
->redisplay_end_trigger
))
2795 it
->redisplay_end_trigger_charpos
2796 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2799 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2801 /* Are lines in the display truncated? */
2803 it
->line_wrap
= TRUNCATE
;
2804 if (base_face_id
== DEFAULT_FACE_ID
2806 && (WINDOW_FULL_WIDTH_P (it
->w
)
2807 || NILP (Vtruncate_partial_width_windows
)
2808 || (INTEGERP (Vtruncate_partial_width_windows
)
2809 /* PXW: Shall we do something about this? */
2810 && (XINT (Vtruncate_partial_width_windows
)
2811 <= WINDOW_TOTAL_COLS (it
->w
))))
2812 && NILP (BVAR (current_buffer
, truncate_lines
)))
2813 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2814 ? WINDOW_WRAP
: WORD_WRAP
;
2816 /* Get dimensions of truncation and continuation glyphs. These are
2817 displayed as fringe bitmaps under X, but we need them for such
2818 frames when the fringes are turned off. But leave the dimensions
2819 zero for tooltip frames, as these glyphs look ugly there and also
2820 sabotage calculations of tooltip dimensions in x-show-tip. */
2821 #ifdef HAVE_WINDOW_SYSTEM
2822 if (!(FRAME_WINDOW_P (it
->f
)
2823 && FRAMEP (tip_frame
)
2824 && it
->f
== XFRAME (tip_frame
)))
2827 if (it
->line_wrap
== TRUNCATE
)
2829 /* We will need the truncation glyph. */
2830 eassert (it
->glyph_row
== NULL
);
2831 produce_special_glyphs (it
, IT_TRUNCATION
);
2832 it
->truncation_pixel_width
= it
->pixel_width
;
2836 /* We will need the continuation glyph. */
2837 eassert (it
->glyph_row
== NULL
);
2838 produce_special_glyphs (it
, IT_CONTINUATION
);
2839 it
->continuation_pixel_width
= it
->pixel_width
;
2843 /* Reset these values to zero because the produce_special_glyphs
2844 above has changed them. */
2845 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2846 it
->phys_ascent
= it
->phys_descent
= 0;
2848 /* Set this after getting the dimensions of truncation and
2849 continuation glyphs, so that we don't produce glyphs when calling
2850 produce_special_glyphs, above. */
2851 it
->glyph_row
= row
;
2852 it
->area
= TEXT_AREA
;
2854 /* Get the dimensions of the display area. The display area
2855 consists of the visible window area plus a horizontally scrolled
2856 part to the left of the window. All x-values are relative to the
2857 start of this total display area. */
2858 if (base_face_id
!= DEFAULT_FACE_ID
)
2860 /* Mode lines, menu bar in terminal frames. */
2861 it
->first_visible_x
= 0;
2862 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2867 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2868 it
->last_visible_x
= (it
->first_visible_x
2869 + window_box_width (w
, TEXT_AREA
));
2871 /* If we truncate lines, leave room for the truncation glyph(s) at
2872 the right margin. Otherwise, leave room for the continuation
2873 glyph(s). Done only if the window has no right fringe. */
2874 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2876 if (it
->line_wrap
== TRUNCATE
)
2877 it
->last_visible_x
-= it
->truncation_pixel_width
;
2879 it
->last_visible_x
-= it
->continuation_pixel_width
;
2882 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2883 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2886 /* Leave room for a border glyph. */
2887 if (!FRAME_WINDOW_P (it
->f
)
2888 && !WINDOW_RIGHTMOST_P (it
->w
))
2889 it
->last_visible_x
-= 1;
2891 it
->last_visible_y
= window_text_bottom_y (w
);
2893 /* For mode lines and alike, arrange for the first glyph having a
2894 left box line if the face specifies a box. */
2895 if (base_face_id
!= DEFAULT_FACE_ID
)
2899 it
->face_id
= remapped_base_face_id
;
2901 /* If we have a boxed mode line, make the first character appear
2902 with a left box line. */
2903 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2904 if (face
&& face
->box
!= FACE_NO_BOX
)
2905 it
->start_of_box_run_p
= true;
2908 /* If a buffer position was specified, set the iterator there,
2909 getting overlays and face properties from that position. */
2910 if (charpos
>= BUF_BEG (current_buffer
))
2912 it
->stop_charpos
= charpos
;
2913 it
->end_charpos
= ZV
;
2914 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2915 IT_CHARPOS (*it
) = charpos
;
2916 IT_BYTEPOS (*it
) = bytepos
;
2918 /* We will rely on `reseat' to set this up properly, via
2919 handle_face_prop. */
2920 it
->face_id
= it
->base_face_id
;
2922 it
->start
= it
->current
;
2923 /* Do we need to reorder bidirectional text? Not if this is a
2924 unibyte buffer: by definition, none of the single-byte
2925 characters are strong R2L, so no reordering is needed. And
2926 bidi.c doesn't support unibyte buffers anyway. Also, don't
2927 reorder while we are loading loadup.el, since the tables of
2928 character properties needed for reordering are not yet
2932 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2935 /* If we are to reorder bidirectional text, init the bidi
2939 /* Since we don't know at this point whether there will be
2940 any R2L lines in the window, we reserve space for
2941 truncation/continuation glyphs even if only the left
2942 fringe is absent. */
2943 if (base_face_id
== DEFAULT_FACE_ID
2944 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
2945 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
2947 if (it
->line_wrap
== TRUNCATE
)
2948 it
->last_visible_x
-= it
->truncation_pixel_width
;
2950 it
->last_visible_x
-= it
->continuation_pixel_width
;
2952 /* Note the paragraph direction that this buffer wants to
2954 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2956 it
->paragraph_embedding
= L2R
;
2957 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2959 it
->paragraph_embedding
= R2L
;
2961 it
->paragraph_embedding
= NEUTRAL_DIR
;
2962 bidi_unshelve_cache (NULL
, false);
2963 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2967 /* Compute faces etc. */
2968 reseat (it
, it
->current
.pos
, true);
2975 /* Initialize IT for the display of window W with window start POS. */
2978 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2980 struct glyph_row
*row
;
2981 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
2983 row
= w
->desired_matrix
->rows
+ first_vpos
;
2984 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2985 it
->first_vpos
= first_vpos
;
2987 /* Don't reseat to previous visible line start if current start
2988 position is in a string or image. */
2989 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2991 int first_y
= it
->current_y
;
2993 /* If window start is not at a line start, skip forward to POS to
2994 get the correct continuation lines width. */
2995 bool start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2996 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2997 if (!start_at_line_beg_p
)
3001 reseat_at_previous_visible_line_start (it
);
3002 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3004 new_x
= it
->current_x
+ it
->pixel_width
;
3006 /* If lines are continued, this line may end in the middle
3007 of a multi-glyph character (e.g. a control character
3008 displayed as \003, or in the middle of an overlay
3009 string). In this case move_it_to above will not have
3010 taken us to the start of the continuation line but to the
3011 end of the continued line. */
3012 if (it
->current_x
> 0
3013 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3014 && (/* And glyph doesn't fit on the line. */
3015 new_x
> it
->last_visible_x
3016 /* Or it fits exactly and we're on a window
3018 || (new_x
== it
->last_visible_x
3019 && FRAME_WINDOW_P (it
->f
)
3020 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3021 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3022 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3024 if ((it
->current
.dpvec_index
>= 0
3025 || it
->current
.overlay_string_index
>= 0)
3026 /* If we are on a newline from a display vector or
3027 overlay string, then we are already at the end of
3028 a screen line; no need to go to the next line in
3029 that case, as this line is not really continued.
3030 (If we do go to the next line, C-e will not DTRT.) */
3033 set_iterator_to_next (it
, true);
3034 move_it_in_display_line_to (it
, -1, -1, 0);
3037 it
->continuation_lines_width
+= it
->current_x
;
3039 /* If the character at POS is displayed via a display
3040 vector, move_it_to above stops at the final glyph of
3041 IT->dpvec. To make the caller redisplay that character
3042 again (a.k.a. start at POS), we need to reset the
3043 dpvec_index to the beginning of IT->dpvec. */
3044 else if (it
->current
.dpvec_index
>= 0)
3045 it
->current
.dpvec_index
= 0;
3047 /* We're starting a new display line, not affected by the
3048 height of the continued line, so clear the appropriate
3049 fields in the iterator structure. */
3050 it
->max_ascent
= it
->max_descent
= 0;
3051 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3053 it
->current_y
= first_y
;
3055 it
->current_x
= it
->hpos
= 0;
3061 /* Return true if POS is a position in ellipses displayed for invisible
3062 text. W is the window we display, for text property lookup. */
3065 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3067 Lisp_Object prop
, window
;
3068 bool ellipses_p
= false;
3069 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3071 /* If POS specifies a position in a display vector, this might
3072 be for an ellipsis displayed for invisible text. We won't
3073 get the iterator set up for delivering that ellipsis unless
3074 we make sure that it gets aware of the invisible text. */
3075 if (pos
->dpvec_index
>= 0
3076 && pos
->overlay_string_index
< 0
3077 && CHARPOS (pos
->string_pos
) < 0
3079 && (XSETWINDOW (window
, w
),
3080 prop
= Fget_char_property (make_number (charpos
),
3081 Qinvisible
, window
),
3082 TEXT_PROP_MEANS_INVISIBLE (prop
) == 0))
3084 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3086 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3093 /* Initialize IT for stepping through current_buffer in window W,
3094 starting at position POS that includes overlay string and display
3095 vector/ control character translation position information. Value
3096 is false if there are overlay strings with newlines at POS. */
3099 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3101 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3103 bool overlay_strings_with_newlines
= false;
3105 /* If POS specifies a position in a display vector, this might
3106 be for an ellipsis displayed for invisible text. We won't
3107 get the iterator set up for delivering that ellipsis unless
3108 we make sure that it gets aware of the invisible text. */
3109 if (in_ellipses_for_invisible_text_p (pos
, w
))
3115 /* Keep in mind: the call to reseat in init_iterator skips invisible
3116 text, so we might end up at a position different from POS. This
3117 is only a problem when POS is a row start after a newline and an
3118 overlay starts there with an after-string, and the overlay has an
3119 invisible property. Since we don't skip invisible text in
3120 display_line and elsewhere immediately after consuming the
3121 newline before the row start, such a POS will not be in a string,
3122 but the call to init_iterator below will move us to the
3124 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3126 /* This only scans the current chunk -- it should scan all chunks.
3127 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3128 to 16 in 22.1 to make this a lesser problem. */
3129 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3131 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3132 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3134 while (s
< e
&& *s
!= '\n')
3139 overlay_strings_with_newlines
= true;
3144 /* If position is within an overlay string, set up IT to the right
3146 if (pos
->overlay_string_index
>= 0)
3150 /* If the first overlay string happens to have a `display'
3151 property for an image, the iterator will be set up for that
3152 image, and we have to undo that setup first before we can
3153 correct the overlay string index. */
3154 if (it
->method
== GET_FROM_IMAGE
)
3157 /* We already have the first chunk of overlay strings in
3158 IT->overlay_strings. Load more until the one for
3159 pos->overlay_string_index is in IT->overlay_strings. */
3160 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3162 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3163 it
->current
.overlay_string_index
= 0;
3166 load_overlay_strings (it
, 0);
3167 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3171 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3172 relative_index
= (it
->current
.overlay_string_index
3173 % OVERLAY_STRING_CHUNK_SIZE
);
3174 it
->string
= it
->overlay_strings
[relative_index
];
3175 eassert (STRINGP (it
->string
));
3176 it
->current
.string_pos
= pos
->string_pos
;
3177 it
->method
= GET_FROM_STRING
;
3178 it
->end_charpos
= SCHARS (it
->string
);
3179 /* Set up the bidi iterator for this overlay string. */
3182 it
->bidi_it
.string
.lstring
= it
->string
;
3183 it
->bidi_it
.string
.s
= NULL
;
3184 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3185 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3186 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3187 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3188 it
->bidi_it
.w
= it
->w
;
3189 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3190 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3192 /* Synchronize the state of the bidi iterator with
3193 pos->string_pos. For any string position other than
3194 zero, this will be done automagically when we resume
3195 iteration over the string and get_visually_first_element
3196 is called. But if string_pos is zero, and the string is
3197 to be reordered for display, we need to resync manually,
3198 since it could be that the iteration state recorded in
3199 pos ended at string_pos of 0 moving backwards in string. */
3200 if (CHARPOS (pos
->string_pos
) == 0)
3202 get_visually_first_element (it
);
3203 if (IT_STRING_CHARPOS (*it
) != 0)
3206 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3207 bidi_move_to_visually_next (&it
->bidi_it
);
3208 } while (it
->bidi_it
.charpos
!= 0);
3210 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3211 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3215 if (CHARPOS (pos
->string_pos
) >= 0)
3217 /* Recorded position is not in an overlay string, but in another
3218 string. This can only be a string from a `display' property.
3219 IT should already be filled with that string. */
3220 it
->current
.string_pos
= pos
->string_pos
;
3221 eassert (STRINGP (it
->string
));
3223 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3224 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3227 /* Restore position in display vector translations, control
3228 character translations or ellipses. */
3229 if (pos
->dpvec_index
>= 0)
3231 if (it
->dpvec
== NULL
)
3232 get_next_display_element (it
);
3233 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3234 it
->current
.dpvec_index
= pos
->dpvec_index
;
3238 return !overlay_strings_with_newlines
;
3242 /* Initialize IT for stepping through current_buffer in window W
3243 starting at ROW->start. */
3246 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3248 init_from_display_pos (it
, w
, &row
->start
);
3249 it
->start
= row
->start
;
3250 it
->continuation_lines_width
= row
->continuation_lines_width
;
3255 /* Initialize IT for stepping through current_buffer in window W
3256 starting in the line following ROW, i.e. starting at ROW->end.
3257 Value is false if there are overlay strings with newlines at ROW's
3261 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3263 bool success
= false;
3265 if (init_from_display_pos (it
, w
, &row
->end
))
3267 if (row
->continued_p
)
3268 it
->continuation_lines_width
3269 = row
->continuation_lines_width
+ row
->pixel_width
;
3280 /***********************************************************************
3282 ***********************************************************************/
3284 /* Called when IT reaches IT->stop_charpos. Handle text property and
3285 overlay changes. Set IT->stop_charpos to the next position where
3289 handle_stop (struct it
*it
)
3291 enum prop_handled handled
;
3292 bool handle_overlay_change_p
;
3296 it
->current
.dpvec_index
= -1;
3297 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3298 it
->ellipsis_p
= false;
3300 /* Use face of preceding text for ellipsis (if invisible) */
3301 if (it
->selective_display_ellipsis_p
)
3302 it
->saved_face_id
= it
->face_id
;
3304 /* Here's the description of the semantics of, and the logic behind,
3305 the various HANDLED_* statuses:
3307 HANDLED_NORMALLY means the handler did its job, and the loop
3308 should proceed to calling the next handler in order.
3310 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3311 change in the properties and overlays at current position, so the
3312 loop should be restarted, to re-invoke the handlers that were
3313 already called. This happens when fontification-functions were
3314 called by handle_fontified_prop, and actually fontified
3315 something. Another case where HANDLED_RECOMPUTE_PROPS is
3316 returned is when we discover overlay strings that need to be
3317 displayed right away. The loop below will continue for as long
3318 as the status is HANDLED_RECOMPUTE_PROPS.
3320 HANDLED_RETURN means return immediately to the caller, to
3321 continue iteration without calling any further handlers. This is
3322 used when we need to act on some property right away, for example
3323 when we need to display the ellipsis or a replacing display
3324 property, such as display string or image.
3326 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3327 consumed, and the handler switched to the next overlay string.
3328 This signals the loop below to refrain from looking for more
3329 overlays before all the overlay strings of the current overlay
3332 Some of the handlers called by the loop push the iterator state
3333 onto the stack (see 'push_it'), and arrange for the iteration to
3334 continue with another object, such as an image, a display string,
3335 or an overlay string. In most such cases, it->stop_charpos is
3336 set to the first character of the string, so that when the
3337 iteration resumes, this function will immediately be called
3338 again, to examine the properties at the beginning of the string.
3340 When a display or overlay string is exhausted, the iterator state
3341 is popped (see 'pop_it'), and iteration continues with the
3342 previous object. Again, in many such cases this function is
3343 called again to find the next position where properties might
3348 handled
= HANDLED_NORMALLY
;
3350 /* Call text property handlers. */
3351 for (p
= it_props
; p
->handler
; ++p
)
3353 handled
= p
->handler (it
);
3355 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3357 else if (handled
== HANDLED_RETURN
)
3359 /* We still want to show before and after strings from
3360 overlays even if the actual buffer text is replaced. */
3361 if (!handle_overlay_change_p
3363 /* Don't call get_overlay_strings_1 if we already
3364 have overlay strings loaded, because doing so
3365 will load them again and push the iterator state
3366 onto the stack one more time, which is not
3367 expected by the rest of the code that processes
3369 || (it
->current
.overlay_string_index
< 0
3370 && !get_overlay_strings_1 (it
, 0, false)))
3373 setup_for_ellipsis (it
, 0);
3374 /* When handling a display spec, we might load an
3375 empty string. In that case, discard it here. We
3376 used to discard it in handle_single_display_spec,
3377 but that causes get_overlay_strings_1, above, to
3378 ignore overlay strings that we must check. */
3379 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3383 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3387 it
->string_from_display_prop_p
= false;
3388 it
->from_disp_prop_p
= false;
3389 handle_overlay_change_p
= false;
3391 handled
= HANDLED_RECOMPUTE_PROPS
;
3394 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3395 handle_overlay_change_p
= false;
3398 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3400 /* Don't check for overlay strings below when set to deliver
3401 characters from a display vector. */
3402 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3403 handle_overlay_change_p
= false;
3405 /* Handle overlay changes.
3406 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3407 if it finds overlays. */
3408 if (handle_overlay_change_p
)
3409 handled
= handle_overlay_change (it
);
3414 setup_for_ellipsis (it
, 0);
3418 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3420 /* Determine where to stop next. */
3421 if (handled
== HANDLED_NORMALLY
)
3422 compute_stop_pos (it
);
3426 /* Compute IT->stop_charpos from text property and overlay change
3427 information for IT's current position. */
3430 compute_stop_pos (struct it
*it
)
3432 register INTERVAL iv
, next_iv
;
3433 Lisp_Object object
, limit
, position
;
3434 ptrdiff_t charpos
, bytepos
;
3436 if (STRINGP (it
->string
))
3438 /* Strings are usually short, so don't limit the search for
3440 it
->stop_charpos
= it
->end_charpos
;
3441 object
= it
->string
;
3443 charpos
= IT_STRING_CHARPOS (*it
);
3444 bytepos
= IT_STRING_BYTEPOS (*it
);
3450 /* If end_charpos is out of range for some reason, such as a
3451 misbehaving display function, rationalize it (Bug#5984). */
3452 if (it
->end_charpos
> ZV
)
3453 it
->end_charpos
= ZV
;
3454 it
->stop_charpos
= it
->end_charpos
;
3456 /* If next overlay change is in front of the current stop pos
3457 (which is IT->end_charpos), stop there. Note: value of
3458 next_overlay_change is point-max if no overlay change
3460 charpos
= IT_CHARPOS (*it
);
3461 bytepos
= IT_BYTEPOS (*it
);
3462 pos
= next_overlay_change (charpos
);
3463 if (pos
< it
->stop_charpos
)
3464 it
->stop_charpos
= pos
;
3466 /* Set up variables for computing the stop position from text
3467 property changes. */
3468 XSETBUFFER (object
, current_buffer
);
3469 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3472 /* Get the interval containing IT's position. Value is a null
3473 interval if there isn't such an interval. */
3474 position
= make_number (charpos
);
3475 iv
= validate_interval_range (object
, &position
, &position
, false);
3478 Lisp_Object values_here
[LAST_PROP_IDX
];
3481 /* Get properties here. */
3482 for (p
= it_props
; p
->handler
; ++p
)
3483 values_here
[p
->idx
] = textget (iv
->plist
,
3484 builtin_lisp_symbol (p
->name
));
3486 /* Look for an interval following iv that has different
3488 for (next_iv
= next_interval (iv
);
3491 || XFASTINT (limit
) > next_iv
->position
));
3492 next_iv
= next_interval (next_iv
))
3494 for (p
= it_props
; p
->handler
; ++p
)
3496 Lisp_Object new_value
= textget (next_iv
->plist
,
3497 builtin_lisp_symbol (p
->name
));
3498 if (!EQ (values_here
[p
->idx
], new_value
))
3508 if (INTEGERP (limit
)
3509 && next_iv
->position
>= XFASTINT (limit
))
3510 /* No text property change up to limit. */
3511 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3513 /* Text properties change in next_iv. */
3514 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3518 if (it
->cmp_it
.id
< 0)
3520 ptrdiff_t stoppos
= it
->end_charpos
;
3522 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3524 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3525 stoppos
, it
->string
);
3528 eassert (STRINGP (it
->string
)
3529 || (it
->stop_charpos
>= BEGV
3530 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3534 /* Return the position of the next overlay change after POS in
3535 current_buffer. Value is point-max if no overlay change
3536 follows. This is like `next-overlay-change' but doesn't use
3540 next_overlay_change (ptrdiff_t pos
)
3542 ptrdiff_t i
, noverlays
;
3544 Lisp_Object
*overlays
;
3547 /* Get all overlays at the given position. */
3548 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, true);
3550 /* If any of these overlays ends before endpos,
3551 use its ending point instead. */
3552 for (i
= 0; i
< noverlays
; ++i
)
3557 oend
= OVERLAY_END (overlays
[i
]);
3558 oendpos
= OVERLAY_POSITION (oend
);
3559 endpos
= min (endpos
, oendpos
);
3566 /* How many characters forward to search for a display property or
3567 display string. Searching too far forward makes the bidi display
3568 sluggish, especially in small windows. */
3569 #define MAX_DISP_SCAN 250
3571 /* Return the character position of a display string at or after
3572 position specified by POSITION. If no display string exists at or
3573 after POSITION, return ZV. A display string is either an overlay
3574 with `display' property whose value is a string, or a `display'
3575 text property whose value is a string. STRING is data about the
3576 string to iterate; if STRING->lstring is nil, we are iterating a
3577 buffer. FRAME_WINDOW_P is true when we are displaying a window
3578 on a GUI frame. DISP_PROP is set to zero if we searched
3579 MAX_DISP_SCAN characters forward without finding any display
3580 strings, non-zero otherwise. It is set to 2 if the display string
3581 uses any kind of `(space ...)' spec that will produce a stretch of
3582 white space in the text area. */
3584 compute_display_string_pos (struct text_pos
*position
,
3585 struct bidi_string_data
*string
,
3587 bool frame_window_p
, int *disp_prop
)
3589 /* OBJECT = nil means current buffer. */
3590 Lisp_Object object
, object1
;
3591 Lisp_Object pos
, spec
, limpos
;
3592 bool string_p
= string
&& (STRINGP (string
->lstring
) || string
->s
);
3593 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3594 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3595 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3597 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3598 struct text_pos tpos
;
3601 if (string
&& STRINGP (string
->lstring
))
3602 object1
= object
= string
->lstring
;
3603 else if (w
&& !string_p
)
3605 XSETWINDOW (object
, w
);
3609 object1
= object
= Qnil
;
3614 /* We don't support display properties whose values are strings
3615 that have display string properties. */
3616 || string
->from_disp_str
3617 /* C strings cannot have display properties. */
3618 || (string
->s
&& !STRINGP (object
)))
3624 /* If the character at CHARPOS is where the display string begins,
3626 pos
= make_number (charpos
);
3627 if (STRINGP (object
))
3628 bufpos
= string
->bufpos
;
3632 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3634 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3637 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3645 /* Look forward for the first character with a `display' property
3646 that will replace the underlying text when displayed. */
3647 limpos
= make_number (lim
);
3649 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3650 CHARPOS (tpos
) = XFASTINT (pos
);
3651 if (CHARPOS (tpos
) >= lim
)
3656 if (STRINGP (object
))
3657 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3659 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3660 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3661 if (!STRINGP (object
))
3662 bufpos
= CHARPOS (tpos
);
3663 } while (NILP (spec
)
3664 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3665 bufpos
, frame_window_p
)));
3669 return CHARPOS (tpos
);
3672 /* Return the character position of the end of the display string that
3673 started at CHARPOS. If there's no display string at CHARPOS,
3674 return -1. A display string is either an overlay with `display'
3675 property whose value is a string or a `display' text property whose
3676 value is a string. */
3678 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3680 /* OBJECT = nil means current buffer. */
3681 Lisp_Object object
=
3682 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3683 Lisp_Object pos
= make_number (charpos
);
3685 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3687 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3690 /* It could happen that the display property or overlay was removed
3691 since we found it in compute_display_string_pos above. One way
3692 this can happen is if JIT font-lock was called (through
3693 handle_fontified_prop), and jit-lock-functions remove text
3694 properties or overlays from the portion of buffer that includes
3695 CHARPOS. Muse mode is known to do that, for example. In this
3696 case, we return -1 to the caller, to signal that no display
3697 string is actually present at CHARPOS. See bidi_fetch_char for
3698 how this is handled.
3700 An alternative would be to never look for display properties past
3701 it->stop_charpos. But neither compute_display_string_pos nor
3702 bidi_fetch_char that calls it know or care where the next
3704 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3707 /* Look forward for the first character where the `display' property
3709 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3711 return XFASTINT (pos
);
3716 /***********************************************************************
3718 ***********************************************************************/
3720 /* Handle changes in the `fontified' property of the current buffer by
3721 calling hook functions from Qfontification_functions to fontify
3724 static enum prop_handled
3725 handle_fontified_prop (struct it
*it
)
3727 Lisp_Object prop
, pos
;
3728 enum prop_handled handled
= HANDLED_NORMALLY
;
3730 if (!NILP (Vmemory_full
))
3733 /* Get the value of the `fontified' property at IT's current buffer
3734 position. (The `fontified' property doesn't have a special
3735 meaning in strings.) If the value is nil, call functions from
3736 Qfontification_functions. */
3737 if (!STRINGP (it
->string
)
3739 && !NILP (Vfontification_functions
)
3740 && !NILP (Vrun_hooks
)
3741 && (pos
= make_number (IT_CHARPOS (*it
)),
3742 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3743 /* Ignore the special cased nil value always present at EOB since
3744 no amount of fontifying will be able to change it. */
3745 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3747 ptrdiff_t count
= SPECPDL_INDEX ();
3749 struct buffer
*obuf
= current_buffer
;
3750 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3751 bool old_clip_changed
= current_buffer
->clip_changed
;
3753 val
= Vfontification_functions
;
3754 specbind (Qfontification_functions
, Qnil
);
3756 eassert (it
->end_charpos
== ZV
);
3758 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3759 safe_call1 (val
, pos
);
3762 Lisp_Object fns
, fn
;
3766 for (; CONSP (val
); val
= XCDR (val
))
3772 /* A value of t indicates this hook has a local
3773 binding; it means to run the global binding too.
3774 In a global value, t should not occur. If it
3775 does, we must ignore it to avoid an endless
3777 for (fns
= Fdefault_value (Qfontification_functions
);
3783 safe_call1 (fn
, pos
);
3787 safe_call1 (fn
, pos
);
3791 unbind_to (count
, Qnil
);
3793 /* Fontification functions routinely call `save-restriction'.
3794 Normally, this tags clip_changed, which can confuse redisplay
3795 (see discussion in Bug#6671). Since we don't perform any
3796 special handling of fontification changes in the case where
3797 `save-restriction' isn't called, there's no point doing so in
3798 this case either. So, if the buffer's restrictions are
3799 actually left unchanged, reset clip_changed. */
3800 if (obuf
== current_buffer
)
3802 if (begv
== BEGV
&& zv
== ZV
)
3803 current_buffer
->clip_changed
= old_clip_changed
;
3805 /* There isn't much we can reasonably do to protect against
3806 misbehaving fontification, but here's a fig leaf. */
3807 else if (BUFFER_LIVE_P (obuf
))
3808 set_buffer_internal_1 (obuf
);
3810 /* The fontification code may have added/removed text.
3811 It could do even a lot worse, but let's at least protect against
3812 the most obvious case where only the text past `pos' gets changed',
3813 as is/was done in grep.el where some escapes sequences are turned
3814 into face properties (bug#7876). */
3815 it
->end_charpos
= ZV
;
3817 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3818 something. This avoids an endless loop if they failed to
3819 fontify the text for which reason ever. */
3820 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3821 handled
= HANDLED_RECOMPUTE_PROPS
;
3829 /***********************************************************************
3831 ***********************************************************************/
3833 /* Set up iterator IT from face properties at its current position.
3834 Called from handle_stop. */
3836 static enum prop_handled
3837 handle_face_prop (struct it
*it
)
3840 ptrdiff_t next_stop
;
3842 if (!STRINGP (it
->string
))
3845 = face_at_buffer_position (it
->w
,
3849 + TEXT_PROP_DISTANCE_LIMIT
),
3850 false, it
->base_face_id
);
3852 /* Is this a start of a run of characters with box face?
3853 Caveat: this can be called for a freshly initialized
3854 iterator; face_id is -1 in this case. We know that the new
3855 face will not change until limit, i.e. if the new face has a
3856 box, all characters up to limit will have one. But, as
3857 usual, we don't know whether limit is really the end. */
3858 if (new_face_id
!= it
->face_id
)
3860 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3861 /* If it->face_id is -1, old_face below will be NULL, see
3862 the definition of FACE_FROM_ID. This will happen if this
3863 is the initial call that gets the face. */
3864 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3866 /* If the value of face_id of the iterator is -1, we have to
3867 look in front of IT's position and see whether there is a
3868 face there that's different from new_face_id. */
3869 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3871 int prev_face_id
= face_before_it_pos (it
);
3873 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3876 /* If the new face has a box, but the old face does not,
3877 this is the start of a run of characters with box face,
3878 i.e. this character has a shadow on the left side. */
3879 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3880 && (old_face
== NULL
|| !old_face
->box
));
3881 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3889 Lisp_Object from_overlay
3890 = (it
->current
.overlay_string_index
>= 0
3891 ? it
->string_overlays
[it
->current
.overlay_string_index
3892 % OVERLAY_STRING_CHUNK_SIZE
]
3895 /* See if we got to this string directly or indirectly from
3896 an overlay property. That includes the before-string or
3897 after-string of an overlay, strings in display properties
3898 provided by an overlay, their text properties, etc.
3900 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3901 if (! NILP (from_overlay
))
3902 for (i
= it
->sp
- 1; i
>= 0; i
--)
3904 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3906 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3907 % OVERLAY_STRING_CHUNK_SIZE
];
3908 else if (! NILP (it
->stack
[i
].from_overlay
))
3909 from_overlay
= it
->stack
[i
].from_overlay
;
3911 if (!NILP (from_overlay
))
3915 if (! NILP (from_overlay
))
3917 bufpos
= IT_CHARPOS (*it
);
3918 /* For a string from an overlay, the base face depends
3919 only on text properties and ignores overlays. */
3921 = face_for_overlay_string (it
->w
,
3925 + TEXT_PROP_DISTANCE_LIMIT
),
3933 /* For strings from a `display' property, use the face at
3934 IT's current buffer position as the base face to merge
3935 with, so that overlay strings appear in the same face as
3936 surrounding text, unless they specify their own faces.
3937 For strings from wrap-prefix and line-prefix properties,
3938 use the default face, possibly remapped via
3939 Vface_remapping_alist. */
3940 /* Note that the fact that we use the face at _buffer_
3941 position means that a 'display' property on an overlay
3942 string will not inherit the face of that overlay string,
3943 but will instead revert to the face of buffer text
3944 covered by the overlay. This is visible, e.g., when the
3945 overlay specifies a box face, but neither the buffer nor
3946 the display string do. This sounds like a design bug,
3947 but Emacs always did that since v21.1, so changing that
3948 might be a big deal. */
3949 base_face_id
= it
->string_from_prefix_prop_p
3950 ? (!NILP (Vface_remapping_alist
)
3951 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3953 : underlying_face_id (it
);
3956 new_face_id
= face_at_string_position (it
->w
,
3958 IT_STRING_CHARPOS (*it
),
3961 base_face_id
, false);
3963 /* Is this a start of a run of characters with box? Caveat:
3964 this can be called for a freshly allocated iterator; face_id
3965 is -1 is this case. We know that the new face will not
3966 change until the next check pos, i.e. if the new face has a
3967 box, all characters up to that position will have a
3968 box. But, as usual, we don't know whether that position
3969 is really the end. */
3970 if (new_face_id
!= it
->face_id
)
3972 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3973 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3975 /* If new face has a box but old face hasn't, this is the
3976 start of a run of characters with box, i.e. it has a
3977 shadow on the left side. */
3978 it
->start_of_box_run_p
3979 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3980 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3984 it
->face_id
= new_face_id
;
3985 return HANDLED_NORMALLY
;
3989 /* Return the ID of the face ``underlying'' IT's current position,
3990 which is in a string. If the iterator is associated with a
3991 buffer, return the face at IT's current buffer position.
3992 Otherwise, use the iterator's base_face_id. */
3995 underlying_face_id (struct it
*it
)
3997 int face_id
= it
->base_face_id
, i
;
3999 eassert (STRINGP (it
->string
));
4001 for (i
= it
->sp
- 1; i
>= 0; --i
)
4002 if (NILP (it
->stack
[i
].string
))
4003 face_id
= it
->stack
[i
].face_id
;
4009 /* Compute the face one character before or after the current position
4010 of IT, in the visual order. BEFORE_P means get the face
4011 in front (to the left in L2R paragraphs, to the right in R2L
4012 paragraphs) of IT's screen position. Value is the ID of the face. */
4015 face_before_or_after_it_pos (struct it
*it
, bool before_p
)
4018 ptrdiff_t next_check_charpos
;
4020 void *it_copy_data
= NULL
;
4022 eassert (it
->s
== NULL
);
4024 if (STRINGP (it
->string
))
4026 ptrdiff_t bufpos
, charpos
;
4029 /* No face change past the end of the string (for the case
4030 we are padding with spaces). No face change before the
4032 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4033 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4038 /* Set charpos to the position before or after IT's current
4039 position, in the logical order, which in the non-bidi
4040 case is the same as the visual order. */
4042 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4043 else if (it
->what
== IT_COMPOSITION
)
4044 /* For composition, we must check the character after the
4046 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4048 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4054 /* With bidi iteration, the character before the current
4055 in the visual order cannot be found by simple
4056 iteration, because "reverse" reordering is not
4057 supported. Instead, we need to start from the string
4058 beginning and go all the way to the current string
4059 position, remembering the previous position. */
4060 /* Ignore face changes before the first visible
4061 character on this display line. */
4062 if (it
->current_x
<= it
->first_visible_x
)
4064 SAVE_IT (it_copy
, *it
, it_copy_data
);
4065 IT_STRING_CHARPOS (it_copy
) = 0;
4066 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy
.f
), &it_copy
.bidi_it
);
4070 charpos
= IT_STRING_CHARPOS (it_copy
);
4071 if (charpos
>= SCHARS (it
->string
))
4073 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4075 while (IT_STRING_CHARPOS (it_copy
) != IT_STRING_CHARPOS (*it
));
4077 RESTORE_IT (it
, it
, it_copy_data
);
4081 /* Set charpos to the string position of the character
4082 that comes after IT's current position in the visual
4084 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4088 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4090 charpos
= it_copy
.bidi_it
.charpos
;
4093 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4095 if (it
->current
.overlay_string_index
>= 0)
4096 bufpos
= IT_CHARPOS (*it
);
4100 base_face_id
= underlying_face_id (it
);
4102 /* Get the face for ASCII, or unibyte. */
4103 face_id
= face_at_string_position (it
->w
,
4107 &next_check_charpos
,
4108 base_face_id
, false);
4110 /* Correct the face for charsets different from ASCII. Do it
4111 for the multibyte case only. The face returned above is
4112 suitable for unibyte text if IT->string is unibyte. */
4113 if (STRING_MULTIBYTE (it
->string
))
4115 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4116 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4118 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4120 c
= string_char_and_length (p
, &len
);
4121 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4126 struct text_pos pos
;
4128 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4129 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4132 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4133 pos
= it
->current
.pos
;
4138 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4141 if (it
->what
== IT_COMPOSITION
)
4143 /* For composition, we must check the position after
4145 pos
.charpos
+= it
->cmp_it
.nchars
;
4146 pos
.bytepos
+= it
->len
;
4149 INC_TEXT_POS (pos
, it
->multibyte_p
);
4158 /* With bidi iteration, the character before the current
4159 in the visual order cannot be found by simple
4160 iteration, because "reverse" reordering is not
4161 supported. Instead, we need to use the move_it_*
4162 family of functions, and move to the previous
4163 character starting from the beginning of the visual
4165 /* Ignore face changes before the first visible
4166 character on this display line. */
4167 if (it
->current_x
<= it
->first_visible_x
)
4169 SAVE_IT (it_copy
, *it
, it_copy_data
);
4170 /* Implementation note: Since move_it_in_display_line
4171 works in the iterator geometry, and thinks the first
4172 character is always the leftmost, even in R2L lines,
4173 we don't need to distinguish between the R2L and L2R
4175 current_x
= it_copy
.current_x
;
4176 move_it_vertically_backward (&it_copy
, 0);
4177 move_it_in_display_line (&it_copy
, ZV
, current_x
- 1, MOVE_TO_X
);
4178 pos
= it_copy
.current
.pos
;
4179 RESTORE_IT (it
, it
, it_copy_data
);
4183 /* Set charpos to the buffer position of the character
4184 that comes after IT's current position in the visual
4186 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4190 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4193 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4196 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4198 /* Determine face for CHARSET_ASCII, or unibyte. */
4199 face_id
= face_at_buffer_position (it
->w
,
4201 &next_check_charpos
,
4204 /* Correct the face for charsets different from ASCII. Do it
4205 for the multibyte case only. The face returned above is
4206 suitable for unibyte text if current_buffer is unibyte. */
4207 if (it
->multibyte_p
)
4209 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4210 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4211 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4220 /***********************************************************************
4222 ***********************************************************************/
4224 /* Set up iterator IT from invisible properties at its current
4225 position. Called from handle_stop. */
4227 static enum prop_handled
4228 handle_invisible_prop (struct it
*it
)
4230 enum prop_handled handled
= HANDLED_NORMALLY
;
4234 if (STRINGP (it
->string
))
4236 Lisp_Object end_charpos
, limit
;
4238 /* Get the value of the invisible text property at the
4239 current position. Value will be nil if there is no such
4241 end_charpos
= make_number (IT_STRING_CHARPOS (*it
));
4242 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4243 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4245 if (invis
!= 0 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4247 /* Record whether we have to display an ellipsis for the
4249 bool display_ellipsis_p
= (invis
== 2);
4250 ptrdiff_t len
, endpos
;
4252 handled
= HANDLED_RECOMPUTE_PROPS
;
4254 /* Get the position at which the next visible text can be
4255 found in IT->string, if any. */
4256 endpos
= len
= SCHARS (it
->string
);
4257 XSETINT (limit
, len
);
4261 = Fnext_single_property_change (end_charpos
, Qinvisible
,
4263 /* Since LIMIT is always an integer, so should be the
4264 value returned by Fnext_single_property_change. */
4265 eassert (INTEGERP (end_charpos
));
4266 if (INTEGERP (end_charpos
))
4268 endpos
= XFASTINT (end_charpos
);
4269 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4270 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4272 display_ellipsis_p
= true;
4274 else /* Should never happen; but if it does, exit the loop. */
4277 while (invis
!= 0 && endpos
< len
);
4279 if (display_ellipsis_p
)
4280 it
->ellipsis_p
= true;
4284 /* Text at END_CHARPOS is visible. Move IT there. */
4285 struct text_pos old
;
4288 old
= it
->current
.string_pos
;
4289 oldpos
= CHARPOS (old
);
4292 if (it
->bidi_it
.first_elt
4293 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4294 bidi_paragraph_init (it
->paragraph_embedding
,
4295 &it
->bidi_it
, true);
4296 /* Bidi-iterate out of the invisible text. */
4299 bidi_move_to_visually_next (&it
->bidi_it
);
4301 while (oldpos
<= it
->bidi_it
.charpos
4302 && it
->bidi_it
.charpos
< endpos
);
4304 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4305 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4306 if (IT_CHARPOS (*it
) >= endpos
)
4307 it
->prev_stop
= endpos
;
4311 IT_STRING_CHARPOS (*it
) = endpos
;
4312 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4317 /* The rest of the string is invisible. If this is an
4318 overlay string, proceed with the next overlay string
4319 or whatever comes and return a character from there. */
4320 if (it
->current
.overlay_string_index
>= 0
4321 && !display_ellipsis_p
)
4323 next_overlay_string (it
);
4324 /* Don't check for overlay strings when we just
4325 finished processing them. */
4326 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4330 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4331 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4338 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4339 Lisp_Object pos
, overlay
;
4341 /* First of all, is there invisible text at this position? */
4342 tem
= start_charpos
= IT_CHARPOS (*it
);
4343 pos
= make_number (tem
);
4344 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4346 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4348 /* If we are on invisible text, skip over it. */
4349 if (invis
!= 0 && start_charpos
< it
->end_charpos
)
4351 /* Record whether we have to display an ellipsis for the
4353 bool display_ellipsis_p
= invis
== 2;
4355 handled
= HANDLED_RECOMPUTE_PROPS
;
4357 /* Loop skipping over invisible text. The loop is left at
4358 ZV or with IT on the first char being visible again. */
4361 /* Try to skip some invisible text. Return value is the
4362 position reached which can be equal to where we start
4363 if there is nothing invisible there. This skips both
4364 over invisible text properties and overlays with
4365 invisible property. */
4366 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4368 /* If we skipped nothing at all we weren't at invisible
4369 text in the first place. If everything to the end of
4370 the buffer was skipped, end the loop. */
4371 if (newpos
== tem
|| newpos
>= ZV
)
4375 /* We skipped some characters but not necessarily
4376 all there are. Check if we ended up on visible
4377 text. Fget_char_property returns the property of
4378 the char before the given position, i.e. if we
4379 get invis = 0, this means that the char at
4380 newpos is visible. */
4381 pos
= make_number (newpos
);
4382 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4383 invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4386 /* If we ended up on invisible text, proceed to
4387 skip starting with next_stop. */
4391 /* If there are adjacent invisible texts, don't lose the
4392 second one's ellipsis. */
4394 display_ellipsis_p
= true;
4398 /* The position newpos is now either ZV or on visible text. */
4401 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4403 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4405 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4407 /* If the invisible text ends on a newline or on a
4408 character after a newline, we can avoid the costly,
4409 character by character, bidi iteration to NEWPOS, and
4410 instead simply reseat the iterator there. That's
4411 because all bidi reordering information is tossed at
4412 the newline. This is a big win for modes that hide
4413 complete lines, like Outline, Org, etc. */
4414 if (on_newline
|| after_newline
)
4416 struct text_pos tpos
;
4417 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4419 SET_TEXT_POS (tpos
, newpos
, bpos
);
4420 reseat_1 (it
, tpos
, false);
4421 /* If we reseat on a newline/ZV, we need to prep the
4422 bidi iterator for advancing to the next character
4423 after the newline/EOB, keeping the current paragraph
4424 direction (so that PRODUCE_GLYPHS does TRT wrt
4425 prepending/appending glyphs to a glyph row). */
4428 it
->bidi_it
.first_elt
= false;
4429 it
->bidi_it
.paragraph_dir
= pdir
;
4430 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4431 it
->bidi_it
.nchars
= 1;
4432 it
->bidi_it
.ch_len
= 1;
4435 else /* Must use the slow method. */
4437 /* With bidi iteration, the region of invisible text
4438 could start and/or end in the middle of a
4439 non-base embedding level. Therefore, we need to
4440 skip invisible text using the bidi iterator,
4441 starting at IT's current position, until we find
4442 ourselves outside of the invisible text.
4443 Skipping invisible text _after_ bidi iteration
4444 avoids affecting the visual order of the
4445 displayed text when invisible properties are
4446 added or removed. */
4447 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4449 /* If we were `reseat'ed to a new paragraph,
4450 determine the paragraph base direction. We
4451 need to do it now because
4452 next_element_from_buffer may not have a
4453 chance to do it, if we are going to skip any
4454 text at the beginning, which resets the
4456 bidi_paragraph_init (it
->paragraph_embedding
,
4457 &it
->bidi_it
, true);
4461 bidi_move_to_visually_next (&it
->bidi_it
);
4463 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4464 && it
->bidi_it
.charpos
< newpos
);
4465 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4466 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4467 /* If we overstepped NEWPOS, record its position in
4468 the iterator, so that we skip invisible text if
4469 later the bidi iteration lands us in the
4470 invisible region again. */
4471 if (IT_CHARPOS (*it
) >= newpos
)
4472 it
->prev_stop
= newpos
;
4477 IT_CHARPOS (*it
) = newpos
;
4478 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4481 if (display_ellipsis_p
)
4483 /* Make sure that the glyphs of the ellipsis will get
4484 correct `charpos' values. If we would not update
4485 it->position here, the glyphs would belong to the
4486 last visible character _before_ the invisible
4487 text, which confuses `set_cursor_from_row'.
4489 We use the last invisible position instead of the
4490 first because this way the cursor is always drawn on
4491 the first "." of the ellipsis, whenever PT is inside
4492 the invisible text. Otherwise the cursor would be
4493 placed _after_ the ellipsis when the point is after the
4494 first invisible character. */
4495 if (!STRINGP (it
->object
))
4497 it
->position
.charpos
= newpos
- 1;
4498 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4502 /* If there are before-strings at the start of invisible
4503 text, and the text is invisible because of a text
4504 property, arrange to show before-strings because 20.x did
4505 it that way. (If the text is invisible because of an
4506 overlay property instead of a text property, this is
4507 already handled in the overlay code.) */
4509 && get_overlay_strings (it
, it
->stop_charpos
))
4511 handled
= HANDLED_RECOMPUTE_PROPS
;
4514 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4515 /* The call to get_overlay_strings above recomputes
4516 it->stop_charpos, but it only considers changes
4517 in properties and overlays beyond iterator's
4518 current position. This causes us to miss changes
4519 that happen exactly where the invisible property
4520 ended. So we play it safe here and force the
4521 iterator to check for potential stop positions
4522 immediately after the invisible text. Note that
4523 if get_overlay_strings returns true, it
4524 normally also pushed the iterator stack, so we
4525 need to update the stop position in the slot
4526 below the current one. */
4527 it
->stack
[it
->sp
- 1].stop_charpos
4528 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4531 else if (display_ellipsis_p
)
4533 it
->ellipsis_p
= true;
4534 /* Let the ellipsis display before
4535 considering any properties of the following char.
4536 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4537 handled
= HANDLED_RETURN
;
4546 /* Make iterator IT return `...' next.
4547 Replaces LEN characters from buffer. */
4550 setup_for_ellipsis (struct it
*it
, int len
)
4552 /* Use the display table definition for `...'. Invalid glyphs
4553 will be handled by the method returning elements from dpvec. */
4554 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4556 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4557 it
->dpvec
= v
->contents
;
4558 it
->dpend
= v
->contents
+ v
->header
.size
;
4562 /* Default `...'. */
4563 it
->dpvec
= default_invis_vector
;
4564 it
->dpend
= default_invis_vector
+ 3;
4567 it
->dpvec_char_len
= len
;
4568 it
->current
.dpvec_index
= 0;
4569 it
->dpvec_face_id
= -1;
4571 /* Remember the current face id in case glyphs specify faces.
4572 IT's face is restored in set_iterator_to_next.
4573 saved_face_id was set to preceding char's face in handle_stop. */
4574 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4575 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4577 /* If the ellipsis represents buffer text, it means we advanced in
4578 the buffer, so we should no longer ignore overlay strings. */
4579 if (it
->method
== GET_FROM_BUFFER
)
4580 it
->ignore_overlay_strings_at_pos_p
= false;
4582 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4583 it
->ellipsis_p
= true;
4588 /***********************************************************************
4590 ***********************************************************************/
4592 /* Set up iterator IT from `display' property at its current position.
4593 Called from handle_stop.
4594 We return HANDLED_RETURN if some part of the display property
4595 overrides the display of the buffer text itself.
4596 Otherwise we return HANDLED_NORMALLY. */
4598 static enum prop_handled
4599 handle_display_prop (struct it
*it
)
4601 Lisp_Object propval
, object
, overlay
;
4602 struct text_pos
*position
;
4604 /* Nonzero if some property replaces the display of the text itself. */
4605 int display_replaced
= 0;
4607 if (STRINGP (it
->string
))
4609 object
= it
->string
;
4610 position
= &it
->current
.string_pos
;
4611 bufpos
= CHARPOS (it
->current
.pos
);
4615 XSETWINDOW (object
, it
->w
);
4616 position
= &it
->current
.pos
;
4617 bufpos
= CHARPOS (*position
);
4620 /* Reset those iterator values set from display property values. */
4621 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4622 it
->space_width
= Qnil
;
4623 it
->font_height
= Qnil
;
4626 /* We don't support recursive `display' properties, i.e. string
4627 values that have a string `display' property, that have a string
4628 `display' property etc. */
4629 if (!it
->string_from_display_prop_p
)
4630 it
->area
= TEXT_AREA
;
4632 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4633 Qdisplay
, object
, &overlay
);
4635 return HANDLED_NORMALLY
;
4636 /* Now OVERLAY is the overlay that gave us this property, or nil
4637 if it was a text property. */
4639 if (!STRINGP (it
->string
))
4640 object
= it
->w
->contents
;
4642 display_replaced
= handle_display_spec (it
, propval
, object
, overlay
,
4644 FRAME_WINDOW_P (it
->f
));
4645 return display_replaced
!= 0 ? HANDLED_RETURN
: HANDLED_NORMALLY
;
4648 /* Subroutine of handle_display_prop. Returns non-zero if the display
4649 specification in SPEC is a replacing specification, i.e. it would
4650 replace the text covered by `display' property with something else,
4651 such as an image or a display string. If SPEC includes any kind or
4652 `(space ...) specification, the value is 2; this is used by
4653 compute_display_string_pos, which see.
4655 See handle_single_display_spec for documentation of arguments.
4656 FRAME_WINDOW_P is true if the window being redisplayed is on a
4657 GUI frame; this argument is used only if IT is NULL, see below.
4659 IT can be NULL, if this is called by the bidi reordering code
4660 through compute_display_string_pos, which see. In that case, this
4661 function only examines SPEC, but does not otherwise "handle" it, in
4662 the sense that it doesn't set up members of IT from the display
4665 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4666 Lisp_Object overlay
, struct text_pos
*position
,
4667 ptrdiff_t bufpos
, bool frame_window_p
)
4672 /* Simple specifications. */
4673 && !EQ (XCAR (spec
), Qimage
)
4674 && !EQ (XCAR (spec
), Qspace
)
4675 && !EQ (XCAR (spec
), Qwhen
)
4676 && !EQ (XCAR (spec
), Qslice
)
4677 && !EQ (XCAR (spec
), Qspace_width
)
4678 && !EQ (XCAR (spec
), Qheight
)
4679 && !EQ (XCAR (spec
), Qraise
)
4680 /* Marginal area specifications. */
4681 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4682 && !EQ (XCAR (spec
), Qleft_fringe
)
4683 && !EQ (XCAR (spec
), Qright_fringe
)
4684 && !NILP (XCAR (spec
)))
4686 for (; CONSP (spec
); spec
= XCDR (spec
))
4688 int rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4689 overlay
, position
, bufpos
,
4690 replacing
, frame_window_p
);
4694 /* If some text in a string is replaced, `position' no
4695 longer points to the position of `object'. */
4696 if (!it
|| STRINGP (object
))
4701 else if (VECTORP (spec
))
4704 for (i
= 0; i
< ASIZE (spec
); ++i
)
4706 int rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4707 overlay
, position
, bufpos
,
4708 replacing
, frame_window_p
);
4712 /* If some text in a string is replaced, `position' no
4713 longer points to the position of `object'. */
4714 if (!it
|| STRINGP (object
))
4720 replacing
= handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4721 bufpos
, 0, frame_window_p
);
4725 /* Value is the position of the end of the `display' property starting
4726 at START_POS in OBJECT. */
4728 static struct text_pos
4729 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4732 struct text_pos end_pos
;
4734 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4735 Qdisplay
, object
, Qnil
);
4736 CHARPOS (end_pos
) = XFASTINT (end
);
4737 if (STRINGP (object
))
4738 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4740 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4746 /* Set up IT from a single `display' property specification SPEC. OBJECT
4747 is the object in which the `display' property was found. *POSITION
4748 is the position in OBJECT at which the `display' property was found.
4749 BUFPOS is the buffer position of OBJECT (different from POSITION if
4750 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4751 previously saw a display specification which already replaced text
4752 display with something else, for example an image; we ignore such
4753 properties after the first one has been processed.
4755 OVERLAY is the overlay this `display' property came from,
4756 or nil if it was a text property.
4758 If SPEC is a `space' or `image' specification, and in some other
4759 cases too, set *POSITION to the position where the `display'
4762 If IT is NULL, only examine the property specification in SPEC, but
4763 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4764 is intended to be displayed in a window on a GUI frame.
4766 Value is non-zero if something was found which replaces the display
4767 of buffer or string text. */
4770 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4771 Lisp_Object overlay
, struct text_pos
*position
,
4772 ptrdiff_t bufpos
, int display_replaced
,
4773 bool frame_window_p
)
4776 Lisp_Object location
, value
;
4777 struct text_pos start_pos
= *position
;
4779 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4780 If the result is non-nil, use VALUE instead of SPEC. */
4782 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4791 if (!NILP (form
) && !EQ (form
, Qt
))
4793 ptrdiff_t count
= SPECPDL_INDEX ();
4795 /* Bind `object' to the object having the `display' property, a
4796 buffer or string. Bind `position' to the position in the
4797 object where the property was found, and `buffer-position'
4798 to the current position in the buffer. */
4801 XSETBUFFER (object
, current_buffer
);
4802 specbind (Qobject
, object
);
4803 specbind (Qposition
, make_number (CHARPOS (*position
)));
4804 specbind (Qbuffer_position
, make_number (bufpos
));
4805 form
= safe_eval (form
);
4806 unbind_to (count
, Qnil
);
4812 /* Handle `(height HEIGHT)' specifications. */
4814 && EQ (XCAR (spec
), Qheight
)
4815 && CONSP (XCDR (spec
)))
4819 if (!FRAME_WINDOW_P (it
->f
))
4822 it
->font_height
= XCAR (XCDR (spec
));
4823 if (!NILP (it
->font_height
))
4825 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4826 int new_height
= -1;
4828 if (CONSP (it
->font_height
)
4829 && (EQ (XCAR (it
->font_height
), Qplus
)
4830 || EQ (XCAR (it
->font_height
), Qminus
))
4831 && CONSP (XCDR (it
->font_height
))
4832 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4834 /* `(+ N)' or `(- N)' where N is an integer. */
4835 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4836 if (EQ (XCAR (it
->font_height
), Qplus
))
4838 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4840 else if (FUNCTIONP (it
->font_height
))
4842 /* Call function with current height as argument.
4843 Value is the new height. */
4845 height
= safe_call1 (it
->font_height
,
4846 face
->lface
[LFACE_HEIGHT_INDEX
]);
4847 if (NUMBERP (height
))
4848 new_height
= XFLOATINT (height
);
4850 else if (NUMBERP (it
->font_height
))
4852 /* Value is a multiple of the canonical char height. */
4855 f
= FACE_FROM_ID (it
->f
,
4856 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4857 new_height
= (XFLOATINT (it
->font_height
)
4858 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4862 /* Evaluate IT->font_height with `height' bound to the
4863 current specified height to get the new height. */
4864 ptrdiff_t count
= SPECPDL_INDEX ();
4866 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4867 value
= safe_eval (it
->font_height
);
4868 unbind_to (count
, Qnil
);
4870 if (NUMBERP (value
))
4871 new_height
= XFLOATINT (value
);
4875 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4882 /* Handle `(space-width WIDTH)'. */
4884 && EQ (XCAR (spec
), Qspace_width
)
4885 && CONSP (XCDR (spec
)))
4889 if (!FRAME_WINDOW_P (it
->f
))
4892 value
= XCAR (XCDR (spec
));
4893 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4894 it
->space_width
= value
;
4900 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4902 && EQ (XCAR (spec
), Qslice
))
4908 if (!FRAME_WINDOW_P (it
->f
))
4911 if (tem
= XCDR (spec
), CONSP (tem
))
4913 it
->slice
.x
= XCAR (tem
);
4914 if (tem
= XCDR (tem
), CONSP (tem
))
4916 it
->slice
.y
= XCAR (tem
);
4917 if (tem
= XCDR (tem
), CONSP (tem
))
4919 it
->slice
.width
= XCAR (tem
);
4920 if (tem
= XCDR (tem
), CONSP (tem
))
4921 it
->slice
.height
= XCAR (tem
);
4930 /* Handle `(raise FACTOR)'. */
4932 && EQ (XCAR (spec
), Qraise
)
4933 && CONSP (XCDR (spec
)))
4937 if (!FRAME_WINDOW_P (it
->f
))
4940 #ifdef HAVE_WINDOW_SYSTEM
4941 value
= XCAR (XCDR (spec
));
4942 if (NUMBERP (value
))
4944 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4945 it
->voffset
= - (XFLOATINT (value
)
4946 * (normal_char_height (face
->font
, -1)));
4948 #endif /* HAVE_WINDOW_SYSTEM */
4954 /* Don't handle the other kinds of display specifications
4955 inside a string that we got from a `display' property. */
4956 if (it
&& it
->string_from_display_prop_p
)
4959 /* Characters having this form of property are not displayed, so
4960 we have to find the end of the property. */
4963 start_pos
= *position
;
4964 *position
= display_prop_end (it
, object
, start_pos
);
4965 /* If the display property comes from an overlay, don't consider
4966 any potential stop_charpos values before the end of that
4967 overlay. Since display_prop_end will happily find another
4968 'display' property coming from some other overlay or text
4969 property on buffer positions before this overlay's end, we
4970 need to ignore them, or else we risk displaying this
4971 overlay's display string/image twice. */
4972 if (!NILP (overlay
))
4974 ptrdiff_t ovendpos
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4976 if (ovendpos
> CHARPOS (*position
))
4977 SET_TEXT_POS (*position
, ovendpos
, CHAR_TO_BYTE (ovendpos
));
4982 /* Stop the scan at that end position--we assume that all
4983 text properties change there. */
4985 it
->stop_charpos
= position
->charpos
;
4987 /* Handle `(left-fringe BITMAP [FACE])'
4988 and `(right-fringe BITMAP [FACE])'. */
4990 && (EQ (XCAR (spec
), Qleft_fringe
)
4991 || EQ (XCAR (spec
), Qright_fringe
))
4992 && CONSP (XCDR (spec
)))
4998 if (!FRAME_WINDOW_P (it
->f
))
4999 /* If we return here, POSITION has been advanced
5000 across the text with this property. */
5002 /* Synchronize the bidi iterator with POSITION. This is
5003 needed because we are not going to push the iterator
5004 on behalf of this display property, so there will be
5005 no pop_it call to do this synchronization for us. */
5008 it
->position
= *position
;
5009 iterate_out_of_display_property (it
);
5010 *position
= it
->position
;
5015 else if (!frame_window_p
)
5018 #ifdef HAVE_WINDOW_SYSTEM
5019 value
= XCAR (XCDR (spec
));
5020 if (!SYMBOLP (value
)
5021 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5022 /* If we return here, POSITION has been advanced
5023 across the text with this property. */
5025 if (it
&& it
->bidi_p
)
5027 it
->position
= *position
;
5028 iterate_out_of_display_property (it
);
5029 *position
= it
->position
;
5036 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5038 if (CONSP (XCDR (XCDR (spec
))))
5040 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5041 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5042 FRINGE_FACE_ID
, false);
5047 /* Save current settings of IT so that we can restore them
5048 when we are finished with the glyph property value. */
5049 push_it (it
, position
);
5051 it
->area
= TEXT_AREA
;
5052 it
->what
= IT_IMAGE
;
5053 it
->image_id
= -1; /* no image */
5054 it
->position
= start_pos
;
5055 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5056 it
->method
= GET_FROM_IMAGE
;
5057 it
->from_overlay
= Qnil
;
5058 it
->face_id
= face_id
;
5059 it
->from_disp_prop_p
= true;
5061 /* Say that we haven't consumed the characters with
5062 `display' property yet. The call to pop_it in
5063 set_iterator_to_next will clean this up. */
5064 *position
= start_pos
;
5066 if (EQ (XCAR (spec
), Qleft_fringe
))
5068 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5069 it
->left_user_fringe_face_id
= face_id
;
5073 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5074 it
->right_user_fringe_face_id
= face_id
;
5077 #endif /* HAVE_WINDOW_SYSTEM */
5081 /* Prepare to handle `((margin left-margin) ...)',
5082 `((margin right-margin) ...)' and `((margin nil) ...)'
5083 prefixes for display specifications. */
5084 location
= Qunbound
;
5085 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5089 value
= XCDR (spec
);
5091 value
= XCAR (value
);
5094 if (EQ (XCAR (tem
), Qmargin
)
5095 && (tem
= XCDR (tem
),
5096 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5098 || EQ (tem
, Qleft_margin
)
5099 || EQ (tem
, Qright_margin
))))
5103 if (EQ (location
, Qunbound
))
5109 /* After this point, VALUE is the property after any
5110 margin prefix has been stripped. It must be a string,
5111 an image specification, or `(space ...)'.
5113 LOCATION specifies where to display: `left-margin',
5114 `right-margin' or nil. */
5116 bool valid_p
= (STRINGP (value
)
5117 #ifdef HAVE_WINDOW_SYSTEM
5118 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5119 && valid_image_p (value
))
5120 #endif /* not HAVE_WINDOW_SYSTEM */
5121 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5123 if (valid_p
&& display_replaced
== 0)
5129 /* Callers need to know whether the display spec is any kind
5130 of `(space ...)' spec that is about to affect text-area
5132 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5137 /* Save current settings of IT so that we can restore them
5138 when we are finished with the glyph property value. */
5139 push_it (it
, position
);
5140 it
->from_overlay
= overlay
;
5141 it
->from_disp_prop_p
= true;
5143 if (NILP (location
))
5144 it
->area
= TEXT_AREA
;
5145 else if (EQ (location
, Qleft_margin
))
5146 it
->area
= LEFT_MARGIN_AREA
;
5148 it
->area
= RIGHT_MARGIN_AREA
;
5150 if (STRINGP (value
))
5153 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5154 it
->current
.overlay_string_index
= -1;
5155 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5156 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5157 it
->method
= GET_FROM_STRING
;
5158 it
->stop_charpos
= 0;
5160 it
->base_level_stop
= 0;
5161 it
->string_from_display_prop_p
= true;
5162 /* Say that we haven't consumed the characters with
5163 `display' property yet. The call to pop_it in
5164 set_iterator_to_next will clean this up. */
5165 if (BUFFERP (object
))
5166 *position
= start_pos
;
5168 /* Force paragraph direction to be that of the parent
5169 object. If the parent object's paragraph direction is
5170 not yet determined, default to L2R. */
5171 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5172 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5174 it
->paragraph_embedding
= L2R
;
5176 /* Set up the bidi iterator for this display string. */
5179 it
->bidi_it
.string
.lstring
= it
->string
;
5180 it
->bidi_it
.string
.s
= NULL
;
5181 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5182 it
->bidi_it
.string
.bufpos
= bufpos
;
5183 it
->bidi_it
.string
.from_disp_str
= true;
5184 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5185 it
->bidi_it
.w
= it
->w
;
5186 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5189 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5191 it
->method
= GET_FROM_STRETCH
;
5193 *position
= it
->position
= start_pos
;
5194 retval
= 1 + (it
->area
== TEXT_AREA
);
5196 #ifdef HAVE_WINDOW_SYSTEM
5199 it
->what
= IT_IMAGE
;
5200 it
->image_id
= lookup_image (it
->f
, value
);
5201 it
->position
= start_pos
;
5202 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5203 it
->method
= GET_FROM_IMAGE
;
5205 /* Say that we haven't consumed the characters with
5206 `display' property yet. The call to pop_it in
5207 set_iterator_to_next will clean this up. */
5208 *position
= start_pos
;
5210 #endif /* HAVE_WINDOW_SYSTEM */
5215 /* Invalid property or property not supported. Restore
5216 POSITION to what it was before. */
5217 *position
= start_pos
;
5221 /* Check if PROP is a display property value whose text should be
5222 treated as intangible. OVERLAY is the overlay from which PROP
5223 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5224 specify the buffer position covered by PROP. */
5227 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5228 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5230 bool frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5231 struct text_pos position
;
5233 SET_TEXT_POS (position
, charpos
, bytepos
);
5234 return (handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5235 &position
, charpos
, frame_window_p
)
5240 /* Return true if PROP is a display sub-property value containing STRING.
5242 Implementation note: this and the following function are really
5243 special cases of handle_display_spec and
5244 handle_single_display_spec, and should ideally use the same code.
5245 Until they do, these two pairs must be consistent and must be
5246 modified in sync. */
5249 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5251 if (EQ (string
, prop
))
5254 /* Skip over `when FORM'. */
5255 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5260 /* Actually, the condition following `when' should be eval'ed,
5261 like handle_single_display_spec does, and we should return
5262 false if it evaluates to nil. However, this function is
5263 called only when the buffer was already displayed and some
5264 glyph in the glyph matrix was found to come from a display
5265 string. Therefore, the condition was already evaluated, and
5266 the result was non-nil, otherwise the display string wouldn't
5267 have been displayed and we would have never been called for
5268 this property. Thus, we can skip the evaluation and assume
5269 its result is non-nil. */
5274 /* Skip over `margin LOCATION'. */
5275 if (EQ (XCAR (prop
), Qmargin
))
5286 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5290 /* Return true if STRING appears in the `display' property PROP. */
5293 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5296 && !EQ (XCAR (prop
), Qwhen
)
5297 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5299 /* A list of sub-properties. */
5300 while (CONSP (prop
))
5302 if (single_display_spec_string_p (XCAR (prop
), string
))
5307 else if (VECTORP (prop
))
5309 /* A vector of sub-properties. */
5311 for (i
= 0; i
< ASIZE (prop
); ++i
)
5312 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5316 return single_display_spec_string_p (prop
, string
);
5321 /* Look for STRING in overlays and text properties in the current
5322 buffer, between character positions FROM and TO (excluding TO).
5323 BACK_P means look back (in this case, TO is supposed to be
5325 Value is the first character position where STRING was found, or
5326 zero if it wasn't found before hitting TO.
5328 This function may only use code that doesn't eval because it is
5329 called asynchronously from note_mouse_highlight. */
5332 string_buffer_position_lim (Lisp_Object string
,
5333 ptrdiff_t from
, ptrdiff_t to
, bool back_p
)
5335 Lisp_Object limit
, prop
, pos
;
5338 pos
= make_number (max (from
, BEGV
));
5340 if (!back_p
) /* looking forward */
5342 limit
= make_number (min (to
, ZV
));
5343 while (!found
&& !EQ (pos
, limit
))
5345 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5346 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5349 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5353 else /* looking back */
5355 limit
= make_number (max (to
, BEGV
));
5356 while (!found
&& !EQ (pos
, limit
))
5358 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5359 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5362 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5367 return found
? XINT (pos
) : 0;
5370 /* Determine which buffer position in current buffer STRING comes from.
5371 AROUND_CHARPOS is an approximate position where it could come from.
5372 Value is the buffer position or 0 if it couldn't be determined.
5374 This function is necessary because we don't record buffer positions
5375 in glyphs generated from strings (to keep struct glyph small).
5376 This function may only use code that doesn't eval because it is
5377 called asynchronously from note_mouse_highlight. */
5380 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5382 const int MAX_DISTANCE
= 1000;
5383 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5384 around_charpos
+ MAX_DISTANCE
,
5388 found
= string_buffer_position_lim (string
, around_charpos
,
5389 around_charpos
- MAX_DISTANCE
, true);
5395 /***********************************************************************
5396 `composition' property
5397 ***********************************************************************/
5399 /* Set up iterator IT from `composition' property at its current
5400 position. Called from handle_stop. */
5402 static enum prop_handled
5403 handle_composition_prop (struct it
*it
)
5405 Lisp_Object prop
, string
;
5406 ptrdiff_t pos
, pos_byte
, start
, end
;
5408 if (STRINGP (it
->string
))
5412 pos
= IT_STRING_CHARPOS (*it
);
5413 pos_byte
= IT_STRING_BYTEPOS (*it
);
5414 string
= it
->string
;
5415 s
= SDATA (string
) + pos_byte
;
5416 it
->c
= STRING_CHAR (s
);
5420 pos
= IT_CHARPOS (*it
);
5421 pos_byte
= IT_BYTEPOS (*it
);
5423 it
->c
= FETCH_CHAR (pos_byte
);
5426 /* If there's a valid composition and point is not inside of the
5427 composition (in the case that the composition is from the current
5428 buffer), draw a glyph composed from the composition components. */
5429 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5430 && composition_valid_p (start
, end
, prop
)
5431 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5434 /* As we can't handle this situation (perhaps font-lock added
5435 a new composition), we just return here hoping that next
5436 redisplay will detect this composition much earlier. */
5437 return HANDLED_NORMALLY
;
5440 if (STRINGP (it
->string
))
5441 pos_byte
= string_char_to_byte (it
->string
, start
);
5443 pos_byte
= CHAR_TO_BYTE (start
);
5445 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5448 if (it
->cmp_it
.id
>= 0)
5451 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5452 it
->cmp_it
.nglyphs
= -1;
5456 return HANDLED_NORMALLY
;
5461 /***********************************************************************
5463 ***********************************************************************/
5465 /* The following structure is used to record overlay strings for
5466 later sorting in load_overlay_strings. */
5468 struct overlay_entry
5470 Lisp_Object overlay
;
5473 bool after_string_p
;
5477 /* Set up iterator IT from overlay strings at its current position.
5478 Called from handle_stop. */
5480 static enum prop_handled
5481 handle_overlay_change (struct it
*it
)
5483 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5484 return HANDLED_RECOMPUTE_PROPS
;
5486 return HANDLED_NORMALLY
;
5490 /* Set up the next overlay string for delivery by IT, if there is an
5491 overlay string to deliver. Called by set_iterator_to_next when the
5492 end of the current overlay string is reached. If there are more
5493 overlay strings to display, IT->string and
5494 IT->current.overlay_string_index are set appropriately here.
5495 Otherwise IT->string is set to nil. */
5498 next_overlay_string (struct it
*it
)
5500 ++it
->current
.overlay_string_index
;
5501 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5503 /* No more overlay strings. Restore IT's settings to what
5504 they were before overlay strings were processed, and
5505 continue to deliver from current_buffer. */
5507 it
->ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
5510 || (NILP (it
->string
)
5511 && it
->method
== GET_FROM_BUFFER
5512 && it
->stop_charpos
>= BEGV
5513 && it
->stop_charpos
<= it
->end_charpos
));
5514 it
->current
.overlay_string_index
= -1;
5515 it
->n_overlay_strings
= 0;
5516 /* If there's an empty display string on the stack, pop the
5517 stack, to resync the bidi iterator with IT's position. Such
5518 empty strings are pushed onto the stack in
5519 get_overlay_strings_1. */
5520 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5523 /* Since we've exhausted overlay strings at this buffer
5524 position, set the flag to ignore overlays until we move to
5525 another position. The flag is reset in
5526 next_element_from_buffer. */
5527 it
->ignore_overlay_strings_at_pos_p
= true;
5529 /* If we're at the end of the buffer, record that we have
5530 processed the overlay strings there already, so that
5531 next_element_from_buffer doesn't try it again. */
5532 if (NILP (it
->string
)
5533 && IT_CHARPOS (*it
) >= it
->end_charpos
5534 && it
->overlay_strings_charpos
>= it
->end_charpos
)
5535 it
->overlay_strings_at_end_processed_p
= true;
5536 /* Note: we reset overlay_strings_charpos only here, to make
5537 sure the just-processed overlays were indeed at EOB.
5538 Otherwise, overlays on text with invisible text property,
5539 which are processed with IT's position past the invisible
5540 text, might fool us into thinking the overlays at EOB were
5541 already processed (linum-mode can cause this, for
5543 it
->overlay_strings_charpos
= -1;
5547 /* There are more overlay strings to process. If
5548 IT->current.overlay_string_index has advanced to a position
5549 where we must load IT->overlay_strings with more strings, do
5550 it. We must load at the IT->overlay_strings_charpos where
5551 IT->n_overlay_strings was originally computed; when invisible
5552 text is present, this might not be IT_CHARPOS (Bug#7016). */
5553 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5555 if (it
->current
.overlay_string_index
&& i
== 0)
5556 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5558 /* Initialize IT to deliver display elements from the overlay
5560 it
->string
= it
->overlay_strings
[i
];
5561 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5562 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5563 it
->method
= GET_FROM_STRING
;
5564 it
->stop_charpos
= 0;
5565 it
->end_charpos
= SCHARS (it
->string
);
5566 if (it
->cmp_it
.stop_pos
>= 0)
5567 it
->cmp_it
.stop_pos
= 0;
5569 it
->base_level_stop
= 0;
5571 /* Set up the bidi iterator for this overlay string. */
5574 it
->bidi_it
.string
.lstring
= it
->string
;
5575 it
->bidi_it
.string
.s
= NULL
;
5576 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5577 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5578 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5579 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5580 it
->bidi_it
.w
= it
->w
;
5581 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5589 /* Compare two overlay_entry structures E1 and E2. Used as a
5590 comparison function for qsort in load_overlay_strings. Overlay
5591 strings for the same position are sorted so that
5593 1. All after-strings come in front of before-strings, except
5594 when they come from the same overlay.
5596 2. Within after-strings, strings are sorted so that overlay strings
5597 from overlays with higher priorities come first.
5599 2. Within before-strings, strings are sorted so that overlay
5600 strings from overlays with higher priorities come last.
5602 Value is analogous to strcmp. */
5606 compare_overlay_entries (const void *e1
, const void *e2
)
5608 struct overlay_entry
const *entry1
= e1
;
5609 struct overlay_entry
const *entry2
= e2
;
5612 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5614 /* Let after-strings appear in front of before-strings if
5615 they come from different overlays. */
5616 if (EQ (entry1
->overlay
, entry2
->overlay
))
5617 result
= entry1
->after_string_p
? 1 : -1;
5619 result
= entry1
->after_string_p
? -1 : 1;
5621 else if (entry1
->priority
!= entry2
->priority
)
5623 if (entry1
->after_string_p
)
5624 /* After-strings sorted in order of decreasing priority. */
5625 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5627 /* Before-strings sorted in order of increasing priority. */
5628 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5637 /* Load the vector IT->overlay_strings with overlay strings from IT's
5638 current buffer position, or from CHARPOS if that is > 0. Set
5639 IT->n_overlays to the total number of overlay strings found.
5641 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5642 a time. On entry into load_overlay_strings,
5643 IT->current.overlay_string_index gives the number of overlay
5644 strings that have already been loaded by previous calls to this
5647 IT->add_overlay_start contains an additional overlay start
5648 position to consider for taking overlay strings from, if non-zero.
5649 This position comes into play when the overlay has an `invisible'
5650 property, and both before and after-strings. When we've skipped to
5651 the end of the overlay, because of its `invisible' property, we
5652 nevertheless want its before-string to appear.
5653 IT->add_overlay_start will contain the overlay start position
5656 Overlay strings are sorted so that after-string strings come in
5657 front of before-string strings. Within before and after-strings,
5658 strings are sorted by overlay priority. See also function
5659 compare_overlay_entries. */
5662 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5664 Lisp_Object overlay
, window
, str
, invisible
;
5665 struct Lisp_Overlay
*ov
;
5666 ptrdiff_t start
, end
;
5667 ptrdiff_t n
= 0, i
, j
;
5669 struct overlay_entry entriesbuf
[20];
5670 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5671 struct overlay_entry
*entries
= entriesbuf
;
5675 charpos
= IT_CHARPOS (*it
);
5677 /* Append the overlay string STRING of overlay OVERLAY to vector
5678 `entries' which has size `size' and currently contains `n'
5679 elements. AFTER_P means STRING is an after-string of
5681 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5684 Lisp_Object priority; \
5688 struct overlay_entry *old = entries; \
5689 SAFE_NALLOCA (entries, 2, size); \
5690 memcpy (entries, old, size * sizeof *entries); \
5694 entries[n].string = (STRING); \
5695 entries[n].overlay = (OVERLAY); \
5696 priority = Foverlay_get ((OVERLAY), Qpriority); \
5697 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5698 entries[n].after_string_p = (AFTER_P); \
5703 /* Process overlay before the overlay center. */
5704 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5706 XSETMISC (overlay
, ov
);
5707 eassert (OVERLAYP (overlay
));
5708 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5709 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5714 /* Skip this overlay if it doesn't start or end at IT's current
5716 if (end
!= charpos
&& start
!= charpos
)
5719 /* Skip this overlay if it doesn't apply to IT->w. */
5720 window
= Foverlay_get (overlay
, Qwindow
);
5721 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5724 /* If the text ``under'' the overlay is invisible, both before-
5725 and after-strings from this overlay are visible; start and
5726 end position are indistinguishable. */
5727 invisible
= Foverlay_get (overlay
, Qinvisible
);
5728 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5730 /* If overlay has a non-empty before-string, record it. */
5731 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5732 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5734 RECORD_OVERLAY_STRING (overlay
, str
, false);
5736 /* If overlay has a non-empty after-string, record it. */
5737 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5738 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5740 RECORD_OVERLAY_STRING (overlay
, str
, true);
5743 /* Process overlays after the overlay center. */
5744 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5746 XSETMISC (overlay
, ov
);
5747 eassert (OVERLAYP (overlay
));
5748 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5749 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5751 if (start
> charpos
)
5754 /* Skip this overlay if it doesn't start or end at IT's current
5756 if (end
!= charpos
&& start
!= charpos
)
5759 /* Skip this overlay if it doesn't apply to IT->w. */
5760 window
= Foverlay_get (overlay
, Qwindow
);
5761 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5764 /* If the text ``under'' the overlay is invisible, it has a zero
5765 dimension, and both before- and after-strings apply. */
5766 invisible
= Foverlay_get (overlay
, Qinvisible
);
5767 invis
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5769 /* If overlay has a non-empty before-string, record it. */
5770 if ((start
== charpos
|| (end
== charpos
&& invis
!= 0))
5771 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5773 RECORD_OVERLAY_STRING (overlay
, str
, false);
5775 /* If overlay has a non-empty after-string, record it. */
5776 if ((end
== charpos
|| (start
== charpos
&& invis
!= 0))
5777 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5779 RECORD_OVERLAY_STRING (overlay
, str
, true);
5782 #undef RECORD_OVERLAY_STRING
5786 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5788 /* Record number of overlay strings, and where we computed it. */
5789 it
->n_overlay_strings
= n
;
5790 it
->overlay_strings_charpos
= charpos
;
5792 /* IT->current.overlay_string_index is the number of overlay strings
5793 that have already been consumed by IT. Copy some of the
5794 remaining overlay strings to IT->overlay_strings. */
5796 j
= it
->current
.overlay_string_index
;
5797 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5799 it
->overlay_strings
[i
] = entries
[j
].string
;
5800 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5808 /* Get the first chunk of overlay strings at IT's current buffer
5809 position, or at CHARPOS if that is > 0. Value is true if at
5810 least one overlay string was found. */
5813 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, bool compute_stop_p
)
5815 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5816 process. This fills IT->overlay_strings with strings, and sets
5817 IT->n_overlay_strings to the total number of strings to process.
5818 IT->pos.overlay_string_index has to be set temporarily to zero
5819 because load_overlay_strings needs this; it must be set to -1
5820 when no overlay strings are found because a zero value would
5821 indicate a position in the first overlay string. */
5822 it
->current
.overlay_string_index
= 0;
5823 load_overlay_strings (it
, charpos
);
5825 /* If we found overlay strings, set up IT to deliver display
5826 elements from the first one. Otherwise set up IT to deliver
5827 from current_buffer. */
5828 if (it
->n_overlay_strings
)
5830 /* Make sure we know settings in current_buffer, so that we can
5831 restore meaningful values when we're done with the overlay
5834 compute_stop_pos (it
);
5835 eassert (it
->face_id
>= 0);
5837 /* Save IT's settings. They are restored after all overlay
5838 strings have been processed. */
5839 eassert (!compute_stop_p
|| it
->sp
== 0);
5841 /* When called from handle_stop, there might be an empty display
5842 string loaded. In that case, don't bother saving it. But
5843 don't use this optimization with the bidi iterator, since we
5844 need the corresponding pop_it call to resync the bidi
5845 iterator's position with IT's position, after we are done
5846 with the overlay strings. (The corresponding call to pop_it
5847 in case of an empty display string is in
5848 next_overlay_string.) */
5850 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5853 /* Set up IT to deliver display elements from the first overlay
5855 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5856 it
->string
= it
->overlay_strings
[0];
5857 it
->from_overlay
= Qnil
;
5858 it
->stop_charpos
= 0;
5859 eassert (STRINGP (it
->string
));
5860 it
->end_charpos
= SCHARS (it
->string
);
5862 it
->base_level_stop
= 0;
5863 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5864 it
->method
= GET_FROM_STRING
;
5865 it
->from_disp_prop_p
= 0;
5867 /* Force paragraph direction to be that of the parent
5869 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5870 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5872 it
->paragraph_embedding
= L2R
;
5874 /* Set up the bidi iterator for this overlay string. */
5877 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5879 it
->bidi_it
.string
.lstring
= it
->string
;
5880 it
->bidi_it
.string
.s
= NULL
;
5881 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5882 it
->bidi_it
.string
.bufpos
= pos
;
5883 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5884 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5885 it
->bidi_it
.w
= it
->w
;
5886 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5891 it
->current
.overlay_string_index
= -1;
5896 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5899 it
->method
= GET_FROM_BUFFER
;
5901 get_overlay_strings_1 (it
, charpos
, true);
5905 /* Value is true if we found at least one overlay string. */
5906 return STRINGP (it
->string
);
5911 /***********************************************************************
5912 Saving and restoring state
5913 ***********************************************************************/
5915 /* Save current settings of IT on IT->stack. Called, for example,
5916 before setting up IT for an overlay string, to be able to restore
5917 IT's settings to what they were after the overlay string has been
5918 processed. If POSITION is non-NULL, it is the position to save on
5919 the stack instead of IT->position. */
5922 push_it (struct it
*it
, struct text_pos
*position
)
5924 struct iterator_stack_entry
*p
;
5926 eassert (it
->sp
< IT_STACK_SIZE
);
5927 p
= it
->stack
+ it
->sp
;
5929 p
->stop_charpos
= it
->stop_charpos
;
5930 p
->prev_stop
= it
->prev_stop
;
5931 p
->base_level_stop
= it
->base_level_stop
;
5932 p
->cmp_it
= it
->cmp_it
;
5933 eassert (it
->face_id
>= 0);
5934 p
->face_id
= it
->face_id
;
5935 p
->string
= it
->string
;
5936 p
->method
= it
->method
;
5937 p
->from_overlay
= it
->from_overlay
;
5940 case GET_FROM_IMAGE
:
5941 p
->u
.image
.object
= it
->object
;
5942 p
->u
.image
.image_id
= it
->image_id
;
5943 p
->u
.image
.slice
= it
->slice
;
5945 case GET_FROM_STRETCH
:
5946 p
->u
.stretch
.object
= it
->object
;
5948 case GET_FROM_BUFFER
:
5949 case GET_FROM_DISPLAY_VECTOR
:
5950 case GET_FROM_STRING
:
5951 case GET_FROM_C_STRING
:
5956 p
->position
= position
? *position
: it
->position
;
5957 p
->current
= it
->current
;
5958 p
->end_charpos
= it
->end_charpos
;
5959 p
->string_nchars
= it
->string_nchars
;
5961 p
->multibyte_p
= it
->multibyte_p
;
5962 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5963 p
->space_width
= it
->space_width
;
5964 p
->font_height
= it
->font_height
;
5965 p
->voffset
= it
->voffset
;
5966 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5967 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5968 p
->display_ellipsis_p
= false;
5969 p
->line_wrap
= it
->line_wrap
;
5970 p
->bidi_p
= it
->bidi_p
;
5971 p
->paragraph_embedding
= it
->paragraph_embedding
;
5972 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5975 /* Save the state of the bidi iterator as well. */
5977 bidi_push_it (&it
->bidi_it
);
5981 iterate_out_of_display_property (struct it
*it
)
5983 bool buffer_p
= !STRINGP (it
->string
);
5984 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5985 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5987 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5989 /* Maybe initialize paragraph direction. If we are at the beginning
5990 of a new paragraph, next_element_from_buffer may not have a
5991 chance to do that. */
5992 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5993 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
5994 /* prev_stop can be zero, so check against BEGV as well. */
5995 while (it
->bidi_it
.charpos
>= bob
5996 && it
->prev_stop
<= it
->bidi_it
.charpos
5997 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5998 && it
->bidi_it
.charpos
< eob
)
5999 bidi_move_to_visually_next (&it
->bidi_it
);
6000 /* Record the stop_pos we just crossed, for when we cross it
6002 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6003 it
->prev_stop
= CHARPOS (it
->position
);
6004 /* If we ended up not where pop_it put us, resync IT's
6005 positional members with the bidi iterator. */
6006 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6007 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6009 it
->current
.pos
= it
->position
;
6011 it
->current
.string_pos
= it
->position
;
6014 /* Restore IT's settings from IT->stack. Called, for example, when no
6015 more overlay strings must be processed, and we return to delivering
6016 display elements from a buffer, or when the end of a string from a
6017 `display' property is reached and we return to delivering display
6018 elements from an overlay string, or from a buffer. */
6021 pop_it (struct it
*it
)
6023 struct iterator_stack_entry
*p
;
6024 bool from_display_prop
= it
->from_disp_prop_p
;
6025 ptrdiff_t prev_pos
= IT_CHARPOS (*it
);
6027 eassert (it
->sp
> 0);
6029 p
= it
->stack
+ it
->sp
;
6030 it
->stop_charpos
= p
->stop_charpos
;
6031 it
->prev_stop
= p
->prev_stop
;
6032 it
->base_level_stop
= p
->base_level_stop
;
6033 it
->cmp_it
= p
->cmp_it
;
6034 it
->face_id
= p
->face_id
;
6035 it
->current
= p
->current
;
6036 it
->position
= p
->position
;
6037 it
->string
= p
->string
;
6038 it
->from_overlay
= p
->from_overlay
;
6039 if (NILP (it
->string
))
6040 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6041 it
->method
= p
->method
;
6044 case GET_FROM_IMAGE
:
6045 it
->image_id
= p
->u
.image
.image_id
;
6046 it
->object
= p
->u
.image
.object
;
6047 it
->slice
= p
->u
.image
.slice
;
6049 case GET_FROM_STRETCH
:
6050 it
->object
= p
->u
.stretch
.object
;
6052 case GET_FROM_BUFFER
:
6053 it
->object
= it
->w
->contents
;
6055 case GET_FROM_STRING
:
6057 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6059 /* Restore the face_box_p flag, since it could have been
6060 overwritten by the face of the object that we just finished
6063 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6064 it
->object
= it
->string
;
6067 case GET_FROM_DISPLAY_VECTOR
:
6069 it
->method
= GET_FROM_C_STRING
;
6070 else if (STRINGP (it
->string
))
6071 it
->method
= GET_FROM_STRING
;
6074 it
->method
= GET_FROM_BUFFER
;
6075 it
->object
= it
->w
->contents
;
6078 case GET_FROM_C_STRING
:
6083 it
->end_charpos
= p
->end_charpos
;
6084 it
->string_nchars
= p
->string_nchars
;
6086 it
->multibyte_p
= p
->multibyte_p
;
6087 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6088 it
->space_width
= p
->space_width
;
6089 it
->font_height
= p
->font_height
;
6090 it
->voffset
= p
->voffset
;
6091 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6092 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6093 it
->line_wrap
= p
->line_wrap
;
6094 it
->bidi_p
= p
->bidi_p
;
6095 it
->paragraph_embedding
= p
->paragraph_embedding
;
6096 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6099 bidi_pop_it (&it
->bidi_it
);
6100 /* Bidi-iterate until we get out of the portion of text, if any,
6101 covered by a `display' text property or by an overlay with
6102 `display' property. (We cannot just jump there, because the
6103 internal coherency of the bidi iterator state can not be
6104 preserved across such jumps.) We also must determine the
6105 paragraph base direction if the overlay we just processed is
6106 at the beginning of a new paragraph. */
6107 if (from_display_prop
6108 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6109 iterate_out_of_display_property (it
);
6111 eassert ((BUFFERP (it
->object
)
6112 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6113 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6114 || (STRINGP (it
->object
)
6115 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6116 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6117 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6119 /* If we move the iterator over text covered by a display property
6120 to a new buffer position, any info about previously seen overlays
6121 is no longer valid. */
6122 if (from_display_prop
&& it
->sp
== 0 && CHARPOS (it
->position
) != prev_pos
)
6123 it
->ignore_overlay_strings_at_pos_p
= false;
6128 /***********************************************************************
6130 ***********************************************************************/
6132 /* Set IT's current position to the previous line start. */
6135 back_to_previous_line_start (struct it
*it
)
6137 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6140 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6144 /* Move IT to the next line start.
6146 Value is true if a newline was found. Set *SKIPPED_P to true if
6147 we skipped over part of the text (as opposed to moving the iterator
6148 continuously over the text). Otherwise, don't change the value
6151 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6152 iterator on the newline, if it was found.
6154 Newlines may come from buffer text, overlay strings, or strings
6155 displayed via the `display' property. That's the reason we can't
6156 simply use find_newline_no_quit.
6158 Note that this function may not skip over invisible text that is so
6159 because of text properties and immediately follows a newline. If
6160 it would, function reseat_at_next_visible_line_start, when called
6161 from set_iterator_to_next, would effectively make invisible
6162 characters following a newline part of the wrong glyph row, which
6163 leads to wrong cursor motion. */
6166 forward_to_next_line_start (struct it
*it
, bool *skipped_p
,
6167 struct bidi_it
*bidi_it_prev
)
6169 ptrdiff_t old_selective
;
6170 bool newline_found_p
= false;
6172 const int MAX_NEWLINE_DISTANCE
= 500;
6174 /* If already on a newline, just consume it to avoid unintended
6175 skipping over invisible text below. */
6176 if (it
->what
== IT_CHARACTER
6178 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6180 if (it
->bidi_p
&& bidi_it_prev
)
6181 *bidi_it_prev
= it
->bidi_it
;
6182 set_iterator_to_next (it
, false);
6187 /* Don't handle selective display in the following. It's (a)
6188 unnecessary because it's done by the caller, and (b) leads to an
6189 infinite recursion because next_element_from_ellipsis indirectly
6190 calls this function. */
6191 old_selective
= it
->selective
;
6194 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6195 from buffer text. */
6197 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6198 n
+= !STRINGP (it
->string
))
6200 if (!get_next_display_element (it
))
6202 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6203 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6204 *bidi_it_prev
= it
->bidi_it
;
6205 set_iterator_to_next (it
, false);
6208 /* If we didn't find a newline near enough, see if we can use a
6210 if (!newline_found_p
)
6212 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6213 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6217 eassert (!STRINGP (it
->string
));
6219 /* If there isn't any `display' property in sight, and no
6220 overlays, we can just use the position of the newline in
6222 if (it
->stop_charpos
>= limit
6223 || ((pos
= Fnext_single_property_change (make_number (start
),
6225 make_number (limit
)),
6227 && next_overlay_change (start
) == ZV
))
6231 IT_CHARPOS (*it
) = limit
;
6232 IT_BYTEPOS (*it
) = bytepos
;
6236 struct bidi_it bprev
;
6238 /* Help bidi.c avoid expensive searches for display
6239 properties and overlays, by telling it that there are
6240 none up to `limit'. */
6241 if (it
->bidi_it
.disp_pos
< limit
)
6243 it
->bidi_it
.disp_pos
= limit
;
6244 it
->bidi_it
.disp_prop
= 0;
6247 bprev
= it
->bidi_it
;
6248 bidi_move_to_visually_next (&it
->bidi_it
);
6249 } while (it
->bidi_it
.charpos
!= limit
);
6250 IT_CHARPOS (*it
) = limit
;
6251 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6253 *bidi_it_prev
= bprev
;
6255 *skipped_p
= newline_found_p
= true;
6259 while (get_next_display_element (it
)
6260 && !newline_found_p
)
6262 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6263 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6264 *bidi_it_prev
= it
->bidi_it
;
6265 set_iterator_to_next (it
, false);
6270 it
->selective
= old_selective
;
6271 return newline_found_p
;
6275 /* Set IT's current position to the previous visible line start. Skip
6276 invisible text that is so either due to text properties or due to
6277 selective display. Caution: this does not change IT->current_x and
6281 back_to_previous_visible_line_start (struct it
*it
)
6283 while (IT_CHARPOS (*it
) > BEGV
)
6285 back_to_previous_line_start (it
);
6287 if (IT_CHARPOS (*it
) <= BEGV
)
6290 /* If selective > 0, then lines indented more than its value are
6292 if (it
->selective
> 0
6293 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6297 /* Check the newline before point for invisibility. */
6300 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6301 Qinvisible
, it
->window
);
6302 if (TEXT_PROP_MEANS_INVISIBLE (prop
) != 0)
6306 if (IT_CHARPOS (*it
) <= BEGV
)
6311 void *it2data
= NULL
;
6314 Lisp_Object val
, overlay
;
6316 SAVE_IT (it2
, *it
, it2data
);
6318 /* If newline is part of a composition, continue from start of composition */
6319 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6320 && beg
< IT_CHARPOS (*it
))
6323 /* If newline is replaced by a display property, find start of overlay
6324 or interval and continue search from that point. */
6325 pos
= --IT_CHARPOS (it2
);
6328 bidi_unshelve_cache (NULL
, false);
6329 it2
.string_from_display_prop_p
= false;
6330 it2
.from_disp_prop_p
= false;
6331 if (handle_display_prop (&it2
) == HANDLED_RETURN
6332 && !NILP (val
= get_char_property_and_overlay
6333 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6334 && (OVERLAYP (overlay
)
6335 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6336 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6338 RESTORE_IT (it
, it
, it2data
);
6342 /* Newline is not replaced by anything -- so we are done. */
6343 RESTORE_IT (it
, it
, it2data
);
6349 IT_CHARPOS (*it
) = beg
;
6350 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6354 it
->continuation_lines_width
= 0;
6356 eassert (IT_CHARPOS (*it
) >= BEGV
);
6357 eassert (IT_CHARPOS (*it
) == BEGV
6358 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6363 /* Reseat iterator IT at the previous visible line start. Skip
6364 invisible text that is so either due to text properties or due to
6365 selective display. At the end, update IT's overlay information,
6366 face information etc. */
6369 reseat_at_previous_visible_line_start (struct it
*it
)
6371 back_to_previous_visible_line_start (it
);
6372 reseat (it
, it
->current
.pos
, true);
6377 /* Reseat iterator IT on the next visible line start in the current
6378 buffer. ON_NEWLINE_P means position IT on the newline
6379 preceding the line start. Skip over invisible text that is so
6380 because of selective display. Compute faces, overlays etc at the
6381 new position. Note that this function does not skip over text that
6382 is invisible because of text properties. */
6385 reseat_at_next_visible_line_start (struct it
*it
, bool on_newline_p
)
6387 bool skipped_p
= false;
6388 struct bidi_it bidi_it_prev
;
6389 bool newline_found_p
6390 = forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6392 /* Skip over lines that are invisible because they are indented
6393 more than the value of IT->selective. */
6394 if (it
->selective
> 0)
6395 while (IT_CHARPOS (*it
) < ZV
6396 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6399 eassert (IT_BYTEPOS (*it
) == BEGV
6400 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6402 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6405 /* Position on the newline if that's what's requested. */
6406 if (on_newline_p
&& newline_found_p
)
6408 if (STRINGP (it
->string
))
6410 if (IT_STRING_CHARPOS (*it
) > 0)
6414 --IT_STRING_CHARPOS (*it
);
6415 --IT_STRING_BYTEPOS (*it
);
6419 /* We need to restore the bidi iterator to the state
6420 it had on the newline, and resync the IT's
6421 position with that. */
6422 it
->bidi_it
= bidi_it_prev
;
6423 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6424 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6428 else if (IT_CHARPOS (*it
) > BEGV
)
6437 /* We need to restore the bidi iterator to the state it
6438 had on the newline and resync IT with that. */
6439 it
->bidi_it
= bidi_it_prev
;
6440 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6441 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6443 reseat (it
, it
->current
.pos
, false);
6447 reseat (it
, it
->current
.pos
, false);
6454 /***********************************************************************
6455 Changing an iterator's position
6456 ***********************************************************************/
6458 /* Change IT's current position to POS in current_buffer.
6459 If FORCE_P, always check for text properties at the new position.
6460 Otherwise, text properties are only looked up if POS >=
6461 IT->check_charpos of a property. */
6464 reseat (struct it
*it
, struct text_pos pos
, bool force_p
)
6466 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6468 reseat_1 (it
, pos
, false);
6470 /* Determine where to check text properties. Avoid doing it
6471 where possible because text property lookup is very expensive. */
6473 || CHARPOS (pos
) > it
->stop_charpos
6474 || CHARPOS (pos
) < original_pos
)
6478 /* For bidi iteration, we need to prime prev_stop and
6479 base_level_stop with our best estimations. */
6480 /* Implementation note: Of course, POS is not necessarily a
6481 stop position, so assigning prev_pos to it is a lie; we
6482 should have called compute_stop_backwards. However, if
6483 the current buffer does not include any R2L characters,
6484 that call would be a waste of cycles, because the
6485 iterator will never move back, and thus never cross this
6486 "fake" stop position. So we delay that backward search
6487 until the time we really need it, in next_element_from_buffer. */
6488 if (CHARPOS (pos
) != it
->prev_stop
)
6489 it
->prev_stop
= CHARPOS (pos
);
6490 if (CHARPOS (pos
) < it
->base_level_stop
)
6491 it
->base_level_stop
= 0; /* meaning it's unknown */
6497 it
->prev_stop
= it
->base_level_stop
= 0;
6506 /* Change IT's buffer position to POS. SET_STOP_P means set
6507 IT->stop_pos to POS, also. */
6510 reseat_1 (struct it
*it
, struct text_pos pos
, bool set_stop_p
)
6512 /* Don't call this function when scanning a C string. */
6513 eassert (it
->s
== NULL
);
6515 /* POS must be a reasonable value. */
6516 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6518 it
->current
.pos
= it
->position
= pos
;
6519 it
->end_charpos
= ZV
;
6521 it
->current
.dpvec_index
= -1;
6522 it
->current
.overlay_string_index
= -1;
6523 IT_STRING_CHARPOS (*it
) = -1;
6524 IT_STRING_BYTEPOS (*it
) = -1;
6526 it
->method
= GET_FROM_BUFFER
;
6527 it
->object
= it
->w
->contents
;
6528 it
->area
= TEXT_AREA
;
6529 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6531 it
->string_from_display_prop_p
= false;
6532 it
->string_from_prefix_prop_p
= false;
6534 it
->from_disp_prop_p
= false;
6535 it
->face_before_selective_p
= false;
6538 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6540 bidi_unshelve_cache (NULL
, false);
6541 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6542 it
->bidi_it
.string
.s
= NULL
;
6543 it
->bidi_it
.string
.lstring
= Qnil
;
6544 it
->bidi_it
.string
.bufpos
= 0;
6545 it
->bidi_it
.string
.from_disp_str
= false;
6546 it
->bidi_it
.string
.unibyte
= false;
6547 it
->bidi_it
.w
= it
->w
;
6552 it
->stop_charpos
= CHARPOS (pos
);
6553 it
->base_level_stop
= CHARPOS (pos
);
6555 /* This make the information stored in it->cmp_it invalidate. */
6560 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6561 If S is non-null, it is a C string to iterate over. Otherwise,
6562 STRING gives a Lisp string to iterate over.
6564 If PRECISION > 0, don't return more then PRECISION number of
6565 characters from the string.
6567 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6568 characters have been returned. FIELD_WIDTH < 0 means an infinite
6571 MULTIBYTE = 0 means disable processing of multibyte characters,
6572 MULTIBYTE > 0 means enable it,
6573 MULTIBYTE < 0 means use IT->multibyte_p.
6575 IT must be initialized via a prior call to init_iterator before
6576 calling this function. */
6579 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6580 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6583 /* No text property checks performed by default, but see below. */
6584 it
->stop_charpos
= -1;
6586 /* Set iterator position and end position. */
6587 memset (&it
->current
, 0, sizeof it
->current
);
6588 it
->current
.overlay_string_index
= -1;
6589 it
->current
.dpvec_index
= -1;
6590 eassert (charpos
>= 0);
6592 /* If STRING is specified, use its multibyteness, otherwise use the
6593 setting of MULTIBYTE, if specified. */
6595 it
->multibyte_p
= multibyte
> 0;
6597 /* Bidirectional reordering of strings is controlled by the default
6598 value of bidi-display-reordering. Don't try to reorder while
6599 loading loadup.el, as the necessary character property tables are
6600 not yet available. */
6603 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6607 eassert (STRINGP (string
));
6608 it
->string
= string
;
6610 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6611 it
->method
= GET_FROM_STRING
;
6612 it
->current
.string_pos
= string_pos (charpos
, string
);
6616 it
->bidi_it
.string
.lstring
= string
;
6617 it
->bidi_it
.string
.s
= NULL
;
6618 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6619 it
->bidi_it
.string
.bufpos
= 0;
6620 it
->bidi_it
.string
.from_disp_str
= false;
6621 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6622 it
->bidi_it
.w
= it
->w
;
6623 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6624 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6629 it
->s
= (const unsigned char *) s
;
6632 /* Note that we use IT->current.pos, not it->current.string_pos,
6633 for displaying C strings. */
6634 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6635 if (it
->multibyte_p
)
6637 it
->current
.pos
= c_string_pos (charpos
, s
, true);
6638 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, true);
6642 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6643 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6648 it
->bidi_it
.string
.lstring
= Qnil
;
6649 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6650 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6651 it
->bidi_it
.string
.bufpos
= 0;
6652 it
->bidi_it
.string
.from_disp_str
= false;
6653 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6654 it
->bidi_it
.w
= it
->w
;
6655 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6658 it
->method
= GET_FROM_C_STRING
;
6661 /* PRECISION > 0 means don't return more than PRECISION characters
6663 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6665 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6667 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6670 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6671 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6672 FIELD_WIDTH < 0 means infinite field width. This is useful for
6673 padding with `-' at the end of a mode line. */
6674 if (field_width
< 0)
6675 field_width
= INFINITY
;
6676 /* Implementation note: We deliberately don't enlarge
6677 it->bidi_it.string.schars here to fit it->end_charpos, because
6678 the bidi iterator cannot produce characters out of thin air. */
6679 if (field_width
> it
->end_charpos
- charpos
)
6680 it
->end_charpos
= charpos
+ field_width
;
6682 /* Use the standard display table for displaying strings. */
6683 if (DISP_TABLE_P (Vstandard_display_table
))
6684 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6686 it
->stop_charpos
= charpos
;
6687 it
->prev_stop
= charpos
;
6688 it
->base_level_stop
= 0;
6691 it
->bidi_it
.first_elt
= true;
6692 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6693 it
->bidi_it
.disp_pos
= -1;
6695 if (s
== NULL
&& it
->multibyte_p
)
6697 ptrdiff_t endpos
= SCHARS (it
->string
);
6698 if (endpos
> it
->end_charpos
)
6699 endpos
= it
->end_charpos
;
6700 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6708 /***********************************************************************
6710 ***********************************************************************/
6712 /* Map enum it_method value to corresponding next_element_from_* function. */
6714 typedef bool (*next_element_function
) (struct it
*);
6716 static next_element_function
const get_next_element
[NUM_IT_METHODS
] =
6718 next_element_from_buffer
,
6719 next_element_from_display_vector
,
6720 next_element_from_string
,
6721 next_element_from_c_string
,
6722 next_element_from_image
,
6723 next_element_from_stretch
6726 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6729 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6730 (possibly with the following characters). */
6732 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6733 ((IT)->cmp_it.id >= 0 \
6734 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6735 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6736 END_CHARPOS, (IT)->w, \
6737 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6741 /* Lookup the char-table Vglyphless_char_display for character C (-1
6742 if we want information for no-font case), and return the display
6743 method symbol. By side-effect, update it->what and
6744 it->glyphless_method. This function is called from
6745 get_next_display_element for each character element, and from
6746 x_produce_glyphs when no suitable font was found. */
6749 lookup_glyphless_char_display (int c
, struct it
*it
)
6751 Lisp_Object glyphless_method
= Qnil
;
6753 if (CHAR_TABLE_P (Vglyphless_char_display
)
6754 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6758 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6759 if (CONSP (glyphless_method
))
6760 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6761 ? XCAR (glyphless_method
)
6762 : XCDR (glyphless_method
);
6765 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6769 if (NILP (glyphless_method
))
6772 /* The default is to display the character by a proper font. */
6774 /* The default for the no-font case is to display an empty box. */
6775 glyphless_method
= Qempty_box
;
6777 if (EQ (glyphless_method
, Qzero_width
))
6780 return glyphless_method
;
6781 /* This method can't be used for the no-font case. */
6782 glyphless_method
= Qempty_box
;
6784 if (EQ (glyphless_method
, Qthin_space
))
6785 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6786 else if (EQ (glyphless_method
, Qempty_box
))
6787 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6788 else if (EQ (glyphless_method
, Qhex_code
))
6789 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6790 else if (STRINGP (glyphless_method
))
6791 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6794 /* Invalid value. We use the default method. */
6795 glyphless_method
= Qnil
;
6798 it
->what
= IT_GLYPHLESS
;
6799 return glyphless_method
;
6802 /* Merge escape glyph face and cache the result. */
6804 static struct frame
*last_escape_glyph_frame
= NULL
;
6805 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6806 static int last_escape_glyph_merged_face_id
= 0;
6809 merge_escape_glyph_face (struct it
*it
)
6813 if (it
->f
== last_escape_glyph_frame
6814 && it
->face_id
== last_escape_glyph_face_id
)
6815 face_id
= last_escape_glyph_merged_face_id
;
6818 /* Merge the `escape-glyph' face into the current face. */
6819 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6820 last_escape_glyph_frame
= it
->f
;
6821 last_escape_glyph_face_id
= it
->face_id
;
6822 last_escape_glyph_merged_face_id
= face_id
;
6827 /* Likewise for glyphless glyph face. */
6829 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6830 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6831 static int last_glyphless_glyph_merged_face_id
= 0;
6834 merge_glyphless_glyph_face (struct it
*it
)
6838 if (it
->f
== last_glyphless_glyph_frame
6839 && it
->face_id
== last_glyphless_glyph_face_id
)
6840 face_id
= last_glyphless_glyph_merged_face_id
;
6843 /* Merge the `glyphless-char' face into the current face. */
6844 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6845 last_glyphless_glyph_frame
= it
->f
;
6846 last_glyphless_glyph_face_id
= it
->face_id
;
6847 last_glyphless_glyph_merged_face_id
= face_id
;
6852 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6853 be called before redisplaying windows, and when the frame's face
6856 forget_escape_and_glyphless_faces (void)
6858 last_escape_glyph_frame
= NULL
;
6859 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6860 last_glyphless_glyph_frame
= NULL
;
6861 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6864 /* Load IT's display element fields with information about the next
6865 display element from the current position of IT. Value is false if
6866 end of buffer (or C string) is reached. */
6869 get_next_display_element (struct it
*it
)
6871 /* True means that we found a display element. False means that
6872 we hit the end of what we iterate over. Performance note: the
6873 function pointer `method' used here turns out to be faster than
6874 using a sequence of if-statements. */
6878 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6880 if (it
->what
== IT_CHARACTER
)
6882 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6883 and only if (a) the resolved directionality of that character
6885 /* FIXME: Do we need an exception for characters from display
6887 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6888 && !inhibit_bidi_mirroring
)
6889 it
->c
= bidi_mirror_char (it
->c
);
6890 /* Map via display table or translate control characters.
6891 IT->c, IT->len etc. have been set to the next character by
6892 the function call above. If we have a display table, and it
6893 contains an entry for IT->c, translate it. Don't do this if
6894 IT->c itself comes from a display table, otherwise we could
6895 end up in an infinite recursion. (An alternative could be to
6896 count the recursion depth of this function and signal an
6897 error when a certain maximum depth is reached.) Is it worth
6899 if (success_p
&& it
->dpvec
== NULL
)
6902 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6903 bool nonascii_space_p
= false;
6904 bool nonascii_hyphen_p
= false;
6905 int c
= it
->c
; /* This is the character to display. */
6907 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6909 eassert (SINGLE_BYTE_CHAR_P (c
));
6910 if (unibyte_display_via_language_environment
)
6912 c
= DECODE_CHAR (unibyte
, c
);
6914 c
= BYTE8_TO_CHAR (it
->c
);
6917 c
= BYTE8_TO_CHAR (it
->c
);
6921 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6924 struct Lisp_Vector
*v
= XVECTOR (dv
);
6926 /* Return the first character from the display table
6927 entry, if not empty. If empty, don't display the
6928 current character. */
6931 it
->dpvec_char_len
= it
->len
;
6932 it
->dpvec
= v
->contents
;
6933 it
->dpend
= v
->contents
+ v
->header
.size
;
6934 it
->current
.dpvec_index
= 0;
6935 it
->dpvec_face_id
= -1;
6936 it
->saved_face_id
= it
->face_id
;
6937 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6938 it
->ellipsis_p
= false;
6942 set_iterator_to_next (it
, false);
6947 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6949 if (it
->what
== IT_GLYPHLESS
)
6951 /* Don't display this character. */
6952 set_iterator_to_next (it
, false);
6956 /* If `nobreak-char-display' is non-nil, we display
6957 non-ASCII spaces and hyphens specially. */
6958 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6960 if (c
== NO_BREAK_SPACE
)
6961 nonascii_space_p
= true;
6962 else if (c
== SOFT_HYPHEN
|| c
== HYPHEN
6963 || c
== NON_BREAKING_HYPHEN
)
6964 nonascii_hyphen_p
= true;
6967 /* Translate control characters into `\003' or `^C' form.
6968 Control characters coming from a display table entry are
6969 currently not translated because we use IT->dpvec to hold
6970 the translation. This could easily be changed but I
6971 don't believe that it is worth doing.
6973 The characters handled by `nobreak-char-display' must be
6976 Non-printable characters and raw-byte characters are also
6977 translated to octal form. */
6978 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6979 ? (it
->area
!= TEXT_AREA
6980 /* In mode line, treat \n, \t like other crl chars. */
6983 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6984 || (c
!= '\n' && c
!= '\t'))
6986 || nonascii_hyphen_p
6988 || ! CHAR_PRINTABLE_P (c
))))
6990 /* C is a control character, non-ASCII space/hyphen,
6991 raw-byte, or a non-printable character which must be
6992 displayed either as '\003' or as `^C' where the '\\'
6993 and '^' can be defined in the display table. Fill
6994 IT->ctl_chars with glyphs for what we have to
6995 display. Then, set IT->dpvec to these glyphs. */
7002 /* Handle control characters with ^. */
7004 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7008 g
= '^'; /* default glyph for Control */
7009 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7011 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7013 g
= GLYPH_CODE_CHAR (gc
);
7014 lface_id
= GLYPH_CODE_FACE (gc
);
7018 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7019 : merge_escape_glyph_face (it
));
7021 XSETINT (it
->ctl_chars
[0], g
);
7022 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7024 goto display_control
;
7027 /* Handle non-ascii space in the mode where it only gets
7030 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7032 /* Merge `nobreak-space' into the current face. */
7033 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7035 XSETINT (it
->ctl_chars
[0], ' ');
7037 goto display_control
;
7040 /* Handle sequences that start with the "escape glyph". */
7042 /* the default escape glyph is \. */
7043 escape_glyph
= '\\';
7046 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7048 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7049 lface_id
= GLYPH_CODE_FACE (gc
);
7053 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7054 : merge_escape_glyph_face (it
));
7056 /* Draw non-ASCII hyphen with just highlighting: */
7058 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7060 XSETINT (it
->ctl_chars
[0], '-');
7062 goto display_control
;
7065 /* Draw non-ASCII space/hyphen with escape glyph: */
7067 if (nonascii_space_p
|| nonascii_hyphen_p
)
7069 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7070 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7072 goto display_control
;
7079 if (CHAR_BYTE8_P (c
))
7080 /* Display \200 instead of \17777600. */
7081 c
= CHAR_TO_BYTE8 (c
);
7082 len
= sprintf (str
, "%03o", c
+ 0u);
7084 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7085 for (i
= 0; i
< len
; i
++)
7086 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7091 /* Set up IT->dpvec and return first character from it. */
7092 it
->dpvec_char_len
= it
->len
;
7093 it
->dpvec
= it
->ctl_chars
;
7094 it
->dpend
= it
->dpvec
+ ctl_len
;
7095 it
->current
.dpvec_index
= 0;
7096 it
->dpvec_face_id
= face_id
;
7097 it
->saved_face_id
= it
->face_id
;
7098 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7099 it
->ellipsis_p
= false;
7102 it
->char_to_display
= c
;
7106 it
->char_to_display
= it
->c
;
7110 #ifdef HAVE_WINDOW_SYSTEM
7111 /* Adjust face id for a multibyte character. There are no multibyte
7112 character in unibyte text. */
7113 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7116 && FRAME_WINDOW_P (it
->f
))
7118 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7120 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7122 /* Automatic composition with glyph-string. */
7123 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7125 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7129 ptrdiff_t pos
= (it
->s
? -1
7130 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7131 : IT_CHARPOS (*it
));
7134 if (it
->what
== IT_CHARACTER
)
7135 c
= it
->char_to_display
;
7138 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7142 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7143 /* TAB in a composition means display glyphs with
7144 padding space on the left or right. */
7145 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7148 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7151 #endif /* HAVE_WINDOW_SYSTEM */
7154 /* Is this character the last one of a run of characters with
7155 box? If yes, set IT->end_of_box_run_p to true. */
7159 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7161 int face_id
= underlying_face_id (it
);
7162 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7166 if (face
->box
== FACE_NO_BOX
)
7168 /* If the box comes from face properties in a
7169 display string, check faces in that string. */
7170 int string_face_id
= face_after_it_pos (it
);
7171 it
->end_of_box_run_p
7172 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7175 /* Otherwise, the box comes from the underlying face.
7176 If this is the last string character displayed, check
7177 the next buffer location. */
7178 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7179 /* n_overlay_strings is unreliable unless
7180 overlay_string_index is non-negative. */
7181 && ((it
->current
.overlay_string_index
>= 0
7182 && (it
->current
.overlay_string_index
7183 == it
->n_overlay_strings
- 1))
7184 /* A string from display property. */
7185 || it
->from_disp_prop_p
))
7189 struct text_pos pos
= it
->current
.pos
;
7191 /* For a string from a display property, the next
7192 buffer position is stored in the 'position'
7193 member of the iteration stack slot below the
7194 current one, see handle_single_display_spec. By
7195 contrast, it->current.pos was is not yet updated
7196 to point to that buffer position; that will
7197 happen in pop_it, after we finish displaying the
7198 current string. Note that we already checked
7199 above that it->sp is positive, so subtracting one
7201 if (it
->from_disp_prop_p
)
7202 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7204 INC_TEXT_POS (pos
, it
->multibyte_p
);
7206 if (CHARPOS (pos
) >= ZV
)
7207 it
->end_of_box_run_p
= true;
7210 next_face_id
= face_at_buffer_position
7211 (it
->w
, CHARPOS (pos
), &ignore
,
7212 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, false, -1);
7213 it
->end_of_box_run_p
7214 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7220 /* next_element_from_display_vector sets this flag according to
7221 faces of the display vector glyphs, see there. */
7222 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7224 int face_id
= face_after_it_pos (it
);
7225 it
->end_of_box_run_p
7226 = (face_id
!= it
->face_id
7227 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7230 /* If we reached the end of the object we've been iterating (e.g., a
7231 display string or an overlay string), and there's something on
7232 IT->stack, proceed with what's on the stack. It doesn't make
7233 sense to return false if there's unprocessed stuff on the stack,
7234 because otherwise that stuff will never be displayed. */
7235 if (!success_p
&& it
->sp
> 0)
7237 set_iterator_to_next (it
, false);
7238 success_p
= get_next_display_element (it
);
7241 /* Value is false if end of buffer or string reached. */
7246 /* Move IT to the next display element.
7248 RESEAT_P means if called on a newline in buffer text,
7249 skip to the next visible line start.
7251 Functions get_next_display_element and set_iterator_to_next are
7252 separate because I find this arrangement easier to handle than a
7253 get_next_display_element function that also increments IT's
7254 position. The way it is we can first look at an iterator's current
7255 display element, decide whether it fits on a line, and if it does,
7256 increment the iterator position. The other way around we probably
7257 would either need a flag indicating whether the iterator has to be
7258 incremented the next time, or we would have to implement a
7259 decrement position function which would not be easy to write. */
7262 set_iterator_to_next (struct it
*it
, bool reseat_p
)
7264 /* Reset flags indicating start and end of a sequence of characters
7265 with box. Reset them at the start of this function because
7266 moving the iterator to a new position might set them. */
7267 it
->start_of_box_run_p
= it
->end_of_box_run_p
= false;
7271 case GET_FROM_BUFFER
:
7272 /* The current display element of IT is a character from
7273 current_buffer. Advance in the buffer, and maybe skip over
7274 invisible lines that are so because of selective display. */
7275 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7276 reseat_at_next_visible_line_start (it
, false);
7277 else if (it
->cmp_it
.id
>= 0)
7279 /* We are currently getting glyphs from a composition. */
7282 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7283 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7289 /* Update IT's char/byte positions to point to the first
7290 character of the next grapheme cluster, or to the
7291 character visually after the current composition. */
7292 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7293 bidi_move_to_visually_next (&it
->bidi_it
);
7294 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7295 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7298 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7299 && it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7301 /* Composition created while scanning forward. Proceed
7302 to the next grapheme cluster. */
7303 it
->cmp_it
.from
= it
->cmp_it
.to
;
7305 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7306 && it
->cmp_it
.from
> 0)
7308 /* Composition created while scanning backward. Proceed
7309 to the previous grapheme cluster. */
7310 it
->cmp_it
.to
= it
->cmp_it
.from
;
7314 /* No more grapheme clusters in this composition.
7315 Find the next stop position. */
7316 ptrdiff_t stop
= it
->end_charpos
;
7318 if (it
->bidi_it
.scan_dir
< 0)
7319 /* Now we are scanning backward and don't know
7322 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7323 IT_BYTEPOS (*it
), stop
, Qnil
);
7328 eassert (it
->len
!= 0);
7332 IT_BYTEPOS (*it
) += it
->len
;
7333 IT_CHARPOS (*it
) += 1;
7337 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7338 /* If this is a new paragraph, determine its base
7339 direction (a.k.a. its base embedding level). */
7340 if (it
->bidi_it
.new_paragraph
)
7341 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
7343 bidi_move_to_visually_next (&it
->bidi_it
);
7344 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7345 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7346 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7348 /* As the scan direction was changed, we must
7349 re-compute the stop position for composition. */
7350 ptrdiff_t stop
= it
->end_charpos
;
7351 if (it
->bidi_it
.scan_dir
< 0)
7353 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7354 IT_BYTEPOS (*it
), stop
, Qnil
);
7357 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7361 case GET_FROM_C_STRING
:
7362 /* Current display element of IT is from a C string. */
7364 /* If the string position is beyond string's end, it means
7365 next_element_from_c_string is padding the string with
7366 blanks, in which case we bypass the bidi iterator,
7367 because it cannot deal with such virtual characters. */
7368 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7370 IT_BYTEPOS (*it
) += it
->len
;
7371 IT_CHARPOS (*it
) += 1;
7375 bidi_move_to_visually_next (&it
->bidi_it
);
7376 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7377 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7381 case GET_FROM_DISPLAY_VECTOR
:
7382 /* Current display element of IT is from a display table entry.
7383 Advance in the display table definition. Reset it to null if
7384 end reached, and continue with characters from buffers/
7386 ++it
->current
.dpvec_index
;
7388 /* Restore face of the iterator to what they were before the
7389 display vector entry (these entries may contain faces). */
7390 it
->face_id
= it
->saved_face_id
;
7392 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7394 bool recheck_faces
= it
->ellipsis_p
;
7397 it
->method
= GET_FROM_C_STRING
;
7398 else if (STRINGP (it
->string
))
7399 it
->method
= GET_FROM_STRING
;
7402 it
->method
= GET_FROM_BUFFER
;
7403 it
->object
= it
->w
->contents
;
7407 it
->current
.dpvec_index
= -1;
7409 /* Skip over characters which were displayed via IT->dpvec. */
7410 if (it
->dpvec_char_len
< 0)
7411 reseat_at_next_visible_line_start (it
, true);
7412 else if (it
->dpvec_char_len
> 0)
7414 it
->len
= it
->dpvec_char_len
;
7415 set_iterator_to_next (it
, reseat_p
);
7418 /* Maybe recheck faces after display vector. */
7421 if (it
->method
== GET_FROM_STRING
)
7422 it
->stop_charpos
= IT_STRING_CHARPOS (*it
);
7424 it
->stop_charpos
= IT_CHARPOS (*it
);
7429 case GET_FROM_STRING
:
7430 /* Current display element is a character from a Lisp string. */
7431 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7432 /* Don't advance past string end. These conditions are true
7433 when set_iterator_to_next is called at the end of
7434 get_next_display_element, in which case the Lisp string is
7435 already exhausted, and all we want is pop the iterator
7437 if (it
->current
.overlay_string_index
>= 0)
7439 /* This is an overlay string, so there's no padding with
7440 spaces, and the number of characters in the string is
7441 where the string ends. */
7442 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7443 goto consider_string_end
;
7447 /* Not an overlay string. There could be padding, so test
7448 against it->end_charpos. */
7449 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7450 goto consider_string_end
;
7452 if (it
->cmp_it
.id
>= 0)
7454 /* We are delivering display elements from a composition.
7455 Update the string position past the grapheme cluster
7456 we've just processed. */
7459 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7460 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7466 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7467 bidi_move_to_visually_next (&it
->bidi_it
);
7468 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7469 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7472 /* Did we exhaust all the grapheme clusters of this
7474 if ((! it
->bidi_p
|| ! it
->cmp_it
.reversed_p
)
7475 && (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
))
7477 /* Not all the grapheme clusters were processed yet;
7478 advance to the next cluster. */
7479 it
->cmp_it
.from
= it
->cmp_it
.to
;
7481 else if ((it
->bidi_p
&& it
->cmp_it
.reversed_p
)
7482 && it
->cmp_it
.from
> 0)
7484 /* Likewise: advance to the next cluster, but going in
7485 the reverse direction. */
7486 it
->cmp_it
.to
= it
->cmp_it
.from
;
7490 /* This composition was fully processed; find the next
7491 candidate place for checking for composed
7493 /* Always limit string searches to the string length;
7494 any padding spaces are not part of the string, and
7495 there cannot be any compositions in that padding. */
7496 ptrdiff_t stop
= SCHARS (it
->string
);
7498 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
7500 else if (it
->end_charpos
< stop
)
7502 /* Cf. PRECISION in reseat_to_string: we might be
7503 limited in how many of the string characters we
7505 stop
= it
->end_charpos
;
7507 composition_compute_stop_pos (&it
->cmp_it
,
7508 IT_STRING_CHARPOS (*it
),
7509 IT_STRING_BYTEPOS (*it
), stop
,
7516 /* If the string position is beyond string's end, it
7517 means next_element_from_string is padding the string
7518 with blanks, in which case we bypass the bidi
7519 iterator, because it cannot deal with such virtual
7521 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7523 IT_STRING_BYTEPOS (*it
) += it
->len
;
7524 IT_STRING_CHARPOS (*it
) += 1;
7528 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7530 bidi_move_to_visually_next (&it
->bidi_it
);
7531 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7532 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7533 /* If the scan direction changes, we may need to update
7534 the place where to check for composed characters. */
7535 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7537 ptrdiff_t stop
= SCHARS (it
->string
);
7539 if (it
->bidi_it
.scan_dir
< 0)
7541 else if (it
->end_charpos
< stop
)
7542 stop
= it
->end_charpos
;
7544 composition_compute_stop_pos (&it
->cmp_it
,
7545 IT_STRING_CHARPOS (*it
),
7546 IT_STRING_BYTEPOS (*it
), stop
,
7552 consider_string_end
:
7554 if (it
->current
.overlay_string_index
>= 0)
7556 /* IT->string is an overlay string. Advance to the
7557 next, if there is one. */
7558 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7560 it
->ellipsis_p
= false;
7561 next_overlay_string (it
);
7563 setup_for_ellipsis (it
, 0);
7568 /* IT->string is not an overlay string. If we reached
7569 its end, and there is something on IT->stack, proceed
7570 with what is on the stack. This can be either another
7571 string, this time an overlay string, or a buffer. */
7572 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7576 if (it
->method
== GET_FROM_STRING
)
7577 goto consider_string_end
;
7582 case GET_FROM_IMAGE
:
7583 case GET_FROM_STRETCH
:
7584 /* The position etc with which we have to proceed are on
7585 the stack. The position may be at the end of a string,
7586 if the `display' property takes up the whole string. */
7587 eassert (it
->sp
> 0);
7589 if (it
->method
== GET_FROM_STRING
)
7590 goto consider_string_end
;
7594 /* There are no other methods defined, so this should be a bug. */
7598 eassert (it
->method
!= GET_FROM_STRING
7599 || (STRINGP (it
->string
)
7600 && IT_STRING_CHARPOS (*it
) >= 0));
7603 /* Load IT's display element fields with information about the next
7604 display element which comes from a display table entry or from the
7605 result of translating a control character to one of the forms `^C'
7608 IT->dpvec holds the glyphs to return as characters.
7609 IT->saved_face_id holds the face id before the display vector--it
7610 is restored into IT->face_id in set_iterator_to_next. */
7613 next_element_from_display_vector (struct it
*it
)
7616 int prev_face_id
= it
->face_id
;
7620 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7622 it
->face_id
= it
->saved_face_id
;
7624 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7625 That seemed totally bogus - so I changed it... */
7626 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7628 if (GLYPH_CODE_P (gc
))
7630 struct face
*this_face
, *prev_face
, *next_face
;
7632 it
->c
= GLYPH_CODE_CHAR (gc
);
7633 it
->len
= CHAR_BYTES (it
->c
);
7635 /* The entry may contain a face id to use. Such a face id is
7636 the id of a Lisp face, not a realized face. A face id of
7637 zero means no face is specified. */
7638 if (it
->dpvec_face_id
>= 0)
7639 it
->face_id
= it
->dpvec_face_id
;
7642 int lface_id
= GLYPH_CODE_FACE (gc
);
7644 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7648 /* Glyphs in the display vector could have the box face, so we
7649 need to set the related flags in the iterator, as
7651 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7652 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7654 /* Is this character the first character of a box-face run? */
7655 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7657 || prev_face
->box
== FACE_NO_BOX
));
7659 /* For the last character of the box-face run, we need to look
7660 either at the next glyph from the display vector, or at the
7661 face we saw before the display vector. */
7662 next_face_id
= it
->saved_face_id
;
7663 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7665 if (it
->dpvec_face_id
>= 0)
7666 next_face_id
= it
->dpvec_face_id
;
7670 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7673 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7677 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7678 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7680 || next_face
->box
== FACE_NO_BOX
));
7681 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7684 /* Display table entry is invalid. Return a space. */
7685 it
->c
= ' ', it
->len
= 1;
7687 /* Don't change position and object of the iterator here. They are
7688 still the values of the character that had this display table
7689 entry or was translated, and that's what we want. */
7690 it
->what
= IT_CHARACTER
;
7694 /* Get the first element of string/buffer in the visual order, after
7695 being reseated to a new position in a string or a buffer. */
7697 get_visually_first_element (struct it
*it
)
7699 bool string_p
= STRINGP (it
->string
) || it
->s
;
7700 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7701 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7703 if (STRINGP (it
->string
))
7705 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7706 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7710 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7711 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7714 if (it
->bidi_it
.charpos
== eob
)
7716 /* Nothing to do, but reset the FIRST_ELT flag, like
7717 bidi_paragraph_init does, because we are not going to
7719 it
->bidi_it
.first_elt
= false;
7721 else if (it
->bidi_it
.charpos
== bob
7723 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7724 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7726 /* If we are at the beginning of a line/string, we can produce
7727 the next element right away. */
7728 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7729 bidi_move_to_visually_next (&it
->bidi_it
);
7733 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7735 /* We need to prime the bidi iterator starting at the line's or
7736 string's beginning, before we will be able to produce the
7739 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7741 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7742 IT_BYTEPOS (*it
), -1,
7743 &it
->bidi_it
.bytepos
);
7744 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, true);
7747 /* Now return to buffer/string position where we were asked
7748 to get the next display element, and produce that. */
7749 bidi_move_to_visually_next (&it
->bidi_it
);
7751 while (it
->bidi_it
.bytepos
!= orig_bytepos
7752 && it
->bidi_it
.charpos
< eob
);
7755 /* Adjust IT's position information to where we ended up. */
7756 if (STRINGP (it
->string
))
7758 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7759 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7763 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7764 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7767 if (STRINGP (it
->string
) || !it
->s
)
7769 ptrdiff_t stop
, charpos
, bytepos
;
7771 if (STRINGP (it
->string
))
7774 stop
= SCHARS (it
->string
);
7775 if (stop
> it
->end_charpos
)
7776 stop
= it
->end_charpos
;
7777 charpos
= IT_STRING_CHARPOS (*it
);
7778 bytepos
= IT_STRING_BYTEPOS (*it
);
7782 stop
= it
->end_charpos
;
7783 charpos
= IT_CHARPOS (*it
);
7784 bytepos
= IT_BYTEPOS (*it
);
7786 if (it
->bidi_it
.scan_dir
< 0)
7788 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7793 /* Load IT with the next display element from Lisp string IT->string.
7794 IT->current.string_pos is the current position within the string.
7795 If IT->current.overlay_string_index >= 0, the Lisp string is an
7799 next_element_from_string (struct it
*it
)
7801 struct text_pos position
;
7803 eassert (STRINGP (it
->string
));
7804 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7805 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7806 position
= it
->current
.string_pos
;
7808 /* With bidi reordering, the character to display might not be the
7809 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7810 that we were reseat()ed to a new string, whose paragraph
7811 direction is not known. */
7812 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7814 get_visually_first_element (it
);
7815 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7818 /* Time to check for invisible text? */
7819 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7821 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7824 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7825 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7827 /* With bidi non-linear iteration, we could find
7828 ourselves far beyond the last computed stop_charpos,
7829 with several other stop positions in between that we
7830 missed. Scan them all now, in buffer's logical
7831 order, until we find and handle the last stop_charpos
7832 that precedes our current position. */
7833 handle_stop_backwards (it
, it
->stop_charpos
);
7834 return GET_NEXT_DISPLAY_ELEMENT (it
);
7840 /* Take note of the stop position we just moved
7841 across, for when we will move back across it. */
7842 it
->prev_stop
= it
->stop_charpos
;
7843 /* If we are at base paragraph embedding level, take
7844 note of the last stop position seen at this
7846 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7847 it
->base_level_stop
= it
->stop_charpos
;
7851 /* Since a handler may have changed IT->method, we must
7853 return GET_NEXT_DISPLAY_ELEMENT (it
);
7857 /* If we are before prev_stop, we may have overstepped
7858 on our way backwards a stop_pos, and if so, we need
7859 to handle that stop_pos. */
7860 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7861 /* We can sometimes back up for reasons that have nothing
7862 to do with bidi reordering. E.g., compositions. The
7863 code below is only needed when we are above the base
7864 embedding level, so test for that explicitly. */
7865 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7867 /* If we lost track of base_level_stop, we have no better
7868 place for handle_stop_backwards to start from than string
7869 beginning. This happens, e.g., when we were reseated to
7870 the previous screenful of text by vertical-motion. */
7871 if (it
->base_level_stop
<= 0
7872 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7873 it
->base_level_stop
= 0;
7874 handle_stop_backwards (it
, it
->base_level_stop
);
7875 return GET_NEXT_DISPLAY_ELEMENT (it
);
7879 if (it
->current
.overlay_string_index
>= 0)
7881 /* Get the next character from an overlay string. In overlay
7882 strings, there is no field width or padding with spaces to
7884 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7889 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7890 IT_STRING_BYTEPOS (*it
),
7891 it
->bidi_it
.scan_dir
< 0
7893 : SCHARS (it
->string
))
7894 && next_element_from_composition (it
))
7898 else if (STRING_MULTIBYTE (it
->string
))
7900 const unsigned char *s
= (SDATA (it
->string
)
7901 + IT_STRING_BYTEPOS (*it
));
7902 it
->c
= string_char_and_length (s
, &it
->len
);
7906 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7912 /* Get the next character from a Lisp string that is not an
7913 overlay string. Such strings come from the mode line, for
7914 example. We may have to pad with spaces, or truncate the
7915 string. See also next_element_from_c_string. */
7916 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7921 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7923 /* Pad with spaces. */
7924 it
->c
= ' ', it
->len
= 1;
7925 CHARPOS (position
) = BYTEPOS (position
) = -1;
7927 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7928 IT_STRING_BYTEPOS (*it
),
7929 it
->bidi_it
.scan_dir
< 0
7931 : it
->string_nchars
)
7932 && next_element_from_composition (it
))
7936 else if (STRING_MULTIBYTE (it
->string
))
7938 const unsigned char *s
= (SDATA (it
->string
)
7939 + IT_STRING_BYTEPOS (*it
));
7940 it
->c
= string_char_and_length (s
, &it
->len
);
7944 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7949 /* Record what we have and where it came from. */
7950 it
->what
= IT_CHARACTER
;
7951 it
->object
= it
->string
;
7952 it
->position
= position
;
7957 /* Load IT with next display element from C string IT->s.
7958 IT->string_nchars is the maximum number of characters to return
7959 from the string. IT->end_charpos may be greater than
7960 IT->string_nchars when this function is called, in which case we
7961 may have to return padding spaces. Value is false if end of string
7962 reached, including padding spaces. */
7965 next_element_from_c_string (struct it
*it
)
7967 bool success_p
= true;
7970 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7971 it
->what
= IT_CHARACTER
;
7972 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7973 it
->object
= make_number (0);
7975 /* With bidi reordering, the character to display might not be the
7976 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
7977 we were reseated to a new string, whose paragraph direction is
7979 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7980 get_visually_first_element (it
);
7982 /* IT's position can be greater than IT->string_nchars in case a
7983 field width or precision has been specified when the iterator was
7985 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7987 /* End of the game. */
7991 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7993 /* Pad with spaces. */
7994 it
->c
= ' ', it
->len
= 1;
7995 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7997 else if (it
->multibyte_p
)
7998 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8000 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8006 /* Set up IT to return characters from an ellipsis, if appropriate.
8007 The definition of the ellipsis glyphs may come from a display table
8008 entry. This function fills IT with the first glyph from the
8009 ellipsis if an ellipsis is to be displayed. */
8012 next_element_from_ellipsis (struct it
*it
)
8014 if (it
->selective_display_ellipsis_p
)
8015 setup_for_ellipsis (it
, it
->len
);
8018 /* The face at the current position may be different from the
8019 face we find after the invisible text. Remember what it
8020 was in IT->saved_face_id, and signal that it's there by
8021 setting face_before_selective_p. */
8022 it
->saved_face_id
= it
->face_id
;
8023 it
->method
= GET_FROM_BUFFER
;
8024 it
->object
= it
->w
->contents
;
8025 reseat_at_next_visible_line_start (it
, true);
8026 it
->face_before_selective_p
= true;
8029 return GET_NEXT_DISPLAY_ELEMENT (it
);
8033 /* Deliver an image display element. The iterator IT is already
8034 filled with image information (done in handle_display_prop). Value
8039 next_element_from_image (struct it
*it
)
8041 it
->what
= IT_IMAGE
;
8046 /* Fill iterator IT with next display element from a stretch glyph
8047 property. IT->object is the value of the text property. Value is
8051 next_element_from_stretch (struct it
*it
)
8053 it
->what
= IT_STRETCH
;
8057 /* Scan backwards from IT's current position until we find a stop
8058 position, or until BEGV. This is called when we find ourself
8059 before both the last known prev_stop and base_level_stop while
8060 reordering bidirectional text. */
8063 compute_stop_pos_backwards (struct it
*it
)
8065 const int SCAN_BACK_LIMIT
= 1000;
8066 struct text_pos pos
;
8067 struct display_pos save_current
= it
->current
;
8068 struct text_pos save_position
= it
->position
;
8069 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8070 ptrdiff_t where_we_are
= charpos
;
8071 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8072 ptrdiff_t save_end_pos
= it
->end_charpos
;
8074 eassert (NILP (it
->string
) && !it
->s
);
8075 eassert (it
->bidi_p
);
8079 it
->end_charpos
= min (charpos
+ 1, ZV
);
8080 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8081 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8082 reseat_1 (it
, pos
, false);
8083 compute_stop_pos (it
);
8084 /* We must advance forward, right? */
8085 if (it
->stop_charpos
<= charpos
)
8088 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8090 if (it
->stop_charpos
<= where_we_are
)
8091 it
->prev_stop
= it
->stop_charpos
;
8093 it
->prev_stop
= BEGV
;
8095 it
->current
= save_current
;
8096 it
->position
= save_position
;
8097 it
->stop_charpos
= save_stop_pos
;
8098 it
->end_charpos
= save_end_pos
;
8101 /* Scan forward from CHARPOS in the current buffer/string, until we
8102 find a stop position > current IT's position. Then handle the stop
8103 position before that. This is called when we bump into a stop
8104 position while reordering bidirectional text. CHARPOS should be
8105 the last previously processed stop_pos (or BEGV/0, if none were
8106 processed yet) whose position is less that IT's current
8110 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8112 bool bufp
= !STRINGP (it
->string
);
8113 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8114 struct display_pos save_current
= it
->current
;
8115 struct text_pos save_position
= it
->position
;
8116 struct text_pos pos1
;
8117 ptrdiff_t next_stop
;
8119 /* Scan in strict logical order. */
8120 eassert (it
->bidi_p
);
8124 it
->prev_stop
= charpos
;
8127 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8128 reseat_1 (it
, pos1
, false);
8131 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8132 compute_stop_pos (it
);
8133 /* We must advance forward, right? */
8134 if (it
->stop_charpos
<= it
->prev_stop
)
8136 charpos
= it
->stop_charpos
;
8138 while (charpos
<= where_we_are
);
8141 it
->current
= save_current
;
8142 it
->position
= save_position
;
8143 next_stop
= it
->stop_charpos
;
8144 it
->stop_charpos
= it
->prev_stop
;
8146 it
->stop_charpos
= next_stop
;
8149 /* Load IT with the next display element from current_buffer. Value
8150 is false if end of buffer reached. IT->stop_charpos is the next
8151 position at which to stop and check for text properties or buffer
8155 next_element_from_buffer (struct it
*it
)
8157 bool success_p
= true;
8159 eassert (IT_CHARPOS (*it
) >= BEGV
);
8160 eassert (NILP (it
->string
) && !it
->s
);
8161 eassert (!it
->bidi_p
8162 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8163 && it
->bidi_it
.string
.s
== NULL
));
8165 /* With bidi reordering, the character to display might not be the
8166 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8167 we were reseat()ed to a new buffer position, which is potentially
8168 a different paragraph. */
8169 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8171 get_visually_first_element (it
);
8172 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8175 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8177 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8179 bool overlay_strings_follow_p
;
8181 /* End of the game, except when overlay strings follow that
8182 haven't been returned yet. */
8183 if (it
->overlay_strings_at_end_processed_p
)
8184 overlay_strings_follow_p
= false;
8187 it
->overlay_strings_at_end_processed_p
= true;
8188 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8191 if (overlay_strings_follow_p
)
8192 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8196 it
->position
= it
->current
.pos
;
8200 else if (!(!it
->bidi_p
8201 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8202 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8204 /* With bidi non-linear iteration, we could find ourselves
8205 far beyond the last computed stop_charpos, with several
8206 other stop positions in between that we missed. Scan
8207 them all now, in buffer's logical order, until we find
8208 and handle the last stop_charpos that precedes our
8209 current position. */
8210 handle_stop_backwards (it
, it
->stop_charpos
);
8211 it
->ignore_overlay_strings_at_pos_p
= false;
8212 return GET_NEXT_DISPLAY_ELEMENT (it
);
8218 /* Take note of the stop position we just moved across,
8219 for when we will move back across it. */
8220 it
->prev_stop
= it
->stop_charpos
;
8221 /* If we are at base paragraph embedding level, take
8222 note of the last stop position seen at this
8224 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8225 it
->base_level_stop
= it
->stop_charpos
;
8228 it
->ignore_overlay_strings_at_pos_p
= false;
8229 return GET_NEXT_DISPLAY_ELEMENT (it
);
8233 /* If we are before prev_stop, we may have overstepped on
8234 our way backwards a stop_pos, and if so, we need to
8235 handle that stop_pos. */
8236 && IT_CHARPOS (*it
) < it
->prev_stop
8237 /* We can sometimes back up for reasons that have nothing
8238 to do with bidi reordering. E.g., compositions. The
8239 code below is only needed when we are above the base
8240 embedding level, so test for that explicitly. */
8241 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8243 if (it
->base_level_stop
<= 0
8244 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8246 /* If we lost track of base_level_stop, we need to find
8247 prev_stop by looking backwards. This happens, e.g., when
8248 we were reseated to the previous screenful of text by
8250 it
->base_level_stop
= BEGV
;
8251 compute_stop_pos_backwards (it
);
8252 handle_stop_backwards (it
, it
->prev_stop
);
8255 handle_stop_backwards (it
, it
->base_level_stop
);
8256 it
->ignore_overlay_strings_at_pos_p
= false;
8257 return GET_NEXT_DISPLAY_ELEMENT (it
);
8261 /* No face changes, overlays etc. in sight, so just return a
8262 character from current_buffer. */
8266 /* We moved to the next buffer position, so any info about
8267 previously seen overlays is no longer valid. */
8268 it
->ignore_overlay_strings_at_pos_p
= false;
8270 /* Maybe run the redisplay end trigger hook. Performance note:
8271 This doesn't seem to cost measurable time. */
8272 if (it
->redisplay_end_trigger_charpos
8274 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8275 run_redisplay_end_trigger_hook (it
);
8277 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8278 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8280 && next_element_from_composition (it
))
8285 /* Get the next character, maybe multibyte. */
8286 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8287 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8288 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8290 it
->c
= *p
, it
->len
= 1;
8292 /* Record what we have and where it came from. */
8293 it
->what
= IT_CHARACTER
;
8294 it
->object
= it
->w
->contents
;
8295 it
->position
= it
->current
.pos
;
8297 /* Normally we return the character found above, except when we
8298 really want to return an ellipsis for selective display. */
8303 /* A value of selective > 0 means hide lines indented more
8304 than that number of columns. */
8305 if (it
->selective
> 0
8306 && IT_CHARPOS (*it
) + 1 < ZV
8307 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8308 IT_BYTEPOS (*it
) + 1,
8311 success_p
= next_element_from_ellipsis (it
);
8312 it
->dpvec_char_len
= -1;
8315 else if (it
->c
== '\r' && it
->selective
== -1)
8317 /* A value of selective == -1 means that everything from the
8318 CR to the end of the line is invisible, with maybe an
8319 ellipsis displayed for it. */
8320 success_p
= next_element_from_ellipsis (it
);
8321 it
->dpvec_char_len
= -1;
8326 /* Value is false if end of buffer reached. */
8327 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8332 /* Run the redisplay end trigger hook for IT. */
8335 run_redisplay_end_trigger_hook (struct it
*it
)
8337 /* IT->glyph_row should be non-null, i.e. we should be actually
8338 displaying something, or otherwise we should not run the hook. */
8339 eassert (it
->glyph_row
);
8341 ptrdiff_t charpos
= it
->redisplay_end_trigger_charpos
;
8342 it
->redisplay_end_trigger_charpos
= 0;
8344 /* Since we are *trying* to run these functions, don't try to run
8345 them again, even if they get an error. */
8346 wset_redisplay_end_trigger (it
->w
, Qnil
);
8347 CALLN (Frun_hook_with_args
, Qredisplay_end_trigger_functions
, it
->window
,
8348 make_number (charpos
));
8350 /* Notice if it changed the face of the character we are on. */
8351 handle_face_prop (it
);
8355 /* Deliver a composition display element. Unlike the other
8356 next_element_from_XXX, this function is not registered in the array
8357 get_next_element[]. It is called from next_element_from_buffer and
8358 next_element_from_string when necessary. */
8361 next_element_from_composition (struct it
*it
)
8363 it
->what
= IT_COMPOSITION
;
8364 it
->len
= it
->cmp_it
.nbytes
;
8365 if (STRINGP (it
->string
))
8369 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8370 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8373 it
->position
= it
->current
.string_pos
;
8374 it
->object
= it
->string
;
8375 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8376 IT_STRING_BYTEPOS (*it
), it
->string
);
8382 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8383 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8386 if (it
->bidi_it
.new_paragraph
)
8387 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
,
8389 /* Resync the bidi iterator with IT's new position.
8390 FIXME: this doesn't support bidirectional text. */
8391 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8392 bidi_move_to_visually_next (&it
->bidi_it
);
8396 it
->position
= it
->current
.pos
;
8397 it
->object
= it
->w
->contents
;
8398 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8399 IT_BYTEPOS (*it
), Qnil
);
8406 /***********************************************************************
8407 Moving an iterator without producing glyphs
8408 ***********************************************************************/
8410 /* Check if iterator is at a position corresponding to a valid buffer
8411 position after some move_it_ call. */
8413 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8414 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8417 /* Move iterator IT to a specified buffer or X position within one
8418 line on the display without producing glyphs.
8420 OP should be a bit mask including some or all of these bits:
8421 MOVE_TO_X: Stop upon reaching x-position TO_X.
8422 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8423 Regardless of OP's value, stop upon reaching the end of the display line.
8425 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8426 This means, in particular, that TO_X includes window's horizontal
8429 The return value has several possible values that
8430 say what condition caused the scan to stop:
8432 MOVE_POS_MATCH_OR_ZV
8433 - when TO_POS or ZV was reached.
8436 -when TO_X was reached before TO_POS or ZV were reached.
8439 - when we reached the end of the display area and the line must
8443 - when we reached the end of the display area and the line is
8447 - when we stopped at a line end, i.e. a newline or a CR and selective
8450 static enum move_it_result
8451 move_it_in_display_line_to (struct it
*it
,
8452 ptrdiff_t to_charpos
, int to_x
,
8453 enum move_operation_enum op
)
8455 enum move_it_result result
= MOVE_UNDEFINED
;
8456 struct glyph_row
*saved_glyph_row
;
8457 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8458 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8459 void *ppos_data
= NULL
;
8460 bool may_wrap
= false;
8461 enum it_method prev_method
= it
->method
;
8462 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8463 bool saw_smaller_pos
= prev_pos
< to_charpos
;
8465 /* Don't produce glyphs in produce_glyphs. */
8466 saved_glyph_row
= it
->glyph_row
;
8467 it
->glyph_row
= NULL
;
8469 /* Use wrap_it to save a copy of IT wherever a word wrap could
8470 occur. Use atpos_it to save a copy of IT at the desired buffer
8471 position, if found, so that we can scan ahead and check if the
8472 word later overshoots the window edge. Use atx_it similarly, for
8478 /* Use ppos_it under bidi reordering to save a copy of IT for the
8479 initial position. We restore that position in IT when we have
8480 scanned the entire display line without finding a match for
8481 TO_CHARPOS and all the character positions are greater than
8482 TO_CHARPOS. We then restart the scan from the initial position,
8483 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8484 the closest to TO_CHARPOS. */
8487 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8489 SAVE_IT (ppos_it
, *it
, ppos_data
);
8490 closest_pos
= IT_CHARPOS (*it
);
8496 #define BUFFER_POS_REACHED_P() \
8497 ((op & MOVE_TO_POS) != 0 \
8498 && BUFFERP (it->object) \
8499 && (IT_CHARPOS (*it) == to_charpos \
8501 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8502 && IT_CHARPOS (*it) > to_charpos) \
8503 || (it->what == IT_COMPOSITION \
8504 && ((IT_CHARPOS (*it) > to_charpos \
8505 && to_charpos >= it->cmp_it.charpos) \
8506 || (IT_CHARPOS (*it) < to_charpos \
8507 && to_charpos <= it->cmp_it.charpos)))) \
8508 && (it->method == GET_FROM_BUFFER \
8509 || (it->method == GET_FROM_DISPLAY_VECTOR \
8510 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8512 /* If there's a line-/wrap-prefix, handle it. */
8513 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8514 && it
->current_y
< it
->last_visible_y
)
8515 handle_line_prefix (it
);
8517 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8518 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8522 int x
, i
, ascent
= 0, descent
= 0;
8524 /* Utility macro to reset an iterator with x, ascent, and descent. */
8525 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8526 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8527 (IT)->max_descent = descent)
8529 /* Stop if we move beyond TO_CHARPOS (after an image or a
8530 display string or stretch glyph). */
8531 if ((op
& MOVE_TO_POS
) != 0
8532 && BUFFERP (it
->object
)
8533 && it
->method
== GET_FROM_BUFFER
8535 /* When the iterator is at base embedding level, we
8536 are guaranteed that characters are delivered for
8537 display in strictly increasing order of their
8538 buffer positions. */
8539 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8540 && IT_CHARPOS (*it
) > to_charpos
)
8542 && (prev_method
== GET_FROM_IMAGE
8543 || prev_method
== GET_FROM_STRETCH
8544 || prev_method
== GET_FROM_STRING
)
8545 /* Passed TO_CHARPOS from left to right. */
8546 && ((prev_pos
< to_charpos
8547 && IT_CHARPOS (*it
) > to_charpos
)
8548 /* Passed TO_CHARPOS from right to left. */
8549 || (prev_pos
> to_charpos
8550 && IT_CHARPOS (*it
) < to_charpos
)))))
8552 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8554 result
= MOVE_POS_MATCH_OR_ZV
;
8557 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8558 /* If wrap_it is valid, the current position might be in a
8559 word that is wrapped. So, save the iterator in
8560 atpos_it and continue to see if wrapping happens. */
8561 SAVE_IT (atpos_it
, *it
, atpos_data
);
8564 /* Stop when ZV reached.
8565 We used to stop here when TO_CHARPOS reached as well, but that is
8566 too soon if this glyph does not fit on this line. So we handle it
8567 explicitly below. */
8568 if (!get_next_display_element (it
))
8570 result
= MOVE_POS_MATCH_OR_ZV
;
8574 if (it
->line_wrap
== TRUNCATE
)
8576 if (BUFFER_POS_REACHED_P ())
8578 result
= MOVE_POS_MATCH_OR_ZV
;
8584 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8586 if (IT_DISPLAYING_WHITESPACE (it
))
8590 /* We have reached a glyph that follows one or more
8591 whitespace characters. If the position is
8592 already found, we are done. */
8593 if (atpos_it
.sp
>= 0)
8595 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8596 result
= MOVE_POS_MATCH_OR_ZV
;
8601 RESTORE_IT (it
, &atx_it
, atx_data
);
8602 result
= MOVE_X_REACHED
;
8605 /* Otherwise, we can wrap here. */
8606 SAVE_IT (wrap_it
, *it
, wrap_data
);
8612 /* Remember the line height for the current line, in case
8613 the next element doesn't fit on the line. */
8614 ascent
= it
->max_ascent
;
8615 descent
= it
->max_descent
;
8617 /* The call to produce_glyphs will get the metrics of the
8618 display element IT is loaded with. Record the x-position
8619 before this display element, in case it doesn't fit on the
8623 PRODUCE_GLYPHS (it
);
8625 if (it
->area
!= TEXT_AREA
)
8627 prev_method
= it
->method
;
8628 if (it
->method
== GET_FROM_BUFFER
)
8629 prev_pos
= IT_CHARPOS (*it
);
8630 set_iterator_to_next (it
, true);
8631 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8632 SET_TEXT_POS (this_line_min_pos
,
8633 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8635 && (op
& MOVE_TO_POS
)
8636 && IT_CHARPOS (*it
) > to_charpos
8637 && IT_CHARPOS (*it
) < closest_pos
)
8638 closest_pos
= IT_CHARPOS (*it
);
8642 /* The number of glyphs we get back in IT->nglyphs will normally
8643 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8644 character on a terminal frame, or (iii) a line end. For the
8645 second case, IT->nglyphs - 1 padding glyphs will be present.
8646 (On X frames, there is only one glyph produced for a
8647 composite character.)
8649 The behavior implemented below means, for continuation lines,
8650 that as many spaces of a TAB as fit on the current line are
8651 displayed there. For terminal frames, as many glyphs of a
8652 multi-glyph character are displayed in the current line, too.
8653 This is what the old redisplay code did, and we keep it that
8654 way. Under X, the whole shape of a complex character must
8655 fit on the line or it will be completely displayed in the
8658 Note that both for tabs and padding glyphs, all glyphs have
8662 /* More than one glyph or glyph doesn't fit on line. All
8663 glyphs have the same width. */
8664 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8666 int x_before_this_char
= x
;
8667 int hpos_before_this_char
= it
->hpos
;
8669 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8671 new_x
= x
+ single_glyph_width
;
8673 /* We want to leave anything reaching TO_X to the caller. */
8674 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8676 if (BUFFER_POS_REACHED_P ())
8678 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8679 goto buffer_pos_reached
;
8680 if (atpos_it
.sp
< 0)
8682 SAVE_IT (atpos_it
, *it
, atpos_data
);
8683 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8688 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8691 result
= MOVE_X_REACHED
;
8696 SAVE_IT (atx_it
, *it
, atx_data
);
8697 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8702 if (/* Lines are continued. */
8703 it
->line_wrap
!= TRUNCATE
8704 && (/* And glyph doesn't fit on the line. */
8705 new_x
> it
->last_visible_x
8706 /* Or it fits exactly and we're on a window
8708 || (new_x
== it
->last_visible_x
8709 && FRAME_WINDOW_P (it
->f
)
8710 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8711 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8712 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8714 if (/* IT->hpos == 0 means the very first glyph
8715 doesn't fit on the line, e.g. a wide image. */
8717 || (new_x
== it
->last_visible_x
8718 && FRAME_WINDOW_P (it
->f
)))
8721 it
->current_x
= new_x
;
8723 /* The character's last glyph just barely fits
8725 if (i
== it
->nglyphs
- 1)
8727 /* If this is the destination position,
8728 return a position *before* it in this row,
8729 now that we know it fits in this row. */
8730 if (BUFFER_POS_REACHED_P ())
8732 if (it
->line_wrap
!= WORD_WRAP
8734 /* If we've just found whitespace to
8735 wrap, effectively ignore the
8736 previous wrap point -- it is no
8737 longer relevant, but we won't
8738 have an opportunity to update it,
8739 since we've reached the edge of
8740 this screen line. */
8742 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8744 it
->hpos
= hpos_before_this_char
;
8745 it
->current_x
= x_before_this_char
;
8746 result
= MOVE_POS_MATCH_OR_ZV
;
8749 if (it
->line_wrap
== WORD_WRAP
8752 SAVE_IT (atpos_it
, *it
, atpos_data
);
8753 atpos_it
.current_x
= x_before_this_char
;
8754 atpos_it
.hpos
= hpos_before_this_char
;
8758 prev_method
= it
->method
;
8759 if (it
->method
== GET_FROM_BUFFER
)
8760 prev_pos
= IT_CHARPOS (*it
);
8761 set_iterator_to_next (it
, true);
8762 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8763 SET_TEXT_POS (this_line_min_pos
,
8764 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8765 /* On graphical terminals, newlines may
8766 "overflow" into the fringe if
8767 overflow-newline-into-fringe is non-nil.
8768 On text terminals, and on graphical
8769 terminals with no right margin, newlines
8770 may overflow into the last glyph on the
8772 if (!FRAME_WINDOW_P (it
->f
)
8774 && it
->bidi_it
.paragraph_dir
== R2L
)
8775 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8776 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8777 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8779 if (!get_next_display_element (it
))
8781 result
= MOVE_POS_MATCH_OR_ZV
;
8784 if (BUFFER_POS_REACHED_P ())
8786 if (ITERATOR_AT_END_OF_LINE_P (it
))
8787 result
= MOVE_POS_MATCH_OR_ZV
;
8789 result
= MOVE_LINE_CONTINUED
;
8792 if (ITERATOR_AT_END_OF_LINE_P (it
)
8793 && (it
->line_wrap
!= WORD_WRAP
8795 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)))
8797 result
= MOVE_NEWLINE_OR_CR
;
8804 IT_RESET_X_ASCENT_DESCENT (it
);
8806 /* If the screen line ends with whitespace, and we
8807 are under word-wrap, don't use wrap_it: it is no
8808 longer relevant, but we won't have an opportunity
8809 to update it, since we are done with this screen
8811 if (may_wrap
&& IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8813 /* If we've found TO_X, go back there, as we now
8814 know the last word fits on this screen line. */
8815 if ((op
& MOVE_TO_X
) && new_x
== it
->last_visible_x
8818 RESTORE_IT (it
, &atx_it
, atx_data
);
8821 result
= MOVE_X_REACHED
;
8825 else if (wrap_it
.sp
>= 0)
8827 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8832 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8834 result
= MOVE_LINE_CONTINUED
;
8838 if (BUFFER_POS_REACHED_P ())
8840 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8841 goto buffer_pos_reached
;
8842 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8844 SAVE_IT (atpos_it
, *it
, atpos_data
);
8845 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8849 if (new_x
> it
->first_visible_x
)
8851 /* Glyph is visible. Increment number of glyphs that
8852 would be displayed. */
8857 if (result
!= MOVE_UNDEFINED
)
8860 else if (BUFFER_POS_REACHED_P ())
8863 IT_RESET_X_ASCENT_DESCENT (it
);
8864 result
= MOVE_POS_MATCH_OR_ZV
;
8867 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8869 /* Stop when TO_X specified and reached. This check is
8870 necessary here because of lines consisting of a line end,
8871 only. The line end will not produce any glyphs and we
8872 would never get MOVE_X_REACHED. */
8873 eassert (it
->nglyphs
== 0);
8874 result
= MOVE_X_REACHED
;
8878 /* Is this a line end? If yes, we're done. */
8879 if (ITERATOR_AT_END_OF_LINE_P (it
))
8881 /* If we are past TO_CHARPOS, but never saw any character
8882 positions smaller than TO_CHARPOS, return
8883 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8885 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8887 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8889 if (closest_pos
< ZV
)
8891 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8892 /* Don't recurse if closest_pos is equal to
8893 to_charpos, since we have just tried that. */
8894 if (closest_pos
!= to_charpos
)
8895 move_it_in_display_line_to (it
, closest_pos
, -1,
8897 result
= MOVE_POS_MATCH_OR_ZV
;
8900 goto buffer_pos_reached
;
8902 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8903 && IT_CHARPOS (*it
) > to_charpos
)
8904 goto buffer_pos_reached
;
8906 result
= MOVE_NEWLINE_OR_CR
;
8909 result
= MOVE_NEWLINE_OR_CR
;
8913 prev_method
= it
->method
;
8914 if (it
->method
== GET_FROM_BUFFER
)
8915 prev_pos
= IT_CHARPOS (*it
);
8916 /* The current display element has been consumed. Advance
8918 set_iterator_to_next (it
, true);
8919 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8920 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8921 if (IT_CHARPOS (*it
) < to_charpos
)
8922 saw_smaller_pos
= true;
8924 && (op
& MOVE_TO_POS
)
8925 && IT_CHARPOS (*it
) >= to_charpos
8926 && IT_CHARPOS (*it
) < closest_pos
)
8927 closest_pos
= IT_CHARPOS (*it
);
8929 /* Stop if lines are truncated and IT's current x-position is
8930 past the right edge of the window now. */
8931 if (it
->line_wrap
== TRUNCATE
8932 && it
->current_x
>= it
->last_visible_x
)
8934 if (!FRAME_WINDOW_P (it
->f
)
8935 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8936 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8937 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8938 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8940 bool at_eob_p
= false;
8942 if ((at_eob_p
= !get_next_display_element (it
))
8943 || BUFFER_POS_REACHED_P ()
8944 /* If we are past TO_CHARPOS, but never saw any
8945 character positions smaller than TO_CHARPOS,
8946 return MOVE_POS_MATCH_OR_ZV, like the
8947 unidirectional display did. */
8948 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8950 && IT_CHARPOS (*it
) > to_charpos
))
8953 && !BUFFER_POS_REACHED_P ()
8954 && !at_eob_p
&& closest_pos
< ZV
)
8956 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8957 if (closest_pos
!= to_charpos
)
8958 move_it_in_display_line_to (it
, closest_pos
, -1,
8961 result
= MOVE_POS_MATCH_OR_ZV
;
8964 if (ITERATOR_AT_END_OF_LINE_P (it
))
8966 result
= MOVE_NEWLINE_OR_CR
;
8970 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8972 && IT_CHARPOS (*it
) > to_charpos
)
8974 if (closest_pos
< ZV
)
8976 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8977 if (closest_pos
!= to_charpos
)
8978 move_it_in_display_line_to (it
, closest_pos
, -1,
8981 result
= MOVE_POS_MATCH_OR_ZV
;
8984 result
= MOVE_LINE_TRUNCATED
;
8987 #undef IT_RESET_X_ASCENT_DESCENT
8990 #undef BUFFER_POS_REACHED_P
8992 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8993 restore the saved iterator. */
8994 if (atpos_it
.sp
>= 0)
8995 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8996 else if (atx_it
.sp
>= 0)
8997 RESTORE_IT (it
, &atx_it
, atx_data
);
9002 bidi_unshelve_cache (atpos_data
, true);
9004 bidi_unshelve_cache (atx_data
, true);
9006 bidi_unshelve_cache (wrap_data
, true);
9008 bidi_unshelve_cache (ppos_data
, true);
9010 /* Restore the iterator settings altered at the beginning of this
9012 it
->glyph_row
= saved_glyph_row
;
9016 /* For external use. */
9018 move_it_in_display_line (struct it
*it
,
9019 ptrdiff_t to_charpos
, int to_x
,
9020 enum move_operation_enum op
)
9022 if (it
->line_wrap
== WORD_WRAP
9023 && (op
& MOVE_TO_X
))
9026 void *save_data
= NULL
;
9029 SAVE_IT (save_it
, *it
, save_data
);
9030 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9031 /* When word-wrap is on, TO_X may lie past the end
9032 of a wrapped line. Then it->current is the
9033 character on the next line, so backtrack to the
9034 space before the wrap point. */
9035 if (skip
== MOVE_LINE_CONTINUED
)
9037 int prev_x
= max (it
->current_x
- 1, 0);
9038 RESTORE_IT (it
, &save_it
, save_data
);
9039 move_it_in_display_line_to
9040 (it
, -1, prev_x
, MOVE_TO_X
);
9043 bidi_unshelve_cache (save_data
, true);
9046 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9050 /* Move IT forward until it satisfies one or more of the criteria in
9051 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9053 OP is a bit-mask that specifies where to stop, and in particular,
9054 which of those four position arguments makes a difference. See the
9055 description of enum move_operation_enum.
9057 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9058 screen line, this function will set IT to the next position that is
9059 displayed to the right of TO_CHARPOS on the screen.
9061 Return the maximum pixel length of any line scanned but never more
9062 than it.last_visible_x. */
9065 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9067 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9068 int line_height
, line_start_x
= 0, reached
= 0;
9069 int max_current_x
= 0;
9070 void *backup_data
= NULL
;
9074 if (op
& MOVE_TO_VPOS
)
9076 /* If no TO_CHARPOS and no TO_X specified, stop at the
9077 start of the line TO_VPOS. */
9078 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9080 if (it
->vpos
== to_vpos
)
9086 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9090 /* TO_VPOS >= 0 means stop at TO_X in the line at
9091 TO_VPOS, or at TO_POS, whichever comes first. */
9092 if (it
->vpos
== to_vpos
)
9098 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9100 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9105 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9107 /* We have reached TO_X but not in the line we want. */
9108 skip
= move_it_in_display_line_to (it
, to_charpos
,
9110 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9118 else if (op
& MOVE_TO_Y
)
9120 struct it it_backup
;
9122 if (it
->line_wrap
== WORD_WRAP
)
9123 SAVE_IT (it_backup
, *it
, backup_data
);
9125 /* TO_Y specified means stop at TO_X in the line containing
9126 TO_Y---or at TO_CHARPOS if this is reached first. The
9127 problem is that we can't really tell whether the line
9128 contains TO_Y before we have completely scanned it, and
9129 this may skip past TO_X. What we do is to first scan to
9132 If TO_X is not specified, use a TO_X of zero. The reason
9133 is to make the outcome of this function more predictable.
9134 If we didn't use TO_X == 0, we would stop at the end of
9135 the line which is probably not what a caller would expect
9137 skip
= move_it_in_display_line_to
9138 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9139 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9141 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9142 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9144 else if (skip
== MOVE_X_REACHED
)
9146 /* If TO_X was reached, we want to know whether TO_Y is
9147 in the line. We know this is the case if the already
9148 scanned glyphs make the line tall enough. Otherwise,
9149 we must check by scanning the rest of the line. */
9150 line_height
= it
->max_ascent
+ it
->max_descent
;
9151 if (to_y
>= it
->current_y
9152 && to_y
< it
->current_y
+ line_height
)
9157 SAVE_IT (it_backup
, *it
, backup_data
);
9158 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9159 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9161 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9162 line_height
= it
->max_ascent
+ it
->max_descent
;
9163 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9165 if (to_y
>= it
->current_y
9166 && to_y
< it
->current_y
+ line_height
)
9168 /* If TO_Y is in this line and TO_X was reached
9169 above, we scanned too far. We have to restore
9170 IT's settings to the ones before skipping. But
9171 keep the more accurate values of max_ascent and
9172 max_descent we've found while skipping the rest
9173 of the line, for the sake of callers, such as
9174 pos_visible_p, that need to know the line
9176 int max_ascent
= it
->max_ascent
;
9177 int max_descent
= it
->max_descent
;
9179 RESTORE_IT (it
, &it_backup
, backup_data
);
9180 it
->max_ascent
= max_ascent
;
9181 it
->max_descent
= max_descent
;
9187 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9193 /* Check whether TO_Y is in this line. */
9194 line_height
= it
->max_ascent
+ it
->max_descent
;
9195 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9197 if (to_y
>= it
->current_y
9198 && to_y
< it
->current_y
+ line_height
)
9200 if (to_y
> it
->current_y
)
9201 max_current_x
= max (it
->current_x
, max_current_x
);
9203 /* When word-wrap is on, TO_X may lie past the end
9204 of a wrapped line. Then it->current is the
9205 character on the next line, so backtrack to the
9206 space before the wrap point. */
9207 if (skip
== MOVE_LINE_CONTINUED
9208 && it
->line_wrap
== WORD_WRAP
)
9210 int prev_x
= max (it
->current_x
- 1, 0);
9211 RESTORE_IT (it
, &it_backup
, backup_data
);
9212 skip
= move_it_in_display_line_to
9213 (it
, -1, prev_x
, MOVE_TO_X
);
9222 max_current_x
= max (it
->current_x
, max_current_x
);
9226 else if (BUFFERP (it
->object
)
9227 && (it
->method
== GET_FROM_BUFFER
9228 || it
->method
== GET_FROM_STRETCH
)
9229 && IT_CHARPOS (*it
) >= to_charpos
9230 /* Under bidi iteration, a call to set_iterator_to_next
9231 can scan far beyond to_charpos if the initial
9232 portion of the next line needs to be reordered. In
9233 that case, give move_it_in_display_line_to another
9236 && it
->bidi_it
.scan_dir
== -1))
9237 skip
= MOVE_POS_MATCH_OR_ZV
;
9239 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9243 case MOVE_POS_MATCH_OR_ZV
:
9244 max_current_x
= max (it
->current_x
, max_current_x
);
9248 case MOVE_NEWLINE_OR_CR
:
9249 max_current_x
= max (it
->current_x
, max_current_x
);
9250 set_iterator_to_next (it
, true);
9251 it
->continuation_lines_width
= 0;
9254 case MOVE_LINE_TRUNCATED
:
9255 max_current_x
= it
->last_visible_x
;
9256 it
->continuation_lines_width
= 0;
9257 reseat_at_next_visible_line_start (it
, false);
9258 if ((op
& MOVE_TO_POS
) != 0
9259 && IT_CHARPOS (*it
) > to_charpos
)
9266 case MOVE_LINE_CONTINUED
:
9267 max_current_x
= it
->last_visible_x
;
9268 /* For continued lines ending in a tab, some of the glyphs
9269 associated with the tab are displayed on the current
9270 line. Since it->current_x does not include these glyphs,
9271 we use it->last_visible_x instead. */
9274 it
->continuation_lines_width
+= it
->last_visible_x
;
9275 /* When moving by vpos, ensure that the iterator really
9276 advances to the next line (bug#847, bug#969). Fixme:
9277 do we need to do this in other circumstances? */
9278 if (it
->current_x
!= it
->last_visible_x
9279 && (op
& MOVE_TO_VPOS
)
9280 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9282 line_start_x
= it
->current_x
+ it
->pixel_width
9283 - it
->last_visible_x
;
9284 if (FRAME_WINDOW_P (it
->f
))
9286 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9287 struct font
*face_font
= face
->font
;
9289 /* When display_line produces a continued line
9290 that ends in a TAB, it skips a tab stop that
9291 is closer than the font's space character
9292 width (see x_produce_glyphs where it produces
9293 the stretch glyph which represents a TAB).
9294 We need to reproduce the same logic here. */
9295 eassert (face_font
);
9298 if (line_start_x
< face_font
->space_width
)
9300 += it
->tab_width
* face_font
->space_width
;
9303 set_iterator_to_next (it
, false);
9307 it
->continuation_lines_width
+= it
->current_x
;
9314 /* Reset/increment for the next run. */
9315 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9316 it
->current_x
= line_start_x
;
9319 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9321 last_height
= it
->max_ascent
+ it
->max_descent
;
9322 it
->max_ascent
= it
->max_descent
= 0;
9327 /* On text terminals, we may stop at the end of a line in the middle
9328 of a multi-character glyph. If the glyph itself is continued,
9329 i.e. it is actually displayed on the next line, don't treat this
9330 stopping point as valid; move to the next line instead (unless
9331 that brings us offscreen). */
9332 if (!FRAME_WINDOW_P (it
->f
)
9334 && IT_CHARPOS (*it
) == to_charpos
9335 && it
->what
== IT_CHARACTER
9337 && it
->line_wrap
== WINDOW_WRAP
9338 && it
->current_x
== it
->last_visible_x
- 1
9341 && it
->w
->window_end_valid
9342 && it
->vpos
< it
->w
->window_end_vpos
)
9344 it
->continuation_lines_width
+= it
->current_x
;
9345 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9346 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9348 last_height
= it
->max_ascent
+ it
->max_descent
;
9352 bidi_unshelve_cache (backup_data
, true);
9354 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9356 return max_current_x
;
9360 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9362 If DY > 0, move IT backward at least that many pixels. DY = 0
9363 means move IT backward to the preceding line start or BEGV. This
9364 function may move over more than DY pixels if IT->current_y - DY
9365 ends up in the middle of a line; in this case IT->current_y will be
9366 set to the top of the line moved to. */
9369 move_it_vertically_backward (struct it
*it
, int dy
)
9373 void *it2data
= NULL
, *it3data
= NULL
;
9374 ptrdiff_t start_pos
;
9376 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9377 ptrdiff_t pos_limit
;
9382 start_pos
= IT_CHARPOS (*it
);
9384 /* Estimate how many newlines we must move back. */
9385 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9386 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9389 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9391 /* Set the iterator's position that many lines back. But don't go
9392 back more than NLINES full screen lines -- this wins a day with
9393 buffers which have very long lines. */
9394 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9395 back_to_previous_visible_line_start (it
);
9397 /* Reseat the iterator here. When moving backward, we don't want
9398 reseat to skip forward over invisible text, set up the iterator
9399 to deliver from overlay strings at the new position etc. So,
9400 use reseat_1 here. */
9401 reseat_1 (it
, it
->current
.pos
, true);
9403 /* We are now surely at a line start. */
9404 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9405 reordering is in effect. */
9406 it
->continuation_lines_width
= 0;
9408 /* Move forward and see what y-distance we moved. First move to the
9409 start of the next line so that we get its height. We need this
9410 height to be able to tell whether we reached the specified
9412 SAVE_IT (it2
, *it
, it2data
);
9413 it2
.max_ascent
= it2
.max_descent
= 0;
9416 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9417 MOVE_TO_POS
| MOVE_TO_VPOS
);
9419 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9420 /* If we are in a display string which starts at START_POS,
9421 and that display string includes a newline, and we are
9422 right after that newline (i.e. at the beginning of a
9423 display line), exit the loop, because otherwise we will
9424 infloop, since move_it_to will see that it is already at
9425 START_POS and will not move. */
9426 || (it2
.method
== GET_FROM_STRING
9427 && IT_CHARPOS (it2
) == start_pos
9428 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9429 eassert (IT_CHARPOS (*it
) >= BEGV
);
9430 SAVE_IT (it3
, it2
, it3data
);
9432 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9433 eassert (IT_CHARPOS (*it
) >= BEGV
);
9434 /* H is the actual vertical distance from the position in *IT
9435 and the starting position. */
9436 h
= it2
.current_y
- it
->current_y
;
9437 /* NLINES is the distance in number of lines. */
9438 nlines
= it2
.vpos
- it
->vpos
;
9440 /* Correct IT's y and vpos position
9441 so that they are relative to the starting point. */
9447 /* DY == 0 means move to the start of the screen line. The
9448 value of nlines is > 0 if continuation lines were involved,
9449 or if the original IT position was at start of a line. */
9450 RESTORE_IT (it
, it
, it2data
);
9452 move_it_by_lines (it
, nlines
);
9453 /* The above code moves us to some position NLINES down,
9454 usually to its first glyph (leftmost in an L2R line), but
9455 that's not necessarily the start of the line, under bidi
9456 reordering. We want to get to the character position
9457 that is immediately after the newline of the previous
9460 && !it
->continuation_lines_width
9461 && !STRINGP (it
->string
)
9462 && IT_CHARPOS (*it
) > BEGV
9463 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9465 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9468 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9469 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9471 bidi_unshelve_cache (it3data
, true);
9475 /* The y-position we try to reach, relative to *IT.
9476 Note that H has been subtracted in front of the if-statement. */
9477 int target_y
= it
->current_y
+ h
- dy
;
9478 int y0
= it3
.current_y
;
9482 RESTORE_IT (&it3
, &it3
, it3data
);
9483 y1
= line_bottom_y (&it3
);
9484 line_height
= y1
- y0
;
9485 RESTORE_IT (it
, it
, it2data
);
9486 /* If we did not reach target_y, try to move further backward if
9487 we can. If we moved too far backward, try to move forward. */
9488 if (target_y
< it
->current_y
9489 /* This is heuristic. In a window that's 3 lines high, with
9490 a line height of 13 pixels each, recentering with point
9491 on the bottom line will try to move -39/2 = 19 pixels
9492 backward. Try to avoid moving into the first line. */
9493 && (it
->current_y
- target_y
9494 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9495 && IT_CHARPOS (*it
) > BEGV
)
9497 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9498 target_y
- it
->current_y
));
9499 dy
= it
->current_y
- target_y
;
9500 goto move_further_back
;
9502 else if (target_y
>= it
->current_y
+ line_height
9503 && IT_CHARPOS (*it
) < ZV
)
9505 /* Should move forward by at least one line, maybe more.
9507 Note: Calling move_it_by_lines can be expensive on
9508 terminal frames, where compute_motion is used (via
9509 vmotion) to do the job, when there are very long lines
9510 and truncate-lines is nil. That's the reason for
9511 treating terminal frames specially here. */
9513 if (!FRAME_WINDOW_P (it
->f
))
9514 move_it_vertically (it
, target_y
- it
->current_y
);
9519 move_it_by_lines (it
, 1);
9521 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9528 /* Move IT by a specified amount of pixel lines DY. DY negative means
9529 move backwards. DY = 0 means move to start of screen line. At the
9530 end, IT will be on the start of a screen line. */
9533 move_it_vertically (struct it
*it
, int dy
)
9536 move_it_vertically_backward (it
, -dy
);
9539 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9540 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9541 MOVE_TO_POS
| MOVE_TO_Y
);
9542 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9544 /* If buffer ends in ZV without a newline, move to the start of
9545 the line to satisfy the post-condition. */
9546 if (IT_CHARPOS (*it
) == ZV
9548 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9549 move_it_by_lines (it
, 0);
9554 /* Move iterator IT past the end of the text line it is in. */
9557 move_it_past_eol (struct it
*it
)
9559 enum move_it_result rc
;
9561 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9562 if (rc
== MOVE_NEWLINE_OR_CR
)
9563 set_iterator_to_next (it
, false);
9567 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9568 negative means move up. DVPOS == 0 means move to the start of the
9571 Optimization idea: If we would know that IT->f doesn't use
9572 a face with proportional font, we could be faster for
9573 truncate-lines nil. */
9576 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9579 /* The commented-out optimization uses vmotion on terminals. This
9580 gives bad results, because elements like it->what, on which
9581 callers such as pos_visible_p rely, aren't updated. */
9582 /* struct position pos;
9583 if (!FRAME_WINDOW_P (it->f))
9585 struct text_pos textpos;
9587 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9588 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9589 reseat (it, textpos, true);
9590 it->vpos += pos.vpos;
9591 it->current_y += pos.vpos;
9597 /* DVPOS == 0 means move to the start of the screen line. */
9598 move_it_vertically_backward (it
, 0);
9599 /* Let next call to line_bottom_y calculate real line height. */
9604 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9605 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9607 /* Only move to the next buffer position if we ended up in a
9608 string from display property, not in an overlay string
9609 (before-string or after-string). That is because the
9610 latter don't conceal the underlying buffer position, so
9611 we can ask to move the iterator to the exact position we
9612 are interested in. Note that, even if we are already at
9613 IT_CHARPOS (*it), the call below is not a no-op, as it
9614 will detect that we are at the end of the string, pop the
9615 iterator, and compute it->current_x and it->hpos
9617 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9618 -1, -1, -1, MOVE_TO_POS
);
9624 void *it2data
= NULL
;
9625 ptrdiff_t start_charpos
, i
;
9627 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9628 bool hit_pos_limit
= false;
9629 ptrdiff_t pos_limit
;
9631 /* Start at the beginning of the screen line containing IT's
9632 position. This may actually move vertically backwards,
9633 in case of overlays, so adjust dvpos accordingly. */
9635 move_it_vertically_backward (it
, 0);
9638 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9639 screen lines, and reseat the iterator there. */
9640 start_charpos
= IT_CHARPOS (*it
);
9641 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9644 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9646 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9647 back_to_previous_visible_line_start (it
);
9648 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9649 hit_pos_limit
= true;
9650 reseat (it
, it
->current
.pos
, true);
9652 /* Move further back if we end up in a string or an image. */
9653 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9655 /* First try to move to start of display line. */
9657 move_it_vertically_backward (it
, 0);
9659 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9661 /* If start of line is still in string or image,
9662 move further back. */
9663 back_to_previous_visible_line_start (it
);
9664 reseat (it
, it
->current
.pos
, true);
9668 it
->current_x
= it
->hpos
= 0;
9670 /* Above call may have moved too far if continuation lines
9671 are involved. Scan forward and see if it did. */
9672 SAVE_IT (it2
, *it
, it2data
);
9673 it2
.vpos
= it2
.current_y
= 0;
9674 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9675 it
->vpos
-= it2
.vpos
;
9676 it
->current_y
-= it2
.current_y
;
9677 it
->current_x
= it
->hpos
= 0;
9679 /* If we moved too far back, move IT some lines forward. */
9680 if (it2
.vpos
> -dvpos
)
9682 int delta
= it2
.vpos
+ dvpos
;
9684 RESTORE_IT (&it2
, &it2
, it2data
);
9685 SAVE_IT (it2
, *it
, it2data
);
9686 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9687 /* Move back again if we got too far ahead. */
9688 if (IT_CHARPOS (*it
) >= start_charpos
)
9689 RESTORE_IT (it
, &it2
, it2data
);
9691 bidi_unshelve_cache (it2data
, true);
9693 else if (hit_pos_limit
&& pos_limit
> BEGV
9694 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9696 /* If we hit the limit, but still didn't make it far enough
9697 back, that means there's a display string with a newline
9698 covering a large chunk of text, and that caused
9699 back_to_previous_visible_line_start try to go too far.
9700 Punish those who commit such atrocities by going back
9701 until we've reached DVPOS, after lifting the limit, which
9702 could make it slow for very long lines. "If it hurts,
9705 RESTORE_IT (it
, it
, it2data
);
9706 for (i
= -dvpos
; i
> 0; --i
)
9708 back_to_previous_visible_line_start (it
);
9711 reseat_1 (it
, it
->current
.pos
, true);
9714 RESTORE_IT (it
, it
, it2data
);
9718 /* Return true if IT points into the middle of a display vector. */
9721 in_display_vector_p (struct it
*it
)
9723 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9724 && it
->current
.dpvec_index
> 0
9725 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9728 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9729 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9730 WINDOW must be a live window and defaults to the selected one. The
9731 return value is a cons of the maximum pixel-width of any text line and
9732 the maximum pixel-height of all text lines.
9734 The optional argument FROM, if non-nil, specifies the first text
9735 position and defaults to the minimum accessible position of the buffer.
9736 If FROM is t, use the minimum accessible position that is not a newline
9737 character. TO, if non-nil, specifies the last text position and
9738 defaults to the maximum accessible position of the buffer. If TO is t,
9739 use the maximum accessible position that is not a newline character.
9741 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9742 width that can be returned. X-LIMIT nil or omitted, means to use the
9743 pixel-width of WINDOW's body; use this if you do not intend to change
9744 the width of WINDOW. Use the maximum width WINDOW may assume if you
9745 intend to change WINDOW's width. In any case, text whose x-coordinate
9746 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9747 can take some time, it's always a good idea to make this argument as
9748 small as possible; in particular, if the buffer contains long lines that
9749 shall be truncated anyway.
9751 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9752 height that can be returned. Text lines whose y-coordinate is beyond
9753 Y-LIMIT are ignored. Since calculating the text height of a large
9754 buffer can take some time, it makes sense to specify this argument if
9755 the size of the buffer is unknown.
9757 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9758 include the height of the mode- or header-line of WINDOW in the return
9759 value. If it is either the symbol `mode-line' or `header-line', include
9760 only the height of that line, if present, in the return value. If t,
9761 include the height of both, if present, in the return value. */)
9762 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
,
9763 Lisp_Object y_limit
, Lisp_Object mode_and_header_line
)
9765 struct window
*w
= decode_live_window (window
);
9766 Lisp_Object buffer
= w
->contents
;
9769 struct buffer
*old_b
= NULL
;
9770 ptrdiff_t start
, end
, pos
;
9771 struct text_pos startp
;
9772 void *itdata
= NULL
;
9773 int c
, max_y
= -1, x
= 0, y
= 0;
9775 CHECK_BUFFER (buffer
);
9776 b
= XBUFFER (buffer
);
9778 if (b
!= current_buffer
)
9780 old_b
= current_buffer
;
9781 set_buffer_internal (b
);
9786 else if (EQ (from
, Qt
))
9789 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9790 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9792 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9797 CHECK_NUMBER_COERCE_MARKER (from
);
9798 start
= min (max (XINT (from
), BEGV
), ZV
);
9803 else if (EQ (to
, Qt
))
9806 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9807 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9809 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9814 CHECK_NUMBER_COERCE_MARKER (to
);
9815 end
= max (start
, min (XINT (to
), ZV
));
9818 if (!NILP (y_limit
))
9820 CHECK_NUMBER (y_limit
);
9821 max_y
= min (XINT (y_limit
), INT_MAX
);
9824 itdata
= bidi_shelve_cache ();
9825 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9826 start_display (&it
, w
, startp
);
9829 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9832 CHECK_NUMBER (x_limit
);
9833 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9834 /* Actually, we never want move_it_to stop at to_x. But to make
9835 sure that move_it_in_display_line_to always moves far enough,
9836 we set it to INT_MAX and specify MOVE_TO_X. */
9837 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9838 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9841 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9843 if (!EQ (mode_and_header_line
, Qheader_line
)
9844 && !EQ (mode_and_header_line
, Qt
))
9845 /* Do not count the header-line which was counted automatically by
9847 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9849 if (EQ (mode_and_header_line
, Qmode_line
)
9850 || EQ (mode_and_header_line
, Qt
))
9851 /* Do count the mode-line which is not included automatically by
9853 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9855 bidi_unshelve_cache (itdata
, false);
9858 set_buffer_internal (old_b
);
9860 return Fcons (make_number (x
), make_number (y
));
9863 /***********************************************************************
9865 ***********************************************************************/
9867 /* Return the number of arguments the format string FORMAT needs. */
9870 format_nargs (char const *format
)
9872 ptrdiff_t nargs
= 0;
9873 for (char const *p
= format
; (p
= strchr (p
, '%')); p
++)
9881 /* Add a message with format string FORMAT and formatted arguments
9885 add_to_log (const char *format
, ...)
9888 va_start (ap
, format
);
9889 vadd_to_log (format
, ap
);
9894 vadd_to_log (char const *format
, va_list ap
)
9896 ptrdiff_t form_nargs
= format_nargs (format
);
9897 ptrdiff_t nargs
= 1 + form_nargs
;
9898 Lisp_Object args
[10];
9899 eassert (nargs
<= ARRAYELTS (args
));
9900 AUTO_STRING (args0
, format
);
9902 for (ptrdiff_t i
= 1; i
<= nargs
; i
++)
9903 args
[i
] = va_arg (ap
, Lisp_Object
);
9904 Lisp_Object msg
= Qnil
;
9905 msg
= Fformat_message (nargs
, args
);
9907 ptrdiff_t len
= SBYTES (msg
) + 1;
9909 char *buffer
= SAFE_ALLOCA (len
);
9910 memcpy (buffer
, SDATA (msg
), len
);
9912 message_dolog (buffer
, len
- 1, true, STRING_MULTIBYTE (msg
));
9917 /* Output a newline in the *Messages* buffer if "needs" one. */
9920 message_log_maybe_newline (void)
9922 if (message_log_need_newline
)
9923 message_dolog ("", 0, true, false);
9927 /* Add a string M of length NBYTES to the message log, optionally
9928 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9929 true, means interpret the contents of M as multibyte. This
9930 function calls low-level routines in order to bypass text property
9931 hooks, etc. which might not be safe to run.
9933 This may GC (insert may run before/after change hooks),
9934 so the buffer M must NOT point to a Lisp string. */
9937 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9939 const unsigned char *msg
= (const unsigned char *) m
;
9941 if (!NILP (Vmemory_full
))
9944 if (!NILP (Vmessage_log_max
))
9946 struct buffer
*oldbuf
;
9947 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9948 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9949 ptrdiff_t point_at_end
= 0;
9950 ptrdiff_t zv_at_end
= 0;
9951 Lisp_Object old_deactivate_mark
;
9953 old_deactivate_mark
= Vdeactivate_mark
;
9954 oldbuf
= current_buffer
;
9956 /* Ensure the Messages buffer exists, and switch to it.
9957 If we created it, set the major-mode. */
9958 bool newbuffer
= NILP (Fget_buffer (Vmessages_buffer_name
));
9959 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9961 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9962 call0 (intern ("messages-buffer-mode"));
9964 bset_undo_list (current_buffer
, Qt
);
9965 bset_cache_long_scans (current_buffer
, Qnil
);
9967 oldpoint
= message_dolog_marker1
;
9968 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9969 oldbegv
= message_dolog_marker2
;
9970 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9971 oldzv
= message_dolog_marker3
;
9972 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9980 BEGV_BYTE
= BEG_BYTE
;
9983 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9985 /* Insert the string--maybe converting multibyte to single byte
9986 or vice versa, so that all the text fits the buffer. */
9988 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9994 /* Convert a multibyte string to single-byte
9995 for the *Message* buffer. */
9996 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9998 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9999 work
[0] = CHAR_TO_BYTE8 (c
);
10000 insert_1_both (work
, 1, 1, true, false, false);
10003 else if (! multibyte
10004 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10008 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10009 /* Convert a single-byte string to multibyte
10010 for the *Message* buffer. */
10011 for (i
= 0; i
< nbytes
; i
++)
10014 MAKE_CHAR_MULTIBYTE (c
);
10015 char_bytes
= CHAR_STRING (c
, str
);
10016 insert_1_both ((char *) str
, 1, char_bytes
, true, false, false);
10020 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
,
10021 true, false, false);
10025 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10028 insert_1_both ("\n", 1, 1, true, false, false);
10030 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, false);
10032 this_bol_byte
= PT_BYTE
;
10034 /* See if this line duplicates the previous one.
10035 If so, combine duplicates. */
10036 if (this_bol
> BEG
)
10038 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, false);
10040 prev_bol_byte
= PT_BYTE
;
10042 dups
= message_log_check_duplicate (prev_bol_byte
,
10046 del_range_both (prev_bol
, prev_bol_byte
,
10047 this_bol
, this_bol_byte
, false);
10050 char dupstr
[sizeof " [ times]"
10051 + INT_STRLEN_BOUND (printmax_t
)];
10053 /* If you change this format, don't forget to also
10054 change message_log_check_duplicate. */
10055 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10056 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10057 insert_1_both (dupstr
, duplen
, duplen
,
10058 true, false, true);
10063 /* If we have more than the desired maximum number of lines
10064 in the *Messages* buffer now, delete the oldest ones.
10065 This is safe because we don't have undo in this buffer. */
10067 if (NATNUMP (Vmessage_log_max
))
10069 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10070 -XFASTINT (Vmessage_log_max
) - 1, false);
10071 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, false);
10074 BEGV
= marker_position (oldbegv
);
10075 BEGV_BYTE
= marker_byte_position (oldbegv
);
10084 ZV
= marker_position (oldzv
);
10085 ZV_BYTE
= marker_byte_position (oldzv
);
10089 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10091 /* We can't do Fgoto_char (oldpoint) because it will run some
10093 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10094 marker_byte_position (oldpoint
));
10096 unchain_marker (XMARKER (oldpoint
));
10097 unchain_marker (XMARKER (oldbegv
));
10098 unchain_marker (XMARKER (oldzv
));
10100 /* We called insert_1_both above with its 5th argument (PREPARE)
10101 false, which prevents insert_1_both from calling
10102 prepare_to_modify_buffer, which in turns prevents us from
10103 incrementing windows_or_buffers_changed even if *Messages* is
10104 shown in some window. So we must manually set
10105 windows_or_buffers_changed here to make up for that. */
10106 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10107 bset_redisplay (current_buffer
);
10109 set_buffer_internal (oldbuf
);
10111 message_log_need_newline
= !nlflag
;
10112 Vdeactivate_mark
= old_deactivate_mark
;
10117 /* We are at the end of the buffer after just having inserted a newline.
10118 (Note: We depend on the fact we won't be crossing the gap.)
10119 Check to see if the most recent message looks a lot like the previous one.
10120 Return 0 if different, 1 if the new one should just replace it, or a
10121 value N > 1 if we should also append " [N times]". */
10124 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10127 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10128 bool seen_dots
= false;
10129 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10130 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10132 for (i
= 0; i
< len
; i
++)
10134 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10136 if (p1
[i
] != p2
[i
])
10142 if (*p1
++ == ' ' && *p1
++ == '[')
10145 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10146 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10153 /* Display an echo area message M with a specified length of NBYTES
10154 bytes. The string may include null characters. If M is not a
10155 string, clear out any existing message, and let the mini-buffer
10158 This function cancels echoing. */
10161 message3 (Lisp_Object m
)
10163 clear_message (true, true);
10166 /* First flush out any partial line written with print. */
10167 message_log_maybe_newline ();
10170 ptrdiff_t nbytes
= SBYTES (m
);
10171 bool multibyte
= STRING_MULTIBYTE (m
);
10174 SAFE_ALLOCA_STRING (buffer
, m
);
10175 message_dolog (buffer
, nbytes
, true, multibyte
);
10178 if (! inhibit_message
)
10179 message3_nolog (m
);
10182 /* Log the message M to stderr. Log an empty line if M is not a string. */
10185 message_to_stderr (Lisp_Object m
)
10187 if (noninteractive_need_newline
)
10189 noninteractive_need_newline
= false;
10190 fputc ('\n', stderr
);
10194 Lisp_Object s
= ENCODE_SYSTEM (m
);
10195 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10197 if (!cursor_in_echo_area
)
10198 fputc ('\n', stderr
);
10202 /* The non-logging version of message3.
10203 This does not cancel echoing, because it is used for echoing.
10204 Perhaps we need to make a separate function for echoing
10205 and make this cancel echoing. */
10208 message3_nolog (Lisp_Object m
)
10210 struct frame
*sf
= SELECTED_FRAME ();
10212 if (FRAME_INITIAL_P (sf
))
10213 message_to_stderr (m
);
10214 /* Error messages get reported properly by cmd_error, so this must be just an
10215 informative message; if the frame hasn't really been initialized yet, just
10217 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10219 /* Get the frame containing the mini-buffer
10220 that the selected frame is using. */
10221 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10222 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10223 struct frame
*f
= XFRAME (frame
);
10225 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10226 Fmake_frame_visible (frame
);
10228 if (STRINGP (m
) && SCHARS (m
) > 0)
10231 if (minibuffer_auto_raise
)
10232 Fraise_frame (frame
);
10233 /* Assume we are not echoing.
10234 (If we are, echo_now will override this.) */
10235 echo_message_buffer
= Qnil
;
10238 clear_message (true, true);
10240 do_pending_window_change (false);
10241 echo_area_display (true);
10242 do_pending_window_change (false);
10243 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10244 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10249 /* Display a null-terminated echo area message M. If M is 0, clear
10250 out any existing message, and let the mini-buffer text show through.
10252 The buffer M must continue to exist until after the echo area gets
10253 cleared or some other message gets displayed there. Do not pass
10254 text that is stored in a Lisp string. Do not pass text in a buffer
10255 that was alloca'd. */
10258 message1 (const char *m
)
10260 message3 (m
? build_unibyte_string (m
) : Qnil
);
10264 /* The non-logging counterpart of message1. */
10267 message1_nolog (const char *m
)
10269 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10272 /* Display a message M which contains a single %s
10273 which gets replaced with STRING. */
10276 message_with_string (const char *m
, Lisp_Object string
, bool log
)
10278 CHECK_STRING (string
);
10281 if (noninteractive
)
10282 need_message
= !!m
;
10283 else if (!INTERACTIVE
)
10284 need_message
= false;
10287 /* The frame whose minibuffer we're going to display the message on.
10288 It may be larger than the selected frame, so we need
10289 to use its buffer, not the selected frame's buffer. */
10290 Lisp_Object mini_window
;
10291 struct frame
*f
, *sf
= SELECTED_FRAME ();
10293 /* Get the frame containing the minibuffer
10294 that the selected frame is using. */
10295 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10296 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10298 /* Error messages get reported properly by cmd_error, so this must be
10299 just an informative message; if the frame hasn't really been
10300 initialized yet, just toss it. */
10301 need_message
= f
->glyphs_initialized_p
;
10306 AUTO_STRING (fmt
, m
);
10307 Lisp_Object msg
= CALLN (Fformat_message
, fmt
, string
);
10309 if (noninteractive
)
10310 message_to_stderr (msg
);
10316 message3_nolog (msg
);
10318 /* Print should start at the beginning of the message
10319 buffer next time. */
10320 message_buf_print
= false;
10326 /* Dump an informative message to the minibuf. If M is 0, clear out
10327 any existing message, and let the mini-buffer text show through.
10329 The message must be safe ASCII and the format must not contain ` or
10330 '. If your message and format do not fit into this category,
10331 convert your arguments to Lisp objects and use Fmessage instead. */
10333 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10334 vmessage (const char *m
, va_list ap
)
10336 if (noninteractive
)
10340 if (noninteractive_need_newline
)
10341 putc ('\n', stderr
);
10342 noninteractive_need_newline
= false;
10343 vfprintf (stderr
, m
, ap
);
10344 if (!cursor_in_echo_area
)
10345 fprintf (stderr
, "\n");
10349 else if (INTERACTIVE
)
10351 /* The frame whose mini-buffer we're going to display the message
10352 on. It may be larger than the selected frame, so we need to
10353 use its buffer, not the selected frame's buffer. */
10354 Lisp_Object mini_window
;
10355 struct frame
*f
, *sf
= SELECTED_FRAME ();
10357 /* Get the frame containing the mini-buffer
10358 that the selected frame is using. */
10359 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10360 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10362 /* Error messages get reported properly by cmd_error, so this must be
10363 just an informative message; if the frame hasn't really been
10364 initialized yet, just toss it. */
10365 if (f
->glyphs_initialized_p
)
10370 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10372 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10374 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10376 message3 (make_string (message_buf
, len
));
10382 /* Print should start at the beginning of the message
10383 buffer next time. */
10384 message_buf_print
= false;
10390 message (const char *m
, ...)
10399 /* Display the current message in the current mini-buffer. This is
10400 only called from error handlers in process.c, and is not time
10404 update_echo_area (void)
10406 if (!NILP (echo_area_buffer
[0]))
10408 Lisp_Object string
;
10409 string
= Fcurrent_message ();
10415 /* Make sure echo area buffers in `echo_buffers' are live.
10416 If they aren't, make new ones. */
10419 ensure_echo_area_buffers (void)
10423 for (i
= 0; i
< 2; ++i
)
10424 if (!BUFFERP (echo_buffer
[i
])
10425 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10428 Lisp_Object old_buffer
;
10431 old_buffer
= echo_buffer
[i
];
10432 echo_buffer
[i
] = Fget_buffer_create
10433 (make_formatted_string (name
, " *Echo Area %d*", i
));
10434 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10435 /* to force word wrap in echo area -
10436 it was decided to postpone this*/
10437 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10439 for (j
= 0; j
< 2; ++j
)
10440 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10441 echo_area_buffer
[j
] = echo_buffer
[i
];
10446 /* Call FN with args A1..A2 with either the current or last displayed
10447 echo_area_buffer as current buffer.
10449 WHICH zero means use the current message buffer
10450 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10451 from echo_buffer[] and clear it.
10453 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10454 suitable buffer from echo_buffer[] and clear it.
10456 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10457 that the current message becomes the last displayed one, make
10458 choose a suitable buffer for echo_area_buffer[0], and clear it.
10460 Value is what FN returns. */
10463 with_echo_area_buffer (struct window
*w
, int which
,
10464 bool (*fn
) (ptrdiff_t, Lisp_Object
),
10465 ptrdiff_t a1
, Lisp_Object a2
)
10467 Lisp_Object buffer
;
10468 bool this_one
, the_other
, clear_buffer_p
, rc
;
10469 ptrdiff_t count
= SPECPDL_INDEX ();
10471 /* If buffers aren't live, make new ones. */
10472 ensure_echo_area_buffers ();
10474 clear_buffer_p
= false;
10477 this_one
= false, the_other
= true;
10478 else if (which
> 0)
10479 this_one
= true, the_other
= false;
10482 this_one
= false, the_other
= true;
10483 clear_buffer_p
= true;
10485 /* We need a fresh one in case the current echo buffer equals
10486 the one containing the last displayed echo area message. */
10487 if (!NILP (echo_area_buffer
[this_one
])
10488 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10489 echo_area_buffer
[this_one
] = Qnil
;
10492 /* Choose a suitable buffer from echo_buffer[] is we don't
10494 if (NILP (echo_area_buffer
[this_one
]))
10496 echo_area_buffer
[this_one
]
10497 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10498 ? echo_buffer
[the_other
]
10499 : echo_buffer
[this_one
]);
10500 clear_buffer_p
= true;
10503 buffer
= echo_area_buffer
[this_one
];
10505 /* Don't get confused by reusing the buffer used for echoing
10506 for a different purpose. */
10507 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10510 record_unwind_protect (unwind_with_echo_area_buffer
,
10511 with_echo_area_buffer_unwind_data (w
));
10513 /* Make the echo area buffer current. Note that for display
10514 purposes, it is not necessary that the displayed window's buffer
10515 == current_buffer, except for text property lookup. So, let's
10516 only set that buffer temporarily here without doing a full
10517 Fset_window_buffer. We must also change w->pointm, though,
10518 because otherwise an assertions in unshow_buffer fails, and Emacs
10520 set_buffer_internal_1 (XBUFFER (buffer
));
10523 wset_buffer (w
, buffer
);
10524 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10525 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10528 bset_undo_list (current_buffer
, Qt
);
10529 bset_read_only (current_buffer
, Qnil
);
10530 specbind (Qinhibit_read_only
, Qt
);
10531 specbind (Qinhibit_modification_hooks
, Qt
);
10533 if (clear_buffer_p
&& Z
> BEG
)
10534 del_range (BEG
, Z
);
10536 eassert (BEGV
>= BEG
);
10537 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10541 eassert (BEGV
>= BEG
);
10542 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10544 unbind_to (count
, Qnil
);
10549 /* Save state that should be preserved around the call to the function
10550 FN called in with_echo_area_buffer. */
10553 with_echo_area_buffer_unwind_data (struct window
*w
)
10556 Lisp_Object vector
, tmp
;
10558 /* Reduce consing by keeping one vector in
10559 Vwith_echo_area_save_vector. */
10560 vector
= Vwith_echo_area_save_vector
;
10561 Vwith_echo_area_save_vector
= Qnil
;
10564 vector
= Fmake_vector (make_number (11), Qnil
);
10566 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10567 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10568 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10572 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10573 ASET (vector
, i
, w
->contents
); ++i
;
10574 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10575 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10576 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10577 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10578 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10579 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10584 for (; i
< end
; ++i
)
10585 ASET (vector
, i
, Qnil
);
10588 eassert (i
== ASIZE (vector
));
10593 /* Restore global state from VECTOR which was created by
10594 with_echo_area_buffer_unwind_data. */
10597 unwind_with_echo_area_buffer (Lisp_Object vector
)
10599 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10600 Vdeactivate_mark
= AREF (vector
, 1);
10601 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10603 if (WINDOWP (AREF (vector
, 3)))
10606 Lisp_Object buffer
;
10608 w
= XWINDOW (AREF (vector
, 3));
10609 buffer
= AREF (vector
, 4);
10611 wset_buffer (w
, buffer
);
10612 set_marker_both (w
->pointm
, buffer
,
10613 XFASTINT (AREF (vector
, 5)),
10614 XFASTINT (AREF (vector
, 6)));
10615 set_marker_both (w
->old_pointm
, buffer
,
10616 XFASTINT (AREF (vector
, 7)),
10617 XFASTINT (AREF (vector
, 8)));
10618 set_marker_both (w
->start
, buffer
,
10619 XFASTINT (AREF (vector
, 9)),
10620 XFASTINT (AREF (vector
, 10)));
10623 Vwith_echo_area_save_vector
= vector
;
10627 /* Set up the echo area for use by print functions. MULTIBYTE_P
10628 means we will print multibyte. */
10631 setup_echo_area_for_printing (bool multibyte_p
)
10633 /* If we can't find an echo area any more, exit. */
10634 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10635 Fkill_emacs (Qnil
);
10637 ensure_echo_area_buffers ();
10639 if (!message_buf_print
)
10641 /* A message has been output since the last time we printed.
10642 Choose a fresh echo area buffer. */
10643 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10644 echo_area_buffer
[0] = echo_buffer
[1];
10646 echo_area_buffer
[0] = echo_buffer
[0];
10648 /* Switch to that buffer and clear it. */
10649 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10650 bset_truncate_lines (current_buffer
, Qnil
);
10654 ptrdiff_t count
= SPECPDL_INDEX ();
10655 specbind (Qinhibit_read_only
, Qt
);
10656 /* Note that undo recording is always disabled. */
10657 del_range (BEG
, Z
);
10658 unbind_to (count
, Qnil
);
10660 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10662 /* Set up the buffer for the multibyteness we need. */
10664 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10665 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10667 /* Raise the frame containing the echo area. */
10668 if (minibuffer_auto_raise
)
10670 struct frame
*sf
= SELECTED_FRAME ();
10671 Lisp_Object mini_window
;
10672 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10673 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10676 message_log_maybe_newline ();
10677 message_buf_print
= true;
10681 if (NILP (echo_area_buffer
[0]))
10683 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10684 echo_area_buffer
[0] = echo_buffer
[1];
10686 echo_area_buffer
[0] = echo_buffer
[0];
10689 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10691 /* Someone switched buffers between print requests. */
10692 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10693 bset_truncate_lines (current_buffer
, Qnil
);
10699 /* Display an echo area message in window W. Value is true if W's
10700 height is changed. If display_last_displayed_message_p,
10701 display the message that was last displayed, otherwise
10702 display the current message. */
10705 display_echo_area (struct window
*w
)
10707 bool no_message_p
, window_height_changed_p
;
10709 /* Temporarily disable garbage collections while displaying the echo
10710 area. This is done because a GC can print a message itself.
10711 That message would modify the echo area buffer's contents while a
10712 redisplay of the buffer is going on, and seriously confuse
10714 ptrdiff_t count
= inhibit_garbage_collection ();
10716 /* If there is no message, we must call display_echo_area_1
10717 nevertheless because it resizes the window. But we will have to
10718 reset the echo_area_buffer in question to nil at the end because
10719 with_echo_area_buffer will sets it to an empty buffer. */
10720 bool i
= display_last_displayed_message_p
;
10721 no_message_p
= NILP (echo_area_buffer
[i
]);
10723 window_height_changed_p
10724 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10725 display_echo_area_1
,
10726 (intptr_t) w
, Qnil
);
10729 echo_area_buffer
[i
] = Qnil
;
10731 unbind_to (count
, Qnil
);
10732 return window_height_changed_p
;
10736 /* Helper for display_echo_area. Display the current buffer which
10737 contains the current echo area message in window W, a mini-window,
10738 a pointer to which is passed in A1. A2..A4 are currently not used.
10739 Change the height of W so that all of the message is displayed.
10740 Value is true if height of W was changed. */
10743 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10746 struct window
*w
= (struct window
*) i1
;
10747 Lisp_Object window
;
10748 struct text_pos start
;
10750 /* We are about to enter redisplay without going through
10751 redisplay_internal, so we need to forget these faces by hand
10753 forget_escape_and_glyphless_faces ();
10755 /* Do this before displaying, so that we have a large enough glyph
10756 matrix for the display. If we can't get enough space for the
10757 whole text, display the last N lines. That works by setting w->start. */
10758 bool window_height_changed_p
= resize_mini_window (w
, false);
10760 /* Use the starting position chosen by resize_mini_window. */
10761 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10764 clear_glyph_matrix (w
->desired_matrix
);
10765 XSETWINDOW (window
, w
);
10766 try_window (window
, start
, 0);
10768 return window_height_changed_p
;
10772 /* Resize the echo area window to exactly the size needed for the
10773 currently displayed message, if there is one. If a mini-buffer
10774 is active, don't shrink it. */
10777 resize_echo_area_exactly (void)
10779 if (BUFFERP (echo_area_buffer
[0])
10780 && WINDOWP (echo_area_window
))
10782 struct window
*w
= XWINDOW (echo_area_window
);
10783 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10784 bool resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10785 (intptr_t) w
, resize_exactly
);
10788 windows_or_buffers_changed
= 42;
10789 update_mode_lines
= 30;
10790 redisplay_internal ();
10796 /* Callback function for with_echo_area_buffer, when used from
10797 resize_echo_area_exactly. A1 contains a pointer to the window to
10798 resize, EXACTLY non-nil means resize the mini-window exactly to the
10799 size of the text displayed. A3 and A4 are not used. Value is what
10800 resize_mini_window returns. */
10803 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10806 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10810 /* Resize mini-window W to fit the size of its contents. EXACT_P
10811 means size the window exactly to the size needed. Otherwise, it's
10812 only enlarged until W's buffer is empty.
10814 Set W->start to the right place to begin display. If the whole
10815 contents fit, start at the beginning. Otherwise, start so as
10816 to make the end of the contents appear. This is particularly
10817 important for y-or-n-p, but seems desirable generally.
10819 Value is true if the window height has been changed. */
10822 resize_mini_window (struct window
*w
, bool exact_p
)
10824 struct frame
*f
= XFRAME (w
->frame
);
10825 bool window_height_changed_p
= false;
10827 eassert (MINI_WINDOW_P (w
));
10829 /* By default, start display at the beginning. */
10830 set_marker_both (w
->start
, w
->contents
,
10831 BUF_BEGV (XBUFFER (w
->contents
)),
10832 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10834 /* Don't resize windows while redisplaying a window; it would
10835 confuse redisplay functions when the size of the window they are
10836 displaying changes from under them. Such a resizing can happen,
10837 for instance, when which-func prints a long message while
10838 we are running fontification-functions. We're running these
10839 functions with safe_call which binds inhibit-redisplay to t. */
10840 if (!NILP (Vinhibit_redisplay
))
10843 /* Nil means don't try to resize. */
10844 if (NILP (Vresize_mini_windows
)
10845 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10848 if (!FRAME_MINIBUF_ONLY_P (f
))
10851 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10852 + WINDOW_PIXEL_HEIGHT (w
));
10853 int unit
= FRAME_LINE_HEIGHT (f
);
10854 int height
, max_height
;
10855 struct text_pos start
;
10856 struct buffer
*old_current_buffer
= NULL
;
10858 if (current_buffer
!= XBUFFER (w
->contents
))
10860 old_current_buffer
= current_buffer
;
10861 set_buffer_internal (XBUFFER (w
->contents
));
10864 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10866 /* Compute the max. number of lines specified by the user. */
10867 if (FLOATP (Vmax_mini_window_height
))
10868 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10869 else if (INTEGERP (Vmax_mini_window_height
))
10870 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10872 max_height
= total_height
/ 4;
10874 /* Correct that max. height if it's bogus. */
10875 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10877 /* Find out the height of the text in the window. */
10878 if (it
.line_wrap
== TRUNCATE
)
10883 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10884 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10885 height
= it
.current_y
+ last_height
;
10887 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10888 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10891 /* Compute a suitable window start. */
10892 if (height
> max_height
)
10894 height
= (max_height
/ unit
) * unit
;
10895 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10896 move_it_vertically_backward (&it
, height
- unit
);
10897 start
= it
.current
.pos
;
10900 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10901 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10903 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10905 /* Let it grow only, until we display an empty message, in which
10906 case the window shrinks again. */
10907 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10909 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10911 FRAME_WINDOWS_FROZEN (f
) = true;
10912 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10913 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10915 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10916 && (exact_p
|| BEGV
== ZV
))
10918 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10920 FRAME_WINDOWS_FROZEN (f
) = false;
10921 shrink_mini_window (w
, true);
10922 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10927 /* Always resize to exact size needed. */
10928 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10930 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10932 FRAME_WINDOWS_FROZEN (f
) = true;
10933 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10934 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10936 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10938 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10940 FRAME_WINDOWS_FROZEN (f
) = false;
10941 shrink_mini_window (w
, true);
10945 FRAME_WINDOWS_FROZEN (f
) = true;
10946 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), true);
10949 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10953 if (old_current_buffer
)
10954 set_buffer_internal (old_current_buffer
);
10957 return window_height_changed_p
;
10961 /* Value is the current message, a string, or nil if there is no
10962 current message. */
10965 current_message (void)
10969 if (!BUFFERP (echo_area_buffer
[0]))
10973 with_echo_area_buffer (0, 0, current_message_1
,
10974 (intptr_t) &msg
, Qnil
);
10976 echo_area_buffer
[0] = Qnil
;
10984 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10987 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10990 *msg
= make_buffer_string (BEG
, Z
, true);
10997 /* Push the current message on Vmessage_stack for later restoration
10998 by restore_message. Value is true if the current message isn't
10999 empty. This is a relatively infrequent operation, so it's not
11000 worth optimizing. */
11003 push_message (void)
11005 Lisp_Object msg
= current_message ();
11006 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11007 return STRINGP (msg
);
11011 /* Restore message display from the top of Vmessage_stack. */
11014 restore_message (void)
11016 eassert (CONSP (Vmessage_stack
));
11017 message3_nolog (XCAR (Vmessage_stack
));
11021 /* Handler for unwind-protect calling pop_message. */
11024 pop_message_unwind (void)
11026 /* Pop the top-most entry off Vmessage_stack. */
11027 eassert (CONSP (Vmessage_stack
));
11028 Vmessage_stack
= XCDR (Vmessage_stack
);
11032 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11033 exits. If the stack is not empty, we have a missing pop_message
11037 check_message_stack (void)
11039 if (!NILP (Vmessage_stack
))
11044 /* Truncate to NCHARS what will be displayed in the echo area the next
11045 time we display it---but don't redisplay it now. */
11048 truncate_echo_area (ptrdiff_t nchars
)
11051 echo_area_buffer
[0] = Qnil
;
11052 else if (!noninteractive
11054 && !NILP (echo_area_buffer
[0]))
11056 struct frame
*sf
= SELECTED_FRAME ();
11057 /* Error messages get reported properly by cmd_error, so this must be
11058 just an informative message; if the frame hasn't really been
11059 initialized yet, just toss it. */
11060 if (sf
->glyphs_initialized_p
)
11061 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11066 /* Helper function for truncate_echo_area. Truncate the current
11067 message to at most NCHARS characters. */
11070 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11072 if (BEG
+ nchars
< Z
)
11073 del_range (BEG
+ nchars
, Z
);
11075 echo_area_buffer
[0] = Qnil
;
11079 /* Set the current message to STRING. */
11082 set_message (Lisp_Object string
)
11084 eassert (STRINGP (string
));
11086 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11088 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11089 message_buf_print
= false;
11090 help_echo_showing_p
= false;
11092 if (STRINGP (Vdebug_on_message
)
11093 && STRINGP (string
)
11094 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11095 call_debugger (list2 (Qerror
, string
));
11099 /* Helper function for set_message. First argument is ignored and second
11100 argument has the same meaning as for set_message.
11101 This function is called with the echo area buffer being current. */
11104 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11106 eassert (STRINGP (string
));
11108 /* Change multibyteness of the echo buffer appropriately. */
11109 if (message_enable_multibyte
11110 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11111 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11113 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11114 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11115 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11117 /* Insert new message at BEG. */
11118 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11120 /* This function takes care of single/multibyte conversion.
11121 We just have to ensure that the echo area buffer has the right
11122 setting of enable_multibyte_characters. */
11123 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), true);
11129 /* Clear messages. CURRENT_P means clear the current message.
11130 LAST_DISPLAYED_P means clear the message last displayed. */
11133 clear_message (bool current_p
, bool last_displayed_p
)
11137 echo_area_buffer
[0] = Qnil
;
11138 message_cleared_p
= true;
11141 if (last_displayed_p
)
11142 echo_area_buffer
[1] = Qnil
;
11144 message_buf_print
= false;
11147 /* Clear garbaged frames.
11149 This function is used where the old redisplay called
11150 redraw_garbaged_frames which in turn called redraw_frame which in
11151 turn called clear_frame. The call to clear_frame was a source of
11152 flickering. I believe a clear_frame is not necessary. It should
11153 suffice in the new redisplay to invalidate all current matrices,
11154 and ensure a complete redisplay of all windows. */
11157 clear_garbaged_frames (void)
11159 if (frame_garbaged
)
11161 Lisp_Object tail
, frame
;
11163 FOR_EACH_FRAME (tail
, frame
)
11165 struct frame
*f
= XFRAME (frame
);
11167 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11172 clear_current_matrices (f
);
11173 fset_redisplay (f
);
11174 f
->garbaged
= false;
11175 f
->resized_p
= false;
11179 frame_garbaged
= false;
11184 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11188 echo_area_display (bool update_frame_p
)
11190 Lisp_Object mini_window
;
11193 bool window_height_changed_p
= false;
11194 struct frame
*sf
= SELECTED_FRAME ();
11196 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11197 w
= XWINDOW (mini_window
);
11198 f
= XFRAME (WINDOW_FRAME (w
));
11200 /* Don't display if frame is invisible or not yet initialized. */
11201 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11204 #ifdef HAVE_WINDOW_SYSTEM
11205 /* When Emacs starts, selected_frame may be the initial terminal
11206 frame. If we let this through, a message would be displayed on
11208 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11210 #endif /* HAVE_WINDOW_SYSTEM */
11212 /* Redraw garbaged frames. */
11213 clear_garbaged_frames ();
11215 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11217 echo_area_window
= mini_window
;
11218 window_height_changed_p
= display_echo_area (w
);
11219 w
->must_be_updated_p
= true;
11221 /* Update the display, unless called from redisplay_internal.
11222 Also don't update the screen during redisplay itself. The
11223 update will happen at the end of redisplay, and an update
11224 here could cause confusion. */
11225 if (update_frame_p
&& !redisplaying_p
)
11229 /* If the display update has been interrupted by pending
11230 input, update mode lines in the frame. Due to the
11231 pending input, it might have been that redisplay hasn't
11232 been called, so that mode lines above the echo area are
11233 garbaged. This looks odd, so we prevent it here. */
11234 if (!display_completed
)
11235 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11237 if (window_height_changed_p
11238 /* Don't do this if Emacs is shutting down. Redisplay
11239 needs to run hooks. */
11240 && !NILP (Vrun_hooks
))
11242 /* Must update other windows. Likewise as in other
11243 cases, don't let this update be interrupted by
11245 ptrdiff_t count
= SPECPDL_INDEX ();
11246 specbind (Qredisplay_dont_pause
, Qt
);
11247 fset_redisplay (f
);
11248 redisplay_internal ();
11249 unbind_to (count
, Qnil
);
11251 else if (FRAME_WINDOW_P (f
) && n
== 0)
11253 /* Window configuration is the same as before.
11254 Can do with a display update of the echo area,
11255 unless we displayed some mode lines. */
11256 update_single_window (w
);
11260 update_frame (f
, true, true);
11262 /* If cursor is in the echo area, make sure that the next
11263 redisplay displays the minibuffer, so that the cursor will
11264 be replaced with what the minibuffer wants. */
11265 if (cursor_in_echo_area
)
11266 wset_redisplay (XWINDOW (mini_window
));
11269 else if (!EQ (mini_window
, selected_window
))
11270 wset_redisplay (XWINDOW (mini_window
));
11272 /* Last displayed message is now the current message. */
11273 echo_area_buffer
[1] = echo_area_buffer
[0];
11274 /* Inform read_char that we're not echoing. */
11275 echo_message_buffer
= Qnil
;
11277 /* Prevent redisplay optimization in redisplay_internal by resetting
11278 this_line_start_pos. This is done because the mini-buffer now
11279 displays the message instead of its buffer text. */
11280 if (EQ (mini_window
, selected_window
))
11281 CHARPOS (this_line_start_pos
) = 0;
11283 if (window_height_changed_p
)
11285 fset_redisplay (f
);
11287 /* If window configuration was changed, frames may have been
11288 marked garbaged. Clear them or we will experience
11289 surprises wrt scrolling.
11290 FIXME: How/why/when? */
11291 clear_garbaged_frames ();
11295 /* True if W's buffer was changed but not saved. */
11298 window_buffer_changed (struct window
*w
)
11300 struct buffer
*b
= XBUFFER (w
->contents
);
11302 eassert (BUFFER_LIVE_P (b
));
11304 return (BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
;
11307 /* True if W has %c in its mode line and mode line should be updated. */
11310 mode_line_update_needed (struct window
*w
)
11312 return (w
->column_number_displayed
!= -1
11313 && !(PT
== w
->last_point
&& !window_outdated (w
))
11314 && (w
->column_number_displayed
!= current_column ()));
11317 /* True if window start of W is frozen and may not be changed during
11321 window_frozen_p (struct window
*w
)
11323 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11325 Lisp_Object window
;
11327 XSETWINDOW (window
, w
);
11328 if (MINI_WINDOW_P (w
))
11330 else if (EQ (window
, selected_window
))
11332 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11333 && EQ (window
, Vminibuf_scroll_window
))
11334 /* This special window can't be frozen too. */
11342 /***********************************************************************
11343 Mode Lines and Frame Titles
11344 ***********************************************************************/
11346 /* A buffer for constructing non-propertized mode-line strings and
11347 frame titles in it; allocated from the heap in init_xdisp and
11348 resized as needed in store_mode_line_noprop_char. */
11350 static char *mode_line_noprop_buf
;
11352 /* The buffer's end, and a current output position in it. */
11354 static char *mode_line_noprop_buf_end
;
11355 static char *mode_line_noprop_ptr
;
11357 #define MODE_LINE_NOPROP_LEN(start) \
11358 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11361 MODE_LINE_DISPLAY
= 0,
11365 } mode_line_target
;
11367 /* Alist that caches the results of :propertize.
11368 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11369 static Lisp_Object mode_line_proptrans_alist
;
11371 /* List of strings making up the mode-line. */
11372 static Lisp_Object mode_line_string_list
;
11374 /* Base face property when building propertized mode line string. */
11375 static Lisp_Object mode_line_string_face
;
11376 static Lisp_Object mode_line_string_face_prop
;
11379 /* Unwind data for mode line strings */
11381 static Lisp_Object Vmode_line_unwind_vector
;
11384 format_mode_line_unwind_data (struct frame
*target_frame
,
11385 struct buffer
*obuf
,
11387 bool save_proptrans
)
11389 Lisp_Object vector
, tmp
;
11391 /* Reduce consing by keeping one vector in
11392 Vwith_echo_area_save_vector. */
11393 vector
= Vmode_line_unwind_vector
;
11394 Vmode_line_unwind_vector
= Qnil
;
11397 vector
= Fmake_vector (make_number (10), Qnil
);
11399 ASET (vector
, 0, make_number (mode_line_target
));
11400 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11401 ASET (vector
, 2, mode_line_string_list
);
11402 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11403 ASET (vector
, 4, mode_line_string_face
);
11404 ASET (vector
, 5, mode_line_string_face_prop
);
11407 XSETBUFFER (tmp
, obuf
);
11410 ASET (vector
, 6, tmp
);
11411 ASET (vector
, 7, owin
);
11414 /* Similarly to `with-selected-window', if the operation selects
11415 a window on another frame, we must restore that frame's
11416 selected window, and (for a tty) the top-frame. */
11417 ASET (vector
, 8, target_frame
->selected_window
);
11418 if (FRAME_TERMCAP_P (target_frame
))
11419 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11426 unwind_format_mode_line (Lisp_Object vector
)
11428 Lisp_Object old_window
= AREF (vector
, 7);
11429 Lisp_Object target_frame_window
= AREF (vector
, 8);
11430 Lisp_Object old_top_frame
= AREF (vector
, 9);
11432 mode_line_target
= XINT (AREF (vector
, 0));
11433 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11434 mode_line_string_list
= AREF (vector
, 2);
11435 if (! EQ (AREF (vector
, 3), Qt
))
11436 mode_line_proptrans_alist
= AREF (vector
, 3);
11437 mode_line_string_face
= AREF (vector
, 4);
11438 mode_line_string_face_prop
= AREF (vector
, 5);
11440 /* Select window before buffer, since it may change the buffer. */
11441 if (!NILP (old_window
))
11443 /* If the operation that we are unwinding had selected a window
11444 on a different frame, reset its frame-selected-window. For a
11445 text terminal, reset its top-frame if necessary. */
11446 if (!NILP (target_frame_window
))
11449 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11451 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11452 Fselect_window (target_frame_window
, Qt
);
11454 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11455 Fselect_frame (old_top_frame
, Qt
);
11458 Fselect_window (old_window
, Qt
);
11461 if (!NILP (AREF (vector
, 6)))
11463 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11464 ASET (vector
, 6, Qnil
);
11467 Vmode_line_unwind_vector
= vector
;
11471 /* Store a single character C for the frame title in mode_line_noprop_buf.
11472 Re-allocate mode_line_noprop_buf if necessary. */
11475 store_mode_line_noprop_char (char c
)
11477 /* If output position has reached the end of the allocated buffer,
11478 increase the buffer's size. */
11479 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11481 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11482 ptrdiff_t size
= len
;
11483 mode_line_noprop_buf
=
11484 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11485 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11486 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11489 *mode_line_noprop_ptr
++ = c
;
11493 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11494 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11495 characters that yield more columns than PRECISION; PRECISION <= 0
11496 means copy the whole string. Pad with spaces until FIELD_WIDTH
11497 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11498 pad. Called from display_mode_element when it is used to build a
11502 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11504 const unsigned char *str
= (const unsigned char *) string
;
11506 ptrdiff_t dummy
, nbytes
;
11508 /* Copy at most PRECISION chars from STR. */
11509 nbytes
= strlen (string
);
11510 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11512 store_mode_line_noprop_char (*str
++);
11514 /* Fill up with spaces until FIELD_WIDTH reached. */
11515 while (field_width
> 0
11516 && n
< field_width
)
11518 store_mode_line_noprop_char (' ');
11525 /***********************************************************************
11527 ***********************************************************************/
11529 #ifdef HAVE_WINDOW_SYSTEM
11531 /* Set the title of FRAME, if it has changed. The title format is
11532 Vicon_title_format if FRAME is iconified, otherwise it is
11533 frame_title_format. */
11536 x_consider_frame_title (Lisp_Object frame
)
11538 struct frame
*f
= XFRAME (frame
);
11540 if (FRAME_WINDOW_P (f
)
11541 || FRAME_MINIBUF_ONLY_P (f
)
11542 || f
->explicit_name
)
11544 /* Do we have more than one visible frame on this X display? */
11545 Lisp_Object tail
, other_frame
, fmt
;
11546 ptrdiff_t title_start
;
11550 ptrdiff_t count
= SPECPDL_INDEX ();
11552 FOR_EACH_FRAME (tail
, other_frame
)
11554 struct frame
*tf
= XFRAME (other_frame
);
11557 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11558 && !FRAME_MINIBUF_ONLY_P (tf
)
11559 && !EQ (other_frame
, tip_frame
)
11560 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11564 /* Set global variable indicating that multiple frames exist. */
11565 multiple_frames
= CONSP (tail
);
11567 /* Switch to the buffer of selected window of the frame. Set up
11568 mode_line_target so that display_mode_element will output into
11569 mode_line_noprop_buf; then display the title. */
11570 record_unwind_protect (unwind_format_mode_line
,
11571 format_mode_line_unwind_data
11572 (f
, current_buffer
, selected_window
, false));
11574 Fselect_window (f
->selected_window
, Qt
);
11575 set_buffer_internal_1
11576 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11577 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11579 mode_line_target
= MODE_LINE_TITLE
;
11580 title_start
= MODE_LINE_NOPROP_LEN (0);
11581 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11582 NULL
, DEFAULT_FACE_ID
);
11583 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, false);
11584 len
= MODE_LINE_NOPROP_LEN (title_start
);
11585 title
= mode_line_noprop_buf
+ title_start
;
11586 unbind_to (count
, Qnil
);
11588 /* Set the title only if it's changed. This avoids consing in
11589 the common case where it hasn't. (If it turns out that we've
11590 already wasted too much time by walking through the list with
11591 display_mode_element, then we might need to optimize at a
11592 higher level than this.) */
11593 if (! STRINGP (f
->name
)
11594 || SBYTES (f
->name
) != len
11595 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11596 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11600 #endif /* not HAVE_WINDOW_SYSTEM */
11603 /***********************************************************************
11605 ***********************************************************************/
11607 /* True if we will not redisplay all visible windows. */
11608 #define REDISPLAY_SOME_P() \
11609 ((windows_or_buffers_changed == 0 \
11610 || windows_or_buffers_changed == REDISPLAY_SOME) \
11611 && (update_mode_lines == 0 \
11612 || update_mode_lines == REDISPLAY_SOME))
11614 /* Prepare for redisplay by updating menu-bar item lists when
11615 appropriate. This can call eval. */
11618 prepare_menu_bars (void)
11620 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11621 bool some_windows
= REDISPLAY_SOME_P ();
11622 Lisp_Object tooltip_frame
;
11624 #ifdef HAVE_WINDOW_SYSTEM
11625 tooltip_frame
= tip_frame
;
11627 tooltip_frame
= Qnil
;
11630 if (FUNCTIONP (Vpre_redisplay_function
))
11632 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11633 if (all_windows
&& some_windows
)
11635 Lisp_Object ws
= window_list ();
11636 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11638 Lisp_Object
this = XCAR (ws
);
11639 struct window
*w
= XWINDOW (this);
11641 || XFRAME (w
->frame
)->redisplay
11642 || XBUFFER (w
->contents
)->text
->redisplay
)
11644 windows
= Fcons (this, windows
);
11648 safe__call1 (true, Vpre_redisplay_function
, windows
);
11651 /* Update all frame titles based on their buffer names, etc. We do
11652 this before the menu bars so that the buffer-menu will show the
11653 up-to-date frame titles. */
11654 #ifdef HAVE_WINDOW_SYSTEM
11657 Lisp_Object tail
, frame
;
11659 FOR_EACH_FRAME (tail
, frame
)
11661 struct frame
*f
= XFRAME (frame
);
11662 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11666 && !XBUFFER (w
->contents
)->text
->redisplay
)
11669 if (!EQ (frame
, tooltip_frame
)
11670 && (FRAME_ICONIFIED_P (f
)
11671 || FRAME_VISIBLE_P (f
) == 1
11672 /* Exclude TTY frames that are obscured because they
11673 are not the top frame on their console. This is
11674 because x_consider_frame_title actually switches
11675 to the frame, which for TTY frames means it is
11676 marked as garbaged, and will be completely
11677 redrawn on the next redisplay cycle. This causes
11678 TTY frames to be completely redrawn, when there
11679 are more than one of them, even though nothing
11680 should be changed on display. */
11681 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11682 x_consider_frame_title (frame
);
11685 #endif /* HAVE_WINDOW_SYSTEM */
11687 /* Update the menu bar item lists, if appropriate. This has to be
11688 done before any actual redisplay or generation of display lines. */
11692 Lisp_Object tail
, frame
;
11693 ptrdiff_t count
= SPECPDL_INDEX ();
11694 /* True means that update_menu_bar has run its hooks
11695 so any further calls to update_menu_bar shouldn't do so again. */
11696 bool menu_bar_hooks_run
= false;
11698 record_unwind_save_match_data ();
11700 FOR_EACH_FRAME (tail
, frame
)
11702 struct frame
*f
= XFRAME (frame
);
11703 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11705 /* Ignore tooltip frame. */
11706 if (EQ (frame
, tooltip_frame
))
11712 && !XBUFFER (w
->contents
)->text
->redisplay
)
11715 /* If a window on this frame changed size, report that to
11716 the user and clear the size-change flag. */
11717 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11719 Lisp_Object functions
;
11721 /* Clear flag first in case we get an error below. */
11722 FRAME_WINDOW_SIZES_CHANGED (f
) = false;
11723 functions
= Vwindow_size_change_functions
;
11725 while (CONSP (functions
))
11727 if (!EQ (XCAR (functions
), Qt
))
11728 call1 (XCAR (functions
), frame
);
11729 functions
= XCDR (functions
);
11733 menu_bar_hooks_run
= update_menu_bar (f
, false, menu_bar_hooks_run
);
11734 #ifdef HAVE_WINDOW_SYSTEM
11735 update_tool_bar (f
, false);
11739 unbind_to (count
, Qnil
);
11743 struct frame
*sf
= SELECTED_FRAME ();
11744 update_menu_bar (sf
, true, false);
11745 #ifdef HAVE_WINDOW_SYSTEM
11746 update_tool_bar (sf
, true);
11752 /* Update the menu bar item list for frame F. This has to be done
11753 before we start to fill in any display lines, because it can call
11756 If SAVE_MATCH_DATA, we must save and restore it here.
11758 If HOOKS_RUN, a previous call to update_menu_bar
11759 already ran the menu bar hooks for this redisplay, so there
11760 is no need to run them again. The return value is the
11761 updated value of this flag, to pass to the next call. */
11764 update_menu_bar (struct frame
*f
, bool save_match_data
, bool hooks_run
)
11766 Lisp_Object window
;
11769 /* If called recursively during a menu update, do nothing. This can
11770 happen when, for instance, an activate-menubar-hook causes a
11772 if (inhibit_menubar_update
)
11775 window
= FRAME_SELECTED_WINDOW (f
);
11776 w
= XWINDOW (window
);
11778 if (FRAME_WINDOW_P (f
)
11780 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11781 || defined (HAVE_NS) || defined (USE_GTK)
11782 FRAME_EXTERNAL_MENU_BAR (f
)
11784 FRAME_MENU_BAR_LINES (f
) > 0
11786 : FRAME_MENU_BAR_LINES (f
) > 0)
11788 /* If the user has switched buffers or windows, we need to
11789 recompute to reflect the new bindings. But we'll
11790 recompute when update_mode_lines is set too; that means
11791 that people can use force-mode-line-update to request
11792 that the menu bar be recomputed. The adverse effect on
11793 the rest of the redisplay algorithm is about the same as
11794 windows_or_buffers_changed anyway. */
11795 if (windows_or_buffers_changed
11796 /* This used to test w->update_mode_line, but we believe
11797 there is no need to recompute the menu in that case. */
11798 || update_mode_lines
11799 || window_buffer_changed (w
))
11801 struct buffer
*prev
= current_buffer
;
11802 ptrdiff_t count
= SPECPDL_INDEX ();
11804 specbind (Qinhibit_menubar_update
, Qt
);
11806 set_buffer_internal_1 (XBUFFER (w
->contents
));
11807 if (save_match_data
)
11808 record_unwind_save_match_data ();
11809 if (NILP (Voverriding_local_map_menu_flag
))
11811 specbind (Qoverriding_terminal_local_map
, Qnil
);
11812 specbind (Qoverriding_local_map
, Qnil
);
11817 /* Run the Lucid hook. */
11818 safe_run_hooks (Qactivate_menubar_hook
);
11820 /* If it has changed current-menubar from previous value,
11821 really recompute the menu-bar from the value. */
11822 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11823 call0 (Qrecompute_lucid_menubar
);
11825 safe_run_hooks (Qmenu_bar_update_hook
);
11830 XSETFRAME (Vmenu_updating_frame
, f
);
11831 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11833 /* Redisplay the menu bar in case we changed it. */
11834 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11835 || defined (HAVE_NS) || defined (USE_GTK)
11836 if (FRAME_WINDOW_P (f
))
11838 #if defined (HAVE_NS)
11839 /* All frames on Mac OS share the same menubar. So only
11840 the selected frame should be allowed to set it. */
11841 if (f
== SELECTED_FRAME ())
11843 set_frame_menubar (f
, false, false);
11846 /* On a terminal screen, the menu bar is an ordinary screen
11847 line, and this makes it get updated. */
11848 w
->update_mode_line
= true;
11849 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11850 /* In the non-toolkit version, the menu bar is an ordinary screen
11851 line, and this makes it get updated. */
11852 w
->update_mode_line
= true;
11853 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11855 unbind_to (count
, Qnil
);
11856 set_buffer_internal_1 (prev
);
11863 /***********************************************************************
11865 ***********************************************************************/
11867 #ifdef HAVE_WINDOW_SYSTEM
11869 /* Select `frame' temporarily without running all the code in
11871 FIXME: Maybe do_switch_frame should be trimmed down similarly
11872 when `norecord' is set. */
11874 fast_set_selected_frame (Lisp_Object frame
)
11876 if (!EQ (selected_frame
, frame
))
11878 selected_frame
= frame
;
11879 selected_window
= XFRAME (frame
)->selected_window
;
11883 /* Update the tool-bar item list for frame F. This has to be done
11884 before we start to fill in any display lines. Called from
11885 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
11886 and restore it here. */
11889 update_tool_bar (struct frame
*f
, bool save_match_data
)
11891 #if defined (USE_GTK) || defined (HAVE_NS)
11892 bool do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11894 bool do_update
= (WINDOWP (f
->tool_bar_window
)
11895 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11900 Lisp_Object window
;
11903 window
= FRAME_SELECTED_WINDOW (f
);
11904 w
= XWINDOW (window
);
11906 /* If the user has switched buffers or windows, we need to
11907 recompute to reflect the new bindings. But we'll
11908 recompute when update_mode_lines is set too; that means
11909 that people can use force-mode-line-update to request
11910 that the menu bar be recomputed. The adverse effect on
11911 the rest of the redisplay algorithm is about the same as
11912 windows_or_buffers_changed anyway. */
11913 if (windows_or_buffers_changed
11914 || w
->update_mode_line
11915 || update_mode_lines
11916 || window_buffer_changed (w
))
11918 struct buffer
*prev
= current_buffer
;
11919 ptrdiff_t count
= SPECPDL_INDEX ();
11920 Lisp_Object frame
, new_tool_bar
;
11921 int new_n_tool_bar
;
11923 /* Set current_buffer to the buffer of the selected
11924 window of the frame, so that we get the right local
11926 set_buffer_internal_1 (XBUFFER (w
->contents
));
11928 /* Save match data, if we must. */
11929 if (save_match_data
)
11930 record_unwind_save_match_data ();
11932 /* Make sure that we don't accidentally use bogus keymaps. */
11933 if (NILP (Voverriding_local_map_menu_flag
))
11935 specbind (Qoverriding_terminal_local_map
, Qnil
);
11936 specbind (Qoverriding_local_map
, Qnil
);
11939 /* We must temporarily set the selected frame to this frame
11940 before calling tool_bar_items, because the calculation of
11941 the tool-bar keymap uses the selected frame (see
11942 `tool-bar-make-keymap' in tool-bar.el). */
11943 eassert (EQ (selected_window
,
11944 /* Since we only explicitly preserve selected_frame,
11945 check that selected_window would be redundant. */
11946 XFRAME (selected_frame
)->selected_window
));
11947 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11948 XSETFRAME (frame
, f
);
11949 fast_set_selected_frame (frame
);
11951 /* Build desired tool-bar items from keymaps. */
11953 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11956 /* Redisplay the tool-bar if we changed it. */
11957 if (new_n_tool_bar
!= f
->n_tool_bar_items
11958 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11960 /* Redisplay that happens asynchronously due to an expose event
11961 may access f->tool_bar_items. Make sure we update both
11962 variables within BLOCK_INPUT so no such event interrupts. */
11964 fset_tool_bar_items (f
, new_tool_bar
);
11965 f
->n_tool_bar_items
= new_n_tool_bar
;
11966 w
->update_mode_line
= true;
11970 unbind_to (count
, Qnil
);
11971 set_buffer_internal_1 (prev
);
11976 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11978 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11979 F's desired tool-bar contents. F->tool_bar_items must have
11980 been set up previously by calling prepare_menu_bars. */
11983 build_desired_tool_bar_string (struct frame
*f
)
11985 int i
, size
, size_needed
;
11986 Lisp_Object image
, plist
;
11988 image
= plist
= Qnil
;
11990 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11991 Otherwise, make a new string. */
11993 /* The size of the string we might be able to reuse. */
11994 size
= (STRINGP (f
->desired_tool_bar_string
)
11995 ? SCHARS (f
->desired_tool_bar_string
)
11998 /* We need one space in the string for each image. */
11999 size_needed
= f
->n_tool_bar_items
;
12001 /* Reuse f->desired_tool_bar_string, if possible. */
12002 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12003 fset_desired_tool_bar_string
12004 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12007 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12008 Fremove_text_properties (make_number (0), make_number (size
),
12009 props
, f
->desired_tool_bar_string
);
12012 /* Put a `display' property on the string for the images to display,
12013 put a `menu_item' property on tool-bar items with a value that
12014 is the index of the item in F's tool-bar item vector. */
12015 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12017 #define PROP(IDX) \
12018 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12020 bool enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12021 bool selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12022 int hmargin
, vmargin
, relief
, idx
, end
;
12024 /* If image is a vector, choose the image according to the
12026 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12027 if (VECTORP (image
))
12031 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12032 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12035 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12036 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12038 eassert (ASIZE (image
) >= idx
);
12039 image
= AREF (image
, idx
);
12044 /* Ignore invalid image specifications. */
12045 if (!valid_image_p (image
))
12048 /* Display the tool-bar button pressed, or depressed. */
12049 plist
= Fcopy_sequence (XCDR (image
));
12051 /* Compute margin and relief to draw. */
12052 relief
= (tool_bar_button_relief
>= 0
12053 ? tool_bar_button_relief
12054 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12055 hmargin
= vmargin
= relief
;
12057 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12058 INT_MAX
- max (hmargin
, vmargin
)))
12060 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12061 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12063 else if (CONSP (Vtool_bar_button_margin
))
12065 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12066 INT_MAX
- hmargin
))
12067 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12069 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12070 INT_MAX
- vmargin
))
12071 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12074 if (auto_raise_tool_bar_buttons_p
)
12076 /* Add a `:relief' property to the image spec if the item is
12080 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12087 /* If image is selected, display it pressed, i.e. with a
12088 negative relief. If it's not selected, display it with a
12090 plist
= Fplist_put (plist
, QCrelief
,
12092 ? make_number (-relief
)
12093 : make_number (relief
)));
12098 /* Put a margin around the image. */
12099 if (hmargin
|| vmargin
)
12101 if (hmargin
== vmargin
)
12102 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12104 plist
= Fplist_put (plist
, QCmargin
,
12105 Fcons (make_number (hmargin
),
12106 make_number (vmargin
)));
12109 /* If button is not enabled, and we don't have special images
12110 for the disabled state, make the image appear disabled by
12111 applying an appropriate algorithm to it. */
12112 if (!enabled_p
&& idx
< 0)
12113 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12115 /* Put a `display' text property on the string for the image to
12116 display. Put a `menu-item' property on the string that gives
12117 the start of this item's properties in the tool-bar items
12119 image
= Fcons (Qimage
, plist
);
12120 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12121 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12123 /* Let the last image hide all remaining spaces in the tool bar
12124 string. The string can be longer than needed when we reuse a
12125 previous string. */
12126 if (i
+ 1 == f
->n_tool_bar_items
)
12127 end
= SCHARS (f
->desired_tool_bar_string
);
12130 Fadd_text_properties (make_number (i
), make_number (end
),
12131 props
, f
->desired_tool_bar_string
);
12137 /* Display one line of the tool-bar of frame IT->f.
12139 HEIGHT specifies the desired height of the tool-bar line.
12140 If the actual height of the glyph row is less than HEIGHT, the
12141 row's height is increased to HEIGHT, and the icons are centered
12142 vertically in the new height.
12144 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12145 count a final empty row in case the tool-bar width exactly matches
12150 display_tool_bar_line (struct it
*it
, int height
)
12152 struct glyph_row
*row
= it
->glyph_row
;
12153 int max_x
= it
->last_visible_x
;
12154 struct glyph
*last
;
12156 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12157 clear_glyph_row (row
);
12158 row
->enabled_p
= true;
12159 row
->y
= it
->current_y
;
12161 /* Note that this isn't made use of if the face hasn't a box,
12162 so there's no need to check the face here. */
12163 it
->start_of_box_run_p
= true;
12165 while (it
->current_x
< max_x
)
12167 int x
, n_glyphs_before
, i
, nglyphs
;
12168 struct it it_before
;
12170 /* Get the next display element. */
12171 if (!get_next_display_element (it
))
12173 /* Don't count empty row if we are counting needed tool-bar lines. */
12174 if (height
< 0 && !it
->hpos
)
12179 /* Produce glyphs. */
12180 n_glyphs_before
= row
->used
[TEXT_AREA
];
12183 PRODUCE_GLYPHS (it
);
12185 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12187 x
= it_before
.current_x
;
12188 while (i
< nglyphs
)
12190 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12192 if (x
+ glyph
->pixel_width
> max_x
)
12194 /* Glyph doesn't fit on line. Backtrack. */
12195 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12197 /* If this is the only glyph on this line, it will never fit on the
12198 tool-bar, so skip it. But ensure there is at least one glyph,
12199 so we don't accidentally disable the tool-bar. */
12200 if (n_glyphs_before
== 0
12201 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12207 x
+= glyph
->pixel_width
;
12211 /* Stop at line end. */
12212 if (ITERATOR_AT_END_OF_LINE_P (it
))
12215 set_iterator_to_next (it
, true);
12220 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12222 /* Use default face for the border below the tool bar.
12224 FIXME: When auto-resize-tool-bars is grow-only, there is
12225 no additional border below the possibly empty tool-bar lines.
12226 So to make the extra empty lines look "normal", we have to
12227 use the tool-bar face for the border too. */
12228 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12229 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12230 it
->face_id
= DEFAULT_FACE_ID
;
12232 extend_face_to_end_of_line (it
);
12233 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12234 last
->right_box_line_p
= true;
12235 if (last
== row
->glyphs
[TEXT_AREA
])
12236 last
->left_box_line_p
= true;
12238 /* Make line the desired height and center it vertically. */
12239 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12241 /* Don't add more than one line height. */
12242 height
%= FRAME_LINE_HEIGHT (it
->f
);
12243 it
->max_ascent
+= height
/ 2;
12244 it
->max_descent
+= (height
+ 1) / 2;
12247 compute_line_metrics (it
);
12249 /* If line is empty, make it occupy the rest of the tool-bar. */
12250 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12252 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12253 row
->visible_height
= row
->height
;
12254 row
->ascent
= row
->phys_ascent
= 0;
12255 row
->extra_line_spacing
= 0;
12258 row
->full_width_p
= true;
12259 row
->continued_p
= false;
12260 row
->truncated_on_left_p
= false;
12261 row
->truncated_on_right_p
= false;
12263 it
->current_x
= it
->hpos
= 0;
12264 it
->current_y
+= row
->height
;
12270 /* Value is the number of pixels needed to make all tool-bar items of
12271 frame F visible. The actual number of glyph rows needed is
12272 returned in *N_ROWS if non-NULL. */
12274 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12276 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12278 /* tool_bar_height is called from redisplay_tool_bar after building
12279 the desired matrix, so use (unused) mode-line row as temporary row to
12280 avoid destroying the first tool-bar row. */
12281 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12283 /* Initialize an iterator for iteration over
12284 F->desired_tool_bar_string in the tool-bar window of frame F. */
12285 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12286 temp_row
->reversed_p
= false;
12287 it
.first_visible_x
= 0;
12288 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12289 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12290 it
.paragraph_embedding
= L2R
;
12292 while (!ITERATOR_AT_END_P (&it
))
12294 clear_glyph_row (temp_row
);
12295 it
.glyph_row
= temp_row
;
12296 display_tool_bar_line (&it
, -1);
12298 clear_glyph_row (temp_row
);
12300 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12302 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12305 return it
.current_y
;
12307 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12310 #endif /* !USE_GTK && !HAVE_NS */
12312 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12314 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12315 If FRAME is nil or omitted, use the selected frame. Optional argument
12316 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12317 (Lisp_Object frame
, Lisp_Object pixelwise
)
12321 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12322 struct frame
*f
= decode_any_frame (frame
);
12324 if (WINDOWP (f
->tool_bar_window
)
12325 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12327 update_tool_bar (f
, true);
12328 if (f
->n_tool_bar_items
)
12330 build_desired_tool_bar_string (f
);
12331 height
= tool_bar_height (f
, NULL
, !NILP (pixelwise
));
12336 return make_number (height
);
12340 /* Display the tool-bar of frame F. Value is true if tool-bar's
12341 height should be changed. */
12343 redisplay_tool_bar (struct frame
*f
)
12345 f
->tool_bar_redisplayed
= true;
12346 #if defined (USE_GTK) || defined (HAVE_NS)
12348 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12349 update_frame_tool_bar (f
);
12352 #else /* !USE_GTK && !HAVE_NS */
12356 struct glyph_row
*row
;
12358 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12359 do anything. This means you must start with tool-bar-lines
12360 non-zero to get the auto-sizing effect. Or in other words, you
12361 can turn off tool-bars by specifying tool-bar-lines zero. */
12362 if (!WINDOWP (f
->tool_bar_window
)
12363 || (w
= XWINDOW (f
->tool_bar_window
),
12364 WINDOW_TOTAL_LINES (w
) == 0))
12367 /* Set up an iterator for the tool-bar window. */
12368 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12369 it
.first_visible_x
= 0;
12370 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12371 row
= it
.glyph_row
;
12372 row
->reversed_p
= false;
12374 /* Build a string that represents the contents of the tool-bar. */
12375 build_desired_tool_bar_string (f
);
12376 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12377 /* FIXME: This should be controlled by a user option. But it
12378 doesn't make sense to have an R2L tool bar if the menu bar cannot
12379 be drawn also R2L, and making the menu bar R2L is tricky due
12380 toolkit-specific code that implements it. If an R2L tool bar is
12381 ever supported, display_tool_bar_line should also be augmented to
12382 call unproduce_glyphs like display_line and display_string
12384 it
.paragraph_embedding
= L2R
;
12386 if (f
->n_tool_bar_rows
== 0)
12388 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, true);
12390 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12392 x_change_tool_bar_height (f
, new_height
);
12393 frame_default_tool_bar_height
= new_height
;
12394 /* Always do that now. */
12395 clear_glyph_matrix (w
->desired_matrix
);
12396 f
->fonts_changed
= true;
12401 /* Display as many lines as needed to display all tool-bar items. */
12403 if (f
->n_tool_bar_rows
> 0)
12405 int border
, rows
, height
, extra
;
12407 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12408 border
= XINT (Vtool_bar_border
);
12409 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12410 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12411 else if (EQ (Vtool_bar_border
, Qborder_width
))
12412 border
= f
->border_width
;
12418 rows
= f
->n_tool_bar_rows
;
12419 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12420 extra
= it
.last_visible_y
- border
- height
* rows
;
12422 while (it
.current_y
< it
.last_visible_y
)
12425 if (extra
> 0 && rows
-- > 0)
12427 h
= (extra
+ rows
- 1) / rows
;
12430 display_tool_bar_line (&it
, height
+ h
);
12435 while (it
.current_y
< it
.last_visible_y
)
12436 display_tool_bar_line (&it
, 0);
12439 /* It doesn't make much sense to try scrolling in the tool-bar
12440 window, so don't do it. */
12441 w
->desired_matrix
->no_scrolling_p
= true;
12442 w
->must_be_updated_p
= true;
12444 if (!NILP (Vauto_resize_tool_bars
))
12446 bool change_height_p
= true;
12448 /* If we couldn't display everything, change the tool-bar's
12449 height if there is room for more. */
12450 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12451 change_height_p
= true;
12453 /* We subtract 1 because display_tool_bar_line advances the
12454 glyph_row pointer before returning to its caller. We want to
12455 examine the last glyph row produced by
12456 display_tool_bar_line. */
12457 row
= it
.glyph_row
- 1;
12459 /* If there are blank lines at the end, except for a partially
12460 visible blank line at the end that is smaller than
12461 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12462 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12463 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12464 change_height_p
= true;
12466 /* If row displays tool-bar items, but is partially visible,
12467 change the tool-bar's height. */
12468 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12469 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12470 change_height_p
= true;
12472 /* Resize windows as needed by changing the `tool-bar-lines'
12473 frame parameter. */
12474 if (change_height_p
)
12477 int new_height
= tool_bar_height (f
, &nrows
, true);
12479 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12480 && !f
->minimize_tool_bar_window_p
)
12481 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12482 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12483 f
->minimize_tool_bar_window_p
= false;
12485 if (change_height_p
)
12487 x_change_tool_bar_height (f
, new_height
);
12488 frame_default_tool_bar_height
= new_height
;
12489 clear_glyph_matrix (w
->desired_matrix
);
12490 f
->n_tool_bar_rows
= nrows
;
12491 f
->fonts_changed
= true;
12498 f
->minimize_tool_bar_window_p
= false;
12501 #endif /* USE_GTK || HAVE_NS */
12504 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12506 /* Get information about the tool-bar item which is displayed in GLYPH
12507 on frame F. Return in *PROP_IDX the index where tool-bar item
12508 properties start in F->tool_bar_items. Value is false if
12509 GLYPH doesn't display a tool-bar item. */
12512 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12517 /* This function can be called asynchronously, which means we must
12518 exclude any possibility that Fget_text_property signals an
12520 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12521 charpos
= max (0, charpos
);
12523 /* Get the text property `menu-item' at pos. The value of that
12524 property is the start index of this item's properties in
12525 F->tool_bar_items. */
12526 prop
= Fget_text_property (make_number (charpos
),
12527 Qmenu_item
, f
->current_tool_bar_string
);
12528 if (! INTEGERP (prop
))
12530 *prop_idx
= XINT (prop
);
12535 /* Get information about the tool-bar item at position X/Y on frame F.
12536 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12537 the current matrix of the tool-bar window of F, or NULL if not
12538 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12539 item in F->tool_bar_items. Value is
12541 -1 if X/Y is not on a tool-bar item
12542 0 if X/Y is on the same item that was highlighted before.
12546 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12547 int *hpos
, int *vpos
, int *prop_idx
)
12549 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12550 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12553 /* Find the glyph under X/Y. */
12554 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12555 if (*glyph
== NULL
)
12558 /* Get the start of this tool-bar item's properties in
12559 f->tool_bar_items. */
12560 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12563 /* Is mouse on the highlighted item? */
12564 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12565 && *vpos
>= hlinfo
->mouse_face_beg_row
12566 && *vpos
<= hlinfo
->mouse_face_end_row
12567 && (*vpos
> hlinfo
->mouse_face_beg_row
12568 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12569 && (*vpos
< hlinfo
->mouse_face_end_row
12570 || *hpos
< hlinfo
->mouse_face_end_col
12571 || hlinfo
->mouse_face_past_end
))
12579 Handle mouse button event on the tool-bar of frame F, at
12580 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12581 false for button release. MODIFIERS is event modifiers for button
12585 handle_tool_bar_click (struct frame
*f
, int x
, int y
, bool down_p
,
12588 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12589 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12590 int hpos
, vpos
, prop_idx
;
12591 struct glyph
*glyph
;
12592 Lisp_Object enabled_p
;
12595 /* If not on the highlighted tool-bar item, and mouse-highlight is
12596 non-nil, return. This is so we generate the tool-bar button
12597 click only when the mouse button is released on the same item as
12598 where it was pressed. However, when mouse-highlight is disabled,
12599 generate the click when the button is released regardless of the
12600 highlight, since tool-bar items are not highlighted in that
12602 frame_to_window_pixel_xy (w
, &x
, &y
);
12603 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12605 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12608 /* When mouse-highlight is off, generate the click for the item
12609 where the button was pressed, disregarding where it was
12611 if (NILP (Vmouse_highlight
) && !down_p
)
12612 prop_idx
= f
->last_tool_bar_item
;
12614 /* If item is disabled, do nothing. */
12615 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12616 if (NILP (enabled_p
))
12621 /* Show item in pressed state. */
12622 if (!NILP (Vmouse_highlight
))
12623 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12624 f
->last_tool_bar_item
= prop_idx
;
12628 Lisp_Object key
, frame
;
12629 struct input_event event
;
12630 EVENT_INIT (event
);
12632 /* Show item in released state. */
12633 if (!NILP (Vmouse_highlight
))
12634 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12636 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12638 XSETFRAME (frame
, f
);
12639 event
.kind
= TOOL_BAR_EVENT
;
12640 event
.frame_or_window
= frame
;
12642 kbd_buffer_store_event (&event
);
12644 event
.kind
= TOOL_BAR_EVENT
;
12645 event
.frame_or_window
= frame
;
12647 event
.modifiers
= modifiers
;
12648 kbd_buffer_store_event (&event
);
12649 f
->last_tool_bar_item
= -1;
12654 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12655 tool-bar window-relative coordinates X/Y. Called from
12656 note_mouse_highlight. */
12659 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12661 Lisp_Object window
= f
->tool_bar_window
;
12662 struct window
*w
= XWINDOW (window
);
12663 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12664 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12666 struct glyph
*glyph
;
12667 struct glyph_row
*row
;
12669 Lisp_Object enabled_p
;
12671 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12675 /* Function note_mouse_highlight is called with negative X/Y
12676 values when mouse moves outside of the frame. */
12677 if (x
<= 0 || y
<= 0)
12679 clear_mouse_face (hlinfo
);
12683 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12686 /* Not on tool-bar item. */
12687 clear_mouse_face (hlinfo
);
12691 /* On same tool-bar item as before. */
12692 goto set_help_echo
;
12694 clear_mouse_face (hlinfo
);
12696 /* Mouse is down, but on different tool-bar item? */
12697 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12698 && f
== dpyinfo
->last_mouse_frame
);
12700 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12703 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12705 /* If tool-bar item is not enabled, don't highlight it. */
12706 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12707 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12709 /* Compute the x-position of the glyph. In front and past the
12710 image is a space. We include this in the highlighted area. */
12711 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12712 for (i
= x
= 0; i
< hpos
; ++i
)
12713 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12715 /* Record this as the current active region. */
12716 hlinfo
->mouse_face_beg_col
= hpos
;
12717 hlinfo
->mouse_face_beg_row
= vpos
;
12718 hlinfo
->mouse_face_beg_x
= x
;
12719 hlinfo
->mouse_face_past_end
= false;
12721 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12722 hlinfo
->mouse_face_end_row
= vpos
;
12723 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12724 hlinfo
->mouse_face_window
= window
;
12725 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12727 /* Display it as active. */
12728 show_mouse_face (hlinfo
, draw
);
12733 /* Set help_echo_string to a help string to display for this tool-bar item.
12734 XTread_socket does the rest. */
12735 help_echo_object
= help_echo_window
= Qnil
;
12736 help_echo_pos
= -1;
12737 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12738 if (NILP (help_echo_string
))
12739 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12742 #endif /* !USE_GTK && !HAVE_NS */
12744 #endif /* HAVE_WINDOW_SYSTEM */
12748 /************************************************************************
12749 Horizontal scrolling
12750 ************************************************************************/
12752 /* For all leaf windows in the window tree rooted at WINDOW, set their
12753 hscroll value so that PT is (i) visible in the window, and (ii) so
12754 that it is not within a certain margin at the window's left and
12755 right border. Value is true if any window's hscroll has been
12759 hscroll_window_tree (Lisp_Object window
)
12761 bool hscrolled_p
= false;
12762 bool hscroll_relative_p
= FLOATP (Vhscroll_step
);
12763 int hscroll_step_abs
= 0;
12764 double hscroll_step_rel
= 0;
12766 if (hscroll_relative_p
)
12768 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12769 if (hscroll_step_rel
< 0)
12771 hscroll_relative_p
= false;
12772 hscroll_step_abs
= 0;
12775 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12777 hscroll_step_abs
= XINT (Vhscroll_step
);
12778 if (hscroll_step_abs
< 0)
12779 hscroll_step_abs
= 0;
12782 hscroll_step_abs
= 0;
12784 while (WINDOWP (window
))
12786 struct window
*w
= XWINDOW (window
);
12788 if (WINDOWP (w
->contents
))
12789 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12790 else if (w
->cursor
.vpos
>= 0)
12793 int text_area_width
;
12794 struct glyph_row
*cursor_row
;
12795 struct glyph_row
*bottom_row
;
12797 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12798 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12799 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12801 cursor_row
= bottom_row
- 1;
12803 if (!cursor_row
->enabled_p
)
12805 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12806 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12807 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12809 cursor_row
= bottom_row
- 1;
12811 bool row_r2l_p
= cursor_row
->reversed_p
;
12813 text_area_width
= window_box_width (w
, TEXT_AREA
);
12815 /* Scroll when cursor is inside this scroll margin. */
12816 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12818 /* If the position of this window's point has explicitly
12819 changed, no more suspend auto hscrolling. */
12820 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12821 w
->suspend_auto_hscroll
= false;
12823 /* Remember window point. */
12824 Fset_marker (w
->old_pointm
,
12825 ((w
== XWINDOW (selected_window
))
12826 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12827 : Fmarker_position (w
->pointm
)),
12830 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12831 && !w
->suspend_auto_hscroll
12832 /* In some pathological cases, like restoring a window
12833 configuration into a frame that is much smaller than
12834 the one from which the configuration was saved, we
12835 get glyph rows whose start and end have zero buffer
12836 positions, which we cannot handle below. Just skip
12838 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12839 /* For left-to-right rows, hscroll when cursor is either
12840 (i) inside the right hscroll margin, or (ii) if it is
12841 inside the left margin and the window is already
12844 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12845 || (cursor_row
->enabled_p
12846 && cursor_row
->truncated_on_right_p
12847 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12848 /* For right-to-left rows, the logic is similar,
12849 except that rules for scrolling to left and right
12850 are reversed. E.g., if cursor.x <= h_margin, we
12851 need to hscroll "to the right" unconditionally,
12852 and that will scroll the screen to the left so as
12853 to reveal the next portion of the row. */
12855 && ((cursor_row
->enabled_p
12856 /* FIXME: It is confusing to set the
12857 truncated_on_right_p flag when R2L rows
12858 are actually truncated on the left. */
12859 && cursor_row
->truncated_on_right_p
12860 && w
->cursor
.x
<= h_margin
)
12862 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12866 struct buffer
*saved_current_buffer
;
12870 /* Find point in a display of infinite width. */
12871 saved_current_buffer
= current_buffer
;
12872 current_buffer
= XBUFFER (w
->contents
);
12874 if (w
== XWINDOW (selected_window
))
12877 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12879 /* Move iterator to pt starting at cursor_row->start in
12880 a line with infinite width. */
12881 init_to_row_start (&it
, w
, cursor_row
);
12882 it
.last_visible_x
= INFINITY
;
12883 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12884 current_buffer
= saved_current_buffer
;
12886 /* Position cursor in window. */
12887 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12888 hscroll
= max (0, (it
.current_x
12889 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12890 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12891 : (text_area_width
/ 2))))
12892 / FRAME_COLUMN_WIDTH (it
.f
);
12893 else if ((!row_r2l_p
12894 && w
->cursor
.x
>= text_area_width
- h_margin
)
12895 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12897 if (hscroll_relative_p
)
12898 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12901 wanted_x
= text_area_width
12902 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12905 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12909 if (hscroll_relative_p
)
12910 wanted_x
= text_area_width
* hscroll_step_rel
12913 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12916 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12918 hscroll
= max (hscroll
, w
->min_hscroll
);
12920 /* Don't prevent redisplay optimizations if hscroll
12921 hasn't changed, as it will unnecessarily slow down
12923 if (w
->hscroll
!= hscroll
)
12925 struct buffer
*b
= XBUFFER (w
->contents
);
12926 b
->prevent_redisplay_optimizations_p
= true;
12927 w
->hscroll
= hscroll
;
12928 hscrolled_p
= true;
12936 /* Value is true if hscroll of any leaf window has been changed. */
12937 return hscrolled_p
;
12941 /* Set hscroll so that cursor is visible and not inside horizontal
12942 scroll margins for all windows in the tree rooted at WINDOW. See
12943 also hscroll_window_tree above. Value is true if any window's
12944 hscroll has been changed. If it has, desired matrices on the frame
12945 of WINDOW are cleared. */
12948 hscroll_windows (Lisp_Object window
)
12950 bool hscrolled_p
= hscroll_window_tree (window
);
12952 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12953 return hscrolled_p
;
12958 /************************************************************************
12960 ************************************************************************/
12962 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
12963 This is sometimes handy to have in a debugger session. */
12967 /* First and last unchanged row for try_window_id. */
12969 static int debug_first_unchanged_at_end_vpos
;
12970 static int debug_last_unchanged_at_beg_vpos
;
12972 /* Delta vpos and y. */
12974 static int debug_dvpos
, debug_dy
;
12976 /* Delta in characters and bytes for try_window_id. */
12978 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12980 /* Values of window_end_pos and window_end_vpos at the end of
12983 static ptrdiff_t debug_end_vpos
;
12985 /* Append a string to W->desired_matrix->method. FMT is a printf
12986 format string. If trace_redisplay_p is true also printf the
12987 resulting string to stderr. */
12989 static void debug_method_add (struct window
*, char const *, ...)
12990 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12993 debug_method_add (struct window
*w
, char const *fmt
, ...)
12996 char *method
= w
->desired_matrix
->method
;
12997 int len
= strlen (method
);
12998 int size
= sizeof w
->desired_matrix
->method
;
12999 int remaining
= size
- len
- 1;
13002 if (len
&& remaining
)
13005 --remaining
, ++len
;
13008 va_start (ap
, fmt
);
13009 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13012 if (trace_redisplay_p
)
13013 fprintf (stderr
, "%p (%s): %s\n",
13015 ((BUFFERP (w
->contents
)
13016 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13017 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13022 #endif /* GLYPH_DEBUG */
13025 /* Value is true if all changes in window W, which displays
13026 current_buffer, are in the text between START and END. START is a
13027 buffer position, END is given as a distance from Z. Used in
13028 redisplay_internal for display optimization. */
13031 text_outside_line_unchanged_p (struct window
*w
,
13032 ptrdiff_t start
, ptrdiff_t end
)
13034 bool unchanged_p
= true;
13036 /* If text or overlays have changed, see where. */
13037 if (window_outdated (w
))
13039 /* Gap in the line? */
13040 if (GPT
< start
|| Z
- GPT
< end
)
13041 unchanged_p
= false;
13043 /* Changes start in front of the line, or end after it? */
13045 && (BEG_UNCHANGED
< start
- 1
13046 || END_UNCHANGED
< end
))
13047 unchanged_p
= false;
13049 /* If selective display, can't optimize if changes start at the
13050 beginning of the line. */
13052 && INTEGERP (BVAR (current_buffer
, selective_display
))
13053 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13054 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13055 unchanged_p
= false;
13057 /* If there are overlays at the start or end of the line, these
13058 may have overlay strings with newlines in them. A change at
13059 START, for instance, may actually concern the display of such
13060 overlay strings as well, and they are displayed on different
13061 lines. So, quickly rule out this case. (For the future, it
13062 might be desirable to implement something more telling than
13063 just BEG/END_UNCHANGED.) */
13066 if (BEG
+ BEG_UNCHANGED
== start
13067 && overlay_touches_p (start
))
13068 unchanged_p
= false;
13069 if (END_UNCHANGED
== end
13070 && overlay_touches_p (Z
- end
))
13071 unchanged_p
= false;
13074 /* Under bidi reordering, adding or deleting a character in the
13075 beginning of a paragraph, before the first strong directional
13076 character, can change the base direction of the paragraph (unless
13077 the buffer specifies a fixed paragraph direction), which will
13078 require to redisplay the whole paragraph. It might be worthwhile
13079 to find the paragraph limits and widen the range of redisplayed
13080 lines to that, but for now just give up this optimization. */
13081 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13082 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13083 unchanged_p
= false;
13086 return unchanged_p
;
13090 /* Do a frame update, taking possible shortcuts into account. This is
13091 the main external entry point for redisplay.
13093 If the last redisplay displayed an echo area message and that message
13094 is no longer requested, we clear the echo area or bring back the
13095 mini-buffer if that is in use. */
13100 redisplay_internal ();
13105 overlay_arrow_string_or_property (Lisp_Object var
)
13109 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13112 return Voverlay_arrow_string
;
13115 /* Return true if there are any overlay-arrows in current_buffer. */
13117 overlay_arrow_in_current_buffer_p (void)
13121 for (vlist
= Voverlay_arrow_variable_list
;
13123 vlist
= XCDR (vlist
))
13125 Lisp_Object var
= XCAR (vlist
);
13128 if (!SYMBOLP (var
))
13130 val
= find_symbol_value (var
);
13132 && current_buffer
== XMARKER (val
)->buffer
)
13139 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13143 overlay_arrows_changed_p (void)
13147 for (vlist
= Voverlay_arrow_variable_list
;
13149 vlist
= XCDR (vlist
))
13151 Lisp_Object var
= XCAR (vlist
);
13152 Lisp_Object val
, pstr
;
13154 if (!SYMBOLP (var
))
13156 val
= find_symbol_value (var
);
13157 if (!MARKERP (val
))
13159 if (! EQ (COERCE_MARKER (val
),
13160 Fget (var
, Qlast_arrow_position
))
13161 || ! (pstr
= overlay_arrow_string_or_property (var
),
13162 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13168 /* Mark overlay arrows to be updated on next redisplay. */
13171 update_overlay_arrows (int up_to_date
)
13175 for (vlist
= Voverlay_arrow_variable_list
;
13177 vlist
= XCDR (vlist
))
13179 Lisp_Object var
= XCAR (vlist
);
13181 if (!SYMBOLP (var
))
13184 if (up_to_date
> 0)
13186 Lisp_Object val
= find_symbol_value (var
);
13187 Fput (var
, Qlast_arrow_position
,
13188 COERCE_MARKER (val
));
13189 Fput (var
, Qlast_arrow_string
,
13190 overlay_arrow_string_or_property (var
));
13192 else if (up_to_date
< 0
13193 || !NILP (Fget (var
, Qlast_arrow_position
)))
13195 Fput (var
, Qlast_arrow_position
, Qt
);
13196 Fput (var
, Qlast_arrow_string
, Qt
);
13202 /* Return overlay arrow string to display at row.
13203 Return integer (bitmap number) for arrow bitmap in left fringe.
13204 Return nil if no overlay arrow. */
13207 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13211 for (vlist
= Voverlay_arrow_variable_list
;
13213 vlist
= XCDR (vlist
))
13215 Lisp_Object var
= XCAR (vlist
);
13218 if (!SYMBOLP (var
))
13221 val
= find_symbol_value (var
);
13224 && current_buffer
== XMARKER (val
)->buffer
13225 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13227 if (FRAME_WINDOW_P (it
->f
)
13228 /* FIXME: if ROW->reversed_p is set, this should test
13229 the right fringe, not the left one. */
13230 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13232 #ifdef HAVE_WINDOW_SYSTEM
13233 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13235 int fringe_bitmap
= lookup_fringe_bitmap (val
);
13236 if (fringe_bitmap
!= 0)
13237 return make_number (fringe_bitmap
);
13240 return make_number (-1); /* Use default arrow bitmap. */
13242 return overlay_arrow_string_or_property (var
);
13249 /* Return true if point moved out of or into a composition. Otherwise
13250 return false. PREV_BUF and PREV_PT are the last point buffer and
13251 position. BUF and PT are the current point buffer and position. */
13254 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13255 struct buffer
*buf
, ptrdiff_t pt
)
13257 ptrdiff_t start
, end
;
13259 Lisp_Object buffer
;
13261 XSETBUFFER (buffer
, buf
);
13262 /* Check a composition at the last point if point moved within the
13264 if (prev_buf
== buf
)
13267 /* Point didn't move. */
13270 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13271 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13272 && composition_valid_p (start
, end
, prop
)
13273 && start
< prev_pt
&& end
> prev_pt
)
13274 /* The last point was within the composition. Return true iff
13275 point moved out of the composition. */
13276 return (pt
<= start
|| pt
>= end
);
13279 /* Check a composition at the current point. */
13280 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13281 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13282 && composition_valid_p (start
, end
, prop
)
13283 && start
< pt
&& end
> pt
);
13286 /* Reconsider the clip changes of buffer which is displayed in W. */
13289 reconsider_clip_changes (struct window
*w
)
13291 struct buffer
*b
= XBUFFER (w
->contents
);
13293 if (b
->clip_changed
13294 && w
->window_end_valid
13295 && w
->current_matrix
->buffer
== b
13296 && w
->current_matrix
->zv
== BUF_ZV (b
)
13297 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13298 b
->clip_changed
= false;
13300 /* If display wasn't paused, and W is not a tool bar window, see if
13301 point has been moved into or out of a composition. In that case,
13302 set b->clip_changed to force updating the screen. If
13303 b->clip_changed has already been set, skip this check. */
13304 if (!b
->clip_changed
&& w
->window_end_valid
)
13306 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13307 ? PT
: marker_position (w
->pointm
));
13309 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13310 && check_point_in_composition (w
->current_matrix
->buffer
,
13311 w
->last_point
, b
, pt
))
13312 b
->clip_changed
= true;
13317 propagate_buffer_redisplay (void)
13318 { /* Resetting b->text->redisplay is problematic!
13319 We can't just reset it in the case that some window that displays
13320 it has not been redisplayed; and such a window can stay
13321 unredisplayed for a long time if it's currently invisible.
13322 But we do want to reset it at the end of redisplay otherwise
13323 its displayed windows will keep being redisplayed over and over
13325 So we copy all b->text->redisplay flags up to their windows here,
13326 such that mark_window_display_accurate can safely reset
13327 b->text->redisplay. */
13328 Lisp_Object ws
= window_list ();
13329 for (; CONSP (ws
); ws
= XCDR (ws
))
13331 struct window
*thisw
= XWINDOW (XCAR (ws
));
13332 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13333 if (thisb
->text
->redisplay
)
13334 thisw
->redisplay
= true;
13338 #define STOP_POLLING \
13339 do { if (! polling_stopped_here) stop_polling (); \
13340 polling_stopped_here = true; } while (false)
13342 #define RESUME_POLLING \
13343 do { if (polling_stopped_here) start_polling (); \
13344 polling_stopped_here = false; } while (false)
13347 /* Perhaps in the future avoid recentering windows if it
13348 is not necessary; currently that causes some problems. */
13351 redisplay_internal (void)
13353 struct window
*w
= XWINDOW (selected_window
);
13357 bool must_finish
= false, match_p
;
13358 struct text_pos tlbufpos
, tlendpos
;
13359 int number_of_visible_frames
;
13362 bool polling_stopped_here
= false;
13363 Lisp_Object tail
, frame
;
13365 /* True means redisplay has to consider all windows on all
13366 frames. False, only selected_window is considered. */
13367 bool consider_all_windows_p
;
13369 /* True means redisplay has to redisplay the miniwindow. */
13370 bool update_miniwindow_p
= false;
13372 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13374 /* No redisplay if running in batch mode or frame is not yet fully
13375 initialized, or redisplay is explicitly turned off by setting
13376 Vinhibit_redisplay. */
13377 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13378 || !NILP (Vinhibit_redisplay
))
13381 /* Don't examine these until after testing Vinhibit_redisplay.
13382 When Emacs is shutting down, perhaps because its connection to
13383 X has dropped, we should not look at them at all. */
13384 fr
= XFRAME (w
->frame
);
13385 sf
= SELECTED_FRAME ();
13387 if (!fr
->glyphs_initialized_p
)
13390 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13391 if (popup_activated ())
13395 /* I don't think this happens but let's be paranoid. */
13396 if (redisplaying_p
)
13399 /* Record a function that clears redisplaying_p
13400 when we leave this function. */
13401 count
= SPECPDL_INDEX ();
13402 record_unwind_protect_void (unwind_redisplay
);
13403 redisplaying_p
= true;
13404 specbind (Qinhibit_free_realized_faces
, Qnil
);
13406 /* Record this function, so it appears on the profiler's backtraces. */
13407 record_in_backtrace (Qredisplay_internal
, 0, 0);
13409 FOR_EACH_FRAME (tail
, frame
)
13410 XFRAME (frame
)->already_hscrolled_p
= false;
13413 /* Remember the currently selected window. */
13417 forget_escape_and_glyphless_faces ();
13419 inhibit_free_realized_faces
= false;
13421 /* If face_change, init_iterator will free all realized faces, which
13422 includes the faces referenced from current matrices. So, we
13423 can't reuse current matrices in this case. */
13425 windows_or_buffers_changed
= 47;
13427 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13428 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13430 /* Since frames on a single ASCII terminal share the same
13431 display area, displaying a different frame means redisplay
13432 the whole thing. */
13433 SET_FRAME_GARBAGED (sf
);
13435 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13437 FRAME_TTY (sf
)->previous_frame
= sf
;
13440 /* Set the visible flags for all frames. Do this before checking for
13441 resized or garbaged frames; they want to know if their frames are
13442 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13443 number_of_visible_frames
= 0;
13445 FOR_EACH_FRAME (tail
, frame
)
13447 struct frame
*f
= XFRAME (frame
);
13449 if (FRAME_VISIBLE_P (f
))
13451 ++number_of_visible_frames
;
13452 /* Adjust matrices for visible frames only. */
13453 if (f
->fonts_changed
)
13455 adjust_frame_glyphs (f
);
13456 /* Disable all redisplay optimizations for this frame.
13457 This is because adjust_frame_glyphs resets the
13458 enabled_p flag for all glyph rows of all windows, so
13459 many optimizations will fail anyway, and some might
13460 fail to test that flag and do bogus things as
13462 SET_FRAME_GARBAGED (f
);
13463 f
->fonts_changed
= false;
13465 /* If cursor type has been changed on the frame
13466 other than selected, consider all frames. */
13467 if (f
!= sf
&& f
->cursor_type_changed
)
13468 fset_redisplay (f
);
13470 clear_desired_matrices (f
);
13473 /* Notice any pending interrupt request to change frame size. */
13474 do_pending_window_change (true);
13476 /* do_pending_window_change could change the selected_window due to
13477 frame resizing which makes the selected window too small. */
13478 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13481 /* Clear frames marked as garbaged. */
13482 clear_garbaged_frames ();
13484 /* Build menubar and tool-bar items. */
13485 if (NILP (Vmemory_full
))
13486 prepare_menu_bars ();
13488 reconsider_clip_changes (w
);
13490 /* In most cases selected window displays current buffer. */
13491 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13494 /* Detect case that we need to write or remove a star in the mode line. */
13495 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13496 w
->update_mode_line
= true;
13498 if (mode_line_update_needed (w
))
13499 w
->update_mode_line
= true;
13501 /* If reconsider_clip_changes above decided that the narrowing
13502 in the current buffer changed, make sure all other windows
13503 showing that buffer will be redisplayed. */
13504 if (current_buffer
->clip_changed
)
13505 bset_update_mode_line (current_buffer
);
13508 /* Normally the message* functions will have already displayed and
13509 updated the echo area, but the frame may have been trashed, or
13510 the update may have been preempted, so display the echo area
13511 again here. Checking message_cleared_p captures the case that
13512 the echo area should be cleared. */
13513 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13514 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13515 || (message_cleared_p
13516 && minibuf_level
== 0
13517 /* If the mini-window is currently selected, this means the
13518 echo-area doesn't show through. */
13519 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13521 echo_area_display (false);
13523 if (message_cleared_p
)
13524 update_miniwindow_p
= true;
13526 must_finish
= true;
13528 /* If we don't display the current message, don't clear the
13529 message_cleared_p flag, because, if we did, we wouldn't clear
13530 the echo area in the next redisplay which doesn't preserve
13532 if (!display_last_displayed_message_p
)
13533 message_cleared_p
= false;
13535 else if (EQ (selected_window
, minibuf_window
)
13536 && (current_buffer
->clip_changed
|| window_outdated (w
))
13537 && resize_mini_window (w
, false))
13539 /* Resized active mini-window to fit the size of what it is
13540 showing if its contents might have changed. */
13541 must_finish
= true;
13543 /* If window configuration was changed, frames may have been
13544 marked garbaged. Clear them or we will experience
13545 surprises wrt scrolling. */
13546 clear_garbaged_frames ();
13549 if (windows_or_buffers_changed
&& !update_mode_lines
)
13550 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13551 only the windows's contents needs to be refreshed, or whether the
13552 mode-lines also need a refresh. */
13553 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13554 ? REDISPLAY_SOME
: 32);
13556 /* If specs for an arrow have changed, do thorough redisplay
13557 to ensure we remove any arrow that should no longer exist. */
13558 if (overlay_arrows_changed_p ())
13559 /* Apparently, this is the only case where we update other windows,
13560 without updating other mode-lines. */
13561 windows_or_buffers_changed
= 49;
13563 consider_all_windows_p
= (update_mode_lines
13564 || windows_or_buffers_changed
);
13566 #define AINC(a,i) \
13568 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13569 if (INTEGERP (entry)) \
13570 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13573 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13574 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13576 /* Optimize the case that only the line containing the cursor in the
13577 selected window has changed. Variables starting with this_ are
13578 set in display_line and record information about the line
13579 containing the cursor. */
13580 tlbufpos
= this_line_start_pos
;
13581 tlendpos
= this_line_end_pos
;
13582 if (!consider_all_windows_p
13583 && CHARPOS (tlbufpos
) > 0
13584 && !w
->update_mode_line
13585 && !current_buffer
->clip_changed
13586 && !current_buffer
->prevent_redisplay_optimizations_p
13587 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13588 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13589 && !XFRAME (w
->frame
)->cursor_type_changed
13590 && !XFRAME (w
->frame
)->face_change
13591 /* Make sure recorded data applies to current buffer, etc. */
13592 && this_line_buffer
== current_buffer
13595 && !w
->optional_new_start
13596 /* Point must be on the line that we have info recorded about. */
13597 && PT
>= CHARPOS (tlbufpos
)
13598 && PT
<= Z
- CHARPOS (tlendpos
)
13599 /* All text outside that line, including its final newline,
13600 must be unchanged. */
13601 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13602 CHARPOS (tlendpos
)))
13604 if (CHARPOS (tlbufpos
) > BEGV
13605 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13606 && (CHARPOS (tlbufpos
) == ZV
13607 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13608 /* Former continuation line has disappeared by becoming empty. */
13610 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13612 /* We have to handle the case of continuation around a
13613 wide-column character (see the comment in indent.c around
13616 For instance, in the following case:
13618 -------- Insert --------
13619 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13620 J_I_ ==> J_I_ `^^' are cursors.
13624 As we have to redraw the line above, we cannot use this
13628 int line_height_before
= this_line_pixel_height
;
13630 /* Note that start_display will handle the case that the
13631 line starting at tlbufpos is a continuation line. */
13632 start_display (&it
, w
, tlbufpos
);
13634 /* Implementation note: It this still necessary? */
13635 if (it
.current_x
!= this_line_start_x
)
13638 TRACE ((stderr
, "trying display optimization 1\n"));
13639 w
->cursor
.vpos
= -1;
13640 overlay_arrow_seen
= false;
13641 it
.vpos
= this_line_vpos
;
13642 it
.current_y
= this_line_y
;
13643 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13644 display_line (&it
);
13646 /* If line contains point, is not continued,
13647 and ends at same distance from eob as before, we win. */
13648 if (w
->cursor
.vpos
>= 0
13649 /* Line is not continued, otherwise this_line_start_pos
13650 would have been set to 0 in display_line. */
13651 && CHARPOS (this_line_start_pos
)
13652 /* Line ends as before. */
13653 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13654 /* Line has same height as before. Otherwise other lines
13655 would have to be shifted up or down. */
13656 && this_line_pixel_height
== line_height_before
)
13658 /* If this is not the window's last line, we must adjust
13659 the charstarts of the lines below. */
13660 if (it
.current_y
< it
.last_visible_y
)
13662 struct glyph_row
*row
13663 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13664 ptrdiff_t delta
, delta_bytes
;
13666 /* We used to distinguish between two cases here,
13667 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13668 when the line ends in a newline or the end of the
13669 buffer's accessible portion. But both cases did
13670 the same, so they were collapsed. */
13672 - CHARPOS (tlendpos
)
13673 - MATRIX_ROW_START_CHARPOS (row
));
13674 delta_bytes
= (Z_BYTE
13675 - BYTEPOS (tlendpos
)
13676 - MATRIX_ROW_START_BYTEPOS (row
));
13678 increment_matrix_positions (w
->current_matrix
,
13679 this_line_vpos
+ 1,
13680 w
->current_matrix
->nrows
,
13681 delta
, delta_bytes
);
13684 /* If this row displays text now but previously didn't,
13685 or vice versa, w->window_end_vpos may have to be
13687 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13689 if (w
->window_end_vpos
< this_line_vpos
)
13690 w
->window_end_vpos
= this_line_vpos
;
13692 else if (w
->window_end_vpos
== this_line_vpos
13693 && this_line_vpos
> 0)
13694 w
->window_end_vpos
= this_line_vpos
- 1;
13695 w
->window_end_valid
= false;
13697 /* Update hint: No need to try to scroll in update_window. */
13698 w
->desired_matrix
->no_scrolling_p
= true;
13701 *w
->desired_matrix
->method
= 0;
13702 debug_method_add (w
, "optimization 1");
13704 #ifdef HAVE_WINDOW_SYSTEM
13705 update_window_fringes (w
, false);
13712 else if (/* Cursor position hasn't changed. */
13713 PT
== w
->last_point
13714 /* Make sure the cursor was last displayed
13715 in this window. Otherwise we have to reposition it. */
13717 /* PXW: Must be converted to pixels, probably. */
13718 && 0 <= w
->cursor
.vpos
13719 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13723 do_pending_window_change (true);
13724 /* If selected_window changed, redisplay again. */
13725 if (WINDOWP (selected_window
)
13726 && (w
= XWINDOW (selected_window
)) != sw
)
13729 /* We used to always goto end_of_redisplay here, but this
13730 isn't enough if we have a blinking cursor. */
13731 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13732 goto end_of_redisplay
;
13736 /* If highlighting the region, or if the cursor is in the echo area,
13737 then we can't just move the cursor. */
13738 else if (NILP (Vshow_trailing_whitespace
)
13739 && !cursor_in_echo_area
)
13742 struct glyph_row
*row
;
13744 /* Skip from tlbufpos to PT and see where it is. Note that
13745 PT may be in invisible text. If so, we will end at the
13746 next visible position. */
13747 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13748 NULL
, DEFAULT_FACE_ID
);
13749 it
.current_x
= this_line_start_x
;
13750 it
.current_y
= this_line_y
;
13751 it
.vpos
= this_line_vpos
;
13753 /* The call to move_it_to stops in front of PT, but
13754 moves over before-strings. */
13755 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13757 if (it
.vpos
== this_line_vpos
13758 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13761 eassert (this_line_vpos
== it
.vpos
);
13762 eassert (this_line_y
== it
.current_y
);
13763 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13765 *w
->desired_matrix
->method
= 0;
13766 debug_method_add (w
, "optimization 3");
13775 /* Text changed drastically or point moved off of line. */
13776 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13779 CHARPOS (this_line_start_pos
) = 0;
13780 ++clear_face_cache_count
;
13781 #ifdef HAVE_WINDOW_SYSTEM
13782 ++clear_image_cache_count
;
13785 /* Build desired matrices, and update the display. If
13786 consider_all_windows_p, do it for all windows on all frames that
13787 require redisplay, as specified by their 'redisplay' flag.
13788 Otherwise do it for selected_window, only. */
13790 if (consider_all_windows_p
)
13792 FOR_EACH_FRAME (tail
, frame
)
13793 XFRAME (frame
)->updated_p
= false;
13795 propagate_buffer_redisplay ();
13797 FOR_EACH_FRAME (tail
, frame
)
13799 struct frame
*f
= XFRAME (frame
);
13801 /* We don't have to do anything for unselected terminal
13803 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13804 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13808 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13811 /* Only GC scrollbars when we redisplay the whole frame. */
13812 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13813 bool f_redisplay_flag
= f
->redisplay
;
13814 /* Mark all the scroll bars to be removed; we'll redeem
13815 the ones we want when we redisplay their windows. */
13816 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13817 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13819 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13820 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13821 /* Remember that the invisible frames need to be redisplayed next
13822 time they're visible. */
13823 else if (!REDISPLAY_SOME_P ())
13824 f
->redisplay
= true;
13826 /* The X error handler may have deleted that frame. */
13827 if (!FRAME_LIVE_P (f
))
13830 /* Any scroll bars which redisplay_windows should have
13831 nuked should now go away. */
13832 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13833 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13835 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13837 /* If fonts changed on visible frame, display again. */
13838 if (f
->fonts_changed
)
13840 adjust_frame_glyphs (f
);
13841 /* Disable all redisplay optimizations for this
13842 frame. For the reasons, see the comment near
13843 the previous call to adjust_frame_glyphs above. */
13844 SET_FRAME_GARBAGED (f
);
13845 f
->fonts_changed
= false;
13849 /* See if we have to hscroll. */
13850 if (!f
->already_hscrolled_p
)
13852 f
->already_hscrolled_p
= true;
13853 if (hscroll_windows (f
->root_window
))
13857 /* If the frame's redisplay flag was not set before
13858 we went about redisplaying its windows, but it is
13859 set now, that means we employed some redisplay
13860 optimizations inside redisplay_windows, and
13861 bypassed producing some screen lines. But if
13862 f->redisplay is now set, it might mean the old
13863 faces are no longer valid (e.g., if redisplaying
13864 some window called some Lisp which defined a new
13865 face or redefined an existing face), so trying to
13866 use them in update_frame will segfault.
13867 Therefore, we must redisplay this frame. */
13868 if (!f_redisplay_flag
&& f
->redisplay
)
13871 /* Prevent various kinds of signals during display
13872 update. stdio is not robust about handling
13873 signals, which can cause an apparent I/O error. */
13874 if (interrupt_input
)
13875 unrequest_sigio ();
13878 pending
|= update_frame (f
, false, false);
13879 f
->cursor_type_changed
= false;
13880 f
->updated_p
= true;
13885 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13889 /* Do the mark_window_display_accurate after all windows have
13890 been redisplayed because this call resets flags in buffers
13891 which are needed for proper redisplay. */
13892 FOR_EACH_FRAME (tail
, frame
)
13894 struct frame
*f
= XFRAME (frame
);
13897 f
->redisplay
= false;
13898 mark_window_display_accurate (f
->root_window
, true);
13899 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13900 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13905 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13907 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13908 struct frame
*mini_frame
;
13910 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13911 /* Use list_of_error, not Qerror, so that
13912 we catch only errors and don't run the debugger. */
13913 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13915 redisplay_window_error
);
13916 if (update_miniwindow_p
)
13917 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13919 redisplay_window_error
);
13921 /* Compare desired and current matrices, perform output. */
13924 /* If fonts changed, display again. Likewise if redisplay_window_1
13925 above caused some change (e.g., a change in faces) that requires
13926 considering the entire frame again. */
13927 if (sf
->fonts_changed
|| sf
->redisplay
)
13930 /* Prevent freeing of realized faces, since desired matrices are
13931 pending that reference the faces we computed and cached. */
13932 inhibit_free_realized_faces
= true;
13934 /* Prevent various kinds of signals during display update.
13935 stdio is not robust about handling signals,
13936 which can cause an apparent I/O error. */
13937 if (interrupt_input
)
13938 unrequest_sigio ();
13941 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13943 if (hscroll_windows (selected_window
))
13946 XWINDOW (selected_window
)->must_be_updated_p
= true;
13947 pending
= update_frame (sf
, false, false);
13948 sf
->cursor_type_changed
= false;
13951 /* We may have called echo_area_display at the top of this
13952 function. If the echo area is on another frame, that may
13953 have put text on a frame other than the selected one, so the
13954 above call to update_frame would not have caught it. Catch
13956 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13957 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13959 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13961 XWINDOW (mini_window
)->must_be_updated_p
= true;
13962 pending
|= update_frame (mini_frame
, false, false);
13963 mini_frame
->cursor_type_changed
= false;
13964 if (!pending
&& hscroll_windows (mini_window
))
13969 /* If display was paused because of pending input, make sure we do a
13970 thorough update the next time. */
13973 /* Prevent the optimization at the beginning of
13974 redisplay_internal that tries a single-line update of the
13975 line containing the cursor in the selected window. */
13976 CHARPOS (this_line_start_pos
) = 0;
13978 /* Let the overlay arrow be updated the next time. */
13979 update_overlay_arrows (0);
13981 /* If we pause after scrolling, some rows in the current
13982 matrices of some windows are not valid. */
13983 if (!WINDOW_FULL_WIDTH_P (w
)
13984 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13985 update_mode_lines
= 36;
13989 if (!consider_all_windows_p
)
13991 /* This has already been done above if
13992 consider_all_windows_p is set. */
13993 if (XBUFFER (w
->contents
)->text
->redisplay
13994 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13995 /* This can happen if b->text->redisplay was set during
13997 propagate_buffer_redisplay ();
13998 mark_window_display_accurate_1 (w
, true);
14000 /* Say overlay arrows are up to date. */
14001 update_overlay_arrows (1);
14003 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14004 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14007 update_mode_lines
= 0;
14008 windows_or_buffers_changed
= 0;
14011 /* Start SIGIO interrupts coming again. Having them off during the
14012 code above makes it less likely one will discard output, but not
14013 impossible, since there might be stuff in the system buffer here.
14014 But it is much hairier to try to do anything about that. */
14015 if (interrupt_input
)
14019 /* If a frame has become visible which was not before, redisplay
14020 again, so that we display it. Expose events for such a frame
14021 (which it gets when becoming visible) don't call the parts of
14022 redisplay constructing glyphs, so simply exposing a frame won't
14023 display anything in this case. So, we have to display these
14024 frames here explicitly. */
14029 FOR_EACH_FRAME (tail
, frame
)
14031 if (XFRAME (frame
)->visible
)
14035 if (new_count
!= number_of_visible_frames
)
14036 windows_or_buffers_changed
= 52;
14039 /* Change frame size now if a change is pending. */
14040 do_pending_window_change (true);
14042 /* If we just did a pending size change, or have additional
14043 visible frames, or selected_window changed, redisplay again. */
14044 if ((windows_or_buffers_changed
&& !pending
)
14045 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14048 /* Clear the face and image caches.
14050 We used to do this only if consider_all_windows_p. But the cache
14051 needs to be cleared if a timer creates images in the current
14052 buffer (e.g. the test case in Bug#6230). */
14054 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14056 clear_face_cache (false);
14057 clear_face_cache_count
= 0;
14060 #ifdef HAVE_WINDOW_SYSTEM
14061 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14063 clear_image_caches (Qnil
);
14064 clear_image_cache_count
= 0;
14066 #endif /* HAVE_WINDOW_SYSTEM */
14070 ns_set_doc_edited ();
14072 if (interrupt_input
&& interrupts_deferred
)
14075 unbind_to (count
, Qnil
);
14080 /* Redisplay, but leave alone any recent echo area message unless
14081 another message has been requested in its place.
14083 This is useful in situations where you need to redisplay but no
14084 user action has occurred, making it inappropriate for the message
14085 area to be cleared. See tracking_off and
14086 wait_reading_process_output for examples of these situations.
14088 FROM_WHERE is an integer saying from where this function was
14089 called. This is useful for debugging. */
14092 redisplay_preserve_echo_area (int from_where
)
14094 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14096 if (!NILP (echo_area_buffer
[1]))
14098 /* We have a previously displayed message, but no current
14099 message. Redisplay the previous message. */
14100 display_last_displayed_message_p
= true;
14101 redisplay_internal ();
14102 display_last_displayed_message_p
= false;
14105 redisplay_internal ();
14107 flush_frame (SELECTED_FRAME ());
14111 /* Function registered with record_unwind_protect in redisplay_internal. */
14114 unwind_redisplay (void)
14116 redisplaying_p
= false;
14120 /* Mark the display of leaf window W as accurate or inaccurate.
14121 If ACCURATE_P, mark display of W as accurate.
14122 If !ACCURATE_P, arrange for W to be redisplayed the next
14123 time redisplay_internal is called. */
14126 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14128 struct buffer
*b
= XBUFFER (w
->contents
);
14130 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14131 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14132 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14136 b
->clip_changed
= false;
14137 b
->prevent_redisplay_optimizations_p
= false;
14138 eassert (buffer_window_count (b
) > 0);
14139 /* Resetting b->text->redisplay is problematic!
14140 In order to make it safer to do it here, redisplay_internal must
14141 have copied all b->text->redisplay to their respective windows. */
14142 b
->text
->redisplay
= false;
14144 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14145 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14146 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14147 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14149 w
->current_matrix
->buffer
= b
;
14150 w
->current_matrix
->begv
= BUF_BEGV (b
);
14151 w
->current_matrix
->zv
= BUF_ZV (b
);
14153 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14154 w
->last_cursor_off_p
= w
->cursor_off_p
;
14156 if (w
== XWINDOW (selected_window
))
14157 w
->last_point
= BUF_PT (b
);
14159 w
->last_point
= marker_position (w
->pointm
);
14161 w
->window_end_valid
= true;
14162 w
->update_mode_line
= false;
14165 w
->redisplay
= !accurate_p
;
14169 /* Mark the display of windows in the window tree rooted at WINDOW as
14170 accurate or inaccurate. If ACCURATE_P, mark display of
14171 windows as accurate. If !ACCURATE_P, arrange for windows to
14172 be redisplayed the next time redisplay_internal is called. */
14175 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14179 for (; !NILP (window
); window
= w
->next
)
14181 w
= XWINDOW (window
);
14182 if (WINDOWP (w
->contents
))
14183 mark_window_display_accurate (w
->contents
, accurate_p
);
14185 mark_window_display_accurate_1 (w
, accurate_p
);
14189 update_overlay_arrows (1);
14191 /* Force a thorough redisplay the next time by setting
14192 last_arrow_position and last_arrow_string to t, which is
14193 unequal to any useful value of Voverlay_arrow_... */
14194 update_overlay_arrows (-1);
14198 /* Return value in display table DP (Lisp_Char_Table *) for character
14199 C. Since a display table doesn't have any parent, we don't have to
14200 follow parent. Do not call this function directly but use the
14201 macro DISP_CHAR_VECTOR. */
14204 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14208 if (ASCII_CHAR_P (c
))
14211 if (SUB_CHAR_TABLE_P (val
))
14212 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14218 XSETCHAR_TABLE (table
, dp
);
14219 val
= char_table_ref (table
, c
);
14228 /***********************************************************************
14230 ***********************************************************************/
14232 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14235 redisplay_windows (Lisp_Object window
)
14237 while (!NILP (window
))
14239 struct window
*w
= XWINDOW (window
);
14241 if (WINDOWP (w
->contents
))
14242 redisplay_windows (w
->contents
);
14243 else if (BUFFERP (w
->contents
))
14245 displayed_buffer
= XBUFFER (w
->contents
);
14246 /* Use list_of_error, not Qerror, so that
14247 we catch only errors and don't run the debugger. */
14248 internal_condition_case_1 (redisplay_window_0
, window
,
14250 redisplay_window_error
);
14258 redisplay_window_error (Lisp_Object ignore
)
14260 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14265 redisplay_window_0 (Lisp_Object window
)
14267 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14268 redisplay_window (window
, false);
14273 redisplay_window_1 (Lisp_Object window
)
14275 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14276 redisplay_window (window
, true);
14281 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14282 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14283 which positions recorded in ROW differ from current buffer
14286 Return true iff cursor is on this row. */
14289 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14290 struct glyph_matrix
*matrix
,
14291 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14294 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14295 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14296 struct glyph
*cursor
= NULL
;
14297 /* The last known character position in row. */
14298 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14300 ptrdiff_t pt_old
= PT
- delta
;
14301 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14302 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14303 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14304 /* A glyph beyond the edge of TEXT_AREA which we should never
14306 struct glyph
*glyphs_end
= end
;
14307 /* True means we've found a match for cursor position, but that
14308 glyph has the avoid_cursor_p flag set. */
14309 bool match_with_avoid_cursor
= false;
14310 /* True means we've seen at least one glyph that came from a
14312 bool string_seen
= false;
14313 /* Largest and smallest buffer positions seen so far during scan of
14315 ptrdiff_t bpos_max
= pos_before
;
14316 ptrdiff_t bpos_min
= pos_after
;
14317 /* Last buffer position covered by an overlay string with an integer
14318 `cursor' property. */
14319 ptrdiff_t bpos_covered
= 0;
14320 /* True means the display string on which to display the cursor
14321 comes from a text property, not from an overlay. */
14322 bool string_from_text_prop
= false;
14324 /* Don't even try doing anything if called for a mode-line or
14325 header-line row, since the rest of the code isn't prepared to
14326 deal with such calamities. */
14327 eassert (!row
->mode_line_p
);
14328 if (row
->mode_line_p
)
14331 /* Skip over glyphs not having an object at the start and the end of
14332 the row. These are special glyphs like truncation marks on
14333 terminal frames. */
14334 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14336 if (!row
->reversed_p
)
14339 && NILP (glyph
->object
)
14340 && glyph
->charpos
< 0)
14342 x
+= glyph
->pixel_width
;
14346 && NILP ((end
- 1)->object
)
14347 /* CHARPOS is zero for blanks and stretch glyphs
14348 inserted by extend_face_to_end_of_line. */
14349 && (end
- 1)->charpos
<= 0)
14351 glyph_before
= glyph
- 1;
14358 /* If the glyph row is reversed, we need to process it from back
14359 to front, so swap the edge pointers. */
14360 glyphs_end
= end
= glyph
- 1;
14361 glyph
+= row
->used
[TEXT_AREA
] - 1;
14363 while (glyph
> end
+ 1
14364 && NILP (glyph
->object
)
14365 && glyph
->charpos
< 0)
14368 x
-= glyph
->pixel_width
;
14370 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14372 /* By default, in reversed rows we put the cursor on the
14373 rightmost (first in the reading order) glyph. */
14374 for (g
= end
+ 1; g
< glyph
; g
++)
14375 x
+= g
->pixel_width
;
14377 && NILP ((end
+ 1)->object
)
14378 && (end
+ 1)->charpos
<= 0)
14380 glyph_before
= glyph
+ 1;
14384 else if (row
->reversed_p
)
14386 /* In R2L rows that don't display text, put the cursor on the
14387 rightmost glyph. Case in point: an empty last line that is
14388 part of an R2L paragraph. */
14390 /* Avoid placing the cursor on the last glyph of the row, where
14391 on terminal frames we hold the vertical border between
14392 adjacent windows. */
14393 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14394 && !WINDOW_RIGHTMOST_P (w
)
14395 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14397 x
= -1; /* will be computed below, at label compute_x */
14400 /* Step 1: Try to find the glyph whose character position
14401 corresponds to point. If that's not possible, find 2 glyphs
14402 whose character positions are the closest to point, one before
14403 point, the other after it. */
14404 if (!row
->reversed_p
)
14405 while (/* not marched to end of glyph row */
14407 /* glyph was not inserted by redisplay for internal purposes */
14408 && !NILP (glyph
->object
))
14410 if (BUFFERP (glyph
->object
))
14412 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14414 if (glyph
->charpos
> bpos_max
)
14415 bpos_max
= glyph
->charpos
;
14416 if (glyph
->charpos
< bpos_min
)
14417 bpos_min
= glyph
->charpos
;
14418 if (!glyph
->avoid_cursor_p
)
14420 /* If we hit point, we've found the glyph on which to
14421 display the cursor. */
14424 match_with_avoid_cursor
= false;
14427 /* See if we've found a better approximation to
14428 POS_BEFORE or to POS_AFTER. */
14429 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14431 pos_before
= glyph
->charpos
;
14432 glyph_before
= glyph
;
14434 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14436 pos_after
= glyph
->charpos
;
14437 glyph_after
= glyph
;
14440 else if (dpos
== 0)
14441 match_with_avoid_cursor
= true;
14443 else if (STRINGP (glyph
->object
))
14445 Lisp_Object chprop
;
14446 ptrdiff_t glyph_pos
= glyph
->charpos
;
14448 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14450 if (!NILP (chprop
))
14452 /* If the string came from a `display' text property,
14453 look up the buffer position of that property and
14454 use that position to update bpos_max, as if we
14455 actually saw such a position in one of the row's
14456 glyphs. This helps with supporting integer values
14457 of `cursor' property on the display string in
14458 situations where most or all of the row's buffer
14459 text is completely covered by display properties,
14460 so that no glyph with valid buffer positions is
14461 ever seen in the row. */
14462 ptrdiff_t prop_pos
=
14463 string_buffer_position_lim (glyph
->object
, pos_before
,
14466 if (prop_pos
>= pos_before
)
14467 bpos_max
= prop_pos
;
14469 if (INTEGERP (chprop
))
14471 bpos_covered
= bpos_max
+ XINT (chprop
);
14472 /* If the `cursor' property covers buffer positions up
14473 to and including point, we should display cursor on
14474 this glyph. Note that, if a `cursor' property on one
14475 of the string's characters has an integer value, we
14476 will break out of the loop below _before_ we get to
14477 the position match above. IOW, integer values of
14478 the `cursor' property override the "exact match for
14479 point" strategy of positioning the cursor. */
14480 /* Implementation note: bpos_max == pt_old when, e.g.,
14481 we are in an empty line, where bpos_max is set to
14482 MATRIX_ROW_START_CHARPOS, see above. */
14483 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14490 string_seen
= true;
14492 x
+= glyph
->pixel_width
;
14495 else if (glyph
> end
) /* row is reversed */
14496 while (!NILP (glyph
->object
))
14498 if (BUFFERP (glyph
->object
))
14500 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14502 if (glyph
->charpos
> bpos_max
)
14503 bpos_max
= glyph
->charpos
;
14504 if (glyph
->charpos
< bpos_min
)
14505 bpos_min
= glyph
->charpos
;
14506 if (!glyph
->avoid_cursor_p
)
14510 match_with_avoid_cursor
= false;
14513 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14515 pos_before
= glyph
->charpos
;
14516 glyph_before
= glyph
;
14518 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14520 pos_after
= glyph
->charpos
;
14521 glyph_after
= glyph
;
14524 else if (dpos
== 0)
14525 match_with_avoid_cursor
= true;
14527 else if (STRINGP (glyph
->object
))
14529 Lisp_Object chprop
;
14530 ptrdiff_t glyph_pos
= glyph
->charpos
;
14532 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14534 if (!NILP (chprop
))
14536 ptrdiff_t prop_pos
=
14537 string_buffer_position_lim (glyph
->object
, pos_before
,
14540 if (prop_pos
>= pos_before
)
14541 bpos_max
= prop_pos
;
14543 if (INTEGERP (chprop
))
14545 bpos_covered
= bpos_max
+ XINT (chprop
);
14546 /* If the `cursor' property covers buffer positions up
14547 to and including point, we should display cursor on
14549 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14555 string_seen
= true;
14558 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14560 x
--; /* can't use any pixel_width */
14563 x
-= glyph
->pixel_width
;
14566 /* Step 2: If we didn't find an exact match for point, we need to
14567 look for a proper place to put the cursor among glyphs between
14568 GLYPH_BEFORE and GLYPH_AFTER. */
14569 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14570 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14571 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14573 /* An empty line has a single glyph whose OBJECT is nil and
14574 whose CHARPOS is the position of a newline on that line.
14575 Note that on a TTY, there are more glyphs after that, which
14576 were produced by extend_face_to_end_of_line, but their
14577 CHARPOS is zero or negative. */
14578 bool empty_line_p
=
14579 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14580 && NILP (glyph
->object
) && glyph
->charpos
> 0
14581 /* On a TTY, continued and truncated rows also have a glyph at
14582 their end whose OBJECT is nil and whose CHARPOS is
14583 positive (the continuation and truncation glyphs), but such
14584 rows are obviously not "empty". */
14585 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14587 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14589 ptrdiff_t ellipsis_pos
;
14591 /* Scan back over the ellipsis glyphs. */
14592 if (!row
->reversed_p
)
14594 ellipsis_pos
= (glyph
- 1)->charpos
;
14595 while (glyph
> row
->glyphs
[TEXT_AREA
]
14596 && (glyph
- 1)->charpos
== ellipsis_pos
)
14597 glyph
--, x
-= glyph
->pixel_width
;
14598 /* That loop always goes one position too far, including
14599 the glyph before the ellipsis. So scan forward over
14601 x
+= glyph
->pixel_width
;
14604 else /* row is reversed */
14606 ellipsis_pos
= (glyph
+ 1)->charpos
;
14607 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14608 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14609 glyph
++, x
+= glyph
->pixel_width
;
14610 x
-= glyph
->pixel_width
;
14614 else if (match_with_avoid_cursor
)
14616 cursor
= glyph_after
;
14619 else if (string_seen
)
14621 int incr
= row
->reversed_p
? -1 : +1;
14623 /* Need to find the glyph that came out of a string which is
14624 present at point. That glyph is somewhere between
14625 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14626 positioned between POS_BEFORE and POS_AFTER in the
14628 struct glyph
*start
, *stop
;
14629 ptrdiff_t pos
= pos_before
;
14633 /* If the row ends in a newline from a display string,
14634 reordering could have moved the glyphs belonging to the
14635 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14636 in this case we extend the search to the last glyph in
14637 the row that was not inserted by redisplay. */
14638 if (row
->ends_in_newline_from_string_p
)
14641 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14644 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14645 correspond to POS_BEFORE and POS_AFTER, respectively. We
14646 need START and STOP in the order that corresponds to the
14647 row's direction as given by its reversed_p flag. If the
14648 directionality of characters between POS_BEFORE and
14649 POS_AFTER is the opposite of the row's base direction,
14650 these characters will have been reordered for display,
14651 and we need to reverse START and STOP. */
14652 if (!row
->reversed_p
)
14654 start
= min (glyph_before
, glyph_after
);
14655 stop
= max (glyph_before
, glyph_after
);
14659 start
= max (glyph_before
, glyph_after
);
14660 stop
= min (glyph_before
, glyph_after
);
14662 for (glyph
= start
+ incr
;
14663 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14666 /* Any glyphs that come from the buffer are here because
14667 of bidi reordering. Skip them, and only pay
14668 attention to glyphs that came from some string. */
14669 if (STRINGP (glyph
->object
))
14673 /* If the display property covers the newline, we
14674 need to search for it one position farther. */
14675 ptrdiff_t lim
= pos_after
14676 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14678 string_from_text_prop
= false;
14679 str
= glyph
->object
;
14680 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14681 if (tem
== 0 /* from overlay */
14684 /* If the string from which this glyph came is
14685 found in the buffer at point, or at position
14686 that is closer to point than pos_after, then
14687 we've found the glyph we've been looking for.
14688 If it comes from an overlay (tem == 0), and
14689 it has the `cursor' property on one of its
14690 glyphs, record that glyph as a candidate for
14691 displaying the cursor. (As in the
14692 unidirectional version, we will display the
14693 cursor on the last candidate we find.) */
14696 || (tem
- pt_old
> 0 && tem
< pos_after
))
14698 /* The glyphs from this string could have
14699 been reordered. Find the one with the
14700 smallest string position. Or there could
14701 be a character in the string with the
14702 `cursor' property, which means display
14703 cursor on that character's glyph. */
14704 ptrdiff_t strpos
= glyph
->charpos
;
14709 string_from_text_prop
= true;
14712 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14713 && EQ (glyph
->object
, str
);
14717 ptrdiff_t gpos
= glyph
->charpos
;
14719 cprop
= Fget_char_property (make_number (gpos
),
14727 if (tem
&& glyph
->charpos
< strpos
)
14729 strpos
= glyph
->charpos
;
14735 || (tem
- pt_old
> 0 && tem
< pos_after
))
14739 pos
= tem
+ 1; /* don't find previous instances */
14741 /* This string is not what we want; skip all of the
14742 glyphs that came from it. */
14743 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14744 && EQ (glyph
->object
, str
))
14751 /* If we reached the end of the line, and END was from a string,
14752 the cursor is not on this line. */
14754 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14755 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14756 && STRINGP (end
->object
)
14757 && row
->continued_p
)
14760 /* A truncated row may not include PT among its character positions.
14761 Setting the cursor inside the scroll margin will trigger
14762 recalculation of hscroll in hscroll_window_tree. But if a
14763 display string covers point, defer to the string-handling
14764 code below to figure this out. */
14765 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14767 cursor
= glyph_before
;
14770 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14771 /* Zero-width characters produce no glyphs. */
14773 && (row
->reversed_p
14774 ? glyph_after
> glyphs_end
14775 : glyph_after
< glyphs_end
)))
14777 cursor
= glyph_after
;
14783 if (cursor
!= NULL
)
14785 else if (glyph
== glyphs_end
14786 && pos_before
== pos_after
14787 && STRINGP ((row
->reversed_p
14788 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14789 : row
->glyphs
[TEXT_AREA
])->object
))
14791 /* If all the glyphs of this row came from strings, put the
14792 cursor on the first glyph of the row. This avoids having the
14793 cursor outside of the text area in this very rare and hard
14797 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14798 : row
->glyphs
[TEXT_AREA
];
14804 /* Need to compute x that corresponds to GLYPH. */
14805 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14807 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14809 x
+= g
->pixel_width
;
14813 /* ROW could be part of a continued line, which, under bidi
14814 reordering, might have other rows whose start and end charpos
14815 occlude point. Only set w->cursor if we found a better
14816 approximation to the cursor position than we have from previously
14817 examined candidate rows belonging to the same continued line. */
14818 if (/* We already have a candidate row. */
14819 w
->cursor
.vpos
>= 0
14820 /* That candidate is not the row we are processing. */
14821 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14822 /* Make sure cursor.vpos specifies a row whose start and end
14823 charpos occlude point, and it is valid candidate for being a
14824 cursor-row. This is because some callers of this function
14825 leave cursor.vpos at the row where the cursor was displayed
14826 during the last redisplay cycle. */
14827 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14828 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14829 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14832 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14834 /* Don't consider glyphs that are outside TEXT_AREA. */
14835 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14837 /* Keep the candidate whose buffer position is the closest to
14838 point or has the `cursor' property. */
14839 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14840 w
->cursor
.hpos
>= 0
14841 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14842 && ((BUFFERP (g1
->object
)
14843 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14844 || (BUFFERP (glyph
->object
)
14845 && eabs (g1
->charpos
- pt_old
)
14846 < eabs (glyph
->charpos
- pt_old
))))
14847 /* Previous candidate is a glyph from a string that has
14848 a non-nil `cursor' property. */
14849 || (STRINGP (g1
->object
)
14850 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14851 Qcursor
, g1
->object
))
14852 /* Previous candidate is from the same display
14853 string as this one, and the display string
14854 came from a text property. */
14855 || (EQ (g1
->object
, glyph
->object
)
14856 && string_from_text_prop
)
14857 /* this candidate is from newline and its
14858 position is not an exact match */
14859 || (NILP (glyph
->object
)
14860 && glyph
->charpos
!= pt_old
)))))
14862 /* If this candidate gives an exact match, use that. */
14863 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14864 /* If this candidate is a glyph created for the
14865 terminating newline of a line, and point is on that
14866 newline, it wins because it's an exact match. */
14867 || (!row
->continued_p
14868 && NILP (glyph
->object
)
14869 && glyph
->charpos
== 0
14870 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14871 /* Otherwise, keep the candidate that comes from a row
14872 spanning less buffer positions. This may win when one or
14873 both candidate positions are on glyphs that came from
14874 display strings, for which we cannot compare buffer
14876 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14877 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14878 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14881 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14883 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14884 w
->cursor
.y
= row
->y
+ dy
;
14886 if (w
== XWINDOW (selected_window
))
14888 if (!row
->continued_p
14889 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14892 this_line_buffer
= XBUFFER (w
->contents
);
14894 CHARPOS (this_line_start_pos
)
14895 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14896 BYTEPOS (this_line_start_pos
)
14897 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14899 CHARPOS (this_line_end_pos
)
14900 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14901 BYTEPOS (this_line_end_pos
)
14902 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14904 this_line_y
= w
->cursor
.y
;
14905 this_line_pixel_height
= row
->height
;
14906 this_line_vpos
= w
->cursor
.vpos
;
14907 this_line_start_x
= row
->x
;
14910 CHARPOS (this_line_start_pos
) = 0;
14917 /* Run window scroll functions, if any, for WINDOW with new window
14918 start STARTP. Sets the window start of WINDOW to that position.
14920 We assume that the window's buffer is really current. */
14922 static struct text_pos
14923 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14925 struct window
*w
= XWINDOW (window
);
14926 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14928 eassert (current_buffer
== XBUFFER (w
->contents
));
14930 if (!NILP (Vwindow_scroll_functions
))
14932 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14933 make_number (CHARPOS (startp
)));
14934 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14935 /* In case the hook functions switch buffers. */
14936 set_buffer_internal (XBUFFER (w
->contents
));
14943 /* Make sure the line containing the cursor is fully visible.
14944 A value of true means there is nothing to be done.
14945 (Either the line is fully visible, or it cannot be made so,
14946 or we cannot tell.)
14948 If FORCE_P, return false even if partial visible cursor row
14949 is higher than window.
14951 If CURRENT_MATRIX_P, use the information from the
14952 window's current glyph matrix; otherwise use the desired glyph
14955 A value of false means the caller should do scrolling
14956 as if point had gone off the screen. */
14959 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14960 bool current_matrix_p
)
14962 struct glyph_matrix
*matrix
;
14963 struct glyph_row
*row
;
14966 if (!make_cursor_line_fully_visible_p
)
14969 /* It's not always possible to find the cursor, e.g, when a window
14970 is full of overlay strings. Don't do anything in that case. */
14971 if (w
->cursor
.vpos
< 0)
14974 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14975 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14977 /* If the cursor row is not partially visible, there's nothing to do. */
14978 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14981 /* If the row the cursor is in is taller than the window's height,
14982 it's not clear what to do, so do nothing. */
14983 window_height
= window_box_height (w
);
14984 if (row
->height
>= window_height
)
14986 if (!force_p
|| MINI_WINDOW_P (w
)
14987 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14994 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14995 means only WINDOW is redisplayed in redisplay_internal.
14996 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14997 in redisplay_window to bring a partially visible line into view in
14998 the case that only the cursor has moved.
15000 LAST_LINE_MISFIT should be true if we're scrolling because the
15001 last screen line's vertical height extends past the end of the screen.
15005 1 if scrolling succeeded
15007 0 if scrolling didn't find point.
15009 -1 if new fonts have been loaded so that we must interrupt
15010 redisplay, adjust glyph matrices, and try again. */
15016 SCROLLING_NEED_LARGER_MATRICES
15019 /* If scroll-conservatively is more than this, never recenter.
15021 If you change this, don't forget to update the doc string of
15022 `scroll-conservatively' and the Emacs manual. */
15023 #define SCROLL_LIMIT 100
15026 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15027 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15028 bool temp_scroll_step
, bool last_line_misfit
)
15030 struct window
*w
= XWINDOW (window
);
15031 struct frame
*f
= XFRAME (w
->frame
);
15032 struct text_pos pos
, startp
;
15034 int this_scroll_margin
, scroll_max
, rc
, height
;
15035 int dy
= 0, amount_to_scroll
= 0;
15036 bool scroll_down_p
= false;
15037 int extra_scroll_margin_lines
= last_line_misfit
;
15038 Lisp_Object aggressive
;
15039 /* We will never try scrolling more than this number of lines. */
15040 int scroll_limit
= SCROLL_LIMIT
;
15041 int frame_line_height
= default_line_pixel_height (w
);
15042 int window_total_lines
15043 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15046 debug_method_add (w
, "try_scrolling");
15049 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15051 /* Compute scroll margin height in pixels. We scroll when point is
15052 within this distance from the top or bottom of the window. */
15053 if (scroll_margin
> 0)
15054 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15055 * frame_line_height
;
15057 this_scroll_margin
= 0;
15059 /* Force arg_scroll_conservatively to have a reasonable value, to
15060 avoid scrolling too far away with slow move_it_* functions. Note
15061 that the user can supply scroll-conservatively equal to
15062 `most-positive-fixnum', which can be larger than INT_MAX. */
15063 if (arg_scroll_conservatively
> scroll_limit
)
15065 arg_scroll_conservatively
= scroll_limit
+ 1;
15066 scroll_max
= scroll_limit
* frame_line_height
;
15068 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15069 /* Compute how much we should try to scroll maximally to bring
15070 point into view. */
15071 scroll_max
= (max (scroll_step
,
15072 max (arg_scroll_conservatively
, temp_scroll_step
))
15073 * frame_line_height
);
15074 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15075 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15076 /* We're trying to scroll because of aggressive scrolling but no
15077 scroll_step is set. Choose an arbitrary one. */
15078 scroll_max
= 10 * frame_line_height
;
15084 /* Decide whether to scroll down. */
15085 if (PT
> CHARPOS (startp
))
15087 int scroll_margin_y
;
15089 /* Compute the pixel ypos of the scroll margin, then move IT to
15090 either that ypos or PT, whichever comes first. */
15091 start_display (&it
, w
, startp
);
15092 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15093 - frame_line_height
* extra_scroll_margin_lines
;
15094 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15095 (MOVE_TO_POS
| MOVE_TO_Y
));
15097 if (PT
> CHARPOS (it
.current
.pos
))
15099 int y0
= line_bottom_y (&it
);
15100 /* Compute how many pixels below window bottom to stop searching
15101 for PT. This avoids costly search for PT that is far away if
15102 the user limited scrolling by a small number of lines, but
15103 always finds PT if scroll_conservatively is set to a large
15104 number, such as most-positive-fixnum. */
15105 int slack
= max (scroll_max
, 10 * frame_line_height
);
15106 int y_to_move
= it
.last_visible_y
+ slack
;
15108 /* Compute the distance from the scroll margin to PT or to
15109 the scroll limit, whichever comes first. This should
15110 include the height of the cursor line, to make that line
15112 move_it_to (&it
, PT
, -1, y_to_move
,
15113 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15114 dy
= line_bottom_y (&it
) - y0
;
15116 if (dy
> scroll_max
)
15117 return SCROLLING_FAILED
;
15120 scroll_down_p
= true;
15126 /* Point is in or below the bottom scroll margin, so move the
15127 window start down. If scrolling conservatively, move it just
15128 enough down to make point visible. If scroll_step is set,
15129 move it down by scroll_step. */
15130 if (arg_scroll_conservatively
)
15132 = min (max (dy
, frame_line_height
),
15133 frame_line_height
* arg_scroll_conservatively
);
15134 else if (scroll_step
|| temp_scroll_step
)
15135 amount_to_scroll
= scroll_max
;
15138 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15139 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15140 if (NUMBERP (aggressive
))
15142 double float_amount
= XFLOATINT (aggressive
) * height
;
15143 int aggressive_scroll
= float_amount
;
15144 if (aggressive_scroll
== 0 && float_amount
> 0)
15145 aggressive_scroll
= 1;
15146 /* Don't let point enter the scroll margin near top of
15147 the window. This could happen if the value of
15148 scroll_up_aggressively is too large and there are
15149 non-zero margins, because scroll_up_aggressively
15150 means put point that fraction of window height
15151 _from_the_bottom_margin_. */
15152 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15153 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15154 amount_to_scroll
= dy
+ aggressive_scroll
;
15158 if (amount_to_scroll
<= 0)
15159 return SCROLLING_FAILED
;
15161 start_display (&it
, w
, startp
);
15162 if (arg_scroll_conservatively
<= scroll_limit
)
15163 move_it_vertically (&it
, amount_to_scroll
);
15166 /* Extra precision for users who set scroll-conservatively
15167 to a large number: make sure the amount we scroll
15168 the window start is never less than amount_to_scroll,
15169 which was computed as distance from window bottom to
15170 point. This matters when lines at window top and lines
15171 below window bottom have different height. */
15173 void *it1data
= NULL
;
15174 /* We use a temporary it1 because line_bottom_y can modify
15175 its argument, if it moves one line down; see there. */
15178 SAVE_IT (it1
, it
, it1data
);
15179 start_y
= line_bottom_y (&it1
);
15181 RESTORE_IT (&it
, &it
, it1data
);
15182 move_it_by_lines (&it
, 1);
15183 SAVE_IT (it1
, it
, it1data
);
15184 } while (IT_CHARPOS (it
) < ZV
15185 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15186 bidi_unshelve_cache (it1data
, true);
15189 /* If STARTP is unchanged, move it down another screen line. */
15190 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15191 move_it_by_lines (&it
, 1);
15192 startp
= it
.current
.pos
;
15196 struct text_pos scroll_margin_pos
= startp
;
15199 /* See if point is inside the scroll margin at the top of the
15201 if (this_scroll_margin
)
15205 start_display (&it
, w
, startp
);
15206 y_start
= it
.current_y
;
15207 move_it_vertically (&it
, this_scroll_margin
);
15208 scroll_margin_pos
= it
.current
.pos
;
15209 /* If we didn't move enough before hitting ZV, request
15210 additional amount of scroll, to move point out of the
15212 if (IT_CHARPOS (it
) == ZV
15213 && it
.current_y
- y_start
< this_scroll_margin
)
15214 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15217 if (PT
< CHARPOS (scroll_margin_pos
))
15219 /* Point is in the scroll margin at the top of the window or
15220 above what is displayed in the window. */
15223 /* Compute the vertical distance from PT to the scroll
15224 margin position. Move as far as scroll_max allows, or
15225 one screenful, or 10 screen lines, whichever is largest.
15226 Give up if distance is greater than scroll_max or if we
15227 didn't reach the scroll margin position. */
15228 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15229 start_display (&it
, w
, pos
);
15231 y_to_move
= max (it
.last_visible_y
,
15232 max (scroll_max
, 10 * frame_line_height
));
15233 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15235 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15236 dy
= it
.current_y
- y0
;
15237 if (dy
> scroll_max
15238 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15239 return SCROLLING_FAILED
;
15241 /* Additional scroll for when ZV was too close to point. */
15244 /* Compute new window start. */
15245 start_display (&it
, w
, startp
);
15247 if (arg_scroll_conservatively
)
15248 amount_to_scroll
= max (dy
, frame_line_height
15249 * max (scroll_step
, temp_scroll_step
));
15250 else if (scroll_step
|| temp_scroll_step
)
15251 amount_to_scroll
= scroll_max
;
15254 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15255 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15256 if (NUMBERP (aggressive
))
15258 double float_amount
= XFLOATINT (aggressive
) * height
;
15259 int aggressive_scroll
= float_amount
;
15260 if (aggressive_scroll
== 0 && float_amount
> 0)
15261 aggressive_scroll
= 1;
15262 /* Don't let point enter the scroll margin near
15263 bottom of the window, if the value of
15264 scroll_down_aggressively happens to be too
15266 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15267 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15268 amount_to_scroll
= dy
+ aggressive_scroll
;
15272 if (amount_to_scroll
<= 0)
15273 return SCROLLING_FAILED
;
15275 move_it_vertically_backward (&it
, amount_to_scroll
);
15276 startp
= it
.current
.pos
;
15280 /* Run window scroll functions. */
15281 startp
= run_window_scroll_functions (window
, startp
);
15283 /* Display the window. Give up if new fonts are loaded, or if point
15285 if (!try_window (window
, startp
, 0))
15286 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15287 else if (w
->cursor
.vpos
< 0)
15289 clear_glyph_matrix (w
->desired_matrix
);
15290 rc
= SCROLLING_FAILED
;
15294 /* Maybe forget recorded base line for line number display. */
15295 if (!just_this_one_p
15296 || current_buffer
->clip_changed
15297 || BEG_UNCHANGED
< CHARPOS (startp
))
15298 w
->base_line_number
= 0;
15300 /* If cursor ends up on a partially visible line,
15301 treat that as being off the bottom of the screen. */
15302 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15304 /* It's possible that the cursor is on the first line of the
15305 buffer, which is partially obscured due to a vscroll
15306 (Bug#7537). In that case, avoid looping forever. */
15307 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15309 clear_glyph_matrix (w
->desired_matrix
);
15310 ++extra_scroll_margin_lines
;
15313 rc
= SCROLLING_SUCCESS
;
15320 /* Compute a suitable window start for window W if display of W starts
15321 on a continuation line. Value is true if a new window start
15324 The new window start will be computed, based on W's width, starting
15325 from the start of the continued line. It is the start of the
15326 screen line with the minimum distance from the old start W->start. */
15329 compute_window_start_on_continuation_line (struct window
*w
)
15331 struct text_pos pos
, start_pos
;
15332 bool window_start_changed_p
= false;
15334 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15336 /* If window start is on a continuation line... Window start may be
15337 < BEGV in case there's invisible text at the start of the
15338 buffer (M-x rmail, for example). */
15339 if (CHARPOS (start_pos
) > BEGV
15340 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15343 struct glyph_row
*row
;
15345 /* Handle the case that the window start is out of range. */
15346 if (CHARPOS (start_pos
) < BEGV
)
15347 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15348 else if (CHARPOS (start_pos
) > ZV
)
15349 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15351 /* Find the start of the continued line. This should be fast
15352 because find_newline is fast (newline cache). */
15353 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15354 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15355 row
, DEFAULT_FACE_ID
);
15356 reseat_at_previous_visible_line_start (&it
);
15358 /* If the line start is "too far" away from the window start,
15359 say it takes too much time to compute a new window start. */
15360 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15361 /* PXW: Do we need upper bounds here? */
15362 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15364 int min_distance
, distance
;
15366 /* Move forward by display lines to find the new window
15367 start. If window width was enlarged, the new start can
15368 be expected to be > the old start. If window width was
15369 decreased, the new window start will be < the old start.
15370 So, we're looking for the display line start with the
15371 minimum distance from the old window start. */
15372 pos
= it
.current
.pos
;
15373 min_distance
= INFINITY
;
15374 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15375 distance
< min_distance
)
15377 min_distance
= distance
;
15378 pos
= it
.current
.pos
;
15379 if (it
.line_wrap
== WORD_WRAP
)
15381 /* Under WORD_WRAP, move_it_by_lines is likely to
15382 overshoot and stop not at the first, but the
15383 second character from the left margin. So in
15384 that case, we need a more tight control on the X
15385 coordinate of the iterator than move_it_by_lines
15386 promises in its contract. The method is to first
15387 go to the last (rightmost) visible character of a
15388 line, then move to the leftmost character on the
15389 next line in a separate call. */
15390 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15391 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15392 move_it_to (&it
, ZV
, 0,
15393 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15394 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15397 move_it_by_lines (&it
, 1);
15400 /* Set the window start there. */
15401 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15402 window_start_changed_p
= true;
15406 return window_start_changed_p
;
15410 /* Try cursor movement in case text has not changed in window WINDOW,
15411 with window start STARTP. Value is
15413 CURSOR_MOVEMENT_SUCCESS if successful
15415 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15417 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15418 display. *SCROLL_STEP is set to true, under certain circumstances, if
15419 we want to scroll as if scroll-step were set to 1. See the code.
15421 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15422 which case we have to abort this redisplay, and adjust matrices
15427 CURSOR_MOVEMENT_SUCCESS
,
15428 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15429 CURSOR_MOVEMENT_MUST_SCROLL
,
15430 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15434 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15437 struct window
*w
= XWINDOW (window
);
15438 struct frame
*f
= XFRAME (w
->frame
);
15439 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15442 if (inhibit_try_cursor_movement
)
15446 /* Previously, there was a check for Lisp integer in the
15447 if-statement below. Now, this field is converted to
15448 ptrdiff_t, thus zero means invalid position in a buffer. */
15449 eassert (w
->last_point
> 0);
15450 /* Likewise there was a check whether window_end_vpos is nil or larger
15451 than the window. Now window_end_vpos is int and so never nil, but
15452 let's leave eassert to check whether it fits in the window. */
15453 eassert (!w
->window_end_valid
15454 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15456 /* Handle case where text has not changed, only point, and it has
15457 not moved off the frame. */
15458 if (/* Point may be in this window. */
15459 PT
>= CHARPOS (startp
)
15460 /* Selective display hasn't changed. */
15461 && !current_buffer
->clip_changed
15462 /* Function force-mode-line-update is used to force a thorough
15463 redisplay. It sets either windows_or_buffers_changed or
15464 update_mode_lines. So don't take a shortcut here for these
15466 && !update_mode_lines
15467 && !windows_or_buffers_changed
15468 && !f
->cursor_type_changed
15469 && NILP (Vshow_trailing_whitespace
)
15470 /* This code is not used for mini-buffer for the sake of the case
15471 of redisplaying to replace an echo area message; since in
15472 that case the mini-buffer contents per se are usually
15473 unchanged. This code is of no real use in the mini-buffer
15474 since the handling of this_line_start_pos, etc., in redisplay
15475 handles the same cases. */
15476 && !EQ (window
, minibuf_window
)
15477 && (FRAME_WINDOW_P (f
)
15478 || !overlay_arrow_in_current_buffer_p ()))
15480 int this_scroll_margin
, top_scroll_margin
;
15481 struct glyph_row
*row
= NULL
;
15482 int frame_line_height
= default_line_pixel_height (w
);
15483 int window_total_lines
15484 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15487 debug_method_add (w
, "cursor movement");
15490 /* Scroll if point within this distance from the top or bottom
15491 of the window. This is a pixel value. */
15492 if (scroll_margin
> 0)
15494 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15495 this_scroll_margin
*= frame_line_height
;
15498 this_scroll_margin
= 0;
15500 top_scroll_margin
= this_scroll_margin
;
15501 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15502 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15504 /* Start with the row the cursor was displayed during the last
15505 not paused redisplay. Give up if that row is not valid. */
15506 if (w
->last_cursor_vpos
< 0
15507 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15508 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15511 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15512 if (row
->mode_line_p
)
15514 if (!row
->enabled_p
)
15515 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15518 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15520 bool scroll_p
= false, must_scroll
= false;
15521 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15523 if (PT
> w
->last_point
)
15525 /* Point has moved forward. */
15526 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15527 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15529 eassert (row
->enabled_p
);
15533 /* If the end position of a row equals the start
15534 position of the next row, and PT is at that position,
15535 we would rather display cursor in the next line. */
15536 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15537 && MATRIX_ROW_END_CHARPOS (row
) == PT
15538 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15539 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15540 && !cursor_row_p (row
))
15543 /* If within the scroll margin, scroll. Note that
15544 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15545 the next line would be drawn, and that
15546 this_scroll_margin can be zero. */
15547 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15548 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15549 /* Line is completely visible last line in window
15550 and PT is to be set in the next line. */
15551 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15552 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15553 && !row
->ends_at_zv_p
15554 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15557 else if (PT
< w
->last_point
)
15559 /* Cursor has to be moved backward. Note that PT >=
15560 CHARPOS (startp) because of the outer if-statement. */
15561 while (!row
->mode_line_p
15562 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15563 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15564 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15565 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15566 row
> w
->current_matrix
->rows
15567 && (row
-1)->ends_in_newline_from_string_p
))))
15568 && (row
->y
> top_scroll_margin
15569 || CHARPOS (startp
) == BEGV
))
15571 eassert (row
->enabled_p
);
15575 /* Consider the following case: Window starts at BEGV,
15576 there is invisible, intangible text at BEGV, so that
15577 display starts at some point START > BEGV. It can
15578 happen that we are called with PT somewhere between
15579 BEGV and START. Try to handle that case. */
15580 if (row
< w
->current_matrix
->rows
15581 || row
->mode_line_p
)
15583 row
= w
->current_matrix
->rows
;
15584 if (row
->mode_line_p
)
15588 /* Due to newlines in overlay strings, we may have to
15589 skip forward over overlay strings. */
15590 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15591 && MATRIX_ROW_END_CHARPOS (row
) == PT
15592 && !cursor_row_p (row
))
15595 /* If within the scroll margin, scroll. */
15596 if (row
->y
< top_scroll_margin
15597 && CHARPOS (startp
) != BEGV
)
15602 /* Cursor did not move. So don't scroll even if cursor line
15603 is partially visible, as it was so before. */
15604 rc
= CURSOR_MOVEMENT_SUCCESS
;
15607 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15608 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15610 /* if PT is not in the glyph row, give up. */
15611 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15612 must_scroll
= true;
15614 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15615 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15617 struct glyph_row
*row1
;
15619 /* If rows are bidi-reordered and point moved, back up
15620 until we find a row that does not belong to a
15621 continuation line. This is because we must consider
15622 all rows of a continued line as candidates for the
15623 new cursor positioning, since row start and end
15624 positions change non-linearly with vertical position
15626 /* FIXME: Revisit this when glyph ``spilling'' in
15627 continuation lines' rows is implemented for
15628 bidi-reordered rows. */
15629 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15630 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15633 /* If we hit the beginning of the displayed portion
15634 without finding the first row of a continued
15638 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15641 eassert (row
->enabled_p
);
15646 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15647 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15648 /* Make sure this isn't a header line by any chance, since
15649 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15650 && !row
->mode_line_p
15651 && make_cursor_line_fully_visible_p
)
15653 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15654 && !row
->ends_at_zv_p
15655 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15656 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15657 else if (row
->height
> window_box_height (w
))
15659 /* If we end up in a partially visible line, let's
15660 make it fully visible, except when it's taller
15661 than the window, in which case we can't do much
15663 *scroll_step
= true;
15664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15668 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15669 if (!cursor_row_fully_visible_p (w
, false, true))
15670 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15672 rc
= CURSOR_MOVEMENT_SUCCESS
;
15676 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15677 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15678 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15680 /* With bidi-reordered rows, there could be more than
15681 one candidate row whose start and end positions
15682 occlude point. We need to let set_cursor_from_row
15683 find the best candidate. */
15684 /* FIXME: Revisit this when glyph ``spilling'' in
15685 continuation lines' rows is implemented for
15686 bidi-reordered rows. */
15691 bool at_zv_p
= false, exact_match_p
= false;
15693 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15694 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15695 && cursor_row_p (row
))
15696 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15698 /* As soon as we've found the exact match for point,
15699 or the first suitable row whose ends_at_zv_p flag
15700 is set, we are done. */
15703 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15704 w
->cursor
.vpos
)->ends_at_zv_p
;
15706 && w
->cursor
.hpos
>= 0
15707 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15710 struct glyph_row
*candidate
=
15711 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15713 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15714 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15717 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15718 || (NILP (g
->object
)
15719 && (g
->charpos
== PT
15720 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15722 if (at_zv_p
|| exact_match_p
)
15724 rc
= CURSOR_MOVEMENT_SUCCESS
;
15728 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15732 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15733 || row
->continued_p
)
15734 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15735 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15736 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15737 /* If we didn't find any candidate rows, or exited the
15738 loop before all the candidates were examined, signal
15739 to the caller that this method failed. */
15740 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15742 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15743 && !row
->continued_p
))
15744 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15746 rc
= CURSOR_MOVEMENT_SUCCESS
;
15752 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15754 rc
= CURSOR_MOVEMENT_SUCCESS
;
15759 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15760 && MATRIX_ROW_START_CHARPOS (row
) == PT
15761 && cursor_row_p (row
));
15771 set_vertical_scroll_bar (struct window
*w
)
15773 ptrdiff_t start
, end
, whole
;
15775 /* Calculate the start and end positions for the current window.
15776 At some point, it would be nice to choose between scrollbars
15777 which reflect the whole buffer size, with special markers
15778 indicating narrowing, and scrollbars which reflect only the
15781 Note that mini-buffers sometimes aren't displaying any text. */
15782 if (!MINI_WINDOW_P (w
)
15783 || (w
== XWINDOW (minibuf_window
)
15784 && NILP (echo_area_buffer
[0])))
15786 struct buffer
*buf
= XBUFFER (w
->contents
);
15787 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15788 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15789 /* I don't think this is guaranteed to be right. For the
15790 moment, we'll pretend it is. */
15791 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15795 if (whole
< (end
- start
))
15796 whole
= end
- start
;
15799 start
= end
= whole
= 0;
15801 /* Indicate what this scroll bar ought to be displaying now. */
15802 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15803 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15804 (w
, end
- start
, whole
, start
);
15809 set_horizontal_scroll_bar (struct window
*w
)
15811 int start
, end
, whole
, portion
;
15813 if (!MINI_WINDOW_P (w
)
15814 || (w
== XWINDOW (minibuf_window
)
15815 && NILP (echo_area_buffer
[0])))
15817 struct buffer
*b
= XBUFFER (w
->contents
);
15818 struct buffer
*old_buffer
= NULL
;
15820 struct text_pos startp
;
15822 if (b
!= current_buffer
)
15824 old_buffer
= current_buffer
;
15825 set_buffer_internal (b
);
15828 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15829 start_display (&it
, w
, startp
);
15830 it
.last_visible_x
= INT_MAX
;
15831 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15832 MOVE_TO_X
| MOVE_TO_Y
);
15833 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15834 window_box_height (w), -1,
15835 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15837 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15838 end
= start
+ window_box_width (w
, TEXT_AREA
);
15839 portion
= end
- start
;
15840 /* After enlarging a horizontally scrolled window such that it
15841 gets at least as wide as the text it contains, make sure that
15842 the thumb doesn't fill the entire scroll bar so we can still
15843 drag it back to see the entire text. */
15844 whole
= max (whole
, end
);
15850 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15851 if (EQ (pdir
, Qright_to_left
))
15853 start
= whole
- end
;
15854 end
= start
+ portion
;
15859 set_buffer_internal (old_buffer
);
15862 start
= end
= whole
= portion
= 0;
15864 w
->hscroll_whole
= whole
;
15866 /* Indicate what this scroll bar ought to be displaying now. */
15867 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15868 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15869 (w
, portion
, whole
, start
);
15873 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15874 selected_window is redisplayed.
15876 We can return without actually redisplaying the window if fonts has been
15877 changed on window's frame. In that case, redisplay_internal will retry.
15879 As one of the important parts of redisplaying a window, we need to
15880 decide whether the previous window-start position (stored in the
15881 window's w->start marker position) is still valid, and if it isn't,
15882 recompute it. Some details about that:
15884 . The previous window-start could be in a continuation line, in
15885 which case we need to recompute it when the window width
15886 changes. See compute_window_start_on_continuation_line and its
15889 . The text that changed since last redisplay could include the
15890 previous window-start position. In that case, we try to salvage
15891 what we can from the current glyph matrix by calling
15892 try_scrolling, which see.
15894 . Some Emacs command could force us to use a specific window-start
15895 position by setting the window's force_start flag, or gently
15896 propose doing that by setting the window's optional_new_start
15897 flag. In these cases, we try using the specified start point if
15898 that succeeds (i.e. the window desired matrix is successfully
15899 recomputed, and point location is within the window). In case
15900 of optional_new_start, we first check if the specified start
15901 position is feasible, i.e. if it will allow point to be
15902 displayed in the window. If using the specified start point
15903 fails, e.g., if new fonts are needed to be loaded, we abort the
15904 redisplay cycle and leave it up to the next cycle to figure out
15907 . Note that the window's force_start flag is sometimes set by
15908 redisplay itself, when it decides that the previous window start
15909 point is fine and should be kept. Search for "goto force_start"
15910 below to see the details. Like the values of window-start
15911 specified outside of redisplay, these internally-deduced values
15912 are tested for feasibility, and ignored if found to be
15915 . Note that the function try_window, used to completely redisplay
15916 a window, accepts the window's start point as its argument.
15917 This is used several times in the redisplay code to control
15918 where the window start will be, according to user options such
15919 as scroll-conservatively, and also to ensure the screen line
15920 showing point will be fully (as opposed to partially) visible on
15924 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15926 struct window
*w
= XWINDOW (window
);
15927 struct frame
*f
= XFRAME (w
->frame
);
15928 struct buffer
*buffer
= XBUFFER (w
->contents
);
15929 struct buffer
*old
= current_buffer
;
15930 struct text_pos lpoint
, opoint
, startp
;
15931 bool update_mode_line
;
15934 /* Record it now because it's overwritten. */
15935 bool current_matrix_up_to_date_p
= false;
15936 bool used_current_matrix_p
= false;
15937 /* This is less strict than current_matrix_up_to_date_p.
15938 It indicates that the buffer contents and narrowing are unchanged. */
15939 bool buffer_unchanged_p
= false;
15940 bool temp_scroll_step
= false;
15941 ptrdiff_t count
= SPECPDL_INDEX ();
15943 int centering_position
= -1;
15944 bool last_line_misfit
= false;
15945 ptrdiff_t beg_unchanged
, end_unchanged
;
15946 int frame_line_height
;
15948 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15952 *w
->desired_matrix
->method
= 0;
15955 if (!just_this_one_p
15956 && REDISPLAY_SOME_P ()
15958 && !w
->update_mode_line
15961 && !buffer
->text
->redisplay
15962 && BUF_PT (buffer
) == w
->last_point
)
15965 /* Make sure that both W's markers are valid. */
15966 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15967 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15969 /* We come here again if we need to run window-text-change-functions
15972 reconsider_clip_changes (w
);
15973 frame_line_height
= default_line_pixel_height (w
);
15975 /* Has the mode line to be updated? */
15976 update_mode_line
= (w
->update_mode_line
15977 || update_mode_lines
15978 || buffer
->clip_changed
15979 || buffer
->prevent_redisplay_optimizations_p
);
15981 if (!just_this_one_p
)
15982 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15983 cleverly elsewhere. */
15984 w
->must_be_updated_p
= true;
15986 if (MINI_WINDOW_P (w
))
15988 if (w
== XWINDOW (echo_area_window
)
15989 && !NILP (echo_area_buffer
[0]))
15991 if (update_mode_line
)
15992 /* We may have to update a tty frame's menu bar or a
15993 tool-bar. Example `M-x C-h C-h C-g'. */
15994 goto finish_menu_bars
;
15996 /* We've already displayed the echo area glyphs in this window. */
15997 goto finish_scroll_bars
;
15999 else if ((w
!= XWINDOW (minibuf_window
)
16000 || minibuf_level
== 0)
16001 /* When buffer is nonempty, redisplay window normally. */
16002 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16003 /* Quail displays non-mini buffers in minibuffer window.
16004 In that case, redisplay the window normally. */
16005 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16007 /* W is a mini-buffer window, but it's not active, so clear
16009 int yb
= window_text_bottom_y (w
);
16010 struct glyph_row
*row
;
16013 for (y
= 0, row
= w
->desired_matrix
->rows
;
16015 y
+= row
->height
, ++row
)
16016 blank_row (w
, row
, y
);
16017 goto finish_scroll_bars
;
16020 clear_glyph_matrix (w
->desired_matrix
);
16023 /* Otherwise set up data on this window; select its buffer and point
16025 /* Really select the buffer, for the sake of buffer-local
16027 set_buffer_internal_1 (XBUFFER (w
->contents
));
16029 current_matrix_up_to_date_p
16030 = (w
->window_end_valid
16031 && !current_buffer
->clip_changed
16032 && !current_buffer
->prevent_redisplay_optimizations_p
16033 && !window_outdated (w
));
16035 /* Run the window-text-change-functions
16036 if it is possible that the text on the screen has changed
16037 (either due to modification of the text, or any other reason). */
16038 if (!current_matrix_up_to_date_p
16039 && !NILP (Vwindow_text_change_functions
))
16041 safe_run_hooks (Qwindow_text_change_functions
);
16045 beg_unchanged
= BEG_UNCHANGED
;
16046 end_unchanged
= END_UNCHANGED
;
16048 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16050 specbind (Qinhibit_point_motion_hooks
, Qt
);
16053 = (w
->window_end_valid
16054 && !current_buffer
->clip_changed
16055 && !window_outdated (w
));
16057 /* When windows_or_buffers_changed is non-zero, we can't rely
16058 on the window end being valid, so set it to zero there. */
16059 if (windows_or_buffers_changed
)
16061 /* If window starts on a continuation line, maybe adjust the
16062 window start in case the window's width changed. */
16063 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16064 compute_window_start_on_continuation_line (w
);
16066 w
->window_end_valid
= false;
16067 /* If so, we also can't rely on current matrix
16068 and should not fool try_cursor_movement below. */
16069 current_matrix_up_to_date_p
= false;
16072 /* Some sanity checks. */
16073 CHECK_WINDOW_END (w
);
16074 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16076 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16079 if (mode_line_update_needed (w
))
16080 update_mode_line
= true;
16082 /* Point refers normally to the selected window. For any other
16083 window, set up appropriate value. */
16084 if (!EQ (window
, selected_window
))
16086 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16087 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16092 new_pt_byte
= BEGV_BYTE
;
16093 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16095 else if (new_pt
> (ZV
- 1))
16098 new_pt_byte
= ZV_BYTE
;
16099 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16102 /* We don't use SET_PT so that the point-motion hooks don't run. */
16103 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16106 /* If any of the character widths specified in the display table
16107 have changed, invalidate the width run cache. It's true that
16108 this may be a bit late to catch such changes, but the rest of
16109 redisplay goes (non-fatally) haywire when the display table is
16110 changed, so why should we worry about doing any better? */
16111 if (current_buffer
->width_run_cache
16112 || (current_buffer
->base_buffer
16113 && current_buffer
->base_buffer
->width_run_cache
))
16115 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16117 if (! disptab_matches_widthtab
16118 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16120 struct buffer
*buf
= current_buffer
;
16122 if (buf
->base_buffer
)
16123 buf
= buf
->base_buffer
;
16124 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16125 recompute_width_table (current_buffer
, disptab
);
16129 /* If window-start is screwed up, choose a new one. */
16130 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16133 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16135 /* If someone specified a new starting point but did not insist,
16136 check whether it can be used. */
16137 if ((w
->optional_new_start
|| window_frozen_p (w
))
16138 && CHARPOS (startp
) >= BEGV
16139 && CHARPOS (startp
) <= ZV
)
16141 ptrdiff_t it_charpos
;
16143 w
->optional_new_start
= false;
16144 start_display (&it
, w
, startp
);
16145 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16146 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16147 /* Record IT's position now, since line_bottom_y might change
16149 it_charpos
= IT_CHARPOS (it
);
16150 /* Make sure we set the force_start flag only if the cursor row
16151 will be fully visible. Otherwise, the code under force_start
16152 label below will try to move point back into view, which is
16153 not what the code which sets optional_new_start wants. */
16154 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16155 && !w
->force_start
)
16157 if (it_charpos
== PT
)
16158 w
->force_start
= true;
16159 /* IT may overshoot PT if text at PT is invisible. */
16160 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16161 w
->force_start
= true;
16163 if (w
->force_start
)
16165 if (window_frozen_p (w
))
16166 debug_method_add (w
, "set force_start from frozen window start");
16168 debug_method_add (w
, "set force_start from optional_new_start");
16176 /* Handle case where place to start displaying has been specified,
16177 unless the specified location is outside the accessible range. */
16178 if (w
->force_start
)
16180 /* We set this later on if we have to adjust point. */
16183 w
->force_start
= false;
16185 w
->window_end_valid
= false;
16187 /* Forget any recorded base line for line number display. */
16188 if (!buffer_unchanged_p
)
16189 w
->base_line_number
= 0;
16191 /* Redisplay the mode line. Select the buffer properly for that.
16192 Also, run the hook window-scroll-functions
16193 because we have scrolled. */
16194 /* Note, we do this after clearing force_start because
16195 if there's an error, it is better to forget about force_start
16196 than to get into an infinite loop calling the hook functions
16197 and having them get more errors. */
16198 if (!update_mode_line
16199 || ! NILP (Vwindow_scroll_functions
))
16201 update_mode_line
= true;
16202 w
->update_mode_line
= true;
16203 startp
= run_window_scroll_functions (window
, startp
);
16206 if (CHARPOS (startp
) < BEGV
)
16207 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16208 else if (CHARPOS (startp
) > ZV
)
16209 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16211 /* Redisplay, then check if cursor has been set during the
16212 redisplay. Give up if new fonts were loaded. */
16213 /* We used to issue a CHECK_MARGINS argument to try_window here,
16214 but this causes scrolling to fail when point begins inside
16215 the scroll margin (bug#148) -- cyd */
16216 if (!try_window (window
, startp
, 0))
16218 w
->force_start
= true;
16219 clear_glyph_matrix (w
->desired_matrix
);
16220 goto need_larger_matrices
;
16223 if (w
->cursor
.vpos
< 0)
16225 /* If point does not appear, try to move point so it does
16226 appear. The desired matrix has been built above, so we
16227 can use it here. */
16228 new_vpos
= window_box_height (w
) / 2;
16231 if (!cursor_row_fully_visible_p (w
, false, false))
16233 /* Point does appear, but on a line partly visible at end of window.
16234 Move it back to a fully-visible line. */
16235 new_vpos
= window_box_height (w
);
16236 /* But if window_box_height suggests a Y coordinate that is
16237 not less than we already have, that line will clearly not
16238 be fully visible, so give up and scroll the display.
16239 This can happen when the default face uses a font whose
16240 dimensions are different from the frame's default
16242 if (new_vpos
>= w
->cursor
.y
)
16244 w
->cursor
.vpos
= -1;
16245 clear_glyph_matrix (w
->desired_matrix
);
16246 goto try_to_scroll
;
16249 else if (w
->cursor
.vpos
>= 0)
16251 /* Some people insist on not letting point enter the scroll
16252 margin, even though this part handles windows that didn't
16254 int window_total_lines
16255 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16256 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16257 int pixel_margin
= margin
* frame_line_height
;
16258 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16260 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16261 below, which finds the row to move point to, advances by
16262 the Y coordinate of the _next_ row, see the definition of
16263 MATRIX_ROW_BOTTOM_Y. */
16264 if (w
->cursor
.vpos
< margin
+ header_line
)
16266 w
->cursor
.vpos
= -1;
16267 clear_glyph_matrix (w
->desired_matrix
);
16268 goto try_to_scroll
;
16272 int window_height
= window_box_height (w
);
16275 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16276 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16278 w
->cursor
.vpos
= -1;
16279 clear_glyph_matrix (w
->desired_matrix
);
16280 goto try_to_scroll
;
16285 /* If we need to move point for either of the above reasons,
16286 now actually do it. */
16289 struct glyph_row
*row
;
16291 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16292 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16295 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16296 MATRIX_ROW_START_BYTEPOS (row
));
16298 if (w
!= XWINDOW (selected_window
))
16299 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16300 else if (current_buffer
== old
)
16301 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16303 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16305 /* Re-run pre-redisplay-function so it can update the region
16306 according to the new position of point. */
16307 /* Other than the cursor, w's redisplay is done so we can set its
16308 redisplay to false. Also the buffer's redisplay can be set to
16309 false, since propagate_buffer_redisplay should have already
16310 propagated its info to `w' anyway. */
16311 w
->redisplay
= false;
16312 XBUFFER (w
->contents
)->text
->redisplay
= false;
16313 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16315 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16317 /* pre-redisplay-function made changes (e.g. move the region)
16318 that require another round of redisplay. */
16319 clear_glyph_matrix (w
->desired_matrix
);
16320 if (!try_window (window
, startp
, 0))
16321 goto need_larger_matrices
;
16324 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16326 clear_glyph_matrix (w
->desired_matrix
);
16327 goto try_to_scroll
;
16331 debug_method_add (w
, "forced window start");
16336 /* Handle case where text has not changed, only point, and it has
16337 not moved off the frame, and we are not retrying after hscroll.
16338 (current_matrix_up_to_date_p is true when retrying.) */
16339 if (current_matrix_up_to_date_p
16340 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16341 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16345 case CURSOR_MOVEMENT_SUCCESS
:
16346 used_current_matrix_p
= true;
16349 case CURSOR_MOVEMENT_MUST_SCROLL
:
16350 goto try_to_scroll
;
16356 /* If current starting point was originally the beginning of a line
16357 but no longer is, find a new starting point. */
16358 else if (w
->start_at_line_beg
16359 && !(CHARPOS (startp
) <= BEGV
16360 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16363 debug_method_add (w
, "recenter 1");
16368 /* Try scrolling with try_window_id. Value is > 0 if update has
16369 been done, it is -1 if we know that the same window start will
16370 not work. It is 0 if unsuccessful for some other reason. */
16371 else if ((tem
= try_window_id (w
)) != 0)
16374 debug_method_add (w
, "try_window_id %d", tem
);
16377 if (f
->fonts_changed
)
16378 goto need_larger_matrices
;
16382 /* Otherwise try_window_id has returned -1 which means that we
16383 don't want the alternative below this comment to execute. */
16385 else if (CHARPOS (startp
) >= BEGV
16386 && CHARPOS (startp
) <= ZV
16387 && PT
>= CHARPOS (startp
)
16388 && (CHARPOS (startp
) < ZV
16389 /* Avoid starting at end of buffer. */
16390 || CHARPOS (startp
) == BEGV
16391 || !window_outdated (w
)))
16393 int d1
, d2
, d5
, d6
;
16396 /* If first window line is a continuation line, and window start
16397 is inside the modified region, but the first change is before
16398 current window start, we must select a new window start.
16400 However, if this is the result of a down-mouse event (e.g. by
16401 extending the mouse-drag-overlay), we don't want to select a
16402 new window start, since that would change the position under
16403 the mouse, resulting in an unwanted mouse-movement rather
16404 than a simple mouse-click. */
16405 if (!w
->start_at_line_beg
16406 && NILP (do_mouse_tracking
)
16407 && CHARPOS (startp
) > BEGV
16408 && CHARPOS (startp
) > BEG
+ beg_unchanged
16409 && CHARPOS (startp
) <= Z
- end_unchanged
16410 /* Even if w->start_at_line_beg is nil, a new window may
16411 start at a line_beg, since that's how set_buffer_window
16412 sets it. So, we need to check the return value of
16413 compute_window_start_on_continuation_line. (See also
16415 && XMARKER (w
->start
)->buffer
== current_buffer
16416 && compute_window_start_on_continuation_line (w
)
16417 /* It doesn't make sense to force the window start like we
16418 do at label force_start if it is already known that point
16419 will not be fully visible in the resulting window, because
16420 doing so will move point from its correct position
16421 instead of scrolling the window to bring point into view.
16423 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16424 /* A very tall row could need more than the window height,
16425 in which case we accept that it is partially visible. */
16426 && (rtop
!= 0) == (rbot
!= 0))
16428 w
->force_start
= true;
16429 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16431 debug_method_add (w
, "recomputed window start in continuation line");
16437 debug_method_add (w
, "same window start");
16440 /* Try to redisplay starting at same place as before.
16441 If point has not moved off frame, accept the results. */
16442 if (!current_matrix_up_to_date_p
16443 /* Don't use try_window_reusing_current_matrix in this case
16444 because a window scroll function can have changed the
16446 || !NILP (Vwindow_scroll_functions
)
16447 || MINI_WINDOW_P (w
)
16448 || !(used_current_matrix_p
16449 = try_window_reusing_current_matrix (w
)))
16451 IF_DEBUG (debug_method_add (w
, "1"));
16452 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16453 /* -1 means we need to scroll.
16454 0 means we need new matrices, but fonts_changed
16455 is set in that case, so we will detect it below. */
16456 goto try_to_scroll
;
16459 if (f
->fonts_changed
)
16460 goto need_larger_matrices
;
16462 if (w
->cursor
.vpos
>= 0)
16464 if (!just_this_one_p
16465 || current_buffer
->clip_changed
16466 || BEG_UNCHANGED
< CHARPOS (startp
))
16467 /* Forget any recorded base line for line number display. */
16468 w
->base_line_number
= 0;
16470 if (!cursor_row_fully_visible_p (w
, true, false))
16472 clear_glyph_matrix (w
->desired_matrix
);
16473 last_line_misfit
= true;
16475 /* Drop through and scroll. */
16480 clear_glyph_matrix (w
->desired_matrix
);
16485 /* Redisplay the mode line. Select the buffer properly for that. */
16486 if (!update_mode_line
)
16488 update_mode_line
= true;
16489 w
->update_mode_line
= true;
16492 /* Try to scroll by specified few lines. */
16493 if ((scroll_conservatively
16494 || emacs_scroll_step
16495 || temp_scroll_step
16496 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16497 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16498 && CHARPOS (startp
) >= BEGV
16499 && CHARPOS (startp
) <= ZV
)
16501 /* The function returns -1 if new fonts were loaded, 1 if
16502 successful, 0 if not successful. */
16503 int ss
= try_scrolling (window
, just_this_one_p
,
16504 scroll_conservatively
,
16506 temp_scroll_step
, last_line_misfit
);
16509 case SCROLLING_SUCCESS
:
16512 case SCROLLING_NEED_LARGER_MATRICES
:
16513 goto need_larger_matrices
;
16515 case SCROLLING_FAILED
:
16523 /* Finally, just choose a place to start which positions point
16524 according to user preferences. */
16529 debug_method_add (w
, "recenter");
16532 /* Forget any previously recorded base line for line number display. */
16533 if (!buffer_unchanged_p
)
16534 w
->base_line_number
= 0;
16536 /* Determine the window start relative to point. */
16537 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16538 it
.current_y
= it
.last_visible_y
;
16539 if (centering_position
< 0)
16541 int window_total_lines
16542 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16544 = scroll_margin
> 0
16545 ? min (scroll_margin
, window_total_lines
/ 4)
16547 ptrdiff_t margin_pos
= CHARPOS (startp
);
16548 Lisp_Object aggressive
;
16551 /* If there is a scroll margin at the top of the window, find
16552 its character position. */
16554 /* Cannot call start_display if startp is not in the
16555 accessible region of the buffer. This can happen when we
16556 have just switched to a different buffer and/or changed
16557 its restriction. In that case, startp is initialized to
16558 the character position 1 (BEGV) because we did not yet
16559 have chance to display the buffer even once. */
16560 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16563 void *it1data
= NULL
;
16565 SAVE_IT (it1
, it
, it1data
);
16566 start_display (&it1
, w
, startp
);
16567 move_it_vertically (&it1
, margin
* frame_line_height
);
16568 margin_pos
= IT_CHARPOS (it1
);
16569 RESTORE_IT (&it
, &it
, it1data
);
16571 scrolling_up
= PT
> margin_pos
;
16574 ? BVAR (current_buffer
, scroll_up_aggressively
)
16575 : BVAR (current_buffer
, scroll_down_aggressively
);
16577 if (!MINI_WINDOW_P (w
)
16578 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16582 /* Setting scroll-conservatively overrides
16583 scroll-*-aggressively. */
16584 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16586 double float_amount
= XFLOATINT (aggressive
);
16588 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16589 if (pt_offset
== 0 && float_amount
> 0)
16591 if (pt_offset
&& margin
> 0)
16594 /* Compute how much to move the window start backward from
16595 point so that point will be displayed where the user
16599 centering_position
= it
.last_visible_y
;
16601 centering_position
-= pt_offset
;
16602 centering_position
-=
16603 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16604 + WINDOW_HEADER_LINE_HEIGHT (w
));
16605 /* Don't let point enter the scroll margin near top of
16607 if (centering_position
< margin
* frame_line_height
)
16608 centering_position
= margin
* frame_line_height
;
16611 centering_position
= margin
* frame_line_height
+ pt_offset
;
16614 /* Set the window start half the height of the window backward
16616 centering_position
= window_box_height (w
) / 2;
16618 move_it_vertically_backward (&it
, centering_position
);
16620 eassert (IT_CHARPOS (it
) >= BEGV
);
16622 /* The function move_it_vertically_backward may move over more
16623 than the specified y-distance. If it->w is small, e.g. a
16624 mini-buffer window, we may end up in front of the window's
16625 display area. Start displaying at the start of the line
16626 containing PT in this case. */
16627 if (it
.current_y
<= 0)
16629 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16630 move_it_vertically_backward (&it
, 0);
16634 it
.current_x
= it
.hpos
= 0;
16636 /* Set the window start position here explicitly, to avoid an
16637 infinite loop in case the functions in window-scroll-functions
16639 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16641 /* Run scroll hooks. */
16642 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16644 /* Redisplay the window. */
16645 if (!current_matrix_up_to_date_p
16646 || windows_or_buffers_changed
16647 || f
->cursor_type_changed
16648 /* Don't use try_window_reusing_current_matrix in this case
16649 because it can have changed the buffer. */
16650 || !NILP (Vwindow_scroll_functions
)
16651 || !just_this_one_p
16652 || MINI_WINDOW_P (w
)
16653 || !(used_current_matrix_p
16654 = try_window_reusing_current_matrix (w
)))
16655 try_window (window
, startp
, 0);
16657 /* If new fonts have been loaded (due to fontsets), give up. We
16658 have to start a new redisplay since we need to re-adjust glyph
16660 if (f
->fonts_changed
)
16661 goto need_larger_matrices
;
16663 /* If cursor did not appear assume that the middle of the window is
16664 in the first line of the window. Do it again with the next line.
16665 (Imagine a window of height 100, displaying two lines of height
16666 60. Moving back 50 from it->last_visible_y will end in the first
16668 if (w
->cursor
.vpos
< 0)
16670 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16672 clear_glyph_matrix (w
->desired_matrix
);
16673 move_it_by_lines (&it
, 1);
16674 try_window (window
, it
.current
.pos
, 0);
16676 else if (PT
< IT_CHARPOS (it
))
16678 clear_glyph_matrix (w
->desired_matrix
);
16679 move_it_by_lines (&it
, -1);
16680 try_window (window
, it
.current
.pos
, 0);
16684 /* Not much we can do about it. */
16688 /* Consider the following case: Window starts at BEGV, there is
16689 invisible, intangible text at BEGV, so that display starts at
16690 some point START > BEGV. It can happen that we are called with
16691 PT somewhere between BEGV and START. Try to handle that case,
16692 and similar ones. */
16693 if (w
->cursor
.vpos
< 0)
16695 /* First, try locating the proper glyph row for PT. */
16696 struct glyph_row
*row
=
16697 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16699 /* Sometimes point is at the beginning of invisible text that is
16700 before the 1st character displayed in the row. In that case,
16701 row_containing_pos fails to find the row, because no glyphs
16702 with appropriate buffer positions are present in the row.
16703 Therefore, we next try to find the row which shows the 1st
16704 position after the invisible text. */
16708 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16711 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16714 Lisp_Object invis_end
=
16715 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16718 if (NATNUMP (invis_end
))
16719 alt_pos
= XFASTINT (invis_end
);
16722 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16726 /* Finally, fall back on the first row of the window after the
16727 header line (if any). This is slightly better than not
16728 displaying the cursor at all. */
16731 row
= w
->current_matrix
->rows
;
16732 if (row
->mode_line_p
)
16735 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16738 if (!cursor_row_fully_visible_p (w
, false, false))
16740 /* If vscroll is enabled, disable it and try again. */
16744 clear_glyph_matrix (w
->desired_matrix
);
16748 /* Users who set scroll-conservatively to a large number want
16749 point just above/below the scroll margin. If we ended up
16750 with point's row partially visible, move the window start to
16751 make that row fully visible and out of the margin. */
16752 if (scroll_conservatively
> SCROLL_LIMIT
)
16754 int window_total_lines
16755 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16758 ? min (scroll_margin
, window_total_lines
/ 4)
16760 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16762 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16763 clear_glyph_matrix (w
->desired_matrix
);
16764 if (1 == try_window (window
, it
.current
.pos
,
16765 TRY_WINDOW_CHECK_MARGINS
))
16769 /* If centering point failed to make the whole line visible,
16770 put point at the top instead. That has to make the whole line
16771 visible, if it can be done. */
16772 if (centering_position
== 0)
16775 clear_glyph_matrix (w
->desired_matrix
);
16776 centering_position
= 0;
16782 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16783 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16784 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16786 /* Display the mode line, if we must. */
16787 if ((update_mode_line
16788 /* If window not full width, must redo its mode line
16789 if (a) the window to its side is being redone and
16790 (b) we do a frame-based redisplay. This is a consequence
16791 of how inverted lines are drawn in frame-based redisplay. */
16792 || (!just_this_one_p
16793 && !FRAME_WINDOW_P (f
)
16794 && !WINDOW_FULL_WIDTH_P (w
))
16795 /* Line number to display. */
16796 || w
->base_line_pos
> 0
16797 /* Column number is displayed and different from the one displayed. */
16798 || (w
->column_number_displayed
!= -1
16799 && (w
->column_number_displayed
!= current_column ())))
16800 /* This means that the window has a mode line. */
16801 && (WINDOW_WANTS_MODELINE_P (w
)
16802 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16805 display_mode_lines (w
);
16807 /* If mode line height has changed, arrange for a thorough
16808 immediate redisplay using the correct mode line height. */
16809 if (WINDOW_WANTS_MODELINE_P (w
)
16810 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16812 f
->fonts_changed
= true;
16813 w
->mode_line_height
= -1;
16814 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16815 = DESIRED_MODE_LINE_HEIGHT (w
);
16818 /* If header line height has changed, arrange for a thorough
16819 immediate redisplay using the correct header line height. */
16820 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16821 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16823 f
->fonts_changed
= true;
16824 w
->header_line_height
= -1;
16825 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16826 = DESIRED_HEADER_LINE_HEIGHT (w
);
16829 if (f
->fonts_changed
)
16830 goto need_larger_matrices
;
16833 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16835 w
->base_line_pos
= 0;
16836 w
->base_line_number
= 0;
16841 /* When we reach a frame's selected window, redo the frame's menu bar. */
16842 if (update_mode_line
16843 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16845 bool redisplay_menu_p
;
16847 if (FRAME_WINDOW_P (f
))
16849 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16850 || defined (HAVE_NS) || defined (USE_GTK)
16851 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16853 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16857 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16859 if (redisplay_menu_p
)
16860 display_menu_bar (w
);
16862 #ifdef HAVE_WINDOW_SYSTEM
16863 if (FRAME_WINDOW_P (f
))
16865 #if defined (USE_GTK) || defined (HAVE_NS)
16866 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16867 redisplay_tool_bar (f
);
16869 if (WINDOWP (f
->tool_bar_window
)
16870 && (FRAME_TOOL_BAR_LINES (f
) > 0
16871 || !NILP (Vauto_resize_tool_bars
))
16872 && redisplay_tool_bar (f
))
16873 ignore_mouse_drag_p
= true;
16879 #ifdef HAVE_WINDOW_SYSTEM
16880 if (FRAME_WINDOW_P (f
)
16881 && update_window_fringes (w
, (just_this_one_p
16882 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16883 || w
->pseudo_window_p
)))
16887 if (draw_window_fringes (w
, true))
16889 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16890 x_draw_right_divider (w
);
16892 x_draw_vertical_border (w
);
16898 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16899 x_draw_bottom_divider (w
);
16900 #endif /* HAVE_WINDOW_SYSTEM */
16902 /* We go to this label, with fonts_changed set, if it is
16903 necessary to try again using larger glyph matrices.
16904 We have to redeem the scroll bar even in this case,
16905 because the loop in redisplay_internal expects that. */
16906 need_larger_matrices
:
16908 finish_scroll_bars
:
16910 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16912 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16913 /* Set the thumb's position and size. */
16914 set_vertical_scroll_bar (w
);
16916 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16917 /* Set the thumb's position and size. */
16918 set_horizontal_scroll_bar (w
);
16920 /* Note that we actually used the scroll bar attached to this
16921 window, so it shouldn't be deleted at the end of redisplay. */
16922 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16923 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16926 /* Restore current_buffer and value of point in it. The window
16927 update may have changed the buffer, so first make sure `opoint'
16928 is still valid (Bug#6177). */
16929 if (CHARPOS (opoint
) < BEGV
)
16930 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16931 else if (CHARPOS (opoint
) > ZV
)
16932 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16934 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16936 set_buffer_internal_1 (old
);
16937 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16938 shorter. This can be caused by log truncation in *Messages*. */
16939 if (CHARPOS (lpoint
) <= ZV
)
16940 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16942 unbind_to (count
, Qnil
);
16946 /* Build the complete desired matrix of WINDOW with a window start
16947 buffer position POS.
16949 Value is 1 if successful. It is zero if fonts were loaded during
16950 redisplay which makes re-adjusting glyph matrices necessary, and -1
16951 if point would appear in the scroll margins.
16952 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16953 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16957 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16959 struct window
*w
= XWINDOW (window
);
16961 struct glyph_row
*last_text_row
= NULL
;
16962 struct frame
*f
= XFRAME (w
->frame
);
16963 int frame_line_height
= default_line_pixel_height (w
);
16965 /* Make POS the new window start. */
16966 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16968 /* Mark cursor position as unknown. No overlay arrow seen. */
16969 w
->cursor
.vpos
= -1;
16970 overlay_arrow_seen
= false;
16972 /* Initialize iterator and info to start at POS. */
16973 start_display (&it
, w
, pos
);
16974 it
.glyph_row
->reversed_p
= false;
16976 /* Display all lines of W. */
16977 while (it
.current_y
< it
.last_visible_y
)
16979 if (display_line (&it
))
16980 last_text_row
= it
.glyph_row
- 1;
16981 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16985 /* Don't let the cursor end in the scroll margins. */
16986 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16987 && !MINI_WINDOW_P (w
))
16989 int this_scroll_margin
;
16990 int window_total_lines
16991 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16993 if (scroll_margin
> 0)
16995 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16996 this_scroll_margin
*= frame_line_height
;
16999 this_scroll_margin
= 0;
17001 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17002 && w
->cursor
.y
< this_scroll_margin
17003 && CHARPOS (pos
) > BEGV
17004 && IT_CHARPOS (it
) < ZV
)
17005 /* rms: considering make_cursor_line_fully_visible_p here
17006 seems to give wrong results. We don't want to recenter
17007 when the last line is partly visible, we want to allow
17008 that case to be handled in the usual way. */
17009 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17011 w
->cursor
.vpos
= -1;
17012 clear_glyph_matrix (w
->desired_matrix
);
17017 /* If bottom moved off end of frame, change mode line percentage. */
17018 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17019 w
->update_mode_line
= true;
17021 /* Set window_end_pos to the offset of the last character displayed
17022 on the window from the end of current_buffer. Set
17023 window_end_vpos to its row number. */
17026 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17027 adjust_window_ends (w
, last_text_row
, false);
17029 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17030 w
->window_end_vpos
)));
17034 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17035 w
->window_end_pos
= Z
- ZV
;
17036 w
->window_end_vpos
= 0;
17039 /* But that is not valid info until redisplay finishes. */
17040 w
->window_end_valid
= false;
17046 /************************************************************************
17047 Window redisplay reusing current matrix when buffer has not changed
17048 ************************************************************************/
17050 /* Try redisplay of window W showing an unchanged buffer with a
17051 different window start than the last time it was displayed by
17052 reusing its current matrix. Value is true if successful.
17053 W->start is the new window start. */
17056 try_window_reusing_current_matrix (struct window
*w
)
17058 struct frame
*f
= XFRAME (w
->frame
);
17059 struct glyph_row
*bottom_row
;
17062 struct text_pos start
, new_start
;
17063 int nrows_scrolled
, i
;
17064 struct glyph_row
*last_text_row
;
17065 struct glyph_row
*last_reused_text_row
;
17066 struct glyph_row
*start_row
;
17067 int start_vpos
, min_y
, max_y
;
17070 if (inhibit_try_window_reusing
)
17074 if (/* This function doesn't handle terminal frames. */
17075 !FRAME_WINDOW_P (f
)
17076 /* Don't try to reuse the display if windows have been split
17078 || windows_or_buffers_changed
17079 || f
->cursor_type_changed
)
17082 /* Can't do this if showing trailing whitespace. */
17083 if (!NILP (Vshow_trailing_whitespace
))
17086 /* If top-line visibility has changed, give up. */
17087 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17088 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17091 /* Give up if old or new display is scrolled vertically. We could
17092 make this function handle this, but right now it doesn't. */
17093 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17094 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17097 /* The variable new_start now holds the new window start. The old
17098 start `start' can be determined from the current matrix. */
17099 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17100 start
= start_row
->minpos
;
17101 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17103 /* Clear the desired matrix for the display below. */
17104 clear_glyph_matrix (w
->desired_matrix
);
17106 if (CHARPOS (new_start
) <= CHARPOS (start
))
17108 /* Don't use this method if the display starts with an ellipsis
17109 displayed for invisible text. It's not easy to handle that case
17110 below, and it's certainly not worth the effort since this is
17111 not a frequent case. */
17112 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17115 IF_DEBUG (debug_method_add (w
, "twu1"));
17117 /* Display up to a row that can be reused. The variable
17118 last_text_row is set to the last row displayed that displays
17119 text. Note that it.vpos == 0 if or if not there is a
17120 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17121 start_display (&it
, w
, new_start
);
17122 w
->cursor
.vpos
= -1;
17123 last_text_row
= last_reused_text_row
= NULL
;
17125 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17127 /* If we have reached into the characters in the START row,
17128 that means the line boundaries have changed. So we
17129 can't start copying with the row START. Maybe it will
17130 work to start copying with the following row. */
17131 while (IT_CHARPOS (it
) > CHARPOS (start
))
17133 /* Advance to the next row as the "start". */
17135 start
= start_row
->minpos
;
17136 /* If there are no more rows to try, or just one, give up. */
17137 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17138 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17139 || CHARPOS (start
) == ZV
)
17141 clear_glyph_matrix (w
->desired_matrix
);
17145 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17147 /* If we have reached alignment, we can copy the rest of the
17149 if (IT_CHARPOS (it
) == CHARPOS (start
)
17150 /* Don't accept "alignment" inside a display vector,
17151 since start_row could have started in the middle of
17152 that same display vector (thus their character
17153 positions match), and we have no way of telling if
17154 that is the case. */
17155 && it
.current
.dpvec_index
< 0)
17158 it
.glyph_row
->reversed_p
= false;
17159 if (display_line (&it
))
17160 last_text_row
= it
.glyph_row
- 1;
17164 /* A value of current_y < last_visible_y means that we stopped
17165 at the previous window start, which in turn means that we
17166 have at least one reusable row. */
17167 if (it
.current_y
< it
.last_visible_y
)
17169 struct glyph_row
*row
;
17171 /* IT.vpos always starts from 0; it counts text lines. */
17172 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17174 /* Find PT if not already found in the lines displayed. */
17175 if (w
->cursor
.vpos
< 0)
17177 int dy
= it
.current_y
- start_row
->y
;
17179 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17180 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17182 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17183 dy
, nrows_scrolled
);
17186 clear_glyph_matrix (w
->desired_matrix
);
17191 /* Scroll the display. Do it before the current matrix is
17192 changed. The problem here is that update has not yet
17193 run, i.e. part of the current matrix is not up to date.
17194 scroll_run_hook will clear the cursor, and use the
17195 current matrix to get the height of the row the cursor is
17197 run
.current_y
= start_row
->y
;
17198 run
.desired_y
= it
.current_y
;
17199 run
.height
= it
.last_visible_y
- it
.current_y
;
17201 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17204 FRAME_RIF (f
)->update_window_begin_hook (w
);
17205 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17206 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17207 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17211 /* Shift current matrix down by nrows_scrolled lines. */
17212 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17213 rotate_matrix (w
->current_matrix
,
17215 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17218 /* Disable lines that must be updated. */
17219 for (i
= 0; i
< nrows_scrolled
; ++i
)
17220 (start_row
+ i
)->enabled_p
= false;
17222 /* Re-compute Y positions. */
17223 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17224 max_y
= it
.last_visible_y
;
17225 for (row
= start_row
+ nrows_scrolled
;
17229 row
->y
= it
.current_y
;
17230 row
->visible_height
= row
->height
;
17232 if (row
->y
< min_y
)
17233 row
->visible_height
-= min_y
- row
->y
;
17234 if (row
->y
+ row
->height
> max_y
)
17235 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17236 if (row
->fringe_bitmap_periodic_p
)
17237 row
->redraw_fringe_bitmaps_p
= true;
17239 it
.current_y
+= row
->height
;
17241 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17242 last_reused_text_row
= row
;
17243 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17247 /* Disable lines in the current matrix which are now
17248 below the window. */
17249 for (++row
; row
< bottom_row
; ++row
)
17250 row
->enabled_p
= row
->mode_line_p
= false;
17253 /* Update window_end_pos etc.; last_reused_text_row is the last
17254 reused row from the current matrix containing text, if any.
17255 The value of last_text_row is the last displayed line
17256 containing text. */
17257 if (last_reused_text_row
)
17258 adjust_window_ends (w
, last_reused_text_row
, true);
17259 else if (last_text_row
)
17260 adjust_window_ends (w
, last_text_row
, false);
17263 /* This window must be completely empty. */
17264 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17265 w
->window_end_pos
= Z
- ZV
;
17266 w
->window_end_vpos
= 0;
17268 w
->window_end_valid
= false;
17270 /* Update hint: don't try scrolling again in update_window. */
17271 w
->desired_matrix
->no_scrolling_p
= true;
17274 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17278 else if (CHARPOS (new_start
) > CHARPOS (start
))
17280 struct glyph_row
*pt_row
, *row
;
17281 struct glyph_row
*first_reusable_row
;
17282 struct glyph_row
*first_row_to_display
;
17284 int yb
= window_text_bottom_y (w
);
17286 /* Find the row starting at new_start, if there is one. Don't
17287 reuse a partially visible line at the end. */
17288 first_reusable_row
= start_row
;
17289 while (first_reusable_row
->enabled_p
17290 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17291 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17292 < CHARPOS (new_start
)))
17293 ++first_reusable_row
;
17295 /* Give up if there is no row to reuse. */
17296 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17297 || !first_reusable_row
->enabled_p
17298 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17299 != CHARPOS (new_start
)))
17302 /* We can reuse fully visible rows beginning with
17303 first_reusable_row to the end of the window. Set
17304 first_row_to_display to the first row that cannot be reused.
17305 Set pt_row to the row containing point, if there is any. */
17307 for (first_row_to_display
= first_reusable_row
;
17308 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17309 ++first_row_to_display
)
17311 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17312 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17313 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17314 && first_row_to_display
->ends_at_zv_p
17315 && pt_row
== NULL
)))
17316 pt_row
= first_row_to_display
;
17319 /* Start displaying at the start of first_row_to_display. */
17320 eassert (first_row_to_display
->y
< yb
);
17321 init_to_row_start (&it
, w
, first_row_to_display
);
17323 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17325 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17327 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17328 + WINDOW_HEADER_LINE_HEIGHT (w
));
17330 /* Display lines beginning with first_row_to_display in the
17331 desired matrix. Set last_text_row to the last row displayed
17332 that displays text. */
17333 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17334 if (pt_row
== NULL
)
17335 w
->cursor
.vpos
= -1;
17336 last_text_row
= NULL
;
17337 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17338 if (display_line (&it
))
17339 last_text_row
= it
.glyph_row
- 1;
17341 /* If point is in a reused row, adjust y and vpos of the cursor
17345 w
->cursor
.vpos
-= nrows_scrolled
;
17346 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17349 /* Give up if point isn't in a row displayed or reused. (This
17350 also handles the case where w->cursor.vpos < nrows_scrolled
17351 after the calls to display_line, which can happen with scroll
17352 margins. See bug#1295.) */
17353 if (w
->cursor
.vpos
< 0)
17355 clear_glyph_matrix (w
->desired_matrix
);
17359 /* Scroll the display. */
17360 run
.current_y
= first_reusable_row
->y
;
17361 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17362 run
.height
= it
.last_visible_y
- run
.current_y
;
17363 dy
= run
.current_y
- run
.desired_y
;
17368 FRAME_RIF (f
)->update_window_begin_hook (w
);
17369 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17370 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17371 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17375 /* Adjust Y positions of reused rows. */
17376 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17377 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17378 max_y
= it
.last_visible_y
;
17379 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17382 row
->visible_height
= row
->height
;
17383 if (row
->y
< min_y
)
17384 row
->visible_height
-= min_y
- row
->y
;
17385 if (row
->y
+ row
->height
> max_y
)
17386 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17387 if (row
->fringe_bitmap_periodic_p
)
17388 row
->redraw_fringe_bitmaps_p
= true;
17391 /* Scroll the current matrix. */
17392 eassert (nrows_scrolled
> 0);
17393 rotate_matrix (w
->current_matrix
,
17395 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17398 /* Disable rows not reused. */
17399 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17400 row
->enabled_p
= false;
17402 /* Point may have moved to a different line, so we cannot assume that
17403 the previous cursor position is valid; locate the correct row. */
17406 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17408 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17409 && !row
->ends_at_zv_p
;
17413 w
->cursor
.y
= row
->y
;
17415 if (row
< bottom_row
)
17417 /* Can't simply scan the row for point with
17418 bidi-reordered glyph rows. Let set_cursor_from_row
17419 figure out where to put the cursor, and if it fails,
17421 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17423 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17426 clear_glyph_matrix (w
->desired_matrix
);
17432 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17433 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17436 && (!BUFFERP (glyph
->object
)
17437 || glyph
->charpos
< PT
);
17441 w
->cursor
.x
+= glyph
->pixel_width
;
17447 /* Adjust window end. A null value of last_text_row means that
17448 the window end is in reused rows which in turn means that
17449 only its vpos can have changed. */
17451 adjust_window_ends (w
, last_text_row
, false);
17453 w
->window_end_vpos
-= nrows_scrolled
;
17455 w
->window_end_valid
= false;
17456 w
->desired_matrix
->no_scrolling_p
= true;
17459 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17469 /************************************************************************
17470 Window redisplay reusing current matrix when buffer has changed
17471 ************************************************************************/
17473 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17474 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17475 ptrdiff_t *, ptrdiff_t *);
17476 static struct glyph_row
*
17477 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17478 struct glyph_row
*);
17481 /* Return the last row in MATRIX displaying text. If row START is
17482 non-null, start searching with that row. IT gives the dimensions
17483 of the display. Value is null if matrix is empty; otherwise it is
17484 a pointer to the row found. */
17486 static struct glyph_row
*
17487 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17488 struct glyph_row
*start
)
17490 struct glyph_row
*row
, *row_found
;
17492 /* Set row_found to the last row in IT->w's current matrix
17493 displaying text. The loop looks funny but think of partially
17496 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17497 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17499 eassert (row
->enabled_p
);
17501 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17510 /* Return the last row in the current matrix of W that is not affected
17511 by changes at the start of current_buffer that occurred since W's
17512 current matrix was built. Value is null if no such row exists.
17514 BEG_UNCHANGED us the number of characters unchanged at the start of
17515 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17516 first changed character in current_buffer. Characters at positions <
17517 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17518 when the current matrix was built. */
17520 static struct glyph_row
*
17521 find_last_unchanged_at_beg_row (struct window
*w
)
17523 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17524 struct glyph_row
*row
;
17525 struct glyph_row
*row_found
= NULL
;
17526 int yb
= window_text_bottom_y (w
);
17528 /* Find the last row displaying unchanged text. */
17529 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17530 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17531 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17534 if (/* If row ends before first_changed_pos, it is unchanged,
17535 except in some case. */
17536 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17537 /* When row ends in ZV and we write at ZV it is not
17539 && !row
->ends_at_zv_p
17540 /* When first_changed_pos is the end of a continued line,
17541 row is not unchanged because it may be no longer
17543 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17544 && (row
->continued_p
17545 || row
->exact_window_width_line_p
))
17546 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17547 needs to be recomputed, so don't consider this row as
17548 unchanged. This happens when the last line was
17549 bidi-reordered and was killed immediately before this
17550 redisplay cycle. In that case, ROW->end stores the
17551 buffer position of the first visual-order character of
17552 the killed text, which is now beyond ZV. */
17553 && CHARPOS (row
->end
.pos
) <= ZV
)
17556 /* Stop if last visible row. */
17557 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17565 /* Find the first glyph row in the current matrix of W that is not
17566 affected by changes at the end of current_buffer since the
17567 time W's current matrix was built.
17569 Return in *DELTA the number of chars by which buffer positions in
17570 unchanged text at the end of current_buffer must be adjusted.
17572 Return in *DELTA_BYTES the corresponding number of bytes.
17574 Value is null if no such row exists, i.e. all rows are affected by
17577 static struct glyph_row
*
17578 find_first_unchanged_at_end_row (struct window
*w
,
17579 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17581 struct glyph_row
*row
;
17582 struct glyph_row
*row_found
= NULL
;
17584 *delta
= *delta_bytes
= 0;
17586 /* Display must not have been paused, otherwise the current matrix
17587 is not up to date. */
17588 eassert (w
->window_end_valid
);
17590 /* A value of window_end_pos >= END_UNCHANGED means that the window
17591 end is in the range of changed text. If so, there is no
17592 unchanged row at the end of W's current matrix. */
17593 if (w
->window_end_pos
>= END_UNCHANGED
)
17596 /* Set row to the last row in W's current matrix displaying text. */
17597 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17599 /* If matrix is entirely empty, no unchanged row exists. */
17600 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17602 /* The value of row is the last glyph row in the matrix having a
17603 meaningful buffer position in it. The end position of row
17604 corresponds to window_end_pos. This allows us to translate
17605 buffer positions in the current matrix to current buffer
17606 positions for characters not in changed text. */
17608 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17609 ptrdiff_t Z_BYTE_old
=
17610 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17611 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17612 struct glyph_row
*first_text_row
17613 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17615 *delta
= Z
- Z_old
;
17616 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17618 /* Set last_unchanged_pos to the buffer position of the last
17619 character in the buffer that has not been changed. Z is the
17620 index + 1 of the last character in current_buffer, i.e. by
17621 subtracting END_UNCHANGED we get the index of the last
17622 unchanged character, and we have to add BEG to get its buffer
17624 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17625 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17627 /* Search backward from ROW for a row displaying a line that
17628 starts at a minimum position >= last_unchanged_pos_old. */
17629 for (; row
> first_text_row
; --row
)
17631 /* This used to abort, but it can happen.
17632 It is ok to just stop the search instead here. KFS. */
17633 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17636 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17641 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17647 /* Make sure that glyph rows in the current matrix of window W
17648 reference the same glyph memory as corresponding rows in the
17649 frame's frame matrix. This function is called after scrolling W's
17650 current matrix on a terminal frame in try_window_id and
17651 try_window_reusing_current_matrix. */
17654 sync_frame_with_window_matrix_rows (struct window
*w
)
17656 struct frame
*f
= XFRAME (w
->frame
);
17657 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17659 /* Preconditions: W must be a leaf window and full-width. Its frame
17660 must have a frame matrix. */
17661 eassert (BUFFERP (w
->contents
));
17662 eassert (WINDOW_FULL_WIDTH_P (w
));
17663 eassert (!FRAME_WINDOW_P (f
));
17665 /* If W is a full-width window, glyph pointers in W's current matrix
17666 have, by definition, to be the same as glyph pointers in the
17667 corresponding frame matrix. Note that frame matrices have no
17668 marginal areas (see build_frame_matrix). */
17669 window_row
= w
->current_matrix
->rows
;
17670 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17671 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17672 while (window_row
< window_row_end
)
17674 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17675 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17677 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17678 frame_row
->glyphs
[TEXT_AREA
] = start
;
17679 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17680 frame_row
->glyphs
[LAST_AREA
] = end
;
17682 /* Disable frame rows whose corresponding window rows have
17683 been disabled in try_window_id. */
17684 if (!window_row
->enabled_p
)
17685 frame_row
->enabled_p
= false;
17687 ++window_row
, ++frame_row
;
17692 /* Find the glyph row in window W containing CHARPOS. Consider all
17693 rows between START and END (not inclusive). END null means search
17694 all rows to the end of the display area of W. Value is the row
17695 containing CHARPOS or null. */
17698 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17699 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17701 struct glyph_row
*row
= start
;
17702 struct glyph_row
*best_row
= NULL
;
17703 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17706 /* If we happen to start on a header-line, skip that. */
17707 if (row
->mode_line_p
)
17710 if ((end
&& row
>= end
) || !row
->enabled_p
)
17713 last_y
= window_text_bottom_y (w
) - dy
;
17717 /* Give up if we have gone too far. */
17718 if (end
&& row
>= end
)
17720 /* This formerly returned if they were equal.
17721 I think that both quantities are of a "last plus one" type;
17722 if so, when they are equal, the row is within the screen. -- rms. */
17723 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17726 /* If it is in this row, return this row. */
17727 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17728 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17729 /* The end position of a row equals the start
17730 position of the next row. If CHARPOS is there, we
17731 would rather consider it displayed in the next
17732 line, except when this line ends in ZV. */
17733 && !row_for_charpos_p (row
, charpos
)))
17734 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17738 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17739 || (!best_row
&& !row
->continued_p
))
17741 /* In bidi-reordered rows, there could be several rows whose
17742 edges surround CHARPOS, all of these rows belonging to
17743 the same continued line. We need to find the row which
17744 fits CHARPOS the best. */
17745 for (g
= row
->glyphs
[TEXT_AREA
];
17746 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17749 if (!STRINGP (g
->object
))
17751 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17753 mindif
= eabs (g
->charpos
- charpos
);
17755 /* Exact match always wins. */
17762 else if (best_row
&& !row
->continued_p
)
17769 /* Try to redisplay window W by reusing its existing display. W's
17770 current matrix must be up to date when this function is called,
17771 i.e., window_end_valid must be true.
17775 >= 1 if successful, i.e. display has been updated
17777 1 means the changes were in front of a newline that precedes
17778 the window start, and the whole current matrix was reused
17779 2 means the changes were after the last position displayed
17780 in the window, and the whole current matrix was reused
17781 3 means portions of the current matrix were reused, while
17782 some of the screen lines were redrawn
17783 -1 if redisplay with same window start is known not to succeed
17784 0 if otherwise unsuccessful
17786 The following steps are performed:
17788 1. Find the last row in the current matrix of W that is not
17789 affected by changes at the start of current_buffer. If no such row
17792 2. Find the first row in W's current matrix that is not affected by
17793 changes at the end of current_buffer. Maybe there is no such row.
17795 3. Display lines beginning with the row + 1 found in step 1 to the
17796 row found in step 2 or, if step 2 didn't find a row, to the end of
17799 4. If cursor is not known to appear on the window, give up.
17801 5. If display stopped at the row found in step 2, scroll the
17802 display and current matrix as needed.
17804 6. Maybe display some lines at the end of W, if we must. This can
17805 happen under various circumstances, like a partially visible line
17806 becoming fully visible, or because newly displayed lines are displayed
17807 in smaller font sizes.
17809 7. Update W's window end information. */
17812 try_window_id (struct window
*w
)
17814 struct frame
*f
= XFRAME (w
->frame
);
17815 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17816 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17817 struct glyph_row
*last_unchanged_at_beg_row
;
17818 struct glyph_row
*first_unchanged_at_end_row
;
17819 struct glyph_row
*row
;
17820 struct glyph_row
*bottom_row
;
17823 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17825 struct text_pos start_pos
;
17827 int first_unchanged_at_end_vpos
= 0;
17828 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17829 struct text_pos start
;
17830 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17833 if (inhibit_try_window_id
)
17837 /* This is handy for debugging. */
17839 #define GIVE_UP(X) \
17841 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17845 #define GIVE_UP(X) return 0
17848 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17850 /* Don't use this for mini-windows because these can show
17851 messages and mini-buffers, and we don't handle that here. */
17852 if (MINI_WINDOW_P (w
))
17855 /* This flag is used to prevent redisplay optimizations. */
17856 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17859 /* This function's optimizations cannot be used if overlays have
17860 changed in the buffer displayed by the window, so give up if they
17862 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17865 /* Verify that narrowing has not changed.
17866 Also verify that we were not told to prevent redisplay optimizations.
17867 It would be nice to further
17868 reduce the number of cases where this prevents try_window_id. */
17869 if (current_buffer
->clip_changed
17870 || current_buffer
->prevent_redisplay_optimizations_p
)
17873 /* Window must either use window-based redisplay or be full width. */
17874 if (!FRAME_WINDOW_P (f
)
17875 && (!FRAME_LINE_INS_DEL_OK (f
)
17876 || !WINDOW_FULL_WIDTH_P (w
)))
17879 /* Give up if point is known NOT to appear in W. */
17880 if (PT
< CHARPOS (start
))
17883 /* Another way to prevent redisplay optimizations. */
17884 if (w
->last_modified
== 0)
17887 /* Verify that window is not hscrolled. */
17888 if (w
->hscroll
!= 0)
17891 /* Verify that display wasn't paused. */
17892 if (!w
->window_end_valid
)
17895 /* Likewise if highlighting trailing whitespace. */
17896 if (!NILP (Vshow_trailing_whitespace
))
17899 /* Can't use this if overlay arrow position and/or string have
17901 if (overlay_arrows_changed_p ())
17904 /* When word-wrap is on, adding a space to the first word of a
17905 wrapped line can change the wrap position, altering the line
17906 above it. It might be worthwhile to handle this more
17907 intelligently, but for now just redisplay from scratch. */
17908 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17911 /* Under bidi reordering, adding or deleting a character in the
17912 beginning of a paragraph, before the first strong directional
17913 character, can change the base direction of the paragraph (unless
17914 the buffer specifies a fixed paragraph direction), which will
17915 require to redisplay the whole paragraph. It might be worthwhile
17916 to find the paragraph limits and widen the range of redisplayed
17917 lines to that, but for now just give up this optimization and
17918 redisplay from scratch. */
17919 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17920 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17923 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17924 to that variable require thorough redisplay. */
17925 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17928 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17929 only if buffer has really changed. The reason is that the gap is
17930 initially at Z for freshly visited files. The code below would
17931 set end_unchanged to 0 in that case. */
17932 if (MODIFF
> SAVE_MODIFF
17933 /* This seems to happen sometimes after saving a buffer. */
17934 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17936 if (GPT
- BEG
< BEG_UNCHANGED
)
17937 BEG_UNCHANGED
= GPT
- BEG
;
17938 if (Z
- GPT
< END_UNCHANGED
)
17939 END_UNCHANGED
= Z
- GPT
;
17942 /* The position of the first and last character that has been changed. */
17943 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17944 last_changed_charpos
= Z
- END_UNCHANGED
;
17946 /* If window starts after a line end, and the last change is in
17947 front of that newline, then changes don't affect the display.
17948 This case happens with stealth-fontification. Note that although
17949 the display is unchanged, glyph positions in the matrix have to
17950 be adjusted, of course. */
17951 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17952 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17953 && ((last_changed_charpos
< CHARPOS (start
)
17954 && CHARPOS (start
) == BEGV
)
17955 || (last_changed_charpos
< CHARPOS (start
) - 1
17956 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17958 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17959 struct glyph_row
*r0
;
17961 /* Compute how many chars/bytes have been added to or removed
17962 from the buffer. */
17963 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17964 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17965 Z_delta
= Z
- Z_old
;
17966 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17968 /* Give up if PT is not in the window. Note that it already has
17969 been checked at the start of try_window_id that PT is not in
17970 front of the window start. */
17971 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17974 /* If window start is unchanged, we can reuse the whole matrix
17975 as is, after adjusting glyph positions. No need to compute
17976 the window end again, since its offset from Z hasn't changed. */
17977 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17978 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17979 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17980 /* PT must not be in a partially visible line. */
17981 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17982 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17984 /* Adjust positions in the glyph matrix. */
17985 if (Z_delta
|| Z_delta_bytes
)
17987 struct glyph_row
*r1
17988 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17989 increment_matrix_positions (w
->current_matrix
,
17990 MATRIX_ROW_VPOS (r0
, current_matrix
),
17991 MATRIX_ROW_VPOS (r1
, current_matrix
),
17992 Z_delta
, Z_delta_bytes
);
17995 /* Set the cursor. */
17996 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17998 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18003 /* Handle the case that changes are all below what is displayed in
18004 the window, and that PT is in the window. This shortcut cannot
18005 be taken if ZV is visible in the window, and text has been added
18006 there that is visible in the window. */
18007 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18008 /* ZV is not visible in the window, or there are no
18009 changes at ZV, actually. */
18010 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18011 || first_changed_charpos
== last_changed_charpos
))
18013 struct glyph_row
*r0
;
18015 /* Give up if PT is not in the window. Note that it already has
18016 been checked at the start of try_window_id that PT is not in
18017 front of the window start. */
18018 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18021 /* If window start is unchanged, we can reuse the whole matrix
18022 as is, without changing glyph positions since no text has
18023 been added/removed in front of the window end. */
18024 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18025 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18026 /* PT must not be in a partially visible line. */
18027 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18028 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18030 /* We have to compute the window end anew since text
18031 could have been added/removed after it. */
18032 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18033 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18035 /* Set the cursor. */
18036 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18038 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18043 /* Give up if window start is in the changed area.
18045 The condition used to read
18047 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18049 but why that was tested escapes me at the moment. */
18050 if (CHARPOS (start
) >= first_changed_charpos
18051 && CHARPOS (start
) <= last_changed_charpos
)
18054 /* Check that window start agrees with the start of the first glyph
18055 row in its current matrix. Check this after we know the window
18056 start is not in changed text, otherwise positions would not be
18058 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18059 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18062 /* Give up if the window ends in strings. Overlay strings
18063 at the end are difficult to handle, so don't try. */
18064 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18065 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18068 /* Compute the position at which we have to start displaying new
18069 lines. Some of the lines at the top of the window might be
18070 reusable because they are not displaying changed text. Find the
18071 last row in W's current matrix not affected by changes at the
18072 start of current_buffer. Value is null if changes start in the
18073 first line of window. */
18074 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18075 if (last_unchanged_at_beg_row
)
18077 /* Avoid starting to display in the middle of a character, a TAB
18078 for instance. This is easier than to set up the iterator
18079 exactly, and it's not a frequent case, so the additional
18080 effort wouldn't really pay off. */
18081 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18082 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18083 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18084 --last_unchanged_at_beg_row
;
18086 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18089 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18091 start_pos
= it
.current
.pos
;
18093 /* Start displaying new lines in the desired matrix at the same
18094 vpos we would use in the current matrix, i.e. below
18095 last_unchanged_at_beg_row. */
18096 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18098 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18099 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18101 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18105 /* There are no reusable lines at the start of the window.
18106 Start displaying in the first text line. */
18107 start_display (&it
, w
, start
);
18108 it
.vpos
= it
.first_vpos
;
18109 start_pos
= it
.current
.pos
;
18112 /* Find the first row that is not affected by changes at the end of
18113 the buffer. Value will be null if there is no unchanged row, in
18114 which case we must redisplay to the end of the window. delta
18115 will be set to the value by which buffer positions beginning with
18116 first_unchanged_at_end_row have to be adjusted due to text
18118 first_unchanged_at_end_row
18119 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18120 IF_DEBUG (debug_delta
= delta
);
18121 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18123 /* Set stop_pos to the buffer position up to which we will have to
18124 display new lines. If first_unchanged_at_end_row != NULL, this
18125 is the buffer position of the start of the line displayed in that
18126 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18127 that we don't stop at a buffer position. */
18129 if (first_unchanged_at_end_row
)
18131 eassert (last_unchanged_at_beg_row
== NULL
18132 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18134 /* If this is a continuation line, move forward to the next one
18135 that isn't. Changes in lines above affect this line.
18136 Caution: this may move first_unchanged_at_end_row to a row
18137 not displaying text. */
18138 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18139 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18140 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18141 < it
.last_visible_y
))
18142 ++first_unchanged_at_end_row
;
18144 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18145 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18146 >= it
.last_visible_y
))
18147 first_unchanged_at_end_row
= NULL
;
18150 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18152 first_unchanged_at_end_vpos
18153 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18154 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18157 else if (last_unchanged_at_beg_row
== NULL
)
18163 /* Either there is no unchanged row at the end, or the one we have
18164 now displays text. This is a necessary condition for the window
18165 end pos calculation at the end of this function. */
18166 eassert (first_unchanged_at_end_row
== NULL
18167 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18169 debug_last_unchanged_at_beg_vpos
18170 = (last_unchanged_at_beg_row
18171 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18173 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18175 #endif /* GLYPH_DEBUG */
18178 /* Display new lines. Set last_text_row to the last new line
18179 displayed which has text on it, i.e. might end up as being the
18180 line where the window_end_vpos is. */
18181 w
->cursor
.vpos
= -1;
18182 last_text_row
= NULL
;
18183 overlay_arrow_seen
= false;
18184 if (it
.current_y
< it
.last_visible_y
18185 && !f
->fonts_changed
18186 && (first_unchanged_at_end_row
== NULL
18187 || IT_CHARPOS (it
) < stop_pos
))
18188 it
.glyph_row
->reversed_p
= false;
18189 while (it
.current_y
< it
.last_visible_y
18190 && !f
->fonts_changed
18191 && (first_unchanged_at_end_row
== NULL
18192 || IT_CHARPOS (it
) < stop_pos
))
18194 if (display_line (&it
))
18195 last_text_row
= it
.glyph_row
- 1;
18198 if (f
->fonts_changed
)
18201 /* The redisplay iterations in display_line above could have
18202 triggered font-lock, which could have done something that
18203 invalidates IT->w window's end-point information, on which we
18204 rely below. E.g., one package, which will remain unnamed, used
18205 to install a font-lock-fontify-region-function that called
18206 bury-buffer, whose side effect is to switch the buffer displayed
18207 by IT->w, and that predictably resets IT->w's window_end_valid
18208 flag, which we already tested at the entry to this function.
18209 Amply punish such packages/modes by giving up on this
18210 optimization in those cases. */
18211 if (!w
->window_end_valid
)
18213 clear_glyph_matrix (w
->desired_matrix
);
18217 /* Compute differences in buffer positions, y-positions etc. for
18218 lines reused at the bottom of the window. Compute what we can
18220 if (first_unchanged_at_end_row
18221 /* No lines reused because we displayed everything up to the
18222 bottom of the window. */
18223 && it
.current_y
< it
.last_visible_y
)
18226 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18228 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18229 run
.current_y
= first_unchanged_at_end_row
->y
;
18230 run
.desired_y
= run
.current_y
+ dy
;
18231 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18235 delta
= delta_bytes
= dvpos
= dy
18236 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18237 first_unchanged_at_end_row
= NULL
;
18239 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18242 /* Find the cursor if not already found. We have to decide whether
18243 PT will appear on this window (it sometimes doesn't, but this is
18244 not a very frequent case.) This decision has to be made before
18245 the current matrix is altered. A value of cursor.vpos < 0 means
18246 that PT is either in one of the lines beginning at
18247 first_unchanged_at_end_row or below the window. Don't care for
18248 lines that might be displayed later at the window end; as
18249 mentioned, this is not a frequent case. */
18250 if (w
->cursor
.vpos
< 0)
18252 /* Cursor in unchanged rows at the top? */
18253 if (PT
< CHARPOS (start_pos
)
18254 && last_unchanged_at_beg_row
)
18256 row
= row_containing_pos (w
, PT
,
18257 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18258 last_unchanged_at_beg_row
+ 1, 0);
18260 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18263 /* Start from first_unchanged_at_end_row looking for PT. */
18264 else if (first_unchanged_at_end_row
)
18266 row
= row_containing_pos (w
, PT
- delta
,
18267 first_unchanged_at_end_row
, NULL
, 0);
18269 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18270 delta_bytes
, dy
, dvpos
);
18273 /* Give up if cursor was not found. */
18274 if (w
->cursor
.vpos
< 0)
18276 clear_glyph_matrix (w
->desired_matrix
);
18281 /* Don't let the cursor end in the scroll margins. */
18283 int this_scroll_margin
, cursor_height
;
18284 int frame_line_height
= default_line_pixel_height (w
);
18285 int window_total_lines
18286 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18288 this_scroll_margin
=
18289 max (0, min (scroll_margin
, window_total_lines
/ 4));
18290 this_scroll_margin
*= frame_line_height
;
18291 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18293 if ((w
->cursor
.y
< this_scroll_margin
18294 && CHARPOS (start
) > BEGV
)
18295 /* Old redisplay didn't take scroll margin into account at the bottom,
18296 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18297 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18298 ? cursor_height
+ this_scroll_margin
18299 : 1)) > it
.last_visible_y
)
18301 w
->cursor
.vpos
= -1;
18302 clear_glyph_matrix (w
->desired_matrix
);
18307 /* Scroll the display. Do it before changing the current matrix so
18308 that xterm.c doesn't get confused about where the cursor glyph is
18310 if (dy
&& run
.height
)
18314 if (FRAME_WINDOW_P (f
))
18316 FRAME_RIF (f
)->update_window_begin_hook (w
);
18317 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18318 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18319 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18323 /* Terminal frame. In this case, dvpos gives the number of
18324 lines to scroll by; dvpos < 0 means scroll up. */
18326 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18327 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18328 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18329 + WINDOW_WANTS_HEADER_LINE_P (w
)
18330 + window_internal_height (w
));
18332 #if defined (HAVE_GPM) || defined (MSDOS)
18333 x_clear_window_mouse_face (w
);
18335 /* Perform the operation on the screen. */
18338 /* Scroll last_unchanged_at_beg_row to the end of the
18339 window down dvpos lines. */
18340 set_terminal_window (f
, end
);
18342 /* On dumb terminals delete dvpos lines at the end
18343 before inserting dvpos empty lines. */
18344 if (!FRAME_SCROLL_REGION_OK (f
))
18345 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18347 /* Insert dvpos empty lines in front of
18348 last_unchanged_at_beg_row. */
18349 ins_del_lines (f
, from
, dvpos
);
18351 else if (dvpos
< 0)
18353 /* Scroll up last_unchanged_at_beg_vpos to the end of
18354 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18355 set_terminal_window (f
, end
);
18357 /* Delete dvpos lines in front of
18358 last_unchanged_at_beg_vpos. ins_del_lines will set
18359 the cursor to the given vpos and emit |dvpos| delete
18361 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18363 /* On a dumb terminal insert dvpos empty lines at the
18365 if (!FRAME_SCROLL_REGION_OK (f
))
18366 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18369 set_terminal_window (f
, 0);
18375 /* Shift reused rows of the current matrix to the right position.
18376 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18378 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18379 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18382 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18383 bottom_vpos
, dvpos
);
18384 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18387 else if (dvpos
> 0)
18389 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18390 bottom_vpos
, dvpos
);
18391 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18392 first_unchanged_at_end_vpos
+ dvpos
);
18395 /* For frame-based redisplay, make sure that current frame and window
18396 matrix are in sync with respect to glyph memory. */
18397 if (!FRAME_WINDOW_P (f
))
18398 sync_frame_with_window_matrix_rows (w
);
18400 /* Adjust buffer positions in reused rows. */
18401 if (delta
|| delta_bytes
)
18402 increment_matrix_positions (current_matrix
,
18403 first_unchanged_at_end_vpos
+ dvpos
,
18404 bottom_vpos
, delta
, delta_bytes
);
18406 /* Adjust Y positions. */
18408 shift_glyph_matrix (w
, current_matrix
,
18409 first_unchanged_at_end_vpos
+ dvpos
,
18412 if (first_unchanged_at_end_row
)
18414 first_unchanged_at_end_row
+= dvpos
;
18415 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18416 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18417 first_unchanged_at_end_row
= NULL
;
18420 /* If scrolling up, there may be some lines to display at the end of
18422 last_text_row_at_end
= NULL
;
18425 /* Scrolling up can leave for example a partially visible line
18426 at the end of the window to be redisplayed. */
18427 /* Set last_row to the glyph row in the current matrix where the
18428 window end line is found. It has been moved up or down in
18429 the matrix by dvpos. */
18430 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18431 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18433 /* If last_row is the window end line, it should display text. */
18434 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18436 /* If window end line was partially visible before, begin
18437 displaying at that line. Otherwise begin displaying with the
18438 line following it. */
18439 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18441 init_to_row_start (&it
, w
, last_row
);
18442 it
.vpos
= last_vpos
;
18443 it
.current_y
= last_row
->y
;
18447 init_to_row_end (&it
, w
, last_row
);
18448 it
.vpos
= 1 + last_vpos
;
18449 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18453 /* We may start in a continuation line. If so, we have to
18454 get the right continuation_lines_width and current_x. */
18455 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18456 it
.hpos
= it
.current_x
= 0;
18458 /* Display the rest of the lines at the window end. */
18459 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18460 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18462 /* Is it always sure that the display agrees with lines in
18463 the current matrix? I don't think so, so we mark rows
18464 displayed invalid in the current matrix by setting their
18465 enabled_p flag to false. */
18466 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18467 if (display_line (&it
))
18468 last_text_row_at_end
= it
.glyph_row
- 1;
18472 /* Update window_end_pos and window_end_vpos. */
18473 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18475 /* Window end line if one of the preserved rows from the current
18476 matrix. Set row to the last row displaying text in current
18477 matrix starting at first_unchanged_at_end_row, after
18479 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18480 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18481 first_unchanged_at_end_row
);
18482 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18483 adjust_window_ends (w
, row
, true);
18484 eassert (w
->window_end_bytepos
>= 0);
18485 IF_DEBUG (debug_method_add (w
, "A"));
18487 else if (last_text_row_at_end
)
18489 adjust_window_ends (w
, last_text_row_at_end
, false);
18490 eassert (w
->window_end_bytepos
>= 0);
18491 IF_DEBUG (debug_method_add (w
, "B"));
18493 else if (last_text_row
)
18495 /* We have displayed either to the end of the window or at the
18496 end of the window, i.e. the last row with text is to be found
18497 in the desired matrix. */
18498 adjust_window_ends (w
, last_text_row
, false);
18499 eassert (w
->window_end_bytepos
>= 0);
18501 else if (first_unchanged_at_end_row
== NULL
18502 && last_text_row
== NULL
18503 && last_text_row_at_end
== NULL
)
18505 /* Displayed to end of window, but no line containing text was
18506 displayed. Lines were deleted at the end of the window. */
18507 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18508 int vpos
= w
->window_end_vpos
;
18509 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18510 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18513 row
== NULL
&& vpos
>= first_vpos
;
18514 --vpos
, --current_row
, --desired_row
)
18516 if (desired_row
->enabled_p
)
18518 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18521 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18525 eassert (row
!= NULL
);
18526 w
->window_end_vpos
= vpos
+ 1;
18527 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18528 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18529 eassert (w
->window_end_bytepos
>= 0);
18530 IF_DEBUG (debug_method_add (w
, "C"));
18535 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18536 debug_end_vpos
= w
->window_end_vpos
));
18538 /* Record that display has not been completed. */
18539 w
->window_end_valid
= false;
18540 w
->desired_matrix
->no_scrolling_p
= true;
18548 /***********************************************************************
18549 More debugging support
18550 ***********************************************************************/
18554 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18555 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18556 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18559 /* Dump the contents of glyph matrix MATRIX on stderr.
18561 GLYPHS 0 means don't show glyph contents.
18562 GLYPHS 1 means show glyphs in short form
18563 GLYPHS > 1 means show glyphs in long form. */
18566 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18569 for (i
= 0; i
< matrix
->nrows
; ++i
)
18570 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18574 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18575 the glyph row and area where the glyph comes from. */
18578 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18580 if (glyph
->type
== CHAR_GLYPH
18581 || glyph
->type
== GLYPHLESS_GLYPH
)
18584 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18585 glyph
- row
->glyphs
[TEXT_AREA
],
18586 (glyph
->type
== CHAR_GLYPH
18590 (BUFFERP (glyph
->object
)
18592 : (STRINGP (glyph
->object
)
18594 : (NILP (glyph
->object
)
18597 glyph
->pixel_width
,
18599 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18603 glyph
->left_box_line_p
,
18604 glyph
->right_box_line_p
);
18606 else if (glyph
->type
== STRETCH_GLYPH
)
18609 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18610 glyph
- row
->glyphs
[TEXT_AREA
],
18613 (BUFFERP (glyph
->object
)
18615 : (STRINGP (glyph
->object
)
18617 : (NILP (glyph
->object
)
18620 glyph
->pixel_width
,
18624 glyph
->left_box_line_p
,
18625 glyph
->right_box_line_p
);
18627 else if (glyph
->type
== IMAGE_GLYPH
)
18630 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18631 glyph
- row
->glyphs
[TEXT_AREA
],
18634 (BUFFERP (glyph
->object
)
18636 : (STRINGP (glyph
->object
)
18638 : (NILP (glyph
->object
)
18641 glyph
->pixel_width
,
18645 glyph
->left_box_line_p
,
18646 glyph
->right_box_line_p
);
18648 else if (glyph
->type
== COMPOSITE_GLYPH
)
18651 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18652 glyph
- row
->glyphs
[TEXT_AREA
],
18655 (BUFFERP (glyph
->object
)
18657 : (STRINGP (glyph
->object
)
18659 : (NILP (glyph
->object
)
18662 glyph
->pixel_width
,
18664 if (glyph
->u
.cmp
.automatic
)
18667 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18668 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18670 glyph
->left_box_line_p
,
18671 glyph
->right_box_line_p
);
18676 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18677 GLYPHS 0 means don't show glyph contents.
18678 GLYPHS 1 means show glyphs in short form
18679 GLYPHS > 1 means show glyphs in long form. */
18682 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18686 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18687 fprintf (stderr
, "==============================================================================\n");
18689 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18690 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18692 MATRIX_ROW_START_CHARPOS (row
),
18693 MATRIX_ROW_END_CHARPOS (row
),
18694 row
->used
[TEXT_AREA
],
18695 row
->contains_overlapping_glyphs_p
,
18697 row
->truncated_on_left_p
,
18698 row
->truncated_on_right_p
,
18700 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18701 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18704 row
->ends_in_middle_of_char_p
,
18705 row
->starts_in_middle_of_char_p
,
18711 row
->visible_height
,
18714 /* The next 3 lines should align to "Start" in the header. */
18715 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18716 row
->end
.overlay_string_index
,
18717 row
->continuation_lines_width
);
18718 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18719 CHARPOS (row
->start
.string_pos
),
18720 CHARPOS (row
->end
.string_pos
));
18721 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18722 row
->end
.dpvec_index
);
18729 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18731 struct glyph
*glyph
= row
->glyphs
[area
];
18732 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18734 /* Glyph for a line end in text. */
18735 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18738 if (glyph
< glyph_end
)
18739 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18741 for (; glyph
< glyph_end
; ++glyph
)
18742 dump_glyph (row
, glyph
, area
);
18745 else if (glyphs
== 1)
18748 char s
[SHRT_MAX
+ 4];
18750 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18754 for (i
= 0; i
< row
->used
[area
]; ++i
)
18756 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18757 if (i
== row
->used
[area
] - 1
18758 && area
== TEXT_AREA
18759 && NILP (glyph
->object
)
18760 && glyph
->type
== CHAR_GLYPH
18761 && glyph
->u
.ch
== ' ')
18763 strcpy (&s
[i
], "[\\n]");
18766 else if (glyph
->type
== CHAR_GLYPH
18767 && glyph
->u
.ch
< 0x80
18768 && glyph
->u
.ch
>= ' ')
18769 s
[i
] = glyph
->u
.ch
;
18775 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18781 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18782 Sdump_glyph_matrix
, 0, 1, "p",
18783 doc
: /* Dump the current matrix of the selected window to stderr.
18784 Shows contents of glyph row structures. With non-nil
18785 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18786 glyphs in short form, otherwise show glyphs in long form.
18788 Interactively, no argument means show glyphs in short form;
18789 with numeric argument, its value is passed as the GLYPHS flag. */)
18790 (Lisp_Object glyphs
)
18792 struct window
*w
= XWINDOW (selected_window
);
18793 struct buffer
*buffer
= XBUFFER (w
->contents
);
18795 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18796 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18797 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18798 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18799 fprintf (stderr
, "=============================================\n");
18800 dump_glyph_matrix (w
->current_matrix
,
18801 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18806 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18807 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18808 Only text-mode frames have frame glyph matrices. */)
18811 struct frame
*f
= XFRAME (selected_frame
);
18813 if (f
->current_matrix
)
18814 dump_glyph_matrix (f
->current_matrix
, 1);
18816 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18821 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18822 doc
: /* Dump glyph row ROW to stderr.
18823 GLYPH 0 means don't dump glyphs.
18824 GLYPH 1 means dump glyphs in short form.
18825 GLYPH > 1 or omitted means dump glyphs in long form. */)
18826 (Lisp_Object row
, Lisp_Object glyphs
)
18828 struct glyph_matrix
*matrix
;
18831 CHECK_NUMBER (row
);
18832 matrix
= XWINDOW (selected_window
)->current_matrix
;
18834 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18835 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18837 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18842 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18843 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18844 GLYPH 0 means don't dump glyphs.
18845 GLYPH 1 means dump glyphs in short form.
18846 GLYPH > 1 or omitted means dump glyphs in long form.
18848 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18850 (Lisp_Object row
, Lisp_Object glyphs
)
18852 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18853 struct frame
*sf
= SELECTED_FRAME ();
18854 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18857 CHECK_NUMBER (row
);
18859 if (vpos
>= 0 && vpos
< m
->nrows
)
18860 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18861 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18867 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18868 doc
: /* Toggle tracing of redisplay.
18869 With ARG, turn tracing on if and only if ARG is positive. */)
18873 trace_redisplay_p
= !trace_redisplay_p
;
18876 arg
= Fprefix_numeric_value (arg
);
18877 trace_redisplay_p
= XINT (arg
) > 0;
18884 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18885 doc
: /* Like `format', but print result to stderr.
18886 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18887 (ptrdiff_t nargs
, Lisp_Object
*args
)
18889 Lisp_Object s
= Fformat (nargs
, args
);
18890 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18894 #endif /* GLYPH_DEBUG */
18898 /***********************************************************************
18899 Building Desired Matrix Rows
18900 ***********************************************************************/
18902 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18903 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18905 static struct glyph_row
*
18906 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18908 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18909 struct buffer
*buffer
= XBUFFER (w
->contents
);
18910 struct buffer
*old
= current_buffer
;
18911 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18912 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18913 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18914 const unsigned char *p
;
18917 int n_glyphs_before
;
18919 set_buffer_temp (buffer
);
18920 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18921 scratch_glyph_row
.reversed_p
= false;
18922 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18923 SET_TEXT_POS (it
.position
, 0, 0);
18925 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18927 while (p
< arrow_end
)
18929 Lisp_Object face
, ilisp
;
18931 /* Get the next character. */
18933 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18936 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18937 if (! ASCII_CHAR_P (it
.c
))
18938 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18942 /* Get its face. */
18943 ilisp
= make_number (p
- arrow_string
);
18944 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18945 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18947 /* Compute its width, get its glyphs. */
18948 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18949 SET_TEXT_POS (it
.position
, -1, -1);
18950 PRODUCE_GLYPHS (&it
);
18952 /* If this character doesn't fit any more in the line, we have
18953 to remove some glyphs. */
18954 if (it
.current_x
> it
.last_visible_x
)
18956 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18961 set_buffer_temp (old
);
18962 return it
.glyph_row
;
18966 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18967 glyphs to insert is determined by produce_special_glyphs. */
18970 insert_left_trunc_glyphs (struct it
*it
)
18972 struct it truncate_it
;
18973 struct glyph
*from
, *end
, *to
, *toend
;
18975 eassert (!FRAME_WINDOW_P (it
->f
)
18976 || (!it
->glyph_row
->reversed_p
18977 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18978 || (it
->glyph_row
->reversed_p
18979 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18981 /* Get the truncation glyphs. */
18983 truncate_it
.current_x
= 0;
18984 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18985 truncate_it
.glyph_row
= &scratch_glyph_row
;
18986 truncate_it
.area
= TEXT_AREA
;
18987 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18988 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18989 truncate_it
.object
= Qnil
;
18990 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18992 /* Overwrite glyphs from IT with truncation glyphs. */
18993 if (!it
->glyph_row
->reversed_p
)
18995 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18997 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18998 end
= from
+ tused
;
18999 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19000 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19001 if (FRAME_WINDOW_P (it
->f
))
19003 /* On GUI frames, when variable-size fonts are displayed,
19004 the truncation glyphs may need more pixels than the row's
19005 glyphs they overwrite. We overwrite more glyphs to free
19006 enough screen real estate, and enlarge the stretch glyph
19007 on the right (see display_line), if there is one, to
19008 preserve the screen position of the truncation glyphs on
19011 struct glyph
*g
= to
;
19014 /* The first glyph could be partially visible, in which case
19015 it->glyph_row->x will be negative. But we want the left
19016 truncation glyphs to be aligned at the left margin of the
19017 window, so we override the x coordinate at which the row
19019 it
->glyph_row
->x
= 0;
19020 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19022 w
+= g
->pixel_width
;
19025 if (g
- to
- tused
> 0)
19027 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19028 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19030 used
= it
->glyph_row
->used
[TEXT_AREA
];
19031 if (it
->glyph_row
->truncated_on_right_p
19032 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19033 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19036 int extra
= w
- it
->truncation_pixel_width
;
19038 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19045 /* There may be padding glyphs left over. Overwrite them too. */
19046 if (!FRAME_WINDOW_P (it
->f
))
19048 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19050 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19057 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19061 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19063 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19064 that back to front. */
19065 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19066 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19067 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19068 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19069 if (FRAME_WINDOW_P (it
->f
))
19072 struct glyph
*g
= to
;
19074 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19076 w
+= g
->pixel_width
;
19079 if (to
- g
- tused
> 0)
19081 if (it
->glyph_row
->truncated_on_right_p
19082 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19083 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19085 int extra
= w
- it
->truncation_pixel_width
;
19087 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19091 while (from
>= end
&& to
>= toend
)
19093 if (!FRAME_WINDOW_P (it
->f
))
19095 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19098 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19099 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19100 while (from
>= end
&& to
>= toend
)
19106 /* Need to free some room before prepending additional
19108 int move_by
= from
- end
+ 1;
19109 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19110 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19112 for ( ; g
>= g0
; g
--)
19114 while (from
>= end
)
19116 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19121 /* Compute the hash code for ROW. */
19123 row_hash (struct glyph_row
*row
)
19126 unsigned hashval
= 0;
19128 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19129 for (k
= 0; k
< row
->used
[area
]; ++k
)
19130 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19131 + row
->glyphs
[area
][k
].u
.val
19132 + row
->glyphs
[area
][k
].face_id
19133 + row
->glyphs
[area
][k
].padding_p
19134 + (row
->glyphs
[area
][k
].type
<< 2));
19139 /* Compute the pixel height and width of IT->glyph_row.
19141 Most of the time, ascent and height of a display line will be equal
19142 to the max_ascent and max_height values of the display iterator
19143 structure. This is not the case if
19145 1. We hit ZV without displaying anything. In this case, max_ascent
19146 and max_height will be zero.
19148 2. We have some glyphs that don't contribute to the line height.
19149 (The glyph row flag contributes_to_line_height_p is for future
19150 pixmap extensions).
19152 The first case is easily covered by using default values because in
19153 these cases, the line height does not really matter, except that it
19154 must not be zero. */
19157 compute_line_metrics (struct it
*it
)
19159 struct glyph_row
*row
= it
->glyph_row
;
19161 if (FRAME_WINDOW_P (it
->f
))
19163 int i
, min_y
, max_y
;
19165 /* The line may consist of one space only, that was added to
19166 place the cursor on it. If so, the row's height hasn't been
19168 if (row
->height
== 0)
19170 if (it
->max_ascent
+ it
->max_descent
== 0)
19171 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19172 row
->ascent
= it
->max_ascent
;
19173 row
->height
= it
->max_ascent
+ it
->max_descent
;
19174 row
->phys_ascent
= it
->max_phys_ascent
;
19175 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19176 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19179 /* Compute the width of this line. */
19180 row
->pixel_width
= row
->x
;
19181 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19182 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19184 eassert (row
->pixel_width
>= 0);
19185 eassert (row
->ascent
>= 0 && row
->height
> 0);
19187 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19188 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19190 /* If first line's physical ascent is larger than its logical
19191 ascent, use the physical ascent, and make the row taller.
19192 This makes accented characters fully visible. */
19193 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19194 && row
->phys_ascent
> row
->ascent
)
19196 row
->height
+= row
->phys_ascent
- row
->ascent
;
19197 row
->ascent
= row
->phys_ascent
;
19200 /* Compute how much of the line is visible. */
19201 row
->visible_height
= row
->height
;
19203 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19204 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19206 if (row
->y
< min_y
)
19207 row
->visible_height
-= min_y
- row
->y
;
19208 if (row
->y
+ row
->height
> max_y
)
19209 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19213 row
->pixel_width
= row
->used
[TEXT_AREA
];
19214 if (row
->continued_p
)
19215 row
->pixel_width
-= it
->continuation_pixel_width
;
19216 else if (row
->truncated_on_right_p
)
19217 row
->pixel_width
-= it
->truncation_pixel_width
;
19218 row
->ascent
= row
->phys_ascent
= 0;
19219 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19220 row
->extra_line_spacing
= 0;
19223 /* Compute a hash code for this row. */
19224 row
->hash
= row_hash (row
);
19226 it
->max_ascent
= it
->max_descent
= 0;
19227 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19231 /* Append one space to the glyph row of iterator IT if doing a
19232 window-based redisplay. The space has the same face as
19233 IT->face_id. Value is true if a space was added.
19235 This function is called to make sure that there is always one glyph
19236 at the end of a glyph row that the cursor can be set on under
19237 window-systems. (If there weren't such a glyph we would not know
19238 how wide and tall a box cursor should be displayed).
19240 At the same time this space let's a nicely handle clearing to the
19241 end of the line if the row ends in italic text. */
19244 append_space_for_newline (struct it
*it
, bool default_face_p
)
19246 if (FRAME_WINDOW_P (it
->f
))
19248 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19250 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19251 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19253 /* Save some values that must not be changed.
19254 Must save IT->c and IT->len because otherwise
19255 ITERATOR_AT_END_P wouldn't work anymore after
19256 append_space_for_newline has been called. */
19257 enum display_element_type saved_what
= it
->what
;
19258 int saved_c
= it
->c
, saved_len
= it
->len
;
19259 int saved_char_to_display
= it
->char_to_display
;
19260 int saved_x
= it
->current_x
;
19261 int saved_face_id
= it
->face_id
;
19262 bool saved_box_end
= it
->end_of_box_run_p
;
19263 struct text_pos saved_pos
;
19264 Lisp_Object saved_object
;
19268 saved_object
= it
->object
;
19269 saved_pos
= it
->position
;
19271 it
->what
= IT_CHARACTER
;
19272 memset (&it
->position
, 0, sizeof it
->position
);
19274 it
->c
= it
->char_to_display
= ' ';
19277 /* If the default face was remapped, be sure to use the
19278 remapped face for the appended newline. */
19279 if (default_face_p
)
19280 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19281 else if (it
->face_before_selective_p
)
19282 it
->face_id
= it
->saved_face_id
;
19283 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19284 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19285 /* In R2L rows, we will prepend a stretch glyph that will
19286 have the end_of_box_run_p flag set for it, so there's no
19287 need for the appended newline glyph to have that flag
19289 if (it
->glyph_row
->reversed_p
19290 /* But if the appended newline glyph goes all the way to
19291 the end of the row, there will be no stretch glyph,
19292 so leave the box flag set. */
19293 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19294 it
->end_of_box_run_p
= false;
19296 PRODUCE_GLYPHS (it
);
19298 #ifdef HAVE_WINDOW_SYSTEM
19299 /* Make sure this space glyph has the right ascent and
19300 descent values, or else cursor at end of line will look
19301 funny, and height of empty lines will be incorrect. */
19302 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19303 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19306 Lisp_Object height
, total_height
;
19307 int extra_line_spacing
= it
->extra_line_spacing
;
19308 int boff
= font
->baseline_offset
;
19310 if (font
->vertical_centering
)
19311 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19313 it
->object
= saved_object
; /* get_it_property needs this */
19314 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19315 /* Must do a subset of line height processing from
19316 x_produce_glyph for newline characters. */
19317 height
= get_it_property (it
, Qline_height
);
19319 && CONSP (XCDR (height
))
19320 && NILP (XCDR (XCDR (height
))))
19322 total_height
= XCAR (XCDR (height
));
19323 height
= XCAR (height
);
19326 total_height
= Qnil
;
19327 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19329 if (it
->override_ascent
>= 0)
19331 it
->ascent
= it
->override_ascent
;
19332 it
->descent
= it
->override_descent
;
19333 boff
= it
->override_boff
;
19335 if (EQ (height
, Qt
))
19336 extra_line_spacing
= 0;
19339 Lisp_Object spacing
;
19341 it
->phys_ascent
= it
->ascent
;
19342 it
->phys_descent
= it
->descent
;
19344 && XINT (height
) > it
->ascent
+ it
->descent
)
19345 it
->ascent
= XINT (height
) - it
->descent
;
19347 if (!NILP (total_height
))
19348 spacing
= calc_line_height_property (it
, total_height
, font
,
19352 spacing
= get_it_property (it
, Qline_spacing
);
19353 spacing
= calc_line_height_property (it
, spacing
, font
,
19356 if (INTEGERP (spacing
))
19358 extra_line_spacing
= XINT (spacing
);
19359 if (!NILP (total_height
))
19360 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19363 if (extra_line_spacing
> 0)
19365 it
->descent
+= extra_line_spacing
;
19366 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19367 it
->max_extra_line_spacing
= extra_line_spacing
;
19369 it
->max_ascent
= it
->ascent
;
19370 it
->max_descent
= it
->descent
;
19371 /* Make sure compute_line_metrics recomputes the row height. */
19372 it
->glyph_row
->height
= 0;
19375 g
->ascent
= it
->max_ascent
;
19376 g
->descent
= it
->max_descent
;
19379 it
->override_ascent
= -1;
19380 it
->constrain_row_ascent_descent_p
= false;
19381 it
->current_x
= saved_x
;
19382 it
->object
= saved_object
;
19383 it
->position
= saved_pos
;
19384 it
->what
= saved_what
;
19385 it
->face_id
= saved_face_id
;
19386 it
->len
= saved_len
;
19388 it
->char_to_display
= saved_char_to_display
;
19389 it
->end_of_box_run_p
= saved_box_end
;
19398 /* Extend the face of the last glyph in the text area of IT->glyph_row
19399 to the end of the display line. Called from display_line. If the
19400 glyph row is empty, add a space glyph to it so that we know the
19401 face to draw. Set the glyph row flag fill_line_p. If the glyph
19402 row is R2L, prepend a stretch glyph to cover the empty space to the
19403 left of the leftmost glyph. */
19406 extend_face_to_end_of_line (struct it
*it
)
19408 struct face
*face
, *default_face
;
19409 struct frame
*f
= it
->f
;
19411 /* If line is already filled, do nothing. Non window-system frames
19412 get a grace of one more ``pixel'' because their characters are
19413 1-``pixel'' wide, so they hit the equality too early. This grace
19414 is needed only for R2L rows that are not continued, to produce
19415 one extra blank where we could display the cursor. */
19416 if ((it
->current_x
>= it
->last_visible_x
19417 + (!FRAME_WINDOW_P (f
)
19418 && it
->glyph_row
->reversed_p
19419 && !it
->glyph_row
->continued_p
))
19420 /* If the window has display margins, we will need to extend
19421 their face even if the text area is filled. */
19422 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19423 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19426 /* The default face, possibly remapped. */
19427 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19429 /* Face extension extends the background and box of IT->face_id
19430 to the end of the line. If the background equals the background
19431 of the frame, we don't have to do anything. */
19432 if (it
->face_before_selective_p
)
19433 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19435 face
= FACE_FROM_ID (f
, it
->face_id
);
19437 if (FRAME_WINDOW_P (f
)
19438 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19439 && face
->box
== FACE_NO_BOX
19440 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19441 #ifdef HAVE_WINDOW_SYSTEM
19444 && !it
->glyph_row
->reversed_p
)
19447 /* Set the glyph row flag indicating that the face of the last glyph
19448 in the text area has to be drawn to the end of the text area. */
19449 it
->glyph_row
->fill_line_p
= true;
19451 /* If current character of IT is not ASCII, make sure we have the
19452 ASCII face. This will be automatically undone the next time
19453 get_next_display_element returns a multibyte character. Note
19454 that the character will always be single byte in unibyte
19456 if (!ASCII_CHAR_P (it
->c
))
19458 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19461 if (FRAME_WINDOW_P (f
))
19463 /* If the row is empty, add a space with the current face of IT,
19464 so that we know which face to draw. */
19465 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19467 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19468 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19469 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19471 /* Mode line and the header line don't have margins, and
19472 likewise the frame's tool-bar window, if there is any. */
19473 if (!(it
->glyph_row
->mode_line_p
19474 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19475 || (WINDOWP (f
->tool_bar_window
)
19476 && it
->w
== XWINDOW (f
->tool_bar_window
))
19480 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19481 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19483 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19484 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19486 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19488 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19489 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19491 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19492 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19494 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19497 #ifdef HAVE_WINDOW_SYSTEM
19498 if (it
->glyph_row
->reversed_p
)
19500 /* Prepend a stretch glyph to the row, such that the
19501 rightmost glyph will be drawn flushed all the way to the
19502 right margin of the window. The stretch glyph that will
19503 occupy the empty space, if any, to the left of the
19505 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19506 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19507 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19509 int row_width
, stretch_ascent
, stretch_width
;
19510 struct text_pos saved_pos
;
19512 bool saved_avoid_cursor
, saved_box_start
;
19514 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19515 row_width
+= g
->pixel_width
;
19517 /* FIXME: There are various minor display glitches in R2L
19518 rows when only one of the fringes is missing. The
19519 strange condition below produces the least bad effect. */
19520 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19521 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19522 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19523 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19525 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19526 stretch_width
-= row_width
;
19528 if (stretch_width
> 0)
19531 (((it
->ascent
+ it
->descent
)
19532 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19533 saved_pos
= it
->position
;
19534 memset (&it
->position
, 0, sizeof it
->position
);
19535 saved_avoid_cursor
= it
->avoid_cursor_p
;
19536 it
->avoid_cursor_p
= true;
19537 saved_face_id
= it
->face_id
;
19538 saved_box_start
= it
->start_of_box_run_p
;
19539 /* The last row's stretch glyph should get the default
19540 face, to avoid painting the rest of the window with
19541 the region face, if the region ends at ZV. */
19542 if (it
->glyph_row
->ends_at_zv_p
)
19543 it
->face_id
= default_face
->id
;
19545 it
->face_id
= face
->id
;
19546 it
->start_of_box_run_p
= false;
19547 append_stretch_glyph (it
, Qnil
, stretch_width
,
19548 it
->ascent
+ it
->descent
, stretch_ascent
);
19549 it
->position
= saved_pos
;
19550 it
->avoid_cursor_p
= saved_avoid_cursor
;
19551 it
->face_id
= saved_face_id
;
19552 it
->start_of_box_run_p
= saved_box_start
;
19554 /* If stretch_width comes out negative, it means that the
19555 last glyph is only partially visible. In R2L rows, we
19556 want the leftmost glyph to be partially visible, so we
19557 need to give the row the corresponding left offset. */
19558 if (stretch_width
< 0)
19559 it
->glyph_row
->x
= stretch_width
;
19561 #endif /* HAVE_WINDOW_SYSTEM */
19565 /* Save some values that must not be changed. */
19566 int saved_x
= it
->current_x
;
19567 struct text_pos saved_pos
;
19568 Lisp_Object saved_object
;
19569 enum display_element_type saved_what
= it
->what
;
19570 int saved_face_id
= it
->face_id
;
19572 saved_object
= it
->object
;
19573 saved_pos
= it
->position
;
19575 it
->what
= IT_CHARACTER
;
19576 memset (&it
->position
, 0, sizeof it
->position
);
19578 it
->c
= it
->char_to_display
= ' ';
19581 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19582 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19583 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19584 && !it
->glyph_row
->mode_line_p
19585 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19587 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19588 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19590 for (it
->current_x
= 0; g
< e
; g
++)
19591 it
->current_x
+= g
->pixel_width
;
19593 it
->area
= LEFT_MARGIN_AREA
;
19594 it
->face_id
= default_face
->id
;
19595 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19596 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19598 PRODUCE_GLYPHS (it
);
19599 /* term.c:produce_glyphs advances it->current_x only for
19601 it
->current_x
+= it
->pixel_width
;
19604 it
->current_x
= saved_x
;
19605 it
->area
= TEXT_AREA
;
19608 /* The last row's blank glyphs should get the default face, to
19609 avoid painting the rest of the window with the region face,
19610 if the region ends at ZV. */
19611 if (it
->glyph_row
->ends_at_zv_p
)
19612 it
->face_id
= default_face
->id
;
19614 it
->face_id
= face
->id
;
19615 PRODUCE_GLYPHS (it
);
19617 while (it
->current_x
<= it
->last_visible_x
)
19618 PRODUCE_GLYPHS (it
);
19620 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19621 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19622 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19623 && !it
->glyph_row
->mode_line_p
19624 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19626 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19627 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19629 for ( ; g
< e
; g
++)
19630 it
->current_x
+= g
->pixel_width
;
19632 it
->area
= RIGHT_MARGIN_AREA
;
19633 it
->face_id
= default_face
->id
;
19634 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19635 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19637 PRODUCE_GLYPHS (it
);
19638 it
->current_x
+= it
->pixel_width
;
19641 it
->area
= TEXT_AREA
;
19644 /* Don't count these blanks really. It would let us insert a left
19645 truncation glyph below and make us set the cursor on them, maybe. */
19646 it
->current_x
= saved_x
;
19647 it
->object
= saved_object
;
19648 it
->position
= saved_pos
;
19649 it
->what
= saved_what
;
19650 it
->face_id
= saved_face_id
;
19655 /* Value is true if text starting at CHARPOS in current_buffer is
19656 trailing whitespace. */
19659 trailing_whitespace_p (ptrdiff_t charpos
)
19661 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19664 while (bytepos
< ZV_BYTE
19665 && (c
= FETCH_CHAR (bytepos
),
19666 c
== ' ' || c
== '\t'))
19669 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19671 if (bytepos
!= PT_BYTE
)
19678 /* Highlight trailing whitespace, if any, in ROW. */
19681 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19683 int used
= row
->used
[TEXT_AREA
];
19687 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19688 struct glyph
*glyph
= start
+ used
- 1;
19690 if (row
->reversed_p
)
19692 /* Right-to-left rows need to be processed in the opposite
19693 direction, so swap the edge pointers. */
19695 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19698 /* Skip over glyphs inserted to display the cursor at the
19699 end of a line, for extending the face of the last glyph
19700 to the end of the line on terminals, and for truncation
19701 and continuation glyphs. */
19702 if (!row
->reversed_p
)
19704 while (glyph
>= start
19705 && glyph
->type
== CHAR_GLYPH
19706 && NILP (glyph
->object
))
19711 while (glyph
<= start
19712 && glyph
->type
== CHAR_GLYPH
19713 && NILP (glyph
->object
))
19717 /* If last glyph is a space or stretch, and it's trailing
19718 whitespace, set the face of all trailing whitespace glyphs in
19719 IT->glyph_row to `trailing-whitespace'. */
19720 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19721 && BUFFERP (glyph
->object
)
19722 && (glyph
->type
== STRETCH_GLYPH
19723 || (glyph
->type
== CHAR_GLYPH
19724 && glyph
->u
.ch
== ' '))
19725 && trailing_whitespace_p (glyph
->charpos
))
19727 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19731 if (!row
->reversed_p
)
19733 while (glyph
>= start
19734 && BUFFERP (glyph
->object
)
19735 && (glyph
->type
== STRETCH_GLYPH
19736 || (glyph
->type
== CHAR_GLYPH
19737 && glyph
->u
.ch
== ' ')))
19738 (glyph
--)->face_id
= face_id
;
19742 while (glyph
<= start
19743 && BUFFERP (glyph
->object
)
19744 && (glyph
->type
== STRETCH_GLYPH
19745 || (glyph
->type
== CHAR_GLYPH
19746 && glyph
->u
.ch
== ' ')))
19747 (glyph
++)->face_id
= face_id
;
19754 /* Value is true if glyph row ROW should be
19755 considered to hold the buffer position CHARPOS. */
19758 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19760 bool result
= true;
19762 if (charpos
== CHARPOS (row
->end
.pos
)
19763 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19765 /* Suppose the row ends on a string.
19766 Unless the row is continued, that means it ends on a newline
19767 in the string. If it's anything other than a display string
19768 (e.g., a before-string from an overlay), we don't want the
19769 cursor there. (This heuristic seems to give the optimal
19770 behavior for the various types of multi-line strings.)
19771 One exception: if the string has `cursor' property on one of
19772 its characters, we _do_ want the cursor there. */
19773 if (CHARPOS (row
->end
.string_pos
) >= 0)
19775 if (row
->continued_p
)
19779 /* Check for `display' property. */
19780 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19781 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19782 struct glyph
*glyph
;
19785 for (glyph
= end
; glyph
>= beg
; --glyph
)
19786 if (STRINGP (glyph
->object
))
19789 = Fget_char_property (make_number (charpos
),
19793 && display_prop_string_p (prop
, glyph
->object
));
19794 /* If there's a `cursor' property on one of the
19795 string's characters, this row is a cursor row,
19796 even though this is not a display string. */
19799 Lisp_Object s
= glyph
->object
;
19801 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19803 ptrdiff_t gpos
= glyph
->charpos
;
19805 if (!NILP (Fget_char_property (make_number (gpos
),
19817 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19819 /* If the row ends in middle of a real character,
19820 and the line is continued, we want the cursor here.
19821 That's because CHARPOS (ROW->end.pos) would equal
19822 PT if PT is before the character. */
19823 if (!row
->ends_in_ellipsis_p
)
19824 result
= row
->continued_p
;
19826 /* If the row ends in an ellipsis, then
19827 CHARPOS (ROW->end.pos) will equal point after the
19828 invisible text. We want that position to be displayed
19829 after the ellipsis. */
19832 /* If the row ends at ZV, display the cursor at the end of that
19833 row instead of at the start of the row below. */
19835 result
= row
->ends_at_zv_p
;
19841 /* Value is true if glyph row ROW should be
19842 used to hold the cursor. */
19845 cursor_row_p (struct glyph_row
*row
)
19847 return row_for_charpos_p (row
, PT
);
19852 /* Push the property PROP so that it will be rendered at the current
19853 position in IT. Return true if PROP was successfully pushed, false
19854 otherwise. Called from handle_line_prefix to handle the
19855 `line-prefix' and `wrap-prefix' properties. */
19858 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19860 struct text_pos pos
=
19861 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19863 eassert (it
->method
== GET_FROM_BUFFER
19864 || it
->method
== GET_FROM_DISPLAY_VECTOR
19865 || it
->method
== GET_FROM_STRING
19866 || it
->method
== GET_FROM_IMAGE
);
19868 /* We need to save the current buffer/string position, so it will be
19869 restored by pop_it, because iterate_out_of_display_property
19870 depends on that being set correctly, but some situations leave
19871 it->position not yet set when this function is called. */
19872 push_it (it
, &pos
);
19874 if (STRINGP (prop
))
19876 if (SCHARS (prop
) == 0)
19883 it
->string_from_prefix_prop_p
= true;
19884 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19885 it
->current
.overlay_string_index
= -1;
19886 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19887 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19888 it
->method
= GET_FROM_STRING
;
19889 it
->stop_charpos
= 0;
19891 it
->base_level_stop
= 0;
19893 /* Force paragraph direction to be that of the parent
19895 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19896 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19898 it
->paragraph_embedding
= L2R
;
19900 /* Set up the bidi iterator for this display string. */
19903 it
->bidi_it
.string
.lstring
= it
->string
;
19904 it
->bidi_it
.string
.s
= NULL
;
19905 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19906 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19907 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19908 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19909 it
->bidi_it
.w
= it
->w
;
19910 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19913 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19915 it
->method
= GET_FROM_STRETCH
;
19918 #ifdef HAVE_WINDOW_SYSTEM
19919 else if (IMAGEP (prop
))
19921 it
->what
= IT_IMAGE
;
19922 it
->image_id
= lookup_image (it
->f
, prop
);
19923 it
->method
= GET_FROM_IMAGE
;
19925 #endif /* HAVE_WINDOW_SYSTEM */
19928 pop_it (it
); /* bogus display property, give up */
19935 /* Return the character-property PROP at the current position in IT. */
19938 get_it_property (struct it
*it
, Lisp_Object prop
)
19940 Lisp_Object position
, object
= it
->object
;
19942 if (STRINGP (object
))
19943 position
= make_number (IT_STRING_CHARPOS (*it
));
19944 else if (BUFFERP (object
))
19946 position
= make_number (IT_CHARPOS (*it
));
19947 object
= it
->window
;
19952 return Fget_char_property (position
, prop
, object
);
19955 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19958 handle_line_prefix (struct it
*it
)
19960 Lisp_Object prefix
;
19962 if (it
->continuation_lines_width
> 0)
19964 prefix
= get_it_property (it
, Qwrap_prefix
);
19966 prefix
= Vwrap_prefix
;
19970 prefix
= get_it_property (it
, Qline_prefix
);
19972 prefix
= Vline_prefix
;
19974 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19976 /* If the prefix is wider than the window, and we try to wrap
19977 it, it would acquire its own wrap prefix, and so on till the
19978 iterator stack overflows. So, don't wrap the prefix. */
19979 it
->line_wrap
= TRUNCATE
;
19980 it
->avoid_cursor_p
= true;
19986 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19987 only for R2L lines from display_line and display_string, when they
19988 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19989 the line/string needs to be continued on the next glyph row. */
19991 unproduce_glyphs (struct it
*it
, int n
)
19993 struct glyph
*glyph
, *end
;
19995 eassert (it
->glyph_row
);
19996 eassert (it
->glyph_row
->reversed_p
);
19997 eassert (it
->area
== TEXT_AREA
);
19998 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
20000 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
20001 n
= it
->glyph_row
->used
[TEXT_AREA
];
20002 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
20003 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
20004 for ( ; glyph
< end
; glyph
++)
20005 glyph
[-n
] = *glyph
;
20008 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20009 and ROW->maxpos. */
20011 find_row_edges (struct it
*it
, struct glyph_row
*row
,
20012 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
20013 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
20015 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20016 lines' rows is implemented for bidi-reordered rows. */
20018 /* ROW->minpos is the value of min_pos, the minimal buffer position
20019 we have in ROW, or ROW->start.pos if that is smaller. */
20020 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20021 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20023 /* We didn't find buffer positions smaller than ROW->start, or
20024 didn't find _any_ valid buffer positions in any of the glyphs,
20025 so we must trust the iterator's computed positions. */
20026 row
->minpos
= row
->start
.pos
;
20029 max_pos
= CHARPOS (it
->current
.pos
);
20030 max_bpos
= BYTEPOS (it
->current
.pos
);
20033 /* Here are the various use-cases for ending the row, and the
20034 corresponding values for ROW->maxpos:
20036 Line ends in a newline from buffer eol_pos + 1
20037 Line is continued from buffer max_pos + 1
20038 Line is truncated on right it->current.pos
20039 Line ends in a newline from string max_pos + 1(*)
20040 (*) + 1 only when line ends in a forward scan
20041 Line is continued from string max_pos
20042 Line is continued from display vector max_pos
20043 Line is entirely from a string min_pos == max_pos
20044 Line is entirely from a display vector min_pos == max_pos
20045 Line that ends at ZV ZV
20047 If you discover other use-cases, please add them here as
20049 if (row
->ends_at_zv_p
)
20050 row
->maxpos
= it
->current
.pos
;
20051 else if (row
->used
[TEXT_AREA
])
20053 bool seen_this_string
= false;
20054 struct glyph_row
*r1
= row
- 1;
20056 /* Did we see the same display string on the previous row? */
20057 if (STRINGP (it
->object
)
20058 /* this is not the first row */
20059 && row
> it
->w
->desired_matrix
->rows
20060 /* previous row is not the header line */
20061 && !r1
->mode_line_p
20062 /* previous row also ends in a newline from a string */
20063 && r1
->ends_in_newline_from_string_p
)
20065 struct glyph
*start
, *end
;
20067 /* Search for the last glyph of the previous row that came
20068 from buffer or string. Depending on whether the row is
20069 L2R or R2L, we need to process it front to back or the
20070 other way round. */
20071 if (!r1
->reversed_p
)
20073 start
= r1
->glyphs
[TEXT_AREA
];
20074 end
= start
+ r1
->used
[TEXT_AREA
];
20075 /* Glyphs inserted by redisplay have nil as their object. */
20077 && NILP ((end
- 1)->object
)
20078 && (end
- 1)->charpos
<= 0)
20082 if (EQ ((end
- 1)->object
, it
->object
))
20083 seen_this_string
= true;
20086 /* If all the glyphs of the previous row were inserted
20087 by redisplay, it means the previous row was
20088 produced from a single newline, which is only
20089 possible if that newline came from the same string
20090 as the one which produced this ROW. */
20091 seen_this_string
= true;
20095 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20096 start
= end
+ r1
->used
[TEXT_AREA
];
20098 && NILP ((end
+ 1)->object
)
20099 && (end
+ 1)->charpos
<= 0)
20103 if (EQ ((end
+ 1)->object
, it
->object
))
20104 seen_this_string
= true;
20107 seen_this_string
= true;
20110 /* Take note of each display string that covers a newline only
20111 once, the first time we see it. This is for when a display
20112 string includes more than one newline in it. */
20113 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20115 /* If we were scanning the buffer forward when we displayed
20116 the string, we want to account for at least one buffer
20117 position that belongs to this row (position covered by
20118 the display string), so that cursor positioning will
20119 consider this row as a candidate when point is at the end
20120 of the visual line represented by this row. This is not
20121 required when scanning back, because max_pos will already
20122 have a much larger value. */
20123 if (CHARPOS (row
->end
.pos
) > max_pos
)
20124 INC_BOTH (max_pos
, max_bpos
);
20125 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20127 else if (CHARPOS (it
->eol_pos
) > 0)
20128 SET_TEXT_POS (row
->maxpos
,
20129 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20130 else if (row
->continued_p
)
20132 /* If max_pos is different from IT's current position, it
20133 means IT->method does not belong to the display element
20134 at max_pos. However, it also means that the display
20135 element at max_pos was displayed in its entirety on this
20136 line, which is equivalent to saying that the next line
20137 starts at the next buffer position. */
20138 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20139 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20142 INC_BOTH (max_pos
, max_bpos
);
20143 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20146 else if (row
->truncated_on_right_p
)
20147 /* display_line already called reseat_at_next_visible_line_start,
20148 which puts the iterator at the beginning of the next line, in
20149 the logical order. */
20150 row
->maxpos
= it
->current
.pos
;
20151 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20152 /* A line that is entirely from a string/image/stretch... */
20153 row
->maxpos
= row
->minpos
;
20158 row
->maxpos
= it
->current
.pos
;
20161 /* Construct the glyph row IT->glyph_row in the desired matrix of
20162 IT->w from text at the current position of IT. See dispextern.h
20163 for an overview of struct it. Value is true if
20164 IT->glyph_row displays text, as opposed to a line displaying ZV
20168 display_line (struct it
*it
)
20170 struct glyph_row
*row
= it
->glyph_row
;
20171 Lisp_Object overlay_arrow_string
;
20173 void *wrap_data
= NULL
;
20174 bool may_wrap
= false;
20175 int wrap_x
IF_LINT (= 0);
20176 int wrap_row_used
= -1;
20177 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20178 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20179 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20180 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20181 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20183 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20184 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20185 bool pending_handle_line_prefix
= false;
20187 /* We always start displaying at hpos zero even if hscrolled. */
20188 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20190 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20191 >= it
->w
->desired_matrix
->nrows
)
20193 it
->w
->nrows_scale_factor
++;
20194 it
->f
->fonts_changed
= true;
20198 /* Clear the result glyph row and enable it. */
20199 prepare_desired_row (it
->w
, row
, false);
20201 row
->y
= it
->current_y
;
20202 row
->start
= it
->start
;
20203 row
->continuation_lines_width
= it
->continuation_lines_width
;
20204 row
->displays_text_p
= true;
20205 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20206 it
->starts_in_middle_of_char_p
= false;
20208 /* Arrange the overlays nicely for our purposes. Usually, we call
20209 display_line on only one line at a time, in which case this
20210 can't really hurt too much, or we call it on lines which appear
20211 one after another in the buffer, in which case all calls to
20212 recenter_overlay_lists but the first will be pretty cheap. */
20213 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20215 /* Move over display elements that are not visible because we are
20216 hscrolled. This may stop at an x-position < IT->first_visible_x
20217 if the first glyph is partially visible or if we hit a line end. */
20218 if (it
->current_x
< it
->first_visible_x
)
20220 enum move_it_result move_result
;
20222 this_line_min_pos
= row
->start
.pos
;
20223 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20224 MOVE_TO_POS
| MOVE_TO_X
);
20225 /* If we are under a large hscroll, move_it_in_display_line_to
20226 could hit the end of the line without reaching
20227 it->first_visible_x. Pretend that we did reach it. This is
20228 especially important on a TTY, where we will call
20229 extend_face_to_end_of_line, which needs to know how many
20230 blank glyphs to produce. */
20231 if (it
->current_x
< it
->first_visible_x
20232 && (move_result
== MOVE_NEWLINE_OR_CR
20233 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20234 it
->current_x
= it
->first_visible_x
;
20236 /* Record the smallest positions seen while we moved over
20237 display elements that are not visible. This is needed by
20238 redisplay_internal for optimizing the case where the cursor
20239 stays inside the same line. The rest of this function only
20240 considers positions that are actually displayed, so
20241 RECORD_MAX_MIN_POS will not otherwise record positions that
20242 are hscrolled to the left of the left edge of the window. */
20243 min_pos
= CHARPOS (this_line_min_pos
);
20244 min_bpos
= BYTEPOS (this_line_min_pos
);
20246 else if (it
->area
== TEXT_AREA
)
20248 /* We only do this when not calling move_it_in_display_line_to
20249 above, because that function calls itself handle_line_prefix. */
20250 handle_line_prefix (it
);
20254 /* Line-prefix and wrap-prefix are always displayed in the text
20255 area. But if this is the first call to display_line after
20256 init_iterator, the iterator might have been set up to write
20257 into a marginal area, e.g. if the line begins with some
20258 display property that writes to the margins. So we need to
20259 wait with the call to handle_line_prefix until whatever
20260 writes to the margin has done its job. */
20261 pending_handle_line_prefix
= true;
20264 /* Get the initial row height. This is either the height of the
20265 text hscrolled, if there is any, or zero. */
20266 row
->ascent
= it
->max_ascent
;
20267 row
->height
= it
->max_ascent
+ it
->max_descent
;
20268 row
->phys_ascent
= it
->max_phys_ascent
;
20269 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20270 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20272 /* Utility macro to record max and min buffer positions seen until now. */
20273 #define RECORD_MAX_MIN_POS(IT) \
20276 bool composition_p \
20277 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20278 ptrdiff_t current_pos = \
20279 composition_p ? (IT)->cmp_it.charpos \
20280 : IT_CHARPOS (*(IT)); \
20281 ptrdiff_t current_bpos = \
20282 composition_p ? CHAR_TO_BYTE (current_pos) \
20283 : IT_BYTEPOS (*(IT)); \
20284 if (current_pos < min_pos) \
20286 min_pos = current_pos; \
20287 min_bpos = current_bpos; \
20289 if (IT_CHARPOS (*it) > max_pos) \
20291 max_pos = IT_CHARPOS (*it); \
20292 max_bpos = IT_BYTEPOS (*it); \
20297 /* Loop generating characters. The loop is left with IT on the next
20298 character to display. */
20301 int n_glyphs_before
, hpos_before
, x_before
;
20303 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20305 /* Retrieve the next thing to display. Value is false if end of
20307 if (!get_next_display_element (it
))
20309 /* Maybe add a space at the end of this line that is used to
20310 display the cursor there under X. Set the charpos of the
20311 first glyph of blank lines not corresponding to any text
20313 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20314 row
->exact_window_width_line_p
= true;
20315 else if ((append_space_for_newline (it
, true)
20316 && row
->used
[TEXT_AREA
] == 1)
20317 || row
->used
[TEXT_AREA
] == 0)
20319 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20320 row
->displays_text_p
= false;
20322 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20323 && (!MINI_WINDOW_P (it
->w
)
20324 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20325 row
->indicate_empty_line_p
= true;
20328 it
->continuation_lines_width
= 0;
20329 row
->ends_at_zv_p
= true;
20330 /* A row that displays right-to-left text must always have
20331 its last face extended all the way to the end of line,
20332 even if this row ends in ZV, because we still write to
20333 the screen left to right. We also need to extend the
20334 last face if the default face is remapped to some
20335 different face, otherwise the functions that clear
20336 portions of the screen will clear with the default face's
20337 background color. */
20338 if (row
->reversed_p
20339 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20340 extend_face_to_end_of_line (it
);
20344 /* Now, get the metrics of what we want to display. This also
20345 generates glyphs in `row' (which is IT->glyph_row). */
20346 n_glyphs_before
= row
->used
[TEXT_AREA
];
20349 /* Remember the line height so far in case the next element doesn't
20350 fit on the line. */
20351 if (it
->line_wrap
!= TRUNCATE
)
20353 ascent
= it
->max_ascent
;
20354 descent
= it
->max_descent
;
20355 phys_ascent
= it
->max_phys_ascent
;
20356 phys_descent
= it
->max_phys_descent
;
20358 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20360 if (IT_DISPLAYING_WHITESPACE (it
))
20364 SAVE_IT (wrap_it
, *it
, wrap_data
);
20366 wrap_row_used
= row
->used
[TEXT_AREA
];
20367 wrap_row_ascent
= row
->ascent
;
20368 wrap_row_height
= row
->height
;
20369 wrap_row_phys_ascent
= row
->phys_ascent
;
20370 wrap_row_phys_height
= row
->phys_height
;
20371 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20372 wrap_row_min_pos
= min_pos
;
20373 wrap_row_min_bpos
= min_bpos
;
20374 wrap_row_max_pos
= max_pos
;
20375 wrap_row_max_bpos
= max_bpos
;
20381 PRODUCE_GLYPHS (it
);
20383 /* If this display element was in marginal areas, continue with
20385 if (it
->area
!= TEXT_AREA
)
20387 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20388 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20389 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20390 row
->phys_height
= max (row
->phys_height
,
20391 it
->max_phys_ascent
+ it
->max_phys_descent
);
20392 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20393 it
->max_extra_line_spacing
);
20394 set_iterator_to_next (it
, true);
20395 /* If we didn't handle the line/wrap prefix above, and the
20396 call to set_iterator_to_next just switched to TEXT_AREA,
20397 process the prefix now. */
20398 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20400 pending_handle_line_prefix
= false;
20401 handle_line_prefix (it
);
20406 /* Does the display element fit on the line? If we truncate
20407 lines, we should draw past the right edge of the window. If
20408 we don't truncate, we want to stop so that we can display the
20409 continuation glyph before the right margin. If lines are
20410 continued, there are two possible strategies for characters
20411 resulting in more than 1 glyph (e.g. tabs): Display as many
20412 glyphs as possible in this line and leave the rest for the
20413 continuation line, or display the whole element in the next
20414 line. Original redisplay did the former, so we do it also. */
20415 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20416 hpos_before
= it
->hpos
;
20419 if (/* Not a newline. */
20421 /* Glyphs produced fit entirely in the line. */
20422 && it
->current_x
< it
->last_visible_x
)
20424 it
->hpos
+= nglyphs
;
20425 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20426 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20427 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20428 row
->phys_height
= max (row
->phys_height
,
20429 it
->max_phys_ascent
+ it
->max_phys_descent
);
20430 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20431 it
->max_extra_line_spacing
);
20432 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20433 /* In R2L rows, we arrange in extend_face_to_end_of_line
20434 to add a right offset to the line, by a suitable
20435 change to the stretch glyph that is the leftmost
20436 glyph of the line. */
20437 && !row
->reversed_p
)
20438 row
->x
= x
- it
->first_visible_x
;
20439 /* Record the maximum and minimum buffer positions seen so
20440 far in glyphs that will be displayed by this row. */
20442 RECORD_MAX_MIN_POS (it
);
20447 struct glyph
*glyph
;
20449 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20451 /* Identify the glyphs added by the last call to
20452 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20453 the previous glyphs. */
20454 if (!row
->reversed_p
)
20455 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20457 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20458 new_x
= x
+ glyph
->pixel_width
;
20460 if (/* Lines are continued. */
20461 it
->line_wrap
!= TRUNCATE
20462 && (/* Glyph doesn't fit on the line. */
20463 new_x
> it
->last_visible_x
20464 /* Or it fits exactly on a window system frame. */
20465 || (new_x
== it
->last_visible_x
20466 && FRAME_WINDOW_P (it
->f
)
20467 && (row
->reversed_p
20468 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20469 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20471 /* End of a continued line. */
20474 || (new_x
== it
->last_visible_x
20475 && FRAME_WINDOW_P (it
->f
)
20476 && (row
->reversed_p
20477 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20478 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20480 /* Current glyph is the only one on the line or
20481 fits exactly on the line. We must continue
20482 the line because we can't draw the cursor
20483 after the glyph. */
20484 row
->continued_p
= true;
20485 it
->current_x
= new_x
;
20486 it
->continuation_lines_width
+= new_x
;
20488 if (i
== nglyphs
- 1)
20490 /* If line-wrap is on, check if a previous
20491 wrap point was found. */
20492 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20493 && wrap_row_used
> 0
20494 /* Even if there is a previous wrap
20495 point, continue the line here as
20496 usual, if (i) the previous character
20497 was a space or tab AND (ii) the
20498 current character is not. */
20500 || IT_DISPLAYING_WHITESPACE (it
)))
20503 /* Record the maximum and minimum buffer
20504 positions seen so far in glyphs that will be
20505 displayed by this row. */
20507 RECORD_MAX_MIN_POS (it
);
20508 set_iterator_to_next (it
, true);
20509 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20511 if (!get_next_display_element (it
))
20513 row
->exact_window_width_line_p
= true;
20514 it
->continuation_lines_width
= 0;
20515 row
->continued_p
= false;
20516 row
->ends_at_zv_p
= true;
20518 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20520 row
->continued_p
= false;
20521 row
->exact_window_width_line_p
= true;
20523 /* If line-wrap is on, check if a
20524 previous wrap point was found. */
20525 else if (wrap_row_used
> 0
20526 /* Even if there is a previous wrap
20527 point, continue the line here as
20528 usual, if (i) the previous character
20529 was a space or tab AND (ii) the
20530 current character is not. */
20532 || IT_DISPLAYING_WHITESPACE (it
)))
20537 else if (it
->bidi_p
)
20538 RECORD_MAX_MIN_POS (it
);
20539 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20540 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20541 extend_face_to_end_of_line (it
);
20543 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20544 && !FRAME_WINDOW_P (it
->f
))
20546 /* A padding glyph that doesn't fit on this line.
20547 This means the whole character doesn't fit
20549 if (row
->reversed_p
)
20550 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20551 - n_glyphs_before
);
20552 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20554 /* Fill the rest of the row with continuation
20555 glyphs like in 20.x. */
20556 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20557 < row
->glyphs
[1 + TEXT_AREA
])
20558 produce_special_glyphs (it
, IT_CONTINUATION
);
20560 row
->continued_p
= true;
20561 it
->current_x
= x_before
;
20562 it
->continuation_lines_width
+= x_before
;
20564 /* Restore the height to what it was before the
20565 element not fitting on the line. */
20566 it
->max_ascent
= ascent
;
20567 it
->max_descent
= descent
;
20568 it
->max_phys_ascent
= phys_ascent
;
20569 it
->max_phys_descent
= phys_descent
;
20570 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20571 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20572 extend_face_to_end_of_line (it
);
20574 else if (wrap_row_used
> 0)
20577 if (row
->reversed_p
)
20578 unproduce_glyphs (it
,
20579 row
->used
[TEXT_AREA
] - wrap_row_used
);
20580 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20581 it
->continuation_lines_width
+= wrap_x
;
20582 row
->used
[TEXT_AREA
] = wrap_row_used
;
20583 row
->ascent
= wrap_row_ascent
;
20584 row
->height
= wrap_row_height
;
20585 row
->phys_ascent
= wrap_row_phys_ascent
;
20586 row
->phys_height
= wrap_row_phys_height
;
20587 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20588 min_pos
= wrap_row_min_pos
;
20589 min_bpos
= wrap_row_min_bpos
;
20590 max_pos
= wrap_row_max_pos
;
20591 max_bpos
= wrap_row_max_bpos
;
20592 row
->continued_p
= true;
20593 row
->ends_at_zv_p
= false;
20594 row
->exact_window_width_line_p
= false;
20595 it
->continuation_lines_width
+= x
;
20597 /* Make sure that a non-default face is extended
20598 up to the right margin of the window. */
20599 extend_face_to_end_of_line (it
);
20601 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20603 /* A TAB that extends past the right edge of the
20604 window. This produces a single glyph on
20605 window system frames. We leave the glyph in
20606 this row and let it fill the row, but don't
20607 consume the TAB. */
20608 if ((row
->reversed_p
20609 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20610 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20611 produce_special_glyphs (it
, IT_CONTINUATION
);
20612 it
->continuation_lines_width
+= it
->last_visible_x
;
20613 row
->ends_in_middle_of_char_p
= true;
20614 row
->continued_p
= true;
20615 glyph
->pixel_width
= it
->last_visible_x
- x
;
20616 it
->starts_in_middle_of_char_p
= true;
20617 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20618 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20619 extend_face_to_end_of_line (it
);
20623 /* Something other than a TAB that draws past
20624 the right edge of the window. Restore
20625 positions to values before the element. */
20626 if (row
->reversed_p
)
20627 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20628 - (n_glyphs_before
+ i
));
20629 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20631 /* Display continuation glyphs. */
20632 it
->current_x
= x_before
;
20633 it
->continuation_lines_width
+= x
;
20634 if (!FRAME_WINDOW_P (it
->f
)
20635 || (row
->reversed_p
20636 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20637 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20638 produce_special_glyphs (it
, IT_CONTINUATION
);
20639 row
->continued_p
= true;
20641 extend_face_to_end_of_line (it
);
20643 if (nglyphs
> 1 && i
> 0)
20645 row
->ends_in_middle_of_char_p
= true;
20646 it
->starts_in_middle_of_char_p
= true;
20649 /* Restore the height to what it was before the
20650 element not fitting on the line. */
20651 it
->max_ascent
= ascent
;
20652 it
->max_descent
= descent
;
20653 it
->max_phys_ascent
= phys_ascent
;
20654 it
->max_phys_descent
= phys_descent
;
20659 else if (new_x
> it
->first_visible_x
)
20661 /* Increment number of glyphs actually displayed. */
20664 /* Record the maximum and minimum buffer positions
20665 seen so far in glyphs that will be displayed by
20668 RECORD_MAX_MIN_POS (it
);
20670 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20671 /* Glyph is partially visible, i.e. row starts at
20672 negative X position. Don't do that in R2L
20673 rows, where we arrange to add a right offset to
20674 the line in extend_face_to_end_of_line, by a
20675 suitable change to the stretch glyph that is
20676 the leftmost glyph of the line. */
20677 row
->x
= x
- it
->first_visible_x
;
20678 /* When the last glyph of an R2L row only fits
20679 partially on the line, we need to set row->x to a
20680 negative offset, so that the leftmost glyph is
20681 the one that is partially visible. But if we are
20682 going to produce the truncation glyph, this will
20683 be taken care of in produce_special_glyphs. */
20684 if (row
->reversed_p
20685 && new_x
> it
->last_visible_x
20686 && !(it
->line_wrap
== TRUNCATE
20687 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20689 eassert (FRAME_WINDOW_P (it
->f
));
20690 row
->x
= it
->last_visible_x
- new_x
;
20695 /* Glyph is completely off the left margin of the
20696 window. This should not happen because of the
20697 move_it_in_display_line at the start of this
20698 function, unless the text display area of the
20699 window is empty. */
20700 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20703 /* Even if this display element produced no glyphs at all,
20704 we want to record its position. */
20705 if (it
->bidi_p
&& nglyphs
== 0)
20706 RECORD_MAX_MIN_POS (it
);
20708 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20709 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20710 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20711 row
->phys_height
= max (row
->phys_height
,
20712 it
->max_phys_ascent
+ it
->max_phys_descent
);
20713 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20714 it
->max_extra_line_spacing
);
20716 /* End of this display line if row is continued. */
20717 if (row
->continued_p
|| row
->ends_at_zv_p
)
20722 /* Is this a line end? If yes, we're also done, after making
20723 sure that a non-default face is extended up to the right
20724 margin of the window. */
20725 if (ITERATOR_AT_END_OF_LINE_P (it
))
20727 int used_before
= row
->used
[TEXT_AREA
];
20729 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20731 /* Add a space at the end of the line that is used to
20732 display the cursor there. */
20733 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20734 append_space_for_newline (it
, false);
20736 /* Extend the face to the end of the line. */
20737 extend_face_to_end_of_line (it
);
20739 /* Make sure we have the position. */
20740 if (used_before
== 0)
20741 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20743 /* Record the position of the newline, for use in
20745 it
->eol_pos
= it
->current
.pos
;
20747 /* Consume the line end. This skips over invisible lines. */
20748 set_iterator_to_next (it
, true);
20749 it
->continuation_lines_width
= 0;
20753 /* Proceed with next display element. Note that this skips
20754 over lines invisible because of selective display. */
20755 set_iterator_to_next (it
, true);
20757 /* If we truncate lines, we are done when the last displayed
20758 glyphs reach past the right margin of the window. */
20759 if (it
->line_wrap
== TRUNCATE
20760 && ((FRAME_WINDOW_P (it
->f
)
20761 /* Images are preprocessed in produce_image_glyph such
20762 that they are cropped at the right edge of the
20763 window, so an image glyph will always end exactly at
20764 last_visible_x, even if there's no right fringe. */
20765 && ((row
->reversed_p
20766 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20767 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20768 || it
->what
== IT_IMAGE
))
20769 ? (it
->current_x
>= it
->last_visible_x
)
20770 : (it
->current_x
> it
->last_visible_x
)))
20772 /* Maybe add truncation glyphs. */
20773 if (!FRAME_WINDOW_P (it
->f
)
20774 || (row
->reversed_p
20775 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20776 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20780 if (!row
->reversed_p
)
20782 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20783 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20788 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20789 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20791 /* Remove any padding glyphs at the front of ROW, to
20792 make room for the truncation glyphs we will be
20793 adding below. The loop below always inserts at
20794 least one truncation glyph, so also remove the
20795 last glyph added to ROW. */
20796 unproduce_glyphs (it
, i
+ 1);
20797 /* Adjust i for the loop below. */
20798 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20801 /* produce_special_glyphs overwrites the last glyph, so
20802 we don't want that if we want to keep that last
20803 glyph, which means it's an image. */
20804 if (it
->current_x
> it
->last_visible_x
)
20806 it
->current_x
= x_before
;
20807 if (!FRAME_WINDOW_P (it
->f
))
20809 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20811 row
->used
[TEXT_AREA
] = i
;
20812 produce_special_glyphs (it
, IT_TRUNCATION
);
20817 row
->used
[TEXT_AREA
] = i
;
20818 produce_special_glyphs (it
, IT_TRUNCATION
);
20820 it
->hpos
= hpos_before
;
20823 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20825 /* Don't truncate if we can overflow newline into fringe. */
20826 if (!get_next_display_element (it
))
20828 it
->continuation_lines_width
= 0;
20829 row
->ends_at_zv_p
= true;
20830 row
->exact_window_width_line_p
= true;
20833 if (ITERATOR_AT_END_OF_LINE_P (it
))
20835 row
->exact_window_width_line_p
= true;
20836 goto at_end_of_line
;
20838 it
->current_x
= x_before
;
20839 it
->hpos
= hpos_before
;
20842 row
->truncated_on_right_p
= true;
20843 it
->continuation_lines_width
= 0;
20844 reseat_at_next_visible_line_start (it
, false);
20845 /* We insist below that IT's position be at ZV because in
20846 bidi-reordered lines the character at visible line start
20847 might not be the character that follows the newline in
20848 the logical order. */
20849 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20850 row
->ends_at_zv_p
=
20851 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20853 row
->ends_at_zv_p
= false;
20859 bidi_unshelve_cache (wrap_data
, true);
20861 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20862 at the left window margin. */
20863 if (it
->first_visible_x
20864 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20866 if (!FRAME_WINDOW_P (it
->f
)
20867 || (((row
->reversed_p
20868 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20869 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20870 /* Don't let insert_left_trunc_glyphs overwrite the
20871 first glyph of the row if it is an image. */
20872 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20873 insert_left_trunc_glyphs (it
);
20874 row
->truncated_on_left_p
= true;
20877 /* Remember the position at which this line ends.
20879 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20880 cannot be before the call to find_row_edges below, since that is
20881 where these positions are determined. */
20882 row
->end
= it
->current
;
20885 row
->minpos
= row
->start
.pos
;
20886 row
->maxpos
= row
->end
.pos
;
20890 /* ROW->minpos and ROW->maxpos must be the smallest and
20891 `1 + the largest' buffer positions in ROW. But if ROW was
20892 bidi-reordered, these two positions can be anywhere in the
20893 row, so we must determine them now. */
20894 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20897 /* If the start of this line is the overlay arrow-position, then
20898 mark this glyph row as the one containing the overlay arrow.
20899 This is clearly a mess with variable size fonts. It would be
20900 better to let it be displayed like cursors under X. */
20901 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20902 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20903 !NILP (overlay_arrow_string
)))
20905 /* Overlay arrow in window redisplay is a fringe bitmap. */
20906 if (STRINGP (overlay_arrow_string
))
20908 struct glyph_row
*arrow_row
20909 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20910 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20911 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20912 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20913 struct glyph
*p2
, *end
;
20915 /* Copy the arrow glyphs. */
20916 while (glyph
< arrow_end
)
20919 /* Throw away padding glyphs. */
20921 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20922 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20928 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20933 eassert (INTEGERP (overlay_arrow_string
));
20934 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20936 overlay_arrow_seen
= true;
20939 /* Highlight trailing whitespace. */
20940 if (!NILP (Vshow_trailing_whitespace
))
20941 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20943 /* Compute pixel dimensions of this line. */
20944 compute_line_metrics (it
);
20946 /* Implementation note: No changes in the glyphs of ROW or in their
20947 faces can be done past this point, because compute_line_metrics
20948 computes ROW's hash value and stores it within the glyph_row
20951 /* Record whether this row ends inside an ellipsis. */
20952 row
->ends_in_ellipsis_p
20953 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20954 && it
->ellipsis_p
);
20956 /* Save fringe bitmaps in this row. */
20957 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20958 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20959 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20960 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20962 it
->left_user_fringe_bitmap
= 0;
20963 it
->left_user_fringe_face_id
= 0;
20964 it
->right_user_fringe_bitmap
= 0;
20965 it
->right_user_fringe_face_id
= 0;
20967 /* Maybe set the cursor. */
20968 cvpos
= it
->w
->cursor
.vpos
;
20970 /* In bidi-reordered rows, keep checking for proper cursor
20971 position even if one has been found already, because buffer
20972 positions in such rows change non-linearly with ROW->VPOS,
20973 when a line is continued. One exception: when we are at ZV,
20974 display cursor on the first suitable glyph row, since all
20975 the empty rows after that also have their position set to ZV. */
20976 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20977 lines' rows is implemented for bidi-reordered rows. */
20979 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20980 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20981 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20982 && cursor_row_p (row
))
20983 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20985 /* Prepare for the next line. This line starts horizontally at (X
20986 HPOS) = (0 0). Vertical positions are incremented. As a
20987 convenience for the caller, IT->glyph_row is set to the next
20989 it
->current_x
= it
->hpos
= 0;
20990 it
->current_y
+= row
->height
;
20991 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20994 /* The next row should by default use the same value of the
20995 reversed_p flag as this one. set_iterator_to_next decides when
20996 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20997 the flag accordingly. */
20998 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20999 it
->glyph_row
->reversed_p
= row
->reversed_p
;
21000 it
->start
= row
->end
;
21001 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
21003 #undef RECORD_MAX_MIN_POS
21006 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
21007 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
21008 doc
: /* Return paragraph direction at point in BUFFER.
21009 Value is either `left-to-right' or `right-to-left'.
21010 If BUFFER is omitted or nil, it defaults to the current buffer.
21012 Paragraph direction determines how the text in the paragraph is displayed.
21013 In left-to-right paragraphs, text begins at the left margin of the window
21014 and the reading direction is generally left to right. In right-to-left
21015 paragraphs, text begins at the right margin and is read from right to left.
21017 See also `bidi-paragraph-direction'. */)
21018 (Lisp_Object buffer
)
21020 struct buffer
*buf
= current_buffer
;
21021 struct buffer
*old
= buf
;
21023 if (! NILP (buffer
))
21025 CHECK_BUFFER (buffer
);
21026 buf
= XBUFFER (buffer
);
21029 if (NILP (BVAR (buf
, bidi_display_reordering
))
21030 || NILP (BVAR (buf
, enable_multibyte_characters
))
21031 /* When we are loading loadup.el, the character property tables
21032 needed for bidi iteration are not yet available. */
21033 || !NILP (Vpurify_flag
))
21034 return Qleft_to_right
;
21035 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21036 return BVAR (buf
, bidi_paragraph_direction
);
21039 /* Determine the direction from buffer text. We could try to
21040 use current_matrix if it is up to date, but this seems fast
21041 enough as it is. */
21042 struct bidi_it itb
;
21043 ptrdiff_t pos
= BUF_PT (buf
);
21044 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21046 void *itb_data
= bidi_shelve_cache ();
21048 set_buffer_temp (buf
);
21049 /* bidi_paragraph_init finds the base direction of the paragraph
21050 by searching forward from paragraph start. We need the base
21051 direction of the current or _previous_ paragraph, so we need
21052 to make sure we are within that paragraph. To that end, find
21053 the previous non-empty line. */
21054 if (pos
>= ZV
&& pos
> BEGV
)
21055 DEC_BOTH (pos
, bytepos
);
21056 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21057 if (fast_looking_at (trailing_white_space
,
21058 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21060 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21061 || c
== ' ' || c
== '\t' || c
== '\f')
21063 if (bytepos
<= BEGV_BYTE
)
21068 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21071 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21072 itb
.paragraph_dir
= NEUTRAL_DIR
;
21073 itb
.string
.s
= NULL
;
21074 itb
.string
.lstring
= Qnil
;
21075 itb
.string
.bufpos
= 0;
21076 itb
.string
.from_disp_str
= false;
21077 itb
.string
.unibyte
= false;
21078 /* We have no window to use here for ignoring window-specific
21079 overlays. Using NULL for window pointer will cause
21080 compute_display_string_pos to use the current buffer. */
21082 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21083 bidi_unshelve_cache (itb_data
, false);
21084 set_buffer_temp (old
);
21085 switch (itb
.paragraph_dir
)
21088 return Qleft_to_right
;
21091 return Qright_to_left
;
21099 DEFUN ("bidi-find-overridden-directionality",
21100 Fbidi_find_overridden_directionality
,
21101 Sbidi_find_overridden_directionality
, 2, 3, 0,
21102 doc
: /* Return position between FROM and TO where directionality was overridden.
21104 This function returns the first character position in the specified
21105 region of OBJECT where there is a character whose `bidi-class' property
21106 is `L', but which was forced to display as `R' by a directional
21107 override, and likewise with characters whose `bidi-class' is `R'
21108 or `AL' that were forced to display as `L'.
21110 If no such character is found, the function returns nil.
21112 OBJECT is a Lisp string or buffer to search for overridden
21113 directionality, and defaults to the current buffer if nil or omitted.
21114 OBJECT can also be a window, in which case the function will search
21115 the buffer displayed in that window. Passing the window instead of
21116 a buffer is preferable when the buffer is displayed in some window,
21117 because this function will then be able to correctly account for
21118 window-specific overlays, which can affect the results.
21120 Strong directional characters `L', `R', and `AL' can have their
21121 intrinsic directionality overridden by directional override
21122 control characters RLO (u+202e) and LRO (u+202d). See the
21123 function `get-char-code-property' for a way to inquire about
21124 the `bidi-class' property of a character. */)
21125 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21127 struct buffer
*buf
= current_buffer
;
21128 struct buffer
*old
= buf
;
21129 struct window
*w
= NULL
;
21130 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21131 struct bidi_it itb
;
21132 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21135 if (!NILP (object
))
21137 if (BUFFERP (object
))
21138 buf
= XBUFFER (object
);
21139 else if (WINDOWP (object
))
21141 w
= decode_live_window (object
);
21142 buf
= XBUFFER (w
->contents
);
21143 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21146 CHECK_STRING (object
);
21149 if (STRINGP (object
))
21151 /* Characters in unibyte strings are always treated by bidi.c as
21153 if (!STRING_MULTIBYTE (object
)
21154 /* When we are loading loadup.el, the character property
21155 tables needed for bidi iteration are not yet
21157 || !NILP (Vpurify_flag
))
21160 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21161 if (from_pos
>= SCHARS (object
))
21164 /* Set up the bidi iterator. */
21165 itb_data
= bidi_shelve_cache ();
21166 itb
.paragraph_dir
= NEUTRAL_DIR
;
21167 itb
.string
.lstring
= object
;
21168 itb
.string
.s
= NULL
;
21169 itb
.string
.schars
= SCHARS (object
);
21170 itb
.string
.bufpos
= 0;
21171 itb
.string
.from_disp_str
= false;
21172 itb
.string
.unibyte
= false;
21174 bidi_init_it (0, 0, frame_window_p
, &itb
);
21178 /* Nothing this fancy can happen in unibyte buffers, or in a
21179 buffer that disabled reordering, or if FROM is at EOB. */
21180 if (NILP (BVAR (buf
, bidi_display_reordering
))
21181 || NILP (BVAR (buf
, enable_multibyte_characters
))
21182 /* When we are loading loadup.el, the character property
21183 tables needed for bidi iteration are not yet
21185 || !NILP (Vpurify_flag
))
21188 set_buffer_temp (buf
);
21189 validate_region (&from
, &to
);
21190 from_pos
= XINT (from
);
21191 to_pos
= XINT (to
);
21192 if (from_pos
>= ZV
)
21195 /* Set up the bidi iterator. */
21196 itb_data
= bidi_shelve_cache ();
21197 from_bpos
= CHAR_TO_BYTE (from_pos
);
21198 if (from_pos
== BEGV
)
21200 itb
.charpos
= BEGV
;
21201 itb
.bytepos
= BEGV_BYTE
;
21203 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21205 itb
.charpos
= from_pos
;
21206 itb
.bytepos
= from_bpos
;
21209 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21211 itb
.paragraph_dir
= NEUTRAL_DIR
;
21212 itb
.string
.s
= NULL
;
21213 itb
.string
.lstring
= Qnil
;
21214 itb
.string
.bufpos
= 0;
21215 itb
.string
.from_disp_str
= false;
21216 itb
.string
.unibyte
= false;
21218 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21223 /* For the purposes of this function, the actual base direction of
21224 the paragraph doesn't matter, so just set it to L2R. */
21225 bidi_paragraph_init (L2R
, &itb
, false);
21226 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21228 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21230 bidi_unshelve_cache (itb_data
, false);
21231 set_buffer_temp (old
);
21233 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21236 DEFUN ("move-point-visually", Fmove_point_visually
,
21237 Smove_point_visually
, 1, 1, 0,
21238 doc
: /* Move point in the visual order in the specified DIRECTION.
21239 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21242 Value is the new character position of point. */)
21243 (Lisp_Object direction
)
21245 struct window
*w
= XWINDOW (selected_window
);
21246 struct buffer
*b
= XBUFFER (w
->contents
);
21247 struct glyph_row
*row
;
21249 Lisp_Object paragraph_dir
;
21251 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21252 (!(ROW)->continued_p \
21253 && NILP ((GLYPH)->object) \
21254 && (GLYPH)->type == CHAR_GLYPH \
21255 && (GLYPH)->u.ch == ' ' \
21256 && (GLYPH)->charpos >= 0 \
21257 && !(GLYPH)->avoid_cursor_p)
21259 CHECK_NUMBER (direction
);
21260 dir
= XINT (direction
);
21266 /* If current matrix is up-to-date, we can use the information
21267 recorded in the glyphs, at least as long as the goal is on the
21269 if (w
->window_end_valid
21270 && !windows_or_buffers_changed
21272 && !b
->clip_changed
21273 && !b
->prevent_redisplay_optimizations_p
21274 && !window_outdated (w
)
21275 /* We rely below on the cursor coordinates to be up to date, but
21276 we cannot trust them if some command moved point since the
21277 last complete redisplay. */
21278 && w
->last_point
== BUF_PT (b
)
21279 && w
->cursor
.vpos
>= 0
21280 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21281 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21283 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21284 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21285 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21287 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21289 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21291 SET_PT (g
->charpos
);
21292 w
->cursor
.vpos
= -1;
21293 return make_number (PT
);
21295 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21299 if (BUFFERP (gpt
->object
))
21302 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21303 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21305 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21307 else if (BUFFERP (g
->object
))
21308 new_pos
= g
->charpos
;
21312 w
->cursor
.vpos
= -1;
21313 return make_number (PT
);
21315 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21317 /* Glyphs inserted at the end of a non-empty line for
21318 positioning the cursor have zero charpos, so we must
21319 deduce the value of point by other means. */
21320 if (g
->charpos
> 0)
21321 SET_PT (g
->charpos
);
21322 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21324 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21325 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21328 w
->cursor
.vpos
= -1;
21329 return make_number (PT
);
21332 if (g
== e
|| NILP (g
->object
))
21334 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21335 goto simulate_display
;
21336 if (!row
->reversed_p
)
21340 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21341 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21342 goto simulate_display
;
21346 if (row
->reversed_p
&& !row
->continued_p
)
21348 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21349 w
->cursor
.vpos
= -1;
21350 return make_number (PT
);
21352 g
= row
->glyphs
[TEXT_AREA
];
21353 e
= g
+ row
->used
[TEXT_AREA
];
21354 for ( ; g
< e
; g
++)
21356 if (BUFFERP (g
->object
)
21357 /* Empty lines have only one glyph, which stands
21358 for the newline, and whose charpos is the
21359 buffer position of the newline. */
21360 || ROW_GLYPH_NEWLINE_P (row
, g
)
21361 /* When the buffer ends in a newline, the line at
21362 EOB also has one glyph, but its charpos is -1. */
21363 || (row
->ends_at_zv_p
21364 && !row
->reversed_p
21365 && NILP (g
->object
)
21366 && g
->type
== CHAR_GLYPH
21367 && g
->u
.ch
== ' '))
21369 if (g
->charpos
> 0)
21370 SET_PT (g
->charpos
);
21371 else if (!row
->reversed_p
21372 && row
->ends_at_zv_p
21377 w
->cursor
.vpos
= -1;
21378 return make_number (PT
);
21384 if (!row
->reversed_p
&& !row
->continued_p
)
21386 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21387 w
->cursor
.vpos
= -1;
21388 return make_number (PT
);
21390 e
= row
->glyphs
[TEXT_AREA
];
21391 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21392 for ( ; g
>= e
; g
--)
21394 if (BUFFERP (g
->object
)
21395 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21397 /* Empty R2L lines on GUI frames have the buffer
21398 position of the newline stored in the stretch
21400 || g
->type
== STRETCH_GLYPH
21401 || (row
->ends_at_zv_p
21403 && NILP (g
->object
)
21404 && g
->type
== CHAR_GLYPH
21405 && g
->u
.ch
== ' '))
21407 if (g
->charpos
> 0)
21408 SET_PT (g
->charpos
);
21409 else if (row
->reversed_p
21410 && row
->ends_at_zv_p
21415 w
->cursor
.vpos
= -1;
21416 return make_number (PT
);
21425 /* If we wind up here, we failed to move by using the glyphs, so we
21426 need to simulate display instead. */
21429 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21431 paragraph_dir
= Qleft_to_right
;
21432 if (EQ (paragraph_dir
, Qright_to_left
))
21434 if (PT
<= BEGV
&& dir
< 0)
21435 xsignal0 (Qbeginning_of_buffer
);
21436 else if (PT
>= ZV
&& dir
> 0)
21437 xsignal0 (Qend_of_buffer
);
21440 struct text_pos pt
;
21442 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21444 bool overshoot_expected
= false;
21445 bool target_is_eol_p
= false;
21447 /* Setup the arena. */
21448 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21449 start_display (&it
, w
, pt
);
21450 /* When lines are truncated, we could be called with point
21451 outside of the windows edges, in which case move_it_*
21452 functions either prematurely stop at window's edge or jump to
21453 the next screen line, whereas we rely below on our ability to
21454 reach point, in order to start from its X coordinate. So we
21455 need to disregard the window's horizontal extent in that case. */
21456 if (it
.line_wrap
== TRUNCATE
)
21457 it
.last_visible_x
= INFINITY
;
21459 if (it
.cmp_it
.id
< 0
21460 && it
.method
== GET_FROM_STRING
21461 && it
.area
== TEXT_AREA
21462 && it
.string_from_display_prop_p
21463 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21464 overshoot_expected
= true;
21466 /* Find the X coordinate of point. We start from the beginning
21467 of this or previous line to make sure we are before point in
21468 the logical order (since the move_it_* functions can only
21471 reseat_at_previous_visible_line_start (&it
);
21472 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21473 if (IT_CHARPOS (it
) != PT
)
21475 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21476 -1, -1, -1, MOVE_TO_POS
);
21477 /* If we missed point because the character there is
21478 displayed out of a display vector that has more than one
21479 glyph, retry expecting overshoot. */
21480 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21481 && it
.current
.dpvec_index
> 0
21482 && !overshoot_expected
)
21484 overshoot_expected
= true;
21487 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21488 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21490 pt_x
= it
.current_x
;
21492 if (dir
> 0 || overshoot_expected
)
21494 struct glyph_row
*row
= it
.glyph_row
;
21496 /* When point is at beginning of line, we don't have
21497 information about the glyph there loaded into struct
21498 it. Calling get_next_display_element fixes that. */
21500 get_next_display_element (&it
);
21501 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21502 it
.glyph_row
= NULL
;
21503 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21504 it
.glyph_row
= row
;
21505 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21506 it, lest it will become out of sync with it's buffer
21508 it
.current_x
= pt_x
;
21511 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21512 pixel_width
= it
.pixel_width
;
21513 if (overshoot_expected
&& at_eol_p
)
21515 else if (pixel_width
<= 0)
21518 /* If there's a display string (or something similar) at point,
21519 we are actually at the glyph to the left of point, so we need
21520 to correct the X coordinate. */
21521 if (overshoot_expected
)
21524 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21526 pt_x
+= pixel_width
;
21529 /* Compute target X coordinate, either to the left or to the
21530 right of point. On TTY frames, all characters have the same
21531 pixel width of 1, so we can use that. On GUI frames we don't
21532 have an easy way of getting at the pixel width of the
21533 character to the left of point, so we use a different method
21534 of getting to that place. */
21536 target_x
= pt_x
+ pixel_width
;
21538 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21540 /* Target X coordinate could be one line above or below the line
21541 of point, in which case we need to adjust the target X
21542 coordinate. Also, if moving to the left, we need to begin at
21543 the left edge of the point's screen line. */
21548 start_display (&it
, w
, pt
);
21549 if (it
.line_wrap
== TRUNCATE
)
21550 it
.last_visible_x
= INFINITY
;
21551 reseat_at_previous_visible_line_start (&it
);
21552 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21554 move_it_by_lines (&it
, pt_vpos
);
21558 move_it_by_lines (&it
, -1);
21559 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21560 target_is_eol_p
= true;
21561 /* Under word-wrap, we don't know the x coordinate of
21562 the last character displayed on the previous line,
21563 which immediately precedes the wrap point. To find
21564 out its x coordinate, we try moving to the right
21565 margin of the window, which will stop at the wrap
21566 point, and then reset target_x to point at the
21567 character that precedes the wrap point. This is not
21568 needed on GUI frames, because (see below) there we
21569 move from the left margin one grapheme cluster at a
21570 time, and stop when we hit the wrap point. */
21571 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21573 void *it_data
= NULL
;
21576 SAVE_IT (it2
, it
, it_data
);
21577 move_it_in_display_line_to (&it
, ZV
, target_x
,
21578 MOVE_TO_POS
| MOVE_TO_X
);
21579 /* If we arrived at target_x, that _is_ the last
21580 character on the previous line. */
21581 if (it
.current_x
!= target_x
)
21582 target_x
= it
.current_x
- 1;
21583 RESTORE_IT (&it
, &it2
, it_data
);
21590 || (target_x
>= it
.last_visible_x
21591 && it
.line_wrap
!= TRUNCATE
))
21594 move_it_by_lines (&it
, 0);
21595 move_it_by_lines (&it
, 1);
21600 /* Move to the target X coordinate. */
21601 #ifdef HAVE_WINDOW_SYSTEM
21602 /* On GUI frames, as we don't know the X coordinate of the
21603 character to the left of point, moving point to the left
21604 requires walking, one grapheme cluster at a time, until we
21605 find ourself at a place immediately to the left of the
21606 character at point. */
21607 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21609 struct text_pos new_pos
;
21610 enum move_it_result rc
= MOVE_X_REACHED
;
21612 if (it
.current_x
== 0)
21613 get_next_display_element (&it
);
21614 if (it
.what
== IT_COMPOSITION
)
21616 new_pos
.charpos
= it
.cmp_it
.charpos
;
21617 new_pos
.bytepos
= -1;
21620 new_pos
= it
.current
.pos
;
21622 while (it
.current_x
+ it
.pixel_width
<= target_x
21623 && (rc
== MOVE_X_REACHED
21624 /* Under word-wrap, move_it_in_display_line_to
21625 stops at correct coordinates, but sometimes
21626 returns MOVE_POS_MATCH_OR_ZV. */
21627 || (it
.line_wrap
== WORD_WRAP
21628 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21630 int new_x
= it
.current_x
+ it
.pixel_width
;
21632 /* For composed characters, we want the position of the
21633 first character in the grapheme cluster (usually, the
21634 composition's base character), whereas it.current
21635 might give us the position of the _last_ one, e.g. if
21636 the composition is rendered in reverse due to bidi
21638 if (it
.what
== IT_COMPOSITION
)
21640 new_pos
.charpos
= it
.cmp_it
.charpos
;
21641 new_pos
.bytepos
= -1;
21644 new_pos
= it
.current
.pos
;
21645 if (new_x
== it
.current_x
)
21647 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21648 MOVE_TO_POS
| MOVE_TO_X
);
21649 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21652 /* The previous position we saw in the loop is the one we
21654 if (new_pos
.bytepos
== -1)
21655 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21656 it
.current
.pos
= new_pos
;
21660 if (it
.current_x
!= target_x
)
21661 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21663 /* If we ended up in a display string that covers point, move to
21664 buffer position to the right in the visual order. */
21667 while (IT_CHARPOS (it
) == PT
)
21669 set_iterator_to_next (&it
, false);
21670 if (!get_next_display_element (&it
))
21675 /* Move point to that position. */
21676 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21679 return make_number (PT
);
21681 #undef ROW_GLYPH_NEWLINE_P
21684 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21685 Sbidi_resolved_levels
, 0, 1, 0,
21686 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21688 The resolved levels are produced by the Emacs bidi reordering engine
21689 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21690 read the Unicode Standard Annex 9 (UAX#9) for background information
21691 about these levels.
21693 VPOS is the zero-based number of the current window's screen line
21694 for which to produce the resolved levels. If VPOS is nil or omitted,
21695 it defaults to the screen line of point. If the window displays a
21696 header line, VPOS of zero will report on the header line, and first
21697 line of text in the window will have VPOS of 1.
21699 Value is an array of resolved levels, indexed by glyph number.
21700 Glyphs are numbered from zero starting from the beginning of the
21701 screen line, i.e. the left edge of the window for left-to-right lines
21702 and from the right edge for right-to-left lines. The resolved levels
21703 are produced only for the window's text area; text in display margins
21706 If the selected window's display is not up-to-date, or if the specified
21707 screen line does not display text, this function returns nil. It is
21708 highly recommended to bind this function to some simple key, like F8,
21709 in order to avoid these problems.
21711 This function exists mainly for testing the correctness of the
21712 Emacs UBA implementation, in particular with the test suite. */)
21715 struct window
*w
= XWINDOW (selected_window
);
21716 struct buffer
*b
= XBUFFER (w
->contents
);
21718 struct glyph_row
*row
;
21722 int d1
, d2
, d3
, d4
, d5
;
21724 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21728 CHECK_NUMBER_COERCE_MARKER (vpos
);
21729 nrow
= XINT (vpos
);
21732 /* We require up-to-date glyph matrix for this window. */
21733 if (w
->window_end_valid
21734 && !windows_or_buffers_changed
21736 && !b
->clip_changed
21737 && !b
->prevent_redisplay_optimizations_p
21738 && !window_outdated (w
)
21740 && nrow
< w
->current_matrix
->nrows
21741 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21742 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21744 struct glyph
*g
, *e
, *g1
;
21746 Lisp_Object levels
;
21748 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21750 g
= g1
= row
->glyphs
[TEXT_AREA
];
21751 e
= g
+ row
->used
[TEXT_AREA
];
21753 /* Skip over glyphs at the start of the row that was
21754 generated by redisplay for its own needs. */
21756 && NILP (g
->object
)
21761 /* Count the "interesting" glyphs in this row. */
21762 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21765 /* Create and fill the array. */
21766 levels
= make_uninit_vector (nglyphs
);
21767 for (i
= 0; g1
< g
; i
++, g1
++)
21768 ASET (levels
, i
, make_number (g1
->resolved_level
));
21770 else /* Right-to-left glyph row. */
21772 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21773 e
= row
->glyphs
[TEXT_AREA
] - 1;
21775 && NILP (g
->object
)
21779 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21781 levels
= make_uninit_vector (nglyphs
);
21782 for (i
= 0; g1
> g
; i
++, g1
--)
21783 ASET (levels
, i
, make_number (g1
->resolved_level
));
21793 /***********************************************************************
21795 ***********************************************************************/
21797 /* Redisplay the menu bar in the frame for window W.
21799 The menu bar of X frames that don't have X toolkit support is
21800 displayed in a special window W->frame->menu_bar_window.
21802 The menu bar of terminal frames is treated specially as far as
21803 glyph matrices are concerned. Menu bar lines are not part of
21804 windows, so the update is done directly on the frame matrix rows
21805 for the menu bar. */
21808 display_menu_bar (struct window
*w
)
21810 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21815 /* Don't do all this for graphical frames. */
21817 if (FRAME_W32_P (f
))
21820 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21826 if (FRAME_NS_P (f
))
21828 #endif /* HAVE_NS */
21830 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21831 eassert (!FRAME_WINDOW_P (f
));
21832 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21833 it
.first_visible_x
= 0;
21834 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21835 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21836 if (FRAME_WINDOW_P (f
))
21838 /* Menu bar lines are displayed in the desired matrix of the
21839 dummy window menu_bar_window. */
21840 struct window
*menu_w
;
21841 menu_w
= XWINDOW (f
->menu_bar_window
);
21842 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21844 it
.first_visible_x
= 0;
21845 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21848 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21850 /* This is a TTY frame, i.e. character hpos/vpos are used as
21852 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21854 it
.first_visible_x
= 0;
21855 it
.last_visible_x
= FRAME_COLS (f
);
21858 /* FIXME: This should be controlled by a user option. See the
21859 comments in redisplay_tool_bar and display_mode_line about
21861 it
.paragraph_embedding
= L2R
;
21863 /* Clear all rows of the menu bar. */
21864 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21866 struct glyph_row
*row
= it
.glyph_row
+ i
;
21867 clear_glyph_row (row
);
21868 row
->enabled_p
= true;
21869 row
->full_width_p
= true;
21870 row
->reversed_p
= false;
21873 /* Display all items of the menu bar. */
21874 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21875 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21877 Lisp_Object string
;
21879 /* Stop at nil string. */
21880 string
= AREF (items
, i
+ 1);
21884 /* Remember where item was displayed. */
21885 ASET (items
, i
+ 3, make_number (it
.hpos
));
21887 /* Display the item, pad with one space. */
21888 if (it
.current_x
< it
.last_visible_x
)
21889 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21890 SCHARS (string
) + 1, 0, 0, -1);
21893 /* Fill out the line with spaces. */
21894 if (it
.current_x
< it
.last_visible_x
)
21895 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21897 /* Compute the total height of the lines. */
21898 compute_line_metrics (&it
);
21901 /* Deep copy of a glyph row, including the glyphs. */
21903 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21905 struct glyph
*pointers
[1 + LAST_AREA
];
21906 int to_used
= to
->used
[TEXT_AREA
];
21908 /* Save glyph pointers of TO. */
21909 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21911 /* Do a structure assignment. */
21914 /* Restore original glyph pointers of TO. */
21915 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21917 /* Copy the glyphs. */
21918 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21919 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21921 /* If we filled only part of the TO row, fill the rest with
21922 space_glyph (which will display as empty space). */
21923 if (to_used
> from
->used
[TEXT_AREA
])
21924 fill_up_frame_row_with_spaces (to
, to_used
);
21927 /* Display one menu item on a TTY, by overwriting the glyphs in the
21928 frame F's desired glyph matrix with glyphs produced from the menu
21929 item text. Called from term.c to display TTY drop-down menus one
21932 ITEM_TEXT is the menu item text as a C string.
21934 FACE_ID is the face ID to be used for this menu item. FACE_ID
21935 could specify one of 3 faces: a face for an enabled item, a face
21936 for a disabled item, or a face for a selected item.
21938 X and Y are coordinates of the first glyph in the frame's desired
21939 matrix to be overwritten by the menu item. Since this is a TTY, Y
21940 is the zero-based number of the glyph row and X is the zero-based
21941 glyph number in the row, starting from left, where to start
21942 displaying the item.
21944 SUBMENU means this menu item drops down a submenu, which
21945 should be indicated by displaying a proper visual cue after the
21949 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21950 int x
, int y
, bool submenu
)
21953 struct frame
*f
= SELECTED_FRAME ();
21954 struct window
*w
= XWINDOW (f
->selected_window
);
21955 struct glyph_row
*row
;
21956 size_t item_len
= strlen (item_text
);
21958 eassert (FRAME_TERMCAP_P (f
));
21960 /* Don't write beyond the matrix's last row. This can happen for
21961 TTY screens that are not high enough to show the entire menu.
21962 (This is actually a bit of defensive programming, as
21963 tty_menu_display already limits the number of menu items to one
21964 less than the number of screen lines.) */
21965 if (y
>= f
->desired_matrix
->nrows
)
21968 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21969 it
.first_visible_x
= 0;
21970 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21971 row
= it
.glyph_row
;
21972 /* Start with the row contents from the current matrix. */
21973 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21974 bool saved_width
= row
->full_width_p
;
21975 row
->full_width_p
= true;
21976 bool saved_reversed
= row
->reversed_p
;
21977 row
->reversed_p
= false;
21978 row
->enabled_p
= true;
21980 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21982 eassert (x
< f
->desired_matrix
->matrix_w
);
21983 it
.current_x
= it
.hpos
= x
;
21984 it
.current_y
= it
.vpos
= y
;
21985 int saved_used
= row
->used
[TEXT_AREA
];
21986 bool saved_truncated
= row
->truncated_on_right_p
;
21987 row
->used
[TEXT_AREA
] = x
;
21988 it
.face_id
= face_id
;
21989 it
.line_wrap
= TRUNCATE
;
21991 /* FIXME: This should be controlled by a user option. See the
21992 comments in redisplay_tool_bar and display_mode_line about this.
21993 Also, if paragraph_embedding could ever be R2L, changes will be
21994 needed to avoid shifting to the right the row characters in
21995 term.c:append_glyph. */
21996 it
.paragraph_embedding
= L2R
;
21998 /* Pad with a space on the left. */
21999 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
22001 /* Display the menu item, pad with spaces to WIDTH. */
22004 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22005 item_len
, 0, FRAME_COLS (f
) - 1, -1);
22007 /* Indicate with " >" that there's a submenu. */
22008 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
22009 FRAME_COLS (f
) - 1, -1);
22012 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
22013 width
, 0, FRAME_COLS (f
) - 1, -1);
22015 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
22016 row
->truncated_on_right_p
= saved_truncated
;
22017 row
->hash
= row_hash (row
);
22018 row
->full_width_p
= saved_width
;
22019 row
->reversed_p
= saved_reversed
;
22022 /***********************************************************************
22024 ***********************************************************************/
22026 /* Redisplay mode lines in the window tree whose root is WINDOW.
22027 If FORCE, redisplay mode lines unconditionally.
22028 Otherwise, redisplay only mode lines that are garbaged. Value is
22029 the number of windows whose mode lines were redisplayed. */
22032 redisplay_mode_lines (Lisp_Object window
, bool force
)
22036 while (!NILP (window
))
22038 struct window
*w
= XWINDOW (window
);
22040 if (WINDOWP (w
->contents
))
22041 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22043 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22044 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22046 struct text_pos lpoint
;
22047 struct buffer
*old
= current_buffer
;
22049 /* Set the window's buffer for the mode line display. */
22050 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22051 set_buffer_internal_1 (XBUFFER (w
->contents
));
22053 /* Point refers normally to the selected window. For any
22054 other window, set up appropriate value. */
22055 if (!EQ (window
, selected_window
))
22057 struct text_pos pt
;
22059 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22060 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22063 /* Display mode lines. */
22064 clear_glyph_matrix (w
->desired_matrix
);
22065 if (display_mode_lines (w
))
22068 /* Restore old settings. */
22069 set_buffer_internal_1 (old
);
22070 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22080 /* Display the mode and/or header line of window W. Value is the
22081 sum number of mode lines and header lines displayed. */
22084 display_mode_lines (struct window
*w
)
22086 Lisp_Object old_selected_window
= selected_window
;
22087 Lisp_Object old_selected_frame
= selected_frame
;
22088 Lisp_Object new_frame
= w
->frame
;
22089 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22092 selected_frame
= new_frame
;
22093 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22094 or window's point, then we'd need select_window_1 here as well. */
22095 XSETWINDOW (selected_window
, w
);
22096 XFRAME (new_frame
)->selected_window
= selected_window
;
22098 /* These will be set while the mode line specs are processed. */
22099 line_number_displayed
= false;
22100 w
->column_number_displayed
= -1;
22102 if (WINDOW_WANTS_MODELINE_P (w
))
22104 struct window
*sel_w
= XWINDOW (old_selected_window
);
22106 /* Select mode line face based on the real selected window. */
22107 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22108 BVAR (current_buffer
, mode_line_format
));
22112 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22114 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22115 BVAR (current_buffer
, header_line_format
));
22119 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22120 selected_frame
= old_selected_frame
;
22121 selected_window
= old_selected_window
;
22123 w
->must_be_updated_p
= true;
22128 /* Display mode or header line of window W. FACE_ID specifies which
22129 line to display; it is either MODE_LINE_FACE_ID or
22130 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22131 display. Value is the pixel height of the mode/header line
22135 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22139 ptrdiff_t count
= SPECPDL_INDEX ();
22141 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22142 /* Don't extend on a previously drawn mode-line.
22143 This may happen if called from pos_visible_p. */
22144 it
.glyph_row
->enabled_p
= false;
22145 prepare_desired_row (w
, it
.glyph_row
, true);
22147 it
.glyph_row
->mode_line_p
= true;
22149 /* FIXME: This should be controlled by a user option. But
22150 supporting such an option is not trivial, since the mode line is
22151 made up of many separate strings. */
22152 it
.paragraph_embedding
= L2R
;
22154 record_unwind_protect (unwind_format_mode_line
,
22155 format_mode_line_unwind_data (NULL
, NULL
,
22158 mode_line_target
= MODE_LINE_DISPLAY
;
22160 /* Temporarily make frame's keyboard the current kboard so that
22161 kboard-local variables in the mode_line_format will get the right
22163 push_kboard (FRAME_KBOARD (it
.f
));
22164 record_unwind_save_match_data ();
22165 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22168 unbind_to (count
, Qnil
);
22170 /* Fill up with spaces. */
22171 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22173 compute_line_metrics (&it
);
22174 it
.glyph_row
->full_width_p
= true;
22175 it
.glyph_row
->continued_p
= false;
22176 it
.glyph_row
->truncated_on_left_p
= false;
22177 it
.glyph_row
->truncated_on_right_p
= false;
22179 /* Make a 3D mode-line have a shadow at its right end. */
22180 face
= FACE_FROM_ID (it
.f
, face_id
);
22181 extend_face_to_end_of_line (&it
);
22182 if (face
->box
!= FACE_NO_BOX
)
22184 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22185 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22186 last
->right_box_line_p
= true;
22189 return it
.glyph_row
->height
;
22192 /* Move element ELT in LIST to the front of LIST.
22193 Return the updated list. */
22196 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22198 register Lisp_Object tail
, prev
;
22199 register Lisp_Object tem
;
22203 while (CONSP (tail
))
22209 /* Splice out the link TAIL. */
22211 list
= XCDR (tail
);
22213 Fsetcdr (prev
, XCDR (tail
));
22215 /* Now make it the first. */
22216 Fsetcdr (tail
, list
);
22221 tail
= XCDR (tail
);
22225 /* Not found--return unchanged LIST. */
22229 /* Contribute ELT to the mode line for window IT->w. How it
22230 translates into text depends on its data type.
22232 IT describes the display environment in which we display, as usual.
22234 DEPTH is the depth in recursion. It is used to prevent
22235 infinite recursion here.
22237 FIELD_WIDTH is the number of characters the display of ELT should
22238 occupy in the mode line, and PRECISION is the maximum number of
22239 characters to display from ELT's representation. See
22240 display_string for details.
22242 Returns the hpos of the end of the text generated by ELT.
22244 PROPS is a property list to add to any string we encounter.
22246 If RISKY, remove (disregard) any properties in any string
22247 we encounter, and ignore :eval and :propertize.
22249 The global variable `mode_line_target' determines whether the
22250 output is passed to `store_mode_line_noprop',
22251 `store_mode_line_string', or `display_string'. */
22254 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22255 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22257 int n
= 0, field
, prec
;
22258 bool literal
= false;
22262 elt
= build_string ("*too-deep*");
22266 switch (XTYPE (elt
))
22270 /* A string: output it and check for %-constructs within it. */
22272 ptrdiff_t offset
= 0;
22274 if (SCHARS (elt
) > 0
22275 && (!NILP (props
) || risky
))
22277 Lisp_Object oprops
, aelt
;
22278 oprops
= Ftext_properties_at (make_number (0), elt
);
22280 /* If the starting string's properties are not what
22281 we want, translate the string. Also, if the string
22282 is risky, do that anyway. */
22284 if (NILP (Fequal (props
, oprops
)) || risky
)
22286 /* If the starting string has properties,
22287 merge the specified ones onto the existing ones. */
22288 if (! NILP (oprops
) && !risky
)
22292 oprops
= Fcopy_sequence (oprops
);
22294 while (CONSP (tem
))
22296 oprops
= Fplist_put (oprops
, XCAR (tem
),
22297 XCAR (XCDR (tem
)));
22298 tem
= XCDR (XCDR (tem
));
22303 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22304 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22306 /* AELT is what we want. Move it to the front
22307 without consing. */
22309 mode_line_proptrans_alist
22310 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22316 /* If AELT has the wrong props, it is useless.
22317 so get rid of it. */
22319 mode_line_proptrans_alist
22320 = Fdelq (aelt
, mode_line_proptrans_alist
);
22322 elt
= Fcopy_sequence (elt
);
22323 Fset_text_properties (make_number (0), Flength (elt
),
22325 /* Add this item to mode_line_proptrans_alist. */
22326 mode_line_proptrans_alist
22327 = Fcons (Fcons (elt
, props
),
22328 mode_line_proptrans_alist
);
22329 /* Truncate mode_line_proptrans_alist
22330 to at most 50 elements. */
22331 tem
= Fnthcdr (make_number (50),
22332 mode_line_proptrans_alist
);
22334 XSETCDR (tem
, Qnil
);
22343 prec
= precision
- n
;
22344 switch (mode_line_target
)
22346 case MODE_LINE_NOPROP
:
22347 case MODE_LINE_TITLE
:
22348 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22350 case MODE_LINE_STRING
:
22351 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22353 case MODE_LINE_DISPLAY
:
22354 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22355 0, prec
, 0, STRING_MULTIBYTE (elt
));
22362 /* Handle the non-literal case. */
22364 while ((precision
<= 0 || n
< precision
)
22365 && SREF (elt
, offset
) != 0
22366 && (mode_line_target
!= MODE_LINE_DISPLAY
22367 || it
->current_x
< it
->last_visible_x
))
22369 ptrdiff_t last_offset
= offset
;
22371 /* Advance to end of string or next format specifier. */
22372 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22375 if (offset
- 1 != last_offset
)
22377 ptrdiff_t nchars
, nbytes
;
22379 /* Output to end of string or up to '%'. Field width
22380 is length of string. Don't output more than
22381 PRECISION allows us. */
22384 prec
= c_string_width (SDATA (elt
) + last_offset
,
22385 offset
- last_offset
, precision
- n
,
22388 switch (mode_line_target
)
22390 case MODE_LINE_NOPROP
:
22391 case MODE_LINE_TITLE
:
22392 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22394 case MODE_LINE_STRING
:
22396 ptrdiff_t bytepos
= last_offset
;
22397 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22398 ptrdiff_t endpos
= (precision
<= 0
22399 ? string_byte_to_char (elt
, offset
)
22400 : charpos
+ nchars
);
22401 Lisp_Object mode_string
22402 = Fsubstring (elt
, make_number (charpos
),
22403 make_number (endpos
));
22404 n
+= store_mode_line_string (NULL
, mode_string
, false,
22408 case MODE_LINE_DISPLAY
:
22410 ptrdiff_t bytepos
= last_offset
;
22411 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22413 if (precision
<= 0)
22414 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22415 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22417 STRING_MULTIBYTE (elt
));
22422 else /* c == '%' */
22424 ptrdiff_t percent_position
= offset
;
22426 /* Get the specified minimum width. Zero means
22429 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22430 field
= field
* 10 + c
- '0';
22432 /* Don't pad beyond the total padding allowed. */
22433 if (field_width
- n
> 0 && field
> field_width
- n
)
22434 field
= field_width
- n
;
22436 /* Note that either PRECISION <= 0 or N < PRECISION. */
22437 prec
= precision
- n
;
22440 n
+= display_mode_element (it
, depth
, field
, prec
,
22441 Vglobal_mode_string
, props
,
22446 ptrdiff_t bytepos
, charpos
;
22448 Lisp_Object string
;
22450 bytepos
= percent_position
;
22451 charpos
= (STRING_MULTIBYTE (elt
)
22452 ? string_byte_to_char (elt
, bytepos
)
22454 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22455 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22457 switch (mode_line_target
)
22459 case MODE_LINE_NOPROP
:
22460 case MODE_LINE_TITLE
:
22461 n
+= store_mode_line_noprop (spec
, field
, prec
);
22463 case MODE_LINE_STRING
:
22465 Lisp_Object tem
= build_string (spec
);
22466 props
= Ftext_properties_at (make_number (charpos
), elt
);
22467 /* Should only keep face property in props */
22468 n
+= store_mode_line_string (NULL
, tem
, false,
22469 field
, prec
, props
);
22472 case MODE_LINE_DISPLAY
:
22474 int nglyphs_before
, nwritten
;
22476 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22477 nwritten
= display_string (spec
, string
, elt
,
22482 /* Assign to the glyphs written above the
22483 string where the `%x' came from, position
22487 struct glyph
*glyph
22488 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22492 for (i
= 0; i
< nwritten
; ++i
)
22494 glyph
[i
].object
= elt
;
22495 glyph
[i
].charpos
= charpos
;
22512 /* A symbol: process the value of the symbol recursively
22513 as if it appeared here directly. Avoid error if symbol void.
22514 Special case: if value of symbol is a string, output the string
22517 register Lisp_Object tem
;
22519 /* If the variable is not marked as risky to set
22520 then its contents are risky to use. */
22521 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22524 tem
= Fboundp (elt
);
22527 tem
= Fsymbol_value (elt
);
22528 /* If value is a string, output that string literally:
22529 don't check for % within it. */
22533 if (!EQ (tem
, elt
))
22535 /* Give up right away for nil or t. */
22545 register Lisp_Object car
, tem
;
22547 /* A cons cell: five distinct cases.
22548 If first element is :eval or :propertize, do something special.
22549 If first element is a string or a cons, process all the elements
22550 and effectively concatenate them.
22551 If first element is a negative number, truncate displaying cdr to
22552 at most that many characters. If positive, pad (with spaces)
22553 to at least that many characters.
22554 If first element is a symbol, process the cadr or caddr recursively
22555 according to whether the symbol's value is non-nil or nil. */
22557 if (EQ (car
, QCeval
))
22559 /* An element of the form (:eval FORM) means evaluate FORM
22560 and use the result as mode line elements. */
22565 if (CONSP (XCDR (elt
)))
22568 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22569 n
+= display_mode_element (it
, depth
, field_width
- n
,
22570 precision
- n
, spec
, props
,
22574 else if (EQ (car
, QCpropertize
))
22576 /* An element of the form (:propertize ELT PROPS...)
22577 means display ELT but applying properties PROPS. */
22582 if (CONSP (XCDR (elt
)))
22583 n
+= display_mode_element (it
, depth
, field_width
- n
,
22584 precision
- n
, XCAR (XCDR (elt
)),
22585 XCDR (XCDR (elt
)), risky
);
22587 else if (SYMBOLP (car
))
22589 tem
= Fboundp (car
);
22593 /* elt is now the cdr, and we know it is a cons cell.
22594 Use its car if CAR has a non-nil value. */
22597 tem
= Fsymbol_value (car
);
22604 /* Symbol's value is nil (or symbol is unbound)
22605 Get the cddr of the original list
22606 and if possible find the caddr and use that. */
22610 else if (!CONSP (elt
))
22615 else if (INTEGERP (car
))
22617 register int lim
= XINT (car
);
22621 /* Negative int means reduce maximum width. */
22622 if (precision
<= 0)
22625 precision
= min (precision
, -lim
);
22629 /* Padding specified. Don't let it be more than
22630 current maximum. */
22632 lim
= min (precision
, lim
);
22634 /* If that's more padding than already wanted, queue it.
22635 But don't reduce padding already specified even if
22636 that is beyond the current truncation point. */
22637 field_width
= max (lim
, field_width
);
22641 else if (STRINGP (car
) || CONSP (car
))
22643 Lisp_Object halftail
= elt
;
22647 && (precision
<= 0 || n
< precision
))
22649 n
+= display_mode_element (it
, depth
,
22650 /* Do padding only after the last
22651 element in the list. */
22652 (! CONSP (XCDR (elt
))
22655 precision
- n
, XCAR (elt
),
22659 if ((len
& 1) == 0)
22660 halftail
= XCDR (halftail
);
22661 /* Check for cycle. */
22662 if (EQ (halftail
, elt
))
22671 elt
= build_string ("*invalid*");
22675 /* Pad to FIELD_WIDTH. */
22676 if (field_width
> 0 && n
< field_width
)
22678 switch (mode_line_target
)
22680 case MODE_LINE_NOPROP
:
22681 case MODE_LINE_TITLE
:
22682 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22684 case MODE_LINE_STRING
:
22685 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22688 case MODE_LINE_DISPLAY
:
22689 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22698 /* Store a mode-line string element in mode_line_string_list.
22700 If STRING is non-null, display that C string. Otherwise, the Lisp
22701 string LISP_STRING is displayed.
22703 FIELD_WIDTH is the minimum number of output glyphs to produce.
22704 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22705 with spaces. FIELD_WIDTH <= 0 means don't pad.
22707 PRECISION is the maximum number of characters to output from
22708 STRING. PRECISION <= 0 means don't truncate the string.
22710 If COPY_STRING, make a copy of LISP_STRING before adding
22711 properties to the string.
22713 PROPS are the properties to add to the string.
22714 The mode_line_string_face face property is always added to the string.
22718 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22720 int field_width
, int precision
, Lisp_Object props
)
22725 if (string
!= NULL
)
22727 len
= strlen (string
);
22728 if (precision
> 0 && len
> precision
)
22730 lisp_string
= make_string (string
, len
);
22732 props
= mode_line_string_face_prop
;
22733 else if (!NILP (mode_line_string_face
))
22735 Lisp_Object face
= Fplist_get (props
, Qface
);
22736 props
= Fcopy_sequence (props
);
22738 face
= mode_line_string_face
;
22740 face
= list2 (face
, mode_line_string_face
);
22741 props
= Fplist_put (props
, Qface
, face
);
22743 Fadd_text_properties (make_number (0), make_number (len
),
22744 props
, lisp_string
);
22748 len
= XFASTINT (Flength (lisp_string
));
22749 if (precision
> 0 && len
> precision
)
22752 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22755 if (!NILP (mode_line_string_face
))
22759 props
= Ftext_properties_at (make_number (0), lisp_string
);
22760 face
= Fplist_get (props
, Qface
);
22762 face
= mode_line_string_face
;
22764 face
= list2 (face
, mode_line_string_face
);
22765 props
= list2 (Qface
, face
);
22767 lisp_string
= Fcopy_sequence (lisp_string
);
22770 Fadd_text_properties (make_number (0), make_number (len
),
22771 props
, lisp_string
);
22776 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22780 if (field_width
> len
)
22782 field_width
-= len
;
22783 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22785 Fadd_text_properties (make_number (0), make_number (field_width
),
22786 props
, lisp_string
);
22787 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22795 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22797 doc
: /* Format a string out of a mode line format specification.
22798 First arg FORMAT specifies the mode line format (see `mode-line-format'
22799 for details) to use.
22801 By default, the format is evaluated for the currently selected window.
22803 Optional second arg FACE specifies the face property to put on all
22804 characters for which no face is specified. The value nil means the
22805 default face. The value t means whatever face the window's mode line
22806 currently uses (either `mode-line' or `mode-line-inactive',
22807 depending on whether the window is the selected window or not).
22808 An integer value means the value string has no text
22811 Optional third and fourth args WINDOW and BUFFER specify the window
22812 and buffer to use as the context for the formatting (defaults
22813 are the selected window and the WINDOW's buffer). */)
22814 (Lisp_Object format
, Lisp_Object face
,
22815 Lisp_Object window
, Lisp_Object buffer
)
22820 struct buffer
*old_buffer
= NULL
;
22822 bool no_props
= INTEGERP (face
);
22823 ptrdiff_t count
= SPECPDL_INDEX ();
22825 int string_start
= 0;
22827 w
= decode_any_window (window
);
22828 XSETWINDOW (window
, w
);
22831 buffer
= w
->contents
;
22832 CHECK_BUFFER (buffer
);
22834 /* Make formatting the modeline a non-op when noninteractive, otherwise
22835 there will be problems later caused by a partially initialized frame. */
22836 if (NILP (format
) || noninteractive
)
22837 return empty_unibyte_string
;
22842 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22843 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22844 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22845 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22846 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22847 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22848 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22851 old_buffer
= current_buffer
;
22853 /* Save things including mode_line_proptrans_alist,
22854 and set that to nil so that we don't alter the outer value. */
22855 record_unwind_protect (unwind_format_mode_line
,
22856 format_mode_line_unwind_data
22857 (XFRAME (WINDOW_FRAME (w
)),
22858 old_buffer
, selected_window
, true));
22859 mode_line_proptrans_alist
= Qnil
;
22861 Fselect_window (window
, Qt
);
22862 set_buffer_internal_1 (XBUFFER (buffer
));
22864 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22868 mode_line_target
= MODE_LINE_NOPROP
;
22869 mode_line_string_face_prop
= Qnil
;
22870 mode_line_string_list
= Qnil
;
22871 string_start
= MODE_LINE_NOPROP_LEN (0);
22875 mode_line_target
= MODE_LINE_STRING
;
22876 mode_line_string_list
= Qnil
;
22877 mode_line_string_face
= face
;
22878 mode_line_string_face_prop
22879 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22882 push_kboard (FRAME_KBOARD (it
.f
));
22883 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22888 len
= MODE_LINE_NOPROP_LEN (string_start
);
22889 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22893 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22894 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22895 empty_unibyte_string
);
22898 unbind_to (count
, Qnil
);
22902 /* Write a null-terminated, right justified decimal representation of
22903 the positive integer D to BUF using a minimal field width WIDTH. */
22906 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22908 register char *p
= buf
;
22916 *p
++ = d
% 10 + '0';
22921 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22932 /* Write a null-terminated, right justified decimal and "human
22933 readable" representation of the nonnegative integer D to BUF using
22934 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22936 static const char power_letter
[] =
22950 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22952 /* We aim to represent the nonnegative integer D as
22953 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22954 ptrdiff_t quotient
= d
;
22956 /* -1 means: do not use TENTHS. */
22960 /* Length of QUOTIENT.TENTHS as a string. */
22966 if (quotient
>= 1000)
22968 /* Scale to the appropriate EXPONENT. */
22971 remainder
= quotient
% 1000;
22975 while (quotient
>= 1000);
22977 /* Round to nearest and decide whether to use TENTHS or not. */
22980 tenths
= remainder
/ 100;
22981 if (remainder
% 100 >= 50)
22988 if (quotient
== 10)
22996 if (remainder
>= 500)
22998 if (quotient
< 999)
23009 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23010 if (tenths
== -1 && quotient
<= 99)
23017 p
= psuffix
= buf
+ max (width
, length
);
23019 /* Print EXPONENT. */
23020 *psuffix
++ = power_letter
[exponent
];
23023 /* Print TENTHS. */
23026 *--p
= '0' + tenths
;
23030 /* Print QUOTIENT. */
23033 int digit
= quotient
% 10;
23034 *--p
= '0' + digit
;
23036 while ((quotient
/= 10) != 0);
23038 /* Print leading spaces. */
23043 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23044 If EOL_FLAG, set also a mnemonic character for end-of-line
23045 type of CODING_SYSTEM. Return updated pointer into BUF. */
23047 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23050 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23053 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23054 const unsigned char *eol_str
;
23056 /* The EOL conversion we are using. */
23057 Lisp_Object eoltype
;
23059 val
= CODING_SYSTEM_SPEC (coding_system
);
23062 if (!VECTORP (val
)) /* Not yet decided. */
23064 *buf
++ = multibyte
? '-' : ' ';
23066 eoltype
= eol_mnemonic_undecided
;
23067 /* Don't mention EOL conversion if it isn't decided. */
23072 Lisp_Object eolvalue
;
23074 attrs
= AREF (val
, 0);
23075 eolvalue
= AREF (val
, 2);
23078 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23083 /* The EOL conversion that is normal on this system. */
23085 if (NILP (eolvalue
)) /* Not yet decided. */
23086 eoltype
= eol_mnemonic_undecided
;
23087 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23088 eoltype
= eol_mnemonic_undecided
;
23089 else /* eolvalue is Qunix, Qdos, or Qmac. */
23090 eoltype
= (EQ (eolvalue
, Qunix
)
23091 ? eol_mnemonic_unix
23092 : EQ (eolvalue
, Qdos
)
23093 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23099 /* Mention the EOL conversion if it is not the usual one. */
23100 if (STRINGP (eoltype
))
23102 eol_str
= SDATA (eoltype
);
23103 eol_str_len
= SBYTES (eoltype
);
23105 else if (CHARACTERP (eoltype
))
23107 int c
= XFASTINT (eoltype
);
23108 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23112 eol_str
= invalid_eol_type
;
23113 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23115 memcpy (buf
, eol_str
, eol_str_len
);
23116 buf
+= eol_str_len
;
23122 /* Return a string for the output of a mode line %-spec for window W,
23123 generated by character C. FIELD_WIDTH > 0 means pad the string
23124 returned with spaces to that value. Return a Lisp string in
23125 *STRING if the resulting string is taken from that Lisp string.
23127 Note we operate on the current buffer for most purposes. */
23129 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23131 static const char *
23132 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23133 Lisp_Object
*string
)
23136 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23137 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23138 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23139 produce strings from numerical values, so limit preposterously
23140 large values of FIELD_WIDTH to avoid overrunning the buffer's
23141 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23142 bytes plus the terminating null. */
23143 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23144 struct buffer
*b
= current_buffer
;
23152 if (!NILP (BVAR (b
, read_only
)))
23154 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23159 /* This differs from %* only for a modified read-only buffer. */
23160 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23162 if (!NILP (BVAR (b
, read_only
)))
23167 /* This differs from %* in ignoring read-only-ness. */
23168 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23180 if (command_loop_level
> 5)
23182 p
= decode_mode_spec_buf
;
23183 for (i
= 0; i
< command_loop_level
; i
++)
23186 return decode_mode_spec_buf
;
23194 if (command_loop_level
> 5)
23196 p
= decode_mode_spec_buf
;
23197 for (i
= 0; i
< command_loop_level
; i
++)
23200 return decode_mode_spec_buf
;
23207 /* Let lots_of_dashes be a string of infinite length. */
23208 if (mode_line_target
== MODE_LINE_NOPROP
23209 || mode_line_target
== MODE_LINE_STRING
)
23211 if (field_width
<= 0
23212 || field_width
> sizeof (lots_of_dashes
))
23214 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23215 decode_mode_spec_buf
[i
] = '-';
23216 decode_mode_spec_buf
[i
] = '\0';
23217 return decode_mode_spec_buf
;
23220 return lots_of_dashes
;
23224 obj
= BVAR (b
, name
);
23228 /* %c and %l are ignored in `frame-title-format'.
23229 (In redisplay_internal, the frame title is drawn _before_ the
23230 windows are updated, so the stuff which depends on actual
23231 window contents (such as %l) may fail to render properly, or
23232 even crash emacs.) */
23233 if (mode_line_target
== MODE_LINE_TITLE
)
23237 ptrdiff_t col
= current_column ();
23238 w
->column_number_displayed
= col
;
23239 pint2str (decode_mode_spec_buf
, width
, col
);
23240 return decode_mode_spec_buf
;
23244 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23246 if (NILP (Vmemory_full
))
23249 return "!MEM FULL! ";
23256 /* %F displays the frame name. */
23257 if (!NILP (f
->title
))
23258 return SSDATA (f
->title
);
23259 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23260 return SSDATA (f
->name
);
23264 obj
= BVAR (b
, filename
);
23269 ptrdiff_t size
= ZV
- BEGV
;
23270 pint2str (decode_mode_spec_buf
, width
, size
);
23271 return decode_mode_spec_buf
;
23276 ptrdiff_t size
= ZV
- BEGV
;
23277 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23278 return decode_mode_spec_buf
;
23283 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23284 ptrdiff_t topline
, nlines
, height
;
23287 /* %c and %l are ignored in `frame-title-format'. */
23288 if (mode_line_target
== MODE_LINE_TITLE
)
23291 startpos
= marker_position (w
->start
);
23292 startpos_byte
= marker_byte_position (w
->start
);
23293 height
= WINDOW_TOTAL_LINES (w
);
23295 /* If we decided that this buffer isn't suitable for line numbers,
23296 don't forget that too fast. */
23297 if (w
->base_line_pos
== -1)
23300 /* If the buffer is very big, don't waste time. */
23301 if (INTEGERP (Vline_number_display_limit
)
23302 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23304 w
->base_line_pos
= 0;
23305 w
->base_line_number
= 0;
23309 if (w
->base_line_number
> 0
23310 && w
->base_line_pos
> 0
23311 && w
->base_line_pos
<= startpos
)
23313 line
= w
->base_line_number
;
23314 linepos
= w
->base_line_pos
;
23315 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23320 linepos
= BUF_BEGV (b
);
23321 linepos_byte
= BUF_BEGV_BYTE (b
);
23324 /* Count lines from base line to window start position. */
23325 nlines
= display_count_lines (linepos_byte
,
23329 topline
= nlines
+ line
;
23331 /* Determine a new base line, if the old one is too close
23332 or too far away, or if we did not have one.
23333 "Too close" means it's plausible a scroll-down would
23334 go back past it. */
23335 if (startpos
== BUF_BEGV (b
))
23337 w
->base_line_number
= topline
;
23338 w
->base_line_pos
= BUF_BEGV (b
);
23340 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23341 || linepos
== BUF_BEGV (b
))
23343 ptrdiff_t limit
= BUF_BEGV (b
);
23344 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23345 ptrdiff_t position
;
23346 ptrdiff_t distance
=
23347 (height
* 2 + 30) * line_number_display_limit_width
;
23349 if (startpos
- distance
> limit
)
23351 limit
= startpos
- distance
;
23352 limit_byte
= CHAR_TO_BYTE (limit
);
23355 nlines
= display_count_lines (startpos_byte
,
23357 - (height
* 2 + 30),
23359 /* If we couldn't find the lines we wanted within
23360 line_number_display_limit_width chars per line,
23361 give up on line numbers for this window. */
23362 if (position
== limit_byte
&& limit
== startpos
- distance
)
23364 w
->base_line_pos
= -1;
23365 w
->base_line_number
= 0;
23369 w
->base_line_number
= topline
- nlines
;
23370 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23373 /* Now count lines from the start pos to point. */
23374 nlines
= display_count_lines (startpos_byte
,
23375 PT_BYTE
, PT
, &junk
);
23377 /* Record that we did display the line number. */
23378 line_number_displayed
= true;
23380 /* Make the string to show. */
23381 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23382 return decode_mode_spec_buf
;
23385 char *p
= decode_mode_spec_buf
;
23386 int pad
= width
- 2;
23392 return decode_mode_spec_buf
;
23398 obj
= BVAR (b
, mode_name
);
23402 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23408 ptrdiff_t pos
= marker_position (w
->start
);
23409 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23411 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23413 if (pos
<= BUF_BEGV (b
))
23418 else if (pos
<= BUF_BEGV (b
))
23422 if (total
> 1000000)
23423 /* Do it differently for a large value, to avoid overflow. */
23424 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23426 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23427 /* We can't normally display a 3-digit number,
23428 so get us a 2-digit number that is close. */
23431 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23432 return decode_mode_spec_buf
;
23436 /* Display percentage of size above the bottom of the screen. */
23439 ptrdiff_t toppos
= marker_position (w
->start
);
23440 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23441 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23443 if (botpos
>= BUF_ZV (b
))
23445 if (toppos
<= BUF_BEGV (b
))
23452 if (total
> 1000000)
23453 /* Do it differently for a large value, to avoid overflow. */
23454 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23456 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23457 /* We can't normally display a 3-digit number,
23458 so get us a 2-digit number that is close. */
23461 if (toppos
<= BUF_BEGV (b
))
23462 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23464 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23465 return decode_mode_spec_buf
;
23470 /* status of process */
23471 obj
= Fget_buffer_process (Fcurrent_buffer ());
23473 return "no process";
23475 obj
= Fsymbol_name (Fprocess_status (obj
));
23481 ptrdiff_t count
= inhibit_garbage_collection ();
23482 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23483 Lisp_Object val
= Qnil
;
23485 if (STRINGP (curdir
))
23486 val
= call1 (intern ("file-remote-p"), curdir
);
23488 unbind_to (count
, Qnil
);
23497 /* coding-system (not including end-of-line format) */
23499 /* coding-system (including end-of-line type) */
23501 bool eol_flag
= (c
== 'Z');
23502 char *p
= decode_mode_spec_buf
;
23504 if (! FRAME_WINDOW_P (f
))
23506 /* No need to mention EOL here--the terminal never needs
23507 to do EOL conversion. */
23508 p
= decode_mode_spec_coding (CODING_ID_NAME
23509 (FRAME_KEYBOARD_CODING (f
)->id
),
23511 p
= decode_mode_spec_coding (CODING_ID_NAME
23512 (FRAME_TERMINAL_CODING (f
)->id
),
23515 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23518 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23519 #ifdef subprocesses
23520 obj
= Fget_buffer_process (Fcurrent_buffer ());
23521 if (PROCESSP (obj
))
23523 p
= decode_mode_spec_coding
23524 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23525 p
= decode_mode_spec_coding
23526 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23528 #endif /* subprocesses */
23531 return decode_mode_spec_buf
;
23538 return SSDATA (obj
);
23545 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23546 means count lines back from START_BYTE. But don't go beyond
23547 LIMIT_BYTE. Return the number of lines thus found (always
23550 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23551 either the position COUNT lines after/before START_BYTE, if we
23552 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23556 display_count_lines (ptrdiff_t start_byte
,
23557 ptrdiff_t limit_byte
, ptrdiff_t count
,
23558 ptrdiff_t *byte_pos_ptr
)
23560 register unsigned char *cursor
;
23561 unsigned char *base
;
23563 register ptrdiff_t ceiling
;
23564 register unsigned char *ceiling_addr
;
23565 ptrdiff_t orig_count
= count
;
23567 /* If we are not in selective display mode,
23568 check only for newlines. */
23569 bool selective_display
23570 = (!NILP (BVAR (current_buffer
, selective_display
))
23571 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23575 while (start_byte
< limit_byte
)
23577 ceiling
= BUFFER_CEILING_OF (start_byte
);
23578 ceiling
= min (limit_byte
- 1, ceiling
);
23579 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23580 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23584 if (selective_display
)
23586 while (*cursor
!= '\n' && *cursor
!= 015
23587 && ++cursor
!= ceiling_addr
)
23589 if (cursor
== ceiling_addr
)
23594 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23603 start_byte
+= cursor
- base
;
23604 *byte_pos_ptr
= start_byte
;
23608 while (cursor
< ceiling_addr
);
23610 start_byte
+= ceiling_addr
- base
;
23615 while (start_byte
> limit_byte
)
23617 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23618 ceiling
= max (limit_byte
, ceiling
);
23619 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23620 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23623 if (selective_display
)
23625 while (--cursor
>= ceiling_addr
23626 && *cursor
!= '\n' && *cursor
!= 015)
23628 if (cursor
< ceiling_addr
)
23633 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23640 start_byte
+= cursor
- base
+ 1;
23641 *byte_pos_ptr
= start_byte
;
23642 /* When scanning backwards, we should
23643 not count the newline posterior to which we stop. */
23644 return - orig_count
- 1;
23647 start_byte
+= ceiling_addr
- base
;
23651 *byte_pos_ptr
= limit_byte
;
23654 return - orig_count
+ count
;
23655 return orig_count
- count
;
23661 /***********************************************************************
23663 ***********************************************************************/
23665 /* Display a NUL-terminated string, starting with index START.
23667 If STRING is non-null, display that C string. Otherwise, the Lisp
23668 string LISP_STRING is displayed. There's a case that STRING is
23669 non-null and LISP_STRING is not nil. It means STRING is a string
23670 data of LISP_STRING. In that case, we display LISP_STRING while
23671 ignoring its text properties.
23673 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23674 FACE_STRING. Display STRING or LISP_STRING with the face at
23675 FACE_STRING_POS in FACE_STRING:
23677 Display the string in the environment given by IT, but use the
23678 standard display table, temporarily.
23680 FIELD_WIDTH is the minimum number of output glyphs to produce.
23681 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23682 with spaces. If STRING has more characters, more than FIELD_WIDTH
23683 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23685 PRECISION is the maximum number of characters to output from
23686 STRING. PRECISION < 0 means don't truncate the string.
23688 This is roughly equivalent to printf format specifiers:
23690 FIELD_WIDTH PRECISION PRINTF
23691 ----------------------------------------
23697 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23698 display them, and < 0 means obey the current buffer's value of
23699 enable_multibyte_characters.
23701 Value is the number of columns displayed. */
23704 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23705 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23706 int field_width
, int precision
, int max_x
, int multibyte
)
23708 int hpos_at_start
= it
->hpos
;
23709 int saved_face_id
= it
->face_id
;
23710 struct glyph_row
*row
= it
->glyph_row
;
23711 ptrdiff_t it_charpos
;
23713 /* Initialize the iterator IT for iteration over STRING beginning
23714 with index START. */
23715 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23716 precision
, field_width
, multibyte
);
23717 if (string
&& STRINGP (lisp_string
))
23718 /* LISP_STRING is the one returned by decode_mode_spec. We should
23719 ignore its text properties. */
23720 it
->stop_charpos
= it
->end_charpos
;
23722 /* If displaying STRING, set up the face of the iterator from
23723 FACE_STRING, if that's given. */
23724 if (STRINGP (face_string
))
23730 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23731 0, &endptr
, it
->base_face_id
, false);
23732 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23733 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23736 /* Set max_x to the maximum allowed X position. Don't let it go
23737 beyond the right edge of the window. */
23739 max_x
= it
->last_visible_x
;
23741 max_x
= min (max_x
, it
->last_visible_x
);
23743 /* Skip over display elements that are not visible. because IT->w is
23745 if (it
->current_x
< it
->first_visible_x
)
23746 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23747 MOVE_TO_POS
| MOVE_TO_X
);
23749 row
->ascent
= it
->max_ascent
;
23750 row
->height
= it
->max_ascent
+ it
->max_descent
;
23751 row
->phys_ascent
= it
->max_phys_ascent
;
23752 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23753 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23755 if (STRINGP (it
->string
))
23756 it_charpos
= IT_STRING_CHARPOS (*it
);
23758 it_charpos
= IT_CHARPOS (*it
);
23760 /* This condition is for the case that we are called with current_x
23761 past last_visible_x. */
23762 while (it
->current_x
< max_x
)
23764 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23766 /* Get the next display element. */
23767 if (!get_next_display_element (it
))
23770 /* Produce glyphs. */
23771 x_before
= it
->current_x
;
23772 n_glyphs_before
= row
->used
[TEXT_AREA
];
23773 PRODUCE_GLYPHS (it
);
23775 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23778 while (i
< nglyphs
)
23780 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23782 if (it
->line_wrap
!= TRUNCATE
23783 && x
+ glyph
->pixel_width
> max_x
)
23785 /* End of continued line or max_x reached. */
23786 if (CHAR_GLYPH_PADDING_P (*glyph
))
23788 /* A wide character is unbreakable. */
23789 if (row
->reversed_p
)
23790 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23791 - n_glyphs_before
);
23792 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23793 it
->current_x
= x_before
;
23797 if (row
->reversed_p
)
23798 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23799 - (n_glyphs_before
+ i
));
23800 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23805 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23807 /* Glyph is at least partially visible. */
23809 if (x
< it
->first_visible_x
)
23810 row
->x
= x
- it
->first_visible_x
;
23814 /* Glyph is off the left margin of the display area.
23815 Should not happen. */
23819 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23820 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23821 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23822 row
->phys_height
= max (row
->phys_height
,
23823 it
->max_phys_ascent
+ it
->max_phys_descent
);
23824 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23825 it
->max_extra_line_spacing
);
23826 x
+= glyph
->pixel_width
;
23830 /* Stop if max_x reached. */
23834 /* Stop at line ends. */
23835 if (ITERATOR_AT_END_OF_LINE_P (it
))
23837 it
->continuation_lines_width
= 0;
23841 set_iterator_to_next (it
, true);
23842 if (STRINGP (it
->string
))
23843 it_charpos
= IT_STRING_CHARPOS (*it
);
23845 it_charpos
= IT_CHARPOS (*it
);
23847 /* Stop if truncating at the right edge. */
23848 if (it
->line_wrap
== TRUNCATE
23849 && it
->current_x
>= it
->last_visible_x
)
23851 /* Add truncation mark, but don't do it if the line is
23852 truncated at a padding space. */
23853 if (it_charpos
< it
->string_nchars
)
23855 if (!FRAME_WINDOW_P (it
->f
))
23859 if (it
->current_x
> it
->last_visible_x
)
23861 if (!row
->reversed_p
)
23863 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23864 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23869 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23870 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23872 unproduce_glyphs (it
, ii
+ 1);
23873 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23875 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23877 row
->used
[TEXT_AREA
] = ii
;
23878 produce_special_glyphs (it
, IT_TRUNCATION
);
23881 produce_special_glyphs (it
, IT_TRUNCATION
);
23883 row
->truncated_on_right_p
= true;
23889 /* Maybe insert a truncation at the left. */
23890 if (it
->first_visible_x
23893 if (!FRAME_WINDOW_P (it
->f
)
23894 || (row
->reversed_p
23895 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23896 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23897 insert_left_trunc_glyphs (it
);
23898 row
->truncated_on_left_p
= true;
23901 it
->face_id
= saved_face_id
;
23903 /* Value is number of columns displayed. */
23904 return it
->hpos
- hpos_at_start
;
23909 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23910 appears as an element of LIST or as the car of an element of LIST.
23911 If PROPVAL is a list, compare each element against LIST in that
23912 way, and return 1/2 if any element of PROPVAL is found in LIST.
23913 Otherwise return 0. This function cannot quit.
23914 The return value is 2 if the text is invisible but with an ellipsis
23915 and 1 if it's invisible and without an ellipsis. */
23918 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23920 Lisp_Object tail
, proptail
;
23922 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23924 register Lisp_Object tem
;
23926 if (EQ (propval
, tem
))
23928 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23929 return NILP (XCDR (tem
)) ? 1 : 2;
23932 if (CONSP (propval
))
23934 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23936 Lisp_Object propelt
;
23937 propelt
= XCAR (proptail
);
23938 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23940 register Lisp_Object tem
;
23942 if (EQ (propelt
, tem
))
23944 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23945 return NILP (XCDR (tem
)) ? 1 : 2;
23953 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23954 doc
: /* Non-nil if the property makes the text invisible.
23955 POS-OR-PROP can be a marker or number, in which case it is taken to be
23956 a position in the current buffer and the value of the `invisible' property
23957 is checked; or it can be some other value, which is then presumed to be the
23958 value of the `invisible' property of the text of interest.
23959 The non-nil value returned can be t for truly invisible text or something
23960 else if the text is replaced by an ellipsis. */)
23961 (Lisp_Object pos_or_prop
)
23964 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23965 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23967 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23968 return (invis
== 0 ? Qnil
23970 : make_number (invis
));
23973 /* Calculate a width or height in pixels from a specification using
23974 the following elements:
23977 NUM - a (fractional) multiple of the default font width/height
23978 (NUM) - specifies exactly NUM pixels
23979 UNIT - a fixed number of pixels, see below.
23980 ELEMENT - size of a display element in pixels, see below.
23981 (NUM . SPEC) - equals NUM * SPEC
23982 (+ SPEC SPEC ...) - add pixel values
23983 (- SPEC SPEC ...) - subtract pixel values
23984 (- SPEC) - negate pixel value
23987 INT or FLOAT - a number constant
23988 SYMBOL - use symbol's (buffer local) variable binding.
23991 in - pixels per inch *)
23992 mm - pixels per 1/1000 meter *)
23993 cm - pixels per 1/100 meter *)
23994 width - width of current font in pixels.
23995 height - height of current font in pixels.
23997 *) using the ratio(s) defined in display-pixels-per-inch.
24001 left-fringe - left fringe width in pixels
24002 right-fringe - right fringe width in pixels
24004 left-margin - left margin width in pixels
24005 right-margin - right margin width in pixels
24007 scroll-bar - scroll-bar area width in pixels
24011 Pixels corresponding to 5 inches:
24014 Total width of non-text areas on left side of window (if scroll-bar is on left):
24015 '(space :width (+ left-fringe left-margin scroll-bar))
24017 Align to first text column (in header line):
24018 '(space :align-to 0)
24020 Align to middle of text area minus half the width of variable `my-image'
24021 containing a loaded image:
24022 '(space :align-to (0.5 . (- text my-image)))
24024 Width of left margin minus width of 1 character in the default font:
24025 '(space :width (- left-margin 1))
24027 Width of left margin minus width of 2 characters in the current font:
24028 '(space :width (- left-margin (2 . width)))
24030 Center 1 character over left-margin (in header line):
24031 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24033 Different ways to express width of left fringe plus left margin minus one pixel:
24034 '(space :width (- (+ left-fringe left-margin) (1)))
24035 '(space :width (+ left-fringe left-margin (- (1))))
24036 '(space :width (+ left-fringe left-margin (-1)))
24041 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24042 struct font
*font
, bool width_p
, int *align_to
)
24046 # define OK_PIXELS(val) (*res = (val), true)
24047 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24050 return OK_PIXELS (0);
24052 eassert (FRAME_LIVE_P (it
->f
));
24054 if (SYMBOLP (prop
))
24056 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24058 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24060 if (unit
[0] == 'i' && unit
[1] == 'n')
24062 else if (unit
[0] == 'm' && unit
[1] == 'm')
24064 else if (unit
[0] == 'c' && unit
[1] == 'm')
24070 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24071 : FRAME_RES_Y (it
->f
));
24074 return OK_PIXELS (ppi
/ pixels
);
24079 #ifdef HAVE_WINDOW_SYSTEM
24080 if (EQ (prop
, Qheight
))
24081 return OK_PIXELS (font
24082 ? normal_char_height (font
, -1)
24083 : FRAME_LINE_HEIGHT (it
->f
));
24084 if (EQ (prop
, Qwidth
))
24085 return OK_PIXELS (font
24086 ? FONT_WIDTH (font
)
24087 : FRAME_COLUMN_WIDTH (it
->f
));
24089 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24090 return OK_PIXELS (1);
24093 if (EQ (prop
, Qtext
))
24094 return OK_PIXELS (width_p
24095 ? window_box_width (it
->w
, TEXT_AREA
)
24096 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24098 if (align_to
&& *align_to
< 0)
24101 if (EQ (prop
, Qleft
))
24102 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24103 if (EQ (prop
, Qright
))
24104 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24105 if (EQ (prop
, Qcenter
))
24106 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24107 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24108 if (EQ (prop
, Qleft_fringe
))
24109 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24110 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24111 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24112 if (EQ (prop
, Qright_fringe
))
24113 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24114 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24115 : window_box_right_offset (it
->w
, TEXT_AREA
));
24116 if (EQ (prop
, Qleft_margin
))
24117 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24118 if (EQ (prop
, Qright_margin
))
24119 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24120 if (EQ (prop
, Qscroll_bar
))
24121 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24123 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24124 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24125 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24130 if (EQ (prop
, Qleft_fringe
))
24131 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24132 if (EQ (prop
, Qright_fringe
))
24133 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24134 if (EQ (prop
, Qleft_margin
))
24135 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24136 if (EQ (prop
, Qright_margin
))
24137 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24138 if (EQ (prop
, Qscroll_bar
))
24139 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24142 prop
= buffer_local_value (prop
, it
->w
->contents
);
24143 if (EQ (prop
, Qunbound
))
24147 if (NUMBERP (prop
))
24149 int base_unit
= (width_p
24150 ? FRAME_COLUMN_WIDTH (it
->f
)
24151 : FRAME_LINE_HEIGHT (it
->f
));
24152 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24157 Lisp_Object car
= XCAR (prop
);
24158 Lisp_Object cdr
= XCDR (prop
);
24162 #ifdef HAVE_WINDOW_SYSTEM
24163 if (FRAME_WINDOW_P (it
->f
)
24164 && valid_image_p (prop
))
24166 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24167 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24169 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24172 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24178 while (CONSP (cdr
))
24180 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24181 font
, width_p
, align_to
))
24184 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24189 if (EQ (car
, Qminus
))
24191 return OK_PIXELS (pixels
);
24194 car
= buffer_local_value (car
, it
->w
->contents
);
24195 if (EQ (car
, Qunbound
))
24202 pixels
= XFLOATINT (car
);
24204 return OK_PIXELS (pixels
);
24205 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24206 font
, width_p
, align_to
))
24207 return OK_PIXELS (pixels
* fact
);
24218 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24220 #ifdef HAVE_WINDOW_SYSTEM
24221 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24229 /***********************************************************************
24231 ***********************************************************************/
24233 #ifdef HAVE_WINDOW_SYSTEM
24238 dump_glyph_string (struct glyph_string
*s
)
24240 fprintf (stderr
, "glyph string\n");
24241 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24242 s
->x
, s
->y
, s
->width
, s
->height
);
24243 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24244 fprintf (stderr
, " hl = %d\n", s
->hl
);
24245 fprintf (stderr
, " left overhang = %d, right = %d\n",
24246 s
->left_overhang
, s
->right_overhang
);
24247 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24248 fprintf (stderr
, " extends to end of line = %d\n",
24249 s
->extends_to_end_of_line_p
);
24250 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24251 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24254 #endif /* GLYPH_DEBUG */
24256 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24257 of XChar2b structures for S; it can't be allocated in
24258 init_glyph_string because it must be allocated via `alloca'. W
24259 is the window on which S is drawn. ROW and AREA are the glyph row
24260 and area within the row from which S is constructed. START is the
24261 index of the first glyph structure covered by S. HL is a
24262 face-override for drawing S. */
24265 #define OPTIONAL_HDC(hdc) HDC hdc,
24266 #define DECLARE_HDC(hdc) HDC hdc;
24267 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24268 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24271 #ifndef OPTIONAL_HDC
24272 #define OPTIONAL_HDC(hdc)
24273 #define DECLARE_HDC(hdc)
24274 #define ALLOCATE_HDC(hdc, f)
24275 #define RELEASE_HDC(hdc, f)
24279 init_glyph_string (struct glyph_string
*s
,
24281 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24282 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24284 memset (s
, 0, sizeof *s
);
24286 s
->f
= XFRAME (w
->frame
);
24290 s
->display
= FRAME_X_DISPLAY (s
->f
);
24291 s
->window
= FRAME_X_WINDOW (s
->f
);
24292 s
->char2b
= char2b
;
24296 s
->first_glyph
= row
->glyphs
[area
] + start
;
24297 s
->height
= row
->height
;
24298 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24299 s
->ybase
= s
->y
+ row
->ascent
;
24303 /* Append the list of glyph strings with head H and tail T to the list
24304 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24307 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24308 struct glyph_string
*h
, struct glyph_string
*t
)
24322 /* Prepend the list of glyph strings with head H and tail T to the
24323 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24327 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24328 struct glyph_string
*h
, struct glyph_string
*t
)
24342 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24343 Set *HEAD and *TAIL to the resulting list. */
24346 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24347 struct glyph_string
*s
)
24349 s
->next
= s
->prev
= NULL
;
24350 append_glyph_string_lists (head
, tail
, s
, s
);
24354 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24355 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24356 make sure that X resources for the face returned are allocated.
24357 Value is a pointer to a realized face that is ready for display if
24360 static struct face
*
24361 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24362 XChar2b
*char2b
, bool display_p
)
24364 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24369 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24371 if (code
== FONT_INVALID_CODE
)
24374 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24376 /* Make sure X resources of the face are allocated. */
24377 #ifdef HAVE_X_WINDOWS
24381 eassert (face
!= NULL
);
24382 prepare_face_for_display (f
, face
);
24389 /* Get face and two-byte form of character glyph GLYPH on frame F.
24390 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24391 a pointer to a realized face that is ready for display. */
24393 static struct face
*
24394 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24400 eassert (glyph
->type
== CHAR_GLYPH
);
24401 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24403 /* Make sure X resources of the face are allocated. */
24404 eassert (face
!= NULL
);
24405 prepare_face_for_display (f
, face
);
24409 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24410 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24412 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24414 if (code
== FONT_INVALID_CODE
)
24418 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24423 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24424 Return true iff FONT has a glyph for C. */
24427 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24431 if (CHAR_BYTE8_P (c
))
24432 code
= CHAR_TO_BYTE8 (c
);
24434 code
= font
->driver
->encode_char (font
, c
);
24436 if (code
== FONT_INVALID_CODE
)
24438 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24443 /* Fill glyph string S with composition components specified by S->cmp.
24445 BASE_FACE is the base face of the composition.
24446 S->cmp_from is the index of the first component for S.
24448 OVERLAPS non-zero means S should draw the foreground only, and use
24449 its physical height for clipping. See also draw_glyphs.
24451 Value is the index of a component not in S. */
24454 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24458 /* For all glyphs of this composition, starting at the offset
24459 S->cmp_from, until we reach the end of the definition or encounter a
24460 glyph that requires the different face, add it to S. */
24465 s
->for_overlaps
= overlaps
;
24468 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24470 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24472 /* TAB in a composition means display glyphs with padding space
24473 on the left or right. */
24476 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24479 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24480 s
->char2b
+ i
, true);
24486 s
->font
= s
->face
->font
;
24488 else if (s
->face
!= face
)
24496 if (s
->face
== NULL
)
24498 s
->face
= base_face
->ascii_face
;
24499 s
->font
= s
->face
->font
;
24502 /* All glyph strings for the same composition has the same width,
24503 i.e. the width set for the first component of the composition. */
24504 s
->width
= s
->first_glyph
->pixel_width
;
24506 /* If the specified font could not be loaded, use the frame's
24507 default font, but record the fact that we couldn't load it in
24508 the glyph string so that we can draw rectangles for the
24509 characters of the glyph string. */
24510 if (s
->font
== NULL
)
24512 s
->font_not_found_p
= true;
24513 s
->font
= FRAME_FONT (s
->f
);
24516 /* Adjust base line for subscript/superscript text. */
24517 s
->ybase
+= s
->first_glyph
->voffset
;
24523 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24524 int start
, int end
, int overlaps
)
24526 struct glyph
*glyph
, *last
;
24527 Lisp_Object lgstring
;
24530 s
->for_overlaps
= overlaps
;
24531 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24532 last
= s
->row
->glyphs
[s
->area
] + end
;
24533 s
->cmp_id
= glyph
->u
.cmp
.id
;
24534 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24535 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24536 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24537 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24538 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24540 while (glyph
< last
24541 && glyph
->u
.cmp
.automatic
24542 && glyph
->u
.cmp
.id
== s
->cmp_id
24543 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24544 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24546 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24548 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24549 unsigned code
= LGLYPH_CODE (lglyph
);
24551 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24553 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24554 return glyph
- s
->row
->glyphs
[s
->area
];
24558 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24559 See the comment of fill_glyph_string for arguments.
24560 Value is the index of the first glyph not in S. */
24564 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24565 int start
, int end
, int overlaps
)
24567 struct glyph
*glyph
, *last
;
24570 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24571 s
->for_overlaps
= overlaps
;
24572 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24573 last
= s
->row
->glyphs
[s
->area
] + end
;
24574 voffset
= glyph
->voffset
;
24575 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24576 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24578 s
->width
= glyph
->pixel_width
;
24580 while (glyph
< last
24581 && glyph
->type
== GLYPHLESS_GLYPH
24582 && glyph
->voffset
== voffset
24583 && glyph
->face_id
== face_id
)
24586 s
->width
+= glyph
->pixel_width
;
24589 s
->ybase
+= voffset
;
24590 return glyph
- s
->row
->glyphs
[s
->area
];
24594 /* Fill glyph string S from a sequence of character glyphs.
24596 FACE_ID is the face id of the string. START is the index of the
24597 first glyph to consider, END is the index of the last + 1.
24598 OVERLAPS non-zero means S should draw the foreground only, and use
24599 its physical height for clipping. See also draw_glyphs.
24601 Value is the index of the first glyph not in S. */
24604 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24605 int start
, int end
, int overlaps
)
24607 struct glyph
*glyph
, *last
;
24609 bool glyph_not_available_p
;
24611 eassert (s
->f
== XFRAME (s
->w
->frame
));
24612 eassert (s
->nchars
== 0);
24613 eassert (start
>= 0 && end
> start
);
24615 s
->for_overlaps
= overlaps
;
24616 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24617 last
= s
->row
->glyphs
[s
->area
] + end
;
24618 voffset
= glyph
->voffset
;
24619 s
->padding_p
= glyph
->padding_p
;
24620 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24622 while (glyph
< last
24623 && glyph
->type
== CHAR_GLYPH
24624 && glyph
->voffset
== voffset
24625 /* Same face id implies same font, nowadays. */
24626 && glyph
->face_id
== face_id
24627 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24629 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24630 s
->char2b
+ s
->nchars
);
24632 eassert (s
->nchars
<= end
- start
);
24633 s
->width
+= glyph
->pixel_width
;
24634 if (glyph
++->padding_p
!= s
->padding_p
)
24638 s
->font
= s
->face
->font
;
24640 /* If the specified font could not be loaded, use the frame's font,
24641 but record the fact that we couldn't load it in
24642 S->font_not_found_p so that we can draw rectangles for the
24643 characters of the glyph string. */
24644 if (s
->font
== NULL
|| glyph_not_available_p
)
24646 s
->font_not_found_p
= true;
24647 s
->font
= FRAME_FONT (s
->f
);
24650 /* Adjust base line for subscript/superscript text. */
24651 s
->ybase
+= voffset
;
24653 eassert (s
->face
&& s
->face
->gc
);
24654 return glyph
- s
->row
->glyphs
[s
->area
];
24658 /* Fill glyph string S from image glyph S->first_glyph. */
24661 fill_image_glyph_string (struct glyph_string
*s
)
24663 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24664 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24666 s
->slice
= s
->first_glyph
->slice
.img
;
24667 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24668 s
->font
= s
->face
->font
;
24669 s
->width
= s
->first_glyph
->pixel_width
;
24671 /* Adjust base line for subscript/superscript text. */
24672 s
->ybase
+= s
->first_glyph
->voffset
;
24676 /* Fill glyph string S from a sequence of stretch glyphs.
24678 START is the index of the first glyph to consider,
24679 END is the index of the last + 1.
24681 Value is the index of the first glyph not in S. */
24684 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24686 struct glyph
*glyph
, *last
;
24687 int voffset
, face_id
;
24689 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24691 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24692 last
= s
->row
->glyphs
[s
->area
] + end
;
24693 face_id
= glyph
->face_id
;
24694 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24695 s
->font
= s
->face
->font
;
24696 s
->width
= glyph
->pixel_width
;
24698 voffset
= glyph
->voffset
;
24702 && glyph
->type
== STRETCH_GLYPH
24703 && glyph
->voffset
== voffset
24704 && glyph
->face_id
== face_id
);
24706 s
->width
+= glyph
->pixel_width
;
24708 /* Adjust base line for subscript/superscript text. */
24709 s
->ybase
+= voffset
;
24711 /* The case that face->gc == 0 is handled when drawing the glyph
24712 string by calling prepare_face_for_display. */
24714 return glyph
- s
->row
->glyphs
[s
->area
];
24717 static struct font_metrics
*
24718 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24720 static struct font_metrics metrics
;
24725 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24726 if (code
== FONT_INVALID_CODE
)
24728 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24732 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24733 for FONT. Values are taken from font-global ones, except for fonts
24734 that claim preposterously large values, but whose glyphs actually
24735 have reasonable dimensions. C is the character to use for metrics
24736 if the font-global values are too large; if C is negative, the
24737 function selects a default character. */
24739 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24741 *ascent
= FONT_BASE (font
);
24742 *descent
= FONT_DESCENT (font
);
24744 if (FONT_TOO_HIGH (font
))
24748 /* Get metrics of C, defaulting to a reasonably sized ASCII
24750 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24752 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24754 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24756 /* We add 1 pixel to character dimensions as heuristics
24757 that produces nicer display, e.g. when the face has
24758 the box attribute. */
24759 *ascent
= pcm
->ascent
+ 1;
24760 *descent
= pcm
->descent
+ 1;
24766 /* A subroutine that computes a reasonable "normal character height"
24767 for fonts that claim preposterously large vertical dimensions, but
24768 whose glyphs are actually reasonably sized. C is the character
24769 whose metrics to use for those fonts, or -1 for default
24772 normal_char_height (struct font
*font
, int c
)
24774 int ascent
, descent
;
24776 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24778 return ascent
+ descent
;
24782 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24783 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24784 assumed to be zero. */
24787 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24789 *left
= *right
= 0;
24791 if (glyph
->type
== CHAR_GLYPH
)
24794 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24797 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24800 if (pcm
->rbearing
> pcm
->width
)
24801 *right
= pcm
->rbearing
- pcm
->width
;
24802 if (pcm
->lbearing
< 0)
24803 *left
= -pcm
->lbearing
;
24807 else if (glyph
->type
== COMPOSITE_GLYPH
)
24809 if (! glyph
->u
.cmp
.automatic
)
24811 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24813 if (cmp
->rbearing
> cmp
->pixel_width
)
24814 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24815 if (cmp
->lbearing
< 0)
24816 *left
= - cmp
->lbearing
;
24820 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24821 struct font_metrics metrics
;
24823 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24824 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24825 if (metrics
.rbearing
> metrics
.width
)
24826 *right
= metrics
.rbearing
- metrics
.width
;
24827 if (metrics
.lbearing
< 0)
24828 *left
= - metrics
.lbearing
;
24834 /* Return the index of the first glyph preceding glyph string S that
24835 is overwritten by S because of S's left overhang. Value is -1
24836 if no glyphs are overwritten. */
24839 left_overwritten (struct glyph_string
*s
)
24843 if (s
->left_overhang
)
24846 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24847 int first
= s
->first_glyph
- glyphs
;
24849 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24850 x
-= glyphs
[i
].pixel_width
;
24861 /* Return the index of the first glyph preceding glyph string S that
24862 is overwriting S because of its right overhang. Value is -1 if no
24863 glyph in front of S overwrites S. */
24866 left_overwriting (struct glyph_string
*s
)
24869 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24870 int first
= s
->first_glyph
- glyphs
;
24874 for (i
= first
- 1; i
>= 0; --i
)
24877 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24880 x
-= glyphs
[i
].pixel_width
;
24887 /* Return the index of the last glyph following glyph string S that is
24888 overwritten by S because of S's right overhang. Value is -1 if
24889 no such glyph is found. */
24892 right_overwritten (struct glyph_string
*s
)
24896 if (s
->right_overhang
)
24899 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24900 int first
= (s
->first_glyph
- glyphs
24901 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24902 int end
= s
->row
->used
[s
->area
];
24904 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24905 x
+= glyphs
[i
].pixel_width
;
24914 /* Return the index of the last glyph following glyph string S that
24915 overwrites S because of its left overhang. Value is negative
24916 if no such glyph is found. */
24919 right_overwriting (struct glyph_string
*s
)
24922 int end
= s
->row
->used
[s
->area
];
24923 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24924 int first
= (s
->first_glyph
- glyphs
24925 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24929 for (i
= first
; i
< end
; ++i
)
24932 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24935 x
+= glyphs
[i
].pixel_width
;
24942 /* Set background width of glyph string S. START is the index of the
24943 first glyph following S. LAST_X is the right-most x-position + 1
24944 in the drawing area. */
24947 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24949 /* If the face of this glyph string has to be drawn to the end of
24950 the drawing area, set S->extends_to_end_of_line_p. */
24952 if (start
== s
->row
->used
[s
->area
]
24953 && ((s
->row
->fill_line_p
24954 && (s
->hl
== DRAW_NORMAL_TEXT
24955 || s
->hl
== DRAW_IMAGE_RAISED
24956 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24957 || s
->hl
== DRAW_MOUSE_FACE
))
24958 s
->extends_to_end_of_line_p
= true;
24960 /* If S extends its face to the end of the line, set its
24961 background_width to the distance to the right edge of the drawing
24963 if (s
->extends_to_end_of_line_p
)
24964 s
->background_width
= last_x
- s
->x
+ 1;
24966 s
->background_width
= s
->width
;
24970 /* Compute overhangs and x-positions for glyph string S and its
24971 predecessors, or successors. X is the starting x-position for S.
24972 BACKWARD_P means process predecessors. */
24975 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24981 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24982 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24992 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24993 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
25003 /* The following macros are only called from draw_glyphs below.
25004 They reference the following parameters of that function directly:
25005 `w', `row', `area', and `overlap_p'
25006 as well as the following local variables:
25007 `s', `f', and `hdc' (in W32) */
25010 /* On W32, silently add local `hdc' variable to argument list of
25011 init_glyph_string. */
25012 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25013 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25015 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25016 init_glyph_string (s, char2b, w, row, area, start, hl)
25019 /* Add a glyph string for a stretch glyph to the list of strings
25020 between HEAD and TAIL. START is the index of the stretch glyph in
25021 row area AREA of glyph row ROW. END is the index of the last glyph
25022 in that glyph row area. X is the current output position assigned
25023 to the new glyph string constructed. HL overrides that face of the
25024 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25025 is the right-most x-position of the drawing area. */
25027 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25028 and below -- keep them on one line. */
25029 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25032 s = alloca (sizeof *s); \
25033 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25034 START = fill_stretch_glyph_string (s, START, END); \
25035 append_glyph_string (&HEAD, &TAIL, s); \
25041 /* Add a glyph string for an image glyph to the list of strings
25042 between HEAD and TAIL. START is the index of the image glyph in
25043 row area AREA of glyph row ROW. END is the index of the last glyph
25044 in that glyph row area. X is the current output position assigned
25045 to the new glyph string constructed. HL overrides that face of the
25046 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25047 is the right-most x-position of the drawing area. */
25049 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25052 s = alloca (sizeof *s); \
25053 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25054 fill_image_glyph_string (s); \
25055 append_glyph_string (&HEAD, &TAIL, s); \
25062 /* Add a glyph string for a sequence of character glyphs to the list
25063 of strings between HEAD and TAIL. START is the index of the first
25064 glyph in row area AREA of glyph row ROW that is part of the new
25065 glyph string. END is the index of the last glyph in that glyph row
25066 area. X is the current output position assigned to the new glyph
25067 string constructed. HL overrides that face of the glyph; e.g. it
25068 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25069 right-most x-position of the drawing area. */
25071 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25077 face_id = (row)->glyphs[area][START].face_id; \
25079 s = alloca (sizeof *s); \
25080 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25081 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25082 append_glyph_string (&HEAD, &TAIL, s); \
25084 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25089 /* Add a glyph string for a composite sequence to the list of strings
25090 between HEAD and TAIL. START is the index of the first glyph in
25091 row area AREA of glyph row ROW that is part of the new glyph
25092 string. END is the index of the last glyph in that glyph row area.
25093 X is the current output position assigned to the new glyph string
25094 constructed. HL overrides that face of the glyph; e.g. it is
25095 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25096 x-position of the drawing area. */
25098 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25100 int face_id = (row)->glyphs[area][START].face_id; \
25101 struct face *base_face = FACE_FROM_ID (f, face_id); \
25102 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25103 struct composition *cmp = composition_table[cmp_id]; \
25105 struct glyph_string *first_s = NULL; \
25108 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25110 /* Make glyph_strings for each glyph sequence that is drawable by \
25111 the same face, and append them to HEAD/TAIL. */ \
25112 for (n = 0; n < cmp->glyph_len;) \
25114 s = alloca (sizeof *s); \
25115 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25116 append_glyph_string (&(HEAD), &(TAIL), s); \
25122 n = fill_composite_glyph_string (s, base_face, overlaps); \
25130 /* Add a glyph string for a glyph-string sequence to the list of strings
25131 between HEAD and TAIL. */
25133 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25137 Lisp_Object gstring; \
25139 face_id = (row)->glyphs[area][START].face_id; \
25140 gstring = (composition_gstring_from_id \
25141 ((row)->glyphs[area][START].u.cmp.id)); \
25142 s = alloca (sizeof *s); \
25143 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25144 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25145 append_glyph_string (&(HEAD), &(TAIL), s); \
25147 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25151 /* Add a glyph string for a sequence of glyphless character's glyphs
25152 to the list of strings between HEAD and TAIL. The meanings of
25153 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25155 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25160 face_id = (row)->glyphs[area][START].face_id; \
25162 s = alloca (sizeof *s); \
25163 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25164 append_glyph_string (&HEAD, &TAIL, s); \
25166 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25172 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25173 of AREA of glyph row ROW on window W between indices START and END.
25174 HL overrides the face for drawing glyph strings, e.g. it is
25175 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25176 x-positions of the drawing area.
25178 This is an ugly monster macro construct because we must use alloca
25179 to allocate glyph strings (because draw_glyphs can be called
25180 asynchronously). */
25182 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25185 HEAD = TAIL = NULL; \
25186 while (START < END) \
25188 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25189 switch (first_glyph->type) \
25192 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25196 case COMPOSITE_GLYPH: \
25197 if (first_glyph->u.cmp.automatic) \
25198 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25201 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25205 case STRETCH_GLYPH: \
25206 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25210 case IMAGE_GLYPH: \
25211 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25215 case GLYPHLESS_GLYPH: \
25216 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25226 set_glyph_string_background_width (s, START, LAST_X); \
25233 /* Draw glyphs between START and END in AREA of ROW on window W,
25234 starting at x-position X. X is relative to AREA in W. HL is a
25235 face-override with the following meaning:
25237 DRAW_NORMAL_TEXT draw normally
25238 DRAW_CURSOR draw in cursor face
25239 DRAW_MOUSE_FACE draw in mouse face.
25240 DRAW_INVERSE_VIDEO draw in mode line face
25241 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25242 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25244 If OVERLAPS is non-zero, draw only the foreground of characters and
25245 clip to the physical height of ROW. Non-zero value also defines
25246 the overlapping part to be drawn:
25248 OVERLAPS_PRED overlap with preceding rows
25249 OVERLAPS_SUCC overlap with succeeding rows
25250 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25251 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25253 Value is the x-position reached, relative to AREA of W. */
25256 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25257 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25258 enum draw_glyphs_face hl
, int overlaps
)
25260 struct glyph_string
*head
, *tail
;
25261 struct glyph_string
*s
;
25262 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25263 int i
, j
, x_reached
, last_x
, area_left
= 0;
25264 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25267 ALLOCATE_HDC (hdc
, f
);
25269 /* Let's rather be paranoid than getting a SEGV. */
25270 end
= min (end
, row
->used
[area
]);
25271 start
= clip_to_bounds (0, start
, end
);
25273 /* Translate X to frame coordinates. Set last_x to the right
25274 end of the drawing area. */
25275 if (row
->full_width_p
)
25277 /* X is relative to the left edge of W, without scroll bars
25279 area_left
= WINDOW_LEFT_EDGE_X (w
);
25280 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25281 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25285 area_left
= window_box_left (w
, area
);
25286 last_x
= area_left
+ window_box_width (w
, area
);
25290 /* Build a doubly-linked list of glyph_string structures between
25291 head and tail from what we have to draw. Note that the macro
25292 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25293 the reason we use a separate variable `i'. */
25296 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25298 x_reached
= tail
->x
+ tail
->background_width
;
25302 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25303 the row, redraw some glyphs in front or following the glyph
25304 strings built above. */
25305 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25307 struct glyph_string
*h
, *t
;
25308 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25309 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25310 bool check_mouse_face
= false;
25313 /* If mouse highlighting is on, we may need to draw adjacent
25314 glyphs using mouse-face highlighting. */
25315 if (area
== TEXT_AREA
&& row
->mouse_face_p
25316 && hlinfo
->mouse_face_beg_row
>= 0
25317 && hlinfo
->mouse_face_end_row
>= 0)
25319 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25321 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25322 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25324 check_mouse_face
= true;
25325 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25326 ? hlinfo
->mouse_face_beg_col
: 0;
25327 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25328 ? hlinfo
->mouse_face_end_col
25329 : row
->used
[TEXT_AREA
];
25333 /* Compute overhangs for all glyph strings. */
25334 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25335 for (s
= head
; s
; s
= s
->next
)
25336 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25338 /* Prepend glyph strings for glyphs in front of the first glyph
25339 string that are overwritten because of the first glyph
25340 string's left overhang. The background of all strings
25341 prepended must be drawn because the first glyph string
25343 i
= left_overwritten (head
);
25346 enum draw_glyphs_face overlap_hl
;
25348 /* If this row contains mouse highlighting, attempt to draw
25349 the overlapped glyphs with the correct highlight. This
25350 code fails if the overlap encompasses more than one glyph
25351 and mouse-highlight spans only some of these glyphs.
25352 However, making it work perfectly involves a lot more
25353 code, and I don't know if the pathological case occurs in
25354 practice, so we'll stick to this for now. --- cyd */
25355 if (check_mouse_face
25356 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25357 overlap_hl
= DRAW_MOUSE_FACE
;
25359 overlap_hl
= DRAW_NORMAL_TEXT
;
25361 if (hl
!= overlap_hl
)
25364 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25365 overlap_hl
, dummy_x
, last_x
);
25367 compute_overhangs_and_x (t
, head
->x
, true);
25368 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25369 if (clip_head
== NULL
)
25373 /* Prepend glyph strings for glyphs in front of the first glyph
25374 string that overwrite that glyph string because of their
25375 right overhang. For these strings, only the foreground must
25376 be drawn, because it draws over the glyph string at `head'.
25377 The background must not be drawn because this would overwrite
25378 right overhangs of preceding glyphs for which no glyph
25380 i
= left_overwriting (head
);
25383 enum draw_glyphs_face overlap_hl
;
25385 if (check_mouse_face
25386 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25387 overlap_hl
= DRAW_MOUSE_FACE
;
25389 overlap_hl
= DRAW_NORMAL_TEXT
;
25391 if (hl
== overlap_hl
|| clip_head
== NULL
)
25393 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25394 overlap_hl
, dummy_x
, last_x
);
25395 for (s
= h
; s
; s
= s
->next
)
25396 s
->background_filled_p
= true;
25397 compute_overhangs_and_x (t
, head
->x
, true);
25398 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25401 /* Append glyphs strings for glyphs following the last glyph
25402 string tail that are overwritten by tail. The background of
25403 these strings has to be drawn because tail's foreground draws
25405 i
= right_overwritten (tail
);
25408 enum draw_glyphs_face overlap_hl
;
25410 if (check_mouse_face
25411 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25412 overlap_hl
= DRAW_MOUSE_FACE
;
25414 overlap_hl
= DRAW_NORMAL_TEXT
;
25416 if (hl
!= overlap_hl
)
25418 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25419 overlap_hl
, x
, last_x
);
25420 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25421 we don't have `end = i;' here. */
25422 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25423 append_glyph_string_lists (&head
, &tail
, h
, t
);
25424 if (clip_tail
== NULL
)
25428 /* Append glyph strings for glyphs following the last glyph
25429 string tail that overwrite tail. The foreground of such
25430 glyphs has to be drawn because it writes into the background
25431 of tail. The background must not be drawn because it could
25432 paint over the foreground of following glyphs. */
25433 i
= right_overwriting (tail
);
25436 enum draw_glyphs_face overlap_hl
;
25437 if (check_mouse_face
25438 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25439 overlap_hl
= DRAW_MOUSE_FACE
;
25441 overlap_hl
= DRAW_NORMAL_TEXT
;
25443 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25445 i
++; /* We must include the Ith glyph. */
25446 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25447 overlap_hl
, x
, last_x
);
25448 for (s
= h
; s
; s
= s
->next
)
25449 s
->background_filled_p
= true;
25450 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25451 append_glyph_string_lists (&head
, &tail
, h
, t
);
25453 if (clip_head
|| clip_tail
)
25454 for (s
= head
; s
; s
= s
->next
)
25456 s
->clip_head
= clip_head
;
25457 s
->clip_tail
= clip_tail
;
25461 /* Draw all strings. */
25462 for (s
= head
; s
; s
= s
->next
)
25463 FRAME_RIF (f
)->draw_glyph_string (s
);
25466 /* When focus a sole frame and move horizontally, this clears on_p
25467 causing a failure to erase prev cursor position. */
25468 if (area
== TEXT_AREA
25469 && !row
->full_width_p
25470 /* When drawing overlapping rows, only the glyph strings'
25471 foreground is drawn, which doesn't erase a cursor
25475 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25476 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25477 : (tail
? tail
->x
+ tail
->background_width
: x
));
25481 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25482 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25486 /* Value is the x-position up to which drawn, relative to AREA of W.
25487 This doesn't include parts drawn because of overhangs. */
25488 if (row
->full_width_p
)
25489 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25491 x_reached
-= area_left
;
25493 RELEASE_HDC (hdc
, f
);
25499 /* Expand row matrix if too narrow. Don't expand if area
25502 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25504 if (!it->f->fonts_changed \
25505 && (it->glyph_row->glyphs[area] \
25506 < it->glyph_row->glyphs[area + 1])) \
25508 it->w->ncols_scale_factor++; \
25509 it->f->fonts_changed = true; \
25513 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25514 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25517 append_glyph (struct it
*it
)
25519 struct glyph
*glyph
;
25520 enum glyph_row_area area
= it
->area
;
25522 eassert (it
->glyph_row
);
25523 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25525 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25526 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25528 /* If the glyph row is reversed, we need to prepend the glyph
25529 rather than append it. */
25530 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25534 /* Make room for the additional glyph. */
25535 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25537 glyph
= it
->glyph_row
->glyphs
[area
];
25539 glyph
->charpos
= CHARPOS (it
->position
);
25540 glyph
->object
= it
->object
;
25541 if (it
->pixel_width
> 0)
25543 glyph
->pixel_width
= it
->pixel_width
;
25544 glyph
->padding_p
= false;
25548 /* Assure at least 1-pixel width. Otherwise, cursor can't
25549 be displayed correctly. */
25550 glyph
->pixel_width
= 1;
25551 glyph
->padding_p
= true;
25553 glyph
->ascent
= it
->ascent
;
25554 glyph
->descent
= it
->descent
;
25555 glyph
->voffset
= it
->voffset
;
25556 glyph
->type
= CHAR_GLYPH
;
25557 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25558 glyph
->multibyte_p
= it
->multibyte_p
;
25559 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25561 /* In R2L rows, the left and the right box edges need to be
25562 drawn in reverse direction. */
25563 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25564 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25568 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25569 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25571 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25572 || it
->phys_descent
> it
->descent
);
25573 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25574 glyph
->face_id
= it
->face_id
;
25575 glyph
->u
.ch
= it
->char_to_display
;
25576 glyph
->slice
.img
= null_glyph_slice
;
25577 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25580 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25581 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25582 glyph
->bidi_type
= it
->bidi_it
.type
;
25586 glyph
->resolved_level
= 0;
25587 glyph
->bidi_type
= UNKNOWN_BT
;
25589 ++it
->glyph_row
->used
[area
];
25592 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25595 /* Store one glyph for the composition IT->cmp_it.id in
25596 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25600 append_composite_glyph (struct it
*it
)
25602 struct glyph
*glyph
;
25603 enum glyph_row_area area
= it
->area
;
25605 eassert (it
->glyph_row
);
25607 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25608 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25610 /* If the glyph row is reversed, we need to prepend the glyph
25611 rather than append it. */
25612 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25616 /* Make room for the new glyph. */
25617 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25619 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25621 glyph
->charpos
= it
->cmp_it
.charpos
;
25622 glyph
->object
= it
->object
;
25623 glyph
->pixel_width
= it
->pixel_width
;
25624 glyph
->ascent
= it
->ascent
;
25625 glyph
->descent
= it
->descent
;
25626 glyph
->voffset
= it
->voffset
;
25627 glyph
->type
= COMPOSITE_GLYPH
;
25628 if (it
->cmp_it
.ch
< 0)
25630 glyph
->u
.cmp
.automatic
= false;
25631 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25632 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25636 glyph
->u
.cmp
.automatic
= true;
25637 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25638 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25639 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25641 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25642 glyph
->multibyte_p
= it
->multibyte_p
;
25643 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25645 /* In R2L rows, the left and the right box edges need to be
25646 drawn in reverse direction. */
25647 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25648 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25652 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25653 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25655 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25656 || it
->phys_descent
> it
->descent
);
25657 glyph
->padding_p
= false;
25658 glyph
->glyph_not_available_p
= false;
25659 glyph
->face_id
= it
->face_id
;
25660 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25663 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25664 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25665 glyph
->bidi_type
= it
->bidi_it
.type
;
25667 ++it
->glyph_row
->used
[area
];
25670 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25674 /* Change IT->ascent and IT->height according to the setting of
25678 take_vertical_position_into_account (struct it
*it
)
25682 if (it
->voffset
< 0)
25683 /* Increase the ascent so that we can display the text higher
25685 it
->ascent
-= it
->voffset
;
25687 /* Increase the descent so that we can display the text lower
25689 it
->descent
+= it
->voffset
;
25694 /* Produce glyphs/get display metrics for the image IT is loaded with.
25695 See the description of struct display_iterator in dispextern.h for
25696 an overview of struct display_iterator. */
25699 produce_image_glyph (struct it
*it
)
25703 int glyph_ascent
, crop
;
25704 struct glyph_slice slice
;
25706 eassert (it
->what
== IT_IMAGE
);
25708 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25710 /* Make sure X resources of the face is loaded. */
25711 prepare_face_for_display (it
->f
, face
);
25713 if (it
->image_id
< 0)
25715 /* Fringe bitmap. */
25716 it
->ascent
= it
->phys_ascent
= 0;
25717 it
->descent
= it
->phys_descent
= 0;
25718 it
->pixel_width
= 0;
25723 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25725 /* Make sure X resources of the image is loaded. */
25726 prepare_image_for_display (it
->f
, img
);
25728 slice
.x
= slice
.y
= 0;
25729 slice
.width
= img
->width
;
25730 slice
.height
= img
->height
;
25732 if (INTEGERP (it
->slice
.x
))
25733 slice
.x
= XINT (it
->slice
.x
);
25734 else if (FLOATP (it
->slice
.x
))
25735 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25737 if (INTEGERP (it
->slice
.y
))
25738 slice
.y
= XINT (it
->slice
.y
);
25739 else if (FLOATP (it
->slice
.y
))
25740 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25742 if (INTEGERP (it
->slice
.width
))
25743 slice
.width
= XINT (it
->slice
.width
);
25744 else if (FLOATP (it
->slice
.width
))
25745 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25747 if (INTEGERP (it
->slice
.height
))
25748 slice
.height
= XINT (it
->slice
.height
);
25749 else if (FLOATP (it
->slice
.height
))
25750 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25752 if (slice
.x
>= img
->width
)
25753 slice
.x
= img
->width
;
25754 if (slice
.y
>= img
->height
)
25755 slice
.y
= img
->height
;
25756 if (slice
.x
+ slice
.width
>= img
->width
)
25757 slice
.width
= img
->width
- slice
.x
;
25758 if (slice
.y
+ slice
.height
> img
->height
)
25759 slice
.height
= img
->height
- slice
.y
;
25761 if (slice
.width
== 0 || slice
.height
== 0)
25764 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25766 it
->descent
= slice
.height
- glyph_ascent
;
25768 it
->descent
+= img
->vmargin
;
25769 if (slice
.y
+ slice
.height
== img
->height
)
25770 it
->descent
+= img
->vmargin
;
25771 it
->phys_descent
= it
->descent
;
25773 it
->pixel_width
= slice
.width
;
25775 it
->pixel_width
+= img
->hmargin
;
25776 if (slice
.x
+ slice
.width
== img
->width
)
25777 it
->pixel_width
+= img
->hmargin
;
25779 /* It's quite possible for images to have an ascent greater than
25780 their height, so don't get confused in that case. */
25781 if (it
->descent
< 0)
25786 if (face
->box
!= FACE_NO_BOX
)
25788 if (face
->box_line_width
> 0)
25791 it
->ascent
+= face
->box_line_width
;
25792 if (slice
.y
+ slice
.height
== img
->height
)
25793 it
->descent
+= face
->box_line_width
;
25796 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25797 it
->pixel_width
+= eabs (face
->box_line_width
);
25798 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25799 it
->pixel_width
+= eabs (face
->box_line_width
);
25802 take_vertical_position_into_account (it
);
25804 /* Automatically crop wide image glyphs at right edge so we can
25805 draw the cursor on same display row. */
25806 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25807 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25809 it
->pixel_width
-= crop
;
25810 slice
.width
-= crop
;
25815 struct glyph
*glyph
;
25816 enum glyph_row_area area
= it
->area
;
25818 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25819 if (it
->glyph_row
->reversed_p
)
25823 /* Make room for the new glyph. */
25824 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25826 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25828 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25830 glyph
->charpos
= CHARPOS (it
->position
);
25831 glyph
->object
= it
->object
;
25832 glyph
->pixel_width
= it
->pixel_width
;
25833 glyph
->ascent
= glyph_ascent
;
25834 glyph
->descent
= it
->descent
;
25835 glyph
->voffset
= it
->voffset
;
25836 glyph
->type
= IMAGE_GLYPH
;
25837 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25838 glyph
->multibyte_p
= it
->multibyte_p
;
25839 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25841 /* In R2L rows, the left and the right box edges need to be
25842 drawn in reverse direction. */
25843 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25844 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25848 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25849 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25851 glyph
->overlaps_vertically_p
= false;
25852 glyph
->padding_p
= false;
25853 glyph
->glyph_not_available_p
= false;
25854 glyph
->face_id
= it
->face_id
;
25855 glyph
->u
.img_id
= img
->id
;
25856 glyph
->slice
.img
= slice
;
25857 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25860 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25861 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25862 glyph
->bidi_type
= it
->bidi_it
.type
;
25864 ++it
->glyph_row
->used
[area
];
25867 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25872 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25873 of the glyph, WIDTH and HEIGHT are the width and height of the
25874 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25877 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25878 int width
, int height
, int ascent
)
25880 struct glyph
*glyph
;
25881 enum glyph_row_area area
= it
->area
;
25883 eassert (ascent
>= 0 && ascent
<= height
);
25885 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25886 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25888 /* If the glyph row is reversed, we need to prepend the glyph
25889 rather than append it. */
25890 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25894 /* Make room for the additional glyph. */
25895 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25897 glyph
= it
->glyph_row
->glyphs
[area
];
25899 /* Decrease the width of the first glyph of the row that
25900 begins before first_visible_x (e.g., due to hscroll).
25901 This is so the overall width of the row becomes smaller
25902 by the scroll amount, and the stretch glyph appended by
25903 extend_face_to_end_of_line will be wider, to shift the
25904 row glyphs to the right. (In L2R rows, the corresponding
25905 left-shift effect is accomplished by setting row->x to a
25906 negative value, which won't work with R2L rows.)
25908 This must leave us with a positive value of WIDTH, since
25909 otherwise the call to move_it_in_display_line_to at the
25910 beginning of display_line would have got past the entire
25911 first glyph, and then it->current_x would have been
25912 greater or equal to it->first_visible_x. */
25913 if (it
->current_x
< it
->first_visible_x
)
25914 width
-= it
->first_visible_x
- it
->current_x
;
25915 eassert (width
> 0);
25917 glyph
->charpos
= CHARPOS (it
->position
);
25918 glyph
->object
= object
;
25919 glyph
->pixel_width
= width
;
25920 glyph
->ascent
= ascent
;
25921 glyph
->descent
= height
- ascent
;
25922 glyph
->voffset
= it
->voffset
;
25923 glyph
->type
= STRETCH_GLYPH
;
25924 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25925 glyph
->multibyte_p
= it
->multibyte_p
;
25926 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25928 /* In R2L rows, the left and the right box edges need to be
25929 drawn in reverse direction. */
25930 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25931 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25935 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25936 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25938 glyph
->overlaps_vertically_p
= false;
25939 glyph
->padding_p
= false;
25940 glyph
->glyph_not_available_p
= false;
25941 glyph
->face_id
= it
->face_id
;
25942 glyph
->u
.stretch
.ascent
= ascent
;
25943 glyph
->u
.stretch
.height
= height
;
25944 glyph
->slice
.img
= null_glyph_slice
;
25945 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25948 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25949 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25950 glyph
->bidi_type
= it
->bidi_it
.type
;
25954 glyph
->resolved_level
= 0;
25955 glyph
->bidi_type
= UNKNOWN_BT
;
25957 ++it
->glyph_row
->used
[area
];
25960 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25963 #endif /* HAVE_WINDOW_SYSTEM */
25965 /* Produce a stretch glyph for iterator IT. IT->object is the value
25966 of the glyph property displayed. The value must be a list
25967 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25970 1. `:width WIDTH' specifies that the space should be WIDTH *
25971 canonical char width wide. WIDTH may be an integer or floating
25974 2. `:relative-width FACTOR' specifies that the width of the stretch
25975 should be computed from the width of the first character having the
25976 `glyph' property, and should be FACTOR times that width.
25978 3. `:align-to HPOS' specifies that the space should be wide enough
25979 to reach HPOS, a value in canonical character units.
25981 Exactly one of the above pairs must be present.
25983 4. `:height HEIGHT' specifies that the height of the stretch produced
25984 should be HEIGHT, measured in canonical character units.
25986 5. `:relative-height FACTOR' specifies that the height of the
25987 stretch should be FACTOR times the height of the characters having
25988 the glyph property.
25990 Either none or exactly one of 4 or 5 must be present.
25992 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25993 of the stretch should be used for the ascent of the stretch.
25994 ASCENT must be in the range 0 <= ASCENT <= 100. */
25997 produce_stretch_glyph (struct it
*it
)
25999 /* (space :width WIDTH :height HEIGHT ...) */
26000 Lisp_Object prop
, plist
;
26001 int width
= 0, height
= 0, align_to
= -1;
26002 bool zero_width_ok_p
= false;
26004 struct font
*font
= NULL
;
26006 #ifdef HAVE_WINDOW_SYSTEM
26008 bool zero_height_ok_p
= false;
26010 if (FRAME_WINDOW_P (it
->f
))
26012 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26013 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26014 prepare_face_for_display (it
->f
, face
);
26018 /* List should start with `space'. */
26019 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26020 plist
= XCDR (it
->object
);
26022 /* Compute the width of the stretch. */
26023 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26024 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26026 /* Absolute width `:width WIDTH' specified and valid. */
26027 zero_width_ok_p
= true;
26030 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26032 /* Relative width `:relative-width FACTOR' specified and valid.
26033 Compute the width of the characters having the `glyph'
26036 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26039 if (it
->multibyte_p
)
26040 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26043 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26044 if (! ASCII_CHAR_P (it2
.c
))
26045 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26048 it2
.glyph_row
= NULL
;
26049 it2
.what
= IT_CHARACTER
;
26050 PRODUCE_GLYPHS (&it2
);
26051 width
= NUMVAL (prop
) * it2
.pixel_width
;
26053 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26054 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26057 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26058 align_to
= (align_to
< 0
26060 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26061 else if (align_to
< 0)
26062 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26063 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26064 zero_width_ok_p
= true;
26067 /* Nothing specified -> width defaults to canonical char width. */
26068 width
= FRAME_COLUMN_WIDTH (it
->f
);
26070 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26073 #ifdef HAVE_WINDOW_SYSTEM
26074 /* Compute height. */
26075 if (FRAME_WINDOW_P (it
->f
))
26077 int default_height
= normal_char_height (font
, ' ');
26079 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26080 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26083 zero_height_ok_p
= true;
26085 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26087 height
= default_height
* NUMVAL (prop
);
26089 height
= default_height
;
26091 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26094 /* Compute percentage of height used for ascent. If
26095 `:ascent ASCENT' is present and valid, use that. Otherwise,
26096 derive the ascent from the font in use. */
26097 if (prop
= Fplist_get (plist
, QCascent
),
26098 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26099 ascent
= height
* NUMVAL (prop
) / 100.0;
26100 else if (!NILP (prop
)
26101 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26102 ascent
= min (max (0, (int)tem
), height
);
26104 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26107 #endif /* HAVE_WINDOW_SYSTEM */
26110 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26111 && it
->current_x
+ width
> it
->last_visible_x
)
26113 width
= it
->last_visible_x
- it
->current_x
;
26114 #ifdef HAVE_WINDOW_SYSTEM
26115 /* Subtract one more pixel from the stretch width, but only on
26116 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26117 width
-= FRAME_WINDOW_P (it
->f
);
26121 if (width
> 0 && height
> 0 && it
->glyph_row
)
26123 Lisp_Object o_object
= it
->object
;
26124 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26127 if (!STRINGP (object
))
26128 object
= it
->w
->contents
;
26129 #ifdef HAVE_WINDOW_SYSTEM
26130 if (FRAME_WINDOW_P (it
->f
))
26131 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26135 it
->object
= object
;
26136 it
->char_to_display
= ' ';
26137 it
->pixel_width
= it
->len
= 1;
26139 tty_append_glyph (it
);
26140 it
->object
= o_object
;
26144 it
->pixel_width
= width
;
26145 #ifdef HAVE_WINDOW_SYSTEM
26146 if (FRAME_WINDOW_P (it
->f
))
26148 it
->ascent
= it
->phys_ascent
= ascent
;
26149 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26150 it
->nglyphs
= width
> 0 && height
> 0;
26151 take_vertical_position_into_account (it
);
26155 it
->nglyphs
= width
;
26158 /* Get information about special display element WHAT in an
26159 environment described by IT. WHAT is one of IT_TRUNCATION or
26160 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26161 non-null glyph_row member. This function ensures that fields like
26162 face_id, c, len of IT are left untouched. */
26165 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26172 temp_it
.object
= Qnil
;
26173 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26175 if (what
== IT_CONTINUATION
)
26177 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26178 if (it
->bidi_it
.paragraph_dir
== R2L
)
26179 SET_GLYPH_FROM_CHAR (glyph
, '/');
26181 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26183 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26185 /* FIXME: Should we mirror GC for R2L lines? */
26186 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26187 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26190 else if (what
== IT_TRUNCATION
)
26192 /* Truncation glyph. */
26193 SET_GLYPH_FROM_CHAR (glyph
, '$');
26195 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26197 /* FIXME: Should we mirror GC for R2L lines? */
26198 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26199 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26205 #ifdef HAVE_WINDOW_SYSTEM
26206 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26207 is turned off, we precede the truncation/continuation glyphs by a
26208 stretch glyph whose width is computed such that these special
26209 glyphs are aligned at the window margin, even when very different
26210 fonts are used in different glyph rows. */
26211 if (FRAME_WINDOW_P (temp_it
.f
)
26212 /* init_iterator calls this with it->glyph_row == NULL, and it
26213 wants only the pixel width of the truncation/continuation
26215 && temp_it
.glyph_row
26216 /* insert_left_trunc_glyphs calls us at the beginning of the
26217 row, and it has its own calculation of the stretch glyph
26219 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26220 && (temp_it
.glyph_row
->reversed_p
26221 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26222 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26224 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26226 if (stretch_width
> 0)
26228 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26229 struct font
*font
=
26230 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26231 int stretch_ascent
=
26232 (((temp_it
.ascent
+ temp_it
.descent
)
26233 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26235 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26236 temp_it
.ascent
+ temp_it
.descent
,
26243 temp_it
.what
= IT_CHARACTER
;
26244 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26245 temp_it
.face_id
= GLYPH_FACE (glyph
);
26246 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26248 PRODUCE_GLYPHS (&temp_it
);
26249 it
->pixel_width
= temp_it
.pixel_width
;
26250 it
->nglyphs
= temp_it
.nglyphs
;
26253 #ifdef HAVE_WINDOW_SYSTEM
26255 /* Calculate line-height and line-spacing properties.
26256 An integer value specifies explicit pixel value.
26257 A float value specifies relative value to current face height.
26258 A cons (float . face-name) specifies relative value to
26259 height of specified face font.
26261 Returns height in pixels, or nil. */
26264 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26265 int boff
, bool override
)
26267 Lisp_Object face_name
= Qnil
;
26268 int ascent
, descent
, height
;
26270 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26275 face_name
= XCAR (val
);
26277 if (!NUMBERP (val
))
26278 val
= make_number (1);
26279 if (NILP (face_name
))
26281 height
= it
->ascent
+ it
->descent
;
26286 if (NILP (face_name
))
26288 font
= FRAME_FONT (it
->f
);
26289 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26291 else if (EQ (face_name
, Qt
))
26300 face_id
= lookup_named_face (it
->f
, face_name
, false);
26302 return make_number (-1);
26304 face
= FACE_FROM_ID (it
->f
, face_id
);
26307 return make_number (-1);
26308 boff
= font
->baseline_offset
;
26309 if (font
->vertical_centering
)
26310 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26313 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26317 it
->override_ascent
= ascent
;
26318 it
->override_descent
= descent
;
26319 it
->override_boff
= boff
;
26322 height
= ascent
+ descent
;
26326 height
= (int)(XFLOAT_DATA (val
) * height
);
26327 else if (INTEGERP (val
))
26328 height
*= XINT (val
);
26330 return make_number (height
);
26334 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26335 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26336 and only if this is for a character for which no font was found.
26338 If the display method (it->glyphless_method) is
26339 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26340 length of the acronym or the hexadecimal string, UPPER_XOFF and
26341 UPPER_YOFF are pixel offsets for the upper part of the string,
26342 LOWER_XOFF and LOWER_YOFF are for the lower part.
26344 For the other display methods, LEN through LOWER_YOFF are zero. */
26347 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26348 short upper_xoff
, short upper_yoff
,
26349 short lower_xoff
, short lower_yoff
)
26351 struct glyph
*glyph
;
26352 enum glyph_row_area area
= it
->area
;
26354 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26355 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26357 /* If the glyph row is reversed, we need to prepend the glyph
26358 rather than append it. */
26359 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26363 /* Make room for the additional glyph. */
26364 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26366 glyph
= it
->glyph_row
->glyphs
[area
];
26368 glyph
->charpos
= CHARPOS (it
->position
);
26369 glyph
->object
= it
->object
;
26370 glyph
->pixel_width
= it
->pixel_width
;
26371 glyph
->ascent
= it
->ascent
;
26372 glyph
->descent
= it
->descent
;
26373 glyph
->voffset
= it
->voffset
;
26374 glyph
->type
= GLYPHLESS_GLYPH
;
26375 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26376 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26377 glyph
->u
.glyphless
.len
= len
;
26378 glyph
->u
.glyphless
.ch
= it
->c
;
26379 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26380 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26381 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26382 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26383 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26384 glyph
->multibyte_p
= it
->multibyte_p
;
26385 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26387 /* In R2L rows, the left and the right box edges need to be
26388 drawn in reverse direction. */
26389 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26390 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26394 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26395 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26397 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26398 || it
->phys_descent
> it
->descent
);
26399 glyph
->padding_p
= false;
26400 glyph
->glyph_not_available_p
= false;
26401 glyph
->face_id
= face_id
;
26402 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26405 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26406 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26407 glyph
->bidi_type
= it
->bidi_it
.type
;
26409 ++it
->glyph_row
->used
[area
];
26412 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26416 /* Produce a glyph for a glyphless character for iterator IT.
26417 IT->glyphless_method specifies which method to use for displaying
26418 the character. See the description of enum
26419 glyphless_display_method in dispextern.h for the detail.
26421 FOR_NO_FONT is true if and only if this is for a character for
26422 which no font was found. ACRONYM, if non-nil, is an acronym string
26423 for the character. */
26426 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26431 int base_width
, base_height
, width
, height
;
26432 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26435 /* Get the metrics of the base font. We always refer to the current
26437 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26438 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26439 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26440 it
->ascent
+= font
->baseline_offset
;
26441 it
->descent
-= font
->baseline_offset
;
26442 base_height
= it
->ascent
+ it
->descent
;
26443 base_width
= font
->average_width
;
26445 face_id
= merge_glyphless_glyph_face (it
);
26447 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26449 it
->pixel_width
= THIN_SPACE_WIDTH
;
26451 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26453 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26455 width
= CHAR_WIDTH (it
->c
);
26458 else if (width
> 4)
26460 it
->pixel_width
= base_width
* width
;
26462 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26468 unsigned int code
[6];
26470 int ascent
, descent
;
26471 struct font_metrics metrics_upper
, metrics_lower
;
26473 face
= FACE_FROM_ID (it
->f
, face_id
);
26474 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26475 prepare_face_for_display (it
->f
, face
);
26477 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26479 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26480 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26481 if (CONSP (acronym
))
26482 acronym
= XCAR (acronym
);
26483 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26487 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26488 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26491 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26492 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26493 upper_len
= (len
+ 1) / 2;
26494 font
->driver
->text_extents (font
, code
, upper_len
,
26496 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26501 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26502 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26503 upper_xoff
= upper_yoff
= 2; /* the typical case */
26504 if (base_width
>= width
)
26506 /* Align the upper to the left, the lower to the right. */
26507 it
->pixel_width
= base_width
;
26508 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26512 /* Center the shorter one. */
26513 it
->pixel_width
= width
;
26514 if (metrics_upper
.width
>= metrics_lower
.width
)
26515 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26518 /* FIXME: This code doesn't look right. It formerly was
26519 missing the "lower_xoff = 0;", which couldn't have
26520 been right since it left lower_xoff uninitialized. */
26522 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26526 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26527 top, bottom, and between upper and lower strings. */
26528 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26529 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26530 /* Center vertically.
26531 H:base_height, D:base_descent
26532 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26534 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26535 descent = D - H/2 + h/2;
26536 lower_yoff = descent - 2 - ld;
26537 upper_yoff = lower_yoff - la - 1 - ud; */
26538 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26539 descent
= it
->descent
- (base_height
- height
) / 2;
26540 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26541 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26542 - metrics_upper
.descent
);
26543 /* Don't make the height shorter than the base height. */
26544 if (height
> base_height
)
26546 it
->ascent
= ascent
;
26547 it
->descent
= descent
;
26551 it
->phys_ascent
= it
->ascent
;
26552 it
->phys_descent
= it
->descent
;
26554 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26555 upper_xoff
, upper_yoff
,
26556 lower_xoff
, lower_yoff
);
26558 take_vertical_position_into_account (it
);
26563 Produce glyphs/get display metrics for the display element IT is
26564 loaded with. See the description of struct it in dispextern.h
26565 for an overview of struct it. */
26568 x_produce_glyphs (struct it
*it
)
26570 int extra_line_spacing
= it
->extra_line_spacing
;
26572 it
->glyph_not_available_p
= false;
26574 if (it
->what
== IT_CHARACTER
)
26577 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26578 struct font
*font
= face
->font
;
26579 struct font_metrics
*pcm
= NULL
;
26580 int boff
; /* Baseline offset. */
26584 /* When no suitable font is found, display this character by
26585 the method specified in the first extra slot of
26586 Vglyphless_char_display. */
26587 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26589 eassert (it
->what
== IT_GLYPHLESS
);
26590 produce_glyphless_glyph (it
, true,
26591 STRINGP (acronym
) ? acronym
: Qnil
);
26595 boff
= font
->baseline_offset
;
26596 if (font
->vertical_centering
)
26597 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26599 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26603 if (it
->override_ascent
>= 0)
26605 it
->ascent
= it
->override_ascent
;
26606 it
->descent
= it
->override_descent
;
26607 boff
= it
->override_boff
;
26611 it
->ascent
= FONT_BASE (font
) + boff
;
26612 it
->descent
= FONT_DESCENT (font
) - boff
;
26615 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26617 pcm
= get_per_char_metric (font
, &char2b
);
26618 if (pcm
->width
== 0
26619 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26625 it
->phys_ascent
= pcm
->ascent
+ boff
;
26626 it
->phys_descent
= pcm
->descent
- boff
;
26627 it
->pixel_width
= pcm
->width
;
26628 /* Don't use font-global values for ascent and descent
26629 if they result in an exceedingly large line height. */
26630 if (it
->override_ascent
< 0)
26632 if (FONT_TOO_HIGH (font
))
26634 it
->ascent
= it
->phys_ascent
;
26635 it
->descent
= it
->phys_descent
;
26636 /* These limitations are enforced by an
26637 assertion near the end of this function. */
26638 if (it
->ascent
< 0)
26640 if (it
->descent
< 0)
26647 it
->glyph_not_available_p
= true;
26648 it
->phys_ascent
= it
->ascent
;
26649 it
->phys_descent
= it
->descent
;
26650 it
->pixel_width
= font
->space_width
;
26653 if (it
->constrain_row_ascent_descent_p
)
26655 if (it
->descent
> it
->max_descent
)
26657 it
->ascent
+= it
->descent
- it
->max_descent
;
26658 it
->descent
= it
->max_descent
;
26660 if (it
->ascent
> it
->max_ascent
)
26662 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26663 it
->ascent
= it
->max_ascent
;
26665 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26666 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26667 extra_line_spacing
= 0;
26670 /* If this is a space inside a region of text with
26671 `space-width' property, change its width. */
26673 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26675 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26677 /* If face has a box, add the box thickness to the character
26678 height. If character has a box line to the left and/or
26679 right, add the box line width to the character's width. */
26680 if (face
->box
!= FACE_NO_BOX
)
26682 int thick
= face
->box_line_width
;
26686 it
->ascent
+= thick
;
26687 it
->descent
+= thick
;
26692 if (it
->start_of_box_run_p
)
26693 it
->pixel_width
+= thick
;
26694 if (it
->end_of_box_run_p
)
26695 it
->pixel_width
+= thick
;
26698 /* If face has an overline, add the height of the overline
26699 (1 pixel) and a 1 pixel margin to the character height. */
26700 if (face
->overline_p
)
26701 it
->ascent
+= overline_margin
;
26703 if (it
->constrain_row_ascent_descent_p
)
26705 if (it
->ascent
> it
->max_ascent
)
26706 it
->ascent
= it
->max_ascent
;
26707 if (it
->descent
> it
->max_descent
)
26708 it
->descent
= it
->max_descent
;
26711 take_vertical_position_into_account (it
);
26713 /* If we have to actually produce glyphs, do it. */
26718 /* Translate a space with a `space-width' property
26719 into a stretch glyph. */
26720 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26721 / FONT_HEIGHT (font
));
26722 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26723 it
->ascent
+ it
->descent
, ascent
);
26728 /* If characters with lbearing or rbearing are displayed
26729 in this line, record that fact in a flag of the
26730 glyph row. This is used to optimize X output code. */
26731 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26732 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26734 if (! stretched_p
&& it
->pixel_width
== 0)
26735 /* We assure that all visible glyphs have at least 1-pixel
26737 it
->pixel_width
= 1;
26739 else if (it
->char_to_display
== '\n')
26741 /* A newline has no width, but we need the height of the
26742 line. But if previous part of the line sets a height,
26743 don't increase that height. */
26745 Lisp_Object height
;
26746 Lisp_Object total_height
= Qnil
;
26748 it
->override_ascent
= -1;
26749 it
->pixel_width
= 0;
26752 height
= get_it_property (it
, Qline_height
);
26753 /* Split (line-height total-height) list. */
26755 && CONSP (XCDR (height
))
26756 && NILP (XCDR (XCDR (height
))))
26758 total_height
= XCAR (XCDR (height
));
26759 height
= XCAR (height
);
26761 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26763 if (it
->override_ascent
>= 0)
26765 it
->ascent
= it
->override_ascent
;
26766 it
->descent
= it
->override_descent
;
26767 boff
= it
->override_boff
;
26771 if (FONT_TOO_HIGH (font
))
26773 it
->ascent
= font
->pixel_size
+ boff
- 1;
26774 it
->descent
= -boff
+ 1;
26775 if (it
->descent
< 0)
26780 it
->ascent
= FONT_BASE (font
) + boff
;
26781 it
->descent
= FONT_DESCENT (font
) - boff
;
26785 if (EQ (height
, Qt
))
26787 if (it
->descent
> it
->max_descent
)
26789 it
->ascent
+= it
->descent
- it
->max_descent
;
26790 it
->descent
= it
->max_descent
;
26792 if (it
->ascent
> it
->max_ascent
)
26794 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26795 it
->ascent
= it
->max_ascent
;
26797 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26798 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26799 it
->constrain_row_ascent_descent_p
= true;
26800 extra_line_spacing
= 0;
26804 Lisp_Object spacing
;
26806 it
->phys_ascent
= it
->ascent
;
26807 it
->phys_descent
= it
->descent
;
26809 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26810 && face
->box
!= FACE_NO_BOX
26811 && face
->box_line_width
> 0)
26813 it
->ascent
+= face
->box_line_width
;
26814 it
->descent
+= face
->box_line_width
;
26817 && XINT (height
) > it
->ascent
+ it
->descent
)
26818 it
->ascent
= XINT (height
) - it
->descent
;
26820 if (!NILP (total_height
))
26821 spacing
= calc_line_height_property (it
, total_height
, font
,
26825 spacing
= get_it_property (it
, Qline_spacing
);
26826 spacing
= calc_line_height_property (it
, spacing
, font
,
26829 if (INTEGERP (spacing
))
26831 extra_line_spacing
= XINT (spacing
);
26832 if (!NILP (total_height
))
26833 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26837 else /* i.e. (it->char_to_display == '\t') */
26839 if (font
->space_width
> 0)
26841 int tab_width
= it
->tab_width
* font
->space_width
;
26842 int x
= it
->current_x
+ it
->continuation_lines_width
;
26843 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26845 /* If the distance from the current position to the next tab
26846 stop is less than a space character width, use the
26847 tab stop after that. */
26848 if (next_tab_x
- x
< font
->space_width
)
26849 next_tab_x
+= tab_width
;
26851 it
->pixel_width
= next_tab_x
- x
;
26853 if (FONT_TOO_HIGH (font
))
26855 if (get_char_glyph_code (' ', font
, &char2b
))
26857 pcm
= get_per_char_metric (font
, &char2b
);
26858 if (pcm
->width
== 0
26859 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26865 it
->ascent
= pcm
->ascent
+ boff
;
26866 it
->descent
= pcm
->descent
- boff
;
26870 it
->ascent
= font
->pixel_size
+ boff
- 1;
26871 it
->descent
= -boff
+ 1;
26873 if (it
->ascent
< 0)
26875 if (it
->descent
< 0)
26880 it
->ascent
= FONT_BASE (font
) + boff
;
26881 it
->descent
= FONT_DESCENT (font
) - boff
;
26883 it
->phys_ascent
= it
->ascent
;
26884 it
->phys_descent
= it
->descent
;
26888 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26889 it
->ascent
+ it
->descent
, it
->ascent
);
26894 it
->pixel_width
= 0;
26899 if (FONT_TOO_HIGH (font
))
26901 int font_ascent
, font_descent
;
26903 /* For very large fonts, where we ignore the declared font
26904 dimensions, and go by per-character metrics instead,
26905 don't let the row ascent and descent values (and the row
26906 height computed from them) be smaller than the "normal"
26907 character metrics. This avoids unpleasant effects
26908 whereby lines on display would change their height
26909 depending on which characters are shown. */
26910 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26911 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26912 it
->max_descent
= max (it
->max_descent
, font_descent
);
26915 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26917 /* A static composition.
26919 Note: A composition is represented as one glyph in the
26920 glyph matrix. There are no padding glyphs.
26922 Important note: pixel_width, ascent, and descent are the
26923 values of what is drawn by draw_glyphs (i.e. the values of
26924 the overall glyphs composed). */
26925 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26926 int boff
; /* baseline offset */
26927 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26928 int glyph_len
= cmp
->glyph_len
;
26929 struct font
*font
= face
->font
;
26933 /* If we have not yet calculated pixel size data of glyphs of
26934 the composition for the current face font, calculate them
26935 now. Theoretically, we have to check all fonts for the
26936 glyphs, but that requires much time and memory space. So,
26937 here we check only the font of the first glyph. This may
26938 lead to incorrect display, but it's very rare, and C-l
26939 (recenter-top-bottom) can correct the display anyway. */
26940 if (! cmp
->font
|| cmp
->font
!= font
)
26942 /* Ascent and descent of the font of the first character
26943 of this composition (adjusted by baseline offset).
26944 Ascent and descent of overall glyphs should not be less
26945 than these, respectively. */
26946 int font_ascent
, font_descent
, font_height
;
26947 /* Bounding box of the overall glyphs. */
26948 int leftmost
, rightmost
, lowest
, highest
;
26949 int lbearing
, rbearing
;
26950 int i
, width
, ascent
, descent
;
26951 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26953 struct font_metrics
*pcm
;
26956 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26957 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26959 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26960 for (i
= 0; i
< glyph_len
; i
++)
26962 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26964 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26966 bool left_padded
= i
> 0;
26968 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26969 : IT_CHARPOS (*it
));
26970 /* If no suitable font is found, use the default font. */
26971 bool font_not_found_p
= font
== NULL
;
26972 if (font_not_found_p
)
26974 face
= face
->ascii_face
;
26977 boff
= font
->baseline_offset
;
26978 if (font
->vertical_centering
)
26979 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26980 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26981 font_ascent
+= boff
;
26982 font_descent
-= boff
;
26983 font_height
= font_ascent
+ font_descent
;
26988 if (! font_not_found_p
)
26990 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26992 pcm
= get_per_char_metric (font
, &char2b
);
26995 /* Initialize the bounding box. */
26998 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26999 ascent
= pcm
->ascent
;
27000 descent
= pcm
->descent
;
27001 lbearing
= pcm
->lbearing
;
27002 rbearing
= pcm
->rbearing
;
27006 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
27007 ascent
= FONT_BASE (font
);
27008 descent
= FONT_DESCENT (font
);
27015 lowest
= - descent
+ boff
;
27016 highest
= ascent
+ boff
;
27018 if (! font_not_found_p
27019 && font
->default_ascent
27020 && CHAR_TABLE_P (Vuse_default_ascent
)
27021 && !NILP (Faref (Vuse_default_ascent
,
27022 make_number (it
->char_to_display
))))
27023 highest
= font
->default_ascent
+ boff
;
27025 /* Draw the first glyph at the normal position. It may be
27026 shifted to right later if some other glyphs are drawn
27028 cmp
->offsets
[i
* 2] = 0;
27029 cmp
->offsets
[i
* 2 + 1] = boff
;
27030 cmp
->lbearing
= lbearing
;
27031 cmp
->rbearing
= rbearing
;
27033 /* Set cmp->offsets for the remaining glyphs. */
27034 for (i
++; i
< glyph_len
; i
++)
27036 int left
, right
, btm
, top
;
27037 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27039 struct face
*this_face
;
27043 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27044 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27045 font
= this_face
->font
;
27051 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27053 pcm
= get_per_char_metric (font
, &char2b
);
27056 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27059 width
= pcm
->width
;
27060 ascent
= pcm
->ascent
;
27061 descent
= pcm
->descent
;
27062 lbearing
= pcm
->lbearing
;
27063 rbearing
= pcm
->rbearing
;
27064 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27066 /* Relative composition with or without
27067 alternate chars. */
27068 left
= (leftmost
+ rightmost
- width
) / 2;
27069 btm
= - descent
+ boff
;
27070 if (font
->relative_compose
27071 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27072 || NILP (Faref (Vignore_relative_composition
,
27073 make_number (ch
)))))
27076 if (- descent
>= font
->relative_compose
)
27077 /* One extra pixel between two glyphs. */
27079 else if (ascent
<= 0)
27080 /* One extra pixel between two glyphs. */
27081 btm
= lowest
- 1 - ascent
- descent
;
27086 /* A composition rule is specified by an integer
27087 value that encodes global and new reference
27088 points (GREF and NREF). GREF and NREF are
27089 specified by numbers as below:
27091 0---1---2 -- ascent
27095 9--10--11 -- center
27097 ---3---4---5--- baseline
27099 6---7---8 -- descent
27101 int rule
= COMPOSITION_RULE (cmp
, i
);
27102 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27104 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27105 grefx
= gref
% 3, nrefx
= nref
% 3;
27106 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27108 xoff
= font_height
* (xoff
- 128) / 256;
27110 yoff
= font_height
* (yoff
- 128) / 256;
27113 + grefx
* (rightmost
- leftmost
) / 2
27114 - nrefx
* width
/ 2
27117 btm
= ((grefy
== 0 ? highest
27119 : grefy
== 2 ? lowest
27120 : (highest
+ lowest
) / 2)
27121 - (nrefy
== 0 ? ascent
+ descent
27122 : nrefy
== 1 ? descent
- boff
27124 : (ascent
+ descent
) / 2)
27128 cmp
->offsets
[i
* 2] = left
;
27129 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27131 /* Update the bounding box of the overall glyphs. */
27134 right
= left
+ width
;
27135 if (left
< leftmost
)
27137 if (right
> rightmost
)
27140 top
= btm
+ descent
+ ascent
;
27146 if (cmp
->lbearing
> left
+ lbearing
)
27147 cmp
->lbearing
= left
+ lbearing
;
27148 if (cmp
->rbearing
< left
+ rbearing
)
27149 cmp
->rbearing
= left
+ rbearing
;
27153 /* If there are glyphs whose x-offsets are negative,
27154 shift all glyphs to the right and make all x-offsets
27158 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27159 cmp
->offsets
[i
* 2] -= leftmost
;
27160 rightmost
-= leftmost
;
27161 cmp
->lbearing
-= leftmost
;
27162 cmp
->rbearing
-= leftmost
;
27165 if (left_padded
&& cmp
->lbearing
< 0)
27167 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27168 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27169 rightmost
-= cmp
->lbearing
;
27170 cmp
->rbearing
-= cmp
->lbearing
;
27173 if (right_padded
&& rightmost
< cmp
->rbearing
)
27175 rightmost
= cmp
->rbearing
;
27178 cmp
->pixel_width
= rightmost
;
27179 cmp
->ascent
= highest
;
27180 cmp
->descent
= - lowest
;
27181 if (cmp
->ascent
< font_ascent
)
27182 cmp
->ascent
= font_ascent
;
27183 if (cmp
->descent
< font_descent
)
27184 cmp
->descent
= font_descent
;
27188 && (cmp
->lbearing
< 0
27189 || cmp
->rbearing
> cmp
->pixel_width
))
27190 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27192 it
->pixel_width
= cmp
->pixel_width
;
27193 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27194 it
->descent
= it
->phys_descent
= cmp
->descent
;
27195 if (face
->box
!= FACE_NO_BOX
)
27197 int thick
= face
->box_line_width
;
27201 it
->ascent
+= thick
;
27202 it
->descent
+= thick
;
27207 if (it
->start_of_box_run_p
)
27208 it
->pixel_width
+= thick
;
27209 if (it
->end_of_box_run_p
)
27210 it
->pixel_width
+= thick
;
27213 /* If face has an overline, add the height of the overline
27214 (1 pixel) and a 1 pixel margin to the character height. */
27215 if (face
->overline_p
)
27216 it
->ascent
+= overline_margin
;
27218 take_vertical_position_into_account (it
);
27219 if (it
->ascent
< 0)
27221 if (it
->descent
< 0)
27224 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27225 append_composite_glyph (it
);
27227 else if (it
->what
== IT_COMPOSITION
)
27229 /* A dynamic (automatic) composition. */
27230 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27231 Lisp_Object gstring
;
27232 struct font_metrics metrics
;
27236 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27238 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27241 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27242 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27243 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27244 it
->descent
= it
->phys_descent
= metrics
.descent
;
27245 if (face
->box
!= FACE_NO_BOX
)
27247 int thick
= face
->box_line_width
;
27251 it
->ascent
+= thick
;
27252 it
->descent
+= thick
;
27257 if (it
->start_of_box_run_p
)
27258 it
->pixel_width
+= thick
;
27259 if (it
->end_of_box_run_p
)
27260 it
->pixel_width
+= thick
;
27262 /* If face has an overline, add the height of the overline
27263 (1 pixel) and a 1 pixel margin to the character height. */
27264 if (face
->overline_p
)
27265 it
->ascent
+= overline_margin
;
27266 take_vertical_position_into_account (it
);
27267 if (it
->ascent
< 0)
27269 if (it
->descent
< 0)
27273 append_composite_glyph (it
);
27275 else if (it
->what
== IT_GLYPHLESS
)
27276 produce_glyphless_glyph (it
, false, Qnil
);
27277 else if (it
->what
== IT_IMAGE
)
27278 produce_image_glyph (it
);
27279 else if (it
->what
== IT_STRETCH
)
27280 produce_stretch_glyph (it
);
27283 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27284 because this isn't true for images with `:ascent 100'. */
27285 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27286 if (it
->area
== TEXT_AREA
)
27287 it
->current_x
+= it
->pixel_width
;
27289 if (extra_line_spacing
> 0)
27291 it
->descent
+= extra_line_spacing
;
27292 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27293 it
->max_extra_line_spacing
= extra_line_spacing
;
27296 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27297 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27298 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27299 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27303 Output LEN glyphs starting at START at the nominal cursor position.
27304 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27305 being updated, and UPDATED_AREA is the area of that row being updated. */
27308 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27309 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27311 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27313 eassert (updated_row
);
27314 /* When the window is hscrolled, cursor hpos can legitimately be out
27315 of bounds, but we draw the cursor at the corresponding window
27316 margin in that case. */
27317 if (!updated_row
->reversed_p
&& chpos
< 0)
27319 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27320 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27324 /* Write glyphs. */
27326 hpos
= start
- updated_row
->glyphs
[updated_area
];
27327 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27328 updated_row
, updated_area
,
27330 DRAW_NORMAL_TEXT
, 0);
27332 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27333 if (updated_area
== TEXT_AREA
27334 && w
->phys_cursor_on_p
27335 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27337 && chpos
< hpos
+ len
)
27338 w
->phys_cursor_on_p
= false;
27342 /* Advance the output cursor. */
27343 w
->output_cursor
.hpos
+= len
;
27344 w
->output_cursor
.x
= x
;
27349 Insert LEN glyphs from START at the nominal cursor position. */
27352 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27353 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27356 int line_height
, shift_by_width
, shifted_region_width
;
27357 struct glyph_row
*row
;
27358 struct glyph
*glyph
;
27359 int frame_x
, frame_y
;
27362 eassert (updated_row
);
27364 f
= XFRAME (WINDOW_FRAME (w
));
27366 /* Get the height of the line we are in. */
27368 line_height
= row
->height
;
27370 /* Get the width of the glyphs to insert. */
27371 shift_by_width
= 0;
27372 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27373 shift_by_width
+= glyph
->pixel_width
;
27375 /* Get the width of the region to shift right. */
27376 shifted_region_width
= (window_box_width (w
, updated_area
)
27377 - w
->output_cursor
.x
27381 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27382 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27384 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27385 line_height
, shift_by_width
);
27387 /* Write the glyphs. */
27388 hpos
= start
- row
->glyphs
[updated_area
];
27389 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27391 DRAW_NORMAL_TEXT
, 0);
27393 /* Advance the output cursor. */
27394 w
->output_cursor
.hpos
+= len
;
27395 w
->output_cursor
.x
+= shift_by_width
;
27401 Erase the current text line from the nominal cursor position
27402 (inclusive) to pixel column TO_X (exclusive). The idea is that
27403 everything from TO_X onward is already erased.
27405 TO_X is a pixel position relative to UPDATED_AREA of currently
27406 updated window W. TO_X == -1 means clear to the end of this area. */
27409 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27410 enum glyph_row_area updated_area
, int to_x
)
27413 int max_x
, min_y
, max_y
;
27414 int from_x
, from_y
, to_y
;
27416 eassert (updated_row
);
27417 f
= XFRAME (w
->frame
);
27419 if (updated_row
->full_width_p
)
27420 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27421 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27423 max_x
= window_box_width (w
, updated_area
);
27424 max_y
= window_text_bottom_y (w
);
27426 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27427 of window. For TO_X > 0, truncate to end of drawing area. */
27433 to_x
= min (to_x
, max_x
);
27435 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27437 /* Notice if the cursor will be cleared by this operation. */
27438 if (!updated_row
->full_width_p
)
27439 notice_overwritten_cursor (w
, updated_area
,
27440 w
->output_cursor
.x
, -1,
27442 MATRIX_ROW_BOTTOM_Y (updated_row
));
27444 from_x
= w
->output_cursor
.x
;
27446 /* Translate to frame coordinates. */
27447 if (updated_row
->full_width_p
)
27449 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27450 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27454 int area_left
= window_box_left (w
, updated_area
);
27455 from_x
+= area_left
;
27459 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27460 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27461 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27463 /* Prevent inadvertently clearing to end of the X window. */
27464 if (to_x
> from_x
&& to_y
> from_y
)
27467 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27468 to_x
- from_x
, to_y
- from_y
);
27473 #endif /* HAVE_WINDOW_SYSTEM */
27477 /***********************************************************************
27479 ***********************************************************************/
27481 /* Value is the internal representation of the specified cursor type
27482 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27483 of the bar cursor. */
27485 static enum text_cursor_kinds
27486 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27488 enum text_cursor_kinds type
;
27493 if (EQ (arg
, Qbox
))
27494 return FILLED_BOX_CURSOR
;
27496 if (EQ (arg
, Qhollow
))
27497 return HOLLOW_BOX_CURSOR
;
27499 if (EQ (arg
, Qbar
))
27506 && EQ (XCAR (arg
), Qbar
)
27507 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27509 *width
= XINT (XCDR (arg
));
27513 if (EQ (arg
, Qhbar
))
27516 return HBAR_CURSOR
;
27520 && EQ (XCAR (arg
), Qhbar
)
27521 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27523 *width
= XINT (XCDR (arg
));
27524 return HBAR_CURSOR
;
27527 /* Treat anything unknown as "hollow box cursor".
27528 It was bad to signal an error; people have trouble fixing
27529 .Xdefaults with Emacs, when it has something bad in it. */
27530 type
= HOLLOW_BOX_CURSOR
;
27535 /* Set the default cursor types for specified frame. */
27537 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27542 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27543 FRAME_CURSOR_WIDTH (f
) = width
;
27545 /* By default, set up the blink-off state depending on the on-state. */
27547 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27550 FRAME_BLINK_OFF_CURSOR (f
)
27551 = get_specified_cursor_type (XCDR (tem
), &width
);
27552 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27555 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27557 /* Make sure the cursor gets redrawn. */
27558 f
->cursor_type_changed
= true;
27562 #ifdef HAVE_WINDOW_SYSTEM
27564 /* Return the cursor we want to be displayed in window W. Return
27565 width of bar/hbar cursor through WIDTH arg. Return with
27566 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27567 (i.e. if the `system caret' should track this cursor).
27569 In a mini-buffer window, we want the cursor only to appear if we
27570 are reading input from this window. For the selected window, we
27571 want the cursor type given by the frame parameter or buffer local
27572 setting of cursor-type. If explicitly marked off, draw no cursor.
27573 In all other cases, we want a hollow box cursor. */
27575 static enum text_cursor_kinds
27576 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27577 bool *active_cursor
)
27579 struct frame
*f
= XFRAME (w
->frame
);
27580 struct buffer
*b
= XBUFFER (w
->contents
);
27581 int cursor_type
= DEFAULT_CURSOR
;
27582 Lisp_Object alt_cursor
;
27583 bool non_selected
= false;
27585 *active_cursor
= true;
27588 if (cursor_in_echo_area
27589 && FRAME_HAS_MINIBUF_P (f
)
27590 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27592 if (w
== XWINDOW (echo_area_window
))
27594 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27596 *width
= FRAME_CURSOR_WIDTH (f
);
27597 return FRAME_DESIRED_CURSOR (f
);
27600 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27603 *active_cursor
= false;
27604 non_selected
= true;
27607 /* Detect a nonselected window or nonselected frame. */
27608 else if (w
!= XWINDOW (f
->selected_window
)
27609 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27611 *active_cursor
= false;
27613 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27616 non_selected
= true;
27619 /* Never display a cursor in a window in which cursor-type is nil. */
27620 if (NILP (BVAR (b
, cursor_type
)))
27623 /* Get the normal cursor type for this window. */
27624 if (EQ (BVAR (b
, cursor_type
), Qt
))
27626 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27627 *width
= FRAME_CURSOR_WIDTH (f
);
27630 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27632 /* Use cursor-in-non-selected-windows instead
27633 for non-selected window or frame. */
27636 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27637 if (!EQ (Qt
, alt_cursor
))
27638 return get_specified_cursor_type (alt_cursor
, width
);
27639 /* t means modify the normal cursor type. */
27640 if (cursor_type
== FILLED_BOX_CURSOR
)
27641 cursor_type
= HOLLOW_BOX_CURSOR
;
27642 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27644 return cursor_type
;
27647 /* Use normal cursor if not blinked off. */
27648 if (!w
->cursor_off_p
)
27650 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27652 if (cursor_type
== FILLED_BOX_CURSOR
)
27654 /* Using a block cursor on large images can be very annoying.
27655 So use a hollow cursor for "large" images.
27656 If image is not transparent (no mask), also use hollow cursor. */
27657 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27658 if (img
!= NULL
&& IMAGEP (img
->spec
))
27660 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27661 where N = size of default frame font size.
27662 This should cover most of the "tiny" icons people may use. */
27664 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27665 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27666 cursor_type
= HOLLOW_BOX_CURSOR
;
27669 else if (cursor_type
!= NO_CURSOR
)
27671 /* Display current only supports BOX and HOLLOW cursors for images.
27672 So for now, unconditionally use a HOLLOW cursor when cursor is
27673 not a solid box cursor. */
27674 cursor_type
= HOLLOW_BOX_CURSOR
;
27677 return cursor_type
;
27680 /* Cursor is blinked off, so determine how to "toggle" it. */
27682 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27683 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27684 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27686 /* Then see if frame has specified a specific blink off cursor type. */
27687 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27689 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27690 return FRAME_BLINK_OFF_CURSOR (f
);
27694 /* Some people liked having a permanently visible blinking cursor,
27695 while others had very strong opinions against it. So it was
27696 decided to remove it. KFS 2003-09-03 */
27698 /* Finally perform built-in cursor blinking:
27699 filled box <-> hollow box
27700 wide [h]bar <-> narrow [h]bar
27701 narrow [h]bar <-> no cursor
27702 other type <-> no cursor */
27704 if (cursor_type
== FILLED_BOX_CURSOR
)
27705 return HOLLOW_BOX_CURSOR
;
27707 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27710 return cursor_type
;
27718 /* Notice when the text cursor of window W has been completely
27719 overwritten by a drawing operation that outputs glyphs in AREA
27720 starting at X0 and ending at X1 in the line starting at Y0 and
27721 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27722 the rest of the line after X0 has been written. Y coordinates
27723 are window-relative. */
27726 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27727 int x0
, int x1
, int y0
, int y1
)
27729 int cx0
, cx1
, cy0
, cy1
;
27730 struct glyph_row
*row
;
27732 if (!w
->phys_cursor_on_p
)
27734 if (area
!= TEXT_AREA
)
27737 if (w
->phys_cursor
.vpos
< 0
27738 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27739 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27740 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27743 if (row
->cursor_in_fringe_p
)
27745 row
->cursor_in_fringe_p
= false;
27746 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27747 w
->phys_cursor_on_p
= false;
27751 cx0
= w
->phys_cursor
.x
;
27752 cx1
= cx0
+ w
->phys_cursor_width
;
27753 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27756 /* The cursor image will be completely removed from the
27757 screen if the output area intersects the cursor area in
27758 y-direction. When we draw in [y0 y1[, and some part of
27759 the cursor is at y < y0, that part must have been drawn
27760 before. When scrolling, the cursor is erased before
27761 actually scrolling, so we don't come here. When not
27762 scrolling, the rows above the old cursor row must have
27763 changed, and in this case these rows must have written
27764 over the cursor image.
27766 Likewise if part of the cursor is below y1, with the
27767 exception of the cursor being in the first blank row at
27768 the buffer and window end because update_text_area
27769 doesn't draw that row. (Except when it does, but
27770 that's handled in update_text_area.) */
27772 cy0
= w
->phys_cursor
.y
;
27773 cy1
= cy0
+ w
->phys_cursor_height
;
27774 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27777 w
->phys_cursor_on_p
= false;
27780 #endif /* HAVE_WINDOW_SYSTEM */
27783 /************************************************************************
27785 ************************************************************************/
27787 #ifdef HAVE_WINDOW_SYSTEM
27790 Fix the display of area AREA of overlapping row ROW in window W
27791 with respect to the overlapping part OVERLAPS. */
27794 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27795 enum glyph_row_area area
, int overlaps
)
27802 for (i
= 0; i
< row
->used
[area
];)
27804 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27806 int start
= i
, start_x
= x
;
27810 x
+= row
->glyphs
[area
][i
].pixel_width
;
27813 while (i
< row
->used
[area
]
27814 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27816 draw_glyphs (w
, start_x
, row
, area
,
27818 DRAW_NORMAL_TEXT
, overlaps
);
27822 x
+= row
->glyphs
[area
][i
].pixel_width
;
27832 Draw the cursor glyph of window W in glyph row ROW. See the
27833 comment of draw_glyphs for the meaning of HL. */
27836 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27837 enum draw_glyphs_face hl
)
27839 /* If cursor hpos is out of bounds, don't draw garbage. This can
27840 happen in mini-buffer windows when switching between echo area
27841 glyphs and mini-buffer. */
27842 if ((row
->reversed_p
27843 ? (w
->phys_cursor
.hpos
>= 0)
27844 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27846 bool on_p
= w
->phys_cursor_on_p
;
27848 int hpos
= w
->phys_cursor
.hpos
;
27850 /* When the window is hscrolled, cursor hpos can legitimately be
27851 out of bounds, but we draw the cursor at the corresponding
27852 window margin in that case. */
27853 if (!row
->reversed_p
&& hpos
< 0)
27855 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27856 hpos
= row
->used
[TEXT_AREA
] - 1;
27858 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27860 w
->phys_cursor_on_p
= on_p
;
27862 if (hl
== DRAW_CURSOR
)
27863 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27864 /* When we erase the cursor, and ROW is overlapped by other
27865 rows, make sure that these overlapping parts of other rows
27867 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27869 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27871 if (row
> w
->current_matrix
->rows
27872 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27873 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27874 OVERLAPS_ERASED_CURSOR
);
27876 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27877 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27878 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27879 OVERLAPS_ERASED_CURSOR
);
27885 /* Erase the image of a cursor of window W from the screen. */
27888 erase_phys_cursor (struct window
*w
)
27890 struct frame
*f
= XFRAME (w
->frame
);
27891 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27892 int hpos
= w
->phys_cursor
.hpos
;
27893 int vpos
= w
->phys_cursor
.vpos
;
27894 bool mouse_face_here_p
= false;
27895 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27896 struct glyph_row
*cursor_row
;
27897 struct glyph
*cursor_glyph
;
27898 enum draw_glyphs_face hl
;
27900 /* No cursor displayed or row invalidated => nothing to do on the
27902 if (w
->phys_cursor_type
== NO_CURSOR
)
27903 goto mark_cursor_off
;
27905 /* VPOS >= active_glyphs->nrows means that window has been resized.
27906 Don't bother to erase the cursor. */
27907 if (vpos
>= active_glyphs
->nrows
)
27908 goto mark_cursor_off
;
27910 /* If row containing cursor is marked invalid, there is nothing we
27912 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27913 if (!cursor_row
->enabled_p
)
27914 goto mark_cursor_off
;
27916 /* If line spacing is > 0, old cursor may only be partially visible in
27917 window after split-window. So adjust visible height. */
27918 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27919 window_text_bottom_y (w
) - cursor_row
->y
);
27921 /* If row is completely invisible, don't attempt to delete a cursor which
27922 isn't there. This can happen if cursor is at top of a window, and
27923 we switch to a buffer with a header line in that window. */
27924 if (cursor_row
->visible_height
<= 0)
27925 goto mark_cursor_off
;
27927 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27928 if (cursor_row
->cursor_in_fringe_p
)
27930 cursor_row
->cursor_in_fringe_p
= false;
27931 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27932 goto mark_cursor_off
;
27935 /* This can happen when the new row is shorter than the old one.
27936 In this case, either draw_glyphs or clear_end_of_line
27937 should have cleared the cursor. Note that we wouldn't be
27938 able to erase the cursor in this case because we don't have a
27939 cursor glyph at hand. */
27940 if ((cursor_row
->reversed_p
27941 ? (w
->phys_cursor
.hpos
< 0)
27942 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27943 goto mark_cursor_off
;
27945 /* When the window is hscrolled, cursor hpos can legitimately be out
27946 of bounds, but we draw the cursor at the corresponding window
27947 margin in that case. */
27948 if (!cursor_row
->reversed_p
&& hpos
< 0)
27950 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27951 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27953 /* If the cursor is in the mouse face area, redisplay that when
27954 we clear the cursor. */
27955 if (! NILP (hlinfo
->mouse_face_window
)
27956 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27957 /* Don't redraw the cursor's spot in mouse face if it is at the
27958 end of a line (on a newline). The cursor appears there, but
27959 mouse highlighting does not. */
27960 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27961 mouse_face_here_p
= true;
27963 /* Maybe clear the display under the cursor. */
27964 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27967 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27970 cursor_glyph
= get_phys_cursor_glyph (w
);
27971 if (cursor_glyph
== NULL
)
27972 goto mark_cursor_off
;
27974 width
= cursor_glyph
->pixel_width
;
27975 x
= w
->phys_cursor
.x
;
27981 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27982 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27983 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27986 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27989 /* Erase the cursor by redrawing the character underneath it. */
27990 if (mouse_face_here_p
)
27991 hl
= DRAW_MOUSE_FACE
;
27993 hl
= DRAW_NORMAL_TEXT
;
27994 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27997 w
->phys_cursor_on_p
= false;
27998 w
->phys_cursor_type
= NO_CURSOR
;
28002 /* Display or clear cursor of window W. If !ON, clear the cursor.
28003 If ON, display the cursor; where to put the cursor is specified by
28004 HPOS, VPOS, X and Y. */
28007 display_and_set_cursor (struct window
*w
, bool on
,
28008 int hpos
, int vpos
, int x
, int y
)
28010 struct frame
*f
= XFRAME (w
->frame
);
28011 int new_cursor_type
;
28012 int new_cursor_width
;
28013 bool active_cursor
;
28014 struct glyph_row
*glyph_row
;
28015 struct glyph
*glyph
;
28017 /* This is pointless on invisible frames, and dangerous on garbaged
28018 windows and frames; in the latter case, the frame or window may
28019 be in the midst of changing its size, and x and y may be off the
28021 if (! FRAME_VISIBLE_P (f
)
28022 || FRAME_GARBAGED_P (f
)
28023 || vpos
>= w
->current_matrix
->nrows
28024 || hpos
>= w
->current_matrix
->matrix_w
)
28027 /* If cursor is off and we want it off, return quickly. */
28028 if (!on
&& !w
->phys_cursor_on_p
)
28031 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28032 /* If cursor row is not enabled, we don't really know where to
28033 display the cursor. */
28034 if (!glyph_row
->enabled_p
)
28036 w
->phys_cursor_on_p
= false;
28041 if (!glyph_row
->exact_window_width_line_p
28042 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28043 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28045 eassert (input_blocked_p ());
28047 /* Set new_cursor_type to the cursor we want to be displayed. */
28048 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28049 &new_cursor_width
, &active_cursor
);
28051 /* If cursor is currently being shown and we don't want it to be or
28052 it is in the wrong place, or the cursor type is not what we want,
28054 if (w
->phys_cursor_on_p
28056 || w
->phys_cursor
.x
!= x
28057 || w
->phys_cursor
.y
!= y
28058 /* HPOS can be negative in R2L rows whose
28059 exact_window_width_line_p flag is set (i.e. their newline
28060 would "overflow into the fringe"). */
28062 || new_cursor_type
!= w
->phys_cursor_type
28063 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28064 && new_cursor_width
!= w
->phys_cursor_width
)))
28065 erase_phys_cursor (w
);
28067 /* Don't check phys_cursor_on_p here because that flag is only set
28068 to false in some cases where we know that the cursor has been
28069 completely erased, to avoid the extra work of erasing the cursor
28070 twice. In other words, phys_cursor_on_p can be true and the cursor
28071 still not be visible, or it has only been partly erased. */
28074 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28075 w
->phys_cursor_height
= glyph_row
->height
;
28077 /* Set phys_cursor_.* before x_draw_.* is called because some
28078 of them may need the information. */
28079 w
->phys_cursor
.x
= x
;
28080 w
->phys_cursor
.y
= glyph_row
->y
;
28081 w
->phys_cursor
.hpos
= hpos
;
28082 w
->phys_cursor
.vpos
= vpos
;
28085 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28086 new_cursor_type
, new_cursor_width
,
28087 on
, active_cursor
);
28091 /* Switch the display of W's cursor on or off, according to the value
28095 update_window_cursor (struct window
*w
, bool on
)
28097 /* Don't update cursor in windows whose frame is in the process
28098 of being deleted. */
28099 if (w
->current_matrix
)
28101 int hpos
= w
->phys_cursor
.hpos
;
28102 int vpos
= w
->phys_cursor
.vpos
;
28103 struct glyph_row
*row
;
28105 if (vpos
>= w
->current_matrix
->nrows
28106 || hpos
>= w
->current_matrix
->matrix_w
)
28109 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28111 /* When the window is hscrolled, cursor hpos can legitimately be
28112 out of bounds, but we draw the cursor at the corresponding
28113 window margin in that case. */
28114 if (!row
->reversed_p
&& hpos
< 0)
28116 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28117 hpos
= row
->used
[TEXT_AREA
] - 1;
28120 display_and_set_cursor (w
, on
, hpos
, vpos
,
28121 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28127 /* Call update_window_cursor with parameter ON_P on all leaf windows
28128 in the window tree rooted at W. */
28131 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28135 if (WINDOWP (w
->contents
))
28136 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28138 update_window_cursor (w
, on_p
);
28140 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28146 Display the cursor on window W, or clear it, according to ON_P.
28147 Don't change the cursor's position. */
28150 x_update_cursor (struct frame
*f
, bool on_p
)
28152 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28157 Clear the cursor of window W to background color, and mark the
28158 cursor as not shown. This is used when the text where the cursor
28159 is about to be rewritten. */
28162 x_clear_cursor (struct window
*w
)
28164 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28165 update_window_cursor (w
, false);
28168 #endif /* HAVE_WINDOW_SYSTEM */
28170 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28173 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28174 int start_hpos
, int end_hpos
,
28175 enum draw_glyphs_face draw
)
28177 #ifdef HAVE_WINDOW_SYSTEM
28178 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28180 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28184 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28185 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28189 /* Display the active region described by mouse_face_* according to DRAW. */
28192 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28194 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28195 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28197 if (/* If window is in the process of being destroyed, don't bother
28199 w
->current_matrix
!= NULL
28200 /* Don't update mouse highlight if hidden. */
28201 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28202 /* Recognize when we are called to operate on rows that don't exist
28203 anymore. This can happen when a window is split. */
28204 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28206 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28207 struct glyph_row
*row
, *first
, *last
;
28209 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28210 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28212 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28214 int start_hpos
, end_hpos
, start_x
;
28216 /* For all but the first row, the highlight starts at column 0. */
28219 /* R2L rows have BEG and END in reversed order, but the
28220 screen drawing geometry is always left to right. So
28221 we need to mirror the beginning and end of the
28222 highlighted area in R2L rows. */
28223 if (!row
->reversed_p
)
28225 start_hpos
= hlinfo
->mouse_face_beg_col
;
28226 start_x
= hlinfo
->mouse_face_beg_x
;
28228 else if (row
== last
)
28230 start_hpos
= hlinfo
->mouse_face_end_col
;
28231 start_x
= hlinfo
->mouse_face_end_x
;
28239 else if (row
->reversed_p
&& row
== last
)
28241 start_hpos
= hlinfo
->mouse_face_end_col
;
28242 start_x
= hlinfo
->mouse_face_end_x
;
28252 if (!row
->reversed_p
)
28253 end_hpos
= hlinfo
->mouse_face_end_col
;
28254 else if (row
== first
)
28255 end_hpos
= hlinfo
->mouse_face_beg_col
;
28258 end_hpos
= row
->used
[TEXT_AREA
];
28259 if (draw
== DRAW_NORMAL_TEXT
)
28260 row
->fill_line_p
= true; /* Clear to end of line. */
28263 else if (row
->reversed_p
&& row
== first
)
28264 end_hpos
= hlinfo
->mouse_face_beg_col
;
28267 end_hpos
= row
->used
[TEXT_AREA
];
28268 if (draw
== DRAW_NORMAL_TEXT
)
28269 row
->fill_line_p
= true; /* Clear to end of line. */
28272 if (end_hpos
> start_hpos
)
28274 draw_row_with_mouse_face (w
, start_x
, row
,
28275 start_hpos
, end_hpos
, draw
);
28278 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28282 #ifdef HAVE_WINDOW_SYSTEM
28283 /* When we've written over the cursor, arrange for it to
28284 be displayed again. */
28285 if (FRAME_WINDOW_P (f
)
28286 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28288 int hpos
= w
->phys_cursor
.hpos
;
28290 /* When the window is hscrolled, cursor hpos can legitimately be
28291 out of bounds, but we draw the cursor at the corresponding
28292 window margin in that case. */
28293 if (!row
->reversed_p
&& hpos
< 0)
28295 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28296 hpos
= row
->used
[TEXT_AREA
] - 1;
28299 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28300 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28303 #endif /* HAVE_WINDOW_SYSTEM */
28306 #ifdef HAVE_WINDOW_SYSTEM
28307 /* Change the mouse cursor. */
28308 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28310 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28311 if (draw
== DRAW_NORMAL_TEXT
28312 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28313 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28316 if (draw
== DRAW_MOUSE_FACE
)
28317 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28319 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28321 #endif /* HAVE_WINDOW_SYSTEM */
28325 Clear out the mouse-highlighted active region.
28326 Redraw it un-highlighted first. Value is true if mouse
28327 face was actually drawn unhighlighted. */
28330 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28333 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28335 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28336 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28337 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28338 hlinfo
->mouse_face_window
= Qnil
;
28339 hlinfo
->mouse_face_overlay
= Qnil
;
28343 /* Return true if the coordinates HPOS and VPOS on windows W are
28344 within the mouse face on that window. */
28346 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28348 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28350 /* Quickly resolve the easy cases. */
28351 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28352 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28354 if (vpos
< hlinfo
->mouse_face_beg_row
28355 || vpos
> hlinfo
->mouse_face_end_row
)
28357 if (vpos
> hlinfo
->mouse_face_beg_row
28358 && vpos
< hlinfo
->mouse_face_end_row
)
28361 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28363 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28365 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28368 else if ((vpos
== hlinfo
->mouse_face_beg_row
28369 && hpos
>= hlinfo
->mouse_face_beg_col
)
28370 || (vpos
== hlinfo
->mouse_face_end_row
28371 && hpos
< hlinfo
->mouse_face_end_col
))
28376 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28378 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28381 else if ((vpos
== hlinfo
->mouse_face_beg_row
28382 && hpos
<= hlinfo
->mouse_face_beg_col
)
28383 || (vpos
== hlinfo
->mouse_face_end_row
28384 && hpos
> hlinfo
->mouse_face_end_col
))
28392 True if physical cursor of window W is within mouse face. */
28395 cursor_in_mouse_face_p (struct window
*w
)
28397 int hpos
= w
->phys_cursor
.hpos
;
28398 int vpos
= w
->phys_cursor
.vpos
;
28399 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28401 /* When the window is hscrolled, cursor hpos can legitimately be out
28402 of bounds, but we draw the cursor at the corresponding window
28403 margin in that case. */
28404 if (!row
->reversed_p
&& hpos
< 0)
28406 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28407 hpos
= row
->used
[TEXT_AREA
] - 1;
28409 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28414 /* Find the glyph rows START_ROW and END_ROW of window W that display
28415 characters between buffer positions START_CHARPOS and END_CHARPOS
28416 (excluding END_CHARPOS). DISP_STRING is a display string that
28417 covers these buffer positions. This is similar to
28418 row_containing_pos, but is more accurate when bidi reordering makes
28419 buffer positions change non-linearly with glyph rows. */
28421 rows_from_pos_range (struct window
*w
,
28422 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28423 Lisp_Object disp_string
,
28424 struct glyph_row
**start
, struct glyph_row
**end
)
28426 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28427 int last_y
= window_text_bottom_y (w
);
28428 struct glyph_row
*row
;
28433 while (!first
->enabled_p
28434 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28437 /* Find the START row. */
28439 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28442 /* A row can potentially be the START row if the range of the
28443 characters it displays intersects the range
28444 [START_CHARPOS..END_CHARPOS). */
28445 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28446 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28447 /* See the commentary in row_containing_pos, for the
28448 explanation of the complicated way to check whether
28449 some position is beyond the end of the characters
28450 displayed by a row. */
28451 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28452 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28453 && !row
->ends_at_zv_p
28454 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28455 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28456 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28457 && !row
->ends_at_zv_p
28458 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28460 /* Found a candidate row. Now make sure at least one of the
28461 glyphs it displays has a charpos from the range
28462 [START_CHARPOS..END_CHARPOS).
28464 This is not obvious because bidi reordering could make
28465 buffer positions of a row be 1,2,3,102,101,100, and if we
28466 want to highlight characters in [50..60), we don't want
28467 this row, even though [50..60) does intersect [1..103),
28468 the range of character positions given by the row's start
28469 and end positions. */
28470 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28471 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28475 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28476 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28477 /* A glyph that comes from DISP_STRING is by
28478 definition to be highlighted. */
28479 || EQ (g
->object
, disp_string
))
28488 /* Find the END row. */
28490 /* If the last row is partially visible, start looking for END
28491 from that row, instead of starting from FIRST. */
28492 && !(row
->enabled_p
28493 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28495 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28497 struct glyph_row
*next
= row
+ 1;
28498 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28500 if (!next
->enabled_p
28501 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28502 /* The first row >= START whose range of displayed characters
28503 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28504 is the row END + 1. */
28505 || (start_charpos
< next_start
28506 && end_charpos
< next_start
)
28507 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28508 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28509 && !next
->ends_at_zv_p
28510 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28511 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28512 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28513 && !next
->ends_at_zv_p
28514 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28521 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28522 but none of the characters it displays are in the range, it is
28524 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28525 struct glyph
*s
= g
;
28526 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28530 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28531 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28532 /* If the buffer position of the first glyph in
28533 the row is equal to END_CHARPOS, it means
28534 the last character to be highlighted is the
28535 newline of ROW, and we must consider NEXT as
28537 || (((!next
->reversed_p
&& g
== s
)
28538 || (next
->reversed_p
&& g
== e
- 1))
28539 && (g
->charpos
== end_charpos
28540 /* Special case for when NEXT is an
28541 empty line at ZV. */
28542 || (g
->charpos
== -1
28543 && !row
->ends_at_zv_p
28544 && next_start
== end_charpos
)))))
28545 /* A glyph that comes from DISP_STRING is by
28546 definition to be highlighted. */
28547 || EQ (g
->object
, disp_string
))
28556 /* The first row that ends at ZV must be the last to be
28558 else if (next
->ends_at_zv_p
)
28567 /* This function sets the mouse_face_* elements of HLINFO, assuming
28568 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28569 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28570 for the overlay or run of text properties specifying the mouse
28571 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28572 before-string and after-string that must also be highlighted.
28573 DISP_STRING, if non-nil, is a display string that may cover some
28574 or all of the highlighted text. */
28577 mouse_face_from_buffer_pos (Lisp_Object window
,
28578 Mouse_HLInfo
*hlinfo
,
28579 ptrdiff_t mouse_charpos
,
28580 ptrdiff_t start_charpos
,
28581 ptrdiff_t end_charpos
,
28582 Lisp_Object before_string
,
28583 Lisp_Object after_string
,
28584 Lisp_Object disp_string
)
28586 struct window
*w
= XWINDOW (window
);
28587 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28588 struct glyph_row
*r1
, *r2
;
28589 struct glyph
*glyph
, *end
;
28590 ptrdiff_t ignore
, pos
;
28593 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28594 eassert (NILP (before_string
) || STRINGP (before_string
));
28595 eassert (NILP (after_string
) || STRINGP (after_string
));
28597 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28598 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28600 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28601 /* If the before-string or display-string contains newlines,
28602 rows_from_pos_range skips to its last row. Move back. */
28603 if (!NILP (before_string
) || !NILP (disp_string
))
28605 struct glyph_row
*prev
;
28606 while ((prev
= r1
- 1, prev
>= first
)
28607 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28608 && prev
->used
[TEXT_AREA
] > 0)
28610 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28611 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28612 while (--glyph
>= beg
&& NILP (glyph
->object
));
28614 || !(EQ (glyph
->object
, before_string
)
28615 || EQ (glyph
->object
, disp_string
)))
28622 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28623 hlinfo
->mouse_face_past_end
= true;
28625 else if (!NILP (after_string
))
28627 /* If the after-string has newlines, advance to its last row. */
28628 struct glyph_row
*next
;
28629 struct glyph_row
*last
28630 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28632 for (next
= r2
+ 1;
28634 && next
->used
[TEXT_AREA
] > 0
28635 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28639 /* The rest of the display engine assumes that mouse_face_beg_row is
28640 either above mouse_face_end_row or identical to it. But with
28641 bidi-reordered continued lines, the row for START_CHARPOS could
28642 be below the row for END_CHARPOS. If so, swap the rows and store
28643 them in correct order. */
28646 struct glyph_row
*tem
= r2
;
28652 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28653 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28655 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28656 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28657 could be anywhere in the row and in any order. The strategy
28658 below is to find the leftmost and the rightmost glyph that
28659 belongs to either of these 3 strings, or whose position is
28660 between START_CHARPOS and END_CHARPOS, and highlight all the
28661 glyphs between those two. This may cover more than just the text
28662 between START_CHARPOS and END_CHARPOS if the range of characters
28663 strides the bidi level boundary, e.g. if the beginning is in R2L
28664 text while the end is in L2R text or vice versa. */
28665 if (!r1
->reversed_p
)
28667 /* This row is in a left to right paragraph. Scan it left to
28669 glyph
= r1
->glyphs
[TEXT_AREA
];
28670 end
= glyph
+ r1
->used
[TEXT_AREA
];
28673 /* Skip truncation glyphs at the start of the glyph row. */
28674 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28676 && NILP (glyph
->object
)
28677 && glyph
->charpos
< 0;
28679 x
+= glyph
->pixel_width
;
28681 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28682 or DISP_STRING, and the first glyph from buffer whose
28683 position is between START_CHARPOS and END_CHARPOS. */
28685 && !NILP (glyph
->object
)
28686 && !EQ (glyph
->object
, disp_string
)
28687 && !(BUFFERP (glyph
->object
)
28688 && (glyph
->charpos
>= start_charpos
28689 && glyph
->charpos
< end_charpos
));
28692 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28693 are present at buffer positions between START_CHARPOS and
28694 END_CHARPOS, or if they come from an overlay. */
28695 if (EQ (glyph
->object
, before_string
))
28697 pos
= string_buffer_position (before_string
,
28699 /* If pos == 0, it means before_string came from an
28700 overlay, not from a buffer position. */
28701 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28704 else if (EQ (glyph
->object
, after_string
))
28706 pos
= string_buffer_position (after_string
, end_charpos
);
28707 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28710 x
+= glyph
->pixel_width
;
28712 hlinfo
->mouse_face_beg_x
= x
;
28713 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28717 /* This row is in a right to left paragraph. Scan it right to
28721 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28722 glyph
= end
+ r1
->used
[TEXT_AREA
];
28724 /* Skip truncation glyphs at the start of the glyph row. */
28725 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28727 && NILP (glyph
->object
)
28728 && glyph
->charpos
< 0;
28732 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28733 or DISP_STRING, and the first glyph from buffer whose
28734 position is between START_CHARPOS and END_CHARPOS. */
28736 && !NILP (glyph
->object
)
28737 && !EQ (glyph
->object
, disp_string
)
28738 && !(BUFFERP (glyph
->object
)
28739 && (glyph
->charpos
>= start_charpos
28740 && glyph
->charpos
< end_charpos
));
28743 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28744 are present at buffer positions between START_CHARPOS and
28745 END_CHARPOS, or if they come from an overlay. */
28746 if (EQ (glyph
->object
, before_string
))
28748 pos
= string_buffer_position (before_string
, start_charpos
);
28749 /* If pos == 0, it means before_string came from an
28750 overlay, not from a buffer position. */
28751 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28754 else if (EQ (glyph
->object
, after_string
))
28756 pos
= string_buffer_position (after_string
, end_charpos
);
28757 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28762 glyph
++; /* first glyph to the right of the highlighted area */
28763 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28764 x
+= g
->pixel_width
;
28765 hlinfo
->mouse_face_beg_x
= x
;
28766 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28769 /* If the highlight ends in a different row, compute GLYPH and END
28770 for the end row. Otherwise, reuse the values computed above for
28771 the row where the highlight begins. */
28774 if (!r2
->reversed_p
)
28776 glyph
= r2
->glyphs
[TEXT_AREA
];
28777 end
= glyph
+ r2
->used
[TEXT_AREA
];
28782 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28783 glyph
= end
+ r2
->used
[TEXT_AREA
];
28787 if (!r2
->reversed_p
)
28789 /* Skip truncation and continuation glyphs near the end of the
28790 row, and also blanks and stretch glyphs inserted by
28791 extend_face_to_end_of_line. */
28793 && NILP ((end
- 1)->object
))
28795 /* Scan the rest of the glyph row from the end, looking for the
28796 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28797 DISP_STRING, or whose position is between START_CHARPOS
28801 && !NILP (end
->object
)
28802 && !EQ (end
->object
, disp_string
)
28803 && !(BUFFERP (end
->object
)
28804 && (end
->charpos
>= start_charpos
28805 && end
->charpos
< end_charpos
));
28808 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28809 are present at buffer positions between START_CHARPOS and
28810 END_CHARPOS, or if they come from an overlay. */
28811 if (EQ (end
->object
, before_string
))
28813 pos
= string_buffer_position (before_string
, start_charpos
);
28814 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28817 else if (EQ (end
->object
, after_string
))
28819 pos
= string_buffer_position (after_string
, end_charpos
);
28820 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28824 /* Find the X coordinate of the last glyph to be highlighted. */
28825 for (; glyph
<= end
; ++glyph
)
28826 x
+= glyph
->pixel_width
;
28828 hlinfo
->mouse_face_end_x
= x
;
28829 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28833 /* Skip truncation and continuation glyphs near the end of the
28834 row, and also blanks and stretch glyphs inserted by
28835 extend_face_to_end_of_line. */
28839 && NILP (end
->object
))
28841 x
+= end
->pixel_width
;
28844 /* Scan the rest of the glyph row from the end, looking for the
28845 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28846 DISP_STRING, or whose position is between START_CHARPOS
28850 && !NILP (end
->object
)
28851 && !EQ (end
->object
, disp_string
)
28852 && !(BUFFERP (end
->object
)
28853 && (end
->charpos
>= start_charpos
28854 && end
->charpos
< end_charpos
));
28857 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28858 are present at buffer positions between START_CHARPOS and
28859 END_CHARPOS, or if they come from an overlay. */
28860 if (EQ (end
->object
, before_string
))
28862 pos
= string_buffer_position (before_string
, start_charpos
);
28863 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28866 else if (EQ (end
->object
, after_string
))
28868 pos
= string_buffer_position (after_string
, end_charpos
);
28869 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28872 x
+= end
->pixel_width
;
28874 /* If we exited the above loop because we arrived at the last
28875 glyph of the row, and its buffer position is still not in
28876 range, it means the last character in range is the preceding
28877 newline. Bump the end column and x values to get past the
28880 && BUFFERP (end
->object
)
28881 && (end
->charpos
< start_charpos
28882 || end
->charpos
>= end_charpos
))
28884 x
+= end
->pixel_width
;
28887 hlinfo
->mouse_face_end_x
= x
;
28888 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28891 hlinfo
->mouse_face_window
= window
;
28892 hlinfo
->mouse_face_face_id
28893 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28895 !hlinfo
->mouse_face_hidden
, -1);
28896 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28899 /* The following function is not used anymore (replaced with
28900 mouse_face_from_string_pos), but I leave it here for the time
28901 being, in case someone would. */
28903 #if false /* not used */
28905 /* Find the position of the glyph for position POS in OBJECT in
28906 window W's current matrix, and return in *X, *Y the pixel
28907 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28909 RIGHT_P means return the position of the right edge of the glyph.
28910 !RIGHT_P means return the left edge position.
28912 If no glyph for POS exists in the matrix, return the position of
28913 the glyph with the next smaller position that is in the matrix, if
28914 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28915 exists in the matrix, return the position of the glyph with the
28916 next larger position in OBJECT.
28918 Value is true if a glyph was found. */
28921 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28922 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28924 int yb
= window_text_bottom_y (w
);
28925 struct glyph_row
*r
;
28926 struct glyph
*best_glyph
= NULL
;
28927 struct glyph_row
*best_row
= NULL
;
28930 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28931 r
->enabled_p
&& r
->y
< yb
;
28934 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28935 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28938 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28939 if (EQ (g
->object
, object
))
28941 if (g
->charpos
== pos
)
28948 else if (best_glyph
== NULL
28949 || ((eabs (g
->charpos
- pos
)
28950 < eabs (best_glyph
->charpos
- pos
))
28953 : g
->charpos
> pos
)))
28967 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28971 *x
+= best_glyph
->pixel_width
;
28976 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28979 return best_glyph
!= NULL
;
28981 #endif /* not used */
28983 /* Find the positions of the first and the last glyphs in window W's
28984 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28985 (assumed to be a string), and return in HLINFO's mouse_face_*
28986 members the pixel and column/row coordinates of those glyphs. */
28989 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28990 Lisp_Object object
,
28991 ptrdiff_t startpos
, ptrdiff_t endpos
)
28993 int yb
= window_text_bottom_y (w
);
28994 struct glyph_row
*r
;
28995 struct glyph
*g
, *e
;
28997 bool found
= false;
28999 /* Find the glyph row with at least one position in the range
29000 [STARTPOS..ENDPOS), and the first glyph in that row whose
29001 position belongs to that range. */
29002 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
29003 r
->enabled_p
&& r
->y
< yb
;
29006 if (!r
->reversed_p
)
29008 g
= r
->glyphs
[TEXT_AREA
];
29009 e
= g
+ r
->used
[TEXT_AREA
];
29010 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
29011 if (EQ (g
->object
, object
)
29012 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29014 hlinfo
->mouse_face_beg_row
29015 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29016 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29017 hlinfo
->mouse_face_beg_x
= gx
;
29026 e
= r
->glyphs
[TEXT_AREA
];
29027 g
= e
+ r
->used
[TEXT_AREA
];
29028 for ( ; g
> e
; --g
)
29029 if (EQ ((g
-1)->object
, object
)
29030 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29032 hlinfo
->mouse_face_beg_row
29033 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29034 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29035 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29036 gx
+= g1
->pixel_width
;
29037 hlinfo
->mouse_face_beg_x
= gx
;
29049 /* Starting with the next row, look for the first row which does NOT
29050 include any glyphs whose positions are in the range. */
29051 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29053 g
= r
->glyphs
[TEXT_AREA
];
29054 e
= g
+ r
->used
[TEXT_AREA
];
29056 for ( ; g
< e
; ++g
)
29057 if (EQ (g
->object
, object
)
29058 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29067 /* The highlighted region ends on the previous row. */
29070 /* Set the end row. */
29071 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29073 /* Compute and set the end column and the end column's horizontal
29074 pixel coordinate. */
29075 if (!r
->reversed_p
)
29077 g
= r
->glyphs
[TEXT_AREA
];
29078 e
= g
+ r
->used
[TEXT_AREA
];
29079 for ( ; e
> g
; --e
)
29080 if (EQ ((e
-1)->object
, object
)
29081 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29083 hlinfo
->mouse_face_end_col
= e
- g
;
29085 for (gx
= r
->x
; g
< e
; ++g
)
29086 gx
+= g
->pixel_width
;
29087 hlinfo
->mouse_face_end_x
= gx
;
29091 e
= r
->glyphs
[TEXT_AREA
];
29092 g
= e
+ r
->used
[TEXT_AREA
];
29093 for (gx
= r
->x
; e
< g
; ++e
)
29095 if (EQ (e
->object
, object
)
29096 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29098 gx
+= e
->pixel_width
;
29100 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29101 hlinfo
->mouse_face_end_x
= gx
;
29105 #ifdef HAVE_WINDOW_SYSTEM
29107 /* See if position X, Y is within a hot-spot of an image. */
29110 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29112 if (!CONSP (hot_spot
))
29115 if (EQ (XCAR (hot_spot
), Qrect
))
29117 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29118 Lisp_Object rect
= XCDR (hot_spot
);
29122 if (!CONSP (XCAR (rect
)))
29124 if (!CONSP (XCDR (rect
)))
29126 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29128 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29130 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29132 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29136 else if (EQ (XCAR (hot_spot
), Qcircle
))
29138 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29139 Lisp_Object circ
= XCDR (hot_spot
);
29140 Lisp_Object lr
, lx0
, ly0
;
29142 && CONSP (XCAR (circ
))
29143 && (lr
= XCDR (circ
), NUMBERP (lr
))
29144 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29145 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29147 double r
= XFLOATINT (lr
);
29148 double dx
= XINT (lx0
) - x
;
29149 double dy
= XINT (ly0
) - y
;
29150 return (dx
* dx
+ dy
* dy
<= r
* r
);
29153 else if (EQ (XCAR (hot_spot
), Qpoly
))
29155 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29156 if (VECTORP (XCDR (hot_spot
)))
29158 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29159 Lisp_Object
*poly
= v
->contents
;
29160 ptrdiff_t n
= v
->header
.size
;
29162 bool inside
= false;
29163 Lisp_Object lx
, ly
;
29166 /* Need an even number of coordinates, and at least 3 edges. */
29167 if (n
< 6 || n
& 1)
29170 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29171 If count is odd, we are inside polygon. Pixels on edges
29172 may or may not be included depending on actual geometry of the
29174 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29175 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29177 x0
= XINT (lx
), y0
= XINT (ly
);
29178 for (i
= 0; i
< n
; i
+= 2)
29180 int x1
= x0
, y1
= y0
;
29181 if ((lx
= poly
[i
], !INTEGERP (lx
))
29182 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29184 x0
= XINT (lx
), y0
= XINT (ly
);
29186 /* Does this segment cross the X line? */
29194 if (y
> y0
&& y
> y1
)
29196 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29206 find_hot_spot (Lisp_Object map
, int x
, int y
)
29208 while (CONSP (map
))
29210 if (CONSP (XCAR (map
))
29211 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29219 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29221 doc
: /* Lookup in image map MAP coordinates X and Y.
29222 An image map is an alist where each element has the format (AREA ID PLIST).
29223 An AREA is specified as either a rectangle, a circle, or a polygon:
29224 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29225 pixel coordinates of the upper left and bottom right corners.
29226 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29227 and the radius of the circle; r may be a float or integer.
29228 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29229 vector describes one corner in the polygon.
29230 Returns the alist element for the first matching AREA in MAP. */)
29231 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29239 return find_hot_spot (map
,
29240 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29241 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29245 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29247 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29249 /* Do not change cursor shape while dragging mouse. */
29250 if (EQ (do_mouse_tracking
, Qdragging
))
29253 if (!NILP (pointer
))
29255 if (EQ (pointer
, Qarrow
))
29256 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29257 else if (EQ (pointer
, Qhand
))
29258 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29259 else if (EQ (pointer
, Qtext
))
29260 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29261 else if (EQ (pointer
, intern ("hdrag")))
29262 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29263 else if (EQ (pointer
, intern ("nhdrag")))
29264 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29265 #ifdef HAVE_X_WINDOWS
29266 else if (EQ (pointer
, intern ("vdrag")))
29267 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29269 else if (EQ (pointer
, intern ("hourglass")))
29270 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29271 else if (EQ (pointer
, Qmodeline
))
29272 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29274 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29277 if (cursor
!= No_Cursor
)
29278 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29281 #endif /* HAVE_WINDOW_SYSTEM */
29283 /* Take proper action when mouse has moved to the mode or header line
29284 or marginal area AREA of window W, x-position X and y-position Y.
29285 X is relative to the start of the text display area of W, so the
29286 width of bitmap areas and scroll bars must be subtracted to get a
29287 position relative to the start of the mode line. */
29290 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29291 enum window_part area
)
29293 struct window
*w
= XWINDOW (window
);
29294 struct frame
*f
= XFRAME (w
->frame
);
29295 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29296 #ifdef HAVE_WINDOW_SYSTEM
29297 Display_Info
*dpyinfo
;
29299 Cursor cursor
= No_Cursor
;
29300 Lisp_Object pointer
= Qnil
;
29301 int dx
, dy
, width
, height
;
29303 Lisp_Object string
, object
= Qnil
;
29304 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29306 Lisp_Object mouse_face
;
29307 int original_x_pixel
= x
;
29308 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29309 struct glyph_row
*row
IF_LINT (= 0);
29311 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29316 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29317 returns them in row/column units! */
29318 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29319 &object
, &dx
, &dy
, &width
, &height
);
29321 row
= (area
== ON_MODE_LINE
29322 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29323 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29325 /* Find the glyph under the mouse pointer. */
29326 if (row
->mode_line_p
&& row
->enabled_p
)
29328 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29329 end
= glyph
+ row
->used
[TEXT_AREA
];
29331 for (x0
= original_x_pixel
;
29332 glyph
< end
&& x0
>= glyph
->pixel_width
;
29334 x0
-= glyph
->pixel_width
;
29342 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29343 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29344 returns them in row/column units! */
29345 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29346 &object
, &dx
, &dy
, &width
, &height
);
29351 #ifdef HAVE_WINDOW_SYSTEM
29352 if (IMAGEP (object
))
29354 Lisp_Object image_map
, hotspot
;
29355 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29357 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29359 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29363 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29364 If so, we could look for mouse-enter, mouse-leave
29365 properties in PLIST (and do something...). */
29366 hotspot
= XCDR (hotspot
);
29367 if (CONSP (hotspot
)
29368 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29370 pointer
= Fplist_get (plist
, Qpointer
);
29371 if (NILP (pointer
))
29373 help
= Fplist_get (plist
, Qhelp_echo
);
29376 help_echo_string
= help
;
29377 XSETWINDOW (help_echo_window
, w
);
29378 help_echo_object
= w
->contents
;
29379 help_echo_pos
= charpos
;
29383 if (NILP (pointer
))
29384 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29386 #endif /* HAVE_WINDOW_SYSTEM */
29388 if (STRINGP (string
))
29389 pos
= make_number (charpos
);
29391 /* Set the help text and mouse pointer. If the mouse is on a part
29392 of the mode line without any text (e.g. past the right edge of
29393 the mode line text), use the default help text and pointer. */
29394 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29396 /* Arrange to display the help by setting the global variables
29397 help_echo_string, help_echo_object, and help_echo_pos. */
29400 if (STRINGP (string
))
29401 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29405 help_echo_string
= help
;
29406 XSETWINDOW (help_echo_window
, w
);
29407 help_echo_object
= string
;
29408 help_echo_pos
= charpos
;
29410 else if (area
== ON_MODE_LINE
)
29412 Lisp_Object default_help
29413 = buffer_local_value (Qmode_line_default_help_echo
,
29416 if (STRINGP (default_help
))
29418 help_echo_string
= default_help
;
29419 XSETWINDOW (help_echo_window
, w
);
29420 help_echo_object
= Qnil
;
29421 help_echo_pos
= -1;
29426 #ifdef HAVE_WINDOW_SYSTEM
29427 /* Change the mouse pointer according to what is under it. */
29428 if (FRAME_WINDOW_P (f
))
29430 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29432 || NILP (Vresize_mini_windows
));
29434 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29435 if (STRINGP (string
))
29437 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29439 if (NILP (pointer
))
29440 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29442 /* Change the mouse pointer according to what is under X/Y. */
29444 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29447 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29448 if (!KEYMAPP (map
))
29449 map
= Fget_text_property (pos
, Qkeymap
, string
);
29450 if (!KEYMAPP (map
) && draggable
)
29451 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29454 else if (draggable
)
29455 /* Default mode-line pointer. */
29456 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29461 /* Change the mouse face according to what is under X/Y. */
29462 bool mouse_face_shown
= false;
29463 if (STRINGP (string
))
29465 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29466 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29467 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29472 struct glyph
* tmp_glyph
;
29476 int total_pixel_width
;
29477 ptrdiff_t begpos
, endpos
, ignore
;
29481 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29482 Qmouse_face
, string
, Qnil
);
29488 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29490 endpos
= SCHARS (string
);
29494 /* Calculate the glyph position GPOS of GLYPH in the
29495 displayed string, relative to the beginning of the
29496 highlighted part of the string.
29498 Note: GPOS is different from CHARPOS. CHARPOS is the
29499 position of GLYPH in the internal string object. A mode
29500 line string format has structures which are converted to
29501 a flattened string by the Emacs Lisp interpreter. The
29502 internal string is an element of those structures. The
29503 displayed string is the flattened string. */
29504 tmp_glyph
= row_start_glyph
;
29505 while (tmp_glyph
< glyph
29506 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29507 && begpos
<= tmp_glyph
->charpos
29508 && tmp_glyph
->charpos
< endpos
)))
29510 gpos
= glyph
- tmp_glyph
;
29512 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29513 the highlighted part of the displayed string to which
29514 GLYPH belongs. Note: GSEQ_LENGTH is different from
29515 SCHARS (STRING), because the latter returns the length of
29516 the internal string. */
29517 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29519 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29520 && begpos
<= tmp_glyph
->charpos
29521 && tmp_glyph
->charpos
< endpos
));
29524 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29526 /* Calculate the total pixel width of all the glyphs between
29527 the beginning of the highlighted area and GLYPH. */
29528 total_pixel_width
= 0;
29529 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29530 total_pixel_width
+= tmp_glyph
->pixel_width
;
29532 /* Pre calculation of re-rendering position. Note: X is in
29533 column units here, after the call to mode_line_string or
29534 marginal_area_string. */
29536 vpos
= (area
== ON_MODE_LINE
29537 ? (w
->current_matrix
)->nrows
- 1
29540 /* If GLYPH's position is included in the region that is
29541 already drawn in mouse face, we have nothing to do. */
29542 if ( EQ (window
, hlinfo
->mouse_face_window
)
29543 && (!row
->reversed_p
29544 ? (hlinfo
->mouse_face_beg_col
<= hpos
29545 && hpos
< hlinfo
->mouse_face_end_col
)
29546 /* In R2L rows we swap BEG and END, see below. */
29547 : (hlinfo
->mouse_face_end_col
<= hpos
29548 && hpos
< hlinfo
->mouse_face_beg_col
))
29549 && hlinfo
->mouse_face_beg_row
== vpos
)
29552 if (clear_mouse_face (hlinfo
))
29553 cursor
= No_Cursor
;
29555 if (!row
->reversed_p
)
29557 hlinfo
->mouse_face_beg_col
= hpos
;
29558 hlinfo
->mouse_face_beg_x
= original_x_pixel
29559 - (total_pixel_width
+ dx
);
29560 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29561 hlinfo
->mouse_face_end_x
= 0;
29565 /* In R2L rows, show_mouse_face expects BEG and END
29566 coordinates to be swapped. */
29567 hlinfo
->mouse_face_end_col
= hpos
;
29568 hlinfo
->mouse_face_end_x
= original_x_pixel
29569 - (total_pixel_width
+ dx
);
29570 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29571 hlinfo
->mouse_face_beg_x
= 0;
29574 hlinfo
->mouse_face_beg_row
= vpos
;
29575 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29576 hlinfo
->mouse_face_past_end
= false;
29577 hlinfo
->mouse_face_window
= window
;
29579 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29584 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29585 mouse_face_shown
= true;
29587 if (NILP (pointer
))
29592 /* If mouse-face doesn't need to be shown, clear any existing
29594 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29595 clear_mouse_face (hlinfo
);
29597 #ifdef HAVE_WINDOW_SYSTEM
29598 if (FRAME_WINDOW_P (f
))
29599 define_frame_cursor1 (f
, cursor
, pointer
);
29605 Take proper action when the mouse has moved to position X, Y on
29606 frame F with regards to highlighting portions of display that have
29607 mouse-face properties. Also de-highlight portions of display where
29608 the mouse was before, set the mouse pointer shape as appropriate
29609 for the mouse coordinates, and activate help echo (tooltips).
29610 X and Y can be negative or out of range. */
29613 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29615 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29616 enum window_part part
= ON_NOTHING
;
29617 Lisp_Object window
;
29619 Cursor cursor
= No_Cursor
;
29620 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29623 /* When a menu is active, don't highlight because this looks odd. */
29624 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29625 if (popup_activated ())
29629 if (!f
->glyphs_initialized_p
29630 || f
->pointer_invisible
)
29633 hlinfo
->mouse_face_mouse_x
= x
;
29634 hlinfo
->mouse_face_mouse_y
= y
;
29635 hlinfo
->mouse_face_mouse_frame
= f
;
29637 if (hlinfo
->mouse_face_defer
)
29640 /* Which window is that in? */
29641 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29643 /* If displaying active text in another window, clear that. */
29644 if (! EQ (window
, hlinfo
->mouse_face_window
)
29645 /* Also clear if we move out of text area in same window. */
29646 || (!NILP (hlinfo
->mouse_face_window
)
29649 && part
!= ON_MODE_LINE
29650 && part
!= ON_HEADER_LINE
))
29651 clear_mouse_face (hlinfo
);
29653 /* Not on a window -> return. */
29654 if (!WINDOWP (window
))
29657 /* Reset help_echo_string. It will get recomputed below. */
29658 help_echo_string
= Qnil
;
29660 /* Convert to window-relative pixel coordinates. */
29661 w
= XWINDOW (window
);
29662 frame_to_window_pixel_xy (w
, &x
, &y
);
29664 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29665 /* Handle tool-bar window differently since it doesn't display a
29667 if (EQ (window
, f
->tool_bar_window
))
29669 note_tool_bar_highlight (f
, x
, y
);
29674 /* Mouse is on the mode, header line or margin? */
29675 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29676 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29678 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29680 #ifdef HAVE_WINDOW_SYSTEM
29681 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29683 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29684 /* Show non-text cursor (Bug#16647). */
29692 #ifdef HAVE_WINDOW_SYSTEM
29693 if (part
== ON_VERTICAL_BORDER
)
29695 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29696 help_echo_string
= build_string ("drag-mouse-1: resize");
29698 else if (part
== ON_RIGHT_DIVIDER
)
29700 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29701 help_echo_string
= build_string ("drag-mouse-1: resize");
29703 else if (part
== ON_BOTTOM_DIVIDER
)
29704 if (! WINDOW_BOTTOMMOST_P (w
)
29706 || NILP (Vresize_mini_windows
))
29708 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29709 help_echo_string
= build_string ("drag-mouse-1: resize");
29712 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29713 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29714 || part
== ON_VERTICAL_SCROLL_BAR
29715 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29716 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29718 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29721 /* Are we in a window whose display is up to date?
29722 And verify the buffer's text has not changed. */
29723 b
= XBUFFER (w
->contents
);
29724 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29726 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29728 struct glyph
*glyph
;
29729 Lisp_Object object
;
29730 Lisp_Object mouse_face
= Qnil
, position
;
29731 Lisp_Object
*overlay_vec
= NULL
;
29732 ptrdiff_t i
, noverlays
;
29733 struct buffer
*obuf
;
29734 ptrdiff_t obegv
, ozv
;
29737 /* Find the glyph under X/Y. */
29738 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29740 #ifdef HAVE_WINDOW_SYSTEM
29741 /* Look for :pointer property on image. */
29742 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29744 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29745 if (img
!= NULL
&& IMAGEP (img
->spec
))
29747 Lisp_Object image_map
, hotspot
;
29748 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29750 && (hotspot
= find_hot_spot (image_map
,
29751 glyph
->slice
.img
.x
+ dx
,
29752 glyph
->slice
.img
.y
+ dy
),
29754 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29758 /* Could check XCAR (hotspot) to see if we enter/leave
29760 If so, we could look for mouse-enter, mouse-leave
29761 properties in PLIST (and do something...). */
29762 hotspot
= XCDR (hotspot
);
29763 if (CONSP (hotspot
)
29764 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29766 pointer
= Fplist_get (plist
, Qpointer
);
29767 if (NILP (pointer
))
29769 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29770 if (!NILP (help_echo_string
))
29772 help_echo_window
= window
;
29773 help_echo_object
= glyph
->object
;
29774 help_echo_pos
= glyph
->charpos
;
29778 if (NILP (pointer
))
29779 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29782 #endif /* HAVE_WINDOW_SYSTEM */
29784 /* Clear mouse face if X/Y not over text. */
29786 || area
!= TEXT_AREA
29787 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29788 /* Glyph's OBJECT is nil for glyphs inserted by the
29789 display engine for its internal purposes, like truncation
29790 and continuation glyphs and blanks beyond the end of
29791 line's text on text terminals. If we are over such a
29792 glyph, we are not over any text. */
29793 || NILP (glyph
->object
)
29794 /* R2L rows have a stretch glyph at their front, which
29795 stands for no text, whereas L2R rows have no glyphs at
29796 all beyond the end of text. Treat such stretch glyphs
29797 like we do with NULL glyphs in L2R rows. */
29798 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29799 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29800 && glyph
->type
== STRETCH_GLYPH
29801 && glyph
->avoid_cursor_p
))
29803 if (clear_mouse_face (hlinfo
))
29804 cursor
= No_Cursor
;
29805 #ifdef HAVE_WINDOW_SYSTEM
29806 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29808 if (area
!= TEXT_AREA
)
29809 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29811 pointer
= Vvoid_text_area_pointer
;
29817 pos
= glyph
->charpos
;
29818 object
= glyph
->object
;
29819 if (!STRINGP (object
) && !BUFFERP (object
))
29822 /* If we get an out-of-range value, return now; avoid an error. */
29823 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29826 /* Make the window's buffer temporarily current for
29827 overlays_at and compute_char_face. */
29828 obuf
= current_buffer
;
29829 current_buffer
= b
;
29835 /* Is this char mouse-active or does it have help-echo? */
29836 position
= make_number (pos
);
29840 if (BUFFERP (object
))
29842 /* Put all the overlays we want in a vector in overlay_vec. */
29843 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29844 /* Sort overlays into increasing priority order. */
29845 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29850 if (NILP (Vmouse_highlight
))
29852 clear_mouse_face (hlinfo
);
29853 goto check_help_echo
;
29856 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29859 cursor
= No_Cursor
;
29861 /* Check mouse-face highlighting. */
29863 /* If there exists an overlay with mouse-face overlapping
29864 the one we are currently highlighting, we have to
29865 check if we enter the overlapping overlay, and then
29866 highlight only that. */
29867 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29868 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29870 /* Find the highest priority overlay with a mouse-face. */
29871 Lisp_Object overlay
= Qnil
;
29872 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29874 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29875 if (!NILP (mouse_face
))
29876 overlay
= overlay_vec
[i
];
29879 /* If we're highlighting the same overlay as before, there's
29880 no need to do that again. */
29881 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29882 goto check_help_echo
;
29883 hlinfo
->mouse_face_overlay
= overlay
;
29885 /* Clear the display of the old active region, if any. */
29886 if (clear_mouse_face (hlinfo
))
29887 cursor
= No_Cursor
;
29889 /* If no overlay applies, get a text property. */
29890 if (NILP (overlay
))
29891 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29893 /* Next, compute the bounds of the mouse highlighting and
29895 if (!NILP (mouse_face
) && STRINGP (object
))
29897 /* The mouse-highlighting comes from a display string
29898 with a mouse-face. */
29902 s
= Fprevious_single_property_change
29903 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29904 e
= Fnext_single_property_change
29905 (position
, Qmouse_face
, object
, Qnil
);
29907 s
= make_number (0);
29909 e
= make_number (SCHARS (object
));
29910 mouse_face_from_string_pos (w
, hlinfo
, object
,
29911 XINT (s
), XINT (e
));
29912 hlinfo
->mouse_face_past_end
= false;
29913 hlinfo
->mouse_face_window
= window
;
29914 hlinfo
->mouse_face_face_id
29915 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29916 glyph
->face_id
, true);
29917 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29918 cursor
= No_Cursor
;
29922 /* The mouse-highlighting, if any, comes from an overlay
29923 or text property in the buffer. */
29924 Lisp_Object buffer
IF_LINT (= Qnil
);
29925 Lisp_Object disp_string
IF_LINT (= Qnil
);
29927 if (STRINGP (object
))
29929 /* If we are on a display string with no mouse-face,
29930 check if the text under it has one. */
29931 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29932 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29933 pos
= string_buffer_position (object
, start
);
29936 mouse_face
= get_char_property_and_overlay
29937 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29938 buffer
= w
->contents
;
29939 disp_string
= object
;
29945 disp_string
= Qnil
;
29948 if (!NILP (mouse_face
))
29950 Lisp_Object before
, after
;
29951 Lisp_Object before_string
, after_string
;
29952 /* To correctly find the limits of mouse highlight
29953 in a bidi-reordered buffer, we must not use the
29954 optimization of limiting the search in
29955 previous-single-property-change and
29956 next-single-property-change, because
29957 rows_from_pos_range needs the real start and end
29958 positions to DTRT in this case. That's because
29959 the first row visible in a window does not
29960 necessarily display the character whose position
29961 is the smallest. */
29963 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29964 ? Fmarker_position (w
->start
)
29967 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29968 ? make_number (BUF_Z (XBUFFER (buffer
))
29969 - w
->window_end_pos
)
29972 if (NILP (overlay
))
29974 /* Handle the text property case. */
29975 before
= Fprevious_single_property_change
29976 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29977 after
= Fnext_single_property_change
29978 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29979 before_string
= after_string
= Qnil
;
29983 /* Handle the overlay case. */
29984 before
= Foverlay_start (overlay
);
29985 after
= Foverlay_end (overlay
);
29986 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29987 after_string
= Foverlay_get (overlay
, Qafter_string
);
29989 if (!STRINGP (before_string
)) before_string
= Qnil
;
29990 if (!STRINGP (after_string
)) after_string
= Qnil
;
29993 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29996 : XFASTINT (before
),
29998 ? BUF_Z (XBUFFER (buffer
))
29999 : XFASTINT (after
),
30000 before_string
, after_string
,
30002 cursor
= No_Cursor
;
30009 /* Look for a `help-echo' property. */
30010 if (NILP (help_echo_string
)) {
30011 Lisp_Object help
, overlay
;
30013 /* Check overlays first. */
30014 help
= overlay
= Qnil
;
30015 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30017 overlay
= overlay_vec
[i
];
30018 help
= Foverlay_get (overlay
, Qhelp_echo
);
30023 help_echo_string
= help
;
30024 help_echo_window
= window
;
30025 help_echo_object
= overlay
;
30026 help_echo_pos
= pos
;
30030 Lisp_Object obj
= glyph
->object
;
30031 ptrdiff_t charpos
= glyph
->charpos
;
30033 /* Try text properties. */
30036 && charpos
< SCHARS (obj
))
30038 help
= Fget_text_property (make_number (charpos
),
30042 /* If the string itself doesn't specify a help-echo,
30043 see if the buffer text ``under'' it does. */
30044 struct glyph_row
*r
30045 = MATRIX_ROW (w
->current_matrix
, vpos
);
30046 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30047 ptrdiff_t p
= string_buffer_position (obj
, start
);
30050 help
= Fget_char_property (make_number (p
),
30051 Qhelp_echo
, w
->contents
);
30060 else if (BUFFERP (obj
)
30063 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30068 help_echo_string
= help
;
30069 help_echo_window
= window
;
30070 help_echo_object
= obj
;
30071 help_echo_pos
= charpos
;
30076 #ifdef HAVE_WINDOW_SYSTEM
30077 /* Look for a `pointer' property. */
30078 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30080 /* Check overlays first. */
30081 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30082 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30084 if (NILP (pointer
))
30086 Lisp_Object obj
= glyph
->object
;
30087 ptrdiff_t charpos
= glyph
->charpos
;
30089 /* Try text properties. */
30092 && charpos
< SCHARS (obj
))
30094 pointer
= Fget_text_property (make_number (charpos
),
30096 if (NILP (pointer
))
30098 /* If the string itself doesn't specify a pointer,
30099 see if the buffer text ``under'' it does. */
30100 struct glyph_row
*r
30101 = MATRIX_ROW (w
->current_matrix
, vpos
);
30102 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30103 ptrdiff_t p
= string_buffer_position (obj
, start
);
30105 pointer
= Fget_char_property (make_number (p
),
30106 Qpointer
, w
->contents
);
30109 else if (BUFFERP (obj
)
30112 pointer
= Fget_text_property (make_number (charpos
),
30116 #endif /* HAVE_WINDOW_SYSTEM */
30120 current_buffer
= obuf
;
30126 #ifdef HAVE_WINDOW_SYSTEM
30127 if (FRAME_WINDOW_P (f
))
30128 define_frame_cursor1 (f
, cursor
, pointer
);
30130 /* This is here to prevent a compiler error, about "label at end of
30131 compound statement". */
30138 Clear any mouse-face on window W. This function is part of the
30139 redisplay interface, and is called from try_window_id and similar
30140 functions to ensure the mouse-highlight is off. */
30143 x_clear_window_mouse_face (struct window
*w
)
30145 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30146 Lisp_Object window
;
30149 XSETWINDOW (window
, w
);
30150 if (EQ (window
, hlinfo
->mouse_face_window
))
30151 clear_mouse_face (hlinfo
);
30157 Just discard the mouse face information for frame F, if any.
30158 This is used when the size of F is changed. */
30161 cancel_mouse_face (struct frame
*f
)
30163 Lisp_Object window
;
30164 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30166 window
= hlinfo
->mouse_face_window
;
30167 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30168 reset_mouse_highlight (hlinfo
);
30173 /***********************************************************************
30175 ***********************************************************************/
30177 #ifdef HAVE_WINDOW_SYSTEM
30179 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30180 which intersects rectangle R. R is in window-relative coordinates. */
30183 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30184 enum glyph_row_area area
)
30186 struct glyph
*first
= row
->glyphs
[area
];
30187 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30188 struct glyph
*last
;
30189 int first_x
, start_x
, x
;
30191 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30192 /* If row extends face to end of line write the whole line. */
30193 draw_glyphs (w
, 0, row
, area
,
30194 0, row
->used
[area
],
30195 DRAW_NORMAL_TEXT
, 0);
30198 /* Set START_X to the window-relative start position for drawing glyphs of
30199 AREA. The first glyph of the text area can be partially visible.
30200 The first glyphs of other areas cannot. */
30201 start_x
= window_box_left_offset (w
, area
);
30203 if (area
== TEXT_AREA
)
30206 /* Find the first glyph that must be redrawn. */
30208 && x
+ first
->pixel_width
< r
->x
)
30210 x
+= first
->pixel_width
;
30214 /* Find the last one. */
30217 /* Use a signed int intermediate value to avoid catastrophic
30218 failures due to comparison between signed and unsigned, when
30219 x is negative (can happen for wide images that are hscrolled). */
30220 int r_end
= r
->x
+ r
->width
;
30221 while (last
< end
&& x
< r_end
)
30223 x
+= last
->pixel_width
;
30229 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30230 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30231 DRAW_NORMAL_TEXT
, 0);
30236 /* Redraw the parts of the glyph row ROW on window W intersecting
30237 rectangle R. R is in window-relative coordinates. Value is
30238 true if mouse-face was overwritten. */
30241 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30243 eassert (row
->enabled_p
);
30245 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30246 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30247 0, row
->used
[TEXT_AREA
],
30248 DRAW_NORMAL_TEXT
, 0);
30251 if (row
->used
[LEFT_MARGIN_AREA
])
30252 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30253 if (row
->used
[TEXT_AREA
])
30254 expose_area (w
, row
, r
, TEXT_AREA
);
30255 if (row
->used
[RIGHT_MARGIN_AREA
])
30256 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30257 draw_row_fringe_bitmaps (w
, row
);
30260 return row
->mouse_face_p
;
30264 /* Redraw those parts of glyphs rows during expose event handling that
30265 overlap other rows. Redrawing of an exposed line writes over parts
30266 of lines overlapping that exposed line; this function fixes that.
30268 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30269 row in W's current matrix that is exposed and overlaps other rows.
30270 LAST_OVERLAPPING_ROW is the last such row. */
30273 expose_overlaps (struct window
*w
,
30274 struct glyph_row
*first_overlapping_row
,
30275 struct glyph_row
*last_overlapping_row
,
30278 struct glyph_row
*row
;
30280 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30281 if (row
->overlapping_p
)
30283 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30286 if (row
->used
[LEFT_MARGIN_AREA
])
30287 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30289 if (row
->used
[TEXT_AREA
])
30290 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30292 if (row
->used
[RIGHT_MARGIN_AREA
])
30293 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30299 /* Return true if W's cursor intersects rectangle R. */
30302 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30304 XRectangle cr
, result
;
30305 struct glyph
*cursor_glyph
;
30306 struct glyph_row
*row
;
30308 if (w
->phys_cursor
.vpos
>= 0
30309 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30310 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30312 && row
->cursor_in_fringe_p
)
30314 /* Cursor is in the fringe. */
30315 cr
.x
= window_box_right_offset (w
,
30316 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30317 ? RIGHT_MARGIN_AREA
30320 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30321 cr
.height
= row
->height
;
30322 return x_intersect_rectangles (&cr
, r
, &result
);
30325 cursor_glyph
= get_phys_cursor_glyph (w
);
30328 /* r is relative to W's box, but w->phys_cursor.x is relative
30329 to left edge of W's TEXT area. Adjust it. */
30330 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30331 cr
.y
= w
->phys_cursor
.y
;
30332 cr
.width
= cursor_glyph
->pixel_width
;
30333 cr
.height
= w
->phys_cursor_height
;
30334 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30335 I assume the effect is the same -- and this is portable. */
30336 return x_intersect_rectangles (&cr
, r
, &result
);
30338 /* If we don't understand the format, pretend we're not in the hot-spot. */
30344 Draw a vertical window border to the right of window W if W doesn't
30345 have vertical scroll bars. */
30348 x_draw_vertical_border (struct window
*w
)
30350 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30352 /* We could do better, if we knew what type of scroll-bar the adjacent
30353 windows (on either side) have... But we don't :-(
30354 However, I think this works ok. ++KFS 2003-04-25 */
30356 /* Redraw borders between horizontally adjacent windows. Don't
30357 do it for frames with vertical scroll bars because either the
30358 right scroll bar of a window, or the left scroll bar of its
30359 neighbor will suffice as a border. */
30360 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30363 /* Note: It is necessary to redraw both the left and the right
30364 borders, for when only this single window W is being
30366 if (!WINDOW_RIGHTMOST_P (w
)
30367 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30369 int x0
, x1
, y0
, y1
;
30371 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30374 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30377 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30380 if (!WINDOW_LEFTMOST_P (w
)
30381 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30383 int x0
, x1
, y0
, y1
;
30385 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30388 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30391 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30396 /* Draw window dividers for window W. */
30399 x_draw_right_divider (struct window
*w
)
30401 struct frame
*f
= WINDOW_XFRAME (w
);
30403 if (w
->mini
|| w
->pseudo_window_p
)
30405 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30407 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30408 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30409 int y0
= WINDOW_TOP_EDGE_Y (w
);
30410 /* The bottom divider prevails. */
30411 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30413 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30418 x_draw_bottom_divider (struct window
*w
)
30420 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30422 if (w
->mini
|| w
->pseudo_window_p
)
30424 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30426 int x0
= WINDOW_LEFT_EDGE_X (w
);
30427 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30428 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30429 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30431 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30435 /* Redraw the part of window W intersection rectangle FR. Pixel
30436 coordinates in FR are frame-relative. Call this function with
30437 input blocked. Value is true if the exposure overwrites
30441 expose_window (struct window
*w
, XRectangle
*fr
)
30443 struct frame
*f
= XFRAME (w
->frame
);
30445 bool mouse_face_overwritten_p
= false;
30447 /* If window is not yet fully initialized, do nothing. This can
30448 happen when toolkit scroll bars are used and a window is split.
30449 Reconfiguring the scroll bar will generate an expose for a newly
30451 if (w
->current_matrix
== NULL
)
30454 /* When we're currently updating the window, display and current
30455 matrix usually don't agree. Arrange for a thorough display
30457 if (w
->must_be_updated_p
)
30459 SET_FRAME_GARBAGED (f
);
30463 /* Frame-relative pixel rectangle of W. */
30464 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30465 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30466 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30467 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30469 if (x_intersect_rectangles (fr
, &wr
, &r
))
30471 int yb
= window_text_bottom_y (w
);
30472 struct glyph_row
*row
;
30473 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30475 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30476 r
.x
, r
.y
, r
.width
, r
.height
));
30478 /* Convert to window coordinates. */
30479 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30480 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30482 /* Turn off the cursor. */
30483 bool cursor_cleared_p
= (!w
->pseudo_window_p
30484 && phys_cursor_in_rect_p (w
, &r
));
30485 if (cursor_cleared_p
)
30486 x_clear_cursor (w
);
30488 /* If the row containing the cursor extends face to end of line,
30489 then expose_area might overwrite the cursor outside the
30490 rectangle and thus notice_overwritten_cursor might clear
30491 w->phys_cursor_on_p. We remember the original value and
30492 check later if it is changed. */
30493 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30495 /* Use a signed int intermediate value to avoid catastrophic
30496 failures due to comparison between signed and unsigned, when
30497 y0 or y1 is negative (can happen for tall images). */
30498 int r_bottom
= r
.y
+ r
.height
;
30500 /* Update lines intersecting rectangle R. */
30501 first_overlapping_row
= last_overlapping_row
= NULL
;
30502 for (row
= w
->current_matrix
->rows
;
30507 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30509 if ((y0
>= r
.y
&& y0
< r_bottom
)
30510 || (y1
> r
.y
&& y1
< r_bottom
)
30511 || (r
.y
>= y0
&& r
.y
< y1
)
30512 || (r_bottom
> y0
&& r_bottom
< y1
))
30514 /* A header line may be overlapping, but there is no need
30515 to fix overlapping areas for them. KFS 2005-02-12 */
30516 if (row
->overlapping_p
&& !row
->mode_line_p
)
30518 if (first_overlapping_row
== NULL
)
30519 first_overlapping_row
= row
;
30520 last_overlapping_row
= row
;
30524 if (expose_line (w
, row
, &r
))
30525 mouse_face_overwritten_p
= true;
30528 else if (row
->overlapping_p
)
30530 /* We must redraw a row overlapping the exposed area. */
30532 ? y0
+ row
->phys_height
> r
.y
30533 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30535 if (first_overlapping_row
== NULL
)
30536 first_overlapping_row
= row
;
30537 last_overlapping_row
= row
;
30545 /* Display the mode line if there is one. */
30546 if (WINDOW_WANTS_MODELINE_P (w
)
30547 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30549 && row
->y
< r_bottom
)
30551 if (expose_line (w
, row
, &r
))
30552 mouse_face_overwritten_p
= true;
30555 if (!w
->pseudo_window_p
)
30557 /* Fix the display of overlapping rows. */
30558 if (first_overlapping_row
)
30559 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30562 /* Draw border between windows. */
30563 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30564 x_draw_right_divider (w
);
30566 x_draw_vertical_border (w
);
30568 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30569 x_draw_bottom_divider (w
);
30571 /* Turn the cursor on again. */
30572 if (cursor_cleared_p
30573 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30574 update_window_cursor (w
, true);
30578 return mouse_face_overwritten_p
;
30583 /* Redraw (parts) of all windows in the window tree rooted at W that
30584 intersect R. R contains frame pixel coordinates. Value is
30585 true if the exposure overwrites mouse-face. */
30588 expose_window_tree (struct window
*w
, XRectangle
*r
)
30590 struct frame
*f
= XFRAME (w
->frame
);
30591 bool mouse_face_overwritten_p
= false;
30593 while (w
&& !FRAME_GARBAGED_P (f
))
30595 mouse_face_overwritten_p
30596 |= (WINDOWP (w
->contents
)
30597 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30598 : expose_window (w
, r
));
30600 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30603 return mouse_face_overwritten_p
;
30608 Redisplay an exposed area of frame F. X and Y are the upper-left
30609 corner of the exposed rectangle. W and H are width and height of
30610 the exposed area. All are pixel values. W or H zero means redraw
30611 the entire frame. */
30614 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30617 bool mouse_face_overwritten_p
= false;
30619 TRACE ((stderr
, "expose_frame "));
30621 /* No need to redraw if frame will be redrawn soon. */
30622 if (FRAME_GARBAGED_P (f
))
30624 TRACE ((stderr
, " garbaged\n"));
30628 /* If basic faces haven't been realized yet, there is no point in
30629 trying to redraw anything. This can happen when we get an expose
30630 event while Emacs is starting, e.g. by moving another window. */
30631 if (FRAME_FACE_CACHE (f
) == NULL
30632 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30634 TRACE ((stderr
, " no faces\n"));
30638 if (w
== 0 || h
== 0)
30641 r
.width
= FRAME_TEXT_WIDTH (f
);
30642 r
.height
= FRAME_TEXT_HEIGHT (f
);
30652 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30653 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30655 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30656 if (WINDOWP (f
->tool_bar_window
))
30657 mouse_face_overwritten_p
30658 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30661 #ifdef HAVE_X_WINDOWS
30663 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30664 if (WINDOWP (f
->menu_bar_window
))
30665 mouse_face_overwritten_p
30666 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30667 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30671 /* Some window managers support a focus-follows-mouse style with
30672 delayed raising of frames. Imagine a partially obscured frame,
30673 and moving the mouse into partially obscured mouse-face on that
30674 frame. The visible part of the mouse-face will be highlighted,
30675 then the WM raises the obscured frame. With at least one WM, KDE
30676 2.1, Emacs is not getting any event for the raising of the frame
30677 (even tried with SubstructureRedirectMask), only Expose events.
30678 These expose events will draw text normally, i.e. not
30679 highlighted. Which means we must redo the highlight here.
30680 Subsume it under ``we love X''. --gerd 2001-08-15 */
30681 /* Included in Windows version because Windows most likely does not
30682 do the right thing if any third party tool offers
30683 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30684 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30686 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30687 if (f
== hlinfo
->mouse_face_mouse_frame
)
30689 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30690 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30691 clear_mouse_face (hlinfo
);
30692 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30699 Determine the intersection of two rectangles R1 and R2. Return
30700 the intersection in *RESULT. Value is true if RESULT is not
30704 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30706 XRectangle
*left
, *right
;
30707 XRectangle
*upper
, *lower
;
30708 bool intersection_p
= false;
30710 /* Rearrange so that R1 is the left-most rectangle. */
30712 left
= r1
, right
= r2
;
30714 left
= r2
, right
= r1
;
30716 /* X0 of the intersection is right.x0, if this is inside R1,
30717 otherwise there is no intersection. */
30718 if (right
->x
<= left
->x
+ left
->width
)
30720 result
->x
= right
->x
;
30722 /* The right end of the intersection is the minimum of
30723 the right ends of left and right. */
30724 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30727 /* Same game for Y. */
30729 upper
= r1
, lower
= r2
;
30731 upper
= r2
, lower
= r1
;
30733 /* The upper end of the intersection is lower.y0, if this is inside
30734 of upper. Otherwise, there is no intersection. */
30735 if (lower
->y
<= upper
->y
+ upper
->height
)
30737 result
->y
= lower
->y
;
30739 /* The lower end of the intersection is the minimum of the lower
30740 ends of upper and lower. */
30741 result
->height
= (min (lower
->y
+ lower
->height
,
30742 upper
->y
+ upper
->height
)
30744 intersection_p
= true;
30748 return intersection_p
;
30751 #endif /* HAVE_WINDOW_SYSTEM */
30754 /***********************************************************************
30756 ***********************************************************************/
30759 syms_of_xdisp (void)
30761 Vwith_echo_area_save_vector
= Qnil
;
30762 staticpro (&Vwith_echo_area_save_vector
);
30764 Vmessage_stack
= Qnil
;
30765 staticpro (&Vmessage_stack
);
30767 /* Non-nil means don't actually do any redisplay. */
30768 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30770 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30772 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30773 doc
: /* Non-nil means calls to `message' are not displayed.
30774 They are still logged to the *Messages* buffer. */);
30775 inhibit_message
= 0;
30777 message_dolog_marker1
= Fmake_marker ();
30778 staticpro (&message_dolog_marker1
);
30779 message_dolog_marker2
= Fmake_marker ();
30780 staticpro (&message_dolog_marker2
);
30781 message_dolog_marker3
= Fmake_marker ();
30782 staticpro (&message_dolog_marker3
);
30785 defsubr (&Sdump_frame_glyph_matrix
);
30786 defsubr (&Sdump_glyph_matrix
);
30787 defsubr (&Sdump_glyph_row
);
30788 defsubr (&Sdump_tool_bar_row
);
30789 defsubr (&Strace_redisplay
);
30790 defsubr (&Strace_to_stderr
);
30792 #ifdef HAVE_WINDOW_SYSTEM
30793 defsubr (&Stool_bar_height
);
30794 defsubr (&Slookup_image_map
);
30796 defsubr (&Sline_pixel_height
);
30797 defsubr (&Sformat_mode_line
);
30798 defsubr (&Sinvisible_p
);
30799 defsubr (&Scurrent_bidi_paragraph_direction
);
30800 defsubr (&Swindow_text_pixel_size
);
30801 defsubr (&Smove_point_visually
);
30802 defsubr (&Sbidi_find_overridden_directionality
);
30804 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30805 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30806 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30807 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30808 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30809 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30810 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30811 DEFSYM (Qeval
, "eval");
30812 DEFSYM (QCdata
, ":data");
30814 /* Names of text properties relevant for redisplay. */
30815 DEFSYM (Qdisplay
, "display");
30816 DEFSYM (Qspace_width
, "space-width");
30817 DEFSYM (Qraise
, "raise");
30818 DEFSYM (Qslice
, "slice");
30819 DEFSYM (Qspace
, "space");
30820 DEFSYM (Qmargin
, "margin");
30821 DEFSYM (Qpointer
, "pointer");
30822 DEFSYM (Qleft_margin
, "left-margin");
30823 DEFSYM (Qright_margin
, "right-margin");
30824 DEFSYM (Qcenter
, "center");
30825 DEFSYM (Qline_height
, "line-height");
30826 DEFSYM (QCalign_to
, ":align-to");
30827 DEFSYM (QCrelative_width
, ":relative-width");
30828 DEFSYM (QCrelative_height
, ":relative-height");
30829 DEFSYM (QCeval
, ":eval");
30830 DEFSYM (QCpropertize
, ":propertize");
30831 DEFSYM (QCfile
, ":file");
30832 DEFSYM (Qfontified
, "fontified");
30833 DEFSYM (Qfontification_functions
, "fontification-functions");
30835 /* Name of the face used to highlight trailing whitespace. */
30836 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30838 /* Name and number of the face used to highlight escape glyphs. */
30839 DEFSYM (Qescape_glyph
, "escape-glyph");
30841 /* Name and number of the face used to highlight non-breaking spaces. */
30842 DEFSYM (Qnobreak_space
, "nobreak-space");
30844 /* The symbol 'image' which is the car of the lists used to represent
30845 images in Lisp. Also a tool bar style. */
30846 DEFSYM (Qimage
, "image");
30848 /* Tool bar styles. */
30849 DEFSYM (Qtext
, "text");
30850 DEFSYM (Qboth
, "both");
30851 DEFSYM (Qboth_horiz
, "both-horiz");
30852 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30854 /* The image map types. */
30855 DEFSYM (QCmap
, ":map");
30856 DEFSYM (QCpointer
, ":pointer");
30857 DEFSYM (Qrect
, "rect");
30858 DEFSYM (Qcircle
, "circle");
30859 DEFSYM (Qpoly
, "poly");
30861 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30863 DEFSYM (Qgrow_only
, "grow-only");
30864 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30865 DEFSYM (Qposition
, "position");
30866 DEFSYM (Qbuffer_position
, "buffer-position");
30867 DEFSYM (Qobject
, "object");
30869 /* Cursor shapes. */
30870 DEFSYM (Qbar
, "bar");
30871 DEFSYM (Qhbar
, "hbar");
30872 DEFSYM (Qbox
, "box");
30873 DEFSYM (Qhollow
, "hollow");
30875 /* Pointer shapes. */
30876 DEFSYM (Qhand
, "hand");
30877 DEFSYM (Qarrow
, "arrow");
30880 DEFSYM (Qdragging
, "dragging");
30882 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30884 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30885 staticpro (&list_of_error
);
30887 /* Values of those variables at last redisplay are stored as
30888 properties on 'overlay-arrow-position' symbol. However, if
30889 Voverlay_arrow_position is a marker, last-arrow-position is its
30890 numerical position. */
30891 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30892 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30894 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30895 properties on a symbol in overlay-arrow-variable-list. */
30896 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30897 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30899 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30900 staticpro (&echo_buffer
[0]);
30901 staticpro (&echo_buffer
[1]);
30903 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30904 staticpro (&echo_area_buffer
[0]);
30905 staticpro (&echo_area_buffer
[1]);
30907 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30908 staticpro (&Vmessages_buffer_name
);
30910 mode_line_proptrans_alist
= Qnil
;
30911 staticpro (&mode_line_proptrans_alist
);
30912 mode_line_string_list
= Qnil
;
30913 staticpro (&mode_line_string_list
);
30914 mode_line_string_face
= Qnil
;
30915 staticpro (&mode_line_string_face
);
30916 mode_line_string_face_prop
= Qnil
;
30917 staticpro (&mode_line_string_face_prop
);
30918 Vmode_line_unwind_vector
= Qnil
;
30919 staticpro (&Vmode_line_unwind_vector
);
30921 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30923 help_echo_string
= Qnil
;
30924 staticpro (&help_echo_string
);
30925 help_echo_object
= Qnil
;
30926 staticpro (&help_echo_object
);
30927 help_echo_window
= Qnil
;
30928 staticpro (&help_echo_window
);
30929 previous_help_echo_string
= Qnil
;
30930 staticpro (&previous_help_echo_string
);
30931 help_echo_pos
= -1;
30933 DEFSYM (Qright_to_left
, "right-to-left");
30934 DEFSYM (Qleft_to_right
, "left-to-right");
30935 defsubr (&Sbidi_resolved_levels
);
30937 #ifdef HAVE_WINDOW_SYSTEM
30938 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30939 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30940 For example, if a block cursor is over a tab, it will be drawn as
30941 wide as that tab on the display. */);
30942 x_stretch_cursor_p
= 0;
30945 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30946 doc
: /* Non-nil means highlight trailing whitespace.
30947 The face used for trailing whitespace is `trailing-whitespace'. */);
30948 Vshow_trailing_whitespace
= Qnil
;
30950 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30951 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30952 If the value is t, Emacs highlights non-ASCII chars which have the
30953 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30954 or `escape-glyph' face respectively.
30956 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30957 U+2011 (non-breaking hyphen) are affected.
30959 Any other non-nil value means to display these characters as a escape
30960 glyph followed by an ordinary space or hyphen.
30962 A value of nil means no special handling of these characters. */);
30963 Vnobreak_char_display
= Qt
;
30965 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30966 doc
: /* The pointer shape to show in void text areas.
30967 A value of nil means to show the text pointer. Other options are
30968 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30970 Vvoid_text_area_pointer
= Qarrow
;
30972 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30973 doc
: /* Non-nil means don't actually do any redisplay.
30974 This is used for internal purposes. */);
30975 Vinhibit_redisplay
= Qnil
;
30977 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30978 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30979 Vglobal_mode_string
= Qnil
;
30981 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30982 doc
: /* Marker for where to display an arrow on top of the buffer text.
30983 This must be the beginning of a line in order to work.
30984 See also `overlay-arrow-string'. */);
30985 Voverlay_arrow_position
= Qnil
;
30987 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30988 doc
: /* String to display as an arrow in non-window frames.
30989 See also `overlay-arrow-position'. */);
30990 Voverlay_arrow_string
= build_pure_c_string ("=>");
30992 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30993 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30994 The symbols on this list are examined during redisplay to determine
30995 where to display overlay arrows. */);
30996 Voverlay_arrow_variable_list
30997 = list1 (intern_c_string ("overlay-arrow-position"));
30999 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
31000 doc
: /* The number of lines to try scrolling a window by when point moves out.
31001 If that fails to bring point back on frame, point is centered instead.
31002 If this is zero, point is always centered after it moves off frame.
31003 If you want scrolling to always be a line at a time, you should set
31004 `scroll-conservatively' to a large value rather than set this to 1. */);
31006 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
31007 doc
: /* Scroll up to this many lines, to bring point back on screen.
31008 If point moves off-screen, redisplay will scroll by up to
31009 `scroll-conservatively' lines in order to bring point just barely
31010 onto the screen again. If that cannot be done, then redisplay
31011 recenters point as usual.
31013 If the value is greater than 100, redisplay will never recenter point,
31014 but will always scroll just enough text to bring point into view, even
31015 if you move far away.
31017 A value of zero means always recenter point if it moves off screen. */);
31018 scroll_conservatively
= 0;
31020 DEFVAR_INT ("scroll-margin", scroll_margin
,
31021 doc
: /* Number of lines of margin at the top and bottom of a window.
31022 Recenter the window whenever point gets within this many lines
31023 of the top or bottom of the window. */);
31026 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31027 doc
: /* Pixels per inch value for non-window system displays.
31028 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31029 Vdisplay_pixels_per_inch
= make_float (72.0);
31032 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31035 DEFVAR_LISP ("truncate-partial-width-windows",
31036 Vtruncate_partial_width_windows
,
31037 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31038 For an integer value, truncate lines in each window narrower than the
31039 full frame width, provided the window width is less than that integer;
31040 otherwise, respect the value of `truncate-lines'.
31042 For any other non-nil value, truncate lines in all windows that do
31043 not span the full frame width.
31045 A value of nil means to respect the value of `truncate-lines'.
31047 If `word-wrap' is enabled, you might want to reduce this. */);
31048 Vtruncate_partial_width_windows
= make_number (50);
31050 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31051 doc
: /* Maximum buffer size for which line number should be displayed.
31052 If the buffer is bigger than this, the line number does not appear
31053 in the mode line. A value of nil means no limit. */);
31054 Vline_number_display_limit
= Qnil
;
31056 DEFVAR_INT ("line-number-display-limit-width",
31057 line_number_display_limit_width
,
31058 doc
: /* Maximum line width (in characters) for line number display.
31059 If the average length of the lines near point is bigger than this, then the
31060 line number may be omitted from the mode line. */);
31061 line_number_display_limit_width
= 200;
31063 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31064 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31065 highlight_nonselected_windows
= false;
31067 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31068 doc
: /* Non-nil if more than one frame is visible on this display.
31069 Minibuffer-only frames don't count, but iconified frames do.
31070 This variable is not guaranteed to be accurate except while processing
31071 `frame-title-format' and `icon-title-format'. */);
31073 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31074 doc
: /* Template for displaying the title bar of visible frames.
31075 (Assuming the window manager supports this feature.)
31077 This variable has the same structure as `mode-line-format', except that
31078 the %c and %l constructs are ignored. It is used only on frames for
31079 which no explicit name has been set (see `modify-frame-parameters'). */);
31081 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31082 doc
: /* Template for displaying the title bar of an iconified frame.
31083 (Assuming the window manager supports this feature.)
31084 This variable has the same structure as `mode-line-format' (which see),
31085 and is used only on frames for which no explicit name has been set
31086 (see `modify-frame-parameters'). */);
31088 = Vframe_title_format
31089 = listn (CONSTYPE_PURE
, 3,
31090 intern_c_string ("multiple-frames"),
31091 build_pure_c_string ("%b"),
31092 listn (CONSTYPE_PURE
, 4,
31093 empty_unibyte_string
,
31094 intern_c_string ("invocation-name"),
31095 build_pure_c_string ("@"),
31096 intern_c_string ("system-name")));
31098 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31099 doc
: /* Maximum number of lines to keep in the message log buffer.
31100 If nil, disable message logging. If t, log messages but don't truncate
31101 the buffer when it becomes large. */);
31102 Vmessage_log_max
= make_number (1000);
31104 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31105 doc
: /* Functions called before redisplay, if window sizes have changed.
31106 The value should be a list of functions that take one argument.
31107 Just before redisplay, for each frame, if any of its windows have changed
31108 size since the last redisplay, or have been split or deleted,
31109 all the functions in the list are called, with the frame as argument. */);
31110 Vwindow_size_change_functions
= Qnil
;
31112 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31113 doc
: /* List of functions to call before redisplaying a window with scrolling.
31114 Each function is called with two arguments, the window and its new
31115 display-start position.
31116 These functions are called whenever the `window-start' marker is modified,
31117 either to point into another buffer (e.g. via `set-window-buffer') or another
31118 place in the same buffer.
31119 Note that the value of `window-end' is not valid when these functions are
31122 Warning: Do not use this feature to alter the way the window
31123 is scrolled. It is not designed for that, and such use probably won't
31125 Vwindow_scroll_functions
= Qnil
;
31127 DEFVAR_LISP ("window-text-change-functions",
31128 Vwindow_text_change_functions
,
31129 doc
: /* Functions to call in redisplay when text in the window might change. */);
31130 Vwindow_text_change_functions
= Qnil
;
31132 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31133 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31134 Each function is called with two arguments, the window and the end trigger value.
31135 See `set-window-redisplay-end-trigger'. */);
31136 Vredisplay_end_trigger_functions
= Qnil
;
31138 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31139 doc
: /* Non-nil means autoselect window with mouse pointer.
31140 If nil, do not autoselect windows.
31141 A positive number means delay autoselection by that many seconds: a
31142 window is autoselected only after the mouse has remained in that
31143 window for the duration of the delay.
31144 A negative number has a similar effect, but causes windows to be
31145 autoselected only after the mouse has stopped moving. (Because of
31146 the way Emacs compares mouse events, you will occasionally wait twice
31147 that time before the window gets selected.)
31148 Any other value means to autoselect window instantaneously when the
31149 mouse pointer enters it.
31151 Autoselection selects the minibuffer only if it is active, and never
31152 unselects the minibuffer if it is active.
31154 When customizing this variable make sure that the actual value of
31155 `focus-follows-mouse' matches the behavior of your window manager. */);
31156 Vmouse_autoselect_window
= Qnil
;
31158 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31159 doc
: /* Non-nil means automatically resize tool-bars.
31160 This dynamically changes the tool-bar's height to the minimum height
31161 that is needed to make all tool-bar items visible.
31162 If value is `grow-only', the tool-bar's height is only increased
31163 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31164 Vauto_resize_tool_bars
= Qt
;
31166 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31167 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31168 auto_raise_tool_bar_buttons_p
= true;
31170 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31171 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31172 make_cursor_line_fully_visible_p
= true;
31174 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31175 doc
: /* Border below tool-bar in pixels.
31176 If an integer, use it as the height of the border.
31177 If it is one of `internal-border-width' or `border-width', use the
31178 value of the corresponding frame parameter.
31179 Otherwise, no border is added below the tool-bar. */);
31180 Vtool_bar_border
= Qinternal_border_width
;
31182 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31183 doc
: /* Margin around tool-bar buttons in pixels.
31184 If an integer, use that for both horizontal and vertical margins.
31185 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31186 HORZ specifying the horizontal margin, and VERT specifying the
31187 vertical margin. */);
31188 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31190 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31191 doc
: /* Relief thickness of tool-bar buttons. */);
31192 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31194 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31195 doc
: /* Tool bar style to use.
31197 image - show images only
31198 text - show text only
31199 both - show both, text below image
31200 both-horiz - show text to the right of the image
31201 text-image-horiz - show text to the left of the image
31202 any other - use system default or image if no system default.
31204 This variable only affects the GTK+ toolkit version of Emacs. */);
31205 Vtool_bar_style
= Qnil
;
31207 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31208 doc
: /* Maximum number of characters a label can have to be shown.
31209 The tool bar style must also show labels for this to have any effect, see
31210 `tool-bar-style'. */);
31211 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31213 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31214 doc
: /* List of functions to call to fontify regions of text.
31215 Each function is called with one argument POS. Functions must
31216 fontify a region starting at POS in the current buffer, and give
31217 fontified regions the property `fontified'. */);
31218 Vfontification_functions
= Qnil
;
31219 Fmake_variable_buffer_local (Qfontification_functions
);
31221 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31222 unibyte_display_via_language_environment
,
31223 doc
: /* Non-nil means display unibyte text according to language environment.
31224 Specifically, this means that raw bytes in the range 160-255 decimal
31225 are displayed by converting them to the equivalent multibyte characters
31226 according to the current language environment. As a result, they are
31227 displayed according to the current fontset.
31229 Note that this variable affects only how these bytes are displayed,
31230 but does not change the fact they are interpreted as raw bytes. */);
31231 unibyte_display_via_language_environment
= false;
31233 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31234 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31235 If a float, it specifies a fraction of the mini-window frame's height.
31236 If an integer, it specifies a number of lines. */);
31237 Vmax_mini_window_height
= make_float (0.25);
31239 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31240 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31241 A value of nil means don't automatically resize mini-windows.
31242 A value of t means resize them to fit the text displayed in them.
31243 A value of `grow-only', the default, means let mini-windows grow only;
31244 they return to their normal size when the minibuffer is closed, or the
31245 echo area becomes empty. */);
31246 Vresize_mini_windows
= Qgrow_only
;
31248 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31249 doc
: /* Alist specifying how to blink the cursor off.
31250 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31251 `cursor-type' frame-parameter or variable equals ON-STATE,
31252 comparing using `equal', Emacs uses OFF-STATE to specify
31253 how to blink it off. ON-STATE and OFF-STATE are values for
31254 the `cursor-type' frame parameter.
31256 If a frame's ON-STATE has no entry in this list,
31257 the frame's other specifications determine how to blink the cursor off. */);
31258 Vblink_cursor_alist
= Qnil
;
31260 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31261 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31262 If non-nil, windows are automatically scrolled horizontally to make
31263 point visible. */);
31264 automatic_hscrolling_p
= true;
31265 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31267 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31268 doc
: /* How many columns away from the window edge point is allowed to get
31269 before automatic hscrolling will horizontally scroll the window. */);
31270 hscroll_margin
= 5;
31272 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31273 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31274 When point is less than `hscroll-margin' columns from the window
31275 edge, automatic hscrolling will scroll the window by the amount of columns
31276 determined by this variable. If its value is a positive integer, scroll that
31277 many columns. If it's a positive floating-point number, it specifies the
31278 fraction of the window's width to scroll. If it's nil or zero, point will be
31279 centered horizontally after the scroll. Any other value, including negative
31280 numbers, are treated as if the value were zero.
31282 Automatic hscrolling always moves point outside the scroll margin, so if
31283 point was more than scroll step columns inside the margin, the window will
31284 scroll more than the value given by the scroll step.
31286 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31287 and `scroll-right' overrides this variable's effect. */);
31288 Vhscroll_step
= make_number (0);
31290 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31291 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31292 Bind this around calls to `message' to let it take effect. */);
31293 message_truncate_lines
= false;
31295 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31296 doc
: /* Normal hook run to update the menu bar definitions.
31297 Redisplay runs this hook before it redisplays the menu bar.
31298 This is used to update menus such as Buffers, whose contents depend on
31300 Vmenu_bar_update_hook
= Qnil
;
31302 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31303 doc
: /* Frame for which we are updating a menu.
31304 The enable predicate for a menu binding should check this variable. */);
31305 Vmenu_updating_frame
= Qnil
;
31307 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31308 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31309 inhibit_menubar_update
= false;
31311 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31312 doc
: /* Prefix prepended to all continuation lines at display time.
31313 The value may be a string, an image, or a stretch-glyph; it is
31314 interpreted in the same way as the value of a `display' text property.
31316 This variable is overridden by any `wrap-prefix' text or overlay
31319 To add a prefix to non-continuation lines, use `line-prefix'. */);
31320 Vwrap_prefix
= Qnil
;
31321 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31322 Fmake_variable_buffer_local (Qwrap_prefix
);
31324 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31325 doc
: /* Prefix prepended to all non-continuation lines at display time.
31326 The value may be a string, an image, or a stretch-glyph; it is
31327 interpreted in the same way as the value of a `display' text property.
31329 This variable is overridden by any `line-prefix' text or overlay
31332 To add a prefix to continuation lines, use `wrap-prefix'. */);
31333 Vline_prefix
= Qnil
;
31334 DEFSYM (Qline_prefix
, "line-prefix");
31335 Fmake_variable_buffer_local (Qline_prefix
);
31337 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31338 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31339 inhibit_eval_during_redisplay
= false;
31341 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31342 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31343 inhibit_free_realized_faces
= false;
31345 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31346 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31347 Intended for use during debugging and for testing bidi display;
31348 see biditest.el in the test suite. */);
31349 inhibit_bidi_mirroring
= false;
31352 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31353 doc
: /* Inhibit try_window_id display optimization. */);
31354 inhibit_try_window_id
= false;
31356 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31357 doc
: /* Inhibit try_window_reusing display optimization. */);
31358 inhibit_try_window_reusing
= false;
31360 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31361 doc
: /* Inhibit try_cursor_movement display optimization. */);
31362 inhibit_try_cursor_movement
= false;
31363 #endif /* GLYPH_DEBUG */
31365 DEFVAR_INT ("overline-margin", overline_margin
,
31366 doc
: /* Space between overline and text, in pixels.
31367 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31368 margin to the character height. */);
31369 overline_margin
= 2;
31371 DEFVAR_INT ("underline-minimum-offset",
31372 underline_minimum_offset
,
31373 doc
: /* Minimum distance between baseline and underline.
31374 This can improve legibility of underlined text at small font sizes,
31375 particularly when using variable `x-use-underline-position-properties'
31376 with fonts that specify an UNDERLINE_POSITION relatively close to the
31377 baseline. The default value is 1. */);
31378 underline_minimum_offset
= 1;
31380 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31381 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31382 This feature only works when on a window system that can change
31383 cursor shapes. */);
31384 display_hourglass_p
= true;
31386 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31387 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31388 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31390 #ifdef HAVE_WINDOW_SYSTEM
31391 hourglass_atimer
= NULL
;
31392 hourglass_shown_p
= false;
31393 #endif /* HAVE_WINDOW_SYSTEM */
31395 /* Name of the face used to display glyphless characters. */
31396 DEFSYM (Qglyphless_char
, "glyphless-char");
31398 /* Method symbols for Vglyphless_char_display. */
31399 DEFSYM (Qhex_code
, "hex-code");
31400 DEFSYM (Qempty_box
, "empty-box");
31401 DEFSYM (Qthin_space
, "thin-space");
31402 DEFSYM (Qzero_width
, "zero-width");
31404 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31405 doc
: /* Function run just before redisplay.
31406 It is called with one argument, which is the set of windows that are to
31407 be redisplayed. This set can be nil (meaning, only the selected window),
31408 or t (meaning all windows). */);
31409 Vpre_redisplay_function
= intern ("ignore");
31411 /* Symbol for the purpose of Vglyphless_char_display. */
31412 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31413 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31415 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31416 doc
: /* Char-table defining glyphless characters.
31417 Each element, if non-nil, should be one of the following:
31418 an ASCII acronym string: display this string in a box
31419 `hex-code': display the hexadecimal code of a character in a box
31420 `empty-box': display as an empty box
31421 `thin-space': display as 1-pixel width space
31422 `zero-width': don't display
31423 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31424 display method for graphical terminals and text terminals respectively.
31425 GRAPHICAL and TEXT should each have one of the values listed above.
31427 The char-table has one extra slot to control the display of a character for
31428 which no font is found. This slot only takes effect on graphical terminals.
31429 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31430 `thin-space'. The default is `empty-box'.
31432 If a character has a non-nil entry in an active display table, the
31433 display table takes effect; in this case, Emacs does not consult
31434 `glyphless-char-display' at all. */);
31435 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31436 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31439 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31440 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31441 Vdebug_on_message
= Qnil
;
31443 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31445 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31447 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31449 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31453 /* Initialize this module when Emacs starts. */
31458 CHARPOS (this_line_start_pos
) = 0;
31460 if (!noninteractive
)
31462 struct window
*m
= XWINDOW (minibuf_window
);
31463 Lisp_Object frame
= m
->frame
;
31464 struct frame
*f
= XFRAME (frame
);
31465 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31466 struct window
*r
= XWINDOW (root
);
31469 echo_area_window
= minibuf_window
;
31471 r
->top_line
= FRAME_TOP_MARGIN (f
);
31472 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31473 r
->total_cols
= FRAME_COLS (f
);
31474 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31475 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31476 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31478 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31479 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31480 m
->total_cols
= FRAME_COLS (f
);
31481 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31482 m
->total_lines
= 1;
31483 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31485 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31486 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31487 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31489 /* The default ellipsis glyphs `...'. */
31490 for (i
= 0; i
< 3; ++i
)
31491 default_invis_vector
[i
] = make_number ('.');
31495 /* Allocate the buffer for frame titles.
31496 Also used for `format-mode-line'. */
31498 mode_line_noprop_buf
= xmalloc (size
);
31499 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31500 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31501 mode_line_target
= MODE_LINE_DISPLAY
;
31504 help_echo_showing_p
= false;
31507 #ifdef HAVE_WINDOW_SYSTEM
31509 /* Platform-independent portion of hourglass implementation. */
31511 /* Timer function of hourglass_atimer. */
31514 show_hourglass (struct atimer
*timer
)
31516 /* The timer implementation will cancel this timer automatically
31517 after this function has run. Set hourglass_atimer to null
31518 so that we know the timer doesn't have to be canceled. */
31519 hourglass_atimer
= NULL
;
31521 if (!hourglass_shown_p
)
31523 Lisp_Object tail
, frame
;
31527 FOR_EACH_FRAME (tail
, frame
)
31529 struct frame
*f
= XFRAME (frame
);
31531 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31532 && FRAME_RIF (f
)->show_hourglass
)
31533 FRAME_RIF (f
)->show_hourglass (f
);
31536 hourglass_shown_p
= true;
31541 /* Cancel a currently active hourglass timer, and start a new one. */
31544 start_hourglass (void)
31546 struct timespec delay
;
31548 cancel_hourglass ();
31550 if (INTEGERP (Vhourglass_delay
)
31551 && XINT (Vhourglass_delay
) > 0)
31552 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31553 TYPE_MAXIMUM (time_t)),
31555 else if (FLOATP (Vhourglass_delay
)
31556 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31557 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31559 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31561 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31562 show_hourglass
, NULL
);
31565 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31569 cancel_hourglass (void)
31571 if (hourglass_atimer
)
31573 cancel_atimer (hourglass_atimer
);
31574 hourglass_atimer
= NULL
;
31577 if (hourglass_shown_p
)
31579 Lisp_Object tail
, frame
;
31583 FOR_EACH_FRAME (tail
, frame
)
31585 struct frame
*f
= XFRAME (frame
);
31587 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31588 && FRAME_RIF (f
)->hide_hourglass
)
31589 FRAME_RIF (f
)->hide_hourglass (f
);
31591 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31592 else if (!FRAME_W32_P (f
))
31593 w32_arrow_cursor ();
31597 hourglass_shown_p
= false;
31602 #endif /* HAVE_WINDOW_SYSTEM */