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 /* Mark all the scroll bars to be removed; we'll redeem
13814 the ones we want when we redisplay their windows. */
13815 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13816 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13818 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13819 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13820 /* Remember that the invisible frames need to be redisplayed next
13821 time they're visible. */
13822 else if (!REDISPLAY_SOME_P ())
13823 f
->redisplay
= true;
13825 /* The X error handler may have deleted that frame. */
13826 if (!FRAME_LIVE_P (f
))
13829 /* Any scroll bars which redisplay_windows should have
13830 nuked should now go away. */
13831 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13832 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13834 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13836 /* If fonts changed on visible frame, display again. */
13837 if (f
->fonts_changed
)
13839 adjust_frame_glyphs (f
);
13840 /* Disable all redisplay optimizations for this
13841 frame. For the reasons, see the comment near
13842 the previous call to adjust_frame_glyphs above. */
13843 SET_FRAME_GARBAGED (f
);
13844 f
->fonts_changed
= false;
13848 /* See if we have to hscroll. */
13849 if (!f
->already_hscrolled_p
)
13851 f
->already_hscrolled_p
= true;
13852 if (hscroll_windows (f
->root_window
))
13856 /* Prevent various kinds of signals during display
13857 update. stdio is not robust about handling
13858 signals, which can cause an apparent I/O error. */
13859 if (interrupt_input
)
13860 unrequest_sigio ();
13863 pending
|= update_frame (f
, false, false);
13864 f
->cursor_type_changed
= false;
13865 f
->updated_p
= true;
13870 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13874 /* Do the mark_window_display_accurate after all windows have
13875 been redisplayed because this call resets flags in buffers
13876 which are needed for proper redisplay. */
13877 FOR_EACH_FRAME (tail
, frame
)
13879 struct frame
*f
= XFRAME (frame
);
13882 f
->redisplay
= false;
13883 mark_window_display_accurate (f
->root_window
, true);
13884 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13885 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13890 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13892 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13893 struct frame
*mini_frame
;
13895 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13896 /* Use list_of_error, not Qerror, so that
13897 we catch only errors and don't run the debugger. */
13898 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13900 redisplay_window_error
);
13901 if (update_miniwindow_p
)
13902 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13904 redisplay_window_error
);
13906 /* Compare desired and current matrices, perform output. */
13909 /* If fonts changed, display again. */
13910 if (sf
->fonts_changed
)
13913 /* Prevent freeing of realized faces, since desired matrices are
13914 pending that reference the faces we computed and cached. */
13915 inhibit_free_realized_faces
= true;
13917 /* Prevent various kinds of signals during display update.
13918 stdio is not robust about handling signals,
13919 which can cause an apparent I/O error. */
13920 if (interrupt_input
)
13921 unrequest_sigio ();
13924 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13926 if (hscroll_windows (selected_window
))
13929 XWINDOW (selected_window
)->must_be_updated_p
= true;
13930 pending
= update_frame (sf
, false, false);
13931 sf
->cursor_type_changed
= false;
13934 /* We may have called echo_area_display at the top of this
13935 function. If the echo area is on another frame, that may
13936 have put text on a frame other than the selected one, so the
13937 above call to update_frame would not have caught it. Catch
13939 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13940 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13942 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13944 XWINDOW (mini_window
)->must_be_updated_p
= true;
13945 pending
|= update_frame (mini_frame
, false, false);
13946 mini_frame
->cursor_type_changed
= false;
13947 if (!pending
&& hscroll_windows (mini_window
))
13952 /* If display was paused because of pending input, make sure we do a
13953 thorough update the next time. */
13956 /* Prevent the optimization at the beginning of
13957 redisplay_internal that tries a single-line update of the
13958 line containing the cursor in the selected window. */
13959 CHARPOS (this_line_start_pos
) = 0;
13961 /* Let the overlay arrow be updated the next time. */
13962 update_overlay_arrows (0);
13964 /* If we pause after scrolling, some rows in the current
13965 matrices of some windows are not valid. */
13966 if (!WINDOW_FULL_WIDTH_P (w
)
13967 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13968 update_mode_lines
= 36;
13972 if (!consider_all_windows_p
)
13974 /* This has already been done above if
13975 consider_all_windows_p is set. */
13976 if (XBUFFER (w
->contents
)->text
->redisplay
13977 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13978 /* This can happen if b->text->redisplay was set during
13980 propagate_buffer_redisplay ();
13981 mark_window_display_accurate_1 (w
, true);
13983 /* Say overlay arrows are up to date. */
13984 update_overlay_arrows (1);
13986 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13987 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13990 update_mode_lines
= 0;
13991 windows_or_buffers_changed
= 0;
13994 /* Start SIGIO interrupts coming again. Having them off during the
13995 code above makes it less likely one will discard output, but not
13996 impossible, since there might be stuff in the system buffer here.
13997 But it is much hairier to try to do anything about that. */
13998 if (interrupt_input
)
14002 /* If a frame has become visible which was not before, redisplay
14003 again, so that we display it. Expose events for such a frame
14004 (which it gets when becoming visible) don't call the parts of
14005 redisplay constructing glyphs, so simply exposing a frame won't
14006 display anything in this case. So, we have to display these
14007 frames here explicitly. */
14012 FOR_EACH_FRAME (tail
, frame
)
14014 if (XFRAME (frame
)->visible
)
14018 if (new_count
!= number_of_visible_frames
)
14019 windows_or_buffers_changed
= 52;
14022 /* Change frame size now if a change is pending. */
14023 do_pending_window_change (true);
14025 /* If we just did a pending size change, or have additional
14026 visible frames, or selected_window changed, redisplay again. */
14027 if ((windows_or_buffers_changed
&& !pending
)
14028 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14031 /* Clear the face and image caches.
14033 We used to do this only if consider_all_windows_p. But the cache
14034 needs to be cleared if a timer creates images in the current
14035 buffer (e.g. the test case in Bug#6230). */
14037 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14039 clear_face_cache (false);
14040 clear_face_cache_count
= 0;
14043 #ifdef HAVE_WINDOW_SYSTEM
14044 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14046 clear_image_caches (Qnil
);
14047 clear_image_cache_count
= 0;
14049 #endif /* HAVE_WINDOW_SYSTEM */
14053 ns_set_doc_edited ();
14055 if (interrupt_input
&& interrupts_deferred
)
14058 unbind_to (count
, Qnil
);
14063 /* Redisplay, but leave alone any recent echo area message unless
14064 another message has been requested in its place.
14066 This is useful in situations where you need to redisplay but no
14067 user action has occurred, making it inappropriate for the message
14068 area to be cleared. See tracking_off and
14069 wait_reading_process_output for examples of these situations.
14071 FROM_WHERE is an integer saying from where this function was
14072 called. This is useful for debugging. */
14075 redisplay_preserve_echo_area (int from_where
)
14077 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14079 if (!NILP (echo_area_buffer
[1]))
14081 /* We have a previously displayed message, but no current
14082 message. Redisplay the previous message. */
14083 display_last_displayed_message_p
= true;
14084 redisplay_internal ();
14085 display_last_displayed_message_p
= false;
14088 redisplay_internal ();
14090 flush_frame (SELECTED_FRAME ());
14094 /* Function registered with record_unwind_protect in redisplay_internal. */
14097 unwind_redisplay (void)
14099 redisplaying_p
= false;
14103 /* Mark the display of leaf window W as accurate or inaccurate.
14104 If ACCURATE_P, mark display of W as accurate.
14105 If !ACCURATE_P, arrange for W to be redisplayed the next
14106 time redisplay_internal is called. */
14109 mark_window_display_accurate_1 (struct window
*w
, bool accurate_p
)
14111 struct buffer
*b
= XBUFFER (w
->contents
);
14113 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14114 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14115 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14119 b
->clip_changed
= false;
14120 b
->prevent_redisplay_optimizations_p
= false;
14121 eassert (buffer_window_count (b
) > 0);
14122 /* Resetting b->text->redisplay is problematic!
14123 In order to make it safer to do it here, redisplay_internal must
14124 have copied all b->text->redisplay to their respective windows. */
14125 b
->text
->redisplay
= false;
14127 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14128 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14129 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14130 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14132 w
->current_matrix
->buffer
= b
;
14133 w
->current_matrix
->begv
= BUF_BEGV (b
);
14134 w
->current_matrix
->zv
= BUF_ZV (b
);
14136 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14137 w
->last_cursor_off_p
= w
->cursor_off_p
;
14139 if (w
== XWINDOW (selected_window
))
14140 w
->last_point
= BUF_PT (b
);
14142 w
->last_point
= marker_position (w
->pointm
);
14144 w
->window_end_valid
= true;
14145 w
->update_mode_line
= false;
14148 w
->redisplay
= !accurate_p
;
14152 /* Mark the display of windows in the window tree rooted at WINDOW as
14153 accurate or inaccurate. If ACCURATE_P, mark display of
14154 windows as accurate. If !ACCURATE_P, arrange for windows to
14155 be redisplayed the next time redisplay_internal is called. */
14158 mark_window_display_accurate (Lisp_Object window
, bool accurate_p
)
14162 for (; !NILP (window
); window
= w
->next
)
14164 w
= XWINDOW (window
);
14165 if (WINDOWP (w
->contents
))
14166 mark_window_display_accurate (w
->contents
, accurate_p
);
14168 mark_window_display_accurate_1 (w
, accurate_p
);
14172 update_overlay_arrows (1);
14174 /* Force a thorough redisplay the next time by setting
14175 last_arrow_position and last_arrow_string to t, which is
14176 unequal to any useful value of Voverlay_arrow_... */
14177 update_overlay_arrows (-1);
14181 /* Return value in display table DP (Lisp_Char_Table *) for character
14182 C. Since a display table doesn't have any parent, we don't have to
14183 follow parent. Do not call this function directly but use the
14184 macro DISP_CHAR_VECTOR. */
14187 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14191 if (ASCII_CHAR_P (c
))
14194 if (SUB_CHAR_TABLE_P (val
))
14195 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14201 XSETCHAR_TABLE (table
, dp
);
14202 val
= char_table_ref (table
, c
);
14211 /***********************************************************************
14213 ***********************************************************************/
14215 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14218 redisplay_windows (Lisp_Object window
)
14220 while (!NILP (window
))
14222 struct window
*w
= XWINDOW (window
);
14224 if (WINDOWP (w
->contents
))
14225 redisplay_windows (w
->contents
);
14226 else if (BUFFERP (w
->contents
))
14228 displayed_buffer
= XBUFFER (w
->contents
);
14229 /* Use list_of_error, not Qerror, so that
14230 we catch only errors and don't run the debugger. */
14231 internal_condition_case_1 (redisplay_window_0
, window
,
14233 redisplay_window_error
);
14241 redisplay_window_error (Lisp_Object ignore
)
14243 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14248 redisplay_window_0 (Lisp_Object window
)
14250 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14251 redisplay_window (window
, false);
14256 redisplay_window_1 (Lisp_Object window
)
14258 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14259 redisplay_window (window
, true);
14264 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14265 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14266 which positions recorded in ROW differ from current buffer
14269 Return true iff cursor is on this row. */
14272 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14273 struct glyph_matrix
*matrix
,
14274 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14277 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14278 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14279 struct glyph
*cursor
= NULL
;
14280 /* The last known character position in row. */
14281 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14283 ptrdiff_t pt_old
= PT
- delta
;
14284 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14285 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14286 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14287 /* A glyph beyond the edge of TEXT_AREA which we should never
14289 struct glyph
*glyphs_end
= end
;
14290 /* True means we've found a match for cursor position, but that
14291 glyph has the avoid_cursor_p flag set. */
14292 bool match_with_avoid_cursor
= false;
14293 /* True means we've seen at least one glyph that came from a
14295 bool string_seen
= false;
14296 /* Largest and smallest buffer positions seen so far during scan of
14298 ptrdiff_t bpos_max
= pos_before
;
14299 ptrdiff_t bpos_min
= pos_after
;
14300 /* Last buffer position covered by an overlay string with an integer
14301 `cursor' property. */
14302 ptrdiff_t bpos_covered
= 0;
14303 /* True means the display string on which to display the cursor
14304 comes from a text property, not from an overlay. */
14305 bool string_from_text_prop
= false;
14307 /* Don't even try doing anything if called for a mode-line or
14308 header-line row, since the rest of the code isn't prepared to
14309 deal with such calamities. */
14310 eassert (!row
->mode_line_p
);
14311 if (row
->mode_line_p
)
14314 /* Skip over glyphs not having an object at the start and the end of
14315 the row. These are special glyphs like truncation marks on
14316 terminal frames. */
14317 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14319 if (!row
->reversed_p
)
14322 && NILP (glyph
->object
)
14323 && glyph
->charpos
< 0)
14325 x
+= glyph
->pixel_width
;
14329 && NILP ((end
- 1)->object
)
14330 /* CHARPOS is zero for blanks and stretch glyphs
14331 inserted by extend_face_to_end_of_line. */
14332 && (end
- 1)->charpos
<= 0)
14334 glyph_before
= glyph
- 1;
14341 /* If the glyph row is reversed, we need to process it from back
14342 to front, so swap the edge pointers. */
14343 glyphs_end
= end
= glyph
- 1;
14344 glyph
+= row
->used
[TEXT_AREA
] - 1;
14346 while (glyph
> end
+ 1
14347 && NILP (glyph
->object
)
14348 && glyph
->charpos
< 0)
14351 x
-= glyph
->pixel_width
;
14353 if (NILP (glyph
->object
) && glyph
->charpos
< 0)
14355 /* By default, in reversed rows we put the cursor on the
14356 rightmost (first in the reading order) glyph. */
14357 for (g
= end
+ 1; g
< glyph
; g
++)
14358 x
+= g
->pixel_width
;
14360 && NILP ((end
+ 1)->object
)
14361 && (end
+ 1)->charpos
<= 0)
14363 glyph_before
= glyph
+ 1;
14367 else if (row
->reversed_p
)
14369 /* In R2L rows that don't display text, put the cursor on the
14370 rightmost glyph. Case in point: an empty last line that is
14371 part of an R2L paragraph. */
14373 /* Avoid placing the cursor on the last glyph of the row, where
14374 on terminal frames we hold the vertical border between
14375 adjacent windows. */
14376 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14377 && !WINDOW_RIGHTMOST_P (w
)
14378 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14380 x
= -1; /* will be computed below, at label compute_x */
14383 /* Step 1: Try to find the glyph whose character position
14384 corresponds to point. If that's not possible, find 2 glyphs
14385 whose character positions are the closest to point, one before
14386 point, the other after it. */
14387 if (!row
->reversed_p
)
14388 while (/* not marched to end of glyph row */
14390 /* glyph was not inserted by redisplay for internal purposes */
14391 && !NILP (glyph
->object
))
14393 if (BUFFERP (glyph
->object
))
14395 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14397 if (glyph
->charpos
> bpos_max
)
14398 bpos_max
= glyph
->charpos
;
14399 if (glyph
->charpos
< bpos_min
)
14400 bpos_min
= glyph
->charpos
;
14401 if (!glyph
->avoid_cursor_p
)
14403 /* If we hit point, we've found the glyph on which to
14404 display the cursor. */
14407 match_with_avoid_cursor
= false;
14410 /* See if we've found a better approximation to
14411 POS_BEFORE or to POS_AFTER. */
14412 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14414 pos_before
= glyph
->charpos
;
14415 glyph_before
= glyph
;
14417 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14419 pos_after
= glyph
->charpos
;
14420 glyph_after
= glyph
;
14423 else if (dpos
== 0)
14424 match_with_avoid_cursor
= true;
14426 else if (STRINGP (glyph
->object
))
14428 Lisp_Object chprop
;
14429 ptrdiff_t glyph_pos
= glyph
->charpos
;
14431 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14433 if (!NILP (chprop
))
14435 /* If the string came from a `display' text property,
14436 look up the buffer position of that property and
14437 use that position to update bpos_max, as if we
14438 actually saw such a position in one of the row's
14439 glyphs. This helps with supporting integer values
14440 of `cursor' property on the display string in
14441 situations where most or all of the row's buffer
14442 text is completely covered by display properties,
14443 so that no glyph with valid buffer positions is
14444 ever seen in the row. */
14445 ptrdiff_t prop_pos
=
14446 string_buffer_position_lim (glyph
->object
, pos_before
,
14449 if (prop_pos
>= pos_before
)
14450 bpos_max
= prop_pos
;
14452 if (INTEGERP (chprop
))
14454 bpos_covered
= bpos_max
+ XINT (chprop
);
14455 /* If the `cursor' property covers buffer positions up
14456 to and including point, we should display cursor on
14457 this glyph. Note that, if a `cursor' property on one
14458 of the string's characters has an integer value, we
14459 will break out of the loop below _before_ we get to
14460 the position match above. IOW, integer values of
14461 the `cursor' property override the "exact match for
14462 point" strategy of positioning the cursor. */
14463 /* Implementation note: bpos_max == pt_old when, e.g.,
14464 we are in an empty line, where bpos_max is set to
14465 MATRIX_ROW_START_CHARPOS, see above. */
14466 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14473 string_seen
= true;
14475 x
+= glyph
->pixel_width
;
14478 else if (glyph
> end
) /* row is reversed */
14479 while (!NILP (glyph
->object
))
14481 if (BUFFERP (glyph
->object
))
14483 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14485 if (glyph
->charpos
> bpos_max
)
14486 bpos_max
= glyph
->charpos
;
14487 if (glyph
->charpos
< bpos_min
)
14488 bpos_min
= glyph
->charpos
;
14489 if (!glyph
->avoid_cursor_p
)
14493 match_with_avoid_cursor
= false;
14496 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14498 pos_before
= glyph
->charpos
;
14499 glyph_before
= glyph
;
14501 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14503 pos_after
= glyph
->charpos
;
14504 glyph_after
= glyph
;
14507 else if (dpos
== 0)
14508 match_with_avoid_cursor
= true;
14510 else if (STRINGP (glyph
->object
))
14512 Lisp_Object chprop
;
14513 ptrdiff_t glyph_pos
= glyph
->charpos
;
14515 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14517 if (!NILP (chprop
))
14519 ptrdiff_t prop_pos
=
14520 string_buffer_position_lim (glyph
->object
, pos_before
,
14523 if (prop_pos
>= pos_before
)
14524 bpos_max
= prop_pos
;
14526 if (INTEGERP (chprop
))
14528 bpos_covered
= bpos_max
+ XINT (chprop
);
14529 /* If the `cursor' property covers buffer positions up
14530 to and including point, we should display cursor on
14532 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14538 string_seen
= true;
14541 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14543 x
--; /* can't use any pixel_width */
14546 x
-= glyph
->pixel_width
;
14549 /* Step 2: If we didn't find an exact match for point, we need to
14550 look for a proper place to put the cursor among glyphs between
14551 GLYPH_BEFORE and GLYPH_AFTER. */
14552 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14553 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14554 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14556 /* An empty line has a single glyph whose OBJECT is nil and
14557 whose CHARPOS is the position of a newline on that line.
14558 Note that on a TTY, there are more glyphs after that, which
14559 were produced by extend_face_to_end_of_line, but their
14560 CHARPOS is zero or negative. */
14561 bool empty_line_p
=
14562 ((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14563 && NILP (glyph
->object
) && glyph
->charpos
> 0
14564 /* On a TTY, continued and truncated rows also have a glyph at
14565 their end whose OBJECT is nil and whose CHARPOS is
14566 positive (the continuation and truncation glyphs), but such
14567 rows are obviously not "empty". */
14568 && !(row
->continued_p
|| row
->truncated_on_right_p
));
14570 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14572 ptrdiff_t ellipsis_pos
;
14574 /* Scan back over the ellipsis glyphs. */
14575 if (!row
->reversed_p
)
14577 ellipsis_pos
= (glyph
- 1)->charpos
;
14578 while (glyph
> row
->glyphs
[TEXT_AREA
]
14579 && (glyph
- 1)->charpos
== ellipsis_pos
)
14580 glyph
--, x
-= glyph
->pixel_width
;
14581 /* That loop always goes one position too far, including
14582 the glyph before the ellipsis. So scan forward over
14584 x
+= glyph
->pixel_width
;
14587 else /* row is reversed */
14589 ellipsis_pos
= (glyph
+ 1)->charpos
;
14590 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14591 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14592 glyph
++, x
+= glyph
->pixel_width
;
14593 x
-= glyph
->pixel_width
;
14597 else if (match_with_avoid_cursor
)
14599 cursor
= glyph_after
;
14602 else if (string_seen
)
14604 int incr
= row
->reversed_p
? -1 : +1;
14606 /* Need to find the glyph that came out of a string which is
14607 present at point. That glyph is somewhere between
14608 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14609 positioned between POS_BEFORE and POS_AFTER in the
14611 struct glyph
*start
, *stop
;
14612 ptrdiff_t pos
= pos_before
;
14616 /* If the row ends in a newline from a display string,
14617 reordering could have moved the glyphs belonging to the
14618 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14619 in this case we extend the search to the last glyph in
14620 the row that was not inserted by redisplay. */
14621 if (row
->ends_in_newline_from_string_p
)
14624 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14627 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14628 correspond to POS_BEFORE and POS_AFTER, respectively. We
14629 need START and STOP in the order that corresponds to the
14630 row's direction as given by its reversed_p flag. If the
14631 directionality of characters between POS_BEFORE and
14632 POS_AFTER is the opposite of the row's base direction,
14633 these characters will have been reordered for display,
14634 and we need to reverse START and STOP. */
14635 if (!row
->reversed_p
)
14637 start
= min (glyph_before
, glyph_after
);
14638 stop
= max (glyph_before
, glyph_after
);
14642 start
= max (glyph_before
, glyph_after
);
14643 stop
= min (glyph_before
, glyph_after
);
14645 for (glyph
= start
+ incr
;
14646 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14649 /* Any glyphs that come from the buffer are here because
14650 of bidi reordering. Skip them, and only pay
14651 attention to glyphs that came from some string. */
14652 if (STRINGP (glyph
->object
))
14656 /* If the display property covers the newline, we
14657 need to search for it one position farther. */
14658 ptrdiff_t lim
= pos_after
14659 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14661 string_from_text_prop
= false;
14662 str
= glyph
->object
;
14663 tem
= string_buffer_position_lim (str
, pos
, lim
, false);
14664 if (tem
== 0 /* from overlay */
14667 /* If the string from which this glyph came is
14668 found in the buffer at point, or at position
14669 that is closer to point than pos_after, then
14670 we've found the glyph we've been looking for.
14671 If it comes from an overlay (tem == 0), and
14672 it has the `cursor' property on one of its
14673 glyphs, record that glyph as a candidate for
14674 displaying the cursor. (As in the
14675 unidirectional version, we will display the
14676 cursor on the last candidate we find.) */
14679 || (tem
- pt_old
> 0 && tem
< pos_after
))
14681 /* The glyphs from this string could have
14682 been reordered. Find the one with the
14683 smallest string position. Or there could
14684 be a character in the string with the
14685 `cursor' property, which means display
14686 cursor on that character's glyph. */
14687 ptrdiff_t strpos
= glyph
->charpos
;
14692 string_from_text_prop
= true;
14695 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14696 && EQ (glyph
->object
, str
);
14700 ptrdiff_t gpos
= glyph
->charpos
;
14702 cprop
= Fget_char_property (make_number (gpos
),
14710 if (tem
&& glyph
->charpos
< strpos
)
14712 strpos
= glyph
->charpos
;
14718 || (tem
- pt_old
> 0 && tem
< pos_after
))
14722 pos
= tem
+ 1; /* don't find previous instances */
14724 /* This string is not what we want; skip all of the
14725 glyphs that came from it. */
14726 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14727 && EQ (glyph
->object
, str
))
14734 /* If we reached the end of the line, and END was from a string,
14735 the cursor is not on this line. */
14737 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14738 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14739 && STRINGP (end
->object
)
14740 && row
->continued_p
)
14743 /* A truncated row may not include PT among its character positions.
14744 Setting the cursor inside the scroll margin will trigger
14745 recalculation of hscroll in hscroll_window_tree. But if a
14746 display string covers point, defer to the string-handling
14747 code below to figure this out. */
14748 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14750 cursor
= glyph_before
;
14753 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14754 /* Zero-width characters produce no glyphs. */
14756 && (row
->reversed_p
14757 ? glyph_after
> glyphs_end
14758 : glyph_after
< glyphs_end
)))
14760 cursor
= glyph_after
;
14766 if (cursor
!= NULL
)
14768 else if (glyph
== glyphs_end
14769 && pos_before
== pos_after
14770 && STRINGP ((row
->reversed_p
14771 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14772 : row
->glyphs
[TEXT_AREA
])->object
))
14774 /* If all the glyphs of this row came from strings, put the
14775 cursor on the first glyph of the row. This avoids having the
14776 cursor outside of the text area in this very rare and hard
14780 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14781 : row
->glyphs
[TEXT_AREA
];
14787 /* Need to compute x that corresponds to GLYPH. */
14788 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14790 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14792 x
+= g
->pixel_width
;
14796 /* ROW could be part of a continued line, which, under bidi
14797 reordering, might have other rows whose start and end charpos
14798 occlude point. Only set w->cursor if we found a better
14799 approximation to the cursor position than we have from previously
14800 examined candidate rows belonging to the same continued line. */
14801 if (/* We already have a candidate row. */
14802 w
->cursor
.vpos
>= 0
14803 /* That candidate is not the row we are processing. */
14804 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14805 /* Make sure cursor.vpos specifies a row whose start and end
14806 charpos occlude point, and it is valid candidate for being a
14807 cursor-row. This is because some callers of this function
14808 leave cursor.vpos at the row where the cursor was displayed
14809 during the last redisplay cycle. */
14810 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14811 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14812 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14815 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14817 /* Don't consider glyphs that are outside TEXT_AREA. */
14818 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14820 /* Keep the candidate whose buffer position is the closest to
14821 point or has the `cursor' property. */
14822 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14823 w
->cursor
.hpos
>= 0
14824 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14825 && ((BUFFERP (g1
->object
)
14826 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14827 || (BUFFERP (glyph
->object
)
14828 && eabs (g1
->charpos
- pt_old
)
14829 < eabs (glyph
->charpos
- pt_old
))))
14830 /* Previous candidate is a glyph from a string that has
14831 a non-nil `cursor' property. */
14832 || (STRINGP (g1
->object
)
14833 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14834 Qcursor
, g1
->object
))
14835 /* Previous candidate is from the same display
14836 string as this one, and the display string
14837 came from a text property. */
14838 || (EQ (g1
->object
, glyph
->object
)
14839 && string_from_text_prop
)
14840 /* this candidate is from newline and its
14841 position is not an exact match */
14842 || (NILP (glyph
->object
)
14843 && glyph
->charpos
!= pt_old
)))))
14845 /* If this candidate gives an exact match, use that. */
14846 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14847 /* If this candidate is a glyph created for the
14848 terminating newline of a line, and point is on that
14849 newline, it wins because it's an exact match. */
14850 || (!row
->continued_p
14851 && NILP (glyph
->object
)
14852 && glyph
->charpos
== 0
14853 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14854 /* Otherwise, keep the candidate that comes from a row
14855 spanning less buffer positions. This may win when one or
14856 both candidate positions are on glyphs that came from
14857 display strings, for which we cannot compare buffer
14859 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14860 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14861 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14864 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14866 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14867 w
->cursor
.y
= row
->y
+ dy
;
14869 if (w
== XWINDOW (selected_window
))
14871 if (!row
->continued_p
14872 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14875 this_line_buffer
= XBUFFER (w
->contents
);
14877 CHARPOS (this_line_start_pos
)
14878 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14879 BYTEPOS (this_line_start_pos
)
14880 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14882 CHARPOS (this_line_end_pos
)
14883 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14884 BYTEPOS (this_line_end_pos
)
14885 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14887 this_line_y
= w
->cursor
.y
;
14888 this_line_pixel_height
= row
->height
;
14889 this_line_vpos
= w
->cursor
.vpos
;
14890 this_line_start_x
= row
->x
;
14893 CHARPOS (this_line_start_pos
) = 0;
14900 /* Run window scroll functions, if any, for WINDOW with new window
14901 start STARTP. Sets the window start of WINDOW to that position.
14903 We assume that the window's buffer is really current. */
14905 static struct text_pos
14906 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14908 struct window
*w
= XWINDOW (window
);
14909 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14911 eassert (current_buffer
== XBUFFER (w
->contents
));
14913 if (!NILP (Vwindow_scroll_functions
))
14915 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14916 make_number (CHARPOS (startp
)));
14917 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14918 /* In case the hook functions switch buffers. */
14919 set_buffer_internal (XBUFFER (w
->contents
));
14926 /* Make sure the line containing the cursor is fully visible.
14927 A value of true means there is nothing to be done.
14928 (Either the line is fully visible, or it cannot be made so,
14929 or we cannot tell.)
14931 If FORCE_P, return false even if partial visible cursor row
14932 is higher than window.
14934 If CURRENT_MATRIX_P, use the information from the
14935 window's current glyph matrix; otherwise use the desired glyph
14938 A value of false means the caller should do scrolling
14939 as if point had gone off the screen. */
14942 cursor_row_fully_visible_p (struct window
*w
, bool force_p
,
14943 bool current_matrix_p
)
14945 struct glyph_matrix
*matrix
;
14946 struct glyph_row
*row
;
14949 if (!make_cursor_line_fully_visible_p
)
14952 /* It's not always possible to find the cursor, e.g, when a window
14953 is full of overlay strings. Don't do anything in that case. */
14954 if (w
->cursor
.vpos
< 0)
14957 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14958 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14960 /* If the cursor row is not partially visible, there's nothing to do. */
14961 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14964 /* If the row the cursor is in is taller than the window's height,
14965 it's not clear what to do, so do nothing. */
14966 window_height
= window_box_height (w
);
14967 if (row
->height
>= window_height
)
14969 if (!force_p
|| MINI_WINDOW_P (w
)
14970 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14977 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14978 means only WINDOW is redisplayed in redisplay_internal.
14979 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14980 in redisplay_window to bring a partially visible line into view in
14981 the case that only the cursor has moved.
14983 LAST_LINE_MISFIT should be true if we're scrolling because the
14984 last screen line's vertical height extends past the end of the screen.
14988 1 if scrolling succeeded
14990 0 if scrolling didn't find point.
14992 -1 if new fonts have been loaded so that we must interrupt
14993 redisplay, adjust glyph matrices, and try again. */
14999 SCROLLING_NEED_LARGER_MATRICES
15002 /* If scroll-conservatively is more than this, never recenter.
15004 If you change this, don't forget to update the doc string of
15005 `scroll-conservatively' and the Emacs manual. */
15006 #define SCROLL_LIMIT 100
15009 try_scrolling (Lisp_Object window
, bool just_this_one_p
,
15010 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15011 bool temp_scroll_step
, bool last_line_misfit
)
15013 struct window
*w
= XWINDOW (window
);
15014 struct frame
*f
= XFRAME (w
->frame
);
15015 struct text_pos pos
, startp
;
15017 int this_scroll_margin
, scroll_max
, rc
, height
;
15018 int dy
= 0, amount_to_scroll
= 0;
15019 bool scroll_down_p
= false;
15020 int extra_scroll_margin_lines
= last_line_misfit
;
15021 Lisp_Object aggressive
;
15022 /* We will never try scrolling more than this number of lines. */
15023 int scroll_limit
= SCROLL_LIMIT
;
15024 int frame_line_height
= default_line_pixel_height (w
);
15025 int window_total_lines
15026 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15029 debug_method_add (w
, "try_scrolling");
15032 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15034 /* Compute scroll margin height in pixels. We scroll when point is
15035 within this distance from the top or bottom of the window. */
15036 if (scroll_margin
> 0)
15037 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15038 * frame_line_height
;
15040 this_scroll_margin
= 0;
15042 /* Force arg_scroll_conservatively to have a reasonable value, to
15043 avoid scrolling too far away with slow move_it_* functions. Note
15044 that the user can supply scroll-conservatively equal to
15045 `most-positive-fixnum', which can be larger than INT_MAX. */
15046 if (arg_scroll_conservatively
> scroll_limit
)
15048 arg_scroll_conservatively
= scroll_limit
+ 1;
15049 scroll_max
= scroll_limit
* frame_line_height
;
15051 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15052 /* Compute how much we should try to scroll maximally to bring
15053 point into view. */
15054 scroll_max
= (max (scroll_step
,
15055 max (arg_scroll_conservatively
, temp_scroll_step
))
15056 * frame_line_height
);
15057 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15058 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15059 /* We're trying to scroll because of aggressive scrolling but no
15060 scroll_step is set. Choose an arbitrary one. */
15061 scroll_max
= 10 * frame_line_height
;
15067 /* Decide whether to scroll down. */
15068 if (PT
> CHARPOS (startp
))
15070 int scroll_margin_y
;
15072 /* Compute the pixel ypos of the scroll margin, then move IT to
15073 either that ypos or PT, whichever comes first. */
15074 start_display (&it
, w
, startp
);
15075 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15076 - frame_line_height
* extra_scroll_margin_lines
;
15077 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15078 (MOVE_TO_POS
| MOVE_TO_Y
));
15080 if (PT
> CHARPOS (it
.current
.pos
))
15082 int y0
= line_bottom_y (&it
);
15083 /* Compute how many pixels below window bottom to stop searching
15084 for PT. This avoids costly search for PT that is far away if
15085 the user limited scrolling by a small number of lines, but
15086 always finds PT if scroll_conservatively is set to a large
15087 number, such as most-positive-fixnum. */
15088 int slack
= max (scroll_max
, 10 * frame_line_height
);
15089 int y_to_move
= it
.last_visible_y
+ slack
;
15091 /* Compute the distance from the scroll margin to PT or to
15092 the scroll limit, whichever comes first. This should
15093 include the height of the cursor line, to make that line
15095 move_it_to (&it
, PT
, -1, y_to_move
,
15096 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15097 dy
= line_bottom_y (&it
) - y0
;
15099 if (dy
> scroll_max
)
15100 return SCROLLING_FAILED
;
15103 scroll_down_p
= true;
15109 /* Point is in or below the bottom scroll margin, so move the
15110 window start down. If scrolling conservatively, move it just
15111 enough down to make point visible. If scroll_step is set,
15112 move it down by scroll_step. */
15113 if (arg_scroll_conservatively
)
15115 = min (max (dy
, frame_line_height
),
15116 frame_line_height
* arg_scroll_conservatively
);
15117 else if (scroll_step
|| temp_scroll_step
)
15118 amount_to_scroll
= scroll_max
;
15121 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15122 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15123 if (NUMBERP (aggressive
))
15125 double float_amount
= XFLOATINT (aggressive
) * height
;
15126 int aggressive_scroll
= float_amount
;
15127 if (aggressive_scroll
== 0 && float_amount
> 0)
15128 aggressive_scroll
= 1;
15129 /* Don't let point enter the scroll margin near top of
15130 the window. This could happen if the value of
15131 scroll_up_aggressively is too large and there are
15132 non-zero margins, because scroll_up_aggressively
15133 means put point that fraction of window height
15134 _from_the_bottom_margin_. */
15135 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15136 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15137 amount_to_scroll
= dy
+ aggressive_scroll
;
15141 if (amount_to_scroll
<= 0)
15142 return SCROLLING_FAILED
;
15144 start_display (&it
, w
, startp
);
15145 if (arg_scroll_conservatively
<= scroll_limit
)
15146 move_it_vertically (&it
, amount_to_scroll
);
15149 /* Extra precision for users who set scroll-conservatively
15150 to a large number: make sure the amount we scroll
15151 the window start is never less than amount_to_scroll,
15152 which was computed as distance from window bottom to
15153 point. This matters when lines at window top and lines
15154 below window bottom have different height. */
15156 void *it1data
= NULL
;
15157 /* We use a temporary it1 because line_bottom_y can modify
15158 its argument, if it moves one line down; see there. */
15161 SAVE_IT (it1
, it
, it1data
);
15162 start_y
= line_bottom_y (&it1
);
15164 RESTORE_IT (&it
, &it
, it1data
);
15165 move_it_by_lines (&it
, 1);
15166 SAVE_IT (it1
, it
, it1data
);
15167 } while (IT_CHARPOS (it
) < ZV
15168 && line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15169 bidi_unshelve_cache (it1data
, true);
15172 /* If STARTP is unchanged, move it down another screen line. */
15173 if (IT_CHARPOS (it
) == CHARPOS (startp
))
15174 move_it_by_lines (&it
, 1);
15175 startp
= it
.current
.pos
;
15179 struct text_pos scroll_margin_pos
= startp
;
15182 /* See if point is inside the scroll margin at the top of the
15184 if (this_scroll_margin
)
15188 start_display (&it
, w
, startp
);
15189 y_start
= it
.current_y
;
15190 move_it_vertically (&it
, this_scroll_margin
);
15191 scroll_margin_pos
= it
.current
.pos
;
15192 /* If we didn't move enough before hitting ZV, request
15193 additional amount of scroll, to move point out of the
15195 if (IT_CHARPOS (it
) == ZV
15196 && it
.current_y
- y_start
< this_scroll_margin
)
15197 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15200 if (PT
< CHARPOS (scroll_margin_pos
))
15202 /* Point is in the scroll margin at the top of the window or
15203 above what is displayed in the window. */
15206 /* Compute the vertical distance from PT to the scroll
15207 margin position. Move as far as scroll_max allows, or
15208 one screenful, or 10 screen lines, whichever is largest.
15209 Give up if distance is greater than scroll_max or if we
15210 didn't reach the scroll margin position. */
15211 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15212 start_display (&it
, w
, pos
);
15214 y_to_move
= max (it
.last_visible_y
,
15215 max (scroll_max
, 10 * frame_line_height
));
15216 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15218 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15219 dy
= it
.current_y
- y0
;
15220 if (dy
> scroll_max
15221 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15222 return SCROLLING_FAILED
;
15224 /* Additional scroll for when ZV was too close to point. */
15227 /* Compute new window start. */
15228 start_display (&it
, w
, startp
);
15230 if (arg_scroll_conservatively
)
15231 amount_to_scroll
= max (dy
, frame_line_height
15232 * max (scroll_step
, temp_scroll_step
));
15233 else if (scroll_step
|| temp_scroll_step
)
15234 amount_to_scroll
= scroll_max
;
15237 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15238 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15239 if (NUMBERP (aggressive
))
15241 double float_amount
= XFLOATINT (aggressive
) * height
;
15242 int aggressive_scroll
= float_amount
;
15243 if (aggressive_scroll
== 0 && float_amount
> 0)
15244 aggressive_scroll
= 1;
15245 /* Don't let point enter the scroll margin near
15246 bottom of the window, if the value of
15247 scroll_down_aggressively happens to be too
15249 if (aggressive_scroll
+ 2 * this_scroll_margin
> height
)
15250 aggressive_scroll
= height
- 2 * this_scroll_margin
;
15251 amount_to_scroll
= dy
+ aggressive_scroll
;
15255 if (amount_to_scroll
<= 0)
15256 return SCROLLING_FAILED
;
15258 move_it_vertically_backward (&it
, amount_to_scroll
);
15259 startp
= it
.current
.pos
;
15263 /* Run window scroll functions. */
15264 startp
= run_window_scroll_functions (window
, startp
);
15266 /* Display the window. Give up if new fonts are loaded, or if point
15268 if (!try_window (window
, startp
, 0))
15269 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15270 else if (w
->cursor
.vpos
< 0)
15272 clear_glyph_matrix (w
->desired_matrix
);
15273 rc
= SCROLLING_FAILED
;
15277 /* Maybe forget recorded base line for line number display. */
15278 if (!just_this_one_p
15279 || current_buffer
->clip_changed
15280 || BEG_UNCHANGED
< CHARPOS (startp
))
15281 w
->base_line_number
= 0;
15283 /* If cursor ends up on a partially visible line,
15284 treat that as being off the bottom of the screen. */
15285 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1,
15287 /* It's possible that the cursor is on the first line of the
15288 buffer, which is partially obscured due to a vscroll
15289 (Bug#7537). In that case, avoid looping forever. */
15290 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15292 clear_glyph_matrix (w
->desired_matrix
);
15293 ++extra_scroll_margin_lines
;
15296 rc
= SCROLLING_SUCCESS
;
15303 /* Compute a suitable window start for window W if display of W starts
15304 on a continuation line. Value is true if a new window start
15307 The new window start will be computed, based on W's width, starting
15308 from the start of the continued line. It is the start of the
15309 screen line with the minimum distance from the old start W->start. */
15312 compute_window_start_on_continuation_line (struct window
*w
)
15314 struct text_pos pos
, start_pos
;
15315 bool window_start_changed_p
= false;
15317 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15319 /* If window start is on a continuation line... Window start may be
15320 < BEGV in case there's invisible text at the start of the
15321 buffer (M-x rmail, for example). */
15322 if (CHARPOS (start_pos
) > BEGV
15323 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15326 struct glyph_row
*row
;
15328 /* Handle the case that the window start is out of range. */
15329 if (CHARPOS (start_pos
) < BEGV
)
15330 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15331 else if (CHARPOS (start_pos
) > ZV
)
15332 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15334 /* Find the start of the continued line. This should be fast
15335 because find_newline is fast (newline cache). */
15336 row
= w
->desired_matrix
->rows
+ WINDOW_WANTS_HEADER_LINE_P (w
);
15337 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15338 row
, DEFAULT_FACE_ID
);
15339 reseat_at_previous_visible_line_start (&it
);
15341 /* If the line start is "too far" away from the window start,
15342 say it takes too much time to compute a new window start. */
15343 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15344 /* PXW: Do we need upper bounds here? */
15345 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15347 int min_distance
, distance
;
15349 /* Move forward by display lines to find the new window
15350 start. If window width was enlarged, the new start can
15351 be expected to be > the old start. If window width was
15352 decreased, the new window start will be < the old start.
15353 So, we're looking for the display line start with the
15354 minimum distance from the old window start. */
15355 pos
= it
.current
.pos
;
15356 min_distance
= INFINITY
;
15357 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15358 distance
< min_distance
)
15360 min_distance
= distance
;
15361 pos
= it
.current
.pos
;
15362 if (it
.line_wrap
== WORD_WRAP
)
15364 /* Under WORD_WRAP, move_it_by_lines is likely to
15365 overshoot and stop not at the first, but the
15366 second character from the left margin. So in
15367 that case, we need a more tight control on the X
15368 coordinate of the iterator than move_it_by_lines
15369 promises in its contract. The method is to first
15370 go to the last (rightmost) visible character of a
15371 line, then move to the leftmost character on the
15372 next line in a separate call. */
15373 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15374 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15375 move_it_to (&it
, ZV
, 0,
15376 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15377 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15380 move_it_by_lines (&it
, 1);
15383 /* Set the window start there. */
15384 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15385 window_start_changed_p
= true;
15389 return window_start_changed_p
;
15393 /* Try cursor movement in case text has not changed in window WINDOW,
15394 with window start STARTP. Value is
15396 CURSOR_MOVEMENT_SUCCESS if successful
15398 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15400 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15401 display. *SCROLL_STEP is set to true, under certain circumstances, if
15402 we want to scroll as if scroll-step were set to 1. See the code.
15404 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15405 which case we have to abort this redisplay, and adjust matrices
15410 CURSOR_MOVEMENT_SUCCESS
,
15411 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15412 CURSOR_MOVEMENT_MUST_SCROLL
,
15413 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15417 try_cursor_movement (Lisp_Object window
, struct text_pos startp
,
15420 struct window
*w
= XWINDOW (window
);
15421 struct frame
*f
= XFRAME (w
->frame
);
15422 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15425 if (inhibit_try_cursor_movement
)
15429 /* Previously, there was a check for Lisp integer in the
15430 if-statement below. Now, this field is converted to
15431 ptrdiff_t, thus zero means invalid position in a buffer. */
15432 eassert (w
->last_point
> 0);
15433 /* Likewise there was a check whether window_end_vpos is nil or larger
15434 than the window. Now window_end_vpos is int and so never nil, but
15435 let's leave eassert to check whether it fits in the window. */
15436 eassert (!w
->window_end_valid
15437 || w
->window_end_vpos
< w
->current_matrix
->nrows
);
15439 /* Handle case where text has not changed, only point, and it has
15440 not moved off the frame. */
15441 if (/* Point may be in this window. */
15442 PT
>= CHARPOS (startp
)
15443 /* Selective display hasn't changed. */
15444 && !current_buffer
->clip_changed
15445 /* Function force-mode-line-update is used to force a thorough
15446 redisplay. It sets either windows_or_buffers_changed or
15447 update_mode_lines. So don't take a shortcut here for these
15449 && !update_mode_lines
15450 && !windows_or_buffers_changed
15451 && !f
->cursor_type_changed
15452 && NILP (Vshow_trailing_whitespace
)
15453 /* This code is not used for mini-buffer for the sake of the case
15454 of redisplaying to replace an echo area message; since in
15455 that case the mini-buffer contents per se are usually
15456 unchanged. This code is of no real use in the mini-buffer
15457 since the handling of this_line_start_pos, etc., in redisplay
15458 handles the same cases. */
15459 && !EQ (window
, minibuf_window
)
15460 && (FRAME_WINDOW_P (f
)
15461 || !overlay_arrow_in_current_buffer_p ()))
15463 int this_scroll_margin
, top_scroll_margin
;
15464 struct glyph_row
*row
= NULL
;
15465 int frame_line_height
= default_line_pixel_height (w
);
15466 int window_total_lines
15467 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15470 debug_method_add (w
, "cursor movement");
15473 /* Scroll if point within this distance from the top or bottom
15474 of the window. This is a pixel value. */
15475 if (scroll_margin
> 0)
15477 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15478 this_scroll_margin
*= frame_line_height
;
15481 this_scroll_margin
= 0;
15483 top_scroll_margin
= this_scroll_margin
;
15484 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15485 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15487 /* Start with the row the cursor was displayed during the last
15488 not paused redisplay. Give up if that row is not valid. */
15489 if (w
->last_cursor_vpos
< 0
15490 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15491 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15494 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15495 if (row
->mode_line_p
)
15497 if (!row
->enabled_p
)
15498 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15501 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15503 bool scroll_p
= false, must_scroll
= false;
15504 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15506 if (PT
> w
->last_point
)
15508 /* Point has moved forward. */
15509 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15510 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15512 eassert (row
->enabled_p
);
15516 /* If the end position of a row equals the start
15517 position of the next row, and PT is at that position,
15518 we would rather display cursor in the next line. */
15519 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15520 && MATRIX_ROW_END_CHARPOS (row
) == PT
15521 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15522 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15523 && !cursor_row_p (row
))
15526 /* If within the scroll margin, scroll. Note that
15527 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15528 the next line would be drawn, and that
15529 this_scroll_margin can be zero. */
15530 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15531 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15532 /* Line is completely visible last line in window
15533 and PT is to be set in the next line. */
15534 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15535 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15536 && !row
->ends_at_zv_p
15537 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15540 else if (PT
< w
->last_point
)
15542 /* Cursor has to be moved backward. Note that PT >=
15543 CHARPOS (startp) because of the outer if-statement. */
15544 while (!row
->mode_line_p
15545 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15546 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15547 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15548 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15549 row
> w
->current_matrix
->rows
15550 && (row
-1)->ends_in_newline_from_string_p
))))
15551 && (row
->y
> top_scroll_margin
15552 || CHARPOS (startp
) == BEGV
))
15554 eassert (row
->enabled_p
);
15558 /* Consider the following case: Window starts at BEGV,
15559 there is invisible, intangible text at BEGV, so that
15560 display starts at some point START > BEGV. It can
15561 happen that we are called with PT somewhere between
15562 BEGV and START. Try to handle that case. */
15563 if (row
< w
->current_matrix
->rows
15564 || row
->mode_line_p
)
15566 row
= w
->current_matrix
->rows
;
15567 if (row
->mode_line_p
)
15571 /* Due to newlines in overlay strings, we may have to
15572 skip forward over overlay strings. */
15573 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15574 && MATRIX_ROW_END_CHARPOS (row
) == PT
15575 && !cursor_row_p (row
))
15578 /* If within the scroll margin, scroll. */
15579 if (row
->y
< top_scroll_margin
15580 && CHARPOS (startp
) != BEGV
)
15585 /* Cursor did not move. So don't scroll even if cursor line
15586 is partially visible, as it was so before. */
15587 rc
= CURSOR_MOVEMENT_SUCCESS
;
15590 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15591 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15593 /* if PT is not in the glyph row, give up. */
15594 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15595 must_scroll
= true;
15597 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15598 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15600 struct glyph_row
*row1
;
15602 /* If rows are bidi-reordered and point moved, back up
15603 until we find a row that does not belong to a
15604 continuation line. This is because we must consider
15605 all rows of a continued line as candidates for the
15606 new cursor positioning, since row start and end
15607 positions change non-linearly with vertical position
15609 /* FIXME: Revisit this when glyph ``spilling'' in
15610 continuation lines' rows is implemented for
15611 bidi-reordered rows. */
15612 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15613 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15616 /* If we hit the beginning of the displayed portion
15617 without finding the first row of a continued
15621 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15624 eassert (row
->enabled_p
);
15629 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15630 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15631 /* Make sure this isn't a header line by any chance, since
15632 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15633 && !row
->mode_line_p
15634 && make_cursor_line_fully_visible_p
)
15636 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15637 && !row
->ends_at_zv_p
15638 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15639 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15640 else if (row
->height
> window_box_height (w
))
15642 /* If we end up in a partially visible line, let's
15643 make it fully visible, except when it's taller
15644 than the window, in which case we can't do much
15646 *scroll_step
= true;
15647 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15651 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15652 if (!cursor_row_fully_visible_p (w
, false, true))
15653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15655 rc
= CURSOR_MOVEMENT_SUCCESS
;
15659 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15660 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15661 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15663 /* With bidi-reordered rows, there could be more than
15664 one candidate row whose start and end positions
15665 occlude point. We need to let set_cursor_from_row
15666 find the best candidate. */
15667 /* FIXME: Revisit this when glyph ``spilling'' in
15668 continuation lines' rows is implemented for
15669 bidi-reordered rows. */
15674 bool at_zv_p
= false, exact_match_p
= false;
15676 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15677 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15678 && cursor_row_p (row
))
15679 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15681 /* As soon as we've found the exact match for point,
15682 or the first suitable row whose ends_at_zv_p flag
15683 is set, we are done. */
15686 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15687 w
->cursor
.vpos
)->ends_at_zv_p
;
15689 && w
->cursor
.hpos
>= 0
15690 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15693 struct glyph_row
*candidate
=
15694 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15696 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15697 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15700 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15701 || (NILP (g
->object
)
15702 && (g
->charpos
== PT
15703 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15705 if (at_zv_p
|| exact_match_p
)
15707 rc
= CURSOR_MOVEMENT_SUCCESS
;
15711 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15715 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15716 || row
->continued_p
)
15717 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15718 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15719 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15720 /* If we didn't find any candidate rows, or exited the
15721 loop before all the candidates were examined, signal
15722 to the caller that this method failed. */
15723 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15725 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15726 && !row
->continued_p
))
15727 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15729 rc
= CURSOR_MOVEMENT_SUCCESS
;
15735 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15737 rc
= CURSOR_MOVEMENT_SUCCESS
;
15742 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15743 && MATRIX_ROW_START_CHARPOS (row
) == PT
15744 && cursor_row_p (row
));
15754 set_vertical_scroll_bar (struct window
*w
)
15756 ptrdiff_t start
, end
, whole
;
15758 /* Calculate the start and end positions for the current window.
15759 At some point, it would be nice to choose between scrollbars
15760 which reflect the whole buffer size, with special markers
15761 indicating narrowing, and scrollbars which reflect only the
15764 Note that mini-buffers sometimes aren't displaying any text. */
15765 if (!MINI_WINDOW_P (w
)
15766 || (w
== XWINDOW (minibuf_window
)
15767 && NILP (echo_area_buffer
[0])))
15769 struct buffer
*buf
= XBUFFER (w
->contents
);
15770 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15771 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15772 /* I don't think this is guaranteed to be right. For the
15773 moment, we'll pretend it is. */
15774 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15778 if (whole
< (end
- start
))
15779 whole
= end
- start
;
15782 start
= end
= whole
= 0;
15784 /* Indicate what this scroll bar ought to be displaying now. */
15785 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15786 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15787 (w
, end
- start
, whole
, start
);
15792 set_horizontal_scroll_bar (struct window
*w
)
15794 int start
, end
, whole
, portion
;
15796 if (!MINI_WINDOW_P (w
)
15797 || (w
== XWINDOW (minibuf_window
)
15798 && NILP (echo_area_buffer
[0])))
15800 struct buffer
*b
= XBUFFER (w
->contents
);
15801 struct buffer
*old_buffer
= NULL
;
15803 struct text_pos startp
;
15805 if (b
!= current_buffer
)
15807 old_buffer
= current_buffer
;
15808 set_buffer_internal (b
);
15811 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15812 start_display (&it
, w
, startp
);
15813 it
.last_visible_x
= INT_MAX
;
15814 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15815 MOVE_TO_X
| MOVE_TO_Y
);
15816 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15817 window_box_height (w), -1,
15818 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15820 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15821 end
= start
+ window_box_width (w
, TEXT_AREA
);
15822 portion
= end
- start
;
15823 /* After enlarging a horizontally scrolled window such that it
15824 gets at least as wide as the text it contains, make sure that
15825 the thumb doesn't fill the entire scroll bar so we can still
15826 drag it back to see the entire text. */
15827 whole
= max (whole
, end
);
15833 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15834 if (EQ (pdir
, Qright_to_left
))
15836 start
= whole
- end
;
15837 end
= start
+ portion
;
15842 set_buffer_internal (old_buffer
);
15845 start
= end
= whole
= portion
= 0;
15847 w
->hscroll_whole
= whole
;
15849 /* Indicate what this scroll bar ought to be displaying now. */
15850 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15851 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15852 (w
, portion
, whole
, start
);
15856 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
15857 selected_window is redisplayed.
15859 We can return without actually redisplaying the window if fonts has been
15860 changed on window's frame. In that case, redisplay_internal will retry.
15862 As one of the important parts of redisplaying a window, we need to
15863 decide whether the previous window-start position (stored in the
15864 window's w->start marker position) is still valid, and if it isn't,
15865 recompute it. Some details about that:
15867 . The previous window-start could be in a continuation line, in
15868 which case we need to recompute it when the window width
15869 changes. See compute_window_start_on_continuation_line and its
15872 . The text that changed since last redisplay could include the
15873 previous window-start position. In that case, we try to salvage
15874 what we can from the current glyph matrix by calling
15875 try_scrolling, which see.
15877 . Some Emacs command could force us to use a specific window-start
15878 position by setting the window's force_start flag, or gently
15879 propose doing that by setting the window's optional_new_start
15880 flag. In these cases, we try using the specified start point if
15881 that succeeds (i.e. the window desired matrix is successfully
15882 recomputed, and point location is within the window). In case
15883 of optional_new_start, we first check if the specified start
15884 position is feasible, i.e. if it will allow point to be
15885 displayed in the window. If using the specified start point
15886 fails, e.g., if new fonts are needed to be loaded, we abort the
15887 redisplay cycle and leave it up to the next cycle to figure out
15890 . Note that the window's force_start flag is sometimes set by
15891 redisplay itself, when it decides that the previous window start
15892 point is fine and should be kept. Search for "goto force_start"
15893 below to see the details. Like the values of window-start
15894 specified outside of redisplay, these internally-deduced values
15895 are tested for feasibility, and ignored if found to be
15898 . Note that the function try_window, used to completely redisplay
15899 a window, accepts the window's start point as its argument.
15900 This is used several times in the redisplay code to control
15901 where the window start will be, according to user options such
15902 as scroll-conservatively, and also to ensure the screen line
15903 showing point will be fully (as opposed to partially) visible on
15907 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15909 struct window
*w
= XWINDOW (window
);
15910 struct frame
*f
= XFRAME (w
->frame
);
15911 struct buffer
*buffer
= XBUFFER (w
->contents
);
15912 struct buffer
*old
= current_buffer
;
15913 struct text_pos lpoint
, opoint
, startp
;
15914 bool update_mode_line
;
15917 /* Record it now because it's overwritten. */
15918 bool current_matrix_up_to_date_p
= false;
15919 bool used_current_matrix_p
= false;
15920 /* This is less strict than current_matrix_up_to_date_p.
15921 It indicates that the buffer contents and narrowing are unchanged. */
15922 bool buffer_unchanged_p
= false;
15923 bool temp_scroll_step
= false;
15924 ptrdiff_t count
= SPECPDL_INDEX ();
15926 int centering_position
= -1;
15927 bool last_line_misfit
= false;
15928 ptrdiff_t beg_unchanged
, end_unchanged
;
15929 int frame_line_height
;
15931 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15935 *w
->desired_matrix
->method
= 0;
15938 if (!just_this_one_p
15939 && REDISPLAY_SOME_P ()
15941 && !w
->update_mode_line
15944 && !buffer
->text
->redisplay
15945 && BUF_PT (buffer
) == w
->last_point
)
15948 /* Make sure that both W's markers are valid. */
15949 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15950 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15952 /* We come here again if we need to run window-text-change-functions
15955 reconsider_clip_changes (w
);
15956 frame_line_height
= default_line_pixel_height (w
);
15958 /* Has the mode line to be updated? */
15959 update_mode_line
= (w
->update_mode_line
15960 || update_mode_lines
15961 || buffer
->clip_changed
15962 || buffer
->prevent_redisplay_optimizations_p
);
15964 if (!just_this_one_p
)
15965 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15966 cleverly elsewhere. */
15967 w
->must_be_updated_p
= true;
15969 if (MINI_WINDOW_P (w
))
15971 if (w
== XWINDOW (echo_area_window
)
15972 && !NILP (echo_area_buffer
[0]))
15974 if (update_mode_line
)
15975 /* We may have to update a tty frame's menu bar or a
15976 tool-bar. Example `M-x C-h C-h C-g'. */
15977 goto finish_menu_bars
;
15979 /* We've already displayed the echo area glyphs in this window. */
15980 goto finish_scroll_bars
;
15982 else if ((w
!= XWINDOW (minibuf_window
)
15983 || minibuf_level
== 0)
15984 /* When buffer is nonempty, redisplay window normally. */
15985 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15986 /* Quail displays non-mini buffers in minibuffer window.
15987 In that case, redisplay the window normally. */
15988 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15990 /* W is a mini-buffer window, but it's not active, so clear
15992 int yb
= window_text_bottom_y (w
);
15993 struct glyph_row
*row
;
15996 for (y
= 0, row
= w
->desired_matrix
->rows
;
15998 y
+= row
->height
, ++row
)
15999 blank_row (w
, row
, y
);
16000 goto finish_scroll_bars
;
16003 clear_glyph_matrix (w
->desired_matrix
);
16006 /* Otherwise set up data on this window; select its buffer and point
16008 /* Really select the buffer, for the sake of buffer-local
16010 set_buffer_internal_1 (XBUFFER (w
->contents
));
16012 current_matrix_up_to_date_p
16013 = (w
->window_end_valid
16014 && !current_buffer
->clip_changed
16015 && !current_buffer
->prevent_redisplay_optimizations_p
16016 && !window_outdated (w
));
16018 /* Run the window-text-change-functions
16019 if it is possible that the text on the screen has changed
16020 (either due to modification of the text, or any other reason). */
16021 if (!current_matrix_up_to_date_p
16022 && !NILP (Vwindow_text_change_functions
))
16024 safe_run_hooks (Qwindow_text_change_functions
);
16028 beg_unchanged
= BEG_UNCHANGED
;
16029 end_unchanged
= END_UNCHANGED
;
16031 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16033 specbind (Qinhibit_point_motion_hooks
, Qt
);
16036 = (w
->window_end_valid
16037 && !current_buffer
->clip_changed
16038 && !window_outdated (w
));
16040 /* When windows_or_buffers_changed is non-zero, we can't rely
16041 on the window end being valid, so set it to zero there. */
16042 if (windows_or_buffers_changed
)
16044 /* If window starts on a continuation line, maybe adjust the
16045 window start in case the window's width changed. */
16046 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16047 compute_window_start_on_continuation_line (w
);
16049 w
->window_end_valid
= false;
16050 /* If so, we also can't rely on current matrix
16051 and should not fool try_cursor_movement below. */
16052 current_matrix_up_to_date_p
= false;
16055 /* Some sanity checks. */
16056 CHECK_WINDOW_END (w
);
16057 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16059 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16062 if (mode_line_update_needed (w
))
16063 update_mode_line
= true;
16065 /* Point refers normally to the selected window. For any other
16066 window, set up appropriate value. */
16067 if (!EQ (window
, selected_window
))
16069 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16070 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16075 new_pt_byte
= BEGV_BYTE
;
16076 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16078 else if (new_pt
> (ZV
- 1))
16081 new_pt_byte
= ZV_BYTE
;
16082 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16085 /* We don't use SET_PT so that the point-motion hooks don't run. */
16086 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16089 /* If any of the character widths specified in the display table
16090 have changed, invalidate the width run cache. It's true that
16091 this may be a bit late to catch such changes, but the rest of
16092 redisplay goes (non-fatally) haywire when the display table is
16093 changed, so why should we worry about doing any better? */
16094 if (current_buffer
->width_run_cache
16095 || (current_buffer
->base_buffer
16096 && current_buffer
->base_buffer
->width_run_cache
))
16098 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16100 if (! disptab_matches_widthtab
16101 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16103 struct buffer
*buf
= current_buffer
;
16105 if (buf
->base_buffer
)
16106 buf
= buf
->base_buffer
;
16107 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16108 recompute_width_table (current_buffer
, disptab
);
16112 /* If window-start is screwed up, choose a new one. */
16113 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16116 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16118 /* If someone specified a new starting point but did not insist,
16119 check whether it can be used. */
16120 if ((w
->optional_new_start
|| window_frozen_p (w
))
16121 && CHARPOS (startp
) >= BEGV
16122 && CHARPOS (startp
) <= ZV
)
16124 ptrdiff_t it_charpos
;
16126 w
->optional_new_start
= false;
16127 start_display (&it
, w
, startp
);
16128 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16129 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16130 /* Record IT's position now, since line_bottom_y might change
16132 it_charpos
= IT_CHARPOS (it
);
16133 /* Make sure we set the force_start flag only if the cursor row
16134 will be fully visible. Otherwise, the code under force_start
16135 label below will try to move point back into view, which is
16136 not what the code which sets optional_new_start wants. */
16137 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16138 && !w
->force_start
)
16140 if (it_charpos
== PT
)
16141 w
->force_start
= true;
16142 /* IT may overshoot PT if text at PT is invisible. */
16143 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16144 w
->force_start
= true;
16146 if (w
->force_start
)
16148 if (window_frozen_p (w
))
16149 debug_method_add (w
, "set force_start from frozen window start");
16151 debug_method_add (w
, "set force_start from optional_new_start");
16159 /* Handle case where place to start displaying has been specified,
16160 unless the specified location is outside the accessible range. */
16161 if (w
->force_start
)
16163 /* We set this later on if we have to adjust point. */
16166 w
->force_start
= false;
16168 w
->window_end_valid
= false;
16170 /* Forget any recorded base line for line number display. */
16171 if (!buffer_unchanged_p
)
16172 w
->base_line_number
= 0;
16174 /* Redisplay the mode line. Select the buffer properly for that.
16175 Also, run the hook window-scroll-functions
16176 because we have scrolled. */
16177 /* Note, we do this after clearing force_start because
16178 if there's an error, it is better to forget about force_start
16179 than to get into an infinite loop calling the hook functions
16180 and having them get more errors. */
16181 if (!update_mode_line
16182 || ! NILP (Vwindow_scroll_functions
))
16184 update_mode_line
= true;
16185 w
->update_mode_line
= true;
16186 startp
= run_window_scroll_functions (window
, startp
);
16189 if (CHARPOS (startp
) < BEGV
)
16190 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16191 else if (CHARPOS (startp
) > ZV
)
16192 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16194 /* Redisplay, then check if cursor has been set during the
16195 redisplay. Give up if new fonts were loaded. */
16196 /* We used to issue a CHECK_MARGINS argument to try_window here,
16197 but this causes scrolling to fail when point begins inside
16198 the scroll margin (bug#148) -- cyd */
16199 if (!try_window (window
, startp
, 0))
16201 w
->force_start
= true;
16202 clear_glyph_matrix (w
->desired_matrix
);
16203 goto need_larger_matrices
;
16206 if (w
->cursor
.vpos
< 0)
16208 /* If point does not appear, try to move point so it does
16209 appear. The desired matrix has been built above, so we
16210 can use it here. */
16211 new_vpos
= window_box_height (w
) / 2;
16214 if (!cursor_row_fully_visible_p (w
, false, false))
16216 /* Point does appear, but on a line partly visible at end of window.
16217 Move it back to a fully-visible line. */
16218 new_vpos
= window_box_height (w
);
16219 /* But if window_box_height suggests a Y coordinate that is
16220 not less than we already have, that line will clearly not
16221 be fully visible, so give up and scroll the display.
16222 This can happen when the default face uses a font whose
16223 dimensions are different from the frame's default
16225 if (new_vpos
>= w
->cursor
.y
)
16227 w
->cursor
.vpos
= -1;
16228 clear_glyph_matrix (w
->desired_matrix
);
16229 goto try_to_scroll
;
16232 else if (w
->cursor
.vpos
>= 0)
16234 /* Some people insist on not letting point enter the scroll
16235 margin, even though this part handles windows that didn't
16237 int window_total_lines
16238 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16239 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16240 int pixel_margin
= margin
* frame_line_height
;
16241 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16243 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16244 below, which finds the row to move point to, advances by
16245 the Y coordinate of the _next_ row, see the definition of
16246 MATRIX_ROW_BOTTOM_Y. */
16247 if (w
->cursor
.vpos
< margin
+ header_line
)
16249 w
->cursor
.vpos
= -1;
16250 clear_glyph_matrix (w
->desired_matrix
);
16251 goto try_to_scroll
;
16255 int window_height
= window_box_height (w
);
16258 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16259 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16261 w
->cursor
.vpos
= -1;
16262 clear_glyph_matrix (w
->desired_matrix
);
16263 goto try_to_scroll
;
16268 /* If we need to move point for either of the above reasons,
16269 now actually do it. */
16272 struct glyph_row
*row
;
16274 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16275 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16278 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16279 MATRIX_ROW_START_BYTEPOS (row
));
16281 if (w
!= XWINDOW (selected_window
))
16282 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16283 else if (current_buffer
== old
)
16284 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16286 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16288 /* Re-run pre-redisplay-function so it can update the region
16289 according to the new position of point. */
16290 /* Other than the cursor, w's redisplay is done so we can set its
16291 redisplay to false. Also the buffer's redisplay can be set to
16292 false, since propagate_buffer_redisplay should have already
16293 propagated its info to `w' anyway. */
16294 w
->redisplay
= false;
16295 XBUFFER (w
->contents
)->text
->redisplay
= false;
16296 safe__call1 (true, Vpre_redisplay_function
, Fcons (window
, Qnil
));
16298 if (w
->redisplay
|| XBUFFER (w
->contents
)->text
->redisplay
)
16300 /* pre-redisplay-function made changes (e.g. move the region)
16301 that require another round of redisplay. */
16302 clear_glyph_matrix (w
->desired_matrix
);
16303 if (!try_window (window
, startp
, 0))
16304 goto need_larger_matrices
;
16307 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, false, false))
16309 clear_glyph_matrix (w
->desired_matrix
);
16310 goto try_to_scroll
;
16314 debug_method_add (w
, "forced window start");
16319 /* Handle case where text has not changed, only point, and it has
16320 not moved off the frame, and we are not retrying after hscroll.
16321 (current_matrix_up_to_date_p is true when retrying.) */
16322 if (current_matrix_up_to_date_p
16323 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16324 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16328 case CURSOR_MOVEMENT_SUCCESS
:
16329 used_current_matrix_p
= true;
16332 case CURSOR_MOVEMENT_MUST_SCROLL
:
16333 goto try_to_scroll
;
16339 /* If current starting point was originally the beginning of a line
16340 but no longer is, find a new starting point. */
16341 else if (w
->start_at_line_beg
16342 && !(CHARPOS (startp
) <= BEGV
16343 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16346 debug_method_add (w
, "recenter 1");
16351 /* Try scrolling with try_window_id. Value is > 0 if update has
16352 been done, it is -1 if we know that the same window start will
16353 not work. It is 0 if unsuccessful for some other reason. */
16354 else if ((tem
= try_window_id (w
)) != 0)
16357 debug_method_add (w
, "try_window_id %d", tem
);
16360 if (f
->fonts_changed
)
16361 goto need_larger_matrices
;
16365 /* Otherwise try_window_id has returned -1 which means that we
16366 don't want the alternative below this comment to execute. */
16368 else if (CHARPOS (startp
) >= BEGV
16369 && CHARPOS (startp
) <= ZV
16370 && PT
>= CHARPOS (startp
)
16371 && (CHARPOS (startp
) < ZV
16372 /* Avoid starting at end of buffer. */
16373 || CHARPOS (startp
) == BEGV
16374 || !window_outdated (w
)))
16376 int d1
, d2
, d5
, d6
;
16379 /* If first window line is a continuation line, and window start
16380 is inside the modified region, but the first change is before
16381 current window start, we must select a new window start.
16383 However, if this is the result of a down-mouse event (e.g. by
16384 extending the mouse-drag-overlay), we don't want to select a
16385 new window start, since that would change the position under
16386 the mouse, resulting in an unwanted mouse-movement rather
16387 than a simple mouse-click. */
16388 if (!w
->start_at_line_beg
16389 && NILP (do_mouse_tracking
)
16390 && CHARPOS (startp
) > BEGV
16391 && CHARPOS (startp
) > BEG
+ beg_unchanged
16392 && CHARPOS (startp
) <= Z
- end_unchanged
16393 /* Even if w->start_at_line_beg is nil, a new window may
16394 start at a line_beg, since that's how set_buffer_window
16395 sets it. So, we need to check the return value of
16396 compute_window_start_on_continuation_line. (See also
16398 && XMARKER (w
->start
)->buffer
== current_buffer
16399 && compute_window_start_on_continuation_line (w
)
16400 /* It doesn't make sense to force the window start like we
16401 do at label force_start if it is already known that point
16402 will not be fully visible in the resulting window, because
16403 doing so will move point from its correct position
16404 instead of scrolling the window to bring point into view.
16406 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16407 /* A very tall row could need more than the window height,
16408 in which case we accept that it is partially visible. */
16409 && (rtop
!= 0) == (rbot
!= 0))
16411 w
->force_start
= true;
16412 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16414 debug_method_add (w
, "recomputed window start in continuation line");
16420 debug_method_add (w
, "same window start");
16423 /* Try to redisplay starting at same place as before.
16424 If point has not moved off frame, accept the results. */
16425 if (!current_matrix_up_to_date_p
16426 /* Don't use try_window_reusing_current_matrix in this case
16427 because a window scroll function can have changed the
16429 || !NILP (Vwindow_scroll_functions
)
16430 || MINI_WINDOW_P (w
)
16431 || !(used_current_matrix_p
16432 = try_window_reusing_current_matrix (w
)))
16434 IF_DEBUG (debug_method_add (w
, "1"));
16435 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16436 /* -1 means we need to scroll.
16437 0 means we need new matrices, but fonts_changed
16438 is set in that case, so we will detect it below. */
16439 goto try_to_scroll
;
16442 if (f
->fonts_changed
)
16443 goto need_larger_matrices
;
16445 if (w
->cursor
.vpos
>= 0)
16447 if (!just_this_one_p
16448 || current_buffer
->clip_changed
16449 || BEG_UNCHANGED
< CHARPOS (startp
))
16450 /* Forget any recorded base line for line number display. */
16451 w
->base_line_number
= 0;
16453 if (!cursor_row_fully_visible_p (w
, true, false))
16455 clear_glyph_matrix (w
->desired_matrix
);
16456 last_line_misfit
= true;
16458 /* Drop through and scroll. */
16463 clear_glyph_matrix (w
->desired_matrix
);
16468 /* Redisplay the mode line. Select the buffer properly for that. */
16469 if (!update_mode_line
)
16471 update_mode_line
= true;
16472 w
->update_mode_line
= true;
16475 /* Try to scroll by specified few lines. */
16476 if ((scroll_conservatively
16477 || emacs_scroll_step
16478 || temp_scroll_step
16479 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16480 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16481 && CHARPOS (startp
) >= BEGV
16482 && CHARPOS (startp
) <= ZV
)
16484 /* The function returns -1 if new fonts were loaded, 1 if
16485 successful, 0 if not successful. */
16486 int ss
= try_scrolling (window
, just_this_one_p
,
16487 scroll_conservatively
,
16489 temp_scroll_step
, last_line_misfit
);
16492 case SCROLLING_SUCCESS
:
16495 case SCROLLING_NEED_LARGER_MATRICES
:
16496 goto need_larger_matrices
;
16498 case SCROLLING_FAILED
:
16506 /* Finally, just choose a place to start which positions point
16507 according to user preferences. */
16512 debug_method_add (w
, "recenter");
16515 /* Forget any previously recorded base line for line number display. */
16516 if (!buffer_unchanged_p
)
16517 w
->base_line_number
= 0;
16519 /* Determine the window start relative to point. */
16520 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16521 it
.current_y
= it
.last_visible_y
;
16522 if (centering_position
< 0)
16524 int window_total_lines
16525 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16527 = scroll_margin
> 0
16528 ? min (scroll_margin
, window_total_lines
/ 4)
16530 ptrdiff_t margin_pos
= CHARPOS (startp
);
16531 Lisp_Object aggressive
;
16534 /* If there is a scroll margin at the top of the window, find
16535 its character position. */
16537 /* Cannot call start_display if startp is not in the
16538 accessible region of the buffer. This can happen when we
16539 have just switched to a different buffer and/or changed
16540 its restriction. In that case, startp is initialized to
16541 the character position 1 (BEGV) because we did not yet
16542 have chance to display the buffer even once. */
16543 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16546 void *it1data
= NULL
;
16548 SAVE_IT (it1
, it
, it1data
);
16549 start_display (&it1
, w
, startp
);
16550 move_it_vertically (&it1
, margin
* frame_line_height
);
16551 margin_pos
= IT_CHARPOS (it1
);
16552 RESTORE_IT (&it
, &it
, it1data
);
16554 scrolling_up
= PT
> margin_pos
;
16557 ? BVAR (current_buffer
, scroll_up_aggressively
)
16558 : BVAR (current_buffer
, scroll_down_aggressively
);
16560 if (!MINI_WINDOW_P (w
)
16561 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16565 /* Setting scroll-conservatively overrides
16566 scroll-*-aggressively. */
16567 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16569 double float_amount
= XFLOATINT (aggressive
);
16571 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16572 if (pt_offset
== 0 && float_amount
> 0)
16574 if (pt_offset
&& margin
> 0)
16577 /* Compute how much to move the window start backward from
16578 point so that point will be displayed where the user
16582 centering_position
= it
.last_visible_y
;
16584 centering_position
-= pt_offset
;
16585 centering_position
-=
16586 (frame_line_height
* (1 + margin
+ last_line_misfit
)
16587 + WINDOW_HEADER_LINE_HEIGHT (w
));
16588 /* Don't let point enter the scroll margin near top of
16590 if (centering_position
< margin
* frame_line_height
)
16591 centering_position
= margin
* frame_line_height
;
16594 centering_position
= margin
* frame_line_height
+ pt_offset
;
16597 /* Set the window start half the height of the window backward
16599 centering_position
= window_box_height (w
) / 2;
16601 move_it_vertically_backward (&it
, centering_position
);
16603 eassert (IT_CHARPOS (it
) >= BEGV
);
16605 /* The function move_it_vertically_backward may move over more
16606 than the specified y-distance. If it->w is small, e.g. a
16607 mini-buffer window, we may end up in front of the window's
16608 display area. Start displaying at the start of the line
16609 containing PT in this case. */
16610 if (it
.current_y
<= 0)
16612 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16613 move_it_vertically_backward (&it
, 0);
16617 it
.current_x
= it
.hpos
= 0;
16619 /* Set the window start position here explicitly, to avoid an
16620 infinite loop in case the functions in window-scroll-functions
16622 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16624 /* Run scroll hooks. */
16625 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16627 /* Redisplay the window. */
16628 if (!current_matrix_up_to_date_p
16629 || windows_or_buffers_changed
16630 || f
->cursor_type_changed
16631 /* Don't use try_window_reusing_current_matrix in this case
16632 because it can have changed the buffer. */
16633 || !NILP (Vwindow_scroll_functions
)
16634 || !just_this_one_p
16635 || MINI_WINDOW_P (w
)
16636 || !(used_current_matrix_p
16637 = try_window_reusing_current_matrix (w
)))
16638 try_window (window
, startp
, 0);
16640 /* If new fonts have been loaded (due to fontsets), give up. We
16641 have to start a new redisplay since we need to re-adjust glyph
16643 if (f
->fonts_changed
)
16644 goto need_larger_matrices
;
16646 /* If cursor did not appear assume that the middle of the window is
16647 in the first line of the window. Do it again with the next line.
16648 (Imagine a window of height 100, displaying two lines of height
16649 60. Moving back 50 from it->last_visible_y will end in the first
16651 if (w
->cursor
.vpos
< 0)
16653 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16655 clear_glyph_matrix (w
->desired_matrix
);
16656 move_it_by_lines (&it
, 1);
16657 try_window (window
, it
.current
.pos
, 0);
16659 else if (PT
< IT_CHARPOS (it
))
16661 clear_glyph_matrix (w
->desired_matrix
);
16662 move_it_by_lines (&it
, -1);
16663 try_window (window
, it
.current
.pos
, 0);
16667 /* Not much we can do about it. */
16671 /* Consider the following case: Window starts at BEGV, there is
16672 invisible, intangible text at BEGV, so that display starts at
16673 some point START > BEGV. It can happen that we are called with
16674 PT somewhere between BEGV and START. Try to handle that case,
16675 and similar ones. */
16676 if (w
->cursor
.vpos
< 0)
16678 /* First, try locating the proper glyph row for PT. */
16679 struct glyph_row
*row
=
16680 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16682 /* Sometimes point is at the beginning of invisible text that is
16683 before the 1st character displayed in the row. In that case,
16684 row_containing_pos fails to find the row, because no glyphs
16685 with appropriate buffer positions are present in the row.
16686 Therefore, we next try to find the row which shows the 1st
16687 position after the invisible text. */
16691 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16694 if (TEXT_PROP_MEANS_INVISIBLE (val
) != 0)
16697 Lisp_Object invis_end
=
16698 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16701 if (NATNUMP (invis_end
))
16702 alt_pos
= XFASTINT (invis_end
);
16705 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16709 /* Finally, fall back on the first row of the window after the
16710 header line (if any). This is slightly better than not
16711 displaying the cursor at all. */
16714 row
= w
->current_matrix
->rows
;
16715 if (row
->mode_line_p
)
16718 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16721 if (!cursor_row_fully_visible_p (w
, false, false))
16723 /* If vscroll is enabled, disable it and try again. */
16727 clear_glyph_matrix (w
->desired_matrix
);
16731 /* Users who set scroll-conservatively to a large number want
16732 point just above/below the scroll margin. If we ended up
16733 with point's row partially visible, move the window start to
16734 make that row fully visible and out of the margin. */
16735 if (scroll_conservatively
> SCROLL_LIMIT
)
16737 int window_total_lines
16738 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16741 ? min (scroll_margin
, window_total_lines
/ 4)
16743 bool move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16745 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16746 clear_glyph_matrix (w
->desired_matrix
);
16747 if (1 == try_window (window
, it
.current
.pos
,
16748 TRY_WINDOW_CHECK_MARGINS
))
16752 /* If centering point failed to make the whole line visible,
16753 put point at the top instead. That has to make the whole line
16754 visible, if it can be done. */
16755 if (centering_position
== 0)
16758 clear_glyph_matrix (w
->desired_matrix
);
16759 centering_position
= 0;
16765 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16766 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16767 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16769 /* Display the mode line, if we must. */
16770 if ((update_mode_line
16771 /* If window not full width, must redo its mode line
16772 if (a) the window to its side is being redone and
16773 (b) we do a frame-based redisplay. This is a consequence
16774 of how inverted lines are drawn in frame-based redisplay. */
16775 || (!just_this_one_p
16776 && !FRAME_WINDOW_P (f
)
16777 && !WINDOW_FULL_WIDTH_P (w
))
16778 /* Line number to display. */
16779 || w
->base_line_pos
> 0
16780 /* Column number is displayed and different from the one displayed. */
16781 || (w
->column_number_displayed
!= -1
16782 && (w
->column_number_displayed
!= current_column ())))
16783 /* This means that the window has a mode line. */
16784 && (WINDOW_WANTS_MODELINE_P (w
)
16785 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16788 display_mode_lines (w
);
16790 /* If mode line height has changed, arrange for a thorough
16791 immediate redisplay using the correct mode line height. */
16792 if (WINDOW_WANTS_MODELINE_P (w
)
16793 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16795 f
->fonts_changed
= true;
16796 w
->mode_line_height
= -1;
16797 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16798 = DESIRED_MODE_LINE_HEIGHT (w
);
16801 /* If header line height has changed, arrange for a thorough
16802 immediate redisplay using the correct header line height. */
16803 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16804 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16806 f
->fonts_changed
= true;
16807 w
->header_line_height
= -1;
16808 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16809 = DESIRED_HEADER_LINE_HEIGHT (w
);
16812 if (f
->fonts_changed
)
16813 goto need_larger_matrices
;
16816 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16818 w
->base_line_pos
= 0;
16819 w
->base_line_number
= 0;
16824 /* When we reach a frame's selected window, redo the frame's menu bar. */
16825 if (update_mode_line
16826 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16828 bool redisplay_menu_p
;
16830 if (FRAME_WINDOW_P (f
))
16832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16833 || defined (HAVE_NS) || defined (USE_GTK)
16834 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16836 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16840 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16842 if (redisplay_menu_p
)
16843 display_menu_bar (w
);
16845 #ifdef HAVE_WINDOW_SYSTEM
16846 if (FRAME_WINDOW_P (f
))
16848 #if defined (USE_GTK) || defined (HAVE_NS)
16849 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16850 redisplay_tool_bar (f
);
16852 if (WINDOWP (f
->tool_bar_window
)
16853 && (FRAME_TOOL_BAR_LINES (f
) > 0
16854 || !NILP (Vauto_resize_tool_bars
))
16855 && redisplay_tool_bar (f
))
16856 ignore_mouse_drag_p
= true;
16862 #ifdef HAVE_WINDOW_SYSTEM
16863 if (FRAME_WINDOW_P (f
)
16864 && update_window_fringes (w
, (just_this_one_p
16865 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16866 || w
->pseudo_window_p
)))
16870 if (draw_window_fringes (w
, true))
16872 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16873 x_draw_right_divider (w
);
16875 x_draw_vertical_border (w
);
16881 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16882 x_draw_bottom_divider (w
);
16883 #endif /* HAVE_WINDOW_SYSTEM */
16885 /* We go to this label, with fonts_changed set, if it is
16886 necessary to try again using larger glyph matrices.
16887 We have to redeem the scroll bar even in this case,
16888 because the loop in redisplay_internal expects that. */
16889 need_larger_matrices
:
16891 finish_scroll_bars
:
16893 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16895 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16896 /* Set the thumb's position and size. */
16897 set_vertical_scroll_bar (w
);
16899 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16900 /* Set the thumb's position and size. */
16901 set_horizontal_scroll_bar (w
);
16903 /* Note that we actually used the scroll bar attached to this
16904 window, so it shouldn't be deleted at the end of redisplay. */
16905 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16906 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16909 /* Restore current_buffer and value of point in it. The window
16910 update may have changed the buffer, so first make sure `opoint'
16911 is still valid (Bug#6177). */
16912 if (CHARPOS (opoint
) < BEGV
)
16913 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16914 else if (CHARPOS (opoint
) > ZV
)
16915 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16917 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16919 set_buffer_internal_1 (old
);
16920 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16921 shorter. This can be caused by log truncation in *Messages*. */
16922 if (CHARPOS (lpoint
) <= ZV
)
16923 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16925 unbind_to (count
, Qnil
);
16929 /* Build the complete desired matrix of WINDOW with a window start
16930 buffer position POS.
16932 Value is 1 if successful. It is zero if fonts were loaded during
16933 redisplay which makes re-adjusting glyph matrices necessary, and -1
16934 if point would appear in the scroll margins.
16935 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16936 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16940 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16942 struct window
*w
= XWINDOW (window
);
16944 struct glyph_row
*last_text_row
= NULL
;
16945 struct frame
*f
= XFRAME (w
->frame
);
16946 int frame_line_height
= default_line_pixel_height (w
);
16948 /* Make POS the new window start. */
16949 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16951 /* Mark cursor position as unknown. No overlay arrow seen. */
16952 w
->cursor
.vpos
= -1;
16953 overlay_arrow_seen
= false;
16955 /* Initialize iterator and info to start at POS. */
16956 start_display (&it
, w
, pos
);
16957 it
.glyph_row
->reversed_p
= false;
16959 /* Display all lines of W. */
16960 while (it
.current_y
< it
.last_visible_y
)
16962 if (display_line (&it
))
16963 last_text_row
= it
.glyph_row
- 1;
16964 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16968 /* Don't let the cursor end in the scroll margins. */
16969 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16970 && !MINI_WINDOW_P (w
))
16972 int this_scroll_margin
;
16973 int window_total_lines
16974 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16976 if (scroll_margin
> 0)
16978 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16979 this_scroll_margin
*= frame_line_height
;
16982 this_scroll_margin
= 0;
16984 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16985 && w
->cursor
.y
< this_scroll_margin
16986 && CHARPOS (pos
) > BEGV
16987 && IT_CHARPOS (it
) < ZV
)
16988 /* rms: considering make_cursor_line_fully_visible_p here
16989 seems to give wrong results. We don't want to recenter
16990 when the last line is partly visible, we want to allow
16991 that case to be handled in the usual way. */
16992 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16994 w
->cursor
.vpos
= -1;
16995 clear_glyph_matrix (w
->desired_matrix
);
17000 /* If bottom moved off end of frame, change mode line percentage. */
17001 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17002 w
->update_mode_line
= true;
17004 /* Set window_end_pos to the offset of the last character displayed
17005 on the window from the end of current_buffer. Set
17006 window_end_vpos to its row number. */
17009 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17010 adjust_window_ends (w
, last_text_row
, false);
17012 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17013 w
->window_end_vpos
)));
17017 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17018 w
->window_end_pos
= Z
- ZV
;
17019 w
->window_end_vpos
= 0;
17022 /* But that is not valid info until redisplay finishes. */
17023 w
->window_end_valid
= false;
17029 /************************************************************************
17030 Window redisplay reusing current matrix when buffer has not changed
17031 ************************************************************************/
17033 /* Try redisplay of window W showing an unchanged buffer with a
17034 different window start than the last time it was displayed by
17035 reusing its current matrix. Value is true if successful.
17036 W->start is the new window start. */
17039 try_window_reusing_current_matrix (struct window
*w
)
17041 struct frame
*f
= XFRAME (w
->frame
);
17042 struct glyph_row
*bottom_row
;
17045 struct text_pos start
, new_start
;
17046 int nrows_scrolled
, i
;
17047 struct glyph_row
*last_text_row
;
17048 struct glyph_row
*last_reused_text_row
;
17049 struct glyph_row
*start_row
;
17050 int start_vpos
, min_y
, max_y
;
17053 if (inhibit_try_window_reusing
)
17057 if (/* This function doesn't handle terminal frames. */
17058 !FRAME_WINDOW_P (f
)
17059 /* Don't try to reuse the display if windows have been split
17061 || windows_or_buffers_changed
17062 || f
->cursor_type_changed
)
17065 /* Can't do this if showing trailing whitespace. */
17066 if (!NILP (Vshow_trailing_whitespace
))
17069 /* If top-line visibility has changed, give up. */
17070 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17071 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17074 /* Give up if old or new display is scrolled vertically. We could
17075 make this function handle this, but right now it doesn't. */
17076 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17077 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17080 /* The variable new_start now holds the new window start. The old
17081 start `start' can be determined from the current matrix. */
17082 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17083 start
= start_row
->minpos
;
17084 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17086 /* Clear the desired matrix for the display below. */
17087 clear_glyph_matrix (w
->desired_matrix
);
17089 if (CHARPOS (new_start
) <= CHARPOS (start
))
17091 /* Don't use this method if the display starts with an ellipsis
17092 displayed for invisible text. It's not easy to handle that case
17093 below, and it's certainly not worth the effort since this is
17094 not a frequent case. */
17095 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17098 IF_DEBUG (debug_method_add (w
, "twu1"));
17100 /* Display up to a row that can be reused. The variable
17101 last_text_row is set to the last row displayed that displays
17102 text. Note that it.vpos == 0 if or if not there is a
17103 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17104 start_display (&it
, w
, new_start
);
17105 w
->cursor
.vpos
= -1;
17106 last_text_row
= last_reused_text_row
= NULL
;
17108 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17110 /* If we have reached into the characters in the START row,
17111 that means the line boundaries have changed. So we
17112 can't start copying with the row START. Maybe it will
17113 work to start copying with the following row. */
17114 while (IT_CHARPOS (it
) > CHARPOS (start
))
17116 /* Advance to the next row as the "start". */
17118 start
= start_row
->minpos
;
17119 /* If there are no more rows to try, or just one, give up. */
17120 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17121 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17122 || CHARPOS (start
) == ZV
)
17124 clear_glyph_matrix (w
->desired_matrix
);
17128 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17130 /* If we have reached alignment, we can copy the rest of the
17132 if (IT_CHARPOS (it
) == CHARPOS (start
)
17133 /* Don't accept "alignment" inside a display vector,
17134 since start_row could have started in the middle of
17135 that same display vector (thus their character
17136 positions match), and we have no way of telling if
17137 that is the case. */
17138 && it
.current
.dpvec_index
< 0)
17141 it
.glyph_row
->reversed_p
= false;
17142 if (display_line (&it
))
17143 last_text_row
= it
.glyph_row
- 1;
17147 /* A value of current_y < last_visible_y means that we stopped
17148 at the previous window start, which in turn means that we
17149 have at least one reusable row. */
17150 if (it
.current_y
< it
.last_visible_y
)
17152 struct glyph_row
*row
;
17154 /* IT.vpos always starts from 0; it counts text lines. */
17155 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17157 /* Find PT if not already found in the lines displayed. */
17158 if (w
->cursor
.vpos
< 0)
17160 int dy
= it
.current_y
- start_row
->y
;
17162 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17163 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17165 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17166 dy
, nrows_scrolled
);
17169 clear_glyph_matrix (w
->desired_matrix
);
17174 /* Scroll the display. Do it before the current matrix is
17175 changed. The problem here is that update has not yet
17176 run, i.e. part of the current matrix is not up to date.
17177 scroll_run_hook will clear the cursor, and use the
17178 current matrix to get the height of the row the cursor is
17180 run
.current_y
= start_row
->y
;
17181 run
.desired_y
= it
.current_y
;
17182 run
.height
= it
.last_visible_y
- it
.current_y
;
17184 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17187 FRAME_RIF (f
)->update_window_begin_hook (w
);
17188 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17189 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17190 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17194 /* Shift current matrix down by nrows_scrolled lines. */
17195 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17196 rotate_matrix (w
->current_matrix
,
17198 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17201 /* Disable lines that must be updated. */
17202 for (i
= 0; i
< nrows_scrolled
; ++i
)
17203 (start_row
+ i
)->enabled_p
= false;
17205 /* Re-compute Y positions. */
17206 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17207 max_y
= it
.last_visible_y
;
17208 for (row
= start_row
+ nrows_scrolled
;
17212 row
->y
= it
.current_y
;
17213 row
->visible_height
= row
->height
;
17215 if (row
->y
< min_y
)
17216 row
->visible_height
-= min_y
- row
->y
;
17217 if (row
->y
+ row
->height
> max_y
)
17218 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17219 if (row
->fringe_bitmap_periodic_p
)
17220 row
->redraw_fringe_bitmaps_p
= true;
17222 it
.current_y
+= row
->height
;
17224 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17225 last_reused_text_row
= row
;
17226 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17230 /* Disable lines in the current matrix which are now
17231 below the window. */
17232 for (++row
; row
< bottom_row
; ++row
)
17233 row
->enabled_p
= row
->mode_line_p
= false;
17236 /* Update window_end_pos etc.; last_reused_text_row is the last
17237 reused row from the current matrix containing text, if any.
17238 The value of last_text_row is the last displayed line
17239 containing text. */
17240 if (last_reused_text_row
)
17241 adjust_window_ends (w
, last_reused_text_row
, true);
17242 else if (last_text_row
)
17243 adjust_window_ends (w
, last_text_row
, false);
17246 /* This window must be completely empty. */
17247 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17248 w
->window_end_pos
= Z
- ZV
;
17249 w
->window_end_vpos
= 0;
17251 w
->window_end_valid
= false;
17253 /* Update hint: don't try scrolling again in update_window. */
17254 w
->desired_matrix
->no_scrolling_p
= true;
17257 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17261 else if (CHARPOS (new_start
) > CHARPOS (start
))
17263 struct glyph_row
*pt_row
, *row
;
17264 struct glyph_row
*first_reusable_row
;
17265 struct glyph_row
*first_row_to_display
;
17267 int yb
= window_text_bottom_y (w
);
17269 /* Find the row starting at new_start, if there is one. Don't
17270 reuse a partially visible line at the end. */
17271 first_reusable_row
= start_row
;
17272 while (first_reusable_row
->enabled_p
17273 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17274 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17275 < CHARPOS (new_start
)))
17276 ++first_reusable_row
;
17278 /* Give up if there is no row to reuse. */
17279 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17280 || !first_reusable_row
->enabled_p
17281 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17282 != CHARPOS (new_start
)))
17285 /* We can reuse fully visible rows beginning with
17286 first_reusable_row to the end of the window. Set
17287 first_row_to_display to the first row that cannot be reused.
17288 Set pt_row to the row containing point, if there is any. */
17290 for (first_row_to_display
= first_reusable_row
;
17291 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17292 ++first_row_to_display
)
17294 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17295 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17296 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17297 && first_row_to_display
->ends_at_zv_p
17298 && pt_row
== NULL
)))
17299 pt_row
= first_row_to_display
;
17302 /* Start displaying at the start of first_row_to_display. */
17303 eassert (first_row_to_display
->y
< yb
);
17304 init_to_row_start (&it
, w
, first_row_to_display
);
17306 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17308 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17310 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17311 + WINDOW_HEADER_LINE_HEIGHT (w
));
17313 /* Display lines beginning with first_row_to_display in the
17314 desired matrix. Set last_text_row to the last row displayed
17315 that displays text. */
17316 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17317 if (pt_row
== NULL
)
17318 w
->cursor
.vpos
= -1;
17319 last_text_row
= NULL
;
17320 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17321 if (display_line (&it
))
17322 last_text_row
= it
.glyph_row
- 1;
17324 /* If point is in a reused row, adjust y and vpos of the cursor
17328 w
->cursor
.vpos
-= nrows_scrolled
;
17329 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17332 /* Give up if point isn't in a row displayed or reused. (This
17333 also handles the case where w->cursor.vpos < nrows_scrolled
17334 after the calls to display_line, which can happen with scroll
17335 margins. See bug#1295.) */
17336 if (w
->cursor
.vpos
< 0)
17338 clear_glyph_matrix (w
->desired_matrix
);
17342 /* Scroll the display. */
17343 run
.current_y
= first_reusable_row
->y
;
17344 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17345 run
.height
= it
.last_visible_y
- run
.current_y
;
17346 dy
= run
.current_y
- run
.desired_y
;
17351 FRAME_RIF (f
)->update_window_begin_hook (w
);
17352 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17353 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17354 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
17358 /* Adjust Y positions of reused rows. */
17359 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17360 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17361 max_y
= it
.last_visible_y
;
17362 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17365 row
->visible_height
= row
->height
;
17366 if (row
->y
< min_y
)
17367 row
->visible_height
-= min_y
- row
->y
;
17368 if (row
->y
+ row
->height
> max_y
)
17369 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17370 if (row
->fringe_bitmap_periodic_p
)
17371 row
->redraw_fringe_bitmaps_p
= true;
17374 /* Scroll the current matrix. */
17375 eassert (nrows_scrolled
> 0);
17376 rotate_matrix (w
->current_matrix
,
17378 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17381 /* Disable rows not reused. */
17382 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17383 row
->enabled_p
= false;
17385 /* Point may have moved to a different line, so we cannot assume that
17386 the previous cursor position is valid; locate the correct row. */
17389 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17391 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17392 && !row
->ends_at_zv_p
;
17396 w
->cursor
.y
= row
->y
;
17398 if (row
< bottom_row
)
17400 /* Can't simply scan the row for point with
17401 bidi-reordered glyph rows. Let set_cursor_from_row
17402 figure out where to put the cursor, and if it fails,
17404 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17406 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17409 clear_glyph_matrix (w
->desired_matrix
);
17415 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17416 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17419 && (!BUFFERP (glyph
->object
)
17420 || glyph
->charpos
< PT
);
17424 w
->cursor
.x
+= glyph
->pixel_width
;
17430 /* Adjust window end. A null value of last_text_row means that
17431 the window end is in reused rows which in turn means that
17432 only its vpos can have changed. */
17434 adjust_window_ends (w
, last_text_row
, false);
17436 w
->window_end_vpos
-= nrows_scrolled
;
17438 w
->window_end_valid
= false;
17439 w
->desired_matrix
->no_scrolling_p
= true;
17442 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17452 /************************************************************************
17453 Window redisplay reusing current matrix when buffer has changed
17454 ************************************************************************/
17456 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17457 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17458 ptrdiff_t *, ptrdiff_t *);
17459 static struct glyph_row
*
17460 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17461 struct glyph_row
*);
17464 /* Return the last row in MATRIX displaying text. If row START is
17465 non-null, start searching with that row. IT gives the dimensions
17466 of the display. Value is null if matrix is empty; otherwise it is
17467 a pointer to the row found. */
17469 static struct glyph_row
*
17470 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17471 struct glyph_row
*start
)
17473 struct glyph_row
*row
, *row_found
;
17475 /* Set row_found to the last row in IT->w's current matrix
17476 displaying text. The loop looks funny but think of partially
17479 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17480 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17482 eassert (row
->enabled_p
);
17484 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17493 /* Return the last row in the current matrix of W that is not affected
17494 by changes at the start of current_buffer that occurred since W's
17495 current matrix was built. Value is null if no such row exists.
17497 BEG_UNCHANGED us the number of characters unchanged at the start of
17498 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17499 first changed character in current_buffer. Characters at positions <
17500 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17501 when the current matrix was built. */
17503 static struct glyph_row
*
17504 find_last_unchanged_at_beg_row (struct window
*w
)
17506 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17507 struct glyph_row
*row
;
17508 struct glyph_row
*row_found
= NULL
;
17509 int yb
= window_text_bottom_y (w
);
17511 /* Find the last row displaying unchanged text. */
17512 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17513 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17514 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17517 if (/* If row ends before first_changed_pos, it is unchanged,
17518 except in some case. */
17519 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17520 /* When row ends in ZV and we write at ZV it is not
17522 && !row
->ends_at_zv_p
17523 /* When first_changed_pos is the end of a continued line,
17524 row is not unchanged because it may be no longer
17526 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17527 && (row
->continued_p
17528 || row
->exact_window_width_line_p
))
17529 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17530 needs to be recomputed, so don't consider this row as
17531 unchanged. This happens when the last line was
17532 bidi-reordered and was killed immediately before this
17533 redisplay cycle. In that case, ROW->end stores the
17534 buffer position of the first visual-order character of
17535 the killed text, which is now beyond ZV. */
17536 && CHARPOS (row
->end
.pos
) <= ZV
)
17539 /* Stop if last visible row. */
17540 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17548 /* Find the first glyph row in the current matrix of W that is not
17549 affected by changes at the end of current_buffer since the
17550 time W's current matrix was built.
17552 Return in *DELTA the number of chars by which buffer positions in
17553 unchanged text at the end of current_buffer must be adjusted.
17555 Return in *DELTA_BYTES the corresponding number of bytes.
17557 Value is null if no such row exists, i.e. all rows are affected by
17560 static struct glyph_row
*
17561 find_first_unchanged_at_end_row (struct window
*w
,
17562 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17564 struct glyph_row
*row
;
17565 struct glyph_row
*row_found
= NULL
;
17567 *delta
= *delta_bytes
= 0;
17569 /* Display must not have been paused, otherwise the current matrix
17570 is not up to date. */
17571 eassert (w
->window_end_valid
);
17573 /* A value of window_end_pos >= END_UNCHANGED means that the window
17574 end is in the range of changed text. If so, there is no
17575 unchanged row at the end of W's current matrix. */
17576 if (w
->window_end_pos
>= END_UNCHANGED
)
17579 /* Set row to the last row in W's current matrix displaying text. */
17580 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17582 /* If matrix is entirely empty, no unchanged row exists. */
17583 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17585 /* The value of row is the last glyph row in the matrix having a
17586 meaningful buffer position in it. The end position of row
17587 corresponds to window_end_pos. This allows us to translate
17588 buffer positions in the current matrix to current buffer
17589 positions for characters not in changed text. */
17591 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17592 ptrdiff_t Z_BYTE_old
=
17593 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17594 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17595 struct glyph_row
*first_text_row
17596 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17598 *delta
= Z
- Z_old
;
17599 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17601 /* Set last_unchanged_pos to the buffer position of the last
17602 character in the buffer that has not been changed. Z is the
17603 index + 1 of the last character in current_buffer, i.e. by
17604 subtracting END_UNCHANGED we get the index of the last
17605 unchanged character, and we have to add BEG to get its buffer
17607 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17608 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17610 /* Search backward from ROW for a row displaying a line that
17611 starts at a minimum position >= last_unchanged_pos_old. */
17612 for (; row
> first_text_row
; --row
)
17614 /* This used to abort, but it can happen.
17615 It is ok to just stop the search instead here. KFS. */
17616 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17619 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17624 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17630 /* Make sure that glyph rows in the current matrix of window W
17631 reference the same glyph memory as corresponding rows in the
17632 frame's frame matrix. This function is called after scrolling W's
17633 current matrix on a terminal frame in try_window_id and
17634 try_window_reusing_current_matrix. */
17637 sync_frame_with_window_matrix_rows (struct window
*w
)
17639 struct frame
*f
= XFRAME (w
->frame
);
17640 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17642 /* Preconditions: W must be a leaf window and full-width. Its frame
17643 must have a frame matrix. */
17644 eassert (BUFFERP (w
->contents
));
17645 eassert (WINDOW_FULL_WIDTH_P (w
));
17646 eassert (!FRAME_WINDOW_P (f
));
17648 /* If W is a full-width window, glyph pointers in W's current matrix
17649 have, by definition, to be the same as glyph pointers in the
17650 corresponding frame matrix. Note that frame matrices have no
17651 marginal areas (see build_frame_matrix). */
17652 window_row
= w
->current_matrix
->rows
;
17653 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17654 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17655 while (window_row
< window_row_end
)
17657 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17658 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17660 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17661 frame_row
->glyphs
[TEXT_AREA
] = start
;
17662 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17663 frame_row
->glyphs
[LAST_AREA
] = end
;
17665 /* Disable frame rows whose corresponding window rows have
17666 been disabled in try_window_id. */
17667 if (!window_row
->enabled_p
)
17668 frame_row
->enabled_p
= false;
17670 ++window_row
, ++frame_row
;
17675 /* Find the glyph row in window W containing CHARPOS. Consider all
17676 rows between START and END (not inclusive). END null means search
17677 all rows to the end of the display area of W. Value is the row
17678 containing CHARPOS or null. */
17681 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17682 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17684 struct glyph_row
*row
= start
;
17685 struct glyph_row
*best_row
= NULL
;
17686 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17689 /* If we happen to start on a header-line, skip that. */
17690 if (row
->mode_line_p
)
17693 if ((end
&& row
>= end
) || !row
->enabled_p
)
17696 last_y
= window_text_bottom_y (w
) - dy
;
17700 /* Give up if we have gone too far. */
17701 if (end
&& row
>= end
)
17703 /* This formerly returned if they were equal.
17704 I think that both quantities are of a "last plus one" type;
17705 if so, when they are equal, the row is within the screen. -- rms. */
17706 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17709 /* If it is in this row, return this row. */
17710 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17711 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17712 /* The end position of a row equals the start
17713 position of the next row. If CHARPOS is there, we
17714 would rather consider it displayed in the next
17715 line, except when this line ends in ZV. */
17716 && !row_for_charpos_p (row
, charpos
)))
17717 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17721 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17722 || (!best_row
&& !row
->continued_p
))
17724 /* In bidi-reordered rows, there could be several rows whose
17725 edges surround CHARPOS, all of these rows belonging to
17726 the same continued line. We need to find the row which
17727 fits CHARPOS the best. */
17728 for (g
= row
->glyphs
[TEXT_AREA
];
17729 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17732 if (!STRINGP (g
->object
))
17734 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17736 mindif
= eabs (g
->charpos
- charpos
);
17738 /* Exact match always wins. */
17745 else if (best_row
&& !row
->continued_p
)
17752 /* Try to redisplay window W by reusing its existing display. W's
17753 current matrix must be up to date when this function is called,
17754 i.e., window_end_valid must be true.
17758 >= 1 if successful, i.e. display has been updated
17760 1 means the changes were in front of a newline that precedes
17761 the window start, and the whole current matrix was reused
17762 2 means the changes were after the last position displayed
17763 in the window, and the whole current matrix was reused
17764 3 means portions of the current matrix were reused, while
17765 some of the screen lines were redrawn
17766 -1 if redisplay with same window start is known not to succeed
17767 0 if otherwise unsuccessful
17769 The following steps are performed:
17771 1. Find the last row in the current matrix of W that is not
17772 affected by changes at the start of current_buffer. If no such row
17775 2. Find the first row in W's current matrix that is not affected by
17776 changes at the end of current_buffer. Maybe there is no such row.
17778 3. Display lines beginning with the row + 1 found in step 1 to the
17779 row found in step 2 or, if step 2 didn't find a row, to the end of
17782 4. If cursor is not known to appear on the window, give up.
17784 5. If display stopped at the row found in step 2, scroll the
17785 display and current matrix as needed.
17787 6. Maybe display some lines at the end of W, if we must. This can
17788 happen under various circumstances, like a partially visible line
17789 becoming fully visible, or because newly displayed lines are displayed
17790 in smaller font sizes.
17792 7. Update W's window end information. */
17795 try_window_id (struct window
*w
)
17797 struct frame
*f
= XFRAME (w
->frame
);
17798 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17799 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17800 struct glyph_row
*last_unchanged_at_beg_row
;
17801 struct glyph_row
*first_unchanged_at_end_row
;
17802 struct glyph_row
*row
;
17803 struct glyph_row
*bottom_row
;
17806 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17808 struct text_pos start_pos
;
17810 int first_unchanged_at_end_vpos
= 0;
17811 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17812 struct text_pos start
;
17813 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17816 if (inhibit_try_window_id
)
17820 /* This is handy for debugging. */
17822 #define GIVE_UP(X) \
17824 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
17828 #define GIVE_UP(X) return 0
17831 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17833 /* Don't use this for mini-windows because these can show
17834 messages and mini-buffers, and we don't handle that here. */
17835 if (MINI_WINDOW_P (w
))
17838 /* This flag is used to prevent redisplay optimizations. */
17839 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17842 /* This function's optimizations cannot be used if overlays have
17843 changed in the buffer displayed by the window, so give up if they
17845 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17848 /* Verify that narrowing has not changed.
17849 Also verify that we were not told to prevent redisplay optimizations.
17850 It would be nice to further
17851 reduce the number of cases where this prevents try_window_id. */
17852 if (current_buffer
->clip_changed
17853 || current_buffer
->prevent_redisplay_optimizations_p
)
17856 /* Window must either use window-based redisplay or be full width. */
17857 if (!FRAME_WINDOW_P (f
)
17858 && (!FRAME_LINE_INS_DEL_OK (f
)
17859 || !WINDOW_FULL_WIDTH_P (w
)))
17862 /* Give up if point is known NOT to appear in W. */
17863 if (PT
< CHARPOS (start
))
17866 /* Another way to prevent redisplay optimizations. */
17867 if (w
->last_modified
== 0)
17870 /* Verify that window is not hscrolled. */
17871 if (w
->hscroll
!= 0)
17874 /* Verify that display wasn't paused. */
17875 if (!w
->window_end_valid
)
17878 /* Likewise if highlighting trailing whitespace. */
17879 if (!NILP (Vshow_trailing_whitespace
))
17882 /* Can't use this if overlay arrow position and/or string have
17884 if (overlay_arrows_changed_p ())
17887 /* When word-wrap is on, adding a space to the first word of a
17888 wrapped line can change the wrap position, altering the line
17889 above it. It might be worthwhile to handle this more
17890 intelligently, but for now just redisplay from scratch. */
17891 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17894 /* Under bidi reordering, adding or deleting a character in the
17895 beginning of a paragraph, before the first strong directional
17896 character, can change the base direction of the paragraph (unless
17897 the buffer specifies a fixed paragraph direction), which will
17898 require to redisplay the whole paragraph. It might be worthwhile
17899 to find the paragraph limits and widen the range of redisplayed
17900 lines to that, but for now just give up this optimization and
17901 redisplay from scratch. */
17902 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17903 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17906 /* Give up if the buffer has line-spacing set, as Lisp-level changes
17907 to that variable require thorough redisplay. */
17908 if (!NILP (BVAR (XBUFFER (w
->contents
), extra_line_spacing
)))
17911 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17912 only if buffer has really changed. The reason is that the gap is
17913 initially at Z for freshly visited files. The code below would
17914 set end_unchanged to 0 in that case. */
17915 if (MODIFF
> SAVE_MODIFF
17916 /* This seems to happen sometimes after saving a buffer. */
17917 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17919 if (GPT
- BEG
< BEG_UNCHANGED
)
17920 BEG_UNCHANGED
= GPT
- BEG
;
17921 if (Z
- GPT
< END_UNCHANGED
)
17922 END_UNCHANGED
= Z
- GPT
;
17925 /* The position of the first and last character that has been changed. */
17926 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17927 last_changed_charpos
= Z
- END_UNCHANGED
;
17929 /* If window starts after a line end, and the last change is in
17930 front of that newline, then changes don't affect the display.
17931 This case happens with stealth-fontification. Note that although
17932 the display is unchanged, glyph positions in the matrix have to
17933 be adjusted, of course. */
17934 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17935 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17936 && ((last_changed_charpos
< CHARPOS (start
)
17937 && CHARPOS (start
) == BEGV
)
17938 || (last_changed_charpos
< CHARPOS (start
) - 1
17939 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17941 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17942 struct glyph_row
*r0
;
17944 /* Compute how many chars/bytes have been added to or removed
17945 from the buffer. */
17946 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17947 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17948 Z_delta
= Z
- Z_old
;
17949 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17951 /* Give up if PT is not in the window. Note that it already has
17952 been checked at the start of try_window_id that PT is not in
17953 front of the window start. */
17954 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17957 /* If window start is unchanged, we can reuse the whole matrix
17958 as is, after adjusting glyph positions. No need to compute
17959 the window end again, since its offset from Z hasn't changed. */
17960 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17961 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17962 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17963 /* PT must not be in a partially visible line. */
17964 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17965 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17967 /* Adjust positions in the glyph matrix. */
17968 if (Z_delta
|| Z_delta_bytes
)
17970 struct glyph_row
*r1
17971 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17972 increment_matrix_positions (w
->current_matrix
,
17973 MATRIX_ROW_VPOS (r0
, current_matrix
),
17974 MATRIX_ROW_VPOS (r1
, current_matrix
),
17975 Z_delta
, Z_delta_bytes
);
17978 /* Set the cursor. */
17979 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17981 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17986 /* Handle the case that changes are all below what is displayed in
17987 the window, and that PT is in the window. This shortcut cannot
17988 be taken if ZV is visible in the window, and text has been added
17989 there that is visible in the window. */
17990 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17991 /* ZV is not visible in the window, or there are no
17992 changes at ZV, actually. */
17993 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17994 || first_changed_charpos
== last_changed_charpos
))
17996 struct glyph_row
*r0
;
17998 /* Give up if PT is not in the window. Note that it already has
17999 been checked at the start of try_window_id that PT is not in
18000 front of the window start. */
18001 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18004 /* If window start is unchanged, we can reuse the whole matrix
18005 as is, without changing glyph positions since no text has
18006 been added/removed in front of the window end. */
18007 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18008 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18009 /* PT must not be in a partially visible line. */
18010 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18011 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18013 /* We have to compute the window end anew since text
18014 could have been added/removed after it. */
18015 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18016 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18018 /* Set the cursor. */
18019 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18021 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18026 /* Give up if window start is in the changed area.
18028 The condition used to read
18030 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18032 but why that was tested escapes me at the moment. */
18033 if (CHARPOS (start
) >= first_changed_charpos
18034 && CHARPOS (start
) <= last_changed_charpos
)
18037 /* Check that window start agrees with the start of the first glyph
18038 row in its current matrix. Check this after we know the window
18039 start is not in changed text, otherwise positions would not be
18041 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18042 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18045 /* Give up if the window ends in strings. Overlay strings
18046 at the end are difficult to handle, so don't try. */
18047 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18048 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18051 /* Compute the position at which we have to start displaying new
18052 lines. Some of the lines at the top of the window might be
18053 reusable because they are not displaying changed text. Find the
18054 last row in W's current matrix not affected by changes at the
18055 start of current_buffer. Value is null if changes start in the
18056 first line of window. */
18057 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18058 if (last_unchanged_at_beg_row
)
18060 /* Avoid starting to display in the middle of a character, a TAB
18061 for instance. This is easier than to set up the iterator
18062 exactly, and it's not a frequent case, so the additional
18063 effort wouldn't really pay off. */
18064 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18065 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18066 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18067 --last_unchanged_at_beg_row
;
18069 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18072 if (! init_to_row_end (&it
, w
, last_unchanged_at_beg_row
))
18074 start_pos
= it
.current
.pos
;
18076 /* Start displaying new lines in the desired matrix at the same
18077 vpos we would use in the current matrix, i.e. below
18078 last_unchanged_at_beg_row. */
18079 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18081 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18082 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18084 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18088 /* There are no reusable lines at the start of the window.
18089 Start displaying in the first text line. */
18090 start_display (&it
, w
, start
);
18091 it
.vpos
= it
.first_vpos
;
18092 start_pos
= it
.current
.pos
;
18095 /* Find the first row that is not affected by changes at the end of
18096 the buffer. Value will be null if there is no unchanged row, in
18097 which case we must redisplay to the end of the window. delta
18098 will be set to the value by which buffer positions beginning with
18099 first_unchanged_at_end_row have to be adjusted due to text
18101 first_unchanged_at_end_row
18102 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18103 IF_DEBUG (debug_delta
= delta
);
18104 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18106 /* Set stop_pos to the buffer position up to which we will have to
18107 display new lines. If first_unchanged_at_end_row != NULL, this
18108 is the buffer position of the start of the line displayed in that
18109 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18110 that we don't stop at a buffer position. */
18112 if (first_unchanged_at_end_row
)
18114 eassert (last_unchanged_at_beg_row
== NULL
18115 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18117 /* If this is a continuation line, move forward to the next one
18118 that isn't. Changes in lines above affect this line.
18119 Caution: this may move first_unchanged_at_end_row to a row
18120 not displaying text. */
18121 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18122 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18123 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18124 < it
.last_visible_y
))
18125 ++first_unchanged_at_end_row
;
18127 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18128 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18129 >= it
.last_visible_y
))
18130 first_unchanged_at_end_row
= NULL
;
18133 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18135 first_unchanged_at_end_vpos
18136 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18137 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18140 else if (last_unchanged_at_beg_row
== NULL
)
18146 /* Either there is no unchanged row at the end, or the one we have
18147 now displays text. This is a necessary condition for the window
18148 end pos calculation at the end of this function. */
18149 eassert (first_unchanged_at_end_row
== NULL
18150 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18152 debug_last_unchanged_at_beg_vpos
18153 = (last_unchanged_at_beg_row
18154 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18156 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18158 #endif /* GLYPH_DEBUG */
18161 /* Display new lines. Set last_text_row to the last new line
18162 displayed which has text on it, i.e. might end up as being the
18163 line where the window_end_vpos is. */
18164 w
->cursor
.vpos
= -1;
18165 last_text_row
= NULL
;
18166 overlay_arrow_seen
= false;
18167 if (it
.current_y
< it
.last_visible_y
18168 && !f
->fonts_changed
18169 && (first_unchanged_at_end_row
== NULL
18170 || IT_CHARPOS (it
) < stop_pos
))
18171 it
.glyph_row
->reversed_p
= false;
18172 while (it
.current_y
< it
.last_visible_y
18173 && !f
->fonts_changed
18174 && (first_unchanged_at_end_row
== NULL
18175 || IT_CHARPOS (it
) < stop_pos
))
18177 if (display_line (&it
))
18178 last_text_row
= it
.glyph_row
- 1;
18181 if (f
->fonts_changed
)
18184 /* The redisplay iterations in display_line above could have
18185 triggered font-lock, which could have done something that
18186 invalidates IT->w window's end-point information, on which we
18187 rely below. E.g., one package, which will remain unnamed, used
18188 to install a font-lock-fontify-region-function that called
18189 bury-buffer, whose side effect is to switch the buffer displayed
18190 by IT->w, and that predictably resets IT->w's window_end_valid
18191 flag, which we already tested at the entry to this function.
18192 Amply punish such packages/modes by giving up on this
18193 optimization in those cases. */
18194 if (!w
->window_end_valid
)
18196 clear_glyph_matrix (w
->desired_matrix
);
18200 /* Compute differences in buffer positions, y-positions etc. for
18201 lines reused at the bottom of the window. Compute what we can
18203 if (first_unchanged_at_end_row
18204 /* No lines reused because we displayed everything up to the
18205 bottom of the window. */
18206 && it
.current_y
< it
.last_visible_y
)
18209 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18211 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18212 run
.current_y
= first_unchanged_at_end_row
->y
;
18213 run
.desired_y
= run
.current_y
+ dy
;
18214 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18218 delta
= delta_bytes
= dvpos
= dy
18219 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18220 first_unchanged_at_end_row
= NULL
;
18222 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18225 /* Find the cursor if not already found. We have to decide whether
18226 PT will appear on this window (it sometimes doesn't, but this is
18227 not a very frequent case.) This decision has to be made before
18228 the current matrix is altered. A value of cursor.vpos < 0 means
18229 that PT is either in one of the lines beginning at
18230 first_unchanged_at_end_row or below the window. Don't care for
18231 lines that might be displayed later at the window end; as
18232 mentioned, this is not a frequent case. */
18233 if (w
->cursor
.vpos
< 0)
18235 /* Cursor in unchanged rows at the top? */
18236 if (PT
< CHARPOS (start_pos
)
18237 && last_unchanged_at_beg_row
)
18239 row
= row_containing_pos (w
, PT
,
18240 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18241 last_unchanged_at_beg_row
+ 1, 0);
18243 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18246 /* Start from first_unchanged_at_end_row looking for PT. */
18247 else if (first_unchanged_at_end_row
)
18249 row
= row_containing_pos (w
, PT
- delta
,
18250 first_unchanged_at_end_row
, NULL
, 0);
18252 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18253 delta_bytes
, dy
, dvpos
);
18256 /* Give up if cursor was not found. */
18257 if (w
->cursor
.vpos
< 0)
18259 clear_glyph_matrix (w
->desired_matrix
);
18264 /* Don't let the cursor end in the scroll margins. */
18266 int this_scroll_margin
, cursor_height
;
18267 int frame_line_height
= default_line_pixel_height (w
);
18268 int window_total_lines
18269 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18271 this_scroll_margin
=
18272 max (0, min (scroll_margin
, window_total_lines
/ 4));
18273 this_scroll_margin
*= frame_line_height
;
18274 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18276 if ((w
->cursor
.y
< this_scroll_margin
18277 && CHARPOS (start
) > BEGV
)
18278 /* Old redisplay didn't take scroll margin into account at the bottom,
18279 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18280 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18281 ? cursor_height
+ this_scroll_margin
18282 : 1)) > it
.last_visible_y
)
18284 w
->cursor
.vpos
= -1;
18285 clear_glyph_matrix (w
->desired_matrix
);
18290 /* Scroll the display. Do it before changing the current matrix so
18291 that xterm.c doesn't get confused about where the cursor glyph is
18293 if (dy
&& run
.height
)
18297 if (FRAME_WINDOW_P (f
))
18299 FRAME_RIF (f
)->update_window_begin_hook (w
);
18300 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18301 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18302 FRAME_RIF (f
)->update_window_end_hook (w
, false, false);
18306 /* Terminal frame. In this case, dvpos gives the number of
18307 lines to scroll by; dvpos < 0 means scroll up. */
18309 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18310 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18311 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18312 + WINDOW_WANTS_HEADER_LINE_P (w
)
18313 + window_internal_height (w
));
18315 #if defined (HAVE_GPM) || defined (MSDOS)
18316 x_clear_window_mouse_face (w
);
18318 /* Perform the operation on the screen. */
18321 /* Scroll last_unchanged_at_beg_row to the end of the
18322 window down dvpos lines. */
18323 set_terminal_window (f
, end
);
18325 /* On dumb terminals delete dvpos lines at the end
18326 before inserting dvpos empty lines. */
18327 if (!FRAME_SCROLL_REGION_OK (f
))
18328 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18330 /* Insert dvpos empty lines in front of
18331 last_unchanged_at_beg_row. */
18332 ins_del_lines (f
, from
, dvpos
);
18334 else if (dvpos
< 0)
18336 /* Scroll up last_unchanged_at_beg_vpos to the end of
18337 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18338 set_terminal_window (f
, end
);
18340 /* Delete dvpos lines in front of
18341 last_unchanged_at_beg_vpos. ins_del_lines will set
18342 the cursor to the given vpos and emit |dvpos| delete
18344 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18346 /* On a dumb terminal insert dvpos empty lines at the
18348 if (!FRAME_SCROLL_REGION_OK (f
))
18349 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18352 set_terminal_window (f
, 0);
18358 /* Shift reused rows of the current matrix to the right position.
18359 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18361 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18362 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18365 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18366 bottom_vpos
, dvpos
);
18367 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18370 else if (dvpos
> 0)
18372 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18373 bottom_vpos
, dvpos
);
18374 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18375 first_unchanged_at_end_vpos
+ dvpos
);
18378 /* For frame-based redisplay, make sure that current frame and window
18379 matrix are in sync with respect to glyph memory. */
18380 if (!FRAME_WINDOW_P (f
))
18381 sync_frame_with_window_matrix_rows (w
);
18383 /* Adjust buffer positions in reused rows. */
18384 if (delta
|| delta_bytes
)
18385 increment_matrix_positions (current_matrix
,
18386 first_unchanged_at_end_vpos
+ dvpos
,
18387 bottom_vpos
, delta
, delta_bytes
);
18389 /* Adjust Y positions. */
18391 shift_glyph_matrix (w
, current_matrix
,
18392 first_unchanged_at_end_vpos
+ dvpos
,
18395 if (first_unchanged_at_end_row
)
18397 first_unchanged_at_end_row
+= dvpos
;
18398 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18399 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18400 first_unchanged_at_end_row
= NULL
;
18403 /* If scrolling up, there may be some lines to display at the end of
18405 last_text_row_at_end
= NULL
;
18408 /* Scrolling up can leave for example a partially visible line
18409 at the end of the window to be redisplayed. */
18410 /* Set last_row to the glyph row in the current matrix where the
18411 window end line is found. It has been moved up or down in
18412 the matrix by dvpos. */
18413 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18414 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18416 /* If last_row is the window end line, it should display text. */
18417 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18419 /* If window end line was partially visible before, begin
18420 displaying at that line. Otherwise begin displaying with the
18421 line following it. */
18422 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18424 init_to_row_start (&it
, w
, last_row
);
18425 it
.vpos
= last_vpos
;
18426 it
.current_y
= last_row
->y
;
18430 init_to_row_end (&it
, w
, last_row
);
18431 it
.vpos
= 1 + last_vpos
;
18432 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18436 /* We may start in a continuation line. If so, we have to
18437 get the right continuation_lines_width and current_x. */
18438 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18439 it
.hpos
= it
.current_x
= 0;
18441 /* Display the rest of the lines at the window end. */
18442 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18443 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18445 /* Is it always sure that the display agrees with lines in
18446 the current matrix? I don't think so, so we mark rows
18447 displayed invalid in the current matrix by setting their
18448 enabled_p flag to false. */
18449 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18450 if (display_line (&it
))
18451 last_text_row_at_end
= it
.glyph_row
- 1;
18455 /* Update window_end_pos and window_end_vpos. */
18456 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18458 /* Window end line if one of the preserved rows from the current
18459 matrix. Set row to the last row displaying text in current
18460 matrix starting at first_unchanged_at_end_row, after
18462 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18463 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18464 first_unchanged_at_end_row
);
18465 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18466 adjust_window_ends (w
, row
, true);
18467 eassert (w
->window_end_bytepos
>= 0);
18468 IF_DEBUG (debug_method_add (w
, "A"));
18470 else if (last_text_row_at_end
)
18472 adjust_window_ends (w
, last_text_row_at_end
, false);
18473 eassert (w
->window_end_bytepos
>= 0);
18474 IF_DEBUG (debug_method_add (w
, "B"));
18476 else if (last_text_row
)
18478 /* We have displayed either to the end of the window or at the
18479 end of the window, i.e. the last row with text is to be found
18480 in the desired matrix. */
18481 adjust_window_ends (w
, last_text_row
, false);
18482 eassert (w
->window_end_bytepos
>= 0);
18484 else if (first_unchanged_at_end_row
== NULL
18485 && last_text_row
== NULL
18486 && last_text_row_at_end
== NULL
)
18488 /* Displayed to end of window, but no line containing text was
18489 displayed. Lines were deleted at the end of the window. */
18490 bool first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
);
18491 int vpos
= w
->window_end_vpos
;
18492 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18493 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18496 row
== NULL
&& vpos
>= first_vpos
;
18497 --vpos
, --current_row
, --desired_row
)
18499 if (desired_row
->enabled_p
)
18501 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18504 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18508 eassert (row
!= NULL
);
18509 w
->window_end_vpos
= vpos
+ 1;
18510 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18512 eassert (w
->window_end_bytepos
>= 0);
18513 IF_DEBUG (debug_method_add (w
, "C"));
18518 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18519 debug_end_vpos
= w
->window_end_vpos
));
18521 /* Record that display has not been completed. */
18522 w
->window_end_valid
= false;
18523 w
->desired_matrix
->no_scrolling_p
= true;
18531 /***********************************************************************
18532 More debugging support
18533 ***********************************************************************/
18537 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18538 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18539 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18542 /* Dump the contents of glyph matrix MATRIX on stderr.
18544 GLYPHS 0 means don't show glyph contents.
18545 GLYPHS 1 means show glyphs in short form
18546 GLYPHS > 1 means show glyphs in long form. */
18549 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18552 for (i
= 0; i
< matrix
->nrows
; ++i
)
18553 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18557 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18558 the glyph row and area where the glyph comes from. */
18561 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18563 if (glyph
->type
== CHAR_GLYPH
18564 || glyph
->type
== GLYPHLESS_GLYPH
)
18567 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18568 glyph
- row
->glyphs
[TEXT_AREA
],
18569 (glyph
->type
== CHAR_GLYPH
18573 (BUFFERP (glyph
->object
)
18575 : (STRINGP (glyph
->object
)
18577 : (NILP (glyph
->object
)
18580 glyph
->pixel_width
,
18582 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18586 glyph
->left_box_line_p
,
18587 glyph
->right_box_line_p
);
18589 else if (glyph
->type
== STRETCH_GLYPH
)
18592 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18593 glyph
- row
->glyphs
[TEXT_AREA
],
18596 (BUFFERP (glyph
->object
)
18598 : (STRINGP (glyph
->object
)
18600 : (NILP (glyph
->object
)
18603 glyph
->pixel_width
,
18607 glyph
->left_box_line_p
,
18608 glyph
->right_box_line_p
);
18610 else if (glyph
->type
== IMAGE_GLYPH
)
18613 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18614 glyph
- row
->glyphs
[TEXT_AREA
],
18617 (BUFFERP (glyph
->object
)
18619 : (STRINGP (glyph
->object
)
18621 : (NILP (glyph
->object
)
18624 glyph
->pixel_width
,
18628 glyph
->left_box_line_p
,
18629 glyph
->right_box_line_p
);
18631 else if (glyph
->type
== COMPOSITE_GLYPH
)
18634 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18635 glyph
- row
->glyphs
[TEXT_AREA
],
18638 (BUFFERP (glyph
->object
)
18640 : (STRINGP (glyph
->object
)
18642 : (NILP (glyph
->object
)
18645 glyph
->pixel_width
,
18647 if (glyph
->u
.cmp
.automatic
)
18650 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18651 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18653 glyph
->left_box_line_p
,
18654 glyph
->right_box_line_p
);
18659 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18660 GLYPHS 0 means don't show glyph contents.
18661 GLYPHS 1 means show glyphs in short form
18662 GLYPHS > 1 means show glyphs in long form. */
18665 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18669 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18670 fprintf (stderr
, "==============================================================================\n");
18672 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18673 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18675 MATRIX_ROW_START_CHARPOS (row
),
18676 MATRIX_ROW_END_CHARPOS (row
),
18677 row
->used
[TEXT_AREA
],
18678 row
->contains_overlapping_glyphs_p
,
18680 row
->truncated_on_left_p
,
18681 row
->truncated_on_right_p
,
18683 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18684 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18687 row
->ends_in_middle_of_char_p
,
18688 row
->starts_in_middle_of_char_p
,
18694 row
->visible_height
,
18697 /* The next 3 lines should align to "Start" in the header. */
18698 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18699 row
->end
.overlay_string_index
,
18700 row
->continuation_lines_width
);
18701 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18702 CHARPOS (row
->start
.string_pos
),
18703 CHARPOS (row
->end
.string_pos
));
18704 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18705 row
->end
.dpvec_index
);
18712 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18714 struct glyph
*glyph
= row
->glyphs
[area
];
18715 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18717 /* Glyph for a line end in text. */
18718 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18721 if (glyph
< glyph_end
)
18722 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18724 for (; glyph
< glyph_end
; ++glyph
)
18725 dump_glyph (row
, glyph
, area
);
18728 else if (glyphs
== 1)
18731 char s
[SHRT_MAX
+ 4];
18733 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18737 for (i
= 0; i
< row
->used
[area
]; ++i
)
18739 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18740 if (i
== row
->used
[area
] - 1
18741 && area
== TEXT_AREA
18742 && NILP (glyph
->object
)
18743 && glyph
->type
== CHAR_GLYPH
18744 && glyph
->u
.ch
== ' ')
18746 strcpy (&s
[i
], "[\\n]");
18749 else if (glyph
->type
== CHAR_GLYPH
18750 && glyph
->u
.ch
< 0x80
18751 && glyph
->u
.ch
>= ' ')
18752 s
[i
] = glyph
->u
.ch
;
18758 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18764 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18765 Sdump_glyph_matrix
, 0, 1, "p",
18766 doc
: /* Dump the current matrix of the selected window to stderr.
18767 Shows contents of glyph row structures. With non-nil
18768 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18769 glyphs in short form, otherwise show glyphs in long form.
18771 Interactively, no argument means show glyphs in short form;
18772 with numeric argument, its value is passed as the GLYPHS flag. */)
18773 (Lisp_Object glyphs
)
18775 struct window
*w
= XWINDOW (selected_window
);
18776 struct buffer
*buffer
= XBUFFER (w
->contents
);
18778 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18779 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18780 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18781 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18782 fprintf (stderr
, "=============================================\n");
18783 dump_glyph_matrix (w
->current_matrix
,
18784 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18789 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18790 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* Dump the current glyph matrix of the selected frame to stderr.
18791 Only text-mode frames have frame glyph matrices. */)
18794 struct frame
*f
= XFRAME (selected_frame
);
18796 if (f
->current_matrix
)
18797 dump_glyph_matrix (f
->current_matrix
, 1);
18799 fprintf (stderr
, "*** This frame doesn't have a frame glyph matrix ***\n");
18804 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18805 doc
: /* Dump glyph row ROW to stderr.
18806 GLYPH 0 means don't dump glyphs.
18807 GLYPH 1 means dump glyphs in short form.
18808 GLYPH > 1 or omitted means dump glyphs in long form. */)
18809 (Lisp_Object row
, Lisp_Object glyphs
)
18811 struct glyph_matrix
*matrix
;
18814 CHECK_NUMBER (row
);
18815 matrix
= XWINDOW (selected_window
)->current_matrix
;
18817 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18818 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18820 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18825 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18826 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18827 GLYPH 0 means don't dump glyphs.
18828 GLYPH 1 means dump glyphs in short form.
18829 GLYPH > 1 or omitted means dump glyphs in long form.
18831 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18833 (Lisp_Object row
, Lisp_Object glyphs
)
18835 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18836 struct frame
*sf
= SELECTED_FRAME ();
18837 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18840 CHECK_NUMBER (row
);
18842 if (vpos
>= 0 && vpos
< m
->nrows
)
18843 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18844 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18850 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18851 doc
: /* Toggle tracing of redisplay.
18852 With ARG, turn tracing on if and only if ARG is positive. */)
18856 trace_redisplay_p
= !trace_redisplay_p
;
18859 arg
= Fprefix_numeric_value (arg
);
18860 trace_redisplay_p
= XINT (arg
) > 0;
18867 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18868 doc
: /* Like `format', but print result to stderr.
18869 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18870 (ptrdiff_t nargs
, Lisp_Object
*args
)
18872 Lisp_Object s
= Fformat (nargs
, args
);
18873 fwrite (SDATA (s
), 1, SBYTES (s
), stderr
);
18877 #endif /* GLYPH_DEBUG */
18881 /***********************************************************************
18882 Building Desired Matrix Rows
18883 ***********************************************************************/
18885 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18886 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18888 static struct glyph_row
*
18889 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18891 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18892 struct buffer
*buffer
= XBUFFER (w
->contents
);
18893 struct buffer
*old
= current_buffer
;
18894 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18895 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18896 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18897 const unsigned char *p
;
18900 int n_glyphs_before
;
18902 set_buffer_temp (buffer
);
18903 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18904 scratch_glyph_row
.reversed_p
= false;
18905 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18906 SET_TEXT_POS (it
.position
, 0, 0);
18908 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18910 while (p
< arrow_end
)
18912 Lisp_Object face
, ilisp
;
18914 /* Get the next character. */
18916 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18919 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18920 if (! ASCII_CHAR_P (it
.c
))
18921 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18925 /* Get its face. */
18926 ilisp
= make_number (p
- arrow_string
);
18927 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18928 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18930 /* Compute its width, get its glyphs. */
18931 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18932 SET_TEXT_POS (it
.position
, -1, -1);
18933 PRODUCE_GLYPHS (&it
);
18935 /* If this character doesn't fit any more in the line, we have
18936 to remove some glyphs. */
18937 if (it
.current_x
> it
.last_visible_x
)
18939 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18944 set_buffer_temp (old
);
18945 return it
.glyph_row
;
18949 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18950 glyphs to insert is determined by produce_special_glyphs. */
18953 insert_left_trunc_glyphs (struct it
*it
)
18955 struct it truncate_it
;
18956 struct glyph
*from
, *end
, *to
, *toend
;
18958 eassert (!FRAME_WINDOW_P (it
->f
)
18959 || (!it
->glyph_row
->reversed_p
18960 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18961 || (it
->glyph_row
->reversed_p
18962 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18964 /* Get the truncation glyphs. */
18966 truncate_it
.current_x
= 0;
18967 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18968 truncate_it
.glyph_row
= &scratch_glyph_row
;
18969 truncate_it
.area
= TEXT_AREA
;
18970 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18971 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18972 truncate_it
.object
= Qnil
;
18973 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18975 /* Overwrite glyphs from IT with truncation glyphs. */
18976 if (!it
->glyph_row
->reversed_p
)
18978 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18980 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18981 end
= from
+ tused
;
18982 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18983 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18984 if (FRAME_WINDOW_P (it
->f
))
18986 /* On GUI frames, when variable-size fonts are displayed,
18987 the truncation glyphs may need more pixels than the row's
18988 glyphs they overwrite. We overwrite more glyphs to free
18989 enough screen real estate, and enlarge the stretch glyph
18990 on the right (see display_line), if there is one, to
18991 preserve the screen position of the truncation glyphs on
18994 struct glyph
*g
= to
;
18997 /* The first glyph could be partially visible, in which case
18998 it->glyph_row->x will be negative. But we want the left
18999 truncation glyphs to be aligned at the left margin of the
19000 window, so we override the x coordinate at which the row
19002 it
->glyph_row
->x
= 0;
19003 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19005 w
+= g
->pixel_width
;
19008 if (g
- to
- tused
> 0)
19010 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19011 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19013 used
= it
->glyph_row
->used
[TEXT_AREA
];
19014 if (it
->glyph_row
->truncated_on_right_p
19015 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19016 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19019 int extra
= w
- it
->truncation_pixel_width
;
19021 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19028 /* There may be padding glyphs left over. Overwrite them too. */
19029 if (!FRAME_WINDOW_P (it
->f
))
19031 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19033 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19040 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19044 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19046 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19047 that back to front. */
19048 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19049 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19050 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19051 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19052 if (FRAME_WINDOW_P (it
->f
))
19055 struct glyph
*g
= to
;
19057 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19059 w
+= g
->pixel_width
;
19062 if (to
- g
- tused
> 0)
19064 if (it
->glyph_row
->truncated_on_right_p
19065 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19066 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19068 int extra
= w
- it
->truncation_pixel_width
;
19070 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19074 while (from
>= end
&& to
>= toend
)
19076 if (!FRAME_WINDOW_P (it
->f
))
19078 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19081 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19082 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19083 while (from
>= end
&& to
>= toend
)
19089 /* Need to free some room before prepending additional
19091 int move_by
= from
- end
+ 1;
19092 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19093 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19095 for ( ; g
>= g0
; g
--)
19097 while (from
>= end
)
19099 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19104 /* Compute the hash code for ROW. */
19106 row_hash (struct glyph_row
*row
)
19109 unsigned hashval
= 0;
19111 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19112 for (k
= 0; k
< row
->used
[area
]; ++k
)
19113 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19114 + row
->glyphs
[area
][k
].u
.val
19115 + row
->glyphs
[area
][k
].face_id
19116 + row
->glyphs
[area
][k
].padding_p
19117 + (row
->glyphs
[area
][k
].type
<< 2));
19122 /* Compute the pixel height and width of IT->glyph_row.
19124 Most of the time, ascent and height of a display line will be equal
19125 to the max_ascent and max_height values of the display iterator
19126 structure. This is not the case if
19128 1. We hit ZV without displaying anything. In this case, max_ascent
19129 and max_height will be zero.
19131 2. We have some glyphs that don't contribute to the line height.
19132 (The glyph row flag contributes_to_line_height_p is for future
19133 pixmap extensions).
19135 The first case is easily covered by using default values because in
19136 these cases, the line height does not really matter, except that it
19137 must not be zero. */
19140 compute_line_metrics (struct it
*it
)
19142 struct glyph_row
*row
= it
->glyph_row
;
19144 if (FRAME_WINDOW_P (it
->f
))
19146 int i
, min_y
, max_y
;
19148 /* The line may consist of one space only, that was added to
19149 place the cursor on it. If so, the row's height hasn't been
19151 if (row
->height
== 0)
19153 if (it
->max_ascent
+ it
->max_descent
== 0)
19154 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19155 row
->ascent
= it
->max_ascent
;
19156 row
->height
= it
->max_ascent
+ it
->max_descent
;
19157 row
->phys_ascent
= it
->max_phys_ascent
;
19158 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19159 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19162 /* Compute the width of this line. */
19163 row
->pixel_width
= row
->x
;
19164 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19165 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19167 eassert (row
->pixel_width
>= 0);
19168 eassert (row
->ascent
>= 0 && row
->height
> 0);
19170 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19171 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19173 /* If first line's physical ascent is larger than its logical
19174 ascent, use the physical ascent, and make the row taller.
19175 This makes accented characters fully visible. */
19176 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19177 && row
->phys_ascent
> row
->ascent
)
19179 row
->height
+= row
->phys_ascent
- row
->ascent
;
19180 row
->ascent
= row
->phys_ascent
;
19183 /* Compute how much of the line is visible. */
19184 row
->visible_height
= row
->height
;
19186 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19187 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19189 if (row
->y
< min_y
)
19190 row
->visible_height
-= min_y
- row
->y
;
19191 if (row
->y
+ row
->height
> max_y
)
19192 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19196 row
->pixel_width
= row
->used
[TEXT_AREA
];
19197 if (row
->continued_p
)
19198 row
->pixel_width
-= it
->continuation_pixel_width
;
19199 else if (row
->truncated_on_right_p
)
19200 row
->pixel_width
-= it
->truncation_pixel_width
;
19201 row
->ascent
= row
->phys_ascent
= 0;
19202 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19203 row
->extra_line_spacing
= 0;
19206 /* Compute a hash code for this row. */
19207 row
->hash
= row_hash (row
);
19209 it
->max_ascent
= it
->max_descent
= 0;
19210 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19214 /* Append one space to the glyph row of iterator IT if doing a
19215 window-based redisplay. The space has the same face as
19216 IT->face_id. Value is true if a space was added.
19218 This function is called to make sure that there is always one glyph
19219 at the end of a glyph row that the cursor can be set on under
19220 window-systems. (If there weren't such a glyph we would not know
19221 how wide and tall a box cursor should be displayed).
19223 At the same time this space let's a nicely handle clearing to the
19224 end of the line if the row ends in italic text. */
19227 append_space_for_newline (struct it
*it
, bool default_face_p
)
19229 if (FRAME_WINDOW_P (it
->f
))
19231 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19233 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19234 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19236 /* Save some values that must not be changed.
19237 Must save IT->c and IT->len because otherwise
19238 ITERATOR_AT_END_P wouldn't work anymore after
19239 append_space_for_newline has been called. */
19240 enum display_element_type saved_what
= it
->what
;
19241 int saved_c
= it
->c
, saved_len
= it
->len
;
19242 int saved_char_to_display
= it
->char_to_display
;
19243 int saved_x
= it
->current_x
;
19244 int saved_face_id
= it
->face_id
;
19245 bool saved_box_end
= it
->end_of_box_run_p
;
19246 struct text_pos saved_pos
;
19247 Lisp_Object saved_object
;
19251 saved_object
= it
->object
;
19252 saved_pos
= it
->position
;
19254 it
->what
= IT_CHARACTER
;
19255 memset (&it
->position
, 0, sizeof it
->position
);
19257 it
->c
= it
->char_to_display
= ' ';
19260 /* If the default face was remapped, be sure to use the
19261 remapped face for the appended newline. */
19262 if (default_face_p
)
19263 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19264 else if (it
->face_before_selective_p
)
19265 it
->face_id
= it
->saved_face_id
;
19266 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19267 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19268 /* In R2L rows, we will prepend a stretch glyph that will
19269 have the end_of_box_run_p flag set for it, so there's no
19270 need for the appended newline glyph to have that flag
19272 if (it
->glyph_row
->reversed_p
19273 /* But if the appended newline glyph goes all the way to
19274 the end of the row, there will be no stretch glyph,
19275 so leave the box flag set. */
19276 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19277 it
->end_of_box_run_p
= false;
19279 PRODUCE_GLYPHS (it
);
19281 #ifdef HAVE_WINDOW_SYSTEM
19282 /* Make sure this space glyph has the right ascent and
19283 descent values, or else cursor at end of line will look
19284 funny, and height of empty lines will be incorrect. */
19285 g
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19286 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
19289 Lisp_Object height
, total_height
;
19290 int extra_line_spacing
= it
->extra_line_spacing
;
19291 int boff
= font
->baseline_offset
;
19293 if (font
->vertical_centering
)
19294 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
19296 it
->object
= saved_object
; /* get_it_property needs this */
19297 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
19298 /* Must do a subset of line height processing from
19299 x_produce_glyph for newline characters. */
19300 height
= get_it_property (it
, Qline_height
);
19302 && CONSP (XCDR (height
))
19303 && NILP (XCDR (XCDR (height
))))
19305 total_height
= XCAR (XCDR (height
));
19306 height
= XCAR (height
);
19309 total_height
= Qnil
;
19310 height
= calc_line_height_property (it
, height
, font
, boff
, true);
19312 if (it
->override_ascent
>= 0)
19314 it
->ascent
= it
->override_ascent
;
19315 it
->descent
= it
->override_descent
;
19316 boff
= it
->override_boff
;
19318 if (EQ (height
, Qt
))
19319 extra_line_spacing
= 0;
19322 Lisp_Object spacing
;
19324 it
->phys_ascent
= it
->ascent
;
19325 it
->phys_descent
= it
->descent
;
19327 && XINT (height
) > it
->ascent
+ it
->descent
)
19328 it
->ascent
= XINT (height
) - it
->descent
;
19330 if (!NILP (total_height
))
19331 spacing
= calc_line_height_property (it
, total_height
, font
,
19335 spacing
= get_it_property (it
, Qline_spacing
);
19336 spacing
= calc_line_height_property (it
, spacing
, font
,
19339 if (INTEGERP (spacing
))
19341 extra_line_spacing
= XINT (spacing
);
19342 if (!NILP (total_height
))
19343 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
19346 if (extra_line_spacing
> 0)
19348 it
->descent
+= extra_line_spacing
;
19349 if (extra_line_spacing
> it
->max_extra_line_spacing
)
19350 it
->max_extra_line_spacing
= extra_line_spacing
;
19352 it
->max_ascent
= it
->ascent
;
19353 it
->max_descent
= it
->descent
;
19354 /* Make sure compute_line_metrics recomputes the row height. */
19355 it
->glyph_row
->height
= 0;
19358 g
->ascent
= it
->max_ascent
;
19359 g
->descent
= it
->max_descent
;
19362 it
->override_ascent
= -1;
19363 it
->constrain_row_ascent_descent_p
= false;
19364 it
->current_x
= saved_x
;
19365 it
->object
= saved_object
;
19366 it
->position
= saved_pos
;
19367 it
->what
= saved_what
;
19368 it
->face_id
= saved_face_id
;
19369 it
->len
= saved_len
;
19371 it
->char_to_display
= saved_char_to_display
;
19372 it
->end_of_box_run_p
= saved_box_end
;
19381 /* Extend the face of the last glyph in the text area of IT->glyph_row
19382 to the end of the display line. Called from display_line. If the
19383 glyph row is empty, add a space glyph to it so that we know the
19384 face to draw. Set the glyph row flag fill_line_p. If the glyph
19385 row is R2L, prepend a stretch glyph to cover the empty space to the
19386 left of the leftmost glyph. */
19389 extend_face_to_end_of_line (struct it
*it
)
19391 struct face
*face
, *default_face
;
19392 struct frame
*f
= it
->f
;
19394 /* If line is already filled, do nothing. Non window-system frames
19395 get a grace of one more ``pixel'' because their characters are
19396 1-``pixel'' wide, so they hit the equality too early. This grace
19397 is needed only for R2L rows that are not continued, to produce
19398 one extra blank where we could display the cursor. */
19399 if ((it
->current_x
>= it
->last_visible_x
19400 + (!FRAME_WINDOW_P (f
)
19401 && it
->glyph_row
->reversed_p
19402 && !it
->glyph_row
->continued_p
))
19403 /* If the window has display margins, we will need to extend
19404 their face even if the text area is filled. */
19405 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19406 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19409 /* The default face, possibly remapped. */
19410 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19412 /* Face extension extends the background and box of IT->face_id
19413 to the end of the line. If the background equals the background
19414 of the frame, we don't have to do anything. */
19415 if (it
->face_before_selective_p
)
19416 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19418 face
= FACE_FROM_ID (f
, it
->face_id
);
19420 if (FRAME_WINDOW_P (f
)
19421 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19422 && face
->box
== FACE_NO_BOX
19423 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19424 #ifdef HAVE_WINDOW_SYSTEM
19427 && !it
->glyph_row
->reversed_p
)
19430 /* Set the glyph row flag indicating that the face of the last glyph
19431 in the text area has to be drawn to the end of the text area. */
19432 it
->glyph_row
->fill_line_p
= true;
19434 /* If current character of IT is not ASCII, make sure we have the
19435 ASCII face. This will be automatically undone the next time
19436 get_next_display_element returns a multibyte character. Note
19437 that the character will always be single byte in unibyte
19439 if (!ASCII_CHAR_P (it
->c
))
19441 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19444 if (FRAME_WINDOW_P (f
))
19446 /* If the row is empty, add a space with the current face of IT,
19447 so that we know which face to draw. */
19448 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19450 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19451 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19452 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19454 /* Mode line and the header line don't have margins, and
19455 likewise the frame's tool-bar window, if there is any. */
19456 if (!(it
->glyph_row
->mode_line_p
19457 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19458 || (WINDOWP (f
->tool_bar_window
)
19459 && it
->w
== XWINDOW (f
->tool_bar_window
))
19463 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19464 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19466 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19467 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19469 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19471 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19472 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19474 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19475 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19477 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19480 #ifdef HAVE_WINDOW_SYSTEM
19481 if (it
->glyph_row
->reversed_p
)
19483 /* Prepend a stretch glyph to the row, such that the
19484 rightmost glyph will be drawn flushed all the way to the
19485 right margin of the window. The stretch glyph that will
19486 occupy the empty space, if any, to the left of the
19488 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19489 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19490 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19492 int row_width
, stretch_ascent
, stretch_width
;
19493 struct text_pos saved_pos
;
19495 bool saved_avoid_cursor
, saved_box_start
;
19497 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19498 row_width
+= g
->pixel_width
;
19500 /* FIXME: There are various minor display glitches in R2L
19501 rows when only one of the fringes is missing. The
19502 strange condition below produces the least bad effect. */
19503 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19504 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19505 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19506 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19508 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19509 stretch_width
-= row_width
;
19511 if (stretch_width
> 0)
19514 (((it
->ascent
+ it
->descent
)
19515 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19516 saved_pos
= it
->position
;
19517 memset (&it
->position
, 0, sizeof it
->position
);
19518 saved_avoid_cursor
= it
->avoid_cursor_p
;
19519 it
->avoid_cursor_p
= true;
19520 saved_face_id
= it
->face_id
;
19521 saved_box_start
= it
->start_of_box_run_p
;
19522 /* The last row's stretch glyph should get the default
19523 face, to avoid painting the rest of the window with
19524 the region face, if the region ends at ZV. */
19525 if (it
->glyph_row
->ends_at_zv_p
)
19526 it
->face_id
= default_face
->id
;
19528 it
->face_id
= face
->id
;
19529 it
->start_of_box_run_p
= false;
19530 append_stretch_glyph (it
, Qnil
, stretch_width
,
19531 it
->ascent
+ it
->descent
, stretch_ascent
);
19532 it
->position
= saved_pos
;
19533 it
->avoid_cursor_p
= saved_avoid_cursor
;
19534 it
->face_id
= saved_face_id
;
19535 it
->start_of_box_run_p
= saved_box_start
;
19537 /* If stretch_width comes out negative, it means that the
19538 last glyph is only partially visible. In R2L rows, we
19539 want the leftmost glyph to be partially visible, so we
19540 need to give the row the corresponding left offset. */
19541 if (stretch_width
< 0)
19542 it
->glyph_row
->x
= stretch_width
;
19544 #endif /* HAVE_WINDOW_SYSTEM */
19548 /* Save some values that must not be changed. */
19549 int saved_x
= it
->current_x
;
19550 struct text_pos saved_pos
;
19551 Lisp_Object saved_object
;
19552 enum display_element_type saved_what
= it
->what
;
19553 int saved_face_id
= it
->face_id
;
19555 saved_object
= it
->object
;
19556 saved_pos
= it
->position
;
19558 it
->what
= IT_CHARACTER
;
19559 memset (&it
->position
, 0, sizeof it
->position
);
19561 it
->c
= it
->char_to_display
= ' ';
19564 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19565 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19566 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19567 && !it
->glyph_row
->mode_line_p
19568 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19570 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19571 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19573 for (it
->current_x
= 0; g
< e
; g
++)
19574 it
->current_x
+= g
->pixel_width
;
19576 it
->area
= LEFT_MARGIN_AREA
;
19577 it
->face_id
= default_face
->id
;
19578 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19579 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19581 PRODUCE_GLYPHS (it
);
19582 /* term.c:produce_glyphs advances it->current_x only for
19584 it
->current_x
+= it
->pixel_width
;
19587 it
->current_x
= saved_x
;
19588 it
->area
= TEXT_AREA
;
19591 /* The last row's blank glyphs should get the default face, to
19592 avoid painting the rest of the window with the region face,
19593 if the region ends at ZV. */
19594 if (it
->glyph_row
->ends_at_zv_p
)
19595 it
->face_id
= default_face
->id
;
19597 it
->face_id
= face
->id
;
19598 PRODUCE_GLYPHS (it
);
19600 while (it
->current_x
<= it
->last_visible_x
)
19601 PRODUCE_GLYPHS (it
);
19603 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19604 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19605 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19606 && !it
->glyph_row
->mode_line_p
19607 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19609 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19610 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19612 for ( ; g
< e
; g
++)
19613 it
->current_x
+= g
->pixel_width
;
19615 it
->area
= RIGHT_MARGIN_AREA
;
19616 it
->face_id
= default_face
->id
;
19617 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19618 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19620 PRODUCE_GLYPHS (it
);
19621 it
->current_x
+= it
->pixel_width
;
19624 it
->area
= TEXT_AREA
;
19627 /* Don't count these blanks really. It would let us insert a left
19628 truncation glyph below and make us set the cursor on them, maybe. */
19629 it
->current_x
= saved_x
;
19630 it
->object
= saved_object
;
19631 it
->position
= saved_pos
;
19632 it
->what
= saved_what
;
19633 it
->face_id
= saved_face_id
;
19638 /* Value is true if text starting at CHARPOS in current_buffer is
19639 trailing whitespace. */
19642 trailing_whitespace_p (ptrdiff_t charpos
)
19644 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19647 while (bytepos
< ZV_BYTE
19648 && (c
= FETCH_CHAR (bytepos
),
19649 c
== ' ' || c
== '\t'))
19652 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19654 if (bytepos
!= PT_BYTE
)
19661 /* Highlight trailing whitespace, if any, in ROW. */
19664 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19666 int used
= row
->used
[TEXT_AREA
];
19670 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19671 struct glyph
*glyph
= start
+ used
- 1;
19673 if (row
->reversed_p
)
19675 /* Right-to-left rows need to be processed in the opposite
19676 direction, so swap the edge pointers. */
19678 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19681 /* Skip over glyphs inserted to display the cursor at the
19682 end of a line, for extending the face of the last glyph
19683 to the end of the line on terminals, and for truncation
19684 and continuation glyphs. */
19685 if (!row
->reversed_p
)
19687 while (glyph
>= start
19688 && glyph
->type
== CHAR_GLYPH
19689 && NILP (glyph
->object
))
19694 while (glyph
<= start
19695 && glyph
->type
== CHAR_GLYPH
19696 && NILP (glyph
->object
))
19700 /* If last glyph is a space or stretch, and it's trailing
19701 whitespace, set the face of all trailing whitespace glyphs in
19702 IT->glyph_row to `trailing-whitespace'. */
19703 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19704 && BUFFERP (glyph
->object
)
19705 && (glyph
->type
== STRETCH_GLYPH
19706 || (glyph
->type
== CHAR_GLYPH
19707 && glyph
->u
.ch
== ' '))
19708 && trailing_whitespace_p (glyph
->charpos
))
19710 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, false);
19714 if (!row
->reversed_p
)
19716 while (glyph
>= start
19717 && BUFFERP (glyph
->object
)
19718 && (glyph
->type
== STRETCH_GLYPH
19719 || (glyph
->type
== CHAR_GLYPH
19720 && glyph
->u
.ch
== ' ')))
19721 (glyph
--)->face_id
= face_id
;
19725 while (glyph
<= start
19726 && BUFFERP (glyph
->object
)
19727 && (glyph
->type
== STRETCH_GLYPH
19728 || (glyph
->type
== CHAR_GLYPH
19729 && glyph
->u
.ch
== ' ')))
19730 (glyph
++)->face_id
= face_id
;
19737 /* Value is true if glyph row ROW should be
19738 considered to hold the buffer position CHARPOS. */
19741 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19743 bool result
= true;
19745 if (charpos
== CHARPOS (row
->end
.pos
)
19746 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19748 /* Suppose the row ends on a string.
19749 Unless the row is continued, that means it ends on a newline
19750 in the string. If it's anything other than a display string
19751 (e.g., a before-string from an overlay), we don't want the
19752 cursor there. (This heuristic seems to give the optimal
19753 behavior for the various types of multi-line strings.)
19754 One exception: if the string has `cursor' property on one of
19755 its characters, we _do_ want the cursor there. */
19756 if (CHARPOS (row
->end
.string_pos
) >= 0)
19758 if (row
->continued_p
)
19762 /* Check for `display' property. */
19763 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19764 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19765 struct glyph
*glyph
;
19768 for (glyph
= end
; glyph
>= beg
; --glyph
)
19769 if (STRINGP (glyph
->object
))
19772 = Fget_char_property (make_number (charpos
),
19776 && display_prop_string_p (prop
, glyph
->object
));
19777 /* If there's a `cursor' property on one of the
19778 string's characters, this row is a cursor row,
19779 even though this is not a display string. */
19782 Lisp_Object s
= glyph
->object
;
19784 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19786 ptrdiff_t gpos
= glyph
->charpos
;
19788 if (!NILP (Fget_char_property (make_number (gpos
),
19800 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19802 /* If the row ends in middle of a real character,
19803 and the line is continued, we want the cursor here.
19804 That's because CHARPOS (ROW->end.pos) would equal
19805 PT if PT is before the character. */
19806 if (!row
->ends_in_ellipsis_p
)
19807 result
= row
->continued_p
;
19809 /* If the row ends in an ellipsis, then
19810 CHARPOS (ROW->end.pos) will equal point after the
19811 invisible text. We want that position to be displayed
19812 after the ellipsis. */
19815 /* If the row ends at ZV, display the cursor at the end of that
19816 row instead of at the start of the row below. */
19818 result
= row
->ends_at_zv_p
;
19824 /* Value is true if glyph row ROW should be
19825 used to hold the cursor. */
19828 cursor_row_p (struct glyph_row
*row
)
19830 return row_for_charpos_p (row
, PT
);
19835 /* Push the property PROP so that it will be rendered at the current
19836 position in IT. Return true if PROP was successfully pushed, false
19837 otherwise. Called from handle_line_prefix to handle the
19838 `line-prefix' and `wrap-prefix' properties. */
19841 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19843 struct text_pos pos
=
19844 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19846 eassert (it
->method
== GET_FROM_BUFFER
19847 || it
->method
== GET_FROM_DISPLAY_VECTOR
19848 || it
->method
== GET_FROM_STRING
19849 || it
->method
== GET_FROM_IMAGE
);
19851 /* We need to save the current buffer/string position, so it will be
19852 restored by pop_it, because iterate_out_of_display_property
19853 depends on that being set correctly, but some situations leave
19854 it->position not yet set when this function is called. */
19855 push_it (it
, &pos
);
19857 if (STRINGP (prop
))
19859 if (SCHARS (prop
) == 0)
19866 it
->string_from_prefix_prop_p
= true;
19867 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19868 it
->current
.overlay_string_index
= -1;
19869 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19870 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19871 it
->method
= GET_FROM_STRING
;
19872 it
->stop_charpos
= 0;
19874 it
->base_level_stop
= 0;
19876 /* Force paragraph direction to be that of the parent
19878 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19879 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19881 it
->paragraph_embedding
= L2R
;
19883 /* Set up the bidi iterator for this display string. */
19886 it
->bidi_it
.string
.lstring
= it
->string
;
19887 it
->bidi_it
.string
.s
= NULL
;
19888 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19889 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19890 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19891 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19892 it
->bidi_it
.w
= it
->w
;
19893 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19896 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19898 it
->method
= GET_FROM_STRETCH
;
19901 #ifdef HAVE_WINDOW_SYSTEM
19902 else if (IMAGEP (prop
))
19904 it
->what
= IT_IMAGE
;
19905 it
->image_id
= lookup_image (it
->f
, prop
);
19906 it
->method
= GET_FROM_IMAGE
;
19908 #endif /* HAVE_WINDOW_SYSTEM */
19911 pop_it (it
); /* bogus display property, give up */
19918 /* Return the character-property PROP at the current position in IT. */
19921 get_it_property (struct it
*it
, Lisp_Object prop
)
19923 Lisp_Object position
, object
= it
->object
;
19925 if (STRINGP (object
))
19926 position
= make_number (IT_STRING_CHARPOS (*it
));
19927 else if (BUFFERP (object
))
19929 position
= make_number (IT_CHARPOS (*it
));
19930 object
= it
->window
;
19935 return Fget_char_property (position
, prop
, object
);
19938 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19941 handle_line_prefix (struct it
*it
)
19943 Lisp_Object prefix
;
19945 if (it
->continuation_lines_width
> 0)
19947 prefix
= get_it_property (it
, Qwrap_prefix
);
19949 prefix
= Vwrap_prefix
;
19953 prefix
= get_it_property (it
, Qline_prefix
);
19955 prefix
= Vline_prefix
;
19957 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19959 /* If the prefix is wider than the window, and we try to wrap
19960 it, it would acquire its own wrap prefix, and so on till the
19961 iterator stack overflows. So, don't wrap the prefix. */
19962 it
->line_wrap
= TRUNCATE
;
19963 it
->avoid_cursor_p
= true;
19969 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19970 only for R2L lines from display_line and display_string, when they
19971 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19972 the line/string needs to be continued on the next glyph row. */
19974 unproduce_glyphs (struct it
*it
, int n
)
19976 struct glyph
*glyph
, *end
;
19978 eassert (it
->glyph_row
);
19979 eassert (it
->glyph_row
->reversed_p
);
19980 eassert (it
->area
== TEXT_AREA
);
19981 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19983 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19984 n
= it
->glyph_row
->used
[TEXT_AREA
];
19985 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19986 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19987 for ( ; glyph
< end
; glyph
++)
19988 glyph
[-n
] = *glyph
;
19991 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19992 and ROW->maxpos. */
19994 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19995 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19996 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19998 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19999 lines' rows is implemented for bidi-reordered rows. */
20001 /* ROW->minpos is the value of min_pos, the minimal buffer position
20002 we have in ROW, or ROW->start.pos if that is smaller. */
20003 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
20004 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
20006 /* We didn't find buffer positions smaller than ROW->start, or
20007 didn't find _any_ valid buffer positions in any of the glyphs,
20008 so we must trust the iterator's computed positions. */
20009 row
->minpos
= row
->start
.pos
;
20012 max_pos
= CHARPOS (it
->current
.pos
);
20013 max_bpos
= BYTEPOS (it
->current
.pos
);
20016 /* Here are the various use-cases for ending the row, and the
20017 corresponding values for ROW->maxpos:
20019 Line ends in a newline from buffer eol_pos + 1
20020 Line is continued from buffer max_pos + 1
20021 Line is truncated on right it->current.pos
20022 Line ends in a newline from string max_pos + 1(*)
20023 (*) + 1 only when line ends in a forward scan
20024 Line is continued from string max_pos
20025 Line is continued from display vector max_pos
20026 Line is entirely from a string min_pos == max_pos
20027 Line is entirely from a display vector min_pos == max_pos
20028 Line that ends at ZV ZV
20030 If you discover other use-cases, please add them here as
20032 if (row
->ends_at_zv_p
)
20033 row
->maxpos
= it
->current
.pos
;
20034 else if (row
->used
[TEXT_AREA
])
20036 bool seen_this_string
= false;
20037 struct glyph_row
*r1
= row
- 1;
20039 /* Did we see the same display string on the previous row? */
20040 if (STRINGP (it
->object
)
20041 /* this is not the first row */
20042 && row
> it
->w
->desired_matrix
->rows
20043 /* previous row is not the header line */
20044 && !r1
->mode_line_p
20045 /* previous row also ends in a newline from a string */
20046 && r1
->ends_in_newline_from_string_p
)
20048 struct glyph
*start
, *end
;
20050 /* Search for the last glyph of the previous row that came
20051 from buffer or string. Depending on whether the row is
20052 L2R or R2L, we need to process it front to back or the
20053 other way round. */
20054 if (!r1
->reversed_p
)
20056 start
= r1
->glyphs
[TEXT_AREA
];
20057 end
= start
+ r1
->used
[TEXT_AREA
];
20058 /* Glyphs inserted by redisplay have nil as their object. */
20060 && NILP ((end
- 1)->object
)
20061 && (end
- 1)->charpos
<= 0)
20065 if (EQ ((end
- 1)->object
, it
->object
))
20066 seen_this_string
= true;
20069 /* If all the glyphs of the previous row were inserted
20070 by redisplay, it means the previous row was
20071 produced from a single newline, which is only
20072 possible if that newline came from the same string
20073 as the one which produced this ROW. */
20074 seen_this_string
= true;
20078 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20079 start
= end
+ r1
->used
[TEXT_AREA
];
20081 && NILP ((end
+ 1)->object
)
20082 && (end
+ 1)->charpos
<= 0)
20086 if (EQ ((end
+ 1)->object
, it
->object
))
20087 seen_this_string
= true;
20090 seen_this_string
= true;
20093 /* Take note of each display string that covers a newline only
20094 once, the first time we see it. This is for when a display
20095 string includes more than one newline in it. */
20096 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20098 /* If we were scanning the buffer forward when we displayed
20099 the string, we want to account for at least one buffer
20100 position that belongs to this row (position covered by
20101 the display string), so that cursor positioning will
20102 consider this row as a candidate when point is at the end
20103 of the visual line represented by this row. This is not
20104 required when scanning back, because max_pos will already
20105 have a much larger value. */
20106 if (CHARPOS (row
->end
.pos
) > max_pos
)
20107 INC_BOTH (max_pos
, max_bpos
);
20108 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20110 else if (CHARPOS (it
->eol_pos
) > 0)
20111 SET_TEXT_POS (row
->maxpos
,
20112 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20113 else if (row
->continued_p
)
20115 /* If max_pos is different from IT's current position, it
20116 means IT->method does not belong to the display element
20117 at max_pos. However, it also means that the display
20118 element at max_pos was displayed in its entirety on this
20119 line, which is equivalent to saying that the next line
20120 starts at the next buffer position. */
20121 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20122 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20125 INC_BOTH (max_pos
, max_bpos
);
20126 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20129 else if (row
->truncated_on_right_p
)
20130 /* display_line already called reseat_at_next_visible_line_start,
20131 which puts the iterator at the beginning of the next line, in
20132 the logical order. */
20133 row
->maxpos
= it
->current
.pos
;
20134 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20135 /* A line that is entirely from a string/image/stretch... */
20136 row
->maxpos
= row
->minpos
;
20141 row
->maxpos
= it
->current
.pos
;
20144 /* Construct the glyph row IT->glyph_row in the desired matrix of
20145 IT->w from text at the current position of IT. See dispextern.h
20146 for an overview of struct it. Value is true if
20147 IT->glyph_row displays text, as opposed to a line displaying ZV
20151 display_line (struct it
*it
)
20153 struct glyph_row
*row
= it
->glyph_row
;
20154 Lisp_Object overlay_arrow_string
;
20156 void *wrap_data
= NULL
;
20157 bool may_wrap
= false;
20158 int wrap_x
IF_LINT (= 0);
20159 int wrap_row_used
= -1;
20160 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20161 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20162 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20163 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20164 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20166 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20167 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20168 bool pending_handle_line_prefix
= false;
20170 /* We always start displaying at hpos zero even if hscrolled. */
20171 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20173 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20174 >= it
->w
->desired_matrix
->nrows
)
20176 it
->w
->nrows_scale_factor
++;
20177 it
->f
->fonts_changed
= true;
20181 /* Clear the result glyph row and enable it. */
20182 prepare_desired_row (it
->w
, row
, false);
20184 row
->y
= it
->current_y
;
20185 row
->start
= it
->start
;
20186 row
->continuation_lines_width
= it
->continuation_lines_width
;
20187 row
->displays_text_p
= true;
20188 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20189 it
->starts_in_middle_of_char_p
= false;
20191 /* Arrange the overlays nicely for our purposes. Usually, we call
20192 display_line on only one line at a time, in which case this
20193 can't really hurt too much, or we call it on lines which appear
20194 one after another in the buffer, in which case all calls to
20195 recenter_overlay_lists but the first will be pretty cheap. */
20196 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20198 /* Move over display elements that are not visible because we are
20199 hscrolled. This may stop at an x-position < IT->first_visible_x
20200 if the first glyph is partially visible or if we hit a line end. */
20201 if (it
->current_x
< it
->first_visible_x
)
20203 enum move_it_result move_result
;
20205 this_line_min_pos
= row
->start
.pos
;
20206 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20207 MOVE_TO_POS
| MOVE_TO_X
);
20208 /* If we are under a large hscroll, move_it_in_display_line_to
20209 could hit the end of the line without reaching
20210 it->first_visible_x. Pretend that we did reach it. This is
20211 especially important on a TTY, where we will call
20212 extend_face_to_end_of_line, which needs to know how many
20213 blank glyphs to produce. */
20214 if (it
->current_x
< it
->first_visible_x
20215 && (move_result
== MOVE_NEWLINE_OR_CR
20216 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20217 it
->current_x
= it
->first_visible_x
;
20219 /* Record the smallest positions seen while we moved over
20220 display elements that are not visible. This is needed by
20221 redisplay_internal for optimizing the case where the cursor
20222 stays inside the same line. The rest of this function only
20223 considers positions that are actually displayed, so
20224 RECORD_MAX_MIN_POS will not otherwise record positions that
20225 are hscrolled to the left of the left edge of the window. */
20226 min_pos
= CHARPOS (this_line_min_pos
);
20227 min_bpos
= BYTEPOS (this_line_min_pos
);
20229 else if (it
->area
== TEXT_AREA
)
20231 /* We only do this when not calling move_it_in_display_line_to
20232 above, because that function calls itself handle_line_prefix. */
20233 handle_line_prefix (it
);
20237 /* Line-prefix and wrap-prefix are always displayed in the text
20238 area. But if this is the first call to display_line after
20239 init_iterator, the iterator might have been set up to write
20240 into a marginal area, e.g. if the line begins with some
20241 display property that writes to the margins. So we need to
20242 wait with the call to handle_line_prefix until whatever
20243 writes to the margin has done its job. */
20244 pending_handle_line_prefix
= true;
20247 /* Get the initial row height. This is either the height of the
20248 text hscrolled, if there is any, or zero. */
20249 row
->ascent
= it
->max_ascent
;
20250 row
->height
= it
->max_ascent
+ it
->max_descent
;
20251 row
->phys_ascent
= it
->max_phys_ascent
;
20252 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20253 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20255 /* Utility macro to record max and min buffer positions seen until now. */
20256 #define RECORD_MAX_MIN_POS(IT) \
20259 bool composition_p \
20260 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20261 ptrdiff_t current_pos = \
20262 composition_p ? (IT)->cmp_it.charpos \
20263 : IT_CHARPOS (*(IT)); \
20264 ptrdiff_t current_bpos = \
20265 composition_p ? CHAR_TO_BYTE (current_pos) \
20266 : IT_BYTEPOS (*(IT)); \
20267 if (current_pos < min_pos) \
20269 min_pos = current_pos; \
20270 min_bpos = current_bpos; \
20272 if (IT_CHARPOS (*it) > max_pos) \
20274 max_pos = IT_CHARPOS (*it); \
20275 max_bpos = IT_BYTEPOS (*it); \
20280 /* Loop generating characters. The loop is left with IT on the next
20281 character to display. */
20284 int n_glyphs_before
, hpos_before
, x_before
;
20286 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20288 /* Retrieve the next thing to display. Value is false if end of
20290 if (!get_next_display_element (it
))
20292 /* Maybe add a space at the end of this line that is used to
20293 display the cursor there under X. Set the charpos of the
20294 first glyph of blank lines not corresponding to any text
20296 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20297 row
->exact_window_width_line_p
= true;
20298 else if ((append_space_for_newline (it
, true)
20299 && row
->used
[TEXT_AREA
] == 1)
20300 || row
->used
[TEXT_AREA
] == 0)
20302 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20303 row
->displays_text_p
= false;
20305 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20306 && (!MINI_WINDOW_P (it
->w
)
20307 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20308 row
->indicate_empty_line_p
= true;
20311 it
->continuation_lines_width
= 0;
20312 row
->ends_at_zv_p
= true;
20313 /* A row that displays right-to-left text must always have
20314 its last face extended all the way to the end of line,
20315 even if this row ends in ZV, because we still write to
20316 the screen left to right. We also need to extend the
20317 last face if the default face is remapped to some
20318 different face, otherwise the functions that clear
20319 portions of the screen will clear with the default face's
20320 background color. */
20321 if (row
->reversed_p
20322 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20323 extend_face_to_end_of_line (it
);
20327 /* Now, get the metrics of what we want to display. This also
20328 generates glyphs in `row' (which is IT->glyph_row). */
20329 n_glyphs_before
= row
->used
[TEXT_AREA
];
20332 /* Remember the line height so far in case the next element doesn't
20333 fit on the line. */
20334 if (it
->line_wrap
!= TRUNCATE
)
20336 ascent
= it
->max_ascent
;
20337 descent
= it
->max_descent
;
20338 phys_ascent
= it
->max_phys_ascent
;
20339 phys_descent
= it
->max_phys_descent
;
20341 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20343 if (IT_DISPLAYING_WHITESPACE (it
))
20347 SAVE_IT (wrap_it
, *it
, wrap_data
);
20349 wrap_row_used
= row
->used
[TEXT_AREA
];
20350 wrap_row_ascent
= row
->ascent
;
20351 wrap_row_height
= row
->height
;
20352 wrap_row_phys_ascent
= row
->phys_ascent
;
20353 wrap_row_phys_height
= row
->phys_height
;
20354 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20355 wrap_row_min_pos
= min_pos
;
20356 wrap_row_min_bpos
= min_bpos
;
20357 wrap_row_max_pos
= max_pos
;
20358 wrap_row_max_bpos
= max_bpos
;
20364 PRODUCE_GLYPHS (it
);
20366 /* If this display element was in marginal areas, continue with
20368 if (it
->area
!= TEXT_AREA
)
20370 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20371 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20372 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20373 row
->phys_height
= max (row
->phys_height
,
20374 it
->max_phys_ascent
+ it
->max_phys_descent
);
20375 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20376 it
->max_extra_line_spacing
);
20377 set_iterator_to_next (it
, true);
20378 /* If we didn't handle the line/wrap prefix above, and the
20379 call to set_iterator_to_next just switched to TEXT_AREA,
20380 process the prefix now. */
20381 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20383 pending_handle_line_prefix
= false;
20384 handle_line_prefix (it
);
20389 /* Does the display element fit on the line? If we truncate
20390 lines, we should draw past the right edge of the window. If
20391 we don't truncate, we want to stop so that we can display the
20392 continuation glyph before the right margin. If lines are
20393 continued, there are two possible strategies for characters
20394 resulting in more than 1 glyph (e.g. tabs): Display as many
20395 glyphs as possible in this line and leave the rest for the
20396 continuation line, or display the whole element in the next
20397 line. Original redisplay did the former, so we do it also. */
20398 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20399 hpos_before
= it
->hpos
;
20402 if (/* Not a newline. */
20404 /* Glyphs produced fit entirely in the line. */
20405 && it
->current_x
< it
->last_visible_x
)
20407 it
->hpos
+= nglyphs
;
20408 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20409 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20410 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20411 row
->phys_height
= max (row
->phys_height
,
20412 it
->max_phys_ascent
+ it
->max_phys_descent
);
20413 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20414 it
->max_extra_line_spacing
);
20415 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20416 /* In R2L rows, we arrange in extend_face_to_end_of_line
20417 to add a right offset to the line, by a suitable
20418 change to the stretch glyph that is the leftmost
20419 glyph of the line. */
20420 && !row
->reversed_p
)
20421 row
->x
= x
- it
->first_visible_x
;
20422 /* Record the maximum and minimum buffer positions seen so
20423 far in glyphs that will be displayed by this row. */
20425 RECORD_MAX_MIN_POS (it
);
20430 struct glyph
*glyph
;
20432 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20434 /* Identify the glyphs added by the last call to
20435 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20436 the previous glyphs. */
20437 if (!row
->reversed_p
)
20438 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20440 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20441 new_x
= x
+ glyph
->pixel_width
;
20443 if (/* Lines are continued. */
20444 it
->line_wrap
!= TRUNCATE
20445 && (/* Glyph doesn't fit on the line. */
20446 new_x
> it
->last_visible_x
20447 /* Or it fits exactly on a window system frame. */
20448 || (new_x
== it
->last_visible_x
20449 && FRAME_WINDOW_P (it
->f
)
20450 && (row
->reversed_p
20451 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20452 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20454 /* End of a continued line. */
20457 || (new_x
== it
->last_visible_x
20458 && FRAME_WINDOW_P (it
->f
)
20459 && (row
->reversed_p
20460 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20461 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20463 /* Current glyph is the only one on the line or
20464 fits exactly on the line. We must continue
20465 the line because we can't draw the cursor
20466 after the glyph. */
20467 row
->continued_p
= true;
20468 it
->current_x
= new_x
;
20469 it
->continuation_lines_width
+= new_x
;
20471 if (i
== nglyphs
- 1)
20473 /* If line-wrap is on, check if a previous
20474 wrap point was found. */
20475 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
)
20476 && wrap_row_used
> 0
20477 /* Even if there is a previous wrap
20478 point, continue the line here as
20479 usual, if (i) the previous character
20480 was a space or tab AND (ii) the
20481 current character is not. */
20483 || IT_DISPLAYING_WHITESPACE (it
)))
20486 /* Record the maximum and minimum buffer
20487 positions seen so far in glyphs that will be
20488 displayed by this row. */
20490 RECORD_MAX_MIN_POS (it
);
20491 set_iterator_to_next (it
, true);
20492 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20494 if (!get_next_display_element (it
))
20496 row
->exact_window_width_line_p
= true;
20497 it
->continuation_lines_width
= 0;
20498 row
->continued_p
= false;
20499 row
->ends_at_zv_p
= true;
20501 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20503 row
->continued_p
= false;
20504 row
->exact_window_width_line_p
= true;
20506 /* If line-wrap is on, check if a
20507 previous wrap point was found. */
20508 else if (wrap_row_used
> 0
20509 /* Even if there is a previous wrap
20510 point, continue the line here as
20511 usual, if (i) the previous character
20512 was a space or tab AND (ii) the
20513 current character is not. */
20515 || IT_DISPLAYING_WHITESPACE (it
)))
20520 else if (it
->bidi_p
)
20521 RECORD_MAX_MIN_POS (it
);
20522 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20523 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20524 extend_face_to_end_of_line (it
);
20526 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20527 && !FRAME_WINDOW_P (it
->f
))
20529 /* A padding glyph that doesn't fit on this line.
20530 This means the whole character doesn't fit
20532 if (row
->reversed_p
)
20533 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20534 - n_glyphs_before
);
20535 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20537 /* Fill the rest of the row with continuation
20538 glyphs like in 20.x. */
20539 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20540 < row
->glyphs
[1 + TEXT_AREA
])
20541 produce_special_glyphs (it
, IT_CONTINUATION
);
20543 row
->continued_p
= true;
20544 it
->current_x
= x_before
;
20545 it
->continuation_lines_width
+= x_before
;
20547 /* Restore the height to what it was before the
20548 element not fitting on the line. */
20549 it
->max_ascent
= ascent
;
20550 it
->max_descent
= descent
;
20551 it
->max_phys_ascent
= phys_ascent
;
20552 it
->max_phys_descent
= phys_descent
;
20553 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20554 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20555 extend_face_to_end_of_line (it
);
20557 else if (wrap_row_used
> 0)
20560 if (row
->reversed_p
)
20561 unproduce_glyphs (it
,
20562 row
->used
[TEXT_AREA
] - wrap_row_used
);
20563 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20564 it
->continuation_lines_width
+= wrap_x
;
20565 row
->used
[TEXT_AREA
] = wrap_row_used
;
20566 row
->ascent
= wrap_row_ascent
;
20567 row
->height
= wrap_row_height
;
20568 row
->phys_ascent
= wrap_row_phys_ascent
;
20569 row
->phys_height
= wrap_row_phys_height
;
20570 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20571 min_pos
= wrap_row_min_pos
;
20572 min_bpos
= wrap_row_min_bpos
;
20573 max_pos
= wrap_row_max_pos
;
20574 max_bpos
= wrap_row_max_bpos
;
20575 row
->continued_p
= true;
20576 row
->ends_at_zv_p
= false;
20577 row
->exact_window_width_line_p
= false;
20578 it
->continuation_lines_width
+= x
;
20580 /* Make sure that a non-default face is extended
20581 up to the right margin of the window. */
20582 extend_face_to_end_of_line (it
);
20584 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20586 /* A TAB that extends past the right edge of the
20587 window. This produces a single glyph on
20588 window system frames. We leave the glyph in
20589 this row and let it fill the row, but don't
20590 consume the TAB. */
20591 if ((row
->reversed_p
20592 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20593 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20594 produce_special_glyphs (it
, IT_CONTINUATION
);
20595 it
->continuation_lines_width
+= it
->last_visible_x
;
20596 row
->ends_in_middle_of_char_p
= true;
20597 row
->continued_p
= true;
20598 glyph
->pixel_width
= it
->last_visible_x
- x
;
20599 it
->starts_in_middle_of_char_p
= true;
20600 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20601 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20602 extend_face_to_end_of_line (it
);
20606 /* Something other than a TAB that draws past
20607 the right edge of the window. Restore
20608 positions to values before the element. */
20609 if (row
->reversed_p
)
20610 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20611 - (n_glyphs_before
+ i
));
20612 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20614 /* Display continuation glyphs. */
20615 it
->current_x
= x_before
;
20616 it
->continuation_lines_width
+= x
;
20617 if (!FRAME_WINDOW_P (it
->f
)
20618 || (row
->reversed_p
20619 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20620 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20621 produce_special_glyphs (it
, IT_CONTINUATION
);
20622 row
->continued_p
= true;
20624 extend_face_to_end_of_line (it
);
20626 if (nglyphs
> 1 && i
> 0)
20628 row
->ends_in_middle_of_char_p
= true;
20629 it
->starts_in_middle_of_char_p
= true;
20632 /* Restore the height to what it was before the
20633 element not fitting on the line. */
20634 it
->max_ascent
= ascent
;
20635 it
->max_descent
= descent
;
20636 it
->max_phys_ascent
= phys_ascent
;
20637 it
->max_phys_descent
= phys_descent
;
20642 else if (new_x
> it
->first_visible_x
)
20644 /* Increment number of glyphs actually displayed. */
20647 /* Record the maximum and minimum buffer positions
20648 seen so far in glyphs that will be displayed by
20651 RECORD_MAX_MIN_POS (it
);
20653 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20654 /* Glyph is partially visible, i.e. row starts at
20655 negative X position. Don't do that in R2L
20656 rows, where we arrange to add a right offset to
20657 the line in extend_face_to_end_of_line, by a
20658 suitable change to the stretch glyph that is
20659 the leftmost glyph of the line. */
20660 row
->x
= x
- it
->first_visible_x
;
20661 /* When the last glyph of an R2L row only fits
20662 partially on the line, we need to set row->x to a
20663 negative offset, so that the leftmost glyph is
20664 the one that is partially visible. But if we are
20665 going to produce the truncation glyph, this will
20666 be taken care of in produce_special_glyphs. */
20667 if (row
->reversed_p
20668 && new_x
> it
->last_visible_x
20669 && !(it
->line_wrap
== TRUNCATE
20670 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20672 eassert (FRAME_WINDOW_P (it
->f
));
20673 row
->x
= it
->last_visible_x
- new_x
;
20678 /* Glyph is completely off the left margin of the
20679 window. This should not happen because of the
20680 move_it_in_display_line at the start of this
20681 function, unless the text display area of the
20682 window is empty. */
20683 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20686 /* Even if this display element produced no glyphs at all,
20687 we want to record its position. */
20688 if (it
->bidi_p
&& nglyphs
== 0)
20689 RECORD_MAX_MIN_POS (it
);
20691 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20692 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20693 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20694 row
->phys_height
= max (row
->phys_height
,
20695 it
->max_phys_ascent
+ it
->max_phys_descent
);
20696 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20697 it
->max_extra_line_spacing
);
20699 /* End of this display line if row is continued. */
20700 if (row
->continued_p
|| row
->ends_at_zv_p
)
20705 /* Is this a line end? If yes, we're also done, after making
20706 sure that a non-default face is extended up to the right
20707 margin of the window. */
20708 if (ITERATOR_AT_END_OF_LINE_P (it
))
20710 int used_before
= row
->used
[TEXT_AREA
];
20712 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20714 /* Add a space at the end of the line that is used to
20715 display the cursor there. */
20716 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20717 append_space_for_newline (it
, false);
20719 /* Extend the face to the end of the line. */
20720 extend_face_to_end_of_line (it
);
20722 /* Make sure we have the position. */
20723 if (used_before
== 0)
20724 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20726 /* Record the position of the newline, for use in
20728 it
->eol_pos
= it
->current
.pos
;
20730 /* Consume the line end. This skips over invisible lines. */
20731 set_iterator_to_next (it
, true);
20732 it
->continuation_lines_width
= 0;
20736 /* Proceed with next display element. Note that this skips
20737 over lines invisible because of selective display. */
20738 set_iterator_to_next (it
, true);
20740 /* If we truncate lines, we are done when the last displayed
20741 glyphs reach past the right margin of the window. */
20742 if (it
->line_wrap
== TRUNCATE
20743 && ((FRAME_WINDOW_P (it
->f
)
20744 /* Images are preprocessed in produce_image_glyph such
20745 that they are cropped at the right edge of the
20746 window, so an image glyph will always end exactly at
20747 last_visible_x, even if there's no right fringe. */
20748 && ((row
->reversed_p
20749 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20750 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20751 || it
->what
== IT_IMAGE
))
20752 ? (it
->current_x
>= it
->last_visible_x
)
20753 : (it
->current_x
> it
->last_visible_x
)))
20755 /* Maybe add truncation glyphs. */
20756 if (!FRAME_WINDOW_P (it
->f
)
20757 || (row
->reversed_p
20758 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20759 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20763 if (!row
->reversed_p
)
20765 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20766 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20771 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20772 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20774 /* Remove any padding glyphs at the front of ROW, to
20775 make room for the truncation glyphs we will be
20776 adding below. The loop below always inserts at
20777 least one truncation glyph, so also remove the
20778 last glyph added to ROW. */
20779 unproduce_glyphs (it
, i
+ 1);
20780 /* Adjust i for the loop below. */
20781 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20784 /* produce_special_glyphs overwrites the last glyph, so
20785 we don't want that if we want to keep that last
20786 glyph, which means it's an image. */
20787 if (it
->current_x
> it
->last_visible_x
)
20789 it
->current_x
= x_before
;
20790 if (!FRAME_WINDOW_P (it
->f
))
20792 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20794 row
->used
[TEXT_AREA
] = i
;
20795 produce_special_glyphs (it
, IT_TRUNCATION
);
20800 row
->used
[TEXT_AREA
] = i
;
20801 produce_special_glyphs (it
, IT_TRUNCATION
);
20803 it
->hpos
= hpos_before
;
20806 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20808 /* Don't truncate if we can overflow newline into fringe. */
20809 if (!get_next_display_element (it
))
20811 it
->continuation_lines_width
= 0;
20812 row
->ends_at_zv_p
= true;
20813 row
->exact_window_width_line_p
= true;
20816 if (ITERATOR_AT_END_OF_LINE_P (it
))
20818 row
->exact_window_width_line_p
= true;
20819 goto at_end_of_line
;
20821 it
->current_x
= x_before
;
20822 it
->hpos
= hpos_before
;
20825 row
->truncated_on_right_p
= true;
20826 it
->continuation_lines_width
= 0;
20827 reseat_at_next_visible_line_start (it
, false);
20828 /* We insist below that IT's position be at ZV because in
20829 bidi-reordered lines the character at visible line start
20830 might not be the character that follows the newline in
20831 the logical order. */
20832 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20833 row
->ends_at_zv_p
=
20834 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20836 row
->ends_at_zv_p
= false;
20842 bidi_unshelve_cache (wrap_data
, true);
20844 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20845 at the left window margin. */
20846 if (it
->first_visible_x
20847 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20849 if (!FRAME_WINDOW_P (it
->f
)
20850 || (((row
->reversed_p
20851 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20852 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20853 /* Don't let insert_left_trunc_glyphs overwrite the
20854 first glyph of the row if it is an image. */
20855 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20856 insert_left_trunc_glyphs (it
);
20857 row
->truncated_on_left_p
= true;
20860 /* Remember the position at which this line ends.
20862 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20863 cannot be before the call to find_row_edges below, since that is
20864 where these positions are determined. */
20865 row
->end
= it
->current
;
20868 row
->minpos
= row
->start
.pos
;
20869 row
->maxpos
= row
->end
.pos
;
20873 /* ROW->minpos and ROW->maxpos must be the smallest and
20874 `1 + the largest' buffer positions in ROW. But if ROW was
20875 bidi-reordered, these two positions can be anywhere in the
20876 row, so we must determine them now. */
20877 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20880 /* If the start of this line is the overlay arrow-position, then
20881 mark this glyph row as the one containing the overlay arrow.
20882 This is clearly a mess with variable size fonts. It would be
20883 better to let it be displayed like cursors under X. */
20884 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20885 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20886 !NILP (overlay_arrow_string
)))
20888 /* Overlay arrow in window redisplay is a fringe bitmap. */
20889 if (STRINGP (overlay_arrow_string
))
20891 struct glyph_row
*arrow_row
20892 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20893 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20894 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20895 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20896 struct glyph
*p2
, *end
;
20898 /* Copy the arrow glyphs. */
20899 while (glyph
< arrow_end
)
20902 /* Throw away padding glyphs. */
20904 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20905 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20911 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20916 eassert (INTEGERP (overlay_arrow_string
));
20917 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20919 overlay_arrow_seen
= true;
20922 /* Highlight trailing whitespace. */
20923 if (!NILP (Vshow_trailing_whitespace
))
20924 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20926 /* Compute pixel dimensions of this line. */
20927 compute_line_metrics (it
);
20929 /* Implementation note: No changes in the glyphs of ROW or in their
20930 faces can be done past this point, because compute_line_metrics
20931 computes ROW's hash value and stores it within the glyph_row
20934 /* Record whether this row ends inside an ellipsis. */
20935 row
->ends_in_ellipsis_p
20936 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20937 && it
->ellipsis_p
);
20939 /* Save fringe bitmaps in this row. */
20940 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20941 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20942 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20943 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20945 it
->left_user_fringe_bitmap
= 0;
20946 it
->left_user_fringe_face_id
= 0;
20947 it
->right_user_fringe_bitmap
= 0;
20948 it
->right_user_fringe_face_id
= 0;
20950 /* Maybe set the cursor. */
20951 cvpos
= it
->w
->cursor
.vpos
;
20953 /* In bidi-reordered rows, keep checking for proper cursor
20954 position even if one has been found already, because buffer
20955 positions in such rows change non-linearly with ROW->VPOS,
20956 when a line is continued. One exception: when we are at ZV,
20957 display cursor on the first suitable glyph row, since all
20958 the empty rows after that also have their position set to ZV. */
20959 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20960 lines' rows is implemented for bidi-reordered rows. */
20962 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20963 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20964 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20965 && cursor_row_p (row
))
20966 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20968 /* Prepare for the next line. This line starts horizontally at (X
20969 HPOS) = (0 0). Vertical positions are incremented. As a
20970 convenience for the caller, IT->glyph_row is set to the next
20972 it
->current_x
= it
->hpos
= 0;
20973 it
->current_y
+= row
->height
;
20974 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20977 /* The next row should by default use the same value of the
20978 reversed_p flag as this one. set_iterator_to_next decides when
20979 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20980 the flag accordingly. */
20981 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20982 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20983 it
->start
= row
->end
;
20984 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20986 #undef RECORD_MAX_MIN_POS
20989 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20990 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20991 doc
: /* Return paragraph direction at point in BUFFER.
20992 Value is either `left-to-right' or `right-to-left'.
20993 If BUFFER is omitted or nil, it defaults to the current buffer.
20995 Paragraph direction determines how the text in the paragraph is displayed.
20996 In left-to-right paragraphs, text begins at the left margin of the window
20997 and the reading direction is generally left to right. In right-to-left
20998 paragraphs, text begins at the right margin and is read from right to left.
21000 See also `bidi-paragraph-direction'. */)
21001 (Lisp_Object buffer
)
21003 struct buffer
*buf
= current_buffer
;
21004 struct buffer
*old
= buf
;
21006 if (! NILP (buffer
))
21008 CHECK_BUFFER (buffer
);
21009 buf
= XBUFFER (buffer
);
21012 if (NILP (BVAR (buf
, bidi_display_reordering
))
21013 || NILP (BVAR (buf
, enable_multibyte_characters
))
21014 /* When we are loading loadup.el, the character property tables
21015 needed for bidi iteration are not yet available. */
21016 || !NILP (Vpurify_flag
))
21017 return Qleft_to_right
;
21018 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
21019 return BVAR (buf
, bidi_paragraph_direction
);
21022 /* Determine the direction from buffer text. We could try to
21023 use current_matrix if it is up to date, but this seems fast
21024 enough as it is. */
21025 struct bidi_it itb
;
21026 ptrdiff_t pos
= BUF_PT (buf
);
21027 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
21029 void *itb_data
= bidi_shelve_cache ();
21031 set_buffer_temp (buf
);
21032 /* bidi_paragraph_init finds the base direction of the paragraph
21033 by searching forward from paragraph start. We need the base
21034 direction of the current or _previous_ paragraph, so we need
21035 to make sure we are within that paragraph. To that end, find
21036 the previous non-empty line. */
21037 if (pos
>= ZV
&& pos
> BEGV
)
21038 DEC_BOTH (pos
, bytepos
);
21039 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
21040 if (fast_looking_at (trailing_white_space
,
21041 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
21043 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
21044 || c
== ' ' || c
== '\t' || c
== '\f')
21046 if (bytepos
<= BEGV_BYTE
)
21051 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
21054 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
21055 itb
.paragraph_dir
= NEUTRAL_DIR
;
21056 itb
.string
.s
= NULL
;
21057 itb
.string
.lstring
= Qnil
;
21058 itb
.string
.bufpos
= 0;
21059 itb
.string
.from_disp_str
= false;
21060 itb
.string
.unibyte
= false;
21061 /* We have no window to use here for ignoring window-specific
21062 overlays. Using NULL for window pointer will cause
21063 compute_display_string_pos to use the current buffer. */
21065 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, true);
21066 bidi_unshelve_cache (itb_data
, false);
21067 set_buffer_temp (old
);
21068 switch (itb
.paragraph_dir
)
21071 return Qleft_to_right
;
21074 return Qright_to_left
;
21082 DEFUN ("bidi-find-overridden-directionality",
21083 Fbidi_find_overridden_directionality
,
21084 Sbidi_find_overridden_directionality
, 2, 3, 0,
21085 doc
: /* Return position between FROM and TO where directionality was overridden.
21087 This function returns the first character position in the specified
21088 region of OBJECT where there is a character whose `bidi-class' property
21089 is `L', but which was forced to display as `R' by a directional
21090 override, and likewise with characters whose `bidi-class' is `R'
21091 or `AL' that were forced to display as `L'.
21093 If no such character is found, the function returns nil.
21095 OBJECT is a Lisp string or buffer to search for overridden
21096 directionality, and defaults to the current buffer if nil or omitted.
21097 OBJECT can also be a window, in which case the function will search
21098 the buffer displayed in that window. Passing the window instead of
21099 a buffer is preferable when the buffer is displayed in some window,
21100 because this function will then be able to correctly account for
21101 window-specific overlays, which can affect the results.
21103 Strong directional characters `L', `R', and `AL' can have their
21104 intrinsic directionality overridden by directional override
21105 control characters RLO (u+202e) and LRO (u+202d). See the
21106 function `get-char-code-property' for a way to inquire about
21107 the `bidi-class' property of a character. */)
21108 (Lisp_Object from
, Lisp_Object to
, Lisp_Object object
)
21110 struct buffer
*buf
= current_buffer
;
21111 struct buffer
*old
= buf
;
21112 struct window
*w
= NULL
;
21113 bool frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ());
21114 struct bidi_it itb
;
21115 ptrdiff_t from_pos
, to_pos
, from_bpos
;
21118 if (!NILP (object
))
21120 if (BUFFERP (object
))
21121 buf
= XBUFFER (object
);
21122 else if (WINDOWP (object
))
21124 w
= decode_live_window (object
);
21125 buf
= XBUFFER (w
->contents
);
21126 frame_window_p
= FRAME_WINDOW_P (XFRAME (w
->frame
));
21129 CHECK_STRING (object
);
21132 if (STRINGP (object
))
21134 /* Characters in unibyte strings are always treated by bidi.c as
21136 if (!STRING_MULTIBYTE (object
)
21137 /* When we are loading loadup.el, the character property
21138 tables needed for bidi iteration are not yet
21140 || !NILP (Vpurify_flag
))
21143 validate_subarray (object
, from
, to
, SCHARS (object
), &from_pos
, &to_pos
);
21144 if (from_pos
>= SCHARS (object
))
21147 /* Set up the bidi iterator. */
21148 itb_data
= bidi_shelve_cache ();
21149 itb
.paragraph_dir
= NEUTRAL_DIR
;
21150 itb
.string
.lstring
= object
;
21151 itb
.string
.s
= NULL
;
21152 itb
.string
.schars
= SCHARS (object
);
21153 itb
.string
.bufpos
= 0;
21154 itb
.string
.from_disp_str
= false;
21155 itb
.string
.unibyte
= false;
21157 bidi_init_it (0, 0, frame_window_p
, &itb
);
21161 /* Nothing this fancy can happen in unibyte buffers, or in a
21162 buffer that disabled reordering, or if FROM is at EOB. */
21163 if (NILP (BVAR (buf
, bidi_display_reordering
))
21164 || NILP (BVAR (buf
, enable_multibyte_characters
))
21165 /* When we are loading loadup.el, the character property
21166 tables needed for bidi iteration are not yet
21168 || !NILP (Vpurify_flag
))
21171 set_buffer_temp (buf
);
21172 validate_region (&from
, &to
);
21173 from_pos
= XINT (from
);
21174 to_pos
= XINT (to
);
21175 if (from_pos
>= ZV
)
21178 /* Set up the bidi iterator. */
21179 itb_data
= bidi_shelve_cache ();
21180 from_bpos
= CHAR_TO_BYTE (from_pos
);
21181 if (from_pos
== BEGV
)
21183 itb
.charpos
= BEGV
;
21184 itb
.bytepos
= BEGV_BYTE
;
21186 else if (FETCH_CHAR (from_bpos
- 1) == '\n')
21188 itb
.charpos
= from_pos
;
21189 itb
.bytepos
= from_bpos
;
21192 itb
.charpos
= find_newline_no_quit (from_pos
, CHAR_TO_BYTE (from_pos
),
21194 itb
.paragraph_dir
= NEUTRAL_DIR
;
21195 itb
.string
.s
= NULL
;
21196 itb
.string
.lstring
= Qnil
;
21197 itb
.string
.bufpos
= 0;
21198 itb
.string
.from_disp_str
= false;
21199 itb
.string
.unibyte
= false;
21201 bidi_init_it (itb
.charpos
, itb
.bytepos
, frame_window_p
, &itb
);
21206 /* For the purposes of this function, the actual base direction of
21207 the paragraph doesn't matter, so just set it to L2R. */
21208 bidi_paragraph_init (L2R
, &itb
, false);
21209 while ((found
= bidi_find_first_overridden (&itb
)) < from_pos
)
21211 } while (found
== ZV
&& itb
.ch
== '\n' && itb
.charpos
< to_pos
);
21213 bidi_unshelve_cache (itb_data
, false);
21214 set_buffer_temp (old
);
21216 return (from_pos
<= found
&& found
< to_pos
) ? make_number (found
) : Qnil
;
21219 DEFUN ("move-point-visually", Fmove_point_visually
,
21220 Smove_point_visually
, 1, 1, 0,
21221 doc
: /* Move point in the visual order in the specified DIRECTION.
21222 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21225 Value is the new character position of point. */)
21226 (Lisp_Object direction
)
21228 struct window
*w
= XWINDOW (selected_window
);
21229 struct buffer
*b
= XBUFFER (w
->contents
);
21230 struct glyph_row
*row
;
21232 Lisp_Object paragraph_dir
;
21234 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21235 (!(ROW)->continued_p \
21236 && NILP ((GLYPH)->object) \
21237 && (GLYPH)->type == CHAR_GLYPH \
21238 && (GLYPH)->u.ch == ' ' \
21239 && (GLYPH)->charpos >= 0 \
21240 && !(GLYPH)->avoid_cursor_p)
21242 CHECK_NUMBER (direction
);
21243 dir
= XINT (direction
);
21249 /* If current matrix is up-to-date, we can use the information
21250 recorded in the glyphs, at least as long as the goal is on the
21252 if (w
->window_end_valid
21253 && !windows_or_buffers_changed
21255 && !b
->clip_changed
21256 && !b
->prevent_redisplay_optimizations_p
21257 && !window_outdated (w
)
21258 /* We rely below on the cursor coordinates to be up to date, but
21259 we cannot trust them if some command moved point since the
21260 last complete redisplay. */
21261 && w
->last_point
== BUF_PT (b
)
21262 && w
->cursor
.vpos
>= 0
21263 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21264 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21266 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21267 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21268 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21270 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21272 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21274 SET_PT (g
->charpos
);
21275 w
->cursor
.vpos
= -1;
21276 return make_number (PT
);
21278 else if (!NILP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21282 if (BUFFERP (gpt
->object
))
21285 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21286 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21288 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21290 else if (BUFFERP (g
->object
))
21291 new_pos
= g
->charpos
;
21295 w
->cursor
.vpos
= -1;
21296 return make_number (PT
);
21298 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21300 /* Glyphs inserted at the end of a non-empty line for
21301 positioning the cursor have zero charpos, so we must
21302 deduce the value of point by other means. */
21303 if (g
->charpos
> 0)
21304 SET_PT (g
->charpos
);
21305 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21307 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21308 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21311 w
->cursor
.vpos
= -1;
21312 return make_number (PT
);
21315 if (g
== e
|| NILP (g
->object
))
21317 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21318 goto simulate_display
;
21319 if (!row
->reversed_p
)
21323 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21324 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21325 goto simulate_display
;
21329 if (row
->reversed_p
&& !row
->continued_p
)
21331 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21332 w
->cursor
.vpos
= -1;
21333 return make_number (PT
);
21335 g
= row
->glyphs
[TEXT_AREA
];
21336 e
= g
+ row
->used
[TEXT_AREA
];
21337 for ( ; g
< e
; g
++)
21339 if (BUFFERP (g
->object
)
21340 /* Empty lines have only one glyph, which stands
21341 for the newline, and whose charpos is the
21342 buffer position of the newline. */
21343 || ROW_GLYPH_NEWLINE_P (row
, g
)
21344 /* When the buffer ends in a newline, the line at
21345 EOB also has one glyph, but its charpos is -1. */
21346 || (row
->ends_at_zv_p
21347 && !row
->reversed_p
21348 && NILP (g
->object
)
21349 && g
->type
== CHAR_GLYPH
21350 && g
->u
.ch
== ' '))
21352 if (g
->charpos
> 0)
21353 SET_PT (g
->charpos
);
21354 else if (!row
->reversed_p
21355 && row
->ends_at_zv_p
21360 w
->cursor
.vpos
= -1;
21361 return make_number (PT
);
21367 if (!row
->reversed_p
&& !row
->continued_p
)
21369 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21370 w
->cursor
.vpos
= -1;
21371 return make_number (PT
);
21373 e
= row
->glyphs
[TEXT_AREA
];
21374 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21375 for ( ; g
>= e
; g
--)
21377 if (BUFFERP (g
->object
)
21378 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21380 /* Empty R2L lines on GUI frames have the buffer
21381 position of the newline stored in the stretch
21383 || g
->type
== STRETCH_GLYPH
21384 || (row
->ends_at_zv_p
21386 && NILP (g
->object
)
21387 && g
->type
== CHAR_GLYPH
21388 && g
->u
.ch
== ' '))
21390 if (g
->charpos
> 0)
21391 SET_PT (g
->charpos
);
21392 else if (row
->reversed_p
21393 && row
->ends_at_zv_p
21398 w
->cursor
.vpos
= -1;
21399 return make_number (PT
);
21408 /* If we wind up here, we failed to move by using the glyphs, so we
21409 need to simulate display instead. */
21412 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21414 paragraph_dir
= Qleft_to_right
;
21415 if (EQ (paragraph_dir
, Qright_to_left
))
21417 if (PT
<= BEGV
&& dir
< 0)
21418 xsignal0 (Qbeginning_of_buffer
);
21419 else if (PT
>= ZV
&& dir
> 0)
21420 xsignal0 (Qend_of_buffer
);
21423 struct text_pos pt
;
21425 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21427 bool overshoot_expected
= false;
21428 bool target_is_eol_p
= false;
21430 /* Setup the arena. */
21431 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21432 start_display (&it
, w
, pt
);
21433 /* When lines are truncated, we could be called with point
21434 outside of the windows edges, in which case move_it_*
21435 functions either prematurely stop at window's edge or jump to
21436 the next screen line, whereas we rely below on our ability to
21437 reach point, in order to start from its X coordinate. So we
21438 need to disregard the window's horizontal extent in that case. */
21439 if (it
.line_wrap
== TRUNCATE
)
21440 it
.last_visible_x
= INFINITY
;
21442 if (it
.cmp_it
.id
< 0
21443 && it
.method
== GET_FROM_STRING
21444 && it
.area
== TEXT_AREA
21445 && it
.string_from_display_prop_p
21446 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21447 overshoot_expected
= true;
21449 /* Find the X coordinate of point. We start from the beginning
21450 of this or previous line to make sure we are before point in
21451 the logical order (since the move_it_* functions can only
21454 reseat_at_previous_visible_line_start (&it
);
21455 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21456 if (IT_CHARPOS (it
) != PT
)
21458 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21459 -1, -1, -1, MOVE_TO_POS
);
21460 /* If we missed point because the character there is
21461 displayed out of a display vector that has more than one
21462 glyph, retry expecting overshoot. */
21463 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21464 && it
.current
.dpvec_index
> 0
21465 && !overshoot_expected
)
21467 overshoot_expected
= true;
21470 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21471 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21473 pt_x
= it
.current_x
;
21475 if (dir
> 0 || overshoot_expected
)
21477 struct glyph_row
*row
= it
.glyph_row
;
21479 /* When point is at beginning of line, we don't have
21480 information about the glyph there loaded into struct
21481 it. Calling get_next_display_element fixes that. */
21483 get_next_display_element (&it
);
21484 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21485 it
.glyph_row
= NULL
;
21486 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21487 it
.glyph_row
= row
;
21488 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21489 it, lest it will become out of sync with it's buffer
21491 it
.current_x
= pt_x
;
21494 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21495 pixel_width
= it
.pixel_width
;
21496 if (overshoot_expected
&& at_eol_p
)
21498 else if (pixel_width
<= 0)
21501 /* If there's a display string (or something similar) at point,
21502 we are actually at the glyph to the left of point, so we need
21503 to correct the X coordinate. */
21504 if (overshoot_expected
)
21507 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21509 pt_x
+= pixel_width
;
21512 /* Compute target X coordinate, either to the left or to the
21513 right of point. On TTY frames, all characters have the same
21514 pixel width of 1, so we can use that. On GUI frames we don't
21515 have an easy way of getting at the pixel width of the
21516 character to the left of point, so we use a different method
21517 of getting to that place. */
21519 target_x
= pt_x
+ pixel_width
;
21521 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21523 /* Target X coordinate could be one line above or below the line
21524 of point, in which case we need to adjust the target X
21525 coordinate. Also, if moving to the left, we need to begin at
21526 the left edge of the point's screen line. */
21531 start_display (&it
, w
, pt
);
21532 if (it
.line_wrap
== TRUNCATE
)
21533 it
.last_visible_x
= INFINITY
;
21534 reseat_at_previous_visible_line_start (&it
);
21535 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21537 move_it_by_lines (&it
, pt_vpos
);
21541 move_it_by_lines (&it
, -1);
21542 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21543 target_is_eol_p
= true;
21544 /* Under word-wrap, we don't know the x coordinate of
21545 the last character displayed on the previous line,
21546 which immediately precedes the wrap point. To find
21547 out its x coordinate, we try moving to the right
21548 margin of the window, which will stop at the wrap
21549 point, and then reset target_x to point at the
21550 character that precedes the wrap point. This is not
21551 needed on GUI frames, because (see below) there we
21552 move from the left margin one grapheme cluster at a
21553 time, and stop when we hit the wrap point. */
21554 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21556 void *it_data
= NULL
;
21559 SAVE_IT (it2
, it
, it_data
);
21560 move_it_in_display_line_to (&it
, ZV
, target_x
,
21561 MOVE_TO_POS
| MOVE_TO_X
);
21562 /* If we arrived at target_x, that _is_ the last
21563 character on the previous line. */
21564 if (it
.current_x
!= target_x
)
21565 target_x
= it
.current_x
- 1;
21566 RESTORE_IT (&it
, &it2
, it_data
);
21573 || (target_x
>= it
.last_visible_x
21574 && it
.line_wrap
!= TRUNCATE
))
21577 move_it_by_lines (&it
, 0);
21578 move_it_by_lines (&it
, 1);
21583 /* Move to the target X coordinate. */
21584 #ifdef HAVE_WINDOW_SYSTEM
21585 /* On GUI frames, as we don't know the X coordinate of the
21586 character to the left of point, moving point to the left
21587 requires walking, one grapheme cluster at a time, until we
21588 find ourself at a place immediately to the left of the
21589 character at point. */
21590 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21592 struct text_pos new_pos
;
21593 enum move_it_result rc
= MOVE_X_REACHED
;
21595 if (it
.current_x
== 0)
21596 get_next_display_element (&it
);
21597 if (it
.what
== IT_COMPOSITION
)
21599 new_pos
.charpos
= it
.cmp_it
.charpos
;
21600 new_pos
.bytepos
= -1;
21603 new_pos
= it
.current
.pos
;
21605 while (it
.current_x
+ it
.pixel_width
<= target_x
21606 && (rc
== MOVE_X_REACHED
21607 /* Under word-wrap, move_it_in_display_line_to
21608 stops at correct coordinates, but sometimes
21609 returns MOVE_POS_MATCH_OR_ZV. */
21610 || (it
.line_wrap
== WORD_WRAP
21611 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21613 int new_x
= it
.current_x
+ it
.pixel_width
;
21615 /* For composed characters, we want the position of the
21616 first character in the grapheme cluster (usually, the
21617 composition's base character), whereas it.current
21618 might give us the position of the _last_ one, e.g. if
21619 the composition is rendered in reverse due to bidi
21621 if (it
.what
== IT_COMPOSITION
)
21623 new_pos
.charpos
= it
.cmp_it
.charpos
;
21624 new_pos
.bytepos
= -1;
21627 new_pos
= it
.current
.pos
;
21628 if (new_x
== it
.current_x
)
21630 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21631 MOVE_TO_POS
| MOVE_TO_X
);
21632 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21635 /* The previous position we saw in the loop is the one we
21637 if (new_pos
.bytepos
== -1)
21638 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21639 it
.current
.pos
= new_pos
;
21643 if (it
.current_x
!= target_x
)
21644 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21646 /* If we ended up in a display string that covers point, move to
21647 buffer position to the right in the visual order. */
21650 while (IT_CHARPOS (it
) == PT
)
21652 set_iterator_to_next (&it
, false);
21653 if (!get_next_display_element (&it
))
21658 /* Move point to that position. */
21659 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21662 return make_number (PT
);
21664 #undef ROW_GLYPH_NEWLINE_P
21667 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21668 Sbidi_resolved_levels
, 0, 1, 0,
21669 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21671 The resolved levels are produced by the Emacs bidi reordering engine
21672 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21673 read the Unicode Standard Annex 9 (UAX#9) for background information
21674 about these levels.
21676 VPOS is the zero-based number of the current window's screen line
21677 for which to produce the resolved levels. If VPOS is nil or omitted,
21678 it defaults to the screen line of point. If the window displays a
21679 header line, VPOS of zero will report on the header line, and first
21680 line of text in the window will have VPOS of 1.
21682 Value is an array of resolved levels, indexed by glyph number.
21683 Glyphs are numbered from zero starting from the beginning of the
21684 screen line, i.e. the left edge of the window for left-to-right lines
21685 and from the right edge for right-to-left lines. The resolved levels
21686 are produced only for the window's text area; text in display margins
21689 If the selected window's display is not up-to-date, or if the specified
21690 screen line does not display text, this function returns nil. It is
21691 highly recommended to bind this function to some simple key, like F8,
21692 in order to avoid these problems.
21694 This function exists mainly for testing the correctness of the
21695 Emacs UBA implementation, in particular with the test suite. */)
21698 struct window
*w
= XWINDOW (selected_window
);
21699 struct buffer
*b
= XBUFFER (w
->contents
);
21701 struct glyph_row
*row
;
21705 int d1
, d2
, d3
, d4
, d5
;
21707 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21711 CHECK_NUMBER_COERCE_MARKER (vpos
);
21712 nrow
= XINT (vpos
);
21715 /* We require up-to-date glyph matrix for this window. */
21716 if (w
->window_end_valid
21717 && !windows_or_buffers_changed
21719 && !b
->clip_changed
21720 && !b
->prevent_redisplay_optimizations_p
21721 && !window_outdated (w
)
21723 && nrow
< w
->current_matrix
->nrows
21724 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21725 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21727 struct glyph
*g
, *e
, *g1
;
21729 Lisp_Object levels
;
21731 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21733 g
= g1
= row
->glyphs
[TEXT_AREA
];
21734 e
= g
+ row
->used
[TEXT_AREA
];
21736 /* Skip over glyphs at the start of the row that was
21737 generated by redisplay for its own needs. */
21739 && NILP (g
->object
)
21744 /* Count the "interesting" glyphs in this row. */
21745 for (nglyphs
= 0; g
< e
&& !NILP (g
->object
); g
++)
21748 /* Create and fill the array. */
21749 levels
= make_uninit_vector (nglyphs
);
21750 for (i
= 0; g1
< g
; i
++, g1
++)
21751 ASET (levels
, i
, make_number (g1
->resolved_level
));
21753 else /* Right-to-left glyph row. */
21755 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21756 e
= row
->glyphs
[TEXT_AREA
] - 1;
21758 && NILP (g
->object
)
21762 for (nglyphs
= 0; g
> e
&& !NILP (g
->object
); g
--)
21764 levels
= make_uninit_vector (nglyphs
);
21765 for (i
= 0; g1
> g
; i
++, g1
--)
21766 ASET (levels
, i
, make_number (g1
->resolved_level
));
21776 /***********************************************************************
21778 ***********************************************************************/
21780 /* Redisplay the menu bar in the frame for window W.
21782 The menu bar of X frames that don't have X toolkit support is
21783 displayed in a special window W->frame->menu_bar_window.
21785 The menu bar of terminal frames is treated specially as far as
21786 glyph matrices are concerned. Menu bar lines are not part of
21787 windows, so the update is done directly on the frame matrix rows
21788 for the menu bar. */
21791 display_menu_bar (struct window
*w
)
21793 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21798 /* Don't do all this for graphical frames. */
21800 if (FRAME_W32_P (f
))
21803 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21809 if (FRAME_NS_P (f
))
21811 #endif /* HAVE_NS */
21813 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21814 eassert (!FRAME_WINDOW_P (f
));
21815 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21816 it
.first_visible_x
= 0;
21817 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21818 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21819 if (FRAME_WINDOW_P (f
))
21821 /* Menu bar lines are displayed in the desired matrix of the
21822 dummy window menu_bar_window. */
21823 struct window
*menu_w
;
21824 menu_w
= XWINDOW (f
->menu_bar_window
);
21825 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21827 it
.first_visible_x
= 0;
21828 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21831 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21833 /* This is a TTY frame, i.e. character hpos/vpos are used as
21835 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21837 it
.first_visible_x
= 0;
21838 it
.last_visible_x
= FRAME_COLS (f
);
21841 /* FIXME: This should be controlled by a user option. See the
21842 comments in redisplay_tool_bar and display_mode_line about
21844 it
.paragraph_embedding
= L2R
;
21846 /* Clear all rows of the menu bar. */
21847 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21849 struct glyph_row
*row
= it
.glyph_row
+ i
;
21850 clear_glyph_row (row
);
21851 row
->enabled_p
= true;
21852 row
->full_width_p
= true;
21853 row
->reversed_p
= false;
21856 /* Display all items of the menu bar. */
21857 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21858 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21860 Lisp_Object string
;
21862 /* Stop at nil string. */
21863 string
= AREF (items
, i
+ 1);
21867 /* Remember where item was displayed. */
21868 ASET (items
, i
+ 3, make_number (it
.hpos
));
21870 /* Display the item, pad with one space. */
21871 if (it
.current_x
< it
.last_visible_x
)
21872 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21873 SCHARS (string
) + 1, 0, 0, -1);
21876 /* Fill out the line with spaces. */
21877 if (it
.current_x
< it
.last_visible_x
)
21878 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21880 /* Compute the total height of the lines. */
21881 compute_line_metrics (&it
);
21884 /* Deep copy of a glyph row, including the glyphs. */
21886 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21888 struct glyph
*pointers
[1 + LAST_AREA
];
21889 int to_used
= to
->used
[TEXT_AREA
];
21891 /* Save glyph pointers of TO. */
21892 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21894 /* Do a structure assignment. */
21897 /* Restore original glyph pointers of TO. */
21898 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21900 /* Copy the glyphs. */
21901 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21902 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21904 /* If we filled only part of the TO row, fill the rest with
21905 space_glyph (which will display as empty space). */
21906 if (to_used
> from
->used
[TEXT_AREA
])
21907 fill_up_frame_row_with_spaces (to
, to_used
);
21910 /* Display one menu item on a TTY, by overwriting the glyphs in the
21911 frame F's desired glyph matrix with glyphs produced from the menu
21912 item text. Called from term.c to display TTY drop-down menus one
21915 ITEM_TEXT is the menu item text as a C string.
21917 FACE_ID is the face ID to be used for this menu item. FACE_ID
21918 could specify one of 3 faces: a face for an enabled item, a face
21919 for a disabled item, or a face for a selected item.
21921 X and Y are coordinates of the first glyph in the frame's desired
21922 matrix to be overwritten by the menu item. Since this is a TTY, Y
21923 is the zero-based number of the glyph row and X is the zero-based
21924 glyph number in the row, starting from left, where to start
21925 displaying the item.
21927 SUBMENU means this menu item drops down a submenu, which
21928 should be indicated by displaying a proper visual cue after the
21932 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21933 int x
, int y
, bool submenu
)
21936 struct frame
*f
= SELECTED_FRAME ();
21937 struct window
*w
= XWINDOW (f
->selected_window
);
21938 struct glyph_row
*row
;
21939 size_t item_len
= strlen (item_text
);
21941 eassert (FRAME_TERMCAP_P (f
));
21943 /* Don't write beyond the matrix's last row. This can happen for
21944 TTY screens that are not high enough to show the entire menu.
21945 (This is actually a bit of defensive programming, as
21946 tty_menu_display already limits the number of menu items to one
21947 less than the number of screen lines.) */
21948 if (y
>= f
->desired_matrix
->nrows
)
21951 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21952 it
.first_visible_x
= 0;
21953 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21954 row
= it
.glyph_row
;
21955 /* Start with the row contents from the current matrix. */
21956 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21957 bool saved_width
= row
->full_width_p
;
21958 row
->full_width_p
= true;
21959 bool saved_reversed
= row
->reversed_p
;
21960 row
->reversed_p
= false;
21961 row
->enabled_p
= true;
21963 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21965 eassert (x
< f
->desired_matrix
->matrix_w
);
21966 it
.current_x
= it
.hpos
= x
;
21967 it
.current_y
= it
.vpos
= y
;
21968 int saved_used
= row
->used
[TEXT_AREA
];
21969 bool saved_truncated
= row
->truncated_on_right_p
;
21970 row
->used
[TEXT_AREA
] = x
;
21971 it
.face_id
= face_id
;
21972 it
.line_wrap
= TRUNCATE
;
21974 /* FIXME: This should be controlled by a user option. See the
21975 comments in redisplay_tool_bar and display_mode_line about this.
21976 Also, if paragraph_embedding could ever be R2L, changes will be
21977 needed to avoid shifting to the right the row characters in
21978 term.c:append_glyph. */
21979 it
.paragraph_embedding
= L2R
;
21981 /* Pad with a space on the left. */
21982 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21984 /* Display the menu item, pad with spaces to WIDTH. */
21987 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21988 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21990 /* Indicate with " >" that there's a submenu. */
21991 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21992 FRAME_COLS (f
) - 1, -1);
21995 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21996 width
, 0, FRAME_COLS (f
) - 1, -1);
21998 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21999 row
->truncated_on_right_p
= saved_truncated
;
22000 row
->hash
= row_hash (row
);
22001 row
->full_width_p
= saved_width
;
22002 row
->reversed_p
= saved_reversed
;
22005 /***********************************************************************
22007 ***********************************************************************/
22009 /* Redisplay mode lines in the window tree whose root is WINDOW.
22010 If FORCE, redisplay mode lines unconditionally.
22011 Otherwise, redisplay only mode lines that are garbaged. Value is
22012 the number of windows whose mode lines were redisplayed. */
22015 redisplay_mode_lines (Lisp_Object window
, bool force
)
22019 while (!NILP (window
))
22021 struct window
*w
= XWINDOW (window
);
22023 if (WINDOWP (w
->contents
))
22024 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
22026 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
22027 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
22029 struct text_pos lpoint
;
22030 struct buffer
*old
= current_buffer
;
22032 /* Set the window's buffer for the mode line display. */
22033 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
22034 set_buffer_internal_1 (XBUFFER (w
->contents
));
22036 /* Point refers normally to the selected window. For any
22037 other window, set up appropriate value. */
22038 if (!EQ (window
, selected_window
))
22040 struct text_pos pt
;
22042 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
22043 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
22046 /* Display mode lines. */
22047 clear_glyph_matrix (w
->desired_matrix
);
22048 if (display_mode_lines (w
))
22051 /* Restore old settings. */
22052 set_buffer_internal_1 (old
);
22053 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
22063 /* Display the mode and/or header line of window W. Value is the
22064 sum number of mode lines and header lines displayed. */
22067 display_mode_lines (struct window
*w
)
22069 Lisp_Object old_selected_window
= selected_window
;
22070 Lisp_Object old_selected_frame
= selected_frame
;
22071 Lisp_Object new_frame
= w
->frame
;
22072 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
22075 selected_frame
= new_frame
;
22076 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22077 or window's point, then we'd need select_window_1 here as well. */
22078 XSETWINDOW (selected_window
, w
);
22079 XFRAME (new_frame
)->selected_window
= selected_window
;
22081 /* These will be set while the mode line specs are processed. */
22082 line_number_displayed
= false;
22083 w
->column_number_displayed
= -1;
22085 if (WINDOW_WANTS_MODELINE_P (w
))
22087 struct window
*sel_w
= XWINDOW (old_selected_window
);
22089 /* Select mode line face based on the real selected window. */
22090 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
22091 BVAR (current_buffer
, mode_line_format
));
22095 if (WINDOW_WANTS_HEADER_LINE_P (w
))
22097 display_mode_line (w
, HEADER_LINE_FACE_ID
,
22098 BVAR (current_buffer
, header_line_format
));
22102 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
22103 selected_frame
= old_selected_frame
;
22104 selected_window
= old_selected_window
;
22106 w
->must_be_updated_p
= true;
22111 /* Display mode or header line of window W. FACE_ID specifies which
22112 line to display; it is either MODE_LINE_FACE_ID or
22113 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22114 display. Value is the pixel height of the mode/header line
22118 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
22122 ptrdiff_t count
= SPECPDL_INDEX ();
22124 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22125 /* Don't extend on a previously drawn mode-line.
22126 This may happen if called from pos_visible_p. */
22127 it
.glyph_row
->enabled_p
= false;
22128 prepare_desired_row (w
, it
.glyph_row
, true);
22130 it
.glyph_row
->mode_line_p
= true;
22132 /* FIXME: This should be controlled by a user option. But
22133 supporting such an option is not trivial, since the mode line is
22134 made up of many separate strings. */
22135 it
.paragraph_embedding
= L2R
;
22137 record_unwind_protect (unwind_format_mode_line
,
22138 format_mode_line_unwind_data (NULL
, NULL
,
22141 mode_line_target
= MODE_LINE_DISPLAY
;
22143 /* Temporarily make frame's keyboard the current kboard so that
22144 kboard-local variables in the mode_line_format will get the right
22146 push_kboard (FRAME_KBOARD (it
.f
));
22147 record_unwind_save_match_data ();
22148 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22151 unbind_to (count
, Qnil
);
22153 /* Fill up with spaces. */
22154 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
22156 compute_line_metrics (&it
);
22157 it
.glyph_row
->full_width_p
= true;
22158 it
.glyph_row
->continued_p
= false;
22159 it
.glyph_row
->truncated_on_left_p
= false;
22160 it
.glyph_row
->truncated_on_right_p
= false;
22162 /* Make a 3D mode-line have a shadow at its right end. */
22163 face
= FACE_FROM_ID (it
.f
, face_id
);
22164 extend_face_to_end_of_line (&it
);
22165 if (face
->box
!= FACE_NO_BOX
)
22167 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
22168 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
22169 last
->right_box_line_p
= true;
22172 return it
.glyph_row
->height
;
22175 /* Move element ELT in LIST to the front of LIST.
22176 Return the updated list. */
22179 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
22181 register Lisp_Object tail
, prev
;
22182 register Lisp_Object tem
;
22186 while (CONSP (tail
))
22192 /* Splice out the link TAIL. */
22194 list
= XCDR (tail
);
22196 Fsetcdr (prev
, XCDR (tail
));
22198 /* Now make it the first. */
22199 Fsetcdr (tail
, list
);
22204 tail
= XCDR (tail
);
22208 /* Not found--return unchanged LIST. */
22212 /* Contribute ELT to the mode line for window IT->w. How it
22213 translates into text depends on its data type.
22215 IT describes the display environment in which we display, as usual.
22217 DEPTH is the depth in recursion. It is used to prevent
22218 infinite recursion here.
22220 FIELD_WIDTH is the number of characters the display of ELT should
22221 occupy in the mode line, and PRECISION is the maximum number of
22222 characters to display from ELT's representation. See
22223 display_string for details.
22225 Returns the hpos of the end of the text generated by ELT.
22227 PROPS is a property list to add to any string we encounter.
22229 If RISKY, remove (disregard) any properties in any string
22230 we encounter, and ignore :eval and :propertize.
22232 The global variable `mode_line_target' determines whether the
22233 output is passed to `store_mode_line_noprop',
22234 `store_mode_line_string', or `display_string'. */
22237 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22238 Lisp_Object elt
, Lisp_Object props
, bool risky
)
22240 int n
= 0, field
, prec
;
22241 bool literal
= false;
22245 elt
= build_string ("*too-deep*");
22249 switch (XTYPE (elt
))
22253 /* A string: output it and check for %-constructs within it. */
22255 ptrdiff_t offset
= 0;
22257 if (SCHARS (elt
) > 0
22258 && (!NILP (props
) || risky
))
22260 Lisp_Object oprops
, aelt
;
22261 oprops
= Ftext_properties_at (make_number (0), elt
);
22263 /* If the starting string's properties are not what
22264 we want, translate the string. Also, if the string
22265 is risky, do that anyway. */
22267 if (NILP (Fequal (props
, oprops
)) || risky
)
22269 /* If the starting string has properties,
22270 merge the specified ones onto the existing ones. */
22271 if (! NILP (oprops
) && !risky
)
22275 oprops
= Fcopy_sequence (oprops
);
22277 while (CONSP (tem
))
22279 oprops
= Fplist_put (oprops
, XCAR (tem
),
22280 XCAR (XCDR (tem
)));
22281 tem
= XCDR (XCDR (tem
));
22286 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22287 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22289 /* AELT is what we want. Move it to the front
22290 without consing. */
22292 mode_line_proptrans_alist
22293 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22299 /* If AELT has the wrong props, it is useless.
22300 so get rid of it. */
22302 mode_line_proptrans_alist
22303 = Fdelq (aelt
, mode_line_proptrans_alist
);
22305 elt
= Fcopy_sequence (elt
);
22306 Fset_text_properties (make_number (0), Flength (elt
),
22308 /* Add this item to mode_line_proptrans_alist. */
22309 mode_line_proptrans_alist
22310 = Fcons (Fcons (elt
, props
),
22311 mode_line_proptrans_alist
);
22312 /* Truncate mode_line_proptrans_alist
22313 to at most 50 elements. */
22314 tem
= Fnthcdr (make_number (50),
22315 mode_line_proptrans_alist
);
22317 XSETCDR (tem
, Qnil
);
22326 prec
= precision
- n
;
22327 switch (mode_line_target
)
22329 case MODE_LINE_NOPROP
:
22330 case MODE_LINE_TITLE
:
22331 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22333 case MODE_LINE_STRING
:
22334 n
+= store_mode_line_string (NULL
, elt
, true, 0, prec
, Qnil
);
22336 case MODE_LINE_DISPLAY
:
22337 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22338 0, prec
, 0, STRING_MULTIBYTE (elt
));
22345 /* Handle the non-literal case. */
22347 while ((precision
<= 0 || n
< precision
)
22348 && SREF (elt
, offset
) != 0
22349 && (mode_line_target
!= MODE_LINE_DISPLAY
22350 || it
->current_x
< it
->last_visible_x
))
22352 ptrdiff_t last_offset
= offset
;
22354 /* Advance to end of string or next format specifier. */
22355 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22358 if (offset
- 1 != last_offset
)
22360 ptrdiff_t nchars
, nbytes
;
22362 /* Output to end of string or up to '%'. Field width
22363 is length of string. Don't output more than
22364 PRECISION allows us. */
22367 prec
= c_string_width (SDATA (elt
) + last_offset
,
22368 offset
- last_offset
, precision
- n
,
22371 switch (mode_line_target
)
22373 case MODE_LINE_NOPROP
:
22374 case MODE_LINE_TITLE
:
22375 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22377 case MODE_LINE_STRING
:
22379 ptrdiff_t bytepos
= last_offset
;
22380 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22381 ptrdiff_t endpos
= (precision
<= 0
22382 ? string_byte_to_char (elt
, offset
)
22383 : charpos
+ nchars
);
22384 Lisp_Object mode_string
22385 = Fsubstring (elt
, make_number (charpos
),
22386 make_number (endpos
));
22387 n
+= store_mode_line_string (NULL
, mode_string
, false,
22391 case MODE_LINE_DISPLAY
:
22393 ptrdiff_t bytepos
= last_offset
;
22394 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22396 if (precision
<= 0)
22397 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22398 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22400 STRING_MULTIBYTE (elt
));
22405 else /* c == '%' */
22407 ptrdiff_t percent_position
= offset
;
22409 /* Get the specified minimum width. Zero means
22412 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22413 field
= field
* 10 + c
- '0';
22415 /* Don't pad beyond the total padding allowed. */
22416 if (field_width
- n
> 0 && field
> field_width
- n
)
22417 field
= field_width
- n
;
22419 /* Note that either PRECISION <= 0 or N < PRECISION. */
22420 prec
= precision
- n
;
22423 n
+= display_mode_element (it
, depth
, field
, prec
,
22424 Vglobal_mode_string
, props
,
22429 ptrdiff_t bytepos
, charpos
;
22431 Lisp_Object string
;
22433 bytepos
= percent_position
;
22434 charpos
= (STRING_MULTIBYTE (elt
)
22435 ? string_byte_to_char (elt
, bytepos
)
22437 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22438 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22440 switch (mode_line_target
)
22442 case MODE_LINE_NOPROP
:
22443 case MODE_LINE_TITLE
:
22444 n
+= store_mode_line_noprop (spec
, field
, prec
);
22446 case MODE_LINE_STRING
:
22448 Lisp_Object tem
= build_string (spec
);
22449 props
= Ftext_properties_at (make_number (charpos
), elt
);
22450 /* Should only keep face property in props */
22451 n
+= store_mode_line_string (NULL
, tem
, false,
22452 field
, prec
, props
);
22455 case MODE_LINE_DISPLAY
:
22457 int nglyphs_before
, nwritten
;
22459 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22460 nwritten
= display_string (spec
, string
, elt
,
22465 /* Assign to the glyphs written above the
22466 string where the `%x' came from, position
22470 struct glyph
*glyph
22471 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22475 for (i
= 0; i
< nwritten
; ++i
)
22477 glyph
[i
].object
= elt
;
22478 glyph
[i
].charpos
= charpos
;
22495 /* A symbol: process the value of the symbol recursively
22496 as if it appeared here directly. Avoid error if symbol void.
22497 Special case: if value of symbol is a string, output the string
22500 register Lisp_Object tem
;
22502 /* If the variable is not marked as risky to set
22503 then its contents are risky to use. */
22504 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22507 tem
= Fboundp (elt
);
22510 tem
= Fsymbol_value (elt
);
22511 /* If value is a string, output that string literally:
22512 don't check for % within it. */
22516 if (!EQ (tem
, elt
))
22518 /* Give up right away for nil or t. */
22528 register Lisp_Object car
, tem
;
22530 /* A cons cell: five distinct cases.
22531 If first element is :eval or :propertize, do something special.
22532 If first element is a string or a cons, process all the elements
22533 and effectively concatenate them.
22534 If first element is a negative number, truncate displaying cdr to
22535 at most that many characters. If positive, pad (with spaces)
22536 to at least that many characters.
22537 If first element is a symbol, process the cadr or caddr recursively
22538 according to whether the symbol's value is non-nil or nil. */
22540 if (EQ (car
, QCeval
))
22542 /* An element of the form (:eval FORM) means evaluate FORM
22543 and use the result as mode line elements. */
22548 if (CONSP (XCDR (elt
)))
22551 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22552 n
+= display_mode_element (it
, depth
, field_width
- n
,
22553 precision
- n
, spec
, props
,
22557 else if (EQ (car
, QCpropertize
))
22559 /* An element of the form (:propertize ELT PROPS...)
22560 means display ELT but applying properties PROPS. */
22565 if (CONSP (XCDR (elt
)))
22566 n
+= display_mode_element (it
, depth
, field_width
- n
,
22567 precision
- n
, XCAR (XCDR (elt
)),
22568 XCDR (XCDR (elt
)), risky
);
22570 else if (SYMBOLP (car
))
22572 tem
= Fboundp (car
);
22576 /* elt is now the cdr, and we know it is a cons cell.
22577 Use its car if CAR has a non-nil value. */
22580 tem
= Fsymbol_value (car
);
22587 /* Symbol's value is nil (or symbol is unbound)
22588 Get the cddr of the original list
22589 and if possible find the caddr and use that. */
22593 else if (!CONSP (elt
))
22598 else if (INTEGERP (car
))
22600 register int lim
= XINT (car
);
22604 /* Negative int means reduce maximum width. */
22605 if (precision
<= 0)
22608 precision
= min (precision
, -lim
);
22612 /* Padding specified. Don't let it be more than
22613 current maximum. */
22615 lim
= min (precision
, lim
);
22617 /* If that's more padding than already wanted, queue it.
22618 But don't reduce padding already specified even if
22619 that is beyond the current truncation point. */
22620 field_width
= max (lim
, field_width
);
22624 else if (STRINGP (car
) || CONSP (car
))
22626 Lisp_Object halftail
= elt
;
22630 && (precision
<= 0 || n
< precision
))
22632 n
+= display_mode_element (it
, depth
,
22633 /* Do padding only after the last
22634 element in the list. */
22635 (! CONSP (XCDR (elt
))
22638 precision
- n
, XCAR (elt
),
22642 if ((len
& 1) == 0)
22643 halftail
= XCDR (halftail
);
22644 /* Check for cycle. */
22645 if (EQ (halftail
, elt
))
22654 elt
= build_string ("*invalid*");
22658 /* Pad to FIELD_WIDTH. */
22659 if (field_width
> 0 && n
< field_width
)
22661 switch (mode_line_target
)
22663 case MODE_LINE_NOPROP
:
22664 case MODE_LINE_TITLE
:
22665 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22667 case MODE_LINE_STRING
:
22668 n
+= store_mode_line_string ("", Qnil
, false, field_width
- n
, 0,
22671 case MODE_LINE_DISPLAY
:
22672 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22681 /* Store a mode-line string element in mode_line_string_list.
22683 If STRING is non-null, display that C string. Otherwise, the Lisp
22684 string LISP_STRING is displayed.
22686 FIELD_WIDTH is the minimum number of output glyphs to produce.
22687 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22688 with spaces. FIELD_WIDTH <= 0 means don't pad.
22690 PRECISION is the maximum number of characters to output from
22691 STRING. PRECISION <= 0 means don't truncate the string.
22693 If COPY_STRING, make a copy of LISP_STRING before adding
22694 properties to the string.
22696 PROPS are the properties to add to the string.
22697 The mode_line_string_face face property is always added to the string.
22701 store_mode_line_string (const char *string
, Lisp_Object lisp_string
,
22703 int field_width
, int precision
, Lisp_Object props
)
22708 if (string
!= NULL
)
22710 len
= strlen (string
);
22711 if (precision
> 0 && len
> precision
)
22713 lisp_string
= make_string (string
, len
);
22715 props
= mode_line_string_face_prop
;
22716 else if (!NILP (mode_line_string_face
))
22718 Lisp_Object face
= Fplist_get (props
, Qface
);
22719 props
= Fcopy_sequence (props
);
22721 face
= mode_line_string_face
;
22723 face
= list2 (face
, mode_line_string_face
);
22724 props
= Fplist_put (props
, Qface
, face
);
22726 Fadd_text_properties (make_number (0), make_number (len
),
22727 props
, lisp_string
);
22731 len
= XFASTINT (Flength (lisp_string
));
22732 if (precision
> 0 && len
> precision
)
22735 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22738 if (!NILP (mode_line_string_face
))
22742 props
= Ftext_properties_at (make_number (0), lisp_string
);
22743 face
= Fplist_get (props
, Qface
);
22745 face
= mode_line_string_face
;
22747 face
= list2 (face
, mode_line_string_face
);
22748 props
= list2 (Qface
, face
);
22750 lisp_string
= Fcopy_sequence (lisp_string
);
22753 Fadd_text_properties (make_number (0), make_number (len
),
22754 props
, lisp_string
);
22759 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22763 if (field_width
> len
)
22765 field_width
-= len
;
22766 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22768 Fadd_text_properties (make_number (0), make_number (field_width
),
22769 props
, lisp_string
);
22770 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22778 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22780 doc
: /* Format a string out of a mode line format specification.
22781 First arg FORMAT specifies the mode line format (see `mode-line-format'
22782 for details) to use.
22784 By default, the format is evaluated for the currently selected window.
22786 Optional second arg FACE specifies the face property to put on all
22787 characters for which no face is specified. The value nil means the
22788 default face. The value t means whatever face the window's mode line
22789 currently uses (either `mode-line' or `mode-line-inactive',
22790 depending on whether the window is the selected window or not).
22791 An integer value means the value string has no text
22794 Optional third and fourth args WINDOW and BUFFER specify the window
22795 and buffer to use as the context for the formatting (defaults
22796 are the selected window and the WINDOW's buffer). */)
22797 (Lisp_Object format
, Lisp_Object face
,
22798 Lisp_Object window
, Lisp_Object buffer
)
22803 struct buffer
*old_buffer
= NULL
;
22805 bool no_props
= INTEGERP (face
);
22806 ptrdiff_t count
= SPECPDL_INDEX ();
22808 int string_start
= 0;
22810 w
= decode_any_window (window
);
22811 XSETWINDOW (window
, w
);
22814 buffer
= w
->contents
;
22815 CHECK_BUFFER (buffer
);
22817 /* Make formatting the modeline a non-op when noninteractive, otherwise
22818 there will be problems later caused by a partially initialized frame. */
22819 if (NILP (format
) || noninteractive
)
22820 return empty_unibyte_string
;
22825 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22826 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22827 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22828 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22829 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22830 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22831 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22834 old_buffer
= current_buffer
;
22836 /* Save things including mode_line_proptrans_alist,
22837 and set that to nil so that we don't alter the outer value. */
22838 record_unwind_protect (unwind_format_mode_line
,
22839 format_mode_line_unwind_data
22840 (XFRAME (WINDOW_FRAME (w
)),
22841 old_buffer
, selected_window
, true));
22842 mode_line_proptrans_alist
= Qnil
;
22844 Fselect_window (window
, Qt
);
22845 set_buffer_internal_1 (XBUFFER (buffer
));
22847 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22851 mode_line_target
= MODE_LINE_NOPROP
;
22852 mode_line_string_face_prop
= Qnil
;
22853 mode_line_string_list
= Qnil
;
22854 string_start
= MODE_LINE_NOPROP_LEN (0);
22858 mode_line_target
= MODE_LINE_STRING
;
22859 mode_line_string_list
= Qnil
;
22860 mode_line_string_face
= face
;
22861 mode_line_string_face_prop
22862 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22865 push_kboard (FRAME_KBOARD (it
.f
));
22866 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, false);
22871 len
= MODE_LINE_NOPROP_LEN (string_start
);
22872 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22876 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22877 str
= Fmapconcat (Qidentity
, mode_line_string_list
,
22878 empty_unibyte_string
);
22881 unbind_to (count
, Qnil
);
22885 /* Write a null-terminated, right justified decimal representation of
22886 the positive integer D to BUF using a minimal field width WIDTH. */
22889 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22891 register char *p
= buf
;
22899 *p
++ = d
% 10 + '0';
22904 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22915 /* Write a null-terminated, right justified decimal and "human
22916 readable" representation of the nonnegative integer D to BUF using
22917 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22919 static const char power_letter
[] =
22933 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22935 /* We aim to represent the nonnegative integer D as
22936 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22937 ptrdiff_t quotient
= d
;
22939 /* -1 means: do not use TENTHS. */
22943 /* Length of QUOTIENT.TENTHS as a string. */
22949 if (quotient
>= 1000)
22951 /* Scale to the appropriate EXPONENT. */
22954 remainder
= quotient
% 1000;
22958 while (quotient
>= 1000);
22960 /* Round to nearest and decide whether to use TENTHS or not. */
22963 tenths
= remainder
/ 100;
22964 if (remainder
% 100 >= 50)
22971 if (quotient
== 10)
22979 if (remainder
>= 500)
22981 if (quotient
< 999)
22992 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22993 if (tenths
== -1 && quotient
<= 99)
23000 p
= psuffix
= buf
+ max (width
, length
);
23002 /* Print EXPONENT. */
23003 *psuffix
++ = power_letter
[exponent
];
23006 /* Print TENTHS. */
23009 *--p
= '0' + tenths
;
23013 /* Print QUOTIENT. */
23016 int digit
= quotient
% 10;
23017 *--p
= '0' + digit
;
23019 while ((quotient
/= 10) != 0);
23021 /* Print leading spaces. */
23026 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23027 If EOL_FLAG, set also a mnemonic character for end-of-line
23028 type of CODING_SYSTEM. Return updated pointer into BUF. */
23030 static unsigned char invalid_eol_type
[] = "(*invalid*)";
23033 decode_mode_spec_coding (Lisp_Object coding_system
, char *buf
, bool eol_flag
)
23036 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
23037 const unsigned char *eol_str
;
23039 /* The EOL conversion we are using. */
23040 Lisp_Object eoltype
;
23042 val
= CODING_SYSTEM_SPEC (coding_system
);
23045 if (!VECTORP (val
)) /* Not yet decided. */
23047 *buf
++ = multibyte
? '-' : ' ';
23049 eoltype
= eol_mnemonic_undecided
;
23050 /* Don't mention EOL conversion if it isn't decided. */
23055 Lisp_Object eolvalue
;
23057 attrs
= AREF (val
, 0);
23058 eolvalue
= AREF (val
, 2);
23061 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
23066 /* The EOL conversion that is normal on this system. */
23068 if (NILP (eolvalue
)) /* Not yet decided. */
23069 eoltype
= eol_mnemonic_undecided
;
23070 else if (VECTORP (eolvalue
)) /* Not yet decided. */
23071 eoltype
= eol_mnemonic_undecided
;
23072 else /* eolvalue is Qunix, Qdos, or Qmac. */
23073 eoltype
= (EQ (eolvalue
, Qunix
)
23074 ? eol_mnemonic_unix
23075 : EQ (eolvalue
, Qdos
)
23076 ? eol_mnemonic_dos
: eol_mnemonic_mac
);
23082 /* Mention the EOL conversion if it is not the usual one. */
23083 if (STRINGP (eoltype
))
23085 eol_str
= SDATA (eoltype
);
23086 eol_str_len
= SBYTES (eoltype
);
23088 else if (CHARACTERP (eoltype
))
23090 int c
= XFASTINT (eoltype
);
23091 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
23095 eol_str
= invalid_eol_type
;
23096 eol_str_len
= sizeof (invalid_eol_type
) - 1;
23098 memcpy (buf
, eol_str
, eol_str_len
);
23099 buf
+= eol_str_len
;
23105 /* Return a string for the output of a mode line %-spec for window W,
23106 generated by character C. FIELD_WIDTH > 0 means pad the string
23107 returned with spaces to that value. Return a Lisp string in
23108 *STRING if the resulting string is taken from that Lisp string.
23110 Note we operate on the current buffer for most purposes. */
23112 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23114 static const char *
23115 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
23116 Lisp_Object
*string
)
23119 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23120 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
23121 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23122 produce strings from numerical values, so limit preposterously
23123 large values of FIELD_WIDTH to avoid overrunning the buffer's
23124 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23125 bytes plus the terminating null. */
23126 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
23127 struct buffer
*b
= current_buffer
;
23135 if (!NILP (BVAR (b
, read_only
)))
23137 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23142 /* This differs from %* only for a modified read-only buffer. */
23143 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23145 if (!NILP (BVAR (b
, read_only
)))
23150 /* This differs from %* in ignoring read-only-ness. */
23151 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
23163 if (command_loop_level
> 5)
23165 p
= decode_mode_spec_buf
;
23166 for (i
= 0; i
< command_loop_level
; i
++)
23169 return decode_mode_spec_buf
;
23177 if (command_loop_level
> 5)
23179 p
= decode_mode_spec_buf
;
23180 for (i
= 0; i
< command_loop_level
; i
++)
23183 return decode_mode_spec_buf
;
23190 /* Let lots_of_dashes be a string of infinite length. */
23191 if (mode_line_target
== MODE_LINE_NOPROP
23192 || mode_line_target
== MODE_LINE_STRING
)
23194 if (field_width
<= 0
23195 || field_width
> sizeof (lots_of_dashes
))
23197 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
23198 decode_mode_spec_buf
[i
] = '-';
23199 decode_mode_spec_buf
[i
] = '\0';
23200 return decode_mode_spec_buf
;
23203 return lots_of_dashes
;
23207 obj
= BVAR (b
, name
);
23211 /* %c and %l are ignored in `frame-title-format'.
23212 (In redisplay_internal, the frame title is drawn _before_ the
23213 windows are updated, so the stuff which depends on actual
23214 window contents (such as %l) may fail to render properly, or
23215 even crash emacs.) */
23216 if (mode_line_target
== MODE_LINE_TITLE
)
23220 ptrdiff_t col
= current_column ();
23221 w
->column_number_displayed
= col
;
23222 pint2str (decode_mode_spec_buf
, width
, col
);
23223 return decode_mode_spec_buf
;
23227 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23229 if (NILP (Vmemory_full
))
23232 return "!MEM FULL! ";
23239 /* %F displays the frame name. */
23240 if (!NILP (f
->title
))
23241 return SSDATA (f
->title
);
23242 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23243 return SSDATA (f
->name
);
23247 obj
= BVAR (b
, filename
);
23252 ptrdiff_t size
= ZV
- BEGV
;
23253 pint2str (decode_mode_spec_buf
, width
, size
);
23254 return decode_mode_spec_buf
;
23259 ptrdiff_t size
= ZV
- BEGV
;
23260 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23261 return decode_mode_spec_buf
;
23266 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23267 ptrdiff_t topline
, nlines
, height
;
23270 /* %c and %l are ignored in `frame-title-format'. */
23271 if (mode_line_target
== MODE_LINE_TITLE
)
23274 startpos
= marker_position (w
->start
);
23275 startpos_byte
= marker_byte_position (w
->start
);
23276 height
= WINDOW_TOTAL_LINES (w
);
23278 /* If we decided that this buffer isn't suitable for line numbers,
23279 don't forget that too fast. */
23280 if (w
->base_line_pos
== -1)
23283 /* If the buffer is very big, don't waste time. */
23284 if (INTEGERP (Vline_number_display_limit
)
23285 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23287 w
->base_line_pos
= 0;
23288 w
->base_line_number
= 0;
23292 if (w
->base_line_number
> 0
23293 && w
->base_line_pos
> 0
23294 && w
->base_line_pos
<= startpos
)
23296 line
= w
->base_line_number
;
23297 linepos
= w
->base_line_pos
;
23298 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23303 linepos
= BUF_BEGV (b
);
23304 linepos_byte
= BUF_BEGV_BYTE (b
);
23307 /* Count lines from base line to window start position. */
23308 nlines
= display_count_lines (linepos_byte
,
23312 topline
= nlines
+ line
;
23314 /* Determine a new base line, if the old one is too close
23315 or too far away, or if we did not have one.
23316 "Too close" means it's plausible a scroll-down would
23317 go back past it. */
23318 if (startpos
== BUF_BEGV (b
))
23320 w
->base_line_number
= topline
;
23321 w
->base_line_pos
= BUF_BEGV (b
);
23323 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23324 || linepos
== BUF_BEGV (b
))
23326 ptrdiff_t limit
= BUF_BEGV (b
);
23327 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23328 ptrdiff_t position
;
23329 ptrdiff_t distance
=
23330 (height
* 2 + 30) * line_number_display_limit_width
;
23332 if (startpos
- distance
> limit
)
23334 limit
= startpos
- distance
;
23335 limit_byte
= CHAR_TO_BYTE (limit
);
23338 nlines
= display_count_lines (startpos_byte
,
23340 - (height
* 2 + 30),
23342 /* If we couldn't find the lines we wanted within
23343 line_number_display_limit_width chars per line,
23344 give up on line numbers for this window. */
23345 if (position
== limit_byte
&& limit
== startpos
- distance
)
23347 w
->base_line_pos
= -1;
23348 w
->base_line_number
= 0;
23352 w
->base_line_number
= topline
- nlines
;
23353 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23356 /* Now count lines from the start pos to point. */
23357 nlines
= display_count_lines (startpos_byte
,
23358 PT_BYTE
, PT
, &junk
);
23360 /* Record that we did display the line number. */
23361 line_number_displayed
= true;
23363 /* Make the string to show. */
23364 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23365 return decode_mode_spec_buf
;
23368 char *p
= decode_mode_spec_buf
;
23369 int pad
= width
- 2;
23375 return decode_mode_spec_buf
;
23381 obj
= BVAR (b
, mode_name
);
23385 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23391 ptrdiff_t pos
= marker_position (w
->start
);
23392 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23394 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23396 if (pos
<= BUF_BEGV (b
))
23401 else if (pos
<= BUF_BEGV (b
))
23405 if (total
> 1000000)
23406 /* Do it differently for a large value, to avoid overflow. */
23407 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23409 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23410 /* We can't normally display a 3-digit number,
23411 so get us a 2-digit number that is close. */
23414 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23415 return decode_mode_spec_buf
;
23419 /* Display percentage of size above the bottom of the screen. */
23422 ptrdiff_t toppos
= marker_position (w
->start
);
23423 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23424 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23426 if (botpos
>= BUF_ZV (b
))
23428 if (toppos
<= BUF_BEGV (b
))
23435 if (total
> 1000000)
23436 /* Do it differently for a large value, to avoid overflow. */
23437 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23439 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23440 /* We can't normally display a 3-digit number,
23441 so get us a 2-digit number that is close. */
23444 if (toppos
<= BUF_BEGV (b
))
23445 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23447 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23448 return decode_mode_spec_buf
;
23453 /* status of process */
23454 obj
= Fget_buffer_process (Fcurrent_buffer ());
23456 return "no process";
23458 obj
= Fsymbol_name (Fprocess_status (obj
));
23464 ptrdiff_t count
= inhibit_garbage_collection ();
23465 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23466 Lisp_Object val
= Qnil
;
23468 if (STRINGP (curdir
))
23469 val
= call1 (intern ("file-remote-p"), curdir
);
23471 unbind_to (count
, Qnil
);
23480 /* coding-system (not including end-of-line format) */
23482 /* coding-system (including end-of-line type) */
23484 bool eol_flag
= (c
== 'Z');
23485 char *p
= decode_mode_spec_buf
;
23487 if (! FRAME_WINDOW_P (f
))
23489 /* No need to mention EOL here--the terminal never needs
23490 to do EOL conversion. */
23491 p
= decode_mode_spec_coding (CODING_ID_NAME
23492 (FRAME_KEYBOARD_CODING (f
)->id
),
23494 p
= decode_mode_spec_coding (CODING_ID_NAME
23495 (FRAME_TERMINAL_CODING (f
)->id
),
23498 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23501 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23502 #ifdef subprocesses
23503 obj
= Fget_buffer_process (Fcurrent_buffer ());
23504 if (PROCESSP (obj
))
23506 p
= decode_mode_spec_coding
23507 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23508 p
= decode_mode_spec_coding
23509 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23511 #endif /* subprocesses */
23514 return decode_mode_spec_buf
;
23521 return SSDATA (obj
);
23528 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23529 means count lines back from START_BYTE. But don't go beyond
23530 LIMIT_BYTE. Return the number of lines thus found (always
23533 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23534 either the position COUNT lines after/before START_BYTE, if we
23535 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23539 display_count_lines (ptrdiff_t start_byte
,
23540 ptrdiff_t limit_byte
, ptrdiff_t count
,
23541 ptrdiff_t *byte_pos_ptr
)
23543 register unsigned char *cursor
;
23544 unsigned char *base
;
23546 register ptrdiff_t ceiling
;
23547 register unsigned char *ceiling_addr
;
23548 ptrdiff_t orig_count
= count
;
23550 /* If we are not in selective display mode,
23551 check only for newlines. */
23552 bool selective_display
23553 = (!NILP (BVAR (current_buffer
, selective_display
))
23554 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23558 while (start_byte
< limit_byte
)
23560 ceiling
= BUFFER_CEILING_OF (start_byte
);
23561 ceiling
= min (limit_byte
- 1, ceiling
);
23562 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23563 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23567 if (selective_display
)
23569 while (*cursor
!= '\n' && *cursor
!= 015
23570 && ++cursor
!= ceiling_addr
)
23572 if (cursor
== ceiling_addr
)
23577 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23586 start_byte
+= cursor
- base
;
23587 *byte_pos_ptr
= start_byte
;
23591 while (cursor
< ceiling_addr
);
23593 start_byte
+= ceiling_addr
- base
;
23598 while (start_byte
> limit_byte
)
23600 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23601 ceiling
= max (limit_byte
, ceiling
);
23602 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23603 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23606 if (selective_display
)
23608 while (--cursor
>= ceiling_addr
23609 && *cursor
!= '\n' && *cursor
!= 015)
23611 if (cursor
< ceiling_addr
)
23616 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23623 start_byte
+= cursor
- base
+ 1;
23624 *byte_pos_ptr
= start_byte
;
23625 /* When scanning backwards, we should
23626 not count the newline posterior to which we stop. */
23627 return - orig_count
- 1;
23630 start_byte
+= ceiling_addr
- base
;
23634 *byte_pos_ptr
= limit_byte
;
23637 return - orig_count
+ count
;
23638 return orig_count
- count
;
23644 /***********************************************************************
23646 ***********************************************************************/
23648 /* Display a NUL-terminated string, starting with index START.
23650 If STRING is non-null, display that C string. Otherwise, the Lisp
23651 string LISP_STRING is displayed. There's a case that STRING is
23652 non-null and LISP_STRING is not nil. It means STRING is a string
23653 data of LISP_STRING. In that case, we display LISP_STRING while
23654 ignoring its text properties.
23656 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23657 FACE_STRING. Display STRING or LISP_STRING with the face at
23658 FACE_STRING_POS in FACE_STRING:
23660 Display the string in the environment given by IT, but use the
23661 standard display table, temporarily.
23663 FIELD_WIDTH is the minimum number of output glyphs to produce.
23664 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23665 with spaces. If STRING has more characters, more than FIELD_WIDTH
23666 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23668 PRECISION is the maximum number of characters to output from
23669 STRING. PRECISION < 0 means don't truncate the string.
23671 This is roughly equivalent to printf format specifiers:
23673 FIELD_WIDTH PRECISION PRINTF
23674 ----------------------------------------
23680 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23681 display them, and < 0 means obey the current buffer's value of
23682 enable_multibyte_characters.
23684 Value is the number of columns displayed. */
23687 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23688 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23689 int field_width
, int precision
, int max_x
, int multibyte
)
23691 int hpos_at_start
= it
->hpos
;
23692 int saved_face_id
= it
->face_id
;
23693 struct glyph_row
*row
= it
->glyph_row
;
23694 ptrdiff_t it_charpos
;
23696 /* Initialize the iterator IT for iteration over STRING beginning
23697 with index START. */
23698 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23699 precision
, field_width
, multibyte
);
23700 if (string
&& STRINGP (lisp_string
))
23701 /* LISP_STRING is the one returned by decode_mode_spec. We should
23702 ignore its text properties. */
23703 it
->stop_charpos
= it
->end_charpos
;
23705 /* If displaying STRING, set up the face of the iterator from
23706 FACE_STRING, if that's given. */
23707 if (STRINGP (face_string
))
23713 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23714 0, &endptr
, it
->base_face_id
, false);
23715 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23716 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23719 /* Set max_x to the maximum allowed X position. Don't let it go
23720 beyond the right edge of the window. */
23722 max_x
= it
->last_visible_x
;
23724 max_x
= min (max_x
, it
->last_visible_x
);
23726 /* Skip over display elements that are not visible. because IT->w is
23728 if (it
->current_x
< it
->first_visible_x
)
23729 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23730 MOVE_TO_POS
| MOVE_TO_X
);
23732 row
->ascent
= it
->max_ascent
;
23733 row
->height
= it
->max_ascent
+ it
->max_descent
;
23734 row
->phys_ascent
= it
->max_phys_ascent
;
23735 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23736 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23738 if (STRINGP (it
->string
))
23739 it_charpos
= IT_STRING_CHARPOS (*it
);
23741 it_charpos
= IT_CHARPOS (*it
);
23743 /* This condition is for the case that we are called with current_x
23744 past last_visible_x. */
23745 while (it
->current_x
< max_x
)
23747 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23749 /* Get the next display element. */
23750 if (!get_next_display_element (it
))
23753 /* Produce glyphs. */
23754 x_before
= it
->current_x
;
23755 n_glyphs_before
= row
->used
[TEXT_AREA
];
23756 PRODUCE_GLYPHS (it
);
23758 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23761 while (i
< nglyphs
)
23763 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23765 if (it
->line_wrap
!= TRUNCATE
23766 && x
+ glyph
->pixel_width
> max_x
)
23768 /* End of continued line or max_x reached. */
23769 if (CHAR_GLYPH_PADDING_P (*glyph
))
23771 /* A wide character is unbreakable. */
23772 if (row
->reversed_p
)
23773 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23774 - n_glyphs_before
);
23775 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23776 it
->current_x
= x_before
;
23780 if (row
->reversed_p
)
23781 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23782 - (n_glyphs_before
+ i
));
23783 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23788 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23790 /* Glyph is at least partially visible. */
23792 if (x
< it
->first_visible_x
)
23793 row
->x
= x
- it
->first_visible_x
;
23797 /* Glyph is off the left margin of the display area.
23798 Should not happen. */
23802 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23803 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23804 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23805 row
->phys_height
= max (row
->phys_height
,
23806 it
->max_phys_ascent
+ it
->max_phys_descent
);
23807 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23808 it
->max_extra_line_spacing
);
23809 x
+= glyph
->pixel_width
;
23813 /* Stop if max_x reached. */
23817 /* Stop at line ends. */
23818 if (ITERATOR_AT_END_OF_LINE_P (it
))
23820 it
->continuation_lines_width
= 0;
23824 set_iterator_to_next (it
, true);
23825 if (STRINGP (it
->string
))
23826 it_charpos
= IT_STRING_CHARPOS (*it
);
23828 it_charpos
= IT_CHARPOS (*it
);
23830 /* Stop if truncating at the right edge. */
23831 if (it
->line_wrap
== TRUNCATE
23832 && it
->current_x
>= it
->last_visible_x
)
23834 /* Add truncation mark, but don't do it if the line is
23835 truncated at a padding space. */
23836 if (it_charpos
< it
->string_nchars
)
23838 if (!FRAME_WINDOW_P (it
->f
))
23842 if (it
->current_x
> it
->last_visible_x
)
23844 if (!row
->reversed_p
)
23846 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23847 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23852 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23853 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23855 unproduce_glyphs (it
, ii
+ 1);
23856 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23858 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23860 row
->used
[TEXT_AREA
] = ii
;
23861 produce_special_glyphs (it
, IT_TRUNCATION
);
23864 produce_special_glyphs (it
, IT_TRUNCATION
);
23866 row
->truncated_on_right_p
= true;
23872 /* Maybe insert a truncation at the left. */
23873 if (it
->first_visible_x
23876 if (!FRAME_WINDOW_P (it
->f
)
23877 || (row
->reversed_p
23878 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23879 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23880 insert_left_trunc_glyphs (it
);
23881 row
->truncated_on_left_p
= true;
23884 it
->face_id
= saved_face_id
;
23886 /* Value is number of columns displayed. */
23887 return it
->hpos
- hpos_at_start
;
23892 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23893 appears as an element of LIST or as the car of an element of LIST.
23894 If PROPVAL is a list, compare each element against LIST in that
23895 way, and return 1/2 if any element of PROPVAL is found in LIST.
23896 Otherwise return 0. This function cannot quit.
23897 The return value is 2 if the text is invisible but with an ellipsis
23898 and 1 if it's invisible and without an ellipsis. */
23901 invisible_prop (Lisp_Object propval
, Lisp_Object list
)
23903 Lisp_Object tail
, proptail
;
23905 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23907 register Lisp_Object tem
;
23909 if (EQ (propval
, tem
))
23911 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23912 return NILP (XCDR (tem
)) ? 1 : 2;
23915 if (CONSP (propval
))
23917 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23919 Lisp_Object propelt
;
23920 propelt
= XCAR (proptail
);
23921 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23923 register Lisp_Object tem
;
23925 if (EQ (propelt
, tem
))
23927 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23928 return NILP (XCDR (tem
)) ? 1 : 2;
23936 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23937 doc
: /* Non-nil if the property makes the text invisible.
23938 POS-OR-PROP can be a marker or number, in which case it is taken to be
23939 a position in the current buffer and the value of the `invisible' property
23940 is checked; or it can be some other value, which is then presumed to be the
23941 value of the `invisible' property of the text of interest.
23942 The non-nil value returned can be t for truly invisible text or something
23943 else if the text is replaced by an ellipsis. */)
23944 (Lisp_Object pos_or_prop
)
23947 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23948 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23950 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23951 return (invis
== 0 ? Qnil
23953 : make_number (invis
));
23956 /* Calculate a width or height in pixels from a specification using
23957 the following elements:
23960 NUM - a (fractional) multiple of the default font width/height
23961 (NUM) - specifies exactly NUM pixels
23962 UNIT - a fixed number of pixels, see below.
23963 ELEMENT - size of a display element in pixels, see below.
23964 (NUM . SPEC) - equals NUM * SPEC
23965 (+ SPEC SPEC ...) - add pixel values
23966 (- SPEC SPEC ...) - subtract pixel values
23967 (- SPEC) - negate pixel value
23970 INT or FLOAT - a number constant
23971 SYMBOL - use symbol's (buffer local) variable binding.
23974 in - pixels per inch *)
23975 mm - pixels per 1/1000 meter *)
23976 cm - pixels per 1/100 meter *)
23977 width - width of current font in pixels.
23978 height - height of current font in pixels.
23980 *) using the ratio(s) defined in display-pixels-per-inch.
23984 left-fringe - left fringe width in pixels
23985 right-fringe - right fringe width in pixels
23987 left-margin - left margin width in pixels
23988 right-margin - right margin width in pixels
23990 scroll-bar - scroll-bar area width in pixels
23994 Pixels corresponding to 5 inches:
23997 Total width of non-text areas on left side of window (if scroll-bar is on left):
23998 '(space :width (+ left-fringe left-margin scroll-bar))
24000 Align to first text column (in header line):
24001 '(space :align-to 0)
24003 Align to middle of text area minus half the width of variable `my-image'
24004 containing a loaded image:
24005 '(space :align-to (0.5 . (- text my-image)))
24007 Width of left margin minus width of 1 character in the default font:
24008 '(space :width (- left-margin 1))
24010 Width of left margin minus width of 2 characters in the current font:
24011 '(space :width (- left-margin (2 . width)))
24013 Center 1 character over left-margin (in header line):
24014 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24016 Different ways to express width of left fringe plus left margin minus one pixel:
24017 '(space :width (- (+ left-fringe left-margin) (1)))
24018 '(space :width (+ left-fringe left-margin (- (1))))
24019 '(space :width (+ left-fringe left-margin (-1)))
24024 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
24025 struct font
*font
, bool width_p
, int *align_to
)
24029 # define OK_PIXELS(val) (*res = (val), true)
24030 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24033 return OK_PIXELS (0);
24035 eassert (FRAME_LIVE_P (it
->f
));
24037 if (SYMBOLP (prop
))
24039 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
24041 char *unit
= SSDATA (SYMBOL_NAME (prop
));
24043 if (unit
[0] == 'i' && unit
[1] == 'n')
24045 else if (unit
[0] == 'm' && unit
[1] == 'm')
24047 else if (unit
[0] == 'c' && unit
[1] == 'm')
24053 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
24054 : FRAME_RES_Y (it
->f
));
24057 return OK_PIXELS (ppi
/ pixels
);
24062 #ifdef HAVE_WINDOW_SYSTEM
24063 if (EQ (prop
, Qheight
))
24064 return OK_PIXELS (font
24065 ? normal_char_height (font
, -1)
24066 : FRAME_LINE_HEIGHT (it
->f
));
24067 if (EQ (prop
, Qwidth
))
24068 return OK_PIXELS (font
24069 ? FONT_WIDTH (font
)
24070 : FRAME_COLUMN_WIDTH (it
->f
));
24072 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
24073 return OK_PIXELS (1);
24076 if (EQ (prop
, Qtext
))
24077 return OK_PIXELS (width_p
24078 ? window_box_width (it
->w
, TEXT_AREA
)
24079 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
24081 if (align_to
&& *align_to
< 0)
24084 if (EQ (prop
, Qleft
))
24085 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
24086 if (EQ (prop
, Qright
))
24087 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
24088 if (EQ (prop
, Qcenter
))
24089 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
24090 + window_box_width (it
->w
, TEXT_AREA
) / 2);
24091 if (EQ (prop
, Qleft_fringe
))
24092 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24093 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
24094 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
24095 if (EQ (prop
, Qright_fringe
))
24096 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24097 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24098 : window_box_right_offset (it
->w
, TEXT_AREA
));
24099 if (EQ (prop
, Qleft_margin
))
24100 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
24101 if (EQ (prop
, Qright_margin
))
24102 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
24103 if (EQ (prop
, Qscroll_bar
))
24104 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
24106 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
24107 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
24108 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
24113 if (EQ (prop
, Qleft_fringe
))
24114 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
24115 if (EQ (prop
, Qright_fringe
))
24116 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
24117 if (EQ (prop
, Qleft_margin
))
24118 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
24119 if (EQ (prop
, Qright_margin
))
24120 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
24121 if (EQ (prop
, Qscroll_bar
))
24122 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
24125 prop
= buffer_local_value (prop
, it
->w
->contents
);
24126 if (EQ (prop
, Qunbound
))
24130 if (NUMBERP (prop
))
24132 int base_unit
= (width_p
24133 ? FRAME_COLUMN_WIDTH (it
->f
)
24134 : FRAME_LINE_HEIGHT (it
->f
));
24135 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
24140 Lisp_Object car
= XCAR (prop
);
24141 Lisp_Object cdr
= XCDR (prop
);
24145 #ifdef HAVE_WINDOW_SYSTEM
24146 if (FRAME_WINDOW_P (it
->f
)
24147 && valid_image_p (prop
))
24149 ptrdiff_t id
= lookup_image (it
->f
, prop
);
24150 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
24152 return OK_PIXELS (width_p
? img
->width
: img
->height
);
24155 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
24161 while (CONSP (cdr
))
24163 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
24164 font
, width_p
, align_to
))
24167 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= false;
24172 if (EQ (car
, Qminus
))
24174 return OK_PIXELS (pixels
);
24177 car
= buffer_local_value (car
, it
->w
->contents
);
24178 if (EQ (car
, Qunbound
))
24185 pixels
= XFLOATINT (car
);
24187 return OK_PIXELS (pixels
);
24188 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
24189 font
, width_p
, align_to
))
24190 return OK_PIXELS (pixels
* fact
);
24201 get_font_ascent_descent (struct font
*font
, int *ascent
, int *descent
)
24203 #ifdef HAVE_WINDOW_SYSTEM
24204 normal_char_ascent_descent (font
, -1, ascent
, descent
);
24212 /***********************************************************************
24214 ***********************************************************************/
24216 #ifdef HAVE_WINDOW_SYSTEM
24221 dump_glyph_string (struct glyph_string
*s
)
24223 fprintf (stderr
, "glyph string\n");
24224 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24225 s
->x
, s
->y
, s
->width
, s
->height
);
24226 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24227 fprintf (stderr
, " hl = %d\n", s
->hl
);
24228 fprintf (stderr
, " left overhang = %d, right = %d\n",
24229 s
->left_overhang
, s
->right_overhang
);
24230 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24231 fprintf (stderr
, " extends to end of line = %d\n",
24232 s
->extends_to_end_of_line_p
);
24233 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24234 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24237 #endif /* GLYPH_DEBUG */
24239 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24240 of XChar2b structures for S; it can't be allocated in
24241 init_glyph_string because it must be allocated via `alloca'. W
24242 is the window on which S is drawn. ROW and AREA are the glyph row
24243 and area within the row from which S is constructed. START is the
24244 index of the first glyph structure covered by S. HL is a
24245 face-override for drawing S. */
24248 #define OPTIONAL_HDC(hdc) HDC hdc,
24249 #define DECLARE_HDC(hdc) HDC hdc;
24250 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24251 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24254 #ifndef OPTIONAL_HDC
24255 #define OPTIONAL_HDC(hdc)
24256 #define DECLARE_HDC(hdc)
24257 #define ALLOCATE_HDC(hdc, f)
24258 #define RELEASE_HDC(hdc, f)
24262 init_glyph_string (struct glyph_string
*s
,
24264 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24265 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24267 memset (s
, 0, sizeof *s
);
24269 s
->f
= XFRAME (w
->frame
);
24273 s
->display
= FRAME_X_DISPLAY (s
->f
);
24274 s
->window
= FRAME_X_WINDOW (s
->f
);
24275 s
->char2b
= char2b
;
24279 s
->first_glyph
= row
->glyphs
[area
] + start
;
24280 s
->height
= row
->height
;
24281 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24282 s
->ybase
= s
->y
+ row
->ascent
;
24286 /* Append the list of glyph strings with head H and tail T to the list
24287 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24290 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24291 struct glyph_string
*h
, struct glyph_string
*t
)
24305 /* Prepend the list of glyph strings with head H and tail T to the
24306 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24310 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24311 struct glyph_string
*h
, struct glyph_string
*t
)
24325 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24326 Set *HEAD and *TAIL to the resulting list. */
24329 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24330 struct glyph_string
*s
)
24332 s
->next
= s
->prev
= NULL
;
24333 append_glyph_string_lists (head
, tail
, s
, s
);
24337 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24338 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24339 make sure that X resources for the face returned are allocated.
24340 Value is a pointer to a realized face that is ready for display if
24343 static struct face
*
24344 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24345 XChar2b
*char2b
, bool display_p
)
24347 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24352 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24354 if (code
== FONT_INVALID_CODE
)
24357 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24359 /* Make sure X resources of the face are allocated. */
24360 #ifdef HAVE_X_WINDOWS
24364 eassert (face
!= NULL
);
24365 prepare_face_for_display (f
, face
);
24372 /* Get face and two-byte form of character glyph GLYPH on frame F.
24373 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24374 a pointer to a realized face that is ready for display. */
24376 static struct face
*
24377 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24383 eassert (glyph
->type
== CHAR_GLYPH
);
24384 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24386 /* Make sure X resources of the face are allocated. */
24387 eassert (face
!= NULL
);
24388 prepare_face_for_display (f
, face
);
24392 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24393 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24395 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24397 if (code
== FONT_INVALID_CODE
)
24401 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24406 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24407 Return true iff FONT has a glyph for C. */
24410 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24414 if (CHAR_BYTE8_P (c
))
24415 code
= CHAR_TO_BYTE8 (c
);
24417 code
= font
->driver
->encode_char (font
, c
);
24419 if (code
== FONT_INVALID_CODE
)
24421 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24426 /* Fill glyph string S with composition components specified by S->cmp.
24428 BASE_FACE is the base face of the composition.
24429 S->cmp_from is the index of the first component for S.
24431 OVERLAPS non-zero means S should draw the foreground only, and use
24432 its physical height for clipping. See also draw_glyphs.
24434 Value is the index of a component not in S. */
24437 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24441 /* For all glyphs of this composition, starting at the offset
24442 S->cmp_from, until we reach the end of the definition or encounter a
24443 glyph that requires the different face, add it to S. */
24448 s
->for_overlaps
= overlaps
;
24451 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24453 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24455 /* TAB in a composition means display glyphs with padding space
24456 on the left or right. */
24459 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24462 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24463 s
->char2b
+ i
, true);
24469 s
->font
= s
->face
->font
;
24471 else if (s
->face
!= face
)
24479 if (s
->face
== NULL
)
24481 s
->face
= base_face
->ascii_face
;
24482 s
->font
= s
->face
->font
;
24485 /* All glyph strings for the same composition has the same width,
24486 i.e. the width set for the first component of the composition. */
24487 s
->width
= s
->first_glyph
->pixel_width
;
24489 /* If the specified font could not be loaded, use the frame's
24490 default font, but record the fact that we couldn't load it in
24491 the glyph string so that we can draw rectangles for the
24492 characters of the glyph string. */
24493 if (s
->font
== NULL
)
24495 s
->font_not_found_p
= true;
24496 s
->font
= FRAME_FONT (s
->f
);
24499 /* Adjust base line for subscript/superscript text. */
24500 s
->ybase
+= s
->first_glyph
->voffset
;
24506 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24507 int start
, int end
, int overlaps
)
24509 struct glyph
*glyph
, *last
;
24510 Lisp_Object lgstring
;
24513 s
->for_overlaps
= overlaps
;
24514 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24515 last
= s
->row
->glyphs
[s
->area
] + end
;
24516 s
->cmp_id
= glyph
->u
.cmp
.id
;
24517 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24518 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24519 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24520 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24521 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24523 while (glyph
< last
24524 && glyph
->u
.cmp
.automatic
24525 && glyph
->u
.cmp
.id
== s
->cmp_id
24526 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24527 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24529 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24531 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24532 unsigned code
= LGLYPH_CODE (lglyph
);
24534 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24536 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24537 return glyph
- s
->row
->glyphs
[s
->area
];
24541 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24542 See the comment of fill_glyph_string for arguments.
24543 Value is the index of the first glyph not in S. */
24547 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24548 int start
, int end
, int overlaps
)
24550 struct glyph
*glyph
, *last
;
24553 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24554 s
->for_overlaps
= overlaps
;
24555 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24556 last
= s
->row
->glyphs
[s
->area
] + end
;
24557 voffset
= glyph
->voffset
;
24558 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24559 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24561 s
->width
= glyph
->pixel_width
;
24563 while (glyph
< last
24564 && glyph
->type
== GLYPHLESS_GLYPH
24565 && glyph
->voffset
== voffset
24566 && glyph
->face_id
== face_id
)
24569 s
->width
+= glyph
->pixel_width
;
24572 s
->ybase
+= voffset
;
24573 return glyph
- s
->row
->glyphs
[s
->area
];
24577 /* Fill glyph string S from a sequence of character glyphs.
24579 FACE_ID is the face id of the string. START is the index of the
24580 first glyph to consider, END is the index of the last + 1.
24581 OVERLAPS non-zero means S should draw the foreground only, and use
24582 its physical height for clipping. See also draw_glyphs.
24584 Value is the index of the first glyph not in S. */
24587 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24588 int start
, int end
, int overlaps
)
24590 struct glyph
*glyph
, *last
;
24592 bool glyph_not_available_p
;
24594 eassert (s
->f
== XFRAME (s
->w
->frame
));
24595 eassert (s
->nchars
== 0);
24596 eassert (start
>= 0 && end
> start
);
24598 s
->for_overlaps
= overlaps
;
24599 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24600 last
= s
->row
->glyphs
[s
->area
] + end
;
24601 voffset
= glyph
->voffset
;
24602 s
->padding_p
= glyph
->padding_p
;
24603 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24605 while (glyph
< last
24606 && glyph
->type
== CHAR_GLYPH
24607 && glyph
->voffset
== voffset
24608 /* Same face id implies same font, nowadays. */
24609 && glyph
->face_id
== face_id
24610 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24612 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24613 s
->char2b
+ s
->nchars
);
24615 eassert (s
->nchars
<= end
- start
);
24616 s
->width
+= glyph
->pixel_width
;
24617 if (glyph
++->padding_p
!= s
->padding_p
)
24621 s
->font
= s
->face
->font
;
24623 /* If the specified font could not be loaded, use the frame's font,
24624 but record the fact that we couldn't load it in
24625 S->font_not_found_p so that we can draw rectangles for the
24626 characters of the glyph string. */
24627 if (s
->font
== NULL
|| glyph_not_available_p
)
24629 s
->font_not_found_p
= true;
24630 s
->font
= FRAME_FONT (s
->f
);
24633 /* Adjust base line for subscript/superscript text. */
24634 s
->ybase
+= voffset
;
24636 eassert (s
->face
&& s
->face
->gc
);
24637 return glyph
- s
->row
->glyphs
[s
->area
];
24641 /* Fill glyph string S from image glyph S->first_glyph. */
24644 fill_image_glyph_string (struct glyph_string
*s
)
24646 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24647 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24649 s
->slice
= s
->first_glyph
->slice
.img
;
24650 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24651 s
->font
= s
->face
->font
;
24652 s
->width
= s
->first_glyph
->pixel_width
;
24654 /* Adjust base line for subscript/superscript text. */
24655 s
->ybase
+= s
->first_glyph
->voffset
;
24659 /* Fill glyph string S from a sequence of stretch glyphs.
24661 START is the index of the first glyph to consider,
24662 END is the index of the last + 1.
24664 Value is the index of the first glyph not in S. */
24667 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24669 struct glyph
*glyph
, *last
;
24670 int voffset
, face_id
;
24672 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24674 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24675 last
= s
->row
->glyphs
[s
->area
] + end
;
24676 face_id
= glyph
->face_id
;
24677 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24678 s
->font
= s
->face
->font
;
24679 s
->width
= glyph
->pixel_width
;
24681 voffset
= glyph
->voffset
;
24685 && glyph
->type
== STRETCH_GLYPH
24686 && glyph
->voffset
== voffset
24687 && glyph
->face_id
== face_id
);
24689 s
->width
+= glyph
->pixel_width
;
24691 /* Adjust base line for subscript/superscript text. */
24692 s
->ybase
+= voffset
;
24694 /* The case that face->gc == 0 is handled when drawing the glyph
24695 string by calling prepare_face_for_display. */
24697 return glyph
- s
->row
->glyphs
[s
->area
];
24700 static struct font_metrics
*
24701 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24703 static struct font_metrics metrics
;
24708 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24709 if (code
== FONT_INVALID_CODE
)
24711 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24715 /* A subroutine that computes "normal" values of ASCENT and DESCENT
24716 for FONT. Values are taken from font-global ones, except for fonts
24717 that claim preposterously large values, but whose glyphs actually
24718 have reasonable dimensions. C is the character to use for metrics
24719 if the font-global values are too large; if C is negative, the
24720 function selects a default character. */
24722 normal_char_ascent_descent (struct font
*font
, int c
, int *ascent
, int *descent
)
24724 *ascent
= FONT_BASE (font
);
24725 *descent
= FONT_DESCENT (font
);
24727 if (FONT_TOO_HIGH (font
))
24731 /* Get metrics of C, defaulting to a reasonably sized ASCII
24733 if (get_char_glyph_code (c
>= 0 ? c
: '{', font
, &char2b
))
24735 struct font_metrics
*pcm
= get_per_char_metric (font
, &char2b
);
24737 if (!(pcm
->width
== 0 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0))
24739 /* We add 1 pixel to character dimensions as heuristics
24740 that produces nicer display, e.g. when the face has
24741 the box attribute. */
24742 *ascent
= pcm
->ascent
+ 1;
24743 *descent
= pcm
->descent
+ 1;
24749 /* A subroutine that computes a reasonable "normal character height"
24750 for fonts that claim preposterously large vertical dimensions, but
24751 whose glyphs are actually reasonably sized. C is the character
24752 whose metrics to use for those fonts, or -1 for default
24755 normal_char_height (struct font
*font
, int c
)
24757 int ascent
, descent
;
24759 normal_char_ascent_descent (font
, c
, &ascent
, &descent
);
24761 return ascent
+ descent
;
24765 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24766 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24767 assumed to be zero. */
24770 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24772 *left
= *right
= 0;
24774 if (glyph
->type
== CHAR_GLYPH
)
24777 struct face
*face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
);
24780 struct font_metrics
*pcm
= get_per_char_metric (face
->font
, &char2b
);
24783 if (pcm
->rbearing
> pcm
->width
)
24784 *right
= pcm
->rbearing
- pcm
->width
;
24785 if (pcm
->lbearing
< 0)
24786 *left
= -pcm
->lbearing
;
24790 else if (glyph
->type
== COMPOSITE_GLYPH
)
24792 if (! glyph
->u
.cmp
.automatic
)
24794 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24796 if (cmp
->rbearing
> cmp
->pixel_width
)
24797 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24798 if (cmp
->lbearing
< 0)
24799 *left
= - cmp
->lbearing
;
24803 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24804 struct font_metrics metrics
;
24806 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24807 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24808 if (metrics
.rbearing
> metrics
.width
)
24809 *right
= metrics
.rbearing
- metrics
.width
;
24810 if (metrics
.lbearing
< 0)
24811 *left
= - metrics
.lbearing
;
24817 /* Return the index of the first glyph preceding glyph string S that
24818 is overwritten by S because of S's left overhang. Value is -1
24819 if no glyphs are overwritten. */
24822 left_overwritten (struct glyph_string
*s
)
24826 if (s
->left_overhang
)
24829 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24830 int first
= s
->first_glyph
- glyphs
;
24832 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24833 x
-= glyphs
[i
].pixel_width
;
24844 /* Return the index of the first glyph preceding glyph string S that
24845 is overwriting S because of its right overhang. Value is -1 if no
24846 glyph in front of S overwrites S. */
24849 left_overwriting (struct glyph_string
*s
)
24852 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24853 int first
= s
->first_glyph
- glyphs
;
24857 for (i
= first
- 1; i
>= 0; --i
)
24860 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24863 x
-= glyphs
[i
].pixel_width
;
24870 /* Return the index of the last glyph following glyph string S that is
24871 overwritten by S because of S's right overhang. Value is -1 if
24872 no such glyph is found. */
24875 right_overwritten (struct glyph_string
*s
)
24879 if (s
->right_overhang
)
24882 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24883 int first
= (s
->first_glyph
- glyphs
24884 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24885 int end
= s
->row
->used
[s
->area
];
24887 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24888 x
+= glyphs
[i
].pixel_width
;
24897 /* Return the index of the last glyph following glyph string S that
24898 overwrites S because of its left overhang. Value is negative
24899 if no such glyph is found. */
24902 right_overwriting (struct glyph_string
*s
)
24905 int end
= s
->row
->used
[s
->area
];
24906 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24907 int first
= (s
->first_glyph
- glyphs
24908 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24912 for (i
= first
; i
< end
; ++i
)
24915 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24918 x
+= glyphs
[i
].pixel_width
;
24925 /* Set background width of glyph string S. START is the index of the
24926 first glyph following S. LAST_X is the right-most x-position + 1
24927 in the drawing area. */
24930 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24932 /* If the face of this glyph string has to be drawn to the end of
24933 the drawing area, set S->extends_to_end_of_line_p. */
24935 if (start
== s
->row
->used
[s
->area
]
24936 && ((s
->row
->fill_line_p
24937 && (s
->hl
== DRAW_NORMAL_TEXT
24938 || s
->hl
== DRAW_IMAGE_RAISED
24939 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24940 || s
->hl
== DRAW_MOUSE_FACE
))
24941 s
->extends_to_end_of_line_p
= true;
24943 /* If S extends its face to the end of the line, set its
24944 background_width to the distance to the right edge of the drawing
24946 if (s
->extends_to_end_of_line_p
)
24947 s
->background_width
= last_x
- s
->x
+ 1;
24949 s
->background_width
= s
->width
;
24953 /* Compute overhangs and x-positions for glyph string S and its
24954 predecessors, or successors. X is the starting x-position for S.
24955 BACKWARD_P means process predecessors. */
24958 compute_overhangs_and_x (struct glyph_string
*s
, int x
, bool backward_p
)
24964 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24965 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24975 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24976 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24986 /* The following macros are only called from draw_glyphs below.
24987 They reference the following parameters of that function directly:
24988 `w', `row', `area', and `overlap_p'
24989 as well as the following local variables:
24990 `s', `f', and `hdc' (in W32) */
24993 /* On W32, silently add local `hdc' variable to argument list of
24994 init_glyph_string. */
24995 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24996 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24998 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24999 init_glyph_string (s, char2b, w, row, area, start, hl)
25002 /* Add a glyph string for a stretch glyph to the list of strings
25003 between HEAD and TAIL. START is the index of the stretch glyph in
25004 row area AREA of glyph row ROW. END is the index of the last glyph
25005 in that glyph row area. X is the current output position assigned
25006 to the new glyph string constructed. HL overrides that face of the
25007 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25008 is the right-most x-position of the drawing area. */
25010 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25011 and below -- keep them on one line. */
25012 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25015 s = alloca (sizeof *s); \
25016 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25017 START = fill_stretch_glyph_string (s, START, END); \
25018 append_glyph_string (&HEAD, &TAIL, s); \
25024 /* Add a glyph string for an image glyph to the list of strings
25025 between HEAD and TAIL. START is the index of the image glyph in
25026 row area AREA of glyph row ROW. END is the index of the last glyph
25027 in that glyph row area. X is the current output position assigned
25028 to the new glyph string constructed. HL overrides that face of the
25029 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25030 is the right-most x-position of the drawing area. */
25032 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25035 s = alloca (sizeof *s); \
25036 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25037 fill_image_glyph_string (s); \
25038 append_glyph_string (&HEAD, &TAIL, s); \
25045 /* Add a glyph string for a sequence of character glyphs to the list
25046 of strings between HEAD and TAIL. START is the index of the first
25047 glyph in row area AREA of glyph row ROW that is part of the new
25048 glyph string. END is the index of the last glyph in that glyph row
25049 area. X is the current output position assigned to the new glyph
25050 string constructed. HL overrides that face of the glyph; e.g. it
25051 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25052 right-most x-position of the drawing area. */
25054 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25060 face_id = (row)->glyphs[area][START].face_id; \
25062 s = alloca (sizeof *s); \
25063 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25064 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25065 append_glyph_string (&HEAD, &TAIL, s); \
25067 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25072 /* Add a glyph string for a composite sequence to the list of strings
25073 between HEAD and TAIL. START is the index of the first glyph in
25074 row area AREA of glyph row ROW that is part of the new glyph
25075 string. END is the index of the last glyph in that glyph row area.
25076 X is the current output position assigned to the new glyph string
25077 constructed. HL overrides that face of the glyph; e.g. it is
25078 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25079 x-position of the drawing area. */
25081 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25083 int face_id = (row)->glyphs[area][START].face_id; \
25084 struct face *base_face = FACE_FROM_ID (f, face_id); \
25085 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25086 struct composition *cmp = composition_table[cmp_id]; \
25088 struct glyph_string *first_s = NULL; \
25091 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25093 /* Make glyph_strings for each glyph sequence that is drawable by \
25094 the same face, and append them to HEAD/TAIL. */ \
25095 for (n = 0; n < cmp->glyph_len;) \
25097 s = alloca (sizeof *s); \
25098 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25099 append_glyph_string (&(HEAD), &(TAIL), s); \
25105 n = fill_composite_glyph_string (s, base_face, overlaps); \
25113 /* Add a glyph string for a glyph-string sequence to the list of strings
25114 between HEAD and TAIL. */
25116 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25120 Lisp_Object gstring; \
25122 face_id = (row)->glyphs[area][START].face_id; \
25123 gstring = (composition_gstring_from_id \
25124 ((row)->glyphs[area][START].u.cmp.id)); \
25125 s = alloca (sizeof *s); \
25126 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25127 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25128 append_glyph_string (&(HEAD), &(TAIL), s); \
25130 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25134 /* Add a glyph string for a sequence of glyphless character's glyphs
25135 to the list of strings between HEAD and TAIL. The meanings of
25136 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25138 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25143 face_id = (row)->glyphs[area][START].face_id; \
25145 s = alloca (sizeof *s); \
25146 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25147 append_glyph_string (&HEAD, &TAIL, s); \
25149 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25155 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25156 of AREA of glyph row ROW on window W between indices START and END.
25157 HL overrides the face for drawing glyph strings, e.g. it is
25158 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25159 x-positions of the drawing area.
25161 This is an ugly monster macro construct because we must use alloca
25162 to allocate glyph strings (because draw_glyphs can be called
25163 asynchronously). */
25165 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25168 HEAD = TAIL = NULL; \
25169 while (START < END) \
25171 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25172 switch (first_glyph->type) \
25175 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25179 case COMPOSITE_GLYPH: \
25180 if (first_glyph->u.cmp.automatic) \
25181 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25184 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25188 case STRETCH_GLYPH: \
25189 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25193 case IMAGE_GLYPH: \
25194 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25198 case GLYPHLESS_GLYPH: \
25199 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25209 set_glyph_string_background_width (s, START, LAST_X); \
25216 /* Draw glyphs between START and END in AREA of ROW on window W,
25217 starting at x-position X. X is relative to AREA in W. HL is a
25218 face-override with the following meaning:
25220 DRAW_NORMAL_TEXT draw normally
25221 DRAW_CURSOR draw in cursor face
25222 DRAW_MOUSE_FACE draw in mouse face.
25223 DRAW_INVERSE_VIDEO draw in mode line face
25224 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25225 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25227 If OVERLAPS is non-zero, draw only the foreground of characters and
25228 clip to the physical height of ROW. Non-zero value also defines
25229 the overlapping part to be drawn:
25231 OVERLAPS_PRED overlap with preceding rows
25232 OVERLAPS_SUCC overlap with succeeding rows
25233 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25234 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25236 Value is the x-position reached, relative to AREA of W. */
25239 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
25240 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
25241 enum draw_glyphs_face hl
, int overlaps
)
25243 struct glyph_string
*head
, *tail
;
25244 struct glyph_string
*s
;
25245 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
25246 int i
, j
, x_reached
, last_x
, area_left
= 0;
25247 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25250 ALLOCATE_HDC (hdc
, f
);
25252 /* Let's rather be paranoid than getting a SEGV. */
25253 end
= min (end
, row
->used
[area
]);
25254 start
= clip_to_bounds (0, start
, end
);
25256 /* Translate X to frame coordinates. Set last_x to the right
25257 end of the drawing area. */
25258 if (row
->full_width_p
)
25260 /* X is relative to the left edge of W, without scroll bars
25262 area_left
= WINDOW_LEFT_EDGE_X (w
);
25263 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25264 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25268 area_left
= window_box_left (w
, area
);
25269 last_x
= area_left
+ window_box_width (w
, area
);
25273 /* Build a doubly-linked list of glyph_string structures between
25274 head and tail from what we have to draw. Note that the macro
25275 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25276 the reason we use a separate variable `i'. */
25279 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25281 x_reached
= tail
->x
+ tail
->background_width
;
25285 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25286 the row, redraw some glyphs in front or following the glyph
25287 strings built above. */
25288 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25290 struct glyph_string
*h
, *t
;
25291 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25292 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25293 bool check_mouse_face
= false;
25296 /* If mouse highlighting is on, we may need to draw adjacent
25297 glyphs using mouse-face highlighting. */
25298 if (area
== TEXT_AREA
&& row
->mouse_face_p
25299 && hlinfo
->mouse_face_beg_row
>= 0
25300 && hlinfo
->mouse_face_end_row
>= 0)
25302 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25304 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25305 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25307 check_mouse_face
= true;
25308 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25309 ? hlinfo
->mouse_face_beg_col
: 0;
25310 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25311 ? hlinfo
->mouse_face_end_col
25312 : row
->used
[TEXT_AREA
];
25316 /* Compute overhangs for all glyph strings. */
25317 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25318 for (s
= head
; s
; s
= s
->next
)
25319 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25321 /* Prepend glyph strings for glyphs in front of the first glyph
25322 string that are overwritten because of the first glyph
25323 string's left overhang. The background of all strings
25324 prepended must be drawn because the first glyph string
25326 i
= left_overwritten (head
);
25329 enum draw_glyphs_face overlap_hl
;
25331 /* If this row contains mouse highlighting, attempt to draw
25332 the overlapped glyphs with the correct highlight. This
25333 code fails if the overlap encompasses more than one glyph
25334 and mouse-highlight spans only some of these glyphs.
25335 However, making it work perfectly involves a lot more
25336 code, and I don't know if the pathological case occurs in
25337 practice, so we'll stick to this for now. --- cyd */
25338 if (check_mouse_face
25339 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25340 overlap_hl
= DRAW_MOUSE_FACE
;
25342 overlap_hl
= DRAW_NORMAL_TEXT
;
25344 if (hl
!= overlap_hl
)
25347 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25348 overlap_hl
, dummy_x
, last_x
);
25350 compute_overhangs_and_x (t
, head
->x
, true);
25351 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25352 if (clip_head
== NULL
)
25356 /* Prepend glyph strings for glyphs in front of the first glyph
25357 string that overwrite that glyph string because of their
25358 right overhang. For these strings, only the foreground must
25359 be drawn, because it draws over the glyph string at `head'.
25360 The background must not be drawn because this would overwrite
25361 right overhangs of preceding glyphs for which no glyph
25363 i
= left_overwriting (head
);
25366 enum draw_glyphs_face overlap_hl
;
25368 if (check_mouse_face
25369 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25370 overlap_hl
= DRAW_MOUSE_FACE
;
25372 overlap_hl
= DRAW_NORMAL_TEXT
;
25374 if (hl
== overlap_hl
|| clip_head
== NULL
)
25376 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25377 overlap_hl
, dummy_x
, last_x
);
25378 for (s
= h
; s
; s
= s
->next
)
25379 s
->background_filled_p
= true;
25380 compute_overhangs_and_x (t
, head
->x
, true);
25381 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25384 /* Append glyphs strings for glyphs following the last glyph
25385 string tail that are overwritten by tail. The background of
25386 these strings has to be drawn because tail's foreground draws
25388 i
= right_overwritten (tail
);
25391 enum draw_glyphs_face overlap_hl
;
25393 if (check_mouse_face
25394 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25395 overlap_hl
= DRAW_MOUSE_FACE
;
25397 overlap_hl
= DRAW_NORMAL_TEXT
;
25399 if (hl
!= overlap_hl
)
25401 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25402 overlap_hl
, x
, last_x
);
25403 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25404 we don't have `end = i;' here. */
25405 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25406 append_glyph_string_lists (&head
, &tail
, h
, t
);
25407 if (clip_tail
== NULL
)
25411 /* Append glyph strings for glyphs following the last glyph
25412 string tail that overwrite tail. The foreground of such
25413 glyphs has to be drawn because it writes into the background
25414 of tail. The background must not be drawn because it could
25415 paint over the foreground of following glyphs. */
25416 i
= right_overwriting (tail
);
25419 enum draw_glyphs_face overlap_hl
;
25420 if (check_mouse_face
25421 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25422 overlap_hl
= DRAW_MOUSE_FACE
;
25424 overlap_hl
= DRAW_NORMAL_TEXT
;
25426 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25428 i
++; /* We must include the Ith glyph. */
25429 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25430 overlap_hl
, x
, last_x
);
25431 for (s
= h
; s
; s
= s
->next
)
25432 s
->background_filled_p
= true;
25433 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, false);
25434 append_glyph_string_lists (&head
, &tail
, h
, t
);
25436 if (clip_head
|| clip_tail
)
25437 for (s
= head
; s
; s
= s
->next
)
25439 s
->clip_head
= clip_head
;
25440 s
->clip_tail
= clip_tail
;
25444 /* Draw all strings. */
25445 for (s
= head
; s
; s
= s
->next
)
25446 FRAME_RIF (f
)->draw_glyph_string (s
);
25449 /* When focus a sole frame and move horizontally, this clears on_p
25450 causing a failure to erase prev cursor position. */
25451 if (area
== TEXT_AREA
25452 && !row
->full_width_p
25453 /* When drawing overlapping rows, only the glyph strings'
25454 foreground is drawn, which doesn't erase a cursor
25458 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25459 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25460 : (tail
? tail
->x
+ tail
->background_width
: x
));
25464 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25465 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25469 /* Value is the x-position up to which drawn, relative to AREA of W.
25470 This doesn't include parts drawn because of overhangs. */
25471 if (row
->full_width_p
)
25472 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25474 x_reached
-= area_left
;
25476 RELEASE_HDC (hdc
, f
);
25482 /* Expand row matrix if too narrow. Don't expand if area
25485 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25487 if (!it->f->fonts_changed \
25488 && (it->glyph_row->glyphs[area] \
25489 < it->glyph_row->glyphs[area + 1])) \
25491 it->w->ncols_scale_factor++; \
25492 it->f->fonts_changed = true; \
25496 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25497 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25500 append_glyph (struct it
*it
)
25502 struct glyph
*glyph
;
25503 enum glyph_row_area area
= it
->area
;
25505 eassert (it
->glyph_row
);
25506 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25508 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25509 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25511 /* If the glyph row is reversed, we need to prepend the glyph
25512 rather than append it. */
25513 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25517 /* Make room for the additional glyph. */
25518 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25520 glyph
= it
->glyph_row
->glyphs
[area
];
25522 glyph
->charpos
= CHARPOS (it
->position
);
25523 glyph
->object
= it
->object
;
25524 if (it
->pixel_width
> 0)
25526 glyph
->pixel_width
= it
->pixel_width
;
25527 glyph
->padding_p
= false;
25531 /* Assure at least 1-pixel width. Otherwise, cursor can't
25532 be displayed correctly. */
25533 glyph
->pixel_width
= 1;
25534 glyph
->padding_p
= true;
25536 glyph
->ascent
= it
->ascent
;
25537 glyph
->descent
= it
->descent
;
25538 glyph
->voffset
= it
->voffset
;
25539 glyph
->type
= CHAR_GLYPH
;
25540 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25541 glyph
->multibyte_p
= it
->multibyte_p
;
25542 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25544 /* In R2L rows, the left and the right box edges need to be
25545 drawn in reverse direction. */
25546 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25547 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25551 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25552 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25554 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25555 || it
->phys_descent
> it
->descent
);
25556 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25557 glyph
->face_id
= it
->face_id
;
25558 glyph
->u
.ch
= it
->char_to_display
;
25559 glyph
->slice
.img
= null_glyph_slice
;
25560 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25563 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25564 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25565 glyph
->bidi_type
= it
->bidi_it
.type
;
25569 glyph
->resolved_level
= 0;
25570 glyph
->bidi_type
= UNKNOWN_BT
;
25572 ++it
->glyph_row
->used
[area
];
25575 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25578 /* Store one glyph for the composition IT->cmp_it.id in
25579 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25583 append_composite_glyph (struct it
*it
)
25585 struct glyph
*glyph
;
25586 enum glyph_row_area area
= it
->area
;
25588 eassert (it
->glyph_row
);
25590 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25591 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25593 /* If the glyph row is reversed, we need to prepend the glyph
25594 rather than append it. */
25595 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25599 /* Make room for the new glyph. */
25600 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25602 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25604 glyph
->charpos
= it
->cmp_it
.charpos
;
25605 glyph
->object
= it
->object
;
25606 glyph
->pixel_width
= it
->pixel_width
;
25607 glyph
->ascent
= it
->ascent
;
25608 glyph
->descent
= it
->descent
;
25609 glyph
->voffset
= it
->voffset
;
25610 glyph
->type
= COMPOSITE_GLYPH
;
25611 if (it
->cmp_it
.ch
< 0)
25613 glyph
->u
.cmp
.automatic
= false;
25614 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25615 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25619 glyph
->u
.cmp
.automatic
= true;
25620 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25621 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25622 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25624 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25625 glyph
->multibyte_p
= it
->multibyte_p
;
25626 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25628 /* In R2L rows, the left and the right box edges need to be
25629 drawn in reverse direction. */
25630 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25631 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25635 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25636 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25638 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25639 || it
->phys_descent
> it
->descent
);
25640 glyph
->padding_p
= false;
25641 glyph
->glyph_not_available_p
= false;
25642 glyph
->face_id
= it
->face_id
;
25643 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25646 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25647 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25648 glyph
->bidi_type
= it
->bidi_it
.type
;
25650 ++it
->glyph_row
->used
[area
];
25653 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25657 /* Change IT->ascent and IT->height according to the setting of
25661 take_vertical_position_into_account (struct it
*it
)
25665 if (it
->voffset
< 0)
25666 /* Increase the ascent so that we can display the text higher
25668 it
->ascent
-= it
->voffset
;
25670 /* Increase the descent so that we can display the text lower
25672 it
->descent
+= it
->voffset
;
25677 /* Produce glyphs/get display metrics for the image IT is loaded with.
25678 See the description of struct display_iterator in dispextern.h for
25679 an overview of struct display_iterator. */
25682 produce_image_glyph (struct it
*it
)
25686 int glyph_ascent
, crop
;
25687 struct glyph_slice slice
;
25689 eassert (it
->what
== IT_IMAGE
);
25691 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25693 /* Make sure X resources of the face is loaded. */
25694 prepare_face_for_display (it
->f
, face
);
25696 if (it
->image_id
< 0)
25698 /* Fringe bitmap. */
25699 it
->ascent
= it
->phys_ascent
= 0;
25700 it
->descent
= it
->phys_descent
= 0;
25701 it
->pixel_width
= 0;
25706 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25708 /* Make sure X resources of the image is loaded. */
25709 prepare_image_for_display (it
->f
, img
);
25711 slice
.x
= slice
.y
= 0;
25712 slice
.width
= img
->width
;
25713 slice
.height
= img
->height
;
25715 if (INTEGERP (it
->slice
.x
))
25716 slice
.x
= XINT (it
->slice
.x
);
25717 else if (FLOATP (it
->slice
.x
))
25718 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25720 if (INTEGERP (it
->slice
.y
))
25721 slice
.y
= XINT (it
->slice
.y
);
25722 else if (FLOATP (it
->slice
.y
))
25723 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25725 if (INTEGERP (it
->slice
.width
))
25726 slice
.width
= XINT (it
->slice
.width
);
25727 else if (FLOATP (it
->slice
.width
))
25728 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25730 if (INTEGERP (it
->slice
.height
))
25731 slice
.height
= XINT (it
->slice
.height
);
25732 else if (FLOATP (it
->slice
.height
))
25733 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25735 if (slice
.x
>= img
->width
)
25736 slice
.x
= img
->width
;
25737 if (slice
.y
>= img
->height
)
25738 slice
.y
= img
->height
;
25739 if (slice
.x
+ slice
.width
>= img
->width
)
25740 slice
.width
= img
->width
- slice
.x
;
25741 if (slice
.y
+ slice
.height
> img
->height
)
25742 slice
.height
= img
->height
- slice
.y
;
25744 if (slice
.width
== 0 || slice
.height
== 0)
25747 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25749 it
->descent
= slice
.height
- glyph_ascent
;
25751 it
->descent
+= img
->vmargin
;
25752 if (slice
.y
+ slice
.height
== img
->height
)
25753 it
->descent
+= img
->vmargin
;
25754 it
->phys_descent
= it
->descent
;
25756 it
->pixel_width
= slice
.width
;
25758 it
->pixel_width
+= img
->hmargin
;
25759 if (slice
.x
+ slice
.width
== img
->width
)
25760 it
->pixel_width
+= img
->hmargin
;
25762 /* It's quite possible for images to have an ascent greater than
25763 their height, so don't get confused in that case. */
25764 if (it
->descent
< 0)
25769 if (face
->box
!= FACE_NO_BOX
)
25771 if (face
->box_line_width
> 0)
25774 it
->ascent
+= face
->box_line_width
;
25775 if (slice
.y
+ slice
.height
== img
->height
)
25776 it
->descent
+= face
->box_line_width
;
25779 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25780 it
->pixel_width
+= eabs (face
->box_line_width
);
25781 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25782 it
->pixel_width
+= eabs (face
->box_line_width
);
25785 take_vertical_position_into_account (it
);
25787 /* Automatically crop wide image glyphs at right edge so we can
25788 draw the cursor on same display row. */
25789 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25790 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25792 it
->pixel_width
-= crop
;
25793 slice
.width
-= crop
;
25798 struct glyph
*glyph
;
25799 enum glyph_row_area area
= it
->area
;
25801 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25802 if (it
->glyph_row
->reversed_p
)
25806 /* Make room for the new glyph. */
25807 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25809 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25811 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25813 glyph
->charpos
= CHARPOS (it
->position
);
25814 glyph
->object
= it
->object
;
25815 glyph
->pixel_width
= it
->pixel_width
;
25816 glyph
->ascent
= glyph_ascent
;
25817 glyph
->descent
= it
->descent
;
25818 glyph
->voffset
= it
->voffset
;
25819 glyph
->type
= IMAGE_GLYPH
;
25820 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25821 glyph
->multibyte_p
= it
->multibyte_p
;
25822 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25824 /* In R2L rows, the left and the right box edges need to be
25825 drawn in reverse direction. */
25826 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25827 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25831 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25832 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25834 glyph
->overlaps_vertically_p
= false;
25835 glyph
->padding_p
= false;
25836 glyph
->glyph_not_available_p
= false;
25837 glyph
->face_id
= it
->face_id
;
25838 glyph
->u
.img_id
= img
->id
;
25839 glyph
->slice
.img
= slice
;
25840 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25843 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25844 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25845 glyph
->bidi_type
= it
->bidi_it
.type
;
25847 ++it
->glyph_row
->used
[area
];
25850 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25855 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25856 of the glyph, WIDTH and HEIGHT are the width and height of the
25857 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25860 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25861 int width
, int height
, int ascent
)
25863 struct glyph
*glyph
;
25864 enum glyph_row_area area
= it
->area
;
25866 eassert (ascent
>= 0 && ascent
<= height
);
25868 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25869 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25871 /* If the glyph row is reversed, we need to prepend the glyph
25872 rather than append it. */
25873 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25877 /* Make room for the additional glyph. */
25878 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25880 glyph
= it
->glyph_row
->glyphs
[area
];
25882 /* Decrease the width of the first glyph of the row that
25883 begins before first_visible_x (e.g., due to hscroll).
25884 This is so the overall width of the row becomes smaller
25885 by the scroll amount, and the stretch glyph appended by
25886 extend_face_to_end_of_line will be wider, to shift the
25887 row glyphs to the right. (In L2R rows, the corresponding
25888 left-shift effect is accomplished by setting row->x to a
25889 negative value, which won't work with R2L rows.)
25891 This must leave us with a positive value of WIDTH, since
25892 otherwise the call to move_it_in_display_line_to at the
25893 beginning of display_line would have got past the entire
25894 first glyph, and then it->current_x would have been
25895 greater or equal to it->first_visible_x. */
25896 if (it
->current_x
< it
->first_visible_x
)
25897 width
-= it
->first_visible_x
- it
->current_x
;
25898 eassert (width
> 0);
25900 glyph
->charpos
= CHARPOS (it
->position
);
25901 glyph
->object
= object
;
25902 glyph
->pixel_width
= width
;
25903 glyph
->ascent
= ascent
;
25904 glyph
->descent
= height
- ascent
;
25905 glyph
->voffset
= it
->voffset
;
25906 glyph
->type
= STRETCH_GLYPH
;
25907 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25908 glyph
->multibyte_p
= it
->multibyte_p
;
25909 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25911 /* In R2L rows, the left and the right box edges need to be
25912 drawn in reverse direction. */
25913 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25914 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25918 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25919 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25921 glyph
->overlaps_vertically_p
= false;
25922 glyph
->padding_p
= false;
25923 glyph
->glyph_not_available_p
= false;
25924 glyph
->face_id
= it
->face_id
;
25925 glyph
->u
.stretch
.ascent
= ascent
;
25926 glyph
->u
.stretch
.height
= height
;
25927 glyph
->slice
.img
= null_glyph_slice
;
25928 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25931 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25932 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25933 glyph
->bidi_type
= it
->bidi_it
.type
;
25937 glyph
->resolved_level
= 0;
25938 glyph
->bidi_type
= UNKNOWN_BT
;
25940 ++it
->glyph_row
->used
[area
];
25943 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25946 #endif /* HAVE_WINDOW_SYSTEM */
25948 /* Produce a stretch glyph for iterator IT. IT->object is the value
25949 of the glyph property displayed. The value must be a list
25950 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25953 1. `:width WIDTH' specifies that the space should be WIDTH *
25954 canonical char width wide. WIDTH may be an integer or floating
25957 2. `:relative-width FACTOR' specifies that the width of the stretch
25958 should be computed from the width of the first character having the
25959 `glyph' property, and should be FACTOR times that width.
25961 3. `:align-to HPOS' specifies that the space should be wide enough
25962 to reach HPOS, a value in canonical character units.
25964 Exactly one of the above pairs must be present.
25966 4. `:height HEIGHT' specifies that the height of the stretch produced
25967 should be HEIGHT, measured in canonical character units.
25969 5. `:relative-height FACTOR' specifies that the height of the
25970 stretch should be FACTOR times the height of the characters having
25971 the glyph property.
25973 Either none or exactly one of 4 or 5 must be present.
25975 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25976 of the stretch should be used for the ascent of the stretch.
25977 ASCENT must be in the range 0 <= ASCENT <= 100. */
25980 produce_stretch_glyph (struct it
*it
)
25982 /* (space :width WIDTH :height HEIGHT ...) */
25983 Lisp_Object prop
, plist
;
25984 int width
= 0, height
= 0, align_to
= -1;
25985 bool zero_width_ok_p
= false;
25987 struct font
*font
= NULL
;
25989 #ifdef HAVE_WINDOW_SYSTEM
25991 bool zero_height_ok_p
= false;
25993 if (FRAME_WINDOW_P (it
->f
))
25995 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25996 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25997 prepare_face_for_display (it
->f
, face
);
26001 /* List should start with `space'. */
26002 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
26003 plist
= XCDR (it
->object
);
26005 /* Compute the width of the stretch. */
26006 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
26007 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true, 0))
26009 /* Absolute width `:width WIDTH' specified and valid. */
26010 zero_width_ok_p
= true;
26013 else if (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0)
26015 /* Relative width `:relative-width FACTOR' specified and valid.
26016 Compute the width of the characters having the `glyph'
26019 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
26022 if (it
->multibyte_p
)
26023 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
26026 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
26027 if (! ASCII_CHAR_P (it2
.c
))
26028 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
26031 it2
.glyph_row
= NULL
;
26032 it2
.what
= IT_CHARACTER
;
26033 PRODUCE_GLYPHS (&it2
);
26034 width
= NUMVAL (prop
) * it2
.pixel_width
;
26036 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
26037 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, true,
26040 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
26041 align_to
= (align_to
< 0
26043 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
26044 else if (align_to
< 0)
26045 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
26046 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
26047 zero_width_ok_p
= true;
26050 /* Nothing specified -> width defaults to canonical char width. */
26051 width
= FRAME_COLUMN_WIDTH (it
->f
);
26053 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
26056 #ifdef HAVE_WINDOW_SYSTEM
26057 /* Compute height. */
26058 if (FRAME_WINDOW_P (it
->f
))
26060 int default_height
= normal_char_height (font
, ' ');
26062 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
26063 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26066 zero_height_ok_p
= true;
26068 else if (prop
= Fplist_get (plist
, QCrelative_height
),
26070 height
= default_height
* NUMVAL (prop
);
26072 height
= default_height
;
26074 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
26077 /* Compute percentage of height used for ascent. If
26078 `:ascent ASCENT' is present and valid, use that. Otherwise,
26079 derive the ascent from the font in use. */
26080 if (prop
= Fplist_get (plist
, QCascent
),
26081 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
26082 ascent
= height
* NUMVAL (prop
) / 100.0;
26083 else if (!NILP (prop
)
26084 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, false, 0))
26085 ascent
= min (max (0, (int)tem
), height
);
26087 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
26090 #endif /* HAVE_WINDOW_SYSTEM */
26093 if (width
> 0 && it
->line_wrap
!= TRUNCATE
26094 && it
->current_x
+ width
> it
->last_visible_x
)
26096 width
= it
->last_visible_x
- it
->current_x
;
26097 #ifdef HAVE_WINDOW_SYSTEM
26098 /* Subtract one more pixel from the stretch width, but only on
26099 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26100 width
-= FRAME_WINDOW_P (it
->f
);
26104 if (width
> 0 && height
> 0 && it
->glyph_row
)
26106 Lisp_Object o_object
= it
->object
;
26107 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
26110 if (!STRINGP (object
))
26111 object
= it
->w
->contents
;
26112 #ifdef HAVE_WINDOW_SYSTEM
26113 if (FRAME_WINDOW_P (it
->f
))
26114 append_stretch_glyph (it
, object
, width
, height
, ascent
);
26118 it
->object
= object
;
26119 it
->char_to_display
= ' ';
26120 it
->pixel_width
= it
->len
= 1;
26122 tty_append_glyph (it
);
26123 it
->object
= o_object
;
26127 it
->pixel_width
= width
;
26128 #ifdef HAVE_WINDOW_SYSTEM
26129 if (FRAME_WINDOW_P (it
->f
))
26131 it
->ascent
= it
->phys_ascent
= ascent
;
26132 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
26133 it
->nglyphs
= width
> 0 && height
> 0;
26134 take_vertical_position_into_account (it
);
26138 it
->nglyphs
= width
;
26141 /* Get information about special display element WHAT in an
26142 environment described by IT. WHAT is one of IT_TRUNCATION or
26143 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26144 non-null glyph_row member. This function ensures that fields like
26145 face_id, c, len of IT are left untouched. */
26148 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
26155 temp_it
.object
= Qnil
;
26156 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
26158 if (what
== IT_CONTINUATION
)
26160 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26161 if (it
->bidi_it
.paragraph_dir
== R2L
)
26162 SET_GLYPH_FROM_CHAR (glyph
, '/');
26164 SET_GLYPH_FROM_CHAR (glyph
, '\\');
26166 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26168 /* FIXME: Should we mirror GC for R2L lines? */
26169 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26170 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26173 else if (what
== IT_TRUNCATION
)
26175 /* Truncation glyph. */
26176 SET_GLYPH_FROM_CHAR (glyph
, '$');
26178 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
26180 /* FIXME: Should we mirror GC for R2L lines? */
26181 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
26182 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
26188 #ifdef HAVE_WINDOW_SYSTEM
26189 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26190 is turned off, we precede the truncation/continuation glyphs by a
26191 stretch glyph whose width is computed such that these special
26192 glyphs are aligned at the window margin, even when very different
26193 fonts are used in different glyph rows. */
26194 if (FRAME_WINDOW_P (temp_it
.f
)
26195 /* init_iterator calls this with it->glyph_row == NULL, and it
26196 wants only the pixel width of the truncation/continuation
26198 && temp_it
.glyph_row
26199 /* insert_left_trunc_glyphs calls us at the beginning of the
26200 row, and it has its own calculation of the stretch glyph
26202 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
26203 && (temp_it
.glyph_row
->reversed_p
26204 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
26205 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
26207 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
26209 if (stretch_width
> 0)
26211 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
26212 struct font
*font
=
26213 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
26214 int stretch_ascent
=
26215 (((temp_it
.ascent
+ temp_it
.descent
)
26216 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
26218 append_stretch_glyph (&temp_it
, Qnil
, stretch_width
,
26219 temp_it
.ascent
+ temp_it
.descent
,
26226 temp_it
.what
= IT_CHARACTER
;
26227 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
26228 temp_it
.face_id
= GLYPH_FACE (glyph
);
26229 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
26231 PRODUCE_GLYPHS (&temp_it
);
26232 it
->pixel_width
= temp_it
.pixel_width
;
26233 it
->nglyphs
= temp_it
.nglyphs
;
26236 #ifdef HAVE_WINDOW_SYSTEM
26238 /* Calculate line-height and line-spacing properties.
26239 An integer value specifies explicit pixel value.
26240 A float value specifies relative value to current face height.
26241 A cons (float . face-name) specifies relative value to
26242 height of specified face font.
26244 Returns height in pixels, or nil. */
26247 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
26248 int boff
, bool override
)
26250 Lisp_Object face_name
= Qnil
;
26251 int ascent
, descent
, height
;
26253 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
26258 face_name
= XCAR (val
);
26260 if (!NUMBERP (val
))
26261 val
= make_number (1);
26262 if (NILP (face_name
))
26264 height
= it
->ascent
+ it
->descent
;
26269 if (NILP (face_name
))
26271 font
= FRAME_FONT (it
->f
);
26272 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26274 else if (EQ (face_name
, Qt
))
26283 face_id
= lookup_named_face (it
->f
, face_name
, false);
26285 return make_number (-1);
26287 face
= FACE_FROM_ID (it
->f
, face_id
);
26290 return make_number (-1);
26291 boff
= font
->baseline_offset
;
26292 if (font
->vertical_centering
)
26293 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26296 normal_char_ascent_descent (font
, -1, &ascent
, &descent
);
26300 it
->override_ascent
= ascent
;
26301 it
->override_descent
= descent
;
26302 it
->override_boff
= boff
;
26305 height
= ascent
+ descent
;
26309 height
= (int)(XFLOAT_DATA (val
) * height
);
26310 else if (INTEGERP (val
))
26311 height
*= XINT (val
);
26313 return make_number (height
);
26317 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26318 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26319 and only if this is for a character for which no font was found.
26321 If the display method (it->glyphless_method) is
26322 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26323 length of the acronym or the hexadecimal string, UPPER_XOFF and
26324 UPPER_YOFF are pixel offsets for the upper part of the string,
26325 LOWER_XOFF and LOWER_YOFF are for the lower part.
26327 For the other display methods, LEN through LOWER_YOFF are zero. */
26330 append_glyphless_glyph (struct it
*it
, int face_id
, bool for_no_font
, int len
,
26331 short upper_xoff
, short upper_yoff
,
26332 short lower_xoff
, short lower_yoff
)
26334 struct glyph
*glyph
;
26335 enum glyph_row_area area
= it
->area
;
26337 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26338 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26340 /* If the glyph row is reversed, we need to prepend the glyph
26341 rather than append it. */
26342 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26346 /* Make room for the additional glyph. */
26347 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26349 glyph
= it
->glyph_row
->glyphs
[area
];
26351 glyph
->charpos
= CHARPOS (it
->position
);
26352 glyph
->object
= it
->object
;
26353 glyph
->pixel_width
= it
->pixel_width
;
26354 glyph
->ascent
= it
->ascent
;
26355 glyph
->descent
= it
->descent
;
26356 glyph
->voffset
= it
->voffset
;
26357 glyph
->type
= GLYPHLESS_GLYPH
;
26358 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26359 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26360 glyph
->u
.glyphless
.len
= len
;
26361 glyph
->u
.glyphless
.ch
= it
->c
;
26362 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26363 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26364 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26365 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26366 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26367 glyph
->multibyte_p
= it
->multibyte_p
;
26368 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26370 /* In R2L rows, the left and the right box edges need to be
26371 drawn in reverse direction. */
26372 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26373 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26377 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26378 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26380 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26381 || it
->phys_descent
> it
->descent
);
26382 glyph
->padding_p
= false;
26383 glyph
->glyph_not_available_p
= false;
26384 glyph
->face_id
= face_id
;
26385 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26388 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26389 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26390 glyph
->bidi_type
= it
->bidi_it
.type
;
26392 ++it
->glyph_row
->used
[area
];
26395 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26399 /* Produce a glyph for a glyphless character for iterator IT.
26400 IT->glyphless_method specifies which method to use for displaying
26401 the character. See the description of enum
26402 glyphless_display_method in dispextern.h for the detail.
26404 FOR_NO_FONT is true if and only if this is for a character for
26405 which no font was found. ACRONYM, if non-nil, is an acronym string
26406 for the character. */
26409 produce_glyphless_glyph (struct it
*it
, bool for_no_font
, Lisp_Object acronym
)
26414 int base_width
, base_height
, width
, height
;
26415 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26418 /* Get the metrics of the base font. We always refer to the current
26420 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26421 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26422 normal_char_ascent_descent (font
, -1, &it
->ascent
, &it
->descent
);
26423 it
->ascent
+= font
->baseline_offset
;
26424 it
->descent
-= font
->baseline_offset
;
26425 base_height
= it
->ascent
+ it
->descent
;
26426 base_width
= font
->average_width
;
26428 face_id
= merge_glyphless_glyph_face (it
);
26430 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26432 it
->pixel_width
= THIN_SPACE_WIDTH
;
26434 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26436 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26438 width
= CHAR_WIDTH (it
->c
);
26441 else if (width
> 4)
26443 it
->pixel_width
= base_width
* width
;
26445 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26451 unsigned int code
[6];
26453 int ascent
, descent
;
26454 struct font_metrics metrics_upper
, metrics_lower
;
26456 face
= FACE_FROM_ID (it
->f
, face_id
);
26457 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26458 prepare_face_for_display (it
->f
, face
);
26460 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26462 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26463 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26464 if (CONSP (acronym
))
26465 acronym
= XCAR (acronym
);
26466 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26470 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26471 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
+ 0u);
26474 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26475 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26476 upper_len
= (len
+ 1) / 2;
26477 font
->driver
->text_extents (font
, code
, upper_len
,
26479 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26484 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26485 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26486 upper_xoff
= upper_yoff
= 2; /* the typical case */
26487 if (base_width
>= width
)
26489 /* Align the upper to the left, the lower to the right. */
26490 it
->pixel_width
= base_width
;
26491 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26495 /* Center the shorter one. */
26496 it
->pixel_width
= width
;
26497 if (metrics_upper
.width
>= metrics_lower
.width
)
26498 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26501 /* FIXME: This code doesn't look right. It formerly was
26502 missing the "lower_xoff = 0;", which couldn't have
26503 been right since it left lower_xoff uninitialized. */
26505 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26509 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26510 top, bottom, and between upper and lower strings. */
26511 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26512 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26513 /* Center vertically.
26514 H:base_height, D:base_descent
26515 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26517 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26518 descent = D - H/2 + h/2;
26519 lower_yoff = descent - 2 - ld;
26520 upper_yoff = lower_yoff - la - 1 - ud; */
26521 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26522 descent
= it
->descent
- (base_height
- height
) / 2;
26523 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26524 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26525 - metrics_upper
.descent
);
26526 /* Don't make the height shorter than the base height. */
26527 if (height
> base_height
)
26529 it
->ascent
= ascent
;
26530 it
->descent
= descent
;
26534 it
->phys_ascent
= it
->ascent
;
26535 it
->phys_descent
= it
->descent
;
26537 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26538 upper_xoff
, upper_yoff
,
26539 lower_xoff
, lower_yoff
);
26541 take_vertical_position_into_account (it
);
26546 Produce glyphs/get display metrics for the display element IT is
26547 loaded with. See the description of struct it in dispextern.h
26548 for an overview of struct it. */
26551 x_produce_glyphs (struct it
*it
)
26553 int extra_line_spacing
= it
->extra_line_spacing
;
26555 it
->glyph_not_available_p
= false;
26557 if (it
->what
== IT_CHARACTER
)
26560 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26561 struct font
*font
= face
->font
;
26562 struct font_metrics
*pcm
= NULL
;
26563 int boff
; /* Baseline offset. */
26567 /* When no suitable font is found, display this character by
26568 the method specified in the first extra slot of
26569 Vglyphless_char_display. */
26570 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26572 eassert (it
->what
== IT_GLYPHLESS
);
26573 produce_glyphless_glyph (it
, true,
26574 STRINGP (acronym
) ? acronym
: Qnil
);
26578 boff
= font
->baseline_offset
;
26579 if (font
->vertical_centering
)
26580 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26582 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26586 if (it
->override_ascent
>= 0)
26588 it
->ascent
= it
->override_ascent
;
26589 it
->descent
= it
->override_descent
;
26590 boff
= it
->override_boff
;
26594 it
->ascent
= FONT_BASE (font
) + boff
;
26595 it
->descent
= FONT_DESCENT (font
) - boff
;
26598 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26600 pcm
= get_per_char_metric (font
, &char2b
);
26601 if (pcm
->width
== 0
26602 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26608 it
->phys_ascent
= pcm
->ascent
+ boff
;
26609 it
->phys_descent
= pcm
->descent
- boff
;
26610 it
->pixel_width
= pcm
->width
;
26611 /* Don't use font-global values for ascent and descent
26612 if they result in an exceedingly large line height. */
26613 if (it
->override_ascent
< 0)
26615 if (FONT_TOO_HIGH (font
))
26617 it
->ascent
= it
->phys_ascent
;
26618 it
->descent
= it
->phys_descent
;
26619 /* These limitations are enforced by an
26620 assertion near the end of this function. */
26621 if (it
->ascent
< 0)
26623 if (it
->descent
< 0)
26630 it
->glyph_not_available_p
= true;
26631 it
->phys_ascent
= it
->ascent
;
26632 it
->phys_descent
= it
->descent
;
26633 it
->pixel_width
= font
->space_width
;
26636 if (it
->constrain_row_ascent_descent_p
)
26638 if (it
->descent
> it
->max_descent
)
26640 it
->ascent
+= it
->descent
- it
->max_descent
;
26641 it
->descent
= it
->max_descent
;
26643 if (it
->ascent
> it
->max_ascent
)
26645 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26646 it
->ascent
= it
->max_ascent
;
26648 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26649 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26650 extra_line_spacing
= 0;
26653 /* If this is a space inside a region of text with
26654 `space-width' property, change its width. */
26656 = it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26658 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26660 /* If face has a box, add the box thickness to the character
26661 height. If character has a box line to the left and/or
26662 right, add the box line width to the character's width. */
26663 if (face
->box
!= FACE_NO_BOX
)
26665 int thick
= face
->box_line_width
;
26669 it
->ascent
+= thick
;
26670 it
->descent
+= thick
;
26675 if (it
->start_of_box_run_p
)
26676 it
->pixel_width
+= thick
;
26677 if (it
->end_of_box_run_p
)
26678 it
->pixel_width
+= thick
;
26681 /* If face has an overline, add the height of the overline
26682 (1 pixel) and a 1 pixel margin to the character height. */
26683 if (face
->overline_p
)
26684 it
->ascent
+= overline_margin
;
26686 if (it
->constrain_row_ascent_descent_p
)
26688 if (it
->ascent
> it
->max_ascent
)
26689 it
->ascent
= it
->max_ascent
;
26690 if (it
->descent
> it
->max_descent
)
26691 it
->descent
= it
->max_descent
;
26694 take_vertical_position_into_account (it
);
26696 /* If we have to actually produce glyphs, do it. */
26701 /* Translate a space with a `space-width' property
26702 into a stretch glyph. */
26703 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26704 / FONT_HEIGHT (font
));
26705 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26706 it
->ascent
+ it
->descent
, ascent
);
26711 /* If characters with lbearing or rbearing are displayed
26712 in this line, record that fact in a flag of the
26713 glyph row. This is used to optimize X output code. */
26714 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26715 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
26717 if (! stretched_p
&& it
->pixel_width
== 0)
26718 /* We assure that all visible glyphs have at least 1-pixel
26720 it
->pixel_width
= 1;
26722 else if (it
->char_to_display
== '\n')
26724 /* A newline has no width, but we need the height of the
26725 line. But if previous part of the line sets a height,
26726 don't increase that height. */
26728 Lisp_Object height
;
26729 Lisp_Object total_height
= Qnil
;
26731 it
->override_ascent
= -1;
26732 it
->pixel_width
= 0;
26735 height
= get_it_property (it
, Qline_height
);
26736 /* Split (line-height total-height) list. */
26738 && CONSP (XCDR (height
))
26739 && NILP (XCDR (XCDR (height
))))
26741 total_height
= XCAR (XCDR (height
));
26742 height
= XCAR (height
);
26744 height
= calc_line_height_property (it
, height
, font
, boff
, true);
26746 if (it
->override_ascent
>= 0)
26748 it
->ascent
= it
->override_ascent
;
26749 it
->descent
= it
->override_descent
;
26750 boff
= it
->override_boff
;
26754 if (FONT_TOO_HIGH (font
))
26756 it
->ascent
= font
->pixel_size
+ boff
- 1;
26757 it
->descent
= -boff
+ 1;
26758 if (it
->descent
< 0)
26763 it
->ascent
= FONT_BASE (font
) + boff
;
26764 it
->descent
= FONT_DESCENT (font
) - boff
;
26768 if (EQ (height
, Qt
))
26770 if (it
->descent
> it
->max_descent
)
26772 it
->ascent
+= it
->descent
- it
->max_descent
;
26773 it
->descent
= it
->max_descent
;
26775 if (it
->ascent
> it
->max_ascent
)
26777 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26778 it
->ascent
= it
->max_ascent
;
26780 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26781 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26782 it
->constrain_row_ascent_descent_p
= true;
26783 extra_line_spacing
= 0;
26787 Lisp_Object spacing
;
26789 it
->phys_ascent
= it
->ascent
;
26790 it
->phys_descent
= it
->descent
;
26792 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26793 && face
->box
!= FACE_NO_BOX
26794 && face
->box_line_width
> 0)
26796 it
->ascent
+= face
->box_line_width
;
26797 it
->descent
+= face
->box_line_width
;
26800 && XINT (height
) > it
->ascent
+ it
->descent
)
26801 it
->ascent
= XINT (height
) - it
->descent
;
26803 if (!NILP (total_height
))
26804 spacing
= calc_line_height_property (it
, total_height
, font
,
26808 spacing
= get_it_property (it
, Qline_spacing
);
26809 spacing
= calc_line_height_property (it
, spacing
, font
,
26812 if (INTEGERP (spacing
))
26814 extra_line_spacing
= XINT (spacing
);
26815 if (!NILP (total_height
))
26816 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26820 else /* i.e. (it->char_to_display == '\t') */
26822 if (font
->space_width
> 0)
26824 int tab_width
= it
->tab_width
* font
->space_width
;
26825 int x
= it
->current_x
+ it
->continuation_lines_width
;
26826 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26828 /* If the distance from the current position to the next tab
26829 stop is less than a space character width, use the
26830 tab stop after that. */
26831 if (next_tab_x
- x
< font
->space_width
)
26832 next_tab_x
+= tab_width
;
26834 it
->pixel_width
= next_tab_x
- x
;
26836 if (FONT_TOO_HIGH (font
))
26838 if (get_char_glyph_code (' ', font
, &char2b
))
26840 pcm
= get_per_char_metric (font
, &char2b
);
26841 if (pcm
->width
== 0
26842 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26848 it
->ascent
= pcm
->ascent
+ boff
;
26849 it
->descent
= pcm
->descent
- boff
;
26853 it
->ascent
= font
->pixel_size
+ boff
- 1;
26854 it
->descent
= -boff
+ 1;
26856 if (it
->ascent
< 0)
26858 if (it
->descent
< 0)
26863 it
->ascent
= FONT_BASE (font
) + boff
;
26864 it
->descent
= FONT_DESCENT (font
) - boff
;
26866 it
->phys_ascent
= it
->ascent
;
26867 it
->phys_descent
= it
->descent
;
26871 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26872 it
->ascent
+ it
->descent
, it
->ascent
);
26877 it
->pixel_width
= 0;
26882 if (FONT_TOO_HIGH (font
))
26884 int font_ascent
, font_descent
;
26886 /* For very large fonts, where we ignore the declared font
26887 dimensions, and go by per-character metrics instead,
26888 don't let the row ascent and descent values (and the row
26889 height computed from them) be smaller than the "normal"
26890 character metrics. This avoids unpleasant effects
26891 whereby lines on display would change their height
26892 depending on which characters are shown. */
26893 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26894 it
->max_ascent
= max (it
->max_ascent
, font_ascent
);
26895 it
->max_descent
= max (it
->max_descent
, font_descent
);
26898 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26900 /* A static composition.
26902 Note: A composition is represented as one glyph in the
26903 glyph matrix. There are no padding glyphs.
26905 Important note: pixel_width, ascent, and descent are the
26906 values of what is drawn by draw_glyphs (i.e. the values of
26907 the overall glyphs composed). */
26908 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26909 int boff
; /* baseline offset */
26910 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26911 int glyph_len
= cmp
->glyph_len
;
26912 struct font
*font
= face
->font
;
26916 /* If we have not yet calculated pixel size data of glyphs of
26917 the composition for the current face font, calculate them
26918 now. Theoretically, we have to check all fonts for the
26919 glyphs, but that requires much time and memory space. So,
26920 here we check only the font of the first glyph. This may
26921 lead to incorrect display, but it's very rare, and C-l
26922 (recenter-top-bottom) can correct the display anyway. */
26923 if (! cmp
->font
|| cmp
->font
!= font
)
26925 /* Ascent and descent of the font of the first character
26926 of this composition (adjusted by baseline offset).
26927 Ascent and descent of overall glyphs should not be less
26928 than these, respectively. */
26929 int font_ascent
, font_descent
, font_height
;
26930 /* Bounding box of the overall glyphs. */
26931 int leftmost
, rightmost
, lowest
, highest
;
26932 int lbearing
, rbearing
;
26933 int i
, width
, ascent
, descent
;
26934 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26936 struct font_metrics
*pcm
;
26939 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26940 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26942 bool right_padded
= glyph_len
< cmp
->glyph_len
;
26943 for (i
= 0; i
< glyph_len
; i
++)
26945 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26947 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26949 bool left_padded
= i
> 0;
26951 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26952 : IT_CHARPOS (*it
));
26953 /* If no suitable font is found, use the default font. */
26954 bool font_not_found_p
= font
== NULL
;
26955 if (font_not_found_p
)
26957 face
= face
->ascii_face
;
26960 boff
= font
->baseline_offset
;
26961 if (font
->vertical_centering
)
26962 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26963 normal_char_ascent_descent (font
, -1, &font_ascent
, &font_descent
);
26964 font_ascent
+= boff
;
26965 font_descent
-= boff
;
26966 font_height
= font_ascent
+ font_descent
;
26971 if (! font_not_found_p
)
26973 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26975 pcm
= get_per_char_metric (font
, &char2b
);
26978 /* Initialize the bounding box. */
26981 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26982 ascent
= pcm
->ascent
;
26983 descent
= pcm
->descent
;
26984 lbearing
= pcm
->lbearing
;
26985 rbearing
= pcm
->rbearing
;
26989 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26990 ascent
= FONT_BASE (font
);
26991 descent
= FONT_DESCENT (font
);
26998 lowest
= - descent
+ boff
;
26999 highest
= ascent
+ boff
;
27001 if (! font_not_found_p
27002 && font
->default_ascent
27003 && CHAR_TABLE_P (Vuse_default_ascent
)
27004 && !NILP (Faref (Vuse_default_ascent
,
27005 make_number (it
->char_to_display
))))
27006 highest
= font
->default_ascent
+ boff
;
27008 /* Draw the first glyph at the normal position. It may be
27009 shifted to right later if some other glyphs are drawn
27011 cmp
->offsets
[i
* 2] = 0;
27012 cmp
->offsets
[i
* 2 + 1] = boff
;
27013 cmp
->lbearing
= lbearing
;
27014 cmp
->rbearing
= rbearing
;
27016 /* Set cmp->offsets for the remaining glyphs. */
27017 for (i
++; i
< glyph_len
; i
++)
27019 int left
, right
, btm
, top
;
27020 int ch
= COMPOSITION_GLYPH (cmp
, i
);
27022 struct face
*this_face
;
27026 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
27027 this_face
= FACE_FROM_ID (it
->f
, face_id
);
27028 font
= this_face
->font
;
27034 get_char_face_and_encoding (it
->f
, ch
, face_id
,
27036 pcm
= get_per_char_metric (font
, &char2b
);
27039 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
27042 width
= pcm
->width
;
27043 ascent
= pcm
->ascent
;
27044 descent
= pcm
->descent
;
27045 lbearing
= pcm
->lbearing
;
27046 rbearing
= pcm
->rbearing
;
27047 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
27049 /* Relative composition with or without
27050 alternate chars. */
27051 left
= (leftmost
+ rightmost
- width
) / 2;
27052 btm
= - descent
+ boff
;
27053 if (font
->relative_compose
27054 && (! CHAR_TABLE_P (Vignore_relative_composition
)
27055 || NILP (Faref (Vignore_relative_composition
,
27056 make_number (ch
)))))
27059 if (- descent
>= font
->relative_compose
)
27060 /* One extra pixel between two glyphs. */
27062 else if (ascent
<= 0)
27063 /* One extra pixel between two glyphs. */
27064 btm
= lowest
- 1 - ascent
- descent
;
27069 /* A composition rule is specified by an integer
27070 value that encodes global and new reference
27071 points (GREF and NREF). GREF and NREF are
27072 specified by numbers as below:
27074 0---1---2 -- ascent
27078 9--10--11 -- center
27080 ---3---4---5--- baseline
27082 6---7---8 -- descent
27084 int rule
= COMPOSITION_RULE (cmp
, i
);
27085 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
27087 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
27088 grefx
= gref
% 3, nrefx
= nref
% 3;
27089 grefy
= gref
/ 3, nrefy
= nref
/ 3;
27091 xoff
= font_height
* (xoff
- 128) / 256;
27093 yoff
= font_height
* (yoff
- 128) / 256;
27096 + grefx
* (rightmost
- leftmost
) / 2
27097 - nrefx
* width
/ 2
27100 btm
= ((grefy
== 0 ? highest
27102 : grefy
== 2 ? lowest
27103 : (highest
+ lowest
) / 2)
27104 - (nrefy
== 0 ? ascent
+ descent
27105 : nrefy
== 1 ? descent
- boff
27107 : (ascent
+ descent
) / 2)
27111 cmp
->offsets
[i
* 2] = left
;
27112 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
27114 /* Update the bounding box of the overall glyphs. */
27117 right
= left
+ width
;
27118 if (left
< leftmost
)
27120 if (right
> rightmost
)
27123 top
= btm
+ descent
+ ascent
;
27129 if (cmp
->lbearing
> left
+ lbearing
)
27130 cmp
->lbearing
= left
+ lbearing
;
27131 if (cmp
->rbearing
< left
+ rbearing
)
27132 cmp
->rbearing
= left
+ rbearing
;
27136 /* If there are glyphs whose x-offsets are negative,
27137 shift all glyphs to the right and make all x-offsets
27141 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27142 cmp
->offsets
[i
* 2] -= leftmost
;
27143 rightmost
-= leftmost
;
27144 cmp
->lbearing
-= leftmost
;
27145 cmp
->rbearing
-= leftmost
;
27148 if (left_padded
&& cmp
->lbearing
< 0)
27150 for (i
= 0; i
< cmp
->glyph_len
; i
++)
27151 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
27152 rightmost
-= cmp
->lbearing
;
27153 cmp
->rbearing
-= cmp
->lbearing
;
27156 if (right_padded
&& rightmost
< cmp
->rbearing
)
27158 rightmost
= cmp
->rbearing
;
27161 cmp
->pixel_width
= rightmost
;
27162 cmp
->ascent
= highest
;
27163 cmp
->descent
= - lowest
;
27164 if (cmp
->ascent
< font_ascent
)
27165 cmp
->ascent
= font_ascent
;
27166 if (cmp
->descent
< font_descent
)
27167 cmp
->descent
= font_descent
;
27171 && (cmp
->lbearing
< 0
27172 || cmp
->rbearing
> cmp
->pixel_width
))
27173 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27175 it
->pixel_width
= cmp
->pixel_width
;
27176 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
27177 it
->descent
= it
->phys_descent
= cmp
->descent
;
27178 if (face
->box
!= FACE_NO_BOX
)
27180 int thick
= face
->box_line_width
;
27184 it
->ascent
+= thick
;
27185 it
->descent
+= thick
;
27190 if (it
->start_of_box_run_p
)
27191 it
->pixel_width
+= thick
;
27192 if (it
->end_of_box_run_p
)
27193 it
->pixel_width
+= thick
;
27196 /* If face has an overline, add the height of the overline
27197 (1 pixel) and a 1 pixel margin to the character height. */
27198 if (face
->overline_p
)
27199 it
->ascent
+= overline_margin
;
27201 take_vertical_position_into_account (it
);
27202 if (it
->ascent
< 0)
27204 if (it
->descent
< 0)
27207 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
27208 append_composite_glyph (it
);
27210 else if (it
->what
== IT_COMPOSITION
)
27212 /* A dynamic (automatic) composition. */
27213 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
27214 Lisp_Object gstring
;
27215 struct font_metrics metrics
;
27219 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
27221 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
27224 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
27225 it
->glyph_row
->contains_overlapping_glyphs_p
= true;
27226 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
27227 it
->descent
= it
->phys_descent
= metrics
.descent
;
27228 if (face
->box
!= FACE_NO_BOX
)
27230 int thick
= face
->box_line_width
;
27234 it
->ascent
+= thick
;
27235 it
->descent
+= thick
;
27240 if (it
->start_of_box_run_p
)
27241 it
->pixel_width
+= thick
;
27242 if (it
->end_of_box_run_p
)
27243 it
->pixel_width
+= thick
;
27245 /* If face has an overline, add the height of the overline
27246 (1 pixel) and a 1 pixel margin to the character height. */
27247 if (face
->overline_p
)
27248 it
->ascent
+= overline_margin
;
27249 take_vertical_position_into_account (it
);
27250 if (it
->ascent
< 0)
27252 if (it
->descent
< 0)
27256 append_composite_glyph (it
);
27258 else if (it
->what
== IT_GLYPHLESS
)
27259 produce_glyphless_glyph (it
, false, Qnil
);
27260 else if (it
->what
== IT_IMAGE
)
27261 produce_image_glyph (it
);
27262 else if (it
->what
== IT_STRETCH
)
27263 produce_stretch_glyph (it
);
27266 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27267 because this isn't true for images with `:ascent 100'. */
27268 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
27269 if (it
->area
== TEXT_AREA
)
27270 it
->current_x
+= it
->pixel_width
;
27272 if (extra_line_spacing
> 0)
27274 it
->descent
+= extra_line_spacing
;
27275 if (extra_line_spacing
> it
->max_extra_line_spacing
)
27276 it
->max_extra_line_spacing
= extra_line_spacing
;
27279 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
27280 it
->max_descent
= max (it
->max_descent
, it
->descent
);
27281 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
27282 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
27286 Output LEN glyphs starting at START at the nominal cursor position.
27287 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27288 being updated, and UPDATED_AREA is the area of that row being updated. */
27291 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27292 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27294 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
27296 eassert (updated_row
);
27297 /* When the window is hscrolled, cursor hpos can legitimately be out
27298 of bounds, but we draw the cursor at the corresponding window
27299 margin in that case. */
27300 if (!updated_row
->reversed_p
&& chpos
< 0)
27302 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
27303 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
27307 /* Write glyphs. */
27309 hpos
= start
- updated_row
->glyphs
[updated_area
];
27310 x
= draw_glyphs (w
, w
->output_cursor
.x
,
27311 updated_row
, updated_area
,
27313 DRAW_NORMAL_TEXT
, 0);
27315 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27316 if (updated_area
== TEXT_AREA
27317 && w
->phys_cursor_on_p
27318 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
27320 && chpos
< hpos
+ len
)
27321 w
->phys_cursor_on_p
= false;
27325 /* Advance the output cursor. */
27326 w
->output_cursor
.hpos
+= len
;
27327 w
->output_cursor
.x
= x
;
27332 Insert LEN glyphs from START at the nominal cursor position. */
27335 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27336 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27339 int line_height
, shift_by_width
, shifted_region_width
;
27340 struct glyph_row
*row
;
27341 struct glyph
*glyph
;
27342 int frame_x
, frame_y
;
27345 eassert (updated_row
);
27347 f
= XFRAME (WINDOW_FRAME (w
));
27349 /* Get the height of the line we are in. */
27351 line_height
= row
->height
;
27353 /* Get the width of the glyphs to insert. */
27354 shift_by_width
= 0;
27355 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27356 shift_by_width
+= glyph
->pixel_width
;
27358 /* Get the width of the region to shift right. */
27359 shifted_region_width
= (window_box_width (w
, updated_area
)
27360 - w
->output_cursor
.x
27364 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27365 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27367 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27368 line_height
, shift_by_width
);
27370 /* Write the glyphs. */
27371 hpos
= start
- row
->glyphs
[updated_area
];
27372 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27374 DRAW_NORMAL_TEXT
, 0);
27376 /* Advance the output cursor. */
27377 w
->output_cursor
.hpos
+= len
;
27378 w
->output_cursor
.x
+= shift_by_width
;
27384 Erase the current text line from the nominal cursor position
27385 (inclusive) to pixel column TO_X (exclusive). The idea is that
27386 everything from TO_X onward is already erased.
27388 TO_X is a pixel position relative to UPDATED_AREA of currently
27389 updated window W. TO_X == -1 means clear to the end of this area. */
27392 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27393 enum glyph_row_area updated_area
, int to_x
)
27396 int max_x
, min_y
, max_y
;
27397 int from_x
, from_y
, to_y
;
27399 eassert (updated_row
);
27400 f
= XFRAME (w
->frame
);
27402 if (updated_row
->full_width_p
)
27403 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27404 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27406 max_x
= window_box_width (w
, updated_area
);
27407 max_y
= window_text_bottom_y (w
);
27409 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27410 of window. For TO_X > 0, truncate to end of drawing area. */
27416 to_x
= min (to_x
, max_x
);
27418 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27420 /* Notice if the cursor will be cleared by this operation. */
27421 if (!updated_row
->full_width_p
)
27422 notice_overwritten_cursor (w
, updated_area
,
27423 w
->output_cursor
.x
, -1,
27425 MATRIX_ROW_BOTTOM_Y (updated_row
));
27427 from_x
= w
->output_cursor
.x
;
27429 /* Translate to frame coordinates. */
27430 if (updated_row
->full_width_p
)
27432 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27433 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27437 int area_left
= window_box_left (w
, updated_area
);
27438 from_x
+= area_left
;
27442 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27443 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27444 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27446 /* Prevent inadvertently clearing to end of the X window. */
27447 if (to_x
> from_x
&& to_y
> from_y
)
27450 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27451 to_x
- from_x
, to_y
- from_y
);
27456 #endif /* HAVE_WINDOW_SYSTEM */
27460 /***********************************************************************
27462 ***********************************************************************/
27464 /* Value is the internal representation of the specified cursor type
27465 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27466 of the bar cursor. */
27468 static enum text_cursor_kinds
27469 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27471 enum text_cursor_kinds type
;
27476 if (EQ (arg
, Qbox
))
27477 return FILLED_BOX_CURSOR
;
27479 if (EQ (arg
, Qhollow
))
27480 return HOLLOW_BOX_CURSOR
;
27482 if (EQ (arg
, Qbar
))
27489 && EQ (XCAR (arg
), Qbar
)
27490 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27492 *width
= XINT (XCDR (arg
));
27496 if (EQ (arg
, Qhbar
))
27499 return HBAR_CURSOR
;
27503 && EQ (XCAR (arg
), Qhbar
)
27504 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27506 *width
= XINT (XCDR (arg
));
27507 return HBAR_CURSOR
;
27510 /* Treat anything unknown as "hollow box cursor".
27511 It was bad to signal an error; people have trouble fixing
27512 .Xdefaults with Emacs, when it has something bad in it. */
27513 type
= HOLLOW_BOX_CURSOR
;
27518 /* Set the default cursor types for specified frame. */
27520 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27525 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27526 FRAME_CURSOR_WIDTH (f
) = width
;
27528 /* By default, set up the blink-off state depending on the on-state. */
27530 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27533 FRAME_BLINK_OFF_CURSOR (f
)
27534 = get_specified_cursor_type (XCDR (tem
), &width
);
27535 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27538 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27540 /* Make sure the cursor gets redrawn. */
27541 f
->cursor_type_changed
= true;
27545 #ifdef HAVE_WINDOW_SYSTEM
27547 /* Return the cursor we want to be displayed in window W. Return
27548 width of bar/hbar cursor through WIDTH arg. Return with
27549 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27550 (i.e. if the `system caret' should track this cursor).
27552 In a mini-buffer window, we want the cursor only to appear if we
27553 are reading input from this window. For the selected window, we
27554 want the cursor type given by the frame parameter or buffer local
27555 setting of cursor-type. If explicitly marked off, draw no cursor.
27556 In all other cases, we want a hollow box cursor. */
27558 static enum text_cursor_kinds
27559 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27560 bool *active_cursor
)
27562 struct frame
*f
= XFRAME (w
->frame
);
27563 struct buffer
*b
= XBUFFER (w
->contents
);
27564 int cursor_type
= DEFAULT_CURSOR
;
27565 Lisp_Object alt_cursor
;
27566 bool non_selected
= false;
27568 *active_cursor
= true;
27571 if (cursor_in_echo_area
27572 && FRAME_HAS_MINIBUF_P (f
)
27573 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27575 if (w
== XWINDOW (echo_area_window
))
27577 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27579 *width
= FRAME_CURSOR_WIDTH (f
);
27580 return FRAME_DESIRED_CURSOR (f
);
27583 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27586 *active_cursor
= false;
27587 non_selected
= true;
27590 /* Detect a nonselected window or nonselected frame. */
27591 else if (w
!= XWINDOW (f
->selected_window
)
27592 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27594 *active_cursor
= false;
27596 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27599 non_selected
= true;
27602 /* Never display a cursor in a window in which cursor-type is nil. */
27603 if (NILP (BVAR (b
, cursor_type
)))
27606 /* Get the normal cursor type for this window. */
27607 if (EQ (BVAR (b
, cursor_type
), Qt
))
27609 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27610 *width
= FRAME_CURSOR_WIDTH (f
);
27613 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27615 /* Use cursor-in-non-selected-windows instead
27616 for non-selected window or frame. */
27619 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27620 if (!EQ (Qt
, alt_cursor
))
27621 return get_specified_cursor_type (alt_cursor
, width
);
27622 /* t means modify the normal cursor type. */
27623 if (cursor_type
== FILLED_BOX_CURSOR
)
27624 cursor_type
= HOLLOW_BOX_CURSOR
;
27625 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27627 return cursor_type
;
27630 /* Use normal cursor if not blinked off. */
27631 if (!w
->cursor_off_p
)
27633 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27635 if (cursor_type
== FILLED_BOX_CURSOR
)
27637 /* Using a block cursor on large images can be very annoying.
27638 So use a hollow cursor for "large" images.
27639 If image is not transparent (no mask), also use hollow cursor. */
27640 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27641 if (img
!= NULL
&& IMAGEP (img
->spec
))
27643 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27644 where N = size of default frame font size.
27645 This should cover most of the "tiny" icons people may use. */
27647 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27648 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27649 cursor_type
= HOLLOW_BOX_CURSOR
;
27652 else if (cursor_type
!= NO_CURSOR
)
27654 /* Display current only supports BOX and HOLLOW cursors for images.
27655 So for now, unconditionally use a HOLLOW cursor when cursor is
27656 not a solid box cursor. */
27657 cursor_type
= HOLLOW_BOX_CURSOR
;
27660 return cursor_type
;
27663 /* Cursor is blinked off, so determine how to "toggle" it. */
27665 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27666 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27667 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27669 /* Then see if frame has specified a specific blink off cursor type. */
27670 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27672 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27673 return FRAME_BLINK_OFF_CURSOR (f
);
27677 /* Some people liked having a permanently visible blinking cursor,
27678 while others had very strong opinions against it. So it was
27679 decided to remove it. KFS 2003-09-03 */
27681 /* Finally perform built-in cursor blinking:
27682 filled box <-> hollow box
27683 wide [h]bar <-> narrow [h]bar
27684 narrow [h]bar <-> no cursor
27685 other type <-> no cursor */
27687 if (cursor_type
== FILLED_BOX_CURSOR
)
27688 return HOLLOW_BOX_CURSOR
;
27690 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27693 return cursor_type
;
27701 /* Notice when the text cursor of window W has been completely
27702 overwritten by a drawing operation that outputs glyphs in AREA
27703 starting at X0 and ending at X1 in the line starting at Y0 and
27704 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27705 the rest of the line after X0 has been written. Y coordinates
27706 are window-relative. */
27709 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27710 int x0
, int x1
, int y0
, int y1
)
27712 int cx0
, cx1
, cy0
, cy1
;
27713 struct glyph_row
*row
;
27715 if (!w
->phys_cursor_on_p
)
27717 if (area
!= TEXT_AREA
)
27720 if (w
->phys_cursor
.vpos
< 0
27721 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27722 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27723 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27726 if (row
->cursor_in_fringe_p
)
27728 row
->cursor_in_fringe_p
= false;
27729 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27730 w
->phys_cursor_on_p
= false;
27734 cx0
= w
->phys_cursor
.x
;
27735 cx1
= cx0
+ w
->phys_cursor_width
;
27736 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27739 /* The cursor image will be completely removed from the
27740 screen if the output area intersects the cursor area in
27741 y-direction. When we draw in [y0 y1[, and some part of
27742 the cursor is at y < y0, that part must have been drawn
27743 before. When scrolling, the cursor is erased before
27744 actually scrolling, so we don't come here. When not
27745 scrolling, the rows above the old cursor row must have
27746 changed, and in this case these rows must have written
27747 over the cursor image.
27749 Likewise if part of the cursor is below y1, with the
27750 exception of the cursor being in the first blank row at
27751 the buffer and window end because update_text_area
27752 doesn't draw that row. (Except when it does, but
27753 that's handled in update_text_area.) */
27755 cy0
= w
->phys_cursor
.y
;
27756 cy1
= cy0
+ w
->phys_cursor_height
;
27757 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27760 w
->phys_cursor_on_p
= false;
27763 #endif /* HAVE_WINDOW_SYSTEM */
27766 /************************************************************************
27768 ************************************************************************/
27770 #ifdef HAVE_WINDOW_SYSTEM
27773 Fix the display of area AREA of overlapping row ROW in window W
27774 with respect to the overlapping part OVERLAPS. */
27777 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27778 enum glyph_row_area area
, int overlaps
)
27785 for (i
= 0; i
< row
->used
[area
];)
27787 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27789 int start
= i
, start_x
= x
;
27793 x
+= row
->glyphs
[area
][i
].pixel_width
;
27796 while (i
< row
->used
[area
]
27797 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27799 draw_glyphs (w
, start_x
, row
, area
,
27801 DRAW_NORMAL_TEXT
, overlaps
);
27805 x
+= row
->glyphs
[area
][i
].pixel_width
;
27815 Draw the cursor glyph of window W in glyph row ROW. See the
27816 comment of draw_glyphs for the meaning of HL. */
27819 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27820 enum draw_glyphs_face hl
)
27822 /* If cursor hpos is out of bounds, don't draw garbage. This can
27823 happen in mini-buffer windows when switching between echo area
27824 glyphs and mini-buffer. */
27825 if ((row
->reversed_p
27826 ? (w
->phys_cursor
.hpos
>= 0)
27827 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27829 bool on_p
= w
->phys_cursor_on_p
;
27831 int hpos
= w
->phys_cursor
.hpos
;
27833 /* When the window is hscrolled, cursor hpos can legitimately be
27834 out of bounds, but we draw the cursor at the corresponding
27835 window margin in that case. */
27836 if (!row
->reversed_p
&& hpos
< 0)
27838 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27839 hpos
= row
->used
[TEXT_AREA
] - 1;
27841 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27843 w
->phys_cursor_on_p
= on_p
;
27845 if (hl
== DRAW_CURSOR
)
27846 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27847 /* When we erase the cursor, and ROW is overlapped by other
27848 rows, make sure that these overlapping parts of other rows
27850 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27852 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27854 if (row
> w
->current_matrix
->rows
27855 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27856 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27857 OVERLAPS_ERASED_CURSOR
);
27859 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27860 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27861 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27862 OVERLAPS_ERASED_CURSOR
);
27868 /* Erase the image of a cursor of window W from the screen. */
27871 erase_phys_cursor (struct window
*w
)
27873 struct frame
*f
= XFRAME (w
->frame
);
27874 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27875 int hpos
= w
->phys_cursor
.hpos
;
27876 int vpos
= w
->phys_cursor
.vpos
;
27877 bool mouse_face_here_p
= false;
27878 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27879 struct glyph_row
*cursor_row
;
27880 struct glyph
*cursor_glyph
;
27881 enum draw_glyphs_face hl
;
27883 /* No cursor displayed or row invalidated => nothing to do on the
27885 if (w
->phys_cursor_type
== NO_CURSOR
)
27886 goto mark_cursor_off
;
27888 /* VPOS >= active_glyphs->nrows means that window has been resized.
27889 Don't bother to erase the cursor. */
27890 if (vpos
>= active_glyphs
->nrows
)
27891 goto mark_cursor_off
;
27893 /* If row containing cursor is marked invalid, there is nothing we
27895 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27896 if (!cursor_row
->enabled_p
)
27897 goto mark_cursor_off
;
27899 /* If line spacing is > 0, old cursor may only be partially visible in
27900 window after split-window. So adjust visible height. */
27901 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27902 window_text_bottom_y (w
) - cursor_row
->y
);
27904 /* If row is completely invisible, don't attempt to delete a cursor which
27905 isn't there. This can happen if cursor is at top of a window, and
27906 we switch to a buffer with a header line in that window. */
27907 if (cursor_row
->visible_height
<= 0)
27908 goto mark_cursor_off
;
27910 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27911 if (cursor_row
->cursor_in_fringe_p
)
27913 cursor_row
->cursor_in_fringe_p
= false;
27914 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27915 goto mark_cursor_off
;
27918 /* This can happen when the new row is shorter than the old one.
27919 In this case, either draw_glyphs or clear_end_of_line
27920 should have cleared the cursor. Note that we wouldn't be
27921 able to erase the cursor in this case because we don't have a
27922 cursor glyph at hand. */
27923 if ((cursor_row
->reversed_p
27924 ? (w
->phys_cursor
.hpos
< 0)
27925 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27926 goto mark_cursor_off
;
27928 /* When the window is hscrolled, cursor hpos can legitimately be out
27929 of bounds, but we draw the cursor at the corresponding window
27930 margin in that case. */
27931 if (!cursor_row
->reversed_p
&& hpos
< 0)
27933 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27934 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27936 /* If the cursor is in the mouse face area, redisplay that when
27937 we clear the cursor. */
27938 if (! NILP (hlinfo
->mouse_face_window
)
27939 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27940 /* Don't redraw the cursor's spot in mouse face if it is at the
27941 end of a line (on a newline). The cursor appears there, but
27942 mouse highlighting does not. */
27943 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27944 mouse_face_here_p
= true;
27946 /* Maybe clear the display under the cursor. */
27947 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27950 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27953 cursor_glyph
= get_phys_cursor_glyph (w
);
27954 if (cursor_glyph
== NULL
)
27955 goto mark_cursor_off
;
27957 width
= cursor_glyph
->pixel_width
;
27958 x
= w
->phys_cursor
.x
;
27964 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27965 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27966 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27969 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27972 /* Erase the cursor by redrawing the character underneath it. */
27973 if (mouse_face_here_p
)
27974 hl
= DRAW_MOUSE_FACE
;
27976 hl
= DRAW_NORMAL_TEXT
;
27977 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27980 w
->phys_cursor_on_p
= false;
27981 w
->phys_cursor_type
= NO_CURSOR
;
27985 /* Display or clear cursor of window W. If !ON, clear the cursor.
27986 If ON, display the cursor; where to put the cursor is specified by
27987 HPOS, VPOS, X and Y. */
27990 display_and_set_cursor (struct window
*w
, bool on
,
27991 int hpos
, int vpos
, int x
, int y
)
27993 struct frame
*f
= XFRAME (w
->frame
);
27994 int new_cursor_type
;
27995 int new_cursor_width
;
27996 bool active_cursor
;
27997 struct glyph_row
*glyph_row
;
27998 struct glyph
*glyph
;
28000 /* This is pointless on invisible frames, and dangerous on garbaged
28001 windows and frames; in the latter case, the frame or window may
28002 be in the midst of changing its size, and x and y may be off the
28004 if (! FRAME_VISIBLE_P (f
)
28005 || FRAME_GARBAGED_P (f
)
28006 || vpos
>= w
->current_matrix
->nrows
28007 || hpos
>= w
->current_matrix
->matrix_w
)
28010 /* If cursor is off and we want it off, return quickly. */
28011 if (!on
&& !w
->phys_cursor_on_p
)
28014 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28015 /* If cursor row is not enabled, we don't really know where to
28016 display the cursor. */
28017 if (!glyph_row
->enabled_p
)
28019 w
->phys_cursor_on_p
= false;
28024 if (!glyph_row
->exact_window_width_line_p
28025 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
28026 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
28028 eassert (input_blocked_p ());
28030 /* Set new_cursor_type to the cursor we want to be displayed. */
28031 new_cursor_type
= get_window_cursor_type (w
, glyph
,
28032 &new_cursor_width
, &active_cursor
);
28034 /* If cursor is currently being shown and we don't want it to be or
28035 it is in the wrong place, or the cursor type is not what we want,
28037 if (w
->phys_cursor_on_p
28039 || w
->phys_cursor
.x
!= x
28040 || w
->phys_cursor
.y
!= y
28041 /* HPOS can be negative in R2L rows whose
28042 exact_window_width_line_p flag is set (i.e. their newline
28043 would "overflow into the fringe"). */
28045 || new_cursor_type
!= w
->phys_cursor_type
28046 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
28047 && new_cursor_width
!= w
->phys_cursor_width
)))
28048 erase_phys_cursor (w
);
28050 /* Don't check phys_cursor_on_p here because that flag is only set
28051 to false in some cases where we know that the cursor has been
28052 completely erased, to avoid the extra work of erasing the cursor
28053 twice. In other words, phys_cursor_on_p can be true and the cursor
28054 still not be visible, or it has only been partly erased. */
28057 w
->phys_cursor_ascent
= glyph_row
->ascent
;
28058 w
->phys_cursor_height
= glyph_row
->height
;
28060 /* Set phys_cursor_.* before x_draw_.* is called because some
28061 of them may need the information. */
28062 w
->phys_cursor
.x
= x
;
28063 w
->phys_cursor
.y
= glyph_row
->y
;
28064 w
->phys_cursor
.hpos
= hpos
;
28065 w
->phys_cursor
.vpos
= vpos
;
28068 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
28069 new_cursor_type
, new_cursor_width
,
28070 on
, active_cursor
);
28074 /* Switch the display of W's cursor on or off, according to the value
28078 update_window_cursor (struct window
*w
, bool on
)
28080 /* Don't update cursor in windows whose frame is in the process
28081 of being deleted. */
28082 if (w
->current_matrix
)
28084 int hpos
= w
->phys_cursor
.hpos
;
28085 int vpos
= w
->phys_cursor
.vpos
;
28086 struct glyph_row
*row
;
28088 if (vpos
>= w
->current_matrix
->nrows
28089 || hpos
>= w
->current_matrix
->matrix_w
)
28092 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28094 /* When the window is hscrolled, cursor hpos can legitimately be
28095 out of bounds, but we draw the cursor at the corresponding
28096 window margin in that case. */
28097 if (!row
->reversed_p
&& hpos
< 0)
28099 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28100 hpos
= row
->used
[TEXT_AREA
] - 1;
28103 display_and_set_cursor (w
, on
, hpos
, vpos
,
28104 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28110 /* Call update_window_cursor with parameter ON_P on all leaf windows
28111 in the window tree rooted at W. */
28114 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
28118 if (WINDOWP (w
->contents
))
28119 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
28121 update_window_cursor (w
, on_p
);
28123 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
28129 Display the cursor on window W, or clear it, according to ON_P.
28130 Don't change the cursor's position. */
28133 x_update_cursor (struct frame
*f
, bool on_p
)
28135 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
28140 Clear the cursor of window W to background color, and mark the
28141 cursor as not shown. This is used when the text where the cursor
28142 is about to be rewritten. */
28145 x_clear_cursor (struct window
*w
)
28147 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
28148 update_window_cursor (w
, false);
28151 #endif /* HAVE_WINDOW_SYSTEM */
28153 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28156 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
28157 int start_hpos
, int end_hpos
,
28158 enum draw_glyphs_face draw
)
28160 #ifdef HAVE_WINDOW_SYSTEM
28161 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
28163 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
28167 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28168 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
28172 /* Display the active region described by mouse_face_* according to DRAW. */
28175 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
28177 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
28178 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
28180 if (/* If window is in the process of being destroyed, don't bother
28182 w
->current_matrix
!= NULL
28183 /* Don't update mouse highlight if hidden. */
28184 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
28185 /* Recognize when we are called to operate on rows that don't exist
28186 anymore. This can happen when a window is split. */
28187 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
28189 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
28190 struct glyph_row
*row
, *first
, *last
;
28192 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
28193 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
28195 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
28197 int start_hpos
, end_hpos
, start_x
;
28199 /* For all but the first row, the highlight starts at column 0. */
28202 /* R2L rows have BEG and END in reversed order, but the
28203 screen drawing geometry is always left to right. So
28204 we need to mirror the beginning and end of the
28205 highlighted area in R2L rows. */
28206 if (!row
->reversed_p
)
28208 start_hpos
= hlinfo
->mouse_face_beg_col
;
28209 start_x
= hlinfo
->mouse_face_beg_x
;
28211 else if (row
== last
)
28213 start_hpos
= hlinfo
->mouse_face_end_col
;
28214 start_x
= hlinfo
->mouse_face_end_x
;
28222 else if (row
->reversed_p
&& row
== last
)
28224 start_hpos
= hlinfo
->mouse_face_end_col
;
28225 start_x
= hlinfo
->mouse_face_end_x
;
28235 if (!row
->reversed_p
)
28236 end_hpos
= hlinfo
->mouse_face_end_col
;
28237 else if (row
== first
)
28238 end_hpos
= hlinfo
->mouse_face_beg_col
;
28241 end_hpos
= row
->used
[TEXT_AREA
];
28242 if (draw
== DRAW_NORMAL_TEXT
)
28243 row
->fill_line_p
= true; /* Clear to end of line. */
28246 else if (row
->reversed_p
&& row
== first
)
28247 end_hpos
= hlinfo
->mouse_face_beg_col
;
28250 end_hpos
= row
->used
[TEXT_AREA
];
28251 if (draw
== DRAW_NORMAL_TEXT
)
28252 row
->fill_line_p
= true; /* Clear to end of line. */
28255 if (end_hpos
> start_hpos
)
28257 draw_row_with_mouse_face (w
, start_x
, row
,
28258 start_hpos
, end_hpos
, draw
);
28261 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
28265 #ifdef HAVE_WINDOW_SYSTEM
28266 /* When we've written over the cursor, arrange for it to
28267 be displayed again. */
28268 if (FRAME_WINDOW_P (f
)
28269 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
28271 int hpos
= w
->phys_cursor
.hpos
;
28273 /* When the window is hscrolled, cursor hpos can legitimately be
28274 out of bounds, but we draw the cursor at the corresponding
28275 window margin in that case. */
28276 if (!row
->reversed_p
&& hpos
< 0)
28278 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28279 hpos
= row
->used
[TEXT_AREA
] - 1;
28282 display_and_set_cursor (w
, true, hpos
, w
->phys_cursor
.vpos
,
28283 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
28286 #endif /* HAVE_WINDOW_SYSTEM */
28289 #ifdef HAVE_WINDOW_SYSTEM
28290 /* Change the mouse cursor. */
28291 if (FRAME_WINDOW_P (f
) && NILP (do_mouse_tracking
))
28293 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28294 if (draw
== DRAW_NORMAL_TEXT
28295 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
28296 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
28299 if (draw
== DRAW_MOUSE_FACE
)
28300 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
28302 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
28304 #endif /* HAVE_WINDOW_SYSTEM */
28308 Clear out the mouse-highlighted active region.
28309 Redraw it un-highlighted first. Value is true if mouse
28310 face was actually drawn unhighlighted. */
28313 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
28316 = !hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
);
28318 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
28319 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
28320 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
28321 hlinfo
->mouse_face_window
= Qnil
;
28322 hlinfo
->mouse_face_overlay
= Qnil
;
28326 /* Return true if the coordinates HPOS and VPOS on windows W are
28327 within the mouse face on that window. */
28329 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28331 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28333 /* Quickly resolve the easy cases. */
28334 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28335 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28337 if (vpos
< hlinfo
->mouse_face_beg_row
28338 || vpos
> hlinfo
->mouse_face_end_row
)
28340 if (vpos
> hlinfo
->mouse_face_beg_row
28341 && vpos
< hlinfo
->mouse_face_end_row
)
28344 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28346 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28348 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28351 else if ((vpos
== hlinfo
->mouse_face_beg_row
28352 && hpos
>= hlinfo
->mouse_face_beg_col
)
28353 || (vpos
== hlinfo
->mouse_face_end_row
28354 && hpos
< hlinfo
->mouse_face_end_col
))
28359 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28361 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28364 else if ((vpos
== hlinfo
->mouse_face_beg_row
28365 && hpos
<= hlinfo
->mouse_face_beg_col
)
28366 || (vpos
== hlinfo
->mouse_face_end_row
28367 && hpos
> hlinfo
->mouse_face_end_col
))
28375 True if physical cursor of window W is within mouse face. */
28378 cursor_in_mouse_face_p (struct window
*w
)
28380 int hpos
= w
->phys_cursor
.hpos
;
28381 int vpos
= w
->phys_cursor
.vpos
;
28382 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28384 /* When the window is hscrolled, cursor hpos can legitimately be out
28385 of bounds, but we draw the cursor at the corresponding window
28386 margin in that case. */
28387 if (!row
->reversed_p
&& hpos
< 0)
28389 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28390 hpos
= row
->used
[TEXT_AREA
] - 1;
28392 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28397 /* Find the glyph rows START_ROW and END_ROW of window W that display
28398 characters between buffer positions START_CHARPOS and END_CHARPOS
28399 (excluding END_CHARPOS). DISP_STRING is a display string that
28400 covers these buffer positions. This is similar to
28401 row_containing_pos, but is more accurate when bidi reordering makes
28402 buffer positions change non-linearly with glyph rows. */
28404 rows_from_pos_range (struct window
*w
,
28405 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28406 Lisp_Object disp_string
,
28407 struct glyph_row
**start
, struct glyph_row
**end
)
28409 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28410 int last_y
= window_text_bottom_y (w
);
28411 struct glyph_row
*row
;
28416 while (!first
->enabled_p
28417 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28420 /* Find the START row. */
28422 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28425 /* A row can potentially be the START row if the range of the
28426 characters it displays intersects the range
28427 [START_CHARPOS..END_CHARPOS). */
28428 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28429 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28430 /* See the commentary in row_containing_pos, for the
28431 explanation of the complicated way to check whether
28432 some position is beyond the end of the characters
28433 displayed by a row. */
28434 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28435 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28436 && !row
->ends_at_zv_p
28437 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28438 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28439 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28440 && !row
->ends_at_zv_p
28441 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28443 /* Found a candidate row. Now make sure at least one of the
28444 glyphs it displays has a charpos from the range
28445 [START_CHARPOS..END_CHARPOS).
28447 This is not obvious because bidi reordering could make
28448 buffer positions of a row be 1,2,3,102,101,100, and if we
28449 want to highlight characters in [50..60), we don't want
28450 this row, even though [50..60) does intersect [1..103),
28451 the range of character positions given by the row's start
28452 and end positions. */
28453 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28454 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28458 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28459 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28460 /* A glyph that comes from DISP_STRING is by
28461 definition to be highlighted. */
28462 || EQ (g
->object
, disp_string
))
28471 /* Find the END row. */
28473 /* If the last row is partially visible, start looking for END
28474 from that row, instead of starting from FIRST. */
28475 && !(row
->enabled_p
28476 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28478 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28480 struct glyph_row
*next
= row
+ 1;
28481 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28483 if (!next
->enabled_p
28484 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28485 /* The first row >= START whose range of displayed characters
28486 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28487 is the row END + 1. */
28488 || (start_charpos
< next_start
28489 && end_charpos
< next_start
)
28490 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28491 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28492 && !next
->ends_at_zv_p
28493 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28494 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28495 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28496 && !next
->ends_at_zv_p
28497 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28504 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28505 but none of the characters it displays are in the range, it is
28507 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28508 struct glyph
*s
= g
;
28509 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28513 if (((BUFFERP (g
->object
) || NILP (g
->object
))
28514 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28515 /* If the buffer position of the first glyph in
28516 the row is equal to END_CHARPOS, it means
28517 the last character to be highlighted is the
28518 newline of ROW, and we must consider NEXT as
28520 || (((!next
->reversed_p
&& g
== s
)
28521 || (next
->reversed_p
&& g
== e
- 1))
28522 && (g
->charpos
== end_charpos
28523 /* Special case for when NEXT is an
28524 empty line at ZV. */
28525 || (g
->charpos
== -1
28526 && !row
->ends_at_zv_p
28527 && next_start
== end_charpos
)))))
28528 /* A glyph that comes from DISP_STRING is by
28529 definition to be highlighted. */
28530 || EQ (g
->object
, disp_string
))
28539 /* The first row that ends at ZV must be the last to be
28541 else if (next
->ends_at_zv_p
)
28550 /* This function sets the mouse_face_* elements of HLINFO, assuming
28551 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28552 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28553 for the overlay or run of text properties specifying the mouse
28554 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28555 before-string and after-string that must also be highlighted.
28556 DISP_STRING, if non-nil, is a display string that may cover some
28557 or all of the highlighted text. */
28560 mouse_face_from_buffer_pos (Lisp_Object window
,
28561 Mouse_HLInfo
*hlinfo
,
28562 ptrdiff_t mouse_charpos
,
28563 ptrdiff_t start_charpos
,
28564 ptrdiff_t end_charpos
,
28565 Lisp_Object before_string
,
28566 Lisp_Object after_string
,
28567 Lisp_Object disp_string
)
28569 struct window
*w
= XWINDOW (window
);
28570 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28571 struct glyph_row
*r1
, *r2
;
28572 struct glyph
*glyph
, *end
;
28573 ptrdiff_t ignore
, pos
;
28576 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28577 eassert (NILP (before_string
) || STRINGP (before_string
));
28578 eassert (NILP (after_string
) || STRINGP (after_string
));
28580 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28581 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28583 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28584 /* If the before-string or display-string contains newlines,
28585 rows_from_pos_range skips to its last row. Move back. */
28586 if (!NILP (before_string
) || !NILP (disp_string
))
28588 struct glyph_row
*prev
;
28589 while ((prev
= r1
- 1, prev
>= first
)
28590 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28591 && prev
->used
[TEXT_AREA
] > 0)
28593 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28594 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28595 while (--glyph
>= beg
&& NILP (glyph
->object
));
28597 || !(EQ (glyph
->object
, before_string
)
28598 || EQ (glyph
->object
, disp_string
)))
28605 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28606 hlinfo
->mouse_face_past_end
= true;
28608 else if (!NILP (after_string
))
28610 /* If the after-string has newlines, advance to its last row. */
28611 struct glyph_row
*next
;
28612 struct glyph_row
*last
28613 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28615 for (next
= r2
+ 1;
28617 && next
->used
[TEXT_AREA
] > 0
28618 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28622 /* The rest of the display engine assumes that mouse_face_beg_row is
28623 either above mouse_face_end_row or identical to it. But with
28624 bidi-reordered continued lines, the row for START_CHARPOS could
28625 be below the row for END_CHARPOS. If so, swap the rows and store
28626 them in correct order. */
28629 struct glyph_row
*tem
= r2
;
28635 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28636 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28638 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28639 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28640 could be anywhere in the row and in any order. The strategy
28641 below is to find the leftmost and the rightmost glyph that
28642 belongs to either of these 3 strings, or whose position is
28643 between START_CHARPOS and END_CHARPOS, and highlight all the
28644 glyphs between those two. This may cover more than just the text
28645 between START_CHARPOS and END_CHARPOS if the range of characters
28646 strides the bidi level boundary, e.g. if the beginning is in R2L
28647 text while the end is in L2R text or vice versa. */
28648 if (!r1
->reversed_p
)
28650 /* This row is in a left to right paragraph. Scan it left to
28652 glyph
= r1
->glyphs
[TEXT_AREA
];
28653 end
= glyph
+ r1
->used
[TEXT_AREA
];
28656 /* Skip truncation glyphs at the start of the glyph row. */
28657 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28659 && NILP (glyph
->object
)
28660 && glyph
->charpos
< 0;
28662 x
+= glyph
->pixel_width
;
28664 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28665 or DISP_STRING, and the first glyph from buffer whose
28666 position is between START_CHARPOS and END_CHARPOS. */
28668 && !NILP (glyph
->object
)
28669 && !EQ (glyph
->object
, disp_string
)
28670 && !(BUFFERP (glyph
->object
)
28671 && (glyph
->charpos
>= start_charpos
28672 && glyph
->charpos
< end_charpos
));
28675 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28676 are present at buffer positions between START_CHARPOS and
28677 END_CHARPOS, or if they come from an overlay. */
28678 if (EQ (glyph
->object
, before_string
))
28680 pos
= string_buffer_position (before_string
,
28682 /* If pos == 0, it means before_string came from an
28683 overlay, not from a buffer position. */
28684 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28687 else if (EQ (glyph
->object
, after_string
))
28689 pos
= string_buffer_position (after_string
, end_charpos
);
28690 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28693 x
+= glyph
->pixel_width
;
28695 hlinfo
->mouse_face_beg_x
= x
;
28696 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28700 /* This row is in a right to left paragraph. Scan it right to
28704 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28705 glyph
= end
+ r1
->used
[TEXT_AREA
];
28707 /* Skip truncation glyphs at the start of the glyph row. */
28708 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28710 && NILP (glyph
->object
)
28711 && glyph
->charpos
< 0;
28715 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28716 or DISP_STRING, and the first glyph from buffer whose
28717 position is between START_CHARPOS and END_CHARPOS. */
28719 && !NILP (glyph
->object
)
28720 && !EQ (glyph
->object
, disp_string
)
28721 && !(BUFFERP (glyph
->object
)
28722 && (glyph
->charpos
>= start_charpos
28723 && glyph
->charpos
< end_charpos
));
28726 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28727 are present at buffer positions between START_CHARPOS and
28728 END_CHARPOS, or if they come from an overlay. */
28729 if (EQ (glyph
->object
, before_string
))
28731 pos
= string_buffer_position (before_string
, start_charpos
);
28732 /* If pos == 0, it means before_string came from an
28733 overlay, not from a buffer position. */
28734 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28737 else if (EQ (glyph
->object
, after_string
))
28739 pos
= string_buffer_position (after_string
, end_charpos
);
28740 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28745 glyph
++; /* first glyph to the right of the highlighted area */
28746 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28747 x
+= g
->pixel_width
;
28748 hlinfo
->mouse_face_beg_x
= x
;
28749 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28752 /* If the highlight ends in a different row, compute GLYPH and END
28753 for the end row. Otherwise, reuse the values computed above for
28754 the row where the highlight begins. */
28757 if (!r2
->reversed_p
)
28759 glyph
= r2
->glyphs
[TEXT_AREA
];
28760 end
= glyph
+ r2
->used
[TEXT_AREA
];
28765 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28766 glyph
= end
+ r2
->used
[TEXT_AREA
];
28770 if (!r2
->reversed_p
)
28772 /* Skip truncation and continuation glyphs near the end of the
28773 row, and also blanks and stretch glyphs inserted by
28774 extend_face_to_end_of_line. */
28776 && NILP ((end
- 1)->object
))
28778 /* Scan the rest of the glyph row from the end, looking for the
28779 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28780 DISP_STRING, or whose position is between START_CHARPOS
28784 && !NILP (end
->object
)
28785 && !EQ (end
->object
, disp_string
)
28786 && !(BUFFERP (end
->object
)
28787 && (end
->charpos
>= start_charpos
28788 && end
->charpos
< end_charpos
));
28791 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28792 are present at buffer positions between START_CHARPOS and
28793 END_CHARPOS, or if they come from an overlay. */
28794 if (EQ (end
->object
, before_string
))
28796 pos
= string_buffer_position (before_string
, start_charpos
);
28797 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28800 else if (EQ (end
->object
, after_string
))
28802 pos
= string_buffer_position (after_string
, end_charpos
);
28803 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28807 /* Find the X coordinate of the last glyph to be highlighted. */
28808 for (; glyph
<= end
; ++glyph
)
28809 x
+= glyph
->pixel_width
;
28811 hlinfo
->mouse_face_end_x
= x
;
28812 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28816 /* Skip truncation and continuation glyphs near the end of the
28817 row, and also blanks and stretch glyphs inserted by
28818 extend_face_to_end_of_line. */
28822 && NILP (end
->object
))
28824 x
+= end
->pixel_width
;
28827 /* Scan the rest of the glyph row from the end, looking for the
28828 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28829 DISP_STRING, or whose position is between START_CHARPOS
28833 && !NILP (end
->object
)
28834 && !EQ (end
->object
, disp_string
)
28835 && !(BUFFERP (end
->object
)
28836 && (end
->charpos
>= start_charpos
28837 && end
->charpos
< end_charpos
));
28840 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28841 are present at buffer positions between START_CHARPOS and
28842 END_CHARPOS, or if they come from an overlay. */
28843 if (EQ (end
->object
, before_string
))
28845 pos
= string_buffer_position (before_string
, start_charpos
);
28846 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28849 else if (EQ (end
->object
, after_string
))
28851 pos
= string_buffer_position (after_string
, end_charpos
);
28852 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28855 x
+= end
->pixel_width
;
28857 /* If we exited the above loop because we arrived at the last
28858 glyph of the row, and its buffer position is still not in
28859 range, it means the last character in range is the preceding
28860 newline. Bump the end column and x values to get past the
28863 && BUFFERP (end
->object
)
28864 && (end
->charpos
< start_charpos
28865 || end
->charpos
>= end_charpos
))
28867 x
+= end
->pixel_width
;
28870 hlinfo
->mouse_face_end_x
= x
;
28871 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28874 hlinfo
->mouse_face_window
= window
;
28875 hlinfo
->mouse_face_face_id
28876 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28878 !hlinfo
->mouse_face_hidden
, -1);
28879 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28882 /* The following function is not used anymore (replaced with
28883 mouse_face_from_string_pos), but I leave it here for the time
28884 being, in case someone would. */
28886 #if false /* not used */
28888 /* Find the position of the glyph for position POS in OBJECT in
28889 window W's current matrix, and return in *X, *Y the pixel
28890 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28892 RIGHT_P means return the position of the right edge of the glyph.
28893 !RIGHT_P means return the left edge position.
28895 If no glyph for POS exists in the matrix, return the position of
28896 the glyph with the next smaller position that is in the matrix, if
28897 RIGHT_P is false. If RIGHT_P, and no glyph for POS
28898 exists in the matrix, return the position of the glyph with the
28899 next larger position in OBJECT.
28901 Value is true if a glyph was found. */
28904 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28905 int *hpos
, int *vpos
, int *x
, int *y
, bool right_p
)
28907 int yb
= window_text_bottom_y (w
);
28908 struct glyph_row
*r
;
28909 struct glyph
*best_glyph
= NULL
;
28910 struct glyph_row
*best_row
= NULL
;
28913 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28914 r
->enabled_p
&& r
->y
< yb
;
28917 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28918 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28921 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28922 if (EQ (g
->object
, object
))
28924 if (g
->charpos
== pos
)
28931 else if (best_glyph
== NULL
28932 || ((eabs (g
->charpos
- pos
)
28933 < eabs (best_glyph
->charpos
- pos
))
28936 : g
->charpos
> pos
)))
28950 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28954 *x
+= best_glyph
->pixel_width
;
28959 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28962 return best_glyph
!= NULL
;
28964 #endif /* not used */
28966 /* Find the positions of the first and the last glyphs in window W's
28967 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28968 (assumed to be a string), and return in HLINFO's mouse_face_*
28969 members the pixel and column/row coordinates of those glyphs. */
28972 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28973 Lisp_Object object
,
28974 ptrdiff_t startpos
, ptrdiff_t endpos
)
28976 int yb
= window_text_bottom_y (w
);
28977 struct glyph_row
*r
;
28978 struct glyph
*g
, *e
;
28980 bool found
= false;
28982 /* Find the glyph row with at least one position in the range
28983 [STARTPOS..ENDPOS), and the first glyph in that row whose
28984 position belongs to that range. */
28985 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28986 r
->enabled_p
&& r
->y
< yb
;
28989 if (!r
->reversed_p
)
28991 g
= r
->glyphs
[TEXT_AREA
];
28992 e
= g
+ r
->used
[TEXT_AREA
];
28993 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28994 if (EQ (g
->object
, object
)
28995 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28997 hlinfo
->mouse_face_beg_row
28998 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28999 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29000 hlinfo
->mouse_face_beg_x
= gx
;
29009 e
= r
->glyphs
[TEXT_AREA
];
29010 g
= e
+ r
->used
[TEXT_AREA
];
29011 for ( ; g
> e
; --g
)
29012 if (EQ ((g
-1)->object
, object
)
29013 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
29015 hlinfo
->mouse_face_beg_row
29016 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29017 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
29018 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
29019 gx
+= g1
->pixel_width
;
29020 hlinfo
->mouse_face_beg_x
= gx
;
29032 /* Starting with the next row, look for the first row which does NOT
29033 include any glyphs whose positions are in the range. */
29034 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
29036 g
= r
->glyphs
[TEXT_AREA
];
29037 e
= g
+ r
->used
[TEXT_AREA
];
29039 for ( ; g
< e
; ++g
)
29040 if (EQ (g
->object
, object
)
29041 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
29050 /* The highlighted region ends on the previous row. */
29053 /* Set the end row. */
29054 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
29056 /* Compute and set the end column and the end column's horizontal
29057 pixel coordinate. */
29058 if (!r
->reversed_p
)
29060 g
= r
->glyphs
[TEXT_AREA
];
29061 e
= g
+ r
->used
[TEXT_AREA
];
29062 for ( ; e
> g
; --e
)
29063 if (EQ ((e
-1)->object
, object
)
29064 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
29066 hlinfo
->mouse_face_end_col
= e
- g
;
29068 for (gx
= r
->x
; g
< e
; ++g
)
29069 gx
+= g
->pixel_width
;
29070 hlinfo
->mouse_face_end_x
= gx
;
29074 e
= r
->glyphs
[TEXT_AREA
];
29075 g
= e
+ r
->used
[TEXT_AREA
];
29076 for (gx
= r
->x
; e
< g
; ++e
)
29078 if (EQ (e
->object
, object
)
29079 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
29081 gx
+= e
->pixel_width
;
29083 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
29084 hlinfo
->mouse_face_end_x
= gx
;
29088 #ifdef HAVE_WINDOW_SYSTEM
29090 /* See if position X, Y is within a hot-spot of an image. */
29093 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
29095 if (!CONSP (hot_spot
))
29098 if (EQ (XCAR (hot_spot
), Qrect
))
29100 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29101 Lisp_Object rect
= XCDR (hot_spot
);
29105 if (!CONSP (XCAR (rect
)))
29107 if (!CONSP (XCDR (rect
)))
29109 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
29111 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
29113 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
29115 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
29119 else if (EQ (XCAR (hot_spot
), Qcircle
))
29121 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29122 Lisp_Object circ
= XCDR (hot_spot
);
29123 Lisp_Object lr
, lx0
, ly0
;
29125 && CONSP (XCAR (circ
))
29126 && (lr
= XCDR (circ
), NUMBERP (lr
))
29127 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
29128 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
29130 double r
= XFLOATINT (lr
);
29131 double dx
= XINT (lx0
) - x
;
29132 double dy
= XINT (ly0
) - y
;
29133 return (dx
* dx
+ dy
* dy
<= r
* r
);
29136 else if (EQ (XCAR (hot_spot
), Qpoly
))
29138 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29139 if (VECTORP (XCDR (hot_spot
)))
29141 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
29142 Lisp_Object
*poly
= v
->contents
;
29143 ptrdiff_t n
= v
->header
.size
;
29145 bool inside
= false;
29146 Lisp_Object lx
, ly
;
29149 /* Need an even number of coordinates, and at least 3 edges. */
29150 if (n
< 6 || n
& 1)
29153 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29154 If count is odd, we are inside polygon. Pixels on edges
29155 may or may not be included depending on actual geometry of the
29157 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
29158 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
29160 x0
= XINT (lx
), y0
= XINT (ly
);
29161 for (i
= 0; i
< n
; i
+= 2)
29163 int x1
= x0
, y1
= y0
;
29164 if ((lx
= poly
[i
], !INTEGERP (lx
))
29165 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
29167 x0
= XINT (lx
), y0
= XINT (ly
);
29169 /* Does this segment cross the X line? */
29177 if (y
> y0
&& y
> y1
)
29179 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
29189 find_hot_spot (Lisp_Object map
, int x
, int y
)
29191 while (CONSP (map
))
29193 if (CONSP (XCAR (map
))
29194 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
29202 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
29204 doc
: /* Lookup in image map MAP coordinates X and Y.
29205 An image map is an alist where each element has the format (AREA ID PLIST).
29206 An AREA is specified as either a rectangle, a circle, or a polygon:
29207 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29208 pixel coordinates of the upper left and bottom right corners.
29209 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29210 and the radius of the circle; r may be a float or integer.
29211 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29212 vector describes one corner in the polygon.
29213 Returns the alist element for the first matching AREA in MAP. */)
29214 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
29222 return find_hot_spot (map
,
29223 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
29224 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
29228 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29230 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
29232 /* Do not change cursor shape while dragging mouse. */
29233 if (EQ (do_mouse_tracking
, Qdragging
))
29236 if (!NILP (pointer
))
29238 if (EQ (pointer
, Qarrow
))
29239 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29240 else if (EQ (pointer
, Qhand
))
29241 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
29242 else if (EQ (pointer
, Qtext
))
29243 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29244 else if (EQ (pointer
, intern ("hdrag")))
29245 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29246 else if (EQ (pointer
, intern ("nhdrag")))
29247 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29248 #ifdef HAVE_X_WINDOWS
29249 else if (EQ (pointer
, intern ("vdrag")))
29250 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29252 else if (EQ (pointer
, intern ("hourglass")))
29253 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
29254 else if (EQ (pointer
, Qmodeline
))
29255 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
29257 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29260 if (cursor
!= No_Cursor
)
29261 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
29264 #endif /* HAVE_WINDOW_SYSTEM */
29266 /* Take proper action when mouse has moved to the mode or header line
29267 or marginal area AREA of window W, x-position X and y-position Y.
29268 X is relative to the start of the text display area of W, so the
29269 width of bitmap areas and scroll bars must be subtracted to get a
29270 position relative to the start of the mode line. */
29273 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
29274 enum window_part area
)
29276 struct window
*w
= XWINDOW (window
);
29277 struct frame
*f
= XFRAME (w
->frame
);
29278 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29279 #ifdef HAVE_WINDOW_SYSTEM
29280 Display_Info
*dpyinfo
;
29282 Cursor cursor
= No_Cursor
;
29283 Lisp_Object pointer
= Qnil
;
29284 int dx
, dy
, width
, height
;
29286 Lisp_Object string
, object
= Qnil
;
29287 Lisp_Object pos
IF_LINT (= Qnil
), help
;
29289 Lisp_Object mouse_face
;
29290 int original_x_pixel
= x
;
29291 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
29292 struct glyph_row
*row
IF_LINT (= 0);
29294 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
29299 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29300 returns them in row/column units! */
29301 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
29302 &object
, &dx
, &dy
, &width
, &height
);
29304 row
= (area
== ON_MODE_LINE
29305 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
29306 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
29308 /* Find the glyph under the mouse pointer. */
29309 if (row
->mode_line_p
&& row
->enabled_p
)
29311 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
29312 end
= glyph
+ row
->used
[TEXT_AREA
];
29314 for (x0
= original_x_pixel
;
29315 glyph
< end
&& x0
>= glyph
->pixel_width
;
29317 x0
-= glyph
->pixel_width
;
29325 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
29326 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29327 returns them in row/column units! */
29328 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
29329 &object
, &dx
, &dy
, &width
, &height
);
29334 #ifdef HAVE_WINDOW_SYSTEM
29335 if (IMAGEP (object
))
29337 Lisp_Object image_map
, hotspot
;
29338 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29340 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29342 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29346 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29347 If so, we could look for mouse-enter, mouse-leave
29348 properties in PLIST (and do something...). */
29349 hotspot
= XCDR (hotspot
);
29350 if (CONSP (hotspot
)
29351 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29353 pointer
= Fplist_get (plist
, Qpointer
);
29354 if (NILP (pointer
))
29356 help
= Fplist_get (plist
, Qhelp_echo
);
29359 help_echo_string
= help
;
29360 XSETWINDOW (help_echo_window
, w
);
29361 help_echo_object
= w
->contents
;
29362 help_echo_pos
= charpos
;
29366 if (NILP (pointer
))
29367 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29369 #endif /* HAVE_WINDOW_SYSTEM */
29371 if (STRINGP (string
))
29372 pos
= make_number (charpos
);
29374 /* Set the help text and mouse pointer. If the mouse is on a part
29375 of the mode line without any text (e.g. past the right edge of
29376 the mode line text), use the default help text and pointer. */
29377 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29379 /* Arrange to display the help by setting the global variables
29380 help_echo_string, help_echo_object, and help_echo_pos. */
29383 if (STRINGP (string
))
29384 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29388 help_echo_string
= help
;
29389 XSETWINDOW (help_echo_window
, w
);
29390 help_echo_object
= string
;
29391 help_echo_pos
= charpos
;
29393 else if (area
== ON_MODE_LINE
)
29395 Lisp_Object default_help
29396 = buffer_local_value (Qmode_line_default_help_echo
,
29399 if (STRINGP (default_help
))
29401 help_echo_string
= default_help
;
29402 XSETWINDOW (help_echo_window
, w
);
29403 help_echo_object
= Qnil
;
29404 help_echo_pos
= -1;
29409 #ifdef HAVE_WINDOW_SYSTEM
29410 /* Change the mouse pointer according to what is under it. */
29411 if (FRAME_WINDOW_P (f
))
29413 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29415 || NILP (Vresize_mini_windows
));
29417 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29418 if (STRINGP (string
))
29420 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29422 if (NILP (pointer
))
29423 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29425 /* Change the mouse pointer according to what is under X/Y. */
29427 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29430 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29431 if (!KEYMAPP (map
))
29432 map
= Fget_text_property (pos
, Qkeymap
, string
);
29433 if (!KEYMAPP (map
) && draggable
)
29434 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29437 else if (draggable
)
29438 /* Default mode-line pointer. */
29439 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29444 /* Change the mouse face according to what is under X/Y. */
29445 bool mouse_face_shown
= false;
29446 if (STRINGP (string
))
29448 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29449 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29450 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29455 struct glyph
* tmp_glyph
;
29459 int total_pixel_width
;
29460 ptrdiff_t begpos
, endpos
, ignore
;
29464 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29465 Qmouse_face
, string
, Qnil
);
29471 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29473 endpos
= SCHARS (string
);
29477 /* Calculate the glyph position GPOS of GLYPH in the
29478 displayed string, relative to the beginning of the
29479 highlighted part of the string.
29481 Note: GPOS is different from CHARPOS. CHARPOS is the
29482 position of GLYPH in the internal string object. A mode
29483 line string format has structures which are converted to
29484 a flattened string by the Emacs Lisp interpreter. The
29485 internal string is an element of those structures. The
29486 displayed string is the flattened string. */
29487 tmp_glyph
= row_start_glyph
;
29488 while (tmp_glyph
< glyph
29489 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29490 && begpos
<= tmp_glyph
->charpos
29491 && tmp_glyph
->charpos
< endpos
)))
29493 gpos
= glyph
- tmp_glyph
;
29495 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29496 the highlighted part of the displayed string to which
29497 GLYPH belongs. Note: GSEQ_LENGTH is different from
29498 SCHARS (STRING), because the latter returns the length of
29499 the internal string. */
29500 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29502 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29503 && begpos
<= tmp_glyph
->charpos
29504 && tmp_glyph
->charpos
< endpos
));
29507 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29509 /* Calculate the total pixel width of all the glyphs between
29510 the beginning of the highlighted area and GLYPH. */
29511 total_pixel_width
= 0;
29512 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29513 total_pixel_width
+= tmp_glyph
->pixel_width
;
29515 /* Pre calculation of re-rendering position. Note: X is in
29516 column units here, after the call to mode_line_string or
29517 marginal_area_string. */
29519 vpos
= (area
== ON_MODE_LINE
29520 ? (w
->current_matrix
)->nrows
- 1
29523 /* If GLYPH's position is included in the region that is
29524 already drawn in mouse face, we have nothing to do. */
29525 if ( EQ (window
, hlinfo
->mouse_face_window
)
29526 && (!row
->reversed_p
29527 ? (hlinfo
->mouse_face_beg_col
<= hpos
29528 && hpos
< hlinfo
->mouse_face_end_col
)
29529 /* In R2L rows we swap BEG and END, see below. */
29530 : (hlinfo
->mouse_face_end_col
<= hpos
29531 && hpos
< hlinfo
->mouse_face_beg_col
))
29532 && hlinfo
->mouse_face_beg_row
== vpos
)
29535 if (clear_mouse_face (hlinfo
))
29536 cursor
= No_Cursor
;
29538 if (!row
->reversed_p
)
29540 hlinfo
->mouse_face_beg_col
= hpos
;
29541 hlinfo
->mouse_face_beg_x
= original_x_pixel
29542 - (total_pixel_width
+ dx
);
29543 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29544 hlinfo
->mouse_face_end_x
= 0;
29548 /* In R2L rows, show_mouse_face expects BEG and END
29549 coordinates to be swapped. */
29550 hlinfo
->mouse_face_end_col
= hpos
;
29551 hlinfo
->mouse_face_end_x
= original_x_pixel
29552 - (total_pixel_width
+ dx
);
29553 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29554 hlinfo
->mouse_face_beg_x
= 0;
29557 hlinfo
->mouse_face_beg_row
= vpos
;
29558 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29559 hlinfo
->mouse_face_past_end
= false;
29560 hlinfo
->mouse_face_window
= window
;
29562 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29567 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29568 mouse_face_shown
= true;
29570 if (NILP (pointer
))
29575 /* If mouse-face doesn't need to be shown, clear any existing
29577 if ((area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
) && !mouse_face_shown
)
29578 clear_mouse_face (hlinfo
);
29580 #ifdef HAVE_WINDOW_SYSTEM
29581 if (FRAME_WINDOW_P (f
))
29582 define_frame_cursor1 (f
, cursor
, pointer
);
29588 Take proper action when the mouse has moved to position X, Y on
29589 frame F with regards to highlighting portions of display that have
29590 mouse-face properties. Also de-highlight portions of display where
29591 the mouse was before, set the mouse pointer shape as appropriate
29592 for the mouse coordinates, and activate help echo (tooltips).
29593 X and Y can be negative or out of range. */
29596 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29598 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29599 enum window_part part
= ON_NOTHING
;
29600 Lisp_Object window
;
29602 Cursor cursor
= No_Cursor
;
29603 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29606 /* When a menu is active, don't highlight because this looks odd. */
29607 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29608 if (popup_activated ())
29612 if (!f
->glyphs_initialized_p
29613 || f
->pointer_invisible
)
29616 hlinfo
->mouse_face_mouse_x
= x
;
29617 hlinfo
->mouse_face_mouse_y
= y
;
29618 hlinfo
->mouse_face_mouse_frame
= f
;
29620 if (hlinfo
->mouse_face_defer
)
29623 /* Which window is that in? */
29624 window
= window_from_coordinates (f
, x
, y
, &part
, true);
29626 /* If displaying active text in another window, clear that. */
29627 if (! EQ (window
, hlinfo
->mouse_face_window
)
29628 /* Also clear if we move out of text area in same window. */
29629 || (!NILP (hlinfo
->mouse_face_window
)
29632 && part
!= ON_MODE_LINE
29633 && part
!= ON_HEADER_LINE
))
29634 clear_mouse_face (hlinfo
);
29636 /* Not on a window -> return. */
29637 if (!WINDOWP (window
))
29640 /* Reset help_echo_string. It will get recomputed below. */
29641 help_echo_string
= Qnil
;
29643 /* Convert to window-relative pixel coordinates. */
29644 w
= XWINDOW (window
);
29645 frame_to_window_pixel_xy (w
, &x
, &y
);
29647 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29648 /* Handle tool-bar window differently since it doesn't display a
29650 if (EQ (window
, f
->tool_bar_window
))
29652 note_tool_bar_highlight (f
, x
, y
);
29657 /* Mouse is on the mode, header line or margin? */
29658 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29659 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29661 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29663 #ifdef HAVE_WINDOW_SYSTEM
29664 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29666 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29667 /* Show non-text cursor (Bug#16647). */
29675 #ifdef HAVE_WINDOW_SYSTEM
29676 if (part
== ON_VERTICAL_BORDER
)
29678 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29679 help_echo_string
= build_string ("drag-mouse-1: resize");
29681 else if (part
== ON_RIGHT_DIVIDER
)
29683 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29684 help_echo_string
= build_string ("drag-mouse-1: resize");
29686 else if (part
== ON_BOTTOM_DIVIDER
)
29687 if (! WINDOW_BOTTOMMOST_P (w
)
29689 || NILP (Vresize_mini_windows
))
29691 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29692 help_echo_string
= build_string ("drag-mouse-1: resize");
29695 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29696 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29697 || part
== ON_VERTICAL_SCROLL_BAR
29698 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29699 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29701 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29704 /* Are we in a window whose display is up to date?
29705 And verify the buffer's text has not changed. */
29706 b
= XBUFFER (w
->contents
);
29707 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29709 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29711 struct glyph
*glyph
;
29712 Lisp_Object object
;
29713 Lisp_Object mouse_face
= Qnil
, position
;
29714 Lisp_Object
*overlay_vec
= NULL
;
29715 ptrdiff_t i
, noverlays
;
29716 struct buffer
*obuf
;
29717 ptrdiff_t obegv
, ozv
;
29720 /* Find the glyph under X/Y. */
29721 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29723 #ifdef HAVE_WINDOW_SYSTEM
29724 /* Look for :pointer property on image. */
29725 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29727 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29728 if (img
!= NULL
&& IMAGEP (img
->spec
))
29730 Lisp_Object image_map
, hotspot
;
29731 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29733 && (hotspot
= find_hot_spot (image_map
,
29734 glyph
->slice
.img
.x
+ dx
,
29735 glyph
->slice
.img
.y
+ dy
),
29737 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29741 /* Could check XCAR (hotspot) to see if we enter/leave
29743 If so, we could look for mouse-enter, mouse-leave
29744 properties in PLIST (and do something...). */
29745 hotspot
= XCDR (hotspot
);
29746 if (CONSP (hotspot
)
29747 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29749 pointer
= Fplist_get (plist
, Qpointer
);
29750 if (NILP (pointer
))
29752 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29753 if (!NILP (help_echo_string
))
29755 help_echo_window
= window
;
29756 help_echo_object
= glyph
->object
;
29757 help_echo_pos
= glyph
->charpos
;
29761 if (NILP (pointer
))
29762 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29765 #endif /* HAVE_WINDOW_SYSTEM */
29767 /* Clear mouse face if X/Y not over text. */
29769 || area
!= TEXT_AREA
29770 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29771 /* Glyph's OBJECT is nil for glyphs inserted by the
29772 display engine for its internal purposes, like truncation
29773 and continuation glyphs and blanks beyond the end of
29774 line's text on text terminals. If we are over such a
29775 glyph, we are not over any text. */
29776 || NILP (glyph
->object
)
29777 /* R2L rows have a stretch glyph at their front, which
29778 stands for no text, whereas L2R rows have no glyphs at
29779 all beyond the end of text. Treat such stretch glyphs
29780 like we do with NULL glyphs in L2R rows. */
29781 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29782 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29783 && glyph
->type
== STRETCH_GLYPH
29784 && glyph
->avoid_cursor_p
))
29786 if (clear_mouse_face (hlinfo
))
29787 cursor
= No_Cursor
;
29788 #ifdef HAVE_WINDOW_SYSTEM
29789 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29791 if (area
!= TEXT_AREA
)
29792 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29794 pointer
= Vvoid_text_area_pointer
;
29800 pos
= glyph
->charpos
;
29801 object
= glyph
->object
;
29802 if (!STRINGP (object
) && !BUFFERP (object
))
29805 /* If we get an out-of-range value, return now; avoid an error. */
29806 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29809 /* Make the window's buffer temporarily current for
29810 overlays_at and compute_char_face. */
29811 obuf
= current_buffer
;
29812 current_buffer
= b
;
29818 /* Is this char mouse-active or does it have help-echo? */
29819 position
= make_number (pos
);
29823 if (BUFFERP (object
))
29825 /* Put all the overlays we want in a vector in overlay_vec. */
29826 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, false);
29827 /* Sort overlays into increasing priority order. */
29828 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29833 if (NILP (Vmouse_highlight
))
29835 clear_mouse_face (hlinfo
);
29836 goto check_help_echo
;
29839 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29842 cursor
= No_Cursor
;
29844 /* Check mouse-face highlighting. */
29846 /* If there exists an overlay with mouse-face overlapping
29847 the one we are currently highlighting, we have to
29848 check if we enter the overlapping overlay, and then
29849 highlight only that. */
29850 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29851 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29853 /* Find the highest priority overlay with a mouse-face. */
29854 Lisp_Object overlay
= Qnil
;
29855 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29857 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29858 if (!NILP (mouse_face
))
29859 overlay
= overlay_vec
[i
];
29862 /* If we're highlighting the same overlay as before, there's
29863 no need to do that again. */
29864 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29865 goto check_help_echo
;
29866 hlinfo
->mouse_face_overlay
= overlay
;
29868 /* Clear the display of the old active region, if any. */
29869 if (clear_mouse_face (hlinfo
))
29870 cursor
= No_Cursor
;
29872 /* If no overlay applies, get a text property. */
29873 if (NILP (overlay
))
29874 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29876 /* Next, compute the bounds of the mouse highlighting and
29878 if (!NILP (mouse_face
) && STRINGP (object
))
29880 /* The mouse-highlighting comes from a display string
29881 with a mouse-face. */
29885 s
= Fprevious_single_property_change
29886 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29887 e
= Fnext_single_property_change
29888 (position
, Qmouse_face
, object
, Qnil
);
29890 s
= make_number (0);
29892 e
= make_number (SCHARS (object
));
29893 mouse_face_from_string_pos (w
, hlinfo
, object
,
29894 XINT (s
), XINT (e
));
29895 hlinfo
->mouse_face_past_end
= false;
29896 hlinfo
->mouse_face_window
= window
;
29897 hlinfo
->mouse_face_face_id
29898 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29899 glyph
->face_id
, true);
29900 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29901 cursor
= No_Cursor
;
29905 /* The mouse-highlighting, if any, comes from an overlay
29906 or text property in the buffer. */
29907 Lisp_Object buffer
IF_LINT (= Qnil
);
29908 Lisp_Object disp_string
IF_LINT (= Qnil
);
29910 if (STRINGP (object
))
29912 /* If we are on a display string with no mouse-face,
29913 check if the text under it has one. */
29914 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29915 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29916 pos
= string_buffer_position (object
, start
);
29919 mouse_face
= get_char_property_and_overlay
29920 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29921 buffer
= w
->contents
;
29922 disp_string
= object
;
29928 disp_string
= Qnil
;
29931 if (!NILP (mouse_face
))
29933 Lisp_Object before
, after
;
29934 Lisp_Object before_string
, after_string
;
29935 /* To correctly find the limits of mouse highlight
29936 in a bidi-reordered buffer, we must not use the
29937 optimization of limiting the search in
29938 previous-single-property-change and
29939 next-single-property-change, because
29940 rows_from_pos_range needs the real start and end
29941 positions to DTRT in this case. That's because
29942 the first row visible in a window does not
29943 necessarily display the character whose position
29944 is the smallest. */
29946 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29947 ? Fmarker_position (w
->start
)
29950 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29951 ? make_number (BUF_Z (XBUFFER (buffer
))
29952 - w
->window_end_pos
)
29955 if (NILP (overlay
))
29957 /* Handle the text property case. */
29958 before
= Fprevious_single_property_change
29959 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29960 after
= Fnext_single_property_change
29961 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29962 before_string
= after_string
= Qnil
;
29966 /* Handle the overlay case. */
29967 before
= Foverlay_start (overlay
);
29968 after
= Foverlay_end (overlay
);
29969 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29970 after_string
= Foverlay_get (overlay
, Qafter_string
);
29972 if (!STRINGP (before_string
)) before_string
= Qnil
;
29973 if (!STRINGP (after_string
)) after_string
= Qnil
;
29976 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29979 : XFASTINT (before
),
29981 ? BUF_Z (XBUFFER (buffer
))
29982 : XFASTINT (after
),
29983 before_string
, after_string
,
29985 cursor
= No_Cursor
;
29992 /* Look for a `help-echo' property. */
29993 if (NILP (help_echo_string
)) {
29994 Lisp_Object help
, overlay
;
29996 /* Check overlays first. */
29997 help
= overlay
= Qnil
;
29998 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
30000 overlay
= overlay_vec
[i
];
30001 help
= Foverlay_get (overlay
, Qhelp_echo
);
30006 help_echo_string
= help
;
30007 help_echo_window
= window
;
30008 help_echo_object
= overlay
;
30009 help_echo_pos
= pos
;
30013 Lisp_Object obj
= glyph
->object
;
30014 ptrdiff_t charpos
= glyph
->charpos
;
30016 /* Try text properties. */
30019 && charpos
< SCHARS (obj
))
30021 help
= Fget_text_property (make_number (charpos
),
30025 /* If the string itself doesn't specify a help-echo,
30026 see if the buffer text ``under'' it does. */
30027 struct glyph_row
*r
30028 = MATRIX_ROW (w
->current_matrix
, vpos
);
30029 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30030 ptrdiff_t p
= string_buffer_position (obj
, start
);
30033 help
= Fget_char_property (make_number (p
),
30034 Qhelp_echo
, w
->contents
);
30043 else if (BUFFERP (obj
)
30046 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
30051 help_echo_string
= help
;
30052 help_echo_window
= window
;
30053 help_echo_object
= obj
;
30054 help_echo_pos
= charpos
;
30059 #ifdef HAVE_WINDOW_SYSTEM
30060 /* Look for a `pointer' property. */
30061 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
30063 /* Check overlays first. */
30064 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
30065 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
30067 if (NILP (pointer
))
30069 Lisp_Object obj
= glyph
->object
;
30070 ptrdiff_t charpos
= glyph
->charpos
;
30072 /* Try text properties. */
30075 && charpos
< SCHARS (obj
))
30077 pointer
= Fget_text_property (make_number (charpos
),
30079 if (NILP (pointer
))
30081 /* If the string itself doesn't specify a pointer,
30082 see if the buffer text ``under'' it does. */
30083 struct glyph_row
*r
30084 = MATRIX_ROW (w
->current_matrix
, vpos
);
30085 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
30086 ptrdiff_t p
= string_buffer_position (obj
, start
);
30088 pointer
= Fget_char_property (make_number (p
),
30089 Qpointer
, w
->contents
);
30092 else if (BUFFERP (obj
)
30095 pointer
= Fget_text_property (make_number (charpos
),
30099 #endif /* HAVE_WINDOW_SYSTEM */
30103 current_buffer
= obuf
;
30109 #ifdef HAVE_WINDOW_SYSTEM
30110 if (FRAME_WINDOW_P (f
))
30111 define_frame_cursor1 (f
, cursor
, pointer
);
30113 /* This is here to prevent a compiler error, about "label at end of
30114 compound statement". */
30121 Clear any mouse-face on window W. This function is part of the
30122 redisplay interface, and is called from try_window_id and similar
30123 functions to ensure the mouse-highlight is off. */
30126 x_clear_window_mouse_face (struct window
*w
)
30128 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
30129 Lisp_Object window
;
30132 XSETWINDOW (window
, w
);
30133 if (EQ (window
, hlinfo
->mouse_face_window
))
30134 clear_mouse_face (hlinfo
);
30140 Just discard the mouse face information for frame F, if any.
30141 This is used when the size of F is changed. */
30144 cancel_mouse_face (struct frame
*f
)
30146 Lisp_Object window
;
30147 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30149 window
= hlinfo
->mouse_face_window
;
30150 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
30151 reset_mouse_highlight (hlinfo
);
30156 /***********************************************************************
30158 ***********************************************************************/
30160 #ifdef HAVE_WINDOW_SYSTEM
30162 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30163 which intersects rectangle R. R is in window-relative coordinates. */
30166 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
30167 enum glyph_row_area area
)
30169 struct glyph
*first
= row
->glyphs
[area
];
30170 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
30171 struct glyph
*last
;
30172 int first_x
, start_x
, x
;
30174 if (area
== TEXT_AREA
&& row
->fill_line_p
)
30175 /* If row extends face to end of line write the whole line. */
30176 draw_glyphs (w
, 0, row
, area
,
30177 0, row
->used
[area
],
30178 DRAW_NORMAL_TEXT
, 0);
30181 /* Set START_X to the window-relative start position for drawing glyphs of
30182 AREA. The first glyph of the text area can be partially visible.
30183 The first glyphs of other areas cannot. */
30184 start_x
= window_box_left_offset (w
, area
);
30186 if (area
== TEXT_AREA
)
30189 /* Find the first glyph that must be redrawn. */
30191 && x
+ first
->pixel_width
< r
->x
)
30193 x
+= first
->pixel_width
;
30197 /* Find the last one. */
30200 /* Use a signed int intermediate value to avoid catastrophic
30201 failures due to comparison between signed and unsigned, when
30202 x is negative (can happen for wide images that are hscrolled). */
30203 int r_end
= r
->x
+ r
->width
;
30204 while (last
< end
&& x
< r_end
)
30206 x
+= last
->pixel_width
;
30212 draw_glyphs (w
, first_x
- start_x
, row
, area
,
30213 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
30214 DRAW_NORMAL_TEXT
, 0);
30219 /* Redraw the parts of the glyph row ROW on window W intersecting
30220 rectangle R. R is in window-relative coordinates. Value is
30221 true if mouse-face was overwritten. */
30224 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
30226 eassert (row
->enabled_p
);
30228 if (row
->mode_line_p
|| w
->pseudo_window_p
)
30229 draw_glyphs (w
, 0, row
, TEXT_AREA
,
30230 0, row
->used
[TEXT_AREA
],
30231 DRAW_NORMAL_TEXT
, 0);
30234 if (row
->used
[LEFT_MARGIN_AREA
])
30235 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
30236 if (row
->used
[TEXT_AREA
])
30237 expose_area (w
, row
, r
, TEXT_AREA
);
30238 if (row
->used
[RIGHT_MARGIN_AREA
])
30239 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
30240 draw_row_fringe_bitmaps (w
, row
);
30243 return row
->mouse_face_p
;
30247 /* Redraw those parts of glyphs rows during expose event handling that
30248 overlap other rows. Redrawing of an exposed line writes over parts
30249 of lines overlapping that exposed line; this function fixes that.
30251 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30252 row in W's current matrix that is exposed and overlaps other rows.
30253 LAST_OVERLAPPING_ROW is the last such row. */
30256 expose_overlaps (struct window
*w
,
30257 struct glyph_row
*first_overlapping_row
,
30258 struct glyph_row
*last_overlapping_row
,
30261 struct glyph_row
*row
;
30263 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
30264 if (row
->overlapping_p
)
30266 eassert (row
->enabled_p
&& !row
->mode_line_p
);
30269 if (row
->used
[LEFT_MARGIN_AREA
])
30270 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
30272 if (row
->used
[TEXT_AREA
])
30273 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
30275 if (row
->used
[RIGHT_MARGIN_AREA
])
30276 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
30282 /* Return true if W's cursor intersects rectangle R. */
30285 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
30287 XRectangle cr
, result
;
30288 struct glyph
*cursor_glyph
;
30289 struct glyph_row
*row
;
30291 if (w
->phys_cursor
.vpos
>= 0
30292 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
30293 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
30295 && row
->cursor_in_fringe_p
)
30297 /* Cursor is in the fringe. */
30298 cr
.x
= window_box_right_offset (w
,
30299 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
30300 ? RIGHT_MARGIN_AREA
30303 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
30304 cr
.height
= row
->height
;
30305 return x_intersect_rectangles (&cr
, r
, &result
);
30308 cursor_glyph
= get_phys_cursor_glyph (w
);
30311 /* r is relative to W's box, but w->phys_cursor.x is relative
30312 to left edge of W's TEXT area. Adjust it. */
30313 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
30314 cr
.y
= w
->phys_cursor
.y
;
30315 cr
.width
= cursor_glyph
->pixel_width
;
30316 cr
.height
= w
->phys_cursor_height
;
30317 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30318 I assume the effect is the same -- and this is portable. */
30319 return x_intersect_rectangles (&cr
, r
, &result
);
30321 /* If we don't understand the format, pretend we're not in the hot-spot. */
30327 Draw a vertical window border to the right of window W if W doesn't
30328 have vertical scroll bars. */
30331 x_draw_vertical_border (struct window
*w
)
30333 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30335 /* We could do better, if we knew what type of scroll-bar the adjacent
30336 windows (on either side) have... But we don't :-(
30337 However, I think this works ok. ++KFS 2003-04-25 */
30339 /* Redraw borders between horizontally adjacent windows. Don't
30340 do it for frames with vertical scroll bars because either the
30341 right scroll bar of a window, or the left scroll bar of its
30342 neighbor will suffice as a border. */
30343 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30346 /* Note: It is necessary to redraw both the left and the right
30347 borders, for when only this single window W is being
30349 if (!WINDOW_RIGHTMOST_P (w
)
30350 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30352 int x0
, x1
, y0
, y1
;
30354 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30357 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30360 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30363 if (!WINDOW_LEFTMOST_P (w
)
30364 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30366 int x0
, x1
, y0
, y1
;
30368 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30371 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30374 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30379 /* Draw window dividers for window W. */
30382 x_draw_right_divider (struct window
*w
)
30384 struct frame
*f
= WINDOW_XFRAME (w
);
30386 if (w
->mini
|| w
->pseudo_window_p
)
30388 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30390 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30391 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30392 int y0
= WINDOW_TOP_EDGE_Y (w
);
30393 /* The bottom divider prevails. */
30394 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30396 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30401 x_draw_bottom_divider (struct window
*w
)
30403 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30405 if (w
->mini
|| w
->pseudo_window_p
)
30407 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30409 int x0
= WINDOW_LEFT_EDGE_X (w
);
30410 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30411 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30412 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30414 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30418 /* Redraw the part of window W intersection rectangle FR. Pixel
30419 coordinates in FR are frame-relative. Call this function with
30420 input blocked. Value is true if the exposure overwrites
30424 expose_window (struct window
*w
, XRectangle
*fr
)
30426 struct frame
*f
= XFRAME (w
->frame
);
30428 bool mouse_face_overwritten_p
= false;
30430 /* If window is not yet fully initialized, do nothing. This can
30431 happen when toolkit scroll bars are used and a window is split.
30432 Reconfiguring the scroll bar will generate an expose for a newly
30434 if (w
->current_matrix
== NULL
)
30437 /* When we're currently updating the window, display and current
30438 matrix usually don't agree. Arrange for a thorough display
30440 if (w
->must_be_updated_p
)
30442 SET_FRAME_GARBAGED (f
);
30446 /* Frame-relative pixel rectangle of W. */
30447 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30448 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30449 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30450 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30452 if (x_intersect_rectangles (fr
, &wr
, &r
))
30454 int yb
= window_text_bottom_y (w
);
30455 struct glyph_row
*row
;
30456 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30458 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30459 r
.x
, r
.y
, r
.width
, r
.height
));
30461 /* Convert to window coordinates. */
30462 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30463 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30465 /* Turn off the cursor. */
30466 bool cursor_cleared_p
= (!w
->pseudo_window_p
30467 && phys_cursor_in_rect_p (w
, &r
));
30468 if (cursor_cleared_p
)
30469 x_clear_cursor (w
);
30471 /* If the row containing the cursor extends face to end of line,
30472 then expose_area might overwrite the cursor outside the
30473 rectangle and thus notice_overwritten_cursor might clear
30474 w->phys_cursor_on_p. We remember the original value and
30475 check later if it is changed. */
30476 bool phys_cursor_on_p
= w
->phys_cursor_on_p
;
30478 /* Use a signed int intermediate value to avoid catastrophic
30479 failures due to comparison between signed and unsigned, when
30480 y0 or y1 is negative (can happen for tall images). */
30481 int r_bottom
= r
.y
+ r
.height
;
30483 /* Update lines intersecting rectangle R. */
30484 first_overlapping_row
= last_overlapping_row
= NULL
;
30485 for (row
= w
->current_matrix
->rows
;
30490 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30492 if ((y0
>= r
.y
&& y0
< r_bottom
)
30493 || (y1
> r
.y
&& y1
< r_bottom
)
30494 || (r
.y
>= y0
&& r
.y
< y1
)
30495 || (r_bottom
> y0
&& r_bottom
< y1
))
30497 /* A header line may be overlapping, but there is no need
30498 to fix overlapping areas for them. KFS 2005-02-12 */
30499 if (row
->overlapping_p
&& !row
->mode_line_p
)
30501 if (first_overlapping_row
== NULL
)
30502 first_overlapping_row
= row
;
30503 last_overlapping_row
= row
;
30507 if (expose_line (w
, row
, &r
))
30508 mouse_face_overwritten_p
= true;
30511 else if (row
->overlapping_p
)
30513 /* We must redraw a row overlapping the exposed area. */
30515 ? y0
+ row
->phys_height
> r
.y
30516 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30518 if (first_overlapping_row
== NULL
)
30519 first_overlapping_row
= row
;
30520 last_overlapping_row
= row
;
30528 /* Display the mode line if there is one. */
30529 if (WINDOW_WANTS_MODELINE_P (w
)
30530 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30532 && row
->y
< r_bottom
)
30534 if (expose_line (w
, row
, &r
))
30535 mouse_face_overwritten_p
= true;
30538 if (!w
->pseudo_window_p
)
30540 /* Fix the display of overlapping rows. */
30541 if (first_overlapping_row
)
30542 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30545 /* Draw border between windows. */
30546 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30547 x_draw_right_divider (w
);
30549 x_draw_vertical_border (w
);
30551 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30552 x_draw_bottom_divider (w
);
30554 /* Turn the cursor on again. */
30555 if (cursor_cleared_p
30556 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30557 update_window_cursor (w
, true);
30561 return mouse_face_overwritten_p
;
30566 /* Redraw (parts) of all windows in the window tree rooted at W that
30567 intersect R. R contains frame pixel coordinates. Value is
30568 true if the exposure overwrites mouse-face. */
30571 expose_window_tree (struct window
*w
, XRectangle
*r
)
30573 struct frame
*f
= XFRAME (w
->frame
);
30574 bool mouse_face_overwritten_p
= false;
30576 while (w
&& !FRAME_GARBAGED_P (f
))
30578 mouse_face_overwritten_p
30579 |= (WINDOWP (w
->contents
)
30580 ? expose_window_tree (XWINDOW (w
->contents
), r
)
30581 : expose_window (w
, r
));
30583 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30586 return mouse_face_overwritten_p
;
30591 Redisplay an exposed area of frame F. X and Y are the upper-left
30592 corner of the exposed rectangle. W and H are width and height of
30593 the exposed area. All are pixel values. W or H zero means redraw
30594 the entire frame. */
30597 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30600 bool mouse_face_overwritten_p
= false;
30602 TRACE ((stderr
, "expose_frame "));
30604 /* No need to redraw if frame will be redrawn soon. */
30605 if (FRAME_GARBAGED_P (f
))
30607 TRACE ((stderr
, " garbaged\n"));
30611 /* If basic faces haven't been realized yet, there is no point in
30612 trying to redraw anything. This can happen when we get an expose
30613 event while Emacs is starting, e.g. by moving another window. */
30614 if (FRAME_FACE_CACHE (f
) == NULL
30615 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30617 TRACE ((stderr
, " no faces\n"));
30621 if (w
== 0 || h
== 0)
30624 r
.width
= FRAME_TEXT_WIDTH (f
);
30625 r
.height
= FRAME_TEXT_HEIGHT (f
);
30635 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30636 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30638 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30639 if (WINDOWP (f
->tool_bar_window
))
30640 mouse_face_overwritten_p
30641 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30644 #ifdef HAVE_X_WINDOWS
30646 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30647 if (WINDOWP (f
->menu_bar_window
))
30648 mouse_face_overwritten_p
30649 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30650 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30654 /* Some window managers support a focus-follows-mouse style with
30655 delayed raising of frames. Imagine a partially obscured frame,
30656 and moving the mouse into partially obscured mouse-face on that
30657 frame. The visible part of the mouse-face will be highlighted,
30658 then the WM raises the obscured frame. With at least one WM, KDE
30659 2.1, Emacs is not getting any event for the raising of the frame
30660 (even tried with SubstructureRedirectMask), only Expose events.
30661 These expose events will draw text normally, i.e. not
30662 highlighted. Which means we must redo the highlight here.
30663 Subsume it under ``we love X''. --gerd 2001-08-15 */
30664 /* Included in Windows version because Windows most likely does not
30665 do the right thing if any third party tool offers
30666 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30667 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30669 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30670 if (f
== hlinfo
->mouse_face_mouse_frame
)
30672 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30673 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30674 clear_mouse_face (hlinfo
);
30675 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30682 Determine the intersection of two rectangles R1 and R2. Return
30683 the intersection in *RESULT. Value is true if RESULT is not
30687 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30689 XRectangle
*left
, *right
;
30690 XRectangle
*upper
, *lower
;
30691 bool intersection_p
= false;
30693 /* Rearrange so that R1 is the left-most rectangle. */
30695 left
= r1
, right
= r2
;
30697 left
= r2
, right
= r1
;
30699 /* X0 of the intersection is right.x0, if this is inside R1,
30700 otherwise there is no intersection. */
30701 if (right
->x
<= left
->x
+ left
->width
)
30703 result
->x
= right
->x
;
30705 /* The right end of the intersection is the minimum of
30706 the right ends of left and right. */
30707 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30710 /* Same game for Y. */
30712 upper
= r1
, lower
= r2
;
30714 upper
= r2
, lower
= r1
;
30716 /* The upper end of the intersection is lower.y0, if this is inside
30717 of upper. Otherwise, there is no intersection. */
30718 if (lower
->y
<= upper
->y
+ upper
->height
)
30720 result
->y
= lower
->y
;
30722 /* The lower end of the intersection is the minimum of the lower
30723 ends of upper and lower. */
30724 result
->height
= (min (lower
->y
+ lower
->height
,
30725 upper
->y
+ upper
->height
)
30727 intersection_p
= true;
30731 return intersection_p
;
30734 #endif /* HAVE_WINDOW_SYSTEM */
30737 /***********************************************************************
30739 ***********************************************************************/
30742 syms_of_xdisp (void)
30744 Vwith_echo_area_save_vector
= Qnil
;
30745 staticpro (&Vwith_echo_area_save_vector
);
30747 Vmessage_stack
= Qnil
;
30748 staticpro (&Vmessage_stack
);
30750 /* Non-nil means don't actually do any redisplay. */
30751 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30753 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30755 DEFVAR_BOOL("inhibit-message", inhibit_message
,
30756 doc
: /* Non-nil means calls to `message' are not displayed.
30757 They are still logged to the *Messages* buffer. */);
30758 inhibit_message
= 0;
30760 message_dolog_marker1
= Fmake_marker ();
30761 staticpro (&message_dolog_marker1
);
30762 message_dolog_marker2
= Fmake_marker ();
30763 staticpro (&message_dolog_marker2
);
30764 message_dolog_marker3
= Fmake_marker ();
30765 staticpro (&message_dolog_marker3
);
30768 defsubr (&Sdump_frame_glyph_matrix
);
30769 defsubr (&Sdump_glyph_matrix
);
30770 defsubr (&Sdump_glyph_row
);
30771 defsubr (&Sdump_tool_bar_row
);
30772 defsubr (&Strace_redisplay
);
30773 defsubr (&Strace_to_stderr
);
30775 #ifdef HAVE_WINDOW_SYSTEM
30776 defsubr (&Stool_bar_height
);
30777 defsubr (&Slookup_image_map
);
30779 defsubr (&Sline_pixel_height
);
30780 defsubr (&Sformat_mode_line
);
30781 defsubr (&Sinvisible_p
);
30782 defsubr (&Scurrent_bidi_paragraph_direction
);
30783 defsubr (&Swindow_text_pixel_size
);
30784 defsubr (&Smove_point_visually
);
30785 defsubr (&Sbidi_find_overridden_directionality
);
30787 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30788 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30789 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30790 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30791 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30792 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30793 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30794 DEFSYM (Qeval
, "eval");
30795 DEFSYM (QCdata
, ":data");
30797 /* Names of text properties relevant for redisplay. */
30798 DEFSYM (Qdisplay
, "display");
30799 DEFSYM (Qspace_width
, "space-width");
30800 DEFSYM (Qraise
, "raise");
30801 DEFSYM (Qslice
, "slice");
30802 DEFSYM (Qspace
, "space");
30803 DEFSYM (Qmargin
, "margin");
30804 DEFSYM (Qpointer
, "pointer");
30805 DEFSYM (Qleft_margin
, "left-margin");
30806 DEFSYM (Qright_margin
, "right-margin");
30807 DEFSYM (Qcenter
, "center");
30808 DEFSYM (Qline_height
, "line-height");
30809 DEFSYM (QCalign_to
, ":align-to");
30810 DEFSYM (QCrelative_width
, ":relative-width");
30811 DEFSYM (QCrelative_height
, ":relative-height");
30812 DEFSYM (QCeval
, ":eval");
30813 DEFSYM (QCpropertize
, ":propertize");
30814 DEFSYM (QCfile
, ":file");
30815 DEFSYM (Qfontified
, "fontified");
30816 DEFSYM (Qfontification_functions
, "fontification-functions");
30818 /* Name of the face used to highlight trailing whitespace. */
30819 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30821 /* Name and number of the face used to highlight escape glyphs. */
30822 DEFSYM (Qescape_glyph
, "escape-glyph");
30824 /* Name and number of the face used to highlight non-breaking spaces. */
30825 DEFSYM (Qnobreak_space
, "nobreak-space");
30827 /* The symbol 'image' which is the car of the lists used to represent
30828 images in Lisp. Also a tool bar style. */
30829 DEFSYM (Qimage
, "image");
30831 /* Tool bar styles. */
30832 DEFSYM (Qtext
, "text");
30833 DEFSYM (Qboth
, "both");
30834 DEFSYM (Qboth_horiz
, "both-horiz");
30835 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30837 /* The image map types. */
30838 DEFSYM (QCmap
, ":map");
30839 DEFSYM (QCpointer
, ":pointer");
30840 DEFSYM (Qrect
, "rect");
30841 DEFSYM (Qcircle
, "circle");
30842 DEFSYM (Qpoly
, "poly");
30844 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30846 DEFSYM (Qgrow_only
, "grow-only");
30847 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30848 DEFSYM (Qposition
, "position");
30849 DEFSYM (Qbuffer_position
, "buffer-position");
30850 DEFSYM (Qobject
, "object");
30852 /* Cursor shapes. */
30853 DEFSYM (Qbar
, "bar");
30854 DEFSYM (Qhbar
, "hbar");
30855 DEFSYM (Qbox
, "box");
30856 DEFSYM (Qhollow
, "hollow");
30858 /* Pointer shapes. */
30859 DEFSYM (Qhand
, "hand");
30860 DEFSYM (Qarrow
, "arrow");
30863 DEFSYM (Qdragging
, "dragging");
30865 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30867 list_of_error
= list1 (list2 (Qerror
, Qvoid_variable
));
30868 staticpro (&list_of_error
);
30870 /* Values of those variables at last redisplay are stored as
30871 properties on 'overlay-arrow-position' symbol. However, if
30872 Voverlay_arrow_position is a marker, last-arrow-position is its
30873 numerical position. */
30874 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30875 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30877 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
30878 properties on a symbol in overlay-arrow-variable-list. */
30879 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30880 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30882 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30883 staticpro (&echo_buffer
[0]);
30884 staticpro (&echo_buffer
[1]);
30886 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30887 staticpro (&echo_area_buffer
[0]);
30888 staticpro (&echo_area_buffer
[1]);
30890 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30891 staticpro (&Vmessages_buffer_name
);
30893 mode_line_proptrans_alist
= Qnil
;
30894 staticpro (&mode_line_proptrans_alist
);
30895 mode_line_string_list
= Qnil
;
30896 staticpro (&mode_line_string_list
);
30897 mode_line_string_face
= Qnil
;
30898 staticpro (&mode_line_string_face
);
30899 mode_line_string_face_prop
= Qnil
;
30900 staticpro (&mode_line_string_face_prop
);
30901 Vmode_line_unwind_vector
= Qnil
;
30902 staticpro (&Vmode_line_unwind_vector
);
30904 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30906 help_echo_string
= Qnil
;
30907 staticpro (&help_echo_string
);
30908 help_echo_object
= Qnil
;
30909 staticpro (&help_echo_object
);
30910 help_echo_window
= Qnil
;
30911 staticpro (&help_echo_window
);
30912 previous_help_echo_string
= Qnil
;
30913 staticpro (&previous_help_echo_string
);
30914 help_echo_pos
= -1;
30916 DEFSYM (Qright_to_left
, "right-to-left");
30917 DEFSYM (Qleft_to_right
, "left-to-right");
30918 defsubr (&Sbidi_resolved_levels
);
30920 #ifdef HAVE_WINDOW_SYSTEM
30921 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30922 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30923 For example, if a block cursor is over a tab, it will be drawn as
30924 wide as that tab on the display. */);
30925 x_stretch_cursor_p
= 0;
30928 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30929 doc
: /* Non-nil means highlight trailing whitespace.
30930 The face used for trailing whitespace is `trailing-whitespace'. */);
30931 Vshow_trailing_whitespace
= Qnil
;
30933 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30934 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30935 If the value is t, Emacs highlights non-ASCII chars which have the
30936 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30937 or `escape-glyph' face respectively.
30939 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30940 U+2011 (non-breaking hyphen) are affected.
30942 Any other non-nil value means to display these characters as a escape
30943 glyph followed by an ordinary space or hyphen.
30945 A value of nil means no special handling of these characters. */);
30946 Vnobreak_char_display
= Qt
;
30948 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30949 doc
: /* The pointer shape to show in void text areas.
30950 A value of nil means to show the text pointer. Other options are
30951 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30953 Vvoid_text_area_pointer
= Qarrow
;
30955 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30956 doc
: /* Non-nil means don't actually do any redisplay.
30957 This is used for internal purposes. */);
30958 Vinhibit_redisplay
= Qnil
;
30960 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30961 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30962 Vglobal_mode_string
= Qnil
;
30964 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30965 doc
: /* Marker for where to display an arrow on top of the buffer text.
30966 This must be the beginning of a line in order to work.
30967 See also `overlay-arrow-string'. */);
30968 Voverlay_arrow_position
= Qnil
;
30970 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30971 doc
: /* String to display as an arrow in non-window frames.
30972 See also `overlay-arrow-position'. */);
30973 Voverlay_arrow_string
= build_pure_c_string ("=>");
30975 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30976 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30977 The symbols on this list are examined during redisplay to determine
30978 where to display overlay arrows. */);
30979 Voverlay_arrow_variable_list
30980 = list1 (intern_c_string ("overlay-arrow-position"));
30982 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30983 doc
: /* The number of lines to try scrolling a window by when point moves out.
30984 If that fails to bring point back on frame, point is centered instead.
30985 If this is zero, point is always centered after it moves off frame.
30986 If you want scrolling to always be a line at a time, you should set
30987 `scroll-conservatively' to a large value rather than set this to 1. */);
30989 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30990 doc
: /* Scroll up to this many lines, to bring point back on screen.
30991 If point moves off-screen, redisplay will scroll by up to
30992 `scroll-conservatively' lines in order to bring point just barely
30993 onto the screen again. If that cannot be done, then redisplay
30994 recenters point as usual.
30996 If the value is greater than 100, redisplay will never recenter point,
30997 but will always scroll just enough text to bring point into view, even
30998 if you move far away.
31000 A value of zero means always recenter point if it moves off screen. */);
31001 scroll_conservatively
= 0;
31003 DEFVAR_INT ("scroll-margin", scroll_margin
,
31004 doc
: /* Number of lines of margin at the top and bottom of a window.
31005 Recenter the window whenever point gets within this many lines
31006 of the top or bottom of the window. */);
31009 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
31010 doc
: /* Pixels per inch value for non-window system displays.
31011 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31012 Vdisplay_pixels_per_inch
= make_float (72.0);
31015 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
31018 DEFVAR_LISP ("truncate-partial-width-windows",
31019 Vtruncate_partial_width_windows
,
31020 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
31021 For an integer value, truncate lines in each window narrower than the
31022 full frame width, provided the window width is less than that integer;
31023 otherwise, respect the value of `truncate-lines'.
31025 For any other non-nil value, truncate lines in all windows that do
31026 not span the full frame width.
31028 A value of nil means to respect the value of `truncate-lines'.
31030 If `word-wrap' is enabled, you might want to reduce this. */);
31031 Vtruncate_partial_width_windows
= make_number (50);
31033 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
31034 doc
: /* Maximum buffer size for which line number should be displayed.
31035 If the buffer is bigger than this, the line number does not appear
31036 in the mode line. A value of nil means no limit. */);
31037 Vline_number_display_limit
= Qnil
;
31039 DEFVAR_INT ("line-number-display-limit-width",
31040 line_number_display_limit_width
,
31041 doc
: /* Maximum line width (in characters) for line number display.
31042 If the average length of the lines near point is bigger than this, then the
31043 line number may be omitted from the mode line. */);
31044 line_number_display_limit_width
= 200;
31046 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
31047 doc
: /* Non-nil means highlight region even in nonselected windows. */);
31048 highlight_nonselected_windows
= false;
31050 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
31051 doc
: /* Non-nil if more than one frame is visible on this display.
31052 Minibuffer-only frames don't count, but iconified frames do.
31053 This variable is not guaranteed to be accurate except while processing
31054 `frame-title-format' and `icon-title-format'. */);
31056 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
31057 doc
: /* Template for displaying the title bar of visible frames.
31058 (Assuming the window manager supports this feature.)
31060 This variable has the same structure as `mode-line-format', except that
31061 the %c and %l constructs are ignored. It is used only on frames for
31062 which no explicit name has been set (see `modify-frame-parameters'). */);
31064 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
31065 doc
: /* Template for displaying the title bar of an iconified frame.
31066 (Assuming the window manager supports this feature.)
31067 This variable has the same structure as `mode-line-format' (which see),
31068 and is used only on frames for which no explicit name has been set
31069 (see `modify-frame-parameters'). */);
31071 = Vframe_title_format
31072 = listn (CONSTYPE_PURE
, 3,
31073 intern_c_string ("multiple-frames"),
31074 build_pure_c_string ("%b"),
31075 listn (CONSTYPE_PURE
, 4,
31076 empty_unibyte_string
,
31077 intern_c_string ("invocation-name"),
31078 build_pure_c_string ("@"),
31079 intern_c_string ("system-name")));
31081 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
31082 doc
: /* Maximum number of lines to keep in the message log buffer.
31083 If nil, disable message logging. If t, log messages but don't truncate
31084 the buffer when it becomes large. */);
31085 Vmessage_log_max
= make_number (1000);
31087 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
31088 doc
: /* Functions called before redisplay, if window sizes have changed.
31089 The value should be a list of functions that take one argument.
31090 Just before redisplay, for each frame, if any of its windows have changed
31091 size since the last redisplay, or have been split or deleted,
31092 all the functions in the list are called, with the frame as argument. */);
31093 Vwindow_size_change_functions
= Qnil
;
31095 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
31096 doc
: /* List of functions to call before redisplaying a window with scrolling.
31097 Each function is called with two arguments, the window and its new
31098 display-start position.
31099 These functions are called whenever the `window-start' marker is modified,
31100 either to point into another buffer (e.g. via `set-window-buffer') or another
31101 place in the same buffer.
31102 Note that the value of `window-end' is not valid when these functions are
31105 Warning: Do not use this feature to alter the way the window
31106 is scrolled. It is not designed for that, and such use probably won't
31108 Vwindow_scroll_functions
= Qnil
;
31110 DEFVAR_LISP ("window-text-change-functions",
31111 Vwindow_text_change_functions
,
31112 doc
: /* Functions to call in redisplay when text in the window might change. */);
31113 Vwindow_text_change_functions
= Qnil
;
31115 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
31116 doc
: /* Functions called when redisplay of a window reaches the end trigger.
31117 Each function is called with two arguments, the window and the end trigger value.
31118 See `set-window-redisplay-end-trigger'. */);
31119 Vredisplay_end_trigger_functions
= Qnil
;
31121 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
31122 doc
: /* Non-nil means autoselect window with mouse pointer.
31123 If nil, do not autoselect windows.
31124 A positive number means delay autoselection by that many seconds: a
31125 window is autoselected only after the mouse has remained in that
31126 window for the duration of the delay.
31127 A negative number has a similar effect, but causes windows to be
31128 autoselected only after the mouse has stopped moving. (Because of
31129 the way Emacs compares mouse events, you will occasionally wait twice
31130 that time before the window gets selected.)
31131 Any other value means to autoselect window instantaneously when the
31132 mouse pointer enters it.
31134 Autoselection selects the minibuffer only if it is active, and never
31135 unselects the minibuffer if it is active.
31137 When customizing this variable make sure that the actual value of
31138 `focus-follows-mouse' matches the behavior of your window manager. */);
31139 Vmouse_autoselect_window
= Qnil
;
31141 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
31142 doc
: /* Non-nil means automatically resize tool-bars.
31143 This dynamically changes the tool-bar's height to the minimum height
31144 that is needed to make all tool-bar items visible.
31145 If value is `grow-only', the tool-bar's height is only increased
31146 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31147 Vauto_resize_tool_bars
= Qt
;
31149 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
31150 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31151 auto_raise_tool_bar_buttons_p
= true;
31153 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
31154 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31155 make_cursor_line_fully_visible_p
= true;
31157 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
31158 doc
: /* Border below tool-bar in pixels.
31159 If an integer, use it as the height of the border.
31160 If it is one of `internal-border-width' or `border-width', use the
31161 value of the corresponding frame parameter.
31162 Otherwise, no border is added below the tool-bar. */);
31163 Vtool_bar_border
= Qinternal_border_width
;
31165 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
31166 doc
: /* Margin around tool-bar buttons in pixels.
31167 If an integer, use that for both horizontal and vertical margins.
31168 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31169 HORZ specifying the horizontal margin, and VERT specifying the
31170 vertical margin. */);
31171 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
31173 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
31174 doc
: /* Relief thickness of tool-bar buttons. */);
31175 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
31177 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
31178 doc
: /* Tool bar style to use.
31180 image - show images only
31181 text - show text only
31182 both - show both, text below image
31183 both-horiz - show text to the right of the image
31184 text-image-horiz - show text to the left of the image
31185 any other - use system default or image if no system default.
31187 This variable only affects the GTK+ toolkit version of Emacs. */);
31188 Vtool_bar_style
= Qnil
;
31190 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
31191 doc
: /* Maximum number of characters a label can have to be shown.
31192 The tool bar style must also show labels for this to have any effect, see
31193 `tool-bar-style'. */);
31194 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
31196 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
31197 doc
: /* List of functions to call to fontify regions of text.
31198 Each function is called with one argument POS. Functions must
31199 fontify a region starting at POS in the current buffer, and give
31200 fontified regions the property `fontified'. */);
31201 Vfontification_functions
= Qnil
;
31202 Fmake_variable_buffer_local (Qfontification_functions
);
31204 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31205 unibyte_display_via_language_environment
,
31206 doc
: /* Non-nil means display unibyte text according to language environment.
31207 Specifically, this means that raw bytes in the range 160-255 decimal
31208 are displayed by converting them to the equivalent multibyte characters
31209 according to the current language environment. As a result, they are
31210 displayed according to the current fontset.
31212 Note that this variable affects only how these bytes are displayed,
31213 but does not change the fact they are interpreted as raw bytes. */);
31214 unibyte_display_via_language_environment
= false;
31216 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
31217 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31218 If a float, it specifies a fraction of the mini-window frame's height.
31219 If an integer, it specifies a number of lines. */);
31220 Vmax_mini_window_height
= make_float (0.25);
31222 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
31223 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
31224 A value of nil means don't automatically resize mini-windows.
31225 A value of t means resize them to fit the text displayed in them.
31226 A value of `grow-only', the default, means let mini-windows grow only;
31227 they return to their normal size when the minibuffer is closed, or the
31228 echo area becomes empty. */);
31229 Vresize_mini_windows
= Qgrow_only
;
31231 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
31232 doc
: /* Alist specifying how to blink the cursor off.
31233 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31234 `cursor-type' frame-parameter or variable equals ON-STATE,
31235 comparing using `equal', Emacs uses OFF-STATE to specify
31236 how to blink it off. ON-STATE and OFF-STATE are values for
31237 the `cursor-type' frame parameter.
31239 If a frame's ON-STATE has no entry in this list,
31240 the frame's other specifications determine how to blink the cursor off. */);
31241 Vblink_cursor_alist
= Qnil
;
31243 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
31244 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
31245 If non-nil, windows are automatically scrolled horizontally to make
31246 point visible. */);
31247 automatic_hscrolling_p
= true;
31248 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
31250 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
31251 doc
: /* How many columns away from the window edge point is allowed to get
31252 before automatic hscrolling will horizontally scroll the window. */);
31253 hscroll_margin
= 5;
31255 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
31256 doc
: /* How many columns to scroll the window when point gets too close to the edge.
31257 When point is less than `hscroll-margin' columns from the window
31258 edge, automatic hscrolling will scroll the window by the amount of columns
31259 determined by this variable. If its value is a positive integer, scroll that
31260 many columns. If it's a positive floating-point number, it specifies the
31261 fraction of the window's width to scroll. If it's nil or zero, point will be
31262 centered horizontally after the scroll. Any other value, including negative
31263 numbers, are treated as if the value were zero.
31265 Automatic hscrolling always moves point outside the scroll margin, so if
31266 point was more than scroll step columns inside the margin, the window will
31267 scroll more than the value given by the scroll step.
31269 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31270 and `scroll-right' overrides this variable's effect. */);
31271 Vhscroll_step
= make_number (0);
31273 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
31274 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
31275 Bind this around calls to `message' to let it take effect. */);
31276 message_truncate_lines
= false;
31278 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
31279 doc
: /* Normal hook run to update the menu bar definitions.
31280 Redisplay runs this hook before it redisplays the menu bar.
31281 This is used to update menus such as Buffers, whose contents depend on
31283 Vmenu_bar_update_hook
= Qnil
;
31285 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
31286 doc
: /* Frame for which we are updating a menu.
31287 The enable predicate for a menu binding should check this variable. */);
31288 Vmenu_updating_frame
= Qnil
;
31290 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
31291 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
31292 inhibit_menubar_update
= false;
31294 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
31295 doc
: /* Prefix prepended to all continuation lines at display time.
31296 The value may be a string, an image, or a stretch-glyph; it is
31297 interpreted in the same way as the value of a `display' text property.
31299 This variable is overridden by any `wrap-prefix' text or overlay
31302 To add a prefix to non-continuation lines, use `line-prefix'. */);
31303 Vwrap_prefix
= Qnil
;
31304 DEFSYM (Qwrap_prefix
, "wrap-prefix");
31305 Fmake_variable_buffer_local (Qwrap_prefix
);
31307 DEFVAR_LISP ("line-prefix", Vline_prefix
,
31308 doc
: /* Prefix prepended to all non-continuation lines at display time.
31309 The value may be a string, an image, or a stretch-glyph; it is
31310 interpreted in the same way as the value of a `display' text property.
31312 This variable is overridden by any `line-prefix' text or overlay
31315 To add a prefix to continuation lines, use `wrap-prefix'. */);
31316 Vline_prefix
= Qnil
;
31317 DEFSYM (Qline_prefix
, "line-prefix");
31318 Fmake_variable_buffer_local (Qline_prefix
);
31320 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
31321 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
31322 inhibit_eval_during_redisplay
= false;
31324 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
31325 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
31326 inhibit_free_realized_faces
= false;
31328 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
31329 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
31330 Intended for use during debugging and for testing bidi display;
31331 see biditest.el in the test suite. */);
31332 inhibit_bidi_mirroring
= false;
31335 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
31336 doc
: /* Inhibit try_window_id display optimization. */);
31337 inhibit_try_window_id
= false;
31339 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
31340 doc
: /* Inhibit try_window_reusing display optimization. */);
31341 inhibit_try_window_reusing
= false;
31343 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
31344 doc
: /* Inhibit try_cursor_movement display optimization. */);
31345 inhibit_try_cursor_movement
= false;
31346 #endif /* GLYPH_DEBUG */
31348 DEFVAR_INT ("overline-margin", overline_margin
,
31349 doc
: /* Space between overline and text, in pixels.
31350 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31351 margin to the character height. */);
31352 overline_margin
= 2;
31354 DEFVAR_INT ("underline-minimum-offset",
31355 underline_minimum_offset
,
31356 doc
: /* Minimum distance between baseline and underline.
31357 This can improve legibility of underlined text at small font sizes,
31358 particularly when using variable `x-use-underline-position-properties'
31359 with fonts that specify an UNDERLINE_POSITION relatively close to the
31360 baseline. The default value is 1. */);
31361 underline_minimum_offset
= 1;
31363 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
31364 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31365 This feature only works when on a window system that can change
31366 cursor shapes. */);
31367 display_hourglass_p
= true;
31369 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
31370 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31371 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
31373 #ifdef HAVE_WINDOW_SYSTEM
31374 hourglass_atimer
= NULL
;
31375 hourglass_shown_p
= false;
31376 #endif /* HAVE_WINDOW_SYSTEM */
31378 /* Name of the face used to display glyphless characters. */
31379 DEFSYM (Qglyphless_char
, "glyphless-char");
31381 /* Method symbols for Vglyphless_char_display. */
31382 DEFSYM (Qhex_code
, "hex-code");
31383 DEFSYM (Qempty_box
, "empty-box");
31384 DEFSYM (Qthin_space
, "thin-space");
31385 DEFSYM (Qzero_width
, "zero-width");
31387 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31388 doc
: /* Function run just before redisplay.
31389 It is called with one argument, which is the set of windows that are to
31390 be redisplayed. This set can be nil (meaning, only the selected window),
31391 or t (meaning all windows). */);
31392 Vpre_redisplay_function
= intern ("ignore");
31394 /* Symbol for the purpose of Vglyphless_char_display. */
31395 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31396 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31398 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31399 doc
: /* Char-table defining glyphless characters.
31400 Each element, if non-nil, should be one of the following:
31401 an ASCII acronym string: display this string in a box
31402 `hex-code': display the hexadecimal code of a character in a box
31403 `empty-box': display as an empty box
31404 `thin-space': display as 1-pixel width space
31405 `zero-width': don't display
31406 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31407 display method for graphical terminals and text terminals respectively.
31408 GRAPHICAL and TEXT should each have one of the values listed above.
31410 The char-table has one extra slot to control the display of a character for
31411 which no font is found. This slot only takes effect on graphical terminals.
31412 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31413 `thin-space'. The default is `empty-box'.
31415 If a character has a non-nil entry in an active display table, the
31416 display table takes effect; in this case, Emacs does not consult
31417 `glyphless-char-display' at all. */);
31418 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31419 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31422 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31423 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31424 Vdebug_on_message
= Qnil
;
31426 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31428 Vredisplay__all_windows_cause
= Fmake_hash_table (0, NULL
);
31430 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31432 Vredisplay__mode_lines_cause
= Fmake_hash_table (0, NULL
);
31436 /* Initialize this module when Emacs starts. */
31441 CHARPOS (this_line_start_pos
) = 0;
31443 if (!noninteractive
)
31445 struct window
*m
= XWINDOW (minibuf_window
);
31446 Lisp_Object frame
= m
->frame
;
31447 struct frame
*f
= XFRAME (frame
);
31448 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31449 struct window
*r
= XWINDOW (root
);
31452 echo_area_window
= minibuf_window
;
31454 r
->top_line
= FRAME_TOP_MARGIN (f
);
31455 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31456 r
->total_cols
= FRAME_COLS (f
);
31457 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31458 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31459 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31461 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31462 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31463 m
->total_cols
= FRAME_COLS (f
);
31464 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31465 m
->total_lines
= 1;
31466 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31468 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31469 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31470 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31472 /* The default ellipsis glyphs `...'. */
31473 for (i
= 0; i
< 3; ++i
)
31474 default_invis_vector
[i
] = make_number ('.');
31478 /* Allocate the buffer for frame titles.
31479 Also used for `format-mode-line'. */
31481 mode_line_noprop_buf
= xmalloc (size
);
31482 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31483 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31484 mode_line_target
= MODE_LINE_DISPLAY
;
31487 help_echo_showing_p
= false;
31490 #ifdef HAVE_WINDOW_SYSTEM
31492 /* Platform-independent portion of hourglass implementation. */
31494 /* Timer function of hourglass_atimer. */
31497 show_hourglass (struct atimer
*timer
)
31499 /* The timer implementation will cancel this timer automatically
31500 after this function has run. Set hourglass_atimer to null
31501 so that we know the timer doesn't have to be canceled. */
31502 hourglass_atimer
= NULL
;
31504 if (!hourglass_shown_p
)
31506 Lisp_Object tail
, frame
;
31510 FOR_EACH_FRAME (tail
, frame
)
31512 struct frame
*f
= XFRAME (frame
);
31514 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31515 && FRAME_RIF (f
)->show_hourglass
)
31516 FRAME_RIF (f
)->show_hourglass (f
);
31519 hourglass_shown_p
= true;
31524 /* Cancel a currently active hourglass timer, and start a new one. */
31527 start_hourglass (void)
31529 struct timespec delay
;
31531 cancel_hourglass ();
31533 if (INTEGERP (Vhourglass_delay
)
31534 && XINT (Vhourglass_delay
) > 0)
31535 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31536 TYPE_MAXIMUM (time_t)),
31538 else if (FLOATP (Vhourglass_delay
)
31539 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31540 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31542 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31544 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31545 show_hourglass
, NULL
);
31548 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31552 cancel_hourglass (void)
31554 if (hourglass_atimer
)
31556 cancel_atimer (hourglass_atimer
);
31557 hourglass_atimer
= NULL
;
31560 if (hourglass_shown_p
)
31562 Lisp_Object tail
, frame
;
31566 FOR_EACH_FRAME (tail
, frame
)
31568 struct frame
*f
= XFRAME (frame
);
31570 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31571 && FRAME_RIF (f
)->hide_hourglass
)
31572 FRAME_RIF (f
)->hide_hourglass (f
);
31574 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31575 else if (!FRAME_W32_P (f
))
31576 w32_arrow_cursor ();
31580 hourglass_shown_p
= false;
31585 #endif /* HAVE_WINDOW_SYSTEM */